Tsenov/device controller (#53)

SvetoslavTsenov · web-flow · commit f1383e222f54 · 2017-10-27T13:40:21.000+03:00
* merge

* fix: kill device server for windowsm

* feat: introduce ignoreDeviceController

* Fix ios simulator

* fix: remove check for null device

* merge: fix after rebase to master

* update: tsconfig lib
diff --git a/README.md b/README.md
@@ -33,13 +33,13 @@ $ tns build ios
 The command that will run the tests should specify the targeted platform using the `runType` option as shown below. This way a capabilities will be selected from the [capabilities config file](#customCapabilities).
 
 ```
-$ npm run e2e -- --runType android23
+$ npm run e2e -- --runType android25
 ```
 
 or
 
 ```
-$ npm run e2e -- --runType ios-simulator10iPhone6
+$ npm run e2e -- --runType sim.iPhone7.iOS110
 ```
 
 Generated tests are standard [Mocha](http://mochajs.org) tests.
@@ -73,36 +73,33 @@ Thus, the same configuration can be used by both apps without duplication of fil
 
 If you wish to use another location of the capapabilities file instead default ones, you can specify it with `--capsLocation` option. Remember that the path provided has to be relative to the root directory.
 
-Notice that once custom capabilities are provided you will be able to pick any of them using the `--runType` option (e.g. `--runType android21`). Sample content of `appium.capabilities.json` file could be:
+Notice that once custom capabilities are provided you will be able to pick any of them using the `--runType` option (e.g. `--runType android25`). Sample content of `appium.capabilities.json` file could be:
 
 ```
 {
     "android21": {
             "browserName": "",
-            "appium-version": "1.6.3",
             "platformName": "Android",
             "platformVersion": "5.0",
             "deviceName": "Android Emulator",
             "noReset": false,
             "app": ""
         
     },
-    "android23": {
+    "android25": {
             "browserName": "",
-            "appium-version": "1.6.5",
             "platformName": "Android",
-            "platformVersion": "6.0",
+            "platformVersion": "7.0",
             "deviceName": "Android Emulator",
             "noReset": false,
             "app": ""
         
     },
-    "ios-simulator10iPhone6": {
+    "sim.iPhone7.iOS110": {
             "browserName": "",
-            "appium-version": "1.6.5",
             "platformName": "iOS",
             "platformVersion": "10.0",
-            "deviceName": "iPhone 6 Simulator",
+            "deviceName": "iPhone 7 110",
             "app": ""
         
     }
@@ -125,7 +122,7 @@ As you can see, the `app` property can be left an empty string which will force
 Examples:
 
 ```
-$ npm run e2e --runType android23 --sauceLab --appLocation demo.apk --capsLocation "/e2e-tests/config"
+$ npm run e2e --runType android25 --sauceLab --appLocation demo.apk --capsLocation "/e2e-tests/config"
 
 ```
 
diff --git a/e2e/tsconfig.json b/e2e/tsconfig.json
@@ -11,7 +11,7 @@
             "chai"
         ],
         "lib": [
-            "es6",
+            "es2015",
             "dom"
         ]
     }
diff --git a/index.ts b/index.ts
@@ -73,7 +73,7 @@ export async function createDriver() {
     } else if (appiumDriver === null) {
         appiumDriver = await AppiumDriver.createAppiumDriver(appiumServer.port, nsCapabilities);
     } else if (appiumDriver !== null && !appiumDriver.isAlive) {
-        await appiumDriver.inint();
+        await appiumDriver.init();
     }
 
     return appiumDriver;
diff --git a/lib/appium-driver.ts b/lib/appium-driver.ts
@@ -366,7 +366,6 @@ export class AppiumDriver {
 
             driverConfig = "https://" + sauceUser + ":" + sauceKey + "@ondemand.saucelabs.com:443/wd/hub";
 
-
             args.appiumCaps.app = "sauce-storage:" + args.appPath;
             console.log("Using Sauce Labs. The application path is changed to: " + args.appPath);
         }
diff --git a/lib/appium-server.ts b/lib/appium-server.ts
@@ -88,6 +88,7 @@ export class AppiumServer {
                     shutdown(this._server, this._args.verbose);
                     this._server.kill("SIGINT");
                     this._server.kill("SIGINT");
+                    this._server = null;
                 } else {
                     this._server.kill("SIGINT");
                     this._server.kill("SIGINT");
diff --git a/lib/device-controller.d.ts b/lib/device-controller.d.ts
@@ -5,6 +5,7 @@ export declare class DeviceController {
     static startDevice(args: INsCapabilities): Promise<any>;
     static stop(args: INsCapabilities): Promise<void>;
     static kill(device: IDevice): Promise<void>;
+    private static getDefaultDevice(args);
     private static device(runType);
     private static getDevicesByStatus(devices, status);
 }
diff --git a/lib/device-controller.ts b/lib/device-controller.ts
@@ -3,64 +3,68 @@ import * as child_process from "child_process";
 import { INsCapabilities } from "./ins-capabilities";
 
 import {
-    DeviceManager,
-    AndroidManager,
-    IOSManager,
     IDevice,
+    Device,
+    DeviceManager,
     Platform,
-    Status
+    Status,
+    DeviceType
 } from "mobile-devices-controller";
 
 
 export class DeviceController {
     private static _emulators: Map<string, IDevice> = new Map();
 
     public static async startDevice(args: INsCapabilities) {
-        const devices = (await DeviceManager.getAllDevices(args.appiumCaps.platformName.toLowerCase(), args.appiumCaps.deviceName));
-        if (!devices || devices === null || devices.size) {
-            console.log("Available devices:\n", devices);
-            throw new Error(`No such device ${args.appiumCaps.deviceName}!!!\n Check availabe emulators!!!`);
+        if (args.isSauceLab || args.ignoreDeviceController) {
+            return DeviceController.getDefaultDevice(args); 
         }
 
-        let device: IDevice;
-        // Should find new device
-        if (!args.reuseDevice) {
-            device = DeviceController.getDevicesByStatus(devices, Status.SHUTDOWN);
+        const allDevices = (await DeviceManager.getAllDevices(args.appiumCaps.platformName.toLowerCase()));
+        if (!allDevices || allDevices === null || allDevices.size === 0) {
+            console.log("We couldn't find any devices. We will try to prossede to appium! Maybe avd manager is missing")
+            console.log("Available devices:\n", allDevices);
         }
 
-        // If there is no shutdown device
-        if (!device || device === null) {
-            device = DeviceController.getDevicesByStatus(devices, Status.BOOTED);
+        let searchedDevices = allDevices.get(args.appiumCaps.deviceName);
+        if (!searchedDevices || searchedDevices.length === 0) {
+            console.log(`No such device ${args.appiumCaps.deviceName}!!!\n Check your device name!!!`);
+            console.log("Available devices:\n", allDevices);
         }
 
-        // If there is no booted device
-        if (!device || device === null) {
-            device = DeviceController.getDevicesByStatus(devices, Status.FREE);
-        }
+        let device: IDevice;
 
-        // In case reuse device is true but there weren't any booted devices. We need to fall back and boot new one.
-        if (!device || device === null && args.reuseDevice) {
-            device = DeviceController.getDevicesByStatus(devices, Status.SHUTDOWN);
-        }
+        if (searchedDevices && searchedDevices.length > 0) {
 
-        if (device.status === Status.SHUTDOWN) {
-            await DeviceManager.startDevice(device);
-            console.log("Started device: ", device);
-        } else {
-            console.log("Device is alredy started", device);
+            // Should find new device
             if (!args.reuseDevice) {
-                DeviceController.kill(device);
+                device = DeviceController.getDevicesByStatus(searchedDevices, Status.SHUTDOWN);
+            }
+
+            // If there is no shutdown device
+            if (!device || device === null) {
+                device = DeviceController.getDevicesByStatus(searchedDevices, Status.BOOTED);
+            }
+
+            // In case reuse device is true but there weren't any booted devices. We need to fall back and boot new one.
+            if (!device || device === null && args.reuseDevice) {
+                device = DeviceController.getDevicesByStatus(searchedDevices, Status.SHUTDOWN);
+            }
+
+            if (device.status === Status.SHUTDOWN) {
                 await DeviceManager.startDevice(device);
+                console.log("Started device: ", device);
+            } else {
+                console.log("Device is alredy started", device);
+                if (!args.reuseDevice) {
+                    DeviceController.kill(device);
+                    await DeviceManager.startDevice(device);
+                }
             }
         }
 
-        if (device.token && args.appiumCaps.platformName.toLowerCase() === Platform.ANDROID) {
-            const density = AndroidManager.getPhysicalDensity(device.token);
-            const offsetPixels = AndroidManager.getPixelsOffset(device.token);
-            device.config = {
-                density: density,
-                offsetPixels: offsetPixels,
-            };
+        if (!device || device === null) {
+            device = DeviceController.getDefaultDevice(args);
         }
 
         DeviceController._emulators.set(args.runType, device);
@@ -69,7 +73,7 @@ export class DeviceController {
     }
 
     public static async stop(args: INsCapabilities) {
-        if (DeviceController._emulators.has(args.runType) && !args.reuseDevice) {
+        if (DeviceController._emulators.has(args.runType) && !args.reuseDevice && !args.isSauceLab && !args.ignoreDeviceController) {
             const device = DeviceController._emulators.get(args.runType);
             await DeviceManager.kill(device);
         }
@@ -79,6 +83,11 @@ export class DeviceController {
         await DeviceManager.kill(device);
     }
 
+
+    private static getDefaultDevice(args) {
+        return new Device(args.appiumCaps.deviceName, args.appiumCaps.platformVersion, undefined, args.appiumCaps.platformName, undefined, undefined);
+    }
+
     private static device(runType) {
         return DeviceController._emulators.get(runType);
     }
diff --git a/lib/ins-capabilities.d.ts b/lib/ins-capabilities.d.ts
@@ -17,4 +17,5 @@ export interface INsCapabilities {
     testReports: string;
     reuseDevice: boolean;
     device: IDevice;
+    ignoreDeviceController: boolean;
 }
diff --git a/lib/ins-capabilities.ts b/lib/ins-capabilities.ts
@@ -17,5 +17,6 @@ export interface INsCapabilities {
     storage: string;
     testReports: string;
     reuseDevice: boolean;
-    device: IDevice;
+    device:IDevice;
+    ignoreDeviceController: boolean;
 }
diff --git a/lib/ns-capabilities.d.ts b/lib/ns-capabilities.d.ts
@@ -18,6 +18,7 @@ export declare class NsCapabilities implements INsCapabilities {
     private _appPath;
     private _emulatorOptions;
     private _device;
+    private _ignoreDeviceController;
     private exceptions;
     constructor();
     readonly projectDir: any;
@@ -35,6 +36,7 @@ export declare class NsCapabilities implements INsCapabilities {
     readonly runType: any;
     readonly isSauceLab: any;
     appPath: string;
+    readonly ignoreDeviceController: boolean;
     device: IDevice;
     readonly emulatorOptions: string;
     private resolveAppPath();
diff --git a/lib/ns-capabilities.ts b/lib/ns-capabilities.ts
@@ -22,6 +22,7 @@ export class NsCapabilities implements INsCapabilities {
     private _appPath: string;
     private _emulatorOptions: string;
     private _device: IDevice;
+    private _ignoreDeviceController: boolean;
     private exceptions: Array<string> = new Array();
 
     constructor() {
@@ -39,6 +40,7 @@ export class NsCapabilities implements INsCapabilities {
         this._reuseDevice = parser.reuseDevice;
         this._runType = parser.runType;
         this._isSauceLab = parser.isSauceLab;
+        this._ignoreDeviceController = parser.ignoreDeviceController;
         this._appiumCaps = resolveCapabilities(this._appiumCapsLocation, parser.runType, parser.projectDir);
         this.resolveAppPath();
         this.checkMandatoryCapabiliies();
@@ -60,6 +62,7 @@ export class NsCapabilities implements INsCapabilities {
     get runType() { return this._runType; }
     get isSauceLab() { return this._isSauceLab; }
     get appPath() { return this._appPath; }
+    get ignoreDeviceController() { return this._ignoreDeviceController; }
     set appPath(appPath: string) { this._appPath = appPath; }
     get device() { return this._device; }
     set device(device: IDevice) { this._device = device; }
diff --git a/lib/parser.d.ts b/lib/parser.d.ts
@@ -1,2 +1,2 @@
 export declare const capabilitiesName = "appium.capabilities.json";
-export declare const projectDir: any, projectBinary: any, pluginRoot: any, pluginBinary: any, port: any, verbose: any, appiumCapsLocation: any, testFolder: any, runType: any, isSauceLab: any, appPath: any, storage: any, testReports: any, reuseDevice: any;
+export declare const projectDir: any, projectBinary: any, pluginRoot: any, pluginBinary: any, port: any, verbose: any, appiumCapsLocation: any, testFolder: any, runType: any, isSauceLab: any, appPath: any, storage: any, testReports: any, reuseDevice: any, ignoreDeviceController: any;
diff --git a/lib/parser.ts b/lib/parser.ts
@@ -17,6 +17,7 @@ const config = (() => {
         .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", defualt: false })
+        .option("ignoreDeviceController", { describe: "Use default appium options for running emulatos/ simulators.", type: "boolean", defualt: false })
         .help()
         .argv;
 
@@ -45,8 +46,9 @@ const config = (() => {
         storage: options.storage || process.env.npm_config_STORAGE || process.env.STORAGE,
         testReports: options.testReports || process.env.npm_config_TEST_REPORTS || process.env.TEST_REPORTS,
         reuseDevice: options.reuseDevice || process.env.npm_config_REUSE_DEVICE || process.env.REUSE_DEVICE,
+        ignoreDeviceController: options.ignoreDeviceController,
     };
-         
+
     return config;
 })();
 
@@ -64,5 +66,6 @@ export const {
     appPath,
     storage,
     testReports,
-    reuseDevice
+    reuseDevice,
+    ignoreDeviceController
 } = config;
diff --git a/lib/utils.d.ts b/lib/utils.d.ts
@@ -1,3 +1,5 @@
+/// <reference types="node" />
+import * as childProcess from "child_process";
 import { INsCapabilities } from "./ins-capabilities";
 import { Point } from "./point";
 import { Direction } from "./direction";
@@ -10,7 +12,7 @@ export declare function searchFiles(folder: any, words: any, recursive?: boolean
 export declare function log(message: any, verbose: any): void;
 export declare function loglogOut(line: any, verbose: any): void;
 export declare function logErr(line: any, verbose: any): void;
-export declare function shutdown(processToKill: any, verbose: any): void;
+export declare function shutdown(processToKill: childProcess.ChildProcess, verbose: any): void;
 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?: any): string;
diff --git a/lib/utils.ts b/lib/utils.ts
@@ -172,14 +172,15 @@ export function logErr(line, verbose) {
     }
 }
 
-export function shutdown(processToKill, verbose) {
+export function shutdown(processToKill: childProcess.ChildProcess, verbose) {
     try {
         if (processToKill && processToKill !== null) {
             if (process.platform === "win32") {
                 killPid(processToKill.pid, verbose);
             } else {
                 processToKill.kill();
             }
+            processToKill.killed = true;
             processToKill = null;
             console.log("Shut down!!!");
         }
diff --git a/package-lock.json b/package-lock.json
diff --git a/tsconfig.json b/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`"chai"`
`12`	`12`	`],`
`13`	`13`	`"lib": [`
`14`		`- "es6",`
	`14`	`+ "es2015",`
`15`	`15`	`"dom"`
`16`	`16`	`]`
`17`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ export async function createDriver() {`
`73`	`73`	`} else if (appiumDriver === null) {`
`74`	`74`	`appiumDriver = await AppiumDriver.createAppiumDriver(appiumServer.port, nsCapabilities);`
`75`	`75`	`} else if (appiumDriver !== null && !appiumDriver.isAlive) {`
`76`		`- await appiumDriver.inint();`
	`76`	`+ await appiumDriver.init();`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`return appiumDriver;`
Original file line number	Diff line number	Diff line change
`@@ -366,7 +366,6 @@ export class AppiumDriver {`
`366`	`366`
`367`	`367`	`driverConfig = "https://" + sauceUser + ":" + sauceKey + "@ondemand.saucelabs.com:443/wd/hub";`
`368`	`368`
`369`		`-`
`370`	`369`	`args.appiumCaps.app = "sauce-storage:" + args.appPath;`
`371`	`370`	`console.log("Using Sauce Labs. The application path is changed to: " + args.appPath);`
`372`	`371`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ export declare class DeviceController {`
`5`	`5`	`static startDevice(args: INsCapabilities): Promise<any>;`
`6`	`6`	`static stop(args: INsCapabilities): Promise<void>;`
`7`	`7`	`static kill(device: IDevice): Promise<void>;`
	`8`	`+ private static getDefaultDevice(args);`
`8`	`9`	`private static device(runType);`
`9`	`10`	`private static getDevicesByStatus(devices, status);`
`10`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,4 +17,5 @@ export interface INsCapabilities {`
`17`	`17`	`testReports: string;`
`18`	`18`	`reuseDevice: boolean;`
`19`	`19`	`device: IDevice;`
	`20`	`+ ignoreDeviceController: boolean;`
`20`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,5 +17,6 @@ export interface INsCapabilities {`
`17`	`17`	`storage: string;`
`18`	`18`	`testReports: string;`
`19`	`19`	`reuseDevice: boolean;`
`20`		`- device: IDevice;`
	`20`	`+ device:IDevice;`
	`21`	`+ ignoreDeviceController: boolean;`
`21`	`22`	`}`