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

Enabling spring validation error messaging

Author: foman-ch

pom.xml

@@ -98,11 +98,6 @@
             <version>6.0.0</version>
             <scope>provided</scope>
         </dependency>
-        <dependency>
-            <groupId>jakarta.validation</groupId>
-            <artifactId>jakarta.validation-api</artifactId>
-            <version>3.0.2</version>
-        </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-validation</artifactId>
@@ -128,6 +123,12 @@
             <groupId>uk.gov.companieshouse</groupId>
             <artifactId>api-sdk-java</artifactId>
             <version>${api-sdk-java.version}</version>
+            <exclusions>
+                <exclusion>
+                    <groupId>javax.validation</groupId>
+                    <artifactId>validation-api</artifactId>
+                </exclusion>
+            </exclusions>
         </dependency>
         <dependency>
             <groupId>uk.gov.companieshouse</groupId>
@@ -192,10 +193,6 @@
             <artifactId>kafka-models</artifactId>
             <version>${kafka-models.version}</version>
         </dependency>
-        <dependency>
-            <groupId>org.hibernate.validator</groupId>
-            <artifactId>hibernate-validator</artifactId>
-        </dependency>
         <dependency>
             <groupId>org.springframework.kafka</groupId>
             <artifactId>spring-kafka-test</artifactId>

src/main/java/uk/gov/companieshouse/orders/api/controller/BasketController.java

@@ -25,6 +25,7 @@
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.lang.NonNull;
+import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PatchMapping;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -68,6 +69,7 @@
 import uk.gov.companieshouse.sdk.manager.ApiSdkManager;
 
 @RestController
+@Validated
 public class BasketController {
     private static final Logger LOGGER = LoggerFactory.getLogger(APPLICATION_NAME_SPACE);
 

src/main/java/uk/gov/companieshouse/orders/api/controller/ConstraintViolationHelper.java

@@ -8,7 +8,7 @@
 import uk.gov.companieshouse.orders.api.util.FieldNameConverter;
 
 @Component
-class ConstraintViolationHelper {
+public class ConstraintViolationHelper {
     private final FieldNameConverter converter;
 
     public ConstraintViolationHelper(FieldNameConverter converter) {

src/main/resources/application.properties

@@ -9,6 +9,11 @@ uk.gov.companieshouse.orders.api.search.checkouts=/checkouts/search
 uk.gov.companieshouse.payments.api.payments: ${PAYMENTS_API_URL}/payments
 spring.mvc.pathmatch.matching-strategy=ant-path-matcher
 
+server.error.include-message=always
+server.error.include-binding-errors=always
+server.error.include-stacktrace=on_param
+server.error.include-exception=false
+
 basket.item.limit=${BASKET_ITEM_LIMIT:1000}
 basket.enrolled=${BASKET_ENROLLED:false}
 

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

@@ -16,6 +16,7 @@
 import jakarta.validation.ConstraintViolationException;
 import jakarta.validation.Path;
 import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
@@ -60,7 +61,6 @@ public TestGlobalExceptionHandler(FieldNameConverter converter, ConstraintViolat
             super(converter, helper);
         }
 
-        @Override
         protected ResponseEntity<Object> handleExceptionInternal(final Exception ex,
                                                                  final Object body,
                                                                  final HttpHeaders headers,
@@ -94,7 +94,6 @@ protected ResponseEntity<Object> handleExceptionInternal(final Exception ex,
     @Mock
     private FieldNameConverter converter;
 
-    @Mock
     private HttpHeaders headers;
 
     @Mock
@@ -109,6 +108,11 @@ protected ResponseEntity<Object> handleExceptionInternal(final Exception ex,
     @Mock
     private Path path;
 
+    @BeforeEach
+    void setup() {
+        headers = new HttpHeaders();
+    }
+
     @Test
     void buildsApiErrorFromMethodArgumentNotValidException() {