【Python自动化测试】如何才能让用例自动运行完之后，生成一张直观可看易懂的测试报告呢？

小编使用的是unittest的一个扩展HTMLTestRunner

• 环境准备

使用之前，我们需要下载HTMLTestRunner.py文件

点击HTMLTestRunner后进入的是一个写满代码的网页，小编推荐操作：右键 --> 另存为，文件名称千万不要改

python3使用上述HTMLTestRunner可能会报错，可以替换如下文件

1. """

2. A TestRunner for use with the Python unit testing framework. It

3. generates a HTML report to show the result at a glance.

5. The simplest way to use this is to invoke its main method. E.g.

7. import unittest

8. import HTMLTestRunner

10. ... define your tests ...

12. if __name__ == '__main__':

13. HTMLTestRunner.main()

16. For more customization options, instantiates a HTMLTestRunner object.

17. HTMLTestRunner is a counterpart to unittest's TextTestRunner. E.g.

19. # output to a file

20. fp = file('my_report.html', 'wb')

21. runner = HTMLTestRunner.HTMLTestRunner(

22. stream=fp,

23. title='My unit test',

24. description='This demonstrates the report output by HTMLTestRunner.'

25. )

27. # Use an external stylesheet.

28. # See the Template_mixin class for more customizable options

29. runner.STYLESHEET_TMPL = ''

31. # run the test

32. runner.run(my_test_suite)

35. ------------------------------------------------------------------------

36. Copyright (c) 2004-2007, Wai Yip Tung

37. All rights reserved.

39. Redistribution and use in source and binary forms, with or without

40. modification, are permitted provided that the following conditions are

41. met:

43. * Redistributions of source code must retain the above copyright notice,

44. this list of conditions and the following disclaimer.

45. * Redistributions in binary form must reproduce the above copyright

46. notice, this list of conditions and the following disclaimer in the

47. documentation and/or other materials provided with the distribution.

48. * Neither the name Wai Yip Tung nor the names of its contributors may be

49. used to endorse or promote products derived from this software without

50. specific prior written permission.

52. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS

53. IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED

54. TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A

55. PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER

56. OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

57. EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

58. PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

59. PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF

60. LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING

61. NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

62. SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

63. """

65. # URL: http://tungwaiyip.info/software/HTMLTestRunner.html

67. __author__ = "Wai Yip Tung"

68. __version__ = "0.8.2"

71. """

72. Change History

74. Version 0.8.2

75. * Show output inline instead of popup window (Viorel Lupu).

77. Version in 0.8.1

78. * Validated XHTML (Wolfgang Borgert).

79. * Added description of test classes and test cases.

81. Version in 0.8.0

82. * Define Template_mixin class for customization.

83. * Workaround a IE 6 bug that it does not treat

85. %(heading)s

86. %(report)s

87. %(ending)s

91. """

92. # variables: (title, generator, stylesheet, heading, report, ending)

95. # ------------------------------------------------------------------------

96. # Stylesheet

97. #

98. # alternatively use a for external style sheet, e.g.

99. #

101. STYLESHEET_TMPL = """

103. """

107. # ------------------------------------------------------------------------

108. # Heading

109. #

111. HEADING_TMPL = """

112. %(title)s

113. %(parameters)s

114. %(description)s

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

HEADING_ATTRIBUTE_TMPL = """

%(name)s: %(value)s

""" # variables: (name, value)

# ------------------------------------------------------------------------

# Report

#

REPORT_TMPL = """

Show

Summary

Failed

All

%(test_list)s

Test Group/Test case	Count	Pass	Fail	Error	View
Total	%(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

Detail

""" # variables: (style, desc, count, Pass, fail, error, cid)

REPORT_TEST_WITH_OUTPUT_TMPL = r"""

%(desc)s

%(status)s

[x]

%(script)s

""" # variables: (tid, Class, style, desc, status)

REPORT_TEST_NO_OUTPUT_TMPL = r"""

%(desc)s

%(status)s

""" # variables: (tid, Class, style, desc, status)

REPORT_TEST_OUTPUT_TMPL = r"""

%(id)s: %(output)s

""" # variables: (id, output)

# ------------------------------------------------------------------------

# ENDING

#

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 = []

def startTest(self, test):

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

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.

self.complete_output()

def addSuccess(self, test):

self.success_count += 1

TestResult.addSuccess(self, test)

output = self.complete_output()

self.result.append((0, test, output, ''))

if self.verbosity > 1:

sys.stderr.write('ok ')

sys.stderr.write(str(test))

sys.stderr.write('\n')

else:

sys.stderr.write('.')

def addError(self, test, err):

self.error_count += 1

TestResult.addError(self, test, err)

_, _exc_str = self.errors[-1]

output = self.complete_output()

self.result.append((2, test, output, _exc_str))

if self.verbosity > 1:

sys.stderr.write('E ')

sys.stderr.write(str(test))

sys.stderr.write('\n')

else:

sys.stderr.write('E')

def addFailure(self, test, err):

self.failure_count += 1

TestResult.addFailure(self, test, err)

_, _exc_str = self.failures[-1]

output = self.complete_output()

self.result.append((1, test, output, _exc_str))

if self.verbosity > 1:

sys.stderr.write('F ')

sys.stderr.write(str(test))

sys.stderr.write('\n')

else:

sys.stderr.write('F')

class HTMLTestRunner(Template_mixin):

"""

"""

def __init__(self, stream=sys.stdout, verbosity=1, title=None, description=None):

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

self.startTime = datetime.datetime.now()

def run(self, test):

"Run the given test case or test suite."

result = _TestResult(self.verbosity)

test(result)

self.stopTime = datetime.datetime.now()

self.generateReport(test, result)

# print >> sys.stderr, '\nTime Elapsed: %s' % (self.stopTime-self.startTime)

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))

r = [(cls, rmap[cls]) for cls in classes]

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('Pass %s' % result.success_count)

if result.failure_count: status.append('Failure %s' % result.failure_count)

if result.error_count: status.append('Error %s' % result.error_count )

if status:

status = ' '.join(status)

else:

status = 'none'

return [

('Start Time', startTime),

('Duration', duration),

('Status', 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,

)

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 = 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),

)

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 = 0

for n,t,o,e in cls_results:

if n == 0: np += 1

elif n == 1: nf += 1

else: ne += 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

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' % (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)

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),

)

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)

tid = (n == 0 and 'p' or 'f') + '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

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):

# 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 = e

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(str(uo)+ue),

)

row = tmpl % dict(

tid = tid,

Class = (n == 0 and 'hiddenRow' or 'none'),

style = n == 2 and 'errorCase' or (n == 1 and 'failCase' or 'none'),

desc = desc,

script = script,

status = self.STATUS[n],

)

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)

• 使用

接下来，小编将以登录网易邮箱为例，生成一份最基础的测试报告。小伙伴们copy走代码验证时一定记得修改账号密码哦。

目录结构如下：

 将HTMLTestRunner.py文件存放到package包下，将test_login.py存放到testcase目录下，用于编写测试用例，建立testreport包，用于存放测试报告，在email目录下建立run_test.py，用于执行测试

HTMLTestRunner的使用方法在代码注释中介绍和解释

【test_login.py】

1. from selenium import webdriver

2. import unittest,time

4. class Login(unittest.TestCase):

5. def setUp(self):

6. #打开百度，搜索“163网易邮箱”，登录

7. driver=webdriver.Firefox()

8. driver.implicitly_wait(5)

9. self.driver=driver

10. driver.get("https://www.baidu.com/")

12. driver.find_element_by_id("kw").send_keys("163邮箱登录")

13. driver.find_element_by_id("su").click()

15. name = driver.find_element_by_id("op_email3_username")

16. password = driver.find_element_by_class_name("op_email3_password")

17. login = driver.find_element_by_css_selector(".c-btn")

19. #如下操作可以使setUp中的变量被其他模块调用

20. self.name=name

21. self.password=password

22. self.login=login

24. def tearDown(self):

25. self.driver.quit()

27. def switch_window(self):

28. #切换窗口

29. for handle in self.driver.window_handles:

30. self.driver.switch_to.window(handle)

31. #j增加等待时间，可以提高测试用例执行的健壮性

32. time.sleep(2)

33. time.sleep(3)

35. #成功登录

36. def test_right_login(self):

37. #账号密码自行填写

38. self.name.send_keys("xxx")

39. self.password.send_keys("xxx")

40. self.login.click()

42. self.switch_window()

43. #t通过新窗口的title验证用例是否通过

44. self.assertEqual(self.driver.title,"网易邮箱6.0版","登录失败")

46. #密码为空登录

47. def test_null_psw_login(self):

48. self.name.send_keys("xxx")

49. time.sleep(3)

50. self.login.click()

51. self.switch_window()

52. # t通过新窗口的title验证用例是否通过

53. self.assertEqual(self.driver.title,"网易帐号中心 > 用户验证","未跳转至用户验证界面")

【run_test.py】

1. #导入HTMLTestRunner的包

2. from package import HTMLTestRunner

3. #导入test_login的包，执行测试用例时需使用

4. from testcase.test_login import *

6. #定义要执行的测试用例的路径

7. test_dir = './testcase'

8. #定义要执行的测试用例的路径和名称格式

9. #test_*.py的意思是，./testcase路径下文件名称格式为test_*.py的文件，*为任意匹配，路径下有多少的test_*.py格式的文件，就依次执行几个

10. discover = unittest.defaultTestLoader.discover(test_dir, pattern='test_*.py')

11. #定义测试报告的名称和存储位置

12. filename = './testreport/loginReport.html'

14. #开始执行

15. if __name__ == '__main__':

17. suit=unittest.TestSuite()

18. suit.addTest(Login("test_right_login"))

19. suit.addTest(Login("test_null_psw_login"))

21. #以wb(可写的二进制文件)形式，打开文件，若文件不存在，则先执行创建，再执行打开

22. fp = open(filename, 'wb')

23. #调用HTMLTestRunner生成报告

24. runner = HTMLTestRunner.HTMLTestRunner(

25. # 指定测试报告的文件

26. stream=fp,

27. # 测试报告的标题

28. title=u"登录网易邮箱测试报告",

29. # 测试报告的副标题

30. description=u'用例执行情况（win7 64位）'

31. )

32. #执行用例

33. runner.run(discover)

• 报告展示

总结：

感谢每一个认真阅读我文章的人！！！

作为一位过来人也是希望大家少走一些弯路，如果你不想再体验一次学习时找不到资料，没人解答问题，坚持几天便放弃的感受的话，在这里我给大家分享一些自动化测试的学习资源，希望能给你前进的路上带来帮助。

  视频文档获取方式：
这份文档和视频资料，对于想从事【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴我走过了最艰难的路程，希望也能帮助到你！以上均可以分享，点下方小卡片即可自行领取。