You can write your own custom service for the WDIO test runner to custom-fit your needs.
Services are add-ons that are created for reusable logic to simplify tests, manage your test suite and integrate results. Services have access to all the same hooks available in the
There are two types of services that can be defined: a launcher service that only has access to the
onComplete hook which are only executed once per test run, and a worker service that has access to all other hooks and is being executed for each worker. Note that you can not share (global) variables between both types of services as worker services run in a different (worker) process.
A launcher service can be defined as follows:
Whereas a worker service should look like this:
It is recommended to store the browser object through the passed in parameter in the constructor. Lastly expose both types of workers as following:
An Error thrown during a service hook will be logged while the runner continues. If a hook in your service is critical to the setup or teardown of the test runner, the
SevereServiceError exposed from the
webdriverio package can be used to stop the runner.
The only thing to do now in order to use this service is to assign it to the
wdio.conf.js file to look like this:
To make services easier to consume and discover by the WebdriverIO community, please follow these recommendations:
- Services should use this naming convention:
- Use NPM keywords:
exportan instance of the service
- Example services:
Following the recommended naming pattern allows services to be added by name:
We really appreciate every new plugin that could help other people run better tests! If you have created such a plugin, please consider adding it to our CLI and docs to make it easier to be found.
Please raise a pull request with the following changes: