HTMLTestRunner

HTMLTestRunner 生成報告如下圖：

 

 

 展開后可查看詳情信息：

 

直接復制以下代碼，保存為HTMLTestRunner.py 即可

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

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

# 全局變量      -- Gelomen
_global_dict = {}


# 讓新建的報告文件夾路徑存入全局變量       -- Gelomen
class GlobalMsg(object):
    def __init__(self):
        global _global_dict
        _global_dict = {}

    @staticmethod
    def set_value(name, value):
        _global_dict[name] = value

    @staticmethod
    def get_value(name):
        try:
            return _global_dict[name]
        except KeyError:
            return None


# ------------------------------------------------------------------------
# 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
    +------------------------+
    |<html>                  |
    |  <head>                |
    |                        |
    |   STYLESHEET           |
    |   +----------------+   |
    |   |                |   |
    |   +----------------+   |
    |                        |
    |  </head>               |
    |                        |
    |  <body>                |
    |                        |
    |   HEADING              |
    |   +----------------+   |
    |   |                |   |
    |   +----------------+   |
    |                        |
    |   REPORT               |
    |   +----------------+   |
    |   |                |   |
    |   +----------------+   |
    |                        |
    |   ENDING               |
    |   +----------------+   |
    |   |                |   |
    |   +----------------+   |
    |                        |
    |  </body>               |
    |</html>                 |
    +------------------------+
    """

    STATUS = {
        0: '通過',
        1: '失敗',
        2: '錯誤',
    }

    DEFAULT_TITLE = '測試報告'
    DEFAULT_DESCRIPTION = ''
    DEFAULT_TESTER = 'QA'

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

    HTML_TMPL = r"""<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <title>%(title)s</title>
    <meta name="generator" content="%(generator)s"/>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
    <link href="http://libs.baidu.com/bootstrap/3.0.3/css/bootstrap.min.css" rel="stylesheet">
    <script src="http://libs.baidu.com/jquery/2.0.0/jquery.min.js"></script>
    <script src="http://libs.baidu.com/bootstrap/3.0.3/js/bootstrap.min.js"></script>
    <script src="https://img.hcharts.cn/highcharts/highcharts.js"></script>
    <script src="https://img.hcharts.cn/highcharts/modules/exporting.js"></script>
    %(stylesheet)s
</head>
<body >
<script language="javascript" type="text/javascript">
    $(function(){
        // 修改 失敗 和 錯誤 用例里對應按鈕的顏色ClassName為動態加載 -- Gelomen
        $("button").each(function () {
            var text = $(this).text();
            if(text == "失敗"){
                $(this).addClass("btn-danger")
            }else if(text == "錯誤") {
                $(this).addClass("btn-warning")
            }
        });
        // 給失敗和錯誤合集加樣式 -- Gelomen
        var p_attribute = $("p.attribute");
        p_attribute.eq(4).addClass("failCollection");
        p_attribute.eq(5).addClass("errorCollection");
        // 打開截圖，放大，點擊任何位置可以關閉圖片  -- Gelomen
        $(".screenshot").click(function(){
            var img = $(this).attr("img");
            $('.pic_show img').attr('src', img);
            $('.pic_looper').fadeIn(200);
            $('.pic_show').fadeIn(200);
            var browserHeight = $(window).height();
            var pic_boxHeight = $(".pic_box").height();
            var top = (browserHeight - pic_boxHeight)/2;
            $('.pic_box').css("margin-top", top + "px")
        });
        $('.pic_looper, .pic_show').click(function(){
            $('.pic_looper').fadeOut(200);
            $('.pic_show').fadeOut(200)
        });
        var browserWidth = $(window).width();
        var margin_left = browserWidth/2 - 450;
        if(margin_left <= 240){
            $("#container").css("margin", "auto");
        }else {
            $("#container").css("margin-left", margin_left + "px");
        }
        $(window).resize(function(){
            // 改變窗口大小時，自動改變圖片與頂部的距離  -- Gelomen
            var browserHeight = $(window).height();
            var pic_boxHeight = $(".pic_box").height();
            var top = (browserHeight - pic_boxHeight)/2;
            $('.pic_box').css("margin-top", top + "px");
            // 改變窗口大小時，自動改變餅圖的邊距  -- Gelomen
            var browserWidth = $(window).width();
            var margin_left = browserWidth/2 - 450;
            if(margin_left <= 240){
                $("#container").css("margin", "auto");
            }else {
                $("#container").css("margin-left", margin_left + "px");
            }
        });
        // 距離頂部超過瀏覽器窗口一屏時，回到頂部按鈕才出現  -- Gelomen
        $(window).scroll(function(){
            var browserHeight = $(window).height();
            var top = $(window).scrollTop();
            if(top >= browserHeight){
                $("#toTop").css("display", "block")
            }else {
                $("#toTop").css("display", "none")
            }
        })
        // 增加回到頂部過程的動畫，以看上去不會那么生硬  -- Gelomen
        $("#toTop").click(function() {
            $("html,body").animate({"scrollTop":0}, 700)
        })
        // 增加餅狀圖  -- Gelomen
        $('#container').highcharts({
            chart: {
                plotBackgroundColor: null,
                plotBorderWidth: null,
                plotShadow: false,
                spacing : [0, 0, 0, 0]
            },
            credits: {
                enabled: false
            },
            navigation: {
                buttonOptions: {
                    enabled: false
                }
            },
            title: {
                floating:true,
                text: '測試結果占比'
            },
            tooltip: {
                pointFormat: '{series.name}: <b>{point.percentage:.1f}%%</b>'
            },
            plotOptions: {
                pie: {
                    allowPointSelect: true,
                    cursor: 'pointer',
                    colors: ['#81ca9d', '#f16d7e', '#fdc68c'],
                    dataLabels: {
                        enabled: true,
                        format: '<b>{point.name}</b>: {point.percentage:.1f} %%',
                        style: {
                            color: (Highcharts.theme && Highcharts.theme.contrastTextColor) || 'black'
                        }
                    },
                    point: {
                        events: {
                            mouseOver: function(e) {  // 鼠標滑過時動態更新標題
                                chart.setTitle({
                                    text: e.target.name+ '\t'+ e.target.y + ' 個'
                                });
                            }
                        }
                    }
                }
            },
            series: [{
                type: 'pie',
                innerSize: '80%%',
                name: '比例',
                data: [
                    ['通過', %(Pass)s],
                    {
                        name: '失敗',
                        y: %(fail)s,
                        sliced: true,
                        selected: true
                    },
                    ['錯誤', %(error)s]
                ]
            }]
        }, function(c) {
            // 環形圖圓心
            var centerY = c.series[0].center[1],
                titleHeight = parseInt(c.title.styles.fontSize);
            c.setTitle({
                y:centerY + titleHeight/2
            });
            chart = c;
        });
        // 查看 失敗 和 錯誤 合集鏈接文字切換  -- Gelomen
        $(".showDetail").click(function () {
            if($(this).html() == "點擊查看"){
                $(this).html("點擊收起")
            }else {
                $(this).html("點擊查看")
            }
        })
    });
output_list = Array();
/*level 調整增加只顯示通過用例的分類 --Findyou / 修復篩選顯示bug --Gelomen
0:Summary //all hiddenRow
1:Failed  //pt&et hiddenRow, ft none
2:Pass    //pt none, ft&et hiddenRow
3:Error   //pt&ft hiddenRow, et none
4:All     //all none
*/
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 == 2 || level == 0 || level == 3) {
                tr.className = 'hiddenRow';
            }
            else {
                tr.className = '';
                // 切換篩選時只顯示預覽   -- Gelomen
                $("div[id^='div_ft']").attr("class", "collapse");
                $("div[id^='div_et']").attr("class", "collapse");
            }
        }
        if (id.substr(0,2) == 'pt') {
            if (level == 1 || level == 0 || level == 3) {
                tr.className = 'hiddenRow';
            }
            else {
                tr.className = '';
                // 切換篩選時只顯示預覽   -- Gelomen
                $("div[id^='div_ft']").attr("class", "collapse");
                $("div[id^='div_et']").attr("class", "collapse");
            }
        }
        if (id.substr(0,2) == 'et') {
            if (level == 1 || level == 0 || level == 2) {
                tr.className = 'hiddenRow';
            }
            else {
                tr.className = '';
                // 切換篩選時只顯示預覽   -- Gelomen
                $("div[id^='div_ft']").attr("class", "collapse");
                $("div[id^='div_et']").attr("class", "collapse");
            }
        }
    }
    //加入【詳細】切換文字變化 --Findyou
    detail_class=document.getElementsByClassName('detail');
    //console.log(detail_class.length)
    if (level == 3) {
        for (var i = 0; i < detail_class.length; i++){
            detail_class[i].innerHTML="收起"
        }
    }
    else{
            for (var i = 0; i < detail_class.length; i++){
            detail_class[i].innerHTML="詳細"
        }
    }
}
function showClassDetail(cid, count) {
    var id_list = Array(count);
    var toHide = 1;
    for (var i = 0; i < count; i++) {
        //ID修改 點 為 下划線 -Findyou
        tid0 = 't' + cid.substr(1) + '_' + (i+1);
        tid = 'f' + tid0;
        tr = document.getElementById(tid);
        if (!tr) {
            tid = 'p' + tid0;
            tr = document.getElementById(tid);
            if (!tr) {
                tid = 'e' + 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];
        //修改點擊無法收起的BUG，加入【詳細】切換文字變化 --Findyou
        if (toHide) {
            document.getElementById(tid).className = 'hiddenRow';
            document.getElementById(cid).innerText = "詳細"
        }
        else {
            document.getElementById(tid).className = '';
            document.getElementById(cid).innerText = "收起"
        }
    }
}
function html_escape(s) {
    s = s.replace(/&/g,'&amp;');
    s = s.replace(/</g,'&lt;');
    s = s.replace(/>/g,'&gt;');
    return s;
}
</script>
%(heading)s
%(report)s
%(ending)s
</body>
</html>
"""
    # 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 = """
<style type="text/css" media="screen">
body        { font-family: Microsoft YaHei;padding: 20px; font-size: 100%; }
table       { font-size: 100%; }
.table tbody tr td{
            vertical-align: middle;
        }
/* -- heading ---------------------------------------------------------------------- */
.heading .description, .attribute {
    clear: both;
}
/* --- 失敗和錯誤合集樣式 -- Gelomen --- */
.failCollection, .errorCollection {
    width: 100px;
    float: left;
}
#failCaseOl li {
    color: red
}
#errorCaseOl li {
    color: orange
}
/* --- 打開截圖特效樣式 -- Gelomen --- */
.data-img{
    cursor:pointer
}
.pic_looper{
    width:100%;
    height:100%;
    position: fixed;
    left: 0;
    top:0;
    opacity: 0.6;
    background: #000;
    display: none;
    z-index: 100;
}
.pic_show{
    width:100%;
    position:fixed;
    left:0;
    top:0;
    right:0;
    bottom:0;
    margin:auto;
    text-align: center;
    display: none;
    z-index: 100;
}
.pic_box{
    padding:10px;
    width:90%;
    height:90%;
    margin:40px auto;
    text-align: center;
    overflow: hidden;
}
.pic_box img{
    width: auto;
    height: 100%;
    -moz-box-shadow: 0px 0px 20px 0px #000;
    -webkit-box-shadow: 0px 0px 20px 0px #000;
    box-shadow: 0px 0px 20px 0px #000;
}
/* --- 餅狀圖div樣式 -- Gelomen --- */
#container {
    width: 450px;
    height: 300px;
    float: left;
}
/* -- report ------------------------------------------------------------------------ */
#total_row  { font-weight: bold; }
.passCase   { color: #5cb85c; }
.failCase   { color: #d9534f; font-weight: bold; }
.errorCase  { color: #f0ad4e; font-weight: bold; }
.hiddenRow  { display: none; }
.testcase   { margin-left: 2em; }
.screenshot:link { text-decoration: none;color: deeppink; }
.screenshot:visited { text-decoration: none;color: deeppink; }
.screenshot:hover { text-decoration: none;color: darkcyan; }
.screenshot:active { text-decoration: none;color: deeppink; }
</style>
"""

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

    # 添加顯示截圖 和 餅狀圖 的div  -- Gelomen
    HEADING_TMPL = """<div class='pic_looper'></div> <div class='pic_show'><div class='pic_box'><img src=''/></div> </div>
<div class='heading'>
<div style="width: 650px; float: left;">
    <h1 style="font-family: Microsoft YaHei">%(title)s</h1>
    %(parameters)s
    <p class='description'>%(description)s</p>
</div>
<div id="container"></div>
</div>
"""  # variables: (title, parameters, description)

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

    # ------------------------------------------------------------------------
    # Report
    #
    # 漢化,加美化效果 --Findyou
    REPORT_TMPL = """
<div style="width: 500px; clear: both;">
<p id='show_detail_line'>
<a class="btn btn-primary" href='javascript:showCase(0)'>概要{ %(passrate)s }</a>
<a class="btn btn-success" href='javascript:showCase(2)'>通過{ %(Pass)s }</a>
<a class="btn btn-danger" href='javascript:showCase(1)'>失敗{ %(fail)s }</a>
<a class="btn btn-warning" href='javascript:showCase(3)'>錯誤{ %(error)s }</a>
<a class="btn btn-info" href='javascript:showCase(4)'>所有{ %(count)s }</a>
</p>
</div>
<table id='result_table' class="table table-condensed table-bordered table-hover">
<colgroup>
<col align='left' style="width: 300px;"/>
<col align='right' style="width: 300px;"/>
<col align='right' />
<col align='right' />
<col align='right' />
<col align='right' />
<col align='right' />
<col align='right' style="width: 200px;"/>
</colgroup>
<tr id='header_row' class="text-center success" style="font-weight: bold;font-size: 14px;">
    <td>用例集/測試用例</td>
    <td>說明</td>
    <td>總計</td>
    <td>通過</td>
    <td>失敗</td>
    <td>錯誤</td>
    <td>耗時</td>
    <td>詳細</td>
</tr>
%(test_list)s
<tr id='total_row' class="text-center active">
    <td colspan='2'>總計</td>
    <td>%(count)s</td>
    <td>%(Pass)s</td>
    <td>%(fail)s</td>
    <td>%(error)s</td>
    <td>%(time_usage)s</td>
    <td>通過率：%(passrate)s</td>
</tr>
</table>
"""  # variables: (test_list, count, Pass, fail, error ,passrate)

    REPORT_CLASS_TMPL = r"""
<tr class='%(style)s warning'>
    <td>%(name)s</td>
    <td>%(doc)s</td>
    <td class="text-center">%(count)s</td>
    <td class="text-center">%(Pass)s</td>
    <td class="text-center">%(fail)s</td>
    <td class="text-center">%(error)s</td>
    <td class="text-center">%(time_usage)s</td>
    <td class="text-center"><a href="javascript:showClassDetail('%(cid)s',%(count)s)" class="detail" id='%(cid)s'>詳細</a></td>
</tr>
"""  # variables: (style, desc, count, Pass, fail, error, cid)

    # 失敗 的樣式，去掉原來JS效果，美化展示效果  -Findyou / 美化類名上下居中，有截圖列 -- Gelomen
    REPORT_TEST_WITH_OUTPUT_TMPL_1 = r"""
<tr id='%(tid)s' class='%(Class)s'>
    <td class='%(style)s' style="vertical-align: middle"><div class='testcase'>%(name)s</div></td>
    <td style="vertical-align: middle">%(doc)s</td>
    <td colspan='5' align='center'>
    <!--默認收起錯誤信息 -Findyou
    <button id='btn_%(tid)s' type="button"  class="btn btn-xs collapsed" data-toggle="collapse" data-target='#div_%(tid)s'>%(status)s</button>
    <div id='div_%(tid)s' class="collapse">  -->
    <!-- 默認展開錯誤信息 -Findyou /  修復失敗按鈕的顏色 -- Gelomen -->
    <button id='btn_%(tid)s' type="button"  class="btn btn-xs" data-toggle="collapse" data-target='#div_%(tid)s,#div_%(tid)s_screenshot'>%(status)s</button>
    <div id='div_%(tid)s' class="collapse in">
    <pre style="text-align:left">
    %(script)s
    </pre>
    </div>
    </td>
    <td class="text-center" style="vertical-align: middle"><div id='div_%(tid)s_screenshot' class="collapse in">瀏覽器版本：<div style="color: brown;">%(browser)s</div></br>截圖：%(screenshot)s</div></td>
</tr>
"""  # variables: (tid, Class, style, desc, status)

    # 失敗 的樣式，去掉原來JS效果，美化展示效果  -Findyou / 美化類名上下居中，無截圖列 -- Gelomen
    REPORT_TEST_WITH_OUTPUT_TMPL_0 = r"""
    <tr id='%(tid)s' class='%(Class)s'>
        <td class='%(style)s' style="vertical-align: middle"><div class='testcase'>%(name)s</div></td>
        <td style="vertical-align: middle">%(doc)s</td>
        <td colspan='5' align='center'>
        <!--默認收起錯誤信息 -Findyou
        <button id='btn_%(tid)s' type="button"  class="btn btn-xs collapsed" data-toggle="collapse" data-target='#div_%(tid)s'>%(status)s</button>
        <div id='div_%(tid)s' class="collapse">  -->
        <!-- 默認展開錯誤信息 -Findyou /  修復失敗按鈕的顏色 -- Gelomen -->
        <button id='btn_%(tid)s' type="button"  class="btn btn-xs" data-toggle="collapse" data-target='#div_%(tid)s'>%(status)s</button>
        <div id='div_%(tid)s' class="collapse in">
        <pre style="text-align:left">
        %(script)s
        </pre>
        </div>
        </td>
        <td class='%(style)s' style="vertical-align: middle"></td>
    </tr>
    """  # variables: (tid, Class, style, desc, status)

    # 通過 的樣式，加標簽效果  -Findyou / 美化類名上下居中 -- Gelomen
    REPORT_TEST_NO_OUTPUT_TMPL = r"""
<tr id='%(tid)s' class='%(Class)s'>
    <td class='%(style)s' style="vertical-align: middle"><div class='testcase'>%(name)s</div></td>
    <td style="vertical-align: left">%(doc)s</td>
    <td colspan='5' align='center'><span class="label label-success success">%(status)s</span></td>
    <td class='%(style)s' style="vertical-align: middle"></td>
</tr>
"""  # variables: (tid, Class, style, desc, status)

    REPORT_TEST_OUTPUT_TMPL = r"""
%(id)s: %(output)s
"""  # variables: (id, output)

    # ------------------------------------------------------------------------
    # ENDING
    #
    # 增加返回頂部按鈕  --Findyou
    ENDING_TMPL = """<div id='ending'>&nbsp;</div>
    <div id="toTop" style=" position:fixed;right:50px; bottom:30px; width:20px; height:20px;cursor:pointer; display: none">
    <a><span class="glyphicon glyphicon-eject" style = "font-size:30px;" aria-hidden="true">
    </span></a></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 = []
        # 增加一個測試通過率 --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 += "<li>" + str(test) + "</li>"

    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 += "<li>" + str(test) + "</li>"


# 新增 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="<ol style='float: left;'>" + value + "</ol>",
                    )
                else:
                    line = self.HEADING_ATTRIBUTE_TMPL % dict(
                        name=name,
                        value="<div class='panel-default' style='float: left;'><a class='showDetail' data-toggle='collapse' href='#failCaseOl' style='text-decoration: none;'>點擊查看</a></div>"
                              "<ol id='failCaseOl' class='collapse' style='float: left;'>" + value + "</ol>",
                    )
            elif name == "錯誤用例合集":
                if value == "無":
                    line = self.HEADING_ATTRIBUTE_TMPL % dict(
                        name=name,
                        value="<ol style='float: left;'>" + value + "</ol>",
                    )
                else:
                    line = self.HEADING_ATTRIBUTE_TMPL % dict(
                        name=name,
                        value="<div class='panel-default' style='float: left;'><a class='showDetail' data-toggle='collapse' href='#errorCaseOl' style='text-decoration: none;'>點擊查看</a></div>"
                              "<ol id='errorCaseOl' class='collapse' style='float: left;'>" + value + "</ol>",
                    )
            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 += "</br><a class=\"screenshot\" href=\"javascript:void(0)\" img=\"image/" + i + "\">img_" + i + "</a>"

            # 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 DirAndFiles(object):

    def __init__(self):
        self.path = "../../result/"
        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["version"]
        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)