[](https://pypi.python.org/pypi/unittest-xml-reporting/)
[](https://pypi.python.org/pypi/unittest-xml-reporting/)
[](https://pypi.python.org/pypi/unittest-xml-reporting/)
[](http://unittest-xml-reporting.readthedocs.io/en/latest/?badge=latest)
[](https://codecov.io/github/xmlrunner/unittest-xml-reporting?branch=master)
[](https://coveralls.io/github/xmlrunner/unittest-xml-reporting?branch=master)
[](https://requires.io/github/xmlrunner/unittest-xml-reporting/requirements/?branch=master)
# unittest-xml-reporting (aka xmlrunner)
A unittest test runner that can save test results to XML files in xUnit format.
The files can be consumed by a wide range of tools, such as build systems, IDEs
and continuous integration servers.
## Requirements
* Python 3.7+
* Please note Python 3.6 end-of-life was in Dec 2021, last version supporting 3.6 was 3.1.0
* Please note Python 3.5 end-of-life was in Sep 2020, last version supporting 3.5 was 3.1.0
* Please note Python 2.7 end-of-life was in Jan 2020, last version supporting 2.7 was 2.5.2
* Please note Python 3.4 end-of-life was in Mar 2019, last version supporting 3.4 was 2.5.2
* Please note Python 2.6 end-of-life was in Oct 2013, last version supporting 2.6 was 1.14.0
## Limited support for `unittest.TestCase.subTest`
https://docs.python.org/3/library/unittest.html#unittest.TestCase.subTest
`unittest` has the concept of sub-tests for a `unittest.TestCase`; this doesn't map well to an existing xUnit concept, so you won't find it in the schema. What that means, is that you lose some granularity
in the reports for sub-tests.
`unittest` also does not report successful sub-tests, so the accounting won't be exact.
## Jenkins plugins
- Jenkins JUnit plugin : https://plugins.jenkins.io/junit/
- Jenkins xUnit plugin : https://plugins.jenkins.io/xunit/
### Jenkins JUnit plugin
This plugin does not perform XSD validation (at time of writing) and should parse the XML file without issues.
### Jenkins xUnit plugin version 1.100
- [Jenkins (junit-10.xsd), xunit plugin (2014-2018)](https://github.com/jenkinsci/xunit-plugin/blob/14c6e39c38408b9ed6280361484a13c6f5becca7/src/main/resources/org/jenkinsci/plugins/xunit/types/model/xsd/junit-10.xsd), version `1.100`.
This plugin does perfom XSD validation and uses the more lax XSD. This should parse the XML file without issues.
### Jenkins xUnit plugin version 1.104+
- [Jenkins (junit-10.xsd), xunit plugin (2018-current)](https://github.com/jenkinsci/xunit-plugin/blob/ae25da5089d4f94ac6c4669bf736e4d416cc4665/src/main/resources/org/jenkinsci/plugins/xunit/types/model/xsd/junit-10.xsd), version `1.104`+.
This plugin does perfom XSD validation and uses the more strict XSD.
See https://github.com/xmlrunner/unittest-xml-reporting/issues/209
```
import io
import unittest
import xmlrunner
# run the tests storing results in memory
out = io.BytesIO()
unittest.main(
testRunner=xmlrunner.XMLTestRunner(output=out),
failfast=False, buffer=False, catchbreak=False, exit=False)
```
Transform the results removing extra attributes.
```
from xmlrunner.extra.xunit_plugin import transform
with open('TEST-report.xml', 'wb') as report:
report.write(transform(out.getvalue()))
```
## JUnit Schema ?
There are many tools claiming to write JUnit reports, so you will find many schemas with minor differences.
We used the XSD that was available in the Jenkins xUnit plugin version `1.100`; a copy is available under `tests/vendor/jenkins/xunit-plugin/.../junit-10.xsd` (see attached license).
You may also find these resources useful:
- https://stackoverflow.com/questions/4922867/what-is-the-junit-xml-format-specification-that-hudson-supports
- https://stackoverflow.com/questions/11241781/python-unittests-in-jenkins
- [JUnit-Schema (JUnit.xsd)](https://github.com/windyroad/JUnit-Schema/blob/master/JUnit.xsd)
- [Windyroad (JUnit.xsd)](http://windyroad.com.au/dl/Open%20Source/JUnit.xsd)
- [a gist (Jenkins xUnit test result schema)](https://gist.github.com/erikd/4192748)
## Installation
The easiest way to install unittest-xml-reporting is via
[Pip](http://www.pip-installer.org):
````bash
$ pip install unittest-xml-reporting
````
If you use Git and want to get the latest *development* version:
````bash
$ git clone https://github.com/xmlrunner/unittest-xml-reporting.git
$ cd unittest-xml-reporting
$ sudo python setup.py install
````
Or get the latest *development* version as a tarball:
````bash
$ wget https://github.com/xmlrunner/unittest-xml-reporting/archive/master.zip
$ unzip master.zip
$ cd unittest-xml-reporting
$ sudo python setup.py install
````
Or you can manually download the latest released version from
[PyPI](https://pypi.python.org/pypi/unittest-xml-reporting/).
## Command-line
````bash
python -m xmlrunner [options]
python -m xmlrunner discover [options]
# help
python -m xmlrunner -h
````
e.g.
````bash
python -m xmlrunner discover -t ~/mycode/tests -o /tmp/build/junit-reports
````
## Usage
The script below, adapted from the
[unittest](http://docs.python.org/library/unittest.html), shows how to use
`XMLTestRunner` in a very simple way. In fact, the only difference between
this script and the original one is the last line:
````python
import random
import unittest
import xmlrunner
class TestSequenceFunctions(unittest.TestCase):
def setUp(self):
self.seq = list(range(10))
@unittest.skip("demonstrating skipping")
def test_skipped(self):
self.fail("shouldn't happen")
def test_shuffle(self):
# make sure the shuffled sequence does not lose any elements
random.shuffle(self.seq)
self.seq.sort()
self.assertEqual(self.seq, list(range(10)))
# should raise an exception for an immutable sequence
self.assertRaises(TypeError, random.shuffle, (1,2,3))
def test_choice(self):
element = random.choice(self.seq)
self.assertTrue(element in self.seq)
def test_sample(self):
with self.assertRaises(ValueError):
random.sample(self.seq, 20)
for element in random.sample(self.seq, 5):
self.assertTrue(element in self.seq)
if __name__ == '__main__':
unittest.main(
testRunner=xmlrunner.XMLTestRunner(output='test-reports'),
# these make sure that some options that are not applicable
# remain hidden from the help menu.
failfast=False, buffer=False, catchbreak=False)
````
### Reporting to a single file
````python
if __name__ == '__main__':
with open('/path/to/results.xml', 'wb') as output:
unittest.main(
testRunner=xmlrunner.XMLTestRunner(output=output),
failfast=False, buffer=False, catchbreak=False)
````
### Doctest support
The XMLTestRunner can also be used to report on docstrings style tests.
````python
import doctest
import xmlrunner
def twice(n):
"""
>>> twice(5)
10
"""
return 2 * n
class Multiplicator(object):
def threetimes(self, n):
"""
>>> Multiplicator().threetimes(5)
15
"""
return 3 * n
if __name__ == "__main__":
suite = doctest.DocTestSuite()
xmlrunner.XMLTestRunner().run(suite)
````
### Django support
In order to plug `XMLTestRunner` to a Django project, add the following
to your `settings.py`:
````python
TEST_RUNNER = 'xmlrunner.extra.djangotestrunner.XMLTestRunner'
````
Also, the following settings are provided so you can fine tune the reports:
|setting|default|values|description|
|-|-|-|-|
|`TEST_OUTPUT_VERBOSE`|`1`|`0\|1\|2`|Besides the XML reports generated by the test runner, a bunch of useful information is printed to the `sys.stderr` stream, just like the `TextTestRunner` does. Use this setting to choose between a verbose and a non-verbose output.|
|`TEST_OUTPUT_DESCRIPTIONS`|`False`|`True\|False`|If your test methods contains docstrings, you can display such docstrings instead of display the test name (ex: `module.TestCase.test_method`).<br>In order to use this feature, you have to enable verbose output by setting `TEST_OUTPUT_VERBOSE = 2`.<br>Only effects stdout and not XML output.|
|`TEST_OUTPUT_DIR`|`"."`|`<str>`|Tells the test runner where to put the XML reports. If the directory couldn't be found, the test runner will try to create it before generate the XML files.|
|`TEST_OUTPUT_FILE_NAME`|`None`|`<str>`|Tells the test runner to output a single XML report with this filename under `os.path.join(TEST_OUTPUT_DIR, TEST_OUTPUT_FILE_NAME)`.<br>Please note that for long running tests, this will keep the results in memory for a longer time than multiple reports, and may use up more resources.|
## Contributing
We are always looking for good contributions, so please just fork the
repository and send pull requests (with tests!).
If you would like write access to the repository, or become a maintainer,
feel free to get in touch.
### Testing changes with `tox`
Please use `tox` to test your changes before sending a pull request.
You can find more information about `tox` at <https://testrun.org/tox/latest/>.
```bash
$ pip install tox
# basic sanity test, friendly output
$ tox -e pytest
# all combinations
$ tox
```
Raw data
{
"_id": null,
"home_page": "http://github.com/xmlrunner/unittest-xml-reporting/tree/master/",
"name": "unittest-xml-reporting",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "pyunit,unittest,junit xml,xunit,report,testrunner,xmlrunner",
"author": "Daniel Fernandes Martins, Damien Nozay",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/ed/40/3bf1afc96e93c7322520981ac4593cbb29daa21b48d32746f05ab5563dca/unittest-xml-reporting-3.2.0.tar.gz",
"platform": "Any",
"description": "[](https://pypi.python.org/pypi/unittest-xml-reporting/)\n[](https://pypi.python.org/pypi/unittest-xml-reporting/)\n[](https://pypi.python.org/pypi/unittest-xml-reporting/)\n[](http://unittest-xml-reporting.readthedocs.io/en/latest/?badge=latest)\n\n[](https://codecov.io/github/xmlrunner/unittest-xml-reporting?branch=master)\n[](https://coveralls.io/github/xmlrunner/unittest-xml-reporting?branch=master)\n[](https://requires.io/github/xmlrunner/unittest-xml-reporting/requirements/?branch=master)\n\n# unittest-xml-reporting (aka xmlrunner)\n\nA unittest test runner that can save test results to XML files in xUnit format.\nThe files can be consumed by a wide range of tools, such as build systems, IDEs\nand continuous integration servers.\n\n\n## Requirements\n\n* Python 3.7+\n* Please note Python 3.6 end-of-life was in Dec 2021, last version supporting 3.6 was 3.1.0\n* Please note Python 3.5 end-of-life was in Sep 2020, last version supporting 3.5 was 3.1.0\n* Please note Python 2.7 end-of-life was in Jan 2020, last version supporting 2.7 was 2.5.2\n* Please note Python 3.4 end-of-life was in Mar 2019, last version supporting 3.4 was 2.5.2\n* Please note Python 2.6 end-of-life was in Oct 2013, last version supporting 2.6 was 1.14.0\n\n\n## Limited support for `unittest.TestCase.subTest`\n\nhttps://docs.python.org/3/library/unittest.html#unittest.TestCase.subTest\n\n`unittest` has the concept of sub-tests for a `unittest.TestCase`; this doesn't map well to an existing xUnit concept, so you won't find it in the schema. What that means, is that you lose some granularity\nin the reports for sub-tests.\n\n`unittest` also does not report successful sub-tests, so the accounting won't be exact.\n\n## Jenkins plugins\n\n- Jenkins JUnit plugin : https://plugins.jenkins.io/junit/\n- Jenkins xUnit plugin : https://plugins.jenkins.io/xunit/\n\n### Jenkins JUnit plugin\n\nThis plugin does not perform XSD validation (at time of writing) and should parse the XML file without issues.\n\n### Jenkins xUnit plugin version 1.100\n\n- [Jenkins (junit-10.xsd), xunit plugin (2014-2018)](https://github.com/jenkinsci/xunit-plugin/blob/14c6e39c38408b9ed6280361484a13c6f5becca7/src/main/resources/org/jenkinsci/plugins/xunit/types/model/xsd/junit-10.xsd), version `1.100`.\n\nThis plugin does perfom XSD validation and uses the more lax XSD. This should parse the XML file without issues.\n\n### Jenkins xUnit plugin version 1.104+\n\n- [Jenkins (junit-10.xsd), xunit plugin (2018-current)](https://github.com/jenkinsci/xunit-plugin/blob/ae25da5089d4f94ac6c4669bf736e4d416cc4665/src/main/resources/org/jenkinsci/plugins/xunit/types/model/xsd/junit-10.xsd), version `1.104`+.\n\nThis plugin does perfom XSD validation and uses the more strict XSD.\n\nSee https://github.com/xmlrunner/unittest-xml-reporting/issues/209\n\n```\nimport io\nimport unittest\nimport xmlrunner\n\n# run the tests storing results in memory\nout = io.BytesIO()\nunittest.main(\n testRunner=xmlrunner.XMLTestRunner(output=out),\n failfast=False, buffer=False, catchbreak=False, exit=False)\n```\n\nTransform the results removing extra attributes.\n```\nfrom xmlrunner.extra.xunit_plugin import transform\n\nwith open('TEST-report.xml', 'wb') as report:\n report.write(transform(out.getvalue()))\n\n```\n\n## JUnit Schema ?\n\nThere are many tools claiming to write JUnit reports, so you will find many schemas with minor differences.\n\nWe used the XSD that was available in the Jenkins xUnit plugin version `1.100`; a copy is available under `tests/vendor/jenkins/xunit-plugin/.../junit-10.xsd` (see attached license).\n\nYou may also find these resources useful:\n\n- https://stackoverflow.com/questions/4922867/what-is-the-junit-xml-format-specification-that-hudson-supports\n- https://stackoverflow.com/questions/11241781/python-unittests-in-jenkins\n- [JUnit-Schema (JUnit.xsd)](https://github.com/windyroad/JUnit-Schema/blob/master/JUnit.xsd)\n- [Windyroad (JUnit.xsd)](http://windyroad.com.au/dl/Open%20Source/JUnit.xsd)\n- [a gist (Jenkins xUnit test result schema)](https://gist.github.com/erikd/4192748)\n\n\n## Installation\n\nThe easiest way to install unittest-xml-reporting is via\n[Pip](http://www.pip-installer.org):\n\n````bash\n$ pip install unittest-xml-reporting\n````\n\nIf you use Git and want to get the latest *development* version:\n\n````bash\n$ git clone https://github.com/xmlrunner/unittest-xml-reporting.git\n$ cd unittest-xml-reporting\n$ sudo python setup.py install\n````\n\nOr get the latest *development* version as a tarball:\n\n````bash\n$ wget https://github.com/xmlrunner/unittest-xml-reporting/archive/master.zip\n$ unzip master.zip\n$ cd unittest-xml-reporting\n$ sudo python setup.py install\n````\n\nOr you can manually download the latest released version from\n[PyPI](https://pypi.python.org/pypi/unittest-xml-reporting/).\n\n\n## Command-line\n\n````bash\npython -m xmlrunner [options]\npython -m xmlrunner discover [options]\n\n# help\npython -m xmlrunner -h\n````\n\ne.g. \n````bash\npython -m xmlrunner discover -t ~/mycode/tests -o /tmp/build/junit-reports\n````\n\n## Usage\n\nThe script below, adapted from the\n[unittest](http://docs.python.org/library/unittest.html), shows how to use\n`XMLTestRunner` in a very simple way. In fact, the only difference between\nthis script and the original one is the last line:\n\n````python\nimport random\nimport unittest\nimport xmlrunner\n\nclass TestSequenceFunctions(unittest.TestCase):\n\n def setUp(self):\n self.seq = list(range(10))\n\n @unittest.skip(\"demonstrating skipping\")\n def test_skipped(self):\n self.fail(\"shouldn't happen\")\n\n def test_shuffle(self):\n # make sure the shuffled sequence does not lose any elements\n random.shuffle(self.seq)\n self.seq.sort()\n self.assertEqual(self.seq, list(range(10)))\n\n # should raise an exception for an immutable sequence\n self.assertRaises(TypeError, random.shuffle, (1,2,3))\n\n def test_choice(self):\n element = random.choice(self.seq)\n self.assertTrue(element in self.seq)\n\n def test_sample(self):\n with self.assertRaises(ValueError):\n random.sample(self.seq, 20)\n for element in random.sample(self.seq, 5):\n self.assertTrue(element in self.seq)\n\nif __name__ == '__main__':\n unittest.main(\n testRunner=xmlrunner.XMLTestRunner(output='test-reports'),\n # these make sure that some options that are not applicable\n # remain hidden from the help menu.\n failfast=False, buffer=False, catchbreak=False)\n````\n\n### Reporting to a single file\n\n````python\nif __name__ == '__main__':\n with open('/path/to/results.xml', 'wb') as output:\n unittest.main(\n testRunner=xmlrunner.XMLTestRunner(output=output),\n failfast=False, buffer=False, catchbreak=False)\n````\n\n### Doctest support\n\nThe XMLTestRunner can also be used to report on docstrings style tests.\n\n````python\nimport doctest\nimport xmlrunner\n\ndef twice(n):\n \"\"\"\n >>> twice(5)\n 10\n \"\"\"\n return 2 * n\n\nclass Multiplicator(object):\n def threetimes(self, n):\n \"\"\"\n >>> Multiplicator().threetimes(5)\n 15\n \"\"\"\n return 3 * n\n\nif __name__ == \"__main__\":\n suite = doctest.DocTestSuite()\n xmlrunner.XMLTestRunner().run(suite)\n````\n\n### Django support\n\nIn order to plug `XMLTestRunner` to a Django project, add the following\nto your `settings.py`:\n\n````python\nTEST_RUNNER = 'xmlrunner.extra.djangotestrunner.XMLTestRunner'\n````\n\nAlso, the following settings are provided so you can fine tune the reports:\n\n|setting|default|values|description|\n|-|-|-|-|\n|`TEST_OUTPUT_VERBOSE`|`1`|`0\\|1\\|2`|Besides the XML reports generated by the test runner, a bunch of useful information is printed to the `sys.stderr` stream, just like the `TextTestRunner` does. Use this setting to choose between a verbose and a non-verbose output.|\n|`TEST_OUTPUT_DESCRIPTIONS`|`False`|`True\\|False`|If your test methods contains docstrings, you can display such docstrings instead of display the test name (ex: `module.TestCase.test_method`).<br>In order to use this feature, you have to enable verbose output by setting `TEST_OUTPUT_VERBOSE = 2`.<br>Only effects stdout and not XML output.|\n|`TEST_OUTPUT_DIR`|`\".\"`|`<str>`|Tells the test runner where to put the XML reports. If the directory couldn't be found, the test runner will try to create it before generate the XML files.|\n|`TEST_OUTPUT_FILE_NAME`|`None`|`<str>`|Tells the test runner to output a single XML report with this filename under `os.path.join(TEST_OUTPUT_DIR, TEST_OUTPUT_FILE_NAME)`.<br>Please note that for long running tests, this will keep the results in memory for a longer time than multiple reports, and may use up more resources.|\n\n\n## Contributing\n\nWe are always looking for good contributions, so please just fork the\nrepository and send pull requests (with tests!).\n\nIf you would like write access to the repository, or become a maintainer,\nfeel free to get in touch.\n\n\n### Testing changes with `tox`\n\nPlease use `tox` to test your changes before sending a pull request.\nYou can find more information about `tox` at <https://testrun.org/tox/latest/>.\n\n```bash\n$ pip install tox\n\n# basic sanity test, friendly output\n$ tox -e pytest\n\n# all combinations\n$ tox\n```\n\n\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "unittest-based test runner with Ant/JUnit like XML reporting.",
"version": "3.2.0",
"split_keywords": [
"pyunit",
"unittest",
"junit xml",
"xunit",
"report",
"testrunner",
"xmlrunner"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3988f6e9b87428584a3c62cac768185c438ca6d561367a5d267b293259d76075",
"md5": "b40dbb6db271b259826b2c293bd3d4a9",
"sha256": "f3d7402e5b3ac72a5ee3149278339db1a8f932ee405f48bcb9c681372f2717d5"
},
"downloads": -1,
"filename": "unittest_xml_reporting-3.2.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "b40dbb6db271b259826b2c293bd3d4a9",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 20936,
"upload_time": "2022-01-20T19:09:53",
"upload_time_iso_8601": "2022-01-20T19:09:53.824818Z",
"url": "https://files.pythonhosted.org/packages/39/88/f6e9b87428584a3c62cac768185c438ca6d561367a5d267b293259d76075/unittest_xml_reporting-3.2.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ed403bf1afc96e93c7322520981ac4593cbb29daa21b48d32746f05ab5563dca",
"md5": "f12aeab63ff44e295526e103313d66c8",
"sha256": "edd8d3170b40c3a81b8cf910f46c6a304ae2847ec01036d02e9c0f9b85762d28"
},
"downloads": -1,
"filename": "unittest-xml-reporting-3.2.0.tar.gz",
"has_sig": false,
"md5_digest": "f12aeab63ff44e295526e103313d66c8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 18002,
"upload_time": "2022-01-20T19:09:55",
"upload_time_iso_8601": "2022-01-20T19:09:55.760232Z",
"url": "https://files.pythonhosted.org/packages/ed/40/3bf1afc96e93c7322520981ac4593cbb29daa21b48d32746f05ab5563dca/unittest-xml-reporting-3.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-01-20 19:09:55",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "unittest-xml-reporting"
}
JSON