Merge pull request #176 from companieshouse/feature/JU-89-java-21-migration-validation-errors

Enabling custom validation error messaging

Author: foman-ch

src/main/java/uk/gov/companieshouse/orders/api/dto/DeliveryDetailsDTO.java

@@ -3,29 +3,23 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.google.gson.Gson;
 
-import jakarta.validation.constraints.NotBlank;
-
 public class DeliveryDetailsDTO {
 
     @JsonProperty("company_name")
     private String companyName;
 
-    @NotBlank(message = "address_line_1 may not be blank")
     @JsonProperty("address_line_1")
     private String addressLine1;
 
     @JsonProperty("address_line_2")
     private String addressLine2;
 
-    @NotBlank(message = "country may not be blank")
     @JsonProperty("country")
     private String country;
 
-    @NotBlank(message = "forename may not be blank")
     @JsonProperty("forename")
     private String forename;
 
-    @NotBlank(message = "locality may not be blank")
     @JsonProperty("locality")
     private String locality;
 
@@ -38,7 +32,6 @@ public class DeliveryDetailsDTO {
     @JsonProperty("region")
     private String region;
 
-    @NotBlank(message = "surname may not be blank")
     @JsonProperty("surname")
     private String surname;
 

src/main/java/uk/gov/companieshouse/orders/api/validator/DeliveryDetailsValidator.java

@@ -11,16 +11,48 @@
 @Component
 public class DeliveryDetailsValidator {
 
+    private static final String ADDRESS_LINE_1_VALIDATION = "delivery_details.address_line_1 may not be blank";
+    private static final String COUNTRY_VALIDATION = "delivery_details.country may not be blank";
+    private static final String FORENAME_VALIDATION = "delivery_details.forename may not be blank";
+    private static final String SURNAME_VALIDATION = "delivery_details.surname may not be blank";
+    private static final String LOCALITY_VALIDATION = "delivery_details.locality may not be blank";
+    private static final String POSTAL_CODE_VALIDATION = "Postcode or Region is required";
+
     public DeliveryDetailsValidator() { }
 
     public List<String> getValidationErrors(final AddDeliveryDetailsRequestDTO addDeliveryDetailsRequestDTO) {
         List<String> errors = new ArrayList<>();
 
+        String addressLine1 = addDeliveryDetailsRequestDTO.getDeliveryDetails().getAddressLine1();
+        String country = addDeliveryDetailsRequestDTO.getDeliveryDetails().getCountry();
+        String forename = addDeliveryDetailsRequestDTO.getDeliveryDetails().getForename();
+        String surname = addDeliveryDetailsRequestDTO.getDeliveryDetails().getSurname();
+        String locality = addDeliveryDetailsRequestDTO.getDeliveryDetails().getLocality();
         String postalCode = addDeliveryDetailsRequestDTO.getDeliveryDetails().getPostalCode();
         String region = addDeliveryDetailsRequestDTO.getDeliveryDetails().getRegion();
 
         if(StringUtils.isBlank(postalCode) && StringUtils.isBlank(region)) {
-            errors.add("Postcode or Region is required");
+            errors.add(POSTAL_CODE_VALIDATION);
+        }
+
+        if (StringUtils.isBlank(addressLine1)) {
+            errors.add(ADDRESS_LINE_1_VALIDATION);
+        }
+
+        if (StringUtils.isBlank(country)) {
+            errors.add(COUNTRY_VALIDATION);
+        }
+
+        if (StringUtils.isBlank(forename)) {
+            errors.add(FORENAME_VALIDATION);
+        }
+
+        if (StringUtils.isBlank(surname)) {
+            errors.add(SURNAME_VALIDATION);
+        }
+
+        if (StringUtils.isBlank(locality)) {
+            errors.add(LOCALITY_VALIDATION);
         }
 
         return errors;

src/test/java/uk/gov/companieshouse/orders/api/controller/BasketControllerIntegrationTest.java

@@ -1522,6 +1522,7 @@ void addDeliveryDetailsFailsDueToFailedValidation() throws Exception {
         deliveryDetailsDTO.setSurname(SURNAME);
         deliveryDetailsDTO.setForename(FORENAME);
         deliveryDetailsDTO.setLocality(LOCALITY);
+        deliveryDetailsDTO.setPostalCode(POSTAL_CODE);
 
         addDeliveryDetailsRequestDTO.setDeliveryDetails(deliveryDetailsDTO);
 
@@ -1535,8 +1536,7 @@ void addDeliveryDetailsFailsDueToFailedValidation() throws Exception {
                 .andExpect(status().isBadRequest())
                 .andDo(MockMvcResultHandlers.print())
                 .andReturn();
-        Assertions.assertEquals("Invalid request content.", result.getResponse().getErrorMessage());
-        Assertions.assertTrue(result.getResolvedException().getMessage().contains("address_line_1 may not be blank"));
+        Assertions.assertTrue(result.getResponse().getContentAsString().contains("address_line_1 may not be blank"));
     }
 
     @Test