From b530a6bc381ed7874e6652462f48f5a6ef4cb5de Mon Sep 17 00:00:00 2001
From: "Kim, Joo Hyuk" <beanskobe@gmail.com>
Date: Mon, 27 Jan 2025 04:31:20 +0900
Subject: [PATCH] [JSTEP-10] Use Jackson testutils and remove `/failure` test
 exclusion (#156)

---
 pom.xml                                       |  5 ---
 release-notes/VERSION-2.x                     |  3 +-
 .../failure/JacksonTestFailureExpected.java   | 37 ++++++++++++++++
 ...JacksonTestFailureExpectedInterceptor.java | 43 +++++++++++++++++++
 .../JacksonTestShouldFailException.java       | 18 ++++++++
 ...teTimeSerializationWithOffsets146Test.java |  4 +-
 6 files changed, 103 insertions(+), 7 deletions(-)
 create mode 100644 src/test/java/com/fasterxml/jackson/datatype/joda/testutil/failure/JacksonTestFailureExpected.java
 create mode 100644 src/test/java/com/fasterxml/jackson/datatype/joda/testutil/failure/JacksonTestFailureExpectedInterceptor.java
 create mode 100644 src/test/java/com/fasterxml/jackson/datatype/joda/testutil/failure/JacksonTestShouldFailException.java
 rename src/test/java/com/fasterxml/jackson/datatype/joda/{failing => tofix}/DateTimeSerializationWithOffsets146Test.java (88%)

diff --git a/pom.xml b/pom.xml
index 9102a5d..ced835b 100644
--- a/pom.xml
+++ b/pom.xml
@@ -121,11 +121,6 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-surefire-plugin</artifactId>
-        <configuration>
-          <excludes>
-            <exclude>com/fasterxml/jackson/**/failing/*.java</exclude>
-          </excludes>
-        </configuration>
       </plugin>
       <!--  19-Mar-2019, tatu: Add rudimentary JDK9+ module info. To build with JDK 8
              will have to use `moduleInfoFile` as anything else requires JDK 9+
diff --git a/release-notes/VERSION-2.x b/release-notes/VERSION-2.x
index d27d849..fd4a307 100644
--- a/release-notes/VERSION-2.x
+++ b/release-notes/VERSION-2.x
@@ -6,7 +6,8 @@ Project: jackson-datatype-joda
 
 2.19.0 (not yet released)
 
--
+#152: Unify testing structure/tools [JSTEP-10]
+ (contributed by Joo-Hyuk K)
 
 2.18.2 (27-Nov-2024)
 2.18.1 (28-Oct-2024)
diff --git a/src/test/java/com/fasterxml/jackson/datatype/joda/testutil/failure/JacksonTestFailureExpected.java b/src/test/java/com/fasterxml/jackson/datatype/joda/testutil/failure/JacksonTestFailureExpected.java
new file mode 100644
index 0000000..0840369
--- /dev/null
+++ b/src/test/java/com/fasterxml/jackson/datatype/joda/testutil/failure/JacksonTestFailureExpected.java
@@ -0,0 +1,37 @@
+package com.fasterxml.jackson.datatype.joda.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
+ *     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/datatype/joda/testutil/failure/JacksonTestFailureExpectedInterceptor.java b/src/test/java/com/fasterxml/jackson/datatype/joda/testutil/failure/JacksonTestFailureExpectedInterceptor.java
new file mode 100644
index 0000000..40a0c40
--- /dev/null
+++ b/src/test/java/com/fasterxml/jackson/datatype/joda/testutil/failure/JacksonTestFailureExpectedInterceptor.java
@@ -0,0 +1,43 @@
+package com.fasterxml.jackson.datatype.joda.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);
+    }
+
+}
diff --git a/src/test/java/com/fasterxml/jackson/datatype/joda/testutil/failure/JacksonTestShouldFailException.java b/src/test/java/com/fasterxml/jackson/datatype/joda/testutil/failure/JacksonTestShouldFailException.java
new file mode 100644
index 0000000..889642e
--- /dev/null
+++ b/src/test/java/com/fasterxml/jackson/datatype/joda/testutil/failure/JacksonTestShouldFailException.java
@@ -0,0 +1,18 @@
+package com.fasterxml.jackson.datatype.joda.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);
+    }
+}
diff --git a/src/test/java/com/fasterxml/jackson/datatype/joda/failing/DateTimeSerializationWithOffsets146Test.java b/src/test/java/com/fasterxml/jackson/datatype/joda/tofix/DateTimeSerializationWithOffsets146Test.java
similarity index 88%
rename from src/test/java/com/fasterxml/jackson/datatype/joda/failing/DateTimeSerializationWithOffsets146Test.java
rename to src/test/java/com/fasterxml/jackson/datatype/joda/tofix/DateTimeSerializationWithOffsets146Test.java
index 70d008d..151733c 100644
--- a/src/test/java/com/fasterxml/jackson/datatype/joda/failing/DateTimeSerializationWithOffsets146Test.java
+++ b/src/test/java/com/fasterxml/jackson/datatype/joda/tofix/DateTimeSerializationWithOffsets146Test.java
@@ -1,9 +1,10 @@
-package com.fasterxml.jackson.datatype.joda.failing;
+package com.fasterxml.jackson.datatype.joda.tofix;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
 
 import com.fasterxml.jackson.datatype.joda.JodaTestBase;
+import com.fasterxml.jackson.datatype.joda.testutil.failure.JacksonTestFailureExpected;
 
 import org.joda.time.*;
 
@@ -15,6 +16,7 @@
 public class DateTimeSerializationWithOffsets146Test extends JodaTestBase
 {
     // [datatype-joda#146]
+    @JacksonTestFailureExpected
     @Test
     public void testLocalDateSerDefault() throws Exception
     {