Fix under-/overflow in min/max validation for controller parameters (#…

…324) * test: add testscase for overflow in javax/jakarta validation * fix: min/max annotation in controller uses long not int * chore: move controller tests to appropriate folder
cjbooms · Oct 9, 2024 · ebe07bc · ebe07bc
1 parent c590d09
commit ebe07bc
Show file tree

Hide file tree

Showing 9 changed files with 480 additions and 10 deletions.
diff --git a/src/main/kotlin/com/cjbooms/fabrikt/generators/ValidationAnnotations.kt b/src/main/kotlin/com/cjbooms/fabrikt/generators/ValidationAnnotations.kt
@@ -7,8 +7,8 @@ interface ValidationAnnotations {
     val nonNullAnnotation: AnnotationSpec?
     fun fieldValid(): AnnotationSpec?
     fun parameterValid(): AnnotationSpec?
-    fun min(value: Int): AnnotationSpec?
-    fun max(value: Int): AnnotationSpec?
+    fun min(value: Long): AnnotationSpec?
+    fun max(value: Long): AnnotationSpec?
     fun regexPattern(pattern: String): AnnotationSpec?
     fun lengthRestriction(min: Int?, max: Int?): AnnotationSpec?
     fun minRestriction(min: Number, exclusive: Boolean): AnnotationSpec?
@@ -39,12 +39,12 @@ abstract class PackageValidationAnnotations(packageName: String) : ValidationAnn
         .builder(validClass)
         .build()
 
-    override fun min(value: Int) = AnnotationSpec
+    override fun min(value: Long) = AnnotationSpec
         .builder(minClass)
         .addMember("%L", value)
         .build()
 
-    override fun max(value: Int) = AnnotationSpec
+    override fun max(value: Long) = AnnotationSpec
         .builder(maxClass)
         .addMember("%L", value)
         .build()
@@ -91,9 +91,9 @@ object NoValidationAnnotations : ValidationAnnotations {
 
     override fun parameterValid(): AnnotationSpec? = null
 
-    override fun min(value: Int): AnnotationSpec? = null
+    override fun min(value: Long): AnnotationSpec? = null
 
-    override fun max(value: Int): AnnotationSpec? = null
+    override fun max(value: Long): AnnotationSpec? = null
 
     override fun regexPattern(pattern: String): AnnotationSpec? = null
 

diff --git a/.../com/cjbooms/fabrikt/generators/controller/AnnotationBasedControllerInterfaceGenerator.kt b/.../com/cjbooms/fabrikt/generators/controller/AnnotationBasedControllerInterfaceGenerator.kt
@@ -48,8 +48,8 @@ abstract class AnnotationBasedControllerInterfaceGenerator(
     }
 
     fun ParameterSpec.Builder.addValidationAnnotations(parameter: RequestParameter): ParameterSpec.Builder {
-        if (parameter.minimum != null) this.maybeAddAnnotation(validationAnnotations.min(parameter.minimum.toInt()))
-        if (parameter.maximum != null) this.maybeAddAnnotation(validationAnnotations.max(parameter.maximum.toInt()))
+        if (parameter.minimum != null) this.maybeAddAnnotation(validationAnnotations.min(parameter.minimum.toLong()))
+        if (parameter.maximum != null) this.maybeAddAnnotation(validationAnnotations.max(parameter.maximum.toLong()))
         if (parameter.typeInfo.isComplexType) this.maybeAddAnnotation(validationAnnotations.parameterValid())
         return this
     }

diff --git a/src/test/kotlin/com/cjbooms/fabrikt/generators/KtorControllerInterfaceGeneratorTest.kt b/src/test/kotlin/com/cjbooms/fabrikt/generators/KtorControllerInterfaceGeneratorTest.kt
@@ -36,6 +36,7 @@ class KtorControllerInterfaceGeneratorTest {
         "pathLevelParameters",
         "parameterNameClash",
         "requestBodyAsArray",
+        "jakartaValidationAnnotations",
     )
 
     private fun setupGithubApiTestEnv() {
@@ -56,7 +57,7 @@ class KtorControllerInterfaceGeneratorTest {
     }
 
     // @Test
-    // fun `debug single test`() = `correct models are generated for different OpenApi Specifications`("singleAllOf")
+    // fun `debug single test`() = `correct controllers are generated for different OpenApi Specifications`("insert testcase here")
 
     @ParameterizedTest
     @MethodSource("testCases")

diff --git a/src/test/kotlin/com/cjbooms/fabrikt/generators/MicronautControllerGeneratorTest.kt b/src/test/kotlin/com/cjbooms/fabrikt/generators/MicronautControllerGeneratorTest.kt
@@ -38,6 +38,7 @@ class MicronautControllerGeneratorTest {
         "singleAllOf",
         "pathLevelParameters",
         "parameterNameClash",
+        "jakartaValidationAnnotations",
     )
 
     private fun setupGithubApiTestEnv(validationAnnotations: ValidationAnnotations = JavaxValidationAnnotations) {
@@ -55,7 +56,7 @@ class MicronautControllerGeneratorTest {
     }
 
     // @Test
-    // fun `debug single test`() = `correct models are generated for different OpenApi Specifications`("singleAllOf")
+    // fun `debug single test`() = `correct models are generated for different OpenApi Specifications`("insert testcase here")
 
     @ParameterizedTest
     @MethodSource("testCases")

diff --git a/src/test/kotlin/com/cjbooms/fabrikt/generators/SpringControllerGeneratorTest.kt b/src/test/kotlin/com/cjbooms/fabrikt/generators/SpringControllerGeneratorTest.kt
@@ -37,6 +37,7 @@ class SpringControllerGeneratorTest {
         "singleAllOf",
         "pathLevelParameters",
         "parameterNameClash",
+        "jakartaValidationAnnotations",
     )
 
     private fun setupGithubApiTestEnv(annotations: ValidationAnnotations = JavaxValidationAnnotations) {

diff --git a/src/test/resources/examples/jakartaValidationAnnotations/api.yaml b/src/test/resources/examples/jakartaValidationAnnotations/api.yaml
@@ -1,4 +1,83 @@
 openapi: 3.0.0
+paths:
+  /maximumTest/{pathId}:
+    get:
+      parameters:
+        - in: path
+          schema:
+            type: integer
+            format: int64
+            minimum: 0
+            maximum: 4294967295
+          name: pathId
+        - in: header
+          name: headerid
+          schema:
+            type: integer
+            format: int64
+            minimum: 0
+            maximum: 4294967295
+        - in: query
+          name: queryid
+          schema:
+            type: integer
+            format: int64
+            minimum: 0
+            maximum: 4294967295
+      responses:
+        204:
+          description: "result"
+  /minimumTest/{pathId}:
+    get:
+      parameters:
+        - in: path
+          schema:
+            type: integer
+            format: int64
+            minimum: -4294967295
+          name: pathId
+        - in: header
+          name: headerid
+          schema:
+            type: integer
+            format: int64
+            minimum: -4294967295
+        - in: query
+          name: queryid
+          schema:
+            type: integer
+            format: int64
+            minimum: -4294967295
+      responses:
+        204:
+          description: "result"
+  /minMaxTest/{pathId}:
+    get:
+      parameters:
+        - in: path
+          schema:
+            type: integer
+            format: int64
+            minimum: -4294967295
+            maximum: 4294967296
+          name: pathId
+        - in: header
+          name: headerid
+          schema:
+            type: integer
+            format: int64
+            minimum: -4294967295
+            maximum: 4294967296
+        - in: query
+          name: queryid
+          schema:
+            type: integer
+            format: int64
+            minimum: -4294967295
+            maximum: 4294967296
+      responses:
+        204:
+          description: "result"
 components:
   schemas:
     ValidationAnnotations: