Pytest框架 — 10、Pytest的标记(一)(跳过和预期失败)

1、前言

引用自官方文档
您可以标记无法在某些平台上运行或您预计会失败的测试功能,以便 pytest 可以相应地处理它们并提供测试会话的摘要,同时保持测试套件绿色。

跳过(skip)意味着您希望测试仅在满足某些条件时才能通过,否则 pytest 应该完全跳过运行测试。常见的例子是跳过非 Windows 平台上的纯 Windows 测试,或者跳过依赖于目前不可用的外部资源(例如数据库)的测试。

预期失败(xfail)意味着您希望测试由于某种原因而失败。一个常见的例子是测试尚未实现的功能或尚未修复的错误。

2、标记跳过

使用方法:通过 @pytest.mark.skip(reason=跳过原因)装饰器标记要跳过的测试用例

  • 参数 reason:跳过的原因,非必填
import pytest

@pytest.mark.skip
def test_register():
    # 测试注册功能
    raise Exception("该功能尚未开发完成")

@pytest.mark.skip(reason="该功能尚未开发完成")
def test_logout():
    # 注销
    raise Exception("该功能尚未开发完成")

def test_login():
    # 登录功能
    assert True

"""
执行结果
mark/skip_mark.py::test_register SKIPPED (unconditional skip)
mark/skip_mark.py::test_logout SKIPPED (该功能尚未开发完成)
mark/skip_mark.py::test_login PASSED
"""

使用方法:通过 @pytest.mark.skipif(condition=跳过条件,reason=跳过原因)标记要跳过的测试用例。

  • 参数 condition:跳过的条件,值为True则跳过,值为False则继续执行,默认值为True
  • 参数 reason:必填,跳过的原因
import pytest

version = 3.0

@pytest.mark.skipif(condition=version > 3.0 or version == 3.0, reason="3.0及以上版本不提供下载功能")
def test_download():
    print("下载功能")

def test_upload():
    print("上传功能")

"""
执行结果
mark/skipif_mark.py::test_download SKIPPED (3.0及以上版本不提供下载功能)
mark/skipif_mark.py::test_upload 上传功能
PASSED
"""

当无法评估跳过条件或不想在模块级别检查条件的情况时,可以根据条件在测试函数中使用 pytest.skip(reason)进行强制跳过。类似于循环中的 break

import pytest

def test_fuction():
    try:
        with open("config.ini") as f:
            pass
    except Exception as e:
        pytest.skip("读取配置文件失败,跳过测试")

def test_function2():
    for i in range(10):
        if i == 3:
            pytest.skip("老子不数了")
        print(i)

"""
执行结果
mark/skip/pytest_skip.py::test_fuction SKIPPED (读取配置文件失败,跳过测试)
mark/skip/pytest_skip.py::test_function2 0
1
2
SKIPPED (老子不数了)
"""

在模块级别使用跳过整个模块

[En]

Use the skip entire module at the module level

import pytest
current_environment = "ios"

if current_environment != "Android":
    pytest.skip("非安卓环境,跳过此模块测试", allow_module_level=True)

def test_login():
    # 登录
    print("登录成功")

def test_add_cart():
    # 加购物车
    print("加购物车成功")

def test_pay():
    # 支付
    print("支付成功")

"""
执行结果
============================= test session starts ==============================
collecting ...

Skipped: 非安卓环境,跳过此模块测试
collected 0 items / 1 skipped
============================== 1 skipped in 0.01s ==============================
"""

3、标记预期失败

  • 如果 xfail标记的用例执行失败,则结果是 xfail,符合预期结果,在测试摘要中报告,不会显示错误回溯信息。
  • 如果 xfial标记的用例执行成功,则结果是 xpass,不符合预期结果,在测试摘要中报告。

@pytest.mark.xfail(condition,reason,raises,run,strict)

  • condition:当满足某种条件时才会预期失败(即满足某种条件此标记才生效,否则正常执行),值为布尔值或字符串,默认为 True,注意,当值为布尔值时必须传递 reason参数。
import pytest
version = 3.0

@pytest.mark.xfail(version==3.0, reason="判断只有3.0版本才会才会失败")
def test_1():
    print("测试函数1")

@pytest.mark.xfail(version>3.0, reason="判断只有3.0版本才会才会失败")
def test_2():
    print("测试函数2")

@pytest.mark.xfail("version==3.0")
def test_3():
    print("测试函数3")

"""
执行结果
mark/xfail/xfail_condition.py::test_1 测试函数1
XPASS (判断只有3.0版本才会才会失败)
mark/xfail/xfail_condition.py::test_2 测试函数2
PASSED
mark/xfail/xfail_condition.py::test_3 测试函数3
XPASS (condition: version==3.0)
"""
  • reason:说明用例标记为预期失败的原因,默认为 None
  • raises:指定单个异常或异常元组,期望抛出这些异常
  • 如果用例失败不是因为指定的这些异常,则执行结果标记为 failed
  • 如果用例失败因为指定的这些异常,则执行结果标记为 xfailed
import pytest

@pytest.mark.xfail(raises=ZeroDivisionError)
def test_1():
    res = 21 / 0

@pytest.mark.xfail(raises=(ValueError, IndexError))
def test_2():
    res = 21 / 0

"""
执行结果
mark/xfail/xfail_raises.py::test_1 XFAIL
mark/xfail/xfail_raises.py::test_2 FAILED

================================================================== FAILURES ===================================================================
___________________________________________________________________ test_2 ____________________________________________________________________

    @pytest.mark.xfail(raises=(ValueError, IndexError))
    def test_2():
>       res = 21 / 0
E       ZeroDivisionError: division by zero

mark/xfail/xfail_raises.py:15: ZeroDivisionError
=========================================================== short test summary info ===========================================================
FAILED mark/xfail/xfail_raises.py::test_2 - ZeroDivisionError: division by zero
"""
  • run:标识是否执行此用例,若为 True则执行,否则直接标记为 xfail,默认为 True
  • strict:若为 True,如果测试用例 xpass则执行结果为 failed,默认为 False。也可以全局配置,在 pytest.ini中添加一条 xfail_strict=True即可。
import pytest

@pytest.mark.xfail(strict=True)
def test_1():
    print("预期失败,结果成功")
    assert True

@pytest.mark.xfail(strict=True)
def test_2():
    print("预期失败,结果失败")
    assert False

"""
执行结果
mark/xfail/xfail_strict.py::test_1 预期失败,结果成功
FAILED
mark/xfail/xfail_strict.py::test_2 预期失败,结果失败
XFAIL
"""

当无法评估是否预期失败或不想在模块级别检查条件的情况时,可以根据情况在测试函数使用 pytest.xfail(reason)进行强制预期失败的标记。类似于循环的 break

import pytest

def test_fuction():
    try:
        with open("config.ini") as f:
            pass
    except Exception as e:
        pytest.xfail("读取配置文件失败,预期失败")

def test_fuction2():
    for i in range(10):
        if i == 3:
            pytest.xfail("强制预期失败")
        print(f"数值{i}")

"""
执行结果
mark/xfail/pytest_xfail.py::test_fuction XFAIL (读取配置文件失败,预期失败)
mark/xfail/pytest_xfail.py::test_fuction2 数值0
数值1
数值2
XFAIL (强制预期失败)
"""
import pytest

预期失败,结果失败
@pytest.mark.xfail(True, reason="预期失败")
def test_1():
    print("预期失败,结果失败")
    assert False

预期失败,结果成功
@pytest.mark.xfail(True, reason="预期失败")
def test_2():
    print("预期失败,结果成功")
    assert True

不预期失败,结果失败
@pytest.mark.xfail(False, reason="不预期失败")
def test_3():
    print("不预期失败,结果失败")
    assert False

不预期失败,结果成功
@pytest.mark.xfail(False, reason="不预期失败")
def test_4():
    print("不预期失败,结果成功")
    assert True

"""
执行结果
mark/xfail/xfail.py::test_1 预期失败,结果失败
XFAIL (预期失败)
mark/xfail/xfail.py::test_2 预期失败,结果成功
XPASS (预期失败)
mark/xfail/xfail.py::test_3 不预期失败,结果失败
FAILED
mark/xfail/xfail.py::test_4 不预期失败,结果成功
PASSED
"""

命令: pytest --runxfail,在执行时添加 --runxfail参数可以将所有预期失败标记忽略

import pytest

@pytest.mark.xfail
def test_1():
    assert False

@pytest.mark.xfail
def test_2():
    assert True

"""
执行结果
mark/xfail/ignore_xfail.py::test_1 FAILED
mark/xfail/ignore_xfail.py::test_2 PASSED
"""
  • 如果 @pytest.mark.xfail不添加任何参数,那么测试结果为 xpassxfail
  • condition值用于判断 xfail标记是否生效,如果生效则测试结果为 xfailxpass,否则为 failedpassed
  • 如果测试失败的原因在 raises中,则标记为 xfailed,否则标记为 failed
  • 如果设置了 strict=True,则当执行结果为 xpass时,测试结果为 failed

Original: https://www.cnblogs.com/qishuaiRisen/p/16599547.html
Author: 睡觉大王Risen
Title: Pytest框架 — 10、Pytest的标记(一)(跳过和预期失败)

原创文章受到原创版权保护。转载请注明出处:https://www.johngo689.com/498731/

转载文章受原作者版权保护。转载请注明原作者出处!

(0)

大家都在看

  • RV1126笔记十六:吸烟行为检测及部署<四>

    若该文为原创文章,转载请注明原文出处。 转换成onnx模型(windows) 一、查看pt文件 准备好训练好的pt文件,可以用Netron打开看看大概长啥样: 二、模型转换 主要的…

    Python 2023年10月10日
    049
  • python3打印输出坐标_PyGame绘制一个像素并打印出它的坐标

    我将aessette的代码编辑为一个独立的示例: 根据您正在执行的操作,获取/设置单个像素可能会很慢。(如果需要,可以使用Surfarray和Pixelarray。)在import…

    Python 2023年9月24日
    041
  • 企业全面云化的时代——云数据库的未来

    云数据库 前言 传统数据库的不足 云原生数据库的优点 * – 1.动态可扩展性 2.高可用性 3.较低的建设成本 4.轻松部署 5.高可靠性 云原生数据库容器化 * 什…

    Python 2023年11月7日
    039
  • Python安装Pytorch教程(图文详解)

    最近人工智能等多门课需要复现论文,近两年的论文很多都是基于Pytorch环境做的实验,所以,这里总结一下Pytorch的安装教程,做好 最快、最简单、最好地完成安装。 本机环境Wi…

    Python 2023年10月11日
    050
  • 【机器学习】手写数字识别

    前言 logistic回归,是一个分类算法,可以处理二元分类,多元分类。我们使用sklearn中的logistic对手写数字识别进行实践。 数据集 MNIST数据集来自美国国家标准…

    Python 2023年5月23日
    0109
  • 关于N个有理分数求和的分析(c语言)

    输入样例1: 5 2/5 4/15 1/30 -2/60 8/3 输出样例1: 3 1/3 输入样例2: 2 4/3 2/3 输出样例2: 2 输入样例3: 3 1/3 -1/6 …

    Python 2023年6月12日
    078
  • python之高阶pandas的使用(一)

    用维度表表示重复的值 values=pd.Series([‘apple’,’orange’,’lemon’,’apple’]*2) values 去重 pd.unique(valu…

    Python 2023年8月7日
    070
  • Pandas之三选择数据

    前文介绍了如何查看dataframe数据,现在再来看看怎么样定位和修改pandas的具体数据。 官方推荐选择数据的方法为 .at, .iat, .loc, .iloc,这些方法可以…

    Python 2023年8月22日
    042
  • 将 N 叉树编码为二叉树

    将 N 叉树编码为二叉树 作者:Grey 原文地址: 博客园:将 N 叉树编码为二叉树 CSDN:将 N 叉树编码为二叉树 题目描述 将一棵n叉树编码为一棵二叉树,并对二叉树进行解…

    Python 2023年10月19日
    062
  • Python与GIS

    Python矢量与栅格数据处理 原创 孟祥帅 祥帅的小屋 2022-10-21 18:55 发表于山东 持续更新ing,欢迎各位点赞关注哦! 1. Python处理栅格影像 1.1…

    Python 2023年8月24日
    038
  • 系统移植第一天

    一、什么是系统移植 1.1 系统移植就是给开发板搭建一个Linux操作系统 1.2 从官方获取源码,进行配置和编译,生成板子需要的镜像文件 二、为什么学习系统移植 2.1 为后面学…

    Python 2023年9月26日
    039
  • Numpy——np.diag()一文看懂

    1.np.diag(v, k): 官方文档如下 @array_function_dispatch(_diag_dispatcher)def diag(v: Union[ndarra…

    Python 2023年8月22日
    038
  • Chrome浏览器的跨域设置

    做前后端分离的开发的时候,出于一些原因往往需要将浏览器设置成支持跨域的模式,而且chrome浏览器支持可跨域的设置,但是新版本的chrome浏览器提高了跨域设置的门槛,原来的方法不…

    Python 2023年10月10日
    068
  • 痞子衡嵌入式:在i.MXRT启动头FDCB里使能串行NOR Flash的QPI/OPI模式

    大家好,我是痞子衡,是正经搞技术的痞子。今天痞子衡给大家介绍的是 在FDCB里使能串行NOR Flash的QPI/OPI模式。 我们知道 Flash 读时序里有五大子序列 CMD …

    Python 2023年10月23日
    052
  • 一些关于conda的介绍及命令

    Anaconda是一个包含数据科学常用包的 Python 发行版本。它基于 conda ——一个包和环境管理器——衍生而来。安装Anaconda,包含了conda包。 你可以使用c…

    Python 2023年9月8日
    052
  • 【算法集锦】Python 性能检测分析方法 – 时间、空间衡量方法

    性能检测分析方法 – 时间、空间衡量方法 Python 自带模块 import time 点击查看代码 仅仅&#x6…

    Python 2023年10月30日
    036
亲爱的 Coder【最近整理,可免费获取】👉 最新必读书单  | 👏 面试题下载  | 🌎 免费的AI知识星球