unittest-xml-reporting is a unittest test runner that can save test results to XML files that can be consumed by a wide range of tools, such as build systems, IDEs and continuous integration servers.
If you find a bug the best way to have it fixed is to fix it yourself and to make a pull request.
If you want you can even get direct access to the repository, is always better to have more than one maintainer.
- Python 2.7+
The easiest way to install unittest-xml-reporting is via Pip:
$ pip install unittest-xml-reporting
If you use Git and want to get the latest development version:
$ git clone git://github.com/danielfm/unittest-xml-reporting.git $ cd unittest-xml-reporting $ sudo python setup.py install
Or get the latest development version as a tarball:
$ wget http://github.com/danielfm/unittest-xml-reporting/tarball/master $ tar zxf danielfm-unittest-xml-reporting-XXXXXXXXXXXXXXXX.tar.gz $ cd danielfm-unittest-xml-reporting-XXXXXXXXXXXXXXXX $ sudo python setup.py install
The script below, adapted from the
unittest, 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:
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'))
In order to plug
XMLTestRunner to a Django project, add the following
TEST_RUNNER = 'xmlrunner.extra.djangotestrunner.XMLTestRunner'
Also, the following settings are provided so you can fine tune the reports:
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
If your test methods contains docstrings, you can display such docstrings
instead of display the test name (ex:
order to use this feature, you have to enable verbose output by setting
TEST_OUTPUT_VERBOSE = 2.
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.