add playwright tests

.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

@@ -6,4 +6,8 @@ public/sitemap.xml
 public/tags/index.html
 public/tags/index.xml
 resources
-node_modules
+node_modules
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

package.json

@@ -1,5 +1,14 @@
 {
   "dependencies": {
     "hugo-extended": "^0.125.6"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.44.0",
+    "@types/node": "^20.12.12"
+  },
+  "scripts": {
+    "build": "hugo",
+    "build:preview": "hugo --baseURL \"${DEPLOY_PRIME_URL:-/}\" --buildDrafts --buildFuture",
+    "start": "hugo server --baseURL \"http://localhost:1313\""
   }
 }

playwright.config.ts

@@ -0,0 +1,88 @@
+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: './tests',
+  /* 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:1313',
+
+    /* 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: 'chromium dark',
+      use: { ...devices['Desktop Chrome'], colorScheme: 'dark' },
+    },
+    {
+      name: 'firefox',
+      use: { ...devices['Desktop Firefox'] },
+    },
+
+    {
+      name: 'webkit',
+      use: { ...devices['Desktop Safari'] },
+    },
+    {
+      name: 'webkit dark',
+      use: { ...devices['Desktop Safari'], colorScheme: 'dark' },
+    },
+
+    /* Test against mobile viewports. */
+    {
+      name: 'Mobile Chrome',
+      use: { ...devices['Pixel 5'] },
+    },
+    {
+      name: 'Mobile Chrome Dark',
+      use: { ...devices['Pixel 5'], colorScheme: 'dark' },
+    },
+    {
+      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://localhost:1313',
+    reuseExistingServer: !process.env.CI,
+  },
+});

tests/homepage.spec.ts

@@ -0,0 +1,15 @@
+import { test, expect } from '@playwright/test';
+
+test('has title', async ({ page }) => {
+  await page.goto('/');
+
+  // Expect a title "to contain" a substring.
+  await expect(page).toHaveTitle("Duncan Mackenzie");
+});
+
+test('get started link', async ({ page }) => {
+  await page.goto('/');
+  // Expects page to have a heading with the name of Installation.
+  await expect(page.getByRole('heading', { name: 'Photography Content' })).toBeVisible();
+  await expect(page.getByRole('heading', { name: 'Posts on Engineering Management' })).toBeVisible();
+});

tests/visual.spec.ts

@@ -0,0 +1,30 @@
+import { test, expect, Page, TestInfo } from '@playwright/test';
+
+test('Visual Diff About', async ({ page }) => {
+    await visualDiff(page, '/about/');
+});
+
+test('Visual Diff Text and Image', async ({ page }) => {
+    await visualDiff(page, '/blog/space-games/');
+});
+
+test('Visual Diff Sample Code', async ({ page }) => {
+    await visualDiff(page, '/blog/image-formats/');
+});
+
+test('Visual Diff Small Album', async ({ page }) => {
+    await visualDiff(page, '/albums/fall-trail-walk/');
+});
+
+
+async function visualDiff(page: Page, url: string) {
+    await page.goto(url);
+
+    // Trigger loading of all images
+    for (const img of await page.locator('//img').all()) {
+        await img.scrollIntoViewIfNeeded();
+    }
+
+    // Set up listeners concurrently
+    await expect(page).toHaveScreenshot({ fullPage: true, timeout: 10000});
+}