Merge pull request #645 from micmarc/fix/report-title-short-summary

Merge pull request #679 from dorny/release/v2.2.0

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 2.2.0
+* Feature: Add collapsed option to control report summary visibility https://github.com/dorny/test-reporter/pull/664
+* Fix badge encoding for values including underscore and hyphens https://github.com/dorny/test-reporter/pull/672
+* Fix missing `report-title` attribute in action definition https://github.com/dorny/test-reporter/pull/637
+* Refactor variable names to fix shadowing issues https://github.com/dorny/test-reporter/pull/630
+
 ## 2.1.1
 * Fix error when a TestMethod element does not have a className attribute in a trx file https://github.com/dorny/test-reporter/pull/623
 * Add stack trace from trx to summary https://github.com/dorny/test-reporter/pull/615

__tests__/jest-junit.test.ts

@@ -303,4 +303,47 @@ describe('jest-junit tests', () => {
     expect(report).not.toContain('<details><summary>Expand for details</summary>')
     expect(report).not.toContain('</details>')
   })
+
+  it('report includes the short summary', async () => {
+    const fixturePath = path.join(__dirname, 'fixtures', 'jest-junit.xml')
+    const filePath = normalizeFilePath(path.relative(__dirname, fixturePath))
+    const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'})
+
+    const opts: ParseOptions = {
+      parseErrors: true,
+      trackedFiles: []
+    }
+
+    const parser = new JestJunitParser(opts)
+    const result = await parser.parse(filePath, fileContent)
+    const shortSummary = '1 passed, 4 failed and 1 skipped'
+    const report = getReport([result], DEFAULT_OPTIONS, shortSummary)
+    // Report should have the title as the first line
+    expect(report).toMatch(/^## 1 passed, 4 failed and 1 skipped\n/)
+  })
+
+  it('report includes a custom report title and short summary', async () => {
+    const fixturePath = path.join(__dirname, 'fixtures', 'jest-junit.xml')
+    const filePath = normalizeFilePath(path.relative(__dirname, fixturePath))
+    const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'})
+
+    const opts: ParseOptions = {
+      parseErrors: true,
+      trackedFiles: []
+    }
+
+    const parser = new JestJunitParser(opts)
+    const result = await parser.parse(filePath, fileContent)
+    const shortSummary = '1 passed, 4 failed and 1 skipped'
+    const report = getReport(
+      [result],
+      {
+        ...DEFAULT_OPTIONS,
+        reportTitle: 'My Custom Title'
+      },
+      shortSummary
+    )
+    // Report should have the title as the first line
+    expect(report).toMatch(/^# My Custom Title\n## 1 passed, 4 failed and 1 skipped\n/)
+  })
 })

dist/index.js

@@ -422,10 +422,9 @@ class TestReporter {
                 badgeTitle,
                 reportTitle,
                 collapsed
-            });
+            }, shortSummary);
             core.info('Summary content:');
             core.info(summary);
-            core.summary.addRaw(`# ${shortSummary}`);
             await core.summary.addRaw(summary).write();
         }
         else {
@@ -1934,11 +1933,10 @@ exports.DEFAULT_OPTIONS = {
     reportTitle: '',
     collapsed: 'auto'
 };
-function getReport(results, options = exports.DEFAULT_OPTIONS) {
-    core.info('Generating check run summary');
+function getReport(results, options = exports.DEFAULT_OPTIONS, shortSummary = '') {
     applySort(results);
     const opts = { ...options };
-    let lines = renderReport(results, opts);
+    let lines = renderReport(results, opts, shortSummary);
     let report = lines.join('\n');
     if (getByteLength(report) <= getMaxReportLength(options)) {
         return report;
@@ -1946,7 +1944,7 @@ function getReport(results, options = exports.DEFAULT_OPTIONS) {
     if (opts.listTests === 'all') {
         core.info("Test report summary is too big - setting 'listTests' to 'failed'");
         opts.listTests = 'failed';
-        lines = renderReport(results, opts);
+        lines = renderReport(results, opts, shortSummary);
         report = lines.join('\n');
         if (getByteLength(report) <= getMaxReportLength(options)) {
             return report;
@@ -1993,12 +1991,15 @@ function applySort(results) {
 function getByteLength(text) {
     return Buffer.byteLength(text, 'utf8');
 }
-function renderReport(results, options) {
+function renderReport(results, options, shortSummary) {
     const sections = [];
     const reportTitle = options.reportTitle.trim();
     if (reportTitle) {
         sections.push(`# ${reportTitle}`);
     }
+    if (shortSummary) {
+        sections.push(`## ${shortSummary}`);
+    }
     const badge = getReportBadge(results, options);
     sections.push(badge);
     const runs = getTestRunsReport(results, options);

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "test-reporter",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "test-reporter",
-      "version": "2.1.1",
+      "version": "2.2.0",
       "license": "MIT",
       "dependencies": {
         "@actions/core": "^1.11.1",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "test-reporter",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "private": true,
   "description": "Presents test results from popular testing frameworks as Github check run",
   "main": "lib/main.js",

src/main.ts

@@ -181,20 +181,23 @@ class TestReporter {
 
     let baseUrl = ''
     if (this.useActionsSummary) {
-      const summary = getReport(results, {
-        listSuites,
-        listTests,
-        baseUrl,
-        onlySummary,
-        useActionsSummary,
-        badgeTitle,
-        reportTitle,
-        collapsed
-      })
+      const summary = getReport(
+        results,
+        {
+          listSuites,
+          listTests,
+          baseUrl,
+          onlySummary,
+          useActionsSummary,
+          badgeTitle,
+          reportTitle,
+          collapsed
+        },
+        shortSummary
+      )
 
       core.info('Summary content:')
       core.info(summary)
-      core.summary.addRaw(`# ${shortSummary}`)
       await core.summary.addRaw(summary).write()
     } else {
       core.info(`Creating check run ${name}`)

src/report/get-report.ts

@@ -30,13 +30,15 @@ export const DEFAULT_OPTIONS: ReportOptions = {
   collapsed: 'auto'
 }
 
-export function getReport(results: TestRunResult[], options: ReportOptions = DEFAULT_OPTIONS): string {
-  core.info('Generating check run summary')
-
+export function getReport(
+  results: TestRunResult[],
+  options: ReportOptions = DEFAULT_OPTIONS,
+  shortSummary = ''
+): string {
   applySort(results)
 
   const opts = {...options}
-  let lines = renderReport(results, opts)
+  let lines = renderReport(results, opts, shortSummary)
   let report = lines.join('\n')
 
   if (getByteLength(report) <= getMaxReportLength(options)) {
@@ -46,7 +48,7 @@ export function getReport(results: TestRunResult[], options: ReportOptions = DEF
   if (opts.listTests === 'all') {
     core.info("Test report summary is too big - setting 'listTests' to 'failed'")
     opts.listTests = 'failed'
-    lines = renderReport(results, opts)
+    lines = renderReport(results, opts, shortSummary)
     report = lines.join('\n')
     if (getByteLength(report) <= getMaxReportLength(options)) {
       return report
@@ -103,7 +105,7 @@ function getByteLength(text: string): number {
   return Buffer.byteLength(text, 'utf8')
 }
 
-function renderReport(results: TestRunResult[], options: ReportOptions): string[] {
+function renderReport(results: TestRunResult[], options: ReportOptions, shortSummary: string): string[] {
   const sections: string[] = []
 
   const reportTitle: string = options.reportTitle.trim()
@@ -111,6 +113,10 @@ function renderReport(results: TestRunResult[], options: ReportOptions): string[
     sections.push(`# ${reportTitle}`)
   }
 
+  if (shortSummary) {
+    sections.push(`## ${shortSummary}`)
+  }
+
   const badge = getReportBadge(results, options)
   sections.push(badge)