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
30
from bzrlib.commands import display_command
31
from bzrlib.tests import TestSkipped
34
class TestCommands(tests.TestCase):
36
def test_display_command(self):
37
"""EPIPE message is selectively suppressed"""
39
raise IOError(errno.EPIPE, "Bogus pipe error")
40
self.assertRaises(IOError, pipe_thrower)
47
raise IOError(errno.ESPIPE, "Bogus pipe error")
48
self.assertRaises(IOError, other_thrower)
50
def test_unicode_command(self):
51
# This error is thrown when we can't find the command in the
52
# list of available commands
53
self.assertRaises(errors.BzrCommandError,
54
commands.run_bzr, [u'cmd\xb5'])
56
def test_unicode_option(self):
57
# This error is actually thrown by optparse, when it
58
# can't find the given option
60
if optparse.__version__ == "1.5.3":
61
raise TestSkipped("optparse 1.5.3 can't handle unicode options")
62
self.assertRaises(errors.BzrCommandError,
63
commands.run_bzr, ['log', u'--option\xb5'])
66
def get_command(options):
67
class cmd_foo(commands.Command):
70
takes_options = options
74
def test_help_hidden(self):
75
c = self.get_command([option.Option('foo', hidden=True)])
76
self.assertNotContainsRe(c.get_help_text(), '--foo')
78
def test_help_not_hidden(self):
79
c = self.get_command([option.Option('foo', hidden=False)])
80
self.assertContainsRe(c.get_help_text(), '--foo')
83
class TestGetAlias(tests.TestCase):
85
def _get_config(self, config_text):
86
my_config = config.GlobalConfig()
87
config_file = StringIO(config_text.encode('utf-8'))
88
my_config._parser = my_config._get_parser(file=config_file)
91
def test_simple(self):
92
my_config = self._get_config("[ALIASES]\n"
93
"diff=diff -r -2..-1\n")
94
self.assertEqual([u'diff', u'-r', u'-2..-1'],
95
commands.get_alias("diff", config=my_config))
97
def test_single_quotes(self):
98
my_config = self._get_config("[ALIASES]\n"
99
"diff=diff -r -2..-1 --diff-options "
100
"'--strip-trailing-cr -wp'\n")
101
self.assertEqual([u'diff', u'-r', u'-2..-1', u'--diff-options',
102
u'--strip-trailing-cr -wp'],
103
commands.get_alias("diff", config=my_config))
105
def test_double_quotes(self):
106
my_config = self._get_config("[ALIASES]\n"
107
"diff=diff -r -2..-1 --diff-options "
108
"\"--strip-trailing-cr -wp\"\n")
109
self.assertEqual([u'diff', u'-r', u'-2..-1', u'--diff-options',
110
u'--strip-trailing-cr -wp'],
111
commands.get_alias("diff", config=my_config))
113
def test_unicode(self):
114
my_config = self._get_config("[ALIASES]\n"
115
u'iam=whoami "Erik B\u00e5gfors <erik@bagfors.nu>"\n')
116
self.assertEqual([u'whoami', u'Erik B\u00e5gfors <erik@bagfors.nu>'],
117
commands.get_alias("iam", config=my_config))
120
class TestSeeAlso(tests.TestCase):
121
"""Tests for the see also functional of Command."""
124
def _get_command_with_see_also(see_also):
125
class ACommand(commands.Command):
126
__doc__ = """A sample command."""
130
def test_default_subclass_no_see_also(self):
131
command = self._get_command_with_see_also([])
132
self.assertEqual([], command.get_see_also())
134
def test__see_also(self):
135
"""When _see_also is defined, it sets the result of get_see_also()."""
136
command = self._get_command_with_see_also(['bar', 'foo'])
137
self.assertEqual(['bar', 'foo'], command.get_see_also())
139
def test_deduplication(self):
140
"""Duplicates in _see_also are stripped out."""
141
command = self._get_command_with_see_also(['foo', 'foo'])
142
self.assertEqual(['foo'], command.get_see_also())
144
def test_sorted(self):
145
"""_see_also is sorted by get_see_also."""
146
command = self._get_command_with_see_also(['foo', 'bar'])
147
self.assertEqual(['bar', 'foo'], command.get_see_also())
149
def test_additional_terms(self):
150
"""Additional terms can be supplied and are deduped and sorted."""
151
command = self._get_command_with_see_also(['foo', 'bar'])
152
self.assertEqual(['bar', 'foo', 'gam'],
153
command.get_see_also(['gam', 'bar', 'gam']))
156
class TestRegisterLazy(tests.TestCase):
159
tests.TestCase.setUp(self)
160
import bzrlib.tests.fake_command
161
del sys.modules['bzrlib.tests.fake_command']
162
global lazy_command_imported
163
lazy_command_imported = False
164
commands.install_bzr_command_hooks()
168
commands.plugin_cmds.remove('fake')
170
def assertIsFakeCommand(self, cmd_obj):
171
from bzrlib.tests.fake_command import cmd_fake
172
self.assertIsInstance(cmd_obj, cmd_fake)
174
def test_register_lazy(self):
175
"""Ensure lazy registration works"""
176
commands.plugin_cmds.register_lazy('cmd_fake', [],
177
'bzrlib.tests.fake_command')
178
self.addCleanup(self.remove_fake)
179
self.assertFalse(lazy_command_imported)
180
fake_instance = commands.get_cmd_object('fake')
181
self.assertTrue(lazy_command_imported)
182
self.assertIsFakeCommand(fake_instance)
184
def test_get_unrelated_does_not_import(self):
185
commands.plugin_cmds.register_lazy('cmd_fake', [],
186
'bzrlib.tests.fake_command')
187
self.addCleanup(self.remove_fake)
188
commands.get_cmd_object('status')
189
self.assertFalse(lazy_command_imported)
191
def test_aliases(self):
192
commands.plugin_cmds.register_lazy('cmd_fake', ['fake_alias'],
193
'bzrlib.tests.fake_command')
194
self.addCleanup(self.remove_fake)
195
fake_instance = commands.get_cmd_object('fake_alias')
196
self.assertIsFakeCommand(fake_instance)
199
class TestExtendCommandHook(tests.TestCase):
201
def test_fires_on_get_cmd_object(self):
202
# The extend_command(cmd) hook fires when commands are delivered to the
203
# ui, not simply at registration (because lazy registered plugin
204
# commands are registered).
205
# when they are simply created.
207
commands.install_bzr_command_hooks()
208
commands.Command.hooks.install_named_hook(
209
"extend_command", hook_calls.append, None)
210
# create a command, should not fire
211
class cmd_test_extend_command_hook(commands.Command):
212
__doc__ = """A sample command."""
213
self.assertEqual([], hook_calls)
215
# register the command class, should not fire
217
commands.builtin_command_registry.register(cmd_test_extend_command_hook)
218
self.assertEqual([], hook_calls)
219
# and ask for the object, should fire
220
cmd = commands.get_cmd_object('test-extend-command-hook')
221
# For resilience - to ensure all code paths hit it - we
222
# fire on everything returned in the 'cmd_dict', which is currently
223
# all known commands, so assert that cmd is in hook_calls
224
self.assertSubset([cmd], hook_calls)
227
commands.builtin_command_registry.remove('test-extend-command-hook')
228
# -- as a plugin lazy registration
230
# register the command class, should not fire
231
commands.plugin_cmds.register_lazy('cmd_fake', [],
232
'bzrlib.tests.fake_command')
233
self.assertEqual([], hook_calls)
234
# and ask for the object, should fire
235
cmd = commands.get_cmd_object('fake')
236
self.assertEqual([cmd], hook_calls)
238
commands.plugin_cmds.remove('fake')
241
class TestGetCommandHook(tests.TestCase):
243
def test_fires_on_get_cmd_object(self):
244
# The get_command(cmd) hook fires when commands are delivered to the
246
commands.install_bzr_command_hooks()
248
class ACommand(commands.Command):
249
__doc__ = """A sample command."""
250
def get_cmd(cmd_or_None, cmd_name):
251
hook_calls.append(('called', cmd_or_None, cmd_name))
252
if cmd_name in ('foo', 'info'):
254
commands.Command.hooks.install_named_hook(
255
"get_command", get_cmd, None)
256
# create a command directly, should not fire
258
self.assertEqual([], hook_calls)
259
# ask by name, should fire and give us our command
260
cmd = commands.get_cmd_object('foo')
261
self.assertEqual([('called', None, 'foo')], hook_calls)
262
self.assertIsInstance(cmd, ACommand)
264
# ask by a name that is supplied by a builtin - the hook should still
265
# fire and we still get our object, but we should see the builtin
266
# passed to the hook.
267
cmd = commands.get_cmd_object('info')
268
self.assertIsInstance(cmd, ACommand)
269
self.assertEqual(1, len(hook_calls))
270
self.assertEqual('info', hook_calls[0][2])
271
self.assertIsInstance(hook_calls[0][1], builtins.cmd_info)
274
class TestGetMissingCommandHook(tests.TestCase):
276
def hook_missing(self):
277
"""Hook get_missing_command for testing."""
279
class ACommand(commands.Command):
280
__doc__ = """A sample command."""
281
def get_missing_cmd(cmd_name):
282
self.hook_calls.append(('called', cmd_name))
283
if cmd_name in ('foo', 'info'):
285
commands.Command.hooks.install_named_hook(
286
"get_missing_command", get_missing_cmd, None)
287
self.ACommand = ACommand
289
def test_fires_on_get_cmd_object(self):
290
# The get_missing_command(cmd) hook fires when commands are delivered to the
293
# create a command directly, should not fire
294
self.cmd = self.ACommand()
295
self.assertEqual([], self.hook_calls)
296
# ask by name, should fire and give us our command
297
cmd = commands.get_cmd_object('foo')
298
self.assertEqual([('called', 'foo')], self.hook_calls)
299
self.assertIsInstance(cmd, self.ACommand)
300
del self.hook_calls[:]
301
# ask by a name that is supplied by a builtin - the hook should not
302
# fire and we still get our object.
303
commands.install_bzr_command_hooks()
304
cmd = commands.get_cmd_object('info')
305
self.assertNotEqual(None, cmd)
306
self.assertEqual(0, len(self.hook_calls))
308
def test_skipped_on_HelpCommandIndex_get_topics(self):
309
# The get_missing_command(cmd_name) hook is not fired when
310
# looking up help topics.
312
topic = commands.HelpCommandIndex()
313
topics = topic.get_topics('foo')
314
self.assertEqual([], self.hook_calls)
317
class TestListCommandHook(tests.TestCase):
319
def test_fires_on_all_command_names(self):
320
# The list_commands() hook fires when all_command_names() is invoked.
322
commands.install_bzr_command_hooks()
323
def list_my_commands(cmd_names):
324
hook_calls.append('called')
325
cmd_names.update(['foo', 'bar'])
327
commands.Command.hooks.install_named_hook(
328
"list_commands", list_my_commands, None)
329
# Get a command, which should not trigger the hook.
330
cmd = commands.get_cmd_object('info')
331
self.assertEqual([], hook_calls)
332
# Get all command classes (for docs and shell completion).
333
cmds = list(commands.all_command_names())
334
self.assertEqual(['called'], hook_calls)
335
self.assertSubset(['foo', 'bar'], cmds)
337
class TestDeprecations(tests.TestCase):
339
def test_shlex_split_unicode_deprecation(self):
340
res = self.applyDeprecated(
341
symbol_versioning.deprecated_in((2, 2, 0)),
342
commands.shlex_split_unicode, 'whatever')
added
removed
bzrlib/tests/test_commands.py
