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

Use any of the below ways to setup the server. Docker has to be installed on the machine.

Quick Setup

Linux, macOS, WSL

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

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

Manual Setup

Copy docker-compose.yml

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

Copy .env

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

In .env file, ensure that the REACT_APP_API_URL has the right address. If it will be accessed from other machines, change localhost with IP or other resolvable name. Ensure the ports being used are free to use.
Start service

$ docker-compose up

Wait until you see your creds printed.

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

Run VRT with logging enabled in Elasticsearch

This is for the users who want to monitor VRT logs via Kibana. It is expected to have basic knowledge of Elastic stack (especially Kibana) for the admin so that the logs can be managed and dashboards created in Kibana. Since logging will be retained by Elasticsearch, it will consume a little more memory and CPU. If you see error in the console, please consult Elasticsearch documentation.

It is recommended to run the program as root user which will ensure permission and ownership related issues will not have to be dealt with.

Clone or download this repository.
Move to the downloaded/cloned repository. In .env file, ensure that the REACT_APP_API_URL has the right address. If it will be accessed from other machines, change localhost with IP or other resolvable name. Ensure the ports being used are free to use.
Follow either of below sub steps.
- If your organization does not have Elasticsearch server running or if you want to start Elastic stack on your own, start service by giving below command.
  
  $ docker-compose -f docker-compose.yml -f docker-compose.elastic.logging.yml up
- If you want to re-use the already running Elasticsearch server in your organization, go to filebeat/config/filebeat.yml and edit hosts to point to the Elasticsearch server. Also, point ELASTIC_URL to this server in .env file. Start service by giving below command.
  
  $ docker-compose -f docker-compose.yml -f docker-compose.logging.yml up
If you are not using root user, in some OS, you may see an error Exiting: error loading config file: config file ("filebeat.yml") must be owned by the user identifier (uid=0) or root. In that case, press Ctrl+C, and follow Elasticsearch instructions. Once done, start the service again.

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

Core SDK

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

Getting started guide

Videos

How to set up on Remote machine via ssh

Wiki

Integration examples

Here you could find examples

Contribution

Try it, raise tickets with ideas, questions, bugs and share feedback :)
More language support for SDK
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 💻	_{Aaron Chelvan} 💻 📖	_marcm-qa 🔌	_Eduard-iCH 🔌	_Roman 💻	_{Dimitri Harding} 💻	_vkostromin94 🔌
_{Bruno Ferreira} 💻	_{Loïc PÉRON} 💻 🔌	_{Alexey Volkov} 🔌 💻	_{Egor Lipskiy} 🔌	_nitschSB 💻