Macros

Macros are reusable scenarios you define once and call with different parameters. Use ${variable} placeholders in the macro, then pass values via a data table at call time.

Define a macro

Tag the scenario with @macro and use ${variable_name} for placeholders:

@macro
Scenario: Login as user
  Given the user goes to the "login" page
  When the user enters "${email}" into the "email" field
  And the user enters "${password}" into the "password" field
  And the user clicks the "login" button
  Then the "dashboard" should be visible

Call a macro

Use the scenario name as a step, followed by a two-column table (variable | value):

Scenario: Admin can access dashboard
  Given Login as user
    | email    | admin@example.com |
    | password | admin123          |
  When the user clicks the "admin_panel" link
  Then the "admin_dashboard" should be visible

Each row maps one ${variable} to a value. Missing variables cause the macro to fail.

API example

@macro
Scenario: I try to create a new post with the following details:
  Given I prepare a request to "jsonplaceholder.create_post"
  When I set the request body to:
    """
    {
      "title": "${title}",
      "body": "${body}",
      "userId": ${userId}
    }
    """
  And I send the request

Scenario: Create a new post
  When I try to create a new post with the following details:
    | title  | Test Post Title |
    | body   | Test body       |
    | userId | 1               |
  Then the response status code should be 201

Tips

• Keep macros focused — one clear action per macro
• Put macro definitions in a dedicated features/macros/ folder
• Macro scenarios are excluded from normal test runs (only invoked explicitly)
• Variable names in the table must match ${placeholders} exactly

Troubleshooting

Next Steps

• Global Hooks — Setup and teardown across the suite
• Variables — Scenario and environment variables