美文网首页
BSTestRunner.py下载(python3)

BSTestRunner.py下载(python3)

作者: 水漾涟漪penny | 来源:发表于2019-11-20 11:37 被阅读0次

    """

    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 BSTestRunner

        ... define your tests ...

        if __name__ == '__main__':

            BSTestRunner.main()

    For more customization options, instantiates a BSTestRunner object.

    BSTestRunner is a counterpart to unittest's TextTestRunner. E.g.

        # output to a file

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

        runner = BSTestRunner.BSTestRunner(

                    stream=fp,

                    title='My unit test',

                    description='This demonstrates the report output by BSTestRunner.'

                    )

        # 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

    Copyright (c) 2016, Eason Han

    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.

    """

    __author__ = "Wai Yip Tung && Eason Han"

    __version__ ="0.8.4"

    """

    Change History

    Version 0.8.3

    * Modify html style using bootstrap3.

    Version 0.8.3

    * Prevent crash on class or module-level exceptions (Darren Wurf).

    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 <script> block as CDATA.

    Version in 0.7.1

    * Back port to Python 2.3 (Frank Horowitz).

    * Fix missing scroll bars in detail log (Podi).

    """

    # TODO: color stderr

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

    importdatetime

    # import StringIO

    import io

    import sys

    import time

    importunittest

    fromxml.saximportsaxutils

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

    # 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 BSTestRunner 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=BSTestRunner.stdout_redirector)

    #  >>>

    defto_unicode(s):

        try:

            returnunicode(s)

        exceptUnicodeDecodeError:

            # s is non ascii byte string

            returns.decode('unicode_escape')

    classOutputRedirector(object):

        """ Wrapper to redirect stdout or stderr """

        def__init__(self, fp):

            self.fp = fp

        defwrite(self, s):

            self.fp.write(to_unicode(s))

        defwritelines(self, lines):

            lines = map(to_unicode, lines)

            self.fp.writelines(lines)

        defflush(self):

            self.fp.flush()

    stdout_redirector = OutputRedirector(sys.stdout)

    stderr_redirector = OutputRedirector(sys.stderr)

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

    # Template

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

    <html lang="zh-cn">

       

       

       

       

        %(title)s

       

       

        %(stylesheet)s

         

         

    <body>

    <script language="javascript" type="text/javascript"><!--

    output_list = Array();

    /* level - 0:Summary; 1:Failed; 2:All */

    function showCase(level) {

        trs = document.getElementsByTagName("tr");

        for (var i = 0; i < trs.length; i++) {

            tr = trs[i];

            id = tr.id;

            if (id.substr(0,2) == 'ft') {

                if (level < 1) {

                    tr.className = 'hiddenRow';

                }

                else {

                    tr.className = '';

                }

            }

            if (id.substr(0,2) == 'pt') {

                if (level > 1) {

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

            }

            id_list[i] = tid;

            if (tr.className) {

                toHide = 0;

            }

        }

        for (var i = 0; i < count; i++) {

            tid = id_list[i];

            if (toHide) {

                document.getElementById('div_'+tid).style.display = 'none'

                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;

    }

    /* obsoleted by detail in <div>

    function showOutput(id, name) {

        var w = window.open("", //url

                        name,

                        "resizable,scrollbars,status,width=800,height=450");

        d = w.document;

        d.write("

    ");

        d.write(html_escape(output_list[id]));

        d.write("\n");

        d.write("close\n");

        d.write("\n");

        d.close();

    }

    */

    --></script>

    <div class="container">

        %(heading)s

        %(report)s

        %(ending)s

    </div>

    </body>

    </html>

    """

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

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

        # Stylesheet

        #

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

        # 

        STYLESHEET_TMPL ="""

    <style type="text/css" media="screen">

    /* -- css div popup ------------------------------------------------------------------------ */

    .popup_window {

        display: none;

        position: relative;

        left: 0px;

        top: 0px;

        /*border: solid #627173 1px; */

        padding: 10px;

        background-color: #99CCFF;

        font-family: "Lucida Console", "Courier New", Courier, monospace;

        text-align: left;

        font-size: 10pt;

        width: 500px;

    }

    /* -- report ------------------------------------------------------------------------ */

    #show_detail_line .label {

        font-size: 85%;

        cursor: pointer;

    }

    #show_detail_line {

        margin: 2em auto 1em auto;

    }

    #total_row  { font-weight: bold; }

    .hiddenRow  { display: none; }

    .testcase  { margin-left: 2em; }

    </style>

    """

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

        # Heading

        #

        HEADING_TMPL ="""

    <h1>%(title)s</h1>

    %(parameters)s

    <p class='description'>%(description)s</p>

    </div>

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

        HEADING_ATTRIBUTE_TMPL ="""

    %(name)s: %(value)s

    """ # variables: (name, value)

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

        # Report

        #

        REPORT_TMPL ="""

    <p id='show_detail_line'>

    <span class="label label-primary" onclick="showCase(0)">Summary</span>

    <span class="label label-danger" onclick="showCase(1)">Failed</span>

    <span class="label label-default" onclick="showCase(2)">All</span>

    </p>

    <table id='result_table' class="table">

                Test Group/Test case

                Count

                Pass

                Fail

                Error

                View

            %(test_list)s

                Total

                %(count)s

                %(Pass)s

                %(fail)s

                %(error)s

    </table>

    """ # variables: (test_list, count, Pass, fail, error)

        REPORT_CLASS_TMPL =r"""

    <tr class='%(style)s'>

        %(desc)s

        %(count)s

        %(Pass)s

        %(fail)s

        %(error)s

        Detail

    </tr>

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

        REPORT_TEST_WITH_OUTPUT_TMPL =r"""

    <tr id='%(tid)s' class='%(Class)s'>

       

    %(desc)s

       

            %(status)s

       

           

           

               [x]

           

    
    

            %(script)s

    </tr>

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

        REPORT_TEST_NO_OUTPUT_TMPL =r"""

    <tr id='%(tid)s' class='%(Class)s'>

       

    %(desc)s

        %(status)s

    </tr>

    """ # 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.outputBuffer = StringIO.StringIO()

            self.outputBuffer = io.StringIO()

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

        defstartTest(self, test):

            TestResult.startTest(self, test)

            # just one buffer for both stdout and stderr

            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

        defcomplete_output(self):

            """

            Disconnect output redirection and return buffer.

            Safe to call multiple times.

            """

            ifself.stdout0:

                sys.stdout = self.stdout0

                sys.stderr = self.stderr0

                self.stdout0 =None

                self.stderr0 =None

            returnself.outputBuffer.getvalue()

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

        defaddSuccess(self, test):

            self.success_count +=1

            TestResult.addSuccess(self, test)

            output = self.complete_output()

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

            ifself.verbosity >1:

                sys.stderr.write('ok ')

                sys.stderr.write(str(test))

                sys.stderr.write('\n')

            else:

                sys.stderr.write('.')

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

            ifself.verbosity >1:

                sys.stderr.write('E  ')

                sys.stderr.write(str(test))

                sys.stderr.write('\n')

            else:

                sys.stderr.write('E')

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

            ifself.verbosity >1:

                sys.stderr.write('F  ')

                sys.stderr.write(str(test))

                sys.stderr.write('\n')

            else:

                sys.stderr.write('F')

    classBSTestRunner(Template_mixin):

        """

        """

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

            self.stream = stream

            self.verbosity = verbosity

            iftitleisNone:

                self.title = self.DEFAULT_TITLE

            else:

                self.title = title

            ifdescriptionisNone:

                self.description = self.DEFAULT_DESCRIPTION

            else:

                self.description = description

            self.startTime = datetime.datetime.now()

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

            returnresult

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

            forn,t,o,einresult_list:

                cls = t.__class__

                # if not rmap.has_key(cls):

                ifnotclsinrmap:

                    rmap[cls] = []

                    classes.append(cls)

                rmap[cls].append((n,t,o,e))

            r = [(cls, rmap[cls])forclsinclasses]

            returnr

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

            ifresult.success_count: status.append('<span class="text text-success">Pass <strong>%s</strong></span>'    % result.success_count)

            ifresult.failure_count: status.append('<span class="text text-danger">Failure <strong>%s</strong></span>'% result.failure_count)

            ifresult.error_count:  status.append('<span class="text text-warning">Error <strong>%s</strong></span>'  % result.error_count  )

            ifstatus:

                status =' '.join(status)

            else:

                status ='none'

            return[

                ('Start Time', startTime),

                ('Duration', duration),

                ('Status', status),

            ]

        defgenerateReport(self, test, result):

            report_attrs = self.getReportAttributes(result)

            generator ='BSTestRunner %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):

            returnself.STYLESHEET_TMPL

        def_generate_heading(self, report_attrs):

            a_lines = []

            forname, valueinreport_attrs:

                line = self.HEADING_ATTRIBUTE_TMPL % dict(

                        # name = saxutils.escape(name),

                        # value = saxutils.escape(value),

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

            )

            returnheading

        def_generate_report(self, result):

            rows = []

            sortedResult = self.sortResult(result.result)

            forcid, (cls, cls_results)inenumerate(sortedResult):

                # subtotal for a class

                np = nf = ne =0

                forn,t,o,eincls_results:

                    ifn ==0: np +=1

                    elifn ==1: nf +=1

                    else: ne +=1

                # format class description

                ifcls.__module__ =="__main__":

                    name = cls.__name__

                else:

                    name ="%s.%s"% (cls.__module__, cls.__name__)

                doc = cls.__doc__andcls.__doc__.split("\n")[0]or""

                desc = docand'%s: %s'% (name, doc)orname

                row = self.REPORT_CLASS_TMPL % dict(

                    style = ne >0 and 'text text-warning' or nf > 0 and 'text text-danger' or 'text text-success',

                    desc = desc,

                    count = np+nf+ne,

                    Pass = np,

                    fail = nf,

                    error = ne,

                    cid ='c%s'% (cid+1),

                )

                rows.append(row)

                fortid, (n,t,o,e)inenumerate(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),

            )

            returnreport

        def_generate_report_test(self, rows, cid, tid, n, t, o, e):

            # e.g. 'pt1.1', 'ft1.1', etc

            has_output = bool(oore)

            tid = (n ==0and'p'or'f') +'t%s.%s'% (cid+1,tid+1)

            name = t.id().split('.')[-1]

            doc = t.shortDescription()or""

            desc = docand('%s: %s'% (name, doc))orname

            tmpl = has_outputandself.REPORT_TEST_WITH_OUTPUT_TMPLorself.REPORT_TEST_NO_OUTPUT_TMPL

            # o and e should be byte string because they are collected from stdout and stderr?

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

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

            )

            row = tmpl % dict(

                tid = tid,

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

                Class = (n ==0and'hiddenRow'or'text text-success'),

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

                style = n ==2 and 'text text-warning' or (n == 1 and 'text text-danger' or 'text text-success'),

                desc = desc,

                script = script,

                status = self.STATUS[n],

            )

            rows.append(row)

            ifnothas_output:

                return

        def_generate_ending(self):

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

    classTestProgram(unittest.TestProgram):

        """

        A variation of the unittest.TestProgram. Please refer to the base

        class for command line parameters.

        """

        defrunTests(self):

            # Pick BSTestRunner as the default test runner.

            # base class's testRunner parameter is not useful because it means

            # we have to instantiate BSTestRunner before we know self.verbosity.

            ifself.testRunnerisNone:

                self.testRunner = BSTestRunner(verbosity=self.verbosity)

            unittest.TestProgram.runTests(self)

    main = TestProgram

    ##############################################################################

    # Executing this module from the command line

    ##############################################################################

    if__name__ =="__main__":

        main(module=None)

    相关文章

      网友评论

          本文标题:BSTestRunner.py下载(python3)

          本文链接:https://www.haomeiwen.com/subject/hfxoictx.html