Appium with JUnit 5

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.

In this document, you’ll learn how to set up your JUnit 5 Appium testing environment, configure your test settings, and execute your first automated test on BrowserStack’s real device cloud. We’ll walk you through each step, from initial setup to viewing your test results on the dashboard.

Onboard faster with Test Companion

Launch in your IDE. Chat with the AI assistant to configure and run your first build instantly.

Launch in IDE

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.

• Environment & Build Tools:
  • For Maven: Java 8+ and JUnit 5. Ensure you have installed Maven by following the Maven installation guide and added it to your system PATH.
  • For Gradle: Java 9+. Ensure you have installed Gradle by following the Gradle installation guide and added it to your system PATH.
• Required Plugin (Gradle + JUnit 5 only):
  • If you are using Kotlin with Gradle, you must configure the com.browserstack.gradle-sdk plugin in your build files to support parallel execution across multiple devices.

Run a sample build

Run a sample Junit 5 test build using your preferred method on BrowserStack:

• CLI
• Eclipse IDE
• IntelliJ IDEA

Get Sample Project

Get our sample project using one of the following options:

Option 1: Download Project

Download ZIP

After downloading the sample project, unzip it in the desired location, and open the junit-5 directory.

Option 2: Using Git

Clone our sample Git repository using the commands.

```bash git clone -b master https://github.com/browserstack/junit-appium-app-browserstack.git cd junit-appium-app-browserstack/junit-5 ```

Copy

Option 3: Using Maven Archetype

Setup using Maven archetype to create a new sample project with your BrowserStack credentials pre-configured.

```bash mvn archetype:generate -B -DarchetypeGroupId=com.browserstack \ -DarchetypeArtifactId="browserstack-sdk-archetype-setup" -DarchetypeVersion=1.1 \ -DgroupId=com.browserstack -DartifactId=junit-appium-app-browserstack -Dversion=1.0 \ -DBROWSERSTACK_USERNAME=YOUR_USERNAME -DBROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY -DBROWSERSTACK_PROJECT_REPO=junit-appium-app-browserstack/junit-5:sdk ```

Copy

```bash mvn archetype:generate -B -DarchetypeGroupId="com.browserstack" -DarchetypeArtifactId="browserstack-sdk-archetype-setup" -DarchetypeVersion="1.1" -DgroupId="com.browserstack" -DartifactId="junit-appium-app-browserstack" -Dversion="1.0" -DBROWSERSTACK_USERNAME="YOUR_USERNAME" -DBROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY" -DBROWSERSTACK_PROJECT_REPO="junit-appium-app-browserstack/junit-5:sdk" && cd junit-appium-app-browserstack ```

Copy

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:

Platform

Select an OS to choose the devices from below

Android

Android

iOS

Parallel thread #1

Windows 10

Chrome 120

Parallel thread #2

OS X Monterey

Safari 15.6

Parallel thread #3

iOS 15

iPhone 13

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.

```yml userName: YOUR_USERNAME accessKey: YOUR_ACCESS_KEY framework: junit5 app: YOUR_APP_ID platforms: - YOUR_FIRST_OS_TYPE: YOUR_FIRST_OS 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_BROWSER_TYPE: YOUR_SECOND_BROWSER YOUR_SECOND_BROWSER_VERSION_TYPE: 'YOUR_SECOND_BROWSER_VERSION' - YOUR_THIRD_OS_TYPE: YOUR_THIRD_OS 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

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
mvn test -P sample-test

cd ios
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 File > Import. Expand General, select Projects from Folder or Archive, and click Next. Then, navigate to the earlier unzipped downloaded project and open the junit-5 directory.

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:

Platform

Select an OS to choose the devices from below

Android

Android

iOS

Parallel thread #1

Windows 10

Chrome 120

Parallel thread #2

OS X Monterey

Safari 15.6

Parallel thread #3

iOS 15

iPhone 13

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.

```yml userName: YOUR_USERNAME accessKey: YOUR_ACCESS_KEY framework: junit5 app: YOUR_APP_ID platforms: - YOUR_FIRST_OS_TYPE: YOUR_FIRST_OS 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_BROWSER_TYPE: YOUR_SECOND_BROWSER YOUR_SECOND_BROWSER_VERSION_TYPE: 'YOUR_SECOND_BROWSER_VERSION' - YOUR_THIRD_OS_TYPE: YOUR_THIRD_OS 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

Run sample tests on BrowserStack

On the Eclipse toolbar, click Help > Eclipse Marketplace.

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

Right-click on FirstTest.java > Run As > JUnit 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 and open the junit-5 directory.

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:

Platform

Select an OS to choose the devices from below

Android

Android

iOS

Parallel thread #1

Windows 10

Chrome 120

Parallel thread #2

OS X Monterey

Safari 15.6

Parallel thread #3

iOS 15

iPhone 13

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.

```yml userName: YOUR_USERNAME accessKey: YOUR_ACCESS_KEY framework: junit5 app: YOUR_APP_ID platforms: - YOUR_FIRST_OS_TYPE: YOUR_FIRST_OS 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_BROWSER_TYPE: YOUR_SECOND_BROWSER YOUR_SECOND_BROWSER_VERSION_TYPE: 'YOUR_SECOND_BROWSER_VERSION' - YOUR_THIRD_OS_TYPE: YOUR_THIRD_OS 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

Run sample tests on BrowserStack

Click IntelliJ IDEA > Preferences > Plugins.

Search for BrowserStack and click Install.

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

If a test run stops due to a crash, you can stop the build from running by clicking the Stop build option from the App Automate dashboard.

Next steps

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