如何在单元测试期间测试必需的argparse参数?

时间:2019-07-05 10:13:44

标签: python unit-testing tdd argparse python-unittest

我正在对argparser进行TDD测试。如何使用 required 选项测试参数?我需要测试所有选项,例如:

  • 论点太多
  • 没有给出参数,
  • 给出了错误的论点。

我可以提高SystemExit,但这不是我真正需要的:

    def test_no_arguments(self):
        with patch.object(sys, 'exit') as mock_method:
            self.parser.parse_arguments()
            self.assertTrue(mock_method.called)

但是,在不提高系统退出率的情况下,我总是会遇到如下错误: test_error

zbx-check-mount.py

class CommandLine:
    def __init__(self):
        self.args_parser = argparse.ArgumentParser(description="Monitoring mounted filesystems",
                                                   formatter_class=argparse.RawTextHelpFormatter)
        self.parsed_args = None

        self.add_arguments()

    def add_arguments(self):
        """
        Add arguments to parser.
        """
        try:
            self.args_parser._action_groups.pop()  # pylint: disable=protected-access
            required = self.args_parser.add_argument_group('required arguments')
            required.add_argument('--fs_name', required=True, help='Given filesystem')
        except argparse.ArgumentError as err:
            log.error('argparse.ArgumentError: %s', err)
            sys.exit(1)

    def parse_arguments(self, args=None):
        """
        Parse added arguments. Then run private method to return values
        """
        self.parsed_args = self.args_parser.parse_args()

        return self.parsed_args.fs_name,

测试

from pyfakefs.fake_filesystem_unittest import TestCase
import os
import sys

try:
    from StringIO import StringIO
except ImportError:
    from io import StringIO

if sys.version_info[0] == 3:
    from unittest.mock import MagicMock, patch
else:
    from mock import MagicMock, patch


sys.path.extend([os.path.join(os.path.dirname(os.path.abspath(__file__)),'..','..', "bin")])
module_name = __import__('zbx-check-mount')


class TestCommandLine(TestCase):

    def setUp(self):
        """
        Method called to prepare the test fixture. This is called immediately before calling the test method
        """
        self.parser = module_name.CommandLine()

    def test_no_arguments(self):
        opts = self.parser.parse_arguments([])
        assert opts.fs_name

    def tearDown(self):
        """
        Method called immediately after the test method has been called and the result recorded.
        """
        pass

如何避免这种情况并测试其他选项?

2 个答案:

答案 0 :(得分:1)

def parse_arguments(self, args=None):中,您应将args传递到解析器,如:

self.args_parser.parse_args(args)

parse_args()解析sys.argv[1:],或者给定参数为None。否则,它将解析提供的列表。

python的完整发行版中,有一个argparsetest_argparse.py)的单元测试文件。这有点复杂,定义了ArgumentParser的子类来捕获错误并重定向错误消息。

测试argparse非常棘手,因为它看起来sys.argv,并且也使用unittest脚本。它通常会尝试在错误时退出。已经在许多SO问题中对此进行了讨论。

答案 1 :(得分:0)

如果我正确解释了您的症状,那么您在测试工具中就遇到了问题,因为您的sys.exit猴子修补实现实际上返回了,这是argparse库所期望的。

引入side_effect会引发异常,然后您可以在单元测试中进行捕获和验证,就可以解决问题。