1 /*
2 * Copyright (c) 2015, 2024, 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 * @test
26 * @summary Negative tests for jlink
27 * @bug 8130861
28 * @bug 8174718
29 * @bug 8189671
30 * @author Andrei Eremeev
31 * @modules java.base/jdk.internal.jimage
32 * java.base/jdk.internal.module
33 * jdk.jlink/jdk.tools.jlink.internal
34 * jdk.jlink/jdk.tools.jmod
35 * jdk.jlink/jdk.tools.jimage
36 * jdk.compiler
37 * @library /test/lib ../lib
38 * @build tests.* jdk.test.lib.util.ModuleInfoWriter
39 * @run testng JLinkNegativeTest
40 */
41
42 import java.io.File;
43 import java.io.FileOutputStream;
44 import java.io.IOException;
45 import java.io.OutputStream;
46 import java.lang.module.ModuleDescriptor;
47 import java.nio.file.FileVisitResult;
48 import java.nio.file.Files;
49 import java.nio.file.Path;
50 import java.nio.file.SimpleFileVisitor;
51 import java.nio.file.attribute.BasicFileAttributes;
52 import java.util.Arrays;
53 import java.util.List;
54 import java.util.Set;
55 import java.util.jar.JarEntry;
56 import java.util.jar.JarOutputStream;
57
58 import jdk.test.lib.util.ModuleInfoWriter;
59 import org.testng.SkipException;
60 import org.testng.annotations.BeforeClass;
61 import org.testng.annotations.Test;
62 import tests.Helper;
63 import tests.JImageGenerator;
64 import tests.JImageGenerator.InMemoryFile;
65 import tests.Result;
66
67 @Test
68 public class JLinkNegativeTest {
69
70 private Helper helper;
71
72 @BeforeClass
73 public void setUp() throws IOException {
74 helper = Helper.newHelper();
75 if (helper == null) {
76 throw new SkipException("Not run");
77 }
78 helper.generateDefaultModules();
79 }
80
81 private void deleteDirectory(Path dir) throws IOException {
82 Files.walkFileTree(dir, new SimpleFileVisitor<Path>() {
83 @Override
84 public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
85 Files.delete(file);
86 return FileVisitResult.CONTINUE;
87 }
88
89 @Override
90 public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOException {
91 Files.delete(dir);
92 return FileVisitResult.CONTINUE;
93 }
94 });
95 }
96
97 public void testModuleNotExist() {
98 helper.generateDefaultImage("failure1").assertFailure("Error: Module failure1 not found");
99 }
100
101 public void testNotExistInAddMods() {
102 // cannot find jmod from --add-modules
103 JImageGenerator.getJLinkTask()
104 .modulePath(".")
105 .addMods("not_exist")
106 .output(helper.getImageDir().resolve("failure2"))
107 .call().assertFailure("Error: Module not_exist not found");
108 }
109
110 public void test() throws IOException {
111 helper.generateDefaultJModule("failure3");
112 Path image = helper.generateDefaultImage("failure3").assertSuccess();
113 JImageGenerator.getJLinkTask()
114 .modulePath(helper.defaultModulePath())
115 .output(image)
116 .addMods("leaf1")
117 .limitMods("leaf1")
118 .call().assertFailure("Error: directory already exists: .*failure3.image(\n|\r|.)*");
119 }
120
121 public void testOutputIsFile() throws IOException {
122 // output == file
123 Path image = helper.createNewImageDir("failure4");
124 Files.createFile(image);
125 JImageGenerator.getJLinkTask()
126 .modulePath(helper.defaultModulePath())
127 .output(image)
128 .addMods("leaf1")
129 .call().assertFailure("Error: directory already exists: .*failure4.image(\n|\r|.)*");
130 if (Files.notExists(image)) {
131 throw new RuntimeException("output directory should not have been deleted");
132 }
133 }
134
135 public void testModuleNotFound() {
136 // limit module is not found
137 Path imageFile = helper.createNewImageDir("test");
138 JImageGenerator.getJLinkTask()
139 .output(imageFile)
140 .addMods("leaf1")
141 .limitMods("leaf1")
142 .limitMods("failure5")
143 .modulePath(helper.defaultModulePath())
144 .call().assertFailure("Error: Module failure5 not found");
145 }
146
147 public void testJmodIsDir() throws IOException {
148 Path imageFile = helper.createNewImageDir("test");
149 Path dirJmod = helper.createNewJmodFile("dir");
150 Files.createDirectory(dirJmod);
151 try {
152 JImageGenerator.getJLinkTask()
153 .output(imageFile)
154 .addMods("dir")
155 .modulePath(helper.defaultModulePath())
156 .call().assertFailure("Error: Module dir not found");
157 } finally {
158 deleteDirectory(dirJmod);
159 }
160 }
161
162 public void testJarIsDir() throws IOException {
163 Path imageFile = helper.createNewImageDir("test");
164 Path dirJar = helper.createNewJarFile("dir");
165 Files.createDirectory(dirJar);
166 try {
167 JImageGenerator.getJLinkTask()
168 .output(imageFile)
169 .addMods("dir")
170 .modulePath(helper.defaultModulePath())
171 .call().assertFailure("Error: Module dir not found");
172 } finally {
173 deleteDirectory(dirJar);
174 }
175 }
176
177 public void testMalformedJar() throws IOException {
178 Path imageFile = helper.createNewImageDir("test");
179 Path jar = helper.createNewJarFile("not_zip");
180 Files.createFile(jar);
181 try {
182 JImageGenerator.getJLinkTask()
183 .output(imageFile)
184 .addMods("not_zip")
185 .modulePath(helper.defaultModulePath())
186 .call().assertFailure("Error: Error reading");
187 } finally {
188 deleteDirectory(jar);
189 }
190 }
191
192 public void testMalformedJmod() throws IOException {
193 Path imageFile = helper.createNewImageDir("test");
194 Path jmod = helper.createNewJmodFile("not_zip");
195 Files.createFile(jmod);
196 try {
197 JImageGenerator.getJLinkTask()
198 .output(imageFile)
199 .addMods("not_zip")
200 .modulePath(helper.defaultModulePath())
201 .call().assertFailure("Error: java.io.IOException: Invalid JMOD file");
202 } finally {
203 deleteDirectory(jmod);
204 }
205 }
206
207 private static File createJarFile(File dir, String filename, String pkg, String name) throws IOException {
208 File jarFile = new File(dir, filename + ".jar");
209
210 try (JarOutputStream output = new JarOutputStream(new FileOutputStream(jarFile))) {
211 JarEntry entry = new JarEntry(filename + "/" + pkg + "/" + name);
212 output.putNextEntry(entry);
213 }
214
215 return jarFile;
216 }
217
218 public void testAutomaticModuleAsRoot() throws IOException {
219 Path imageFile = helper.createNewImageDir("test");
220 String jarName = "myautomod";
221 File jarFile = createJarFile(new File("jars"), jarName, "com/acme", "Bar.class");
222 try {
223 JImageGenerator.getJLinkTask()
224 .output(imageFile)
225 .addMods(jarName)
226 .modulePath(helper.defaultModulePath())
227 .call().assertFailure("Error: automatic module cannot be used with jlink: " + jarName);
228 } finally {
229 jarFile.delete();
230 }
231 }
232
233 public void testAutomaticModuleAsDependency() throws IOException {
234 Path imageFile = helper.createNewImageDir("test");
235 String autoJarName = "myautomod";
236 File autoJarFile = createJarFile(new File("jars"), autoJarName, "com/acme", "Bar.class");
237 String rootMod = "autodepender";
238 helper.generateDefaultJModule(rootMod, autoJarName).assertSuccess();
239 try {
240 JImageGenerator.getJLinkTask()
241 .output(imageFile)
242 .addMods(rootMod)
243 .modulePath(helper.defaultModulePath())
244 .call().assertFailure("Error: automatic module cannot be used with jlink: " + autoJarName);
245 } finally {
246 autoJarFile.delete();
247 }
248 }
249
250 // Temporarily exclude; the jmod tool can no longer be used to create a jmod
251 // with a class in the unnamed package. Find another way, or remove.
252 // public void testAddDefaultPackage() throws IOException {
253 // String moduleName = "hacked1";
254 // Path module = helper.generateModuleCompiledClasses(helper.getJmodSrcDir(), helper.getJmodClassesDir(),
255 // moduleName, Arrays.asList("hacked1.Main", "A", "B"), "leaf1");
256 // JImageGenerator
257 // .getJModTask()
258 // .addClassPath(module)
259 // .jmod(helper.getJmodDir().resolve(moduleName + ".jmod"))
260 // .create().assertSuccess();
261 // Path image = helper.generateDefaultImage(moduleName).assertSuccess();
262 // helper.checkImage(image, moduleName, null, null);
263 // }
264
265 public void testAddSomeTopLevelFiles() throws IOException {
266 String moduleName = "hacked2";
267 Path module = helper.generateModuleCompiledClasses(helper.getJmodSrcDir(), helper.getJmodClassesDir(),
268 moduleName);
269 Files.createFile(module.resolve("top-level-file"));
270 Path jmod = JImageGenerator
271 .getJModTask()
272 .addClassPath(module)
273 .jmod(helper.getJmodDir().resolve(moduleName + ".jmod"))
274 .create().assertSuccess();
275 try {
276 Path image = helper.generateDefaultImage(moduleName).assertSuccess();
277 helper.checkImage(image, moduleName, null, null);
278 } finally {
279 deleteDirectory(jmod);
280 }
281 }
282
283 public void testAddNonStandardSection() throws IOException {
284 String moduleName = "hacked3";
285 Path module = helper.generateDefaultJModule(moduleName).assertSuccess();
286 JImageGenerator.addFiles(module, new InMemoryFile("unknown/A.class", new byte[0]));
287 try {
288 Result result = helper.generateDefaultImage(moduleName);
289 System.err.println(result.getMessage());
290 if (result.getExitCode() == 0) {
291 throw new AssertionError("Crash expected");
292 }
293 } finally {
294 deleteDirectory(module);
295 }
296 }
297
298 @Test(enabled = true)
299 public void testSectionsAreFiles() throws IOException {
300 String moduleName = "hacked4";
301 Path jmod = helper.generateDefaultJModule(moduleName).assertSuccess();
302 JImageGenerator.addFiles(jmod,
303 new InMemoryFile("/lib", new byte[0]),
304 new InMemoryFile("/conf", new byte[0]),
305 new InMemoryFile("/bin", new byte[0]));
306 try {
307 Result result = helper.generateDefaultImage(moduleName);
308 System.err.println(result.getMessage());
309 if (result.getExitCode() == 0) {
310 throw new AssertionError("Crash expected");
311 }
312 } finally {
313 deleteDirectory(jmod);
314 }
315 }
316
317 public void testDuplicateModule1() throws IOException {
318 String moduleName1 = "dupRes1Jmod1";
319 String moduleName2 = "dupRes1Jmod2";
320 List<String> classNames = Arrays.asList("java.A", "javax.B");
321 Path module1 = helper.generateModuleCompiledClasses(
322 helper.getJmodSrcDir(), helper.getJmodClassesDir(), moduleName1, classNames);
323 Path module2 = helper.generateModuleCompiledClasses(
324 helper.getJmodSrcDir(), helper.getJmodClassesDir(), moduleName2, classNames);
325
326 try (OutputStream out = Files.newOutputStream(module2.resolve("module-info.class"))) {
327 ModuleInfoWriter.write(ModuleDescriptor.newModule(moduleName1)
328 .requires("java.base").build(), out);
329 }
330
331 Path jmod1 = JImageGenerator.getJModTask()
332 .addClassPath(module1)
333 .jmod(helper.createNewJmodFile(moduleName1))
334 .create()
335 .assertSuccess();
336 Path jmod2 = JImageGenerator.getJModTask()
337 .addClassPath(module2)
338 .jmod(helper.createNewJmodFile(moduleName2))
339 .create()
340 .assertSuccess();
341 try {
342 helper.generateDefaultImage(moduleName1)
343 .assertFailure("Error: Two versions of module dupRes1Jmod1 found in");
344 } finally {
345 deleteDirectory(jmod1);
346 deleteDirectory(jmod2);
347 }
348 }
349
350 public void testDuplicateModule2() throws IOException {
351 String moduleName = "dupRes2Jmod";
352 List<String> classNames = Arrays.asList("java.A", "javax.B");
353 Path module1 = helper.generateModuleCompiledClasses(
354 helper.getJmodSrcDir(), helper.getJmodClassesDir(), moduleName, classNames);
355 Path module2 = helper.generateModuleCompiledClasses(
356 helper.getJarSrcDir(), helper.getJarClassesDir(), moduleName, classNames);
357
358 Path jmod = JImageGenerator.getJModTask()
359 .addClassPath(module1)
360 .jmod(helper.createNewJmodFile(moduleName))
361 .create()
362 .assertSuccess();
363 Path jar = JImageGenerator.createJarFile(helper.getJarDir().resolve(moduleName + ".jar"), module2);
364 Path newJar = helper.getJmodDir().resolve(jar.getFileName());
365 Files.move(jar, newJar);
366 try {
367 helper.generateDefaultImage(moduleName)
368 .assertFailure("Error: Two versions of module dupRes2Jmod found in");
369 } finally {
370 deleteDirectory(jmod);
371 deleteDirectory(newJar);
372 }
373 }
374
375 public void testDuplicateModule3() throws IOException {
376 String moduleName1 = "dupRes3Jar1";
377 String moduleName2 = "dupRes3Jar2";
378 List<String> classNames = Arrays.asList("java.A", "javax.B");
379 Path module1 = helper.generateModuleCompiledClasses(
380 helper.getJarSrcDir(), helper.getJarClassesDir(), moduleName1, classNames);
381 Path module2 = helper.generateModuleCompiledClasses(
382 helper.getJarSrcDir(), helper.getJarClassesDir(), moduleName2, classNames);
383
384 try (OutputStream out = Files.newOutputStream(module2.resolve("module-info.class"))) {
385 ModuleInfoWriter.write(ModuleDescriptor.newModule(moduleName1)
386 .requires("java.base").build(), out);
387 }
388
389 Path jar1 = JImageGenerator.createJarFile(helper.getJarDir().resolve(moduleName1 + ".jar"), module1);
390 Path jar2 = JImageGenerator.createJarFile(helper.getJarDir().resolve(moduleName2 + ".jar"), module2);
391 try {
392 helper.generateDefaultImage(moduleName1)
393 .assertFailure("Error: Two versions of module dupRes3Jar1 found in");
394 } finally {
395 deleteDirectory(jar1);
396 deleteDirectory(jar2);
397 }
398 }
399
400 public void testInconsistentModuleInfo() throws IOException {
401 String moduleName = "inconsistentJar";
402 List<String> classNames = Arrays.asList("xorg.acme.internal.B");
403 Path module = helper.generateModuleCompiledClasses(
404 helper.getJarSrcDir(), helper.getJarClassesDir(), moduleName, classNames);
405
406 try (OutputStream out = Files.newOutputStream(module.resolve("module-info.class"))) {
407 ModuleInfoWriter.write(ModuleDescriptor.newModule(moduleName)
408 .requires("java.base")
409 .packages(Set.of("org.acme.internal"))
410 .build(), out);
411 }
412
413 Path jar = JImageGenerator.createJarFile(helper.getJarDir().resolve(moduleName + ".jar"), module);
414 try {
415 helper.generateDefaultImage(moduleName)
416 .assertFailure("Module inconsistentJar's descriptor indicates the set of packages is : " +
417 "[org.acme.internal], but module contains packages: [xorg.acme.internal]");
418 } finally {
419 deleteDirectory(jar);
420 }
421 }
422 }