Skip to main content

Appium with Ruby

In this documentation, you will learn how to trigger a automation script of Ruby for application testing with Appium on LambdaTest, set the desired capabilities for appium testing, and other advanced features of LambdaTest.

Prerequisites​

  • Your LambdaTest Username and Access key.
  • Install Ruby on your local system. Follow these instructions to install on different operating systems.

For macOS, you can run a Homebrew command like this:

brew install ruby

Try our Sample Repository​

Step 1: Get a Sample Project​

You can use your own project to configure and test it. For demo purposes, we are using the sample repository.

Sample repo

All the code samples in this documentation can be found on LambdaTest's Github Repository. You can either download or clone the repository to quickly run your tests. Image View on GitHub

Step 2: Setup the Environment Variables​

You need to export your environment variables LT_USERNAME and LT_ACCESS_KEY that are available in your LambdaTest Profile page. Run the below mentioned commands in your terminal to setup the environment variables.

export LT_USERNAME="undefined"
export LT_ACCESS_KEY="undefined"

Step 3: Upload your Application​

Upload your iOS application (.ipa file) or android application (.apk or .aab file) to the LambdaTest servers using our REST API. You need to provide your Username and AccessKey in the format Username:AccessKey in the cURL command for authentication.

Make sure to add the path of the appFile in the cURL request. Below is an example cURL request to upload your app using our REST API:

curl -u "undefined:undefined" -X POST "https://manual-api.lambdatest.com/app/upload/realDevice" -F "appFile=@"/Users/macuser/Downloads/proverbial_android.apk"" -F "name="proverbial_app""
tip

  • If you do not have any .apk or .ipa file, you can run your sample tests on LambdaTest by using our sample apps, 🔗 Android app or 🔗 iOS app.

  • Response of above cURL will be a JSON object containing the APP_URL of the format - lt://APP123456789123456789 and will be used in the next step

Step 4: Update your Automation Script​

An automation script for the sample application given above has been provided here. Ensure to update the APP_URL, username and accessKey in the code scripts before running the tests.

ios.py
require 'rubygems'
require 'appium_lib'

        username= "username" #Add username here
        accessToken= "accesKey" #Add accessKey here

        caps = {
          "LT:Options" => {      
                :deviceName => "iPhone 13 Pro",  
                :platformName => "iOS",
                :platformVersion => "15",
                :build => "Ruby Vanilla - iOS",
                :name => "Ruby iOS Test",
                :isRealMobile => true,
                :app => "YOUR_APP_URL", #Enter the App URL here
                :w3c => true,
        } }

        appium_driver = Appium::Driver.new({
            'caps' => caps,
            'appium_lib' => {
                :server_url => "http://"+username+":"+accessToken+"@mobile-hub.lambdatest.com/wd/hub"
            }}, true)

            driver = appium_driver.start_driver

            wait = Selenium::WebDriver::Wait.new(:timeout => 30)

            el1 = driver.find_element(:id, "color")
            el1.click
            el2 = driver.find_element(:id, "geoLocation")
            el2.click
            sleep(5)
            driver.back
            el3 = driver.find_element(:id, "Text")
            el3.click
            el4 = driver.find_element(:id, "notification")
            el4.click
            el5 = driver.find_element(:id, "Toast")
            el5.click
            el6 = driver.find_element(:id, "speedTest")
            el6.click
            sleep(10)
            driver.back

            puts "Found results - Test Passed"


            driver.quit

Step 5: Configure the Test Capabilities​

You can update your custom capabilities in test scripts. In this sample project, we are passing platform name, platform version, device name and app url (generated earlier) along with other capabilities like build name and test name via capabilities object.

The capabilities object in the sample code are defined as:

iOS(.ipa)
 caps = {
            "LT:Options" => {
                :deviceName => "iPhone 13 Pro",  
                :platformName => "iOS",
                :platformVersion => "15",
                :build => "Ruby Vanilla - iOS",
                :name => "Ruby iOS Test",
                :isRealMobile => true,
                :app => "YOUR_APP_URL", #Enter the App (.ipa) URL here
                :w3c => true,
        } }

In case you're using capabilities generated using the JSON Wire Protocol, then it's recommended to use appium_lib version 10.6.0. Run gem install appium_lib -v 10.6.0 command to install it.

info

Step 6: Execute and Monitor your Tests​

If you are using an iOS app, the cURL command will generate an app URL for the corresponding iOS app and install the same for running the tests. You can either use our sample 🔗 iOS app or upload your own app as discussed earlier.

  • Navigate to the corresponding directory based on your app.
cd ios
  • Execute the following command to run your test on LambdaTest platform:
ruby ios-sample.rb
For Windows Users

In case of Windows, if you get any error message. Please try this method:

  • Navigate to the corresponding directory based on your app.
cd android
  • Refresh the gem bundles through given command
gem uninstall -aIx
  • Re-install the gems required
gem install appium_lib -v 10.6.0
gem install ffi

  • Now try running the corresponding automation script for your app.
ruby android-sample.rb

Your test results would be displayed on the test console (or CLI if you are using terminal/cmd) and on the LambdaTest App Automation Dashboard.

Reference Guides​

Last updated on

Test across 3000+ combinations of browsers, real devices & OS.

Book Demo

Help and Support

Related Articles