openapi-processor/openapi-processor-spring#198, add string values constraints annotation

Author: hauner

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/BeanValidation.kt

@@ -19,4 +19,5 @@ class BeanValidations(val format: BeanValidationFormat = BeanValidationFormat.JA
     val PATTERN = "${format.pkg}.validation.constraints.Pattern"
     val SIZE = "${format.pkg}.validation.constraints.Size"
     val VALID = "${format.pkg}.validation.Valid"
+    val VALUES = "support.validation.Values"
 }

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/BeanValidationFactory.kt

@@ -5,6 +5,7 @@
 
 package io.openapiprocessor.core.writer.java
 
+import io.openapiprocessor.core.converter.ApiOptions
 import io.openapiprocessor.core.converter.mapping.ParameterValue
 import io.openapiprocessor.core.converter.mapping.SimpleParameterValue
 import io.openapiprocessor.core.model.Annotation
@@ -15,9 +16,9 @@ import org.apache.commons.text.StringEscapeUtils.escapeJava
  * creates bean validation imports and annotations.
  */
 open class BeanValidationFactory(
-    val format: BeanValidationFormat = BeanValidationFormat.JAVAX
+    private val options: ApiOptions
 ) {
-    val validations: BeanValidations = BeanValidations(format)
+    val validations: BeanValidations = BeanValidations(getValidationFormat())
 
     /**
      * override to add annotations to the model object class.
@@ -73,6 +74,10 @@ open class BeanValidationFactory(
             annotations.add(createEmailAnnotation())
         }
 
+        if (sourceDataType.valuesConstraint()) {
+            annotations.add(createValuesAnnotation(dataType))
+        }
+
         return annotations
     }
 
@@ -141,6 +146,26 @@ open class BeanValidationFactory(
     private fun createEmailAnnotation(): Annotation {
         return Annotation(validations.EMAIL)
     }
+
+    private fun createValuesAnnotation(dataType: DataType): Annotation {
+        val parameters = linkedMapOf<String, ParameterValue>()
+
+        val params = StringBuilder()
+        params.append("{")
+        params.append(dataType.constraints!!.values.joinToString(", ") { """"$it"""" })
+        params.append("}")
+
+        parameters["values"] = SimpleParameterValue(params.toString())
+        return Annotation("${options.packageName}.${validations.VALUES}", parameters)
+    }
+
+    private fun getValidationFormat(): BeanValidationFormat {
+        val format = options.beanValidationFormat
+        return if (format != null)
+            BeanValidationFormat.valueOf(format.uppercase())
+        else
+            BeanValidationFormat.JAVAX
+    }
 }
 
 private fun DataType.shouldHaveValid(): Boolean {
@@ -194,3 +219,5 @@ private fun DataType.itemConstraints(): SizeConstraints = constraints?.itemConst
 private fun DataType.patternConstraint(): Boolean = constraints?.pattern != null
 
 private fun DataType.emailConstraint(): Boolean = "email" == constraints?.format
+
+private fun DataType.valuesConstraint(): Boolean = isString() && constraints?.values?.isNotEmpty() == true

openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/writer/java/BeanValidationFactorySpec.kt

@@ -9,6 +9,7 @@ import io.kotest.core.spec.IsolationMode
 import io.kotest.core.spec.style.StringSpec
 import io.kotest.matchers.collections.shouldBeEmpty
 import io.kotest.matchers.shouldBe
+import io.openapiprocessor.core.converter.ApiOptions
 import io.openapiprocessor.core.model.datatypes.*
 import io.openapiprocessor.core.support.datatypes.ListDataType
 import io.openapiprocessor.core.support.datatypes.ObjectDataType
@@ -18,7 +19,8 @@ import io.openapiprocessor.core.support.datatypes.propertyDataTypeString
 class BeanValidationFactorySpec : StringSpec({
     isolationMode = IsolationMode.InstancePerTest
 
-    val validation = BeanValidationFactory()
+    val apiOptions = ApiOptions()
+    val validation = BeanValidationFactory(apiOptions)
     val validations = validation.validations
 
     "applies @Valid to 'array' with object items" {
@@ -175,4 +177,21 @@ class BeanValidationFactorySpec : StringSpec({
         io.imports shouldBe setOf(validations.EMAIL)
         io.annotations.shouldBeEmpty()
     }
+
+    "applies @Values to String" {
+        apiOptions.packageName = "package.name"
+
+        val dataType = StringDataType(constraints = DataTypeConstraints(values = listOf("foo", "bar")))
+        val info = validation.validate(dataType)
+
+        val prop = info.prop
+        prop.dataTypeValue shouldBe "String"
+        prop.imports shouldBe setOf("${apiOptions.packageName}.support.validation.Values")
+        prop.annotations shouldBe setOf("""@Values(values = {"foo", "bar"})""")
+
+        val io = info.inout
+        io.dataTypeValue shouldBe """@Values(values = {"foo", "bar"}) String"""
+        io.imports shouldBe setOf("${apiOptions.packageName}.support.validation.Values")
+        io.annotations.shouldBeEmpty()
+    }
 })