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
17
19
from bzrlib import (
25
from bzrlib.builtins import cmd_commit, cmd_log, cmd_status
26
from bzrlib.commands import Command, parse_args
26
from bzrlib.builtins import cmd_commit
27
from bzrlib.commands import parse_args
27
28
from bzrlib.tests import TestCase
28
29
from bzrlib.repofmt import knitrepo
30
32
def parse(options, args):
31
33
parser = option.get_optparser(dict((o.name, o) for o in options))
32
34
return parser.parse_args(args)
34
37
class OptionTests(TestCase):
35
38
"""Command-line option tests"""
37
40
def test_parse_args(self):
38
41
"""Option parser"""
39
eq = self.assertEquals
40
eq(parse_args(cmd_commit(), ['--help']),
42
eq(parse_args(cmd_commit(), ['--message=biter']),
43
([], {'message': 'biter'}))
44
## eq(parse_args(cmd_log(), '-r 500'.split()),
45
## ([], {'revision': RevisionSpec_int(500)}))
42
# XXX: Using cmd_commit makes these tests overly sensitive to changes
43
# to cmd_commit, when they are meant to be about option parsing in
45
self.assertEqual(parse_args(cmd_commit(), ['--help']),
46
([], {'author': [], 'exclude': [], 'fixes': [], 'help': True}))
47
self.assertEqual(parse_args(cmd_commit(), ['--message=biter']),
48
([], {'author': [], 'exclude': [], 'fixes': [], 'message': 'biter'}))
47
50
def test_no_more_opts(self):
48
51
"""Terminated options"""
49
self.assertEquals(parse_args(cmd_commit(), ['--', '-file-with-dashes']),
50
(['-file-with-dashes'], {}))
52
self.assertEqual(parse_args(cmd_commit(), ['--', '-file-with-dashes']),
53
(['-file-with-dashes'], {'author': [], 'exclude': [], 'fixes': []}))
52
55
def test_option_help(self):
53
56
"""Options have help strings."""
54
out, err = self.run_bzr_captured(['commit', '--help'])
55
self.assertContainsRe(out, r'--file(.|\n)*file containing commit'
57
out, err = self.run_bzr('commit --help')
58
self.assertContainsRe(out,
59
r'--file(.|\n)*Take commit message from this file\.')
57
60
self.assertContainsRe(out, r'-h.*--help')
59
62
def test_option_help_global(self):
60
63
"""Global options have help strings."""
61
out, err = self.run_bzr_captured(['help', 'status'])
62
self.assertContainsRe(out, r'--show-ids.*show internal object')
64
out, err = self.run_bzr('help status')
65
self.assertContainsRe(out, r'--show-ids.*Show internal object.')
64
67
def test_option_arg_help(self):
65
68
"""Help message shows option arguments."""
66
out, err = self.run_bzr_captured(['help', 'commit'])
67
self.assertEquals(err, '')
69
out, err = self.run_bzr('help commit')
70
self.assertEqual(err, '')
68
71
self.assertContainsRe(out, r'--file[ =]MSGFILE')
70
73
def test_unknown_short_opt(self):
71
out, err = self.run_bzr_captured(['help', '-r'], retcode=3)
74
out, err = self.run_bzr('help -r', retcode=3)
72
75
self.assertContainsRe(err, r'no such option')
74
def test_get_short_name(self):
75
file_opt = option.Option.OPTIONS['file']
76
self.assertEquals(file_opt.short_name(), 'F')
77
force_opt = option.Option.OPTIONS['force']
78
self.assertEquals(force_opt.short_name(), None)
80
77
def test_set_short_name(self):
81
78
o = option.Option('wiggle')
82
79
o.set_short_name('w')
83
80
self.assertEqual(o.short_name(), 'w')
85
def test_old_short_names(self):
86
# test the deprecated method for getting and setting short option
89
"access to SHORT_OPTIONS was deprecated in version 0.14."
90
" Set the short option name when constructing the Option.",
91
DeprecationWarning, 2)
93
def capture_warning(message, category, stacklevel=None):
94
_warnings.append((message, category, stacklevel))
95
old_warning_method = symbol_versioning.warn
97
# an example of the kind of thing plugins might want to do through
98
# the old interface - make a new option and then give it a short
100
symbol_versioning.set_warning_method(capture_warning)
101
example_opt = option.Option('example', help='example option')
102
option.Option.SHORT_OPTIONS['w'] = example_opt
103
self.assertEqual(example_opt.short_name(), 'w')
104
self.assertEqual([expected_warning], _warnings)
105
# now check that it can actually be parsed with the registered
107
opts, args = parse([example_opt], ['-w', 'foo'])
108
self.assertEqual(opts.example, True)
109
self.assertEqual(args, ['foo'])
111
symbol_versioning.set_warning_method(old_warning_method)
113
82
def test_allow_dash(self):
114
83
"""Test that we can pass a plain '-' as an argument."""
115
self.assertEqual((['-'], {}), parse_args(cmd_commit(), ['-']))
84
self.assertEqual((['-']), parse_args(cmd_commit(), ['-'])[0])
117
86
def parse(self, options, args):
118
87
parser = option.get_optparser(dict((o.name, o) for o in options))
165
156
self.assertIsInstance(opts.format.repository_format,
166
157
knitrepo.RepositoryFormatKnit1)
159
def test_lazy_registry(self):
160
options = [option.RegistryOption('format', '',
161
lazy_registry=('bzrlib.bzrdir','format_registry'),
163
opts, args = self.parse(options, ['--format', 'knit'])
164
self.assertEqual({'format': 'knit'}, opts)
166
errors.BadOptionValue, self.parse, options, ['--format', 'BAD'])
168
def test_from_kwargs(self):
169
my_option = option.RegistryOption.from_kwargs('my-option',
170
help='test option', short='be short', be_long='go long')
171
self.assertEqual(['my-option'],
172
[x[0] for x in my_option.iter_switches()])
173
my_option = option.RegistryOption.from_kwargs('my-option',
174
help='test option', title="My option", short='be short',
175
be_long='go long', value_switches=True)
176
self.assertEqual(['my-option', 'be-long', 'short'],
177
[x[0] for x in my_option.iter_switches()])
178
self.assertEqual('test option', my_option.help)
168
180
def test_help(self):
169
registry = bzrdir.BzrDirFormatRegistry()
170
registry.register_metadir('one', 'RepositoryFormat7', 'one help')
171
registry.register_metadir('two',
181
registry = controldir.ControlDirFormatRegistry()
182
bzrdir.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
183
bzrdir.register_metadir(registry, 'two',
172
184
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
187
bzrdir.register_metadir(registry, 'hidden', 'RepositoryFormat7', 'hidden help',
175
189
registry.set_default('one')
176
190
options = [option.RegistryOption('format', 'format help', registry,
177
191
str, value_switches=True, title='Formats')]
211
226
('two', None, None, 'two help'),
214
# >>> parse_args('log -r 500'.split())
215
# (['log'], {'revision': [<RevisionSpec_int 500>]})
216
# >>> parse_args('log -r500..600'.split())
217
# (['log'], {'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
218
# >>> parse_args('log -vr500..600'.split())
219
# (['log'], {'verbose': True, 'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
220
# >>> parse_args('log -rrevno:500..600'.split()) #the r takes an argument
221
# (['log'], {'revision': [<RevisionSpec_revno revno:500>, <RevisionSpec_int 600>]})
229
def test_option_callback_bool(self):
230
"Test booleans get True and False passed correctly to a callback."""
232
def cb(option, name, value, parser):
233
cb_calls.append((option,name,value,parser))
234
options = [option.Option('hello', custom_callback=cb)]
235
opts, args = self.parse(options, ['--hello', '--no-hello'])
236
self.assertEqual(2, len(cb_calls))
237
opt,name,value,parser = cb_calls[0]
238
self.assertEqual('hello', name)
239
self.assertTrue(value)
240
opt,name,value,parser = cb_calls[1]
241
self.assertEqual('hello', name)
242
self.assertFalse(value)
244
def test_option_callback_str(self):
245
"""Test callbacks work for string options both long and short."""
247
def cb(option, name, value, parser):
248
cb_calls.append((option,name,value,parser))
249
options = [option.Option('hello', type=str, custom_callback=cb,
251
opts, args = self.parse(options, ['--hello', 'world', '-h', 'mars'])
252
self.assertEqual(2, len(cb_calls))
253
opt,name,value,parser = cb_calls[0]
254
self.assertEqual('hello', name)
255
self.assertEqual('world', value)
256
opt,name,value,parser = cb_calls[1]
257
self.assertEqual('hello', name)
258
self.assertEqual('mars', value)
261
class TestListOptions(TestCase):
262
"""Tests for ListOption, used to specify lists on the command-line."""
264
def parse(self, options, args):
265
parser = option.get_optparser(dict((o.name, o) for o in options))
266
return parser.parse_args(args)
268
def test_list_option(self):
269
options = [option.ListOption('hello', type=str)]
270
opts, args = self.parse(options, ['--hello=world', '--hello=sailor'])
271
self.assertEqual(['world', 'sailor'], opts.hello)
273
def test_list_option_with_dash(self):
274
options = [option.ListOption('with-dash', type=str)]
275
opts, args = self.parse(options, ['--with-dash=world',
276
'--with-dash=sailor'])
277
self.assertEqual(['world', 'sailor'], opts.with_dash)
279
def test_list_option_no_arguments(self):
280
options = [option.ListOption('hello', type=str)]
281
opts, args = self.parse(options, [])
282
self.assertEqual([], opts.hello)
284
def test_list_option_with_int_type(self):
285
options = [option.ListOption('hello', type=int)]
286
opts, args = self.parse(options, ['--hello=2', '--hello=3'])
287
self.assertEqual([2, 3], opts.hello)
289
def test_list_option_with_int_type_can_be_reset(self):
290
options = [option.ListOption('hello', type=int)]
291
opts, args = self.parse(options, ['--hello=2', '--hello=3',
292
'--hello=-', '--hello=5'])
293
self.assertEqual([5], opts.hello)
295
def test_list_option_can_be_reset(self):
296
"""Passing an option of '-' to a list option should reset the list."""
297
options = [option.ListOption('hello', type=str)]
298
opts, args = self.parse(
299
options, ['--hello=a', '--hello=b', '--hello=-', '--hello=c'])
300
self.assertEqual(['c'], opts.hello)
302
def test_option_callback_list(self):
303
"""Test callbacks work for list options."""
305
def cb(option, name, value, parser):
306
# Note that the value is a reference so copy to keep it
307
cb_calls.append((option,name,value[:],parser))
308
options = [option.ListOption('hello', type=str, custom_callback=cb)]
309
opts, args = self.parse(options, ['--hello=world', '--hello=mars',
311
self.assertEqual(3, len(cb_calls))
312
opt,name,value,parser = cb_calls[0]
313
self.assertEqual('hello', name)
314
self.assertEqual(['world'], value)
315
opt,name,value,parser = cb_calls[1]
316
self.assertEqual('hello', name)
317
self.assertEqual(['world', 'mars'], value)
318
opt,name,value,parser = cb_calls[2]
319
self.assertEqual('hello', name)
320
self.assertEqual([], value)
322
def test_list_option_param_name(self):
323
"""Test list options can have their param_name set."""
324
options = [option.ListOption('hello', type=str, param_name='greeting')]
325
opts, args = self.parse(
326
options, ['--hello=world', '--hello=sailor'])
327
self.assertEqual(['world', 'sailor'], opts.greeting)
330
class TestOptionDefinitions(TestCase):
331
"""Tests for options in the Bazaar codebase."""
333
def get_builtin_command_options(self):
335
for cmd_name in sorted(commands.all_command_names()):
336
cmd = commands.get_cmd_object(cmd_name)
337
for opt_name, opt in sorted(cmd.options().items()):
338
g.append((cmd_name, opt))
341
def test_global_options_used(self):
342
# In the distant memory, options could only be declared globally. Now
343
# we prefer to declare them in the command, unless like -r they really
344
# are used very widely with the exact same meaning. So this checks
345
# for any that should be garbage collected.
346
g = dict(option.Option.OPTIONS.items())
349
for cmd_name in sorted(commands.all_command_names()):
350
cmd = commands.get_cmd_object(cmd_name)
351
for option_or_name in sorted(cmd.takes_options):
352
if not isinstance(option_or_name, basestring):
353
self.assertIsInstance(option_or_name, option.Option)
354
elif not option_or_name in g:
355
msgs.append("apparent reference to undefined "
356
"global option %r from %r"
357
% (option_or_name, cmd))
359
used_globals.setdefault(option_or_name, []).append(cmd_name)
360
unused_globals = set(g.keys()) - set(used_globals.keys())
361
# not enforced because there might be plugins that use these globals
362
## for option_name in sorted(unused_globals):
363
## msgs.append("unused global option %r" % option_name)
364
## for option_name, cmds in sorted(used_globals.items()):
365
## if len(cmds) <= 1:
366
## msgs.append("global option %r is only used by %r"
367
## % (option_name, cmds))
369
self.fail("problems with global option definitions:\n"
372
def test_option_grammar(self):
374
# Option help should be written in sentence form, and have a final
375
# period and be all on a single line, because the display code will
377
option_re = re.compile(r'^[A-Z][^\n]+\.$')
378
for scope, opt in self.get_builtin_command_options():
380
msgs.append('%-16s %-16s %s' %
381
((scope or 'GLOBAL'), opt.name, 'NO HELP'))
382
elif not option_re.match(opt.help):
383
msgs.append('%-16s %-16s %s' %
384
((scope or 'GLOBAL'), opt.name, opt.help))
386
self.fail("The following options don't match the style guide:\n"
389
def test_is_hidden(self):
390
registry = controldir.ControlDirFormatRegistry()
391
bzrdir.register_metadir(registry, 'hidden', 'HiddenFormat',
392
'hidden help text', hidden=True)
393
bzrdir.register_metadir(registry, 'visible', 'VisibleFormat',
394
'visible help text', hidden=False)
395
format = option.RegistryOption('format', '', registry, str)
396
self.assertTrue(format.is_hidden('hidden'))
397
self.assertFalse(format.is_hidden('visible'))
399
def test_short_name(self):
400
registry = controldir.ControlDirFormatRegistry()
401
opt = option.RegistryOption('format', help='', registry=registry)
402
self.assertEquals(None, opt.short_name())
403
opt = option.RegistryOption('format', short_name='F', help='',
405
self.assertEquals('F', opt.short_name())
407
def test_option_custom_help(self):
408
the_opt = option.Option.OPTIONS['help']
409
orig_help = the_opt.help[:]
410
my_opt = option.custom_help('help', 'suggest lottery numbers')
411
# Confirm that my_opt has my help and the original is unchanged
412
self.assertEqual('suggest lottery numbers', my_opt.help)
413
self.assertEqual(orig_help, the_opt.help)
416
class TestVerboseQuietLinkage(TestCase):
418
def check(self, parser, level, args):
419
option._verbosity_level = 0
420
opts, args = parser.parse_args(args)
421
self.assertEqual(level, option._verbosity_level)
423
def test_verbose_quiet_linkage(self):
424
parser = option.get_optparser(option.Option.STD_OPTIONS)
425
self.check(parser, 0, [])
426
self.check(parser, 1, ['-v'])
427
self.check(parser, 2, ['-v', '-v'])
428
self.check(parser, -1, ['-q'])
429
self.check(parser, -2, ['-qq'])
430
self.check(parser, -1, ['-v', '-v', '-q'])
431
self.check(parser, 2, ['-q', '-v', '-v'])
432
self.check(parser, 0, ['--no-verbose'])
433
self.check(parser, 0, ['-v', '-q', '--no-quiet'])
added
removed
bzrlib/tests/test_options.py
