Merge pull request #124 from codeceptjs/1.9.7

1.9.7 Release Merge

Author: sharath2106

README.md

@@ -184,6 +184,28 @@ The resultant output image will be uploaded in a folder named "*output*" and dif
 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.
 
+### Other S3 Providers
+The same configuration as above, but with *endpoint* field:
+
+```json
+{
+    "helpers": {
+        "ResembleHelper" : {
+            "require": "codeceptjs-resemblehelper",
+            "baseFolder": "<location of base folder>",
+            "diffFolder": "<location of diff folder>",
+            "aws": {
+                "accessKeyId" : "<Your AccessKeyId>",
+                "secretAccessKey": "<Your secretAccessKey>",
+                "region": "<Region of Bucket>",
+                "bucketName": "<Bucket Name>",
+                "endpoint": "<Endpoint of Bucket>"
+            }
+        }
+    }
+}
+```
+
 ### Compare with custom image
 Usually, every screenshot needs to have the same filename as an existing image inside the `baseFolder` directory. To change this behavior, you can use the `compareWithImage` option and specify a different image inside the `baseFolder` directory.
 

index.d.ts

@@ -3,21 +3,50 @@ export = ResembleHelper;
  * Resemble.js helper class for CodeceptJS, this allows screen comparison
  * @author Puneet Kala
  */
+declare class Endpoint {
+    /**
+     * Constructs a new endpoint given an endpoint URL.
+     */
+    constructor(url: string);
+
+    /**
+     * The host portion of the endpoint including the port, e.g., example.com:80.
+     */
+    host: string;
+    /**
+     * The host portion of the endpoint, e.g., example.com.
+     */
+    hostname: string;
+    /**
+     * The full URL of the endpoint.
+     */
+    href: string;
+    /**
+     * The port of the endpoint.
+     */
+    port: number;
+    /**
+     * The protocol (http or https) of the endpoint URL.
+     */
+    protocol: string;
+}
+
 declare class ResembleHelper {
     constructor(config: any);
     baseFolder: any;
     diffFolder: any;
     screenshotFolder: string;
     prepareBaseImage: any;
     resolvePath(folderPath: any): any;
+    _resolveRelativePath(folderPath: any): any;
     /**
      * Compare Images
      *
      * @param image
      * @param options
      * @returns {Promise<resolve | reject>}
      */
-    _compareImages(image: any, options: any): Promise<any | any>;
+    _compareImages(image: any, options: any): Promise<resolve | reject>;
     /**
      *
      * @param image
@@ -57,9 +86,10 @@ declare class ResembleHelper {
      * @param bucketName
      * @param baseImage
      * @param options
+     * @param {string | Endpoint } [endpoint]
      * @returns {Promise<void>}
      */
-    _upload(accessKeyId: any, secretAccessKey: any, region: any, bucketName: any, baseImage: any, options: any): Promise<void>;
+    _upload(accessKeyId: any, secretAccessKey: any, region: any, bucketName: any, baseImage: any, options: any, endpoint?: string | Endpoint): Promise<void>;
     /**
      * This method downloads base images from specified bucket into the base folder as mentioned in config file.
      * @param accessKeyId
@@ -68,9 +98,10 @@ declare class ResembleHelper {
      * @param bucketName
      * @param baseImage
      * @param options
+     * @param {string | Endpoint } [endpoint]
      * @returns {Promise<void>}
      */
-    _download(accessKeyId: any, secretAccessKey: any, region: any, bucketName: any, baseImage: any, options: any): Promise<void>;
+    _download(accessKeyId: any, secretAccessKey: any, region: any, bucketName: any, baseImage: any, options: any, endpoint?: string | Endpoint): Promise<void>;
     /**
      * Check Visual Difference for Base and Screenshot Image
      * @param baseImage         Name of the Base Image (Base Image path is taken from Configuration)

index.js

@@ -41,7 +41,7 @@ class ResembleHelper extends Helper {
       absolutePathOfReportFolder = Container.mocha().options.reporterOptions.reportDir;
     }
     // support mocha-multi-reporters
-    if (Container.mocha() && typeof Container.mocha().options.reporterOptions.mochawesomeReporterOptions.reportDir !== 'undefined') {
+    if (Container.mocha() && typeof Container.mocha().options.reporterOptions.mochawesomeReporterOptions?.reportDir !== 'undefined') {
       absolutePathOfReportFolder = Container.mocha().options.reporterOptions.mochawesomeReporterOptions.reportDir;
     }
     return path.relative(absolutePathOfReportFolder, absolutePathOfImage);
@@ -78,7 +78,7 @@ class ResembleHelper extends Helper {
 
     return new Promise((resolve, reject) => {
 
-      if (options.outputSettings) {
+      if (!options.outputSettings) {
         options.outputSettings = {};
       }
       if (typeof options.needsSameDimension === 'undefined') {
@@ -93,7 +93,7 @@ class ResembleHelper extends Helper {
       this.debug("Tolerance Level Provided " + options.tolerance);
       const tolerance = options.tolerance;
 
-      resemble.compare(baseImage, actualImage, options, (err, data) => {
+      resemble.compare(actualImage, baseImage, options, (err, data) => {
         if (err) {
           reject(err);
         } else {
@@ -191,11 +191,11 @@ class ResembleHelper extends Helper {
 
     if (mocha !== undefined && misMatch >= options.tolerance) {
       await mocha.addMochawesomeContext("Base Image");
-      await mocha.addMochawesomeContext(this.resolveImagePathRelativeFromReport(this._getBaseImagePath(baseImage, options)));
+      await mocha.addMochawesomeContext(this._resolveRelativePath(this._getBaseImagePath(baseImage, options)));
       await mocha.addMochawesomeContext("ScreenShot Image");
-      await mocha.addMochawesomeContext(this.resolveImagePathRelativeFromReport(this._getActualImagePath(baseImage)));
+      await mocha.addMochawesomeContext(this._resolveRelativePath(this._getActualImagePath(baseImage)));
       await mocha.addMochawesomeContext("Diff Image");
-      await mocha.addMochawesomeContext(this.resolveImagePathRelativeFromReport(this._getDiffImagePath(baseImage)));
+      await mocha.addMochawesomeContext(this._resolveRelativePath(this._getDiffImagePath(baseImage)));
     }
   }
 
@@ -208,15 +208,17 @@ class ResembleHelper extends Helper {
    * @param bucketName
    * @param baseImage
    * @param options
+   * @param {string | Endpoint } [endpoint]
    * @returns {Promise<void>}
    */
 
-  async _upload(accessKeyId, secretAccessKey, region, bucketName, baseImage, options) {
+  async _upload(accessKeyId, secretAccessKey, region, bucketName, baseImage, options, endpoint) {
     console.log("Starting Upload... ");
     const s3 = new AWS.S3({
       accessKeyId: accessKeyId,
       secretAccessKey: secretAccessKey,
-      region: region
+      region: region,
+      endpoint: endpoint
     });
     fs.readFile(this._getActualImagePath(baseImage), (err, data) => {
       if (err) throw err;
@@ -279,16 +281,18 @@ class ResembleHelper extends Helper {
    * @param bucketName
    * @param baseImage
    * @param options
+   * @param {string | Endpoint } [endpoint]
    * @returns {Promise<void>}
    */
 
-  _download(accessKeyId, secretAccessKey, region, bucketName, baseImage, options) {
+  _download(accessKeyId, secretAccessKey, region, bucketName, baseImage, options, endpoint) {
     console.log("Starting Download...");
     const baseImageName = this._getBaseImageName(baseImage, options);
     const s3 = new AWS.S3({
       accessKeyId: accessKeyId,
       secretAccessKey: secretAccessKey,
-      region: region
+      region: region,
+      endpoint: endpoint
     });
     const params = {
       Bucket: bucketName,
@@ -337,17 +341,18 @@ class ResembleHelper extends Helper {
     if (this._getPrepareBaseImage(options)) {
       await this._prepareBaseImage(baseImage, options);
     } else if (awsC !== undefined) {
-      await this._download(awsC.accessKeyId, awsC.secretAccessKey, awsC.region, awsC.bucketName, baseImage, options);
+      await this._download(awsC.accessKeyId, awsC.secretAccessKey, awsC.region, awsC.bucketName, baseImage, options, awsC.endpoint);
     }
 
-    if (selector) {
+    // BoundingBox for Playwright not necessary
+    if (selector && !this.helpers['Playwright']) {
       options.boundingBox = await this._getBoundingBox(selector);
     }
     const misMatch = await this._fetchMisMatchPercentage(baseImage, options);
-    this._addAttachment(baseImage, misMatch, options);
-    this._addMochaContext(baseImage, misMatch, options);
+    await this._addAttachment(baseImage, misMatch, options);
+    await this._addMochaContext(baseImage, misMatch, options);
     if (awsC !== undefined) {
-      await this._upload(awsC.accessKeyId, awsC.secretAccessKey, awsC.region, awsC.bucketName, baseImage, options)
+      await this._upload(awsC.accessKeyId, awsC.secretAccessKey, awsC.region, awsC.bucketName, baseImage, options, awsC.endpoint)
     }
 
     this.debug("MisMatch Percentage Calculated is " + misMatch + " for baseline " + baseImage);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs-resemblehelper",
-  "version": "1.9.6",
+  "version": "1.9.7",
   "description": "Resemble Js helper for CodeceptJS, with Support for Playwright, Webdriver, TestCafe, Puppeteer & Appium",
   "repository": {
     "type": "git",