Lettuce

If you already have lettuce-webdriver scripts setup to work locally, changing them to work with our system is easy. You just have to change the WebDriver object to a RemoteWebDriver object, and supply it with capabilities that match up with the CrossBrowserTesting API. For example, you might create a Firefox WebDriver like this:

And to run your test on CrossBrowserTesting, you just have to change that line to this:

Your username here will be the email address associated with your CBT account and your authkey can be found on the Manage Account section of CrossBrowserTesting.

First let us get the framework installed. You can do so quickly with PIP.

We will also need lettuce-webdriver.

Alright, now we can get started. To run a test with Lettuce, you need at least three basic files:

• a *.feature file describing your tests using Gherkin’s Given-When-Then syntax,
• a terrain.py file containing your email, authkey, capabilities, and any other setup/teardown steps for your tests,
• at least one steps.py file where test functions from your *.feature files are defined.

Do not worry if any of that sounds confusing. We go over each step below. If you want to follow along with this example, you can find all the files we use on our repository.

Lettuce, like Ruby’s Cucumber framework, uses Gherkin to translate plain English descriptions of how an application should behave into automated functional tests. You should have a different *.feature file for each different feature your are testing. The filename does not matter (since Lettuce loads all *.feature files it finds), but you should make it descriptive. In this example we will be testing a login form, so let us call the file login.feature.

Example login.feature:

As you will see, Lettuce reads quoted input from these instructions to use with correlating Python methods. These Python methods will be setup in a file called steps.py.

Example steps.py:

As you now see, our Python methods pull input from the Gherkin story by using the @step decorator. In this example, we confirm the title of the page, enter a username/password, then hit submit. Finally we ensure that the text “You are now logged in” can be located within the page to verify that our login was successful.

Lastly, we need to ensure that our tests are pointed to CrossBrowserTesting! Lettuce uses python to instantiate a RemoteWebDriver, we just need to make sure its pointed at our hub and uses our API names to pick out a OS/Browser configuration.

Example terrain.py:

Now we lettuce. Within your terminal navigate to the parent of your features directory and run the lettuce command. Go to the Selenium dashboard on our site, and watch your test in action. From the terminal you can watch your test run, and eventually pass: