CCM-8572: add e2e tests

Author: harrim91

infrastructure/terraform/components/sandbox/outputs.tf

@@ -13,3 +13,11 @@ output "cognito_user_pool_client_id" {
 output "templates_table_name" {
   value = module.backend_api.templates_table_name
 }
+
+output "internal_bucket_name" {
+  value = module.backend_api.internal_bucket_name
+}
+
+output "quarantine_bucket_name" {
+  value = module.backend_api.quarantine_bucket_name
+}

infrastructure/terraform/modules/backend-api/outputs.tf

@@ -5,3 +5,11 @@ output "api_base_url" {
 output "templates_table_name" {
   value = aws_dynamodb_table.templates.name
 }
+
+output "internal_bucket_name" {
+  value = module.s3bucket_internal.id
+}
+
+output "quarantine_bucket_name" {
+  value = module.s3bucket_quarantine.id
+}

lambdas/backend-api/src/templates/infra/letter-upload-repository.ts

@@ -39,6 +39,7 @@ export class LetterUploadRepository {
         Bucket: this.bucketName,
         Key: pdfKey,
         Body: await pdf.bytes(),
+        ChecksumAlgorithm: 'SHA256',
         Metadata: this.metadata(
           owner,
           pdf.name,
@@ -58,6 +59,7 @@ export class LetterUploadRepository {
           Bucket: this.bucketName,
           Key: csvKey,
           Body: await csv.bytes(),
+          ChecksumAlgorithm: 'SHA256',
           Metadata: this.metadata(
             owner,
             csv.name,

package-lock.json

@@ -2,6 +2,14 @@ import path from 'node:path';
 import { defineConfig, devices } from '@playwright/test';
 import baseConfig from '../playwright.config';
 
+const buildCommand = [
+  'INCLUDE_AUTH_PAGES=true',
+  'NEXT_PUBLIC_TIME_TILL_LOGOUT_SECONDS=25',
+  'NEXT_PUBLIC_PROMPT_SECONDS_BEFORE_LOGOUT=5',
+  'NEXT_PUBLIC_ENABLE_LETTERS=true',
+  'npm run build && npm run start',
+].join(' ');
+
 export default defineConfig({
   ...baseConfig,
 
@@ -11,18 +19,37 @@ export default defineConfig({
   },
   projects: [
     {
-      name: 'e2e-local',
+      name: 'e2e:setup',
+      testMatch: 'e2e.setup.ts',
+      use: {
+        baseURL: 'http://localhost:3000',
+        ...devices['Desktop Chrome'],
+        headless: true,
+        screenshot: 'only-on-failure',
+      },
+    },
+    {
+      name: 'e2e',
       testMatch: '*.e2e.spec.ts',
       use: {
+        screenshot: 'only-on-failure',
         baseURL: 'http://localhost:3000',
         ...devices['Desktop Chrome'],
+        headless: true,
+        storageState: path.resolve(__dirname, '../.auth/e2e/user.json'),
       },
+      dependencies: ['e2e:setup'],
+      teardown: 'e2e:teardown',
+    },
+    {
+      name: 'e2e:teardown',
+      testMatch: 'e2e.teardown.ts',
     },
   ],
   /* Run your local dev server before starting the tests */
   webServer: {
     timeout: 2 * 60 * 1000, // 2 minutes
-    command: 'npm run build && npm run start',
+    command: buildCommand,
     cwd: path.resolve(__dirname, '../../../..'),
     url: 'http://localhost:3000/templates/create-and-submit-templates',
     reuseExistingServer: !process.env.CI,

tests/test-team/config/e2e/e2e.config.ts

@@ -0,0 +1,38 @@
+/*
+ * Playwright setting up Auth -> https://playwright.dev/docs/auth
+ */
+
+import path from 'node:path';
+import { test as setup } from '@playwright/test';
+import { BackendConfigHelper } from 'nhs-notify-web-template-management-util-backend-config';
+import { TemplateMgmtSignInPage } from '../../pages/templates-mgmt-login-page';
+import {
+  createAuthHelper,
+  TestUserId,
+} from '../../helpers/auth/cognito-auth-helper';
+
+setup('e2e test setup', async ({ page }) => {
+  const backendConfig = BackendConfigHelper.fromTerraformOutputsFile(
+    path.join(__dirname, '..', '..', '..', '..', 'sandbox_tf_outputs.json')
+  );
+
+  BackendConfigHelper.toEnv(backendConfig);
+
+  const auth = createAuthHelper();
+
+  await auth.setup();
+
+  const user = await auth.getTestUser(TestUserId.User1);
+
+  const loginPage = new TemplateMgmtSignInPage(page);
+
+  await loginPage.loadPage();
+
+  await loginPage.cognitoSignIn(user);
+
+  await page.waitForURL('/templates/create-and-submit-templates');
+
+  await page.context().storageState({
+    path: path.resolve(__dirname, '..', '.auth', 'e2e', 'user.json'),
+  });
+});

tests/test-team/config/e2e/e2e.setup.ts

@@ -0,0 +1,6 @@
+import { test as teardown } from '@playwright/test';
+import { createAuthHelper } from '../../helpers/auth/cognito-auth-helper';
+
+teardown('e2e test teardown', async () => {
+  await createAuthHelper().teardown();
+});

tests/test-team/config/e2e/e2e.teardown.ts

@@ -0,0 +1,11 @@
+# Test Fixtures
+
+## Custom Matchers
+
+Custom playwright matchers
+
+## PDF Upload
+
+Files for use with letter templates.
+
+For all files `password.pdf`, the password is `password`.

tests/test-team/fixtures/README.md

@@ -3,7 +3,7 @@ import { expect } from '@playwright/test';
 expect.extend({
   /**
    * Asserts that a value is parsable as a date, and is roughly within the given range.
-   * Roughly means that the received value can be be within 1 second either side of the range.
+   * "Roughly" means that the received value can be within 1 second either side of the range.
    * This helps deal with local machines being out of sync with remote servers
    */
   // eslint-disable-next-line @typescript-eslint/no-explicit-any

tests/test-team/fixtures/custom-matchers.ts

@@ -1,16 +1,54 @@
 /* eslint-disable security/detect-non-literal-fs-filename */
+import { createHash } from 'node:crypto';
 import { readFileSync } from 'node:fs';
 import path from 'node:path';
 
-const getFile = (directory: string, filename: string) =>
-  readFileSync(path.resolve(__dirname, directory, filename));
+const files = new Map<string, { data: Buffer; checksumSha256: string }>();
+
+const loadFile = (filepath: string) => {
+  const data = readFileSync(filepath);
+  const checksumSha256 = sha256(data);
+  const file = { data, checksumSha256 };
+  files.set(filepath, file);
+  return file;
+};
+
+const sha256 = (data: Buffer) =>
+  createHash('sha256').update(data).digest('base64');
+
+const getFile = (directory: string, filename: string) => {
+  const filepath = path.resolve(__dirname, directory, filename);
+
+  return {
+    filepath,
+    open: () => {
+      const opened = files.get(filepath);
+
+      if (opened) {
+        return opened.data;
+      }
+
+      return loadFile(filepath).data;
+    },
+    checksumSha256: () => {
+      const opened = files.get(filepath);
+      if (opened) {
+        return opened.checksumSha256;
+      }
+
+      return loadFile(filepath).checksumSha256;
+    },
+  };
+};
 
 export const pdfUploadFixtures = {
   withPersonalisation: {
     pdf: getFile('with-personalisation', 'template.pdf'),
     csv: getFile('with-personalisation', 'test-data.csv'),
+    passwordPdf: getFile('with-personalisation', 'password.pdf'),
   },
   noCustomPersonalisation: {
     pdf: getFile('no-custom-personalisation', 'template.pdf'),
+    passwordPdf: getFile('no-custom-personalisation', 'password.pdf'),
   },
 };