/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_commands.py

  • Committer: Martin Pool
  • Date: 2010-05-14 13:34:22 UTC
  • mto: This revision was merged to the branch mainline in revision 5252.
  • Revision ID: mbp@canonical.com-20100514133422-zcr5tt9vwy5ww1jj
Clean up and improve code review and contribution guidelines. 

Detangle "how to contribute code" from "how to review contributions".

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_commands.py
 
1
# Copyright (C) 2005-2010 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from cStringIO import StringIO
 
18
import errno
 
19
import sys
 
20
 
 
21
from bzrlib import (
 
22
    builtins,
 
23
    commands,
 
24
    config,
 
25
    errors,
 
26
    option,
 
27
    symbol_versioning,
 
28
    tests,
 
29
    )
 
30
from bzrlib.commands import display_command
 
31
from bzrlib.tests import TestSkipped
 
32
 
 
33
 
 
34
class TestCommands(tests.TestCase):
 
35
 
 
36
    def test_display_command(self):
 
37
        """EPIPE message is selectively suppressed"""
 
38
        def pipe_thrower():
 
39
            raise IOError(errno.EPIPE, "Bogus pipe error")
 
40
        self.assertRaises(IOError, pipe_thrower)
 
41
        @display_command
 
42
        def non_thrower():
 
43
            pipe_thrower()
 
44
        non_thrower()
 
45
        @display_command
 
46
        def other_thrower():
 
47
            raise IOError(errno.ESPIPE, "Bogus pipe error")
 
48
        self.assertRaises(IOError, other_thrower)
 
49
 
 
50
    def test_unicode_command(self):
 
51
        # This error is thrown when we can't find the command in the
 
52
        # list of available commands
 
53
        self.assertRaises(errors.BzrCommandError,
 
54
                          commands.run_bzr, [u'cmd\xb5'])
 
55
 
 
56
    def test_unicode_option(self):
 
57
        # This error is actually thrown by optparse, when it
 
58
        # can't find the given option
 
59
        import optparse
 
60
        if optparse.__version__ == "1.5.3":
 
61
            raise TestSkipped("optparse 1.5.3 can't handle unicode options")
 
62
        self.assertRaises(errors.BzrCommandError,
 
63
                          commands.run_bzr, ['log', u'--option\xb5'])
 
64
 
 
65
    @staticmethod
 
66
    def get_command(options):
 
67
        class cmd_foo(commands.Command):
 
68
            __doc__ = '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
 
 
82
    def test_no_help_init_failure(self):
 
83
        class cmd_foo(commands.Command):
 
84
            pass
 
85
        self.assertRaises(ValueError, cmd_foo)
 
86
 
 
87
 
 
88
class TestGetAlias(tests.TestCase):
 
89
 
 
90
    def _get_config(self, config_text):
 
91
        my_config = config.GlobalConfig()
 
92
        config_file = StringIO(config_text.encode('utf-8'))
 
93
        my_config._parser = my_config._get_parser(file=config_file)
 
94
        return my_config
 
95
 
 
96
    def test_simple(self):
 
97
        my_config = self._get_config("[ALIASES]\n"
 
98
            "diff=diff -r -2..-1\n")
 
99
        self.assertEqual([u'diff', u'-r', u'-2..-1'],
 
100
            commands.get_alias("diff", config=my_config))
 
101
 
 
102
    def test_single_quotes(self):
 
103
        my_config = self._get_config("[ALIASES]\n"
 
104
            "diff=diff -r -2..-1 --diff-options "
 
105
            "'--strip-trailing-cr -wp'\n")
 
106
        self.assertEqual([u'diff', u'-r', u'-2..-1', u'--diff-options',
 
107
                          u'--strip-trailing-cr -wp'],
 
108
                          commands.get_alias("diff", config=my_config))
 
109
 
 
110
    def test_double_quotes(self):
 
111
        my_config = self._get_config("[ALIASES]\n"
 
112
            "diff=diff -r -2..-1 --diff-options "
 
113
            "\"--strip-trailing-cr -wp\"\n")
 
114
        self.assertEqual([u'diff', u'-r', u'-2..-1', u'--diff-options',
 
115
                          u'--strip-trailing-cr -wp'],
 
116
                          commands.get_alias("diff", config=my_config))
 
117
 
 
118
    def test_unicode(self):
 
119
        my_config = self._get_config("[ALIASES]\n"
 
120
            u'iam=whoami "Erik B\u00e5gfors <erik@bagfors.nu>"\n')
 
121
        self.assertEqual([u'whoami', u'Erik B\u00e5gfors <erik@bagfors.nu>'],
 
122
                          commands.get_alias("iam", config=my_config))
 
123
 
 
124
 
 
125
class TestSeeAlso(tests.TestCase):
 
126
    """Tests for the see also functional of Command."""
 
127
 
 
128
    @staticmethod
 
129
    def _get_command_with_see_also(see_also):
 
130
        class ACommand(commands.Command):
 
131
            __doc__ = """A sample command."""
 
132
            _see_also = see_also
 
133
        return ACommand()
 
134
 
 
135
    def test_default_subclass_no_see_also(self):
 
136
        command = self._get_command_with_see_also([])
 
137
        self.assertEqual([], command.get_see_also())
 
138
 
 
139
    def test__see_also(self):
 
140
        """When _see_also is defined, it sets the result of get_see_also()."""
 
141
        command = self._get_command_with_see_also(['bar', 'foo'])
 
142
        self.assertEqual(['bar', 'foo'], command.get_see_also())
 
143
 
 
144
    def test_deduplication(self):
 
145
        """Duplicates in _see_also are stripped out."""
 
146
        command = self._get_command_with_see_also(['foo', 'foo'])
 
147
        self.assertEqual(['foo'], command.get_see_also())
 
148
 
 
149
    def test_sorted(self):
 
150
        """_see_also is sorted by get_see_also."""
 
151
        command = self._get_command_with_see_also(['foo', 'bar'])
 
152
        self.assertEqual(['bar', 'foo'], command.get_see_also())
 
153
 
 
154
    def test_additional_terms(self):
 
155
        """Additional terms can be supplied and are deduped and sorted."""
 
156
        command = self._get_command_with_see_also(['foo', 'bar'])
 
157
        self.assertEqual(['bar', 'foo', 'gam'],
 
158
            command.get_see_also(['gam', 'bar', 'gam']))
 
159
 
 
160
 
 
161
class TestRegisterLazy(tests.TestCase):
 
162
 
 
163
    def setUp(self):
 
164
        tests.TestCase.setUp(self)
 
165
        import bzrlib.tests.fake_command
 
166
        del sys.modules['bzrlib.tests.fake_command']
 
167
        global lazy_command_imported
 
168
        lazy_command_imported = False
 
169
        commands.install_bzr_command_hooks()
 
170
 
 
171
    @staticmethod
 
172
    def remove_fake():
 
173
        commands.plugin_cmds.remove('fake')
 
174
 
 
175
    def assertIsFakeCommand(self, cmd_obj):
 
176
        from bzrlib.tests.fake_command import cmd_fake
 
177
        self.assertIsInstance(cmd_obj, cmd_fake)
 
178
 
 
179
    def test_register_lazy(self):
 
180
        """Ensure lazy registration works"""
 
181
        commands.plugin_cmds.register_lazy('cmd_fake', [],
 
182
                                           'bzrlib.tests.fake_command')
 
183
        self.addCleanup(self.remove_fake)
 
184
        self.assertFalse(lazy_command_imported)
 
185
        fake_instance = commands.get_cmd_object('fake')
 
186
        self.assertTrue(lazy_command_imported)
 
187
        self.assertIsFakeCommand(fake_instance)
 
188
 
 
189
    def test_get_unrelated_does_not_import(self):
 
190
        commands.plugin_cmds.register_lazy('cmd_fake', [],
 
191
                                           'bzrlib.tests.fake_command')
 
192
        self.addCleanup(self.remove_fake)
 
193
        commands.get_cmd_object('status')
 
194
        self.assertFalse(lazy_command_imported)
 
195
 
 
196
    def test_aliases(self):
 
197
        commands.plugin_cmds.register_lazy('cmd_fake', ['fake_alias'],
 
198
                                           'bzrlib.tests.fake_command')
 
199
        self.addCleanup(self.remove_fake)
 
200
        fake_instance = commands.get_cmd_object('fake_alias')
 
201
        self.assertIsFakeCommand(fake_instance)
 
202
 
 
203
 
 
204
class TestExtendCommandHook(tests.TestCase):
 
205
 
 
206
    def test_fires_on_get_cmd_object(self):
 
207
        # The extend_command(cmd) hook fires when commands are delivered to the
 
208
        # ui, not simply at registration (because lazy registered plugin
 
209
        # commands are registered).
 
210
        # when they are simply created.
 
211
        hook_calls = []
 
212
        commands.install_bzr_command_hooks()
 
213
        commands.Command.hooks.install_named_hook(
 
214
            "extend_command", hook_calls.append, None)
 
215
        # create a command, should not fire
 
216
        class cmd_test_extend_command_hook(commands.Command):
 
217
            __doc__ = """A sample command."""
 
218
        self.assertEqual([], hook_calls)
 
219
        # -- as a builtin
 
220
        # register the command class, should not fire
 
221
        try:
 
222
            commands.builtin_command_registry.register(cmd_test_extend_command_hook)
 
223
            self.assertEqual([], hook_calls)
 
224
            # and ask for the object, should fire
 
225
            cmd = commands.get_cmd_object('test-extend-command-hook')
 
226
            # For resilience - to ensure all code paths hit it - we
 
227
            # fire on everything returned in the 'cmd_dict', which is currently
 
228
            # all known commands, so assert that cmd is in hook_calls
 
229
            self.assertSubset([cmd], hook_calls)
 
230
            del hook_calls[:]
 
231
        finally:
 
232
            commands.builtin_command_registry.remove('test-extend-command-hook')
 
233
        # -- as a plugin lazy registration
 
234
        try:
 
235
            # register the command class, should not fire
 
236
            commands.plugin_cmds.register_lazy('cmd_fake', [],
 
237
                                               'bzrlib.tests.fake_command')
 
238
            self.assertEqual([], hook_calls)
 
239
            # and ask for the object, should fire
 
240
            cmd = commands.get_cmd_object('fake')
 
241
            self.assertEqual([cmd], hook_calls)
 
242
        finally:
 
243
            commands.plugin_cmds.remove('fake')
 
244
 
 
245
 
 
246
class TestGetCommandHook(tests.TestCase):
 
247
 
 
248
    def test_fires_on_get_cmd_object(self):
 
249
        # The get_command(cmd) hook fires when commands are delivered to the
 
250
        # ui.
 
251
        commands.install_bzr_command_hooks()
 
252
        hook_calls = []
 
253
        class ACommand(commands.Command):
 
254
            __doc__ = """A sample command."""
 
255
        def get_cmd(cmd_or_None, cmd_name):
 
256
            hook_calls.append(('called', cmd_or_None, cmd_name))
 
257
            if cmd_name in ('foo', 'info'):
 
258
                return ACommand()
 
259
        commands.Command.hooks.install_named_hook(
 
260
            "get_command", get_cmd, None)
 
261
        # create a command directly, should not fire
 
262
        cmd = ACommand()
 
263
        self.assertEqual([], hook_calls)
 
264
        # ask by name, should fire and give us our command
 
265
        cmd = commands.get_cmd_object('foo')
 
266
        self.assertEqual([('called', None, 'foo')], hook_calls)
 
267
        self.assertIsInstance(cmd, ACommand)
 
268
        del hook_calls[:]
 
269
        # ask by a name that is supplied by a builtin - the hook should still
 
270
        # fire and we still get our object, but we should see the builtin
 
271
        # passed to the hook.
 
272
        cmd = commands.get_cmd_object('info')
 
273
        self.assertIsInstance(cmd, ACommand)
 
274
        self.assertEqual(1, len(hook_calls))
 
275
        self.assertEqual('info', hook_calls[0][2])
 
276
        self.assertIsInstance(hook_calls[0][1], builtins.cmd_info)
 
277
 
 
278
 
 
279
class TestGetMissingCommandHook(tests.TestCase):
 
280
 
 
281
    def hook_missing(self):
 
282
        """Hook get_missing_command for testing."""
 
283
        self.hook_calls = []
 
284
        class ACommand(commands.Command):
 
285
            __doc__ = """A sample command."""
 
286
        def get_missing_cmd(cmd_name):
 
287
            self.hook_calls.append(('called', cmd_name))
 
288
            if cmd_name in ('foo', 'info'):
 
289
                return ACommand()
 
290
        commands.Command.hooks.install_named_hook(
 
291
            "get_missing_command", get_missing_cmd, None)
 
292
        self.ACommand = ACommand
 
293
 
 
294
    def test_fires_on_get_cmd_object(self):
 
295
        # The get_missing_command(cmd) hook fires when commands are delivered to the
 
296
        # ui.
 
297
        self.hook_missing()
 
298
        # create a command directly, should not fire
 
299
        self.cmd = self.ACommand()
 
300
        self.assertEqual([], self.hook_calls)
 
301
        # ask by name, should fire and give us our command
 
302
        cmd = commands.get_cmd_object('foo')
 
303
        self.assertEqual([('called', 'foo')], self.hook_calls)
 
304
        self.assertIsInstance(cmd, self.ACommand)
 
305
        del self.hook_calls[:]
 
306
        # ask by a name that is supplied by a builtin - the hook should not
 
307
        # fire and we still get our object.
 
308
        commands.install_bzr_command_hooks()
 
309
        cmd = commands.get_cmd_object('info')
 
310
        self.assertNotEqual(None, cmd)
 
311
        self.assertEqual(0, len(self.hook_calls))
 
312
 
 
313
    def test_skipped_on_HelpCommandIndex_get_topics(self):
 
314
        # The get_missing_command(cmd_name) hook is not fired when
 
315
        # looking up help topics.
 
316
        self.hook_missing()
 
317
        topic = commands.HelpCommandIndex()
 
318
        topics = topic.get_topics('foo')
 
319
        self.assertEqual([], self.hook_calls)
 
320
 
 
321
 
 
322
class TestListCommandHook(tests.TestCase):
 
323
 
 
324
    def test_fires_on_all_command_names(self):
 
325
        # The list_commands() hook fires when all_command_names() is invoked.
 
326
        hook_calls = []
 
327
        commands.install_bzr_command_hooks()
 
328
        def list_my_commands(cmd_names):
 
329
            hook_calls.append('called')
 
330
            cmd_names.update(['foo', 'bar'])
 
331
            return cmd_names
 
332
        commands.Command.hooks.install_named_hook(
 
333
            "list_commands", list_my_commands, None)
 
334
        # Get a command, which should not trigger the hook.
 
335
        cmd = commands.get_cmd_object('info')
 
336
        self.assertEqual([], hook_calls)
 
337
        # Get all command classes (for docs and shell completion).
 
338
        cmds = list(commands.all_command_names())
 
339
        self.assertEqual(['called'], hook_calls)
 
340
        self.assertSubset(['foo', 'bar'], cmds)
 
341
 
 
342
class TestDeprecations(tests.TestCase):
 
343
 
 
344
    def test_shlex_split_unicode_deprecation(self):
 
345
        res = self.applyDeprecated(
 
346
                symbol_versioning.deprecated_in((2, 2, 0)),
 
347
                commands.shlex_split_unicode, 'whatever')