CCM-11537: Preview page tests

Author: ClareJonesBJSS

tests/test-team/helpers/template-mgmt-common.steps.ts

@@ -4,6 +4,7 @@ import { TemplateMgmtBasePage } from '../pages/template-mgmt-base-page';
 type CommonStepsProps = {
   page: TemplateMgmtBasePage;
   id?: string;
+  additionalIds?: string[];
   baseURL?: string;
 };
 
@@ -35,9 +36,24 @@ const expectedFooterLinks: Record<string, FooterLinkSpec> = {
   },
 };
 
-export function assertSkipToMainContent({ page, id }: CommonStepsProps) {
+const loadPageFromIds = async (
+  page: TemplateMgmtBasePage,
+  id?: string,
+  additionalIds?: string[]
+) => {
+  if (id) {
+    return await page.loadPage(id, ...(additionalIds ?? []));
+  }
+  return await page.loadPage();
+};
+
+export function assertSkipToMainContent({
+  page,
+  id,
+  additionalIds,
+}: CommonStepsProps) {
   return test.step('when user clicks "skip to main content", then page heading is focused', async () => {
-    await page.loadPage(id);
+    await loadPageFromIds(page, id, additionalIds);
 
     await page.page.keyboard.press('Tab');
 
@@ -55,9 +71,13 @@ export function assertSkipToMainContent({ page, id }: CommonStepsProps) {
   });
 }
 
-export function assertHeaderWhenSignedOut({ page, id }: CommonStepsProps) {
+export function assertHeaderWhenSignedOut({
+  page,
+  id,
+  additionalIds,
+}: CommonStepsProps) {
   return test.step('when user is signed out, then header displays sign in link only', async () => {
-    await page.loadPage(id);
+    await loadPageFromIds(page, id, additionalIds);
 
     await expect(page.signInLink).toBeVisible();
     await expect(page.signOutLink).toBeHidden();
@@ -70,14 +90,15 @@ export function assertHeaderWhenSignedOut({ page, id }: CommonStepsProps) {
 export function assertHeaderWhenSignedIn({
   page,
   id,
+  additionalIds,
   expectedDisplayName,
   expectedClientName,
 }: CommonStepsProps & {
   expectedDisplayName: string;
   expectedClientName: string;
 }) {
   return test.step('when user is signed in, then header shows display name and client name', async () => {
-    await page.loadPage(id);
+    await loadPageFromIds(page, id, additionalIds);
 
     await expect(page.signOutLink).toBeVisible();
     await expect(page.signInLink).toBeHidden();
@@ -96,9 +117,13 @@ export function assertHeaderWhenSignedIn({
   });
 }
 
-export function assertHeaderLogoLink({ page, id }: CommonStepsProps) {
+export function assertHeaderLogoLink({
+  page,
+  id,
+  additionalIds,
+}: CommonStepsProps & { additionalIds?: string[] }) {
   return test.step('header logo is visible, correctly labelled and structured', async () => {
-    await page.loadPage(id);
+    await loadPageFromIds(page, id, additionalIds);
 
     const logoLink = page.headerLogoLink;
 
@@ -134,9 +159,13 @@ export function assertClickHeaderLogoRedirectsToStartPage({
   });
 }
 
-export function assertSignInLink({ page, id }: CommonStepsProps) {
+export function assertSignInLink({
+  page,
+  id,
+  additionalIds,
+}: CommonStepsProps & { additionalIds?: string[] }) {
   return test.step('when user clicks "Sign in", then user is redirected to "sign in page"', async () => {
-    await page.loadPage(id);
+    await loadPageFromIds(page, id, additionalIds);
 
     const link = page.signInLink;
 
@@ -147,9 +176,13 @@ export function assertSignInLink({ page, id }: CommonStepsProps) {
   });
 }
 
-export function assertSignOutLink({ page, id }: CommonStepsProps) {
+export function assertSignOutLink({
+  page,
+  id,
+  additionalIds,
+}: CommonStepsProps & { additionalIds?: string[] }) {
   return test.step('"Sign out", should direct user to signout', async () => {
-    await page.loadPage(id);
+    await loadPageFromIds(page, id, additionalIds);
 
     const link = page.signOutLink;
 
@@ -160,14 +193,15 @@ export function assertSignOutLink({ page, id }: CommonStepsProps) {
 export function assertHeaderNavigationLinksWhenSignedIn({
   page,
   id,
+  additionalIds,
   routingEnabled,
 }: CommonStepsProps & { routingEnabled: boolean }) {
   const description = routingEnabled
     ? 'Templates and Message plans links'
     : 'Templates link only';
 
   return test.step(`header shows ${description} when routing is ${routingEnabled ? 'enabled' : 'disabled'}`, async () => {
-    await page.loadPage(id);
+    await loadPageFromIds(page, id, additionalIds);
 
     const nav = page.headerNavigationLinks;
 
@@ -184,9 +218,10 @@ export function assertHeaderNavigationLinksWhenSignedIn({
 export function assertHeaderNavigationLinksWhenSignedOut({
   page,
   id,
+  additionalIds,
 }: CommonStepsProps) {
   return test.step('header does not display navigation links when signed out', async () => {
-    await page.loadPage(id);
+    await loadPageFromIds(page, id, additionalIds);
 
     await expect(page.headerNavigationLinks).toHaveCount(0);
   });
@@ -197,9 +232,10 @@ export function assertGoBackLink({
   id,
   baseURL,
   expectedUrl,
+  additionalIds,
 }: CommonStepsProps & { expectedUrl: string }) {
   return test.step('when user clicks "Go back", then user is redirected to previous page', async () => {
-    await page.loadPage(id);
+    await loadPageFromIds(page, id, additionalIds);
 
     await page.goBackLink.click();
 
@@ -209,17 +245,25 @@ export function assertGoBackLink({
   });
 }
 
-export function assertGoBackLinkNotPresent({ page, id }: CommonStepsProps) {
+export function assertGoBackLinkNotPresent({
+  page,
+  id,
+  additionalIds,
+}: CommonStepsProps) {
   return test.step('should not display "Go Back" link on page', async () => {
-    await page.loadPage(id);
+    await loadPageFromIds(page, id, additionalIds);
 
     await expect(page.goBackLink).toBeHidden();
   });
 }
 
-export function assertFooterLinks({ page, id }: CommonStepsProps) {
+export function assertFooterLinks({
+  page,
+  id,
+  additionalIds,
+}: CommonStepsProps) {
   return test.step('when page loads, then Page Footer should have the correct links', async () => {
-    await page.loadPage(id);
+    await loadPageFromIds(page, id, additionalIds);
 
     const promises = Object.values(expectedFooterLinks).map((linkSpec) =>
       expect(

tests/test-team/pages/email/template-mgmt-create-email-page.ts

@@ -3,7 +3,7 @@ import { TemplateMgmtMessageFormatting } from '../template-mgmt-message-formatti
 import { TemplateMgmtBasePageNonDynamic } from '../template-mgmt-base-page-non-dynamic';
 
 export class TemplateMgmtCreateEmailPage extends TemplateMgmtBasePageNonDynamic {
-  static readonly pageUrlSegment = 'create-email-template';
+  static readonly pageUrlSegments = ['create-email-template'];
 
   public readonly nameInput: Locator;
 

tests/test-team/pages/email/template-mgmt-edit-email-page.ts

@@ -3,7 +3,7 @@ import { TemplateMgmtMessageFormatting } from '../template-mgmt-message-formatti
 import { TemplateMgmtBasePageDynamic } from '../template-mgmt-base-page-dynamic';
 
 export class TemplateMgmtEditEmailPage extends TemplateMgmtBasePageDynamic {
-  static readonly pageUrlSegment = 'edit-email-template';
+  static readonly pageUrlSegments = ['edit-email-template'];
 
   public readonly nameInput: Locator;
 

tests/test-team/pages/email/template-mgmt-preview-email-page.ts

@@ -2,7 +2,7 @@ import { Locator, Page } from '@playwright/test';
 import { TemplateMgmtPreviewBasePage } from '../template-mgmt-preview-base-page';
 
 export class TemplateMgmtPreviewEmailPage extends TemplateMgmtPreviewBasePage {
-  static readonly pageUrlSegment = 'preview-email-template';
+  static readonly pageUrlSegments = ['preview-email-template'];
 
   public readonly editRadioOption: Locator;
 

tests/test-team/pages/email/template-mgmt-preview-submitted-email-page.ts

@@ -2,7 +2,7 @@ import { Locator, Page } from '@playwright/test';
 import { TemplateMgmtPreviewSubmitedBasePage } from '../template-mgmt-preview-submitted-base-page';
 
 export class TemplateMgmtPreviewSubmittedEmailPage extends TemplateMgmtPreviewSubmitedBasePage {
-  static readonly pageUrlSegment = 'preview-submitted-email-template';
+  static readonly pageUrlSegments = ['preview-submitted-email-template'];
 
   public readonly subjectLineText: Locator;
 

tests/test-team/pages/email/template-mgmt-submit-email-page.ts

@@ -1,5 +1,5 @@
 import { TemplateMgmtSubmitBasePage } from '../template-mgmt-submit-base-page';
 
 export class TemplateMgmtSubmitEmailPage extends TemplateMgmtSubmitBasePage {
-  static readonly pageUrlSegment = 'submit-email-template';
+  static readonly pageUrlSegments = ['submit-email-template'];
 }

tests/test-team/pages/email/template-mgmt-template-submitted-email-page.ts

@@ -1,5 +1,5 @@
 import { TemplateMgmtTemplateSubmittedBasePage } from '../template-mgmt-template-submitted-base-page';
 
 export class TemplateMgmtTemplateSubmittedEmailPage extends TemplateMgmtTemplateSubmittedBasePage {
-  static readonly pageUrlSegment = 'email-template-submitted';
+  static readonly pageUrlSegments = ['email-template-submitted'];
 }

tests/test-team/pages/letter/template-mgmt-preview-letter-page.ts

@@ -2,7 +2,7 @@ import { Locator, Page } from '@playwright/test';
 import { TemplateMgmtPreviewBasePage } from '../template-mgmt-preview-base-page';
 
 export class TemplateMgmtPreviewLetterPage extends TemplateMgmtPreviewBasePage {
-  static readonly pageUrlSegment = 'preview-letter-template';
+  static readonly pageUrlSegments = ['preview-letter-template'];
 
   public static readonly urlRegexp = new RegExp(
     /\/templates\/preview-letter-template\/([\dA-Fa-f-]+)(?:\?from=edit)?$/

tests/test-team/pages/letter/template-mgmt-preview-submitted-letter-page.ts

@@ -1,5 +1,5 @@
 import { TemplateMgmtPreviewSubmitedBasePage } from '../template-mgmt-preview-submitted-base-page';
 
 export class TemplateMgmtPreviewSubmittedLetterPage extends TemplateMgmtPreviewSubmitedBasePage {
-  static readonly pageUrlSegment = 'preview-submitted-letter-template';
+  static readonly pageUrlSegments = ['preview-submitted-letter-template'];
 }

tests/test-team/pages/letter/template-mgmt-submit-letter-page.ts

@@ -1,7 +1,7 @@
 import { TemplateMgmtSubmitBasePage } from '../template-mgmt-submit-base-page';
 
 export class TemplateMgmtSubmitLetterPage extends TemplateMgmtSubmitBasePage {
-  static readonly pageUrlSegment = 'submit-letter-template';
+  static readonly pageUrlSegments = ['submit-letter-template'];
 
   public static readonly urlRegexp = new RegExp(
     /\/templates\/submit-letter-template\/([\dA-Fa-f-]+)$/