1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
# flake8: noqa E302
"""
Unit/functional testing for argparse customizations in cmd2
"""
import argparse
import pytest
import cmd2
from cmd2.argparse_custom import generate_range_error, INFINITY
from .conftest import run_cmd
class ApCustomTestApp(cmd2.Cmd):
"""Test app for cmd2's argparse customization"""
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
range_parser = cmd2.ArgParser()
range_parser.add_argument('--arg1', nargs=(2, 3))
range_parser.add_argument('--arg2', nargs=argparse.ZERO_OR_MORE)
range_parser.add_argument('--arg3', nargs=argparse.ONE_OR_MORE)
@cmd2.with_argparser(range_parser)
def do_range(self, _):
pass
@pytest.fixture
def cust_app():
return ApCustomTestApp()
def fake_func():
pass
@pytest.mark.parametrize('args, is_valid', [
({'choices': []}, True),
({'choices_function': fake_func}, True),
({'choices_method': fake_func}, True),
({'completer_function': fake_func}, True),
({'completer_method': fake_func}, True),
({'choices': [], 'choices_function': fake_func}, False),
({'choices': [], 'choices_method': fake_func}, False),
({'choices_method': fake_func, 'completer_function': fake_func}, False),
({'choices_method': fake_func, 'completer_method': fake_func}, False),
])
def test_apcustom_invalid_args(args, is_valid):
parser = cmd2.ArgParser(prog='test')
try:
parser.add_argument('name', **args)
assert is_valid
except ValueError as ex:
assert not is_valid
assert 'Only one of the following may be used' in str(ex)
def test_apcustom_usage():
usage = "A custom usage statement"
parser = cmd2.ArgParser(usage=usage)
assert usage in parser.format_help()
def test_apcustom_nargs_help_format(cust_app):
out, err = run_cmd(cust_app, 'help range')
assert 'Usage: range [-h] [--arg1 ARG1{2..3}] [--arg2 [ARG2 [...]]]' in out[0]
assert ' [--arg3 ARG3 [...]]' in out[1]
def test_apcustom_nargs_not_enough(cust_app):
out, err = run_cmd(cust_app, 'range --arg1 one')
assert 'Error: argument --arg1: expected 2 to 3 arguments' in err[2]
@pytest.mark.parametrize('nargs_tuple', [
(),
('f', 5),
(5, 'f'),
(1, 2, 3),
])
def test_apcustom_narg_invalid_tuples(nargs_tuple):
with pytest.raises(ValueError) as excinfo:
parser = cmd2.ArgParser(prog='test')
parser.add_argument('invalid_tuple', nargs=nargs_tuple)
assert 'Ranged values for nargs must be a tuple of 1 or 2 integers' in str(excinfo.value)
def test_apcustom_narg_tuple_order():
with pytest.raises(ValueError) as excinfo:
parser = cmd2.ArgParser(prog='test')
parser.add_argument('invalid_tuple', nargs=(2, 1))
assert 'Invalid nargs range. The first value must be less than the second' in str(excinfo.value)
def test_apcustom_narg_tuple_negative():
with pytest.raises(ValueError) as excinfo:
parser = cmd2.ArgParser(prog='test')
parser.add_argument('invalid_tuple', nargs=(-1, 1))
assert 'Negative numbers are invalid for nargs range' in str(excinfo.value)
# noinspection PyUnresolvedReferences
def test_apcustom_narg_tuple_zero_base():
parser = cmd2.ArgParser(prog='test')
arg = parser.add_argument('tuple', nargs=(0,))
assert arg.nargs == argparse.ZERO_OR_MORE
assert arg.nargs_range is None
parser = cmd2.ArgParser(prog='test')
arg = parser.add_argument('tuple', nargs=(0, 1))
assert arg.nargs == argparse.OPTIONAL
assert arg.nargs_range is None
parser = cmd2.ArgParser(prog='test')
arg = parser.add_argument('tuple', nargs=(0, 3))
assert arg.nargs == argparse.ZERO_OR_MORE
assert arg.nargs_range == (0, 3)
# noinspection PyUnresolvedReferences
def test_apcustom_narg_tuple_one_base():
parser = cmd2.ArgParser(prog='test')
arg = parser.add_argument('tuple', nargs=(1,))
assert arg.nargs == argparse.ONE_OR_MORE
assert arg.nargs_range is None
parser = cmd2.ArgParser(prog='test')
arg = parser.add_argument('tuple', nargs=(1, 5))
assert arg.nargs == argparse.ONE_OR_MORE
assert arg.nargs_range is (1, 5)
# noinspection PyUnresolvedReferences
def test_apcustom_narg_tuple_other():
parser = cmd2.ArgParser(prog='test')
arg = parser.add_argument('tuple', nargs=(2, 5))
assert arg.nargs == argparse.ONE_OR_MORE
assert arg.nargs_range is (2, 5)
def test_apcustom_print_message(capsys):
import sys
test_message = 'The test message'
# Specify the file
parser = cmd2.ArgParser(prog='test')
parser._print_message(test_message, file=sys.stdout)
out, err = capsys.readouterr()
assert test_message in out
# Make sure file defaults to sys.stderr
parser = cmd2.ArgParser(prog='test')
parser._print_message(test_message)
out, err = capsys.readouterr()
assert test_message in err
def test_generate_range_error():
# max is INFINITY
err_str = generate_range_error(1, INFINITY)
assert err_str == "expected at least 1 argument"
err_str = generate_range_error(2, INFINITY)
assert err_str == "expected at least 2 arguments"
# min and max are equal
err_str = generate_range_error(1, 1)
assert err_str == "expected 1 argument"
err_str = generate_range_error(2, 2)
assert err_str == "expected 2 arguments"
# min and max are not equal
err_str = generate_range_error(0, 1)
assert err_str == "expected 0 to 1 argument"
err_str = generate_range_error(0, 2)
assert err_str == "expected 0 to 2 arguments"
def test_apcustom_required_options():
# Make sure a 'required arguments' section shows when a flag is marked required
parser = cmd2.ArgParser(prog='test')
parser.add_argument('--required_flag', required=True)
assert 'required arguments' in parser.format_help()
|
