← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_commands.py

(jameinel) Allow 'bzr serve' to interpret SIGHUP as a graceful shutdown.
 (bug #795025) (John A Meinel)

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-2011 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
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 (
23
23
    commands,
24
24
    config,
25
25
    errors,
 
26
    option,
 
27
    symbol_versioning,
26
28
    tests,
27
29
    )
28
30
from bzrlib.commands import display_command
31
33
 
32
34
class TestCommands(tests.TestCase):
33
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
 
34
47
    def test_display_command(self):
35
48
        """EPIPE message is selectively suppressed"""
36
49
        def pipe_thrower():
60
73
        self.assertRaises(errors.BzrCommandError,
61
74
                          commands.run_bzr, ['log', u'--option\xb5'])
62
75
 
 
76
    @staticmethod
 
77
    def get_command(options):
 
78
        class cmd_foo(commands.Command):
 
79
            __doc__ = 'Bar'
 
80
 
 
81
            takes_options = options
 
82
 
 
83
        return cmd_foo()
 
84
 
 
85
    def test_help_hidden(self):
 
86
        c = self.get_command([option.Option('foo', hidden=True)])
 
87
        self.assertNotContainsRe(c.get_help_text(), '--foo')
 
88
 
 
89
    def test_help_not_hidden(self):
 
90
        c = self.get_command([option.Option('foo', hidden=False)])
 
91
        self.assertContainsRe(c.get_help_text(), '--foo')
 
92
 
 
93
 
 
94
class TestInvokedAs(tests.TestCase):
 
95
 
 
96
    def test_invoked_as(self):
 
97
        """The command object knows the actual name used to invoke it."""
 
98
        commands.install_bzr_command_hooks()
 
99
        commands._register_builtin_commands()
 
100
        # get one from the real get_cmd_object.
 
101
        c = commands.get_cmd_object('ci')
 
102
        self.assertIsInstance(c, builtins.cmd_commit)
 
103
        self.assertEquals(c.invoked_as, 'ci')
 
104
 
63
105
 
64
106
class TestGetAlias(tests.TestCase):
65
107
 
66
108
    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)
 
109
        my_config = config.GlobalConfig.from_string(config_text)
70
110
        return my_config
71
111
 
72
112
    def test_simple(self):
93
133
 
94
134
    def test_unicode(self):
95
135
        my_config = self._get_config("[ALIASES]\n"
96
 
            u"iam=whoami 'Erik B\u00e5gfors <erik@bagfors.nu>'\n")
 
136
            u'iam=whoami "Erik B\u00e5gfors <erik@bagfors.nu>"\n')
97
137
        self.assertEqual([u'whoami', u'Erik B\u00e5gfors <erik@bagfors.nu>'],
98
138
                          commands.get_alias("iam", config=my_config))
99
139
 
101
141
class TestSeeAlso(tests.TestCase):
102
142
    """Tests for the see also functional of Command."""
103
143
 
 
144
    @staticmethod
 
145
    def _get_command_with_see_also(see_also):
 
146
        class ACommand(commands.Command):
 
147
            __doc__ = """A sample command."""
 
148
            _see_also = see_also
 
149
        return ACommand()
 
150
 
104
151
    def test_default_subclass_no_see_also(self):
105
 
        class ACommand(commands.Command):
106
 
            """A sample command."""
107
 
        command = ACommand()
 
152
        command = self._get_command_with_see_also([])
108
153
        self.assertEqual([], command.get_see_also())
109
154
 
110
155
    def test__see_also(self):
111
156
        """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()
 
157
        command = self._get_command_with_see_also(['bar', 'foo'])
115
158
        self.assertEqual(['bar', 'foo'], command.get_see_also())
116
159
 
117
160
    def test_deduplication(self):
118
161
        """Duplicates in _see_also are stripped out."""
119
 
        class ACommand(commands.Command):
120
 
            _see_also = ['foo', 'foo']
121
 
        command = ACommand()
 
162
        command = self._get_command_with_see_also(['foo', 'foo'])
122
163
        self.assertEqual(['foo'], command.get_see_also())
123
164
 
124
165
    def test_sorted(self):
125
166
        """_see_also is sorted by get_see_also."""
126
 
        class ACommand(commands.Command):
127
 
            _see_also = ['foo', 'bar']
128
 
        command = ACommand()
 
167
        command = self._get_command_with_see_also(['foo', 'bar'])
129
168
        self.assertEqual(['bar', 'foo'], command.get_see_also())
130
169
 
131
170
    def test_additional_terms(self):
132
171
        """Additional terms can be supplied and are deduped and sorted."""
133
 
        class ACommand(commands.Command):
134
 
            _see_also = ['foo', 'bar']
135
 
        command = ACommand()
 
172
        command = self._get_command_with_see_also(['foo', 'bar'])
136
173
        self.assertEqual(['bar', 'foo', 'gam'],
137
174
            command.get_see_also(['gam', 'bar', 'gam']))
138
175
 
140
177
class TestRegisterLazy(tests.TestCase):
141
178
 
142
179
    def setUp(self):
 
180
        tests.TestCase.setUp(self)
143
181
        import bzrlib.tests.fake_command
144
182
        del sys.modules['bzrlib.tests.fake_command']
145
183
        global lazy_command_imported
146
184
        lazy_command_imported = False
 
185
        commands.install_bzr_command_hooks()
147
186
 
148
187
    @staticmethod
149
188
    def remove_fake():
186
225
        # commands are registered).
187
226
        # when they are simply created.
188
227
        hook_calls = []
 
228
        commands.install_bzr_command_hooks()
189
229
        commands.Command.hooks.install_named_hook(
190
230
            "extend_command", hook_calls.append, None)
191
231
        # create a command, should not fire
192
 
        class ACommand(commands.Command):
193
 
            """A sample command."""
194
 
        cmd = ACommand()
 
232
        class cmd_test_extend_command_hook(commands.Command):
 
233
            __doc__ = """A sample command."""
195
234
        self.assertEqual([], hook_calls)
196
235
        # -- as a builtin
197
236
        # register the command class, should not fire
198
237
        try:
199
 
            builtins.cmd_test_extend_command_hook = ACommand
 
238
            commands.builtin_command_registry.register(cmd_test_extend_command_hook)
200
239
            self.assertEqual([], hook_calls)
201
240
            # and ask for the object, should fire
202
241
            cmd = commands.get_cmd_object('test-extend-command-hook')
206
245
            self.assertSubset([cmd], hook_calls)
207
246
            del hook_calls[:]
208
247
        finally:
209
 
            del builtins.cmd_test_extend_command_hook
 
248
            commands.builtin_command_registry.remove('test-extend-command-hook')
210
249
        # -- as a plugin lazy registration
211
250
        try:
212
251
            # register the command class, should not fire
218
257
            self.assertEqual([cmd], hook_calls)
219
258
        finally:
220
259
            commands.plugin_cmds.remove('fake')
 
260
 
 
261
 
 
262
class TestGetCommandHook(tests.TestCase):
 
263
 
 
264
    def test_fires_on_get_cmd_object(self):
 
265
        # The get_command(cmd) hook fires when commands are delivered to the
 
266
        # ui.
 
267
        commands.install_bzr_command_hooks()
 
268
        hook_calls = []
 
269
        class ACommand(commands.Command):
 
270
            __doc__ = """A sample command."""
 
271
        def get_cmd(cmd_or_None, cmd_name):
 
272
            hook_calls.append(('called', cmd_or_None, cmd_name))
 
273
            if cmd_name in ('foo', 'info'):
 
274
                return ACommand()
 
275
        commands.Command.hooks.install_named_hook(
 
276
            "get_command", get_cmd, None)
 
277
        # create a command directly, should not fire
 
278
        cmd = ACommand()
 
279
        self.assertEqual([], hook_calls)
 
280
        # ask by name, should fire and give us our command
 
281
        cmd = commands.get_cmd_object('foo')
 
282
        self.assertEqual([('called', None, 'foo')], hook_calls)
 
283
        self.assertIsInstance(cmd, ACommand)
 
284
        del hook_calls[:]
 
285
        # ask by a name that is supplied by a builtin - the hook should still
 
286
        # fire and we still get our object, but we should see the builtin
 
287
        # passed to the hook.
 
288
        cmd = commands.get_cmd_object('info')
 
289
        self.assertIsInstance(cmd, ACommand)
 
290
        self.assertEqual(1, len(hook_calls))
 
291
        self.assertEqual('info', hook_calls[0][2])
 
292
        self.assertIsInstance(hook_calls[0][1], builtins.cmd_info)
 
293
 
 
294
 
 
295
class TestGetMissingCommandHook(tests.TestCase):
 
296
 
 
297
    def hook_missing(self):
 
298
        """Hook get_missing_command for testing."""
 
299
        self.hook_calls = []
 
300
        class ACommand(commands.Command):
 
301
            __doc__ = """A sample command."""
 
302
        def get_missing_cmd(cmd_name):
 
303
            self.hook_calls.append(('called', cmd_name))
 
304
            if cmd_name in ('foo', 'info'):
 
305
                return ACommand()
 
306
        commands.Command.hooks.install_named_hook(
 
307
            "get_missing_command", get_missing_cmd, None)
 
308
        self.ACommand = ACommand
 
309
 
 
310
    def test_fires_on_get_cmd_object(self):
 
311
        # The get_missing_command(cmd) hook fires when commands are delivered to the
 
312
        # ui.
 
313
        self.hook_missing()
 
314
        # create a command directly, should not fire
 
315
        self.cmd = self.ACommand()
 
316
        self.assertEqual([], self.hook_calls)
 
317
        # ask by name, should fire and give us our command
 
318
        cmd = commands.get_cmd_object('foo')
 
319
        self.assertEqual([('called', 'foo')], self.hook_calls)
 
320
        self.assertIsInstance(cmd, self.ACommand)
 
321
        del self.hook_calls[:]
 
322
        # ask by a name that is supplied by a builtin - the hook should not
 
323
        # fire and we still get our object.
 
324
        commands.install_bzr_command_hooks()
 
325
        cmd = commands.get_cmd_object('info')
 
326
        self.assertNotEqual(None, cmd)
 
327
        self.assertEqual(0, len(self.hook_calls))
 
328
 
 
329
    def test_skipped_on_HelpCommandIndex_get_topics(self):
 
330
        # The get_missing_command(cmd_name) hook is not fired when
 
331
        # looking up help topics.
 
332
        self.hook_missing()
 
333
        topic = commands.HelpCommandIndex()
 
334
        topics = topic.get_topics('foo')
 
335
        self.assertEqual([], self.hook_calls)
 
336
 
 
337
 
 
338
class TestListCommandHook(tests.TestCase):
 
339
 
 
340
    def test_fires_on_all_command_names(self):
 
341
        # The list_commands() hook fires when all_command_names() is invoked.
 
342
        hook_calls = []
 
343
        commands.install_bzr_command_hooks()
 
344
        def list_my_commands(cmd_names):
 
345
            hook_calls.append('called')
 
346
            cmd_names.update(['foo', 'bar'])
 
347
            return cmd_names
 
348
        commands.Command.hooks.install_named_hook(
 
349
            "list_commands", list_my_commands, None)
 
350
        # Get a command, which should not trigger the hook.
 
351
        cmd = commands.get_cmd_object('info')
 
352
        self.assertEqual([], hook_calls)
 
353
        # Get all command classes (for docs and shell completion).
 
354
        cmds = list(commands.all_command_names())
 
355
        self.assertEqual(['called'], hook_calls)
 
356
        self.assertSubset(['foo', 'bar'], cmds)