CCM-16489: Add letter authoring e2e tests by andykay-nhs · Pull Request #930 · NHSDigital/nhs-notify-web-template-management

andykay-nhs · 2026-04-30T13:22:10Z

Description

for each letter type

create a new template of the letter type
upload standard docx. (Im unsure if the template type matters here? the rendered output isn't checked. I did create a spanish translated copy of the standard template but if we're not actually validating the final rendered content then I'm not sure this matters and just the standard one works?)
validates persisted template data is expected by querying dynamo via templateStorageHelper. (Saw this in the existing pdf-letter e2e tests)
edit template name
edit template campaign
set printing and postage. (Do we need further e2e tests for different printing and postage types? or is setting the same one okay for this?)
fill out short and long form preview inputs and update preview
approve
confirm approved status of template in template list view
validate approved template cannot be edited

One test covers off invalid template scenario (missing address).

Added arabic and large print letters.

Tests succeeding locally:

Context

Type of changes

Refactoring (non-breaking change)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would change existing functionality)
Bug fix (non-breaking change which fixes an issue)

Checklist

I am familiar with the contributing guidelines
I have followed the code style of the project
I have added tests to cover my changes
I have updated the documentation accordingly
This PR is a result of pair or mob programming

Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.

I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes.

Description

Raising draft to check CI pipeline status

for each letter type

create a new template of the letter type
upload standard docx. (Im unsure if the template type matters here? the rendered output isn't checked. I did create a spanish translated copy of the standard template but if we're not actually validating the final rendered content then I'm not sure this matters and just the standard one works?)
validates persisted template data is expected by querying dynamo via templateStorageHelper. (Saw this in the existing pdf-letter e2e tests)
set printing and postage. (Do we need further e2e tests for different printing and postage types? or is setting the same one okay for this?)
fill out short and long form preview inputs and update preview
approve
confirm approved status of template in template list view

Context

Type of changes

Refactoring (non-breaking change)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would change existing functionality)
Bug fix (non-breaking change which fixes an issue)

Checklist

I am familiar with the contributing guidelines
I have followed the code style of the project
I have added tests to cover my changes
I have updated the documentation accordingly
This PR is a result of pair or mob programming

Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.

I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes.

…e test

alexnuttall · 2026-05-01T14:31:19Z

+    });
+  }
+
+  // Method not intended for use


Could this be made to work as an abstract method?

i had no idea there even was an abstract keyword in typescript! will give this a go

alexnuttall · 2026-05-01T14:45:37Z

+        await chooseTemplateTypePage.clickContinueButton();
+
+        await expect(page).toHaveURL(
+          TemplateMgmtBasePage.appUrlSegment + uploadPage.pathTemplate


uploadPage.getUrl()?

alexnuttall · 2026-05-01T14:49:59Z

+
+          await expect(async () => {
+            const template = await templateStorageHelper.getTemplate(key);
+            expect(template.campaignId).toEqual(campaignId);


I wonder if it's better to use toMatchObject or similar, instead of individual assertions, because then if an assertion fails, you get the whole object printed out, which can be more useful than just the single property

alexnuttall · 2026-05-01T14:54:14Z

+      const choosePrintingAndPostagePage =
+        new TemplateMgmtChoosePrintingAndPostagePage(page);
+      const letterVariants =
+        await context.letterVariants.getGlobalLetterVariants();


What did you think to the idea of using client or campaign specific, rather than global letter variants in some of these tests?

I thought that because it was covered off in depth else where then it wouldn't really add much value to this but I suppose it could be another parameter to add in to the tests so each letter type is tested with a different variant

That's fine, I don't disagree, just wondered

alexnuttall · 2026-05-01T15:03:36Z

+        await shortTab.clickUpdatePreview();
+
+        await expect(async () => {
+          const template = await templateStorageHelper.getTemplate(templateKey);


The backend rendering test is already doing this kind of assertion on personalisationParameters, status, etc. I think it might be better to depend more on UI assertions here.

also would be good to show that the iframe URL has been updated since viewing the intial (unpersonalised) render

yeah totally agree, think I copied this over from the existing pdf letter e2e tests but in hindsight it should really only be making assertions based on whats in the UI

I guess there's not much you can get from the UI, though, so there's a case for leaving this in

alexnuttall · 2026-05-01T15:08:31Z

+        }, 'Persisted long form render is updated with correct personalisation details').toPass(
+          { timeout: 40_000 }
+        );
+      });


maybe flip between the tabs and assert on the changing iframe URL, and the personalisation fields?

alexnuttall · 2026-05-01T15:09:22Z

+          TemplateMgmtReviewAndApproveLetterTemplatePage.urlRegexp
+        );
+
+        await expect(reviewAndApprovePage.shortRenderIFrame).toBeAttached();


the iframe URLs should match those of the personalised renders from earlier

alexnuttall · 2026-05-01T15:12:08Z

+
+      await test.step('Template is listed and approved', async () => {
+        await expect(page).toHaveURL(
+          `/templates${TemplateMgmtMessageTemplatesPage.pathTemplate}`


new TemplateMgmtMessageTemplatesPage(page).getUrl()?

alexnuttall · 2026-05-01T15:13:48Z

+        expect(templateStatus).toEqual('Approved');
+      });
+
+      await test.step('Approved template cannot be edited', async () => {


it can be deleted, so that could be added as a final step

alexnuttall · 2026-05-01T15:14:47Z

+    await chooseTemplateTypePage.getLetterTypeRadio('x0').click();
+    await chooseTemplateTypePage.clickContinueButton();
+
+    await expect(page).toHaveURL(


as elsewhere, can you use getUrl?

alexnuttall · 2026-05-01T15:18:35Z

+            expect(template.files?.docxTemplate?.virusScanStatus).toEqual(
+              'PASSED'
+            );
+            expect(template.templateStatus).toEqual('PENDING_VALIDATION');


If you're going to assert on the (transitory) PENDING_VALIDATION, you might as well assert on the spinner being visible too

alexnuttall · 2026-05-01T15:20:51Z

+
+    await expect(async () => {
+      const template = await templateStorageHelper.getTemplate(key);
+      expect(template.campaignId).toEqual(campaignId);


as above, consider using toMatchObject, and whether all these details need to be checked

andykay-nhs force-pushed the feature/CCM-16489 branch 3 times, most recently from bcfb235 to 5de6a57 Compare May 1, 2026 09:26

andykay-nhs added 5 commits May 1, 2026 14:34

Rename legacy letter e2e tests, add new standard letter happy path e2…

89e2235

…e test

Parameterise e2e test for different letter types

94a6529

Complete happy path letter tests

d082c23

Add validation failed test

7513a86

Add edit template test steps

e471aad

andykay-nhs force-pushed the feature/CCM-16489 branch from 5cb1262 to 5a8a9d4 Compare May 1, 2026 13:34

Add large print and arabic letters

aa1ec8e

andykay-nhs force-pushed the feature/CCM-16489 branch from 5a8a9d4 to aa1ec8e Compare May 1, 2026 13:35

andykay-nhs marked this pull request as ready for review May 1, 2026 13:36

andykay-nhs requested a review from a team as a code owner May 1, 2026 13:36

alexnuttall reviewed May 1, 2026

View reviewed changes

Conversation

andykay-nhs commented Apr 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Context

Type of changes

Checklist

Sensitive Information Declaration

Description

Context

Type of changes

Checklist

Sensitive Information Declaration

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexnuttall May 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexnuttall May 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexnuttall May 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

andykay-nhs commented Apr 30, 2026 •

edited

Loading

alexnuttall May 1, 2026 •

edited

Loading

alexnuttall May 1, 2026 •

edited

Loading

alexnuttall May 1, 2026 •

edited

Loading