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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
|
from typing import Generator
import pytest
from clikit import ConsoleApplication
from clikit.api.command.exceptions import CannotAddCommandException
from clikit.api.command.exceptions import NoSuchCommandException
from clikit.api.config import ApplicationConfig as BaseApplicationConfig
from clikit.api.config import CommandConfig
from clikit.api.io import IO
from clikit.api.io import Input
from clikit.api.io import Output
from clikit.args import StringArgs
from clikit.handler.callback_handler import CallbackHandler
from clikit.io.input_stream import StringInputStream
from clikit.io.output_stream import BufferedOutputStream
from clikit.resolver import DefaultResolver
class ApplicationConfig(BaseApplicationConfig):
@property
def default_command_resolver(self):
return DefaultResolver()
@pytest.fixture()
def config(): # type: () -> Generator[ApplicationConfig]
config = ApplicationConfig()
config.set_catch_exceptions(False)
config.set_terminate_after_run(False)
config.set_io_factory(
lambda app, args, input_stream, output_stream, error_stream: IO(
Input(input_stream), Output(output_stream), Output(error_stream)
)
)
yield config
def test_create(config):
config.add_argument("argument")
config.add_option("option", "o")
app = ConsoleApplication(config)
assert config == app.config
fmt = app.global_args_format
assert len(fmt.get_arguments()) == 1
arg = fmt.get_argument("argument")
assert arg.name == "argument"
opt = fmt.get_option("option")
assert opt.long_name == "option"
assert opt.short_name == "o"
def test_get_commands(config):
config1 = CommandConfig("command1")
config2 = CommandConfig("command2")
config.add_command_config(config1)
config.add_command_config(config2)
app = ConsoleApplication(config)
assert len(app.commands) == 2
assert app.commands.get("command1").name == config1.name
assert app.commands.get("command2").name == config2.name
def test_get_commands_excludes_disabled_commands(config):
enabled = CommandConfig("command1").enable()
disabled = CommandConfig("command2").disable()
config.add_command_config(enabled)
config.add_command_config(disabled)
app = ConsoleApplication(config)
assert len(app.commands) == 1
assert app.commands.get("command1").name == enabled.name
def test_get_command(config):
config1 = CommandConfig("command1")
config.add_command_config(config1)
app = ConsoleApplication(config)
command = app.get_command("command1")
assert command.name == config1.name
def test_get_command_fails_if_command_not_found(config):
app = ConsoleApplication(config)
with pytest.raises(NoSuchCommandException):
app.get_command("foobar")
def test_has_command(config):
config1 = CommandConfig("command1")
config.add_command_config(config1)
app = ConsoleApplication(config)
assert app.has_command(config1.name)
def test_has_commands(config):
config1 = CommandConfig("command1")
config.add_command_config(config1)
app = ConsoleApplication(config)
assert app.has_commands()
def test_has_no_commands(config):
app = ConsoleApplication(config)
assert not app.has_commands()
def test_get_named_commands(config):
config1 = CommandConfig("command1")
config2 = CommandConfig("command2")
config3 = CommandConfig("command3")
config2.anonymous()
config3.default()
config.add_command_config(config1)
config.add_command_config(config2)
config.add_command_config(config3)
app = ConsoleApplication(config)
assert len(app.named_commands) == 2
def test_has_named_commands(config):
config1 = CommandConfig("command1")
config.add_command_config(config1)
app = ConsoleApplication(config)
assert app.has_named_commands()
def test_has_no_named_commands(config):
config1 = CommandConfig("command1")
config1.anonymous()
config.add_command_config(config1)
app = ConsoleApplication(config)
assert not app.has_named_commands()
def test_get_default_commands(config):
config1 = CommandConfig("command1")
config2 = CommandConfig("command2")
config3 = CommandConfig("command3")
config2.default()
config3.default()
config.add_command_config(config1)
config.add_command_config(config2)
config.add_command_config(config3)
app = ConsoleApplication(config)
assert len(app.default_commands) == 2
def test_has_no_default_commands(config):
config1 = CommandConfig("command1")
config.add_command_config(config1)
app = ConsoleApplication(config)
assert not app.has_default_commands()
def test_has_default_commands(config):
config1 = CommandConfig("command1")
config1.default()
config.add_command_config(config1)
app = ConsoleApplication(config)
assert app.has_default_commands()
def test_fails_if_no_command_name(config):
config.add_command_config(CommandConfig())
with pytest.raises(CannotAddCommandException):
ConsoleApplication(config)
def test_fails_if_duplicate_command_name(config):
config.add_command_config(CommandConfig("command"))
config.add_command_config(CommandConfig("command"))
with pytest.raises(CannotAddCommandException):
ConsoleApplication(config)
@pytest.mark.parametrize(
"arg_string, config_callback",
[
# Simple command
(
"list",
lambda config, callback: config.create_command("list").set_handler(
CallbackHandler(callback)
),
),
# Default command
(
"",
lambda config, callback: config.create_command("list")
.default()
.set_handler(CallbackHandler(callback)),
),
# Sub command
(
"server add",
lambda config, callback: config.create_command("server")
.create_sub_command("add")
.set_handler(CallbackHandler(callback)),
),
# Default sub command
(
"server",
lambda config, callback: config.create_command("server")
.create_sub_command("add")
.default()
.set_handler(CallbackHandler(callback)),
),
],
)
def test_run_command(config, arg_string, config_callback):
def callback(_, io):
io.write(io.read_line())
io.error(io.read_line())
return 123
config_callback(config, callback)
args = StringArgs(arg_string)
input = StringInputStream("line1\nline2")
output = BufferedOutputStream()
error_output = BufferedOutputStream()
app = ConsoleApplication(config)
assert 123 == app.run(args, input, output, error_output)
assert "line1\n" == output.fetch()
assert "line2" == error_output.fetch()
def test_run_with_keyboard_interrupt(config): # type: (ApplicationConfig) -> None
def callback(_, io):
raise KeyboardInterrupt()
config.create_command("interrupted").set_handler(CallbackHandler(callback))
app = ConsoleApplication(config)
output = BufferedOutputStream()
error_output = BufferedOutputStream()
assert 1 == app.run(
StringArgs("interrupted"), StringInputStream(""), output, error_output
)
assert "" == output.fetch()
assert "" == error_output.fetch()
|
