Merge pull request #475 from NHSDigital/release/2025-01-22

megan-bower4 · web-flow · commit d755dab8fc10 · 2025-01-24T10:05:41.000Z
Release/2025 01 22
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 # Changelog
 
+## 2025-01-22
+- [PI-693] Changelog ETL - modify / remove from an AS
+
 ## 2025-01-17
 - [PI-730] Accredited System base model is outdated
 - [PI-704] Refactor searchSdsDevice to use new domain structure
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-2025.01.17
+2025.01.22
diff --git a/changelog/2025-01-22.md b/changelog/2025-01-22.md
@@ -0,0 +1 @@
+- [PI-693] Changelog ETL - modify / remove from an AS
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "connecting-party-manager"
-version = "2025.01.17"
+version = "2025.01.22"
 description = "Repository for the Connecting Party Manager API and related services"
 authors = ["NHS England"]
 license = "LICENSE.md"
diff --git a/src/etl/sds/tests/changelog/changelog_components/modify/accredited_system/delete/description.ldif b/src/etl/sds/tests/changelog/changelog_components/modify/accredited_system/delete/description.ldif
@@ -0,0 +1 @@
+delete: description
diff --git a/src/etl/sds/tests/changelog/changelog_components/modify/accredited_system/delete/nhs_approver_urp.ldif b/src/etl/sds/tests/changelog/changelog_components/modify/accredited_system/delete/nhs_approver_urp.ldif
diff --git a/src/etl/sds/tests/changelog/changelog_components/modify/accredited_system/delete/nhs_as_client.ldif b/src/etl/sds/tests/changelog/changelog_components/modify/accredited_system/delete/nhs_as_client.ldif
diff --git a/src/etl/sds/tests/changelog/changelog_components/modify/accredited_system/delete/nhs_as_svc_ia.ldif b/src/etl/sds/tests/changelog/changelog_components/modify/accredited_system/delete/nhs_as_svc_ia.ldif
diff --git a/src/etl/sds/tests/changelog/changelog_components/modify/accredited_system/delete/nhs_product_name.ldif b/src/etl/sds/tests/changelog/changelog_components/modify/accredited_system/delete/nhs_product_name.ldif
diff --git a/src/etl/sds/tests/changelog/scenarios/accredited_system/delete_from_as__device/__init__.py b/src/etl/sds/tests/changelog/scenarios/accredited_system/delete_from_as__device/__init__.py
@@ -0,0 +1,15 @@
+from etl.sds.tests.changelog.utils import (
+    ADD_ACCREDITED_SYSTEM,
+    MODIFY_ACCREDITED_SYSTEM_ADD_TO_DEVICE_FIELD_NOT_LIST,
+    MODIFY_ACCREDITED_SYSTEM_DELETE_DEVICE_FIELD,
+    _Scenario,
+)
+
+SCENARIO = _Scenario(
+    file_path=__file__,
+    extract_input=[
+        ADD_ACCREDITED_SYSTEM,
+        MODIFY_ACCREDITED_SYSTEM_ADD_TO_DEVICE_FIELD_NOT_LIST,
+        MODIFY_ACCREDITED_SYSTEM_DELETE_DEVICE_FIELD,
+    ],
+)
diff --git a/src/etl/sds/tests/changelog/scenarios/accredited_system/delete_from_as__device/extract_output.json b/src/etl/sds/tests/changelog/scenarios/accredited_system/delete_from_as__device/extract_output.json
@@ -0,0 +1,35 @@
+[
+  {
+    "change_type": "add",
+    "nhs_approver_urp": "uniqueIdentifier=102583034545,uniqueIdentifier=352307522545,uid=432776896545,ou=People,o=nhs",
+    "nhs_as_svc_ia": ["urn:nhs:names:services:pdsquery:QUQI_IN010000UK14"],
+    "nhs_date_approved": "20091016133823",
+    "nhs_date_requested": "20091016133757",
+    "nhs_as_client": ["C3O9X"],
+    "nhs_id_code": "C3O9X",
+    "nhs_mhs_manufacturer_org": "C3O9X",
+    "nhs_mhs_party_key": "C3O9X-806782",
+    "nhs_product_key": "6216",
+    "nhs_product_name": "TPP SystmOne",
+    "nhs_product_version": null,
+    "nhs_requestor_urp": "uniqueIdentifier=203171972540,uniqueIdentifier=352307522545,uid=432776896545,ou=People,o=nhs",
+    "nhs_temp_uid": "10312",
+    "object_class": "nhsAs",
+    "unique_identifier": "000000000001",
+    "nhs_as_acf": null,
+    "nhs_as_category_bag": null,
+    "description": null
+  },
+  {
+    "change_type": "modify",
+    "object_class": "modify",
+    "modifications": [["add", "description", ["description..."]]],
+    "unique_identifier": "000000000001"
+  },
+  {
+    "change_type": "modify",
+    "object_class": "modify",
+    "modifications": [["delete", "description", []]],
+    "unique_identifier": "000000000001"
+  }
+]
diff --git a/src/etl/sds/tests/changelog/scenarios/accredited_system/delete_from_as__device/load_output.json b/src/etl/sds/tests/changelog/scenarios/accredited_system/delete_from_as__device/load_output.json
@@ -0,0 +1,129 @@
+[
+  {
+    "id": "C3O9X.fe49c1d5-d9bc-4c2e-8e8d-54d8e2e88250",
+    "name": "C3O9X (EPR)",
+    "ods_code": "C3O9X",
+    "status": "active",
+    "created_on": "2024-12-11T11:18:53.365591+00:00",
+    "updated_on": null,
+    "deleted_on": null,
+    "keys": [
+      {
+        "key_type": "epr_id",
+        "key_value": "EPR-C3O9X"
+      }
+    ]
+  },
+  {
+    "id": "P.9AN-PJG",
+    "product_team_id": "C3O9X.fe49c1d5-d9bc-4c2e-8e8d-54d8e2e88250",
+    "name": "TPP SystmOne",
+    "ods_code": "C3O9X",
+    "status": "active",
+    "created_on": "2024-12-11T11:18:53.407960+00:00",
+    "updated_on": "2024-12-11T11:18:53.408432+00:00",
+    "deleted_on": null,
+    "keys": [
+      {
+        "key_type": "party_key",
+        "key_value": "C3O9X-806782"
+      }
+    ]
+  },
+  {
+    "id": "fe15bd58-6897-4566-9a87-aab781fd96b5",
+    "name": "C3O9X-806782/000000000001 - Accredited System",
+    "status": "active",
+    "product_id": "P.9AN-PJG",
+    "product_team_id": "C3O9X.fe49c1d5-d9bc-4c2e-8e8d-54d8e2e88250",
+    "ods_code": "C3O9X",
+    "environment": "prod",
+    "created_on": "2024-12-11T11:18:53.532840+00:00",
+    "updated_on": "2024-12-11T11:18:53.534066+00:00",
+    "deleted_on": null,
+    "keys": [
+      {
+        "key_type": "accredited_system_id",
+        "key_value": "000000000001"
+      }
+    ],
+    "tags": [
+      {
+        "nhs_id_code": "C3O9X",
+        "nhs_as_svc_ia": "urn:nhs:names:services:pdsquery:QUQI_IN010000UK14"
+      },
+      {
+        "nhs_id_code": "C3O9X",
+        "nhs_as_svc_ia": "urn:nhs:names:services:pdsquery:QUQI_IN010000UK14",
+        "nhs_mhs_party_key": "C3O9X-806782"
+      }
+    ],
+    "questionnaire_responses": {
+      "spine_as/1": [
+        {
+          "id": "07dacf01-359a-4276-9dd2-e11ecb07076a",
+          "questionnaire_name": "spine_as",
+          "questionnaire_version": "1",
+          "data": {
+            "Client ODS Codes": ["C3O9X"],
+            "MHS Party Key": "C3O9X-806782",
+            "ASID": "000000000001",
+            "ODS Code": "C3O9X",
+            "Temp UID": "10312",
+            "Product Key": "6216",
+            "Product Name": "TPP SystmOne",
+            "Product Version": null,
+            "Date Requested": "20091016133757",
+            "Date Approved": "20091016133823",
+            "Approver URP": "uniqueIdentifier=102583034545,uniqueIdentifier=352307522545,uid=432776896545,ou=People,o=nhs",
+            "Requestor URP": "uniqueIdentifier=203171972540,uniqueIdentifier=352307522545,uid=432776896545,ou=People,o=nhs",
+            "MHS Manufacturer Organisation": "C3O9X"
+          },
+          "created_on": "2024-12-11T11:18:53.456536+00:00"
+        }
+      ]
+    },
+    "device_reference_data": {
+      "390fc252-02a2-494e-b6fb-16717eec7168": ["*.Interaction ID"],
+      "68cd98db-5d8d-45dc-ba9a-09e892535d83": ["*.Interaction ID"]
+    }
+  },
+  {
+    "id": "390fc252-02a2-494e-b6fb-16717eec7168",
+    "name": "C3O9X-806782 - MHS Message Sets",
+    "status": "active",
+    "product_id": "P.9AN-PJG",
+    "product_team_id": "C3O9X.fe49c1d5-d9bc-4c2e-8e8d-54d8e2e88250",
+    "ods_code": "C3O9X",
+    "environment": "prod",
+    "questionnaire_responses": {},
+    "created_on": "2024-12-11T11:18:53.452472+00:00",
+    "updated_on": null,
+    "deleted_on": null
+  },
+  {
+    "id": "68cd98db-5d8d-45dc-ba9a-09e892535d83",
+    "name": "C3O9X-806782 - AS Additional Interactions",
+    "status": "active",
+    "product_id": "P.9AN-PJG",
+    "product_team_id": "C3O9X.fe49c1d5-d9bc-4c2e-8e8d-54d8e2e88250",
+    "ods_code": "C3O9X",
+    "environment": "prod",
+    "questionnaire_responses": {
+      "spine_as_additional_interactions/1": [
+        {
+          "id": "2071f8ac-a020-4bf3-b413-c205004bfb08",
+          "questionnaire_name": "spine_as_additional_interactions",
+          "questionnaire_version": "1",
+          "data": {
+            "Interaction ID": "urn:nhs:names:services:pdsquery:QUQI_IN010000UK14"
+          },
+          "created_on": "2024-12-11T11:18:53.409854+00:00"
+        }
+      ]
+    },
+    "created_on": "2024-12-11T11:18:53.452472+00:00",
+    "updated_on": "2024-12-11T11:18:53.452853+00:00",
+    "deleted_on": null
+  }
+]
diff --git a/src/etl/sds/tests/changelog/utils.py b/src/etl/sds/tests/changelog/utils.py
@@ -194,6 +194,9 @@ def read_all(
         "add/nhs_as_svc_ia.Another.ldif", device_type="accredited_system"
     )
 )
+MODIFY_ACCREDITED_SYSTEM_DELETE_DEVICE_FIELD = create_modify_ldif(
+    "delete/description.ldif", device_type="accredited_system"
+)
 MODIFY_MESSAGE_HANDLING_SYSTEM_DELETE_DEVICE_FIELD = create_modify_ldif(
     "delete/nhs_product_name.ldif", device_type="message_handling_system"
 )
diff --git a/src/layers/sds/epr/bulk_create/tests/conftest.py b/src/layers/sds/epr/bulk_create/tests/conftest.py
@@ -86,6 +86,8 @@ def accredited_system_1() -> NhsMhs:
         nhsasclient={"ABC", "CDE", "EFG"},
         nhsassvcia={"interaction-id-1", "interaction-id-2"},
         nhsmhsmanufacturerorg="AAA",
+        nhstempuid=None,
+        nhsascategorybag={"example"},
     )
 
 
diff --git a/src/layers/sds/epr/bulk_create/tests/test_bulk_create.py b/src/layers/sds/epr/bulk_create/tests/test_bulk_create.py
@@ -146,6 +146,7 @@ def as_device_data():
                 "Product Name": "My EPR Product",
                 "Product Version": None,
                 "Temp UID": None,
+                "Category Bag": ["example"],
             },
         },
         {
diff --git a/src/layers/sds/epr/updates/change_request_processors.py b/src/layers/sds/epr/updates/change_request_processors.py
@@ -39,6 +39,7 @@
 )
 from sds.epr.tags import sds_metadata_to_device_tags
 from sds.epr.updaters import (
+    JSON_SCHEMA_REQUIRED_KEYWORD,
     UnexpectedModification,
     ldif_add_to_field_in_questionnaire,
     ldif_modify_field_in_questionnaire,
@@ -455,7 +456,7 @@ def process_request_to_delete_from_mhs(
     mhs_device_field_mapping: dict,
     message_set_questionnaire: Questionnaire,
     message_set_field_mapping: dict,
-) -> list[Device, DeviceReferenceData, DeviceReferenceData]:
+) -> list[Device | DeviceReferenceData]:
     return _process_request_to_modify_mhs(
         device=device,
         cpa_id_to_modify=cpa_id_to_modify,
@@ -529,7 +530,15 @@ def _process_request_to_modify_as(
 
     # Route the operation
     if modify_additional_interactions:
-        # Check each value not in message set or additional interactions already
+        # Check if Interaction ID field is being deleted
+        required_fields = set(
+            additional_interactions_questionnaire.json_schema.get(
+                JSON_SCHEMA_REQUIRED_KEYWORD, ()
+            )
+        )
+        if new_values is None and additional_interactions_field in required_fields:
+            raise UnexpectedModification(f"Cannot remove required field '{field_name}'")
+        # Check each new value not in message set or additional interactions already
         for new_value in new_values:
             if (
                 new_value not in additional_interactions_interaction_ids
@@ -642,12 +651,24 @@ def process_request_to_replace_in_as(
 
 def process_request_to_delete_from_as(
     device: Device,
+    device_repository: DeviceRepository,
     field_name: str,
+    new_values: set[str],
     device_reference_data_repository: DeviceReferenceDataRepository,
     accredited_system_questionnaire: Questionnaire,
     accredited_system_field_mapping: dict,
-    message_set_questionnaire: Questionnaire,
-    message_set_field_mapping: dict,
     additional_interactions_questionnaire: Questionnaire,
-) -> list[Device, DeviceReferenceData]:
-    raise NotImplementedError()
+    additional_interactions_field_mapping: dict,
+) -> list[Device | DeviceReferenceData]:
+    return _process_request_to_modify_as(
+        device=device,
+        device_repository=device_repository,
+        field_name=field_name,
+        new_values=new_values,
+        device_reference_data_repository=device_reference_data_repository,
+        accredited_system_questionnaire=accredited_system_questionnaire,
+        accredited_system_field_mapping=accredited_system_field_mapping,
+        additional_interactions_questionnaire=additional_interactions_questionnaire,
+        additional_interactions_field_mapping=additional_interactions_field_mapping,
+        ldif_modify_field_in_questionnaire=ldif_remove_field_from_questionnaire,
+    )
diff --git a/src/layers/sds/epr/updates/modification_request_routing.py b/src/layers/sds/epr/updates/modification_request_routing.py
@@ -111,6 +111,6 @@ def route_as_modification_request(
                 )
             case ModificationType.DELETE:
                 domain_objects += process_request_to_delete_from_as(
-                    field_name=field_name, **common_payload
+                    field_name=field_name, new_values=[], **common_payload
                 )
     return domain_objects
diff --git a/src/layers/sds/epr/updates/tests/test_process_to_modify_as.py b/src/layers/sds/epr/updates/tests/test_process_to_modify_as.py
diff --git a/src/layers/sds/epr/updates/tests/test_process_to_modify_mhs.py b/src/layers/sds/epr/updates/tests/test_process_to_modify_mhs.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+- [PI-693] Changelog ETL - modify / remove from an AS`