Do not include Target-Label in java_export manifests (bazel-contrib#766)

Bazel labels are an internal detail of the project producing the jar.
fmeum · Oct 12, 2022 · 762f94d · 762f94d
1 parent f6cec9c
commit 762f94d
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 0 deletions.
diff --git a/private/tools/java/rules/jvm/external/jar/MergeJars.java b/private/tools/java/rules/jvm/external/jar/MergeJars.java
@@ -169,6 +169,9 @@ public static void main(String[] args) throws IOException {
     }
 
     manifest.getMainAttributes().put(new Attributes.Name("Created-By"), "mergejars");
+    // Bazel labels are an internal detail of the project producing the merged
+    // jar and not useful for consumers.
+    manifest.getMainAttributes().remove(new Attributes.Name("Target-Label"));
 
     // Now create the output jar
     Files.createDirectories(out.getParent());

diff --git a/tests/com/jvm/external/jar/MergeJarsTest.java b/tests/com/jvm/external/jar/MergeJarsTest.java
@@ -23,7 +23,10 @@
 import java.util.Map;
 import java.util.Set;
 import java.util.jar.Attributes;
+import java.util.jar.JarFile;
 import java.util.jar.Manifest;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipFile;
 import java.util.zip.ZipInputStream;
@@ -432,6 +435,35 @@ public void orderingOfAutomaticallyCreatedDirectoriesIsConduciveToSensibleUnpack
     assertTrue(indexOfQux > indexOfBaz);
   }
 
+  @Test
+  public void mergedJarManifestSpecialAttributesAreHandled() throws IOException {
+    // This is required to allow JarInputStream to read the manifest properly
+    Path inputOne = temp.newFile("one.jar").toPath();
+
+    Manifest firstManifest = new Manifest();
+    firstManifest.getMainAttributes().put(Attributes.Name.MANIFEST_VERSION, "1.0");
+    firstManifest.getMainAttributes().put(new Attributes.Name("First"), "foo");
+    firstManifest.getMainAttributes().put(new Attributes.Name("Target-Label"), "@secret_corp//:foo");
+    ByteArrayOutputStream bos = new ByteArrayOutputStream();
+    firstManifest.write(bos);
+
+    createJar(
+            inputOne,
+            ImmutableMap.of(
+                    "META-INF/MANIFEST.MF", bos.toString("UTF-8")));
+
+    Path outputJar = temp.newFile("out.jar").toPath();
+
+    MergeJars.main(new String[]{
+            "--output", outputJar.toAbsolutePath().toString(),
+            "--sources", inputOne.toAbsolutePath().toString()});
+
+    try (JarFile jar = new JarFile(outputJar.toFile())) {
+      assertTrue(jar.getManifest().getMainAttributes().containsKey(new Attributes.Name("Created-By")));
+      assertFalse(jar.getManifest().getMainAttributes().containsKey(new Attributes.Name("Target-Label")));
+    }
+  }
+
   private void createJar(Path outputTo, Map<String, String> pathToContents) throws IOException {
     try (OutputStream os = Files.newOutputStream(outputTo);
          ZipOutputStream zos = new ZipOutputStream(os)) {