General Coding rule to detect usages of old time and date classes (#1384 / #1385)

With this commit new general rules are added which detect the usages of old time and date classes, e.g. java.util.Date.

Author: hankem

archunit/src/main/java/com/tngtech/archunit/library/GeneralCodingRules.java

@@ -509,4 +509,18 @@ public void check(JavaClass implementationClass, ConditionEvents events) {
                     .should(accessTargetWhere(JavaAccess.Predicates.target(annotatedWith(Deprecated.class))).as("access @Deprecated members"))
                     .orShould(dependOnClassesThat(annotatedWith(Deprecated.class)).as("depend on @Deprecated classes"))
                     .because("there should be a better alternative");
+
+    /**
+     * A rule checking that no classes uses old date and time classes and point out to use the Java 8 time API.
+     */
+    @PublicAPI(usage = ACCESS)
+    public static final ArchRule OLD_DATE_AND_TIME_CLASSES_SHOULD_NOT_BE_USED =
+            noClasses()
+                    .should().dependOnClassesThat().haveFullyQualifiedName("java.sql.Date")
+                    .orShould().dependOnClassesThat().haveFullyQualifiedName("java.sql.Time")
+                    .orShould().dependOnClassesThat().haveFullyQualifiedName("java.sql.Timestamp")
+                    .orShould().dependOnClassesThat().haveFullyQualifiedName("java.util.Calendar")
+                    .orShould().dependOnClassesThat().haveFullyQualifiedName("java.util.Date")
+                    .as("java.time API should be used")
+                    .because("legacy date/time APIs have been replaced since Java 8 (JSR 310)");
 }

archunit/src/test/java/com/tngtech/archunit/library/GeneralCodingRulesTest.java

@@ -10,11 +10,17 @@
 import com.tngtech.archunit.library.testclasses.packages.incorrect.wrongsubdir.customsuffix.subdir.ImplementationClassWithWrongTestClassPackageCustomSuffixTestingScenario;
 import com.tngtech.archunit.library.testclasses.packages.incorrect.wrongsubdir.defaultsuffix.ImplementationClassWithWrongTestClassPackage;
 import com.tngtech.archunit.library.testclasses.packages.incorrect.wrongsubdir.defaultsuffix.subdir.ImplementationClassWithWrongTestClassPackageTest;
+import com.tngtech.archunit.library.testclasses.timeapi.incorrect.UsesJavaSqlDate;
+import com.tngtech.archunit.library.testclasses.timeapi.incorrect.UsesJavaSqlTime;
+import com.tngtech.archunit.library.testclasses.timeapi.incorrect.UsesJavaSqlTimestamp;
+import com.tngtech.archunit.library.testclasses.timeapi.incorrect.UsesJavaUtilCalender;
+import com.tngtech.archunit.library.testclasses.timeapi.incorrect.UsesJavaUtilDate;
 import org.junit.Test;
 
 import static com.tngtech.archunit.core.domain.JavaConstructor.CONSTRUCTOR_NAME;
 import static com.tngtech.archunit.library.GeneralCodingRules.ASSERTIONS_SHOULD_HAVE_DETAIL_MESSAGE;
 import static com.tngtech.archunit.library.GeneralCodingRules.DEPRECATED_API_SHOULD_NOT_BE_USED;
+import static com.tngtech.archunit.library.GeneralCodingRules.OLD_DATE_AND_TIME_CLASSES_SHOULD_NOT_BE_USED;
 import static com.tngtech.archunit.library.GeneralCodingRules.testClassesShouldResideInTheSamePackageAsImplementation;
 import static com.tngtech.archunit.testutil.Assertions.assertThatRule;
 
@@ -180,4 +186,44 @@ void origin() {
     @SuppressWarnings("DeprecatedIsStillUsed")
     private @interface DeprecatedAnnotation {
     }
+
+    @Test
+    public void OLD_DATE_AND_TIME_CLASSES_SHOULD_NOT_BE_USED_should_fail_when_class_uses_java_util_date() {
+        assertThatRule(OLD_DATE_AND_TIME_CLASSES_SHOULD_NOT_BE_USED)
+                .hasDescription("java.time API should be used, because legacy date/time APIs have been replaced since Java 8 (JSR 310)")
+                .checking(new ClassFileImporter().importClasses(UsesJavaUtilDate.class))
+                .hasViolationContaining("calls method <java.util.Date");
+    }
+
+    @Test
+    public void OLD_DATE_AND_TIME_CLASSES_SHOULD_NOT_BE_USED_should_fail_when_class_uses_java_sql_timestamp() {
+        assertThatRule(OLD_DATE_AND_TIME_CLASSES_SHOULD_NOT_BE_USED)
+                .hasDescription("java.time API should be used, because legacy date/time APIs have been replaced since Java 8 (JSR 310)")
+                .checking(new ClassFileImporter().importClasses(UsesJavaSqlTimestamp.class))
+                .hasViolationContaining("calls constructor <java.sql.Timestamp");
+    }
+
+    @Test
+    public void OLD_DATE_AND_TIME_CLASSES_SHOULD_NOT_BE_USED_should_fail_when_class_uses_java_sql_time() {
+        assertThatRule(OLD_DATE_AND_TIME_CLASSES_SHOULD_NOT_BE_USED)
+                .hasDescription("java.time API should be used, because legacy date/time APIs have been replaced since Java 8 (JSR 310)")
+                .checking(new ClassFileImporter().importClasses(UsesJavaSqlTime.class))
+                .hasViolationContaining("calls constructor <java.sql.Time");
+    }
+
+    @Test
+    public void OLD_DATE_AND_TIME_CLASSES_SHOULD_NOT_BE_USED_should_fail_when_class_uses_java_sql_date() {
+        assertThatRule(OLD_DATE_AND_TIME_CLASSES_SHOULD_NOT_BE_USED)
+                .hasDescription("java.time API should be used, because legacy date/time APIs have been replaced since Java 8 (JSR 310)")
+                .checking(new ClassFileImporter().importClasses(UsesJavaSqlDate.class))
+                .hasViolationContaining("calls constructor <java.sql.Date");
+    }
+
+    @Test
+    public void OLD_DATE_AND_TIME_CLASSES_SHOULD_NOT_BE_USED_should_fail_when_class_uses_java_util_calender() {
+        assertThatRule(OLD_DATE_AND_TIME_CLASSES_SHOULD_NOT_BE_USED)
+                .hasDescription("java.time API should be used, because legacy date/time APIs have been replaced since Java 8 (JSR 310)")
+                .checking(new ClassFileImporter().importClasses(UsesJavaUtilCalender.class))
+                .hasViolationContaining("calls method <java.util.Calendar");
+    }
 }

archunit/src/test/java/com/tngtech/archunit/library/testclasses/timeapi/incorrect/UsesJavaSqlDate.java

@@ -0,0 +1,10 @@
+package com.tngtech.archunit.library.testclasses.timeapi.incorrect;
+
+import java.sql.Date;
+
+public class UsesJavaSqlDate {
+
+    void usesSqlDate() {
+        Date badUsage = new Date(System.currentTimeMillis());
+    }
+}

archunit/src/test/java/com/tngtech/archunit/library/testclasses/timeapi/incorrect/UsesJavaSqlTime.java

@@ -0,0 +1,10 @@
+package com.tngtech.archunit.library.testclasses.timeapi.incorrect;
+
+import java.sql.Time;
+
+public class UsesJavaSqlTime {
+
+    void usesSqlTimestamp() {
+        Time badUsage = new Time(System.currentTimeMillis());
+    }
+}

archunit/src/test/java/com/tngtech/archunit/library/testclasses/timeapi/incorrect/UsesJavaSqlTimestamp.java

@@ -0,0 +1,10 @@
+package com.tngtech.archunit.library.testclasses.timeapi.incorrect;
+
+import java.sql.Timestamp;
+
+public class UsesJavaSqlTimestamp {
+
+    void usesSqlTimestamp() {
+        Timestamp badUsage = new Timestamp(System.currentTimeMillis());
+    }
+}

archunit/src/test/java/com/tngtech/archunit/library/testclasses/timeapi/incorrect/UsesJavaUtilCalender.java

@@ -0,0 +1,10 @@
+package com.tngtech.archunit.library.testclasses.timeapi.incorrect;
+
+import java.util.Calendar;
+
+public class UsesJavaUtilCalender {
+
+    void usesJavaUtilCalender() {
+        Calendar badUsage = Calendar.getInstance();
+    }
+}

archunit/src/test/java/com/tngtech/archunit/library/testclasses/timeapi/incorrect/UsesJavaUtilDate.java

@@ -0,0 +1,11 @@
+package com.tngtech.archunit.library.testclasses.timeapi.incorrect;
+
+import java.time.Instant;
+import java.util.Date;
+
+public class UsesJavaUtilDate {
+
+    void usesJavaUtilDate() {
+        Date badDate = Date.from(Instant.now());
+    }
+}