---
title: "Gherkin Reference"
vignette: >
  %\VignetteIndexEntry{Gherkin Reference}
  %\VignetteEngine{quarto::html}
  %\VignetteEncoding{UTF-8}
---

This reference describes how to write Gherkin.

This is a modified copy of the official [Gherkin reference](https://cucumber.io/docs/gherkin/reference/) from Cucumber project, adjusted to specific features of the `{cucumber}` package.

---

Gherkin uses a set of special [keywords](#keywords) to give structure and meaning to executable specifications.

Most lines in a Gherkin document start with one of the [keywords](#keywords).

Comments are only permitted at the start of a new line, anywhere in the feature file. They begin with zero or more spaces, followed by a hash sign (`#`) and some text.

Block comments are currently not supported by Gherkin.

The recommended indentation level is two spaces. If you need other indentation see `?opts`.

Here is an example:

```gherkin
Feature: Guess the word
  # The first example has two steps
  Scenario: Maker starts a game
    When the Maker starts a game
    Then the Maker waits for a Breaker to join

  # The second example has three steps
  Scenario: Breaker joins a game
    Given the Maker has started a game with the word "silky"
    When the Breaker joins the Maker's game
    Then the Breaker must guess a word with 5 characters
```

Please note that some keywords _are_ followed by a colon (`:`) and some _are not_. If you add a colon after a keyword that should not be followed by one, your test(s) will be ignored.

# Keywords

Each line that isn't a blank line has to start with a Gherkin _keyword_, followed by any text you like. The only exceptions are the free-form descriptions placed underneath `Example/Scenario`, `Background` and `Scenario Outline` lines.

The primary keywords are:

- [Keywords](#keywords)
    - [Feature](#feature)
    - [Example](#example) (or `Scenario`)
    - [Steps](#steps)
      - [Given](#given)
      - [When](#when)
      - [Then](#then)
      - [And, But](#and-but)
      - [\*](#)
    - [Background](#background)
      - [Tips for using Background](#tips-for-using-background)
    - [Scenario Outline](#scenario-outline) (or `Scenario Template`)
    - [Examples](#examples)
  - [Step Arguments](#step-arguments)
    - [Doc Strings](#doc-strings)
    - [Data Tables](#data-tables)

There are a few secondary keywords as well:

* `"""` ([Doc Strings](#doc-strings))
* `|` ([Data Tables](#data-tables))
* `#` (Comments)

# Feature

The purpose of the `Feature` keyword is to provide a high-level description of a software feature, and to group related scenarios.

The first primary keyword in a Gherkin document must always be `Feature`, followed by a `:` and a short text that describes the feature.

You can add free-form text underneath Feature to add more description. These description lines are ignored by Cucumber at runtime.

```gherkin
Feature: Guess the word
  The word guess game is a turn-based game for two players.
  The Maker makes a word for the Breaker to guess. The game  is over when the Breaker guesses the Maker's word.

  Example: Maker starts a game
```

The name and the optional description have no special meaning to Cucumber. Their purpose is to provide a place for you to document important aspects of the feature, such as a brief explanation and a list of business rules (general acceptance criteria).

The free format description for Feature ends when you start a line with the keyword `Background`, `Example` or `Scenario Outline` (or their alias keywords).

You can only have a single `Feature` in a `.feature` file.

# Descriptions

Free-form descriptions (as described above for `Feature`) can also be placed underneath `Example/Scenario`, `Background` and `Scenario Outline`.

You can write anything you like, as long as no line starts with a keyword.

# Example

This is a _concrete example_ that _illustrates_ a business rule. It consists of a list of [steps](#steps).

The keyword `Scenario` is a synonym of the keyword `Example`.

You can have as many steps as you like, but we recommend 3-5 steps per example. Having too many steps will cause the example to lose its expressive power as a specification and documentation.

In addition to being a specification and documentation, an example is also a _test_. As a whole, your examples are an _executable specification_ of the system.

Examples follow this same pattern:

* Describe an initial context (`Given` steps)
* Describe an event (`When` steps)
* Describe an expected outcome (`Then` steps)

# Steps

Each step starts with `Given`, `When`, `Then`, `And`, or `But`.

Cucumber executes each step in a scenario one at a time, in the sequence you’ve written them in. When Cucumber tries to execute a step, it looks for a matching step definition to execute.

Keywords are not taken into account when looking for a step definition. This means you cannot have a `Given`, `When`, `Then`, `And` or `But` step with the same text as another step.

Cucumber considers the following steps duplicates:

```gherkin
Given there is money in my account
Then there is money in my account
```

This might seem like a limitation, but it forces you to come up with a less ambiguous, more clear domain language:

```gherkin
Given my account has a balance of £430
Then my account should have a balance of £430
```

## Given

`Given` steps are used to describe the initial context of the system - the _scene_ of the scenario. It is typically something that happened in the _past_.

When Cucumber executes a `Given` step, it will configure the system to be in a well-defined state, such as creating and configuring objects or adding data to a test database.

The purpose of `Given` steps is to **put the system in a known state** before the user (or external system) starts interacting with the system (in the `When` steps). Avoid talking about user interaction in `Given`'s. If you were creating use cases, `Given`'s would be your preconditions.

It's okay to have several `Given` steps (use `And` or `But` for number 2 and upwards to make it more readable).

Examples:

* Mickey and Minnie have started a game
* I am logged in
* Joe has a balance of £42

## When

`When` steps are used to describe an event, or an _action_. This can be a person interacting with the system, or it can be an event triggered by another system.

Examples:

* Guess a word
* Invite a friend
* Withdraw money

Imagine it's 1922

Most software does something people could do manually (just not as efficiently).

Try hard to come up with examples that don't make any assumptions about technology or user interface. Imagine it's 1922, when there were no computers.

Implementation details should be hidden in `step()`.

## Then

`Then` steps are used to describe an _expected_ outcome, or result.

The `step()` definition of a `Then` step should use an _assertion_ to compare the _actual_ outcome (what the system actually does) to the _expected_ outcome (what the step says the system is supposed to do).

An outcome _should_ be on an **observable** output. That is, something that comes _out_ of the system (report, user interface, message), and not a behaviour deeply buried inside the system (like a record in a database).

Examples:

* See that the guessed word was wrong
* Receive an invitation
* Card should be swallowed

While it might be tempting to implement `Then` steps to look in the database - resist that temptation!

You should only verify an outcome that is observable for the user (or external system), and changes to a database are usually not.

## And, But

If you have successive `Given`'s or `Then`'s, you _could_ write:

```gherkin
Example: Multiple Givens
  Given one thing
  Given another thing
  Given yet another thing
  When I open my eyes
  Then I should see something
  Then I shouldn't see something else
```

Or, you could make the example more fluidly structured by replacing the successive `Given`'s or `Then`'s with `And`'s and `But`'s:

```gherkin
Example: Multiple Givens
  Given one thing
  And another thing
  And yet another thing
  When I open my eyes
  Then I should see something
  But I shouldn't see something else
```

## \*

Gherkin also supports using an asterisk (`*`) in place of any of the normal step keywords. This can be helpful when you have some steps that are effectively a _list of things_, so you can express it more like bullet points where otherwise the natural language of `And` etc might not read so elegantly.

For example:

```gherkin
Scenario: All done
  Given I am out shopping
  And I have eggs
  And I have milk
  And I have butter
  When I check my list
  Then I don't need anything
```

Could be expressed as:

```gherkin
Scenario: All done
  Given I am out shopping
  * I have eggs
  * I have milk
  * I have butter
  When I check my list
  Then I don't need anything
```

# Background

Occasionally you'll find yourself repeating the same `Given` steps in all of the scenarios in a `Feature`.

Since it is repeated in every scenario, this is an indication that those steps are not _essential_ to describe the scenarios; they are _incidental details_. You can literally move such `Given` steps to the background, by grouping them under a `Background` section.

A `Background` allows you to add some context to the scenarios that follow it. It can contain one or more `Given` steps, which are run before _each_ scenario, but after any before `hook()`.

A `Background` is placed before the first `Scenario`/`Example`, at the same level of indentation.

For example:

```gherkin
Feature: Multiple site support
  Only blog owners can post to a blog, except administrators,  who can post to all blogs.

  Background:
    Given a global administrator named "Greg"
    And a blog named "Greg's anti-tax rants"
    And a customer named "Dr. Bill"
    And a blog named "Expensive Therapy" owned by "Dr. Bill"

  Scenario: Dr. Bill posts to his own blog
    Given I am logged in as Dr. Bill
    When I try to post to "Expensive Therapy"
    Then I should see "Your article was published."

  Scenario: Dr. Bill tries to post to somebody else's blog, and fails
    Given I am logged in as Dr. Bill
    When I try to post to "Greg's anti-tax rants"
    Then I should see "Hey! That's not your blog!"

  Scenario: Greg posts to a client's blog
    Given I am logged in as Greg
    When I try to post to "Expensive Therapy"
    Then I should see "Your article was published."
```

You can only have one set of `Background` steps per `Feature`. If you need different `Background` steps for different scenarios, consider breaking up your set of scenarios into more `Feature`s.

For a less explicit alternative to `Background`, check out `?hook`

## Tips for using Background

*   Don't use `Background` to set up **complicated states**, unless that state is actually something the client needs to know.
    *   For example, if the user and site names don't matter to the client, use a higher-level step such as `Given I am logged in as a site owner`.
*   Keep your `Background` section **short**.
    *   The client needs to actually remember this stuff when reading the scenarios. If the `Background` is more than 4 lines long, consider moving some of the irrelevant details into higher-level steps.
*   Make your `Background` section **vivid**.
    *   Use colourful names, and try to tell a story. The human brain keeps track of stories much better than it keeps track of names like `"User A"`, `"User B"`, `"Site 1"`, and so on.
*   Keep your scenarios **short**, and don't have too many.
    *   If the `Background` section has scrolled off the screen, the reader no longer has a full overview of what's happening. Think about using higher-level steps, or splitting the `*.feature` file.

# Scenario Outline

The `Scenario Outline` keyword can be used to run the same `Scenario` multiple times, with different combinations of values.

The keyword `Scenario Template` is a synonym of the keyword `Scenario Outline`.

Copying and pasting scenarios to use different values quickly becomes tedious and repetitive:

```gherkin
Scenario: eat 5 out of 12
  Given there are 12 cucumbers
  When I eat 5 cucumbers
  Then I should have 7 cucumbers
Scenario: eat 5 out of 20
  Given there are 20 cucumbers
  When I eat 5 cucumbers
  Then I should have 15 cucumbers
```

We can collapse these two similar scenarios into a `Scenario Outline`.

Scenario outlines allow us to more concisely express these scenarios through the use of a template with `< >`\-delimited parameters:

```gherkin
Scenario Outline: eating
  Given there are <start> cucumbers
  When I eat <eat> cucumbers
  Then I should have <left> cucumbers

  Examples:
    | start | eat | left |
    |    12 |   5 |    7 |
    |    20 |   5 |   15 |
```

# Examples

A `Scenario Outline` must contain one or more `Examples` (or `Scenarios`) section(s). Its steps are interpreted as a template which is never directly run. Instead, the `Scenario Outline` is run _once for each row_ in the `Examples` section beneath it (not counting the first header row).

The steps can use `<>` delimited _parameters_ that reference headers in the examples table. Cucumber will replace these parameters with values from the table _before_ it tries to match the step against a step definition.

If our `?step`s use {string} parameters, we must use quotes around the values in the table for them to match correctly.

```gherkin
Scenario Outline: eating
  Given there are <start> cucumbers
  When I eat <eat> cucumbers
  Then I should have <left> cucumbers

  Examples:
    | start    | eat    | left      |
    | 'twelve' | 'five' | 'seven'   |
    | 'twenty' | 'five' | 'fifteen' |
```

This Scenario Outline results in two Scenarios being run, with modified names to indicate which row of the examples table is being run:

```gherkin
Scenario: eating (Example 1)
  Given there are 'twelve' cucumbers
  When I eat 'five' cucumbers
  Then I should have 'seven' cucumbers

Scenario: eating (Example 2)
  Given there are 'twenty' cucumbers
  When I eat 'five' cucumbers
  Then I should have 'fifteen' cucumbers
```

<!-- You can use parameters in `Scenario Outline` descriptions as well. -->

<!-- You can also use parameters in [multiline step arguments](#step-arguments). -->

# Step Arguments

In some cases you might want to pass more data to a step than fits on a single line. For this purpose Gherkin has `Doc Strings` and `Data Tables`.

# Doc Strings

`Doc Strings` are handy for passing a larger piece of text to a step definition.

The text should be offset by delimiters consisting of three double-quote marks on lines of their own:

```gherkin
Given a blog post named "Random" with Markdown body
  """
  Some Title, Eh?
  ===============
  Here is the first paragraph of my blog post. Lorem ipsum dolor sit amet,  consectetur adipiscing elit.
  """
```

In your step definition, there’s no need to find this text and match it in your pattern.

It will automatically be passed as the last argument in the step definition. See `?step` for details.

Indentation of the opening `"""` is unimportant, although common practice is two spaces in from the enclosing step. The indentation inside the triple quotes, however, is significant. Each line of the Doc String will be dedented according to the opening `"""`. Indentation beyond the column of the opening `"""` will therefore be preserved.

Doc strings also support using three backticks or three single quotes as the delimiter.

# Data Tables

`Data Tables` are handy for passing a list of values to a step definition:

```gherkin
Given the following users exist:
  | name   | email              | twitter         |
  | Aslak  | [email protected]  | @aslak_hellesoy |
  | Julien | [email protected]  | @jbpros         |
  | Matt   | [email protected]  | @mattwynne      |
```

Just like `Doc Strings`, `Data Tables` will be passed to the step definition as the last argument. See `?step` for details.

#### Table Cell Escaping

If you want to use a newline character in a table cell, you can write this as `\n`. If you need a `|` as part of the cell, you can escape it as `\|`.
