CCM-12732: Component tests framework (#94)

Author: simonlabarere

.github/actions/acceptance-tests/action.yaml

@@ -0,0 +1,55 @@
+name: Acceptance tests
+description: "Run acceptance tests for this repo"
+
+inputs:
+  testType:
+    description: Type of test to run
+    required: true
+    default: main
+
+  targetEnvironment:
+    description: Name of the environment under test
+    required: true
+    default: main
+
+  targetAccountGroup:
+    description: Name of the account group under test
+    default: nhs-notify-digital-letters-dev
+    required: true
+
+  targetComponent:
+    description: Name of the component under test
+    default: dl
+
+runs:
+  using: "composite"
+
+  steps:
+    - name: "Repo setup"
+      shell: bash
+      run: |
+        npm ci
+
+    - name: Run test - ${{ inputs.testType }}
+      shell: bash
+      run: |
+        set -euo pipefail
+        case "$TEST_TYPE" in
+          main|integration|unit)
+            make "test-$TEST_TYPE"
+            ;;
+          *)
+            echo "Invalid testType: $TEST_TYPE" >&2
+            exit 1
+            ;;
+        esac
+      env:
+        TEST_TYPE: ${{ inputs.testType }}
+        ENVIRONMENT: ${{ inputs.targetEnvironment }}
+
+    - name: Archive integration test results
+      if: ${{ inputs.testType == 'integration' }}
+      uses: actions/upload-artifact@v4
+      with:
+        name: Integration test report
+        path: "tests/playwright/playwright-report"

.github/actions/test-types.json

@@ -0,0 +1,3 @@
+[
+  "integration"
+]

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

@@ -151,18 +151,15 @@ jobs:
             --overrides "branch_name=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}"
   acceptance-stage: # Recommended maximum execution time is 10 minutes
     name: "Acceptance stage"
-    needs: [metadata, build-stage]
+    needs: [metadata, pr-create-dynamic-environment]
     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 }}"
-    secrets: inherit
+      target_environment: "pr${{ needs.metadata.outputs.pr_number }}"
+      target_account_group: nhs-notify-digital-letters-dev
+    secrets:
+      APP_PEM_FILE: ${{ secrets.APP_PEM_FILE }}
+      APP_CLIENT_ID: ${{ secrets.APP_CLIENT_ID }}
   publish-stage: # Recommended maximum execution time is 10 minutes
     name: "Publish stage"
     needs: [metadata, acceptance-stage]

.github/workflows/pr_closed.yaml

@@ -62,3 +62,15 @@ 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
+    secrets:
+      APP_PEM_FILE: ${{ secrets.APP_PEM_FILE }}
+      APP_CLIENT_ID: ${{ secrets.APP_CLIENT_ID }}
+    with:
+      target_release_version: main
+      target_environment: main
+      target_account_group: nhs-notify-digital-letters-dev

.github/workflows/release_created.yaml

@@ -49,3 +49,4 @@ jobs:
     with:
       target_environment: "main"
       target_account_group: nhs-notify-digital-letters-nonprod
+      target_release_version: ${{ github.event.release.tag_name }}

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

@@ -2,33 +2,22 @@ name: "Acceptance stage"
 
 on:
   workflow_call:
-    inputs:
-      build_datetime:
-        description: "Build datetime, set by the CI/CD pipeline workflow"
+    secrets:
+      APP_PEM_FILE:
         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"
+      APP_CLIENT_ID:
         required: true
+    inputs:
+      target_release_version:
+        description: "Version of the software, set by the CI/CD pipeline workflow"
+        required: false
         type: string
-      terraform_version:
-        description: "Terraform version, set by the CI/CD pipeline workflow"
+      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
 
@@ -109,16 +98,27 @@ jobs:
     name: "Integration test"
     runs-on: ubuntu-latest
     needs: environment-set-up
-    timeout-minutes: 10
     steps:
-      - name: "Checkout code"
-        uses: actions/checkout@v5
-      - name: "Run integration test"
-        run: |
-          make test-integration
-      - name: "Save result"
-        run: |
-          echo "Nothing to save"
+      - uses: actions/checkout@v5.0.0
+      # Calls out to the nhs-notify-internal repo.
+      # The nhs-notify-internal repo will run the tests
+      # setup in ./.github/actions/acceptance-tests/action.yaml
+      - name: Trigger Acceptance Tests
+        shell: bash
+        env:
+          APP_PEM_FILE: ${{ secrets.APP_PEM_FILE }}
+          APP_CLIENT_ID: ${{ secrets.APP_CLIENT_ID }}
+          TARGET_ENVIRONMENT: ${{ inputs.target_environment }}
+          TARGET_ACCOUNT_GROUP: ${{ inputs.target_account_group }}
+        run: |
+          .github/scripts/dispatch_internal_repo_workflow.sh \
+            --infraRepoName "nhs-notify-digital-letters" \
+            --overrideProjectName "nhs" \
+            --releaseVersion "${{ inputs.target_release_version || github.head_ref || github.ref_name }}" \
+            --targetWorkflow "dispatch-contextual-tests-dynamic-env.yaml" \
+            --targetEnvironment "$TARGET_ENVIRONMENT" \
+            --targetAccountGroup "$TARGET_ACCOUNT_GROUP" \
+            --targetComponent "dl"
   test-accessibility:
     name: "Accessibility test"
     runs-on: ubuntu-latest

.gitignore

@@ -22,3 +22,5 @@ node_modules
 dist
 .DS_Store
 .reports
+**/playwright-report
+**/test-results

.gitleaksignore

@@ -4,3 +4,4 @@ cd9c0efec38c5d63053dd865e5d4e207c0760d91:docs/guides/Perform_static_analysis.md:
 cd9c0efec38c5d63053dd865e5d4e207c0760d91:docs/guides/Perform_static_analysis.md:sonar-api-token:37
 96096685ab3d6876671e2bc9a6ff4d48fc56e521:src/helloworld/helloworld.sln:ipv4:4
 4f4e8c15629b2cb09356a7fed4d72953590227ce:docs/Gemfile.lock:ipv4:4
+52386bca9b88c0c8c7dee52ab0ec69d04fb72c46:src/TESTING_PLAN.md:ipv4:145

.tool-versions

@@ -3,6 +3,7 @@ gitleaks 8.24.0
 jq 1.6
 nodejs 22.11.0
 pre-commit 3.6.0
+python 3.13.2
 terraform 1.10.1
 terraform-docs 0.19.0
 trivy 0.61.0

infrastructure/terraform/components/dl/README.md

@@ -10,6 +10,7 @@ No requirements.
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | <a name="input_aws_account_id"></a> [aws\_account\_id](#input\_aws\_account\_id) | The AWS Account ID (numeric) | `string` | n/a | yes |
+| <a name="input_component"></a> [component](#input\_component) | The variable encapsulating the name of this component | `string` | `"dl"` | no |
 | <a name="input_default_tags"></a> [default\_tags](#input\_default\_tags) | A map of default tags to apply to all taggable resources within the component | `map(string)` | `{}` | no |
 | <a name="input_enable_dynamodb_delete_protection"></a> [enable\_dynamodb\_delete\_protection](#input\_enable\_dynamodb\_delete\_protection) | Enable DynamoDB Delete Protection on all Tables | `bool` | `true` | no |
 | <a name="input_environment"></a> [environment](#input\_environment) | The name of the tfscaffold environment | `string` | n/a | yes |
@@ -38,7 +39,9 @@ No requirements.
 | <a name="module_ttl_poll"></a> [ttl\_poll](#module\_ttl\_poll) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.24/terraform-lambda.zip | n/a |
 ## Outputs
 
-No outputs.
+| Name | Description |
+|------|-------------|
+| <a name="output_deployment"></a> [deployment](#output\_deployment) | Deployment details used for post-deployment scripts |
 <!-- vale on -->
 <!-- markdownlint-enable -->
 <!-- END_TF_DOCS -->