# 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 (c) 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: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name Wai Yip Tung nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 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. """ # URL: http://tungwaiyip.info/software/HTMLTestRunner.html # URL: https://github.com/Gelomen/HTMLTestReportCN-ScreenShot __author__ = "Wai Yip Tung, Findyou, boafantasy, Gelomen" __version__ = "1.2.0" """ Change History Version 1.3.0 -- Gelomen * 增加初始化报告目录自定义 * 升级版本 * 优化命名 Version 1.2.0 -- Gelomen * 优化用例说明显示 * 错误和失败报告里可以放入多张截图 Version 1.1.0 -- Gelomen * 优化报告截图写入方式 Version 1.0.2 -- Gelomen * 新增测试结果统计饼图 * 优化筛选时只显示预览 Version 1.0.1 -- Gelomen * 修复报告存入文件夹的bug * 优化报告的命名方式 Version 1.0.0 -- Gelomen * 修改测试报告文件夹路径的获取方式 * 修改截图获取文件夹路径的获取方式 Version 0.9.9 -- Gelomen * 优化报告文件夹命名 * 优化截图存放的目录 * 增加图片阴影边框以突出图片 * 优化 失败用例合集 和 错误用例合集 显示的颜色 Version 0.9.8 -- Gelomen * 优化回到顶部按钮的显示方式 Version 0.9.7 -- Gelomen * 优化截图显示，滚动页面会固定居中 Version 0.9.6 -- Gelomen * 新增打开图片的特效，可以直接在当前页面看截图 Version 0.9.5 -- Gelomen * heading新增 失败 和 错误 测试用例合集 Version 0.9.4 -- Gelomen * 修复失败和错误用例里对应按钮的颜色 Version 0.9.3 -- Gelomen * 修复点击失败或错误按钮后，浏览器版本和截图的列不会隐藏的bug Version 0.9.2 -- Gelomen * 美化 浏览器版本 和 截图 的显示 Version 0.9.1 -- Gelomen * 使用UI自动化测试时，增加 错误、失败 详细信息的 浏览器类型和版本 Version 0.9.0 -- Gelomen * 可通过 `need_screenshot=1` 作为开关，将报告开启截图功能 * 增加 失败 和 错误 详细信息的 截图链接 Version 0.8.4 -- Gelomen * 删除 失败模块 的显示 Version 0.8.3 -- Gelomen * 修复 测试结果 的筛选 * 优化 失败、错误 小图标的颜色 * 增加表格 最后一列 的显示，以美化表格 Version 0.8.2.1 -Findyou * 改为支持python3 Version 0.8.2.1 -Findyou * 支持中文，汉化 * 调整样式，美化（需要连入网络，使用的百度的Bootstrap.js） * 增加 通过分类显示、测试人员、通过率的展示 * 优化“详细”与“收起”状态的变换 * 增加返回顶部的锚点 Version 0.8.2 * Show output inline instead of popup window (Viorel Lupu). Version in 0.8.1 * Validated XHTML (Wolfgang Borgert). * Added description of test classes and test cases. Version in 0.8.0 * Define Template_mixin class for customization. * Workaround a IE 6 bug that it does not treat %(stylesheet)s %(heading)s %(report)s %(ending)s """ # variables: (title, generator, stylesheet, heading, report, ending) # ------------------------------------------------------------------------ # Stylesheet # # alternatively use a for external style sheet, e.g. # STYLESHEET_TMPL = """ """ # ------------------------------------------------------------------------ # Heading # # 添加显示截图 和 饼状图 的div -- Gelomen HEADING_TMPL = """

%(title)s

%(parameters)s

%(description)s

""" # variables: (title, parameters, description) HEADING_ATTRIBUTE_TMPL = """

%(name)s : %(value)s

""" # variables: (name, value) # ------------------------------------------------------------------------ # Report # # 汉化,加美化效果 --Findyou REPORT_TMPL = """

概要{ %(passrate)s } 通过{ %(Pass)s } 失败{ %(fail)s } 错误{ %(error)s } 所有{ %(count)s }

%(test_list)s
用例集/测试用例 说明 总计 通过 失败 错误 耗时 详细
总计 %(count)s %(Pass)s %(fail)s %(error)s %(time_usage)s 通过率：%(passrate)s
""" # variables: (test_list, count, Pass, fail, error ,passrate) REPORT_CLASS_TMPL = r""" %(name)s %(doc)s %(count)s %(Pass)s %(fail)s %(error)s %(time_usage)s 详细 """ # variables: (style, desc, count, Pass, fail, error, cid) # 失败 的样式，去掉原来JS效果，美化展示效果 -Findyou / 美化类名上下居中，有截图列 -- Gelomen REPORT_TEST_WITH_OUTPUT_TMPL_1 = r"""
%(name)s
%(doc)s 
    %(script)s
浏览器版本：
%(browser)s

截图：%(screenshot)s
""" # variables: (tid, Class, style, desc, status) # 失败 的样式，去掉原来JS效果，美化展示效果 -Findyou / 美化类名上下居中，无截图列 -- Gelomen REPORT_TEST_WITH_OUTPUT_TMPL_0 = r"""
%(name)s
%(doc)s 
        %(script)s
""" # variables: (tid, Class, style, desc, status) # 通过 的样式，加标签效果 -Findyou / 美化类名上下居中 -- Gelomen REPORT_TEST_NO_OUTPUT_TMPL = r"""
%(name)s
%(doc)s %(status)s """ # variables: (tid, Class, style, desc, status) REPORT_TEST_OUTPUT_TMPL = r""" %(id)s: %(output)s """ # variables: (id, output) # ------------------------------------------------------------------------ # ENDING # # 增加返回顶部按钮 --Findyou ENDING_TMPL = """
 
""" # -------------------- The end of the Template class ------------------- 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): TestResult.__init__(self) self.stdout0 = None self.stderr0 = None self.success_count = 0 self.failure_count = 0 self.error_count = 0 self.verbosity = verbosity # 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 = [] # 增加一个测试通过率 --Findyou self.passrate = float(0) # 增加失败用例合集 self.failCase = "" # 增加错误用例合集 self.errorCase = "" def startTest(self, test): stream = sys.stderr # stdout_content = " Testing: " + str(test) # stream.write(stdout_content) # stream.flush() # stream.write("\n") TestResult.startTest(self, 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.test_start_time = round(time.time(), 2) def complete_output(self): """ Disconnect output redirection and return buffer. Safe to call multiple times. """ self.test_end_time = round(time.time(), 2) 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. self.complete_output() def addSuccess(self, test): self.success_count += 1 TestResult.addSuccess(self, test) output = self.complete_output() use_time = round(self.test_end_time - self.test_start_time, 2) self.result.append((0, test, output, '', use_time)) if self.verbosity > 1: sys.stderr.write(' S ') sys.stderr.write(str(test)) sys.stderr.write('\n') else: sys.stderr.write(' S ') sys.stderr.write('\n') def addError(self, test, err): self.error_count += 1 TestResult.addError(self, test, err) _, _exc_str = self.errors[-1] output = self.complete_output() use_time = round(self.test_end_time - self.test_start_time, 2) self.result.append((2, test, output, _exc_str, use_time)) 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') # 添加收集错误用例名字 -- Gelomen self.errorCase += "
  • " + str(test) + "
    • " def addFailure(self, test, err): self.failure_count += 1 TestResult.addFailure(self, test, err) _, _exc_str = self.failures[-1] output = self.complete_output() use_time = round(self.test_end_time - self.test_start_time, 2) self.result.append((1, test, output, _exc_str, use_time)) 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') # 添加收集失败用例名字 -- Gelomen self.failCase += "
  • " + 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 = str(self.stopTime - self.startTime) status = [] status.append('共 %s' % (result.success_count + result.failure_count + result.error_count)) if result.success_count: status.append('通过 %s' % result.success_count) if result.failure_count: status.append('失败 %s' % result.failure_count) if result.error_count: status.append('错误 %s' % result.error_count) if status: status = '，'.join(status) if (result.success_count + result.failure_count + result.error_count) > 0: self.passrate = str("%.2f%%" % (float(result.success_count) / float( result.success_count + result.failure_count + result.error_count) * 100)) else: self.passrate = "0.00 %" else: status = 'none' if len(result.failCase) > 0: failCase = result.failCase else: failCase = "无" if len(result.errorCase) > 0: errorCase = result.errorCase else: errorCase = "无" return [ ('测试人员', self.tester), ('开始时间', startTime), ('合计耗时', duration), ('测试结果', status + "，通过率 = " + self.passrate), ('失败用例合集', failCase), ('错误用例合集', errorCase), ] def generateReport(self, test, result): report_attrs = self.getReportAttributes(result) generator = 'HTMLTestRunner %s' % __version__ 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.success_count + result.failure_count + result.error_count), Pass=str(result.success_count), fail=str(result.failure_count), error=str(result.error_count), time_usage=str(sum_ns) + "秒", # 所有用例耗时 passrate=self.passrate, ) # 获取 通过、失败 和 错误 的统计并return，以用于饼图 -- Gelomen Pass = str(result.success_count) fail = str(result.failure_count) error = str(result.error_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 'errorCase' or (n == 1 and 'failCase' or 'passCase'), 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 'errorCase' or (n == 1 and 'failCase' or 'passCase'), 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)