基于nose-html-report定制测试报告

环境准备

参考文章

pip3.5 install nose-html-report 

安装目录文件:

├── __init__.py

├── __pycache__

│   └── __init__.cpython-35.pyc

└── templates

├── report2.jinja2

└── report.html

主要修改 __init__.py文件及测试报告模板文件report2.jinja2

jinja2模板有自己的语法,参见 链接

对于jinja中的语法:

if elif else endif  条件语法 

{% if not test.failed %}

{% set test_status="Pass" %}

{% elif test.failed and test.type == 'skipped' %}

{% set test_status="Skip" %}

{% elif test.failed and test.type != 'skipped' %}

{% set test_status="Fail" %}

{%- else -%}

{% set test_status="Error" %}

{%- endif %}

for语法

{% for test in group.tests %}

{%- endfor -%}

测试报告定制的实现主要包括如下类

class OutputRedirector(object):  # 输出重定向类,包含一个文件对象fp,主要包括如下方法

def write(self, s):   

def writelines(self, lines):

def flush(self):

def readall(self):

class Group(object):  # 测试用例组,主要包括如下两个对象

self.stats = {'errors': 0, 'failures': 0, 'passes': 0, 'skipped': 0} # 用例组的结果状态统计

self.tests = [] # 用例组中具体测试用例统计

class HtmlReport(Plugin):  # 测试报告插件

主要包括startTest、begin、complete_test_output、 complete_global_output、report、addSuccess、addError、addFailure等方法,具体实现如下:

def __init__(self, verbosity=1): #全局变量、报告统计数据初始化

    super(HtmlReport, self).__init__()

    self.global_stdout0 = None

    self.global_stderr0 = None

    self.test_stdout0 = None

    self.test_stderr0 = None

    self.testOutputBuffer = StringIO.StringIO()

    self.globalOutputBuffer = StringIO.StringIO()

    self.stdout_redirector = OutputRedirector(sys.stdout)

    self.stderr_redirector = OutputRedirector(sys.stderr)

    self.test_stdout_redirector = OutputRedirector(sys.stdout)

    self.test_stderr_redirector = OutputRedirector(sys.stderr)

    self.verbosity = verbosity

def startTest(self, test):   # 重定向输出初始化

    # just one buffer for both stdout and stderr

    self.testOutputBuffer = StringIO.StringIO()

    self.test_stdout_redirector.fp = self.testOutputBuffer

    self.test_stderr_redirector.fp = self.testOutputBuffer

    self.test_stdout0 = sys.stdout

    self.test_stderr0 = sys.stderr

    sys.stdout = self.test_stdout_redirector

    sys.stderr = self.test_stderr_redirector

    self.test_start_time = datetime.now()

def complete_test_output(self, err_msg='', traceback=''): 

# 测试完成后的断开重定向链接同时返回缓存数据

"""

Disconnect output redirection and return buffer.

Safe to call multiple times.

"""

if self.test_stdout0:

    sys.stdout = self.test_stdout0

    sys.stderr = self.test_stderr0

    self.test_stdout0 = None

    self.test_stderr0 = None

self.globalOutputBuffer.write(self.testOutputBuffer.getvalue())

self.globalOutputBuffer.write(err_msg)

self.globalOutputBuffer.write(traceback)

return self.testOutputBuffer.getvalue()

def begin(self): # 测试用例执行

    # just one buffer for both stdout and stderr

    # self.outputBuffer = StringIO.StringIO()

    self.stdout_redirector.fp = self.globalOutputBuffer

    self.stderr_redirector.fp = self.globalOutputBuffer

    self.global_stdout0 = sys.stdout

    self.global_stderr0 = sys.stderr

    sys.stdout = self.stdout_redirector

    sys.stderr = self.stderr_redirector

def complete_global_output(self):  # 所有测试用例执行后的操作

    """

    Disconnect output redirection and return buffer.

    Safe to call multiple times.

    """

    if self.global_stdout0:

        sys.stdout = self.global_stdout0

        sys.stderr = self.global_stderr0

        self.global_stdout0 = None

        self.global_stderr0 = None

    return self.globalOutputBuffer.getvalue()

def options(self, parser, env): 通过nosetests运行测试用例时携带的命令选项  

def configure(self, options, config):  通过命令配置进行实际配置加载(加载指定报告模板)

def report(self, stream): # 基于模板,对模板中的变量进行赋值,写测试报告   通过report_data,以group为单位,对测试结果结果进行传递,group中包含stats及tests对象,分别记录该测试组中测试运行状态及具体用例信息

    """Writes an Xunit-formatted XML file

    The file includes a report of test errors and failures.

    """

    self.stats['total'] = sum(self.stats.values())

    for group in self.report_data.values():

        group.stats['total'] = sum(group.stats.values())

    self.report_file.write(self.jinja.get_template(os.path.basename(self.report_template_filename)).render(

        report=self.report_data,

        stats=self.stats,

        start_time = str(self.test_start_time)[:19],

        rawoutput=self._format_output(self.complete_global_output()),

        duration_time = self.test_duration_time - datetime.resolution

    ))

    self.report_file.close()

    if self.config.verbosity > 1:

        stream.writeln("-" * 70)

        stream.writeln("HTML: %s" % self.report_file.name)

def addSuccess(self, test):   # 测试成功 返回的状态信息及用例详情

    name = id_split(test.id())

    group = self.report_data[name[0]]

    self.stats['passes'] += 1

    group.stats['passes'] += 1

    group.tests.append({

        'name': name[-1],

        'failed': False,

        'output': self._format_output(self.complete_test_output()),

        'shortDescription': test.shortDescription(),

        'time': str(datetime.now() - self.test_start_time),

    })

def addError(self, test, err, capt=None):    # 测试失败 返回的状态信息及用例详情、错误信息等

    """Add error output to Xunit report.

    """

    exc_type, exc_val, tb = err

    tb = ''.join(traceback.format_exception(

        exc_type,

        exc_val if isinstance(exc_val, exc_type) else exc_type(exc_val),

        tb

    ))

    name = id_split(test.id())

    group = self.report_data[name[0]]

    if issubclass(err[0], SkipTest):

        type = 'skipped'

        self.stats['skipped'] += 1

        group.stats['skipped'] += 1

    else:

        type = 'error'

        self.stats['errors'] += 1

        group.stats['errors'] += 1

    group.tests.append({

        'name': name[-1],

        'failed': True,

        'type': type,

        'errtype': nice_classname(err[0]),

        'message': exc_message(err),

        'tb': self._format_output(tb),

        'output': self._format_output(self.complete_test_output(exc_message(err), tb)),

        'shortDescription': test.shortDescription(),

        'time': str(datetime.now() - self.test_start_time),

    })

def addFailure(self, test, err, capt=None):    # 测试失败 返回的状态信息及用例详情、失败详情

    """Add failure output to Xunit report.

    """

    exc_type, exc_val, tb = err

    tb = ''.join(traceback.format_exception(

        exc_type,

        exc_val if isinstance(exc_val, exc_type) else exc_type(exc_val),

        tb

    ))

    name = id_split(test.id())

    group = self.report_data[name[0]]

    self.stats['failures'] += 1

    group.stats['failures'] += 1

    group.tests.append({

        'name': name[-1],

        'failed': True,

        'errtype': nice_classname(err[0]),

        'message': exc_message(err),

        'tb': self._format_output(tb),

        'output': self._format_output(self.complete_test_output(exc_message(err), tb)),

        'shortDescription': test.shortDescription(),

        'time': str(datetime.now() - self.test_start_time),

    })

def _format_output(self, o): #指定编码

    if isinstance(o, str):

        # return o.decode('latin-1')

        return o.decode('UTF-8')

    else:

        return o

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,734评论 6 505
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,931评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,133评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,532评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,585评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,462评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,262评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,153评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,587评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,792评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,919评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,635评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,237评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,855评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,983评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,048评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,864评论 2 354

推荐阅读更多精彩内容