1
# Copyright (C) 2005-2011 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
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
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
19
19
from bzrlib import (
27
25
from bzrlib.builtins import cmd_commit
28
from bzrlib.commands import parse_args
26
from bzrlib.commands import Command, parse_args
29
27
from bzrlib.tests import TestCase
30
28
from bzrlib.repofmt import knitrepo
44
42
# to cmd_commit, when they are meant to be about option parsing in
46
44
self.assertEqual(parse_args(cmd_commit(), ['--help']),
47
([], {'author': [], 'exclude': [], 'fixes': [], 'help': True}))
45
([], {'exclude': [], 'fixes': [], 'help': True}))
48
46
self.assertEqual(parse_args(cmd_commit(), ['--message=biter']),
49
([], {'author': [], 'exclude': [], 'fixes': [], 'message': 'biter'}))
47
([], {'exclude': [], 'fixes': [], 'message': 'biter'}))
51
49
def test_no_more_opts(self):
52
50
"""Terminated options"""
53
51
self.assertEqual(parse_args(cmd_commit(), ['--', '-file-with-dashes']),
54
(['-file-with-dashes'], {'author': [], 'exclude': [], 'fixes': []}))
52
(['-file-with-dashes'], {'exclude': [], 'fixes': []}))
56
54
def test_option_help(self):
57
55
"""Options have help strings."""
104
102
self.assertRaises(errors.BzrCommandError, self.parse, options,
107
def test_is_hidden(self):
108
self.assertTrue(option.Option('foo', hidden=True).is_hidden('foo'))
109
self.assertFalse(option.Option('foo', hidden=False).is_hidden('foo'))
111
105
def test_registry_conversion(self):
112
registry = controldir.ControlDirFormatRegistry()
113
bzrdir.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
114
bzrdir.register_metadir(registry, 'two', 'RepositoryFormatKnit1', 'two help')
115
bzrdir.register_metadir(registry, 'hidden', 'RepositoryFormatKnit1',
106
registry = bzrdir.BzrDirFormatRegistry()
107
registry.register_metadir('one', 'RepositoryFormat7', 'one help')
108
registry.register_metadir('two', 'RepositoryFormatKnit1', 'two help')
109
registry.register_metadir('hidden', 'RepositoryFormatKnit1',
116
110
'two help', hidden=True)
117
111
registry.set_default('one')
118
112
options = [option.RegistryOption('format', '', registry, str)]
179
173
self.assertEqual('test option', my_option.help)
181
175
def test_help(self):
182
registry = controldir.ControlDirFormatRegistry()
183
bzrdir.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
184
bzrdir.register_metadir(registry, 'two',
176
registry = bzrdir.BzrDirFormatRegistry()
177
registry.register_metadir('one', 'RepositoryFormat7', 'one help')
178
registry.register_metadir('two',
185
179
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
188
bzrdir.register_metadir(registry, 'hidden', 'RepositoryFormat7', 'hidden help',
182
registry.register_metadir('hidden', 'RepositoryFormat7', 'hidden help',
190
184
registry.set_default('one')
191
185
options = [option.RegistryOption('format', 'format help', registry,
207
201
opt = option.Option('hello', help='fg', type=int, argname='gar')
208
202
self.assertEqual(list(opt.iter_switches()),
209
203
[('hello', None, 'GAR', 'fg')])
210
registry = controldir.ControlDirFormatRegistry()
211
bzrdir.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
212
bzrdir.register_metadir(registry, 'two',
204
registry = bzrdir.BzrDirFormatRegistry()
205
registry.register_metadir('one', 'RepositoryFormat7', 'one help')
206
registry.register_metadir('two',
213
207
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
320
314
self.assertEqual('hello', name)
321
315
self.assertEqual([], value)
323
def test_list_option_param_name(self):
324
"""Test list options can have their param_name set."""
325
options = [option.ListOption('hello', type=str, param_name='greeting')]
326
opts, args = self.parse(
327
options, ['--hello=world', '--hello=sailor'])
328
self.assertEqual(['world', 'sailor'], opts.greeting)
331
318
class TestOptionDefinitions(TestCase):
332
319
"""Tests for options in the Bazaar codebase."""
334
321
def get_builtin_command_options(self):
336
for cmd_name in sorted(commands.all_command_names()):
337
cmd = commands.get_cmd_object(cmd_name)
323
for cmd_name, cmd_class in sorted(commands.get_all_cmds()):
338
325
for opt_name, opt in sorted(cmd.options().items()):
339
326
g.append((cmd_name, opt))
347
334
g = dict(option.Option.OPTIONS.items())
348
335
used_globals = {}
350
for cmd_name in sorted(commands.all_command_names()):
351
cmd = commands.get_cmd_object(cmd_name)
352
for option_or_name in sorted(cmd.takes_options):
337
for cmd_name, cmd_class in sorted(commands.get_all_cmds()):
338
for option_or_name in sorted(cmd_class.takes_options):
353
339
if not isinstance(option_or_name, basestring):
354
340
self.assertIsInstance(option_or_name, option.Option)
355
341
elif not option_or_name in g:
356
342
msgs.append("apparent reference to undefined "
357
343
"global option %r from %r"
358
% (option_or_name, cmd))
344
% (option_or_name, cmd_class))
360
346
used_globals.setdefault(option_or_name, []).append(cmd_name)
361
347
unused_globals = set(g.keys()) - set(used_globals.keys())
388
374
+ '\n'.join(msgs))
390
376
def test_is_hidden(self):
391
registry = controldir.ControlDirFormatRegistry()
392
bzrdir.register_metadir(registry, 'hidden', 'HiddenFormat',
377
registry = bzrdir.BzrDirFormatRegistry()
378
registry.register_metadir('hidden', 'HiddenFormat',
393
379
'hidden help text', hidden=True)
394
bzrdir.register_metadir(registry, 'visible', 'VisibleFormat',
380
registry.register_metadir('visible', 'VisibleFormat',
395
381
'visible help text', hidden=False)
396
382
format = option.RegistryOption('format', '', registry, str)
397
383
self.assertTrue(format.is_hidden('hidden'))
398
384
self.assertFalse(format.is_hidden('visible'))
400
def test_short_name(self):
401
registry = controldir.ControlDirFormatRegistry()
402
opt = option.RegistryOption('format', help='', registry=registry)
403
self.assertEquals(None, opt.short_name())
404
opt = option.RegistryOption('format', short_name='F', help='',
406
self.assertEquals('F', opt.short_name())
408
386
def test_option_custom_help(self):
409
387
the_opt = option.Option.OPTIONS['help']
410
388
orig_help = the_opt.help[:]
413
391
self.assertEqual('suggest lottery numbers', my_opt.help)
414
392
self.assertEqual(orig_help, the_opt.help)
416
def test_short_value_switches(self):
417
reg = registry.Registry()
418
reg.register('short', 'ShortChoice')
419
reg.register('long', 'LongChoice')
420
ropt = option.RegistryOption('choice', '', reg, value_switches=True,
421
short_value_switches={'short': 's'})
422
opts, args = parse([ropt], ['--short'])
423
self.assertEqual('ShortChoice', opts.choice)
424
opts, args = parse([ropt], ['-s'])
425
self.assertEqual('ShortChoice', opts.choice)
428
395
class TestVerboseQuietLinkage(TestCase):