cucumber

What is cucumber?

Cucumber is a tool for running automated tests written in plain language. It allows you to write tests that anyone can understand, regardless of their technical knowledge. Cucumber supports Behavior Driven Development (BDD) and is used to bridge the communication gap between stakeholders and developers.

What are cucumber's main functionalities?

Writing Features in Gherkin

Cucumber uses Gherkin syntax to define test scenarios in plain language. This makes it easy for non-technical stakeholders to understand and contribute to the test cases.

Feature: User login
  Scenario: Successful login
    Given the user is on the login page
    When the user enters valid credentials
    Then the user should be redirected to the dashboard

Step Definitions

Step definitions are the actual code implementations of the steps defined in Gherkin. They link the plain language steps to executable code.

const { Given, When, Then } = require('@cucumber/cucumber');

Given('the user is on the login page', function () {
  // code to navigate to login page
});

When('the user enters valid credentials', function () {
  // code to enter credentials
});

Then('the user should be redirected to the dashboard', function () {
  // code to check redirection
});

Hooks

Hooks allow you to run code before and after each scenario. This is useful for setting up and tearing down test environments.

const { Before, After } = require('@cucumber/cucumber');

Before(function () {
  // code to run before each scenario
});

After(function () {
  // code to run after each scenario
});

Data Tables

Data tables allow you to run the same scenario with multiple sets of data. This is useful for testing different input combinations.

Feature: User login
  Scenario Outline: Successful login with multiple users
    Given the user is on the login page
    When the user enters <username> and <password>
    Then the user should be redirected to the dashboard

    Examples:
      | username | password |
      | user1    | pass1    |
      | user2    | pass2    |

Other packages similar to cucumber

jest-cucumber

jest-cucumber is a library that allows you to use Cucumber's Gherkin syntax with Jest. It provides a way to write BDD-style tests using Jest as the test runner. Compared to Cucumber, jest-cucumber is more tightly integrated with Jest and may be easier to set up for projects already using Jest.

cypress-cucumber-preprocessor

cypress-cucumber-preprocessor is a plugin for Cypress that allows you to write your tests in Gherkin syntax. It combines the power of Cypress for end-to-end testing with the readability of Cucumber. This package is ideal for teams that prefer using Cypress for their testing needs but want to leverage BDD.

codeceptjs

CodeceptJS is an end-to-end testing framework that supports BDD-style tests. It allows you to write tests in plain language and supports multiple test runners and helpers. Compared to Cucumber, CodeceptJS offers more flexibility in terms of test runners and integrations.

README

🚨🚨🚨

Cucumber is publishing new releases under @cucumber/cucumber on npm:
https://www.npmjs.com/package/@cucumber/cucumber

Features in the latest version include:

• BeforeEach and AfterEach hooks
• Searchable HTML reports
• Native ESM support
• Write scenarios in Markdown

Full changelog: https://github.com/cucumber/cucumber-js/blob/main/CHANGELOG.md
Upgrading guide: https://github.com/cucumber/cucumber-js/blob/main/UPGRADING.md

🚨🚨🚨

Cucumber

Cucumber is a tool for running automated tests written in plain language. Because they're written in plain language, they can be read by anyone on your team. Because they can be read by anyone, you can use them to help improve communication, collaboration and trust on your team.

Cucumber.js is the JavaScript implementation of Cucumber and runs on the maintained Node.js versions and modern web browsers.

Help & support

• See here: https://cucumber.io/support

Contributing

See CONTRIBUTING.md for info on contributing to Cucumber.js.

Code of Conduct

Everyone interacting in this codebase and issue tracker is expected to follow the Cucumber code of conduct.

Install

Node

Cucumber.js is available as an npm module.

$ npm install cucumber

Browser

• Grab the browserified code from the latest release in the dist folder

Documentation

The following documentation is for master. See below for documentation for older versions.

• CLI
• Custom Formatters
• Custom Snippet Syntaxes
• NodeJs Example
• Support Files
  • World
  • Step Definitions
  • Hooks
  • Timeouts
  • Data Table Interface
  • Attachments
  • API Reference
• FAQ

Documentation for older versions

• 5.x
• 4.x
• 3.x
• 2.x
• 1.x