Merge pull request #3 from microsoft/apkSizeAnalyzer

Added APK size analyzer

Author: pkpio

.gitignore

@@ -3,3 +3,7 @@ dist
 *.vsix
 .taskkey
 **/.taskkey
+.DS_Store
+**/.DS_Store
+test/assets/extracted/
+

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.22",
     "publisher": "PraveenPendyala",
     "targets": [
         {
@@ -18,7 +18,7 @@
     },
     "files": [
         {
-            "path": "dist/src/"
+            "path": "dist/src"
         }
     ],
     "contributions": [
@@ -29,7 +29,7 @@
                 "ms.vss-distributed-task.tasks"
             ],
             "properties": {
-                "name": "dist/src/"
+                "name": "dist/src"
             }
         }
     ]

ado-task-test.yml

@@ -0,0 +1,16 @@
+trigger:
+- master
+
+pool:
+  vmImage: 'ubuntu-latest'
+
+steps:
+- task: android-app-size-diff-task@0
+  inputs:
+    baseAppPath: test/assets/test.apk
+    targetAppPath: test/assets/test.apk
+    summaryOutputPath: summary.md
+  displayName: 'Run APK size comparision'
+
+- script: cat summary.md
+  displayName: 'Print generated summary'

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!"

downloadAndroidSdk.ts

@@ -1,21 +1,16 @@
 {
     "name": "android-app-size-ado",
-    "version": "0.0.19",
+    "version": "0.0.22",
     "description": "Azure DevOps task to measure the size in Android app size by looking at 2 given APKs and AABs",
     "main": "index.js",
     "scripts": {
-        "postinstall": "npm run download-sdk-all",
         "build": "npm run build-ts && npm run copy-files",
         "adoTask": "npm run build && node dist/src/ado-index.js",
         "build-ts": "tsc",
         "copy-files": "ts-node copyFiles.ts",
         "test": "npm run build && mocha dist/test/**/*.js",
         "bundle": "npm run build && npm run bundle-ado-task",
         "bundle-ado-task": "tfx extension create --manifest-globs ado-extension.json",
-        "download-sdk-windows": "ts-node downloadAndroidSdk.ts Windows_NT",
-        "download-sdk-linux": "ts-node downloadAndroidSdk.ts Linux",
-        "download-sdk-mac": "ts-node downloadAndroidSdk.ts Darwin",
-        "download-sdk-all": "npm run download-sdk-windows && npm run download-sdk-linux && npm run download-sdk-mac",
         "bump-major": "ts-node bumpVersion.ts major",
         "bump-minor": "ts-node bumpVersion.ts minor",
         "bump-patch": "ts-node bumpVersion.ts patch"
@@ -37,7 +32,11 @@
     },
     "homepage": "https://github.com/microsoft/android-app-size-ci#readme",
     "dependencies": {
-        "azure-pipelines-task-lib": "^2.9.3"
+        "@types/adm-zip": "^0.4.32",
+        "@types/line-reader": "0.0.28",
+        "adm-zip": "^0.4.13",
+        "azure-pipelines-task-lib": "^2.9.3",
+        "line-reader": "^0.4.0"
     },
     "devDependencies": {
         "@types/download": "^6.2.4",
@@ -51,4 +50,4 @@
         "ts-node": "^8.5.4",
         "typescript": "^3.7.4"
     }
-}
+}

package-lock.json

@@ -1,28 +1,39 @@
-import * as tl from 'azure-pipelines-task-lib/task';
-import * as shell from "shelljs";
-import * as os from 'os';
-import * as path from 'path';
+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 {
 
     public async run() {
-        const platform = os.type();
+        try {
+            const baseAppPath: string | undefined = adoTask.getInput('baseAppPath', true);
+            const targetAppPath: string | undefined = adoTask.getInput('targetAppPath', true);
+            const summaryOutputPath: string | undefined = adoTask.getInput('summaryOutputPath', false);
 
-        const apkanalyzerPath = path.join('dist', 'src', 'bin', platform, 'tools', 'bin', 'apkanalyzer');
-        const testApkPath = path.join('test', 'assets', 'test.apk');
+            if (util.isUndefined(baseAppPath) 
+                || util.isUndefined(targetAppPath) 
+                || util.isUndefined(summaryOutputPath)) {
+                throw 'App paths not supplied!'
+            }
 
-        shell.exec(apkanalyzerPath + ' apk download-size ' + testApkPath);
+            const apkAnalyzer = new ApkAnalyzer();
+            const markdownReportor = new MarkdownReporter();
+            const compareReportGenerator = new ComparisionReportGenerator(
+                apkAnalyzer, markdownReportor);
 
-        try {
-            const inputString: string | undefined = tl.getInput('baseAppPath', true);
-            if (inputString == 'bad') {
-                tl.setResult(tl.TaskResult.Failed, 'Bad input was given');
-                return;
-            }
-            console.log('Hello', inputString);
+            console.log(await compareReportGenerator.generateComparisionReport(
+                baseAppPath,
+                targetAppPath,
+                summaryOutputPath,
+                'Base APK',
+                'Target APK',
+                ['apkSize', 'installSize', 'dexFiles', 'arscFile']
+            ));
         }
         catch (err) {
-            tl.setResult(tl.TaskResult.Failed, err.message);
+            adoTask.setResult(adoTask.TaskResult.Failed, err.message);
         }
     }
 

package.json

@@ -0,0 +1,38 @@
+import AdmZip from 'adm-zip';
+import * as path from 'path'
+import * as util from 'util';
+import MetaMfParser from './MetaMfParser';
+import ApkSizeSummary from './model/ApkSizeSummary';
+import { FilesSizeCalculator } from './FilesSizeCalculator';
+
+export default class ApkAnalyzer {
+
+    public async analyse(apkPath: string, apkLabel: string, workingDir?: string) : Promise<ApkSizeSummary> {
+        if (util.isUndefined(workingDir)) {
+            workingDir = path.join(path.dirname(apkPath), 'extracted');
+        }
+
+        // Extract the apk file
+        const apkFile = new AdmZip(apkPath);
+        console.log('Extracting APK file to ' + workingDir);
+        apkFile.extractAllTo(workingDir, true);
+
+        // Parse the IMF file
+        const mfParser = new MetaMfParser(workingDir);
+        await mfParser.parse();
+
+        // Build Apk size summary
+        const fileSizeCalc = new FilesSizeCalculator();
+        const sizeSummary = new ApkSizeSummary();
+
+        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/adoTask/adoTaskRunner.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;
+    }
+    
+ }