add option for derivedDataPath

Author: SvetoslavTsenov

lib/appium-driver.ts

@@ -30,7 +30,8 @@ import {
     encodeImageToBase64,
     ensureReportsDirExists,
     checkImageLogType,
-    adbShellCommand
+    adbShellCommand,
+    logWarn
 } from "./utils";
 
 import { INsCapabilities } from "./interfaces/ns-capabilities";
@@ -280,6 +281,8 @@ export class AppiumDriver {
                     }
                 } catch (error) {
                     args.verbose = true;
+                    console.log("===============================");
+                    console.log("", error)
                     if (!args.ignoreDeviceController && error && error.message && error.message.includes("Failure [INSTALL_FAILED_INSUFFICIENT_STORAGE]")) {
                         await DeviceManager.kill(args.device);
                         await DeviceController.startDevice(args.device);
@@ -303,11 +306,11 @@ export class AppiumDriver {
                 console.log("Retry launching appium driver!");
                 hasStarted = false;
 
-                if (error && error.message && error.message.includes("WebDriverAgent")) {
-                    const freePort = await findFreePort(100, args.wdaLocalPort);
-                    console.log("args.appiumCaps['wdaLocalPort']", freePort);
-                    args.appiumCaps["wdaLocalPort"] = freePort;
-                }
+                // if (error && error.message && error.message.includes("WebDriverAgent")) {
+                //     const freePort = await findFreePort(100, args.wdaLocalPort);
+                //     console.log("args.appiumCaps['wdaLocalPort']", freePort);
+                //     args.appiumCaps["wdaLocalPort"] = freePort;
+                // }
             }
 
             if (hasStarted) {
@@ -883,7 +886,7 @@ export class AppiumDriver {
         }
     }
 
-    private static async applyAdditionalSettings(args) {
+    private static async applyAdditionalSettings(args: INsCapabilities) {
         if (args.isSauceLab) return;
 
         args.appiumCaps['udid'] = args.appiumCaps['udid'] || args.device.token;
@@ -900,6 +903,11 @@ export class AppiumDriver {
             args.appiumCaps["wdaStartupRetries"] = 5;
             args.appiumCaps["shouldUseSingletonTestManager"] = args.appiumCaps.shouldUseSingletonTestManager;
 
+            if (args.derivedDataPath) {
+                args.appiumCaps["derivedDataPath"] = `${args.derivedDataPath}/${args.device.token}`;
+                logWarn('Changed derivedDataPath to: ', args.appiumCaps["derivedDataPath"]);
+            }
+
             // It looks we need it for XCTest (iOS 10+ automation)
             if (args.appiumCaps.platformVersion >= 10 && args.wdaLocalPort) {
                 console.log(`args.appiumCaps['wdaLocalPort']: ${args.wdaLocalPort}`);

lib/device-manager.d.ts

@@ -13,7 +13,7 @@ export declare class DeviceManager implements IDeviceManager {
     static getInstalledApps(device: IDevice): Promise<string[]>;
     static getDefaultDevice(args: INsCapabilities, deviceName?: string, token?: string, type?: DeviceType, platformVersion?: number): IDevice;
     private static convertViewportRectToIRectangle;
-    static applyAppiumSessionInfoDetails(args: INsCapabilities, sessionInfoDetails: any): IDevice;
+    static applyAppiumSessionInfoDetails(args: INsCapabilities, sessionInfoDetails: any): any;
     static setDontKeepActivities(args: INsCapabilities, driver: any, value: any): Promise<void>;
     static executeShellCommand(driver: any, commandArgs: {
         command: string;

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

@@ -4,6 +4,7 @@ import { AutomationName } from "../automation-name";
 import { ITestReporter } from "./test-reporter";
 import { LogImageType } from "../enums/log-image-type";
 export interface INsCapabilitiesArgs {
+    derivedDataPath?: string;
     port?: number;
     wdaLocalPort?: number;
     projectDir?: string;

lib/interfaces/ns-capabilities-args.ts

@@ -5,6 +5,7 @@ import { ITestReporter } from "./test-reporter";
 import { LogImageType } from "../enums/log-image-type";
 
 export interface INsCapabilitiesArgs {
+    derivedDataPath?: string;
     port?: number;
     wdaLocalPort?: number;
     projectDir?: string;

lib/ns-capabilities.d.ts

@@ -47,6 +47,7 @@ export declare class NsCapabilities implements INsCapabilities {
     deviceTypeOrPlatform: string;
     driverConfig: any;
     logImageTypes: Array<LogImageType>;
+    derivedDataPath: string;
     constructor(_parser: INsCapabilitiesArgs);
     readonly isAndroid: any;
     readonly isIOS: boolean;

lib/ns-capabilities.ts

@@ -53,6 +53,7 @@ export class NsCapabilities implements INsCapabilities {
     public deviceTypeOrPlatform: string;
     public driverConfig: any;
     public logImageTypes: Array<LogImageType>;
+    public derivedDataPath: string;
 
     constructor(private _parser: INsCapabilitiesArgs) {
         this.projectDir = this._parser.projectDir;
@@ -76,6 +77,7 @@ export class NsCapabilities implements INsCapabilities {
         this.isSauceLab = this._parser.isSauceLab;
         this.ignoreDeviceController = this._parser.ignoreDeviceController;
         this.wdaLocalPort = this._parser.wdaLocalPort;
+        this.derivedDataPath = this._parser.derivedDataPath;
         this.path = this._parser.path;
         this.capabilitiesName = this._parser.capabilitiesName;
         this.imagesPath = this._parser.imagesPath;

lib/parser.d.ts

@@ -1,2 +1,2 @@
 import { LogImageType } from "./enums/log-image-type";
-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, devMode: boolean, ignoreDeviceController: boolean, wdaLocalPort: number, path: string, relaxedSecurity: boolean, cleanApp: boolean, attachToDebug: boolean, sessionId: string, startSession: boolean, capabilitiesName: string, imagesPath: string, startDeviceOptions: string, deviceTypeOrPlatform: string, device: import("mobile-devices-controller/lib/device").IDevice, driverConfig: any, logImageTypes: LogImageType[], appiumCaps: any;
+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, devMode: boolean, ignoreDeviceController: boolean, wdaLocalPort: number, derivedDataPath: string, path: string, relaxedSecurity: boolean, cleanApp: boolean, attachToDebug: boolean, sessionId: string, startSession: boolean, capabilitiesName: string, imagesPath: string, startDeviceOptions: string, deviceTypeOrPlatform: string, device: any, driverConfig: any, logImageTypes: LogImageType[], appiumCaps: any;

lib/parser.ts

@@ -64,6 +64,9 @@ const config = (() => {
             type: "string"
         })
         .option("wdaLocalPort", { alias: "wda", describe: "WDA port", type: "number" })
+        .options("derivedDataPath", { 
+            describe: "set the unique derived data path root for each driver instance. This will help to avoid possible conflicts and to speed up the parallel execution", 
+            type: "string" })
         .option("verbose", { alias: "v", describe: "Log actions", type: "boolean" })
         .option("path", { describe: "Execution path", default: process.cwd(), type: "string" })
         .option("relaxedSecurity", { describe: "appium relaxedSecurity", default: false, type: "boolean" })
@@ -160,6 +163,7 @@ const config = (() => {
         pluginRoot: pluginRoot,
         pluginBinary: pluginBinary,
         wdaLocalPort: options.wdaLocalPort || process.env.npm_config_wdaLocalPort || process.env["WDA_LOCAL_PORT"] || 8410,
+        derivedDataPath: options.derivedDataPath || process.env.npm_config_derivedDataPath || process.env["DERIVED_DATA_PATH"],
         testFolder: options.testFolder || process.env.npm_config_testFolder || "e2e",
         runType: options.runType || process.env.npm_config_runType,
         appiumCapsLocation: options.appiumCapsLocation || process.env.npm_config_appiumCapsLocation || join(projectDir, options.testFolder, "config", options.capabilitiesName),
@@ -208,6 +212,7 @@ export const {
     devMode,
     ignoreDeviceController,
     wdaLocalPort,
+    derivedDataPath,
     path,
     relaxedSecurity,
     cleanApp,