CCM-12732: Component tests framework

CCM-12732: Component tests framework

CCM-12732: Component tests framework

CCM-12732: Component tests framework

Author: simonlabarere

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

@@ -151,7 +151,7 @@ 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: [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:

.gitignore

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

.tool-versions

@@ -7,6 +7,7 @@ terraform 1.10.1
 terraform-docs 0.19.0
 trivy 0.61.0
 vale 3.6.0
+python 3.11.8
 
 
 # ==============================================================================

package-lock.json

@@ -53,6 +53,7 @@
     "lambdas/mesh-poll",
     "lambdas/ttl-create-lambda",
     "lambdas/ttl-poll-lambda",
-    "utils/utils"
+    "utils/utils",
+    "tests/playwright"
   ]
 }

package.json

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+set -euo pipefail
+
+cd "$(git rev-parse --show-toplevel)"
+
+npm install
+npx playwright install --with-deps > /dev/null
+
+cd tests/playwright
+
+npm run test:component

scripts/tests/integration.sh

@@ -0,0 +1,22 @@
+import { defineConfig } from '@playwright/test';
+import baseConfig from 'config/playwright.config';
+
+export default defineConfig({
+  ...baseConfig,
+
+  timeout: 120_000, // 30 seconds in the playwright default
+  expect: {
+    timeout: 10_000, // default is 5 seconds. After creating and previewing sometimes the load is slow on a cold start
+  },
+  projects: [
+    {
+      name: 'component',
+      testMatch: '*.component.spec.ts',
+      teardown: 'component:teardown',
+    },
+    {
+      name: 'component:teardown',
+      testMatch: 'component.teardown.ts',
+    },
+  ],
+});

tests/playwright/config/component/component.config.ts

@@ -0,0 +1,5 @@
+import { test as teardown } from '@playwright/test';
+
+teardown('component test teardown', async () => {
+  // component test teardown
+});

tests/playwright/config/component/component.teardown.ts

@@ -0,0 +1,7 @@
+import { randomUUID } from 'node:crypto';
+
+async function globalSetup() {
+  process.env.PLAYWRIGHT_RUN_ID = randomUUID();
+}
+
+export default globalSetup;

tests/playwright/config/global.setup.ts

@@ -0,0 +1,29 @@
+import { defineConfig } from '@playwright/test';
+import path from 'node:path';
+
+export default defineConfig({
+  testDir: path.resolve(__dirname, '../'),
+  fullyParallel: false,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  retries: 0,
+  /* Opt out of parallel tests on CI. */
+  workers: process.env.CI ? 4 : undefined,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: [
+    ['line'],
+    [
+      'html',
+      {
+        outputFolder: path.resolve(__dirname, '../playwright-report'),
+        open: process.env.CI ? 'never' : 'on-failure',
+      },
+    ],
+  ],
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    /* Collect trace when a test fails. See https://playwright.dev/docs/trace-viewer */
+    trace: 'retain-on-failure',
+  },
+  globalSetup: path.resolve(__dirname, 'global.setup.ts'),
+});