Implement app profiling functionality for android tests (#31)

Author: sudharsan-selvaraj

migrations/001_create_table.js

@@ -51,11 +51,13 @@ var createSessionTable = function (queryInterface, Sequelize) {
     browser_name: { type: Sequelize.TEXT, allowNull: true },
     udid: { type: Sequelize.TEXT, allowNull: false },
     capabilities: { type: Sequelize.TEXT, allowNull: false },
+    device_info: { type: Sequelize.TEXT, allowNull: true },
     is_completed: { type: Sequelize.BOOLEAN, defaultValue: false },
     start_time: { type: Sequelize.DATE, allowNull: false },
     end_time: { type: Sequelize.DATE, defaultValue: null },
     is_test_passed: { type: Sequelize.BOOLEAN, allowNull: true },
     is_paused: { type: Sequelize.BOOLEAN, allowNull: true, default: false },
+    is_profiling_available: { type: Sequelize.BOOLEAN, allowNull: true, default: false },
     session_status: {
       type: Sequelize.ENUM,
       values: ["PASSED", "FAILED", "TIMEOUT", "RUNNING"],
@@ -99,17 +101,40 @@ var createCommandLogsTable = function (queryInterface, Sequelize) {
   });
 };
 
+var createAppProfileTable = function (queryInterface, Sequelize) {
+  return queryInterface.createTable("profiling", {
+    session_id: { type: Sequelize.TEXT, references: { model: "session", key: "session_id" }, onDelete: "CASCADE" },
+    id: { type: Sequelize.INTEGER, primaryKey: true, autoIncrement: true },
+    timestamp: Sequelize.DATE,
+    cpu: { type: Sequelize.TEXT, allowNull: false, defaultValue: "0" },
+    memory: { type: Sequelize.TEXT, allowNull: false, defaultValue: "0" },
+    total_cpu_used: { type: Sequelize.TEXT, allowNull: false, defaultValue: "0" },
+    total_memory_used: { type: Sequelize.TEXT, allowNull: false, defaultValue: "0" },
+    raw_cpu_log: { type: Sequelize.TEXT },
+    raw_memory_log: { type: Sequelize.TEXT },
+    created_at: Sequelize.DATE,
+    updated_at: Sequelize.DATE,
+  });
+};
+
 module.exports = {
   up: (queryInterface, Sequelize) => {
     return promise.each(
-      [createProjetsTable, createBuildsTable, createSessionTable, createLogsTable, createCommandLogsTable],
+      [
+        createProjetsTable,
+        createBuildsTable,
+        createSessionTable,
+        createLogsTable,
+        createCommandLogsTable,
+        createAppProfileTable,
+      ],
       function (table) {
         return table(queryInterface, Sequelize);
       }
     );
   },
   down: (queryInterface, Sequelize) => {
-    return promise.each(["logs", "command_logs", "projects", "build", "session"], function (table) {
+    return promise.each(["profiling", "logs", "command_logs", "projects", "build", "session"], function (table) {
       return queryInterface.dropTable(table);
     });
   },

package-lock.json

@@ -32,6 +32,7 @@
     "@ffmpeg-installer/ffmpeg": "^1.1.0",
     "@mui/icons-material": "^5.0.4",
     "@mui/material": "^5.0.4",
+    "appium-adb": "^9.0.0",
     "appium-base-driver": "^7.10.1",
     "async-lock": "^1.3.0",
     "async-wait-until": "^2.0.12",
@@ -55,12 +56,14 @@
   },
   "devDependencies": {
     "@types/async-lock": "^1.1.3",
+    "@types/bluebird": "^3.5.36",
     "@types/express": "^4.17.13",
     "@types/lodash": "^4.14.178",
     "@types/lokijs": "^1.5.7",
     "@types/node": "^16.10.2",
-    "@types/uuid": "^8.3.1",
     "@types/node-fetch": "^3.0.3",
+    "@types/teen_process": "^1.16.0",
+    "@types/uuid": "^8.3.1",
     "typescript": "^4.4.4"
   }
 }

package.json

@@ -3,7 +3,7 @@ import { Session } from "../../models/session";
 import { Op, Sequelize } from "sequelize";
 import { BaseController } from "../commons/base-controller";
 import fs from "fs";
-import { CommandLogs, Logs } from "../../models";
+import { CommandLogs, Logs, Profiling } from "../../models";
 import * as path from "path";
 
 export class SessionController extends BaseController {
@@ -16,6 +16,7 @@ export class SessionController extends BaseController {
     router.get("/:sessionId/logs/text", this.getTextLogs.bind(this));
     router.get("/:sessionId/logs/device", this.getDeviceLogs.bind(this));
     router.get("/:sessionId/logs/debug", this.getDebugLogs.bind(this));
+    router.get("/:sessionId/profiling_data", this.getProfilingData.bind(this));
   }
 
   public async getSessions(request: Request, response: Response, next: NextFunction) {
@@ -160,4 +161,24 @@ export class SessionController extends BaseController {
     }
     this.sendFailureResponse(response, "Screen shot not available");
   }
+
+  public async getProfilingData(request: Request, response: Response, next: NextFunction) {
+    let sessionId: string = request.params.sessionId;
+    let logs = await Profiling.findAll({
+      attributes: [
+        "timestamp",
+        "cpu",
+        "memory",
+        "total_cpu_used",
+        "total_memory_used",
+        "raw_cpu_log",
+        "raw_memory_log",
+      ],
+      where: {
+        session_id: sessionId,
+      },
+      order: [["timestamp", "ASC"]],
+    });
+    this.sendSuccessResponse(response, logs);
+  }
 }

src/app/controllers/session-controller.ts

@@ -6,6 +6,7 @@ import { config } from "./config";
 import * as fs from "fs";
 import { pluginLogger } from "./loggers/plugin-logger";
 import { EventEmitter } from "events";
+import ADB from "appium-adb";
 
 const ffmpeg = require("@ffmpeg-installer/ffmpeg").path;
 const DebugEventNotifier = new EventEmitter();
@@ -22,6 +23,14 @@ Container.set("expressRouter", getRouter({ config, dependencies: { debugEventEmi
 Container.set("config", config);
 
 (async () => {
+  //Create ADB instance
+  try {
+    Container.set("adb", await ADB.createADB({}));
+  } catch (ignore) {
+    pluginLogger.error("Unable to create adb instance");
+    pluginLogger.error(ignore);
+  }
+
   //Add FFMPEG to path
   process.env.PATH = process.env.PATH + ":" + ffmpeg.replace(/ffmpeg$/g, "");
 

src/index.ts

@@ -3,3 +3,4 @@ export { Logs } from "./logs";
 export { CommandLogs } from "./command-logs";
 export { Build } from "./build";
 export { Project } from "./project";
+export { Profiling } from "./profiling";