Feature/nav 140 utility endpoints health and service info

Dockerfile

@@ -4,7 +4,7 @@ COPY .mvn/ .mvn
 COPY mvnw pom.xml ./
 RUN ./mvnw dependency:go-offline -B
 COPY src ./src
-RUN ./mvnw clean package -DskipTests
+RUN ./mvnw clean package -DskipTests -Pdocker-build
 
 FROM openjdk:21-jdk-slim
 WORKDIR /app

pom.xml

@@ -60,10 +60,35 @@
         <java.version>21</java.version>
         <maven.compiler.source>21</maven.compiler.source>
         <maven.compiler.target>21</maven.compiler.target>
+        <git.commit.id.skip>false</git.commit.id.skip>
     </properties>
 
+    <profiles>
+        <profile>
+            <id>docker-build</id>
+            <properties>
+                <git.commit.id.skip>true</git.commit.id.skip>
+            </properties>
+        </profile>
+    </profiles>
+
     <build>
         <plugins>
+            <plugin>
+                <groupId>io.github.git-commit-id</groupId>
+                <artifactId>git-commit-id-maven-plugin</artifactId>
+                <version>9.0.1</version>
+                <configuration>
+                    <skip>${git.commit.id.skip}</skip>
+                </configuration>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>revision</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>
@@ -91,6 +116,18 @@
             <plugin>
                 <groupId>org.springframework.boot</groupId>
                 <artifactId>spring-boot-maven-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>build-info</goal>
+                        </goals>
+                        <configuration>
+                            <additionalProperties>
+                                <description>${project.description}</description>
+                            </additionalProperties>
+                        </configuration>
+                    </execution>
+                </executions>
             </plugin>
         </plugins>
     </build>
@@ -100,7 +137,7 @@
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter</artifactId>
-            <version>5.10.3</version>
+            <version>5.11.0</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -155,11 +192,26 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-web</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-actuator</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>
             <scope>test</scope>
         </dependency>
+        <!-- home -->
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-thymeleaf</artifactId>
+        </dependency>
+        <!-- openapi -->
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+            <version>2.6.0</version>
+        </dependency>
     </dependencies>
 
     <repositories>

src/main/java/ch/naviqore/app/config/OpenApiConfig.java

@@ -0,0 +1,29 @@
+package ch.naviqore.app.config;
+
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.info.BuildProperties;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class OpenApiConfig {
+
+    private final String name;
+    private final String version;
+    private final String description;
+
+    @Autowired
+    public OpenApiConfig(BuildProperties buildProperties) {
+        name = "Naviqore - " + buildProperties.getName() + " API";
+        version = buildProperties.getVersion();
+        description = buildProperties.get("description");
+    }
+
+    @Bean
+    public OpenAPI customOpenAPI() {
+        return new OpenAPI().info(new Info().title(name).version(version).description(description));
+    }
+
+}

src/main/java/ch/naviqore/app/controller/GlobalExceptionHandler.java

@@ -0,0 +1,50 @@
+package ch.naviqore.app.controller;
+
+import jakarta.servlet.http.HttpServletRequest;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.HttpStatusCode;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException;
+import org.springframework.web.server.ResponseStatusException;
+
+import java.time.LocalDateTime;
+import java.util.Arrays;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.Objects;
+
+@ControllerAdvice
+public class GlobalExceptionHandler {
+
+    private static ResponseEntity<Object> buildErrorResponse(HttpStatusCode statusCode, HttpServletRequest request,
+                                                             String message) {
+        Map<String, Object> body = new LinkedHashMap<>();
+        body.put("timestamp", LocalDateTime.now());
+        body.put("status", statusCode.value());
+        body.put("error", HttpStatus.valueOf(statusCode.value()).getReasonPhrase());
+        body.put("path", request.getRequestURI());
+        body.put("message", message);
+
+        return new ResponseEntity<>(body, statusCode);
+    }
+
+    @ExceptionHandler(ResponseStatusException.class)
+    public ResponseEntity<Object> handleResponseStatusException(ResponseStatusException ex,
+                                                                HttpServletRequest request) {
+        return buildErrorResponse(ex.getStatusCode(), request, ex.getReason());
+    }
+
+    @ExceptionHandler(MethodArgumentTypeMismatchException.class)
+    public ResponseEntity<Object> handleMethodArgumentTypeMismatch(MethodArgumentTypeMismatchException ex,
+                                                                   HttpServletRequest request) {
+        String message = String.format(
+                "The value '%s' is not valid for the parameter '%s'; it must be one of the following: %s.",
+                ex.getValue(), ex.getName(),
+                Arrays.toString(Objects.requireNonNull(ex.getRequiredType()).getEnumConstants()));
+
+        return buildErrorResponse(HttpStatus.BAD_REQUEST, request, message);
+    }
+
+}

src/main/java/ch/naviqore/app/controller/GlobalValidator.java

@@ -0,0 +1,54 @@
+package ch.naviqore.app.controller;
+
+import ch.naviqore.service.ScheduleInformationService;
+import ch.naviqore.service.Stop;
+import ch.naviqore.service.exception.StopNotFoundException;
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+import org.springframework.http.HttpStatus;
+import org.springframework.web.server.ResponseStatusException;
+
+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;
+import java.time.temporal.ChronoUnit;
+
+@NoArgsConstructor(access = AccessLevel.NONE)
+final class GlobalValidator {
+
+    public static LocalDateTime validateAndSetDefaultDateTime(LocalDateTime dateTime,
+                                                              ScheduleInformationService service) {
+        dateTime = (dateTime == null) ? LocalDateTime.now() : dateTime;
+
+        if (service.getValidity().isWithin(dateTime.toLocalDate())) {
+            return dateTime;
+        }
+
+        LocalDateTime startDate = service.getValidity().getStartDate().atStartOfDay();
+        LocalDateTime endDate = service.getValidity().getEndDate().atTime(23, 59, 59);
+
+        throw new ResponseStatusException(HttpStatus.BAD_REQUEST, String.format(
+                "The provided datetime '%s' is outside of the schedule validity period. Please provide a datetime between '%s' and '%s'.",
+                dateTime.truncatedTo(ChronoUnit.SECONDS).format(DateTimeFormatter.ISO_LOCAL_DATE_TIME),
+                startDate.format(DateTimeFormatter.ISO_LOCAL_DATE_TIME),
+                endDate.format(DateTimeFormatter.ISO_LOCAL_DATE_TIME)));
+    }
+
+    public static Stop validateAndGetStop(String stopId, ScheduleInformationService service, StopType stopType) {
+        try {
+            return service.getStopById(stopId);
+        } catch (StopNotFoundException e) {
+            throw new ResponseStatusException(HttpStatus.NOT_FOUND, createErrorMessage(stopId, stopType), e);
+        }
+    }
+
+    private static String createErrorMessage(String stopId, StopType stopType) {
+        String stopTypeDescription = (stopType == StopType.NOT_DEFINED) ? "" : stopType.name().toLowerCase() + " ";
+        return String.format("The requested %sstop with ID '%s' was not found.", stopTypeDescription, stopId);
+    }
+
+    enum StopType {
+        SOURCE,
+        TARGET,
+        NOT_DEFINED
+    }
+}

src/main/java/ch/naviqore/app/controller/HomeController.java

@@ -0,0 +1,30 @@
+package ch.naviqore.app.controller;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.info.BuildProperties;
+import org.springframework.stereotype.Controller;
+import org.springframework.ui.Model;
+import org.springframework.web.bind.annotation.GetMapping;
+
+@Controller
+public class HomeController {
+
+    private final String name;
+    private final String version;
+    private final String description;
+
+    @Autowired
+    public HomeController(BuildProperties buildProperties) {
+        name = buildProperties.getName();
+        version = buildProperties.getVersion();
+        description = buildProperties.get("description");
+    }
+
+    @GetMapping("/")
+    public String index(Model model) {
+        model.addAttribute("appName", name);
+        model.addAttribute("appVersion", version);
+        model.addAttribute("appDescription", description.substring(0, description.length() - 1));
+        return "index";
+    }
+}