Add playwright tests

Author: NotWoods

.github/workflows/main.yml

@@ -12,9 +12,24 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: '20'
+          node-version: lts/*
           cache: 'npm'
       - run: npm ci
       - run: npm run lint
       - run: npm run check
       - run: npm run test
+
+  e2e_test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run build
+      - name: Install Playwright Browsers
+        run: npx playwright install --with-deps
+      - run: npx playwright test

.gitignore

@@ -1,3 +1,7 @@
 node_modules
 
 dist
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

package-lock.json

@@ -8,6 +8,7 @@
     "format": "prettier . --ignore-path .gitignore --write",
     "postformat": "eslint . --fix",
     "test": "npm run check && vitest",
+    "e2e": "playwright test --project chromium",
     "check": "tsc --noEmit",
     "dev": "vite",
     "build": "vite build",
@@ -19,6 +20,8 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.8.0",
+    "@playwright/test": "^1.46.0",
+    "@types/node": "^22.1.0",
     "@typescript/lib-dom": "npm:@types/web@^0.0.151",
     "@vitejs/plugin-legacy": "^5.4.1",
     "eslint": "^9.8.0",

package.json

@@ -0,0 +1,58 @@
+import { defineConfig, devices } from '@playwright/test';
+
+const webServer = false;
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  testDir: './tests/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,
+  use: {
+    baseURL: webServer ? 'http://127.0.0.1:4173' : 'https://maskable.app/',
+    /* 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'] },
+    },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  webServer: webServer
+    ? {
+        command: 'npm run preview',
+        url: 'http://127.0.0.1:4173',
+        reuseExistingServer: !process.env.CI,
+      }
+    : undefined,
+});