@ministryofjustice/hmpps-probation-integration-e2e-tests 1.199.0 → 1.200.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ministryofjustice/hmpps-probation-integration-e2e-tests",
   "description": "Playwright end to end tests for hmpps-probation-integration-services.",
-  "version": "1.199.0",
+  "version": "1.200.0",
   "license": "MIT",
   "homepage": "https://github.com/ministryofjustice/hmpps-probation-integration-e2e-tests#readme",
   "bugs": {
@@ -138,12 +138,14 @@
     "./steps/delius/upw/checkAppointmentDetails": "./steps/delius/upw/checkAppointmentDetails.mjs",
     "./steps/delius/upw/create-upw-project": "./steps/delius/upw/create-upw-project.mjs",
     "./steps/delius/upw/start-upw-assessment": "./steps/delius/upw/start-upw-assessment.mjs",
+    "./steps/delius/upw/verify-time-credited": "./steps/delius/upw/verify-time-credited.mjs",
     "./steps/delius/utils/contact": "./steps/delius/utils/contact.mjs",
     "./steps/delius/utils/date-time": "./steps/delius/utils/date-time.mjs",
     "./steps/delius/utils/inputs": "./steps/delius/utils/inputs.mjs",
     "./steps/delius/utils/pdf-utils": "./steps/delius/utils/pdf-utils.mjs",
     "./steps/delius/utils/person": "./steps/delius/utils/person.mjs",
     "./steps/delius/utils/refresh": "./steps/delius/utils/refresh.mjs",
+    "./steps/delius/utils/table": "./steps/delius/utils/table.mjs",
     "./steps/dps/caseload": "./steps/dps/caseload.mjs",
     "./steps/dps/login": "./steps/dps/login.mjs",
     "./steps/hdc-licences/login": "./steps/hdc-licences/login.mjs",

package/steps/delius/upw/checkAppointmentDetails.mjs

@@ -1,29 +1,7 @@
 import { waitForAjax } from "../utils/refresh.mjs";
+import { getRowByContent, getRowCellsByContent } from "../utils/table.mjs";
 import { expect } from "@playwright/test";
 //#region steps/delius/upw/checkAppointmentDetails.ts
-async function clickNextButton(page) {
-	const nextButtonSelector = "a.page-link[title=\"Next\"]:not(.disabled)";
-	await page.waitForSelector(nextButtonSelector, { state: "visible" });
-	await page.click(nextButtonSelector);
-	await waitForAjax(page);
-	await page.waitForSelector("#searchResultsTable tbody");
-	return true;
-}
-async function getRowByContent(page, content) {
-	const row = page.locator(`#searchResultsTable tbody tr:has-text("${content}")`).first();
-	if (await row.isVisible().catch(() => false)) return row;
-	if (await page.locator("a.page-link[title=\"Next\"]:not(.disabled)").count() > 0) {
-		await clickNextButton(page);
-		return getRowByContent(page, content);
-	}
-	throw new Error(`Row with content "${content}" not found`);
-}
-async function getCellContents(row) {
-	const cellElements = await row.locator("td").all();
-	return await Promise.all(cellElements.map(async (td) => {
-		return (await td.innerText()).trim();
-	}));
-}
 async function checkAppointmentOnDelius(page, checkAppointmentOptions) {
 	const { teamProvider, teamName, projectName, popCrn, popName, startTime, endTime, penalty, outcome, enforcementAction, hoursCredited, outStanding } = checkAppointmentOptions;
 	await page.getByRole("combobox", { name: "Provider:" }).selectOption(teamProvider);
@@ -31,10 +9,10 @@ async function checkAppointmentOnDelius(page, checkAppointmentOptions) {
 	await page.getByRole("button", { name: "Search" }).click();
 	await waitForAjax(page);
 	await page.waitForSelector("h2:text-is(\"Project List\")");
-	await (await getRowByContent(page, projectName)).getByRole("link", { name: "manage" }).click();
+	await (await getRowByContent(page, "searchResultsTable", projectName)).getByRole("link", { name: "manage" }).click();
 	await page.waitForSelector("h2:text-is(\"Allocated To Attend\")");
-	const cells = await getCellContents(page.locator("#allocatedOffendersTable tbody tr").filter({ has: page.locator(`td:first-child:text-is("${popCrn}")`) }));
-	expect(cells[0]).toBe(popCrn);
+	const cells = await getRowCellsByContent(page, "allocatedOffendersTable", popCrn);
+	expect(cells[0]).toContain(popCrn);
 	expect(cells[1]).toBe(popName);
 	expect(cells[2]).toBe(startTime);
 	expect(cells[3]).toBe(endTime);

package/steps/delius/upw/verify-time-credited.d.mts

@@ -0,0 +1,20 @@
+import { Page } from "@playwright/test";
+
+//#region steps/delius/upw/verify-time-credited.d.ts
+interface Options {
+  crn: string;
+  eventNumber?: number;
+  projectName: string;
+  date: Date;
+  hoursCredited: string;
+  outcome: string;
+}
+declare function verifyTimeCredited(page: Page, {
+  crn,
+  eventNumber,
+  projectName,
+  hoursCredited,
+  outcome
+}: Options): Promise<void>;
+//#endregion
+export { verifyTimeCredited as default };

package/steps/delius/upw/verify-time-credited.mjs

@@ -0,0 +1,19 @@
+import { waitForAjax } from "../utils/refresh.mjs";
+import { findEventByCRN } from "../event/find-events.mjs";
+import { verifyTableRowByContent } from "../utils/table.mjs";
+//#region steps/delius/upw/verify-time-credited.ts
+async function verifyTimeCredited(page, { crn, eventNumber = 1, projectName, hoursCredited, outcome }) {
+	await findEventByCRN(page, crn, eventNumber);
+	await page.click("#navigation-include\\:linkNavigation3UnpaidWork");
+	await page.getByRole("button", { name: "Worksheet summary" }).click();
+	await waitForAjax(page);
+	await verifyTableRowByContent(page, "appointmentsTable", projectName, [{
+		columnName: "Hrs Credited",
+		cellContent: hoursCredited
+	}, {
+		columnName: "Outcome",
+		cellContent: outcome
+	}]);
+}
+//#endregion
+export { verifyTimeCredited as default };

package/steps/delius/utils/table.d.mts

@@ -0,0 +1,11 @@
+import { Locator, Page } from "@playwright/test";
+
+//#region steps/delius/utils/table.d.ts
+declare function getRowByContent(page: Page, tableId: string, content: string): Promise<Locator>;
+declare function getRowCellsByContent(page: Page, tableId: string, content: string): Promise<string[]>;
+declare function verifyTableRowByContent(page: Page, tableId: string, rowIdentifyingContent: string, toVerify: Array<{
+  columnName: string;
+  cellContent: string;
+}>): Promise<void>;
+//#endregion
+export { getRowByContent, getRowCellsByContent, verifyTableRowByContent };

package/steps/delius/utils/table.mjs

@@ -0,0 +1,31 @@
+import { waitForAjax } from "./refresh.mjs";
+import { expect } from "@playwright/test";
+//#region steps/delius/utils/table.ts
+async function getRowByContent(page, tableId, content) {
+	const tableLocator = page.locator(`#${tableId}`);
+	await expect(tableLocator).toBeVisible();
+	const row = tableLocator.getByRole("row").filter({ hasText: content });
+	try {
+		await expect(row).toBeVisible();
+		return row;
+	} catch {
+		const nextPageButtonLocator = page.getByRole("link", { name: "Next" });
+		await expect(nextPageButtonLocator, `Expected - ${content} - not found, try next page`).toBeVisible();
+		await nextPageButtonLocator.click();
+		await waitForAjax(page);
+		return getRowByContent(page, tableId, content);
+	}
+}
+async function getRowCellsByContent(page, tableId, content) {
+	return await (await getRowByContent(page, tableId, content)).getByRole("cell").allTextContents();
+}
+async function verifyTableRowByContent(page, tableId, rowIdentifyingContent, toVerify) {
+	const tableLocator = page.locator(`#${tableId}`);
+	const rowCellsByContent = await getRowCellsByContent(page, tableId, rowIdentifyingContent);
+	const headerRowCells = await tableLocator.getByRole("columnheader").allTextContents();
+	toVerify.forEach((verification) => {
+		expect(rowCellsByContent[headerRowCells.findIndex((cell) => cell.includes(verification.columnName))]).toContain(verification.cellContent);
+	});
+}
+//#endregion
+export { getRowByContent, getRowCellsByContent, verifyTableRowByContent };