Screenshot Comparison

Track visual changes on your website and flag potential issues

Search our documentation:

Toggle Documentation Menu

Screenshot Comparison

Screenshot comparisonGhost Inspector is capable of tracking what your website is supposed to look like via our screenshot comparison feature. Our system does this by taking a screenshot at the end of every test run and doing a pixel-by-pixel comparison to the last passing screenshot to look for differences.

You can set a “tolerance” anywhere from 0% to 90%. This is the amount of change that’s allowable. If Ghost Inspector detects that the screenshot has changed by more than that amount, it’ll flag it as a failure and notify you. A second image will be shown next to the result’s screenshot that highlights the differences in red. There is an “Accept New Screenshot as Baseline” button that will be present above any screenshot failures. This allows you to set a new baseline (essentially telling our system “It’s ok, this is what the screenshot is supposed to look like now”).

The system will track different baselines for each combination of browser, screen size and geolocation. This means that if you run at test at 1024x768, the run it again at 1280x1024, those screenshots will not be directly compared. Each run will look for it's own respective baseline for that resolution, browser and geolocation. If no baseline exists, the screenshot will become the baseline for that combination (assuming the test passed). We do this because comparing screenshots for different resolutions and browsers generally results in a large amount of change that's not very helpful to investigate.

You can enable or disable screenshot comparison and adjust the tolerance level for your test under Settings > Display Options in the test. A number of other options (seen below) are available as well. Many of these can be adjusted at the suite level under Settings > Test Defaults in the suite.

Display Options
Note #1: Changing the steps of your test (or changing your website itself) can cause changes in the screenshot. If expected changes occur, you will need to use the “Accept New Screenshot as Baseline” button to accept the new baseline.
Note #2: Our system currently compares a maximum area of 1600x20000 pixels. This means that content further down than 20,000 pixels is not factored into the comparison.