Merge pull request #46 from NHSDigital/AMB-1744-complete-read-endpoint

Amb 1744 complete read endpoint

Author: ewan-IW

lambda_code/Makefile

@@ -6,6 +6,6 @@ package: build
 	docker run --rm -v $(shell pwd)/build:/build imms-lambda-build
 
 test:
-	python -m unittest
+	DYNAMODB_TABLE_NAME=example-table python -m unittest
 
 .PHONY: build package test

lambda_code/entrypoint.sh

@@ -5,6 +5,7 @@ cd /lambda_test || exit 2
 echo "Installing dependencies for test..."
 pip install -q -r requirements.txt
 echo "Running unit tests"
+export DYNAMODB_TABLE_NAME=example_table
 python -m unittest
 
 cd /lambda_package || exit 2

lambda_code/src/dynamodb.py

@@ -7,7 +7,7 @@
 
 class EventTable:
     def __init__(self, table_name=os.environ["DYNAMODB_TABLE_NAME"], endpoint_url=None):
-        db = boto3.resource("dynamodb", endpoint_url=endpoint_url)
+        db = boto3.resource("dynamodb", endpoint_url=endpoint_url, region_name='eu-west-2')
         self.table = db.Table(table_name)
 
     def get_event_by_id(self, event_id):

lambda_code/src/get_imms_handler.py

@@ -1,17 +1,77 @@
+import uuid
+
 from dynamodb import EventTable
 import json
+import re
+
+
+def create_response(event_id, message, code):
+    return {
+        "resourceType": "OperationOutcome",
+        "id": event_id,
+        "meta": {
+            "profile": [
+                "https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome"
+            ]
+        },
+        "issue": [
+            {
+                "severity": "error",
+                "code": code,
+                "details": {
+                    "coding": [
+                        {
+                            "system": "https://fhir.nhs.uk/Codesystem/http-error-codes",
+                            "code": code.upper()
+                        }
+                    ]
+                },
+                "diagnostics": message
+            }
+        ]
+    }
 
 
 def get_imms_handler(event, context):
-    event_body = json.dumps(event)
-    print(event_body)
-    event_id = event["pathParameters"]["id"]
     dynamo_service = EventTable()
+    return get_imms(event, dynamo_service)
+
+
+# create function which receives event and instance of dynamodb
+def get_imms(event, dynamo_service):
+    event_id = event["pathParameters"]["id"]
+
+    def is_valid_id(_event_id):
+        pattern = r'^[A-Za-z0-9\-.]{1,64}$'
+        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)
-    response = {
-        "statusCode": 200,  # HTTP status code
-        "body": json.dumps({
-            "message": message  
-        })
+    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)
     }
-    return response

lambda_code/tests/test_get_imms.py

@@ -0,0 +1,64 @@
+import uuid
+from unittest.mock import MagicMock
+import unittest
+import json
+import sys
+import os
+
+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
+
+
+class TestGetImms(unittest.TestCase):
+    def setUp(self):
+        self.dynamodb_service = EventTable()
+
+    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"}}
+
+        # Act
+        result = get_imms(formatted_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.assertEquals(result['headers']['Content-Type'], "application/fhir+json")
+        assert json.loads(result['body']) == {"message": "Mocked event data"}
+
+    def test_get_imms_handler_sad_path_400(self):
+        unformatted_event = {"pathParameters": {"id": "unexpected_id"}}
+
+        # Act
+        result = get_imms(unformatted_event, None)
+
+        # Assert
+        assert result['statusCode'] == 400
+        self.assertEquals(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")
+        act_body["id"] = None
+        exp_body["id"] = None
+        self.assertDictEqual(act_body, exp_body)
+
+    def test_get_imms_handler_sad_path_404(self):
+        # Arrange
+        self.dynamodb_service.get_event_by_id = MagicMock(return_value=None)
+        incorrect_event = {"pathParameters": {"id": "incorrectid"}}
+
+        # Act
+        result = get_imms(incorrect_event, self.dynamodb_service)
+
+        # Assert
+        assert result['statusCode'] == 404
+        self.assertEquals(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")
+        act_body["id"] = None
+        exp_body["id"] = None
+        self.assertDictEqual(act_body, exp_body)

openapi.json

@@ -18,7 +18,7 @@ paths:
         '201':
           description: Get status
           content:
-            application/json:
+            application/fhir+json:
               schema:
                 type: object
 
@@ -35,7 +35,7 @@ paths:
         '200':
           description: An Immunisation get event
           content:
-            application/json:
+            application/fhir+json:
               schema:
                 type: object
     delete:
@@ -50,7 +50,7 @@ paths:
         '200':
           description: An Immunisation delete event
           content:
-            application/json:
+            application/fhir+json:
               schema:
                 type: object
 
@@ -77,7 +77,7 @@ paths:
         '201':
           description: An Immunisation search event
           content:
-            application/json:
+            application/fhir+json:
               schema:
                 type: object
     post:
@@ -92,7 +92,7 @@ paths:
         '201':
           description: An Immunisation post event
           content:
-            application/json:
+            application/fhir+json:
               schema:
                 type: object
   /{proxy+}:
@@ -114,6 +114,6 @@ paths:
         '404':
           description: Not Found
           content:
-            application/json:
+            application/fhir+json:
               schema:
                 type: object

terraform/.terraform.lock.hcl

@@ -24,7 +24,6 @@ def test_invalid_access_token():
 
 
 @pytest.mark.auth
-@pytest.mark.debug
 @pytest.mark.nhsd_apim_authorization(
     {
         "access": "healthcare_worker",