WebdriverIO Test Ledger Service

WDIO service that takes results from wdio-test-ledger-reporter and uploads them to testledger.dev

testledger.dev stores and tracks all test runs with extensive details about each test. This gives you a historical overivew of how your tests are running.

Setup is very simple. All you need to do is add the service and reporter to the services and reporters arrays in your wdio.conf.js file.

Install the service

npm install wdio-test-ledger-service

Add the service to the services array in wdio.conf.js

services: [['test-ledger', {
	reporterOutputDir : `./testledger`,            // This must match the outputDir from the wdio-test-reporter
	apiUrl            : `app-api.testledger.dev`,  // Defaults to app-api.testledger.dev if none is set
	username          : `[email protected]`,      // app.testledger.dev username
	apiToken          : `12345`,                   // Found in the app.testledger.dev under your proifle section
	projectId         : 123,                       // Only needed if using more than one project
	appVersion        : `2.8.10`,                  // The code version can also be set here
	enableFlaky       : 1,                         // Will mark tests as flaky if it detects them based on previous runs
}]],

You will create a custom username and apiToken in the UI under Settings -> Profile -> API Keys

Add the wdio-test-ledger-reporter to the reporters array in wdio.conf.js

npm install wdio-test-ledger-reporter

reporters : [[`test-ledger`, {
	outputDir : `./testledger`
}]]

Environment variables

Environment variables can be set when running tests that the server will use to add to the results

• RUN_TITLE - Title of the test run. This might be something like a Jira issue key. Defaults to a timestamp if not specified
• RUN_UUID - UUID which can be used to directly link to the test run results. e.g. https://app.testledger.dev/runs/c26b23d8-eb9f-4ff4-a884-5cb9f3d3aba5
• APP_VERSION - Set the version of app this test run ran against