Pytest with argparse：如何测试用户被提示确认？

Posted 2023-03-25

【中文标题】Pytest with argparse：如何测试用户被提示确认？

【英文标题】：Pytest with argparse: how to test user is prompted for confirmation?

【发布时间】：2018-06-29 19:23:09

【问题描述】：

我有一个 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。

我想确保：

设置破坏性标志时显示确认 不显示时不显示

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

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?

【问题讨论】：

感谢您的链接。需要明确的是，我不想测试/模拟用户的输入，我想确保提出问题。我将更改标题以更好地反映这一点。

模拟库有方法来确定模拟被调用的次数。这就是你告诉它被调用的方式。

【参考方案1】：

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

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

代码：

@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:\Users\stephen\Documents\src\testcode, inifile:
collected 4 items

test.py ....                                                             [100%]

========================== 4 passed in 0.15 seconds ===========================

测试对confirm()的调用：

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

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

检查对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:\Users\stephen\Documents\src\testcode, inifile:
collected 3 items

test.py ...                                                              [100%]

========================== 3 passed in 3.26 seconds ===========================
enter code here