FastAPI中如何为@app.on_event("shutdown")关闭事件编写单元测试

依赖准备 #

你需要提前安装测试所需的依赖：
pip install pytest fastapi httpx

测试代码实现 #

新建测试文件test_main.py，内容如下：

import os
from fastapi.testclient import TestClient
from main import app

TEST_FILE = "shutdown-test-file.txt"

def test_shutdown_handler():
    # 提前清理历史测试残留文件，避免影响测试结果
    if os.path.exists(TEST_FILE):
        os.remove(TEST_FILE)
    
    # 上下文管理器退出时会自动触发shutdown事件
    with TestClient(app):
        # 可在此处添加正常的接口请求逻辑，无相关需求也可以留空
        pass
    
    # 验证shutdown逻辑执行结果
    assert os.path.exists(TEST_FILE), "shutdown事件未触发，目标文件未生成"
    with open(TEST_FILE, "r", encoding="utf-8") as f:
        content = f.read()
    assert content == "FastAPI app has been terminated", "shutdown事件写入内容不符合预期"

    # 测试完成后清理文件，避免残留
    os.remove(TEST_FILE)

运行测试 #

直接在项目根目录的终端执行pytest命令即可：
pytest test_main.py -v

原理解释 #

• FastAPI的TestClient实现了上下文管理器协议，with块进入时会自动触发所有注册的startup事件，块退出时自动触发所有注册的shutdown事件，完全模拟应用真实的启停流程，测试结果和生产运行表现一致
• 如果你定义的是异步shutdown处理函数，只需要将TestClient替换为httpx.AsyncClient，使用async with语法管理上下文即可

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