Visual Regression Tracker

Open source, self hosted solution for visual testing and managing results of visual testing.

Hello

• Take 1-minute survey to help us priorities tasks better ❤️
• Twitter
• Telegram group

How it works

Service receives images, performs pixel by pixel comparison with it’s previously accepted baseline and provides immediate results in order to catch unexpected changes.

Features

• Automation framework independent - no need to stick with specific automation tool, integrate with existing one
• Platform independent - web, mobile, desktop etc. as long as you could make a screenshot
• Baseline history - track how baseline image changed since the beginning
• Ignore regions - improve stability by ignoring not important or not controllable parts of image
• Language support - JS, Java, Python, .Net or any other via REST API (need more?)
• Easy setup - everything is inside Docker images
• Self-hosted - keep your data save inside your intranet

Glossary

• TestVariation - historical record of Baselines by Name + Branch + OS + Browser + Viewport + Device,
• Baseline - validated and accepted image, latest will be used as expected result in TestRun
• TestRun - result of comparing image against Baseline
• Build - list of TestRuns
• Project - list of Builds and TestVariations

Set up

Linux, macOS, WSL

1. Install Docker
2. Download the installation script

curl https://raw.githubusercontent.com/Visual-Regression-Tracker/Visual-Regression-Tracker/master/vrt-install.sh -o vrt-install.sh
chmod a+x vrt-install.sh

3. Run the installation script

./vrt-install.sh

Command line arguments

Installs the Visual Regression Tracker

Usage: ./vrt-install.sh

Arguments:
    -h | --help
    -a | --frontend-url <url>   Set the Front-end url. Default: http://localhost:8080
    -r | --backend-url <url>    Set the API url. Default: http://localhost:4200
    --jwt-secret <secret>       Set the JWT secret. Default: randomly generated

By Hand

1. Install Docker
2. Copy docker-compose.yml

$ curl https://raw.githubusercontent.com/Visual-Regression-Tracker/Visual-Regression-Tracker/master/docker-compose.yml -o docker-compose.yml

3. Copy .env

$ curl https://raw.githubusercontent.com/Visual-Regression-Tracker/Visual-Regression-Tracker/master/.env -o .env

4. Start service

$ docker-compose up

Wait untill you see your creds printed.

New users and projects could be created via frontend app by default on http://localhost:8080

Integration

Use implemented libraries to integrate with existing automated suites by adding assertions based on image comparison. We provide native integration with automation libraries, core SDK and Rest API interfaces that allow the system to be used with any existing programming language.

Agents

• Playwright
• Cypress
• CodeceptJS

Core SDK

Basic wrapper over API to be used for integration with existing tools

• JavaScript
• Java
• Python
• Dotnet

Getting started guide

Videos

• How to set up on Remote machine via ssh

Wiki

• Cypress
• Playwright
• Storybook
• Selenide (Java)
• Jenkins VRT result publising example (with JAVA SDK)

Integration examples

Here you could find examples

• JavaScript
• Java
• Python
• Dotnet

Contribution

1. Try it, raise tickets with ideas, questions, bugs and share feedback :)
2. More language support for SDK
3. More integration with specific testing frameworks (agents)

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Pavel Strunkin 💻 💼 🤔 🔌	Daniel Crowe 🔌 👀	Surat Das 💻 🔌	Oleksandr Romanov 🔌	Terentev Denis 🔌	JustSittinHere 🔌	Dekara VanHoc 🔌
maddocnc 💻

This project follows the all-contributors specification. Contributions of any kind welcome!