Merge pull request #1298 from mikepenz/feature/ungrouped_report

Add ability to ungroup tests by their report files

Author: mikepenz

.github/workflows/build.yml

@@ -57,6 +57,17 @@ jobs:
           comment: true
           annotate_only: ${{ github.event_name == 'workflow_dispatch' }}
 
+      - name: Test Ungrouped test import
+        uses: ./
+        with:
+          check_name: Example Ungrouped Test Report
+          report_paths: test_results/multiple/*.xml
+          verbose_summary: false
+          include_passed: true
+          detailed_summary: false
+          group_reports: false
+          comment: true
+
       - name: Test JUnit flaky test import
         uses: ./
         with:

README.md

@@ -76,6 +76,7 @@ jobs:
 |----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `report_paths`             | Optional. [Glob](https://github.com/actions/toolkit/tree/master/packages/glob) expression to junit report paths. Defaults to: `**/junit-reports/TEST-*.xml`.                                        |
 | `token`                    | Optional. GitHub token for creating a check run. Set to `${{ github.token }}` by default.                                                                                                           |
+| `group_reports`            | Optional. Defines if different reports found by a single `report_paths` glob expression are grouped together. Defaults to `true`.                                                                   |
 | `test_files_prefix`        | Optional. Prepends the provided prefix to test file paths within the report when annotating on GitHub.                                                                                              |
 | `exclude_sources`          | Optional. Provide `,` seperated array of folders to ignore for source lookup. Defaults to: `/build/,/__pycache__/`                                                                                  |
 | `check_name`               | Optional. Check name to use when creating a check run. The default is `JUnit Test Report`.                                                                                                          |

action.yml

@@ -15,6 +15,10 @@ inputs:
     description: 'Xml report paths in glob format'
     required: false
     default: '**/junit-reports/TEST-*.xml'
+  group_reports:
+    description: 'Defines if reports are grouped into a combined test result. This '
+    required: false
+    default: 'true'
   test_files_prefix:
     description: 'Prefix to add to test file paths from report files when annotating'
     required: false

dist/index.js

@@ -17,6 +17,7 @@ export async function run(): Promise<void> {
       return
     }
 
+    const groupReports = core.getInput('group_reports') === 'true'
     const annotateOnly = core.getInput('annotate_only') === 'true'
     const updateCheck = core.getInput('update_check') === 'true'
     const checkAnnotations = core.getInput('check_annotations') === 'true'
@@ -103,7 +104,25 @@ export async function run(): Promise<void> {
       mergedResult.failed += testResult.failed
       mergedResult.passed += testResult.passed
       mergedResult.retried += testResult.retried
-      testResults.push(testResult)
+
+      if (groupReports) {
+        testResults.push(testResult)
+      } else {
+        for (const actualTestResult of testResult.testResults) {
+          testResults.push({
+            checkName: `${testResult.checkName} | ${actualTestResult.name}`,
+            summary: testResult.summary,
+            totalCount: actualTestResult.totalCount,
+            skipped: actualTestResult.skippedCount,
+            failed: actualTestResult.failedCount,
+            passed: actualTestResult.passedCount,
+            retried: actualTestResult.retriedCount,
+            foundFiles: 1,
+            globalAnnotations: actualTestResult.annotations,
+            testResults: actualTestResult.testResults
+          })
+        }
+      }
     }
 
     core.setOutput('total', mergedResult.totalCount)

dist/index.js.map

@@ -9,6 +9,8 @@ export interface ActualTestResult {
   name: string
   totalCount: number
   skippedCount: number
+  failedCount: number
+  passedCount: number
   retriedCount: number
   annotations: Annotation[]
   globalAnnotations: Annotation[]
@@ -18,6 +20,8 @@ export interface ActualTestResult {
 interface TestCasesResult {
   totalCount: number
   skippedCount: number
+  failedCount: number
+  passedCount: number
   retriedCount: number
   annotations: Annotation[]
 }
@@ -222,7 +226,7 @@ export async function parseFile(
     return undefined
   }
 
-  return await parseSuite(
+  const testResult = await parseSuite(
     testsuite,
     suiteRegex, // no-op
     '',
@@ -240,6 +244,12 @@ export async function parseFile(
     globalAnnotations,
     resolveIgnoreClassname
   )
+
+  if (testResult !== undefined && !testResult.name) {
+    testResult.name = pathHelper.basename(file)
+  }
+
+  return testResult
 }
 
 function templateVar(varName: string): string {
@@ -277,6 +287,8 @@ async function parseSuite(
 
   let totalCount = 0
   let skippedCount = 0
+  let failedCount = 0
+  let passedCount = 0
   let retriedCount = 0
   const annotations: Annotation[] = []
 
@@ -308,6 +320,8 @@ async function parseSuite(
     // expand global annotations array
     totalCount += parsedTestCases.totalCount
     skippedCount += parsedTestCases.skippedCount
+    failedCount += parsedTestCases.failedCount
+    passedCount += parsedTestCases.passedCount
     retriedCount += parsedTestCases.retriedCount
     annotations.push(...parsedTestCases.annotations)
     globalAnnotations.push(...parsedTestCases.annotations)
@@ -318,6 +332,8 @@ async function parseSuite(
       name: suiteName,
       totalCount,
       skippedCount,
+      failedCount,
+      passedCount,
       retriedCount,
       annotations,
       globalAnnotations,
@@ -360,6 +376,8 @@ async function parseSuite(
       childSuiteResults.push(childSuiteResult)
       totalCount += childSuiteResult.totalCount
       skippedCount += childSuiteResult.skippedCount
+      failedCount += childSuiteResult.failedCount
+      passedCount += childSuiteResult.passedCount
       retriedCount += childSuiteResult.retriedCount
     }
 
@@ -369,6 +387,8 @@ async function parseSuite(
         name: suiteName,
         totalCount,
         skippedCount,
+        failedCount,
+        passedCount,
         retriedCount,
         annotations,
         globalAnnotations,
@@ -381,6 +401,8 @@ async function parseSuite(
     name: suiteName,
     totalCount,
     skippedCount,
+    failedCount,
+    passedCount,
     retriedCount,
     annotations,
     globalAnnotations,
@@ -576,9 +598,13 @@ async function parseTestCases(
     if (limit >= 0 && annotations.length >= limit) break
   }
 
+  const failedCount = annotations.filter(a => a.annotation_level === 'failure').length
+  const passedCount = totalCount - failedCount - skippedCount
   return {
     totalCount,
     skippedCount,
+    failedCount,
+    passedCount,
     retriedCount,
     annotations
   }
@@ -616,6 +642,8 @@ export async function parseTestReports(
   const testResults: ActualTestResult[] = []
   let totalCount = 0
   let skipped = 0
+  let failed = 0
+  let passed = 0
   let retried = 0
   let foundFiles = 0
   for await (const file of globber.globGenerator()) {
@@ -642,9 +670,11 @@ export async function parseTestReports(
     )
 
     if (!testResult) continue
-    const {totalCount: c, skippedCount: s, retriedCount: r} = testResult
+    const {totalCount: c, skippedCount: s, failedCount: f, passedCount: p, retriedCount: r} = testResult
     totalCount += c
     skipped += s
+    failed += f
+    passed += p
     retried += r
     testResults.push(testResult)
 
@@ -653,10 +683,6 @@ export async function parseTestReports(
     }
   }
 
-  // get the count of passed and failed tests.
-  const failed = globalAnnotations.filter(a => a.annotation_level === 'failure').length
-  const passed = totalCount - failed - skipped
-
   return {
     checkName,
     summary,

src/main.ts

@@ -0,0 +1,7 @@
+<testsuites failures="0" tests="8" time="1967986371">
+    <testsuite>
+        <testcase name="Command Test: apt-get upgrade" time="999638317"></testcase>
+        <testcase name="File Existence Test: /home/app/app" time="0"></testcase>
+        <testcase name="Metadata Test" time="0"></testcase>
+    </testsuite>
+</testsuites>

src/testParser.ts

@@ -0,0 +1,9 @@
+<testsuites failures="0" tests="8" time="1967986371">
+    <testsuite>
+        <testcase name="Command Test: apt-get upgrade" time="999638317"></testcase>
+        <testcase name="File Existence Test: /home/app/app" time="0"></testcase>
+        <testcase name="Metadata Test" time="0">
+            <failure message="AssertionError: assert">SackTrace</failure>
+        </testcase>
+    </testsuite>
+</testsuites>

test_results/multiple/test_10.xml

@@ -0,0 +1,9 @@
+<testsuites failures="0" tests="8" time="1967986371">
+    <testsuite>
+        <testcase name="Command Test: apt-get upgrade" time="999638317"></testcase>
+        <testcase name="File Existence Test: /home/app/app" time="0">
+            <skipped></skipped>
+        </testcase>
+        <testcase name="Metadata Test" time="0"></testcase>
+    </testsuite>
+</testsuites>