【pytest进阶】pytest之hook函数

什么是 hook 函数

比如说你写了一个框架类的程序，你希望这个框架可以“被其他的代码注入”，即别人可以加入代码对你这个框架进行定制化，该如何做比较好？
一种很常见的方式就是约定一个规则，框架初始化时会收集满足这个规则的所有代码（文件），然后把这些代码加入到框架中来，在执行时一并执行。所有这一规则下可以被框架收集到的方法就是hook方法。

pytest 加载插件的方式

• 内置plugins：从代码内部的_pytest目录加载
• 外部插件（第三方插件）：通过setuptools entry points机制发现的第三方插件模块
  推荐的第三方的pytest的插件：https://docs.pytest.org/en/latest/plugins.html
• conftest.py形式的本地插件：测试目录下的自动模块发现机制

查看当前pytest中所有的插件

pytest --trace-config命令可以查看当前pytest中所有的plugin。

编写自己的插件

官网文档

http://doc.pytest.org/en/latest/_modules/_pytest/hookspec.html

命令行添加自定义参数

parser.addoption()
参数说明:

• name：自定义命令行参数的名字，可以是：“foo”， “-foo” 或 “–foo”
• action：在命令行中遇到此参数时要采取的基本操作类型
• nargs：应该使用的命令行参数的数量
• const：某些操作和nargs选择所需的常量值
• default：如果参数不在命令行中，则生成的默认值。
• type：命令行参数应该转换为的类型
• choices：参数允许值的容器
• required：命令行选项是否可以省略（仅可选）
• help：对参数作用的简要说明
• metavar：用法消息中参数的名称
• dest：要添加到 parse_args() 返回的对象中的属性的名称

使用场景

• 使用 UI 自动化时，可以指定手机设备，或者不同的浏览器
• 接口自动化时，可以指定正式环境，测试环境分别读取不同的配置文件数据

示例

# conftest.py 文件---项目根目录
# 注册一个命令行参数--cmdopt
def pytest_addoption(parser):
    parser.addoption(
        "--cmdopt",
        action="store",
        default="devices_info",
        help="What is needed to start the session udid and port,type is dict"
    )

# 创建一个 fixture 获取命令行参数--cmdopt 的值
@pytest.fixture()  # session 作用域的话,每次执行用例不会重启 app
def cmdopt(request):
    return request.config.getoption("--cmdopt")

用例中查看自定义参数

# test_simple.py 文件
class TestDemo(object):

    def test_004(self, cmdopt):
        print("获取到的设备名称:{}".format(cmdopt))
        assert 4 == 4

    def test_005(self, cmdopt):
        print("获取到的设备名称:{}".format(cmdopt))
        assert 4 == 5


pytest.main(['test_simple.py::TestDemo',
             '-vs', '--cmdopt=iphone'])

获取每个用例详细的执行结果

pytest_runtest_markreport()
可以获取到测试用例的详细执行结果，setup 是否执行成功，call 测试用例是否执行成功，teardown 是否执行成功

# conftest.py 文件
@pytest.hookimpl(hookwrapper=True, tryfirst=True)
def pytest_runtest_makereport(item, call):
    print('*'*50)
    # 获取钩子方法的调用结果
    out = yield
    print('用例执行结果', out)
    # 从钩子方法的调用结果中获取测试报告
    report = out.get_result()
    print('测试报告：{}'.format(report))
    print('步骤：{}'.format(report.when))
    print('nodeid：{}'.format(report.nodeid))
    print('description:{}'.format(str(item.function.__doc__)))
    print(('运行结果: {}'.format(report.outcome)))
    print('*'*50)
    
# 与上面一样，只是通过 when 进行了阶段的区分    
@pytest.hookimpl(hookwrapper=True, tryfirst=True)
def pytest_runtest_makereport(item, call):
    print('*' * 50)
    # 获取钩子方法的调用结果
    out = yield
    print('用例执行结果', out)
    # 从钩子方法的调用结果中获取测试报告
    report = out.get_result()
    # 通过 when 来区分 setup,call,teardown 这三个阶段
    if report.when == "call":
        print('测试报告：{}'.format(report))
        print('步骤：{}'.format(report.when))
        print('nodeid：{}'.format(report.nodeid))
        print('description:{}'.format(str(item.function.__doc__)))
        print(('运行结果: {}'.format(report.outcome)))
        print('*' * 50)

# test_simple.py 文件
class TestDemo(object):

    def test_004(self, cmdopt):
        assert 4 == 4

    def test_005(self, cmdopt):
        assert 4 == 5


pytest.main(['test_simple.py::TestDemo',
             '-v'])

改变用例执行顺序

pytest_collection_modifyitems(session, items)
可以通过此 hook 函数改变收集到用例的执行顺序

# conftest.py 文件
def pytest_collection_modifyitems(session, items):
    print("收集到的测试用例:%s" % items)
    random.shuffle(items) # 将收集到的用例进行随机
    print("随机排序后的用例：%s" % items)

# test_simple.py 文件
class TestDemo(object):
    def test_004(self):
        assert 4 == 4

    def test_b_002(self):
        assert 1 == 1

    def test_a_002(self):
        assert 1 == 1

    def test_005(self):
        assert 4 == 5

    def test_b_001(self):
        assert 1 == 1

    def test_a_001(self):
        assert 1 == 1


pytest.main(['test_simple.py::TestDemo',
             '-v'])

统计测试结果

pytest_terminal_summary(terminalreporter, exitstatus, config)
通过此 hook 函数可以获取到用例执行的结果，通过数，失败数，跳过数，总数，执行时间等

# conftest.py
# 收集测试结果
def pytest_terminal_summary(terminalreporter, exitstatus, config):
    print("收集测试结果开始:")
    print("*"*30)
    print(terminalreporter.stats)
    print("total:", terminalreporter._numcollected)
    print('passed:', len(terminalreporter.stats.get('passed', [])))
    print('failed:', len(terminalreporter.stats.get('failed', [])))
    print('error:', len(terminalreporter.stats.get('error', [])))
    print('skipped:', len(terminalreporter.stats.get('skipped', [])))
    # terminalreporter._sessionstarttime 会话开始时间
    duration = time.time() - terminalreporter._sessionstarttime
    print('total times:', duration, 's')
    print("收集测试结果结束:")
    print("*" * 30)

# test_simple.py 文件
class TestDemo(object):
    def test_004(self):
        assert 4 == 4

    def test_b_002(self):
        assert 1 == 1

    def test_a_002(self):
        assert 1 == 1

    def test_005(self):
        assert 4 == 5

    def test_b_001(self):
        assert 1 == 1

    def test_a_001(self):
        assert 1 == 1


pytest.main(['test_simple.py::TestDemo',
             '-v'])