#-- coding: utf-8 --
“”"
A TestRunner for use with the Python unit testing framework. It
generates a HTML report to show the result at a glance.
The simplest way to use this is to invoke its main method. E.g.
import unittest
import HTMLTestRunner
... define your tests ...
if __name__ == '__main__':
HTMLTestRunner.main()
For more customization options, instantiates a HTMLTestRunner object.
HTMLTestRunner is a counterpart to unittest’s TextTestRunner. E.g.
# output to a file
fp = file('my_report.html', 'wb')
runner = HTMLTestRunner.HTMLTestRunner(
stream=fp,
title='My unit test',
description='This demonstrates the report output by HTMLTestRunner.'
)
# Use an external stylesheet.
# See the Template_mixin class for more customizable options
runner.STYLESHEET_TMPL = ''
# run the test
runner.run(my_test_suite)
Copyright © 2004-2007, Wai Yip Tung
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS
IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
“”"
author = “Wai Yip Tung”
version = “0.8.3”
“”"
Change History
Version 0.8.4 by GoverSky
Version 0.8.3
Version 0.8.2
Version in 0.8.1
Version in 0.8.0
Version in 0.7.1
import datetime
import sys
import unittest
import copy
import threading
from xml.sax import saxutils
from functools import cmp_to_key
PY3K = (sys.version_info[0] > 2)
if PY3K:
import io as StringIO
else:
import StringIO
class OutputRedirector(object):
“”" Wrapper to redirect stdout or stderr “”"
def __init__(self, fp):
self.fp = fp
def write(self, s):
self.fp.write(s)
def writelines(self, lines):
self.fp.writelines(lines)
def flush(self):
self.fp.flush()
stdout_redirector = OutputRedirector(sys.stdout)
stderr_redirector = OutputRedirector(sys.stderr)
class Template_mixin(object):
“”"
Define a HTML template for report customerization and generation.
Overall structure of an HTML report
HTML
+------------------------+
| |
| |
| |
| STYLESHEET |
| +----------------+ |
| | | |
| +----------------+ |
| |
| |
| |
| |
| |
| HEADING |
| +----------------+ |
| | | |
| +----------------+ |
| |
| REPORT |
| +----------------+ |
| | | |
| +----------------+ |
| |
| ENDING |
| +----------------+ |
| | | |
| +----------------+ |
| |
| |
| |
+------------------------+
"""
STATUS = {
0: u'通过',
1: u'失败',
2: u'错误',
3:u'跳过',
}
DEFAULT_TITLE = 'Unit Test Report'
DEFAULT_DESCRIPTION = ''
# ------------------------------------------------------------------------
# HTML Template
HTML_TMPL = r"""
%(title)s %(stylesheet)s
/* level - 0:Summary; 1:Passed; 2:Failed; 3:Errored; 4:Skiped; 5:All */
function showCase(level,channel) {
trs = document.getElementsByTagName(“tr”);
for (var i = 0; i < trs.length; i++) {
tr = trs[i];
id = tr.id;
if ([“ft”,“pt”,“et”,“st”].indexOf(id.substr(0,2))!=-1){
if ( level ==0 && id.substr(2,1)==channel ) {
tr.className = ‘hiddenRow’;
}
}
if (id.substr(0,3) == 'pt'+channel) {
if ( level==1){
tr.className = '';
}
else if (level>4 && id.substr(2,1)==channel ){
tr.className = '';
}
else {
tr.className = 'hiddenRow';
}
}
if (id.substr(0,3) == 'ft'+channel) {
if (level ==2) {
tr.className = '';
}
else if (level>4 && id.substr(2,1)==channel ){
tr.className = '';
}
else {
tr.className = 'hiddenRow';
}
}
if (id.substr(0,3) == 'et'+channel) {
if (level ==3) {
tr.className = '';
}
else if (level>4 && id.substr(2,1)==channel ){
tr.className = '';
}
else {
tr.className = 'hiddenRow';
}
}
if (id.substr(0,3) == 'st'+channel) {
if (level ==4) {
tr.className = '';
}
else if (level>4 && id.substr(2,1)==channel ){
tr.className = '';
}
else {
tr.className = 'hiddenRow';
}
}
}
}
function showClassDetail(cid, count) {
var id_list = Array(count);
var toHide = 1;
for (var i = 0; i < count; i++) {
tid0 = ‘t’ + cid.substr(1) + ‘.’ + (i+1);
tid = ‘f’ + tid0;
tr = document.getElementById(tid);
if (!tr) {
tid = ‘p’ + tid0;
tr = document.getElementById(tid);
}
if (!tr) {
tid = ‘e’ + tid0;
tr = document.getElementById(tid);
}
if (!tr) {
tid = ‘s’ + tid0;
tr = document.getElementById(tid);
}
id_list[i] = tid;
if (tr.className) {
toHide = 0;
}
}
for (var i = 0; i < count; i++) {
tid = id_list[i];
if (toHide) {
document.getElementById(tid).className = ‘hiddenRow’;
}
else {
document.getElementById(tid).className = ‘’;
}
}
}
function showTestDetail(div_id){
var details_div = document.getElementById(div_id)
var displayState = details_div.style.display
// alert(displayState)
if (displayState != ‘block’ ) {
displayState = ‘block’
details_div.style.display = ‘block’
}
else {
details_div.style.display = ‘none’
}
}
function html_escape(s) {
s = s.replace(/&/g,’&’);
s = s.replace(/ s = s.replace(/>/g,’>’);
return s;
}
function drawCircle(circle,pass, fail, error){
var color = ["#6c6","#c60","#c00"];
var data = [pass,fail,error];
var text_arr = [“Pass”, “Fail”, “Error”];
var canvas = document.getElementById(circle);
var ctx = canvas.getContext("2d");
var startPoint=0;
var width = 20, height = 10;
var posX = 112 * 2 + 20, posY = 30;
var textX = posX + width + 5, textY = posY + 10;
for(var i=0;i
}
function show_img(obj) {
var obj1 = obj.nextElementSibling
obj1.style.display=‘block’
var index = 0;//每张图片的下标,
var len = obj1.getElementsByTagName(‘img’).length;
var imgyuan = obj1.getElementsByClassName(‘imgyuan’)[0]
//var start=setInterval(autoPlay,500);
obj1.οnmοuseοver=function(){//当鼠标光标停在图片上,则停止轮播
clearInterval(start);
}
obj1.οnmοuseοut=function(){//当鼠标光标停在图片上,则开始轮播
start=setInterval(autoPlay,1000);
}
for (var i = 0; i < len; i++) {
var font = document.createElement(‘font’)
imgyuan.appendChild(font)
}
var lis = obj1.getElementsByTagName(‘font’);//得到所有圆圈
changeImg(0)
var funny = function (i) {
lis[i].onmouseover = function () {
index=i
changeImg(i)
}
}
for (var i = 0; i < lis.length; i++) {
funny(i);
}
function autoPlay(){
if(index>len-1){
index=0;
clearInterval(start); //运行一轮后停止
}
changeImg(index++);
}
imgyuan.style.width= 25*len +"px";
//对应圆圈和图片同步
function changeImg(index) {
var list = obj1.getElementsByTagName('img');
var list1 = obj1.getElementsByTagName('font');
for (i = 0; i < list.length; i++) {
list[i].style.display = 'none';
list1[i].style.backgroundColor = 'white';
}
list[index].style.display = 'block';
list1[index].style.backgroundColor = 'blue';
}
}
function hide_img(obj){
obj.parentElement.style.display = “none”;
obj.parentElement.getElementsByClassName(‘imgyuan’)[0].innerHTML = “”;
}
%(heading)s
# ------------------------------------------------------------------------
# Stylesheet
#
# alternatively use a for external style sheet, e.g.
#
STYLESHEET_TMPL = """
“”"
# ------------------------------------------------------------------------
# Heading
#
HEADING_TMPL = """
%(title)s
%(parameters)s
%(description)s
“”" # variables: (title, parameters, description)
HEADING_ATTRIBUTE_TMPL = """%(name)s: %(value)s
“”" # variables: (name, value)
# ------------------------------------------------------------------------
# Report
#
REPORT_TMPL = """
概要[%(Pass_p).2f%%] 通过[%(Pass)s] 失败[%(fail)s] 错误[%(error)s] 跳过[%(skip)s] 所有[%(total)s]
%(test_list)s
测试组/测试用例
总数
通过
失败
错误
视图
错误截图
统计
%(count)s
%(Pass)s
%(fail)s
%(error)s
""" # variables: (test_list, count, Pass, fail, error)
REPORT_CLASS_TMPL = r"""
%(desc)s %(count)s %(Pass)s %(fail)s %(error)s 详情 """ # variables: (style, desc, count, Pass, fail, error, cid)
REPORT_TEST_WITH_OUTPUT_TMPL = r"""
%(desc)s
%(status)s
%(script)s
%(img)s
""" # variables: (tid, Class, style, desc, status,img)
REPORT_TEST_NO_OUTPUT_TMPL = r"""
%(desc)s
%(status)s %(img)s """ # variables: (tid, Class, style, desc, status,img)
REPORT_TEST_OUTPUT_TMPL = r"""
%(id)s: %(output)s
“”" # variables: (id, output)
IMG_TMPL = r"""
显示截图
"""
# ------------------------------------------------------------------------
# ENDING
#
ENDING_TMPL = """ """
# -------------------- The end of the Template class -------------------
def __getattribute__(self, item):
value = object.__getattribute__(self, item)
if PY3K:
return value
else:
if isinstance(value, str):
return value.decode("utf-8")
else:
return value
TestResult = unittest.TestResult
class _TestResult(TestResult):
# note: _TestResult is a pure representation of results.
# It lacks the output and reporting ability compares to unittest._TextTestResult.
def __init__(self, verbosity=1, retry=0,save_last_try=False):
TestResult.__init__(self)
self.stdout0 = None
self.stderr0 = None
self.success_count = 0
self.failure_count = 0
self.error_count = 0
self.skip_count = 0
self.verbosity = verbosity
# result is a list of result in 4 tuple
# (
# result code (0: success; 1: fail; 2: error;3:skip),
# TestCase object,
# Test output (byte string),
# stack trace,
# )
self.result = []
self.retry = retry
self.trys = 0
self.status = 0
self.save_last_try = save_last_try
self.outputBuffer = StringIO.StringIO()
def startTest(self, test):
# test.imgs = []
test.imgs = getattr(test, "imgs", [])
# TestResult.startTest(self, test)
self.outputBuffer.seek(0)
self.outputBuffer.truncate()
stdout_redirector.fp = self.outputBuffer
stderr_redirector.fp = self.outputBuffer
self.stdout0 = sys.stdout
self.stderr0 = sys.stderr
sys.stdout = stdout_redirector
sys.stderr = stderr_redirector
def complete_output(self):
"""
Disconnect output redirection and return buffer.
Safe to call multiple times.
"""
if self.stdout0:
sys.stdout = self.stdout0
sys.stderr = self.stderr0
self.stdout0 = None
self.stderr0 = None
return self.outputBuffer.getvalue()
def stopTest(self, test):
# Usually one of addSuccess, addError or addFailure would have been called.
# But there are some path in unittest that would bypass this.
# We must disconnect stdout in stopTest(), which is guaranteed to be called.
if self.retry and self.retry>=1:
if self.status == 1:
self.trys += 1
if self.trys <= self.retry:
if self.save_last_try:
t = self.result.pop(-1)
if t[0]==1:
self.failure_count -=1
else:
self.error_count -= 1
test=copy.copy(test)
sys.stderr.write("Retesting... ")
sys.stderr.write(str(test))
sys.stderr.write('..%d \n' % self.trys)
doc = getattr(test,'_testMethodDoc',u"") or u''
if doc.find('_retry')!=-1:
doc = doc[:doc.find('_retry')]
desc ="%s_retry:%d" %(doc, self.trys)
if not PY3K:
if isinstance(desc, str):
desc = desc.decode("utf-8")
test._testMethodDoc = desc
test(self)
else:
self.status = 0
self.trys = 0
self.complete_output()
def addSuccess(self, test):
self.success_count += 1
self.status = 0
TestResult.addSuccess(self, test)
output = self.complete_output()
self.result.append((0, test, output, ''))
if self.verbosity > 1:
sys.stderr.write('P ')
sys.stderr.write(str(test))
sys.stderr.write('\n')
else:
sys.stderr.write('P')
def addFailure(self, test, err):
self.failure_count += 1
self.status = 1
TestResult.addFailure(self, test, err)
_, _exc_str = self.failures[-1]
output = self.complete_output()
self.result.append((1, test, output, _exc_str))
if not getattr(test, "driver",""):
pass
else:
try:
driver = getattr(test, "driver")
test.imgs.append(driver.get_screenshot_as_base64())
except Exception as e:
pass
if self.verbosity > 1:
sys.stderr.write('F ')
sys.stderr.write(str(test))
sys.stderr.write('\n')
else:
sys.stderr.write('F')
def addError(self, test, err):
self.error_count += 1
self.status = 1
TestResult.addError(self, test, err)
_, _exc_str = self.errors[-1]
output = self.complete_output()
self.result.append((2, test, output, _exc_str))
if not getattr(test, "driver",""):
pass
else:
try:
driver = getattr(test, "driver")
test.imgs.append(driver.get_screenshot_as_base64())
except Exception:
pass
if self.verbosity > 1:
sys.stderr.write('E ')
sys.stderr.write(str(test))
sys.stderr.write('\n')
else:
sys.stderr.write('E')
def addSkip(self, test, reason):
self.skip_count += 1
self.status = 0
TestResult.addSkip(self, test,reason)
output = self.complete_output()
self.result.append((3, test, output, reason))
if self.verbosity > 1:
sys.stderr.write('K')
sys.stderr.write(str(test))
sys.stderr.write('\n')
else:
sys.stderr.write('K')
class HTMLTestRunner(Template_mixin):
def init(self, stream=sys.stdout, verbosity=1, title=None, description=None,is_thread=False, retry=0,save_last_try=True):
self.stream = stream
self.retry = retry
self.is_thread=is_thread
self.threads= 5
self.save_last_try=save_last_try
self.verbosity = verbosity
self.run_times=0
if title is None:
self.title = self.DEFAULT_TITLE
else:
self.title = title
if description is None:
self.description = self.DEFAULT_DESCRIPTION
else:
self.description = description
def run(self, test):
"Run the given test case or test suite."
self.startTime = datetime.datetime.now()
result = _TestResult(self.verbosity, self.retry, self.save_last_try)
test(result)
self.stopTime = datetime.datetime.now()
self.run_times+=1
self.generateReport(test, result)
if PY3K:
# for python3
# print('\nTime Elapsed: %s' % (self.stopTime - self.startTime),file=sys.stderr)
output = '\nTime Elapsed: %s' % (self.stopTime - self.startTime)
sys.stderr.write(output)
else:
print >> sys.stderr, '\nTime Elapsed: %s' % (self.stopTime - self.startTime)
return result
def sortResult(self, result_list):
# unittest does not seems to run in any particular order.
# Here at least we want to group them together by class.
rmap = {}
classes = []
for n, t, o, e in result_list:
cls = t.__class__
if not cls in rmap:
rmap[cls] = []
classes.append(cls)
rmap[cls].append((n, t, o, e))
for cls in classes:
rmap[cls].sort(key=cmp_to_key(lambda a,b:1 if a[1].id()>b[1].id() else ( 1 if a[1].id()==b[1].id() else -1)))
r = [(cls, rmap[cls]) for cls in classes]
# name = t.id().split('.')[-1]
r.sort(key=cmp_to_key(lambda a, b: 1 if a[0].__name__ > b[0].__name__ else -1))
return r
def getReportAttributes(self, result):
"""
Return report attributes as a list of (name, value).
Override this to add custom attributes.
"""
startTime = str(self.startTime)[:19]
duration = str(self.stopTime - self.startTime)
status = []
if result.success_count:
status.append(u'Pass:%s' % result.success_count)
if result.failure_count:
status.append(u'Failure:%s' % result.failure_count)
if result.error_count:
status.append(u'Error:%s' % result.error_count)
if result.skip_count:
status.append(u'Skip:%s' % result.skip_count)
total = result.success_count+result.failure_count+result.error_count # +result.skip_count
if total>0:
passed = result.success_count*1.000/total*100
else:
passed =0.0
status.append(u'通过率:%.1f%%' % passed)
if status:
status = u' '.join(status)
else:
status = 'none'
return [
(u'开始时间', startTime),
(u'耗时', duration),
(u'状态', status),
]
def generateReport(self, test, result):
report_attrs = self.getReportAttributes(result)
generator = 'HTMLTestRunner %s' % __version__
stylesheet = self._generate_stylesheet()
heading = self._generate_heading(report_attrs)
report = self._generate_report(result)
ending = self._generate_ending()
output = self.HTML_TMPL % dict(
title=saxutils.escape(self.title),
generator=generator,
stylesheet=stylesheet,
heading=heading,
report=report,
ending=ending,
channel=self.run_times,
)
if PY3K:
self.stream.write(output.encode())
else:
self.stream.write(output.encode('utf8'))
def _generate_stylesheet(self):
return self.STYLESHEET_TMPL
def _generate_heading(self, report_attrs):
a_lines = []
for name, value in report_attrs:
line = self.HEADING_ATTRIBUTE_TMPL % dict(
name=name,
value=value,
)
a_lines.append(line)
heading = self.HEADING_TMPL % dict(
title=saxutils.escape(self.title),
parameters=''.join(a_lines),
description=saxutils.escape(self.description),
)
return heading
def _generate_report(self, result):
rows = []
sortedResult = self.sortResult(result.result)
for cid, (cls, cls_results) in enumerate(sortedResult):
# subtotal for a class
np = nf = ne = ns = 0
for n, t, o, e in cls_results:
if n == 0:
np += 1
elif n == 1:
nf += 1
elif n==2:
ne += 1
else:
ns +=1
# format class description
if cls.__module__ == "__main__":
name = cls.__name__
else:
name = "%s.%s" % (cls.__module__, cls.__name__)
doc = cls.__doc__ and cls.__doc__.split("\n")[0] or ""
desc = doc and '%s: %s' % (name, doc) or name
if not PY3K:
if isinstance(desc, str):
desc = desc.decode("utf-8")
row = self.REPORT_CLASS_TMPL % dict(
style=ne > 0 and 'errorClass' or nf > 0 and 'failClass' or 'passClass',
desc=desc,
count=np + nf + ne,
Pass=np,
fail=nf,
error=ne,
cid='c%s.%s' % (self.run_times,cid + 1),
)
rows.append(row)
for tid, (n, t, o, e) in enumerate(cls_results):
self._generate_report_test(rows, cid, tid, n, t, o, e)
total = result.success_count + result.failure_count + result.error_count #+result.skip_count
report = self.REPORT_TMPL % dict(
test_list=u''.join(rows),
count=str(total),
Pass=str(result.success_count),
Pass_p=result.success_count*1.00/total*100 if total else 0.0,
fail=str(result.failure_count),
error=str(result.error_count),
skip=str(result.skip_count),
total=str(total),
channel=str(self.run_times),
)
return report
def _generate_report_test(self, rows, cid, tid, n, t, o, e):
# e.g. 'pt1.1', 'ft1.1', etc
has_output = bool(o or e)
if n==0:
tmp="p"
elif n==1:
tmp="f"
elif n==2:
tmp = "e"
else:
tmp = "s"
tid = tmp + 't%d.%d.%d' % (self.run_times,cid + 1, tid + 1)
name = t.id().split('.')[-1]
if self.verbosity > 1:
doc = getattr(t,'_testMethodDoc',"") or ''
else:
doc = ""
desc = doc and ('%s: %s' % (name, doc)) or name
if not PY3K:
if isinstance(desc, str):
desc = desc.decode("utf-8")
tmpl = has_output and self.REPORT_TEST_WITH_OUTPUT_TMPL or self.REPORT_TEST_NO_OUTPUT_TMPL
# o and e should be byte string because they are collected from stdout and stderr?
if isinstance(o, str):
# uo = unicode(o.encode('string_escape'))
if PY3K:
uo = o
else:
uo = o.decode('utf-8', 'ignore')
else:
uo = o
if isinstance(e, str):
# ue = unicode(e.encode('string_escape'))
if PY3K:
ue = e
elif e.find("Error") != -1 or e.find("Exception") != -1:
es = e.decode('utf-8', 'ignore').split('\n')
try:
if es[-2].find("\\u") != -1 or es[-2].find('"\\u') != -1:
es[-2] = es[-2].decode('unicode_escape')
except Exception:
pass
ue = u"\n".join(es)
else:
ue = e.decode('utf-8', 'ignore')
else:
ue = e
script = self.REPORT_TEST_OUTPUT_TMPL % dict(
id=tid,
output=saxutils.escape(uo + ue),
)
if getattr(t,'imgs',[]):
# 判断截图列表,如果有则追加
tmp = u""
for i, img in enumerate(t.imgs):
if i==0:
tmp+=""" \n""" % img
else:
tmp+=""" \n""" % img
imgs = self.IMG_TMPL % dict(imgs=tmp)
else:
imgs = u"""无截图"""
row = tmpl % dict(
tid=tid,
Class=(n == 0 and 'hiddenRow' or 'none'),
style=n == 2 and 'errorCase' or (n == 1 and 'failCase' or 'passCase'),
desc=desc,
script=script,
status=self.STATUS[n],
img=imgs,
)
rows.append(row)
if not has_output:
return
def _generate_ending(self):
return self.ENDING_TMPL
##############################################################################
Facilities for running tests from the command line
##############################################################################
Note: Reuse unittest.TestProgram to launch test. In the future we may
build our own launcher to support more specific command line
parameters like test title, CSS, etc.
class TestProgram(unittest.TestProgram):
“”"
A variation of the unittest.TestProgram. Please refer to the base
class for command line parameters.
“”"
def runTests(self):
# Pick HTMLTestRunner as the default test runner.
# base class's testRunner parameter is not useful because it means
# we have to instantiate HTMLTestRunner before we know self.verbosity.
if self.testRunner is None:
self.testRunner = HTMLTestRunner(verbosity=self.verbosity)
unittest.TestProgram.runTests(self)
main = TestProgram
##############################################################################
Executing this module from the command line
##############################################################################
if name == “main”:
main(module=None)