/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: Canonical.com Patch Queue Manager
  • Date: 2010-02-11 04:02:41 UTC
  • mfrom: (5017.2.2 tariff)
  • Revision ID: pqm@pqm.ubuntu.com-20100211040241-w6n021dz0uus341n
(mbp) add import-tariff tests

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_commands.py
1
 
# Copyright (C) 2005-2012, 2016 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
 
from .. import (
 
21
from bzrlib import (
22
22
    builtins,
23
23
    commands,
24
24
    config,
25
25
    errors,
26
26
    option,
27
27
    tests,
28
 
    trace,
29
28
    )
30
 
from ..commands import display_command
31
 
from . import TestSkipped
 
29
from bzrlib.commands import display_command
 
30
from bzrlib.tests import TestSkipped
32
31
 
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():
50
38
            raise IOError(errno.EPIPE, "Bogus pipe error")
51
39
        self.assertRaises(IOError, pipe_thrower)
52
 
 
53
40
        @display_command
54
41
        def non_thrower():
55
42
            pipe_thrower()
56
43
        non_thrower()
57
 
 
58
44
        @display_command
59
45
        def other_thrower():
60
46
            raise IOError(errno.ESPIPE, "Bogus pipe error")
78
64
    @staticmethod
79
65
    def get_command(options):
80
66
        class cmd_foo(commands.Command):
81
 
            __doc__ = 'Bar'
 
67
            'Bar'
82
68
 
83
69
            takes_options = options
84
70
 
93
79
        self.assertContainsRe(c.get_help_text(), '--foo')
94
80
 
95
81
 
96
 
class TestInsideCommand(tests.TestCaseInTempDir):
97
 
 
98
 
    def test_command_see_config_overrides(self):
99
 
        def run(cmd):
100
 
            # We override the run() command method so we can observe the
101
 
            # overrides from inside.
102
 
            c = config.GlobalStack()
103
 
            self.assertEqual('12', c.get('xx'))
104
 
            self.assertEqual('foo', c.get('yy'))
105
 
        self.overrideAttr(builtins.cmd_rocks, 'run', run)
106
 
        self.run_bzr(['rocks', '-Oxx=12', '-Oyy=foo'])
107
 
        c = config.GlobalStack()
108
 
        # Ensure that we don't leak outside of the command
109
 
        self.assertEqual(None, c.get('xx'))
110
 
        self.assertEqual(None, c.get('yy'))
111
 
 
112
 
 
113
 
class TestInvokedAs(tests.TestCase):
114
 
 
115
 
    def test_invoked_as(self):
116
 
        """The command object knows the actual name used to invoke it."""
117
 
        commands.install_bzr_command_hooks()
118
 
        commands._register_builtin_commands()
119
 
        # get one from the real get_cmd_object.
120
 
        c = commands.get_cmd_object('ci')
121
 
        self.assertIsInstance(c, builtins.cmd_commit)
122
 
        self.assertEqual(c.invoked_as, 'ci')
123
 
 
124
 
 
125
82
class TestGetAlias(tests.TestCase):
126
83
 
127
84
    def _get_config(self, config_text):
128
 
        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)
129
88
        return my_config
130
89
 
131
90
    def test_simple(self):
132
91
        my_config = self._get_config("[ALIASES]\n"
133
 
                                     "diff=diff -r -2..-1\n")
 
92
            "diff=diff -r -2..-1\n")
134
93
        self.assertEqual([u'diff', u'-r', u'-2..-1'],
135
 
                         commands.get_alias("diff", config=my_config))
 
94
            commands.get_alias("diff", config=my_config))
136
95
 
137
96
    def test_single_quotes(self):
138
97
        my_config = self._get_config("[ALIASES]\n"
139
 
                                     "diff=diff -r -2..-1 --diff-options "
140
 
                                     "'--strip-trailing-cr -wp'\n")
 
98
            "diff=diff -r -2..-1 --diff-options "
 
99
            "'--strip-trailing-cr -wp'\n")
141
100
        self.assertEqual([u'diff', u'-r', u'-2..-1', u'--diff-options',
142
101
                          u'--strip-trailing-cr -wp'],
143
 
                         commands.get_alias("diff", config=my_config))
 
102
                          commands.get_alias("diff", config=my_config))
144
103
 
145
104
    def test_double_quotes(self):
146
105
        my_config = self._get_config("[ALIASES]\n"
147
 
                                     "diff=diff -r -2..-1 --diff-options "
148
 
                                     "\"--strip-trailing-cr -wp\"\n")
 
106
            "diff=diff -r -2..-1 --diff-options "
 
107
            "\"--strip-trailing-cr -wp\"\n")
149
108
        self.assertEqual([u'diff', u'-r', u'-2..-1', u'--diff-options',
150
109
                          u'--strip-trailing-cr -wp'],
151
 
                         commands.get_alias("diff", config=my_config))
 
110
                          commands.get_alias("diff", config=my_config))
152
111
 
153
112
    def test_unicode(self):
154
113
        my_config = self._get_config("[ALIASES]\n"
155
 
                                     u'iam=whoami "Erik B\u00e5gfors <erik@bagfors.nu>"\n')
 
114
            u"iam=whoami 'Erik B\u00e5gfors <erik@bagfors.nu>'\n")
156
115
        self.assertEqual([u'whoami', u'Erik B\u00e5gfors <erik@bagfors.nu>'],
157
 
                         commands.get_alias("iam", config=my_config))
 
116
                          commands.get_alias("iam", config=my_config))
158
117
 
159
118
 
160
119
class TestSeeAlso(tests.TestCase):
161
120
    """Tests for the see also functional of Command."""
162
121
 
163
 
    @staticmethod
164
 
    def _get_command_with_see_also(see_also):
165
 
        class ACommand(commands.Command):
166
 
            __doc__ = """A sample command."""
167
 
            _see_also = see_also
168
 
        return ACommand()
169
 
 
170
122
    def test_default_subclass_no_see_also(self):
171
 
        command = self._get_command_with_see_also([])
 
123
        class ACommand(commands.Command):
 
124
            """A sample command."""
 
125
        command = ACommand()
172
126
        self.assertEqual([], command.get_see_also())
173
127
 
174
128
    def test__see_also(self):
175
129
        """When _see_also is defined, it sets the result of get_see_also()."""
176
 
        command = self._get_command_with_see_also(['bar', 'foo'])
 
130
        class ACommand(commands.Command):
 
131
            _see_also = ['bar', 'foo']
 
132
        command = ACommand()
177
133
        self.assertEqual(['bar', 'foo'], command.get_see_also())
178
134
 
179
135
    def test_deduplication(self):
180
136
        """Duplicates in _see_also are stripped out."""
181
 
        command = self._get_command_with_see_also(['foo', 'foo'])
 
137
        class ACommand(commands.Command):
 
138
            _see_also = ['foo', 'foo']
 
139
        command = ACommand()
182
140
        self.assertEqual(['foo'], command.get_see_also())
183
141
 
184
142
    def test_sorted(self):
185
143
        """_see_also is sorted by get_see_also."""
186
 
        command = self._get_command_with_see_also(['foo', 'bar'])
 
144
        class ACommand(commands.Command):
 
145
            _see_also = ['foo', 'bar']
 
146
        command = ACommand()
187
147
        self.assertEqual(['bar', 'foo'], command.get_see_also())
188
148
 
189
149
    def test_additional_terms(self):
190
150
        """Additional terms can be supplied and are deduped and sorted."""
191
 
        command = self._get_command_with_see_also(['foo', 'bar'])
 
151
        class ACommand(commands.Command):
 
152
            _see_also = ['foo', 'bar']
 
153
        command = ACommand()
192
154
        self.assertEqual(['bar', 'foo', 'gam'],
193
 
                         command.get_see_also(['gam', 'bar', 'gam']))
 
155
            command.get_see_also(['gam', 'bar', 'gam']))
194
156
 
195
157
 
196
158
class TestRegisterLazy(tests.TestCase):
197
159
 
198
160
    def setUp(self):
199
 
        super(TestRegisterLazy, self).setUp()
200
 
        import breezy.tests.fake_command
201
 
        del sys.modules['breezy.tests.fake_command']
 
161
        tests.TestCase.setUp(self)
 
162
        import bzrlib.tests.fake_command
 
163
        del sys.modules['bzrlib.tests.fake_command']
202
164
        global lazy_command_imported
203
165
        lazy_command_imported = False
204
166
        commands.install_bzr_command_hooks()
208
170
        commands.plugin_cmds.remove('fake')
209
171
 
210
172
    def assertIsFakeCommand(self, cmd_obj):
211
 
        from breezy.tests.fake_command import cmd_fake
 
173
        from bzrlib.tests.fake_command import cmd_fake
212
174
        self.assertIsInstance(cmd_obj, cmd_fake)
213
175
 
214
176
    def test_register_lazy(self):
215
177
        """Ensure lazy registration works"""
216
178
        commands.plugin_cmds.register_lazy('cmd_fake', [],
217
 
                                           'breezy.tests.fake_command')
 
179
                                           'bzrlib.tests.fake_command')
218
180
        self.addCleanup(self.remove_fake)
219
181
        self.assertFalse(lazy_command_imported)
220
182
        fake_instance = commands.get_cmd_object('fake')
223
185
 
224
186
    def test_get_unrelated_does_not_import(self):
225
187
        commands.plugin_cmds.register_lazy('cmd_fake', [],
226
 
                                           'breezy.tests.fake_command')
 
188
                                           'bzrlib.tests.fake_command')
227
189
        self.addCleanup(self.remove_fake)
228
190
        commands.get_cmd_object('status')
229
191
        self.assertFalse(lazy_command_imported)
230
192
 
231
193
    def test_aliases(self):
232
194
        commands.plugin_cmds.register_lazy('cmd_fake', ['fake_alias'],
233
 
                                           'breezy.tests.fake_command')
 
195
                                           'bzrlib.tests.fake_command')
234
196
        self.addCleanup(self.remove_fake)
235
197
        fake_instance = commands.get_cmd_object('fake_alias')
236
198
        self.assertIsFakeCommand(fake_instance)
248
210
        commands.Command.hooks.install_named_hook(
249
211
            "extend_command", hook_calls.append, None)
250
212
        # create a command, should not fire
251
 
 
252
 
        class cmd_test_extend_command_hook(commands.Command):
253
 
            __doc__ = """A sample command."""
 
213
        class ACommand(commands.Command):
 
214
            """A sample command."""
 
215
        cmd = ACommand()
254
216
        self.assertEqual([], hook_calls)
255
217
        # -- as a builtin
256
218
        # register the command class, should not fire
257
219
        try:
258
 
            commands.builtin_command_registry.register(
259
 
                cmd_test_extend_command_hook)
 
220
            builtins.cmd_test_extend_command_hook = ACommand
260
221
            self.assertEqual([], hook_calls)
261
222
            # and ask for the object, should fire
262
223
            cmd = commands.get_cmd_object('test-extend-command-hook')
266
227
            self.assertSubset([cmd], hook_calls)
267
228
            del hook_calls[:]
268
229
        finally:
269
 
            commands.builtin_command_registry.remove(
270
 
                'test-extend-command-hook')
 
230
            del builtins.cmd_test_extend_command_hook
271
231
        # -- as a plugin lazy registration
272
232
        try:
273
233
            # register the command class, should not fire
274
234
            commands.plugin_cmds.register_lazy('cmd_fake', [],
275
 
                                               'breezy.tests.fake_command')
 
235
                                               'bzrlib.tests.fake_command')
276
236
            self.assertEqual([], hook_calls)
277
237
            # and ask for the object, should fire
278
238
            cmd = commands.get_cmd_object('fake')
288
248
        # ui.
289
249
        commands.install_bzr_command_hooks()
290
250
        hook_calls = []
291
 
 
292
251
        class ACommand(commands.Command):
293
 
            __doc__ = """A sample command."""
294
 
 
 
252
            """A sample command."""
295
253
        def get_cmd(cmd_or_None, cmd_name):
296
254
            hook_calls.append(('called', cmd_or_None, cmd_name))
297
255
            if cmd_name in ('foo', 'info'):
316
274
        self.assertIsInstance(hook_calls[0][1], builtins.cmd_info)
317
275
 
318
276
 
319
 
class TestCommandNotFound(tests.TestCase):
320
 
 
321
 
    def setUp(self):
322
 
        super(TestCommandNotFound, self).setUp()
323
 
        commands._register_builtin_commands()
324
 
        commands.install_bzr_command_hooks()
325
 
 
326
 
    def test_not_found_no_suggestion(self):
327
 
        e = self.assertRaises(errors.BzrCommandError,
328
 
                              commands.get_cmd_object, 'idontexistand')
329
 
        self.assertEqual('unknown command "idontexistand"', str(e))
330
 
 
331
 
    def test_not_found_with_suggestion(self):
332
 
        e = self.assertRaises(errors.BzrCommandError,
333
 
                              commands.get_cmd_object, 'statue')
334
 
        self.assertEqual('unknown command "statue". Perhaps you meant "status"',
335
 
                         str(e))
336
 
 
337
 
 
338
277
class TestGetMissingCommandHook(tests.TestCase):
339
278
 
340
 
    def hook_missing(self):
341
 
        """Hook get_missing_command for testing."""
342
 
        self.hook_calls = []
343
 
 
 
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 = []
344
283
        class ACommand(commands.Command):
345
 
            __doc__ = """A sample command."""
346
 
 
 
284
            """A sample command."""
347
285
        def get_missing_cmd(cmd_name):
348
 
            self.hook_calls.append(('called', cmd_name))
 
286
            hook_calls.append(('called', cmd_name))
349
287
            if cmd_name in ('foo', 'info'):
350
288
                return ACommand()
351
289
        commands.Command.hooks.install_named_hook(
352
290
            "get_missing_command", get_missing_cmd, None)
353
 
        self.ACommand = ACommand
354
 
 
355
 
    def test_fires_on_get_cmd_object(self):
356
 
        # The get_missing_command(cmd) hook fires when commands are delivered to the
357
 
        # ui.
358
 
        self.hook_missing()
359
291
        # create a command directly, should not fire
360
 
        self.cmd = self.ACommand()
361
 
        self.assertEqual([], self.hook_calls)
 
292
        cmd = ACommand()
 
293
        self.assertEqual([], hook_calls)
362
294
        # ask by name, should fire and give us our command
363
295
        cmd = commands.get_cmd_object('foo')
364
 
        self.assertEqual([('called', 'foo')], self.hook_calls)
365
 
        self.assertIsInstance(cmd, self.ACommand)
366
 
        del self.hook_calls[:]
 
296
        self.assertEqual([('called', 'foo')], hook_calls)
 
297
        self.assertIsInstance(cmd, ACommand)
 
298
        del hook_calls[:]
367
299
        # ask by a name that is supplied by a builtin - the hook should not
368
300
        # fire and we still get our object.
369
301
        commands.install_bzr_command_hooks()
370
302
        cmd = commands.get_cmd_object('info')
371
303
        self.assertNotEqual(None, cmd)
372
 
        self.assertEqual(0, len(self.hook_calls))
373
 
 
374
 
    def test_skipped_on_HelpCommandIndex_get_topics(self):
375
 
        # The get_missing_command(cmd_name) hook is not fired when
376
 
        # looking up help topics.
377
 
        self.hook_missing()
378
 
        topic = commands.HelpCommandIndex()
379
 
        topics = topic.get_topics('foo')
380
 
        self.assertEqual([], self.hook_calls)
 
304
        self.assertEqual(0, len(hook_calls))
381
305
 
382
306
 
383
307
class TestListCommandHook(tests.TestCase):
386
310
        # The list_commands() hook fires when all_command_names() is invoked.
387
311
        hook_calls = []
388
312
        commands.install_bzr_command_hooks()
389
 
 
390
313
        def list_my_commands(cmd_names):
391
314
            hook_calls.append('called')
392
315
            cmd_names.update(['foo', 'bar'])
400
323
        cmds = list(commands.all_command_names())
401
324
        self.assertEqual(['called'], hook_calls)
402
325
        self.assertSubset(['foo', 'bar'], cmds)
403
 
 
404
 
 
405
 
class TestPreAndPostCommandHooks(tests.TestCase):
406
 
    class TestError(Exception):
407
 
        __doc__ = """A test exception."""
408
 
 
409
 
    def test_pre_and_post_hooks(self):
410
 
        hook_calls = []
411
 
 
412
 
        def pre_command(cmd):
413
 
            self.assertEqual([], hook_calls)
414
 
            hook_calls.append('pre')
415
 
 
416
 
        def post_command(cmd):
417
 
            self.assertEqual(['pre', 'run'], hook_calls)
418
 
            hook_calls.append('post')
419
 
 
420
 
        def run(cmd):
421
 
            self.assertEqual(['pre'], hook_calls)
422
 
            hook_calls.append('run')
423
 
 
424
 
        self.overrideAttr(builtins.cmd_rocks, 'run', run)
425
 
        commands.install_bzr_command_hooks()
426
 
        commands.Command.hooks.install_named_hook(
427
 
            "pre_command", pre_command, None)
428
 
        commands.Command.hooks.install_named_hook(
429
 
            "post_command", post_command, None)
430
 
 
431
 
        self.assertEqual([], hook_calls)
432
 
        self.run_bzr(['rocks', '-Oxx=12', '-Oyy=foo'])
433
 
        self.assertEqual(['pre', 'run', 'post'], hook_calls)
434
 
 
435
 
    def test_post_hook_provided_exception(self):
436
 
        hook_calls = []
437
 
 
438
 
        def post_command(cmd):
439
 
            hook_calls.append('post')
440
 
 
441
 
        def run(cmd):
442
 
            hook_calls.append('run')
443
 
            raise self.TestError()
444
 
 
445
 
        self.overrideAttr(builtins.cmd_rocks, 'run', run)
446
 
        commands.install_bzr_command_hooks()
447
 
        commands.Command.hooks.install_named_hook(
448
 
            "post_command", post_command, None)
449
 
 
450
 
        self.assertEqual([], hook_calls)
451
 
        self.assertRaises(self.TestError, commands.run_bzr, [u'rocks'])
452
 
        self.assertEqual(['run', 'post'], hook_calls)
453
 
 
454
 
    def test_pre_command_error(self):
455
 
        """Ensure an BzrCommandError in pre_command aborts the command"""
456
 
 
457
 
        hook_calls = []
458
 
 
459
 
        def pre_command(cmd):
460
 
            hook_calls.append('pre')
461
 
            # verify that all subclasses of BzrCommandError caught too
462
 
            raise commands.BzrOptionError()
463
 
 
464
 
        def post_command(cmd, e):
465
 
            self.fail('post_command should not be called')
466
 
 
467
 
        def run(cmd):
468
 
            self.fail('command should not be called')
469
 
 
470
 
        self.overrideAttr(builtins.cmd_rocks, 'run', run)
471
 
        commands.install_bzr_command_hooks()
472
 
        commands.Command.hooks.install_named_hook(
473
 
            "pre_command", pre_command, None)
474
 
        commands.Command.hooks.install_named_hook(
475
 
            "post_command", post_command, None)
476
 
 
477
 
        self.assertEqual([], hook_calls)
478
 
        self.assertRaises(errors.BzrCommandError,
479
 
                          commands.run_bzr, [u'rocks'])
480
 
        self.assertEqual(['pre'], hook_calls)
481
 
 
482
 
 
483
 
class GuessCommandTests(tests.TestCase):
484
 
 
485
 
    def setUp(self):
486
 
        super(GuessCommandTests, self).setUp()
487
 
        commands._register_builtin_commands()
488
 
        commands.install_bzr_command_hooks()
489
 
 
490
 
    def test_guess_override(self):
491
 
        self.assertEqual('ci', commands.guess_command('ic'))
492
 
 
493
 
    def test_guess(self):
494
 
        commands.get_cmd_object('status')
495
 
        self.assertEqual('status', commands.guess_command('statue'))
496
 
 
497
 
    def test_none(self):
498
 
        self.assertIs(None, commands.guess_command('nothingisevenclose'))