chore: add option to provide relative path to the images for comparison. (#152)

The path is relative to resources/images

Author: Zdravko

lib/interfaces/ns-capabilities-args.d.ts

@@ -35,4 +35,5 @@ export interface INsCapabilitiesArgs {
     device?: IDevice;
     automationName?: AutomationName;
     deviceManager?: IDeviceManager;
+    imagesPath?: string;
 }

lib/interfaces/ns-capabilities-args.ts

@@ -36,4 +36,5 @@ export interface INsCapabilitiesArgs {
     device?: IDevice;
     automationName?: AutomationName;
     deviceManager?: IDeviceManager;
+    imagesPath?: string;
 }

lib/ns-capabilities.ts

@@ -39,6 +39,7 @@ export class NsCapabilities implements INsCapabilities {
     private _device: IDevice;
     private _deviceManager: IDeviceManager;
     private _exceptions: Array<string> = new Array();
+    private _imagesPath: string;
 
     constructor(private _parser: INsCapabilitiesArgs) {
         this._projectDir = this._parser.projectDir;
@@ -65,6 +66,7 @@ export class NsCapabilities implements INsCapabilities {
         this._wdaLocalPort = this._parser.wdaLocalPort;
         this._path = this._parser.path;
         this._capabilitiesName = this._parser.capabilitiesName;
+        this._imagesPath = this._parser.imagesPath;
     }
 
     get path() { return this._path; }
@@ -107,6 +109,7 @@ export class NsCapabilities implements INsCapabilities {
     get deviceManager() { return this._deviceManager; }
     set deviceManager(deviceManager: IDeviceManager) { this._deviceManager = deviceManager; }
     get isValidated() { return this._isValidated; }
+    get imagesPath() { return this._imagesPath; }
     //set isValidated(isValidated: boolean) { this._isValidated = isValidated; }
 
     public extend(args: INsCapabilities) {

lib/parser.d.ts

@@ -1 +1 @@
-export declare const projectDir: string, projectBinary: string, pluginRoot: string, pluginBinary: string, port: number, verbose: boolean, appiumCapsLocation: string, testFolder: string, runType: string, isSauceLab: boolean, appPath: string, storage: string, testReports: string, reuseDevice: boolean, devMode: boolean, ignoreDeviceController: boolean, wdaLocalPort: number, path: string, relaxedSecurity: boolean, cleanApp: boolean, attachToDebug: boolean, sessionId: string, startSession: boolean, capabilitiesName: string;
+export declare const projectDir: string, projectBinary: string, pluginRoot: string, pluginBinary: string, port: number, verbose: boolean, appiumCapsLocation: string, testFolder: string, runType: string, isSauceLab: boolean, appPath: string, storage: string, testReports: string, reuseDevice: boolean, devMode: boolean, ignoreDeviceController: boolean, wdaLocalPort: number, path: string, relaxedSecurity: boolean, cleanApp: boolean, attachToDebug: boolean, sessionId: string, startSession: boolean, capabilitiesName: string, imagesPath: string;

lib/parser.ts

@@ -25,6 +25,7 @@ const config = (() => {
         .option("devMode", { alias: "dev-mode", describe: "Will skipp app instalation and will reuse the one installed on device!", type: "boolean", default: false })
         .option("ignoreDeviceController", { alias: "i-ns-device-controller", describe: "Use default appium options for running emulatos/ simulators.", type: "boolean", default: false })
         .option("cleanApp", { alias: "c", describe: "Uninstall app after test are finished", type: "boolean", default: false })
+        .option("imagesPath", { describe: "comparison images path relative to resources/images", type: "string" })
         .help()
         .argv;
 
@@ -89,6 +90,7 @@ const config = (() => {
         sessionId: options.sessionId,
         startSession: options.startSession,
         capabilitiesName: options.capabilitiesName,
+        imagesPath: options.imagesPath || process.env.npm_config_imagesPath
     };
 
     return config;
@@ -118,5 +120,6 @@ export const {
     attachToDebug,
     sessionId,
     startSession,
-    capabilitiesName
+    capabilitiesName,
+    imagesPath
 }: INsCapabilitiesArgs = config;

lib/utils.ts

@@ -243,9 +243,13 @@ const getDeviceName = (args) => {
 
 export function getStorageByDeviceName(args: INsCapabilities) {
     let storage = getStorage(args);
+    if(args.imagesPath){
+        const segments = args.imagesPath.split(/[\/\\]+/);
+        storage = path.join(storage, segments.join(path.sep));
+        return storage;
+    }
     const appName = resolveSauceLabAppName(getAppName(args));
     storage = createStorageFolder(storage, appName);
-
     storage = createStorageFolder(storage, getDeviceName(args));
 
     return storage;
@@ -427,8 +431,8 @@ export async function scroll(wd, driver, direction: Direction, isIOS: boolean, y
     await driver.sleep(150);
 }
 
-function createStorageFolder(storage, direcotry) {
-    storage = resolve(storage, direcotry);
+function createStorageFolder(storage, directory) {
+    storage = resolve(storage, directory);
     if (!fileExists(storage)) {
         fs.mkdirSync(storage);
     }