add test to verify mirror events

Author: roberttoyonaga

substratevm/src/com.oracle.svm.test/src/com/oracle/svm/test/jfr/TestMirrorEvents.java

@@ -0,0 +1,110 @@
+/*
+ * Copyright (c) 2023, 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2023, 2023, Red Hat Inc. 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.
+ */
+
+package com.oracle.svm.test.jfr;
+
+import jdk.jfr.EventType;
+import jdk.jfr.Recording;
+import jdk.jfr.consumer.RecordedEvent;
+import jdk.jfr.consumer.RecordingFile;
+import org.junit.Test;
+
+import java.nio.file.Path;
+import java.util.List;
+
+import com.oracle.svm.test.jfr.utils.JfrFileParser;
+
+import static org.junit.Assert.assertTrue;
+
+/**
+ * This test checks that JFR mirror events have been set up correctly. If mirror events have not
+ * been set up correctly, then mirrored events will have incorrect metadata. This test verifies that
+ * metadata.
+ */
+public class TestMirrorEvents extends JfrRecordingTest {
+
+    @Test
+    public void test() throws Throwable {
+        Recording recording = new Recording();
+
+        // Disable all events except Mirror Events.
+        recording.enable("jdk.ThreadSleep");
+        recording.enable("jdk.VirtualThreadStart");
+        recording.enable("jdk.VirtualThreadEnd");
+
+        Path path = createTempJfrFile();
+        recording.setDestination(path);
+        recording.start();
+
+        // Generate some mirror event emissions.
+        Runnable eventEmitter = () -> {
+            try {
+                Thread.sleep(100);
+            } catch (Exception e) {
+                throw new RuntimeException(e);
+            }
+        };
+
+        VirtualStressor.execute(1, eventEmitter);
+
+        recording.stop();
+        recording.close();
+
+        // Some standard checks
+        JfrFileParser parser = new JfrFileParser(path);
+        parser.verify();
+
+        boolean foundSleepEvent = false;
+        boolean foundVthreadStartEvent = false;
+        boolean foundVthreadEndEvent = false;
+
+        List<RecordedEvent> recordedEvents = RecordingFile.readAllEvents(path);
+        assertTrue("No events were recorded.", recordedEvents.size() > 0);
+
+        for (RecordedEvent event : recordedEvents) {
+            EventType eventType = event.getEventType();
+
+            assertTrue("Mirror event metadata not applied correctly.", !eventType.getName().equals("jdk.internal.event.ThreadSleepEvent") &&
+                            !eventType.getName().equals("jdk.internal.event.VirtualThreadStartEvent") && !eventType.getName().equals("jdk.internal.event.VirtualThreadEndEvent"));
+
+            System.out.println(eventType.getName());
+            if (eventType.getName().equals("jdk.ThreadSleep") && eventType.getCategoryNames().contains("Java Application") && eventType.getLabel().equals("Java Thread Sleep")) {
+                foundSleepEvent = true;
+            }
+            if (eventType.getName().equals("jdk.VirtualThreadStart") && eventType.getCategoryNames().contains("Java Application") && eventType.getLabel().equals("Virtual Thread Start")) {
+                foundVthreadStartEvent = true;
+            }
+            if (eventType.getName().equals("jdk.VirtualThreadEnd") && eventType.getCategoryNames().contains("Java Application") && eventType.getLabel().equals("Virtual Thread End")) {
+                foundVthreadEndEvent = true;
+            }
+        }
+
+        // The only events recorded should be the mirror events we explicitly enabled. If they were
+        // not found, it means their metadata is incorrect.
+        assertTrue("Mirror events containing correct metadata not found.", foundSleepEvent && foundVthreadStartEvent && foundVthreadEndEvent);
+    }
+
+}