fix: allow google_apis_ps16k and google_apis_playstore_ps16k as valid targets

Fixes #403

Author: mikehardy

README.md

@@ -206,7 +206,7 @@ jobs:
 |-|-|-|-|
 | `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**. |
 | `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 - `default`, `google_apis`, `playstore`, `android-wear`, `android-wear-cn`, `android-tv`, `google-tv`, `aosp_atd`, `google_atd`, `android-automotive`, `android-automotive-playstore` or `android-desktop`. Note that `aosp_atd` and `google_atd` currently require the following: `api-level: 30`, `arch: x86` or `arch: arm64-v8` and `channel: canary`. |
+| `target` | Optional | `default` | Target of the system image - `default`, `google_apis`, `google_apis_ps16k`, `playstore`, `playstore_ps16k`, `android-wear`, `android-wear-cn`, `android-tv`, `google-tv`, `aosp_atd`, `google_atd`, `android-automotive`, `android-automotive-playstore` or `android-desktop`. Note that the ATD and PS16K emulators currently require `arch: x86` or `arch: arm64-v8`, ATDs require `api-level` 30 or higher, PS16k require `api-level` 35 or higher. |
 | `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`. |
 | `cores` | Optional | 2 | Number of cores to use for the emulator (`hw.cpu.ncore` in config.ini). |

__tests__/input-validator.test.ts

@@ -9,6 +9,18 @@ describe('target validator tests', () => {
     expect(func).toThrowError(`Value for input.target 'some-target' is unknown. Supported options: ${validator.VALID_TARGETS}`);
   });
 
+  it('Validates successfully with playstore target shorthands', () => {
+    const func1 = () => {
+      validator.checkTarget('playstore');
+    };
+    expect(func1).not.toThrow();
+    const func2 = () => {
+      validator.checkTarget('playstore_ps16k');
+    };
+    expect(func2).not.toThrow();
+  });
+});
+
 describe('arch validator tests', () => {
   it('Throws if arch is unknown', () => {
     const func = () => {

lib/input-validator.js

@@ -1,13 +1,15 @@
 "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.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.checkTarget = exports.playstoreTargetSubstitution = exports.MAX_PORT = exports.MIN_PORT = 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_ps16k',
     'aosp_atd',
     'google_atd',
     'google_apis_playstore',
+    'google_apis_playstore_ps16k',
     'android-wear',
     'android-wear-cn',
     'android-tv',
@@ -20,8 +22,18 @@ exports.VALID_ARCHS = ['x86', 'x86_64', 'arm64-v8a'];
 exports.VALID_CHANNELS = ['stable', 'beta', 'dev', 'canary'];
 exports.MIN_PORT = 5554;
 exports.MAX_PORT = 5584;
+function playstoreTargetSubstitution(target) {
+    // "playstore" is an allowed shorthand for "google_apis_playstore" images
+    // this is idempotent - return same even if run multiple times on same target
+    if (target === 'playstore')
+        return 'google_apis_playstore';
+    if (target === 'playstore_ps16k')
+        return 'google_apis_playstore_ps16k';
+    return target;
+}
+exports.playstoreTargetSubstitution = playstoreTargetSubstitution;
 function checkTarget(target) {
-    if (!exports.VALID_TARGETS.includes(target)) {
+    if (!exports.VALID_TARGETS.includes(playstoreTargetSubstitution(target))) {
         throw new Error(`Value for input.target '${target}' is unknown. Supported options: ${exports.VALID_TARGETS}.`);
     }
 }

lib/main.js

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

src/input-validator.ts

@@ -2,9 +2,11 @@ export const MIN_API_LEVEL = 15;
 export const VALID_TARGETS: Array<string> = [
   'default',
   'google_apis',
+  'google_apis_ps16k',
   'aosp_atd',
   'google_atd',
   'google_apis_playstore',
+  'google_apis_playstore_ps16k',
   'android-wear',
   'android-wear-cn',
   'android-tv',
@@ -18,8 +20,16 @@ export const VALID_CHANNELS: Array<string> = ['stable', 'beta', 'dev', 'canary']
 export const MIN_PORT = 5554;
 export const MAX_PORT = 5584;
 
+export function playstoreTargetSubstitution(target: string): string {
+  // "playstore" is an allowed shorthand for "google_apis_playstore" images
+  // this is idempotent - return same even if run multiple times on same target
+  if (target === 'playstore') return 'google_apis_playstore';
+  if (target === 'playstore_ps16k') return 'google_apis_playstore_ps16k';
+  return target;
+}
+
 export function checkTarget(target: string): void {
-  if (!VALID_TARGETS.includes(target)) {
+  if (!VALID_TARGETS.includes(playstoreTargetSubstitution(target))) {
     throw new Error(`Value for input.target '${target}' is unknown. Supported options: ${VALID_TARGETS}.`);
   }
 }

src/main.ts

@@ -12,6 +12,7 @@ import {
   checkEnableHardwareKeyboard,
   checkDiskSize,
   checkPort,
+  playstoreTargetSubstitution,
   MIN_PORT,
 } from './input-validator';
 import { createAvd, launchEmulator, killEmulator } from './emulator-manager';
@@ -52,8 +53,7 @@ async function run() {
     console.log(`System image API level: ${systemImageApiLevel}`);
 
     // target of the system image
-    const targetInput = core.getInput('target');
-    const target = targetInput == 'playstore' ? 'google_apis_playstore' : targetInput;
+    const target = playstoreTargetSubstitution(core.getInput('target'));
     checkTarget(target);
     console.log(`target: ${target}`);