FAQ

Getting started and help 🔗︎

How do I get started with Cucumber? 🔗︎

To get started from scratch, try the 10-minute tutorial.

You can read these docs to learn more about Gherkin, Cucumber and BDD. There are also links to several blog posts about Cucumber and BDD.

Where can I get more in depth information? 🔗︎

If you’d like to go more in depth, try one of the following:

Where can I get help? 🔗︎

For questions, you can get in touch with the community.

Installing and running Cucumber 🔗︎

How do I install Cucumber? 🔗︎

How to install Cucumber, depends on which programming language you are using.

You can find information on how to install your flavour of Cucumber on the installation page.

Which version of Cucumber should I use? 🔗︎

In general, it is recommended to use the most recently released version of Cucumber for your programming language. Each release will fix known bugs and/or add new features.

You can find the most recent version of Cucumber either in the 10-minute tutorial, the installation page or on GitHub.

How do I run Cucumber? 🔗︎

For information on how to run Cucumber, see Running Cucumber.

For additional configuration options, see Configuration.

Cucumber says my steps are undefined, but I have implemented step definitions! 🔗︎

If Cucumber is telling you that your steps are undefined, when you have defined step definitions, this means that Cucumber cannot find your step definitions. You’ll need to make sure to specify the path to your step definitions (glue path) correctly.

How do I call other steps or scenarios? 🔗︎

Each scenario should be independent; you should be able to run them in any order or in parallel without one scenario interfering with another.

Each scenario should test exactly one thing so that when it fails, it fails for a clear reason. This means you wouldn’t reuse one scenario inside another scenario.

If your scenarios use the same or similar steps, or perform similar actions on your system, you can extract helper methods to do those things.

How to use helper methods 🔗︎

We will illustrate the use of helper methods with an example. For instance, let’s say you need to login to your application. If you want to (re)use this action as a step or part of another step, write a method for login.

public void login(String user, String pass) {

  // sendKeys to username field

  // sendKeys to password fields

  // click Login button

}

You can call this method from your step definition. You could even call several helper methods from one step definition; for instance, if you want to login and navigate to a particular page.

Of course, which helper methods you’ll need will depend on your application and your domain.

How detailed should my scenarios be? 🔗︎

Your scenarios should contain just enough information to describe the behaviour of the system. They should not describe the implementation of your application, as that might change - causing your tests to fail. They shouldn’t contain too many details, as this will distract from the actual behaviour.

Let’s illustrate this with an example. Imagine we have a process where the user will be notified of the result. At the moment that might be implemented as sending them an email, but that might change in the future (for instance, to a text message). You can specify the step as follows:

Then the user will be notified

This way, if the implementation of how the user is notified changes, you will only have to change the step definition (or the helper method called by that step definition), rather than the step itself and all underlying code.

For more information, have a look at Writing better Gherkin and/or Writing maintainable automated acceptance tests (pdf).

How can I specify my test cases in Excel / csv? 🔗︎

We advise you not to use Excel or csv files to define your test cases; using Excel or csv files is considered an anti-pattern.

One of the goals of Cucumber is to have executable specifications. This means your feature files should contain just the right level of information to document the expected behaviour of the system. If your test cases are kept in separate files, how would you be able to read the documentation?

This also means you shouldn’t have too many details in your feature file. If you do, you might consider moving them to your step definitions or helper methods. For instance, if you have a form where you need to populate lots of different fields, you might use the Builder pattern to do so.

How can I make Cucumber conditionally skip steps 🔗︎

Each scenario should test one thing and fail for one particular reason. This means there should be no reason to skip steps.

If there does seem to be a reason you’d want to skip steps conditionally, you probably have an anti-pattern. For instance, you might be trying to test multiple things in one scenario or you might not be in control of the state of your test environment or test data.

The best thing to do here is to fix the root cause.

Taking a screenshot after (failed) steps 🔗︎

Taking a screenshot when a scenario fails, might help you to figure out what went wrong. To take a screenshot on failure, you can configure an after hook.

Note that taking a screenshot after every step is considered an anti-pattern. You should be able to rely on your test automation, without having to check every step of your scenario with a screenshot. Your automation should be stable and tests should fail for a clear reason.

How do I share state between steps? 🔗︎


You can help us improve this documentation. Edit this page.