Skip to main content

Rspec With Appium

Tutorial To Run Your First Test On LambdaTest​

In this topic, you will learn how to configure and run your Rspec automation testing scripts with Appium on LambdaTest Real Device Cloud platform.

Objective​

By the end of this topic, you will be able to:

  1. Run a sample automation script of Rspec for application testing with Appium on LambdaTest.
  2. Learn more about Desired Capabilities for Appium testing.
  3. Explore advanced features of LambdaTest.
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

Pre-requisites​

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

  • You have access to LambdaTest username and accessKey. If you have not registered yet, you can do the same by visiting our website. You will be able to access the credentials in the LambdaTest Profile
  • 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
  • Ensure you have Dependency manager bundler installed. If not installed, you can install with the following command:
gem install bundler

Run your first test​

1. 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 from System:

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""

Using App URL:

curl -u "undefined:undefined" -X POST "https://manual-api.lambdatest.com/app/upload/realDevice" -F "url=:https://prod-mobile-artefacts.lambdatest.com/assets/docs/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 🔗 Android app or sample 🔗 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.

2. Clone the sample project​

Clone the LambdaTest’s 🔗 LT-appium-ruby-rspec repository:

git clone https://github.com/LambdaTest/LT-appium-ruby-rspec
cd LT-appium-ruby-rspec

3. Set up your authentication​

Make sure you have your LambdaTest credentials with you to run test automation scripts on LambdaTest. To obtain your access credentials, purchase a plan or access the Automation Dashboard. Then, set LambdaTest Username and Access Key in environment variables with following commands.

export LT_USERNAME=undefined \
export LT_ACCESS_KEY=undefined

4. Write your automation script​

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

single.config.yml
server: "mobile-hub.lambdatest.com"
user: "LT_USERNAME"         #Add your LambdaTest username here
key: "LT_ACCESS_KEY"  #Add your LambdaTest accessKey here

common_caps:
  "build": "RSpec Selenium Demo"

browser_caps:
  -
    "isRealMobile": "true"
    "platform": "Android"
    "deviceName": "Galaxy A31"
    "platformVersion": "10"
    "app": "APP_URL"        #Add the app url here

Configure the test capabilities​

You can update your custom capabilities in test scripts lambdatest.rb. 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:

    caps={ 
  
      "LT:Options" => {

   
    "build" => "Ruby RSpec",
    "name" => "Sample Test",
    "platformName" => platform,
    "isRealMobile" => isRealMobile,
    "deviceName" => deviceName,
    "platformVersion" => platformVersion,
    "app" => app,
    "w3c" => true
    },
Note

5. Execute your test case​

  1. Run the following command to make sure that all the dependencies required for the test are installed.
bundle install
  1. Execute the following command to run single test on LambdaTest platform:
bundle exec rake single

In order to run parallel tests, run bundle exec rake parallel.

info

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

Last updated on