Timeline Reporter
wdio-timeline-reporter is a 3rd party package, for more information please see GitHub | npm
A one stop shop WebdriverIO reporter for an aggregated visualisation of your test results because "Seeing is believing"
Why
Because we spend a lot of time debugging failing tests switching from terminal output to viewing error screenshots etc. This reporter aggregates all the typical information you will need into one report. Run tests and have a nice timeline of events you can look back at to further verify everything looks ok.
Features include:
- Works great with Mocha and Jasmine frameworks. Also works with Cucumber but every step will be reported as a test
- Loud Summary of the Test Results.
- Detail of each test run including all screenshots captured during test execution.
- Test Results filtering. Great for focusing on failed tests
- Error stack trace attached to test.
- Ability to add additional information to test at runtime.
- No post processing required. On completion of wdio test process, a static html report file will get generated.
- Timeline service to manage the taking of screenshots including resizing of the images.
An example html report can be found here
Instructions on how to install WebdriverIO
can be found here.
Installation
FOR VERSION COMPATIBLE WITH WEBDRIVERIO V4 SEE HERE
npm install --save wdio-timeline-reporter
A dependency will be added to your package.json
{
"dependencies": {
"wdio-timeline-reporter": "^5.1.0"
}
}
Usage
Add timeline
to the reporters array in your wdio config file.
Also import and add TimelineService
from wdio-timeline-reporter.
Service is mandatory to combine reports and create html as reporters are now initialised per runner instance in webdriverio 5. See open discussion on webdriverio
The TimelineService can also manage taking of screenshots during tests execution. You have the option to reduce the size and quality of the images and to embed the images into the report as base64. These are configurable using the reporter options.
// wdio.conf.js
const { TimelineService } = require('wdio-timeline-reporter/timeline-service');
exports.config = {
// ...
reporters: [['timeline', { outputDir: './desired_location' }]],
// ...
services: [[TimelineService]]
};