- add ability to skip successful summaries

  - FIXES #1287

Author: mikepenz

README.md

@@ -94,9 +94,10 @@ jobs:
 | `annotate_only`            | Optional. Will only annotate the results on the files, won't create a check run. Defaults to `false`.                                                                                               |
 | `transformers`             | Optional. Array of `Transformer`s offering the ability to adjust the fileName. Defaults to: `[{"searchValue":"::","replaceValue":"/"}]`                                                             |
 | `job_summary`              | Optional. Enables the publishing of the job summary for the results. Defaults to `true`. May be required to disable [Enterprise Server](https://github.com/mikepenz/action-junit-report/issues/637) |
-| `detailed_summary`         | Optional. Include table with all test results in the summary. Defaults to `false`.                                                                                                                  |
-| `flaky_summary`            | Optional. Include table with all flaky results in the summary. Defaults to `false`.                                                                                                                 |
-| `verbose_summary`          | Optional. Detail table will note if there were no test annotations for a test suite. Defaults to `true`.                                                                                            |
+| `detailed_summary`         | Optional. Include table with all test results in the summary (Also applies to comment). Defaults to `false`.                                                                                        |
+| `flaky_summary`            | Optional. Include table with all flaky results in the summary (Also applies to comment). Defaults to `false`.                                                                                       |
+| `verbose_summary`          | Optional. Detail table will note if there were no test annotations for a test suite (Also applies to comment). Defaults to `true`.                                                                  |
+| `skip_success_summary`     | Optional. Skips the summary table if only successful tests were detected (Also applies to comment). Defaults to `true`.                                                                             |
 | `group_suite`              | Optional. If enabled, will group the testcases by test suite in the `detailed_summary`. Defaults to `false`.                                                                                        |
 | `comment`                  | Optional. Enables a comment being added to the PR with the summary tables (Respects the summary configuration flags). Defaults to `false`.                                                          |
 | `updateComment`            | Optional. If a prior action run comment exists, it is updated. If disabled, new comments are creted for each run. Defaults to `true`.                                                               |
@@ -150,7 +151,6 @@ you can increase the memory allocation by setting an environment variable
 </p>
 </details>
 
-
 ### Action outputs
 
 After action execution it will return the test counts as output.
@@ -280,8 +280,6 @@ This will selectively use different methods for forked and unforked repos.
 </p>
 </details>
 
-
-
 ## Sample 🖥️
 
 <div align="center">

__tests__/table.test.ts

@@ -59,7 +59,7 @@ describe('buildSummaryTables', () => {
       '/'
     )
 
-    const [table, detailTable, flakyTable] = buildSummaryTables([testResult], true, true, true, true)
+    const [table, detailTable, flakyTable] = buildSummaryTables([testResult], true, true, true, true, false)
 
     expect(table).toStrictEqual(NORMAL_TABLE)
     expect(detailTable).toStrictEqual([
@@ -86,7 +86,7 @@ describe('buildSummaryTables', () => {
     expect(flakyTable).toStrictEqual(FLAKY_TABLE)
   })
 
-  it('should group detail tables', async () => {
+  it('should skip only successful tables', async () => {
     const testResult = await parseTestReports(
       'checkName',
       'summary',
@@ -101,6 +101,26 @@ describe('buildSummaryTables', () => {
     )
 
     const [table, detailTable, flakyTable] = buildSummaryTables([testResult], true, true, true, true, true)
+    expect(table).toStrictEqual([])
+    expect(detailTable).toStrictEqual([])
+    expect(flakyTable).toStrictEqual([])
+  })
+
+  it('should group detail tables', async () => {
+    const testResult = await parseTestReports(
+      'checkName',
+      'summary',
+      'test_results/nested/multi-level.xml',
+      '*',
+      true,
+      true,
+      true,
+      [],
+      '{{SUITE_NAME}}/{{TEST_NAME}}',
+      '/'
+    )
+
+    const [table, detailTable, flakyTable] = buildSummaryTables([testResult], true, true, true, true, false, true)
 
     expect(table).toStrictEqual(NORMAL_TABLE)
     expect(detailTable).toStrictEqual([

action.yml

@@ -98,6 +98,10 @@ inputs:
     description: 'Include note of missing test annotations in summary.'
     required: false
     default: 'true'
+  skip_success_summary:
+    description: 'Skips summaries that would not contain failed tests'
+    required: false
+    default: 'false'
   group_suite:
     description: 'If enabled, will group the testcases by test suite in the `detailed_summary`'
     required: false

dist/index.js

@@ -131,7 +131,9 @@ export async function attachSummary(
   detailsTable: SummaryTableRow[],
   flakySummary: SummaryTableRow[]
 ): Promise<void> {
-  await core.summary.addTable(table).write()
+  if (table.length > 0) {
+    await core.summary.addTable(table).write()
+  }
   if (detailsTable.length > 1) {
     await core.summary.addTable(detailsTable).write()
   }
@@ -157,6 +159,11 @@ export async function attachComment(
     return
   }
 
+  if (table.length === 0 && detailsTable.length === 0 && flakySummary.length === 0) {
+    core.debug(`Tables for comment were empty. 'skip_success_summary' enabled?`)
+    return
+  }
+
   const identifier = buildCommentIdentifier(checkName)
 
   let comment = buildTable(table)

dist/index.js.map

@@ -32,6 +32,7 @@ export async function run(): Promise<void> {
     const detailedSummary = core.getInput('detailed_summary') === 'true'
     const flakySummary = core.getInput('flaky_summary') === 'true'
     const verboseSummary = core.getInput('verbose_summary') === 'true'
+    const skipSuccessSummary = core.getInput('skip_success_summary') === 'true'
     const groupSuite = core.getInput('group_suite') === 'true'
     const comment = core.getInput('comment') === 'true'
     const updateComment = core.getInput('updateComment') === 'true'
@@ -157,6 +158,7 @@ export async function run(): Promise<void> {
       detailedSummary,
       flakySummary,
       verboseSummary,
+      skipSuccessSummary,
       groupSuite
     )
     if (jobSummary && supportsJobSummary) {

src/annotator.ts

@@ -9,6 +9,7 @@ export function buildSummaryTables(
   detailedSummary: boolean,
   flakySummary: boolean,
   verboseSummary: boolean,
+  skipSuccessSummary: boolean,
   groupSuite = false
 ): [SummaryTableRow[], SummaryTableRow[], SummaryTableRow[]] {
   // only include a warning icon if there are skipped tests
@@ -17,6 +18,11 @@ export function buildSummaryTables(
   const hasFailed = testResults.some(testResult => testResult.failed > 0)
   const hasTests = testResults.some(testResult => testResult.totalCount > 0)
 
+  if (skipSuccessSummary && !hasFailed) {
+    // if we have skip success summary enabled, and we don't have any test failures, return empty tables
+    return [[], [], []]
+  }
+
   const passedHeader = hasTests ? (hasPassed ? (hasFailed ? 'Passed ☑️' : 'Passed ✅') : 'Passed') : 'Passed ❌️'
   const skippedHeader = hasSkipped ? 'Skipped ⚠️' : 'Skipped'
   const failedHeader = hasFailed ? 'Failed ❌️' : 'Failed'