Merge pull request #3127 from IntersectMBO/develop

chore: update @intersect.mbo/govtool-outcomes-pillar-ui to 1.2.5

Author: MSzalowski

.github/scripts/set_commit_status.sh

@@ -9,7 +9,7 @@ fi
 # Retrieve necessary variables from workflow
 START_TIME=${START_TIME:-$(date +%s)}
 TEST_STATUS=${TEST_STATUS:-"failure"}
-REPORT_NUMBER=${REPORT_NUMBER:-1}
+REPORT_NUMBER=${REPORT_NUMBER:-0}
 REPORT_NAME=${REPORT_NAME:-"govtool-frontend"}
 HOST_URL=${HOST_URL:-"https://govtool.cardanoapi.io"}
 CONTEXT="Playwright Tests : $HOST_URL"
@@ -64,6 +64,12 @@ else
   TARGET_URL="https://github.com/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}"
 fi
 
+if [[ "$REPORT_NUMBER" == 0 ]]; then
+  DESCRIPTION="⚠️ Test execution failed due to missing report number"
+  TEST_STATUS="error"
+  TARGET_URL="https://github.com/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}"
+fi
+
 
 
 # Send commit status update to GitHub

govtool/frontend/package-lock.json

@@ -27,7 +27,7 @@
     "@emotion/styled": "^11.11.0",
     "@emurgo/cardano-serialization-lib-asmjs": "^12.1.1",
     "@hookform/resolvers": "^3.3.1",
-    "@intersect.mbo/govtool-outcomes-pillar-ui": "1.2.4",
+    "@intersect.mbo/govtool-outcomes-pillar-ui": "1.2.5",
     "@intersect.mbo/intersectmbo.org-icons-set": "^1.0.8",
     "@intersect.mbo/pdf-ui": "0.6.4",
     "@mui/icons-material": "^5.14.3",

govtool/frontend/package.json

@@ -1492,10 +1492,10 @@
   resolved "https://registry.npmjs.org/@inquirer/type/-/type-3.0.4.tgz"
   integrity sha512-2MNFrDY8jkFYc9Il9DgLsHhMzuHnOYM1+CUYVWbzu9oT0hC7V7EcYvdCKeoll/Fcci04A+ERZ9wcc7cQ8lTkIA==
 
-"@intersect.mbo/[email protected].4":
-  version "1.2.4"
-  resolved "https://registry.npmjs.org/@intersect.mbo/govtool-outcomes-pillar-ui/-/govtool-outcomes-pillar-ui-1.2.4.tgz"
-  integrity sha512-MQdbU2cQ4l5lUab+5WmugwzbgSrujnGoA6gZO297y2l/ZxAtX/PNjxm//F+G5CJuupl1lYEhRoo/WGE87oUOng==
+"@intersect.mbo/[email protected].5":
+  version "1.2.5"
+  resolved "https://registry.npmjs.org/@intersect.mbo/govtool-outcomes-pillar-ui/-/govtool-outcomes-pillar-ui-1.2.5.tgz"
+  integrity sha512-z0QDUZKj262vvNCtjr2L8ILgeub8da3ryhMhgLJpuxuO1zfEBUhTuwUPkRuLBE1Gf52TW/AfgmR2qXANsjY4/Q==
   dependencies:
     "@fontsource/poppins" "^5.0.14"
     "@intersect.mbo/intersectmbo.org-icons-set" "^1.0.8"

govtool/frontend/yarn.lock

@@ -23,3 +23,11 @@ export const guardrailsScript = {
 
 export const guardrailsScriptHash =
   "914d97d63e2b7113465739faddd82362b1deaeedbcc4d01016c35c6e";
+
+export const outcomeStatusType = [
+  "Expired",
+  "Not Ratified",
+  "Ratified",
+  "Enacted",
+  "Live",
+];

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

@@ -14,13 +14,13 @@ const monthNames = [
 ];
 
 export default function extractExpiryDateFromText(text: string): Date | null {
-  const regex = /(\d{1,2})(st|nd|rd|th) ([\w]{3}) (\d{4})/;
+  const regex = /(\d{1,2})(?:st|nd|rd|th)? (\w{3}) (\d{4})/;
   const match = text.match(regex);
 
   if (match) {
     const day = parseInt(match[1]);
-    const month = match[3];
-    const year = parseInt(match[4]);
+    const month = match[2];
+    const year = parseInt(match[3]);
 
     return new Date(year, monthNames.indexOf(month), day);
   } else {

tests/govtool-frontend/playwright/lib/helpers/extractExpiryDateFromText.ts

@@ -1,51 +1,112 @@
-import { GovernanceActionType, IProposal } from "@types";
+import {
+  GovernanceActionType,
+  IProposal,
+  outcomeProposal,
+  outcomeType,
+} from "@types";
 import { isBootStrapingPhase } from "./cardano";
 import { SECURITY_RELEVANT_PARAMS_MAP } from "@constants/index";
 
-export const areDRepVoteTotalsDisplayed = async (proposal: IProposal) => {
+const getProposalType = (
+  type: keyof typeof outcomeType,
+  fallback: GovernanceActionType,
+  proposal: IProposal | outcomeProposal
+) =>
+  "proposal_params" in proposal
+    ? Object.keys(outcomeType).find(
+        (key) => outcomeType[key] === outcomeType[type]
+      )
+    : fallback;
+
+export const areDRepVoteTotalsDisplayed = async (
+  proposal: IProposal | outcomeProposal
+) => {
   const isInBootstrapPhase = await isBootStrapingPhase();
   const isSecurityGroup = Object.values(SECURITY_RELEVANT_PARAMS_MAP).some(
-    (paramKey) =>
-      proposal.protocolParams?.[
-        paramKey as keyof typeof proposal.protocolParams
-      ] !== null
+    (paramKey) => {
+      const params =
+        "protocolParams" in proposal
+          ? proposal.protocolParams
+          : proposal.proposal_params;
+      return params?.[paramKey as keyof typeof params] !== null;
+    }
   );
+
   if (isInBootstrapPhase) {
+    const HardForkInitiation = getProposalType(
+      "HardForkInitiation",
+      GovernanceActionType.HardFork,
+      proposal
+    );
+
+    const ProtocolParameterChange = getProposalType(
+      "ParameterChange",
+      GovernanceActionType.ProtocolParameterChange,
+      proposal
+    );
+
     return !(
-      proposal.type === GovernanceActionType.HardFork ||
-      (proposal.type === GovernanceActionType.ProtocolParameterChange &&
-        !isSecurityGroup)
+      proposal.type === HardForkInitiation ||
+      (proposal.type === ProtocolParameterChange && !isSecurityGroup)
     );
   }
 
   return true;
 };
 
-export const areSPOVoteTotalsDisplayed = async (proposal: IProposal) => {
+export const areSPOVoteTotalsDisplayed = async (
+  proposal: IProposal | outcomeProposal
+) => {
   const isInBootstrapPhase = await isBootStrapingPhase();
   const isSecurityGroup = Object.values(SECURITY_RELEVANT_PARAMS_MAP).some(
-    (paramKey) =>
-      proposal.protocolParams?.[
-        paramKey as keyof typeof proposal.protocolParams
-      ] !== null
+    (paramKey) => {
+      const params =
+        "protocolParams" in proposal
+          ? proposal.protocolParams
+          : proposal.proposal_params;
+      return params?.[paramKey as keyof typeof params] !== null;
+    }
   );
+
+  const ProtocolParameterChange = getProposalType(
+    "ParameterChange",
+    GovernanceActionType.ProtocolParameterChange,
+    proposal
+  );
+  const UpdatetotheConstitution = getProposalType(
+    "NewConstitution",
+    GovernanceActionType.UpdatetotheConstitution,
+    proposal
+  );
+  const TreasuryWithdrawal = getProposalType(
+    "TreasuryWithdrawals",
+    GovernanceActionType.TreasuryWithdrawal,
+    proposal
+  );
+
   if (isInBootstrapPhase) {
-    return proposal.type !== GovernanceActionType.ProtocolParameterChange;
+    return proposal.type !== ProtocolParameterChange;
   }
 
   return !(
-    proposal.type === GovernanceActionType.UpdatetotheConstitution ||
-    proposal.type === GovernanceActionType.TreasuryWithdrawal ||
-    (proposal.type === GovernanceActionType.ProtocolParameterChange &&
-      !isSecurityGroup)
+    proposal.type === UpdatetotheConstitution ||
+    proposal.type === TreasuryWithdrawal ||
+    (proposal.type === ProtocolParameterChange && !isSecurityGroup)
   );
 };
 
 export const areCCVoteTotalsDisplayed = (
-  governanceActionType: GovernanceActionType
+  proposal: IProposal | outcomeProposal
 ) => {
-  return ![
+  const NoConfidence = getProposalType(
+    "NoConfidence",
     GovernanceActionType.NoConfidence,
+    proposal
+  );
+  const NewCommittee = getProposalType(
+    "NewCommittee",
     GovernanceActionType.NewCommittee,
-  ].includes(governanceActionType);
+    proposal
+  );
+  return ![NewCommittee, NoConfidence].includes(proposal.type);
 };

tests/govtool-frontend/playwright/lib/helpers/featureFlag.ts

@@ -4,14 +4,24 @@ export function extractProposalIdFromUrl(url: string) {
   return parseInt(url.split("/").pop());
 }
 
-export function generateExactLengthText(characterLength:number) {
-  let text = '';
-  
+export function generateExactLengthText(characterLength: number) {
+  let text = "";
+
   // Keep generating paragraphs until we exceed the required length
   while (text.length < characterLength) {
-      text += faker.lorem.paragraphs(10);
+    text += faker.lorem.paragraphs(10);
   }
-  
+
   // Truncate to the exact number of characters needed
   return text.substring(0, characterLength);
-}
+}
+
+export function toCamelCase(str: string) {
+  return str
+    .toLowerCase()
+    .split(" ")
+    .map((word, index) =>
+      index === 0 ? word : word.charAt(0).toUpperCase() + word.slice(1)
+    )
+    .join("");
+}

tests/govtool-frontend/playwright/lib/helpers/string.ts

@@ -99,7 +99,7 @@ export default class GovernanceActionsPage {
     await waitedLoop(async () => {
       return (
         (await this.page.locator('[data-testid$="-card"]').count()) > 0 ||
-        this.page.getByText("No results for the search.")
+        (await this.page.getByText("No results for the search.").isVisible())
       );
     });
     return this.page.locator('[data-testid$="-card"]').all();

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

@@ -0,0 +1,62 @@
+import environments from "@constants/environments";
+import { Page, Response } from "@playwright/test";
+import { outcomeProposal } from "@types";
+
+export default class OutcomeDetailsPage {
+  readonly dRepYesVotes = this.page.getByTestId("submitted-votes-dReps-yes");
+  readonly dRepNoVotes = this.page.getByTestId("submitted-votes-dReps-no");
+  readonly dRepNotVoted = this.page.getByTestId(
+    "submitted-votes-dReps-notVoted"
+  );
+  readonly dRepAbstainVotes = this.page.getByTestId(
+    "submitted-votes-dReps-abstain"
+  );
+
+  readonly sPosYesVotes = this.page.getByTestId("submitted-votes-sPos-yes");
+  readonly sPosNoVotes = this.page.getByTestId("submitted-votes-sPos-no");
+  readonly sPosAbstainVotes = this.page.getByTestId(
+    "submitted-votes-sPos-abstain"
+  );
+
+  readonly ccCommitteeYesVotes = this.page.getByTestId(
+    "submitted-votes-ccCommittee-yes"
+  );
+  readonly ccCommitteeNoVotes = this.page.getByTestId(
+    "submitted-votes-ccCommittee-no"
+  );
+  readonly ccCommitteeAbstainVotes = this.page.getByTestId(
+    "submitted-votes-ccCommittee-abstain"
+  );
+
+  constructor(private readonly page: Page) {}
+
+  get currentPage(): Page {
+    return this.page;
+  }
+
+  async goto(proposalId: string) {
+    await this.page.goto(
+      `${environments.frontendUrl}/outcomes/governance_actions/${proposalId}`
+    );
+  }
+
+  async getDRepTotalAbstainVoted(
+    proposal: outcomeProposal,
+    metricsResponses: Response
+  ): Promise<number | undefined> {
+    const alwaysAbstainVotingPower = await metricsResponses
+      .json()
+      .then((res) => res.alwaysAbstainVotingPower);
+    if (
+      alwaysAbstainVotingPower &&
+      typeof alwaysAbstainVotingPower === "number"
+    ) {
+      const totalAbstainVoted =
+        alwaysAbstainVotingPower + parseInt(proposal.abstain_votes);
+
+      return totalAbstainVoted;
+    } else {
+      return parseInt(proposal.abstain_votes);
+    }
+  }
+}