def configure(self, options, config):
"""Configures the xunit plugin."""
Plugin.configure(self, options, config)
self.config = config
if self.enabled:
self.jinja = Environment(loader=FileSystemLoader(
os.path.dirname(options.html_template)),
trim_blocks=True,
lstrip_blocks=True)
self.stats = {
'errors': 0,
'failures': 0,
'passes': 0,
'skipped': 0
}
self.report_data = defaultdict(Group)
htmlfile_dirname = os.path.dirname(options.html_file)
if not os.path.exists(os.path.abspath(htmlfile_dirname)):
os.makedirs(htmlfile_dirname)
self.report_file = codecs.open(options.html_file, 'w',
self.encoding, 'replace')
self.report_template_filename = options.html_template
def configure(self, options, config):
"""Configures the xunit plugin."""
Plugin.configure(self, options, config)
self.config = config
if self.enabled:
self.jinja = Environment(
loader=FileSystemLoader(os.path.dirname(options.html_template)),
trim_blocks=True,
lstrip_blocks=True
)
self.stats = {'errors': 0, 'failures': 0, 'passes': 0, 'skipped': 0}
self.report_data = defaultdict(Group)
htmlfile_dirname = os.path.dirname(options.html_file)
if not os.path.exists(os.path.abspath(htmlfile_dirname)):
os.makedirs(htmlfile_dirname)
self.report_file = codecs.open(options.html_file, 'w', self.encoding, 'replace')
self.report_template_filename = options.html_template
class HtmlReport(Plugin):
"""
Output test results as pretty html.
"""
name = 'html'
score = 2000
encoding = 'UTF-8'
report_file = None
# stdout0 = None
# stderr0 = None
# outputBuffer = None
def __init__(self, verbosity=1):
super(HtmlReport, self).__init__()
self.global_stdout0 = None
self.global_stderr0 = None
self.test_stdout0 = None
self.test_stderr0 = None
self.testOutputBuffer = StringIO.StringIO()
self.globalOutputBuffer = StringIO.StringIO()
self.stdout_redirector = OutputRedirector(sys.stdout)
self.stderr_redirector = OutputRedirector(sys.stderr)
self.test_stdout_redirector = OutputRedirector(sys.stdout)
self.test_stderr_redirector = OutputRedirector(sys.stderr)
self.verbosity = verbosity
def startTest(self, test):
# just one buffer for both stdout and stderr
self.testOutputBuffer = StringIO.StringIO()
self.test_stdout_redirector.fp = self.testOutputBuffer
self.test_stderr_redirector.fp = self.testOutputBuffer
self.test_stdout0 = sys.stdout
self.test_stderr0 = sys.stderr
sys.stdout = self.test_stdout_redirector
sys.stderr = self.test_stderr_redirector
self.test_start_time = datetime.now()
def complete_test_output(self, err_msg='', traceback=''):
"""
Disconnect output redirection and return buffer.
Safe to call multiple times.
"""
if self.test_stdout0:
sys.stdout = self.test_stdout0
sys.stderr = self.test_stderr0
self.test_stdout0 = None
self.test_stderr0 = None
self.globalOutputBuffer.write(self.testOutputBuffer.getvalue())
self.globalOutputBuffer.write(err_msg)
self.globalOutputBuffer.write(traceback)
return self.testOutputBuffer.getvalue()
def begin(self):
# just one buffer for both stdout and stderr
# self.outputBuffer = StringIO.StringIO()
self.stdout_redirector.fp = self.globalOutputBuffer
self.stderr_redirector.fp = self.globalOutputBuffer
self.global_stdout0 = sys.stdout
self.global_stderr0 = sys.stderr
sys.stdout = self.stdout_redirector
sys.stderr = self.stderr_redirector
def complete_global_output(self):
"""
Disconnect output redirection and return buffer.
Safe to call multiple times.
"""
if self.global_stdout0:
sys.stdout = self.global_stdout0
sys.stderr = self.global_stderr0
self.global_stdout0 = None
self.global_stderr0 = None
return self.globalOutputBuffer.getvalue()
def options(self, parser, env):
"""Sets additional command line options."""
Plugin.options(self, parser, env)
parser.add_option('--html-report',
action='store',
dest='html_file',
metavar="FILE",
default=env.get('NOSE_HTML_FILE', 'nosetests.html'),
help="Path to html file to store the report in. "
"Default is nosetests.html in the working directory "
"[NOSE_HTML_FILE]")
parser.add_option(
'--html-report-template',
action='store',
dest='html_template',
metavar="FILE",
default=env.get(
'NOSE_HTML_TEMPLATE_FILE',
os.path.join(os.path.dirname(__file__), "templates",
"report2.jinja2")),
help="Path to html template file in with jinja2 format."
"Default is report.html in the lib sources"
"[NOSE_HTML_TEMPLATE_FILE]")
def configure(self, options, config):
"""Configures the xunit plugin."""
Plugin.configure(self, options, config)
self.config = config
if self.enabled:
self.jinja = Environment(loader=FileSystemLoader(
os.path.dirname(options.html_template)),
trim_blocks=True,
lstrip_blocks=True)
self.stats = {
'errors': 0,
'failures': 0,
'passes': 0,
'skipped': 0
}
self.report_data = defaultdict(Group)
htmlfile_dirname = os.path.dirname(options.html_file)
if not os.path.exists(os.path.abspath(htmlfile_dirname)):
os.makedirs(htmlfile_dirname)
self.report_file = codecs.open(options.html_file, 'w',
self.encoding, 'replace')
self.report_template_filename = options.html_template
def report(self, stream):
"""Writes an Xunit-formatted XML file
The file includes a report of test errors and failures.
"""
self.stats['total'] = sum(self.stats.values())
for group in self.report_data.values():
group.stats['total'] = sum(group.stats.values())
self.report_file.write(
self.jinja.get_template(
os.path.basename(self.report_template_filename)).render(
report=self.report_data,
stats=self.stats,
rawoutput=self._format_output(
self.complete_global_output())))
self.report_file.close()
if self.config.verbosity > 1:
stream.writeln("-" * 70)
stream.writeln("HTML: %s" % self.report_file.name)
def addSuccess(self, test):
name = id_split(test.id())
group = self.report_data[name[0]]
self.stats['passes'] += 1
group.stats['passes'] += 1
group.tests.append({
'name':
name[-1],
'failed':
False,
'output':
self._format_output(self.complete_test_output()),
'shortDescription':
test.shortDescription(),
'time':
str(datetime.now() - self.test_start_time),
})
def addError(self, test, err, capt=None):
"""Add error output to Xunit report.
"""
exc_type, exc_val, tb = err
tb = ''.join(
traceback.format_exception(
exc_type, exc_val
if isinstance(exc_val, exc_type) else exc_type(exc_val), tb))
name = id_split(test.id())
group = self.report_data[name[0]]
if issubclass(err[0], SkipTest):
type = 'skipped'
self.stats['skipped'] += 1
group.stats['skipped'] += 1
else:
type = 'error'
self.stats['errors'] += 1
group.stats['errors'] += 1
group.tests.append({
'name':
name[-1],
'failed':
True,
'type':
type,
'errtype':
nice_classname(err[0]),
'message':
exc_message(err),
'tb':
self._format_output(tb),
'output':
self._format_output(self.complete_test_output(
exc_message(err), tb)),
'shortDescription':
test.shortDescription(),
'time':
str(datetime.now() - self.test_start_time),
})
def addFailure(self, test, err, capt=None):
"""Add failure output to Xunit report.
"""
exc_type, exc_val, tb = err
tb = ''.join(
traceback.format_exception(
exc_type, exc_val
if isinstance(exc_val, exc_type) else exc_type(exc_val), tb))
name = id_split(test.id())
group = self.report_data[name[0]]
self.stats['failures'] += 1
group.stats['failures'] += 1
group.tests.append({
'name':
name[-1],
'failed':
True,
'errtype':
nice_classname(err[0]),
'message':
exc_message(err),
'tb':
self._format_output(tb),
'output':
self._format_output(self.complete_test_output(
exc_message(err), tb)),
'shortDescription':
test.shortDescription(),
'time':
str(datetime.now() - self.test_start_time),
})
def _format_output(self, o):
if isinstance(o, str):
return o.decode('latin-1')
else:
return o
class HtmlReport(Plugin):
"""
Output test results as pretty html.
"""
name = 'html'
score = 2000
encoding = 'UTF-8'
report_file = None
# stdout0 = None
# stderr0 = None
# outputBuffer = None
def __init__(self, verbosity=1):
super(HtmlReport, self).__init__()
self.global_stdout0 = None
self.global_stderr0 = None
self.test_stdout0 = None
self.test_stderr0 = None
self.testOutputBuffer = StringIO.StringIO()
self.globalOutputBuffer = StringIO.StringIO()
self.stdout_redirector = OutputRedirector(sys.stdout)
self.stderr_redirector = OutputRedirector(sys.stderr)
self.test_stdout_redirector = OutputRedirector(sys.stdout)
self.test_stderr_redirector = OutputRedirector(sys.stderr)
self.verbosity = verbosity
def startTest(self, test):
# just one buffer for both stdout and stderr
self.testOutputBuffer = StringIO.StringIO()
self.test_stdout_redirector.fp = self.testOutputBuffer
self.test_stderr_redirector.fp = self.testOutputBuffer
self.test_stdout0 = sys.stdout
self.test_stderr0 = sys.stderr
sys.stdout = self.test_stdout_redirector
sys.stderr = self.test_stderr_redirector
self.test_start_time = datetime.now()
def complete_test_output(self, err_msg='', traceback=''):
"""
Disconnect output redirection and return buffer.
Safe to call multiple times.
"""
if self.test_stdout0:
sys.stdout = self.test_stdout0
sys.stderr = self.test_stderr0
self.test_stdout0 = None
self.test_stderr0 = None
self.globalOutputBuffer.write(self.testOutputBuffer.getvalue())
self.globalOutputBuffer.write(err_msg)
self.globalOutputBuffer.write(traceback)
return self.testOutputBuffer.getvalue()
def begin(self):
# just one buffer for both stdout and stderr
# self.outputBuffer = StringIO.StringIO()
self.stdout_redirector.fp = self.globalOutputBuffer
self.stderr_redirector.fp = self.globalOutputBuffer
self.global_stdout0 = sys.stdout
self.global_stderr0 = sys.stderr
sys.stdout = self.stdout_redirector
sys.stderr = self.stderr_redirector
def complete_global_output(self):
"""
Disconnect output redirection and return buffer.
Safe to call multiple times.
"""
if self.global_stdout0:
sys.stdout = self.global_stdout0
sys.stderr = self.global_stderr0
self.global_stdout0 = None
self.global_stderr0 = None
return self.globalOutputBuffer.getvalue()
def options(self, parser, env):
"""Sets additional command line options."""
Plugin.options(self, parser, env)
parser.add_option(
'--html-report', action='store',
dest='html_file', metavar="FILE",
default=env.get('NOSE_HTML_FILE', 'nosetests.html'),
help="Path to html file to store the report in. "
"Default is nosetests.html in the working directory "
"[NOSE_HTML_FILE]")
parser.add_option(
'--html-report-template', action='store',
dest='html_template', metavar="FILE",
default=env.get('NOSE_HTML_TEMPLATE_FILE',
os.path.join(os.path.dirname(__file__), "templates", "report2.jinja2")),
help="Path to html template file in with jinja2 format."
"Default is report.html in the lib sources"
"[NOSE_HTML_TEMPLATE_FILE]")
def configure(self, options, config):
"""Configures the xunit plugin."""
Plugin.configure(self, options, config)
self.config = config
if self.enabled:
self.jinja = Environment(
loader=FileSystemLoader(os.path.dirname(options.html_template)),
trim_blocks=True,
lstrip_blocks=True
)
self.stats = {'errors': 0, 'failures': 0, 'passes': 0, 'skipped': 0}
self.report_data = defaultdict(Group)
htmlfile_dirname = os.path.dirname(options.html_file)
if not os.path.exists(os.path.abspath(htmlfile_dirname)):
os.makedirs(htmlfile_dirname)
self.report_file = codecs.open(options.html_file, 'w', self.encoding, 'replace')
self.report_template_filename = options.html_template
def report(self, stream):
"""Writes an Xunit-formatted XML file
The file includes a report of test errors and failures.
"""
self.stats['total'] = sum(self.stats.values())
for group in self.report_data.values():
group.stats['total'] = sum(group.stats.values())
self.report_file.write(self.jinja.get_template(os.path.basename(self.report_template_filename)).render(
report=self.report_data,
stats=self.stats,
rawoutput=self._format_output(self.complete_global_output())
))
self.report_file.close()
if self.config.verbosity > 1:
stream.writeln("-" * 70)
stream.writeln("HTML: %s" % self.report_file.name)
def addSuccess(self, test):
name = id_split(test.id())
group = self.report_data[name[0]]
self.stats['passes'] += 1
group.stats['passes'] += 1
group.tests.append({
'name': name[-1],
'failed': False,
'output': self._format_output(self.complete_test_output()),
'shortDescription': test.shortDescription(),
'time': str(datetime.now() - self.test_start_time),
})
def addError(self, test, err, capt=None):
"""Add error output to Xunit report.
"""
exc_type, exc_val, tb = err
tb = ''.join(traceback.format_exception(
exc_type,
exc_val if isinstance(exc_val, exc_type) else exc_type(exc_val),
tb
))
name = id_split(test.id())
group = self.report_data[name[0]]
if issubclass(err[0], SkipTest):
type = 'skipped'
self.stats['skipped'] += 1
group.stats['skipped'] += 1
else:
type = 'error'
self.stats['errors'] += 1
group.stats['errors'] += 1
group.tests.append({
'name': name[-1],
'failed': True,
'type': type,
'errtype': nice_classname(err[0]),
'message': exc_message(err),
'tb': self._format_output(tb),
'output': self._format_output(self.complete_test_output(exc_message(err), tb)),
'shortDescription': test.shortDescription(),
'time': str(datetime.now() - self.test_start_time),
})
def addFailure(self, test, err, capt=None):
"""Add failure output to Xunit report.
"""
exc_type, exc_val, tb = err
tb = ''.join(traceback.format_exception(
exc_type,
exc_val if isinstance(exc_val, exc_type) else exc_type(exc_val),
tb
))
name = id_split(test.id())
group = self.report_data[name[0]]
self.stats['failures'] += 1
group.stats['failures'] += 1
group.tests.append({
'name': name[-1],
'failed': True,
'errtype': nice_classname(err[0]),
'message': exc_message(err),
'tb': self._format_output(tb),
'output': self._format_output(self.complete_test_output(exc_message(err), tb)),
'shortDescription': test.shortDescription(),
'time': str(datetime.now() - self.test_start_time),
})
def _format_output(self, o):
if isinstance(o, str):
return o.decode('latin-1')
else:
return o
