A WebdriverIO plugin. Adapter for Cucumber.js testing framework.
npm install @wdio/cucumber-frameworkWDIO Cucumber Framework Adapter
===============================
> A WebdriverIO plugin. Adapter for CucumberJS v5 testing framework.
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.
Following code shows the default wdio test runner configuration...
`js`
// wdio.conf.js
module.exports = {
// ...
framework: 'cucumber',
cucumberOpts: {
timeout: 10000
}
// ...
};
OptionsType: Boolean
Default:
Type: String[]
Default:
Example: or [['@babel/register', { rootMode: 'upward', ignore: ['node_modules'] }]]
Type: Boolean
Default:
Type: REGEXP[]
Default:
Type: String[]
Default:
Example:
Type: String[]
Default:
Example:
Type: Boolean
Default:
on Windows.E.g.:
npx wdio wdio.config.js --cucumberOpts.tags """@Smoke and not @Pending"""Type:
Default: $3
Timeout in milliseconds for step definitions.Type:
Default: $3
Specify the number of times to retry failing test cases.Type:
Default: $3
Only retries the features or scenarios with tags matching the expression (repeatable). This option requires '--retry' to be specified.Type:
$3
Default language for your feature filesType:
Default: $3
Run tests in defined / random orderType:
Default: $3
Name and output file path of formatter to use.
WebdriverIO primarily supports only the Formatters that writes output to a file.Type:
$3
Options to be provided to formattersType:
$3
Add cucumber tags to feature or scenario nameType:
Default: Please note that this is a @wdio/cucumber-framework specific option and not recognized by cucumber-js itself
$3
Treat undefined definitions as warnings.Type:
Default: Please note that this is a @wdio/cucumber-framework specific option and not recognized by cucumber-js itself
$3
Treat ambiguous definitions as errors.Type:
Default: Please note that this is a @wdio/cucumber-framework specific option and not recognized by cucumber-js itself
$3
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).
Please see the Cucumber documentation 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 on Windows.E.g.:
npx wdio wdio.config.js --cucumberOpts.tagExpression """@Smoke and not @Pending"""Type:
Default: Please note that this option would be deprecated in future. Use
config property instead$3
Specify the profile to use.Type:
string[]
Default: Kindly take note that only specific values (worldParameters, name, retryTagFilter) are supported within profiles, as
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
is the directory where cucumber message` reports will be stored.----
For more information on WebdriverIO see the homepage.