# wdio-testingbot-service

> WebdriverIO service for better TestingBot integration

Latest version **0.2.3** (published 2019-01-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install wdio-testingbot-service
pnpm add wdio-testingbot-service
yarn add wdio-testingbot-service
bun add wdio-testingbot-service
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.3 |
| Published | 2019-01-30 |
| First published | 2016-04-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 12.6 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Jochen Delabie |
| Maintainers | testingbot |
| Keywords | webdriverio, wdio, testingbot, test, automation, cloud, wdio-service |

## Links

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

## Dependencies (2)

- [request](https://npm.io/package/request.md) ^2.87.0
- [testingbot-tunnel-launcher](https://npm.io/package/testingbot-tunnel-launcher.md) ^1.1.7

## 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
- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads

## Recent versions

- 0.2.3 (latest) — 2019-01-30
- 5.0.0-beta.3 (next) — 2018-09-28
- 5.0.0-beta.0 (beta) — 2018-08-24
- 5.0.0-alpha.14 (alpha) — 2018-08-08
- 0.2.1 — 2018-11-02
- 5.0.0-beta.2 — 2018-09-07
- 5.0.0-beta.1 — 2018-08-30
- 0.2.0 — 2018-07-31
- 0.1.9 — 2018-07-31
- 5.0.0-alpha.13 — 2018-07-20
- 5.0.0-alpha.12 — 2018-07-18
- 5.0.0-alpha.11 — 2018-07-16
- 5.0.0-alpha.10 — 2018-07-13
- 5.0.0-alpha.9 — 2018-07-11
- 5.0.0-alpha.8 — 2018-07-10
- … 9 more at https://npm.io/package/wdio-testingbot-service/versions

## README

[![Greenkeeper badge](https://badges.greenkeeper.io/testingbot/wdio-testingbot-service.svg)](https://greenkeeper.io/)
[![npm](https://img.shields.io/npm/v/wdio-testingbot-service.svg?maxAge=2592000)](https://www.npmjs.com/package/wdio-testingbot-service)
[![dependencies Status](https://david-dm.org/testingbot/wdio-testingbot-service/status.svg)](https://david-dm.org/testingbot/wdio-testingbot-service)
[![devDependencies Status](https://david-dm.org/testingbot/wdio-testingbot-service/dev-status.svg)](https://david-dm.org/testingbot/wdio-testingbot-service?type=dev)
[![CircleCI](https://circleci.com/gh/testingbot/wdio-testingbot-service.svg?style=shield)](https://circleci.com/gh/testingbot/wdio-testingbot-service)

WDIO TestingBot Service
==========

> A WebdriverIO service. It updates the job metadata ('name', 'passed', 'tags', 'public', 'build', 'extra') and runs TestingBot Tunnel if desired.

## Installation

The easiest way is to keep `wdio-testingbot-service` as a devDependency in your `package.json`.

```json
{
  "devDependencies": {
    "wdio-testingbot-service": "~0.1"
  }
}
```

You can simple do it by:

```bash
npm install wdio-testingbot-service --save-dev
```

Instructions on how to install `WebdriverIO` can be found [here.](http://webdriver.io/guide/getstarted/install.html)

## Configuration

In order to use the service you need to set `user` and `key` in your `wdio.conf.js` file, and set the `host` option to 'hub.testingbot.com'. If you want to use [TestingBot Tunnel](https://testingbot.com/support/other/tunnel)
you just need to set `tbTunnel: true`.

```js
// wdio.conf.js
export.config = {
  // ...
  services: ['testingbot'],
  user: process.env.TB_KEY,
  key: process.env.TB_SECRET,
  tbTunnel: true,
  // ...
};
```

## Options

### user
Your TestingBot API KEY.

Type: `String`

### key
Your TestingBot API SECRET.

Type: `String`

### tbTunnel
If true it runs the TestingBot Tunnel and opens a secure connection between a TestingBot Virtual Machine running your browser tests.

Type: `Boolean`<br>
Default: `false`

### tbTunnelOpts
Apply TestingBot Tunnel options (e.g. to change port number or logFile settings). See [this list](https://github.com/testingbot/testingbot-tunnel-launcher) for more information.

Type: `Object`<br>
Default: `{}`

----

For more information on WebdriverIO see the [homepage](http://webdriver.io).

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