← 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: John Arbash Meinel
  • Date: 2008-11-25 17:15:26 UTC
  • mto: This revision was merged to the branch mainline in revision 3851.
  • Revision ID: john@arbash-meinel.com-20081125171526-pi2g4m1w70pkie1f
Add a bit of help text when supplying --help.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_commands.py
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
17
from cStringIO import StringIO
18
18
import errno
19
19
import sys
20
20
 
21
21
from bzrlib import (
22
 
    builtins,
23
22
    commands,
24
23
    config,
25
24
    errors,
26
 
    option,
27
 
    symbol_versioning,
28
25
    tests,
29
26
    )
30
27
from bzrlib.commands import display_command
62
59
        self.assertRaises(errors.BzrCommandError,
63
60
                          commands.run_bzr, ['log', u'--option\xb5'])
64
61
 
65
 
    @staticmethod
66
 
    def get_command(options):
67
 
        class cmd_foo(commands.Command):
68
 
            '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
 
 
82
62
 
83
63
class TestGetAlias(tests.TestCase):
84
64
 
112
92
 
113
93
    def test_unicode(self):
114
94
        my_config = self._get_config("[ALIASES]\n"
115
 
            u'iam=whoami "Erik B\u00e5gfors <erik@bagfors.nu>"\n')
 
95
            u"iam=whoami 'Erik B\u00e5gfors <erik@bagfors.nu>'\n")
116
96
        self.assertEqual([u'whoami', u'Erik B\u00e5gfors <erik@bagfors.nu>'],
117
97
                          commands.get_alias("iam", config=my_config))
118
98
 
159
139
class TestRegisterLazy(tests.TestCase):
160
140
 
161
141
    def setUp(self):
162
 
        tests.TestCase.setUp(self)
163
142
        import bzrlib.tests.fake_command
164
143
        del sys.modules['bzrlib.tests.fake_command']
165
144
        global lazy_command_imported
166
145
        lazy_command_imported = False
167
 
        commands.install_bzr_command_hooks()
168
146
 
169
147
    @staticmethod
170
148
    def remove_fake():
197
175
        self.addCleanup(self.remove_fake)
198
176
        fake_instance = commands.get_cmd_object('fake_alias')
199
177
        self.assertIsFakeCommand(fake_instance)
200
 
 
201
 
 
202
 
class TestExtendCommandHook(tests.TestCase):
203
 
 
204
 
    def test_fires_on_get_cmd_object(self):
205
 
        # The extend_command(cmd) hook fires when commands are delivered to the
206
 
        # ui, not simply at registration (because lazy registered plugin
207
 
        # commands are registered).
208
 
        # when they are simply created.
209
 
        hook_calls = []
210
 
        commands.install_bzr_command_hooks()
211
 
        commands.Command.hooks.install_named_hook(
212
 
            "extend_command", hook_calls.append, None)
213
 
        # create a command, should not fire
214
 
        class ACommand(commands.Command):
215
 
            """A sample command."""
216
 
        cmd = ACommand()
217
 
        self.assertEqual([], hook_calls)
218
 
        # -- as a builtin
219
 
        # register the command class, should not fire
220
 
        try:
221
 
            builtins.cmd_test_extend_command_hook = ACommand
222
 
            self.assertEqual([], hook_calls)
223
 
            # and ask for the object, should fire
224
 
            cmd = commands.get_cmd_object('test-extend-command-hook')
225
 
            # For resilience - to ensure all code paths hit it - we
226
 
            # fire on everything returned in the 'cmd_dict', which is currently
227
 
            # all known commands, so assert that cmd is in hook_calls
228
 
            self.assertSubset([cmd], hook_calls)
229
 
            del hook_calls[:]
230
 
        finally:
231
 
            del builtins.cmd_test_extend_command_hook
232
 
        # -- as a plugin lazy registration
233
 
        try:
234
 
            # register the command class, should not fire
235
 
            commands.plugin_cmds.register_lazy('cmd_fake', [],
236
 
                                               'bzrlib.tests.fake_command')
237
 
            self.assertEqual([], hook_calls)
238
 
            # and ask for the object, should fire
239
 
            cmd = commands.get_cmd_object('fake')
240
 
            self.assertEqual([cmd], hook_calls)
241
 
        finally:
242
 
            commands.plugin_cmds.remove('fake')
243
 
 
244
 
 
245
 
class TestGetCommandHook(tests.TestCase):
246
 
 
247
 
    def test_fires_on_get_cmd_object(self):
248
 
        # The get_command(cmd) hook fires when commands are delivered to the
249
 
        # ui.
250
 
        commands.install_bzr_command_hooks()
251
 
        hook_calls = []
252
 
        class ACommand(commands.Command):
253
 
            """A sample command."""
254
 
        def get_cmd(cmd_or_None, cmd_name):
255
 
            hook_calls.append(('called', cmd_or_None, cmd_name))
256
 
            if cmd_name in ('foo', 'info'):
257
 
                return ACommand()
258
 
        commands.Command.hooks.install_named_hook(
259
 
            "get_command", get_cmd, None)
260
 
        # create a command directly, should not fire
261
 
        cmd = ACommand()
262
 
        self.assertEqual([], hook_calls)
263
 
        # ask by name, should fire and give us our command
264
 
        cmd = commands.get_cmd_object('foo')
265
 
        self.assertEqual([('called', None, 'foo')], hook_calls)
266
 
        self.assertIsInstance(cmd, ACommand)
267
 
        del hook_calls[:]
268
 
        # ask by a name that is supplied by a builtin - the hook should still
269
 
        # fire and we still get our object, but we should see the builtin
270
 
        # passed to the hook.
271
 
        cmd = commands.get_cmd_object('info')
272
 
        self.assertIsInstance(cmd, ACommand)
273
 
        self.assertEqual(1, len(hook_calls))
274
 
        self.assertEqual('info', hook_calls[0][2])
275
 
        self.assertIsInstance(hook_calls[0][1], builtins.cmd_info)
276
 
 
277
 
 
278
 
class TestGetMissingCommandHook(tests.TestCase):
279
 
 
280
 
    def hook_missing(self):
281
 
        """Hook get_missing_command for testing."""
282
 
        self.hook_calls = []
283
 
        class ACommand(commands.Command):
284
 
            """A sample command."""
285
 
        def get_missing_cmd(cmd_name):
286
 
            self.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
 
        self.ACommand = ACommand
292
 
 
293
 
    def test_fires_on_get_cmd_object(self):
294
 
        # The get_missing_command(cmd) hook fires when commands are delivered to the
295
 
        # ui.
296
 
        self.hook_missing()
297
 
        # create a command directly, should not fire
298
 
        self.cmd = self.ACommand()
299
 
        self.assertEqual([], self.hook_calls)
300
 
        # ask by name, should fire and give us our command
301
 
        cmd = commands.get_cmd_object('foo')
302
 
        self.assertEqual([('called', 'foo')], self.hook_calls)
303
 
        self.assertIsInstance(cmd, self.ACommand)
304
 
        del self.hook_calls[:]
305
 
        # ask by a name that is supplied by a builtin - the hook should not
306
 
        # fire and we still get our object.
307
 
        commands.install_bzr_command_hooks()
308
 
        cmd = commands.get_cmd_object('info')
309
 
        self.assertNotEqual(None, cmd)
310
 
        self.assertEqual(0, len(self.hook_calls))
311
 
 
312
 
    def test_skipped_on_HelpCommandIndex_get_topics(self):
313
 
        # The get_missing_command(cmd_name) hook is not fired when
314
 
        # looking up help topics.
315
 
        self.hook_missing()
316
 
        topic = commands.HelpCommandIndex()
317
 
        topics = topic.get_topics('foo')
318
 
        self.assertEqual([], self.hook_calls)
319
 
 
320
 
 
321
 
class TestListCommandHook(tests.TestCase):
322
 
 
323
 
    def test_fires_on_all_command_names(self):
324
 
        # The list_commands() hook fires when all_command_names() is invoked.
325
 
        hook_calls = []
326
 
        commands.install_bzr_command_hooks()
327
 
        def list_my_commands(cmd_names):
328
 
            hook_calls.append('called')
329
 
            cmd_names.update(['foo', 'bar'])
330
 
            return cmd_names
331
 
        commands.Command.hooks.install_named_hook(
332
 
            "list_commands", list_my_commands, None)
333
 
        # Get a command, which should not trigger the hook.
334
 
        cmd = commands.get_cmd_object('info')
335
 
        self.assertEqual([], hook_calls)
336
 
        # Get all command classes (for docs and shell completion).
337
 
        cmds = list(commands.all_command_names())
338
 
        self.assertEqual(['called'], hook_calls)
339
 
        self.assertSubset(['foo', 'bar'], cmds)
340
 
 
341
 
class TestDeprecations(tests.TestCase):
342
 
 
343
 
    def test_shlex_split_unicode_deprecation(self):
344
 
        res = self.applyDeprecated(
345
 
                symbol_versioning.deprecated_in((2, 2, 0)),
346
 
                commands.shlex_split_unicode, 'whatever')