2016-06-08 67 views
1

蟒单元测试我有一个模块内的功能,创建一个​​:为argparse

def get_options(prog_version='1.0', prog_usage='', misc_opts=None): 
    options = [] if misc_opts is None else misc_opts 
    parser = ArgumentParser(usage=prog_usage) if prog_usage else ArgumentParser() 
    parser.add_argument('-v', '--version', action='version', version='%(prog)s {}'.format(prog_version)) 
    parser.add_argument('-c', '--config', dest='config', required=True, help='the path to the configuration file') 

    for option in options: 
     if 'option' in option and 'destination' in option: 
      parser.add_argument(option['option'], 
           dest=option.get('destination', ''), 
           default=option.get('default', ''), 
           help=option.get('description', ''), 
           action=option.get('action', 'store')) 

    return parser.parse_args() 

样品myapp.py将是:

my_options = [ 
    { 
     "option": "-s", 
     "destination": "remote_host", 
     "default": "127.0.0.1", 
     "description": "The remote server name or IP address", 
     "action": "store" 
    }, 
] 

# Get Command Line Options 
options = get_options(misc_opts=my_options) 
print options.config 
print options.remote_host 

,这将被称为:

$> python myapp.py -c config.yaml 
$> config.yaml 
    127.0.0.1 

现在,我想创建一个单位测试这个功能,但我的问题是,我可以'通过测试代码传递命令行参数。

# mytest.py 
import unittest 
from mymodule import get_options 

class argParseTestCase(unittest.TestCase): 
    def test_parser(self): 
     options = get_options() 
     # ...pass the command line arguments... 
     self.assertEquals('config.yaml', options.config) # ofcourse this fails because I don't know how I will pass the command line arguments 

我的问题是,我需要在命令行参数传递给get_options(),但我不知道如何正确地做到这一点。

预期正确拨打电话:(-c config.yaml应该测试代码内部通过某种方式)python mytest.py

什么是 “工作”/不是现在的工作:

  1. python mytest.py -c config.yaml也不能正常工作。返回AttributeError: 'module' object has no attribute 'config',因为它期望我改为拨打argParseTestCase。换句话说,python mytest.py -c argParseTestCase“作品”,但当然是返回AssertionError: 'config.yaml' != 'argParseTestCase'
  2. python mytest.py -v在详细模式下运行单元测试也失败。它返回:

    test_parser (main.argParseTestCase) ... mytest.py 1.0 ERROR ERROR: test_parser (main.argParseTestCase)
    Traceback (most recent call last): File "tests/unit_tests/mytest.py", line 376, in test_parser options = get_options() File "/root/test/lib/python2.7/site-packages/mymodule.py", line 61, in get_options return parser.parse_args()
    File "/usr/local/lib/python2.7/argparse.py", line 1701, in parse_args args, argv = self.parse_known_args(args, namespace)
    File "/usr/local/lib/python2.7/argparse.py", line 1733, in parse_known_args namespace, args = self._parse_known_args(args, namespace)
    File "/usr/local/lib/python2.7/argparse.py", line 1939, in _parse_known_args start_index = consume_optional(start_index)
    File "/usr/local/lib/python2.7/argparse.py", line 1879, in consume_optional take_action(action, args, option_string)
    File "/usr/local/lib/python2.7/argparse.py", line 1807, in take_action action(self, namespace, argument_values, option_string)
    File "/usr/local/lib/python2.7/argparse.py", line 1022, in call parser.exit(message=formatter.format_help())
    File "/usr/local/lib/python2.7/argparse.py", line 2362, in exit _sys.exit(status) SystemExit: 0

回答

2

你的错误信息堆栈是难以阅读,因为它是在引号形式,而不是代码。但我认为-v的说法是产生一个sys.exitversion就像help - 它应该显示一条消息,然后退出。 unittest使用-v,但您的解析器也会读取它。

有一个​​unittest模块,test/test_argparse.py。您可能需要开发Python安装才能看到。有些测试很简单,有些则使用专门的测试结构。其中一些特殊代码以与options相同的方式创建参数。

的两个特殊问题:

  • 生成输入。 parse_args使用sys.argv[1:],除非它的argv参数不是None。因此,您可以通过修改sys.argv列表(unittest已经使用您的命令行值)或将argv=None关键字参数传递到您的函数以及parse_args来测试解析器。试图制作一个命令行,用于unittest代码与get_options一起工作太复杂。

  • 陷印输出,尤其是sys.exit产生的错误。一种选择是将ArgumentParser分类并给它一个不同的error和/或exit方法。另一个是将函数调用包装在try块中。

unittest需要-c的说法,但有不同的语法和意义

-c, --catch  Catch control-C and display results 

-vverbose,不version

=============

此测试config参数(在一个自包含一个文件形式)

import unittest 
import sys 
#from mymodule import get_options 

def get_options(argv=None, prog_version='1.0', prog_usage='', misc_opts=None): 
    # argv is optional test list; uses sys.argv[1:] is not provided 
    from argparse import ArgumentParser 
    options = [] if misc_opts is None else misc_opts 
    parser = ArgumentParser(usage=prog_usage) if prog_usage else ArgumentParser() 
    parser.add_argument('-v', '--version', action='version', version='%(prog)s {}'.format(prog_version)) 
    parser.add_argument('-c', '--config', dest='config', help='the path to the configuration file') 

    for option in options: 
     if 'option' in option and 'destination' in option: 
      parser.add_argument(option['option'], 
           dest=option.get('destination', ''), 
           default=option.get('default', ''), 
           help=option.get('description', ''), 
           action=option.get('action', 'store')) 

    args = parser.parse_args(argv) 
    print('args',args) 
    return args 

class argParseTestCase(unittest.TestCase): 
    def test_config(self): 
     sys.argv[1:]=['-c','config.yaml']  
     options = get_options() 
     self.assertEquals('config.yaml', options.config) 
    def test_version(self): 
     sys.argv[1:]=['-v'] 
     with self.assertRaises(SystemExit): 
        get_options() 
     # testing version message requires redirecting stdout 
    # similarly for a misc_opts test 

if __name__=='__main__': 
    unittest.main() 
3

我喜欢明确地传递参数,而不是依靠的在全球可用的属性,如sys.argv(其中parser.parse_args()内部)。因此,我通常自己将列表传递的参数使用​​(以main(),随后get_options()何地你需要他们):

def get_options(args, prog_version='1.0', prog_usage='', misc_opts=None): 
    # ... 
    return parser.parse_args(args) 

,然后传入参数

def main(args): 
    get_options(args) 

if __name__ == "__main__": 
    main(sys.argv[1:]) 

这样我可以代替并测试我喜欢的任何参数列表

options = get_options(['-c','config.yaml']) 
self.assertEquals('config.yaml', options.config)