chore: ignore more paths on argos & ignore videos (#1724)

jonas-jonas · web-flow · commit 0f7d58013f67 · 2024-04-24T14:49:31.000+02:00
diff --git a/playwright-argos.config.ts b/playwright-argos.config.ts
@@ -1,12 +1,17 @@
-import { devices } from "@playwright/test"
 import type { PlaywrightTestConfig } from "@playwright/test"
+import { devices } from "@playwright/test"
 
 const config: PlaywrightTestConfig = {
   testDir: "./tests/playwright-argos",
   webServer: {
     port: 3000,
     command: "npm run serve",
   },
+
+  // Tests shouldn't fail. If they do something is wrong with the test or the site.
+  maxFailures: 0,
+  workers: 1,
+
   projects: [
     {
       name: "chromium",
diff --git a/tests/playwright-argos/screenshot.css b/tests/playwright-argos/screenshot.css
@@ -7,7 +7,8 @@ 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'] {
+[class*='playgroundPreview'],
+video {
   visibility: hidden;
 }
 
diff --git a/tests/playwright-argos/screenshot.spec.ts b/tests/playwright-argos/screenshot.spec.ts
@@ -8,7 +8,23 @@ const siteUrl = "http://localhost:3000"
 const sitemapPath = "./build/sitemap.xml"
 const stylesheetPath = "./tests/playwright-argos/screenshot.css"
 const stylesheet = fs.readFileSync(stylesheetPath).toString()
-const ignoredPathnames = ["/docs/reference/api"]
+const ignoredPathnames = [
+  // Thes files are too large to screenshot
+  "/docs/reference/api",
+  "/docs/hydra/reference/api",
+  "/docs/kratos/reference/api",
+  "/docs/keto/reference/api",
+  "/docs/oathkeeper/reference/api",
+  // the configuration pages are lazily loaded and the screenshot is sometimes taken before they are loaded
+  "/docs/kratos/reference/configuration-editor",
+  "/docs/hydra/reference/configuration-editor",
+  "/docs/keto/reference/configuration-editor",
+  "/docs/oathkeeper/reference/configuration-editor",
+  "/docs/kratos/reference/configuration",
+  "/docs/hydra/reference/configuration",
+  "/docs/keto/reference/configuration",
+  "/docs/oathkeeper/reference/configuration",
+]
 
 // Wait for hydration, requires Docusaurus v2.4.3+
 // Docusaurus adds a <html data-has-hydrated="true"> once hydrated
@@ -29,12 +45,7 @@ function screenshotPathname(pathname: string) {
 
 test.describe("Docusaurus site screenshots", () => {
   const pathnames = extractSitemapPathnames(sitemapPath)
-
-  for (const p of pathnames) {
-    if (ignoredPathnames.includes(p)) {
-      console.log(`Ignoring ${p}`)
-    } else {
-      screenshotPathname(p)
-    }
-  }
+  pathnames
+    .filter((p) => !ignoredPathnames.includes(p))
+    .forEach(screenshotPathname)
 })

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,8 @@ img[src$='.gif'],`
`7`	`7`	`/* Algolia keyboard shortcuts appear with a little delay */`
`8`	`8`	`.DocSearch-Button-Keys > kbd,`
`9`	`9`	`/* The live playground preview can often display dates/counters */`
`10`		`-[class*='playgroundPreview'] {`
	`10`	`+[class*='playgroundPreview'],`
	`11`	`+video {`
`11`	`12`	`visibility: hidden;`
`12`	`13`	`}`
`13`	`14`