Pytest钩子函数，测试框架动态切换测试环境

news2025/1/9 16:45:17

在软件测试中，测试环境的切换是个令人头疼的问题。不同环境的配置不同，如何高效切换测试环境成为许多测试开发人员关注的重点。你是否希望在运行测试用例时，能够动态选择测试环境，而不是繁琐地手动修改配置？

Pytest 测试框架的 hook 函数可以轻松实现这一需求！ 本文将带你详细了解如何借助 pytest 的强大功能，实现测试环境的动态切换。

在自动化测试过程中，有时候我们需要切换不同的测试环境用于验证功能是否正常（比如在测试环境中功能是正常的，但是到了预发布环境中就出现了问题）。往往我们需要手动修改测试脚本中的配置适配在不同的环境执行，十分不优雅！

如果能在执行测试脚本之前指定对应环境进行自动化配置那就不需要手动一个个修改配置了，比如像pytest执行时可以通过传入丰富的内置命令行参数改变其测试行为。同样pytest也能支持自定义命令行参数，通过对应的参数选取对应的环境配置进行执行，实现这一需求可以通过pytest的hook函数。

Pytest 是 Python 社区最受欢迎的测试框架之一，其灵活的插件机制和丰富的 hook 函数，让开发者能够根据需求自定义测试行为。在动态切换测试环境的场景中，以下思路和方法非常实用：

1. 使用 pytest 的 `pytest_addoption` 添加命令行参数

通过为 pytest 添加命令行参数，我们可以实现环境配置的动态传递。

实现步骤：

在 conftest.py 文件中，定义一个选项用于传递环境信息。

def pytest_addoption(parser):
    parser.addoption(
        "--env", action="store", default="dev", help="Specify test environment: dev/staging/prod"
    )

关于pytest hook函数

Hook函数（钩子函数），它是pytest框架的开发者为了让用户更好的去扩展pytest的功能而预留的一些函数。而预留的这些函数在整个测试执行的生命周期中特定的阶段会被pytest自动调用执行。

关于pytest中的预留钩子，可以通过开发插件，和在conftest.py去实现这些钩子。pytest中的钩子函数按功能一共分为6类：引导钩子，初始化钩子、用例收集钩子、用例执行钩子、报告钩子、调试钩子，当然动态切换测试环境这个需求我们不需要熟悉所有的钩子函数，这里我们只需要知道pytest_addoption这个初始化钩子函数即可：

函数

pytest_addoption

参数

parser ：参数解析器
pluginmanager ：插件管理器

触发时机：

conftest文件加载完之后执行，在测试运行开始时调用一次。

作用：

添加运行命令的命令行参数，pytest.ini的配置参数

实现步骤

1：新增`conftest.py`文件，添加`pytest_addoption`钩子函数

def pytest_addoption(parser):
    """
    注册自定义参数命令行参数
    """
    parser.addoption("--env", default="test", choices=['dev', 'test', 'pre'],
                     help="命令行参数 '--env' 设置环境切换")

参数说明：

--env 代表需要传入 --env 参数，后续通过pytest --env=test 或者 pytest --env test去运行
default 代表默认值，不传--env参数的情况下默认使用test环境
choices 设置参数范围，仅限于dev、test、pre这三个环境
help 代表命令行参数的帮助信息

需要注意：钩子函数名字是固定的，不能随意更改

2：定义fixture函数，用于获取命令行参数

@pytest.fixture(scope='session')
def get_env(request):
    option = request.config.getoption("--env")
    if option == 'test':
        print("当前环境为测试环境")
    elif option == "dev":
        print("当前环境为开发环境")
    elif option == "pre":
        print("当前环境为预发布环境")

3：在测试函数上使用fixture

我们可以看到通过--env参数可以切换不同的环境执行，不加参数的情况下使用的是test环境。

4：fixture函数解析不同的配置

上述的步骤能够完成基本的命令行参数解析，但是离动态切换环境还差一步：我们需要通过不同的参数读取对应的配置文件，将配置文件信息解析出来传递给测试用例使用。

在项目的config目录下保存项目的不同环境配置文件：dev-env.ini、test-env.ini、pre-env.ini。文件中存储不同的环境参数值（比如URL、账号信息、数据库配置信息等），如下所示：

[host]
baseurl = http://192.168.3.200:8080

[account]
username = admin
password = 123456abc

[dbinfo]
url = http://db.192.168.3.100:8081
port = 3306
username = root
password = 123456abc

[host] baseurl = http://test.lemonban.com [account] username = lemon_auto password = lemon123456 [dbinfo] url = http://db.lemonban.com port = 3306 username = student password = 123456a