@cucumber/cucumber

What is @cucumber/cucumber?

@cucumber/cucumber is a popular tool for Behavior-Driven Development (BDD). It allows you to write tests in a natural language that non-programmers can read, using Gherkin syntax. This makes it easier for teams to collaborate on defining the behavior of an application.

What are @cucumber/cucumber's main functionalities?

Defining Features with Gherkin

This feature allows you to define the behavior of your application in plain language using Gherkin syntax. The example defines a feature for user login with a scenario for successful login.

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 glue between Gherkin steps and the actual code that executes them. This example shows how to implement the steps defined in the Gherkin feature.

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
});

Running Tests

You can run your Cucumber tests using the `cucumber-js` command. This will execute all the feature files and their corresponding step definitions.

npx cucumber-js

Other packages similar to @cucumber/cucumber

jest-cucumber

jest-cucumber is a library that allows you to use Gherkin syntax with Jest, a popular JavaScript testing framework. It provides similar functionality to @cucumber/cucumber but is integrated with Jest, making it easier to use if you are already using Jest for your unit tests.

cypress-cucumber-preprocessor

cypress-cucumber-preprocessor is a plugin for Cypress that allows you to write your Cypress tests in Gherkin syntax. It combines the power of Cypress for end-to-end testing with the readability of Cucumber.

codeceptjs

CodeceptJS is an end-to-end testing framework that supports BDD-style tests using Gherkin syntax. It provides a high-level API for writing tests and supports multiple backends like WebDriver, Puppeteer, and TestCafe.

README

Cucumber.js

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.

Try it now

We've put a demo of Cucumber.js to run in your browser. Why don't you give it a try before anything else?

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.

6.x.x and below

$ npm install cucumber

7.x.x and above

(Not yet released)

$ npm install @cucumber/cucumber

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

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

Changelog

[7.0.0-rc.0] - 2020-09-14

Added

• Add --publish option to publish reports to reports.cucumber.io #1423, #1424
• Add support for Gherkin's Rule/Example syntax
• Add transpose method to data table interface
• Add log function to world, providing a shorthand to log plain text as attachment(s)
• Now includes TypeScript type definitions, deprecating the need for @types/cucumber in TypeScript projects

Changed

• The npm module has changed name from cucumber to @cucumber/cucumber - require/import statements must be changed from cucumber to @cucumber/cucumber
• TypeScript users must rename TableDefinition to DataTable
• Drop support for Node.js 8, add support for Node.js 14
• Events are now based on cucumber-messages
• event-protocol formatter has been removed and replaced with message
• Formatters
• Remove long-deprecated typeName from options object for defineParameterType in favour of name
• CUCUMBER_TOTAL_SLAVES is now CUCUMBER_TOTAL_WORKERS
• CUCUMBER_SLAVE_ID is now CUCUMBER_WORKER_ID
• Parallel runtime environment variables renamed for inclusivity:
• Custom formatters are now loaded via the regular require paths relative to the current directory, unless it begins with a dot (e.g. --format=./relpath/to/formatter). Previously this was always loaded as a file relative to the current directory.

Deprecated

• json formatter is deprecated and will be removed in next major release. Custom formatters should migrate to use the message formatter, or the standalone JSON formatter as a stopgap.

Fixed

• don't execute BeforeAll and AfterAll hooks when in dry-run
• support correct case for --retry-tag-filter CLI argument