Integrate Your Test Suite with BrowserStack

BrowserStack’s NodeJS SDK supports a plug-and-play integration. Run your entire test suite in parallel with a few steps!

Select your integration method

BrowserStack SDK (Recommended)

Plug-n-play solution that takes care of all the integration steps for you
Legacy integration

Perform the integration steps yourself. Useful for custom frameworks and advanced use-cases

Using the BrowserStack SDK is the recommended integration method for NodeJS. The SDK auto-handles your integration steps.

Learn the benefits of using BrowserStack SDK

Following are the benefits of using BrowserStack SDK against manual integration process:

Integration step	With BrowserStack SDK	With manual integration
Connect to CDP Endpoint to run tests on BrowserStack	Via the `browserstack.yml` config file	Requires code changes to change the CDP Endpoint
Integrate with BrowserStack Local	Via the `browserstack.yml` config file	Requires code changes in test suite
Send test context to BrowserStack for reporting	Via the `browserstack.yml` config file	Requires additional code to be added in the test suite hooks
Use basic cross browser testing parallelization	Via the `browserstack.yml` config file	May require code changes depending on the test suite
Use advanced parallelization strategies	Via the `browserstack.yml` config file	Requires code changes to support different parallelization strategies

Prerequisites

An existing automated test suite.
Node v14+ is installed on your machine.

Looking for a starter project? Get started with our NodeJS sample project

Integration Steps

Set BrowserStack credentials

Save your BrowserStack credentials as environment variables. It simplifies running your test suite from your local or CI environment.

Copy snippet

Install BrowserStack NodeJS SDK

Execute the following commands to install BrowserStack NodeJS SDK for plug-and-play integration of your test suite with BrowserStack.

Copy snippet

Update your BrowserStack config file

When you install the SDK, a browserstack.yml config file is created at the root level of your project. This file holds all the required capabilities to run tests on BrowserStack.

Specify platforms to test on

Set the browsers/OS you want to test under the platforms object. Select over 100+ browsers-OS combinations from the list of supported browsers and OS

Enable 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

BrowserStack Local supports all advanced use cases and restricted networks. Contact our support team for assistance in configuring BrowserStack Local for your enterprise.

BrowserStack Reporting

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

buildIdentifier	Description	Generated build name on 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:

BROWSERSTACK_BUILD_NAME=bstack-demo 1234 mvn test -P 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

sessionName is the name of your test sessions and is automatically picked from your test class/spec name. It doesn’t need to be set manually when using the BrowserStack SDK.

Use additional debugging features

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

Update browserstack.yml file with selected capabilities

Copy the following code snippet and replace contents of browserstack.yml file in the root folder of your test suite.

Copy snippet

Run your test suite

Your test suite is now ready to run on BrowserStack. Use the following command to execute your tests on BrowserStack using the NodeJS SDK.

Copy snippet

Advanced features and use cases

Here’s a list of features and capabilities you may find useful.

Lighthouse Integration

Learn how to Integrate Lighthouse to your Playwright tests for improving the quality of your web pages.

Chrome Extension Testing

Learn more about Testing Chrome Extension on your Playwright tests with BrowserStack Automate.

Simulate IP geolocation

The browserstack.geoLocation capability lets you test your websites across different countries.

Note that this capability is supported on the Enterprise plan only. You can contact sales to get an Enterprise plan for your account.

Capability	Description	Expected values
`browserstack.geoLocation`	Set the country code you want your test to detect	A string. An ISO 2 country code `FR` for France, `CN` for China Check out the complete list of 45+ countries we support.

Others

Following are a few additional links to documentation pages that might help with your test scenarios:

Change the desktop browser window in your tests
Test File upload scenarios
Prevent sensitive test data from appearing in the Automate logs using mask commands

Next steps

Once you have successfully integrated your test suite with BrowserStack, you might want to check the following:

Did this page help you?

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback

Is this page helping you?

Yes

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback!