WebdriverIO Browserstack Service

We've moved!

This project is now part of the webdriverio monorepo. Find the new home for this project here.

A WebdriverIO service that manages local tunnel and job metadata for Browserstack users.

Installation

Simply run:

npm install --save-dev wdio-browserstack-service

Configuration

WebdriverIO has Browserstack support out of the box. You should simply set user and key in your wdio.conf.js file. This service plugin provides supports for Browserstack Tunnel. Set browserstackLocal: true also to activate this feature.

// wdio.conf.js
export.config = {
  // ...
  services: ['browserstack'],
  user: process.env.BROWSERSTACK_USERNAME,
  key: process.env.BROWSERSTACK_ACCESS_KEY,
  browserstackLocal: true,
};

Options

user

Your Browserstack username.

Type: String

key

Your Browserstack access key.

Type: String

browserstackLocal

Set this to true to enable routing connections from Browserstack cloud through your computer. You will also need to set browserstack.local to true in browser capabilities.

Type: Boolean
Default: false

browserstackLocalForcedStop

Set this to true to kill the browserstack process on complete, without waiting for the browserstack stop callback to be called. This is experimental and should not be used by all. Mostly necessary as a workaraound for this issue.

Type: Boolean
Default: false

browserstackOpts

Specified optional will be passed down to BrowserstackLocal. See this list for details.

Type: Object
Default: {}

---

Known Issues

• It's more of how webdriverio desigend the multi-process model. It is extremely hard if not impossible to reliable transfer localIdentifier to child-processes. We recommend to use it without the identifier at this moment, which will create an account-wide local tunnel.

Credits

• wdio-sauce-service
• browserstack-local
• ... and all other dependencies

For more information on WebdriverIO see the homepage.

Sponsors

Thanks for Browserstack to provide us with a free account for automated tests.