Test API 23-30.

Shopify/android-testify uses the Android Emulator Runner for GitHub Actions

.github/workflows/workflow.yml

@@ -3,36 +3,43 @@ on:
   pull_request:
   push:
     branches:
-      - main
+      # - main
+      - 'yc/*'
     paths-ignore:
       - '**.md'
 
 jobs:
   test:
-    runs-on: ${{ matrix.os }}
+    # runs-on: ${{ matrix.os }}
+    runs-on: macos-latest
     env:
       JAVA_TOOL_OPTIONS: -Xmx4g
     timeout-minutes: 15
     strategy:
+      fail-fast: false
       matrix:
-        os: [macos-latest, ubuntu-latest]
-        api-level: [16, 23, 29]
-        target: [default, google_apis]
-        exclude:
-          - os: ubuntu-latest
-            api-level: 23
-          - os: ubuntu-latest
-            api-level: 29
-          - target: google_apis
-            api-level: 16
-          - target: google_apis
-            api-level: 23
-          - target: google_apis
-            api-level: 29
-        include:
-          - os: macos-latest
-            api-level: 30
-            target: google_apis
+      #   os: [macos-latest, ubuntu-latest]
+        api-level: [23, 24, 25, 26, 27, 28, 29, 30]
+      #   target: [default, google_apis]
+      #   exclude:
+      #     - os: ubuntu-latest
+      #       api-level: 23
+      #     - os: ubuntu-latest
+      #       api-level: 29
+      #     - target: google_apis
+      #       api-level: 16
+      #     - target: google_apis
+      #       api-level: 23
+      #     - target: google_apis
+      #       api-level: 29
+      #   include:
+      #     - os: macos-latest
+      #       api-level: 30
+      #       target: google_apis
+      #     - os: macos-latest
+      #       api-level: 24
+      #       target: playstore
+
     steps:
     - name: checkout
       uses: actions/checkout@v2
@@ -42,7 +49,7 @@ jobs:
 
     - name: build, test and lint
       run: |
-        npm install
+        npm ci
         npm run build
         npm run lint
         npm test
@@ -61,15 +68,29 @@ jobs:
       uses: ./
       with:
         api-level: ${{ matrix.api-level }}
-        target: ${{ matrix.target }}
+        target: default
         arch: x86
-        profile: Nexus 6
-        avd-name: test
+        # profile: Nexus 6
+        profile: pixel_3a
+        # avd-name: test
         emulator-options: -no-window -gpu swiftshader_indirect -no-snapshot -noaudio -no-boot-anim -camera-back none
         disable-animations: true
         working-directory: ./test-fixture/
         script: |
           echo $GITHUB_REPOSITORY
           adb devices
-          ./gradlew help
-          ./gradlew connectedDebugAndroidTest
+          adb shell ls -la /sdcard
+          adb shell ls -la /storage
+          adb emu geo fix 0 51
+          adb shell screenrecord --verbose /sdcard/capture.mpg &
+          adb shell pkill -INT screenrecord
+          mkdir -p app/build/report
+          cd app/build/report && adb pull /sdcard/capture.mpg
+          # ./gradlew help
+          # ./gradlew connectedDebugAndroidTest
+
+    - name: Upload build artifacts
+      uses: actions/upload-artifact@v1
+      with:
+        name: build-outputs
+        path: ./test-fixture/app/build/report

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change Log
 
+## v2.12.0
+
+Added support for using the `playstore` system images:
+
+```
+- name: run tests
+  uses: reactivecircus/android-emulator-runner@v2
+  with:
+    api-level: 30
+    target: playstore
+    arch: x86
+    script: ./gradlew connectedCheck
+```
+
 ## v2.11.1
 
 * Update SDK command-line tools to `2.1`.

README.md

@@ -8,7 +8,7 @@ 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 **masOS** 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 
+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.
 
 This action automates the process by doing the following:
@@ -86,10 +86,10 @@ jobs:
 
 ## Configurations
 
-|  | **Required** | **Default** | **Description** |
-|----------------------|--------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **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` or `google_apis`. |
+| `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". |
 | `avd-name` | Optional | `test` | Custom AVD name used for creating the Android Virtual Device. |
@@ -132,5 +132,6 @@ These are some of the open-source projects using (or used) **Android Emulator Ru
 - [simpledotorg/simple-android](https://github.com/simpledotorg/simple-android)
 - [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)
 
 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__/input-validator.test.ts

@@ -53,6 +53,11 @@ describe('target validator tests', () => {
       validator.checkTarget('google_apis');
     };
     expect(func2).not.toThrow();
+
+    const func3 = () => {
+      validator.checkTarget('google_apis');
+    };
+    expect(func3).not.toThrow();
   });
 });
 

action.yml

@@ -9,7 +9,7 @@ inputs:
     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 or google_apis'
+    description: 'target of the system image - default, google_apis or playstore'
     default: 'default'
   arch:
     description: 'CPU architecture of the system image - x86 or x86_64'

lib/input-validator.js

@@ -2,7 +2,7 @@
 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.MIN_API_LEVEL = 15;
-exports.VALID_TARGETS = ['default', 'google_apis'];
+exports.VALID_TARGETS = ['default', 'google_apis', 'google_apis_playstore'];
 exports.VALID_ARCHS = ['x86', 'x86_64'];
 function checkApiLevel(apiLevel) {
     if (isNaN(Number(apiLevel)) || !Number.isInteger(Number(apiLevel))) {

lib/main.js

@@ -52,7 +52,8 @@ function run() {
             const apiLevel = Number(apiLevelInput);
             console.log(`API level: ${apiLevel}`);
             // target of the system image
-            const target = core.getInput('target');
+            const targetInput = core.getInput('target');
+            const target = targetInput == 'playstore' ? 'google_apis_playstore' : targetInput;
             input_validator_1.checkTarget(target);
             console.log(`target: ${target}`);
             // CPU architecture of the system image

lib/sdk-installer.js

@@ -32,10 +32,11 @@ exports.installAndroidSdk = void 0;
 const core = __importStar(require("@actions/core"));
 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.2';
-const CMDLINE_TOOLS_URL_MAC = 'https://dl.google.com/android/repository/commandlinetools-mac-6609375_latest.zip';
-const CMDLINE_TOOLS_URL_LINUX = 'https://dl.google.com/android/repository/commandlinetools-linux-6609375_latest.zip';
+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';
 /**
  * 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.
@@ -50,12 +51,14 @@ function installAndroidSdk(apiLevel, target, arch, emulatorBuild, ndkVersion, cm
         if (!fs.existsSync(cmdlineToolsPath)) {
             console.log('Installing new cmdline-tools.');
             const sdkUrl = isOnMac ? CMDLINE_TOOLS_URL_MAC : CMDLINE_TOOLS_URL_LINUX;
-            yield io.mkdirP(`${process.env.ANDROID_HOME}/cmdline-tools`);
-            yield exec.exec(`curl -fo commandlinetools.zip ${sdkUrl}`);
-            yield exec.exec(`unzip -q commandlinetools.zip -d ${cmdlineToolsPath}`);
-            yield io.rmRF('commandlinetools.zip');
+            // await io.mkdirP(cmdlineToolsPath);
+            const downloadPath = yield tc.downloadTool(sdkUrl);
+            yield tc.extractZip(downloadPath, cmdlineToolsPath);
+            yield io.mv(`${cmdlineToolsPath}/cmdline-tools`, `${cmdlineToolsPath}/latest`);
+            yield exec.exec(`ls -la ${cmdlineToolsPath}`);
             // add paths for commandline-tools and platform-tools
-            core.addPath(`${cmdlineToolsPath}/tools:${cmdlineToolsPath}/tools/bin:${process.env.ANDROID_HOME}/platform-tools`);
+            core.addPath(`${cmdlineToolsPath}/latest:${cmdlineToolsPath}/latest/bin:${process.env.ANDROID_HOME}/platform-tools`);
+            yield exec.exec(`ls -la ${cmdlineToolsPath}/latest`);
         }
         // additional permission and license requirements for Linux
         const sdkPreviewLicensePath = `${process.env.ANDROID_HOME}/licenses/android-sdk-preview-license`;

src/input-validator.ts

@@ -1,5 +1,5 @@
 export const MIN_API_LEVEL = 15;
-export const VALID_TARGETS: Array<string> = ['default', 'google_apis'];
+export const VALID_TARGETS: Array<string> = ['default', 'google_apis', 'google_apis_playstore'];
 export const VALID_ARCHS: Array<string> = ['x86', 'x86_64'];
 
 export function checkApiLevel(apiLevel: string): void {

src/main.ts

@@ -25,7 +25,8 @@ async function run() {
     console.log(`API level: ${apiLevel}`);
 
     // target of the system image
-    const target = core.getInput('target');
+    const targetInput = core.getInput('target');
+    const target = targetInput == 'playstore' ? 'google_apis_playstore' : targetInput;
     checkTarget(target);
     console.log(`target: ${target}`);
 

src/sdk-installer.ts

@@ -1,11 +1,12 @@
 import * as core from '@actions/core';
 import * as exec from '@actions/exec';
 import * as io from '@actions/io';
+import * as tc from '@actions/tool-cache';
 import * as fs from 'fs';
 
 const BUILD_TOOLS_VERSION = '30.0.2';
-const CMDLINE_TOOLS_URL_MAC = 'https://dl.google.com/android/repository/commandlinetools-mac-6609375_latest.zip';
-const CMDLINE_TOOLS_URL_LINUX = 'https://dl.google.com/android/repository/commandlinetools-linux-6609375_latest.zip';
+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';
 
 /**
  * Installs & updates the Android SDK for the macOS platform, including SDK platform for the chosen API level, latest build tools, platform tools, Android Emulator,
@@ -22,13 +23,17 @@ export async function installAndroidSdk(apiLevel: number, target: string, arch:
   if (!fs.existsSync(cmdlineToolsPath)) {
     console.log('Installing new cmdline-tools.');
     const sdkUrl = isOnMac ? CMDLINE_TOOLS_URL_MAC : CMDLINE_TOOLS_URL_LINUX;
-    await io.mkdirP(`${process.env.ANDROID_HOME}/cmdline-tools`);
-    await exec.exec(`curl -fo commandlinetools.zip ${sdkUrl}`);
-    await exec.exec(`unzip -q commandlinetools.zip -d ${cmdlineToolsPath}`);
-    await io.rmRF('commandlinetools.zip');
+    // await io.mkdirP(cmdlineToolsPath);
+    const downloadPath = await tc.downloadTool(sdkUrl);
+    await tc.extractZip(downloadPath, cmdlineToolsPath);
+    await io.mv(`${cmdlineToolsPath}/cmdline-tools`, `${cmdlineToolsPath}/latest`);
+
+    await exec.exec(`ls -la ${cmdlineToolsPath}`);
 
     // add paths for commandline-tools and platform-tools
-    core.addPath(`${cmdlineToolsPath}/tools:${cmdlineToolsPath}/tools/bin:${process.env.ANDROID_HOME}/platform-tools`);
+    core.addPath(`${cmdlineToolsPath}/latest:${cmdlineToolsPath}/latest/bin:${process.env.ANDROID_HOME}/platform-tools`);
+
+    await exec.exec(`ls -la ${cmdlineToolsPath}/latest`);
   }
 
   // additional permission and license requirements for Linux

test-fixture/gradle.properties

@@ -1,6 +1,7 @@
 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.7-rc-1-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip