Boozang Docker container

degardinn/boozang

A Boozang container, based on alekzonder/puppeteer, to run Boozang tests in a headless browser.

Description

This container executes a Boozang test (or test suite) defined by the provided Boozang test URL, in an headless Chromium browser (via Puppeteer).

It returns an error code if the test fails, and its report can be accessed thanks to a docker volume.

This container is mainly designed to be integrated to a Continuous Integration workflow.

Requirement

To work properly, the command line should target an environment embedding a Boozang cross-browser code fragment as defined in the Boozang documentation. Otherwise, the script execution might simply hang.

Basically, the server at the targeted domain and port should serve such an HTML file (where id is set to a proper Boozang project id):

<DOCTYPE html>
<script type='text/javascript' src='//ai.boozang.com/ide?id=6d34d123abfe65dc'></script>

The Boozang test URL must call the code fragment, and can end with /run (if not the case, /run will be appended), for instance:

http://localhost/bz.html#6d34d123abfe65dc/0.0.1/m1/t1/run

Usage

Basic

The base command takes the test URL as a mandatory parameter:

docker run --rm --shm-size 1G degardinn/boozang https://localhost/bz.html#6d34d123abfe65dc/0.0.1/m3/t2

• --rm� can be specified to remove the container after the test execution.
• --shm-size 1G� should be specified to increase the memory available for the virtual browser

The command outputs the test steps and result to the console, and returns the following exit codes:

• 0 if the tests succeeded
• 1 if the tests failed
• 2 in case of any other error

Options

The following options can be specified.

• device�: define a specific device to run the tests
• timeout�: define the command timeout time in seconds
• token�: add a Boozang user token to the URL, to allow user connection. The token can also be directly specified in the URL. In this case, the environment variable token will be ignored.
• file�: define the report and screenshot file name (without an extension). If not specified, the name is boozang� followed by the date and time
• screenshot�: if true, a screenshot is taken two seconds after opening the URL.

Example:

docker run degardinn/boozang --timeout=60 --token=a4fd68b4b239 --file=my-custom-name --screenshot https://localhost/bz.html#6d34d123abfe65dc/0.0.1/m3/t2�

Accessing reports

The report and screenshot are written to the container /var/boozang volume.

To retrieve them, the volume can be mapped to a local directory, this way:

docker run -v "$(pwd):/var/boozang" degardinn/boozang --screenshot https://localhost/bz.html#6d34d123abfe65dc/0.0.1/m3/t2�