Pytest测试框架系列 - 通过hooks函数pytest_terminal_summary 通过企业微信推送简单测试报告

最新推荐文章于 2024-05-20 21:44:59 发布

测试之路king

最新推荐文章于 2024-05-20 21:44:59 发布

阅读量2.6k

点赞数 3

分类专栏： pytest 系列文章标签： python

本文版权归原作者所有，仅供学习参考之用，转载请注明出处未经作者允许请务必保留此段声明！

本文链接：https://blog.csdn.net/u010454117/article/details/119155473

版权

pytest 系列专栏收录该内容

23 篇文章 26 订阅

订阅专栏

前言

正常来说我们自动化测试执行完成之后，都会发送一个报告，以便相关人员查看测试情况，但是对于经常运行的用例如果每次去打开测试报告查看测试结果，大家就会慢慢不去关注测试结果，所以现在大多数都会采用简单的测试结果提醒，有问题再去查看详细的报告。

通过企业微信、钉钉、短信等发送推送消息(常用)
通过发送邮件

如果 通过企业微信、钉钉、短信等发送推送消息 方式，我们就需要获取当前测试完成后执行情况，在pytest 框架里面有一个Hooks函数 pytest_terminal_summary 就可以轻松获取到执行报告数据，下面我们来具体讲解一下如何使用。

pytest_terminal_summary 使用

源码：pytest_terminal_summary

def pytest_terminal_summary(
    terminalreporter: "TerminalReporter", exitstatus: "ExitCode", config: "Config",
) -> None:
    """Add a section to terminal summary reporting.

    :param _pytest.terminal.TerminalReporter terminalreporter: The internal terminal reporter object.
    :param int exitstatus: The exit status that will be reported back to the OS.
    :param _pytest.config.Config config: The pytest config object.

    .. versionadded:: 4.2
        The ``config`` parameter.
    """

这个我们需要关注的重点参数为 terminalreporter ,就是测试报告数据对象，由于是hooks函数，所以我们在contest.py里面进行使用.

contest.py示例：

def pytest_terminal_summary(terminalreporter, exitstatus, config):
    print(terminalreporter.__dict__)

这句话的意思就是打印出terminalreporter对象里面的属性、方法，为我们后面获取数据使用

test_summary.py 文件

# !/usr/bin/python3
# _*_coding:utf-8 _*_
""""
# @Time　　:2021/7/27 22:31
# @Author　 : king
# @File　　  :test_summary.py
# @Software  :PyCharm
# @blog     :https://blog.csdn.net/u010454117
# @WeChat Official Account: 【测试之路笔记】
"""
import pytest

def test_01():
    print("测试用例 test_01")
    assert 1 == 1

@pytest.mark.skip("跳过用例")
def test_02():
    print("测试用例 test_02")
    assert 1 == 2

def test_03():
    print("测试用例 test_03")
    assert 1 == 2

def test_04():
    print("测试用例 test_04", 1/0)
    assert 1 == 1

在命令行执行 pytest -s test_summary.py ，查看输出结果：

pytest -s test_summary.py

collected 4 items                                                                                                                                                       

{'config': <_pytest.config.Config object at 0x00000277AFC51C88>, '_numcollected': 4, '_session': <Session class_08 exitstatus=<ExitCode.TESTS_FAILED: 1> testsfailed=2 te
stscollected=4>, '_showfspath': None, 'stats': {'': [<TestReport 'test_summary.py::test_01' when='setup' outcome='passed'>, <TestReport 'test_summary.py::test_01' when='
teardown' outcome='passed'>, <TestReport 'test_summary.py::test_02' when='teardown' outcome='passed'>, <TestReport 'test_summary.py::test_03' when='setup' outcome='passe
d'>, <TestReport 'test_summary.py::test_03' when='teardown' outcome='passed'>, <TestReport 'test_summary.py::test_04' when='setup' outcome='passed'>, <TestReport 'test_s
ummary.py::test_04' when='teardown' outcome='passed'>], 'passed': [<TestReport 'test_summary.py::test_01' when='call' outcome='passed'>], 'skipped': [<TestReport 'test_s
ummary.py::test_02' when='setup' outcome='skipped'>], 'failed': [<TestReport 'test_summary.py::test_03' when='call' outcome='failed'>, <TestReport 'test_summary.py::test
_04' when='call' outcome='failed'>]}, '_main_color': 'red', '_known_types': ['failed', 'passed', 'skipped', 'deselected', 'xfailed', 'xpassed', 'warnings', 'error'], 'st
artdir': local('E:\\pytest_demo\\class_08'), 'startpath': WindowsPath('E:/pytest_demo/class_08'), '_tw': <_pytest._io.terminalwriter.TerminalWriter object at 0x00000277B
00BB550>, '_screen_width': 169, 'currentfspath': None, 'reportchars': 'wfE', 'hasmarkup': True, 'isatty': True, '_progress_nodeids_reported': set(), '_show_progress_info
': False, '_collect_report_last_write': 1627400262.0004442, '_already_displayed_warnings': None, '_keyboardinterrupt_memo': None, '_sessionstarttime': 1627400261.9884875
, '_tests_ran': True}
======short test summary info ========================================================================
FAILED test_summary.py::test_03 - assert 1 == 2
FAILED test_summary.py::test_04 - ZeroDivisionError: division by zero
=====2 failed, 1 passed, 1 skipped in 0.06s

从上述结果我们可以看出来，用例执行结果在stats里面，我们修改一下pytest_terminal_summary方法如下：

def pytest_terminal_summary(terminalreporter, exitstatus, config):
    # print(terminalreporter.__dict__)
    print("total:", terminalreporter._numcollected)  # 获取总用例数，就是 collected 的数量
    print('passed:', len(terminalreporter.stats.get('passed', [])))  # 获取 pass 的case
    print('failed:', len(terminalreporter.stats.get('failed', [])))  # 获取 failed 的case
    print('error:', len(terminalreporter.stats.get('error', [])))  # 获取 error 的case
    print('skipped:', len(terminalreporter.stats.get('skipped', [])))  # 获取 skipped 的case

再次在命令行执行 pytest -s test_summary.py ，查看输出结果：

(pytest_demo) E:\pytest_demo\class_08>pytest -s test_summary.py

collected 4 items                                                                                                                                                       

test_summary.py 测试用例 test_01
.s测试用例 test_03
FF

total: 4
passed: 1
failed: 2
error: 0
skipped: 1

short test summary info 
========================================================================
FAILED test_summary.py::test_03 - assert 1 == 2
FAILED test_summary.py::test_04 - ZeroDivisionError: division by zero
================================================================ 
2 failed, 1 passed, 1 skipped in 0.05s 
================================================================

目前case未添加前置setup和后置teardown，我们来添加一些，看下执行结果。
contest.py示例：

def pytest_terminal_summary(terminalreporter, exitstatus, config):
    print(terminalreporter.stats)
    print("total:", terminalreporter._numcollected)  # 获取总用例数，就是 collected 的数量
    print('passed:', len(terminalreporter.stats.get('passed', [])))  # 获取 pass 的case
    print('failed:', len(terminalreporter.stats.get('failed', [])))  # 获取 failed 的case
    print('error:', len(terminalreporter.stats.get('error', [])))  # 获取 error 的case
    print('skipped:', len(terminalreporter.stats.get('skipped', [])))  # 获取 skipped 的case

@pytest.fixture()
def set_up():
    print("我是后置操作！", 1/0)
    yield
    print("我是后置操作！", 1/2)

@pytest.fixture()
def tear_down():
    print("我是后置操作！", 1/1)
    yield
    print("我是后置操作！", 1/0)

test_summary.py 文件

# !/usr/bin/python3
# _*_coding:utf-8 _*_
""""
# @Time　　:2021/7/27 22:31
# @Author　 : king
# @File　　  :test_summary.py
# @Software  :PyCharm
# @blog     :https://blog.csdn.net/u010454117
# @WeChat Official Account: 【测试之路笔记】
"""
import pytest

def test_01():
    print("测试用例 test_01")
    assert 1 == 1

@pytest.mark.skip("跳过用例")
def test_02():
    print("测试用例 test_02")
    assert 1 == 2

def test_03():
    print("测试用例 test_03")
    assert 1 == 2

def test_04():
    print("测试用例 test_04", 1/0)
    assert 1 == 1

def test_05(set_up):
    print("测试用例 test_05")

def test_06(tear_down):
    print("测试用例 test_06")

再次在命令行执行 pytest -s test_summary.py ，查看输出结果：

从执行结果可以看出来，统计的用例结果不正确，总用例是6，但是 passed: 2 failed: 2 error: 2 skipped: 1加起来的个数是7，这个为什么？

再根据terminalreporter.stats分析结果：test_summary.py::test_06 在 when='call' 和 when='teardown'都做了统计，基本上用例 when='call'阶段执行成功，代表用例是成功的，teardown 阶段失败或者错误，不影响执行结果。

所以需要修改 pytest_terminal_summary统计方法：

def pytest_terminal_summary(terminalreporter, exitstatus, config):
    # print(terminalreporter.stats)

    # 获取总用例数，就是 collected 的数量
    print("total:", terminalreporter._numcollected)

    # 获取 pass 的case
    print('passed:', len([i for i in terminalreporter.stats.get('passed', [])]))

    # 获取 failed 的case
    print('failed:', len([i for i in terminalreporter.stats.get('failed', [])]))

    # 获取 error 的case
    print('error:', len([i for i in terminalreporter.stats.get('error', []) if i.when != 'teardown']))

    # 获取 skipped 的case
    print('skipped:', len([i for i in terminalreporter.stats.get('skipped', [])]))

再次在命令行执行 pytest -s test_summary.py ，查看输出结果，数据正确，如下图
执行结果

通过企业微信、钉钉、短信推送消息

方案：直接在pytest_terminal_summary下方调用微信、钉钉、短信推送消息的 api 即可实现，具体相应调用实现略。

def pytest_terminal_summary(terminalreporter, exitstatus, config):
    total_case = terminalreporter._numcollected
    pass_case = len([i for i in terminalreporter.stats.get('passed', [])])
    fail_case = len([i for i in terminalreporter.stats.get('failed', [])])
    error_case = len([i for i in terminalreporter.stats.get('error', [])])
    skip_case = len([i for i in terminalreporter.stats.get('skipped', [])])
    pass_rate = round(pass_case / total_case * 100, 2)

    desc = """
    本次执行情况如下：
    总用例数为：{}
    通过用例数：{}
    失败用例数：{}
    错误用例数：{}
    跳过用例数：{}
    通过率为： {} %
    """.format(total_case, pass_case, fail_case, error_case, skip_case, pass_rate)

    # TODO :此处可以调用微信、钉钉、短信相应方法推送消息
    # WeChat.sendMsg(desc)
    # DingDing.sendMsg(desc)
    # SMS.sendMsg(desc)

总结

pytest_terminal_summary 使用
pytest_terminal_summary 统计报告里面数据的准备度分析及解决

以上为内容纯属个人理解，如有不足，欢迎各位大神指正，转载请注明出处!

如果觉得文章不错，欢迎关注微信公众号，微信公众号每天推送相关测试技术文章

测试之路king

关注

3
点赞
踩
12

收藏

觉得还不错? 一键收藏
打赏
2
评论
Pytest测试框架系列 - 通过hooks函数pytest_terminal_summary 通过企业微信推送简单测试报告

前言正常来说我们自动化测试执行完成之后，都会发送一个报告，以便相关人员查看测试情况，但是对于经常运行的用例如果每次去打开测试报告查看测试结果，大家就会慢慢不去关注测试结果，所以现在大多数都会采用简单的测试结果提醒，有问题再去查看详细的报告。通过企业微信、钉钉、短信等发送推送消息(常用)通过发送邮件如果通过企业微信、钉钉、短信等发送推送消息方式，我们就需要获取当前测试完成后执行情况，在pytest 框架里面有一个Hooks函数 pytest_terminal_summary 就可以轻松获取到执
复制链接

扫一扫