mirror of
https://github.com/dorny/test-reporter.git
synced 2026-02-03 11:45:22 -08:00
Compare commits
4 Commits
v2.2.0
...
feature/60
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4344e43b30 | ||
|
|
8a2a2093e5 | ||
|
|
4277f239de | ||
|
|
aaa58cbe8b |
@@ -1,4 +0,0 @@
|
|||||||
dist/
|
|
||||||
lib/
|
|
||||||
node_modules/
|
|
||||||
jest.config.js
|
|
||||||
4
.github/workflows/check-dist.yml
vendored
4
.github/workflows/check-dist.yml
vendored
@@ -24,7 +24,7 @@ jobs:
|
|||||||
- uses: actions/checkout@v5
|
- uses: actions/checkout@v5
|
||||||
|
|
||||||
- name: Set Node.js
|
- name: Set Node.js
|
||||||
uses: actions/setup-node@v6
|
uses: actions/setup-node@v5
|
||||||
with:
|
with:
|
||||||
node-version-file: '.nvmrc'
|
node-version-file: '.nvmrc'
|
||||||
|
|
||||||
@@ -46,7 +46,7 @@ jobs:
|
|||||||
id: diff
|
id: diff
|
||||||
|
|
||||||
# If index.js was different than expected, upload the expected version as an artifact
|
# If index.js was different than expected, upload the expected version as an artifact
|
||||||
- uses: actions/upload-artifact@v5
|
- uses: actions/upload-artifact@v4
|
||||||
if: ${{ failure() && steps.diff.conclusion == 'failure' }}
|
if: ${{ failure() && steps.diff.conclusion == 'failure' }}
|
||||||
with:
|
with:
|
||||||
name: dist
|
name: dist
|
||||||
|
|||||||
4
.github/workflows/ci.yml
vendored
4
.github/workflows/ci.yml
vendored
@@ -14,7 +14,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v5
|
- uses: actions/checkout@v5
|
||||||
- uses: actions/setup-node@v6
|
- uses: actions/setup-node@v5
|
||||||
with:
|
with:
|
||||||
node-version-file: '.nvmrc'
|
node-version-file: '.nvmrc'
|
||||||
- run: npm ci
|
- run: npm ci
|
||||||
@@ -25,7 +25,7 @@ jobs:
|
|||||||
|
|
||||||
- name: Upload test results
|
- name: Upload test results
|
||||||
if: ${{ !cancelled() }}
|
if: ${{ !cancelled() }}
|
||||||
uses: actions/upload-artifact@v5
|
uses: actions/upload-artifact@v4
|
||||||
with:
|
with:
|
||||||
name: test-results
|
name: test-results
|
||||||
path: __tests__/__results__/*.xml
|
path: __tests__/__results__/*.xml
|
||||||
|
|||||||
@@ -1,11 +1,5 @@
|
|||||||
# Changelog
|
# 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
|
## 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
|
* 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
|
* Add stack trace from trx to summary https://github.com/dorny/test-reporter/pull/615
|
||||||
|
|||||||
@@ -207,100 +207,4 @@ describe('jest-junit tests', () => {
|
|||||||
// Report should have the title as the first line
|
// Report should have the title as the first line
|
||||||
expect(report).toMatch(/^# My Custom Title\n/)
|
expect(report).toMatch(/^# My Custom Title\n/)
|
||||||
})
|
})
|
||||||
|
|
||||||
it('report can be collapsed when configured', 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 report = getReport([result], {
|
|
||||||
...DEFAULT_OPTIONS,
|
|
||||||
collapsed: 'always'
|
|
||||||
})
|
|
||||||
// Report should include collapsible details
|
|
||||||
expect(report).toContain('<details><summary>Expand for details</summary>')
|
|
||||||
expect(report).toContain('</details>')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('report is not collapsed when configured to never', 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 report = getReport([result], {
|
|
||||||
...DEFAULT_OPTIONS,
|
|
||||||
collapsed: 'never'
|
|
||||||
})
|
|
||||||
// Report should not include collapsible details
|
|
||||||
expect(report).not.toContain('<details><summary>Expand for details</summary>')
|
|
||||||
expect(report).not.toContain('</details>')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('report auto-collapses when all tests pass', async () => {
|
|
||||||
// Test with a fixture that has all passing tests (no failures)
|
|
||||||
const fixturePath = path.join(__dirname, 'fixtures', 'jest-junit-eslint.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)
|
|
||||||
|
|
||||||
// Verify this fixture has no failures
|
|
||||||
expect(result.failed).toBe(0)
|
|
||||||
|
|
||||||
const report = getReport([result], {
|
|
||||||
...DEFAULT_OPTIONS,
|
|
||||||
collapsed: 'auto'
|
|
||||||
})
|
|
||||||
|
|
||||||
// Should collapse when all tests pass
|
|
||||||
expect(report).toContain('<details><summary>Expand for details</summary>')
|
|
||||||
expect(report).toContain('</details>')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('report does not auto-collapse when tests fail', async () => {
|
|
||||||
// Test with a fixture that has failing tests
|
|
||||||
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)
|
|
||||||
|
|
||||||
// Verify this fixture has failures
|
|
||||||
expect(result.failed).toBeGreaterThan(0)
|
|
||||||
|
|
||||||
const report = getReport([result], {
|
|
||||||
...DEFAULT_OPTIONS,
|
|
||||||
collapsed: 'auto'
|
|
||||||
})
|
|
||||||
|
|
||||||
// Should not collapse when there are failures
|
|
||||||
expect(report).not.toContain('<details><summary>Expand for details</summary>')
|
|
||||||
expect(report).not.toContain('</details>')
|
|
||||||
})
|
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -1,120 +0,0 @@
|
|||||||
import {getBadge, DEFAULT_OPTIONS, ReportOptions} from '../../src/report/get-report'
|
|
||||||
|
|
||||||
describe('getBadge', () => {
|
|
||||||
describe('URI encoding with special characters', () => {
|
|
||||||
it('generates correct URI with simple badge title', () => {
|
|
||||||
const options: ReportOptions = {
|
|
||||||
...DEFAULT_OPTIONS,
|
|
||||||
badgeTitle: 'tests'
|
|
||||||
}
|
|
||||||
const badge = getBadge(5, 0, 1, options)
|
|
||||||
expect(badge).toBe('')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('handles badge title with single hyphen', () => {
|
|
||||||
const options: ReportOptions = {
|
|
||||||
...DEFAULT_OPTIONS,
|
|
||||||
badgeTitle: 'unit-tests'
|
|
||||||
}
|
|
||||||
const badge = getBadge(3, 0, 0, options)
|
|
||||||
// The hyphen in the badge title should be encoded as --
|
|
||||||
expect(badge).toBe('')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('handles badge title with multiple hyphens', () => {
|
|
||||||
const options: ReportOptions = {
|
|
||||||
...DEFAULT_OPTIONS,
|
|
||||||
badgeTitle: 'integration-api-tests'
|
|
||||||
}
|
|
||||||
const badge = getBadge(10, 0, 0, options)
|
|
||||||
// All hyphens in the title should be encoded as --
|
|
||||||
expect(badge).toBe('')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('handles badge title with multiple underscores', () => {
|
|
||||||
const options: ReportOptions = {
|
|
||||||
...DEFAULT_OPTIONS,
|
|
||||||
badgeTitle: 'my_integration_test'
|
|
||||||
}
|
|
||||||
const badge = getBadge(10, 0, 0, options)
|
|
||||||
// All underscores in the title should be encoded as __
|
|
||||||
expect(badge).toBe('')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('handles badge title with version format containing hyphen', () => {
|
|
||||||
const options: ReportOptions = {
|
|
||||||
...DEFAULT_OPTIONS,
|
|
||||||
badgeTitle: 'MariaDb 12.0-ubi database tests'
|
|
||||||
}
|
|
||||||
const badge = getBadge(1, 0, 0, options)
|
|
||||||
// The hyphen in "12.0-ubi" should be encoded as --
|
|
||||||
expect(badge).toBe('')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('handles badge title with dots and hyphens', () => {
|
|
||||||
const options: ReportOptions = {
|
|
||||||
...DEFAULT_OPTIONS,
|
|
||||||
badgeTitle: 'v1.2.3-beta-test'
|
|
||||||
}
|
|
||||||
const badge = getBadge(4, 1, 0, options)
|
|
||||||
expect(badge).toBe('')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('preserves structural hyphens between label and message', () => {
|
|
||||||
const options: ReportOptions = {
|
|
||||||
...DEFAULT_OPTIONS,
|
|
||||||
badgeTitle: 'test-suite'
|
|
||||||
}
|
|
||||||
const badge = getBadge(2, 3, 1, options)
|
|
||||||
// The URI should have literal hyphens separating title-message-color
|
|
||||||
expect(badge).toBe('')
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('generates test outcome as color name for imgshields', () => {
|
|
||||||
it('uses success color when all tests pass', () => {
|
|
||||||
const options: ReportOptions = {...DEFAULT_OPTIONS}
|
|
||||||
const badge = getBadge(5, 0, 0, options)
|
|
||||||
expect(badge).toContain('-success)')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('uses critical color when tests fail', () => {
|
|
||||||
const options: ReportOptions = {...DEFAULT_OPTIONS}
|
|
||||||
const badge = getBadge(5, 2, 0, options)
|
|
||||||
expect(badge).toContain('-critical)')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('uses yellow color when no tests found', () => {
|
|
||||||
const options: ReportOptions = {...DEFAULT_OPTIONS}
|
|
||||||
const badge = getBadge(0, 0, 0, options)
|
|
||||||
expect(badge).toContain('-yellow)')
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('badge message composition', () => {
|
|
||||||
it('includes only passed count when no failures or skips', () => {
|
|
||||||
const options: ReportOptions = {...DEFAULT_OPTIONS}
|
|
||||||
const badge = getBadge(5, 0, 0, options)
|
|
||||||
expect(badge).toBe('')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('includes passed and failed counts', () => {
|
|
||||||
const options: ReportOptions = {...DEFAULT_OPTIONS}
|
|
||||||
const badge = getBadge(5, 2, 0, options)
|
|
||||||
expect(badge).toBe('')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('includes passed, failed and skipped counts', () => {
|
|
||||||
const options: ReportOptions = {...DEFAULT_OPTIONS}
|
|
||||||
const badge = getBadge(5, 2, 1, options)
|
|
||||||
expect(badge).toBe('')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('uses "none" message when no tests', () => {
|
|
||||||
const options: ReportOptions = {...DEFAULT_OPTIONS}
|
|
||||||
const badge = getBadge(0, 0, 0, options)
|
|
||||||
expect(badge).toBe('')
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
@@ -89,14 +89,6 @@ inputs:
|
|||||||
description: Customize badge title
|
description: Customize badge title
|
||||||
required: false
|
required: false
|
||||||
default: 'tests'
|
default: 'tests'
|
||||||
collapsed:
|
|
||||||
description: |
|
|
||||||
Controls whether test report details are collapsed or expanded. Supported options:
|
|
||||||
- auto: Collapse only if all tests pass (default behavior)
|
|
||||||
- always: Always collapse the report details
|
|
||||||
- never: Always expand the report details
|
|
||||||
required: false
|
|
||||||
default: 'auto'
|
|
||||||
token:
|
token:
|
||||||
description: GitHub Access Token
|
description: GitHub Access Token
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
32
dist/index.js
generated
vendored
32
dist/index.js
generated
vendored
@@ -309,7 +309,6 @@ class TestReporter {
|
|||||||
useActionsSummary = core.getInput('use-actions-summary', { required: false }) === 'true';
|
useActionsSummary = core.getInput('use-actions-summary', { required: false }) === 'true';
|
||||||
badgeTitle = core.getInput('badge-title', { required: false });
|
badgeTitle = core.getInput('badge-title', { required: false });
|
||||||
reportTitle = core.getInput('report-title', { required: false });
|
reportTitle = core.getInput('report-title', { required: false });
|
||||||
collapsed = core.getInput('collapsed', { required: false });
|
|
||||||
token = core.getInput('token', { required: true });
|
token = core.getInput('token', { required: true });
|
||||||
octokit;
|
octokit;
|
||||||
context = (0, github_utils_1.getCheckRunContext)();
|
context = (0, github_utils_1.getCheckRunContext)();
|
||||||
@@ -323,10 +322,6 @@ class TestReporter {
|
|||||||
core.setFailed(`Input parameter 'list-tests' has invalid value`);
|
core.setFailed(`Input parameter 'list-tests' has invalid value`);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
if (this.collapsed !== 'auto' && this.collapsed !== 'always' && this.collapsed !== 'never') {
|
|
||||||
core.setFailed(`Input parameter 'collapsed' has invalid value`);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (isNaN(this.maxAnnotations) || this.maxAnnotations < 0 || this.maxAnnotations > 50) {
|
if (isNaN(this.maxAnnotations) || this.maxAnnotations < 0 || this.maxAnnotations > 50) {
|
||||||
core.setFailed(`Input parameter 'max-annotations' has invalid value`);
|
core.setFailed(`Input parameter 'max-annotations' has invalid value`);
|
||||||
return;
|
return;
|
||||||
@@ -406,7 +401,7 @@ class TestReporter {
|
|||||||
throw error;
|
throw error;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
const { listSuites, listTests, onlySummary, useActionsSummary, badgeTitle, reportTitle, collapsed } = this;
|
const { listSuites, listTests, onlySummary, useActionsSummary, badgeTitle, reportTitle } = this;
|
||||||
const passed = results.reduce((sum, tr) => sum + tr.passed, 0);
|
const passed = results.reduce((sum, tr) => sum + tr.passed, 0);
|
||||||
const failed = results.reduce((sum, tr) => sum + tr.failed, 0);
|
const failed = results.reduce((sum, tr) => sum + tr.failed, 0);
|
||||||
const skipped = results.reduce((sum, tr) => sum + tr.skipped, 0);
|
const skipped = results.reduce((sum, tr) => sum + tr.skipped, 0);
|
||||||
@@ -420,8 +415,7 @@ class TestReporter {
|
|||||||
onlySummary,
|
onlySummary,
|
||||||
useActionsSummary,
|
useActionsSummary,
|
||||||
badgeTitle,
|
badgeTitle,
|
||||||
reportTitle,
|
reportTitle
|
||||||
collapsed
|
|
||||||
});
|
});
|
||||||
core.info('Summary content:');
|
core.info('Summary content:');
|
||||||
core.info(summary);
|
core.info(summary);
|
||||||
@@ -449,8 +443,7 @@ class TestReporter {
|
|||||||
onlySummary,
|
onlySummary,
|
||||||
useActionsSummary,
|
useActionsSummary,
|
||||||
badgeTitle,
|
badgeTitle,
|
||||||
reportTitle,
|
reportTitle
|
||||||
collapsed
|
|
||||||
});
|
});
|
||||||
core.info('Creating annotations');
|
core.info('Creating annotations');
|
||||||
const annotations = (0, get_annotations_1.getAnnotations)(results, this.maxAnnotations);
|
const annotations = (0, get_annotations_1.getAnnotations)(results, this.maxAnnotations);
|
||||||
@@ -1916,7 +1909,6 @@ var __importStar = (this && this.__importStar) || (function () {
|
|||||||
Object.defineProperty(exports, "__esModule", ({ value: true }));
|
Object.defineProperty(exports, "__esModule", ({ value: true }));
|
||||||
exports.DEFAULT_OPTIONS = void 0;
|
exports.DEFAULT_OPTIONS = void 0;
|
||||||
exports.getReport = getReport;
|
exports.getReport = getReport;
|
||||||
exports.getBadge = getBadge;
|
|
||||||
const core = __importStar(__nccwpck_require__(7484));
|
const core = __importStar(__nccwpck_require__(7484));
|
||||||
const markdown_utils_1 = __nccwpck_require__(5129);
|
const markdown_utils_1 = __nccwpck_require__(5129);
|
||||||
const node_utils_1 = __nccwpck_require__(5384);
|
const node_utils_1 = __nccwpck_require__(5384);
|
||||||
@@ -1931,8 +1923,7 @@ exports.DEFAULT_OPTIONS = {
|
|||||||
onlySummary: false,
|
onlySummary: false,
|
||||||
useActionsSummary: true,
|
useActionsSummary: true,
|
||||||
badgeTitle: 'tests',
|
badgeTitle: 'tests',
|
||||||
reportTitle: '',
|
reportTitle: ''
|
||||||
collapsed: 'auto'
|
|
||||||
};
|
};
|
||||||
function getReport(results, options = exports.DEFAULT_OPTIONS) {
|
function getReport(results, options = exports.DEFAULT_OPTIONS) {
|
||||||
core.info('Generating check run summary');
|
core.info('Generating check run summary');
|
||||||
@@ -2031,17 +2022,13 @@ function getBadge(passed, failed, skipped, options) {
|
|||||||
color = 'yellow';
|
color = 'yellow';
|
||||||
}
|
}
|
||||||
const hint = failed > 0 ? 'Tests failed' : 'Tests passed successfully';
|
const hint = failed > 0 ? 'Tests failed' : 'Tests passed successfully';
|
||||||
const encodedBadgeTitle = encodeImgShieldsURIComponent(options.badgeTitle);
|
const uri = encodeURIComponent(`${options.badgeTitle}-${message}-${color}`);
|
||||||
const encodedMessage = encodeImgShieldsURIComponent(message);
|
return ``;
|
||||||
const encodedColor = encodeImgShieldsURIComponent(color);
|
|
||||||
return ``;
|
|
||||||
}
|
}
|
||||||
function getTestRunsReport(testRuns, options) {
|
function getTestRunsReport(testRuns, options) {
|
||||||
const sections = [];
|
const sections = [];
|
||||||
const totalFailed = testRuns.reduce((sum, tr) => sum + tr.failed, 0);
|
const totalFailed = testRuns.reduce((sum, tr) => sum + tr.failed, 0);
|
||||||
// Determine if report should be collapsed based on collapsed option
|
if (totalFailed === 0) {
|
||||||
const shouldCollapse = options.collapsed === 'always' || (options.collapsed === 'auto' && totalFailed === 0);
|
|
||||||
if (shouldCollapse) {
|
|
||||||
sections.push(`<details><summary>Expand for details</summary>`);
|
sections.push(`<details><summary>Expand for details</summary>`);
|
||||||
sections.push(` `);
|
sections.push(` `);
|
||||||
}
|
}
|
||||||
@@ -2066,7 +2053,7 @@ function getTestRunsReport(testRuns, options) {
|
|||||||
const suitesReports = testRuns.map((tr, i) => getSuitesReport(tr, i, options)).flat();
|
const suitesReports = testRuns.map((tr, i) => getSuitesReport(tr, i, options)).flat();
|
||||||
sections.push(...suitesReports);
|
sections.push(...suitesReports);
|
||||||
}
|
}
|
||||||
if (shouldCollapse) {
|
if (totalFailed === 0) {
|
||||||
sections.push(`</details>`);
|
sections.push(`</details>`);
|
||||||
}
|
}
|
||||||
return sections;
|
return sections;
|
||||||
@@ -2166,9 +2153,6 @@ function getResultIcon(result) {
|
|||||||
return '';
|
return '';
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
function encodeImgShieldsURIComponent(component) {
|
|
||||||
return encodeURIComponent(component).replace(/-/g, '--').replace(/_/g, '__');
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/***/ }),
|
/***/ }),
|
||||||
|
|||||||
52
eslint.config.mjs
Normal file
52
eslint.config.mjs
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
import github from 'eslint-plugin-github'
|
||||||
|
import prettier from 'eslint-plugin-prettier'
|
||||||
|
import jest from 'eslint-plugin-jest'
|
||||||
|
|
||||||
|
export default [
|
||||||
|
github.getFlatConfigs().recommended,
|
||||||
|
...github.getFlatConfigs().typescript,
|
||||||
|
{
|
||||||
|
files: ['src/**/*.ts'],
|
||||||
|
plugins: {
|
||||||
|
prettier,
|
||||||
|
},
|
||||||
|
rules: {
|
||||||
|
'no-shadow': 'off',
|
||||||
|
'import/no-namespace': 'off',
|
||||||
|
'i18n-text/no-en': 'off',
|
||||||
|
'prefer-template': 'off',
|
||||||
|
'prettier/prettier': 'error',
|
||||||
|
"@typescript-eslint/array-type": ['error', {default: 'array'}],
|
||||||
|
'@typescript-eslint/no-unused-vars': ['error', {varsIgnorePattern: '^_'}],
|
||||||
|
'@typescript-eslint/no-shadow': ['error'],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
files: ['__tests__/**/*.test.ts'],
|
||||||
|
...jest.configs['flat/recommended'],
|
||||||
|
plugins: {
|
||||||
|
jest,
|
||||||
|
},
|
||||||
|
languageOptions: {
|
||||||
|
globals: jest.environments.globals.globals,
|
||||||
|
},
|
||||||
|
rules: {
|
||||||
|
'i18n-text/no-en': 'off',
|
||||||
|
'import/no-namespace': 'off',
|
||||||
|
"@typescript-eslint/array-type": ['error', {default: 'array'}],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
ignores: [
|
||||||
|
'dist/**',
|
||||||
|
'lib/**',
|
||||||
|
'node_modules/**',
|
||||||
|
'__tests__/__snapshots__/**',
|
||||||
|
'__tests__/__results__/**',
|
||||||
|
'assets/**',
|
||||||
|
'reports/**',
|
||||||
|
'eslint.config.mjs',
|
||||||
|
'jest.config.js',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
]
|
||||||
2994
package-lock.json
generated
2994
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
28
package.json
28
package.json
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "test-reporter",
|
"name": "test-reporter",
|
||||||
"version": "2.2.0",
|
"version": "2.1.1",
|
||||||
"private": true,
|
"private": true,
|
||||||
"description": "Presents test results from popular testing frameworks as Github check run",
|
"description": "Presents test results from popular testing frameworks as Github check run",
|
||||||
"main": "lib/main.js",
|
"main": "lib/main.js",
|
||||||
@@ -8,7 +8,7 @@
|
|||||||
"build": "tsc",
|
"build": "tsc",
|
||||||
"format": "prettier --write **/*.ts",
|
"format": "prettier --write **/*.ts",
|
||||||
"format-check": "prettier --check **/*.ts",
|
"format-check": "prettier --check **/*.ts",
|
||||||
"lint": "eslint src/**/*.ts",
|
"lint": "eslint",
|
||||||
"package": "ncc build --license licenses.txt && eolConverter lf 'dist/*'",
|
"package": "ncc build --license licenses.txt && eolConverter lf 'dist/*'",
|
||||||
"version": "npm run build && npm run package && git add dist/*",
|
"version": "npm run build && npm run package && git add dist/*",
|
||||||
"test": "jest --ci --reporters=default --reporters=jest-junit",
|
"test": "jest --ci --reporters=default --reporters=jest-junit",
|
||||||
@@ -49,25 +49,25 @@
|
|||||||
"@octokit/webhooks-types": "^7.6.1",
|
"@octokit/webhooks-types": "^7.6.1",
|
||||||
"@types/adm-zip": "^0.5.7",
|
"@types/adm-zip": "^0.5.7",
|
||||||
"@types/jest": "^30.0.0",
|
"@types/jest": "^30.0.0",
|
||||||
"@types/node": "^20.19.23",
|
"@types/node": "^20.19.13",
|
||||||
"@types/picomatch": "^4.0.2",
|
"@types/picomatch": "^4.0.2",
|
||||||
"@types/xml2js": "^0.4.14",
|
"@types/xml2js": "^0.4.14",
|
||||||
"@typescript-eslint/eslint-plugin": "^7.18.0",
|
"@typescript-eslint/eslint-plugin": "^8.43.0",
|
||||||
"@typescript-eslint/parser": "^7.18.0",
|
"@typescript-eslint/parser": "^8.43.0",
|
||||||
"@vercel/ncc": "^0.38.4",
|
"@vercel/ncc": "^0.38.3",
|
||||||
"eol-converter-cli": "^1.1.0",
|
"eol-converter-cli": "^1.1.0",
|
||||||
"eslint": "^8.57.1",
|
"eslint": "^9.35.0",
|
||||||
"eslint-import-resolver-typescript": "^3.10.1",
|
"eslint-import-resolver-typescript": "^4.4.4",
|
||||||
"eslint-plugin-github": "^4.10.2",
|
"eslint-plugin-github": "^6.0.0",
|
||||||
"eslint-plugin-import": "^2.32.0",
|
"eslint-plugin-import": "^2.32.0",
|
||||||
"eslint-plugin-jest": "^28.14.0",
|
"eslint-plugin-jest": "^29.0.1",
|
||||||
"eslint-plugin-prettier": "^5.5.4",
|
"eslint-plugin-prettier": "^5.5.4",
|
||||||
"jest": "^30.2.0",
|
"jest": "^30.1.3",
|
||||||
"jest-junit": "^16.0.0",
|
"jest-junit": "^16.0.0",
|
||||||
"js-yaml": "^4.1.1",
|
"js-yaml": "^4.1.0",
|
||||||
"prettier": "^3.6.2",
|
"prettier": "^3.6.2",
|
||||||
"ts-jest": "^29.4.5",
|
"ts-jest": "^29.4.1",
|
||||||
"typescript": "^5.9.3"
|
"typescript": "^5.9.2"
|
||||||
},
|
},
|
||||||
"jest-junit": {
|
"jest-junit": {
|
||||||
"suiteName": "jest tests",
|
"suiteName": "jest tests",
|
||||||
|
|||||||
14
src/main.ts
14
src/main.ts
@@ -49,7 +49,6 @@ class TestReporter {
|
|||||||
readonly useActionsSummary = core.getInput('use-actions-summary', {required: false}) === 'true'
|
readonly useActionsSummary = core.getInput('use-actions-summary', {required: false}) === 'true'
|
||||||
readonly badgeTitle = core.getInput('badge-title', {required: false})
|
readonly badgeTitle = core.getInput('badge-title', {required: false})
|
||||||
readonly reportTitle = core.getInput('report-title', {required: false})
|
readonly reportTitle = core.getInput('report-title', {required: false})
|
||||||
readonly collapsed = core.getInput('collapsed', {required: false}) as 'auto' | 'always' | 'never'
|
|
||||||
readonly token = core.getInput('token', {required: true})
|
readonly token = core.getInput('token', {required: true})
|
||||||
readonly octokit: InstanceType<typeof GitHub>
|
readonly octokit: InstanceType<typeof GitHub>
|
||||||
readonly context = getCheckRunContext()
|
readonly context = getCheckRunContext()
|
||||||
@@ -67,11 +66,6 @@ class TestReporter {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
if (this.collapsed !== 'auto' && this.collapsed !== 'always' && this.collapsed !== 'never') {
|
|
||||||
core.setFailed(`Input parameter 'collapsed' has invalid value`)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if (isNaN(this.maxAnnotations) || this.maxAnnotations < 0 || this.maxAnnotations > 50) {
|
if (isNaN(this.maxAnnotations) || this.maxAnnotations < 0 || this.maxAnnotations > 50) {
|
||||||
core.setFailed(`Input parameter 'max-annotations' has invalid value`)
|
core.setFailed(`Input parameter 'max-annotations' has invalid value`)
|
||||||
return
|
return
|
||||||
@@ -172,7 +166,7 @@ class TestReporter {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
const {listSuites, listTests, onlySummary, useActionsSummary, badgeTitle, reportTitle, collapsed} = this
|
const {listSuites, listTests, onlySummary, useActionsSummary, badgeTitle, reportTitle} = this
|
||||||
|
|
||||||
const passed = results.reduce((sum, tr) => sum + tr.passed, 0)
|
const passed = results.reduce((sum, tr) => sum + tr.passed, 0)
|
||||||
const failed = results.reduce((sum, tr) => sum + tr.failed, 0)
|
const failed = results.reduce((sum, tr) => sum + tr.failed, 0)
|
||||||
@@ -188,8 +182,7 @@ class TestReporter {
|
|||||||
onlySummary,
|
onlySummary,
|
||||||
useActionsSummary,
|
useActionsSummary,
|
||||||
badgeTitle,
|
badgeTitle,
|
||||||
reportTitle,
|
reportTitle
|
||||||
collapsed
|
|
||||||
})
|
})
|
||||||
|
|
||||||
core.info('Summary content:')
|
core.info('Summary content:')
|
||||||
@@ -218,8 +211,7 @@ class TestReporter {
|
|||||||
onlySummary,
|
onlySummary,
|
||||||
useActionsSummary,
|
useActionsSummary,
|
||||||
badgeTitle,
|
badgeTitle,
|
||||||
reportTitle,
|
reportTitle
|
||||||
collapsed
|
|
||||||
})
|
})
|
||||||
|
|
||||||
core.info('Creating annotations')
|
core.info('Creating annotations')
|
||||||
|
|||||||
@@ -16,7 +16,6 @@ export interface ReportOptions {
|
|||||||
useActionsSummary: boolean
|
useActionsSummary: boolean
|
||||||
badgeTitle: string
|
badgeTitle: string
|
||||||
reportTitle: string
|
reportTitle: string
|
||||||
collapsed: 'auto' | 'always' | 'never'
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export const DEFAULT_OPTIONS: ReportOptions = {
|
export const DEFAULT_OPTIONS: ReportOptions = {
|
||||||
@@ -26,8 +25,7 @@ export const DEFAULT_OPTIONS: ReportOptions = {
|
|||||||
onlySummary: false,
|
onlySummary: false,
|
||||||
useActionsSummary: true,
|
useActionsSummary: true,
|
||||||
badgeTitle: 'tests',
|
badgeTitle: 'tests',
|
||||||
reportTitle: '',
|
reportTitle: ''
|
||||||
collapsed: 'auto'
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export function getReport(results: TestRunResult[], options: ReportOptions = DEFAULT_OPTIONS): string {
|
export function getReport(results: TestRunResult[], options: ReportOptions = DEFAULT_OPTIONS): string {
|
||||||
@@ -127,7 +125,7 @@ function getReportBadge(results: TestRunResult[], options: ReportOptions): strin
|
|||||||
return getBadge(passed, failed, skipped, options)
|
return getBadge(passed, failed, skipped, options)
|
||||||
}
|
}
|
||||||
|
|
||||||
export function getBadge(passed: number, failed: number, skipped: number, options: ReportOptions): string {
|
function getBadge(passed: number, failed: number, skipped: number, options: ReportOptions): string {
|
||||||
const text = []
|
const text = []
|
||||||
if (passed > 0) {
|
if (passed > 0) {
|
||||||
text.push(`${passed} passed`)
|
text.push(`${passed} passed`)
|
||||||
@@ -147,20 +145,14 @@ export function getBadge(passed: number, failed: number, skipped: number, option
|
|||||||
color = 'yellow'
|
color = 'yellow'
|
||||||
}
|
}
|
||||||
const hint = failed > 0 ? 'Tests failed' : 'Tests passed successfully'
|
const hint = failed > 0 ? 'Tests failed' : 'Tests passed successfully'
|
||||||
const encodedBadgeTitle = encodeImgShieldsURIComponent(options.badgeTitle)
|
const uri = encodeURIComponent(`${options.badgeTitle}-${message}-${color}`)
|
||||||
const encodedMessage = encodeImgShieldsURIComponent(message)
|
return ``
|
||||||
const encodedColor = encodeImgShieldsURIComponent(color)
|
|
||||||
return ``
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function getTestRunsReport(testRuns: TestRunResult[], options: ReportOptions): string[] {
|
function getTestRunsReport(testRuns: TestRunResult[], options: ReportOptions): string[] {
|
||||||
const sections: string[] = []
|
const sections: string[] = []
|
||||||
const totalFailed = testRuns.reduce((sum, tr) => sum + tr.failed, 0)
|
const totalFailed = testRuns.reduce((sum, tr) => sum + tr.failed, 0)
|
||||||
|
if (totalFailed === 0) {
|
||||||
// Determine if report should be collapsed based on collapsed option
|
|
||||||
const shouldCollapse = options.collapsed === 'always' || (options.collapsed === 'auto' && totalFailed === 0)
|
|
||||||
|
|
||||||
if (shouldCollapse) {
|
|
||||||
sections.push(`<details><summary>Expand for details</summary>`)
|
sections.push(`<details><summary>Expand for details</summary>`)
|
||||||
sections.push(` `)
|
sections.push(` `)
|
||||||
}
|
}
|
||||||
@@ -193,7 +185,7 @@ function getTestRunsReport(testRuns: TestRunResult[], options: ReportOptions): s
|
|||||||
sections.push(...suitesReports)
|
sections.push(...suitesReports)
|
||||||
}
|
}
|
||||||
|
|
||||||
if (shouldCollapse) {
|
if (totalFailed === 0) {
|
||||||
sections.push(`</details>`)
|
sections.push(`</details>`)
|
||||||
}
|
}
|
||||||
return sections
|
return sections
|
||||||
@@ -313,7 +305,3 @@ function getResultIcon(result: TestExecutionResult): string {
|
|||||||
return ''
|
return ''
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function encodeImgShieldsURIComponent(component: string): string {
|
|
||||||
return encodeURIComponent(component).replace(/-/g, '--').replace(/_/g, '__')
|
|
||||||
}
|
|
||||||
|
|||||||
Reference in New Issue
Block a user