openapi-processor/openapi-processor-spring#198, generate enum values validator

hauner · hauner · commit e9a41ff44907 · 2023-10-31T16:57:53.000+01:00
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/ApiWriter.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/ApiWriter.kt
@@ -24,6 +24,7 @@ import java.io.Writer
 class ApiWriter(
     private val options: ApiOptions,
     private val generatedWriter: GeneratedWriter,
+    private val validationWriter: ValidationWriter,
     private val interfaceWriter: InterfaceWriter,
     private val dataTypeWriter: DataTypeWriter,
     private val enumWriter: StringEnumWriter,
@@ -37,9 +38,9 @@ class ApiWriter(
         }
     }
 
-
     fun write(api: Api) {
         writeGenerated()
+        writeValidation()
         writeInterfaces(api)
         writeObjectDataTypes(api)
         writeInterfaceDataTypes(api)
@@ -52,6 +53,19 @@ class ApiWriter(
         writer.close()
     }
 
+    private fun writeValidation() {
+        if (!options.beanValidation)
+            return
+
+        val vWriter = getWriter("${options.packageName}.validation", "Values")
+        writeValues(vWriter)
+        vWriter.close()
+
+        val vvWriter = getWriter("${options.packageName}.validation", "ValueValidator")
+        writeValueValidator(vvWriter)
+        vvWriter.close()
+    }
+
     private fun writeInterfaces(api: Api) {
         api.forEachInterface {
             val writer = getWriter(it.getPackageName(), it.getInterfaceName())
@@ -114,6 +128,18 @@ class ApiWriter(
         writer.write(format(raw.toString()))
     }
 
+    private fun writeValues(writer: Writer) {
+        val raw = StringWriter()
+        validationWriter.writeValues(raw)
+        writer.write(format(raw.toString()))
+    }
+
+    private fun writeValueValidator(writer: Writer) {
+        val raw = StringWriter()
+        validationWriter.writeValueValidator(raw)
+        writer.write(format(raw.toString()))
+    }
+
     private fun getWriter(packageName: String, className: String): Writer {
         return writerFactory.createWriter(packageName, className)
     }
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/ValidationWriter.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/ValidationWriter.kt
@@ -0,0 +1,60 @@
+/*
+ * Copyright 2023 https://github.com/openapi-processor/openapi-processor-base
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.core.writer.java
+
+import io.openapiprocessor.core.converter.ApiOptions
+import java.io.Writer
+
+class ValidationWriter(val options: ApiOptions) {
+
+    fun writeValues(target: Writer) {
+        target.write("""
+            package ${options.packageName}.validation;
+
+            import ${options.beanValidationFormat}.validation.Constraint;
+            import ${options.beanValidationFormat}.validation.Payload;
+            import java.lang.annotation.*;
+    
+            @Target({ElementType.FIELD, ElementType.PARAMETER})
+            @Retention(RetentionPolicy.RUNTIME)
+            @Constraint(validatedBy = ValueValidator.class)
+            @Documented
+            public @interface Values {
+                String message() default "Invalid value. Should be one of values.";
+                Class<?>[] groups() default {};
+                Class<? extends Payload>[] payload() default {};
+                String[] values() default {};
+            }
+            
+            """.trimIndent())
+    }
+
+    fun writeValueValidator(target: Writer) {
+        target.write("""
+            package ${options.packageName}.validation;
+
+            import jakarta.validation.ConstraintValidator;
+            import jakarta.validation.ConstraintValidatorContext;
+            
+            import java.util.Arrays;
+
+            public class ValueValidator implements ConstraintValidator<Values, String> {
+                private String[] values;
+
+                @Override
+                public void initialize (Values constraintAnnotation) {
+                    values = constraintAnnotation.values();
+                }
+
+                @Override
+                public boolean isValid (String value, ConstraintValidatorContext context) {
+                    return value != null && Arrays.asList(values).contains(value);
+                }
+            }
+
+            """.trimIndent())
+    }
+}
diff --git a/openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/writer/java/ApiWriterSpec.kt b/openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/writer/java/ApiWriterSpec.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020 https://github.com/openapi-processor/openapi-processor-core
+ * Copyright 2020 https://github.com/openapi-processor/openapi-processor-base
  * PDX-License-Identifier: Apache-2.0
  */
 
@@ -55,7 +55,7 @@ class ApiWriterSpec: StringSpec({
         val api = Api(dataTypes = dts)
 
         val enumWriter = stub<StringEnumWriter>(relaxed = true)
-        ApiWriter(options, stub(relaxed = true), stub(), stub(), enumWriter, stub(), nf, wfStub)
+        ApiWriter(options, stub(relaxed = true), stub(), stub(), stub(), enumWriter, stub(), nf, wfStub)
             .write(api)
 
         verify(exactly = 1) { enumWriter.write(any(), dtA) }
@@ -70,7 +70,7 @@ class ApiWriterSpec: StringSpec({
         dts.addRef("Foo")
         val api = Api(dataTypes = dts)
 
-        ApiWriter(options, stub(relaxed = true), stub(), stub(), stub(relaxed = true), stub(), formatter, wfStub)
+        ApiWriter(options, stub(relaxed = true), stub(), stub(), stub(), stub(relaxed = true), stub(), formatter, wfStub)
             .write(api)
 
         verify (exactly = 2) { formatter.format(any()) }
@@ -84,7 +84,7 @@ class ApiWriterSpec: StringSpec({
         val api = Api(itfs)
 
         val itfWriter = stub<InterfaceWriter>(relaxed = true)
-        ApiWriter(options, stub(relaxed = true), itfWriter, stub(), stub(), stub(), nf, wfStub)
+        ApiWriter(options, stub(relaxed = true), stub(), itfWriter, stub(), stub(), stub(), nf, wfStub)
             .write (api)
 
         verify(exactly = 1) { itfWriter.write(any(), itfs[0]) }
@@ -99,7 +99,7 @@ class ApiWriterSpec: StringSpec({
         )
         val api = Api(itfs)
 
-        ApiWriter(options, stub(relaxed = true), stub(relaxed = true), stub(), stub(), stub(), formatter, wfStub)
+        ApiWriter(options, stub(relaxed = true), stub(), stub(relaxed = true), stub(), stub(), stub(), formatter, wfStub)
             .write(api)
 
         verify (exactly = 2) { formatter.format(any()) }
@@ -119,7 +119,7 @@ class ApiWriterSpec: StringSpec({
         val api = Api(dataTypes = dts)
 
         val dtWriter = stub<DataTypeWriter>(relaxed = true)
-        ApiWriter(options, stub(relaxed = true), stub(), dtWriter, stub(), stub(), nf, wfStub)
+        ApiWriter(options, stub(relaxed = true), stub(), stub(), dtWriter, stub(), stub(), nf, wfStub)
             .write (api)
 
         verify(exactly = 1) { dtWriter.write(any(), dtA) }
@@ -134,7 +134,7 @@ class ApiWriterSpec: StringSpec({
         dts.addRef("Foo")
         val api = Api(dataTypes = dts)
 
-        ApiWriter(options, stub(relaxed = true), stub(), stub(relaxed = true), stub(), stub(), formatter, wfStub)
+        ApiWriter(options, stub(relaxed = true), stub(), stub(), stub(relaxed = true), stub(), stub(), formatter, wfStub)
             .write(api)
 
         verify (exactly = 2) { formatter.format(any()) }
@@ -154,7 +154,7 @@ class ApiWriterSpec: StringSpec({
         val api = Api(dataTypes = dts)
 
         val dtWriter = stub<InterfaceDataTypeWriter>(relaxed = true)
-        ApiWriter(options, stub(relaxed = true), stub(), stub(), stub(), dtWriter, nf, wfStub)
+        ApiWriter(options, stub(relaxed = true), stub(), stub(), stub(), stub(), dtWriter, nf, wfStub)
             .write (api)
 
         verify(exactly = 1) { dtWriter.write(any(), dtA) }
@@ -169,7 +169,7 @@ class ApiWriterSpec: StringSpec({
         dts.addRef("Foo")
         val api = Api(dataTypes = dts)
 
-        ApiWriter(options, stub(relaxed = true), stub(), stub(), stub(), stub(relaxed = true), formatter, wfStub)
+        ApiWriter(options, stub(relaxed = true), stub(), stub(), stub(), stub(), stub(relaxed = true), formatter, wfStub)
             .write(api)
 
         verify (exactly = 2) { formatter.format(any()) }
@@ -184,7 +184,7 @@ class ApiWriterSpec: StringSpec({
         val api = Api(dataTypes = dt)
 
         // when:
-        ApiWriter(options, gwStub, stub(), dtWriter, stub(), stub()).write (api)
+        ApiWriter(options, gwStub, stub(), stub(), dtWriter, stub(), stub()).write (api)
 
         // then:
         verify(exactly = 0) {
@@ -201,11 +201,25 @@ class ApiWriterSpec: StringSpec({
         val api = Api(dataTypes = dts)
 
         options.formatCode = false
-        ApiWriter(options, stub(relaxed = true), stub(), stub(), stub(), stub(relaxed = true), formatter, wfStub)
+        ApiWriter(options, stub(relaxed = true), stub(), stub(), stub(), stub(), stub(relaxed = true), formatter, wfStub)
             .write(api)
 
         verify (exactly = 0) { formatter.format(any()) }
     }
+
+    "writes custom validation sources" {
+        val validation = stub<ValidationWriter>(relaxed = true)
+
+        val dts = DataTypes()
+        options.beanValidation = true
+        val api = Api(dataTypes = dts)
+
+        ApiWriter(options, stub(relaxed = true), validation, stub(), stub(), stub(), stub(), nf, wfStub)
+            .write(api)
+
+        verify(exactly = 1) { validation.writeValues(any()) }
+        verify(exactly = 1) { validation.writeValueValidator(any()) }
+    }
 })
 
 private fun ApiOptions.getSourceDir(pkg: String): Path {
diff --git a/openapi-processor-core/src/testInt/kotlin/io/openapiprocessor/core/TestProcessor.kt b/openapi-processor-core/src/testInt/kotlin/io/openapiprocessor/core/TestProcessor.kt
@@ -52,6 +52,7 @@ class TestProcessor:
             val writer = ApiWriter(
                 options,
                 generatedWriter,
+                ValidationWriter(options),
                 InterfaceWriter(
                     options,
                     generatedWriter,
