Report generator added

Author: pkpio

ado-extension.json

@@ -2,7 +2,7 @@
     "manifestVersion": 1,
     "id": "android-app-size-diff",
     "name": "Android app size changes",
-    "version": "0.0.19",
+    "version": "0.0.20",
     "publisher": "PraveenPendyala",
     "targets": [
         {

bumpVersion.ts

@@ -5,7 +5,7 @@ const supportedBumps = ["major", "minor", "patch"]
 
 const nodePackagJsonPath = 'package.json';
 const adoExtensionJsonPath = 'ado-extension.json';
-const adoTaskJsonPath = 'ado-task.json';
+const adoTaskJsonPath = 'src/task.json';
 
 if (process.argv.length != 3) {
     throw "Need exactly one argument!"

package.json

@@ -1,6 +1,6 @@
 {
     "name": "android-app-size-ado",
-    "version": "0.0.19",
+    "version": "0.0.20",
     "description": "Azure DevOps task to measure the size in Android app size by looking at 2 given APKs and AABs",
     "main": "index.js",
     "scripts": {
@@ -50,4 +50,4 @@
         "ts-node": "^8.5.4",
         "typescript": "^3.7.4"
     }
-}
+}

src/adoTask/adoTaskRunner.ts

@@ -1,6 +1,8 @@
 import * as adoTask from 'azure-pipelines-task-lib/task';
 import * as util from 'util';
 import ApkAnalyzer from '../apkAnalyzer/ApkAnalyzer';
+import ComparisionReportGenerator from '../apkAnalyzer/ComparisionReportGenerator';
+import { MarkdownReporter } from '../apkAnalyzer/reporter/MarkdownReporter';
 
 export default class AdoTaskRunner {
 
@@ -10,16 +12,25 @@ export default class AdoTaskRunner {
             const targetAppPath: string | undefined = adoTask.getInput('targetAppPath', true);
             const summaryOutputPath: string | undefined = adoTask.getInput('summaryOutputPath', false);
 
-            if (util.isUndefined(baseAppPath) || util.isUndefined(targetAppPath)) {
-                adoTask.setResult(adoTask.TaskResult.Failed, 'Invalid app paths supplied!');
-                return;
+            if (util.isUndefined(baseAppPath) 
+                || util.isUndefined(targetAppPath) 
+                || util.isUndefined(summaryOutputPath)) {
+                throw 'App paths not supplied!'
             }
 
-            const baseSizeSummary = await new ApkAnalyzer().analyse(baseAppPath);
-            const targetSizeSummary = await new ApkAnalyzer().analyse(targetAppPath);
+            const apkAnalyzer = new ApkAnalyzer();
+            const markdownReportor = new MarkdownReporter();
+            const compareReportGenerator = new ComparisionReportGenerator(
+                apkAnalyzer, markdownReportor);
 
-            console.log(baseSizeSummary);
-            console.log(targetSizeSummary);
+            console.log(await compareReportGenerator.generateComparisionReport(
+                baseAppPath,
+                targetAppPath,
+                summaryOutputPath,
+                'Base APK',
+                'Target APK',
+                ['apkSize', 'installSize', 'dexFiles', 'arscFile']
+            ));
         }
         catch (err) {
             adoTask.setResult(adoTask.TaskResult.Failed, err.message);

src/apkAnalyzer/ApkAnalyzer.ts

@@ -2,12 +2,12 @@ import AdmZip from 'adm-zip';
 import * as path from 'path'
 import * as util from 'util';
 import MetaMfParser from './MetaMfParser';
-import ApkSizeSummary from './ApkSizeSummary';
+import ApkSizeSummary from './model/ApkSizeSummary';
 import { FilesSizeCalculator } from './FilesSizeCalculator';
 
 export default class ApkAnalyzer {
 
-    public async analyse(apkPath: string, workingDir?: string) : Promise<ApkSizeSummary> {
+    public async analyse(apkPath: string, apkLabel: string, workingDir?: string) : Promise<ApkSizeSummary> {
         if (util.isUndefined(workingDir)) {
             workingDir = path.join(path.dirname(apkPath), 'extracted');
         }
@@ -25,11 +25,12 @@ export default class ApkAnalyzer {
         const fileSizeCalc = new FilesSizeCalculator();
         const sizeSummary = new ApkSizeSummary();
 
-        sizeSummary.apkFile = fileSizeCalc.getFileSize(apkPath);
-        sizeSummary.arscFile = fileSizeCalc.getFilesSize(mfParser.getFiles('.arsc'));
-        sizeSummary.dexFiles = fileSizeCalc.getFilesSize(mfParser.getFiles('.dex'));
-        sizeSummary.nativeLibs = fileSizeCalc.getFilesSize(mfParser.getFiles('.so'));
-        sizeSummary.installSize = sizeSummary.apkFile + sizeSummary.dexFiles;
+        sizeSummary.apkLabel = apkLabel;
+        sizeSummary.sizeMetrics['apkSize'] = fileSizeCalc.getFileSize(apkPath);
+        sizeSummary.sizeMetrics['arscFile'] = fileSizeCalc.getFilesSize(mfParser.getFiles('.arsc'));
+        sizeSummary.sizeMetrics['dexFiles'] = fileSizeCalc.getFilesSize(mfParser.getFiles('.dex'));
+        sizeSummary.sizeMetrics['nativeLibs'] = fileSizeCalc.getFilesSize(mfParser.getFiles('.so'));
+        sizeSummary.sizeMetrics['installSize'] = sizeSummary.sizeMetrics['apkSize'] + sizeSummary.sizeMetrics['dexFiles'];
 
         return sizeSummary;
     }

src/apkAnalyzer/ApkSizeSummary.ts

@@ -0,0 +1,50 @@
+import ApkAnalyzer from "./ApkAnalyzer";
+import ComparisionReport from "./model/ComparisionReport";
+import IReportor from './reporter/IReporter';
+
+/**
+ * Generates a report comparsing two different APks
+ */
+
+ export default class ComparisionReportGenerator {
+   apkAnalyser: ApkAnalyzer;
+   reporter: IReportor;
+
+    public constructor(apkAnalyser : ApkAnalyzer, reporter: IReportor) {
+      this.apkAnalyser = apkAnalyser;
+      this.reporter = reporter;
+    }
+
+    public async generateComparisionReport(
+       baseApkPath: string, 
+       targetApkPath: string,
+       reportOutputPath: string,
+       baseApkLabel: string = 'Base APK',
+       targetApkLabel: string = 'Target APK',
+       includeMetrics: Array<string> = ['apkSize', 'installSize', 'dexFiles']) : Promise<ComparisionReport> {
+         const baseSummary = await this.apkAnalyser.analyse(baseApkPath, baseApkLabel);
+         const targetSummary = await this.apkAnalyser.analyse(targetApkPath, targetApkLabel);
+
+         const comparisionReport = new ComparisionReport();
+         comparisionReport.baseApkLabel = baseSummary.apkLabel;
+         comparisionReport.targetApkLabel = targetSummary.apkLabel;
+
+         includeMetrics.forEach(metric => {
+            const baseMetric = baseSummary.sizeMetrics[metric];
+            const targetMetric = baseSummary.sizeMetrics[metric];
+            const difference = targetMetric - baseMetric;
+
+            comparisionReport.comparisionMetrics.push({
+               metricName: metric,
+               baseValue: baseMetric,
+               targetValue: targetMetric,
+               difference: difference
+            });
+         });
+
+         this.reporter.writeReport(comparisionReport, reportOutputPath);
+
+         return comparisionReport;
+    }
+    
+ }

src/apkAnalyzer/ComparisionReportGenerator.ts

@@ -0,0 +1,4 @@
+export default class ApkSizeSummary {
+    apkLabel: string = '';
+    sizeMetrics: {[key: string]: number} = {};
+}

src/apkAnalyzer/model/ApkSizeSummary.ts

@@ -0,0 +1,12 @@
+export interface ComparisionMetric {
+    metricName: string;
+    baseValue: number;
+    targetValue: number;
+    difference: number;
+}
+
+export default class ComparisionReport {
+    baseApkLabel: string = '';
+    targetApkLabel: string = '';
+    comparisionMetrics: Array<ComparisionMetric> = [];
+}

src/apkAnalyzer/model/ComparisionReport.ts

@@ -0,0 +1,6 @@
+import ComparisionReport from '../model/ComparisionReport'
+
+export default interface IReporter {
+
+    writeReport(comparisionReport: ComparisionReport, outputPath: string) : Promise<any>;
+}