actions/test-reporter
1
0
Fork 0
mirror of https://github.com/dorny/test-reporter.git synced 2025-12-15 22:07:09 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add badge title customization

Browse source
This commit is contained in:
Ray Xu 2022-04-23 15:44:12 +00:00 • committed by Zach Renner
parent 83b7f42d2d
commit 49667db475
5 changed files with 26 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

5
src/main.ts
View file

@ -41,6 +41,7 @@ class TestReporter {
readonly failOnError = core.getInput('fail-on-error', {required: true}) === 'true'
readonly workDirInput = core.getInput('working-directory', {required: false})
readonly onlySummary = core.getInput('only-summary', {required: false}) === 'true'
readonly badgeTitle = core.getInput('badge-title', {required: false})
readonly token = core.getInput('token', {required: true})
readonly octokit: InstanceType<typeof GitHub>
readonly context = getCheckRunContext()
@ -166,9 +167,9 @@ class TestReporter {
// })
core.info('Creating report summary')
const {listSuites, listTests, onlySummary} = this
const {listSuites, listTests, onlySummary, badgeTitle} = this
const baseUrl = ''
const summary = getReport(results, {listSuites, listTests, baseUrl, onlySummary})
const summary = getReport(results, {listSuites, listTests, baseUrl, onlySummary, badgeTitle})
core.info('Summary content:')
core.info(summary)
await fs.promises.writeFile(this.path.replace('*.trx', 'test-summary.md'), summary)

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

@ -12,13 +12,15 @@ export interface ReportOptions {
listTests: 'all' | 'failed' | 'none'
baseUrl: string
onlySummary: boolean
badgeTitle: string
}
const defaultOptions: ReportOptions = {
listSuites: 'all',
listTests: 'all',
baseUrl: '',
onlySummary: false
onlySummary: false,
badgeTitle: 'tests'
}
export function getReport(results: TestRunResult[], options: ReportOptions = defaultOptions): string {
@ -92,7 +94,7 @@ function getByteLength(text: string): number {
function renderReport(results: TestRunResult[], options: ReportOptions): string[] {
const sections: string[] = []
const badge = getReportBadge(results)
const badge = getReportBadge(results, options)
sections.push(badge)
const runs = getTestRunsReport(results, options)
@ -101,14 +103,14 @@ function renderReport(results: TestRunResult[], options: ReportOptions): string[
return sections
}
function getReportBadge(results: TestRunResult[]): string {
function getReportBadge(results: TestRunResult[], options: ReportOptions): 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)
return getBadge(passed, failed, skipped, options)
}
function getBadge(passed: number, failed: number, skipped: number): string {
function getBadge(passed: number, failed: number, skipped: number, options: ReportOptions): string {
const text = []
if (passed > 0) {
text.push(`${passed} passed`)
@ -128,7 +130,7 @@ function getBadge(passed: number, failed: number, skipped: number): string {
color = 'yellow'
}
const hint = failed > 0 ? 'Tests failed' : 'Tests passed successfully'
const uri = encodeURIComponent(`tests-${message}-${color}`)
const uri = encodeURIComponent(`${options.badgeTitle}-${message}-${color}`)
return `![${hint}](https://img.shields.io/badge/${uri})`
}