Merge branch 'main' into release/v2

* main:
  Prepare for release 2.15.0.
  Change default cores to 2, add cores in workflow
  Add option to modify the number of cores

.github/workflows/workflow.yml

@@ -30,12 +30,15 @@ jobs:
           - target: google_apis
             api-level: 29
         include:
-          - os: macos-latest
+          - os: macos-11.0
             api-level: 30
             target: google_apis
           - os: macos-latest
             api-level: 24
             target: playstore
+          - os: macos-latest
+            api-level: 28
+            target: google_apis
 
     steps:
     - name: checkout
@@ -68,6 +71,7 @@ jobs:
         target: ${{ matrix.target }}
         arch: x86
         profile: Nexus 6
+        cores: 2
         sdcard-path-or-size: 100M
         avd-name: test
         emulator-options: -no-window -gpu swiftshader_indirect -no-snapshot -noaudio -no-boot-anim -camera-back none

CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change Log
 
+## 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).
+
+## v2.14.2
+
+* Support API 28 system images with `google_apis` or `google_apis_playstore` target - [#117](https://github.com/ReactiveCircus/android-emulator-runner/pull/117).
+
+## v2.14.1
+
+* Fix hang during AVD creation when `profile` is not specified - [#113](https://github.com/ReactiveCircus/android-emulator-runner/issues/113).
+
 ## v2.14.0
 
 * Support specifying SD card path or size via `sdcard-path-or-size`.

README.md

@@ -92,6 +92,7 @@ jobs:
 | `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+. |
 | `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). |
 | `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. |
 | `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`. |
@@ -115,24 +116,27 @@ For a longer answer please refer to [this issue](https://github.com/ReactiveCirc
 
 These are some of the open-source projects using (or used) **Android Emulator Runner**:
 
-- [coil-kt/coil](https://github.com/coil-kt/coil/blob/master/.github/workflows/)
-- [cashapp/sqldelight](https://github.com/cashapp/sqldelight/blob/master/.github/workflows/)
-- [square/workflow](https://github.com/square/workflow/blob/main/.github/workflows/)
-- [square/retrofit](https://github.com/square/retrofit/blob/master/.github/workflows/)
+- [coil-kt/coil](https://github.com/coil-kt/coil/blob/master/.github/workflows)
+- [cashapp/sqldelight](https://github.com/cashapp/sqldelight/blob/master/.github/workflows)
+- [square/workflow-kotlin](https://github.com/square/workflow-kotlin/tree/main/.github/workflows)
+- [square/retrofit](https://github.com/square/retrofit/blob/master/.github/workflows)
 - [natario1/CameraView](https://github.com/natario1/CameraView/tree/master/.github/workflows)
 - [natario1/Transcoder](https://github.com/natario1/Transcoder/tree/master/.github/workflows)
 - [chrisbanes/insetter](https://github.com/chrisbanes/insetter/tree/main/.github/workflows)
 - [slackhq/keeper](https://github.com/slackhq/keeper/tree/main/.github/workflows)
 - [android/compose-samples](https://github.com/android/compose-samples/tree/main/.github/workflows)
 - [ReactiveCircus/streamlined](https://github.com/ReactiveCircus/streamlined/tree/main/.github/workflows)
-- [ReactiveCircus/FlowBinding](https://github.com/ReactiveCircus/FlowBinding)
+- [ReactiveCircus/FlowBinding](https://github.com/ReactiveCircus/FlowBinding/tree/main/.github/workflows)
 - [JakeWharton/RxBinding](https://github.com/JakeWharton/RxBinding/tree/master/.github/workflows)
-- [vinaygaba/Learn-Jetpack-Compose-By-Example](https://github.com/vinaygaba/Learn-Jetpack-Compose-By-Example/)
+- [vinaygaba/Learn-Jetpack-Compose-By-Example](https://github.com/vinaygaba/Learn-Jetpack-Compose-By-Example/tree/master/.github/workflows)
 - [ashishb/adb-enhanced](https://github.com/ashishb/adb-enhanced/tree/master/.github/workflows)
 - [vgaidarji/ci-matters](https://github.com/vgaidarji/ci-matters/blob/master/.github/workflows/main.yaml)
-- [simpledotorg/simple-android](https://github.com/simpledotorg/simple-android)
+- [simpledotorg/simple-android](https://github.com/simpledotorg/simple-android/tree/master/.github/workflows)
 - [cashapp/copper](https://github.com/cashapp/copper/blob/trunk/.github/workflows/build.yaml)
 - [square/radiography](https://github.com/square/radiography/blob/main/.github/workflows/android.yml)
 - [Shopify/android-testify](https://github.com/Shopify/android-testify/blob/master/.github/workflows/sample_build.yml)
+- [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)
 
 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.

action.yml

@@ -16,6 +16,9 @@ inputs:
     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
   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:

lib/emulator-manager.js

@@ -34,13 +34,16 @@ 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, sdcardPathOrSize, avdName, emulatorOptions, disableAnimations) {
     return __awaiter(this, void 0, void 0, function* () {
         // create a new AVD
-        const profileOption = profile.trim() !== '' ? `--device "${profile}"` : '';
-        const sdcardPathOrSizeOption = sdcardPathOrSize.trim() !== '' ? `--sdcard "${sdcardPathOrSize}"` : '';
+        const profileOption = profile.trim() !== '' ? `--device '${profile}'` : '';
+        const sdcardPathOrSizeOption = sdcardPathOrSize.trim() !== '' ? `--sdcard '${sdcardPathOrSize}'` : '';
         console.log(`Creating AVD.`);
-        yield exec.exec(`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}" --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' >> ~/.android/avd/"${avdName}".avd"/config.ini`);
+        }
         // start emulator
         console.log('Starting emulator.');
         // turn off hardware acceleration on Linux

lib/main.js

@@ -63,6 +63,9 @@ 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}`);
             // 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}`);
@@ -112,7 +115,7 @@ function run() {
             // install SDK
             yield sdk_installer_1.installAndroidSdk(apiLevel, target, arch, 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, sdcardPathOrSize, avdName, emulatorOptions, disableAnimations);
             // execute the custom script
             try {
                 // move to custom working directory if set

lib/sdk-installer.js

@@ -54,17 +54,17 @@ function installAndroidSdk(apiLevel, target, arch, emulatorBuild, ndkVersion, cm
             const downloadPath = yield tc.downloadTool(sdkUrl);
             yield tc.extractZip(downloadPath, cmdlineToolsPath);
             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`);
         }
+        // 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 system images
+        // 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 (apiLevel == 30 && !fs.existsSync(sdkArmDbtLicensePath)) {
+        if (requiresArmDbtLicense(apiLevel, target) && !fs.existsSync(sdkArmDbtLicensePath)) {
             fs.writeFileSync(sdkArmDbtLicensePath, '\n859f317696f67ef3d7f30a50a5560e7834b43903');
         }
         console.log('Installing latest build tools, platform tools, and platform.');
@@ -93,3 +93,6 @@ function installAndroidSdk(apiLevel, target, arch, emulatorBuild, ndkVersion, cm
     });
 }
 exports.installAndroidSdk = installAndroidSdk;
+function requiresArmDbtLicense(apiLevel, target) {
+    return apiLevel === 30 || (apiLevel === 28 && target !== 'default');
+}

src/emulator-manager.ts

@@ -10,16 +10,23 @@ export async function launchEmulator(
   target: string,
   arch: string,
   profile: string,
+  cores: string,
   sdcardPathOrSize: string,
   avdName: string,
   emulatorOptions: string,
   disableAnimations: boolean
 ): Promise<void> {
   // create a new AVD
-  const profileOption = profile.trim() !== '' ? `--device "${profile}"` : '';
-  const sdcardPathOrSizeOption = sdcardPathOrSize.trim() !== '' ? `--sdcard "${sdcardPathOrSize}"` : '';
+  const profileOption = profile.trim() !== '' ? `--device '${profile}'` : '';
+  const sdcardPathOrSizeOption = sdcardPathOrSize.trim() !== '' ? `--sdcard '${sdcardPathOrSize}'` : '';
   console.log(`Creating AVD.`);
-  await exec.exec(`avdmanager create avd --force -n "${avdName}" --abi "${target}/${arch}" --package "system-images;android-${apiLevel};${target};${arch}" ${profileOption} ${sdcardPathOrSizeOption}`);
+  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' >> ~/.android/avd/"${avdName}".avd"/config.ini`);
+  }
 
   // start emulator
   console.log('Starting emulator.');

src/main.ts

@@ -39,6 +39,10 @@ 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}`);
+
     // 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}`);
@@ -98,7 +102,7 @@ async function run() {
     await installAndroidSdk(apiLevel, target, arch, emulatorBuild, ndkVersion, cmakeVersion);
 
     // launch an emulator
-    await launchEmulator(apiLevel, target, arch, profile, sdcardPathOrSize, avdName, emulatorOptions, disableAnimations);
+    await launchEmulator(apiLevel, target, arch, profile, cores, sdcardPathOrSize, avdName, emulatorOptions, disableAnimations);
 
     // execute the custom script
     try {

src/sdk-installer.ts

@@ -26,19 +26,20 @@ export async function installAndroidSdk(apiLevel: number, target: string, arch:
     const downloadPath = await tc.downloadTool(sdkUrl);
     await tc.extractZip(downloadPath, cmdlineToolsPath);
     await 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`);
   }
 
+  // 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 system images
+  // 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 (apiLevel == 30 && !fs.existsSync(sdkArmDbtLicensePath)) {
+  if (requiresArmDbtLicense(apiLevel, target) && !fs.existsSync(sdkArmDbtLicensePath)) {
     fs.writeFileSync(sdkArmDbtLicensePath, '\n859f317696f67ef3d7f30a50a5560e7834b43903');
   }
 
@@ -67,3 +68,7 @@ export async function installAndroidSdk(apiLevel: number, target: string, arch:
     await exec.exec(`sh -c \\"sdkmanager --install 'cmake;${cmakeVersion}' > /dev/null"`);
   }
 }
+
+function requiresArmDbtLicense(apiLevel: number, target: string): boolean {
+  return apiLevel === 30 || (apiLevel === 28 && target !== 'default');
+}

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