---
title: Run Selenium tests with Python and Lettuce BDD
description: Automatically test your website with Python, Selenium WebDriver and Lettuce.
source_url:
  html: https://testingbot.com/support/web-automate/selenium/python/lettuce
  md: https://testingbot.com/support/web-automate/selenium/python/lettuce/index.md
---
# BDD with Python, Lettuce and WebDriver

**Note:** Lettuce is no longer actively maintained. Consider using [Behave](https://testingbot.com/support/web-automate/selenium/python/behave) or [pytest-bdd](https://pytest-bdd.readthedocs.io/) for new projects.

Lettuce is a Python BDD plugin based on Ruby's Cucumber, offering Gherkin stories.   
 To get started, make sure you have installed these packages with `pip`:

    pip install lettuce lettuce_webdriver nose

`lettuce`, `lettuce_webdriver` and `nose` are Python 2 era packages and do not install cleanly on modern Python (3.10+). They require a legacy Python interpreter. For new projects use [Behave](https://testingbot.com/support/web-automate/selenium/python/behave) instead.

You are now ready to create your first story and run it on our Selenium grid.   
 Run the test with:

    lettuce

## Example feature (features/google.feature)

    Feature: Go to google
    
    Scenario: Visit Google
      Given I go to "https://www.google.com/"
      When I fill in field with class "gsfi" with "testingbot"
      Then I should see "testingbot.com" within 2 seconds

## Example steps (features/steps.py)

    from lettuce import *
    from lettuce_webdriver.util import assert_false
    from lettuce_webdriver.util import AssertContextManager
    from selenium.webdriver.common.by import By
    
    def find_field_by_class(browser, attribute):
        xpath = "//input[@class='%s']" % attribute
        elems = browser.find_elements(By.XPATH, xpath)
        return elems[0] if elems else False
    
    @step('I fill in field with class "(.*?)" with "(.*?)"')
    def fill_in_textfield_by_class(step, field_name, value):
        with AssertContextManager(step):
            text_field = find_field_by_class(world.browser, field_name)
            text_field.clear()
            text_field.send_keys(value)

## Example terrain.py

    from lettuce import after, before, world
    from selenium import webdriver
    from selenium.webdriver.firefox.options import Options
    import lettuce_webdriver.webdriver
    
    @before.all
    def setup_browser():
        options = Options()
        options.browser_version = 'latest'
        options.platform_name = 'WIN11'
        options.set_capability('tb:options', {
            'key': 'API_KEY',
            'secret': 'API_SECRET',
            'name': 'Testing Selenium with Lettuce'
        })
    
        world.browser = webdriver.Remote(
            command_executor='https://hub.testingbot.com/wd/hub',
            options=options
        )
    
    @after.all
    def teardown_browser(total):
        world.browser.quit()

## 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.webdriver.firefox.options import Options
    
    options = Options()
    # set capabilities from picker below
    
    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 Lettuce Python test with our Tunnel:

1. [Download our tunnel](https://testingbot.com/support/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:

### Example terrain.py

    from lettuce import before, world
    from selenium import webdriver
    from selenium.webdriver.firefox.options import Options
    import lettuce_webdriver.webdriver
    
    @before.all
    def setup_browser():
        options = Options()
        options.browser_version = 'latest'
        options.platform_name = 'WIN10'
        options.set_capability('tb:options', {
            'key': 'API_KEY',
            'secret': 'API_SECRET',
            'name': 'Testing Selenium with Lettuce'
        })
    
        world.browser = 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.

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

    pip install pytest pytest-xdist

    pytest -n <number_of_processes>

### 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.

    from testingbotclient import TestingBotClient
    
    tb = TestingBotClient("key", "secret")
    tb.tests.update_test(world.browser.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.

- [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 is a Python package, its mission: "Bring the best of Selenium, Cypress and Python into one package."

### 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)