https://github.com/browserstack/serenity-appium-app-browserstack
This repository demonstrates how to run Appium tests in Xunit on BrowserStack App Automate.
https://github.com/browserstack/serenity-appium-app-browserstack
Last synced: 5 months ago
JSON representation
This repository demonstrates how to run Appium tests in Xunit on BrowserStack App Automate.
- Host: GitHub
- URL: https://github.com/browserstack/serenity-appium-app-browserstack
- Owner: browserstack
- Created: 2024-08-20T02:52:42.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2026-02-02T01:25:51.000Z (5 months ago)
- Last Synced: 2026-02-10T20:42:32.859Z (5 months ago)
- Language: Java
- Size: 33.7 MB
- Stars: 0
- Watchers: 6
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# serenity-appium-app-browserstack
[Serenity](https://serenity-bdd.info/) Integration with BrowserStack SDK.
## 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, run :
- For Android
```sh
cd android
mvn clean
```
- For iOS
```sh
cd ios
mvn clean
```
## Getting Started
Getting Started with Appium tests on BrowserStack couldn't be easier!
### **Run first test :**
- Update `browserstack.yml` file at root level of [Android examples](android) or [iOS examples](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 :**
- Update `browserstack.yml` file at root level of [Android examples](android) or [iOS examples](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 examples](android) or [iOS examples](ios).
```
browserstackLocal: true
```
- You can use the `LocalSample` app provided in both folder [Android examples](android) or [iOS examples](ios) to run your test. Change the app parameter in the `browserstack.yml` file.
- **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)
- [JUnit](https://github.com/browserstack/junit-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).