Features
Start a free trial

BDD with Python, Behave and WebDriver

See our Behave example repository 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:

Copy code
pip install behave

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

Copy code
behave

Example feature (features/google.feature)

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

Copy code
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)

Copy code
@when('we visit google')
def step(context):
   context.browser.get('https://www.google.com')

@then('it should have a title "Google"')
def step(context):
   assert context.browser.title == "Google"

Example features/environment.py

Copy code
from selenium import webdriver

def before_all(context):
	desired_capabilities = webdriver.DesiredCapabilities.FIREFOX
	desired_capabilities['version'] = 'latest'
	desired_capabilities['platform'] = 'WINDOWS'
	desired_capabilities['name'] = 'Testing Selenium with Behave'
	desired_capabilities['client_key'] = 'key'
	desired_capabilities['client_secret'] = 'secret'

	context.browser = webdriver.Remote(
		desired_capabilities=desired_capabilities,
		command_executor="https://hub.testingbot.com/wd/hub"
	)

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:
Copy code
driver = webdriver.Firefox()
After:
Copy code
driver = webdriver.Remote(
  command_executor='http://key:secret@hub.testingbot.com/wd/hub',
  desired_capabilities=desired_caps)

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.

1. Select a Platform
2. Select a browser
Copy code

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 Behave WebDriver test with our Tunnel:

1. Download our tunnel and start the tunnel:

Copy code
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

Copy code
from selenium import webdriver

def before_all(context):
	desired_capabilities = webdriver.DesiredCapabilities.FIREFOX
	desired_capabilities['version'] = 'latest'
	desired_capabilities['platform'] = 'WINDOWS'
	desired_capabilities['name'] = 'Testing Selenium with Behave'
	desired_capabilities['client_key'] = 'key'
	desired_capabilities['client_secret'] = 'secret'

	context.browser = webdriver.Remote(
		desired_capabilities=desired_capabilities,
		command_executor="http://localhost:4445/wd/hub"
	)

def after_all(context):
	context.browser.quit()

Mark tests as passed/failed

As TestingBot has no way to dermine 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.

Copy code
tb = testingbotclient.TestingBotClient(key, secret)
tb.tests.update_test(self.driver.session_id, status_message=.., passed=1|0, build=.., name=..)

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.