OZG-4717 OZG-4799 Add other exception types

pom.xml

@@ -34,6 +34,14 @@
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-web</artifactId>
 		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-security</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-validation</artifactId>
+		</dependency>
 
 		<!-- Dev -->
 		<dependency>

src/main/java/de/ozgcloud/admin/web/error/ExceptionTranslator.java → src/main/java/de/ozgcloud/admin/errorhandling/ExceptionTranslator.java

@@ -19,11 +19,14 @@
  * Die sprachspezifischen Genehmigungen und Beschränkungen
  * unter der Lizenz sind dem Lizenztext zu entnehmen.
  */
-package de.ozgcloud.admin.web.error;
+package de.ozgcloud.admin.errorhandling;
 
-import java.nio.file.AccessDeniedException;
 import java.util.Map;
 
+import jakarta.validation.ConstraintViolationException;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.security.access.AccessDeniedException;
 import org.springframework.web.ErrorResponse;
 import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.bind.annotation.RestControllerAdvice;
@@ -34,13 +37,26 @@ import de.ozgcloud.common.errorhandling.TechnicalException;
 @RestControllerAdvice
 public class ExceptionTranslator extends ResponseEntityExceptionHandler {
 
-	@ExceptionHandler({ RuntimeException.class, AccessDeniedException.class, TechnicalException.class })
-	public ErrorResponse handleAccessDeniedException(Exception ex) {
-		var errorType = Map.of(
-				AccessDeniedException.class, ErrorType.AUTHORIZATION,
-				TechnicalException.class, ErrorType.TECHNICAL
-		).getOrDefault(ex.getClass(), ErrorType.UNKNOWN);
+	static final Map<Class<? extends Exception>, HttpStatus> EXCEPTION_STATUS = Map.of(
+			RuntimeException.class, HttpStatus.INTERNAL_SERVER_ERROR,
+			AccessDeniedException.class, HttpStatus.FORBIDDEN,
+			ConstraintViolationException.class, HttpStatus.UNPROCESSABLE_ENTITY,
+			ResourceNotFoundException.class, HttpStatus.NOT_FOUND,
+			FunctionalException.class, HttpStatus.BAD_REQUEST,
+			TechnicalException.class, HttpStatus.INTERNAL_SERVER_ERROR
+	);
+
+	@ExceptionHandler({
+			RuntimeException.class,
+			AccessDeniedException.class,
+			ConstraintViolationException.class,
+			ResourceNotFoundException.class,
+			FunctionalException.class,
+			TechnicalException.class
+	})
+	public ErrorResponse handleRuntimeExceptionGeneric(RuntimeException ex) {
+		var errorStatus = EXCEPTION_STATUS.getOrDefault(ex.getClass(), HttpStatus.INTERNAL_SERVER_ERROR);
 
-		return ErrorResponse.builder(ex, errorType.getStatus(), ex.getLocalizedMessage()).build();
+		return ErrorResponse.builder(ex, errorStatus, ex.getLocalizedMessage()).build();
 	}
 }

src/main/java/de/ozgcloud/admin/service/BasicAppInfoService.java → src/main/java/de/ozgcloud/admin/errorhandling/FunctionalException.java

@@ -19,38 +19,41 @@
  * Die sprachspezifischen Genehmigungen und Beschränkungen
  * unter der Lizenz sind dem Lizenztext zu entnehmen.
  */
-package de.ozgcloud.admin.service;
+package de.ozgcloud.admin.errorhandling;
 
-import java.time.Instant;
-import java.util.Optional;
+import java.io.Serial;
+import java.util.UUID;
 
-import org.springframework.boot.info.BuildProperties;
-import org.springframework.stereotype.Service;
+import de.ozgcloud.common.errorhandling.ExceptionUtil;
+import de.ozgcloud.common.errorhandling.FunctionalErrorCode;
+import de.ozgcloud.common.errorhandling.IdentifiableException;
 
-import lombok.AllArgsConstructor;
+public class FunctionalException extends RuntimeException implements IdentifiableException {
 
-@Service
-@AllArgsConstructor
-public class BasicAppInfoService {
-	private Optional<BuildProperties> buildProperties;
+	@Serial
+	private static final long serialVersionUID = 1L;
 
-	public String getVersion() {
-		return buildProperties.map(BuildProperties::getVersion).orElse("--");
-	}
+	private final FunctionalErrorCode errorCode;
+	private final String exceptionId;
+
+	public FunctionalException(FunctionalErrorCode errorCode) {
+		super("Functional error: " + errorCode.getErrorCode());
 
-	public Instant getBuildTime() {
-		return buildProperties.map(BuildProperties::getTime).orElse(Instant.now());
+		this.errorCode = errorCode;
+		this.exceptionId = UUID.randomUUID().toString();
 	}
 
-	public String getJavaVersion() {
-		return System.getProperty("java.version", "?");
+	public String getErrorCode() {
+		return errorCode.getErrorCode();
 	}
 
-	public String getBuildNumber() {
-		return buildProperties.map(p -> p.get("number")).orElse("?");
+	@Override
+	public String getMessage() {
+		return ExceptionUtil.formatMessageWithExceptionId(super.getMessage(), exceptionId);
 	}
 
-	public String getBuildUrl() {
-		return buildProperties.map(p -> p.get("url")).orElse("?");
+	@Override
+	public String getExceptionId() {
+		return exceptionId;
 	}
 }

src/main/java/de/ozgcloud/admin/web/error/ErrorType.java → src/main/java/de/ozgcloud/admin/errorhandling/ResourceNotFoundException.java

@@ -19,21 +19,26 @@
  * Die sprachspezifischen Genehmigungen und Beschränkungen
  * unter der Lizenz sind dem Lizenztext zu entnehmen.
  */
-package de.ozgcloud.admin.web.error;
+package de.ozgcloud.admin.errorhandling;
 
-import org.springframework.http.HttpStatus;
+import java.io.Serial;
 
-import lombok.AllArgsConstructor;
+import de.ozgcloud.common.errorhandling.FunctionalErrorCode;
 import lombok.Getter;
 
-@AllArgsConstructor
 @Getter
-public enum ErrorType {
-	UNKNOWN(HttpStatus.INTERNAL_SERVER_ERROR),
-	AUTHORIZATION(HttpStatus.UNAUTHORIZED),
-	FUNCTIONAL(HttpStatus.BAD_REQUEST),
-	TECHNICAL(HttpStatus.INTERNAL_SERVER_ERROR),
-	;
+public class ResourceNotFoundException extends FunctionalException {
 
-	private final HttpStatus status;
+	@Serial
+	private static final long serialVersionUID = 1L;
+
+	private static final String MESSAGE_TEMPLATE = "Resource '%s' with id '%s' not found.";
+
+	public ResourceNotFoundException(Class<?> resource, Object id) {
+		super(buildErrorCode(resource, id));
+	}
+
+	private static FunctionalErrorCode buildErrorCode(Class<?> resource, Object id) {
+		return () -> String.format(MESSAGE_TEMPLATE, resource.getSimpleName(), id.toString());
+	}
 }

src/main/java/de/ozgcloud/admin/web/dto/BasicAppInfo.java

-/*
- * Copyright (c) 2024. Das Land Schleswig-Holstein vertreten durch das Ministerium für Energiewende, Klimaschutz, Umwelt und Natur
- * Zentrales IT-Management
- *
- * Lizenziert unter der EUPL, Version 1.2 oder - sobald
- * diese von der Europäischen Kommission genehmigt wurden -
- * Folgeversionen der EUPL ("Lizenz");
- * Sie dürfen dieses Werk ausschließlich gemäß
- * dieser Lizenz nutzen.
- * Eine Kopie der Lizenz finden Sie hier:
- *
- * https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12
- *
- * Sofern nicht durch anwendbare Rechtsvorschriften
- * gefordert oder in schriftlicher Form vereinbart, wird
- * die unter der Lizenz verbreitete Software "so wie sie
- * ist", OHNE JEGLICHE GEWÄHRLEISTUNG ODER BEDINGUNGEN -
- * ausdrücklich oder stillschweigend - verbreitet.
- * Die sprachspezifischen Genehmigungen und Beschränkungen
- * unter der Lizenz sind dem Lizenztext zu entnehmen.
- */
-package de.ozgcloud.admin.web.dto;
-
-import java.time.Instant;
-
-import lombok.Builder;
-import lombok.Getter;
-
-@Builder
-@Getter
-public class BasicAppInfo {
-	private String javaVersion;
-	private String buildVersion;
-	private Instant buildTime;
-	private String buildNumber;
-	private String buildUrl;
-}

src/test/java/de/ozgcloud/admin/web/error/ExceptionTranslatorITCase.java → src/test/java/de/ozgcloud/admin/errorhandling/ExceptionTranslatorITCase.java

@@ -19,82 +19,61 @@
  * Die sprachspezifischen Genehmigungen und Beschränkungen
  * unter der Lizenz sind dem Lizenztext zu entnehmen.
  */
-package de.ozgcloud.admin.web.error;
+package de.ozgcloud.admin.errorhandling;
 
-import static org.mockito.Mockito.*;
+import static de.ozgcloud.admin.errorhandling.ExceptionTranslator.*;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
 
-import java.nio.file.AccessDeniedException;
+import java.util.stream.Stream;
 
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Nested;
-import org.junit.jupiter.api.Test;
-import org.mockito.InjectMocks;
-import org.mockito.Mock;
-import org.mockito.Spy;
-import org.springframework.boot.test.context.SpringBootTest;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+import org.mockito.junit.jupiter.MockitoExtension;
+import org.springframework.http.HttpStatus;
 import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.ResultActions;
 import org.springframework.test.web.servlet.setup.MockMvcBuilders;
 
-import de.ozgcloud.admin.service.BasicAppInfoService;
-import de.ozgcloud.admin.web.controller.BasicAppInfoController;
-import de.ozgcloud.common.errorhandling.TechnicalException;
+import lombok.SneakyThrows;
 
-@SpringBootTest
+@ExtendWith(MockitoExtension.class)
 class ExceptionTranslatorITCase {
 
-	@Spy
-	@InjectMocks
-	private BasicAppInfoController basicAppInfoController;
-
-	@Mock
-	private BasicAppInfoService basicAppInfoService;
-
 	private MockMvc mockMvc;
 
 	@BeforeEach
-	void mock() {
+	void setup() {
 		mockMvc = MockMvcBuilders
-				.standaloneSetup(basicAppInfoController)
-				.setControllerAdvice(new ExceptionTranslator())
-				.build();
+				.standaloneSetup(new TestErrorController())
+				.setControllerAdvice(new ExceptionTranslator()).build();
 	}
 
 	@DisplayName("Error handler")
 	@Nested
 	class TestErrorHandler {
 
-		private void throwWhenApiCalled(Exception ex) {
-			when(basicAppInfoService.getJavaVersion())
-					.thenAnswer(invocation -> {
-						throw ex;
-					});
-		}
-
-		@Test
-		void shouldHandleAccessDenied() throws Exception {
-			throwWhenApiCalled(new AccessDeniedException("test no access"));
-
-			mockMvc.perform(get("/api"))
-					.andExpect(status().is(ErrorType.AUTHORIZATION.getStatus().value()));
+		private static Stream<Arguments> exceptionAndExpectedStatus() {
+			return EXCEPTION_STATUS.entrySet().stream().map(kv -> Arguments.of(kv.getKey(), kv.getValue()));
 		}
 
-		@Test
-		void shouldHandleTechnicalError() throws Exception {
-			throwWhenApiCalled(new TechnicalException("test technical error"));
+		@ParameterizedTest
+		@MethodSource("exceptionAndExpectedStatus")
+		@SneakyThrows
+		void shouldHandleExceptionWithStatus(Class<? extends Exception> exceptionClass, HttpStatus expectedStatus) {
+			var result = doPerformWithError(exceptionClass);
 
-			mockMvc.perform(get("/api"))
-					.andExpect(status().is(ErrorType.TECHNICAL.getStatus().value()));
+			result.andExpect(status().is(expectedStatus.value()));
 		}
 
-		@Test
-		void shouldRuntimeError() throws Exception {
-			throwWhenApiCalled(new RuntimeException("test unknown error"));
-
-			mockMvc.perform(get("/api"))
-					.andExpect(status().is(ErrorType.UNKNOWN.getStatus().value()));
+		@SneakyThrows
+		private ResultActions doPerformWithError(Class<? extends Exception> exceptionClass) {
+			return mockMvc.perform(get("/test-error").param("errorClassName", exceptionClass.getName()));
 		}
 	}
 }

src/main/java/de/ozgcloud/admin/web/controller/BasicAppInfoController.java → src/test/java/de/ozgcloud/admin/errorhandling/TestErrorController.java

@@ -19,37 +19,51 @@
  * Die sprachspezifischen Genehmigungen und Beschränkungen
  * unter der Lizenz sind dem Lizenztext zu entnehmen.
  */
-package de.ozgcloud.admin.web.controller;
+package de.ozgcloud.admin.errorhandling;
 
+import static org.junit.Assert.*;
+
+import java.util.Collections;
+import java.util.Map;
+import java.util.Objects;
+
+import jakarta.validation.ConstraintViolationException;
+
+import org.springframework.data.repository.query.Param;
+import org.springframework.security.access.AccessDeniedException;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
-import de.ozgcloud.admin.service.BasicAppInfoService;
-import de.ozgcloud.admin.web.dto.BasicAppInfo;
-import lombok.AllArgsConstructor;
+import de.ozgcloud.common.errorhandling.TechnicalException;
 
 @RestController
-@AllArgsConstructor
-@RequestMapping(BasicAppInfoController.PATH)
-public class BasicAppInfoController {
-	static final String PATH = "/api"; // NOSONAR
+@RequestMapping("/test-error")
+public class TestErrorController {
+
+	@FunctionalInterface
+	interface ExceptionProducer {
+		Exception produceException();
+	}
 
-	private BasicAppInfoService basicAppInfoService;
+	static Map<Class<? extends Exception>, ExceptionProducer> EXCEPTION_PRODUCER = Map.of(
+			RuntimeException.class, () -> new RuntimeException("x"),
+			AccessDeniedException.class, () -> new AccessDeniedException("x"),
+			ConstraintViolationException.class, () -> new ConstraintViolationException("x", Collections.emptySet()),
+			ResourceNotFoundException.class, () -> new ResourceNotFoundException(Object.class, "x"),
+			FunctionalException.class, () -> new FunctionalException(() -> "x"),
+			TechnicalException.class, () -> new TechnicalException("x")
+	);
 
 	@GetMapping
-	public BasicAppInfo getInfo() {
-		return buildInfo();
-	}
+	String throwException(@Param("error") String errorClassName) throws Exception {
+		Objects.requireNonNull(errorClassName);
 
-	private BasicAppInfo buildInfo() {
-		return BasicAppInfo.builder()
-				.javaVersion(basicAppInfoService.getJavaVersion())
-				.buildTime(basicAppInfoService.getBuildTime())
-				.buildVersion(basicAppInfoService.getVersion())
-				.buildNumber(basicAppInfoService.getBuildNumber())
-				.buildUrl(basicAppInfoService.getBuildUrl())
-				.build();
-	}
+		var clazz = Class.forName(errorClassName);
 
+		var exception = EXCEPTION_PRODUCER.get(clazz).produceException();
+		assertEquals(clazz, exception.getClass());
+		throw exception;
 	}
+}
+

src/test/java/de/ozgcloud/admin/web/AdministrationApplicationTests.java

-/*
- * Copyright (c) 2024. Das Land Schleswig-Holstein vertreten durch das Ministerium für Energiewende, Klimaschutz, Umwelt und Natur
- * Zentrales IT-Management
- *
- * Lizenziert unter der EUPL, Version 1.2 oder - sobald
- * diese von der Europäischen Kommission genehmigt wurden -
- * Folgeversionen der EUPL ("Lizenz");
- * Sie dürfen dieses Werk ausschließlich gemäß
- * dieser Lizenz nutzen.
- * Eine Kopie der Lizenz finden Sie hier:
- *
- * https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12
- *
- * Sofern nicht durch anwendbare Rechtsvorschriften
- * gefordert oder in schriftlicher Form vereinbart, wird
- * die unter der Lizenz verbreitete Software "so wie sie
- * ist", OHNE JEGLICHE GEWÄHRLEISTUNG ODER BEDINGUNGEN -
- * ausdrücklich oder stillschweigend - verbreitet.
- * Die sprachspezifischen Genehmigungen und Beschränkungen
- * unter der Lizenz sind dem Lizenztext zu entnehmen.
- */
-package de.ozgcloud.admin.web;
-
-import org.junit.jupiter.api.Test;
-import org.springframework.boot.test.context.SpringBootTest;
-
-@SpringBootTest
-class AdministrationApplicationTest {
-
-	@Test
-	void shouldSpringContextLoad() { // NOSONAR
-	}
-}