AMP-135 - refactored and resolved the test issues.

Author: madhusudan-yasa

Dockerfile

@@ -1,36 +1,4 @@
-# ---- Base image (default fallback) ----
-ARG BASE_IMAGE
-FROM ${BASE_IMAGE:-eclipse-temurin:21}
-
-# ---- Runtime arguments ----
-ARG JAR_FILENAME
-ARG JAR_FILE_PATH
-
-ENV JAR_FILENAME=${JAR_FILENAME:-app.jar}
-ENV JAR_FILE_PATH=${JAR_FILE_PATH:-build/libs}
-ENV JAR_FULL_PATH=$JAR_FILE_PATH/$JAR_FILENAME
-
-# ---- Set runtime ENV for Spring Boot to bind port
-ARG SERVER_PORT
-ENV SERVER_PORT=${SERVER_PORT:-8082}
-
-# ---- Dependencies ----
-RUN apt-get update \
-    && apt-get install -y curl \
-    && rm -rf /var/lib/apt/lists/*
-
-# ---- Application files ----
-COPY $JAR_FULL_PATH /opt/app/app.jar
-COPY lib/applicationinsights.json /opt/app/
-
-# ---- Permissions ----
-RUN chmod 755 /opt/app/app.jar
-
-# ---- Runtime ----
-EXPOSE ${SERVER_PORT:-8082}
-
-# Documented runtime configuration
-# JWT secret for token verification (Base64-encoded HS256 key)
-ENV JWT_SECRET_KEY="it-must-be-a-string-secret-at-least-256-bits-long"
-
+FROM eclipse-temurin:21
+WORKDIR /opt/app
+COPY build/libs/*.jar /opt/app/app.jar
 CMD ["java", "-jar", "/opt/app/app.jar"]

Makefile

@@ -0,0 +1,20 @@
+# Makefile for Docker Compose services
+
+.PHONY: build up down restart logs
+
+build:
+	@echo "Building Gradle JAR..."
+	gradle clean bootJar
+	@echo "Building Docker image..."
+	docker-compose build
+
+up:
+	docker-compose --env-file local.env up -d
+
+down:
+	docker-compose down
+
+restart: down up
+
+logs:
+	docker-compose logs -f

build.gradle

@@ -45,6 +45,7 @@ dependencies {
 
   // --- Observability / Actuator / OTEL / Prometheus ---
   implementation 'org.springframework.boot:spring-boot-starter-actuator'
+    implementation 'org.hibernate.validator:hibernate-validator'
   implementation 'org.springframework.boot:spring-boot-starter-opentelemetry'
   implementation 'io.jsonwebtoken:jjwt:0.13.0'
   testRuntimeOnly 'org.junit.platform:junit-platform-launcher'

docker-compose.yml

@@ -1,3 +1,5 @@
+version: '3.9'
+
 services:
   postgres:
     image: postgres:16-alpine
@@ -7,29 +9,21 @@ services:
       POSTGRES_PASSWORD: postgres
     ports:
       - "5432:5432"
+    healthcheck:
+      test: [ "CMD-SHELL", "pg_isready -U postgres" ]
+      interval: 10s
+      timeout: 5s
+      retries: 5
 
   service-hmcts-marketplace-springboot-template:
     env_file:
-      - .env
+      - local.env
     build:
       context: .
       dockerfile: Dockerfile
-      args:
-        http_proxy: ${http_proxy}
-        https_proxy: ${https_proxy}
-        no_proxy: ${no_proxy}
-        BASE_IMAGE: ${BASE_IMAGE}
-        SERVER_PORT: ${SERVER_PORT}
-        JAR_FILENAME: ${JAR_FILENAME}
-        JAR_FILE_PATH: ${JAR_FILE_PATH}
-    environment:
-      - SERVER_PORT=${SERVER_PORT:-8082}
-      - APP_NAME_DATASOURCE_URL=${APP_NAME_DATASOURCE_URL:-jdbc:postgresql://db:5432/appdb}
-      - APP_NAME_DATASOURCE_USERNAME=${APP_NAME_DATASOURCE_USERNAME:-app}
-      - APP_NAME_DATASOURCE_PASSWORD=${APP_NAME_DATASOURCE_PASSWORD:-app}
     depends_on:
       postgres:
         condition: service_healthy
     ports:
-      - "${SERVER_PORT:-8082}:${SERVER_PORT:-8082}"
+      - "8082:8082"
 

local.env

@@ -0,0 +1,54 @@
+# ------------------------------
+# Spring Boot Application
+# ------------------------------
+
+# Application
+SPRING_APPLICATION_NAME=service-UPDATE-TO-BE-NAME-OF-SERVICE
+
+# Datasource
+APP_NAME_DATASOURCE_URL=jdbc:postgresql://host.docker.internal:5432/postgres
+APP_NAME_DATASOURCE_USERNAME=postgres
+APP_NAME_DATASOURCE_PASSWORD=postgres
+
+# JPA
+SPRING_JPA_OPEN_IN_VIEW=false
+
+# Flyway
+FLYWAY_ENABLED=true
+FLYWAY_LOCATIONS=classpath:db/migration
+FLYWAY_BASELINE_ON_MIGRATE=true
+
+# Server
+SERVER_PORT=8082
+MANAGEMENT_SERVER_PORT=8082
+SERVER_SHUTDOWN=graceful
+SERVER_HTTP2_ENABLED=true
+SERVER_FORWARD_HEADERS_STRATEGY=framework
+SERVER_COMPRESSION_ENABLED=true
+SERVER_COMPRESSION_MIN_RESPONSE_SIZE=2KB
+SERVER_COMPRESSION_MIME_TYPES=application/json
+
+# Management / Actuator
+MANAGEMENT_ENDPOINTS_WEB_BASE_PATH=/actuator
+MANAGEMENT_ENDPOINTS_WEB_EXPOSURE_INCLUDE=health,info,prometheus
+MANAGEMENT_ENDPOINT_HEALTH_PROBES_ENABLED=true
+
+# Metrics / Tracing
+CLUSTER_NAME=local
+REGION=local
+TRACING_SAMPLER_PROBABILITY=1.0
+OTEL_TRACES_URL=http://localhost:4318/traces
+OTEL_METRICS_ENABLED=false
+OTEL_METRICS_URL=http://localhost:4318/metrics
+
+# Azure Application Insights
+RPE_APPINSIGHTS_INSTRUMENTATIONKEY=00000000-0000-0000-0000-000000000000
+
+# JWT
+JWT_SECRET_KEY=it-must-be-a-string-secret-at-least-256-bits-long
+JWT_FILTER_ENABLED=false
+
+# Logging
+LOGGING_LEVEL_ROOT=INFO
+LOGGING_CONFIG=classpath:logback.xml
+

src/main/java/uk/gov/hmcts/cp/controllers/ExampleController.java

@@ -1,22 +1,25 @@
 package uk.gov.hmcts.cp.controllers;
 
-import lombok.AllArgsConstructor;
+import jakarta.validation.constraints.NotNull;
+import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RestController;
 import uk.gov.hmcts.cp.openapi.api.ExamplesApi;
 import uk.gov.hmcts.cp.openapi.model.ExampleResponse;
 import uk.gov.hmcts.cp.services.ExampleService;
 
 @RestController
-@AllArgsConstructor
+@RequiredArgsConstructor
 @Slf4j
 public class ExampleController implements ExamplesApi {
 
     private final ExampleService exampleService;
 
     @Override
-    public ResponseEntity<ExampleResponse> getExampleByExampleId(final  Long exampleId) {
+    public ResponseEntity<ExampleResponse> getExampleByExampleId(@PathVariable("example_id") @NotNull Long exampleId) {
+
         log.info("getExampleByExampleId example for {}", exampleId);
         return ResponseEntity.ok(exampleService.getExampleById(exampleId));
     }

src/main/java/uk/gov/hmcts/cp/entities/ExampleEntity.java

@@ -11,11 +11,11 @@
 import lombok.NoArgsConstructor;
 
 @Entity
-@Table(name = "example")
 @Getter
 @Builder(toBuilder = true)
 @NoArgsConstructor
 @AllArgsConstructor
+@Table(name = "example")
 public class ExampleEntity {
 
     @Id

src/main/java/uk/gov/hmcts/cp/services/ExampleService.java

@@ -17,7 +17,7 @@ public class ExampleService {
     private final ExampleMapper exampleMapper;
 
     public ExampleResponse getExampleById(final long exampleId) {
-        ExampleEntity entity = exampleRepository.getReferenceById(exampleId);
+        ExampleEntity entity = exampleRepository.findById(exampleId).orElseThrow();
         return exampleMapper.mapExampleToResponse(entity);
     }
 

src/test/java/uk/gov/hmcts/cp/config/TestContainersInitialise.java

@@ -1,32 +1,31 @@
 package uk.gov.hmcts.cp.config;
 
-import lombok.SneakyThrows;
-import lombok.extern.slf4j.Slf4j;
 import org.springframework.boot.test.util.TestPropertyValues;
 import org.springframework.context.ApplicationContextInitializer;
 import org.springframework.context.ConfigurableApplicationContext;
 import org.testcontainers.containers.PostgreSQLContainer;
 
-@Slf4j
-public class TestContainersInitialise implements ApplicationContextInitializer<ConfigurableApplicationContext> {
+public class TestContainersInitialise
+        implements ApplicationContextInitializer<ConfigurableApplicationContext> {
 
-    private static final PostgreSQLContainer postgreSQLContainer = new PostgreSQLContainer(
-            "postgres")
-            .withDatabaseName("postgres")
-            .withUsername("postgres")
-            .withPassword("postgres");
+    private static final PostgreSQLContainer<?> postgreSQLContainer =
+            new PostgreSQLContainer<>("postgres:15.3")
+                    .withDatabaseName("postgres")
+                    .withUsername("postgres")
+                    .withPassword("postgres")
+                    .withReuse(true);
 
+    static {
+        postgreSQLContainer.start(); // start once
+    }
 
-    @SneakyThrows
     @Override
-    public void initialize(ConfigurableApplicationContext applicationContext) {
-        postgreSQLContainer.start();
+    public void initialize(ConfigurableApplicationContext context) {
+
         TestPropertyValues.of(
                 "spring.datasource.url=" + postgreSQLContainer.getJdbcUrl(),
                 "spring.datasource.username=" + postgreSQLContainer.getUsername(),
                 "spring.datasource.password=" + postgreSQLContainer.getPassword()
-        ).applyTo(applicationContext.getEnvironment());
-        log.info("COLING starting container");
+        ).applyTo(context.getEnvironment());
     }
 }
-

src/test/java/uk/gov/hmcts/cp/integration/IntegrationTestBase.java

@@ -2,14 +2,11 @@
 
 import jakarta.annotation.Resource;
 import lombok.extern.slf4j.Slf4j;
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.boot.webmvc.test.autoconfigure.AutoConfigureMockMvc;
 import org.springframework.test.context.ContextConfiguration;
 import org.springframework.test.web.servlet.MockMvc;
 import uk.gov.hmcts.cp.config.TestContainersInitialise;
-import uk.gov.hmcts.cp.entities.ExampleEntity;
-import uk.gov.hmcts.cp.repositories.ExampleRepository;
 
 @SpringBootTest
 @ContextConfiguration(initializers = TestContainersInitialise.class)
@@ -19,13 +16,4 @@ public abstract class IntegrationTestBase {
 
     @Resource
     protected MockMvc mockMvc;
-
-    @Autowired
-    protected ExampleRepository exampleRepository;
-
-    protected ExampleEntity insertExample(String text) {
-        ExampleEntity exampleEntity = exampleRepository.save(ExampleEntity.builder().exampleText(text).build());
-        log.info("Inserted example:{}", exampleEntity.getId());
-        return exampleEntity;
-    }
 }