Python自动化测试框架【生成测试报告】

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 = '<link rel="stylesheet" href="my_stylesheet.css" type="text/css">'
# 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:

• 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

author = “Wai Yip Tung”
version = “0.8.2”

“”"
Change History
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

TODO: color stderr

TODO: simplify javascript using ,ore than 1 class in the class attribute?

import datetime
import io
import sys
import time
import unittest
from xml.sax import saxutils

------------------------------------------------------------------------

The redirectors below are used to capture output during testing. Output

sent to sys.stdout and sys.stderr are automatically captured. However

in some cases sys.stdout is already cached before HTMLTestRunner is

invoked (e.g. calling logging.basicConfig). In order to capture those

output, use the redirectors for the cached stream.

e.g.

>>> logging.basicConfig(stream=HTMLTestRunner.stdout_redirector)

>>>

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)

----------------------------------------------------------------------

Template

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: 'pass',
1: 'fail',
2: 'error',
}

DEFAULT_TITLE = 'Unit Test Report'
DEFAULT_DESCRIPTION = ''

# ------------------------------------------------------------------------
# HTML Template

HTML_TMPL = r"""<?xml version="1.0" encoding="UTF-8"?>

%(stylesheet)s %(heading)s %(report)s %(ending)s """ # variables: (title, generator, stylesheet, heading, report, ending)

# ------------------------------------------------------------------------
# Stylesheet
#
# alternatively use a <link> for external style sheet, e.g.
#   <link rel="stylesheet" href="$url" type="text/css">

STYLESHEET_TMPL = """

“”"

# ------------------------------------------------------------------------
# Heading
#

HEADING_TMPL = """<div class='heading'>

%(title)s

%(parameters)s

%(description)s

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

HEADING_ATTRIBUTE_TMPL = """<p class='attribute'><strong>%(name)s:</strong> %(value)s</p>

“”" # 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 = """<div id='ending'>&nbsp;</div>"""

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

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

+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

[外链图片转存中…(img-FjJz7wLJ-1719235851768)]
[外链图片转存中…(img-IhBSyvSN-1719235851769)]

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！