Skip to main content

Crossbrowsertesting Service

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

Installation​

The easiest way is to keep @wdio/crossbrowsertesting-service as a devDependency in your package.json, via:

npm install  @wdio/crossbrowsertesting-service --save-dev

Instructions on how to install WebdriverIO can be found here.

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.crossbrowsertesting.com. If you want to use CrossBrowserTesting Tunnel you just need to set cbtTunnel: true.

// wdio.conf.js
exports.config
    // ...
    user: process.env.CBT_USERNAME,
    key: process.env.CBT_AUTHKEY,
    services: [
        ['crossbrowsertesting', {
            cbtTunnel: true,
            cbtTunnelOpts: {
                // any additional options from cbt_tunnels
            },
        }]
    ],
    // ...
};

Options​

In order to authorize to the CrossBrowserTesting service your config needs to contain a user and key option.

cbtTunnel​

If true secure CBT local connection is started.

Type: Boolean
Default: false

cbtTunnelOpts​

Any additional options to pass along to the start() function of cbt_tunnels

Type: Object
Default: {}

For more information on WebdriverIO see the homepage.