8252730: jlink does not create reproducible builds on different servers

Reviewed-by: mchung, alanb

Author: Ian Graves

src/jdk.jlink/share/classes/jdk/tools/jlink/internal/ImageFileCreator.java

@@ -262,14 +262,14 @@ public String getString(int id) {
                 return writer.getString(id);
             }
         });
-
-        for (Archive archive : archives) {
-            String mn = archive.moduleName();
-            entriesForModule.get(mn).stream()
-                .map(e -> new ArchiveEntryResourcePoolEntry(mn,
-                                    e.getResourcePoolEntryName(), e))
+        archives.stream()
+                .map(Archive::moduleName)
+                .sorted()
+                .flatMap(mn ->
+                    entriesForModule.get(mn).stream()
+                            .map(e -> new ArchiveEntryResourcePoolEntry(mn,
+                                    e.getResourcePoolEntryName(), e)))
                 .forEach(resources::add);
-        }
         return resources;
     }
 

test/jdk/tools/jlink/JLinkReproducible2Test.java

@@ -32,6 +32,9 @@
  * @bug 8241602
  * @modules jdk.jlink
  *          java.se
+ *          jdk.management
+ *          jdk.unsupported
+ *          jdk.charsets
  * @run main JLinkReproducible2Test
  */
 public class JLinkReproducible2Test {
@@ -48,7 +51,17 @@ public static void main(String[] args) throws Exception {
         JLINK_TOOL.run(System.out, System.err, "--add-modules", "java.se", "--output", image2.toString());
 
         if (Files.mismatch(image1.resolve("lib").resolve("modules"), image2.resolve("lib").resolve("modules")) != -1L) {
-            new RuntimeException("jlink producing inconsistent result");
+            throw new RuntimeException("jlink producing inconsistent result");
+        }
+
+        Path image3 = Paths.get("./image3");
+        Path image4 = Paths.get("./image4");
+
+        JLINK_TOOL.run(System.out, System.err, "--add-modules", "java.base,jdk.management,jdk.unsupported,jdk.charsets", "--output", image3.toString());
+        JLINK_TOOL.run(System.out, System.err, "--add-modules", "java.base,jdk.management,jdk.unsupported,jdk.charsets", "--output", image4.toString());
+
+        if (Files.mismatch(image3.resolve("lib").resolve("modules"), image4.resolve("lib").resolve("modules")) != -1L) {
+            throw new RuntimeException("jlink producing inconsistent result with multiple named modules");
         }
     }
 }

test/jdk/tools/jlink/JLinkReproducible3Test.java

@@ -0,0 +1,101 @@
+/*
+ * Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+import jdk.test.lib.process.ProcessTools;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.nio.file.*;
+
+import java.nio.file.attribute.BasicFileAttributes;
+import java.util.Optional;
+
+/*
+ * @test
+ * @summary Make sure that jimages are consistent when created by jlink. Copies test jdk and runs against original.
+ * @bug 8252730
+ * @modules jdk.jlink
+ *          jdk.management
+ *          jdk.unsupported
+ *          jdk.charsets
+ * @library /test/lib
+ * @run main JLinkReproducible3Test
+ */
+public class JLinkReproducible3Test {
+
+    public static void main(String[] args) throws Exception {
+        Path image1 = Paths.get("./image1");
+        Path image2 = Paths.get("./image2");
+
+        Path copyJdk1Dir = Path.of("./copy-jdk1-tmpdir");
+        Files.createDirectory(copyJdk1Dir);
+
+        Path copyJdk2Dir = Path.of("./copy-jdk2-tmpdir");
+        Files.createDirectory(copyJdk2Dir);
+
+        Path jdkTestDir = Path.of(
+                Optional.of(
+                        System.getProperty("test.jdk"))
+                        .orElseThrow(() -> new RuntimeException("Couldn't load JDK Test Dir"))
+        );
+
+        copyJDK(jdkTestDir, copyJdk1Dir);
+        copyJDK(jdkTestDir, copyJdk2Dir);
+
+        Path copiedJlink1 = Optional.of(
+                Paths.get(copyJdk1Dir.toString(), "bin", "jlink"))
+                .orElseThrow(() -> new RuntimeException("Unable to load copied jlink")
+                );
+
+        Path copiedJlink2 = Optional.of(
+                Paths.get(copyJdk2Dir.toString(), "bin", "jlink"))
+                .orElseThrow(() -> new RuntimeException("Unable to load copied jlink")
+                );
+
+        runCopiedJlink(copiedJlink1.toString(), "--add-modules", "java.base,jdk.management,jdk.unsupported,jdk.charsets", "--output", image1.toString());
+        runCopiedJlink(copiedJlink2.toString(), "--add-modules", "java.base,jdk.management,jdk.unsupported,jdk.charsets", "--output", image2.toString());
+
+        long mismatch = Files.mismatch(image1.resolve("lib").resolve("modules"), image2.resolve("lib").resolve("modules"));
+        if (mismatch != -1L) {
+            throw new RuntimeException("jlink producing inconsistent result in modules. Mismatch in modules file occurred at byte position " + mismatch);
+        }
+    }
+
+    private static void runCopiedJlink(String... args) throws Exception {
+        var process = new ProcessBuilder(args);
+        var res = ProcessTools.executeProcess(process);
+        res.shouldHaveExitValue(0);
+    }
+
+    private static void copyJDK(Path src, Path dst) throws Exception {
+        Files.walk(src).skip(1).forEach(file -> {
+            try {
+                Files.copy(file, dst.resolve(src.relativize(file)), StandardCopyOption.COPY_ATTRIBUTES);
+            } catch (IOException ioe) {
+                throw new UncheckedIOException(ioe);
+            }
+        });
+    }
+}
+