1 /*
2  * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.
8  *
9  * This code is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12  * version 2 for more details (a copy is included in the LICENSE file that
13  * accompanied this code).
14  *
15  * You should have received a copy of the GNU General Public License version
16  * 2 along with this work; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18  *
19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20  * or visit www.oracle.com if you need additional information or have any
21  * questions.
22  *
23  */
24 
25 /**
26  * @test
27  * @requires vm.cds
28  * @library /test/lib /test/hotspot/jtreg/runtime/appcds
29  * @modules jdk.compiler
30  *          jdk.jartool/sun.tools.jar
31  *          jdk.jlink
32  * @run driver MainModuleOnly
33  * @summary Test some scenarios with a main modular jar specified in the --module-path and -cp options in the command line.
34  */
35 
36 import java.io.File;
37 import java.nio.file.Files;
38 import java.nio.file.Path;
39 import java.nio.file.Paths;
40 import java.util.Arrays;
41 
42 import jdk.test.lib.process.OutputAnalyzer;
43 import jdk.test.lib.Platform;
44 
45 public class MainModuleOnly {
46 
47     private static final Path USER_DIR = Paths.get(System.getProperty("user.dir"));
48 
49     private static final String TEST_SRC = System.getProperty("test.src");
50 
51     private static final Path SRC_DIR = Paths.get(TEST_SRC, "src");
52     private static final Path MODS_DIR = Paths.get("mods");
53 
54     // the module name of the test module
55     private static final String TEST_MODULE1 = "com.simple";
56 
57     // the module main class
58     private static final String MAIN_CLASS = "com.simple.Main";
59 
60     private static Path moduleDir = null;
61     private static Path moduleDir2 = null;
62     private static Path destJar = null;
63 
buildTestModule()64     public static void buildTestModule() throws Exception {
65 
66         // javac -d mods/$TESTMODULE --module-path MOD_DIR src/$TESTMODULE/**
67         JarBuilder.compileModule(SRC_DIR.resolve(TEST_MODULE1),
68                                  MODS_DIR.resolve(TEST_MODULE1),
69                                  MODS_DIR.toString());
70 
71 
72         moduleDir = Files.createTempDirectory(USER_DIR, "mlib");
73         moduleDir2 = Files.createTempDirectory(USER_DIR, "mlib2");
74 
75         Path srcJar = moduleDir.resolve(TEST_MODULE1 + ".jar");
76         destJar = moduleDir2.resolve(TEST_MODULE1 + ".jar");
77         String classes = MODS_DIR.resolve(TEST_MODULE1).toString();
78         JarBuilder.createModularJar(srcJar.toString(), classes, MAIN_CLASS);
79         Files.copy(srcJar, destJar);
80 
81     }
82 
main(String... args)83     public static void main(String... args) throws Exception {
84         // compile the modules and create the modular jar files
85         buildTestModule();
86         String appClasses[] = {MAIN_CLASS};
87         // create an archive with both -cp and --module-path in the command line.
88         // Only the class in the modular jar in the --module-path will be archived;
89         // the class in the modular jar in the -cp won't be archived.
90         OutputAnalyzer output = TestCommon.createArchive(
91                                         destJar.toString(), appClasses,
92                                         "--module-path", moduleDir.toString(),
93                                         "-m", TEST_MODULE1);
94         TestCommon.checkDump(output);
95 
96         // run with the archive using the same command line as in dump time.
97         // The main class should be loaded from the archive.
98         TestCommon.run("-Xlog:class+load=trace",
99                        "-cp", destJar.toString(),
100                        "--module-path", moduleDir.toString(),
101                        "-m", TEST_MODULE1)
102             .assertNormalExit("[class,load] com.simple.Main source: shared objects file");
103 
104         // run with the archive with the main class name inserted before the -m.
105         // The main class name will be picked up before the module name. So the
106         // main class should be loaded from the jar in the -cp.
107         TestCommon.run("-Xlog:class+load=trace",
108                        "-cp", destJar.toString(),
109                        "--module-path", moduleDir.toString(),
110                        MAIN_CLASS, "-m", TEST_MODULE1)
111             .assertNormalExit(out ->
112                 out.shouldMatch(".class.load. com.simple.Main source:.*com.simple.jar"));
113 
114         // run with the archive with exploded module. Since during dump time, we
115         // only archive classes from the modular jar in the --module-path, the
116         // main class should be loaded from the exploded module directory.
117         TestCommon.run("-Xlog:class+load=trace",
118                        "-cp", destJar.toString(),
119                        "--module-path", MODS_DIR.toString(),
120                        "-m", TEST_MODULE1 + "/" + MAIN_CLASS)
121             .assertNormalExit(out -> {
122                 out.shouldMatch(".class.load. com.simple.Main source:.*com.simple")
123                    .shouldContain(MODS_DIR.toString());
124             });
125 
126         // run with the archive with the --upgrade-module-path option.
127         // CDS will be disabled with this options and the main class will be
128         // loaded from the modular jar.
129         TestCommon.run("-Xlog:class+load=trace",
130                        "-cp", destJar.toString(),
131                        "--upgrade-module-path", moduleDir.toString(),
132                        "--module-path", moduleDir.toString(),
133                        "-m", TEST_MODULE1)
134             .assertSilentlyDisabledCDS(out -> {
135                 out.shouldHaveExitValue(0)
136                    .shouldMatch("CDS is disabled when the.*option is specified")
137                    .shouldMatch(".class.load. com.simple.Main source:.*com.simple.jar");
138             });
139         // run with the archive with the --limit-modules option.
140         // CDS will be disabled with this options and the main class will be
141         // loaded from the modular jar.
142         TestCommon.run("-Xlog:class+load=trace",
143                        "-cp", destJar.toString(),
144                        "--limit-modules", "java.base," + TEST_MODULE1,
145                        "--module-path", moduleDir.toString(),
146                        "-m", TEST_MODULE1)
147             .assertSilentlyDisabledCDS(out -> {
148                 out.shouldHaveExitValue(0)
149                    .shouldMatch("CDS is disabled when the.*option is specified")
150                    .shouldMatch(".class.load. com.simple.Main source:.*com.simple.jar");
151             });
152         // run with the archive with the --patch-module option.
153         // CDS will be disabled with this options and the main class will be
154         // loaded from the modular jar.
155         TestCommon.run("-Xlog:class+load=trace",
156                        "-cp", destJar.toString(),
157                        "--patch-module", TEST_MODULE1 + "=" + MODS_DIR.toString(),
158                        "--module-path", moduleDir.toString(),
159                        "-m", TEST_MODULE1)
160             .assertSilentlyDisabledCDS(out -> {
161                 out.shouldHaveExitValue(0)
162                    .shouldMatch("CDS is disabled when the.*option is specified")
163                    .shouldMatch(".class.load. com.simple.Main source:.*com.simple.jar");
164             });
165         // modify the timestamp of the jar file
166         (new File(destJar.toString())).setLastModified(System.currentTimeMillis() + 2000);
167         // run with the archive and the jar with modified timestamp.
168         // It should fail due to timestamp of the jar doesn't match the one
169         // used during dump time.
170         TestCommon.run("-cp", destJar.toString(),
171                        "--module-path", moduleDir.toString(),
172                        "-m", TEST_MODULE1)
173             .assertAbnormalExit(
174                 "A jar file is not the one used while building the shared archive file:");
175         // create an archive with a non-empty directory in the --module-path.
176         // The dumping process will exit with an error due to non-empty directory
177         // in the --module-path.
178         output = TestCommon.createArchive(destJar.toString(), appClasses,
179                                           "--module-path", MODS_DIR.toString(),
180                                           "-m", TEST_MODULE1);
181         output.shouldHaveExitValue(1)
182               .shouldMatch("Error: non-empty directory.*com.simple");
183 
184         // test module path with very long length
185         //
186         // This test can't be run on the windows platform due to an existing
187         // issue in ClassLoader::get_canonical_path() (JDK-8190737).
188         if (Platform.isWindows()) {
189             System.out.println("Long module path test cannot be tested on the Windows platform.");
190             return;
191         }
192         Path longDir = USER_DIR;
193         int pathLen = longDir.toString().length();
194         int PATH_LEN = 2034;
195         int MAX_DIR_LEN = 250;
196         while (pathLen < PATH_LEN) {
197             int remaining = PATH_LEN - pathLen;
198             int subPathLen = remaining > MAX_DIR_LEN ? MAX_DIR_LEN : remaining;
199             char[] chars = new char[subPathLen];
200             Arrays.fill(chars, 'x');
201             String subPath = new String(chars);
202             longDir = Paths.get(longDir.toString(), subPath);
203             pathLen = longDir.toString().length();
204         }
205         File longDirFile = new File(longDir.toString());
206         try {
207             longDirFile.mkdirs();
208         } catch (Exception e) {
209             throw e;
210         }
211         Path longDirJar = longDir.resolve(TEST_MODULE1 + ".jar");
212         // IOException results from the Files.copy() call on platform
213         // such as MacOS X. Test can't be proceeded further with the
214         // exception.
215         try {
216             Files.copy(destJar, longDirJar);
217         } catch (java.io.IOException ioe) {
218             System.out.println("Caught IOException from Files.copy(). Cannot continue.");
219             return;
220         }
221         output = TestCommon.createArchive(destJar.toString(), appClasses,
222                                           "-Xlog:exceptions=trace",
223                                           "--module-path", longDirJar.toString(),
224                                           "-m", TEST_MODULE1);
225         if (output.getExitValue() != 0) {
226             output.shouldMatch("os::stat error.*CDS dump aborted");
227         }
228     }
229 }
230