String enum validation (#18)

* Added InStringListByEnum validator

* Added tests for InStringListByEnum

* Changed package version

* Updated version at README

* added mode to failedValidationRuleTest

Author: muerwre

README.md

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

web-utils/build.gradle.kts

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

web-utils/src/main/kotlin/com/icerockdev/validation/InStringListByEnum.kt

@@ -0,0 +1,58 @@
+/*
+ * Copyright 2020 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package com.icerockdev.validation
+
+import javax.validation.Constraint
+import javax.validation.ConstraintValidator
+import javax.validation.ConstraintValidatorContext
+import javax.validation.ReportAsSingleViolation
+import kotlin.reflect.KClass
+
+/**
+ * Validation annotation to validate field than contains in array.
+ *
+ * Example, validate field value contains in enum:
+ * @field:InStringListByEnum(IAvailableStringByEnum = Status::class, message = "Invalid value")
+ */
+interface IAvailableStringByEnum {
+    fun getAvailableStringList(listName: String): List<String>
+}
+
+@Target(AnnotationTarget.FIELD)
+@MustBeDocumented
+@Constraint(validatedBy = [InStringListByEnumValidator::class])
+@kotlin.annotation.Retention
+@ReportAsSingleViolation
+annotation class InStringListByEnum(
+    val message: String = "Not exists in string array",
+    val groups: Array<KClass<out Any>> = [],
+    val payload: Array<KClass<out Any>> = [],
+    val nullable: Boolean = true,
+    val listName: String = "all",
+    val IAvailableStringByEnum: KClass<out IAvailableStringByEnum>
+)
+
+class InStringListByEnumValidator : ConstraintValidator<InStringListByEnum, String> {
+
+    private var annotationValue: List<String> = emptyList()
+    private var annotationNullable: Boolean = true
+
+    override fun initialize(constraintAnnotation: InStringListByEnum) {
+        this.annotationNullable = constraintAnnotation.nullable
+        val clazz = constraintAnnotation.IAvailableStringByEnum.java
+        if (!clazz.isEnum) {
+            throw IllegalAccessException("Only enum class supported for validation")
+        }
+
+        annotationValue = clazz.enumConstants.first().getAvailableStringList(constraintAnnotation.listName)
+    }
+
+    override fun isValid(fieldValue: String?, constraintContext: ConstraintValidatorContext?): Boolean {
+        if (fieldValue == null) {
+            return this.annotationNullable
+        }
+        return fieldValue in this.annotationValue
+    }
+}

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

@@ -30,6 +30,7 @@ class ToolsTest {
         testObj.name = null
         testObj.age = 21
         testObj.status = 10
+        testObj.mode = "ACTIVE"
         testObj.email = "test@test"
         testObj.date = "Invalid date"
         testObj.passwordRepeat = "123457"
@@ -48,6 +49,7 @@ class ToolsTest {
         testObj.name = null
         testObj.age = 21
         testObj.status = 10
+        testObj.mode = "ANYTHING"
         testObj.email = "test@test"
         testObj.date = "Invalid date"
         testObj.passwordRepeat = "123457"
@@ -60,6 +62,7 @@ class ToolsTest {
         val expectedErrors = arrayOf(
             ErrorDetail(message = "Should it be 10 or 20", code = 0),
             ErrorDetail(message = "Should it be 30 or 40", code = 0),
+            ErrorDetail(message = "Should be ACTIVE or PASSIVE", code = 0),
             ErrorDetail(message = "Date must be in YYYY-MM-DD format", code = 0),
             ErrorDetail(message = "Name is required", code = 0),
             ErrorDetail(message = "email определен в неверном формате", code = 0),
@@ -76,7 +79,7 @@ class ToolsTest {
             println(e.message)
         }
 
-        assertEquals(8, errorsResponse.data.size)
+        assertEquals(9, errorsResponse.data.size)
         assertEquals(422, errorsResponse.status)
         assertEquals("Validation Error", errorsResponse.message)
         assertEquals(false, errorsResponse.success)

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

@@ -19,6 +19,18 @@ enum class Status(val value: Int) : IAvailableIntByEnum {
     }
 }
 
+enum class Mode : IAvailableStringByEnum {
+    ACTIVE,
+    PASSIVE;
+
+    override fun getAvailableStringList(listName: String): List<String> {
+        return when (listName) {
+            "all" -> arrayListOf(ACTIVE.name, PASSIVE.name)
+            else -> emptyList()
+        }
+    }
+}
+
 @FieldMatch(message = "The password fields must match", first = "password", second = "passwordRepeat")
 class TestRequest(
     @field:NotNull(message = "Name is required")
@@ -33,6 +45,8 @@ class TestRequest(
     var age: Int = 10,
     @field:InIntListByEnum(IAvailableIntByEnum = Status::class, message = "Should it be 30 or 40")
     var status: Int = 30,
+    @field:InStringListByEnum(IAvailableStringByEnum = Mode::class, message = "Should be ACTIVE or PASSIVE")
+    var mode: String = "ACTIVE",
     @field:StrictEmail(message = "Invalid email")
     var email: String = "test@test.er",
     @field:DateFormat(message = "Date must be in YYYY-MM-DD format", pattern = "YYYY-MM-DD")