← 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: Vincent Ladeuil
  • Date: 2010-04-26 13:51:08 UTC
  • mto: (5184.2.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5185.
  • Revision ID: v.ladeuil+lp@free.fr-20100426135108-vwmfphc2xg1w058c
Random cleanups to catch up with copyright updates in trunk.

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-2010 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
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
60
62
        self.assertRaises(errors.BzrCommandError,
61
63
                          commands.run_bzr, ['log', u'--option\xb5'])
62
64
 
 
65
    @staticmethod
 
66
    def get_command(options):
 
67
        class cmd_foo(commands.Command):
 
68
            __doc__ = 'Bar'
 
69
 
 
70
            takes_options = options
 
71
 
 
72
        return cmd_foo()
 
73
 
 
74
    def test_help_hidden(self):
 
75
        c = self.get_command([option.Option('foo', hidden=True)])
 
76
        self.assertNotContainsRe(c.get_help_text(), '--foo')
 
77
 
 
78
    def test_help_not_hidden(self):
 
79
        c = self.get_command([option.Option('foo', hidden=False)])
 
80
        self.assertContainsRe(c.get_help_text(), '--foo')
 
81
 
63
82
 
64
83
class TestGetAlias(tests.TestCase):
65
84
 
93
112
 
94
113
    def test_unicode(self):
95
114
        my_config = self._get_config("[ALIASES]\n"
96
 
            u"iam=whoami 'Erik B\u00e5gfors <erik@bagfors.nu>'\n")
 
115
            u'iam=whoami "Erik B\u00e5gfors <erik@bagfors.nu>"\n')
97
116
        self.assertEqual([u'whoami', u'Erik B\u00e5gfors <erik@bagfors.nu>'],
98
117
                          commands.get_alias("iam", config=my_config))
99
118
 
101
120
class TestSeeAlso(tests.TestCase):
102
121
    """Tests for the see also functional of Command."""
103
122
 
 
123
    @staticmethod
 
124
    def _get_command_with_see_also(see_also):
 
125
        class ACommand(commands.Command):
 
126
            __doc__ = """A sample command."""
 
127
            _see_also = see_also
 
128
        return ACommand()
 
129
 
104
130
    def test_default_subclass_no_see_also(self):
105
 
        class ACommand(commands.Command):
106
 
            """A sample command."""
107
 
        command = ACommand()
 
131
        command = self._get_command_with_see_also([])
108
132
        self.assertEqual([], command.get_see_also())
109
133
 
110
134
    def test__see_also(self):
111
135
        """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()
 
136
        command = self._get_command_with_see_also(['bar', 'foo'])
115
137
        self.assertEqual(['bar', 'foo'], command.get_see_also())
116
138
 
117
139
    def test_deduplication(self):
118
140
        """Duplicates in _see_also are stripped out."""
119
 
        class ACommand(commands.Command):
120
 
            _see_also = ['foo', 'foo']
121
 
        command = ACommand()
 
141
        command = self._get_command_with_see_also(['foo', 'foo'])
122
142
        self.assertEqual(['foo'], command.get_see_also())
123
143
 
124
144
    def test_sorted(self):
125
145
        """_see_also is sorted by get_see_also."""
126
 
        class ACommand(commands.Command):
127
 
            _see_also = ['foo', 'bar']
128
 
        command = ACommand()
 
146
        command = self._get_command_with_see_also(['foo', 'bar'])
129
147
        self.assertEqual(['bar', 'foo'], command.get_see_also())
130
148
 
131
149
    def test_additional_terms(self):
132
150
        """Additional terms can be supplied and are deduped and sorted."""
133
 
        class ACommand(commands.Command):
134
 
            _see_also = ['foo', 'bar']
135
 
        command = ACommand()
 
151
        command = self._get_command_with_see_also(['foo', 'bar'])
136
152
        self.assertEqual(['bar', 'foo', 'gam'],
137
153
            command.get_see_also(['gam', 'bar', 'gam']))
138
154
 
145
161
        del sys.modules['bzrlib.tests.fake_command']
146
162
        global lazy_command_imported
147
163
        lazy_command_imported = False
 
164
        commands.install_bzr_command_hooks()
148
165
 
149
166
    @staticmethod
150
167
    def remove_fake():
187
204
        # commands are registered).
188
205
        # when they are simply created.
189
206
        hook_calls = []
 
207
        commands.install_bzr_command_hooks()
190
208
        commands.Command.hooks.install_named_hook(
191
209
            "extend_command", hook_calls.append, None)
192
210
        # create a command, should not fire
193
 
        class ACommand(commands.Command):
194
 
            """A sample command."""
195
 
        cmd = ACommand()
 
211
        class cmd_test_extend_command_hook(commands.Command):
 
212
            __doc__ = """A sample command."""
196
213
        self.assertEqual([], hook_calls)
197
214
        # -- as a builtin
198
215
        # register the command class, should not fire
199
216
        try:
200
 
            builtins.cmd_test_extend_command_hook = ACommand
 
217
            commands.builtin_command_registry.register(cmd_test_extend_command_hook)
201
218
            self.assertEqual([], hook_calls)
202
219
            # and ask for the object, should fire
203
220
            cmd = commands.get_cmd_object('test-extend-command-hook')
207
224
            self.assertSubset([cmd], hook_calls)
208
225
            del hook_calls[:]
209
226
        finally:
210
 
            del builtins.cmd_test_extend_command_hook
 
227
            commands.builtin_command_registry.remove('test-extend-command-hook')
211
228
        # -- as a plugin lazy registration
212
229
        try:
213
230
            # register the command class, should not fire
219
236
            self.assertEqual([cmd], hook_calls)
220
237
        finally:
221
238
            commands.plugin_cmds.remove('fake')
 
239
 
 
240
 
 
241
class TestGetCommandHook(tests.TestCase):
 
242
 
 
243
    def test_fires_on_get_cmd_object(self):
 
244
        # The get_command(cmd) hook fires when commands are delivered to the
 
245
        # ui.
 
246
        commands.install_bzr_command_hooks()
 
247
        hook_calls = []
 
248
        class ACommand(commands.Command):
 
249
            __doc__ = """A sample command."""
 
250
        def get_cmd(cmd_or_None, cmd_name):
 
251
            hook_calls.append(('called', cmd_or_None, cmd_name))
 
252
            if cmd_name in ('foo', 'info'):
 
253
                return ACommand()
 
254
        commands.Command.hooks.install_named_hook(
 
255
            "get_command", get_cmd, None)
 
256
        # create a command directly, should not fire
 
257
        cmd = ACommand()
 
258
        self.assertEqual([], hook_calls)
 
259
        # ask by name, should fire and give us our command
 
260
        cmd = commands.get_cmd_object('foo')
 
261
        self.assertEqual([('called', None, 'foo')], hook_calls)
 
262
        self.assertIsInstance(cmd, ACommand)
 
263
        del hook_calls[:]
 
264
        # ask by a name that is supplied by a builtin - the hook should still
 
265
        # fire and we still get our object, but we should see the builtin
 
266
        # passed to the hook.
 
267
        cmd = commands.get_cmd_object('info')
 
268
        self.assertIsInstance(cmd, ACommand)
 
269
        self.assertEqual(1, len(hook_calls))
 
270
        self.assertEqual('info', hook_calls[0][2])
 
271
        self.assertIsInstance(hook_calls[0][1], builtins.cmd_info)
 
272
 
 
273
 
 
274
class TestGetMissingCommandHook(tests.TestCase):
 
275
 
 
276
    def hook_missing(self):
 
277
        """Hook get_missing_command for testing."""
 
278
        self.hook_calls = []
 
279
        class ACommand(commands.Command):
 
280
            __doc__ = """A sample command."""
 
281
        def get_missing_cmd(cmd_name):
 
282
            self.hook_calls.append(('called', cmd_name))
 
283
            if cmd_name in ('foo', 'info'):
 
284
                return ACommand()
 
285
        commands.Command.hooks.install_named_hook(
 
286
            "get_missing_command", get_missing_cmd, None)
 
287
        self.ACommand = ACommand
 
288
 
 
289
    def test_fires_on_get_cmd_object(self):
 
290
        # The get_missing_command(cmd) hook fires when commands are delivered to the
 
291
        # ui.
 
292
        self.hook_missing()
 
293
        # create a command directly, should not fire
 
294
        self.cmd = self.ACommand()
 
295
        self.assertEqual([], self.hook_calls)
 
296
        # ask by name, should fire and give us our command
 
297
        cmd = commands.get_cmd_object('foo')
 
298
        self.assertEqual([('called', 'foo')], self.hook_calls)
 
299
        self.assertIsInstance(cmd, self.ACommand)
 
300
        del self.hook_calls[:]
 
301
        # ask by a name that is supplied by a builtin - the hook should not
 
302
        # fire and we still get our object.
 
303
        commands.install_bzr_command_hooks()
 
304
        cmd = commands.get_cmd_object('info')
 
305
        self.assertNotEqual(None, cmd)
 
306
        self.assertEqual(0, len(self.hook_calls))
 
307
 
 
308
    def test_skipped_on_HelpCommandIndex_get_topics(self):
 
309
        # The get_missing_command(cmd_name) hook is not fired when
 
310
        # looking up help topics.
 
311
        self.hook_missing()
 
312
        topic = commands.HelpCommandIndex()
 
313
        topics = topic.get_topics('foo')
 
314
        self.assertEqual([], self.hook_calls)
 
315
 
 
316
 
 
317
class TestListCommandHook(tests.TestCase):
 
318
 
 
319
    def test_fires_on_all_command_names(self):
 
320
        # The list_commands() hook fires when all_command_names() is invoked.
 
321
        hook_calls = []
 
322
        commands.install_bzr_command_hooks()
 
323
        def list_my_commands(cmd_names):
 
324
            hook_calls.append('called')
 
325
            cmd_names.update(['foo', 'bar'])
 
326
            return cmd_names
 
327
        commands.Command.hooks.install_named_hook(
 
328
            "list_commands", list_my_commands, None)
 
329
        # Get a command, which should not trigger the hook.
 
330
        cmd = commands.get_cmd_object('info')
 
331
        self.assertEqual([], hook_calls)
 
332
        # Get all command classes (for docs and shell completion).
 
333
        cmds = list(commands.all_command_names())
 
334
        self.assertEqual(['called'], hook_calls)
 
335
        self.assertSubset(['foo', 'bar'], cmds)
 
336
 
 
337
class TestDeprecations(tests.TestCase):
 
338
 
 
339
    def test_shlex_split_unicode_deprecation(self):
 
340
        res = self.applyDeprecated(
 
341
                symbol_versioning.deprecated_in((2, 2, 0)),
 
342
                commands.shlex_split_unicode, 'whatever')