Merge branch 'main' into release/v2

* main:
  Prepare for release 2.22.0.
  Update the README and fix some typos (#199)
  Add support for enabling hardware keyboard.
  Update README.md `avdmanager list device`
  Update NPM packages.
  Migrate to gradle-build-action.
  Update packages.

.github/workflows/main.yml

@@ -64,12 +64,6 @@ jobs:
       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') }}
     - uses: actions/cache@v2
       id: avd-cache
       with:
@@ -80,9 +74,10 @@ jobs:
         key: avd-${{ matrix.api-level }}-${{ matrix.os }}-${{ matrix.target }}
 
     - name: assemble tests
-      run: |
-        cd ./test-fixture/
-        ./gradlew assembleAndroidTest
+      uses: gradle/gradle-build-action@v2
+      with:
+        build-root-directory: test-fixture
+        arguments: assembleAndroidTest
 
     - name: run emulator to generate snapshot for caching
       if: steps.avd-cache.outputs.cache-hit != 'true'

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## v2.22.0
+
+* Add option to enable hardware keyboard. - [#209](https://github.com/ReactiveCircus/android-emulator-runner/pull/209) (upstreamed from the [Doist fork](https://github.com/Doist/android-emulator-runner/commit/4b6ca99f0d657662beca3eb0c22d8e254fbd5b31)).
+* Update README and fix typos. - [#203](https://github.com/ReactiveCircus/android-emulator-runner/pull/203) @JPrendy.
+
 ## 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:

README.md

@@ -22,7 +22,7 @@ This action automates the process by doing the following:
 
 ## Usage
 
-It is recommended to run this action on a **macOS** VM, e.g. `macos-latest` or `macos-10.15` to take advantage of hardware accleration support provided by **HAXM**.
+It is recommended to run this action on a **macOS** VM, e.g. `macos-latest`, `macos-10.15` or `macos-11` to take advantage of hardware acceleration support provided by **HAXM**.
 
 A workflow that uses **android-emulator-runner** to run your instrumented tests on **API 29**:
 
@@ -143,9 +143,9 @@ jobs:
 | **Input** | **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`, `google_apis` or `playstore`. |
+| `target` | Optional | `default` | Target of the system image - `default`, `google_apis`, `playstore`, `android-wear`, `android-wear-cn`, `android-tv`, `google-tv`, `aosp_atd` or `google_atd`. Note that `aosp_atd` and `google_atd` currently require the following: `api-level: 30`, `arch: x86` or `arch: arm64-v8` and `channel: canary`. |
 | `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". |
+| `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 device`. |
 | `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`. |
@@ -155,6 +155,7 @@ jobs:
 | `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. |
+| `enable-hw-keyboard` | Optional | `false` | Whether to enable hardware keyboard - `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` |

RELEASING.md

@@ -1,6 +1,6 @@
 # GitHub Action - Android Emulator Runner
 
-Refer to the [recommendeations for versioning and releasing actions](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md#recommendations).
+Refer to the [recommendations for versioning and releasing actions](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md#recommendations).
 
 ## New major release
 

__tests__/input-validator.test.ts

@@ -227,6 +227,27 @@ describe('disable-linux-hw-accel validator tests', () => {
   });
 });
 
+describe('enable-hw-keyboard validator tests', () => {
+  it('Throws if enable-hw-keyboard is not a boolean', () => {
+    const func = () => {
+      validator.checkEnableHardwareKeyboard('yes');
+    };
+    expect(func).toThrowError(`Input for input.enable-hw-keyboard should be either 'true' or 'false'.`);
+  });
+
+  it('Validates successfully if enable-hardware-keyboard is either true or false', () => {
+    const func1 = () => {
+      validator.checkEnableHardwareKeyboard('true');
+    };
+    expect(func1).not.toThrow();
+
+    const func2 = () => {
+      validator.checkEnableHardwareKeyboard('false');
+    };
+    expect(func2).not.toThrow();
+  });
+});
+
 describe('emulator-build validator tests', () => {
   it('Throws if emulator-build is not a number', () => {
     const func = () => {

action.yml

@@ -41,6 +41,9 @@ inputs:
   disable-linux-hw-accel:
     description: 'whether to disable hardware acceleration on Linux machines - `true` or `false`'
     default: 'true'
+  enable-hw-keyboard:
+    description: 'whether to enable hardware keyboard - `true` or `false`.'
+    default: 'false'
   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:

lib/emulator-manager.js

@@ -35,7 +35,7 @@ const EMULATOR_BOOT_TIMEOUT_SECONDS = 600;
 /**
  * Creates and launches a new AVD instance with the specified configurations.
  */
-function launchEmulator(apiLevel, target, arch, profile, cores, ramSize, sdcardPathOrSize, avdName, forceAvdCreation, emulatorOptions, disableAnimations, disableSpellChecker, disableLinuxHardwareAcceleration) {
+function launchEmulator(apiLevel, target, arch, profile, cores, ramSize, sdcardPathOrSize, avdName, forceAvdCreation, emulatorOptions, disableAnimations, disableSpellChecker, disableLinuxHardwareAcceleration, enableHardwareKeyboard) {
     return __awaiter(this, void 0, void 0, function* () {
         // create a new AVD if AVD directory does not already exist or forceAvdCreation is true
         const avdPath = `${process.env.ANDROID_AVD_HOME}/${avdName}.avd`;
@@ -51,6 +51,9 @@ function launchEmulator(apiLevel, target, arch, profile, cores, ramSize, sdcardP
         if (ramSize) {
             yield exec.exec(`sh -c \\"printf 'hw.ramSize=${ramSize}\n' >> ${process.env.ANDROID_AVD_HOME}/"${avdName}".avd"/config.ini`);
         }
+        if (enableHardwareKeyboard) {
+            yield exec.exec(`sh -c \\"printf 'hw.keyboard=yes\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.');
@@ -70,7 +73,6 @@ function launchEmulator(apiLevel, target, arch, profile, cores, ramSize, sdcardP
         // wait for emulator to complete booting
         yield waitForDevice();
         yield exec.exec(`adb shell input keyevent 82`);
-        // disable animations
         if (disableAnimations) {
             console.log('Disabling animations.');
             yield exec.exec(`adb shell settings put global window_animation_scale 0.0`);
@@ -80,11 +82,14 @@ function launchEmulator(apiLevel, target, arch, profile, cores, ramSize, sdcardP
         if (disableSpellChecker) {
             yield exec.exec(`adb shell settings put secure spell_checker_enabled 0`);
         }
+        if (enableHardwareKeyboard) {
+            yield exec.exec(`adb shell settings put secure show_ime_with_hard_keyboard 0`);
+        }
     });
 }
 exports.launchEmulator = launchEmulator;
 /**
- * Kills the running emulator on the defaut port.
+ * Kills the running emulator on the default port.
  */
 function killEmulator() {
     return __awaiter(this, void 0, void 0, function* () {
@@ -105,7 +110,7 @@ function waitForDevice() {
         let booted = false;
         let attempts = 0;
         const retryInterval = 2; // retry every 2 seconds
-        const maxAttemps = EMULATOR_BOOT_TIMEOUT_SECONDS / 2;
+        const maxAttempts = EMULATOR_BOOT_TIMEOUT_SECONDS / 2;
         while (!booted) {
             try {
                 let result = '';
@@ -125,7 +130,7 @@ function waitForDevice() {
             catch (error) {
                 console.warn(error.message);
             }
-            if (attempts < maxAttemps) {
+            if (attempts < maxAttempts) {
                 yield delay(retryInterval * 1000);
             }
             else {

lib/input-validator.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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.checkEmulatorBuild = exports.checkEnableHardwareKeyboard = 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', 'aosp_atd', 'google_atd', 'google_apis_playstore', 'android-wear', 'android-wear-cn', 'android-tv', 'google-tv'];
 exports.VALID_ARCHS = ['x86', 'x86_64', 'arm64-v8a'];
@@ -56,6 +56,12 @@ function checkDisableLinuxHardwareAcceleration(disableLinuxHardwareAcceleration)
     }
 }
 exports.checkDisableLinuxHardwareAcceleration = checkDisableLinuxHardwareAcceleration;
+function checkEnableHardwareKeyboard(enableHardwareKeyboard) {
+    if (!isValidBoolean(enableHardwareKeyboard)) {
+        throw new Error(`Input for input.enable-hw-keyboard should be either 'true' or 'false'.`);
+    }
+}
+exports.checkEnableHardwareKeyboard = checkEnableHardwareKeyboard;
 function checkEmulatorBuild(emulatorBuild) {
     if (isNaN(Number(emulatorBuild)) || !Number.isInteger(Number(emulatorBuild))) {
         throw new Error(`Unexpected emulator build: '${emulatorBuild}'.`);

lib/main.js

@@ -99,6 +99,11 @@ function run() {
             input_validator_1.checkDisableLinuxHardwareAcceleration(disableLinuxHardwareAccelerationInput);
             const disableLinuxHardwareAcceleration = disableLinuxHardwareAccelerationInput === 'true';
             console.log(`disable Linux hardware acceleration: ${disableLinuxHardwareAcceleration}`);
+            // enable hardware keyboard
+            const enableHardwareKeyboardInput = core.getInput('enable-hw-keyboard');
+            input_validator_1.checkEnableHardwareKeyboard(enableHardwareKeyboardInput);
+            const enableHardwareKeyboard = enableHardwareKeyboardInput === 'true';
+            console.log(`enable hardware keyboard: ${enableHardwareKeyboard}`);
             // emulator build
             const emulatorBuildInput = core.getInput('emulator-build');
             if (emulatorBuildInput) {
@@ -139,7 +144,7 @@ function run() {
             // install SDK
             yield sdk_installer_1.installAndroidSdk(apiLevel, target, arch, channelId, emulatorBuild, ndkVersion, cmakeVersion);
             // launch an emulator
-            yield emulator_manager_1.launchEmulator(apiLevel, target, arch, profile, cores, ramSize, sdcardPathOrSize, avdName, forceAvdCreation, emulatorOptions, disableAnimations, disableSpellchecker, disableLinuxHardwareAcceleration);
+            yield emulator_manager_1.launchEmulator(apiLevel, target, arch, profile, cores, ramSize, sdcardPathOrSize, avdName, forceAvdCreation, emulatorOptions, disableAnimations, disableSpellchecker, disableLinuxHardwareAcceleration, enableHardwareKeyboard);
             // execute the custom script
             try {
                 // move to custom working directory if set