CCM-12875: Added toggle for mock in environments

Author: ScottFullerton-NHSE

infrastructure/terraform/components/dl/README.md

@@ -17,6 +17,7 @@ No requirements.
 | <a name="input_component"></a> [component](#input\_component) | The variable encapsulating the name of this component | `string` | `"dl"` | no |
 | <a name="input_default_tags"></a> [default\_tags](#input\_default\_tags) | A map of default tags to apply to all taggable resources within the component | `map(string)` | `{}` | no |
 | <a name="input_enable_dynamodb_delete_protection"></a> [enable\_dynamodb\_delete\_protection](#input\_enable\_dynamodb\_delete\_protection) | Enable DynamoDB Delete Protection on all Tables | `bool` | `true` | no |
+| <a name="input_enable_pdm_mock"></a> [enable\_pdm\_mock](#input\_enable\_pdm\_mock) | Flag indicating whether to deploy PDM mock API (should be false in production environments) | `bool` | `true` | no |
 | <a name="input_environment"></a> [environment](#input\_environment) | The name of the tfscaffold environment | `string` | n/a | yes |
 | <a name="input_force_destroy"></a> [force\_destroy](#input\_force\_destroy) | Flag to force deletion of S3 buckets | `bool` | `false` | no |
 | <a name="input_force_lambda_code_deploy"></a> [force\_lambda\_code\_deploy](#input\_force\_lambda\_code\_deploy) | If the lambda package in s3 has the same commit id tag as the terraform build branch, the lambda will not update automatically. Set to True if making changes to Lambda code from on the same commit for example during development | `bool` | `false` | no |
@@ -57,8 +58,8 @@ No requirements.
 | Name | Description |
 |------|-------------|
 | <a name="output_deployment"></a> [deployment](#output\_deployment) | Deployment details used for post-deployment scripts |
-| <a name="output_pdm_mock_lambda_endpoint"></a> [pdm\_mock\_lambda\_endpoint](#output\_pdm\_mock\_lambda\_endpoint) | The base URL of the PDM Mock Lambda |
-| <a name="output_pdm_mock_lambda_id"></a> [pdm\_mock\_lambda\_id](#output\_pdm\_mock\_lambda\_id) | The ID of the PDM Mock Lambda API Gateway |
+| <a name="output_pdm_mock_lambda_endpoint"></a> [pdm\_mock\_lambda\_endpoint](#output\_pdm\_mock\_lambda\_endpoint) | The base URL of the PDM Mock Lambda (null when not deployed) |
+| <a name="output_pdm_mock_lambda_id"></a> [pdm\_mock\_lambda\_id](#output\_pdm\_mock\_lambda\_id) | The ID of the PDM Mock Lambda API Gateway (null when not deployed) |
 <!-- vale on -->
 <!-- markdownlint-enable -->
 <!-- END_TF_DOCS -->

infrastructure/terraform/components/dl/apigateway_pdm_mock.tf

@@ -1,4 +1,6 @@
 resource "aws_api_gateway_rest_api" "pdm_mock" {
+  count = local.deploy_pdm_mock ? 1 : 0
+
   name        = "${var.project}-${var.environment}-pdm-mock-lambda"
   description = "PDM Mock API for testing integration with Patient Data Manager"
 
@@ -15,97 +17,119 @@ resource "aws_api_gateway_rest_api" "pdm_mock" {
 }
 
 resource "aws_api_gateway_resource" "patient_data_manager" {
-  rest_api_id = aws_api_gateway_rest_api.pdm_mock.id
-  parent_id   = aws_api_gateway_rest_api.pdm_mock.root_resource_id
+  count = local.deploy_pdm_mock ? 1 : 0
+
+  rest_api_id = aws_api_gateway_rest_api.pdm_mock[0].id
+  parent_id   = aws_api_gateway_rest_api.pdm_mock[0].root_resource_id
   path_part   = "patient-data-manager"
 }
 
 resource "aws_api_gateway_resource" "fhir" {
-  rest_api_id = aws_api_gateway_rest_api.pdm_mock.id
-  parent_id   = aws_api_gateway_resource.patient_data_manager.id
+  count = local.deploy_pdm_mock ? 1 : 0
+
+  rest_api_id = aws_api_gateway_rest_api.pdm_mock[0].id
+  parent_id   = aws_api_gateway_resource.patient_data_manager[0].id
   path_part   = "FHIR"
 }
 
 resource "aws_api_gateway_resource" "r4" {
-  rest_api_id = aws_api_gateway_rest_api.pdm_mock.id
-  parent_id   = aws_api_gateway_resource.fhir.id
+  count = local.deploy_pdm_mock ? 1 : 0
+
+  rest_api_id = aws_api_gateway_rest_api.pdm_mock[0].id
+  parent_id   = aws_api_gateway_resource.fhir[0].id
   path_part   = "R4"
 }
 
 resource "aws_api_gateway_resource" "document_reference" {
-  rest_api_id = aws_api_gateway_rest_api.pdm_mock.id
-  parent_id   = aws_api_gateway_resource.r4.id
+  count = local.deploy_pdm_mock ? 1 : 0
+
+  rest_api_id = aws_api_gateway_rest_api.pdm_mock[0].id
+  parent_id   = aws_api_gateway_resource.r4[0].id
   path_part   = "DocumentReference"
 }
 
 resource "aws_api_gateway_resource" "document_reference_id" {
-  rest_api_id = aws_api_gateway_rest_api.pdm_mock.id
-  parent_id   = aws_api_gateway_resource.document_reference.id
+  count = local.deploy_pdm_mock ? 1 : 0
+
+  rest_api_id = aws_api_gateway_rest_api.pdm_mock[0].id
+  parent_id   = aws_api_gateway_resource.document_reference[0].id
   path_part   = "{id}"
 }
 
 resource "aws_api_gateway_method" "create_document_reference" {
-  rest_api_id   = aws_api_gateway_rest_api.pdm_mock.id
-  resource_id   = aws_api_gateway_resource.document_reference.id
+  count = local.deploy_pdm_mock ? 1 : 0
+
+  rest_api_id   = aws_api_gateway_rest_api.pdm_mock[0].id
+  resource_id   = aws_api_gateway_resource.document_reference[0].id
   http_method   = "POST"
   authorization = "AWS_IAM"
 }
 
 resource "aws_api_gateway_integration" "create_document_reference" {
-  rest_api_id = aws_api_gateway_rest_api.pdm_mock.id
-  resource_id = aws_api_gateway_resource.document_reference.id
-  http_method = aws_api_gateway_method.create_document_reference.http_method
+  count = local.deploy_pdm_mock ? 1 : 0
+
+  rest_api_id = aws_api_gateway_rest_api.pdm_mock[0].id
+  resource_id = aws_api_gateway_resource.document_reference[0].id
+  http_method = aws_api_gateway_method.create_document_reference[0].http_method
 
   integration_http_method = "POST"
   type                    = "AWS_PROXY"
-  uri                     = module.pdm_mock_lambda.function_invoke_arn
+  uri                     = module.pdm_mock_lambda[0].function_invoke_arn
 }
 
 resource "aws_api_gateway_method" "get_document_reference" {
-  rest_api_id   = aws_api_gateway_rest_api.pdm_mock.id
-  resource_id   = aws_api_gateway_resource.document_reference_id.id
+  count = local.deploy_pdm_mock ? 1 : 0
+
+  rest_api_id   = aws_api_gateway_rest_api.pdm_mock[0].id
+  resource_id   = aws_api_gateway_resource.document_reference_id[0].id
   http_method   = "GET"
   authorization = "AWS_IAM"
 }
 
 resource "aws_api_gateway_integration" "get_document_reference" {
-  rest_api_id = aws_api_gateway_rest_api.pdm_mock.id
-  resource_id = aws_api_gateway_resource.document_reference_id.id
-  http_method = aws_api_gateway_method.get_document_reference.http_method
+  count = local.deploy_pdm_mock ? 1 : 0
+
+  rest_api_id = aws_api_gateway_rest_api.pdm_mock[0].id
+  resource_id = aws_api_gateway_resource.document_reference_id[0].id
+  http_method = aws_api_gateway_method.get_document_reference[0].http_method
 
   integration_http_method = "POST"
   type                    = "AWS_PROXY"
-  uri                     = module.pdm_mock_lambda.function_invoke_arn
+  uri                     = module.pdm_mock_lambda[0].function_invoke_arn
 }
 
 resource "aws_lambda_permission" "pdm_mock_lambda_gateway" {
+  count = local.deploy_pdm_mock ? 1 : 0
+
   statement_id  = "AllowAPIGatewayInvoke"
   action        = "lambda:InvokeFunction"
-  function_name = module.pdm_mock_lambda.function_name
+  function_name = module.pdm_mock_lambda[0].function_name
   principal     = "apigateway.amazonaws.com"
 
-  source_arn = "${aws_api_gateway_rest_api.pdm_mock.execution_arn}/*/*"
+  source_arn = "${aws_api_gateway_rest_api.pdm_mock[0].execution_arn}/*/*"
 }
 
 resource "aws_api_gateway_deployment" "pdm_mock" {
+  count = local.deploy_pdm_mock ? 1 : 0
+
   depends_on = [
     aws_api_gateway_integration.create_document_reference,
     aws_api_gateway_integration.get_document_reference,
   ]
 
-  rest_api_id = aws_api_gateway_rest_api.pdm_mock.id
+  rest_api_id = aws_api_gateway_rest_api.pdm_mock[0].id
 
   triggers = {
     redeployment = sha1(jsonencode([
-      aws_api_gateway_resource.patient_data_manager.id,
-      aws_api_gateway_resource.fhir.id,
-      aws_api_gateway_resource.r4.id,
-      aws_api_gateway_resource.document_reference.id,
-      aws_api_gateway_resource.document_reference_id.id,
-      aws_api_gateway_method.create_document_reference.id,
-      aws_api_gateway_method.get_document_reference.id,
-      aws_api_gateway_integration.create_document_reference.id,
-      aws_api_gateway_integration.get_document_reference.id,
+      aws_api_gateway_resource.patient_data_manager[0].id,
+      aws_api_gateway_resource.fhir[0].id,
+      aws_api_gateway_resource.r4[0].id,
+      aws_api_gateway_resource.document_reference[0].id,
+      aws_api_gateway_resource.document_reference_id[0].id,
+      aws_api_gateway_method.create_document_reference[0].id,
+      aws_api_gateway_method.get_document_reference[0].id,
+      aws_api_gateway_integration.create_document_reference[0].id,
+      aws_api_gateway_integration.get_document_reference[0].id,
     ]))
   }
 
@@ -114,14 +138,16 @@ resource "aws_api_gateway_deployment" "pdm_mock" {
   }
 }
 resource "aws_api_gateway_stage" "pdm_mock" {
-  deployment_id = aws_api_gateway_deployment.pdm_mock.id
-  rest_api_id   = aws_api_gateway_rest_api.pdm_mock.id
+  count = local.deploy_pdm_mock ? 1 : 0
+
+  deployment_id = aws_api_gateway_deployment.pdm_mock[0].id
+  rest_api_id   = aws_api_gateway_rest_api.pdm_mock[0].id
   stage_name    = var.environment
 
   xray_tracing_enabled = true
 
   access_log_settings {
-    destination_arn = aws_cloudwatch_log_group.pdm_mock_lambda_gateway.arn
+    destination_arn = aws_cloudwatch_log_group.pdm_mock_lambda_gateway[0].arn
     format = jsonencode({
       requestId      = "$context.requestId"
       ip             = "$context.identity.sourceIp"
@@ -145,6 +171,8 @@ resource "aws_api_gateway_stage" "pdm_mock" {
 }
 
 resource "aws_cloudwatch_log_group" "pdm_mock_lambda_gateway" {
+  count = local.deploy_pdm_mock ? 1 : 0
+
   name              = "/aws/apigateway/${var.project}-${var.environment}-pdm-mock-lambda"
   retention_in_days = var.log_retention_in_days
   kms_key_id        = module.kms.key_arn
@@ -158,11 +186,11 @@ resource "aws_cloudwatch_log_group" "pdm_mock_lambda_gateway" {
 }
 
 output "pdm_mock_lambda_endpoint" {
-  description = "The base URL of the PDM Mock Lambda"
-  value       = aws_api_gateway_stage.pdm_mock.invoke_url
+  description = "The base URL of the PDM Mock Lambda (null when not deployed)"
+  value       = local.deploy_pdm_mock ? aws_api_gateway_stage.pdm_mock[0].invoke_url : null
 }
 
 output "pdm_mock_lambda_id" {
-  description = "The ID of the PDM Mock Lambda API Gateway"
-  value       = aws_api_gateway_rest_api.pdm_mock.id
+  description = "The ID of the PDM Mock Lambda API Gateway (null when not deployed)"
+  value       = local.deploy_pdm_mock ? aws_api_gateway_rest_api.pdm_mock[0].id : null
 }

infrastructure/terraform/components/dl/locals.tf

@@ -8,4 +8,5 @@ locals {
   root_domain_name                     = "${var.environment}.${local.acct.route53_zone_names["digital-letters"]}"
   root_domain_id                       = local.acct.route53_zone_ids["digital-letters"]
   ttl_shard_count = 3
+  deploy_pdm_mock                      = var.enable_pdm_mock
 }

infrastructure/terraform/components/dl/module_lambda_pdm_mock_api.tf

@@ -1,4 +1,5 @@
 module "pdm_mock_lambda" {
+  count  = local.deploy_pdm_mock ? 1 : 0
   source = "https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.24/terraform-lambda.zip"
 
   function_name = "pdm-mock-lambda"
@@ -15,7 +16,7 @@ module "pdm_mock_lambda" {
   kms_key_arn           = module.kms.key_arn
 
   iam_policy_document = {
-    body = data.aws_iam_policy_document.pdm_mock_lambda.json
+    body = data.aws_iam_policy_document.pdm_mock_lambda[0].json
   }
 
   function_s3_bucket      = local.acct.s3_buckets["lambda_function_artefacts"]["id"]
@@ -43,6 +44,8 @@ module "pdm_mock_lambda" {
 }
 
 data "aws_iam_policy_document" "pdm_mock_lambda" {
+  count = local.deploy_pdm_mock ? 1 : 0
+
   statement {
     sid    = "KMSPermissions"
     effect = "Allow"

infrastructure/terraform/components/dl/variables.tf

@@ -157,3 +157,9 @@ variable "force_destroy" {
   description = "Flag to force deletion of S3 buckets"
   default     = false
 }
+
+variable "enable_pdm_mock" {
+  type        = bool
+  description = "Flag indicating whether to deploy PDM mock API (should be false in production environments)"
+  default     = true
+}