Integrate Your Test Suite with BrowserStack
Integrate BrowserStack into your test suite using the BrowserStack Node SDK — a plug-and-play solution that takes care of all the integration steps for you!
Prerequisites
- An existing automated test suite.
- Node v12+ installed on your machine.
Looking for a starter project? Get started with our NodeJS sample project.
Integration steps
Install BrowserStack Node SDK
Install the BrowserStack SDK using npm
for your NodeJS based test suite for plug-and-play integration with BrowserStack.
The npx setup
command generates a browserstack.yml
file at the root location of your project with your access credentials already configured. It also adds new command(s) in your package.json
file to run tests on BrowserStack.
Configure your browserstack.yml file
The auto-generated browserstack.yml
file situated in the root location of your project holds all the required settings to run tests on BrowserStack.
Set platforms to test on
Set the browsers and devices you want to test under the platforms
object. Our config follows W3C formatted capabilities.
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:
Update BrowserStack Config file
Copy the given config into your browserstack.yml
file.
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.
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
Run your test suite on BrowserStack
Your test suite is now ready to run on BrowserStack! Run the commands added under the scripts property section in the package.json
file. Here is an example command:
If you don’t see any new commands, make sure you ran npx setup
correctly or contact support for assistance.
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 Automate dashboard to view your test results.
Advanced features and use cases
Here’s a list of features and capabilities that you might find useful:
Accept insecure certificates
The acceptInsecureCerts
capability suppresses browser popups 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 desktop resolution
The resolution
capability changes the default desktop screen resolution for your tests on BrowserStack infrastructure.
Capability | Description | Expected values |
---|---|---|
resolution |
Set the resolution of your VM before beginning your test | A string. Default resolution is 1024x768 Supported resolutions: Windows (XP): 800x600 , 1024x768 , 1280x800 , 1280x1024 , 1366x768 , 1440x900 , 1680x1050 , 1600x1200 , 1920x1200 , 1920x1080 , 2048x1536 , 2560x1600 , and 2560x1920 Windows (7): 800x600 , 1024x768 , 1280x800 , 1280x1024 , 1366x768 , 1440x900 , 1680x1050 , 1600x1200 , 1920x1200 , 1920x1080 , 2048x1536 , 2560x1600 , 2560x1920 , and 3840x2160 Windows (8, 8.1, 10, 11): 1024x768 , 1280x800 , 1280x1024 , 1366x768 , 1440x900 , 1680x1050 , 1600x1200 , 1920x1200 , 1920x1080 , 2048x1536 , 2560x1600 , 2560x1920 , and 3840x2160 OS X (Sequoia, Sonoma, Ventura, Monterey, Big Sur, Catalina, Mojave, and High Sierra): 1024x768 , 1280x960 , 1280x1024 , 1600x1200 , 1920x1080 , 2560x1440 , 2560x1600 , and 3840x2160 OS X (All other versions): 1024x768 , 1280x960 , 1280x1024 , 1600x1200 , and 1920x1080
|
Adding root level or platform level capabilities
You can add any capability in the browserstack.yml
file at the root level or platform level. Refer to the snippet for details.
Other use cases
Use the following additional links to documentation pages that might help with your test scenarios:
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, BitBucket, TravisCI, GitHub Actions
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
- RESOURCES
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!