CCM-7465: add authed user context to automated tests

Author: bhansell1

frontend/src/components/molecules/ManageTemplates/ManageTemplates.tsx

@@ -12,9 +12,9 @@ import {
   TemplateStatus,
   templateStatustoDisplayMappings,
   templateTypeDisplayMappings,
-} from 'nhs-notify-web-template-management-utils/src/enum';
+  viewSubmittedTemplatePages,
+} from 'nhs-notify-web-template-management-utils';
 import { TemplateDTO } from 'nhs-notify-backend-client';
-import { viewSubmittedTemplatePages } from 'nhs-notify-web-template-management-utils';
 
 const manageTemplatesContent = content.pages.manageTemplates;
 

frontend/src/utils/amplify-utils.ts

@@ -7,7 +7,7 @@ import { generateServerClientUsingCookies } from '@aws-amplify/adapter-nextjs/da
 import { Schema } from 'nhs-notify-web-template-management-amplify';
 import { createServerRunner } from '@aws-amplify/adapter-nextjs';
 import { fetchAuthSession } from 'aws-amplify/auth/server';
-import { logger } from 'nhs-notify-web-template-management-utils';
+import { logger } from 'nhs-notify-web-template-management-utils/logger';
 
 const config = require('@/amplify_outputs.json');
 

infrastructure/terraform/modules/backend-api/spec.tmpl.json

@@ -383,8 +383,7 @@
         "enum": [
           "NHS_APP",
           "SMS",
-          "EMAIL",
-          "LETTER"
+          "EMAIL"
         ]
       },
       "TemplateStatus": {

lambdas/backend-client/src/types/generated/models/TemplateType.ts

@@ -6,5 +6,4 @@ export enum TemplateType {
     NHS_APP = 'NHS_APP',
     SMS = 'SMS',
     EMAIL = 'EMAIL',
-    LETTER = 'LETTER',
 }

package-lock.json

@@ -0,0 +1 @@
+auth/*

tests/test-team/.gitignore

@@ -0,0 +1,18 @@
+/*
+ * Playwright setting up Auth -> https://playwright.dev/docs/auth
+ */
+
+import { test as setup } from '@playwright/test';
+import { TemplateMgmtSignInPage } from '../pages/templates-mgmt-login-page';
+
+setup('authenticate setup', async ({ page }) => {
+  const loginPage = new TemplateMgmtSignInPage(page);
+
+  await loginPage.loadPage();
+
+  await loginPage.cognitoSignIn(process.env.USER_EMAIL);
+
+  await page.waitForEvent('load');
+
+  await page.context().storageState({ path: 'auth/user.json' });
+});

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

@@ -0,0 +1,25 @@
+/*
+ * Playwright setting up Auth -> https://playwright.dev/docs/auth
+ */
+
+import { test as teardown } from '@playwright/test';
+import { CognitoUserHelper } from '../helpers/cognito-user-helper';
+
+teardown('authenticate teardown', async () => {
+  const userHelper = new CognitoUserHelper();
+
+  const user = await userHelper.getUser(process.env.USER_EMAIL);
+
+  if (user) {
+    // TODO: undo this
+    // await userHelper.deleteUser(user.email);
+  }
+
+  // TODO: delete this.
+  console.log({
+    USER_EMAIL: process.env.USER_EMAIL,
+    USER_ID: process.env.USER_ID,
+    USER_TEMPORARY_PASSWORD: process.env.USER_TEMPORARY_PASSWORD,
+    USER_PASSWORD: process.env.USER_PASSWORD,
+  });
+});

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

@@ -1,11 +1,36 @@
+import { randomUUID as uuidv4 } from 'node:crypto';
 import { FullConfig } from '@playwright/test';
-import { DatabaseTableNameHelper } from '../helpers/database-tablename-helper';
+import generate from 'generate-password';
+import { OutputsHelper } from '../helpers/outputs-helper';
+import { CognitoUserHelper } from '../helpers/cognito-user-helper';
 
 async function globalSetup(config: FullConfig) {
-  const tableNameHelper = new DatabaseTableNameHelper();
+  const outputsHelper = new OutputsHelper();
 
   process.env.TEMPLATE_STORAGE_TABLE_NAME =
-    await tableNameHelper.getTemplateStorageTableName();
+    outputsHelper.getTemplateStorageTableName();
+
+  process.env.COGNITO_USER_POOL_ID = outputsHelper.getCognitoUserPoolId();
+
+  const cognitoUserHelper = new CognitoUserHelper();
+
+  const [temporary, password] = generate.generateMultiple(2, {
+    length: 12,
+    numbers: true,
+    uppercase: true,
+    symbols: true,
+    strict: true,
+  });
+
+  const user = await cognitoUserHelper.createUser(
+    `${uuidv4().slice(0, 5)}[email protected]`,
+    temporary
+  );
+
+  process.env.USER_TEMPORARY_PASSWORD = temporary;
+  process.env.USER_PASSWORD = password;
+  process.env.USER_EMAIL = user.email;
+  process.env.USER_ID = user.userId;
 
   return config;
 }

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

@@ -7,6 +7,14 @@ export default defineConfig({
   timeout: 10_000,
 
   projects: [
+    {
+      name: 'auth-setup',
+      testMatch: 'auth.setup.ts',
+      use: {
+        baseURL: 'http://localhost:3000',
+        ...devices['Desktop Chrome'],
+      },
+    },
     {
       name: 'component',
       testMatch: '*.component.ts',
@@ -15,16 +23,25 @@ export default defineConfig({
         baseURL: 'http://localhost:3000',
         ...devices['Desktop Chrome'],
         headless: true,
+        storageState: './auth/user.json',
       },
+      dependencies: ['auth-setup'],
+      teardown: 'auth-teardown',
     },
     {
       name: 'e2e-local',
       testMatch: '*.e2e.spec.ts',
       use: {
         baseURL: 'http://localhost:3000',
         ...devices['Desktop Chrome'],
+        // Use prepared auth state.
+        storageState: 'auth/user.json',
       },
     },
+    {
+      name: 'auth-teardown',
+      testMatch: 'auth.teardown.ts',
+    },
   ],
   /* Run your local dev server before starting the tests */
   webServer: {