Suite files
Every field of a suite file.
A suite runs a list of tests in order against one target. Suites explains how a suite behaves; this page lists every field.
suite-id: s_dice-ego-veer-warp-ionic-trying-tur-cal-stride-battle
name: Komazon examples
target: komazon
context: Every test starts from the shop's home page.
setup:
- h_phi-arts-vis-band-aira-streng-twig-roi-mino-fold
use:
timeout:
step: 10m
test: 30m
navigation: 1m
tests:
- test: tests/examples/komazon-checkout.yaml
id: t_packer-staff-asha-lak-spill-usher-pele-allen-bid-done
- test: tests/examples/komazon-cart-total-bug.yaml
id: t_reduce-eva-elding-reset-lai-iban-rum-hin-parent-changsuite-id
A stable ID for the suite. The dashboard's suite editor creates one.
- Values
s_followed by ten lowercase words joined by hyphens.- Required
- Optional
- Default
- none.
name
The name shown in the terminal, the dashboard and reports.
- Values
- any text.
- Required
- Required
- Default
- none.
target
The app every test in the suite runs against. It replaces each test's own target.
- Values
- a target name from
registry.targets. - Required
- Required
- Default
- none.
context
Background every test in the suite reads before its first step.
- Values
- any text.
- Required
- Optional
- Default
- none.
setup and teardown
Hooks that run once before the first test and once after the last. Variables a setup hook writes reach every test.
- Values
- lists of hook IDs from your hooks file.
- Required
- Optional
- Default
- none.
tests
The tests, in the order they run. test is the file's path from the config file's folder, and id is that file's test-id. A mismatched ID stops the run.
- Values
- a list of at least one
{ test, id }entry. - Required
- Required
- Default
- none.
use
Run settings for every test in the suite. A test's own use still overrides them, except device and browser.remote: a suite runs every test on one device and in one place. The suite's pick wins, and tests that pick different ones stop the suite before it starts.
- Values
- the same keys as a test's
use. - Required
- Optional
- Default
- none.