CCM-16489: Add letter authoring e2e tests

tests/test-team/fixtures/letters/index.ts

@@ -21,6 +21,7 @@ const getFile = (directory: string, filename: string) => {
 
   return {
     filepath,
+    filename,
     open: () => {
       const opened = files.get(filepath);
 
@@ -73,5 +74,6 @@ export const docxFixtures = {
   randomBytes: getFile('docx', 'random-bytes.docx'),
   randomBytesZipped: getFile('docx', 'random-bytes-zipped.docx'),
   standard: getFile('docx', 'standard-english-template.docx'),
+  spanish: getFile('docx', 'spanish-letter-template.docx'),
   unexpectedAddressLines: getFile('docx', 'unexpected-address-lines.docx'),
 };

tests/test-team/pages/letter/template-mgmt-choose-printing-and-postage-page.ts

@@ -4,6 +4,10 @@ import { TemplateMgmtBasePage } from '../template-mgmt-base-page';
 export class TemplateMgmtChoosePrintingAndPostagePage extends TemplateMgmtBasePage {
   static readonly pathTemplate = '/choose-printing-and-postage/:templateId';
 
+  public static readonly urlRegexp = new RegExp(
+    /\/templates\/choose-printing-and-postage\/[\dA-Fa-f-]+/
+  );
+
   variantsTable: Locator;
 
   submitButton: Locator;

tests/test-team/pages/letter/template-mgmt-get-ready-to-approve-letter-template-page.ts

@@ -5,6 +5,10 @@ export class TemplateMgmtGetReadyToApproveLetterTemplatePage extends TemplateMgm
   static readonly pathTemplate =
     '/get-ready-to-approve-letter-template/:templateId';
 
+  public static readonly urlRegexp = new RegExp(
+    /\/templates\/get-ready-to-approve-letter-template\/[\dA-Fa-f-]+/
+  );
+
   public readonly continueButton: Locator;
   public readonly backButton: Locator;
 

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

@@ -7,7 +7,7 @@ export class TemplateMgmtPreviewLetterPage extends TemplateMgmtPreviewBasePage {
   static readonly pathTemplate = '/preview-letter-template/:templateId';
 
   public static readonly urlRegexp = new RegExp(
-    /\/templates\/preview-letter-template\/([\dA-Fa-f-]+)(?:\?from=edit)?$/
+    /\/templates\/preview-letter-template\/([\dA-Fa-f-]+)(?:\?from=(edit|upload))?$/
   );
 
   public readonly errorSummary: Locator;
@@ -24,6 +24,7 @@ export class TemplateMgmtPreviewLetterPage extends TemplateMgmtPreviewBasePage {
   public readonly statusAction: Locator;
   public readonly campaignAction: Locator;
   public readonly printingAndPostage: Locator;
+  public readonly printingAndPostageAction: Locator;
 
   public readonly tabbedRenderSection: Locator;
 
@@ -57,6 +58,7 @@ export class TemplateMgmtPreviewLetterPage extends TemplateMgmtPreviewBasePage {
     this.statusAction = page.getByTestId('status-action');
     this.campaignAction = page.getByTestId('campaign-action');
     this.printingAndPostage = page.locator('[id="printing-and-postage"]');
+    this.printingAndPostageAction = page.getByTestId('printing-postage-action');
 
     this.tabbedRenderSection = page.locator('section').filter({
       has: page.getByRole('heading', { name: 'Letter preview' }),

tests/test-team/pages/letter/template-mgmt-review-and-approve-letter-template-page.ts

@@ -6,15 +6,23 @@ export class TemplateMgmtReviewAndApproveLetterTemplatePage extends TemplateMgmt
     '/review-and-approve-letter-template/:templateId';
 
   public static readonly urlRegexp = new RegExp(
-    /\/templates\/review-and-approve-letter-template\/([\dA-Fa-f-]+)$/
+    /\/templates\/review-and-approve-letter-template\/([\dA-Fa-f-]+)(?:\?lockNumber=(\d))?$/
   );
 
   readonly approveButton: Locator;
+  readonly shortRenderIFrame: Locator;
+  readonly longRenderIFrame: Locator;
 
   constructor(page: Page) {
     super(page);
 
     this.approveButton = page.getByRole('button', { name: 'Approve' });
+    this.shortRenderIFrame = page.locator(
+      'iframe[title="Letter preview - short examples"]'
+    );
+    this.longRenderIFrame = page.locator(
+      'iframe[title="Letter preview - long examples"]'
+    );
   }
 
   async clickApproveButton() {

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

@@ -1,7 +1,7 @@
 import type { Locator, Page } from '@playwright/test';
-import { TemplateMgmtBasePage } from '../template-mgmt-base-page';
+import { TemplateMgmtUploadLetterBasePage } from './template-mgmt-upload-letter-base-page';
 
-export class TemplateMgmtUploadBSLLetterTemplatePage extends TemplateMgmtBasePage {
+export class TemplateMgmtUploadBSLLetterTemplatePage extends TemplateMgmtUploadLetterBasePage {
   static readonly pathTemplate =
     '/upload-british-sign-language-letter-template';
 
@@ -30,4 +30,18 @@ export class TemplateMgmtUploadBSLLetterTemplatePage extends TemplateMgmtBasePag
       name: 'Upload letter template file',
     });
   }
+
+  async fillForm(input: {
+    name: string;
+    campaignId: string;
+    filePath: string;
+    language?: string;
+  }) {
+    await this.nameInput.fill(input.name);
+
+    await this.campaignIdInput.selectOption(input.campaignId);
+
+    await this.fileInput.click();
+    await this.fileInput.setInputFiles(input.filePath);
+  }
 }

tests/test-team/pages/letter/template-mgmt-upload-large-print-letter-template-page.ts

@@ -1,7 +1,7 @@
 import type { Locator, Page } from '@playwright/test';
-import { TemplateMgmtBasePage } from '../template-mgmt-base-page';
+import { TemplateMgmtUploadLetterBasePage } from './template-mgmt-upload-letter-base-page';
 
-export class TemplateMgmtUploadLargePrintLetterTemplatePage extends TemplateMgmtBasePage {
+export class TemplateMgmtUploadLargePrintLetterTemplatePage extends TemplateMgmtUploadLetterBasePage {
   static readonly pathTemplate = '/upload-large-print-letter-template';
 
   nameInput: Locator;
@@ -29,4 +29,18 @@ export class TemplateMgmtUploadLargePrintLetterTemplatePage extends TemplateMgmt
       name: 'Upload letter template file',
     });
   }
+
+  async fillForm(input: {
+    name: string;
+    campaignId: string;
+    filePath: string;
+    language?: string;
+  }) {
+    await this.nameInput.fill(input.name);
+
+    await this.campaignIdInput.selectOption(input.campaignId);
+
+    await this.fileInput.click();
+    await this.fileInput.setInputFiles(input.filePath);
+  }
 }

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

@@ -0,0 +1,23 @@
+import { Locator, Page } from '@playwright/test';
+import { TemplateMgmtBasePage } from 'pages/template-mgmt-base-page';
+
+export class TemplateMgmtUploadLetterBasePage extends TemplateMgmtBasePage {
+  submitButton: Locator;
+
+  constructor(page: Page) {
+    super(page);
+
+    this.submitButton = page.getByRole('button', {
+      name: 'Upload letter template file',
+    });
+  }
+
+  async fillForm(input: {
+    name: string;
+    campaignId: string;
+    filePath: string;
+    language?: string;
+  }) {
+    throw new Error('This method should be overridden');
+  }
+}

tests/test-team/pages/letter/template-mgmt-upload-other-language-letter-template-page.ts

@@ -1,7 +1,7 @@
 import type { Locator, Page } from '@playwright/test';
-import { TemplateMgmtBasePage } from '../template-mgmt-base-page';
+import { TemplateMgmtUploadLetterBasePage } from './template-mgmt-upload-letter-base-page';
 
-export class TemplateMgmtUploadOtherLanguageLetterTemplatePage extends TemplateMgmtBasePage {
+export class TemplateMgmtUploadOtherLanguageLetterTemplatePage extends TemplateMgmtUploadLetterBasePage {
   static readonly pathTemplate = '/upload-other-language-letter-template';
 
   nameInput: Locator;
@@ -33,4 +33,24 @@ export class TemplateMgmtUploadOtherLanguageLetterTemplatePage extends TemplateM
       name: 'Upload letter template file',
     });
   }
+
+  async fillForm(input: {
+    name: string;
+    campaignId: string;
+    filePath: string;
+    language?: string;
+  }) {
+    await this.nameInput.fill(input.name);
+
+    await this.campaignIdInput.selectOption(input.campaignId);
+
+    await this.fileInput.click();
+    await this.fileInput.setInputFiles(input.filePath);
+
+    if (!input.language) {
+      return;
+    }
+
+    await this.languageInput.selectOption(input.language);
+  }
 }

tests/test-team/pages/letter/template-mgmt-upload-standard-english-letter-template-page.ts

@@ -1,7 +1,7 @@
 import type { Locator, Page } from '@playwright/test';
-import { TemplateMgmtBasePage } from '../template-mgmt-base-page';
+import { TemplateMgmtUploadLetterBasePage } from './template-mgmt-upload-letter-base-page';
 
-export class TemplateMgmtUploadStandardEnglishLetterTemplatePage extends TemplateMgmtBasePage {
+export class TemplateMgmtUploadStandardEnglishLetterTemplatePage extends TemplateMgmtUploadLetterBasePage {
   static readonly pathTemplate = '/upload-standard-english-letter-template';
 
   nameInput: Locator;
@@ -29,4 +29,18 @@ export class TemplateMgmtUploadStandardEnglishLetterTemplatePage extends Templat
       name: 'Upload letter template file',
     });
   }
+
+  async fillForm(input: {
+    name: string;
+    campaignId: string;
+    filePath: string;
+    language?: string;
+  }) {
+    await this.nameInput.fill(input.name);
+
+    await this.campaignIdInput.selectOption(input.campaignId);
+
+    await this.fileInput.click();
+    await this.fileInput.setInputFiles(input.filePath);
+  }
 }