Spec reference

A test is one YAML file in tests/, named <name>.test.yaml. It holds a name, a start URL and a list of steps written in plain English. The platform resolves each step against the live page at run time.

Full example

tests/checkout.test.yaml
1name: Checkout with a saved card2url: https://app.example.com3tags: [checkout, smoke]4env:5  EMAIL: ${TEST_EMAIL}6  PASSWORD: ${TEST_PASSWORD}7steps:8  - Log in with EMAIL and PASSWORD9  - Open the cart10  - Click "Checkout"11  - Choose the saved card ending in 424212  - Click "Place order"13  - assert: The order confirmation page shows an order number14  - api:15      get: /api/orders/latest16      expect:17        status: 20018        body.status: confirmed

Fields

FieldRequiredTypeMeaning
nameyesstringThe test name shown in run output, reports and pull request checks.
urlyesstringThe page the test starts on.
tagsnolistLabels used to select a group of tests with --tag.
envnomapNamed values taken from environment variables, used inside steps by name.
stepsyeslistThe steps, in order. See Steps.

In this section