Skip to main content

Integrate Your Test Suite

BrowserStack gives you instant access to our Selenium Grid of 3000+ real devices and desktop browsers. Running your Selenium tests with TestNG on BrowserStack is simple.

Select your integration method

  • Automatic (Browserstack SDK)
    Plug-n-play solution that takes care of all the integration steps for you
  • Manual integration
    Perform the integration steps yourself. Useful for custom frameworks and advanced use-cases

Use Manual integration only if you want to perform the integration step-by-step yourself. It is useful only when you are using custom frameworks or want to handle advanced parallelization use-cases.


This guide will help you:

  1. Migrate your test cases
  2. Organize tests for Debugging and Reporting
  3. Mark tests as passed or failed
  4. Debug your app
  5. Setup advanced features and use-cases

Setup authentication

Set environment variables for BrowserStack credentials

# Set these values in your ~/.zprofile (zsh) or ~/.profile (bash)
export BROWSERSTACK_USERNAME="YOUR_USERNAME"
export BROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"
# setx.exe does not set the environment variable in the current command prompt, but it will be available in subsequent command prompts
setx BROWSERSTACK_USERNAME "YOUR_USERNAME"
setx BROWSERSTACK_ACCESS_KEY "YOUR_ACCESS_KEY"

# Verify whether the variables have been set
echo BROWSERSTACK_USERNAME
echo BROWSERSTACK_ACCESS_KEY

In the previous 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.

Update your Test suite config file

testng.conf.json

Once you set your BrowserStack credentials through environment variables, it will be automatically fetched from BrowserStackTestNGTest.java file while executing your test script. Next, point the Selenium hub to the BrowserStack remote hub URL.

Our config file is based on TestNG’s default config. If you don’t have a config file already setup, you can download it as a base config.

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.

Run test suite on a single browser

// Set this in your testng.conf.json file
"environments": [{
    "os":"Windows",
    "os_version":"10",
    "browser": "chrome",
    "browser_version":"latest",
}]
// Set this in your testng.conf.json file
"environments": [{
    "os":"Windows",
    "osVersion":"10",
    "browserName": "chrome",
    "browserVersion":"latest",
}]

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 to the capabilities on the right to use Chrome.

Once you’ve migrated your test cases or have achieved stability with Chrome or Firefox, you can setup cross-browser testing.

Organize tests

testng.conf.json

Naming your tests and builds properly is crucial for effective debugging, test reporting and analyzing your build execution time on BrowserStack.

Capability Description
name Name for your test case. Example, Homepage - Get started
build CI/CD job or build name. Example, Website build #23, staging_1.3.27
project Name of your project. Example, Marketing Website

Use a new build name every time you run your test cases. Not using a new build name upon every test run makes it difficult to find and debug tests on Automate dashboard. Using a static build name across tests will group those tests into a single build on the dashboard.

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

test-script.java

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.

Set up Debugging capabilities

testng.conf.json

BrowserStack provides the following debugging capabilities for your tests:

  1. Use visual logs capability to capture screenshots at every Selenium command automatically. Enable visual logs by using the browserstack.debug capability as shown on the right.
  2. Console Logs with log level ‘errors’ are enabled by default. You can enable different log levels viz. warnings, info, verbose, errors and disable using the browserstack.console capability as shown on the right.
  3. Network Logs capture the browser’s performance data such as network traffic, latency, HTTP requests, and responses in a HAR format. You can enable network logs using the browserstack.networkLogs capability as shown on the right.

Commonly used features and advanced-use cases

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

Accept insecure certificates

testng.conf.json

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.

Change desktop resolution

testng.conf.json

This capability changes the default desktop screen resolution for your tests on BrowserStack infra.

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, 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 (Monterey,Big Sur,Catalina,Mojave,High Sierra): 1024x768, 1280x960, 1280x1024, 1600x1200, 1920x1080, 2560x1440, 2560x1600 and 3840x2160

OS X (All other versions): 1024x768, 1280x960, 1280x1024, 1600x1200 and 1920x1080

Others

Below are few of the 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:

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?

Yes
No

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