Merge pull request #123 from workgroupengineering/features/only-summary

Add option to generate only the summary from processed test results files

README.md

@@ -128,6 +128,11 @@ jobs:
     #   mocha-json
     reporter: ''
 
+    # Allows you to generate only the summary.
+    # If enabled, the report will contain a table listing each test results file and the number of passed, failed, and skipped tests.
+    # Detailed listing of test suites and test cases will be skipped.
+    only-summary: 'false'
+
     # Limits which test suites are listed:
     #   all
     #   failed

action.yml

@@ -53,6 +53,13 @@ inputs:
   working-directory:
     description: Relative path under $GITHUB_WORKSPACE where the repository was checked out
     required: false
+  only-summary:
+    description: |
+      Allows you to generate only the summary.
+      If enabled, the report will contain a table listing each test results file and the number of passed, failed, and skipped tests.
+      Detailed listing of test suites and test cases will be skipped.
+    default: 'false'
+    required: false
   token:
     description: GitHub Access Token
     required: false

src/main.ts

@@ -39,6 +39,7 @@ class TestReporter {
   readonly maxAnnotations = parseInt(core.getInput('max-annotations', {required: true}))
   readonly failOnError = core.getInput('fail-on-error', {required: true}) === 'true'
   readonly workDirInput = core.getInput('working-directory', {required: false})
+  readonly onlySummary = core.getInput('only-summary', {required: false}) === 'true'
   readonly token = core.getInput('token', {required: true})
   readonly octokit: InstanceType<typeof GitHub>
   readonly context = getCheckRunContext()
@@ -160,9 +161,9 @@ class TestReporter {
     })
 
     core.info('Creating report summary')
-    const {listSuites, listTests} = this
+    const {listSuites, listTests, onlySummary} = this
     const baseUrl = createResp.data.html_url
-    const summary = getReport(results, {listSuites, listTests, baseUrl})
+    const summary = getReport(results, {listSuites, listTests, baseUrl, onlySummary})
 
     core.info('Creating annotations')
     const annotations = getAnnotations(results, this.maxAnnotations)

src/report/get-report.ts

@@ -10,12 +10,14 @@ export interface ReportOptions {
   listSuites: 'all' | 'failed'
   listTests: 'all' | 'failed' | 'none'
   baseUrl: string
+  onlySummary: boolean
 }
 
 const defaultOptions: ReportOptions = {
   listSuites: 'all',
   listTests: 'all',
-  baseUrl: ''
+  baseUrl: '',
+  onlySummary: false
 }
 
 export function getReport(results: TestRunResult[], options: ReportOptions = defaultOptions): string {
@@ -132,7 +134,7 @@ function getBadge(passed: number, failed: number, skipped: number): string {
 function getTestRunsReport(testRuns: TestRunResult[], options: ReportOptions): string[] {
   const sections: string[] = []
 
-  if (testRuns.length > 1) {
+  if (testRuns.length > 1 || options.onlySummary) {
     const tableData = testRuns.map((tr, runIndex) => {
       const time = formatTime(tr.time)
       const name = tr.path
@@ -152,8 +154,10 @@ function getTestRunsReport(testRuns: TestRunResult[], options: ReportOptions): s
     sections.push(resultsTable)
   }
 
-  const suitesReports = testRuns.map((tr, i) => getSuitesReport(tr, i, options)).flat()
-  sections.push(...suitesReports)
+  if (options.onlySummary === false) {
+    const suitesReports = testRuns.map((tr, i) => getSuitesReport(tr, i, options)).flat()
+    sections.push(...suitesReports)
+  }
   return sections
 }