Merge pull request #69 from amochuko/speedfox/dw-327/add-export-to-ze…

…chub-wik

Speedfox/dw 327/add export to zechub wik

.github/workflows/playwright.yml

@@ -0,0 +1,27 @@
+name: Playwright Tests
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+jobs:
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: lts/*
+    - name: Install dependencies
+      run: npm ci
+    - name: Install Playwright Browsers
+      run: npx playwright install --with-deps
+    - name: Run Playwright tests
+      run: npx playwright test
+    - uses: actions/upload-artifact@v4
+      if: always()
+      with:
+        name: playwright-report
+        path: playwright-report/
+        retention-days: 30

.gitignore

@@ -42,3 +42,7 @@ yarn-error.log*
 *.tsbuildinfo
 next-env.d.ts
 next-env.d.ts
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

e2e/export-dashboard.spec.ts

@@ -0,0 +1,50 @@
+import { expect, test } from "@playwright/test";
+
+const devURL = "http://localhost:3000/";
+
+test.describe("Dashboard", () => {
+  test("has export button", async ({ page }) => {
+    await page.goto(devURL);
+
+    await page.getByRole("link", { name: /dashboard/i }).click();
+    await expect(
+      page.getByRole("button", { name: "Export (PNG)" })
+    ).toBeVisible();
+  });
+
+  test("has name of Sprout pool plus amount of zec", async ({ page }) => {
+    await page.goto(devURL);
+
+    await page.getByRole("link", { name: /dashboard/i }).click();
+
+    await page.getByRole("button", { name: "Sprout Pool" }).click();
+
+    await page.getByRole("button", { name: "Export (PNG)" }).click();
+
+    await expect(page.getByText(/ZEC in Sprout Pool/i)).toBeVisible();
+  });
+
+  test("has name of Sapling pool plus amount of zec", async ({ page }) => {
+    await page.goto(devURL);
+
+    await page.getByRole("link", { name: /dashboard/i }).click();
+
+    await page.getByRole("button", { name: "Sapling Pool" }).click();
+
+    await page.getByRole("button", { name: "Export (PNG)" }).click();
+
+    await expect(page.getByText(/ZEC in Sapling Pool/i)).toBeVisible();
+  });
+
+  test("has name of Orchard pool plus amount of zec", async ({ page }) => {
+    await page.goto(devURL);
+
+    await page.getByRole("link", { name: /dashboard/i }).click();
+
+    await page.getByRole("button", { name: "Orchard Pool" }).click();
+
+    await page.getByRole("button", { name: "Export (PNG)" }).click();
+
+    await expect(page.getByText(/ZEC in Orchard Pool/i)).toBeVisible();
+  });
+});

jest-setup.js

@@ -0,0 +1 @@
+import "@testing-library/jest-dom";

jest.config.js

@@ -0,0 +1,18 @@
+const nextJest = require("next/jest");
+
+const createJestConfig = nextJest({ dir: "./" });
+
+/** @type {import('jest').Config}*/
+const customJestConfig = {
+  setupFilesAfterEnv: ["<rootDir>/jest-setup.js"],
+  moduleDirectories: ["node_modules", "<rootDir>/"],
+  testPathIgnorePatterns: ["<rootDir>/e2e"], // ignores e2e
+  testEnvironment: "jest-environment-jsdom",
+  collectCoverageFrom: [
+    "**/*.{js,jsx}",
+    "!**/node_modules/**",
+    "!**/vendor/**",
+  ],
+};
+
+module.exports = createJestConfig(customJestConfig);

package.json

@@ -6,7 +6,11 @@
     "dev": "next dev",
     "build": "next build",
     "start": "next start",
-    "lint": "next lint"
+    "lint": "next lint",
+    "test:coverage": "jest --coverage",
+    "test": "jest --watch",
+    "test:e2e": "npx playwright test",
+    "test:e2e:ui": "npx playwright test --ui"
   },
   "dependencies": {
     "@headlessui/react": "^1.7.18",
@@ -36,6 +40,7 @@
     "flowbite-react": "^0.6.4",
     "framer-motion": "^11.0.3",
     "gitlog": "^4.0.8",
+    "html2canvas": "^1.4.1",
     "mongodb": "6.3",
     "next": "^13.5.6",
     "next-auth": "^4.24.5",
@@ -62,13 +67,22 @@
   },
   "devDependencies": {
     "@octokit/types": "^11.1.0",
+    "@playwright/test": "^1.45.1",
+    "@testing-library/dom": "^10.3.1",
+    "@testing-library/jest-dom": "^6.4.6",
+    "@testing-library/react": "^16.0.0",
+    "@testing-library/react-hooks": "^8.0.1",
+    "@testing-library/user-event": "^14.5.2",
+    "@types/jest": "^29.5.12",
     "@types/marked": "^5.0.1",
     "@types/node": "20.5.7",
     "@types/react": "18.2.21",
     "@types/react-dom": "18.2.7",
     "@types/react-icons": "^3.0.0",
     "@types/serviceworker": "^0.0.82",
     "@types/web-push": "^3.6.3",
-    "eslint-config-prettier": "^9.1.0"
+    "eslint-config-prettier": "^9.1.0",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0"
   }
 }

playwright.config.ts

@@ -0,0 +1,78 @@
+import { defineConfig, devices } from "@playwright/test";
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// import dotenv from 'dotenv';
+// dotenv.config({ path: path.resolve(__dirname, '.env') });
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  testDir: "./e2e",
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  /* Retry on CI only */
+  retries: process.env.CI ? 2 : 0,
+  /* Opt out of parallel tests on CI. */
+  workers: process.env.CI ? 1 : undefined,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: "html",
+  /* 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('/')`. */
+    // baseURL: 'http://127.0.0.1:3000',
+
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: "on-first-retry",
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: "chromium",
+      use: { ...devices["Desktop Chrome"] },
+    },
+
+    // {
+    //   name: 'firefox',
+    //   use: { ...devices['Desktop Firefox'] },
+    // },
+
+    // {
+    //   name: 'webkit',
+    //   use: { ...devices['Desktop Safari'] },
+    // },
+
+    /* Test against mobile viewports. */
+    // {
+    //   name: 'Mobile Chrome',
+    //   use: { ...devices['Pixel 5'] },
+    // },
+    // {
+    //   name: 'Mobile Safari',
+    //   use: { ...devices['iPhone 12'] },
+    // },
+
+    /* Test against branded browsers. */
+    // {
+    //   name: 'Microsoft Edge',
+    //   use: { ...devices['Desktop Edge'], channel: 'msedge' },
+    // },
+    // {
+    //   name: 'Google Chrome',
+    //   use: { ...devices['Desktop Chrome'], channel: 'chrome' },
+    // },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  // webServer: {
+  //   command: 'npm run start',
+  //   url: 'http://127.0.0.1:3000',
+  //   reuseExistingServer: !process.env.CI,
+  // },
+});