1.3.2 • Published 4 years ago

image-comparison-backend v1.3.2

Weekly downloads
2
License
GPL-3.0-or-later
Repository
github
Last release
4 years ago

Image comparison backend

The image comparison backend works together with the image comparison frontend to provide the creation and management of automated image comparisons in an continous integration environment.

The image comparison frontend is used in end to end tests run in the CI environment to take images during the test and compare these images to base images that are known to be correct. The frontend stores these images together with test result information and difference images, if applicable. If a test fails, the CI process should report this.

Using the image comparison backend, the test results can be evaluated. If the comparison failed because of a bug, a developer can fix this and the CI should report now that the comparison no longer fails. If the comparison failed but the new image is correct, perhaps because of a new feature, the image comparison backend offers an option to accept the new image. The test result will be updated and the new image will be used from now on as new base image.

Requirements:

  • Node v10 (if you want to develop or run without docker)
  • Docker (if using the docker image (recommended))

Getting Started

Using Docker (recommended):

sudo docker run -p <port>:3000 -v <datadir>:/home/node/app/public/data -d jochendiekenbrock/image-comparison-backend

(replace <port> with a port on your system, for example 80 and <datadir> with the directory on your system, where the test data resides, for example /public/data)

Run manually or for development:

yarn install
yarn start-dev

If no test result data is found in /public/data (or the data directory you specified in src/config.ts), example data from /public/example-data is used.

License

GPL-3.0-or-later