Use common base class for validation exceptions

bargergo · bargergo · commit d527139daab1 · 2020-05-28T22:54:27.000+02:00
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/common/ConstraintViolation.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/common/ConstraintViolation.kt
@@ -0,0 +1,6 @@
+package com.papsign.ktor.openapigen.annotations.type.common
+
+import java.lang.Exception
+
+abstract class ConstraintViolation(defaultMessage: String, message: String = "", cause: Throwable? = null)
+    : Exception(if (message.isEmpty()) defaultMessage else message, cause)
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/NumberConstraintProcessor.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/NumberConstraintProcessor.kt
@@ -1,11 +1,11 @@
 package com.papsign.ktor.openapigen.annotations.type.number
 
+import com.papsign.ktor.openapigen.annotations.type.common.ConstraintViolation
 import com.papsign.ktor.openapigen.classLogger
 import com.papsign.ktor.openapigen.model.schema.SchemaModel
 import com.papsign.ktor.openapigen.schema.processor.SchemaProcessor
 import com.papsign.ktor.openapigen.validation.Validator
 import com.papsign.ktor.openapigen.validation.ValidatorBuilder
-import java.lang.Exception
 import java.math.BigDecimal
 import kotlin.reflect.KType
 import kotlin.reflect.full.withNullability
@@ -61,9 +61,7 @@ abstract class NumberConstraintProcessor<A: Annotation>(allowedTypes: Iterable<K
 
 data class NumberConstraint(val min: BigDecimal? = null, val max: BigDecimal? = null, val minInclusive: Boolean = true, val maxInclusive: Boolean = true)
 
-open class ConstraintVialoation(message: String, cause: Throwable? = null): Exception(message, cause)
-
-class NumberConstraintViolation(val actual: Number?, val constraint: NumberConstraint): ConstraintVialoation("Constraint violation: $actual should be ${
+class NumberConstraintViolation(val actual: Number?, val constraint: NumberConstraint): ConstraintViolation("Constraint violation: $actual should be ${
 {
     val min = "${constraint.min} ${if (constraint.minInclusive) "inclusive" else "exclusive"}"
     val max = "${constraint.max} ${if (constraint.maxInclusive) "inclusive" else "exclusive"}"
@@ -76,4 +74,4 @@ class NumberConstraintViolation(val actual: Number?, val constraint: NumberConst
 }()
 }")
 
-class NotANumberViolationViolation(val value: Any?): ConstraintVialoation("Constraint violation: $value is not a number")
+class NotANumberViolationViolation(val value: Any?): ConstraintViolation("Constraint violation: $value is not a number")
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/string/NotAStringViolation.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/string/NotAStringViolation.kt
@@ -0,0 +1,5 @@
+package com.papsign.ktor.openapigen.annotations.type.string
+
+import com.papsign.ktor.openapigen.annotations.type.common.ConstraintViolation
+
+class NotAStringViolation(val value: Any?): ConstraintViolation("Constraint violation: $value is not a string")
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/string/length/LengthConstraintProcessor.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/string/length/LengthConstraintProcessor.kt
@@ -1,12 +1,13 @@
 package com.papsign.ktor.openapigen.annotations.type.string.length
 
+import com.papsign.ktor.openapigen.annotations.type.common.ConstraintViolation
+import com.papsign.ktor.openapigen.annotations.type.string.NotAStringViolation
 import com.papsign.ktor.openapigen.classLogger
 import com.papsign.ktor.openapigen.getKType
 import com.papsign.ktor.openapigen.model.schema.SchemaModel
 import com.papsign.ktor.openapigen.schema.processor.SchemaProcessor
 import com.papsign.ktor.openapigen.validation.Validator
 import com.papsign.ktor.openapigen.validation.ValidatorBuilder
-import java.lang.Exception
 import kotlin.reflect.KType
 import kotlin.reflect.full.withNullability
 
@@ -55,11 +56,9 @@ abstract class LengthConstraintProcessor<A: Annotation>(): SchemaProcessor<A>, V
     }
 }
 
-data class LengthConstraint(val min: Int? = null, val max: Int? = null, val errorMessage: String? = null)
+data class LengthConstraint(val min: Int? = null, val max: Int? = null, val errorMessage: String)
 
-open class ConstraintViolation(message: String, cause: Throwable? = null): Exception(message, cause)
-
-class LengthConstraintViolation(val actual: Number?, val constraint: LengthConstraint): ConstraintViolation(constraint.errorMessage ?: "Constraint violation: the length of the string should be ${
+class LengthConstraintViolation(val actual: Number?, val constraint: LengthConstraint): ConstraintViolation("Constraint violation: the length of the string should be ${
 {
     val min = "${constraint.min}"
     val max = "${constraint.max}"
@@ -70,6 +69,4 @@ class LengthConstraintViolation(val actual: Number?, val constraint: LengthConst
         else -> "anything"
     }
 }()
-}, but it is $actual")
-
-class NotAStringViolation(val value: Any?): ConstraintViolation("Constraint violation: $value is not a string")
+}, but it is $actual", constraint.errorMessage)
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/string/length/LengthProcessor.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/string/length/LengthProcessor.kt
@@ -12,7 +12,6 @@ object LengthProcessor : LengthConstraintProcessor<Length>() {
     }
 
     override fun getConstraint(annotation: Length): LengthConstraint {
-        val errorMessage = if (annotation.message.isNotEmpty()) annotation.message else null
-        return LengthConstraint(min = annotation.min, max = annotation.max, errorMessage = errorMessage)
+        return LengthConstraint(min = annotation.min, max = annotation.max, errorMessage = annotation.message)
     }
 }
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/string/length/MaxLengthProcessor.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/string/length/MaxLengthProcessor.kt
@@ -11,7 +11,6 @@ object MaxLengthProcessor : LengthConstraintProcessor<MaxLength>() {
     }
 
     override fun getConstraint(annotation: MaxLength): LengthConstraint {
-        val errorMessage = if (annotation.message.isNotEmpty()) annotation.message else null
-        return LengthConstraint(max = annotation.value, errorMessage = errorMessage)
+        return LengthConstraint(max = annotation.value, errorMessage = annotation.message)
     }
 }
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/string/length/MinLengthProcessor.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/string/length/MinLengthProcessor.kt
@@ -11,7 +11,6 @@ object MinLengthProcessor : LengthConstraintProcessor<MinLength>() {
     }
 
     override fun getConstraint(annotation: MinLength): LengthConstraint {
-        val errorMessage = if (annotation.message.isNotEmpty()) annotation.message else null
-        return LengthConstraint(min = annotation.value, errorMessage = errorMessage)
+        return LengthConstraint(min = annotation.value, errorMessage = annotation.message)
     }
 }
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/string/pattern/RegularExpressionConstraintProcessor.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/string/pattern/RegularExpressionConstraintProcessor.kt
@@ -1,12 +1,13 @@
 package com.papsign.ktor.openapigen.annotations.type.string.pattern
 
+import com.papsign.ktor.openapigen.annotations.type.common.ConstraintViolation
+import com.papsign.ktor.openapigen.annotations.type.string.NotAStringViolation
 import com.papsign.ktor.openapigen.classLogger
 import com.papsign.ktor.openapigen.getKType
 import com.papsign.ktor.openapigen.model.schema.SchemaModel
 import com.papsign.ktor.openapigen.schema.processor.SchemaProcessor
 import com.papsign.ktor.openapigen.validation.Validator
 import com.papsign.ktor.openapigen.validation.ValidatorBuilder
-import java.lang.Exception
 import kotlin.reflect.KType
 import kotlin.reflect.full.withNullability
 
@@ -51,11 +52,7 @@ abstract class RegularExpressionConstraintProcessor<A: Annotation>(): SchemaProc
     }
 }
 
-data class RegularExpressionConstraint(val pattern: String, val errorMessage: String? = null)
+data class RegularExpressionConstraint(val pattern: String, val errorMessage: String)
 
-open class ConstraintViolation(message: String, cause: Throwable? = null): Exception(message, cause)
-
-class RegularExpressionConstraintViolation(val actual: String?, val constraint: RegularExpressionConstraint): ConstraintViolation(constraint.errorMessage ?: "Constraint violation: the string " +
-"\'$actual\' does not match the regular expression ${constraint.pattern}")
-
-class NotAStringViolation(val value: Any?): ConstraintViolation("Constraint violation: $value is not a string")
+class RegularExpressionConstraintViolation(val actual: String?, val constraint: RegularExpressionConstraint): ConstraintViolation("Constraint violation: the string " +
+"'$actual' does not match the regular expression ${constraint.pattern}", constraint.errorMessage)
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/string/pattern/RegularExpressionProcessor.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/string/pattern/RegularExpressionProcessor.kt
@@ -11,7 +11,6 @@ object RegularExpressionProcessor : RegularExpressionConstraintProcessor<Regular
     }
 
     override fun getConstraint(annotation: RegularExpression): RegularExpressionConstraint {
-        val errorMessage = if (annotation.message.isNotEmpty()) annotation.message else null
-        return RegularExpressionConstraint(annotation.pattern, errorMessage)
+        return RegularExpressionConstraint(annotation.pattern, annotation.message)
     }
 }
diff --git a/src/test/kotlin/TestServer.kt b/src/test/kotlin/TestServer.kt
@@ -18,6 +18,15 @@ import com.papsign.ktor.openapigen.annotations.parameters.PathParam
 import com.papsign.ktor.openapigen.annotations.properties.description.Description
 import com.papsign.ktor.openapigen.annotations.type.`object`.example.ExampleProvider
 import com.papsign.ktor.openapigen.annotations.type.`object`.example.WithExample
+import com.papsign.ktor.openapigen.annotations.type.common.ConstraintViolation
+import com.papsign.ktor.openapigen.annotations.type.number.integer.clamp.Clamp
+import com.papsign.ktor.openapigen.annotations.type.number.integer.max.Max
+import com.papsign.ktor.openapigen.annotations.type.number.integer.min.Min
+import com.papsign.ktor.openapigen.annotations.type.string.example.StringExample
+import com.papsign.ktor.openapigen.annotations.type.string.length.Length
+import com.papsign.ktor.openapigen.annotations.type.string.length.MaxLength
+import com.papsign.ktor.openapigen.annotations.type.string.length.MinLength
+import com.papsign.ktor.openapigen.annotations.type.string.pattern.RegularExpression
 import com.papsign.ktor.openapigen.interop.withAPI
 import com.papsign.ktor.openapigen.model.Described
 import com.papsign.ktor.openapigen.model.server.ServerModel
@@ -28,16 +37,6 @@ import com.papsign.ktor.openapigen.route.path.normal.post
 import com.papsign.ktor.openapigen.route.response.respond
 import com.papsign.ktor.openapigen.schema.namer.DefaultSchemaNamer
 import com.papsign.ktor.openapigen.schema.namer.SchemaNamer
-import com.papsign.ktor.openapigen.annotations.type.number.ConstraintVialoation
-import com.papsign.ktor.openapigen.annotations.type.number.integer.clamp.Clamp
-import com.papsign.ktor.openapigen.annotations.type.number.integer.max.Max
-import com.papsign.ktor.openapigen.annotations.type.number.integer.min.Min
-import com.papsign.ktor.openapigen.annotations.type.string.example.StringExample
-import com.papsign.ktor.openapigen.annotations.type.string.length.ConstraintViolation
-import com.papsign.ktor.openapigen.annotations.type.string.length.Length
-import com.papsign.ktor.openapigen.annotations.type.string.length.MaxLength
-import com.papsign.ktor.openapigen.annotations.type.string.length.MinLength
-import com.papsign.ktor.openapigen.annotations.type.string.pattern.RegularExpression
 import io.ktor.application.application
 import io.ktor.application.call
 import io.ktor.application.install
@@ -115,15 +114,9 @@ object TestServer {
                         it.printStackTrace()
                         Error("mapping.json", it.localizedMessage)
                     }
-                    exception<ConstraintVialoation, Error>(HttpStatusCode.BadRequest) {
-                        Error("violation.constraint", it.localizedMessage)
-                    }
                     exception<ConstraintViolation, Error>(HttpStatusCode.BadRequest) {
                         Error("violation.constraint", it.localizedMessage)
                     }
-                    exception<com.papsign.ktor.openapigen.annotations.type.string.pattern.ConstraintViolation, Error>(HttpStatusCode.BadRequest) {
-                        Error("violation.constraint", it.localizedMessage)
-                    }
                     exception<ProperException, Error>(HttpStatusCode.BadRequest) {
                         it.printStackTrace()
                         Error(it.id, it.localizedMessage)
@@ -210,6 +203,18 @@ object TestServer {
                     respond(StringResponse("All of the fields were valid"))
                 }
 
+                route("validate-number").post<Unit, StringResponse, NumberValidatorsExample>(
+                        info("This endpoint demonstrates the usage of number validators", "This endpoint demonstrates the usage of number validators"),
+                        exampleRequest = NumberValidatorsExample(
+                                1,
+                                56,
+                                15.02f,
+                                0.023f),
+                        exampleResponse = StringResponse("All of the fields were valid")
+                ) { params, body ->
+                    respond(StringResponse("All of the fields were valid"))
+                }
+
                 route("again") {
                     tag(TestServer.Tags.EXAMPLE) {
 
@@ -262,6 +267,14 @@ object TestServer {
             @RegularExpression("^[0-9a-fA-F]*$", "The field strHexaDec should only contain hexadecimal digits") val strHexaDec: String
     )
 
+    @Request("A Request with validated number fields")
+    data class NumberValidatorsExample(
+            @Min(0) val intWithMin: Int,
+            @Clamp( 1, 90 ) val intBetween: Int,
+            @Max(100 ) val floatMax: Float,
+            @Clamp(0, 1) val floatBetween: Float
+    )
+
     @Response("A String Response")
     @Request("A String Request")
     data class StringUsable(val str: String)

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,6 @@ object LengthProcessor : LengthConstraintProcessor<Length>() {`
`12`	`12`	`}`
`13`	`13`
`14`	`14`	`override fun getConstraint(annotation: Length): LengthConstraint {`
`15`		`- val errorMessage = if (annotation.message.isNotEmpty()) annotation.message else null`
`16`		`- return LengthConstraint(min = annotation.min, max = annotation.max, errorMessage = errorMessage)`
	`15`	`+ return LengthConstraint(min = annotation.min, max = annotation.max, errorMessage = annotation.message)`
`17`	`16`	`}`
`18`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,6 @@ object MaxLengthProcessor : LengthConstraintProcessor<MaxLength>() {`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`override fun getConstraint(annotation: MaxLength): LengthConstraint {`
`14`		`- val errorMessage = if (annotation.message.isNotEmpty()) annotation.message else null`
`15`		`- return LengthConstraint(max = annotation.value, errorMessage = errorMessage)`
	`14`	`+ return LengthConstraint(max = annotation.value, errorMessage = annotation.message)`
`16`	`15`	`}`
`17`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,6 @@ object MinLengthProcessor : LengthConstraintProcessor<MinLength>() {`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`override fun getConstraint(annotation: MinLength): LengthConstraint {`
`14`		`- val errorMessage = if (annotation.message.isNotEmpty()) annotation.message else null`
`15`		`- return LengthConstraint(min = annotation.value, errorMessage = errorMessage)`
	`14`	`+ return LengthConstraint(min = annotation.value, errorMessage = annotation.message)`
`16`	`15`	`}`
`17`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,6 @@ object RegularExpressionProcessor : RegularExpressionConstraintProcessor<Regular`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`override fun getConstraint(annotation: RegularExpression): RegularExpressionConstraint {`
`14`		`- val errorMessage = if (annotation.message.isNotEmpty()) annotation.message else null`
`15`		`- return RegularExpressionConstraint(annotation.pattern, errorMessage)`
	`14`	`+ return RegularExpressionConstraint(annotation.pattern, annotation.message)`
`16`	`15`	`}`
`17`	`16`	`}`