feat: expose isAndroid and isIOS (#62)

* feat: expose isAndroid and isIOS

* refactor: expose isAndroid and isIOS

Author: Vasil Chimev

lib/appium-driver.d.ts

@@ -31,6 +31,8 @@ export declare class AppiumDriver {
     readonly elementHelper: ElementHelper;
     readonly locators: Locator;
     readonly isAlive: boolean;
+    readonly isAndroid: boolean;
+    readonly isIOS: boolean;
     readonly driver: any;
     webio(): any;
     wd(): any;

lib/appium-driver.ts

@@ -41,10 +41,10 @@ export class AppiumDriver {
     private _storage: string;
 
     private constructor(private _driver: any, private _wd, private _webio: any, private _driverConfig, private _args: INsCapabilities) {
-        this._elementHelper = new ElementHelper(this._args.appiumCaps.platformName.toLowerCase(), this._args.appiumCaps.platformVersion.toLowerCase());
+        this._elementHelper = new ElementHelper(this._args);
         this._imageHelper = new ImageHelper(this._args);
         this._isAlive = true;
-        this._locators = new Locator(this._args.appiumCaps.platformName, this._args.appiumCaps.platformVersion);
+        this._locators = new Locator(this._args);
         this._webio.requestHandler.sessionID = this._driver.sessionID;
     }
 
@@ -84,6 +84,14 @@ export class AppiumDriver {
         return this._isAlive;
     }
 
+    get isAndroid() {
+        return this._args.isAndroid;
+    }
+
+    get isIOS() {
+        return this._args.isIOS;
+    }
+
     get driver() {
         return this._driver;
     }

lib/element-helper.d.ts

@@ -1,9 +1,8 @@
+import { INsCapabilities } from "./ins-capabilities";
 export declare class ElementHelper {
-    private _platform;
-    private _platformVersion;
+    private _args;
     private locators;
-    private isAndroid;
-    constructor(_platform: string, _platformVersion: number);
+    constructor(_args: INsCapabilities);
     getXPathElement(name: any): void;
     getXPathByText(text: any, exactMatch: any): string;
     getXPathWithExactText(text: any): string;

lib/element-helper.ts

@@ -1,15 +1,14 @@
 import { contains } from "./utils";
 import { log } from "./utils";
+import { INsCapabilities } from "./ins-capabilities";
 import { Locator } from "./locators";
 
 export class ElementHelper {
 
-    private locators : Locator;
+    private locators: Locator;
 
-    private isAndroid: boolean;
-    constructor(private _platform: string, private _platformVersion: number) {
-        this.isAndroid = this._platform === "android";
-        this.locators = new Locator(this._platform, this._platformVersion)
+    constructor(private _args: INsCapabilities) {
+        this.locators = new Locator(this._args)
     }
 
     public getXPathElement(name) {
@@ -31,19 +30,19 @@ export class ElementHelper {
 
     public findByTextLocator(controlType, value, exactMatch) {
         let artbutes = ["label", "value", "hint"];
-        if (this.isAndroid) {
+        if (this._args.isAndroid) {
             artbutes = ["content-desc", "resource-id", "text"];
         }
 
         let searchedString = "";
         if (exactMatch) {
-            if (this.isAndroid) {
+            if (this._args.isAndroid) {
                 artbutes.forEach((atr) => { searchedString += "translate(@" + atr + ",'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz')='" + value.toLowerCase() + "'" + " or " });
             } else {
                 artbutes.forEach((atr) => { searchedString += "@" + atr + "='" + value + "'" + " or " });
             }
         } else {
-            if (this.isAndroid) {
+            if (this._args.isAndroid) {
                 artbutes.forEach((atr) => { searchedString += "contains(translate(@" + atr + ",'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz'),'" + value.toLowerCase() + "')" + " or " });
             } else {
                 artbutes.forEach((atr) => { searchedString += "contains(@" + atr + ",'" + value + "')" + " or " });

lib/ins-capabilities.d.ts

@@ -10,6 +10,8 @@ export interface INsCapabilities {
     appiumCaps: any;
     testFolder: string;
     runType: string;
+    isAndroid: boolean;
+    isIOS: boolean;
     isSauceLab: boolean;
     appPath: string;
     emulatorOptions: string;

lib/ins-capabilities.ts

@@ -11,12 +11,14 @@ export interface INsCapabilities {
     appiumCaps: any;
     testFolder: string;
     runType: string;
+    isAndroid: boolean;
+    isIOS: boolean;
     isSauceLab: boolean;
     appPath: string;
     emulatorOptions: string;
     storage: string;
     testReports: string;
     reuseDevice: boolean;
-    device:IDevice;
+    device: IDevice;
     ignoreDeviceController: boolean;
 }

lib/locators.d.ts

@@ -1,8 +1,8 @@
+import { INsCapabilities } from "./ins-capabilities";
 export declare class Locator {
-    private _platformName;
-    private _platformVersion;
+    private _args;
     private _elementsList;
-    constructor(_platformName: string, _platformVersion: any);
+    constructor(_args: INsCapabilities);
     readonly button: string;
     readonly listView: string;
     readonly image: string;

lib/locators.ts

@@ -4,9 +4,9 @@ export class Locator {
 
     private _elementsList: Map<string, string>;
 
-    constructor(private _platformName: string, private _platformVersion) {
+    constructor(private _args: INsCapabilities) {
         this._elementsList = new Map<string, string>();
-        if (this._platformName.toLowerCase().includes("android")) {
+        if (this._args.isAndroid) {
             this.loadAndroidElements();
         } else {
             this.loadIOSElements();
@@ -105,7 +105,7 @@ export class Locator {
 
     private createIosElement(element) {
         let elementType = "UIA";
-        if (parseFloat(this._platformVersion) >= 10) {
+        if (parseFloat(this._args.appiumCaps.platformVersion) >= 10) {
             elementType = "XCUIElementType";
         }
 

lib/ns-capabilities.d.ts

@@ -14,6 +14,8 @@ export declare class NsCapabilities implements INsCapabilities {
     private _testReports;
     private _reuseDevice;
     private _runType;
+    private _isAndroid;
+    private _isIOS;
     private _isSauceLab;
     private _appPath;
     private _emulatorOptions;
@@ -34,11 +36,14 @@ export declare class NsCapabilities implements INsCapabilities {
     readonly testReports: any;
     readonly reuseDevice: any;
     readonly runType: any;
+    readonly isAndroid: any;
+    readonly isIOS: any;
     readonly isSauceLab: any;
     appPath: string;
     readonly ignoreDeviceController: boolean;
     device: IDevice;
     readonly emulatorOptions: string;
+    private isAndroidPlatform();
     private resolveAppPath();
     private checkMandatoryCapabiliies();
     private throwExceptions();

lib/ns-capabilities.ts

@@ -18,6 +18,8 @@ export class NsCapabilities implements INsCapabilities {
     private _testReports;
     private _reuseDevice;
     private _runType;
+    private _isAndroid;
+    private _isIOS;
     private _isSauceLab;
     private _appPath: string;
     private _emulatorOptions: string;
@@ -34,14 +36,16 @@ export class NsCapabilities implements INsCapabilities {
         this._port = parser.port;
         this._verbose = parser.verbose;
         this._appiumCapsLocation = parser.appiumCapsLocation;
+        this._appiumCaps = resolveCapabilities(this._appiumCapsLocation, parser.runType, parser.projectDir);
         this._testFolder = parser.testFolder;
         this._storage = parser.storage;
         this._testReports = parser.testReports;
         this._reuseDevice = parser.reuseDevice;
         this._runType = parser.runType;
+        this._isAndroid = this.isAndroidPlatform();
+        this._isIOS = !this._isAndroid;
         this._isSauceLab = parser.isSauceLab;
         this._ignoreDeviceController = parser.ignoreDeviceController;
-        this._appiumCaps = resolveCapabilities(this._appiumCapsLocation, parser.runType, parser.projectDir);
         this.resolveAppPath();
         this.checkMandatoryCapabiliies();
         this.throwExceptions();
@@ -60,6 +64,8 @@ export class NsCapabilities implements INsCapabilities {
     get testReports() { return this._testReports; }
     get reuseDevice() { return this._reuseDevice; }
     get runType() { return this._runType; }
+    get isAndroid() { return this._isAndroid; }
+    get isIOS() { return this._isIOS; }
     get isSauceLab() { return this._isSauceLab; }
     get appPath() { return this._appPath; }
     get ignoreDeviceController() { return this._ignoreDeviceController; }
@@ -68,6 +74,8 @@ export class NsCapabilities implements INsCapabilities {
     set device(device: IDevice) { this._device = device; }
     get emulatorOptions() { return (this._emulatorOptions || "-wipe-data -gpu on") }
 
+    private isAndroidPlatform() { return this._appiumCaps.platformName.toLowerCase().includes("android"); }
+
     private resolveAppPath() {
         if (this._appPath) {
             this._appiumCaps.app = this._appPath;
@@ -92,7 +100,7 @@ export class NsCapabilities implements INsCapabilities {
             this.exceptions.push("Platform name is missing! Please, check appium capabilities file!");
         }
 
-        if (!this._appiumCaps.platformName) {
+        if (!this._appiumCaps.platformVersion) {
             this.exceptions.push("Platform version is missing! Please, check appium capabilities file!");
         }