add aar-metadata.properties attribute in android_archive and android-library to support adding AAR metadata file inside final .aar.

PiperOrigin-RevId: 721597551
Change-Id: I5c1c41dacf0b97c1ff97926929ae81a769386aa2

Author: A Googler

rules/android_library/attrs.bzl

@@ -26,6 +26,10 @@ visibility(PROJECT_VISIBILITY)
 
 ATTRS = _attrs.add(
     dict(
+        aar_metadata = attr.label(
+            allow_single_file = [".properties"],
+            doc = ("The name of the AAR metadata file, optional"),
+        ),
         baseline_profiles = attr.label_list(
             allow_files = [".txt"],
             doc = (

rules/android_library/impl.bzl

@@ -333,6 +333,7 @@ def _process_aar(ctx, java_package, resources_ctx, proguard_ctx, **unused_ctx):
         resource_files = resources_ctx.starlark_processed_resources if not ctx.attr.neverlink else [],
         class_jar = ctx.outputs.lib_jar,
         r_txt = resources_ctx.starlark_r_txt,
+        aar_metadata = ctx.file.aar_metadata,
         proguard_specs = proguard_ctx.proguard_configs,
         busybox = get_android_toolchain(ctx).android_resources_busybox.files_to_run,
         host_javabase = _common.get_host_javabase(ctx),

rules/busybox.bzl

@@ -1078,6 +1078,7 @@ def _make_aar(
         class_jar = None,
         r_txt = None,
         manifest = None,
+        aar_metadata = None,
         proguard_specs = [],
         should_throw_on_conflict = False,
         busybox = None,
@@ -1093,6 +1094,7 @@ def _make_aar(
       class_jar: File. The class jar file.
       r_txt: File. The resource IDs outputted by linking resources in text.
       manifest: File. The primary AndroidManifest.xml.
+      aar_metadata: File. Optional metadata file to be included in the output AAR file.
       proguard_specs: List of File. The proguard spec files.
       busybox: FilesToRunProvider. The ResourceBusyBox executable or
         FilesToRunprovider
@@ -1119,6 +1121,12 @@ def _make_aar(
     args.add("--classes", class_jar)
     args.add("--aarOutput", out_aar)
     args.add_all(proguard_specs, before_each = "--proguardSpec")
+
+    input_files = [r_txt, manifest, class_jar]
+    if aar_metadata != None:
+        args.add("--aarMetadata", aar_metadata)
+        input_files.append(aar_metadata)
+
     if should_throw_on_conflict:
         args.add("--throwOnResourceConflict")
 
@@ -1134,7 +1142,7 @@ def _make_aar(
             resource_files +
             assets +
             proguard_specs +
-            [r_txt, manifest, class_jar]
+            input_files
         ),
         outputs = [out_aar],
         mnemonic = "StarlarkAARGenerator",

rules/resources.bzl

@@ -954,6 +954,7 @@ def _make_aar(
         class_jar = None,
         r_txt = None,
         manifest = None,
+        aar_metadata = None,
         proguard_specs = [],
         busybox = None,
         host_javabase = None):
@@ -967,6 +968,7 @@ def _make_aar(
       class_jar: File. The class jar file.
       r_txt: File. The resource IDs outputted by linking resources in text.
       manifest: File. The primary AndroidManifest.xml.
+      aar_metadata: File. Optional metadata file to be included in the `.aar` file.
       proguard_specs: List of File. The proguard spec files.
       busybox: FilesToRunProvider. The ResourceBusyBox executable or
         FilesToRunprovider
@@ -985,6 +987,7 @@ def _make_aar(
         class_jar = class_jar,
         r_txt = r_txt,
         manifest = manifest,
+        aar_metadata = aar_metadata,
         proguard_specs = proguard_specs,
         busybox = busybox,
         host_javabase = host_javabase,

src/tools/java/com/google/devtools/build/android/AarGeneratorAction.java

@@ -23,6 +23,7 @@
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Joiner;
 import com.google.common.base.Stopwatch;
+import com.google.common.base.Strings;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.Ordering;
 import com.google.devtools.build.android.AndroidDataMerger.MergeConflictException;
@@ -103,6 +104,12 @@ public static final class AarGeneratorOptions {
         description = "Path to classes.jar.")
     public Path classes;
 
+    @Parameter(
+        names = "--aarMetadata",
+        converter = CompatExistingPathConverter.class,
+        description = "Path to aar-metadata.properties file. Optional.")
+    public Path aarMetadata;
+
     @Parameter(
         names = "--proguardSpec",
         converter = CompatExistingPathConverter.class,
@@ -164,6 +171,7 @@ public static void main(String[] args) throws ParameterException, IOException {
           options.manifest,
           options.rtxt,
           options.classes,
+          options.aarMetadata,
           options.proguardSpecs);
       logger.fine(
           String.format("Packaging finished at %dms", timer.elapsed(TimeUnit.MILLISECONDS)));
@@ -203,6 +211,7 @@ static void writeAar(
       Path manifest,
       Path rtxt,
       Path classes,
+      Path aarMetadata,
       List<Path> proguardSpecs)
       throws IOException {
     try (final ZipOutputStream zipOut =
@@ -213,6 +222,20 @@ static void writeAar(
       zipOut.write(Files.readAllBytes(manifest));
       zipOut.closeEntry();
 
+      if (aarMetadata != null && !Strings.isNullOrEmpty(aarMetadata.toString())) {
+        if (Files.notExists(aarMetadata)) {
+          throw new ParameterException(
+              String.format("AAR metadata file %s does not exist.", aarMetadata));
+        }
+
+        ZipEntry aarMetadataEntry =
+            new ZipEntry("META-INF/com/android/build/gradle/aar-metadata.properties");
+        aarMetadataEntry.setTime(DEFAULT_TIMESTAMP.toEpochMilli());
+        zipOut.putNextEntry(aarMetadataEntry);
+        zipOut.write(Files.readAllBytes(aarMetadata));
+        zipOut.closeEntry();
+      }
+
       ZipEntry classJar = new ZipEntry("classes.jar");
       classJar.setTime(DEFAULT_TIMESTAMP.toEpochMilli());
       zipOut.putNextEntry(classJar);