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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
# -*- coding: utf-8 -*-
from __future__ import unicode_literals
import pytest
from clikit.api.args import Args
from clikit.args.string_args import StringArgs
from clikit.config.default_application_config import DefaultApplicationConfig
from clikit.console_application import ConsoleApplication
@pytest.fixture()
def app():
config = DefaultApplicationConfig()
config.set_display_name("The Application")
config.set_version("1.2.3")
with config.command("command") as c:
with c.sub_command("add") as sc1:
sc1.set_description('Description of "add"')
sc1.add_argument("argument", 0, 'Description of "argument"')
with c.sub_command("delete") as sc2:
sc2.set_description('Description of "delete"')
sc2.add_option("opt", "o", description='Description of "opt"')
sc2.add_argument("sub-arg", description='Description of "sub-arg"')
application = ConsoleApplication(config)
return application
def test_render_for_application(app, io):
help_command = app.get_command("help")
handler = help_command.config.handler
raw_args = StringArgs("")
args = Args(help_command.args_format, raw_args)
status = handler.handle(args, io, app.get_command("command"))
expected = """\
The Application version 1.2.3
USAGE
console [-h] [-q] [-v [<...>]] [-V] [--ansi] [--no-ansi] [-n] <command>
[<arg1>] ... [<argN>]
ARGUMENTS
<command> The command to execute
<arg> The arguments of the command
GLOBAL OPTIONS
-h (--help) Display this help message
-q (--quiet) Do not output any message
-v (--verbose) Increase the verbosity of messages: "-v" for normal
output, "-vv" for more verbose output and "-vvv" for
debug
-V (--version) Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
-n (--no-interaction) Do not ask any interactive question
AVAILABLE COMMANDS
command
help Display the manual of a command
"""
assert 0 == status
assert expected == io.fetch_output()
def test_render_for_application_does_not_display_hidden_commands(app, io):
app.get_command("command").config.hide()
help_command = app.get_command("help")
handler = help_command.config.handler
raw_args = StringArgs("")
args = Args(help_command.args_format, raw_args)
status = handler.handle(args, io, app.get_command("command"))
expected = """\
The Application version 1.2.3
USAGE
console [-h] [-q] [-v [<...>]] [-V] [--ansi] [--no-ansi] [-n] <command>
[<arg1>] ... [<argN>]
ARGUMENTS
<command> The command to execute
<arg> The arguments of the command
GLOBAL OPTIONS
-h (--help) Display this help message
-q (--quiet) Do not output any message
-v (--verbose) Increase the verbosity of messages: "-v" for normal
output, "-vv" for more verbose output and "-vvv" for
debug
-V (--version) Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
-n (--no-interaction) Do not ask any interactive question
AVAILABLE COMMANDS
help Display the manual of a command
"""
assert 0 == status
assert expected == io.fetch_output()
def test_render_sub_command(app, io):
help_command = app.get_command("help")
handler = help_command.config.handler
raw_args = StringArgs("command delete")
args = Args(help_command.args_format, raw_args)
args.set_argument("command", "command")
status = handler.handle(args, io, app.get_command("command"))
expected = """\
USAGE
console command delete [-o] [<sub-arg>]
ARGUMENTS
<sub-arg> Description of "sub-arg"
OPTIONS
-o (--opt) Description of "opt"
GLOBAL OPTIONS
-h (--help) Display this help message
-q (--quiet) Do not output any message
-v (--verbose) Increase the verbosity of messages: "-v" for normal
output, "-vv" for more verbose output and "-vvv" for
debug
-V (--version) Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
-n (--no-interaction) Do not ask any interactive question
"""
assert 0 == status
assert expected == io.fetch_output()
def test_render_parent_command_with_help_command_argument(app, io):
help_command = app.get_command("help")
handler = help_command.config.handler
raw_args = StringArgs("help command")
args = Args(help_command.args_format, raw_args)
args.set_argument("command", "command")
status = handler.handle(args, io, app.get_command("command"))
expected = """\
USAGE
console command
or: console command add [<argument>]
or: console command delete [-o] [<sub-arg>]
COMMANDS
add
Description of "add"
<argument> Description of "argument"
delete
Description of "delete"
<sub-arg> Description of "sub-arg"
-o (--opt) Description of "opt"
GLOBAL OPTIONS
-h (--help) Display this help message
-q (--quiet) Do not output any message
-v (--verbose) Increase the verbosity of messages: "-v" for normal
output, "-vv" for more verbose output and "-vvv" for
debug
-V (--version) Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
-n (--no-interaction) Do not ask any interactive question
"""
assert 0 == status
assert expected == io.fetch_output()
def test_render_sub_command_with_help_command_argument(app, io):
help_command = app.get_command("help")
handler = help_command.config.handler
raw_args = StringArgs("help command delete")
args = Args(help_command.args_format, raw_args)
args.set_argument("command", "command")
status = handler.handle(args, io, app.get_command("command"))
expected = """\
USAGE
console command delete [-o] [<sub-arg>]
ARGUMENTS
<sub-arg> Description of "sub-arg"
OPTIONS
-o (--opt) Description of "opt"
GLOBAL OPTIONS
-h (--help) Display this help message
-q (--quiet) Do not output any message
-v (--verbose) Increase the verbosity of messages: "-v" for normal
output, "-vv" for more verbose output and "-vvv" for
debug
-V (--version) Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
-n (--no-interaction) Do not ask any interactive question
"""
assert 0 == status
assert expected == io.fetch_output()
def test_render_parent_command_does_not_display_hidden_sub_commands(app, io):
app.get_command("command").config.get_sub_command_config("delete").hide()
help_command = app.get_command("help")
handler = help_command.config.handler
raw_args = StringArgs("help command")
args = Args(help_command.args_format, raw_args)
args.set_argument("command", "command")
status = handler.handle(args, io, app.get_command("command"))
expected = """\
USAGE
console command
or: console command add [<argument>]
COMMANDS
add
Description of "add"
<argument> Description of "argument"
GLOBAL OPTIONS
-h (--help) Display this help message
-q (--quiet) Do not output any message
-v (--verbose) Increase the verbosity of messages: "-v" for normal
output, "-vv" for more verbose output and "-vvv" for
debug
-V (--version) Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
-n (--no-interaction) Do not ask any interactive question
"""
assert 0 == status
assert expected == io.fetch_output()
|
