如何使用 flask 和 pytest 测试端点异常？

Question

我有一个端点，它从我的数据库中返回一个列表。 如果在此过程中出现问题，我会返回一个 internal_server_error，其中包含 500 status_code 和一条消息作为参数。

def get_general_ranking():
    try:
        ranking_list = GamificationService.get_general_ranking()
        return basic_response(ranking_list, 200)
    except Exception as e:
        logging.error(str(e))
        cache.delete()
        return internal_server_error_response('Could not get ranking. Check log for reasons.')

我正在对此端点进行单元测试。 所以，现在，我有这个实现：

class TestGamificationController(unittest.TestCase):

    def setUp(self):
        """
        Function called when the class is initialized.
        """
        test_app = app.test_client()
        self.general_ranking = test_app.get('/v1/gamification/general_ranking')

    def test_endpoint_general_ranking(self):
        """
        Testing the endpoint '/v1/gamification/general_ranking'.
        """
        assert self.general_ranking.status_code == 200, "Wrong status code."
        assert len(self.general_ranking.json) > 0, "/v1/gamification/general_ranking is returning an empty list."
        assert self.general_ranking.content_type == 'application/json', "Wrong content_type"

但是，正如您在下面看到的，当我运行覆盖率测试以检查我是否覆盖了 100% 的代码时，我得到了 75%。 缺少的行是例外行。

---------- coverage: platform darwin, python 3.8.0-final-0 -----------
Name                                       Stmts   Miss  Cover   Missing
------------------------------------------------------------------------
api/controller/GamificationController.py      16      4    75%   18-21

缺失的行：

    except Exception as e:
        logging.error(str(e))
        cache.delete()
        return internal_server_error_response('Could not get ranking. Check log for reasons.')

我怎样才能使用 pytest 来覆盖这个异常？ 还是我应该使用其他东西？

Answer 1

我看到了三个可能的解决方法：

1. 在您的应用程序中创建一个仅引发所述异常的自定义路由。
2. 当您开始测试时，以编程方式在您的应用程序中添加此自定义路由。
3. 将您的全局错误处理程序 function 移动到它自己的文件中，并从您的覆盖范围中忽略它。

现在个人 1 是最简单的，只需应用一个调试/开发环境检查，如果它关闭，它只会抛出一个找不到路由的错误。

如果您使用AssertionError应用程序工厂生成应用程序并在测试执行中生成自定义路由，则 2 是可行的在收到第一个请求后。 当您在conftest.py上实例化您的应用程序时，通常会出现这种情况。

3 我觉得有点作弊。

希望你能解决这个问题。 想知道你是如何解决这个问题的。

更新：我发现这样做的最好方法是使用在任何测试之前运行的pytest的 sessionstart 钩子。 我用它来初始化自定义错误端点。 这种方法效果最好，因为您不必使用特定于测试的逻辑污染代码库。