Address review round 2 comments

Author: edhall-nhs

lambdas/backend/src/controller/fhir_api_exception_handler.py

@@ -9,7 +9,7 @@
     CustomValidationError,
     IdentifierDuplicationError,
     InconsistentIdentifierError,
-    InconsistentResourceVersion,
+    InconsistentResourceVersionError,
     ResourceNotFoundError,
 )
 from constants import GENERIC_SERVER_ERROR_DIAGNOSTICS_MESSAGE
@@ -30,7 +30,7 @@
 )
 
 _CUSTOM_EXCEPTION_TO_STATUS_MAP: dict[Type[Exception], int] = {
-    InconsistentResourceVersion: 400,
+    InconsistentResourceVersionError: 400,
     InconsistentIdentifierError: 400,  # Identifier refers to the local FHIR identifier composed of system and value.
     InconsistentIdError: 400,  # ID refers to the top-level ID of the FHIR resource.
     InvalidImmunizationIdError: 400,

lambdas/backend/tests/controller/test_fhir_api_exception_handler.py

@@ -6,7 +6,7 @@
     CustomValidationError,
     IdentifierDuplicationError,
     InconsistentIdentifierError,
-    InconsistentResourceVersion,
+    InconsistentResourceVersionError,
     ResourceNotFoundError,
 )
 from controller.fhir_api_exception_handler import fhir_api_exception_handler
@@ -44,7 +44,7 @@ def test_exception_handler_handles_custom_exception_and_returns_fhir_response(se
         """Test that custom exceptions are handled by the wrapper and a valid response is returned to the client"""
         test_cases = [
             (
-                InconsistentResourceVersion("Resource versions do not match"),
+                InconsistentResourceVersionError("Resource versions do not match"),
                 400,
                 "invariant",
                 "Resource versions do not match",

lambdas/backend/tests/service/test_fhir_service.py

@@ -18,7 +18,7 @@
     CustomValidationError,
     IdentifierDuplicationError,
     InconsistentIdentifierError,
-    InconsistentResourceVersion,
+    InconsistentResourceVersionError,
     ResourceNotFoundError,
 )
 from common.models.fhir_immunization import ImmunizationValidator
@@ -612,7 +612,7 @@ def test_update_immunization_raises_invalid_error_if_resource_version_does_not_m
         self.authoriser.authorise.return_value = True
 
         # When
-        with self.assertRaises(InconsistentResourceVersion) as error:
+        with self.assertRaises(InconsistentResourceVersionError) as error:
             self.fhir_service.update_immunization(imms_id, updated_immunisation, "Test", 2)
 
         # Then

lambdas/backend/tests/test_errors.py

@@ -177,3 +177,18 @@ def test_errors_unhandled_response_error(self):
         self.assertEqual(issue.get("severity"), errors.Severity.error)
         self.assertEqual(issue.get("code"), errors.Code.server_error)
         self.assertEqual(issue.get("diagnostics"), f"{test_message}\n{test_response}")
+
+    def test_errors_invalid_stored_data_error(self):
+        """Test correct operation of UnhandledResponseError"""
+        test_data_type = "test_data_type"
+
+        with self.assertRaises(errors.InvalidStoredDataError) as context:
+            raise errors.InvalidStoredDataError(test_data_type)
+
+        self.assertEqual(str(context.exception), f"Invalid data stored for immunization record: {test_data_type}")
+        outcome = context.exception.to_operation_outcome()
+        self.assert_operation_outcome(outcome)
+        issue = outcome.get("issue")[0]
+        self.assertEqual(issue.get("severity"), errors.Severity.error)
+        self.assertEqual(issue.get("code"), errors.Code.server_error)
+        self.assertEqual(issue.get("diagnostics"), f"Invalid data stored for immunization record: {test_data_type}")

lambdas/shared/src/common/models/errors.py

@@ -83,7 +83,7 @@ def to_operation_outcome(self) -> dict:
 
 
 @dataclass
-class InconsistentResourceVersion(ApiValidationError):
+class InconsistentResourceVersionError(ApiValidationError):
     """Use this when the resource version in the request and actual resource version do not match"""
 
     message: str

lambdas/shared/src/common/models/utils/validation_utils.py

@@ -3,7 +3,7 @@
 from fhir.resources.R4B.identifier import Identifier
 
 from common.models.constants import Constants, Urls
-from common.models.errors import InconsistentIdentifierError, InconsistentResourceVersion, MandatoryError
+from common.models.errors import InconsistentIdentifierError, InconsistentResourceVersionError, MandatoryError
 from common.models.field_names import FieldNames
 from common.models.obtain_field_value import ObtainFieldValue
 from common.models.utils.base_utils import obtain_field_location
@@ -106,12 +106,12 @@ def validate_resource_versions_match(
     """Checks if the resource version in the request and the resource version of the actual Immunization record matches.
     Raises a InconsistentResourceVersion if they do not match."""
     if actual_resource_version > resource_version_in_request:
-        raise InconsistentResourceVersion(
+        raise InconsistentResourceVersionError(
             f"Validation errors: The requested immunization resource {imms_id} has changed since the last retrieve."
         )
 
     if actual_resource_version < resource_version_in_request:
-        raise InconsistentResourceVersion(
+        raise InconsistentResourceVersionError(
             f"Validation errors: The requested immunization resource {imms_id} version is inconsistent with the "
             f"existing version."
         )

lambdas/shared/tests/test_common/models/utils/test_validation_utils.py

@@ -4,7 +4,7 @@
 from fhir.resources.R4B.identifier import Identifier
 from jsonpath_ng.ext import parse
 
-from common.models.errors import InconsistentIdentifierError, InconsistentResourceVersion
+from common.models.errors import InconsistentIdentifierError, InconsistentResourceVersionError
 from common.models.fhir_immunization import ImmunizationValidator
 from common.models.obtain_field_value import ObtainFieldValue
 from common.models.utils.generic_utils import (
@@ -299,7 +299,7 @@ def test_validate_resource_versions_match_raises_error_when_versions_do_not_matc
 
         for actual_version, expected_error in test_cases:
             with self.subTest(actual_version=actual_version, expected_error=expected_error):
-                with self.assertRaises(InconsistentResourceVersion) as error:
+                with self.assertRaises(InconsistentResourceVersionError) as error:
                     validate_resource_versions_match(3, actual_version, "12345-id")
 
                 self.assertEqual(str(error.exception), expected_error)

lambdas/shared/tests/test_common/test_errors.py

@@ -101,8 +101,8 @@ def test_errors_inconsistent_resource_version(self):
         """Test correct operation of InconsistentResourceVersion"""
         test_message = "test_message"
 
-        with self.assertRaises(errors.InconsistentResourceVersion) as context:
-            raise errors.InconsistentResourceVersion(test_message)
+        with self.assertRaises(errors.InconsistentResourceVersionError) as context:
+            raise errors.InconsistentResourceVersionError(test_message)
         self.assertEqual(context.exception.message, test_message)
 
         outcome = context.exception.to_operation_outcome()