[NDR-278] Refactor retrieve & search E2E tests (#830)

Author: megan-bower4

.github/workflows/base-e2e-fhir-backendtest.yml

@@ -33,7 +33,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v5
         with:
-          repository: "nhsconnect/national-document-repository"
+          repository: "NHSDigital/national-document-repository"
           ref: ${{ inputs.build_branch }}
 
       - name: AWS Role

lambdas/tests/e2e/api/fhir/test_retrieve_document_fhir_api.py

@@ -1,6 +1,8 @@
 import io
 import uuid
 
+import pytest
+import requests
 from tests.e2e.helpers.pdm_data_helper import PdmDataHelper
 
 from lambdas.tests.e2e.api.fhir.conftest import (
@@ -13,90 +15,93 @@
 pdm_data_helper = PdmDataHelper()
 
 
-def test_small_file(test_data):
-    pdm_record = {}
-    test_data.append(pdm_record)
-
-    pdm_record["id"] = str(uuid.uuid4())
-    pdm_record["nhs_number"] = "9912003071"
-    pdm_record["data"] = io.BytesIO(b"Sample PDF Content")
+def build_pdm_record(nhs_number="9912003071", data=None, doc_status=None, size=None):
+    """Helper to create a PDM record dictionary."""
+    record = {
+        "id": str(uuid.uuid4()),
+        "nhs_number": nhs_number,
+        "data": data or io.BytesIO(b"Sample PDF Content"),
+    }
+    if doc_status:
+        record["doc_status"] = doc_status
+    if size:
+        record["size"] = size
+    return record
 
-    pdm_data_helper.create_metadata(pdm_record)
-    pdm_data_helper.create_resource(pdm_record)
 
-    url = f"https://{MTLS_ENDPOINT}/DocumentReference/{PDM_SNOMED}~{pdm_record['id']}"
+def get_document_reference(record_id):
+    """Helper to perform GET request for DocumentReference."""
+    url = f"https://{MTLS_ENDPOINT}/DocumentReference/{PDM_SNOMED}~{record_id}"
+    print("url:", url)
     headers = {
         "Authorization": "Bearer 123",
         "X-Correlation-Id": "1234",
     }
-    # Use mTLS
     session = create_mtls_session()
-    response = session.get(url, headers=headers)
-    assert response.status_code == 200
+    return session.get(url, headers=headers)
 
 
-def test_large_file(test_data):
-    pdm_record = {}
+@pytest.mark.parametrize("file_size", [None, 10 * 1024 * 1024])
+def test_file_retrieval(test_data, file_size):
+    """Test retrieval for small and large files."""
+    pdm_record = build_pdm_record(
+        data=io.BytesIO(b"A" * file_size) if file_size else None,
+        size=file_size * 1024 if file_size else None,
+    )
     test_data.append(pdm_record)
 
-    pdm_record["id"] = str(uuid.uuid4())
-    pdm_record["nhs_number"] = "9912003071"
-    pdm_record["data"] = io.BytesIO(b"A" * (10 * 1024 * 1024))
-    pdm_record["size"] = 10 * 1024 * 1024 * 1024
-
     pdm_data_helper.create_metadata(pdm_record)
     pdm_data_helper.create_resource(pdm_record)
 
-    url = f"https://{MTLS_ENDPOINT}/DocumentReference/{PDM_SNOMED}~{pdm_record['id']}"
-    headers = {
-        "Authorization": "Bearer 123",
-        "X-Correlation-Id": "1234",
-    }
-
-    # Use mTLS
-    session = create_mtls_session()
-    response = session.get(url, headers=headers)
+    response = get_document_reference(pdm_record["id"])
     assert response.status_code == 200
 
-    json = response.json()
-    expected_presign_uri = f"https://{PDM_S3_BUCKET}.s3.eu-west-2.amazonaws.com/{pdm_record['nhs_number']}/{pdm_record['id']}"
-    assert expected_presign_uri in json["content"][0]["attachment"]["url"]
+    if file_size:
+        json = response.json()
+        expected_presign_uri = (
+            f"https://{PDM_S3_BUCKET}.s3.eu-west-2.amazonaws.com/"
+            f"{pdm_record['nhs_number']}/{pdm_record['id']}"
+        )
+        assert expected_presign_uri in json["content"][0]["attachment"]["url"]
 
 
 def test_no_file_found():
-    pdm_record = {}
-    pdm_record["id"] = str(uuid.uuid4())
-
-    url = f"https://{MTLS_ENDPOINT}/DocumentReference/{PDM_SNOMED}~{pdm_record['id']}"
-    headers = {
-        "Authorization": "Bearer 123",
-        "X-Correlation-Id": "1234",
-    }
-    # Use mTLS
-    session = create_mtls_session()
-    response = session.get(url, headers=headers)
+    """Test retrieval when file does not exist."""
+    pdm_record = build_pdm_record()
+    response = get_document_reference(pdm_record["id"])
     assert response.status_code == 404
 
 
 def test_preliminary_file(test_data):
-    pdm_record = {}
+    """Test retrieval for preliminary document status."""
+    pdm_record = build_pdm_record(doc_status="preliminary")
     test_data.append(pdm_record)
 
-    pdm_record["id"] = str(uuid.uuid4())
-    pdm_record["nhs_number"] = "9912003071"
-    pdm_record["data"] = io.BytesIO(b"Sample PDF Content")
-    pdm_record["doc_status"] = "preliminary"
+    pdm_data_helper.create_metadata(pdm_record)
+    pdm_data_helper.create_resource(pdm_record)
+
+    response = get_document_reference(pdm_record["id"])
+    assert response.status_code == 200
+
+
+# the error is about the auth token not mtls?
+def test_forbidden_without_mtls(test_data):
+    pdm_record = build_pdm_record()
+    test_data.append(pdm_record)
 
     pdm_data_helper.create_metadata(pdm_record)
     pdm_data_helper.create_resource(pdm_record)
 
-    url = f"https://{MTLS_ENDPOINT}/DocumentReference/{PDM_SNOMED}~{pdm_record['id']}"
+    url = (
+        f"https://{MTLS_ENDPOINT}/FhirDocumentReference/{PDM_SNOMED}~{pdm_record['id']}"
+    )
     headers = {
         "Authorization": "Bearer 123",
         "X-Correlation-Id": "1234",
     }
+    response = requests.request("GET", url, headers=headers)
+    print("inital response:", response)
+    json = response.json()
+    print("response:", json)
 
-    # Use mTLS
-    session = create_mtls_session()
-    response = session.get(url, headers=headers)
-    assert response.status_code == 200
+    assert response.status_code == 403

lambdas/tests/e2e/api/fhir/test_search_patient_fhir_api.py

@@ -2,94 +2,77 @@
 import logging
 import uuid
 
+import pytest
+
 from lambdas.tests.e2e.api.fhir.conftest import MTLS_ENDPOINT, create_mtls_session
 from lambdas.tests.e2e.helpers.pdm_data_helper import PdmDataHelper
 
 pdm_data_helper = PdmDataHelper()
 
 
-def test_search_patient_details(test_data):
-    pdm_record = {}
-    test_data.append(pdm_record)
-
-    pdm_record["id"] = str(uuid.uuid4())
-    pdm_record["nhs_number"] = "9912003071"
-    pdm_record["data"] = io.BytesIO(b"Sample PDF Content")
-
-    pdm_data_helper.create_metadata(pdm_record)
-    pdm_data_helper.create_resource(pdm_record)
-
-    url = f"https://{MTLS_ENDPOINT}/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|{pdm_record['nhs_number']}"
-    headers = {
-        "Authorization": "Bearer 123",
-        "X-Correlation-Id": "1234",
+def build_pdm_record(nhs_number="9912003071", data=None, doc_status=None):
+    """Helper to create a PDM record dictionary."""
+    record = {
+        "id": str(uuid.uuid4()),
+        "nhs_number": nhs_number,
+        "data": data or io.BytesIO(b"Sample PDF Content"),
     }
-    # Use mTLS
-    session = create_mtls_session()
-    response = session.get(url, headers=headers)
-    bundle = response.json()
-    logging.info(bundle)
-
-
-def test_multiple_cancelled_search_patient_details(test_data):
-    pdm_record = {}
-    test_data.append(pdm_record)
-
-    pdm_record["id"] = str(uuid.uuid4())
-    pdm_record["nhs_number"] = "9912003071"
-    pdm_record["data"] = io.BytesIO(b"Sample PDF Content")
-    pdm_record["doc_status"] = "cancelled"
-
-    pdm_data_helper.create_metadata(pdm_record)
-    pdm_data_helper.create_resource(pdm_record)
-
-    second_pdm_record = {}
-    test_data.append(second_pdm_record)
-
-    second_pdm_record["id"] = str(uuid.uuid4())
-    second_pdm_record["nhs_number"] = "9912003071"
-    second_pdm_record["data"] = io.BytesIO(b"Sample PDF Content")
-    second_pdm_record["doc_status"] = "cancelled"
+    if doc_status:
+        record["doc_status"] = doc_status
+    return record
 
-    pdm_data_helper.create_metadata(second_pdm_record)
-    pdm_data_helper.create_resource(second_pdm_record)
 
-    url = f"https://{MTLS_ENDPOINT}/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|{pdm_record['nhs_number']}"
+def search_document_reference(nhs_number):
+    """Helper to perform search by NHS number."""
+    url = (
+        f"https://{MTLS_ENDPOINT}/DocumentReference?"
+        f"subject:identifier=https://fhir.nhs.uk/Id/nhs-number|{nhs_number}"
+    )
     headers = {
         "Authorization": "Bearer 123",
         "X-Correlation-Id": "1234",
     }
-    # Use mTLS
     session = create_mtls_session()
-    response = session.get(url, headers=headers)
-    assert response.status_code == 200
+    return session.get(url, headers=headers)
 
 
-def test_no_records():
-    pdm_record = {}
-    pdm_record["nhs_number"] = "9912003071"
+def create_and_store_record(test_data, nhs_number="9912003071", doc_status=None):
+    """Helper to create metadata and resource for a record."""
+    record = build_pdm_record(nhs_number=nhs_number, doc_status=doc_status)
+    test_data.append(record)
+    pdm_data_helper.create_metadata(record)
+    pdm_data_helper.create_resource(record)
+    return record
 
-    url = f"https://{MTLS_ENDPOINT}/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|{pdm_record['nhs_number']}"
-    headers = {
-        "Authorization": "Bearer 123",
-        "X-Correlation-Id": "1234",
-    }
-    # Use mTLS
-    session = create_mtls_session()
-    response = session.get(url, headers=headers)
-    assert response.status_code == 404
 
+def test_search_patient_details(test_data):
+    """Search for a patient with one record."""
+    create_and_store_record(test_data)
+    response = search_document_reference("9912003071")
+    assert response.status_code == 200
+    bundle = response.json()
+    logging.info(bundle)
+    assert "entry" in bundle  # Basic validation
 
-def test_invalid_patient():
-    pdm_record = {}
-    pdm_record["nhs_number"] = "9999999993"
 
-    url = f"https://{MTLS_ENDPOINT}/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|{pdm_record['nhs_number']}"
-    headers = {
-        "Authorization": "Bearer 123",
-        "X-Correlation-Id": "1234",
-    }
-    # Use mTLS
-    session = create_mtls_session()
-    response = session.get(url, headers=headers)
-    assert response.status_code == 400
+def test_multiple_cancelled_search_patient_details(test_data):
+    """Search for a patient with multiple cancelled records."""
+    create_and_store_record(test_data, doc_status="cancelled")
+    create_and_store_record(test_data, doc_status="cancelled")
+    response = search_document_reference("9912003071")
+    assert response.status_code == 200
+    bundle = response.json()
+    assert len(bundle.get("entry", [])) >= 2
+
+
+@pytest.mark.parametrize(
+    "nhs_number,expected_status",
+    [
+        ("9912003071", 404),  # No records
+        ("9999999993", 400),  # Invalid patient
+    ],
+)
+def test_search_edge_cases(nhs_number, expected_status):
+    """Test search for no records and invalid patient."""
+    response = search_document_reference(nhs_number)
+    assert response.status_code == expected_status

lambdas/tests/e2e/helpers/pdm_data_helper.py

@@ -21,13 +21,13 @@ def create_metadata(self, pdm_document_details):
             "Custodian": "H81109",
             "DocStatus": pdm_document_details.get("doc_status", "final"),
             "DocumentScanCreation": "2023-01-01",
+            "DocumentSnomedCodeType": "717391000000106",
             "FileLocation": f"s3://{self.s3_bucket}/{pdm_document_details['nhs_number']}/{pdm_document_details['id']}",
             "FileName": f"1of1_pdm_record_[Holly Lorna MAGAN]_[{pdm_document_details['nhs_number']}]_[29-05-2006].pdf",
             "FileSize": pdm_document_details.get("size", "12345"),
             "LastUpdated": 1743177202,
             "NhsNumber": pdm_document_details["nhs_number"],
             "Status": "current",
-            "DocumentSnomedCode": "717391000000106",
             "Uploaded": True,
             "Uploading": False,
             "Version": "1",

scripts/test/run-e2e-fhir-api-tests.sh

@@ -14,6 +14,12 @@ while [[ "$#" -gt 0 ]]; do
 done
 
 echo "Selected workspace: $WORKSPACE"
+
+if [ "$WORKSPACE" = "prod" ]; then
+    echo "Error: Cannot run E2E tests in production workspace."
+    exit 1
+fi
+
 # Set environment variables
 source ./scripts/test/set-e2e-env-vars.sh $WORKSPACE
 

scripts/test/set-e2e-env-vars.sh

@@ -9,10 +9,17 @@ fi
 
 WORKSPACE="$1"
 
+# Set domain
+if [[ "$WORKSPACE" = "ndr-test" || "$WORKSPACE" = "pre-prod" ]]; then
+    DOMAIN="national-document-repository.nhs.uk"
+else
+    DOMAIN="access-request-fulfilment.patient-deductions.nhs.uk"
+fi
+
 # Set environment variables
 export PDM_METADATA_TABLE="${WORKSPACE}_PDMDocumentMetadata"
 export PDM_S3_BUCKET="${WORKSPACE}-pdm-document-store"
-export MTLS_ENDPOINT="mtls.${WORKSPACE}.access-request-fulfilment.patient-deductions.nhs.uk"
+export MTLS_ENDPOINT="mtls.${WORKSPACE}.${DOMAIN}"
 
 # Ensure Client certificates in place
 if ! make download-api-certs WORKSPACE="${WORKSPACE}"