~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_commands.py

  • Committer: Martin Pool
  • Date: 2005-09-13 23:18:12 UTC
  • Revision ID: mbp@sourcefrog.net-20050913231812-dc1df8fb11f78a31
- rename last_patch to last_revision

Show diffs side-by-side

added added

removed removed

Lines of Context:
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
 
    tests,
27
 
    )
28
 
from bzrlib.commands import display_command
29
 
from bzrlib.tests import TestSkipped
30
 
 
31
 
 
32
 
class TestCommands(tests.TestCase):
33
 
 
34
 
    def test_display_command(self):
35
 
        """EPIPE message is selectively suppressed"""
36
 
        def pipe_thrower():
37
 
            raise IOError(errno.EPIPE, "Bogus pipe error")
38
 
        self.assertRaises(IOError, pipe_thrower)
39
 
        @display_command
40
 
        def non_thrower():
41
 
            pipe_thrower()
42
 
        non_thrower()
43
 
        @display_command
44
 
        def other_thrower():
45
 
            raise IOError(errno.ESPIPE, "Bogus pipe error")
46
 
        self.assertRaises(IOError, other_thrower)
47
 
 
48
 
    def test_unicode_command(self):
49
 
        # This error is thrown when we can't find the command in the
50
 
        # list of available commands
51
 
        self.assertRaises(errors.BzrCommandError,
52
 
                          commands.run_bzr, [u'cmd\xb5'])
53
 
 
54
 
    def test_unicode_option(self):
55
 
        # This error is actually thrown by optparse, when it
56
 
        # can't find the given option
57
 
        import optparse
58
 
        if optparse.__version__ == "1.5.3":
59
 
            raise TestSkipped("optparse 1.5.3 can't handle unicode options")
60
 
        self.assertRaises(errors.BzrCommandError,
61
 
                          commands.run_bzr, ['log', u'--option\xb5'])
62
 
 
63
 
 
64
 
class TestGetAlias(tests.TestCase):
65
 
 
66
 
    def _get_config(self, config_text):
67
 
        my_config = config.GlobalConfig()
68
 
        config_file = StringIO(config_text.encode('utf-8'))
69
 
        my_config._parser = my_config._get_parser(file=config_file)
70
 
        return my_config
71
 
 
72
 
    def test_simple(self):
73
 
        my_config = self._get_config("[ALIASES]\n"
74
 
            "diff=diff -r -2..-1\n")
75
 
        self.assertEqual([u'diff', u'-r', u'-2..-1'],
76
 
            commands.get_alias("diff", config=my_config))
77
 
 
78
 
    def test_single_quotes(self):
79
 
        my_config = self._get_config("[ALIASES]\n"
80
 
            "diff=diff -r -2..-1 --diff-options "
81
 
            "'--strip-trailing-cr -wp'\n")
82
 
        self.assertEqual([u'diff', u'-r', u'-2..-1', u'--diff-options',
83
 
                          u'--strip-trailing-cr -wp'],
84
 
                          commands.get_alias("diff", config=my_config))
85
 
 
86
 
    def test_double_quotes(self):
87
 
        my_config = self._get_config("[ALIASES]\n"
88
 
            "diff=diff -r -2..-1 --diff-options "
89
 
            "\"--strip-trailing-cr -wp\"\n")
90
 
        self.assertEqual([u'diff', u'-r', u'-2..-1', u'--diff-options',
91
 
                          u'--strip-trailing-cr -wp'],
92
 
                          commands.get_alias("diff", config=my_config))
93
 
 
94
 
    def test_unicode(self):
95
 
        my_config = self._get_config("[ALIASES]\n"
96
 
            u"iam=whoami 'Erik B\u00e5gfors <erik@bagfors.nu>'\n")
97
 
        self.assertEqual([u'whoami', u'Erik B\u00e5gfors <erik@bagfors.nu>'],
98
 
                          commands.get_alias("iam", config=my_config))
99
 
 
100
 
 
101
 
class TestSeeAlso(tests.TestCase):
102
 
    """Tests for the see also functional of Command."""
103
 
 
104
 
    def test_default_subclass_no_see_also(self):
105
 
        class ACommand(commands.Command):
106
 
            """A sample command."""
107
 
        command = ACommand()
108
 
        self.assertEqual([], command.get_see_also())
109
 
 
110
 
    def test__see_also(self):
111
 
        """When _see_also is defined, it sets the result of get_see_also()."""
112
 
        class ACommand(commands.Command):
113
 
            _see_also = ['bar', 'foo']
114
 
        command = ACommand()
115
 
        self.assertEqual(['bar', 'foo'], command.get_see_also())
116
 
 
117
 
    def test_deduplication(self):
118
 
        """Duplicates in _see_also are stripped out."""
119
 
        class ACommand(commands.Command):
120
 
            _see_also = ['foo', 'foo']
121
 
        command = ACommand()
122
 
        self.assertEqual(['foo'], command.get_see_also())
123
 
 
124
 
    def test_sorted(self):
125
 
        """_see_also is sorted by get_see_also."""
126
 
        class ACommand(commands.Command):
127
 
            _see_also = ['foo', 'bar']
128
 
        command = ACommand()
129
 
        self.assertEqual(['bar', 'foo'], command.get_see_also())
130
 
 
131
 
    def test_additional_terms(self):
132
 
        """Additional terms can be supplied and are deduped and sorted."""
133
 
        class ACommand(commands.Command):
134
 
            _see_also = ['foo', 'bar']
135
 
        command = ACommand()
136
 
        self.assertEqual(['bar', 'foo', 'gam'],
137
 
            command.get_see_also(['gam', 'bar', 'gam']))
138
 
 
139
 
 
140
 
class TestRegisterLazy(tests.TestCase):
141
 
 
142
 
    def setUp(self):
143
 
        import bzrlib.tests.fake_command
144
 
        del sys.modules['bzrlib.tests.fake_command']
145
 
        global lazy_command_imported
146
 
        lazy_command_imported = False
147
 
 
148
 
    @staticmethod
149
 
    def remove_fake():
150
 
        commands.plugin_cmds.remove('fake')
151
 
 
152
 
    def assertIsFakeCommand(self, cmd_obj):
153
 
        from bzrlib.tests.fake_command import cmd_fake
154
 
        self.assertIsInstance(cmd_obj, cmd_fake)
155
 
 
156
 
    def test_register_lazy(self):
157
 
        """Ensure lazy registration works"""
158
 
        commands.plugin_cmds.register_lazy('cmd_fake', [],
159
 
                                           'bzrlib.tests.fake_command')
160
 
        self.addCleanup(self.remove_fake)
161
 
        self.assertFalse(lazy_command_imported)
162
 
        fake_instance = commands.get_cmd_object('fake')
163
 
        self.assertTrue(lazy_command_imported)
164
 
        self.assertIsFakeCommand(fake_instance)
165
 
 
166
 
    def test_get_unrelated_does_not_import(self):
167
 
        commands.plugin_cmds.register_lazy('cmd_fake', [],
168
 
                                           'bzrlib.tests.fake_command')
169
 
        self.addCleanup(self.remove_fake)
170
 
        commands.get_cmd_object('status')
171
 
        self.assertFalse(lazy_command_imported)
172
 
 
173
 
    def test_aliases(self):
174
 
        commands.plugin_cmds.register_lazy('cmd_fake', ['fake_alias'],
175
 
                                           'bzrlib.tests.fake_command')
176
 
        self.addCleanup(self.remove_fake)
177
 
        fake_instance = commands.get_cmd_object('fake_alias')
178
 
        self.assertIsFakeCommand(fake_instance)
179
 
 
180
 
 
181
 
class TestExtendCommandHook(tests.TestCase):
182
 
 
183
 
    def test_fires_on_get_cmd_object(self):
184
 
        # The extend_command(cmd) hook fires when commands are delivered to the
185
 
        # ui, not simply at registration (because lazy registered plugin
186
 
        # commands are registered).
187
 
        # when they are simply created.
188
 
        hook_calls = []
189
 
        commands.Command.hooks.install_named_hook(
190
 
            "extend_command", hook_calls.append, None)
191
 
        # create a command, should not fire
192
 
        class ACommand(commands.Command):
193
 
            """A sample command."""
194
 
        cmd = ACommand()
195
 
        self.assertEqual([], hook_calls)
196
 
        # -- as a builtin
197
 
        # register the command class, should not fire
198
 
        try:
199
 
            builtins.cmd_test_extend_command_hook = ACommand
200
 
            self.assertEqual([], hook_calls)
201
 
            # and ask for the object, should fire
202
 
            cmd = commands.get_cmd_object('test-extend-command-hook')
203
 
            # For resilience - to ensure all code paths hit it - we
204
 
            # fire on everything returned in the 'cmd_dict', which is currently
205
 
            # all known commands, so assert that cmd is in hook_calls
206
 
            self.assertSubset([cmd], hook_calls)
207
 
            del hook_calls[:]
208
 
        finally:
209
 
            del builtins.cmd_test_extend_command_hook
210
 
        # -- as a plugin lazy registration
211
 
        try:
212
 
            # register the command class, should not fire
213
 
            commands.plugin_cmds.register_lazy('cmd_fake', [],
214
 
                                               'bzrlib.tests.fake_command')
215
 
            self.assertEqual([], hook_calls)
216
 
            # and ask for the object, should fire
217
 
            cmd = commands.get_cmd_object('fake')
218
 
            self.assertEqual([cmd], hook_calls)
219
 
        finally:
220
 
            commands.plugin_cmds.remove('fake')