#82, annotate string:email with email bean validation

Author: hauner

src/main/kotlin/io/openapiprocessor/core/converter/DataTypeConverter.kt

@@ -239,7 +239,8 @@ class DataTypeConverter(
             schemaInfo.getExclusiveMinimum(),
             schemaInfo.getMaximum(),
             schemaInfo.getExclusiveMaximum(),
-            pattern = schemaInfo.pattern
+            pattern = schemaInfo.pattern,
+            format = schemaInfo.getFormat()
         )
 
         return when(typeFormat) {

src/main/kotlin/io/openapiprocessor/core/model/datatypes/DataTypeConstraints.kt

@@ -21,8 +21,8 @@ class DataTypeConstraints(
     var /*val*/ minItems: Int = 0,
     var /*val*/ maxItems: Int? = null,
     var pattern: String? = null,
-    var /*val*/ required: List<String> = emptyList()
-
+    var /*val*/ required: List<String> = emptyList(),
+    val format: String? = null
 ) {
 
     fun getDefault(): Any? = defaultValue

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

@@ -8,6 +8,7 @@ package io.openapiprocessor.core.writer.java
 enum class BeanValidation(val typeName: String) {
     DECIMAL_MAX("javax.validation.constraints.DecimalMax"),
     DECIMAL_MIN("javax.validation.constraints.DecimalMin"),
+    EMAIL("javax.validation.constraints.Email"),
     NOT_NULL("javax.validation.constraints.NotNull"),
     PATTERN("javax.validation.constraints.Pattern"),
     SIZE("javax.validation.constraints.Size"),

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

@@ -64,6 +64,10 @@ open class BeanValidationFactory {
             imports.add(BeanValidation.PATTERN.import)
         }
 
+        if (dataType.emailConstraint()) {
+            imports.add(BeanValidation.EMAIL.import)
+        }
+
         return imports
     }
 
@@ -95,6 +99,10 @@ open class BeanValidationFactory {
             annotations.add(createPatternAnnotation(dataType))
         }
 
+        if (dataType.emailConstraint()) {
+            annotations.add(BeanValidation.EMAIL.annotation)
+        }
+
         return annotations
     }
 
@@ -195,3 +203,5 @@ private fun DataType.lengthConstraints(): SizeConstraints = constraints?.lengthC
 private fun DataType.itemConstraints(): SizeConstraints = constraints?.itemConstraints!!
 
 private fun DataType.patternConstraint(): Boolean = constraints?.pattern != null
+
+private fun DataType.emailConstraint(): Boolean = "email" == constraints?.format

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

@@ -220,4 +220,20 @@ class BeanValidationFactorySpec: StringSpec({
         io.annotations shouldBe emptySet()
     }
 
+    "applies @Email to String" {
+        val validation = BeanValidationFactory()
+
+        val dataType = StringDataType(constraints = DataTypeConstraints(format = "email"))
+        val info = validation.validate(dataType)
+
+        val prop = info.prop
+        prop.dataTypeValue shouldBe "String"
+        info.imports shouldBe setOf(BeanValidation.EMAIL.import)
+        info.annotations shouldBe setOf(BeanValidation.EMAIL.annotation)
+
+        val io = info.inout
+        io.dataTypeValue shouldBe """${BeanValidation.EMAIL.annotation} String"""
+        io.imports shouldBe setOf(BeanValidation.EMAIL.import)
+        io.annotations shouldBe emptySet()
+    }
 })

src/testInt/resources/tests/bean-validation/generated/api/EndpointApi.java

@@ -11,6 +11,7 @@
 import javax.validation.Valid;
 import javax.validation.constraints.DecimalMax;
 import javax.validation.constraints.DecimalMin;
+import javax.validation.constraints.Email;
 import javax.validation.constraints.NotNull;
 import javax.validation.constraints.Pattern;
 import javax.validation.constraints.Size;
@@ -51,4 +52,7 @@ void getEndpointItems(
     @Mapping("/endpoint/pattern")
     void getEndpointPattern(@Parameter @Pattern(regexp = ".*\\.\\\\") String anything);
 
+    @Mapping("/endpoint/email")
+    void getEndpointEmail(@Parameter @Email String anything);
+
 }

src/testInt/resources/tests/bean-validation/inputs/openapi.yaml

@@ -158,6 +158,21 @@ paths:
         '204':
           description: empty
 
+  /endpoint/email:
+    get:
+      tags:
+        - endpoint
+      parameters:
+        - in: query
+          name: anything
+          schema:
+            type: string
+            format: email
+            description: email format
+      responses:
+        '204':
+          description: empty
+
 components:
   schemas:
     Obj1: