wdio-watr-reporter v0.0.6
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
TODO: This will need to change when we host internally
npm i 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.
TODO: Due to an issue with the way ES6 imports work in WDIO projects the import has to be formatted oddly. Will need to research a fix for this.
// wdio.conf.js
var customWatrReporter = require('wdio-watr-reporter').default;
After you have imported the custom report you can now add it to the reporter
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', 'json'],
reporterOptions: {
outputDir: './reports',
combined: true
},
// ...
};
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 following property.
// wdio.conf.js
module.exports = {
// ...
reporters: ['dot', customWatrReporter],
reporterOptions: {
outputDir: './reports',
combined: true,
filename: 'wdio-results'
},
// ...
};
You can also choose to send the reporter output to stdout instead of writing to a file:
// wdio.conf.js
module.exports = {
// ...
reporters: [customWatrReporter],
reporterOptions: {
useStdout: true,
combined: 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.
TODO: We may have to restructure the Selenium-Common project because it doesn't feel like the upload scripts belong there.