Skip to main content
BrowserStack is now Appium’s Strategic Partner. Unlock the special benefits of this partnership. Learn More

Appium with TestNG

Test your native and hybrid apps on a real device cloud. This guide helps you run your first test build on a real Android or iOS device on BrowserStack.

Run tests on 150+ 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.

  • If you are using Eclipse or IntelliJ IDEA for running tests, install the corresponding TestNG plugin.

  • TestNG v6.8+, Java v8+ (if using Gradle, Java v9+ is required).

  • If you are using CLI for running tests, ensure that Maven is installed on your machine, Maven environment variables are set, and Maven bin is added to system path, $PATH(This is only applicable to mac/linux systems).

Run a sample build

Run a sample TestNG test build 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: Using Git

Clone our sample Git repository using the commands.

Copy icon Copy snippet

Configure your browserstack.yml config file

The browserstack.yml file holds all the required capabilities to run your tests on BrowserStack. It is found in your project’s (android/ios) root folder and is part of downloaded sample.

Set access credentials

Set userName and accessKey parameters in the browserstack.yml file to authenticate your tests on BrowserStack.

Select Android or iOS devices from a list of 150+ available combinations:

Use one of our sample apps to run your first Appium test on BrowserStack App Automate. Choose from the options below:

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.

You can also pass regular expressions (regex) in deviceName and platformVersion capabilities if your device selection is more flexible. Check out how to use regular expressions to specify device attributes.

browserstack.yml
Copy icon Copy snippet

Run sample tests on BrowserStack!

Based on the devices and app selected, cd to the right project, install dependencies, and run a sample test build on BrowserStack

cd android/testng-examples
mvn test -P sample-test
cd ios/testng-examples
mvn test -P sample-test

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, 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. It is found in your project’s (android/ios) root folder and is part of downloaded sample.

Set access credentials

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

Select Android or iOS devices from a list of 150+ available combinations:

Use one of our sample apps to run your first Appium test on BrowserStack App Automate. Choose from the options below:

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.

You can also pass regular expressions (regex) in deviceName and platformVersion capabilities if your device selection is more flexible. Check out how to use regular expressions to specify device attributes.

browserstack.yml
Copy icon Copy snippet

Run sample tests on BrowserStack

On the Eclipse toolbar, click Help > Eclipse Marketplace.

In the Eclipse Marketplace, search for BrowserStack > click Install > Finish. Search for BrowserStack plugin

Right-click on FirstTest.java > Run As > TestNG Test Run Test

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. Navigate to the earlier unzipped downloaded project .

Configure your browserstack.yml config file

The browserstack.yml file holds all the required capabilities to run your tests on BrowserStack. It is found in your project’s (android/ios) root folder and is part of downloaded sample.

Set access credentials

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

Select Android or iOS devices from a list of 150+ available combinations:

Use one of our sample apps to run your first Appium test on BrowserStack App Automate. Choose from the options below:

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.

You can also pass regular expressions (regex) in deviceName and platformVersion capabilities if your device selection is more flexible. Check out how to use regular expressions to specify device attributes.

browserstack.yml
Copy icon Copy snippet

Run sample tests on BrowserStack

Click IntelliJ IDEA > Preferences > Plugins.

Search for BrowserStack and click Install. Intellij IDEA Configuration

Open the file FirstTest.java and click the Run button. Run Test

After you run your test, visit the App Automate dashboard to view your test results.

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