Merge pull request #772 from dorny/codex/summary-output

Bumps [jest-junit](https://github.com/jest-community/jest-junit) from 16.0.0 to 17.0.0.
- [Release notes](https://github.com/jest-community/jest-junit/releases)
- [Commits](https://github.com/jest-community/jest-junit/compare/v16.0.0...v17.0.0)

---
updated-dependencies:
- dependency-name: jest-junit
  dependency-version: 17.0.0
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.1.0
+* Feature: Add `list-files` input to control test report file listing https://github.com/dorny/test-reporter/pull/773
+* Feature: Add `summary_file` output with the path to the generated summary in Markdown format https://github.com/dorny/test-reporter/pull/772
+
 ## 3.0.0
 * Feature: Use NodeJS 24 LTS as default runtime https://github.com/dorny/test-reporter/pull/738
 

README.md

@@ -47,7 +47,7 @@ jobs:
     name: Build & Test
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4     # checkout the repo
+      - uses: actions/checkout@v6     # checkout the repo
       - run: npm ci                   # install packages
       - run: npm test                 # run tests (configured to use jest-junit reporter)
 
@@ -78,10 +78,10 @@ jobs:
   build-test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4         # checkout the repo
+      - uses: actions/checkout@v6         # checkout the repo
       - run: npm ci                       # install packages
       - run: npm test                     # run tests (configured to use jest-junit reporter)
-      - uses: actions/upload-artifact@v4  # upload test results
+      - uses: actions/upload-artifact@v7  # upload test results
         if: ${{ !cancelled() }}           # run this step even if previous step failed
         with:
           name: test-results
@@ -184,6 +184,12 @@ jobs:
     #   none
     list-tests: 'all'
 
+    # Limits which test result files are listed:
+    #   all
+    #   failed
+    #   none
+    list-files: 'all'
+
     # Limits number of created annotations with error message and stack trace captured during test execution.
     # Must be less or equal to 50.
     max-annotations: '10'
@@ -219,6 +225,7 @@ jobs:
 | time       | Test execution time [ms] |
 | url        | Check run URL            |
 | url_html   | Check run URL HTML       |
+| summary_file | Path to a file containing the generated test report summary in Markdown format |
 | slug_prefix| Random anchor links slug prefix generated for the summary headers |
 
 ## Supported formats

__tests__/report/get-report.test.ts

@@ -1,4 +1,5 @@
-import {getBadge, DEFAULT_OPTIONS, ReportOptions} from '../../src/report/get-report.js'
+import {DEFAULT_OPTIONS, getBadge, getReport, ReportOptions} from '../../src/report/get-report.js'
+import {TestCaseResult, TestGroupResult, TestRunResult, TestSuiteResult} from '../../src/test-results.js'
 
 describe('getBadge', () => {
   describe('URI encoding with special characters', () => {
@@ -131,3 +132,147 @@ describe('getBadge', () => {
     })
   })
 })
+
+describe('getReport', () => {
+  // Helper function to create test results
+  function createTestResult(path: string, passed: number, failed: number, skipped: number): TestRunResult {
+    const tests: TestCaseResult[] = []
+    for (let i = 0; i < passed; i++) {
+      tests.push(new TestCaseResult(`passed-test-${i}`, 'success', 100))
+    }
+    for (let i = 0; i < failed; i++) {
+      tests.push(
+        new TestCaseResult(`failed-test-${i}`, 'failed', 100, {
+          details: 'Test failed',
+          message: 'Assertion error'
+        })
+      )
+    }
+    for (let i = 0; i < skipped; i++) {
+      tests.push(new TestCaseResult(`skipped-test-${i}`, 'skipped', 0))
+    }
+
+    const group = new TestGroupResult('test-group', tests)
+    const suite = new TestSuiteResult('test-suite', [group])
+    return new TestRunResult(path, [suite])
+  }
+
+  describe('list-files parameter', () => {
+    const results = [
+      createTestResult('passing-file.spec.ts', 5, 0, 0),
+      createTestResult('failing-file.spec.ts', 3, 2, 1),
+      createTestResult('passing-with-skipped-file.spec.ts', 8, 0, 2)
+    ]
+
+    it('shows all files when list-files is "all"', () => {
+      const report = getReport(results, {
+        ...DEFAULT_OPTIONS,
+        listFiles: 'all',
+        listSuites: 'none',
+        listTests: 'none'
+      })
+
+      expect(report).toContain('|Report|Passed|Failed|Skipped|Time|')
+      expect(report).toContain('passing-file.spec.ts')
+      expect(report).toContain('failing-file.spec.ts')
+      expect(report).toContain('passing-with-skipped-file.spec.ts')
+    })
+
+    it('shows only failed files when list-files is "failed"', () => {
+      const report = getReport(results, {
+        ...DEFAULT_OPTIONS,
+        listFiles: 'failed',
+        listSuites: 'none',
+        listTests: 'none'
+      })
+
+      expect(report).toContain('|Report|Passed|Failed|Skipped|Time|')
+      expect(report).not.toContain('passing-file.spec.ts')
+      expect(report).toContain('failing-file.spec.ts')
+      expect(report).not.toContain('passing-with-skipped-file.spec.ts')
+    })
+
+    it('shows no file details when list-files is "none"', () => {
+      const report = getReport(results, {
+        ...DEFAULT_OPTIONS,
+        listFiles: 'none',
+        listSuites: 'none',
+        listTests: 'none'
+      })
+
+      expect(report).toContain('![')
+      expect(report).not.toContain('|Report|Passed|Failed|Skipped|Time|')
+      expect(report).not.toContain('passing-file.spec.ts')
+      expect(report).not.toContain('failing-file.spec.ts')
+      expect(report).not.toContain('passing-with-skipped-file.spec.ts')
+    })
+
+    it('does not show an empty summary table when list-files is "none" and only-summary is enabled', () => {
+      const report = getReport(results, {
+        ...DEFAULT_OPTIONS,
+        listFiles: 'none',
+        listSuites: 'all',
+        onlySummary: true,
+        listTests: 'none'
+      })
+
+      expect(report).toContain('![')
+      expect(report).not.toContain('|Report|Passed|Failed|Skipped|Time|')
+      expect(report).not.toContain('passing-file.spec.ts')
+      expect(report).not.toContain('failing-file.spec.ts')
+      expect(report).not.toContain('passing-with-skipped-file.spec.ts')
+    })
+
+    it('works correctly with list-suites and list-tests when list-files is "failed"', () => {
+      const report = getReport(results, {
+        ...DEFAULT_OPTIONS,
+        listFiles: 'failed',
+        listSuites: 'all',
+        listTests: 'all'
+      })
+
+      expect(report).toContain('|Report|Passed|Failed|Skipped|Time|')
+      expect(report).not.toContain('passing-file.spec.ts')
+      expect(report).toContain('failing-file.spec.ts')
+      expect(report).not.toContain('passing-with-skipped-file.spec.ts')
+      // Should show suite details for the failed file
+      expect(report).toContain('test-suite')
+    })
+
+    it('filters correctly when all files pass and list-files is "failed"', () => {
+      const allPassingResults = [
+        createTestResult('passing-file-1.spec.ts', 5, 0, 0),
+        createTestResult('passing-file-2.spec.ts', 8, 0, 2)
+      ]
+
+      const report = getReport(allPassingResults, {
+        ...DEFAULT_OPTIONS,
+        listFiles: 'failed',
+        listSuites: 'all',
+        listTests: 'none'
+      })
+
+      expect(report).not.toContain('passing-file-1.spec.ts')
+      expect(report).not.toContain('passing-file-2.spec.ts')
+      expect(report).toContain('![')
+      expect(report).not.toContain('|Report|Passed|Failed|Skipped|Time|')
+    })
+
+    it('filters correctly when all files fail and list-files is "failed"', () => {
+      const allFailingResults = [
+        createTestResult('failing-file-1.spec.ts', 0, 5, 0),
+        createTestResult('failing-file-2.spec.ts', 1, 2, 1)
+      ]
+
+      const report = getReport(allFailingResults, {
+        ...DEFAULT_OPTIONS,
+        listFiles: 'failed',
+        listSuites: 'all',
+        listTests: 'none'
+      })
+
+      expect(report).toContain('failing-file-1.spec.ts')
+      expect(report).toContain('failing-file-2.spec.ts')
+    })
+  })
+})

action.yml

@@ -54,6 +54,14 @@ inputs:
         - none
     required: false
     default: 'all'
+  list-files:
+    description: |
+      Limits which test result files are listed. Supported options:
+        - all
+        - failed
+        - none
+    required: false
+    default: 'all'
   max-annotations:
     description: |
       Limits number of created annotations with error message and stack trace captured during test execution.
@@ -122,6 +130,8 @@ outputs:
     description: Check run URL
   url_html:
     description: Check run URL HTML
+  summary_file:
+    description: Path to a file containing the generated test report summary in Markdown format
   slug_prefix:
     description: Random prefix added to generated report anchor slugs for this action run
 runs:

dist/licenses.txt

@@ -889,7 +889,7 @@ reusify
 MIT
 The MIT License (MIT)
 
-Copyright (c) 2015 Matteo Collina
+Copyright (c) 2015-2024 Matteo Collina
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package.json

@@ -37,37 +37,37 @@
   "author": "Michal Dorner <dorner.michal@gmail.com>",
   "license": "MIT",
   "dependencies": {
-    "@actions/core": "^3.0.0",
+    "@actions/core": "^3.0.1",
     "@actions/exec": "^3.0.0",
-    "@actions/github": "^9.0.0",
-    "adm-zip": "^0.5.16",
+    "@actions/github": "^9.1.1",
+    "adm-zip": "^0.5.17",
     "fast-glob": "^3.3.3",
-    "picomatch": "^4.0.3",
+    "picomatch": "^4.0.4",
     "xml2js": "^0.6.2"
   },
   "devDependencies": {
     "@octokit/webhooks-types": "^7.6.1",
     "@types/adm-zip": "^0.5.8",
     "@types/jest": "^30.0.0",
-    "@types/node": "^24.12.0",
-    "@types/picomatch": "^4.0.2",
+    "@types/node": "^24.12.2",
+    "@types/picomatch": "^4.0.3",
     "@types/xml2js": "^0.4.14",
-    "@typescript-eslint/eslint-plugin": "^8.56.1",
-    "@typescript-eslint/parser": "^8.57.1",
+    "@typescript-eslint/eslint-plugin": "^8.59.0",
+    "@typescript-eslint/parser": "^8.59.0",
     "@vercel/ncc": "^0.38.4",
     "eol-converter-cli": "^1.1.0",
     "eslint": "^9.39.4",
     "eslint-import-resolver-typescript": "^4.4.4",
     "eslint-plugin-github": "^6.0.0",
     "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-jest": "^29.15.0",
+    "eslint-plugin-jest": "^29.15.2",
     "eslint-plugin-prettier": "^5.5.5",
     "jest": "^30.3.0",
-    "jest-junit": "^16.0.0",
+    "jest-junit": "^17.0.0",
     "js-yaml": "^4.1.1",
-    "prettier": "^3.8.1",
-    "ts-jest": "^29.4.6",
-    "typescript": "^5.9.3"
+    "prettier": "^3.8.3",
+    "ts-jest": "^29.4.9",
+    "typescript": "^6.0.3"
   },
   "overrides": {
     "sax": "^1.4.3"

reports/jest/package-lock.json

@@ -4548,10 +4548,11 @@
       "dev": true
     },
     "node_modules/picomatch": {
-      "version": "2.2.2",
-      "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.2.2.tgz",
-      "integrity": "sha512-q0M/9eZHzmr0AulXyPwNfZjtwZ/RBZlbN3K3CErVrk50T2ASYI7Bye0EvekFY3IP1Nt2DHu0re+V2ZHIpMkuWg==",
+      "version": "2.3.2",
+      "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.2.tgz",
+      "integrity": "sha512-V7+vQEJ06Z+c5tSye8S+nHUfI51xoXIXjHQ99cQtKUkQqqO1kO/KCJUfZXuB47h/YBlDhah2H3hdUGXn8ie0oA==",
       "dev": true,
+      "license": "MIT",
       "engines": {
         "node": ">=8.6"
       },

src/main.ts

@@ -2,6 +2,9 @@ import * as core from '@actions/core'
 import * as github from '@actions/github'
 import {GitHub} from '@actions/github/lib/utils'
 import {randomBytes} from 'node:crypto'
+import {writeFileSync} from 'node:fs'
+import {tmpdir} from 'node:os'
+import {join} from 'node:path'
 
 import {ArtifactProvider} from './input-providers/artifact-provider.js'
 import {LocalFileProvider} from './input-providers/local-file-provider.js'
@@ -44,6 +47,7 @@ class TestReporter {
   readonly reporter = core.getInput('reporter', {required: true})
   readonly listSuites = core.getInput('list-suites', {required: true}) as 'all' | 'failed' | 'none'
   readonly listTests = core.getInput('list-tests', {required: true}) as 'all' | 'failed' | 'none'
+  readonly listFiles = core.getInput('list-files', {required: true}) as 'all' | 'failed' | 'none'
   readonly maxAnnotations = parseInt(core.getInput('max-annotations', {required: true}))
   readonly failOnError = core.getInput('fail-on-error', {required: true}) === 'true'
   readonly failOnEmpty = core.getInput('fail-on-empty', {required: true}) === 'true'
@@ -71,6 +75,11 @@ class TestReporter {
       return
     }
 
+    if (this.listFiles !== 'all' && this.listFiles !== 'failed' && this.listFiles !== 'none') {
+      core.setFailed(`Input parameter 'list-files' has invalid value`)
+      return
+    }
+
     if (this.collapsed !== 'auto' && this.collapsed !== 'always' && this.collapsed !== 'never') {
       core.setFailed(`Input parameter 'collapsed' has invalid value`)
       return
@@ -177,7 +186,17 @@ class TestReporter {
       }
     }
 
-    const {listSuites, listTests, slugPrefix, onlySummary, useActionsSummary, badgeTitle, reportTitle, collapsed} = this
+    const {
+      listSuites,
+      listTests,
+      slugPrefix,
+      listFiles,
+      onlySummary,
+      useActionsSummary,
+      badgeTitle,
+      reportTitle,
+      collapsed
+    } = this
 
     const passed = results.reduce((sum, tr) => sum + tr.passed, 0)
     const failed = results.reduce((sum, tr) => sum + tr.failed, 0)
@@ -192,6 +211,7 @@ class TestReporter {
           listSuites,
           listTests,
           slugPrefix,
+          listFiles,
           baseUrl,
           onlySummary,
           useActionsSummary,
@@ -204,6 +224,7 @@ class TestReporter {
 
       core.info('Summary content:')
       core.info(summary)
+      this.writeSummaryFile(summary)
       await core.summary.addRaw(summary).write()
     } else {
       core.info(`Creating check run ${name}`)
@@ -224,6 +245,7 @@ class TestReporter {
         listSuites,
         listTests,
         slugPrefix,
+        listFiles,
         baseUrl,
         onlySummary,
         useActionsSummary,
@@ -234,6 +256,7 @@ class TestReporter {
 
       core.info('Creating annotations')
       const annotations = getAnnotations(results, this.maxAnnotations)
+      this.writeSummaryFile(summary)
 
       const isFailed = this.failOnError && results.some(tr => tr.result === 'failed')
       const conclusion = isFailed ? 'failure' : 'success'
@@ -260,6 +283,14 @@ class TestReporter {
     return results
   }
 
+  writeSummaryFile(summary: string): void {
+    const dir = process.env.RUNNER_TEMP || tmpdir()
+    const file = join(dir, `test-reporter-summary-${randomBytes(8).toString('hex')}.md`)
+    writeFileSync(file, summary)
+    core.info(`Summary written to ${file}`)
+    core.setOutput('summary_file', file)
+  }
+
   getParser(reporter: string, options: ParseOptions): TestParser {
     switch (reporter) {
       case 'dart-json':

src/report/get-report.ts

@@ -12,6 +12,7 @@ export interface ReportOptions {
   listSuites: 'all' | 'failed' | 'none'
   listTests: 'all' | 'failed' | 'none'
   slugPrefix: string
+  listFiles: 'all' | 'failed' | 'none'
   baseUrl: string
   onlySummary: boolean
   useActionsSummary: boolean
@@ -24,6 +25,7 @@ export const DEFAULT_OPTIONS: ReportOptions = {
   listSuites: 'all',
   listTests: 'all',
   slugPrefix: '',
+  listFiles: 'all',
   baseUrl: '',
   onlySummary: false,
   useActionsSummary: true,
@@ -173,8 +175,15 @@ function getTestRunsReport(testRuns: TestRunResult[], options: ReportOptions): s
     sections.push(` `)
   }
 
-  if (testRuns.length > 0 || options.onlySummary) {
-    const tableData = testRuns
+  // Filter test runs based on list-files option
+  const filteredTestRuns =
+    options.listFiles === 'failed'
+      ? testRuns.filter(tr => tr.result === 'failed')
+      : options.listFiles === 'none'
+        ? []
+        : testRuns
+
+  const tableData = filteredTestRuns
     .map((tr, originalIndex) => ({tr, originalIndex}))
     .filter(({tr}) => tr.passed > 0 || tr.failed > 0 || tr.skipped > 0)
     .map(({tr, originalIndex}) => {
@@ -188,6 +197,7 @@ function getTestRunsReport(testRuns: TestRunResult[], options: ReportOptions): s
       return [nameLink, passed, failed, skipped, time]
     })
 
+  if (tableData.length > 0) {
     const resultsTable = table(
       ['Report', 'Passed', 'Failed', 'Skipped', 'Time'],
       [Align.Left, Align.Right, Align.Right, Align.Right, Align.Right],
@@ -197,7 +207,7 @@ function getTestRunsReport(testRuns: TestRunResult[], options: ReportOptions): s
   }
 
   if (options.onlySummary === false) {
-    const suitesReports = testRuns.map((tr, i) => getSuitesReport(tr, i, options)).flat()
+    const suitesReports = filteredTestRuns.map((tr, i) => getSuitesReport(tr, i, options)).flat()
     sections.push(...suitesReports)
   }