refactor: remove --reuseDevice option (#182)

SvetoslavTsenov · web-flow · commit 5c40e3bc3322 · 2018-12-19T15:53:59.000+02:00
BREAKING CHANGES:

There will be no longer --reuseDevice option available. From now on will be preserved options from appium caps "fullReset"

Migration steps:
To reuse device set in your Appium capabilities file &lt;b&gt;"fullReset": false&lt;/b&gt;
Not to reuse device set &lt;b&gt;"fullReset": true&lt;/b&gt;
diff --git a/index.ts b/index.ts
@@ -83,8 +83,9 @@ export async function stopServer() {
         await appiumServer.stop();
     }
 
-    if (nsCapabilities.cleanApp) {
+    if (nsCapabilities.cleanApp && !nsCapabilities.ignoreDeviceController) {
         await DeviceController.uninstallApp(nsCapabilities.device, nsCapabilities.appPath);
+        logInfo("Application from device is uninstalled.")
     }
 };
 
diff --git a/lib/device-manager.d.ts b/lib/device-manager.d.ts
@@ -1,6 +1,6 @@
 import { INsCapabilities } from "./interfaces/ns-capabilities";
 import { IDeviceManager } from "./interfaces/device-manager";
-import { IDevice, DeviceType } from "mobile-devices-controller";
+import { IDevice, Device, DeviceType } from "mobile-devices-controller";
 export declare class DeviceManager implements IDeviceManager {
     private static _emulators;
     constructor();
@@ -9,7 +9,7 @@ export declare class DeviceManager implements IDeviceManager {
     installApp(args: INsCapabilities): Promise<any>;
     uninstallApp(args: INsCapabilities): Promise<any>;
     static kill(device: IDevice): Promise<void>;
-    static getDefaultDevice(args: INsCapabilities, deviceName?: string, token?: string, type?: DeviceType, platformVersion?: number): any;
+    static getDefaultDevice(args: INsCapabilities, deviceName?: string, token?: string, type?: DeviceType, platformVersion?: number): Device;
     static setDontKeepActivities(args: INsCapabilities, driver: any, value: any): Promise<void>;
     static executeShellCommand(driver: any, commandAndargs: {
         command: string;
diff --git a/lib/image-helper.d.ts b/lib/image-helper.d.ts
@@ -10,7 +10,7 @@ export declare class ImageHelper {
     blockOutAreas: IRectangle[];
     imageOutputLimit(): ImageOptions;
     thresholdType(): ImageOptions;
-    threshold(thresholdType: any): 10 | 0.01;
+    threshold(thresholdType: any): 0.01 | 10;
     delta(): number;
     static cropImageDefault(_args: INsCapabilities): {
         x: number;
diff --git a/lib/ns-capabilities.ts b/lib/ns-capabilities.ts
@@ -58,7 +58,6 @@ export class NsCapabilities implements INsCapabilities {
         this._testFolder = this._parser.testFolder;
         this._storage = this._parser.storage;
         this._testReports = this._parser.testReports;
-        this._reuseDevice = this._parser.reuseDevice;
         this._devMode = this._parser.devMode;
         this._runType = this._parser.runType;
         this._isSauceLab = this._parser.isSauceLab;
@@ -116,7 +115,7 @@ export class NsCapabilities implements INsCapabilities {
     //set isValidated(isValidated: boolean) { this._isValidated = isValidated; }
 
     setAutomationNameFromString(automationName: String) {
-        const key  = Object.keys(AutomationName).filter((v,i,a) => v.toLowerCase() === automationName.toLowerCase());
+        const key = Object.keys(AutomationName).filter((v, i, a) => v.toLowerCase() === automationName.toLowerCase());
         this._automationName = AutomationName[key[0]];
     }
 
@@ -134,6 +133,7 @@ export class NsCapabilities implements INsCapabilities {
         if (this._attachToDebug || this._sessionId) {
             this._isValidated = true;
         }
+
         if (!this._attachToDebug && !this._sessionId) {
             this._appiumCaps = resolveCapabilities(this.appiumCapsLocation, this.runType, this.projectDir, this._capabilitiesName);
 
@@ -151,10 +151,15 @@ export class NsCapabilities implements INsCapabilities {
     private isAndroidPlatform() { return this._appiumCaps && this._appiumCaps ? this._appiumCaps.platformName.toLowerCase().includes("android") : undefined; }
 
     private shouldSetFullResetOption() {
-        if (this._ignoreDeviceController) {
-            this.appiumCaps["fullReset"] = true;
-            this.appiumCaps["noReset"] = false;
-            logInfo("Changing appium setting fullReset: true and noReset: false ");
+        if (!this._ignoreDeviceController) {
+            this._reuseDevice = !this.appiumCaps["fullReset"];
+            this.appiumCaps["fullReset"] = false;
+            if(!this.reuseDevice){
+                logWarn("The started device will be killed after the session!");
+                logInfo("To avoid it, set 'fullReset: false' in appium capabilities.");
+            }
+
+            this._cleanApp = !this.appiumCaps["noReset"];
         }
 
         if (this._attachToDebug || this._devMode) {
diff --git a/lib/parser.d.ts b/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, imagesPath: 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, devMode: boolean, ignoreDeviceController: boolean, wdaLocalPort: number, path: string, relaxedSecurity: boolean, cleanApp: boolean, attachToDebug: boolean, sessionId: string, startSession: boolean, capabilitiesName: string, imagesPath: string;
diff --git a/lib/parser.ts b/lib/parser.ts
@@ -5,26 +5,82 @@ import { INsCapabilitiesArgs } from "./interfaces/ns-capabilities-args";
 
 const config = (() => {
     const options = yargs
-        .option("runType", { describe: "Path to excute command.", type: "string", default: null })
-        .option("testFolder", { describe: "e2e test folder name", default: "e2e", type: "string" })
-        .option("appiumCapsLocation", { describe: "Capabilities", type: "string" })
-        .option("sauceLab", { describe: "SauceLab", default: false, type: "boolean" })
-        .option("port", { alias: "p", describe: "Appium port", type: "number"})
-        .option("attachToDebug", { alias: "a", describe: "Attach to appium desktop app.", default: false, type: "boolean" })
-        .option("capabilitiesName", { describe: "Capabilities file name", default: "appium.capabilities.json", type: "string" })
-        .option("sessionId", { alias: "s", describe: "Session to attach", default: false, type: "string" })
-        .option("startSession", { describe: "Start session.", default: false, type: "boolean" })
+        .option("runType",
+            {
+                describe: "Which option to use from appium capabilities.json",
+                type: "string"
+            })
+        .option("testFolder",
+            {
+                describe: "e2e test folder name",
+                default: "e2e",
+                type: "string"
+            })
+        .option("appiumCapsLocation",
+            {
+                describe: "Custom capabilities location",
+                type: "string"
+            })
+        .option("sauceLab",
+            {
+                describe: "Use it mandatory for sauceLab run!",
+                default: false,
+                type: "boolean"
+            })
+        .option("port",
+            {
+                alias: "p",
+                describe: "Appium port",
+                type: "number"
+            })
+        .option("attachToDebug",
+            {
+                alias: "a",
+                describe: "Attach to appium desktop application. Will use first met session!",
+                default: false,
+                type: "boolean"
+            })
+        .option("capabilitiesName",
+            {
+                describe: "Capabilities file name",
+                default: "appium.capabilities.json",
+                type: "string"
+            })
+        .option("startSession",
+            {
+                describe: "Start session. This option will start a new session can be reused for tests!",
+                default: false,
+                type: "boolean"
+            })
+        .option("sessionId", {
+            alias: "s",
+            describe: "Provide session id which you want to attach",
+            default: false,
+            type: "string"
+        })
         .option("wdaLocalPort", { alias: "wda", describe: "WDA port", type: "number" })
         .option("verbose", { alias: "v", describe: "Log actions", type: "boolean" })
-        .option("path", { describe: "path", default: process.cwd(), type: "string" })
+        .option("path", { describe: "Execution path", default: process.cwd(), type: "string" })
         .option("relaxedSecurity", { describe: "appium relaxedSecurity", default: false, type: "boolean" })
         .option("appPath", { describe: "application path", type: "string" })
         .option("storage", { describe: "Storage for images folder.", type: "string" })
         .option("testReports", { describe: "Test reporting folder", type: "string" })
-        .option("reuseDevice", { describe: "Reusing device if available.", type: "boolean", default: false })
-        .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("devMode",
+            {
+                alias: "dev-mode",
+                describe: "Skips app installation and uses the one that should already be installed on device! Good to use during development.",
+                type: "boolean",
+                default: false
+            })
+        .option("ignoreDeviceController",
+            {
+                alias: "idc",
+                describe: `Use default appium options for running emulators/ simulators. Provide this option will not use custom device controller.
+                Device controller is disabled by default when --sauceLab option is provided!`,
+                type: "boolean",
+                default: false
+            })
+        .option("cleanApp", { alias: "c", describe: "Clean app before and after run.", type: "boolean", default: false })
         .option("imagesPath", { describe: "comparison images path relative to resources/images", type: "string" })
         .help()
         .argv;
@@ -55,8 +111,7 @@ const config = (() => {
         options.attachToDebug = true;
         options.devMode = true;
         if (!options.port) {
-            logError("Provide appium server port started from desktop application!")
-            process.exit(1);
+            logError(`Provide appium server port that has been used to start session or the default '${port}' one will be used`);
         }
     }
 
@@ -70,7 +125,7 @@ const config = (() => {
         projectBinary: projectBinary,
         pluginRoot: pluginRoot,
         pluginBinary: pluginBinary,
-        port: options.port || process.env.npm_config_port || process.env["APPIUM_PORT"] || 4723 ,
+        port: options.port || process.env.npm_config_port || process.env["APPIUM_PORT"] || 4723,
         wdaLocalPort: options.wdaLocalPort || process.env.npm_config_wdaLocalPort || process.env["WDA_LOCAL_PORT"] || 8410,
         testFolder: options.testFolder || process.env.npm_config_testFolder || "e2e",
         runType: options.runType || process.env.npm_config_runType,
@@ -80,8 +135,7 @@ const config = (() => {
         appPath: options.appPath || process.env.npm_config_appPath,
         storage: options.storage || process.env.npm_config_STORAGE || process.env.STORAGE,
         testReports: options.testReports || process.env.npm_config_testReports || process.env.TEST_REPORTS,
-        devMode: options.devMode || process.env.npm_config_devMode  || process.env.REUSE_APP,
-        reuseDevice: options.devMode ? true : options.reuseDevice || process.env.npm_config_reuseDevice || process.env.REUSE_DEVICE,
+        devMode: options.devMode || process.env.npm_config_devMode || process.env.REUSE_APP,
         cleanApp: !options.devMode && options.cleanApp && !options.sauceLab && !options.ignoreDeviceController,
         ignoreDeviceController: options.ignoreDeviceController || process.env.npm_ignoreDeviceController,
         path: options.path || process.env.npm_path,
@@ -110,7 +164,6 @@ export const {
     appPath,
     storage,
     testReports,
-    reuseDevice,
     devMode,
     ignoreDeviceController,
     wdaLocalPort,
diff --git a/lib/utils.ts b/lib/utils.ts
@@ -537,7 +537,7 @@ export const prepareApp = async (args: INsCapabilities) => {
         const groupings = getRegexResultsAsArray(/(\w+)/gi, args.appiumCaps[appPackage]);
         args.appName = groupings[groupings.length - 1];
         console.log(`Setting application name as ${args.appName}`);
-        if (!args.devMode && !args.ignoreDeviceController) {
+        if (!args.devMode && !args.ignoreDeviceController && args.cleanApp) {
             logInfo("Check and uninstall application from device.");
             await args.deviceManager.uninstallApp(args);
         } else {
diff --git a/package.json b/package.json
@@ -46,7 +46,7 @@
   },
   "devDependencies": {
     "@types/node": "~10.12.15",
-    "typescript": "^3.1.1"
+    "typescript": "^3.2.0"
   },
   "scripts": {
     "postinstall": "node ./postinstall.js",
diff --git a/samples/config/appium.capabilities.json b/samples/config/appium.capabilities.json
@@ -6,7 +6,7 @@
         "avd": "Emulator-Api19-Default",
         "lt": 60000,
         "newCommandTimeout": 720,
-        "noReset": true,
+        "noReset": false,
         "fullReset": false,
         "app": ""
     },
@@ -17,7 +17,7 @@
         "avd": "Emulator-Api21-Default",
         "lt": 60000,
         "newCommandTimeout": 720,
-        "noReset": true,
+        "noReset": false,
         "fullReset": false,
         "app": ""
     },
@@ -28,7 +28,7 @@
         "avd": "Emulator-Api23-Default",
         "lt": 60000,
         "newCommandTimeout": 720,
-        "noReset": true,
+        "noReset": false,
         "fullReset": false,
         "app": ""
     },
@@ -39,7 +39,7 @@
         "avd": "Emulator-Api24-Default",
         "lt": 60000,
         "newCommandTimeout": 720,
-        "noReset": true,
+        "noReset": false,
         "fullReset": false,
         "app": ""
     },
@@ -50,7 +50,7 @@
         "avd": "Emulator-Api25-Google",
         "lt": 60000,
         "newCommandTimeout": 720,
-        "noReset": true,
+        "noReset": false,
         "fullReset": false,
         "app": ""
     },
@@ -61,7 +61,7 @@
         "avd": "Emulator-Api26-Google",
         "lt": 60000,
         "newCommandTimeout": 720,
-        "noReset": true,
+        "noReset": false,
         "fullReset": false,
         "app": ""
     },
@@ -72,7 +72,7 @@
         "avd": "Emulator-Api27-Google",
         "lt": 60000,
         "newCommandTimeout": 720,
-        "noReset": true,
+        "noReset": false,
         "fullReset": false,
         "app": ""
     },
@@ -83,41 +83,40 @@
         "avd": "Emulator-Api28-Google",
         "lt": 60000,
         "newCommandTimeout": 720,
-        "noReset": true,
+        "noReset": false,
         "fullReset": false,
         "app": ""
     },
     "sim.iPhone7": {
         "platformName": "iOS",
         "platformVersion": "12.*",
         "deviceName": "iPhone 7",
-        "noReset": true,
+        "noReset": false,
         "fullReset": false,
         "app": ""
     },
-
     "sim.iPhone8": {
         "platformName": "iOS",
         "platformVersion": "12*",
         "deviceName": "iPhone 8",
-        "noReset": true,
+        "noReset": false,
         "fullReset": false,
         "app": ""
     },
     "sim.iPhoneX": {
         "platformName": "iOS",
         "platformVersion": "12*",
         "deviceName": "iPhone X",
-        "noReset": true,
+        "noReset": false,
         "fullReset": false,
         "app": ""
     },
     "sim.iPhoneXS": {
         "platformName": "ios",
         "platformVersion": "12*",
         "deviceName": "iPhone XS",
-        "noReset": true,
+        "noReset": false,
         "fullReset": false,
         "app": ""
     }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -83,8 +83,9 @@ export async function stopServer() {`
`83`	`83`	`await appiumServer.stop();`
`84`	`84`	`}`
`85`	`85`
`86`		`- if (nsCapabilities.cleanApp) {`
	`86`	`+ if (nsCapabilities.cleanApp && !nsCapabilities.ignoreDeviceController) {`
`87`	`87`	`await DeviceController.uninstallApp(nsCapabilities.device, nsCapabilities.appPath);`
	`88`	`+ logInfo("Application from device is uninstalled.")`
`88`	`89`	`}`
`89`	`90`	`};`
`90`	`91`
Original file line number	Diff line number	Diff line change
`@@ -1 +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, imagesPath: string;
	`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, devMode: boolean, ignoreDeviceController: boolean, wdaLocalPort: number, path: string, relaxedSecurity: boolean, cleanApp: boolean, attachToDebug: boolean, sessionId: string, startSession: boolean, capabilitiesName: string, imagesPath: string;