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!
Prerequisites
- An existing appium based automated test suite.
- Node v16 installed on your machine.
Looking for a starter project? Get started with our NodeJS sample project.
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.
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.
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:
{
"app_url":"bs://f7c874f21852ba57957a3fdc33f47514288c4ba4",
"custom_id":"SampleApp",
"shareable_id":"exampleuser/SampleApp"
}
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.
Do you want to dynamically configure platforms?
To dynamically configure platforms across different tests, you can comment out the platforms
capability while still passing platform-specific capabilities.
BrowserStack Reporting (part 1/2)
You can leverage BrowserStack’s extensive reporting features using the following capabilities:
The projectName
and buildName
config must be static and not change across different runs of the same build. This is a deviation in approach as specified by BrowserStack Automate or App Automate as Test Observability will automatically identify different build runs.
Restrict the characters in your projectName
and buildName
to alphanumeric characters (A-Z, a-z, 0-9), underscores (_), colons (:), and hyphens (-). Any other character will be replaced with a space.
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:
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.
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
app: bs://sample.app
platforms:
- platformName: android
deviceName: Samsung Galaxy S22 Ultra
platformVersion: 12.0
- platformName: android
deviceName: Google Pixel 7 Pro
platformVersion: 13.0
- platformName: android
deviceName: OnePlus 9
platformVersion: 11.0
browserstackLocal: true
buildName: bstack-demo
projectName: BrowserStack Sample
CUSTOM_TAG_1: "You can set a custom Build Tag here"
# Use CUSTOM_TAG_<N> and set more build tags as you need.
debug: true
networkLogs: true
Use our Capability Generator to select from a comprehensive set of options you can use to customize your tests.
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.
executor_object = {
'action': 'setSessionName',
'arguments': {
'name': "<test-name>"
}
}
browserstack_executor = 'browserstack_executor: {}'.format(json.dumps(executor_object))
driver.execute_script(browserstack_executor)
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 eitherpassed
orfailed
as the value -
reason
accepts a value in string datatype
import json
executor_object = {
'action': 'setSessionStatus',
'arguments': {
'status': "<passed/failed>",
'reason': "<reason>"
}
}
browserstack_executor = 'browserstack_executor: {}'.format(json.dumps(executor_object))
driver.execute_script(browserstack_executor)
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.
npm run [your-test-script-name]
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.
After you run your test, visit the App Automate dashboard to view your test results.
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. |
acceptInsecureCerts: true
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 . |
deviceOrientation: 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. |
geoLocation: FR
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 |
networkProfile: 2g-gprs-good
Others
Following are a few additional links to documentation pages that might help with your test scenarios:
Troubleshooting
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. |
resignApp: false
Next steps
Once you have successfully integrated your test suite with BrowserStack, you might want to check the following:
- Generate a list of capabilities that you want to use in tests
- Find information about your Projects, Builds and Sessions using our REST APIs
- Set up your CI/CD: Jenkins, Bamboo, TeamCity, Azure, CircleCI, TravisCI.
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
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!