"""
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 = '%(title)s
%(title)s
%(parameters)s
%(description)s
"""
# 测试信息模板，变量列表 name, value
HEADING_ATTRIBUTE_TMPL = """
%(name)s : %(value)s
"""
# 头部信息结束
# ------------------------------------------------------------------------
# ------------------------------------------------------------------------
# 报告模板开始
# 变量列表 test_list, count, Pass, fail, error ,passrate
REPORT_TMPL = """
%(test_list)s
总计
%(count)s
%(Pass)s
%(fail)s
%(error)s
%(time_usage)s
通过：%(passrate)s
"""
# 变量列表 style, desc, count, Pass, fail, error, cid
REPORT_CLASS_TMPL = """
%(name)s
%(doc)s
%(count)s
%(Pass)s
%(fail)s
%(error)s
%(time_usage)s
查看全部
"""
# 失败样式(有截图列)，变量列表 tid, Class, style, desc, status
REPORT_TEST_WITH_OUTPUT_TMPL_1 = """
%(name)s
%(doc)s
%(status)s
浏览器：
%(browser)s
截图：%(screenshot)s
"""
# 失败样式(无截图列)，变量列表 tid, Class, style, desc, status
REPORT_TEST_WITH_OUTPUT_TMPL_0 = """
%(name)s
%(doc)s
%(status)s
"""
# 通过样式，变量列表 tid, Class, style, desc, status
REPORT_TEST_NO_OUTPUT_TMPL = """
%(name)s
%(doc)s
%(status)s
"""
# 测试输出内容
REPORT_TEST_OUTPUT_TMPL = '%(id)s:' + "\n" + '%(output)s'
# 返回顶部按钮
ENDING_TMPL = """
"""
# 报告模板结束
# ------------------------------------------------------------------------
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):
super().__init__(verbosity=verbosity)
self.verbosity = verbosity
self.outputBuffer = None
self.stdout0 = None
self.stderr0 = None
self.passed_count = 0
self.failed_count = 0
self.errors_count = 0
# result is a list of result in 4 tuple
# (
# result code (0: success; 1: fail; 2: error),
# TestCase object,
# Test output (byte string),
# stack trace,
# )
self.result = []
self.passrate = float(0)
# 增加失败用例合集
self.failedCase = ""
# 增加错误用例合集
self.errorsCase = ""
self.logger = logging.getLogger('test')
def startTest(self, test):
stream = sys.stderr
# stdout_content = " Testing: " + str(test)
# stream.write(stdout_content)
# stream.flush()
# stream.write("\n")
super().startTest(test)
# just one buffer for both stdout and stderr
self.outputBuffer = io.StringIO()
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
self.stime = round(time.time(), 2)
self.loggerStream = io.StringIO()
self.ch = logging.StreamHandler(self.loggerStream)
self.ch.setLevel(logging.DEBUG)
self.ch.setFormatter(
logging.Formatter('%(asctime)s - %(name)s -%(levelname)s -%(process)d -%(processName)s - %(message)s'))
self.logger.addHandler(self.ch)
def complete_output(self):
"""
Disconnect output redirection and return buffer.
Safe to call multiple times.
"""
self.etime = round(time.time(), 2)
if self.stdout0:
sys.stdout = self.stdout0
sys.stderr = self.stderr0
self.stdout0 = None
self.stderr0 = None
return self.loggerStream.getvalue() + 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.
self.complete_output()
# 移除日志Handler
self.logger.removeHandler(self.ch)
def addSuccess(self, test):
self.passed_count += 1
super().addSuccess(test)
output = self.complete_output()
utime = round(self.etime - self.stime, 2)
self.result.append((0, test, output, '', utime))
if self.verbosity > 1:
# sys.stderr.write('Passed: ' + str(test.__module__) + '.' + str(test.__class__.__qualname__) + '.' +
# str(test.__dict__["_testMethodName"]) )
sys.stderr.write('%s %s.%s.%-12s\t|\t%s' %('Passed:', str(test.__module__), str(test.__class__.__qualname__),
str(test.__dict__["_testMethodName"]), str(test.__dict__["_testMethodDoc"] or "") ))
sys.stderr.write("\n")
# sys.stderr.write(str(test))
# sys.stderr.write('\n')
# sys.stderr.write(str(test.__dict__))
def addError(self, test, err):
self.errors_count += 1
super().addError(test, err)
_, _exc_str = self.errors[-1]
output = self.complete_output()
utime = round(self.etime - self.stime, 2)
self.result.append((2, test, output, _exc_str, utime))
if self.verbosity > 1:
sys.stderr.write(' E ')
sys.stderr.write(str(test))
sys.stderr.write('\n')
else:
sys.stderr.write(' E ')
sys.stderr.write('\n')
# 收集错误测试用例名称以在测试报告中显示
self.errorsCase += "" + str(test) + " "
def addFailure(self, test, err):
self.failed_count += 1
super().addFailure(test, err)
_, _exc_str = self.failures[-1]
output = self.complete_output()
utime = round(self.etime - self.stime, 2)
self.result.append((1, test, output, _exc_str, utime))
if self.verbosity > 1:
sys.stderr.write(' F ')
sys.stderr.write(str(test))
sys.stderr.write('\n')
else:
sys.stderr.write(' F ')
sys.stderr.write('\n')
# 收集失败测试用例名称以在测试报告中显示
self.failedCase += "" + str(test) + " "
# 新增 need_screenshot 参数，-1为无需截图，否则需要截图 -- Gelomen
class HTMLTestRunner(Template_mixin):
"""
"""
def __init__(self, stream=sys.stdout, verbosity=2, title=None, description=None, tester=None):
self.need_screenshot = 0
self.stream = stream
self.verbosity = verbosity
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
if tester is None:
self.tester = self.DEFAULT_TESTER
else:
self.tester = tester
self.startTime = datetime.datetime.now()
def run(self, test):
"Run the given test case or test suite."
result = _TestResult(self.verbosity) # verbosity为1,只输出成功与否，为2会输出用例名称
test(result)
self.stopTime = datetime.datetime.now()
self.generateReport(test, result)
# 优化测试结束后打印蓝色提示文字 -- Gelomen
print("\n\033[36;0m--------------------- 测试结束 ---------------------\n"
"------------- 合计耗时: %s -------------\033[0m" % (self.stopTime - self.startTime), file=sys.stderr)
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, s in result_list:
cls = t.__class__
if cls not in rmap:
rmap[cls] = []
classes.append(cls)
rmap[cls].append((n, t, o, e, s))
r = [(cls, rmap[cls]) for cls in classes]
return r
# 替换测试结果status为通过率 --Findyou
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 = time.strftime('%H:%M:%S', time.gmtime((self.stopTime - self.startTime).seconds))
status = []
status.append('总共 %s' % (result.passed_count + result.failed_count + result.errors_count))
if result.passed_count:
status.append('通过 %s' % result.passed_count)
if result.failed_count:
status.append('失败 %s' % result.failed_count)
if result.errors_count:
status.append('错误 %s' % result.errors_count)
if status:
status = '，'.join(status)
if (result.passed_count + result.failed_count + result.errors_count) > 0:
self.passrate = str("%.2f%%" % (float(result.passed_count) / float(
result.passed_count + result.failed_count + result.errors_count) * 100))
else:
self.passrate = "0.00 %"
else:
status = 'none'
if len(result.failedCase) > 0:
failedCase = result.failedCase
else:
failedCase = "无"
if len(result.errorsCase) > 0:
errorsCase = result.errorsCase
else:
errorsCase = "无"
return [
('测试人员', self.tester),
('开始时间', startTime),
('合计耗时', duration),
('测试结果', status + "，通过率 " + self.passrate),
('失败用例', failedCase),
('错误用例', errorsCase),
]
def generateReport(self, test, result):
report_attrs = self.getReportAttributes(result)
generator = 'HTMLTestRunner'
stylesheet = self._generate_stylesheet()
# 添加 通过、失败 和 错误 的统计，以用于饼图 -- Gelomen
Pass = self._generate_report(result)["Pass"]
fail = self._generate_report(result)["fail"]
error = self._generate_report(result)["error"]
heading = self._generate_heading(report_attrs)
report = self._generate_report(result)["report"]
ending = self._generate_ending()
output = self.HTML_TMPL % dict(
title=saxutils.escape(self.title),
generator=generator,
stylesheet=stylesheet,
Pass=Pass,
fail=fail,
error=error,
heading=heading,
report=report,
ending=ending,
)
self.stream.write(output.encode('utf8'))
def _generate_stylesheet(self):
return self.STYLESHEET_TMPL
# 增加Tester显示 -Findyou
# 增加 失败用例合集 和 错误用例合集 的显示 -- Gelomen
def _generate_heading(self, report_attrs):
a_lines = []
for name, value in report_attrs:
# 如果是 失败用例 或 错误用例合集，则不进行转义 -- Gelomen
if name == "失败用例":
if value == "无":
line = self.HEADING_ATTRIBUTE_TMPL % dict(
name=name,
value=value,
)
else:
line = self.HEADING_ATTRIBUTE_TMPL % dict(
name=name,
value="点击查看 "
"" + value + " ",
)
elif name == "错误用例":
if value == "无":
line = self.HEADING_ATTRIBUTE_TMPL % dict(
name=name,
value=value,
)
else:
line = self.HEADING_ATTRIBUTE_TMPL % dict(
name=name,
value="点击查看 "
"" + value + " ",
)
else:
line = self.HEADING_ATTRIBUTE_TMPL % dict(
name=saxutils.escape(name),
value=saxutils.escape(value),
)
a_lines.append(line)
heading = self.HEADING_TMPL % dict(
title=saxutils.escape(self.title),
parameters=''.join(a_lines),
description=saxutils.escape(self.description),
tester=saxutils.escape(self.tester),
)
return heading
# 生成报告 --Findyou添加注释
def _generate_report(self, result):
rows = []
sortedResult = self.sortResult(result.result)
# 所有用例统计耗时初始化
sum_ns = 0
for cid, (cls, cls_results) in enumerate(sortedResult):
# subtotal for a class
np = nf = ne = ns = 0
for n, t, o, e, s in cls_results:
if n == 0:
np += 1
elif n == 1:
nf += 1
elif n == 2:
ne += 1
ns += s # 把单个class用例文件里面的多个def用例每次的耗时相加
ns = round(ns, 2)
sum_ns += ns # 把所有用例的每次耗时相加
# format class description
# if cls.__module__ == "__main__":
# name = cls.__name__
# else:
# name = "%s.%s" % (cls.__module__, cls.__name__)
name = cls.__name__
doc = cls.__doc__ and cls.__doc__.split("\n")[0] or ""
# desc = doc and '%s - %s' % (name, doc) or name
row = self.REPORT_CLASS_TMPL % dict(
style=ne > 0 and 'errorClass' or nf > 0 and 'failClass' or 'passClass',
name=name,
doc=doc,
count=np + nf + ne,
Pass=np,
fail=nf,
error=ne,
cid='c%s' % (cid + 1),
time_usage=str(ns) + "秒" # 单个用例耗时
)
rows.append(row)
for tid, (n, t, o, e, s) in enumerate(cls_results):
self._generate_report_test(rows, cid, tid, n, t, o, e)
sum_ns = round(sum_ns, 2)
report = self.REPORT_TMPL % dict(
test_list=''.join(rows),
count=str(result.passed_count + result.failed_count + result.errors_count),
Pass=str(result.passed_count),
fail=str(result.failed_count),
error=str(result.errors_count),
time_usage=str(sum_ns) + "秒", # 所有用例耗时
passrate=self.passrate,
)
# 获取 通过、失败 和 错误 的统计并return，以用于饼图 -- Gelomen
Pass = str(result.passed_count)
fail = str(result.failed_count)
error = str(result.errors_count)
return {"report": report, "Pass": Pass, "fail": fail, "error": error}
def _generate_report_test(self, rows, cid, tid, n, t, o, e):
# e.g. 'pt1_1', 'ft1_1', 'et1_1'etc
has_output = bool(o or e)
# ID修改点为下划线,支持Bootstrap折叠展开特效 - Findyou
if n == 0:
tid_flag = 'p'
elif n == 1:
tid_flag = 'f'
elif n == 2:
tid_flag = 'e'
tid = tid_flag + 't%s_%s' % (cid + 1, tid + 1)
name = t.id().split('.')[-1]
doc = t.shortDescription() or ""
# desc = doc and ('%s - %s' % (name, doc)) or name
# utf-8 支持中文 - Findyou
# o and e should be byte string because they are collected from stdout and stderr?
if isinstance(o, str):
# TODO: some problem with 'string_escape': it escape \n and mess up formating
# uo = unicode(o.encode('string_escape'))
# uo = o.decode('latin-1')
uo = o
else:
uo = o
if isinstance(e, str):
# TODO: some problem with 'string_escape': it escape \n and mess up formating
# ue = unicode(e.encode('string_escape'))
# ue = e.decode('latin-1')
ue = e
else:
ue = e
script = self.REPORT_TEST_OUTPUT_TMPL % dict(
id=tid,
output=saxutils.escape(uo + ue),
)
# 截图名字通过抛出异常存放在u，通过截取字段获得截图名字 -- Gelomen
u = uo + ue
# 先判断是否需要截图
self.need_screenshot = u.find("errorImg[")
if self.need_screenshot == -1:
tmpl = has_output and self.REPORT_TEST_WITH_OUTPUT_TMPL_0 or self.REPORT_TEST_NO_OUTPUT_TMPL
row = tmpl % dict(
tid=tid,
Class=(n == 0 and 'hiddenRow' or 'none'),
style=n == 2 and 'errorsCase' or (n == 1 and 'failedCase' or 'passedCase'),
name=name,
doc=doc,
script=script,
status=self.STATUS[n],
)
else:
tmpl = has_output and self.REPORT_TEST_WITH_OUTPUT_TMPL_1 or self.REPORT_TEST_NO_OUTPUT_TMPL
screenshot_list = re.findall("errorImg\[(.*?)\]errorImg", u)
screenshot = ""
for i in screenshot_list:
screenshot += "img_" + i + " "
# screenshot = u[u.find('errorImg[') + 9:u.find(']errorImg')]
browser = u[u.find('browser[') + 8:u.find(']browser')]
row = tmpl % dict(
tid=tid,
Class=(n == 0 and 'hiddenRow' or 'none'),
style=n == 2 and 'errorsCase' or (n == 1 and 'failedCase' or 'passedCase'),
name=name,
doc=doc,
script=script,
status=self.STATUS[n],
# 添加截图字段
screenshot=screenshot,
# 添加浏览器版本字段
browser=browser
)
rows.append(row)
if not has_output:
return
def _generate_ending(self):
return self.ENDING_TMPL
# 集成创建文件夹、保存截图、获得截图名字等方法，与HTMLTestReportCN交互从而实现嵌入截图 -- Gelomen
class ReportDirectory(object):
def __init__(self, path="../../result/"):
self.path = path
self.title = "Test Report"
def create_dir(self, title=None):
i = 1.0
if title is not None:
self.title = title
dir_path = self.path + self.title + "V" + str(round(i, 1))
# 判断文件夹是否存在，不存在则创建
while True:
is_dir = os.path.isdir(dir_path)
if is_dir:
i += 0.1
dir_path = self.path + self.title + "V" + str(round(i, 1))
else:
break
os.makedirs(dir_path)
# 测试报告路径
report_path = dir_path + "/" + self.title + "V" + str(round(i, 1)) + ".html"
# 将新建的 文件夹路径 和 报告路径 存入全局变量
GlobalMsg.set_value("dir_path", dir_path)
GlobalMsg.set_value("report_path", report_path)
@staticmethod
def get_screenshot(browser):
i = 1
# 通过全局变量获取文件夹路径
new_dir = GlobalMsg.get_value("dir_path")
img_dir = new_dir + "/image"
# 判断文件夹是否存在，不存在则创建
is_dir = os.path.isdir(img_dir)
if not is_dir:
os.makedirs(img_dir)
img_path = img_dir + "/" + str(i) + ".png"
# 有可能同个测试步骤出错，截图名字一样导致覆盖文件，所以名字存在则增加id
while True:
is_file = os.path.isfile(img_path)
if is_file:
i += 1
img_path = img_dir + "/" + str(i) + ".png"
else:
break
browser.get_screenshot_as_file(img_path)
img_name = str(i) + ".png"
browser_type = browser.capabilities["browserName"]
browser_version = browser.capabilities["browserVersion"]
browser_msg = browser_type + "(" + browser_version + ")"
print("errorImg[" + img_name + "]errorImg, browser[" + browser_msg + "]browser")
##############################################################################
# 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)