CCM-10048: update event assertions to reduce duplication. Add a temporary script to create and env, run tests then delete env.

Author: bhansell1

.gitignore

@@ -90,3 +90,5 @@ lambdas/backend-api/src/email/email-template.json
 
 # vscode
 .vscode/settings.local.json
+
+test-runs

run-e2e.sh

@@ -0,0 +1,77 @@
+#!/bin/bash
+
+#### DELETE once finished... ####
+
+# Colors for output
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+NC='\033[0m' # No Color
+
+# Function to print colored output
+print_status() {
+    echo -e "${GREEN}[INFO]${NC} $1"
+}
+
+print_warning() {
+    echo -e "${YELLOW}[WARN]${NC} $1"
+}
+
+print_error() {
+    echo -e "${RED}[ERROR]${NC} $1"
+}
+
+RANDOM_DIGITS=0056
+ENVIRONMENT_NAME="${RANDOM_DIGITS}flaky"
+TOTAL_RUNS=1
+export CI=1
+export SKIP_SANDBOX_INSTALL=1
+
+
+print_status "Starting automated E2E test suite - $TOTAL_RUNS iterations"
+echo "========================================================"
+
+for i in $(seq 1 $TOTAL_RUNS); do
+  TIMESTAMP=$(date +"%Y%m%d_%H%M%S")
+  RUN_DIR="test-runs/$TIMESTAMP"
+
+  # Create run directory
+  mkdir -p "$RUN_DIR"
+
+  print_status "Generated environment name: $ENVIRONMENT_NAME"
+
+  # Create backend sandbox
+  print_status "Creating backend sandbox environment..."
+  if ./scripts/create_backend_sandbox.sh "$ENVIRONMENT_NAME"; then
+      print_status "Backend sandbox created successfully"
+  else
+      print_error "Failed to create backend sandbox"
+      exit 1
+  fi
+
+  # Run E2E tests
+  print_status "Running E2E tests..."
+  if npm run test:e2e --workspace tests/test-team; then
+      print_status "E2E tests completed successfuly"
+  else
+      print_error "E2E tests failed"
+      print_warning "Environment '$ENVIRONMENT_NAME' may still be running"
+  fi
+
+  print_status "Moving test-report to test runs"
+  if [ -d "tests/test-team/playwright-report" ]; then
+      print_status "Copying Playwright report files..."
+      cp -r tests/test-team/playwright-report/* "$RUN_DIR/" 2>/dev/null || true
+  fi
+
+  #  Destory environment
+  print_status "Destorying $ENVIRONMENT_NAME env... "
+  if ./scripts/destroy_backend_sandbox.sh "$ENVIRONMENT_NAME"; then
+      print_status "Environment destroyed successfully"
+  else
+      print_warning "Could not automagically destroy environment. You may need to clean up manually."
+      print_warning "Environment name: $ENVIRONMENT_NAME"
+  fi
+done
+
+print_status "Script completed"

tests/test-team/template-mgmt-e2e-tests/template-mgmt-letter-file-validation.e2e.spec.ts

@@ -706,10 +706,7 @@ test.describe('letter file validation', () => {
     });
 
     await expect(async () => {
-      const template = await templateStorageHelper.getTemplate({
-        id: templateId,
-        owner: user.userId,
-      });
+      const template = await templateStorageHelper.getTemplate(key);
 
       expect(template.files?.pdfTemplate?.virusScanStatus).toBe('PASSED');
       expect(template.files?.testDataCsv?.virusScanStatus).toBe('PASSED');

tests/test-team/template-mgmt-e2e-tests/template-mgmt-letter-full.e2e.spec.ts

@@ -20,9 +20,6 @@ import {
 
 const lambdaClient = new LambdaClient({ region: 'eu-west-2' });
 
-const getProofRandomSegment = (value?: string) =>
-  value?.replaceAll('-', '').slice(0, 27);
-
 // eslint-disable-next-line playwright/no-skipped-test
 test.describe('letter complete e2e journey', () => {
   const templateStorageHelper = new TemplateStorageHelper();
@@ -162,22 +159,24 @@ test.describe('letter complete e2e journey', () => {
 
     const template = await templateStorageHelper.getTemplate(key);
 
+    const batchId = `${key.id}-0000000000000_${template.files?.pdfTemplate?.currentVersion.replaceAll('-', '').slice(0, 27)}`;
+
     await assertProofGuardDutyEvent({
       key,
       scanResult: 'NO_THREATS_FOUND',
-      fileName: `${key.id}-0000000000000_${getProofRandomSegment(template.files?.pdfTemplate?.currentVersion)}_proof_1.pdf`,
+      fileName: `${batchId}_proof_1.pdf`,
     });
 
     await assertProofGuardDutyEvent({
       key,
       scanResult: 'NO_THREATS_FOUND',
-      fileName: `${key.id}-0000000000000_${getProofRandomSegment(template.files?.pdfTemplate?.currentVersion)}_proof_2.pdf`,
+      fileName: `${batchId}_proof_2.pdf`,
     });
 
     await assertProofGuardDutyEvent({
       key,
       scanResult: 'NO_THREATS_FOUND',
-      fileName: `${key.id}-0000000000000_${getProofRandomSegment(template.files?.pdfTemplate?.currentVersion)}_proof_3.pdf`,
+      fileName: `${batchId}_proof_3.pdf`,
     });
 
     await expect(async () => {

tests/test-team/template-mgmt-e2e-tests/template-mgmt-letter-guardduty.steps.ts

@@ -4,24 +4,26 @@ import { GuardDutyScanResult } from '../helpers/eventbridge/eventbridge-helper';
 import { TemplateStorageHelper } from '../helpers/db/template-storage-helper';
 import { Template, TemplateFile } from '../helpers/types';
 
-type AssertConfig = {
+type EventConfig = {
   key: { id: string; owner: string };
   scanResult: GuardDutyScanResult;
-  timeout?: number;
 };
 
 type FileConfig = {
   pathPrefix: 'pdf-template' | 'test-data' | 'proofs';
-  extension: '.pdf' | '.csv';
   getFile: (template: Template) => TemplateFile | undefined;
+  getPath: (template: Template, file?: TemplateFile) => string;
 };
 
+const guardDutyScan = new SimulateGuardDutyScan();
+const templateStorageHelper = new TemplateStorageHelper();
+
 function assertGuardDutyEventForFile(
-  { key, scanResult, timeout = 60_000 }: AssertConfig,
-  { pathPrefix, extension, getFile }: FileConfig
+  event: EventConfig,
+  fileConfig: FileConfig
 ) {
-  const guardDutyScan = new SimulateGuardDutyScan();
-  const templateStorageHelper = new TemplateStorageHelper();
+  const { key, scanResult } = event;
+  const { pathPrefix, getFile, getPath } = fileConfig;
 
   return test.step(`when user uploads ${pathPrefix} file, then guardduty triggers ${scanResult}`, async () => {
     await expect(async () => {
@@ -33,54 +35,48 @@ function assertGuardDutyEventForFile(
         return true;
       }
 
+      const path = getPath(template, file);
+
       const published = await guardDutyScan.publish({
         type: scanResult,
-        path: `${pathPrefix}/${template.owner}/${template.id}/${file?.currentVersion}${extension}`,
+        path,
       });
 
       expect(published).toEqual(true);
-    }).toPass({ timeout });
+    }).toPass({ timeout: 60_000 });
   });
 }
 
-export function assertPdfTemplateGuardDutyEvent(props: AssertConfig) {
+export function assertPdfTemplateGuardDutyEvent(props: EventConfig) {
   return assertGuardDutyEventForFile(props, {
     pathPrefix: 'pdf-template',
-    extension: '.pdf',
     getFile: (template) => template.files?.pdfTemplate,
+    getPath: (template, file) =>
+      `pdf-template/${template.owner}/${template.id}/${file?.currentVersion}.pdf`,
   });
 }
 
-export function assertTestDataGuardDutyEvent(props: AssertConfig) {
+export function assertTestDataGuardDutyEvent(props: EventConfig) {
   return assertGuardDutyEventForFile(props, {
     pathPrefix: 'test-data',
-    extension: '.csv',
     getFile: (template) => template.files?.testDataCsv,
+    getPath: (template, file) =>
+      `test-data/${template.owner}/${template.id}/${file?.currentVersion}.csv`,
   });
 }
 
 export function assertProofGuardDutyEvent(
-  props: AssertConfig & { fileName: string }
+  props: EventConfig & { fileName: string }
 ) {
-  const guardDutyScan = new SimulateGuardDutyScan();
-  const templateStorageHelper = new TemplateStorageHelper();
-
-  return test.step(`when user receives proof file, then guardduty triggers ${props.scanResult}`, async () => {
-    await expect(async () => {
-      const template = await templateStorageHelper.getTemplate(props.key);
-
-      const proof = template.files?.proofs?.[props.fileName];
+  return assertGuardDutyEventForFile(props, {
+    pathPrefix: 'proofs',
+    getFile: (template) => {
+      const file = template.files?.proofs?.[props.fileName];
 
-      if (proof && proof.virusScanStatus !== 'PENDING') {
-        return true;
+      if (file) {
+        return { ...file, currentVersion: 'unknown' };
       }
-
-      const published = await guardDutyScan.publish({
-        type: props.scanResult,
-        path: `proofs/${props.key.id}/${props.fileName}`,
-      });
-
-      expect(published).toEqual(true);
-    }).toPass({ timeout: 60_000 });
+    },
+    getPath: () => `proofs/${props.key.id}/${props.fileName}`,
   });
 }