* hacky way to update snapshots * new hack to update snapshots * trying again * hacky fix * ci: snapshots * ci: snapshots * snapshots * mas updates * update spec API * fix test * fix test * update * update test * fix test * update plugin * update spec * webpack optinos * Update launchpad tests * fix screenshot paths * updated snapshot * change pattern * guard * fix smoke test * patch code coverage * update percy config * fix specs * try updating example project * update snapshots * remove old test * remove snapshot hack * add back appveyor * remove old code * update snapshot * Fix tests * wip * revert snapshot * reverted all snaps * remove only * remove commnet * remove old code * reverted file * lint * revert video compression spec * update snapshot * update spec path logic * update snap * updated snap * snaps * snaps * fix spec * rename ignoreTestFiles to ignoreSpecPattern * update screenshot dir for runner-ct * update deprecations * update * upate * fix test * update snaps * update snap * updating snap * added missing snaps * updated cypress run mode integration spec * electron snapshot * update default * rename integration->e2e * rename integration->e2e in packages * spec.ts -> cy.ts * spec.ts -> cy.ts * _spec.js -> .cy.js * .spec.js -> .cy.js * .spec.js -> .cy.js * update config * update config * update * update spec ext * update config * update config * ensure newly scaffold specs are cached * fix launchpad spec * types * update test * transpile based on spec pattern * add back example * remove unnecessary async and nodeVersion * spec.tsx -> cy.tsx * update stop-only config * exclude CT from E2E * removed old test * update spec pattern in angular * update spec pattern in design system * update all specs npm npm/react * update spec name * update spec patterns * remove old script * update tests path * update config * fix test * update snapshots * update examples * update ignore patterns * update snapshots * unit tests * update tests * patch code coverage * revert spec name * rename a lot of speces * update * update spec ext * update spec * update spec * update spec ext * update lint * update rules * update lint * snaps * update spec dir * update paths * remove unused pluginsfile config opt * update smoke test * update create cypress tests * update gitignore * update types * update paths * update spe * update test * update all snaps * update tests * update http request spec * update spec file names * snaps * update snaps * updated snaps * update snaps * spacing * spacing * spacing * spacing * fix perf spec * update * update * revert * update * snaps * snaps * rename spec * update snaps * snapshots * update tests * update tests * update * fix * update test projects * update * updating * update run-ct test * update spec pattern and add defensive check around platform * fix system test script * update snap * snaps * update test * update spe * update for FF * ff * remove unused feature flag * added tests * fix react example * update test * update config * update test projects * update snapshots * correctly remove private prefix on darwin * fix types * rename integration -> e2e * update config * updatec onfig * fixing app scaffold integration tests * remove code * exclude e2e specs from CT * update snapshot * integration->e2e * update path for test file in ts project * update schematic * use updated branch for CI * update config * update config * revert some changes * remove built code * revert changes * update gitignore * include test spec * update scaffold script * wip: renames * script * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * mass rename * rename * rename * fix angular * update spec in create cypress tests * remove old file * fix tests * access specPattern in a more idiomatic fashion * do not duplicate variable * pass correct params to findSpec in files controller * add comment explaining spec finding * remove reference to old file that no longer exist * resolve conflicts * fix types * transpile cypress dir * update circle ymlg * update spec pattern for example project * supportFile: false * fix circle yml * update test glob * rename some specs to use correct .cy ext * more ext renames * rename spec * update extensions * update extensions * update specs Co-authored-by: estrada9166 <estrada9166@hotmail.com> Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com>
example: visual tests for Sudoku
This React Sudoku app was cloned from raravi/sudoku.
Visual testing uses open source palmerhq/cypress-image-snapshot plugin.
Usage
- Make sure the root project has been built .
# in the root of the project
npm install
npm run build
- Run
npm installin this folder to symlink the@cypress/reactdependency.
# in this folder
npm install
- Start Cypress
npm run cy:open
# or just run headless tests
npm test
Running Tests
Example failing test src/App.cy-spec.js
Because there is a difference in the numbers displayed on the board
The saved snapshots are saved in cypress/snapshots folder and committed to the repo.
Consistent images
If we generate images on Mac, they will be different from images generated on Linux CI
- the images will be twice as large because in the headed mode Mac's DPI is 2x
- even in non-interactive mode using
cypress run, due to fonts rendering, the images will be slightly different from Linux images
Thus I recommend generating / updating images using a Docker container cypress/included. You can run it using npm script npm run docker:run which executes
# map the entire repo as a volume
# and set the working directory to the current folder
docker run -it -v $PWD/../..:/e2e \
-w /e2e/examples/visual-sudoku cypress/included:4.5.0
If you want to update the saved snapshots, run the script with environment variable
npm run docker:run -- --env updateSnapshots=true
See cypress-image-snapshot docs.
Full example
For a larger Do-It-Yourself example with an hour long list of explanation videos, see bahmutov/sudoku repository, read the blog post Visual testing for React components using open source tools and flip through slides I See What is Going On.

