Merge pull request #1939 from NHSDigital/feature/ERSSUP-81596-81565

Feature/erssup 81596 81565

Author: nhsd-angel-pastor

sandbox/src/routes/stu3/services/mockResponseProvider.js

@@ -166,19 +166,24 @@ module.exports = {
 
   getExampleResponseForRetrieveAttachment: function (request) {
 
-    const attachmentId = request.params.attachmentLogicalID
+    const attachmentId = request.params.attachmentLogicalID;
 
     if (attachmentId) {
 
       if (attachmentId.startsWith('att-')) {
-        return { responsePath: 'stu3/retrieveAttachment/responses/example_attachment.pdf', filename: 'example_attachment.pdf', responseCode: 200 }
+        return { responsePath: 'stu3/retrieveAttachment/responses/example_attachment.pdf', filename: 'example_attachment.pdf', responseCode: 200 };
       }
 
-      if (attachmentId === 'c5d2d200-7613-4a69-9c5f-1bb68e04b8d8') {
-        return { responsePath: 'stu3/retrieveAttachment/responses/example_attachment.pdf', filename: 'example_attachment.pdf', responseCode: 200 }
+      if (this.isvalidUuid(attachmentId)) {
+        return { responsePath: 'stu3/retrieveAttachment/responses/example_attachment.pdf', filename: 'example_attachment.pdf', responseCode: 200 };
       }
     }
 
+    return {};
+  },
+
+  isvalidUuid: function(string) {
+    return /^[0-9A-F]{8}-[0-9A-F]{4}-[4][0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$/i.test(string);
   },
 
   getExampleResponseForRetrieveReferralRequest: function (request) {

specification/components/stu3/schemas/endpoints/a006-retrieve-attachment.yaml

@@ -65,6 +65,14 @@ description: |
   ## Related endpoints
   
   You can retrieve a clinical information summary for a referral using [[HYPERLINK_A007]].
+  
+  ## Sandbox test scenarios
+  
+  The sandbox for this endpoint is a simple implementation that only supports success cases.
+  
+  A successful response will always be returned, provided the Binary ID is in a valid format. The Availability Status of a file is not considered in the sandbox and a file will always be available for retrieval.
+  
+  Successful responses will always return the same example PDF file.
 
 summary: Retrieve attachment (A006, FHIR STU3) [deprecated]
 operationId: a006-retrieve-attachment

specification/components/stu3/schemas/endpoints/a044-create-advice-and-guidance-request.yaml

@@ -20,7 +20,7 @@ description: |
   In order to retrieve an attachment using the [[HYPERLINK_A042]] (or deprecated [[HYPERLINK_A006]]) endpoint, the attachment must be available for download. 
   The availability status of attachments associated with a referral are returned via this endpoint as a eRS-AvailabilityStatus-1 code. 
   
-  Further details on attachment availability status and eRS-AvailabilityStatus-1 codes can be found in the [[HYPERLINK_A005]] and [[HYPERLINK_A042]] specifications.
+  Further details on attachment availability status and eRS-AvailabilityStatus-1 codes can be found in the [[HYPERLINK_A024]], [[HYPERLINK_A025]] and [[HYPERLINK_A042]] specifications.
 
   ## Pre-requisites
   To use this endpoint, you must be an authenticated e-RS user and use one of the following e-RS roles:

tests/sandbox/stu3/test_a006_get_attachment.py

@@ -22,14 +22,15 @@ class TestGetAttachment(SandboxTest):
         required_business_functions=allowed_business_function_data
     )
 
-    testdata = [
+    valid_test_data = [
         (
             "att-70000-70001",
             "stu3/retrieveAttachment/responses/example_attachment.pdf",
             "example_attachment.pdf",
         ),
         (
-            "c5d2d200-7613-4a69-9c5f-1bb68e04b8d8",
+            # Any arbitrary v4 UUID should work here
+            "f1b1b2b1-30db-48f9-8906-8b703adca5fb",
             "stu3/retrieveAttachment/responses/example_attachment.pdf",
             "example_attachment.pdf",
         ),
@@ -63,7 +64,7 @@ def call_endpoint(
         )
 
     @pytest.mark.parametrize("actor", authorised_actor_data)
-    @pytest.mark.parametrize("id,response, filename", testdata)
+    @pytest.mark.parametrize("id,response, filename", valid_test_data)
     def test_success(
         self,
         call_endpoint_url_with_pathParams: Callable[
@@ -90,3 +91,16 @@ def test_success(
                 "content-length": str(len(expected_response)),
             },
         )
+
+    @pytest.mark.parametrize("actor", authorised_actor_data)
+    def test_failure_not_a_uuid(
+        self,
+        call_endpoint_url_with_pathParams: Callable[
+            [Actor, Dict[str, str], Dict[str, str]], Response
+        ],
+        actor: Actor,
+    ):
+        response = call_endpoint_url_with_pathParams(
+            actor, {"attachmentLogicalID": "f1bb2b1-30db-48f9-8906-8b703adca5fb"}
+        )
+        asserts.assert_status_code(404, response.status_code)