Skip to content

Files

Latest commit

 

History

History

docker

README.md

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:

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

MultiArch Build

Your docker setup should have buildx support to be able to build that.

docker buildx create --name mybuilder --use --bootstrap

Build + Push:

export BACKSTOPJS_VERSION=6.1.4
docker buildx build --push --build-arg BACKSTOPJS_VERSION --platform linux/amd64,linux/arm64 --tag backstopjs/backstopjs:$BACKSTOPJS_VERSION docker

local load to your registry

build + load it to your registry (load does not support more than 1 platform, push does docker/buildx#59):

AMD64:

export BACKSTOPJS_VERSION=6.1.4
docker buildx build --build-arg BACKSTOPJS_VERSION --platform linux/amd64 --load --tag backstopjs/backstopjs:$BACKSTOPJS_VERSION docker

ARM64:

export BACKSTOPJS_VERSION=6.1.4
docker buildx build --build-arg BACKSTOPJS_VERSION --platform linux/arm64 --load --tag backstopjs/backstopjs:$BACKSTOPJS_VERSION docker