158
99
class TestSeeAlso(tests.TestCase):
159
100
"""Tests for the see also functional of Command."""
162
def _get_command_with_see_also(see_also):
163
class ACommand(commands.Command):
164
__doc__ = """A sample command."""
168
102
def test_default_subclass_no_see_also(self):
169
command = self._get_command_with_see_also([])
103
class ACommand(commands.Command):
104
"""A sample command."""
170
106
self.assertEqual([], command.get_see_also())
172
108
def test__see_also(self):
173
109
"""When _see_also is defined, it sets the result of get_see_also()."""
174
command = self._get_command_with_see_also(['bar', 'foo'])
110
class ACommand(commands.Command):
111
_see_also = ['bar', 'foo']
175
113
self.assertEqual(['bar', 'foo'], command.get_see_also())
177
115
def test_deduplication(self):
178
116
"""Duplicates in _see_also are stripped out."""
179
command = self._get_command_with_see_also(['foo', 'foo'])
117
class ACommand(commands.Command):
118
_see_also = ['foo', 'foo']
180
120
self.assertEqual(['foo'], command.get_see_also())
182
122
def test_sorted(self):
183
123
"""_see_also is sorted by get_see_also."""
184
command = self._get_command_with_see_also(['foo', 'bar'])
124
class ACommand(commands.Command):
125
_see_also = ['foo', 'bar']
185
127
self.assertEqual(['bar', 'foo'], command.get_see_also())
187
129
def test_additional_terms(self):
188
130
"""Additional terms can be supplied and are deduped and sorted."""
189
command = self._get_command_with_see_also(['foo', 'bar'])
131
class ACommand(commands.Command):
132
_see_also = ['foo', 'bar']
190
134
self.assertEqual(['bar', 'foo', 'gam'],
191
135
command.get_see_also(['gam', 'bar', 'gam']))
194
class TestRegisterLazy(tests.TestCase):
197
super(TestRegisterLazy, self).setUp()
198
import bzrlib.tests.fake_command
199
del sys.modules['bzrlib.tests.fake_command']
200
global lazy_command_imported
201
lazy_command_imported = False
202
commands.install_bzr_command_hooks()
206
commands.plugin_cmds.remove('fake')
208
def assertIsFakeCommand(self, cmd_obj):
209
from bzrlib.tests.fake_command import cmd_fake
210
self.assertIsInstance(cmd_obj, cmd_fake)
212
def test_register_lazy(self):
213
"""Ensure lazy registration works"""
214
commands.plugin_cmds.register_lazy('cmd_fake', [],
215
'bzrlib.tests.fake_command')
216
self.addCleanup(self.remove_fake)
217
self.assertFalse(lazy_command_imported)
218
fake_instance = commands.get_cmd_object('fake')
219
self.assertTrue(lazy_command_imported)
220
self.assertIsFakeCommand(fake_instance)
222
def test_get_unrelated_does_not_import(self):
223
commands.plugin_cmds.register_lazy('cmd_fake', [],
224
'bzrlib.tests.fake_command')
225
self.addCleanup(self.remove_fake)
226
commands.get_cmd_object('status')
227
self.assertFalse(lazy_command_imported)
229
def test_aliases(self):
230
commands.plugin_cmds.register_lazy('cmd_fake', ['fake_alias'],
231
'bzrlib.tests.fake_command')
232
self.addCleanup(self.remove_fake)
233
fake_instance = commands.get_cmd_object('fake_alias')
234
self.assertIsFakeCommand(fake_instance)
237
class TestExtendCommandHook(tests.TestCase):
239
def test_fires_on_get_cmd_object(self):
240
# The extend_command(cmd) hook fires when commands are delivered to the
241
# ui, not simply at registration (because lazy registered plugin
242
# commands are registered).
243
# when they are simply created.
245
commands.install_bzr_command_hooks()
246
commands.Command.hooks.install_named_hook(
247
"extend_command", hook_calls.append, None)
248
# create a command, should not fire
249
class cmd_test_extend_command_hook(commands.Command):
250
__doc__ = """A sample command."""
251
self.assertEqual([], hook_calls)
253
# register the command class, should not fire
255
commands.builtin_command_registry.register(cmd_test_extend_command_hook)
256
self.assertEqual([], hook_calls)
257
# and ask for the object, should fire
258
cmd = commands.get_cmd_object('test-extend-command-hook')
259
# For resilience - to ensure all code paths hit it - we
260
# fire on everything returned in the 'cmd_dict', which is currently
261
# all known commands, so assert that cmd is in hook_calls
262
self.assertSubset([cmd], hook_calls)
265
commands.builtin_command_registry.remove('test-extend-command-hook')
266
# -- as a plugin lazy registration
268
# register the command class, should not fire
269
commands.plugin_cmds.register_lazy('cmd_fake', [],
270
'bzrlib.tests.fake_command')
271
self.assertEqual([], hook_calls)
272
# and ask for the object, should fire
273
cmd = commands.get_cmd_object('fake')
274
self.assertEqual([cmd], hook_calls)
276
commands.plugin_cmds.remove('fake')
279
class TestGetCommandHook(tests.TestCase):
281
def test_fires_on_get_cmd_object(self):
282
# The get_command(cmd) hook fires when commands are delivered to the
284
commands.install_bzr_command_hooks()
286
class ACommand(commands.Command):
287
__doc__ = """A sample command."""
288
def get_cmd(cmd_or_None, cmd_name):
289
hook_calls.append(('called', cmd_or_None, cmd_name))
290
if cmd_name in ('foo', 'info'):
292
commands.Command.hooks.install_named_hook(
293
"get_command", get_cmd, None)
294
# create a command directly, should not fire
296
self.assertEqual([], hook_calls)
297
# ask by name, should fire and give us our command
298
cmd = commands.get_cmd_object('foo')
299
self.assertEqual([('called', None, 'foo')], hook_calls)
300
self.assertIsInstance(cmd, ACommand)
302
# ask by a name that is supplied by a builtin - the hook should still
303
# fire and we still get our object, but we should see the builtin
304
# passed to the hook.
305
cmd = commands.get_cmd_object('info')
306
self.assertIsInstance(cmd, ACommand)
307
self.assertEqual(1, len(hook_calls))
308
self.assertEqual('info', hook_calls[0][2])
309
self.assertIsInstance(hook_calls[0][1], builtins.cmd_info)
312
class TestGetMissingCommandHook(tests.TestCase):
314
def hook_missing(self):
315
"""Hook get_missing_command for testing."""
317
class ACommand(commands.Command):
318
__doc__ = """A sample command."""
319
def get_missing_cmd(cmd_name):
320
self.hook_calls.append(('called', cmd_name))
321
if cmd_name in ('foo', 'info'):
323
commands.Command.hooks.install_named_hook(
324
"get_missing_command", get_missing_cmd, None)
325
self.ACommand = ACommand
327
def test_fires_on_get_cmd_object(self):
328
# The get_missing_command(cmd) hook fires when commands are delivered to the
331
# create a command directly, should not fire
332
self.cmd = self.ACommand()
333
self.assertEqual([], self.hook_calls)
334
# ask by name, should fire and give us our command
335
cmd = commands.get_cmd_object('foo')
336
self.assertEqual([('called', 'foo')], self.hook_calls)
337
self.assertIsInstance(cmd, self.ACommand)
338
del self.hook_calls[:]
339
# ask by a name that is supplied by a builtin - the hook should not
340
# fire and we still get our object.
341
commands.install_bzr_command_hooks()
342
cmd = commands.get_cmd_object('info')
343
self.assertNotEqual(None, cmd)
344
self.assertEqual(0, len(self.hook_calls))
346
def test_skipped_on_HelpCommandIndex_get_topics(self):
347
# The get_missing_command(cmd_name) hook is not fired when
348
# looking up help topics.
350
topic = commands.HelpCommandIndex()
351
topics = topic.get_topics('foo')
352
self.assertEqual([], self.hook_calls)
355
class TestListCommandHook(tests.TestCase):
357
def test_fires_on_all_command_names(self):
358
# The list_commands() hook fires when all_command_names() is invoked.
360
commands.install_bzr_command_hooks()
361
def list_my_commands(cmd_names):
362
hook_calls.append('called')
363
cmd_names.update(['foo', 'bar'])
365
commands.Command.hooks.install_named_hook(
366
"list_commands", list_my_commands, None)
367
# Get a command, which should not trigger the hook.
368
cmd = commands.get_cmd_object('info')
369
self.assertEqual([], hook_calls)
370
# Get all command classes (for docs and shell completion).
371
cmds = list(commands.all_command_names())
372
self.assertEqual(['called'], hook_calls)
373
self.assertSubset(['foo', 'bar'], cmds)
375
class TestPreAndPostCommandHooks(tests.TestCase):
376
class TestError(StandardError):
377
__doc__ = """A test exception."""
379
def test_pre_and_post_hooks(self):
382
def pre_command(cmd):
383
self.assertEqual([], hook_calls)
384
hook_calls.append('pre')
386
def post_command(cmd):
387
self.assertEqual(['pre', 'run'], hook_calls)
388
hook_calls.append('post')
391
self.assertEqual(['pre'], hook_calls)
392
hook_calls.append('run')
394
self.overrideAttr(builtins.cmd_rocks, 'run', run)
395
commands.install_bzr_command_hooks()
396
commands.Command.hooks.install_named_hook(
397
"pre_command", pre_command, None)
398
commands.Command.hooks.install_named_hook(
399
"post_command", post_command, None)
401
self.assertEqual([], hook_calls)
402
self.run_bzr(['rocks', '-Oxx=12', '-Oyy=foo'])
403
self.assertEqual(['pre', 'run', 'post'], hook_calls)
405
def test_post_hook_provided_exception(self):
408
def post_command(cmd):
409
hook_calls.append('post')
412
hook_calls.append('run')
413
raise self.TestError()
415
self.overrideAttr(builtins.cmd_rocks, 'run', run)
416
commands.install_bzr_command_hooks()
417
commands.Command.hooks.install_named_hook(
418
"post_command", post_command, None)
420
self.assertEqual([], hook_calls)
421
self.assertRaises(self.TestError, commands.run_bzr, [u'rocks'])
422
self.assertEqual(['run', 'post'], hook_calls)
424
def test_pre_command_error(self):
425
"""Ensure an BzrCommandError in pre_command aborts the command"""
429
def pre_command(cmd):
430
hook_calls.append('pre')
431
# verify that all subclasses of BzrCommandError caught too
432
raise errors.BzrOptionError()
434
def post_command(cmd, e):
435
self.fail('post_command should not be called')
438
self.fail('command should not be called')
440
self.overrideAttr(builtins.cmd_rocks, 'run', run)
441
commands.install_bzr_command_hooks()
442
commands.Command.hooks.install_named_hook(
443
"pre_command", pre_command, None)
444
commands.Command.hooks.install_named_hook(
445
"post_command", post_command, None)
447
self.assertEqual([], hook_calls)
448
self.assertRaises(errors.BzrCommandError,
449
commands.run_bzr, [u'rocks'])
450
self.assertEqual(['pre'], hook_calls)
added
removed
bzrlib/tests/test_commands.py
