Skip to main content
Get Automate insights in Microsoft Teams with our new integration! Get Started!.

Integrate Your Test Suite

BrowserStack’s Java SDK supports a plug-and-play integration with the TestNG Runner. Run your entire test suite in parallel with a few steps!

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

Using the BrowserStack SDK is the recommended integration method for TestNG. The SDK auto-handles your integration steps.


This guide will help you:

  1. Install the Java SDK
  2. Create your BrowserStack config file
  3. Setup advanced features and use cases

Set 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

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

Add BrowserStack SDK dependency

pom.xml
Copy snippet

Add browserstack-java-sdk as a maven dependency in your pom.xml file

Modify your build plugins

pom.xml
Copy snippet

Add the following build plugin

Add maven-dependency-plugin as a plugin under your <build> plugin to resolve dependencies.

Add BrowserStack SDK as an argline property

Add the following java agent <argLine> in your <build> plugin. This step invokes our SDK when your build is triggered.

-javaagent:${com.browserstack:browserstack-java-sdk:jar}

Create your BrowserStack config file

The browerstack.yml file holds all the required capabilities to run your tests on BrowserStack

Set access credentials

Set userName and accessKey as env variables or directly in the config file.

Set platforms to test on

Set the browsers / devices you want to test under the platforms object. Our config follows W3C formatted capabilities.

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

Set number of parallels threads per platform

The parallelsPerPlatform property determines the number of parallel threads to be executed. BrowserStack’s SDK runner will select the best strategy based on the configured value.

Example 1: If you have configured 3 platforms and set parallelsPerPlatform as 2: a total of 6 (2 x 3) parallel threads will be used on BrowserStack.

Example 2: If you have configured 1 platform and set parallelsPerPlatform as 15: a total of 15 (1 x 15) parallel threads will be used on BrowserStack.

Enable BrowserStack Local

Test localhost / internal servers in your network

True
False
Test Localhost / Staging websites that are not publicly accessible

BrowserStack’s Local Testing feature connects with test suites pointing to your localhost URL

Learn more

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 or Contact Support for assistance.

Organizing your test suite

Our projectName, buildName and name capabilities help with organizing your tests on BrowserStack’s Dashboard.

name is the name of your test sessions and is automatically picked from your test class/spec name. It doesn’t need to be set manually when using the BrowserStack SDK.

Build Name
Project Name

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

True
False
Network logs

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

True
False

Create BrowserStack Config file

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

browserstack.yml
Copy snippet

Advanced features and 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