Integrate Your Test Suite with BrowserStack
BrowserStack’s TestNG SDK supports a plug-and-play integration. 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 step-by-step yourself (legacy flow)
Using the BrowserStack SDK is the recommended integration method for TestNG. The SDK auto-handles your integration steps.
Learn the benefits of using BrowserStack SDK
Following are the benefits of using BrowserStack SDK against manual integration process:
| Integration step | With BrowserStack SDK | With manual integration |
|---|---|---|
| Perform Webdriver changes to run tests on BrowserStack |
 Via the browserstack.yml config file |
 Requires code changes to change the RemoteWebdriver |
| Integrate with BrowserStack Local |
Via the browserstack.yml config file |
Requires code changes in test suite |
| Send test context to BrowserStack for reporting |
Via the browserstack.yml config file |
Requires additional code to be added in the test suite hooks |
| Use basic cross browser testing parallelization |
Via the browserstack.yml config file |
May require code changes depending on the test suite |
| Use advanced parallelization strategies |
Via the browserstack.yml config file |
Requires code changes to support different parallelization strategies |
Prerequisites
- An existing automated test suite.
- TestNG v6.8+, Java v8+ (If using Gradle, Java v9+ is required), Selenium v2.5+ (JSON Wire / W3C).
-
Maven or Gradle is installed on your machine, its environment variables are set, and its bin is added to system path,
$PATH.
Looking for a starter project? Get started with our TestNG sample project.
Integration Steps
Based on the method you use to build your project, complete the steps in the following tabs to integrate with BrowserStack.
Set BrowserStack credentials
Saving your BrowserStack credentials as environment variables makes it easier to run your test suite from your local or CI environment.
Install BrowserStack SDK using Maven Archetype
Maven Archetype provides a template to quickly configure your project. Copy & run the below command on your terminal/command prompt to add browserstack-java-sdk dependency in your pom.xml and browserstack.yml config file in your project.
Update your BrowserStack config file
Once you have installed the SDK, a browserstack.yml config file will be created at the root level of your project. This file holds all the required capabilities to run tests on BrowserStack.
Set platforms to test on
Set the browsers/devices you want to test under the platforms object. Our config follows W3C formatted capabilities.
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
BrowserStack’s Local Testing feature connects with test suites pointing to your localhost URL
BrowserStack Local supports all advanced use cases and restricted networks. Contact our support team for assistance in configuring BrowserStack Local for your enterprise.
BrowserStack Reporting
You can leverage BrowserStack’s extensive reporting features using the following capabilities:
Set build name as the name of the job/test suite being run
| buildIdentifier | Description | Generated build name on dashboard |
|---|---|---|
| ${BUILD_NUMBER} (Default) | If build is triggered locally, an incremental counter is appended. If build is triggered with CI tools, CI generated build number is appended. |
bstack-demo 1 bstack-demo CI 1395 |
| ${DATE_TIME} | The timestamp of run time is appended to the build. | bstack-demo 29-Nov-20:44 |
Advanced use cases for Build name
Custom formatting of build name
Prefix buildIdentifier with desired characters, for example, # or :
buildName: bstack-demo
buildIdentifier: '#${BUILD_NUMBER}'
Re-run tests in a build
You can re-run selected tests from a build using any of the following options:
Option 1: Set the existing build name in the BROWSERSTACK_BUILD_NAME variable and prepend it to your test run command to re-run tests in the same build:
BROWSERSTACK_BUILD_NAME=bstack-demo 1234 mvn test -P sample-test
Option 2: Set the build name as a combination of buildName and buildIdentifier, as seen on the dashboard, and set buildIdenitifier as null:
buildName: bstack-demo 123
buildIdentifier: null
Option 3: Set the buildIdentifier as the build number or time of the required build as seen on the dashboard:
buildName: bstack-demo
buildIdentifier: 123
Set a project name for your project.
sessionName 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.
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.yml file with selected capabilities
Copy the following code snippet and replace contents of browserstack.yml file in the root folder of your test suite.
Run your test suite
Run the following command from the project’s root directory to run your test suite with BrowserStack.
Set BrowserStack credentials
Saving your BrowserStack credentials as environment variables makes it easier to run your test suite from your local or CI environment.
Add BrowserStack SDK dependency
In your pom.xml file, add browserstack-java-sdk as a Maven dependency at the end of the dependencies list, within the <dependencies> element. Save the project.
Modify your build plugins
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
After installing 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 platforms to test on
Set the browsers / devices you want to test under the platforms object. Our config follows W3C formatted capabilities.
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
BrowserStack’s Local Testing feature connects with test suites pointing to your localhost URL
BrowserStack Local supports all advanced use cases and restricted networks. Contact our support team for assistance in configuring BrowserStack Local for your enterprise.
BrowserStack Reporting
You can leverage BrowserStack’s extensive reporting features using the following capabilities:
Set build name as the name of the job/test suite being run
| buildIdentifier | Description | Generated build name on dashboard |
|---|---|---|
| ${BUILD_NUMBER} (Default) | If build is triggered locally, an incremental counter is appended. If build is triggered with CI tools, CI generated build number is appended. |
bstack-demo 1 bstack-demo CI 1395 |
| ${DATE_TIME} | The timestamp of run time is appended to the build. | bstack-demo 29-Nov-20:44 |
Advanced use cases for Build name
Custom formatting of build name
Prefix buildIdentifier with desired characters, for example, # or :
buildName: bstack-demo
buildIdentifier: '#${BUILD_NUMBER}'
Re-run tests in a build
You can re-run selected tests from a build using any of the following options:
Option 1: Set the existing build name in the BROWSERSTACK_BUILD_NAME variable and prepend it to your test run command to re-run tests in the same build:
BROWSERSTACK_BUILD_NAME=bstack-demo 1234 mvn test -P sample-test
Option 2: Set the build name as a combination of buildName and buildIdentifier, as seen on the dashboard, and set buildIdenitifier as null:
buildName: bstack-demo 123
buildIdentifier: null
Option 3: Set the buildIdentifier as the build number or time of the required build as seen on the dashboard:
buildName: bstack-demo
buildIdentifier: 123
Set a project name for your project.
sessionName 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.
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
Create browserstack.yml file in the root folder of your test suite and add the adjacent code to it.
Run your test suite
Right-click your pom.xml file and click Run As → Maven Test:
Facing issues with TestNG Plugin?
If you encounter the following error, use these steps to resolve the issue:
- Get .m2 repository path for
browserstack-java-sdkjar
- Pass the .m2 repository path in
arglineofmaven-surefire-pluginin yourpom.xml
- Now you can run tests using TestNG Plugin
Set BrowserStack credentials
Saving your BrowserStack credentials as environment variables makes it easier to run your test suite from your local or CI environment.
Add BrowserStack SDK dependency
In your pom.xml file, add browserstack-java-sdk as a Maven dependency at the end of the dependencies list, within the <dependencies> element. Refresh the project.
Create your BrowserStack config file
After installing 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 platforms to test on
Set the browsers / devices you want to test under the platforms object. Our config follows W3C formatted capabilities.
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
BrowserStack’s Local Testing feature connects with test suites pointing to your localhost URL
BrowserStack Local supports all advanced use cases and restricted networks. Contact our support team for assistance in configuring BrowserStack Local for your enterprise.
BrowserStack Reporting
You can leverage BrowserStack’s extensive reporting features using the following capabilities:
Set build name as the name of the job/test suite being run
| buildIdentifier | Description | Generated build name on dashboard |
|---|---|---|
| ${BUILD_NUMBER} (Default) | If build is triggered locally, an incremental counter is appended. If build is triggered with CI tools, CI generated build number is appended. |
bstack-demo 1 bstack-demo CI 1395 |
| ${DATE_TIME} | The timestamp of run time is appended to the build. | bstack-demo 29-Nov-20:44 |
Advanced use cases for Build name
Custom formatting of build name
Prefix buildIdentifier with desired characters, for example, # or :
buildName: bstack-demo
buildIdentifier: '#${BUILD_NUMBER}'
Re-run tests in a build
You can re-run selected tests from a build using any of the following options:
Option 1: Set the existing build name in the BROWSERSTACK_BUILD_NAME variable and prepend it to your test run command to re-run tests in the same build:
BROWSERSTACK_BUILD_NAME=bstack-demo 1234 mvn test -P sample-test
Option 2: Set the build name as a combination of buildName and buildIdentifier, as seen on the dashboard, and set buildIdenitifier as null:
buildName: bstack-demo 123
buildIdentifier: null
Option 3: Set the buildIdentifier as the build number or time of the required build as seen on the dashboard:
buildName: bstack-demo
buildIdentifier: 123
Set a project name for your project.
sessionName 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.
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
Create browserstack.yml file in the root folder of your test suite and add the adjacent code to it.
Run your test suite
Get browserstack-java-sdk .m2 repository path
Search for the browserstack-java-sdk jar in External Libraries. Right-click the .jar file, select Copy Path/References, and then copy the absolute path:
Example Paths:
Mac or Linux: /Users/User_Name/.m2/repository/com/browserstack/browserstack-java-sdk/1.0.9/browserstack-java-sdk-1.0.9.jar
Windows: C:\Users\User_Name\.m2\repository\com\browserstack\browserstack-java-sdk\1.0.9\browserstack-java-sdk-1.0.9.jar
Add browserstack-java-sdk .m2 repository path in VM arguments
In your TestNG Runner file, click the run icon & select Modify Run Configurations:
Add .m2 repo path from previous step in VM options field. Click Apply and then click OK:
After successful completion of the above steps, you can now run your test suite using BrowserStack.
Advanced features and use cases
Here’s a list of features and capabilities you may 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 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 (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
|
Simulate IP geolocation
The geoLocation capability lets you test your websites 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. |
Simulate network conditions
The networkProfile capability lets you test your websites 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 Check out the complete list of all pre-defined network profiles. |
Others
Following are a few 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
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!
