@wdio/spec-reporter

A WebdriverIO plugin to report in spec style

Usage no npm install needed!

<script type="module">
  import wdioSpecReporter from 'https://cdn.skypack.dev/@wdio/spec-reporter';
</script>

README

WDIO Spec Reporter

A WebdriverIO plugin to report in spec style.

Spec Reporter

Installation

The easiest way is to keep @wdio/spec-reporter as a devDependency in your package.json, via:

npm install @wdio/spec-reporter --save-dev

Instructions on how to install WebdriverIO can be found here.

Configuration

The following code shows the default wdio test runner configuration. Just add 'spec' as a reporter to the array.

// wdio.conf.js
module.exports = {
  // ...
  reporters: ['dot', 'spec'],
  // ...
};

Spec Reporter Options

symbols

Provide custom symbols for passed, failed and or skipped tests

Type: object Default: {passed: '✓', skipped: '-', failed: '✖'}

Example

[
  "spec",
  {
    symbols: {
      passed: '[PASS]',
      failed: '[FAIL]',
    },
  },
]

sauceLabsSharableLinks

By default the test results in Sauce Labs can only be viewed by a team member from the same team, not by a team member from a different team. This options will enable sharable links by default, which means that all tests that are executed in Sauce Labs can be viewed by everybody. Just add sauceLabsSharableLinks: false, as shown below, in the reporter options to disable this feature.

Type: boolean Default: true

Example

[
  "spec",
  {
    sauceLabsSharableLinks: false,
  },
]

onlyFailures

Print only failed specs results.

Type: boolean Default: false

Example

[
  "spec",
  {
    onlyFailures: true,
  },
]

addConsoleLogs

Set to true to show console logs from steps in final report

Type: boolean Default: false

[
  "spec",
  {
    addConsoleLogs: true,
  },
]

realtimeReporting

Set to true to display test status realtime than just at the end of the run

Type: boolean Default: false

[
  "spec",
  {
    realtimeReporting: true,
  },
]