Add testutil.failure utils

Author: JooHyukKim

avro/src/test/java/com/fasterxml/jackson/dataformat/avro/testutil/failure/JacksonTestFailureExpected.java

@@ -0,0 +1,38 @@
+package com.fasterxml.jackson.dataformat.avro.testutil.failure;
+
+import java.lang.annotation.*;
+
+import org.junit.jupiter.api.extension.ExtendWith;
+
+/**
+ * <p>
+ * Annotation used to indicate that a JUnit-5 based tests method is expected to fail.
+ *
+ * <p>
+ * When a test method is annotated with {@code @JacksonTestFailureExpected}, the
+ * {@link JacksonTestFailureExpectedInterceptor} will intercept the test execution.
+ * If the test passes, which is an unexpected behavior, the interceptor will throw an exception to fail the test,
+ * indicating that the test was expected to fail but didn't.
+ * </p>
+ *
+ * <h3>Usage Example:</h3>
+ *
+ * <pre><code>
+ *
+ *     &#64;Test
+ *     &#64;JacksonTestFailureExpected
+ *     @Test
+    public void testFeatureNotYetImplemented() {
+ *         // Test code that is expected to fail
+ *     }
+ * }
+ * </code></pre>
+ *
+ * <p>
+ *
+ * @since 2.19
+ */
+@Target({ElementType.METHOD})
+@Retention(RetentionPolicy.RUNTIME)
+@ExtendWith(JacksonTestFailureExpectedInterceptor.class)
+public @interface JacksonTestFailureExpected { }

avro/src/test/java/com/fasterxml/jackson/dataformat/avro/testutil/failure/JacksonTestFailureExpectedInterceptor.java

@@ -0,0 +1,43 @@
+package com.fasterxml.jackson.dataformat.avro.testutil.failure;
+
+import java.lang.reflect.Method;
+
+import org.junit.jupiter.api.extension.*;
+
+/**
+ * Custom {@link InvocationInterceptor} that intercepts test method invocation.
+ * To pass the test ***only if*** test fails with an exception, and fail the test otherwise.
+ *
+ * @since 2.19
+ */
+public class JacksonTestFailureExpectedInterceptor
+    implements InvocationInterceptor
+{
+    @Override
+    public void interceptTestMethod(Invocation<Void> invocation,
+            ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext)
+        throws Throwable
+    {
+        try {
+            invocation.proceed();
+        } catch (Throwable t) {
+            // do-nothing, we do expect an exception
+            return;
+        }
+        handleUnexpectePassingTest(invocationContext);
+    }
+
+    private void handleUnexpectePassingTest(ReflectiveInvocationContext<Method> invocationContext) {
+        // Collect information we need
+        Object targetClass = invocationContext.getTargetClass();
+        Object testMethod = invocationContext.getExecutable().getName();
+        //List<Object> arguments = invocationContext.getArguments();
+
+        // Create message
+        String message = String.format("Test method %s.%s() passed, but should have failed", targetClass, testMethod);
+
+        // throw exception
+        throw new JacksonTestShouldFailException(message);
+    }
+
+}

avro/src/test/java/com/fasterxml/jackson/dataformat/avro/testutil/failure/JacksonTestShouldFailException.java

@@ -0,0 +1,18 @@
+package com.fasterxml.jackson.dataformat.avro.testutil.failure;
+
+/**
+ * Exception used to alert that a test is passing, but should be failing.
+ *
+ * WARNING : This only for test code, and should never be thrown from production code.
+ *
+ * @since 2.19
+ */
+public class JacksonTestShouldFailException
+    extends RuntimeException
+{
+    private static final long serialVersionUID = 1L;
+
+    public JacksonTestShouldFailException(String msg) {
+        super(msg);
+    }
+}

cbor/src/test/java/com/fasterxml/jackson/dataformat/cbor/testutil/failure/JacksonTestFailureExpected.java

@@ -0,0 +1,38 @@
+package com.fasterxml.jackson.dataformat.cbor.testutil.failure;
+
+import java.lang.annotation.*;
+
+import org.junit.jupiter.api.extension.ExtendWith;
+
+/**
+ * <p>
+ * Annotation used to indicate that a JUnit-5 based tests method is expected to fail.
+ *
+ * <p>
+ * When a test method is annotated with {@code @JacksonTestFailureExpected}, the
+ * {@link JacksonTestFailureExpectedInterceptor} will intercept the test execution.
+ * If the test passes, which is an unexpected behavior, the interceptor will throw an exception to fail the test,
+ * indicating that the test was expected to fail but didn't.
+ * </p>
+ *
+ * <h3>Usage Example:</h3>
+ *
+ * <pre><code>
+ *
+ *     &#64;Test
+ *     &#64;JacksonTestFailureExpected
+ *     @Test
+    public void testFeatureNotYetImplemented() {
+ *         // Test code that is expected to fail
+ *     }
+ * }
+ * </code></pre>
+ *
+ * <p>
+ *
+ * @since 2.19
+ */
+@Target({ElementType.METHOD})
+@Retention(RetentionPolicy.RUNTIME)
+@ExtendWith(JacksonTestFailureExpectedInterceptor.class)
+public @interface JacksonTestFailureExpected { }

cbor/src/test/java/com/fasterxml/jackson/dataformat/cbor/testutil/failure/JacksonTestFailureExpectedInterceptor.java

@@ -0,0 +1,43 @@
+package com.fasterxml.jackson.dataformat.cbor.testutil.failure;
+
+import java.lang.reflect.Method;
+
+import org.junit.jupiter.api.extension.*;
+
+/**
+ * Custom {@link InvocationInterceptor} that intercepts test method invocation.
+ * To pass the test ***only if*** test fails with an exception, and fail the test otherwise.
+ *
+ * @since 2.19
+ */
+public class JacksonTestFailureExpectedInterceptor
+    implements InvocationInterceptor
+{
+    @Override
+    public void interceptTestMethod(Invocation<Void> invocation,
+            ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext)
+        throws Throwable
+    {
+        try {
+            invocation.proceed();
+        } catch (Throwable t) {
+            // do-nothing, we do expect an exception
+            return;
+        }
+        handleUnexpectePassingTest(invocationContext);
+    }
+
+    private void handleUnexpectePassingTest(ReflectiveInvocationContext<Method> invocationContext) {
+        // Collect information we need
+        Object targetClass = invocationContext.getTargetClass();
+        Object testMethod = invocationContext.getExecutable().getName();
+        //List<Object> arguments = invocationContext.getArguments();
+
+        // Create message
+        String message = String.format("Test method %s.%s() passed, but should have failed", targetClass, testMethod);
+
+        // throw exception
+        throw new JacksonTestShouldFailException(message);
+    }
+
+}

cbor/src/test/java/com/fasterxml/jackson/dataformat/cbor/testutil/failure/JacksonTestShouldFailException.java

@@ -0,0 +1,18 @@
+package com.fasterxml.jackson.dataformat.cbor.testutil.failure;
+
+/**
+ * Exception used to alert that a test is passing, but should be failing.
+ *
+ * WARNING : This only for test code, and should never be thrown from production code.
+ *
+ * @since 2.19
+ */
+public class JacksonTestShouldFailException
+    extends RuntimeException
+{
+    private static final long serialVersionUID = 1L;
+
+    public JacksonTestShouldFailException(String msg) {
+        super(msg);
+    }
+}

ion/src/test/java/com/fasterxml/jackson/dataformat/ion/testutil/failure/JacksonTestFailureExpected.java

@@ -0,0 +1,38 @@
+package com.fasterxml.jackson.dataformat.ion.testutil.failure;
+
+import java.lang.annotation.*;
+
+import org.junit.jupiter.api.extension.ExtendWith;
+
+/**
+ * <p>
+ * Annotation used to indicate that a JUnit-5 based tests method is expected to fail.
+ *
+ * <p>
+ * When a test method is annotated with {@code @JacksonTestFailureExpected}, the
+ * {@link JacksonTestFailureExpectedInterceptor} will intercept the test execution.
+ * If the test passes, which is an unexpected behavior, the interceptor will throw an exception to fail the test,
+ * indicating that the test was expected to fail but didn't.
+ * </p>
+ *
+ * <h3>Usage Example:</h3>
+ *
+ * <pre><code>
+ *
+ *     &#64;Test
+ *     &#64;JacksonTestFailureExpected
+ *     @Test
+    public void testFeatureNotYetImplemented() {
+ *         // Test code that is expected to fail
+ *     }
+ * }
+ * </code></pre>
+ *
+ * <p>
+ *
+ * @since 2.19
+ */
+@Target({ElementType.METHOD})
+@Retention(RetentionPolicy.RUNTIME)
+@ExtendWith(JacksonTestFailureExpectedInterceptor.class)
+public @interface JacksonTestFailureExpected { }

ion/src/test/java/com/fasterxml/jackson/dataformat/ion/testutil/failure/JacksonTestFailureExpectedInterceptor.java

@@ -0,0 +1,43 @@
+package com.fasterxml.jackson.dataformat.ion.testutil.failure;
+
+import java.lang.reflect.Method;
+
+import org.junit.jupiter.api.extension.*;
+
+/**
+ * Custom {@link InvocationInterceptor} that intercepts test method invocation.
+ * To pass the test ***only if*** test fails with an exception, and fail the test otherwise.
+ *
+ * @since 2.19
+ */
+public class JacksonTestFailureExpectedInterceptor
+    implements InvocationInterceptor
+{
+    @Override
+    public void interceptTestMethod(Invocation<Void> invocation,
+            ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext)
+        throws Throwable
+    {
+        try {
+            invocation.proceed();
+        } catch (Throwable t) {
+            // do-nothing, we do expect an exception
+            return;
+        }
+        handleUnexpectePassingTest(invocationContext);
+    }
+
+    private void handleUnexpectePassingTest(ReflectiveInvocationContext<Method> invocationContext) {
+        // Collect information we need
+        Object targetClass = invocationContext.getTargetClass();
+        Object testMethod = invocationContext.getExecutable().getName();
+        //List<Object> arguments = invocationContext.getArguments();
+
+        // Create message
+        String message = String.format("Test method %s.%s() passed, but should have failed", targetClass, testMethod);
+
+        // throw exception
+        throw new JacksonTestShouldFailException(message);
+    }
+
+}

ion/src/test/java/com/fasterxml/jackson/dataformat/ion/testutil/failure/JacksonTestShouldFailException.java

@@ -0,0 +1,18 @@
+package com.fasterxml.jackson.dataformat.ion.testutil.failure;
+
+/**
+ * Exception used to alert that a test is passing, but should be failing.
+ *
+ * WARNING : This only for test code, and should never be thrown from production code.
+ *
+ * @since 2.19
+ */
+public class JacksonTestShouldFailException
+    extends RuntimeException
+{
+    private static final long serialVersionUID = 1L;
+
+    public JacksonTestShouldFailException(String msg) {
+        super(msg);
+    }
+}

pom.xml

@@ -67,7 +67,18 @@
       <groupId>junit</groupId>
       <artifactId>junit</artifactId>
       <scope>test</scope>
-    </dependency>    
+    </dependency>
+    <!-- 11-Jan-2025, joohyukkim: For JSTEP-10, migrate to JUnit5 -->
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-api</artifactId>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <!-- Alas, need to include snapshot reference since otherwise can not find