pax_global_header00006660000000000000000000000064121501314550014507gustar00rootroot0000000000000052 comment=221b4a324cdfcb6d0f28b90a752b783e68d76e7a unittest-xml-reporting-1.5.0/000077500000000000000000000000001215013145500161765ustar00rootroot00000000000000unittest-xml-reporting-1.5.0/.gitignore000066400000000000000000000001331215013145500201630ustar00rootroot00000000000000# Python bytecode *.pyc # Build directory build/* dist/* # Egg info directory *.egg-info unittest-xml-reporting-1.5.0/LICENSE000066400000000000000000000167271215013145500172200ustar00rootroot00000000000000 GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library. unittest-xml-reporting-1.5.0/README.markdown000066400000000000000000000062451215013145500207060ustar00rootroot00000000000000# unittest-xml-reporting 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. ## Requirements * Python 2.5+ ## Installation The easiest way to install unittest-xml-reporting is via [EasyInstall](http://peak.telecommunity.com/DevCenter/EasyInstall). Follow [these instructions](http://pypi.python.org/pypi/setuptools) 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: ````bash $ sudo easy_install unittest-xml-reporting ```` If you use Git and want to get the latest *development* version: ````bash $ 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: ````bash $ 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 ```` ## 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 = range(10) 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, 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__': unittest.main(testRunner=xmlrunner.XMLTestRunner(output='test-reports')) ```` ### Django 1.2 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: **TEST_OUTPUT_VERBOSE** (Default: `1`) 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** (Default: `False`) 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 = 2`. **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. unittest-xml-reporting-1.5.0/setup.py000077500000000000000000000026701215013145500177200ustar00rootroot00000000000000#!/usr/bin/env python import os from setuptools import setup, find_packages # Load version information xmlrunner_version = os.path.join( os.path.abspath(os.path.dirname(__file__)), 'src', 'xmlrunner', 'version.py' ) exec(compile(open(xmlrunner_version).read(), xmlrunner_version, 'exec')) setup( name = 'unittest-xml-reporting', version = __version__, author = 'Daniel Fernandes Martins', author_email = 'daniel.tritone@gmail.com', description = 'PyUnit-based test runner with JUnit like XML reporting.', license = 'LGPL', platforms = ['Any'], keywords = ['pyunit', 'unittest', 'junit xml', 'report', 'testrunner'], url = 'http://github.com/danielfm/unittest-xml-reporting/tree/master/', classifiers = [ 'Development Status :: 5 - Production/Stable', 'Intended Audience :: Developers', 'License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)', 'Natural Language :: English', 'Operating System :: OS Independent', 'Programming Language :: Python', 'Programming Language :: Python :: 2', 'Programming Language :: Python :: 3', 'Topic :: Software Development :: Libraries :: Python Modules', 'Topic :: Software Development :: Testing' ], packages = find_packages('src'), package_dir = {'':'src'}, zip_safe = False, include_package_data = True, test_suite = 'xmlrunner.tests.testsuite' ) unittest-xml-reporting-1.5.0/src/000077500000000000000000000000001215013145500167655ustar00rootroot00000000000000unittest-xml-reporting-1.5.0/src/xmlrunner/000077500000000000000000000000001215013145500210175ustar00rootroot00000000000000unittest-xml-reporting-1.5.0/src/xmlrunner/__init__.py000066400000000000000000000324701215013145500231360ustar00rootroot00000000000000# -*- coding: utf-8 -*- """ This module provides the XMLTestRunner class, which is heavily based on the default TextTestRunner. """ import os import sys import time from unittest import TestResult, _TextTestResult, TextTestRunner try: # Removed in Python 3 from cStringIO import StringIO except ImportError: from io import StringIO # Allow version to be detected at runtime. from .version import __version__, __version_info__ class _DelegateIO(object): """ This class defines an object that captures whatever is written to a stream or file. """ def __init__(self, delegate): self._captured = StringIO() self.delegate = delegate def write(self, text): self._captured.write(text) self.delegate.write(text) def __getattr__(self, attr): return getattr(self._captured, attr) class _TestInfo(object): """ This class keeps useful information about the execution of a test method. """ # Possible test outcomes (SUCCESS, FAILURE, ERROR, SKIP) = range(4) def __init__(self, test_result, test_method, outcome=SUCCESS, err=None): self.test_result = test_result self.test_method = test_method self.outcome = outcome self.elapsed_time = 0 self.err = err def test_finished(self): """Save info that can only be calculated once a test has run. """ self.elapsed_time = \ self.test_result.stop_time - self.test_result.start_time def get_description(self): """ Return a text representation of the test method. """ return self.test_result.getDescription(self.test_method) def get_error_info(self): """ Return a text representation of an exception thrown by a test method. """ if not self.err: return '' return self.test_result._exc_info_to_string(self.err, self.test_method) class _XMLTestResult(_TextTestResult): """ A test result class that can express test results in a XML report. Used by XMLTestRunner. """ def __init__(self, stream=sys.stderr, descriptions=1, verbosity=1, elapsed_times=True): _TextTestResult.__init__(self, stream, descriptions, verbosity) self.successes = [] self.callback = None self.elapsed_times = elapsed_times def _prepare_callback(self, test_info, target_list, verbose_str, short_str): """ Appends a _TestInfo to the given target list and sets a callback method to be called by stopTest method. """ target_list.append(test_info) def callback(): """Prints the test method outcome to the stream, as well as the elapsed time. """ test_info.test_finished() # Ignore the elapsed times for a more reliable unit testing if not self.elapsed_times: self.start_time = self.stop_time = 0 if self.showAll: self.stream.writeln( '%s (%.3fs)' % (verbose_str, test_info.elapsed_time) ) elif self.dots: self.stream.write(short_str) self.callback = callback def startTest(self, test): """ Called before execute each test method. """ self.start_time = time.time() TestResult.startTest(self, test) if self.showAll: self.stream.write(' ' + self.getDescription(test)) self.stream.write(" ... ") def stopTest(self, test): """ Called after execute each test method. """ _TextTestResult.stopTest(self, test) self.stop_time = time.time() if self.callback and callable(self.callback): self.callback() self.callback = None def addSuccess(self, test): """ Called when a test executes successfully. """ self._prepare_callback( _TestInfo(self, test), self.successes, 'OK', '.' ) def addFailure(self, test, err): """ Called when a test method fails. """ self._prepare_callback( _TestInfo(self, test, _TestInfo.FAILURE, err), self.failures, 'FAIL', 'F' ) def addError(self, test, err): """ Called when a test method raises an error. """ self._prepare_callback( _TestInfo(self, test, _TestInfo.ERROR, err), self.errors, 'ERROR', 'E' ) def addSkip(self, test, err): """ Called when a test method was skipped. """ self._prepare_callback( _TestInfo(self, test, _TestInfo.SKIP, err), self.skipped, 'SKIP', 'S' ) def printErrorList(self, flavour, errors): """ Writes information about the FAIL or ERROR to the stream. """ for test_info in errors: self.stream.writeln(self.separator1) self.stream.writeln( '%s [%.3fs]: %s' % (flavour, test_info.elapsed_time, test_info.get_description()) ) self.stream.writeln(self.separator2) self.stream.writeln('%s' % test_info.get_error_info()) def _get_info_by_testcase(self, outsuffix): """ Organizes test results by TestCase module. This information is used during the report generation, where a XML report will be created for each TestCase. """ tests_by_testcase = {} for tests in (self.successes, self.failures, self.errors): for test_info in tests: testcase = type(test_info.test_method) # Ignore module name if it is '__main__' module = testcase.__module__ + '.' if module == '__main__.': module = '' testcase_name = module + testcase.__name__ if not testcase_name in tests_by_testcase: tests_by_testcase[testcase_name] = [] tests_by_testcase[testcase_name].append(test_info) return tests_by_testcase def _report_testsuite(suite_name, outsuffix, tests, xml_document): """ Appends the testsuite section to the XML document. """ testsuite = xml_document.createElement('testsuite') xml_document.appendChild(testsuite) testsuite.setAttribute('name', "%s-%s" % (suite_name, outsuffix)) testsuite.setAttribute('tests', str(len(tests))) testsuite.setAttribute( 'time', '%.3f' % sum(map(lambda e: e.elapsed_time, tests)) ) failures = filter(lambda e: e.outcome == _TestInfo.FAILURE, tests) testsuite.setAttribute('failures', str(len(list(failures)))) errors = filter(lambda e: e.outcome == _TestInfo.ERROR, tests) testsuite.setAttribute('errors', str(len(list(errors)))) return testsuite _report_testsuite = staticmethod(_report_testsuite) def _test_method_name(test_method): """ Returns the test method name. """ test_id = test_method.id() return test_id.split('.')[-1] _test_method_name = staticmethod(_test_method_name) def _report_testcase(suite_name, test_result, xml_testsuite, xml_document): """ Appends a testcase section to the XML document. """ testcase = xml_document.createElement('testcase') xml_testsuite.appendChild(testcase) testcase.setAttribute('classname', suite_name) testcase.setAttribute( 'name', _XMLTestResult._test_method_name(test_result.test_method) ) testcase.setAttribute('time', '%.3f' % test_result.elapsed_time) if (test_result.outcome != _TestInfo.SUCCESS): elem_name = ('failure', 'error')[test_result.outcome - 1] failure = xml_document.createElement(elem_name) testcase.appendChild(failure) failure.setAttribute('type', test_result.err[0].__name__) failure.setAttribute('message', str(test_result.err[1])) error_info = str(test_result.get_error_info()) failureText = xml_document.createCDATASection(error_info) failure.appendChild(failureText) _report_testcase = staticmethod(_report_testcase) def _report_output(test_runner, xml_testsuite, xml_document): """ Appends the system-out and system-err sections to the XML document. """ systemout = xml_document.createElement('system-out') xml_testsuite.appendChild(systemout) systemout_text = xml_document.createCDATASection(sys.stdout.getvalue()) systemout.appendChild(systemout_text) systemerr = xml_document.createElement('system-err') xml_testsuite.appendChild(systemerr) systemerr_text = xml_document.createCDATASection(sys.stderr.getvalue()) systemerr.appendChild(systemerr_text) _report_output = staticmethod(_report_output) def generate_reports(self, test_runner): """ Generates the XML reports to a given XMLTestRunner object. """ from xml.dom.minidom import Document all_results = self._get_info_by_testcase(test_runner.outsuffix) if (isinstance(test_runner.output, str) and not os.path.exists(test_runner.output)): os.makedirs(test_runner.output) for suite, tests in all_results.items(): doc = Document() # Build the XML file testsuite = _XMLTestResult._report_testsuite( suite, test_runner.outsuffix, tests, doc ) for test in tests: _XMLTestResult._report_testcase(suite, test, testsuite, doc) _XMLTestResult._report_output(test_runner, testsuite, doc) xml_content = doc.toprettyxml(indent='\t') if type(test_runner.output) is str: report_file = open( '%s%sTEST-%s-%s.xml' % ( test_runner.output, os.sep, suite, test_runner.outsuffix ), 'w' ) try: report_file.write(xml_content) finally: report_file.close() else: # Assume that test_runner.output is a stream test_runner.output.write(xml_content) class XMLTestRunner(TextTestRunner): """ A test runner class that outputs the results in JUnit like XML files. """ def __init__(self, output='.', outsuffix=None, stream=sys.stderr, descriptions=True, verbosity=1, elapsed_times=True): TextTestRunner.__init__(self, stream, descriptions, verbosity) self.verbosity = verbosity self.output = output if outsuffix: self.outsuffix = outsuffix else: self.outsuffix = time.strftime("%Y%m%d%H%M%S") self.elapsed_times = elapsed_times def _make_result(self): """ Creates a TestResult object which will be used to store information about the executed tests. """ return _XMLTestResult( self.stream, self.descriptions, self.verbosity, self.elapsed_times ) def _patch_standard_output(self): """ Replaces stdout and stderr streams with string-based streams in order to capture the tests' output. """ sys.stdout = _DelegateIO(sys.stdout) sys.stderr = _DelegateIO(sys.stderr) def _restore_standard_output(self): """ Restores stdout and stderr streams. """ sys.stdout = sys.stdout.delegate sys.stderr = sys.stderr.delegate def run(self, test): """ Runs the given test case or test suite. """ try: # Prepare the test execution self._patch_standard_output() result = self._make_result() # Print a nice header self.stream.writeln() self.stream.writeln('Running tests...') self.stream.writeln(result.separator2) # Execute tests start_time = time.time() test(result) stop_time = time.time() time_taken = stop_time - start_time # Print results result.printErrors() self.stream.writeln(result.separator2) run = result.testsRun self.stream.writeln("Ran %d test%s in %.3fs" % ( run, run != 1 and "s" or "", time_taken) ) self.stream.writeln() # Error traces if not result.wasSuccessful(): self.stream.write("FAILED (") failed, errored = (len(result.failures), len(result.errors)) if failed: self.stream.write("failures=%d" % failed) if errored: if failed: self.stream.write(", ") self.stream.write("errors=%d" % errored) self.stream.writeln(")") else: self.stream.writeln("OK") # Generate reports self.stream.writeln() self.stream.writeln('Generating XML reports...') result.generate_reports(self) finally: self._restore_standard_output() return result unittest-xml-reporting-1.5.0/src/xmlrunner/extra/000077500000000000000000000000001215013145500221425ustar00rootroot00000000000000unittest-xml-reporting-1.5.0/src/xmlrunner/extra/__init__.py000066400000000000000000000000001215013145500242410ustar00rootroot00000000000000unittest-xml-reporting-1.5.0/src/xmlrunner/extra/djangotestrunner.py000066400000000000000000000036631215013145500261200ustar00rootroot00000000000000# -*- coding: utf-8 -*- """ Custom Django test runner that runs the tests using the XMLTestRunner class. This script shows how to use the XMLTestRunner in a Django project. To learn how to configure a custom TestRunner in a Django project, please read the Django docs website. """ from django.conf import settings from django.test.simple import DjangoTestSuiteRunner from django.test.utils import setup_test_environment, teardown_test_environment import xmlrunner class XMLTestRunner(DjangoTestSuiteRunner): def run_tests(self, test_labels, extra_tests=None, **kwargs): """ Run the unit tests for all the test labels in the provided list. Labels must be of the form: - app.TestClass.test_method Run a single specific test method - app.TestClass Run all the test methods in a given class - app Search for doctests and unittests in the named application. When looking for tests, the test runner will look in the models and tests modules for the application. A list of 'extra' tests may also be provided; these tests will be added to the test suite. Returns the number of tests that failed. """ setup_test_environment() settings.DEBUG = False verbosity = getattr(settings, 'TEST_OUTPUT_VERBOSE', 1) if isinstance(verbosity, bool): verbosity = (1, 2)[verbosity] descriptions = getattr(settings, 'TEST_OUTPUT_DESCRIPTIONS', False) output = getattr(settings, 'TEST_OUTPUT_DIR', '.') suite = self.build_suite(test_labels, extra_tests) old_config = self.setup_databases() result = xmlrunner.XMLTestRunner( verbosity=verbosity, descriptions=descriptions, output=output).run(suite) self.teardown_databases(old_config) teardown_test_environment() return len(result.failures) + len(result.errors) unittest-xml-reporting-1.5.0/src/xmlrunner/tests/000077500000000000000000000000001215013145500221615ustar00rootroot00000000000000unittest-xml-reporting-1.5.0/src/xmlrunner/tests/__init__.py000066400000000000000000000000001215013145500242600ustar00rootroot00000000000000unittest-xml-reporting-1.5.0/src/xmlrunner/tests/testsuite.py000077500000000000000000000004341215013145500245700ustar00rootroot00000000000000#!/usr/bin/env python # -*- coding: utf-8 -*- """Executable module to test unittest-xml-reporting. """ import unittest import xmlrunner class XMLTestRunnerTestCase(unittest.TestCase): """XMLTestRunner test case. """ pass if __name__ == '__main__': unittest.main() unittest-xml-reporting-1.5.0/src/xmlrunner/version.py000066400000000000000000000005371215013145500230630ustar00rootroot00000000000000# -*- coding: utf-8 -*- """ xmlrunner.version ~~~~~~~~~~~~~~~~~ Runtime library version information. :codeauthor: :email:`Pedro Algarvio (pedro@algarvio.me)` :copyright: © 2013 Pedro Algarvio. :license: LGPL, see LICENSE for more details. """ __version_info__ = (1, 5, 0) __version__ = '.'.join(map(str, __version_info__))