← 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: Canonical.com Patch Queue Manager
  • Date: 2009-10-13 06:08:53 UTC
  • mfrom: (4737.1.1 merge-2.0-into-devel)
  • Revision ID: pqm@pqm.ubuntu.com-20091013060853-erk2aaj80fnkrv25
(andrew) Merge lp:bzr/2.0 into lp:bzr, including fixes for #322807,
        #389413, #402623 and documentation improvements.

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 (
25
25
    errors,
26
26
    option,
27
27
    tests,
28
 
    trace,
29
28
    )
30
29
from bzrlib.commands import display_command
31
30
from bzrlib.tests import TestSkipped
33
32
 
34
33
class TestCommands(tests.TestCase):
35
34
 
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
35
    def test_display_command(self):
48
36
        """EPIPE message is selectively suppressed"""
49
37
        def pipe_thrower():
76
64
    @staticmethod
77
65
    def get_command(options):
78
66
        class cmd_foo(commands.Command):
79
 
            __doc__ = 'Bar'
 
67
            'Bar'
80
68
 
81
69
            takes_options = options
82
70
 
91
79
        self.assertContainsRe(c.get_help_text(), '--foo')
92
80
 
93
81
 
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
 
 
123
82
class TestGetAlias(tests.TestCase):
124
83
 
125
84
    def _get_config(self, config_text):
126
 
        my_config = config.GlobalConfig.from_string(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)
127
88
        return my_config
128
89
 
129
90
    def test_simple(self):
150
111
 
151
112
    def test_unicode(self):
152
113
        my_config = self._get_config("[ALIASES]\n"
153
 
            u'iam=whoami "Erik B\u00e5gfors <erik@bagfors.nu>"\n')
 
114
            u"iam=whoami 'Erik B\u00e5gfors <erik@bagfors.nu>'\n")
154
115
        self.assertEqual([u'whoami', u'Erik B\u00e5gfors <erik@bagfors.nu>'],
155
116
                          commands.get_alias("iam", config=my_config))
156
117
 
158
119
class TestSeeAlso(tests.TestCase):
159
120
    """Tests for the see also functional of Command."""
160
121
 
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
 
 
168
122
    def test_default_subclass_no_see_also(self):
169
 
        command = self._get_command_with_see_also([])
 
123
        class ACommand(commands.Command):
 
124
            """A sample command."""
 
125
        command = ACommand()
170
126
        self.assertEqual([], command.get_see_also())
171
127
 
172
128
    def test__see_also(self):
173
129
        """When _see_also is defined, it sets the result of get_see_also()."""
174
 
        command = self._get_command_with_see_also(['bar', 'foo'])
 
130
        class ACommand(commands.Command):
 
131
            _see_also = ['bar', 'foo']
 
132
        command = ACommand()
175
133
        self.assertEqual(['bar', 'foo'], command.get_see_also())
176
134
 
177
135
    def test_deduplication(self):
178
136
        """Duplicates in _see_also are stripped out."""
179
 
        command = self._get_command_with_see_also(['foo', 'foo'])
 
137
        class ACommand(commands.Command):
 
138
            _see_also = ['foo', 'foo']
 
139
        command = ACommand()
180
140
        self.assertEqual(['foo'], command.get_see_also())
181
141
 
182
142
    def test_sorted(self):
183
143
        """_see_also is sorted by get_see_also."""
184
 
        command = self._get_command_with_see_also(['foo', 'bar'])
 
144
        class ACommand(commands.Command):
 
145
            _see_also = ['foo', 'bar']
 
146
        command = ACommand()
185
147
        self.assertEqual(['bar', 'foo'], command.get_see_also())
186
148
 
187
149
    def test_additional_terms(self):
188
150
        """Additional terms can be supplied and are deduped and sorted."""
189
 
        command = self._get_command_with_see_also(['foo', 'bar'])
 
151
        class ACommand(commands.Command):
 
152
            _see_also = ['foo', 'bar']
 
153
        command = ACommand()
190
154
        self.assertEqual(['bar', 'foo', 'gam'],
191
155
            command.get_see_also(['gam', 'bar', 'gam']))
192
156
 
246
210
        commands.Command.hooks.install_named_hook(
247
211
            "extend_command", hook_calls.append, None)
248
212
        # create a command, should not fire
249
 
        class cmd_test_extend_command_hook(commands.Command):
250
 
            __doc__ = """A sample command."""
 
213
        class ACommand(commands.Command):
 
214
            """A sample command."""
 
215
        cmd = ACommand()
251
216
        self.assertEqual([], hook_calls)
252
217
        # -- as a builtin
253
218
        # register the command class, should not fire
254
219
        try:
255
 
            commands.builtin_command_registry.register(cmd_test_extend_command_hook)
 
220
            builtins.cmd_test_extend_command_hook = ACommand
256
221
            self.assertEqual([], hook_calls)
257
222
            # and ask for the object, should fire
258
223
            cmd = commands.get_cmd_object('test-extend-command-hook')
262
227
            self.assertSubset([cmd], hook_calls)
263
228
            del hook_calls[:]
264
229
        finally:
265
 
            commands.builtin_command_registry.remove('test-extend-command-hook')
 
230
            del builtins.cmd_test_extend_command_hook
266
231
        # -- as a plugin lazy registration
267
232
        try:
268
233
            # register the command class, should not fire
284
249
        commands.install_bzr_command_hooks()
285
250
        hook_calls = []
286
251
        class ACommand(commands.Command):
287
 
            __doc__ = """A sample command."""
 
252
            """A sample command."""
288
253
        def get_cmd(cmd_or_None, cmd_name):
289
254
            hook_calls.append(('called', cmd_or_None, cmd_name))
290
255
            if cmd_name in ('foo', 'info'):
311
276
 
312
277
class TestGetMissingCommandHook(tests.TestCase):
313
278
 
314
 
    def hook_missing(self):
315
 
        """Hook get_missing_command for testing."""
316
 
        self.hook_calls = []
 
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 = []
317
283
        class ACommand(commands.Command):
318
 
            __doc__ = """A sample command."""
 
284
            """A sample command."""
319
285
        def get_missing_cmd(cmd_name):
320
 
            self.hook_calls.append(('called', cmd_name))
 
286
            hook_calls.append(('called', cmd_name))
321
287
            if cmd_name in ('foo', 'info'):
322
288
                return ACommand()
323
289
        commands.Command.hooks.install_named_hook(
324
290
            "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()
331
291
        # create a command directly, should not fire
332
 
        self.cmd = self.ACommand()
333
 
        self.assertEqual([], self.hook_calls)
 
292
        cmd = ACommand()
 
293
        self.assertEqual([], hook_calls)
334
294
        # ask by name, should fire and give us our command
335
295
        cmd = commands.get_cmd_object('foo')
336
 
        self.assertEqual([('called', 'foo')], self.hook_calls)
337
 
        self.assertIsInstance(cmd, self.ACommand)
338
 
        del self.hook_calls[:]
 
296
        self.assertEqual([('called', 'foo')], hook_calls)
 
297
        self.assertIsInstance(cmd, ACommand)
 
298
        del hook_calls[:]
339
299
        # ask by a name that is supplied by a builtin - the hook should not
340
300
        # fire and we still get our object.
341
301
        commands.install_bzr_command_hooks()
342
302
        cmd = commands.get_cmd_object('info')
343
303
        self.assertNotEqual(None, cmd)
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)
 
304
        self.assertEqual(0, len(hook_calls))
353
305
 
354
306
 
355
307
class TestListCommandHook(tests.TestCase):
371
323
        cmds = list(commands.all_command_names())
372
324
        self.assertEqual(['called'], hook_calls)
373
325
        self.assertSubset(['foo', 'bar'], cmds)
374
 
 
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