Merge pull request #683 from micmarc/feature/python-pytest

Add robust test schema for pytest report
Update README with sample pytest command

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,20 @@ 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.
 </details>
 
+<details>
+  <summary>python-xunit (Experimental)</summary>
+
+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.
+
+```shell
+pytest --junit-xml=test-report.xml
+```
+
+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/).
+</details>
+
 <details>
   <summary>swift-xunit (Experimental)</summary>
 

__tests__/__outputs__/python-xunit-pytest.md

@@ -0,0 +1,26 @@
+![Tests failed](https://img.shields.io/badge/tests-6%20passed%2C%202%20failed%2C%202%20skipped-critical)
+|Report|Passed|Failed|Skipped|Time|
+|:---|---:|---:|---:|---:|
+|[fixtures/python-xunit-pytest.xml](#user-content-r0)|6 ✅|2 ❌|2 ⚪|19ms|
+## ❌ <a id="user-content-r0" href="#user-content-r0">fixtures/python-xunit-pytest.xml</a>
+**10** tests were completed in **19ms** with **6** passed, **2** failed and **2** skipped.
+|Test suite|Passed|Failed|Skipped|Time|
+|:---|---:|---:|---:|---:|
+|[pytest](#user-content-r0s0)|6 ✅|2 ❌|2 ⚪|19ms|
+### ❌ <a id="user-content-r0s0" href="#user-content-r0s0">pytest</a>
+```
+tests.test_lib
+  ✅ test_always_pass
+  ✅ test_with_subtests
+  ✅ test_parameterized[param1]
+  ✅ test_parameterized[param2]
+  ⚪ test_always_skip
+  ❌ test_always_fail
+	assert False
+  ⚪ test_expected_failure
+  ❌ test_error
+	Exception: error
+  ✅ test_with_record_property
+custom_classname
+  ✅ test_with_record_xml_attribute
+```

__tests__/__outputs__/python-xunit-unittest.md

@@ -0,0 +1,23 @@
+![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-unittest.xml](#user-content-r0)|4 ✅|2 ❌|2 ⚪|1ms|
+## ❌ <a id="user-content-r0" href="#user-content-r0">fixtures/python-xunit-unittest.xml</a>
+**8** tests were completed in **1ms** with **4** passed, **2** failed and **2** skipped.
+|Test suite|Passed|Failed|Skipped|Time|
+|:---|---:|---:|---:|---:|
+|[TestAcme-20251114214921](#user-content-r0s0)|4 ✅|2 ❌|2 ⚪|1ms|
+### ❌ <a id="user-content-r0s0" href="#user-content-r0s0">TestAcme-20251114214921</a>
+```
+TestAcme
+  ✅ test_always_pass
+  ✅ test_parameterized_0_param1
+  ✅ test_parameterized_1_param2
+  ✅ test_with_subtests
+  ❌ test_always_fail
+	AssertionError: failed
+  ❌ test_error
+	Exception: error
+  ⚪ test_always_skip
+  ⚪ test_expected_failure
+```

__tests__/__snapshots__/python-xunit.test.ts.snap

@@ -0,0 +1,192 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`python-xunit pytest report report from python test results matches snapshot 1`] = `
+TestRunResult {
+  "path": "fixtures/python-xunit-pytest.xml",
+  "suites": [
+    TestSuiteResult {
+      "groups": [
+        TestGroupResult {
+          "name": "tests.test_lib",
+          "tests": [
+            TestCaseResult {
+              "error": undefined,
+              "name": "test_always_pass",
+              "result": "success",
+              "time": 2,
+            },
+            TestCaseResult {
+              "error": undefined,
+              "name": "test_with_subtests",
+              "result": "success",
+              "time": 5,
+            },
+            TestCaseResult {
+              "error": undefined,
+              "name": "test_parameterized[param1]",
+              "result": "success",
+              "time": 0,
+            },
+            TestCaseResult {
+              "error": undefined,
+              "name": "test_parameterized[param2]",
+              "result": "success",
+              "time": 0,
+            },
+            TestCaseResult {
+              "error": undefined,
+              "name": "test_always_skip",
+              "result": "skipped",
+              "time": 0,
+            },
+            TestCaseResult {
+              "error": {
+                "details": "def test_always_fail():
+        > assert False
+        E assert False
+
+        tests/test_lib.py:25: AssertionError
+      ",
+                "line": undefined,
+                "message": "assert False",
+                "path": undefined,
+              },
+              "name": "test_always_fail",
+              "result": "failed",
+              "time": 0,
+            },
+            TestCaseResult {
+              "error": undefined,
+              "name": "test_expected_failure",
+              "result": "skipped",
+              "time": 0,
+            },
+            TestCaseResult {
+              "error": {
+                "details": "def test_error():
+        > raise Exception("error")
+        E Exception: error
+
+        tests/test_lib.py:32: Exception
+      ",
+                "line": undefined,
+                "message": "Exception: error",
+                "path": undefined,
+              },
+              "name": "test_error",
+              "result": "failed",
+              "time": 0,
+            },
+            TestCaseResult {
+              "error": undefined,
+              "name": "test_with_record_property",
+              "result": "success",
+              "time": 0,
+            },
+          ],
+        },
+        TestGroupResult {
+          "name": "custom_classname",
+          "tests": [
+            TestCaseResult {
+              "error": undefined,
+              "name": "test_with_record_xml_attribute",
+              "result": "success",
+              "time": 0,
+            },
+          ],
+        },
+      ],
+      "name": "pytest",
+      "totalTime": 19,
+    },
+  ],
+  "totalTime": undefined,
+}
+`;
+
+exports[`python-xunit unittest report report from python test results matches snapshot 1`] = `
+TestRunResult {
+  "path": "fixtures/python-xunit-unittest.xml",
+  "suites": [
+    TestSuiteResult {
+      "groups": [
+        TestGroupResult {
+          "name": "TestAcme",
+          "tests": [
+            TestCaseResult {
+              "error": undefined,
+              "name": "test_always_pass",
+              "result": "success",
+              "time": 0,
+            },
+            TestCaseResult {
+              "error": undefined,
+              "name": "test_parameterized_0_param1",
+              "result": "success",
+              "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": "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": "AssertionError: failed",
+                "path": undefined,
+              },
+              "name": "test_always_fail",
+              "result": "failed",
+              "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": "TestAcme-20251114214921",
+      "totalTime": 1,
+    },
+  ],
+  "totalTime": 1,
+}
+`;

__tests__/fixtures/python-xunit-pytest.xml

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="utf-8"?>
+<testsuites name="pytest tests">
+  <testsuite name="pytest" errors="0" failures="2" skipped="2" tests="15" time="0.019"
+             timestamp="2025-11-15T11:51:49.548396-05:00" hostname="Mac.hsd1.va.comcast.net">
+    <properties>
+      <property name="custom_prop" value="custom_val"/>
+    </properties>
+    <testcase classname="tests.test_lib" name="test_always_pass" time="0.002"/>
+    <testcase classname="tests.test_lib" name="test_with_subtests" time="0.005"/>
+    <testcase classname="tests.test_lib" name="test_parameterized[param1]" time="0.000"/>
+    <testcase classname="tests.test_lib" name="test_parameterized[param2]" time="0.000"/>
+    <testcase classname="tests.test_lib" name="test_always_skip" time="0.000">
+      <skipped type="pytest.skip" message="skipped">/Users/mike/Projects/python-test/tests/test_lib.py:20: skipped
+      </skipped>
+    </testcase>
+    <testcase classname="tests.test_lib" name="test_always_fail" time="0.000">
+      <failure message="assert False">def test_always_fail():
+        &gt; assert False
+        E assert False
+
+        tests/test_lib.py:25: AssertionError
+      </failure>
+    </testcase>
+    <testcase classname="tests.test_lib" name="test_expected_failure" time="0.000">
+      <skipped type="pytest.xfail" message=""/>
+    </testcase>
+    <testcase classname="tests.test_lib" name="test_error" time="0.000">
+      <failure message="Exception: error">def test_error():
+        &gt; raise Exception("error")
+        E Exception: error
+
+        tests/test_lib.py:32: Exception
+      </failure>
+    </testcase>
+    <testcase classname="tests.test_lib" name="test_with_record_property" time="0.000">
+      <properties>
+        <property name="example_key" value="1"/>
+      </properties>
+    </testcase>
+    <testcase classname="custom_classname" name="test_with_record_xml_attribute" time="0.000"/>
+  </testsuite>
+</testsuites>

__tests__/fixtures/python-xunit-unittest.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite name="TestAcme-20251114214921" tests="8" file=".py" time="0.001" timestamp="2025-11-14T21:49:22" failures="1" errors="1" skipped="2">
+  <testcase classname="TestAcme" name="test_always_pass" time="0.000" timestamp="2025-11-14T21:49:22" file="tests/test_lib.py" line="8"/>
+  <testcase classname="TestAcme" name="test_parameterized_0_param1" time="0.001" timestamp="2025-11-14T21:49:22" file="tests/test_lib.py" line="618"/>
+  <testcase classname="TestAcme" name="test_parameterized_1_param2" time="0.000" timestamp="2025-11-14T21:49:22" file="tests/test_lib.py" line="618"/>
+  <testcase classname="TestAcme" name="test_with_subtests" time="0.000" timestamp="2025-11-14T21:49:22" file="tests/test_lib.py" line="11"/>
+  <testcase classname="TestAcme" name="test_always_fail" time="0.000" timestamp="2025-11-14T21:49:22" file="tests/test_lib.py" line="23">
+    <failure type="AssertionError" message="failed"><![CDATA[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
+]]></failure>
+  </testcase>
+  <testcase classname="TestAcme" name="test_error" time="0.000" timestamp="2025-11-14T21:49:22" file="tests/test_lib.py" line="30">
+    <error type="Exception" message="error"><![CDATA[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
+]]></error>
+  </testcase>
+  <testcase classname="TestAcme" name="test_always_skip" time="0.000" timestamp="2025-11-14T21:49:22" file="tests/test_lib.py" line="20">
+    <skipped type="skip" message="skipped"/>
+  </testcase>
+  <testcase classname="TestAcme" name="test_expected_failure" time="0.000" timestamp="2025-11-14T21:49:22" file="tests/test_lib.py" line="26">
+    <skipped type="XFAIL" message="expected failure: (&lt;class 'AssertionError'&gt;, AssertionError('expected failure'), &lt;traceback object at 0x100c125c0&gt;)"/>
+  </testcase>
+</testsuite>

__tests__/python-xunit.test.ts

@@ -0,0 +1,93 @@
+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'
+
+const defaultOpts: ParseOptions = {
+  parseErrors: true,
+  trackedFiles: []
+}
+
+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'})
+  const outputPath = path.join(__dirname, '__outputs__', 'python-xunit-unittest.md')
+
+  it('report from python test results matches snapshot', async () => {
+    const trackedFiles = ['tests/test_lib.py']
+    const opts: ParseOptions = {
+      ...defaultOpts,
+      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 parser = new PythonXunitParser(defaultOpts)
+    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 parser = new PythonXunitParser(defaultOpts)
+    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 parser = new PythonXunitParser(defaultOpts)
+    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/)
+  })
+})
+
+describe('python-xunit pytest report', () => {
+  const fixturePath = path.join(__dirname, 'fixtures', 'python-xunit-pytest.xml')
+  const filePath = normalizeFilePath(path.relative(__dirname, fixturePath))
+  const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'})
+  const outputPath = path.join(__dirname, '__outputs__', 'python-xunit-pytest.md')
+
+  it('report from python test results matches snapshot', async () => {
+    const trackedFiles = ['tests/test_lib.py']
+    const opts: ParseOptions = {
+      ...defaultOpts,
+      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)
+  })
+})

action.yml

@@ -32,6 +32,7 @@ inputs:
         - java-junit
         - jest-junit
         - mocha-json
+        - python-xunit
         - rspec-json
         - swift-xunit
     required: true

dist/licenses.txt

@@ -1350,48 +1350,62 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 
 sax
-ISC
+BlueOak-1.0.0
-The ISC License
+# Blue Oak Model License
 
-Copyright (c) Isaac Z. Schlueter and Contributors
+Version 1.0.0
 
-Permission to use, copy, modify, and/or distribute this software for any
+## Purpose
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
 
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+This license gives everyone as much permission to work with
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+this software as possible, while protecting contributors
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+from liability.
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
-IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-====
+## Acceptance
 
-`String.fromCodePoint` by Mathias Bynens used according to terms of MIT
+In order to receive this license, you must agree to its
-License, as follows:
+rules.  The rules of this license are both obligations
+under that agreement and conditions to your license.
+You must not do anything with this software that triggers
+a rule that you cannot or will not follow.
 
-    Copyright Mathias Bynens <https://mathiasbynens.be/>
+## Copyright
 
-    Permission is hereby granted, free of charge, to any person obtaining
+Each contributor licenses you to do everything with this
-    a copy of this software and associated documentation files (the
+software that would otherwise infringe that contributor's
-    "Software"), to deal in the Software without restriction, including
+copyright in it.
-    without limitation the rights to use, copy, modify, merge, publish,
-    distribute, sublicense, and/or sell copies of the Software, and to
-    permit persons to whom the Software is furnished to do so, subject to
-    the following conditions:
 
-    The above copyright notice and this permission notice shall be
+## Notices
-    included in all copies or substantial portions of the Software.
 
-    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+You must ensure that everyone who gets a copy of
-    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+any part of this software from you, with or without
-    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+changes, also gets the text of this license or a link to
-    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+<https://blueoakcouncil.org/license/1.0.0>.
-    LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+
-    OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+## Excuse
-    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+If anyone notifies you in writing that you have not
+complied with [Notices](#notices), you can keep your
+license by taking all practical steps to comply within 30
+days after the notice.  If you do not do so, your license
+ends immediately.
+
+## Patent
+
+Each contributor licenses you to do everything with this
+software that would otherwise infringe any patent claims
+they can license or become able to license.
+
+## Reliability
+
+No contributor can revoke this license.
+
+## No Liability
+
+***As far as the law allows, this software comes as is,
+without any warranty or condition, and no contributor
+will be liable to anyone for any damages related to this
+software or this license, under any kind of legal claim.***
 
 
 to-regex-range

package-lock.json

@@ -7580,9 +7580,10 @@
       }
     },
     "node_modules/sax": {
-      "version": "1.2.4",
+      "version": "1.4.3",
-      "resolved": "https://registry.npmjs.org/sax/-/sax-1.2.4.tgz",
+      "resolved": "https://registry.npmjs.org/sax/-/sax-1.4.3.tgz",
-      "integrity": "sha512-NqVDv9TpANUjFm0N8uM5GxL36UgKi9/atZw+x7YFnQ8ckwFGKrl4xX4yWtrey3UJm5nP1kUbnYgLopqWNSRhWw=="
+      "integrity": "sha512-yqYn1JhPczigF94DMS+shiDMjDowYO6y9+wB/4WgO0Y19jWYk0lQ4tuG5KI7kj4FTp1wxPj5IFfcrz/s1c3jjQ==",
+      "license": "BlueOak-1.0.0"
     },
     "node_modules/semver": {
       "version": "7.7.3",

package.json

@@ -69,6 +69,9 @@
     "ts-jest": "^29.4.5",
     "typescript": "^5.9.3"
   },
+  "overrides": {
+    "sax": "^1.4.3"
+  },
   "jest-junit": {
     "suiteName": "jest tests",
     "outputDirectory": "__tests__/__results__",

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':

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)
+  }
+}