Add support for @ShouldNotPin/@ShouldPin on superclass

Fix for quarkusio#41782
Allow the usage of @ShouldPin and @ShouldNotPin on super classes

independent-projects/junit5-virtual-threads/pom.xml

@@ -46,6 +46,7 @@
         <impsort-maven-plugin.version>1.11.0</impsort-maven-plugin.version>
 
         <junit.jupiter.version>5.10.3</junit.jupiter.version>
+        <junit.testkit.version>1.10.3</junit.testkit.version>
         <assertj.version>3.26.3</assertj.version>
     </properties>
 
@@ -57,6 +58,11 @@
             <scope>compile</scope>
             <version>${junit.jupiter.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.junit.platform</groupId>
+            <artifactId>junit-platform-testkit</artifactId>
+            <version>${junit.testkit.version}</version>
+        </dependency>
         <dependency>
             <groupId>org.assertj</groupId>
             <artifactId>assertj-core</artifactId>
@@ -135,6 +141,9 @@
                         <!-- set tmpdir as early as possible because failsafe sets it too late for JDK16 -->
                         <argLine>-Djava.io.tmpdir="${project.build.directory}"</argLine>
                         <excludedEnvironmentVariables>MAVEN_OPTS</excludedEnvironmentVariables>
+                        <excludes>
+                            <exclude>io.quarkus.test.junit5.virtual.internal.ignore.**Test.java</exclude>
+                        </excludes>
                     </configuration>
                 </plugin>
                 <!-- Replicate what's in parent, since this pom doesn't inherit parent but IDE settings will be common -->

independent-projects/junit5-virtual-threads/src/main/java/io/quarkus/test/junit5/virtual/ShouldNotPin.java

@@ -1,6 +1,7 @@
 package io.quarkus.test.junit5.virtual;
 
 import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
@@ -12,6 +13,7 @@
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ ElementType.METHOD, ElementType.TYPE })
+@Inherited
 public @interface ShouldNotPin {
 
     /**

independent-projects/junit5-virtual-threads/src/main/java/io/quarkus/test/junit5/virtual/ShouldPin.java

@@ -1,6 +1,7 @@
 package io.quarkus.test.junit5.virtual;
 
 import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
@@ -12,6 +13,7 @@
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ ElementType.METHOD, ElementType.TYPE })
+@Inherited
 public @interface ShouldPin {
     int atMost() default Integer.MAX_VALUE;
 

independent-projects/junit5-virtual-threads/src/test/java/io/quarkus/test/junit5/virtual/internal/JUnitEngine.java

@@ -0,0 +1,34 @@
+package io.quarkus.test.junit5.virtual.internal;
+
+import static org.junit.platform.engine.discovery.DiscoverySelectors.selectMethod;
+import static org.junit.platform.testkit.engine.EventConditions.*;
+
+import org.assertj.core.api.Condition;
+import org.junit.platform.testkit.engine.EngineTestKit;
+import org.junit.platform.testkit.engine.Events;
+
+public class JUnitEngine {
+
+    public static void runTestAndAssertFailure(Class<?> clazz, String methodName, String message) {
+        runTest(clazz, methodName).assertThatEvents()
+                .haveExactly(1, event(test(methodName),
+                        finishedWithFailure(new Condition<>(
+                                throwable -> throwable instanceof AssertionError && throwable.getMessage().contains(message),
+                                ""))));
+    }
+
+    public static void runTestAndAssertSuccess(Class<?> clazz, String methodName) {
+        runTest(clazz, methodName).assertThatEvents()
+                .haveExactly(1, event(test(methodName),
+                        finishedSuccessfully()));
+    }
+
+    public static Events runTest(Class<?> clazz, String methodName) {
+        return EngineTestKit
+                .engine("junit-jupiter")
+                .selectors(selectMethod(clazz, methodName))
+                .execute()
+                .testEvents();
+    }
+
+}

independent-projects/junit5-virtual-threads/src/test/java/io/quarkus/test/junit5/virtual/internal/ShouldNotPinTest.java

@@ -0,0 +1,46 @@
+package io.quarkus.test.junit5.virtual.internal;
+
+import static io.quarkus.test.junit5.virtual.internal.JUnitEngine.runTestAndAssertFailure;
+import static io.quarkus.test.junit5.virtual.internal.JUnitEngine.runTestAndAssertSuccess;
+import static org.junit.jupiter.params.provider.Arguments.arguments;
+
+import java.util.stream.Stream;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.condition.EnabledForJreRange;
+import org.junit.jupiter.api.condition.JRE;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+
+import io.quarkus.test.junit5.virtual.internal.ignore.LoomUnitExampleOnMethodTest;
+import io.quarkus.test.junit5.virtual.internal.ignore.LoomUnitExampleShouldNotPinOnClassTest;
+import io.quarkus.test.junit5.virtual.internal.ignore.LoomUnitExampleShouldNotPinOnSuperClassTest;
+import io.quarkus.test.junit5.virtual.internal.ignore.LoomUnitExampleShouldPinOnSuperClassTest;
+
+public class ShouldNotPinTest {
+
+    @ParameterizedTest
+    @MethodSource
+    @EnabledForJreRange(min = JRE.JAVA_21)
+    void testShouldNotPinButPinEventDetected(Class<?> clazz, String methodName) {
+        runTestAndAssertFailure(clazz, methodName, "was expected to NOT pin the carrier thread");
+    }
+
+    public static Stream<Arguments> testShouldNotPinButPinEventDetected() {
+        return Stream.of(
+                arguments(LoomUnitExampleOnMethodTest.class, "failWhenShouldNotPinAndPinDetected"),
+                arguments(LoomUnitExampleOnMethodTest.class, "failWhenShouldNotPinAtMostAndTooManyPinDetected"),
+                arguments(LoomUnitExampleShouldNotPinOnClassTest.class, "failWhenShouldNotPinAndPinDetected"),
+                arguments(LoomUnitExampleShouldNotPinOnSuperClassTest.class, "failWhenShouldNotPinAndPinDetected"),
+                arguments(LoomUnitExampleShouldPinOnSuperClassTest.class, "failWhenShouldNotPinAndPinDetected"));
+    }
+
+    @Test
+    @EnabledForJreRange(min = JRE.JAVA_21)
+    void shouldNotPinOnMethodOverridesClassAnnotation() {
+        runTestAndAssertSuccess(LoomUnitExampleShouldNotPinOnClassTest.class, "overrideClassAnnotation");
+        runTestAndAssertSuccess(LoomUnitExampleShouldNotPinOnSuperClassTest.class, "overrideClassAnnotation");
+    }
+
+}

independent-projects/junit5-virtual-threads/src/test/java/io/quarkus/test/junit5/virtual/internal/ShouldPinTest.java

@@ -0,0 +1,36 @@
+package io.quarkus.test.junit5.virtual.internal;
+
+import static io.quarkus.test.junit5.virtual.internal.JUnitEngine.runTestAndAssertFailure;
+import static org.junit.jupiter.params.provider.Arguments.arguments;
+
+import java.util.stream.Stream;
+
+import org.junit.jupiter.api.condition.EnabledForJreRange;
+import org.junit.jupiter.api.condition.JRE;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+
+import io.quarkus.test.junit5.virtual.internal.ignore.LoomUnitExampleOnMethodTest;
+import io.quarkus.test.junit5.virtual.internal.ignore.LoomUnitExampleShouldNotPinOnClassTest;
+import io.quarkus.test.junit5.virtual.internal.ignore.LoomUnitExampleShouldNotPinOnSuperClassTest;
+import io.quarkus.test.junit5.virtual.internal.ignore.LoomUnitExampleShouldPinOnSuperClassTest;
+
+public class ShouldPinTest {
+
+    @ParameterizedTest
+    @MethodSource
+    @EnabledForJreRange(min = JRE.JAVA_21)
+    void testShouldPinButNoPinEventDetected(Class<?> clazz, String methodName) {
+        runTestAndAssertFailure(clazz, methodName, "was expected to pin the carrier thread, it didn't");
+    }
+
+    public static Stream<Arguments> testShouldPinButNoPinEventDetected() {
+        return Stream.of(
+                arguments(LoomUnitExampleOnMethodTest.class, "failWhenMethodShouldPinButNoPinDetected"),
+                arguments(LoomUnitExampleShouldNotPinOnClassTest.class, "failWhenMethodShouldPinButNoPinDetected"),
+                arguments(LoomUnitExampleShouldNotPinOnSuperClassTest.class, "failWhenShouldPinAndNoPinDetected"),
+                arguments(LoomUnitExampleShouldPinOnSuperClassTest.class, "failWhenShouldPinAndNoPinDetected"));
+    }
+
+}

independent-projects/junit5-virtual-threads/src/test/java/io/quarkus/test/junit5/virtual/internal/TestPinJfrEvent.java

@@ -17,7 +17,7 @@ public TestPinJfrEvent(String message) {
         this.message = message;
     }
 
-    static void pin() {
+    public static void pin() {
         TestPinJfrEvent event = new TestPinJfrEvent("Hello, JFR!");
         event.commit();
     }

independent-projects/junit5-virtual-threads/src/test/java/io/quarkus/test/junit5/virtual/internal/ignore/LoomUnitExampleOnMethodTest.java

@@ -0,0 +1,31 @@
+package io.quarkus.test.junit5.virtual.internal.ignore;
+
+import org.junit.jupiter.api.Test;
+
+import io.quarkus.test.junit5.virtual.ShouldNotPin;
+import io.quarkus.test.junit5.virtual.ShouldPin;
+import io.quarkus.test.junit5.virtual.VirtualThreadUnit;
+import io.quarkus.test.junit5.virtual.internal.TestPinJfrEvent;
+
+@VirtualThreadUnit
+public class LoomUnitExampleOnMethodTest {
+
+    @Test
+    @ShouldNotPin
+    void failWhenShouldNotPinAndPinDetected() {
+        TestPinJfrEvent.pin();
+    }
+
+    @Test
+    @ShouldNotPin(atMost = 1)
+    void failWhenShouldNotPinAtMostAndTooManyPinDetected() {
+        TestPinJfrEvent.pin();
+        TestPinJfrEvent.pin();
+    }
+
+    @Test
+    @ShouldPin
+    void failWhenMethodShouldPinButNoPinDetected() {
+    }
+
+}

independent-projects/junit5-virtual-threads/src/test/java/io/quarkus/test/junit5/virtual/internal/ignore/LoomUnitExampleShouldNotPinOnClassTest.java

@@ -0,0 +1,31 @@
+package io.quarkus.test.junit5.virtual.internal.ignore;
+
+import org.junit.jupiter.api.Test;
+
+import io.quarkus.test.junit5.virtual.ShouldNotPin;
+import io.quarkus.test.junit5.virtual.ShouldPin;
+import io.quarkus.test.junit5.virtual.VirtualThreadUnit;
+import io.quarkus.test.junit5.virtual.internal.TestPinJfrEvent;
+
+@VirtualThreadUnit
+@ShouldNotPin // You can use @ShouldNotPin or @ShouldPin on the class itself, it's applied to each method.
+public class LoomUnitExampleShouldNotPinOnClassTest {
+
+    @Test
+    public void failWhenShouldNotPinAndPinDetected() {
+        TestPinJfrEvent.pin();
+    }
+
+    @Test
+    @ShouldPin(atMost = 1)
+    public void overrideClassAnnotation() {
+        TestPinJfrEvent.pin();
+    }
+
+    @Test
+    @ShouldPin
+    public void failWhenMethodShouldPinButNoPinDetected() {
+
+    }
+
+}

independent-projects/junit5-virtual-threads/src/test/java/io/quarkus/test/junit5/virtual/internal/ignore/LoomUnitExampleShouldNotPinOnSuperClass.java

@@ -0,0 +1,9 @@
+package io.quarkus.test.junit5.virtual.internal.ignore;
+
+import io.quarkus.test.junit5.virtual.ShouldNotPin;
+import io.quarkus.test.junit5.virtual.VirtualThreadUnit;
+
+@VirtualThreadUnit
+@ShouldNotPin // You can use @ShouldNotPin or @ShouldPin on the super class itself, it's applied to each method.
+public abstract class LoomUnitExampleShouldNotPinOnSuperClass {
+}

independent-projects/junit5-virtual-threads/src/test/java/io/quarkus/test/junit5/virtual/internal/ignore/LoomUnitExampleShouldNotPinOnSuperClassTest.java

@@ -0,0 +1,27 @@
+package io.quarkus.test.junit5.virtual.internal.ignore;
+
+import org.junit.jupiter.api.Test;
+
+import io.quarkus.test.junit5.virtual.ShouldPin;
+import io.quarkus.test.junit5.virtual.internal.TestPinJfrEvent;
+
+public class LoomUnitExampleShouldNotPinOnSuperClassTest extends LoomUnitExampleShouldNotPinOnSuperClass {
+
+    @Test
+    public void failWhenShouldNotPinAndPinDetected() {
+        TestPinJfrEvent.pin();
+    }
+
+    @Test
+    @ShouldPin(atMost = 1)
+    public void overrideClassAnnotation() {
+        TestPinJfrEvent.pin();
+    }
+
+    @Test
+    @ShouldPin // Method annotation overrides the class annotation
+    public void failWhenShouldPinAndNoPinDetected() {
+
+    }
+
+}

independent-projects/junit5-virtual-threads/src/test/java/io/quarkus/test/junit5/virtual/internal/ignore/LoomUnitExampleShouldPinOnSuperClass.java

@@ -0,0 +1,9 @@
+package io.quarkus.test.junit5.virtual.internal.ignore;
+
+import io.quarkus.test.junit5.virtual.ShouldPin;
+import io.quarkus.test.junit5.virtual.VirtualThreadUnit;
+
+@VirtualThreadUnit
+@ShouldPin // You can use @ShouldNotPin or @ShouldPin on the super class itself, it's applied to each method.
+public abstract class LoomUnitExampleShouldPinOnSuperClass {
+}

independent-projects/junit5-virtual-threads/src/test/java/io/quarkus/test/junit5/virtual/internal/ignore/LoomUnitExampleShouldPinOnSuperClassTest.java

@@ -0,0 +1,21 @@
+package io.quarkus.test.junit5.virtual.internal.ignore;
+
+import org.junit.jupiter.api.Test;
+
+import io.quarkus.test.junit5.virtual.ShouldNotPin;
+import io.quarkus.test.junit5.virtual.internal.TestPinJfrEvent;
+
+public class LoomUnitExampleShouldPinOnSuperClassTest extends LoomUnitExampleShouldPinOnSuperClass {
+
+    @Test
+    @ShouldNotPin // Method annotation overrides the class annotation
+    public void failWhenShouldNotPinAndPinDetected() {
+        TestPinJfrEvent.pin();
+    }
+
+    @Test
+    public void failWhenShouldPinAndNoPinDetected() {
+
+    }
+
+}