使用简单的 unittest 模拟来修补 SMTP 调用

Question

我只是在学习 unittest Mocks 并试图了解为什么修补对“smtplib.SMTP”的调用不会返回在模拟对象上设置的值。我认为不是，因为断言失败了。

我对发送电子邮件的函数有一个简单的定义：

def send(sender, to, subject="None", body="None", server="localhost"):
    message = email.message.Message()
    message['To'] = to
    message['From'] = sender
    message['Subject'] = subject
    message.set_payload(body)

    server = smtplib.SMTP(server)
    try:
        server.sendmail(sender, to, message.as_string())
    finally:
        server.quit()

我有一个包含简单测试函数的单元测试文件：

def test_send():
    with patch('smtplib.SMTP') as mock:
        instance = mock.return_value
        instance.sendmail.return_value = {}
        res = send('x@gmail.com', 'y@gmail.com', 'subject', 'body')
        assert res == {}

据我了解，当调用 'smtplib.SMTP' 的 sendmail 时，该调用应由 mock 修补，并应返回一个空字典。所以 res 变量应该设置为 {}。

对文件执行 pytest 时，断言总是失败：

 assert None == {}

我有两个问题：

1. 我对单元测试的定义有问题吗？
2. 什么是调试此类问题的好方法。我尝试使用 --trace 选项运行 pytest，但在单步执行代码时无法捕捉到“修补”时刻。

Answer 1

这里：

res = send('x@gmail.com', 'y@gmail.com', 'subject', 'body')
assert res == {}

您期望send 会返回一个值，并且应该是{} 的模拟值。但是，您将实现定义为不返回任何内容

def send(sender, to, subject="None", body="None", server="localhost"):
    ...
    try:
        server.sendmail(sender, to, message.as_string())
    ...
    # Doesn't return anything

如果您想查看模拟值，那么您应该响应返回到 sendmail 的调用。

def send(sender, to, subject="None", body="None", server="localhost"):
    ...
    response = None
    try:
        response = server.sendmail(sender, to, message.as_string())
    ....
    return response

运行后我这边测试成功了。