pytest 的 request fixture:实现个性化测试需求

2024-04-26 21:04

本文主要是介绍pytest 的 request fixture:实现个性化测试需求,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

在之前深入理解pytest-repeat插件的工作原理一文中,我们看到pytest_repeat源码中有这样一段

  1. @pytest.fixture

  2. def __pytest_repeat_step_number(request):

  3.    marker = request.node.get_closest_marker("repeat")

  4.    count = marker and marker.args[0] or request.config.option.count

  5. ......

看到参数为request,我们知道fixture装饰的函数入参,只能是其他fixture,所以这里request一定也是fixture。那它到底怎么用呢?这篇文章将详细介绍,并通过实战项目加深理解。

request fixture

The request fixture is a special fixture providing information of the requesting test function.这是pytest官方文档的介绍,意思就是请求fixture是一个特殊的fixture,提供请求测试函数的信息。

源码直达,感兴趣的朋友可以查看源码FixtureRequest

文档直达

request.node

当前测试用例的节点对象,表示当前执行的测试用例。可以使用该对象获取测试用例的名称、文件路径、测试类等信息。

  1. import pytest

  2. @pytest.fixture

  3. def my_fixture(request):

  4.    node = request.node

  5.    print(f"Current test case: {node.name}")

  6.    print(f"Test file path: {node.fspath}")

  7.    print(f"Test class: {node.getparent}")

  8. def test_demo(my_fixture):

  9.    pass

输出结果为:

  1. Current test case: test_demo

  2. Test file path: /Users/pxl/test_dir/test_demo.py

  3. Test class: <bound method Node.getparent of <Function test_demo>>

fixture 使用了 request 参数,并通过 request.node 获取了当前测试用例的相关信息。具体来说,我们打印了当前测试用例的名称、文件路径和测试类名称。

request.config

前运行的配置对象,表示当前 Pytest 的配置信息。可以使用该对象获取命令行参数、配置文件设置等信息。

pytest.ini

  1. [pytest]

  2. markers =

  3.    p0: 冒烟

  4.    p1: 功能

 
  1. @pytest.fixture

  2. def my_fixture(request):

  3.    config = request.config

  4.    print(f"Command line arguments: {config.option}")

  5.    print(f"INI file options: {config.getini('markers')}")

该 fixture 使用了 request 参数,并通过 request.config 获取了当前 Pytest 的配置信息。具体来说,我们打印了命令行参数和配置文件中的一个选项。

request.param

当前 fixture 的参数,表示当前 fixture 的实例所需的参数值

  1. @pytest.fixture(params=[1, 2, 3])

  2. def my_fixture(request):

  3.    param_value = request.param

  4.    print(f"Current parameter value: {param_value}")

  5.    return param_value

该 fixture 使用了 request 参数,并通过 request.param 获取了当前实例所需的参数值。

request.fixturename

返回当前 fixture 的名称。

  1. @pytest.fixture

  2. def my_fixture(request):

  3.    fixture_name = request.fixturename

  4.    print(f"Current fixture name: {fixture_name}")

我们使用 request.fixturename 获取了当前 fixture 的名称,并将其打印出来.

request.fixturenames

返回当前测试函数所使用的所有 fixture 的名称列表

  1. @pytest.fixture

  2. def my_fixture(request):

  3.    pass

  4. def test_example(my_fixture, request):

  5.    fixture_names = request.fixturenames

  6.    print(f"Current fixture name: {fixture_names}")

我们使用 request.fixturename s获取了test_example使用的所有 fixture 的名称

request.cls

当前测试类的类对象。

  1. class TestClass:

  2.    @pytest.fixture

  3.    def my_fixture(self, request):

  4.        class_obj = request.cls

  5.        print(f"Current class object: {class_obj}")

使用 request.cls 获取了当前测试类的类对象,并将其打印出来。

request.addfinalizer(finalizer_func)

在 fixture 完成后执行指定的函数。

  1. @pytest.fixture

  2. def my_fixture(request):

  3.    def finalizer_func():

  4.        print("Finalizer function called")

  5.    request.addfinalizer(finalizer_func)

  6.    print("Fixture setup")

我们使用 request.addfinalizer() 方法注册了一个 finalizer 函数 finalizer_func。该函数将在 fixture 执行完毕后被调用,并打印一条消息。

request.applymarker(marker)

为当前测试用例或 fixture 应用指定的 marker。

  1. @pytest.fixture

  2. def my_fixture(request):

  3.    request.applymarker(pytest.mark.slow)

我们使用 request.applymarker() 方法为当前 fixture 添加了一个 pytest.mark.slow 的标记。这个标记可以被 Pytest 识别并用于特定的测试运行策略。

request.config.getoption(name)

获取命令行选项的值。

  1. @pytest.fixture

  2. def my_fixture(request):

  3.    my_option = request.config.getoption("--my_option")

  4.    print(f"Value of --my_option: {my_option}")

我们使用 request.config.getoption() 方法获取了命令行选项 --my_option 的值,并将其打印出来。

request.module

当前测试用例所属的模块对象

  1. def my_fixture(request):

  2.    module_obj = request.module

  3.    print(f"Current module object: {module_obj}")

我们使用 request.module 获取了当前测试用例所属的模块对象,并将其打印出来

request.param_index

参数化 fixture 的参数索引

  1. @pytest.fixture(params=[1, 2, 3])

  2. def my_fixture(request):

  3.    param_value = request.param

  4.    param_index = request.param_index

  5.    print(f"Current parameter value: {param_value}")

  6.    print(f"Current parameter index: {param_index}")

  7.    return param_value

我们对带有参数的 my_fixture fixture 进行了参数化。使用 request.param_index 可以获取当前参数在参数列表中的索引,并将其打印出来。

request.keywords

当前测试用例的关键字集合

  1. @pytest.fixture

  2. def my_fixture(request):

  3.    keywords = request.keywords

  4.    print(f"Current test keywords: {keywords}")

我们使用 request.keywords 获取了当前测试用例的关键字集合,并将其打印出来

request.getfixturevalue(fixturename)

获取已注册的 fixture 对象的值

  1. import pytest

  2. @pytest.fixture

  3. def my_fixture():

  4.    return "Hello, Fixture!"

  5. def test_example(request):

  6.    fixture_value = request.getfixturevalue("my_fixture")

  7.    assert fixture_value == "Hello, Fixture!"

实战

到这里request fixture的常用属性和方法应该了解差不多了。更多属性和方法,可以参考官方文档。

接下来我们就利用request属性实现数据库环境的切换。看实现代码

conftest.py

  1. def pytest_addoption(parser):

  2.    parser.addoption("--test", action="store_true", help="Run tests in test mode")

  3. @pytest.fixture(scope="session")

  4. def config_parser(request):

  5.    class Clazz(object):

  6.        config = ConfigParser()

  7.        config.read(config_path)

  8.        section = 'test' if request.config.getoption("--test") else 'prod'

  9.        log.info(f"section: {config.sections()}")

  10.        db_host = config.get(section, 'host')

  11.        db_port = config.get(section, 'port')

  12.        db_username = config.get(section, 'username')

  13.        db_password = config.get(section, 'password')

  14.        db_database = config.get(section, 'database')

  15.        api_url = config.get(section, 'url')

  16.    return Clazz

  17. @pytest.fixture(scope="session")

  18. def db_connection(config_parser):

  19.    db_conn = MySQLDB(

  20.        config_parser.db_host,

  21.        int(config_parser.db_port),

  22.        config_parser.db_username,

  23.        config_parser.db_password,

  24.        config_parser.db_database

  25.   )

  26.    yield db_conn

  27.    db_conn.close()

  1. config_parser 是一个会话级别的 fixture,它返回一个配置解析器对象。这个配置解析器对象可以读取配置文件,并根据传入的命令行参数 --test 来确定读取哪个配置文件的特定部分(测试环境或生产环境)。具体流程如下:

    a. 首先,在 pytest_addoption 函数中,通过调用 parser.addoption() 方法来添加一个命令行选项 --test,它的作用是告诉 pytest 在测试模式下运行。

    b. 在 config_parser fixture 中,我们首先创建了一个名为 Clazz 的类,它包含了从配置文件中读取的各个配置项的值。

    c. 根据传入的 --test 参数值,决定使用测试环境还是生产环境的配置。如果 --test 参数被指定,则使用配置文件中的 test 部分,否则使用 prod 部分。

    d. 通过 config.get() 方法获取具体的配置项的值,例如 db_hostdb_portdb_username 等。

    e. 最后,将 Clazz 类作为返回值,供其他测试代码使用。

  2. db_connection 是一个会话级别的 fixture,它返回一个数据库连接对象。这个对象在测试期间可以被使用,并在测试完成后进行关闭。具体流程如下:

    a. 在 db_connection fixture 中,我们创建了一个 MySQLDB 对象,将从 config_parser fixture 中获取的数据库连接参数传入。

    b. 使用 yield 语句将数据库连接对象返回给测试代码。yield 使得这个 fixture 可以在测试期间提供数据库连接,而在测试完成后继续执行下面的代码。

    c. 在 yield 之后的代码将在测试完成后执行,这里使用 db_conn.close() 来关闭数据库连接。

可以看到我们正是使用request.config.getoption这个方法来 获取命令行选项的值。

这段代码展示了如何使用 pytest 的 fixture 来管理测试环境和资源的初始化和清理。通过使用会话级别的 fixture,可以确保在整个测试会话期间只进行一次配置解析和数据库连接操作,避免重复的开销和不必要的操作。

后续

到这里我们有攻克了一个知识点request,不仅介绍了它的基本用法,也介绍了笔者在工作中真实使用场景。多加尝试,才能印象深刻。

行动吧,在路上总比一直观望的要好,未来的你肯定会感 谢现在拼搏的自己!如果想学习提升找不到资料,没人答疑解惑时,请及时加入扣群: 320231853,里面有各种软件测试+开发资料和技术可以一起交流学习哦。

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

这些资料,对于【软件测试】的朋友来说应该是最全面最完整的备战仓库,这个仓库也陪伴上万个测试工程师们走过最艰难的路程,希望也能帮助到你!

这篇关于pytest 的 request fixture:实现个性化测试需求的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

C++使用栈实现括号匹配的代码详解

《C++使用栈实现括号匹配的代码详解》在编程中,括号匹配是一个常见问题,尤其是在处理数学表达式、编译器解析等任务时,栈是一种非常适合处理此类问题的数据结构,能够精确地管理括号的匹配问题,本文将通过C+... 目录引言问题描述代码讲解代码解析栈的状态表示测试总结引言在编程中,括号匹配是一个常见问题,尤其是在

Java实现检查多个时间段是否有重合

《Java实现检查多个时间段是否有重合》这篇文章主要为大家详细介绍了如何使用Java实现检查多个时间段是否有重合,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录流程概述步骤详解China编程步骤1:定义时间段类步骤2:添加时间段步骤3:检查时间段是否有重合步骤4:输出结果示例代码结语作

Nginx设置连接超时并进行测试的方法步骤

《Nginx设置连接超时并进行测试的方法步骤》在高并发场景下,如果客户端与服务器的连接长时间未响应,会占用大量的系统资源,影响其他正常请求的处理效率,为了解决这个问题,可以通过设置Nginx的连接... 目录设置连接超时目的操作步骤测试连接超时测试方法:总结:设置连接超时目的设置客户端与服务器之间的连接

使用C++实现链表元素的反转

《使用C++实现链表元素的反转》反转链表是链表操作中一个经典的问题,也是面试中常见的考题,本文将从思路到实现一步步地讲解如何实现链表的反转,帮助初学者理解这一操作,我们将使用C++代码演示具体实现,同... 目录问题定义思路分析代码实现带头节点的链表代码讲解其他实现方式时间和空间复杂度分析总结问题定义给定

Java覆盖第三方jar包中的某一个类的实现方法

《Java覆盖第三方jar包中的某一个类的实现方法》在我们日常的开发中,经常需要使用第三方的jar包,有时候我们会发现第三方的jar包中的某一个类有问题,或者我们需要定制化修改其中的逻辑,那么应该如何... 目录一、需求描述二、示例描述三、操作步骤四、验证结果五、实现原理一、需求描述需求描述如下:需要在

如何使用Java实现请求deepseek

《如何使用Java实现请求deepseek》这篇文章主要为大家详细介绍了如何使用Java实现请求deepseek功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1.deepseek的api创建2.Java实现请求deepseek2.1 pom文件2.2 json转化文件2.2

python使用fastapi实现多语言国际化的操作指南

《python使用fastapi实现多语言国际化的操作指南》本文介绍了使用Python和FastAPI实现多语言国际化的操作指南,包括多语言架构技术栈、翻译管理、前端本地化、语言切换机制以及常见陷阱和... 目录多语言国际化实现指南项目多语言架构技术栈目录结构翻译工作流1. 翻译数据存储2. 翻译生成脚本

如何通过Python实现一个消息队列

《如何通过Python实现一个消息队列》这篇文章主要为大家详细介绍了如何通过Python实现一个简单的消息队列,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录如何通过 python 实现消息队列如何把 http 请求放在队列中执行1. 使用 queue.Queue 和 reque

Python如何实现PDF隐私信息检测

《Python如何实现PDF隐私信息检测》随着越来越多的个人信息以电子形式存储和传输,确保这些信息的安全至关重要,本文将介绍如何使用Python检测PDF文件中的隐私信息,需要的可以参考下... 目录项目背景技术栈代码解析功能说明运行结php果在当今,数据隐私保护变得尤为重要。随着越来越多的个人信息以电子形

使用 sql-research-assistant进行 SQL 数据库研究的实战指南(代码实现演示)

《使用sql-research-assistant进行SQL数据库研究的实战指南(代码实现演示)》本文介绍了sql-research-assistant工具,该工具基于LangChain框架,集... 目录技术背景介绍核心原理解析代码实现演示安装和配置项目集成LangSmith 配置(可选)启动服务应用场景