WD-318 Update validation logic (#17)

* WD-318 Add error list field, changes tests and make old methods as deprecated

* WD-318 Up the version

* WD-318 Fixes after review

* WD-318 Fixes

* WD-318 Update README

* WD-318 Remvoe isValidRecursive, change return type for validateRecursive method to bool

Co-authored-by: Ilya Shaydullin <shaydullin@icerockdev.com>

Author: ilya-shaydullin

README.md

@@ -12,7 +12,7 @@ repositories {
 }
 
 // Append dependency
-implementation("com.icerockdev:web-utils:0.5.0")
+implementation("com.icerockdev:web-utils:0.6.0")
 ````
 
 ## Library usage

sample/src/main/kotlin/com/icerockdev/sample/server.kt

@@ -29,6 +29,7 @@ import io.ktor.routing.get
 import io.ktor.routing.post
 import io.ktor.routing.routing
 import io.ktor.util.KtorExperimentalAPI
+import javax.validation.constraints.Email
 
 @KtorExperimentalAPI
 fun Application.main() {
@@ -88,8 +89,8 @@ fun Application.main() {
 
             post("/object") {
                 val request = call.receiveRequest<TestRequest>()
-                if (!request.isValid()) {
-                    throw ValidationException(request.validate())
+                if (!request.validate()) {
+                    throw ValidationException(request.getErrorList())
                 }
                 call.respond(TestResponse2(200, request.email, request.password))
             }
@@ -118,7 +119,7 @@ fun Application.main() {
     }
 }
 
-class TestRequest(val email: String, @JsonSecret val password: String) : Request()
+class TestRequest(@field:Email val email: String, @JsonSecret val password: String) : Request()
 class TestResponse2(status: Int, val email: String, @JsonSecret val password: String) :
     AbstractResponse(status, success = true) {
 }

web-utils/build.gradle.kts

@@ -13,7 +13,7 @@ apply(plugin = "java")
 apply(plugin = "kotlin")
 
 group = "com.icerockdev"
-version = "0.5.0"
+version = "0.6.0"
 
 val sourcesJar by tasks.registering(Jar::class) {
     classifier = "sources"

web-utils/src/main/kotlin/com/icerockdev/api/Request.kt

@@ -23,17 +23,21 @@ abstract class Request(
         .buildValidatorFactory()
 ) {
     private val validator: Validator? = validatorFactory.validator
+    private var errorList: Set<ConstraintViolation<Request>> = emptySet()
 
-    fun validate(): Set<ConstraintViolation<Request>> {
+    @JsonIgnore
+    fun validate(): Boolean {
         if (validator == null) {
             throw ValidatorException("Validator doesn't defined")
         }
-
-        return validator.validate(this)
+        errorList = validator.validate(this)
+        return errorList.isEmpty()
     }
 
-    fun validateRecursive(propertyPath: String = "*"): Set<ConstraintViolation<Request>> {
-        val constraintSet = validate().toMutableSet()
+    @JsonIgnore
+    fun validateRecursive(propertyPath: String = "*"): Boolean {
+        validate()
+        val constraintSet = getErrorList().toMutableSet()
 
         @Suppress("UNCHECKED_CAST")
         val self = this::class as KClass<Request>
@@ -44,29 +48,31 @@ abstract class Request(
             val propertyName = kProperty.name
             when (property) {
                 is Request -> {
-                    constraintSet.addAll(property.validateRecursive("$propertyPath -> $propertyName"))
+                    val isValid = property.validateRecursive("$propertyPath -> $propertyName")
+                    if (!isValid) {
+                        constraintSet.addAll(property.getErrorList())
+                    }
                 }
                 is List<*> -> {
                     property.forEach { listItem ->
                         if (listItem is Request) {
-                            constraintSet.addAll(listItem.validateRecursive("$propertyPath -> $propertyName"))
+                            val isValid = listItem.validateRecursive("$propertyPath -> $propertyName")
+                            if (!isValid) {
+                                constraintSet.addAll(listItem.getErrorList())
+                            }
                         }
                     }
                 }
             }
         }
 
-        return constraintSet
-    }
-
-    @JsonIgnore
-    fun isValid(): Boolean {
-        return validate().isEmpty()
+        errorList = constraintSet
+        return errorList.isEmpty()
     }
 
     @JsonIgnore
-    fun isValidRecursive(): Boolean {
-        return validateRecursive().isEmpty()
+    fun getErrorList(): Set<ConstraintViolation<Request>> {
+        return errorList
     }
 
     @JsonIgnore

web-utils/src/test/kotlin/com/icerockdev/api/ToolsTest.kt

@@ -18,13 +18,9 @@ class ToolsTest {
     @Test
     fun successValidationRulesTest() {
         val testObj = TestRequest()
-        val errors = testObj.validate()
-        val errorsRecursive = testObj.validateRecursive()
 
-        assertEquals(0, errors.size)
-        assertTrue(testObj.isValid())
-        assertEquals(0, errorsRecursive.size)
-        assertTrue(testObj.isValidRecursive())
+        assertTrue(testObj.validate())
+        assertEquals(0, testObj.getErrorList().size)
     }
 
     @Test
@@ -39,13 +35,10 @@ class ToolsTest {
         testObj.passwordRepeat = "123457"
         testObj.nested.list.add(NestedTestListItemRequest(10, "test10"))
 
-        val errors = testObj.validate()
-        val errorsRecursive = testObj.validateRecursive()
-
-        assertEquals(7, errors.size)
-        assertFalse(testObj.isValid())
-        assertEquals(8, errorsRecursive.size)
-        assertFalse(testObj.isValidRecursive())
+        assertFalse(testObj.validate())
+        assertEquals(7, testObj.getErrorList().size)
+        assertFalse(testObj.validateRecursive())
+        assertEquals(8, testObj.getErrorList().size)
     }
 
     @Test
@@ -60,7 +53,8 @@ class ToolsTest {
         testObj.passwordRepeat = "123457"
         testObj.nested.list.add(NestedTestListItemRequest(10, "test10"))
 
-        val errorsResponse = ErrorResponse(testObj.validateRecursive())
+        testObj.validateRecursive()
+        val errorsResponse = ErrorResponse(testObj.getErrorList())
         errorsResponse.timestamp = 1566554901677
 
         val expectedErrors = arrayOf(
@@ -95,7 +89,8 @@ class ToolsTest {
         val testObj = TestRequest()
         testObj.age = 12
 
-        val errorsResponse = ErrorResponse(testObj.validate())
+        testObj.validateRecursive()
+        val errorsResponse = ErrorResponse(testObj.getErrorList())
         errorsResponse.timestamp = 1566554901677
 
         val expectedErrors = arrayOf(