Merge branch 'master' into reporter

Author: Kartikeya99

.gitignore

@@ -59,3 +59,6 @@ typings/
 
 # next.js build output
 .next
+
+#webstorm
+.idea

README.md

@@ -72,13 +72,13 @@ 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");
 ```
 
 Finally to use the helper in your test, you can write something like this:
 
-```
+```js
 Feature('to verify monitoried Remote Db instances');
 
 Scenario('Open the System Overview Dashboard', async (I, adminPage, loginPage) => {
@@ -102,6 +102,7 @@ Scenario('Compare CPU Usage Images', async (I) => {
 });
 ```
 
+### Allure Reporter
 Allure reports may also be generated directly from the tool. To do so, add
 ```
 "plugins": {
@@ -110,4 +111,35 @@ Allure reports may also be generated directly from the tool. To do so, add
 ```
 in the config file.
 The attachments will be added to the report only when the calulated mismatch is greater than the given tolerance. 
-Set `output` to where the generated report is to be stored. Default is the output directory of the project.
+Set `output` to where the generated report is to be stored. Default is the output directory of the project.
+
+### AWS Support
+AWS S3 support to upload and download various images is also provided.
+It can be used by adding the *aws* code inside `"ResembleHelper"` in the `"helpers"` section in config file. The final result should look like:    
+```json
+{
+    "helpers": {
+        "ResembleHelper" : {
+            "require": "codeceptjs-resemblehelper",
+            "screenshotFolder" : "<location of output folder>",
+            "baseFolder": "<location of base folder>",
+            "diffFolder": "<location of diff folder>",
+            "aws": {
+                "accessKeyId" : "<Your AccessKeyId>",
+                "secretAccessKey": "<Your secretAccessKey>",
+                "region": "<Region of Bucket>",
+                "bucketName": "<Bucket Name>"
+            }
+        }
+    }
+}
+```
+When this option has been provided, the helper will download the base image from the S3 bucket.
+This base image has to be located inside a folder named "*base*".
+The resultant output image will be uploaded in a folder named "*output*" and diff image will be uploaded to a folder named "*diff*" in the S3 bucket.
+If the `prepareBaseImage` option is marked `true`, then the generated base image will be uploaded to a folder named "*base*" in the S3 bucket.
+>Note: The tests may take a bit longer to run when the AWS configuration is provided as determined by the internet speed to upload/download images.
+
+### Known Issues:
+
+> Issue in Windows where the image comparison is not carried out, and therefore no Mismatch Percentage is shown. See 'loadImageData' function in resemble.js

index.js

@@ -2,8 +2,8 @@ const resemble = require("resemblejs");
 const fs = require('fs');
 const assert = require('assert');
 const mkdirp = require('mkdirp');
-const path = require('path');
-const getDirName = path.dirname;
+const getDirName = require('path').dirname;
+const AWS = require('aws-sdk');
 
 /**
  * Resemble.js helper class for CodeceptJS, this allows screen comparison
@@ -104,11 +104,111 @@ class ResembleHelper extends Helper {
     const allure = codeceptjs.container.plugins('allure');
     const diffImage = "Diff_" + baseImage.split(".")[0] + ".png";
 
-    if(allure && misMatch >= tolerance) {
-      allure.addAttachment('Base Image', fs.readFileSync(path.join(this.config.baseFolder, baseImage)), 'image/png');
-      allure.addAttachment('Screenshot Image', fs.readFileSync(path.join(this.config.screenshotFolder, baseImage)), 'image/png');
-      allure.addAttachment('Diff Image', fs.readFileSync(path.join(this.config.diffFolder, diffImage)), 'image/png');
+    if(allure !== undefined && misMatch >= tolerance) {
+      allure.addAttachment('Base Image', fs.readFileSync(this.config.baseFolder + baseImage), 'image/png');
+      allure.addAttachment('Screenshot Image', fs.readFileSync(this.config.screenshotFolder + baseImage), 'image/png');
+      allure.addAttachment('Diff Image', fs.readFileSync(this.config.diffFolder + diffImage), 'image/png');
     }
+  }  
+
+  /**
+   * This method uploads the diff and screenshot images into the bucket with diff image under bucketName/diff/diffImage and the screenshot image as
+   * bucketName/output/ssImage
+   * @param accessKeyId
+   * @param secretAccessKey
+   * @param region
+   * @param bucketName
+   * @param baseImage
+   * @param ifBaseImage - tells if the prepareBaseImage is true or false. If false, then it won't upload the baseImage.
+   * @returns {Promise<void>}
+   */
+
+  async _upload(accessKeyId, secretAccessKey, region, bucketName, baseImage, ifBaseImage) {
+      console.log("Starting Upload... ");
+      const s3 = new AWS.S3({
+          accessKeyId: accessKeyId,
+          secretAccessKey: secretAccessKey,
+          region: region
+      });
+      fs.readFile(this.config.screenshotFolder + baseImage, (err, data) => {
+          if(err) throw err;
+          let base64data = new Buffer(data, 'binary');
+          const params = {
+              Bucket: bucketName,
+              Key: `output/${baseImage}`,
+              Body: base64data
+          };
+          s3.upload(params, (uerr, data) => {
+              if(uerr) throw uerr;
+              console.log(`Screenshot Image uploaded successfully at ${data.Location}`);
+          });
+      });
+      fs.readFile(this.config.diffFolder + "Diff_" + baseImage, (err, data) => {
+          if(err) console.log("Diff image not generated");
+          else {
+              let base64data = new Buffer(data, 'binary');
+              const params = {
+                  Bucket: bucketName,
+                  Key: `diff/Diff_${baseImage}`,
+                  Body: base64data
+              };
+              s3.upload(params, (uerr, data) => {
+                  if(uerr) throw uerr;
+                  console.log(`Diff Image uploaded successfully at ${data.Location}`)
+              });
+          }
+      });
+      if(ifBaseImage) {
+          fs.readFile(this.config.baseFolder + baseImage, (err, data) => {
+              if(err) throw err;
+              else {
+                  let base64data = new Buffer(data, 'binary');
+                  const params = {
+                      Bucket: bucketName,
+                      Key: `base/${baseImage}`,
+                      Body: base64data
+                  };
+                  s3.upload(params, (uerr, data) => {
+                      if(uerr) throw uerr;
+                      console.log(`Base Image uploaded at ${data.Location}`)
+                  });
+              }
+          });
+      }
+      else {
+          console.log("Not Uploading base Image");
+      }
+  }
+
+  /**
+   * This method downloads base images from specified bucket into the base folder as mentioned in config file.
+   * @param accessKeyId
+   * @param secretAccessKey
+   * @param region
+   * @param bucketName
+   * @param baseImage
+   * @returns {Promise<void>}
+   */
+
+  _download(accessKeyId, secretAccessKey, region, bucketName, baseImage) {
+      console.log("Starting Download...");
+      const s3 = new AWS.S3({
+          accessKeyId: accessKeyId,
+          secretAccessKey: secretAccessKey,
+          region: region
+      });
+      const params = {
+          Bucket: bucketName,
+          Key: `base/${baseImage}`
+      };
+      return new Promise((resolve, reject) => {
+          s3.getObject(params, (err, data) => {
+              if(err) console.error(err);
+              console.log(this.config.baseFolder + baseImage);
+              fs.writeFileSync(this.config.baseFolder + baseImage, data.Body);
+              resolve("File Downloaded Successfully");
+          });
+      });
   }
 
   /**
@@ -123,6 +223,12 @@ class ResembleHelper extends Helper {
       options.tolerance = 0;
     }
 
+    const awsC = this.config.aws;
+
+    if (awsC !== undefined && options.prepareBaseImage === false) {
+        await this._download(awsC.accessKeyId, awsC.secretAccessKey, awsC.region, awsC.bucketName, baseImage);
+    }
+
     if (options.prepareBaseImage !== undefined && options.prepareBaseImage) {
       await this._prepareBaseImage(baseImage);
     }
@@ -131,6 +237,11 @@ class ResembleHelper extends Helper {
 
     this._addAttachment(baseImage, misMatch, options.tolerance);
 
+    if(awsC !== undefined) {
+        let ifUpload = options.prepareBaseImage === false ? false : true;
+        await this._upload(awsC.accessKeyId, awsC.secretAccessKey, awsC.region, awsC.bucketName, baseImage, ifUpload)
+    }
+
     this.debug("MisMatch Percentage Calculated is " + misMatch);
     assert(misMatch <= options.tolerance, "MissMatch Percentage " + misMatch);
   }
@@ -150,6 +261,12 @@ class ResembleHelper extends Helper {
       options.tolerance = 0;
     }
 
+    const awsC = this.config.aws;
+
+    if (awsC !== undefined && options.prepareBaseImage === false) {
+        await this._download(awsC.accessKeyId, awsC.secretAccessKey, awsC.region, awsC.bucketName, baseImage);
+    }
+
     if (options.prepareBaseImage !== undefined && options.prepareBaseImage) {
       await this._prepareBaseImage(baseImage);
     }
@@ -158,6 +275,11 @@ class ResembleHelper extends Helper {
     const misMatch = await this._fetchMisMatchPercentage(baseImage, options);
 
     this._addAttachment(baseImage, misMatch, options.tolerance);
+    
+    if(awsC !== undefined) {
+        let ifUpload = options.prepareBaseImage === false ? false : true;
+        await this._upload(awsC.accessKeyId, awsC.secretAccessKey, awsC.region, awsC.bucketName, baseImage, ifUpload)
+    }
 
     this.debug("MisMatch Percentage Calculated is " + misMatch);
     assert(misMatch <= options.tolerance, "MissMatch Percentage " + misMatch);

package.json

@@ -12,7 +12,8 @@
     "mz": "^2.7.0",
     "resemblejs": "^3.0.0",
     "mkdirp": "^0.5.1",
-    "path": "^0.12.7"
+    "path": "^0.12.7",
+    "aws-sdk": "^2.476.0"
   },
   "keywords": [
     "codeceptJS",