Getting started
Last updated
Last updated
Visual regression test with cypress
This tool was created to make visual regression as simple as possible, by exposing basic functions that allow you to view the difference between images. The wrapper uses which is simple and powerful and relies on to take screenshots.
Create a spec file under cypress integration folder i.e cypress/integration/specs/some-test-spec.js
Then use the cypress image diff command to take screenshots of pages or elements:
You can also make the comparison assertion more flexible by applying a higher threshold (default is 0):
Alternatively, you can delete the baseline image that you wish to be updated and rerun the tests, this will create a new baseline image with the updated image.
This folder structure will be created by default at the root of your project where your package.json
lives:
In order to force the screenshot resolution when running a test you will need to set the following cypress config values in cypress.json
:
All screenshots will be renamed and moved from the default screenshot location to a new screenshot folder structure. To preserve the screenshot in the original location, set the following values in cypress.json
:
Note: Be aware that despite forcing a screenshot resolution to a particular height and width for a test, if this test is run on different infrastructure (i.e a 13" Mac vs PC attached to a 30" monitor), the results will be different. So it's extremely important that you standardize where the tests will run, both locally and CI.
One way to handle this, is by running it with docker container or against BrowserStack or alike.
This project tests use a docker container to run the tests so it could be used as an example.
Once you have setup cypress and followed you can start writing tests
You can also retry the snapshot comparison by passing in an optional third parameter. It accepts the same options as .
If there are wanted changes to the application in test and if we need to update baseline images, you can follow the steps in documentation to update the baselines.
In some cases, you may want to modify the folder structure relative to the directory. To accomplish this you will need to set a value on the ROOT_DIR key value on the cypress-image-diff.config.js
. ROOT_DIR
is a path relative to the current working directory.
Note: This plugin internally uses cypress.screenshot
command and due to its limitation on taking full page screenshots (), you might encounter some weird results if you have html
, body
set to 100%
, or scroll-behavior: smooth
, this workaround of reseting these CSS properties before invoking the command might help:
Full page screenshots are generally not recommended over individual DOM elements, as stated in the , so use them sparingly.