如何使用 pytest 在上下文管理器中测试操作

Question

我有一个数据库处理程序，它利用 SQLAlchemy ORM 与数据库进行通信。 作为 SQLAlchemy 推荐实践的一部分，我通过将其用作上下文管理器来与 session 进行交互。 我如何使用上下文管理器测试上下文管理器内部调用的 function 做了什么？

编辑：由于引入的复杂性，我意识到文件结构很重要。 我重新构建了下面的代码，以更接近地反映最终文件结构的样子，以及我环境中常见的生产回购的样子，代码在一个文件中定义并在一个完全独立的文件中进行测试。

例如：

代码文件（ delete_things_from_table.py ）：

from db_handler import delete, SomeTable


def delete_stuff(handler):
    stmt = delete(SomeTable)
    with handler.Session.begin() as session:
        session.execute(stmt)
        session.commit()

测试文件：

import pytest
import delete_things_from_table as dlt
from db_handler import Handler

def test_delete_stuff():
    handler = db_handler()
    dlt.delete_stuff(handler):

    # Test that session.execute was called
    # Test the value of 'stmt'
    # Test that session.commit was called

我不是在寻找特定于 SQLAlchemy 的解决方案； 我只是利用它来突出显示我想在上下文管理器中测试的内容，欢迎任何测试上下文管理器的策略。

Answer 1

沉睡之后，我想出了一个解决方案。 如果有任何可用的解决方案，我会喜欢额外的/不太复杂的解决方案，但这有效：

import pytest
import delete_things_from_table as dlt
from db_handler import Handler

class MockSession:
    def __init__(self):
        self.execute_params = []
        self.commit_called = False

    def execute(self, *args, **kwargs):
        self.execute_params.append(["call", args, kwargs])
        return self

    def commit(self):
        self.commit_called = True
        return self
    
    def begin(self):
        return self

    def __enter__(self):
        return self
    def __exit__(self, type, value, traceback):
        pass


def test_delete_stuff(monkeypatch):
    handler = db_handler()
    # Parens in 'MockSession' below are Important, pass an instance not the class
    monkeypatch.setattr(handler, Session, MockSession()) 
    dlt.delete_stuff(handler):

    # Test that session.execute was called
    assert len(handler.Session.execute_params)
    # Test the value of 'stmt'
    assert str(handler.Session.execute_params[0][1][0]) == "DELETE FROM some_table"
    # Test that session.commit was called
    assert handler.Session.commit_called

需要注意的一些关键事项：

1. 我创建了一个 static 模拟而不是 MagicMock，因为使用自定义模拟 class 更容易控制方法/数据流
2. 由于 SQLAlchemy session 上下文管理器需要一个begin()来启动上下文，因此我的模拟 class 需要一个开始。 在begin中返回self允许我们稍后测试这些值。
3. 上下文管理器依赖于魔术方法__enter__和__exit__以及您在上面看到的参数签名。
4. 模拟的 class 包含改变实例变量的模拟方法，允许我们稍后测试
5. 这依赖于 monkeypatch（我确定还有其他方法），但需要注意的重要一点是，当您传递模拟 class 时，您想要修补 class 的实例而不是 class 本身。 括号使世界变得不同。

我认为这不是一个优雅的解决方案，但它确实有效。 我很乐意接受任何改进建议。