actions/test-reporter
1
0
Fork 0
mirror of https://github.com/dorny/test-reporter.git synced 2025-12-16 06:17:10 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add shortSummary to getReport truncation logic

Browse source
This commit is contained in:
Jon Peterson 2025-09-23 00:22:32 +00:00
parent fe75d329a2
commit d31e490978
No known key found for this signature in database
GPG key ID: 12669C1EC6468FF3
2 changed files with 28 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

11
src/main.ts
View file

@ -175,7 +175,10 @@ class TestReporter {
let baseUrl = '' let baseUrl = ''
if (this.useActionsSummary) { if (this.useActionsSummary) {
const summary = getReport(results, { const summaryPrepend = `# ${shortSummary}\n`
const summary = getReport(
results,
{
listSuites, listSuites,
listTests, listTests,
baseUrl, baseUrl,
@ -183,11 +186,13 @@ class TestReporter {
useActionsSummary, useActionsSummary,
badgeTitle, badgeTitle,
reportTitle reportTitle
}) },
summaryPrepend
)
core.info('Summary content:') core.info('Summary content:')
core.info(summary) core.info(summary)
core.summary.addRaw(`# ${shortSummary}`) core.summary.addRaw(summaryPrepend)
await core.summary.addRaw(summary).write() await core.summary.addRaw(summary).write()
} else { } else {
core.info(`Creating check run ${name}`) core.info(`Creating check run ${name}`)

21
src/report/get-report.ts
View file

@ -6,7 +6,7 @@ import {getFirstNonEmptyLine} from '../utils/parse-utils'
import {slug} from '../utils/slugger' import {slug} from '../utils/slugger'
const MAX_REPORT_LENGTH = 65535 const MAX_REPORT_LENGTH = 65535
const MAX_ACTIONS_SUMMARY_LENGTH = 1048576 export const MAX_ACTIONS_SUMMARY_LENGTH = 1048576
export interface ReportOptions { export interface ReportOptions {
listSuites: 'all' | 'failed' | 'none' listSuites: 'all' | 'failed' | 'none'
@ -28,16 +28,21 @@ export const DEFAULT_OPTIONS: ReportOptions = {
reportTitle: '' reportTitle: ''
} }
export function getReport(results: TestRunResult[], options: ReportOptions = DEFAULT_OPTIONS): string { export function getReport(
results: TestRunResult[],
options: ReportOptions = DEFAULT_OPTIONS,
prependString?: string
): string {
core.info('Generating check run summary') core.info('Generating check run summary')
applySort(results) applySort(results)
const opts = {...options} const opts = {...options}
const prependStringLen = getByteLength(prependString || '')
let lines = renderReport(results, opts) let lines = renderReport(results, opts)
let report = lines.join('\n') let report = lines.join('\n')
if (getByteLength(report) <= getMaxReportLength(options)) { if (getByteLength(report) + prependStringLen <= getMaxReportLength(options)) {
return report return report
} }
@ -46,24 +51,24 @@ export function getReport(results: TestRunResult[], options: ReportOptions = DEF
opts.listTests = 'failed' opts.listTests = 'failed'
lines = renderReport(results, opts) lines = renderReport(results, opts)
report = lines.join('\n') report = lines.join('\n')
if (getByteLength(report) <= getMaxReportLength(options)) { if (getByteLength(report) + prependStringLen <= getMaxReportLength(options)) {
return report return report
} }
} }
core.warning(`Test report summary exceeded limit of ${getMaxReportLength(options)} bytes and will be trimmed`) core.warning(`Test report summary exceeded limit of ${getMaxReportLength(options)} bytes and will be trimmed`)
return trimReport(lines, options) return trimReport(lines, prependStringLen, options)
} }
function getMaxReportLength(options: ReportOptions = DEFAULT_OPTIONS): number { function getMaxReportLength(options: ReportOptions = DEFAULT_OPTIONS): number {
return options.useActionsSummary ? MAX_ACTIONS_SUMMARY_LENGTH : MAX_REPORT_LENGTH return options.useActionsSummary ? MAX_ACTIONS_SUMMARY_LENGTH : MAX_REPORT_LENGTH
} }
function trimReport(lines: string[], options: ReportOptions): string { export function trimReport(lines: string[], prependStringLen: number, options: ReportOptions): string {
const closingBlock = '```' const closingBlock = '```'
const errorMsg = `**Report exceeded GitHub limit of ${getMaxReportLength(options)} bytes and has been trimmed**` const errorMsg = `**Report exceeded GitHub limit of ${getMaxReportLength(options)} bytes and has been trimmed**`
const maxErrorMsgLength = closingBlock.length + errorMsg.length + 2 const maxErrorMsgLength = closingBlock.length + errorMsg.length + 2
const maxReportLength = getMaxReportLength(options) - maxErrorMsgLength const maxReportLength = getMaxReportLength(options) - maxErrorMsgLength - prependStringLen
let reportLength = 0 let reportLength = 0
let codeBlock = false let codeBlock = false
@ -97,7 +102,7 @@ function applySort(results: TestRunResult[]): void {
} }
} }
function getByteLength(text: string): number { export function getByteLength(text: string): number {
return Buffer.byteLength(text, 'utf8') return Buffer.byteLength(text, 'utf8')
} }