robot-appium-app-browserstack

This repository demonstrates how to run Appium Robot tests on BrowserStack App Automate.

Based on

These code samples are currently based on:

Appium-Python-Client: 3.2.1
Selenium: 4.16.0
Protocol: W3C

Setup

Requirements

Python 3.7+

NOTE: Since v1.0.0, only Python 3.7+ is supported.
- For Windows, download latest python version from here and run the installer executable
- For Mac and Linux, run python --version to see what python version is pre-installed. If you want a different version download from here
Package Manager pip

Note : pip comes installed with python 3.4+
- If pip is not installed, follow these instructions:
  - Securely download get-pip.py by following this link: get-pip.py or use following cURL command to download it:
```
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
```
  - After dowloading, run the file :
    - For Python 3
      python3 get-pip.py

Install the dependencies

To install the dependencies, run the following command in project's base directory:

For Python 3
```
pip3 install -r requirements.txt
```

Getting Started

Getting Started with Appium tests in Robot on BrowserStack couldn't be easier!

Run your first test :

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

Export BrowserStack access credentials

Run export BROWSERSTACK_USERNAME=<username> && export BROWSERSTACK_ACCESS_KEY=<accesskey>
- Get your BrowserStack access credentials from here

Open Tests/android/SingleTestAndroid.robot

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
Run robot --outputdir . Tests/android/SingleTestAndroid.robot
You can access the test execution results, and debugging information such as video recording, network logs on App Automate dashboard

Use Local testing for apps that access resources hosted in development or testing environments :

1. Upload 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"

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 Tests/common/KeywordsFile.robot file :

Replace BROWSERSTACK_USERNAME & BROWSERSTACK_ACCESS_KEY with your BrowserStack access credentials. Get your BrowserStack access credentials from here

Open Tests/android/LocalTestAndroid.robot

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
Run robot --outputdir . Tests/android/LocalTestAndroid.robot
You can access the test execution results, and debugging information such as video recording, network logs on App Automate dashboard

3. Configure and run your tests in parallel

To run parallel tests we will be using the Pabot library

Android Test

Run pabot --processes <count_of_parallels> Tests/android/parallel/*.robot

iOS Tests

Run pabot --processes <count_of_parallels> Tests/ios/parallel/*.robot

Integration with other python frameworks

For other Python frameworks samples, refer to following repositories :

Note: For other test frameworks supported by App-Automate refer our Developer documentation

Getting Help

If you are running into any issues or have any queries, please check Browserstack Support page or get in touch with us.

browserstack / robot-appium-app-browserstack