From e3573495114c38fecacb978d785015914e8f3807 Mon Sep 17 00:00:00 2001
From: Tatu Saloranta <tatu.saloranta@iki.fi>
Date: Thu, 19 Sep 2024 08:37:48 -0700
Subject: [PATCH] Merging parts of #4696 separately to ease merging into 3.0

---
 .../failure/JacksonTestFailureExpected.java   | 40 ++++++++++++++++
 ...JacksonTestFailureExpectedInterceptor.java | 46 +++++++++++++++++++
 .../JacksonTestShouldFailException.java       | 16 +++++++
 3 files changed, 102 insertions(+)
 create mode 100644 src/test/java/com/fasterxml/jackson/databind/testutil/failure/JacksonTestFailureExpected.java
 create mode 100644 src/test/java/com/fasterxml/jackson/databind/testutil/failure/JacksonTestFailureExpectedInterceptor.java
 create mode 100644 src/test/java/com/fasterxml/jackson/databind/testutil/failure/JacksonTestShouldFailException.java

diff --git a/src/test/java/com/fasterxml/jackson/databind/testutil/failure/JacksonTestFailureExpected.java b/src/test/java/com/fasterxml/jackson/databind/testutil/failure/JacksonTestFailureExpected.java
new file mode 100644
index 0000000000..66fca0d2cc
--- /dev/null
+++ b/src/test/java/com/fasterxml/jackson/databind/testutil/failure/JacksonTestFailureExpected.java
@@ -0,0 +1,40 @@
+package com.fasterxml.jackson.databind.testutil.failure;
+
+import org.junit.jupiter.api.extension.ExtendWith;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * <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
+ *     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 { }
diff --git a/src/test/java/com/fasterxml/jackson/databind/testutil/failure/JacksonTestFailureExpectedInterceptor.java b/src/test/java/com/fasterxml/jackson/databind/testutil/failure/JacksonTestFailureExpectedInterceptor.java
new file mode 100644
index 0000000000..767511bd1c
--- /dev/null
+++ b/src/test/java/com/fasterxml/jackson/databind/testutil/failure/JacksonTestFailureExpectedInterceptor.java
@@ -0,0 +1,46 @@
+package com.fasterxml.jackson.databind.testutil.failure;
+
+import org.junit.jupiter.api.extension.ExtensionContext;
+import org.junit.jupiter.api.extension.InvocationInterceptor;
+import org.junit.jupiter.api.extension.ReflectiveInvocationContext;
+
+import java.lang.reflect.Method;
+import java.util.List;
+
+/**
+ * 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);
+    }
+
+}
diff --git a/src/test/java/com/fasterxml/jackson/databind/testutil/failure/JacksonTestShouldFailException.java b/src/test/java/com/fasterxml/jackson/databind/testutil/failure/JacksonTestShouldFailException.java
new file mode 100644
index 0000000000..3a4d7375fd
--- /dev/null
+++ b/src/test/java/com/fasterxml/jackson/databind/testutil/failure/JacksonTestShouldFailException.java
@@ -0,0 +1,16 @@
+package com.fasterxml.jackson.databind.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
+{
+    public JacksonTestShouldFailException(String msg) {
+        super(msg);
+    }
+}