Skip to main content

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!

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 icon Copy snippet
Copy icon Copy snippet
Copy icon 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 icon 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 you want to test under the platforms object from the list of supported browsers.

BrowserStack Reporting

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. Accepted characters: A-Z, a-z, 0-9, ., :, -, [], /, @, &, , _. All other characters are ignored.
Character limit: 255


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:

Video

Enables video recording for every command ran

True
False

Use Automate Turboscale

Turboscale

Enables Turboscale

True
False
Grid Name

Set grid name as the name of the Turboscale grid. Accepted characters: A-Z, a-z, 0-9, ., :, -, [], /, @, &, , _. All other characters are ignored.
Character limit: 255

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 snippet

It is mandatory to set turboScale to true to use Automate Turboscale.
gridName is an optional parameter. If turboScale is set to true and gridName is not specified, then the test session is run on the latest grid that you created.

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 snippet

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

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