pytest-recording 0.13.2

默认记录模式

pytest-recording 默认使用 none VCR 录制模式以防止意外网络请求。要允许它们，您需要通过 --record-mode 命令行选项将不同的录制模式（例如 once）传递给测试命令。有关可用的录制模式的更多信息，请参阅官方 VCR 文档

配置

您可以使用 vcr_config 固定装置提供录制配置，其范围可以是任何范围 - session、package、module 或 function。它应该返回一个字典，该字典将直接传递给底层的 VCR.use_cassettes。

import pytest

@pytest.fixture(scope="module")
def vcr_config():
    return {"filter_headers": ["authorization"]}

为了更细粒度的控制，您需要将这些关键字参数传递给单个 pytest.mark.vcr 标记，在这种情况下，所有参数将合并成一个具有以下优先级的单个字典（从低到高）

• vcr_config 固定装置

• 从最广泛的范围（“session”）到最狭窄的范围（“function”）的所有标记

示例

import pytest

pytestmark = [pytest.mark.vcr(ignore_localhost=True)]

@pytest.fixture(scope="module")
def vcr_config():
    return {"filter_headers": ["authorization"]}

@pytest.mark.vcr(filter_headers=[])
def test_one():
    ...

@pytest.mark.vcr(filter_query_parameters=["api_key"])
def test_two():
    ...

每个测试的结果 VCR 配置

• test_one - {"ignore_localhost": True, "filter_headers": []}

• test_two - {"ignore_localhost": True, "filter_headers": ["authorization"], "filter_query_parameters": ["api_key"]}

您可以通过 pytest_recording_configure 钩子获取访问使用的 VCR 实例。这可能会对注册自定义匹配器、持久化程序等非常有用。

# conftest.py

def jurassic_matcher(r1, r2):
    assert r1.uri == r2.uri and "JURASSIC PARK" in r1.body, \
        "required string (JURASSIC PARK) not found in request body"

def pytest_recording_configure(config, vcr):
    vcr.register_matcher("jurassic", jurassic_matcher)

您可以通过传递 --disable-recording 命令行选项来完全禁用 VCR.py 集成。

重写录制模式

您可以从头重新编写磁带，而不是像现在使用 VCR.py 的 all 录制模式那样扩展它。

但是，它只会重写默认磁带，而不会触摸额外磁带。

import pytest

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

或者通过命令行选项

$ pytest --record-mode=rewrite tests/

阻止网络访问

要更有信心确保测试不会通过网络进行，您可以使用 pytest.mark.block_network 标记来阻止它

import pytest
import requests

@pytest.mark.block_network
def test_multiple():
    assert requests.get("http://httpbin.org/get").text == '{"get": true}'

...
# in case of access
RuntimeError: Network is disabled

除了标记之外，可以使用 --block-network 命令行选项全局阻止网络访问。

但是，如果启用了 VCR.py 录制，则带有 pytest.mark.vcr 的测试不会阻止网络。

示例

import pytest
import requests

@pytest.mark.vcr
def test_multiple():
    assert requests.get("http://httpbin.org/get").text == '{"get": true}'

运行 pytest

$ pytest --record-mode=once --block-network tests/

网络阻塞功能支持基于 socket 的传输和 pycurl。

您可以在网络阻塞期间允许访问特定的主机

import pytest
import requests

@pytest.mark.block_network(allowed_hosts=["httpbin.*"])
def test_access():
    assert requests.get("http://httpbin.org/get").text == '{"get": true}'
    with pytest.raises(RuntimeError, match=r"^Network is disabled$"):
        requests.get("http://example.com")

或者通过命令行选项

$ pytest --record-mode=once --block-network --allowed-hosts=httpbin.*,localhost tests/

或者通过 vcr_config 固定装置

import pytest

@pytest.fixture(autouse=True)
def vcr_config():
    return {"allowed_hosts": ["httpbin.*"]}