feat: export smoke test results in prometheus format

webui/configs/playwright.config.ts

@@ -1,5 +1,8 @@
 import { defineConfig, devices } from "@playwright/test";
 import { SmokeTestOptions } from "./smoke-test.options";
+import path from "path";
+
+const resultsDir = path.resolve('./', 'playwright-report')
 
 /**
  * See https://playwright.dev/docs/test-configuration.
@@ -14,8 +17,20 @@ export default defineConfig<SmokeTestOptions>({
   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",
+  reporter: [
+      [
+          "html", { outputFolder: `${resultsDir}/playwright-report` }
+      ],
+      [
+          "json", { outputFile: `${resultsDir}/report.json` }
+      ],
+      [
+        "../reporters/prometheus-reporter.ts", { outputFile: `${resultsDir}/report.prom` }
+      ]
+  ],
   /* 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('/')`. */

webui/package.json

@@ -86,6 +86,7 @@
         "@types/react-transition-group": "^4.4.6",
         "@typescript-eslint/eslint-plugin": "^5.61.0",
         "@typescript-eslint/parser": "^5.61.0",
+        "axios": "^1.7.7",
         "chai": "^4.3.7",
         "css-loader": "^6.8.1",
         "eslint": "^8.44.0",

webui/reporters/prometheus-reporter.ts

@@ -0,0 +1,80 @@
+import { Reporter, TestResult } from "@playwright/test/reporter";
+import fs from "fs";
+import axios from "axios";
+
+type PrometheusReporterOptions = {
+  outputFile: string;
+};
+
+class PrometheusReporter implements Reporter {
+  private pushGatewayUrl: string;
+  private username: string;
+  private password: string;
+  private outputFile: string;
+  private totalTests: number;
+  private passedTests: number;
+  private failedTests: number;
+  private skippedTests: number;
+  private startTime: number;
+  private duration: number;
+
+  constructor(options: PrometheusReporterOptions) {
+    this.pushGatewayUrl = process.env.PROMETHEUS_PUSHGATEWAY_URL || "";
+    this.username = process.env.PROMETHEUS_USERNAME || "";
+    this.password = process.env.PROMETHEUS_PASSWORD || "";
+    this.outputFile = options.outputFile;
+    this.totalTests = 0;
+    this.passedTests = 0;
+    this.failedTests = 0;
+    this.skippedTests = 0;
+    this.startTime = Date.now();
+  }
+
+  onTestEnd(_: unknown, result: TestResult) {
+    this.totalTests++;
+    if (result.status === "passed") this.passedTests++;
+    if (result.status === "failed") this.failedTests++;
+    if (result.status === "skipped") this.skippedTests++;
+  }
+
+  async onEnd() {
+    this.duration = Date.now() - this.startTime;
+    const content = this.buildMetricsString();
+    fs.writeFileSync(this.outputFile, content);
+    this.pushMetricsToPrometheus(content);
+  }
+
+  private pushMetricsToPrometheus(content: string) {
+    if (!this.pushGatewayUrl) return;
+    axios.post(this.pushGatewayUrl, content, {
+      headers: {
+        "Content-Type": "text/plain",
+      },
+      auth: {
+        username: this.username,
+        password: this.password,
+      },
+    });
+  }
+
+  private buildMetricsString() {
+    return `# HELP playwright_test_total The total number of tests
+# TYPE playwright_test_total counter
+playwright_test_total ${this.totalTests}
+# HELP playwright_test_passed The number of passed tests
+# TYPE playwright_test_passed counter
+playwright_test_passed ${this.passedTests}
+# HELP playwright_test_failed The number of failed tests
+# TYPE playwright_test_failed counter
+playwright_test_failed ${this.failedTests}
+# HELP playwright_test_skipped The number of skipped tests
+# TYPE playwright_test_skipped counter
+playwright_test_skipped ${this.skippedTests}
+# HELP playwright_test_duration The duration of the test run
+# TYPE playwright_test_duration gauge
+playwright_test_duration ${this.duration}
+`;
+  }
+}
+
+export default PrometheusReporter;