Get your setup working faster. Join our Discord for optimisation tips from elite testers.

Automated tests on TestNG

Quick start guide to integrate Automated tests in BrowserStack Accessibility Testing with TestNG.

Prerequisites

You have an account with BrowserStack (even a free trial works) and can get the username and access key from Account & Profile.
Maven or Gradle is installed on your machine, its environment variables are set, and its bin is added to system path, $PATH.
TestNG v6.10+, Java v8+ (If using Gradle, Java v9+ is required), Selenium v2.5+ (JSON Wire / W3C).
You have a pre-existing TestNG test suite. You can use test suites integrated with BrowserStack Automate, BrowserStack Automate TurboScale or test suites that are outside the BrowserStack infrastructure.

The minimum version of browserstack-java-sdk that supports Automated tests is 1.13.10. To support Safari, you need version 1.57.00 or later of browserstack-java-sdk.

To get the instructions to integrate Automated tests in your test suites, select one of the following tabs depending on where your test suites run:

Install or update to the latest BrowserStack Java SDK

If you already use browserstack-java-sdk, update the entry enclosed within the <version> - </version> tags as LATEST in the pom.xml file of your project and run the following command to update to the latest SDK version.

Copy

If you don’t have browserstack-java-sdk installed already, run the following command on your terminal/command prompt to add browserstack-java-sdk dependency and browserstack.yml file in your project.

      
            macOS or Linux
          
            Windows
          
mvn archetype:generate -B -DarchetypeGroupId=com.browserstack \
-DarchetypeArtifactId=testng-archetype-integrate -DarchetypeVersion=1.2 \
-DgroupId=com.browserstack -DartifactId=testng-archetype-integrate -Dversion=1.2 \
-DBROWSERSTACK_USERNAME=YOUR_USERNAME -DBROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY

mvn archetype:generate -B -DarchetypeGroupId=com.browserstack -DarchetypeArtifactId=testng-archetype-integrate -DarchetypeVersion=1.2 -DgroupId=com.browserstack -DartifactId=testng-archetype-integrate -Dversion=1.2 -DBROWSERSTACK_USERNAME=YOUR_USERNAME -DBROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY

Modify your browserStack.yml config file

Automated tests mandatorily needs the following five configurations in the browserstack.yml file. In particular, set the accessibility flag as true at the end of the browserstack.yml file.

The projectName and buildName config must be static and not change across different runs of the same build. This deviates from the standard BrowserStack Automate approach, because Automated tests automatically identify different build runs.

Copy

Automated tests support the following browsers and operating systems:

Operating system	Chrome	Safari	Edge
Windows	Versions 100 and above	N/A	Not supported
macOS	Versions 100 and above	`osVersion: Sequoia`, `osVersion: Tahoe`, and `osVersion: Golden Gate`	Not supported
Android	Android 15 and 16	N/A	Not supported
iOS	Not supported	Not supported	Not supported

Use the exact configurations provided in the example for mobile browser testing. Using different combinations of configurations may cause testing errors.
Window handle commands might cause instability to Automated tests. If you face issues, consider removing window handle commands or contact support.

Run your test suite with Automated tests

Continue running your tests as you have been running previously. The command to run your tests using the BrowserStack SDK remains unchanged. For your reference, here’s a sample command:

Copy

You can check the Accessibility report for your build through the Automated tests page.

Visit Automated tests page

Install or update to the latest BrowserStack Java SDK

Copy

      
            macOS or Linux
          
            Windows
          
mvn archetype:generate -B -DarchetypeGroupId=com.browserstack \
-DarchetypeArtifactId=testng-archetype-integrate -DarchetypeVersion=1.2 \
-DgroupId=com.browserstack -DartifactId=testng-archetype-integrate -Dversion=1.2 \
-DBROWSERSTACK_USERNAME=YOUR_USERNAME -DBROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY

mvn archetype:generate -B -DarchetypeGroupId=com.browserstack -DarchetypeArtifactId=testng-archetype-integrate -DarchetypeVersion=1.2 -DgroupId=com.browserstack -DartifactId=testng-archetype-integrate -Dversion=1.2 -DBROWSERSTACK_USERNAME=YOUR_USERNAME -DBROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY

Modify your browserStack.yml config file

Automated tests mandatorily needs the following five configurations in the browserstack.yml file. In particular, set the accessibility flag as true at the end of the browserstack.yml file.

Copy

Automated tests support the following browsers and operating systems:

Operating system	Chrome	Safari	Edge
Windows	Versions 100 and above	N/A	Not supported
macOS	Versions 100 and above	`osVersion: Sequoia`, `osVersion: Tahoe`, and `osVersion: Golden Gate`	Not supported
Android	Android 15 and 16	N/A	Not supported
iOS	Not supported	Not supported	Not supported

Use the exact configurations provided in the example for mobile browser testing. Using different combinations of configurations may cause testing errors.
Window handle commands might cause instability to Automated tests. If you face issues, consider removing window handle commands or contact support.

Run your test suite with Automated tests

Continue running your tests as you have been running previously. The command to run your tests using the BrowserStack SDK remains unchanged. For your reference, here’s a sample command:

Copy

You can check the Accessibility report for your build through the Automated tests page.

Visit Automated tests page

Install or update to the latest BrowserStack Java SDK

Copy

      
            macOS or Linux
          
            Windows
          
mvn archetype:generate -B -DarchetypeGroupId=com.browserstack \
-DarchetypeArtifactId=testng-archetype-integrate -DarchetypeVersion=1.2 \
-DgroupId=com.browserstack -DartifactId=testng-archetype-integrate -Dversion=1.2 \
-DBROWSERSTACK_USERNAME=YOUR_USERNAME -DBROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY

mvn archetype:generate -B -DarchetypeGroupId=com.browserstack -DarchetypeArtifactId=testng-archetype-integrate -DarchetypeVersion=1.2 -DgroupId=com.browserstack -DartifactId=testng-archetype-integrate -Dversion=1.2 -DBROWSERSTACK_USERNAME=YOUR_USERNAME -DBROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY

Modify your browserStack.yml config file

Automated tests mandatorily needs the following five configurations in the browserstack.yml file. In particular, set the accessibility flag as true at the end of the browserstack.yml file.

Google Chrome policy changes in v142 and later prevent accessibility automation from functioning for customers using non-BrowserStack infrastructure.

To continue performing accessibility automation, you must either:

Switch to Chrome for Testing (recommended).
Use Chrome v141 or an earlier version.

Copy

Automated tests support the following browsers and operating systems:

Operating system	Chrome	Safari	Edge
Windows	Versions 100 and above	N/A	Not supported
macOS	Versions 100 and above	`osVersion: Sequoia`, `osVersion: Tahoe`, and `osVersion: Golden Gate`	Not supported
Android	Android 15 and 16	N/A	Not supported
iOS	Not supported	Not supported	Not supported

Use the exact configurations provided in the example for mobile browser testing. Using different combinations of configurations may cause testing errors.
Window handle commands might cause instability to Automated tests. If you face issues, consider removing window handle commands or contact support.

Run your test suite with Automated tests

Continue running your tests as you have been running previously. The command to run your tests using the BrowserStack SDK remains unchanged. For your reference, here’s a sample command:

Copy

You can check the Accessibility report for your build through the Automated tests page.

Visit Automated tests page

Did this page help you?

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

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback

Is this page helping you?

Yes

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

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback!