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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
|
"""
Tests for `shtab`.
"""
import logging
import os
import subprocess
from argparse import ArgumentParser
import pytest
import shtab
from shtab.main import get_main_parser, main
fix_shell = pytest.mark.parametrize("shell", shtab.SUPPORTED_SHELLS)
class Bash:
def __init__(self, init_script=""):
self.init = init_script
def test(self, cmd="1", failure_message=""):
"""Equivalent to `bash -c '{init}; [[ {cmd} ]]'`."""
init = self.init + "\n" if self.init else ""
proc = subprocess.Popen(["bash", "-o", "pipefail", "-euc", f"{init}[[ {cmd} ]]"])
stdout, stderr = proc.communicate()
assert (0 == proc.wait() and not stdout and not stderr), f"""\
{failure_message}
{cmd}
=== stdout ===
{stdout or ""}=== stderr ===
{stderr or ""}"""
def compgen(self, compgen_cmd, word, expected_completions, failure_message=""):
self.test(
f'"$(echo $(compgen {compgen_cmd} -- "{word}"))" = "{expected_completions}"',
failure_message,
)
@pytest.mark.parametrize("init,test", [("export FOO=1", '"$FOO" -eq 1'), ("", '-z "${FOO-}"')])
def test_bash(init, test):
shell = Bash(init)
shell.test(test)
def test_bash_compgen():
shell = Bash()
shell.compgen('-W "foo bar foobar"', "fo", "foo foobar")
def test_choices():
assert "x" in shtab.Optional.FILE
assert "" in shtab.Optional.FILE
assert "x" in shtab.Required.FILE
assert "" not in shtab.Required.FILE
@fix_shell
def test_main(shell, caplog):
with caplog.at_level(logging.INFO):
main(["-s", shell, "shtab.main.get_main_parser"])
assert not caplog.record_tuples
@fix_shell
def test_main_self_completion(shell, caplog, capsys):
with caplog.at_level(logging.INFO):
try:
main(["--print-own-completion", shell])
except SystemExit:
pass
captured = capsys.readouterr()
assert not captured.err
expected = {
"bash": "complete -o filenames -F _shtab_shtab shtab", "zsh": "_shtab_shtab_commands()",
"tcsh": "complete shtab"}
assert expected[shell] in captured.out
assert not caplog.record_tuples
@fix_shell
def test_prog_override(shell, caplog, capsys):
with caplog.at_level(logging.INFO):
main(["-s", shell, "--prog", "foo", "shtab.main.get_main_parser"])
captured = capsys.readouterr()
assert not captured.err
if shell == "bash":
assert "complete -o filenames -F _shtab_shtab foo" in captured.out
assert not caplog.record_tuples
@fix_shell
def test_prog_scripts(shell, caplog, capsys):
with caplog.at_level(logging.INFO):
main(["-s", shell, "--prog", "script.py", "shtab.main.get_main_parser"])
captured = capsys.readouterr()
assert not captured.err
script_py = [i.strip() for i in captured.out.splitlines() if "script.py" in i]
if shell == "bash":
assert script_py == ["complete -o filenames -F _shtab_shtab script.py"]
elif shell == "zsh":
assert script_py == [
"#compdef script.py", "_describe 'script.py commands' _commands",
"_shtab_shtab_options+=(': :_shtab_shtab_commands' '*::: :->script.py')", "script.py)",
"compdef _shtab_shtab -N script.py"]
elif shell == "tcsh":
assert script_py == ["complete script.py \\"]
else:
raise NotImplementedError(shell)
assert not caplog.record_tuples
@fix_shell
def test_prefix_override(shell, caplog, capsys):
with caplog.at_level(logging.INFO):
main(["-s", shell, "--prefix", "foo", "shtab.main.get_main_parser"])
captured = capsys.readouterr()
print(captured.out)
assert not captured.err
if shell == "bash":
shell = Bash(captured.out)
shell.compgen('-W "${_shtab_foo_option_strings[*]}"', "--h", "--help")
assert not caplog.record_tuples
@fix_shell
def test_complete(shell, caplog):
parser = get_main_parser()
with caplog.at_level(logging.INFO):
completion = shtab.complete(parser, shell=shell)
print(completion)
if shell == "bash":
shell = Bash(completion)
shell.compgen('-W "${_shtab_shtab_option_strings[*]}"', "--h", "--help")
assert not caplog.record_tuples
@fix_shell
def test_positional_choices(shell, caplog):
parser = ArgumentParser(prog="test")
parser.add_argument("posA", choices=["one", "two"])
with caplog.at_level(logging.INFO):
completion = shtab.complete(parser, shell=shell)
print(completion)
if shell == "bash":
shell = Bash(completion)
shell.compgen('-W "$_shtab_test_pos_0_choices"', "o", "one")
assert not caplog.record_tuples
@fix_shell
def test_custom_complete(shell, caplog):
parser = ArgumentParser(prog="test")
parser.add_argument("posA").complete = {"bash": "_shtab_test_some_func"}
preamble = {"bash": "_shtab_test_some_func() { compgen -W 'one two' -- $1 ;}"}
with caplog.at_level(logging.INFO):
completion = shtab.complete(parser, shell=shell, preamble=preamble)
print(completion)
if shell == "bash":
shell = Bash(completion)
shell.test('"$($_shtab_test_pos_0_COMPGEN o)" = "one"')
assert not caplog.record_tuples
@fix_shell
def test_subparser_custom_complete(shell, caplog):
parser = ArgumentParser(prog="test")
subparsers = parser.add_subparsers()
sub = subparsers.add_parser("sub", help="help message")
sub.add_argument("posA").complete = {"bash": "_shtab_test_some_func"}
preamble = {"bash": "_shtab_test_some_func() { compgen -W 'one two' -- $1 ;}"}
with caplog.at_level(logging.INFO):
completion = shtab.complete(parser, shell=shell, preamble=preamble)
print(completion)
if shell == "bash":
shell = Bash(completion)
shell.compgen('-W "${_shtab_test_subparsers[*]}"', "s", "sub")
shell.compgen('-W "$_shtab_test_pos_0_choices"', "s", "sub")
shell.test('"$($_shtab_test_sub_pos_0_COMPGEN o)" = "one"')
shell.test('-z "${_shtab_test_COMPGEN-}"')
assert not caplog.record_tuples
@fix_shell
def test_subparser_aliases(shell, caplog):
parser = ArgumentParser(prog="test")
subparsers = parser.add_subparsers()
sub = subparsers.add_parser("sub", aliases=["xsub", "ysub"], help="help message")
sub.add_argument("posA").complete = {"bash": "_shtab_test_some_func"}
preamble = {"bash": "_shtab_test_some_func() { compgen -W 'one two' -- $1 ;}"}
with caplog.at_level(logging.INFO):
completion = shtab.complete(parser, shell=shell, preamble=preamble)
print(completion)
if shell == "bash":
shell = Bash(completion)
shell.compgen('-W "${_shtab_test_subparsers[*]}"', "s", "sub")
shell.compgen('-W "${_shtab_test_pos_0_choices[*]}"', "s", "sub")
shell.compgen('-W "${_shtab_test_subparsers[*]}"', "x", "xsub")
shell.compgen('-W "${_shtab_test_pos_0_choices[*]}"', "x", "xsub")
shell.compgen('-W "${_shtab_test_subparsers[*]}"', "y", "ysub")
shell.compgen('-W "${_shtab_test_pos_0_choices[*]}"', "y", "ysub")
shell.test('"$($_shtab_test_sub_pos_0_COMPGEN o)" = "one"')
shell.test('-z "${_shtab_test_COMPGEN-}"')
assert not caplog.record_tuples
@fix_shell
def test_subparser_colons(shell, caplog):
parser = ArgumentParser(prog="test")
subparsers = parser.add_subparsers()
subparsers.add_parser("sub:cmd", help="help message")
with caplog.at_level(logging.INFO):
completion = shtab.complete(parser, shell=shell)
print(completion)
if shell == "bash":
shell = Bash(completion)
shell.compgen('-W "${_shtab_test_subparsers[*]}"', "s", "sub:cmd")
shell.compgen('-W "${_shtab_test_pos_0_choices[*]}"', "s", "sub:cmd")
shell.test('-z "${_shtab_test_COMPGEN-}"')
assert not caplog.record_tuples
@fix_shell
def test_subparser_slashes(shell, caplog):
parser = ArgumentParser(prog="test")
subparsers = parser.add_subparsers()
subparsers.add_parser("sub/cmd", help="help message")
with caplog.at_level(logging.INFO):
completion = shtab.complete(parser, shell=shell)
print(completion)
if shell == "bash":
shell = Bash(completion)
shell.compgen('-W "${_shtab_test_subparsers[*]}"', "s", "sub/cmd")
shell.compgen('-W "${_shtab_test_pos_0_choices[*]}"', "s", "sub/cmd")
shell.test('-z "${_shtab_test_COMPGEN-}"')
elif shell == "zsh":
assert "_shtab_test_sub/cmd" not in completion
assert "_shtab_test_sub_cmd" in completion
@fix_shell
def test_add_argument_to_optional(shell, caplog):
parser = ArgumentParser(prog="test")
shtab.add_argument_to(parser, ["-s", "--shell"])
with caplog.at_level(logging.INFO):
completion = shtab.complete(parser, shell=shell)
print(completion)
if shell == "bash":
shell = Bash(completion)
shell.compgen('-W "${_shtab_test_option_strings[*]}"', "--s", "--shell")
assert not caplog.record_tuples
@fix_shell
def test_add_argument_to_positional(shell, caplog, capsys):
parser = ArgumentParser(prog="test")
subparsers = parser.add_subparsers()
sub = subparsers.add_parser("completion", help="help message")
shtab.add_argument_to(sub, "shell", parent=parser)
from argparse import Namespace
with caplog.at_level(logging.INFO):
completion_manual = shtab.complete(parser, shell=shell)
with pytest.raises(SystemExit) as exc:
sub._actions[-1](sub, Namespace(), shell)
assert exc.type == SystemExit
assert exc.value.code == 0
completion, err = capsys.readouterr()
print(completion)
assert completion_manual.rstrip() == completion.rstrip()
assert not err
if shell == "bash":
shell = Bash(completion)
shell.compgen('-W "${_shtab_test_subparsers[*]}"', "c", "completion")
shell.compgen('-W "${_shtab_test_pos_0_choices[*]}"', "c", "completion")
shell.compgen('-W "${_shtab_test_completion_pos_0_choices[*]}"', "ba", "bash")
shell.compgen('-W "${_shtab_test_completion_pos_0_choices[*]}"', "z", "zsh")
assert not caplog.record_tuples
@fix_shell
def test_get_completer(shell):
shtab.get_completer(shell)
def test_get_completer_invalid():
try:
shtab.get_completer("invalid")
except NotImplementedError:
pass
else:
raise NotImplementedError("invalid")
@pytest.fixture
def change_dir(tmp_path):
original_cwd = os.getcwd()
os.chdir(tmp_path)
yield tmp_path
os.chdir(original_cwd)
def test_path_completion_after_redirection(caplog, change_dir):
parser = ArgumentParser(prog="test")
shtab.add_argument_to(parser, ["-s", "--shell"])
with caplog.at_level(logging.INFO):
completion = shtab.complete(parser, shell="bash")
print(completion)
(change_dir / "test_file.txt").touch()
for redirection in [">", ">>", "1>", "1>>", "2>", "2>>"]:
shell = Bash(completion +
f"\nCOMP_WORDS=(test '{redirection}' tes); COMP_CWORD=2; _shtab_test;")
shell.test('"${COMPREPLY[@]}" = "test_file.txt"', f"Redirection {redirection} failed")
assert not caplog.record_tuples
|
