Appium with Rspec
In this documentation, you will learn how to trigger a automation script of Rspec 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.
- 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
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.
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
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.
- Linux / MacOS
- Windows
export LT_USERNAME="undefined"
export LT_ACCESS_KEY="undefined"
set LT_USERNAME="undefined"
set 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:
- App File
- App URL
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""
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 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.
- Single Test
- Parallel test
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
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 Parallel"
"visual": false
"network": false
"console": false
app_caps:
-
"isRealMobile": "true"
"platform": "Android"
"deviceName": "Galaxy A31"
"platformVersion": "10"
"app": "APP_URL" #Add the app url here
-
"isRealMobile": "true"
"platform": "Android"
"deviceName": "Galaxy A32"
"platformVersion": "11"
"app": "APP_URL" #Add the app url here
-
"isRealMobile": "true"
"platform": "iOS"
"deviceName": "iPhone 13 Pro"
"platformVersion": "15.0"
"app": "APP_URL" #Add the app url here
Step 5: 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
}},
- 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.
Step 6: Execute and Monitor your Tests
- Run the following command to make sure that all the dependencies required for the test are installed.
bundle install
- 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
. 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.