← 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-12-05 14:12:23 UTC
  • mto: This revision was merged to the branch mainline in revision 6348.
  • Revision ID: jelmer@samba.org-20111205141223-8qxae4h37satlzgq
Move more functionality to vf_search.

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 TestInsideCommand(tests.TestCaseInTempDir):
 
95
 
 
96
    def test_command_see_config_overrides(self):
 
97
        def run(cmd):
 
98
            # We override the run() command method so we can observe the
 
99
            # overrides from inside.
 
100
            c = config.GlobalStack()
 
101
            self.assertEquals('12', c.get('xx'))
 
102
            self.assertEquals('foo', c.get('yy'))
 
103
        self.overrideAttr(builtins.cmd_rocks, 'run', run)
 
104
        self.run_bzr(['rocks', '-Oxx=12', '-Oyy=foo'])
 
105
        c = config.GlobalStack()
 
106
        # Ensure that we don't leak outside of the command
 
107
        self.assertEquals(None, c.get('xx'))
 
108
        self.assertEquals(None, c.get('yy'))
 
109
 
 
110
 
 
111
class TestInvokedAs(tests.TestCase):
 
112
 
 
113
    def test_invoked_as(self):
 
114
        """The command object knows the actual name used to invoke it."""
 
115
        commands.install_bzr_command_hooks()
 
116
        commands._register_builtin_commands()
 
117
        # get one from the real get_cmd_object.
 
118
        c = commands.get_cmd_object('ci')
 
119
        self.assertIsInstance(c, builtins.cmd_commit)
 
120
        self.assertEquals(c.invoked_as, 'ci')
 
121
 
 
122
 
82
123
class TestGetAlias(tests.TestCase):
83
124
 
84
125
    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)
 
126
        my_config = config.GlobalConfig.from_string(config_text)
88
127
        return my_config
89
128
 
90
129
    def test_simple(self):
111
150
 
112
151
    def test_unicode(self):
113
152
        my_config = self._get_config("[ALIASES]\n"
114
 
            u"iam=whoami 'Erik B\u00e5gfors <erik@bagfors.nu>'\n")
 
153
            u'iam=whoami "Erik B\u00e5gfors <erik@bagfors.nu>"\n')
115
154
        self.assertEqual([u'whoami', u'Erik B\u00e5gfors <erik@bagfors.nu>'],
116
155
                          commands.get_alias("iam", config=my_config))
117
156
 
119
158
class TestSeeAlso(tests.TestCase):
120
159
    """Tests for the see also functional of Command."""
121
160
 
 
161
    @staticmethod
 
162
    def _get_command_with_see_also(see_also):
 
163
        class ACommand(commands.Command):
 
164
            __doc__ = """A sample command."""
 
165
            _see_also = see_also
 
166
        return ACommand()
 
167
 
122
168
    def test_default_subclass_no_see_also(self):
123
 
        class ACommand(commands.Command):
124
 
            """A sample command."""
125
 
        command = ACommand()
 
169
        command = self._get_command_with_see_also([])
126
170
        self.assertEqual([], command.get_see_also())
127
171
 
128
172
    def test__see_also(self):
129
173
        """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()
 
174
        command = self._get_command_with_see_also(['bar', 'foo'])
133
175
        self.assertEqual(['bar', 'foo'], command.get_see_also())
134
176
 
135
177
    def test_deduplication(self):
136
178
        """Duplicates in _see_also are stripped out."""
137
 
        class ACommand(commands.Command):
138
 
            _see_also = ['foo', 'foo']
139
 
        command = ACommand()
 
179
        command = self._get_command_with_see_also(['foo', 'foo'])
140
180
        self.assertEqual(['foo'], command.get_see_also())
141
181
 
142
182
    def test_sorted(self):
143
183
        """_see_also is sorted by get_see_also."""
144
 
        class ACommand(commands.Command):
145
 
            _see_also = ['foo', 'bar']
146
 
        command = ACommand()
 
184
        command = self._get_command_with_see_also(['foo', 'bar'])
147
185
        self.assertEqual(['bar', 'foo'], command.get_see_also())
148
186
 
149
187
    def test_additional_terms(self):
150
188
        """Additional terms can be supplied and are deduped and sorted."""
151
 
        class ACommand(commands.Command):
152
 
            _see_also = ['foo', 'bar']
153
 
        command = ACommand()
 
189
        command = self._get_command_with_see_also(['foo', 'bar'])
154
190
        self.assertEqual(['bar', 'foo', 'gam'],
155
191
            command.get_see_also(['gam', 'bar', 'gam']))
156
192
 
210
246
        commands.Command.hooks.install_named_hook(
211
247
            "extend_command", hook_calls.append, None)
212
248
        # create a command, should not fire
213
 
        class ACommand(commands.Command):
214
 
            """A sample command."""
215
 
        cmd = ACommand()
 
249
        class cmd_test_extend_command_hook(commands.Command):
 
250
            __doc__ = """A sample command."""
216
251
        self.assertEqual([], hook_calls)
217
252
        # -- as a builtin
218
253
        # register the command class, should not fire
219
254
        try:
220
 
            builtins.cmd_test_extend_command_hook = ACommand
 
255
            commands.builtin_command_registry.register(cmd_test_extend_command_hook)
221
256
            self.assertEqual([], hook_calls)
222
257
            # and ask for the object, should fire
223
258
            cmd = commands.get_cmd_object('test-extend-command-hook')
227
262
            self.assertSubset([cmd], hook_calls)
228
263
            del hook_calls[:]
229
264
        finally:
230
 
            del builtins.cmd_test_extend_command_hook
 
265
            commands.builtin_command_registry.remove('test-extend-command-hook')
231
266
        # -- as a plugin lazy registration
232
267
        try:
233
268
            # register the command class, should not fire
249
284
        commands.install_bzr_command_hooks()
250
285
        hook_calls = []
251
286
        class ACommand(commands.Command):
252
 
            """A sample command."""
 
287
            __doc__ = """A sample command."""
253
288
        def get_cmd(cmd_or_None, cmd_name):
254
289
            hook_calls.append(('called', cmd_or_None, cmd_name))
255
290
            if cmd_name in ('foo', 'info'):
276
311
 
277
312
class TestGetMissingCommandHook(tests.TestCase):
278
313
 
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 = []
 
314
    def hook_missing(self):
 
315
        """Hook get_missing_command for testing."""
 
316
        self.hook_calls = []
283
317
        class ACommand(commands.Command):
284
 
            """A sample command."""
 
318
            __doc__ = """A sample command."""
285
319
        def get_missing_cmd(cmd_name):
286
 
            hook_calls.append(('called', cmd_name))
 
320
            self.hook_calls.append(('called', cmd_name))
287
321
            if cmd_name in ('foo', 'info'):
288
322
                return ACommand()
289
323
        commands.Command.hooks.install_named_hook(
290
324
            "get_missing_command", get_missing_cmd, None)
 
325
        self.ACommand = ACommand
 
326
 
 
327
    def test_fires_on_get_cmd_object(self):
 
328
        # The get_missing_command(cmd) hook fires when commands are delivered to the
 
329
        # ui.
 
330
        self.hook_missing()
291
331
        # create a command directly, should not fire
292
 
        cmd = ACommand()
293
 
        self.assertEqual([], hook_calls)
 
332
        self.cmd = self.ACommand()
 
333
        self.assertEqual([], self.hook_calls)
294
334
        # ask by name, should fire and give us our command
295
335
        cmd = commands.get_cmd_object('foo')
296
 
        self.assertEqual([('called', 'foo')], hook_calls)
297
 
        self.assertIsInstance(cmd, ACommand)
298
 
        del hook_calls[:]
 
336
        self.assertEqual([('called', 'foo')], self.hook_calls)
 
337
        self.assertIsInstance(cmd, self.ACommand)
 
338
        del self.hook_calls[:]
299
339
        # ask by a name that is supplied by a builtin - the hook should not
300
340
        # fire and we still get our object.
301
341
        commands.install_bzr_command_hooks()
302
342
        cmd = commands.get_cmd_object('info')
303
343
        self.assertNotEqual(None, cmd)
304
 
        self.assertEqual(0, len(hook_calls))
 
344
        self.assertEqual(0, len(self.hook_calls))
 
345
 
 
346
    def test_skipped_on_HelpCommandIndex_get_topics(self):
 
347
        # The get_missing_command(cmd_name) hook is not fired when
 
348
        # looking up help topics.
 
349
        self.hook_missing()
 
350
        topic = commands.HelpCommandIndex()
 
351
        topics = topic.get_topics('foo')
 
352
        self.assertEqual([], self.hook_calls)
305
353
 
306
354
 
307
355
class TestListCommandHook(tests.TestCase):