Skip to main content

Gauge With Appium

Tutorial To Run Your First Test On LambdaTest

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


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

  1. Set up an environment for testing your Apps using Gauge 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 App automation testing with Appium, you would need to follow these steps:

  • 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 the latest Python build from the official website. We recommend using the latest version.
  • Make sure pip is installed in your system. You can install pip from pip documentation.

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

  1. Clone the LambdaTest’s LT-appium-python-gauge and navigate to the code directory as shown below:
git clone
cd LT-appium-python-gauge

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 below.
from sqlite3 import Time
from appium.webdriver.common.mobileby import MobileBy
from import WebDriverWait
from import expected_conditions as EC
from getgauge.python import step
from step_impl.utils.driver import Driver

@step("changes color to pink")
def change_color():
colorElement = WebDriverWait(Driver.driver, 20).until(EC.element_to_be_clickable(
(MobileBy.ID, "com.lambdatest.proverbial:id/color")))

@step("changes the text to Proverbial")
def chnage_text():
textElement = WebDriverWait(Driver.driver, 20).until(
EC.element_to_be_clickable((MobileBy.ID, "com.lambdatest.proverbial:id/Text")))

@step("toast will be visible")
def toast_visible():
toastElement = WebDriverWait(Driver.driver, 20).until(EC.element_to_be_clickable(
(MobileBy.ID, "com.lambdatest.proverbial:id/toast")))

@step("notification will be visible")
def notification():
notification = WebDriverWait(Driver.driver, 20).until(EC.element_to_be_clickable(
(MobileBy.ID, "com.lambdatest.proverbial:id/notification")))

@step("perform the speed test")
def speedTest():
speedTest = WebDriverWait(Driver.driver, 20).until(EC.element_to_be_clickable(
(MobileBy.ID, "com.lambdatest.proverbial:id/speedTest")))

@step("back to home")
def home():
home = WebDriverWait(Driver.driver, 20).until(EC.element_to_be_clickable(
(MobileBy.ID, "com.lambdatest.proverbial:id/buttonPage")))

Configure the test capabilities

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.Ensure to update the APP_URL, username and accessKey in the code scripts before running the tests. The capabilities object in the sample code are defined as:
        caps['name'] = 'Gauge Sample Test'
caps['build'] = 'Python_Gauge_LambdaTest'
caps['isRealMobile'] = 'true'
caps['platformVersion'] = '11'
caps['platform'] = 'Android'
caps['deviceName'] = 'Galaxy S21 Ultra 5G'
caps['app'] = 'APP_URL' #add app url here

5. Execute your test case

  1. Install the required packages from the cloned project directory:
pip install -r requirements.txt
npm install -g @getgauge/cli
  1. Run the following command in the directory where your project has been saved to execute your build.
gauge run specs

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.