Transform your testing process with: Real Device Features, Company-wide Licences, & Test Observability
No Result Found

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 Yes Via the browserstack.yml config file Changes Requires code changes to change the CDP Endpoint
Integrate with BrowserStack Local Yes Via the browserstack.yml config file Changes Requires code changes in test suite
Send test context to BrowserStack for reporting Yes Via the browserstack.yml config file Changes Requires additional code to be added in the test suite hooks
Use basic cross browser testing parallelization Yes Via the browserstack.yml config file Changes May require code changes depending on the test suite
Use advanced parallelization strategies Yes Via the browserstack.yml config file Changes 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
Copy icon Copy
Copy icon Copy
Copy icon Copy

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 icon Copy

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:

Build Name

Set a name to your build (usually the same as the build ID that’s on your CI/CD platform). Accepted characters: A-Z, a-z, 0-9, ., :, -, [], /, @, &, ‘, _. All other characters are ignored.
Character limit: 255
Build Identifier

Select a dynamic build identifier that appends to the build name and generates a unique name on the BrowserStack dashboard
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


Project Name

Set a project name for your project.

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:

Test Observability

Enables Test Observability, an advanced test reporting and debugging tool that helps you analyze test failures dramatically faster. If enabled, Test Observability collects test data using the SDK. This capability is enabled (set to true) by default.

True
False
Video

Enables video recording for every command ran

True
False
Console logs

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

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.

browserstack.yml
Copy icon Copy

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 icon Copy

To find out the location of the BrowserStack SDK log files, refer to BrowserStack SDK Log Files. If you are looking for more information, see FAQ documentation.

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.
browserstack.yml
Copy icon Copy

Others

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

Next steps

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

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





Thank you for your valuable feedback

  • ON THIS PAGE

    Is this page helping you?

    Yes
    No

    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





    Thank you for your valuable feedback!

    Talk to an Expert
    Download Copy Check Circle