CCM-12666: make tests run in the pipeline

Author: bhansell1

.github/actions/test-types.json

@@ -2,6 +2,7 @@
   "accessibility",
   "api",
   "event",
+  "ui-accessibility",
   "ui-component",
   "ui-routing-component",
   "ui-e2e",

scripts/tests/test.mk

@@ -23,6 +23,9 @@ test-coverage: # Evaluate code coverage from scripts/test/coverage @Testing
 test-accessibility: # Run tests from scripts/tests/accessibility.sh @Testing
 	make _test name="accessibility"
 
+test-ui-accessibility: # Run tests from scripts/tests/ui-accessibility.sh @Testing
+	make _test name="ui-accessibility"
+
 test-ui-routing-component: # Run tests from scripts/tests/ui-routing-component.sh @Testing
 	make _test name="ui-routing-component"
 
@@ -50,6 +53,7 @@ test: # Run all the test tasks @Testing
 		test-lint \
 		test-typecheck \
 		test-coverage \
+		test-ui-accessibility \
 		test-ui-component \
 		test-ui-e2e \
 		test-api \
@@ -73,6 +77,7 @@ ${VERBOSE}.SILENT: \
 	test-coverage \
 	test-lint \
 	test-typecheck \
+	test-ui-accessibility \
 	test-ui-component \
 	test-api \
 	test-ui-e2e \

scripts/tests/ui-accessibility.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+set -euo pipefail
+cd "$(git rev-parse --show-toplevel)"
+npx playwright install --with-deps > /dev/null
+cd tests/test-team
+TEST_EXIT_CODE=0
+npm run test:accessibility || TEST_EXIT_CODE=$?
+echo "TEST_EXIT_CODE=$TEST_EXIT_CODE"
+
+mkdir -p ../acceptance-test-report
+cp -r ./playwright-report ../acceptance-test-report
+[[ -e test-results ]] && cp -r ./test-results ../acceptance-test-report
+
+exit $TEST_EXIT_CODE

tests/test-team/fixtures/accessibility-analyze.ts

@@ -0,0 +1,39 @@
+import { test as base, Page } from '@playwright/test';
+import AxeBuilder from '@axe-core/playwright';
+import { TemplateMgmtBasePage } from 'pages/template-mgmt-base-page';
+import { expect } from '@playwright/test';
+
+type Analyze = <T extends TemplateMgmtBasePage>(
+  page: T,
+  opts?: {
+    id?: string;
+    beforeAnalyze?: (page: T) => Promise<void>;
+  }
+) => Promise<void>;
+
+type AccessibilityFixture = {
+  analyze: Analyze;
+};
+
+const makeAxeBuilder = (page: Page) =>
+  new AxeBuilder({ page }).withTags(['wcag2a', 'wcag2aa']);
+
+export const test = base.extend<AccessibilityFixture>({
+  analyze: async ({ page }, use) => {
+    const analyze: Analyze = async (pageUnderTest, opts) => {
+      const { id, beforeAnalyze } = opts ?? {};
+
+      await pageUnderTest.loadPage(id);
+
+      if (beforeAnalyze) {
+        await beforeAnalyze(pageUnderTest);
+      }
+
+      const results = await makeAxeBuilder(page).analyze();
+
+      expect(results.violations).toEqual([]);
+    };
+
+    await use(analyze);
+  },
+});

tests/test-team/fixtures/axe-test.ts

@@ -5,43 +5,30 @@ import {
 } from 'helpers/auth/cognito-auth-helper';
 import { RoutingConfigFactory } from 'helpers/factories/routing-config-factory';
 import { RoutingConfigStorageHelper } from 'helpers/db/routing-config-storage-helper';
-import { test, expect } from 'fixtures/axe-test';
+import { test } from 'fixtures/accessibility-analyze';
 import {
   RoutingChooseMessageOrderPage,
   RoutingCreateMessagePlanPage,
   RoutingMessagePlanCampaignIdRequiredPage,
   RoutingMessagePlansPage,
 } from 'pages/routing';
 import { loginAsUser } from 'helpers/auth/login-as-user';
-import { TemplateMgmtBasePage } from 'pages/template-mgmt-base-page';
-import AxeBuilder from '@axe-core/playwright';
 
 let user: TestUser;
 let userWithMultipleCampaigns: TestUser;
 
 const routingStorageHelper = new RoutingConfigStorageHelper();
 
-async function run<T extends TemplateMgmtBasePage>(
-  page: T,
-  makeAxeBuilder: () => AxeBuilder,
-  fn?: (page: T) => Promise<void>
-) {
-  await page.loadPage();
-  if (fn) {
-    await fn(page);
-  }
-  const results = await makeAxeBuilder().analyze();
-  expect(results.violations).toEqual([]);
-}
-
 test.describe('Routing - Accessibility', () => {
   test.beforeAll(async () => {
     const authHelper = createAuthHelper();
 
     user = await authHelper.getTestUser(testUsers.User1.userId);
+
     userWithMultipleCampaigns = await authHelper.getTestUser(
       testUsers.UserWithMultipleCampaigns.userId
     );
+
     await routingStorageHelper.seed([
       RoutingConfigFactory.create(user).dbEntry,
     ]);
@@ -51,42 +38,42 @@ test.describe('Routing - Accessibility', () => {
     await routingStorageHelper.deleteSeeded();
   });
 
-  test('Message plans', async ({ page, makeAxeBuilder }) =>
-    run(new RoutingMessagePlansPage(page), makeAxeBuilder));
+  test('Message plans', async ({ page, analyze }) =>
+    analyze(new RoutingMessagePlansPage(page)));
 
-  test('Campaign required', async ({ page, makeAxeBuilder }) =>
-    run(new RoutingMessagePlanCampaignIdRequiredPage(page), makeAxeBuilder));
+  test('Campaign required', async ({ page, analyze }) =>
+    analyze(new RoutingMessagePlanCampaignIdRequiredPage(page)));
 
-  test('Choose message order', async ({ page, makeAxeBuilder }) =>
-    run(new RoutingChooseMessageOrderPage(page), makeAxeBuilder));
+  test('Choose message order', async ({ page, analyze }) =>
+    analyze(new RoutingChooseMessageOrderPage(page)));
 
-  test('Choose message order - error', async ({ page, makeAxeBuilder }) =>
-    run(new RoutingChooseMessageOrderPage(page), makeAxeBuilder, (p) =>
-      p.clickContinueButton()
-    ));
+  test('Choose message order - error', async ({ page, analyze }) =>
+    analyze(new RoutingChooseMessageOrderPage(page), {
+      beforeAnalyze: (p) => p.clickContinueButton(),
+    }));
 
   test.describe('client has multiple campaigns', () => {
+    const messageOrder = 'NHSAPP,EMAIL,SMS,LETTER';
+
     test.use({ storageState: { cookies: [], origins: [] } });
 
     test.beforeEach(async ({ page }) => {
       await loginAsUser(userWithMultipleCampaigns, page);
     });
 
-    test('Create message plan', async ({ page, makeAxeBuilder }) =>
-      run(
+    test('Create message plan', async ({ page, analyze }) =>
+      analyze(
         new RoutingCreateMessagePlanPage(page, {
-          messageOrder: 'NHSAPP,EMAIL,SMS,LETTER',
-        }),
-        makeAxeBuilder
+          messageOrder,
+        })
       ));
 
-    test('Create message plan - error', async ({ page, makeAxeBuilder }) =>
-      run(
+    test('Create message plan - error', async ({ page, analyze }) =>
+      analyze(
         new RoutingCreateMessagePlanPage(page, {
-          messageOrder: 'NHSAPP,EMAIL,SMS,LETTER',
+          messageOrder,
         }),
-        makeAxeBuilder,
-        (p) => p.clickSubmit()
+        { beforeAnalyze: (p) => p.clickSubmit() }
       ));
   });
 });