Skip to main content

PyUnit Automated Testing

See our PyUnit example repository for a simple example on how to run PyUnit 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
  • 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

First, make sure you have installed the correct Python packages:

pip install selenium
pip install testingbotclient

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

Example code

import unittest
from selenium import webdriver
from selenium.webdriver.chrome.options import Options as ChromeOptions
from testingbotclient import TestingBotClient

class TestGoogleSearch(unittest.TestCase):

    def setUp(self):
        options = ChromeOptions()
        options.set_capability('platformName', 'WIN11')
        options.set_capability('browserVersion', 'latest')
        options.set_capability('tb:options', {
            'key': 'API_KEY',
            'secret': 'API_SECRET',
            'name': 'Testing Selenium with PyUnit'
        })

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

    def test_google(self):
        self.driver.get('https://www.google.com')
        self.assertIn("Google", self.driver.title)

    def tearDown(self):
        status = self._outcome.success
        tb_client = TestingBotClient(
            'API_KEY',
            'API_SECRET'
        )
        tb_client.tests.update_test(self.driver.session_id, passed=status)
        self.driver.quit()

if __name__ == '__main__':
    unittest.main()

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.Firefox()
After:
from selenium import webdriver
from selenium.webdriver.chrome.options import Options as ChromeOptions

options = ChromeOptions()
options.set_capability('platformName', 'WIN11')
options.set_capability('browserVersion', 'latest')
options.set_capability('tb:options', {
    'key': 'API_KEY',
    'secret': 'API_SECRET'
})

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.

Testing Internal Websites

We've built TestingBot Tunnel, to provide you with a secure way to run tests against your staged/internal webapps.
Please see our TestingBot Tunnel documentation for more information about this easy to use tunneling solution.

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

1. Download our tunnel and start the tunnel:

java -jar testingbot-tunnel.jar key secret

2. Adjust your test: instead of pointing to 'hub.testingbot.com/wd/hub' like the example above - change it to point to your tunnel's IP address.
Assuming you run the tunnel on the same machine you run your tests, change to 'localhost:4445/wd/hub'. localhost is the machine running the tunnel, 4445 is the default port of the tunnel.

This way your test will go securely through the tunnel to TestingBot and back:

import unittest
from selenium import webdriver
from selenium.webdriver.chrome.options import Options as ChromeOptions
from testingbotclient import TestingBotClient

class TestGoogleSearch(unittest.TestCase):

    def setUp(self):
        options = ChromeOptions()
        options.set_capability('platformName', 'WIN11')
        options.set_capability('browserVersion', 'latest')
        options.set_capability('tb:options', {
            'key': 'API_KEY',
            'secret': 'API_SECRET',
            'name': 'Testing Selenium with PyUnit'
        })

        # Point to the tunnel running on localhost:4445
        self.driver = webdriver.Remote(
            command_executor='http://localhost:4445/wd/hub',
            options=options
        )
        self.driver.implicitly_wait(30)

    def test_google(self):
        self.driver.get('https://www.google.com')
        self.assertIn("Google", self.driver.title)

    def tearDown(self):
        status = self._outcome.success
        tb_client = TestingBotClient(
            'API_KEY',
            'API_SECRET'
        )
        tb_client.tests.update_test(self.driver.session_id, passed=status)
        self.driver.quit()

if __name__ == '__main__':
    unittest.main()

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.

To run tests in parallel, we recommend using pytest with pytest-xdist, which makes it very easy to run multiple Python tests simultaneously:

pip install pytest pytest-xdist
pytest -n 4  # run tests on 4 parallel workers

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 to report back test results.

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

    PyTest makes it easy to run Selenium tests with Python.

  • Behave

    Behave is behaviour-driven development, Python style.

  • Lettuce

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

  • PyUnit

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

  • Helium

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

  • Pylenium

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

  • SeleniumBase

    SeleniumBase is a Python package that simplifies Selenium testing.

  • Robot Framework

    Robot Framework is a generic automation framework for acceptance testing.

Was this page helpful?

Looking for More Help?

Have questions or need more information?
You can reach us via the following channels: