Pytest Cov报告缺少模拟异常返回

Question

我是一名网络工程师，正在尝试编写一些Python，所以每天都在学习。我对单元测试和Pytest覆盖率报告有一个问题。我想我理解单元测试和pytest的概念。

我有一个使用套接字进行DNS查找的函数

def get_ip(d):
"""Returns the first IPv4 address that resolves from 'd'
Args:
d (string): string that needs to be resolved in DNS.
Returns:
string: IPv4 address if found
"""
logger.info("Returns IP address from hostname: " + d)
try:
data = socket.gethostbyname(d)
ip_addr = repr(data).strip("'")
logger.debug("IP Address Resolved to: " + ip_addr)
return ip_addr
except socket.gaierror:
return False

我写了一个单元测试，通过得很好。我使用pytest-mock来处理DNS查找套接字的模拟。副作用似乎在嘲笑异常，我已经将return_value设置为False，并且我假设我已经断言返回了False，测试通过了，这就是为什么我假设我的测试是可以的。

import pytest
import pytest_mock
import socket
from utils import network_utils
@pytest.fixture
def test_setup_network_utils():
return network_utils
def test_get_ip__unhappy(mocker, test_setup_network_utils):
mocker.patch.object(network_utils, 'socket')
test_setup_network_utils.socket.gethostbyname.side_effect = socket.gaierror
with pytest.raises(Exception):
d = 'xxxxxx'
test_setup_network_utils.socket.gethostbyname.return_value = False
test_setup_network_utils.get_ip(d)
assert not test_setup_network_utils.socket.gethostbyname.return_value
test_setup_network_utils.socket.gethostbyname.assert_called_once()
test_setup_network_utils.socket.gethostbyname.assert_called_with(d)

pytest cov报告显示返回的False行未被覆盖。

pytest --cov-report term-missing:skip-covered --cov=utils unit_tests
network_utils.py     126      7    94%   69

第69行是功能中代码的下一行

except socket.gaierror:
return False <<<<<<<< This is missing from the report

任何关于为什么False的返回没有被声明为已覆盖的指针都将不胜感激。就像我上面说的，我对Python和编码还很陌生，这是我关于Stackoverflow的第一个问题。希望我已经解释了我的问题，并为一些指导提供了足够的信息。

Answer 1

当您声明时

mocker.patch.object(network_utils, 'socket')

您将用一个mock替换整个socket模块，因此socket模块中的所有内容也将变为mock，包括socket.gaierror。因此，当在运行测试时试图捕获socket.gaierror时，Python会抱怨它不是异常(不是BaseException的子类(并失败。因此，不执行所需的回流管线。

总的来说，您的测试看起来过于工程化了，并且包含了很多不必要的代码。你需要test_setup_network_utils干什么？为什么在测试中捕获任意异常？一个重新访问的test_get_ip__unhappy，它涵盖了gaierror情况下的完整代码：

def test_get_ip__unhappy(mocker):
# test setup: patch socket.gethostbyname so it always raises
mocker.patch('spam.socket.gethostbyname')
spam.socket.gethostbyname.side_effect = socket.gaierror
# run test
d = 'xxxxxx'
result = spam.get_ip(d)
# perform checks
assert result is False
spam.socket.gethostbyname.assert_called_once()
spam.socket.gethostbyname.assert_called_with(d)

当然，spam只是一个例子；将其替换为实际导入。