chore: update to Spring Boot 4 and create more e2e tests (#952)

Author: Portals

.github/workflows/workflow.yml

@@ -83,6 +83,12 @@ jobs:
       - name: Check code formatting
         run: cd e2e && pnpm run format:check
 
+      - name: Typecheck E2E
+        run: cd e2e && pnpm run typecheck
+
+      - name: Lint E2E
+        run: cd e2e && pnpm run lint
+
       - name: Install Playwright Browsers
         run: cd e2e && pnpm exec playwright install --with-deps chromium
 

app/build.gradle

@@ -1,7 +1,8 @@
 plugins {
     id "java"
     id "com.diffplug.spotless" version "8.0.0"
-    id 'org.springframework.boot' version '3.5.6'
+    id "io.spring.dependency-management" version "1.1.7"
+    id 'org.springframework.boot' version '4.0.0'
 }
 
 repositories {
@@ -14,9 +15,6 @@ java {
     }
 }
 
-apply plugin: "org.springframework.boot"
-apply plugin: "io.spring.dependency-management"
-
 group = "it.chalmers"
 
 dependencies {
@@ -33,29 +31,40 @@ dependencies {
             "org.postgresql:postgresql:42.7.3",
 
             // Spring Boot
-            "org.springframework.boot:spring-boot",
-            "org.springframework.boot:spring-boot-autoconfigure",
             "org.springframework.boot:spring-boot-starter-data-jpa",
+            "org.springframework.boot:spring-boot-starter-data-redis",
             "org.springframework.boot:spring-boot-starter-security",
             "org.springframework.boot:spring-boot-starter-validation",
             "org.springframework.boot:spring-boot-starter-web",
             "org.springframework.boot:spring-boot-starter-oauth2-authorization-server",
 
             // Spring session
-            "org.springframework.session:spring-session-core:3.5.2",
-            "org.springframework.session:spring-session-data-redis:3.5.2",
+            "org.springframework.session:spring-session-core",
+            "org.springframework.session:spring-session-data-redis",
 
             // Redis
-            "org.springframework.data:spring-data-redis:3.5.5",
+            "org.springframework.data:spring-data-redis",
+    )
+
+    compileOnly(
+            // Testcontainers for local dev service startup
+            "org.testcontainers:testcontainers:1.21.4",
+            "org.testcontainers:postgresql:1.21.4",
+    )
+
+    developmentOnly(
+            // Testcontainers for local dev service startup
+            "org.testcontainers:testcontainers:1.21.4",
+            "org.testcontainers:postgresql:1.21.4",
     )
 
    runtimeOnly(
             // FlywayDB (Database migration)
-            "org.flywaydb:flyway-core:9.21.0",
+            "org.springframework.boot:spring-boot-starter-flyway",
+            "org.flywaydb:flyway-database-postgresql",
 
             // Spring Boot
             "org.springframework.boot:spring-boot-devtools",
-            "org.springframework.boot:spring-boot-starter-data-redis",
             "org.springframework.boot:spring-boot-starter-thymeleaf",
 
             // Thymeleaf
@@ -69,6 +78,10 @@ dependencies {
     )
 }
 
+tasks.named("bootBuildImage") {
+    environment = ["BP_JVM_VERSION": "25.*"]
+}
+
 
 spotless {
     java {

app/src/main/java/it/chalmers/gamma/adapter/primary/api/ApiExceptionAdvice.java

@@ -0,0 +1,39 @@
+package it.chalmers.gamma.adapter.primary.api;
+
+import it.chalmers.gamma.app.authentication.AccessGuard;
+import org.springframework.core.Ordered;
+import org.springframework.core.annotation.Order;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.HttpStatusCode;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+import org.springframework.web.server.ResponseStatusException;
+
+@Order(Ordered.HIGHEST_PRECEDENCE)
+@RestControllerAdvice(basePackages = "it.chalmers.gamma.adapter.primary.api")
+public class ApiExceptionAdvice {
+
+  record ApiErrorBody(int status, String error, String message) {}
+
+  @ExceptionHandler(ResponseStatusException.class)
+  public ResponseEntity<ApiErrorBody> handleResponseStatusException(ResponseStatusException ex) {
+    return createResponse(ex.getStatusCode(), ex.getReason());
+  }
+
+  @ExceptionHandler(AccessGuard.AccessDeniedException.class)
+  public ResponseEntity<ApiErrorBody> handleAccessDeniedException(
+      AccessGuard.AccessDeniedException ex) {
+    return createResponse(HttpStatus.FORBIDDEN, "FORBIDDEN");
+  }
+
+  private ResponseEntity<ApiErrorBody> createResponse(HttpStatusCode statusCode, String reason) {
+    HttpStatus status = HttpStatus.resolve(statusCode.value());
+    String error = status != null ? status.getReasonPhrase() : "Unknown";
+    String message = reason != null ? reason : error;
+    ApiErrorBody body = new ApiErrorBody(statusCode.value(), error, message);
+
+    return ResponseEntity.status(statusCode).contentType(MediaType.APPLICATION_JSON).body(body);
+  }
+}

app/src/main/java/it/chalmers/gamma/adapter/primary/web/GammaErrorController.java

@@ -6,7 +6,7 @@
 import jakarta.servlet.http.HttpServletResponse;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.springframework.boot.web.servlet.error.ErrorController;
+import org.springframework.boot.webmvc.error.ErrorController;
 import org.springframework.http.HttpStatus;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.GetMapping;

app/src/main/java/it/chalmers/gamma/adapter/primary/web/HomeController.java

@@ -116,6 +116,7 @@ public ModelAndView editMe(
             me.groups(),
             form.language,
             me.isAdmin()));
+    mv.addObject("gdpr", this.userGdprTrainingFacade.hasGdprTraining(me.id()));
 
     return mv;
   }
@@ -129,6 +130,7 @@ public ModelAndView getCancelEdit(
 
     mv.setViewName("home/page :: userinfo");
     mv.addObject("me", me);
+    mv.addObject("gdpr", this.userGdprTrainingFacade.hasGdprTraining(me.id()));
 
     return mv;
   }
@@ -185,6 +187,7 @@ public ModelAndView editPassword(
 
     mv.setViewName("home/edited-me-password");
     mv.addObject("me", me);
+    mv.addObject("gdpr", this.userGdprTrainingFacade.hasGdprTraining(me.id()));
 
     return mv;
   }

app/src/main/java/it/chalmers/gamma/adapter/primary/web/SuperGroupsController.java

@@ -192,6 +192,7 @@ public ModelAndView updateSuperGroup(
             form.type,
             form.svDescription,
             form.enDescription));
+    mv.addObject("usages", this.groupFacade.getAllBySuperGroup(id));
 
     return mv;
   }

app/src/main/java/it/chalmers/gamma/adapter/secondary/jpa/apikey/ApiKeyEntity.java

@@ -21,6 +21,7 @@ public class ApiKeyEntity extends MutableEntity<UUID> {
   protected String prettyName;
 
   @Enumerated(EnumType.STRING)
+  @Column(name = "key_type")
   protected ApiKeyType keyType;
 
   @JoinColumn(name = "description")

app/src/main/java/it/chalmers/gamma/app/oauth2/GammaAuthorizationService.java

@@ -10,9 +10,8 @@
 import it.chalmers.gamma.app.supergroup.domain.SuperGroupId;
 import it.chalmers.gamma.app.user.domain.UserId;
 import it.chalmers.gamma.app.user.domain.UserMembership;
+import java.security.Principal;
 import java.util.List;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
 import org.springframework.security.core.userdetails.User;
 import org.springframework.security.oauth2.server.authorization.OAuth2Authorization;
@@ -23,7 +22,6 @@
 @Component
 public class GammaAuthorizationService implements OAuth2AuthorizationService {
 
-  private final Logger LOGGER = LoggerFactory.getLogger(GammaAuthorizationService.class);
   private final GammaAuthorizationRepository gammaAuthorizationRepository;
   private final ClientRepository clientRepository;
   private final GroupRepository groupRepository;
@@ -40,7 +38,7 @@ public GammaAuthorizationService(
   @Override
   public void save(OAuth2Authorization authorization) {
     UsernamePasswordAuthenticationToken authenticationToken =
-        authorization.getAttribute("java.security.Principal");
+        authorization.getAttribute(Principal.class.getName());
 
     if (authenticationToken != null && authenticationToken.getPrincipal() instanceof User user) {
       Client client =
@@ -56,7 +54,22 @@ public void save(OAuth2Authorization authorization) {
       }
     }
 
-    gammaAuthorizationRepository.save(authorization);
+    OAuth2Authorization authorizationToSave = authorization;
+    if (authenticationToken != null) {
+      UsernamePasswordAuthenticationToken sanitizedAuthenticationToken =
+          new UsernamePasswordAuthenticationToken(
+              authenticationToken.getPrincipal(),
+              authenticationToken.getCredentials(),
+              authenticationToken.getAuthorities());
+      sanitizedAuthenticationToken.setDetails(null);
+
+      authorizationToSave =
+          OAuth2Authorization.from(authorization)
+              .attribute(Principal.class.getName(), sanitizedAuthenticationToken)
+              .build();
+    }
+
+    gammaAuthorizationRepository.save(authorizationToSave);
   }
 
   private boolean userPassesRestriction(ClientRestriction restriction, User user) {

app/src/main/java/it/chalmers/gamma/bootstrap/DevServicesConfig.java

@@ -0,0 +1,83 @@
+package it.chalmers.gamma.bootstrap;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.data.redis.autoconfigure.DataRedisConnectionDetails;
+import org.springframework.boot.jdbc.autoconfigure.JdbcConnectionDetails;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.testcontainers.containers.GenericContainer;
+import org.testcontainers.containers.PostgreSQLContainer;
+import org.testcontainers.utility.DockerImageName;
+
+@Configuration(proxyBeanMethods = false)
+@ConditionalOnClass(
+    name = {
+      "org.testcontainers.containers.PostgreSQLContainer",
+      "org.testcontainers.containers.GenericContainer"
+    })
+@ConditionalOnProperty(
+    name = "application.production",
+    havingValue = "false",
+    matchIfMissing = true)
+@ConditionalOnProperty(
+    name = "gamma.dev-services.enabled",
+    havingValue = "true",
+    matchIfMissing = true)
+public class DevServicesConfig {
+
+  private static final Logger LOGGER = LoggerFactory.getLogger(DevServicesConfig.class);
+  private static final DockerImageName POSTGRES_IMAGE = DockerImageName.parse("postgres:16");
+  private static final DockerImageName REDIS_IMAGE = DockerImageName.parse("redis:7-alpine");
+  private static final int REDIS_PORT = 6379;
+
+  @Bean(initMethod = "start", destroyMethod = "stop")
+  public PostgreSQLContainer<?> postgresContainer() {
+    return new PostgreSQLContainer<>(POSTGRES_IMAGE)
+        .withDatabaseName("postgres")
+        .withUsername("postgres")
+        .withPassword("postgres");
+  }
+
+  @Bean(initMethod = "start", destroyMethod = "stop")
+  public GenericContainer<?> redisContainer() {
+    return new GenericContainer<>(REDIS_IMAGE).withExposedPorts(REDIS_PORT);
+  }
+
+  @Bean
+  public JdbcConnectionDetails jdbcConnectionDetails(PostgreSQLContainer<?> postgresContainer) {
+    LOGGER.info("Development PostgreSQL container started at {}", postgresContainer.getJdbcUrl());
+    return new JdbcConnectionDetails() {
+      @Override
+      public String getUsername() {
+        return postgresContainer.getUsername();
+      }
+
+      @Override
+      public String getPassword() {
+        return postgresContainer.getPassword();
+      }
+
+      @Override
+      public String getJdbcUrl() {
+        return postgresContainer.getJdbcUrl();
+      }
+    };
+  }
+
+  @Bean
+  public DataRedisConnectionDetails dataRedisConnectionDetails(GenericContainer<?> redisContainer) {
+    LOGGER.info(
+        "Development Redis container started at {}:{}",
+        redisContainer.getHost(),
+        redisContainer.getMappedPort(REDIS_PORT));
+    return new DataRedisConnectionDetails() {
+      @Override
+      public Standalone getStandalone() {
+        return Standalone.of(redisContainer.getHost(), redisContainer.getMappedPort(REDIS_PORT));
+      }
+    };
+  }
+}

app/src/main/java/it/chalmers/gamma/bootstrap/MockBootstrap.java

@@ -1,6 +1,5 @@
 package it.chalmers.gamma.bootstrap;
 
-import com.fasterxml.jackson.databind.ObjectMapper;
 import java.io.IOException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -9,6 +8,7 @@
 import org.springframework.core.io.Resource;
 import org.springframework.core.io.ResourceLoader;
 import org.springframework.stereotype.Component;
+import tools.jackson.databind.ObjectMapper;
 
 @Component
 public class MockBootstrap {
@@ -24,18 +24,22 @@ public MockBootstrap(ResourceLoader resourceLoader) {
   @Bean
   public BootstrapSettings loadBootstrapSettings(
       @Value("${application.admin-setup}") boolean adminSetup,
-      @Value("${application.production}") boolean production) {
-    return new BootstrapSettings(adminSetup, !production);
+      @Value("${application.production}") boolean production,
+      @Value("${application.mocking:false}") boolean isMocking) {
+    return new BootstrapSettings(adminSetup, !production || isMocking);
   }
 
   @Bean
-  public MockData mockData(BootstrapSettings bootstrapSettings) {
+  public MockData mockData(
+      BootstrapSettings bootstrapSettings,
+      @Value("${application.mock-data-resource:classpath:/mock/mock.json}")
+          String mockDataResource) {
     if (!bootstrapSettings.mocking()) {
       LOGGER.info("Not running mock...");
       return MockData.empty();
     }
 
-    Resource resource = this.resourceLoader.getResource("classpath:/mock/mock.json");
+    Resource resource = this.resourceLoader.getResource(mockDataResource);
     ObjectMapper objectMapper = new ObjectMapper();
     try {
       return objectMapper.readValue(resource.getInputStream(), MockData.class);