@wdio/cucumber-framework

WDIO Cucumber Framework Adapter =============================== > A WebdriverIO plugin. Adapter for CucumberJS v5 testing framework. ## Installation The easiest way is to keep `@wdio/cucumber-framework` as a devDependency in your `package.json`, via: ```sh npm install @wdio/cucumber-framework --save-dev ``` Instructions on how to install `WebdriverIO` can be found [here.](https://webdriver.io/docs/gettingstarted.html) ## Configuration Following code shows the default wdio test runner configuration... ```js // wdio.conf.js module.exports = { // ... framework: 'cucumber', cucumberOpts: { timeout: 10000 } // ... }; ``` ## `cucumberOpts` Options ### backtrace Show full backtrace for errors. Type: `Boolean` Default: `false` ### requireModule Require modules prior to requiring any support files. Type: `String[]` Default: `[]` Example: `['@babel/register']` or `[['@babel/register', { rootMode: 'upward', ignore: ['node_modules'] }]]` ### failFast Abort the run on first failure. Type: `Boolean` Default: `false` ### name Only execute the scenarios with name matching the expression (repeatable). Type: `REGEXP[]` Default: `[]` ### require Require files containing your step definitions before executing features. You can also specify a glob to your step definitions. Type: `String[]` Default: `[]` Example: `[path.join(__dirname, 'step-definitions', 'my-steps.js')]` ### import Paths to where your support code is, for ESM. Type: `String[]` Default: `[]` Example: `[path.join(__dirname, 'step-definitions', 'my-steps.js')]` ### strict Fail if there are any undefined or pending steps Type: `Boolean` Default: `false` ### tags Only execute the features or scenarios with tags matching the expression. Note that untagged features will still spawn a Selenium session (see issue [webdriverio/webdriverio#1247](https://github.com/webdriverio/webdriverio/issues/1247)). Please see the [Cucumber documentation](https://docs.cucumber.io/cucumber/api/#tag-expressions) for more details. If passing as a command-line argument, compound expressions may need to be enclosed in three sets of double quotes if WebdriverIO is invoked using `npx` on Windows. E.g.: `npx wdio wdio.config.js --cucumberOpts.tags """@Smoke and not @Pending"""` Type: `String` Default: `` ### timeout Timeout in milliseconds for step definitions. Type: `Number` Default: `30000` ### retry Specify the number of times to retry failing test cases. Type: `Number` Default: `0` ### retryTagFilter Only retries the features or scenarios with tags matching the expression (repeatable). This option requires '--retry' to be specified. Type: `RegExp` ### language Default language for your feature files Type: `String` Default: `en` ### order Run tests in defined / random order Type: `String` Default: `defined` ### format Name and output file path of formatter to use. WebdriverIO primarily supports only the [Formatters](https://github.com/cucumber/cucumber-js/blob/main/docs/formatters.md) that writes output to a file. Type: `string[]` ### formatOptions Options to be provided to formatters Type: `object` ### tagsInTitle Add cucumber tags to feature or scenario name Type: `Boolean` Default: `false` ***Please note that this is a @wdio/cucumber-framework specific option and not recognized by cucumber-js itself*** ### ignoreUndefinedDefinitions Treat undefined definitions as warnings. Type: `Boolean` Default: `false` ***Please note that this is a @wdio/cucumber-framework specific option and not recognized by cucumber-js itself*** ### failAmbiguousDefinitions Treat ambiguous definitions as errors. Type: `Boolean` Default: `false` ***Please note that this is a @wdio/cucumber-framework specific option and not recognized by cucumber-js itself*** ### tagExpression Only execute the features or scenarios with tags matching the expression. Note that untagged features will still spawn a Selenium session (see issue [webdriverio/webdriverio#1247](https://github.com/webdriverio/webdriverio/issues/1247)). Please see the [Cucumber documentation](https://docs.cucumber.io/cucumber/api/#tag-expressions) for more details. If passing as a command-line argument, compound expressions may need to be enclosed in three sets of double quotes if WebdriverIO is invoked using `npx` on Windows. E.g.: `npx wdio wdio.config.js --cucumberOpts.tagExpression """@Smoke and not @Pending"""` Type: `String` Default: `` ***Please note that this option would be deprecated in future. Use [`tags`](#tags) config property instead*** ### profile Specify the profile to use. Type: `string[]` Default: `[]` ***Kindly take note that only specific values (worldParameters, name, retryTagFilter) are supported within profiles, as `cucumberOpts` takes precedence. Additionally, when using a profile, make sure that the mentioned values are not declared within `cucumberOpts`.*** ## Publishing Report Cucumber provides a feature to publish your test run reports to `https://reports.cucumber.io/`, which can be controlled either by setting the `publish` flag in `cucumberOpts` or by configuring the `CUCUMBER_PUBLISH_TOKEN` environment variable. However, when you use `WebdriverIO` for test execution, there's a limitation with this approach. It updates the reports separately for each feature file, making it difficult to view a consolidated report. To overcome this limitation, we've introduced a promise-based method called `publishCucumberReport` within `@wdio/cucumber-framework`. This method should be called in the `onComplete` hook, which is the optimal place to invoke it. `publishCucumberReport` requires the input of the report directory where cucumber message reports are stored. You can generate `cucumber message` reports by configuring the `format` option in your `cucumberOpts`. It's highly recommended to provide a dynamic file name within the `cucumber message` format option to prevent overwriting reports and ensure that each test run is accurately recorded. Before using this function, make sure to set the following environment variables: - CUCUMBER_PUBLISH_REPORT_URL: The URL where you want to publish the Cucumber report. If not provided, the default URL 'https://messages.cucumber.io/api/reports' will be used. - CUCUMBER_PUBLISH_REPORT_TOKEN: The authorization token required to publish the report. If this token is not set, the function will exit without publishing the report. Here's an example of the necessary configurations and code samples for implementation: ```javascript import { v4 as uuidv4 } from 'uuid' import { publishCucumberReport } from '@wdio/cucumber-framework'; export const config = { // ... Other Configuration Options cucumberOpts: { // ... Cucumber Options Configuration format: [ ['message', `./reports/${uuidv4()}.ndjson`], ['json', './reports/test-report.json'] ] }, async onComplete() { await publishCucumberReport('./reports'); } } ``` Please note that `./reports/` is the directory where `cucumber message` reports will be stored. ---- For more information on WebdriverIO see the [homepage](http://webdriver.io).