Tsenov/extend device support (#123)

SvetoslavTsenov · web-flow · commit 5e4108f65d61 · 2018-06-04T18:45:12.000+03:00
* feat(sauceLabs): get device density and run in background 

* chore: update dependencies

* fix: find array of elements
diff --git a/lib/appium-driver.d.ts b/lib/appium-driver.d.ts
@@ -55,6 +55,7 @@ export declare class AppiumDriver {
      */
     readonly storageByDeviceName: string;
     static createAppiumDriver(port: number, args: INsCapabilities): Promise<AppiumDriver>;
+    private static applyDeviceAdditionsSettings(args, sessionIfno);
     /**
      *
      * @param xPath
@@ -203,5 +204,9 @@ export declare class AppiumDriver {
     * @param waitForElement
     */
     findElementByAccessibilityIdIfExists(id: string, waitForElement?: number): Promise<UIElement>;
+    executeShellCommand(commandAndargs: {
+        command: string;
+        "args": Array<any>;
+    }): Promise<any>;
     setDontKeepActivities(value: boolean): Promise<void>;
 }
diff --git a/lib/appium-driver.ts b/lib/appium-driver.ts
@@ -16,7 +16,8 @@ import {
     DeviceController,
     IDevice,
     DeviceType,
-    AndroidController
+    AndroidController,
+    IOSController
 } from "mobile-devices-controller";
 import {
     addExt,
@@ -179,11 +180,15 @@ export class AppiumDriver {
 
         const driver = await wd.promiseChainRemote(driverConfig);
         AppiumDriver.configureLogging(driver, args.verbose);
+
         let hasStarted = false;
         let retries = 10;
         while (retries > 0 && !hasStarted) {
             try {
-                await driver.init(args.appiumCaps);
+                const sessionIfno = await driver.init(args.appiumCaps);
+                log(sessionIfno, args.verbose);
+                AppiumDriver.applyDeviceAdditionsSettings(args, sessionIfno);
+
                 hasStarted = true;
             } catch (error) {
                 console.log(error);
@@ -204,6 +209,29 @@ export class AppiumDriver {
         return new AppiumDriver(driver, wd, webio, driverConfig, args);
     }
 
+    private static applyDeviceAdditionsSettings(args: INsCapabilities, sessionIfno: any) {
+        if (!args.device.config || !args.device.config.density || !args.device.config.offset) {
+            args.device.config = {};
+            const density: number = sessionIfno[1].deviceScreenDensity / 100;
+            args.device.config['density'] = density;
+
+            if (args.appiumCaps.platformName.toLowerCase() === "android") {
+                args.device.config['offsetPixels'] = AndroidController.calculateScreenOffset(density);
+            } else {
+                IOSController.getDevicesScreenInfo().forEach((v, k, m) => {
+                    if (args.device.name.includes(k)) {
+                        args.device.config = {
+                            density: args.device.config['density'] || v.density,
+                            offsetPixels: v.actionBarHeight
+                        };
+                    }
+                });
+            }
+
+            console.log(`Device setting:`, args.device.config);
+        }
+    }
+
     /**
      *
      * @param xPath
@@ -600,15 +628,15 @@ export class AppiumDriver {
     }
 
     private async convertArrayToUIElements(array, searchM, args) {
-        let i = 0;
         const arrayOfUIElements = new Array<UIElement>();
         if (!array || array === null) {
             return arrayOfUIElements;
         }
-        array.forEach(async element => {
-            arrayOfUIElements.push(new UIElement(await element, this._driver, this._wd, this._webio, this._args, searchM, args, i));
-            i++;
-        });
+
+        for (let index = 0; index < array.length; index++) {
+            const element = array[index];
+            arrayOfUIElements.push(new UIElement(await element, this._driver, this._wd, this._webio, this._args, searchM, args, index));
+        }
 
         return arrayOfUIElements;
     }
@@ -705,9 +733,17 @@ export class AppiumDriver {
         }
     }
 
+    public async executeShellCommand(commandAndargs: { command: string, "args": Array<any> }) {
+        const output = await this._driver.execute("mobile: shell", commandAndargs);
+        return output;
+    }
     public async setDontKeepActivities(value: boolean) {
         if (this._args.isAndroid) {
-            AndroidController.setDontKeepActivities(value, this._args.device);
+            const status = value ? 1 : 0;
+            const output = await this.executeShellCommand({ command: "settings", args: ['put', 'global', 'always_finish_activities', status] });
+            //check if set 
+            const check = await this.executeShellCommand({ command: "settings", args: ['get', 'global', 'always_finish_activities'] })
+            console.info(`always_finish_activities: ${check}`)
         } else {
             // Do nothing for iOS ...
         }
diff --git a/lib/appium-server.ts b/lib/appium-server.ts
@@ -84,7 +84,8 @@ export class AppiumServer {
     }
 
     private startAppiumServer(logLevel: string, isSauceLab: boolean) {
-        const startingServerArgs = isSauceLab ? [ "--log-level", logLevel] : ["-p", this.port.toString(), "--log-level", logLevel];
+        const startingServerArgs: Array<string> = isSauceLab ? ["--log-level", logLevel] : ["-p", this.port.toString(), "--log-level", logLevel];
+        startingServerArgs.push("--relaxed-security");
         this._server = child_process.spawn(this._appium, startingServerArgs, {
             shell: true,
             detached: false
diff --git a/lib/frame-comparer.ts b/lib/frame-comparer.ts
@@ -1,7 +1,6 @@
 import { mkdirSync } from "fs";
 import { resolve, getStorageByDeviceName, getReportPath } from "./utils";
 import { INsCapabilities } from "./interfaces/ns-capabilities";
-import { IDevice } from "mobile-devices-controller";
 import * as frComparer from "frame-comparer";
 import { IRectangle } from "..";
 import { ImageHelper } from "./image-helper";
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/interfaces/ns-capabilities.d.ts b/lib/interfaces/ns-capabilities.d.ts
@@ -2,7 +2,7 @@ import { IDevice } from "mobile-devices-controller";
 export declare enum AutomationName {
     UiAutomator2 = "UIAutomator2",
     Appium = "Appium",
-    XCUITest = "XCUITest"
+    XCUITest = "XCUITest",
 }
 export interface INsCapabilities {
     projectDir: string;
diff --git a/lib/ns-capabilities.ts b/lib/ns-capabilities.ts
@@ -93,12 +93,12 @@ export class NsCapabilities implements INsCapabilities {
 
     private setAutomationName() {
         if (this.appiumCaps["automationName"]) {
-            switch (this.appiumCaps["automationName"]) {
-                case AutomationName.UiAutomator2.toString():
+            switch (this.appiumCaps["automationName"].toLowerCase()) {
+                case AutomationName.UiAutomator2.toString().toLowerCase():
                     this._automationName = AutomationName.UiAutomator2; break;
-                case AutomationName.Appium.toString():
+                case AutomationName.Appium.toString().toLowerCase():
                     this._automationName = AutomationName.Appium; break;
-                case AutomationName.XCUITest.toString():
+                case AutomationName.XCUITest.toString().toLowerCase():
                     this._automationName = AutomationName.XCUITest; break;
             }
         } else {
diff --git a/lib/utils.ts b/lib/utils.ts
@@ -302,8 +302,8 @@ function getAppName(args: INsCapabilities) {
 }
 
 export function getAppPath(caps: INsCapabilities) {
-    let basePath = caps.appPath;
-    if (isFile(basePath)) {
+    let basePath = caps.appiumCaps.app || caps.appPath;
+    if (fs.existsSync(basePath) && ((basePath.endsWith(".apk") || basePath.endsWith(".app") || basePath.endsWith(".ipa")))) {
         return basePath;
     }
 
diff --git a/package.json b/package.json
@@ -1,53 +1,51 @@
 {
-  "name": "nativescript-dev-appium",
-  "version": "3.3.0",
-  "description": "A NativeScript plugin to help integrate and run Appium tests",
-  "author": "NativeScript",
-  "license": "MIT",
-  "main": "./index.js",
-  "directories": {
-    "lib": "./lib"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/NativeScript/nativescript-dev-appium.git"
-  },
-  "keywords": [
-    "nativescript",
-    "appium",
-    "test"
-  ],
-  "maintainers": [
-    {
-      "name": "SvetoslavTsenov",
-      "email": "tsenov@progress.com"
+    "name": "nativescript-dev-appium",
+    "version": "3.3.0",
+    "description": "A NativeScript plugin to help integrate and run Appium tests",
+    "author": "NativeScript",
+    "license": "MIT",
+    "main": "./index.js",
+    "directories": {
+        "lib": "./lib"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/NativeScript/nativescript-dev-appium.git"
+    },
+    "keywords": [
+        "nativescript",
+        "appium",
+        "test"
+    ],
+    "maintainers": [{
+        "name": "SvetoslavTsenov",
+        "email": "tsenov@progress.com"
+    }],
+    "dependencies": {
+        "app-root-path": "~2.0.1",
+        "blink-diff": "~1.0.13",
+        "chai": "~4.1.0",
+        "chai-as-promised": "~7.1.0",
+        "frame-comparer": "^1.0.3",
+        "glob": "7.1.0",
+        "mobile-devices-controller": "~2.5.0",
+        "mocha": "~5.1.0",
+        "mocha-junit-reporter": "~1.17.0",
+        "mocha-multi": "~1.0.0",
+        "wd": "~1.8.0",
+        "webdriverio": "~4.12.0",
+        "yargs": "~8.0.2"
+    },
+    "devDependencies": {
+        "@types/chai": "^4.1.3",
+        "@types/mocha": "^5.2.0",
+        "@types/node": "^8.10.13",
+        "@types/webdriverio": "~4.8.4",
+        "typescript": "^2.8.0"
+    },
+    "scripts": {
+        "postinstall": "node ./postinstall.js",
+        "prepare": "tsc",
+        "watch": "tsc --watch"
     }
-  ],
-  "dependencies": {
-    "app-root-path": "^2.0.1",
-    "blink-diff": "^1.0.13",
-    "chai": "^4.1.0",
-    "chai-as-promised": "^7.1.0",
-    "frame-comparer": "^1.0.3",
-    "glob": "7.1.0",
-    "mobile-devices-controller": "^2.5.0",
-    "mocha": "^5.1.0",
-    "mocha-junit-reporter": "^1.17.0",
-    "mocha-multi": "^1.0.0",
-    "wd": "^1.6.0",
-    "webdriverio": "^4.12.0",
-    "yargs": "^8.0.2"
-  },
-  "devDependencies": {
-    "@types/chai": "^4.1.3",
-    "@types/mocha": "^5.2.0",
-    "@types/node": "^8.10.13",
-    "@types/webdriverio": "~4.8.4",
-    "typescript": "^2.8.0"
-  },
-  "scripts": {
-    "postinstall": "node ./postinstall.js",
-    "prepare": "tsc",
-    "watch": "tsc --watch"
-  }
-}
+}
diff --git a/postinstall.js b/postinstall.js
@@ -72,8 +72,8 @@ function getDevDependencies() {
     // There is need to explicitly install them to the project.
     const typeScriptDevDependencies = [
         //{ name: "tslib", version: "^1.7.1" },
-        { name: "@types/chai", version: "^4.0.2" },
-        { name: "@types/mocha", version: "^2.2.41" },
+        { name: "@types/chai", version: "~4.1.3" },
+        { name: "@types/mocha", version: "~5.2.1" },
         { name: "@types/node", version: "^7.0.5" },
     ];
 
@@ -100,7 +100,7 @@ function configureDevDependencies(packageJson) {
     if (devDependenciesToInstall.length) {
         console.info("Installing new devDependencies ...");
         // Execute `npm install` after everything else
-        setTimeout(function () {
+        setTimeout(function() {
             executeNpmInstall(appRootPath);
         }, 300);
     }
@@ -136,4 +136,4 @@ if (basename(appRootPath) !== "nativescript-dev-appium") {
             console.info("JavaScript project - not adding sample config and test ...");
         }
     }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,8 @@ export class AppiumServer {`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`private startAppiumServer(logLevel: string, isSauceLab: boolean) {`
`87`		`- const startingServerArgs = isSauceLab ? [ "--log-level", logLevel] : ["-p", this.port.toString(), "--log-level", logLevel];`
	`87`	`+ const startingServerArgs: Array<string> = isSauceLab ? ["--log-level", logLevel] : ["-p", this.port.toString(), "--log-level", logLevel];`
	`88`	`+ startingServerArgs.push("--relaxed-security");`
`88`	`89`	`this._server = child_process.spawn(this._appium, startingServerArgs, {`
`89`	`90`	`shell: true,`
`90`	`91`	`detached: false`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ import { IDevice } from "mobile-devices-controller";`
`2`	`2`	`export declare enum AutomationName {`
`3`	`3`	`UiAutomator2 = "UIAutomator2",`
`4`	`4`	`Appium = "Appium",`
`5`		`- XCUITest = "XCUITest"`
	`5`	`+ XCUITest = "XCUITest",`
`6`	`6`	`}`
`7`	`7`	`export interface INsCapabilities {`
`8`	`8`	`projectDir: string;`
Original file line number	Diff line number	Diff line change
`@@ -302,8 +302,8 @@ function getAppName(args: INsCapabilities) {`
`302`	`302`	`}`
`303`	`303`
`304`	`304`	`export function getAppPath(caps: INsCapabilities) {`
`305`		`- let basePath = caps.appPath;`
`306`		`- if (isFile(basePath)) {`
	`305`	`+ let basePath = caps.appiumCaps.app \|\| caps.appPath;`
	`306`	`+ if (fs.existsSync(basePath) && ((basePath.endsWith(".apk") \|\| basePath.endsWith(".app") \|\| basePath.endsWith(".ipa")))) {`
`307`	`307`	`return basePath;`
`308`	`308`	`}`
`309`	`309`