AYS-688 | AysUserFilter.lineNumber Field Validations Have Been Fixed (#477)

Author: agitrubard

src/main/java/org/ays/auth/model/AysUserFilter.java

@@ -10,6 +10,7 @@
 import org.ays.auth.model.enums.AysUserStatus;
 import org.ays.common.model.AysFilter;
 import org.ays.common.util.validation.Name;
+import org.ays.common.util.validation.OnlyPositiveNumber;
 import org.springframework.data.jpa.domain.Specification;
 import org.springframework.util.StringUtils;
 
@@ -65,6 +66,7 @@ public class AysUserFilter implements AysFilter {
     @Setter
     public static class PhoneNumber {
 
+        @OnlyPositiveNumber
         @Size(min = 1, max = 10)
         private String lineNumber;
 

src/main/java/org/ays/common/util/validation/OnlyPositiveNumber.java

@@ -0,0 +1,45 @@
+package org.ays.common.util.validation;
+
+import jakarta.validation.Constraint;
+import jakarta.validation.Payload;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Annotation to validate that a numeric field contains only positive values.
+ * <p>
+ * This constraint is validated using the {@link OnlyPositiveNumberValidator} class.
+ * It can be applied to fields of numeric types (e.g., {@link Integer}, {@link Long}) to enforce positivity.
+ * </p>
+ */
+@Target(ElementType.FIELD)
+@Retention(RetentionPolicy.RUNTIME)
+@Constraint(validatedBy = OnlyPositiveNumberValidator.class)
+public @interface OnlyPositiveNumber {
+
+
+    /**
+     * Returns the error message when the number is not positive.
+     *
+     * @return the validation error message
+     */
+    String message() default "must be positive number";
+
+    /**
+     * Returns the validation groups this constraint belongs to.
+     *
+     * @return the validation groups
+     */
+    Class<?>[] groups() default {};
+
+    /**
+     * Returns the custom payload objects associated with this constraint.
+     *
+     * @return the payload
+     */
+    Class<? extends Payload>[] payload() default {};
+
+}

src/main/java/org/ays/common/util/validation/OnlyPositiveNumberValidator.java

@@ -0,0 +1,34 @@
+package org.ays.common.util.validation;
+
+import jakarta.validation.ConstraintValidator;
+import jakarta.validation.ConstraintValidatorContext;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.commons.lang3.math.NumberUtils;
+
+/**
+ * A custom validator implementation for the {@link OnlyPositiveNumber} annotation.
+ * <p>
+ * Validates whether the given {@link String} represents a positive numeric value.
+ * The input is considered valid if it is non-blank, contains only digits, and represents a number greater than zero.
+ * </p>
+ */
+class OnlyPositiveNumberValidator implements ConstraintValidator<OnlyPositiveNumber, String> {
+
+    /**
+     * Validates whether the provided {@code String} value is a positive number.
+     *
+     * @param number  the string value to validate
+     * @param context the context in which the constraint is evaluated
+     * @return {@code true} if the value is blank or a positive number; {@code false} otherwise
+     */
+    @Override
+    public boolean isValid(String number, ConstraintValidatorContext context) {
+
+        if (StringUtils.isEmpty(number)) {
+            return true;
+        }
+
+        return NumberUtils.isDigits(number) && Long.parseLong(number) > 0;
+    }
+
+}

src/test/java/org/ays/auth/controller/AysUserControllerTest.java

@@ -185,7 +185,14 @@ void givenUserListRequest_whenLastNameDoesNotValid_thenReturnValidationError(Str
     @ValueSource(strings = {
             "",
             "12345678912",
-            "12345678912367"
+            "12345678912367",
+            "-321",
+            "321.",
+            "12.34",
+            "1 234",
+            "-45",
+            "12a34",
+            "    "
     })
     @ParameterizedTest
     void givenUserListRequest_whenLineNumberIsNotValid_thenReturnValidationError(String mockLineNumber) throws Exception {
@@ -210,7 +217,11 @@ void givenUserListRequest_whenLineNumberIsNotValid_thenReturnValidationError(Str
                 .andExpect(AysMockResultMatchersBuilders.status()
                         .isBadRequest())
                 .andExpect(AysMockResultMatchersBuilders.subErrors()
-                        .isNotEmpty());
+                        .isArray())
+                .andExpect(AysMockResultMatchersBuilders.subErrorsSize()
+                        .value(1))
+                .andExpect(AysMockResultMatchersBuilders.subErrors("[*].field")
+                        .value("lineNumber"));
 
         // Verify
         Mockito.verify(userReadService, Mockito.never())

src/test/java/org/ays/util/AysMockResultMatchersBuilders.java

@@ -72,6 +72,10 @@ public static JsonPathResultMatchers subErrors() {
         return MockMvcResultMatchers.jsonPath("$.subErrors");
     }
 
+    public static JsonPathResultMatchers subErrorsSize() {
+        return MockMvcResultMatchers.jsonPath("$.subErrors.size()");
+    }
+
     public static JsonPathResultMatchers subErrors(String path) {
         return MockMvcResultMatchers.jsonPath("$.subErrors".concat(path));
     }