Skip to main content

PyUnit-based test runner with JUnit like XML reporting.

Project description

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.

Author:Daniel Fernandes Martins <>
Company:Destaquenet Technology Solutions



The easiest way to install unittest-xml-reporting is via EasyInstall. Follow these instructions to install EasyInstall if you don’t have it already.

Then, execute the following command line to install the latest stable version of unittest-xml-reporting:

$ sudo easy_install unittest-xml-reporting

If you use Git and want to get the latest development version:

$ git clone git://
$ cd unittest-xml-reporting
$ sudo python install

Or get the latest development version as a tarball:

$ wget
$ tar zxf danielfm-unittest-xml-reporting-XXXXXXXXXXXXXXXX.tar.gz
$ cd danielfm-unittest-xml-reporting-XXXXXXXXXXXXXXXX
$ sudo python install


The script below, adapted from the unittest documentation, 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 = range(10)

    def test_shuffle(self):
        # make sure the shuffled sequence does not lose any elements
        self.assertEqual(self.seq, range(10))

    def test_choice(self):
        element = random.choice(self.seq)
        self.assert_(element in self.seq)

    def test_sample(self):
        self.assertRaises(ValueError, random.sample, self.seq, 20)
        for element in random.sample(self.seq, 5):
            self.assert_(element in self.seq)

if __name__ == '__main__':

Django 1.2

In order to plug XMLTestRunner to a Django project, add the following to your

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 non-verbose output.
If your test methods contains docstrings, you can display such docstrings instead of display the test name (ex: module.TestCase.test_method). In order to use this feature, you have to enable verbose output by setting TEST_OUTPUT_VERBOSE = True.
TEST_OUTPUT_DIR (Default: ".")
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.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
unittest_xml_reporting-1.3.2-py2.5.egg (21.6 kB) Copy SHA256 hash SHA256 Egg 2.5
unittest_xml_reporting-1.3.2-py2.6.egg (21.6 kB) Copy SHA256 hash SHA256 Egg 2.6
unittest-xml-reporting-1.3.2.tar.gz (11.8 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page