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
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License 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.
from unittest import mock
import testscenarios # type: ignore
from cliff import command
from cliff import commandmanager
from cliff.tests import base
from cliff.tests import utils
load_tests = testscenarios.load_tests_apply_scenarios
class TestLookupAndFind(base.TestBase):
scenarios = [
('one-word', {'argv': ['one']}),
('two-words', {'argv': ['two', 'words']}),
('three-words', {'argv': ['three', 'word', 'command']}),
]
argv: list[str]
def test(self):
mgr = utils.TestCommandManager(utils.TEST_NAMESPACE)
cmd, name, remaining = mgr.find_command(self.argv)
self.assertTrue(cmd)
self.assertEqual(' '.join(self.argv), name)
self.assertFalse(remaining)
class TestLookupWithRemainder(base.TestBase):
scenarios = [
('one', {'argv': ['one', '--opt']}),
('two', {'argv': ['two', 'words', '--opt']}),
('three', {'argv': ['three', 'word', 'command', '--opt']}),
]
argv: list[str]
def test(self):
mgr = utils.TestCommandManager(utils.TEST_NAMESPACE)
cmd, name, remaining = mgr.find_command(self.argv)
self.assertTrue(cmd)
self.assertEqual(['--opt'], remaining)
class TestFindInvalidCommand(base.TestBase):
scenarios = [
('no-such-command', {'argv': ['a', '-b']}),
('no-command-given', {'argv': ['-b']}),
]
argv: list[str]
def test(self):
mgr = utils.TestCommandManager(utils.TEST_NAMESPACE)
try:
mgr.find_command(self.argv)
except ValueError as err:
# make sure err include 'a' when ['a', '-b']
self.assertIn(self.argv[0], str(err))
self.assertIn('-b', str(err))
else:
self.fail('expected a failure')
class TestFindUnknownCommand(base.TestBase):
def test(self):
mgr = utils.TestCommandManager(utils.TEST_NAMESPACE)
try:
mgr.find_command(['a', 'b'])
except ValueError as err:
self.assertIn("['a', 'b']", str(err))
else:
self.fail('expected a failure')
class FooCommand(command.Command):
"""Description of foo command."""
def take_action(self, parsed_args):
return 'foo'
class FooBarCommand(command.Command):
"""Description of foobar command."""
def take_action(self, parsed_args):
return 'foobar'
class TestDynamicCommands(base.TestBase):
def test_add(self):
mgr = utils.TestCommandManager(utils.TEST_NAMESPACE)
mock_cmd = mock.Mock()
mgr.add_command('mock', mock_cmd)
found_cmd, name, args = mgr.find_command(['mock'])
self.assertIs(mock_cmd, found_cmd)
def test_intersected_commands(self):
mgr = utils.TestCommandManager(utils.TEST_NAMESPACE)
mgr.add_command('foo', FooCommand)
mgr.add_command('foo bar', FooBarCommand)
self.assertIs(FooBarCommand, mgr.find_command(['foo', 'bar'])[0])
self.assertIs(FooCommand, mgr.find_command(['foo', 'arg0'])[0])
class TestLoad(base.TestBase):
def test_load_commands(self):
testcmd = mock.Mock()
testcmd.name = 'test_cmd'
testcmd.module_name = 'module.a'
mock_get_group_all = mock.Mock(return_value=[testcmd])
with mock.patch(
'stevedore.ExtensionManager', mock_get_group_all
) as mock_manager:
mgr = commandmanager.CommandManager('test')
mock_manager.assert_called_once_with('test')
names = [n for n, v in mgr]
self.assertEqual(['test cmd'], names)
def test_load_commands_keep_underscores(self):
testcmd = mock.Mock()
testcmd.name = 'test_cmd'
testcmd.module_name = 'module.a'
mock_get_group_all = mock.Mock(return_value=[testcmd])
with mock.patch(
'stevedore.ExtensionManager', mock_get_group_all
) as mock_manager:
mgr = commandmanager.CommandManager(
'test',
convert_underscores=False,
)
mock_manager.assert_called_once_with('test')
names = [n for n, v in mgr]
self.assertEqual(['test_cmd'], names)
def test_load_commands_ignore_modules(self):
testcmd_normal = mock.Mock()
testcmd_normal.name = 'normal_cmd'
testcmd_normal.module_name = 'normal.module'
testcmd_ignored = mock.Mock()
testcmd_ignored.name = 'ignored_cmd'
testcmd_ignored.module_name = 'ignored.module'
mock_get_group_all = mock.Mock(
return_value=[testcmd_normal, testcmd_ignored]
)
with mock.patch(
'stevedore.ExtensionManager', mock_get_group_all
) as mock_manager:
mgr = commandmanager.CommandManager(
'test',
ignored_modules=['ignored.module'],
)
mock_manager.assert_called_once_with('test')
names = [n for n, v in mgr]
self.assertEqual(['normal cmd'], names)
def test_load_commands_duplicates(self):
testcmd_a = mock.Mock()
testcmd_a.name = 'test_cmd'
testcmd_a.module_name = 'module.a'
testcmd_a.entry_point.value = 'module.a:TestCmd'
testcmd_b = mock.Mock()
testcmd_b.name = 'test_cmd'
testcmd_b.module_name = 'module.b'
testcmd_b.entry_point.value = 'module.b:TestCmd'
mock_get_group_all = mock.Mock(return_value=[testcmd_a, testcmd_b])
with mock.patch(
'stevedore.ExtensionManager', mock_get_group_all
) as mock_manager:
mgr = commandmanager.CommandManager('test')
mock_manager.assert_called_once_with('test')
names = [n for n, v in mgr]
commands = [v for _, v in mgr]
self.assertEqual(['test cmd'], names)
# we should have ended up with the second command
self.assertEqual([testcmd_b.entry_point], commands)
self.assertIn(
"found duplicate implementations of the 'test cmd' command",
self.logger.output,
)
class FauxCommand(command.Command):
def take_action(self, parsed_args):
return 0
class FauxCommand2(FauxCommand):
pass
class TestLegacyCommand(base.TestBase):
def test_find_legacy(self):
mgr = utils.TestCommandManager(utils.TEST_NAMESPACE)
mgr.add_command('new name', FauxCommand)
mgr.add_legacy_command('old name', 'new name')
cmd, name, remaining = mgr.find_command(['old', 'name'])
self.assertIs(cmd, FauxCommand)
self.assertEqual(name, 'old name')
def test_legacy_overrides_new(self):
mgr = utils.TestCommandManager(utils.TEST_NAMESPACE)
mgr.add_command('cmd1', FauxCommand)
mgr.add_command('cmd2', FauxCommand2)
mgr.add_legacy_command('cmd2', 'cmd1')
cmd, name, remaining = mgr.find_command(['cmd2'])
self.assertIs(cmd, FauxCommand)
self.assertEqual(name, 'cmd2')
def test_no_legacy(self):
mgr = utils.TestCommandManager(utils.TEST_NAMESPACE)
mgr.add_command('cmd1', FauxCommand)
self.assertRaises(
ValueError,
mgr.find_command,
['cmd2'],
)
def test_no_command(self):
mgr = utils.TestCommandManager(utils.TEST_NAMESPACE)
mgr.add_legacy_command('cmd2', 'cmd1')
self.assertRaises(
ValueError,
mgr.find_command,
['cmd2'],
)
class TestLookupAndFindPartialName(base.TestBase):
scenarios = [
('one-word', {'argv': ['o']}),
('two-words', {'argv': ['t', 'w']}),
('three-words', {'argv': ['t', 'w', 'c']}),
]
argv: list[str]
def test(self):
mgr = utils.TestCommandManager(utils.TEST_NAMESPACE)
cmd, name, remaining = mgr.find_command(self.argv)
self.assertTrue(cmd)
self.assertEqual(' '.join(self.argv), name)
self.assertFalse(remaining)
class TestIsModuleIgnored(base.TestBase):
def test_match(self):
result = commandmanager.CommandManager._is_module_ignored(
'foo.bar.baz', ['foo.bar.baz', 'other.module']
)
self.assertTrue(result)
result = commandmanager.CommandManager._is_module_ignored(
'foo.bar.baz', ['foo.bar', 'other.module']
)
self.assertTrue(result)
result = commandmanager.CommandManager._is_module_ignored(
'foo.bar.baz', ['foo', 'other.module']
)
self.assertTrue(result)
def test_no_match(self):
result = commandmanager.CommandManager._is_module_ignored(
'foo.bar.baz', ['other.module', 'another.package']
)
self.assertFalse(result)
def test_no_ignores(self):
result = commandmanager.CommandManager._is_module_ignored(
'foo.bar.baz', []
)
self.assertFalse(result)
class TestGetByPartialName(base.TestBase):
def setUp(self):
super().setUp()
self.commands = {
'resource provider list': 1,
'resource class list': 2,
'server list': 3,
'service list': 4,
}
def test_no_candidates(self):
self.assertEqual(
[],
commandmanager._get_commands_by_partial_name(
['r', 'p'], list(self.commands)
),
)
self.assertEqual(
[],
commandmanager._get_commands_by_partial_name(
['r', 'p', 'c'], list(self.commands)
),
)
def test_multiple_candidates(self):
self.assertEqual(
2,
len(
commandmanager._get_commands_by_partial_name(
['se', 'li'], list(self.commands)
)
),
)
def test_one_candidate(self):
self.assertEqual(
['resource provider list'],
commandmanager._get_commands_by_partial_name(
['r', 'p', 'l'], list(self.commands)
),
)
self.assertEqual(
['resource provider list'],
commandmanager._get_commands_by_partial_name(
['resource', 'provider', 'list'], list(self.commands)
),
)
self.assertEqual(
['server list'],
commandmanager._get_commands_by_partial_name(
['serve', 'l'], list(self.commands)
),
)
FAKE_CMD_ONE = commandmanager.EntryPointWrapper('one', utils.TestCommand)
FAKE_CMD_TWO = commandmanager.EntryPointWrapper('two', utils.TestCommand)
FAKE_CMD_ALPHA = commandmanager.EntryPointWrapper('alpha', utils.TestCommand)
FAKE_CMD_BETA = commandmanager.EntryPointWrapper('beta', utils.TestCommand)
class FakeCommandManager(commandmanager.CommandManager):
commands = {}
def load_commands(self, namespace):
if namespace == 'test':
self.commands['one'] = FAKE_CMD_ONE
self.commands['two'] = FAKE_CMD_TWO
self.group_list.append(namespace)
elif namespace == 'greek':
self.commands['alpha'] = FAKE_CMD_ALPHA
self.commands['beta'] = FAKE_CMD_BETA
self.group_list.append(namespace)
class TestCommandManagerGroups(base.TestBase):
def test_add_command_group(self):
mgr = FakeCommandManager('test')
# Make sure add_command() still functions
mock_cmd_one = mock.Mock()
mgr.add_command('mock', mock_cmd_one)
cmd_mock, name, args = mgr.find_command(['mock'])
self.assertEqual(mock_cmd_one, cmd_mock)
# Find a command added in initialization
cmd_one, name, args = mgr.find_command(['one'])
self.assertEqual(FAKE_CMD_ONE.load(), cmd_one)
# Load another command group
mgr.add_command_group('greek')
# Find a new command
cmd_alpha, name, args = mgr.find_command(['alpha'])
self.assertEqual(FAKE_CMD_ALPHA.load(), cmd_alpha)
# Ensure that the original commands were not overwritten
cmd_two, name, args = mgr.find_command(['two'])
self.assertEqual(FAKE_CMD_TWO.load(), cmd_two)
def test_get_command_groups(self):
mgr = FakeCommandManager('test')
# Make sure add_command() still functions
mock_cmd_one = mock.Mock()
mgr.add_command('mock', mock_cmd_one)
cmd_mock, name, args = mgr.find_command(['mock'])
self.assertEqual(mock_cmd_one, cmd_mock)
# Load another command group
mgr.add_command_group('greek')
gl = mgr.get_command_groups()
self.assertEqual(['test', 'greek'], gl)
def test_get_command_names(self):
mock_cmd_one = mock.Mock()
mock_cmd_one.name = 'one'
mock_cmd_one.module_name = 'module.a'
mock_cmd_two = mock.Mock()
mock_cmd_two.name = 'cmd two'
mock_cmd_two.module_name = 'module.b'
mock_get_group_all = mock.Mock(
return_value=[mock_cmd_one, mock_cmd_two],
)
with mock.patch(
'stevedore.ExtensionManager',
mock_get_group_all,
) as mock_manager:
mgr = commandmanager.CommandManager('test')
mock_manager.assert_called_once_with('test')
cmds = mgr.get_command_names('test')
mock_manager.assert_has_calls(
[mock.call('test'), mock.call('test')]
)
self.assertEqual(['one', 'cmd two'], cmds)
|
