Merge pull request #13 from Satellite-im/luis/playwright

chore(playwright): draft to test playwright framework

.github/workflows/playwright.yml

@@ -0,0 +1,24 @@
+name: Playwright Tests
+on:
+  workflow_dispatch:
+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

@@ -79,4 +79,14 @@ $RECYCLE.BIN/
 # Cypress Assets
 cypress/downloads/
 cypress/screenshots/
-cypress/videos/
+cypress/videos/
+/test-results/
+
+# Playwright Assets
+/playwright-report/
+/blob-report/
+/playwright/.cache/
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

package.json

@@ -8,12 +8,13 @@
   "license": "MIT",
   "devDependencies": {
     "@faker-js/faker": "^8.4.1",
+    "@playwright/test": "^1.44.1",
+    "@types/node": "^20.14.2",
     "cypress": "^13.11.0",
+    "cypress-clipboard": "^1.0.3",
     "cypress-real-events": "^1.12.0",
     "prettier": "3.2.5",
     "typescript": "^5.4.5"
   },
-  "dependencies": {
-    "cypress-clipboard": "^1.0.3"
-  }
+  "scripts": {}
 }

playwright.config.ts

@@ -0,0 +1,77 @@
+import { defineConfig, devices } from "@playwright/test";
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// require('dotenv').config();
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  testDir: "./playwright",
+  /* 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://localhost:5173/",
+
+    /* 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,
+  // },
+});

playwright/example.spec.ts

@@ -0,0 +1,28 @@
+import { test, expect } from "@playwright/test";
+
+test.describe("Pin Tests", () => {
+  test.beforeEach(async ({ page }) => {
+    // Navigate to main page
+    await page.goto("/");
+  });
+
+  test("Has correct URL redirected", async ({ page }) => {
+    // Expect a title "to contain" a substring.
+    await expect(page).toHaveURL("auth/unlock");
+  });
+
+  test("Enter valid PIN", async ({ page }) => {
+    // Enter a valid pin to continue
+    await page.getByTestId("button-pin-1").click();
+    await page.getByTestId("button-pin-2").click();
+    await page.getByTestId("button-pin-3").click();
+    await page.getByTestId("button-pin-4").click();
+    await page.getByTestId("button-confirm-pin").click();
+
+    // Expect a title "to contain" a substring.
+    await expect(page).toHaveURL("pre");
+
+    // Expect a title "to contain" a substring.
+    await expect(page).toHaveURL("chat");
+  });
+});