如何通过pytest的pytest_runtest_makereport钩子函数获取测试用例执行结果？

本文共计1846个文字，预计阅读时间需要8分钟。

前言：pytest测试框架提供的丰富钩子函数方便我们进行二次开发，可依据自身需求进行改造。

例如：钩子方法：pytest_runtest_makereport，可更清晰地了解测试用例的执行过程。

前言

pytest测试框架提供的很多钩子函数方便我们对测试框架进行二次开发，可以根据自己的需求进行改造。

例如：钩子方法：pytest_runtest_makereport，可以更清晰的了解测试用例的执行过程，并获取到每个测试用例的执行结果。

pytest_runtest_makereport方法简介

先看下相关的源码，在_pytest/runner.py文件下，可以导入之后查看：

源码：

from _pytest import runner

# 对应源码
def pytest_runtest_makereport(item, call):
""" return a :py:class:`_pytest.runner.TestReport` object
for the given :py:class:`pytest.Item` and
:py:class:`_pytest.runner.CallInfo`.
"""

装饰器pytest.hookimpl(hookwrapper=True, tryfirst=True)解释：

@pytest.hookimpl(hookwrapper=True)装饰的钩子函数，有以下两个作用：

1、可以获取到测试用例不同执行阶段的结果（setup，call，teardown）

2、可以获取钩子方法pytest_runtest_makereport(item, call)的调用结果（yield返回一个测试用例执行后的result对象）和调用结果result对象中的测试报告（返回一个report对象）

pytest_runtest_makereport(item, call)钩子函数参数解释：

1、item是测试用例对象；

2、call是测试用例的测试步骤；具体执行过程如下：

①先执行 when="setup"，返回​​setup用例前置操作函数​​的执行结果。

②然后执行 when="call"，返回​​call测试用例​​的执行结果。

③最后执行 when="teardown" ，返回​​teardown用例后置操作函数​​的执行结果。

第一个案例

conftest.py文件编写pytest_runtest_makereport钩子方法，打印运行过程和运行结果。

# conftest.py

import pytest

@pytest.hookimpl(hookwrapper=True, tryfirst=True)
def pytest_runtest_makereport(item, call):
print('------------------------------------')

# 获取钩子方法的调用结果，返回一个result对象
out = yield
print('用例执行结果', out)

# 从钩子方法的调用结果中获取测试报告
report = out.get_result()

print('测试报告：%s' % report)
print('步骤：%s' % report.when)
print('nodeid：%s' % report.nodeid)
print('description:%s' % str(item.function.__doc__))
print(('运行结果: %s' % report.outcome))

test_a.py写一个简单的用例：

def test_a():
'''用例描述:test_a'''

print("123")

运行结果：

结果分析：

从结果可以看到，测试用例的执行过程会经历3个阶段：

setup -> call -> teardown

每个阶段会返回Result对象和TestReport对象，以及对象属性。（​​setup​​​和​​teardown​​​上面的用例默认没有，结果都是​​passed​​。）

第二个案例

给用例写个fixture()函数增加测试用例的前置和后置操作；conftest.py如下：

import pytest

@pytest.hookimpl(hookwrapper=True, tryfirst=True)
def pytest_runtest_makereport(item, call):
print('------------------------------------')

# 获取钩子方法的调用结果
out = yield
print('用例执行结果', out)

# 从钩子方法的调用结果中获取测试报告
report = out.get_result()

print('测试报告：%s' % report)
print('步骤：%s' % report.when)
print('nodeid：%s' % report.nodeid)
print('description:%s' % str(item.function.__doc__))
print(('运行结果: %s' % report.outcome))


@pytest.fixture(scope="session", autouse=True)
def fix_a():
print("setup 前置操作")
yield
print("teardown 后置操作")

第三个案例

fixture()函数的setup前置函数在执行时异常，即setup执行结果为failed，则后面的call测试用例与teardown后置操作函数都不会执行。

此时的状态是error，也就是代表测试用例还没开始执行就已经异常了。（在执行前置操作函数的时候就已经发生异常）

import pytest


@pytest.hookimpl(hookwrapper=True, tryfirst=True)
def pytest_runtest_makereport(item, call):
print('------------------------------------')

# 获取钩子方法的调用结果
out = yield
print('用例执行结果', out)

# 从钩子方法的调用结果中获取测试报告
report = out.get_result()

print('测试报告：%s' % report)
print('步骤：%s' % report.when)
print('nodeid：%s' % report.nodeid)
print('description:%s' % str(item.function.__doc__))
print(('运行结果: %s' % report.outcome))


@pytest.fixture(scope="session", autouse=True)
def fix_a():
print("setup 前置操作")
assert 1 == 2
yield
print("teardown 后置操作")

第四个案例

setup前置操作函数正常执行，测试用例call执行发生异常。

此时的测试用例执行结果为failed

# conftest.py

import pytest


@pytest.hookimpl(hookwrapper=True, tryfirst=True)
def pytest_runtest_makereport(item, call):
print('------------------------------------')

# 获取钩子方法的调用结果
out = yield
print('用例执行结果', out)

# 3. 从钩子方法的调用结果中获取测试报告
report = out.get_result()

print('测试报告：%s' % report)
print('步骤：%s' % report.when)
print('nodeid：%s' % report.nodeid)
print('description:%s' % str(item.function.__doc__))
print(('运行结果: %s' % report.outcome))


@pytest.fixture(scope="session", autouse=True)
def fix_a():
print("setup 前置操作")
yield
print("teardown 后置操作")# test_a.py

def test_a():
"""用例描述:test_a"""

print("123")
assert 1 == 0

第五个案例

setup前置操作函数正常执行，测试用例call正常执行，teardown后置操作函数执行时发生异常。

测试用例正常执行，但是测试结果中会有error，因为teardown后置操作函数在执行时发生异常

# conftest.py

import pytest


@pytest.hookimpl(hookwrapper=True, tryfirst=True)
def pytest_runtest_makereport(item, call):
print('------------------------------------')

# 获取钩子方法的调用结果
out = yield
print('用例执行结果', out)

# 从钩子方法的调用结果中获取测试报告
report = out.get_result()

print('测试报告：%s' % report)
print('步骤：%s' % report.when)
print('nodeid：%s' % report.nodeid)
print('description:%s' % str(item.function.__doc__))
print(('运行结果: %s' % report.outcome))


@pytest.fixture(scope="session", autouse=True)
def fix_a():
print("setup 前置操作")
yield
print("teardown 后置操作")
raise Exception("teardown 失败了")# test_a.py

def test_a():
'''用例描述:test_a'''
print("123")

第六个案例：只获取call结果

场景：编写测试用例时，在保证setup前置操作函数和teardown后置操作函数不报错的前提下，我们一般只需要关注测试用例的执行结果，即只需要获取测试用例执行call的结果。

解决办法：因为前面的pytest_runtest_makereport钩子方法执行了三次。所以在打印测试报告的相关数据之气可以加个判断：if report.when == "call"。

import pytest
from _pytest import runner

'''
# 对应源码
def pytest_runtest_makereport(item, call):
""" return a :py:class:`_pytest.runner.TestReport` object
for the given :py:class:`pytest.Item` and
:py:class:`_pytest.runner.CallInfo`.
"""
'''


@pytest.hookimpl(hookwrapper=True, tryfirst=True)
def pytest_runtest_makereport(item, call):
print('------------------------------------')

# 获取钩子方法的调用结果
out = yield
# print('用例执行结果:', out)

# 从钩子方法的调用结果中获取测试报告
report = out.get_result()

if report.when == "call":
print('测试报告：%s' % report)
print('步骤：%s' % report.when)
print('nodeid：%s' % report.nodeid)
print('description:%s' % str(item.function.__doc__))
print(('运行结果: %s' % report.outcome))


@pytest.fixture(scope="session", autouse=True)
def fix_a():
print("setup 前置操作")
yield
print("teardown 后置操作")

conftest.py去除pytest_runtest_makereport钩子方法，正常执行测试用例

# conftest.py

import pytest

@pytest.fixture(scope="session", autouse=True)
def fix_a():
print("setup 前置操作")
yield
print("teardown 后置操作")# test_a.py

def test_a():
"""用例描述:test_a"""

print("123")

去期待陌生，去拥抱惊喜。