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.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 appClasses[],
99 String... suffix) throws Exception {
100 return createArchive(appJar, appClasses, suffix);
101 }
102
103
104 // Create AppCDS archive using most common args - convenience method
105 public static OutputAnalyzer createArchive(String appJar, String appClasses[],
106 String... suffix) throws Exception {
107 AppCDSOptions opts = (new AppCDSOptions()).setAppJar(appJar)
108 .setAppClasses(appClasses);
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 File classList = makeClassList(opts.appClasses);
119 startNewArchiveName();
120
121 for (String p : opts.prefix) cmd.add(p);
122
123 if (opts.appJar != null) {
124 cmd.add("-cp");
125 cmd.add(opts.appJar);
126 } else {
127 cmd.add("-cp");
128 cmd.add("\"\"");
129 }
130
131 cmd.add("-Xshare:dump");
132 cmd.add("-XX:ExtraSharedClassListFile=" + classList.getPath());
133
134 if (opts.archiveName == null)
135 opts.archiveName = getCurrentArchiveName();
136
137 cmd.add("-XX:SharedArchiveFile=" + opts.archiveName);
138
139 for (String s : opts.suffix) cmd.add(s);
140
141 String[] cmdLine = cmd.toArray(new String[cmd.size()]);
142 ProcessBuilder pb = ProcessTools.createJavaProcessBuilder(true, cmdLine);
143 return executeAndLog(pb, "dump");
144 }
145
146
147 // Execute JVM using AppCDS archive with specified AppCDSOptions
148 public static OutputAnalyzer runWithArchive(AppCDSOptions opts)
149 throws Exception {
150
151 ArrayList<String> cmd = new ArrayList<String>();
152
153 for (String p : opts.prefix) cmd.add(p);
154
155 cmd.add("-Xshare:" + opts.xShareMode);
156 cmd.add("-showversion");
157 cmd.add("-XX:SharedArchiveFile=" + getCurrentArchiveName());
158 cmd.add("-Dtest.timeout.factor=" + timeoutFactor);
159
160 if (opts.appJar != null) {
161 cmd.add("-cp");
162 cmd.add(opts.appJar);
163 }
164
165 for (String s : opts.suffix) cmd.add(s);
166
167 String[] cmdLine = cmd.toArray(new String[cmd.size()]);
168 ProcessBuilder pb = ProcessTools.createJavaProcessBuilder(true, cmdLine);
169 return executeAndLog(pb, "exec");
170 }
171
172
173 public static OutputAnalyzer execCommon(String... suffix) throws Exception {
174 AppCDSOptions opts = (new AppCDSOptions());
175 opts.addSuffix(suffix);
176 return runWithArchive(opts);
177 }
178
179 // This is the new API for running a Java process with CDS enabled.
180 // See comments in the CDSTestUtils.Result class for how to use this method.
181 public static Result run(String... suffix) throws Exception {
182 AppCDSOptions opts = (new AppCDSOptions());
183 opts.addSuffix(suffix);
184 return new Result(opts, runWithArchive(opts));
185 }
186
187 public static OutputAnalyzer exec(String appJar, String... suffix) throws Exception {
188 AppCDSOptions opts = (new AppCDSOptions()).setAppJar(appJar);
189 opts.addSuffix(suffix);
190 return runWithArchive(opts);
191 }
192
193 public static Result runWithModules(String prefix[], String upgrademodulepath, String modulepath,
194 String mid, String... testClassArgs) throws Exception {
195 AppCDSOptions opts = makeModuleOptions(prefix, upgrademodulepath, modulepath,
196 mid, testClassArgs);
197 return new Result(opts, runWithArchive(opts));
198 }
199
200 public static OutputAnalyzer execAuto(String... suffix) throws Exception {
201 AppCDSOptions opts = (new AppCDSOptions());
202 opts.addSuffix(suffix).setXShareMode("auto");
203 return runWithArchive(opts);
204 }
205
206 public static OutputAnalyzer execOff(String... suffix) throws Exception {
207 AppCDSOptions opts = (new AppCDSOptions());
208 opts.addSuffix(suffix).setXShareMode("off");
209 return runWithArchive(opts);
210 }
211
212
213 private static AppCDSOptions makeModuleOptions(String prefix[], String upgrademodulepath, String modulepath,
214 String mid, String testClassArgs[]) {
215 AppCDSOptions opts = (new AppCDSOptions());
216
217 opts.addPrefix(prefix);
218 if (upgrademodulepath == null) {
219 opts.addSuffix("-p", modulepath, "-m", mid);
220 } else {
221 opts.addSuffix("--upgrade-module-path", upgrademodulepath,
222 "-p", modulepath, "-m", mid);
223 }
224 opts.addSuffix(testClassArgs);
225 return opts;
226 }
227
228 public static OutputAnalyzer execModule(String prefix[], String upgrademodulepath, String modulepath,
229 String mid, String... testClassArgs)
230 throws Exception {
231 AppCDSOptions opts = makeModuleOptions(prefix, upgrademodulepath, modulepath,
232 mid, testClassArgs);
233 return runWithArchive(opts);
234 }
235
236
237 // A common operation: dump, then check results
238 public static OutputAnalyzer testDump(String appJar, String appClasses[],
239 String... suffix) throws Exception {
240 OutputAnalyzer output = dump(appJar, appClasses, suffix);
241 output.shouldContain("Loading classes to share");
242 output.shouldHaveExitValue(0);
243 return output;
244 }
245
246
247 /**
248 * Simple test -- dump and execute appJar with the given appClasses in classlist.
249 */
250 public static OutputAnalyzer test(String appJar, String appClasses[], String... args)
251 throws Exception {
252 testDump(appJar, appClasses);
253
254 OutputAnalyzer output = exec(appJar, args);
255 return checkExec(output);
256 }
257
258
259 public static OutputAnalyzer checkExecReturn(OutputAnalyzer output, int ret,
260 boolean checkContain, String... matches) throws Exception {
261 try {
262 for (String s : matches) {
263 if (checkContain) {
264 output.shouldContain(s);
265 } else {
266 output.shouldNotContain(s);
267 }
268 }
269 output.shouldHaveExitValue(ret);
270 } catch (Exception e) {
271 checkCommonExecExceptions(output, e);
272 }
273
274 return output;
275 }
276
277
278 // Convenience concatenation utils
279 public static String[] list(String ...args) {
280 return args;
281 }
282
283
284 public static String[] list(String arg, int count) {
285 ArrayList<String> stringList = new ArrayList<String>();
286 for (int i = 0; i < count; i++) {
287 stringList.add(arg);
288 }
289
290 String outputArray[] = stringList.toArray(new String[stringList.size()]);
291 return outputArray;
292 }
293
294
295 public static String[] concat(String... args) {
296 return list(args);
297 }
298
299
300 public static String[] concat(String prefix[], String... extra) {
301 ArrayList<String> list = new ArrayList<String>();
302 for (String s : prefix) {
303 list.add(s);
304 }
305 for (String s : extra) {
306 list.add(s);
307 }
308
309 return list.toArray(new String[list.size()]);
310 }
311
312
313 // ===================== Concatenate paths
314 public static String concatPaths(String... paths) {
315 String prefix = "";
316 String s = "";
317 for (String p : paths) {
318 s += prefix;
319 s += p;
320 prefix = File.pathSeparator;
321 }
322 return s;
323 }
324
325
326 public static String getTestJar(String jar) {
327 File jarFile = CDSTestUtils.getTestArtifact(jar, true);
328 if (!jarFile.isFile()) {
329 throw new RuntimeException("Not a regular file: " + jarFile.getPath());
330 }
331 return jarFile.getPath();
332 }
333
334
335 public static String getTestDir(String d) {
336 File dirFile = CDSTestUtils.getTestArtifact(d, true);
337 if (!dirFile.isDirectory()) {
338 throw new RuntimeException("Not a directory: " + dirFile.getPath());
339 }
340 return dirFile.getPath();
341 }
342
343 public static boolean checkOutputStrings(String outputString1,
344 String outputString2,
345 String split_regex) {
346 String[] sa1 = outputString1.split(split_regex);
347 String[] sa2 = outputString2.split(split_regex);
348 Arrays.sort(sa1);
349 Arrays.sort(sa2);
350
351 int i = 0;
352 for (String s : sa1) {
353 if (!s.equals(sa2[i])) {
354 throw new RuntimeException(s + " is different from " + sa2[i]);
355 }
356 i ++;
357 }
358 return true;
359 }
360 }