Implement CoderReporter

mtojek · mtojek · commit 6da5bf122093 · 2023-08-30T13:24:55.000+02:00
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -554,7 +554,7 @@ jobs:
       - run: pnpm playwright:install
         working-directory: site
 
-      - run: pnpm playwright:test
+      - run: pnpm playwright:test --workers 1
         env:
           DEBUG: pw:api
         working-directory: site
diff --git a/site/e2e/playwright.config.ts b/site/e2e/playwright.config.ts
@@ -1,6 +1,7 @@
 import { defineConfig } from "@playwright/test"
 import path from "path"
 import { defaultPort, gitAuth } from "./constants"
+import CoderReporter from "./reporter"
 
 export const port = process.env.CODER_E2E_PORT
   ? Number(process.env.CODER_E2E_PORT)
@@ -30,6 +31,7 @@ export default defineConfig({
       timeout: 60000,
     },
   ],
+  reporter: [["./reporter.ts"]],
   use: {
     baseURL: `http://localhost:${port}`,
     video: "retain-on-failure",
diff --git a/site/e2e/reporter.ts b/site/e2e/reporter.ts
@@ -0,0 +1,51 @@
+import type {
+  Reporter,
+  FullConfig,
+  Suite,
+  TestCase,
+  TestResult,
+  FullResult,
+} from "@playwright/test/reporter"
+
+class CoderReporter implements Reporter {
+  onBegin(config: FullConfig, suite: Suite) {
+    // eslint-disable-next-line no-console -- Helpful for debugging
+    console.log(`Starting the run with ${suite.allTests().length} tests`)
+  }
+
+  onTestBegin(test: TestCase) {
+    // eslint-disable-next-line no-console -- Helpful for debugging
+    console.log(`Starting test ${test.title}`)
+  }
+
+  onStdOut(chunk: string, test: TestCase, _: TestResult): void {
+    // eslint-disable-next-line no-console -- Helpful for debugging
+    console.log(
+      `[stdout] [${test ? test.title : "unknown"}]: ${chunk.replace(
+        /\n$/g,
+        "",
+      )}`,
+    )
+  }
+
+  onStdErr(chunk: string, test: TestCase, _: TestResult): void {
+    // eslint-disable-next-line no-console -- Helpful for debugging
+    console.log(
+      `[stderr] [${test ? test.title : "unknown"}]: ${chunk.replace(
+        /\n$/g,
+        "",
+      )}`,
+    )
+  }
+
+  onTestEnd(test: TestCase, result: TestResult) {
+    // eslint-disable-next-line no-console -- Helpful for debugging
+    console.log(`Finished test ${test.title}: ${result.status}`)
+  }
+
+  onEnd(result: FullResult) {
+    // eslint-disable-next-line no-console -- Helpful for debugging
+    console.log(`Finished the run: ${result.status}`)
+  }
+}
+export default CoderReporter
