Features
Start a free trial

Ruby Automated App Testing

Let's start with making sure Ruby is available on your system.

For Windows:
  • You can download Ruby for Windows from https://rubyinstaller.org/
  • Run the installer and follow the setup wizard to install Ruby.
For Linux/macOS:

Download RVM and install Ruby:

Copy code
curl -L https://get.rvm.io | bash -s stable --ruby

Installation

With TestingBot you can easily run your automated app tests with Ruby.
Please install the following gems:

Copy code
gem install --no-rdoc --no-ri appium_lib
gem install selenium-webdriver

Please see the example below. We're going to run a test on our sample app (calculator) where we'll add values to two input fields.

Real Device Testing

Copy code
require 'rubygems'
require 'appium_lib'

caps = {}
caps['name'] = 'Ruby Appium Example'
caps['deviceName'] = 'Galaxy S10'
caps['platformName'] = 'Android'
caps['version'] = '10.0'
caps['app'] = 'https://testingbot.com/appium/sample.apk'
caps['realDevice'] = true

appium_driver = Appium::Driver.new({
    'caps' => caps,
    'appium_lib' => {
        :server_url => "https://API_KEY:API_SECRET@hub.testingbot.com/wd/hub"
    }}, true)
driver = appium_driver.start_driver

wait = Selenium::WebDriver::Wait.new(:timeout => 30)
wait.until { driver.find_element(:accessibility_id, "inputA").displayed? }

driver.find_element(:accessibility_id, "inputA").send_keys 5
driver.find_element(:accessibility_id, "inputB").send_keys 10
result = driver.find_element(:accessibility_id, "sum")

if (!result.nil?) && (result.text.eql? "15")
  puts "Test Passed"
else
  puts "Test Failed"
end
driver.quit
Copy code
require 'rubygems'
require 'appium_lib'

caps = {}
caps['name'] = 'Ruby Appium Example'
caps['deviceName'] = 'iPhone XR'
caps['platformName'] = 'iOS'
caps['version'] = '16.3'
caps['app'] = 'https://testingbot.com/appium/sample.ipa'
caps['realDevice'] = true

appium_driver = Appium::Driver.new({
    'caps' => caps,
    'appium_lib' => {
        :server_url => "https://API_KEY:API_SECRET@hub.testingbot.com/wd/hub"
    }}, true)
driver = appium_driver.start_driver

wait = Selenium::WebDriver::Wait.new(:timeout => 30)
driver.find_element(:name, "inputA").send_keys 5
driver.find_element(:name, "inputB").send_keys 10
driver.quit

Simulator/Emulator Testing

Copy code
require 'rubygems'
require 'appium_lib'

caps = {}
caps['name'] = 'Ruby Appium Example'
caps['deviceName'] = 'Pixel 8'
caps['platformName'] = 'Android'
caps['version'] = '14.0'
caps['app'] = 'https://testingbot.com/appium/sample.apk'

appium_driver = Appium::Driver.new({
    'caps' => caps,
    'appium_lib' => {
        :server_url => "https://API_KEY:API_SECRET@hub.testingbot.com/wd/hub"
    }}, true)
driver = appium_driver.start_driver

wait = Selenium::WebDriver::Wait.new(:timeout => 30)
wait.until { driver.find_element(:accessibility_id, "inputA").displayed? }

driver.find_element(:accessibility_id, "inputA").send_keys 5
driver.find_element(:accessibility_id, "inputB").send_keys 10
result = driver.find_element(:accessibility_id, "sum")

if (!result.nil?) && (result.text.eql? "15")
  puts "Test Passed"
else
  puts "Test Failed"
end
driver.quit
Copy code
require 'rubygems'
require 'appium_lib'

caps = {}
caps['name'] = 'Ruby Appium Example'
caps['deviceName'] = 'iPhone 15'
caps['platformName'] = 'iOS'
caps['version'] = '17.4'
caps['app'] = 'https://testingbot.com/appium/sample.zip'

appium_driver = Appium::Driver.new({
    'caps' => caps,
    'appium_lib' => {
        :server_url => "https://API_KEY:API_SECRET@hub.testingbot.com/wd/hub"
    }}, true)
driver = appium_driver.start_driver

wait = Selenium::WebDriver::Wait.new(:timeout => 30)
driver.find_element(:name, "inputA").send_keys 5
driver.find_element(:name, "inputB").send_keys 10
driver.quit

Make sure to always stop your test (driver.quit), otherwise it will continue running, leading to a timeout.

Uploading Your App

Please see our Upload Mobile App documentation to find out how to upload your app to TestingBot for testing.

Specify Browsers & Devices

To run your existing tests on TestingBot, your tests will need to be configured to use the TestingBot remote machines. If the test was running on your local machine or network, you can simply change your existing test like this:

Before:
Copy code
appium_driver = Appium::Driver.new
After:
Copy code
appium_driver = Appium::Driver.new({
'caps' => caps,
'appium_lib' => {
    :server_url => "https://API_KEY:API_SECRET@hub.testingbot.com/wd/hub"
}}, true)

To let TestingBot know on which device you want to run your test on, you need to specify the deviceName, version, platformName and other optional options in the capabilities field.

Copy code
appium_driver = Appium::Driver.new({
'caps' => caps,
'appium_lib' => {
    :server_url => "https://API_KEY:API_SECRET@hub.testingbot.com/wd/hub"
}}, true)

To see how to do this, please select a combination of device type and device name in the drop-down menus below.

1. Select a Device Type
2. Select a Device Name
Copy code

Testing Internal Websites

We've built TestingBot Tunnel, to provide you with a secure way to run tests against your staged/internal webapps.
Please see our TestingBot Tunnel documentation for more information about this easy to use tunneling solution.

The example below shows how to easily run a Ruby WebDriver test with our Tunnel:

1. Download our tunnel and start the tunnel:

Copy code
java -jar testingbot-tunnel.jar key secret

2. Adjust your test: instead of pointing to 'hub.testingbot.com/wd/hub' like the example above - change it to point to your tunnel's IP address.
Assuming you run the tunnel on the same machine you run your tests, change to 'localhost:4445/wd/hub'. localhost is the machine running the tunnel, 4445 is the default port of the tunnel.

This way your test will go securely through the tunnel to TestingBot and back:

Copy code
#!/usr/bin/env ruby
require 'rubygems'
require 'appium_lib'

caps = {}
caps['build'] = 'Ruby Appium Sample'
caps['name'] = 'single_test'
caps['deviceName'] = 'iPhone 15'
caps['platformName'] = 'iOS'
caps['version'] = '17.4'
caps['app'] = 'https://testingbot.com/appium/sample.zip'

appium_driver = Appium::Driver.new({
    'caps' => caps,
    'appium_lib' => {
        :server_url => "https://API_KEY:API_SECRET@hub.testingbot.com/wd/hub"
    }}, true)
driver = appium_driver.start_driver

wait = Selenium::WebDriver::Wait.new(:timeout => 30)
driver.find_element(:name, "inputA").send_keys 5
driver.find_element(:name, "inputB").send_keys 10
driver.quit

Run tests in Parallel

Parallel Testing means running the same test, or multiple tests, simultaneously. This greatly reduces your total testing time.

You can run the same tests on all different browser configurations or run different tests all on the same browser configuration.
TestingBot has a large grid of machines and browsers, which means you can use our service to do efficient parallel testing. It is one of the key features we provide to greatly cut down on your total testing time.

To get started, please see the examples on https://github.com/grosser/parallel_tests

Queuing

Every plan we provide comes with a limit of parallel tests.
If you exceed the number of parallel tests assigned to your account, TestingBot will queue the additional tests (for up to 6 minutes) and run the tests as soon as slots become available.

Mark tests as passed/failed

As TestingBot has no way to dermine whether your test passed or failed (it is determined by your business logic), we offer a way to send the test status back to TestingBot. This is useful if you want to see if a test succeeded or failed from the TestingBot member area.

You can use our Ruby API client to report back test results.

Copy code
api = TestingBot::Api.new(key, secret)
api.update_test(driver.session_id, { :name => new_name, :success => true })

Preparing your App

You do not need to install any code or plugin to run a test.
Below are some things that are necessary to successfully run a mobile test:

For Android:
  • Please supply the URL to your .apk or .aab file.
    Important: the .apk file needs to be a x86 build (x86 ABI) for Android emulators.
For iOS Real Device:
  • Please supply the URL to an .ipa file.
For iOS Simulator:
  • Please supply the URL to a .zip file that contains your .app
  • The .app needs to be an iOS Simulator build:
    • Create a Simulator build:
      Copy code
      xcodebuild -sdk iphonesimulator -configuration Debug
    • Zip the .app bundle:
      Copy code
      zip -r MyApp.zip MyApp.app

Additional Options

Appium provides a lot of options to configure your test.

Some important options that might help:

For Android:
  • appActivity and appPackage: by default, Appium will try to extract the main Activity from your apk. If this fails, you can supply your own with these options.
  • chromeOptions: additional chromedriver options you can supply.
  • otherApps: a JSON array of other apps that need to be installed, in URL format.
For Android & iOS:
  • locale: the language of the simulator/device (ex: fr_CA)
  • newCommandTimeout: How long (in seconds) Appium will wait for a new command from the client before assuming the client quit and ending the session