Dockerized Behave/Selenium

behave-selenium is a docker image for running behave containers. It borrows heavily from William Yeh's docker-behave.

Installed

From python:3.8-slim-buster

Package	Version
ChromeDriver	88.0.4324.27
google-chrome-stable	88.0.4324.96-1
GeckoDriver	0.29.0
firefox-esr	78.6.1esr-1~deb10u1
behave	1.2.6
elementium	2.0.2
selenium	3.141.0

How it works

This container contains Behave, (the python version of Cucumber), Selenium, and Elementium. Elementium is a wrapper for drivers that provides jQuery like syntactic sugar over the regular Selenium bindings, as well as providing fault tolerance.

How to use

Firstly, add the following to your features/environment.py file:

from selenium import webdriver
from selenium.webdriver.chrome.options import Options as ChromeOptions
from selenium.webdriver.firefox.options import Options as FirefoxOptions
from elementium.drivers.se import SeElements
from configparser import ConfigParser
import os

def before_all(context):
    config = ConfigParser()
    config_file = (os.path.join(os.getcwd(), 'setup.cfg'))
    config.read(config_file)

    browser = config.get('Environment', 'Browser')
    remote = config.get('Environment', 'Local')

    if (remote == "true"):
      if (browser == "chrome"):
        context.driver = SeElements(
          webdriver.Remote(
            command_executor='http://host.docker.internal:9515/wd/hub'
          )
        )
      elif (browser == "firefox"):
        context.driver = SeElements(
          webdriver.Remote(
            command_executor='http://host.docker.internal:4444'
          )
        )
    else:
      if (browser == "chrome"):
        chrome_options = ChromeOptions()
        chrome_options.headless = True
        chrome_options.add_argument("no-sandbox")
        chrome_options.add_argument("disable-setuid-sandbox")
        context.driver = SeElements(
          webdriver.Chrome(
            chrome_options=chrome_options
          )
        )
      elif (browser == "firefox"):
        firefox_options = FirefoxOptions()
        firefox_options.headless = True
        context.driver = SeElements(
          webdriver.Firefox(
            firefox_options=firefox_options
          )
        )    

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

You'll then want to create a file called setup.cfg in your root folder that contains the following:

[Environment]
Browser = (chrome or firefox)
Local = (true or false)

This will accomodate both headless and local testing.

If you require additional python packages, you can place a requirements.txt file in your steps folder, and it will be installed before running the behave tests. If you would like to place the file in a different location for some reason, you can specify -e REQUIREMENTS_PATH=path/to/requirements.txt.

Headless

---

Simply set "Local" to "false" in your setup.cfg file, cd into the folder that contains your features folder, and run the following:

docker run --rm -it -v $(pwd):/behave obscuritylabs/behave-selenium

On local host (for development)

---

You can have this container run tests on your local browser, which is useful for debugging, and ensuring that tests are running correctly visually.

Using Chrome

On Mac, install ChromeDriver with brew:

$ brew install chromedriver

In order to allow the connection between the container and the local chromedriver, you need to whitelist the IP that is making the connection, and that needs to be specified before the container exists. Otherwise you'll get the error WebDriverException: Message: Host header or origin header is specified and is not localhost. In most cases, this will be 172.17.0.2, specifically if this is the only container running:

$ chromedriver --url-base=/wd/hub --whitelisted-ips="172.17.0.2"
$ docker run --rm -it -v $(pwd):/behave obscuritylabs/behave-selenium

If you have issues with this, have other containers running, or would like to ensure that the IP address is predictable for any other reason, you can run the following docker compose file instead, and whitelist 172.23.0.2 (or whatever you want to change it to, 23 is just my favorite number).

version: '3'
services:
  behave:
    image: obscuritylabs/behave-selenium
    volumes: 
      - .:/behave
    networks: 
      static-network:
        ipv4_address: 172.23.0.2
networks: 
  static-network:
    ipam:
      config:
        - subnet: 172.23.0.0/16

Using Firefox

On Mac, install GeckoDriver with brew:

$ brew install geckodriver

There are no ip restrictions like in ChromeDriver, so you can just run the following

$ geckodriver
$ docker run --rm -it -v $(pwd):/behave obscuritylabs/behave-selenium