merge master into staging branch

motola · motola · commit 6d1b0032b706 · 2026-03-16T17:34:26.000Z
diff --git a/README.md b/README.md
@@ -26,6 +26,7 @@ See https://nhsd-confluence.digital.nhs.uk/display/APM/Glossary.
 | `id_sync`                | **Imms Cross-cutting** – Handles [MNS](https://digital.nhs.uk/developer/api-catalogue/multicast-notification-service) NHS Number Change events and applies updates to affected records. |
 | `mesh_processor`         | **Imms Batch** – Triggered when new files are received via MESH. Moves them into the Imms Batch processing system.                                                                      |
 | `mns_subscription`       | **Imms Cross-cutting** – Simple helper Lambda which sets up our required MNS subscription. Used in pipelines in DEV.                                                                    |
+| `perf_tests`             | **Imms API** – Locust performance tests for the Immunisation API.                                                                                                                       |
 | `recordforwarder`        | **Imms Batch** – Consumes from the stream and applies the processed batch file row operations (CUD) to IEDS.                                                                            |
 | `recordprocessor`        | **Imms Batch** – ECS Task - **not** a Lambda function - responsible for processing batch file rows and forwarding to the stream.                                                        |
 | `redis_sync`             | **Imms Cross-cutting** – Handles config file updates. E.g. disease mapping or permission files.                                                                                         |
@@ -142,22 +143,12 @@ Steps:
     pip install poetry
     ```
 
-### Install Pre-Commit Hooks
-
-[Husky](https://typicode.github.io/husky/) is used to perform automatic checks upon making a commit.
-It is configured within `.husky/pre-commit` to run the checks defined in the root level `package.json` under `lint-staged`.
-To set this up:
-
-1. Ensure you have installed nodejs at the same version or later as per .tool-versions and
+8. Install pre-commit hooks. Ensure you have installed nodejs at the same version or later as per .tool-versions and
    then, from the repo root, run:
-
     ```
     npm install
     ```
 
-2. Run `cd quality_checks` then `poetry install --no-root`. This will make sure your version of ruff is the same as used in the GitHub pipeline.
-   You can check your version is correct by running `poetry run ruff --version` from within the `quality_checks` directory and comparing to the version in the poetry.lock file.
-
 ### Setting up a virtual environment with poetry
 
 The steps below must be performed in each Lambda function folder and e2e_automation folder to ensure the environment is correctly configured.
@@ -216,6 +207,18 @@ Steps:
 
 It is not necessary to activate the virtual environment (using `source .venv/bin/activate`) before running a unit test suite from the command line; `direnv` will pick up the correct configurations for us. Run `pip list` to verify that the expected packages are installed. You should for example see that `recordprocessor` is specifically running `moto` v4, regardless of which if any `.venv` is active.
 
+### Setting up the root level environment
+
+The root-level virtual environment is primarily used for linting, as we create separate virtual environments for each folder that contains Lambda functions.
+Steps:
+
+1. Follow instructions above to [install dependencies](#install-dependencies) & [set up a virtual environment](#setting-up-a-virtual-environment-with-poetry).
+   **Note: While this project uses Python 3.11 (e.g. for Lambdas), the NHSDigital/api-management-utils repository — which orchestrates setup and linting — defaults to Python 3.8.
+   The linting command is executed from within that repo but calls the Makefile in this project, so be aware of potential Python version mismatches when running or debugging locally or in the pipeline.**
+2. Run `make lint`. This will:
+    - Check the linting of the API specification yaml.
+    - Run Flake8 on all Python files in the repository, excluding files inside .venv and .terraform directories.
+
 ## IDE setup
 
 The current team uses VS Code mainly. So this setup is targeted towards VS code. If you use another IDE please add the documentation to set up workspaces here.
diff --git a/lambdas/id_sync/tests/test_pds_details.py b/lambdas/id_sync/tests/test_pds_details.py
@@ -0,0 +1,195 @@
+import unittest
+from unittest.mock import MagicMock, patch
+
+from exceptions.id_sync_exception import IdSyncException
+from pds_details import get_nhs_number_from_pds_resource, pds_get_patient_details
+
+
+class TestGetPdsPatientDetails(unittest.TestCase):
+    def setUp(self):
+        """Set up test fixtures and mocks"""
+        self.test_patient_id = "9912003888"
+
+        # Patch all external dependencies
+        self.logger_patcher = patch("pds_details.logger")
+        self.mock_logger = self.logger_patcher.start()
+
+        self.secrets_manager_patcher = patch("common.clients.global_secrets_manager_client")
+        self.mock_secrets_manager = self.secrets_manager_patcher.start()
+
+        self.pds_env_patcher = patch("pds_details.get_pds_env")
+        self.mock_pds_env = self.pds_env_patcher.start()
+        self.mock_pds_env.return_value = "test-env"
+
+        self.auth_patcher = patch("pds_details.AppRestrictedAuth")
+        self.mock_auth_class = self.auth_patcher.start()
+        self.mock_auth_instance = MagicMock()
+        self.mock_auth_class.return_value = self.mock_auth_instance
+
+        self.pds_service_patcher = patch("pds_details.PdsService")
+        self.mock_pds_service_class = self.pds_service_patcher.start()
+        self.mock_pds_service_instance = MagicMock()
+        self.mock_pds_service_class.return_value = self.mock_pds_service_instance
+
+    def tearDown(self):
+        """Clean up patches"""
+        patch.stopall()
+
+    def test_pds_get_patient_details_success(self):
+        """Test successful retrieval of patient details"""
+        # Arrange
+        expected_patient_data = {
+            "identifier": [{"value": "9912003888"}],
+            "name": "John Doe",
+            "birthDate": "1990-01-01",
+            "gender": "male",
+        }
+        self.mock_pds_service_instance.get_patient_details.return_value = expected_patient_data
+
+        # Act
+        result = pds_get_patient_details(self.test_patient_id)
+
+        # Assert
+        self.assertEqual(result["identifier"][0]["value"], "9912003888")
+
+        # Verify get_patient_details was called
+        self.mock_pds_service_instance.get_patient_details.assert_called_once()
+
+    def test_pds_get_patient_details_no_patient_found(self):
+        """Test when PDS returns None (no patient found)"""
+        # Arrange
+        self.mock_pds_service_instance.get_patient_details.return_value = None
+
+        # Act
+        result = pds_get_patient_details(self.test_patient_id)
+
+        # Assert
+        self.assertIsNone(result)
+
+        self.mock_pds_service_instance.get_patient_details.assert_called_once_with(self.test_patient_id)
+
+    def test_pds_get_patient_details_empty_response(self):
+        """Test when PDS returns empty dict (falsy)"""
+        # Arrange
+        self.mock_pds_service_instance.get_patient_details.return_value = None
+
+        # Act
+        result = pds_get_patient_details(self.test_patient_id)
+
+        # Assert
+        self.assertIsNone(result)
+
+    def test_pds_get_patient_details_pds_service_exception(self):
+        """Test when PdsService.get_patient_details raises an exception"""
+        # Arrange
+        mock_exception = Exception("My custom error")
+        self.mock_pds_service_instance.get_patient_details.side_effect = mock_exception
+
+        # Act
+        with self.assertRaises(IdSyncException) as context:
+            pds_get_patient_details(self.test_patient_id)
+
+        exception = context.exception
+
+        # Assert
+        self.assertEqual(
+            exception.message,
+            "Error retrieving patient details from PDS",
+        )
+
+        # Verify exception was logged
+        self.mock_logger.exception.assert_called_once_with("Error retrieving patient details from PDS")
+
+        self.mock_pds_service_instance.get_patient_details.assert_called_once_with(self.test_patient_id)
+
+    def test_pds_get_patient_details_auth_initialization_error(self):
+        """Test when AppRestrictedAuth initialization fails"""
+        # Arrange
+        self.mock_auth_class.side_effect = ValueError("Invalid authentication parameters")
+
+        # Act
+        with self.assertRaises(IdSyncException) as context:
+            pds_get_patient_details(self.test_patient_id)
+
+        # Assert
+        exception = context.exception
+        self.assertEqual(
+            exception.message,
+            "Error retrieving patient details from PDS",
+        )
+
+        # Verify exception was logged
+        self.mock_logger.exception.assert_called_once_with("Error retrieving patient details from PDS")
+
+    def test_pds_get_patient_details_exception(self):
+        """Test when logger.info throws an exception"""
+        # Arrange
+        test_exception = Exception("some-random-error")
+        self.mock_pds_service_class.side_effect = test_exception
+        test_nhs_number = "another-nhs-number"
+
+        # Act
+        with self.assertRaises(Exception) as context:
+            pds_get_patient_details(test_nhs_number)
+
+        exception = context.exception
+        # Assert
+        self.assertEqual(
+            exception.message,
+            "Error retrieving patient details from PDS",
+        )
+        # Verify logger.exception was called due to the caught exception
+        self.mock_logger.exception.assert_called_once_with("Error retrieving patient details from PDS")
+
+    def test_pds_get_patient_details_different_patient_ids(self):
+        """Test with different patient ID formats"""
+        test_cases = [
+            ("9912003888", {"identifier": [{"value": "9912003888"}]}),
+            ("1234567890", {"identifier": [{"value": "1234567890"}]}),
+            ("0000000000", {"identifier": [{"value": "0000000000"}]}),
+        ]
+
+        for patient_id, expected_response in test_cases:
+            with self.subTest(patient_id=patient_id):
+                # Reset mocks
+                self.mock_pds_service_instance.reset_mock()
+                self.mock_logger.reset_mock()
+
+                # Arrange
+                self.mock_pds_service_instance.get_patient_details.return_value = expected_response
+
+                # Act
+                result = pds_get_patient_details(patient_id)
+
+                # Assert
+                self.assertEqual(result, expected_response)
+                self.mock_pds_service_instance.get_patient_details.assert_called_once_with(patient_id)
+
+    def test_pds_get_patient_details(self):
+        """Test with complex identifier structure"""
+        # Arrange
+        test_nhs_number = "9912003888"
+        pds_id = "abcefghijkl"
+        mock_pds_response = {"identifier": [{"value": pds_id}]}
+        self.mock_pds_service_instance.get_patient_details.return_value = mock_pds_response
+        # Act
+        result = pds_get_patient_details(test_nhs_number)
+
+        # Assert - function should extract the value from first identifier
+        self.assertEqual(result, mock_pds_response)
+        self.mock_pds_service_instance.get_patient_details.assert_called_once_with(test_nhs_number)
+
+    def test_get_nhs_number_from_pds_resource(self):
+        """Test that the NHS Number is retrieved from a full PDS patient resource."""
+        mock_pds_resource = {
+            "identifier": [
+                {
+                    "system": "https://fhir.nhs.uk/Id/nhs-number",
+                    "value": "123456789012",
+                }
+            ]
+        }
+
+        result = get_nhs_number_from_pds_resource(mock_pds_resource)
+
+        self.assertEqual(result, "123456789012")
diff --git a/lambdas/mns_subscription/src/mns_setup.py b/lambdas/mns_subscription/src/mns_setup.py
@@ -0,0 +1,20 @@
+import logging
+
+import boto3
+from botocore.config import Config
+
+from common.api_clients.authentication import AppRestrictedAuth
+from common.api_clients.mns_service import MnsService
+
+logging.basicConfig(level=logging.INFO)
+
+
+def get_mns_service(mns_env: str = "int"):
+    boto_config = Config(region_name="eu-west-2")
+
+    authenticator = AppRestrictedAuth(
+        secret_manager_client=boto3.client("secretsmanager", config=boto_config),
+        environment=mns_env,
+    )
+
+    return MnsService(authenticator)
diff --git a/manifest_template.yml b/manifest_template.yml
@@ -5,7 +5,7 @@ APIGEE_ENVIRONMENTS:
     display_name_suffix: Internal Development
     ratelimiting:
       immunisation-fhir-api-internal-dev:
-        # 5 requests per second on average
+        # 500 requests per second on average
         quota:
           enabled: true
           limit: 300
@@ -112,7 +112,7 @@ APIGEE_ENVIRONMENTS:
           limit: 300
           interval: 1
           timeunit: minute
-        # 10 requests per second max
+        # 1000 requests per second max
         spikeArrest:
           enabled: true
           ratelimit: 600pm
diff --git a/tests/perf_tests/Makefile b/tests/perf_tests/Makefile
@@ -0,0 +1,4 @@
+test:
+	poetry run locust -f src/locustfile.py
+
+.PHONY: test
diff --git a/tests/perf_tests/Readme.md b/tests/perf_tests/Readme.md
@@ -0,0 +1,10 @@
+# Perf tests
+
+This project contains Locust performance tests for the Immunisation FHIR API.
+
+To run them, ensure you have the
+`APIGEE_ENVIRONMENT` : Currently, only the ref environment is supported.
+`PERF_SUPPLIER_SYSTEM` : `EMIS` or `TPP`
+`PERF_CREATE_RPS_PER_USER` : numeric
+
+env vars set, and call `make test`.
diff --git a/tests/perf_tests/pyproject.toml b/tests/perf_tests/pyproject.toml
@@ -0,0 +1,24 @@
+[tool.poetry]
+name = "perf-tests"
+version = "0.1.0"
+description = ""
+authors = ["Matt Jarvis matt.jarvis2@nhs.net"]
+readme = "README.md"
+packages = [
+{ include = "objectModels", from = "../e2e_automation/src" },
+{ include = "utilities", from = "../e2e_automation" }
+]
+
+[tool.poetry.dependencies]
+python = ">=3.11,<3.12"
+locust = ">=2.42.3,<3.0.0"
+pyjwt = { version = ">=2.11.0,<3.0.0", extras = ["crypto"] }
+boto3 = ">=1.42.59,<2.0.0"
+shared = { path = "../../lambdas/shared", develop = true }
+pandas = "2.3.0"
+pydantic = "1.10.13"
+typing_extensions = "~4.15.0"
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
diff --git a/tests/perf_tests/src/locustfile.py b/tests/perf_tests/src/locustfile.py

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +test:
 +	poetry run locust -f src/locustfile.py
++
 +.PHONY: test