Use common clients

dlzhry2nhs · dlzhry2nhs · commit 31f9dfda8127 · 2025-10-24T15:36:35.000+01:00
diff --git a/lambdas/recordprocessor/Dockerfile b/lambdas/recordprocessor/Dockerfile
@@ -27,5 +27,4 @@ RUN chmod 644 $(find . -type f) && chmod 755 $(find . -type d)
 
 # Switch to the non-root user for running the container
 USER 1001:1001
-CMD ["python", "batch_processor.py"]
 ENTRYPOINT ["python", "batch_processor.py"]
diff --git a/lambdas/recordprocessor/src/audit_table.py b/lambdas/recordprocessor/src/audit_table.py
@@ -2,7 +2,7 @@
 
 from typing import Optional
 
-from clients import dynamodb_client, logger
+from common.clients import dynamodb_client, logger
 from constants import AUDIT_TABLE_NAME, AuditTableKeys
 from errors import UnhandledAuditTableError
 
diff --git a/lambdas/recordprocessor/src/batch_processor.py b/lambdas/recordprocessor/src/batch_processor.py
@@ -8,7 +8,7 @@
 from typing import Optional
 
 from audit_table import update_audit_table_status
-from clients import logger
+from common.clients import logger
 from constants import (
     ARCHIVE_DIR_NAME,
     PROCESSING_DIR_NAME,
diff --git a/lambdas/recordprocessor/src/clients.py b/lambdas/recordprocessor/src/clients.py
diff --git a/lambdas/recordprocessor/src/file_level_validation.py b/lambdas/recordprocessor/src/file_level_validation.py
@@ -6,7 +6,7 @@
 from csv import DictReader
 
 from audit_table import update_audit_table_status
-from clients import logger, s3_client
+from common.clients import logger, s3_client
 from constants import (
     ARCHIVE_DIR_NAME,
     EXPECTED_CSV_HEADERS,
diff --git a/lambdas/recordprocessor/src/logging_decorator.py b/lambdas/recordprocessor/src/logging_decorator.py
@@ -6,7 +6,7 @@
 from datetime import datetime
 from functools import wraps
 
-from clients import firehose_client, logger
+from common.clients import firehose_client, logger
 from errors import InvalidHeaders, NoOperationPermissions
 
 STREAM_NAME = os.getenv("SPLUNK_FIREHOSE_NAME", "immunisation-fhir-api-internal-dev-splunk-firehose")
diff --git a/lambdas/recordprocessor/src/make_and_upload_ack_file.py b/lambdas/recordprocessor/src/make_and_upload_ack_file.py
@@ -3,7 +3,7 @@
 from csv import writer
 from io import BytesIO, StringIO
 
-from clients import s3_client
+from common.clients import s3_client
 from constants import ACK_BUCKET_NAME
 
 
diff --git a/lambdas/recordprocessor/src/mappings.py b/lambdas/recordprocessor/src/mappings.py
@@ -2,13 +2,13 @@
 
 import json
 
-from clients import redis_client
+from common.redis_client import get_redis_client
 from constants import Urls
 
 
 def map_target_disease(vaccine: str) -> list:
     """Returns the target disease element for the given vaccine type using the vaccine_disease_mapping"""
-    diseases_str = redis_client.hget("vacc_to_diseases", vaccine)
+    diseases_str = get_redis_client().hget("vacc_to_diseases", vaccine)
     diseases = json.loads(diseases_str) if diseases_str else []
     return [
         {
diff --git a/lambdas/recordprocessor/src/process_row.py b/lambdas/recordprocessor/src/process_row.py
@@ -1,6 +1,6 @@
 """Function to process a single row of a csv file"""
 
-from clients import logger
+from common.clients import logger
 from constants import Diagnostics
 from convert_to_fhir_imms_resource import convert_to_fhir_imms_resource
 from utils_for_recordprocessor import create_diagnostics_dictionary
diff --git a/lambdas/recordprocessor/src/send_to_kinesis.py b/lambdas/recordprocessor/src/send_to_kinesis.py
@@ -5,7 +5,7 @@
 import simplejson as json
 from botocore.exceptions import ClientError
 
-from clients import kinesis_client, logger
+from common.clients import kinesis_client, logger
 
 
 def send_to_kinesis(supplier: str, message_body: dict, vaccine_type: str) -> bool:
diff --git a/lambdas/recordprocessor/src/utils_for_recordprocessor.py b/lambdas/recordprocessor/src/utils_for_recordprocessor.py
@@ -4,7 +4,7 @@
 from csv import DictReader
 from io import TextIOWrapper
 
-from clients import s3_client
+from common.clients import s3_client
 
 
 def get_environment() -> str:
diff --git a/lambdas/recordprocessor/tests/test_audit_table.py b/lambdas/recordprocessor/tests/test_audit_table.py
@@ -8,25 +8,25 @@
 from moto import mock_dynamodb
 
 from errors import UnhandledAuditTableError
-from tests.utils_for_recordprocessor_tests.generic_setup_and_teardown import (
+from utils_for_recordprocessor_tests.generic_setup_and_teardown import (
     GenericSetUp,
     GenericTearDown,
 )
-from tests.utils_for_recordprocessor_tests.mock_environment_variables import (
+from utils_for_recordprocessor_tests.mock_environment_variables import (
     MOCK_ENVIRONMENT_DICT,
 )
-from tests.utils_for_recordprocessor_tests.utils_for_recordprocessor_tests import (
+from utils_for_recordprocessor_tests.utils_for_recordprocessor_tests import (
     add_entry_to_table,
 )
-from tests.utils_for_recordprocessor_tests.values_for_recordprocessor_tests import (
+from utils_for_recordprocessor_tests.values_for_recordprocessor_tests import (
     FileDetails,
     MockFileDetails,
 )
 
 # Ensure environment variables are mocked before importing from src files
 with patch.dict("os.environ", MOCK_ENVIRONMENT_DICT):
     from audit_table import update_audit_table_status
-    from clients import REGION_NAME
+    from common.clients import REGION_NAME
     from constants import (
         AUDIT_TABLE_NAME,
         FileStatus,
@@ -45,11 +45,14 @@ class TestAuditTable(TestCase):
 
     def setUp(self):
         """Set up test values to be used for the tests"""
+        self.logger_patcher = patch("audit_table.logger")
+        self.mock_logger = self.logger_patcher.start()
         GenericSetUp(dynamodb_client=dynamodb_client)
 
     def tearDown(self):
         """Tear down the test values"""
         GenericTearDown(dynamodb_client=dynamodb_client)
+        self.mock_logger.stop()
 
     @staticmethod
     def get_table_items() -> list:
@@ -76,6 +79,12 @@ def test_update_audit_table_status(self):
         table_items = dynamodb_client.scan(TableName=AUDIT_TABLE_NAME).get("Items", [])
 
         self.assertIn(expected_table_entry, table_items)
+        self.mock_logger.info.assert_called_once_with(
+            "The status of %s file, with message id %s, was successfully updated to %s in the audit table",
+            "RSV_Vaccinations_v5_X26_20210730T12000000.csv",
+            "rsv_ravs_test_id",
+            "Preprocessed",
+        )
 
     def test_update_audit_table_status_including_error_details(self):
         """Checks audit table correctly updates a record including some error details"""
@@ -99,16 +108,24 @@ def test_update_audit_table_status_including_error_details(self):
             },
             table_items[0],
         )
+        self.mock_logger.info.assert_called_once_with(
+            "The status of %s file, with message id %s, was successfully updated to %s in the audit table",
+            "RSV_Vaccinations_v5_X26_20210730T12000000.csv",
+            "rsv_ravs_test_id",
+            "Failed",
+        )
 
     def test_update_audit_table_status_throws_exception_with_invalid_id(self):
         emis_flu_test_file_2 = FileDetails("FLU", "EMIS", "YGM41")
 
         message_id = emis_flu_test_file_2.message_id
-        file_key = (emis_flu_test_file_2.file_key,)
+        file_key = emis_flu_test_file_2.file_key
 
         with self.assertRaises(UnhandledAuditTableError):
             update_audit_table_status(file_key, message_id, FileStatus.PROCESSED)
 
+        self.mock_logger.error.assert_called_once()
+
 
 if __name__ == "__main__":
     unittest.main()
diff --git a/lambdas/recordprocessor/tests/test_logging_decorator.py b/lambdas/recordprocessor/tests/test_logging_decorator.py
@@ -21,7 +21,7 @@
 )
 
 with patch.dict("os.environ", MOCK_ENVIRONMENT_DICT):
-    from clients import REGION_NAME
+    from common.clients import REGION_NAME
     from errors import InvalidHeaders, NoOperationPermissions
     from file_level_validation import file_level_validation
     from logging_decorator import generate_and_send_logs, send_log_to_firehose
diff --git a/lambdas/recordprocessor/tests/test_make_and_upload_ack_file.py b/lambdas/recordprocessor/tests/test_make_and_upload_ack_file.py
@@ -19,7 +19,7 @@
 )
 
 with patch("os.environ", MOCK_ENVIRONMENT_DICT):
-    from clients import REGION_NAME
+    from common.clients import REGION_NAME
     from make_and_upload_ack_file import (
         make_ack_data,
         make_and_upload_ack_file,
diff --git a/lambdas/recordprocessor/tests/test_map_target_disease.py b/lambdas/recordprocessor/tests/test_map_target_disease.py
@@ -2,33 +2,35 @@
 
 import json
 import unittest
-from unittest.mock import patch
+from unittest.mock import Mock, patch
 
-from tests.utils_for_recordprocessor_tests.mock_environment_variables import (
+from utils_for_recordprocessor_tests.mock_environment_variables import (
     MOCK_ENVIRONMENT_DICT,
 )
 
 with patch("os.environ", MOCK_ENVIRONMENT_DICT):
     from mappings import map_target_disease
 
 
-@patch("mappings.redis_client")
+@patch("mappings.get_redis_client")
 class TestMapTargetDisease(unittest.TestCase):
     """
     Test that map_target_disease returns the correct target disease element for valid vaccine types, or [] for
     invalid vaccine types.
     """
 
-    def test_map_target_disease_valid(self, mock_redis_client):
+    def test_map_target_disease_valid(self, mock_get_redis_client):
         """Tests map_target_disease returns the disease coding information when using valid vaccine types"""
-        mock_redis_client.hget.return_value = json.dumps(
+        mock_redis = Mock()
+        mock_redis.hget.return_value = json.dumps(
             [
                 {
                     "code": "55735004",
                     "term": "Respiratory syncytial virus infection (disorder)",
                 }
             ]
         )
+        mock_get_redis_client.return_value = mock_redis
 
         self.assertEqual(
             map_target_disease("RSV"),
@@ -45,16 +47,17 @@ def test_map_target_disease_valid(self, mock_redis_client):
             ],
         )
 
-        mock_redis_client.hget.assert_called_with("vacc_to_diseases", "RSV")
+        mock_redis.hget.assert_called_with("vacc_to_diseases", "RSV")
 
-    def test_map_target_disease_invalid(self, mock_redis_client):
+    def test_map_target_disease_invalid(self, mock_get_redis_client):
         """Tests map_target_disease does not return the disease coding information when using invalid vaccine types."""
-
-        mock_redis_client.hget.return_value = None
+        mock_redis = Mock()
+        mock_redis.hget.return_value = None
+        mock_get_redis_client.return_value = mock_redis
 
         self.assertEqual(map_target_disease("invalid_vaccine"), [])
 
-        mock_redis_client.hget.assert_called_with("vacc_to_diseases", "invalid_vaccine")
+        mock_redis.hget.assert_called_with("vacc_to_diseases", "invalid_vaccine")
 
 
 if __name__ == "__main__":
diff --git a/lambdas/recordprocessor/tests/test_process_csv_to_fhir.py b/lambdas/recordprocessor/tests/test_process_csv_to_fhir.py
@@ -3,7 +3,7 @@
 import json
 import unittest
 from copy import deepcopy
-from unittest.mock import patch
+from unittest.mock import Mock, patch
 
 import boto3
 from moto import mock_dynamodb, mock_firehose, mock_s3
@@ -49,17 +49,19 @@ def setUp(self) -> None:
             dynamodb_client=dynamodb_client,
         )
 
-        redis_patcher = patch("mappings.redis_client")
-        self.addCleanup(redis_patcher.stop)
-        mock_redis_client = redis_patcher.start()
-        mock_redis_client.hget.return_value = json.dumps(
+        redis_getter_patcher = patch("mappings.get_redis_client")
+        self.addCleanup(redis_getter_patcher.stop)
+        mock_redis = Mock()
+        mock_redis_getter = redis_getter_patcher.start()
+        mock_redis.hget.return_value = json.dumps(
             [
                 {
                     "code": "55735004",
                     "term": "Respiratory syncytial virus infection (disorder)",
                 }
             ]
         )
+        mock_redis_getter.return_value = mock_redis
 
     def tearDown(self) -> None:
         GenericTearDown(
diff --git a/lambdas/recordprocessor/tests/test_process_row.py b/lambdas/recordprocessor/tests/test_process_row.py
@@ -21,7 +21,7 @@
 )
 
 with patch("os.environ", MOCK_ENVIRONMENT_DICT):
-    from clients import REGION_NAME
+    from common.clients import REGION_NAME
     from process_row import process_row
 
 s3_client = boto3_client("s3", region_name=REGION_NAME)
diff --git a/lambdas/recordprocessor/tests/test_recordprocessor_main.py b/lambdas/recordprocessor/tests/test_recordprocessor_main.py
@@ -5,7 +5,7 @@
 from datetime import datetime, timedelta, timezone
 from decimal import Decimal
 from json import JSONDecodeError
-from unittest.mock import patch
+from unittest.mock import Mock, patch
 
 from boto3 import client as boto3_client
 from moto import mock_dynamodb, mock_firehose, mock_kinesis, mock_s3
@@ -62,19 +62,21 @@ class TestRecordProcessor(unittest.TestCase):
     def setUp(self) -> None:
         GenericSetUp(s3_client, firehose_client, kinesis_client, dynamo_db_client)
 
-        redis_patcher = patch("mappings.redis_client")
+        mock_redis = Mock()
+        redis_getter_patcher = patch("mappings.get_redis_client")
         batch_processor_logger_patcher = patch("batch_processor.logger")
-        self.addCleanup(redis_patcher.stop)
+        self.addCleanup(redis_getter_patcher.stop)
         self.mock_batch_processor_logger = batch_processor_logger_patcher.start()
-        mock_redis_client = redis_patcher.start()
-        mock_redis_client.hget.return_value = json.dumps(
+        mock_redis_getter = redis_getter_patcher.start()
+        mock_redis.hget.return_value = json.dumps(
             [
                 {
                     "code": "55735004",
                     "term": "Respiratory syncytial virus infection (disorder)",
                 }
             ]
         )
+        mock_redis_getter.return_value = mock_redis
         self.mock_logger_info = create_patch("logging.Logger.info")
 
     def tearDown(self) -> None:
diff --git a/lambdas/recordprocessor/tests/utils_for_recordprocessor_tests/generic_setup_and_teardown.py b/lambdas/recordprocessor/tests/utils_for_recordprocessor_tests/generic_setup_and_teardown.py
@@ -11,7 +11,7 @@
 
 # Ensure environment variables are mocked before importing from src files
 with patch.dict("os.environ", MOCK_ENVIRONMENT_DICT):
-    from clients import REGION_NAME
+    from common.clients import REGION_NAME
     from constants import (
         AUDIT_TABLE_FILENAME_GSI,
         AUDIT_TABLE_NAME,
diff --git a/lambdas/recordprocessor/tests/utils_for_recordprocessor_tests/utils_for_recordprocessor_tests.py b/lambdas/recordprocessor/tests/utils_for_recordprocessor_tests/utils_for_recordprocessor_tests.py
@@ -22,7 +22,7 @@
 with patch.dict("os.environ", MOCK_ENVIRONMENT_DICT):
     from csv import DictReader
 
-    from clients import REGION_NAME
+    from common.clients import REGION_NAME
     from constants import (
         AUDIT_TABLE_FILENAME_GSI,
         AUDIT_TABLE_NAME,
diff --git a/lambdas/shared/src/common/clients.py b/lambdas/shared/src/common/clients.py
