Ruby
Documentation for running Appium automated mobile app tests with BrowserStack.
Getting Started
BrowserStack supports Appium automated mobile app tests using Ruby, 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 Ruby libraries installed.
#Install using rubygems gem install 'appium_lib' gem install selenium-webdriver
Step 2: Upload your app
Upload your Android app (.apk file) or iOS app (.ipa file) to the BrowserStack servers using the REST API.
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>"}
Note: If you do not have an .apk or .ipa file and are looking to simply try App Automate, you can download our Android sample app or iOS sample app and upload to the BrowserStack servers using the above API. Complete list of REST APIs can be found here.
Note:
- App upload will take few seconds to about a minute depending on the size of your app. Do not interrupt the curl command until you get the response back.
- We will delete the uploaded app after 30 days from the date of upload.
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.
Note: Complete list of REST API's can be found here. Use browserstack.app_version capability if you would like to test older version of apps uploaded under the custom_id. Refer Capabilities page for more details.
Step 3: Configure and run test
Copy sample code provided in Ruby for Android and iOS. Update the desired capability "app" with the App URL returned from the above API call.
If you are using our Sample App, the sample test below will install the Sample App (Wikipedia App) on the device, search for 'browserstack' and asserts for the list of results. If you are using your own app, modify the code as per your test cases. Copy the code below into your editor, and run the test from the command-line interface.
Note: Refer our sample repo for ruby on Github: ruby-appium-app-browserstack
require 'rubygems'
require 'appium_lib'
username = 'USERNAME'
access_key = 'ACCESS_KEY'
caps = {}
caps['build'] = 'Ruby Appium Sample'
caps['name'] = 'single_test'
caps['device'] = 'Samsung Galaxy S8 Plus'
caps['platformName'] = 'android'
caps['browserstack.debug'] = true
caps['app'] = 'bs://<hashed app-id>'
appium_driver = Appium::Driver.new({
'caps' => caps,
'appium_lib' => {
:server_url => "http://#{username}:#{access_key}@hub-cloud.browserstack.com/wd/hub"
}}, true)
driver = appium_driver.start_driver
wait = Selenium::WebDriver::Wait.new(:timeout => 30)
wait.until { driver.find_element(:accessibility_id, "Search Wikipedia").displayed? }
element = driver.find_element(:accessibility_id, "Search Wikipedia")
element.click
wait.until { driver.find_element(:id, "org.wikipedia.alpha:id/search_src_text").displayed? }
search_box = driver.find_element(:id, "org.wikipedia.alpha:id/search_src_text")
search_box.send_keys("BrowserStack")
sleep 5
results = driver.find_elements(:class, "android.widget.TextView")
if results.count > 0
puts "Found results - Test Passed"
else
puts "No results found - Test Failed"
end
driver.quit
If you are using our iOS Sample App, the sample test below will install the Sample App (WordPress App) on the device, navigate to the Login screen, enters the login email and check whether the email is registered on WordPress. If you are using your own app, modify the code as per your test cases. Copy the code below into your editor, and run the test from the command-line interface.
Note: Refer our sample repo for ruby on Github: ruby-appium-app-browserstack
require 'rubygems'
require 'appium_lib'
username = 'USERNAME'
access_key = 'ACCESS_KEY'
caps = {}
caps['build'] = 'Ruby Appium Sample'
caps['name'] = 'single_test'
caps['device'] = 'iPhone 7 Plus'
caps['platformName'] = 'iOS'
caps['browserstack.debug'] = true
caps['app'] = 'bs://<hashed app-id>'
appium_driver = Appium::Driver.new({
'caps' => caps,
'appium_lib' => {
:server_url => "http://#{username}:#{access_key}@hub-cloud.browserstack.com/wd/hub"
}}, true)
driver = appium_driver.start_driver
wait = Selenium::WebDriver::Wait.new(:timeout => 30)
wait.until { driver.find_element(:accessibility_id, "Log In").displayed? }
login_button = driver.find_element(:accessibility_id, "Log In")
login_button.click
wait.until { driver.find_element(:accessibility_id, "Email address").displayed? }
email_input = driver.find_element(:accessibility_id, "Email address")
email_input.send_keys("hello@browserstack.com")
wait.until { driver.find_element(:accessibility_id, "Next").displayed? }
driver.find_element(:accessibility_id, "Next").click
sleep 5
results = driver.find_elements(:xpath, "//XCUIElementTypeStaticText")
if results.map(&:text).any?{|x| !x.nil? && x.match('not registered on WordPress.com')}
puts "Test Passed"
else
puts "Test Failed"
end
driver.quit
Warning: The driver.quit statement is required, otherwise the test continues to execute, leading to a timeout.
The test results are available on the command-line interface, as well as the Automate dashboard. You have now run your first test on BrowserStack App Automate.
Note:
- UIAutomator2 is the default automation engine for Android.
- Pass automationName as 'Appium' if you are using Appium automation engine
- If your app uses webview, set the webview debugging flag to true when creating the webview object as described in the Android remote debugging docs: WebView.setWebContentsDebuggingEnabled(true);
Testing on Internal Networks
Download and run the BrowserStackLocal binary:
Download the appropriate binary:
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.
./BrowserStackLocal --key ACCESS_KEYOnce the connection is made you need to set the browserstack.local capability to true.
caps['browserstack.local'] = True
Multiple Local Testing connections
If you are using same account to test multiple applications, you can setup a named connection using localIdentifier.
- Run the BrowserStackLocal binary with the localIdentifier option
./BrowserStackLocal --key ACCESS_KEY --local-identifier Test123Here, we have created a named connection called Test123.
- Once the connection is made, you need to set the browserstack.localIdentifier capability with the correct named connection
caps['browserstack.local'] = 'true' caps['browserstack.localIdentifier'] = 'Test123'
Note: Learn more about other common local testing use cases such as testing behind a firewall, proxy, browsermob proxy and whitelisting IPs.
- Once the connection is made, you need to set the browserstack.localIdentifier capability with the correct named connection
Speed up testing
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.
Note: The wait limit for the execution of a pending queued job is 15 minutes and will be cancelled if exceeded.
We have provided examples of parallel testing implementation using popular testing frameworks.
Configuring Capabilities
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.
Note: In free trial you can access "Google Pixel", "Google Nexus 6" and "iPhone 7 Plus" devices.
desired_caps = {'device': 'iPhone 7 Plus', 'os_version': '10.0'}