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
|
# Copyright (C) 2005-2011 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
import errno
import inspect
import sys
from bzrlib import (
builtins,
commands,
config,
errors,
option,
symbol_versioning,
tests,
)
from bzrlib.commands import display_command
from bzrlib.tests import TestSkipped
class TestCommands(tests.TestCase):
def test_all_commands_have_help(self):
commands._register_builtin_commands()
commands_without_help = set()
base_doc = inspect.getdoc(commands.Command)
for cmd_name in commands.all_command_names():
cmd = commands.get_cmd_object(cmd_name)
cmd_help = cmd.help()
if not cmd_help or cmd_help == base_doc:
commands_without_help.append(cmd_name)
self.assertLength(0, commands_without_help)
def test_display_command(self):
"""EPIPE message is selectively suppressed"""
def pipe_thrower():
raise IOError(errno.EPIPE, "Bogus pipe error")
self.assertRaises(IOError, pipe_thrower)
@display_command
def non_thrower():
pipe_thrower()
non_thrower()
@display_command
def other_thrower():
raise IOError(errno.ESPIPE, "Bogus pipe error")
self.assertRaises(IOError, other_thrower)
def test_unicode_command(self):
# This error is thrown when we can't find the command in the
# list of available commands
self.assertRaises(errors.BzrCommandError,
commands.run_bzr, [u'cmd\xb5'])
def test_unicode_option(self):
# This error is actually thrown by optparse, when it
# can't find the given option
import optparse
if optparse.__version__ == "1.5.3":
raise TestSkipped("optparse 1.5.3 can't handle unicode options")
self.assertRaises(errors.BzrCommandError,
commands.run_bzr, ['log', u'--option\xb5'])
@staticmethod
def get_command(options):
class cmd_foo(commands.Command):
__doc__ = 'Bar'
takes_options = options
return cmd_foo()
def test_help_hidden(self):
c = self.get_command([option.Option('foo', hidden=True)])
self.assertNotContainsRe(c.get_help_text(), '--foo')
def test_help_not_hidden(self):
c = self.get_command([option.Option('foo', hidden=False)])
self.assertContainsRe(c.get_help_text(), '--foo')
class TestInsideCommand(tests.TestCaseInTempDir):
def test_command_see_config_overrides(self):
def run(cmd):
# We override the run() command method so we can observe the
# overrides from inside.
c = config.GlobalStack()
self.assertEquals('12', c.get('xx'))
self.assertEquals('foo', c.get('yy'))
self.overrideAttr(builtins.cmd_rocks, 'run', run)
self.run_bzr(['rocks', '-Oxx=12', '-Oyy=foo'])
c = config.GlobalStack()
# Ensure that we don't leak outside of the command
self.assertEquals(None, c.get('xx'))
self.assertEquals(None, c.get('yy'))
class TestInvokedAs(tests.TestCase):
def test_invoked_as(self):
"""The command object knows the actual name used to invoke it."""
commands.install_bzr_command_hooks()
commands._register_builtin_commands()
# get one from the real get_cmd_object.
c = commands.get_cmd_object('ci')
self.assertIsInstance(c, builtins.cmd_commit)
self.assertEquals(c.invoked_as, 'ci')
class TestGetAlias(tests.TestCase):
def _get_config(self, config_text):
my_config = config.GlobalConfig.from_string(config_text)
return my_config
def test_simple(self):
my_config = self._get_config("[ALIASES]\n"
"diff=diff -r -2..-1\n")
self.assertEqual([u'diff', u'-r', u'-2..-1'],
commands.get_alias("diff", config=my_config))
def test_single_quotes(self):
my_config = self._get_config("[ALIASES]\n"
"diff=diff -r -2..-1 --diff-options "
"'--strip-trailing-cr -wp'\n")
self.assertEqual([u'diff', u'-r', u'-2..-1', u'--diff-options',
u'--strip-trailing-cr -wp'],
commands.get_alias("diff", config=my_config))
def test_double_quotes(self):
my_config = self._get_config("[ALIASES]\n"
"diff=diff -r -2..-1 --diff-options "
"\"--strip-trailing-cr -wp\"\n")
self.assertEqual([u'diff', u'-r', u'-2..-1', u'--diff-options',
u'--strip-trailing-cr -wp'],
commands.get_alias("diff", config=my_config))
def test_unicode(self):
my_config = self._get_config("[ALIASES]\n"
u'iam=whoami "Erik B\u00e5gfors <erik@bagfors.nu>"\n')
self.assertEqual([u'whoami', u'Erik B\u00e5gfors <erik@bagfors.nu>'],
commands.get_alias("iam", config=my_config))
class TestSeeAlso(tests.TestCase):
"""Tests for the see also functional of Command."""
@staticmethod
def _get_command_with_see_also(see_also):
class ACommand(commands.Command):
__doc__ = """A sample command."""
_see_also = see_also
return ACommand()
def test_default_subclass_no_see_also(self):
command = self._get_command_with_see_also([])
self.assertEqual([], command.get_see_also())
def test__see_also(self):
"""When _see_also is defined, it sets the result of get_see_also()."""
command = self._get_command_with_see_also(['bar', 'foo'])
self.assertEqual(['bar', 'foo'], command.get_see_also())
def test_deduplication(self):
"""Duplicates in _see_also are stripped out."""
command = self._get_command_with_see_also(['foo', 'foo'])
self.assertEqual(['foo'], command.get_see_also())
def test_sorted(self):
"""_see_also is sorted by get_see_also."""
command = self._get_command_with_see_also(['foo', 'bar'])
self.assertEqual(['bar', 'foo'], command.get_see_also())
def test_additional_terms(self):
"""Additional terms can be supplied and are deduped and sorted."""
command = self._get_command_with_see_also(['foo', 'bar'])
self.assertEqual(['bar', 'foo', 'gam'],
command.get_see_also(['gam', 'bar', 'gam']))
class TestRegisterLazy(tests.TestCase):
def setUp(self):
tests.TestCase.setUp(self)
import bzrlib.tests.fake_command
del sys.modules['bzrlib.tests.fake_command']
global lazy_command_imported
lazy_command_imported = False
commands.install_bzr_command_hooks()
@staticmethod
def remove_fake():
commands.plugin_cmds.remove('fake')
def assertIsFakeCommand(self, cmd_obj):
from bzrlib.tests.fake_command import cmd_fake
self.assertIsInstance(cmd_obj, cmd_fake)
def test_register_lazy(self):
"""Ensure lazy registration works"""
commands.plugin_cmds.register_lazy('cmd_fake', [],
'bzrlib.tests.fake_command')
self.addCleanup(self.remove_fake)
self.assertFalse(lazy_command_imported)
fake_instance = commands.get_cmd_object('fake')
self.assertTrue(lazy_command_imported)
self.assertIsFakeCommand(fake_instance)
def test_get_unrelated_does_not_import(self):
commands.plugin_cmds.register_lazy('cmd_fake', [],
'bzrlib.tests.fake_command')
self.addCleanup(self.remove_fake)
commands.get_cmd_object('status')
self.assertFalse(lazy_command_imported)
def test_aliases(self):
commands.plugin_cmds.register_lazy('cmd_fake', ['fake_alias'],
'bzrlib.tests.fake_command')
self.addCleanup(self.remove_fake)
fake_instance = commands.get_cmd_object('fake_alias')
self.assertIsFakeCommand(fake_instance)
class TestExtendCommandHook(tests.TestCase):
def test_fires_on_get_cmd_object(self):
# The extend_command(cmd) hook fires when commands are delivered to the
# ui, not simply at registration (because lazy registered plugin
# commands are registered).
# when they are simply created.
hook_calls = []
commands.install_bzr_command_hooks()
commands.Command.hooks.install_named_hook(
"extend_command", hook_calls.append, None)
# create a command, should not fire
class cmd_test_extend_command_hook(commands.Command):
__doc__ = """A sample command."""
self.assertEqual([], hook_calls)
# -- as a builtin
# register the command class, should not fire
try:
commands.builtin_command_registry.register(cmd_test_extend_command_hook)
self.assertEqual([], hook_calls)
# and ask for the object, should fire
cmd = commands.get_cmd_object('test-extend-command-hook')
# For resilience - to ensure all code paths hit it - we
# fire on everything returned in the 'cmd_dict', which is currently
# all known commands, so assert that cmd is in hook_calls
self.assertSubset([cmd], hook_calls)
del hook_calls[:]
finally:
commands.builtin_command_registry.remove('test-extend-command-hook')
# -- as a plugin lazy registration
try:
# register the command class, should not fire
commands.plugin_cmds.register_lazy('cmd_fake', [],
'bzrlib.tests.fake_command')
self.assertEqual([], hook_calls)
# and ask for the object, should fire
cmd = commands.get_cmd_object('fake')
self.assertEqual([cmd], hook_calls)
finally:
commands.plugin_cmds.remove('fake')
class TestGetCommandHook(tests.TestCase):
def test_fires_on_get_cmd_object(self):
# The get_command(cmd) hook fires when commands are delivered to the
# ui.
commands.install_bzr_command_hooks()
hook_calls = []
class ACommand(commands.Command):
__doc__ = """A sample command."""
def get_cmd(cmd_or_None, cmd_name):
hook_calls.append(('called', cmd_or_None, cmd_name))
if cmd_name in ('foo', 'info'):
return ACommand()
commands.Command.hooks.install_named_hook(
"get_command", get_cmd, None)
# create a command directly, should not fire
cmd = ACommand()
self.assertEqual([], hook_calls)
# ask by name, should fire and give us our command
cmd = commands.get_cmd_object('foo')
self.assertEqual([('called', None, 'foo')], hook_calls)
self.assertIsInstance(cmd, ACommand)
del hook_calls[:]
# ask by a name that is supplied by a builtin - the hook should still
# fire and we still get our object, but we should see the builtin
# passed to the hook.
cmd = commands.get_cmd_object('info')
self.assertIsInstance(cmd, ACommand)
self.assertEqual(1, len(hook_calls))
self.assertEqual('info', hook_calls[0][2])
self.assertIsInstance(hook_calls[0][1], builtins.cmd_info)
class TestGetMissingCommandHook(tests.TestCase):
def hook_missing(self):
"""Hook get_missing_command for testing."""
self.hook_calls = []
class ACommand(commands.Command):
__doc__ = """A sample command."""
def get_missing_cmd(cmd_name):
self.hook_calls.append(('called', cmd_name))
if cmd_name in ('foo', 'info'):
return ACommand()
commands.Command.hooks.install_named_hook(
"get_missing_command", get_missing_cmd, None)
self.ACommand = ACommand
def test_fires_on_get_cmd_object(self):
# The get_missing_command(cmd) hook fires when commands are delivered to the
# ui.
self.hook_missing()
# create a command directly, should not fire
self.cmd = self.ACommand()
self.assertEqual([], self.hook_calls)
# ask by name, should fire and give us our command
cmd = commands.get_cmd_object('foo')
self.assertEqual([('called', 'foo')], self.hook_calls)
self.assertIsInstance(cmd, self.ACommand)
del self.hook_calls[:]
# ask by a name that is supplied by a builtin - the hook should not
# fire and we still get our object.
commands.install_bzr_command_hooks()
cmd = commands.get_cmd_object('info')
self.assertNotEqual(None, cmd)
self.assertEqual(0, len(self.hook_calls))
def test_skipped_on_HelpCommandIndex_get_topics(self):
# The get_missing_command(cmd_name) hook is not fired when
# looking up help topics.
self.hook_missing()
topic = commands.HelpCommandIndex()
topics = topic.get_topics('foo')
self.assertEqual([], self.hook_calls)
class TestListCommandHook(tests.TestCase):
def test_fires_on_all_command_names(self):
# The list_commands() hook fires when all_command_names() is invoked.
hook_calls = []
commands.install_bzr_command_hooks()
def list_my_commands(cmd_names):
hook_calls.append('called')
cmd_names.update(['foo', 'bar'])
return cmd_names
commands.Command.hooks.install_named_hook(
"list_commands", list_my_commands, None)
# Get a command, which should not trigger the hook.
cmd = commands.get_cmd_object('info')
self.assertEqual([], hook_calls)
# Get all command classes (for docs and shell completion).
cmds = list(commands.all_command_names())
self.assertEqual(['called'], hook_calls)
self.assertSubset(['foo', 'bar'], cmds)
|