Headless kjøring og kontinuerlig integrasjon

Et scenario du har bygget i grensesnittet, kjører uten vindu fra kommandolinjen. Det er veien som gjør API-testene dine om til et trinn i en pipeline.

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

Pro-utgaven

Headless kjøring er inkludert i utgavene Pro og Enterprise. Den krever et organisasjonstoken, som oppgis i miljøvariabelen RESTORM_TOKEN. Se Planer og muligheter.

Argumentene

Argument	Rolle
--open <path>, -o	Prosjektet som skal åpnes. Påkrevd sammen med --run
--run <target>	Scenarioet som skal kjøres. Er det til stede, slås kommandolinjemodus på
--by <name|id>	Hvordan --run peker ut scenarioet: etter navn (standard) eller etter ID
--headless	Ingen vindu. Uten dette vises vinduet mens loggen ruller på konsollet
--param name=value	En verdi for en inndataparameter i scenarioet (en Input / Param-boks). Kan gjentas
--all-logs	Tar med motorens oppføringer også; som standard sendes bare de fra handlingen Log ut
--out <file>	Skriver loggen til en fil i tillegg, fortløpende
--clear-settings, -cls	Nullstiller innstillingene før start

En --param med feil form (uten =) meldes på feilutgangen og ignoreres. name= (tom verdi) godtas.

Verdiene konverteres etter parameterens erklærte type — se Variabler og data.

--param treffer scenarioets inndata, ikke miljøvariablene

--param mater Input / Param-boksene som er erklært i scenarioet — den endrer ikke en miljøvariabel. --param status=available ovenfor fungerer altså bare fordi scenarioet eksponerer en inndataparameter som heter status. Å prøve å overstyre grunn-URLen med --param baseUrl=… ville ikke ha noen effekt hvis baseUrl er en miljøvariabel: en verdi som lever i et miljø, kan ikke overstyres på kommandolinjen. Vil du gjøre en slik verdi styrbar fra CI, eksponerer du den som en inndataparameter i scenarioet (en Input / Param-boks) og kobler den opp der du trenger den.

Exit-kodene

Kode	Betydning
0	Scenarioet ble ferdig som det skulle
1	Feil, avbrudd eller en feil i motoren
2	Målet ble ikke funnet, --out-filen er utilgjengelig, eller --run uten --open
3	Rettighet avslått: RESTORM_TOKEN mangler, er ugyldig eller trukket tilbake, planen er utilstrekkelig, eller verifiseringspunktet er utilgjengelig

Det er denne konvensjonen som gjør resultatet direkte brukbart for en CI-runner.

Utdataene

Loggen skrives til standard ut, én oppføring om gangen, så snart den er produsert, som en YAML-sekvens:

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

Nivåene har en farget kule foran: ⚪ debug, 🔵 info, 🟠 warn, 🔴 error. Linjene brytes aldri — utdataene forblir grep-bare. Feilene går til standard feilutgang.

Det er nøyaktig den teksten som knappen «kopier loggen» i grensesnittet produserer: samme format på begge sider.

Hemmeligheter i CI

Bruk hemmelighetskilden miljøvariabel: hemmeligheten injiseres av hvelvet i CI, Restorm gjør ikke annet enn å lese den, og ingenting skrives til prosjektet. Se Hemmeligheter.

Lås versjonen

Nedlastingskanalen publiserer versjonerte filer (restorm_<version>_amd64.deb): det finnes ingen latest-alias. Lås versjonen i pipelinen din — det er uansett det man vil i CI, slik at en ny versjon ikke endrer oppførselen til en jobb uten at noen har sett på det. De eksakte filnavnene for siste versjon er listet i manifestet latest-linux.yml i den samme kanalen.

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' # versjonen du vil låse til
        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' # versjonen du vil låse til
  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]

Det som endrer seg i headless

• Toast-handlingene gjør ingenting; kjøringen fortsetter som normalt.
• Parameterne kan ikke etterspørres interaktivt: oppgi dem alle med --param, eller la dem ta standardverdien sin.
• MCP-serveren starter aldri på en maskin uten skjerm, uansett hvilken innstilling som er satt.

Skaffe et token

Tokenet RESTORM_TOKEN (med prefikset rstk_) genereres fra kontrollpanelet til kontoen din. Det er knyttet til organisasjonen, ikke til en person: det er tokenet man legger i hvelvet i CI. Se Kontoer og innlogging.