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.

Include Page
_sauce description_sauce description
 This tutorial will show you how to get started with testing with Python on Sauce. 

Include Page

Table of Contents


Include Page


Include Page


The implicitly wait method tells the browser to wait a set amount of time (in seconds) for elements to appear on the page before giving up. Without it, slow loading DOMs could cause our tests to fail when they might otherwise pass. Using implicit 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.


Running the Example Code

  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 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 Tests Against Local Applications

If your test application is not publicly available, you will need to use Sauce Connect so that Sauce can reach it. 

Sauce Connect is a tunneling app that allows you to execute tests securely when testing behind firewalls or on localhost. For more detailed information, please visit see the Sauce Connect docs

Reporting to the Sauce Labs Dashboard


Running Tests in Parallel

Include Page_running_tests_in_parallel_running_tests_in_parallelSee 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 


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/