WebDriverIO Reporters

One of the essential aspects of QA automation is generating comprehensive and readable reports to track test execution and the pass/failure status. WebDriverIO provides various built-in reporters that offer insights into test results. Below we will go over the various reporters you can use, with a brief description of the benefits they provide in terms of reporting and analysis.

Spec Reporter

The Spec Reporter is the default reporter provided by WebDriverIO. It displays test execution details in a human-readable format directly in your console. The Spec Reporter provides real-time feedback during test execution, making it ideal for debugging and quick visibility into test progress.

You can enable this reporter by modifying your wdio.conf.js file, as shown below.

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

Allure Reporter

The Allure Reporter is a powerful and visually appealing reporting framework that generates detailed HTML reports with rich information about test execution. It offers features like step-wise execution logging, attachments and categorization of test cases. The Allure Reporter makes it easier to analyze and share test results with various people.

// wdio.conf.js
exports.config = {
  // ...
  reporters: [['allure', {
    outputDir: './allure-results',
    disableWebdriverStepsReporting: true,
    disableWebdriverScreenshotsReporting: false,
  }]],
  // ...
};

JUnit Reporter

The JUnit Reporter generates XML based reports in the JUnit format. This format makes it compatible with popular CI/CD tools and test management systems. These reports can be easily integrated into existing pipelines and provide a standardized format for test result analysis.

// wdio.conf.js
exports.config = {
  // ...
  reporters: ['junit'],
  reporterOptions: {
    junit: {
      outputDir: './junit-results',
      outputFileFormat: function (opts) {
        return `results-${opts.cid}.${opts.capabilities.browserName}.xml`;
      },
    },
  },
  // ...
};