Merge branch 'main' into release/v2

* main:
  Prepare for release 2.21.0.
  Update packages.
  Support aosp_atd and google_atd targets.
  Added SORMAS to the list of projects
  Bump tmpl from 1.0.4 to 1.0.5
  Update NPM packages.
  Add tinylog to project list
  Add paths-ignore for pull_request.
  Fix typo.

.github/workflows/main.yml

@@ -1,6 +1,8 @@
 name: Main workflow
 on:
   pull_request:
+    paths-ignore:
+      - '**.md'
   push:
     branches:
       - main
@@ -18,6 +20,7 @@ jobs:
         os: [macos-latest, ubuntu-latest]
         api-level: [16, 23, 29]
         target: [default, google_apis]
+        arch: [x86]
         exclude:
           - os: ubuntu-latest
             api-level: 23
@@ -30,15 +33,18 @@ jobs:
           - target: google_apis
             api-level: 29
         include:
-          - os: macos-11.0
-            api-level: 30
-            target: google_apis
           - os: macos-latest
             api-level: 24
             target: playstore
+            arch: x86
           - os: macos-latest
-            api-level: 28
+            api-level: 30
+            target: aosp_atd
+            arch: x86
+          - os: macos-11
+            api-level: 31
             target: google_apis
+            arch: x86_64
 
     steps:
     - name: checkout
@@ -64,20 +70,55 @@ jobs:
           ~/.gradle/caches
           ~/.gradle/wrapper
         key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}-${{ hashFiles('**/gradle/wrapper/gradle-wrapper.properties') }}
+    - uses: actions/cache@v2
+      id: avd-cache
+      with:
+        path: |
+          ~/.android/avd/*
+          ~/.android/adb*
+          ~/.android/debug.keystore
+        key: avd-${{ matrix.api-level }}-${{ matrix.os }}-${{ matrix.target }}
+
+    - name: assemble tests
+      run: |
+        cd ./test-fixture/
+        ./gradlew assembleAndroidTest
+
+    - name: run emulator to generate snapshot for caching
+      if: steps.avd-cache.outputs.cache-hit != 'true'
+      uses: ./
+      with:
+        api-level: ${{ matrix.api-level }}
+        target: ${{ matrix.target }}
+        arch: ${{ matrix.arch }}
+        profile: Galaxy Nexus
+        cores: 2
+        sdcard-path-or-size: 100M
+        avd-name: test
+        force-avd-creation: false
+        emulator-options: -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
+        disable-animations: false
+        working-directory: ./test-fixture/
+        channel: canary
+        script: echo "Generated AVD snapshot for caching."
+
     - name: run action
       uses: ./
       with:
         api-level: ${{ matrix.api-level }}
         target: ${{ matrix.target }}
-        arch: x86
-        profile: Nexus 6
+        arch: ${{ matrix.arch }}
+        profile: Galaxy Nexus
+        cores: 2
+        ram-size: 2048M
         sdcard-path-or-size: 100M
         avd-name: test
-        emulator-options: -no-window -gpu swiftshader_indirect -no-snapshot -noaudio -no-boot-anim -camera-back none
+        force-avd-creation: false
+        emulator-options: -no-snapshot-save -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
         disable-animations: true
         working-directory: ./test-fixture/
+        channel: canary
         script: |
           echo $GITHUB_REPOSITORY
           adb devices
-          ./gradlew help
           ./gradlew connectedDebugAndroidTest

.github/workflows/manually.yml

@@ -0,0 +1,76 @@
+name: Manually triggered workflow
+on:
+  workflow_dispatch:
+    inputs:
+      os:
+        description: 'OS'
+        required: true
+        default: 'macos-latest'
+      api-level:
+        description: 'API level of the platform and system image'
+        required: true
+        default: '30'
+      target:
+        description: 'target of the system image - default, google_apis, google_apis_playstore, aosp_atd, google_atd, android-wear, android-wear-cn, android-tv or google-tv'
+        required: true
+        default: 'default'
+      arch:
+        description: 'CPU architecture of the system image - x86, x86_64 or arm64-v8a'
+        default: 'x86'
+      emulator-options:
+        description: 'command-line options used when launching the emulator'
+        default: '-no-window -gpu swiftshader_indirect -no-snapshot -noaudio -no-boot-anim'
+      emulator-build:
+        description: 'build number of a specific version of the emulator binary to use'
+      channel:
+        description: 'Channel to download the SDK components from - `stable`, `beta`, `dev`, `canary`'
+        default: 'stable'
+      script:
+        description: 'custom script to run - e.g. `./gradlew connectedCheck`'
+        required: true
+        default: './gradlew connectedDebugAndroidTest'
+
+jobs:
+  test:
+    runs-on: ${{ github.event.inputs.os }}
+    env:
+      JAVA_TOOL_OPTIONS: -Xmx4g
+    timeout-minutes: 15
+    
+    steps:
+    - name: checkout
+      uses: actions/checkout@v2
+
+    - name: validate gradle wrapper
+      uses: gradle/wrapper-validation-action@v1
+
+    - name: build, test and lint
+      run: |
+        npm install
+        npm run build
+        npm run lint
+        npm test
+
+    - name: Java 15
+      uses: actions/setup-java@v1
+      with:
+        java-version: 15
+    - uses: actions/cache@v2
+      with:
+        path: |
+          ~/.gradle/caches
+          ~/.gradle/wrapper
+        key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}-${{ hashFiles('**/gradle/wrapper/gradle-wrapper.properties') }}
+
+    - name: run action
+      uses: ./
+      with:
+        api-level: ${{ github.event.inputs.api-level }}
+        target: ${{ github.event.inputs.target }}
+        arch: ${{ github.event.inputs.arch }}
+        profile: Galaxy Nexus
+        emulator-options: ${{ github.event.inputs.emulator-options }}
+        emulator-build: ${{ github.event.inputs.emulator-build }}
+        channel: ${{ github.event.inputs.channel }}
+        working-directory: ./test-fixture/
+        script: ${{ github.event.inputs.script }}

CHANGELOG.md

@@ -1,5 +1,50 @@
 # Change Log
 
+## v2.21.0
+
+* Support new [ATD](https://developer.android.com/studio/preview/features#gmd-atd) targets optimized to reduce CPU and memory resources when running instrumented tests: `aosp_atd`, `google_atd`. - [#198](https://github.com/ReactiveCircus/android-emulator-runner/pull/198). Note that currently these targets require the following:
+  * `api-level: 30`
+  * `arch: x86` or `arch: arm64-v8a`
+  * `channel: canary`
+
+## v2.20.0
+
+* Support non-mobile targets: `android-wear`, `android-wear-cn`, `android-tv` and `google-tv`. - [#180](https://github.com/ReactiveCircus/android-emulator-runner/pull/180) @alexvanyo.
+* Update SDK command-line tools to `5.0`. - [#174](https://github.com/ReactiveCircus/android-emulator-runner/pull/174)
+* Update build tools to `31.0.0`. - [#174](https://github.com/ReactiveCircus/android-emulator-runner/pull/174)
+* Add option to specify the `channel` to download SDK components from: `stable` (default), `beta`, `dev` and `canary`. - [#185](https://github.com/ReactiveCircus/android-emulator-runner/pull/185)
+
+## v2.19.1
+
+* Accept all Android SDK Licenses to fix `sdkmanager` installation. - [#172](https://github.com/ReactiveCircus/android-emulator-runner/pull/172) @marcuspridham.
+
+## v2.19.0
+
+* Add option to specify `ram-size` for the AVD. - [#165](https://github.com/ReactiveCircus/android-emulator-runner/pull/165).
+
+
+## v2.18.1
+
+* Added support for setting modern emulator build ids for `emulator-build`. Not all build ids are supported until we are able to figure out at which build id the download URL pattern changed. `7425822` (version 30.7.3) is currently the last known working build id.
+
+## v2.18.0
+
+* Add `force-avd-creation` which when set to `false` will skip avd creation if avd with same name exists. This enables AVD snapshot caching which can significantly reduce emulator startup time. See [README.md](https://github.com/ReactiveCircus/android-emulator-runner/blob/main/README.md#usage) for a sample workflow. - [#159](https://github.com/ReactiveCircus/android-emulator-runner/pull/159)
+
+## v2.17.0
+
+* Add option to toggle Linux hardware acceleration - [#154](https://github.com/ReactiveCircus/android-emulator-runner/pull/154) @stevestotter
+
+## v2.16.0
+
+* Avoid wrapping script code in quotes - [#134](https://github.com/ReactiveCircus/android-emulator-runner/pull/134) @hostilefork
+* Add option to disable spellcheck - [#143](https://github.com/ReactiveCircus/android-emulator-runner/pull/143) @AfzalivE
+* Add support for arm64-v8a for Apple Silicon Macs - [#146](https://github.com/ReactiveCircus/android-emulator-runner/pull/146) @Jeehut
+
+## v2.15.0
+
+* Added support for specifying the number of cores to use for the emulator - [#130](https://github.com/ReactiveCircus/android-emulator-runner/pull/130).
+
 ## v2.14.3
 
 * Support `macos-11.0` (Big Sur) runner - [#124](https://github.com/ReactiveCircus/android-emulator-runner/pull/124).

README.md

@@ -8,8 +8,8 @@ A GitHub Action for installing, configuring and running hardware-accelerated And
 
 The old ARM-based emulators were slow and are no longer supported by Google. The modern Intel Atom (x86 and x86_64) emulators require hardware acceleration (HAXM on Mac & Windows, QEMU on Linux) from the host to run fast. This presents a challenge on CI as to be able to run hardware accelerated emulators within a docker container, **KVM** must be supported by the host VM which isn't the case for cloud-based CI providers due to infrastructural limits. If you want to learn more about this, here's an article I wrote: [Running Android Instrumented Tests on CI](https://dev.to/ychescale9/running-android-emulators-on-ci-from-bitrise-io-to-github-actions-3j76).
 
-The **macOS** VM provided by **GitHub Actions** has **HAXM** installed so we are able to create a new AVD instance, launch an emulator with hardware acceleration, and run our Android 
-tests directly on the VM.
+The **macOS** VM provided by **GitHub Actions** has **HAXM** installed so we are able to create a new AVD instance, launch an emulator with hardware acceleration, and run our Android
+tests directly on the VM. You can also achieve this on a self-hosted Linux runner, but it will need to be on a compatible instance that allows you to enable KVM - for example AWS EC2 Bare Metal instances. 
 
 This action automates the process by doing the following:
 
@@ -31,14 +31,14 @@ jobs:
   test:
     runs-on: macos-latest
     steps:
-    - name: checkout
-      uses: actions/checkout@v2
+      - name: checkout
+        uses: actions/checkout@v2
 
-    - name: run tests
-      uses: reactivecircus/android-emulator-runner@v2
-      with:
-        api-level: 29
-        script: ./gradlew connectedCheck
+      - name: run tests
+        uses: reactivecircus/android-emulator-runner@v2
+        with:
+          api-level: 29
+          script: ./gradlew connectedCheck
 ```
 
 We can also leverage GitHub Actions's build matrix to test across multiple configurations:
@@ -52,17 +52,17 @@ jobs:
         api-level: [21, 23, 29]
         target: [default, google_apis]
     steps:
-    - name: checkout
-      uses: actions/checkout@v2
+      - name: checkout
+        uses: actions/checkout@v2
 
-    - name: run tests
-      uses: reactivecircus/android-emulator-runner@v2
-      with:
-        api-level: ${{ matrix.api-level }}
-        target: ${{ matrix.target }}
-        arch: x86_64
-        profile: Nexus 6
-        script: ./gradlew connectedCheck
+      - name: run tests
+        uses: reactivecircus/android-emulator-runner@v2
+        with:
+          api-level: ${{ matrix.api-level }}
+          target: ${{ matrix.target }}
+          arch: x86_64
+          profile: Nexus 6
+          script: ./gradlew connectedCheck
 ```
 
 If you need specific versions of **NDK** and **CMake** installed:
@@ -72,16 +72,70 @@ jobs:
   test:
     runs-on: macos-latest
     steps:
-    - name: checkout
-      uses: actions/checkout@v2
+      - 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
+      - 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
+```
+
+We can significantly reduce emulator startup time by setting up AVD snapshot caching:
+
+1. add an `actions/cache@v2` step for caching the `avd`
+2. add a `reactivecircus/android-emulator-runner@v2` step to generate a clean snapshot - specify `emulator-options` without `no-snapshot`
+3. add another `reactivecircus/android-emulator-runner@v2` step to run your tests using existing AVD / snapshot - specify `emulator-options` with `no-snapshot-save`
+
+```
+jobs:
+  test:
+    runs-on: macos-latest
+    strategy:
+      matrix:
+        api-level: [21, 23, 29]
+    steps:
+      - name: checkout
+        uses: actions/checkout@v2
+
+      - name: Gradle cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*') }}-${{ hashFiles('**/gradle/wrapper/gradle-wrapper.properties') }}-${{ hashFiles('**/buildSrc/**/*.kt') }}
+
+      - name: AVD cache
+        uses: actions/cache@v2
+        id: avd-cache
+        with:
+          path: |
+            ~/.android/avd/*
+            ~/.android/adb*
+          key: avd-${{ matrix.api-level }}
+
+      - name: create AVD and generate snapshot for caching
+        if: steps.avd-cache.outputs.cache-hit != 'true'
+        uses: reactivecircus/android-emulator-runner@v2
+        with:
+          api-level: ${{ matrix.api-level }}
+          force-avd-creation: false
+          emulator-options: -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
+          disable-animations: false
+          script: echo "Generated AVD snapshot for caching."
+
+      - name: run tests
+        uses: reactivecircus/android-emulator-runner@v2
+        with:
+          api-level: ${{ matrix.api-level }}
+          force-avd-creation: false
+          emulator-options: -no-snapshot-save -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
+          disable-animations: true
+          script: ./gradlew connectedCheck
 ```
 
 ## Configurations
@@ -90,23 +144,29 @@ jobs:
 |-|-|-|-|
 | `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`, `google_apis` or `playstore`. |
-| `arch` | Optional | `x86` | CPU architecture of the system image - `x86` or `x86_64`. Note that `x86_64` image is only available for API 21+. |
+| `arch` | Optional | `x86` | CPU architecture of the system image - `x86`, `x86_64` or `arm64-v8a`. Note that `x86_64` image is only available for API 21+. `arm64-v8a` images require Android 4.2+ and are limited to fewer API levels (e.g. 30). |
 | `profile` | Optional | N/A | Hardware profile used for creating the AVD - e.g. `Nexus 6`. For a list of all profiles available, run `avdmanager list` and refer to the results under "Available Android Virtual Devices". |
+| `cores` | Optional | 2 | Number of cores to use for the emulator (`hw.cpu.ncore` in config.ini). |
+| `ram-size` | Optional | N/A | Size of RAM to use for this AVD, in KB or MB, denoted with K or M. - e.g. `2048M` |
 | `sdcard-path-or-size` | Optional | N/A | Path to the SD card image for this AVD or the size of a new SD card image to create for this AVD, in KB or MB, denoted with K or M. - e.g. `path/to/sdcard`, or `1000M`. |
 | `avd-name` | Optional | `test` | Custom AVD name used for creating the Android Virtual Device. |
+| `force-avd-creation` | Optional | `true` | Whether to force create the AVD by overwriting an existing AVD with the same name as `avd-name` - `true` or `false`. |
 | `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`. |
+| `disable-spellchecker` | Optional | `false` | Whether to disable spellchecker - `true` or `false`. |
+| `disable-linux-hw-accel` | Optional | `true` | Whether to disable hardware acceleration on Linux machines - `true` or `false`. Note that this is true by default as Github-hosted Linux runners do not support hardware acceleration. |
 | `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` |
+| `channel` | Optional | stable | Channel to download the SDK components from - `stable`, `beta`, `dev`, `canary` |
 | `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`.
 
 ## Can I use this action on Linux VMs?
 
-The short answer is yes but it's expected to be a much worse experience (on some newer API levels it might not work at all) than running it on macOS.
+The short answer is yes but on Github-hosted Linux runners it's expected to be a much worse experience (on some newer API levels it might not work at all) than running it on macOS. You can get it running much faster on self-hosted Linux runners but only if the underlying instances support KVM (which most don't).
 
 For a longer answer please refer to [this issue](https://github.com/ReactiveCircus/android-emulator-runner/issues/46).
 
@@ -137,5 +197,12 @@ These are some of the open-source projects using (or used) **Android Emulator Ru
 - [square/leakcanary](https://github.com/square/leakcanary/tree/main/.github/workflows)
 - [hash-checker/hash-checker](https://github.com/hash-checker/hash-checker/tree/master/.github/workflows)
 - [hash-checker/hash-checker-lite](https://github.com/hash-checker/hash-checker-lite/tree/master/.github/workflows)
+- [Kiwix/kiwix-android](https://github.com/kiwix/kiwix-android/blob/develop/.github/workflows)
+- [wikimedia/apps-android-wikipedia](https://github.com/wikimedia/apps-android-wikipedia/blob/master/.github/workflows)
+- [google/android-fhir](https://github.com/google/android-fhir/tree/master/.github/workflows)
+- [google/accompanist](https://github.com/google/accompanist/blob/main/.github/workflows)
+- [dotanuki-labs/norris](https://github.com/dotanuki-labs/norris/blob/master/.github/workflows/main.yml)
+- [tinylog-org/tinylog](https://github.com/tinylog-org/tinylog/blob/v3.0/.github/workflows/build.yaml)
+- [hzi-braunschweig/SORMAS-Project](https://github.com/hzi-braunschweig/SORMAS-Project/blob/development/.github/workflows/sormas_app_ci.yml)
 
 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.

__tests__/channel-id-mapper.test.ts

@@ -0,0 +1,17 @@
+import * as mapper from '../src/channel-id-mapper';
+
+describe('channel id mapper tests', () => {
+  it('Throws if channelName is unknown', () => {
+    const func = () => {
+      mapper.getChannelId('unknown-channel');
+    };
+    expect(func).toThrowError(`Unexpected channel name: 'unknown-channel'.`);
+  });
+
+  it('Returns expected channelId from channelName', () => {
+    expect(mapper.getChannelId('stable')).toBe(0);
+    expect(mapper.getChannelId('beta')).toBe(1);
+    expect(mapper.getChannelId('dev')).toBe(2);
+    expect(mapper.getChannelId('canary')).toBe(3);
+  });
+});

__tests__/input-validator.test.ts

@@ -55,9 +55,39 @@ describe('target validator tests', () => {
     expect(func2).not.toThrow();
 
     const func3 = () => {
-      validator.checkTarget('google_apis');
+      validator.checkTarget('aosp_atd');
     };
     expect(func3).not.toThrow();
+
+    const func4 = () => {
+      validator.checkTarget('google_atd');
+    };
+    expect(func4).not.toThrow();
+
+    const func5 = () => {
+      validator.checkTarget('google_apis_playstore');
+    };
+    expect(func5).not.toThrow();
+
+    const func6 = () => {
+      validator.checkTarget('android-wear');
+    };
+    expect(func6).not.toThrow();
+
+    const func7 = () => {
+      validator.checkTarget('android-wear-cn');
+    };
+    expect(func7).not.toThrow();
+
+    const func8 = () => {
+      validator.checkTarget('android-tv');
+    };
+    expect(func8).not.toThrow();
+
+    const func9 = () => {
+      validator.checkTarget('google-tv');
+    };
+    expect(func9).not.toThrow();
   });
 });
 
@@ -82,6 +112,58 @@ describe('arch validator tests', () => {
   });
 });
 
+describe('channel validator tests', () => {
+  it('Throws if channel is unknown', () => {
+    const func = () => {
+      validator.checkChannel('some-channel');
+    };
+    expect(func).toThrowError(`Value for input.channel 'some-channel' is unknown. Supported options: ${validator.VALID_CHANNELS}`);
+  });
+
+  it('Validates successfully with valid channel', () => {
+    const func1 = () => {
+      validator.checkChannel('stable');
+    };
+    expect(func1).not.toThrow();
+
+    const func2 = () => {
+      validator.checkChannel('beta');
+    };
+    expect(func2).not.toThrow();
+
+    const func3 = () => {
+      validator.checkChannel('dev');
+    };
+    expect(func3).not.toThrow();
+
+    const func4 = () => {
+      validator.checkChannel('canary');
+    };
+    expect(func4).not.toThrow();
+  });
+});
+
+describe('force-avd-creation validator tests', () => {
+  it('Throws if force-avd-creation is not a boolean', () => {
+    const func = () => {
+      validator.checkForceAvdCreation('yes');
+    };
+    expect(func).toThrowError(`Input for input.force-avd-creation should be either 'true' or 'false'.`);
+  });
+
+  it('Validates successfully if force-avd-creation is either true or false', () => {
+    const func1 = () => {
+      validator.checkForceAvdCreation('true');
+    };
+    expect(func1).not.toThrow();
+
+    const func2 = () => {
+      validator.checkForceAvdCreation('false');
+    };
+    expect(func2).not.toThrow();
+  });
+});
+
 describe('disable-animations validator tests', () => {
   it('Throws if disable-animations is not a boolean', () => {
     const func = () => {
@@ -103,6 +185,48 @@ describe('disable-animations validator tests', () => {
   });
 });
 
+describe('disable-spellchecker validator tests', () => {
+  it('Throws if disable-spellchecker is not a boolean', () => {
+    const func = () => {
+      validator.checkDisableSpellchecker('yes');
+    };
+    expect(func).toThrowError(`Input for input.disable-spellchecker should be either 'true' or 'false'.`);
+  });
+
+  it('Validates successfully if disable-spellchecker is either true or false', () => {
+    const func1 = () => {
+      validator.checkDisableSpellchecker('true');
+    };
+    expect(func1).not.toThrow();
+
+    const func2 = () => {
+      validator.checkDisableSpellchecker('false');
+    };
+    expect(func2).not.toThrow();
+  });
+});
+
+describe('disable-linux-hw-accel validator tests', () => {
+  it('Throws if disable-linux-hw-accel is not a boolean', () => {
+    const func = () => {
+      validator.checkDisableLinuxHardwareAcceleration('yes');
+    };
+    expect(func).toThrowError(`Input for input.disable-linux-hw-accel should be either 'true' or 'false'.`);
+  });
+
+  it('Validates successfully if disable-linux-hw-accel is either true or false', () => {
+    const func1 = () => {
+      validator.checkDisableLinuxHardwareAcceleration('true');
+    };
+    expect(func1).not.toThrow();
+
+    const func2 = () => {
+      validator.checkDisableLinuxHardwareAcceleration('false');
+    };
+    expect(func2).not.toThrow();
+  });
+});
+
 describe('emulator-build validator tests', () => {
   it('Throws if emulator-build is not a number', () => {
     const func = () => {

action.yml

@@ -2,31 +2,45 @@ name: 'Android Emulator Runner'
 description: 'Installs, configures and starts an Android Emulator directly on macOS virtual machines.'
 author: 'Reactive Circus'
 branding:
-  icon: 'smartphone'  
+  icon: 'smartphone'
   color: 'green'
 inputs:
   api-level:
     description: 'API level of the platform and system image - e.g. 23 for Android Marshmallow, 29 for Android 10'
     required: true
   target:
-    description: 'target of the system image - default, google_apis or playstore'
+    description: 'target of the system image - default, google_apis, google_apis_playstore, aosp_atd, google_atd, android-wear, android-wear-cn, android-tv or google-tv'
     default: 'default'
   arch:
-    description: 'CPU architecture of the system image - x86 or x86_64'
+    description: 'CPU architecture of the system image - x86, x86_64 or arm64-v8a'
     default: 'x86'
   profile:
     description: 'hardware profile used for creating the AVD - e.g. `Nexus 6`'
+  cores:
+    description: 'the number of cores to use for the emulator'
+    default: 2
+  ram-size:
+    description: 'size of RAM to use for this AVD, in KB or MB, denoted with K or M. - e.g. `2048M`'
   sdcard-path-or-size:
     description: 'path to the SD card image for this AVD or the size of a new SD card image to create for this AVD, in KB or MB, denoted with K or M. - e.g. `path/to/sdcard`, or `1000M`'
   avd-name:
     description: 'custom AVD name used for creating the Android Virtual Device'
     default: 'test'
+  force-avd-creation:
+    description: 'whether to force create the AVD by overwriting an existing AVD with the same name as `avd-name` - `true` or `false`'
+    default: 'true'
   emulator-options:
     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'
+  disable-spellchecker:
+    description: 'whether to disable spellchecker - `true` or `false`'
+    default: 'false'
+  disable-linux-hw-accel:
+    description: 'whether to disable hardware acceleration on Linux machines - `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'
   working-directory:
@@ -35,6 +49,9 @@ inputs:
     description: 'version of NDK to install - e.g. 21.0.6113669'
   cmake:
     description: 'version of CMake to install - e.g. 3.10.2.4988404'
+  channel:
+    description: 'Channel to download the SDK components from - `stable`, `beta`, `dev`, `canary`'
+    default: 'stable'
   script:
     description: 'custom script to run - e.g. `./gradlew connectedCheck`'
     required: true

lib/channel-id-mapper.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getChannelId = void 0;
+function getChannelId(channelName) {
+    if (channelName === 'stable') {
+        return 0;
+    }
+    else if (channelName === 'beta') {
+        return 1;
+    }
+    else if (channelName === 'dev') {
+        return 2;
+    }
+    else if (channelName === 'canary') {
+        return 3;
+    }
+    else {
+        throw new Error(`Unexpected channel name: '${channelName}'.`);
+    }
+}
+exports.getChannelId = getChannelId;

lib/emulator-manager.js

@@ -30,23 +30,34 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.killEmulator = exports.launchEmulator = void 0;
 const exec = __importStar(require("@actions/exec"));
+const fs = __importStar(require("fs"));
 const EMULATOR_BOOT_TIMEOUT_SECONDS = 600;
 /**
  * Creates and launches a new AVD instance with the specified configurations.
  */
-function launchEmulator(apiLevel, target, arch, profile, sdcardPathOrSize, avdName, emulatorOptions, disableAnimations) {
+function launchEmulator(apiLevel, target, arch, profile, cores, ramSize, sdcardPathOrSize, avdName, forceAvdCreation, emulatorOptions, disableAnimations, disableSpellChecker, disableLinuxHardwareAcceleration) {
     return __awaiter(this, void 0, void 0, function* () {
-        // create a new AVD
-        const profileOption = profile.trim() !== '' ? `--device '${profile}'` : '';
-        const sdcardPathOrSizeOption = sdcardPathOrSize.trim() !== '' ? `--sdcard '${sdcardPathOrSize}'` : '';
-        console.log(`Creating AVD.`);
-        yield exec.exec(`sh -c \\"echo no | avdmanager create avd --force -n "${avdName}" --abi '${target}/${arch}' --package 'system-images;android-${apiLevel};${target};${arch}' ${profileOption} ${sdcardPathOrSizeOption}"`);
-        // start emulator
-        console.log('Starting emulator.');
-        // turn off hardware acceleration on Linux
-        if (process.platform === 'linux') {
+        // create a new AVD if AVD directory does not already exist or forceAvdCreation is true
+        const avdPath = `${process.env.ANDROID_AVD_HOME}/${avdName}.avd`;
+        if (!fs.existsSync(avdPath) || forceAvdCreation) {
+            const profileOption = profile.trim() !== '' ? `--device '${profile}'` : '';
+            const sdcardPathOrSizeOption = sdcardPathOrSize.trim() !== '' ? `--sdcard '${sdcardPathOrSize}'` : '';
+            console.log(`Creating AVD.`);
+            yield exec.exec(`sh -c \\"echo no | avdmanager create avd --force -n "${avdName}" --abi '${target}/${arch}' --package 'system-images;android-${apiLevel};${target};${arch}' ${profileOption} ${sdcardPathOrSizeOption}"`);
+        }
+        if (cores) {
+            yield exec.exec(`sh -c \\"printf 'hw.cpu.ncore=${cores}\n' >> ${process.env.ANDROID_AVD_HOME}/"${avdName}".avd"/config.ini`);
+        }
+        if (ramSize) {
+            yield exec.exec(`sh -c \\"printf 'hw.ramSize=${ramSize}\n' >> ${process.env.ANDROID_AVD_HOME}/"${avdName}".avd"/config.ini`);
+        }
+        //turn off hardware acceleration on Linux
+        if (process.platform === 'linux' && disableLinuxHardwareAcceleration) {
+            console.log('Disabling Linux hardware acceleration.');
             emulatorOptions += ' -accel off';
         }
+        // start emulator
+        console.log('Starting emulator.');
         yield exec.exec(`sh -c \\"${process.env.ANDROID_SDK_ROOT}/emulator/emulator -avd "${avdName}" ${emulatorOptions} &"`, [], {
             listeners: {
                 stderr: (data) => {
@@ -66,6 +77,9 @@ function launchEmulator(apiLevel, target, arch, profile, sdcardPathOrSize, avdNa
             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`);
         }
+        if (disableSpellChecker) {
+            yield exec.exec(`adb shell settings put secure spell_checker_enabled 0`);
+        }
     });
 }
 exports.launchEmulator = launchEmulator;

lib/input-validator.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkEmulatorBuild = exports.checkDisableAnimations = exports.checkArch = exports.checkTarget = exports.checkApiLevel = exports.VALID_ARCHS = exports.VALID_TARGETS = exports.MIN_API_LEVEL = void 0;
+exports.checkEmulatorBuild = exports.checkDisableLinuxHardwareAcceleration = exports.checkDisableSpellchecker = exports.checkDisableAnimations = exports.checkForceAvdCreation = exports.checkChannel = exports.checkArch = exports.checkTarget = exports.checkApiLevel = exports.VALID_CHANNELS = exports.VALID_ARCHS = exports.VALID_TARGETS = exports.MIN_API_LEVEL = void 0;
 exports.MIN_API_LEVEL = 15;
-exports.VALID_TARGETS = ['default', 'google_apis', 'google_apis_playstore'];
-exports.VALID_ARCHS = ['x86', 'x86_64'];
+exports.VALID_TARGETS = ['default', 'google_apis', 'aosp_atd', 'google_atd', 'google_apis_playstore', 'android-wear', 'android-wear-cn', 'android-tv', 'google-tv'];
+exports.VALID_ARCHS = ['x86', 'x86_64', 'arm64-v8a'];
+exports.VALID_CHANNELS = ['stable', 'beta', 'dev', 'canary'];
 function checkApiLevel(apiLevel) {
     if (isNaN(Number(apiLevel)) || !Number.isInteger(Number(apiLevel))) {
         throw new Error(`Unexpected API level: '${apiLevel}'.`);
@@ -25,15 +26,42 @@ function checkArch(arch) {
     }
 }
 exports.checkArch = checkArch;
+function checkChannel(channel) {
+    if (!exports.VALID_CHANNELS.includes(channel)) {
+        throw new Error(`Value for input.channel '${channel}' is unknown. Supported options: ${exports.VALID_CHANNELS}.`);
+    }
+}
+exports.checkChannel = checkChannel;
+function checkForceAvdCreation(forceAvdCreation) {
+    if (!isValidBoolean(forceAvdCreation)) {
+        throw new Error(`Input for input.force-avd-creation should be either 'true' or 'false'.`);
+    }
+}
+exports.checkForceAvdCreation = checkForceAvdCreation;
 function checkDisableAnimations(disableAnimations) {
-    if (disableAnimations !== 'true' && disableAnimations !== 'false') {
+    if (!isValidBoolean(disableAnimations)) {
         throw new Error(`Input for input.disable-animations should be either 'true' or 'false'.`);
     }
 }
 exports.checkDisableAnimations = checkDisableAnimations;
+function checkDisableSpellchecker(disableSpellchecker) {
+    if (!isValidBoolean(disableSpellchecker)) {
+        throw new Error(`Input for input.disable-spellchecker should be either 'true' or 'false'.`);
+    }
+}
+exports.checkDisableSpellchecker = checkDisableSpellchecker;
+function checkDisableLinuxHardwareAcceleration(disableLinuxHardwareAcceleration) {
+    if (!isValidBoolean(disableLinuxHardwareAcceleration)) {
+        throw new Error(`Input for input.disable-linux-hw-accel should be either 'true' or 'false'.`);
+    }
+}
+exports.checkDisableLinuxHardwareAcceleration = checkDisableLinuxHardwareAcceleration;
 function checkEmulatorBuild(emulatorBuild) {
     if (isNaN(Number(emulatorBuild)) || !Number.isInteger(Number(emulatorBuild))) {
         throw new Error(`Unexpected emulator build: '${emulatorBuild}'.`);
     }
 }
 exports.checkEmulatorBuild = checkEmulatorBuild;
+function isValidBoolean(value) {
+    return value === 'true' || value === 'false';
+}

lib/main.js

@@ -34,6 +34,7 @@ const input_validator_1 = require("./input-validator");
 const emulator_manager_1 = require("./emulator-manager");
 const exec = __importStar(require("@actions/exec"));
 const script_parser_1 = require("./script-parser");
+const channel_id_mapper_1 = require("./channel-id-mapper");
 function run() {
     return __awaiter(this, void 0, void 0, function* () {
         try {
@@ -63,12 +64,23 @@ function run() {
             // Hardware profile used for creating the AVD
             const profile = core.getInput('profile');
             console.log(`Hardware profile: ${profile}`);
+            // Number of cores to use for emulator
+            const cores = core.getInput('cores');
+            console.log(`Cores: ${cores}`);
+            // RAM to use for AVD
+            const ramSize = core.getInput('ram-size');
+            console.log(`RAM size: ${ramSize}`);
             // SD card path or size used for creating the AVD
             const sdcardPathOrSize = core.getInput('sdcard-path-or-size');
             console.log(`SD card path or size: ${sdcardPathOrSize}`);
             // custom name used for creating the AVD
             const avdName = core.getInput('avd-name');
             console.log(`AVD name: ${avdName}`);
+            // force AVD creation
+            const forceAvdCreationInput = core.getInput('force-avd-creation');
+            input_validator_1.checkForceAvdCreation(forceAvdCreationInput);
+            const forceAvdCreation = forceAvdCreationInput === 'true';
+            console.log(`force avd creation: ${forceAvdCreation}`);
             // emulator options
             const emulatorOptions = core.getInput('emulator-options').trim();
             console.log(`emulator options: ${emulatorOptions}`);
@@ -77,6 +89,16 @@ function run() {
             input_validator_1.checkDisableAnimations(disableAnimationsInput);
             const disableAnimations = disableAnimationsInput === 'true';
             console.log(`disable animations: ${disableAnimations}`);
+            // disable spellchecker
+            const disableSpellcheckerInput = core.getInput('disable-spellchecker');
+            input_validator_1.checkDisableSpellchecker(disableSpellcheckerInput);
+            const disableSpellchecker = disableSpellcheckerInput === 'true';
+            console.log(`disable spellchecker: ${disableSpellchecker}`);
+            // disable linux hardware acceleration
+            const disableLinuxHardwareAccelerationInput = core.getInput('disable-linux-hw-accel');
+            input_validator_1.checkDisableLinuxHardwareAcceleration(disableLinuxHardwareAccelerationInput);
+            const disableLinuxHardwareAcceleration = disableLinuxHardwareAccelerationInput === 'true';
+            console.log(`disable Linux hardware acceleration: ${disableLinuxHardwareAcceleration}`);
             // emulator build
             const emulatorBuildInput = core.getInput('emulator-build');
             if (emulatorBuildInput) {
@@ -102,6 +124,11 @@ function run() {
                 console.log(`version of CMake to install: ${cmakeInput}`);
             }
             const cmakeVersion = !cmakeInput ? undefined : cmakeInput;
+            // channelId (up to and including) to download the SDK packages from
+            const channelName = core.getInput('channel');
+            input_validator_1.checkChannel(channelName);
+            const channelId = channel_id_mapper_1.getChannelId(channelName);
+            console.log(`Channel: ${channelId} (${channelName})`);
             // custom script to run
             const scriptInput = core.getInput('script', { required: true });
             const scripts = script_parser_1.parseScript(scriptInput);
@@ -110,9 +137,9 @@ function run() {
                 console.log(`${script}`);
             }));
             // install SDK
-            yield sdk_installer_1.installAndroidSdk(apiLevel, target, arch, emulatorBuild, ndkVersion, cmakeVersion);
+            yield sdk_installer_1.installAndroidSdk(apiLevel, target, arch, channelId, emulatorBuild, ndkVersion, cmakeVersion);
             // launch an emulator
-            yield emulator_manager_1.launchEmulator(apiLevel, target, arch, profile, sdcardPathOrSize, avdName, emulatorOptions, disableAnimations);
+            yield emulator_manager_1.launchEmulator(apiLevel, target, arch, profile, cores, ramSize, sdcardPathOrSize, avdName, forceAvdCreation, emulatorOptions, disableAnimations, disableSpellchecker, disableLinuxHardwareAcceleration);
             // execute the custom script
             try {
                 // move to custom working directory if set
@@ -120,7 +147,9 @@ function run() {
                     process.chdir(workingDirectory);
                 }
                 for (const script of scripts) {
-                    yield exec.exec(`sh -c \\"${script}"`);
+                    // use array form to avoid various quote escaping problems
+                    // caused by exec(`sh -c "${script}"`)
+                    yield exec.exec('sh', ['-c', script]);
                 }
             }
             catch (error) {

lib/sdk-installer.js

@@ -34,14 +34,14 @@ const exec = __importStar(require("@actions/exec"));
 const io = __importStar(require("@actions/io"));
 const tc = __importStar(require("@actions/tool-cache"));
 const fs = __importStar(require("fs"));
-const BUILD_TOOLS_VERSION = '30.0.3';
-const CMDLINE_TOOLS_URL_MAC = 'https://dl.google.com/android/repository/commandlinetools-mac-6858069_latest.zip';
-const CMDLINE_TOOLS_URL_LINUX = 'https://dl.google.com/android/repository/commandlinetools-linux-6858069_latest.zip';
+const BUILD_TOOLS_VERSION = '31.0.0';
+const CMDLINE_TOOLS_URL_MAC = 'https://dl.google.com/android/repository/commandlinetools-mac-7583922_latest.zip';
+const CMDLINE_TOOLS_URL_LINUX = 'https://dl.google.com/android/repository/commandlinetools-linux-7583922_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, ndkVersion, cmakeVersion) {
+function installAndroidSdk(apiLevel, target, arch, channelId, emulatorBuild, ndkVersion, cmakeVersion) {
     return __awaiter(this, void 0, void 0, function* () {
         const isOnMac = process.platform === 'darwin';
         if (!isOnMac) {
@@ -57,42 +57,32 @@ function installAndroidSdk(apiLevel, target, arch, emulatorBuild, ndkVersion, cm
         }
         // add paths for commandline-tools and platform-tools
         core.addPath(`${cmdlineToolsPath}/latest:${cmdlineToolsPath}/latest/bin:${process.env.ANDROID_SDK_ROOT}/platform-tools`);
-        // additional permission and license requirements for Linux
-        const sdkPreviewLicensePath = `${process.env.ANDROID_SDK_ROOT}/licenses/android-sdk-preview-license`;
-        if (!isOnMac && !fs.existsSync(sdkPreviewLicensePath)) {
-            fs.writeFileSync(sdkPreviewLicensePath, '\n84831b9409646a918e30573bab4c9c91346d8abd');
-        }
-        // license required for API 30 and non-default API 28 system images
-        const sdkArmDbtLicensePath = `${process.env.ANDROID_SDK_ROOT}/licenses/android-sdk-arm-dbt-license`;
-        if (requiresArmDbtLicense(apiLevel, target) && !fs.existsSync(sdkArmDbtLicensePath)) {
-            fs.writeFileSync(sdkArmDbtLicensePath, '\n859f317696f67ef3d7f30a50a5560e7834b43903');
-        }
+        // set standard AVD path
+        core.exportVariable('ANDROID_AVD_HOME', `${process.env.HOME}/.android/avd`);
+        // accept all Android SDK licenses
+        yield exec.exec(`sh -c \\"yes | sdkmanager --licenses > /dev/null"`);
         console.log('Installing latest build tools, platform tools, and platform.');
         yield exec.exec(`sh -c \\"sdkmanager --install 'build-tools;${BUILD_TOOLS_VERSION}' platform-tools 'platforms;android-${apiLevel}' > /dev/null"`);
+        console.log('Installing latest emulator.');
+        yield exec.exec(`sh -c \\"sdkmanager --install emulator --channel=${channelId} > /dev/null"`);
         if (emulatorBuild) {
             console.log(`Installing emulator build ${emulatorBuild}.`);
-            yield exec.exec(`curl -fo emulator.zip https://dl.google.com/android/repository/emulator-${isOnMac ? 'darwin' : 'linux'}-${emulatorBuild}.zip`);
-            yield io.rmRF(`${process.env.ANDROID_SDK_ROOT}/emulator`);
-            yield exec.exec(`unzip -q emulator.zip -d ${process.env.ANDROID_SDK_ROOT}`);
+            // TODO find out the correct download URLs for all build ids
+            const downloadUrlSuffix = Number(emulatorBuild.charAt(0)) > 6 ? `_x64-${emulatorBuild}` : `-${emulatorBuild}`;
+            yield exec.exec(`curl -fo emulator.zip https://dl.google.com/android/repository/emulator-${isOnMac ? 'darwin' : 'linux'}${downloadUrlSuffix}.zip`);
+            yield exec.exec(`unzip -o -q emulator.zip -d ${process.env.ANDROID_SDK_ROOT}`);
             yield io.rmRF('emulator.zip');
         }
-        else {
-            console.log('Installing latest emulator.');
-            yield exec.exec(`sh -c \\"sdkmanager --install emulator > /dev/null"`);
-        }
         console.log('Installing system images.');
-        yield exec.exec(`sh -c \\"sdkmanager --install 'system-images;android-${apiLevel};${target};${arch}' > /dev/null"`);
+        yield exec.exec(`sh -c \\"sdkmanager --install 'system-images;android-${apiLevel};${target};${arch}' --channel=${channelId} > /dev/null"`);
         if (ndkVersion) {
             console.log(`Installing NDK ${ndkVersion}.`);
-            yield exec.exec(`sh -c \\"sdkmanager --install 'ndk;${ndkVersion}' > /dev/null"`);
+            yield exec.exec(`sh -c \\"sdkmanager --install 'ndk;${ndkVersion}' --channel=${channelId} > /dev/null"`);
         }
         if (cmakeVersion) {
             console.log(`Installing CMake ${cmakeVersion}.`);
-            yield exec.exec(`sh -c \\"sdkmanager --install 'cmake;${cmakeVersion}' > /dev/null"`);
+            yield exec.exec(`sh -c \\"sdkmanager --install 'cmake;${cmakeVersion}' --channel=${channelId} > /dev/null"`);
         }
     });
 }
 exports.installAndroidSdk = installAndroidSdk;
-function requiresArmDbtLicense(apiLevel, target) {
-    return apiLevel === 30 || (apiLevel === 28 && target !== 'default');
-}

node_modules/@actions/exec/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright 2019 GitHub
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

node_modules/@actions/io/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright 2019 GitHub
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package.json

@@ -21,24 +21,25 @@
   "author": "Reactive Circus",
   "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.2.6",
-    "@actions/exec": "^1.0.4",
-    "@actions/tool-cache": "^1.6.1",
-    "minimist": "^1.2.5"
+    "@actions/core": "^1.5.0",
+    "@actions/exec": "^1.1.0",
+    "@actions/tool-cache": "^1.7.1",
+    "minimist": "^1.2.5",
+    "set-value": "^4.1.0"
   },
   "devDependencies": {
     "@types/jest": "^24.9.1",
-    "@types/node": "^12.19.11",
+    "@types/node": "^12.20.25",
     "@typescript-eslint/eslint-plugin": "^2.34.0",
     "@typescript-eslint/parser": "^2.34.0",
     "eslint": "^6.8.0",
     "eslint-config-prettier": "^6.15.0",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-prettier": "^3.3.0",
+    "eslint-plugin-import": "^2.24.2",
+    "eslint-plugin-prettier": "^3.4.1",
     "jest": "^26.6.3",
     "jest-circus": "^25.5.4",
     "prettier": "^1.19.1",
-    "ts-jest": "^26.4.4",
-    "typescript": "^3.9.7"
+    "ts-jest": "^26.5.6",
+    "typescript": "^3.9.10"
   }
 }

src/channel-id-mapper.ts

@@ -0,0 +1,13 @@
+export function getChannelId(channelName: string): number {
+  if (channelName === 'stable') {
+    return 0;
+  } else if (channelName === 'beta') {
+    return 1;
+  } else if (channelName === 'dev') {
+    return 2;
+  } else if (channelName === 'canary') {
+    return 3;
+  } else {
+    throw new Error(`Unexpected channel name: '${channelName}'.`);
+  }
+}

src/emulator-manager.ts

@@ -1,4 +1,5 @@
 import * as exec from '@actions/exec';
+import * as fs from 'fs';
 
 const EMULATOR_BOOT_TIMEOUT_SECONDS = 600;
 
@@ -10,27 +11,44 @@ export async function launchEmulator(
   target: string,
   arch: string,
   profile: string,
+  cores: string,
+  ramSize: string,
   sdcardPathOrSize: string,
   avdName: string,
+  forceAvdCreation: boolean,
   emulatorOptions: string,
-  disableAnimations: boolean
+  disableAnimations: boolean,
+  disableSpellChecker: boolean,
+  disableLinuxHardwareAcceleration: boolean
 ): Promise<void> {
-  // create a new AVD
-  const profileOption = profile.trim() !== '' ? `--device '${profile}'` : '';
-  const sdcardPathOrSizeOption = sdcardPathOrSize.trim() !== '' ? `--sdcard '${sdcardPathOrSize}'` : '';
-  console.log(`Creating AVD.`);
-  await exec.exec(
-    `sh -c \\"echo no | avdmanager create avd --force -n "${avdName}" --abi '${target}/${arch}' --package 'system-images;android-${apiLevel};${target};${arch}' ${profileOption} ${sdcardPathOrSizeOption}"`
-  );
+  // create a new AVD if AVD directory does not already exist or forceAvdCreation is true
+  const avdPath = `${process.env.ANDROID_AVD_HOME}/${avdName}.avd`;
+  if (!fs.existsSync(avdPath) || forceAvdCreation) {
+    const profileOption = profile.trim() !== '' ? `--device '${profile}'` : '';
+    const sdcardPathOrSizeOption = sdcardPathOrSize.trim() !== '' ? `--sdcard '${sdcardPathOrSize}'` : '';
+    console.log(`Creating AVD.`);
+    await exec.exec(
+      `sh -c \\"echo no | avdmanager create avd --force -n "${avdName}" --abi '${target}/${arch}' --package 'system-images;android-${apiLevel};${target};${arch}' ${profileOption} ${sdcardPathOrSizeOption}"`
+    );
+  }
+
+  if (cores) {
+    await exec.exec(`sh -c \\"printf 'hw.cpu.ncore=${cores}\n' >> ${process.env.ANDROID_AVD_HOME}/"${avdName}".avd"/config.ini`);
+  }
+
+  if (ramSize) {
+    await exec.exec(`sh -c \\"printf 'hw.ramSize=${ramSize}\n' >> ${process.env.ANDROID_AVD_HOME}/"${avdName}".avd"/config.ini`);
+  }
+
+  //turn off hardware acceleration on Linux
+  if (process.platform === 'linux' && disableLinuxHardwareAcceleration) {
+    console.log('Disabling Linux hardware acceleration.');
+    emulatorOptions += ' -accel off';
+  }
 
   // start emulator
   console.log('Starting emulator.');
 
-  // turn off hardware acceleration on Linux
-  if (process.platform === 'linux') {
-    emulatorOptions += ' -accel off';
-  }
-
   await exec.exec(`sh -c \\"${process.env.ANDROID_SDK_ROOT}/emulator/emulator -avd "${avdName}" ${emulatorOptions} &"`, [], {
     listeners: {
       stderr: (data: Buffer) => {
@@ -52,6 +70,9 @@ export async function launchEmulator(
     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`);
   }
+  if (disableSpellChecker) {
+    await exec.exec(`adb shell settings put secure spell_checker_enabled 0`);
+  }
 }
 
 /**

src/input-validator.ts

@@ -1,6 +1,7 @@
 export const MIN_API_LEVEL = 15;
-export const VALID_TARGETS: Array<string> = ['default', 'google_apis', 'google_apis_playstore'];
-export const VALID_ARCHS: Array<string> = ['x86', 'x86_64'];
+export const VALID_TARGETS: Array<string> = ['default', 'google_apis', 'aosp_atd', 'google_atd', 'google_apis_playstore', 'android-wear', 'android-wear-cn', 'android-tv', 'google-tv'];
+export const VALID_ARCHS: Array<string> = ['x86', 'x86_64', 'arm64-v8a'];
+export const VALID_CHANNELS: Array<string> = ['stable', 'beta', 'dev', 'canary'];
 
 export function checkApiLevel(apiLevel: string): void {
   if (isNaN(Number(apiLevel)) || !Number.isInteger(Number(apiLevel))) {
@@ -23,14 +24,42 @@ export function checkArch(arch: string): void {
   }
 }
 
+export function checkChannel(channel: string): void {
+  if (!VALID_CHANNELS.includes(channel)) {
+    throw new Error(`Value for input.channel '${channel}' is unknown. Supported options: ${VALID_CHANNELS}.`);
+  }
+}
+
+export function checkForceAvdCreation(forceAvdCreation: string): void {
+  if (!isValidBoolean(forceAvdCreation)) {
+    throw new Error(`Input for input.force-avd-creation should be either 'true' or 'false'.`);
+  }
+}
+
 export function checkDisableAnimations(disableAnimations: string): void {
-  if (disableAnimations !== 'true' && disableAnimations !== 'false') {
+  if (!isValidBoolean(disableAnimations)) {
     throw new Error(`Input for input.disable-animations should be either 'true' or 'false'.`);
   }
 }
 
+export function checkDisableSpellchecker(disableSpellchecker: string): void {
+  if (!isValidBoolean(disableSpellchecker)) {
+    throw new Error(`Input for input.disable-spellchecker should be either 'true' or 'false'.`);
+  }
+}
+
+export function checkDisableLinuxHardwareAcceleration(disableLinuxHardwareAcceleration: string): void {
+  if (!isValidBoolean(disableLinuxHardwareAcceleration)) {
+    throw new Error(`Input for input.disable-linux-hw-accel should be either 'true' or 'false'.`);
+  }
+}
+
 export function checkEmulatorBuild(emulatorBuild: string): void {
   if (isNaN(Number(emulatorBuild)) || !Number.isInteger(Number(emulatorBuild))) {
     throw new Error(`Unexpected emulator build: '${emulatorBuild}'.`);
   }
 }
+
+function isValidBoolean(value: string): boolean {
+  return value === 'true' || value === 'false';
+}

src/main.ts

@@ -1,9 +1,20 @@
 import * as core from '@actions/core';
 import { installAndroidSdk } from './sdk-installer';
-import { checkApiLevel, checkTarget, checkArch, checkDisableAnimations, checkEmulatorBuild } from './input-validator';
+import {
+  checkApiLevel,
+  checkTarget,
+  checkArch,
+  checkDisableAnimations,
+  checkEmulatorBuild,
+  checkDisableSpellchecker,
+  checkDisableLinuxHardwareAcceleration,
+  checkForceAvdCreation,
+  checkChannel
+} from './input-validator';
 import { launchEmulator, killEmulator } from './emulator-manager';
 import * as exec from '@actions/exec';
 import { parseScript } from './script-parser';
+import { getChannelId } from './channel-id-mapper';
 
 async function run() {
   try {
@@ -39,6 +50,14 @@ async function run() {
     const profile = core.getInput('profile');
     console.log(`Hardware profile: ${profile}`);
 
+    // Number of cores to use for emulator
+    const cores = core.getInput('cores');
+    console.log(`Cores: ${cores}`);
+
+    // RAM to use for AVD
+    const ramSize = core.getInput('ram-size');
+    console.log(`RAM size: ${ramSize}`);
+
     // SD card path or size used for creating the AVD
     const sdcardPathOrSize = core.getInput('sdcard-path-or-size');
     console.log(`SD card path or size: ${sdcardPathOrSize}`);
@@ -47,6 +66,12 @@ async function run() {
     const avdName = core.getInput('avd-name');
     console.log(`AVD name: ${avdName}`);
 
+    // force AVD creation
+    const forceAvdCreationInput = core.getInput('force-avd-creation');
+    checkForceAvdCreation(forceAvdCreationInput);
+    const forceAvdCreation = forceAvdCreationInput === 'true';
+    console.log(`force avd creation: ${forceAvdCreation}`);
+
     // emulator options
     const emulatorOptions = core.getInput('emulator-options').trim();
     console.log(`emulator options: ${emulatorOptions}`);
@@ -57,6 +82,18 @@ async function run() {
     const disableAnimations = disableAnimationsInput === 'true';
     console.log(`disable animations: ${disableAnimations}`);
 
+    // disable spellchecker
+    const disableSpellcheckerInput = core.getInput('disable-spellchecker');
+    checkDisableSpellchecker(disableSpellcheckerInput);
+    const disableSpellchecker = disableSpellcheckerInput === 'true';
+    console.log(`disable spellchecker: ${disableSpellchecker}`);
+
+    // disable linux hardware acceleration
+    const disableLinuxHardwareAccelerationInput = core.getInput('disable-linux-hw-accel');
+    checkDisableLinuxHardwareAcceleration(disableLinuxHardwareAccelerationInput);
+    const disableLinuxHardwareAcceleration = disableLinuxHardwareAccelerationInput === 'true';
+    console.log(`disable Linux hardware acceleration: ${disableLinuxHardwareAcceleration}`);
+
     // emulator build
     const emulatorBuildInput = core.getInput('emulator-build');
     if (emulatorBuildInput) {
@@ -86,6 +123,12 @@ async function run() {
     }
     const cmakeVersion = !cmakeInput ? undefined : cmakeInput;
 
+    // channelId (up to and including) to download the SDK packages from
+    const channelName = core.getInput('channel');
+    checkChannel(channelName);
+    const channelId = getChannelId(channelName);
+    console.log(`Channel: ${channelId} (${channelName})`);
+
     // custom script to run
     const scriptInput = core.getInput('script', { required: true });
     const scripts = parseScript(scriptInput);
@@ -95,10 +138,24 @@ async function run() {
     });
 
     // install SDK
-    await installAndroidSdk(apiLevel, target, arch, emulatorBuild, ndkVersion, cmakeVersion);
+    await installAndroidSdk(apiLevel, target, arch, channelId, emulatorBuild, ndkVersion, cmakeVersion);
 
     // launch an emulator
-    await launchEmulator(apiLevel, target, arch, profile, sdcardPathOrSize, avdName, emulatorOptions, disableAnimations);
+    await launchEmulator(
+      apiLevel,
+      target,
+      arch,
+      profile,
+      cores,
+      ramSize,
+      sdcardPathOrSize,
+      avdName,
+      forceAvdCreation,
+      emulatorOptions,
+      disableAnimations,
+      disableSpellchecker,
+      disableLinuxHardwareAcceleration
+    );
 
     // execute the custom script
     try {
@@ -107,7 +164,9 @@ async function run() {
         process.chdir(workingDirectory);
       }
       for (const script of scripts) {
-        await exec.exec(`sh -c \\"${script}"`);
+        // use array form to avoid various quote escaping problems
+        // caused by exec(`sh -c "${script}"`)
+        await exec.exec('sh', ['-c', script]);
       }
     } catch (error) {
       core.setFailed(error.message);

src/sdk-installer.ts

@@ -4,15 +4,15 @@ import * as io from '@actions/io';
 import * as tc from '@actions/tool-cache';
 import * as fs from 'fs';
 
-const BUILD_TOOLS_VERSION = '30.0.3';
-const CMDLINE_TOOLS_URL_MAC = 'https://dl.google.com/android/repository/commandlinetools-mac-6858069_latest.zip';
-const CMDLINE_TOOLS_URL_LINUX = 'https://dl.google.com/android/repository/commandlinetools-linux-6858069_latest.zip';
+const BUILD_TOOLS_VERSION = '31.0.0';
+const CMDLINE_TOOLS_URL_MAC = 'https://dl.google.com/android/repository/commandlinetools-mac-7583922_latest.zip';
+const CMDLINE_TOOLS_URL_LINUX = 'https://dl.google.com/android/repository/commandlinetools-linux-7583922_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, ndkVersion?: string, cmakeVersion?: string): Promise<void> {
+export async function installAndroidSdk(apiLevel: number, target: string, arch: string, channelId: number, emulatorBuild?: string, ndkVersion?: string, cmakeVersion?: string): Promise<void> {
   const isOnMac = process.platform === 'darwin';
 
   if (!isOnMac) {
@@ -31,44 +31,36 @@ export async function installAndroidSdk(apiLevel: number, target: string, arch:
   // add paths for commandline-tools and platform-tools
   core.addPath(`${cmdlineToolsPath}/latest:${cmdlineToolsPath}/latest/bin:${process.env.ANDROID_SDK_ROOT}/platform-tools`);
 
-  // additional permission and license requirements for Linux
-  const sdkPreviewLicensePath = `${process.env.ANDROID_SDK_ROOT}/licenses/android-sdk-preview-license`;
-  if (!isOnMac && !fs.existsSync(sdkPreviewLicensePath)) {
-    fs.writeFileSync(sdkPreviewLicensePath, '\n84831b9409646a918e30573bab4c9c91346d8abd');
-  }
+  // set standard AVD path
+  core.exportVariable('ANDROID_AVD_HOME', `${process.env.HOME}/.android/avd`);
 
-  // license required for API 30 and non-default API 28 system images
-  const sdkArmDbtLicensePath = `${process.env.ANDROID_SDK_ROOT}/licenses/android-sdk-arm-dbt-license`;
-  if (requiresArmDbtLicense(apiLevel, target) && !fs.existsSync(sdkArmDbtLicensePath)) {
-    fs.writeFileSync(sdkArmDbtLicensePath, '\n859f317696f67ef3d7f30a50a5560e7834b43903');
-  }
+  // accept all Android SDK licenses
+  await exec.exec(`sh -c \\"yes | sdkmanager --licenses > /dev/null"`);
 
   console.log('Installing latest build tools, platform tools, and platform.');
 
   await exec.exec(`sh -c \\"sdkmanager --install 'build-tools;${BUILD_TOOLS_VERSION}' platform-tools 'platforms;android-${apiLevel}' > /dev/null"`);
+
+  console.log('Installing latest emulator.');
+  await exec.exec(`sh -c \\"sdkmanager --install emulator --channel=${channelId} > /dev/null"`);
+
   if (emulatorBuild) {
     console.log(`Installing emulator build ${emulatorBuild}.`);
-    await exec.exec(`curl -fo emulator.zip https://dl.google.com/android/repository/emulator-${isOnMac ? 'darwin' : 'linux'}-${emulatorBuild}.zip`);
-    await io.rmRF(`${process.env.ANDROID_SDK_ROOT}/emulator`);
-    await exec.exec(`unzip -q emulator.zip -d ${process.env.ANDROID_SDK_ROOT}`);
+    // TODO find out the correct download URLs for all build ids
+    const downloadUrlSuffix = Number(emulatorBuild.charAt(0)) > 6 ? `_x64-${emulatorBuild}` : `-${emulatorBuild}`;
+    await exec.exec(`curl -fo emulator.zip https://dl.google.com/android/repository/emulator-${isOnMac ? 'darwin' : 'linux'}${downloadUrlSuffix}.zip`);
+    await exec.exec(`unzip -o -q emulator.zip -d ${process.env.ANDROID_SDK_ROOT}`);
     await io.rmRF('emulator.zip');
-  } else {
-    console.log('Installing latest emulator.');
-    await exec.exec(`sh -c \\"sdkmanager --install emulator > /dev/null"`);
   }
   console.log('Installing system images.');
-  await exec.exec(`sh -c \\"sdkmanager --install 'system-images;android-${apiLevel};${target};${arch}' > /dev/null"`);
+  await exec.exec(`sh -c \\"sdkmanager --install 'system-images;android-${apiLevel};${target};${arch}' --channel=${channelId} > /dev/null"`);
 
   if (ndkVersion) {
     console.log(`Installing NDK ${ndkVersion}.`);
-    await exec.exec(`sh -c \\"sdkmanager --install 'ndk;${ndkVersion}' > /dev/null"`);
+    await exec.exec(`sh -c \\"sdkmanager --install 'ndk;${ndkVersion}' --channel=${channelId} > /dev/null"`);
   }
   if (cmakeVersion) {
     console.log(`Installing CMake ${cmakeVersion}.`);
-    await exec.exec(`sh -c \\"sdkmanager --install 'cmake;${cmakeVersion}' > /dev/null"`);
+    await exec.exec(`sh -c \\"sdkmanager --install 'cmake;${cmakeVersion}' --channel=${channelId} > /dev/null"`);
   }
 }
-
-function requiresArmDbtLicense(apiLevel: number, target: string): boolean {
-  return apiLevel === 30 || (apiLevel === 28 && target !== 'default');
-}

test-fixture/app/build.gradle

@@ -2,13 +2,13 @@ apply plugin: 'com.android.application'
 apply plugin: 'kotlin-android'
 
 android {
-    compileSdkVersion 30
-    buildToolsVersion "30.0.3"
+    compileSdkVersion 31
+    buildToolsVersion "31.0.0"
 
     defaultConfig {
         applicationId "com.example.testapp"
         minSdkVersion 15
-        targetSdkVersion 30
+        targetSdkVersion 31
         versionCode 1
         versionName "1.0"
 
@@ -26,10 +26,7 @@ android {
 dependencies {
     implementation fileTree(dir: 'libs', include: ['*.jar'])
     implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
-    implementation 'androidx.appcompat:appcompat:1.2.0'
-    implementation 'androidx.core:core-ktx:1.3.2'
-    implementation 'androidx.constraintlayout:constraintlayout:2.0.4'
-    testImplementation 'junit:junit:4.13'
-    androidTestImplementation 'androidx.test.ext:junit:1.1.2'
-    androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0'
+    implementation 'androidx.appcompat:appcompat:1.3.1'
+    androidTestImplementation 'androidx.test.ext:junit:1.1.3'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
 }

test-fixture/app/src/main/AndroidManifest.xml

@@ -9,7 +9,9 @@
         android:roundIcon="@mipmap/ic_launcher_round"
         android:supportsRtl="true"
         android:theme="@style/AppTheme">
-        <activity android:name="com.example.testapp.MainActivity">
+        <activity
+            android:name="com.example.testapp.MainActivity"
+            android:exported="true">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
 

test-fixture/app/src/main/res/layout/activity_main.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
+<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
     xmlns:app="http://schemas.android.com/apk/res-auto"
     xmlns:tools="http://schemas.android.com/tools"
     android:layout_width="match_parent"
@@ -10,9 +10,6 @@
         android:layout_width="wrap_content"
         android:layout_height="wrap_content"
         android:text="Hello World!"
-        app:layout_constraintBottom_toBottomOf="parent"
-        app:layout_constraintLeft_toLeftOf="parent"
-        app:layout_constraintRight_toRightOf="parent"
-        app:layout_constraintTop_toTopOf="parent" />
+        android:layout_gravity="center" />
 
-</androidx.constraintlayout.widget.ConstraintLayout>
+</FrameLayout>

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.4.21'
+    ext.kotlin_version = '1.5.30'
     repositories {
         google()
         jcenter()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:4.1.1'
+        classpath 'com.android.tools.build:gradle:7.0.1'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
 
         // NOTE: Do not place your application dependencies here; they belong

test-fixture/gradle.properties

@@ -1,7 +1,6 @@
 org.gradle.parallel=true
 org.gradle.configureondemand=true
 org.gradle.caching=true
-org.gradle.vfs.watch=true
 
 # Enable Kotlin incremental compilation
 kotlin.incremental=true

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.8-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip