Feat/collapse large reports (#172)

Author: Ma11hewThomas

.github/workflows/build-and-test.yaml

@@ -33,7 +33,6 @@ jobs:
           flaky-rate-report: true
           slowest-report: true
           previous-results-report: true
-          use-suite-name: true
           upload-artifact: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -247,6 +246,27 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         if: always()
+  collapse-large-reports-test:
+    needs: build-and-test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install dependencies
+        run: npm install
+      - name: Modify reports
+        run: npm run modify-reports
+      - name: Collapse Large Reports Test
+        uses: ./
+        with:
+          report-path: './ctrf-reports/*.json'
+          test-report: true
+          test-list-report: true
+          collapse-large-reports: true
+          annotate: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        if: always()
   junit-to-ctrf-test:
     needs: build-and-test
     runs-on: ubuntu-latest

__tests__/ctrf/report-preparation.test.ts

@@ -554,6 +554,7 @@ function createSingleReportInputs(): Inputs {
     summary: false,
     pullRequest: false,
     issue: '',
+    collapseLargeReports: false,
     summaryReport: true, // Only 1 report enabled
     githubReport: false,
     testReport: false,

action.yml

@@ -175,6 +175,10 @@ inputs:
     description: 'Upload the processed CTRF report for future processing'
     required: false
     default: false
+  collapse-large-reports:
+    description: 'Collapse large reports (test-table and test-list) by default.'
+    required: false
+    default: false
 
   # Advanced Options
   artifact-name:

dist/index.js

@@ -17,6 +17,7 @@ export function getCliInputs(args: Arguments): Inputs {
     summary: true,
     pullRequest: args.pullRequest || false,
     issue: '',
+    collapseLargeReports: false,
     summaryReport: args._.includes('summary'),
     githubReport: args._.includes('github'),
     testReport: args._.includes('tests'),
@@ -81,6 +82,7 @@ export function getInputs(): Inputs {
     githubReport: core.getInput('github-report').toLowerCase() === 'true',
     pullRequest: core.getInput('pull-request').toLowerCase() === 'true',
     issue: core.getInput('issue').toLowerCase() || '',
+    collapseLargeReports: core.getInput('collapse-large-reports').toLowerCase() === 'true',
     summaryReport: core.getInput('summary-report').toLowerCase() === 'true',
     testReport: core.getInput('test-report').toLowerCase() === 'true',
     testListReport: core.getInput('test-list-report').toLowerCase() === 'true',

dist/index.js.map

@@ -1,6 +1,7 @@
 import Handlebars from 'handlebars'
 import { getEmoji, getGitHubIcon } from '../../ctrf/helpers'
 import { CtrfTest, CtrfTestState } from '../../types'
+import * as core from '@actions/core'
 
 /**
  * Filters an array of tests to only those that have failed, then limits the result to a specified number.
@@ -366,3 +367,25 @@ export function formatTestPathHelper(): void {
     )
   })
 }
+
+/**
+ * Gets the collapse-large-reports input value from GitHub Actions.
+ *
+ * @example
+ * In Handlebars:
+ * {{#if (getCollapseLargeReports)}}
+ *   <details><summary>Tests</summary>
+ *     <!-- content -->
+ *   </details>
+ * {{else}}
+ *   <!-- content -->
+ * {{/if}}
+ *
+ * @returns {boolean} True if collapse-large-reports is enabled, false otherwise.
+ */
+export function getCollapseLargeReportsHelper(): void {
+  Handlebars.registerHelper('getCollapseLargeReports', () => {
+    const input = core.getInput('collapse-large-reports')
+    return input ? input.toLowerCase() === 'true' : false
+  })
+}