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.
Objective
- Set up an environment for testing your Apps using Cucumber with Appium.
- Understand and configure the core capabilities required for your Appium test suite.
- Explore the advanced features of LambdaTest.
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. 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.
- MacOS
- Linux
- Windows
For macOS, you can run a Homebrew command like this:
brew install ruby
For Linux or Ubuntu, you can run a simple apt command like below:
sudo apt-get install ruby-full
For Windows, you can download from the official website.
- 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"
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 https://github.com/LambdaTest/LT-appium-ruby-cucumber
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.
- Linux / MacOS
- Windows
export LT_USERNAME=undefined \
export LT_ACCESS_KEY=undefined
set LT_USERNAME=undefined `
set LT_ACCESS_KEY=undefined
4. Write your automation script
The file first_steps.rb
defines the script that the test should follow:
- iOS
- Android
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
sleep(5)
#Click on back Button
$driver.back
#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
sleep(10)
$driver.back
$driver.find_element(:id, "Browser").click
sleep(5)
$driver.find_element(:id, "url").click
$driver.find_element(:id, "url").send_keys "https://www.lambdatest.com/"
$driver.find_element(:id, "find").click
sleep(5)
$driver.back
$driver.execute_script("lambda-status=passed")
end
When /^I click on buttons app$/ do
$driver.find_element(:id, "com.lambdatest.proverbial:id/color").click
#Click on Color Button
$driver.find_element(:id, "com.lambdatest.proverbial:id/color").click
#Click on Geolocation Button
$driver.find_element(:id, "com.lambdatest.proverbial:id/geoLocation").click
#wait of 5 seconds
sleep(5)
#Click on back Button
$driver.back
#Click on text Button to enter value
$driver.find_element(:id, "com.lambdatest.proverbial:id/Text").click
#Click on Notification Button
$driver.find_element(:id, "com.lambdatest.proverbial:id/notification").click
#Click on toast Button
$driver.find_element(:id, "com.lambdatest.proverbial:id/toast").click
#Click on speedtest Button
$driver.find_element(:id, "com.lambdatest.proverbial:id/speedTest").click
#Wait for 10 seconds
sleep(10)
$driver.back
$driver.execute_script("lambda-status=passed")
end
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:
- iOS
- Android
server: "mobile-hub.lambdatest.com"
user: "LT_USERNAME" # Add Lambdatest username here
key: "LT_ACCESS_KEY" # Add Lambdtest accessKey here
common_caps:
"build": "br-2"
browser_caps:
-
"isRealMobile": "true"
"platform": "ios"
"deviceName": "iPad (2017)"
"platformVersion": "13"
"app": "APP_URL" # Add your app url here
server: "mobile-hub.lambdatest.com"
user: "LT_USERNAME" # Add Lambdatest username here
key: "LT_ACCESS_KEY" # Add Lambdtest accessKey here
common_caps:
"build": "br-1"
browser_caps:
-
"isRealMobile": "true"
"platform": "android"
"deviceName": "Galaxy S21 5G"
"platformVersion": "11"
"app": "APP_URL" # Add your app url here
- You must add the generated APP_URL to the
"app"
capability in the config file. - You can generate capabilities for your test requirements with the help of our inbuilt Capabilities Generator tool.For more details, please refer to our guide on Desired Capabilities in Appium.
Executing The Tests
- Navigate to the
run_first_test
directory under corresponding os based on your app.
Go to
config/first.config.yml
and edit theusername
,accessKey
and add yourapp url
.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.