Python Demonstration Scripts

This repository contains example scripts and dependencies for running automated Selenium tests on Sauce Labs using Python. You can use these scripts to test your Sauce Labs authentication credentials, setup of your automated testing environment, and try out Sauce Labs features.

Disclaimer

The code in these scripts is provided on an "AS-IS" basis without warranty of any kind, either express or implied, including without limitation any implied warranties of condition, uninterrupted use, merchantability, fitness for a particular purpose, or non-infringement. These scripts are provided for educational and demonstration purposes only, and should not be used in production. Issues regarding these scripts should be submitted through GitHub.

Some examples in this repository, may require a different account tier beyond free trial. Please contact the Sauce Labs Sales Team for support and information.

Prerequisites

In order to complete these exercises you must complete the following prerequisite installation and configuration steps:

• Install Git
• Install python and pip
• Install pipenv (https://github.com/pypa/pipenv#installation)
• (Optional) Install an IDE (PyCharm, Visual Studio Code, Komodo Edit etc.)

Tested with: Python 3.14. Code targets Python 3; if you use a different Python 3.x version you may need to update dependencies.

Running Tests on Sauce Labs

The main purpose of this repository is to show how Sauce Labs works with sample Python tests. We have included some samples of using Sauce Labs with some common Python test tools. In particular, we have examples using

• Pytest
• robotframework
• Playwright

and these cover using

• Desktop Web browsers on Sauce virtual devices,
• Mobile Web browsers on Sauce emulators/simulators, and
• Real devices to test native mobile apps.

These samples are executed using Pipenv for simplicity. Each test suite has its own Pipfile in its own directory, so dependencies and CI triggers stay scoped to just that suite instead of one shared repo-wide dependency file. To run a suite: cd into its directory, run pipenv install, then pipenv run <script-name>.

Available Pipenv scripts

Below are the scripts defined in each suite's own Pipfile, grouped by directory. cd into the listed directory first, then run pipenv run <script-name>.

• best_practice/desktop_web/

  • best-practice-desktop-us — runs desktop best-practice tests against the US data center
  • best-practice-desktop-eu — runs desktop best-practice tests against the EU data center

• best_practice/mobile_web/

  • best-practice-mobile-web-vdc-us — runs mobile web tests on virtual devices (VDC) in US
  • best-practice-mobile-web-vdc-eu — runs mobile web tests on virtual devices (VDC) in EU
  • best-practice-mobile-web-rdc-us — runs mobile web tests on real devices (RDC) in US
  • best-practice-mobile-web-rdc-eu — runs mobile web tests on real devices (RDC) in EU

• best_practice/mobile_native/

  • best-practice-mobile-native-us-android — runs native Android tests in US
  • best-practice-mobile-native-eu-android — runs native Android tests in EU
  • best-practice-mobile-native-us-ios — runs native iOS tests in US
  • best-practice-mobile-native-eu-ios — runs native iOS tests in EU

• examples/selenium/

  • demo — runs the Selenium examples

• examples/playwright/

  • playwright-tests — runs the Playwright examples

• examples/robotframework/desktop_web/

  • robot-desktop-web-us — runs desktop web robot tests against US datacenter
  • robot-desktop-web-eu — runs desktop web robot tests against EU datacenter

• examples/robotframework/native_mobile/

  • robot-android-us — runs native Android robot tests against US datacenter
  • robot-android-eu — runs native Android robot tests against EU datacenter
  • robot-ios-us — runs native iOS robot tests against US datacenter
  • robot-ios-eu — runs native iOS robot tests against EU datacenter

Notes:

• VDC = virtual device cloud (emulator/simulator). Use the vdc scripts for emulator-based testing. RDC = real device cloud (real devices) — use the rdc scripts for real-device runs.
• The --dc argument used in pytest scripts sets the Sauce Labs data center (us/eu) and is consumed by the tests via fixtures.
• Some robotframework scripts use pabot and pass DATA_CENTER variables so the tests point to the correct Sauce endpoint.

This repository is divided into two main sections: best_practice and examples.

We also recommend Pytest overall as a Python test framework and runner.

Contributing

Pull requests are welcome! If you see something you'd like to add, please open a PR. This could include

• more test cases,
• using a particular Sauce feature that is not seen here,
• bugfixes, or
• anything else that looks like it belongs