← 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: Patch Queue Manager
  • Date: 2016-04-21 05:06:57 UTC
  • mfrom: (6603.4.1 bzr)
  • Revision ID: pqm@pqm.ubuntu.com-20160421050657-ygnzfybewvudf1j9
(richard-wilbur) Use initial_comment as commit_message for lp_propose.(Shawn
 Wang) (Shawn Wang)

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-2012, 2016 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,
28
27
    tests,
 
28
    trace,
29
29
    )
30
30
from bzrlib.commands import display_command
31
31
from bzrlib.tests import TestSkipped
33
33
 
34
34
class TestCommands(tests.TestCase):
35
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
 
36
47
    def test_display_command(self):
37
48
        """EPIPE message is selectively suppressed"""
38
49
        def pipe_thrower():
65
76
    @staticmethod
66
77
    def get_command(options):
67
78
        class cmd_foo(commands.Command):
68
 
            'Bar'
 
79
            __doc__ = 'Bar'
69
80
 
70
81
            takes_options = options
71
82
 
80
91
        self.assertContainsRe(c.get_help_text(), '--foo')
81
92
 
82
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.assertEqual('12', c.get('xx'))
 
102
            self.assertEqual('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.assertEqual(None, c.get('xx'))
 
108
        self.assertEqual(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.assertEqual(c.invoked_as, 'ci')
 
121
 
 
122
 
83
123
class TestGetAlias(tests.TestCase):
84
124
 
85
125
    def _get_config(self, config_text):
86
 
        my_config = config.GlobalConfig()
87
 
        config_file = StringIO(config_text.encode('utf-8'))
88
 
        my_config._parser = my_config._get_parser(file=config_file)
 
126
        my_config = config.GlobalConfig.from_string(config_text)
89
127
        return my_config
90
128
 
91
129
    def test_simple(self):
120
158
class TestSeeAlso(tests.TestCase):
121
159
    """Tests for the see also functional of Command."""
122
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
 
123
168
    def test_default_subclass_no_see_also(self):
124
 
        class ACommand(commands.Command):
125
 
            """A sample command."""
126
 
        command = ACommand()
 
169
        command = self._get_command_with_see_also([])
127
170
        self.assertEqual([], command.get_see_also())
128
171
 
129
172
    def test__see_also(self):
130
173
        """When _see_also is defined, it sets the result of get_see_also()."""
131
 
        class ACommand(commands.Command):
132
 
            _see_also = ['bar', 'foo']
133
 
        command = ACommand()
 
174
        command = self._get_command_with_see_also(['bar', 'foo'])
134
175
        self.assertEqual(['bar', 'foo'], command.get_see_also())
135
176
 
136
177
    def test_deduplication(self):
137
178
        """Duplicates in _see_also are stripped out."""
138
 
        class ACommand(commands.Command):
139
 
            _see_also = ['foo', 'foo']
140
 
        command = ACommand()
 
179
        command = self._get_command_with_see_also(['foo', 'foo'])
141
180
        self.assertEqual(['foo'], command.get_see_also())
142
181
 
143
182
    def test_sorted(self):
144
183
        """_see_also is sorted by get_see_also."""
145
 
        class ACommand(commands.Command):
146
 
            _see_also = ['foo', 'bar']
147
 
        command = ACommand()
 
184
        command = self._get_command_with_see_also(['foo', 'bar'])
148
185
        self.assertEqual(['bar', 'foo'], command.get_see_also())
149
186
 
150
187
    def test_additional_terms(self):
151
188
        """Additional terms can be supplied and are deduped and sorted."""
152
 
        class ACommand(commands.Command):
153
 
            _see_also = ['foo', 'bar']
154
 
        command = ACommand()
 
189
        command = self._get_command_with_see_also(['foo', 'bar'])
155
190
        self.assertEqual(['bar', 'foo', 'gam'],
156
191
            command.get_see_also(['gam', 'bar', 'gam']))
157
192
 
159
194
class TestRegisterLazy(tests.TestCase):
160
195
 
161
196
    def setUp(self):
162
 
        tests.TestCase.setUp(self)
 
197
        super(TestRegisterLazy, self).setUp()
163
198
        import bzrlib.tests.fake_command
164
199
        del sys.modules['bzrlib.tests.fake_command']
165
200
        global lazy_command_imported
211
246
        commands.Command.hooks.install_named_hook(
212
247
            "extend_command", hook_calls.append, None)
213
248
        # create a command, should not fire
214
 
        class ACommand(commands.Command):
215
 
            """A sample command."""
216
 
        cmd = ACommand()
 
249
        class cmd_test_extend_command_hook(commands.Command):
 
250
            __doc__ = """A sample command."""
217
251
        self.assertEqual([], hook_calls)
218
252
        # -- as a builtin
219
253
        # register the command class, should not fire
220
254
        try:
221
 
            builtins.cmd_test_extend_command_hook = ACommand
 
255
            commands.builtin_command_registry.register(cmd_test_extend_command_hook)
222
256
            self.assertEqual([], hook_calls)
223
257
            # and ask for the object, should fire
224
258
            cmd = commands.get_cmd_object('test-extend-command-hook')
228
262
            self.assertSubset([cmd], hook_calls)
229
263
            del hook_calls[:]
230
264
        finally:
231
 
            del builtins.cmd_test_extend_command_hook
 
265
            commands.builtin_command_registry.remove('test-extend-command-hook')
232
266
        # -- as a plugin lazy registration
233
267
        try:
234
268
            # register the command class, should not fire
250
284
        commands.install_bzr_command_hooks()
251
285
        hook_calls = []
252
286
        class ACommand(commands.Command):
253
 
            """A sample command."""
 
287
            __doc__ = """A sample command."""
254
288
        def get_cmd(cmd_or_None, cmd_name):
255
289
            hook_calls.append(('called', cmd_or_None, cmd_name))
256
290
            if cmd_name in ('foo', 'info'):
281
315
        """Hook get_missing_command for testing."""
282
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
320
            self.hook_calls.append(('called', cmd_name))
287
321
            if cmd_name in ('foo', 'info'):
338
372
        self.assertEqual(['called'], hook_calls)
339
373
        self.assertSubset(['foo', 'bar'], cmds)
340
374
 
341
 
class TestDeprecations(tests.TestCase):
342
 
 
343
 
    def test_shlex_split_unicode_deprecation(self):
344
 
        res = self.applyDeprecated(
345
 
                symbol_versioning.deprecated_in((2, 2, 0)),
346
 
                commands.shlex_split_unicode, 'whatever')
 
375
class TestPreAndPostCommandHooks(tests.TestCase):
 
376
    class TestError(StandardError):
 
377
        __doc__ = """A test exception."""
 
378
 
 
379
    def test_pre_and_post_hooks(self):
 
380
        hook_calls = []
 
381
 
 
382
        def pre_command(cmd):
 
383
            self.assertEqual([], hook_calls)
 
384
            hook_calls.append('pre')
 
385
 
 
386
        def post_command(cmd):
 
387
            self.assertEqual(['pre', 'run'], hook_calls)
 
388
            hook_calls.append('post')
 
389
 
 
390
        def run(cmd):
 
391
            self.assertEqual(['pre'], hook_calls)
 
392
            hook_calls.append('run')
 
393
 
 
394
        self.overrideAttr(builtins.cmd_rocks, 'run', run)
 
395
        commands.install_bzr_command_hooks()
 
396
        commands.Command.hooks.install_named_hook(
 
397
            "pre_command", pre_command, None)
 
398
        commands.Command.hooks.install_named_hook(
 
399
            "post_command", post_command, None)
 
400
 
 
401
        self.assertEqual([], hook_calls)
 
402
        self.run_bzr(['rocks', '-Oxx=12', '-Oyy=foo'])
 
403
        self.assertEqual(['pre', 'run', 'post'], hook_calls)
 
404
 
 
405
    def test_post_hook_provided_exception(self):
 
406
        hook_calls = []
 
407
 
 
408
        def post_command(cmd):
 
409
            hook_calls.append('post')
 
410
 
 
411
        def run(cmd):
 
412
            hook_calls.append('run')
 
413
            raise self.TestError()
 
414
 
 
415
        self.overrideAttr(builtins.cmd_rocks, 'run', run)
 
416
        commands.install_bzr_command_hooks()
 
417
        commands.Command.hooks.install_named_hook(
 
418
            "post_command", post_command, None)
 
419
 
 
420
        self.assertEqual([], hook_calls)
 
421
        self.assertRaises(self.TestError, commands.run_bzr, [u'rocks'])
 
422
        self.assertEqual(['run', 'post'], hook_calls)
 
423
 
 
424
    def test_pre_command_error(self):
 
425
        """Ensure an BzrCommandError in pre_command aborts the command"""
 
426
 
 
427
        hook_calls = []
 
428
 
 
429
        def pre_command(cmd):
 
430
            hook_calls.append('pre')
 
431
            # verify that all subclasses of BzrCommandError caught too
 
432
            raise errors.BzrOptionError()
 
433
 
 
434
        def post_command(cmd, e):
 
435
            self.fail('post_command should not be called')
 
436
 
 
437
        def run(cmd):
 
438
            self.fail('command should not be called')
 
439
 
 
440
        self.overrideAttr(builtins.cmd_rocks, 'run', run)
 
441
        commands.install_bzr_command_hooks()
 
442
        commands.Command.hooks.install_named_hook(
 
443
            "pre_command", pre_command, None)
 
444
        commands.Command.hooks.install_named_hook(
 
445
            "post_command", post_command, None)
 
446
 
 
447
        self.assertEqual([], hook_calls)
 
448
        self.assertRaises(errors.BzrCommandError,
 
449
                          commands.run_bzr, [u'rocks'])
 
450
        self.assertEqual(['pre'], hook_calls)
 
451