---
title: Run Selenium tests with Python and Behave BDD
description: Automatically test your website with Python, Selenium WebDriver and Behave.
  Automated testing on real browsers and mobile devices.
source_url:
  html: https://testingbot.com/support/web-automate/selenium/python/behave
  md: https://testingbot.com/support/web-automate/selenium/python/behave/index.md
---
# BDD with Python, Behave and WebDriver

See our [Behave example repository](https://github.com/testingbot/python-behave-example) for a simple example on how to run Behave tests in parallel on TestingBot.

Behave is a Python BDD (Behavior Driven Development) framework which makes it easy to write tests (bdd tests) in a natural language style.   
 To get started, make sure you have installed Behave:

    pip install behave

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

    behave

## Example feature (features/google.feature)

This feature file needs to be added to the features directory.

    Feature: testing google
    
    Scenario: visit google and check
    When we visit google
    Then it should have a title "Google"

## Example steps (features/steps/steps.py)

    from behave import when, then
    
    @when('we visit google')
    def step_visit_google(context):
        context.browser.get('https://www.google.com')
    
    @then('it should have a title "Google"')
    def step_check_title(context):
        assert context.browser.title == "Google"

## Example features/environment.py

    from selenium import webdriver
    from selenium.webdriver.firefox.options import Options
    
    def before_all(context):
        options = Options()
        options.set_capability('browserVersion', 'latest')
        options.set_capability('platformName', 'WIN11')
        options.set_capability('tb:options', {
            'name': 'Testing Selenium with Behave',
            'key': 'key',
            'secret': 'secret'
        })
    
        context.browser = webdriver.Remote(
            command_executor='https://hub.testingbot.com/wd/hub',
            options=options
        )
    
    def after_all(context):
        context.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()
    options.set_capability('browserVersion', 'latest')
    options.set_capability('platformName', 'WIN10')
    options.set_capability('tb:options', {
        'key': 'key',
        'secret': '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.

  ![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 Behave 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

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 features/environment.py

    from selenium import webdriver
    from selenium.webdriver.firefox.options import Options
    
    def before_all(context):
        options = Options()
        options.set_capability('browserVersion', 'latest')
        options.set_capability('platformName', 'WIN10')
        options.set_capability('tb:options', {
            'name': 'Testing Selenium with Behave',
            'key': 'key',
            'secret': 'secret'
        })
    
        context.browser = webdriver.Remote(
            command_executor='http://localhost:4445/wd/hub',
            options=options
        )
    
    def after_all(context):
        context.browser.quit()

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