8177471: jlink should use the version from java.base.jmod to find modules
authorsundar
Tue, 14 Nov 2017 08:59:19 +0530
changeset 47737 acfedb75dd51
parent 47736 9f913dffab13
child 47738 e4d7a32e6a91
8177471: jlink should use the version from java.base.jmod to find modules Reviewed-by: mchung, alanb
src/jdk.jlink/share/classes/jdk/tools/jlink/internal/JarArchive.java
src/jdk.jlink/share/classes/jdk/tools/jlink/internal/JlinkTask.java
src/jdk.jlink/share/classes/jdk/tools/jlink/internal/ModularJarArchive.java
test/jdk/tools/jlink/multireleasejar/CheckRuntimeVersion.java
test/jdk/tools/jlink/multireleasejar/JLinkMRJavaBaseVersionTest.java
--- a/src/jdk.jlink/share/classes/jdk/tools/jlink/internal/JarArchive.java	Mon Nov 13 18:14:33 2017 +0100
+++ b/src/jdk.jlink/share/classes/jdk/tools/jlink/internal/JarArchive.java	Tue Nov 14 08:59:19 2017 +0530
@@ -74,14 +74,16 @@
 
     private final Path file;
     private final String moduleName;
+    private final Runtime.Version version;
     // currently processed JarFile
     private JarFile jarFile;
 
-    protected JarArchive(String mn, Path file) {
+    protected JarArchive(String mn, Path file, Runtime.Version version) {
         Objects.requireNonNull(mn);
         Objects.requireNonNull(file);
         this.moduleName = mn;
         this.file = file;
+        this.version = Objects.requireNonNull(version);
     }
 
     @Override
@@ -126,7 +128,7 @@
         if (jarFile != null) {
             jarFile.close();
         }
-        jarFile = new JarFile(file.toFile(), true, ZipFile.OPEN_READ, JarFile.runtimeVersion());
+        jarFile = new JarFile(file.toFile(), true, ZipFile.OPEN_READ, version);
     }
 
     protected JarFile getJarFile() {
--- a/src/jdk.jlink/share/classes/jdk/tools/jlink/internal/JlinkTask.java	Mon Nov 13 18:14:33 2017 +0100
+++ b/src/jdk.jlink/share/classes/jdk/tools/jlink/internal/JlinkTask.java	Tue Nov 14 08:59:19 2017 +0530
@@ -421,6 +421,9 @@
      * the observable modules to those in the transitive closure of
      * the modules specified in {@code limitMods} plus other modules
      * specified in the {@code roots} set.
+     *
+     * @throws IllegalArgumentException if java.base module is present
+     * but its descriptor has no version
      */
     public static ModuleFinder newModuleFinder(List<Path> paths,
                                                Set<String> limitMods,
@@ -429,8 +432,25 @@
         if (Objects.requireNonNull(paths).isEmpty()) {
              throw new IllegalArgumentException("Empty module path");
         }
+
         Path[] entries = paths.toArray(new Path[0]);
-        ModuleFinder finder = ModulePath.of(Runtime.version(), true, entries);
+        Runtime.Version version = Runtime.version();
+        ModuleFinder finder = ModulePath.of(version, true, entries);
+
+        if (finder.find("java.base").isPresent()) {
+            // use the version of java.base module, if present, as
+            // the release version for multi-release JAR files
+            ModuleDescriptor.Version v = finder.find("java.base").get()
+                .descriptor().version().orElseThrow(() ->
+                    new IllegalArgumentException("No version in java.base descriptor")
+                );
+
+            // java.base version is different than the current runtime version
+            version = Runtime.Version.parse(v.toString());
+            if (Runtime.version().major() != version.major()) {
+                finder = ModulePath.of(version, true, entries);
+            }
+        }
 
         // if limitmods is specified then limit the universe
         if (limitMods != null && !limitMods.isEmpty()) {
@@ -744,6 +764,7 @@
         final ByteOrder order;
         final Path packagedModulesPath;
         final boolean ignoreSigning;
+        final Runtime.Version version;
         final Set<Archive> archives;
 
         ImageHelper(Configuration cf,
@@ -754,6 +775,17 @@
             this.order = order;
             this.packagedModulesPath = packagedModulesPath;
             this.ignoreSigning = ignoreSigning;
+
+            // use the version of java.base module, if present, as
+            // the release version for multi-release JAR files
+            this.version = cf.findModule("java.base")
+                .map(ResolvedModule::reference)
+                .map(ModuleReference::descriptor)
+                .flatMap(ModuleDescriptor::version)
+                .map(ModuleDescriptor.Version::toString)
+                .map(Runtime.Version::parse)
+                .orElse(Runtime.version());
+
             this.archives = modsPaths.entrySet().stream()
                                 .map(e -> newArchive(e.getKey(), e.getValue()))
                                 .collect(Collectors.toSet());
@@ -763,7 +795,7 @@
             if (path.toString().endsWith(".jmod")) {
                 return new JmodArchive(module, path);
             } else if (path.toString().endsWith(".jar")) {
-                ModularJarArchive modularJarArchive = new ModularJarArchive(module, path);
+                ModularJarArchive modularJarArchive = new ModularJarArchive(module, path, version);
 
                 Stream<Archive.Entry> signatures = modularJarArchive.entries().filter((entry) -> {
                     String name = entry.name().toUpperCase(Locale.ENGLISH);
--- a/src/jdk.jlink/share/classes/jdk/tools/jlink/internal/ModularJarArchive.java	Mon Nov 13 18:14:33 2017 +0100
+++ b/src/jdk.jlink/share/classes/jdk/tools/jlink/internal/ModularJarArchive.java	Tue Nov 14 08:59:19 2017 +0530
@@ -39,8 +39,8 @@
     private static final String JAR_EXT = ".jar";
     private static final String MODULE_INFO = "module-info.class";
 
-    public ModularJarArchive(String mn, Path jmod) {
-        super(mn, jmod);
+    public ModularJarArchive(String mn, Path jmod, Runtime.Version version) {
+        super(mn, jmod, version);
         String filename = Objects.requireNonNull(jmod.getFileName()).toString();
         if (!filename.endsWith(JAR_EXT)) {
             throw new UnsupportedOperationException("Unsupported format: " + filename);
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/test/jdk/tools/jlink/multireleasejar/CheckRuntimeVersion.java	Tue Nov 14 08:59:19 2017 +0530
@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) 2017, 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 java.lang.module.ModuleDescriptor;
+import java.lang.module.ModuleFinder;
+import java.lang.module.ModuleReference;
+import java.util.Arrays;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+public class CheckRuntimeVersion {
+    public static void main(String... args) {
+        int version = Integer.parseInt(args[0]);
+        if (Runtime.version().major() != version) {
+            throw new RuntimeException(version + " != current runtime version "
+                + Runtime.version());
+        }
+
+        Set<String> expected = Arrays.stream(args, 1, args.length)
+                                     .collect(Collectors.toSet());
+        Set<String> modules = ModuleFinder.ofSystem().findAll().stream()
+            .map(ModuleReference::descriptor)
+            .map(ModuleDescriptor::name)
+            .collect(Collectors.toSet());
+
+        if (!modules.equals(expected)) {
+            throw new RuntimeException("Expected: " + expected +
+                " observable modules: " + modules);
+        }
+    }
+}
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/test/jdk/tools/jlink/multireleasejar/JLinkMRJavaBaseVersionTest.java	Tue Nov 14 08:59:19 2017 +0530
@@ -0,0 +1,163 @@
+/*
+ * Copyright (c) 2017, 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.
+ */
+
+/*
+ * @test
+ * @bug 8177471
+ * @summary  jlink should use the version from java.base.jmod to find modules
+ * @modules java.base/jdk.internal.module
+ * @library /test/lib
+ * @build jdk.test.lib.process.* CheckRuntimeVersion
+ * @run testng/othervm JLinkMRJavaBaseVersionTest
+ */
+
+import java.io.ByteArrayInputStream;
+import java.io.File;
+import java.io.IOException;
+import java.lang.module.ModuleFinder;
+import java.lang.module.ModuleReference;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.List;
+import java.util.jar.JarFile;
+import java.util.spi.ToolProvider;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+import jdk.internal.module.ModulePath;
+import jdk.test.lib.process.ProcessTools;
+import org.testng.Assert;
+import org.testng.annotations.BeforeClass;
+import org.testng.annotations.Test;
+
+public class JLinkMRJavaBaseVersionTest {
+    private static final ToolProvider JAR_TOOL = ToolProvider.findFirst("jar")
+            .orElseThrow(() -> new RuntimeException("jar tool not found"));
+    private static final ToolProvider JAVAC_TOOL = ToolProvider.findFirst("javac")
+            .orElseThrow(() -> new RuntimeException("javac tool not found"));
+    private static final ToolProvider JLINK_TOOL = ToolProvider.findFirst("jlink")
+            .orElseThrow(() -> new RuntimeException("jlink tool not found"));
+
+    private static final Path javaHome = Paths.get(System.getProperty("java.home"));
+
+    // resource text for version 9
+    private byte[] resource9 = ("9 resource file").getBytes();
+    // resource text for current version
+    private byte[] resource = (Runtime.version().major() + " resource file").getBytes();
+
+    static Path getJmods() {
+        Path jmods = Paths.get(System.getProperty("java9.home", javaHome.toString())).resolve("jmods");
+        if (Files.notExists(jmods)) {
+            throw new RuntimeException(jmods + " not found");
+        }
+        return jmods;
+    }
+
+    @BeforeClass
+    public void initialize() throws IOException {
+        Path srcdir = Paths.get(System.getProperty("test.src"));
+
+        // create class files from source
+        Path base = srcdir.resolve("base");
+        Path mr9 = Paths.get("mr9");
+        javac(base, mr9, base.toString());
+
+        // current version
+        Path rt = srcdir.resolve("rt");
+        Path rtmods = Paths.get("rtmods");
+        javac(rt, rtmods, rt.toString());
+
+        // build multi-release jar file with different module-info.class
+        String[] args = {
+                "-cf", "m1.jar",
+                "-C", rtmods.resolve("m1").toString(), ".",
+                "--release ", "9",
+                "-C", mr9.resolve("m1").toString(), "."
+
+        };
+        JAR_TOOL.run(System.out, System.err, args);
+    }
+
+    private void javac(Path source, Path destination, String srcpath) throws IOException {
+        String[] args = Stream.concat(
+                Stream.of("-d", destination.toString(), "--release", "9",
+                          "--module-source-path", srcpath),
+                Files.walk(source)
+                     .map(Path::toString)
+                     .filter(s -> s.endsWith(".java"))
+        ).toArray(String[]::new);
+        int rc = JAVAC_TOOL.run(System.out, System.err, args);
+        Assert.assertEquals(rc, 0);
+    }
+
+    @Test
+    public void basicTest() throws Throwable {
+        if (Files.notExists(javaHome.resolve("lib").resolve("modules"))) {
+            // exploded image
+            return;
+        }
+
+        Runtime.Version version = targetRuntimeVersion();
+        System.out.println("Testing jlink with " + getJmods() + " of target version " + version);
+
+        // use jlink to build image from multi-release jar
+        jlink("m1.jar", "myimage");
+
+        // validate runtime image
+        Path java = Paths.get("myimage", "bin", "java");
+        ProcessTools.executeProcess(java.toString(), "-m", "m1/p.Main");
+
+        // validate the image linked with the proper MR version
+
+        if (version.equalsIgnoreOptional(Runtime.version())) {
+            ProcessTools.executeProcess(java.toString(), "-cp", System.getProperty("test.classes"),
+                                        "CheckRuntimeVersion", String.valueOf(version.major()),
+                                        "java.base", "java.logging", "m1")
+                .shouldHaveExitValue(0);
+        } else {
+            ProcessTools.executeProcess(java.toString(), "-cp", System.getProperty("test.classes"),
+                                        "CheckRuntimeVersion", String.valueOf(version.major()),
+                                        "java.base", "m1")
+                .shouldHaveExitValue(0);
+        }
+    }
+
+    private Runtime.Version targetRuntimeVersion() {
+        ModuleReference mref = ModulePath.of(Runtime.version(), true, getJmods())
+            .find("java.base")
+            .orElseThrow(() -> new RuntimeException("java.base not found from " + getJmods()));
+
+        return Runtime.Version.parse(mref.descriptor().version().get().toString());
+    }
+
+    private void jlink(String jar, String image) {
+        List<String> args = List.of("--output", image,
+                                    "--add-modules", "m1",
+                                    "--module-path",
+                                    getJmods().toString() + File.pathSeparator + jar);
+        System.out.println("jlink " + args.stream().collect(Collectors.joining(" ")));
+        int exitCode = JLINK_TOOL.run(System.out, System.err, args.toArray(new String[0]));
+        Assert.assertEquals(exitCode, 0);
+    }
+}