Headless futtatás és folyamatos integráció

A felületen felépített forgatókönyv a parancssorból ablak nélkül is lefuttatható. Ez az az út, amely az API-tesztekből pipeline-lépést csinál.

restorm \
  --open ./projet.restorm \
  --run "Find pets by status" \
  --headless \
  --param status=available

Pro kiadás

A headless futtatás a Pro és az Enterprise kiadás része. Szervezeti tokent igényel, amelyet a RESTORM_TOKEN környezeti változó ad át. Lásd: Előfizetések és képességek.

Az argumentumok

Argumentum	Szerep
--open <path>, -o	A megnyitandó projekt. A --run mellett kötelező
--run <target>	A futtatandó forgatókönyv. Puszta jelenléte bekapcsolja a parancssori módot
--by <name|id>	Ahogyan a --run megjelöli a forgatókönyvet: név szerint (alapértelmezés) vagy azonosító szerint
--headless	Semmilyen ablak. Nélküle megjelenik az ablak, miközben a napló a konzolon fut
--param name=value	Érték a forgatókönyv egyik bemeneti paraméteréhez (egy Input / Param blokkhoz). Többször megadható
--all-logs	A motor bejegyzéseit is beleveszi; alapértelmezés szerint csak a Log művelet bejegyzései kerülnek ki
--out <file>	A naplót menet közben egy fájlba is kiírja
--clear-settings, -cls	Indítás előtt visszaállítja a beállításokat

A hibásan megadott --param (amelyben nincs =) a hibakimeneten jelzésre kerül, és figyelmen kívül marad. A name= (üres érték) elfogadott.

Az értékek a paraméter deklarált típusa szerint alakulnak át — lásd: Változók és adatok.

A --param a forgatókönyv bemeneteit célozza, nem a környezeti változókat

A --param a forgatókönyvben deklarált Input / Param blokkokat táplálja — környezeti változót nem módosít. A fenti --param status=available tehát csak azért működik, mert a forgatókönyv közzétesz egy status nevű bemeneti paramétert. Az alap URL felülírása --param baseUrl=… formában semmilyen hatással nem járna, ha a baseUrl környezeti változó: az az érték, amely egy környezetben él, a parancssorból nem felülírható. Ha egy ilyen értéket CI-ből vezérelhetővé kell tenni, a forgatókönyv bemeneti paraméterévé kell alakítani (egy Input / Param blokkal), és oda kell bekötni, ahol szükség van rá.

A kilépési kódok

Kód	Jelentés
0	A forgatókönyv rendben lefutott
1	Hiba, megszakítás vagy a motor hibája
2	A cél nem található, a --out fájl nem érhető el, vagy --run szerepel --open nélkül
3	Jogosultság elutasítva: a RESTORM_TOKEN hiányzik, érvénytelen vagy visszavont, az előfizetés nem elegendő, vagy az ellenőrzőpont nem érhető el

Ez a megállapodás teszi az eredményt közvetlenül feldolgozhatóvá egy CI-runner számára.

A kimenet

A napló a standard kimenetre kerül, bejegyzésenként, amint elkészül, YAML-szekvencia formájában:

- message: "🔵 [2026-07-29 10:30:00.123] Commande créée"
  data: { id: 4271 }

A szinteket egy-egy jelölő előzi meg: ⚪ debug, 🔵 info, 🟠 warn, 🔴 error. A sorok soha nem törnek meg — a kimenet grep-elhető marad. A hibák a standard hibakimenetre mennek.

Pontosan ugyanez a szöveg, mint amit a felület „napló másolása” gombja előállít: mindkét oldalon ugyanaz a formátum.

Titkok CI-ben

A környezeti változó titokforrást érdemes használni: a titkot a CI széfje injektálja, a Restorm csak beolvassa, és semmi nem kerül a projektfájlba. Lásd: Titkok.

A verzió rögzítése

A letöltési csatorna verziózott fájlokat tesz közzé (restorm_<version>_amd64.deb): nincs latest alias. A verziót rögzíteni kell a pipeline-ban — CI-ben egyébként is ez a cél, hogy egy új verzió felülvizsgálat nélkül ne változtassa meg egy feladat viselkedését. A legutóbbi verzió pontos fájlnevei ugyanazon csatorna latest-linux.yml manifesztjében szerepelnek.

GitHub Actions

name: Tests d'API
on: [push]

jobs:
  api:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Installer Restorm
        env:
          RESTORM_VERSION: '1.4.2' # a rögzítendő verzió
        run: |
          curl -sSL -o restorm.deb \
            "https://dl.restorm.app/restorm_${RESTORM_VERSION}_amd64.deb"
          sudo apt-get install -y ./restorm.deb

      - name: Exécuter les tests de fumée
        env:
          RESTORM_TOKEN: ${{ secrets.RESTORM_TOKEN }}
          API_TOKEN: ${{ secrets.API_TOKEN }}
        run: |
          xvfb-run -a restorm \
            --open ./api.restorm \
            --run "Find pets by status" \
            --headless \
            --all-logs \
            --out run.log \
            --param status=available

      - name: Publier le journal
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: journal-restorm
          path: run.log

GitLab CI

tests-api:
  image: ubuntu:24.04
  variables:
    RESTORM_TOKEN: $RESTORM_TOKEN
    RESTORM_VERSION: '1.4.2' # a rögzítendő verzió
  before_script:
    - apt-get update && apt-get install -y curl xvfb
    - curl -sSL -o restorm.deb "https://dl.restorm.app/restorm_${RESTORM_VERSION}_amd64.deb"
    - apt-get install -y ./restorm.deb
  script:
    - >
      xvfb-run -a restorm
      --open ./api.restorm
      --run "Find pets by status"
      --headless --all-logs --out run.log
      --param status=$PET_STATUS
  artifacts:
    when: always
    paths: [run.log]

Ami headless módban másképp működik

• A Toast műveletek nem tesznek semmit; a futtatás normálisan folytatódik.
• A paramétereket nem lehet interaktívan bekérni: mindegyiket a --param argumentummal kell megadni, vagy hagyni, hogy az alapértelmezett értékükre álljanak.
• Az MCP-kiszolgáló kijelző nélküli gépen soha nem indul el, a beállítástól függetlenül.

Token beszerzése

A RESTORM_TOKEN token (rstk_ előtaggal) a fiók irányítópultján generálható. A szervezethez van kötve, nem egy személyhez: ez az a token, amely a CI széfjébe kerül. Lásd: Fiókok és bejelentkezés.