Skip to main content

Cucumber With Appium

Tutorial To Run Your First Test On LambdaTest

This article will guide you in getting started with configuring and running your Ruby:Cucumber-based Appium automation test scripts on the LambdaTest Real Device Cloud Platform.


  1. Set up an environment for testing your Apps using Cucumber with Appium.
  2. Understand and configure the core capabilities required for your Appium test suite.
  3. Explore the 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


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 "" -F "appFile=@"/Users/macuser/Downloads/proverbial_android.apk"" -F "name="proverbial_app""

Using App URL:

curl -u "undefined:undefined" -X POST "" -F "url=:" -F "name=Proverbial_App"
  • 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_Ruby_Appium and navigate to the code directory as shown below:

git clone
cd LT-appium-ruby-cucumber

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

The file first_steps.rb defines the script that the test should follow:

When /^I click on buttons app$/ do 

$driver.find_element(:id, "color").click
#Click on Color Button
$driver.find_element(:id, "color").click
#Click on Geolocation Button
$driver.find_element(:id, "geoLocation").click
#wait of 5 seconds
#Click on back Button
#Click on text Button to enter value
$driver.find_element(:id, "Text").click
#Click on Notification Button
$driver.find_element(:id, "notification").click
#Click on toast Button
$driver.find_element(:id, "toast").click
#Click on speedtest Button
$driver.find_element(:id, "speedTest").click
#Wait for 10 seconds
$driver.find_element(:id, "Browser").click
$driver.find_element(:id, "url").click
$driver.find_element(:id, "url").send_keys ""
$driver.find_element(:id, "find").click


Configuring Your Test Capabilities

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.

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:

first.config.yml iOS
server: ""
user: "LT_USERNAME" # Add Lambdatest username here
key: "LT_ACCESS_KEY" # Add Lambdtest accessKey here


"build": "br-2"

"isRealMobile": "true"
"platform": "ios"
"deviceName": "iPad (2017)"
"platformVersion": "13"
"app": "APP_URL" # Add your app url here

Executing The Tests

  1. Navigate to the run_first_test directory under corresponding os based on your app.
  1. Go to config/first.config.yml and edit the username, accessKey and add your app url.

  2. Run the following commands to run your tests

bundle install
bundle exec rake first

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.