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!

Prerequisites

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

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

After you have installed the SDK, a browserstack.yml config file will be 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/devices you want to test under the platforms object. Our configuration follows W3C-formatted capabilities.

Platform Browser
Linux Firefox
Linux Chrome
Linux Edge

.

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


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

BrowserStack offers session logs, screenshots of failed commands, and a video of the entire test, with additional options to enable.

Test Observability

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

True
False
Visual logs

Enables screenshots for every selenium command ran

True
False
Video logs

Enables accurate video recordings of execution

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)

Use Automate Turboscale

Turboscale

Enables Turboscale

True
False

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

It is mandatory to set turboScale to true to use Automate Turboscale.

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

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