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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
"""Most of argparse examples rebuilt with climp."""
import argparse
import unittest
import pytest
from decli import cli
from . import examples
class Test(unittest.TestCase):
def test_main_example_ok(self) -> None:
parser = examples.main_example()
args = parser.parse_args("1 2 3 4".split())
assert args.accumulate(args.integers) == 4
def test_main_example_sums_ok(self) -> None:
parser = examples.main_example()
args = parser.parse_args("1 2 3 4 --sum".split())
assert args.accumulate(args.integers) == 10
def test_main_example_fails(self) -> None:
parser = examples.main_example()
with pytest.raises(SystemExit):
args = parser.parse_args("a b c".split())
args.accumulate(args.integers)
def test_complete_example(self) -> None:
parser = examples.complete_example()
args = parser.parse_args("sum 1 2 3".split())
assert args.func(args.integers) == 6
def test_compose_clis_using_parents(self) -> None:
data = {"prog": "daddy", "arguments": [{"name": "something"}]}
parents = examples.compose_clis_using_parents()
parser = cli(data, parents=parents)
args = parser.parse_args(["--foo-parent", "2", "XXX"])
assert args.something == "XXX"
assert args.foo_parent == 2
def test_compose_clis_using_parents_and_arguments(self) -> None:
data = {"prog": "daddy", "arguments": [{"name": "--something"}]}
parents = examples.compose_clis_using_parents()
parser = cli(data, parents=parents)
args = parser.parse_args(["--something", "XXX"])
assert args.something == "XXX"
def test_prefix_chars(self) -> None:
data = examples.prefix_chars()
parser = cli(data)
args = parser.parse_args("+f X ++bar Y".split())
assert args.foo == "X"
assert args.bar == "Y"
def test_name_or_flags(self) -> None:
data = examples.name_or_flags()
parser = cli(data)
args = parser.parse_args(["HELLO"])
assert args.bar == "HELLO"
args = parser.parse_args(["BAR", "--foo", "FOO"])
assert args.bar == "BAR"
assert args.foo == "FOO"
def test_name_or_flags_fail(self) -> None:
data = examples.name_or_flags()
parser = cli(data)
with pytest.raises(SystemExit):
parser.parse_args(["--foo", "FOO"])
def test_cli_no_args(self) -> None:
data = {"prog": "daddy", "description": "helloo"}
parser = cli(data)
args = parser.parse_args([])
assert args.__dict__ == {}
def test_groups(self) -> None:
data = examples.grouping_arguments()
parser = cli(data)
help_result = parser.format_help()
assert "app" in help_result
assert "package" in help_result
def test_not_optional_arg_name_validation_fails(self) -> None:
data = {"arguments": [{"name": ["f", "foo"]}]}
with pytest.raises(ValueError):
cli(data)
def test_exclusive_group_ok(self) -> None:
data = {
"prog": "app",
"arguments": [
{
"name": "--install",
"action": "store_true",
"exclusive_group": "ops",
},
{
"name": "--purge",
"action": "store_true",
"exclusive_group": "ops",
},
],
}
parser = cli(data)
args = parser.parse_args(["--install"])
assert args.install is True
assert args.purge is False
def test_exclusive_group_fails_when_same_group_called(self) -> None:
data = {
"prog": "app",
"arguments": [
{
"name": "--install",
"action": "store_true",
"exclusive_group": "opas",
},
{
"name": "--purge",
"action": "store_true",
"exclusive_group": "opas",
},
],
}
parser = cli(data)
with pytest.raises(SystemExit):
parser.parse_args("--install --purge".split())
def test_exclusive_group_and_group_together_fail(self) -> None:
"""
Note:
Exclusive group requires at least one arg before adding groups
"""
data = {
"prog": "app",
"arguments": [
{
"name": "--install",
"action": "store_true",
"exclusive_group": "ops",
"group": "cmd",
},
{
"name": "--purge",
"action": "store_true",
"exclusive_group": "ops",
"group": "cmd",
},
{"name": "--fear", "exclusive_group": "ops"},
],
}
with pytest.raises(ValueError):
cli(data)
def test_subcommand_required(self) -> None:
data = {
"prog": "cz",
"description": (
"Commitizen is a cli tool to generate conventional commits.\n"
"For more information about the topic go to "
"https://conventionalcommits.org/"
),
"formatter_class": argparse.RawDescriptionHelpFormatter,
"arguments": [
{"name": "--debug", "action": "store_true", "help": "use debug mode"},
{
"name": ["-n", "--name"],
"help": "use the given commitizen (default: cz_conventional_commits)",
},
],
"subcommands": {
"title": "commands",
"required": True,
"commands": [
{
"name": ["init"],
"help": "init commitizen configuration",
}
],
},
}
parser = cli(data)
args = parser.parse_args(["-n", "cz_jira", "init"])
assert args.debug is False
assert args.name == "cz_jira"
|
