pytest插件探索——hook workflow

pubdreamcc 发布于2019-07-31 10:12 / 2448人阅读

摘要：会调用向打印一些环境信息，比如插件版本，版本，操作平台这些等。在执行之后调用执行的过程是否执行取决于是否需要创建执行的过程如果有。所有测试执行完毕之后，返回之前的阶段。结束以后，整个退出之前的阶段。

pytest插件开发需要熟悉一些常用的hook函数，官方对于这些hook有一份简略的文档（目前除了小部分hook目前缺乏文档外，见这个issue），但是各个hook的调用逻辑没有一个直观的flowchart（这个也有人提了issue）

根据pytest core developer-Bruno Oliveira的提示，通过使用向pytest传递--debug选项然后运行测试，我们就可以在当前目录得到一个类似如下内容的pytestdebug.log：

versions pytest-4.3.0, py-1.8.0, python-3.6.4.final.0
cwd=E:Devdebug_pytest
args=["tests	est_setup.py", "--debug"]pytest_cmdline_main [hook]
    config: <_pytest.config.Config object at 0x000002119BA91080>
 pytest_plugin_registered [hook]
      plugin: 
      manager: <_pytest.config.PytestPluginManager object at 0x000002119B22BD30>
 finish pytest_plugin_registered --> [][hook]
 pytest_configure [hook]
      config: <_pytest.config.Config object at 0x000002119BA91080>
    pytest_plugin_registered [hook]
...

经过多次反复测试分析debug文件，整理出了一个xmind的思维导图：

链接: https://pan.baidu.com/s/1owWI... 提取码: 69ks

另附pytest的个人总结xmind图：

链接: https://pan.baidu.com/s/18l6J... 提取码: uwnd

结合导图再梳理一下（建议配合网盘里的xmind图看），大体整个测试分成如下6个阶段：

pytest_configure

插件和conftest.py文件配置初始化等，创建session。

pytest_sessionstart

创建session完以后，执行collection之前的阶段。会调用pytest_report_header向terminal打印一些环境信息，比如插件版本，python版本，操作平台这些等。

pytest_collection

测试用例收集以及生成测试输入的过程，这里还可能包括根据keywords和marker筛选测试用例的过程。这个过程会涉及多次generate item的调用，主要关注如下调用：

pytest_generate_tests(metafunc): 生成测试项；

pytest_make_parametrize_id(config, val, argname)：根据@pytest.mark.parametrize生成对应值；

pytest_collection_modifyitems(session, config, items)：所有测试项收集完毕以后调用，一般用来进行重新排序和二次过滤。

pytest_deselected(items): 有测试项被关键字或者marker过滤掉的时候会被调用

注意：通过::语法筛选测试用例的步骤是在之前生成测试用例阶段完成的，并不是在deselected里面做的

pytest_runtestloop

执行筛选过的测试用例，在pytest_runtest_protocol里面完成包括setup, call, teardown和log打印的过程。主要关注如下调用：

pytest_runtest_logstart(nodeid, location)：开始执行一个新测试项的时候调用.

注：官方文档的意思表述的有点模糊，并不是setup/call/teardown阶段分别调用一次，就是函数命令一直的意思测试开始前打印一次

pytest_runtest_logfinish(nodeid, location): 结束执行一个测试项的时候调用.
注：同上

pytest_runtest_setup(item)：在pytest_runtest_call执行之前调用.

pytest_runtest_call(item): 执行实际的测试过程。

pytest_runtest_teardow(item, nextitem): 在pytest_runtest_call执行之后调用

pytest_fixture_setup(fixturedef, request)：执行fixture的setup过程（是否执行取决于fixture是否需要创建）.

pytest_fixture_post_finalizer(fixturedef, request): 执行fixture的teardown过程（如果有）。

pytest_runtest_makereport(item, call): 返回给定item和call对应的 _pytest.runner.TestReport 对象, 这里的call object我们一般不太接触，_pytest/runner.py里面有具体的用法可以参考。

pytest_runtest_logreport(report): 在测试的setup/call/teardown阶段report更新之后分别被调用到，可以用when属性来区分不同阶段。

pytest_report_teststatus(report, config): 返回各个测试阶段的result, 可以用when属性来区分不同阶段。

pytest_sessionfinish

所有测试执行完毕之后，返回exit status之前的阶段。会调用pytest_terminal_summary向terminal打印一些summary信息，比如pass, fail, error数量之类的总结信息。

pytest_unconfigure

session结束以后，整个process退出之前的阶段。

海外云主机私有云 pytest workflow Workflows Hooking

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/43437.html

pytest插件探索——hook开发

摘要：所有的函数都使用的命名规则，以便于查找并且同其他函数区分开来。用来每个，保证被正确的定义。里还有一个选项，用来表示这个函数是个函数。自动注册插件除了常规的方法注册插件，同时提供了方法，允许通过自动注册插件。前言参考官方的这篇文章，我尝试翻译其中一些重点部分，并且拓展了相关的pluggy部分的知识。由于pytest是在pluggy基础上构建的，强烈建议先阅读一下pluggy的官方文档...

shiguibiao 2019-07-31 10:12 评论0 收藏0
2021-09-03-接口自动化-python+requests+pytest+csv+yaml+a

摘要：本套代码和逻辑是本人的劳动成果，如果有转载需要标注，非常适合公司做项目的同学小白也可以学哦接口自动化项目目录公共方法的封装如果不用配置文件可以使用这个方法进行封装但是有一定的缺陷可以不使用字典。这是在正常的命令行解析之前发生的。 ...

李昌杰 2021-09-04 16:45 评论0 收藏0
带你深入理解自动化测试框架Pytest的配置文件!

摘要：其中用到编程等，还需要花更多的精力去深入学习，当每项技能都能掌握到一定深度，才能称为一个完整的知识体系。都有哪些种类的配置文件 pytest.ini：pytes...

wayneli 2021-09-04 16:40 评论0 收藏0
Pytest+Allure使用问题记录

摘要：问题大部分问题是因为安装了导致的比如此时需要先卸载然后再安装包已经安装过的不用重复安装。版本问题类似于这种一般是因为版本太高导致建议卸载现有版本并安装较低版本的。后续重装低版本出现如下报错重装最新版本并重装包 ...

番茄西红柿 2021-11-26 11:11 评论0 收藏2637
这样来轻松自定义 Jenkins 发行版！

摘要：在内运行集成测试很长时间以来都是一个难题。为了复用已有的框架，我们需要打包一个自带配置的文件，以便可以在现有的框架中运行集成测试。今天，我打算给 Jenkins 管理员和开发者们介绍一个新的工具 Custom WAR Packager。该工具可以打包 Jenkins 的自定义 WAR 发行版、 Docker 镜像以及 Jenkinsfile Runner 包。它可以打包 Jenkin...

RichardXG 2019-06-28 16:54 评论0 收藏0