Avoid failing the test for a given threshold but yet generating the difference image (#63)

* Option bypassFailure allowing the user to avoid failing the test for a given threshold but yet generating the difference image

* Renamed option to skipFailure

Co-authored-by: Jonatas Kirsch <[email protected]>

Author: jonatask

README.md

@@ -121,6 +121,15 @@ I.seeVisualDiff("image.png", {prepareBaseImage: true, tolerance: 1, ignoredBox:
 After this, that specific mentioned part will be ignored while comparison.
 This works for `seeVisualDiff` and `seeVisualDiffForElement`.
 
+### Skip Failure
+You can avoid the test fails for a given threshold but yet generates the difference image.
+Just declare an object and pass it in options as `skipFailure`:
+```
+I.seeVisualDiff("image.png", {prepareBaseImage: true, tolerance: 1, skipFailure: true});
+```
+After this, the system generates the difference image but does not fail the test.
+This works for `seeVisualDiff` and `seeVisualDiffForElement`.
+
 ### Allure Reporter
 Allure reports may also be generated directly from the tool. To do so, add
 

index.js

@@ -326,7 +326,10 @@ class ResembleHelper extends Helper {
     }
 
     this.debug("MisMatch Percentage Calculated is " + misMatch);
-    assert(misMatch <= options.tolerance, "MissMatch Percentage " + misMatch);
+
+    if (options.skipFailure === false) {
+      assert(misMatch <= options.tolerance, "MissMatch Percentage " + misMatch);
+    }
   }
 
   /**