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
|
# coding=utf-8
"""
Unit/functional testing for readline tab-completion functions in the cmd2.py module.
These are primarily tests related to readline completer functions which handle tab-completion of cmd2/cmd commands,
file system paths, and shell commands.
Copyright 2017 Todd Leonhardt <todd.leonhardt@gmail.com>
Released under MIT license, see LICENSE file
"""
import os
import sys
import cmd2
import pytest
@pytest.fixture
def cmd2_app():
c = cmd2.Cmd()
return c
def test_cmd2_command_completion_single_end(cmd2_app):
text = 'he'
line = 'he'
endidx = len(line)
begidx = endidx - len(text)
# It is at end of line, so extra space is present
assert cmd2_app.completenames(text, line, begidx, endidx) == ['help ']
def test_cmd2_command_completion_single_mid(cmd2_app):
text = 'he'
line = 'he'
begidx = 0
endidx = 1
# It is not at end of line, so no extra space
assert cmd2_app.completenames(text, line, begidx, endidx) == ['help']
def test_cmd2_command_completion_multiple(cmd2_app):
text = 'h'
line = 'h'
endidx = len(line)
begidx = endidx - len(text)
# It is not at end of line, so no extra space
assert cmd2_app.completenames(text, line, begidx, endidx) == ['help', 'history']
def test_cmd2_command_completion_nomatch(cmd2_app):
text = 'z'
line = 'z'
endidx = len(line)
begidx = endidx - len(text)
assert cmd2_app.completenames(text, line, begidx, endidx) == []
def test_cmd2_help_completion_single_end(cmd2_app):
text = 'he'
line = 'help he'
endidx = len(line)
begidx = endidx - len(text)
# Even though it is at end of line, no extra space is present when tab completing a command name to get help on
assert cmd2_app.completenames(text, line, begidx, endidx) == ['help']
def test_cmd2_help_completion_single_mid(cmd2_app):
text = 'he'
line = 'help he'
begidx = 5
endidx = 6
assert cmd2_app.completenames(text, line, begidx, endidx) == ['help']
def test_cmd2_help_completion_multiple(cmd2_app):
text = 'h'
line = 'help h'
endidx = len(line)
begidx = endidx - len(text)
assert cmd2_app.completenames(text, line, begidx, endidx) == ['help', 'history']
def test_cmd2_help_completion_nomatch(cmd2_app):
text = 'z'
line = 'help z'
endidx = len(line)
begidx = endidx - len(text)
assert cmd2_app.completenames(text, line, begidx, endidx) == []
def test_shell_command_completion(cmd2_app):
if sys.platform == "win32":
text = 'calc'
line = 'shell {}'.format(text)
expected = ['calc.exe ']
else:
text = 'eg'
line = '!{}'.format(text)
expected = ['egrep ']
endidx = len(line)
begidx = endidx - len(text)
assert cmd2_app.complete_shell(text, line, begidx, endidx) == expected
def test_shell_command_completion_doesnt_match_wildcards(cmd2_app):
if sys.platform == "win32":
text = 'c*'
line = 'shell {}'.format(text)
else:
text = 'e*'
line = '!{}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
assert cmd2_app.complete_shell(text, line, begidx, endidx) == []
def test_shell_command_completion_multiple(cmd2_app):
if sys.platform == "win32":
text = 'c'
line = 'shell {}'.format(text)
expected = 'calc.exe'
else:
text = 'l'
line = '!{}'.format(text)
expected = 'ls'
endidx = len(line)
begidx = endidx - len(text)
assert expected in cmd2_app.complete_shell(text, line, begidx, endidx)
def test_shell_command_completion_nomatch(cmd2_app):
text = 'zzzz'
line = 'shell zzzz'
endidx = len(line)
begidx = endidx - len(text)
assert cmd2_app.complete_shell(text, line, begidx, endidx) == []
def test_shell_command_completion_doesnt_complete_when_just_shell(cmd2_app):
text = ''
if sys.platform == "win32":
line = 'shell'.format(text)
else:
line = '!'.format(text)
endidx = len(line)
begidx = endidx - len(text)
assert cmd2_app.complete_shell(text, line, begidx, endidx) == []
def test_shell_command_completion_does_path_completion_when_after_command(cmd2_app, request):
test_dir = os.path.dirname(request.module.__file__)
text = 'c'
path = os.path.join(test_dir, text)
line = 'shell cat {}'.format(path)
endidx = len(line)
begidx = endidx - len(text)
assert cmd2_app.complete_shell(text, line, begidx, endidx) == ['conftest.py ']
def test_path_completion_single_end(cmd2_app, request):
test_dir = os.path.dirname(request.module.__file__)
text = 'c'
path = os.path.join(test_dir, text)
line = '!cat {}'.format(path)
endidx = len(line)
begidx = endidx - len(text)
assert cmd2_app.path_complete(text, line, begidx, endidx) == ['conftest.py ']
def test_path_completion_single_mid(cmd2_app, request):
test_dir = os.path.dirname(request.module.__file__)
text = 'tes'
path = os.path.join(test_dir, 'c')
line = '!cat {}'.format(path)
begidx = line.find(text)
endidx = begidx + len(text)
assert cmd2_app.path_complete(text, line, begidx, endidx) == ['tests' + os.path.sep]
def test_path_completion_multiple(cmd2_app, request):
test_dir = os.path.dirname(request.module.__file__)
text = 's'
path = os.path.join(test_dir, text)
line = '!cat {}'.format(path)
endidx = len(line)
begidx = endidx - len(text)
assert cmd2_app.path_complete(text, line, begidx, endidx) == ['script.py', 'script.txt', 'scripts' + os.path.sep]
def test_path_completion_nomatch(cmd2_app, request):
test_dir = os.path.dirname(request.module.__file__)
text = 'z'
path = os.path.join(test_dir, text)
line = '!cat {}'.format(path)
endidx = len(line)
begidx = endidx - len(text)
assert cmd2_app.path_complete(text, line, begidx, endidx) == []
def test_path_completion_cwd(cmd2_app):
# Run path complete with no path and no search text
text = ''
line = '!ls {}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
completions_empty = cmd2_app.path_complete(text, line, begidx, endidx)
# Run path complete with path set to the CWD
cwd = os.getcwd()
line = '!ls {}'.format(cwd)
endidx = len(line)
begidx = endidx - len(text)
completions_cwd = cmd2_app.path_complete(text, line, begidx, endidx)
# Verify that the results are the same in both cases and that there is something there
assert completions_empty == completions_cwd
assert completions_cwd
def test_path_completion_doesnt_match_wildcards(cmd2_app, request):
test_dir = os.path.dirname(request.module.__file__)
text = 'c*'
path = os.path.join(test_dir, text)
line = '!cat {}'.format(path)
endidx = len(line)
begidx = endidx - len(text)
# Currently path completion doesn't accept wildcards, so will always return empty results
assert cmd2_app.path_complete(text, line, begidx, endidx) == []
def test_path_completion_user_expansion(cmd2_app):
# Run path with just a tilde
text = ''
if sys.platform.startswith('win'):
line = '!dir ~\{}'.format(text)
else:
line = '!ls ~{}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
completions_tilde = cmd2_app.path_complete(text, line, begidx, endidx)
# Run path complete on the user's home directory
user_dir = os.path.expanduser('~')
if sys.platform.startswith('win'):
line = '!dir {}'.format(user_dir)
else:
line = '!ls {}'.format(user_dir)
endidx = len(line)
begidx = endidx - len(text)
completions_home = cmd2_app.path_complete(text, line, begidx, endidx)
# Verify that the results are the same in both cases
assert completions_tilde == completions_home
# This next assert fails on AppVeyor Windows containers, but works fine on my Windows 10 VM
if not sys.platform.startswith('win'):
# Verify that there is something there
assert completions_tilde
def test_path_completion_directories_only(cmd2_app, request):
test_dir = os.path.dirname(request.module.__file__)
text = 's'
path = os.path.join(test_dir, text)
line = '!cat {}'.format(path)
endidx = len(line)
begidx = endidx - len(text)
assert cmd2_app.path_complete(text, line, begidx, endidx, dir_only=True) == ['scripts' + os.path.sep]
def test_parseline_command_and_args(cmd2_app):
line = 'help history'
command, args, out_line = cmd2_app.parseline(line)
assert command == 'help'
assert args == 'history'
assert line == out_line
def test_parseline_emptyline(cmd2_app):
line = ''
command, args, out_line = cmd2_app.parseline(line)
assert command == None
assert args == None
assert line == out_line
def test_parseline_strips_line(cmd2_app):
line = ' help history '
command, args, out_line = cmd2_app.parseline(line)
assert command == 'help'
assert args == 'history'
assert line.strip() == out_line
def test_parseline_expands_shortcuts(cmd2_app):
line = '!cat foobar.txt'
command, args, out_line = cmd2_app.parseline(line)
assert command == 'shell'
assert args == 'cat foobar.txt'
assert line.replace('!', 'shell ') == out_line
|
