Make android_sdk_repository generate filegroups containing system image files for all android system images installed in the SDK. For system images that are not installed, create genrule "poison pills" that print a helpful error message if you attempt to build them.

These filegroups are intended to be used as the system_image attribute of the android_device rule.

Example:

$ bazel build @android_test_support//tools/android/emulated_devices/pixel:android_25_x86
Extracting Bazel installation...
.
INFO: Found 1 target...
ERROR: /usr/local/google/home/ajmichael/.cache/bazel/_bazel_ajmichael/efa32264346ef1fc4fec492202b88b31/external/androidsdk/BUILD.bazel:56:1: Executing genrule @androidsdk//:emulator_images_android_25_x86 failed: Process exited with status 1 [sandboxed].
This rule requires that the Android SDK used by Bazel has the following system image installed: emulator_images_android_25_x86. Please install this system image through the Android SDK Manager and try again.

RELNOTES: None
PiperOrigin-RevId: 152889824

3 files changed, 93 insertions, 19 deletions

diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/android/android_sdk_repository_template.txt b/src/main/java/com/google/devtools/build/lib/bazel/rules/android/android_sdk_repository_template.txt
index cab75e8baa..a2663c719c 100644
--- a/src/main/java/com/google/devtools/build/lib/bazel/rules/android/android_sdk_repository_template.txt
+++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/android/android_sdk_repository_template.txt
@@ -2,8 +2,8 @@ package(default_visibility = ["//visibility:public"])
 
 load(
     "@bazel_tools//tools/android:android_sdk_repository_template.bzl",
-    "create_android_device_rules",
-    "create_android_sdk_rules")
+    "create_android_sdk_rules",
+    "create_system_images_filegroups")
 
 create_android_sdk_rules(
     name = "%repository_name%",
@@ -53,7 +53,7 @@ filegroup(
     srcs = ["."],
 )
 
-create_android_device_rules(
+create_system_images_filegroups(
     system_image_dirs = [
 %system_image_dirs%    ],
 )
diff --git a/src/test/java/com/google/devtools/build/lib/bazel/rules/android/AndroidSdkRepositoryTest.java b/src/test/java/com/google/devtools/build/lib/bazel/rules/android/AndroidSdkRepositoryTest.java
index fd64a4a8ca..47554ecdca 100644
--- a/src/test/java/com/google/devtools/build/lib/bazel/rules/android/AndroidSdkRepositoryTest.java
+++ b/src/test/java/com/google/devtools/build/lib/bazel/rules/android/AndroidSdkRepositoryTest.java
@@ -128,7 +128,7 @@ public class AndroidSdkRepositoryTest extends BuildViewTestCase {
     invalidatePackages();
 
     ConfiguredTarget android25ArmFilegroup =
-        getConfiguredTarget("@androidsdk//:android-25_default_armeabi-v7a_files");
+        getConfiguredTarget("@androidsdk//:emulator_images_android_25_arm");
     assertThat(android25ArmFilegroup).isNotNull();
     assertThat(
         artifactsToStrings(
@@ -137,7 +137,7 @@ public class AndroidSdkRepositoryTest extends BuildViewTestCase {
             "src external/androidsdk/system-images/android-25/default/armeabi-v7a/system.img");
 
     ConfiguredTarget android24X86Filegroup =
-        getConfiguredTarget("@androidsdk//:android-24_google_apis_x86_files");
+        getConfiguredTarget("@androidsdk//:emulator_images_google_24_x86");
     assertThat(android24X86Filegroup).isNotNull();
     assertThat(
         artifactsToStrings(
diff --git a/tools/android/android_sdk_repository_template.bzl b/tools/android/android_sdk_repository_template.bzl
index 153afcc541..0e9ec0c56a 100644
--- a/tools/android/android_sdk_repository_template.bzl
+++ b/tools/android/android_sdk_repository_template.bzl
@@ -201,25 +201,99 @@ def create_android_sdk_rules(
       jars = [":dx_jar"],
   )
 
-def create_android_device_rules(system_image_dirs):
-  """Generate android_device rules for the system images in the Android SDK.
+
+TAGDIR_TO_TAG_MAP = {
+    "google_apis": "google",
+    "default": "android",
+    "android-tv": "tv",
+    "android-wear": "wear",
+}
+
+
+ARCHDIR_TO_ARCH_MAP = {
+    "x86": "x86",
+    "armeabi-v7a": "arm",
+}
+
+
+def create_system_images_filegroups(system_image_dirs):
+  """Generate filegroups for the system images in the Android SDK.
 
   Args:
     system_image_dirs: list of strings, the directories containing system image
         files to be used to create android_device rules.
   """
 
-  for system_image_dir in system_image_dirs:
-    name = "_".join(system_image_dir.split("/")[1:])
+  # These images will need to be updated as Android releases new system images.
+  # We are intentionally not adding future releases because there is no
+  # guarantee that they will work out of the box. Supported system images should
+  # be added here once they have been confirmed to work with the Bazel Android
+  # testing infrastructure.
+  system_images = [(tag, api, arch)
+                   for tag in ["android", "google"]
+                   for api in [10] + range(15, 20) + range(21, 27)
+                   for arch in ("x86", "arm")]
+  tv_images = [("tv", api, arch)
+               for api in range(21, 25) for arch in ("x86", "arm")]
+  wear_images = [("wear", api, "x86")
+                 for api in range(20, 26)] + [("wear", api, "arm")
+                                              for api in range(24, 26)]
+  supported_system_images = system_images + tv_images + wear_images
 
-    # TODO(ajmichael): Remove this target after unified_launcher's tests are
-    # updated to use the emulator_images_%s filegroups instead.
-    native.filegroup(
-        name = "%s_files" % name,
-        srcs = native.glob(["%s/**" % system_image_dir]),
-    )
+  installed_system_images_dirs = {}
+  for system_image_dir in system_image_dirs:
+    apidir, tagdir, archdir = system_image_dir.split("/")[1:]
+    api = int(apidir.split("-")[1])  # "android-24" --> 24
+    if tagdir not in TAGDIR_TO_TAG_MAP:
+      continue
+    tag = TAGDIR_TO_TAG_MAP[tagdir]
+    if archdir not in ARCHDIR_TO_ARCH_MAP:
+      continue
+    arch = ARCHDIR_TO_ARCH_MAP[archdir]
+    if (tag, api, arch) in supported_system_images:
+      name = "emulator_images_%s_%s_%s" % (tag, api, arch)
+      installed_system_images_dirs[name] = system_image_dir
+    else:
+      # TODO(bazel-team): If the user has an unsupported system image installed,
+      # should we print a warning? This includes all 64-bit system-images.
+      pass
 
-    native.filegroup(
-        name = "emulator_images_%s" % name,
-        srcs = native.glob(["%s/**" % system_image_dir]),
-    )
+  for (tag, api, arch) in supported_system_images:
+    name = "emulator_images_%s_%s_%s" % (tag, api, arch)
+    if name in installed_system_images_dirs:
+      system_image_dir = installed_system_images_dirs[name]
+      # For supported system images that exist in /sdk/system-images/, we
+      # create a filegroup with their contents.
+      native.filegroup(
+          name = name,
+          srcs = native.glob([
+              "%s/**" % system_image_dir,
+          ]),
+      )
+      native.filegroup(
+          name = "%s_qemu2_extra" % name,
+          srcs = native.glob(["%s/kernel-ranchu" % system_image_dir]),
+      )
+    else:
+      # For supported system images that are not installed in the SDK, we
+      # create a "poison pill" genrule to display a helpful error message to
+      # a user who attempts to run a test against an android_device that
+      # they don't have the system image for installed.
+      native.genrule(
+          name = name,
+          outs = [
+              # Necessary so that the build doesn't fail in analysis because
+              # android_device expects a file named source.properties.
+              "poison_pill_for_%s/source.properties" % name,
+          ],
+          cmd = """echo \
+          This rule requires that the Android SDK used by Bazel has the \
+          following system image installed: %s. Please install this system \
+          image through the Android SDK Manager and try again. ; \
+          exit 1
+          """ % name,
+      )
+      native.filegroup(
+          name = "%s_qemu2_extra" % name,
+          srcs = [],
+      )