使用argparse进行pytest:如何测试提示用户确认?

Question

我有一个 CLI 工具，想测试是否提示用户使用input()确认选择。这相当于在Python 2中使用raw_input()。

法典

要测试的(释义)代码如下所示：

import sys
import argparse

def confirm():
notification_str = "Please respond with 'y' or 'n'"
while True:
choice = input("Confirm [Y/n]?").lower()
if choice in 'yes' or not choice:
return True
if choice in 'no':
return False
print(notification_str)

def parse_args(args):
parser = argparse.ArgumentParser()
parser.add_argument('-d', '--destructive', action='store_true')
return parser.parse_args()

def main():
args = parse_args(sys.argv[1:])
if args.destructive:
if not confirm():
sys.exit()
do_stuff(args)

if __name__ == '__main__':
main()

问题

我正在使用pytest作为我的框架。如何测试确认提示是否显示在 CLI 中？如果我尝试比较stdout，则会出现错误：OSError: reading from stdin while output is captured.

我想确保：

1. 设置破坏性标志时显示确认
2. 当它不显示时，它不会显示

我将在另一个文件中使用以下代码：

import pytest
from module_name import main

def test_user_is_prompted_when_destructive_flag_is_set():
sys.argv['', '-d']
main()
assert _  # What the hell goes here?

def test_user_is_not_prompted_when_destructive_flag_not_set():
sys.argv['',]
main()
assert _  # And here too?

Answer 1

我建议使用confirm()函数开始测试是一种更好的单元测试策略。这使得像input和sys.stdio这样的东西可以在本地被嘲笑。 然后，一旦保证确认按预期工作，就可以编写测试来验证它是否以特定方式调用。您可以为此编写测试，并在这些测试期间模拟confirm()。

下面是使用pytest.parametrize和mock来处理用户输入和输出的confirm()单元测试：

法典：

@pytest.mark.parametrize("from_user, response, output", [
(['x', 'x', 'No'], False, "Please respond with 'y' or 'n'n" * 2),
('y', True, ''),
('n', False, ''),
(['x', 'y'], True, "Please respond with 'y' or 'n'n"),
])
def test_get_from_user(from_user, response, output):
from_user = list(from_user) if isinstance(from_user, list) else [from_user]
with mock.patch.object(builtins, 'input', lambda x: from_user.pop(0)):
with mock.patch('sys.stdout', new_callable=StringIO):
assert response == confirm()
assert output == sys.stdout.getvalue()

这是如何工作的？

pytest.mark.parametrize允许在条件下轻松调用测试函数的多个时间。 以下是 4 个简单的步骤，它们将测试confirm中的大多数功能：

@pytest.mark.parametrize("from_user, response, output", [
(['x', 'x', 'No'], False, "Please respond with 'y' or 'n'n" * 2),
('y', True, ''),
('n', False, ''),
(['x', 'y'], True, "Please respond with 'y' or 'n'n"),
])

mock.patch可用于临时替换模块中的功能(以及其他用途)。 在这种情况下，它用于替换input和sys.stdout以允许注入用户输入并捕获打印的字符串

with mock.patch.object(builtins, 'input', lambda x: from_user.pop(0)):
with mock.patch('sys.stdout', new_callable=StringIO):

最后运行被测函数，并验证函数的输出和打印的任何字符串：

assert response == confirm()
assert output == sys.stdout.getvalue()

测试代码

(用于测试代码)：

import sys
from io import StringIO
import pytest
from unittest import mock
import builtins
def confirm():
notification_str = "Please respond with 'y' or 'n'"
while True:
choice = input("Confirm [Y/n]?").lower()
if choice in 'yes' or not choice:
return True
if choice in 'no':
return False
print(notification_str)
@pytest.mark.parametrize("from_user, response, output", [
(['x', 'x', 'No'], False, "Please respond with 'y' or 'n'n" * 2),
('y', True, ''),
('n', False, ''),
(['x', 'y'], True, "Please respond with 'y' or 'n'n"),
])
def test_get_from_user(from_user, response, output):
from_user = list(from_user) if isinstance(from_user, list) 
else [from_user]
with mock.patch.object(builtins, 'input', lambda x: from_user.pop(0)):
with mock.patch('sys.stdout', new_callable=StringIO):
assert response == confirm()
assert output == sys.stdout.getvalue()
pytest.main('-x test.py'.split())

结果：

============================= test session starts =============================
platform win32 -- Python 3.6.3, pytest-3.3.2, py-1.5.2, pluggy-0.6.0
rootdir: C:UsersstephenDocumentssrctestcode, inifile:
collected 4 items
test.py ....                                                             [100%]
========================== 4 passed in 0.15 seconds ===========================

测试调用confirm()：

要测试确认在预期时调用，以及程序在调用时是否按预期响应，您可以使用unittest.mock来模拟confirm()。

注意：在通常的单元测试场景中，confirm将位于不同的文件中，并且可以以类似于此示例中修补sys.argv的方式使用mock.patch。

用于检查对confirm()调用的测试代码：

import sys
import argparse
def confirm():
pass
def parse_args(args):
parser = argparse.ArgumentParser()
parser.add_argument('-d', '--destructive', action='store_true')
return parser.parse_args()

def main():
args = parse_args(sys.argv[1:])
if args.destructive:
if not confirm():
sys.exit()

import pytest
from unittest import mock
@pytest.mark.parametrize("argv, called, response", [
([], False, None),
(['-d'], True, False),
(['-d'], True, True),
])
def test_get_from_user(argv, called, response):
global confirm
original_confirm = confirm
confirm = mock.Mock(return_value=response)
with mock.patch('sys.argv', [''] + argv):
if called and not response:
with pytest.raises(SystemExit):
main()
else:
main()
assert confirm.called == called
confirm = original_confirm
pytest.main('-x test.py'.split())

结果：

============================= test session starts =============================
platform win32 -- Python 3.6.3, pytest-3.3.2, py-1.5.2, pluggy-0.6.0
rootdir: C:UsersstephenDocumentssrctestcode, inifile:
collected 3 items
test.py ...                                                              [100%]
========================== 3 passed in 3.26 seconds ===========================
enter code here