feature: deviceLog

SvetoslavTsenov · SvetoslavTsenov · commit 1279323c4f79 · 2018-07-04T14:03:08.000+03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,7 +13,8 @@
 * attach to session option "--attachToDebug"
 * create session "--createSession"
 * option "--sessionId" to provide specific session
-* get device log
+* exposed driver.getDeviceLog() which will return device log
+* exposed driver.logDeviceLog(fileName, logtype) which will create such file with postfix `${fileName}_${logtype}.log` in reports folder under appName/deviceName
 * **android:** provide option "--relaxedSecurity" to enable relaxed security and execute shell commands using appium android driver (#126) ([ce780bf](https://github.com/NativeScript/nativescript-dev-appium/commit/ce780bf)), closes [#126](https://github.com/NativeScript/nativescript-dev-appium/issues/126)
 
 +### BREAKING CHANGES
diff --git a/README.md b/README.md
@@ -293,7 +293,7 @@ $ npm run e2e -- --runType android25
 
 Starting new session will console log appium server port and session id
 ```
-$ node ./node_modules/.bin/ns-appium -- --runType android23 --startSession 
+$ node ./node_modules/.bin/ns-appium --runType android23 --startSession 
 ```
 
 Run tests with already started session. Specify session id and server port. Default value for server port is 8300
diff --git a/lib/appium-driver.d.ts b/lib/appium-driver.d.ts
@@ -55,7 +55,6 @@ export declare class AppiumDriver {
      * Get the storage where images are captured. It will be resources/app nam/device name
      */
     readonly storageByDeviceName: string;
-    getlog(logType: LogType): Promise<any>;
     static createAppiumDriver(port: number, args: INsCapabilities): Promise<AppiumDriver>;
     /**
      *
@@ -163,7 +162,14 @@ export declare class AppiumDriver {
     prepareImageToCompare(filePath: string, rect: IRectangle): Promise<void>;
     takeScreenshot(fileName: string): Promise<string>;
     logScreenshot(fileName: string): Promise<string>;
+    getlog(logType: LogType): Promise<any>;
     logPageSource(fileName: string): Promise<void>;
+    logDeviceLog(fileName: any, logType: LogType, filter?: string): Promise<void>;
+    /**
+     * This method will snapshot the screen of device, get page source and log from device
+     * @param logName
+     */
+    logTestArtifacts(logName: string): Promise<void>;
     /**
      * Send the currently active app to the background
      * @param time
diff --git a/lib/appium-driver.ts b/lib/appium-driver.ts
@@ -158,11 +158,6 @@ export class AppiumDriver {
         return this._storageByDeviceName;
     }
 
-    public async getlog(logType: LogType) {
-        const logs = await this._driver.log(logType);
-        return logs;
-    }
-
     // Still not supported in wd
     // public async getPerformanceDataTypes() {
     //     return await this._driver.getSupportedPerformanceDataTypes;
@@ -216,7 +211,7 @@ export class AppiumDriver {
                                 args.sessionId = info.value[0].id;
                             }
                             if (!args.sessionId || args.sessionId.includes("undefined")) {
-                            logError("Please provide session id!");
+                                logError("Please provide session id!");
                                 process.exit(1);
                             }
                         }
@@ -243,7 +238,7 @@ export class AppiumDriver {
             }
             if (hasStarted) {
                 console.log("Appium driver has started successfully!");
-            }else{
+            } else {
                 logError("Appium driver is NOT started!")
             }
 
@@ -564,7 +559,7 @@ export class AppiumDriver {
     }
 
     public async logScreenshot(fileName: string) {
-        if (!this._logPath && !fileExists(fileName)) {
+        if (!this._logPath) {
             this._logPath = getReportPath(this._args);
         }
         if (!fileName.endsWith(AppiumDriver.pngFileExt)) {
@@ -575,8 +570,13 @@ export class AppiumDriver {
         return imgPath;
     }
 
+    public async getlog(logType: LogType) {
+        const logs = await this._driver.log(logType);
+        return logs;
+    }
+
     public async logPageSource(fileName: string) {
-        if (!this._logPath && !fileExists(fileName)) {
+        if (!this._logPath) {
             this._logPath = getReportPath(this._args);
         }
         if (!fileName.endsWith(".xml")) {
@@ -588,6 +588,58 @@ export class AppiumDriver {
         writeFileSync(path, xml.value, 'utf8');
     }
 
+    public async logDeviceLog(fileName, logType: LogType, filter: string = undefined) {
+        let logs;
+        try {
+            logs = await this.getlog(logType);
+        } catch (error) {
+            logError(`Failed to get log type: ${logType}`);
+        }
+        let deviceLog = ""
+        logs.forEach(log => {
+            const curruntLog = `\n${JSON.stringify(log)}`;
+            if (filter) {
+                if (curruntLog.includes(filter)) {
+                    deviceLog += `\n${JSON.stringify(log)}`;
+                }
+            } else {
+                deviceLog += `\n${JSON.stringify(log)}`;
+            }
+        });
+
+        if (logs.length > 0 && deviceLog) {
+            const ext = extname(fileName);
+            fileName = fileName.replace(ext, "");
+            fileName = fileName.concat('_').concat(logType);
+            fileName = fileName.concat(".log");
+
+            if (!this._logPath) {
+                this._logPath = getReportPath(this._args);
+            }
+
+            const path = resolve(this._logPath, fileName);
+            writeFileSync(path, deviceLog, 'utf8');
+        } else {
+            console.log(`Log type: ${logType} is empty!`);
+        }
+    }
+
+    /**
+     * This method will snapshot the screen of device, get page source and log from device
+     * @param logName 
+     */
+    public async logTestArtifacts(logName: string) {
+        await this.logScreenshot(logName);
+        await this.logPageSource(logName);
+
+        if (this.isAndroid) {
+            await this.logDeviceLog(logName, LogType.logcat);
+        } else {
+            await this.logDeviceLog(logName, LogType.crashlog);
+            await this.logDeviceLog(logName, LogType.syslog, this._args.device.token);
+        }
+    }
+
     /**
      * Send the currently active app to the background
      * @param time
diff --git a/lib/device-manager.ts b/lib/device-manager.ts
@@ -98,6 +98,10 @@ export class DeviceManager implements IDeviceManager {
             }
         }
 
+        if (device.platform === Platform.ANDROID) {
+            AndroidController.clearLog(device);
+        }
+
         DeviceManager._emulators.set(args.runType, device);
 
         if (!device || !device.token) {
diff --git a/lib/log-types.d.ts b/lib/log-types.d.ts
@@ -1,5 +1,9 @@
 export declare enum LogType {
     logcat = "logcat",
     bugreport = "bugreport",
-    server = "server"
+    server = "server",
+    driver = "driver",
+    syslog = "syslog",
+    crashlog = "crashlog",
+    performance = "performance"
 }
diff --git a/lib/log-types.ts b/lib/log-types.ts
@@ -1,5 +1,9 @@
 export enum LogType {
     logcat = "logcat",
     bugreport = "bugreport",
-    server = "server"
+    server = "server",
+    driver = "driver",
+    syslog = "syslog",
+    crashlog = "crashlog",
+    performance = "performance"
 }
diff --git a/lib/ns-capabilities.ts b/lib/ns-capabilities.ts
@@ -1,7 +1,7 @@
 import * as parser from "./parser"
 import { INsCapabilities, AutomationName } from "./interfaces/ns-capabilities";
 import { resolveCapabilities } from "./capabilities-helper";
-import { getAppPath, fileExists, logErr } from "./utils";
+import { getAppPath, fileExists, logErr, logInfo, logError } from "./utils";
 import { IDevice } from "mobile-devices-controller";
 
 export class NsCapabilities implements INsCapabilities {
@@ -108,7 +108,7 @@ export class NsCapabilities implements INsCapabilities {
 
     private isAndroidPlatform() { return this._appiumCaps.platformName.toLowerCase().includes("android"); }
 
-    private shouldSetFullResetOption(){
+    private shouldSetFullResetOption() {
         if (this._ignoreDeviceController) {
             this.appiumCaps["fullReset"] = true;
             this.appiumCaps["noReset"] = false;
@@ -123,84 +123,83 @@ export class NsCapabilities implements INsCapabilities {
     }
 
     private setAutomationName() {
-    if (this.appiumCaps["automationName"]) {
-        switch (this.appiumCaps["automationName"].toLowerCase()) {
-            case AutomationName.UiAutomator2.toString().toLowerCase():
-                this._automationName = AutomationName.UiAutomator2; break;
-            case AutomationName.Appium.toString().toLowerCase():
-                this._automationName = AutomationName.Appium; break;
-            case AutomationName.XCUITest.toString().toLowerCase():
-                this._automationName = AutomationName.XCUITest; break;
-        }
-    } else {
-        if (this._isAndroid) {
-            if (this.tryGetAndroidApiLevel() > 6 || (this.appiumCaps["apiLevel"] && this.appiumCaps["apiLevel"].toLowerCase().includes("p"))) {
-                this._automationName = AutomationName.UiAutomator2;
+        if (this.appiumCaps["automationName"]) {
+            switch (this.appiumCaps["automationName"].toLowerCase()) {
+                case AutomationName.UiAutomator2.toString().toLowerCase():
+                    this._automationName = AutomationName.UiAutomator2; break;
+                case AutomationName.Appium.toString().toLowerCase():
+                    this._automationName = AutomationName.Appium; break;
+                case AutomationName.XCUITest.toString().toLowerCase():
+                    this._automationName = AutomationName.XCUITest; break;
+            }
+        } else {
+            if (this._isAndroid) {
+                if (this.tryGetAndroidApiLevel() > 6 || (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`);
+        if (this._automationName) {
+            this.appiumCaps["automationName"] = this._automationName.toString();
+            logInfo(`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 {
-        if (this.appiumCaps["platformVersion"]) {
-            const apiLevel = this.appiumCaps["platformVersion"].split(".").splice(0, 2).join('.');
-            return parseFloat(apiLevel);
-        }
-    } catch (error) { }
-    return undefined;
-}
+    tryGetAndroidApiLevel() {
+        try {
+            if (this.appiumCaps["platformVersion"]) {
+                const apiLevel = this.appiumCaps["platformVersion"].split(".").splice(0, 2).join('.');
+                return parseFloat(apiLevel);
+            }
+        } catch (error) { }
+        return undefined;
+    }
 
     private resolveApplication() {
-    if (this.isSauceLab) {
-        this._appiumCaps.app = `sauce-storage:${this.appPath}`
-        this._ignoreDeviceController = true;
-        console.log("Using Sauce Labs. The application path is changed to: " + this.appPath);
-    } else {
-        this.appiumCaps.app = getAppPath(this);
-        this._appPath = this._appiumCaps.app;
-        console.log("Application full path: " + this._appiumCaps.app);
+        if (this.isSauceLab) {
+            this._appiumCaps.app = `sauce-storage:${this.appPath}`
+            this._ignoreDeviceController = true;
+            console.log("Using Sauce Labs. The application path is changed to: " + this.appPath);
+        } else {
+            this.appiumCaps.app = getAppPath(this);
+            this._appPath = this._appiumCaps.app;
+            console.log("Application full path: " + this._appiumCaps.app);
+        }
     }
-}
 
     private checkMandatoryCapabiliies() {
-    if (!this.isSauceLab && !fileExists(this._appiumCaps.app)) {
-        this.exceptions.push("The application folder doesn't exist!");
-    }
+        if (!this.isSauceLab && !fileExists(this._appiumCaps.app)) {
+            this.exceptions.push("The application folder doesn't exist!");
+        }
 
-    if (!this._runType) {
-        this.exceptions.push("Missing runType! Please select one from appium capabilities file!");
-    }
+        if (!this._runType) {
+            this.exceptions.push("Missing runType! Please select one from appium capabilities file!");
+        }
 
-    if (!this._appiumCaps.platformName) {
-        this.exceptions.push("Platform name is missing! Please, check appium capabilities file!");
-    }
+        if (!this._appiumCaps.platformName) {
+            this.exceptions.push("Platform name is missing! Please, check appium capabilities file!");
+        }
 
-    if (!this._appiumCaps.platformVersion) {
-        console.warn("Platform version is missing! You'd better to set it in order to use the correct device");
-    }
+        if (!this._appiumCaps.platformVersion) {
+            console.warn("Platform version is missing! You'd better to set it in order to use the correct device");
+        }
 
-    if (!this._appiumCaps.deviceName && !this._appiumCaps.udid) {
-        this.exceptions.push("The device name or udid are missing! Please, check appium capabilities file!");
+        if (!this._appiumCaps.deviceName && !this._appiumCaps.udid) {
+            this.exceptions.push("The device name or udid are missing! Please, check appium capabilities file!");
+        }
     }
-}
 
     private throwExceptions() {
-    this.exceptions.forEach(msg => {
-        logErr(msg, true);
-    });
+        this.exceptions.forEach(msg => {
+            logError(msg);
+        });
 
-    if (this.exceptions.length > 0) {
-        const messagesString = this.exceptions.length > 1 ? "messages" : "message";
-        throw new Error(`See the ${messagesString} above and fullfill the conditions!!!`);
+        if (this.exceptions.length > 0) {
+           process.exit(1);
+        }
     }
-}
 }
diff --git a/lib/parser.ts b/lib/parser.ts
@@ -1,6 +1,6 @@
 import * as yargs from "yargs";
 import { join, dirname } from "path";
-import { resolve } from "./utils";
+import { resolve, logError } from "./utils";
 
 export const capabilitiesName = "appium.capabilities.json";
 
@@ -45,7 +45,7 @@ const config = (() => {
         options.devMode = true;
         console.log(`Option attachToDebug is set to true. Option --devMode is set true as well !`)
         if (!options.port) {
-            console.error("Provide appium server port started from desktop application!")
+            logError("Provide appium server port started from desktop application!")
             process.exit(1);
         }
     }
@@ -54,7 +54,7 @@ const config = (() => {
         options.attachToDebug = true;
         options.devMode = true;
         if (!options.port) {
-            console.error("Provide appium server port started from desktop application!")
+            logError("Provide appium server port started from desktop application!")
             process.exit(1);
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -98,6 +98,10 @@ export class DeviceManager implements IDeviceManager {`
`98`	`98`	`}`
`99`	`99`	`}`
`100`	`100`
	`101`	`+ if (device.platform === Platform.ANDROID) {`
	`102`	`+ AndroidController.clearLog(device);`
	`103`	`+ }`
	`104`	`+`
`101`	`105`	`DeviceManager._emulators.set(args.runType, device);`
`102`	`106`
`103`	`107`	`if (!device \|\| !device.token) {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`import * as yargs from "yargs";`
`2`	`2`	`import { join, dirname } from "path";`
`3`		`-import { resolve } from "./utils";`
	`3`	`+import { resolve, logError } from "./utils";`
`4`	`4`
`5`	`5`	`export const capabilitiesName = "appium.capabilities.json";`
`6`	`6`
`@@ -45,7 +45,7 @@ const config = (() => {`
`45`	`45`	`options.devMode = true;`
`46`	`46`	console.log(`Option attachToDebug is set to true. Option --devMode is set true as well !`)
`47`	`47`	`if (!options.port) {`
`48`		`- console.error("Provide appium server port started from desktop application!")`
	`48`	`+ logError("Provide appium server port started from desktop application!")`
`49`	`49`	`process.exit(1);`
`50`	`50`	`}`
`51`	`51`	`}`
`@@ -54,7 +54,7 @@ const config = (() => {`
`54`	`54`	`options.attachToDebug = true;`
`55`	`55`	`options.devMode = true;`
`56`	`56`	`if (!options.port) {`
`57`		`- console.error("Provide appium server port started from desktop application!")`
	`57`	`+ logError("Provide appium server port started from desktop application!")`
`58`	`58`	`process.exit(1);`
`59`	`59`	`}`
`60`	`60`	`}`