interim - for merge II

Author: JamesW1-NHS

lambdas/backend/src/controller/aws_apig_event_utils.py

@@ -5,7 +5,7 @@
 from aws_lambda_typing.events import APIGatewayProxyEventV1
 
 from controller.constants import E_TAG_HEADER_NAME, SUPPLIER_SYSTEM_HEADER_NAME
-from models.errors import ResourceVersionNotProvided, UnauthorizedError
+from common.models.errors import ResourceVersionNotProvided, UnauthorizedError
 from utils import dict_utils
 
 

lambdas/backend/src/controller/fhir_api_exception_handler.py

@@ -7,7 +7,7 @@
 from clients import logger
 from constants import GENERIC_SERVER_ERROR_DIAGNOSTICS_MESSAGE
 from controller.aws_apig_response_utils import create_response
-from models.errors import (
+from common.models.errors import (
     Code,
     CustomValidationError,
     IdentifierDuplicationError,

lambdas/backend/src/controller/fhir_controller.py

@@ -18,7 +18,7 @@
 from controller.aws_apig_response_utils import create_response
 from controller.constants import E_TAG_HEADER_NAME
 from controller.fhir_api_exception_handler import fhir_api_exception_handler
-from models.errors import (
+from common.models.errors import (
     Code,
     InconsistentIdError,
     InvalidImmunizationId,
@@ -30,7 +30,7 @@
     UnauthorizedVaxError,
     create_operation_outcome,
 )
-from models.utils.generic_utils import check_keys_in_sources
+from common.models.utils.generic_utils import check_keys_in_sources
 from parameter_parser import create_query_string, process_params, process_search_params
 from repository.fhir_repository import ImmunizationRepository, create_table
 from service.fhir_service import FhirService, get_service_url

lambdas/backend/src/repository/fhir_repository.py

@@ -13,14 +13,14 @@
 from mypy_boto3_dynamodb.service_resource import DynamoDBServiceResource, Table
 from responses import logger
 
-from models.constants import Constants
-from models.errors import (
+from common.models.constants import Constants
+from common.models.errors import (
     ResourceNotFoundError,
     UnhandledResponseError,
 )
-from models.immunization_record_metadata import ImmunizationRecordMetadata
-from models.utils.generic_utils import get_contained_patient
-from models.utils.validation_utils import (
+from common.models.immunization_record_metadata import ImmunizationRecordMetadata
+from common.models.utils.generic_utils import get_contained_patient
+from common.models.utils.validation_utils import (
     get_vaccine_type,
 )
 

lambdas/backend/src/service/fhir_service.py

@@ -22,20 +22,20 @@
 from authorisation.api_operation_code import ApiOperationCode
 from authorisation.authoriser import Authoriser
 from filter import Filter
-from models.errors import (
+from common.models.errors import (
     CustomValidationError,
     IdentifierDuplicationError,
     MandatoryError,
     ResourceNotFoundError,
     UnauthorizedVaxError,
 )
-from models.fhir_immunization import ImmunizationValidator
-from models.utils.generic_utils import (
+from common.models.fhir_immunization import ImmunizationValidator
+from common.models.utils.generic_utils import (
     form_json,
     get_contained_patient,
     get_occurrence_datetime,
 )
-from models.utils.validation_utils import get_vaccine_type, validate_identifiers_match, validate_resource_versions_match
+from common.models.utils.validation_utils import get_vaccine_type, validate_identifiers_match, validate_resource_versions_match
 from repository.fhir_repository import ImmunizationRepository
 
 logging.basicConfig(level="INFO")

lambdas/backend/tests/controller/test_fhir_api_exception_handler.py

@@ -3,7 +3,7 @@
 from unittest.mock import patch
 
 from controller.fhir_api_exception_handler import fhir_api_exception_handler
-from models.errors import (
+from common.models.errors import (
     CustomValidationError,
     IdentifierDuplicationError,
     InconsistentIdentifierError,

lambdas/backend/tests/controller/test_fhir_controller.py

@@ -12,7 +12,7 @@
 
 from controller.aws_apig_response_utils import create_response
 from controller.fhir_controller import FhirController
-from models.errors import (
+from common.models.errors import (
     CustomValidationError,
     ParameterException,
     ResourceNotFoundError,
@@ -31,13 +31,14 @@ class TestFhirControllerBase(unittest.TestCase):
 
     def setUp(self):
         super().setUp()
-        self.redis_patcher = patch("parameter_parser.redis_client")
-        self.mock_redis_client = self.redis_patcher.start()
+        self.mock_redis = Mock()
+        self.redis_getter_patcher = patch("parameter_parser.get_redis_client")
+        self.mock_redis_getter = self.redis_getter_patcher.start()
         self.logger_info_patcher = patch("logging.Logger.info")
         self.mock_logger_info = self.logger_info_patcher.start()
 
     def tearDown(self):
-        self.redis_patcher.stop()
+        self.redis_getter_patcher.stop()
         self.logger_info_patcher.stop()
         super().tearDown()
 
@@ -1270,7 +1271,8 @@ def setUp(self):
         self.date_to_key = "-date.to"
         self.nhs_number_valid_value = "9000000009"
         self.patient_identifier_valid_value = f"{patient_identifier_system}|{self.nhs_number_valid_value}"
-        self.mock_redis_client.hkeys.return_value = self.MOCK_REDIS_V2D_HKEYS
+        self.mock_redis.hkeys.return_value = self.MOCK_REDIS_V2D_HKEYS
+        self.mock_redis_getter.return_value = self.mock_redis
 
     def test_get_search_immunizations(self):
         """it should search based on patient_identifier and immunization_target"""
@@ -1537,7 +1539,8 @@ def test_post_search_immunizations_for_unauthorized_vaccine_type_search_403(self
 
     @patch("controller.fhir_controller.process_search_params", wraps=process_search_params)
     def test_uses_parameter_parser(self, process_search_params: Mock):
-        self.mock_redis_client.hkeys.return_value = self.MOCK_REDIS_V2D_HKEYS
+        self.mock_redis.hkeys.return_value = self.MOCK_REDIS_V2D_HKEYS
+        self.mock_redis_getter.return_value = self.mock_redis
         lambda_event = {
             "multiValueQueryStringParameters": {
                 self.patient_identifier_key: ["https://fhir.nhs.uk/Id/nhs-number|9000000009"],

lambdas/backend/tests/models/utils/test_validation_utils.py

@@ -3,16 +3,16 @@
 
 from jsonpath_ng.ext import parse
 
-from models.errors import InconsistentIdentifierError, InconsistentResourceVersion
-from models.fhir_immunization import ImmunizationValidator
-from models.obtain_field_value import ObtainFieldValue
-from models.utils.generic_utils import (
+from common.models.errors import InconsistentIdentifierError, InconsistentResourceVersion
+from common.models.fhir_immunization import ImmunizationValidator
+from common.models.obtain_field_value import ObtainFieldValue
+from common.models.utils.generic_utils import (
     get_current_name_instance,
     obtain_current_name_period,
     obtain_name_field_location,
     patient_and_practitioner_value_and_index,
 )
-from models.utils.validation_utils import validate_identifiers_match, validate_resource_versions_match
+from common.models.utils.validation_utils import validate_identifiers_match, validate_resource_versions_match
 from testing_utils.generic_utils import (
     load_json_data,
 )

lambdas/backend/tests/repository/test_fhir_repository.py

@@ -8,12 +8,12 @@
 from boto3.dynamodb.conditions import Attr, Key
 from fhir.resources.R4B.immunization import Immunization
 
-from models.errors import (
+from common.models.errors import (
     ResourceNotFoundError,
     UnhandledResponseError,
 )
-from models.immunization_record_metadata import ImmunizationRecordMetadata
-from models.utils.validation_utils import get_vaccine_type
+from common.models.immunization_record_metadata import ImmunizationRecordMetadata
+from common.models.utils.validation_utils import get_vaccine_type
 from repository.fhir_repository import ImmunizationRepository
 from testing_utils.generic_utils import update_target_disease_code
 from testing_utils.immunization_utils import VALID_NHS_NUMBER, create_covid_immunization_dict
@@ -32,8 +32,9 @@ class TestFhirRepositoryBase(unittest.TestCase):
 
     def setUp(self):
         super().setUp()
-        self.redis_patcher = patch("models.utils.validation_utils.redis_client")
-        self.mock_redis_client = self.redis_patcher.start()
+        self.mock_redis = Mock()
+        self.redis_getter_patcher = patch("common.models.utils.validation_utils.get_redis_client")
+        self.mock_redis_getter = self.redis_getter_patcher.start()
         self.logger_info_patcher = patch("logging.Logger.info")
         self.mock_logger_info = self.logger_info_patcher.start()
 
@@ -252,7 +253,8 @@ def test_create_immunization(self):
         imms = Immunization.parse_obj(create_covid_immunization_dict(imms_id=self._MOCK_CREATED_UUID))
 
         self.table.put_item = MagicMock(return_value={"ResponseMetadata": {"HTTPStatusCode": 200}})
-        self.mock_redis_client.hget.return_value = "COVID"
+        self.mock_redis.hget.return_value = "COVID"
+        self.mock_redis_getter.return_value = self.mock_redis
 
         created_id = self.repository.create_immunization(imms, "Test")
 

lambdas/backend/tests/service/test_fhir_service.py

@@ -14,16 +14,16 @@
 from authorisation.api_operation_code import ApiOperationCode
 from authorisation.authoriser import Authoriser
 from constants import NHS_NUMBER_USED_IN_SAMPLE_DATA
-from models.errors import (
+from common.models.errors import (
     CustomValidationError,
     IdentifierDuplicationError,
     InconsistentIdentifierError,
     InconsistentResourceVersion,
     ResourceNotFoundError,
     UnauthorizedVaxError,
 )
-from models.fhir_immunization import ImmunizationValidator
-from models.immunization_record_metadata import ImmunizationRecordMetadata
+from common.models.fhir_immunization import ImmunizationValidator
+from common.models.immunization_record_metadata import ImmunizationRecordMetadata
 from repository.fhir_repository import ImmunizationRepository
 from service.fhir_service import FhirService, get_service_url
 from testing_utils.generic_utils import load_json_data
@@ -40,8 +40,9 @@ class TestFhirServiceBase(unittest.TestCase):
 
     def setUp(self):
         super().setUp()
-        self.redis_patcher = patch("models.utils.validation_utils.redis_client")
-        self.mock_redis_client = self.redis_patcher.start()
+        self.mock_redis = Mock()
+        self.redis_getter_patcher = patch("common.models.utils.validation_utils.get_redis_client")
+        self.mock_redis_getter = self.redis_getter_patcher.start()
         self.logger_info_patcher = patch("logging.Logger.info")
         self.mock_logger_info = self.logger_info_patcher.start()
 
@@ -99,7 +100,8 @@ def tearDown(self):
     def test_get_immunization_by_id(self):
         """it should find an Immunization by id"""
         imms_id = "an-id"
-        self.mock_redis_client.hget.return_value = "COVID"
+        self.mock_redis.hget.return_value = "COVID"
+        self.mock_redis_getter.return_value = self.mock_redis
         self.authoriser.authorise.return_value = True
         self.imms_repo.get_immunization_and_resource_meta_by_id.return_value = (
             create_covid_immunization(imms_id).dict(),
@@ -140,7 +142,8 @@ def test_get_immunization_by_id_patient_not_restricted(self):
         imms_id = "non_restricted_id"
 
         immunization_data = load_json_data("completed_covid_immunization_event.json")
-        self.mock_redis_client.hget.return_value = "COVID"
+        self.mock_redis.hget.return_value = "COVID"
+        self.mock_redis_getter.return_value = self.mock_redis
         self.authoriser.authorise.return_value = True
         self.imms_repo.get_immunization_and_resource_meta_by_id.return_value = (
             immunization_data,
@@ -162,7 +165,8 @@ def test_get_immunization_by_id_patient_not_restricted(self):
     def test_unauthorised_error_raised_when_user_lacks_permissions(self):
         """it should throw an exception when user lacks permissions"""
         imms_id = "an-id"
-        self.mock_redis_client.hget.return_value = "COVID"
+        self.mock_redis.hget.return_value = "COVID"
+        self.mock_redis_getter.return_value = self.mock_redis
         self.authoriser.authorise.return_value = False
         self.imms_repo.get_immunization_and_resource_meta_by_id.return_value = (
             create_covid_immunization(imms_id).dict(),
@@ -288,7 +292,8 @@ def setUp(self):
 
     def test_create_immunization(self):
         """it should create Immunization and validate it"""
-        self.mock_redis_client.hget.return_value = "COVID"
+        self.mock_redis.hget.return_value = "COVID"
+        self.mock_redis_getter.return_value = self.mock_redis
         self.authoriser.authorise.return_value = True
         self.imms_repo.check_immunization_identifier_exists.return_value = False
         self.imms_repo.create_immunization.return_value = self._MOCK_NEW_UUID
@@ -338,7 +343,8 @@ def test_pre_validation_failed(self):
 
     def test_post_validation_failed_create_invalid_target_disease(self):
         """it should raise CustomValidationError for invalid target disease code on create"""
-        self.mock_redis_client.hget.return_value = None
+        self.mock_redis.hget.return_value = None
+        self.mock_redis_getter.return_value = self.mock_redis
         valid_imms = create_covid_immunization_dict_no_id(VALID_NHS_NUMBER)
 
         bad_target_disease_imms = deepcopy(valid_imms)
@@ -358,7 +364,8 @@ def test_post_validation_failed_create_invalid_target_disease(self):
 
     def test_post_validation_failed_create_missing_patient_name(self):
         """it should raise CustomValidationError for missing patient name on create"""
-        self.mock_redis_client.hget.return_value = "COVID"
+        self.mock_redis.hget.return_value = "COVID"
+        self.mock_redis_getter.return_value = self.mock_redis
         valid_imms = create_covid_immunization_dict_no_id(VALID_NHS_NUMBER)
 
         bad_patient_name_imms = deepcopy(valid_imms)
@@ -391,7 +398,8 @@ def test_patient_error(self):
 
     def test_unauthorised_error_raised_when_user_lacks_permissions(self):
         """it should raise error when user lacks permissions"""
-        self.mock_redis_client.hget.return_value = "COVID"
+        self.mock_redis.hget.return_value = "COVID"
+        self.mock_redis_getter.return_value = self.mock_redis
         self.authoriser.authorise.return_value = False
         self.imms_repo.create_immunization.return_value = create_covid_immunization_dict_no_id()
 
@@ -409,7 +417,8 @@ def test_unauthorised_error_raised_when_user_lacks_permissions(self):
 
     def test_raises_duplicate_error_if_identifier_already_exits(self):
         """it should raise a duplicate error if the immunisation identifier (system + local ID) already exists"""
-        self.mock_redis_client.hget.return_value = "COVID"
+        self.mock_redis.hget.return_value = "COVID"
+        self.mock_redis_getter.return_value = self.mock_redis
         self.authoriser.authorise.return_value = True
         self.imms_repo.check_immunization_identifier_exists.return_value = True
 
@@ -441,7 +450,8 @@ def setUp(self):
         self.authoriser = create_autospec(Authoriser)
         self.imms_repo = create_autospec(ImmunizationRepository)
         self.fhir_service = FhirService(self.imms_repo, self.authoriser)
-        self.mock_redis_client.hget.return_value = "COVID"
+        self.mock_redis.hget.return_value = "COVID"
+        self.mock_redis_getter.return_value = self.mock_redis
 
     def test_update_immunization(self):
         """it should update Immunization and validate NHS number"""
@@ -588,7 +598,8 @@ def setUp(self):
     def test_delete_immunization(self):
         """it should delete Immunization record"""
         imms = json.loads(create_covid_immunization(self.TEST_IMMUNISATION_ID).json())
-        self.mock_redis_client.hget.return_value = "COVID"
+        self.mock_redis.hget.return_value = "COVID"
+        self.mock_redis_getter.return_value = self.mock_redis
         self.authoriser.authorise.return_value = True
         self.imms_repo.get_immunization_and_resource_meta_by_id.return_value = (
             imms,
@@ -621,7 +632,8 @@ def test_delete_immunization_throws_authorisation_exception_if_does_not_have_req
     ):
         """it should raise an UnauthorizedVaxError when the client does not have permissions for the given vacc type"""
         imms = json.loads(create_covid_immunization(self.TEST_IMMUNISATION_ID).json())
-        self.mock_redis_client.hget.return_value = "FLU"
+        self.mock_redis.hget.return_value = "FLU"
+        self.mock_redis_getter.return_value = self.mock_redis
         self.authoriser.authorise.return_value = False
         self.imms_repo.get_immunization_and_resource_meta_by_id.return_value = (
             imms,