pytest教程-13-conftest.py文件

2024-03-02 17:12
文章标签 教程 py 13 pytest conftest

本文主要是介绍pytest教程-13-conftest.py文件,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

上一小节我们学习了fixture的作用域,本小节我们学习一下pytest conftest.py文件的使用方法。

conftest.py文件的作用

conftest.py文件是pytest框架中的一个特殊文件,用于定义共享的设置、夹具(fixture)和钩子函数(hook)。

在pytest中,conftest.py文件可以用于在整个测试项目中共享夹具、配置和钩子函数。通过在conftest.py文件中定义夹具,你可以提供测试所需的初始化数据和对象,并使其在测试文件中可用。这样可以避免在每个测试文件中重复定义夹具,提高代码的复用性和可维护性。

此外,conftest.py文件也可以定义钩子函数,用于在测试执行的不同阶段插入自定义的行为。通过定义钩子函数,你可以在测试开始前、测试结束后或其他特定的测试事件发生时执行特定的代码逻辑。这样可以扩展和定制pytest的行为,实现特定的测试需求和额外的操作。

当pytest运行时,它会自动搜索项目中的conftest.py文件,并根据其中的定义来加载夹具和钩子函数。conftest.py文件可以位于项目的根目录下,也可以位于子目录中,它们会在对应的作用域内生效。

conftest.py文件的特点

  • conftest.py文件名是固定的,不能修改
  • contest.py文件不需要导入,pytest运行的时候会自动识别该文件
  • conftest.py文件不能被其他文件导入
  • 所有同目录测试文件运行前都会执行conftest.py文件
  • conftest.py与运行的用例要在同一个pakage下,并且有__init__.py文件
  • conftest.py作用于文件同级目录和子目录下的所有测试用例,当有多个conftest.py文件的时候,子目录的conftest.py文件优先级较高
  • 如果希望fixture(夹具)共享给所有测试,则可以把conftest.py文件放在测试框架的根目录下。
  • 定义夹具@pytest.fixture的作用域参数scope:session,module,class,function
  • 可以跨.py文件调用,有多个.py文件调用时,可让conftest.py只调用了一次fixture,或调用多次fixture

conftest.py的使用

夹具(fixture)示例

conftest.py

import pytest@pytest.fixture()
def conftest_fixture():print("fixture前置")yieldprint("fixture后置")

test_demo.py

def test_case(conftest_fixture):print("测试用例")

运行结果

============================= test session starts =============================
collecting ... collected 1 itemtest_demo.py::test_case fixture前置
PASSED                                           [100%]测试用例
fixture后置============================== 1 passed in 0.02s ==============================

钩子函数(hook)示例

比如在pytest教程-9-pytest-html生成html报告这一小节中,使用钩子函数来定制html报告就是一个比较好的例子。

conftest.py

# conftest.py
import pytest
from py._xmlgen import html
from datetime import datetime# 1、修改报告标题
def pytest_html_report_title(report):report.title = "我的测试报告标题"# 2、运行测试前修改环境信息
@pytest.hookimpl(optionalhook=True)
def pytest_metadata(metadata: dict):metadata['项目名称'] = '我的项目'metadata['接口地址'] = "https://www.example.com"# 3、修改摘要信息
def pytest_html_results_summary(prefix, summary, postfix):prefix.extend([html.p("所属部门: 测试保障部")])prefix.extend([html.p("测试人员: 张三")])# 4、测试结果表格
@pytest.mark.optionalhook
def pytest_html_results_table_header(cells):cells.insert(1, html.th("Description"))  # 表头添加Descriptioncells.insert(2, html.th("Time", class_="sortable time", col="time"))cells.pop(-1)  # 删除link@pytest.mark.optionalhook
def pytest_html_results_table_row(report, cells):cells.insert(1, html.td(report.description))  # 表头对应的内容cells.insert(2, html.td(datetime.now(), class_="col-time"))cells.pop(-1)  # 删除link@pytest.mark.hookwrapper
def pytest_runtest_makereport(item, call):  # Description取值为用例说明__doc__outcome = yieldreport = outcome.get_result()report.description = str(item.function.__doc__)report.nodeid = report.nodeid.encode("utf-8").decode("unicode_escape")

test_demo.py

import pytestdef fun(x):return x + 1def test_answer_1():"""测试断言一"""assert fun(3) == 4def test_answer_2():"""测试断言二"""assert fun(5) == 7@pytest.mark.parametrize("test_input,expected", [("3+5", 8),("2+4", 6),pytest.param("6 * 9", 42, marks=pytest.mark.xfail),pytest.param("6 * 6", 42, marks=pytest.mark.skip)
])
def test_mark(test_input, expected):"""用例集合"""assert eval(test_input) == expected

修改完成,重新执行脚本,查看最终效果。

conftest.py文件作用域

  • 比如在测试框架的根目录创建conftest.py文件,文件中的Fixture的作用范围是所有测试模块。
  • 比如在某个单独的测试文件夹里创建conftest.py文件,文件中Fixture的作用范围,就仅局限于该测试文件夹里的测试模块。
  • 该测试文件夹外的测试模块,或者该测试文件夹外的测试文件夹,是无法调用到这个conftest.py文件中的Fixture。
  • 如果测试框架的根目录和子包中都有conftest.py文件,并且这两个conftest.py文件中都有一个同名的Fixture,实际生效的是测试框架中子包目录下的conftest.py文件中配置的Fixture。

conftest层级关系

在pytest_demo项目工程下建两个子项目baidu、blog,并且每个目录下都放一个conftest.py和init.py(python的每个package必须要有init.py)

pytest_demo是工程名称├─baidu
│  │  conftest.py
│  │  test_1_baidu.py
│  │  __init__.py
│  
│          
├─blog
│  │  conftest.py
│  │  test_2_blog.py
│  │  __init__.py
│   
│  conftest.py
│  __init__.py


案例分析

pytest_demo工程下conftest.py文件代码案例

# pytest_demo/conftest.py
import pytest@pytest.fixture(scope="session")
def start():print("\n打开首页")

baidu目录下conftest.py和test_1_baidu.py


运行test_1_baidu.py结果可以看出,start和open_baidu是session级别的,只运行一次

============================= test session starts =============================
collecting ... collected 2 itemstest_1_baidu.py::test_01 
打开首页
打开百度页面_session
PASSED                                          [ 50%]测试用例test_01test_1_baidu.py::test_02 PASSED                                          [100%]测试用例test_02============================== 2 passed in 0.02s ==============================

blog目录下conftest.py和test_2_blog.py代码

# pytest_demo/blog/conftest.py
import pytest@pytest.fixture(scope="function")
def open_blog():print("打开blog页面_function")# web_conf_py/blog/test_2_blog.pyimport pytestdef test_03(start, open_blog):print("测试用例test_03")assert 1def test_04(start, open_blog):print("测试用例test_04")assert 1def test_05(start, open_baidu):'''跨模块调用baidu模块下的conftest'''print("测试用例test_05,跨模块调用baidu")assert 1if __name__ == "__main__":pytest.main(["-s", "test_2_blog.py"])

运行结果可以看出,start起到全局作用,blog目录下的open_blog是function级别,每个用例调用一次。
test_05(start, open_baidu)用例不能跨模块调用baidu模块下的open_baidu,所以test_05用例会运行失败

============================= test session starts =============================
collecting ... collected 3 itemstest_2_blog.py::test_03 
打开首页
打开blog页面_function
PASSED                                           [ 33%]测试用例test_03test_2_blog.py::test_04 打开blog页面_function
PASSED                                           [ 66%]测试用例test_04test_2_blog.py::test_05 ERROR                                            [100%]
test setup failed
file D:\PycharmProjects\Source_Code\pytest_demo\blog\test_2_blog.py, line 14def test_05(start, open_baidu):
E       fixture 'open_baidu' not found
>       available fixtures: cache, capfd, capfdbinary, caplog, capsys, capsysbinary, doctest_namespace, extra, extras, include_metadata_in_junit_xml, metadata, monkeypatch, open_blog, pytestconfig, record_property, record_testsuite_property, record_xml_attribute, recwarn, start, tmp_path, tmp_path_factory, tmpdir, tmpdir_factory
>       use 'pytest --fixtures [testpath]' for help on them.D:\PycharmProjects\Source_Code\pytest_demo\blog\test_2_blog.py:14========================= 2 passed, 1 error in 0.03s ==========================

最后感谢每一个认真阅读我文章的人,礼尚往来总是要有的,虽然不是什么很值钱的东西,如果你用得到的话可以直接拿走,希望可以帮助到大家!

这篇关于pytest教程-13-conftest.py文件的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/766857

相关文章

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门(一):登录与退出》 《Spring-Security-入门(二):基于数据库验证》 《Spring-Security-入门(三):密码加密》 《Spring-Security-入门(四):自定义-Filter》 《Spring-Security-入门(五):在 Sprin

python: 多模块(.py)中全局变量的导入

文章目录 global关键字可变类型和不可变类型数据的内存地址单模块(单个py文件)的全局变量示例总结 多模块(多个py文件)的全局变量from x import x导入全局变量示例 import x导入全局变量示例 总结 global关键字 global 的作用范围是模块(.py)级别: 当你在一个模块(文件)中使用 global 声明变量时,这个变量只在该模块的全局命名空

Java进阶13讲__第12讲_1/2

多线程、线程池 1.  线程概念 1.1  什么是线程 1.2  线程的好处 2.   创建线程的三种方式 注意事项 2.1  继承Thread类 2.1.1 认识  2.1.2  编码实现  package cn.hdc.oop10.Thread;import org.slf4j.Logger;import org.slf4j.LoggerFactory

Makefile简明使用教程

文章目录 规则makefile文件的基本语法:加在命令前的特殊符号:.PHONY伪目标: Makefilev1 直观写法v2 加上中间过程v3 伪目标v4 变量 make 选项-f-n-C Make 是一种流行的构建工具,常用于将源代码转换成可执行文件或者其他形式的输出文件(如库文件、文档等)。Make 可以自动化地执行编译、链接等一系列操作。 规则 makefile文件

SWAP作物生长模型安装教程、数据制备、敏感性分析、气候变化影响、R模型敏感性分析与贝叶斯优化、Fortran源代码分析、气候数据降尺度与变化影响分析

查看原文>>>全流程SWAP农业模型数据制备、敏感性分析及气候变化影响实践技术应用 SWAP模型是由荷兰瓦赫宁根大学开发的先进农作物模型,它综合考虑了土壤-水分-大气以及植被间的相互作用;是一种描述作物生长过程的一种机理性作物生长模型。它不但运用Richard方程,使其能够精确的模拟土壤中水分的运动,而且耦合了WOFOST作物模型使作物的生长描述更为科学。 本文让更多的科研人员和农业工作者

沁恒CH32在MounRiver Studio上环境配置以及使用详细教程

目录 1.  RISC-V简介 2.  CPU架构现状 3.  MounRiver Studio软件下载 4.  MounRiver Studio软件安装 5.  MounRiver Studio软件介绍 6.  创建工程 7.  编译代码 1.  RISC-V简介         RISC就是精简指令集计算机(Reduced Instruction SetCom

前端技术(七)——less 教程

一、less简介 1. less是什么? less是一种动态样式语言,属于css预处理器的范畴,它扩展了CSS语言,增加了变量、Mixin、函数等特性,使CSS 更易维护和扩展LESS 既可以在 客户端 上运行 ,也可以借助Node.js在服务端运行。 less的中文官网:https://lesscss.cn/ 2. less编译工具 koala 官网 http://koala-app.

【Shiro】Shiro 的学习教程(三)之 SpringBoot 集成 Shiro

目录 1、环境准备2、引入 Shiro3、实现认证、退出3.1、使用死数据实现3.2、引入数据库,添加注册功能后端代码前端代码 3.3、MD5、Salt 的认证流程 4.、实现授权4.1、基于角色授权4.2、基于资源授权 5、引入缓存5.1、EhCache 实现缓存5.2、集成 Redis 实现 Shiro 缓存 1、环境准备 新建一个 SpringBoot 工程,引入依赖:

Windows环境利用VS2022编译 libvpx 源码教程

libvpx libvpx 是一个开源的视频编码库,由 WebM 项目开发和维护,专门用于 VP8 和 VP9 视频编码格式的编解码处理。它支持高质量的视频压缩,广泛应用于视频会议、在线教育、视频直播服务等多种场景中。libvpx 的特点包括跨平台兼容性、硬件加速支持以及灵活的接口设计,使其可以轻松集成到各种应用程序中。 libvpx 的安装和配置过程相对简单,用户可以从官方网站下载源代码

PHP APC缓存函数使用教程

APC,全称是Alternative PHP Cache,官方翻译叫”可选PHP缓存”。它为我们提供了缓存和优化PHP的中间代码的框架。 APC的缓存分两部分:系统缓存和用户数据缓存。(Linux APC扩展安装) 系统缓存 它是指APC把PHP文件源码的编译结果缓存起来,然后在每次调用时先对比时间标记。如果未过期,则使用缓存的中间代码运行。默认缓存 3600s(一小时)。但是这样仍会浪费大量C