Merge pull request #3691 from IntersectMBO/tests/budget-proposal-filter

Tests: budget proposal filter

Author: kneerose

tests/govtool-frontend/playwright/lib/constants/index.ts

@@ -1,5 +1,5 @@
 import { faker } from "@faker-js/faker";
-import { InvalidMetadataType } from "@types";
+import { BudgetProposalFilterTypes, InvalidMetadataType } from "@types";
 
 export const SECURITY_RELEVANT_PARAMS_MAP: Record<string, string> = {
   maxBlockBodySize: "max_block_size",
@@ -61,3 +61,15 @@ export const InvalidMetadata: InvalidMetadataType[] = [
     hash: "e71bf6171adda3754a87fff5c2d8d9e404eb3366428a5be13f7e76357a39004f",
   },
 ];
+
+export const budgetProposalfilterOptionNames: Array<BudgetProposalFilterTypes> =
+  [
+    "Newest",
+    "Oldest",
+    "Most comments",
+    "Least comments",
+    "Name A-Z",
+    "Name Z-A",
+    "Proposer A-Z",
+    "Proposer Z-A",
+  ];

tests/govtool-frontend/playwright/lib/pages/budgetDiscussionPage.ts

@@ -1,6 +1,10 @@
 import { functionWaitedAssert, waitedLoop } from "@helpers/waitedLoop";
 import { expect, Locator, Page } from "@playwright/test";
-import { BudgetDiscussionEnum, ProposedGovAction } from "@types";
+import {
+  BudgetDiscussionEnum,
+  BudgetProposalFilterTypes,
+  ProposedGovAction,
+} from "@types";
 import environments from "lib/constants/environments";
 import BudgetDiscussionDetailsPage from "./budgetDiscussionDetailsPage";
 
@@ -140,16 +144,29 @@ export default class BudgetDiscussionPage {
   }
 
   async sortAndValidate(
-    option: "asc" | "desc",
+    type: BudgetProposalFilterTypes,
     validationFn: (p1: ProposedGovAction, p2: ProposedGovAction) => boolean
   ) {
+    const sortMappings = {
+      "Proposer A-Z": "&sort[creator][govtool_username]=ASC",
+      "Proposer Z-A": "&sort[creator][govtool_username]=DESC",
+      "Name A-Z": "&sort[bd_proposal_detail][proposal_name]=ASC",
+      "Name Z-A": "&sort[bd_proposal_detail][proposal_name]=DESC",
+      "Most comments": "&sort[prop_comments_number]=DESC",
+      "Least comments": "&sort[prop_comments_number]=ASC",
+      Oldest: "&sort[createdAt]=ASC",
+      Newest: "&sort[createdAt]=DESC",
+    };
+
+    const urlParam = sortMappings[type];
+    const populateParam = "&populate[0]=bd_costing";
+
     const responsePromise = this.page.waitForResponse((response) =>
-      response
-        .url()
-        .includes(`&sort[createdAt]=${option}&populate[0]=bd_costing`)
+      response.url().includes(`${urlParam}${populateParam}`)
     );
 
     await this.sortBtn.click();
+    await this.page.getByTestId(`${type}-sort-option`).click();
     const response = await responsePromise;
 
     let proposals: ProposedGovAction[] = (await response.json()).data;

tests/govtool-frontend/playwright/lib/types.ts

@@ -196,13 +196,29 @@ export type ProposalCreateRequest = {
   has_guardrails?: boolean;
   is_draft: boolean;
 };
-
 export type ProposedGovAction = {
   id: number;
   attributes: {
     gov_action_type_name: string;
+    prop_comments_number: number;
     createdAt: string;
     updatedAt: string;
+    creator: {
+      data: {
+        id: number;
+        attributes: {
+          govtool_username: string;
+        };
+      };
+    };
+    bd_proposal_detail: {
+      data: {
+        id: number;
+        attributes: {
+          proposal_name: string;
+        };
+      };
+    };
   };
 };
 
@@ -521,3 +537,13 @@ export enum BudgetProposalStageEnum {
 }
 
 export type VoterType = "DReps" | "SPOs" | "CC";
+
+export type BudgetProposalFilterTypes =
+  | "Newest"
+  | "Oldest"
+  | "Most comments"
+  | "Least comments"
+  | "Name A-Z"
+  | "Name Z-A"
+  | "Proposer A-Z"
+  | "Proposer Z-A";

tests/govtool-frontend/playwright/tests/11-proposal-budget/proposalBudget.spec.ts

@@ -1,4 +1,5 @@
 import environments from "@constants/environments";
+import { budgetProposalfilterOptionNames } from "@constants/index";
 import { faker } from "@faker-js/faker";
 import { test } from "@fixtures/walletExtension";
 import { setAllureEpic } from "@helpers/allure";
@@ -8,7 +9,11 @@ import { functionWaitedAssert } from "@helpers/waitedLoop";
 import BudgetDiscussionDetailsPage from "@pages/budgetDiscussionDetailsPage";
 import BudgetDiscussionPage from "@pages/budgetDiscussionPage";
 import { expect } from "@playwright/test";
-import { BudgetDiscussionEnum } from "@types";
+import {
+  BudgetDiscussionEnum,
+  BudgetProposalFilterTypes,
+  ProposedGovAction,
+} from "@types";
 
 const mockBudgetProposal = require("../../lib/_mock/budgetProposal.json");
 const mockPoll = require("../../lib/_mock/budgetProposalPoll.json");
@@ -103,15 +108,41 @@ test.describe("Budget proposal list manipulation", () => {
     });
 
     test("11B_3. Should sort budget proposals", async () => {
-      await budgetDiscussionPage.sortAndValidate(
-        "asc",
-        (p1, p2) => p1.attributes.createdAt <= p2.attributes.createdAt
-      );
-
-      await budgetDiscussionPage.sortAndValidate(
-        "desc",
-        (p1, p2) => p1.attributes.createdAt >= p2.attributes.createdAt
-      );
+      const sortOptions = {
+        Oldest: (p1: ProposedGovAction, p2: ProposedGovAction) =>
+          p1.attributes.createdAt <= p2.attributes.createdAt,
+        Newest: (p1: ProposedGovAction, p2: ProposedGovAction) =>
+          p1.attributes.createdAt >= p2.attributes.createdAt,
+        "Most comments": (p1: ProposedGovAction, p2: ProposedGovAction) =>
+          p1.attributes.prop_comments_number >=
+          p2.attributes.prop_comments_number,
+        "Least comments": (p1: ProposedGovAction, p2: ProposedGovAction) =>
+          p1.attributes.prop_comments_number <=
+          p2.attributes.prop_comments_number,
+        "Name A-Z": (p1: ProposedGovAction, p2: ProposedGovAction) =>
+          p1.attributes.bd_proposal_detail.data.attributes.proposal_name.localeCompare(
+            p2.attributes.bd_proposal_detail.data.attributes.proposal_name
+          ) <= 0,
+        "Name Z-A": (p1: ProposedGovAction, p2: ProposedGovAction) =>
+          p1.attributes.bd_proposal_detail.data.attributes.proposal_name.localeCompare(
+            p2.attributes.bd_proposal_detail.data.attributes.proposal_name
+          ) >= 0,
+        "Proposer A-Z": (p1: ProposedGovAction, p2: ProposedGovAction) =>
+          p1.attributes.creator.data.attributes.govtool_username.localeCompare(
+            p2.attributes.creator.data.attributes.govtool_username
+          ) <= 0,
+        "Proposer Z-A": (p1: ProposedGovAction, p2: ProposedGovAction) =>
+          p1.attributes.creator.data.attributes.govtool_username.localeCompare(
+            p2.attributes.creator.data.attributes.govtool_username
+          ) >= 0,
+      };
+
+      for (const [option, validationFn] of Object.entries(sortOptions)) {
+        await budgetDiscussionPage.sortAndValidate(
+          option as BudgetProposalFilterTypes,
+          validationFn
+        );
+      }
     });
   });
 });