refactor(devMode): use android/ ios or --device.[prop] as option instead devMode (#192)

* refactor(devMode): replace with ios or android as a first option.

BREAKING CHANGES:
validate() args returns a promise

Author: SvetoslavTsenov

.gitignore

@@ -12,4 +12,5 @@ samples/reports
 !samples/config
 !samples/e2e-tsc/*.ts
 !samples/e2e-js/*.js
-!samples/e2e-tsc/tsconfig.json
+!samples/e2e-tsc/tsconfig.json
+test/out/*

index.ts

@@ -94,7 +94,7 @@ export async function createDriver(args?: INsCapabilitiesArgs) {
     if (!nsCapabilities.appiumCapsLocation) {
         throw new Error("Provided path to appium capabilities is not correct!");
     }
-    if (!nsCapabilities.runType) {
+    if (!nsCapabilities.runType && !nsCapabilities.appiumCaps) {
         throw new Error("--runType is missing! Make sure it is provided correctly! It is used to parse the configuration for appium driver!");
     }
 

lib/appium-driver.ts

@@ -16,7 +16,8 @@ import {
     DeviceController,
     IDevice,
     DeviceType,
-    AndroidController
+    AndroidController,
+    killAllProcessAndRelatedCommand
 } from "mobile-devices-controller";
 import {
     addExt,
@@ -189,7 +190,7 @@ export class AppiumDriver {
         };
 
         if (!args.isValidated) {
-            args.validateArgs();
+            await args.validateArgs();
         }
 
         if (args.isSauceLab) {

lib/appium-server.ts

@@ -15,6 +15,7 @@ import { INsCapabilities } from "./interfaces/ns-capabilities";
 import { IDeviceManager } from "./interfaces/device-manager";
 import { DeviceManager } from "./device-manager";
 import { existsSync } from "fs";
+import { killAllProcessAndRelatedCommand } from "mobile-devices-controller";
 
 export class AppiumServer {
     private _server: child_process.ChildProcess;
@@ -59,12 +60,12 @@ export class AppiumServer {
     }
 
     public async start(port, deviceManager: IDeviceManager = new DeviceManager()) {
-        if (!this._args.isValidated) {
-            this._args.validateArgs();
+        if (!this._args.isValidated && this._args.validateArgs) {
+            await this._args.validateArgs();
             this._args.port = port;
         }
         this._args.deviceManager = deviceManager;
-        if (!this._args.attachToDebug && !this._args.sessionId) {
+        if (this._args.isValidated && !this._args.attachToDebug && !this._args.sessionId) {
             await this.prepDevice(deviceManager);
             await this.prepApp();
         }
@@ -84,6 +85,9 @@ export class AppiumServer {
 
             let retries = 11;
             while (retries > 0 && !response) {
+                if (retries < 5) {
+                    killAllProcessAndRelatedCommand(this._port);
+                }
                 retries--;
                 this.port += 10;
                 this.port = (await findFreePort(100, this.port));
@@ -109,10 +113,7 @@ export class AppiumServer {
 
         logInfo(`Server args: `, startingServerArgs);
 
-        this._server = child_process.spawn(this._appium, startingServerArgs, {
-            shell: true,
-            detached: false
-        });
+        this._server = child_process.spawn(this._appium, startingServerArgs);
     }
 
     public async stop() {
@@ -124,22 +125,22 @@ export class AppiumServer {
         await this._args.deviceManager.stopDevice(this._args.device, this._args);
         return new Promise((resolve, reject) => {
             this._server.once("close", (code, signal) => {
-                onServerKilled(this._server, signal,code, this._args.verbose);
+                onServerKilled(this._server, signal, code, this._args.verbose);
                 resolve();
             });
 
             this._server.once("exit", (code, signal) => {
-                onServerKilled(this._server, signal,code, this._args.verbose);
+                onServerKilled(this._server, signal, code, this._args.verbose);
                 resolve();
             });
 
             this._server.once("error", (code, signal) => {
-                onServerKilled(this._server, signal,code, this._args.verbose);
+                onServerKilled(this._server, signal, code, this._args.verbose);
                 resolve();
             });
 
             this._server.once("disconnect", (code, signal) => {
-                onServerKilled(this._server, signal,code, this._args.verbose);
+                onServerKilled(this._server, signal, code, this._args.verbose);
                 resolve();
             });
 

lib/device-manager.d.ts

@@ -6,10 +6,12 @@ export declare class DeviceManager implements IDeviceManager {
     constructor();
     startDevice(args: INsCapabilities): Promise<IDevice>;
     stopDevice(device: IDevice, args: INsCapabilities): Promise<any>;
+    static getDevices(query: IDevice): Promise<IDevice[]>;
     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 getInstalledApps(device: IDevice): Promise<string[]>;
+    static getDefaultDevice(args: INsCapabilities, deviceName?: string, token?: string, type?: DeviceType, platformVersion?: number): IDevice;
     static setDontKeepActivities(args: INsCapabilities, driver: any, value: any): Promise<void>;
     static executeShellCommand(driver: any, commandArgs: {
         command: string;

lib/device-manager.ts

@@ -11,6 +11,7 @@ import {
     DeviceType,
     sortDescByApiLevelPredicate
 } from "mobile-devices-controller";
+import { isRegExp } from "util";
 
 export class DeviceManager implements IDeviceManager {
     private static _emulators: Map<string, IDevice> = new Map();
@@ -25,7 +26,7 @@ export class DeviceManager implements IDeviceManager {
         const token = process.env["DEVICE_TOKEN"] || process.env.npm_config_deviceToken;
         device.token = token && token.replace("emulator-", "");
         device.name = process.env["DEVICE_NAME"] || device.name;
-  
+
         DeviceManager.cleanUnsetProperties(device);
 
         if (args.ignoreDeviceController) {
@@ -45,8 +46,7 @@ export class DeviceManager implements IDeviceManager {
             return device;
         }
 
-        const searchQuery = args.appiumCaps.udid ? { token: args.appiumCaps.udid } : device;
-
+        const searchQuery = args.appiumCaps.udid ? { token: args.appiumCaps.udid } : Object.assign(device);
         const foundDevices = (await DeviceController.getDevices(searchQuery))
             .sort((a, b) => sortDescByApiLevelPredicate(a, b));
 
@@ -75,20 +75,22 @@ export class DeviceManager implements IDeviceManager {
 
         if (foundDevices && foundDevices.length > 0) {
             let deviceStatus = args.reuseDevice ? Status.BOOTED : Status.SHUTDOWN;
-            device = DeviceController.filter(foundDevices, { status: deviceStatus })[0];
+            device = DeviceController.filter(foundDevices, { status: deviceStatus })
+                .filter(d => d.type !== DeviceType.TV && d.type !== DeviceType.WATCH)[0];
 
             // If there is no shutdown device
             if (!device || !device.status) {
                 deviceStatus = args.reuseDevice ? Status.SHUTDOWN : Status.BOOTED;
-                device = DeviceController.filter(foundDevices, { status: deviceStatus })[0];
+                device = DeviceController.filter(foundDevices, { status: deviceStatus })
+                    .filter(d => d.type !== DeviceType.TV && d.type !== DeviceType.WATCH)[0];
             }
 
             // If the device should not be reused we need to shutdown device and boot a clean instance
             let startDeviceOptions = args.startDeviceOptions || undefined;
             if (!args.reuseDevice && device.status !== Status.SHUTDOWN) {
                 await DeviceController.kill(device);
                 device.status = Status.SHUTDOWN;
-                startDeviceOptions = device.type === DeviceType.EMULATOR ? "-wipe-data -no-snapshot-load -no-boot-anim -no-audio" : "";
+                startDeviceOptions = device.type === DeviceType.EMULATOR ? "-wipe-data -no-snapshot-load -no-boot-anim -no-audio -snapshot clean_boot" : "";
                 logInfo("Change appium config to fullReset: false if no restart of the device needed!");
             }
 
@@ -131,6 +133,10 @@ export class DeviceManager implements IDeviceManager {
         }
     }
 
+    public static async getDevices(query: IDevice) {
+        return await DeviceController.getDevices(query);
+    }
+
     public async installApp(args: INsCapabilities): Promise<any> {
         if (args.isIOS) {
             IOSController.installApp(args.device, args.appiumCaps.app);
@@ -149,7 +155,13 @@ export class DeviceManager implements IDeviceManager {
     }
 
     public static async kill(device: IDevice) {
-        await DeviceController.kill(device);
+        if (device) {
+            await DeviceController.kill(device);
+        }
+    }
+
+    public static async getInstalledApps(device: IDevice) {
+        return await DeviceController.getInstalledApplication(device);
     }
 
     public static getDefaultDevice(args: INsCapabilities, deviceName?: string, token?: string, type?: DeviceType, platformVersion?: number) {

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

@@ -37,4 +37,5 @@ export interface INsCapabilitiesArgs {
     deviceManager?: IDeviceManager;
     imagesPath?: string;
     startDeviceOptions?: string;
+    deviceTypeOrPlatform?: string;
 }

lib/interfaces/ns-capabilities-args.ts

@@ -38,4 +38,5 @@ export interface INsCapabilitiesArgs {
     deviceManager?: IDeviceManager;
     imagesPath?: string;
     startDeviceOptions?: string;
+    deviceTypeOrPlatform?: string
 }

lib/ns-capabilities.d.ts

@@ -38,13 +38,14 @@ export declare class NsCapabilities implements INsCapabilities {
     deviceManager: IDeviceManager;
     exceptions: Array<string>;
     imagesPath: string;
+    deviceTypeOrPlatform: string;
     constructor(_parser: INsCapabilitiesArgs);
     readonly isAndroid: any;
     readonly isIOS: boolean;
     automationName: AutomationName;
     setAutomationNameFromString(automationName: String): void;
     extend(args: INsCapabilities): this;
-    validateArgs(): any;
+    validateArgs(): Promise<void>;
     private isAndroidPlatform;
     shouldSetFullResetOption(): void;
     private setAutomationName;