---
title: PyTest Selenium testing with TestingBot
description: Examples on how to use PyTest to do Selenium & Appium testing on various
  browsers and devices.
source_url:
  html: https://testingbot.com/support/web-automate/selenium/python/pytest
  md: https://testingbot.com/support/web-automate/selenium/python/pytest/index.md
---
# PyTest Automated Testing

See our [PyTest Selenium Example](https://github.com/testingbot/Python-PyTest-Selenium) for a simple example on how to run PyTest tests on TestingBot.

Let's start with making sure Python is available on your system.

**For Windows:**
- Download the latest Python installer for Windows: [Python Releases for Windows](https://www.python.org/downloads/windows/)
- Run the installer and follow the setup wizard to install Python. 

**For Linux/macOS:**
- Run `python3 --version` to see which Python version is currently installed. Make sure it is Python 3.8 or above. 
- macOS and most Linux distros come with Python pre-installed. You may need to install `python3` separately on some systems. 

## Installation

Install `pytest` and `selenium`:

    pip install pytest selenium

You are now ready to start testing with our Selenium grid.

### Setup credentials

Set your TestingBot credentials as environment variables. The fixture below reads them when constructing the remote driver:

    export TESTINGBOT_KEY=API_KEY
    export TESTINGBOT_SECRET=API_SECRET

### conftest.py

Create a `conftest.py` file that defines a `driver` fixture pointing at the TestingBot grid:

    import os
    import pytest
    from selenium import webdriver
    
    
    @pytest.fixture
    def driver(request):
        options = webdriver.ChromeOptions()
        options.browser_version = 'latest'
        options.platform_name = 'WIN11'
        options.set_capability('tb:options', {
            'key': os.environ['TESTINGBOT_KEY'],
            'secret': os.environ['TESTINGBOT_SECRET'],
            'name': request.node.name,
        })
    
        driver = webdriver.Remote(
            command_executor='https://hub.testingbot.com/wd/hub',
            options=options,
        )
    
        yield driver
        driver.quit()

### Example code

Save the example in a file called `test_sample.py`. (Important: the filename should start with `test_`)

    def test_sample(driver):
        driver.get('https://google.com/ncr')
        assert "Google" == driver.title

Run the test:

    pytest test_sample.py

This will run the test on the latest version of Chrome on Windows 11. Update the capabilities in the fixture (or parametrize the fixture) to target other browsers and platforms.

### Configuring capabilities

To run your existing tests on TestingBot, your tests will need to be configured to use the TestingBot remote machines. If the test was running on your local machine or network, you can simply change your existing test like this:

**Before:**

    driver = webdriver.Chrome()

**After:**

    driver = webdriver.Remote(
        command_executor='https://hub.testingbot.com/wd/hub',
        options=options,
    )

## Specify Browsers & Devices

To let TestingBot know on which browser/platform/device you want to run your test on, you need to specify the browsername, version, OS and other optional options in the capabilities field.

  ![OS selected](https://testingbot.com/assets/environments/svg/windows11-0e1b28bc0fdd5034d3e4d3dc8d346c500a8c6522facf4b45d0da56537c1f1c6d.svg) Windows 11 › ![Browser Selected](https://testingbot.com/assets/environments/svg/chrome-c4081ff447d2d898d4afcb8f074a907c960e6f007716c1a1d119eee6803c4042.svg) Chrome 139 

Loading environments...

Please wait while we load the available browsers and platforms.

    

## Testing Internal Websites

We've built [TestingBot Tunnel](https://testingbot.com/support/tunnel), to provide you with a secure way to run tests against your staged/internal webapps.  
Please see our [TestingBot Tunnel documentation](https://testingbot.com/support/tunnel) for more information about this easy to use tunneling solution.

The example below shows how to easily run a PyTest WebDriver test with our Tunnel:

1. [Download our tunnel](https://testingbot.com/support/tunnel) and start the tunnel:

    java -jar testingbot-tunnel.jar key secret -i pyTunnel

2. In your `conftest.py` fixture, point the driver at the local tunnel and set `tunnelIdentifier` inside `tb:options`:

    options.set_capability('tb:options', {
        'key': os.environ['TESTINGBOT_KEY'],
        'secret': os.environ['TESTINGBOT_SECRET'],
        'tunnelIdentifier': 'pyTunnel',
    })
    
    driver = webdriver.Remote(
        command_executor='http://localhost:4445/wd/hub',
        options=options,
    )

## Run tests in Parallel

Parallel Testing means running the same test, or multiple tests, simultaneously. This greatly reduces your total testing time.

You can run the same tests on all different browser configurations or run different tests all on the same browser configuration.   
 TestingBot has a large grid of machines and browsers, which means you can use our service to do efficient parallel testing. It is one of the key features we provide to greatly cut down on your total testing time.

You can use pytest-xdist's `-n` option to run multiple tests at the same time:

    pip install pytest-xdist

    pytest -n 4 test_sample.py

### Queuing

Every plan we provide comes with a limit of parallel tests.   
 If you exceed the number of parallel tests assigned to your account, TestingBot will queue the additional tests (for up to 6 minutes) and run the tests as soon as slots become available.

## Mark tests as passed/failed

As TestingBot has no way to determine whether your test passed or failed (it is determined by your business logic), we offer a way to send the test status back to TestingBot. This is useful if you want to see if a test succeeded or failed from the TestingBot member area.

You can use our [Python API client](https://github.com/testingbot/testingbotclient) to report back test results. Install it with `pip install testingbotclient`:

    from testingbotclient import TestingBotClient
    
    client = TestingBotClient('API_KEY', 'API_SECRET')
    client.tests.update_test(
        driver.session_id,
        name='My Test',
        passed=True,
        build='build-123'
    )

## Other Python Framework examples

- [PyTest](https://testingbot.com/support/web-automate/selenium/python/pytest)

PyTest makes it easy to run Selenium tests with Python.

- [Behave](https://testingbot.com/support/web-automate/selenium/python/behave)

Behave is behaviour-driven development, Python style.

- [Lettuce](https://testingbot.com/support/web-automate/selenium/python/lettuce)

Lettuce is a Python BDD plugin based on Ruby's Cucumber, offering Gherkin stories.

- [PyUnit](https://testingbot.com/support/web-automate/selenium/python/pyunit)

PyUnit is the standard unit testing framework module for Python, described as a Python version of JUnit.

- [Helium](https://testingbot.com/support/web-automate/selenium/python/helium)

Helium is a tool that makes it easy to test websites and automate browsers.

- [Pylenium](https://testingbot.com/support/web-automate/selenium/python/pylenium)

Pylenium brings the best of Selenium, Cypress and Python into one package.

- [Robot Framework](https://testingbot.com/support/web-automate/selenium/robotframework)

Robot Framework is a generic automation framework for acceptance testing.

### Looking for more help?

Have questions or need more information? Reach out via email or Slack.

[Email us](https://testingbot.com/contact/new)[Slack Join our Slack](https://join.slack.com/t/testingb0t/shared_invite/zt-3bcw9xch-jk19~6XPs_xBrsAgAedkCw)