wdio-cucumber-framework

WDIO Cucumber

A WebdriverIO plugin. Adapter for CucumberJS testing framework.

Installation

The easiest way is to keep wdio-cucumber-framework as a devDependency in your package.json.

{
  "devDependencies": {
    "wdio-cucumber-framework": "~0.2.0"
  }
}

You can simple do it by:

npm install wdio-cucumber-framework --save-dev

Instructions on how to install WebdriverIO can be found here.

Install Cucumber

Note that cucumber is defined as a peer dependency so make sure it is installed in your project as well.

{
  "devDependencies": {
    "cucumber": "~1.2.0"
  }
}

You can simply do it by:

npm install cucumber --save-dev

Configuration

Following code shows the default wdio test runner configuration...

// wdio.conf.js
module.exports = {
  // ...
  framework: 'cucumber'
  cucumberOpts: {
    timeout: 10000
  }
  // ...
};

cucumberOpts Options

backtrace

Show full backtrace for errors.

Type: Boolean
Default: false

compiler

Require files with the given EXTENSION after requiring MODULE.

Type: String[]
Default: *[]*
Example: ['js:babel-core/register']

dryRun

Invoke formatters without executing steps.

Type: Boolean
Default: false

failFast

Abort the run on first failure.

Type: Boolean
Default: false

format

Specify the output format, optionally supply PATH to redirect formatter output (repeatable).

Type: String[]
Default: ['pretty']

name

Only execute the scenarios with name matching the expression (repeatable).

Type: REGEXP[]
Default: []

colors

If false it disables colors in formatter output.

Type: Boolean
Default: true

snippets

Hide step definition snippets for pending steps.

Type: Boolean
Default: true

source

Hide source uris.

Type: Boolean
Default: true

profile

Specify the profile to use.

Type: String[]
Default: []

require

Require files/dir before executing features.

Type: String[]
Default: []

snippetSyntax

Specify a custom snippet syntax.

Type: String
Default: undefined

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.

Type: String[]
Default: []

timeout

Timeout in milliseconds for step definitions.

Type: Number
Default: 30000

ignoreUndefinedDefinitions

Please not that this is a wdio-cucumber-framework specifc option and not recognized by cucumber-js itself Treat undefined definitions as warnings.

Type: Boolean
Default: false

failAmbiguousDefinitions

Please note that this is a wdio-cucumber-framework specifc option and not recognized by cucumber-js itself Treat ambiguous definitions as errors.

Type: Boolean
Default: false

For more information on WebdriverIO see the homepage.