Python单元测试：如何Mock flask.current_app以测试失败场景

问题描述 #

我在Flask应用的健康检查API中实现了如下方法：

from flask import current_app

class Healthcheck():
    @classmethod
    def check_running(cls):
        if(current_app):
            return True, "OK"
        else:
            return False, "Fail"

尝试对失败场景编写单元测试时遇到问题，现有测试代码：

def testRunningCheck_pass(self, flask_test_client):
    result = Healthcheck.check_running()
    assert result[0] == True, "Unexpected check result"
    assert result[1] == "OK", "Unexpected check message"

@patch("flask.current_app")
def testRunningCheck_fail(self, flask_test_client):
    result = Healthcheck.check_running()
    assert result[0] == False, "Unexpected check result"
    assert result[1] == "Fail", "Unexpected check message"

testRunningCheck_pass测试通过，但testRunningCheck_fail抛出错误：

./tests/test_healthcheck.py::TestHealthcheck::testRunningCheck_fail Failed: [undefined]RuntimeError: Working outside of application context.

This typically means that you attempted to use functionality that needed
to interface with the current application object in some way. To solve
this, set up an application context with app.app_context().  See the
documentation for more information.
args = (<tests.test_healthcheck.TestHealthcheck object at 0x110af3b50>,)
keywargs = {}

    @wraps(func)
    def patched(*args, **keywargs):
>       with self.decoration_helper(patched,
                                    args,
                                    keywargs) as (newargs, newkeywargs)

需要解决的问题：能否通过Mock flask.current_app 控制其状态，完成失败场景的测试？

解决方案 #

可以通过正确Mock目标对象来实现失败场景的测试，问题出在Mock路径和测试逻辑上，调整步骤如下：

1. 修正Mock路径
   必须Mock被测试代码所在模块中导入的current_app，而非flask.current_app本身。例如，如果Healthcheck类在your_app.health模块中，就需要Mockyour_app.health.current_app，这样才能覆盖被测试代码中实际使用的代理对象。

2. 调整测试逻辑
   失败场景测试不需要flask_test_client（我们要模拟无应用上下文的状态），同时要让Mock的current_app在布尔判断时返回False，贴合代码中if(current_app)的判断逻辑。

修改后的测试代码示例：

from unittest.mock import patch
from your_app.health import Healthcheck  # 替换为实际的导入路径

class TestHealthcheck:
    def testRunningCheck_pass(self, flask_test_client):
        result = Healthcheck.check_running()
        assert result[0] is True
        assert result[1] == "OK"

    @patch("your_app.health.current_app")  # 替换为Healthcheck所在模块的current_app路径
    def testRunningCheck_fail(self, mock_current_app):
        # 模拟current_app的布尔判断返回False
        mock_current_app.__bool__.return_value = False
        result = Healthcheck.check_running()
        assert result[0] is False
        assert result[1] == "Fail"

错误原因说明 #

之前的测试报错是因为current_app是Flask的代理对象，即使Mock了flask.current_app，被测试模块中导入的实例在无应用上下文时访问依然会触发RuntimeError。只有Mock被测试模块内的current_app实例，才能覆盖其布尔判断行为，避免上下文错误并模拟失败场景。

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