backstopjs/backstopjs repository overview

⁠BackstopJS Docker Image

A self-contained Docker image to run BackstopJS⁠ with no external dependencies.

Visual Regression Testing with BackstopJS in a Docker container⁠

Features:

• BackstopJS 3.x⁠
• Chrome-headless⁠

⁠Versions

• backstopjs/backstopjs - BackstopJS v3 with Chrome Headless support

⁠Usage

Use this image as if you were using a binary.
Working directory is expected to be mounted at /src in the container.

$ docker run --rm -v $(pwd):/src backstopjs/backstopjs --version
BackstopJS v3.x.x

# On Windows use:
$(pwd -W)

You can also add a shell alias (in .bashrc, .zshrc, etc.) for convenience.

alias backstop='docker run --rm -v $(pwd):/src backstopjs/backstopjs "$@"'

Restart your shell or open a new one, then

$ backstopjs --version
BackstopJS v3.x.x

⁠Sample test

docker run --rm -v $(pwd):/src backstopjs/backstopjs init
docker run --rm -v $(pwd):/src backstopjs/backstopjs reference
docker run --rm -v $(pwd):/src backstopjs/backstopjs test

⁠Browser engines

By default BackstopJS is using Headless Chrome to take screenshots.

Chrome is pre-installed in the container.

⁠Limitations

backstop openReport is not (yet) supported.

⁠Debugging

The following command will start a bash session in the container.

docker run --rm -v $(pwd):/src -it --entrypoint=bash backstopjs/backstopjs

⁠Jenkins Guide

You could get a Jenkins Guide here: Jenkins Guide⁠