Overview
pytest_configure是一个钩子函数，用于在pytest配置和插件初始化完成后立即调用。这个钩子函数通常用于执行全局初始化操作，如设置插件的全局配置、初始化日志记录、设置环境变量等。它允许你在测试运行开始之前执行必要的配置和准备工作。
使用场景
-
插件初始化：配置和初始化插件的全局状态和资源
-
全局配置：设置全局变量、环境变量或其他需要在测试开始前设置的信息
-
日志记录：初始化全局的日志记录配置
-
动态配置：根据命令行参数或配置文件动态调整
pytest的行为 -
注入默认
fixture：配置全局的fixture和测试前初始化工作
参数
-
config：这是一个
pytest.Config对象，代表了pytest的配置信息，包含了命令行参数、ini文件配置等所有pytest配置信息。
示例代码
以下是一个使用pytest_configure的示例代码，展示如何在测试开始之前进行全局配置和初始化：
初始化日志记录和设置全局变量
# conftest.py
import pytest
import logging
def pytest_addoption(parser):
parser.addoption(
"--env", action="store", default="dev",
help="Environment to run tests against: dev/staging/prod"
)
def pytest_configure(config):
# 初始化日志记录
logging.basicConfig(level=logging.INFO)
logging.info("Starting tests with pytest")
# 设置全局变量
config.env = config.getoption("--env")
logging.info(f"Running tests in environment: {config.env}")
在测试中访问这些配置
# test_example.py
import pytest
import logging
def test_environment(pytestconfig):
env = pytestconfig.env
logging.info(f"Test running in environment: {env}")
assert env in ["dev", "staging", "prod"]
说明:
-
conftest.py：在conftest.py文件中，首先使用pytest_addoption钩子添加一个命令行选项--env，用于指定测试运行的环境。然后在pytest_configure中初始化日志记录，并设置一个全局变量env。 -
test_example.py：在测试用例文件test_example.py中，使用pytestconfig对象来访问在pytest_configure中设置的全局变量env。
运行示例
为了测试不同环境，可以在运行 pytest 时传递 --env 参数：
pytest --env="staging"
你应该会在控制台中看到类似以下的日志输出：
root@Gavin:~/test/hook# pytest --env="staging"
INFO:root:Starting tests with pytest
INFO:root:Running tests in environment: staging
================================================================================================================== test session starts ===================================================================================================================
platform linux -- Python 3.11.6, pytest-8.0.2, pluggy-1.5.0
Test order randomisation NOT enabled. Enable with --random-order or --random-order-bucket=<bucket_type>
sensitiveurl: .*
rootdir: /root/test/hook
plugins: cov-4.1.0, order-1.2.0, random-order-1.1.1, tornasync-0.6.0.post2, check-2.2.2, instafail-0.5.0, allure-pytest-2.13.2, asyncio-0.23.6, selenium-4.1.0, xdist-3.5.0, variables-3.1.0, rerunfailures-13.0, html-4.1.1, progress-1.2.5, metadata-3.0.0, twisted-1.14.1, picked-0.5.0, anyio-4.3.0, Faker-24.0.0, trio-0.8.0, repeat-0.9.3, base-url-2.1.0, dependency-0.6.0, dotenv-0.5.2, timeout-2.2.0
asyncio: mode=Mode.STRICT
collected 1 item
test_example.py . [100%]
=================================================================================================================== 1 passed in 0.03s ====================================================================================================================
root@Gavin:~/test/hook#
总结
通过pytest_configure钩子，你可以在pytest初始化完配置和插件后，开始测试运行之前进行任何必要的配置和初始化工作。这个钩子函数非常适合用于插件初始化、全局变量设置、日志记录配置以及根据命令行参数动态调整测试行为等场景。利用这个钩子，可以让你的测试框架更加灵活和强大，适应各种不同的测试需求。
