Serenity/JS Cucumber



@serenity-js/cucumber integrates Serenity/JS with Cucumber,
enabling you to run automated, plain-language scenarios with rich reporting and powerful Screenplay-based abstractions.

Features

- Integrates Serenity/JS with Cucumber.js
- Supports all Cucumber.js versions from 0.x to 12.x
- Enriches Serenity reports with Gherkin feature descriptions, scenarios, and steps
- Supports using Screenplay Pattern APIs in step definitions

Installation

``
npm install --save-dev @serenity-js/cucumber @serenity-js/core
`

See the Serenity/JS Installation Guide.

Quick Start

`ts
import { actorCalled, actorInTheSpotlight } from '@serenity-js/core';
import { Given, When, Then } from '@cucumber/cucumber';
import { Ensure, equals } from '@serenity-js/assertions';

Given('{word} has {int} apples', async (actorName: string, count: number) => {
// Create or retrieve the actor by name
await actorCalled(actorName).attemptsTo(
// Add tasks or interactions
);
});

When('she adds {int} apples', async (count: number) => {
// Retrieve the most recently used actor
await actorInTheSpotlight().attemptsTo(
// Add tasks or interactions
)
});

Then('she has {int} apples', async (expectedCount: number) => {
await actorInTheSpotlight().attemptsTo(
Ensure.that(/ actual count /, equals(expectedCount))
)
})
`

Explore practical examples and in-depth explanations in the Serenity/JS Handbook.

Configuration

When using Serenity/JS with WebdriverIO, follow the official Serenity/JS WebdriverIO + Cucumber integration guide.

To use Serenity/JS with Cucumber and Playwright, follow the steps below, or use one of the available Serenity/JS Project Templates.

$3

Use the cucumber.js configuration file
to set up Cucumber to use Serenity/JS as the "formatter" and load extra *.config.ts files.

`javascript
// cucumber.js
module.exports = {
default: {
// Use TypeScript in-memory transpiler, ts-node
// requires npm install --save-dev ts-node
requireModule: ['ts-node/register'],

// Use Serenity/JS Cucumber adapter
format: ['@serenity-js/cucumber'],
// Configure the adapter
formatOptions: {
specDirectory: 'features'
},
require: [
// Load configuration files
'./features/*/.config.ts',
// Load step definition libraries
'./features/*/.steps.ts'
],
}
}
`

$3

To configure Serenity/JS, create a serenity.config.ts file with the following content:

`typescript
// features/support/serenity.config.ts
import { configure, Cast } from '@serenity-js/core'
import { BeforeAll } from '@cucumber/cucumber'

BeforeAll(async () => {

// ... start any services or browsers here

// Configure Serenity/JS
configure({

actors: Cast.where(actor => {
return actor.whoCan(
// ... add abilities here
)
}),

crew: [
[ '@serenity-js/console-reporter', { theme: 'auto' } ],
// ... add other crew members here
]
})
})
``

See the Serenity/JS configuration options and reporting guide.

Documentation

- API Reference
- Screenplay Pattern Guide
- Serenity/JS Project Templates
- Tutorial: First Web Scenario
- Tutorial: First API Scenario

Contributing

Contributions of all kinds are welcome! Get started with the Contributing Guide.

Community

- Community Chat
- Discussions Forum
- Visit the 💡How to... ? section for answers to common questions

If you enjoy using Serenity/JS, make sure to star ⭐️ Serenity/JS on GitHub to help others discover the framework!

License

The Serenity/JS code base is licensed under the Apache-2.0 license,
while its documentation and the Serenity/JS Handbook are licensed under the Creative Commons BY-NC-SA 4.0 International.

See the Serenity/JS License.

Support

Support ongoing development through GitHub Sponsors. Sponsors gain access to Serenity/JS Playbooks
and priority help in the Discussions Forum.

For corporate sponsorship or commercial support, please contact Jan Molak.