From cc98166aaa6341bde2293cad6420abbbd43b974b Mon Sep 17 00:00:00 2001
From: Yury Semikhatsky <yurys@chromium.org>
Date: Thu, 19 Dec 2024 22:59:24 -0800
Subject: [PATCH] chore(bidi): add csv report (#34107)

---
 .github/workflows/tests_bidi.yml |  7 +++
 tests/bidi/csvReporter.ts        | 82 ++++++++++++++++++++++++++++++++
 tests/bidi/playwright.config.ts  |  1 +
 3 files changed, 90 insertions(+)
 create mode 100644 tests/bidi/csvReporter.ts

diff --git a/.github/workflows/tests_bidi.yml b/.github/workflows/tests_bidi.yml
index 4fee45e34c084..db54550a4cda6 100644
--- a/.github/workflows/tests_bidi.yml
+++ b/.github/workflows/tests_bidi.yml
@@ -44,3 +44,10 @@ jobs:
       run: xvfb-run --auto-servernum --server-args="-screen 0 1280x960x24" -- npm run biditest -- --project=${{ matrix.channel }}*
       env:
         PWTEST_USE_BIDI_EXPECTATIONS: '1'
+    - name: Upload csv report to GitHub
+      if: ${{ !cancelled() }}
+      uses: actions/upload-artifact@v4
+      with:
+        name: csv-report
+        path: test-results/report.csv
+        retention-days: 7
diff --git a/tests/bidi/csvReporter.ts b/tests/bidi/csvReporter.ts
new file mode 100644
index 0000000000000..8fb936dd11517
--- /dev/null
+++ b/tests/bidi/csvReporter.ts
@@ -0,0 +1,82 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type {
+  FullConfig, FullResult, Reporter, Suite
+} from '@playwright/test/reporter';
+import { stripAnsi } from '../config/utils';
+import fs from 'fs';
+import path from 'path';
+
+
+type ReporterOptions = {
+  outputFile?: string,
+  configDir: string,
+};
+
+class CsvReporter implements Reporter {
+  private _suite: Suite;
+  private _options: ReporterOptions;
+  private _pendingWrite: Promise<void>;
+
+  constructor(options: ReporterOptions) {
+    this._options = options;
+  }
+
+  onBegin(config: FullConfig, suite: Suite) {
+    this._suite = suite;
+  }
+
+  onEnd(result: FullResult) {
+    const rows = [['File Name', 'Test Name', 'Expected Status', 'Status', 'Error Message']];
+    for (const project of this._suite.suites) {
+      for (const file of project.suites) {
+        for (const test of file.allTests()) {
+          if (test.ok())
+            continue;
+          const row = [];
+          row.push(file.title);
+          row.push(csvEscape(test.title));
+          row.push(test.expectedStatus);
+          row.push(test.outcome());
+          const result = test.results.find(r => r.error);
+          const errorMessage = stripAnsi(result?.error?.message.replace(/\s+/g, ' ').trim().substring(0, 1024));
+          row.push(csvEscape(errorMessage ?? ''));
+          rows.push(row);
+        }
+      }
+    }
+    const csv = rows.map(r => r.join(',')).join('\n');
+    const reportFile = path.resolve(this._options.configDir, this._options.outputFile || 'test-results.csv');
+    this._pendingWrite = fs.promises.writeFile(reportFile, csv);
+  }
+
+  async onExit() {
+    await this._pendingWrite;
+  }
+
+  printsToStdio(): boolean {
+    return false;
+  }
+}
+
+function csvEscape(str) {
+  if (str.includes('"') || str.includes(',') || str.includes('\n'))
+    return `"${str.replace(/"/g, '""')}"`;
+  return str;
+}
+
+export default CsvReporter;
\ No newline at end of file
diff --git a/tests/bidi/playwright.config.ts b/tests/bidi/playwright.config.ts
index 481fa4243476a..8dbe5b2b9d61d 100644
--- a/tests/bidi/playwright.config.ts
+++ b/tests/bidi/playwright.config.ts
@@ -39,6 +39,7 @@ const reporters = () => {
     hasDebugOutput ? ['list'] : ['dot'],
     ['json', { outputFile: path.join(outputDir, 'report.json') }],
     ['blob', { fileName: `${process.env.PWTEST_BOT_NAME}.zip` }],
+    ['./csvReporter', { outputFile: path.join(outputDir, 'report.csv') }],
   ] : [
     ['html', { open: 'on-failure' }],
     ['./expectationReporter', { rebase: false }],