← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_commands.py

  • Committer: Martin von Gagern
  • Date: 2010-04-20 08:47:38 UTC
  • mfrom: (5167 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5195.
  • Revision ID: martin.vgagern@gmx.net-20100420084738-ygymnqmdllzrhpfn
merge trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_commands.py
1
 
# Copyright (C) 2004, 2005 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
from cStringIO import StringIO
18
18
import errno
 
19
import sys
19
20
 
20
21
from bzrlib import (
 
22
    builtins,
21
23
    commands,
22
24
    config,
23
25
    errors,
 
26
    option,
 
27
    symbol_versioning,
24
28
    tests,
25
29
    )
26
30
from bzrlib.commands import display_command
58
62
        self.assertRaises(errors.BzrCommandError,
59
63
                          commands.run_bzr, ['log', u'--option\xb5'])
60
64
 
 
65
    @staticmethod
 
66
    def get_command(options):
 
67
        class cmd_foo(commands.Command):
 
68
            'Bar'
 
69
 
 
70
            takes_options = options
 
71
 
 
72
        return cmd_foo()
 
73
 
 
74
    def test_help_hidden(self):
 
75
        c = self.get_command([option.Option('foo', hidden=True)])
 
76
        self.assertNotContainsRe(c.get_help_text(), '--foo')
 
77
 
 
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')
 
81
 
61
82
 
62
83
class TestGetAlias(tests.TestCase):
63
84
 
91
112
 
92
113
    def test_unicode(self):
93
114
        my_config = self._get_config("[ALIASES]\n"
94
 
            u"iam=whoami 'Erik B\u00e5gfors <erik@bagfors.nu>'\n")
 
115
            u'iam=whoami "Erik B\u00e5gfors <erik@bagfors.nu>"\n')
95
116
        self.assertEqual([u'whoami', u'Erik B\u00e5gfors <erik@bagfors.nu>'],
96
117
                          commands.get_alias("iam", config=my_config))
97
118
 
134
155
        self.assertEqual(['bar', 'foo', 'gam'],
135
156
            command.get_see_also(['gam', 'bar', 'gam']))
136
157
 
 
158
 
 
159
class TestRegisterLazy(tests.TestCase):
 
160
 
 
161
    def setUp(self):
 
162
        tests.TestCase.setUp(self)
 
163
        import bzrlib.tests.fake_command
 
164
        del sys.modules['bzrlib.tests.fake_command']
 
165
        global lazy_command_imported
 
166
        lazy_command_imported = False
 
167
        commands.install_bzr_command_hooks()
 
168
 
 
169
    @staticmethod
 
170
    def remove_fake():
 
171
        commands.plugin_cmds.remove('fake')
 
172
 
 
173
    def assertIsFakeCommand(self, cmd_obj):
 
174
        from bzrlib.tests.fake_command import cmd_fake
 
175
        self.assertIsInstance(cmd_obj, cmd_fake)
 
176
 
 
177
    def test_register_lazy(self):
 
178
        """Ensure lazy registration works"""
 
179
        commands.plugin_cmds.register_lazy('cmd_fake', [],
 
180
                                           'bzrlib.tests.fake_command')
 
181
        self.addCleanup(self.remove_fake)
 
182
        self.assertFalse(lazy_command_imported)
 
183
        fake_instance = commands.get_cmd_object('fake')
 
184
        self.assertTrue(lazy_command_imported)
 
185
        self.assertIsFakeCommand(fake_instance)
 
186
 
 
187
    def test_get_unrelated_does_not_import(self):
 
188
        commands.plugin_cmds.register_lazy('cmd_fake', [],
 
189
                                           'bzrlib.tests.fake_command')
 
190
        self.addCleanup(self.remove_fake)
 
191
        commands.get_cmd_object('status')
 
192
        self.assertFalse(lazy_command_imported)
 
193
 
 
194
    def test_aliases(self):
 
195
        commands.plugin_cmds.register_lazy('cmd_fake', ['fake_alias'],
 
196
                                           'bzrlib.tests.fake_command')
 
197
        self.addCleanup(self.remove_fake)
 
198
        fake_instance = commands.get_cmd_object('fake_alias')
 
199
        self.assertIsFakeCommand(fake_instance)
 
200
 
 
201
 
 
202
class TestExtendCommandHook(tests.TestCase):
 
203
 
 
204
    def test_fires_on_get_cmd_object(self):
 
205
        # The extend_command(cmd) hook fires when commands are delivered to the
 
206
        # ui, not simply at registration (because lazy registered plugin
 
207
        # commands are registered).
 
208
        # when they are simply created.
 
209
        hook_calls = []
 
210
        commands.install_bzr_command_hooks()
 
211
        commands.Command.hooks.install_named_hook(
 
212
            "extend_command", hook_calls.append, None)
 
213
        # create a command, should not fire
 
214
        class cmd_test_extend_command_hook(commands.Command):
 
215
            """A sample command."""
 
216
        self.assertEqual([], hook_calls)
 
217
        # -- as a builtin
 
218
        # register the command class, should not fire
 
219
        try:
 
220
            commands.builtin_command_registry.register(cmd_test_extend_command_hook)
 
221
            self.assertEqual([], hook_calls)
 
222
            # and ask for the object, should fire
 
223
            cmd = commands.get_cmd_object('test-extend-command-hook')
 
224
            # For resilience - to ensure all code paths hit it - we
 
225
            # fire on everything returned in the 'cmd_dict', which is currently
 
226
            # all known commands, so assert that cmd is in hook_calls
 
227
            self.assertSubset([cmd], hook_calls)
 
228
            del hook_calls[:]
 
229
        finally:
 
230
            commands.builtin_command_registry.remove('test-extend-command-hook')
 
231
        # -- as a plugin lazy registration
 
232
        try:
 
233
            # register the command class, should not fire
 
234
            commands.plugin_cmds.register_lazy('cmd_fake', [],
 
235
                                               'bzrlib.tests.fake_command')
 
236
            self.assertEqual([], hook_calls)
 
237
            # and ask for the object, should fire
 
238
            cmd = commands.get_cmd_object('fake')
 
239
            self.assertEqual([cmd], hook_calls)
 
240
        finally:
 
241
            commands.plugin_cmds.remove('fake')
 
242
 
 
243
 
 
244
class TestGetCommandHook(tests.TestCase):
 
245
 
 
246
    def test_fires_on_get_cmd_object(self):
 
247
        # The get_command(cmd) hook fires when commands are delivered to the
 
248
        # ui.
 
249
        commands.install_bzr_command_hooks()
 
250
        hook_calls = []
 
251
        class ACommand(commands.Command):
 
252
            """A sample command."""
 
253
        def get_cmd(cmd_or_None, cmd_name):
 
254
            hook_calls.append(('called', cmd_or_None, cmd_name))
 
255
            if cmd_name in ('foo', 'info'):
 
256
                return ACommand()
 
257
        commands.Command.hooks.install_named_hook(
 
258
            "get_command", get_cmd, None)
 
259
        # create a command directly, should not fire
 
260
        cmd = ACommand()
 
261
        self.assertEqual([], hook_calls)
 
262
        # ask by name, should fire and give us our command
 
263
        cmd = commands.get_cmd_object('foo')
 
264
        self.assertEqual([('called', None, 'foo')], hook_calls)
 
265
        self.assertIsInstance(cmd, ACommand)
 
266
        del hook_calls[:]
 
267
        # ask by a name that is supplied by a builtin - the hook should still
 
268
        # fire and we still get our object, but we should see the builtin
 
269
        # passed to the hook.
 
270
        cmd = commands.get_cmd_object('info')
 
271
        self.assertIsInstance(cmd, ACommand)
 
272
        self.assertEqual(1, len(hook_calls))
 
273
        self.assertEqual('info', hook_calls[0][2])
 
274
        self.assertIsInstance(hook_calls[0][1], builtins.cmd_info)
 
275
 
 
276
 
 
277
class TestGetMissingCommandHook(tests.TestCase):
 
278
 
 
279
    def hook_missing(self):
 
280
        """Hook get_missing_command for testing."""
 
281
        self.hook_calls = []
 
282
        class ACommand(commands.Command):
 
283
            """A sample command."""
 
284
        def get_missing_cmd(cmd_name):
 
285
            self.hook_calls.append(('called', cmd_name))
 
286
            if cmd_name in ('foo', 'info'):
 
287
                return ACommand()
 
288
        commands.Command.hooks.install_named_hook(
 
289
            "get_missing_command", get_missing_cmd, None)
 
290
        self.ACommand = ACommand
 
291
 
 
292
    def test_fires_on_get_cmd_object(self):
 
293
        # The get_missing_command(cmd) hook fires when commands are delivered to the
 
294
        # ui.
 
295
        self.hook_missing()
 
296
        # create a command directly, should not fire
 
297
        self.cmd = self.ACommand()
 
298
        self.assertEqual([], self.hook_calls)
 
299
        # ask by name, should fire and give us our command
 
300
        cmd = commands.get_cmd_object('foo')
 
301
        self.assertEqual([('called', 'foo')], self.hook_calls)
 
302
        self.assertIsInstance(cmd, self.ACommand)
 
303
        del self.hook_calls[:]
 
304
        # ask by a name that is supplied by a builtin - the hook should not
 
305
        # fire and we still get our object.
 
306
        commands.install_bzr_command_hooks()
 
307
        cmd = commands.get_cmd_object('info')
 
308
        self.assertNotEqual(None, cmd)
 
309
        self.assertEqual(0, len(self.hook_calls))
 
310
 
 
311
    def test_skipped_on_HelpCommandIndex_get_topics(self):
 
312
        # The get_missing_command(cmd_name) hook is not fired when
 
313
        # looking up help topics.
 
314
        self.hook_missing()
 
315
        topic = commands.HelpCommandIndex()
 
316
        topics = topic.get_topics('foo')
 
317
        self.assertEqual([], self.hook_calls)
 
318
 
 
319
 
 
320
class TestListCommandHook(tests.TestCase):
 
321
 
 
322
    def test_fires_on_all_command_names(self):
 
323
        # The list_commands() hook fires when all_command_names() is invoked.
 
324
        hook_calls = []
 
325
        commands.install_bzr_command_hooks()
 
326
        def list_my_commands(cmd_names):
 
327
            hook_calls.append('called')
 
328
            cmd_names.update(['foo', 'bar'])
 
329
            return cmd_names
 
330
        commands.Command.hooks.install_named_hook(
 
331
            "list_commands", list_my_commands, None)
 
332
        # Get a command, which should not trigger the hook.
 
333
        cmd = commands.get_cmd_object('info')
 
334
        self.assertEqual([], hook_calls)
 
335
        # Get all command classes (for docs and shell completion).
 
336
        cmds = list(commands.all_command_names())
 
337
        self.assertEqual(['called'], hook_calls)
 
338
        self.assertSubset(['foo', 'bar'], cmds)
 
339
 
 
340
class TestDeprecations(tests.TestCase):
 
341
 
 
342
    def test_shlex_split_unicode_deprecation(self):
 
343
        res = self.applyDeprecated(
 
344
                symbol_versioning.deprecated_in((2, 2, 0)),
 
345
                commands.shlex_split_unicode, 'whatever')