chore: setup e2e test with playwright

.github/workflows/e2e.yml

@@ -0,0 +1,35 @@
+name: e2e
+
+on:
+  deployment_status:
+
+jobs:
+  playwright:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    if: github.event.deployment_status.state == 'success'
+    container:
+      image: mcr.microsoft.com/playwright:v1.40.0-jammy
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: "npm"
+
+      - run: npm ci
+
+      - run: npx playwright install --with-deps
+
+      - run: npx playwright test
+        env:
+          PLAYWRIGHT_TEST_BASE_URL: ${{ github.event.deployment_status.target_url }}
+
+      - uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: playwright-report
+          path: playwright-report/
+          retention-days: 30

.github/workflows/pr.yml

@@ -1,6 +1,8 @@
 name: pr
 
 on:
+  push:
+    branches: [main]
   pull_request:
     branches: [main]
 

.gitignore

@@ -41,3 +41,7 @@ next-env.d.ts
 .env*
 .flaskenv*
 !.env.project
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

e2e/home.test.ts

@@ -0,0 +1,17 @@
+import { expect, test } from "@playwright/test";
+
+test("has title", async ({ page }) => {
+  await page.goto("/");
+
+  await expect(page).toHaveTitle(/100-cims/);
+});
+
+test("get started link", async ({ page }) => {
+  await page.goto("/");
+
+  await page.getByRole("link", { name: "Get started" }).click();
+
+  await expect(
+    page.getByRole("heading", { name: "Installation" })
+  ).toBeVisible();
+});

package.json

@@ -9,6 +9,7 @@
     "lint": "next lint -- -f gha",
     "test": "jest",
     "test:watch": "jest --watch",
+    "e2e": "playwright test",
     "postinstall": "prisma generate"
   },
   "prisma": {
@@ -51,6 +52,7 @@
     "zod-fetch": "^0.1.1"
   },
   "devDependencies": {
+    "@playwright/test": "^1.41.0",
     "@testing-library/jest-dom": "^6.2.0",
     "@testing-library/react": "^14.1.2",
     "@total-typescript/ts-reset": "^0.5.1",

playwright.config.ts

@@ -0,0 +1,24 @@
+import { defineConfig, devices } from "@playwright/test";
+
+require("dotenv").config();
+
+export default defineConfig({
+  testDir: "./e2e",
+  fullyParallel: true,
+  forbidOnly: !!process.env.CI,
+  retries: process.env.CI ? 2 : 0,
+  workers: process.env.CI ? 1 : undefined,
+  reporter: process.env.GITHUB_ACTIONS ? "github" : "html",
+  use: {
+    baseURL: process.env.PLAYWRIGHT_TEST_BASE_URL,
+    trace: process.env.CI ? "on-first-retry" : "retain-on-failure",
+    video: process.env.CI ? "on-first-retry" : "retain-on-failure",
+    screenshot: "only-on-failure",
+  },
+  projects: [
+    {
+      name: "chromium",
+      use: { ...devices["Desktop Chrome"] },
+    },
+  ],
+});

src/types/env.d.ts

@@ -35,6 +35,8 @@ declare global {
       CI: string | undefined;
       GITHUB_ACTIONS: string | undefined;
 
+      PLAYWRIGHT_TEST_BASE_URL: string;
+
       // make typescript error when using env vars that are not defined in here
       [key: string]: undefined;
     }