Merge branch 'main' into release/v2

* main:
  Prepare for release 2.36.0.
  Add F3D in the list of projects (#462)
  fix: remove problematic / unneeded `--abi` option in avd creation (#456)
  Replace deprecated `macos-13` runner with `macos-15-intel`. (#460)
  Add Compose Unstyled to the list of users (#457)

.github/workflows/main.yml

@@ -27,7 +27,7 @@ jobs:
             api-level: 24
             target: playstore
             arch: x86
-          - os: macos-13
+          - os: macos-15-intel
             api-level: 31
             target: default
             arch: x86_64
@@ -35,10 +35,15 @@ jobs:
             api-level: 34
             target: aosp_atd
             arch: x86_64
-          - os: ubuntu-lastest
+          - os: ubuntu-latest
             api-level: 35
             target: google_apis
             arch: x86_64
+          - os: ubuntu-latest
+            api-level: 34-ext10
+            target: android-automotive
+            arch: x86_64
+            system-image-api-level: 34-ext9
 
     steps:
     - name: checkout
@@ -85,6 +90,7 @@ jobs:
         api-level: ${{ matrix.api-level }}
         target: ${{ matrix.target }}
         arch: ${{ matrix.arch }}
+        system-image-api-level: ${{ matrix.system-image-api-level }}
         profile: Galaxy Nexus
         cores: 2
         sdcard-path-or-size: 100M
@@ -102,6 +108,7 @@ jobs:
         api-level: ${{ matrix.api-level }}
         target: ${{ matrix.target }}
         arch: ${{ matrix.arch }}
+        system-image-api-level: ${{ matrix.system-image-api-level }}
         profile: Galaxy Nexus
         cores: 2
         ram-size: 2048M

.github/workflows/manually.yml

@@ -7,11 +7,13 @@ on:
         required: true
         default: 'ubuntu-latest'
       api-level:
-        description: 'API level of the platform and system image'
+        description: 'API level of the platform and system image (if not overridden with system-image-api-level input) - e.g. 33, 35-ext15, Baklava'
         required: true
         default: '34'
+      system-image-api-level:
+        description: 'API level of the system image - e.g. 34-ext10, 35-ext15'
       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'
+        description: 'target of the system image - default, google_apis, google_apis_playstore, aosp_atd, google_atd, android-wear, android-wear-cn, android-tv, google-tv, android-automotive, android-automotive-playstore or android-desktop'
         required: true
         default: 'default'
       arch:
@@ -68,6 +70,7 @@ jobs:
         api-level: ${{ github.event.inputs.api-level }}
         target: ${{ github.event.inputs.target }}
         arch: ${{ github.event.inputs.arch }}
+        system-image-api-level: ${{ github.event.inputs.system-image-api-level }}
         profile: Galaxy Nexus
         emulator-options: ${{ github.event.inputs.emulator-options }}
         emulator-build: ${{ github.event.inputs.emulator-build }}

CHANGELOG.md

@@ -1,5 +1,24 @@
 # Change Log
 
+## Unreleased
+
+## v2.36.0
+
+* Remove `--abi` option to better support 16-KB-based system images (#456).
+
+
+## v2.35.0
+
+* Optimize config.ini updates and efficiency improvements report (#436).
+* Fix `pre-emulator-launch-script` (#439).
+* Allow `google_apis_ps16k` as a valid target (#440).
+
+## v2.34.0
+
+* Allow arbitrary value for `api-level` such as `Baklava` and `35-ext15`. - [428](https://github.com/ReactiveCircus/android-emulator-runner/pull/428)
+* Add option to specify `system-image-api-level` to use a system image with a different API level than the platform. - [428](https://github.com/ReactiveCircus/android-emulator-runner/pull/428)
+* Support automotive and desktop targets: `android-automotive`, `android-automotive-playstore`, `android-desktop`. - [428](https://github.com/ReactiveCircus/android-emulator-runner/pull/428)
+
 ## v2.33.0
 
 * Fix missing AVD directory in `ubuntu-24.04` runner. - [415](https://github.com/ReactiveCircus/android-emulator-runner/pull/415)

README.md

@@ -12,7 +12,7 @@ This presents a challenge when running emulators on CI especially when running e
 
 ## Running hardware accelerated emulators on Linux runners
 
-GitHub's [larger Linux runners support running hardware accelerated emulators](https://github.blog/changelog/2023-02-23-hardware-accelerated-android-virtualization-on-actions-windows-and-linux-larger-hosted-runners/) which is [free for public GitHub repos](https://github.blog/2024-01-17-github-hosted-runners-double-the-power-for-open-source/). It is now recommended to use the **Ubuntu** (`ubuntu-latest`) runners which are 2-3 times faster than the **macOS** ones which are also a lot more expensive. Remember to enable KVM in your workflow before running this action:
+GitHub's [larger Linux runners support running hardware accelerated emulators](https://github.blog/changelog/2023-02-23-hardware-accelerated-android-virtualization-on-actions-windows-and-linux-larger-hosted-runners/). It is now recommended to use the **Ubuntu** (`ubuntu-latest`) runners which are 2-3 times faster than the **macOS** ones which are also a lot more expensive. Remember to enable KVM in your workflow before running this action:
 
 ```
 - name: Enable KVM group perms
@@ -90,7 +90,7 @@ jobs:
           api-level: ${{ matrix.api-level }}
           target: ${{ matrix.target }}
           arch: x86_64
-          profile: Nexus 6
+          profile: pixel_7_pro
           script: ./gradlew connectedCheck
 ```
 
@@ -119,6 +119,31 @@ jobs:
           script: ./gradlew connectedCheck
 ```
 
+If you need a specific [SDK Extensions](https://developer.android.com/guide/sdk-extensions) for the system image but not the platform:
+
+```yml
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+
+      - name: Enable KVM
+        run: |
+          echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
+          sudo udevadm control --reload-rules
+          sudo udevadm trigger --name-match=kvm
+
+      - name: run tests
+        uses: reactivecircus/android-emulator-runner@v2
+        with:
+          api-level: 34
+          system-image-api-level: 34-ext9
+          target: android-automotive
+          script: ./gradlew connectedCheck
+```
+
 We can significantly reduce emulator startup time by setting up AVD snapshot caching:
 
 1. add a `gradle/actions/setup-gradle@v4` step for caching Gradle, more details see [#229](https://github.com/ReactiveCircus/android-emulator-runner/issues/229)
@@ -179,10 +204,11 @@ 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**. |
+| `api-level` | Required | N/A | API level of the platform and system image - e.g. `23`, `33`, `35-ext15`, `Baklava`. **Minimum API level supported is 15**. |
-| `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`. |
+| `system-image-api-level` | Optional | same as `api-level` | API level of the system image - e.g. `34-ext10`, `35-ext15`. |
+| `target` | Optional | `default` | Target of the system image - e.g. `default`, `google_apis`, `google_apis_ps16k`, `google_apis_playstore`, `google_apis_playstore_ps16k`, `android-wear`, `android-wear-cn`, `android-tv`, `google-tv`, `aosp_atd`, `google_atd`, `android-automotive`, `android-automotive-playstore`, `android-desktop`. Please run `sdkmanager --list` to see the available targets. |
 | `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 device`. |
+| `profile` | Optional | N/A | Hardware profile id used for creating the AVD - e.g. `pixel_7_pro`. 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` |
 | `heap-size` | Optional | N/A | Heap size to use for this AVD, in KB or MB, denoted with K or M. - e.g. `512M` |
@@ -243,5 +269,8 @@ These are some of the open-source projects using (or used) **Android Emulator Ru
 - [ACRA/acra](https://github.com/ACRA/acra/blob/master/.github/workflows/test.yml)
 - [bitfireAT/davx5-ose](https://github.com/bitfireAT/davx5-ose/blob/dev-ose/.github/workflows/test-dev.yml)
 - [robolectric/robolectric](https://github.com/robolectric/robolectric/blob/master/.github/workflows/tests.yml)
+- [home-assistant/android](https://github.com/home-assistant/android/blob/master/.github/workflows/pr.yml)
+- [composablehorizons/compose-unstyled](https://github.com/composablehorizons/compose-unstyled/tree/main/.github/workflows)
+- [f3d-app/f3d-android](https://github.com/f3d-app/f3d-android/blob/master/.github/workflows/ci.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

@@ -1,105 +1,6 @@
 import * as validator from '../src/input-validator';
 import { MAX_PORT, MIN_PORT } from '../src/input-validator';
 
-describe('api-level validator tests', () => {
-  it('Throws if api-level is not a number', () => {
-    const func = () => {
-      validator.checkApiLevel('api');
-    };
-    expect(func).toThrowError(`Unexpected API level: 'api'.`);
-  });
-
-  it('Throws if api-level is not an integer', () => {
-    const func = () => {
-      validator.checkApiLevel('29.1');
-    };
-    expect(func).toThrowError(`Unexpected API level: '29.1'.`);
-  });
-
-  it('Throws if api-level is lower than min API supported', () => {
-    const func = () => {
-      validator.checkApiLevel('14');
-    };
-    expect(func).toThrowError(`Minimum API level supported is ${validator.MIN_API_LEVEL}.`);
-  });
-
-  it('Validates successfully with valid api-level', () => {
-    const func1 = () => {
-      validator.checkApiLevel('15');
-    };
-    expect(func1).not.toThrow();
-
-    const func2 = () => {
-      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();
-  });
-});
-
-describe('target validator tests', () => {
-  it('Throws if target is unknown', () => {
-    const func = () => {
-      validator.checkTarget('some-target');
-    };
-    expect(func).toThrowError(`Value for input.target 'some-target' is unknown. Supported options: ${validator.VALID_TARGETS}`);
-  });
-
-  it('Validates successfully with valid target', () => {
-    const func1 = () => {
-      validator.checkTarget('default');
-    };
-    expect(func1).not.toThrow();
-
-    const func2 = () => {
-      validator.checkTarget('google_apis');
-    };
-    expect(func2).not.toThrow();
-
-    const func3 = () => {
-      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();
-  });
-});
-
 describe('arch validator tests', () => {
   it('Throws if arch is unknown', () => {
     const func = () => {

action-types.yml

@@ -1,6 +1,8 @@
 inputs:
   api-level:
-    type: integer
+    type: string
+  system-image-api-level:
+    type: string
   target:
     type: enum
     allowed-values:
@@ -13,6 +15,9 @@ inputs:
       - android-wear-cn
       - android-tv
       - google-tv
+      - android-automotive
+      - android-automotive-playstore
+      - android-desktop
   arch:
     type: enum
     allowed-values:

action.yml

@@ -6,10 +6,13 @@ branding:
   color: 'green'
 inputs:
   api-level:
-    description: 'API level of the platform and system image - e.g. 23 for Android Marshmallow, 29 for Android 10'
+    description: 'API level of the platform and system image - e.g. 23, 33, 35-ext15, Baklava'
     required: true
+  system-image-api-level:
+    description: 'API level of the system image - e.g. 34-ext10, 35-ext15. If not set the `api-level` input will be used.'
+    required: false
   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'
+    description: 'target of the system image - e.g. default, google_apis, google_apis_ps16k, google_apis_playstore, google_apis_playstore_16k, aosp_atd, google_atd, android-wear, android-wear-cn, android-tv, google-tv, android-automotive, android-automotive-playstore or android-desktop'
     default: 'default'
   arch:
     description: 'CPU architecture of the system image - x86, x86_64 or arm64-v8a'

lib/emulator-manager.js

@@ -32,39 +32,60 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.killEmulator = exports.launchEmulator = void 0;
+exports.killEmulator = exports.launchEmulator = exports.createAvd = void 0;
 const exec = __importStar(require("@actions/exec"));
 const fs = __importStar(require("fs"));
 /**
- * Creates and launches a new AVD instance with the specified configurations.
+ * Creates a new AVD instance with the specified configurations.
  */
-function launchEmulator(apiLevel, target, arch, profile, cores, ramSize, heapSize, sdcardPathOrSize, diskSize, avdName, forceAvdCreation, emulatorBootTimeout, port, emulatorOptions, disableAnimations, disableSpellChecker, disableLinuxHardwareAcceleration, enableHardwareKeyboard) {
+function createAvd(arch, avdName, cores, diskSize, enableHardwareKeyboard, forceAvdCreation, heapSize, profile, ramSize, sdcardPathOrSize, systemImageApiLevel, target) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
-            console.log(`::group::Launch Emulator`);
+            console.log(`::group::Create AVD`);
             // 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}"`);
+                yield exec.exec(`sh -c \\"echo no | avdmanager create avd --force -n "${avdName}" --package 'system-images;android-${systemImageApiLevel};${target};${arch}' ${profileOption} ${sdcardPathOrSizeOption}"`);
             }
-            if (cores) {
+            if (cores || ramSize || heapSize || enableHardwareKeyboard || diskSize) {
-                yield exec.exec(`sh -c \\"printf 'hw.cpu.ncore=${cores}\n' >> ${process.env.ANDROID_AVD_HOME}/"${avdName}".avd"/config.ini`);
+                const configEntries = [];
-            }
+                if (cores) {
-            if (ramSize) {
+                    configEntries.push(`hw.cpu.ncore=${cores}`);
-                yield exec.exec(`sh -c \\"printf 'hw.ramSize=${ramSize}\n' >> ${process.env.ANDROID_AVD_HOME}/"${avdName}".avd"/config.ini`);
+                }
-            }
+                if (ramSize) {
-            if (heapSize) {
+                    configEntries.push(`hw.ramSize=${ramSize}`);
-                yield exec.exec(`sh -c \\"printf 'hw.heapSize=${heapSize}\n' >> ${process.env.ANDROID_AVD_HOME}/"${avdName}".avd"/config.ini`);
+                }
-            }
+                if (heapSize) {
-            if (enableHardwareKeyboard) {
+                    configEntries.push(`hw.heapSize=${heapSize}`);
-                yield exec.exec(`sh -c \\"printf 'hw.keyboard=yes\n' >> ${process.env.ANDROID_AVD_HOME}/"${avdName}".avd"/config.ini`);
+                }
-            }
+                if (enableHardwareKeyboard) {
-            if (diskSize) {
+                    configEntries.push('hw.keyboard=yes');
-                yield exec.exec(`sh -c \\"printf 'disk.dataPartition.size=${diskSize}\n' >> ${process.env.ANDROID_AVD_HOME}/"${avdName}".avd"/config.ini`);
+                }
+                if (diskSize) {
+                    configEntries.push(`disk.dataPartition.size=${diskSize}`);
+                }
+                if (configEntries.length > 0) {
+                    const configContent = configEntries.join('\\n') + '\\n';
+                    yield exec.exec(`sh -c \\"printf '${configContent}' >> ${process.env.ANDROID_AVD_HOME}/"${avdName}".avd"/config.ini"`);
+                }
             }
+        }
+        finally {
+            console.log(`::endgroup::`);
+        }
+    });
+}
+exports.createAvd = createAvd;
+/**
+ * Launches an existing AVD instance with the specified configurations.
+ */
+function launchEmulator(avdName, disableAnimations, disableLinuxHardwareAcceleration, disableSpellChecker, emulatorBootTimeout, emulatorOptions, enableHardwareKeyboard, port) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            console.log(`::group::Launch Emulator`);
             // turn off hardware acceleration on Linux
             if (process.platform === 'linux' && disableLinuxHardwareAcceleration) {
                 console.log('Disabling Linux hardware acceleration.');

lib/input-validator.js

@@ -1,30 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkDiskSize = exports.checkEmulatorBuild = exports.checkEnableHardwareKeyboard = exports.checkDisableLinuxHardwareAcceleration = exports.checkDisableSpellchecker = exports.checkDisableAnimations = exports.checkPort = exports.checkForceAvdCreation = exports.checkChannel = exports.checkArch = exports.checkTarget = exports.checkApiLevel = exports.PREVIEW_API_LEVELS = exports.MAX_PORT = exports.MIN_PORT = exports.VALID_CHANNELS = exports.VALID_ARCHS = exports.VALID_TARGETS = exports.MIN_API_LEVEL = void 0;
+exports.checkDiskSize = exports.checkEmulatorBuild = exports.checkEnableHardwareKeyboard = exports.checkDisableLinuxHardwareAcceleration = exports.checkDisableSpellchecker = exports.checkDisableAnimations = exports.checkPort = exports.checkForceAvdCreation = exports.checkChannel = exports.checkArch = exports.playstoreTargetSubstitution = exports.MAX_PORT = exports.MIN_PORT = exports.VALID_CHANNELS = exports.VALID_ARCHS = 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'];
 exports.VALID_CHANNELS = ['stable', 'beta', 'dev', 'canary'];
 exports.MIN_PORT = 5554;
 exports.MAX_PORT = 5584;
-exports.PREVIEW_API_LEVELS = ['Tiramisu', 'UpsideDownCake', 'VanillaIceCream'];
+function playstoreTargetSubstitution(target) {
-function checkApiLevel(apiLevel) {
+    // "playstore" is an allowed shorthand for "google_apis_playstore" images
-    if (exports.PREVIEW_API_LEVELS.some((previewLevel) => apiLevel.startsWith(previewLevel)))
+    // this is idempotent - return same even if run multiple times on same target
-        return;
+    if (target === 'playstore')
-    if (isNaN(Number(apiLevel)) || !Number.isInteger(Number(apiLevel))) {
+        return 'google_apis_playstore';
-        throw new Error(`Unexpected API level: '${apiLevel}'.`);
+    if (target === 'playstore_ps16k')
-    }
+        return 'google_apis_playstore_ps16k';
-    if (Number(apiLevel) < exports.MIN_API_LEVEL) {
+    return target;
-        throw new Error(`Minimum API level supported is ${exports.MIN_API_LEVEL}.`);
-    }
 }
-exports.checkApiLevel = checkApiLevel;
+exports.playstoreTargetSubstitution = playstoreTargetSubstitution;
-function checkTarget(target) {
-    if (!exports.VALID_TARGETS.includes(target)) {
-        throw new Error(`Value for input.target '${target}' is unknown. Supported options: ${exports.VALID_TARGETS}.`);
-    }
-}
-exports.checkTarget = checkTarget;
 function checkArch(arch) {
     if (!exports.VALID_ARCHS.includes(arch)) {
         throw new Error(`Value for input.arch '${arch}' is unknown. Supported options: ${exports.VALID_ARCHS}.`);

lib/main.js

@@ -63,12 +63,14 @@ function run() {
             }
             // API level of the platform and system image
             const apiLevel = core.getInput('api-level', { required: true });
-            (0, input_validator_1.checkApiLevel)(apiLevel);
             console.log(`API level: ${apiLevel}`);
+            let systemImageApiLevel = core.getInput('system-image-api-level');
+            if (!systemImageApiLevel) {
+                systemImageApiLevel = apiLevel;
+            }
+            console.log(`System image API level: ${systemImageApiLevel}`);
             // target of the system image
-            const targetInput = core.getInput('target');
+            const target = (0, input_validator_1.playstoreTargetSubstitution)(core.getInput('target'));
-            const target = targetInput == 'playstore' ? 'google_apis_playstore' : targetInput;
-            (0, input_validator_1.checkTarget)(target);
             console.log(`target: ${target}`);
             // CPU architecture of the system image
             const arch = core.getInput('arch');
@@ -179,7 +181,9 @@ function run() {
             }));
             console.log(`::endgroup::`);
             // install SDK
-            yield (0, sdk_installer_1.installAndroidSdk)(apiLevel, target, arch, channelId, emulatorBuild, ndkVersion, cmakeVersion);
+            yield (0, sdk_installer_1.installAndroidSdk)(apiLevel, systemImageApiLevel, target, arch, channelId, emulatorBuild, ndkVersion, cmakeVersion);
+            // create AVD
+            yield (0, emulator_manager_1.createAvd)(arch, avdName, cores, diskSize, enableHardwareKeyboard, forceAvdCreation, heapSize, profile, ramSize, sdcardPathOrSize, systemImageApiLevel, target);
             // execute pre emulator launch script if set
             if (preEmulatorLaunchScripts !== undefined) {
                 console.log(`::group::Run pre emulator launch script`);
@@ -198,7 +202,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, emulatorBootTimeout, port, emulatorOptions, disableAnimations, disableSpellchecker, disableLinuxHardwareAcceleration, enableHardwareKeyboard);
+            yield (0, emulator_manager_1.launchEmulator)(avdName, disableAnimations, disableLinuxHardwareAcceleration, disableSpellchecker, emulatorBootTimeout, emulatorOptions, enableHardwareKeyboard, port);
             // execute the custom script
             try {
                 // move to custom working directory if set

lib/sdk-installer.js

@@ -46,7 +46,7 @@ const CMDLINE_TOOLS_URL_LINUX = 'https://dl.google.com/android/repository/comman
  * 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, channelId, emulatorBuild, ndkVersion, cmakeVersion) {
+function installAndroidSdk(apiLevel, systemImageApiLevel, target, arch, channelId, emulatorBuild, ndkVersion, cmakeVersion) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
             console.log(`::group::Install Android SDK`);
@@ -95,7 +95,7 @@ function installAndroidSdk(apiLevel, target, arch, channelId, emulatorBuild, ndk
                 yield io.rmRF('emulator.zip');
             }
             console.log('Installing system images.');
-            yield exec.exec(`sh -c \\"sdkmanager --install 'system-images;android-${apiLevel};${target};${arch}' --channel=${channelId} > /dev/null"`);
+            yield exec.exec(`sh -c \\"sdkmanager --install 'system-images;android-${systemImageApiLevel};${target};${arch}' --channel=${channelId} > /dev/null"`);
             if (ndkVersion) {
                 console.log(`Installing NDK ${ndkVersion}.`);
                 yield exec.exec(`sh -c \\"sdkmanager --install 'ndk;${ndkVersion}' --channel=${channelId} > /dev/null"`);

src/emulator-manager.ts

@@ -2,30 +2,24 @@ import * as exec from '@actions/exec';
 import * as fs from 'fs';
 
 /**
- * Creates and launches a new AVD instance with the specified configurations.
+ * Creates a new AVD instance with the specified configurations.
  */
-export async function launchEmulator(
+export async function createAvd(
-  apiLevel: string,
-  target: string,
   arch: string,
-  profile: string,
-  cores: string,
-  ramSize: string,
-  heapSize: string,
-  sdcardPathOrSize: string,
-  diskSize: string,
   avdName: string,
+  cores: string,
+  diskSize: string,
+  enableHardwareKeyboard: boolean,
   forceAvdCreation: boolean,
-  emulatorBootTimeout: number,
+  heapSize: string,
-  port: number,
+  profile: string,
-  emulatorOptions: string,
+  ramSize: string,
-  disableAnimations: boolean,
+  sdcardPathOrSize: string,
-  disableSpellChecker: boolean,
+  systemImageApiLevel: string,
-  disableLinuxHardwareAcceleration: boolean,
+  target: string
-  enableHardwareKeyboard: boolean
 ): Promise<void> {
   try {
-    console.log(`::group::Launch Emulator`);
+    console.log(`::group::Create AVD`);
     // 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) {
@@ -33,29 +27,54 @@ export async function launchEmulator(
       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}"`
+        `sh -c \\"echo no | avdmanager create avd --force -n "${avdName}" --package 'system-images;android-${systemImageApiLevel};${target};${arch}' ${profileOption} ${sdcardPathOrSizeOption}"`
       );
     }
 
-    if (cores) {
+    if (cores || ramSize || heapSize || enableHardwareKeyboard || diskSize) {
-      await exec.exec(`sh -c \\"printf 'hw.cpu.ncore=${cores}\n' >> ${process.env.ANDROID_AVD_HOME}/"${avdName}".avd"/config.ini`);
+      const configEntries: string[] = [];
-    }
 
-    if (ramSize) {
+      if (cores) {
-      await exec.exec(`sh -c \\"printf 'hw.ramSize=${ramSize}\n' >> ${process.env.ANDROID_AVD_HOME}/"${avdName}".avd"/config.ini`);
+        configEntries.push(`hw.cpu.ncore=${cores}`);
-    }
+      }
+      if (ramSize) {
+        configEntries.push(`hw.ramSize=${ramSize}`);
+      }
+      if (heapSize) {
+        configEntries.push(`hw.heapSize=${heapSize}`);
+      }
+      if (enableHardwareKeyboard) {
+        configEntries.push('hw.keyboard=yes');
+      }
+      if (diskSize) {
+        configEntries.push(`disk.dataPartition.size=${diskSize}`);
+      }
 
-    if (heapSize) {
+      if (configEntries.length > 0) {
-      await exec.exec(`sh -c \\"printf 'hw.heapSize=${heapSize}\n' >> ${process.env.ANDROID_AVD_HOME}/"${avdName}".avd"/config.ini`);
+        const configContent = configEntries.join('\\n') + '\\n';
+        await exec.exec(`sh -c \\"printf '${configContent}' >> ${process.env.ANDROID_AVD_HOME}/"${avdName}".avd"/config.ini"`);
+      }
     }
+  } finally {
+    console.log(`::endgroup::`);
+  }
+}
 
-    if (enableHardwareKeyboard) {
+/**
-      await exec.exec(`sh -c \\"printf 'hw.keyboard=yes\n' >> ${process.env.ANDROID_AVD_HOME}/"${avdName}".avd"/config.ini`);
+ * Launches an existing AVD instance with the specified configurations.
-    }
+ */
-
+export async function launchEmulator(
-    if (diskSize) {
+  avdName: string,
-      await exec.exec(`sh -c \\"printf 'disk.dataPartition.size=${diskSize}\n' >> ${process.env.ANDROID_AVD_HOME}/"${avdName}".avd"/config.ini`);
+  disableAnimations: boolean,
-    }
+  disableLinuxHardwareAcceleration: boolean,
+  disableSpellChecker: boolean,
+  emulatorBootTimeout: number,
+  emulatorOptions: string,
+  enableHardwareKeyboard: boolean,
+  port: number
+): Promise<void> {
+  try {
+    console.log(`::group::Launch Emulator`);
 
     // turn off hardware acceleration on Linux
     if (process.platform === 'linux' && disableLinuxHardwareAcceleration) {

src/input-validator.ts

@@ -1,25 +1,15 @@
 export const MIN_API_LEVEL = 15;
-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 const MIN_PORT = 5554;
 export const MAX_PORT = 5584;
-export const PREVIEW_API_LEVELS: Array<string> = ['Tiramisu', 'UpsideDownCake', 'VanillaIceCream'];
 
-export function checkApiLevel(apiLevel: string): void {
+export function playstoreTargetSubstitution(target: string): string {
-  if (PREVIEW_API_LEVELS.some((previewLevel) => apiLevel.startsWith(previewLevel))) return;
+  // "playstore" is an allowed shorthand for "google_apis_playstore" images
-  if (isNaN(Number(apiLevel)) || !Number.isInteger(Number(apiLevel))) {
+  // this is idempotent - return same even if run multiple times on same target
-    throw new Error(`Unexpected API level: '${apiLevel}'.`);
+  if (target === 'playstore') return 'google_apis_playstore';
-  }
+  if (target === 'playstore_ps16k') return 'google_apis_playstore_ps16k';
-  if (Number(apiLevel) < MIN_API_LEVEL) {
+  return target;
-    throw new Error(`Minimum API level supported is ${MIN_API_LEVEL}.`);
-  }
-}
-
-export function checkTarget(target: string): void {
-  if (!VALID_TARGETS.includes(target)) {
-    throw new Error(`Value for input.target '${target}' is unknown. Supported options: ${VALID_TARGETS}.`);
-  }
 }
 
 export function checkArch(arch: string): void {

src/main.ts

@@ -1,8 +1,6 @@
 import * as core from '@actions/core';
 import { installAndroidSdk } from './sdk-installer';
 import {
-  checkApiLevel,
-  checkTarget,
   checkArch,
   checkDisableAnimations,
   checkEmulatorBuild,
@@ -13,9 +11,10 @@ import {
   checkEnableHardwareKeyboard,
   checkDiskSize,
   checkPort,
+  playstoreTargetSubstitution,
   MIN_PORT,
 } from './input-validator';
-import { launchEmulator, killEmulator } from './emulator-manager';
+import { createAvd, launchEmulator, killEmulator } from './emulator-manager';
 import * as exec from '@actions/exec';
 import { parseScript } from './script-parser';
 import { getChannelId } from './channel-id-mapper';
@@ -44,13 +43,16 @@ async function run() {
 
     // API level of the platform and system image
     const apiLevel = core.getInput('api-level', { required: true });
-    checkApiLevel(apiLevel);
     console.log(`API level: ${apiLevel}`);
 
+    let systemImageApiLevel = core.getInput('system-image-api-level');
+    if (!systemImageApiLevel) {
+      systemImageApiLevel = apiLevel;
+    }
+    console.log(`System image API level: ${systemImageApiLevel}`);
+
     // target of the system image
-    const targetInput = core.getInput('target');
+    const target = playstoreTargetSubstitution(core.getInput('target'));
-    const target = targetInput == 'playstore' ? 'google_apis_playstore' : targetInput;
-    checkTarget(target);
     console.log(`target: ${target}`);
 
     // CPU architecture of the system image
@@ -185,7 +187,10 @@ async function run() {
     console.log(`::endgroup::`);
 
     // install SDK
-    await installAndroidSdk(apiLevel, target, arch, channelId, emulatorBuild, ndkVersion, cmakeVersion);
+    await installAndroidSdk(apiLevel, systemImageApiLevel, target, arch, channelId, emulatorBuild, ndkVersion, cmakeVersion);
+
+    // create AVD
+    await createAvd(arch, avdName, cores, diskSize, enableHardwareKeyboard, forceAvdCreation, heapSize, profile, ramSize, sdcardPathOrSize, systemImageApiLevel, target);
 
     // execute pre emulator launch script if set
     if (preEmulatorLaunchScripts !== undefined) {
@@ -205,26 +210,7 @@ async function run() {
     }
 
     // launch an emulator
-    await launchEmulator(
+    await launchEmulator(avdName, disableAnimations, disableLinuxHardwareAcceleration, disableSpellchecker, emulatorBootTimeout, emulatorOptions, enableHardwareKeyboard, port);
-      apiLevel,
-      target,
-      arch,
-      profile,
-      cores,
-      ramSize,
-      heapSize,
-      sdcardPathOrSize,
-      diskSize,
-      avdName,
-      forceAvdCreation,
-      emulatorBootTimeout,
-      port,
-      emulatorOptions,
-      disableAnimations,
-      disableSpellchecker,
-      disableLinuxHardwareAcceleration,
-      enableHardwareKeyboard
-    );
 
     // execute the custom script
     try {

src/sdk-installer.ts

@@ -13,7 +13,16 @@ const CMDLINE_TOOLS_URL_LINUX = 'https://dl.google.com/android/repository/comman
  * 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: string, target: string, arch: string, channelId: number, emulatorBuild?: string, ndkVersion?: string, cmakeVersion?: string): Promise<void> {
+export async function installAndroidSdk(
+  apiLevel: string,
+  systemImageApiLevel: String,
+  target: string,
+  arch: string,
+  channelId: number,
+  emulatorBuild?: string,
+  ndkVersion?: string,
+  cmakeVersion?: string
+): Promise<void> {
   try {
     console.log(`::group::Install Android SDK`);
     const isOnMac = process.platform === 'darwin';
@@ -66,7 +75,7 @@ export async function installAndroidSdk(apiLevel: string, target: string, arch:
       await io.rmRF('emulator.zip');
     }
     console.log('Installing system images.');
-    await exec.exec(`sh -c \\"sdkmanager --install 'system-images;android-${apiLevel};${target};${arch}' --channel=${channelId} > /dev/null"`);
+    await exec.exec(`sh -c \\"sdkmanager --install 'system-images;android-${systemImageApiLevel};${target};${arch}' --channel=${channelId} > /dev/null"`);
 
     if (ndkVersion) {
       console.log(`Installing NDK ${ndkVersion}.`);