1 /*
2 * Copyright (c) 2014, 2018, 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 import jdk.test.lib.Utils;
26 import jdk.test.lib.BuildHelper;
27 import jdk.test.lib.JDKToolFinder;
28 import jdk.test.lib.Platform;
29 import jdk.test.lib.cds.CDSOptions;
30 import jdk.test.lib.cds.CDSTestUtils;
31 import jdk.test.lib.cds.CDSTestUtils.Result;
32 import jdk.test.lib.process.ProcessTools;
33 import jdk.test.lib.process.OutputAnalyzer;
34 import java.io.File;
35 import java.text.SimpleDateFormat;
36 import java.util.ArrayList;
37 import java.util.Date;
38
39 /**
40 * This is a test utility class for common AppCDS test functionality.
41 *
42 * Various methods use (String ...) for passing VM options. Note that the order
43 * of the VM options are important in certain cases. Many methods take arguments like
44 *
45 * (String prefix[], String suffix[], String... opts)
46 *
47 * Note that the order of the VM options is:
48 *
49 * prefix + opts + suffix
50 */
51 public class TestCommon extends CDSTestUtils {
52 private static final String JSA_FILE_PREFIX = System.getProperty("user.dir") +
53 File.separator + "appcds-";
54
55 private static final SimpleDateFormat timeStampFormat =
56 new SimpleDateFormat("HH'h'mm'm'ss's'SSS");
57
58 private static final String timeoutFactor =
59 System.getProperty("test.timeout.factor", "1.0");
60
61 private static String currentArchiveName;
62
63 // Call this method to start new archive with new unique name
64 public static void startNewArchiveName() {
65 deletePriorArchives();
66 currentArchiveName = JSA_FILE_PREFIX +
67 timeStampFormat.format(new Date()) + ".jsa";
68 }
69
70 // Call this method to get current archive name
71 public static String getCurrentArchiveName() {
72 return currentArchiveName;
73 }
74
75 // Attempt to clean old archives to preserve space
76 // Archives are large artifacts (20Mb or more), and much larger than
77 // most other artifacts created in jtreg testing.
78 // Therefore it is a good idea to clean the old archives when they are not needed.
79 // In most cases the deletion attempt will succeed; on rare occasion the
80 // delete operation will fail since the system or VM process still holds a handle
81 // to the file; in such cases the File.delete() operation will silently fail, w/o
82 // throwing an exception, thus allowing testing to continue.
83 public static void deletePriorArchives() {
84 File dir = new File(System.getProperty("user.dir"));
85 String files[] = dir.list();
86 for (String name : files) {
87 if (name.startsWith("appcds-") && name.endsWith(".jsa")) {
88 if (!(new File(dir, name)).delete())
89 System.out.println("deletePriorArchives(): delete failed for file " + name);
90 }
91 }
92 }
93
94
95 // Create AppCDS archive using most common args - convenience method
96 // Legacy name preserved for compatibility
97 public static OutputAnalyzer dump(String appJar, String appClasses[],
98 String... suffix) throws Exception {
99 return createArchive(appJar, appClasses, suffix);
100 }
101
102
103 // Create AppCDS archive using most common args - convenience method
104 public static OutputAnalyzer createArchive(String appJar, String appClasses[],
105 String... suffix) throws Exception {
106 AppCDSOptions opts = (new AppCDSOptions()).setAppJar(appJar)
107 .setAppClasses(appClasses);
108 opts.addSuffix(suffix);
109 return createArchive(opts);
110 }
111
112 // If you use -XX:+UseAppCDS or -XX:-UseAppCDS in your JVM command-line, call this method
113 // to wrap the arguments.
114 public static String[] makeCommandLineForAppCDS(String... args) throws Exception {
115 return args;
116 }
117
118 // Create AppCDS archive using appcds options
119 public static OutputAnalyzer createArchive(AppCDSOptions opts)
120 throws Exception {
121
122 ArrayList<String> cmd = new ArrayList<String>();
123 File classList = makeClassList(opts.appClasses);
124 startNewArchiveName();
125
126 for (String p : opts.prefix) cmd.add(p);
127
128 if (opts.appJar != null) {
129 cmd.add("-cp");
130 cmd.add(opts.appJar);
131 } else {
132 cmd.add("-cp");
133 cmd.add("\"\"");
134 }
135
136 cmd.add("-Xshare:dump");
137 cmd.add("-Xlog:cds,cds+hashtables");
138 cmd.add("-XX:+UseAppCDS");
139 cmd.add("-XX:ExtraSharedClassListFile=" + classList.getPath());
140
141 if (opts.archiveName == null)
142 opts.archiveName = getCurrentArchiveName();
143
144 cmd.add("-XX:SharedArchiveFile=" + opts.archiveName);
145
146 for (String s : opts.suffix) cmd.add(s);
147
148 String[] cmdLine = cmd.toArray(new String[cmd.size()]);
149 ProcessBuilder pb = ProcessTools.createJavaProcessBuilder(true, makeCommandLineForAppCDS(cmdLine));
150 return executeAndLog(pb, "dump");
151 }
152
153
154 // Execute JVM using AppCDS archive with specified AppCDSOptions
155 public static OutputAnalyzer runWithArchive(AppCDSOptions opts)
156 throws Exception {
157
158 ArrayList<String> cmd = new ArrayList<String>();
159
160 for (String p : opts.prefix) cmd.add(p);
161
162 cmd.add("-Xshare:" + opts.xShareMode);
163 cmd.add("-XX:+UseAppCDS");
164 cmd.add("-showversion");
165 cmd.add("-XX:SharedArchiveFile=" + getCurrentArchiveName());
166 cmd.add("-Dtest.timeout.factor=" + timeoutFactor);
167
168 if (opts.appJar != null) {
169 cmd.add("-cp");
170 cmd.add(opts.appJar);
171 }
172
173 for (String s : opts.suffix) cmd.add(s);
174
175 String[] cmdLine = cmd.toArray(new String[cmd.size()]);
176 ProcessBuilder pb = ProcessTools.createJavaProcessBuilder(true, makeCommandLineForAppCDS(cmdLine));
177 return executeAndLog(pb, "exec");
178 }
179
180
181 public static OutputAnalyzer execCommon(String... suffix) throws Exception {
182 AppCDSOptions opts = (new AppCDSOptions());
183 opts.addSuffix(suffix);
184 return runWithArchive(opts);
185 }
186
187 // This is the new API for running a Java process with CDS enabled.
188 // See comments in the CDSTestUtils.Result class for how to use this method.
189 public static Result run(String... suffix) throws Exception {
190 AppCDSOptions opts = (new AppCDSOptions());
191 opts.addSuffix(suffix);
192 return new Result(opts, runWithArchive(opts));
193 }
194
195 public static OutputAnalyzer exec(String appJar, String... suffix) throws Exception {
196 AppCDSOptions opts = (new AppCDSOptions()).setAppJar(appJar);
197 opts.addSuffix(suffix);
198 return runWithArchive(opts);
199 }
200
201 public static Result runWithModules(String prefix[], String upgrademodulepath, String modulepath,
202 String mid, String... testClassArgs) throws Exception {
203 AppCDSOptions opts = makeModuleOptions(prefix, upgrademodulepath, modulepath,
204 mid, testClassArgs);
205 return new Result(opts, runWithArchive(opts));
206 }
207
208 public static OutputAnalyzer execAuto(String... suffix) throws Exception {
209 AppCDSOptions opts = (new AppCDSOptions());
210 opts.addSuffix(suffix).setXShareMode("auto");
211 return runWithArchive(opts);
212 }
213
214 public static OutputAnalyzer execOff(String... suffix) throws Exception {
215 AppCDSOptions opts = (new AppCDSOptions());
216 opts.addSuffix(suffix).setXShareMode("off");
217 return runWithArchive(opts);
218 }
219
220
221 private static AppCDSOptions makeModuleOptions(String prefix[], String upgrademodulepath, String modulepath,
222 String mid, String testClassArgs[]) {
223 AppCDSOptions opts = (new AppCDSOptions());
224
225 opts.addPrefix(prefix);
226 if (upgrademodulepath == null) {
227 opts.addSuffix("-p", modulepath, "-m", mid);
228 } else {
229 opts.addSuffix("--upgrade-module-path", upgrademodulepath,
230 "-p", modulepath, "-m", mid);
231 }
232 opts.addSuffix(testClassArgs);
233 return opts;
234 }
235
236 public static OutputAnalyzer execModule(String prefix[], String upgrademodulepath, String modulepath,
237 String mid, String... testClassArgs)
238 throws Exception {
239 AppCDSOptions opts = makeModuleOptions(prefix, upgrademodulepath, modulepath,
240 mid, testClassArgs);
241 return runWithArchive(opts);
242 }
243
244
245 // A common operation: dump, then check results
246 public static OutputAnalyzer testDump(String appJar, String appClasses[],
247 String... suffix) throws Exception {
248 OutputAnalyzer output = dump(appJar, appClasses, suffix);
249 output.shouldContain("Loading classes to share");
250 output.shouldHaveExitValue(0);
251 return output;
252 }
253
254
255 /**
256 * Simple test -- dump and execute appJar with the given appClasses in classlist.
257 */
258 public static OutputAnalyzer test(String appJar, String appClasses[], String... args)
259 throws Exception {
260 testDump(appJar, appClasses);
261
262 OutputAnalyzer output = exec(appJar, args);
263 return checkExec(output);
264 }
265
266
267 public static OutputAnalyzer checkExecReturn(OutputAnalyzer output, int ret,
268 boolean checkContain, String... matches) throws Exception {
269 try {
270 for (String s : matches) {
271 if (checkContain) {
272 output.shouldContain(s);
273 } else {
274 output.shouldNotContain(s);
275 }
276 }
277 output.shouldHaveExitValue(ret);
278 } catch (Exception e) {
279 checkCommonExecExceptions(output, e);
280 }
281
282 return output;
283 }
284
285
286 // Convenience concatenation utils
287 public static String[] list(String ...args) {
288 return args;
289 }
290
291
292 public static String[] list(String arg, int count) {
293 ArrayList<String> stringList = new ArrayList<String>();
294 for (int i = 0; i < count; i++) {
295 stringList.add(arg);
296 }
297
298 String outputArray[] = stringList.toArray(new String[stringList.size()]);
299 return outputArray;
300 }
301
302
303 public static String[] concat(String... args) {
304 return list(args);
305 }
306
307
308 public static String[] concat(String prefix[], String... extra) {
309 ArrayList<String> list = new ArrayList<String>();
310 for (String s : prefix) {
311 list.add(s);
312 }
313 for (String s : extra) {
314 list.add(s);
315 }
316
317 return list.toArray(new String[list.size()]);
318 }
319
320
321 // ===================== Concatenate paths
322 public static String concatPaths(String... paths) {
323 String prefix = "";
324 String s = "";
325 for (String p : paths) {
326 s += prefix;
327 s += p;
328 prefix = File.pathSeparator;
329 }
330 return s;
331 }
332
333
334 public static String getTestJar(String jar) {
335 File jarFile = CDSTestUtils.getTestArtifact(jar, true);
336 if (!jarFile.isFile()) {
337 throw new RuntimeException("Not a regular file: " + jarFile.getPath());
338 }
339 return jarFile.getPath();
340 }
341
342
343 public static String getTestDir(String d) {
344 File dirFile = CDSTestUtils.getTestArtifact(d, true);
345 if (!dirFile.isDirectory()) {
346 throw new RuntimeException("Not a directory: " + dirFile.getPath());
347 }
348 return dirFile.getPath();
349 }
350 }