Pact测试可空字段时跨测试用例状态未更新问题排查

核心原因 #

即使将Pact fixture的作用域改为function，仍可能因为以下原因导致状态未正确重置：

• Fixture未执行完整清理：Pact的mock server不会自动在测试结束后清除已注册的交互，若未显式调用清理方法，前一个测试的契约预期会残留。
• 交互标识重复：两个测试使用了相同的交互描述/标识，Pact会复用旧的契约规则，而非重新注册适配null值的新交互。
• 契约定义未兼容可空值：第一个测试的契约中未将key字段标记为可空，残留的契约仍强制要求字符串类型。

具体解决步骤 #

1. 完善Fixture的销毁逻辑 #

在conftest.py的Pact fixture中，添加测试后清理逻辑，确保每个测试结束后清除交互并终止mock server：

import pytest
from pact import Consumer, Provider

@pytest.fixture(scope="function")
def pact():
    pact_instance = Consumer("MyConsumer").has_pact_with(Provider("MyProvider"))
    pact_instance.start_service()
    yield pact_instance
    # 强制清理交互并停止服务
    pact_instance.clear_interactions()
    pact_instance.stop_service()

2. 为每个测试定义独立交互 #

确保两个测试的交互描述完全唯一，避免Pact复用旧预期：

• 带字符串值的测试：

def test_post_1(pact):
    pact.given("valid string key exists") \
        .upon_receiving("post request with non-null key") \
        .with_request("post", "/target-endpoint", body={"key": "test-content"}) \
        .will_respond_with(200)
    
    # 执行请求逻辑...
    pact.verify()

• 带null值的测试：

def test_post_2(pact):
    pact.given("key is null") \
        .upon_receiving("post request with null key") \
        .with_request("post", "/target-endpoint", body={"key": None}) \
        .will_respond_with(200)
    
    # 执行请求逻辑...
    pact.verify()

3. 修正契约的可空字段定义 #

在契约中明确标记key字段支持可空类型，兼容字符串和null：

from pact.matchers import Term

def test_post_2(pact):
    pact.given("key is null") \
        .upon_receiving("post request with null key") \
        .with_request(
            "post", 
            "/target-endpoint", 
            body={
                "key": Term(
                    matcher=r"^.*$|null",  # 匹配任意字符串或null
                    generate=None  # 生成null作为测试用例值
                )
            }
        ) \
        .will_respond_with(200)
    
    # 执行请求逻辑...
    pact.verify()

若使用的Pact版本支持Optional匹配器，可更简洁地定义：

from pact import Optional

body={
    "key": Optional(Like("test-content"))  # 字段可选，值可为字符串或null
}

4. 确保测试完全隔离 #

每个测试应独立初始化请求客户端，避免复用前一个测试的客户端实例导致状态残留。

内容的提问来源于stack exchange，提问作者Conor