Skip to main content

pytest plugin for openSTF

Project description

pytest-stf PyPI version

pytest plugin for OpenSTF

Plugin for simplify OpenSTF usage with pytest framework by providing simple fixture that do all primitive tasks for appium based tests.

Target is to easily scale up tests in CI environment where external stf service is used to provide android phones.

Plugin based on stf-appium-python-client

pytest arguments

  --stf_host=STF_HOST   Openstf host
                        Openstf access token
                        Phone requirements
                        Maximum time in seconds after which STF releases allocated devices
                        Appium server API URL
                        Appium capabilities
                        Appium server log file path



  • Session scoped
  • Find and allocate a phone based on --phone_requirements cli argument from STF or using pytest-lockable

NOTE: only one phone is handled by this fixture.


  • Session scoped
  • Depends on allocated_phone
  • Create ADB tunnel to phone if using STF

NOTE: Android SDK (commandline tools, platform tools and build tools) need to be installed separately!


  • Session scoped
  • Depends on phone_with_adb
  • Start Appium server or alternatively use remote one passed via --appium_server cli argument or appium_server lockable resource property

NOTE: appium need to be installed separately! (npm i appium) .


  • Session scoped
  • Depends on appium_server
  • Start Appium webdriver client


  • Session scoped
  • Returns arguments passed to Appium webdriver
  • Tests can override this fixture in order to pass custom arguments


  • Session scoped
  • Returns arguments passed to Appium server
  • Tests can override this fixture in order to pass custom arguments

Usage example

from appium.webdriver.webdriver import WebDriver

def test_create(appium_client):
    client, appium, adb, phone = appium_client
    # device is dictionary of device metadata
    # adb: AdbServer instance, that is already connected
    # appium: AppiumServer instance that provide server address for appium client
    print(f'wd_hub: {appium.get_api_path()}')
    client: WebDriver
    client, *_ = appium_client
    URL = ''
    url = client.current_url
    assert url == URL, 'Wrong URL'


> pytest sample/ --stf_host localhost --stf_token $TOKEN --phone_requirements platform=Android

See more examples from sample/

Custom capabilities:

> pytest --appium_capabilities cab=val1&cab=val2

Usage with local devices

Testing with a local device you can omit --stf_host and --stf_token cli arguments and use lockable resources file (defaults to resources.json).

resources.json example:

    "id": "1",
    "type": "Phone",
    "platform": "Android",
    "online": true,
    "hostname": <HOSTNAME>,
    "version": "12",
    "appium_server": "http://localhost:4723"


> pytest sample/ --phone_requirements platform=Android

NOTE: Appium server need to be run separately! (appium -a

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest-stf-0.5.0.tar.gz (7.9 kB view hashes)

Uploaded source

Built Distribution

pytest_stf-0.5.0-py3-none-any.whl (5.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page