Add java.util.Calendar to DenyListedApiDetector (#351)

* Improve code coverage of DenyListedApiDetector * Add deny list entries for java.util.Calendar * Improve deny list error messages for java.util.Calendar
slackhq · Feb 17, 2025 · a29179f · a29179f
1 parent 7cb36a6
commit a29179f
Show file tree

Hide file tree

Showing 2 changed files with 215 additions and 0 deletions.
diff --git a/slack-lint-checks/src/main/java/slack/lint/denylistedapis/DenyListedApiDetector.kt b/slack-lint-checks/src/main/java/slack/lint/denylistedapis/DenyListedApiDetector.kt
@@ -421,6 +421,18 @@ internal class DenyListedApiDetector : Detector(), SourceCodeScanner, XmlScanner
           errorMessage =
             "Use java.time.Instant or java.time.ZonedDateTime instead. There is no reason to use java.util.Date in Java 8+.",
         ),
+        DenyListedEntry(
+          className = "java.util.Calendar",
+          fieldName = MatchAll,
+          errorMessage =
+            "Use java.time.Instant or java.time.ZonedDateTime instead. There is no reason to use java.util.Calendar in Java 8+.",
+        ),
+        DenyListedEntry(
+          className = "java.util.Calendar",
+          functionName = MatchAll,
+          errorMessage =
+            "Use java.time.Instant or java.time.ZonedDateTime instead. There is no reason to use java.util.Calendar in Java 8+.",
+        ),
         DenyListedEntry(
           className = "java.text.DateFormat",
           fieldName = MatchAll,

diff --git a/slack-lint-checks/src/test/java/slack/lint/denylistedapis/DenyListedApiDetectorTest.kt b/slack-lint-checks/src/test/java/slack/lint/denylistedapis/DenyListedApiDetectorTest.kt
@@ -423,6 +423,209 @@ class DenyListedApiDetectorTest : BaseSlackLintTest() {
       )
   }
 
+  @Test
+  fun javaUtilDate() {
+    lint()
+      .files(
+        kotlin(
+            """
+          package foo
+
+          import java.util.Date
+
+          class SomeClass {
+            val now = Date()
+          }
+          """
+          )
+          .indented()
+      )
+      .run()
+      .expect(
+        """
+        src/foo/SomeClass.kt:6: Error: Use java.time.Instant or java.time.ZonedDateTime instead. There is no reason to use java.util.Date in Java 8+. [DenyListedApi]
+          val now = Date()
+                    ~~~~
+        1 errors, 0 warnings
+        """
+          .trimIndent()
+      )
+  }
+
+  @Test
+  fun javaTextDateFormatField() {
+    lint()
+      .files(
+        kotlin(
+            """
+          package foo
+
+          import java.text.DateFormat
+
+          class SomeClass {
+            val yearField = DateFormat.YEAR_FIELD
+          }
+          """
+          )
+          .indented()
+      )
+      .run()
+      .expect(
+        """
+        src/foo/SomeClass.kt:6: Error: Use java.time.DateTimeFormatter instead. There is no reason to use java.text.DateFormat in Java 8+. [DenyListedApi]
+          val yearField = DateFormat.YEAR_FIELD
+                          ~~~~~~~~~~~~~~~~~~~~~
+        1 errors, 0 warnings
+        """
+          .trimIndent()
+      )
+  }
+
+  @Test
+  fun javaTextDateFormatFunction() {
+    lint()
+      .files(
+        kotlin(
+            """
+          package foo
+
+          import java.text.DateFormat
+
+          class SomeClass {
+            val dateFormat = DateFormat.getDateInstance()
+          }
+          """
+          )
+          .indented()
+      )
+      .run()
+      .expect(
+        """
+        src/foo/SomeClass.kt:6: Error: Use java.time.DateTimeFormatter instead. There is no reason to use java.text.DateFormat in Java 8+. [DenyListedApi]
+          val dateFormat = DateFormat.getDateInstance()
+                                      ~~~~~~~~~~~~~~~
+        1 errors, 0 warnings
+        """
+          .trimIndent()
+      )
+  }
+
+  @Test
+  fun javaTextSimpleDateFormatField() {
+    lint()
+      .files(
+        kotlin(
+            """
+          package foo
+
+          import java.text.SimpleDateFormat
+
+          class SomeClass {
+            val yearField = SimpleDateFormat.YEAR_FIELD
+          }
+          """
+          )
+          .indented()
+      )
+      .run()
+      .expect(
+        """
+        src/foo/SomeClass.kt:6: Error: Use java.time.DateTimeFormatter instead. There is no reason to use java.text.DateFormat in Java 8+. [DenyListedApi]
+          val yearField = SimpleDateFormat.YEAR_FIELD
+                          ~~~~~~~~~~~~~~~~~~~~~~~~~~~
+        1 errors, 0 warnings
+        """
+          .trimIndent()
+      )
+  }
+
+  @Test
+  fun javaTextSimpleDateFormatFunction() {
+    lint()
+      .files(
+        kotlin(
+            """
+          package foo
+
+          import java.text.SimpleDateFormat
+
+          class SomeClass {
+            val dateFormat = SimpleDateFormat.getDateInstance()
+          }
+          """
+          )
+          .indented()
+      )
+      .run()
+      .expect(
+        """
+        src/foo/SomeClass.kt:6: Error: Use java.time.DateTimeFormatter instead. There is no reason to use java.text.DateFormat in Java 8+. [DenyListedApi]
+          val dateFormat = SimpleDateFormat.getDateInstance()
+                                            ~~~~~~~~~~~~~~~
+        1 errors, 0 warnings
+        """
+          .trimIndent()
+      )
+  }
+
+  @Test
+  fun javaUtilCalendarField() {
+    lint()
+      .files(
+        kotlin(
+            """
+          package foo
+
+          import java.util.Calendar
+
+          class SomeClass {
+            val hourOfDay = Calendar.HOUR_OF_DAY
+          }
+          """
+          )
+          .indented()
+      )
+      .run()
+      .expect(
+        """
+        src/foo/SomeClass.kt:6: Error: Use java.time.Instant or java.time.ZonedDateTime instead. There is no reason to use java.util.Calendar in Java 8+. [DenyListedApi]
+          val hourOfDay = Calendar.HOUR_OF_DAY
+                          ~~~~~~~~~~~~~~~~~~~~
+        1 errors, 0 warnings
+        """
+          .trimIndent()
+      )
+  }
+
+  @Test
+  fun javaUtilCalendarFunction() {
+    lint()
+      .files(
+        kotlin(
+            """
+          package foo
+
+          import java.util.Calendar
+
+          class SomeClass {
+            val calendar = Calendar.getInstance()
+          }
+          """
+          )
+          .indented()
+      )
+      .run()
+      .expect(
+        """
+        src/foo/SomeClass.kt:6: Error: Use java.time.Instant or java.time.ZonedDateTime instead. There is no reason to use java.util.Calendar in Java 8+. [DenyListedApi]
+          val calendar = Calendar.getInstance()
+                                  ~~~~~~~~~~~
+        1 errors, 0 warnings
+        """
+          .trimIndent()
+      )
+  }
+
   @Test
   fun rxCompletableParameterless() {
     lint()