深入解析 Pytest 中的 conftest.py:测试配置与复用的利器

ops/2024/12/15 13:12:36/

在 Pytest 测试框架中,conftest.py 是一个特殊的文件,用于定义测试会话的共享配置和通用功能。它是 Pytest 的核心功能之一,可以用于以下目的:

【主要功能】
1、定义共享的 Fixture
(1)conftest.py 文件可以存放常用的测试前置(fixture)代码,供同目录下或子目录中的测试用例直接使用,而无需显式导入。

参考前面的文章:全面解析 pytest fixture:使用方法、实战技巧与最佳实践-CSDN博客
(2)fixture 是 pytest 用来管理测试用例依赖的核心机制,可以用于设置测试前后需要的做的内容(通过yield实现),例如,启动appium server、启动app等。

 参考前面的文章:全面解析 pytest fixture:使用方法、实战技巧与最佳实践-CSDN博客
2、自定义钩子函数(Hooks)
(1)Pytest 提供了一系列的钩子(Hooks)函数,用于扩展测试框架行为。例如:
    a. 在测试会话开始或结束时执行特定代码,下面是iOS UI自动化每条用例执行结束后,如果failed会截一张图,并附加到allure报告中,并且把当次执行的结果passed、failed、skipped输出到日志中:

python">@pytest.hookimpl(tryfirst=True, hookwrapper=True)
def pytest_runtest_makereport(item, call):outcome = yieldrep = outcome.get_result()if rep.when == 'call':if rep.failed:logger.error(f"Test {item.nodeid}: FAILED\n")driver = item.funcargs['ios_driver']screenshot_path = take_screenshot(driver)with open(screenshot_path, 'rb') as image_file:allure.attach(image_file.read(), name='测试未通过截图', attachment_type=allure.attachment_type.PNG)if call.excinfo:error_message = str(call.excinfo.value)logger.error(f"Test {item.nodeid} failed with error: {error_message}\n")elif rep.skipped:outcome_status = 'SKIPPED'logger.info(f"Test {item.nodeid}: {outcome_status}\n")else:outcome_status = 'PASSED'logger.info(f"Test {item.nodeid}: {outcome_status}\n")

    b. 修改收集测试用例的行为。
(2)这些钩子函数通常也会放在 conftest.py 中。
3、参数化和共享配置
  可以在 conftest.py 中为多个测试用例设置公共的参数化数据或共享变量或者通过conftest.py 集中管理其他fixture,例如,在本次的iOS UI自动化项目中,把用到的设备数据单独放在了test_data_fixture.py中,数据格式如下,在conftest.py中引用test_data_fixture.py,通过 conftest.py 来集中管理所有 fixture,避免了在每个测试文件中都需要导入多个 fixture 文件:

python"># conftest.pyfrom test_data_fixture import *
python"># test_data_fixture.py# 设备数据
@pytest.fixture(scope="module")
def device_data(request):from network_request import get_dev_name_over_requestdev_model = request.paramdev_name = get_dev_name_over_request(dev_model)if dev_model == 'CCC':result = clear_sandbox_log('iPhoneX')return {'iphone_model': 'iPhoneX','sn': 'CCC2DA110012345','dev_model': 'CCC','dev_name': dev_name,'sleep_time': 25}elif dev_model == 'LLL':result = clear_sandbox_log('iPhoneX')return {'iphone_model': 'iPhoneX','sn': 'CCC2DA110012345','dev_model': 'CCC','dev_name': dev_name,'sleep_time': 35}else:raise ValueError("Unknown device model: {}".format(dev_model))

4、灵活的作用域控制
  通过设置 fixture 的作用域(function、class、module 或 session),可以让它们在不同层次的测试中共享,减少冗余。

 参考前面的文章:全面解析 pytest fixture:使用方法、实战技巧与最佳实践-CSDN博客
5、层级作用域
  每个目录都可以有自己的 conftest.py,这些文件会在测试运行时自动被发现,且只会作用于其所在目录及子目录中的测试用例。

【conftest.py 的加载规则】
1、不需要显式导入,pytest 会自动发现 conftest.py 文件。
2、每个目录下的 conftest.py 仅影响该目录及其子目录的测试用例。
3、同名的 fixture 或配置会覆盖上层目录的内容。

示例 1:共享 Fixture
目录结构

python">project/
│
├── conftest.py
├── tests/
│   ├── test_login.py
│   ├── test_dashboard.py
python"># conftest.pyimport pytest# 定义一个共享的 Fixture
@pytest.fixture(scope="session")
def setup_environment():print("\nSetting up the environment")yieldprint("\nTearing down the environment")
python"># test_login.pydef test_login(setup_environment):# 测试用例会自动调用 `setup_environment` Fixtureprint("\nRunning login test")assert 1 == 1

python"># test_hahahah.pydef test_hahahah(setup_environment):# 测试用例会自动调用 `setup_environment` Fixtureprint("\nRunning hahahah test")assert 2 == 2
python">$ pytest -s
Setting up the environment
Running login test
.
Running hahahah test
.
Tearing down the environment

【注意事项】
1、避免在 conftest.py 中包含业务逻辑
      conftest.py 应该仅用于配置和工具代码,不建议放置实际的测试逻辑。
2、fixture 名称避免冲突
     如果在多个 conftest.py 文件中定义了同名的 fixture,pytest 会根据目录层级覆盖上层目录的定义。
3、调试时避免命名冲突
      如果测试用例或模块中定义了与 conftest.py 中同名的 fixture,pytest 优先使用本地的 fixture。

【总结】
conftest.py 是 Pytest 中一个用于集中管理共享配置的工具,可以极大地提高测试代码的可维护性和复用性。对于复杂的测试框架来说,合理使用 conftest.py 是非常关键的一部分。


http://www.ppmy.cn/ops/142110.html

相关文章

实战设计模式之单例模式

概述 在进行大型项目的系统架构设计时,确保某些类只有一个实例,是非常重要的。比如:日志记录器、数据库连接池、配置管理器等组件,通常只需要一个实例来处理所有请求。在这种情况下,如果每次使用都创建新的对象实例&am…

21天掌握JavaWeb-》第16天 - 后端开发与API设计

引言 在今天的课程中,我们将使用Spring Boot结合MyBatis来开发后端逻辑,并设计RESTful API。我们将根据之前设计的用户(User)、商品(Product)、购物车(Cart)和订单(Orde…

微服务中间件~nacos安全配置(含参考案例)

Nacos 是阿里巴巴开源的一个动态服务发现、配置管理和服务管理平台。为了确保 Nacos 的安全性,可以从以下几个方面入手: 1、启用身份验证: 在 application.properties 文件中启用身份验证功能:properties nacos.core.auth.enable…

MySQL运算符知识点

算术运算符 算术运算符主要用于数学运算,其可以连接运算符前后的两个数值或表达式,对数值或表达式进行加()、减(-)、乘(*)、除(/)和取模(%)运算…

ElasticSearch03-基本操作

零、文章目录 ElasticSearch03-基本操作 1、RestFul API 风格 ElasticSearch 的接口风格是 RESTful API。RESTful 是一种软件架构风格,它使用 HTTP 协议来实现客户端和服务器之间的通信。ElasticSearch 的 RESTful API 提供了一种简单且标准化的方式来与 Elastic…

大屏开源项目go-view二次开发2----半环形控件(C#)

环境搭建参考: 大屏开源项目go-view二次开发1----环境搭建(C#)-CSDN博客 要做的半环形控件最终效果如下图: 步骤如下: 1 在go-view前端项目的\src\packages\components\Charts目录下新增Others目录,并在Others目录下新增PieExt…

孚盟云 MailAjax.ashx SQL注入漏洞复现

0x01 产品简介 上海孚盟软件有限公司是一家外贸SaaS服务提供商,也是专业的外贸行业解决方案专业提供商。 全新的孚盟云产品,让用户可以用云模式实现信息化管理,让用户的异地办公更加流畅,大大降低中小企业在信息化上成本,用最小的投入享受大型企业级别的信息化服务,主要…

特工找密码(蓝桥杯)

本来这题想用枚举暴力解的,但是运行总是超时,数值范围太大了~,所以该题不能用枚举进行暴力。 转换成二进制,我们判断一下其规律 注意:按位与是都为1时其值才为1,所以当x和y按位与的结果为2时,其…