1 /**
   2  * Copyright (c) 2015, 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  * @library ../lib
  32  * @modules java.base/jdk.internal.jimage
  33  *          java.base/jdk.internal.module
  34  *          jdk.jdeps/com.sun.tools.classfile
  35  *          jdk.jlink/jdk.tools.jlink.internal
  36  *          jdk.jlink/jdk.tools.jmod
  37  *          jdk.jlink/jdk.tools.jimage
  38  *          jdk.compiler
  39  * @build tests.*
  40  * @run testng JLinkNegativeTest
  41  */
  42 
  43 import java.io.File;
  44 import java.io.FileOutputStream;
  45 import java.io.IOException;
  46 import java.io.OutputStream;
  47 import java.lang.module.ModuleDescriptor;
  48 import java.nio.file.FileVisitResult;
  49 import java.nio.file.Files;
  50 import java.nio.file.Path;
  51 import java.nio.file.Paths;
  52 import java.nio.file.SimpleFileVisitor;
  53 import java.nio.file.attribute.BasicFileAttributes;
  54 import java.util.Arrays;
  55 import java.util.Collections;
  56 import java.util.List;
  57 import java.util.Set;
  58 import java.util.jar.JarEntry;
  59 import java.util.jar.JarOutputStream;
  60 
  61 import jdk.internal.module.ModuleInfoWriter;
  62 import org.testng.SkipException;
  63 import org.testng.annotations.BeforeClass;
  64 import org.testng.annotations.Test;
  65 import tests.Helper;
  66 import tests.JImageGenerator;
  67 import tests.JImageGenerator.InMemoryFile;
  68 import tests.Result;
  69 
  70 @Test
  71 public class JLinkNegativeTest {
  72 
  73     private Helper helper;
  74 
  75     @BeforeClass
  76     public void setUp() throws IOException {
  77         helper = Helper.newHelper();
  78         if (helper == null) {
  79             throw new SkipException("Not run");
  80         }
  81         helper.generateDefaultModules();
  82     }
  83 
  84     private void deleteDirectory(Path dir) throws IOException {
  85         Files.walkFileTree(dir, new SimpleFileVisitor<Path>() {
  86             @Override
  87             public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
  88                 Files.delete(file);
  89                 return FileVisitResult.CONTINUE;
  90             }
  91 
  92             @Override
  93             public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOException {
  94                 Files.delete(dir);
  95                 return FileVisitResult.CONTINUE;
  96             }
  97         });
  98     }
  99 
 100     public void testModuleNotExist() {
 101         helper.generateDefaultImage("failure1").assertFailure("Error: Module failure1 not found");
 102     }
 103 
 104     public void testNotExistInAddMods() {
 105         // cannot find jmod from --add-modules
 106         JImageGenerator.getJLinkTask()
 107                 .modulePath(".")
 108                 .addMods("not_exist")
 109                 .output(helper.getImageDir().resolve("failure2"))
 110                 .call().assertFailure("Error: Module not_exist not found");
 111     }
 112 
 113     public void test() throws IOException {
 114         helper.generateDefaultJModule("failure3");
 115         Path image = helper.generateDefaultImage("failure3").assertSuccess();
 116         JImageGenerator.getJLinkTask()
 117                 .modulePath(helper.defaultModulePath())
 118                 .output(image)
 119                 .addMods("leaf1")
 120                 .limitMods("leaf1")
 121                 .call().assertFailure("Error: directory already exists: .*failure3.image(\n|\r|.)*");
 122     }
 123 
 124     public void testOutputIsFile() throws IOException {
 125         // output == file
 126         Path image = helper.createNewImageDir("failure4");
 127         Files.createFile(image);
 128         JImageGenerator.getJLinkTask()
 129                 .modulePath(helper.defaultModulePath())
 130                 .output(image)
 131                 .addMods("leaf1")
 132                 .call().assertFailure("Error: directory already exists: .*failure4.image(\n|\r|.)*");
 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 as a root module: " + jarName);
 228         } finally {
 229             jarFile.delete();
 230         }
 231     }
 232 
 233     // Temporarily exclude; the jmod tool can no longer be used to create a jmod
 234     // with a class in the unnamed package. Find another way, or remove.
 235 //    public void testAddDefaultPackage() throws IOException {
 236 //        String moduleName = "hacked1";
 237 //        Path module = helper.generateModuleCompiledClasses(helper.getJmodSrcDir(), helper.getJmodClassesDir(),
 238 //                moduleName, Arrays.asList("hacked1.Main", "A", "B"), "leaf1");
 239 //        JImageGenerator
 240 //                .getJModTask()
 241 //                .addClassPath(module)
 242 //                .jmod(helper.getJmodDir().resolve(moduleName + ".jmod"))
 243 //                .create().assertSuccess();
 244 //        Path image = helper.generateDefaultImage(moduleName).assertSuccess();
 245 //        helper.checkImage(image, moduleName, null, null);
 246 //    }
 247 
 248     public void testAddSomeTopLevelFiles() throws IOException {
 249         String moduleName = "hacked2";
 250         Path module = helper.generateModuleCompiledClasses(helper.getJmodSrcDir(), helper.getJmodClassesDir(),
 251                 moduleName);
 252         Files.createFile(module.resolve("top-level-file"));
 253         Path jmod = JImageGenerator
 254                 .getJModTask()
 255                 .addClassPath(module)
 256                 .jmod(helper.getJmodDir().resolve(moduleName + ".jmod"))
 257                 .create().assertSuccess();
 258         try {
 259             Path image = helper.generateDefaultImage(moduleName).assertSuccess();
 260             helper.checkImage(image, moduleName, null, null);
 261         } finally {
 262             deleteDirectory(jmod);
 263         }
 264     }
 265 
 266     public void testAddNonStandardSection() throws IOException {
 267         String moduleName = "hacked3";
 268         Path module = helper.generateDefaultJModule(moduleName).assertSuccess();
 269         JImageGenerator.addFiles(module, new InMemoryFile("unknown/A.class", new byte[0]));
 270         try {
 271             Result result = helper.generateDefaultImage(moduleName);
 272             System.err.println(result.getMessage());
 273             if (result.getExitCode() == 0) {
 274                 throw new AssertionError("Crash expected");
 275             }
 276         } finally {
 277             deleteDirectory(module);
 278         }
 279     }
 280 
 281     @Test(enabled = true)
 282     public void testSectionsAreFiles() throws IOException {
 283         String moduleName = "hacked4";
 284         Path jmod = helper.generateDefaultJModule(moduleName).assertSuccess();
 285         JImageGenerator.addFiles(jmod,
 286                 new InMemoryFile("/lib", new byte[0]),
 287                 new InMemoryFile("/conf", new byte[0]),
 288                 new InMemoryFile("/bin", new byte[0]));
 289         try {
 290             Result result = helper.generateDefaultImage(moduleName);
 291             System.err.println(result.getMessage());
 292             if (result.getExitCode() == 0) {
 293                 throw new AssertionError("Crash expected");
 294             }
 295         } finally {
 296             deleteDirectory(jmod);
 297         }
 298     }
 299 
 300     public void testDuplicateModule1() throws IOException {
 301         String moduleName1 = "dupRes1Jmod1";
 302         String moduleName2 = "dupRes1Jmod2";
 303         List<String> classNames = Arrays.asList("java.A", "javax.B");
 304         Path module1 = helper.generateModuleCompiledClasses(
 305                 helper.getJmodSrcDir(), helper.getJmodClassesDir(), moduleName1, classNames);
 306         Path module2 = helper.generateModuleCompiledClasses(
 307                 helper.getJmodSrcDir(), helper.getJmodClassesDir(), moduleName2, classNames);
 308 
 309         try (OutputStream out = Files.newOutputStream(module2.resolve("module-info.class"))) {
 310             ModuleInfoWriter.write(ModuleDescriptor.newModule(moduleName1)
 311                     .requires("java.base").build(), out);
 312         }
 313 
 314         Path jmod1 = JImageGenerator.getJModTask()
 315                 .addClassPath(module1)
 316                 .jmod(helper.createNewJmodFile(moduleName1))
 317                 .create()
 318                 .assertSuccess();
 319         Path jmod2 = JImageGenerator.getJModTask()
 320                 .addClassPath(module2)
 321                 .jmod(helper.createNewJmodFile(moduleName2))
 322                 .create()
 323                 .assertSuccess();
 324         try {
 325             helper.generateDefaultImage(moduleName1)
 326                     .assertFailure("Error: Two versions of module dupRes1Jmod1 found in");
 327         } finally {
 328             deleteDirectory(jmod1);
 329             deleteDirectory(jmod2);
 330         }
 331     }
 332 
 333     public void testDuplicateModule2() throws IOException {
 334         String moduleName = "dupRes2Jmod";
 335         List<String> classNames = Arrays.asList("java.A", "javax.B");
 336         Path module1 = helper.generateModuleCompiledClasses(
 337                 helper.getJmodSrcDir(), helper.getJmodClassesDir(), moduleName, classNames);
 338         Path module2 = helper.generateModuleCompiledClasses(
 339                 helper.getJarSrcDir(), helper.getJarClassesDir(), moduleName, classNames);
 340 
 341         Path jmod = JImageGenerator.getJModTask()
 342                 .addClassPath(module1)
 343                 .jmod(helper.createNewJmodFile(moduleName))
 344                 .create()
 345                 .assertSuccess();
 346         Path jar = JImageGenerator.createJarFile(helper.getJarDir().resolve(moduleName + ".jar"), module2);
 347         Path newJar = helper.getJmodDir().resolve(jar.getFileName());
 348         Files.move(jar, newJar);
 349         try {
 350             helper.generateDefaultImage(moduleName)
 351                     .assertFailure("Error: Two versions of module dupRes2Jmod found in");
 352         } finally {
 353             deleteDirectory(jmod);
 354             deleteDirectory(newJar);
 355         }
 356     }
 357 
 358     public void testDuplicateModule3() throws IOException {
 359         String moduleName1 = "dupRes3Jar1";
 360         String moduleName2 = "dupRes3Jar2";
 361         List<String> classNames = Arrays.asList("java.A", "javax.B");
 362         Path module1 = helper.generateModuleCompiledClasses(
 363                 helper.getJarSrcDir(), helper.getJarClassesDir(), moduleName1, classNames);
 364         Path module2 = helper.generateModuleCompiledClasses(
 365                 helper.getJarSrcDir(), helper.getJarClassesDir(), moduleName2, classNames);
 366 
 367         try (OutputStream out = Files.newOutputStream(module2.resolve("module-info.class"))) {
 368             ModuleInfoWriter.write(ModuleDescriptor.newModule(moduleName1)
 369                     .requires("java.base").build(), out);
 370         }
 371 
 372         Path jar1 = JImageGenerator.createJarFile(helper.getJarDir().resolve(moduleName1 + ".jar"), module1);
 373         Path jar2 = JImageGenerator.createJarFile(helper.getJarDir().resolve(moduleName2 + ".jar"), module2);
 374         try {
 375             helper.generateDefaultImage(moduleName1)
 376                     .assertFailure("Error: Two versions of module dupRes3Jar1 found in");
 377         } finally {
 378             deleteDirectory(jar1);
 379             deleteDirectory(jar2);
 380         }
 381     }
 382 
 383     public void testInconsistentModuleInfo() throws IOException {
 384         String moduleName = "inconsistentJar";
 385         List<String> classNames = Arrays.asList("xorg.acme.internal.B");
 386         Path module = helper.generateModuleCompiledClasses(
 387                 helper.getJarSrcDir(), helper.getJarClassesDir(), moduleName, classNames);
 388 
 389         try (OutputStream out = Files.newOutputStream(module.resolve("module-info.class"))) {
 390             ModuleInfoWriter.write(ModuleDescriptor.newModule(moduleName)
 391                     .requires("java.base")
 392                     .packages(Set.of("org.acme.internal"))
 393                     .build(), out);
 394         }
 395 
 396         Path jar = JImageGenerator.createJarFile(helper.getJarDir().resolve(moduleName + ".jar"), module);
 397         try {
 398             helper.generateDefaultImage(moduleName)
 399                   .assertFailure("Module inconsistentJar's descriptor indicates the set of packages is : " +
 400                   "[org.acme.internal], but module contains packages: [xorg.acme.internal]");
 401         } finally {
 402             deleteDirectory(jar);
 403         }
 404     }
 405 }