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

Set listTests and listSuites to lower detail if report is too big

Browse source
This commit is contained in:
Michal Dorner 2021-02-20 22:32:30 +01:00
parent 603e84536d
commit 32f5b23752
No known key found for this signature in database
GPG key ID: 9EEE04B48DA36786
5 changed files with 109 additions and 43 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -4,38 +4,58 @@ import {Align, formatTime, Icon, link, table} from '../utils/markdown-utils'
import {slug} from '../utils/slugger'
export interface ReportOptions {
listSuites?: 'all' | 'failed'
listTests?: 'all' | 'failed' | 'none'
listSuites: 'all' | 'failed'
listTests: 'all' | 'failed' | 'none'
}
export function getReport(results: TestRunResult[], options: ReportOptions = {}): string {
const defaultOptions: ReportOptions = {
listSuites: 'all',
listTests: 'all'
}
export function getReport(results: TestRunResult[], options: ReportOptions = defaultOptions): string {
core.info('Generating check run summary')
const maxReportLength = 65535
const sections: string[] = []
applySort(results)
const badge = getReportBadge(results)
sections.push(badge)
const runs = getTestRunsReport(results, options)
sections.push(...runs)
const report = sections.join('\n')
if (report.length > maxReportLength) {
let msg = `**Check Run summary limit of ${maxReportLength} chars was exceed**`
if (options.listTests !== 'all') {
msg += '\n- Consider setting `list-tests` option to `only-failed` or `none`'
}
if (options.listSuites !== 'all') {
msg += '\n- Consider setting `list-suites` option to `only-failed`'
}
return `${badge}\n${msg}`
const opts = {...options}
let report = renderReport(results, opts)
if (getByteLength(report) <= maxReportLength) {
return report
}
return report
if (opts.listTests === 'all') {
core.info("Test report summary is too big - setting 'listTests' to 'failed'")
opts.listTests = 'failed'
report = renderReport(results, opts)
if (getByteLength(report) <= maxReportLength) {
return report
}
}
if (opts.listSuites === 'all') {
core.info("Test report summary is too big - setting 'listSuites' to 'failed'")
opts.listSuites = 'failed'
report = renderReport(results, opts)
if (getByteLength(report) <= maxReportLength) {
return report
}
}
if (opts.listTests !== 'none') {
core.info("Test report summary is too big - setting 'listTests' to 'none'")
opts.listTests = 'none'
report = renderReport(results, opts)
if (getByteLength(report) <= maxReportLength) {
return report
}
}
core.warning(`Test report summary exceeded limit of ${maxReportLength} bytes`)
const badge = getReportBadge(results)
const msg = `**Test report summary exceeded limit of ${maxReportLength} bytes and was removed**`
return `${badge}\n${msg}`
}
function applySort(results: TestRunResult[]): void {
@ -45,6 +65,21 @@ function applySort(results: TestRunResult[]): void {
}
}
function getByteLength(text: string): number {
return Buffer.byteLength(text, 'utf8')
}
function renderReport(results: TestRunResult[], options: ReportOptions): string {
const sections: string[] = []
const badge = getReportBadge(results)
sections.push(badge)
const runs = getTestRunsReport(results, options)
sections.push(...runs)
return sections.join('\n')
}
function getReportBadge(results: TestRunResult[]): string {
const passed = results.reduce((sum, tr) => sum + tr.passed, 0)
const skipped = results.reduce((sum, tr) => sum + tr.skipped, 0)