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

Selenium with TestNG

Your guide to running tests using TestNG on BrowserStack’s Selenium Grid of 3000+ real devices and desktop browsers.

Run tests on 3000+ real devices and desktop browsers

Prerequisites

  • You need to have BrowserStack Username and Access key, which you can find in your account profile. If you have not created an account yet, you can sign up for a Free Trial.
  • TestNG v6.8+, Java v8+ (if using Gradle, Java v9+ is required), Selenium v2.5+ (JSON Wire / W3C).
  • If you are using CLI for running tests, ensure that Maven or Gradle is installed on your machine, its environment variables are set, and its bin is added to system path, $PATH.

Run a sample build

Run a sample TestNG test build, which is based on the TestNG runner, using your preferred method on BrowserStack:

Get Sample Project

Get our sample project using one of the following options:

Option 1: Download Project

Download ZIP

Option 2: Via Git

Clone our sample Git repository using the following code snippet:

Copy icon Copy snippet

Option 3: Via Maven Archetype

Maven archetype lets you create a new sample project with your BrowserStack credentials pre-configured.

The following command creates a project named as testng-browserstack with the sample scripts.

Copy icon Copy snippet
Copy icon Copy snippet

Configure your browserstack.yml config file

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

Set access credentials

Set userName and accessKey properties in browserstack.yml to authenticate your tests on BrowserStack.

Select desktop browsers or real devices from a list of 3000+ available combinations:

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

Update the browserstack.yml config file

Copy and replace the platforms object in the browserstack.yml file available in the root directory of this project.

browserstack.yml
Copy icon Copy snippet

Run sample tests on BrowserStack!

Install dependencies and run a sample test build on BrowserStack using the following commands:

mvn compile
mvn test -P sample-test
gradle build
gradle sampleTest

Get Sample Project

Download Project

Download ZIP

After downloading the sample project, unzip it in the desired location.

Import the downloaded project

Click FileImport. Expand General, select Projects from Folder or Archive, and click Next. Then, click the directory and navigate to the earlier unzipped downloaded project.
Eclipse IDE Configuration

Configure your browserstack.yml config file

Configure a few parameters in the sample repo to start testing.

Set access credentials

Set userName and accessKey properties in browserstack.yml to authenticate your tests on BrowserStack.

Select desktop browsers or real devices from a list of 3000+ available combinations:

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

Update the browserstack.yml config file

Copy and replace the platforms object in the browserstack.yml file available in the root directory of this project.

browserstack.yml
Copy icon Copy snippet

Run sample tests on BrowserStack

Right-click your pom.xml file and click Run AsMaven Test:
Eclipse IDE Configuration

Facing issues with TestNG Plugin?

If you encounter the following error, use these steps to resolve the issue:

TestNG Runner Error

  1. Get .m2 repository path for browserstack-java-sdk jar. .m2 repository path
  2. Pass the .m2 repository path in argline of maven-surefire-plugin in your pom.xml file. Modify argline
  3. Retry running tests using the TestNG Plugin.```

Get Sample Project

Download Project

Download ZIP

After downloading the sample project, unzip it in the desired location.

Import the downloaded project

Click File → Open, and then navigate to the earlier unzipped downloaded project. Click Open.

Configure your browserstack.yml config file

Configure the following few parameters in the sample repository to start testing.

Set access credentials

Set userName and accessKey properties in browserstack.yml to authenticate your tests on BrowserStack.

Select desktop browsers or real devices from a list of 3000+ available combinations:

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

Update the browserstack.yml config file

Copy and replace the platforms object in the browserstack.yml file available in the root directory of this project.

browserstack.yml
Copy icon Copy snippet

Run sample tests on BrowserStack

Run the tests using the following steps:

Click the Maven tool window on the right-hand side. If you can’t see the tool window, click View -> Tool Windows -> Maven to enable it:

Intellij IDEA Configuration

Under Profiles, select the profiles for running tests:

Intellij IDEA Configuration

Expand the Lifecycle drop-down, and then double-click test to run the tests:

Intellij IDEA Configuration

Next steps

After you have successfully run your first test on BrowserStack, try integrating your test suite with BrowserStack.

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