Python

BrowserStack supports Appium automated mobile app tests using Python, and running your tests on our cloud setup is simple and straightforward. Follow 3 easy steps to get started with your first Appium test on BrowserStack cloud.

Step 1: Setup environment

Ensure you have python libraries installed.

#If pip is not installed, you can install it using:
sudo easy_install pip
 
#If you prefer pip, then use the following command:
sudo pip install Appium-Python-Client
sudo pip install selenium

Step 2: Upload your app

Upload your Android app (.apk file) or iOS app (.ipa file) to the BrowserStack servers using the REST API. A unique App URL (bs://<hashed appid>) is generated every time you upload an app.

The AppiumDriver uses the 'app' capability to identify the application file to install on the target device. Note the App URL to configure the 'app' capability of your test as explained in step 3.

curl -u "USERNAME:ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/upload" \
-F "file=@/path/to/app/file/Application-debug.apk"

Please note the App URL (bs://<hashed appid>) returned in the response of this call:

{"app_url":"bs://<hashed appid>"}

If you would like to set a constant value in your 'app' capability instead updating your test code to change the App URL everytime you upload an app, define a Custom Id for your apps. Use the same Custom Id for every build you upload. Custom Id is optional.

curl -u "USERNAME:ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/upload" \
-F "file=@/path/to/app/file/Application-debug.apk" \
-F "data={\"custom_id\": \"MyApp\"}"

Sample response of the API call

{"custom_id":"MyApp", "app_url":"bs://<hashed appid>", "shareable_id":"USERNAME/MyApp"}

You can use either of the above values in the 'app' capability of your test.

custom_id: If you use custom_id value in the 'app' capability, Appium will pick the latest app uploaded by you using that custom_id. For example, if you upload 3 different builds of your app using the same custom_id, and if you are using custom_id in your 'app' capability, Appium will pick the last uploaded build and execute your test.

shareable_id: If you would like some other user with in your group to run test using the app uploaded by you, provide the shareable_id to that user. The user can set shareable_id value in the 'app' capability and run the test.

Step 3: Configure and run test

Copy sample code provided in python for Android and iOS. Update the desired capability "app" with the App URL returned from the above API call.

from appium import webdriver
from appium.webdriver.common.mobileby import MobileBy
from selenium.webdriver.support.ui import WebDriverWait
from selenium.webdriver.support import expected_conditions as EC
import time
 
userName = "USERNAME"
accessKey = "ACCESS_KEY"
 
desired_caps = {
    "build": "Python Android",
    "device": "Samsung Galaxy S8 Plus",
    "app": "bs://<hashed app-id>"
}
 
driver = webdriver.Remote("http://" + userName + ":" + accessKey + "@hub-cloud.browserstack.com/wd/hub", desired_caps)
 
search_element = WebDriverWait(driver, 30).until(
    EC.element_to_be_clickable((MobileBy.ACCESSIBILITY_ID, "Search Wikipedia"))
)
search_element.click()
 
search_input = WebDriverWait(driver, 30).until(
    EC.element_to_be_clickable((MobileBy.ID, "org.wikipedia.alpha:id/search_src_text"))
)
search_input.send_keys("BrowserStack")
time.sleep(5)
 
search_results = driver.find_elements_by_class_name("android.widget.TextView")
assert(len(search_results) > 0)
 
driver.quit()

from appium import webdriver
from appium.webdriver.common.mobileby import MobileBy
from selenium.webdriver.support.ui import WebDriverWait
from selenium.webdriver.support import expected_conditions as EC
import time
 
userName = "USERNAME"
accessKey = "ACCESS_KEY"
 
desired_caps = {
    "build": "Python iOS",
    "device": "iPhone 7 Plus",
    "app": "bs://<hashed app-id>"
}
 
driver = webdriver.Remote("http://" + userName + ":" + accessKey + "@hub-cloud.browserstack.com/wd/hub", desired_caps)
 
login_button = WebDriverWait(driver, 30).until(
    EC.element_to_be_clickable((MobileBy.ACCESSIBILITY_ID, "Log In"))
)
login_button.click()
 
email_input = WebDriverWait(driver, 30).until(
    EC.element_to_be_clickable((MobileBy.ACCESSIBILITY_ID, "Email address"))
)
email_input.send_keys("hello@browserstack.com")
 
driver.find_element_by_accessibility_id("Next").click()
time.sleep(5)
 
text_elements = driver.find_elements_by_xpath("//XCUIElementTypeStaticText")
assert(len(text_elements) > 0)
elements = filter(
    lambda x: x and x.__contains__("not registered on WordPress.com"),
    [x.text for x in text_elements]
)
assert(len(elements) > 0)
driver.quit()

1. Download and run the BrowserStackLocal binary:

   Download the appropriate binary:

   • OS X (Recommended for your system)
   • Linux 32-bit
   • Linux 64-bit
   • Windows

   The download links are secure. The binaries are digitally signed, identifying the publisher as BrowserStack Ltd. Read more about our security.

   Navigate to the folder containing the binary, and run it from the terminal.

   • OS X & Linux
   • Windows

   ./BrowserStackLocal --key ACCESS_KEY
   

2. Once the connection is made you need to set the browserstack.local capability to true.

   desired_caps['browserstack.local'] = True
   

Parallel testing is running multiple tests concurrently to reduce your testing time, and is a key feature of BrowserStack Automate. This can be the same test running on different browser configurations, or different tests running on the same browser configuration. With access to our extensive BrowserStack cloud, parallel testing on many platforms becomes very efficient.

Queuing

With queuing, you can launch an additional number of parallel tests with different configurations that will be queued in a sequence, for a seamless parallel execution. For instance, if you want to run 5 additional tests, apart from your subscribed limit of 2 parallel tests, BrowserStack will queue the additional 5 tests until one of the 2 initial tests finish, and a slot is available for execution. With queuing, you can be less bothered about managing your tests, and it can save development time.

With this feature, accounts up to 5 parallel tests can queue 5 tests. Beyond 5 parallel tests, an equivalent number of tests will be queued.

We have provided examples of parallel testing implementation using popular testing frameworks.

Capabilities are a series of key-value pairs that allow customization of testing from within BrowserStack Automate.

Appium provides a series of capabilities that you can set for the Appium version you are running. Appium server on the BrowserStack will receive all the capabilities you set on the client side. You can also use BrowserStack specific capabilities to configure your tests. Visit Capabilities page to view the complete list of BrowserStack capabilities.

Use the drop down below to select your device and configure the capabilities.

desired_caps = {'device': 'iPhone 7 Plus', 'os_version': '10.0'}