Documentation Index
Fetch the complete documentation index at: https://docs.openqa.io/llms.txt
Use this file to discover all available pages before exploring further.
YAML Test Format
The simplest way to write browser tests.
Example
name: TodoMVC Tests
url: https://demo.playwright.dev/todomvc/
tests:
- name: Add todo item
tags: [smoke]
steps:
- Navigate to the TodoMVC home page
- Add a new todo item "Buy groceries"
- Verify "Buy groceries" appears in the todo list
- name: Complete and filter todos
tags: [smoke, regression]
steps:
- Navigate to the TodoMVC home page
- Add three todo items "Task 1", "Task 2", and "Task 3"
- Mark the first todo as completed
- Click the Active filter
- Verify 2 active todos are shown
Schema
| Field | Required | Description |
|---|
name | Yes | Test suite name |
url | No | Base URL for all tests |
tests | Yes | Array of test cases |
tests[].name | Yes | Individual test name |
tests[].tags | No | Tags for filtering |
tests[].steps | Yes | Natural language steps |
Running
Filter by tag:
npm test -- --grep @smoke
Writing Steps
Steps are natural language instructions. Be specific:
- Navigate to "https://example.com/login"
- Enter "user@test.com" in the email field
- Click the "Sign In" button
- Verify "Dashboard" appears in the heading
- Go to login
- Log in
- Check dashboard
Tips
- Include URLs in navigation steps
- Use quotes for specific text values
- Be explicit about what to verify
