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

相关文章

使用Java解析JSON数据并提取特定字段的实现步骤(以提取mailNo为例)

《使用Java解析JSON数据并提取特定字段的实现步骤(以提取mailNo为例)》在现代软件开发中,处理JSON数据是一项非常常见的任务,无论是从API接口获取数据,还是将数据存储为JSON格式,解析... 目录1. 背景介绍1.1 jsON简介1.2 实际案例2. 准备工作2.1 环境搭建2.1.1 添加

Java实现任务管理器性能网络监控数据的方法详解

《Java实现任务管理器性能网络监控数据的方法详解》在现代操作系统中,任务管理器是一个非常重要的工具,用于监控和管理计算机的运行状态,包括CPU使用率、内存占用等,对于开发者和系统管理员来说,了解这些... 目录引言一、背景知识二、准备工作1. Maven依赖2. Gradle依赖三、代码实现四、代码详解五

java如何分布式锁实现和选型

《java如何分布式锁实现和选型》文章介绍了分布式锁的重要性以及在分布式系统中常见的问题和需求,它详细阐述了如何使用分布式锁来确保数据的一致性和系统的高可用性,文章还提供了基于数据库、Redis和Zo... 目录引言:分布式锁的重要性与分布式系统中的常见问题和需求分布式锁的重要性分布式系统中常见的问题和需求

SpringBoot基于MyBatis-Plus实现Lambda Query查询的示例代码

《SpringBoot基于MyBatis-Plus实现LambdaQuery查询的示例代码》MyBatis-Plus是MyBatis的增强工具,简化了数据库操作,并提高了开发效率,它提供了多种查询方... 目录引言基础环境配置依赖配置(Maven)application.yml 配置表结构设计demo_st

python使用watchdog实现文件资源监控

《python使用watchdog实现文件资源监控》watchdog支持跨平台文件资源监控,可以检测指定文件夹下文件及文件夹变动,下面我们来看看Python如何使用watchdog实现文件资源监控吧... python文件监控库watchdogs简介随着Python在各种应用领域中的广泛使用,其生态环境也

el-select下拉选择缓存的实现

《el-select下拉选择缓存的实现》本文主要介绍了在使用el-select实现下拉选择缓存时遇到的问题及解决方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的... 目录项目场景:问题描述解决方案:项目场景:从左侧列表中选取字段填入右侧下拉多选框,用户可以对右侧

Python pyinstaller实现图形化打包工具

《Pythonpyinstaller实现图形化打包工具》:本文主要介绍一个使用PythonPYQT5制作的关于pyinstaller打包工具,代替传统的cmd黑窗口模式打包页面,实现更快捷方便的... 目录1.简介2.运行效果3.相关源码1.简介一个使用python PYQT5制作的关于pyinstall

使用Python实现大文件切片上传及断点续传的方法

《使用Python实现大文件切片上传及断点续传的方法》本文介绍了使用Python实现大文件切片上传及断点续传的方法,包括功能模块划分(获取上传文件接口状态、临时文件夹状态信息、切片上传、切片合并)、整... 目录概要整体架构流程技术细节获取上传文件状态接口获取临时文件夹状态信息接口切片上传功能文件合并功能小

python实现自动登录12306自动抢票功能

《python实现自动登录12306自动抢票功能》随着互联网技术的发展,越来越多的人选择通过网络平台购票,特别是在中国,12306作为官方火车票预订平台,承担了巨大的访问量,对于热门线路或者节假日出行... 目录一、遇到的问题?二、改进三、进阶–展望总结一、遇到的问题?1.url-正确的表头:就是首先ur

C#实现文件读写到SQLite数据库

《C#实现文件读写到SQLite数据库》这篇文章主要为大家详细介绍了使用C#将文件读写到SQLite数据库的几种方法,文中的示例代码讲解详细,感兴趣的小伙伴可以参考一下... 目录1. 使用 BLOB 存储文件2. 存储文件路径3. 分块存储文件《文件读写到SQLite数据库China编程的方法》博客中,介绍了文