1 /*
   2  * Copyright (c) 2017, 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 Testing -Xbootclasspath/a support for CDS
  27  * @library /test/lib
  28  * @modules java.base/jdk.internal.misc
  29  *          java.management
  30  *          jdk.internal.jvmstat/sun.jvmstat.monitor
  31  * @compile javax/sound/sampled/MyClass.jasm
  32  * @compile org/omg/CORBA/Context.jasm
  33  * @compile nonjdk/myPackage/MyClass.java
  34  * @build LoadClass
  35  * @run main/othervm BootAppendTests
  36  */
  37 
  38 import java.io.File;
  39 import java.io.FileOutputStream;
  40 import java.io.IOException;
  41 import java.io.PrintStream;
  42 
  43 import java.nio.file.Path;
  44 import java.nio.file.Paths;
  45 
  46 import jdk.test.lib.cds.CDSOptions;
  47 import jdk.test.lib.cds.CDSTestUtils;
  48 import jdk.test.lib.process.ProcessTools;
  49 import jdk.test.lib.process.OutputAnalyzer;
  50 
  51 public class BootAppendTests {
  52     private static final String APP_CLASS = "LoadClass";
  53     private static final String BOOT_APPEND_MODULE_CLASS = "javax/sound/sampled/MyClass";
  54     private static final String BOOT_APPEND_DUPLICATE_MODULE_CLASS = "org/omg/CORBA/Context";
  55     private static final String BOOT_APPEND_CLASS = "nonjdk/myPackage/MyClass";
  56     private static final String BOOT_APPEND_MODULE_CLASS_NAME =
  57         BOOT_APPEND_MODULE_CLASS.replace('/', '.');
  58     private static final String BOOT_APPEND_DUPLICATE_MODULE_CLASS_NAME =
  59         BOOT_APPEND_DUPLICATE_MODULE_CLASS.replace('/', '.');
  60     private static final String BOOT_APPEND_CLASS_NAME =
  61         BOOT_APPEND_CLASS.replace('/', '.');
  62     private static final String[] ARCHIVE_CLASSES =
  63         {BOOT_APPEND_MODULE_CLASS, BOOT_APPEND_DUPLICATE_MODULE_CLASS, BOOT_APPEND_CLASS};
  64 
  65     private static final String modes[] = {"on", "off"};
  66 
  67     private static String appJar;
  68     private static String bootAppendJar;
  69 
  70     public static void main(String... args) throws Exception {
  71         dumpArchive();
  72 
  73         logTestCase("1");
  74         testBootAppendModuleClass();
  75 
  76         // This test case is currently failing
  77         // TODO: Resolve prior to the final review and integration
  78         // log("TESTCASE: 2");
  79         // testBootAppendDuplicateModuleClass();
  80 
  81         logTestCase("3");
  82         testBootAppendExcludedModuleClass();
  83 
  84         logTestCase("4");
  85         testBootAppendDuplicateExcludedModuleClass();
  86 
  87         logTestCase("5");
  88         testBootAppendClass();
  89     }
  90 
  91     private static void logTestCase(String msg) {
  92         System.out.println();
  93         System.out.printf("TESTCASE: %s", msg);
  94         System.out.println();
  95     }
  96 
  97     static void dumpArchive() throws Exception {
  98         // create the classlist
  99         File classlist = CDSTestUtils.makeClassList(ARCHIVE_CLASSES);
 100 
 101         // build jar files
 102         appJar = ClassFileInstaller.writeJar("app.jar", APP_CLASS);
 103         bootAppendJar = ClassFileInstaller.writeJar("bootAppend.jar",
 104             BOOT_APPEND_MODULE_CLASS, BOOT_APPEND_DUPLICATE_MODULE_CLASS, BOOT_APPEND_CLASS);
 105 
 106 
 107         OutputAnalyzer out = CDSTestUtils.createArchiveAndCheck(
 108                                  "-Xbootclasspath/a:" + bootAppendJar,
 109                                  "-XX:SharedClassListFile=" + classlist.getPath());
 110         // Make sure all the classes were successfully archived.
 111         for (String archiveClass : ARCHIVE_CLASSES) {
 112             out.shouldNotContain("Preload Warning: Cannot find " + archiveClass);
 113         }
 114     }
 115 
 116     // Test #1: If a class on -Xbootclasspath/a is from a package defined in
 117     //          bootmodules, the class is not loaded at runtime.
 118     //          Verify the behavior is the same when the class is archived
 119     //          with CDS enabled at runtime.
 120     //
 121     //          The javax.sound.sampled package is defined in the java.desktop module.
 122     //          The archived javax.sound.sampled.MyClass from the -Xbootclasspath/a
 123     //          should not be loaded at runtime.
 124     public static void testBootAppendModuleClass() throws Exception {
 125         for (String mode : modes) {
 126             CDSOptions opts = (new CDSOptions())
 127                 .setXShareMode(mode).setUseVersion(false)
 128                 .addPrefix("-Xbootclasspath/a:" + bootAppendJar, "-cp", appJar)
 129                 .addSuffix(APP_CLASS, BOOT_APPEND_MODULE_CLASS_NAME);
 130 
 131             CDSTestUtils.runWithArchive(opts)
 132                 .shouldContain("java.lang.ClassNotFoundException: javax.sound.sampled.MyClass");
 133         }
 134     }
 135 
 136     // Test #2: If a class on -Xbootclasspath/a has the same fully qualified
 137     //          name as a class defined in boot modules, the class is not loaded
 138     //          from -Xbootclasspath/a. Verify the behavior is the same at runtime
 139     //          when CDS is enabled.
 140     //
 141     //          The org.omg.CORBA.Context is a boot module class. The class on
 142     //          the -Xbootclasspath/a path that has the same fully-qualified name
 143     //          should not be loaded at runtime when CDS is enabled.
 144     //          The one from the boot modules should be loaded instead.
 145     public static void testBootAppendDuplicateModuleClass() throws Exception {
 146         for (String mode : modes) {
 147             CDSOptions opts = (new CDSOptions())
 148                 .setXShareMode(mode).setUseVersion(false)
 149                 .addPrefix("-Xbootclasspath/a:" + bootAppendJar, "-cp", appJar)
 150                 .addSuffix(APP_CLASS, BOOT_APPEND_DUPLICATE_MODULE_CLASS_NAME);
 151 
 152             CDSTestUtils.runWithArchive(opts)
 153                 .shouldContain("[class,load] org.omg.CORBA.Context source: jrt:/java.corba");
 154         }
 155     }
 156 
 157     // Test #3: If a class on -Xbootclasspath/a is from a package defined in boot modules,
 158     //          the class can be loaded from -Xbootclasspath/a when the module is excluded
 159     //          using --limit-modules. Verify the behavior is the same at runtime when CDS
 160     //          is enabled.
 161     //
 162     //          The java.desktop module is excluded using --limit-modules at runtime,
 163     //          javax.sound.sampled.MyClass is archived from -Xbootclasspath/a. It can be
 164     //          loaded from the archive at runtime.
 165     public static void testBootAppendExcludedModuleClass() throws Exception {
 166         for (String mode : modes) {
 167             CDSOptions opts = (new CDSOptions())
 168                 .setXShareMode(mode).setUseVersion(false)
 169                 .addPrefix("-Xbootclasspath/a:" + bootAppendJar,
 170                            "--limit-modules=java.base", "-cp", appJar)
 171                 .addSuffix("-Xlog:class+load=info",
 172                            APP_CLASS, BOOT_APPEND_MODULE_CLASS_NAME);
 173 
 174             OutputAnalyzer out = CDSTestUtils.runWithArchive(opts)
 175                 .shouldContain("[class,load] javax.sound.sampled.MyClass");
 176 
 177             // When CDS is enabled, the shared class should be loaded from the archive.
 178             if (mode.equals("on")) {
 179                 out.shouldContain("[class,load] javax.sound.sampled.MyClass source: shared objects file");
 180             }
 181         }
 182     }
 183 
 184     // Test #4: If a class on -Xbootclasspath/a has the same fully qualified
 185     //          name as a class defined in boot modules, the class is loaded
 186     //          from -Xbootclasspath/a when the boot module is excluded using
 187     //          --limit-modules. Verify the behavior is the same at runtime
 188     //          when CDS is enabled.
 189     //
 190     //          The org.omg.CORBA.Context is a boot module class. The class
 191     //          on -Xbootclasspath/a that has the same fully-qualified name
 192     //          as org.omg.CORBA.Context can be loaded at runtime when
 193     //          java.corba is excluded.
 194     public static void testBootAppendDuplicateExcludedModuleClass() throws Exception {
 195         for (String mode : modes) {
 196             CDSOptions opts = (new CDSOptions())
 197                 .setXShareMode(mode).setUseVersion(false)
 198                 .addPrefix("-Xbootclasspath/a:" + bootAppendJar,
 199                            "--limit-modules=java.base", "-cp", appJar)
 200                 .addSuffix("-Xlog:class+load=info",
 201                            APP_CLASS, BOOT_APPEND_DUPLICATE_MODULE_CLASS_NAME);
 202 
 203             CDSTestUtils.runWithArchive(opts)
 204                 .shouldContain("[class,load] org.omg.CORBA.Context")
 205                 .shouldMatch(".*\\[class,load\\] org.omg.CORBA.Context source:.*bootAppend.jar");
 206         }
 207     }
 208 
 209     // Test #5: If a class on -Xbootclasspath/a is not from named modules,
 210     //          the class can be loaded at runtime. Verify the behavior is
 211     //          the same at runtime when CDS is enabled.
 212     //
 213     //          The nonjdk.myPackage is not defined in named modules. The
 214     //          archived nonjdk.myPackage.MyClass from -Xbootclasspath/a
 215     //          can be loaded at runtime when CDS is enabled.
 216     public static void testBootAppendClass() throws Exception {
 217         for (String mode : modes) {
 218             CDSOptions opts = (new CDSOptions())
 219                 .setXShareMode(mode).setUseVersion(false)
 220                 .addPrefix("-Xbootclasspath/a:" + bootAppendJar,
 221                            "--limit-modules=java.base", "-cp", appJar)
 222                 .addSuffix("-Xlog:class+load=info",
 223                            APP_CLASS, BOOT_APPEND_CLASS_NAME);
 224 
 225             OutputAnalyzer out = CDSTestUtils.runWithArchive(opts)
 226                 .shouldContain("[class,load] nonjdk.myPackage.MyClass");
 227 
 228             // If CDS is enabled, the nonjdk.myPackage.MyClass should be loaded
 229             // from the shared archive.
 230             if (mode.equals("on")) {
 231                 out.shouldContain(
 232                     "[class,load] nonjdk.myPackage.MyClass source: shared objects file");
 233             }
 234         }
 235     }
 236 }