feat: provide storage by platform (#68)

Author: SvetoslavTsenov

lib/appium-driver.d.ts

@@ -21,7 +21,8 @@ export declare class AppiumDriver {
     private _isAlive;
     private _locators;
     private _logPath;
-    private _storage;
+    private _storageByDeviceName;
+    private _storageByPlatform;
     private constructor();
     readonly imageHelper: ImageHelper;
     defaultWaitTime: number;

lib/appium-driver.ts

@@ -12,7 +12,8 @@ import { Direction } from "./direction";
 import { Locator } from "./locators";
 import {
     log,
-    getStorage,
+    getStorageByPlatform,
+    getStorageByDeviceName,
     resolve,
     fileExists,
     getAppPath,
@@ -37,7 +38,8 @@ export class AppiumDriver {
     private _isAlive: boolean = false;
     private _locators: Locator;
     private _logPath: string;
-    private _storage: string;
+    private _storageByDeviceName: string;
+    private _storageByPlatform: string;
 
     private constructor(private _driver: any, private _wd, private _webio: any, private _driverConfig, private _args: INsCapabilities) {
         this._elementHelper = new ElementHelper(this._args);
@@ -271,19 +273,31 @@ export class AppiumDriver {
             imageName = imageName.concat(AppiumDriver.pngFileExt);
         }
 
-        if (!this._storage) {
-            this._storage = getStorage(this._args);
+        if (!this._storageByDeviceName) {
+            this._storageByDeviceName = getStorageByDeviceName(this._args);
         }
 
+        let expectedImage = resolve(this._storageByDeviceName, imageName);
+        if (!fileExists(expectedImage)) {
+            if (!this._storageByPlatform) {
+                this._storageByPlatform = getStorageByPlatform(this._args);
+            }  
+            expectedImage = resolve(this._storageByPlatform, imageName);  
+        }
+        
+        if (!fileExists(expectedImage)) {
+            expectedImage = resolve(this._storageByDeviceName, imageName);
+        }
+    
         if (!this._logPath) {
             this._logPath = getReportPath(this._args);
         }
 
-        let expectedImage = resolve(this._storage, imageName);
+        expectedImage = resolve(this._storageByDeviceName, imageName);
 
         // Firts capture of screen when the expected image is not available
         if (!fileExists(expectedImage)) {
-            await this.takeScreenshot(resolve(this._storage, imageName.replace(".", "_actual.")));
+            await this.takeScreenshot(resolve(this._storageByDeviceName, imageName.replace(".", "_actual.")));
             console.log("Remove the 'actual' suffix to continue using the image as expected one ", expectedImage);
             let eventStartTime = Date.now().valueOf();
             let counter = 1;

lib/utils.d.ts

@@ -17,7 +17,8 @@ export declare function killPid(pid: any, verbose: any): void;
 export declare function waitForOutput(process: any, matcher: any, errorMatcher: any, timeout: any, verbose: any): Promise<boolean>;
 export declare function executeCommand(args: any, cwd?: string): string;
 export declare function isWin(): boolean;
-export declare function getStorage(args: INsCapabilities): string;
+export declare function getStorageByDeviceName(args: INsCapabilities): string;
+export declare function getStorageByPlatform(args: INsCapabilities): string;
 export declare function getReportPath(args: INsCapabilities): string;
 export declare function getAppPath(platform: any, runType: any): any;
 export declare function calculateOffset(direction: any, y: number, yOffset: number, x: number, xOffset: number, isIOS: boolean, verbose: any): {

lib/utils.ts

@@ -233,12 +233,37 @@ export function isWin() {
     return /^win/.test(process.platform);
 }
 
-export function getStorage(args: INsCapabilities) {
+
+export function getStorageByDeviceName(args: INsCapabilities) {
+    let storage = getStorage(args);
+    const appName = getAppName(args);
+    storage = createStorageFolder(storage, appName);
+    storage = createStorageFolder(storage, args.appiumCaps.deviceName);
+
+    return storage;
+}
+
+export function getStorageByPlatform(args: INsCapabilities) {
     let storage = args.storage;
     if (!storage) {
         storage = createStorageFolder(resolve(args.projectDir, args.testFolder), "resources");
         storage = createStorageFolder(storage, "images");
     }
+
+    const appName = getAppName(args);
+    storage = createStorageFolder(storage, appName);
+    storage = createStorageFolder(storage, args.appiumCaps.platformName.toLowerCase());
+
+    return storage;
+}
+
+function getStorage(args: INsCapabilities) {
+    let storage = args.storage;
+    if (!storage) {
+        storage = createStorageFolder(resolve(args.projectDir, args.testFolder), "resources");
+        storage = createStorageFolder(storage, "images");
+    }
+
     const appName = getAppName(args);
     storage = createStorageFolder(storage, appName);
     storage = createStorageFolder(storage, args.appiumCaps.deviceName);