testcafe-browser-provider-browserstack

testcafe-browser-provider-browserstack

This plugin integrates TestCafe with the BrowserStack Testing Cloud.

Install

npm install testcafe-browser-provider-browserstack

Usage

Before using this plugin, save the BrowserStack username and access key to environment variables BROWSERSTACK_USERNAME and BROWSERSTACK_ACCESS_KEY.

Project name and build name will be displayed in BrowserStack if you set the environment variables BROWSERSTACK_PROJECT_NAME and BROWSERSTACK_BUILD_ID.

If you have troubles starting multiple browsers at once, or get browserstack-local related errors like #27, try setting the BROWSERSTACK_PARALLEL_RUNS environment variable to the number of browsers you want to run simultaneously, or to 1 if you want to run just one browser.

You can determine the available browser aliases by running

testcafe -b browserstack

If you run tests from the command line, use the alias when specifying browsers:

testcafe "browserstack:Chrome@53.0:Windows 10" "path/to/test/file.js"

When you use API, pass the alias to the browsers() method:

testCafe
    .createRunner()
    .src('path/to/test/file.js')
    .browsers('browserstack:Chrome@53.0:Windows 10')
    .run();

Tip: you can skip version (@53.0) or/and OS name (:Windows 10).

Browserstack Proxy Options

Proxy options can be passed via envrionment variables.

• BROWSERSTACK_PROXY - a string that specifies a proxy for the Browserstack local binary. It should have the following structure: user:pass@proxyHostName:port,
• BROWERSTACK_LOCAL_PROXY - a string that specifies a proxy for the local web server. It should have the following structure: user:pass@proxyHostName:port,
• BROWSERSTACK_FORCE_PROXY - if it's not empty, forces all traffic of Browserstack local binary to go through the proxy,
• BROWSERSTACK_FORCE_LOCAL - if it's not empty, forces all traffic of Browserstack local binary to go through the local machine

Browserstack JS Testing and Browserstack Automate

Browserstack offers two APIs for browser testing:

• Browserstack JS Testing
• Browserstack Automate

JS testing supports more types of devices (compare: JS Testing devices vs Automate devices), while Automate allows for much longer tests (2 hours vs 30 minutes) and provides some additional features (like the window resizing functionality).

TestCafe uses the JS Testing API by default. In order to use Browserstack Automate, set the BROWSERSTACK_USE_AUTOMATE environment variable to 1.

Setting display resolution

To set the display resolution, use the BROWSERSTACK_DISPLAY_RESOLUTION environment variable. Valid resolutions can be found here.

Remember that this only sets the display resolution and does not resize the browser window. You'll still need to use TestCafe's window resizing API to do so.

Author

Developer Express Inc. (https://devexpress.com)