[PRMP-908] Refactor MNS document review logic and handling

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

@@ -78,6 +78,7 @@ jobs:
         run: |
           AWS_WORKSPACE="${SANDBOX}"
           API_URL="api-${SANDBOX}.access-request-fulfilment.patient-deductions.nhs.uk"
+          AWS_DEFAULT_REGION=${{ vars.AWS_REGION }}
           echo "NDR_API_ENDPOINT=$API_URL" >> $GITHUB_ENV
           echo "AWS_WORKSPACE=$AWS_WORKSPACE" >> $GITHUB_ENV
         env:

.github/workflows/base-e2e-mns.yml

@@ -0,0 +1,78 @@
+name: "Z-BASE E2e Test: MNS E2E Tests"
+
+on:
+  workflow_call:
+    inputs:
+      build_branch:
+        description: "Branch with e2e tests."
+        required: true
+        type: "string"
+      environment:
+        description: "Which Environment type are we using"
+        required: true
+        type: "string"
+      sandbox:
+        description: "Sandbox to run the smoke tests on."
+        required: true
+        type: "string"
+    secrets:
+      AWS_ASSUME_ROLE:
+        required: true
+
+permissions:
+  pull-requests: write
+  id-token: write
+  contents: read
+
+jobs:
+  mns-e2e-test:
+    runs-on: ubuntu-latest
+    environment: ${{ inputs.environment }}
+    strategy:
+      matrix:
+        test-file:
+          - test_mns_process.py
+          - test_mns_death.py
+      fail-fast: false
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+        with:
+          repository: "NHSDigital/national-document-repository"
+          ref: ${{ inputs.build_branch }}
+
+      - name: AWS Role
+        uses: aws-actions/configure-aws-credentials@v5
+        with:
+          role-to-assume: ${{ secrets.AWS_ASSUME_ROLE }}
+          role-skip-session-tagging: true
+          mask-aws-account-id: true
+          aws-region: ${{ vars.AWS_REGION }}
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v6
+        with:
+          python-version: 3.11
+
+      - name: Make virtual environment
+        run: |
+          make env
+
+      - name: Start virtual environment
+        run: |
+          source ./lambdas/venv/bin/activate
+          echo PATH=$PATH >> $GITHUB_ENV
+
+
+      - name: Set E2e Test Variables
+        run: |
+          AWS_WORKSPACE="${SANDBOX}"
+          AWS_DEFAULT_REGION=${{ vars.AWS_REGION }}
+          echo "AWS_WORKSPACE=$AWS_WORKSPACE" >> $GITHUB_ENV
+          echo "AWS_DEFAULT_REGION=$AWS_DEFAULT_REGION" >> $GITHUB_ENV
+        env:
+          SANDBOX: ${{ inputs.sandbox }}
+
+      - name: Run MNS E2E Test - ${{ matrix.test-file }}
+        run: |
+          cd ./lambdas && ./venv/bin/python3 -m pytest tests/e2e/mns/${{ matrix.test-file }} -vv

.github/workflows/lambdas-deploy-feature-to-sandbox.yml

@@ -117,3 +117,13 @@ jobs:
       sandbox: ${{ inputs.sandbox }}
     secrets:
       AWS_ASSUME_ROLE: ${{ secrets.AWS_ASSUME_ROLE }}
+
+  run_mns_e2etest:
+    uses: ./.github/workflows/base-e2e-mns.yml
+    needs: ["deploy_all_lambdas", "disable_fhir_stub"]
+    with:
+      build_branch: ${{ inputs.build_branch }}
+      environment: development
+      sandbox: ${{ inputs.sandbox }}
+    secrets:
+      AWS_ASSUME_ROLE: ${{ secrets.AWS_ASSUME_ROLE }}

.github/workflows/ndr-e2e-test-sandbox.yml

@@ -40,4 +40,13 @@ jobs:
       environment: ${{ inputs.environment }}
       sandbox: ${{ inputs.sandbox }}
     secrets:
-      AWS_ASSUME_ROLE: ${{ secrets.AWS_ASSUME_ROLE }}
+      AWS_ASSUME_ROLE: ${{ secrets.AWS_ASSUME_ROLE }}
+
+  services-mns-e2etest:
+    uses: ./.github/workflows/base-e2e-mns.yml
+    with:
+      build_branch: ${{ inputs.build_branch }}
+      environment: ${{ inputs.environment }}
+      sandbox: ${{ inputs.sandbox }}
+    secrets:
+      AWS_ASSUME_ROLE: ${{ secrets.AWS_ASSUME_ROLE }}

lambdas/enums/lambda_error.py

@@ -1,15 +1,20 @@
-from enum import Enum
+from enum import Enum, StrEnum
 from typing import Optional
 
 from enums.fhir.fhir_issue_type import FhirIssueCoding, UKCoreSpineError
 from utils.error_response import ErrorResponse
 from utils.request_context import request_context
 
-
-class LambdaError(Enum):
+class ErrorMessage(StrEnum):
     MISSING_POST = "Missing POST request body"
     MISSING_KEY = "An error occurred due to missing key"
     RETRIEVE_DOCUMENTS = "Unable to retrieve documents for patient"
+    FAILED_TO_QUERY_DYNAMO = "Failed to query DynamoDB"
+    FAILED_TO_VALIDATE = "Failed to validate data"
+    FAILED_TO_UPDATE_DYNAMO = "Failed to update DynamoDB"
+    FAILED_TO_CREATE_TRANSACTION = "Failed to create transaction"
+
+class LambdaError(Enum):
 
     def create_error_response(
         self, params: Optional[dict] = None, **kwargs
@@ -235,15 +240,15 @@ def create_error_body(self, params: Optional[dict] = None, **kwargs) -> str:
     }
     ManifestMissingBody = {
         "err_code": "DMS_4002",
-        "message": MISSING_POST,
+        "message": ErrorMessage.MISSING_POST,
     }
     ManifestFilterDocumentReferences = {
         "err_code": "DMS_4003",
         "message": "Selected document references do not match any documents stored for this patient",
     }
     ManifestMissingJobId = {
         "err_code": "DMS_4004",
-        "message": MISSING_KEY,
+        "message": ErrorMessage.MISSING_KEY,
     }
     ManifestMissingJob = {
         "err_code": "DMS_4005",
@@ -267,19 +272,19 @@ def create_error_body(self, params: Optional[dict] = None, **kwargs) -> str:
     }
     StitchNoService = {
         "err_code": "LGS_5001",
-        "message": RETRIEVE_DOCUMENTS,
+        "message": ErrorMessage.RETRIEVE_DOCUMENTS,
     }
     StitchClient = {
         "err_code": "LGS_5002",
         "message": "Unable to return stitched pdf file due to internal error",
     }
     StitchDB = {
         "err_code": "LGS_5003",
-        "message": RETRIEVE_DOCUMENTS,
+        "message": ErrorMessage.RETRIEVE_DOCUMENTS,
     }
     StitchValidation = {
         "err_code": "LGS_5004",
-        "message": RETRIEVE_DOCUMENTS,
+        "message": ErrorMessage.RETRIEVE_DOCUMENTS,
     }
     StitchCloudFront = {
         "err_code": "LGS_5005",
@@ -320,7 +325,7 @@ def create_error_body(self, params: Optional[dict] = None, **kwargs) -> str:
     """
     FeedbackMissingBody = {
         "err_code": "SFB_4001",
-        "message": MISSING_POST,
+        "message": ErrorMessage.MISSING_POST,
     }
 
     FeedbackInvalidBody = {
@@ -603,7 +608,7 @@ def create_error_body(self, params: Optional[dict] = None, **kwargs) -> str:
     }
     DocTypeKey = {
         "err_code": "VDT_4003",
-        "message": MISSING_KEY,
+        "message": ErrorMessage.MISSING_KEY,
     }
     PatientIdInvalid = {
         "err_code": "PN_4001",
@@ -612,7 +617,7 @@ def create_error_body(self, params: Optional[dict] = None, **kwargs) -> str:
     }
     PatientIdNoKey = {
         "err_code": "PN_4002",
-        "message": MISSING_KEY,
+        "message": ErrorMessage.MISSING_KEY,
         "fhir_coding": UKCoreSpineError.MISSING_VALUE,
     }
     PatientIdMismatch = {
@@ -662,7 +667,7 @@ def create_error_body(self, params: Optional[dict] = None, **kwargs) -> str:
     """
     DocumentReviewDB = {
         "err_code": "UDR_5001",
-        "message": RETRIEVE_DOCUMENTS,
+        "message": ErrorMessage.RETRIEVE_DOCUMENTS,
     }
 
     DocumentReviewValidation = {

lambdas/services/document_service.py

@@ -109,7 +109,7 @@ def fetch_documents_from_table(
     def get_item(
         self,
         document_id: str,
-        sort_key: dict = None,
+        sort_key: dict | None = None,
         table_name: str = None,
         model_class: type[BaseModel] = None,
     ) -> Optional[BaseModel]:
@@ -218,7 +218,7 @@ def update_document(
         update_fields_name: set[str] | None = None,
         condition_expression: str | Attr | ConditionBase = None,
         expression_attribute_values: dict = None,
-        key_pair: dict | None = None
+        key_pair: dict | None = None,
     ):
         """Update document in specified or configured table."""
         table_name = table_name or self.table_name
@@ -228,13 +228,9 @@ def update_document(
             "updated_fields": document.model_dump(
                 exclude_none=True, by_alias=True, include=update_fields_name
             ),
+            "key_pair": key_pair
+            or {DocumentReferenceMetadataFields.ID.value: document.id},
         }
-        if key_pair:
-            update_kwargs["key_pair"] = key_pair
-        else:
-            update_kwargs["key_pair"] = {
-                DocumentReferenceMetadataFields.ID.value: document.id
-            }
 
         if condition_expression:
             update_kwargs["condition_expression"] = condition_expression