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

This section covers running your first build with BrowserStack’s sample repo. To run builds with your existing test suite(s), skip to integrate your test suite.

Prerequisites

BrowserStack Username and Access key. You can find this in your account profile. If you do not have an account yet, please sign up for a Free Trial.
TestNG v6.8+, Java v8+ (if using Gradle, Java v9+ is required), Selenium v2.5+ (W3C/JSON Wire).
If you are using Eclipse or IntelliJ IDEA for running tests, install the corresponding TestNG plugin.
If you are using CLI for running tests, ensure that Maven or Gradle are 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:

Maven
Gradle

If you are using Maven, follow the given steps to run the sample build:

Get Sample Project

Download Project

Download ZIP

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

Import the downloaded project

Click File → Import. Expand General, select Projects from Folder or Archive, and click Next. Then, navigate to the earlier unzipped downloaded project .

Eclipse IDE Configuration

Configure your browserstack.yml config file

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

Set access credentials

Set userName and accessKey properties in the browserstack.yml file, available in the root directory, to authenticate your tests on BrowserStack.

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

Update the browserstack.yml config file

Copy and replace the platforms object in the browserstack.yml file.

```yml
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
framework: testng
platforms:
  - YOUR_FIRST_OS_TYPE: YOUR_FIRST_OS
    YOUR_FIRST_OS_VERSION_TYPE: YOUR_FIRST_OS_VERSION
    YOUR_FIRST_BROWSER_TYPE: YOUR_FIRST_BROWSER
    YOUR_FIRST_BROWSER_VERSION_TYPE: YOUR_FIRST_BROWSER_VERSION
  - YOUR_SECOND_OS_TYPE: YOUR_SECOND_OS
    YOUR_SECOND_OS_VERSION_TYPE: YOUR_SECOND_OS_VERSION
    YOUR_SECOND_BROWSER_TYPE: YOUR_SECOND_BROWSER
    YOUR_SECOND_BROWSER_VERSION_TYPE: YOUR_SECOND_BROWSER_VERSION
  - YOUR_THIRD_OS_TYPE: YOUR_THIRD_OS
    YOUR_THIRD_OS_VERSION_TYPE: YOUR_THIRD_OS_VERSION
    YOUR_THIRD_BROWSER_TYPE: YOUR_THIRD_BROWSER
    YOUR_THIRD_BROWSER_VERSION_TYPE: YOUR_THIRD_BROWSER_VERSION
parallelsPerPlatform: 1
browserstackLocal: true
buildName: browserstack-build-1
projectName: BrowserStack Sample    
```
browserstack.yml

      
      
    

        
            Copy icon
            
          
        Copy
      
    userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
framework: testng
platforms:
  - os: Windows
    osVersion: 10
    browserName: Chrome
    browserVersion: 120.0
  - os: OS X
    osVersion: Monterey
    browserName: Safari
    browserVersion: 15.6
  - deviceName: iPhone 13
    osVersion: 15
    browserName: Chromium
    deviceOrientation: portrait
parallelsPerPlatform: 1
browserstackLocal: true
buildName: browserstack-build-1
projectName: BrowserStack Sample

  