feat: adjust date time property suffix rule (#1536)

Signed-off-by: Tronje Krop <[email protected]>

Author: tkrop

server/zally-ruleset-zalando/src/main/kotlin/org/zalando/zally/ruleset/zalando/DateTimePropertiesSuffixRule.kt

@@ -13,7 +13,7 @@ import org.zalando.zally.rule.api.Violation
     ruleSet = ZalandoRuleSet::class,
     id = "235",
     severity = Severity.SHOULD,
-    title = "Name date/time properties using the \"_at\" suffix"
+    title = "Name date/time properties using the common suffix"
 )
 class DateTimePropertiesSuffixRule(rulesConfig: Config) {
 
@@ -22,7 +22,7 @@ class DateTimePropertiesSuffixRule(rulesConfig: Config) {
         .map { Regex(it) }
         .toSet()
 
-    private val propertyFormats = setOf("date", "date-time")
+    private val propertyFormats = setOf("date", "time", "date-time")
 
     @Check(severity = Severity.SHOULD)
     fun validate(context: Context): List<Violation> {

server/zally-ruleset-zalando/src/main/resources/reference.conf

@@ -216,7 +216,11 @@ ProprietaryHeadersRule {
 
 DateTimePropertiesSuffixRule {
   patterns: [
-    ".*_at"
+    ".*_at$",
+    "(.*_)*time(_.*)*",
+    "(.*_)*timestamp(_.*)*",
+    "(.*_)*date(_.*)*",
+    "(.*_)*day(_.*)*",
   ]
 }
 

server/zally-ruleset-zalando/src/test/kotlin/org/zalando/zally/ruleset/zalando/DateTimePropertiesSuffixRuleTest.kt

@@ -2,7 +2,6 @@
 
 package org.zalando.zally.ruleset.zalando
 
-import com.typesafe.config.ConfigValueFactory
 import org.assertj.core.api.Assertions.assertThat
 import org.intellij.lang.annotations.Language
 import org.junit.jupiter.api.Test
@@ -14,7 +13,7 @@ class DateTimePropertiesSuffixRuleTest {
     private val rule = DateTimePropertiesSuffixRule(rulesConfig)
 
     @Test
-    fun `rule should pass with correct 'date-time' fields`() {
+    fun `should pass with correct format and suffix`() {
         @Language("YAML")
         val content = """
             openapi: '3.0.1'
@@ -28,44 +27,18 @@ class DateTimePropertiesSuffixRuleTest {
                     created_at:
                       type: string
                       format: date-time
-                    modified_at:
+                    modified_time:
                       type: string
-                      format: date-time                      
-                    occurred_at:
+                      format: time
+                    occurred_timestamp:
                       type: string
                       format: date-time                      
-                    returned_at:
-                      type: string
-                      format: date-time
-        """.trimIndent()
-        val violations = rule.validate(DefaultContextFactory().getOpenApiContext(content))
-        assertThat(violations).isEmpty()
-    }
-
-    @Test
-    fun `rule should pass with correct 'date' fields`() {
-        @Language("YAML")
-        val content = """
-            openapi: '3.0.1'
-            info:
-              title: Test API
-              version: 1.0.0
-            components:
-              schemas:
-                Car:
-                  properties:
-                    created_at:
+                    returned_date:
                       type: string
                       format: date
-                    modified_at:
-                      type: string
-                      format: date                      
-                    occurred_at:
+                    delivered_day:
                       type: string
-                      format: date                      
-                    returned_at:
-                      type: string
-                      format: date                  
+                      format: date
         """.trimIndent()
         val violations = rule.validate(DefaultContextFactory().getOpenApiContext(content))
         assertThat(violations).isEmpty()
@@ -84,20 +57,23 @@ class DateTimePropertiesSuffixRuleTest {
                 Car:
                   properties:
                     created:
-                      type: string                      
+                      type: string
+                    modified:
+                      type: enum
+                      enum: [ "yes", "no" ]
                     occurred:
                       type: string                      
                     returned:
                       type: string                      
-                    modified:
+                    delivered:
                       type: int                                          
         """.trimIndent()
         val violations = rule.validate(DefaultContextFactory().getOpenApiContext(content))
         assertThat(violations).isEmpty()
     }
 
     @Test
-    fun `rule should fail to validate schema`() {
+    fun `should fail on suffix _at and succeed on infix patterns`() {
         @Language("YAML")
         val content = """
             openapi: '3.0.1'
@@ -108,30 +84,30 @@ class DateTimePropertiesSuffixRuleTest {
               schemas:
                 Car:
                   properties:
-                    created:
+                    created_at_suffix:
                       type: string
                       format: date-time
-                    occurred:
+                    modified_time_suffix:
                       type: string
-                      format: date
-                    returned:
+                      format: time
+                    occurred_timestamp_suffix:
                       type: string
                       format: date-time
-                    modified:
+                    returned_date_suffix:
+                      type: string
+                      format: date
+                    delivered_day_suffix:
                       type: string
                       format: date
         """.trimIndent()
         val violations = rule.validate(DefaultContextFactory().getOpenApiContext(content))
         assertThat(violations.map { it.description }).containsExactly(
-            rule.generateMessage("created", "string", "date-time"),
-            rule.generateMessage("occurred", "string", "date"),
-            rule.generateMessage("returned", "string", "date-time"),
-            rule.generateMessage("modified", "string", "date")
+            rule.generateMessage("created_at_suffix", "string", "date-time")
         )
     }
 
     @Test
-    fun `rule should support different patterns`() {
+    fun `should fail on prefix _at and succeed on prefix patterns`() {
         @Language("YAML")
         val content = """
             openapi: '3.0.1'
@@ -142,19 +118,25 @@ class DateTimePropertiesSuffixRuleTest {
               schemas:
                 Car:
                   properties:
-                    created:
+                    at_created:
                       type: string
                       format: date-time
-                    modified:
+                    time_modified:
+                      type: string
+                      format: time
+                    timestamp_occurred:
+                      type: string
+                      format: date-time
+                    date_returned:
+                      type: string
+                      format: date
+                    day_delivered:
                       type: string
                       format: date
         """.trimIndent()
-        val newConfig = rulesConfig.withValue("DateTimePropertiesSuffixRule/patterns", ConfigValueFactory.fromIterable(listOf("was_.*")))
-        val customRule = DateTimePropertiesSuffixRule(newConfig)
-        val violations = customRule.validate(DefaultContextFactory().getOpenApiContext(content))
+        val violations = rule.validate(DefaultContextFactory().getOpenApiContext(content))
         assertThat(violations.map { it.description }).containsExactly(
-            customRule.generateMessage("created", "string", "date-time"),
-            customRule.generateMessage("modified", "string", "date")
+            rule.generateMessage("at_created", "string", "date-time")
         )
     }
 }