Get your setup working faster. Join our Discord for optimisation tips from elite testers.Join our Discord
Integrate your test suite with BrowserStack
This section will help you migrate your existing test suite to run on BrowserStack Automate. It also covers key features and best practice recommendations for smooth integration.
Set up authentication
Set BrowserStack credentials
Save your BrowserStack credentials as environment variables. It simplifies running your test suite from your local or CI environment.
Update your test cases to read BrowserStack credentials from environment variables and update the selenium hub URL to the BrowserStack remote hub URL.
Connect your website under test
You can integrate BrowserStack with test suites pointing to your localhost URL, staging environment and even websites behind one or more proxies/firewalls.
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 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 within the onComplete hook in your test suite.
bs_local.isRunning()
Check if the BrowserStack local instance is running.
Add capabilities to enable BrowserStack local
selenium 4 W3C
selenium Legacy JSON
```javascript
// Set these values in your capabilities.
const capabilities = {
'bstack:options': {
local: 'true'
}
};
```
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.
```javascript
// Set these values in your capabilities.
const capabilities = {
"browserstack.local" : "true",
}
```
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.
Download BrowserStack Local
Show download options
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
Copy the adjacent command to initiate the BrowserStack Local connection
# 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.
selenium 4 W3C
selenium Legacy JSON
Set up config to enable browserstack local
Copy the capabilities as shown into your config file.
After you Set up authentication in your test scripts, you can now add configurations, such as adding browser-os combination, test suite organization details, test status that you want to track, and then run your tests.
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
```javascript
// Testing the home page
const capabilities = {
'bstack:options' : {
"projectName" : "Marketing Website v2",
"buildName" : "alpha_0.1.7",
"sessionName" : "Home page must have a title",
}
}
```
Use the following capabilities for naming your tests and builds. This ensures effective debugging, test reporting, and build execution time analysis.
Capability
Description
sessionName
Name for your test case. For example, Homepage - Get started
buildName
CI/CD job or build name. For example, Website build #23, staging_1.3.27
projectName
Name of your project. For example, Marketing Website
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
```javascript
// For marking test as passed
driver.executeScript('browserstack_executor: {"action": "setSessionStatus", "arguments": {"status":"passed","reason": "Yaay! my sample test passed"}}');
// For marking test as failed
driver.executeScript('browserstack_executor: {"action": "setSessionStatus", "arguments": {"status":"failed","reason": "Oops! my sample test 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
```javascript
const capabilities = {
'bstack:options': {
debug: 'true', // to enable visual logs
networkLogs: 'true', // to enable network logs to be logged
consoleLogs: 'info' // to enable console logs at the info level. You can also use other log levels here.
}
};
```
Use the following common debugging capabilities for your tests:
Set the debug capability to enable visual logs and capture screenshots at every selenium command automatically.
Console Logs with log level ‘errors’ are enabled by default. Set the consoleLogs capability to enable different log levels, such as warnings, info, verbose, errors, and disable.
Set the networkLogs capability to capture the browser’s performance data such as network traffic, latency, HTTP requests, and responses in a HAR format.
Commonly used features and advanced-use cases
Here’s a list of features and capabilities you may find useful.
Accept insecure certificates
This 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.
This capability changes the default desktop screen resolution for your tests on BrowserStack infra.
Capability
Description
Expected values
resolution
Set the resolution of your remote machine before beginning your test
A string. Default resolution is 1024x768
Supported resolutions: Windows (XP, 7):800x600, 1024x768, 1280x800, 1280x1024, 1366x768, 1440x900, 1680x1050, 1600x1200, 1920x1200, 1920x1080, and 2048x1536
Windows (8, 8.1, 10):1024x768, 1280x800, 1280x1024, 1366x768, 1440x900, 1680x1050, 1600x1200, 1920x1200, 1920x1080, and 2048x1536
OS X (Golden Gate, Tahoe, 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
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
```javascript
// Testing the home page
const capabilities = {
"project" : "Marketing Website v2",
"build" : "alpha_0.1.7",
"name" : "Home page must have a title",
}
```
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
project
Name of your project. For example, Marketing Website
Use a new build 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
```javascript
// For marking test as passed
driver.executeScript('browserstack_executor: {"action": "setSessionStatus", "arguments": {"status":"passed","reason": "Yaay! my sample test passed"}}');
// For marking test as failed
driver.executeScript('browserstack_executor: {"action": "setSessionStatus", "arguments": {"status":"failed","reason": "Oops! my sample test failed"}}');
```
To mark whether your test has passed or failed on BrowserStack, use the adjacent 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 value in string datatype
Set up debugging capabilities
```javascript
const capabilities = {
"browserstack.debug" : "true", // for enabling visual logs
"browserstack.networkLogs" : "true", // to enable network logs to be logged
"browserstack.consoleLogs" : "info", // to enable console logs at the info level. You can also use other log levels here
}
```
Use the following common debugging capabilities for your tests:
Set the browserstack.debug capability to enable visual logs and capture screenshots at every selenium command automatically.
Console Logs with log level ‘errors’ are enabled by default. Set the browserstack.console capability to enable different log levels, such as warnings, info, verbose, errors, and disable.
Set the browserstack.networkLogs capability to capture the browser’s performance data such as network traffic, latency, HTTP requests, and responses in a HAR format.
Commonly used features and advanced-use cases
Here’s a list of features and capabilities you may find useful.
Accept insecure certificates
This capability suppresses browser popups warning about self-signed certificates usually found in staging environments.
Capability
Expected values
acceptSslCerts
A boolean. Default is False. True if you want to accept all SSL certificates.
This capability changes the default desktop screen resolution for your tests on BrowserStack infra.
Capability
Description
Expected values
resolution
Set the resolution of your remote machine before beginning your test
A string. Default resolution is 1024x768
Supported resolutions: Windows (XP, 7):800x600, 1024x768, 1280x800, 1280x1024, 1366x768, 1440x900, 1680x1050, 1600x1200, 1920x1200, 1920x1080, and 2048x1536
Windows (8, 8.1, 10):1024x768, 1280x800, 1280x1024, 1366x768, 1440x900, 1680x1050, 1600x1200, 1920x1200, 1920x1080, and 2048x1536
OS X (Golden Gate, Tahoe, 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
Join our Discord