Merge branch 'main' into feature/fix-dependabot

Author: duncancrawford

.github/workflows/ci-build-publish.yml

@@ -75,7 +75,7 @@ jobs:
           echo "artefact_name=${repo_name}-${{ needs.Artefact-Version.outputs.artefact_version }}" >> $GITHUB_OUTPUT
 
       - name: Upload JAR Artefact
-        uses: actions/upload-artifact@v6
+        uses: actions/upload-artifact@v7
         with:
           name: app-jar
           path: build/libs/${{ steps.repo_vars.outputs.artefact_name }}.jar
@@ -133,7 +133,7 @@ jobs:
         uses: actions/checkout@v6
 
       - name: Download JAR Artefact
-        uses: actions/download-artifact@v7
+        uses: actions/download-artifact@v8
         with:
           name: app-jar
           path: build/libs

.github/workflows/codeql.yml

@@ -67,7 +67,7 @@ jobs:
         # - It's available to download and inspect from the GitHub Actions UI
       - name: Upload SBOM
         if: always()
-        uses: actions/upload-artifact@v6
+        uses: actions/upload-artifact@v7
         with:
           name: sbom
           path: build/resources/main/META-INF/sbom/application.cdx.json
@@ -115,7 +115,7 @@ jobs:
           cmd_options: "-a -J zap_report.json -r zap_report.html"
 
       - name: Upload ZAP HTML Report
-        uses: actions/upload-artifact@v6
+        uses: actions/upload-artifact@v7
         with:
           name: zap-html-report
           path: zap_report.html

src/main/resources/logback.xml

@@ -3,16 +3,20 @@
         <encoder class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
             <providers>
                 <mdc/>
-                <logLevel/>
                 <timestamp>
                     <fieldName>timestamp</fieldName>
                     <pattern>yyyy-MM-dd' 'HH:mm:ss.SSS</pattern>
                 </timestamp>
                 <loggerName/>
                 <threadName/>
-                <message/>
+                <logLevel/>
+                <pattern>
+                    <pattern>{"message": "%message%n%xException{full}"}</pattern>
+                </pattern>
             </providers>
         </encoder>
     </appender>
-    <root level="INFO"><appender-ref ref="JSON"/></root>
+    <root level="INFO">
+        <appender-ref ref="JSON"/>
+    </root>
 </configuration>

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

@@ -1,51 +1,53 @@
 package uk.gov.hmcts.cp.integration;
 
+import ch.qos.logback.classic.AsyncAppender;
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import lombok.extern.slf4j.Slf4j;
+import org.assertj.core.api.AssertionsForClassTypes;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
+import org.slf4j.LoggerFactory;
 import org.slf4j.MDC;
 
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.PrintStream;
-import java.nio.charset.StandardCharsets;
 import java.util.Map;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
 @Slf4j
 class SpringLoggingIntegrationTest extends IntegrationTestBase {
-
-    private final PrintStream originalStdOut = System.out;
+    private PrintStream originalStdOut = System.out;
 
     @AfterEach
     void afterEach() {
         System.setOut(originalStdOut);
     }
 
     @Test
-    void springboot_test_should_log_correct_fields() throws IOException {
+    void springboot_test_should_log_correct_fields_including_exception() throws IOException {
         MDC.put("any-mdc-field", "1234-1234");
-        final ByteArrayOutputStream capturedStdOut = captureStdOut();
-        log.info("spring boot test message");
+        ByteArrayOutputStream capturedStdOut = captureStdOut();
+        log.info("spring boot test message", new RuntimeException("MyException"));
 
-        final Map<String, Object> capturedFields = new ObjectMapper().readValue(capturedStdOut.toString(StandardCharsets.UTF_8), new TypeReference<>() {
+        String logMessage = capturedStdOut.toString();
+        AssertionsForClassTypes.assertThat(logMessage).isNotEmpty();
+        Map<String, Object> capturedFields = new ObjectMapper().readValue(logMessage, new TypeReference<>() {
         });
-
-        assertThat(capturedFields)
-                .containsEntry("any-mdc-field", "1234-1234")
-                .containsKey("timestamp")
-                .containsEntry("logger_name", "uk.gov.hmcts.cp.integration.SpringLoggingIntegrationTest")
-                .containsEntry("thread_name", "Test worker")
-                .containsEntry("level", "INFO")
-                .containsEntry("message", "spring boot test message");
+        assertThat(capturedFields.get("any-mdc-field")).isEqualTo("1234-1234");
+        assertThat(capturedFields.get("timestamp")).isNotNull();
+        assertThat(capturedFields.get("logger_name")).isEqualTo("uk.gov.hmcts.cp.integration.SpringLoggingIntegrationTest");
+        assertThat(capturedFields.get("thread_name")).isEqualTo("Test worker");
+        assertThat(capturedFields.get("level")).isEqualTo("INFO");
+        assertThat(capturedFields.get("message").toString()).contains("spring boot test message\njava.lang.RuntimeException: MyException");
+        assertThat(capturedFields.get("message").toString()).contains("at uk.gov.hmcts.cp.integration.SpringLoggingIntegrationTest");
     }
 
     private ByteArrayOutputStream captureStdOut() {
         final ByteArrayOutputStream capturedStdOut = new ByteArrayOutputStream();
-        System.setOut(new PrintStream(capturedStdOut, true, StandardCharsets.UTF_8));
+        System.setOut(new PrintStream(capturedStdOut));
         return capturedStdOut;
     }
 }

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

@@ -143,7 +143,7 @@ private void assertTracingFields(final Map<String, Object> log, final String exp
 
     private void assertCommonLogFields(final Map<String, Object> log) {
         assertEquals("uk.gov.hmcts.cp.controllers.ExampleController", log.get("logger_name"));
-        assertEquals(log.get("message"), "getExampleByExampleId example for " + entity.getId());
+        assertEquals(log.get("message"), "getExampleByExampleId example for " + entity.getId() + "\n");
     }
 
     private void assertResponseHeaders(final MvcResult result, final String expectedTraceId, final String expectedSpanId) {

src/test/java/uk/gov/hmcts/cp/logging/JunitLoggingTest.java

@@ -32,7 +32,7 @@ void junit_should_log_correct_fields() throws JsonProcessingException {
                 .containsEntry("logger_name", "uk.gov.hmcts.cp.logging.JunitLoggingTest")
                 .containsEntry("thread_name", "Test worker")
                 .containsEntry("level", "INFO")
-                .containsEntry("message", "junit test message");
+                .containsEntry("message", "junit test message\n");
     }
 
     private ByteArrayOutputStream captureStdOut() {