pytest测试之conftest详解

一、概述
  Conftest是一个Python测试框架，它是pytest的一个组件，用于配置测试环境和参数。通过Conftest，我们可以创建一个可复用的测试配置文件，以便在多个测试模块之间共享配置信息。Conftest非常适合用于管理大型项目中的测试环境，可以提高测试的可维护性和可读性。
二、安装与使用

1. 安装Conftest
   要使用Conftest，首先需要安装pytest和Conftest。可以使用pip命令安装：

pip install pytest
1

2. 创建Conftest文件
   在项目根目录下创建一个名为conftest.py的文件，用于存放测试配置。也可以在子目录中创建conftest.py文件，以区分不同环境的配置。
3. 编写测试用例
   在项目中创建一个测试文件，例如test_module.py，然后编写测试用例。在运行测试之前，先运行pytest命令，它会自动识别并执行conftest.py文件中的配置。
4. 使用Conftest配置
   在conftest.py文件中，可以定义函数、类和变量，以供测试用例中使用。这些配置可以通过参数传递给测试用例，例如：

# conftest.py
def pytest_addoption(parser):
    parser.addoption("--url", help="API URL")
@pytest.fixture
def api_url():
    return pytest.config.getoption("--url")
1
2
3
4
5
6

在测试用例中，可以使用pytest.mark.parametrize装饰器来传递参数：

# test_module.py
import pytest
@pytest.mark.parametrize("url", [
    "http://api.example.com",
    "http://api2.example.com"
])
def test_api(url):
    print(f"Testing {url}")
1
2
3
4
5
6
7
8

运行测试时，可以通过命令行传入参数：

pytest --url=http://api.example.com
1

三、Conftest高级用法

1. 目录级Conftest
   在项目中有多个测试环境时，可以在不同目录下创建conftest.py文件，以区分测试环境。例如，在base目录下创建一个基础测试环境配置文件，然后在env1和env2目录下创建各自的测试环境配置文件。
2. 继承Conftest
   在conftest.py文件中，可以使用pytest_configure函数来修改测试配置。这个函数可以在测试会话开始时调用，也可以用来继承其他conftest.py文件的配置。例如：

# conftest.py
def pytest_configure(config):
    config.option.my_option = "value"
1
2
3

在另一个conftest.py文件中，可以使用pytest_configure函数来继承并修改配置：

# another_conftest.py
def pytest_configure(config):
    config.option.my_option = "new_value"
1
2
3

3. 使用文件作为参数
   在conftest.py文件中，可以使用pytest_addoption函数添加文件参数，并在测试用例中使用这个参数：

# conftest.py
def pytest_addoption(parser):
    parser.addoption("--input_file", help="Input file path")
@pytest.fixture
def input_file():
    return pytest.config.getoption("--input_file")
1
2
3
4
5
6

在测试用例中，可以使用input_file fixture：

# test_module.py
import pytest
def test_read_file(input_file):
    with open(input_file, "r") as f:
        content = f.read()
    print(content)
1
2
3
4
5
6

四、总结
  Conftest是一个强大的测试配置工具，可以帮助我们更好地管理大型项目中的测试环境。通过使用Conftest，我们可以创建可复用的测试配置，提高测试的可维护性和可读性。