@wdio/spec-reporter

What is @wdio/spec-reporter?

@wdio/spec-reporter is a WebdriverIO plugin that provides a detailed and formatted output of test results. It is designed to give a clear and concise summary of test execution, including information about passed, failed, and skipped tests. This reporter is particularly useful for developers and testers who want to quickly understand the outcome of their test suites.

What are @wdio/spec-reporter's main functionalities?

Formatted Test Results

This feature provides a formatted output of test results, including stack traces for failed tests, summaries of failures and pending tests, and durations of test execution. The configuration options allow customization of what information is displayed.

const { SpecReporter } = require('@wdio/spec-reporter');

exports.config = {
  reporters: ['spec'],
  reporterOptions: {
    spec: {
      displayStacktrace: 'all',
      displayFailuresSummary: true,
      displayPendingSummary: true,
      displaySuccessfulSpec: true,
      displayFailedSpec: true,
      displayPendingSpec: true,
      displayDuration: true
    }
  }
};

Customizable Output

This feature allows customization of the symbols used in the output for passed, failed, and pending tests. This can help in making the test results more readable and aligned with the team's preferences.

const { SpecReporter } = require('@wdio/spec-reporter');

exports.config = {
  reporters: ['spec'],
  reporterOptions: {
    spec: {
      symbols: {
        passed: '[PASS]',
        failed: '[FAIL]',
        pending: '[PEND]'
      }
    }
  }
};

Integration with WebdriverIO

The @wdio/spec-reporter integrates seamlessly with WebdriverIO, making it easy to add to your existing WebdriverIO configuration. This feature ensures that the reporter works out of the box with WebdriverIO's test runner.

const { SpecReporter } = require('@wdio/spec-reporter');

exports.config = {
  reporters: ['spec'],
  reporterOptions: {
    spec: {
      displayStacktrace: 'summary'
    }
  }
};

Other packages similar to @wdio/spec-reporter

mochawesome

Mochawesome is a reporter for the Mocha test framework that generates a visually appealing HTML/CSS report. It provides detailed information about test results, including screenshots and stack traces. Compared to @wdio/spec-reporter, mochawesome offers more visual customization and is specifically designed for Mocha.

jasmine-spec-reporter

Jasmine-spec-reporter is a custom reporter for the Jasmine test framework that provides a detailed and formatted output of test results. It offers similar functionalities to @wdio/spec-reporter, such as displaying stack traces and summaries of test results. However, it is tailored for use with Jasmine rather than WebdriverIO.

karma-spec-reporter

Karma-spec-reporter is a reporter for the Karma test runner that provides a concise and readable output of test results. It is similar to @wdio/spec-reporter in terms of providing formatted test results, but it is designed to work with the Karma test runner instead of WebdriverIO.

README

WDIO Spec Reporter

A WebdriverIO plugin to report in spec style.

Installation

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

{
  "devDependencies": {
    "@wdio/spec-reporter": "^5.0.0"
  }
}

You can simple do it by:

$ 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'],
  // ...
};