← 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: Jelmer Vernooij
  • Date: 2011-09-26 15:21:01 UTC
  • mfrom: (6165.2.3 avoid-revision-history)
  • mto: This revision was merged to the branch mainline in revision 6216.
  • Revision ID: jelmer@samba.org-20110926152101-afcxw1hikybyivfd
merge avoid-revision-history.

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-2011 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from cStringIO import StringIO
18
17
import errno
 
18
import inspect
19
19
import sys
20
20
 
21
21
from bzrlib import (
24
24
    config,
25
25
    errors,
26
26
    option,
 
27
    symbol_versioning,
27
28
    tests,
28
29
    )
29
30
from bzrlib.commands import display_command
32
33
 
33
34
class TestCommands(tests.TestCase):
34
35
 
 
36
    def test_all_commands_have_help(self):
 
37
        commands._register_builtin_commands()
 
38
        commands_without_help = set()
 
39
        base_doc = inspect.getdoc(commands.Command)
 
40
        for cmd_name in commands.all_command_names():
 
41
            cmd = commands.get_cmd_object(cmd_name)
 
42
            cmd_help = cmd.help()
 
43
            if not cmd_help or cmd_help == base_doc:
 
44
                commands_without_help.append(cmd_name)
 
45
        self.assertLength(0, commands_without_help)
 
46
 
35
47
    def test_display_command(self):
36
48
        """EPIPE message is selectively suppressed"""
37
49
        def pipe_thrower():
64
76
    @staticmethod
65
77
    def get_command(options):
66
78
        class cmd_foo(commands.Command):
67
 
            'Bar'
 
79
            __doc__ = 'Bar'
68
80
 
69
81
            takes_options = options
70
82
 
79
91
        self.assertContainsRe(c.get_help_text(), '--foo')
80
92
 
81
93
 
 
94
class TestInvokedAs(tests.TestCase):
 
95
 
 
96
    def test_invoked_as(self):
 
97
        """The command object knows the actual name used to invoke it."""
 
98
        commands.install_bzr_command_hooks()
 
99
        commands._register_builtin_commands()
 
100
        # get one from the real get_cmd_object.
 
101
        c = commands.get_cmd_object('ci')
 
102
        self.assertIsInstance(c, builtins.cmd_commit)
 
103
        self.assertEquals(c.invoked_as, 'ci')
 
104
 
 
105
 
82
106
class TestGetAlias(tests.TestCase):
83
107
 
84
108
    def _get_config(self, 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)
 
109
        my_config = config.GlobalConfig.from_string(config_text)
88
110
        return my_config
89
111
 
90
112
    def test_simple(self):
111
133
 
112
134
    def test_unicode(self):
113
135
        my_config = self._get_config("[ALIASES]\n"
114
 
            u"iam=whoami 'Erik B\u00e5gfors <erik@bagfors.nu>'\n")
 
136
            u'iam=whoami "Erik B\u00e5gfors <erik@bagfors.nu>"\n')
115
137
        self.assertEqual([u'whoami', u'Erik B\u00e5gfors <erik@bagfors.nu>'],
116
138
                          commands.get_alias("iam", config=my_config))
117
139
 
119
141
class TestSeeAlso(tests.TestCase):
120
142
    """Tests for the see also functional of Command."""
121
143
 
 
144
    @staticmethod
 
145
    def _get_command_with_see_also(see_also):
 
146
        class ACommand(commands.Command):
 
147
            __doc__ = """A sample command."""
 
148
            _see_also = see_also
 
149
        return ACommand()
 
150
 
122
151
    def test_default_subclass_no_see_also(self):
123
 
        class ACommand(commands.Command):
124
 
            """A sample command."""
125
 
        command = ACommand()
 
152
        command = self._get_command_with_see_also([])
126
153
        self.assertEqual([], command.get_see_also())
127
154
 
128
155
    def test__see_also(self):
129
156
        """When _see_also is defined, it sets the result of get_see_also()."""
130
 
        class ACommand(commands.Command):
131
 
            _see_also = ['bar', 'foo']
132
 
        command = ACommand()
 
157
        command = self._get_command_with_see_also(['bar', 'foo'])
133
158
        self.assertEqual(['bar', 'foo'], command.get_see_also())
134
159
 
135
160
    def test_deduplication(self):
136
161
        """Duplicates in _see_also are stripped out."""
137
 
        class ACommand(commands.Command):
138
 
            _see_also = ['foo', 'foo']
139
 
        command = ACommand()
 
162
        command = self._get_command_with_see_also(['foo', 'foo'])
140
163
        self.assertEqual(['foo'], command.get_see_also())
141
164
 
142
165
    def test_sorted(self):
143
166
        """_see_also is sorted by get_see_also."""
144
 
        class ACommand(commands.Command):
145
 
            _see_also = ['foo', 'bar']
146
 
        command = ACommand()
 
167
        command = self._get_command_with_see_also(['foo', 'bar'])
147
168
        self.assertEqual(['bar', 'foo'], command.get_see_also())
148
169
 
149
170
    def test_additional_terms(self):
150
171
        """Additional terms can be supplied and are deduped and sorted."""
151
 
        class ACommand(commands.Command):
152
 
            _see_also = ['foo', 'bar']
153
 
        command = ACommand()
 
172
        command = self._get_command_with_see_also(['foo', 'bar'])
154
173
        self.assertEqual(['bar', 'foo', 'gam'],
155
174
            command.get_see_also(['gam', 'bar', 'gam']))
156
175
 
210
229
        commands.Command.hooks.install_named_hook(
211
230
            "extend_command", hook_calls.append, None)
212
231
        # create a command, should not fire
213
 
        class ACommand(commands.Command):
214
 
            """A sample command."""
215
 
        cmd = ACommand()
 
232
        class cmd_test_extend_command_hook(commands.Command):
 
233
            __doc__ = """A sample command."""
216
234
        self.assertEqual([], hook_calls)
217
235
        # -- as a builtin
218
236
        # register the command class, should not fire
219
237
        try:
220
 
            builtins.cmd_test_extend_command_hook = ACommand
 
238
            commands.builtin_command_registry.register(cmd_test_extend_command_hook)
221
239
            self.assertEqual([], hook_calls)
222
240
            # and ask for the object, should fire
223
241
            cmd = commands.get_cmd_object('test-extend-command-hook')
227
245
            self.assertSubset([cmd], hook_calls)
228
246
            del hook_calls[:]
229
247
        finally:
230
 
            del builtins.cmd_test_extend_command_hook
 
248
            commands.builtin_command_registry.remove('test-extend-command-hook')
231
249
        # -- as a plugin lazy registration
232
250
        try:
233
251
            # register the command class, should not fire
249
267
        commands.install_bzr_command_hooks()
250
268
        hook_calls = []
251
269
        class ACommand(commands.Command):
252
 
            """A sample command."""
 
270
            __doc__ = """A sample command."""
253
271
        def get_cmd(cmd_or_None, cmd_name):
254
272
            hook_calls.append(('called', cmd_or_None, cmd_name))
255
273
            if cmd_name in ('foo', 'info'):
276
294
 
277
295
class TestGetMissingCommandHook(tests.TestCase):
278
296
 
279
 
    def test_fires_on_get_cmd_object(self):
280
 
        # The get_missing_command(cmd) hook fires when commands are delivered to the
281
 
        # ui.
282
 
        hook_calls = []
 
297
    def hook_missing(self):
 
298
        """Hook get_missing_command for testing."""
 
299
        self.hook_calls = []
283
300
        class ACommand(commands.Command):
284
 
            """A sample command."""
 
301
            __doc__ = """A sample command."""
285
302
        def get_missing_cmd(cmd_name):
286
 
            hook_calls.append(('called', cmd_name))
 
303
            self.hook_calls.append(('called', cmd_name))
287
304
            if cmd_name in ('foo', 'info'):
288
305
                return ACommand()
289
306
        commands.Command.hooks.install_named_hook(
290
307
            "get_missing_command", get_missing_cmd, None)
 
308
        self.ACommand = ACommand
 
309
 
 
310
    def test_fires_on_get_cmd_object(self):
 
311
        # The get_missing_command(cmd) hook fires when commands are delivered to the
 
312
        # ui.
 
313
        self.hook_missing()
291
314
        # create a command directly, should not fire
292
 
        cmd = ACommand()
293
 
        self.assertEqual([], hook_calls)
 
315
        self.cmd = self.ACommand()
 
316
        self.assertEqual([], self.hook_calls)
294
317
        # ask by name, should fire and give us our command
295
318
        cmd = commands.get_cmd_object('foo')
296
 
        self.assertEqual([('called', 'foo')], hook_calls)
297
 
        self.assertIsInstance(cmd, ACommand)
298
 
        del hook_calls[:]
 
319
        self.assertEqual([('called', 'foo')], self.hook_calls)
 
320
        self.assertIsInstance(cmd, self.ACommand)
 
321
        del self.hook_calls[:]
299
322
        # ask by a name that is supplied by a builtin - the hook should not
300
323
        # fire and we still get our object.
301
324
        commands.install_bzr_command_hooks()
302
325
        cmd = commands.get_cmd_object('info')
303
326
        self.assertNotEqual(None, cmd)
304
 
        self.assertEqual(0, len(hook_calls))
 
327
        self.assertEqual(0, len(self.hook_calls))
 
328
 
 
329
    def test_skipped_on_HelpCommandIndex_get_topics(self):
 
330
        # The get_missing_command(cmd_name) hook is not fired when
 
331
        # looking up help topics.
 
332
        self.hook_missing()
 
333
        topic = commands.HelpCommandIndex()
 
334
        topics = topic.get_topics('foo')
 
335
        self.assertEqual([], self.hook_calls)
305
336
 
306
337
 
307
338
class TestListCommandHook(tests.TestCase):