Merge branch 'main' into release/v2

* main:
  Prepare for release 2.20.0.
  Update manual workflow.
  Support choosing channel to download SDK components from.
  build-tools to 31.0.0; SDK cmd-line tools to 5.0. (ReactiveCircus#174)
  Fix macos-11 VM label.
  Realm JavaScript is using Android Emulator Runner (ReactiveCircus#182)
  Add MobileRT to the list of projects (ReactiveCircus#181)
  Support non-mobile targets (Wear OS, TV) (ReactiveCircus#180)
  Bump path-parse from 1.0.6 to 1.0.7

Author: ychescale9

.github/workflows/workflow.yml renamed to .github/workflows/main.yml

@@ -18,6 +18,7 @@ jobs:
         os: [macos-latest, ubuntu-latest]
         api-level: [16, 23, 29]
         target: [default, google_apis]
+        arch: [x86]
         exclude:
           - os: ubuntu-latest
             api-level: 23
@@ -30,15 +31,18 @@ jobs:
           - target: google_apis
             api-level: 29
         include:
-          - os: macos-11.0
-            api-level: 30
-            target: google_apis
           - os: macos-latest
             api-level: 24
             target: playstore
+            arch: x86
           - os: macos-latest
             api-level: 28
             target: google_apis
+            arch: x86
+          - os: macos-11
+            api-level: 31
+            target: google_apis
+            arch: x86_64
 
     steps:
     - name: checkout
@@ -84,7 +88,7 @@ jobs:
       with:
         api-level: ${{ matrix.api-level }}
         target: ${{ matrix.target }}
-        arch: x86
+        arch: ${{ matrix.arch }}
         profile: Galaxy Nexus
         cores: 2
         sdcard-path-or-size: 100M
@@ -100,7 +104,7 @@ jobs:
       with:
         api-level: ${{ matrix.api-level }}
         target: ${{ matrix.target }}
-        arch: x86
+        arch: ${{ matrix.arch }}
         profile: Galaxy Nexus
         cores: 2
         ram-size: 2048M

.github/workflows/manually.yml

@@ -0,0 +1,76 @@
+name: Manually triggered workflow
+on:
+  workflow_dispatch:
+    inputs:
+      os:
+        description: 'OS'
+        required: true
+        default: 'macos-latest'
+      api-level:
+        description: 'API level of the platform and system image'
+        required: true
+        default: '30'
+      target:
+        description: 'target of the system image - default, google_apis, google_apis_playstore, android-wear, android-wear-cn, android-tv or google-tv'
+        required: true
+        default: 'default'
+      arch:
+        description: 'CPU architecture of the system image - x86, x86_64 or arm64-v8a'
+        default: 'x86'
+      emulator-options:
+        description: 'command-line options used when launching the emulator'
+        default: '-no-window -gpu swiftshader_indirect -no-snapshot -noaudio -no-boot-anim'
+      emulator-build:
+        description: 'build number of a specific version of the emulator binary to use'
+      channel:
+        description: 'Channel to download the SDK components from - `stable`, `beta`, `dev`, `canary`'
+        default: 'stable'
+      script:
+        description: 'custom script to run - e.g. `./gradlew connectedCheck`'
+        required: true
+        default: './gradlew connectedDebugAndroidTest'
+
+jobs:
+  test:
+    runs-on: ${{ github.event.inputs.os }}
+    env:
+      JAVA_TOOL_OPTIONS: -Xmx4g
+    timeout-minutes: 15
+    
+    steps:
+    - name: checkout
+      uses: actions/checkout@v2
+
+    - name: validate gradle wrapper
+      uses: gradle/wrapper-validation-action@v1
+
+    - name: build, test and lint
+      run: |
+        npm install
+        npm run build
+        npm run lint
+        npm test
+
+    - name: Java 15
+      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') }}
+
+    - name: run action
+      uses: ./
+      with:
+        api-level: ${{ github.event.inputs.api-level }}
+        target: ${{ github.event.inputs.target }}
+        arch: ${{ github.event.inputs.arch }}
+        profile: Galaxy Nexus
+        emulator-options: ${{ github.event.inputs.emulator-options }}
+        emulator-build: ${{ github.event.inputs.emulator-build }}
+        channel: ${{ github.event.inputs.channel }}
+        working-directory: ./test-fixture/
+        script: ${{ github.event.inputs.script }}

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## v2.20.0
+
+* Support non-mobile targets: `android-wear`, `android-wear-cn`, `android-tv` and `google-tv`. - [#180](https://github.com/ReactiveCircus/android-emulator-runner/pull/180) @alexvanyo.
+* Update SDK command-line tools to `5.0`. - [#174](https://github.com/ReactiveCircus/android-emulator-runner/pull/174)
+* Update build tools to `31.0.0`. - [#174](https://github.com/ReactiveCircus/android-emulator-runner/pull/174)
+* Add option to specify the `channel` to download SDK components from: `stable` (default), `beta`, `dev` and `canary`. - [#185](https://github.com/ReactiveCircus/android-emulator-runner/pull/185)
+
 ## v2.19.1
 
 * Accept all Android SDL Licenses to fix `sdkmanager` installation. - [#172](https://github.com/ReactiveCircus/android-emulator-runner/pull/172) @marcuspridham.

README.md

@@ -159,6 +159,7 @@ jobs:
 | `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` |
 | `cmake` | Optional | N/A | Version of CMake to install - e.g. `3.10.2.4988404` |
+| `channel` | Optional | stable | Channel to download the SDK components from - `stable`, `beta`, `dev`, `canary` |
 | `script` | Required | N/A | Custom script to run - e.g. to run Android instrumented tests on the emulator: `./gradlew connectedCheck` |
 
 Default `emulator-options`: `-no-window -gpu swiftshader_indirect -no-snapshot -noaudio -no-boot-anim`.

__tests__/channel-id-mapper.test.ts

@@ -0,0 +1,17 @@
+import * as mapper from '../src/channel-id-mapper';
+
+describe('channel id mapper tests', () => {
+  it('Throws if channelName is unknown', () => {
+    const func = () => {
+      mapper.getChannelId('unknown-channel');
+    };
+    expect(func).toThrowError(`Unexpected channel name: 'unknown-channel'.`);
+  });
+
+  it('Returns expected channelId from channelName', () => {
+    expect(mapper.getChannelId('stable')).toBe(0);
+    expect(mapper.getChannelId('beta')).toBe(1);
+    expect(mapper.getChannelId('dev')).toBe(2);
+    expect(mapper.getChannelId('canary')).toBe(3);
+  });
+});

__tests__/input-validator.test.ts

@@ -55,9 +55,29 @@ describe('target validator tests', () => {
     expect(func2).not.toThrow();
 
     const func3 = () => {
-      validator.checkTarget('google_apis');
+      validator.checkTarget('google_apis_playstore');
     };
     expect(func3).not.toThrow();
+
+    const func4 = () => {
+      validator.checkTarget('android-wear');
+    };
+    expect(func4).not.toThrow();
+
+    const func5 = () => {
+      validator.checkTarget('android-wear-cn');
+    };
+    expect(func5).not.toThrow();
+
+    const func6 = () => {
+      validator.checkTarget('android-tv');
+    };
+    expect(func6).not.toThrow();
+
+    const func7 = () => {
+      validator.checkTarget('google-tv');
+    };
+    expect(func7).not.toThrow();
   });
 });
 
@@ -82,6 +102,37 @@ describe('arch validator tests', () => {
   });
 });
 
+describe('channel validator tests', () => {
+  it('Throws if channel is unknown', () => {
+    const func = () => {
+      validator.checkChannel('some-channel');
+    };
+    expect(func).toThrowError(`Value for input.channel 'some-channel' is unknown. Supported options: ${validator.VALID_CHANNELS}`);
+  });
+
+  it('Validates successfully with valid channel', () => {
+    const func1 = () => {
+      validator.checkChannel('stable');
+    };
+    expect(func1).not.toThrow();
+
+    const func2 = () => {
+      validator.checkChannel('beta');
+    };
+    expect(func2).not.toThrow();
+
+    const func3 = () => {
+      validator.checkChannel('dev');
+    };
+    expect(func3).not.toThrow();
+
+    const func4 = () => {
+      validator.checkChannel('canary');
+    };
+    expect(func4).not.toThrow();
+  });
+});
+
 describe('force-avd-creation validator tests', () => {
   it('Throws if force-avd-creation is not a boolean', () => {
     const func = () => {

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, google_apis or playstore'
+    description: 'target of the system image - default, google_apis, google_apis_playstore, android-wear, android-wear-cn, android-tv or google-tv'
     default: 'default'
   arch:
     description: 'CPU architecture of the system image - x86, x86_64 or arm64-v8a'
@@ -49,6 +49,9 @@ inputs:
     description: 'version of NDK to install - e.g. 21.0.6113669'
   cmake:
     description: 'version of CMake to install - e.g. 3.10.2.4988404'
+  channel:
+    description: 'Channel to download the SDK components from - `stable`, `beta`, `dev`, `canary`'
+    default: 'stable'
   script:
     description: 'custom script to run - e.g. `./gradlew connectedCheck`'
     required: true

lib/channel-id-mapper.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getChannelId = void 0;
+function getChannelId(channelName) {
+    if (channelName === 'stable') {
+        return 0;
+    }
+    else if (channelName === 'beta') {
+        return 1;
+    }
+    else if (channelName === 'dev') {
+        return 2;
+    }
+    else if (channelName === 'canary') {
+        return 3;
+    }
+    else {
+        throw new Error(`Unexpected channel name: '${channelName}'.`);
+    }
+}
+exports.getChannelId = getChannelId;

lib/input-validator.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkEmulatorBuild = exports.checkDisableLinuxHardwareAcceleration = exports.checkDisableSpellchecker = exports.checkDisableAnimations = exports.checkForceAvdCreation = exports.checkArch = exports.checkTarget = exports.checkApiLevel = exports.VALID_ARCHS = exports.VALID_TARGETS = exports.MIN_API_LEVEL = void 0;
+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.MIN_API_LEVEL = 15;
-exports.VALID_TARGETS = ['default', 'google_apis', 'google_apis_playstore'];
+exports.VALID_TARGETS = ['default', 'google_apis', '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'];
 function checkApiLevel(apiLevel) {
     if (isNaN(Number(apiLevel)) || !Number.isInteger(Number(apiLevel))) {
         throw new Error(`Unexpected API level: '${apiLevel}'.`);
@@ -25,6 +26,12 @@ function checkArch(arch) {
     }
 }
 exports.checkArch = checkArch;
+function checkChannel(channel) {
+    if (!exports.VALID_CHANNELS.includes(channel)) {
+        throw new Error(`Value for input.channel '${channel}' is unknown. Supported options: ${exports.VALID_CHANNELS}.`);
+    }
+}
+exports.checkChannel = checkChannel;
 function checkForceAvdCreation(forceAvdCreation) {
     if (!isValidBoolean(forceAvdCreation)) {
         throw new Error(`Input for input.force-avd-creation should be either 'true' or 'false'.`);

lib/main.js

@@ -34,6 +34,7 @@ const input_validator_1 = require("./input-validator");
 const emulator_manager_1 = require("./emulator-manager");
 const exec = __importStar(require("@actions/exec"));
 const script_parser_1 = require("./script-parser");
+const channel_id_mapper_1 = require("./channel-id-mapper");
 function run() {
     return __awaiter(this, void 0, void 0, function* () {
         try {
@@ -123,6 +124,11 @@ function run() {
                 console.log(`version of CMake to install: ${cmakeInput}`);
             }
             const cmakeVersion = !cmakeInput ? undefined : cmakeInput;
+            // channelId (up to and including) to download the SDK packages from
+            const channelName = core.getInput('channel');
+            input_validator_1.checkChannel(channelName);
+            const channelId = channel_id_mapper_1.getChannelId(channelName);
+            console.log(`Channel: ${channelId} (${channelName})`);
             // custom script to run
             const scriptInput = core.getInput('script', { required: true });
             const scripts = script_parser_1.parseScript(scriptInput);
@@ -131,7 +137,7 @@ function run() {
                 console.log(`${script}`);
             }));
             // install SDK
-            yield sdk_installer_1.installAndroidSdk(apiLevel, target, arch, emulatorBuild, ndkVersion, cmakeVersion);
+            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);
             // execute the custom script