From 9b8d3b002ee223a4dc1788ccf12d034d93418eb4 Mon Sep 17 00:00:00 2001 From: Michael Marcus Date: Fri, 25 Jul 2025 15:06:22 -0400 Subject: [PATCH 1/2] Python support Add python-xunit-parser.ts with associated case statement Add python-xunit to reporter docs in action.yml Add tests Update README Resolves #244 Resolves #633 --- README.md | 13 +++ __tests__/__outputs__/python-xunit.md | 17 ++++ .../__snapshots__/python-xunit.test.ts.snap | 44 +++++++++ __tests__/fixtures/python-xunit.xml | 12 +++ __tests__/python-xunit.test.ts | 92 +++++++++++++++++++ action.yml | 1 + dist/index.js | 23 +++++ src/main.ts | 4 +- .../python-xunit/python-xunit-parser.ts | 8 ++ 9 files changed, 213 insertions(+), 1 deletion(-) create mode 100644 __tests__/__outputs__/python-xunit.md create mode 100644 __tests__/__snapshots__/python-xunit.test.ts.snap create mode 100644 __tests__/fixtures/python-xunit.xml create mode 100644 __tests__/python-xunit.test.ts create mode 100644 src/parsers/python-xunit/python-xunit-parser.ts diff --git a/README.md b/README.md index c307ff3..0563641 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ This [Github Action](https://github.com/features/actions) displays test results - Go / [go test](https://pkg.go.dev/testing) - Java / [JUnit](https://junit.org/) - JavaScript / [JEST](https://jestjs.io/) / [Mocha](https://mochajs.org/) +- Python / [pytest](https://docs.pytest.org/en/stable/) / [unittest](https://docs.python.org/3/library/unittest.html) - Swift / xUnit For more information see [Supported formats](#supported-formats) section. @@ -145,7 +146,9 @@ jobs: # java-junit # jest-junit # mocha-json + # python-xunit # rspec-json + # swift-xunit reporter: '' # Allows you to generate only the summary. @@ -349,6 +352,16 @@ Before version [v9.1.0](https://github.com/mochajs/mocha/releases/tag/v9.1.0), M Please update Mocha to version [v9.1.0](https://github.com/mochajs/mocha/releases/tag/v9.1.0) or above if you encounter this issue. +
+ python-xunit (Experimental) + +Support for Python test results in xUnit format is experimental - should work but it was not extensively tested. + +For pytest support, configure [JUnit XML output](https://docs.pytest.org/en/stable/how-to/output.html#creating-junitxml-format-files) and run with the `--junit-xml` option, which also lets you specify the output path for test results. + +For unittest support, use a test runner that outputs the JUnit report format, such as [unittest-xml-reporting](https://pypi.org/project/unittest-xml-reporting/). +
+
swift-xunit (Experimental) diff --git a/__tests__/__outputs__/python-xunit.md b/__tests__/__outputs__/python-xunit.md new file mode 100644 index 0000000..5715276 --- /dev/null +++ b/__tests__/__outputs__/python-xunit.md @@ -0,0 +1,17 @@ +![Tests failed](https://img.shields.io/badge/tests-2%20passed%2C%201%20failed-critical) +|Report|Passed|Failed|Skipped|Time| +|:---|---:|---:|---:|---:| +|[fixtures/python-xunit.xml](#user-content-r0)|2 ✅|1 ❌||220ms| +## ❌ fixtures/python-xunit.xml +**3** tests were completed in **220ms** with **2** passed, **1** failed and **0** skipped. +|Test suite|Passed|Failed|Skipped|Time| +|:---|---:|---:|---:|---:| +|[pytest](#user-content-r0s0)|2 ✅|1 ❌||220ms| +### ❌ pytest +``` +src.acme.test_lib + ✅ test_always_pass + ✅ test_always_skip + ❌ test_always_fail + failed +``` \ No newline at end of file diff --git a/__tests__/__snapshots__/python-xunit.test.ts.snap b/__tests__/__snapshots__/python-xunit.test.ts.snap new file mode 100644 index 0000000..94a1046 --- /dev/null +++ b/__tests__/__snapshots__/python-xunit.test.ts.snap @@ -0,0 +1,44 @@ +// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing + +exports[`python-xunit tests report from python test results matches snapshot 1`] = ` +TestRunResult { + "path": "fixtures/python-xunit.xml", + "suites": [ + TestSuiteResult { + "groups": [ + TestGroupResult { + "name": "src.acme.test_lib", + "tests": [ + TestCaseResult { + "error": undefined, + "name": "test_always_pass", + "result": "success", + "time": 36.386333, + }, + TestCaseResult { + "error": undefined, + "name": "test_always_skip", + "result": "success", + "time": 92.039167, + }, + TestCaseResult { + "error": { + "details": undefined, + "line": undefined, + "message": "failed", + "path": undefined, + }, + "name": "test_always_fail", + "result": "failed", + "time": 92.05175, + }, + ], + }, + ], + "name": "pytest", + "totalTime": 220.47725000000003, + }, + ], + "totalTime": undefined, +} +`; diff --git a/__tests__/fixtures/python-xunit.xml b/__tests__/fixtures/python-xunit.xml new file mode 100644 index 0000000..c2872f7 --- /dev/null +++ b/__tests__/fixtures/python-xunit.xml @@ -0,0 +1,12 @@ + + + + + + + + + + + + diff --git a/__tests__/python-xunit.test.ts b/__tests__/python-xunit.test.ts new file mode 100644 index 0000000..e4adeab --- /dev/null +++ b/__tests__/python-xunit.test.ts @@ -0,0 +1,92 @@ +import * as fs from 'fs' +import * as path from 'path' + +import {PythonXunitParser} from '../src/parsers/python-xunit/python-xunit-parser' +import {ParseOptions} from '../src/test-parser' +import {DEFAULT_OPTIONS, getReport} from '../src/report/get-report' +import {normalizeFilePath} from '../src/utils/path-utils' + +describe('python-xunit tests', () => { + it('report from python test results matches snapshot', async () => { + const fixturePath = path.join(__dirname, 'fixtures', 'python-xunit.xml') + const outputPath = path.join(__dirname, '__outputs__', 'python-xunit.md') + const filePath = normalizeFilePath(path.relative(__dirname, fixturePath)) + const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'}) + + const trackedFiles = ['src/acme/test_lib.py'] + const opts: ParseOptions = { + parseErrors: true, + trackedFiles + } + + const parser = new PythonXunitParser(opts) + const result = await parser.parse(filePath, fileContent) + expect(result).toMatchSnapshot() + + const report = getReport([result]) + fs.mkdirSync(path.dirname(outputPath), {recursive: true}) + fs.writeFileSync(outputPath, report) + }) + + it('report does not include a title by default', async () => { + const fixturePath = path.join(__dirname, 'fixtures', 'python-xunit.xml') + const filePath = normalizeFilePath(path.relative(__dirname, fixturePath)) + const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'}) + + const opts: ParseOptions = { + parseErrors: true, + trackedFiles: [] + } + + const parser = new PythonXunitParser(opts) + const result = await parser.parse(filePath, fileContent) + const report = getReport([result]) + // Report should have the badge as the first line + expect(report).toMatch(/^!\[Tests failed]/) + }) + + it.each([ + ['empty string', ''], + ['space', ' '], + ['tab', '\t'], + ['newline', '\n'] + ])('report does not include a title when configured value is %s', async (_, reportTitle) => { + const fixturePath = path.join(__dirname, 'fixtures', 'python-xunit.xml') + const filePath = normalizeFilePath(path.relative(__dirname, fixturePath)) + const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'}) + + const opts: ParseOptions = { + parseErrors: true, + trackedFiles: [] + } + + const parser = new PythonXunitParser(opts) + const result = await parser.parse(filePath, fileContent) + const report = getReport([result], { + ...DEFAULT_OPTIONS, + reportTitle + }) + // Report should have the badge as the first line + expect(report).toMatch(/^!\[Tests failed]/) + }) + + it('report includes a custom report title', async () => { + const fixturePath = path.join(__dirname, 'fixtures', 'python-xunit.xml') + const filePath = normalizeFilePath(path.relative(__dirname, fixturePath)) + const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'}) + + const opts: ParseOptions = { + parseErrors: true, + trackedFiles: [] + } + + const parser = new PythonXunitParser(opts) + const result = await parser.parse(filePath, fileContent) + const report = getReport([result], { + ...DEFAULT_OPTIONS, + reportTitle: 'My Custom Title' + }) + // Report should have the title as the first line + expect(report).toMatch(/^# My Custom Title\n/) + }) +}) diff --git a/action.yml b/action.yml index c8dd56b..fab75d5 100644 --- a/action.yml +++ b/action.yml @@ -32,6 +32,7 @@ inputs: - java-junit - jest-junit - mocha-json + - python-xunit - rspec-json - swift-xunit required: true diff --git a/dist/index.js b/dist/index.js index ee83e34..a66a461 100644 --- a/dist/index.js +++ b/dist/index.js @@ -277,6 +277,7 @@ const golang_json_parser_1 = __nccwpck_require__(5162); const java_junit_parser_1 = __nccwpck_require__(8342); const jest_junit_parser_1 = __nccwpck_require__(1042); const mocha_json_parser_1 = __nccwpck_require__(5402); +const python_xunit_parser_1 = __nccwpck_require__(6578); const rspec_json_parser_1 = __nccwpck_require__(9768); const swift_xunit_parser_1 = __nccwpck_require__(7330); const path_utils_1 = __nccwpck_require__(9132); @@ -493,6 +494,8 @@ class TestReporter { return new jest_junit_parser_1.JestJunitParser(options); case 'mocha-json': return new mocha_json_parser_1.MochaJsonParser(options); + case 'python-xunit': + return new python_xunit_parser_1.PythonXunitParser(options); case 'rspec-json': return new rspec_json_parser_1.RspecJsonParser(options); case 'swift-xunit': @@ -1663,6 +1666,26 @@ class MochaJsonParser { exports.MochaJsonParser = MochaJsonParser; +/***/ }), + +/***/ 6578: +/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => { + +"use strict"; + +Object.defineProperty(exports, "__esModule", ({ value: true })); +exports.PythonXunitParser = void 0; +const java_junit_parser_1 = __nccwpck_require__(8342); +class PythonXunitParser extends java_junit_parser_1.JavaJunitParser { + options; + constructor(options) { + super(options); + this.options = options; + } +} +exports.PythonXunitParser = PythonXunitParser; + + /***/ }), /***/ 9768: diff --git a/src/main.ts b/src/main.ts index 46ffdec..e76992a 100644 --- a/src/main.ts +++ b/src/main.ts @@ -17,9 +17,9 @@ import {GolangJsonParser} from './parsers/golang-json/golang-json-parser' import {JavaJunitParser} from './parsers/java-junit/java-junit-parser' import {JestJunitParser} from './parsers/jest-junit/jest-junit-parser' import {MochaJsonParser} from './parsers/mocha-json/mocha-json-parser' +import {PythonXunitParser} from './parsers/python-xunit/python-xunit-parser' import {RspecJsonParser} from './parsers/rspec-json/rspec-json-parser' import {SwiftXunitParser} from './parsers/swift-xunit/swift-xunit-parser' - import {normalizeDirPath, normalizeFilePath} from './utils/path-utils' import {getCheckRunContext} from './utils/github-utils' @@ -271,6 +271,8 @@ class TestReporter { return new JestJunitParser(options) case 'mocha-json': return new MochaJsonParser(options) + case 'python-xunit': + return new PythonXunitParser(options) case 'rspec-json': return new RspecJsonParser(options) case 'swift-xunit': diff --git a/src/parsers/python-xunit/python-xunit-parser.ts b/src/parsers/python-xunit/python-xunit-parser.ts new file mode 100644 index 0000000..6902d71 --- /dev/null +++ b/src/parsers/python-xunit/python-xunit-parser.ts @@ -0,0 +1,8 @@ +import {ParseOptions} from '../../test-parser' +import {JavaJunitParser} from '../java-junit/java-junit-parser' + +export class PythonXunitParser extends JavaJunitParser { + constructor(readonly options: ParseOptions) { + super(options) + } +} From fe87682515df3d40b35ffe4a3cd7c51d28d90d07 Mon Sep 17 00:00:00 2001 From: Michael Marcus Date: Fri, 14 Nov 2025 21:59:25 -0500 Subject: [PATCH 2/2] Improve testing with robust schema for unittest report --- __tests__/__outputs__/python-xunit.md | 24 ++++--- .../__snapshots__/python-xunit.test.ts.snap | 67 +++++++++++++++---- __tests__/fixtures/python-xunit-unittest.xml | 27 ++++++++ __tests__/fixtures/python-xunit.xml | 12 ---- __tests__/python-xunit.test.ts | 54 +++++---------- 5 files changed, 113 insertions(+), 71 deletions(-) create mode 100644 __tests__/fixtures/python-xunit-unittest.xml delete mode 100644 __tests__/fixtures/python-xunit.xml diff --git a/__tests__/__outputs__/python-xunit.md b/__tests__/__outputs__/python-xunit.md index 5715276..230d186 100644 --- a/__tests__/__outputs__/python-xunit.md +++ b/__tests__/__outputs__/python-xunit.md @@ -1,17 +1,23 @@ -![Tests failed](https://img.shields.io/badge/tests-2%20passed%2C%201%20failed-critical) +![Tests failed](https://img.shields.io/badge/tests-4%20passed%2C%202%20failed%2C%202%20skipped-critical) |Report|Passed|Failed|Skipped|Time| |:---|---:|---:|---:|---:| -|[fixtures/python-xunit.xml](#user-content-r0)|2 ✅|1 ❌||220ms| -## ❌ fixtures/python-xunit.xml -**3** tests were completed in **220ms** with **2** passed, **1** failed and **0** skipped. +|[fixtures/python-xunit-unittest.xml](#user-content-r0)|4 ✅|2 ❌|2 ⚪|1ms| +## ❌ fixtures/python-xunit-unittest.xml +**8** tests were completed in **1ms** with **4** passed, **2** failed and **2** skipped. |Test suite|Passed|Failed|Skipped|Time| |:---|---:|---:|---:|---:| -|[pytest](#user-content-r0s0)|2 ✅|1 ❌||220ms| -### ❌ pytest +|[TestAcme-20251114214921](#user-content-r0s0)|4 ✅|2 ❌|2 ⚪|1ms| +### ❌ TestAcme-20251114214921 ``` -src.acme.test_lib +TestAcme ✅ test_always_pass - ✅ test_always_skip + ✅ test_parameterized_0_param1 + ✅ test_parameterized_1_param2 + ✅ test_with_subtests ❌ test_always_fail - failed + AssertionError: failed + ❌ test_error + Exception: error + ⚪ test_always_skip + ⚪ test_expected_failure ``` \ No newline at end of file diff --git a/__tests__/__snapshots__/python-xunit.test.ts.snap b/__tests__/__snapshots__/python-xunit.test.ts.snap index 94a1046..555d41f 100644 --- a/__tests__/__snapshots__/python-xunit.test.ts.snap +++ b/__tests__/__snapshots__/python-xunit.test.ts.snap @@ -1,44 +1,87 @@ // Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing -exports[`python-xunit tests report from python test results matches snapshot 1`] = ` +exports[`python-xunit unittest report report from python test results matches snapshot 1`] = ` TestRunResult { - "path": "fixtures/python-xunit.xml", + "path": "fixtures/python-xunit-unittest.xml", "suites": [ TestSuiteResult { "groups": [ TestGroupResult { - "name": "src.acme.test_lib", + "name": "TestAcme", "tests": [ TestCaseResult { "error": undefined, "name": "test_always_pass", "result": "success", - "time": 36.386333, + "time": 0, }, TestCaseResult { "error": undefined, - "name": "test_always_skip", + "name": "test_parameterized_0_param1", "result": "success", - "time": 92.039167, + "time": 1, + }, + TestCaseResult { + "error": undefined, + "name": "test_parameterized_1_param2", + "result": "success", + "time": 0, + }, + TestCaseResult { + "error": undefined, + "name": "test_with_subtests", + "result": "success", + "time": 0, }, TestCaseResult { "error": { - "details": undefined, + "details": "Traceback (most recent call last): + File "/Users/foo/Projects/python-test/tests/test_lib.py", line 24, in test_always_fail + self.fail("failed") +AssertionError: failed +", "line": undefined, - "message": "failed", + "message": "AssertionError: failed", "path": undefined, }, "name": "test_always_fail", "result": "failed", - "time": 92.05175, + "time": 0, + }, + TestCaseResult { + "error": { + "details": "Traceback (most recent call last): + File "/Users/foo/Projects/python-test/tests/test_lib.py", line 31, in test_error + raise Exception("error") +Exception: error +", + "line": undefined, + "message": "Exception: error", + "path": undefined, + }, + "name": "test_error", + "result": "failed", + "time": 0, + }, + TestCaseResult { + "error": undefined, + "name": "test_always_skip", + "result": "skipped", + "time": 0, + }, + TestCaseResult { + "error": undefined, + "name": "test_expected_failure", + "result": "skipped", + "time": 0, }, ], }, ], - "name": "pytest", - "totalTime": 220.47725000000003, + "name": "TestAcme-20251114214921", + "totalTime": 1, }, ], - "totalTime": undefined, + "totalTime": 1, } `; diff --git a/__tests__/fixtures/python-xunit-unittest.xml b/__tests__/fixtures/python-xunit-unittest.xml new file mode 100644 index 0000000..ecc67d4 --- /dev/null +++ b/__tests__/fixtures/python-xunit-unittest.xml @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + diff --git a/__tests__/fixtures/python-xunit.xml b/__tests__/fixtures/python-xunit.xml deleted file mode 100644 index c2872f7..0000000 --- a/__tests__/fixtures/python-xunit.xml +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - - - - - diff --git a/__tests__/python-xunit.test.ts b/__tests__/python-xunit.test.ts index e4adeab..9959ce0 100644 --- a/__tests__/python-xunit.test.ts +++ b/__tests__/python-xunit.test.ts @@ -6,16 +6,21 @@ import {ParseOptions} from '../src/test-parser' import {DEFAULT_OPTIONS, getReport} from '../src/report/get-report' import {normalizeFilePath} from '../src/utils/path-utils' -describe('python-xunit tests', () => { - it('report from python test results matches snapshot', async () => { - const fixturePath = path.join(__dirname, 'fixtures', 'python-xunit.xml') - const outputPath = path.join(__dirname, '__outputs__', 'python-xunit.md') - const filePath = normalizeFilePath(path.relative(__dirname, fixturePath)) - const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'}) +const defaultOpts: ParseOptions = { + parseErrors: true, + trackedFiles: [] +} - const trackedFiles = ['src/acme/test_lib.py'] +describe('python-xunit unittest report', () => { + const fixturePath = path.join(__dirname, 'fixtures', 'python-xunit-unittest.xml') + const filePath = normalizeFilePath(path.relative(__dirname, fixturePath)) + const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'}) + + it('report from python test results matches snapshot', async () => { + const outputPath = path.join(__dirname, '__outputs__', 'python-xunit.md') + const trackedFiles = ['tests/test_lib.py'] const opts: ParseOptions = { - parseErrors: true, + ...defaultOpts, trackedFiles } @@ -29,16 +34,7 @@ describe('python-xunit tests', () => { }) it('report does not include a title by default', async () => { - const fixturePath = path.join(__dirname, 'fixtures', 'python-xunit.xml') - const filePath = normalizeFilePath(path.relative(__dirname, fixturePath)) - const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'}) - - const opts: ParseOptions = { - parseErrors: true, - trackedFiles: [] - } - - const parser = new PythonXunitParser(opts) + const parser = new PythonXunitParser(defaultOpts) const result = await parser.parse(filePath, fileContent) const report = getReport([result]) // Report should have the badge as the first line @@ -51,16 +47,7 @@ describe('python-xunit tests', () => { ['tab', '\t'], ['newline', '\n'] ])('report does not include a title when configured value is %s', async (_, reportTitle) => { - const fixturePath = path.join(__dirname, 'fixtures', 'python-xunit.xml') - const filePath = normalizeFilePath(path.relative(__dirname, fixturePath)) - const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'}) - - const opts: ParseOptions = { - parseErrors: true, - trackedFiles: [] - } - - const parser = new PythonXunitParser(opts) + const parser = new PythonXunitParser(defaultOpts) const result = await parser.parse(filePath, fileContent) const report = getReport([result], { ...DEFAULT_OPTIONS, @@ -71,16 +58,7 @@ describe('python-xunit tests', () => { }) it('report includes a custom report title', async () => { - const fixturePath = path.join(__dirname, 'fixtures', 'python-xunit.xml') - const filePath = normalizeFilePath(path.relative(__dirname, fixturePath)) - const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'}) - - const opts: ParseOptions = { - parseErrors: true, - trackedFiles: [] - } - - const parser = new PythonXunitParser(opts) + const parser = new PythonXunitParser(defaultOpts) const result = await parser.parse(filePath, fileContent) const report = getReport([result], { ...DEFAULT_OPTIONS,