Tsenov/uiautomator2 (#122)

* feat: include support for UiAutomator2

Author: SvetoslavTsenov

lib/interfaces/ns-capabilities.d.ts

@@ -1,4 +1,9 @@
 import { IDevice } from "mobile-devices-controller";
+export declare enum AutomationName {
+    UiAutomator2 = "UiAutomator2",
+    Appium = "Appium",
+    XCUITest = "XCUITest",
+}
 export interface INsCapabilities {
     projectDir: string;
     projectBinary: string;
@@ -24,4 +29,5 @@ export interface INsCapabilities {
     ignoreDeviceController: boolean;
     wdaLocalPort: number;
     path: string;
+    automationName: AutomationName;
 }

lib/interfaces/ns-capabilities.ts

@@ -1,5 +1,11 @@
 import { IDevice } from "mobile-devices-controller";
 
+export enum AutomationName {
+    UiAutomator2 = "UiAutomator2",
+    Appium = "Appium",
+    XCUITest = "XCUITest",
+}
+
 export interface INsCapabilities {
     projectDir: string;
     projectBinary: string;
@@ -25,4 +31,5 @@ export interface INsCapabilities {
     ignoreDeviceController: boolean;
     wdaLocalPort: number;
     path: string;
+    automationName: AutomationName;
 }

lib/ns-capabilities.d.ts

@@ -1,4 +1,4 @@
-import { INsCapabilities } from "./interfaces/ns-capabilities";
+import { INsCapabilities, AutomationName } from "./interfaces/ns-capabilities";
 import { IDevice } from "mobile-devices-controller";
 export declare class NsCapabilities implements INsCapabilities {
     private _projectDir;
@@ -22,6 +22,7 @@ export declare class NsCapabilities implements INsCapabilities {
     private _appPath;
     private _path;
     private _emulatorOptions;
+    private _automationName;
     private _device;
     private _ignoreDeviceController;
     private _wdaLocalPort;
@@ -45,13 +46,16 @@ export declare class NsCapabilities implements INsCapabilities {
     readonly isAndroid: any;
     readonly isIOS: any;
     readonly isSauceLab: any;
+    readonly automationName: AutomationName;
     readonly appPath: string;
     appName: string;
     ignoreDeviceController: boolean;
     readonly wdaLocalPort: number;
     device: IDevice;
     readonly emulatorOptions: string;
     private isAndroidPlatform();
+    private setAutomationName();
+    tryGetAndroidApiLevel(): number;
     private resolveApplication();
     private checkMandatoryCapabiliies();
     private throwExceptions();

lib/ns-capabilities.ts

@@ -1,5 +1,5 @@
 import * as parser from "./parser"
-import { INsCapabilities } from "./interfaces/ns-capabilities";
+import { INsCapabilities, AutomationName } from "./interfaces/ns-capabilities";
 import { resolveCapabilities } from "./capabilities-helper";
 import { getAppPath, fileExists, logErr } from "./utils";
 import { IDevice } from "mobile-devices-controller";
@@ -26,6 +26,7 @@ export class NsCapabilities implements INsCapabilities {
     private _appPath: string;
     private _path: string;
     private _emulatorOptions: string;
+    private _automationName: AutomationName;
     private _device: IDevice;
     private _ignoreDeviceController: boolean;
     private _wdaLocalPort: number;
@@ -53,6 +54,7 @@ export class NsCapabilities implements INsCapabilities {
         this._ignoreDeviceController = parser.ignoreDeviceController;
         this._wdaLocalPort = parser.wdaLocalPort;
         this._path = parser.path;
+        this.setAutomationName();
         this.resolveApplication();
         this.checkMandatoryCapabiliies();
         this.throwExceptions();
@@ -76,6 +78,7 @@ export class NsCapabilities implements INsCapabilities {
     get isAndroid() { return this._isAndroid; }
     get isIOS() { return this._isIOS; }
     get isSauceLab() { return this._isSauceLab; }
+    get automationName() { return this._automationName; }
     get appPath() { return this._appPath; }
     get appName() { return this._appName; }
     set appName(appName: string) { this._appName = appName; }
@@ -88,6 +91,40 @@ export class NsCapabilities implements INsCapabilities {
 
     private isAndroidPlatform() { return this._appiumCaps.platformName.toLowerCase().includes("android"); }
 
+    private setAutomationName() {
+        if (this.appiumCaps["automationName"]) {
+            switch (this.appiumCaps["automationName"]) {
+                case AutomationName.UiAutomator2.toString():
+                    this._automationName = AutomationName.UiAutomator2; break;
+                case AutomationName.Appium.toString():
+                    this._automationName = AutomationName.Appium; break;
+                case AutomationName.XCUITest.toString():
+                    this._automationName = AutomationName.XCUITest; break;
+            }
+        } else {
+            if (this._isAndroid) {
+                if (this.tryGetAndroidApiLevel() > 24 || (this.appiumCaps["apiLevel"] && this.appiumCaps["apiLevel"].toLowerCase().includes("p"))) {
+                    this._automationName = AutomationName.UiAutomator2;
+                }
+            }
+        }
+
+        if (this._automationName) {
+            this.appiumCaps["automationName"] = this._automationName.toString();
+            console.log(`Automation name set to: ${this.appiumCaps["automationName"]}`);
+            console.log(`To change automation name, you need to set it in appium capabilities!`);
+        } else {
+            console.log(`Appium will use default automation name`);
+        }
+    }
+
+    tryGetAndroidApiLevel() {
+        try {
+            return parseInt(this.appiumCaps["platformVersion"]);
+        } catch (error) {
+        }
+    }
+
     private resolveApplication() {
         if (this.isSauceLab) {
             this._appiumCaps.app = `sauce-storage:${this.appPath}`

lib/ui-element.d.ts

@@ -15,6 +15,12 @@ export declare class UIElement {
      * Click on element
      */
     click(): Promise<any>;
+    /**
+    * Click a point by providing coordinates
+    * @param x
+    * @param y
+    */
+    tapCenter(): Promise<void>;
     /**
      * Tap on element
      */

lib/ui-element.ts

@@ -1,6 +1,6 @@
 import { Point } from "./point";
 import { Direction } from "./direction";
-import { INsCapabilities } from "./interfaces/ns-capabilities";
+import { INsCapabilities, AutomationName } from "./interfaces/ns-capabilities";
 import { IRectangle } from "./interfaces/rectangle";
 import { calculateOffset } from "./utils";
 
@@ -22,11 +22,29 @@ export class UIElement {
         return await (await this.element()).click();
     }
 
+    /**
+    * Click a point by providing coordinates
+    * @param x
+    * @param y
+    */
+    public async tapCenter() {
+        let action = new this._wd.TouchAction(this._driver);
+        const rect = await this.getActualRectangle();
+        action
+            .tap({ x: rect.x + rect.width / 2, y: rect.y + rect.height / 2 });
+        await action.perform();
+        await this._driver.sleep(150);
+    }
+
     /**
      * Tap on element
      */
     public async tap() {
-        return await (await this.element()).tap();
+        if (this._args.automationName == AutomationName.UiAutomator2) {
+            return await this.tapCenter();
+        } else {
+            return await (await this.element()).tap();
+        }
     }
 
     /**