Integrate Your Test Suite with BrowserStack

Install BrowserStack Node SDK

Install the BrowserStack SDK using npm for your NodeJS based test suite for plug-and-play integration with BrowserStack.

The npx setup command generates a browserstack.yml file at the root location of your project with your access credentials already configured. It also adds new command(s) in your package.json file to run tests on BrowserStack.

Configure your browserstack.yml file

The auto-generated browserstack.yml file situated in the root location of your project holds all the required settings to run tests on BrowserStack.

Set platforms to test on

Set the browsers and devices you want to test under the platforms object. Our config follows W3C formatted capabilities.

Parallel thread #1

Windows 11

Chrome 103

Parallel thread #2

Windows 10

Firefox 102

Parallel thread #3

OS X Big Sur

Safari 14.1

Configure BrowserStack Local

Test localhost / internal servers in your network

True

False

Test Localhost / Staging websites that are not publicly accessible

BrowserStack’s Local Testing feature connects with test suites pointing to your localhost URL

Learn more

If your staging environment is behind a proxy or firewall, you need to set additional arguments, such as proxy username, proxy password, etc. Check out Local Binary parameters to learn about additional arguments or Contact Support for assistance.

BrowserStack Reporting (part 1/2)

You can leverage BrowserStack’s extensive reporting features using the following capabilities:

Build Name

Set build name as the name of the job/test suite being run

Build Identifier

Select a dynamic build identifier that appends to the build name and generates a unique name on the BrowserStack dashboard

${BUILD_NUMBER}

${BUILD_NUMBER}

${DATE_TIME}

buildIdentifier	Description	Generated build name on BrowserStack dashboard
${BUILD_NUMBER} (Default)	If build is triggered locally, an incremental counter is appended. If build is triggered with CI tools, CI generated build number is appended.	bstack-demo 1 bstack-demo CI 1395
${DATE_TIME}	The timestamp of run time is appended to the build.	bstack-demo 29-Nov-20:44

Advanced use cases for Build name

Custom formatting of build name

Prefix buildIdentifier with desired characters, for example, # or :

buildName: bstack-demo
buildIdentifier: '#${BUILD_NUMBER}'

Re-run tests in a build

You can re-run selected tests from a build using any of the following options:

Option 1: Set the existing build name in the BROWSERSTACK_BUILD_NAME variable and prepend it to your test run command to re-run tests in the same build:

MacOS/Linux:

BROWSERSTACK_BUILD_NAME="bstack-demo 123" npm run sample-test

Windows Powershell:

$env:BROWSERSTACK_BUILD_NAME=“bstack-demo 123”; npm run sample-test

Windows cmd:

set BROWSERSTACK_BUILD_NAME=“bstack-demo 123” && npm run sample-test

Option 2: Set the build name as a combination of buildName and buildIdentifier, as seen on the dashboard, and set buildIdenitifier as null:

buildName: bstack-demo 123
buildIdentifier: null

Option 3: Set the buildIdentifier as the build number or time of the required build as seen on the dashboard:

buildName: bstack-demo
buildIdentifier: 123

Project Name

Set a project name for your project.

Use additional debugging features

By default, BrowserStack provides prettified session logs, screenshots on every failed selenium command, and a video of the entire test. Additionally, you can enable the following features:

Visual logs

Enables screenshots for every selenium command ran

True

False

Network logs

Enables network capture for the session in HAR format. Reduces session performance slightly

True

False

Console logs

Set the remote Browser’s console log levels. Currently supported only on Chrome browsers (Desktop and Android)

Info

Disable

Verbose

Info

Warnings

Errors

Update BrowserStack Config file

Copy the given config into your browserstack.yml file.

BrowserStack Reporting (part 2/2)

Test assertions are specific to selected language frameworks. BrowserStack requires explicit instruction to determine whether your tests have passed or failed based on the assertions in your test script.

Run your test suite on BrowserStack

Your test suite is now ready to run on BrowserStack! Run the commands added under the scripts property section in the package.json file. Here is an example command:

If you don’t see any new commands, make sure you ran npx setup correctly or contact support for assistance.