Merge pull request #949 from gemini-testing/diff-bounds

feat: pass diff bounds to error from looks-same
gemini-testing · Dec 26, 2018 · 5c89c0f · 5c89c0f
2 parents 86624ce + bdb3aab
commit 5c89c0f
Show file tree

Hide file tree

Showing 8 changed files with 2,446 additions and 2,686 deletions.
diff --git a/doc/config.md b/doc/config.md
@@ -13,7 +13,9 @@ desiredCapabilities:
   commonThing: value
 calibrate: false
 tolerance: 3.5
-antialiasingTolerance: 0
+antialiasingTolerance: 0,
+compareOpts:
+  stopOnFirstFail: true
 httpTimeout: 5000
 sessionRequestTimeout: 60000
 sessionQuitTimeout: 5000
@@ -213,6 +215,10 @@ Settings list:
 
 * `antialiasingTolerance` — read about this option in [looks-same](https://github.com/gemini-testing/looks-same#comparing-images-with-ignoring-antialiasing).
 
+* `compareOpts` — extra options for images comparing. It's an Object with following fields:
+    * `[stopOnFirstFail] {Boolean}` Only first pixel will be found if this option is true
+  See [looks-same](https://github.com/gemini-testing/looks-same#comparing-images) documentation for the list of options.
+
 * `windowSize` — specify browser window dimensions (i.e. `1600x1200`). If not
   specified, the size of the window depends on WebDriver. :warning: You can't set specific resolutions for browser Opera or mobile platforms. They use only full-screen resolution.
 

diff --git a/lib/config/browser-options.js b/lib/config/browser-options.js
@@ -25,6 +25,7 @@ const getTopLevel = () => {
         screenshotsDir: 'gemini/screens',
         tolerance: 2.3,
         antialiasingTolerance: 0,
+        compareOpts: {stopOnFirstFail: false},
         sessionsPerBrowser: 1,
         suitesPerSession: Infinity,
         windowSize: null,
@@ -228,6 +229,17 @@ function buildBrowserOptions(defaultFactory, extra) {
 
         compositeImage: booleanOption(defaultFactory('compositeImage')),
 
+        compareOpts: option({
+            defaultValue: defaultFactory('compareOpts'),
+            parseEnv: JSON.parse,
+            parseCli: JSON.parse,
+            validate: (value) => {
+                if (!isOptionalObject(value)) {
+                    throw new GeminiError('CompareOpts should be object');
+                }
+            }
+        }),
+
         orientation: option({
             defaultValue: defaultFactory('orientation'),
             validate: (value) => {

diff --git a/lib/state-processor/capture-processor/capture-processor.js b/lib/state-processor/capture-processor/capture-processor.js
@@ -49,19 +49,20 @@ module.exports = class CaptureProcessor {
     _compareImages(capture, opts) {
         const {refImg} = opts;
         const currImg = {path: temp.path({suffix: '.png'}), size: capture.image.getSize()};
-        const compareOpts = {
+        const imageCompareOpts = {
             canHaveCaret: capture.canHaveCaret,
             pixelRatio: opts.pixelRatio,
             tolerance: opts.tolerance,
-            antialiasingTolerance: opts.antialiasingTolerance
+            antialiasingTolerance: opts.antialiasingTolerance,
+            compareOpts: opts.compareOpts
         };
 
         return capture.image.save(currImg.path)
-            .then(() => Image.compare(currImg.path, refImg.path, compareOpts))
-            .then((isEqual) => {
-                return isEqual
+            .then(() => Image.compare(currImg.path, refImg.path, imageCompareOpts))
+            .then(({equal, diffBounds}) => {
+                return equal
                     ? this._onEqualHandler(refImg, currImg)
-                    : this._onDiffHandler(refImg, currImg);
+                    : this._onDiffHandler(refImg, currImg, diffBounds);
             });
     }
 };
diff --git a/lib/state-processor/capture-processor/index.js b/lib/state-processor/capture-processor/index.js
@@ -38,7 +38,7 @@ exports.create = (type) => {
             .onReference()
             .onNoReference(throwNoRefError)
             .onEqual((refImg, currImg) => ({refImg, currImg, equal: true}))
-            .onDiff((refImg, currImg) => ({refImg, currImg, equal: false}));
+            .onDiff((refImg, currImg, diffBounds) => ({refImg, currImg, diffBounds, equal: false}));
     }
 
     if (type === 'new-updater') {

diff --git a/lib/state-processor/state-processor.js b/lib/state-processor/state-processor.js
@@ -33,7 +33,8 @@ module.exports = class StateProcessor {
                 refImg: {path: browserConfig.getScreenshotPath(state.suite, state.name), size: null},
                 pixelRatio: page.pixelRatio,
                 antialiasingTolerance: browserConfig.antialiasingTolerance,
-                tolerance
+                tolerance,
+                compareOpts: browserConfig.compareOpts
             },
             temp: temp.serialize()
         };