Merge branch 'main' into release/v2

* main:
  Prepare for release 2.28.0.
  Cleanup action description.
  Update `test-fixture` dependencies and workflows (#332)
  SDK command-line tools 9.0. (#331)
  Add emulator-boot-timeout parameter (#326)
  Update dependency androidx.appcompat:appcompat to v1.6.1 (#322)
  Add renovate.json (#320)
  Support non-integer API level (#317)
  Replace deprecated `ANDROID_SDK_ROOT` with `ANDROID_HOME`.
  Update npm packages.
  Include ACRA in list of users (#295)
  Update readme with new info on hypervisors (#292)
  SDK command-line tools 8.0. (#291)

Author: ychescale9

.github/workflows/main.yml

@@ -61,11 +61,11 @@ jobs:
         npm run lint
         npm test
 
-    - name: Java 15
-      uses: actions/setup-java@v3
+    - uses: actions/setup-java@v3
       with:
         distribution: 'zulu'
-        java-version: 15
+        java-version: 19
+
     - uses: actions/cache@v3
       id: avd-cache
       with:

.github/workflows/manually.yml

@@ -51,17 +51,14 @@ jobs:
         npm run lint
         npm test
 
-    - name: Java 15
-      uses: actions/setup-java@v3
+    - uses: actions/setup-java@v3
       with:
         distribution: 'zulu'
-        java-version: 15
-    - uses: actions/cache@v3
+        java-version: 19
+
+    - uses: gradle/gradle-build-action@v2
       with:
-        path: |
-          ~/.gradle/caches
-          ~/.gradle/wrapper
-        key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}-${{ hashFiles('**/gradle/wrapper/gradle-wrapper.properties') }}
+        gradle-home-cache-cleanup: true
 
     - name: run action
       uses: ./

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## v2.28.0
+
+* Add `emulator-boot-timeout` to support configuring maximum time waiting for emulator boot. - [#326](https://github.com/ReactiveCircus/android-emulator-runner/pull/326)
+* Support non-integer `api-level`. - [#317](https://github.com/ReactiveCircus/android-emulator-runner/pull/317)
+* Replace deprecated `ANDROID_SDK_ROOT` with `ANDROID_HOME`. - [304](https://github.com/ReactiveCircus/android-emulator-runner/pull/304)
+* Update SDK command-line tools to `9.0`. - [#331](https://github.com/ReactiveCircus/android-emulator-runner/pull/331)
+* Update SDK build tools to `33.0.2`. - [#331](https://github.com/ReactiveCircus/android-emulator-runner/pull/331)
+
 ## v2.27.0
 
 * Added `pre-emulator-launch-script` to support running script after creating the AVD and before launching the emulator.  - [#247](https://github.com/ReactiveCircus/android-emulator-runner/pull/247) @nilsreichardt.

README.md

@@ -10,13 +10,11 @@ The old ARM-based emulators were slow and are no longer supported by Google. The
 
 This presents a challenge when running emulators on CI especially when running emulators within a docker container, because **Nested Virtualization** must be supported by the host VM which isn't the case for most cloud-based CI providers due to infrastructural limits.  If you want to learn more about Emulators on CI, here's an article [Yang](https://github.com/ychescale9) wrote: [Running Android Instrumented Tests on CI](https://dev.to/ychescale9/running-android-emulators-on-ci-from-bitrise-io-to-github-actions-3j76).
 
-## HAXM support on Github's MacOS Runners
+## A note on VM Acceleration and why we don't need HAXM anymore
 
-The 10.x **macOS** VM provided by **GitHub Actions** had **HAXM** [pre-installed](https://github.com/actions/runner-images/blob/main/images/macos/macos-10.15-Readme.md). However, Github's [macOS-11](https://github.com/actions/runner-images/blob/main/images/macos/macos-11-Readme.md) and [macOS-12](https://github.com/actions/runner-images/blob/main/images/macos/macos-12-Readme.md) VMs **no longer** come pre-installed with HAXM. See [here](https://github.com/actions/runner-images/issues/183#issuecomment-610723516) and [here](https://github.com/actions/runner-images/issues/6388) for more info. 
+According to [this documentation](https://developer.android.com/studio/run/emulator-acceleration#vm-mac), "on Mac OS X v10.10 Yosemite and higher, the Android Emulator uses the built-in [Hypervisor.Framework](https://developer.apple.com/documentation/hypervisor) by default, and falls back to using Intel HAXM if Hypervisor.Framework fails to initialize." This means that **HAXM is only needed to achieve VM Acceleration if this default Hypervisor is not available on macOS machines.**
 
-**To run with HAXM on the macOS-11 and macOS-12 agents, you must install HAXM before starting your emulator**. See: [this snippet](https://gist.github.com/mrk-han/a0a11ed9bed966bb8b775ff55f2a87e9) for more info. This will enable VM acceleration, but as of right now running with GPU acceleration, e.g. `emulator -gpu host` is not possible with Github's standard runners.
-
-For Linux, Nested virtualization is possible on a self-hosted or 3rd party runner, but the VM will need to be hosted on a compatible machine that allows you to [enable KVM](https://developer.android.com/studio/run/emulator-acceleration#vm-linux), or is already configured with - for example the AWS EC2 Bare Metal instances. **The Github-hosted Linux runners are not currently KVM compatible.**
+**Note**: Manually enabling and downloading HAXM is not recommended because it is redundant and not needed (see above), and for users of macOS 10.13 High Sierra and higher: macOS 10.13 [disables installation of kernel extensions by default](https://developer.apple.com/library/archive/technotes/tn2459/_index.html#//apple_ref/doc/uid/DTS40017658). Because Intel HAXM is a kernel extension, we would need to manually enable its installation on the base runner VM. Furthermore, manually trying to install HAXM on a Github Runner [brings up a popup](https://github.com/ReactiveCircus/android-emulator-runner/discussions/286#discussioncomment-4026120) which further hinders tests from running.
 
 ## Purpose
 
@@ -156,6 +154,7 @@ jobs:
 | `disk-size` | Optional | N/A | Disk size, or partition size to use for this AVD. Either in bytes or KB, MB or GB, when denoted with K, M or G. - e.g. `2048M` |
 | `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-boot-timeout` | Optional | `600` | Emulator boot timeout in seconds. If it takes longer to boot, the action would fail - e.g. `300` for 5 minutes. |
 | `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`. |
@@ -210,5 +209,6 @@ These are some of the open-source projects using (or used) **Android Emulator Ru
 - [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)
+- [ACRA/acra](https://github.com/ACRA/acra/blob/master/.github/workflows/test.yml)
 
 If you are using **Android Emulator Runner** and want your project included in the list, please feel free to open a pull request.

__tests__/input-validator.test.ts

@@ -32,6 +32,14 @@ describe('api-level validator tests', () => {
       validator.checkApiLevel('29');
     };
     expect(func2).not.toThrow();
+    const func3 = () => {
+      validator.checkApiLevel('UpsideDownCake-ext5');
+    };
+    expect(func3).not.toThrow();
+    const func4 = () => {
+      validator.checkApiLevel('TiramisuPrivacySandbox');
+    };
+    expect(func4).not.toThrow();
   });
 });
 

action-types.yml

@@ -35,6 +35,8 @@ inputs:
    type: string
   force-avd-creation:
    type: boolean
+  emulator-boot-timeout:
+   type: integer
   emulator-options:
    type: string
   disable-animations:

action.yml

@@ -33,6 +33,9 @@ inputs:
   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-boot-timeout:
+    description: 'Emulator boot timeout in seconds. If it takes longer to boot, the action would fail - e.g. `300` for 5 minutes'
+    default: '600'
   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'

lib/emulator-manager.js

@@ -35,11 +35,10 @@ 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, cores, ramSize, heapSize, sdcardPathOrSize, diskSize, avdName, forceAvdCreation, emulatorOptions, disableAnimations, disableSpellChecker, disableLinuxHardwareAcceleration, enableHardwareKeyboard) {
+function launchEmulator(apiLevel, target, arch, profile, cores, ramSize, heapSize, sdcardPathOrSize, diskSize, avdName, forceAvdCreation, emulatorBootTimeout, emulatorOptions, disableAnimations, disableSpellChecker, disableLinuxHardwareAcceleration, enableHardwareKeyboard) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
             console.log(`::group::Launch Emulator`);
@@ -73,7 +72,7 @@ function launchEmulator(apiLevel, target, arch, profile, cores, ramSize, heapSiz
             }
             // start emulator
             console.log('Starting emulator.');
-            yield exec.exec(`sh -c \\"${process.env.ANDROID_SDK_ROOT}/emulator/emulator -avd "${avdName}" ${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')) {
@@ -83,7 +82,7 @@ function launchEmulator(apiLevel, target, arch, profile, cores, ramSize, heapSiz
                 },
             });
             // wait for emulator to complete booting
-            yield waitForDevice();
+            yield waitForDevice(emulatorBootTimeout);
             yield exec.exec(`adb shell input keyevent 82`);
             if (disableAnimations) {
                 console.log('Disabling animations.');
@@ -125,12 +124,12 @@ exports.killEmulator = killEmulator;
 /**
  * Wait for emulator to boot.
  */
-function waitForDevice() {
+function waitForDevice(emulatorBootTimeout) {
     return __awaiter(this, void 0, void 0, function* () {
         let booted = false;
         let attempts = 0;
         const retryInterval = 2; // retry every 2 seconds
-        const maxAttempts = EMULATOR_BOOT_TIMEOUT_SECONDS / 2;
+        const maxAttempts = emulatorBootTimeout / 2;
         while (!booted) {
             try {
                 let result = '';

lib/input-validator.js

@@ -6,6 +6,8 @@ exports.VALID_TARGETS = ['default', 'google_apis', 'aosp_atd', 'google_atd', 'go
 exports.VALID_ARCHS = ['x86', 'x86_64', 'arm64-v8a'];
 exports.VALID_CHANNELS = ['stable', 'beta', 'dev', 'canary'];
 function checkApiLevel(apiLevel) {
+    if (apiLevel.startsWith('UpsideDownCake') || apiLevel === 'TiramisuPrivacySandbox')
+        return;
     if (isNaN(Number(apiLevel)) || !Number.isInteger(Number(apiLevel))) {
         throw new Error(`Unexpected API level: '${apiLevel}'.`);
     }

lib/main.js

@@ -61,9 +61,8 @@ function run() {
                 }
             }
             // API level of the platform and system image
-            const apiLevelInput = core.getInput('api-level', { required: true });
-            (0, input_validator_1.checkApiLevel)(apiLevelInput);
-            const apiLevel = Number(apiLevelInput);
+            const apiLevel = core.getInput('api-level', { required: true });
+            (0, input_validator_1.checkApiLevel)(apiLevel);
             console.log(`API level: ${apiLevel}`);
             // target of the system image
             const targetInput = core.getInput('target');
@@ -100,6 +99,9 @@ function run() {
             (0, input_validator_1.checkForceAvdCreation)(forceAvdCreationInput);
             const forceAvdCreation = forceAvdCreationInput === 'true';
             console.log(`force avd creation: ${forceAvdCreation}`);
+            // Emulator boot timeout seconds
+            const emulatorBootTimeout = parseInt(core.getInput('emulator-boot-timeout'), 10);
+            console.log(`Emulator boot timeout: ${emulatorBootTimeout}`);
             // emulator options
             const emulatorOptions = core.getInput('emulator-options').trim();
             console.log(`emulator options: ${emulatorOptions}`);
@@ -191,7 +193,7 @@ function run() {
                 console.log(`::endgroup::`);
             }
             // launch an emulator
-            yield (0, emulator_manager_1.launchEmulator)(apiLevel, target, arch, profile, cores, ramSize, heapSize, sdcardPathOrSize, diskSize, avdName, forceAvdCreation, emulatorOptions, disableAnimations, disableSpellchecker, disableLinuxHardwareAcceleration, enableHardwareKeyboard);
+            yield (0, emulator_manager_1.launchEmulator)(apiLevel, target, arch, profile, cores, ramSize, heapSize, sdcardPathOrSize, diskSize, avdName, forceAvdCreation, emulatorBootTimeout, emulatorOptions, disableAnimations, disableSpellchecker, disableLinuxHardwareAcceleration, enableHardwareKeyboard);
             // execute the custom script
             try {
                 // move to custom working directory if set

lib/sdk-installer.js

@@ -38,9 +38,10 @@ 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 = '33.0.0';
-const CMDLINE_TOOLS_URL_MAC = 'https://dl.google.com/android/repository/commandlinetools-mac-8512546_latest.zip';
-const CMDLINE_TOOLS_URL_LINUX = 'https://dl.google.com/android/repository/commandlinetools-linux-8512546_latest.zip';
+const BUILD_TOOLS_VERSION = '33.0.2';
+// SDK command-line tools 9.0
+const CMDLINE_TOOLS_URL_MAC = 'https://dl.google.com/android/repository/commandlinetools-mac-9477386_latest.zip';
+const CMDLINE_TOOLS_URL_LINUX = 'https://dl.google.com/android/repository/commandlinetools-linux-9477386_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.
@@ -51,9 +52,9 @@ function installAndroidSdk(apiLevel, target, arch, channelId, emulatorBuild, ndk
             console.log(`::group::Install Android SDK`);
             const isOnMac = process.platform === 'darwin';
             if (!isOnMac) {
-                yield exec.exec(`sh -c \\"sudo chown $USER:$USER ${process.env.ANDROID_SDK_ROOT} -R`);
+                yield exec.exec(`sh -c \\"sudo chown $USER:$USER ${process.env.ANDROID_HOME} -R`);
             }
-            const cmdlineToolsPath = `${process.env.ANDROID_SDK_ROOT}/cmdline-tools`;
+            const cmdlineToolsPath = `${process.env.ANDROID_HOME}/cmdline-tools`;
             if (!fs.existsSync(cmdlineToolsPath)) {
                 console.log('Installing new cmdline-tools.');
                 const sdkUrl = isOnMac ? CMDLINE_TOOLS_URL_MAC : CMDLINE_TOOLS_URL_LINUX;
@@ -62,21 +63,21 @@ function installAndroidSdk(apiLevel, target, arch, channelId, emulatorBuild, ndk
                 yield io.mv(`${cmdlineToolsPath}/cmdline-tools`, `${cmdlineToolsPath}/latest`);
             }
             // add paths for commandline-tools and platform-tools
-            core.addPath(`${cmdlineToolsPath}/latest:${cmdlineToolsPath}/latest/bin:${process.env.ANDROID_SDK_ROOT}/platform-tools`);
+            core.addPath(`${cmdlineToolsPath}/latest:${cmdlineToolsPath}/latest/bin:${process.env.ANDROID_HOME}/platform-tools`);
             // 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"`);
+            yield exec.exec(`sh -c \\"sdkmanager --install 'build-tools;${BUILD_TOOLS_VERSION}' platform-tools > /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}.`);
                 // 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 exec.exec(`unzip -o -q emulator.zip -d ${process.env.ANDROID_HOME}`);
                 yield io.rmRF('emulator.zip');
             }
             console.log('Installing system images.');

package-lock.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:base"
+  ]
+}