Ruby With Appium

Blog   ⋅   Docs   ⋅   Learning Hub   ⋅   Newsletter   ⋅   Certifications   ⋅   YouTube

Appium is a tool for automating native, mobile web, and hybrid applications on iOS, Android, and Windows platforms. It supports iOS native apps written in Objective-C or Swift and Android native apps written in Java or Kotlin. It also supports mobile web apps accessed using a mobile browser (Appium supports Safari on iOS and Chrome or the built-in 'Browser' app on Android). Perform Appium automation tests on LambdaTest's online cloud.

Learn the basics of Appium testing on the LambdaTest platform.

Table of Contents

• Pre-requisites
• Setting Up Your Authentication
• Upload Your Application
• Run Your First Test
• Executing The Tests
• Troubleshooting
• About LambdaTest

---

Pre-requisites

Before you can start performing Ruby automation testing with Appium, you would need to:

1. Install Ruby: Ensure you have Ruby 3.4+ installed.

   • For Windows, download from RubyInstaller.
   • For macOS, run brew install ruby.
   • For Linux or Ubuntu, you can run a simple apt command like below: sudo apt-get install ruby-full

2. Clone The Sample Project:

git clone [https://github.com/Priya2224/LT-appium-ruby.git](https://github.com/Priya2224/LT-appium-ruby.git)
cd LT-appium-ruby

Setting Up Your Authentication

Make sure you have your LambdaTest credentials with you to run test automation scripts. To obtain your access credentials, purchase a plan or access the access the App Automation Dashboard

Set LambdaTest Username and Access Key in environment variables.

For Linux/macOS:

export LT_USERNAME=YOUR_LAMBDATEST_USERNAME
export LT_ACCESS_KEY=YOUR_LAMBDATEST_ACCESS_KEY

For Windows:

set LT_USERNAME=YOUR_LAMBDATEST_USERNAME
set LT_ACCESS_KEY=YOUR_LAMBDATEST_ACCESS_KEY

Upload Your Application

Upload your iOS application (.ipa file) or android application (.apk 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. Here is an example cURL request to upload your app using our REST API:

Using App File:

For Linux/macOS:

curl -u "YOUR_LAMBDATEST_USERNAME:YOUR_LAMBDATEST_ACCESS_KEY" \
--location --request POST 'https://manual-api.lambdatest.com/app/upload/realDevice' \
--form 'name="Android_App"' \
--form 'appFile=@"/Users/macuser/Downloads/proverbial_android.apk"'

For Windows:

curl -u "USER:KEY" -X POST "https://manual-api.lambdatest.com/app/upload/realDevice" -F "appFile=@"C:/path/to/proverbial_android.apk""

Using App URL:

For Linux/macOS:

curl -u "YOUR_LAMBDATEST_USERNAME:YOUR_LAMBDATEST_ACCESS_KEY" \
--location --request POST 'https://manual-api.lambdatest.com/app/upload/realDevice' \
--form 'name="Android_App"' \
--form 'url="https://prod-mobile-artefacts.lambdatest.com/assets/docs/proverbial_android.apk"'

For Windows:

curl -u "YOUR_LAMBDATEST_USERNAME:YOUR_LAMBDATEST_ACCESS_KEY" -X POST "https://manual-api.lambdatest.com/app/upload/realDevice" -d "{"url":"https://prod-mobile-artefacts.lambdatest.com/assets/docs/proverbial_android.apk","name":"sample.apk"}"

Tip:

1. If you do not have any .apk or .ipa file, you can run your sample tests on LambdaTest by using our sample 🔗 Android App or sample 🔗 iOS App.
2. 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.

Run Your First Test

Once you are done with the above-mentioned steps, you can initiate your first Ruby test on LambdaTest.

Test Scenario: Check out Android.rb file to view the sample test script for android and iOS.rb for iOS.

Configuring Your Test Capabilities (Ruby 3.4/W3C Fix)

Update the caps object in your scripts. For Ruby 3.4, keys must be Symbols.

Android Configuration

caps = {
  "lt:options" => {
    :deviceName => "Galaxy S24",
    :platformName => "Android",
    :platformVersion => "14",
    :isRealMobile => true,
    :app => "YOUR_APP_URL",
    :w3c => true
  },
  :platformName => "Android"
}

iOS Configuration

caps = {
  "lt:options" => {
    :deviceName => "iPhone 17 Pro",
    :platformName => "iOS",
    :platformVersion => "26",
    :isRealMobile => true,
    :app => "YOUR_APP_URL",
    :w3c => true
  },
  :platformName => "iOS"
}

Info Note:

1. You must add the generated APP_URL to the "app" capability in the config file.
2. You can generate capabilities for your test requirements with the help of our inbuilt Capabilities Generator tool. A more Detailed Capability Guide is available here.

Executing The Tests

1. Install dependencies:

bundle install

2. Run the scripts:

Running on Android

Navigate to the corresponding directory based on your app.

cd android

Execute the following command to run your test on LambdaTest platform:

ruby android-sample.rb

Running on iOS

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

Note: Ensure you have updated the YOUR_APP_URL in each respective file before running these commands. Your test results will be displayed on the terminal and can also be viewed in detail on the App Automation Dashboard.

Troubleshooting

1. Ruby 3.4 ArgumentError (String to Symbol)

   If you encounter an ArgumentError stating "String cannot be converted to Symbol," it is because Ruby 3.4 requires explicit symbols for the driver initialization keys. Update your initialization to include the :caps and :appium_lib symbols exactly as shown below:

@appium_driver = Appium::Driver.new({
  :caps => caps,
  :appium_lib => { :server_url => server_url }
}, true)

2. Gem Installation Issues

   If you encounter an error like No such file or directory @ rb_sysopen during gem installation, you can resolve it by using administrator privileges or ensuring the directory exists:

   • macOS/Linux: Use sudo gem install appium_lib -v 10.6.0.

   • Windows: Open Command Prompt as Administrator and run gem install appium_lib -v 10.6.0.

3. W3C Protocol Compatibility

   Ensure your capabilities object includes the :w3c => true option and wraps custom LambdaTest options inside the "lt:options" key to stay compatible with modern Appium standards.

Additional Links

• Advanced Configuration for Capabilities
• How to test locally hosted apps
• How to integrate LambdaTest with CI/CD

Documentation & Resources 📚

Visit the following links to learn more about LambdaTest's features, setup and tutorials around test automation, mobile app testing, responsive testing, and manual testing.

• LambdaTest Documentation
• LambdaTest Blog
• LambdaTest Learning Hub

LambdaTest Community 👥

The LambdaTest Community allows people to interact with tech enthusiasts. Connect, ask questions, and learn from tech-savvy people. Discuss best practises in web development, testing, and DevOps with professionals from across the globe 🌎

What's New At LambdaTest ❓

To stay updated with the latest features and product add-ons, visit Changelog

About LambdaTest

LambdaTest is a leading test execution and orchestration platform that is fast, reliable, scalable, and secure. It allows users to run both manual and automated testing of web and mobile apps across 3000+ different browsers, operating systems, and real device combinations. Using LambdaTest, businesses can ensure quicker developer feedback and hence achieve faster go to market. Over 500 enterprises and 1 Million + users across 130+ countries rely on LambdaTest for their testing needs.

Features

• Run Selenium, Cypress, Puppeteer, Playwright, and Appium automation tests across 3000+ real desktop and mobile environments.
• Real-time cross browser testing on 3000+ environments.
• Test on Real device cloud
• Blazing fast test automation with HyperExecute
• Accelerate testing, shorten job times and get faster feedback on code changes with Test At Scale.
• Smart Visual Regression Testing on cloud
• 120+ third-party integrations with your favorite tool for CI/CD, Project Management, Codeless Automation, and more.
• Automated Screenshot testing across multiple browsers in a single click.
• Local testing of web and mobile apps.
• Online Accessibility Testing across 3000+ desktop and mobile browsers, browser versions, and operating systems.
• Geolocation testing of web and mobile apps across 53+ countries.
• LT Browser - for responsive testing across 50+ pre-installed mobile, tablets, desktop, and laptop viewports

We are here to help you 🎧

• Got a query? we are available 24x7 to help. Contact Us
• For more info, visit - LambdaTest