/
test_completer.py
410 lines (369 loc) · 14.7 KB
/
test_completer.py
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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
# Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
import pprint
import difflib
import mock
from botocore.compat import OrderedDict
from botocore.model import OperationModel
from awscli.clidriver import (
CLIDriver, ServiceCommand, ServiceOperation, CLICommand)
from awscli.arguments import BaseCLIArgument, CustomArgument
from awscli.help import ProviderHelpCommand
from awscli.completer import Completer
from awscli.testutils import unittest
from awscli.customizations.commands import BasicCommand
class BaseCompleterTest(unittest.TestCase):
def setUp(self):
self.clidriver_creator = MockCLIDriverFactory()
def assert_completion(self, completer, cmdline, expected_results,
point=None):
if point is None:
point = len(cmdline)
actual = set(completer.complete(cmdline, point))
expected = set(expected_results)
if not actual == expected:
# Borrowed from assertDictEqual, though this doesn't
# handle the case when unicode literals are used in one
# dict but not in the other (and we want to consider them
# as being equal).
pretty_d1 = pprint.pformat(actual, width=1).splitlines()
pretty_d2 = pprint.pformat(expected, width=1).splitlines()
diff = ('\n' + '\n'.join(difflib.ndiff(pretty_d1, pretty_d2)))
raise AssertionError("Results are not equal:\n%s" % diff)
self.assertEqual(actual, expected)
class TestCompleter(BaseCompleterTest):
def test_complete_services(self):
commands = {
'subcommands': {
'foo': {},
'bar': {
'subcommands': {
'baz': {}
}
}
},
'arguments': []
}
completer = Completer(
self.clidriver_creator.create_clidriver(commands))
self.assert_completion(completer, 'aws ', ['foo', 'bar'])
def test_complete_partial_service_name(self):
commands = {
'subcommands': {
'cloudfront': {},
'cloudformation': {},
'cloudhsm': {},
'sts': {}
},
'arguments': []
}
completer = Completer(
self.clidriver_creator.create_clidriver(commands))
self.assert_completion(completer, 'aws cloud', [
'cloudfront', 'cloudformation', 'cloudhsm'])
self.assert_completion(completer, 'aws cloudf', [
'cloudfront', 'cloudformation'])
self.assert_completion(completer, 'aws cloudfr', ['cloudfront'])
self.assert_completion(completer, 'aws cloudfront', [])
def test_complete_on_invalid_service(self):
commands = {
'subcommands': {
'foo': {},
'bar': {
'subcommands': {
'baz': {}
}
}
},
'arguments': []
}
completer = Completer(
self.clidriver_creator.create_clidriver(commands))
self.assert_completion(completer, 'aws bin', [])
def test_complete_top_level_args(self):
commands = {
'subcommands': {},
'arguments': ['foo', 'bar']
}
completer = Completer(
self.clidriver_creator.create_clidriver(commands))
self.assert_completion(completer, 'aws --', ['--foo', '--bar'])
def test_complete_partial_top_level_arg(self):
commands = {
'subcommands': {},
'arguments': ['foo', 'bar', 'foobar', 'fubar']
}
completer = Completer(
self.clidriver_creator.create_clidriver(commands))
self.assert_completion(completer, 'aws --f', [
'--foo', '--fubar', '--foobar'])
self.assert_completion(completer, 'aws --fo', [
'--foo', '--foobar'])
self.assert_completion(completer, 'aws --foob', ['--foobar'])
self.assert_completion(completer, 'aws --foobar', [])
def test_complete_top_level_arg_with_arg_already_used(self):
commands = {
'subcommands': {
'baz': {}
},
'arguments': ['foo', 'bar']
}
completer = Completer(
self.clidriver_creator.create_clidriver(commands))
self.assert_completion(completer, 'aws --foo --f', [])
def test_complete_service_commands(self):
commands = {
'subcommands': {
'foo': {
'subcommands': {
'bar': {
'arguments': ['bin']
},
'baz': {}
}
}
},
'arguments': []
}
completer = Completer(
self.clidriver_creator.create_clidriver(commands))
self.assert_completion(completer, 'aws foo ', ['bar', 'baz'])
def test_complete_partial_service_commands(self):
commands = {
'subcommands': {
'foo': {
'subcommands': {
'barb': {
'arguments': ['nil']
},
'baz': {},
'biz': {},
'foobar': {}
}
}
},
'arguments': []
}
completer = Completer(
self.clidriver_creator.create_clidriver(commands))
self.assert_completion(completer, 'aws foo b', ['barb', 'baz', 'biz'])
self.assert_completion(completer, 'aws foo ba', ['barb', 'baz'])
self.assert_completion(completer, 'aws foo bar', ['barb'])
self.assert_completion(completer, 'aws foo barb', [])
def test_complete_service_arguments(self):
commands = {
'subcommands': {
'foo': {}
},
'arguments': ['baz', 'bin']
}
completer = Completer(
self.clidriver_creator.create_clidriver(commands))
self.assert_completion(completer, 'aws foo --', ['--baz', '--bin'])
def test_complete_partial_service_arguments(self):
commands = {
'subcommands': {
'biz': {}
},
'arguments': ['foo', 'bar', 'foobar', 'fubar']
}
completer = Completer(
self.clidriver_creator.create_clidriver(commands))
self.assert_completion(completer, 'aws biz --f', [
'--foo', '--fubar', '--foobar'])
self.assert_completion(completer, 'aws biz --fo', [
'--foo', '--foobar'])
self.assert_completion(completer, 'aws biz --foob', ['--foobar'])
def test_complete_service_arg_with_arg_already_used(self):
commands = {
'subcommands': {
'baz': {}
},
'arguments': ['foo', 'bar']
}
completer = Completer(
self.clidriver_creator.create_clidriver(commands))
self.assert_completion(completer, 'aws baz --foo --f', [])
def test_complete_operation_arguments(self):
commands = {
'subcommands': {
'foo': {'subcommands': {
'bar': {'arguments': ['baz']}
}}
},
'arguments': ['bin']
}
completer = Completer(
self.clidriver_creator.create_clidriver(commands))
self.assert_completion(completer, 'aws foo bar --', ['--baz', '--bin'])
def test_complete_partial_operation_arguments(self):
commands = {
'subcommands': {
'foo': {'subcommands': {
'bar': {'arguments': ['base', 'baz', 'air']}
}}
},
'arguments': ['bin']
}
completer = Completer(
self.clidriver_creator.create_clidriver(commands))
self.assert_completion(completer, 'aws foo bar --b', [
'--base', '--baz', '--bin'])
self.assert_completion(completer, 'aws foo bar --ba', [
'--base', '--baz'])
self.assert_completion(completer, 'aws foo bar --bas', ['--base'])
self.assert_completion(completer, 'aws foo bar --base', [])
def test_complete_operation_arg_when_arg_already_used(self):
commands = {
'subcommands': {
'foo': {'subcommands': {
'bar': {'arguments': ['baz']}
}}
},
'arguments': []
}
completer = Completer(
self.clidriver_creator.create_clidriver(commands))
self.assert_completion(completer, 'aws foo bar --baz --b', [])
def test_complete_positional_argument(self):
commands = {
'subcommands': {
'foo': {'subcommands': {
'bar': {'arguments': [
'baz',
CustomArgument('bin', positional_arg=True)
]}
}}
},
'arguments': []
}
completer = Completer(
self.clidriver_creator.create_clidriver(commands))
self.assert_completion(completer, 'aws foo bar --bin ', [])
self.assert_completion(completer, 'aws foo bar --bin blah --',
['--baz'])
def test_complete_undocumented_command(self):
class UndocumentedCommand(CLICommand):
_UNDOCUMENTED = True
commands = {
'subcommands': {
'foo': {},
'bar': UndocumentedCommand()
},
'arguments': []
}
completer = Completer(
self.clidriver_creator.create_clidriver(commands))
self.assert_completion(completer, 'aws ', ['foo'])
class TestCompleteCustomCommands(BaseCompleterTest):
def setUp(self):
super(TestCompleteCustomCommands, self).setUp()
custom_arguments = [
{'name': 'recursive'},
{'name': 'sse'}
]
custom_commands = [
self.create_custom_command('mb'),
self.create_custom_command('mv'),
self.create_custom_command('cp', arguments=custom_arguments)
]
custom_service = self.create_custom_command('s3', custom_commands)
clidriver = self.clidriver_creator.create_clidriver({
'subcommands': {
's3': custom_service['command_class'](mock.Mock()),
'foo': {}
},
'arguments': ['bar']
})
self.completer = Completer(clidriver)
def create_custom_command(self, name, sub_commands=None, arguments=None):
arg_table = arguments
if arg_table is None:
arg_table = []
subs = sub_commands
if subs is None:
subs = []
class CustomCommand(BasicCommand):
NAME = name
ARG_TABLE = arg_table
SUBCOMMANDS = subs
return {'name': name, 'command_class': CustomCommand}
def test_complete_custom_service(self):
self.assert_completion(self.completer, 'aws ', ['s3', 'foo'])
def test_complete_custom_command(self):
self.assert_completion(self.completer, 'aws s3 ', ['mb', 'mv', 'cp'])
def test_complete_partial_custom_command(self):
self.assert_completion(self.completer, 'aws s3 m', ['mb', 'mv'])
def test_complete_custom_command_arguments(self):
self.assert_completion(self.completer, 'aws s3 cp --', [
'--bar', '--recursive', '--sse'])
def test_complete_custom_command_arguments_with_arg_already_used(self):
self.assert_completion(self.completer, 'aws s3 cp --recursive --', [
'--bar', '--sse'])
class MockCLIDriverFactory(object):
def create_clidriver(self, commands=None, profiles=None):
session = mock.Mock()
session.get_data.return_value = None
if profiles is not None and isinstance(profiles, list):
session.available_profiles = profiles
else:
session.available_profiles = ['default']
clidriver = mock.Mock(spec=CLIDriver)
clidriver.create_help_command.return_value = \
self._create_top_level_help(commands, session)
clidriver.session = session
return clidriver
def _create_top_level_help(self, commands, session):
command_table = self.create_command_table(
commands.get('subcommands', {}), self._create_service_command)
argument_table = self.create_argument_table(
commands.get('arguments', []))
return ProviderHelpCommand(
session, command_table, argument_table, None, None, None)
def _create_service_command(self, name, command):
command_table = self.create_command_table(
command.get('subcommands', {}), self._create_operation_command)
service_command = ServiceCommand(name, None)
service_command._service_model = {}
service_command._command_table = command_table
return service_command
def _create_operation_command(self, name, command):
argument_table = self.create_argument_table(
command.get('arguments', []))
mock_operation = mock.Mock(spec=OperationModel)
mock_operation.deprecated = False
operation = ServiceOperation(name, 'parent', None, mock_operation,
None)
operation._arg_table = argument_table
return operation
def create_command_table(self, commands, command_creator):
if not commands:
return OrderedDict()
command_table = OrderedDict()
for name, command in commands.items():
if isinstance(command, CLICommand):
# Already a valid command, no need to fake one
command_table[name] = command
else:
command_table[name] = command_creator(name, command)
return command_table
def create_argument_table(self, arguments):
if not arguments:
return OrderedDict()
argument_table = OrderedDict()
for arg in arguments:
if isinstance(arg, BaseCLIArgument):
argument_table[arg.name] = arg
else:
argument_table[arg] = BaseCLIArgument(arg)
return argument_table