8219997: [TESTBUG] Create test for JFR events in Docker container: CPU, Memory and Process Info

Start docker with limits on CPU/Mem, verify JFR reports correct data

Reviewed-by: egahlin
This commit is contained in:
Mikhailo Seledtsov 2019-03-07 13:20:04 -08:00
parent d48c35db98
commit 6d12ffec19
2 changed files with 194 additions and 0 deletions

View File

@ -0,0 +1,74 @@
/*
* Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
import java.nio.file.Paths;
import jdk.jfr.Recording;
import jdk.jfr.consumer.RecordedEvent;
import jdk.jfr.consumer.RecordingFile;
// This class is intended to run inside a container
public class JfrReporter {
public static final String TEST_REPORTED_CORES="TEST_REPORTED_CORES";
public static final String TEST_REPORTED_MEMORY="TEST_REPORTED_MEMORY";
public static final String TEST_REPORTED_PID="TEST_REPORTED_PID";
public static final String TESTCASE_CPU="cpu";
public static final String TESTCASE_MEMORY="memory";
public static final String TESTCASE_PROCESS="process";
public static void main(String[] args) throws Exception {
String testCase = args[0];
System.out.println("Testcase: " + testCase);
switch (testCase) {
case TESTCASE_CPU:
RecordedEvent event = testEvent("jdk.CPUInformation", "cpu.jfr");
System.out.println(TEST_REPORTED_CORES + "=" + event.getInt("cores"));
break;
case TESTCASE_MEMORY:
event = testEvent("jdk.PhysicalMemory", "memory.jfr");
System.out.println(TEST_REPORTED_MEMORY + "=" + event.getLong("totalSize"));
break;
case TESTCASE_PROCESS:
event = testEvent("jdk.SystemProcess", "process.jfr");
System.out.println(TEST_REPORTED_PID + "=" + event.getString("pid"));
break;
default:
throw new IllegalArgumentException("Invalid test case");
}
}
private static RecordedEvent testEvent(String event, String recordingPath) throws Exception {
System.out.println("========= Testing event: " + event);
Recording r = new Recording();
r.enable(event);
r.setDestination(Paths.get("tmp", recordingPath));
r.start();
r.stop();
RecordedEvent recordedEvent = RecordingFile.readAllEvents(r.getDestination()).get(0);
System.out.println("RecordedEvent: " + recordedEvent);
return recordedEvent;
}
}

View File

@ -0,0 +1,120 @@
/*
* Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/*
* @test
* @summary Ensure that certain JFR events return correct results for resource values
* when run inside Docker container, such as available CPU and memory.
* Also make sure that PIDs are based on value provided by container,
* not by the host system.
* @requires (docker.support & os.maxMemory >= 2g)
* @library /test/lib
* @modules java.base/jdk.internal.misc
* java.management
* jdk.jartool/sun.tools.jar
* @build JfrReporter
* @run driver TestJFREvents
*/
import jdk.test.lib.containers.docker.Common;
import jdk.test.lib.containers.docker.DockerRunOptions;
import jdk.test.lib.containers.docker.DockerTestUtils;
import jdk.test.lib.Utils;
public class TestJFREvents {
private static final String imageName = Common.imageName("jfr-events");
private static final int availableCPUs = Runtime.getRuntime().availableProcessors();
public static void main(String[] args) throws Exception {
System.out.println("Test Environment: detected availableCPUs = " + availableCPUs);
if (!DockerTestUtils.canTestDocker()) {
return;
}
DockerTestUtils.buildJdkDockerImage(imageName, "Dockerfile-BasicTest", "jdk-docker");
try {
// leave one CPU for system and tools, otherwise this test may be unstable
int maxNrOfAvailableCpus = availableCPUs - 1;
for (int i=1; i < maxNrOfAvailableCpus; i = i * 2) {
testCPUInfo(i, i);
}
long MB = 1024*1024;
testMemory("200m", "" + 200*MB);
testMemory("500m", "" + 500*MB);
testMemory("1g", "" + 1024*MB);
testProcessInfo();
} finally {
DockerTestUtils.removeDockerImage(imageName);
}
}
private static void testCPUInfo(int valueToSet, int expectedValue) throws Exception {
Common.logNewTestCase("CPUInfo: --cpus = " + valueToSet);
DockerTestUtils.dockerRunJava(
commonDockerOpts()
.addDockerOpts("--cpus=" + valueToSet)
.addClassOptions(JfrReporter.TESTCASE_CPU))
.shouldHaveExitValue(0)
.shouldContain(JfrReporter.TEST_REPORTED_CORES);
// The following assertion is currently disabled due to JFR reporting incorrect values.
// JFR reports values for the host system as opposed to values for the container.
// @ignore 8219999
// .shouldContain(JfrReporter.TEST_REPORTED_CORES + "=" + expectedValue);
}
private static void testMemory(String valueToSet, String expectedValue) throws Exception {
Common.logNewTestCase("Memory: --memory = " + valueToSet);
DockerTestUtils.dockerRunJava(
commonDockerOpts()
.addDockerOpts("--memory=" + valueToSet)
.addClassOptions(JfrReporter.TESTCASE_MEMORY))
.shouldHaveExitValue(0)
.shouldContain(JfrReporter.TEST_REPORTED_MEMORY + "=" + expectedValue);
}
private static void testProcessInfo() throws Exception {
Common.logNewTestCase("ProcessInfo");
DockerTestUtils.dockerRunJava(
commonDockerOpts()
.addClassOptions(JfrReporter.TESTCASE_PROCESS))
.shouldHaveExitValue(0)
.shouldContain(JfrReporter.TEST_REPORTED_PID + "=1");
}
private static DockerRunOptions commonDockerOpts() {
return new DockerRunOptions(imageName, "/jdk/bin/java", "JfrReporter")
.addDockerOpts("--volume", Utils.TEST_CLASSES + ":/test-classes/")
.addJavaOpts("-cp", "/test-classes/");
}
}