refactor: createDriver

Author: SvetoslavTsenov

index.d.ts

@@ -1,5 +1,6 @@
 import { IDeviceManager } from "./lib/interfaces/device-manager";
 import * as frameComparerHelper from "./lib/frame-comparer";
+import { INsCapabilitiesArgs } from "./lib/interfaces/ns-capabilities-args";
 export { AppiumDriver } from "./lib/appium-driver";
 export { AppiumServer } from "./lib/appium-server";
 export { ElementHelper } from "./lib/element-helper";
@@ -13,9 +14,11 @@ export { FrameComparer } from "./lib/frame-comparer";
 export { IRectangle } from "./lib/interfaces/rectangle";
 export { IDeviceManager } from "./lib/interfaces/device-manager";
 export { LogType } from "./lib/log-types";
+export { INsCapabilities } from "./lib/interfaces/ns-capabilities";
+export { INsCapabilitiesArgs } from "./lib/interfaces/ns-capabilities-args";
 export declare function startServer(port?: number, deviceManager?: IDeviceManager): Promise<void>;
 export declare function stopServer(): Promise<void>;
-export declare function createDriver(): Promise<any>;
+export declare function createDriver(args?: INsCapabilitiesArgs): Promise<any>;
 /**
  * Provide instance of FrameComparer in order to compare frames/ images from video
  * Please read carefully README.md before using it.

index.ts

@@ -6,7 +6,10 @@ import * as frameComparerHelper from "./lib/frame-comparer";
 import { FrameComparer } from "./lib/frame-comparer";
 import { DeviceManager } from "./lib/device-manager";
 import { DeviceController } from "mobile-devices-controller";
-import { logInfo, logError } from "./lib/utils";
+import { logInfo, logError, logWarn } from "./lib/utils";
+import { INsCapabilities } from "./lib/interfaces/ns-capabilities";
+import { INsCapabilitiesArgs } from "./lib/interfaces/ns-capabilities-args";
+import * as parser from "./lib/parser"
 
 export { AppiumDriver } from "./lib/appium-driver";
 export { AppiumServer } from "./lib/appium-server";
@@ -21,8 +24,10 @@ export { FrameComparer } from "./lib/frame-comparer";
 export { IRectangle } from "./lib/interfaces/rectangle";
 export { IDeviceManager } from "./lib/interfaces/device-manager";
 export { LogType } from "./lib/log-types";
+export { INsCapabilities } from "./lib/interfaces/ns-capabilities";
+export { INsCapabilitiesArgs } from "./lib/interfaces/ns-capabilities-args";
 
-const nsCapabilities = new NsCapabilities();
+const nsCapabilities: INsCapabilities = new NsCapabilities({ ...<INsCapabilities>parser });
 const appiumServer = new AppiumServer(nsCapabilities);
 let frameComparer: FrameComparer;
 let appiumDriver = null;
@@ -64,7 +69,7 @@ if (nsCapabilities.startSession) {
 }
 
 export async function startServer(port?: number, deviceManager?: IDeviceManager) {
-    await appiumServer.start(port || nsCapabilities.port, deviceManager);
+    await appiumServer.start(port, deviceManager);
     await attachToExitProcessHoockup(appiumServer.server, "appium");
 }
 
@@ -81,13 +86,18 @@ export async function stopServer() {
     }
 };
 
-export async function createDriver() {
+export async function createDriver(args?: INsCapabilitiesArgs) {
+    if (args) {
+        nsCapabilities.extend(args);
+    }
+    const port = nsCapabilities.port || appiumServer.port;
+
     if (nsCapabilities.attachToDebug) {
-        appiumDriver = await AppiumDriver.createAppiumDriver(appiumServer.port, nsCapabilities);
+        appiumDriver = await AppiumDriver.createAppiumDriver(port, nsCapabilities);
         return appiumDriver;
     }
     if (!appiumServer.server) {
-        throw new Error("Server is not available!");
+        logWarn("Server is not available!");
     }
     if (!nsCapabilities.appiumCapsLocation) {
         throw new Error("Provided path to appium capabilities is not correct!");
@@ -99,7 +109,7 @@ export async function createDriver() {
     if (appiumDriver !== null && appiumDriver.isAlive) {
         return appiumDriver;
     } else if (appiumDriver === null) {
-        appiumDriver = await AppiumDriver.createAppiumDriver(appiumServer.port, nsCapabilities);
+        appiumDriver = await AppiumDriver.createAppiumDriver(port, nsCapabilities);
     } else if (appiumDriver !== null && !appiumDriver.isAlive) {
         await appiumDriver.init();
     }

lib/appium-driver.d.ts

@@ -1,4 +1,4 @@
-export declare var should: any;
+export declare const should: any;
 import { ElementHelper } from "./element-helper";
 import { SearchOptions } from "./search-options";
 import { UIElement } from "./ui-element";

lib/appium-driver.ts

@@ -1,11 +1,11 @@
-var chai = require("chai");
 import * as wd from "wd";
-var chaiAsPromised = require("chai-as-promised");
+import * as webdriverio from "webdriverio";
+const chai = require("chai");
+const chaiAsPromised = require("chai-as-promised");
 chai.use(chaiAsPromised);
-export var should = chai.should();
+export const should = chai.should();
 chaiAsPromised.transferPromiseness = wd.transferPromiseness;
 
-import { ChildProcess } from "child_process";
 import { ElementHelper } from "./element-helper";
 import { SearchOptions } from "./search-options";
 import { UIElement } from "./ui-element";
@@ -16,8 +16,7 @@ import {
     DeviceController,
     IDevice,
     DeviceType,
-    AndroidController,
-    IOSController
+    AndroidController
 } from "mobile-devices-controller";
 import {
     addExt,
@@ -42,7 +41,6 @@ import { Point } from "./point";
 import { ImageHelper } from "./image-helper";
 import { ImageOptions } from "./image-options"
 import { unlinkSync, writeFileSync } from "fs";
-import * as webdriverio from "webdriverio";
 import { DeviceManager } from "../lib/device-manager";
 import { extname, basename } from "path";
 import { LogType } from "./log-types";
@@ -180,6 +178,10 @@ export class AppiumDriver {
             port: port
         };
 
+        if(!args.isValidated){
+            args.validateArgs();
+        }
+
         if (args.isSauceLab) {
             const sauceUser = process.env.SAUCE_USER || process.env.npm_config["SAUCE_USER"];
             const sauceKey = process.env.SAUCE_KEY || process.env.npm_config["SAUCE_KEY"];
@@ -194,6 +196,9 @@ export class AppiumDriver {
         log("Creating driver!", args.verbose);
 
         if (!args.attachToDebug && !args.sessionId) {
+            if (!args.device) {
+                args.device = DeviceManager.getDefaultDevice(args);
+            }
             await AppiumDriver.applyAdditionalSettings(args);
         }
 

lib/appium-server.ts

@@ -26,6 +26,7 @@ export class AppiumServer {
     constructor(private _args: INsCapabilities) {
         this._runType = this._args.runType;
         this._hasStarted = false;
+        this._port = _args.port;
         this.resolveAppiumDependency();
     }
 
@@ -58,6 +59,10 @@ export class AppiumServer {
     }
 
     public async start(port, deviceManager: IDeviceManager = new DeviceManager()) {
+        if(!this._args.isValidated){
+            this._args.validateArgs();
+            this._args.port = port;
+        }
         this._args.deviceManager = deviceManager;
         if (!this._args.attachToDebug && !this._args.sessionId) {
             await this.prepDevice(deviceManager);

lib/automation-name.d.ts

@@ -0,0 +1,5 @@
+export declare enum AutomationName {
+    UiAutomator2 = "UIAutomator2",
+    Appium = "Appium",
+    XCUITest = "XCUITest"
+}

lib/automation-name.ts

@@ -0,0 +1,5 @@
+export enum AutomationName {
+    UiAutomator2 = "UIAutomator2",
+    Appium = "Appium",
+    XCUITest = "XCUITest",
+}

lib/interfaces/ins-capabilities.d.ts

@@ -0,0 +1,38 @@
+import { IDevice } from "mobile-devices-controller";
+import { IDeviceManager } from "./device-manager";
+import { AutomationName } from "../automation-name";
+export interface INsCapabilitiesArgs {
+    port?: number;
+    wdaLocalPort?: number;
+    projectDir?: string;
+    projectBinary?: string;
+    pluginRoot?: string;
+    pluginBinary?: string;
+    testFolder?: string;
+    sessionId?: string;
+    appiumCapsLocation?: string;
+    runType?: string;
+    appPath?: string;
+    appName?: string;
+    emulatorOptions?: string;
+    storage?: string;
+    testReports?: string;
+    path?: string;
+    capabilitiesName?: string;
+    attachToDebug?: boolean;
+    startSession?: boolean;
+    verbose?: boolean;
+    isAndroid?: boolean;
+    isIOS?: boolean;
+    isSauceLab?: boolean;
+    reuseDevice?: boolean;
+    ignoreDeviceController?: boolean;
+    relaxedSecurity?: boolean;
+    devMode?: boolean;
+    cleanApp?: boolean;
+    isValidated?: boolean;
+    appiumCaps?: any;
+    device?: IDevice;
+    automationName?: AutomationName;
+    deviceManager?: IDeviceManager;
+}

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

@@ -0,0 +1,39 @@
+import { IDevice } from "mobile-devices-controller";
+import { IDeviceManager } from "./device-manager";
+import { AutomationName } from "../automation-name";
+
+export interface INsCapabilitiesArgs {
+    port?: number;
+    wdaLocalPort?: number;
+    projectDir?: string;
+    projectBinary?: string;
+    pluginRoot?: string;
+    pluginBinary?: string;
+    testFolder?: string;
+    sessionId?: string;
+    appiumCapsLocation?: string;
+    runType?: string;
+    appPath?: string;
+    appName?: string;
+    emulatorOptions?: string;
+    storage?: string;
+    testReports?: string;
+    path?: string;
+    capabilitiesName?: string;
+    attachToDebug?: boolean;
+    startSession?: boolean;
+    verbose?: boolean;
+    isAndroid?: boolean;
+    isIOS?: boolean;
+    isSauceLab?: boolean;
+    reuseDevice?: boolean;
+    ignoreDeviceController?: boolean;
+    relaxedSecurity?: boolean,
+    devMode?: boolean;
+    cleanApp?: boolean,
+    isValidated?: boolean,
+    appiumCaps?: any;
+    device?: IDevice;
+    automationName?: AutomationName;
+    deviceManager?: IDeviceManager;
+}