CCM-12732: Component tests framework

Author: simonlabarere

.github/workflows/cicd-1-pull-request.yaml

@@ -155,13 +155,9 @@ jobs:
     uses: ./.github/workflows/stage-4-acceptance.yaml
     if: needs.metadata.outputs.does_pull_request_exist == 'true' || (github.event_name == 'pull_request' && (github.event.action == 'opened' || github.event.action == 'reopened')) || (github.event_name == 'push' && github.ref == 'refs/heads/main')
     with:
-      build_datetime: "${{ needs.metadata.outputs.build_datetime }}"
-      build_timestamp: "${{ needs.metadata.outputs.build_timestamp }}"
-      build_epoch: "${{ needs.metadata.outputs.build_epoch }}"
-      nodejs_version: "${{ needs.metadata.outputs.nodejs_version }}"
-      python_version: "${{ needs.metadata.outputs.python_version }}"
-      terraform_version: "${{ needs.metadata.outputs.terraform_version }}"
       version: "${{ needs.metadata.outputs.version }}"
+      target_environment: "pr${{ needs.metadata.outputs.pr_number }}"
+      target_account_group: nhs-notify-digital-letters-dev
     secrets: inherit
   publish-stage: # Recommended maximum execution time is 10 minutes
     name: "Publish stage"

.github/workflows/pr_closed.yaml

@@ -62,3 +62,13 @@ jobs:
             --targetAccountGroup "nhs-notify-digital-letters-dev" \
             --targetComponent "${{ matrix.component }}" \
             --terraformAction "apply"
+
+  acceptance-stage: # Recommended maximum execution time is 10 minutes
+    name: "Acceptance stage"
+    needs: [ deploy-main]
+    uses: ./.github/workflows/stage-4-acceptance.yaml
+    with:
+      version: "main"
+      target_environment: "main"
+      target_account_group: nhs-notify-digital-letters-dev
+    secrets: inherit

.github/workflows/stage-4-acceptance.yaml

@@ -3,32 +3,16 @@ name: "Acceptance stage"
 on:
   workflow_call:
     inputs:
-      build_datetime:
-        description: "Build datetime, set by the CI/CD pipeline workflow"
-        required: true
-        type: string
-      build_timestamp:
-        description: "Build timestamp, set by the CI/CD pipeline workflow"
-        required: true
-        type: string
-      build_epoch:
-        description: "Build epoch, set by the CI/CD pipeline workflow"
-        required: true
-        type: string
-      nodejs_version:
-        description: "Node.js version, set by the CI/CD pipeline workflow"
-        required: true
-        type: string
-      python_version:
-        description: "Python version, set by the CI/CD pipeline workflow"
+      version:
+        description: "Version of the software, set by the CI/CD pipeline workflow"
         required: true
-        type: string
-      terraform_version:
-        description: "Terraform version, set by the CI/CD pipeline workflow"
+        type: string#
+      target_environment:
+        description: "Environment being tested"
         required: true
         type: string
-      version:
-        description: "Version of the software, set by the CI/CD pipeline workflow"
+      target_account_group:
+        description: "Account for the environment being tested"
         required: true
         type: string
 

tests/playwright/constants/backend-constants.ts

@@ -0,0 +1,15 @@
+// Envar Based
+// Environment Configuration
+export const ENV = process.env.ENVIRONMENT || 'main';
+
+// Compound Scope Indicator
+export const CSI = `nhs-${ENV}-dl`;
+
+// Lambda Names
+export const MESH_POLL_LAMBDA_NAME = `${CSI}-mesh-poll`;
+export const TTL_CREATE_LAMBDA_NAME = `${CSI}-ttl-create`;
+export const TTL_POLL_LAMBDA_NAME = `${CSI}-ttl-poll`;
+
+// Queue Names
+export const TTL_QUEUE_NAME = `${CSI}-ttl-queue`;
+export const TTL_DLQ_NAME = `${CSI}-ttl-dlq`;

tests/playwright/digital-letters-component-tests/delete-me.component.spec.ts

@@ -1,7 +1,10 @@
 import { expect, test } from '@playwright/test';
+import { ENV } from 'constants/backend-constants';
+import { listBuckets } from 'helpers/s3-helpers';
 
 test.describe('Digital Letters', () => {
-  test('should pass', async () => {
-    expect(true).toBeTruthy();
+  test('should contain a bucket with dl-letters in its name', async () => {
+    const buckets = await listBuckets(ENV);
+    expect(buckets.some(b => b.includes('dl-letters'))).toBeTruthy();
   });
 });

tests/playwright/helpers/s3-helpers.ts

@@ -0,0 +1,18 @@
+import { S3Client, ListBucketsCommand } from "@aws-sdk/client-s3";
+
+const s3 = new S3Client({
+  region: process.env.AWS_REGION || "eu-west-2",
+});
+
+
+export async function listBuckets(substring: string): Promise<string[]> {
+  const resp = await s3.send(new ListBucketsCommand({}));
+  const buckets = resp.Buckets ?? [];
+  if (!substring) {
+    return buckets.map(b => b.Name!).filter(Boolean);
+  }
+  const needle = substring.toLowerCase();
+  return buckets
+    .map(b => b.Name)
+    .filter((name): name is string => !!name && name.toLowerCase().includes(needle));
+}