Merge pull request #1055 from IntersectMBO/enhancement/allure-report

Enhance allure dashboard visibility

tests/govtool-frontend/playwright/.gitignore

@@ -13,4 +13,4 @@ allure-report/
 .secrets
 .vars
 .lock-pool/
-.logs/
+.logs/

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

@@ -0,0 +1,18 @@
+import { allure } from "allure-playwright";
+import { isMobile } from "./mobile";
+import { chromium } from "@playwright/test";
+
+export const setAllureEpic = async (groupName: string) => {
+  const browser = await chromium.launch();
+  const page = await browser.newPage();
+  if (isMobile(page)) {
+    await allure.epic("6. Miscellaneous");
+    await allure.story("6A. Should be accessible from mobile");
+  } else {
+    await allure.epic(groupName);
+  }
+};
+
+export const setAllureStory = async (groupName: string) => {
+  await allure.story(groupName);
+};

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

@@ -83,21 +83,12 @@ export default class DRepRegistrationPage {
     await this.linkInput.fill(link);
 
     for (const err of formErrors.dRepName) {
-      await expect(
-        this.page.getByTestId(err),
-        `Invalid name: ${name}`
-      ).toBeHidden();
+      await expect(this.page.getByTestId(err)).toBeHidden();
     }
 
-    await expect(
-      this.page.getByTestId(formErrors.email),
-      `Invalid email: ${email}`
-    ).toBeHidden();
+    await expect(this.page.getByTestId(formErrors.email)).toBeHidden();
 
-    expect(
-      await this.bioInput.textContent(),
-      "Bio exceeded 500 characters"
-    ).toEqual(bio);
+    expect(await this.bioInput.textContent()).toEqual(bio);
 
     await expect(this.page.getByTestId(formErrors.link)).toBeHidden();
 
@@ -127,17 +118,11 @@ export default class DRepRegistrationPage {
       })
       .all();
 
-    expect(nameErrors.length, `Valid name: ${name}`).toEqual(1);
+    expect(nameErrors.length).toEqual(1);
 
-    await expect(
-      this.page.getByTestId(formErrors.email),
-      `Valid email: ${email}`
-    ).toBeVisible();
+    await expect(this.page.getByTestId(formErrors.email)).toBeVisible();
 
-    expect(
-      await this.bioInput.textContent(),
-      "Bio less than 500 characters"
-    ).not.toEqual(bio);
+    expect(await this.bioInput.textContent()).not.toEqual(bio);
 
     await expect(this.page.getByTestId(formErrors.link)).toBeVisible();
 

tests/govtool-frontend/playwright/playwright.config.ts

@@ -27,7 +27,14 @@ export default defineConfig({
   /*use Allure Playwright's testPlanFilter() to determine the grep parameter*/
   grep: testPlanFilter(),
   /* Reporter to use. See https://playwright.dev/docs/test-reporters */
-  reporter: process.env.CI ? [["line"], ["allure-playwright"]] : [["line"]],
+  reporter: process.env.CI
+    ? [
+        ["line"],
+        [
+          "allure-playwright"
+        ],
+      ]
+    : [["line"]],
   /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
   use: {
     /* Base URL to use in actions like `await page.goto('/')`. */

tests/govtool-frontend/playwright/tests/1-wallet-connect/walletConnect.loggedin.spec.ts

@@ -1,12 +1,14 @@
 import { user01Wallet } from "@constants/staticWallets";
 import { test } from "@fixtures/walletExtension";
+import { setAllureEpic } from "@helpers/allure";
 import LoginPage from "@pages/loginPage";
 
 test.use({ storageState: ".auth/user01.json", wallet: user01Wallet });
+test.beforeEach(async () => {
+  await setAllureEpic("1. Wallet connect");
+});
 
-test("1B: Should connect wallet with single stake key @smoke @fast", async ({
-  page,
-}) => {
+test("1B: Should connect wallet with single stake key", async ({ page }) => {
   const loginPage = new LoginPage(page);
   await loginPage.goto();
   await loginPage.isLoggedIn();

tests/govtool-frontend/playwright/tests/1-wallet-connect/walletConnect.spec.ts

@@ -1,11 +1,16 @@
 import createWallet from "@fixtures/createWallet";
 import { test } from "@fixtures/walletExtension";
+import { setAllureEpic } from "@helpers/allure";
 import convertBufferToHex from "@helpers/convertBufferToHex";
 import { ShelleyWallet } from "@helpers/crypto";
 import LoginPage from "@pages/loginPage";
 import { expect } from "@playwright/test";
 
-test("1A. Should connect wallet and choose stake-key to use @smoke @fast", async ({
+test.beforeEach(async () => {
+  await setAllureEpic("1. Wallet connect");
+});
+
+test("1A. Should connect wallet and choose stake-key to use", async ({
   page,
 }) => {
   const shellyWallet = await ShelleyWallet.generate();
@@ -23,9 +28,7 @@ test("1A. Should connect wallet and choose stake-key to use @smoke @fast", async
   await loginPage.login();
 });
 
-test("1C: Should disconnect Wallet When connected @smoke @fast", async ({
-  page,
-}) => {
+test("1C: Should disconnect Wallet When connected", async ({ page }) => {
   await createWallet(page);
 
   const loginPage = new LoginPage(page);
@@ -34,7 +37,7 @@ test("1C: Should disconnect Wallet When connected @smoke @fast", async ({
   await loginPage.logout();
 });
 
-test("1D. Should check correct network (Testnet/Mainnet) on connection @smoke @fast", async ({
+test("1D. Should check correct network (Testnet/Mainnet) on connection", async ({
   page,
 }) => {
   const wrongNetworkId = 1; // mainnet network

tests/govtool-frontend/playwright/tests/2-delegation/delegation.drep.spec.ts

@@ -3,6 +3,7 @@ import { dRep01Wallet } from "@constants/staticWallets";
 import { createTempDRepAuth } from "@datafactory/createAuth";
 import { faker } from "@faker-js/faker";
 import { test } from "@fixtures/walletExtension";
+import { setAllureEpic } from "@helpers/allure";
 import { ShelleyWallet } from "@helpers/crypto";
 import { isMobile, openDrawer } from "@helpers/mobile";
 import { createNewPageWithWallet } from "@helpers/page";
@@ -12,6 +13,10 @@ import DRepDirectoryPage from "@pages/dRepDirectoryPage";
 import DRepRegistrationPage from "@pages/dRepRegistrationPage";
 import { expect } from "@playwright/test";
 
+test.beforeEach(async () => {
+  await setAllureEpic("2. Delegation");
+});
+
 test("2C. Should open wallet connection popup on delegate in disconnected state", async ({
   page,
 }) => {

tests/govtool-frontend/playwright/tests/2-delegation/delegation.loggedin.spec.ts

@@ -1,5 +1,6 @@
 import { dRep01Wallet, user01Wallet } from "@constants/staticWallets";
 import { test } from "@fixtures/walletExtension";
+import { setAllureEpic } from "@helpers/allure";
 import { ShelleyWallet } from "@helpers/crypto";
 import { isMobile } from "@helpers/mobile";
 import extractDRepFromWallet from "@helpers/shellyWallet";
@@ -8,11 +9,14 @@ import { expect } from "@playwright/test";
 
 test.use({ storageState: ".auth/user01.json", wallet: user01Wallet });
 
+test.beforeEach(async () => {
+  await setAllureEpic("2. Delegation");
+});
+
 test("2B. Should access DRep Directory page", async ({ page }) => {
   await page.goto("/");
 
   await page.getByTestId("view-drep-directory-button").click();
-
   if (isMobile(page)) {
     await expect(page.getByText("DRep Directory")).toBeVisible();
   } else {

tests/govtool-frontend/playwright/tests/2-delegation/delegation.spec.ts

@@ -1,8 +1,13 @@
 import { dRep01Wallet } from "@constants/staticWallets";
 import DRepDirectoryPage from "@pages/dRepDirectoryPage";
+import { setAllureEpic } from "@helpers/allure";
 import { expect, test } from "@playwright/test";
 import { DRepStatus } from "@types";
 
+test.beforeEach(async () => {
+  await setAllureEpic("2. Delegation");
+});
+
 test("2J. Should search by DRep id", async ({ page }) => {
   const dRepDirectory = new DRepDirectoryPage(page);
   await dRepDirectory.goto();

tests/govtool-frontend/playwright/tests/2-delegation/delegationFunctionality.delegation.spec.ts

@@ -2,6 +2,7 @@ import environments from "@constants/environments";
 import { adaHolder01Wallet, dRep01Wallet } from "@constants/staticWallets";
 import { createTempDRepAuth } from "@datafactory/createAuth";
 import { test } from "@fixtures/walletExtension";
+import { setAllureEpic } from "@helpers/allure";
 import { ShelleyWallet } from "@helpers/crypto";
 import { createNewPageWithWallet } from "@helpers/page";
 import extractDRepFromWallet from "@helpers/shellyWallet";
@@ -13,6 +14,10 @@ import {
 import DRepDirectoryPage from "@pages/dRepDirectoryPage";
 import { expect } from "@playwright/test";
 
+test.beforeEach(async () => {
+  await setAllureEpic("2. Delegation");
+});
+
 test.describe("Delegate to others", () => {
   test.describe.configure({ mode: "serial" });
 

tests/govtool-frontend/playwright/tests/3-drep-registration/dRepRegistration.dRep.spec.ts

@@ -3,6 +3,7 @@ import { dRep01Wallet } from "@constants/staticWallets";
 import { createTempDRepAuth } from "@datafactory/createAuth";
 import { faker } from "@faker-js/faker";
 import { test } from "@fixtures/walletExtension";
+import { setAllureEpic } from "@helpers/allure";
 import { ShelleyWallet } from "@helpers/crypto";
 import { createNewPageWithWallet } from "@helpers/page";
 import {
@@ -15,6 +16,10 @@ import GovernanceActionsPage from "@pages/governanceActionsPage";
 import { expect } from "@playwright/test";
 import * as crypto from "crypto";
 
+test.beforeEach(async () => {
+  await setAllureEpic("3. DRep registration");
+});
+
 test.describe("Logged in DReps", () => {
   test.use({ storageState: ".auth/dRep01.json", wallet: dRep01Wallet });
 
@@ -30,7 +35,8 @@ test.describe("Logged in DReps", () => {
   test.use({ storageState: ".auth/dRep01.json", wallet: dRep01Wallet });
 
   // Skipped: No option to update metadata
-  test.skip("3H. Should be able to update metadata", async ({ page }) => {
+  test("3H. Should be able to update metadata ", async ({ page }) => {
+    test.skip();
     page.getByTestId("change-metadata-button").click();
     page.getByTestId("url-input").fill("https://google.com");
     page.getByTestId("hash-input").fill(crypto.randomBytes(32).toString("hex"));

tests/govtool-frontend/playwright/tests/3-drep-registration/dRepRegistration.loggedin.spec.ts

@@ -1,6 +1,7 @@
 import { user01Wallet } from "@constants/staticWallets";
 import { faker } from "@faker-js/faker";
 import { test } from "@fixtures/walletExtension";
+import { setAllureEpic } from "@helpers/allure";
 import DRepRegistrationPage from "@pages/dRepRegistrationPage";
 import { expect } from "@playwright/test";
 
@@ -9,6 +10,10 @@ test.use({
   wallet: user01Wallet,
 });
 
+test.beforeEach(async () => {
+  await setAllureEpic("3. DRep registration");
+});
+
 test("3B. Should access DRep registration page", async ({ page }) => {
   await page.goto("/");
 

tests/govtool-frontend/playwright/tests/3-drep-registration/dRepRegistration.spec.ts

@@ -1,5 +1,10 @@
+import { setAllureEpic } from "@helpers/allure";
 import { expect, test } from "@playwright/test";
 
+test.beforeEach(async () => {
+  await setAllureEpic("3. DRep registration");
+});
+
 test("3C. Should open wallet connection popup on DRep registration in disconnected state", async ({
   page,
 }) => {

tests/govtool-frontend/playwright/tests/4-proposal-visibility/proposalVisibility.dRep.spec.ts

@@ -3,6 +3,7 @@ import { dRep01Wallet } from "@constants/staticWallets";
 import { createTempDRepAuth } from "@datafactory/createAuth";
 import { faker } from "@faker-js/faker";
 import { test } from "@fixtures/walletExtension";
+import { setAllureEpic } from "@helpers/allure";
 import { lovelaceToAda } from "@helpers/cardano";
 import { ShelleyWallet } from "@helpers/crypto";
 import { createNewPageWithWallet } from "@helpers/page";
@@ -17,12 +18,16 @@ import { FilterOption, IProposal } from "@types";
 test.describe("Logged in DRep", () => {
   test.use({ storageState: ".auth/dRep01.json", wallet: dRep01Wallet });
 
-  test("4E. Should display DRep's voting power in governance actions page", async ({
-    page,
-  }) => {
-    const votingPowerPromise = page.waitForResponse("**/get-voting-power/**");
-    const governanceActionsPage = new GovernanceActionsPage(page);
-    await governanceActionsPage.goto();
+test.beforeEach(async () => {
+  await setAllureEpic("4. Proposal visibility");
+});
+
+test("4E. Should display DRep's voting power in governance actions page", async ({
+  page,
+}) => {
+  const votingPowerPromise = page.waitForResponse("**/get-voting-power/**");
+  const governanceActionsPage = new GovernanceActionsPage(page);
+  await governanceActionsPage.goto();
 
     const res = await votingPowerPromise;
     const votingPower = await res.json();

tests/govtool-frontend/playwright/tests/4-proposal-visibility/proposalVisibility.loggedin.spec.ts

@@ -1,5 +1,6 @@
 import { user01Wallet } from "@constants/staticWallets";
 import { test } from "@fixtures/walletExtension";
+import { setAllureEpic } from "@helpers/allure";
 import extractExpiryDateFromText from "@helpers/extractExpiryDateFromText";
 import { isMobile, openDrawer } from "@helpers/mobile";
 import removeAllSpaces from "@helpers/removeAllSpaces";
@@ -24,6 +25,10 @@ enum SortOption {
 
 test.use({ storageState: ".auth/user01.json", wallet: user01Wallet });
 
+test.beforeEach(async () => {
+  await setAllureEpic("4. Proposal visibility");
+});
+
 test("4A.1: Should access Governance Actions page with connecting wallet", async ({
   page,
 }) => {

tests/govtool-frontend/playwright/tests/4-proposal-visibility/proposalVisibility.spec.ts

@@ -1,6 +1,11 @@
+import { setAllureEpic } from "@helpers/allure";
 import GovernanceActionsPage from "@pages/governanceActionsPage";
 import { expect, test } from "@playwright/test";
 
+test.beforeEach(async () => {
+  await setAllureEpic("4. Proposal visibility");
+});
+
 test("4A.2: Should access Governance Actions page without connecting wallet", async ({
   page,
 }) => {

tests/govtool-frontend/playwright/tests/5-proposal-functionality/proposalFunctionality.dRep.spec.ts

@@ -2,6 +2,7 @@ import environments from "@constants/environments";
 import { dRep01Wallet } from "@constants/staticWallets";
 import { createTempDRepAuth } from "@datafactory/createAuth";
 import { test } from "@fixtures/walletExtension";
+import { setAllureEpic } from "@helpers/allure";
 import { ShelleyWallet } from "@helpers/crypto";
 import { createNewPageWithWallet } from "@helpers/page";
 import {
@@ -14,6 +15,10 @@ import GovernanceActionsPage from "@pages/governanceActionsPage";
 import { expect } from "@playwright/test";
 import kuberService from "@services/kuberService";
 
+test.beforeEach(async () => {
+  await setAllureEpic("5. Proposal functionality");
+});
+
 test.describe("Proposal checks", () => {
   test.use({ storageState: ".auth/dRep01.json", wallet: dRep01Wallet });
 
@@ -60,7 +65,8 @@ test.describe("Proposal checks", () => {
   });
 
   // Skipped: No url/hash input to validate
-  test.skip("5D. Should validate proposal voting", async () => {
+  test("5D. Should validate proposal voting", async () => {
+    test.skip();
     // const invalidURLs = ["testdotcom", "https://testdotcom", "https://test.c"];
     // invalidURLs.forEach(async (url) => {
     //   govActionDetailsPage.urlInput.fill(url);
@@ -198,7 +204,7 @@ test.describe("Check voting power", () => {
 
     await dRepPage.goto("/");
     await dRepPage.getByTestId("retire-button").click();
-    await dRepPage.getByTestId("continue-retirement-button").click(); 
+    await dRepPage.getByTestId("continue-retirement-button").click();
     await expect(
       dRepPage.getByTestId("retirement-transaction-submitted-modal")
     ).toBeVisible();

tests/govtool-frontend/playwright/tests/5-proposal-functionality/proposalFunctionality.loggedin.spec.ts

@@ -1,9 +1,14 @@
 import { user01Wallet } from "@constants/staticWallets";
 import { test } from "@fixtures/walletExtension";
+import { setAllureEpic } from "@helpers/allure";
 import { expect } from "@playwright/test";
 
 test.use({ storageState: ".auth/user01.json", wallet: user01Wallet });
 
+test.beforeEach(async () => {
+  await setAllureEpic("5. Proposal functionality");
+});
+
 test("5J. Should hide retirement option for non-registered DRep", async ({
   page,
 }) => {