1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from cStringIO import StringIO
31
from bzrlib.commands import display_command
32
from bzrlib.tests import TestSkipped
35
class TestCommands(tests.TestCase):
37
def test_all_commands_have_help(self):
38
commands._register_builtin_commands()
39
commands_without_help = set()
40
base_doc = inspect.getdoc(commands.Command)
41
for cmd_name in commands.all_command_names():
42
cmd = commands.get_cmd_object(cmd_name)
44
if not cmd_help or cmd_help == base_doc:
45
commands_without_help.append(cmd_name)
46
self.assertLength(0, commands_without_help)
48
def test_display_command(self):
49
"""EPIPE message is selectively suppressed"""
51
raise IOError(errno.EPIPE, "Bogus pipe error")
52
self.assertRaises(IOError, pipe_thrower)
59
raise IOError(errno.ESPIPE, "Bogus pipe error")
60
self.assertRaises(IOError, other_thrower)
62
def test_unicode_command(self):
63
# This error is thrown when we can't find the command in the
64
# list of available commands
65
self.assertRaises(errors.BzrCommandError,
66
commands.run_bzr, [u'cmd\xb5'])
68
def test_unicode_option(self):
69
# This error is actually thrown by optparse, when it
70
# can't find the given option
72
if optparse.__version__ == "1.5.3":
73
raise TestSkipped("optparse 1.5.3 can't handle unicode options")
74
self.assertRaises(errors.BzrCommandError,
75
commands.run_bzr, ['log', u'--option\xb5'])
78
def get_command(options):
79
class cmd_foo(commands.Command):
82
takes_options = options
86
def test_help_hidden(self):
87
c = self.get_command([option.Option('foo', hidden=True)])
88
self.assertNotContainsRe(c.get_help_text(), '--foo')
90
def test_help_not_hidden(self):
91
c = self.get_command([option.Option('foo', hidden=False)])
92
self.assertContainsRe(c.get_help_text(), '--foo')
95
class TestGetAlias(tests.TestCase):
97
def _get_config(self, config_text):
98
my_config = config.GlobalConfig.from_string(config_text)
101
def test_simple(self):
102
my_config = self._get_config("[ALIASES]\n"
103
"diff=diff -r -2..-1\n")
104
self.assertEqual([u'diff', u'-r', u'-2..-1'],
105
commands.get_alias("diff", config=my_config))
107
def test_single_quotes(self):
108
my_config = self._get_config("[ALIASES]\n"
109
"diff=diff -r -2..-1 --diff-options "
110
"'--strip-trailing-cr -wp'\n")
111
self.assertEqual([u'diff', u'-r', u'-2..-1', u'--diff-options',
112
u'--strip-trailing-cr -wp'],
113
commands.get_alias("diff", config=my_config))
115
def test_double_quotes(self):
116
my_config = self._get_config("[ALIASES]\n"
117
"diff=diff -r -2..-1 --diff-options "
118
"\"--strip-trailing-cr -wp\"\n")
119
self.assertEqual([u'diff', u'-r', u'-2..-1', u'--diff-options',
120
u'--strip-trailing-cr -wp'],
121
commands.get_alias("diff", config=my_config))
123
def test_unicode(self):
124
my_config = self._get_config("[ALIASES]\n"
125
u'iam=whoami "Erik B\u00e5gfors <erik@bagfors.nu>"\n')
126
self.assertEqual([u'whoami', u'Erik B\u00e5gfors <erik@bagfors.nu>'],
127
commands.get_alias("iam", config=my_config))
130
class TestSeeAlso(tests.TestCase):
131
"""Tests for the see also functional of Command."""
134
def _get_command_with_see_also(see_also):
135
class ACommand(commands.Command):
136
__doc__ = """A sample command."""
140
def test_default_subclass_no_see_also(self):
141
command = self._get_command_with_see_also([])
142
self.assertEqual([], command.get_see_also())
144
def test__see_also(self):
145
"""When _see_also is defined, it sets the result of get_see_also()."""
146
command = self._get_command_with_see_also(['bar', 'foo'])
147
self.assertEqual(['bar', 'foo'], command.get_see_also())
149
def test_deduplication(self):
150
"""Duplicates in _see_also are stripped out."""
151
command = self._get_command_with_see_also(['foo', 'foo'])
152
self.assertEqual(['foo'], command.get_see_also())
154
def test_sorted(self):
155
"""_see_also is sorted by get_see_also."""
156
command = self._get_command_with_see_also(['foo', 'bar'])
157
self.assertEqual(['bar', 'foo'], command.get_see_also())
159
def test_additional_terms(self):
160
"""Additional terms can be supplied and are deduped and sorted."""
161
command = self._get_command_with_see_also(['foo', 'bar'])
162
self.assertEqual(['bar', 'foo', 'gam'],
163
command.get_see_also(['gam', 'bar', 'gam']))
166
class TestRegisterLazy(tests.TestCase):
169
tests.TestCase.setUp(self)
170
import bzrlib.tests.fake_command
171
del sys.modules['bzrlib.tests.fake_command']
172
global lazy_command_imported
173
lazy_command_imported = False
174
commands.install_bzr_command_hooks()
178
commands.plugin_cmds.remove('fake')
180
def assertIsFakeCommand(self, cmd_obj):
181
from bzrlib.tests.fake_command import cmd_fake
182
self.assertIsInstance(cmd_obj, cmd_fake)
184
def test_register_lazy(self):
185
"""Ensure lazy registration works"""
186
commands.plugin_cmds.register_lazy('cmd_fake', [],
187
'bzrlib.tests.fake_command')
188
self.addCleanup(self.remove_fake)
189
self.assertFalse(lazy_command_imported)
190
fake_instance = commands.get_cmd_object('fake')
191
self.assertTrue(lazy_command_imported)
192
self.assertIsFakeCommand(fake_instance)
194
def test_get_unrelated_does_not_import(self):
195
commands.plugin_cmds.register_lazy('cmd_fake', [],
196
'bzrlib.tests.fake_command')
197
self.addCleanup(self.remove_fake)
198
commands.get_cmd_object('status')
199
self.assertFalse(lazy_command_imported)
201
def test_aliases(self):
202
commands.plugin_cmds.register_lazy('cmd_fake', ['fake_alias'],
203
'bzrlib.tests.fake_command')
204
self.addCleanup(self.remove_fake)
205
fake_instance = commands.get_cmd_object('fake_alias')
206
self.assertIsFakeCommand(fake_instance)
209
class TestExtendCommandHook(tests.TestCase):
211
def test_fires_on_get_cmd_object(self):
212
# The extend_command(cmd) hook fires when commands are delivered to the
213
# ui, not simply at registration (because lazy registered plugin
214
# commands are registered).
215
# when they are simply created.
217
commands.install_bzr_command_hooks()
218
commands.Command.hooks.install_named_hook(
219
"extend_command", hook_calls.append, None)
220
# create a command, should not fire
221
class cmd_test_extend_command_hook(commands.Command):
222
__doc__ = """A sample command."""
223
self.assertEqual([], hook_calls)
225
# register the command class, should not fire
227
commands.builtin_command_registry.register(cmd_test_extend_command_hook)
228
self.assertEqual([], hook_calls)
229
# and ask for the object, should fire
230
cmd = commands.get_cmd_object('test-extend-command-hook')
231
# For resilience - to ensure all code paths hit it - we
232
# fire on everything returned in the 'cmd_dict', which is currently
233
# all known commands, so assert that cmd is in hook_calls
234
self.assertSubset([cmd], hook_calls)
237
commands.builtin_command_registry.remove('test-extend-command-hook')
238
# -- as a plugin lazy registration
240
# register the command class, should not fire
241
commands.plugin_cmds.register_lazy('cmd_fake', [],
242
'bzrlib.tests.fake_command')
243
self.assertEqual([], hook_calls)
244
# and ask for the object, should fire
245
cmd = commands.get_cmd_object('fake')
246
self.assertEqual([cmd], hook_calls)
248
commands.plugin_cmds.remove('fake')
251
class TestGetCommandHook(tests.TestCase):
253
def test_fires_on_get_cmd_object(self):
254
# The get_command(cmd) hook fires when commands are delivered to the
256
commands.install_bzr_command_hooks()
258
class ACommand(commands.Command):
259
__doc__ = """A sample command."""
260
def get_cmd(cmd_or_None, cmd_name):
261
hook_calls.append(('called', cmd_or_None, cmd_name))
262
if cmd_name in ('foo', 'info'):
264
commands.Command.hooks.install_named_hook(
265
"get_command", get_cmd, None)
266
# create a command directly, should not fire
268
self.assertEqual([], hook_calls)
269
# ask by name, should fire and give us our command
270
cmd = commands.get_cmd_object('foo')
271
self.assertEqual([('called', None, 'foo')], hook_calls)
272
self.assertIsInstance(cmd, ACommand)
274
# ask by a name that is supplied by a builtin - the hook should still
275
# fire and we still get our object, but we should see the builtin
276
# passed to the hook.
277
cmd = commands.get_cmd_object('info')
278
self.assertIsInstance(cmd, ACommand)
279
self.assertEqual(1, len(hook_calls))
280
self.assertEqual('info', hook_calls[0][2])
281
self.assertIsInstance(hook_calls[0][1], builtins.cmd_info)
284
class TestGetMissingCommandHook(tests.TestCase):
286
def hook_missing(self):
287
"""Hook get_missing_command for testing."""
289
class ACommand(commands.Command):
290
__doc__ = """A sample command."""
291
def get_missing_cmd(cmd_name):
292
self.hook_calls.append(('called', cmd_name))
293
if cmd_name in ('foo', 'info'):
295
commands.Command.hooks.install_named_hook(
296
"get_missing_command", get_missing_cmd, None)
297
self.ACommand = ACommand
299
def test_fires_on_get_cmd_object(self):
300
# The get_missing_command(cmd) hook fires when commands are delivered to the
303
# create a command directly, should not fire
304
self.cmd = self.ACommand()
305
self.assertEqual([], self.hook_calls)
306
# ask by name, should fire and give us our command
307
cmd = commands.get_cmd_object('foo')
308
self.assertEqual([('called', 'foo')], self.hook_calls)
309
self.assertIsInstance(cmd, self.ACommand)
310
del self.hook_calls[:]
311
# ask by a name that is supplied by a builtin - the hook should not
312
# fire and we still get our object.
313
commands.install_bzr_command_hooks()
314
cmd = commands.get_cmd_object('info')
315
self.assertNotEqual(None, cmd)
316
self.assertEqual(0, len(self.hook_calls))
318
def test_skipped_on_HelpCommandIndex_get_topics(self):
319
# The get_missing_command(cmd_name) hook is not fired when
320
# looking up help topics.
322
topic = commands.HelpCommandIndex()
323
topics = topic.get_topics('foo')
324
self.assertEqual([], self.hook_calls)
327
class TestListCommandHook(tests.TestCase):
329
def test_fires_on_all_command_names(self):
330
# The list_commands() hook fires when all_command_names() is invoked.
332
commands.install_bzr_command_hooks()
333
def list_my_commands(cmd_names):
334
hook_calls.append('called')
335
cmd_names.update(['foo', 'bar'])
337
commands.Command.hooks.install_named_hook(
338
"list_commands", list_my_commands, None)
339
# Get a command, which should not trigger the hook.
340
cmd = commands.get_cmd_object('info')
341
self.assertEqual([], hook_calls)
342
# Get all command classes (for docs and shell completion).
343
cmds = list(commands.all_command_names())
344
self.assertEqual(['called'], hook_calls)
345
self.assertSubset(['foo', 'bar'], cmds)
348
class TestDeprecations(tests.TestCase):
350
def test_shlex_split_unicode_deprecation(self):
351
res = self.applyDeprecated(
352
symbol_versioning.deprecated_in((2, 2, 0)),
353
commands.shlex_split_unicode, 'whatever')
added
removed
bzrlib/tests/test_commands.py
