AMB-1741 move create_response out and test it separately

Author: artronics

lambda_code/src/get_imms_handler.py

@@ -1,11 +1,12 @@
+import json
+import re
 import uuid
 
 from dynamodb import EventTable
-import json
-import re
+from immunisation_api import create_response
 
 
-def create_response(event_id, message, code):
+def create_operation_outcome(event_id, message, code):
     return {
         "resourceType": "OperationOutcome",
         "id": event_id,
@@ -46,32 +47,16 @@ def is_valid_id(_event_id):
         return re.match(pattern, _event_id) is not None
 
     if not is_valid_id(event_id) or not event_id:
-        return {
-            "statusCode": 400,
-            "headers": {
-                "Content-Type": "application/fhir+json",
-            },
-            "body": json.dumps(
-                create_response(str(uuid.uuid4()),
-                                "he provided event ID is either missing or not in the expected format.",
-                                "invalid"))
-        }
-
-    message = dynamo_service.get_event_by_id(event_id)
-    if message is None:
-
-        return {
-            "statusCode": 404,
-            "headers": {
-                "Content-Type": "application/fhir+json",
-            },
-            "body": json.dumps(create_response(str(uuid.uuid4()), "The requested resource was not found.", "not-found"))
-        }
-
-    return {
-        'statusCode': 200,
-        "headers": {
-            "Content-Type": "application/fhir+json",
-        },
-        'body': json.dumps(message)
-    }
+        body = json.dumps(
+            create_operation_outcome(str(uuid.uuid4()),
+                                     "he provided event ID is either missing or not in the expected format.",
+                                     "invalid"))
+        return create_response(400, body)
+
+    query_result = dynamo_service.get_event_by_id(event_id)
+    if query_result is None:
+        body = json.dumps(
+            create_operation_outcome(str(uuid.uuid4()), "The requested resource was not found.", "not-found"))
+        return create_response(404, body)
+
+    return create_response(200, json.dumps(query_result))

lambda_code/src/immunisation_api.py

@@ -1,6 +1,16 @@
 import requests
 
 
+def create_response(status_code, body):
+    return {
+        "statusCode": status_code,
+        "headers": {
+            "Content-Type": "application/fhir+json",
+        },
+        "body": body
+    }
+
+
 class ImmunisationApi:
     def __init__(self, url):
         self.url = url

lambda_code/src/models/errors.py

@@ -9,51 +9,38 @@ class Severity(str, Enum):
 
 
 class Code(str, Enum):
-    not_found = "NOT_FOUND"
+    not_found = "not_found"
 
 
-# @dataclass
-class ApiError(BaseModel):
+class ApiError(BaseModel, use_enum_values=True):
     id: str
     severity: Severity
     code: Code
     diagnostics: str
 
-
-base_model = {
-    "resourceType": "OperationOutcome",
-    "id": None,
-    "meta": {
-        "profile": [
-            "https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome"
-        ]
-    },
-    "issue": [
-        {
-            "severity": None,
-            "code": None,
-            "details": {
-                "coding": [
-                    {
-                        "system": "https://fhir.nhs.uk/Codesystem/http-error-codes",
-                        "code": None
-                    }
+    def to_uk_core(self) -> OperationOutcome:
+        model = {
+            "resourceType": "OperationOutcome",
+            "id": self.id,
+            "meta": {
+                "profile": [
+                    "https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome"
                 ]
             },
-            "diagnostics": None
+            "issue": [
+                {
+                    "severity": self.severity,
+                    "code": self.code,
+                    "details": {
+                        "coding": [
+                            {
+                                "system": "https://fhir.nhs.uk/Codesystem/http-error-codes",
+                                "code": self.code.upper()
+                            }
+                        ]
+                    },
+                    "diagnostics": self.diagnostics
+                }
+            ]
         }
-    ]
-}
-
-
-class ApiErrors:
-    @staticmethod
-    def event_not_found(error: ApiError) -> OperationOutcome:
-        op = OperationOutcome.parse_obj(base_model, "fd")
-        # op = OperationOutcome.construct()
-        # op.id = error_id
-        # issue = OperationOutcomeIssue.construct()
-        # issue.severity = "error"
-        # issue.code = "not_found"
-        # op.issue = issue
-        return op
+        return OperationOutcome.parse_obj(model)

lambda_code/tests/test_api_errors.py

@@ -4,11 +4,24 @@
 
 sys.path.append(f"{os.path.dirname(os.path.abspath(__file__))}/../src")
 
-from models.errors import ApiError, Severity, Code
+from models.errors import  ApiError, Severity, Code
 
 
 class TestApiErrors(unittest.TestCase):
-    def test_event_not_found(self):
-        a = ApiError(id="foo", severity=Severity.error, code=Code.not_found, diagnostics="bad thing happened")
-        print(a.dict())
-        # print(ApiErrors.event_not_found("foo").json())
+    def test_error_to_uk_core(self):
+        code = Code.not_found
+        severity = Severity.error
+        diag = "a-diagnostic"
+        error_id = "a-id"
+
+        api_error = ApiError(id=error_id, severity=severity, code=code, diagnostics=diag)
+        error = api_error.to_uk_core().dict()
+
+        issue = error["issue"][0]
+        self.assertEqual(error["id"], error_id)
+        self.assertEqual(issue["code"], "not_found")
+        self.assertEqual(issue["severity"], "error")
+        self.assertEqual(issue["diagnostics"], diag)
+        self.assertEqual(issue["details"]["coding"][0]["code"], "NOT_FOUND")
+
+

lambda_code/tests/test_get_imms.py

@@ -8,7 +8,7 @@
 sys.path.append(f"{os.path.dirname(os.path.abspath(__file__))}/../src")
 
 from dynamodb import EventTable
-from get_imms_handler import get_imms, create_response
+from get_imms_handler import get_imms, create_operation_outcome
 
 
 class TestGetImms(unittest.TestCase):
@@ -18,16 +18,16 @@ def setUp(self):
     def test_get_imms_happy_path(self):
         # Arrange
         self.dynamodb_service.get_event_by_id = MagicMock(return_value={"message": "Mocked event data"})
-        formatted_event = {"pathParameters": {"id": "sampleid"}}
+        lambda_event = {"pathParameters": {"id": "sample-id"}}
 
         # Act
-        result = get_imms(formatted_event, self.dynamodb_service)
+        result = get_imms(lambda_event, self.dynamodb_service)
 
         # Assert
-        self.dynamodb_service.get_event_by_id.assert_called_once_with(formatted_event["pathParameters"]["id"])
-        assert result['statusCode'] == 200
+        self.dynamodb_service.get_event_by_id.assert_called_once_with(lambda_event["pathParameters"]["id"])
+        self.assertEqual(result['statusCode'], 200)
         self.assertEqual(result['headers']['Content-Type'], "application/fhir+json")
-        assert json.loads(result['body']) == {"message": "Mocked event data"}
+        self.assertDictEqual(json.loads(result['body']), {"message": "Mocked event data"})
 
     def test_get_imms_handler_sad_path_400(self):
         unformatted_event = {"pathParameters": {"id": "unexpected_id"}}
@@ -39,9 +39,9 @@ def test_get_imms_handler_sad_path_400(self):
         assert result['statusCode'] == 400
         self.assertEqual(result['headers']['Content-Type'], "application/fhir+json")
         act_body = json.loads(result['body'])
-        exp_body = create_response(str(uuid.uuid4()),
-                                   "he provided event ID is either missing or not in the expected format.",
-                                   "invalid")
+        exp_body = create_operation_outcome(str(uuid.uuid4()),
+                                            "he provided event ID is either missing or not in the expected format.",
+                                            "invalid")
         act_body["id"] = None
         exp_body["id"] = None
         self.assertDictEqual(act_body, exp_body)
@@ -58,7 +58,7 @@ def test_get_imms_handler_sad_path_404(self):
         assert result['statusCode'] == 404
         self.assertEqual(result['headers']['Content-Type'], "application/fhir+json")
         act_body = json.loads(result['body'])
-        exp_body = create_response(str(uuid.uuid4()), "The requested resource was not found.", "not-found")
+        exp_body = create_operation_outcome(str(uuid.uuid4()), "The requested resource was not found.", "not-found")
         act_body["id"] = None
         exp_body["id"] = None
         self.assertDictEqual(act_body, exp_body)

…mbda_code/tests/test_imms_api_service.py …mbda_code/tests/test_immunisation_api.pylambda_code/tests/test_imms_api_service.py renamed to lambda_code/tests/test_immunisation_api.py lambda_code/tests/test_imms_api_service.py renamed to lambda_code/tests/test_immunisation_api.py

@@ -7,7 +7,19 @@
 
 sys.path.append(f"{os.path.dirname(os.path.abspath(__file__))}/../src")
 
-from immunisation_api import ImmunisationApi
+from immunisation_api import ImmunisationApi, create_response
+
+
+class TestRequestResponseHelpers(unittest.TestCase):
+    def test_create_response(self):
+        res = create_response(42, "a body")
+        headers = res["headers"]
+        self.assertEqual(res["statusCode"], 42)
+
+        self.assertDictEqual(headers, {
+            "Content-Type": "application/fhir+json",
+        })
+        self.assertEqual(res["body"], "a body")
 
 
 class TestImmsApiService(unittest.TestCase):