ci: add modify-reports step to GitHub Actions workflows

Ma11hewThomas · Ma11hewThomas · commit 71026fb13497 · 2025-02-10T18:55:36.000Z
diff --git a/.eslintignore b/.eslintignore
@@ -3,3 +3,5 @@ dist/
 node_modules/
 coverage/
 templates/
+scripts/
+
diff --git a/.github/workflows/ai-action.yaml b/.github/workflows/ai-action.yaml
@@ -18,6 +18,8 @@ jobs:
         run: npm install
       - name: Build
         run: npm run all:action
+      - name: Modify reports
+        run: npm run modify-reports
       - name: Publish Test Report
         uses: ./
         with:
diff --git a/.github/workflows/cli.yaml b/.github/workflows/cli.yaml
@@ -18,6 +18,8 @@ jobs:
         run: npm install
       - name: Build
         run: npm run build:npm
+      - name: Modify reports
+        run: npm run modify-reports
       - name: Summary table
         run: node dist/core/cli.js summary ctrf-reports/ctrf-report.json --title "Summary table"
       - name: Default tables
diff --git a/.github/workflows/commit-action.yaml b/.github/workflows/commit-action.yaml
@@ -18,6 +18,8 @@ jobs:
         run: npm install
       - name: Build
         run: npm run all:action
+      - name: Modify reports
+        run: npm run modify-reports
       - name: Publish Test Report
         uses: ./
         with:
diff --git a/.github/workflows/community-action.yaml b/.github/workflows/community-action.yaml
@@ -18,6 +18,8 @@ jobs:
         run: npm install
       - name: Build
         run: npm run all:action
+      - name: Modify reports
+        run: npm run modify-reports
       - name: Publish Test Report
         uses: ./
         with:
diff --git a/.github/workflows/custom-action.yaml b/.github/workflows/custom-action.yaml
@@ -18,6 +18,8 @@ jobs:
         run: npm install
       - name: Build
         run: npm run all:action
+      - name: Modify reports
+        run: npm run modify-reports
       - name: Publish Test Report
         uses: ./
         with:
diff --git a/.github/workflows/detailed-action.yaml b/.github/workflows/detailed-action.yaml
@@ -18,6 +18,8 @@ jobs:
         run: npm install
       - name: Build
         run: npm run all:action
+      - name: Modify reports
+        run: npm run modify-reports
       - name: Publish Test Report
         uses: ./
         with:
diff --git a/.github/workflows/failed-action.yaml b/.github/workflows/failed-action.yaml
@@ -18,6 +18,8 @@ jobs:
         run: npm install
       - name: Build
         run: npm run all:action
+      - name: Modify reports
+        run: npm run modify-reports
       - name: Publish Test Report
         uses: ./
         with:
diff --git a/.github/workflows/flaky-action.yaml b/.github/workflows/flaky-action.yaml
@@ -18,6 +18,8 @@ jobs:
         run: npm install
       - name: Build
         run: npm run all:action
+      - name: Modify reports
+        run: npm run modify-reports
       - name: Publish Test Report
         uses: ./
         with:
diff --git a/.github/workflows/previous-action.yaml b/.github/workflows/previous-action.yaml
@@ -18,6 +18,8 @@ jobs:
         run: npm install
       - name: Build
         run: npm run all:action
+      - name: Modify reports
+        run: npm run modify-reports
       - name: Publish Test Report
         uses: ./
         with:
diff --git a/.github/workflows/skipped-action.yaml b/.github/workflows/skipped-action.yaml
@@ -18,6 +18,8 @@ jobs:
         run: npm install
       - name: Build
         run: npm run all:action
+      - name: Modify reports
+        run: npm run modify-reports
       - name: Publish Test Report
         uses: ./
         with:
diff --git a/.github/workflows/suite-action.yaml b/.github/workflows/suite-action.yaml
@@ -18,6 +18,8 @@ jobs:
         run: npm install
       - name: Build
         run: npm run all:action
+      - name: Modify reports
+        run: npm run modify-reports
       - name: Publish Test Report
         uses: ./
         with:
diff --git a/.github/workflows/summary-action.yaml b/.github/workflows/summary-action.yaml
@@ -18,6 +18,8 @@ jobs:
         run: npm install
       - name: Build
         run: npm run all:action
+      - name: Modify reports
+        run: npm run modify-reports
       - name: Publish Test Report
         uses: ./
         with:
diff --git a/scripts/modify-reports.ts b/scripts/modify-reports.ts
@@ -1,129 +1,132 @@
-import * as fs from 'fs';
-import * as path from 'path';
+// @ts-nocheck
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable */
+import * as fs from 'fs'
+import * as path from 'path'
 
 interface Test {
-    name: string;
-    status: 'passed' | 'failed' | 'pending' | 'skipped' | 'other';
-    duration: number;
-    flaky?: boolean;
-    retries?: number;
-    message?: string;
-    trace?: string;
-    filePath?: string;
-    suite?: string;
+  name: string
+  status: 'passed' | 'failed' | 'pending' | 'skipped' | 'other'
+  duration: number
+  flaky?: boolean
+  retries?: number
+  message?: string
+  trace?: string
+  filePath?: string
+  suite?: string
 }
 
 interface TestReport {
-    results: {
-        tool: {
-            name: string;
-        };
-        summary: {
-            tests: number;
-            passed: number;
-            failed: number;
-            pending: number;
-            skipped: number;
-            other: number;
-            start: number;
-            stop: number;
-        };
-        tests: Test[];
-    };
+  results: {
+    tool: {
+      name: string
+    }
+    summary: {
+      tests: number
+      passed: number
+      failed: number
+      pending: number
+      skipped: number
+      other: number
+      start: number
+      stop: number
+    }
+    tests: Test[]
+  }
 }
 
 function getRandomInt(min: number, max: number): number {
-    return Math.floor(Math.random() * (max - min + 1)) + min;
+  return Math.floor(Math.random() * (max - min + 1)) + min
 }
 
 function modifyTestResults(tests: Test[]): Test[] {
-    return tests.map(test => {
-        // Randomly make some tests flaky
-        if (Math.random() < 0.3) {
-            test.flaky = true;
-            test.retries = getRandomInt(1, 3);
-        }
-
-        // Randomly change some test statuses
-        const rand = Math.random();
-        if (rand < 0.15) {
-            test.status = 'failed';
-            test.message = 'Assertion failed: expected value to be true';
-            test.trace = `${test.filePath}:${getRandomInt(10, 100)}`;
-        } else if (rand < 0.2) {
-            test.status = 'skipped';
-            delete test.message;
-            delete test.trace;
-        } else if (rand < 0.25) {
-            test.status = 'pending';
-            delete test.message;
-            delete test.trace;
-        } else {
-            test.status = 'passed';
-            delete test.message;
-            delete test.trace;
-        }
-
-        // Randomize duration between 500ms and 3000ms
-        test.duration = getRandomInt(500, 3000);
-
-        return test;
-    });
+  return tests.map(test => {
+    // Randomly make some tests flaky
+    if (Math.random() < 0.3) {
+      test.flaky = true
+      test.retries = getRandomInt(1, 3)
+    }
+
+    // Randomly change some test statuses
+    const rand = Math.random()
+    if (rand < 0.15) {
+      test.status = 'failed'
+      test.message = 'Assertion failed: expected value to be true'
+      test.trace = `${test.filePath}:${getRandomInt(10, 100)}`
+    } else if (rand < 0.2) {
+      test.status = 'skipped'
+      delete test.message
+      delete test.trace
+    } else if (rand < 0.25) {
+      test.status = 'pending'
+      delete test.message
+      delete test.trace
+    } else {
+      test.status = 'passed'
+      delete test.message
+      delete test.trace
+    }
+
+    // Randomize duration between 500ms and 3000ms
+    test.duration = getRandomInt(500, 3000)
+
+    return test
+  })
 }
 
 function updateSummary(tests: Test[]): any {
-    const summary = {
-        tests: tests.length,
-        passed: 0,
-        failed: 0,
-        pending: 0,
-        skipped: 0,
-        other: 0,
-        start: Date.now() - 10000, // 10 seconds ago
-        stop: Date.now()
-    };
-
-    tests.forEach(test => {
-        switch (test.status) {
-            case 'passed':
-                summary.passed++;
-                break;
-            case 'failed':
-                summary.failed++;
-                break;
-            case 'pending':
-                summary.pending++;
-                break;
-            case 'skipped':
-                summary.skipped++;
-                break;
-            default:
-                summary.other++;
-        }
-    });
-
-    return summary;
+  const summary = {
+    tests: tests.length,
+    passed: 0,
+    failed: 0,
+    pending: 0,
+    skipped: 0,
+    other: 0,
+    start: Date.now() - 10000, // 10 seconds ago
+    stop: Date.now()
+  }
+
+  tests.forEach(test => {
+    switch (test.status) {
+      case 'passed':
+        summary.passed++
+        break
+      case 'failed':
+        summary.failed++
+        break
+      case 'pending':
+        summary.pending++
+        break
+      case 'skipped':
+        summary.skipped++
+        break
+      default:
+        summary.other++
+    }
+  })
+
+  return summary
 }
 
 function modifyReport(reportPath: string): void {
-    const report: TestReport = JSON.parse(fs.readFileSync(reportPath, 'utf-8'));
-    
-    // Modify test results
-    report.results.tests = modifyTestResults(report.results.tests);
-    
-    // Update summary
-    report.results.summary = updateSummary(report.results.tests);
-
-    // Write modified report
-    fs.writeFileSync(reportPath, JSON.stringify(report, null, 2));
-    console.log(`Modified report: ${reportPath}`);
+  const report: TestReport = JSON.parse(fs.readFileSync(reportPath, 'utf-8'))
+
+  // Modify test results
+  report.results.tests = modifyTestResults(report.results.tests)
+
+  // Update summary
+  report.results.summary = updateSummary(report.results.tests)
+
+  // Write modified report
+  fs.writeFileSync(reportPath, JSON.stringify(report, null, 2))
+  console.log(`Modified report: ${reportPath}`)
 }
 
 // Process all JSON files in ctrf-reports directory
-const reportsDir = path.join(process.cwd(), 'ctrf-reports');
-const files = fs.readdirSync(reportsDir)
-    .filter(file => file.endsWith('.json'));
+const reportsDir = path.join(process.cwd(), 'ctrf-reports')
+const files = fs.readdirSync(reportsDir).filter(file => file.endsWith('.json'))
 
 files.forEach(file => {
-    modifyReport(path.join(reportsDir, file));
-}); 
+  modifyReport(path.join(reportsDir, file))
+})
diff --git a/tsconfig.json b/tsconfig.json
@@ -18,5 +18,11 @@
     "skipLibCheck": true,
     "newLine": "lf"
   },
-  "exclude": ["./dist", "./node_modules", "./__tests__", "./coverage"]
+  "exclude": [
+    "./dist",
+    "./node_modules",
+    "./__tests__",
+    "./coverage",
+    "./scripts"
+  ]
 }
