WDIO WATR REPORTER

A custom report for WebdriverIO projects looking to upload their results to the Work & Co Automation Test Reporter (WATR)

This project was derived from the 'wdio-junit-reporter' found here

Installation

The custom reporter can be installed via npm module by using the npm install command. We have hosted the reporter in our internal workco organization so you will need to include the @workco scope

npm i @workco/wdio-watr-reporter

Instructions on how to install WebdriverIO can be found here.

Configuration

After installing the custom reporter you will need include it in your test config file in order to add it to the Reporters option. Do not forget to include the @workco scope when importing.

NOTE: You must append .default when importing. This is due to some problems with ES6 imports in WDIO currently.

// wdio.conf.js
var customWatrReporter = require('@workco/wdio-watr-reporter').default;

After you have imported the custom report you can now add it to the reporters option in your WDIO config file. If you would like to run a stdout test report you can include it in the array with the imported custom report

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

For the sake of maintaining consistent WATR index mappings we recommend setting reporterOptions with the combined property to true and also setting the outputDir to ./reports

// wdio.conf.js
module.exports = {
  // ...
  reporters: ['dot', customWatrReporter],
  reporterOptions: {
    outputDir: './reports'
  },
  // ...
};

By default the custom reporter pulls the name and version from your package.json file to build your filename. If you wish to specify a custom filename you can set the filename property.

// wdio.conf.js
module.exports = {
  // ...
  reporters: ['dot', customWatrReporter],
  reporterOptions: {
    outputDir: './reports',
    filename: 'wdio-results.json'
  },
  // ...
};

You can also choose to send the reporter output to the console (Stdout) instead of writing to a file:

// wdio.conf.js
module.exports = {
  // ...
  reporters: [customWatrReporter],
  reporterOptions: {
    useStdout: true
  },
  // ...
};

If you do not want to print out the mocha epilogue (i.e. 1 passing (5.2s)), you can suppress it:

// wdio.conf.js
module.exports = {
  // ...
  reporters: [customWatrReporter],
  reporterOptions: {
    suppressEpilogue: true
  },
  // ...
};

Upload to WATR

If you are using this custom report you are most likely interested in uploading your report to WATR, a system for aggregating and analysing test reports from all of Work & Co's internal projects using automated testing. Please visit the Workco-Selenium-Common home page for information regarding uploading your test results.