← 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: Andrew Bennetts
  • Date: 2009-04-02 05:53:12 UTC
  • mto: This revision was merged to the branch mainline in revision 4242.
  • Revision ID: andrew.bennetts@canonical.com-20090402055312-h7mvgumvm7e620mj
Fix nits in spelling and naming.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_commands.py
1
 
# Copyright (C) 2005-2011 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
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
17
18
import errno
18
 
import inspect
19
19
import sys
20
20
 
21
21
from bzrlib import (
23
23
    commands,
24
24
    config,
25
25
    errors,
26
 
    option,
27
 
    symbol_versioning,
28
26
    tests,
29
27
    )
30
28
from bzrlib.commands import display_command
33
31
 
34
32
class TestCommands(tests.TestCase):
35
33
 
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
 
 
47
34
    def test_display_command(self):
48
35
        """EPIPE message is selectively suppressed"""
49
36
        def pipe_thrower():
73
60
        self.assertRaises(errors.BzrCommandError,
74
61
                          commands.run_bzr, ['log', u'--option\xb5'])
75
62
 
76
 
    @staticmethod
77
 
    def get_command(options):
78
 
        class cmd_foo(commands.Command):
79
 
            __doc__ = 'Bar'
80
 
 
81
 
            takes_options = options
82
 
 
83
 
        return cmd_foo()
84
 
 
85
 
    def test_help_hidden(self):
86
 
        c = self.get_command([option.Option('foo', hidden=True)])
87
 
        self.assertNotContainsRe(c.get_help_text(), '--foo')
88
 
 
89
 
    def test_help_not_hidden(self):
90
 
        c = self.get_command([option.Option('foo', hidden=False)])
91
 
        self.assertContainsRe(c.get_help_text(), '--foo')
92
 
 
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
63
 
106
64
class TestGetAlias(tests.TestCase):
107
65
 
108
66
    def _get_config(self, config_text):
109
 
        my_config = config.GlobalConfig.from_string(config_text)
 
67
        my_config = config.GlobalConfig()
 
68
        config_file = StringIO(config_text.encode('utf-8'))
 
69
        my_config._parser = my_config._get_parser(file=config_file)
110
70
        return my_config
111
71
 
112
72
    def test_simple(self):
133
93
 
134
94
    def test_unicode(self):
135
95
        my_config = self._get_config("[ALIASES]\n"
136
 
            u'iam=whoami "Erik B\u00e5gfors <erik@bagfors.nu>"\n')
 
96
            u"iam=whoami 'Erik B\u00e5gfors <erik@bagfors.nu>'\n")
137
97
        self.assertEqual([u'whoami', u'Erik B\u00e5gfors <erik@bagfors.nu>'],
138
98
                          commands.get_alias("iam", config=my_config))
139
99
 
141
101
class TestSeeAlso(tests.TestCase):
142
102
    """Tests for the see also functional of Command."""
143
103
 
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
 
 
151
104
    def test_default_subclass_no_see_also(self):
152
 
        command = self._get_command_with_see_also([])
 
105
        class ACommand(commands.Command):
 
106
            """A sample command."""
 
107
        command = ACommand()
153
108
        self.assertEqual([], command.get_see_also())
154
109
 
155
110
    def test__see_also(self):
156
111
        """When _see_also is defined, it sets the result of get_see_also()."""
157
 
        command = self._get_command_with_see_also(['bar', 'foo'])
 
112
        class ACommand(commands.Command):
 
113
            _see_also = ['bar', 'foo']
 
114
        command = ACommand()
158
115
        self.assertEqual(['bar', 'foo'], command.get_see_also())
159
116
 
160
117
    def test_deduplication(self):
161
118
        """Duplicates in _see_also are stripped out."""
162
 
        command = self._get_command_with_see_also(['foo', 'foo'])
 
119
        class ACommand(commands.Command):
 
120
            _see_also = ['foo', 'foo']
 
121
        command = ACommand()
163
122
        self.assertEqual(['foo'], command.get_see_also())
164
123
 
165
124
    def test_sorted(self):
166
125
        """_see_also is sorted by get_see_also."""
167
 
        command = self._get_command_with_see_also(['foo', 'bar'])
 
126
        class ACommand(commands.Command):
 
127
            _see_also = ['foo', 'bar']
 
128
        command = ACommand()
168
129
        self.assertEqual(['bar', 'foo'], command.get_see_also())
169
130
 
170
131
    def test_additional_terms(self):
171
132
        """Additional terms can be supplied and are deduped and sorted."""
172
 
        command = self._get_command_with_see_also(['foo', 'bar'])
 
133
        class ACommand(commands.Command):
 
134
            _see_also = ['foo', 'bar']
 
135
        command = ACommand()
173
136
        self.assertEqual(['bar', 'foo', 'gam'],
174
137
            command.get_see_also(['gam', 'bar', 'gam']))
175
138
 
182
145
        del sys.modules['bzrlib.tests.fake_command']
183
146
        global lazy_command_imported
184
147
        lazy_command_imported = False
185
 
        commands.install_bzr_command_hooks()
186
148
 
187
149
    @staticmethod
188
150
    def remove_fake():
225
187
        # commands are registered).
226
188
        # when they are simply created.
227
189
        hook_calls = []
228
 
        commands.install_bzr_command_hooks()
229
190
        commands.Command.hooks.install_named_hook(
230
191
            "extend_command", hook_calls.append, None)
231
192
        # create a command, should not fire
232
 
        class cmd_test_extend_command_hook(commands.Command):
233
 
            __doc__ = """A sample command."""
 
193
        class ACommand(commands.Command):
 
194
            """A sample command."""
 
195
        cmd = ACommand()
234
196
        self.assertEqual([], hook_calls)
235
197
        # -- as a builtin
236
198
        # register the command class, should not fire
237
199
        try:
238
 
            commands.builtin_command_registry.register(cmd_test_extend_command_hook)
 
200
            builtins.cmd_test_extend_command_hook = ACommand
239
201
            self.assertEqual([], hook_calls)
240
202
            # and ask for the object, should fire
241
203
            cmd = commands.get_cmd_object('test-extend-command-hook')
245
207
            self.assertSubset([cmd], hook_calls)
246
208
            del hook_calls[:]
247
209
        finally:
248
 
            commands.builtin_command_registry.remove('test-extend-command-hook')
 
210
            del builtins.cmd_test_extend_command_hook
249
211
        # -- as a plugin lazy registration
250
212
        try:
251
213
            # register the command class, should not fire
257
219
            self.assertEqual([cmd], hook_calls)
258
220
        finally:
259
221
            commands.plugin_cmds.remove('fake')
260
 
 
261
 
 
262
 
class TestGetCommandHook(tests.TestCase):
263
 
 
264
 
    def test_fires_on_get_cmd_object(self):
265
 
        # The get_command(cmd) hook fires when commands are delivered to the
266
 
        # ui.
267
 
        commands.install_bzr_command_hooks()
268
 
        hook_calls = []
269
 
        class ACommand(commands.Command):
270
 
            __doc__ = """A sample command."""
271
 
        def get_cmd(cmd_or_None, cmd_name):
272
 
            hook_calls.append(('called', cmd_or_None, cmd_name))
273
 
            if cmd_name in ('foo', 'info'):
274
 
                return ACommand()
275
 
        commands.Command.hooks.install_named_hook(
276
 
            "get_command", get_cmd, None)
277
 
        # create a command directly, should not fire
278
 
        cmd = ACommand()
279
 
        self.assertEqual([], hook_calls)
280
 
        # ask by name, should fire and give us our command
281
 
        cmd = commands.get_cmd_object('foo')
282
 
        self.assertEqual([('called', None, 'foo')], hook_calls)
283
 
        self.assertIsInstance(cmd, ACommand)
284
 
        del hook_calls[:]
285
 
        # ask by a name that is supplied by a builtin - the hook should still
286
 
        # fire and we still get our object, but we should see the builtin
287
 
        # passed to the hook.
288
 
        cmd = commands.get_cmd_object('info')
289
 
        self.assertIsInstance(cmd, ACommand)
290
 
        self.assertEqual(1, len(hook_calls))
291
 
        self.assertEqual('info', hook_calls[0][2])
292
 
        self.assertIsInstance(hook_calls[0][1], builtins.cmd_info)
293
 
 
294
 
 
295
 
class TestGetMissingCommandHook(tests.TestCase):
296
 
 
297
 
    def hook_missing(self):
298
 
        """Hook get_missing_command for testing."""
299
 
        self.hook_calls = []
300
 
        class ACommand(commands.Command):
301
 
            __doc__ = """A sample command."""
302
 
        def get_missing_cmd(cmd_name):
303
 
            self.hook_calls.append(('called', cmd_name))
304
 
            if cmd_name in ('foo', 'info'):
305
 
                return ACommand()
306
 
        commands.Command.hooks.install_named_hook(
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()
314
 
        # create a command directly, should not fire
315
 
        self.cmd = self.ACommand()
316
 
        self.assertEqual([], self.hook_calls)
317
 
        # ask by name, should fire and give us our command
318
 
        cmd = commands.get_cmd_object('foo')
319
 
        self.assertEqual([('called', 'foo')], self.hook_calls)
320
 
        self.assertIsInstance(cmd, self.ACommand)
321
 
        del self.hook_calls[:]
322
 
        # ask by a name that is supplied by a builtin - the hook should not
323
 
        # fire and we still get our object.
324
 
        commands.install_bzr_command_hooks()
325
 
        cmd = commands.get_cmd_object('info')
326
 
        self.assertNotEqual(None, cmd)
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)
336
 
 
337
 
 
338
 
class TestListCommandHook(tests.TestCase):
339
 
 
340
 
    def test_fires_on_all_command_names(self):
341
 
        # The list_commands() hook fires when all_command_names() is invoked.
342
 
        hook_calls = []
343
 
        commands.install_bzr_command_hooks()
344
 
        def list_my_commands(cmd_names):
345
 
            hook_calls.append('called')
346
 
            cmd_names.update(['foo', 'bar'])
347
 
            return cmd_names
348
 
        commands.Command.hooks.install_named_hook(
349
 
            "list_commands", list_my_commands, None)
350
 
        # Get a command, which should not trigger the hook.
351
 
        cmd = commands.get_cmd_object('info')
352
 
        self.assertEqual([], hook_calls)
353
 
        # Get all command classes (for docs and shell completion).
354
 
        cmds = list(commands.all_command_names())
355
 
        self.assertEqual(['called'], hook_calls)
356
 
        self.assertSubset(['foo', 'bar'], cmds)