https://github.com/cweagans/comparinator

Simple webdriver backed visual regression testing
https://github.com/cweagans/comparinator

Last synced: 30 days ago
JSON representation

Simple webdriver backed visual regression testing

• Host: GitHub
• URL: https://github.com/cweagans/comparinator
• Owner: cweagans
• Created: 2020-05-02T05:44:10.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-12-17T19:49:23.000Z (about 4 years ago)
• Last Synced: 2024-05-01T22:57:23.903Z (8 months ago)
• Language: Go
• Size: 14.6 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# comparinator

Simple visual regression testing for websites with reasonable defaults.

If you need something more advanced, wraith is probably what you want. This tool will only crawl the base path and any pages on the alpha site that are directly linked from the base path (determined by domain).

## Usage

`comparinator -help` shows all available flags.

For the most common testing scenario:

`comparinator -alpha-base-url="https://www.yoursite.com" -beta-base-url="https://dev.yoursite.com"`

You'll need to have webdriver running at `localhost:4444` or specify the URL to your webdriver with the `-webdriver-url` flag.

Once it's done running, you'll have an output directory with all of the screenshots + diffs + a JSON file with a bunch of info in it about which screenshots belong to which url, how similar they are, and the overall similarity across all screenshots. Someday I'll build a little web UI around this.

You can optionally specify the path to a sitemap.xml file using the `sitemap-url` flag. If you specify a sitemap, the links contained in the sitemap will be used instead of the links found on the home page of the alpha site. The full URL to the sitemap.xml depends on what you specify for the alpha site base url -- essentially, it's `alpha-base-url sitemap-url`.

## Building

`make`

## Releasing

Push a tag to the repo and Github CI will take over, build a release, and upload

the artifacts to the release page.