https://github.com/browserstack/junit-appium-app-browserstack
https://github.com/browserstack/junit-appium-app-browserstack
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/browserstack/junit-appium-app-browserstack
- Owner: browserstack
- Created: 2017-08-03T10:38:34.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-04-04T08:31:59.000Z (12 months ago)
- Last Synced: 2025-04-22T21:07:11.913Z (11 months ago)
- Language: Java
- Size: 35.6 MB
- Stars: 7
- Watchers: 17
- Forks: 23
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# junit-appium-app-browserstack
This repository demonstrates how to run Appium tests in [JUnit4](http://junit.org/junit4/) and [Junit5](https://junit.org/junit5/) on BrowserStack App Automate.
## Based on
These code samples are currently based on:
- **Appium-Java-Client:** `8.1.1`
- **Protocol:** `W3C`
## Setup
### Requirements
1. Java 8+
- If Java is not installed, follow these instructions:
- For Windows, download latest java version from [here](https://java.com/en/download/) and run the installer executable
- For Mac and Linux, run `java -version` to see what java version is pre-installed. If you want a different version download from [here](https://java.com/en/download/)
2. Maven (Only required if using Maven as the build tool)
- If Maven is not downloaded, download it from [here](https://maven.apache.org/download.cgi)
- For installation, follow the instructions [here](https://maven.apache.org/install.html)
3. Gradle (Only required if using Gradle as the build tool)
- If Gradle is not downloaded, download it from [here](https://gradle.org/releases/)
- For installation, follow the instructions [here](https://gradle.org/install/)
### Install the dependencies
To install the dependencies for JUnit4 tests, run :
- For Android
```sh
cd junit-4/android
mvn clean
```
- For iOS
```sh
cd junit-4/ios
mvn clean
```
Or,
To install the dependencies for JUnit5 tests, run :
- For Android
```sh
cd junit-5/android
mvn clean
```
- For iOS
```sh
cd junit-5/ios
mvn clean
```
## Getting Started
Getting Started with Appium tests in Junit4 and Junit5 on BrowserStack couldn't be easier!
### **Run first test :**
- Junit4
- Update `browserstack.yml` file at root level of [Android Junit4 examples](junit-4/android) or [iOS Junit4 examples](junit-4/ios) with your [BrowserStack Username and Access Key](https://www.browserstack.com/accounts/settings)
- **For Maven:** Run the following command to execute tests in the Maven environment:
```sh
mvn test -P sample-test
```
- **For Gradle:** Run the following command to execute tests in the Gradle environment:
```sh
gradle clean sampleTest
```
- Junit5
- Update `browserstack.yml` file at root level of [Android Junit5 examples](junit-5/android) or [iOS Junit5 examples](junit-5/ios) with your [BrowserStack Username and Access Key](https://www.browserstack.com/accounts/settings)
- **For Maven:** Run the following command to execute tests in the Maven environment:
```sh
mvn test -P sample-test
```
- **For Gradle:** Run the following command to execute tests in the Gradle environment:
```sh
gradle clean sampleTest
```
### **Use Local testing for apps that access resources hosted in development or testing environments :**
- Junit4
- Update `browserstack.yml` file at root level of [Android Junit4 examples](junit-4/android) or [iOS Junit4 examples](junit-4/ios) with your [BrowserStack Username and Access Key](https://www.browserstack.com/accounts/settings)
- Simply configure the browserstackLocal parameter in the browserstack.yml file accordingly in [Android Junit4 examples](junit-4/android) or [iOS Junit4 examples](junit-4/ios).
```
browserstackLocal: true
```
- **For Maven:** Run the following command to execute tests in the Maven environment:
```sh
mvn test -P sample-local-test
```
- **For Gradle:** Run the following command to execute tests in the Gradle environment:
```sh
gradle clean sampleLocalTest
```
- Junit5
- Update `browserstack.yml` file at root level of Android Junit5 examples or iOS Junit5 examples with your [BrowserStack Username and Access Key](https://www.browserstack.com/accounts/settings)
- Simply configure the browserstackLocal parameter in the browserstack.yml file accordingly in [Android Junit5 examples](junit-5/android) or [iOS Junit5 examples](junit-5/ios).
```
browserstackLocal: true
```
- **For Maven:** Run the following command to execute tests in the Maven environment:
```sh
mvn test -P sample-local-test
```
- **For Gradle:** Run the following command to execute tests in the Gradle environment:
```sh
gradle clean sampleLocalTest
```
**Note**: If you are facing any issues, refer [Getting Help section](#Getting-Help)
## Integration with other Java frameworks
For other Java frameworks samples, refer to following repositories :
- [TestNG](https://github.com/browserstack/testng-appium-app-browserstack)
- [Java](https://github.com/browserstack/java-appium-app-browserstack)
Note: For other test frameworks supported by App-Automate refer our [Developer documentation](https://www.browserstack.com/docs/)
## Getting Help
If you are running into any issues or have any queries, please check [Browserstack Support page](https://www.browserstack.com/support/app-automate) or [get in touch with us](https://www.browserstack.com/contact?ref=help).