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