Merge pull request #4 from microsoft/githubAction

Added Github action

Author: pkpio

.github/workflows/gh-action-test.yml

@@ -0,0 +1,25 @@
+name: Github Action Test
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+
+    steps:
+    - uses: actions/checkout@v1
+      name: Checkout repo
+      
+    - name: Run App size diff
+      uses: ./
+      with:
+        baseAppPath: 'test/assets/test.apk'
+        targetAppPath: 'test/assets/test.apk'
+        summaryOutputPath: summary.md
+
+    - name: Print summary
+      run: cat summary.md

action.yml

@@ -0,0 +1,18 @@
+name: 'Android App size difference'
+description: 'Compares the size of 2 APKs'
+inputs:
+  baseAppPath:
+    description: 'Path to base apk. This is the app before changes'
+    required: true
+    default: ''
+  targetAppPath:
+    description: 'Path to target apk. This is the app after changes'
+    required: true
+    default: ''
+  summaryOutputPath:
+    description: 'Output file where comparision summary should be written to'
+    required: true
+    default: ''
+runs:
+  using: 'node12'
+  main: 'dist_gh_action/index.js'

ado-extension.json

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

dist_gh_action/index.js

@@ -0,0 +1,36 @@
+{
+  "messages": {
+    "LIB_UnhandledEx": "Unhandled: %s",
+    "LIB_FailOnCode": "Failure return code: %d",
+    "LIB_MkdirFailed": "Unable to create directory '%s'. %s",
+    "LIB_MkdirFailedFileExists": "Unable to create directory '%s'. Conflicting file exists: '%s'",
+    "LIB_MkdirFailedInvalidDriveRoot": "Unable to create directory '%s'. Root directory does not exist: '%s'",
+    "LIB_MkdirFailedInvalidShare": "Unable to create directory '%s'. Unable to verify the directory exists: '%s'. If directory is a file share, please verify the share name is correct, the share is online, and the current process has permission to access the share.",
+    "LIB_MultilineSecret": "Secrets cannot contain multiple lines",
+    "LIB_ProcessError": "There was an error when attempting to execute the process '%s'. This may indicate the process failed to start. Error: %s",
+    "LIB_ProcessExitCode": "The process '%s' failed with exit code %s",
+    "LIB_ProcessStderr": "The process '%s' failed because one or more lines were written to the STDERR stream",
+    "LIB_ReturnCode": "Return code: %d",
+    "LIB_ResourceFileNotExist": "Resource file doesn\\'t exist: %s",
+    "LIB_ResourceFileAlreadySet": "Resource file has already set to: %s",
+    "LIB_ResourceFileNotSet": "Resource file haven\\'t set, can\\'t find loc string for key: %s",
+    "LIB_StdioNotClosed": "The STDIO streams did not close within %s seconds of the exit event from process '%s'. This may indicate a child process inherited the STDIO streams and has not yet exited.",
+    "LIB_WhichNotFound_Linux": "Unable to locate executable file: '%s'. Please verify either the file path exists or the file can be found within a directory specified by the PATH environment variable. Also check the file mode to verify the file is executable.",
+    "LIB_WhichNotFound_Win": "Unable to locate executable file: '%s'. Please verify either the file path exists or the file can be found within a directory specified by the PATH environment variable. Also verify the file has a valid extension for an executable file.",
+    "LIB_LocStringNotFound": "Can\\'t find loc string for key: %s",
+    "LIB_ParameterIsRequired": "%s not supplied",
+    "LIB_InputRequired": "Input required: %s",
+    "LIB_InvalidPattern": "Invalid pattern: '%s'",
+    "LIB_EndpointNotExist": "Endpoint not present: %s",
+    "LIB_EndpointDataNotExist": "Endpoint data parameter %s not present: %s",
+    "LIB_EndpointAuthNotExist": "Endpoint auth data not present: %s",
+    "LIB_InvalidEndpointAuth": "Invalid endpoint auth: %s",
+    "LIB_InvalidSecureFilesInput": "Invalid secure file input: %s",
+    "LIB_PathNotFound": "Not found %s: %s",
+    "LIB_PathHasNullByte": "Path cannot contain null bytes",
+    "LIB_OperationFailed": "Failed %s: %s",
+    "LIB_UseFirstGlobMatch": "Multiple workspace matches. using first.",
+    "LIB_MergeTestResultNotSupported": "Merging test results from multiple files to one test run is not supported on this version of build agent for OSX/Linux, each test result file will be published as a separate test run in VSO/TFS.",
+    "LIB_PlatformNotSupported": "Platform not supported: %s"
+  } 
+}

dist_gh_action/lib.json

@@ -1,6 +1,6 @@
 {
     "name": "android-app-size-ado",
-    "version": "0.0.22",
+    "version": "0.0.24",
     "description": "Azure DevOps task to measure the size in Android app size by looking at 2 given APKs and AABs",
     "main": "index.js",
     "scripts": {
@@ -9,7 +9,8 @@
         "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": "npm run build && npm run bundle-ado-task && npm run bundle-gh-action",
+        "bundle-gh-action": "ncc build src/gh-action-index.ts -m -o dist_gh_action",
         "bundle-ado-task": "tfx extension create --manifest-globs ado-extension.json",
         "bump-major": "ts-node bumpVersion.ts major",
         "bump-minor": "ts-node bumpVersion.ts minor",
@@ -32,6 +33,7 @@
     },
     "homepage": "https://github.com/microsoft/android-app-size-ci#readme",
     "dependencies": {
+        "@actions/core": "^1.2.0",
         "@types/adm-zip": "^0.4.32",
         "@types/line-reader": "0.0.28",
         "adm-zip": "^0.4.13",

package-lock.json

@@ -1,36 +1,12 @@
 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';
+import CiRunner from '../apkAnalyzer/CiRunner';
 
 export default class AdoTaskRunner {
 
     public async run() {
         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);
-
-            if (util.isUndefined(baseAppPath) 
-                || util.isUndefined(targetAppPath) 
-                || util.isUndefined(summaryOutputPath)) {
-                throw 'App paths not supplied!'
-            }
-
-            const apkAnalyzer = new ApkAnalyzer();
-            const markdownReportor = new MarkdownReporter();
-            const compareReportGenerator = new ComparisionReportGenerator(
-                apkAnalyzer, markdownReportor);
-
-            console.log(await compareReportGenerator.generateComparisionReport(
-                baseAppPath,
-                targetAppPath,
-                summaryOutputPath,
-                'Base APK',
-                'Target APK',
-                ['apkSize', 'installSize', 'dexFiles', 'arscFile']
-            ));
+            const ciRunner = new CiRunner(adoTask);
+            await ciRunner.run();
         }
         catch (err) {
             adoTask.setResult(adoTask.TaskResult.Failed, err.message);

package.json

@@ -0,0 +1,47 @@
+import * as util from 'util';
+import ApkAnalyzer from '../apkAnalyzer/ApkAnalyzer';
+import ComparisionReportGenerator from '../apkAnalyzer/ComparisionReportGenerator';
+import { MarkdownReporter } from '../apkAnalyzer/reporter/MarkdownReporter';
+
+export interface CiCore {
+    getInput(name: string): string | undefined;
+}
+
+/**
+ * Runs Apk comparision on a CI - Github workflow or ADO Task
+ */
+export default class CiRunner {
+    ciCore: CiCore; // either Github action core or ADO Task
+
+    constructor(ciCore: CiCore) {
+        this.ciCore = ciCore;
+    }
+
+    public async run() {
+        const baseAppPath = this.ciCore.getInput('baseAppPath');
+        const targetAppPath = this.ciCore.getInput('targetAppPath');
+        const summaryOutputPath = this.ciCore.getInput('summaryOutputPath');
+
+        if (util.isUndefined(baseAppPath) 
+            || util.isUndefined(targetAppPath) 
+            || util.isUndefined(summaryOutputPath)) {
+            throw 'App paths not supplied!'
+        }
+
+        const apkAnalyzer = new ApkAnalyzer();
+        const markdownReportor = new MarkdownReporter();
+        const compareReportGenerator = new ComparisionReportGenerator(
+            apkAnalyzer, markdownReportor);
+
+        return console.log(await compareReportGenerator.generateComparisionReport(
+            baseAppPath,
+            targetAppPath,
+            summaryOutputPath,
+            'Base APK',
+            'Target APK',
+            ['apkSize', 'installSize', 'dexFiles', 'arscFile']
+        ));
+    }
+    
+
+}

src/adoTask/adoTaskRunner.ts

@@ -2,13 +2,6 @@ import LineReader from 'line-reader';
 import * as path from 'path';
 import * as util from 'util';
 
-/**
- * Map from extension to all files with that extension
- */
-interface ExtensionFiles {
-    [key: string]: Array<string>;
-}
-
 /**
  * Parses the contents of the Android MetaMf file and sorts the list of files based on extension 
  */
@@ -53,11 +46,14 @@ interface ExtensionFiles {
 
         const filePath = path.join(this.mBasePath, line.split('Name: ', 2)[1]);
         const extension = path.extname(filePath);
-
+        
         if (!this.mFilesExtensionMap.has(extension)) {
             this.mFilesExtensionMap.set(extension, []);
         }
 
-        this.mFilesExtensionMap.get(extension)?.push(filePath);
+        const filesForExt = this.mFilesExtensionMap.get(extension);
+        if (!util.isUndefined(filesForExt)) {
+            filesForExt.push(filePath);
+        }
     }
  }