FastAPI API密钥授权pytest测试用例失败求助

核心问题 #

你的测试用例始终返回200，根本原因是测试中覆盖的get_api_key依赖，并没有被/queueFetch端点实际调用。从你贴出的端点代码来看，端点直接依赖Security(api_key_header)（即APIKeyHeader实例），而非测试里写的get_api_key函数——这导致测试时完全跳过了你自定义的密钥验证逻辑，自然无论密钥是否正确都返回200。

解决方案 #

方案1：统一端点与测试的依赖逻辑（推荐）

修改端点代码，让它使用自定义的get_api_key依赖函数，这样测试中的覆盖才能准确生效：

# Security setup
from fastapi import Security, APIKeyHeader, HTTPException

api_key_header = APIKeyHeader(name="X-API-Key", auto_error=True)
MEMA4_API_KEY = "your_actual_production_key"

# 定义统一的API密钥验证依赖
def get_api_key(api_key: str = Security(api_key_header)):
    if api_key == MEMA4_API_KEY:
        return api_key
    raise HTTPException(status_code=403, detail="Invalid API Key")

@app.get(
    "/queueFetch",
    response_model=QueueItemsResponse,
    responses={
        200: {"description": "Successfully retrieved queue items"},
        403: {"description": "Invalid API Key"},
        503: {"description": "Service unavailable, queue is down"},
    },
    dependencies=[Security(get_api_key)],  # 改为依赖get_api_key函数
)
def queue_fetch():
    # 你的端点业务逻辑
    return {"queue_items": []}

修改后，测试中对get_api_key的覆盖会直接作用于端点的验证逻辑，403场景的验证就能正常触发。

方案2：不修改端点，直接覆盖APIKeyHeader逻辑

如果不想改动现有端点代码，可以在测试中直接模拟APIKeyHeader的验证行为：

# 修改测试中的override fixture
@pytest.fixture(scope="function", autouse=True)
def override_api_key_header():
    # 模拟APIKeyHeader的验证逻辑
    def mock_api_key_header(api_key: str = Header(None, alias="X-API-Key")):
        if not api_key or api_key != MEMA4_API_KEY:
            raise HTTPException(status_code=403, detail="Invalid API Key")
        return api_key

    # 覆盖端点中使用的api_key_header实例
    app.dependency_overrides[api_key_header] = mock_api_key_header
    try:
        yield
    finally:
        del app.dependency_overrides[api_key_header]

额外排查点 #

• 确认测试中使用的app与实际运行的app是同一个实例，避免因导入错误导致端点未加载依赖。
• 在测试函数中添加打印语句，检查依赖覆盖是否生效：

  def test_api_key_scenarios(mock_redis_client, api_key, expected_status):
      print("当前依赖覆盖:", app.dependency_overrides)  # 验证get_api_key或api_key_header是否被覆盖
      # ... 其余测试代码
  

• 检查测试环境中MEMA4_API_KEY的取值是否与生产环境一致，避免环境变量差异导致验证逻辑异常。

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