BDD with Python, Lettuce and WebDriver

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

$ pip install lettuce


To use Lettuce with Selenium, you'll need to install the lettuce_webdriver plugin:

$ pip install lettuce_webdriver

You might also need to install nose:
$ pip install nose


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 "http://www.google.com/"
  When I fill in field with class "gsfi" with "testingbot"
  Then I should see "testingbot.com" within 2 second

Example steps (features/steps.py)

from lettuce import *
from lettuce_webdriver.util import assert_false
from lettuce_webdriver.util import AssertContextManager

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 before, world
from selenium import webdriver
import lettuce_webdriver.webdriver

@before.all
def setup_browser():
    desired_capabilities = webdriver.DesiredCapabilities.FIREFOX
    desired_capabilities['version'] = 'latest'
    desired_capabilities['platform'] = 'WINDOWS'
    desired_capabilities['name'] = 'Testing Selenium with Lettuce'

    world.browser = webdriver.Remote(
        desired_capabilities=desired_capabilities,
        command_executor="https://key:secret@hub.testingbot.com/wd/hub"
    )

Configuring capabilities

To let TestingBot know on which browser/platform you want to run your test on, you need to specify the browsername, version, OS and other optional options in the capabilities field.



Before
driver = webdriver.Firefox()

After
driver = webdriver.Remote(
command_executor='https://key:secret@hub.testingbot.com/wd/hub',
desired_capabilities=desired_caps)

To see how to do this, please select a combination of browser, version and platform in the drop-down menus below:


1. Select a Platform
2. Select a Browser


Testing Internal/Staged 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 Lettuce 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 securily through the tunnel to TestingBot and back:


Example terrain.py

from lettuce import before, world
from selenium import webdriver
import lettuce_webdriver.webdriver

@before.all
def setup_browser():
    desired_capabilities = webdriver.DesiredCapabilities.FIREFOX
    desired_capabilities['version'] = 'latest'
    desired_capabilities['platform'] = 'WINDOWS'
    desired_capabilities['name'] = 'Testing Selenium with Lettuce'

    world.browser = webdriver.Remote(
        desired_capabilities=desired_capabilities,
        command_executor="http://key:secret@localhost:4445/wd/hub"
    )

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.

Parallel Testing

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.


Queueing

Every plan we provide comes with a limit of concurrent VMs (how many tests you can run in parallel).
For example: if you have a plan with 5 concurrent VMs, it is possible to start more tests. TestingBot will queue the additional tests and run the tests as soon as slots become available.


To run tests in parallel, we recommend using Nose and MultiProcessing, which makes it very easy to run multiple Python tests simultaneously:

pip install nose==0.11
pip install multiprocessing
nosetests --processes=<number_of_processes>

Pick a Python Test Framework

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