Merge pull request #30 from HyunmoAhn/env/visual-testing

env: config playwright and argos
HyunmoAhn · Oct 31, 2024 · 084a167 · 084a167
2 parents f4cb7b4 + 8dcf79b
commit 084a167
Show file tree

Hide file tree

Showing 10 changed files with 1,073 additions and 23 deletions.
diff --git a/.github/workflows/argos.yml b/.github/workflows/argos.yml
@@ -0,0 +1,35 @@
+name: Argos CI Screenshots
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  take-screenshots:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+      - name: Install dependencies
+        run: |
+          corepack enable
+          yarn install --frozen-lockfile
+
+      - name: Install Playwright browsers
+        run: yarn playwright install --with-deps chromium
+
+      - name: Build the website
+        run: yarn docusaurus build
+
+      - name: Take screenshots with Playwright
+        run: yarn playwright test
+
+      - name: Upload screenshots to Argos
+        run: yarn argos upload ./screenshots
diff --git a/.gitignore b/.gitignore
@@ -20,3 +20,6 @@ yarn-debug.log*
 yarn-error.log*
 .idea/
 .token
+
+test-results
+screenshots/
diff --git a/.yarn/install-state.gz b/.yarn/install-state.gz
diff --git a/argos/screenshot.css b/argos/screenshot.css
@@ -0,0 +1,19 @@
+/* Iframes can load lazily */
+iframe,
+  /* Avatars can be flaky due to using external sources: GitHub/Unavatar */
+.avatar__photo,
+  /* Gifs load lazily and are animated */
+img[src$='.gif'],
+  /* Algolia keyboard shortcuts appear with a little delay */
+.DocSearch-Button-Keys > kbd,
+  /* The live playground preview can often display dates/counters */
+[class*='playgroundPreview'] {
+  visibility: hidden;
+}
+
+/* Different docs last-update dates can alter layout */
+.theme-last-updated,
+  /* Mermaid diagrams are rendered client-side and produce layout shifts */
+.docusaurus-mermaid-container {
+  display: none;
+}
diff --git a/argos/screenshot.spec.ts b/argos/screenshot.spec.ts
@@ -0,0 +1,33 @@
+import * as fs from 'fs';
+import { test } from '@playwright/test';
+import { argosScreenshot } from '@argos-ci/playwright';
+import { extractSitemapPathnames, pathnameToArgosName } from './utils';
+
+// Constants
+const siteUrl = 'http://localhost:3000';
+const sitemapPath = './build/sitemap.xml';
+const stylesheetPath = `${__dirname}/screenshot.css`;
+const stylesheet = fs.readFileSync(stylesheetPath).toString();
+
+// Wait for hydration, requires Docusaurus v2.4.3+
+// Docusaurus adds a <html data-has-hydrated="true"> once hydrated
+// See https://github.com/facebook/docusaurus/pull/9256
+function waitForDocusaurusHydration() {
+  return document.documentElement.dataset.hasHydrated === 'true';
+}
+
+function screenshotPathname(pathname: string) {
+  test(`pathname ${pathname}`, async ({ page }) => {
+    const url = siteUrl + pathname;
+    await page.goto(url);
+    await page.waitForFunction(waitForDocusaurusHydration);
+    await page.addStyleTag({ content: stylesheet });
+    await argosScreenshot(page, pathnameToArgosName(pathname));
+  });
+}
+
+test.describe('Docusaurus site screenshots', () => {
+  const pathnames = extractSitemapPathnames(sitemapPath);
+  console.log('Pathnames to screenshot:', pathnames);
+  pathnames.forEach(screenshotPathname);
+});
diff --git a/argos/utils.ts b/argos/utils.ts
@@ -0,0 +1,19 @@
+import * as fs from 'fs';
+import * as cheerio from 'cheerio';
+
+// Extract a list of pathnames, given a fs path to a sitemap.xml file
+// Docusaurus generates a build/sitemap.xml file for you!
+export function extractSitemapPathnames(sitemapPath: string): string[] {
+  const sitemap = fs.readFileSync(sitemapPath).toString();
+  const $ = cheerio.load(sitemap, { xmlMode: true });
+  const urls: string[] = [];
+  $('loc').each(function handleLoc() {
+    urls.push($(this).text());
+  });
+  return urls.map((url) => new URL(url).pathname);
+}
+
+// Converts a pathname to a decent screenshot name
+export function pathnameToArgosName(pathname: string): string {
+  return pathname.replace(/^\/|\/$/g, '') || 'index';
+}
diff --git a/package.json b/package.json
@@ -45,11 +45,15 @@
     "url-loader": "^4.1.1"
   },
   "devDependencies": {
+    "@argos-ci/cli": "^2.5.0",
+    "@argos-ci/playwright": "^3.9.1",
     "@docusaurus/module-type-aliases": "3.5.2",
+    "@playwright/test": "^1.48.2",
     "@tsconfig/docusaurus": "^2.0.3",
     "@types/react": "^18.2.21",
     "@typescript-eslint/eslint-plugin": "^6.3.0",
     "@typescript-eslint/parser": "^6.3.0",
+    "cheerio": "^1.0.0",
     "eslint": "^8.47.0",
     "eslint-config-airbnb": "19.0.4",
     "eslint-config-airbnb-typescript": "^17.1.0",

diff --git a/playwright.config.ts b/playwright.config.ts
@@ -0,0 +1,19 @@
+import { devices } from '@playwright/test';
+import type { PlaywrightTestConfig } from '@playwright/test';
+
+const config: PlaywrightTestConfig = {
+  webServer: {
+    port: 3000,
+    command: 'yarn docusaurus serve',
+  },
+  projects: [
+    {
+      name: 'chromium',
+      use: {
+        ...devices['Desktop Chrome'],
+      },
+    },
+  ],
+};
+
+export default config;
diff --git a/tsconfig.json b/tsconfig.json
@@ -8,6 +8,6 @@
     },
     "skipLibCheck": true
   },
-  "include": ["src", "*.js"],
+  "include": ["src", "argos", "*.config.ts", "*.js"],
   "exclude": ["node_modules"]
 }