Python的pytest框架(5)--测试标记(Markers)

devtools/2024/9/23 18:19:55/

该篇将循序渐进地详细拆解 pytest.mark 装饰器:

目录

一、概念

二、标记的基本结构与使用

三、标记在测试中的层次应用

四、标记的筛选与运行

五、标记与测试行为控制

六、标记与测试参数化

七、标记的注册与自定义

pytest.ini%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6%EF%BC%9A-toc" style="margin-left:40px;">1、通过pytest.ini配置文件:

2、通过conftest.py文件:

八、标记与第三方插件的集成


一、概念

在软件测试中,经常需要对大量的测试用例进行分类、筛选和管理。为了提高测试的组织性和可维护性,pytest 提供了一种称为“标记”(Marker)的功能。标记是一种元数据,允许我们为测试函数、类或模块添加额外的描述性信息。这些信息可以帮助我们:

  • 分类测试:根据测试的目的、重要性、阶段(如单元测试、集成测试、冒烟测试等)对测试进行分组。
  • 筛选测试:在运行测试时,通过标记快速选择特定类型的测试进行执行,避免运行全部测试。
  • 控制测试行为:标记可以指示 pytest 对特定测试采取特定的操作,如跳过、预期失败等。
  • 集成第三方工具:标记可与某些 pytest 插件或外部工具配合,提供更丰富的测试报告、自动化处理等。

二、标记的基本结构与使用

标记是通过 pytest.mark 装饰器来应用的。装饰器是一种 Python 语法,用于修改或增强函数、类等对象的行为。在 pytest 中,使用 pytest.mark.<marker_name> 形式的装饰器为测试项添加标记。实例如下:

python">import pytest# 使用 @pytest.mark.smoke 标记一个冒烟测试
@pytest.mark.smoke
def test_login():...# 使用 @pytest.mark.integration 标记一个集成测试
@pytest.mark.integration
class TestPaymentSystem:...

pytest 内置了一些常见的标记名称,这些标记可以直接在测试代码中使用,以下是一些常见的内置标记名称及其用途:

标记名称含义与用途分类
smoke冒烟测试,快速验证核心功能是否正常
测试类型或阶段
regression回归测试,检查已有功能在代码变更后是否正常,防止引入新的 bug
unit单元测试,针对代码最小可测试单元进行隔离测试
integration集成测试,验证不同模块或组件间的交互是否正确
system系统测试,测试整个系统作为一个整体的功能和行为
e2e / end-to-end端到端测试,模拟用户操作验证完整业务流程的正确性
slow耗时较长的测试,可以用于筛选并单独运行这类测试,或者在持续集成(CI)环境中跳过它们以加快测试周转时间。执行条件
fast快速测试,用于快速验证关键功能或优先运行
flaky易变或不可靠的测试,可能间歇性失败,标记为 flaky 的测试在失败时可以被报告为预期失败(xfail),不影响整体测试结果。
network需要网络连接的测试资源要求或限制
database依赖数据库的测试
live_server需要与实际运行服务器交互的测试
no_cover不计入代码覆盖率统计的测试
windows / linux / macos只能在特定操作系统上运行的测试特定环境或条件
python_version依赖特定 Python 版本的测试
requires_gpu需要 GPU 支持的测试
requires_redis / requires_mysql依赖特定第三方服务或软件的测试

三、标记在测试中的层次应用

标记可以应用在不同测试层次上,影响范围从单个测试函数到整个测试模块。

  • 函数级标记:直接应用于测试函数,仅对该函数生效。
  • 类级标记:应用于测试类,类中所有测试函数都将继承该标记。
  • 模块级标记:在 conftest.py 或测试模块顶部使用 pytestmark = pytest.mark.<marker_name>,标记整个模块内的所有测试。

实例如下:

python"># 函数级标记
@pytest.mark.unit
def test_unit():...# 类级标记
@pytest.mark.integration
class TestIntegration:def test_large_query(self):...def test_concurrency(self):...# 模块级标记(在 conftest.py 或测试模块顶部)
pytestmark = pytest.mark.regression

四、标记的筛选与运行

在运行 pytest 命令时,可以通过 -m(或 --mark)选项指定一个标记表达式来筛选测试。标记表达式可以包含标记名称、逻辑运算符(and、or、not)以及括号用于分组。示例:

python"># 执行所有标记为 smoke 的测试
pytest -m smoke# 执行标记为 smoke 或 integration 的测试
pytest -m "smoke or integration"# 执行既非 slow 也非 integration 的测试
pytest -m "not slow and not integration"# 运行同时带有 unit 和 integration 的测试
pytest -m "unit and integration"# 复杂组合筛选
pytest -m "(system or integration) and not unit"  #运行system或integration,且不运行带有unit的测试

在项目的 pytest.ini 配置文件中,可以设置 addopts 键来指定默认的标记筛选规则。例如:

python">[pytest]
addopts = -m "not slow and not flaky"

这样,除非在命令行中显式覆盖,否则 pytest 将默认排除标记为 slow 或 flaky 的测试。

pytest 的测试报告会显示每个测试用例的标记信息。当通过标记筛选运行测试时,报告会清晰地展示哪些测试因为标记筛选而被包含或排除。这对于理解测试执行情况和分析测试结果非常有帮助。在实际使用中,应结合项目特点和团队约定,合理使用标记和筛选功能,确保测试的有效性和覆盖率。

五、标记与测试行为控制

某些标记可以直接控制测试的执行行为,如跳过、预期失败等。

  • pytest.mark.skip:无条件跳过标记了该标记的测试。
  • pytest.mark.skipif:在给定条件为真时跳过测试,接受一个条件表达式和可选的跳过原因。
  • pytest.mark.xfail:预期测试失败,如果测试确实失败,则视为“预期失败”,否则为“意外通过”。接受条件表达式、预期失败原因、是否严格检查意外通过等参数。
  • pytest.mark.usefixtures:强制使用 fixtures,即使测试函数没有显式请求这些 fixtures,pytest 也会在测试执行前准备并清理它们。

实例如下:

python">import sys
import pytest# 无条件跳过测试
@pytest.mark.skip(reason="待修复")
def test_buggy_feature():...# 在 Python 版本低于 3.7 时跳过测试
@pytest.mark.skipif(sys.version_info < (3, 7), reason="Requires Python 3.7+")
def test_new_syntax():...# 预期测试失败,但允许意外通过
@pytest.mark.xfail(reason="Known issue with this combination")
def test_unstable_combination():...import os
#如果环境变量 RUN_DATABASE_TESTS 未设置或者其值为假(如空字符串或 "False"),该测试将被跳过。
@pytest.mark.skipif(not os.environ.get("RUN_DATABASE_TESTS"), reason="Database tests disabled")
def test_database_connection():# 连接并验证数据库连接# ...@pytest.fixture
def shared_resource():resource = create_shared_resource()yield resourcecleanup_shared_resource(resource)@pytest.mark.usefixtures("shared_resource")
class TestWithShared_resource:def test_case1(self):...def test_case2(self):...#这种方式也简化了代码,避免了在每个测试方法上重复添加装饰器。

六、标记与测试参数化

pytest.mark.parametrize 是一个特殊的标记,用于创建参数化的测试,即一个测试函数可以针对多组不同的输入数据执行多次。我在pytest专栏里已经写了关于参数化的文章:Python的pytest框架(4)--参数化测试

七、标记的注册与自定义

若要使用自定义标记,需要在 pytest.ini 或 conftest.py 中注册标记及其说明。自定义标记可以像内置标记一样使用,并可能与特定插件或内部逻辑交互。pytest提供了两种主要方式来注册自定义标记:

pytest.ini%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6%EF%BC%9A">1、通过pytest.ini配置文件:

在项目根目录下创建或编辑pytest.ini文件,添加[pytest]节,并在其中定义标记。格式如下:

python">[pytest]
markers =slow: marks tests as slow (deselect with '-m "not slow"')requires_gpu: marks tests that require a GPU to runapi_integration: marks tests that involve API integration...

在这里,标记名称(如slow、requires_gpu、api_integration)放在冒号前面,后面是对标记的简短描述。这些标记可以在命令行中通过-m选项进行筛选。

2、通过conftest.py文件:

在项目的任意层级(通常是与待测试代码相近的位置)创建或编辑conftest.py文件。在其中,可以通过重写pytest_configure(config)函数来注册标记。例如:

python"># conftest.pyimport pytestdef pytest_configure(config):"""Register custom pytest markers."""config.addinivalue_line("markers",#参数 "markers"指定了要添加到哪个键下。markers 键是用来存储所有自定义标记定义的。"performance: mark a test as measuring performance, ""may be used for long-running tests" #这是添加到markers键下的值。它是一个字符串,格式为 <marker_name>: <marker_description> 也就是"performance"是标记名称,冒号后面为标记描述) config.addinivalue_line("markers","network: mark tests that require network connectivity")config.addinivalue_line("markers","critical: mark tests that verify critical functionality, ""should always be included in regression testing")

这里使用config.addinivalue_line()方法向markers键添加新的标记定义。在这个例子中,我们定义了三个标记:performance、network和critical。每个标记都有一个简短的描述,说明其含义和使用场景。config.addinivalue_line()方法用于向markers键添加新的标记定义。

八、标记与第三方插件的集成

许多 pytest 插件会识别并利用标记来扩展测试功能。Allure是一个通用的测试报告工具,提供了详细的测试执行历史、丰富的图表和交互式界面。allure-pytest插件将pytest与Allure报告系统紧密集成,使得pytest标记可以在Allure报告中发挥重要作用。

  • 标记分类:Allure报告可以按标记对测试进行分类展示。在pytest测试中使用标记后,Allure报告会自动将标记作为测试的标签显示,方便用户按标记过滤和浏览测试结果。
  • 标记与标签:在Allure中,可以将pytest标记映射为特定的Allure标签,以便在报告中以特定样式呈现或进行特定分析。这通常通过在pytest.ini或conftest.py中配置allure_markers来实现。
  • 标记与测试步骤:某些Allure插件(如allure-behave)支持将pytest标记关联到测试步骤,以便在报告中突出显示关键步骤或标记特定行为。
python">[pytest]
allure_markers =smoke: smokecritical: criticalregression: regression

相关内容会持续在pytest框架专栏中拓展,大家多多关注~

希望上述内容能帮助到大家理解使用pytest框架的测试标记@pytest.mark.<marker_name>


http://www.ppmy.cn/devtools/7986.html

相关文章

C++修炼之路之多态---多态的原理(虚函数表)

目录 一&#xff1a;多态的原理 1.虚函数表 2.原理分析 3.对于虚表存在哪里的探讨 4.对于是不是所有的虚函数都要存进虚函数表的探讨 二&#xff1a;多继承中的虚函数表 三&#xff1a;常见的问答题 接下来的日子会顺顺利利&#xff0c;万事胜意&#xff0c;生活明朗--…

NPM常用命令详解:提升你的JavaScript开发效率

NPM常用命令详解&#xff1a;提升你的JavaScript开发效率 NPM&#xff08;Node Package Manager&#xff09;是随同Node.js一起安装的包管理工具&#xff0c;它是世界上最大的软件注册中心。通过NPM&#xff0c;开发者可以分享和重用代码&#xff0c;管理项目中的依赖关系&…

Rust - 引用和借用

上一篇章末尾提到&#xff0c;如果仅仅支持通过转移所有权的方式获取一个值&#xff0c;那会让程序变得复杂。 Rust 能否像其它编程语言一样&#xff0c;使用某个变量的指针或者引用呢&#xff1f;答案是可以。 Rust 通过 借用(Borrowing) 这个行为来达成上述的目的&#xff0…

使用51单片机控制T0和T1分别间隔1秒2秒亮灭逻辑

#include <reg51.h>sbit LED1 P1^0; // 设置LED1灯的接口 sbit LED2 P1^1; // 设置LED2灯的接口unsigned int cnt1 0; // 设置LED1灯的定时器溢出次数 unsigned int cnt2 0; // 设置LED2灯的定时器溢出次数// 定时器T0 void Init_Timer0() {TMOD | 0x01;; // 定时器…

Github 2024-04-21php开源项目日报Top10

根据Github Trendings的统计,今日(2024-04-21统计)共有10个项目上榜。根据开发语言中项目的数量,汇总情况如下: 开发语言项目数量PHP项目10Blade项目1Laravel:表达力和优雅的 Web 应用程序框架 创建周期:4631 天开发语言:PHP, BladeStar数量:75969 个Fork数量:24281 次…

【深度学习】DragGAN

基于StyleGAN的图像拖拽编辑新范式 一、StyleGAN与DragGAN&#xff1a;图像生成与编辑的桥梁二、DragGAN的实现原理三、实例与代码展示四、总结与展望 在深度学习和计算机视觉领域&#xff0c;图像生成和编辑技术一直是研究的热点。StyleGAN作为一种强大的图像生成模型&#xf…

图论——基础概念

文章目录 学习引言什么是图图的一些定义和概念图的存储方式二维数组邻接矩阵存储优缺点 数组模拟邻接表存储优缺点 边集数组优缺点排序前向星优缺点链式前向星优缺点 学习引言 图论&#xff0c;是 C 里面很重要的一种算法&#xff0c;今天&#xff0c;就让我们一起来了解一下图…

Spark和Hadoop的安装

实验内容和要求 1&#xff0e;安装Hadoop和Spark 进入Linux系统&#xff0c;完成Hadoop伪分布式模式的安装。完成Hadoop的安装以后&#xff0c;再安装Spark&#xff08;Local模式&#xff09;。 2&#xff0e;HDFS常用操作 使用hadoop用户名登录进入Linux系统&#xff0c;启动…