Merge pull request #262 from NHSDigital/feature/CCM-7498_templates-api-test-pack

CCM-7498: add playwright test suite for templates api

Author: harrim91

.eslintrc.json

@@ -86,11 +86,12 @@
         "devDependencies": [
           "jest.config.ts",
           "jest.setup.ts",
-          "src/__tests__/**"
+          "**/__tests__/**"
         ]
       }
     ],
-    "no-empty-function": "off"
+    "no-empty-function": "off",
+    "unicorn/prefer-module": "off"
   },
   "overrides": [
     {

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

@@ -66,6 +66,10 @@ jobs:
         with:
           name: sandbox_tf_outputs.json
           path: sandbox_tf_outputs.json
+      - uses: actions/upload-artifact@v4
+        with:
+          name: amplify_outputs.json
+          path: ./frontend/amplify_outputs.json
   test-security:
     name: "Security test"
     runs-on: ubuntu-latest
@@ -95,6 +99,10 @@ jobs:
         with:
           name: sandbox_tf_outputs.json
           path: ./
+      - uses: actions/download-artifact@v4
+        with:
+          name: amplify_outputs.json
+          path: ./frontend
       - name: "Repo setup"
         run: |
           npm ci
@@ -108,9 +116,7 @@ jobs:
           role-session-name: deployInfra
           aws-region: eu-west-2
       - name: "Run accessibility test"
-        run: |
-          npm run create-amplify-outputs file
-          make test-accessibility
+        run: make test-accessibility
       - name: Archive accessibility results
         uses: actions/upload-artifact@v4
         with:
@@ -131,6 +137,10 @@ jobs:
         with:
           name: sandbox_tf_outputs.json
           path: ./
+      - uses: actions/download-artifact@v4
+        with:
+          name: amplify_outputs.json
+          path: ./frontend
       - name: "Repo setup"
         run: |
           npm ci
@@ -147,7 +157,6 @@ jobs:
           aws-region: eu-west-2
       - name: "Run ui component test"
         run: |
-          npm run create-amplify-outputs file
           cd tests/test-team
           npm run test:local-ui
       - name: Archive component test results
@@ -156,11 +165,50 @@ jobs:
         with:
           name: component test report
           path: "tests/test-team/playwright-report"
+  test-api:
+    name: "API test"
+    runs-on: ubuntu-latest
+    needs: [sandbox-set-up]
+    environment: dev
+    timeout-minutes: 10
+    steps:
+      - name: "Checkout code"
+        uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          name: sandbox_tf_outputs.json
+          path: './'
+      - uses: actions/download-artifact@v4
+        with:
+          name: amplify_outputs.json
+          path: ./frontend
+      - name: "Repo setup"
+        run: |
+          npm ci
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          role-to-assume: arn:aws:iam::${{ secrets.AWS_ACCOUNT_ID }}:role/${{ secrets.AWS_ASSUME_ROLE_NAME }}
+          role-session-name: deployInfra
+          aws-region: eu-west-2
+      - name: "Run API test"
+        run: |
+          cd tests/test-team
+          npm run test:api
+      - name: Archive API test results
+        uses: actions/upload-artifact@v4
+        with:
+          name: API test report
+          path: "tests/test-team/playwright-report"
+
   sandbox-tear-down:
     name: "Sandbox tear down"
     if: success() || failure()
     runs-on: ubuntu-latest
-    needs: [test-accessibility, test-ui-component]
+    needs:
+      - test-accessibility
+      - test-ui-component
+      - test-api
     environment: dev
     steps:
       - uses: hashicorp/setup-terraform@v3

frontend/next.config.js

@@ -15,7 +15,7 @@ const nextConfig = (phase) => {
     basePath,
     env: {
       basePath,
-      BACKEND_API_URL: amplifyConfig?.meta?.backend_api_url,
+      API_BASE_URL: amplifyConfig?.meta?.api_base_url,
     },
 
     experimental: {

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

@@ -10,7 +10,7 @@ import {
   previewTemplatePages,
   Template,
   TemplateStatus,
-  templateStatustoDisplayMappings,
+  templateStatusToDisplayMappings,
   templateTypeDisplayMappings,
   viewSubmittedTemplatePages,
 } from 'nhs-notify-web-template-management-utils';
@@ -78,7 +78,7 @@ export function ManageTemplates({
                         : undefined
                     }
                   >
-                    {templateStatustoDisplayMappings(template.templateStatus)}
+                    {templateStatusToDisplayMappings(template.templateStatus)}
                   </Tag>
                 </Table.Cell>
                 <Table.Cell>

frontend/src/components/molecules/PreviewTemplate/PreviewTemplate.tsx

@@ -3,7 +3,7 @@ import concatClassNames from '@utils/concat-class-names';
 import {
   Template,
   TemplateStatus,
-  templateStatustoDisplayMappings,
+  templateStatusToDisplayMappings,
   templateTypeDisplayMappings,
 } from 'nhs-notify-web-template-management-utils';
 import styles from './PreviewTemplate.module.scss';
@@ -53,7 +53,7 @@ export function PreviewTemplate({
                     : undefined
                 }
               >
-                {templateStatustoDisplayMappings(template.templateStatus)}
+                {templateStatusToDisplayMappings(template.templateStatus)}
               </Tag>
             </Col>
           </Row>

infrastructure/terraform/components/app/amplify_app.tf

@@ -34,7 +34,7 @@ resource "aws_amplify_app" "main" {
     ACCOUNT_ID                  = var.aws_account_id
     NEXT_PUBLIC_DISABLE_CONTENT = var.disable_content
     AMPLIFY_MONOREPO_APP_ROOT   = "frontend"
-    BACKEND_API_URL             = module.backend_api.api_base_url
+    API_BASE_URL                = module.backend_api.api_base_url
     USER_POOL_ID                = jsondecode(data.aws_ssm_parameter.cognito_config.value)["USER_POOL_ID"]
     USER_POOL_CLIENT_ID         = jsondecode(data.aws_ssm_parameter.cognito_config.value)["USER_POOL_CLIENT_ID"]
   }

infrastructure/terraform/components/sandbox/outputs.tf

@@ -10,6 +10,6 @@ output "cognito_user_pool_client_id" {
   value = aws_cognito_user_pool_client.sandbox.id
 }
 
-output "dynamodb_table_templates" {
-  value = module.backend_api.dynamodb_table_templates
+output "templates_table_name" {
+  value = module.backend_api.templates_table_name
 }

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

@@ -3,4 +3,64 @@ resource "aws_api_gateway_stage" "main" {
   description   = "Templates API stage ${var.environment}"
   rest_api_id   = aws_api_gateway_rest_api.main.id
   deployment_id = aws_api_gateway_deployment.main.id
+
+  access_log_settings {
+    destination_arn = aws_cloudwatch_log_group.api_gateway_access.arn
+
+    // Context variables reference - https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference
+    // This is useful https://aws.amazon.com/blogs/compute/troubleshooting-amazon-api-gateway-with-enhanced-observability-variables/
+    // We're not using WAF, custom domain, mTLS etc at the moment, but we might want to add variables around these in the future if we start using them
+    format = jsonencode({
+      "accountId" : "$context.accountId"
+      "apiId" : "$context.apiId"
+      "authorize" : {
+        "error" : "$context.authorize.error"
+        "latency" : "$context.authorize.latency"
+        "status" : "$context.authorize.status"
+      }
+      "authorizer" : {
+        "error" : "$context.authorizer.error"
+        "integrationLatency" : "$context.authorizer.integrationLatency"
+        "integrationStatus" : "$context.authorizer.integrationStatus"
+        "latency" : "$context.authorizer.latency"
+        "principalId" : "$context.authorizer.principalId"
+        "requestId" : "$context.authorizer.requestId"
+        "status" : "$context.authorizer.status"
+      }
+      "awsEndpointRequestId" : "$context.awsEndpointRequestId"
+      "deploymentId" : "$context.deploymentId"
+      "domainName" : "$context.domainName"
+      "domainPrefix" : "$context.domainPrefix"
+      "endpointType" : "$context.endpointType"
+      "error" : {
+        "message" : "$context.error.message"
+        "responseType" : "$context.error.responseType"
+        "validationErrorString" : "$context.error.validationErrorString"
+      }
+      "extendedRequestId" : "$context.extendedRequestId"
+      "httpMethod" : "$context.httpMethod"
+      "identity" : {
+        "sourceIp" : "$context.identity.sourceIp"
+        "userAgent" : "$context.identity.userAgent"
+      }
+      "integration" : {
+        "error" : "$context.integration.error"
+        "integrationStatus" : "$context.integration.integrationStatus"
+        "latency" : "$context.integration.latency"
+        "requestId" : "$context.integration.requestId"
+        "status" : "$context.integration.status"
+      }
+      "path" : "$context.path"
+      "protocol" : "$context.protocol"
+      "requestId" : "$context.requestId"
+      "requestTime" : "$context.requestTime"
+      "requestTimeEpoch" : "$context.requestTimeEpoch"
+      "responseLatency" : "$context.responseLatency"
+      "responseLength" : "$context.responseLength"
+      "resourceId" : "$context.resourceId"
+      "resourcePath" : "$context.resourcePath"
+      "stage" : "$context.stage"
+      "status" : "$context.status"
+    })
+  }
 }

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

@@ -0,0 +1,4 @@
+resource "aws_cloudwatch_log_group" "api_gateway_access" {
+  name              = "/aws/api-gateway/${aws_api_gateway_rest_api.main.id}/${var.environment}/access-logs"
+  retention_in_days = var.log_retention_in_days
+}

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

@@ -4,6 +4,12 @@ resource "aws_iam_role" "api_gateway_execution_role" {
   assume_role_policy = data.aws_iam_policy_document.api_gateway_service_trust_policy.json
 }
 
+resource "aws_iam_role_policy_attachment" "cloudwatch_logs" {
+  role       = aws_iam_role.api_gateway_execution_role.name
+  policy_arn = "arn:aws:iam::aws:policy/service-role/AmazonAPIGatewayPushToCloudWatchLogs"
+
+}
+
 resource "aws_iam_role_policy" "api_gateway_execution_policy" {
   role   = aws_iam_role.api_gateway_execution_role.name
   name   = "${local.csi}-apig-execution-policy"