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()
99
config_file = StringIO(config_text.encode('utf-8'))
100
my_config._parser = my_config._get_parser(file=config_file)
103
def test_simple(self):
104
my_config = self._get_config("[ALIASES]\n"
105
"diff=diff -r -2..-1\n")
106
self.assertEqual([u'diff', u'-r', u'-2..-1'],
107
commands.get_alias("diff", config=my_config))
109
def test_single_quotes(self):
110
my_config = self._get_config("[ALIASES]\n"
111
"diff=diff -r -2..-1 --diff-options "
112
"'--strip-trailing-cr -wp'\n")
113
self.assertEqual([u'diff', u'-r', u'-2..-1', u'--diff-options',
114
u'--strip-trailing-cr -wp'],
115
commands.get_alias("diff", config=my_config))
117
def test_double_quotes(self):
118
my_config = self._get_config("[ALIASES]\n"
119
"diff=diff -r -2..-1 --diff-options "
120
"\"--strip-trailing-cr -wp\"\n")
121
self.assertEqual([u'diff', u'-r', u'-2..-1', u'--diff-options',
122
u'--strip-trailing-cr -wp'],
123
commands.get_alias("diff", config=my_config))
125
def test_unicode(self):
126
my_config = self._get_config("[ALIASES]\n"
127
u'iam=whoami "Erik B\u00e5gfors <erik@bagfors.nu>"\n')
128
self.assertEqual([u'whoami', u'Erik B\u00e5gfors <erik@bagfors.nu>'],
129
commands.get_alias("iam", config=my_config))
132
class TestSeeAlso(tests.TestCase):
133
"""Tests for the see also functional of Command."""
136
def _get_command_with_see_also(see_also):
137
class ACommand(commands.Command):
138
__doc__ = """A sample command."""
142
def test_default_subclass_no_see_also(self):
143
command = self._get_command_with_see_also([])
144
self.assertEqual([], command.get_see_also())
146
def test__see_also(self):
147
"""When _see_also is defined, it sets the result of get_see_also()."""
148
command = self._get_command_with_see_also(['bar', 'foo'])
149
self.assertEqual(['bar', 'foo'], command.get_see_also())
151
def test_deduplication(self):
152
"""Duplicates in _see_also are stripped out."""
153
command = self._get_command_with_see_also(['foo', 'foo'])
154
self.assertEqual(['foo'], command.get_see_also())
156
def test_sorted(self):
157
"""_see_also is sorted by get_see_also."""
158
command = self._get_command_with_see_also(['foo', 'bar'])
159
self.assertEqual(['bar', 'foo'], command.get_see_also())
161
def test_additional_terms(self):
162
"""Additional terms can be supplied and are deduped and sorted."""
163
command = self._get_command_with_see_also(['foo', 'bar'])
164
self.assertEqual(['bar', 'foo', 'gam'],
165
command.get_see_also(['gam', 'bar', 'gam']))
168
class TestRegisterLazy(tests.TestCase):
171
tests.TestCase.setUp(self)
172
import bzrlib.tests.fake_command
173
del sys.modules['bzrlib.tests.fake_command']
174
global lazy_command_imported
175
lazy_command_imported = False
176
commands.install_bzr_command_hooks()
180
commands.plugin_cmds.remove('fake')
182
def assertIsFakeCommand(self, cmd_obj):
183
from bzrlib.tests.fake_command import cmd_fake
184
self.assertIsInstance(cmd_obj, cmd_fake)
186
def test_register_lazy(self):
187
"""Ensure lazy registration works"""
188
commands.plugin_cmds.register_lazy('cmd_fake', [],
189
'bzrlib.tests.fake_command')
190
self.addCleanup(self.remove_fake)
191
self.assertFalse(lazy_command_imported)
192
fake_instance = commands.get_cmd_object('fake')
193
self.assertTrue(lazy_command_imported)
194
self.assertIsFakeCommand(fake_instance)
196
def test_get_unrelated_does_not_import(self):
197
commands.plugin_cmds.register_lazy('cmd_fake', [],
198
'bzrlib.tests.fake_command')
199
self.addCleanup(self.remove_fake)
200
commands.get_cmd_object('status')
201
self.assertFalse(lazy_command_imported)
203
def test_aliases(self):
204
commands.plugin_cmds.register_lazy('cmd_fake', ['fake_alias'],
205
'bzrlib.tests.fake_command')
206
self.addCleanup(self.remove_fake)
207
fake_instance = commands.get_cmd_object('fake_alias')
208
self.assertIsFakeCommand(fake_instance)
211
class TestExtendCommandHook(tests.TestCase):
213
def test_fires_on_get_cmd_object(self):
214
# The extend_command(cmd) hook fires when commands are delivered to the
215
# ui, not simply at registration (because lazy registered plugin
216
# commands are registered).
217
# when they are simply created.
219
commands.install_bzr_command_hooks()
220
commands.Command.hooks.install_named_hook(
221
"extend_command", hook_calls.append, None)
222
# create a command, should not fire
223
class cmd_test_extend_command_hook(commands.Command):
224
__doc__ = """A sample command."""
225
self.assertEqual([], hook_calls)
227
# register the command class, should not fire
229
commands.builtin_command_registry.register(cmd_test_extend_command_hook)
230
self.assertEqual([], hook_calls)
231
# and ask for the object, should fire
232
cmd = commands.get_cmd_object('test-extend-command-hook')
233
# For resilience - to ensure all code paths hit it - we
234
# fire on everything returned in the 'cmd_dict', which is currently
235
# all known commands, so assert that cmd is in hook_calls
236
self.assertSubset([cmd], hook_calls)
239
commands.builtin_command_registry.remove('test-extend-command-hook')
240
# -- as a plugin lazy registration
242
# register the command class, should not fire
243
commands.plugin_cmds.register_lazy('cmd_fake', [],
244
'bzrlib.tests.fake_command')
245
self.assertEqual([], hook_calls)
246
# and ask for the object, should fire
247
cmd = commands.get_cmd_object('fake')
248
self.assertEqual([cmd], hook_calls)
250
commands.plugin_cmds.remove('fake')
253
class TestGetCommandHook(tests.TestCase):
255
def test_fires_on_get_cmd_object(self):
256
# The get_command(cmd) hook fires when commands are delivered to the
258
commands.install_bzr_command_hooks()
260
class ACommand(commands.Command):
261
__doc__ = """A sample command."""
262
def get_cmd(cmd_or_None, cmd_name):
263
hook_calls.append(('called', cmd_or_None, cmd_name))
264
if cmd_name in ('foo', 'info'):
266
commands.Command.hooks.install_named_hook(
267
"get_command", get_cmd, None)
268
# create a command directly, should not fire
270
self.assertEqual([], hook_calls)
271
# ask by name, should fire and give us our command
272
cmd = commands.get_cmd_object('foo')
273
self.assertEqual([('called', None, 'foo')], hook_calls)
274
self.assertIsInstance(cmd, ACommand)
276
# ask by a name that is supplied by a builtin - the hook should still
277
# fire and we still get our object, but we should see the builtin
278
# passed to the hook.
279
cmd = commands.get_cmd_object('info')
280
self.assertIsInstance(cmd, ACommand)
281
self.assertEqual(1, len(hook_calls))
282
self.assertEqual('info', hook_calls[0][2])
283
self.assertIsInstance(hook_calls[0][1], builtins.cmd_info)
286
class TestGetMissingCommandHook(tests.TestCase):
288
def hook_missing(self):
289
"""Hook get_missing_command for testing."""
291
class ACommand(commands.Command):
292
__doc__ = """A sample command."""
293
def get_missing_cmd(cmd_name):
294
self.hook_calls.append(('called', cmd_name))
295
if cmd_name in ('foo', 'info'):
297
commands.Command.hooks.install_named_hook(
298
"get_missing_command", get_missing_cmd, None)
299
self.ACommand = ACommand
301
def test_fires_on_get_cmd_object(self):
302
# The get_missing_command(cmd) hook fires when commands are delivered to the
305
# create a command directly, should not fire
306
self.cmd = self.ACommand()
307
self.assertEqual([], self.hook_calls)
308
# ask by name, should fire and give us our command
309
cmd = commands.get_cmd_object('foo')
310
self.assertEqual([('called', 'foo')], self.hook_calls)
311
self.assertIsInstance(cmd, self.ACommand)
312
del self.hook_calls[:]
313
# ask by a name that is supplied by a builtin - the hook should not
314
# fire and we still get our object.
315
commands.install_bzr_command_hooks()
316
cmd = commands.get_cmd_object('info')
317
self.assertNotEqual(None, cmd)
318
self.assertEqual(0, len(self.hook_calls))
320
def test_skipped_on_HelpCommandIndex_get_topics(self):
321
# The get_missing_command(cmd_name) hook is not fired when
322
# looking up help topics.
324
topic = commands.HelpCommandIndex()
325
topics = topic.get_topics('foo')
326
self.assertEqual([], self.hook_calls)
329
class TestListCommandHook(tests.TestCase):
331
def test_fires_on_all_command_names(self):
332
# The list_commands() hook fires when all_command_names() is invoked.
334
commands.install_bzr_command_hooks()
335
def list_my_commands(cmd_names):
336
hook_calls.append('called')
337
cmd_names.update(['foo', 'bar'])
339
commands.Command.hooks.install_named_hook(
340
"list_commands", list_my_commands, None)
341
# Get a command, which should not trigger the hook.
342
cmd = commands.get_cmd_object('info')
343
self.assertEqual([], hook_calls)
344
# Get all command classes (for docs and shell completion).
345
cmds = list(commands.all_command_names())
346
self.assertEqual(['called'], hook_calls)
347
self.assertSubset(['foo', 'bar'], cmds)
349
class TestDeprecations(tests.TestCase):
351
def test_shlex_split_unicode_deprecation(self):
352
res = self.applyDeprecated(
353
symbol_versioning.deprecated_in((2, 2, 0)),
354
commands.shlex_split_unicode, 'whatever')
added
removed
bzrlib/tests/test_commands.py
