"""This plugin provides test results in the standard XUnit XML format.
It was designed for the `Hudson`_ continuous build system but will
probably work for anything else that understands an XUnit-formatted XML
representation of test results.
Add this shell command to your builder ::
nosetests --with-xunit
And by default a file named nosetests.xml will be written to the
working directory.
In a Hudson builder, tick the box named "Publish JUnit test result report"
under the Post-build Actions and enter this value for Test report XMLs::
**/nosetests.xml
If you need to change the name or location of the file, you can set the
``--xunit-file`` option.
Here is an abbreviated version of what an XML test report might look like::
Traceback (most recent call last):
...
TypeError: oops, wrong type
.. _Hudson: https://hudson.dev.java.net/
"""
import os
import traceback
import re
import inspect
from nose.plugins.base import Plugin
from nose.exc import SkipTest
from time import time
import doctest
def xmlsafe(s, encoding="utf-8"):
"""Used internally to escape XML."""
if isinstance(s, unicode):
s = s.encode(encoding)
s = str(s)
for src, rep in [('&', '&', ),
('<', '<', ),
('>', '>', ),
('"', '"', ),
("'", ''', ),
]:
s = s.replace(src, rep)
return s
def nice_classname(obj):
"""Returns a nice name for class object or class instance.
>>> nice_classname(Exception()) # doctest: +ELLIPSIS
'...Exception'
>>> nice_classname(Exception)
'exceptions.Exception'
"""
if inspect.isclass(obj):
cls_name = obj.__name__
else:
cls_name = obj.__class__.__name__
mod = inspect.getmodule(obj)
if mod:
name = mod.__name__
# jython
if name.startswith('org.python.core.'):
name = name[len('org.python.core.'):]
return "%s.%s" % (name, cls_name)
else:
return cls_name
class Xunit(Plugin):
"""This plugin provides test results in the standard XUnit XML format."""
name = 'xunit'
score = 2000
encoding = 'UTF-8'
def _timeTaken(self):
if hasattr(self, '_timer'):
taken = time() - self._timer
else:
# test died before it ran (probably error in setup())
# or success/failure added before test started probably
# due to custom TestResult munging
taken = 0.0
return taken
def _xmlsafe(self, s):
return xmlsafe(s, encoding=self.encoding)
def options(self, parser, env):
"""Sets additional command line options."""
Plugin.options(self, parser, env)
parser.add_option(
'--xunit-file', action='store',
dest='xunit_file', metavar="FILE",
default=env.get('NOSE_XUNIT_FILE', 'nosetests.xml'),
help=("Path to xml file to store the xunit report in. "
"Default is nosetests.xml in the working directory "
"[NOSE_XUNIT_FILE]"))
def configure(self, options, config):
"""Configures the xunit plugin."""
Plugin.configure(self, options, config)
self.config = config
if self.enabled:
self.stats = {'errors': 0,
'failures': 0,
'passes': 0,
'skipped': 0
}
self.errorlist = []
self.error_report_file = open(options.xunit_file, 'w')
def report(self, stream):
"""Writes an Xunit-formatted XML file
The file includes a report of test errors and failures.
"""
self.stats['encoding'] = self.encoding
self.stats['total'] = (self.stats['errors'] + self.stats['failures']
+ self.stats['passes'] + self.stats['skipped'])
self.error_report_file.write(
''
'' % self.stats)
self.error_report_file.write(''.join(self.errorlist))
self.error_report_file.write('')
self.error_report_file.close()
if self.config.verbosity > 1:
stream.writeln("-" * 70)
stream.writeln("XML: %s" % self.error_report_file.name)
def startTest(self, test):
"""Initializes a timer before starting a test."""
self._timer = time()
def addError(self, test, err, capt=None):
"""Add error output to Xunit report.
"""
taken = self._timeTaken()
if issubclass(err[0], SkipTest):
self.stats['skipped'] +=1
return
tb = ''.join(traceback.format_exception(*err))
self.stats['errors'] += 1
id = test.id()
self.errorlist.append(
''
'%(tb)s' %
{'cls': self._xmlsafe('.'.join(id.split('.')[:-1])),
'name': self._xmlsafe(id),
'errtype': self._xmlsafe(nice_classname(err[0])),
'tb': self._xmlsafe(tb),
'taken': taken,
})
def addFailure(self, test, err, capt=None, tb_info=None):
"""Add failure output to Xunit report.
"""
taken = self._timeTaken()
tb = ''.join(traceback.format_exception(*err))
self.stats['failures'] += 1
id = test.id()
self.errorlist.append(
''
'%(tb)s' %
{'cls': self._xmlsafe('.'.join(id.split('.')[:-1])),
'name': self._xmlsafe(id),
'errtype': self._xmlsafe(nice_classname(err[0])),
'tb': self._xmlsafe(tb),
'taken': taken,
})
def addSuccess(self, test, capt=None):
"""Add success output to Xunit report.
"""
taken = self._timeTaken()
self.stats['passes'] += 1
id = test.id()
self.errorlist.append(
'' %
{'cls': self._xmlsafe('.'.join(id.split('.')[:-1])),
'name': self._xmlsafe(id),
'taken': taken,
})