WIP

Author: Pfeil

src/main/java/edu/kit/datamanager/pit/Application.java

@@ -37,6 +37,7 @@
 import edu.kit.datamanager.pit.pitservice.impl.TypingService;
 import edu.kit.datamanager.pit.typeregistry.ITypeRegistry;
 import edu.kit.datamanager.pit.typeregistry.impl.TypeRegistry;
+import edu.kit.datamanager.pit.web.ExtendedErrorAttributes;
 import edu.kit.datamanager.pit.web.converter.SimplePidRecordConverter;
 import edu.kit.datamanager.security.filter.KeycloakJwtProperties;
 
@@ -100,6 +101,11 @@ public Logger logger(InjectionPoint injectionPoint) {
         return LoggerFactory.getLogger(targetClass.getCanonicalName());
     }
 
+    @Bean
+    public ExtendedErrorAttributes errorAttributes(ObjectMapper objectMapper) {
+        return new ExtendedErrorAttributes(objectMapper);
+    }
+
     @Bean
     public ITypeRegistry typeRegistry() {
         return new TypeRegistry();

src/main/java/edu/kit/datamanager/pit/common/RecordValidationException.java

@@ -5,18 +5,21 @@
 
 import edu.kit.datamanager.pit.domain.PIDRecord;
 
+import java.io.Serial;
+
 /**
  * Indicates that a PID was given which could not be resolved to answer the
  * request properly.
  */
 public class RecordValidationException extends ResponseStatusException {
 
 	private static final String VALIDATION_OF_RECORD = "Validation of record ";
-	private static final long serialVersionUID = 1L;
+	@Serial
+	private static final long serialVersionUID = -7287999233733933282L;
 	private static final HttpStatus HTTP_STATUS = HttpStatus.BAD_REQUEST;
 
-	// For cases in which the PID record shold be appended to the error response.
-	private final transient PIDRecord pidRecord;
+	// For cases in which the PID record should be appended to the error response.
+	private final PIDRecord pidRecord;
 
 	public RecordValidationException(PIDRecord pidRecord) {
 		super(HTTP_STATUS, VALIDATION_OF_RECORD + pidRecord.getPid() + " failed.");

src/main/java/edu/kit/datamanager/pit/web/ExtendedErrorAttributes.java

@@ -2,30 +2,29 @@
 
 import java.util.Map;
 
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.web.error.ErrorAttributeOptions;
 import org.springframework.boot.web.servlet.error.DefaultErrorAttributes;
-import org.springframework.stereotype.Component;
 import org.springframework.web.context.request.WebRequest;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 import edu.kit.datamanager.pit.common.RecordValidationException;
 
-@Component
 public class ExtendedErrorAttributes extends DefaultErrorAttributes {
 
-    @Autowired(required = true)
     ObjectMapper objectMapperBean;
 
+    public ExtendedErrorAttributes(ObjectMapper objectMapperBean) {
+        this.objectMapperBean = objectMapperBean;
+    }
+
     @Override
     public Map<String, Object> getErrorAttributes(WebRequest webRequest, ErrorAttributeOptions options) {
         final Map<String, Object> errorAttributes = 
             super.getErrorAttributes(webRequest, options);
 
         final Throwable error = super.getError(webRequest);
-        if (error instanceof RecordValidationException) {
-            final RecordValidationException validationError = (RecordValidationException) error;
+        if (error instanceof RecordValidationException validationError) {
             try {
                 errorAttributes.put("pid-record", objectMapperBean.writeValueAsString(validationError.getPidRecord()));
             } catch (Exception e) {

src/test/java/edu/kit/datamanager/pit/web/ExtendedErrorAttributesTest.java

@@ -0,0 +1,64 @@
+package edu.kit.datamanager.pit.web;
+
+import java.util.Map;
+
+import edu.kit.datamanager.pit.common.RecordValidationException;
+import edu.kit.datamanager.pit.domain.PIDRecord;
+import jakarta.servlet.http.HttpServletRequest;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.web.client.TestRestTemplate;
+import org.springframework.boot.web.error.ErrorAttributeOptions;
+import org.springframework.boot.web.servlet.error.ErrorAttributes;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.mock.web.MockHttpServletRequest;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.web.context.WebApplicationContext;
+import org.springframework.web.context.request.WebRequest;
+import org.springframework.web.context.request.ServletWebRequest;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
+@AutoConfigureMockMvc
+@ActiveProfiles("test")
+public class ExtendedErrorAttributesTest {
+
+    @Autowired
+    private TestRestTemplate restTemplate;
+
+    @Autowired
+    private WebApplicationContext webApplicationContext;
+
+    @Autowired
+    private ExtendedErrorAttributes errorAttributes;
+
+    @Test
+    public void testExtendedErrorAttributes() {
+        // Create a mock request to pass to the error attributes
+        HttpServletRequest request = new MockHttpServletRequest();
+        WebRequest webRequest = new ServletWebRequest(request);
+
+        // Simulate an exception to be handled by the error attributes
+        request.setAttribute("jakarta.servlet.error.exception", new RecordValidationException(
+                new PIDRecord().withPID("asdfg"),
+                "Validation failed"
+        ));
+
+        // Get the error attributes
+        Map<String, Object> attributes = errorAttributes.getErrorAttributes(webRequest, ErrorAttributeOptions.defaults());
+
+        // Check if the custom attribute is present
+        assertTrue(attributes.containsKey("pid-record"));
+    }
+
+    @Test
+    public void testExtendedErrorAttributesBeanRegistration() {
+        // Check if the ExtendedErrorAttributes bean is registered
+        ExtendedErrorAttributes extendedErrorAttributes = webApplicationContext.getBean(ExtendedErrorAttributes.class);
+        assertNotNull(extendedErrorAttributes, "ExtendedErrorAttributes bean should be registered");
+    }
+}