Merge pull request #31 from Kartikeya99/ignoredBox

Ignored box

Author: puneet0191

README.md

@@ -71,10 +71,10 @@ It is exactly same as `seeVisualDiff` function, only an additional `selector` CS
 
 Third one is the `screenshotElement` which basically takes screenshot of the element. Selector for the element must be provided.
 It saves the image in the output directory as mentioned in the config folder.
-This method only works with puppeteer.
 ```js
 I.screenshotElement("selectorForElement", "nameForImage");
 ```
+>Note: This method only works with puppeteer.
 
 Finally to use the helper in your test, you can write something like this:
 
@@ -102,6 +102,22 @@ Scenario('Compare CPU Usage Images', async (I) => {
 });
 ```
 
+### Ignored Box
+You can also exclude part of the image from comparison, by specifying the excluded area in pixels from the top left.
+Just declare an object and pass it options as `ignoredBox`:
+```
+const box = {
+    left: 0,
+    top: 10,
+    right: 0,
+    bottom: 10
+};
+
+I.seeVisualDiff("image.png", {prepareBaseImage: true, tolerance: 1, ignoredBox: box});
+```
+After this, that specific mentioned part will be ignored while comparison.
+This works with both `seeVisualDiff` and `seeVisualDiffForElement`.
+
 ### Allure Reporter
 Allure reports may also be generated directly from the tool. To do so, add
 ```

index.js

@@ -26,11 +26,11 @@ class ResembleHelper extends Helper {
     image2 = this.config.screenshotFolder + image2;
 
     return new Promise((resolve, reject) => {
-      if (options.boundingBox !== undefined) {
-        resemble.outputSettings({
-          boundingBox: options.boundingBox
-        });
-      }
+      
+      resemble.outputSettings({
+        boundingBox: options.boundingBox,
+        ignoredBox: options.ignoredBox
+      });
 
       this.debug("Tolerance Level Provided " + options.tolerance);
       const tolerance = options.tolerance;
@@ -48,6 +48,9 @@ class ResembleHelper extends Helper {
               if (err) {
                 throw new Error(this.err);
               }
+              else {
+                this.debug(this.config.diffFolder + diffImage + '.png');
+              }
             });
           }
         }