如何解决Pytest Cov 报告缺少模拟异常返回
我是一名网络工程师,正在尝试编写一些 Python,所以每天仍在学习。我对单元测试和 Pytest 覆盖率报告有疑问。我想我理解单元测试和pytest的概念。
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 查找的套接字模拟。 Side Effect 似乎在嘲笑 Exception,我已经将 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
except socket.gaierror:
return False <<<<<<<< This is missing from the report
关于为什么没有将 False 的返回声明为覆盖的任何指针,我们将不胜感激。就像我上面说的,我对 Python 和编码很陌生,这是我关于 Stackoverflow 的第一个问题。希望我已经解释了我的问题,并为一些指导提供了足够的信息。
解决方法
当你声明时
mocker.patch.object(network_utils,'socket')
您正在用一个模拟替换整个 socket
模块,因此 socket
模块中的所有内容也变成了模拟,包括 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
只是一个例子;用您的实际导入替换它。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。