← 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: Canonical.com Patch Queue Manager
  • Date: 2009-04-30 15:00:23 UTC
  • mfrom: (4273.1.21 branch-subtree-locations)
  • Revision ID: pqm@pqm.ubuntu.com-20090430150023-1cw4lwqf312vpuu8
(abentley) Implement references command.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_commands.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2004, 2005 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
16
16
 
17
17
from cStringIO import StringIO
18
18
import errno
19
 
import inspect
20
19
import sys
21
20
 
22
21
from bzrlib import (
25
24
    config,
26
25
    errors,
27
26
    option,
28
 
    symbol_versioning,
29
27
    tests,
30
28
    )
31
29
from bzrlib.commands import display_command
34
32
 
35
33
class TestCommands(tests.TestCase):
36
34
 
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)
43
 
            cmd_help = cmd.help()
44
 
            if not cmd_help or cmd_help == base_doc:
45
 
                commands_without_help.append(cmd_name)
46
 
        self.assertLength(0, commands_without_help)
47
 
 
48
35
    def test_display_command(self):
49
36
        """EPIPE message is selectively suppressed"""
50
37
        def pipe_thrower():
77
64
    @staticmethod
78
65
    def get_command(options):
79
66
        class cmd_foo(commands.Command):
80
 
            __doc__ = 'Bar'
 
67
            'Bar'
81
68
 
82
69
            takes_options = options
83
70
 
95
82
class TestGetAlias(tests.TestCase):
96
83
 
97
84
    def _get_config(self, config_text):
98
 
        my_config = config.GlobalConfig.from_string(config_text)
 
85
        my_config = config.GlobalConfig()
 
86
        config_file = StringIO(config_text.encode('utf-8'))
 
87
        my_config._parser = my_config._get_parser(file=config_file)
99
88
        return my_config
100
89
 
101
90
    def test_simple(self):
122
111
 
123
112
    def test_unicode(self):
124
113
        my_config = self._get_config("[ALIASES]\n"
125
 
            u'iam=whoami "Erik B\u00e5gfors <erik@bagfors.nu>"\n')
 
114
            u"iam=whoami 'Erik B\u00e5gfors <erik@bagfors.nu>'\n")
126
115
        self.assertEqual([u'whoami', u'Erik B\u00e5gfors <erik@bagfors.nu>'],
127
116
                          commands.get_alias("iam", config=my_config))
128
117
 
130
119
class TestSeeAlso(tests.TestCase):
131
120
    """Tests for the see also functional of Command."""
132
121
 
133
 
    @staticmethod
134
 
    def _get_command_with_see_also(see_also):
135
 
        class ACommand(commands.Command):
136
 
            __doc__ = """A sample command."""
137
 
            _see_also = see_also
138
 
        return ACommand()
139
 
 
140
122
    def test_default_subclass_no_see_also(self):
141
 
        command = self._get_command_with_see_also([])
 
123
        class ACommand(commands.Command):
 
124
            """A sample command."""
 
125
        command = ACommand()
142
126
        self.assertEqual([], command.get_see_also())
143
127
 
144
128
    def test__see_also(self):
145
129
        """When _see_also is defined, it sets the result of get_see_also()."""
146
 
        command = self._get_command_with_see_also(['bar', 'foo'])
 
130
        class ACommand(commands.Command):
 
131
            _see_also = ['bar', 'foo']
 
132
        command = ACommand()
147
133
        self.assertEqual(['bar', 'foo'], command.get_see_also())
148
134
 
149
135
    def test_deduplication(self):
150
136
        """Duplicates in _see_also are stripped out."""
151
 
        command = self._get_command_with_see_also(['foo', 'foo'])
 
137
        class ACommand(commands.Command):
 
138
            _see_also = ['foo', 'foo']
 
139
        command = ACommand()
152
140
        self.assertEqual(['foo'], command.get_see_also())
153
141
 
154
142
    def test_sorted(self):
155
143
        """_see_also is sorted by get_see_also."""
156
 
        command = self._get_command_with_see_also(['foo', 'bar'])
 
144
        class ACommand(commands.Command):
 
145
            _see_also = ['foo', 'bar']
 
146
        command = ACommand()
157
147
        self.assertEqual(['bar', 'foo'], command.get_see_also())
158
148
 
159
149
    def test_additional_terms(self):
160
150
        """Additional terms can be supplied and are deduped and sorted."""
161
 
        command = self._get_command_with_see_also(['foo', 'bar'])
 
151
        class ACommand(commands.Command):
 
152
            _see_also = ['foo', 'bar']
 
153
        command = ACommand()
162
154
        self.assertEqual(['bar', 'foo', 'gam'],
163
155
            command.get_see_also(['gam', 'bar', 'gam']))
164
156
 
171
163
        del sys.modules['bzrlib.tests.fake_command']
172
164
        global lazy_command_imported
173
165
        lazy_command_imported = False
174
 
        commands.install_bzr_command_hooks()
175
166
 
176
167
    @staticmethod
177
168
    def remove_fake():
214
205
        # commands are registered).
215
206
        # when they are simply created.
216
207
        hook_calls = []
217
 
        commands.install_bzr_command_hooks()
218
208
        commands.Command.hooks.install_named_hook(
219
209
            "extend_command", hook_calls.append, None)
220
210
        # create a command, should not fire
221
 
        class cmd_test_extend_command_hook(commands.Command):
222
 
            __doc__ = """A sample command."""
 
211
        class ACommand(commands.Command):
 
212
            """A sample command."""
 
213
        cmd = ACommand()
223
214
        self.assertEqual([], hook_calls)
224
215
        # -- as a builtin
225
216
        # register the command class, should not fire
226
217
        try:
227
 
            commands.builtin_command_registry.register(cmd_test_extend_command_hook)
 
218
            builtins.cmd_test_extend_command_hook = ACommand
228
219
            self.assertEqual([], hook_calls)
229
220
            # and ask for the object, should fire
230
221
            cmd = commands.get_cmd_object('test-extend-command-hook')
234
225
            self.assertSubset([cmd], hook_calls)
235
226
            del hook_calls[:]
236
227
        finally:
237
 
            commands.builtin_command_registry.remove('test-extend-command-hook')
 
228
            del builtins.cmd_test_extend_command_hook
238
229
        # -- as a plugin lazy registration
239
230
        try:
240
231
            # register the command class, should not fire
246
237
            self.assertEqual([cmd], hook_calls)
247
238
        finally:
248
239
            commands.plugin_cmds.remove('fake')
249
 
 
250
 
 
251
 
class TestGetCommandHook(tests.TestCase):
252
 
 
253
 
    def test_fires_on_get_cmd_object(self):
254
 
        # The get_command(cmd) hook fires when commands are delivered to the
255
 
        # ui.
256
 
        commands.install_bzr_command_hooks()
257
 
        hook_calls = []
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'):
263
 
                return ACommand()
264
 
        commands.Command.hooks.install_named_hook(
265
 
            "get_command", get_cmd, None)
266
 
        # create a command directly, should not fire
267
 
        cmd = ACommand()
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)
273
 
        del hook_calls[:]
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)
282
 
 
283
 
 
284
 
class TestGetMissingCommandHook(tests.TestCase):
285
 
 
286
 
    def hook_missing(self):
287
 
        """Hook get_missing_command for testing."""
288
 
        self.hook_calls = []
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'):
294
 
                return ACommand()
295
 
        commands.Command.hooks.install_named_hook(
296
 
            "get_missing_command", get_missing_cmd, None)
297
 
        self.ACommand = ACommand
298
 
 
299
 
    def test_fires_on_get_cmd_object(self):
300
 
        # The get_missing_command(cmd) hook fires when commands are delivered to the
301
 
        # ui.
302
 
        self.hook_missing()
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))
317
 
 
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.
321
 
        self.hook_missing()
322
 
        topic = commands.HelpCommandIndex()
323
 
        topics = topic.get_topics('foo')
324
 
        self.assertEqual([], self.hook_calls)
325
 
 
326
 
 
327
 
class TestListCommandHook(tests.TestCase):
328
 
 
329
 
    def test_fires_on_all_command_names(self):
330
 
        # The list_commands() hook fires when all_command_names() is invoked.
331
 
        hook_calls = []
332
 
        commands.install_bzr_command_hooks()
333
 
        def list_my_commands(cmd_names):
334
 
            hook_calls.append('called')
335
 
            cmd_names.update(['foo', 'bar'])
336
 
            return cmd_names
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)
346
 
 
347
 
 
348
 
class TestDeprecations(tests.TestCase):
349
 
 
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')