Writing Tests

TestFlowKit scenarios live in .feature files written in Gherkin — plain English with a fixed structure. No coding required.

Basic structure

Feature: Login

  Scenario: Successful login
    Given the user goes to the "login" page
    When the user enters "john@example.com" into the "email" field
    And the user enters "mypassword" into the "password" field
    And the user clicks the "login" button
    Then the page title should be "Dashboard"

TestFlowKit matches steps by their text, not the keyword.

Writing a good scenario

1. Name the scenario clearly — what behavior and outcome?
2. Write steps as you'd explain them to a colleague
3. Keep one behavior per scenario
4. Use tags to group tests: @smoke, @regression

tkit run --tags @smoke
tkit run --tags "@login and not @slow"

Data in steps

Tables — key/value pairs:

And I set the following path parameters:
  | id | 123 |

Doc strings — multi-line text:

And I set the request body to:
  """
  { "name": "John", "email": "john@example.com" }
  """

Scenario Outline

Run the same steps with different data:

Scenario Outline: Login attempts
  When the user enters "<email>" into the "email" field
  And the user enters "<password>" into the "password" field
  Then the "<result>" should be visible

  Examples:
    | email             | password | result        |
    | valid@example.com | correct  | dashboard     |
    | bad@example.com   | wrong    | error_message |

Common patterns

Navigation:

Given the user goes to the "home" page
When the user clicks the "about" link
Then the current URL should contain "/about"

Forms:

When the user enters "Jane Doe" into the "name" field
And the user clicks the "submit" button
Then the "success_message" should be visible

Visibility:

Then the "sidebar" should be visible
And the "login_button" should not be visible

What developers set up for you

• testflowkit.yml — Page URLs, element selectors, API definitions
• Macros — Reusable login/setup flows (Macros)

When a test fails, share the scenario name, error message, and what you expected.

Use macros to hide repetitive setup steps.

Step catalog

Browse the Step Definitions catalog for every available sentence — searchable by keyword and category.

Next Steps

• Frontend Testing — UI testing guide
• Variables — Dynamic test data
• Common Issues — Troubleshooting