chore: switch tolerance of compare methods to percent and prevent cre… (#91)

* chore: switch tolerance of compare methods to percent and prevent creating image for sauce labs runs.

* fix: a typo and do small refactoring

* chore: bump version

Author: Zdravko

lib/appium-driver.d.ts

@@ -8,6 +8,7 @@ import { INsCapabilities } from "./interfaces/ns-capabilities";
 import { IRectangle } from "./interfaces/rectangle";
 import { Point } from "./point";
 import { ImageHelper } from "./image-helper";
+import { ImageOptions } from "./image-options";
 export declare class AppiumDriver {
     private _driver;
     private _wd;
@@ -24,7 +25,7 @@ export declare class AppiumDriver {
     private _logPath;
     private _storageByDeviceName;
     private _storageByPlatform;
-    private constructor();
+    private constructor(_driver, _wd, _webio, _driverConfig, _args);
     readonly imageHelper: ImageHelper;
     defaultWaitTime: number;
     readonly capabilities: any;
@@ -128,10 +129,10 @@ export declare class AppiumDriver {
     clickPoint(xCoordinate: number, yCoordinate: number): Promise<void>;
     source(): Promise<any>;
     sessionId(): Promise<any>;
-    compareElement(element: UIElement, imageName: string): Promise<boolean>;
-    compareRectangle(rect: IRectangle, imageName: string, timeOutSeconds?: number, tollerance?: number): Promise<boolean>;
-    compareScreen(imageName: string, timeOutSeconds?: number, tollerance?: number): Promise<boolean>;
-    private compare(imageName, timeOutSeconds?, tollerance?, rect?);
+    compareElement(element: UIElement, imageName: string, tolerance?: number, timeOutSeconds?: number, toleranceType?: ImageOptions): Promise<boolean>;
+    compareRectangle(rect: IRectangle, imageName: string, timeOutSeconds?: number, tolerance?: number, toleranceType?: ImageOptions): Promise<boolean>;
+    compareScreen(imageName: string, timeOutSeconds?: number, tolerance?: number, toleranceType?: ImageOptions): Promise<boolean>;
+    private compare(imageName, timeOutSeconds?, tolerance?, rect?, toleranceType?);
     prepareImageToCompare(filePath: string, rect: IRectangle): Promise<void>;
     takeScreenshot(fileName: string): Promise<string>;
     logScreenshot(fileName: string): Promise<string>;

lib/appium-driver.ts

@@ -286,19 +286,19 @@ export class AppiumDriver {
         return await this.driver.getSessionId();
     }
 
-    public async compareElement(element: UIElement, imageName: string, ) {
-        return await this.compareRectangle(await element.getActualRectangle(), imageName);
+    public async compareElement(element: UIElement, imageName: string, tolerance: number = 0.01, timeOutSeconds: number = 3, toleranceType?: ImageOptions) {
+        return await this.compareRectangle(await element.getActualRectangle(), imageName, timeOutSeconds, tolerance, toleranceType);
     }
 
-    public async compareRectangle(rect: IRectangle, imageName: string, timeOutSeconds: number = 3, tollerance: number = 0.01) {
-        return await this.compare(imageName, timeOutSeconds, tollerance, rect);
+    public async compareRectangle(rect: IRectangle, imageName: string, timeOutSeconds: number = 3, tolerance: number = 0.01, toleranceType?: ImageOptions) {
+        return await this.compare(imageName, timeOutSeconds, tolerance, rect, toleranceType);
     }
 
-    public async compareScreen(imageName: string, timeOutSeconds: number = 3, tollerance: number = 0.01) {
-        return await this.compare(imageName, timeOutSeconds, tollerance);
+    public async compareScreen(imageName: string, timeOutSeconds: number = 3, tolerance: number = 0.01, toleranceType?: ImageOptions) {
+        return await this.compare(imageName, timeOutSeconds, tolerance, undefined, toleranceType);
     }
 
-    private async compare(imageName: string, timeOutSeconds: number = 3, tollerance: number = 0.01, rect?: IRectangle) {
+    private async compare(imageName: string, timeOutSeconds: number = 3, tolerance: number = 0.01, rect?: IRectangle, toleranceType?: ImageOptions) {
 
         if (!this._logPath) {
             this._logPath = getReportPath(this._args);
@@ -326,7 +326,7 @@ export class AppiumDriver {
         const pathDiffImage = pathActualImage.replace("actual", "diff");
 
         await this.prepareImageToCompare(pathActualImage, rect);
-        let result = await this._imageHelper.compareImages(pathActualImage, pathExpectedImage, pathDiffImage, tollerance);
+        let result = await this._imageHelper.compareImages(pathActualImage, pathExpectedImage, pathDiffImage, tolerance, toleranceType);
 
         // Iterate
         if (!result) {
@@ -338,7 +338,7 @@ export class AppiumDriver {
                 pathActualImage = await this.takeScreenshot(pathActualImageConter);
 
                 await this.prepareImageToCompare(pathActualImage, rect);
-                result = await this._imageHelper.compareImages(pathActualImage, pathExpectedImage, pathDiffImage, tollerance);
+                result = await this._imageHelper.compareImages(pathActualImage, pathExpectedImage, pathDiffImage, tolerance, toleranceType);
                 counter++;
             }
         } else {

lib/device-controller.ts

@@ -159,6 +159,8 @@ export class DeviceManger implements IDeviceManager {
     }
 
     private static getDefaultDevice(args) {
-        return new Device(args.appiumCaps.deviceName, args.appiumCaps.platformVersion, undefined, args.appiumCaps.platformName, undefined, undefined);
+        let device = new Device(args.appiumCaps.deviceName, args.appiumCaps.platformVersion, undefined, args.appiumCaps.platformName, undefined, undefined);
+        device.config = { "density": args.appiumCaps.density, "offsetPixels": args.appiumCaps.offsetPixels };
+        return device;
     }
 }

lib/image-helper.d.ts

@@ -10,7 +10,7 @@ export declare class ImageHelper {
     blockOutAreas: IRectangle[];
     imageOutputLimit(): ImageOptions;
     thresholdType(): ImageOptions;
-    threshold(): number;
+    threshold(thresholdType: any): 10 | 0.01;
     delta(): number;
     static cropImageDefault(_args: INsCapabilities): {
         x: number;

lib/image-helper.ts

@@ -34,11 +34,15 @@ export class ImageHelper {
     }
 
     public thresholdType() {
-        return ImageOptions.pixel;
+        return ImageOptions.percent;
     }
 
-    public threshold() {
-        return 0.1; // 0.1 percent; 500 percent
+    public threshold(thresholdType) {
+        if (thresholdType == ImageOptions.percent) {
+            return 0.01; // 0.01 = 1 percent; 500 percent
+        } else {
+            return 10; // 10 pixels
+        }
     }
 
     public delta() {
@@ -78,7 +82,7 @@ export class ImageHelper {
         });
     }
 
-    public compareImages(actual: string, expected: string, output: string, valueThreshold: number = this.threshold(), typeThreshold: any = ImageOptions.pixel) {
+    public compareImages(actual: string, expected: string, output: string, valueThreshold: number = this.threshold(this.thresholdType()), typeThreshold: any = this.thresholdType()) {
         const diff = new BlinkDiff({
 
             imageAPath: actual,
@@ -95,6 +99,11 @@ export class ImageHelper {
             verbose: this._args.verbose,
         });
 
+        if (typeThreshold == ImageOptions.percent) {
+            valueThreshold = Math.floor(valueThreshold * 100);
+        }
+
+        console.log("Using " + valueThreshold + " " + typeThreshold + "s tolerance");
         const result = this.runDiff(diff, output);
         this._blockOutAreas = undefined;
         return result;

lib/utils.ts

@@ -236,7 +236,7 @@ export function isWin() {
 
 export function getStorageByDeviceName(args: INsCapabilities) {
     let storage = getStorage(args);
-    const appName = getAppName(args);
+    const appName = resolveSauceLabAppName(getAppName(args));
     storage = createStorageFolder(storage, appName);
     storage = createStorageFolder(storage, args.appiumCaps.deviceName);
 
@@ -250,7 +250,7 @@ export function getStorageByPlatform(args: INsCapabilities) {
         storage = createStorageFolder(storage, "images");
     }
 
-    const appName = getAppName(args);
+    const appName = resolveSauceLabAppName(getAppName(args));
     storage = createStorageFolder(storage, appName);
     storage = createStorageFolder(storage, args.appiumCaps.platformName.toLowerCase());
 
@@ -428,3 +428,6 @@ export const findFreePort = async (retries: number = 10, port: number = 3000, ar
     }
     return p;
 }
+function resolveSauceLabAppName(appName: string) {
+    return appName.includes("sauce-storage:") ? appName.replace("sauce-storage:", "") : appName;
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nativescript-dev-appium",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "A NativeScript plugin to help integrate and run Appium tests",
   "author": "NativeScript",
   "license": "MIT",