1 /*
   2  * Copyright (c) 2015, 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  * @library /lib/testlibrary /test/lib
  27  * @modules jdk.compiler
  28  * @build PatchTest JarUtils jdk.testlibrary.*
  29  *        jdk.test.lib.compiler.CompilerUtils
  30  * @run testng PatchTest
  31  * @summary Basic test for --patch-module
  32  */
  33 
  34 import java.io.File;
  35 import java.nio.file.Files;
  36 import java.nio.file.Path;
  37 import java.nio.file.Paths;
  38 import java.util.stream.Collectors;
  39 import java.util.stream.Stream;
  40 
  41 import jdk.test.lib.compiler.CompilerUtils;
  42 import static jdk.testlibrary.ProcessTools.*;
  43 
  44 import org.testng.annotations.BeforeTest;
  45 import org.testng.annotations.Test;
  46 import static org.testng.Assert.*;
  47 
  48 /**
  49  * Compiles and launches a test that uses --patch-module with two directories
  50  * of classes to override existing classes and add new classes to modules in
  51  * the boot layer.
  52  *
  53  * The classes overridden or added via --patch-module all define a public
  54  * no-arg constructor and override toString to return "hi". This allows the
  55  * launched test to check that the overridden classes are loaded.
  56  */
  57 
  58 @Test
  59 public class PatchTest {
  60 
  61     // top-level source directory
  62     private static final String TEST_SRC = System.getProperty("test.src");
  63 
  64     // source/destination tree for the test module
  65     private static final Path SRC_DIR = Paths.get(TEST_SRC, "src");
  66     private static final Path MODS_DIR = Paths.get("mods");
  67 
  68     // source/destination tree for patch tree 1
  69     private static final Path SRC1_DIR = Paths.get(TEST_SRC, "src1");
  70     private static final Path PATCHES1_DIR = Paths.get("patches1");
  71 
  72     // source/destination tree for patch tree 2
  73     private static final Path SRC2_DIR = Paths.get(TEST_SRC, "src2");
  74     private static final Path PATCHES2_DIR = Paths.get("patches2");
  75 
  76     // destination directory for patches packaged as JAR files
  77     private static final Path PATCHES_DIR = Paths.get("patches");
  78 
  79 
  80     // the classes overridden or added with --patch-module
  81     private static final String[] CLASSES = {
  82 
  83         // java.base = boot loader
  84         "java.base/java.text.Annotation",           // override class
  85         "java.base/java.text.AnnotationBuddy",      // add class to package
  86         "java.base/java.lang2.Object",              // new package
  87 
  88         // jdk.naming.dns = platform class loader
  89         "jdk.naming.dns/com.sun.jndi.dns.DnsClient",
  90         "jdk.naming.dns/com.sun.jndi.dns.DnsClientBuddy",
  91         "jdk.naming.dns/com.sun.jndi.dns2.Zone",
  92 
  93         // jdk.compiler = application class loaded
  94         "jdk.compiler/com.sun.tools.javac.Main",
  95         "jdk.compiler/com.sun.tools.javac.MainBuddy",
  96         "jdk.compiler/com.sun.tools.javac2.Main",
  97 
  98     };
  99 
 100 
 101     @BeforeTest
 102     public void setup() throws Exception {
 103 
 104         // javac -d mods/test src/test/**
 105         boolean compiled= CompilerUtils.compile(SRC_DIR.resolve("test"),
 106                                                 MODS_DIR.resolve("test"));
 107         assertTrue(compiled, "classes did not compile");
 108 
 109         // javac --patch-module $MODULE=patches1/$MODULE -d patches1/$MODULE patches1/$MODULE/**
 110         // jar cf patches/$MODULE-1.jar -C patches1/$MODULE .
 111         for (Path src : Files.newDirectoryStream(SRC1_DIR)) {
 112             Path output = PATCHES1_DIR.resolve(src.getFileName());
 113             String mn = src.getFileName().toString();
 114             compiled  = CompilerUtils.compile(src, output,
 115                                               "--patch-module", mn + "=" + src.toString());
 116             assertTrue(compiled, "classes did not compile");
 117             JarUtils.createJarFile(PATCHES_DIR.resolve(mn + "-1.jar"), output);
 118         }
 119 
 120         // javac --patch-module $MODULE=patches2/$MODULE -d patches2/$MODULE patches2/$MODULE/**
 121         // jar cf patches/$MODULE-2.jar -C patches2/$MODULE .
 122         for (Path src : Files.newDirectoryStream(SRC2_DIR)) {
 123             Path output = PATCHES2_DIR.resolve(src.getFileName());
 124             String mn = src.getFileName().toString();
 125             compiled  = CompilerUtils.compile(src, output,
 126                                               "--patch-module", mn + "=" + src.toString());
 127             assertTrue(compiled, "classes did not compile");
 128             JarUtils.createJarFile(PATCHES_DIR.resolve(mn + "-2.jar"), output);
 129         }
 130 
 131     }
 132 
 133     /**
 134      * Run test with patches to java.base, jdk.naming.dns and jdk.compiler
 135      */
 136     void runTest(String basePatches, String dnsPatches, String compilerPatches)
 137         throws Exception
 138     {
 139         // the argument to the test is the list of classes overridden or added
 140         String arg = Stream.of(CLASSES).collect(Collectors.joining(","));
 141 
 142         int exitValue
 143             =  executeTestJava("--patch-module", "java.base=" + basePatches,
 144                                "--patch-module", "jdk.naming.dns=" + dnsPatches,
 145                                "--patch-module", "jdk.compiler=" + compilerPatches,
 146                                "--add-exports", "java.base/java.lang2=test",
 147                                "--add-exports", "jdk.naming.dns/com.sun.jndi.dns=test",
 148                                "--add-exports", "jdk.naming.dns/com.sun.jndi.dns2=test",
 149                                "--add-exports", "jdk.compiler/com.sun.tools.javac2=test",
 150                                "--add-modules", "jdk.naming.dns,jdk.compiler",
 151                                "--module-path", MODS_DIR.toString(),
 152                                "-m", "test/jdk.test.Main", arg)
 153                 .outputTo(System.out)
 154                 .errorTo(System.out)
 155                 .getExitValue();
 156 
 157         assertTrue(exitValue == 0);
 158     }
 159 
 160 
 161     /**
 162      * Run test with ---patch-module and exploded patches
 163      */
 164     public void testWithExplodedPatches() throws Exception {
 165 
 166         // patches1/java.base:patches2/java.base
 167         String basePatches = PATCHES1_DIR.resolve("java.base")
 168                 + File.pathSeparator + PATCHES2_DIR.resolve("java.base");
 169 
 170         String dnsPatches = PATCHES1_DIR.resolve("jdk.naming.dns")
 171                 + File.pathSeparator + PATCHES2_DIR.resolve("jdk.naming.dns");
 172 
 173         String compilerPatches = PATCHES1_DIR.resolve("jdk.compiler")
 174                 + File.pathSeparator + PATCHES2_DIR.resolve("jdk.compiler");
 175 
 176         runTest(basePatches, dnsPatches, compilerPatches);
 177     }
 178 
 179 
 180     /**
 181      * Run test with ---patch-module and patches in JAR files
 182      */
 183     public void testWithJarPatches() throws Exception {
 184 
 185         // patches/java.base-1.jar:patches/java-base-2.jar
 186         String basePatches = PATCHES_DIR.resolve("java.base-1.jar")
 187                 + File.pathSeparator + PATCHES_DIR.resolve("java.base-2.jar");
 188 
 189         String dnsPatches = PATCHES_DIR.resolve("jdk.naming.dns-1.jar")
 190                 +  File.pathSeparator + PATCHES_DIR.resolve("jdk.naming.dns-2.jar");
 191 
 192         String compilerPatches = PATCHES_DIR.resolve("jdk.compiler-1.jar")
 193                 +  File.pathSeparator + PATCHES_DIR.resolve("jdk.compiler-2.jar");
 194 
 195         runTest(basePatches, dnsPatches, compilerPatches);
 196 
 197     }
 198 
 199 
 200     /**
 201      * Run test with ---patch-module and patches in JAR files and exploded patches
 202      */
 203     public void testWithJarAndExplodedPatches() throws Exception {
 204 
 205         // patches/java.base-1.jar:patches2/java.base
 206         String basePatches = PATCHES_DIR.resolve("java.base-1.jar")
 207                 + File.pathSeparator + PATCHES2_DIR.resolve("java.base");
 208 
 209         // patches1/jdk.naming.dns:patches/jdk.naming.dns-2.jar
 210         String dnsPatches = PATCHES1_DIR.resolve("jdk.naming.dns")
 211                 +  File.pathSeparator + PATCHES_DIR.resolve("jdk.naming.dns-2.jar");
 212 
 213         String compilerPatches = PATCHES1_DIR.resolve("jdk.compiler")
 214                 +  File.pathSeparator + PATCHES_DIR.resolve("jdk.compiler-2.jar");
 215 
 216         runTest(basePatches, dnsPatches, compilerPatches);
 217 
 218     }
 219 }