test/lib/jdk/test/lib/cds/CDSTestUtils.java
author mseledtsov
Tue, 18 Apr 2017 14:18:37 -0700
changeset 46207 7e77d58073d6
child 46220 c9a98ebe678b
permissions -rw-r--r--
8177728: [TESTBUG] Improve CDS test utils Summary: Improved and expanded CDS test utils; updated CDS tests to use new utils. Reviewed-by: jiangli, ccheung
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
46207
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
     1
/*
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
     2
 * Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
     4
 *
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
     7
 * published by the Free Software Foundation.
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
     8
 *
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    13
 * accompanied this code).
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    14
 *
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    18
 *
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    21
 * questions.
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    22
 */
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    23
package jdk.test.lib.cds;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    24
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    25
import java.io.IOException;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    26
import java.io.File;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    27
import java.io.FileOutputStream;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    28
import java.io.PrintStream;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    29
import java.util.ArrayList;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    30
import jdk.test.lib.Utils;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    31
import jdk.test.lib.process.OutputAnalyzer;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    32
import jdk.test.lib.process.ProcessTools;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    33
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    34
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    35
// This class contains common test utilities for testing CDS
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    36
public class CDSTestUtils {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    37
    // Specify this property to copy sdandard output of the child test process to
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    38
    // the parent/main stdout of the test.
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    39
    // By default such output is logged into a file, but not copied into the main stdout
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    40
    // to avoid excessive log pollution. See executeAndLog() for details
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    41
    public static final boolean CopyChildStdoutToMainStdout =
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    42
        Boolean.getBoolean("test.cds.copy.child.stdout");
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    43
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    44
    // This property is passed to child test processes
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    45
    public static final String TestTimeoutFactor = System.getProperty("test.timeout.factor", "1.0");
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    46
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    47
    public static final String UnableToMapMsg =
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    48
        "Unable to map shared archive: test did not complete; assumed PASS";
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    49
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    50
    // Create bootstrap CDS archive,
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    51
    // use extra JVM command line args as a prefix.
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    52
    // For CDS tests specifying prefix makes more sense than specifying suffix, since
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    53
    // normally there are no classes or arguments to classes, just "-version"
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    54
    // To specify suffix explicitly use CDSOptions.addSuffix()
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    55
    public static OutputAnalyzer createArchive(String... cliPrefix)
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    56
        throws Exception {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    57
        return createArchive((new CDSOptions()).addPrefix(cliPrefix));
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    58
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    59
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    60
    // Create bootstrap CDS archive
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    61
    public static OutputAnalyzer createArchive(CDSOptions opts)
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    62
        throws Exception {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    63
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    64
        ArrayList<String> cmd = new ArrayList<String>();
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    65
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    66
        for (String p : opts.prefix) cmd.add(p);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    67
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    68
        cmd.add("-Xshare:dump");
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    69
        cmd.add("-XX:+PrintSharedSpaces");
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    70
        cmd.add("-XX:+UnlockDiagnosticVMOptions");
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    71
        if (opts.archiveName == null)
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    72
            opts.archiveName = getDefaultArchiveName();
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    73
        cmd.add("-XX:SharedArchiveFile=./" + opts.archiveName);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    74
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    75
        for (String s : opts.suffix) cmd.add(s);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    76
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    77
        String[] cmdLine = cmd.toArray(new String[cmd.size()]);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    78
        ProcessBuilder pb = ProcessTools.createJavaProcessBuilder(true, cmdLine);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    79
        return executeAndLog(pb, "dump");
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    80
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    81
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    82
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    83
    // check result of 'dump-the-archive' operation, that is "-Xshare:dump"
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    84
    public static OutputAnalyzer checkDump(OutputAnalyzer output, String... extraMatches)
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    85
        throws Exception {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    86
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    87
        output.shouldContain("Loading classes to share");
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    88
        output.shouldHaveExitValue(0);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    89
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    90
        for (String match : extraMatches) {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    91
            output.shouldContain(match);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    92
        }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    93
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    94
        return output;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    95
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    96
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    97
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    98
    // A commonly used convenience methods to create an archive and check the results
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
    99
    // Creates an archive and checks for errors
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   100
    public static OutputAnalyzer createArchiveAndCheck(CDSOptions opts)
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   101
        throws Exception {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   102
        return checkDump(createArchive(opts));
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   103
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   104
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   105
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   106
    public static OutputAnalyzer createArchiveAndCheck(String... cliPrefix)
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   107
        throws Exception {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   108
        return checkDump(createArchive(cliPrefix));
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   109
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   110
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   111
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   112
    // This method should be used to check the output of child VM for common exceptions.
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   113
    // Most of CDS tests deal with child VM processes for creating and using the archive.
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   114
    // However exceptions that occur in the child process do not automatically propagate
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   115
    // to the parent process. This mechanism aims to improve the propagation
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   116
    // of exceptions and common errors.
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   117
    // Exception e argument - an exception to be re-thrown if none of the common
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   118
    // exceptions match. Pass null if you wish not to re-throw any exception.
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   119
    public static void checkCommonExecExceptions(OutputAnalyzer output, Exception e)
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   120
        throws Exception {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   121
        if (output.getStdout().contains("http://bugreport.java.com/bugreport/crash.jsp")) {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   122
            throw new RuntimeException("Hotspot crashed");
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   123
        }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   124
        if (output.getStdout().contains("TEST FAILED")) {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   125
            throw new RuntimeException("Test Failed");
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   126
        }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   127
        if (output.getOutput().contains("shared class paths mismatch")) {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   128
            throw new RuntimeException("shared class paths mismatch");
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   129
        }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   130
        if (output.getOutput().contains("Unable to unmap shared space")) {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   131
            throw new RuntimeException("Unable to unmap shared space");
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   132
        }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   133
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   134
        // Special case -- sometimes Xshare:on fails because it failed to map
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   135
        // at given address. This behavior is platform-specific, machine config-specific
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   136
        // and can be random (see ASLR).
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   137
        if (isUnableToMap(output)) {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   138
            System.out.println(UnableToMapMsg);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   139
            return;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   140
        }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   141
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   142
        if (e != null)
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   143
            throw e;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   144
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   145
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   146
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   147
    // Check the output for indication that mapping of the archive failed.
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   148
    // Performance note: this check seems to be rather costly - searching the entire
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   149
    // output stream of a child process for multiple strings. However, it is necessary
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   150
    // to detect this condition, a failure to map an archive, since this is not a real
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   151
    // failure of the test or VM operation, and results in a test being "skipped".
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   152
    // Suggestions to improve:
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   153
    // 1. VM can designate a special exit code for such condition.
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   154
    // 2. VM can print a single distinct string indicating failure to map an archive,
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   155
    //    instead of utilizing multiple messages.
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   156
    // These are suggestions to improve testibility of the VM. However, implementing them
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   157
    // could also improve usability in the field.
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   158
    public static boolean isUnableToMap(OutputAnalyzer output) {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   159
        String outStr = output.getOutput();
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   160
        if ((output.getExitValue() == 1) && (
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   161
            outStr.contains("Unable to reserve shared space at required address") ||
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   162
            outStr.contains("Unable to map ReadOnly shared space at required address") ||
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   163
            outStr.contains("Unable to map ReadWrite shared space at required address") ||
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   164
            outStr.contains("Unable to map MiscData shared space at required address") ||
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   165
            outStr.contains("Unable to map MiscCode shared space at required address") ||
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   166
            outStr.contains("Unable to map shared string space at required address") ||
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   167
            outStr.contains("Could not allocate metaspace at a compatible address") ||
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   168
            outStr.contains("Unable to allocate shared string space: range is not within java heap") ))
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   169
        {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   170
            return true;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   171
        }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   172
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   173
        return false;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   174
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   175
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   176
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   177
    // Execute JVM with CDS archive, specify command line args suffix
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   178
    public static OutputAnalyzer runWithArchive(String... cliPrefix)
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   179
        throws Exception {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   180
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   181
        return runWithArchive( (new CDSOptions())
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   182
                               .setArchiveName(getDefaultArchiveName())
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   183
                               .addPrefix(cliPrefix) );
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   184
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   185
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   186
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   187
    // Execute JVM with CDS archive, specify CDSOptions
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   188
    public static OutputAnalyzer runWithArchive(CDSOptions opts)
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   189
        throws Exception {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   190
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   191
        ArrayList<String> cmd = new ArrayList<String>();
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   192
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   193
        for (String p : opts.prefix) cmd.add(p);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   194
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   195
        cmd.add("-Xshare:" + opts.xShareMode);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   196
        cmd.add("-XX:+UnlockDiagnosticVMOptions");
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   197
        cmd.add("-Dtest.timeout.factor=" + TestTimeoutFactor);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   198
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   199
        if (opts.archiveName == null)
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   200
            opts.archiveName = getDefaultArchiveName();
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   201
        cmd.add("-XX:SharedArchiveFile=" + opts.archiveName);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   202
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   203
        if (opts.useVersion)
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   204
            cmd.add("-version");
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   205
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   206
        for (String s : opts.suffix) cmd.add(s);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   207
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   208
        String[] cmdLine = cmd.toArray(new String[cmd.size()]);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   209
        ProcessBuilder pb = ProcessTools.createJavaProcessBuilder(true, cmdLine);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   210
        return executeAndLog(pb, "exec");
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   211
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   212
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   213
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   214
    // A commonly used convenience methods to create an archive and check the results
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   215
    // Creates an archive and checks for errors
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   216
    public static OutputAnalyzer runWithArchiveAndCheck(CDSOptions opts) throws Exception {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   217
        return checkExec(runWithArchive(opts));
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   218
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   219
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   220
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   221
    public static OutputAnalyzer runWithArchiveAndCheck(String... cliPrefix) throws Exception {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   222
        return checkExec(runWithArchive(cliPrefix));
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   223
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   224
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   225
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   226
    public static OutputAnalyzer checkExec(OutputAnalyzer output,
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   227
                                     String... extraMatches) throws Exception {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   228
        CDSOptions opts = new CDSOptions();
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   229
        return checkExec(output, opts, extraMatches);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   230
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   231
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   232
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   233
    // check result of 'exec' operation, that is when JVM is run using the archive
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   234
    public static OutputAnalyzer checkExec(OutputAnalyzer output, CDSOptions opts,
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   235
                                     String... extraMatches) throws Exception {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   236
        try {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   237
            if ("on".equals(opts.xShareMode)) {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   238
                output.shouldContain("sharing");
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   239
            }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   240
            output.shouldHaveExitValue(0);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   241
        } catch (RuntimeException e) {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   242
            checkCommonExecExceptions(output, e);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   243
            return output;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   244
        }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   245
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   246
        checkExtraMatches(output, extraMatches);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   247
        return output;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   248
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   249
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   250
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   251
    public static OutputAnalyzer checkExecExpectError(OutputAnalyzer output,
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   252
                                             int expectedExitValue,
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   253
                                             String... extraMatches) throws Exception {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   254
        if (isUnableToMap(output)) {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   255
            System.out.println(UnableToMapMsg);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   256
            return output;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   257
        }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   258
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   259
        output.shouldHaveExitValue(expectedExitValue);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   260
        checkExtraMatches(output, extraMatches);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   261
        return output;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   262
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   263
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   264
    public static OutputAnalyzer checkExtraMatches(OutputAnalyzer output,
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   265
                                                    String... extraMatches) throws Exception {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   266
        for (String match : extraMatches) {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   267
            output.shouldContain(match);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   268
        }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   269
        return output;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   270
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   271
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   272
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   273
    // get the file object for the test artifact
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   274
    public static File getTestArtifact(String name, boolean checkExistence) {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   275
        File dir = new File(System.getProperty("test.classes", "."));
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   276
        File file = new File(dir, name);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   277
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   278
        if (checkExistence && !file.exists()) {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   279
            throw new RuntimeException("Cannot find " + file.getPath());
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   280
        }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   281
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   282
        return file;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   283
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   284
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   285
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   286
    // create file containing the specified class list
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   287
    public static File makeClassList(String classes[])
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   288
        throws Exception {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   289
        return makeClassList(getTestName() + "-", classes);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   290
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   291
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   292
    // create file containing the specified class list
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   293
    public static File makeClassList(String testCaseName, String classes[])
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   294
        throws Exception {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   295
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   296
        File classList = getTestArtifact(testCaseName + "test.classlist", false);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   297
        FileOutputStream fos = new FileOutputStream(classList);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   298
        PrintStream ps = new PrintStream(fos);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   299
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   300
        addToClassList(ps, classes);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   301
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   302
        ps.close();
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   303
        fos.close();
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   304
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   305
        return classList;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   306
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   307
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   308
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   309
    public static void addToClassList(PrintStream ps, String classes[])
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   310
        throws IOException
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   311
    {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   312
        if (classes != null) {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   313
            for (String s : classes) {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   314
                ps.println(s);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   315
            }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   316
        }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   317
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   318
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   319
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   320
    // Optimization for getting a test name.
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   321
    // Test name does not change during execution of the test,
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   322
    // but getTestName() uses stack walking hence it is expensive.
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   323
    // Therefore cache it and reuse it.
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   324
    private static String testName;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   325
    public static String getTestName() {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   326
        if (testName == null) {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   327
            testName = Utils.getTestName();
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   328
        }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   329
        return testName;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   330
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   331
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   332
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   333
    public static String getDefaultArchiveName() {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   334
        return getTestName() + ".jsa";
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   335
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   336
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   337
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   338
    // ===================== FILE ACCESS convenience methods
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   339
    public static File getOutputFile(String name) {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   340
        File dir = new File(System.getProperty("test.classes", "."));
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   341
        return new File(dir, getTestName() + "-" + name);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   342
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   343
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   344
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   345
    public static File getOutputSourceFile(String name) {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   346
        File dir = new File(System.getProperty("test.classes", "."));
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   347
        return new File(dir, name);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   348
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   349
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   350
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   351
    public static File getSourceFile(String name) {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   352
        File dir = new File(System.getProperty("test.src", "."));
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   353
        return new File(dir, name);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   354
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   355
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   356
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   357
    // ============================= Logging
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   358
    public static OutputAnalyzer executeAndLog(ProcessBuilder pb, String logName) throws Exception {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   359
        long started = System.currentTimeMillis();
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   360
        OutputAnalyzer output = new OutputAnalyzer(pb.start());
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   361
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   362
        writeFile(getOutputFile(logName + ".stdout"), output.getStdout());
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   363
        writeFile(getOutputFile(logName + ".stderr"), output.getStderr());
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   364
        System.out.println("[ELAPSED: " + (System.currentTimeMillis() - started) + " ms]");
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   365
        System.out.println("[STDERR]\n" + output.getStderr());
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   366
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   367
        if (CopyChildStdoutToMainStdout)
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   368
            System.out.println("[STDOUT]\n" + output.getStdout());
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   369
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   370
        return output;
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   371
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   372
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   373
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   374
    private static void writeFile(File file, String content) throws Exception {
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   375
        FileOutputStream fos = new FileOutputStream(file);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   376
        PrintStream ps = new PrintStream(fos);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   377
        ps.print(content);
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   378
        ps.close();
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   379
        fos.close();
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   380
    }
7e77d58073d6 8177728: [TESTBUG] Improve CDS test utils
mseledtsov
parents:
diff changeset
   381
}