- F DateUtils.toString, EndOfTime, QuartzUtils.toString, Timestamp date format scrubber

Co-Authored-By: Jay Bazuzi <[email protected]>
Co-Authored-By: Scott Wierschem <[email protected]>

Author: 3 people

.windsurf/UnitTestStyleGuide.process.md

@@ -14,9 +14,11 @@
 ### Dates, GUIDS and other non-deterministic values
 
 If you are printing dates, guids, or any other non-deterministic values to an `.approved.` file. 
+Always use the scrubbers provided by ApprovalTests.
 Please read [Scrubbers](../approvaltests/docs/Scrubbers.md) and add on Options to the Approvals.verify call.
 
-Example:
+Either use Scrubbers or DateScrubber.
+#### Scrubbers Example:
 
 ```java
 Approvals.verifyAll("guids", guids, new Options(Scrubbers::scrubGuid));

approvaltests-tests/src/test/java/org/approvaltests/scrubbers/DateScrubberTest.java

@@ -68,9 +68,7 @@ void supportedFormats()
   void textExamples()
   {
     String[] examples = """
-        05/13/2014 11:50:49 PM
-        2024-12-18T14:04:46-0500
-        2025-07-17 14:58:02,123456
+        2025-05-15 16:57:04.599
         """.split("\n");
     Approvals.verifyAll("Date scrubbing", examples, this::verifyScrubbing);
   }

approvaltests-tests/src/test/java/org/approvaltests/scrubbers/DateScrubberTest.supportedFormats.approved.md

@@ -19,5 +19,6 @@
 | 2024-12-17                     | \d{4}-\d{2}-\d{2}                                                                                                                   |
 | 2024-12-18T14:04:46.746130Z    | \d{4}-\d{1,2}-\d{1,2}T\d{1,2}:\d{2}:\d{2}(\.\d{1,9})?Z                                                                              |
 | 13/05/2014 23:50:49            | \d{2}[-/.]\d{2}[-/.]\d{4}\s\d{2}:\d{2}(:\d{2})?( (?:pm\|am\|PM\|AM))?                                                               |
+| 2025-05-15 16:57:04.599        | \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d{3}                                                                                          |
 
 

approvaltests-tests/src/test/java/org/approvaltests/scrubbers/DateScrubberTest.testGetDateScrubber.approved.txt

@@ -136,3 +136,8 @@ RegExScrubber[\d{2}[-/.]\d{2}[-/.]\d{4}\s\d{2}:\d{2}(:\d{2})?( (?:pm|am|PM|AM))?
 Example: {'date':"[Date1]"}
 
 
+Scrubbing for 2025-05-15 16:57:04.599:
+RegExScrubber[\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d{3}]
+Example: {'date':"[Date1]"}
+
+

approvaltests-tests/src/test/java/org/approvaltests/scrubbers/DateScrubberTest.textExamples.approved.txt

@@ -1,36 +1,31 @@
 package com.spun.util.quartz;
 
 import org.approvaltests.Approvals;
+import org.approvaltests.core.Options;
+import org.approvaltests.scrubbers.DateScrubber;
 import org.junit.jupiter.api.Test;
 import org.quartz.JobKey;
 import org.quartz.Trigger;
 import org.quartz.impl.triggers.SimpleTriggerImpl;
 
-class QuartzUtilsTest {
-    @Test
-    void testCreateTrigger() {
-        // Arrange
-        SimpleTriggerImpl oldTrigger = new SimpleTriggerImpl();
-        oldTrigger.setName("oldName");
-        oldTrigger.setGroup("oldGroup");
-        oldTrigger.setJobKey(new JobKey("jobName", "jobGroup"));
-        
-        // Act
-        Trigger newTrigger = QuartzUtils.createTrigger(oldTrigger, "testTriggerName", "testTriggerGroup");
-        
-        // Verify
-        String output = String.format(
-            "Trigger:\n" +
-            "  Key: %s\n" +
-            "  Job Key: %s\n" +
-            "  Start Time: %s\n" +
-            "  End Time: %s",
-            newTrigger.getKey(),
-            newTrigger.getJobKey(),
-            newTrigger.getStartTime(),
-            newTrigger.getEndTime()
-        );
-        
-        Approvals.verify(output);
-    }
-}
+class QuartzUtilsTest
+{
+  @Test
+  void testCreateTriggerFromTrigger()
+  {
+    var expected = """
+        Trigger:
+          Key: newGroup.newName
+          Job Key: jobGroup.jobName
+          Start Time: [Date1]
+          End Time: <EndOfTime>
+        """;
+    SimpleTriggerImpl oldTrigger = new SimpleTriggerImpl();
+    oldTrigger.setName("oldName");
+    oldTrigger.setGroup("oldGroup");
+    oldTrigger.setJobKey(new JobKey("jobName", "jobGroup"));
+    Trigger newTrigger = QuartzUtils.createTrigger(oldTrigger, "newName", "newGroup");
+    DateScrubber scrubber = DateScrubber.getScrubberFor("2025-05-15 16:57:04.599");
+    Approvals.verify(QuartzUtils.toString(newTrigger), new Options().inline(expected).withScrubber(scrubber));
+  }
+}

approvaltests-util-tests/src/test/java/com/spun/util/quartz/QuartzUtilsTest.java

@@ -294,4 +294,27 @@ public static Calendar setTime(Calendar day, int hour, int minute)
     return new GregorianCalendar(day.get(Calendar.YEAR), day.get(Calendar.MONTH), day.get(Calendar.DAY_OF_MONTH),
         hour, minute);
   }
+  public static boolean isEndOfTime(Date time)
+  {
+    return time.getTime() == Long.MAX_VALUE;
+  }
+  public static String toString(Date date)
+  {
+    if (date == null)
+    {
+      return "null";
+    }
+    else if (isEndOfTime(date))
+    {
+      return "<EndOfTime>";
+    }
+    else if (date.getTime() == 0)
+    {
+      return "<Epoch>";
+    }
+    else
+    {
+      return asTimestamp(date).toString();
+    }
+  }
 }

approvaltests-util-tests/src/test/java/com/spun/util/quartz/QuartzUtilsTest.testCreateTrigger.approved.txt

@@ -1,5 +1,6 @@
 package com.spun.util.quartz;
 
+import com.spun.util.DateUtils;
 import org.quartz.Trigger;
 import org.quartz.TriggerBuilder;
 
@@ -16,4 +17,9 @@ public static Trigger createTrigger(Trigger oldTrigger, String name, String defa
         .build();
     return newTrigger;
   }
+  public static String toString(Trigger trigger)
+  {
+    return String.format("Trigger:\n  Key: %s\n  Job Key: %s\n  Start Time: %s\n  End Time: %s", trigger.getKey(),
+        trigger.getJobKey(), DateUtils.toString(trigger.getStartTime()), DateUtils.toString(trigger.getEndTime()));
+  }
 }

approvaltests-util/src/main/java/com/spun/util/DateUtils.java

@@ -46,7 +46,9 @@ public static SupportedFormat[] getSupportedFormats()
                                      "2024-12-18T14:04:46.746130834Z"),
                                  __("\\d{2}[-/.]\\d{2}[-/.]\\d{4}\\s\\d{2}:\\d{2}(:\\d{2})?( (?:pm|am|PM|AM))?",
                                      "13/05/2014 23:50:49", "13.05.2014 23:50:49", "13-05-2014 23:50:49",
-                                     "13.05.2014 23:50", "05/13/2014 11:50:49 PM"),};
+                                     "13.05.2014 23:50", "05/13/2014 11:50:49 PM"),
+                                 __("\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}\\.\\d{3}",
+                                     "2025-05-15 16:57:04.599"),};
   }
   private static SupportedFormat __(String regex, String... examples)
   {