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