CCM-10283: Add e2e test

chris-elliott-nhsd · chris-elliott-nhsd · commit a67e37375f17 · 2025-06-30T17:08:16.000+01:00
diff --git a/infrastructure/terraform/components/sandbox/README.md b/infrastructure/terraform/components/sandbox/README.md
@@ -4,7 +4,10 @@
 
 ## Requirements
 
-No requirements.
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.9.0 |
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.50 |
 ## Inputs
 
 | Name | Description | Type | Default | Required |
@@ -15,7 +18,7 @@ No requirements.
 | <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/>      "template-submitted-recipient@sandbox.templates.dev.nhsnotify.national.nhs.uk"<br/>    ],<br/>    "enable_polling": true<br/>  }<br/>}</pre> | 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 |
@@ -40,6 +43,8 @@ No requirements.
 | <a name="output_sftp_mock_credential_path"></a> [sftp\_mock\_credential\_path](#output\_sftp\_mock\_credential\_path) | n/a |
 | <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_email_prefix"></a> [test\_email\_prefix](#output\_test\_email\_prefix) | n/a |
 <!-- vale on -->
 <!-- markdownlint-enable -->
 <!-- END_TF_DOCS -->
diff --git a/infrastructure/terraform/components/sandbox/locals.tf b/infrastructure/terraform/components/sandbox/locals.tf
@@ -2,4 +2,15 @@ locals {
   mock_letter_supplier_name = "WTMMOCK"
 
   use_sftp_letter_supplier_mock = lookup(var.letter_suppliers, local.mock_letter_supplier_name, null) != null
+
+  sandbox_letter_supplier_mock_recipient = "template-submitted-recipient-${var.environment}@sandbox.${local.acct.dns_zone["name"]}"
+
+  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
 }
diff --git a/infrastructure/terraform/components/sandbox/locals_tfscaffold.tf b/infrastructure/terraform/components/sandbox/locals_tfscaffold.tf
@@ -27,4 +27,26 @@ locals {
       Name        = local.csi
     },
   )
+
+    acct_csi = replace(
+        format(
+        "%s-%s-acct",
+        var.project,
+        var.parent_acct_environment,
+        ),
+        "_",
+        "",
+    )
+
+    acct_global_csi = replace(
+    format(
+      "%s-%s-%s-%s-acct",
+      var.project,
+      var.aws_account_id,
+      var.region,
+      var.parent_acct_environment,
+    ),
+    "_",
+    "",
+  )
 }
diff --git a/infrastructure/terraform/components/sandbox/module_backend_api.tf b/infrastructure/terraform/components/sandbox/module_backend_api.tf
@@ -18,7 +18,7 @@ module "backend_api" {
   }
 
   enable_proofing  = true
-  letter_suppliers = var.letter_suppliers
+  letter_suppliers = local.letter_suppliers
 
   kms_key_arn = data.aws_kms_key.sandbox.arn
 
@@ -29,5 +29,5 @@ module "backend_api" {
   email_domain             = "sandbox.${local.acct.dns_zone["name"]}"
 
   mock_letter_supplier_name     = local.mock_letter_supplier_name
-  use_sftp_letter_supplier_mock = lookup(var.letter_suppliers, local.mock_letter_supplier_name, null) != null
+  use_sftp_letter_supplier_mock = local.use_sftp_letter_supplier_mock
 }
diff --git a/infrastructure/terraform/components/sandbox/outputs.tf b/infrastructure/terraform/components/sandbox/outputs.tf
@@ -42,3 +42,10 @@ output "quarantine_bucket_name" {
   value = module.backend_api.quarantine_bucket_name
 }
 
+output "test_email_bucket_name" {
+  value = "${local.acct_global_csi}-ses"
+}
+
+output "test_email_prefix" {
+  value = "emails-${var.environment}"
+}
diff --git a/infrastructure/terraform/components/sandbox/ses_receipt_rule.tf b/infrastructure/terraform/components/sandbox/ses_receipt_rule.tf
@@ -0,0 +1,15 @@
+resource "aws_ses_receipt_rule" "main" {
+  name          = "${local.csi}-store-email-sandbox"
+  rule_set_name = local.acct_csi
+  recipients    = [local.sandbox_letter_supplier_mock_recipient]
+  enabled       = true
+  scan_enabled  = true
+  tls_policy    = "Optional"
+
+  s3_action {
+    position          = 1
+    bucket_name       = "${local.acct_global_csi}-ses"
+    object_key_prefix = "emails-${var.environment}/"
+    iam_role_arn      = "arn:aws:iam::${var.aws_account_id}:role/${local.acct_csi}-ses-receipts"
+  }
+}
diff --git a/infrastructure/terraform/components/sandbox/variables.tf b/infrastructure/terraform/components/sandbox/variables.tf
@@ -72,7 +72,7 @@ variable "letter_suppliers" {
 
   default = {
     "WTMMOCK" = {
-      email_addresses  = ["template-submitted-recipient@sandbox.templates.dev.nhsnotify.national.nhs.uk"]
+      email_addresses  = []
       enable_polling   = true
       default_supplier = true
     }
diff --git a/infrastructure/terraform/components/sandbox/versions.tf b/infrastructure/terraform/components/sandbox/versions.tf
@@ -0,0 +1,10 @@
+terraform {
+  required_providers {
+    aws = {
+      source  = "hashicorp/aws"
+      version = "~> 5.50"
+    }
+  }
+
+  required_version = ">= 1.9.0"
+}
diff --git a/infrastructure/terraform/modules/ses/ses_receipt_rule_set.tf b/infrastructure/terraform/modules/ses/ses_receipt_rule_set.tf
@@ -9,7 +9,7 @@ resource "aws_ses_receipt_rule" "store_email" {
 
   name          = "${local.csi}-store-email"
   rule_set_name = aws_ses_receipt_rule_set.main.0.rule_set_name
-  recipients    = [aws_ses_domain_identity.main.domain]
+  recipients    = ["template-submitted-recipient@${aws_ses_domain_identity.main.domain}"]
   enabled       = true
   scan_enabled  = true
   tls_policy    = "Optional"
diff --git a/lambdas/backend-api/src/templates/infra/email-template.html b/lambdas/backend-api/src/templates/infra/email-template.html
@@ -3,21 +3,6 @@
   <head>
     <meta charset="UTF-8" />
     <title>Letter Proof Approval</title>
-
-    @media all {
-      @font-face {
-        font-display: swap;
-        font-family: "Frutiger W01";
-        font-style: normal;
-        font-weight: 400;
-        src: url(https://assets.nhs.uk/fonts/FrutigerLTW01-55Roman.eot?#iefix);
-        src: url(https://assets.nhs.uk/fonts/FrutigerLTW01-55Roman.eot?#iefix) format("eot"),
-          url(https://assets.nhs.uk/fonts/FrutigerLTW01-55Roman.woff2) format("woff2"),
-          url(https://assets.nhs.uk/fonts/FrutigerLTW01-55Roman.woff) format("woff"),
-          url(https://assets.nhs.uk/fonts/FrutigerLTW01-55Roman.ttf) format("truetype"),
-          url(https://assets.nhs.uk/fonts/FrutigerLTW01-55Roman.svg#7def0e34-f28d-434f-b2ec-472bde847115) format("svg")
-      }
-    }
   </head>
   <body style="font-family: Frutiger W01, sans-serif; font-size: 14px">
     <p>For the attention of {{supplier}}.</p>
diff --git a/tests/test-team/helpers/email-helper.ts b/tests/test-team/helpers/email-helper.ts
@@ -0,0 +1,61 @@
+import { S3Client, ListObjectsV2Command, GetObjectCommand } from '@aws-sdk/client-s3';
+import { Readable } from 'stream';
+
+async function streamToString(stream: Readable): Promise<string> {
+  return await new Promise((resolve, reject) => {
+    const chunks: Buffer[] = [];
+    stream.on("data", (chunk) => chunks.push(Buffer.from(chunk)));
+    stream.on("error", (err) => reject(err));
+    stream.on("end", () => resolve(Buffer.concat(chunks).toString("utf-8")));
+  });
+}
+
+export class EmailHelper {
+  private readonly s3Client = new S3Client({ region: 'eu-west-2' });
+
+  private readonly testEmailBucketName = process.env.TEST_EMAIL_BUCKET_NAME;
+
+  private readonly testEmailPrefix = process.env.TEST_EMAIL_PREFIX;
+
+  constructor() {}
+
+  // This will stop working if one environment ever ends up with 1,000 email on it.
+  // This seems very unlikely but if it happens we can revisit this and add pagination.
+  async getEmailForTemplateId(templateId: string, dateCutoff: Date) {
+
+    const command = new ListObjectsV2Command({
+        Bucket: this.testEmailBucketName,
+        Prefix: this.testEmailPrefix,
+    });
+
+    const { Contents = [] } = await this.s3Client.send(command);
+
+    const sortedKeys = Contents
+        .filter(({ LastModified }) => (LastModified ?? 0) > dateCutoff)
+        .sort((a, b) => ((b.LastModified?.getTime() ?? 0) - (a.LastModified?.getTime() ?? 0)));
+
+    // SES does not tell us what the S3 keys are going to be for received emails,
+    // so we have to search all recent ones to ensure we get the right one and
+    // not one that was generated by a different test
+    for (const { Key } of sortedKeys) {
+        const getCommand = new GetObjectCommand({
+            Bucket: this.testEmailBucketName,
+        Key,
+        });
+
+        const { Body } = await this.s3Client.send(getCommand);
+
+        if (!Body || !(Body instanceof Readable)) {
+          throw new Error('Unexpected response body type');
+        }
+
+        const content = await streamToString(Body);
+
+        if (content.includes(templateId)) {
+            return content;
+        }
+    }
+
+    throw new Error('Email not found');
+  }
+}
diff --git a/tests/test-team/helpers/use-cases/simulate-passed-validation.ts b/tests/test-team/helpers/use-cases/simulate-passed-validation.ts
@@ -30,13 +30,21 @@ export class SimulatePassedValidation implements IUseCase<Template> {
         UpdateExpression: [
           'SET files.pdfTemplate.virusScanStatus = :virusScanStatus',
           'templateStatus = :readyForSubmissionStatus',
+          'files.proofs = :proofs',
           ...(this.#config.hasTestData
             ? ['files.testDataCsv.virusScanStatus = :virusScanStatus']
             : []),
         ].join(', '),
         ExpressionAttributeValues: {
           ':virusScanStatus': 'PASSED',
-          ':readyForSubmissionStatus': 'NOT_YET_SUBMITTED',
+          ':readyForSubmissionStatus': 'PROOF_AVAILABLE',
+          ':proofs': {
+            proof: {
+              fileName: 'proof.pdf',
+              supplier: 'WTMMOCK',
+              virusScanStatus: 'PASSED',
+            }
+          }
         },
         ReturnValues: 'ALL_NEW',
       })
diff --git a/tests/test-team/template-mgmt-api-tests/submit-template.api.spec.ts b/tests/test-team/template-mgmt-api-tests/submit-template.api.spec.ts
@@ -16,6 +16,7 @@ import {
   SimulateFailedVirusScan,
   SimulatePassedValidation,
 } from '../helpers/use-cases';
+import { EmailHelper } from '../helpers/email-helper';
 
 test.describe('POST /v1/template/:templateId/submit', () => {
   const authHelper = createAuthHelper();
@@ -141,16 +142,18 @@ test.describe('POST /v1/template/:templateId/submit', () => {
 
       const debug = JSON.stringify(createResult, null, 2);
 
+      const { id: templateId, name: templateName } = createResult.template;
+
       expect(createResponse.status(), debug).toBe(201);
 
       templateStorageHelper.addAdHocTemplateKey({
-        id: createResult.template.id,
+        id: templateId,
         owner: user1.userId,
       });
 
       await orchestrator.send(
         new SimulatePassedValidation({
-          templateId: createResult.template.id,
+          templateId,
           templateOwner: user1.userId,
           hasTestData: true,
         })
@@ -159,7 +162,7 @@ test.describe('POST /v1/template/:templateId/submit', () => {
       const start = new Date();
 
       const updateResponse = await request.patch(
-        `${process.env.API_BASE_URL}/v1/template/${createResult.template.id}/submit`,
+        `${process.env.API_BASE_URL}/v1/template/${templateId}/submit`,
         {
           headers: {
             Authorization: await user1.getAccessToken(),
@@ -190,6 +193,17 @@ test.describe('POST /v1/template/:templateId/submit', () => {
       expect(updated.template.createdAt).toEqual(
         createResult.template.createdAt
       );
+
+      // check email
+      const emailHelper = new EmailHelper();
+
+      await expect(async () => {
+        const emailContents = await emailHelper.getEmailForTemplateId(templateId, start);
+
+        expect(emailContents).toContain(templateId);
+        expect(emailContents).toContain(templateName);
+        expect(emailContents).toContain('proof.pdf');
+      }).toPass({ timeout: 20_000 });
     });
 
     test('returns 400 - cannot submit a submitted template', async ({
diff --git a/utils/backend-config/src/backend-config.ts b/utils/backend-config/src/backend-config.ts
@@ -12,6 +12,8 @@ export type BackendConfig = {
   templatesInternalBucketName: string;
   templatesQuarantineBucketName: string;
   templatesDownloadBucketName: string;
+  testEmailBucketName: string;
+  testEmailPrefix: string;
   userPoolId: string;
   userPoolClientId: string;
 };
@@ -33,6 +35,8 @@ export const BackendConfigHelper = {
       userPoolId: process.env.USER_POOL_ID ?? '',
       userPoolClientId: process.env.USER_POOL_CLIENT_ID ?? '',
       sftpPollLambdaName: process.env.SFTP_POLL_LAMBDA_NAME ?? '',
+      testEmailBucketName: process.env.TEST_EMAIL_BUCKET_NAME ?? '',
+      testEmailPrefix: process.env.TEST_EMAIL_PREFIX ?? '',
     };
   },
 
@@ -51,6 +55,8 @@ export const BackendConfigHelper = {
     process.env.TEMPLATES_DOWNLOAD_BUCKET_NAME =
       config.templatesDownloadBucketName;
     process.env.SFTP_POLL_LAMBDA_NAME = config.sftpPollLambdaName;
+    process.env.TEST_EMAIL_BUCKET_NAME = config.testEmailBucketName;
+    process.env.TEST_EMAIL_PREFIX = config.testEmailPrefix;
   },
 
   fromTerraformOutputsFile(filepath: string): BackendConfig {
@@ -73,6 +79,8 @@ export const BackendConfigHelper = {
       userPoolClientId:
         outputsFileContent.cognito_user_pool_client_id?.value ?? '',
       sftpPollLambdaName: outputsFileContent.sftp_poll_lambda_name?.value ?? '',
+      testEmailBucketName: outputsFileContent.test_email_bucket_name.value ?? '',
+      testEmailPrefix: outputsFileContent.test_email_prefix?.value ?? ''
     };
   },
 

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ module "backend_api" {`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`enable_proofing = true`
`21`		`- letter_suppliers = var.letter_suppliers`
	`21`	`+ letter_suppliers = local.letter_suppliers`
`22`	`22`
`23`	`23`	`kms_key_arn = data.aws_kms_key.sandbox.arn`
`24`	`24`
`@@ -29,5 +29,5 @@ module "backend_api" {`
`29`	`29`	`email_domain = "sandbox.${local.acct.dns_zone["name"]}"`
`30`	`30`
`31`	`31`	`mock_letter_supplier_name = local.mock_letter_supplier_name`
`32`		`- use_sftp_letter_supplier_mock = lookup(var.letter_suppliers, local.mock_letter_supplier_name, null) != null`
	`32`	`+ use_sftp_letter_supplier_mock = local.use_sftp_letter_supplier_mock`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ variable "letter_suppliers" {`
`72`	`72`
`73`	`73`	`default = {`
`74`	`74`	`"WTMMOCK" = {`
`75`		`- email_addresses = ["template-submitted-recipient@sandbox.templates.dev.nhsnotify.national.nhs.uk"]`
	`75`	`+ email_addresses = []`
`76`	`76`	`enable_polling = true`
`77`	`77`	`default_supplier = true`
`78`	`78`	`}`