← Back to branch summary

~bzr/ubuntu/lucid/bzr/beta-ppa

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_commands.py

  • Committer: Martin Pool
  • Date: 2010-07-02 07:29:40 UTC
  • mfrom: (129.1.7 packaging-karmic)
  • Revision ID: mbp@sourcefrog.net-20100702072940-hpzq5elg8wjve8rh
http://bugs.debian.org/452024
http://bugs.debian.org/464688
http://bugs.debian.org/523595
http://bugs.debian.org/526233
http://bugs.debian.org/537708
http://bugs.debian.org/555336
http://bugs.debian.org/555343
https://launchpad.net/bugs/249452
https://launchpad.net/bugs/385074
* PPA rebuild.
* PPA rebuild for Karmic.
* PPA rebuild for Jaunty.
* PPA rebuild for Hardy.
* From postinst, actually remove the example bash completion scripts.
  (LP: #249452)
* New upstream release.
* New upstream release.
* New upstream release.
* Revert change to Build-depends: Dapper does not have python-central.
  Should be python-support..
* Target ppa..
* Target ppa..
* Target ppa..
* Target ppa..
* New upstream release.
* Switch to dpkg-source 3.0 (quilt) format.
* Bump standards version to 3.8.4.
* Remove embedded copy of python-configobj. Closes: #555336
* Remove embedded copy of python-elementtree. Closes: #555343
* Change section from 'Devel' to 'Vcs'..
* Change section from 'Devel' to 'Vcs'..
* Change section from 'Devel' to 'Vcs'..
* Change section from 'Devel' to 'Vcs'..
* Change section from 'Devel' to 'Vcs'..
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* debian/control: Fix obsolete-relation-form-in-source
  lintian warning. 
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Split out docs into bzr-doc package.
* New upstream release.
* Added John Francesco Ferlito to Uploaders.
* Fix install path to quick-reference guide
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Fix FTBFS due to path changes, again.
* Fix FTBFS due to doc paths changing
* New upstream release.
* Fix FTBFS due to path changes, again.
* Fix FTBFS due to doc paths changing
* New upstream release.
* Fix FTBFS due to path changes, again.
* Fix FTBFS due to doc paths changing
* New upstream release.
* Fix FTBFS due to path changes, again, again.
* Fix FTBFS due to path changes, again.
* Fix FTBFS due to path changes.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Bump standards version to 3.8.3.
* Remove unused patch system.
* New upstream release.
* New upstream release.
* New upstream release.
* Fix copy and paste tab error in .install file
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
 + Fixes compatibility with Python 2.4. Closes: #537708
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream version.
* Bump standards version to 3.8.2.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Add python-pyrex to build-deps to ensure C extensions are always build.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Split documentation into bzr-doc package. ((LP: #385074)
* Multiple packaging changes to make us more linitan clean.
* New upstream release.
* Split documentation into bzr-doc package. ((LP: #385074)
* Multiple packaging changes to make us more linitan clean.
* New upstream release.
* Split documentation into bzr-doc package. ((LP: #385074)
* Multiple packaging changes to make us more linitan clean.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Fix API compatibility version. (Closes: #526233)
* New upstream release.
  + Fixes default format for upgrade command. (Closes: #464688)
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Add missing dependency on zlib development library. (Closes:
  #523595)
* Add zlib build-depends.
* Add zlib build-depends.
* Add zlib build-depends.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Move to section vcs.
* Bump standards version to 3.8.1.
* New upstream release.
* Remove temporary patch for missing .c files from distribution
* New upstream release.
* Remove temporary patch for missing .c files from distribution
* New upstream release.
* Remove temporary patch for missing .c files from distribution
* Add temporary patch for missing .c files from distribution
* Add temporary patch for missing .c files from distribution
* Add temporary patch for missing .c files from distribution
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Recommend ca-certificates. (Closes: #452024)
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Update watch file. bazaar now uses launchpad to host its sources.
* Remove patch for inventory root revision copy, applied upstream.
* New upstream release.
* New upstream release.
* New upstream release
* Force removal of files installed in error to /etc/bash_completion.d/
  (LP: #249452)
* New upstream release.
* New upstream release
* New upstream release.
* Bump standards version.
* Include patch for inventory root revision copy, required for bzr-svn.
* New upstream release.
* Remove unused lintian overrides.
* Correct the package version not to be native.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Final 1.5 release.
* New upstream release.
* New upstream release.
* New upstream release.
* Add myself as a co-maintainer.
* Add a Dm-Upload-Allowed: yes header.
* New upstream bugfix release.
* New upstream release.
* Final 1.3 release.
* New upstream release.
* First release candidate of the upcoming 1.3 release.
* Rebuild to fix the problem caused by a build with a broken python-central.
* New upstream release.
* Rebuild for dapper PPA.
* Apply Lamont's patches to fix build-dependencies on dapper.
  (See: https://bugs.launchpad.net/bzr/+bug/189915)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_commands.py
 
1
# Copyright (C) 2004, 2005 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
    tests,
 
28
    )
 
29
from bzrlib.commands import display_command
 
30
from bzrlib.tests import TestSkipped
 
31
 
 
32
 
 
33
class TestCommands(tests.TestCase):
 
34
 
 
35
    def test_display_command(self):
 
36
        """EPIPE message is selectively suppressed"""
 
37
        def pipe_thrower():
 
38
            raise IOError(errno.EPIPE, "Bogus pipe error")
 
39
        self.assertRaises(IOError, pipe_thrower)
 
40
        @display_command
 
41
        def non_thrower():
 
42
            pipe_thrower()
 
43
        non_thrower()
 
44
        @display_command
 
45
        def other_thrower():
 
46
            raise IOError(errno.ESPIPE, "Bogus pipe error")
 
47
        self.assertRaises(IOError, other_thrower)
 
48
 
 
49
    def test_unicode_command(self):
 
50
        # This error is thrown when we can't find the command in the
 
51
        # list of available commands
 
52
        self.assertRaises(errors.BzrCommandError,
 
53
                          commands.run_bzr, [u'cmd\xb5'])
 
54
 
 
55
    def test_unicode_option(self):
 
56
        # This error is actually thrown by optparse, when it
 
57
        # can't find the given option
 
58
        import optparse
 
59
        if optparse.__version__ == "1.5.3":
 
60
            raise TestSkipped("optparse 1.5.3 can't handle unicode options")
 
61
        self.assertRaises(errors.BzrCommandError,
 
62
                          commands.run_bzr, ['log', u'--option\xb5'])
 
63
 
 
64
    @staticmethod
 
65
    def get_command(options):
 
66
        class cmd_foo(commands.Command):
 
67
            'Bar'
 
68
 
 
69
            takes_options = options
 
70
 
 
71
        return cmd_foo()
 
72
 
 
73
    def test_help_hidden(self):
 
74
        c = self.get_command([option.Option('foo', hidden=True)])
 
75
        self.assertNotContainsRe(c.get_help_text(), '--foo')
 
76
 
 
77
    def test_help_not_hidden(self):
 
78
        c = self.get_command([option.Option('foo', hidden=False)])
 
79
        self.assertContainsRe(c.get_help_text(), '--foo')
 
80
 
 
81
 
 
82
class TestGetAlias(tests.TestCase):
 
83
 
 
84
    def _get_config(self, 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)
 
88
        return my_config
 
89
 
 
90
    def test_simple(self):
 
91
        my_config = self._get_config("[ALIASES]\n"
 
92
            "diff=diff -r -2..-1\n")
 
93
        self.assertEqual([u'diff', u'-r', u'-2..-1'],
 
94
            commands.get_alias("diff", config=my_config))
 
95
 
 
96
    def test_single_quotes(self):
 
97
        my_config = self._get_config("[ALIASES]\n"
 
98
            "diff=diff -r -2..-1 --diff-options "
 
99
            "'--strip-trailing-cr -wp'\n")
 
100
        self.assertEqual([u'diff', u'-r', u'-2..-1', u'--diff-options',
 
101
                          u'--strip-trailing-cr -wp'],
 
102
                          commands.get_alias("diff", config=my_config))
 
103
 
 
104
    def test_double_quotes(self):
 
105
        my_config = self._get_config("[ALIASES]\n"
 
106
            "diff=diff -r -2..-1 --diff-options "
 
107
            "\"--strip-trailing-cr -wp\"\n")
 
108
        self.assertEqual([u'diff', u'-r', u'-2..-1', u'--diff-options',
 
109
                          u'--strip-trailing-cr -wp'],
 
110
                          commands.get_alias("diff", config=my_config))
 
111
 
 
112
    def test_unicode(self):
 
113
        my_config = self._get_config("[ALIASES]\n"
 
114
            u"iam=whoami 'Erik B\u00e5gfors <erik@bagfors.nu>'\n")
 
115
        self.assertEqual([u'whoami', u'Erik B\u00e5gfors <erik@bagfors.nu>'],
 
116
                          commands.get_alias("iam", config=my_config))
 
117
 
 
118
 
 
119
class TestSeeAlso(tests.TestCase):
 
120
    """Tests for the see also functional of Command."""
 
121
 
 
122
    def test_default_subclass_no_see_also(self):
 
123
        class ACommand(commands.Command):
 
124
            """A sample command."""
 
125
        command = ACommand()
 
126
        self.assertEqual([], command.get_see_also())
 
127
 
 
128
    def test__see_also(self):
 
129
        """When _see_also is defined, it sets the result of get_see_also()."""
 
130
        class ACommand(commands.Command):
 
131
            _see_also = ['bar', 'foo']
 
132
        command = ACommand()
 
133
        self.assertEqual(['bar', 'foo'], command.get_see_also())
 
134
 
 
135
    def test_deduplication(self):
 
136
        """Duplicates in _see_also are stripped out."""
 
137
        class ACommand(commands.Command):
 
138
            _see_also = ['foo', 'foo']
 
139
        command = ACommand()
 
140
        self.assertEqual(['foo'], command.get_see_also())
 
141
 
 
142
    def test_sorted(self):
 
143
        """_see_also is sorted by get_see_also."""
 
144
        class ACommand(commands.Command):
 
145
            _see_also = ['foo', 'bar']
 
146
        command = ACommand()
 
147
        self.assertEqual(['bar', 'foo'], command.get_see_also())
 
148
 
 
149
    def test_additional_terms(self):
 
150
        """Additional terms can be supplied and are deduped and sorted."""
 
151
        class ACommand(commands.Command):
 
152
            _see_also = ['foo', 'bar']
 
153
        command = ACommand()
 
154
        self.assertEqual(['bar', 'foo', 'gam'],
 
155
            command.get_see_also(['gam', 'bar', 'gam']))
 
156
 
 
157
 
 
158
class TestRegisterLazy(tests.TestCase):
 
159
 
 
160
    def setUp(self):
 
161
        tests.TestCase.setUp(self)
 
162
        import bzrlib.tests.fake_command
 
163
        del sys.modules['bzrlib.tests.fake_command']
 
164
        global lazy_command_imported
 
165
        lazy_command_imported = False
 
166
        commands.install_bzr_command_hooks()
 
167
 
 
168
    @staticmethod
 
169
    def remove_fake():
 
170
        commands.plugin_cmds.remove('fake')
 
171
 
 
172
    def assertIsFakeCommand(self, cmd_obj):
 
173
        from bzrlib.tests.fake_command import cmd_fake
 
174
        self.assertIsInstance(cmd_obj, cmd_fake)
 
175
 
 
176
    def test_register_lazy(self):
 
177
        """Ensure lazy registration works"""
 
178
        commands.plugin_cmds.register_lazy('cmd_fake', [],
 
179
                                           'bzrlib.tests.fake_command')
 
180
        self.addCleanup(self.remove_fake)
 
181
        self.assertFalse(lazy_command_imported)
 
182
        fake_instance = commands.get_cmd_object('fake')
 
183
        self.assertTrue(lazy_command_imported)
 
184
        self.assertIsFakeCommand(fake_instance)
 
185
 
 
186
    def test_get_unrelated_does_not_import(self):
 
187
        commands.plugin_cmds.register_lazy('cmd_fake', [],
 
188
                                           'bzrlib.tests.fake_command')
 
189
        self.addCleanup(self.remove_fake)
 
190
        commands.get_cmd_object('status')
 
191
        self.assertFalse(lazy_command_imported)
 
192
 
 
193
    def test_aliases(self):
 
194
        commands.plugin_cmds.register_lazy('cmd_fake', ['fake_alias'],
 
195
                                           'bzrlib.tests.fake_command')
 
196
        self.addCleanup(self.remove_fake)
 
197
        fake_instance = commands.get_cmd_object('fake_alias')
 
198
        self.assertIsFakeCommand(fake_instance)
 
199
 
 
200
 
 
201
class TestExtendCommandHook(tests.TestCase):
 
202
 
 
203
    def test_fires_on_get_cmd_object(self):
 
204
        # The extend_command(cmd) hook fires when commands are delivered to the
 
205
        # ui, not simply at registration (because lazy registered plugin
 
206
        # commands are registered).
 
207
        # when they are simply created.
 
208
        hook_calls = []
 
209
        commands.install_bzr_command_hooks()
 
210
        commands.Command.hooks.install_named_hook(
 
211
            "extend_command", hook_calls.append, None)
 
212
        # create a command, should not fire
 
213
        class ACommand(commands.Command):
 
214
            """A sample command."""
 
215
        cmd = ACommand()
 
216
        self.assertEqual([], hook_calls)
 
217
        # -- as a builtin
 
218
        # register the command class, should not fire
 
219
        try:
 
220
            builtins.cmd_test_extend_command_hook = ACommand
 
221
            self.assertEqual([], hook_calls)
 
222
            # and ask for the object, should fire
 
223
            cmd = commands.get_cmd_object('test-extend-command-hook')
 
224
            # For resilience - to ensure all code paths hit it - we
 
225
            # fire on everything returned in the 'cmd_dict', which is currently
 
226
            # all known commands, so assert that cmd is in hook_calls
 
227
            self.assertSubset([cmd], hook_calls)
 
228
            del hook_calls[:]
 
229
        finally:
 
230
            del builtins.cmd_test_extend_command_hook
 
231
        # -- as a plugin lazy registration
 
232
        try:
 
233
            # register the command class, should not fire
 
234
            commands.plugin_cmds.register_lazy('cmd_fake', [],
 
235
                                               'bzrlib.tests.fake_command')
 
236
            self.assertEqual([], hook_calls)
 
237
            # and ask for the object, should fire
 
238
            cmd = commands.get_cmd_object('fake')
 
239
            self.assertEqual([cmd], hook_calls)
 
240
        finally:
 
241
            commands.plugin_cmds.remove('fake')
 
242
 
 
243
 
 
244
class TestGetCommandHook(tests.TestCase):
 
245
 
 
246
    def test_fires_on_get_cmd_object(self):
 
247
        # The get_command(cmd) hook fires when commands are delivered to the
 
248
        # ui.
 
249
        commands.install_bzr_command_hooks()
 
250
        hook_calls = []
 
251
        class ACommand(commands.Command):
 
252
            """A sample command."""
 
253
        def get_cmd(cmd_or_None, cmd_name):
 
254
            hook_calls.append(('called', cmd_or_None, cmd_name))
 
255
            if cmd_name in ('foo', 'info'):
 
256
                return ACommand()
 
257
        commands.Command.hooks.install_named_hook(
 
258
            "get_command", get_cmd, None)
 
259
        # create a command directly, should not fire
 
260
        cmd = ACommand()
 
261
        self.assertEqual([], hook_calls)
 
262
        # ask by name, should fire and give us our command
 
263
        cmd = commands.get_cmd_object('foo')
 
264
        self.assertEqual([('called', None, 'foo')], hook_calls)
 
265
        self.assertIsInstance(cmd, ACommand)
 
266
        del hook_calls[:]
 
267
        # ask by a name that is supplied by a builtin - the hook should still
 
268
        # fire and we still get our object, but we should see the builtin
 
269
        # passed to the hook.
 
270
        cmd = commands.get_cmd_object('info')
 
271
        self.assertIsInstance(cmd, ACommand)
 
272
        self.assertEqual(1, len(hook_calls))
 
273
        self.assertEqual('info', hook_calls[0][2])
 
274
        self.assertIsInstance(hook_calls[0][1], builtins.cmd_info)
 
275
 
 
276
 
 
277
class TestGetMissingCommandHook(tests.TestCase):
 
278
 
 
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 = []
 
283
        class ACommand(commands.Command):
 
284
            """A sample command."""
 
285
        def get_missing_cmd(cmd_name):
 
286
            hook_calls.append(('called', cmd_name))
 
287
            if cmd_name in ('foo', 'info'):
 
288
                return ACommand()
 
289
        commands.Command.hooks.install_named_hook(
 
290
            "get_missing_command", get_missing_cmd, None)
 
291
        # create a command directly, should not fire
 
292
        cmd = ACommand()
 
293
        self.assertEqual([], hook_calls)
 
294
        # ask by name, should fire and give us our command
 
295
        cmd = commands.get_cmd_object('foo')
 
296
        self.assertEqual([('called', 'foo')], hook_calls)
 
297
        self.assertIsInstance(cmd, ACommand)
 
298
        del hook_calls[:]
 
299
        # ask by a name that is supplied by a builtin - the hook should not
 
300
        # fire and we still get our object.
 
301
        commands.install_bzr_command_hooks()
 
302
        cmd = commands.get_cmd_object('info')
 
303
        self.assertNotEqual(None, cmd)
 
304
        self.assertEqual(0, len(hook_calls))
 
305
 
 
306
 
 
307
class TestListCommandHook(tests.TestCase):
 
308
 
 
309
    def test_fires_on_all_command_names(self):
 
310
        # The list_commands() hook fires when all_command_names() is invoked.
 
311
        hook_calls = []
 
312
        commands.install_bzr_command_hooks()
 
313
        def list_my_commands(cmd_names):
 
314
            hook_calls.append('called')
 
315
            cmd_names.update(['foo', 'bar'])
 
316
            return cmd_names
 
317
        commands.Command.hooks.install_named_hook(
 
318
            "list_commands", list_my_commands, None)
 
319
        # Get a command, which should not trigger the hook.
 
320
        cmd = commands.get_cmd_object('info')
 
321
        self.assertEqual([], hook_calls)
 
322
        # Get all command classes (for docs and shell completion).
 
323
        cmds = list(commands.all_command_names())
 
324
        self.assertEqual(['called'], hook_calls)
 
325
        self.assertSubset(['foo', 'bar'], cmds)