This repository demonstrates how to run Appium Java tests on BrowserStack App Automate.
- Java 8+
- If Java is not installed, follow these instructions:
-
Maven
To install the dependencies, run the following command in the project's base folder
mvn clean install
Getting Started with Appium tests in Java on BrowserStack couldn't be easier!
1. Upload your Android or iOS App
Upload your Android app (.apk or .aab file) or iOS app (.ipa file) to BrowserStack servers using our REST API. Here is an example cURL request :
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/upload" \
-F "file=@/path/to/apk/file"
Ensure that @ symbol is prepended to the file path in the above request. Please note the app_url
value returned in the API response. We will use this to set the application under test while configuring the test later on.
Note: If you do not have an .apk or .ipa file and are looking to simply try App Automate, you can download and test using our sample Android app or sample iOS app.
2. Configure and run your first test
Open BrowserStackSample.java
file in the android
directory or ios
directory :
-
Replace
YOUR_USERNAME
&YOUR_ACCESS_KEY
with your BrowserStack access credentials. Get your BrowserStack access credentials from here -
Replace
bs://<app-id>
with the URL obtained from app upload step -
Set the device and OS version
-
If you have uploaded your own app update the test case
-
To run the test, use the following command in the base directory :
- For Android test, run
mvn test -P android-first-test
- For iOS test, run
mvn test -P ios-first-test
-
You can access the test execution results, and debugging information such as video recording, network logs on App Automate dashboard
1. Upoad your Android or iOS App
Upload your Android app (.apk or .aab file) or iOS app (.ipa file) that access resources hosted on your internal or test environments to BrowserStack servers using our REST API. Here is an example cURL request :
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/upload" \
-F "file=@/path/to/apk/file"
Ensure that @ symbol is prepended to the file path in the above request. Please note the app_url
value returned in the API response. We will use this to set the application under test while configuring the test later on.
Note: If you do not have an .apk or .ipa file and are looking to simply try App Automate, you can download and test using our sample Android Local app or sample iOS Local app.
2. Configure and run your local test
Open BrowserStackSampleLocal.java
file in the android
or ios
directory :
-
Replace
YOUR_USERNAME
&YOUR_ACCESS_KEY
with your BrowserStack access credentials. Get your BrowserStack access credentials from here -
Replace
bs://<app-id>
with the URL obtained from app upload step -
Set the device and OS version
-
Ensure that
browserstack.local
capability is set totrue
. Within the test script, there is code snippet that automatically establishes Local Testing connection to BrowserStack servers using Java binding for BrowserStack Local. -
If you have uploaded your own app update the test case
-
To run the test, use the following command in the base directory :
- For Android test, run
mvn test -P android-local-test
- For iOS test, run
mvn test -P ios-local-test
-
You can access the test execution results, and debugging information such as video recording, network logs on App Automate dashboard
If you are running into any issues or have any queries, please check Browserstack Support page or get in touch with us.