mirror of
https://github.com/dorny/test-reporter.git
synced 2025-12-15 22:07:09 +01:00
Add table with reports results if there are more test runs
This commit is contained in:
Michal Dorner
parent
96e91aa726
commit
c75a9dd8c8
7 changed files with 329 additions and 308 deletions
|
|
@ -1,6 +1,6 @@
|
|||
import * as core from '@actions/core'
|
||||
import {TestExecutionResult, TestRunResult, TestSuiteResult} from './test-results'
|
||||
import {Align, Icon, link, table} from '../utils/markdown-utils'
|
||||
import {Align, formatTime, Icon, link, table} from '../utils/markdown-utils'
|
||||
import {slug} from '../utils/slugger'
|
||||
|
||||
export interface ReportOptions {
|
||||
|
|
@ -9,35 +9,20 @@ export interface ReportOptions {
|
|||
}
|
||||
|
||||
export function getReport(results: TestRunResult[], options: ReportOptions = {}): string {
|
||||
core.info('Generating check run summary')
|
||||
|
||||
const maxReportLength = 65535
|
||||
const sections: string[] = []
|
||||
|
||||
applySort(results)
|
||||
|
||||
const badge = getBadge(results)
|
||||
const badge = getReportBadge(results)
|
||||
sections.push(badge)
|
||||
|
||||
const runsSummary = results.map((tr, i) => getRunSummary(tr, i, options)).join('\n\n')
|
||||
sections.push(runsSummary)
|
||||
const runs = getTestRunsReport(results, options)
|
||||
sections.push(...runs)
|
||||
|
||||
if (options.listTests !== 'none') {
|
||||
const suitesSummary = results
|
||||
.map((tr, runIndex) => {
|
||||
const suites = options.listSuites === 'failed' ? tr.failedSuites : tr.suites
|
||||
return suites
|
||||
.map((ts, suiteIndex) => getSuiteSummary(ts, runIndex, suiteIndex, options))
|
||||
.filter(str => str !== '')
|
||||
})
|
||||
.flat()
|
||||
.join('\n')
|
||||
|
||||
if (suitesSummary !== '') {
|
||||
const suitesSection = `# Test Suites\n\n${suitesSummary}`
|
||||
sections.push(suitesSection)
|
||||
}
|
||||
}
|
||||
|
||||
const report = sections.join('\n\n')
|
||||
const report = sections.join('\n')
|
||||
if (report.length > maxReportLength) {
|
||||
let msg = `**Check Run summary limit of ${maxReportLength} chars was exceed**`
|
||||
if (options.listTests !== 'all') {
|
||||
|
|
@ -47,7 +32,7 @@ export function getReport(results: TestRunResult[], options: ReportOptions = {})
|
|||
msg += '\n- Consider setting `list-suites` option to `only-failed`'
|
||||
}
|
||||
|
||||
return `${badge}\n\n${msg}`
|
||||
return `${badge}\n${msg}`
|
||||
}
|
||||
|
||||
return report
|
||||
|
|
@ -60,96 +45,153 @@ function applySort(results: TestRunResult[]): void {
|
|||
}
|
||||
}
|
||||
|
||||
function getBadge(results: TestRunResult[]): string {
|
||||
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)
|
||||
const failed = results.reduce((sum, tr) => sum + tr.failed, 0)
|
||||
return getBadge(passed, failed, skipped)
|
||||
}
|
||||
|
||||
function getBadge(passed: number, failed: number, skipped: number): string {
|
||||
const text = []
|
||||
if (passed > 0) { text.push(`${passed} passed`) }
|
||||
if (failed > 0) { text.push(`${failed} failed`) }
|
||||
if (skipped > 0) { text.push(`${skipped} skipped`) }
|
||||
let message = text.length > 0 ? text.join(', ') : 'none'
|
||||
|
||||
const passedText = passed > 0 ? `${passed} passed` : null
|
||||
const failedText = failed > 0 ? `${failed} failed` : null
|
||||
const skippedText = skipped > 0 ? `${skipped} skipped` : null
|
||||
const message = [passedText, skippedText, failedText].filter(s => s != null).join(', ') || 'none'
|
||||
let color = 'success'
|
||||
if (failed > 0) {
|
||||
color = 'critical'
|
||||
} else if (passed === 0 && failed === 0) {
|
||||
color = 'yellow'
|
||||
}
|
||||
|
||||
const hint = failed > 0 ? 'Tests failed' : 'Tests passed successfully'
|
||||
const uri = encodeURIComponent(`tests-${message}-${color}`)
|
||||
const text = failed > 0 ? 'Tests failed' : 'Tests passed successfully'
|
||||
return ``
|
||||
return ``
|
||||
}
|
||||
|
||||
function getRunSummary(tr: TestRunResult, runIndex: number, options: ReportOptions): string {
|
||||
core.info('Generating check run summary')
|
||||
const time = `${(tr.time / 1000).toFixed(3)}s`
|
||||
const headingLine1 = `### ${tr.path}`
|
||||
const headingLine2 = `**${tr.tests}** tests were completed in **${time}** with **${tr.passed}** passed, **${tr.failed}** failed and **${tr.skipped}** skipped.`
|
||||
function getTestRunsReport(testRuns: TestRunResult[], options: ReportOptions): string[] {
|
||||
const sections: string[] = []
|
||||
|
||||
const suites = options.listSuites === 'failed' ? tr.failedSuites : tr.suites
|
||||
const suitesSummary = suites.map((s, suiteIndex) => {
|
||||
const tsTime = `${Math.round(s.time)}ms`
|
||||
const tsName = s.name
|
||||
const skipLink = options.listTests === 'none' || (options.listTests === 'failed' && s.result !== 'failed')
|
||||
const tsAddr = makeSuiteSlug(runIndex, suiteIndex, tsName).link
|
||||
const tsNameLink = skipLink ? tsName : link(tsName, tsAddr)
|
||||
const passed = s.passed > 0 ? `${s.passed}${Icon.success}` : ''
|
||||
const failed = s.failed > 0 ? `${s.failed}${Icon.fail}` : ''
|
||||
const skipped = s.skipped > 0 ? `${s.skipped}${Icon.skip}` : ''
|
||||
return [tsNameLink, passed, failed, skipped, tsTime]
|
||||
})
|
||||
if (testRuns.length > 1) {
|
||||
const tableData = testRuns.map((tr, runIndex) => {
|
||||
const time = formatTime(tr.time)
|
||||
const name = tr.path
|
||||
const addr = makeRunSlug(runIndex).link
|
||||
const nameLink = link(name, addr)
|
||||
const passed = tr.passed > 0 ? `${tr.passed}${Icon.success}` : ''
|
||||
const failed = tr.failed > 0 ? `${tr.failed}${Icon.fail}` : ''
|
||||
const skipped = tr.skipped > 0 ? `${tr.skipped}${Icon.skip}` : ''
|
||||
return [nameLink, passed, failed, skipped, time]
|
||||
})
|
||||
|
||||
const summary =
|
||||
suites.length === 0
|
||||
? ''
|
||||
: table(
|
||||
['Suite', 'Passed', 'Failed', 'Skipped', 'Time'],
|
||||
[Align.Left, Align.Right, Align.Right, Align.Right, Align.Right],
|
||||
...suitesSummary
|
||||
)
|
||||
|
||||
return [headingLine1, headingLine2, summary].join('\n\n')
|
||||
}
|
||||
|
||||
function getSuiteSummary(ts: TestSuiteResult, runIndex: number, suiteIndex: number, options: ReportOptions): string {
|
||||
const groups = options.listTests === 'failed' ? ts.failedGroups : ts.groups
|
||||
if (groups.length === 0) {
|
||||
return ''
|
||||
const resultsTable = table(
|
||||
['Report', 'Passed', 'Failed', 'Skipped', 'Time'],
|
||||
[Align.Left, Align.Right, Align.Right, Align.Right, Align.Right],
|
||||
...tableData
|
||||
)
|
||||
sections.push(resultsTable)
|
||||
}
|
||||
|
||||
const icon = getResultIcon(ts.result)
|
||||
const content = groups
|
||||
.map(grp => {
|
||||
const tests = options.listTests === 'failed' ? grp.failedTests : grp.tests
|
||||
if (tests.length === 0) {
|
||||
return ''
|
||||
}
|
||||
const header = grp.name ? `### ${grp.name}\n\n` : ''
|
||||
const testsTable = table(
|
||||
['Result', 'Test', 'Time'],
|
||||
[Align.Center, Align.Left, Align.Right],
|
||||
...grp.tests.map(tc => {
|
||||
const name = tc.name
|
||||
const time = `${Math.round(tc.time)}ms`
|
||||
const result = getResultIcon(tc.result)
|
||||
return [result, name, time]
|
||||
})
|
||||
)
|
||||
|
||||
return `${header}${testsTable}\n`
|
||||
})
|
||||
.join('\n')
|
||||
|
||||
const tsName = ts.name
|
||||
const tsSlug = makeSuiteSlug(runIndex, suiteIndex, tsName)
|
||||
const tsNameLink = `<a id="${tsSlug.id}" href="${tsSlug.link}">${tsName}</a>`
|
||||
return `## ${tsNameLink} ${icon}\n\n${content}`
|
||||
const suitesReports = testRuns.map((tr, i) => getSuitesReport(tr, i, options)).flat()
|
||||
sections.push(...suitesReports)
|
||||
return sections
|
||||
}
|
||||
|
||||
function makeSuiteSlug(runIndex: number, suiteIndex: number, name: string): {id: string; link: string} {
|
||||
function getSuitesReport(tr: TestRunResult, runIndex: number, options: ReportOptions): string[] {
|
||||
const sections: string[] = []
|
||||
|
||||
const time = `${(tr.time / 1000).toFixed(3)}s`
|
||||
|
||||
const slug = makeRunSlug(runIndex)
|
||||
const nameLink = `<a id="${slug.id}" href="${slug.link}">${tr.path}</a>`
|
||||
const icon = getResultIcon(tr.result)
|
||||
sections.push(`## ${nameLink} ${icon}`)
|
||||
|
||||
const headingLine2 = `**${tr.tests}** tests were completed in **${time}** with **${tr.passed}** passed, **${tr.failed}** failed and **${tr.skipped}** skipped.`
|
||||
sections.push(headingLine2)
|
||||
|
||||
const suites = options.listSuites === 'failed' ? tr.failedSuites : tr.suites
|
||||
if (suites.length > 0) {
|
||||
const suitesTable = table(
|
||||
['Test suite', 'Passed', 'Failed', 'Skipped', 'Time'],
|
||||
[Align.Left, Align.Right, Align.Right, Align.Right, Align.Right],
|
||||
...suites.map((s, suiteIndex) => {
|
||||
const tsTime = formatTime(s.time)
|
||||
const tsName = s.name
|
||||
const skipLink = options.listTests === 'none' || (options.listTests === 'failed' && s.result !== 'failed')
|
||||
const tsAddr = makeSuiteSlug(runIndex, suiteIndex).link
|
||||
const tsNameLink = skipLink ? tsName : link(tsName, tsAddr)
|
||||
const passed = s.passed > 0 ? `${s.passed}${Icon.success}` : ''
|
||||
const failed = s.failed > 0 ? `${s.failed}${Icon.fail}` : ''
|
||||
const skipped = s.skipped > 0 ? `${s.skipped}${Icon.skip}` : ''
|
||||
return [tsNameLink, passed, failed, skipped, tsTime]
|
||||
})
|
||||
)
|
||||
sections.push(suitesTable)
|
||||
}
|
||||
|
||||
if (options.listTests !== 'none') {
|
||||
const tests = suites
|
||||
.map((ts, suiteIndex) => getTestsReport(ts, runIndex, suiteIndex, options))
|
||||
.flat()
|
||||
|
||||
if (tests.length > 1) {
|
||||
sections.push(...tests)
|
||||
}
|
||||
}
|
||||
|
||||
return sections
|
||||
}
|
||||
|
||||
function getTestsReport(ts: TestSuiteResult, runIndex: number, suiteIndex: number, options: ReportOptions): string[] {
|
||||
const groups = options.listTests === 'failed' ? ts.failedGroups : ts.groups
|
||||
if (groups.length === 0) {
|
||||
return []
|
||||
}
|
||||
|
||||
const sections: string[] = []
|
||||
|
||||
const tsName = ts.name
|
||||
const tsSlug = makeSuiteSlug(runIndex, suiteIndex)
|
||||
const tsNameLink = `<a id="${tsSlug.id}" href="${tsSlug.link}">${tsName}</a>`
|
||||
const icon = getResultIcon(ts.result)
|
||||
sections.push(`### ${tsNameLink} ${icon}`)
|
||||
|
||||
const headingLine2 = `**${ts.tests}** tests were completed in **${ts.time}ms** with **${ts.passed}** passed, **${ts.failed}** failed and **${ts.skipped}** skipped.`
|
||||
sections.push(headingLine2)
|
||||
|
||||
for (const grp of groups) {
|
||||
const tests = options.listTests === 'failed' ? grp.failedTests : grp.tests
|
||||
if (tests.length === 0) {
|
||||
continue
|
||||
}
|
||||
const grpHeader = grp.name ? `\n**${grp.name}**` : ''
|
||||
const testsTable = table(
|
||||
['Result', 'Test', 'Time'],
|
||||
[Align.Center, Align.Left, Align.Right],
|
||||
...grp.tests.map(tc => {
|
||||
const name = tc.name
|
||||
const time = formatTime(tc.time)
|
||||
const result = getResultIcon(tc.result)
|
||||
return [result, name, time]
|
||||
})
|
||||
)
|
||||
|
||||
sections.push(grpHeader, testsTable)
|
||||
}
|
||||
|
||||
return sections
|
||||
}
|
||||
|
||||
function makeRunSlug(runIndex: number): {id: string; link: string} {
|
||||
// use prefix to avoid slug conflicts after escaping the paths
|
||||
return slug(`r${runIndex}s${suiteIndex}-${name}`)
|
||||
return slug(`r${runIndex}`)
|
||||
}
|
||||
|
||||
function makeSuiteSlug(runIndex: number, suiteIndex: number): {id: string; link: string} {
|
||||
// use prefix to avoid slug conflicts after escaping the paths
|
||||
return slug(`r${runIndex}s${suiteIndex}`)
|
||||
}
|
||||
|
||||
function getResultIcon(result: TestExecutionResult): string {
|
||||
|
|
|
|||
|
|
@ -38,3 +38,11 @@ export function ellipsis(text: string, maxLength: number): string {
|
|||
|
||||
return text.substr(0, maxLength - 3) + '...'
|
||||
}
|
||||
|
||||
export function formatTime(ms: number) {
|
||||
if (ms > 1000) {
|
||||
return `${(ms / 1000).toFixed(3)}s`
|
||||
}
|
||||
|
||||
return `${Math.round(ms)}ms`
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue