1 /*
2 * Copyright (c) 2014, 2019, 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.Arrays;
37 import java.util.ArrayList;
38 import java.util.Date;
39
40 /**
41 * This is a test utility class for common AppCDS test functionality.
42 *
43 * Various methods use (String ...) for passing VM options. Note that the order
44 * of the VM options are important in certain cases. Many methods take arguments like
45 *
46 * (String prefix[], String suffix[], String... opts)
47 *
48 * Note that the order of the VM options is:
49 *
50 * prefix + opts + suffix
51 */
52 public class TestCommon extends CDSTestUtils {
53 private static final String JSA_FILE_PREFIX = System.getProperty("user.dir") +
54 File.separator + "appcds-";
55
56 private static final SimpleDateFormat timeStampFormat =
57 new SimpleDateFormat("HH'h'mm'm'ss's'SSS");
58
59 private static final String timeoutFactor =
60 System.getProperty("test.timeout.factor", "1.0");
61
62 private static String currentArchiveName;
63
64 // Call this method to start new archive with new unique name
65 public static void startNewArchiveName() {
66 deletePriorArchives();
67 currentArchiveName = JSA_FILE_PREFIX +
68 timeStampFormat.format(new Date()) + ".jsa";
69 }
70
71 // Call this method to get current archive name
72 public static String getCurrentArchiveName() {
73 return currentArchiveName;
74 }
75
76 // Attempt to clean old archives to preserve space
77 // Archives are large artifacts (20Mb or more), and much larger than
78 // most other artifacts created in jtreg testing.
79 // Therefore it is a good idea to clean the old archives when they are not needed.
80 // In most cases the deletion attempt will succeed; on rare occasion the
81 // delete operation will fail since the system or VM process still holds a handle
82 // to the file; in such cases the File.delete() operation will silently fail, w/o
83 // throwing an exception, thus allowing testing to continue.
84 public static void deletePriorArchives() {
85 File dir = new File(System.getProperty("user.dir"));
86 String files[] = dir.list();
87 for (String name : files) {
88 if (name.startsWith("appcds-") && name.endsWith(".jsa")) {
89 if (!(new File(dir, name)).delete())
90 System.out.println("deletePriorArchives(): delete failed for file " + name);
91 }
92 }
93 }
94
95
96 // Create AppCDS archive using most common args - convenience method
97 // Legacy name preserved for compatibility
98 public static OutputAnalyzer dump(String appJar, String classList[],
99 String... suffix) throws Exception {
100 return createArchive(appJar, classList, suffix);
101 }
102
103
104 // Create AppCDS archive using most common args - convenience method
105 public static OutputAnalyzer createArchive(String appJar, String classList[],
106 String... suffix) throws Exception {
107 AppCDSOptions opts = (new AppCDSOptions()).setAppJar(appJar);
108 opts.setClassList(classList);
109 opts.addSuffix(suffix);
110 return createArchive(opts);
111 }
112
113 // Create AppCDS archive using appcds options
114 public static OutputAnalyzer createArchive(AppCDSOptions opts)
115 throws Exception {
116
117 ArrayList<String> cmd = new ArrayList<String>();
118 startNewArchiveName();
119
120 for (String p : opts.prefix) cmd.add(p);
121
122 if (opts.appJar != null) {
123 cmd.add("-cp");
124 cmd.add(opts.appJar);
125 } else {
126 cmd.add("-Djava.class.path=");
127 }
128
129 cmd.add("-Xshare:dump");
130
131 if (opts.archiveName == null)
132 opts.archiveName = getCurrentArchiveName();
133
134 cmd.add("-XX:SharedArchiveFile=" + opts.archiveName);
135
136 if (opts.classList != null) {
137 File classListFile = makeClassList(opts.classList);
138 cmd.add("-XX:ExtraSharedClassListFile=" + classListFile.getPath());
139 }
140
141 for (String s : opts.suffix) cmd.add(s);
142
143 String[] cmdLine = cmd.toArray(new String[cmd.size()]);
144 ProcessBuilder pb = ProcessTools.createJavaProcessBuilder(true, cmdLine);
145 return executeAndLog(pb, "dump");
146 }
147
148
149 // Execute JVM using AppCDS archive with specified AppCDSOptions
150 public static OutputAnalyzer runWithArchive(AppCDSOptions opts)
151 throws Exception {
152 ProcessBuilder pb = createProcessBuilderWithArchive(opts);
153 return executeAndLog(pb, "exec");
154 }
155
156 public static ProcessBuilder createProcessBuilderWithArchive(AppCDSOptions opts)
157 throws Exception {
158
159 ArrayList<String> cmd = new ArrayList<String>();
160
161 for (String p : opts.prefix) cmd.add(p);
162
163 cmd.add("-Xshare:" + opts.xShareMode);
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, cmdLine);
177 return pb;
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 ProcessBuilder createProcessBuilderWithAutoArchive(String... suffix) throws Exception {
215 AppCDSOptions opts = (new AppCDSOptions());
216 opts.addSuffix(suffix).setXShareMode("auto");
217 return createProcessBuilderWithArchive(opts);
218 }
219
220 public static OutputAnalyzer execOff(String... suffix) throws Exception {
221 AppCDSOptions opts = (new AppCDSOptions());
222 opts.addSuffix(suffix).setXShareMode("off");
223 return runWithArchive(opts);
224 }
225
226
227 private static AppCDSOptions makeModuleOptions(String prefix[], String upgrademodulepath, String modulepath,
228 String mid, String testClassArgs[]) {
229 AppCDSOptions opts = (new AppCDSOptions());
230
231 opts.addPrefix(prefix);
232 if (upgrademodulepath == null) {
233 opts.addSuffix("-p", modulepath, "-m", mid);
234 } else {
235 opts.addSuffix("--upgrade-module-path", upgrademodulepath,
236 "-p", modulepath, "-m", mid);
237 }
238 opts.addSuffix(testClassArgs);
239 return opts;
240 }
241
242 public static OutputAnalyzer execModule(String prefix[], String upgrademodulepath, String modulepath,
243 String mid, String... testClassArgs)
244 throws Exception {
245 AppCDSOptions opts = makeModuleOptions(prefix, upgrademodulepath, modulepath,
246 mid, testClassArgs);
247 return runWithArchive(opts);
248 }
249
250
251 // A common operation: dump, then check results
252 public static OutputAnalyzer testDump(String appJar, String classList[],
253 String... suffix) throws Exception {
254 OutputAnalyzer output = dump(appJar, classList, suffix);
255 output.shouldContain("Loading classes to share");
256 output.shouldHaveExitValue(0);
257 return output;
258 }
259
260
261 /**
262 * Simple test -- dump and execute appJar with the given classList in classlist.
263 */
264 public static OutputAnalyzer test(String appJar, String classList[], String... args)
265 throws Exception {
266 testDump(appJar, classList);
267
268 OutputAnalyzer output = exec(appJar, args);
269 return checkExec(output);
270 }
271
272
273 public static OutputAnalyzer checkExecReturn(OutputAnalyzer output, int ret,
274 boolean checkContain, String... matches) throws Exception {
275 try {
276 for (String s : matches) {
277 if (checkContain) {
278 output.shouldContain(s);
279 } else {
280 output.shouldNotContain(s);
281 }
282 }
283 output.shouldHaveExitValue(ret);
284 } catch (Exception e) {
285 checkCommonExecExceptions(output, e);
286 }
287
288 return output;
289 }
290
291
292 // Convenience concatenation utils
293 public static String[] list(String ...args) {
294 return args;
295 }
296
297
298 public static String[] list(String arg, int count) {
299 ArrayList<String> stringList = new ArrayList<String>();
300 for (int i = 0; i < count; i++) {
301 stringList.add(arg);
302 }
303
304 String outputArray[] = stringList.toArray(new String[stringList.size()]);
305 return outputArray;
306 }
307
308
309 public static String[] concat(String... args) {
310 return list(args);
311 }
312
313
314 public static String[] concat(String prefix[], String... extra) {
315 ArrayList<String> list = new ArrayList<String>();
316 for (String s : prefix) {
317 list.add(s);
318 }
319 for (String s : extra) {
320 list.add(s);
321 }
322
323 return list.toArray(new String[list.size()]);
324 }
325
326
327 // ===================== Concatenate paths
328 public static String concatPaths(String... paths) {
329 String prefix = "";
330 String s = "";
331 for (String p : paths) {
332 s += prefix;
333 s += p;
334 prefix = File.pathSeparator;
335 }
336 return s;
337 }
338
339
340 public static String getTestJar(String jar) {
341 File jarFile = CDSTestUtils.getTestArtifact(jar, true);
342 if (!jarFile.isFile()) {
343 throw new RuntimeException("Not a regular file: " + jarFile.getPath());
344 }
345 return jarFile.getPath();
346 }
347
348
349 public static String getTestDir(String d) {
350 File dirFile = CDSTestUtils.getTestArtifact(d, true);
351 if (!dirFile.isDirectory()) {
352 throw new RuntimeException("Not a directory: " + dirFile.getPath());
353 }
354 return dirFile.getPath();
355 }
356
357 public static boolean checkOutputStrings(String outputString1,
358 String outputString2,
359 String split_regex) {
360 String[] sa1 = outputString1.split(split_regex);
361 String[] sa2 = outputString2.split(split_regex);
362 Arrays.sort(sa1);
363 Arrays.sort(sa2);
364
365 int i = 0;
366 for (String s : sa1) {
367 if (!s.equals(sa2[i])) {
368 throw new RuntimeException(s + " is different from " + sa2[i]);
369 }
370 i ++;
371 }
372 return true;
373 }
374 }