Merge pull request #428 from NHSDigital/release/2024-11-27

Release/2024 11 27

Author: megan-bower4

.github/workflows/pull-requests.yml

@@ -201,7 +201,7 @@ jobs:
         with:
           ref: ${{ env.BRANCH_NAME }}
       - run: |
-          poetry add pytest-nhsd-apim
+          poetry add pytest-nhsd-apim==3.4.3
       - uses: ./.github/actions/make/
         with:
           command: apigee--attach-product DEV_BUILD="true"
@@ -290,7 +290,7 @@ jobs:
         with:
           ref: ${{ env.BRANCH_NAME }}
       - run: |
-          poetry add pytest-nhsd-apim
+          poetry add pytest-nhsd-apim==3.4.3
       - uses: ./.github/actions/make/
         with:
           command: apigee--detach-product DEV_BUILD="true"

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 2024-11-27
+- [PI-605] Bulk ETL (transform layer)
+- [PI-582] Read MHS Device
+
 ## 2024-11-25
 - [PI-643] Add status to Device Reference Data
 - Dependabot: slack-github-action, pydantic

VERSION

@@ -1 +1 @@
-2024.11.25
+2024.11.27

changelog/2024-11-27.md

@@ -0,0 +1,2 @@
+- [PI-605] Bulk ETL (transform layer)
+- [PI-582] Read MHS Device

infrastructure/terraform/per_workspace/vars.tf

@@ -40,7 +40,8 @@ variable "api_lambda_layers" {
   default = [
     "domain",
     "event",
-    "api_utils"
+    "api_utils",
+    "sds"
   ]
 }
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "connecting-party-manager"
-version = "2024.11.25"
+version = "2024.11.27"
 description = "Repository for the Connecting Party Manager API and related services"
 authors = ["NHS England"]
 license = "LICENSE.md"

src/api/createDeviceMessageHandlingSystem/src/v1/steps.py

@@ -9,7 +9,6 @@
 )
 from domain.core.cpm_product import CpmProduct
 from domain.core.device import (
-    MHS_DEVICE_NAME,
     Device,
     DeviceKeyAddedEvent,
     DeviceReferenceDataIdAddedEvent,
@@ -31,6 +30,7 @@
 )
 from domain.request_models import CpmProductPathParams, CreateMhsDeviceIncomingParams
 from domain.response.validation_errors import mark_validation_errors_as_inbound
+from sds.epr.constants import EprNameTemplate, SdsDeviceReferenceDataPath, SdsFieldName
 
 
 @mark_validation_errors_as_inbound
@@ -42,13 +42,17 @@ def parse_mhs_device_payload(data, cache) -> CreateMhsDeviceIncomingParams:
 def check_for_existing_mhs(data, cache):
     product_team: ProductTeam = data[read_product_team]
     product: CpmProduct = data[read_product]
+    party_key: str = data[get_party_key]
 
     device_repo = DeviceRepository(
         table_name=cache["DYNAMODB_TABLE"], dynamodb_client=cache["DYNAMODB_CLIENT"]
     )
 
     devices = device_repo.search(product_team_id=product_team.id, product_id=product.id)
-    if any(device.name == MHS_DEVICE_NAME for device in devices):
+    if any(
+        device.name == EprNameTemplate.MHS_DEVICE.format(party_key=party_key)
+        for device in devices
+    ):
         raise ConfigurationError(
             "There is already an existing MHS Device for this Product"
         )
@@ -65,12 +69,11 @@ def read_device_reference_data(data, cache) -> DeviceReferenceData:
     )
 
     party_key: str = data[get_party_key]
-    # use {QuestionnaireInstance.SPINE_MHS_MESSAGE_SETS}
-    mhs_message_set_drd_name = f"{party_key} - MHS Message Set"
-
     try:
         (device_reference_data,) = filter(
-            lambda drd: drd.name == mhs_message_set_drd_name, device_reference_datas
+            lambda drd: drd.name
+            == EprNameTemplate.MESSAGE_SETS.format(party_key=party_key),
+            device_reference_datas,
         )
     except ValueError:
         raise ConfigurationError(
@@ -98,11 +101,14 @@ def validate_spine_mhs_questionnaire_response(data, cache) -> QuestionnaireRespo
 
 def create_mhs_device(data, cache) -> Device:
     product: CpmProduct = data[read_product]
+    party_key: str = data[get_party_key]
     payload: CreateMhsDeviceIncomingParams = data[parse_mhs_device_payload]
 
     # Create a new Device dictionary excluding 'questionnaire_responses'
     device_payload = payload.dict(exclude={"questionnaire_responses"})
-    return product.create_device(**device_payload)
+    return product.create_device(
+        name=EprNameTemplate.MHS_DEVICE.format(party_key=party_key), **device_payload
+    )
 
 
 def create_party_key_tag(data, cache) -> DeviceTagAddedEvent:
@@ -114,20 +120,18 @@ def create_cpa_id_keys(data, cache) -> DeviceKeyAddedEvent:
     mhs_device: Device = data[create_mhs_device]
     party_key = data[get_party_key]
     drd: DeviceReferenceData = data[read_device_reference_data]
-    interaction_ids = []
 
-    # Extract Interaction IDs from questionnaire responses
     questionnaire_responses = drd.questionnaire_responses.get(
         f"{QuestionnaireInstance.SPINE_MHS_MESSAGE_SETS}/1", []
     )
-    for response in questionnaire_responses:
-        interaction_ids.append(response.data.get("Interaction ID"))
 
-    # Use cpa_id in furture
+    interaction_ids = [
+        response.data.get(SdsFieldName.INTERACTION_ID)
+        for response in questionnaire_responses
+    ]
+
     for id in interaction_ids:
-        mhs_device.add_key(
-            key_type=DeviceKeyType.INTERACTION_ID, key_value=f"{party_key}:{id}"
-        )
+        mhs_device.add_key(key_type=DeviceKeyType.CPA_ID, key_value=f"{party_key}:{id}")
 
     return mhs_device
 
@@ -136,7 +140,8 @@ def add_device_reference_data_id(data, cache) -> DeviceReferenceDataIdAddedEvent
     mhs_device: Device = data[create_mhs_device]
     drd: DeviceReferenceData = data[read_device_reference_data]
     return mhs_device.add_device_reference_data_id(
-        device_reference_data_id=str(drd.id), path_to_data=["*"]
+        device_reference_data_id=str(drd.id),
+        path_to_data=[SdsDeviceReferenceDataPath.ALL],
     )
 
 

src/api/createDeviceMessageHandlingSystem/tests/test_index.py

@@ -23,12 +23,13 @@
     QuestionnaireRepository,
 )
 from event.json import json_loads
+from sds.epr.constants import MHS_DEVICE_SUFFIX, EprNameTemplate
 
 from test_helpers.dynamodb import mock_table
 from test_helpers.uuid import consistent_uuid
 
 TABLE_NAME = "hiya"
-DEVICE_NAME = "Product-MHS"
+DEVICE_NAME = "ABC1234-987654 - Message Handling System"
 ODS_CODE = "AAA"
 PRODUCT_ID = ProductId.create()
 PRODUCT_TEAM_NAME = "My Product Team"
@@ -52,6 +53,7 @@
     "MHS Is Authenticated": "PERSISTENT",
     "Product Key": "product-key-001",
     "Requestor URP": "requestor-789",
+    "MHS Manufacturer Organisation": "AAA",
 }
 
 
@@ -81,7 +83,7 @@ def mock_epr_product_with_message_set_drd() -> (
         )
         product_repo.write(entity=product)
 
-        # set up questionnaire response
+        # set up questionnaire responses
         mhs_message_set_questionnaire = QuestionnaireRepository().read(
             QuestionnaireInstance.SPINE_MHS_MESSAGE_SETS
         )
@@ -92,7 +94,6 @@ def mock_epr_product_with_message_set_drd() -> (
                 "MHS IN": "baz",
             }
         )
-
         questionnaire_response_2 = mhs_message_set_questionnaire.validate(
             data={
                 "Interaction ID": "urn:foo2",
@@ -103,7 +104,7 @@ def mock_epr_product_with_message_set_drd() -> (
 
         # Set up DeviceReferenceData in DB
         device_reference_data = product.create_device_reference_data(
-            name="ABC1234-987654 - MHS Message Set"
+            name=EprNameTemplate.MESSAGE_SETS.format(party_key="ABC1234-987654")
         )
         device_reference_data.add_questionnaire_response(questionnaire_response)
         device_reference_data.add_questionnaire_response(questionnaire_response_2)
@@ -205,7 +206,7 @@ def test_index() -> None:
         device = Device(**_device)
         assert device.product_team_id == product.product_team_id
         assert device.product_id == product.id
-        assert device.name == DEVICE_NAME
+        assert device.name.endswith(MHS_DEVICE_SUFFIX)
         assert device.ods_code == ODS_CODE
         assert device.created_on.date() == datetime.today().date()
         assert device.updated_on.date() == datetime.today().date()
@@ -302,7 +303,7 @@ def test_incoming_errors(body, path_parameters, error_code, status_code):
                 }
             },
             "MISSING_VALUE",
-            "Failed to validate data against 'spine_mhs/1': 'Unique Identifier' is a required property",
+            "Failed to validate data against 'spine_mhs/1': 'MHS Manufacturer Organisation' is a required property",
             400,
         ),
     ],
@@ -375,4 +376,42 @@ def test_no_existing_message_set_drd():
         assert expected_message_code in response["body"]
 
 
-# add test for already existing mhs device?
+def test_mhs_already_exists() -> None:
+    with mock_epr_product_with_message_set_drd() as (index, product):
+        # Execute the lambda
+        response = index.handler(
+            event={
+                "headers": {"version": VERSION},
+                "body": json.dumps(
+                    {"questionnaire_responses": {"spine_mhs": [QUESTIONNAIRE_DATA]}}
+                ),
+                "pathParameters": {
+                    "product_team_id": str(product.product_team_id),
+                    "product_id": str(product.id),
+                },
+            }
+        )
+
+        assert response["statusCode"] == 201
+
+        # Execute the lambda again
+        response = index.handler(
+            event={
+                "headers": {"version": VERSION},
+                "body": json.dumps(
+                    {"questionnaire_responses": {"spine_mhs": [QUESTIONNAIRE_DATA]}}
+                ),
+                "pathParameters": {
+                    "product_team_id": str(product.product_team_id),
+                    "product_id": str(product.id),
+                },
+            }
+        )
+
+        assert response["statusCode"] == 400
+        expected_error_code = "VALIDATION_ERROR"
+        expected_message_code = (
+            "There is already an existing MHS Device for this Product"
+        )
+        assert expected_error_code in response["body"]
+        assert expected_message_code in response["body"]

src/api/createDeviceReferenceDataASActions/src/v1/steps.py

@@ -21,8 +21,7 @@
 )
 from domain.request_models import CreateDeviceReferenceAdditionalInteractionsDataParams
 from domain.response.validation_errors import mark_validation_errors_as_inbound
-
-DEVICE_NAME_MARKER = "AS Additional Interactions"
+from sds.epr.constants import ADDITIONAL_INTERACTIONS_SUFFIX, EprNameTemplate
 
 
 @mark_validation_errors_as_inbound
@@ -60,7 +59,7 @@ def require_no_existing_additional_interactions_device_reference_data(
         product_team_id=product.product_team_id, product_id=product.id
     )
     if any(
-        device_reference_data.name.endswith(DEVICE_NAME_MARKER)
+        device_reference_data.name.endswith(ADDITIONAL_INTERACTIONS_SUFFIX)
         for device_reference_data in results
     ):
         raise AlreadyExistsError(
@@ -91,7 +90,7 @@ def create_additional_interactions_device_reference_data(
     product: CpmProduct = data[read_product]
     party_key: str = data[get_party_key]
     return product.create_device_reference_data(
-        name=f"{party_key} - {DEVICE_NAME_MARKER}"
+        name=EprNameTemplate.ADDITIONAL_INTERACTIONS.format(party_key=party_key)
     )
 
 

src/api/createDeviceReferenceDataMessageSet/src/v1/steps.py

@@ -20,8 +20,7 @@
 )
 from domain.request_models import CreateDeviceReferenceMessageSetsDataParams
 from domain.response.validation_errors import mark_validation_errors_as_inbound
-
-DEVICE_NAME_MARKER = "MHS Message Set"
+from sds.epr.constants import MESSAGE_SETS_SUFFIX, EprNameTemplate
 
 
 @mark_validation_errors_as_inbound
@@ -43,11 +42,11 @@ def require_no_existing_message_sets_device_reference_data(
         product_team_id=product.product_team_id, product_id=product.id
     )
     if any(
-        device_reference_data.name.endswith(DEVICE_NAME_MARKER)
+        device_reference_data.name.endswith(MESSAGE_SETS_SUFFIX)
         for device_reference_data in results
     ):
         raise AlreadyExistsError(
-            "This product already has a 'Message Set' DeviceReferenceData. "
+            "This product already has a 'Message Sets' DeviceReferenceData. "
             "Please update, or delete and recreate if you wish to make changes."
         )
 
@@ -71,7 +70,7 @@ def create_message_set_device_reference_data(data, cache) -> DeviceReferenceData
     product: CpmProduct = data[read_product]
     party_key: str = data[get_party_key]
     return product.create_device_reference_data(
-        name=f"{party_key} - {DEVICE_NAME_MARKER}"
+        name=EprNameTemplate.MESSAGE_SETS.format(party_key=party_key)
     )