Merge branch 'master' into release/v2

* master:
  Prepare for release 2.5.0.
  Add support for API 15-19 system images.
  Use new cmdline-tools with support for running sdkmanager and avdmanager with Java 8+.
  Update test-fixture dependencies. Drop minSdkVersion to 15.
  Update to AGP 3.6.0 and Gradle 6.2.1 for test-fixture project.

.github/workflows/workflow.yml

@@ -13,12 +13,13 @@ jobs:
     timeout-minutes: 10
     strategy:
       matrix:
-        api-level: [21, 23, 29]
+        api-level: [16, 21, 23, 29]
     steps:
     - name: checkout
-      uses: actions/checkout@v1
-      with:
-        fetch-depth: 1
+      uses: actions/checkout@v2
+
+    - name: validate gradle wrapper
+      uses: gradle/wrapper-validation-action@v1
 
     - name: build, test and lint
       run: |
@@ -27,18 +28,23 @@ jobs:
         npm run lint
         npm test
 
-    - name: Prepare test fixture
-      run: cp -a ./test-fixture/* ./
+    - name: Java 13
+      uses: actions/setup-java@v1
+      with:
+        java-version: 13
 
     - name: run action
       uses: ./
       with:
         api-level: ${{ matrix.api-level }}
-        target: google_apis
+        target: default
         arch: x86
         profile: Nexus 6
         emulator-options: -no-window -gpu swiftshader_indirect -no-snapshot -noaudio -no-boot-anim -camera-back none
         disable-animations: true
+        working-directory: ./test-fixture/
         script: |
+          echo $GITHUB_REPOSITORY
+          adb devices
           ./gradlew help
           ./gradlew connectedDebugAndroidTest

CHANGELOG.md

@@ -1,5 +1,26 @@
 # Change Log
 
+## v2.5.0
+
+* Added support for API 15-19 system images.
+* Switched to the new SDK command-line tools which supports running `sdkmanager` and `avdmanager` with Java 9+.
+
+## v2.4.0
+
+* Added support for setting custom `working-directory` - e.g. `./android` if your root Gradle project is under the `./android` sub-directory within your repository.
+
+## v2.3.2
+
+* Fixed an issue where environment variables are escaped in script.
+
+## v2.3.1
+
+* Bumped Android Build tools to 29.0.3.
+
+## v2.3.0
+
+* Added support for running the action with Java 9+ by forcing SDK manager and AVD manager to use Java 8.
+
 ## v2.2.0
 
 * Fixed an issue where emulator is killed prematurely.

README.md

@@ -32,9 +32,7 @@ jobs:
     runs-on: macOS-latest
     steps:
     - name: checkout
-      uses: actions/checkout@v1
-      with:
-        fetch-depth: 1
+      uses: actions/checkout@v2
 
     - name: run tests
       uses: reactivecircus/android-emulator-runner@v2
@@ -55,9 +53,7 @@ jobs:
         target: [default, google_apis]
     steps:
     - name: checkout
-      uses: actions/checkout@v1
-      with:
-        fetch-depth: 1
+      uses: actions/checkout@v2
 
     - name: run tests
       uses: reactivecircus/android-emulator-runner@v2
@@ -73,13 +69,14 @@ jobs:
 
 |  | **Required** | **Default** | **Description** |
 |----------------------|--------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `api-level` | Required | N/A | API level of the platform system image - e.g. 23 for Android Marshmallow, 29 for Android 10. **Minimum API level supported is 21**. |
+| `api-level` | Required | N/A | API level of the platform system image - e.g. 23 for Android Marshmallow, 29 for Android 10. **Minimum API level supported is 15**. |
 | `target` | Optional | `default` | Target of the system image - `default` or `google_apis`. |
-| `arch` | Optional | `x86` | CPU architecture of the system image - `x86` or `x86_64`. |
+| `arch` | Optional | `x86` | CPU architecture of the system image - `x86` or `x86_64`. Note that `x86_64` image is only available for API 21+. |
 | `profile` | Optional | N/A | Hardware profile used for creating the AVD - e.g. `Nexus 6`. For a list of all profiles available, run `$ANDROID_HOME/tools/bin/avdmanager list` and refer to the results under "Available Android Virtual Devices". |
 | `emulator-options` | Optional | See below | Command-line options used when launching the emulator (replacing all default options) - e.g. `-no-window -no-snapshot -camera-back emulated`. |
 | `disable-animations` | Optional | `true` | Whether to disable animations - `true` or `false`. |
 | `emulator-build` | Optional | N/A | Build number of a specific version of the emulator binary to use e.g. `6061023` for emulator v29.3.0.0. |
+| `working-directory` | Optional | `./` | A custom working directory - e.g. `./android` if your root Gradle project is under the `./android` sub-directory within your repository. |
 | `script` | Required | N/A | Custom script to run - e.g. to run Android instrumented tests on the emulator: `./gradlew connectedCheck` |
 
 Default `emulator-options`: `-no-window -gpu swiftshader_indirect -no-snapshot -noaudio -no-boot-anim`.

__tests__/input-validator.test.ts

@@ -17,14 +17,14 @@ describe('api-level validator tests', () => {
 
   it('Throws if api-level is lower than min API supported', () => {
     const func = () => {
-      validator.checkApiLevel('20');
+      validator.checkApiLevel('14');
     };
     expect(func).toThrowError(`Minimum API level supported is ${validator.MIN_API_LEVEL}.`);
   });
 
   it('Validates successfully with valid api-level', () => {
     const func1 = () => {
-      validator.checkApiLevel('21');
+      validator.checkApiLevel('15');
     };
     expect(func1).not.toThrow();
 

lib/emulator-manager.js

@@ -17,8 +17,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const exec = __importStar(require("@actions/exec"));
 const EMULATOR_BOOT_TIMEOUT_SECONDS = 300;
-const AVD_MANAGER_PATH = `${process.env.ANDROID_HOME}/tools/bin/avdmanager`;
-const ADB_PATH = `${process.env.ANDROID_HOME}/platform-tools/adb`;
 /**
  * Creates and launches a new AVD instance with the specified configurations.
  */
@@ -27,11 +25,11 @@ function launchEmulator(apiLevel, target, arch, profile, emulatorOptions, disabl
         // create a new AVD
         if (profile.trim() !== '') {
             console.log(`Creating AVD with custom profile ${profile}`);
-            yield exec.exec(`${AVD_MANAGER_PATH} create avd --force -n test --abi "${target}/${arch}" --package "system-images;android-${apiLevel};${target};${arch}" --device "${profile}"`);
+            yield exec.exec(`avdmanager create avd --force -n test --abi "${target}/${arch}" --package "system-images;android-${apiLevel};${target};${arch}" --device "${profile}"`);
         }
         else {
             console.log(`Creating AVD without custom profile.`);
-            yield exec.exec(`sh -c \\"echo no | ${AVD_MANAGER_PATH} create avd --force -n test --abi '${target}/${arch}' --package 'system-images;android-${apiLevel};${target};${arch}'"`);
+            yield exec.exec(`sh -c \\"echo no | avdmanager create avd --force -n test --abi '${target}/${arch}' --package 'system-images;android-${apiLevel};${target};${arch}'"`);
         }
         // start emulator
         console.log('Starting emulator.');
@@ -46,13 +44,13 @@ function launchEmulator(apiLevel, target, arch, profile, emulatorOptions, disabl
         });
         // wait for emulator to complete booting
         yield waitForDevice();
-        yield exec.exec(`${ADB_PATH} shell input keyevent 82`);
+        yield exec.exec(`adb shell input keyevent 82`);
         // disable animations
         if (disableAnimations) {
             console.log('Disabling animations.');
-            yield exec.exec(`${ADB_PATH} shell settings put global window_animation_scale 0.0`);
-            yield exec.exec(`${ADB_PATH} shell settings put global transition_animation_scale 0.0`);
-            yield exec.exec(`${ADB_PATH} shell settings put global animator_duration_scale 0.0`);
+            yield exec.exec(`adb shell settings put global window_animation_scale 0.0`);
+            yield exec.exec(`adb shell settings put global transition_animation_scale 0.0`);
+            yield exec.exec(`adb shell settings put global animator_duration_scale 0.0`);
         }
     });
 }
@@ -63,7 +61,7 @@ exports.launchEmulator = launchEmulator;
 function killEmulator() {
     return __awaiter(this, void 0, void 0, function* () {
         try {
-            yield exec.exec(`${ADB_PATH} -s emulator-5554 emu kill`);
+            yield exec.exec(`adb -s emulator-5554 emu kill`);
         }
         catch (error) {
             console.log(error.message);
@@ -83,7 +81,7 @@ function waitForDevice() {
         while (!booted) {
             try {
                 let result = '';
-                yield exec.exec(`${ADB_PATH} shell getprop sys.boot_completed`, [], {
+                yield exec.exec(`adb shell getprop sys.boot_completed`, [], {
                     listeners: {
                         stdout: (data) => {
                             result += data.toString();

lib/input-validator.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MIN_API_LEVEL = 21;
+exports.MIN_API_LEVEL = 15;
 exports.VALID_TARGETS = ['default', 'google_apis'];
 exports.VALID_ARCHS = ['x86', 'x86_64'];
 function checkApiLevel(apiLevel) {

lib/main.js

@@ -59,6 +59,12 @@ function run() {
                 console.log(`using emulator build: ${emulatorBuildInput}`);
             }
             const emulatorBuild = !emulatorBuildInput ? undefined : emulatorBuildInput;
+            // custom working directory
+            const workingDirectoryInput = core.getInput('working-directory');
+            if (workingDirectoryInput) {
+                console.log(`custom working directory: ${workingDirectoryInput}`);
+            }
+            const workingDirectory = !workingDirectoryInput ? undefined : workingDirectoryInput;
             // custom script to run
             const scriptInput = core.getInput('script', { required: true });
             const scripts = script_parser_1.parseScript(scriptInput);
@@ -77,8 +83,12 @@ function run() {
             }
             // execute the custom script
             try {
+                // move to custom working directory if set
+                if (workingDirectory) {
+                    process.chdir(workingDirectory);
+                }
                 for (const script of scripts) {
-                    yield exec.exec(`${script}`);
+                    yield exec.exec(`sh -c \\"${script}"`);
                 }
             }
             catch (error) {

lib/sdk-installer.js

@@ -15,17 +15,25 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const core = __importStar(require("@actions/core"));
 const exec = __importStar(require("@actions/exec"));
-const BUILD_TOOLS_VERSION = '29.0.2';
+const BUILD_TOOLS_VERSION = '29.0.3';
+const CMDLINE_TOOLS_URL = 'https://dl.google.com/android/repository/commandlinetools-linux-6200805_latest.zip';
 /**
  * Installs & updates the Android SDK for the macOS platform, including SDK platform for the chosen API level, latest build tools, platform tools, Android Emulator,
  * and the system image for the chosen API level, CPU arch, and target.
  */
 function installAndroidSdk(apiLevel, target, arch, emulatorBuild) {
     return __awaiter(this, void 0, void 0, function* () {
-        const sdkmangerPath = `${process.env.ANDROID_HOME}/tools/bin/sdkmanager`;
+        console.log('Installing new cmdline-tools.');
+        yield exec.exec(`mkdir ${process.env.ANDROID_HOME}/cmdline-tools`);
+        yield exec.exec(`curl -fo commandlinetools.zip ${CMDLINE_TOOLS_URL}`);
+        yield exec.exec(`unzip -q commandlinetools.zip -d ${process.env.ANDROID_HOME}/cmdline-tools`);
+        yield exec.exec(`rm -f commandlinetools.zip`);
+        // add paths for commandline-tools and platform-tools
+        core.addPath(`${process.env.ANDROID_HOME}/cmdline-tools/tools:${process.env.ANDROID_HOME}/cmdline-tools/tools/bin:${process.env.ANDROID_HOME}/platform-tools`);
         console.log('Installing latest build tools, platform tools, and platform.');
-        yield exec.exec(`sh -c \\"${sdkmangerPath} --install 'build-tools;${BUILD_TOOLS_VERSION}' platform-tools 'platforms;android-${apiLevel}' > /dev/null"`);
+        yield exec.exec(`sh -c \\"sdkmanager --install 'build-tools;${BUILD_TOOLS_VERSION}' platform-tools 'platforms;android-${apiLevel}' > /dev/null"`);
         if (emulatorBuild) {
             console.log(`Installing emulator build ${emulatorBuild}.`);
             yield exec.exec(`curl -fo emulator.zip https://dl.google.com/android/repository/emulator-darwin-${emulatorBuild}.zip`);
@@ -35,10 +43,10 @@ function installAndroidSdk(apiLevel, target, arch, emulatorBuild) {
         }
         else {
             console.log('Installing latest emulator.');
-            yield exec.exec(`sh -c \\"${sdkmangerPath} --install emulator > /dev/null"`);
+            yield exec.exec(`sh -c \\"sdkmanager --install emulator > /dev/null"`);
         }
         console.log('Installing system images.');
-        yield exec.exec(`sh -c \\"${sdkmangerPath} --install 'system-images;android-${apiLevel};${target};${arch}' > /dev/null"`);
+        yield exec.exec(`sh -c \\"sdkmanager --install 'system-images;android-${apiLevel};${target};${arch}' > /dev/null"`);
     });
 }
 exports.installAndroidSdk = installAndroidSdk;

src/emulator-manager.ts

@@ -1,8 +1,6 @@
 import * as exec from '@actions/exec';
 
 const EMULATOR_BOOT_TIMEOUT_SECONDS = 300;
-const AVD_MANAGER_PATH = `${process.env.ANDROID_HOME}/tools/bin/avdmanager`;
-const ADB_PATH = `${process.env.ANDROID_HOME}/platform-tools/adb`;
 
 /**
  * Creates and launches a new AVD instance with the specified configurations.
@@ -11,10 +9,10 @@ export async function launchEmulator(apiLevel: number, target: string, arch: str
   // create a new AVD
   if (profile.trim() !== '') {
     console.log(`Creating AVD with custom profile ${profile}`);
-    await exec.exec(`${AVD_MANAGER_PATH} create avd --force -n test --abi "${target}/${arch}" --package "system-images;android-${apiLevel};${target};${arch}" --device "${profile}"`);
+    await exec.exec(`avdmanager create avd --force -n test --abi "${target}/${arch}" --package "system-images;android-${apiLevel};${target};${arch}" --device "${profile}"`);
   } else {
     console.log(`Creating AVD without custom profile.`);
-    await exec.exec(`sh -c \\"echo no | ${AVD_MANAGER_PATH} create avd --force -n test --abi '${target}/${arch}' --package 'system-images;android-${apiLevel};${target};${arch}'"`);
+    await exec.exec(`sh -c \\"echo no | avdmanager create avd --force -n test --abi '${target}/${arch}' --package 'system-images;android-${apiLevel};${target};${arch}'"`);
   }
 
   // start emulator
@@ -31,14 +29,14 @@ export async function launchEmulator(apiLevel: number, target: string, arch: str
 
   // wait for emulator to complete booting
   await waitForDevice();
-  await exec.exec(`${ADB_PATH} shell input keyevent 82`);
+  await exec.exec(`adb shell input keyevent 82`);
 
   // disable animations
   if (disableAnimations) {
     console.log('Disabling animations.');
-    await exec.exec(`${ADB_PATH} shell settings put global window_animation_scale 0.0`);
-    await exec.exec(`${ADB_PATH} shell settings put global transition_animation_scale 0.0`);
-    await exec.exec(`${ADB_PATH} shell settings put global animator_duration_scale 0.0`);
+    await exec.exec(`adb shell settings put global window_animation_scale 0.0`);
+    await exec.exec(`adb shell settings put global transition_animation_scale 0.0`);
+    await exec.exec(`adb shell settings put global animator_duration_scale 0.0`);
   }
 }
 
@@ -47,7 +45,7 @@ export async function launchEmulator(apiLevel: number, target: string, arch: str
  */
 export async function killEmulator(): Promise<void> {
   try {
-    await exec.exec(`${ADB_PATH} -s emulator-5554 emu kill`);
+    await exec.exec(`adb -s emulator-5554 emu kill`);
   } catch (error) {
     console.log(error.message);
   }
@@ -64,7 +62,7 @@ async function waitForDevice(): Promise<void> {
   while (!booted) {
     try {
       let result = '';
-      await exec.exec(`${ADB_PATH} shell getprop sys.boot_completed`, [], {
+      await exec.exec(`adb shell getprop sys.boot_completed`, [], {
         listeners: {
           stdout: (data: Buffer) => {
             result += data.toString();

src/input-validator.ts

@@ -1,4 +1,4 @@
-export const MIN_API_LEVEL = 21;
+export const MIN_API_LEVEL = 15;
 export const VALID_TARGETS: Array<string> = ['default', 'google_apis'];
 export const VALID_ARCHS: Array<string> = ['x86', 'x86_64'];
 

src/main.ts

@@ -50,6 +50,13 @@ async function run() {
     }
     const emulatorBuild = !emulatorBuildInput ? undefined : emulatorBuildInput;
 
+    // custom working directory
+    const workingDirectoryInput = core.getInput('working-directory');
+    if (workingDirectoryInput) {
+      console.log(`custom working directory: ${workingDirectoryInput}`);
+    }
+    const workingDirectory = !workingDirectoryInput ? undefined : workingDirectoryInput;
+
     // custom script to run
     const scriptInput = core.getInput('script', { required: true });
     const scripts = parseScript(scriptInput);
@@ -70,8 +77,12 @@ async function run() {
 
     // execute the custom script
     try {
+      // move to custom working directory if set
+      if (workingDirectory) {
+        process.chdir(workingDirectory);
+      }
       for (const script of scripts) {
-        await exec.exec(`${script}`);
+        await exec.exec(`sh -c \\"${script}"`);
       }
     } catch (error) {
       core.setFailed(error.message);

src/sdk-installer.ts

@@ -1,15 +1,25 @@
+import * as core from '@actions/core';
 import * as exec from '@actions/exec';
 
-const BUILD_TOOLS_VERSION = '29.0.2';
+const BUILD_TOOLS_VERSION = '29.0.3';
+const CMDLINE_TOOLS_URL = 'https://dl.google.com/android/repository/commandlinetools-linux-6200805_latest.zip';
 
 /**
  * Installs & updates the Android SDK for the macOS platform, including SDK platform for the chosen API level, latest build tools, platform tools, Android Emulator,
  * and the system image for the chosen API level, CPU arch, and target.
  */
 export async function installAndroidSdk(apiLevel: number, target: string, arch: string, emulatorBuild?: string): Promise<void> {
-  const sdkmangerPath = `${process.env.ANDROID_HOME}/tools/bin/sdkmanager`;
+  console.log('Installing new cmdline-tools.');
+  await exec.exec(`mkdir ${process.env.ANDROID_HOME}/cmdline-tools`);
+  await exec.exec(`curl -fo commandlinetools.zip ${CMDLINE_TOOLS_URL}`);
+  await exec.exec(`unzip -q commandlinetools.zip -d ${process.env.ANDROID_HOME}/cmdline-tools`);
+  await exec.exec(`rm -f commandlinetools.zip`);
+
+  // add paths for commandline-tools and platform-tools
+  core.addPath(`${process.env.ANDROID_HOME}/cmdline-tools/tools:${process.env.ANDROID_HOME}/cmdline-tools/tools/bin:${process.env.ANDROID_HOME}/platform-tools`);
+
   console.log('Installing latest build tools, platform tools, and platform.');
-  await exec.exec(`sh -c \\"${sdkmangerPath} --install 'build-tools;${BUILD_TOOLS_VERSION}' platform-tools 'platforms;android-${apiLevel}' > /dev/null"`);
+  await exec.exec(`sh -c \\"sdkmanager --install 'build-tools;${BUILD_TOOLS_VERSION}' platform-tools 'platforms;android-${apiLevel}' > /dev/null"`);
   if (emulatorBuild) {
     console.log(`Installing emulator build ${emulatorBuild}.`);
     await exec.exec(`curl -fo emulator.zip https://dl.google.com/android/repository/emulator-darwin-${emulatorBuild}.zip`);
@@ -18,8 +28,8 @@ export async function installAndroidSdk(apiLevel: number, target: string, arch:
     await exec.exec(`rm -f emulator.zip`);
   } else {
     console.log('Installing latest emulator.');
-    await exec.exec(`sh -c \\"${sdkmangerPath} --install emulator > /dev/null"`);
+    await exec.exec(`sh -c \\"sdkmanager --install emulator > /dev/null"`);
   }
   console.log('Installing system images.');
-  await exec.exec(`sh -c \\"${sdkmangerPath} --install 'system-images;android-${apiLevel};${target};${arch}' > /dev/null"`);
+  await exec.exec(`sh -c \\"sdkmanager --install 'system-images;android-${apiLevel};${target};${arch}' > /dev/null"`);
 }

test-fixture/app/build.gradle

@@ -4,11 +4,11 @@ apply plugin: 'kotlin-android-extensions'
 
 android {
     compileSdkVersion 29
-    buildToolsVersion "29.0.2"
+    buildToolsVersion "29.0.3"
 
     defaultConfig {
         applicationId "com.example.testapp"
-        minSdkVersion 21
+        minSdkVersion 15
         targetSdkVersion 29
         versionCode 1
         versionName "1.0"
@@ -28,9 +28,9 @@ dependencies {
     implementation fileTree(dir: 'libs', include: ['*.jar'])
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
     implementation 'androidx.appcompat:appcompat:1.1.0'
-    implementation 'androidx.core:core-ktx:1.1.0'
+    implementation 'androidx.core:core-ktx:1.2.0'
     implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
-    testImplementation 'junit:junit:4.12'
+    testImplementation 'junit:junit:4.13'
     androidTestImplementation 'androidx.test.ext:junit:1.1.1'
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
 }

test-fixture/build.gradle

@@ -1,13 +1,13 @@
 // Top-level build file where you can add configuration options common to all sub-projects/modules.
 
 buildscript {
-    ext.kotlin_version = '1.3.61'
+    ext.kotlin_version = '1.3.70'
     repositories {
         google()
         jcenter()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:3.5.3'
+        classpath 'com.android.tools.build:gradle:3.6.0'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
 
         // NOTE: Do not place your application dependencies here; they belong

test-fixture/gradle/wrapper/gradle-wrapper.properties

@@ -3,4 +3,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.0.1-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.2.2-all.zip