CCM-10442: Email test fixes (#567)

Author: chris-elliott-nhsd

infrastructure/terraform/components/sandbox/README.md

@@ -18,7 +18,6 @@
 | <a name="input_environment"></a> [environment](#input\_environment) | The name of the tfscaffold environment | `string` | n/a | yes |
 | <a name="input_group"></a> [group](#input\_group) | The group variables are being inherited from (often synonymous with account short-name) | `string` | n/a | yes |
 | <a name="input_kms_deletion_window"></a> [kms\_deletion\_window](#input\_kms\_deletion\_window) | When a kms key is deleted, how long should it wait in the pending deletion state? | `string` | `"30"` | no |
-| <a name="input_letter_suppliers"></a> [letter\_suppliers](#input\_letter\_suppliers) | Letter suppliers enabled in the environment | <pre>map(object({<br/>    email_addresses  = list(string)<br/>    enable_polling   = bool<br/>    default_supplier = optional(bool)<br/>  }))</pre> | <pre>{<br/>  "WTMMOCK": {<br/>    "default_supplier": true,<br/>    "email_addresses": [],<br/>    "enable_polling": true<br/>  }<br/>}</pre> | no |
 | <a name="input_log_retention_in_days"></a> [log\_retention\_in\_days](#input\_log\_retention\_in\_days) | The retention period in days for the Cloudwatch Logs events to be retained, default of 0 is indefinite | `number` | `0` | no |
 | <a name="input_parent_acct_environment"></a> [parent\_acct\_environment](#input\_parent\_acct\_environment) | Name of the environment responsible for the acct resources used, affects things like DNS zone. Useful for named dev environments | `string` | `"main"` | no |
 | <a name="input_project"></a> [project](#input\_project) | The name of the tfscaffold project | `string` | n/a | yes |
@@ -47,8 +46,7 @@
 | <a name="output_sftp_poll_lambda_name"></a> [sftp\_poll\_lambda\_name](#output\_sftp\_poll\_lambda\_name) | n/a |
 | <a name="output_templates_table_name"></a> [templates\_table\_name](#output\_templates\_table\_name) | n/a |
 | <a name="output_test_email_bucket_name"></a> [test\_email\_bucket\_name](#output\_test\_email\_bucket\_name) | n/a |
-| <a name="output_test_proof_requested_email_prefix"></a> [test\_proof\_requested\_email\_prefix](#output\_test\_proof\_requested\_email\_prefix) | n/a |
-| <a name="output_test_template_submitted_email_prefix"></a> [test\_template\_submitted\_email\_prefix](#output\_test\_template\_submitted\_email\_prefix) | n/a |
+| <a name="output_test_email_bucket_prefix"></a> [test\_email\_bucket\_prefix](#output\_test\_email\_bucket\_prefix) | n/a |
 <!-- vale on -->
 <!-- markdownlint-enable -->
 <!-- END_TF_DOCS -->

infrastructure/terraform/components/sandbox/locals.tf

@@ -1,21 +1,6 @@
 locals {
-  mock_letter_supplier_name = "WTMMOCK"
-
-  use_sftp_letter_supplier_mock = lookup(var.letter_suppliers, local.mock_letter_supplier_name, null) != null
-
   email_domain                                           = "sandbox.${local.acct.dns_zone["name"]}"
   sandbox_letter_supplier_mock_proof_requested_sender    = "proof-requested-sender-${var.environment}@${local.email_domain}"
   sandbox_letter_supplier_mock_template_submitted_sender = "template-submitted-sender-${var.environment}@${local.email_domain}"
   sandbox_letter_supplier_mock_recipient                 = "supplier-recipient-${var.environment}@${local.email_domain}"
-
-  # var.letter_suppliers is defined at a point where we don't know what the environment is, so
-  # we need to add the environment-dependent test recipient separately here
-  letter_suppliers = local.use_sftp_letter_supplier_mock ? merge(
-    var.letter_suppliers,
-    { WTMMOCK = {
-      email_addresses  = concat(var.letter_suppliers.WTMMOCK.email_addresses, [local.sandbox_letter_supplier_mock_recipient])
-      enable_polling   = true
-      default_supplier = true
-    } }
-  ) : var.letter_suppliers
 }

infrastructure/terraform/components/sandbox/module_backend_api.tf

@@ -18,7 +18,13 @@ module "backend_api" {
   }
 
   enable_proofing  = true
-  letter_suppliers = local.letter_suppliers
+  letter_suppliers = {
+    WTMMOCK = {
+      email_addresses  = [local.sandbox_letter_supplier_mock_recipient]
+      enable_polling   = true
+      default_supplier = true
+    }
+  }
 
   kms_key_arn = data.aws_kms_key.sandbox.arn
 

infrastructure/terraform/components/sandbox/outputs.tf

@@ -62,11 +62,6 @@ output "test_email_bucket_name" {
   value = local.acct["ses_testing_config"].bucket_name
 }
 
-output "test_proof_requested_email_prefix" {
-  value = "proof-requested-emails-${var.environment}"
-}
-
-
-output "test_template_submitted_email_prefix" {
-  value = "template-submitted-emails-${var.environment}"
+output "test_email_bucket_prefix" {
+  value = "emails-${var.environment}"
 }

…dbox/ses_receipt_rule_proof_requested.tf …m/components/sandbox/ses_receipt_rule.tfinfrastructure/terraform/components/sandbox/ses_receipt_rule_proof_requested.tf renamed to infrastructure/terraform/components/sandbox/ses_receipt_rule.tf infrastructure/terraform/components/sandbox/ses_receipt_rule_proof_requested.tf renamed to infrastructure/terraform/components/sandbox/ses_receipt_rule.tf

@@ -2,16 +2,15 @@ resource "aws_ses_receipt_rule" "proof_requested" {
   name          = "${local.csi}-store-email-proof-requested"
   rule_set_name = local.acct["ses_testing_config"].rule_set_name
 
-  # Despite being called "recipients", AWS appears to apply this check to the sender email
-  recipients    = [local.sandbox_letter_supplier_mock_proof_requested_sender]
+  recipients    = [local.sandbox_letter_supplier_mock_recipient]
   enabled       = true
   scan_enabled  = true
   tls_policy    = "Optional"
 
   s3_action {
     position          = 1
     bucket_name       = local.acct["ses_testing_config"].bucket_name
-    object_key_prefix = "proof-requested-emails-${var.environment}/"
+    object_key_prefix = "emails-${var.environment}/"
     iam_role_arn      = local.acct["ses_testing_config"].iam_role_arn
   }
 }

infrastructure/terraform/components/sandbox/ses_receipt_rule_template_submitted.tf

@@ -63,32 +63,6 @@ variable "kms_deletion_window" {
   default     = "30"
 }
 
-variable "letter_suppliers" {
-  type = map(object({
-    email_addresses  = list(string)
-    enable_polling   = bool
-    default_supplier = optional(bool)
-  }))
-
-  default = {
-    "WTMMOCK" = {
-      email_addresses  = []
-      enable_polling   = true
-      default_supplier = true
-    }
-  }
-
-  validation {
-    condition = (
-      length(var.letter_suppliers) == 0 ||
-      length([for s in values(var.letter_suppliers) : s if s.default_supplier]) == 1
-    )
-    error_message = "If letter suppliers are configured, exactly one must be default_supplier"
-  }
-
-  description = "Letter suppliers enabled in the environment"
-}
-
 variable "parent_acct_environment" {
   type        = string
   description = "Name of the environment responsible for the acct resources used, affects things like DNS zone. Useful for named dev environments"

infrastructure/terraform/components/sandbox/variables.tf

@@ -14,8 +14,7 @@ declare global {
       TEMPLATES_INTERNAL_BUCKET_NAME: string;
       TEMPLATES_QUARANTINE_BUCKET_NAME: string;
       TEMPLATES_DOWNLOAD_BUCKET_NAME: string;
-      TEST_TEMPLATE_SUBMITTED_EMAIL_PREFIX: string;
-      TEST_PROOF_REQUESTED_EMAIL_PREFIX: string;
+      TEST_EMAIL_BUCKET_PREFIX: string;
     }
   }
 

tests/test-team/global.d.ts

@@ -54,7 +54,8 @@ export class EmailHelper {
   async getEmailForTemplateId(
     prefix: string,
     templateId: string,
-    dateCutoff: Date
+    dateCutoff: Date,
+    extraTextToSearch: string
   ) {
     const s3Items = await this.getAllS3Items(prefix);
 
@@ -82,7 +83,7 @@ export class EmailHelper {
 
       const content = await streamToString(Body);
 
-      if (content.includes(templateId)) {
+      if (content.includes(templateId) && content.includes(extraTextToSearch)) {
         return content;
       }
     }

tests/test-team/helpers/email-helper.ts

@@ -200,9 +200,10 @@ test.describe('POST /v1/template/:templateId/submit', () => {
 
       await expect(async () => {
         const emailContents = await emailHelper.getEmailForTemplateId(
-          process.env.TEST_TEMPLATE_SUBMITTED_EMAIL_PREFIX,
+          process.env.TEST_EMAIL_BUCKET_PREFIX,
           templateId,
-          start
+          start,
+          'template-submitted-sender'
         );
 
         expect(emailContents).toContain(templateId);