Merge pull request #295 from Rajshri-Firke/feature/pet-birthdate-validation

fix : Missing business validation on pet birthDate (future or unrealistic dates allowed)

Author: vfedoriv

src/main/java/org/springframework/samples/petclinic/rest/controller/OwnerRestController.java

@@ -16,6 +16,9 @@
 
 package org.springframework.samples.petclinic.rest.controller;
 
+import java.util.Collection;
+import java.util.List;
+
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
@@ -26,7 +29,12 @@
 import org.springframework.samples.petclinic.model.Pet;
 import org.springframework.samples.petclinic.model.Visit;
 import org.springframework.samples.petclinic.rest.api.OwnersApi;
-import org.springframework.samples.petclinic.rest.dto.*;
+import org.springframework.samples.petclinic.rest.dto.OwnerDto;
+import org.springframework.samples.petclinic.rest.dto.OwnerFieldsDto;
+import org.springframework.samples.petclinic.rest.dto.PetDto;
+import org.springframework.samples.petclinic.rest.dto.PetFieldsDto;
+import org.springframework.samples.petclinic.rest.dto.VisitDto;
+import org.springframework.samples.petclinic.rest.dto.VisitFieldsDto;
 import org.springframework.samples.petclinic.service.ClinicService;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.web.bind.annotation.CrossOrigin;
@@ -36,9 +44,6 @@
 
 import jakarta.transaction.Transactional;
 
-import java.util.Collection;
-import java.util.List;
-
 /**
  * @author Vitaliy Fedoriv
  */

src/main/java/org/springframework/samples/petclinic/rest/validation/PetAgeValidation.java

@@ -0,0 +1,18 @@
+package org.springframework.samples.petclinic.rest.validation;
+
+import jakarta.validation.Constraint;
+import jakarta.validation.Payload;
+import java.lang.annotation.*;
+
+@Target({ ElementType.FIELD })
+@Retention(RetentionPolicy.RUNTIME)
+@Constraint(validatedBy = PetAgeValidator.class)
+@Documented
+public @interface PetAgeValidation {
+
+    String message() default "Birth date must not be in the future or older than 50 years";
+
+    Class<?>[] groups() default {};
+
+    Class<? extends Payload>[] payload() default {};
+}

src/main/java/org/springframework/samples/petclinic/rest/validation/PetAgeValidator.java

@@ -0,0 +1,37 @@
+package org.springframework.samples.petclinic.rest.validation;
+
+import java.time.LocalDate;
+
+import jakarta.validation.ConstraintValidator;
+import jakarta.validation.ConstraintValidatorContext;
+
+public class PetAgeValidator implements ConstraintValidator<PetAgeValidation, LocalDate> {
+
+    @Override
+    public boolean isValid(LocalDate birthDate, ConstraintValidatorContext context) {
+
+        if (birthDate == null) {
+            return true; 
+        }
+
+        LocalDate today = LocalDate.now();
+
+        if (birthDate.isAfter(today)) {
+            context.disableDefaultConstraintViolation();
+            context.buildConstraintViolationWithTemplate(
+                "Birth date cannot be in the future"
+            ).addConstraintViolation();
+            return false;
+        }
+
+        if (birthDate.isBefore(today.minusYears(50))) {
+            context.disableDefaultConstraintViolation();
+            context.buildConstraintViolationWithTemplate(
+                "Birth date cannot be older than 50 years"
+            ).addConstraintViolation();
+            return false;
+        }
+
+        return true;
+    }
+}

src/main/resources/openapi.yml

@@ -1953,6 +1953,7 @@ components:
           type: string
           format: date
           example: '2010-09-07'
+          x-field-extra-annotation: "@org.springframework.samples.petclinic.rest.validation.PetAgeValidation"
         type:
           $ref: '#/components/schemas/PetType'
       required:

src/test/java/org/springframework/validation/PetAgeValidatorTest.java

@@ -0,0 +1,58 @@
+package org.springframework.validation;
+
+import jakarta.validation.ConstraintValidatorContext;
+import org.junit.jupiter.api.Test;
+import org.mockito.Mockito;
+import org.springframework.samples.petclinic.rest.validation.PetAgeValidator;
+
+import java.time.LocalDate;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.Mockito.*;
+
+class PetAgeValidatorTest {
+
+    private final PetAgeValidator validator = new PetAgeValidator();
+
+    @Test
+    void shouldReturnFalseWhenBirthDateIsInFuture() {
+        LocalDate futureDate = LocalDate.now().plusDays(1);
+
+        ConstraintValidatorContext context = mock(ConstraintValidatorContext.class);
+        when(context.buildConstraintViolationWithTemplate(anyString()))
+                .thenReturn(mock(ConstraintValidatorContext.ConstraintViolationBuilder.class));
+
+        boolean result = validator.isValid(futureDate, context);
+
+        assertFalse(result);
+    }
+
+    @Test
+    void shouldReturnFalseWhenBirthDateIsOlderThan50Years() {
+        LocalDate tooOldDate = LocalDate.now().minusYears(51);
+
+        ConstraintValidatorContext context = mock(ConstraintValidatorContext.class);
+        when(context.buildConstraintViolationWithTemplate(anyString()))
+                .thenReturn(mock(ConstraintValidatorContext.ConstraintViolationBuilder.class));
+
+        boolean result = validator.isValid(tooOldDate, context);
+
+        assertFalse(result);
+    }
+
+    @Test
+    void shouldReturnTrueWhenBirthDateIsValid() {
+        LocalDate validDate = LocalDate.now().minusYears(10);
+
+        boolean result = validator.isValid(validDate, null);
+
+        assertTrue(result);
+    }
+
+    @Test
+    void shouldReturnTrueWhenBirthDateIsNull() {
+        boolean result = validator.isValid(null, null);
+
+        assertTrue(result);
+    }
+}