FastAPI单元测试：业务逻辑测试

欢迎来到FastAPI学习教程的这一单元！我们将深入探讨业务逻辑单元测试，这是确保API功能正确性的关键步骤。本教程针对新人设计，力求简单易懂，并附带代码示例。

什么是单元测试和业务逻辑测试？

• 单元测试：测试代码的最小单元（如函数或方法），以验证其行为是否符合预期。
• 业务逻辑测试：专注于测试应用程序的业务规则和逻辑，而不是外部依赖（如数据库或网络）。在FastAPI中，这通常涉及API端点背后的数据处理和验证。

为什么重要？单元测试帮助您及早发现错误，提高代码质量，并使代码重构更安全。业务逻辑测试确保您的应用逻辑正确，用户数据得到正确处理。

设置FastAPI测试环境

在开始之前，确保已安装FastAPI和相关工具。我们将使用pytest作为测试框架，以及httpx或requests作为测试客户端。

1. 安装依赖：如果您还没有安装，可以通过pip安装：

   pip install fastapi pytest httpx
   

2. 创建项目结构：建议将测试代码放在单独的文件夹中，例如tests/。

3. 配置pytest：在根目录创建一个pytest.ini文件（可选），但默认配置通常足够。

测试业务逻辑的步骤

在FastAPI中，业务逻辑测试通常围绕API端点进行。以下是一般步骤：

1. 导入依赖：导入FastAPI、测试客户端和您的应用模块。
2. 创建测试客户端：使用FastAPI的TestClient来模拟HTTP请求。
3. 编写测试用例：针对每个端点，测试不同的输入场景，如有效数据、无效数据或边界情况。
4. 断言结果：检查HTTP状态码、响应数据和错误处理。
5. 模拟外部依赖：对于数据库或其他外部服务，使用模拟（mocking）来隔离业务逻辑。

代码示例：测试一个简单的FastAPI应用

让我们通过一个示例来具体化。假设我们有一个简单的FastAPI应用，处理用户注册。

应用代码 (main.py)：

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class UserCreate(BaseModel):
    username: str
    email: str
    age: int

@app.post("/register/")
async def create_user(user: UserCreate):
    # 业务逻辑：验证年龄必须大于等于18岁
    if user.age < 18:
        return {"error": "User must be at least 18 years old"}
    # 模拟保存用户到数据库
    return {"message": "User registered successfully", "user": user.dict()}

测试代码 (test_business_logic.py)：

import pytest
from fastapi.testclient import TestClient
from main import app  # 导入您的FastAPI应用

client = TestClient(app)

def test_create_user_success():
    """测试成功创建用户：年龄大于等于18岁"""
    response = client.post("/register/", json={"username": "john_doe", "email": "john@example.com", "age": 25})
    assert response.status_code == 200
    assert response.json()["message"] == "User registered successfully"


def test_create_user_failure():
    """测试创建用户失败：年龄小于18岁"""
    response = client.post("/register/", json={"username": "jane_doe", "email": "jane@example.com", "age": 16})
    assert response.status_code == 200  # FastAPI默认返回200，但我们可以检查错误消息
    assert response.json()["error"] == "User must be at least 18 years old"


def test_invalid_data():
    """测试无效数据：例如缺少必填字段"""
    response = client.post("/register/", json={"username": "test", "age": 20})  # 缺少email
    assert response.status_code == 422  # FastAPI使用422状态码表示验证错误
    assert "detail" in response.json()  # 检查错误详情

运行测试： 在终端中运行pytest test_business_logic.py，确保所有测试通过。

常见问题解答

• 如何处理数据库测试？ 使用测试数据库或模拟数据库操作。例如，可以设置一个测试数据库或使用库如unittest.mock来模拟数据库调用。
• 测试应该覆盖哪些方面？ 覆盖正常场景、错误场景和边界情况。例如，测试输入验证、业务规则和响应格式。
• 如何提高测试效率？ 保持测试独立和快速，避免外部依赖，并定期运行测试。

总结

通过本教程，您学习了如何在FastAPI中编写业务逻辑单元测试。关键点包括设置测试环境、编写针对API端点的测试用例，以及使用断言和模拟来处理各种场景。实践这些技能将帮助您构建更健壮的FastAPI应用。

继续学习FastAPI的其他单元，如集成测试或异步测试，以全面掌握测试策略。如有疑问，请参考官方文档或社区资源。祝您学习愉快！