Skip to main content

Integrate Your Test Suite with BrowserStack

BrowserStack 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
Perform Appium Driver changes to run tests on BrowserStack Yes Via the browserstack.yml config file Changes Requires code changes to change the Remote Appium Driver
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 Changes Requires code changes in test suite Changes Requires additional code to be added in the test suite hooks
Test on multiple devices using parallelization Yes Via the browserstack.yml config file Changes May require code changes depending on the test suite
Use advanced parallelization strategies Changes Requires code changes to support different parallelisation strategies Changes Requires code changes to support different parallelization strategies

* Depending on your test framework


  • An existing appium based automated test suite.
  • Node v12+ installed on your machine.

Integration Steps

Complete the following steps to integrate your Nodejs test suite using BrowserStack SDK.

Set BrowserStack credentials

Saving your BrowserStack credentials as environment variables makes it simple to run your test suite from your local or CI environment.

Copy icon Copy snippet
Copy icon Copy snippet

Create your BrowserStack config file

Once you have installed the SDK, create a browserstack.yml config file at the root level of your project. This file holds all the required capabilities to run tests on BrowserStack.

Set app to be tested

The app property determines the app to be tested. You can upload an Android app (.apk or .aab file) or an iOS app (.ipa file) from your local filesystem.

Supported method Description
path(Recommended) SDK uploads the app using the specified relative or absolute path.
Eg: app: ./SampleApp.apk.

Check out how to create IPA files for iOS app testing on BrowserStack.


Set the path to your app. Or, if you have already uploaded your app, provide one of the other acceptable app property values here

Other acceptable app property values

You can use BrowserStack REST API to upload your app.

Following is a sample response that is generated when you upload an app using any of the mentioned methods:


The following table explains the other acceptable app property values:

Supported method Description
app_url Uploaded app’s app_url is a valid value for app property.
Eg: app: bs://45e1c1473b17b7643aed1761f51cb5cdf3d3e334
custom_id If you’ve defined a custom_id while uploading your app, the same value can be used as app property value.
Eg: app: CalculatorApp
shareable_id If you wish to test an app uploaded by someone else from your organization, a shareable_id can be used as the app property value.
Eg: app: exampleuser/CalculatorApp

Check out how to specify the application under test to understand the above options better.

Set platforms to test on

Set the devices you want to test under the platforms object.

Parallel thread #1
Parallel thread #2
Parallel thread #3

Enable BrowserStack Local

Test apps with local/staging API servers

Test apps locally with local/staging API servers

BrowserStack’s Local Testing feature connects with locally hosted API servers to run your apps

Learn more

BrowserStack Reporting (part 1/2)

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

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

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 build name as a combination of buildName and buildIdentifier as seen on the dashboard and set the buildIdenitifier as null:

buildName: bstack-demo 123
buildIdentifier: null

Option 2: 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

Use additional debugging features

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

Visual logs

Enables screenshots for every selenium command ran

Network logs

Enables network capture for the session in HAR format. Might reduce session performance slightly


Create browserstack.yml file

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

You can also pass regular expressions (regex) in deviceName and platformVersion capabilities if your device selection is more flexible. Check out how to use regular expressions to specify device attributes.

Copy icon Copy snippet

BrowserStack Reporting (part 2/2)

Test assertions are specific to selected language frameworks. BrowserStack requires explicit instruction to determine whether your tests have passed or failed based on the assertions in your test script.

Mark session name

You can use the sessionName capability to give your session a name (usually describing the test case) so that it is easy for you to debug later.

Copy icon Copy snippet

Mark test as passed or failed

To mark whether your test has passed or failed on BrowserStack, use the following Javascript executor in your test script.

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 value in string datatype
Copy icon Copy snippet

Run your test suite

Your test suite is now ready to run on BrowserStack. Execute the following command from the project’s root directory(android/ios) to run your test suite with BrowserStack.

Copy icon Copy snippet

Advanced features and use cases

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

Accept insecure certificates

The acceptInsecureCerts capability suppresses warning about self-signed certificates usually found in staging environments.

Capability Expected values
acceptInsecureCerts A boolean. Default is False.
True if you want to accept all SSL certificates.

Change device orientation

The deviceOrientation capability changes the default mobile screen orientation for your tests on BrowserStack infra.

  • If the parameter is set at the root level, its applicable to all the devices in the test.
  • If you wish to apply it to a specific device, set it at the platform level which has the device details.
Capability Description Expected values
deviceOrientation Set the orientation of your app before beginning your test A string. Default orientation is portrait.

Supported orientations:
portrait and landscape.

Simulate IP geolocation

The geoLocation capability lets you test your app 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
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.

Simulate network conditions

The networkProfile capability lets you test your app under different network conditions.

Capability Description Expected values
networkProfile Set the network profile to start the test with A string.

2g-gprs-good, 4g-lte-advanced-lossy


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


Here’s a list of troubleshooting options you may find useful.

Resigned Apps and Third-Party Library Integration Issues

  • Uploading an unsigned version of an Android app will require us to sign it with our certificates before installing it on our devices. In the same manner, any uploaded .aab files will be converted into a universal APK and signed with our certificates.

  • If Browserstack resigns the apps, third-party library integrations such as Google Firebase services, Google Maps SDK, Facebook SDK, etc., may not function properly if the use of API keys is restricted based on the SHA-1 certificate fingerprint of the app’s signing key.

  • To prevent this issue, it’s recommended to sign the APK with your own certificates before uploading it to BrowserStack.

Disabling Re-Signing for iOS Apps

  • If you upload an iOS app, we will re-sign the app with our own provisioning profile to be able to install your app on our devices during test execution.
  • However, if your app is signed using the Apple Developer Enterprise Program, you can disable this behavior to test features such as push notifications on BrowserStack devices.
Capability Expected values
resignApp A boolean. To disable re-signing, set the capability to false in your Appium test scripts.

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

Is this page helping 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

Thank you for your valuable feedback!

Talk to an Expert
Download Copy