Merge branch 'master' into release/v2

* master: Prepare for release 2.8.0. Add support for specifying a custom name used for creating AVD. Fix typo Add list of projects using android-emulator-runner. Bump kotlin and AGP for test fixture project.
Prepare for release 2.8.0.
2026-09-01 01:59:32 +00:00 · 2020-05-01 20:18:58 +10:00 · 2020-05-01 20:18:07 +10:00 · 2020-05-01 20:11:25 +10:00 · 2020-04-25 18:52:46 +10:00 · 2020-04-25 18:17:11 +10:00
12 changed files with 149 additions and 37 deletions
@@ -14,14 +14,12 @@ jobs:
    strategy:
      matrix:
        os: [macos-latest, ubuntu-latest]
-        api-level: [16, 23, 28, 29]
+        api-level: [16, 23, 29]
        exclude:
          - os: ubuntu-latest
            api-level: 23
          - os: ubuntu-latest
            api-level: 29
-          - os: macos-latest
-            api-level: 28
    steps:
    - name: checkout
      uses: actions/checkout@v2
@@ -40,7 +38,13 @@ jobs:
      uses: actions/setup-java@v1
      with:
        java-version: 14
-
+    - name: Clean cache
+      if: matrix.os == 'macos-latest'
+      run: mv ~/.gradle/caches ~/.gradle/.invalid_caches
+    - uses: actions/cache@v1
+      with:
+        path: ~/.gradle/caches
+        key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}-${{ hashFiles('**/gradle/wrapper/gradle-wrapper.properties') }}
    - name: run action
      uses: ./
      with:
@@ -48,6 +52,7 @@ jobs:
        target: default
        arch: x86
        profile: Nexus 6
+        avd-name: test
        emulator-options: -no-window -gpu swiftshader_indirect -no-snapshot -noaudio -no-boot-anim -camera-back none
        disable-animations: true
        working-directory: ./test-fixture/
@@ -1,5 +1,17 @@
 # Change Log

+## v2.8.0
+
+* Added support for specifying a custom name used for creating the **AVD** - [#59](https://github.com/ReactiveCircus/android-emulator-runner/issues/59).
+
+## v2.7.0
+
+* Added support for specifying versions of **NDK** and **CMake** to install.
+
+## v2.6.2
+
+* Fixed an issue where the Linux command-line tools binary is used for `macos`.
+
 ## v2.6.1

 * Fixed SDK license issue on Linux when downloading API 28+ system images - [#42](https://github.com/ReactiveCircus/android-emulator-runner/issues/42).
@@ -67,20 +67,64 @@ jobs:
        script: ./gradlew connectedCheck
 ```

+If you need specific versions of **NDK** and **CMake** installed:
+
+```
+jobs:
+  test:
+    runs-on: macos-latest
+    steps:
+    - name: checkout
+      uses: actions/checkout@v2
+
+    - name: run tests
+      uses: reactivecircus/android-emulator-runner@v2
+      with:
+        api-level: 29
+        ndk: 21.0.6113669
+        cmake: 3.10.2.4988404
+        script: ./gradlew connectedCheck
+```
+
 ## Configurations

+|  | **Required** | **Default** | **Description** |
+|----------------------|--------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 |  | **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 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`. 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". |
+| `avd-name` | Optional | `test` | Custom AVD name used for creating the Android Virtual Device. |
 | `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. |
+| `ndk` | Optional | N/A | Version of NDK to install - e.g. `21.0.6113669` |
+| `cmake` | Optional | N/A | Version of CMake to install - e.g. `3.10.2.4988404` |
 | `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`.

 _Please note that if you are running on a Linux VM, `-no-accel` will be added to the `emulator-options` to make sure hardware acceleration is turned off._
+
+## Who is using Android Emulator Runner?
+
+These are some of the open-source projects using (or used) **Android Emulator Runner**:
+
+- [coil-kt/coil](https://github.com/coil-kt/coil/blob/master/.github/workflows/)
+- [cashapp/sqldelight](https://github.com/cashapp/sqldelight/blob/master/.github/workflows/)
+- [square/workflow](https://github.com/square/workflow/blob/master/.github/workflows/)
+- [square/retrofit](https://github.com/square/retrofit/blob/master/.github/workflows/)
+- [natario1/CameraView](https://github.com/natario1/CameraView/tree/master/.github/workflows)
+- [natario1/Transcoder](https://github.com/natario1/Transcoder/tree/master/.github/workflows)
+- [chrisbanes/insetter](https://github.com/chrisbanes/insetter/tree/master/.github/workflows)
+- [slackhq/keeper](https://github.com/slackhq/keeper/tree/master/.github/workflows)
+- [android/compose-samples](https://github.com/android/compose-samples/blob/master/.github/workflows/ci.yaml)
+- [ReactiveCircus/streamlined](https://github.com/ReactiveCircus/streamlined/tree/master/.github/workflows)
+- [ReactiveCircus/FlowBinding](https://github.com/ReactiveCircus/FlowBinding)
+- [vinaygaba/Learn-Jetpack-Compose-By-Example](https://github.com/vinaygaba/Learn-Jetpack-Compose-By-Example/)
+- [ashishb/adb-enhanced](https://github.com/ashishb/adb-enhanced/tree/master/.github/workflows)
+
+If you are using **Android Emulator Runner** and want your project included in the list, please feel free to create an issue or open a pull request.
@@ -15,15 +15,24 @@ inputs:
    description: 'CPU architecture of the system image - x86 or x86_64'
    default: 'x86'
  profile:
-    description: 'Hardware profile used for creating the AVD - e.g. `Nexus 6`.'
+    description: 'hardware profile used for creating the AVD - e.g. `Nexus 6`'
+  avd-name:
+    description: 'custom AVD name used for creating the Android Virtual Device'
+    default: 'test'
  emulator-options:
-    description: 'command-line options used when launching the emulator - e.g. `-no-window -no-snapshot -camera-back emulated`.'
+    description: 'command-line options used when launching the emulator - e.g. `-no-window -no-snapshot -camera-back emulated`'
    default: '-no-window -gpu swiftshader_indirect -no-snapshot -noaudio -no-boot-anim'
  disable-animations:
    description: 'whether to disable animations - true or false'
    default: 'true'
  emulator-build:
-    description: 'build number of a specific version of the emulator binary to use e.g. `6061023` for emulator v29.3.0.0.'
+    description: 'build number of a specific version of the emulator binary to use - e.g. `6061023` for emulator v29.3.0.0'
+  working-directory:
+    description: 'A custom working directory - e.g. `./android` if your root Gradle project is under the `./android` sub-directory within your repository'
+  ndk:
+    description: 'version of NDK to install - e.g. 21.0.6113669'
+  cmake:
+    description: 'version of CMake to install - e.g. 3.10.2.4988404'
  script:
    description: 'custom script to run - e.g. `./gradlew connectedCheck`'
    required: true
@@ -20,16 +20,16 @@ const EMULATOR_BOOT_TIMEOUT_SECONDS = 600;
 /**
 * Creates and launches a new AVD instance with the specified configurations.
 */
-function launchEmulator(apiLevel, target, arch, profile, emulatorOptions, disableAnimations) {
+function launchEmulator(apiLevel, target, arch, profile, avdName, emulatorOptions, disableAnimations) {
    return __awaiter(this, void 0, void 0, function* () {
        // create a new AVD
        if (profile.trim() !== '') {
            console.log(`Creating AVD with custom profile ${profile}`);
-            yield exec.exec(`avdmanager 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 "${avdName}" --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 | avdmanager 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 "${avdName}" --abi '${target}/${arch}' --package 'system-images;android-${apiLevel};${target};${arch}'"`);
        }
        // start emulator
        console.log('Starting emulator.');
@@ -37,7 +37,7 @@ function launchEmulator(apiLevel, target, arch, profile, emulatorOptions, disabl
        if (process.platform === 'linux') {
            emulatorOptions += ' -accel off';
        }
-        yield exec.exec(`sh -c \\"${process.env.ANDROID_HOME}/emulator/emulator -avd test ${emulatorOptions} &"`, [], {
+        yield exec.exec(`sh -c \\"${process.env.ANDROID_HOME}/emulator/emulator -avd "${avdName}" ${emulatorOptions} &"`, [], {
            listeners: {
                stderr: (data) => {
                    if (data.toString().includes('invalid command-line parameter')) {
@@ -49,6 +49,9 @@ function run() {
            // Hardware profile used for creating the AVD
            const profile = core.getInput('profile');
            console.log(`Hardware profile: ${profile}`);
+            // custom name used for creating the AVD
+            const avdName = core.getInput('avd-name');
+            console.log(`AVD name: ${avdName}`);
            // emulator options
            const emulatorOptions = core.getInput('emulator-options').trim();
            console.log(`emulator options: ${emulatorOptions}`);
@@ -70,6 +73,18 @@ function run() {
                console.log(`custom working directory: ${workingDirectoryInput}`);
            }
            const workingDirectory = !workingDirectoryInput ? undefined : workingDirectoryInput;
+            // version of NDK to install
+            const ndkInput = core.getInput('ndk');
+            if (ndkInput) {
+                console.log(`version of NDK to install: ${ndkInput}`);
+            }
+            const ndkVersion = !ndkInput ? undefined : ndkInput;
+            // version of CMake to install
+            const cmakeInput = core.getInput('cmake');
+            if (cmakeInput) {
+                console.log(`version of CMake to install: ${cmakeInput}`);
+            }
+            const cmakeVersion = !cmakeInput ? undefined : cmakeInput;
            // custom script to run
            const scriptInput = core.getInput('script', { required: true });
            const scripts = script_parser_1.parseScript(scriptInput);
@@ -78,9 +93,9 @@ function run() {
                console.log(`${script}`);
            }));
            // install SDK
-            yield sdk_installer_1.installAndroidSdk(apiLevel, target, arch, emulatorBuild);
+            yield sdk_installer_1.installAndroidSdk(apiLevel, target, arch, emulatorBuild, ndkVersion, cmakeVersion);
            // launch an emulator
-            yield emulator_manager_1.launchEmulator(apiLevel, target, arch, profile, emulatorOptions, disableAnimations);
+            yield emulator_manager_1.launchEmulator(apiLevel, target, arch, profile, avdName, emulatorOptions, disableAnimations);
            // execute the custom script
            try {
                // move to custom working directory if set
@@ -18,13 +18,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const core = __importStar(require("@actions/core"));
 const exec = __importStar(require("@actions/exec"));
 const BUILD_TOOLS_VERSION = '29.0.3';
-const CMDLINE_TOOLS_URL_MAC = 'https://dl.google.com/android/repository/commandlinetools-linux-6200805_latest.zip';
+const CMDLINE_TOOLS_URL_MAC = 'https://dl.google.com/android/repository/commandlinetools-mac-6200805_latest.zip';
 const CMDLINE_TOOLS_URL_LINUX = '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) {
+function installAndroidSdk(apiLevel, target, arch, emulatorBuild, ndkVersion, cmakeVersion) {
    return __awaiter(this, void 0, void 0, function* () {
        const isOnMac = process.platform === 'darwin';
        console.log('Installing new cmdline-tools.');
@@ -55,6 +55,14 @@ function installAndroidSdk(apiLevel, target, arch, emulatorBuild) {
        }
        console.log('Installing system images.');
        yield exec.exec(`sh -c \\"sdkmanager --install 'system-images;android-${apiLevel};${target};${arch}' > /dev/null"`);
+        if (ndkVersion) {
+            console.log(`Installing NDK ${ndkVersion}.`);
+            yield exec.exec(`sh -c \\"sdkmanager --install 'ndk;${ndkVersion}' > /dev/null"`);
+        }
+        if (cmakeVersion) {
+            console.log(`Installing CMake ${cmakeVersion}.`);
+            yield exec.exec(`sh -c \\"sdkmanager --install 'cmake;${cmakeVersion}' > /dev/null"`);
+        }
    });
 }
 exports.installAndroidSdk = installAndroidSdk;
@@ -4937,20 +4937,12 @@
      }
    },
    "mkdirp": {
-      "version": "0.5.1",
-      "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.1.tgz",
-      "integrity": "sha1-MAV0OOrGz3+MR2fzhkjWaX11yQM=",
+      "version": "0.5.5",
+      "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.5.tgz",
+      "integrity": "sha512-NKmAlESf6jMGym1++R0Ra7wvhV+wFW63FaSOFPwRahvea0gMUcGUhVeAg/0BC0wiv9ih5NYPB1Wn1UEI1/L+xQ==",
      "dev": true,
      "requires": {
-        "minimist": "0.0.8"
-      },
-      "dependencies": {
-        "minimist": {
-          "version": "0.0.8",
-          "resolved": "https://registry.npmjs.org/minimist/-/minimist-0.0.8.tgz",
-          "integrity": "sha1-hX/Kv8M5fSYluCKCYuhqp6ARsF0=",
-          "dev": true
-        }
+        "minimist": "^1.2.5"
      }
    },
    "ms": {
@@ -5,14 +5,14 @@ const EMULATOR_BOOT_TIMEOUT_SECONDS = 600;
 /**
 * Creates and launches a new AVD instance with the specified configurations.
 */
-export async function launchEmulator(apiLevel: number, target: string, arch: string, profile: string, emulatorOptions: string, disableAnimations: boolean): Promise<void> {
+export async function launchEmulator(apiLevel: number, target: string, arch: string, profile: string, avdName: string, emulatorOptions: string, disableAnimations: boolean): Promise<void> {
  // create a new AVD
  if (profile.trim() !== '') {
    console.log(`Creating AVD with custom profile ${profile}`);
-    await exec.exec(`avdmanager 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 "${avdName}" --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 | avdmanager 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 "${avdName}" --abi '${target}/${arch}' --package 'system-images;android-${apiLevel};${target};${arch}'"`);
  }

  // start emulator
@@ -23,7 +23,7 @@ export async function launchEmulator(apiLevel: number, target: string, arch: str
    emulatorOptions += ' -accel off';
  }

-  await exec.exec(`sh -c \\"${process.env.ANDROID_HOME}/emulator/emulator -avd test ${emulatorOptions} &"`, [], {
+  await exec.exec(`sh -c \\"${process.env.ANDROID_HOME}/emulator/emulator -avd "${avdName}" ${emulatorOptions} &"`, [], {
    listeners: {
      stderr: (data: Buffer) => {
        if (data.toString().includes('invalid command-line parameter')) {
@@ -38,6 +38,10 @@ async function run() {
    const profile = core.getInput('profile');
    console.log(`Hardware profile: ${profile}`);

+    // custom name used for creating the AVD
+    const avdName = core.getInput('avd-name');
+    console.log(`AVD name: ${avdName}`);
+
    // emulator options
    const emulatorOptions = core.getInput('emulator-options').trim();
    console.log(`emulator options: ${emulatorOptions}`);
@@ -63,6 +67,20 @@ async function run() {
    }
    const workingDirectory = !workingDirectoryInput ? undefined : workingDirectoryInput;

+    // version of NDK to install
+    const ndkInput = core.getInput('ndk');
+    if (ndkInput) {
+      console.log(`version of NDK to install: ${ndkInput}`);
+    }
+    const ndkVersion = !ndkInput ? undefined : ndkInput;
+
+    // version of CMake to install
+    const cmakeInput = core.getInput('cmake');
+    if (cmakeInput) {
+      console.log(`version of CMake to install: ${cmakeInput}`);
+    }
+    const cmakeVersion = !cmakeInput ? undefined : cmakeInput;
+
    // custom script to run
    const scriptInput = core.getInput('script', { required: true });
    const scripts = parseScript(scriptInput);
@@ -72,10 +90,10 @@ async function run() {
    });

    // install SDK
-    await installAndroidSdk(apiLevel, target, arch, emulatorBuild);
+    await installAndroidSdk(apiLevel, target, arch, emulatorBuild, ndkVersion, cmakeVersion);

    // launch an emulator
-    await launchEmulator(apiLevel, target, arch, profile, emulatorOptions, disableAnimations);
+    await launchEmulator(apiLevel, target, arch, profile, avdName, emulatorOptions, disableAnimations);

    // execute the custom script
    try {
@@ -2,14 +2,14 @@ import * as core from '@actions/core';
 import * as exec from '@actions/exec';

 const BUILD_TOOLS_VERSION = '29.0.3';
-const CMDLINE_TOOLS_URL_MAC = 'https://dl.google.com/android/repository/commandlinetools-linux-6200805_latest.zip';
+const CMDLINE_TOOLS_URL_MAC = 'https://dl.google.com/android/repository/commandlinetools-mac-6200805_latest.zip';
 const CMDLINE_TOOLS_URL_LINUX = '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> {
+export async function installAndroidSdk(apiLevel: number, target: string, arch: string, emulatorBuild?: string, ndkVersion?: string, cmakeVersion?: string): Promise<void> {
  const isOnMac = process.platform === 'darwin';
  console.log('Installing new cmdline-tools.');
  const sdkUrl = isOnMac ? CMDLINE_TOOLS_URL_MAC : CMDLINE_TOOLS_URL_LINUX;
@@ -42,4 +42,13 @@ export async function installAndroidSdk(apiLevel: number, target: string, arch:
  }
  console.log('Installing system images.');
  await exec.exec(`sh -c \\"sdkmanager --install 'system-images;android-${apiLevel};${target};${arch}' > /dev/null"`);
+
+  if (ndkVersion) {
+    console.log(`Installing NDK ${ndkVersion}.`);
+    await exec.exec(`sh -c \\"sdkmanager --install 'ndk;${ndkVersion}' > /dev/null"`);
+  }
+  if (cmakeVersion) {
+    console.log(`Installing CMake ${cmakeVersion}.`);
+    await exec.exec(`sh -c \\"sdkmanager --install 'cmake;${cmakeVersion}' > /dev/null"`);
+  }
 }
@@ -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.70'
+    ext.kotlin_version = '1.3.72'
    repositories {
        google()
        jcenter()
    }
    dependencies {
-        classpath 'com.android.tools.build:gradle:3.6.0'
+        classpath 'com.android.tools.build:gradle:3.6.2'
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"

        // NOTE: Do not place your application dependencies here; they belong
Author	SHA1	Message	Date
Yang	4f4106d3fc	Merge branch 'master' into release/v2 * master: Prepare for release 2.8.0. Add support for specifying a custom name used for creating AVD. Fix typo Add list of projects using android-emulator-runner. Bump kotlin and AGP for test fixture project.	2020-05-01 20:18:58 +10:00
Yang	4df9257dba	Prepare for release 2.8.0.	2020-05-01 20:18:07 +10:00
Yang	f5435af41b	Add support for specifying a custom name used for creating AVD.	2020-05-01 20:11:25 +10:00
Yang	fdd35a3667	Fix typo	2020-04-25 18:52:46 +10:00
Yang	2513ea5ecf	Add list of projects using android-emulator-runner.	2020-04-25 18:17:11 +10:00
Yang	c0431f2812	Bump kotlin and AGP for test fixture project.	2020-04-14 23:57:49 +10:00
Yang	2f678a7026	Merge branch 'master' into release/v2 * master: Prepare for release 2.7.0. Security audit. Support specifying versions of NDK and CMake to install.	2020-04-11 21:52:57 +10:00
Yang	33176ea112	Prepare for release 2.7.0.	2020-04-11 21:50:47 +10:00
Yang	8972f964c9	Security audit.	2020-04-11 21:48:08 +10:00
Yang	438dce7110	Support specifying versions of NDK and CMake to install.	2020-04-11 21:02:42 +10:00
Yang Chen	e4eb880655	Merge branch 'master' into release/v2 * master: Prepare for release 2.6.2. Add gradle caching. Use correct cli-tools binary for mac. Remove API 28 from workflow.	2020-04-03 00:13:02 +11:00
Yang Chen	61dd774a5b	Prepare for release 2.6.2.	2020-04-03 00:12:04 +11:00
Yang Chen	8c62a78107	Add gradle caching.	2020-04-02 23:43:06 +11:00
Yang Chen	0d53ec8e43	Use correct cli-tools binary for mac.	2020-04-02 22:56:56 +11:00
Yang Chen	730757f124	Remove API 28 from workflow.	2020-04-01 09:37:55 +11:00