The Sauce Labs Cookbook

Sauce Headless

Front End Performance Testing


External Resources

More Info

Page tree

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.

Sauce Labs is a cloud platform for executing automated and manual mobile and web tests. Sauce Labs supports running automated tests with Selenium WebDriver (for web applications) and Appium (for native and mobile web applications). This topic will provide you with an example of how to get your Python tests up and running on Sauce.

Include Page

Include Page

Table of Contents


Include Page

Code Example

Include Page



The explicit wait method tells the browser to wait a set amount of time (in seconds) for elements to appear on the page before giving up. Using explicit waits is one of our recommended best practices.

Analyzing the Code

If you look at the code closely, you'll see that basics for setting up a test to run on sauce are very straightforward, and really only require two elements.

If you wanted to run Selenium locally, you might initiate a driver for the browser that you want to test on like so:

Code Block
titleRunning a Local Python Test
driver = webdriver.Firefox() 

If you wanted to run on Sauce, you would instead use webdriver.Remote(), and then pass it two paramaters: command_executor, which points to the Sauce cloud and uses your Sauce Labs authentication to log in, and desired_capabilties, which specifies the browsers and operating systems to run the tests against.

Code Block
titleRunning a Python Test Remotely on Sauce
# this is how you set up a test to run on Sauce Labs
desired_cap = {
    'platform': "Mac OS X 10.9",
    'browserName': "chrome",
    'version': "31",
driver = webdriver.Remote(

You can use the Platform Configurator to specify the desired capabilities for any browser/platform combination you want. 

Running the Test

  1. Copy the example code and save it into a file called
    Make sure your username and access key are included in the URL passed through to the command_executor.
  2. Open a command line terminal and navigate to the directory where the file is located.
  3. Execute the test:

    Code Block

    Check your dashboard and you will see that your test has just run on Sauce!

Running Local Tests


Running Tests in Parallel


See the topics under Running Tests in Parallel with Python for more information and examples of setting up popular Python testing frameworks to run tests in parallel on Sauce 

Reporting on Test Results

"Wait," you might be asking, "My test says 'Complete' but what happens if it fails?"

Unfortunately, Sauce has no way to determine whether your test passed or failed automatically, since it is determined entirely by your business logic. You can, however, tell Sauce about the results of our tests automatically using the Sauce python client and adding these lines to your test. 

Code Block
# this authenticates you 
from sauceclient import SauceClient

# this belongs in your test logic, passed=True) 

You should also follow our recommended best practice of adding build numbers, tags, and other identifying information to your tests so you can easily find and manage them in your test results and archives pages



You can clone this script from the saucelabs-training repository on GitHub:


There are examples using both pytest and unittest frameworks, change directories to the relevant module before running your tests:

Testing with a Proxy

If you're trying to run this script from behind a VPN or a corporate proxy, you must use either IPSec or Sauce Connect Proxy. Once you've downloaded and installed the relevant software, add the following capability to the test script:

Code Block
'tunnelIdentifier': '<tunnel_id>',

Running the Test

  1. Navigate to the root project directory and use pip to install the latest Selenium library for use in the script:

    Code Block
    $ pip install -r requirements.txt
  2. Set your Sauce Labs Credentials as envrionment variables, indicated by the following lines in the script:

    View Git file
  3. Depending on which framework you're using, your commands may be different to run the tests. Use any of the following command based on the chosen framework:


    Code Block
    pytest on-boarding-modules/pytest-examples/


    Code Block
     python -m unittest on-boarding-modules/unittest-examples/