Pytest-recording插件使用手册

Pytest-recording插件使用手册

1. 项目介绍

Pytest-recording 是一个专为 pytest 设计的插件，它通过集成 VCR.py 实现了在测试过程中记录网络交互的功能。这允许开发者在进行单元测试时模拟网络请求，从而确保测试的可重复性和独立性。通过保存实际的HTTP交互到“磁带”（cassettes），这个工具极大地简化了对网络依赖的应用的测试流程。

2. 项目快速启动

安装

首先，通过pip安装pytest-recording插件，注意不要同时安装pytest-vcr以避免兼容性问题：

pip install pytest-recording

使用示例

在您的测试文件中，利用 @pytest.mark.vcr 装饰器来标记那些需要记录或播放网络交互的测试方法。

import pytest
import requests

# 自动创建或重放对应的 cassette
@pytest.mark.vcr()
def test_single():
    response = requests.get('http://httpbin.org/get')
    assert response.text == '["get": true]'

运行测试时，通过命令行指定录制模式，例如首次运行时设置为记录模式：

pytest --record-mode=once test_your_file.py

后续测试可以复用已记录的数据，避免真实网络调用：

pytest test_your_file.py

3. 应用案例和最佳实践

复合Cassette使用

为了更灵活地控制测试数据，您可以为不同的测试场景分配不同的磁带，并能通过路径直接指定使用哪一个磁带。

@pytest.mark.vcr("/path/to/custom.yaml")
def test_with_custom_cassette():
    ...

阻止网络访问

增强测试隔离性，可以通过 @pytest.mark.block_network 确保测试不会意外触发外部网络请求。

@pytest.mark.block_network
def test_no_real_network_access():
    ...

重写磁带记录

若需从头重写磁带而不是追加，可以在配置或命令行指定 record_mode 为 rewrite。

@pytest.fixture(scope="module")
def vcr_config():
    return {"record_mode": "rewrite"}

# 或者命令行方式：
pytest --record-mode=rewrite

4. 典型生态项目结合

虽然本项目本身就是围绕pytest生态构建，没有特定指出与其它“典型生态项目”的直接组合，但在Python测试环境中，pytest-recording常与其他pytest的插件一起使用，如pytest-cov用于覆盖率分析，或者与持续集成服务如GitLab CI、Jenkins等结合，自动化测试执行和报告生成。此外，与版本控制系统（如Git）配合使用，保证每次提交都经过充分测试，并且测试数据的变化能够得到恰当管理。

通过上述步骤和实践，您能有效地使用pytest-recording来提升测试效率和质量，特别是在处理对外部API依赖的测试场景中。