Skip to main content

Pytest With Appium

Tutorial To Run Your First Test On LambdaTest​

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

Objective​

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

  1. Set up an environment for testing your Apps using Pytest 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

Pre-requisites​

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.
  • Install pytest on your system with following pip command:
pip install pytest

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​

  1. Clone the LambdaTest’s LT-appium-python and navigate to the code directory as shown below:
git clone https://github.com/LambdaTest/LT-appium-python-pytest
cd LT-appium-python-pytest

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. Ensure to update the APP_URL, username and accesKey in the code scripts before running the tests.

ios.py
from os import environ
import pytest
from appium import webdriver

@pytest.fixture(scope='function')
def test_setup_ios(request):
    test_name = request.node.name
    build = environ.get('BUILD', "Pytest IOS Sample")
    caps = {}
    caps["deviceName"] = "iPhone 11"
    caps["platformName"] = "iOS"
    caps["platformVersion"] = "14"
    caps["app"] = "lt://proverbial-ios"     #Enter the app (.ipa) url here
    caps["isRealMobile"] = True
    caps['build'] = build
    caps['name'] = test_name
    caps['project'] = project_name
    driver = webdriver.Remote("https://<username>:<accessKey>@mobile-hub.lambdatest.com/wd/hub", caps)   #Add LambdaTest username and accessKey here
    request.cls.driver = driver
    
    yield driver
    
    def fin():
        #browser.execute_script("lambda-status=".format(str(not request.node.rep_call.failed if "passed" else "failed").lower()))
        if request.node.rep_call.failed:
            driver.execute_script('lambda-status=failed')
        else:
            driver.execute_script('lambda-status=passed')
        driver.quit()
    request.addfinalizer(fin)
    
@pytest.hookimpl(tryfirst=True, hookwrapper=True)
def pytest_runtest_makereport(item, call):
    # this sets the result as a test attribute for LambdaTest reporting.
    # execute all other hooks to obtain the report object
    outcome = yield
    rep = outcome.get_result()

    # set an report attribute for each phase of a call, which can
    # be "setup", "call", "teardown"
    setattr(item, "rep_" + rep.when, rep)

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. The capabilities object in the sample code are defined as:

iOS(.ipa)
   caps = {
      "deviceName": "iPhone 11",
      "platformName": "iOS",
      "platformVersion": "14",
      "app": "lt://proverbial-ios"     # Enter the app (.ipa) URL here,
      "isRealMobile": True,
      "build": build,
      "name": test_name,
      "project": project_name
   }
Note

5. Execute your test case​

  1. Install the required packages from the cloned project directory:
pip install -r requirements.txt
  1. Run the following command in the directory where your project has been saved to execute your build.
pytest test_ios.py
tip

If you are unable to run the automation script with the above mentioned commands try using python -m before the given commands.

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