feat: add "antialiasingTolerance" option

* allows to make the algorithm for determing antialiasing less strict
gemini-testing · Sep 11, 2018 · de7cc86 · de7cc86
1 parent 754c56d
commit de7cc86
Show file tree

Hide file tree

Showing 9 changed files with 2,204 additions and 2,098 deletions.
diff --git a/doc/config.md b/doc/config.md
@@ -13,6 +13,7 @@ desiredCapabilities:
   commonThing: value
 calibrate: false
 tolerance: 3.5
+antialiasingTolerance: 0
 httpTimeout: 5000
 sessionRequestTimeout: 60000
 sessionQuitTimeout: 5000
@@ -210,6 +211,8 @@ Settings list:
   recommended, prefer changing tolerance for particular suites or states
   instead.
 
+* `antialiasingTolerance` — read about this option in [looks-same](https://github.com/gemini-testing/looks-same#comparing-images-with-ignoring-antialiasing).
+
 * `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.
 
@@ -226,7 +229,7 @@ Settings list:
   specified, the fallen tests will not be relaunched (by default it's 0).
 
   Note that the same test never be performed in the same browser session.
-  
+
 * `shouldRetry` — function which defines whether to make a retry. Should returns `Boolean` value. First argument is `data` which is the result of the test run, it's an Object with following fields:
     * `attempt {Number}` number of retries performed for the test
     * `retriesLeft {Number}` number of retries left

diff --git a/lib/config/browser-options.js b/lib/config/browser-options.js
@@ -24,6 +24,7 @@ const getTopLevel = () => {
         sessionQuitTimeout: null,
         screenshotsDir: 'gemini/screens',
         tolerance: 2.3,
+        antialiasingTolerance: 0,
         sessionsPerBrowser: 1,
         suitesPerSession: Infinity,
         windowSize: null,
@@ -150,6 +151,13 @@ function buildBrowserOptions(defaultFactory, extra) {
             validate: is('number')
         }),
 
+        antialiasingTolerance: option({
+            defaultValue: defaultFactory('antialiasingTolerance'),
+            parseEnv: Number,
+            parseCli: Number,
+            validate: is('number')
+        }),
+
         windowSize: option({
             defaultValue: defaultFactory('windowSize'),
             validate: (value) => {

diff --git a/lib/state-processor/capture-processor/capture-processor.js b/lib/state-processor/capture-processor/capture-processor.js
@@ -45,8 +45,9 @@ module.exports = class CaptureProcessor {
         const currentPath = temp.path({suffix: '.png'});
         const compareOpts = {
             canHaveCaret: capture.canHaveCaret,
+            pixelRatio: opts.pixelRatio,
             tolerance: opts.tolerance,
-            pixelRatio: opts.pixelRatio
+            antialiasingTolerance: opts.antialiasingTolerance
         };
 
         return capture.image.save(currentPath)

diff --git a/lib/state-processor/state-processor.js b/lib/state-processor/state-processor.js
@@ -31,6 +31,7 @@ module.exports = class StateProcessor {
             execOpts: {
                 pixelRatio: page.pixelRatio,
                 referencePath: browserSession.browser.config.getScreenshotPath(state.suite, state.name),
+                antialiasingTolerance: browserSession.browser.config.antialiasingTolerance,
                 tolerance
             },
             temp: temp.serialize()