FACT-2658 audit view updates

README.md

@@ -1,4 +1,5 @@
 # FaCT Data API
+
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=uk.gov.hmcts.reform%3Afact-data-api&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=uk.gov.hmcts.reform%3Afact-data-api)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=uk.gov.hmcts.reform%3Afact-data-api&metric=coverage)](https://sonarcloud.io/summary/new_code?id=uk.gov.hmcts.reform%3Afact-data-api)
 [![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=uk.gov.hmcts.reform%3Afact-data-api&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=uk.gov.hmcts.reform%3Afact-data-api)

src/functionalTest/java/uk/gov/hmcts/reform/fact/functional/controllers/AuditControllerFunctionalTest.java

@@ -18,6 +18,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.springframework.http.HttpStatus.CREATED;
 import static org.springframework.http.HttpStatus.NO_CONTENT;
+import static org.springframework.http.HttpStatus.NOT_FOUND;
 import static org.springframework.http.HttpStatus.OK;
 
 @Feature("Audit Controller")
@@ -94,6 +95,42 @@ void shouldReturnExpectedAuditActionsForCourtAndAddressFlow() {
             .containsExactly("DELETE", "UPDATE", ACTION_INSERT);
     }
 
+    @Test
+    @DisplayName("GET /audits/{auditId}/v1 returns a single audit record for an existing id")
+    void shouldReturnSingleAuditRecordById() {
+        final UUID courtId = TestDataHelper.createCourt(http, "Test Court Audit By Id");
+        final String auditsPath = String.format(
+            "/audits/v1?pageNumber=0&pageSize=%d&fromDate=%s&courtId=%s",
+            50,
+            LocalDate.now().minusDays(1),
+            courtId
+        );
+
+        final Response auditsResponse = http.doGet(auditsPath);
+        AssertionHelper.assertStatus(auditsResponse, OK);
+
+        final String auditId = auditsResponse.jsonPath().getString("content[0].id");
+        assertThat(auditId).as("Expected at least one audit id to be present").isNotBlank();
+
+        final Response singleAuditResponse = http.doGet("/audits/" + auditId + "/v1");
+        AssertionHelper.assertStatus(singleAuditResponse, OK);
+
+        assertThat(singleAuditResponse.jsonPath().getString("id"))
+            .as("Returned audit id should match requested id")
+            .isEqualTo(auditId);
+
+        assertThat(singleAuditResponse.jsonPath().getString("subjectId"))
+            .as("Returned audit should belong to the created court")
+            .isEqualTo(courtId.toString());
+    }
+
+    @Test
+    @DisplayName("GET /audits/{auditId}/v1 returns not found for unknown id")
+    void shouldReturnNotFoundForUnknownAuditId() {
+        final Response response = http.doGet("/audits/" + UUID.randomUUID() + "/v1");
+        AssertionHelper.assertStatus(response, NOT_FOUND);
+    }
+
     private static List<String> extractActionTypesForEntity(final Response response, final String actionEntity) {
         return response.jsonPath().getList(
             "content.findAll { it.actionEntity == '" + actionEntity + "' }.actionType",

src/integrationTest/java/uk/gov/hmcts/reform/fact/data/api/audit/AuditingTest.java

@@ -366,6 +366,7 @@ private void assertAuditActionsForEntity(Court owningCourt, String testedEntity,
             1000,
             CREATED_AFTER,
             null,
+            null,
             owningCourt.getId().toString(),
             null,
             null

src/integrationTest/java/uk/gov/hmcts/reform/fact/data/api/controllers/AuditControllerTest.java

@@ -11,6 +11,7 @@
 import uk.gov.hmcts.reform.fact.data.api.entities.ServiceCentre;
 import uk.gov.hmcts.reform.fact.data.api.entities.User;
 import uk.gov.hmcts.reform.fact.data.api.entities.types.AuditActionType;
+import uk.gov.hmcts.reform.fact.data.api.entities.types.AuditSubjectType;
 import uk.gov.hmcts.reform.fact.data.api.entities.types.UserRole;
 import uk.gov.hmcts.reform.fact.data.api.repositories.AuditRepository;
 import uk.gov.hmcts.reform.fact.data.api.repositories.CourtRepository;
@@ -26,6 +27,7 @@
 import java.util.Optional;
 import java.util.UUID;
 
+import com.jayway.jsonpath.JsonPath;
 import io.qameta.allure.Feature;
 import org.apache.commons.lang3.RandomStringUtils;
 import org.hamcrest.Description;
@@ -345,12 +347,101 @@ void getFilteredAndPaginatedAuditsReturnsBadRequestForInvalidPageNumber() throws
             .andExpect(status().isBadRequest());
     }
 
+    @Test
+    @DisplayName("GET /audits/v1 returns results when subjectType is provided")
+    void getFilteredAndPaginatedAuditsReturnsResultsWhenSubjectTypeProvided() throws Exception {
+        createTestCourts(2);
+        createTestServiceCentre();
+
+        mvc.perform(get("/audits/v1")
+                        .param("pageNumber", "0")
+                        .param("pageSize", "10")
+                        .param("fromDate", LocalDate.now().toString())
+                        .param("subjectType", AuditSubjectType.COURT.name()))
+            .andExpect(status().isOk())
+            .andExpect(jsonPath("$.content").isArray())
+            .andExpect(jsonPath("$.content.length()").value(2))
+            .andExpect(jsonPath("$.content[*].subjectType")
+                           .value(allElementsEqual(AuditSubjectType.COURT.name())))
+            .andExpect(jsonPath("$.page.number").value(0))
+            .andExpect(jsonPath("$.page.totalElements").value(2));
+    }
+
+    @Test
+    @DisplayName("GET /audits/v1 returns 400 when subjectType is invalid")
+    void getFilteredAndPaginatedAuditsReturnsBadRequestForInvalidSubjectType() throws Exception {
+        mvc.perform(get("/audits/v1")
+                        .param("pageNumber", "0")
+                        .param("pageSize", "5")
+                        .param("fromDate", LocalDate.now().toString())
+                        .param("subjectType", "NOT_A_REAL_TYPE"))
+            .andExpect(status().isBadRequest());
+    }
+
     @Test
     @DisplayName("DELETE /audits/v1 returns 204")
     void deleteAuditsRemovesExpiredAuditsAndReturns204() throws Exception {
         mvc.perform(delete("/audits/v1")).andExpect(status().isNoContent());
     }
 
+    @Test
+    @DisplayName("GET /audits/subjectoptions/v1 returns subject options map")
+    void getSubjectNameAndIdMapReturnsResults() throws Exception {
+        // Seed at least one court so COURT options are present
+        createTestCourts(1);
+        createTestServiceCentre();
+
+        mvc.perform(get("/audits/subjectoptions/v1"))
+            .andExpect(status().isOk())
+            .andExpect(jsonPath("$.COURT").isArray())
+            .andExpect(jsonPath("$.SERVICE_CENTRE").isArray())
+            .andExpect(jsonPath("$.COURT[0].name").exists())
+            .andExpect(jsonPath("$.COURT[0].id").exists())
+            .andExpect(jsonPath("$.SERVICE_CENTRE[0].name").exists())
+            .andExpect(jsonPath("$.SERVICE_CENTRE[0].id").exists());
+    }
+
+    @Test
+    @DisplayName("GET /audits/{auditId}/v1 returns audit when id is valid")
+    void getAuditByIdReturnsAuditWhenIdIsValid() throws Exception {
+        Court court = createTestCourts(1).getFirst();
+
+        String auditsResponse = mvc.perform(get("/audits/v1")
+                                                .param("pageNumber", "0")
+                                                .param("pageSize", "10")
+                                                .param("fromDate", LocalDate.now().toString())
+                                                .param("courtId", court.getId().toString()))
+            .andExpect(status().isOk())
+            .andExpect(jsonPath("$.content").isArray())
+            .andExpect(jsonPath("$.content.length()").value(1))
+            .andReturn()
+            .getResponse()
+            .getContentAsString();
+
+        String auditId = JsonPath.read(auditsResponse, "$.content[0].id");
+
+        mvc.perform(get("/audits/" + auditId + "/v1"))
+            .andExpect(status().isOk())
+            .andExpect(jsonPath("$.id").value(auditId))
+            .andExpect(jsonPath("$.subjectId").value(court.getCourtId().toString()))
+            .andExpect(jsonPath("$.actionType").exists())
+            .andExpect(jsonPath("$.createdAt").exists());
+    }
+
+    @Test
+    @DisplayName("GET /audits/{auditId}/v1 returns 400 when auditId is not a UUID")
+    void getAuditByIdReturnsBadRequestWhenAuditIdIsInvalid() throws Exception {
+        mvc.perform(get("/audits/not-a-valid-uuid/v1"))
+            .andExpect(status().isBadRequest());
+    }
+
+    @Test
+    @DisplayName("GET /audits/{auditId}/v1 returns 404 when audit does not exist")
+    void getAuditByIdReturnsNotFoundWhenAuditDoesNotExist() throws Exception {
+        mvc.perform(get("/audits/" + UUID.randomUUID() + "/v1"))
+            .andExpect(status().isNotFound());
+    }
+
     private List<Court> createTestCourts(int num) {
         List<Court> results = new ArrayList<>();
         for (int i = 0; i < num; i++) {

src/main/java/uk/gov/hmcts/reform/fact/data/api/controllers/AuditController.java

@@ -1,13 +1,18 @@
 package uk.gov.hmcts.reform.fact.data.api.controllers;
 
 import uk.gov.hmcts.reform.fact.data.api.entities.Audit;
+import uk.gov.hmcts.reform.fact.data.api.entities.types.AuditSubjectType;
+import uk.gov.hmcts.reform.fact.data.api.entities.types.NameAndId;
 import uk.gov.hmcts.reform.fact.data.api.errorhandling.exceptions.InvalidDateRangeException;
 import uk.gov.hmcts.reform.fact.data.api.errorhandling.exceptions.InvalidParameterCombinationException;
 import uk.gov.hmcts.reform.fact.data.api.security.SecuredFactRestController;
 import uk.gov.hmcts.reform.fact.data.api.services.AuditService;
 import uk.gov.hmcts.reform.fact.data.api.validation.annotations.ValidUUID;
 
 import java.time.LocalDate;
+import java.util.List;
+import java.util.Map;
+import java.util.UUID;
 
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
@@ -21,6 +26,7 @@
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestParam;
 
@@ -52,6 +58,7 @@ public ResponseEntity<Page<Audit>> getFilteredAndPaginatedAudits(
         @PositiveOrZero(message = "pageNumber must be greater than or equal to 0") int pageNumber,
         @RequestParam(name = "pageSize", defaultValue = "25")
         @Positive(message = "pageSize must be greater than 0") int pageSize,
+        @RequestParam(name = "subjectType", required = false) AuditSubjectType subjectType,
         @RequestParam(name = "courtId", required = false) @ValidUUID(allowNull = true) String courtId,
         @RequestParam(name = "serviceCentreId", required = false) @ValidUUID(allowNull = true) String serviceCentreId,
         @RequestParam(name = "email", required = false)
@@ -80,13 +87,29 @@ public ResponseEntity<Page<Audit>> getFilteredAndPaginatedAudits(
                 pageSize,
                 fromDate,
                 toDate,
+                subjectType,
                 courtId,
                 serviceCentreId,
                 emailMatch
             )
         );
     }
 
+    @GetMapping("/{auditId}/v1")
+    @Operation(
+        summary = "Retrieve a single audit record",
+        description = "Fetch the audit record that relates to the given id"
+    )
+    @ApiResponses(value = {
+        @ApiResponse(responseCode = "200", description = "Successfully retrieved Audit record"),
+        @ApiResponse(responseCode = "400", description = "Invalid request parameters supplied"),
+        @ApiResponse(responseCode = "404", description = "Audit record with the given id was not found")
+    })
+    public ResponseEntity<Audit> getAuditById(
+        @ValidUUID @PathVariable String auditId) {
+        return ResponseEntity.ok(auditService.getAuditById(UUID.fromString(auditId)));
+    }
+
     @DeleteMapping("/v1")
     @Operation(
         summary = "Remove expired audits",
@@ -100,4 +123,15 @@ public ResponseEntity<Void> removeExpiredAuditEntries() {
         return ResponseEntity.noContent().build();
     }
 
+    @GetMapping("/subjectoptions/v1")
+    @Operation(
+        summary = "Retrieve the complete set of name->id value pairs for all supported audit subjects",
+        description = "Fetches a Map of all subject names with their corresponding ids, mapped to their subject type"
+    )
+    @ApiResponses(value = {
+        @ApiResponse(responseCode = "200", description = "Successfully retrieved map of subject-> name+id pairs")
+    })
+    public ResponseEntity<Map<AuditSubjectType, List<NameAndId>>> getSubjectNameAndIdMap() {
+        return ResponseEntity.ok(this.auditService.getSubjectNameAndIdMap());
+    }
 }

src/main/java/uk/gov/hmcts/reform/fact/data/api/entities/Audit.java

@@ -62,7 +62,7 @@ public class Audit {
 
     @Schema(description = "The associated User")
     @ManyToOne
-    @JoinColumn(name = "user_id", insertable = false, updatable = false)
+    @JoinColumn(name = "user_id", referencedColumnName = "id", insertable = false, updatable = false)
     private User user;
 
     @Schema(description = "The action type")

src/main/java/uk/gov/hmcts/reform/fact/data/api/entities/types/AuditSubjectType.java

@@ -1,5 +1,8 @@
 package uk.gov.hmcts.reform.fact.data.api.entities.types;
 
+/**
+ * Subject types that are applicable for auditing.
+ */
 public enum AuditSubjectType {
     COURT,
     SERVICE_CENTRE

src/main/java/uk/gov/hmcts/reform/fact/data/api/entities/types/NameAndId.java

@@ -0,0 +1,11 @@
+package uk.gov.hmcts.reform.fact.data.api.entities.types;
+
+import java.util.UUID;
+
+/**
+ * re-usable Name and Id pair object for use in repository results.
+ *
+ * @param name the entity Name
+ * @param id the entity Id
+ */
+public record NameAndId(String name, UUID id) {}