Merge pull request #31 from NHSDigital/AMB-1708-status-endpoint

AMB-1708 Adding status endpoint to back end lambda

Author: ewan-IW

lambda_typescript/src/index.ts

@@ -1,18 +1,28 @@
 import { DynamoDB } from 'aws-sdk';
 
+
 const dynamoDB = new DynamoDB.DocumentClient();
 
 export const handler = async (event: any): Promise<any> => {
+
   const operation = event.httpMethod;
   const dynamoDBTableName = process.env.DYNAMODB_TABLE_NAME || 'DefaultTableName';
-  
-  if (operation === 'POST' && event.path === '/event') {
+
+  if (event.path === '/_status' && operation === 'GET') {
+    const statusResponse = {
+      status: 'healthy',
+      message: 'Backend is up and running.',
+    };
+    return {
+      statusCode: 200,
+      body: JSON.stringify(statusResponse),
+    };
+  } else if (operation === 'POST' && event.path === '/event') {
     // Handle the POST request to create a new item
     const params = {
       TableName: dynamoDBTableName,
       Item: JSON.parse(event.body),
     };
-
     try {
       await dynamoDB.put(params).promise();
       return {
@@ -34,7 +44,6 @@ export const handler = async (event: any): Promise<any> => {
         id: event.queryStringParameters.id,
       },
     };
-
     try {
       const data = await dynamoDB.get(params).promise();
       if (!data.Item) {
@@ -63,7 +72,6 @@ export const handler = async (event: any): Promise<any> => {
         id: event.queryStringParameters.id,
       },
     };
-
     try {
         const data = await dynamoDB.get(params).promise();
         if (!data.Item) {
@@ -87,7 +95,6 @@ export const handler = async (event: any): Promise<any> => {
       };
     }
   }
-
   return {
     statusCode: 400,
     body: JSON.stringify('Invalid operation.'),

proxies/live/apiproxy/policies/ServiceCallout.CallHealthcheckEndpoint.xml

@@ -16,7 +16,7 @@
 <!--        <Path>/_ping</Path>-->
 <!--    </HTTPTargetConnection>-->
     <HTTPTargetConnection>
-        <URL>http://mocktarget.apigee.net</URL>
+        <URL>{{ DOMAIN_ENDPOINT }}/_status</URL>
         <Properties>
             <Property name="supports.http10">true</Property>
             <Property name="request.retain.headers">User-Agent,Referer,Accept-Language</Property>

proxies/live/apiproxy/proxies/default.xml

@@ -6,7 +6,7 @@
       </Step>
     </Request>
   </PreFlow>
-
+  
   <Flows>
     <Flow name="OptionsPreFlight">
       <Request/>

terraform/api_gateway/api.tf

@@ -39,18 +39,15 @@ resource "aws_apigatewayv2_domain_name" "service_api_domain_name" {
     endpoint_type   = "REGIONAL"
     security_policy = "TLS_1_2"
   }
-
   tags = {
     Name = "${var.prefix}-api-domain-name"
   }
 }
-
 resource "aws_apigatewayv2_api_mapping" "api_mapping" {
   api_id      = aws_apigatewayv2_api.service_api.id
   domain_name = aws_apigatewayv2_domain_name.service_api_domain_name.id
   stage       = aws_apigatewayv2_stage.default.id
 }
-
 resource "aws_lambda_permission" "api_gw" {
   statement_id  = "AllowExecutionFromAPIGateway"
   action        = "lambda:InvokeFunction"
@@ -86,6 +83,15 @@ resource "aws_route53_record" "api_domain" {
     zone_id                = aws_apigatewayv2_domain_name.service_api_domain_name.domain_name_configuration[0].hosted_zone_id
   }
 }
+data "aws_lambda_function" "status_lambda" {
+  function_name = var.lambda_name
+}
+resource "aws_apigatewayv2_integration" "status_integration" {
+  api_id             = aws_apigatewayv2_api.service_api.id
+  integration_uri    = data.aws_lambda_function.status_lambda.invoke_arn
+  integration_type   = "AWS_PROXY"
+  integration_method = "POST"
+}
 
 output "service_domain_name" {
   value = aws_apigatewayv2_api_mapping.api_mapping.domain_name

tests/test_lambda.py

@@ -1,11 +1,5 @@
-"""
-See
-https://github.com/NHSDigital/pytest-nhsd-apim/blob/main/tests/test_examples.py
-for more ideas on how to test the authorization of your API.
-"""
 import random
 import time
-
 import pytest
 import requests
 from assertpy import assert_that
@@ -18,7 +12,9 @@ def lambda_crud(url, headers):
 
     request_payload = {
         "id": event_id,
-        "message": "Hello World"}
+        "message": "Hello World"
+    }
+
     post_response = requests.post(
         url=f"{url}/event",
         headers=headers,
@@ -61,8 +57,11 @@ def test_lambda_crud_nhs_login(nhsd_apim_proxy_url, nhsd_apim_auth_headers):
 
 
 @pytest.mark.smoketest
-@pytest.mark.debug
-@pytest.mark.nhsd_apim_authorization({"access": "application", "level": "level3"})
+@pytest.mark.nhsd_apim_authorization(
+    {
+        "access": "application",
+        "level": "level3"
+     })
 def test_lambda_crud_app_restricted(nhsd_apim_proxy_url, nhsd_apim_auth_headers):
     """
     Test for the POST,GET and Delete for Lambda endpoints. Using app-restricted