# wdio-test-reporter-service

> WebdriverIO server to send reporter data to testreporter.io

Latest version **9.0.24** (published 2025-09-28) · ISC license · 0 weekly downloads

## Install

```sh
npm install wdio-test-reporter-service
pnpm add wdio-test-reporter-service
yarn add wdio-test-reporter-service
bun add wdio-test-reporter-service
```

## Health

**Score 30/100 (F)** — status: maintenance-mode.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 9.0.24 |
| Published | 2025-09-28 |
| First published | 2021-02-21 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | 20.x |
| Dependencies | 3 |
| Unpacked size | 9.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Will Brock |
| Maintainers | willbrock |
| Keywords | WebdriverIO, tests, test, e2e, wdio, testing, reporter, service |

## Links

- npm: https://www.npmjs.com/package/wdio-test-reporter-service
- Repository: https://github.com/WillBrock/wdio-test-reporter-service
- Homepage: https://github.com/WillBrock/wdio-test-reporter-service#readme
- Issues: https://github.com/WillBrock/wdio-test-reporter-service/issues
- npm.io page: https://npm.io/package/wdio-test-reporter-service

## Dependencies (3)

- [btoa](https://npm.io/package/btoa.md) ^1.2.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^11.2.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^3.3.2

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads
- [aws-elasticsearch-connector](https://npm.io/package/aws-elasticsearch-connector.md) — 37.4K weekly downloads

## Recent versions

- 9.0.24 (latest) — 2025-09-28
- 9.0.23 — 2025-09-24
- 9.0.22 — 2025-09-21
- 9.0.21 — 2025-05-03
- 9.0.20 — 2025-05-03
- 9.0.19 — 2025-01-28
- 9.0.18 — 2025-01-28
- 9.0.17 — 2025-01-28
- 9.0.16 — 2025-01-28
- 9.0.15 — 2025-01-28
- 9.0.14 — 2025-01-27
- 9.0.13 — 2025-01-27
- 9.0.12 — 2024-12-17
- 9.0.11 — 2024-12-17
- 9.0.10 — 2024-12-17
- … 23 more at https://npm.io/package/wdio-test-reporter-service/versions

## README

# WebdriverIO Test Reporter Service

WDIO service that takes results from [wdio-test-reporter](https://github.com/WillBrock/wdio-test-reporter) and uploads them to [testreporter.io](https://testreporter.io)

testreporter.io 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-reporter-service
```

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

```
services: [['test-reporter', {
	reporterOutputDir : `./testreporter`,          // This must match the outputDir from the wdio-test-reporter
	apiUrl            : `app-api.testreporter.io`, // Defaults to app-api.testreporter.io if none is set
	username          : `jenkins@foobar.com`,      // app.testreporter.io username
	apiToken          : `12345`,                   // Found in the app.testreporter.io 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-reporter to the reporters array in wdio.conf.js

```
npm install wdio-test-reporter
```

```
reporters : [[`test`, {
	outputDir : `./testreporter`
}]]
```

## 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.testreporter.io/runs/c26b23d8-eb9f-4ff4-a884-5cb9f3d3aba5<uuid>
* `APP_VERSION`  - Set the version of app this test run ran against

---
_Source: https://npm.io/package/wdio-test-reporter-service · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._