chore: add e2e test

Author: shon-button

bciers/apps/reporting-e2e/poms/past-reports.ts

@@ -1,6 +1,7 @@
 import { Page, expect } from "@playwright/test";
 import { CurrentReportsPOM } from "@/reporting-e2e/poms/current-reports";
-import { AppRoutes } from "../utils/enums";
+import { AppRoutes } from "@/reporting-e2e/utils/enums";
+import { GRID_BUTTON_TEXT } from "@/reporting-e2e/utils/constants";
 import { waitForGridReady } from "@bciers/e2e/utils/helpers";
 
 export class PastReportsPOM extends CurrentReportsPOM {
@@ -32,4 +33,21 @@ export class PastReportsPOM extends CurrentReportsPOM {
 
     await expect(row).toBeVisible({ timeout: 30_000 });
   }
+
+  async clickFileReport(): Promise<void> {
+    const expectedUrl = new RegExp(`${AppRoutes.PAGE_START_PAST_REPORT}$`, "i");
+
+    const link = this.page.getByRole("link", {
+      name: GRID_BUTTON_TEXT.FILE_PREVIOUS_YEARS_REPORT,
+    });
+
+    await expect(link).toBeVisible({ timeout: 30_000 });
+    await expect(link).toBeEnabled({ timeout: 30_000 });
+
+    await link.click();
+
+    await expect(this.page).toHaveURL(expectedUrl, {
+      timeout: 30_000,
+    });
+  }
 }

bciers/apps/reporting-e2e/poms/report-operation.ts

@@ -3,6 +3,7 @@ import {
   assertFieldVisibility,
   checkFormFieldsReadOnly,
 } from "@bciers/e2e/utils/helpers";
+import { ReportPageTitles, ReportRoutes } from "@/reporting-e2e/utils/enums";
 
 const OPERATION_INFO_FIELDS = {
   // Field labels
@@ -42,6 +43,19 @@ export class ReportOperationPOM {
     this.page = page;
   }
 
+  async isLoaded(): Promise<void> {
+    await expect(this.page).toHaveURL(
+      new RegExp(`/reports/\\d+/${ReportRoutes.REVIEW_OPERATION_INFORMATION}$`),
+      { timeout: 30_000 },
+    );
+
+    await expect(
+      this.page.getByRole("heading", {
+        name: ReportPageTitles.REVIEW_OPERATION_INFORMATION,
+      }),
+    ).toBeVisible();
+  }
+
   async verifyBugleSfoFields(): Promise<void> {
     // 1. Report type — combobox (name matches the start of the long label)
     await expect(

bciers/apps/reporting-e2e/poms/start-past-report.ts

@@ -0,0 +1,53 @@
+import { Page, expect } from "@playwright/test";
+import { fillComboxboxWidget } from "@bciers/e2e/utils/helpers";
+import { AppRoutes } from "@/reporting-e2e/utils/enums";
+import { FORM_BUTTON_TEXT } from "@/reporting-e2e/utils/constants";
+
+export class StartPastReportPOM {
+  constructor(private readonly page: Page) {}
+
+  async isLoaded(): Promise<void> {
+    await expect(this.page).toHaveURL(
+      new RegExp(`${AppRoutes.PAGE_START_PAST_REPORT}$`),
+    );
+
+    await expect(
+      this.page.getByRole("button", {
+        name: FORM_BUTTON_TEXT.START,
+      }),
+    ).toBeVisible();
+  }
+
+  async selectReportingYear(year: string): Promise<void> {
+    await fillComboxboxWidget(this.page, /select reporting year/i, year, true);
+  }
+
+  async selectOperation(operation: string): Promise<void> {
+    await fillComboxboxWidget(this.page, /select operation/i, operation, true);
+  }
+
+  async selectRegistrationPurpose(purpose: string): Promise<void> {
+    await fillComboxboxWidget(
+      this.page,
+      /select the registration/i,
+      purpose,
+      true,
+    );
+  }
+
+  async clickStart(): Promise<void> {
+    await this.page
+      .getByRole("button", {
+        name: FORM_BUTTON_TEXT.START,
+      })
+      .click();
+  }
+
+  async clickCancel(): Promise<void> {
+    await this.page
+      .getByRole("button", {
+        name: FORM_BUTTON_TEXT.CANCEL,
+      })
+      .click();
+  }
+}

bciers/apps/reporting-e2e/tests/workflows/start-past-report.spec.ts

@@ -0,0 +1,42 @@
+import { PastReportsPOM } from "@/reporting-e2e/poms/past-reports";
+import { StartPastReportPOM } from "@/reporting-e2e/poms/start-past-report";
+import { ReportOperationPOM } from "@/reporting-e2e/poms/report-operation";
+import { REGULATED_OPERATION_REGISTRATION_PURPOSE } from "@reporting/src/app/utils/constants";
+import { OPERATION_NAMES } from "@/reporting-e2e/utils/enums";
+import { setupBeforeAllTest } from "@bciers/e2e/setupBeforeAll";
+import { UserRole } from "@bciers/e2e/utils/enums";
+
+const test = setupBeforeAllTest(UserRole.INDUSTRY_USER_ADMIN);
+test.describe.configure({ mode: "serial" });
+
+test.describe("Start Past Report", () => {
+  test("Industry user can start a report for a previous reporting year", async ({
+    page,
+  }) => {
+    //  Setup POMs
+    const pastReports = new PastReportsPOM(page);
+    const startPastReport = new StartPastReportPOM(page);
+    const reportOperation = new ReportOperationPOM(page);
+
+    // Navigate to the past reports grid
+    await pastReports.route();
+
+    // Click button File previous years report
+    await pastReports.clickFileReport();
+
+    // Assert Report on a previous year page displays
+    await startPastReport.isLoaded();
+
+    // Complete form
+    await startPastReport.selectReportingYear("2024");
+    await startPastReport.selectOperation(OPERATION_NAMES.BUGLE_SFO);
+    await startPastReport.selectRegistrationPurpose(
+      REGULATED_OPERATION_REGISTRATION_PURPOSE,
+    );
+    //  Submit form
+    await startPastReport.clickStart();
+
+    // Assert Review Operation Information page displays
+    await reportOperation.isLoaded();
+  });
+});

bciers/apps/reporting-e2e/utils/constants.ts

@@ -29,10 +29,12 @@ export const DIALOG_BUTTON_TEXT = {
 
 // Form submit / navigation buttons
 export const FORM_BUTTON_TEXT = {
+  START: "Start",
   SAVE_AND_CONTINUE: "Save & Continue",
   SAVE: "Save",
   BACK: "Back",
   CONTINUE: "Continue",
+  CANCEL: "Cancel",
   RETURN_TO_FACILITY_REPORTS: "Return To All Facility Reports",
 } as const;
 
@@ -48,3 +50,7 @@ export const ACTION_BUTTON_TEXT = {
   VIEW_REPORT: "View Report",
   REPORT_HISTORY: "Report history",
 } as const;
+
+export const GRID_BUTTON_TEXT = {
+  FILE_PREVIOUS_YEARS_REPORT: "File previous years report",
+} as const;

bciers/apps/reporting-e2e/utils/enums.ts

@@ -2,6 +2,7 @@
 export enum AppRoutes {
   GRID_REPORTING_CURRENT_REPORTS = "reporting/reports",
   GRID_REPORTING_PAST_REPORTS = "reporting/reports/previous-years",
+  PAGE_START_PAST_REPORT = "reporting/reports/previous-years/report-on-a-previous-year",
   GRID_REPORT_HISTORY = "reporting/reports/report-history",
   GRID_REPORTING_ATTACHMENTS_LIST = "reporting/reports/attachments",
 }
@@ -50,6 +51,22 @@ export enum ReportRoutes {
   ANNUAL_REPORT = "annual-report",
 }
 
+export const ReportPageTitles = {
+  REVIEW_OPERATION_INFORMATION: "Review Operation Information",
+  PERSON_RESPONSIBLE: "Person Responsible for Submitting Report",
+  REVIEW_FACILITIES: "Review Facilities",
+  REVIEW_FACILITY_INFORMATION: "Review Facility Information",
+  FACILITY_GRID: "Facilities",
+  ADDITIONAL_REPORTING_DATA: "Additional Reporting Data",
+  EMISSION_SUMMARY: "Emission Summary",
+  COMPLIANCE_SUMMARY: "Compliance Summary",
+  REPORT_VALIDATION: "Report validation",
+  FINAL_REVIEW: "Final Review",
+  VERIFICATION: "Verification",
+  ATTACHMENTS: "Attachments",
+  SUBMISSION: "Submission",
+} as const;
+
 // Attachment checkboxes
 export enum AttachmentCheckboxLabel {
   UPDATED_REQUIRED = "uploaded any attachments that are required to be updated",

bciers/apps/reporting/src/app/components/operations/PastReportsPage.tsx

@@ -15,7 +15,7 @@ export default async function PastReportsPage({
     <div className="flex w-full justify-end pb-6">
       <Link
         className="link-button-blue"
-        href="../reports/previous-years/report-on-a-previous-year"
+        href="/reporting/reports/previous-years/report-on-a-previous-year"
       >
         File previous years report
       </Link>