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!

SDK integration
Non SDK integration

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

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

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

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:

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.

Use Automate Turboscale

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

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

Using the BrowserStack SDK is the recommended integration method for NodeJS. The SDK handles your integration steps automatically. Use the manual integration only when you are using custom frameworks or want to handle advanced parallelization use-cases.

Setup authentication

Set environment variables for BrowserStack credentials

In the run a sample build section, we set up BrowserStack credentials directly in the test script.

That method works for a sample build, but for a production-grade integration, we recommend you store your credentials as environment variables and use those environment variables in your code.

      
            macOS or Linux
          
            Windows PowerShell
          
            Windows Cmd
          
          Copy
        
export BROWSERSTACK_USERNAME="YOUR_USERNAME"
export BROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"
$env:BROWSERSTACK_USERNAME "YOUR_USERNAME" 
$env:BROWSERSTACK_ACCESS_KEY "YOUR_ACCESS_KEY" 
setx BROWSERSTACK_USERNAME "YOUR_USERNAME" 
setx BROWSERSTACK_ACCESS_KEY "YOUR_ACCESS_KEY" 

set BROWSERSTACK_USERNAME=YOUR_USERNAME
set BROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY

Connect CDP Endpoint

Connect to the CDP endpoint at BrowserStack as shown in the following example:

Connect your website under test

BrowserStack can integrate with test suites pointing to your localhost URL, staging environment and even websites behind one or more proxies/firewalls.

NPM - Language Bindings
CLI Interface - Binary

Install the package

Add browserstack-local to your project using the following npm command:

Copy

Set the access key and use available methods in your test script

Set the bs_local_args variable to your BrowserStack Access Key and and use the following methods provided by the local library to manage your local connection:

Method	Description
`bs_local.start()`	Expects the `bs_local` object. Returns a callback when the tunnel has started successfully. Your test script should start executing after this callback has been invoked.
`bs_local.stop()`	Call this method after your test suite is complete.
`bs_local.isRunning()`	Check if BrowserStack local instance is running.

Use the following example code snippet to manage your local connections:

Add capabilities to enable BrowserStack local

Run a test using BrowserStack Local

Try running a localhost after completing the above steps. Check out our sample Git repository for more details.

Download BrowserStack Local

Unzip the binary

Unzip the downloaded file and move it to a folder/directory from which you have permission to start it using your command line or terminal.

Run the binary using your command line or terminal

Run the following command to initiate the BrowserStack Local connection:

      
            macOS or Linux
          
            Windows PowerShell
          
            Windows Cmd
          
          Copy
        
# Step 3 - Run this command in your terminal to start the BrowserStack Local binary. Your working directory should be where you have the downloaded binary.
./BrowserStackLocal --key YOUR_ACCESS_KEY
# Step 3 - Run this command in your terminal to start the BrowserStack Local binary. Your working directory should be where you have the downloaded binary.
./BrowserStackLocal --key YOUR_ACCESS_KEY
# Step 3 - Run this command in your command prompt. Your working directory should be where you have unzipped BrowserStackLocal.exe
BrowserStackLocal.exe --key YOUR_ACCESS_KEY

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

Set up config to enable local

Run a test using BrowserStack Local

Try running a localhost after completing the above steps. Check out our sample Git repository for more details.

Migrate your test cases

This section will help you with all the config changes, commonly used features, and best practices for a smooth migration of your test cases to BrowserStack.

Set OS-browser combination to run test

We recommend running your build using a single browser like Chrome or Firefox to begin with. This will isolate issues during the migration phase and help with faster debugging. Refer the capabilities as shown to use Chrome. Once you’ve migrated your test cases or have achieved stability with Chrome or Firefox, you can set up cross-browser testing.

Organize tests

Use the following capabilities for naming your tests and builds. This ensures effective debugging, test reporting, and build execution time analysis.

Capability	Description
`name`	Name for your test case. For example, `Homepage - Get started`
`build`	CI/CD job or build name. For example, `Website build #23`, `staging_1.3.27`

Use a new buildName name every time you run your test cases. This ensures that sessions are logically grouped under a unique build name and helps you monitor the health of your test suite effectively.

A build can only have a maximum of 1000 tests and post that a new build gets created with a ‘-1’ suffixed to the original build name.

Mark test as passed or failed

To mark whether your test has passed or failed on BrowserStack, use the Javascript executor in your test script. You can mark a test as passed or failed based on your test assertions.

The arguments passed in the JavaScript method for setting the status and the corresponding reason of the test are status and reason.

status accepts either passed or failed as the value
reason accepts a string value

Set up debugging capabilities

Use the following common debugging capabilities for your tests:

Set the debug capability to record video of the entire test execution
Console Logs with log level errors are enabled by default. Set the console capability to enable different log levels, such as warnings, info, verbose, errors, and disable.

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!