Merge pull request #269 from NativeScript/zbranzov/default-tolerance

chore: add the ability to set global tolerance and toleranceType

Author: Zdravko

lib/appium-driver.d.ts

@@ -23,6 +23,8 @@ export declare class AppiumDriver {
     private _isAlive;
     private _locators;
     private _storageByPlatform;
+    private _defaultToleranceType;
+    private _defaultTolerance;
     private constructor();
     readonly imageHelper: ImageHelper;
     defaultWaitTime: number;
@@ -36,6 +38,8 @@ export declare class AppiumDriver {
     readonly isAndroid: boolean;
     readonly isIOS: boolean;
     readonly driver: any;
+    defaultToleranceType: ImageOptions;
+    defaultTolerance: number;
     /**
     * Get the storage where test results from image comparison is logged. The path should be reports/app nam/device name
     */

lib/appium-driver.ts

@@ -57,6 +57,8 @@ export class AppiumDriver {
     private _isAlive: boolean = false;
     private _locators: Locator;
     private _storageByPlatform: string;
+    private _defaultToleranceType: ImageOptions = ImageOptions.percent;
+    private _defaultTolerance: number = 0;
 
     private constructor(private _driver: any, private _wd, private _webio: any, private _driverConfig, private _args: INsCapabilities) {
         this._elementHelper = new ElementHelper(this._args);
@@ -118,6 +120,22 @@ export class AppiumDriver {
         return this._driver;
     }
 
+    get defaultToleranceType(): ImageOptions {
+        return this._defaultToleranceType;
+    }
+
+    set defaultToleranceType(toleranceType: ImageOptions) {
+        this._defaultToleranceType = toleranceType;
+    }
+
+    get defaultTolerance(): number {
+        return this._defaultTolerance;
+    }
+
+    set defaultTolerance(tolerance: number) {
+        this._defaultTolerance = tolerance;
+    }
+
     /**
     * Get the storage where test results from image comparison is logged. The path should be reports/app nam/device name
     */
@@ -601,11 +619,11 @@ export class AppiumDriver {
         return await this.driver.getSessionId();
     }
 
-    public async compareElement(element: UIElement, imageName?: string, tolerance: number = 0, timeOutSeconds: number = 3, toleranceType: ImageOptions = ImageOptions.percent) {
+    public async compareElement(element: UIElement, imageName?: string, tolerance: number = this._defaultTolerance, timeOutSeconds: number = 3, toleranceType: ImageOptions = this._defaultToleranceType) {
         return await this.compareRectangle(await element.getActualRectangle(), imageName, timeOutSeconds, tolerance, toleranceType);
     }
 
-    public async compareRectangle(rect: IRectangle, imageName?: string, timeOutSeconds: number = 3, tolerance: number = 0, toleranceType: ImageOptions = ImageOptions.percent) {
+    public async compareRectangle(rect: IRectangle, imageName?: string, timeOutSeconds: number = 3, tolerance: number = this._defaultTolerance, toleranceType: ImageOptions = this._defaultToleranceType) {
         imageName = imageName || this.imageHelper.testName;
         const options = this.imageHelper.extendOptions({
             imageName: imageName,
@@ -619,7 +637,7 @@ export class AppiumDriver {
         return await this.imageHelper.compare(options);
     }
 
-    public async compareScreen(imageName?: string, timeOutSeconds: number = 3, tolerance: number = 0, toleranceType: ImageOptions = ImageOptions.percent) {
+    public async compareScreen(imageName?: string, timeOutSeconds: number = 3, tolerance: number = this._defaultTolerance, toleranceType: ImageOptions = this._defaultToleranceType) {
         imageName = imageName || this.imageHelper.testName;
         const options = this.imageHelper.extendOptions({
             imageName: imageName,