Integration tests and Open API validation

stephenokeefe · stephenokeefe · commit 7e0ad0cbcaa6 · 2025-10-17T11:59:37.000+01:00
diff --git a/src/integrationTest/java/uk/gov/hmcts/darts/authorisation/component/impl/AuthorisationImplTest.java b/src/integrationTest/java/uk/gov/hmcts/darts/authorisation/component/impl/AuthorisationImplTest.java
@@ -29,7 +29,7 @@
 import static uk.gov.hmcts.darts.common.enums.SecurityRoleEnum.JUDICIARY;
 import static uk.gov.hmcts.darts.common.enums.SecurityRoleEnum.REQUESTER;
 import static uk.gov.hmcts.darts.hearings.exception.HearingApiError.HEARING_NOT_FOUND;
-import static uk.gov.hmcts.darts.transcriptions.exception.TranscriptionApiError.TRANSCRIPTION_NOT_FOUND;
+import static uk.gov.hmcts.darts.transcriptions.exception.TranscriptionApiError.BAD_REQUEST_TRANSCRIPTION_ID;
 
 class AuthorisationImplTest extends IntegrationBase {
 
@@ -222,8 +222,8 @@ void authoriseByTranscriptionIdShouldThrowTranscriptionApiErrorTranscriptionNotF
                 -1L, Set.of(JUDICIARY))
         );
 
-        assertEquals(TRANSCRIPTION_NOT_FOUND.getTitle(), exception.getMessage());
-        assertEquals(TRANSCRIPTION_NOT_FOUND, exception.getError());
+        assertEquals(BAD_REQUEST_TRANSCRIPTION_ID.getTitle(), exception.getMessage());
+        assertEquals(BAD_REQUEST_TRANSCRIPTION_ID, exception.getError());
     }
 
     @Test
diff --git a/src/integrationTest/java/uk/gov/hmcts/darts/transcriptions/api/TranscriptionOpenApiContractTest.java b/src/integrationTest/java/uk/gov/hmcts/darts/transcriptions/api/TranscriptionOpenApiContractTest.java
@@ -4,12 +4,10 @@
 import com.atlassian.oai.validator.model.Request;
 import com.atlassian.oai.validator.model.SimpleRequest;
 import com.atlassian.oai.validator.report.ValidationReport;
-import lombok.extern.slf4j.Slf4j;
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
-@Slf4j
 class TranscriptionOpenApiContractTest {
 
     private static final OpenApiInteractionValidator VALIDATOR =
@@ -20,14 +18,39 @@ class TranscriptionOpenApiContractTest {
         ).build();
 
     @Test
-    void negativeTranscriptionId() {
+    void openApi_ShouldReturnError_WhenNegativeTranscriptionIdUsed() {
         Request request = SimpleRequest.Builder
-            .get("/transcriptions/-1/document")
+            .get("/transcriptions/-123/document")
             .build();
 
         ValidationReport report = VALIDATOR.validateRequest(request);
 
-        assertTrue(report.hasErrors());
-        report.getMessages().forEach(m -> log.info(m.getMessage()));
+        assertTrue(report.getMessages().stream()
+            .anyMatch(m -> m.getMessage().contains("Numeric instance is lower than the required " +
+                                                       "minimum (minimum: 1, found: -123)")));
+    }
+
+    @Test
+    void openApi_ShouldReturnError_WhenAboveMaximumTranscriptionIdUsed() {
+        Request request = SimpleRequest.Builder
+            .get("/transcriptions/922337203685477580799/document")
+            .build();
+
+        ValidationReport report = VALIDATOR.validateRequest(request);
+
+        assertTrue(report.getMessages().stream()
+                       .anyMatch(m -> m.getMessage().contains("Numeric instance is greater than the required" +
+                                                                  " maximum (maximum: 9223372036854775807, found: 922337203685477580799)")));
+    }
+
+    @Test
+    void openApi_ShouldReturnNoError_WhenValidTranscriptionIdUsed() {
+        Request request = SimpleRequest.Builder
+            .get("/transcriptions/1000/document")
+            .build();
+
+        ValidationReport report = VALIDATOR.validateRequest(request);
+
+        assertTrue(report.getMessages().isEmpty(), "Expected no validation errors for a valid transcription_id");
     }
 }
diff --git a/src/integrationTest/java/uk/gov/hmcts/darts/transcriptions/controller/TranscriptionControllerDownloadTranscriptIntTest.java b/src/integrationTest/java/uk/gov/hmcts/darts/transcriptions/controller/TranscriptionControllerDownloadTranscriptIntTest.java
@@ -328,13 +328,13 @@ void downloadTranscript_ShouldReturnError_WhenNegativeTranscriptionIdUsed() thro
                 "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
             );
         MvcResult mvcResult = mockMvc.perform(requestBuilder)
-            .andExpect(status().isNotFound())
+            .andExpect(status().isBadRequest())
             .andReturn();
 
         String actualResponse = mvcResult.getResponse().getContentAsString();
 
         String expectedResponse = """
-            {"type":"TRANSCRIPTION_101","title":"The requested transcription cannot be found","status":404}
+            {"type":"TRANSCRIPTION_124","title":"Invalid transcription id","status":400}
             """;
         JSONAssert.assertEquals(expectedResponse, actualResponse, JSONCompareMode.NON_EXTENSIBLE);
 
diff --git a/src/integrationTest/java/uk/gov/hmcts/darts/transcriptions/controller/TranscriptionControllerGetTranscriptionTest.java b/src/integrationTest/java/uk/gov/hmcts/darts/transcriptions/controller/TranscriptionControllerGetTranscriptionTest.java
@@ -287,11 +287,11 @@ void getTranscriptionNotFoundWhenIsCurrentFalse() throws Exception {
     }
 
     @Test
-    void getTranscriptionNotFound() throws Exception {
+    void getTranscriptionBadRequest() throws Exception {
         MockHttpServletRequestBuilder requestBuilder = get(ENDPOINT_URL_TRANSCRIPTION, -999);
-        MvcResult response = mockMvc.perform(requestBuilder).andExpect(status().isNotFound()).andReturn();
+        MvcResult response = mockMvc.perform(requestBuilder).andExpect(status().isBadRequest()).andReturn();
         String actualResponse = response.getResponse().getContentAsString();
-        String expectedResponse = getContentsFromFile("tests/transcriptions/transcription/expectedResponseNotFound.json");
+        String expectedResponse = getContentsFromFile("tests/transcriptions/transcription/expectedResponseBadRequest.json");
         JSONAssert.assertEquals(expectedResponse, actualResponse, JSONCompareMode.NON_EXTENSIBLE);
     }
 
diff --git a/src/integrationTest/java/uk/gov/hmcts/darts/transcriptions/controller/TranscriptionControllerUpdateTranscriptionWithTranscriberIntTest.java b/src/integrationTest/java/uk/gov/hmcts/darts/transcriptions/controller/TranscriptionControllerUpdateTranscriptionWithTranscriberIntTest.java
@@ -142,12 +142,12 @@ void updateTranscriptionShouldReturnTranscriptionNotFoundError() throws Exceptio
             .header("Content-Type", "application/json")
             .content(objectMapper.writeValueAsString(updateTranscription));
         MvcResult mvcResult = mockMvc.perform(requestBuilder)
-            .andExpect(status().isNotFound())
+            .andExpect(status().isBadRequest())
             .andReturn();
 
         String actualJson = mvcResult.getResponse().getContentAsString();
         String expectedJson = """
-            {"type":"TRANSCRIPTION_101","title":"The requested transcription cannot be found","status":404}
+            {"type":"TRANSCRIPTION_124","title":"Invalid transcription id","status":400}
             """;
         JSONAssert.assertEquals(expectedJson, actualJson, JSONCompareMode.NON_EXTENSIBLE);
 
diff --git a/src/integrationTest/resources/tests/transcriptions/transcription/expectedResponseBadRequest.json b/src/integrationTest/resources/tests/transcriptions/transcription/expectedResponseBadRequest.json
@@ -0,0 +1 @@
+{"type":"TRANSCRIPTION_124","title":"Invalid transcription id","status":400}
diff --git a/src/main/java/uk/gov/hmcts/darts/authorisation/component/impl/AuthorisationImpl.java b/src/main/java/uk/gov/hmcts/darts/authorisation/component/impl/AuthorisationImpl.java
@@ -4,6 +4,7 @@
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.collections4.CollectionUtils;
+import org.apache.coyote.BadRequestException;
 import org.springframework.stereotype.Component;
 import uk.gov.hmcts.darts.audio.entity.MediaRequestEntity;
 import uk.gov.hmcts.darts.authorisation.api.AuthorisationApi;
@@ -22,6 +23,7 @@
 import uk.gov.hmcts.darts.common.repository.MediaRequestRepository;
 import uk.gov.hmcts.darts.common.repository.TranscriptionRepository;
 import uk.gov.hmcts.darts.common.repository.TransformedMediaRepository;
+import uk.gov.hmcts.darts.util.DataUtil;
 
 import java.util.Collections;
 import java.util.List;
@@ -36,6 +38,7 @@
 import static uk.gov.hmcts.darts.audio.exception.AudioRequestsApiError.TRANSFORMED_MEDIA_NOT_FOUND;
 import static uk.gov.hmcts.darts.cases.exception.CaseApiError.CASE_NOT_FOUND;
 import static uk.gov.hmcts.darts.hearings.exception.HearingApiError.HEARING_NOT_FOUND;
+import static uk.gov.hmcts.darts.transcriptions.exception.TranscriptionApiError.BAD_REQUEST_TRANSCRIPTION_ID;
 import static uk.gov.hmcts.darts.transcriptions.exception.TranscriptionApiError.TRANSCRIPTION_NOT_FOUND;
 
 @Component
@@ -115,6 +118,9 @@ public void authoriseByMediaId(Long mediaId, Set<SecurityRoleEnum> securityRoles
     @SuppressWarnings({"PMD.ExceptionAsFlowControl"})
     public void authoriseByTranscriptionId(Long transcriptionId, Set<SecurityRoleEnum> securityRoles) {
         try {
+            if (!DataUtil.isWithinBounds(transcriptionId, 1L, 9_223_372_036_854_775_807L)) {
+                throw new BadRequestException();
+            }
             final List<CourthouseEntity> courthouses = getCourthousesFromTranscription(transcriptionId);
             if (CollectionUtils.isEmpty(courthouses)) {
                 throw new EntityNotFoundException();
@@ -123,6 +129,9 @@ public void authoriseByTranscriptionId(Long transcriptionId, Set<SecurityRoleEnu
         } catch (EntityNotFoundException ex) {
             log.error("Unable to find Transcription-Courtroom-Courthouse for checkAuthorisation. TranscriptionId={}", transcriptionId, ex);
             throw new DartsApiException(TRANSCRIPTION_NOT_FOUND, ex);
+        } catch (BadRequestException ex) {
+            log.error("TranscriptionId is out of accepted range. TranscriptionId={}", transcriptionId, ex);
+            throw new DartsApiException(BAD_REQUEST_TRANSCRIPTION_ID, ex);
         }
     }
 
diff --git a/src/main/java/uk/gov/hmcts/darts/transcriptions/exception/TranscriptionApiError.java b/src/main/java/uk/gov/hmcts/darts/transcriptions/exception/TranscriptionApiError.java
@@ -133,7 +133,12 @@ public enum TranscriptionApiError implements DartsApiError {
     TOO_MANY_RESULTS(
         TranscriptionsErrorCode.TOO_MANY_RESULTS.getValue(),
         HttpStatus.UNPROCESSABLE_ENTITY,
-        TranscriptionsTitleErrors.TOO_MANY_RESULTS.getValue());
+        TranscriptionsTitleErrors.TOO_MANY_RESULTS.getValue()
+    ),
+    BAD_REQUEST_TRANSCRIPTION_ID(
+        TranscriptionsErrorCode.BAD_REQUEST_TRANSCRIPTION_ID.getValue(),
+        HttpStatus.BAD_REQUEST,
+        TranscriptionsTitleErrors.BAD_REQUEST_TRANSCRIPTION_ID.getValue());
 
 
     private static final String ERROR_TYPE_PREFIX = "TRANSCRIPTION";
diff --git a/src/main/java/uk/gov/hmcts/darts/util/DataUtil.java b/src/main/java/uk/gov/hmcts/darts/util/DataUtil.java
@@ -125,4 +125,15 @@ public static boolean toBoolean(Boolean value) {
     public static boolean toBoolean(Boolean value, boolean defaultValue) {
         return Optional.ofNullable(value).orElse(defaultValue);
     }
+
+    public static boolean isWithinBounds(Long value, Long min, Long max) {
+        if (value == null) {
+            return false;
+        }
+        if (min != null && value < min) {
+            return false;
+        }
+        return max == null || value <= max;
+    }
+
 }
diff --git a/src/main/resources/openapi/transcriptions.yaml b/src/main/resources/openapi/transcriptions.yaml
@@ -396,10 +396,17 @@ paths:
           content:
             application/json+problem:
               schema:
-                $ref: './problem.yaml'
+                allOf:
+                  - $ref: './problem.yaml'
+                  - type: object
+                    required:
+                      - type
+                    properties:
+                      type:
+                        $ref: '#/components/schemas/DownloadTranscript400ErrorCode'
               example:
-                type: "TRANSCRIPTION_109"
-                title: "Failed to download transcript"
+                type: "TRANSCRIPTION_124"
+                title: "Invalid transcription id"
                 status: 400
         '401':
           description: Unauthorised Error
@@ -1482,7 +1489,12 @@ components:
           type: integer
           description: The number of assigned transcript requests for a user with transcriber role.
           example: 3
-
+    DownloadTranscript400ErrorCode:
+      type: string
+      enum:
+        - "TRANSCRIPTION_124"
+      x-enum-varnames:
+        - BAD_REQUEST_TRANSCRIPTION_ID
     UpdateTranscriptions400ErrorCode:
       type: string
       enum:
@@ -1983,8 +1995,9 @@ components:
         - "TRANSCRIPTION_121"
         - "TRANSCRIPTION_122"
         - "TRANSCRIPTION_123"
+        - "TRANSCRIPTION_124"
       x-enum-varnames: [ FAILED_TO_VALIDATE_TRANSCRIPTION_REQUEST, TRANSCRIPTION_NOT_FOUND,  BAD_REQUEST_TRANSCRIPTION_STATUS, BAD_REQUEST_WORKFLOW_COMMENT, BAD_REQUEST_TRANSCRIPTION_TYPE, TRANSCRIPTION_WORKFLOW_ACTION_INVALID, BAD_REQUEST_TRANSCRIPTION_URGENCY, DUPLICATE_TRANSCRIPTION, FAILED_TO_ATTACH_TRANSCRIPT, AUDIO_NOT_FOUND, FAILED_TO_UPDATE_TRANSCRIPTIONS, TRANSCRIPTION_DOCUMENT_NOT_FOUND, TRANSCRIPTION_DOCUMENT_ALREADY_HIDDEN, TRANSCRIPTION_DOCUMENT_HIDE_ACTION_PAYLOAD_INCORRECT_USAGE, TRANSCRIPTION_DOCUMENT_SHOW_ACTION_PAYLOAD_INCORRECT_USAGE, TRANSCRIPTION_DOCUMENT_HIDE_ACTION_REASON_NOT_FOUND,
-                         TRANSCRIPTION_DOCUMENT_DELETE_NOT_SUPPORTED, TRANSCRIPTION_DOCUMENT_DELETION_ALREADY_APPROVED, TRANSCRIPTION_DOCUMENT_DELETION_CAN_NOT_APPROVE_OWN_REQUEST, TOO_MANY_RESULTS, TRANSCRIPTION_DOCUMENT_MARKED_FOR_DELETION_REASON_NOT_FOUND,FAILED_TO_UPLOAD_TRANSCRIPT ]
+                         TRANSCRIPTION_DOCUMENT_DELETE_NOT_SUPPORTED, TRANSCRIPTION_DOCUMENT_DELETION_ALREADY_APPROVED, TRANSCRIPTION_DOCUMENT_DELETION_CAN_NOT_APPROVE_OWN_REQUEST, TOO_MANY_RESULTS, TRANSCRIPTION_DOCUMENT_MARKED_FOR_DELETION_REASON_NOT_FOUND,FAILED_TO_UPLOAD_TRANSCRIPT,  BAD_REQUEST_TRANSCRIPTION_ID]
 
     TranscriptionsTitleErrors:
       type: string
@@ -2012,6 +2025,7 @@ components:
         - "Too many results"
         - "Transcription document marked for deletion reason not found"
         - "Failed to upload transcript"
+        -  "Invalid transcription id"
 
       x-enum-varnames: [ FAILED_TO_VALIDATE_TRANSCRIPTION_REQUEST, TRANSCRIPTION_NOT_FOUND,  BAD_REQUEST_TRANSCRIPTION_STATUS, BAD_REQUEST_WORKFLOW_COMMENT, BAD_REQUEST_TRANSCRIPTION_TYPE, TRANSCRIPTION_WORKFLOW_ACTION_INVALID, BAD_REQUEST_TRANSCRIPTION_URGENCY, DUPLICATE_TRANSCRIPTION, FAILED_TO_ATTACH_TRANSCRIPT, AUDIO_NOT_FOUND, FAILED_TO_UPDATE_TRANSCRIPTIONS, TRANSCRIPTION_DOCUMENT_NOT_FOUND,  TRANSCRIPTION_DOCUMENT_ALREADY_HIDDEN, TRANSCRIPTION_DOCUMENT_HIDE_ACTION_PAYLOAD_INCORRECT_USAGE, TRANSCRIPTION_DOCUMENT_SHOW_ACTION_PAYLOAD_INCORRECT_USAGE,
-                         TRANSCRIPTION_DOCUMENT_HIDE_ACTION_REASON_NOT_FOUND, TRANSCRIPTION_DOCUMENT_HIDE_ACTION_REASON_MARKED_FOR_DELETION, TRANSCRIPTION_DOCUMENT_DELETE_NOT_SUPPORTED, TRANSCRIPTION_DOCUMENT_DELETION_ALREADY_APPROVED, TRANSCRIPTION_DOCUMENT_DELETION_CAN_NOT_APPROVE_OWN_REQUEST, TOO_MANY_RESULTS, TRANSCRIPTION_DOCUMENT_MARKED_FOR_DELETION_REASON_NOT_FOUND,FAILED_TO_UPLOAD_TRANSCRIPT ]
+                         TRANSCRIPTION_DOCUMENT_HIDE_ACTION_REASON_NOT_FOUND, TRANSCRIPTION_DOCUMENT_HIDE_ACTION_REASON_MARKED_FOR_DELETION, TRANSCRIPTION_DOCUMENT_DELETE_NOT_SUPPORTED, TRANSCRIPTION_DOCUMENT_DELETION_ALREADY_APPROVED, TRANSCRIPTION_DOCUMENT_DELETION_CAN_NOT_APPROVE_OWN_REQUEST, TOO_MANY_RESULTS, TRANSCRIPTION_DOCUMENT_MARKED_FOR_DELETION_REASON_NOT_FOUND,FAILED_TO_UPLOAD_TRANSCRIPT , BAD_REQUEST_TRANSCRIPTION_ID]

Original file line number	Diff line number	Diff line change
`@@ -287,11 +287,11 @@ void getTranscriptionNotFoundWhenIsCurrentFalse() throws Exception {`
`287`	`287`	`}`
`288`	`288`
`289`	`289`	`@Test`
`290`		`- void getTranscriptionNotFound() throws Exception {`
	`290`	`+ void getTranscriptionBadRequest() throws Exception {`
`291`	`291`	`MockHttpServletRequestBuilder requestBuilder = get(ENDPOINT_URL_TRANSCRIPTION, -999);`
`292`		`- MvcResult response = mockMvc.perform(requestBuilder).andExpect(status().isNotFound()).andReturn();`
	`292`	`+ MvcResult response = mockMvc.perform(requestBuilder).andExpect(status().isBadRequest()).andReturn();`
`293`	`293`	`String actualResponse = response.getResponse().getContentAsString();`
`294`		`- String expectedResponse = getContentsFromFile("tests/transcriptions/transcription/expectedResponseNotFound.json");`
	`294`	`+ String expectedResponse = getContentsFromFile("tests/transcriptions/transcription/expectedResponseBadRequest.json");`
`295`	`295`	`JSONAssert.assertEquals(expectedResponse, actualResponse, JSONCompareMode.NON_EXTENSIBLE);`
`296`	`296`	`}`
`297`	`297`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"type":"TRANSCRIPTION_124","title":"Invalid transcription id","status":400}`