pytest插件探索——hook workflow

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:\Dev\debug_pytest
args=['tests\test_setup.py', '--debug']

pytest_cmdline_main [hook]
​ config: <_pytest.config.Config object at 0x000002119BA91080>
pytest_plugin_registered [hook]
​ plugin: <Session debug_pytest>
​ 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/1owWIaItldwDL2jZq7wb9_w 提取码: 69ks

另附pytest的个人总结xmind图:

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

结合导图再梳理一下(建议配合网盘里的xmind图看),大体整个测试分成如下6个阶段:

  1. pytest_configure

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

  2. pytest_sessionstart

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

  3. 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里面做的

  4. 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属性来区分不同阶段。

  5. pytest_sessionfinish

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

  6. pytest_unconfigure

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

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

推荐阅读更多精彩内容

  • 大年初一那天,我学会了包饺。那天我和妈妈一起包饺子让奶奶休息。妈妈和好了面,办好了馅儿,然后把面分成一个一个的小剂...
    43李昆城阅读 133评论 0 0
  • 曾经做过一个梦,关于千里之外的妈妈。 梦中,我在为妈妈做饭,炒了很多菜,刚准备把面条丢进锅里时,妈妈进来了,有点不...
    令狐豆阅读 370评论 2 5
  • 儿时的家族年 原创:魏周全 “独在异乡为异客,每逢佳节倍思亲”春节将至,思亲心切。幼时的年影历历在目,挥之不去,虽...
    魏周全阅读 551评论 3 9
  • 我们从来不怕忙碌, 怕只怕忙碌的没有目的。 我们从来没有目的, 没有目的才能摸索着前进。 我们从来都在前进, 前进...
    走歌人强子阅读 575评论 0 9
  • 手指轻轻地在键盘上敲打着,每一字每一句都在慢慢地突显,回忆起这一段日子,好颓废、好迷茫,特别是高考成绩出来了之...
    lsusan阅读 207评论 1 1