Skip to main content

Pylenium

Pylenium is a Python package, its mission: "Bring the best of Selenium, Cypress and Python into one package."

To get started, please make sure you have python3 installed. Then install the package and scaffold the project:

pip install pyleniumio
pylenium init

pylenium init creates a pylenium.json config file and a conftest.py in your project.

Example test

Pylenium tests use the py fixture that ships with the package. Save the example as test_sample.py:

def test_sample(py):
    py.visit("https://www.google.com")
    py.get("[name='q']").type("TestingBot")
    assert "Google" in py.title

Run it with pytest:

pytest test_sample.py

Specify Browsers & Devices

Point Pylenium at the TestingBot grid by editing pylenium.json. Set driver.remote_url to the TestingBot hub and put the W3C capabilities under driver.capabilities:

{
  "driver": {
    "browser": "chrome",
    "remote_url": "https://API_KEY:API_SECRET@hub.testingbot.com/wd/hub",
    "capabilities": {
      "browserVersion": "latest",
      "platformName": "WIN11",
      "tb:options": {
        "name": "Pylenium Test"
      }
    }
  }
}

Run the same test command, Pylenium now provisions the browser on TestingBot:

pytest test_sample.py

To use a different browser, version or platform on the fly, override capabilities from the CLI:

pytest --remote_url='https://API_KEY:API_SECRET@hub.testingbot.com/wd/hub'

Pick a browser/version/platform combination below, the snippet shows the JSON fragment to drop under driver.capabilities in pylenium.json.

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 Pylenium Python 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. Point Pylenium at the local tunnel URL in pylenium.json:

{
  "driver": {
    "browser": "chrome",
    "remote_url": "http://localhost:4445/wd/hub",
    "capabilities": {
      "browserVersion": "latest",
      "platformName": "WIN11",
      "tb:options": {
        "name": "Pylenium Tunnel Test"
      }
    }
  }
}

Other Options

We offer many other test options, for example: disable video recording, specifying a custom Firefox Profile, loading Chrome/Firefox/Safari extensions, running an executable before your test starts, uploading files, ...
See our list of test options for a full list of options to customize your tests.

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. Pylenium exposes the underlying Selenium WebDriver via py.webdriver, so the session id is available as py.webdriver.session_id:

from testingbotclient import TestingBotClient


def test_sample(py):
    py.visit("https://www.google.com")
    passed = "Google" in py.title

    client = TestingBotClient('API_KEY', 'API_SECRET')
    client.tests.update_test(
        py.webdriver.session_id,
        name='My Test',
        passed=passed,
        build='build-123'
    )
    assert passed

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.

  • Pylenium

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

  • Helium

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

  • 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: