← 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: Robert Collins
  • Date: 2007-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

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
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
 
17
from cStringIO import StringIO
17
18
import errno
18
 
import inspect
19
 
import sys
20
19
 
21
20
from bzrlib import (
22
 
    builtins,
23
21
    commands,
24
22
    config,
25
23
    errors,
26
 
    option,
27
 
    symbol_versioning,
28
 
    tests,
29
24
    )
30
25
from bzrlib.commands import display_command
31
 
from bzrlib.tests import TestSkipped
32
 
 
33
 
 
34
 
class TestCommands(tests.TestCase):
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)
 
26
from bzrlib.tests import TestCase, TestSkipped
 
27
 
 
28
 
 
29
class TestCommands(TestCase):
46
30
 
47
31
    def test_display_command(self):
48
32
        """EPIPE message is selectively suppressed"""
73
57
        self.assertRaises(errors.BzrCommandError,
74
58
                          commands.run_bzr, ['log', u'--option\xb5'])
75
59
 
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 TestGetAlias(tests.TestCase):
 
60
 
 
61
class TestGetAlias(TestCase):
95
62
 
96
63
    def _get_config(self, config_text):
97
 
        my_config = config.GlobalConfig.from_string(config_text)
 
64
        my_config = config.GlobalConfig()
 
65
        config_file = StringIO(config_text.encode('utf-8'))
 
66
        my_config._parser = my_config._get_parser(file=config_file)
98
67
        return my_config
99
68
 
100
69
    def test_simple(self):
121
90
 
122
91
    def test_unicode(self):
123
92
        my_config = self._get_config("[ALIASES]\n"
124
 
            u'iam=whoami "Erik B\u00e5gfors <erik@bagfors.nu>"\n')
 
93
            u"iam=whoami 'Erik B\u00e5gfors <erik@bagfors.nu>'\n")
125
94
        self.assertEqual([u'whoami', u'Erik B\u00e5gfors <erik@bagfors.nu>'],
126
95
                          commands.get_alias("iam", config=my_config))
127
 
 
128
 
 
129
 
class TestSeeAlso(tests.TestCase):
130
 
    """Tests for the see also functional of Command."""
131
 
 
132
 
    @staticmethod
133
 
    def _get_command_with_see_also(see_also):
134
 
        class ACommand(commands.Command):
135
 
            __doc__ = """A sample command."""
136
 
            _see_also = see_also
137
 
        return ACommand()
138
 
 
139
 
    def test_default_subclass_no_see_also(self):
140
 
        command = self._get_command_with_see_also([])
141
 
        self.assertEqual([], command.get_see_also())
142
 
 
143
 
    def test__see_also(self):
144
 
        """When _see_also is defined, it sets the result of get_see_also()."""
145
 
        command = self._get_command_with_see_also(['bar', 'foo'])
146
 
        self.assertEqual(['bar', 'foo'], command.get_see_also())
147
 
 
148
 
    def test_deduplication(self):
149
 
        """Duplicates in _see_also are stripped out."""
150
 
        command = self._get_command_with_see_also(['foo', 'foo'])
151
 
        self.assertEqual(['foo'], command.get_see_also())
152
 
 
153
 
    def test_sorted(self):
154
 
        """_see_also is sorted by get_see_also."""
155
 
        command = self._get_command_with_see_also(['foo', 'bar'])
156
 
        self.assertEqual(['bar', 'foo'], command.get_see_also())
157
 
 
158
 
    def test_additional_terms(self):
159
 
        """Additional terms can be supplied and are deduped and sorted."""
160
 
        command = self._get_command_with_see_also(['foo', 'bar'])
161
 
        self.assertEqual(['bar', 'foo', 'gam'],
162
 
            command.get_see_also(['gam', 'bar', 'gam']))
163
 
 
164
 
 
165
 
class TestRegisterLazy(tests.TestCase):
166
 
 
167
 
    def setUp(self):
168
 
        tests.TestCase.setUp(self)
169
 
        import bzrlib.tests.fake_command
170
 
        del sys.modules['bzrlib.tests.fake_command']
171
 
        global lazy_command_imported
172
 
        lazy_command_imported = False
173
 
        commands.install_bzr_command_hooks()
174
 
 
175
 
    @staticmethod
176
 
    def remove_fake():
177
 
        commands.plugin_cmds.remove('fake')
178
 
 
179
 
    def assertIsFakeCommand(self, cmd_obj):
180
 
        from bzrlib.tests.fake_command import cmd_fake
181
 
        self.assertIsInstance(cmd_obj, cmd_fake)
182
 
 
183
 
    def test_register_lazy(self):
184
 
        """Ensure lazy registration works"""
185
 
        commands.plugin_cmds.register_lazy('cmd_fake', [],
186
 
                                           'bzrlib.tests.fake_command')
187
 
        self.addCleanup(self.remove_fake)
188
 
        self.assertFalse(lazy_command_imported)
189
 
        fake_instance = commands.get_cmd_object('fake')
190
 
        self.assertTrue(lazy_command_imported)
191
 
        self.assertIsFakeCommand(fake_instance)
192
 
 
193
 
    def test_get_unrelated_does_not_import(self):
194
 
        commands.plugin_cmds.register_lazy('cmd_fake', [],
195
 
                                           'bzrlib.tests.fake_command')
196
 
        self.addCleanup(self.remove_fake)
197
 
        commands.get_cmd_object('status')
198
 
        self.assertFalse(lazy_command_imported)
199
 
 
200
 
    def test_aliases(self):
201
 
        commands.plugin_cmds.register_lazy('cmd_fake', ['fake_alias'],
202
 
                                           'bzrlib.tests.fake_command')
203
 
        self.addCleanup(self.remove_fake)
204
 
        fake_instance = commands.get_cmd_object('fake_alias')
205
 
        self.assertIsFakeCommand(fake_instance)
206
 
 
207
 
 
208
 
class TestExtendCommandHook(tests.TestCase):
209
 
 
210
 
    def test_fires_on_get_cmd_object(self):
211
 
        # The extend_command(cmd) hook fires when commands are delivered to the
212
 
        # ui, not simply at registration (because lazy registered plugin
213
 
        # commands are registered).
214
 
        # when they are simply created.
215
 
        hook_calls = []
216
 
        commands.install_bzr_command_hooks()
217
 
        commands.Command.hooks.install_named_hook(
218
 
            "extend_command", hook_calls.append, None)
219
 
        # create a command, should not fire
220
 
        class cmd_test_extend_command_hook(commands.Command):
221
 
            __doc__ = """A sample command."""
222
 
        self.assertEqual([], hook_calls)
223
 
        # -- as a builtin
224
 
        # register the command class, should not fire
225
 
        try:
226
 
            commands.builtin_command_registry.register(cmd_test_extend_command_hook)
227
 
            self.assertEqual([], hook_calls)
228
 
            # and ask for the object, should fire
229
 
            cmd = commands.get_cmd_object('test-extend-command-hook')
230
 
            # For resilience - to ensure all code paths hit it - we
231
 
            # fire on everything returned in the 'cmd_dict', which is currently
232
 
            # all known commands, so assert that cmd is in hook_calls
233
 
            self.assertSubset([cmd], hook_calls)
234
 
            del hook_calls[:]
235
 
        finally:
236
 
            commands.builtin_command_registry.remove('test-extend-command-hook')
237
 
        # -- as a plugin lazy registration
238
 
        try:
239
 
            # register the command class, should not fire
240
 
            commands.plugin_cmds.register_lazy('cmd_fake', [],
241
 
                                               'bzrlib.tests.fake_command')
242
 
            self.assertEqual([], hook_calls)
243
 
            # and ask for the object, should fire
244
 
            cmd = commands.get_cmd_object('fake')
245
 
            self.assertEqual([cmd], hook_calls)
246
 
        finally:
247
 
            commands.plugin_cmds.remove('fake')
248
 
 
249
 
 
250
 
class TestGetCommandHook(tests.TestCase):
251
 
 
252
 
    def test_fires_on_get_cmd_object(self):
253
 
        # The get_command(cmd) hook fires when commands are delivered to the
254
 
        # ui.
255
 
        commands.install_bzr_command_hooks()
256
 
        hook_calls = []
257
 
        class ACommand(commands.Command):
258
 
            __doc__ = """A sample command."""
259
 
        def get_cmd(cmd_or_None, cmd_name):
260
 
            hook_calls.append(('called', cmd_or_None, cmd_name))
261
 
            if cmd_name in ('foo', 'info'):
262
 
                return ACommand()
263
 
        commands.Command.hooks.install_named_hook(
264
 
            "get_command", get_cmd, None)
265
 
        # create a command directly, should not fire
266
 
        cmd = ACommand()
267
 
        self.assertEqual([], hook_calls)
268
 
        # ask by name, should fire and give us our command
269
 
        cmd = commands.get_cmd_object('foo')
270
 
        self.assertEqual([('called', None, 'foo')], hook_calls)
271
 
        self.assertIsInstance(cmd, ACommand)
272
 
        del hook_calls[:]
273
 
        # ask by a name that is supplied by a builtin - the hook should still
274
 
        # fire and we still get our object, but we should see the builtin
275
 
        # passed to the hook.
276
 
        cmd = commands.get_cmd_object('info')
277
 
        self.assertIsInstance(cmd, ACommand)
278
 
        self.assertEqual(1, len(hook_calls))
279
 
        self.assertEqual('info', hook_calls[0][2])
280
 
        self.assertIsInstance(hook_calls[0][1], builtins.cmd_info)
281
 
 
282
 
 
283
 
class TestGetMissingCommandHook(tests.TestCase):
284
 
 
285
 
    def hook_missing(self):
286
 
        """Hook get_missing_command for testing."""
287
 
        self.hook_calls = []
288
 
        class ACommand(commands.Command):
289
 
            __doc__ = """A sample command."""
290
 
        def get_missing_cmd(cmd_name):
291
 
            self.hook_calls.append(('called', cmd_name))
292
 
            if cmd_name in ('foo', 'info'):
293
 
                return ACommand()
294
 
        commands.Command.hooks.install_named_hook(
295
 
            "get_missing_command", get_missing_cmd, None)
296
 
        self.ACommand = ACommand
297
 
 
298
 
    def test_fires_on_get_cmd_object(self):
299
 
        # The get_missing_command(cmd) hook fires when commands are delivered to the
300
 
        # ui.
301
 
        self.hook_missing()
302
 
        # create a command directly, should not fire
303
 
        self.cmd = self.ACommand()
304
 
        self.assertEqual([], self.hook_calls)
305
 
        # ask by name, should fire and give us our command
306
 
        cmd = commands.get_cmd_object('foo')
307
 
        self.assertEqual([('called', 'foo')], self.hook_calls)
308
 
        self.assertIsInstance(cmd, self.ACommand)
309
 
        del self.hook_calls[:]
310
 
        # ask by a name that is supplied by a builtin - the hook should not
311
 
        # fire and we still get our object.
312
 
        commands.install_bzr_command_hooks()
313
 
        cmd = commands.get_cmd_object('info')
314
 
        self.assertNotEqual(None, cmd)
315
 
        self.assertEqual(0, len(self.hook_calls))
316
 
 
317
 
    def test_skipped_on_HelpCommandIndex_get_topics(self):
318
 
        # The get_missing_command(cmd_name) hook is not fired when
319
 
        # looking up help topics.
320
 
        self.hook_missing()
321
 
        topic = commands.HelpCommandIndex()
322
 
        topics = topic.get_topics('foo')
323
 
        self.assertEqual([], self.hook_calls)
324
 
 
325
 
 
326
 
class TestListCommandHook(tests.TestCase):
327
 
 
328
 
    def test_fires_on_all_command_names(self):
329
 
        # The list_commands() hook fires when all_command_names() is invoked.
330
 
        hook_calls = []
331
 
        commands.install_bzr_command_hooks()
332
 
        def list_my_commands(cmd_names):
333
 
            hook_calls.append('called')
334
 
            cmd_names.update(['foo', 'bar'])
335
 
            return cmd_names
336
 
        commands.Command.hooks.install_named_hook(
337
 
            "list_commands", list_my_commands, None)
338
 
        # Get a command, which should not trigger the hook.
339
 
        cmd = commands.get_cmd_object('info')
340
 
        self.assertEqual([], hook_calls)
341
 
        # Get all command classes (for docs and shell completion).
342
 
        cmds = list(commands.all_command_names())
343
 
        self.assertEqual(['called'], hook_calls)
344
 
        self.assertSubset(['foo', 'bar'], cmds)
345
 
 
346
 
 
347
 
class TestDeprecations(tests.TestCase):
348
 
 
349
 
    def test_shlex_split_unicode_deprecation(self):
350
 
        res = self.applyDeprecated(
351
 
                symbol_versioning.deprecated_in((2, 2, 0)),
352
 
                commands.shlex_split_unicode, 'whatever')