test/jdk/jdk/jfr/jcmd/JcmdHelper.java
author egahlin
Tue, 15 May 2018 20:24:34 +0200
changeset 50113 caf115bb98ad
child 50226 408021edf22f
permissions -rw-r--r--
8199712: Flight Recorder Reviewed-by: coleenp, ihse, erikj, dsamersoff, mseledtsov, egahlin, mgronlun Contributed-by: erik.gahlin@oracle.com, markus.gronlund@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     1
/*
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     2
 * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     4
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    10
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    15
 * accompanied this code).
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    16
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    20
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    23
 * questions.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    24
 */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    25
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    26
package jdk.jfr.jcmd;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    27
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    28
import java.io.File;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    29
import java.util.Arrays;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    30
import java.util.stream.Collectors;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    31
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    32
import jdk.test.lib.Asserts;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    33
import jdk.test.lib.dcmd.CommandExecutor;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    34
import jdk.test.lib.dcmd.PidJcmdExecutor;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    35
import jdk.test.lib.process.OutputAnalyzer;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    36
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    37
public class JcmdHelper {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    38
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    39
    // Wait until recording's state became running
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    40
    public static void waitUntilRunning(String name) throws Exception {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    41
        long timeoutAt = System.currentTimeMillis() + 10000;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    42
        while (true) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    43
            OutputAnalyzer output = jcmdCheck(name, false);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    44
            try {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    45
                // The expected output can look like this:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    46
                // Recording: recording=1 name="Recording 1" (running)
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    47
                output.shouldMatch("^Recording: recording=\\d+\\s+name=\"" + name
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    48
                        + "\".*\\W{1}running\\W{1}");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    49
                return;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    50
            } catch (RuntimeException e) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    51
                if (System.currentTimeMillis() > timeoutAt) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    52
                    Asserts.fail("Recording not started: " + name);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    53
                }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    54
                Thread.sleep(100);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    55
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    56
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    57
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    58
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    59
    // Wait until default recording's state became running
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    60
    public static void waitUntilDefaultRecordingRunning() throws Exception {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    61
        while (true) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    62
            OutputAnalyzer output = jcmd("JFR.check", "recording=0");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    63
            try {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    64
                output.shouldContain("Recording: recording=0 name=\"HotSpot default\" (running)");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    65
                return;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    66
            } catch (RuntimeException e) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    67
                Thread.sleep(100);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    68
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    69
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    70
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    71
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    72
    public static void stopAndCheck(String name) throws Exception {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    73
        jcmd("JFR.stop", "name=\"" + name + "\"");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    74
        assertRecordingNotRunning(name);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    75
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    76
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    77
    public static void stopWriteToFileAndCheck(String name, File file) throws Exception {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    78
        OutputAnalyzer output = jcmd("JFR.stop",
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    79
                "name=\"" + name + "\"",
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    80
                "filename=\"" + file.getAbsolutePath() + "\"");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    81
        JcmdAsserts.assertStoppedAndWrittenTo(output, name, file);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    82
        assertRecordingNotRunning(name);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    83
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    84
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    85
    public static void stopCompressAndCheck(String name, File file) throws Exception {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    86
        OutputAnalyzer output = jcmd("JFR.stop",
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    87
                "name=\"" + name + "\"",
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    88
                "compress=true",
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    89
                "filename=\"" + file.getAbsolutePath() + "\"");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    90
        JcmdAsserts.assertStoppedAndWrittenTo(output, name, file);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    91
        checkAndAssertNoRecordingsAvailable();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    92
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    93
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    94
    public static void stopDefaultRecordingAndCheck() throws Exception {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    95
        OutputAnalyzer output = jcmd("JFR.stop", "recording=0");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    96
        JcmdAsserts.assertStoppedDefaultRecording(output);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    97
        checkAndAssertNoRecordingsAvailable();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    98
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    99
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   100
    public static void checkAndAssertNoRecordingsAvailable() throws Exception {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   101
        OutputAnalyzer output = jcmd("JFR.check");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   102
        JcmdAsserts.assertNoRecordingsAvailable(output);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   103
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   104
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   105
    public static void assertRecordingNotExist(String name) throws Exception {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   106
        OutputAnalyzer output = jcmdCheck(name, false);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   107
        JcmdAsserts.assertRecordingNotExist(output, name);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   108
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   109
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   110
    public static void assertRecordingNotRunning(String name) throws Exception {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   111
        OutputAnalyzer output = jcmdCheck(name, false);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   112
        JcmdAsserts.assertRecordingNotRunning(output, name);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   113
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   114
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   115
    public static void assertRecordingIsRunning(String name) throws Exception {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   116
        OutputAnalyzer output = jcmdCheck(name, false);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   117
        JcmdAsserts.assertRecordingIsRunning(output, name);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   118
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   119
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   120
    public static OutputAnalyzer jcmd(int expectedExitValue, String... args) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   121
        String argsString = Arrays.stream(args).collect(Collectors.joining(" "));
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   122
        CommandExecutor executor = new PidJcmdExecutor();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   123
        OutputAnalyzer oa = executor.execute(argsString);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   124
        oa.shouldHaveExitValue(expectedExitValue);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   125
        return oa;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   126
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   127
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   128
    public static OutputAnalyzer jcmd(String... args) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   129
        return jcmd(0, args);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   130
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   131
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   132
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   133
    public static OutputAnalyzer jcmdCheck(String recordingName, boolean verbose) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   134
        return jcmd("JFR.check", "name=" + recordingName, "verbose=" + verbose);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   135
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   136
}