首页 > 其他分享 >Pytest 框架执行用例流程浅谈

Pytest 框架执行用例流程浅谈

时间:2023-08-29 22:23:23浏览次数:48  
标签:调用 浅谈 hook self pytest 用例 Pytest 测试用例

背景:

  根据以下简单的代码示例,我们将从源码的角度分析其中的关键加载执行步骤,对pytest整体流程架构有个初步学习。

代码示例:

import pytest

def test_add():

assert 1 + 1 == 2

def test_sub():

assert 2 - 1 == 1

  通过 pytest test_example.py 运行此代码示例后,会触发pytest的入口函数main(),这个函数定义在src/pytest/__main__.py中,它的作用是创建一个PytestConfig对象,并调用其

do_configure()和do_main()方法。PytestConfig对象是pytest的核心配置类,它负责解析命令行参数、读取配置文件、注册插件、创建Session对象等。PytestConfig对象定义在

src/_pytest/config/__init__.py中,它继承了pluggy.HookimplMarker类,也就是说它可以作为一个插件管理器,调用各种hook函数。

```python
# src/pytest/__main__.py

def main():
    # 创建PytestConfig对象
    config = PytestConfig()
    # 调用config.do_configure()方法
    config.do_configure()
    # 调用config.do_main()方法
    config.do_main()
```

```python
# src/_pytest/config/__init__.py

class PytestConfig(pluggy.HookimplMarker):
    def __init__(self):
        # 解析命令行参数
        self.parse_args()
        # 读取配置文件
        self.read_config_files()
        # 注册插件
        self.register_plugins()
        # 创建Session对象
        self.session = Session(self)
    
    def do_configure(self):
        # 调用hook函数pytest_configure
        self.hook.pytest_configure(config=self)
    
    def do_main(self):
        # 调用hook函数pytest_sessionstart
        self.hook.pytest_sessionstart(session=self.session)
        # 调用Session对象的main()方法
        self.session.main()
```
 

  Session对象是pytest的核心上下文类,它负责管理整个测试过程的信息,包括收集测试用例、执行测试用例、生成测试报告等。Session对象定义在src/_pytest/main.py中,它继承了

Collector类,也就是说它可以作为一个测试用例收集器。Session对象的main()方法是执行测试用例的主要入口,它会调用perform_collect()方法来收集测试用例,并返回一个列表items;然后

调用runtestloop()方法来循环执行items中的每个Item对象;最后调用hook函数pytest_sessionfinish来结束测试会话,并返回一个退出码exitstatus。

```python
# src/_pytest/main.py

class Session(Collector):
    def __init__(self, config):
        # 初始化一些属性和状态信息
    
    def main(self):
        # 调用perform_collect()方法收集测试用例,并返回items列表
        items = self.perform_collect()
        # 调用runtestloop()方法循环执行items中的每个Item对象,并返回退出码exitstatus
        exitstatus = self.runtestloop(items)
        # 调用hook函数pytest_sessionfinish来结束测试会话,并返回退出码exitstatus
        self.hook.pytest_sessionfinish(session=self, exitstatus=exitstatus)
        return exitstatus
    
    def perform_collect(self):
        # 调用hook函数pytest_collectstart表示开始收集测试用例
        self.hook.pytest_collectstart(collector=self)
        # 调用自身的collect()方法来递归遍历指定的测试文件或目录,并返回一个列表items
        items = self.collect()
        # 调用hook函数pytest_collectreport表示收集测试用例结束,并生成收集报告
        self.hook.pytest_collectreport(report=CollectReport(self, "passed", items))
        # 调用hook函数pytest_collection_modifyitems允许对收集到的Item对象进行修改
        self.hook.pytest_collection_modifyitems(session=self, config=self.config, items=items)
        # 调用hook函数pytest_deselected表示从收集到的Item对象中筛选出需要执行的Item对象
        self.hook.pytest_deselected(items=self.deselected)
        # 调用hook函数pytest_collection_finish表示收集和筛选测试用例完成,并返回最终要执行的Item对象列表
        self.hook.pytest_collection_finish(session=self)
        return items
    
    def runtestloop(self, items):
        # 调用hook函数pytest_runtestloop表示开始循环执行测试用例
        self.hook.pytest_runtestloop(session=self)
        # 遍历items列表,依次取出每个Item对象
        for item in items:
            # 调用Item对象的runtestprotocol()方法来执行单个测试用例的协议
            item.runtestprotocol()
        # 返回退出码0表示成功
        return 0
```

  

  Item对象是pytest的核心测试类,它负责封装和执行单个测试用例的信息,包括名称、位置、参数化信息、标记信息等。Item对象定义在src/_pytest/python.py中,它继承了Node类,也

就是说它可以作为一个测试节点。Item对象的runtestprotocol()方法是执行单个测试用例的主要入口,它会调用hook函数pytest_runtest_logstart来开始记录日志信息;然后调用runtest()方法

来执行测试用例的前置、主体和后置部分;最后调用hook函数pytest_runtest_logfinish来结束记录日志信息,并生成日志报告。

 

```python
# src/_pytest/python.py

class Item(Node):
    def __init__(self, name, parent, config, session):
        # 初始化一些属性和状态信息
    
    def runtestprotocol(self):
        # 调用hook函数pytest_runtest_logstart表示开始记录日志信息
        self.ihook.pytest_runtest_logstart(nodeid=self.nodeid, location=self.location)
        # 调用runtest()方法来执行测试用例的前置、主体和后置部分,并返回一个列表reports
        reports = self.runtest()
        # 调用hook函数pytest_runtest_logfinish表示结束记录日志信息,并生成日志报告
        self.ihook.pytest_runtest_logfinish(nodeid=self.nodeid, location=self.location)
        return reports
    
    def runtest(self):
        # 创建一个空列表reports
        reports = []
        # 调用_setup()方法来执行测试用例的前置操作,并将返回的报告添加到reports列表中
        reports.append(self._setup())
        # 如果前置操作没有失败或跳过,则调用_call()方法来执行测试用例的主体部分,并将返回的报告添加到reports列表中
        if reports[-1].passed:
            reports.append(self._call())
        # 调用_teardown()方法来执行测试用例的后置操作,并将返回的报告添加到reports列表中
        reports.append(self._teardown())
        # 返回reports列表
        return reports
    
    def _setup(self):
        # 调用hook函数pytest_runtest_setup表示开始执行前置操作,并返回一个报告setup_report
        setup_report = self.ihook.pytest_runtest_setup(item=self)
        return setup_report
    
    def _call(self):
        # 调用hook函数pytest_runtest_call表示开始执行主体部分,并返回一个报告call_report
        call_report = self.ihook.pytest_runtest_call(item=self)
        return call_report
    
    def _teardown(self):
        # 调用hook函数pytest_runtest_teardown表示开始执行后置操作,并返回一个报告teardown_report
        teardown_report = self.ihook.pytest_runtest_teardown(item=self)
        return teardown_report
```

 

总结:

Pytest的加载流程大致如下:

- Pytest首先会解析命令行参数,确定要执行的测试文件、测试目录、测试类、测试函数等,以及一些配置选项。
- Pytest会根据配置文件(pytest.ini、setup.cfg、tox.ini等)和命令行参数,创建一个Config对象,用于存储配置信息。
- Pytest会创建一个Session对象,用于管理整个测试过程的上下文信息,包括收集测试用例、执行测试用例、生成测试报告等。
- Pytest会调用hook函数pytest_sessionstart,表示测试会话开始。
- Pytest会调用hook函数pytest_collectstart,表示开始收集测试用例。
- Pytest会根据Config对象中的信息,递归遍历指定的测试文件或目录,寻找符合pytest约定的测试用例(以test_开头的函数或方法,以Test开头的类等)。
- Pytest会将找到的测试用例封装成Item对象,并添加到Session对象的items列表中。Item对象包含了测试用例的名称、位置、参数化信息、标记信息等。
- Pytest会调用hook函数pytest_collectreport,表示收集测试用例结束,并生成收集报告。
- Pytest会调用hook函数pytest_collection_modifyitems,允许对收集到的Item对象进行修改,例如重新排序、添加或删除标记等。
- Pytest会调用hook函数pytest_deselected,表示从收集到的Item对象中筛选出需要执行的Item对象,并将不需要执行的Item对象放入Session对象的deselected列表中。
- Pytest会调用hook函数pytest_collection_finish,表示收集和筛选测试用例完成,并返回最终要执行的Item对象列表。
- Pytest会根据是否使用多进程或多线程模式,创建相应的WorkerController对象,用于管理多个Worker对象。Worker对象负责执行具体的测试用例,并将结果返回给WorkerController对象。
- Pytest会调用hook函数pytest_runtestloop,表示开始循环执行测试用例。
- Pytest会遍历Session对象中的items列表,依次取出每个Item对象,并调用hook函数pytest_runtest_protocol,表示开始执行单个测试用例的协议。
- Pytest会调用hook函数pytest_runtest_logstart,表示开始记录单个测试用例的日志信息。
- Pytest会调用hook函数pytest_runtest_setup,表示开始执行单个测试用例的前置操作(例如setup函数或方法)。
- Pytest会调用hook函数pytest_runtest_call,表示开始执行单个测试用例的主体部分(例如测试函数或方法)。
- Pytest会调用hook函数pytest_runtest_teardown,表示开始执行单个测试用例的后置操作(例如teardown函数或方法)。
- Pytest会调用hook函数pytest_runtest_logfinish,表示结束记录单个测试用例的日志信息,并生成日志报告。
- Pytest会调用hook函数pytest_runtest_makereport,表示根据单个测试用例的执行结果,生成测试报告(包括setup、call和teardown三个阶段的报告)。
- Pytest会重复上述步骤,直到所有的Item对象都被执行完毕。
- Pytest会调用hook函数pytest_sessionfinish,表示测试会话结束,并生成最终的测试报告(包括所有Item对象的报告)。
- Pytest会调用hook函数pytest_terminal_summary,表示在终端输出最终的测试结果和统计信息。

标签:调用,浅谈,hook,self,pytest,用例,Pytest,测试用例
From: https://www.cnblogs.com/beyond-tester/p/17665993.html

相关文章

  • pytest + yaml 框架 -54. variables 可以引用同一层级变量
    前言v1.4.5新增功能。同一层级variables变量中,可以引用前面的变量了config中variables可以引用同一层级变量用例中variables可以引用同一层级变量引用同一层级变量最近有部分学员遇到的问题,在同一个层级设置变量,后面的变量引用前面的变量(v1.4.4之前的版本不支持)con......
  • 浅谈高斯消元法
    2023.6.16:发布2023.8.29:修缮,加上自己觉得通俗易懂的理解,更新矩阵求逆。高斯消元高斯消元可以用于线性方程组求解或者行列式计算,求矩阵的逆等等,也算是比较基础的一个思想。消元法定义消元法是将方程组中的一方程的未知数用含有另一未知数的代数式表示,并将其带入到另一方程中,......
  • 浅谈图像格式 .bmp
     云无月.NET/Unity3D/Python  位图(Bitmap)格式其实并不能说是一种很常见的格式(从我们日常的使用频率上来讲,远不如.jpg.png.gif等),因为其数据没有经过压缩,或最多只采用行程长度编码(RLE,run-lengthencoding)来进行轻度的无损数据压缩。以至于,LaTeX......
  • python+playwright 学习-80 v1.37版本新增--full-page-screenshot 用例失败截长图
    前言--full-page-screenshot参数是pytest-playwright在使用,在失败时是否进行完整页面截图。默认情况下,仅捕获视口。需开启--screenshot开关(默认:off).用例失败截图环境准备:1.安装playwright最新v1.37版本2.安装pytest-playwright0.4.2版本用例示例fromplaywright.......
  • python+selenium+pytest-(5)_yaml文件
    导包importyamlelement.yamllogin:safe:'#element'link:'#element'user:['#element','user1','user2','user3']password:['#element','pw']auth_code:'element......
  • 浅谈5G技术会给视频监控行业带来的一些变革情况
    5G是第五代移动通信技术,能够提供更高的带宽和更快的传输速度,这将为视频技术的发展带来大量机会。随着5G技术的逐步普及与商用,人们将能够享受到更加流畅的高清视频体验,并且5G技术还拥有更低的延迟和更高的网络容量。这些优势不仅将推动视频技术的变革,也将创造出更多的商业机会和产......
  • Pytest+Jenkins 学习笔记
    Pytest+Jenkins学习笔记在软件测试工作中,单元测试通常是由开发人员执行的、针对最小单元粒度的组件测试,在完成了单元粒度的测试任务之后,通常就需要交由专职的测试人员将这些单元级的组件放到粒度更大的功能组件或子系统中来进行整合性的测试了。在专业术语中,粒度介于单元测试与......
  • 浅谈缺一分治
    这个思想好像并不常见,我也是一个月前在lxr讲dp的课上第一次听说这个名字,后来ACM比赛中出了一个gym题,也可以运用相同的思想,但是脑子短路没搞出来,现在随便记一记。缺一分治,顾名思义,就是在题目中有一个位置的限制和其它位置不一样,我们利用分治的思想,枚举每一个位置,然后把\(......
  • 禁用测试用例
    给用例添加禁用标识,被禁用的用例执行后会添加跳过的状态,可以禁用测试类、也可以禁用测试方法注意:IDEA不支持,maven构建才支持importorg.junit.jupiter.api.Disabled;importorg.junit.jupiter.api.Tag;importorg.junit.jupiter.api.Test;//在类名添加Disabled注解@Disa......
  • 标记用例tag
    通过Tag对用例分组:环境分组:测试环境、预发布环境阶段分组:冒烟用例版本分组:V1.1、V1.2设置标签根据标签执行结合Maven执行结合测试套件执行importorg.junit.jupiter.api.Tag;importorg.junit.jupiter.api.Test;publicclassTagExampleTest{@T......