4.x: Fail HelidonTests by default when pinning jfr event is detected #…

…8857

Signed-off-by: Jorge Bescos Gascon <[email protected]>

microprofile/testing/junit5/src/main/java/io/helidon/microprofile/testing/junit5/HelidonJunitExtension.java

@@ -59,6 +59,9 @@
 import jakarta.ws.rs.client.Client;
 import jakarta.ws.rs.client.ClientBuilder;
 import jakarta.ws.rs.client.WebTarget;
+import jdk.jfr.consumer.RecordedEvent;
+import jdk.jfr.consumer.RecordedFrame;
+import jdk.jfr.consumer.RecordingStream;
 import org.eclipse.microprofile.config.Config;
 import org.eclipse.microprofile.config.spi.ConfigBuilder;
 import org.eclipse.microprofile.config.spi.ConfigProviderResolver;
@@ -77,6 +80,7 @@
 import org.junit.jupiter.api.extension.ParameterResolver;
 import org.junit.jupiter.api.extension.ReflectiveInvocationContext;
 
+import static org.junit.jupiter.api.Assertions.fail;
 
 /**
  * Junit5 extension to support Helidon CDI container in tests.
@@ -100,7 +104,9 @@ class HelidonJunitExtension implements BeforeAllCallback,
 
     private final List<AddExtension> classLevelExtensions = new ArrayList<>();
     private final List<AddBean> classLevelBeans = new ArrayList<>();
+    private final List<EventWrapper> jfrVTPinned = new ArrayList<>();
     private final ConfigMeta classLevelConfigMeta = new ConfigMeta();
+    private final RecordingStream recordingStream = new RecordingStream();
     private boolean classLevelDisableDiscovery = false;
     private boolean resetPerTest;
 
@@ -113,6 +119,8 @@ class HelidonJunitExtension implements BeforeAllCallback,
     @SuppressWarnings("unchecked")
     @Override
     public void beforeAll(ExtensionContext context) {
+        startRecordingStream();
+
         testClass = context.getRequiredTestClass();
 
         AddConfig[] configs = getAnnotations(testClass, AddConfig.class);
@@ -383,6 +391,27 @@ public void afterAll(ExtensionContext context) {
         stopContainer();
         releaseConfig();
         callAfterStop();
+        closeRecordingStream();
+    }
+
+    private void startRecordingStream() {
+        recordingStream.enable("jdk.VirtualThreadPinned").withStackTrace();
+        recordingStream.onEvent("jdk.VirtualThreadPinned", event -> {
+            jfrVTPinned.add(new EventWrapper(event));
+        });
+        recordingStream.startAsync();
+    }
+
+    private void closeRecordingStream() {
+        try {
+            // Flush ending events
+            recordingStream.stop();
+            if (!jfrVTPinned.isEmpty()) {
+                fail("Some pinned virtual threads were detected:\n" + jfrVTPinned);
+            }
+        } finally {
+            recordingStream.close();
+        }
     }
 
     @Override
@@ -748,4 +777,28 @@ public Class<? extends Extension> value() {
         }
     }
 
+    private static class EventWrapper {
+
+        private final RecordedEvent recordedEvent;
+
+        private EventWrapper(RecordedEvent recordedEvent) {
+            this.recordedEvent = recordedEvent;
+        }
+
+        @Override
+        public String toString() {
+            StringBuilder builder = new StringBuilder(recordedEvent.toString());
+            if (recordedEvent.getStackTrace() != null) {
+                builder.append("full-stackTrace = [");
+                List<RecordedFrame> frames = recordedEvent.getStackTrace().getFrames();
+                for (RecordedFrame frame : frames) {
+                    builder.append("\n\t").append(frame.getMethod().getType().getName())
+                    .append("#").append(frame.getMethod().getName())
+                    .append("(").append(frame.getLineNumber()).append(")");
+                }
+                builder.append("\n]");
+            }
+            return builder.toString();
+        }
+    }
 }

microprofile/testing/junit5/src/main/java/module-info.java

@@ -24,6 +24,7 @@
     requires io.helidon.microprofile.cdi;
     requires jakarta.inject;
     requires org.junit.jupiter.api;
+    requires jdk.jfr;
 
     requires transitive jakarta.cdi;
     requires transitive jakarta.ws.rs;

microprofile/testing/testng/src/main/java/io/helidon/microprofile/testing/testng/HelidonTestNgListener.java

@@ -60,6 +60,9 @@
 import jakarta.inject.Singleton;
 import jakarta.ws.rs.client.Client;
 import jakarta.ws.rs.client.ClientBuilder;
+import jdk.jfr.consumer.RecordedEvent;
+import jdk.jfr.consumer.RecordedFrame;
+import jdk.jfr.consumer.RecordingStream;
 import org.eclipse.microprofile.config.Config;
 import org.eclipse.microprofile.config.spi.ConfigBuilder;
 import org.eclipse.microprofile.config.spi.ConfigProviderResolver;
@@ -71,6 +74,8 @@
 import org.testng.ITestResult;
 import org.testng.annotations.Test;
 
+import static org.testng.Assert.fail;
+
 /**
  * TestNG extension to support Helidon CDI container in tests.
  */
@@ -89,7 +94,9 @@ public class HelidonTestNgListener implements IClassListener, ITestListener {
 
     private List<AddExtension> classLevelExtensions = new ArrayList<>();
     private List<AddBean> classLevelBeans = new ArrayList<>();
+    private List<EventWrapper> jfrVTPinned = new ArrayList<>();
     private ConfigMeta classLevelConfigMeta = new ConfigMeta();
+    private RecordingStream recordingStream;
     private boolean classLevelDisableDiscovery = false;
     private boolean resetPerTest;
 
@@ -100,6 +107,7 @@ public class HelidonTestNgListener implements IClassListener, ITestListener {
 
     @Override
     public void onBeforeClass(ITestClass iTestClass) {
+        startRecordingStream();
 
         testClass = iTestClass.getRealClass();
 
@@ -162,6 +170,7 @@ public void onAfterClass(ITestClass testClass) {
             releaseConfig();
             stopContainer();
         }
+        closeRecordingStream();
     }
 
     @Override
@@ -398,6 +407,26 @@ private void stopContainer() {
         }
     }
 
+    private void startRecordingStream() {
+        recordingStream = new RecordingStream();
+        recordingStream.enable("jdk.VirtualThreadPinned").withStackTrace();
+        recordingStream.onEvent("jdk.VirtualThreadPinned", event -> {
+            jfrVTPinned.add(new EventWrapper(event));
+        });
+        recordingStream.startAsync();
+    }
+
+    private void closeRecordingStream() {
+        try {
+            // Flush ending events
+            recordingStream.stop();
+            if (!jfrVTPinned.isEmpty()) {
+                fail("Some pinned virtual threads were detected:\n" + jfrVTPinned);
+            }
+        } finally {
+            recordingStream.close();
+        }
+    }
 
     @SuppressWarnings("unchecked")
     private <T extends Annotation> T[] getAnnotations(Class<?> testClass, Class<T> annotClass) {
@@ -635,4 +664,29 @@ public Class<? extends Extension> value() {
         }
     }
 
+    private static class EventWrapper {
+
+        private final RecordedEvent recordedEvent;
+
+        private EventWrapper(RecordedEvent recordedEvent) {
+            this.recordedEvent = recordedEvent;
+        }
+
+        @Override
+        public String toString() {
+            StringBuilder builder = new StringBuilder(recordedEvent.toString());
+            if (recordedEvent.getStackTrace() != null) {
+                builder.append("full-stackTrace = [");
+                List<RecordedFrame> frames = recordedEvent.getStackTrace().getFrames();
+                for (RecordedFrame frame : frames) {
+                    builder.append("\n\t").append(frame.getMethod().getType().getName())
+                    .append("#").append(frame.getMethod().getName())
+                    .append("(").append(frame.getLineNumber()).append(")");
+                }
+                builder.append("\n]");
+            }
+            return builder.toString();
+        }
+    }
+
 }

microprofile/testing/testng/src/main/java/module-info.java

@@ -27,6 +27,7 @@
     requires jakarta.cdi;
     requires jakarta.inject;
     requires jakarta.ws.rs;
+    requires jdk.jfr;
     requires microprofile.config.api;
     requires org.testng;
 

microprofile/tests/testing/junit5/src/test/java/io/helidon/microprofile/tests/testing/junit5/TestPinnedThread.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2024 Oracle and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.helidon.microprofile.tests.testing.junit5;
+
+import io.helidon.microprofile.testing.junit5.HelidonTest;
+
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
+
+@HelidonTest
+class TestPinnedThread {
+
+    @Test
+    @Disabled("Enable to verify pinned threads fails")
+    void test() throws InterruptedException {
+        Thread.ofVirtual().start(() -> {
+            synchronized (this) {
+                try {
+                    Thread.sleep(1000);
+                } catch (InterruptedException e) {
+                    Thread.interrupted();
+                }
+            }
+        }).join();
+    }
+}

microprofile/tests/testing/testng/src/test/java/io/helidon/microprofile/tests/testing/testng/TestPinnedThread.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2024 Oracle and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.helidon.microprofile.tests.testing.testng;
+
+import io.helidon.microprofile.testing.testng.HelidonTest;
+
+import org.testng.annotations.Ignore;
+import org.testng.annotations.Test;
+
+@HelidonTest
+class TestPinnedThread {
+
+    @Test
+    @Ignore("Enable to verify pinned threads fails")
+    void test() throws InterruptedException {
+        Thread.ofVirtual().start(() -> {
+            synchronized (this) {
+                try {
+                    Thread.sleep(1000);
+                } catch (InterruptedException e) {
+                    Thread.interrupted();
+                }
+            }
+        }).join();
+    }
+}