feat: start session command. (#207)

* feat: start session command.

It is very useful to reuse already running server and driver. To start simply run ns-start-session [options]

Author: SvetoslavTsenov

bin/start-session

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+
+"use strict";
+require("../lib/helpers/start-session.js");

bin/start-session.cmd

@@ -0,0 +1 @@
+@node %~dp0\start-session %*

lib/appium-driver.d.ts

@@ -85,7 +85,13 @@ export declare class AppiumDriver {
      * @param text
      * @param waitForElement
      */
-    findElementByAutomationText(automationText: string, waitForElement?: number): Promise<any>;
+    findElementByAutomationText(automationText: string, waitForElement?: number): Promise<UIElement>;
+    /**
+     * Search for element by given automationText. Searches only for exact string.
+     * @param text
+     * @param waitForElement
+    */
+    findElementByAutomationTextIfExists(automationText: string, waitForElement?: number): Promise<any>;
     /**
      * Search for element by given automationText and waits until the element is displayed.
      * @param text

lib/appium-driver.ts

@@ -320,6 +320,18 @@ export class AppiumDriver {
      * @param waitForElement
      */
     public async findElementByAutomationText(automationText: string, waitForElement: number = this.defaultWaitTime) {
+        if (this.isIOS) {
+            return await this.findElementByAccessibilityId(`${automationText}`, waitForElement);
+        }
+        return await this.findElementByXPath(this._elementHelper.getXPathByText(automationText, true), waitForElement);
+    }
+
+    /**
+     * Search for element by given automationText. Searches only for exact string.
+     * @param text
+     * @param waitForElement
+    */
+    public async findElementByAutomationTextIfExists(automationText: string, waitForElement: number = this.defaultWaitTime) {
         if (this.isIOS) {
             return await this.findElementByAccessibilityIdIfExists(`${automationText}`, waitForElement);
         }
@@ -334,12 +346,12 @@ export class AppiumDriver {
     public async waitForElement(automationText: string, waitInMilliseconds: number = this.defaultWaitTime): Promise<UIElement> {
         let element;
         try {
-            element = await this.findElementByAutomationText(automationText, 100);
+            element = await this.findElementByAutomationTextIfExists(automationText, 100);
         } catch (error) { }
         const startTime = Date.now();
         while ((!element || !(await element.isDisplayed())) && Date.now() - startTime <= waitInMilliseconds) {
             try {
-                element = await this.findElementByAutomationText(automationText, 100);
+                element = await this.findElementByAutomationTextIfExists(automationText, 100);
             } catch (error) { }
         }
 
@@ -730,7 +742,7 @@ export class AppiumDriver {
      * @param time in minutes
      */
     public async backgroundApp(minutes: number) {
-        console.log("Sending the currently active app to the background ...");
+        logInfo("Sending the currently active app to the background ...");
         await this._driver.backgroundApp(minutes);
     }
 
@@ -756,20 +768,23 @@ export class AppiumDriver {
     }
 
     public async quit() {
-        console.log("Killing driver");
         if (this._recordVideoInfo && this._recordVideoInfo['videoRecordingProcess']) {
             this._recordVideoInfo['videoRecordingProcess'].kill("SIGINT");
         }
         try {
             if (!this._args.attachToDebug) {
+                console.log("Killing driver...");
                 await this._driver.quit();
+                this._isAlive = false;
+                console.log("Driver is dead!");
             } else {
                 //await this._webio.detach();
             }
         } catch (error) {
+            if (this._args.verbose) {
+                console.dir(error);
+            }
         }
-        this._isAlive = false;
-        console.log("Driver is dead");
     }
 
     private static async applyAdditionalSettings(args) {
@@ -817,13 +832,16 @@ export class AppiumDriver {
 
     private static configureLogging(driver, verbose) {
         driver.on("status", function (info) {
-            log(info.cyan, verbose);
+            log(info, verbose);
+        });
+        driver.on("quit", function (info) {
+            console.log("QUIT: ", info);
         });
         driver.on("command", function (meth, path, data) {
-            log(" > " + meth.yellow + path.grey + " " + (data || ""), verbose);
+            log(" > " + meth + " " + path + " " + (data || ""), verbose);
         });
         driver.on("http", function (meth, path, data) {
-            log(" > " + meth.magenta + path + " " + (data || "").grey, verbose);
+            log(" > " + meth + " " + path + " " + (data || ""), verbose);
         });
     };
 
@@ -945,4 +963,4 @@ export class AppiumDriver {
 
         return new UIElement(searchResult, this._driver, this._wd, this._webio, this._args, "elementByImage", imageAsBase64);
     }
-}
+}

lib/appium-server.ts

@@ -1,4 +1,4 @@
-import { ChildProcess, spawn } from "child_process";
+import { ChildProcess, spawn, execSync } from "child_process";
 import {
     log,
     resolvePath,
@@ -9,7 +9,8 @@ import {
     logWarn,
     logInfo,
     prepareApp,
-    prepareDevice
+    prepareDevice,
+    stopServerCommand
 } from "./utils";
 import { INsCapabilities } from "./interfaces/ns-capabilities";
 import { IDeviceManager } from "./interfaces/device-manager";

lib/helpers/start-session.d.ts

@@ -0,0 +1,2 @@
+import { INsCapabilities } from "../interfaces/ns-capabilities";
+export declare const nsCapabilities: INsCapabilities;

lib/helpers/start-session.ts

@@ -0,0 +1,42 @@
+import { execSync } from "child_process";
+import { NsCapabilities } from "../ns-capabilities";
+import { AppiumServer } from "../appium-server";
+import { AppiumDriver } from "../appium-driver";
+import { isWin, logInfo, logError, stopServerCommand } from "../utils";
+import * as parser from "../parser"
+import { INsCapabilities } from "../interfaces/ns-capabilities";
+
+export const nsCapabilities: INsCapabilities = new NsCapabilities(parser);
+let server: AppiumServer;
+const startSession = async () => {
+    if (!isWin()) {
+        execSync(stopServerCommand(nsCapabilities.port));
+        console.log(stopServerCommand(nsCapabilities.port));
+    }
+
+    nsCapabilities.validateArgs();
+    nsCapabilities.appiumCaps = nsCapabilities.appiumCaps || {};
+    nsCapabilities.appiumCaps["newCommandTimeout"] = 300;
+    server = new AppiumServer(nsCapabilities);
+    await server.start(nsCapabilities.port);
+    const driver = await AppiumDriver.createAppiumDriver(nsCapabilities);
+    const session = await driver.sessionId();
+    logInfo(`port: ${nsCapabilities.port}`);
+    logInfo(`session id: ${session}`);
+}
+
+startSession().then(s => {
+    logInfo("session started")
+});
+
+process.once("uncaughtException", async () => {
+    logError(`uncaughtException!`)
+})
+
+process.once("SIGINT", async () => {
+    if (!isWin()) {
+        console.log(`stop server!`)
+        execSync(stopServerCommand(nsCapabilities.port));
+    }
+    await server.stop();
+})

lib/parser.d.ts

@@ -1 +1 @@
-export declare const projectDir: string, projectBinary: string, pluginRoot: string, pluginBinary: string, port: number, verbose: boolean, appiumCapsLocation: string, testFolder: string, runType: string, isSauceLab: boolean, appPath: string, storage: string, testReports: string, devMode: boolean, ignoreDeviceController: boolean, wdaLocalPort: number, path: string, relaxedSecurity: boolean, cleanApp: boolean, attachToDebug: boolean, sessionId: string, startSession: boolean, capabilitiesName: string, imagesPath: string, startDeviceOptions: string, deviceTypeOrPlatform: string, device: any, driverConfig: any;
+export declare const projectDir: string, projectBinary: string, pluginRoot: string, pluginBinary: string, port: number, verbose: boolean, appiumCapsLocation: string, testFolder: string, runType: string, isSauceLab: boolean, appPath: string, storage: string, testReports: string, devMode: boolean, ignoreDeviceController: boolean, wdaLocalPort: number, path: string, relaxedSecurity: boolean, cleanApp: boolean, attachToDebug: boolean, sessionId: string, startSession: boolean, capabilitiesName: string, imagesPath: string, startDeviceOptions: string, deviceTypeOrPlatform: string, device: import("mobile-devices-controller/lib/device").IDevice, driverConfig: any;

lib/parser.ts

@@ -1,6 +1,6 @@
 import * as yargs from "yargs";
 import { join } from "path";
-import { resolvePath, logError } from "./utils";
+import { resolvePath, logError, logWarn } from "./utils";
 import { INsCapabilitiesArgs } from "./interfaces/ns-capabilities-args";
 
 const config = (() => {
@@ -105,8 +105,8 @@ const config = (() => {
         options.devMode = true;
         console.log(`Option attachToDebug is set to true. Option --devMode is set true as well !`)
         if (!options.port) {
-            logError("Provide appium server port started from desktop application!")
-            process.exit(1);
+            logWarn(`Default appium server port 4732!`);
+            logWarn(`In order to change it use --port option!`);
         }
     }
 

lib/utils.d.ts

@@ -39,6 +39,7 @@ export declare const prepareApp: (args: INsCapabilities) => Promise<INsCapabilit
 export declare const sessionIds: (port: any) => Promise<any[]>;
 export declare function encodeImageToBase64(path: any): string;
 export declare const shouldUserMobileDevicesController: (args: INsCapabilities) => boolean;
+export declare const stopServerCommand: (port: any) => string;
 export declare function logInfo(info: any, obj?: any): void;
 export declare function logWarn(info: any, obj?: any): void;
 export declare function logError(info: any, obj?: any): void;