Segédeszközök

Random (véletlen)


Bemenetek	`min`, `max` (számok), `seed`
Kimenetek	`result`

`op`	Visszaadott érték
`int`	Egy egész szám `min` és `max` között
`float`	Egy lebegőpontos szám
`string`	Egy `length` karakter hosszú karakterlánc
`boolean`	Egy logikai érték
`pick`	Egy elem az `items` listából

A seed mező (egy szám vagy egy karakterlánc) determinisztikussá teszi a sorsolást: így lehetnek változatosak az adatok, miközben a teszt reprodukálható marad. Ez a lényegi különbség a {{$random…}} helperekhez képest, amelyek soha nem reprodukálhatók.

Schema validate (sémaellenőrzés)


Bemenetek	`value`, `schema` (karakterlánc)
Kimenetek	`valid`, `invalid`, `errors`
Konfiguráció	`schema` — egy JSON Schema, draft-07, 2019-09 vagy 2020-12 verzióban

A legjobb eszköz annak ellenőrzésére, hogy egy válasz megfelel-e a szerződésének. Az errors portot érdemes egy Log blokkra kötni: a kimenet minden egyes szabálysértést részletez, amivel a CI-hiba azonnal felhasználhatóvá válik.

HTTP-kérés ──response[body]──► Schema validate
                                  ├─ valid   ──► (folytatás)
                                  ├─ invalid ──► Throw
                                  └─ errors  ──► Log

Read file (fájl beolvasása)


Bemenetek	`path` (karakterlánc)
Kimenetek	`content` (karakterlánc)
Konfiguráció	`path` — abszolút, vagy a megnyitott `.restorm` fájlhoz relatív

A relatív útvonal az, amellyel a forgatókönyv átvihető marad a saját gép és a CI között.

Write file (fájl írása)


Bemenetek	`path` (karakterlánc), `content`
Kimenetek	nincs
Konfiguráció	`path`, `mode`: `replace` (alapértelmezés) vagy `append`

Log (napló)


Bemenetek	`message` (karakterlánc), `data`
Kimenetek	nincs
Konfiguráció	`level`: `debug`, `info`, `warn`, `error`

Ez a nyomonkövetési blokk. Alapértelmezés szerint csak az ő bejegyzései jelennek meg a futtatási naplóban és a parancssor kimenetén — a motor bejegyzései csak az --all-logs kapcsolóval kerülnek be.

Másképp fogalmazva: ami a Log blokkba kerül, az található meg a CI artefaktumaiban is.

Assert (állítás)


Bemenetek	`a` (a megfigyelt érték), `b` (a várt érték), `message` (karakterlánc)
Kimenetek	`then` (sikeres), `else` (sikertelen)
Konfiguráció	`operator`, `a`, `b`, `message`

Az elérhető operátorok:

eq · ne · lt · lte · gt · gte · contains · isString · isNumber · isBoolean · isArray · isObject · isNull · exists · isEmpty · matchesRegex · isOneOf · deepEquals · lengthEq · lengthGt · lengthLt

A message mező az, ami a naplóban érthetővé teszi a hibát: azt kell beírni, hogy mi volt a várt eredmény, nem azt, hogy „hiba”.

Throw (hiba kiváltása)


Bemenetek	`message` (karakterlánc)
Kimenetek	nincs — ennek a blokknak nincs `done` portja
Konfiguráció	`message`

Szándékosan sikertelenné teszi a futtatást. Ez adja a CI-ben az 1-es kilépési kódot: a kritikus állítások else kimenetére vagy egy sémaellenőrzés invalid kimenetére kell kötni.