1
# Copyright (C) 2005, 2006 Canonical Ltd
1
# Copyright (C) 2005-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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
27
from bzrlib.builtins import cmd_commit
28
from bzrlib.commands import parse_args
3
29
from bzrlib.tests import TestCase
4
from bzrlib.commands import Command, parse_args
5
from bzrlib.builtins import cmd_commit, cmd_log, cmd_status
7
# TODO: might be nice to just parse them into a structured form and test
8
# against that, rather than running the whole command.
30
from bzrlib.repofmt import knitrepo
33
def parse(options, args):
34
parser = option.get_optparser(dict((o.name, o) for o in options))
35
return parser.parse_args(args)
10
38
class OptionTests(TestCase):
11
39
"""Command-line option tests"""
13
41
def test_parse_args(self):
14
42
"""Option parser"""
15
eq = self.assertEquals
16
eq(parse_args(cmd_commit(), ['--help']),
18
eq(parse_args(cmd_status(), ['--all']),
20
eq(parse_args(cmd_commit(), ['--message=biter']),
21
([], {'message': 'biter'}))
22
## eq(parse_args(cmd_log(), '-r 500'.split()),
23
## ([], {'revision': RevisionSpec_int(500)}))
43
# XXX: Using cmd_commit makes these tests overly sensitive to changes
44
# to cmd_commit, when they are meant to be about option parsing in
46
self.assertEqual(parse_args(cmd_commit(), ['--help']),
47
([], {'author': [], 'exclude': [], 'fixes': [], 'help': True}))
48
self.assertEqual(parse_args(cmd_commit(), ['--message=biter']),
49
([], {'author': [], 'exclude': [], 'fixes': [], 'message': 'biter'}))
25
51
def test_no_more_opts(self):
26
52
"""Terminated options"""
27
self.assertEquals(parse_args(cmd_commit(), ['--', '-file-with-dashes']),
28
(['-file-with-dashes'], {}))
53
self.assertEqual(parse_args(cmd_commit(), ['--', '-file-with-dashes']),
54
(['-file-with-dashes'], {'author': [], 'exclude': [], 'fixes': []}))
30
56
def test_option_help(self):
31
57
"""Options have help strings."""
32
out, err = self.run_bzr_captured(['commit', '--help'])
33
self.assertContainsRe(out, r'--file.*file containing commit message')
34
self.assertContainsRe(out, r'--help.*-h')
58
out, err = self.run_bzr('commit --help')
59
self.assertContainsRe(out,
60
r'--file(.|\n)*Take commit message from this file\.')
61
self.assertContainsRe(out, r'-h.*--help')
36
63
def test_option_help_global(self):
37
64
"""Global options have help strings."""
38
out, err = self.run_bzr_captured(['help', 'status'])
39
self.assertContainsRe(out, r'--show-ids.*show internal object')
65
out, err = self.run_bzr('help status')
66
self.assertContainsRe(out, r'--show-ids.*Show internal object.')
41
68
def test_option_arg_help(self):
42
69
"""Help message shows option arguments."""
43
out, err = self.run_bzr_captured(['help', 'commit'])
44
self.assertEquals(err, '')
70
out, err = self.run_bzr('help commit')
71
self.assertEqual(err, '')
45
72
self.assertContainsRe(out, r'--file[ =]MSGFILE')
47
74
def test_unknown_short_opt(self):
48
out, err = self.run_bzr_captured(['help', '-r'], retcode=3)
49
self.assertContainsRe(err, r'unknown short option')
52
# >>> parse_args('log -r 500'.split())
53
# (['log'], {'revision': [<RevisionSpec_int 500>]})
54
# >>> parse_args('log -r500..600'.split())
55
# (['log'], {'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
56
# >>> parse_args('log -vr500..600'.split())
57
# (['log'], {'verbose': True, 'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
58
# >>> parse_args('log -rrevno:500..600'.split()) #the r takes an argument
59
# (['log'], {'revision': [<RevisionSpec_revno revno:500>, <RevisionSpec_int 600>]})
75
out, err = self.run_bzr('help -r', retcode=3)
76
self.assertContainsRe(err, r'no such option')
78
def test_set_short_name(self):
79
o = option.Option('wiggle')
81
self.assertEqual(o.short_name(), 'w')
83
def test_allow_dash(self):
84
"""Test that we can pass a plain '-' as an argument."""
85
self.assertEqual((['-']), parse_args(cmd_commit(), ['-'])[0])
87
def parse(self, options, args):
88
parser = option.get_optparser(dict((o.name, o) for o in options))
89
return parser.parse_args(args)
91
def test_conversion(self):
92
options = [option.Option('hello')]
93
opts, args = self.parse(options, ['--no-hello', '--hello'])
94
self.assertEqual(True, opts.hello)
95
opts, args = self.parse(options, [])
96
self.assertFalse(hasattr(opts, 'hello'))
97
opts, args = self.parse(options, ['--hello', '--no-hello'])
98
self.assertEqual(False, opts.hello)
99
options = [option.Option('number', type=int)]
100
opts, args = self.parse(options, ['--number', '6'])
101
self.assertEqual(6, opts.number)
102
self.assertRaises(errors.BzrCommandError, self.parse, options,
104
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
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',
116
'two help', hidden=True)
117
registry.set_default('one')
118
options = [option.RegistryOption('format', '', registry, str)]
119
opts, args = self.parse(options, ['--format', 'one'])
120
self.assertEqual({'format':'one'}, opts)
121
opts, args = self.parse(options, ['--format', 'two'])
122
self.assertEqual({'format':'two'}, opts)
123
self.assertRaises(errors.BadOptionValue, self.parse, options,
124
['--format', 'three'])
125
self.assertRaises(errors.BzrCommandError, self.parse, options,
127
options = [option.RegistryOption('format', '', registry, str,
128
value_switches=True)]
129
opts, args = self.parse(options, ['--two'])
130
self.assertEqual({'format':'two'}, opts)
131
opts, args = self.parse(options, ['--two', '--one'])
132
self.assertEqual({'format':'one'}, opts)
133
opts, args = self.parse(options, ['--two', '--one',
135
self.assertEqual({'format':'two'}, opts)
136
options = [option.RegistryOption('format', '', registry, str,
138
self.assertRaises(errors.BzrCommandError, self.parse, options,
141
def test_override(self):
142
options = [option.Option('hello', type=str),
143
option.Option('hi', type=str, param_name='hello')]
144
opts, args = self.parse(options, ['--hello', 'a', '--hello', 'b'])
145
self.assertEqual('b', opts.hello)
146
opts, args = self.parse(options, ['--hello', 'b', '--hello', 'a'])
147
self.assertEqual('a', opts.hello)
148
opts, args = self.parse(options, ['--hello', 'a', '--hi', 'b'])
149
self.assertEqual('b', opts.hello)
150
opts, args = self.parse(options, ['--hi', 'b', '--hello', 'a'])
151
self.assertEqual('a', opts.hello)
153
def test_registry_converter(self):
154
options = [option.RegistryOption('format', '',
155
bzrdir.format_registry, bzrdir.format_registry.make_bzrdir)]
156
opts, args = self.parse(options, ['--format', 'knit'])
157
self.assertIsInstance(opts.format.repository_format,
158
knitrepo.RepositoryFormatKnit1)
160
def test_lazy_registry(self):
161
options = [option.RegistryOption('format', '',
162
lazy_registry=('bzrlib.bzrdir','format_registry'),
164
opts, args = self.parse(options, ['--format', 'knit'])
165
self.assertEqual({'format': 'knit'}, opts)
167
errors.BadOptionValue, self.parse, options, ['--format', 'BAD'])
169
def test_from_kwargs(self):
170
my_option = option.RegistryOption.from_kwargs('my-option',
171
help='test option', short='be short', be_long='go long')
172
self.assertEqual(['my-option'],
173
[x[0] for x in my_option.iter_switches()])
174
my_option = option.RegistryOption.from_kwargs('my-option',
175
help='test option', title="My option", short='be short',
176
be_long='go long', value_switches=True)
177
self.assertEqual(['my-option', 'be-long', 'short'],
178
[x[0] for x in my_option.iter_switches()])
179
self.assertEqual('test option', my_option.help)
182
registry = controldir.ControlDirFormatRegistry()
183
bzrdir.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
184
bzrdir.register_metadir(registry, 'two',
185
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
188
bzrdir.register_metadir(registry, 'hidden', 'RepositoryFormat7', 'hidden help',
190
registry.set_default('one')
191
options = [option.RegistryOption('format', 'format help', registry,
192
str, value_switches=True, title='Formats')]
193
parser = option.get_optparser(dict((o.name, o) for o in options))
194
value = parser.format_option_help()
195
self.assertContainsRe(value, 'format.*format help')
196
self.assertContainsRe(value, 'one.*one help')
197
self.assertContainsRe(value, 'Formats:\n *--format')
198
self.assertNotContainsRe(value, 'hidden help')
200
def test_iter_switches(self):
201
opt = option.Option('hello', help='fg')
202
self.assertEqual(list(opt.iter_switches()),
203
[('hello', None, None, 'fg')])
204
opt = option.Option('hello', help='fg', type=int)
205
self.assertEqual(list(opt.iter_switches()),
206
[('hello', None, 'ARG', 'fg')])
207
opt = option.Option('hello', help='fg', type=int, argname='gar')
208
self.assertEqual(list(opt.iter_switches()),
209
[('hello', None, 'GAR', 'fg')])
210
registry = controldir.ControlDirFormatRegistry()
211
bzrdir.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
212
bzrdir.register_metadir(registry, 'two',
213
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
216
registry.set_default('one')
217
opt = option.RegistryOption('format', 'format help', registry,
218
value_switches=False)
219
self.assertEqual(list(opt.iter_switches()),
220
[('format', None, 'ARG', 'format help')])
221
opt = option.RegistryOption('format', 'format help', registry,
223
self.assertEqual(list(opt.iter_switches()),
224
[('format', None, 'ARG', 'format help'),
225
('default', None, None, 'one help'),
226
('one', None, None, 'one help'),
227
('two', None, None, 'two help'),
230
def test_option_callback_bool(self):
231
"Test booleans get True and False passed correctly to a callback."""
233
def cb(option, name, value, parser):
234
cb_calls.append((option,name,value,parser))
235
options = [option.Option('hello', custom_callback=cb)]
236
opts, args = self.parse(options, ['--hello', '--no-hello'])
237
self.assertEqual(2, len(cb_calls))
238
opt,name,value,parser = cb_calls[0]
239
self.assertEqual('hello', name)
240
self.assertTrue(value)
241
opt,name,value,parser = cb_calls[1]
242
self.assertEqual('hello', name)
243
self.assertFalse(value)
245
def test_option_callback_str(self):
246
"""Test callbacks work for string options both long and short."""
248
def cb(option, name, value, parser):
249
cb_calls.append((option,name,value,parser))
250
options = [option.Option('hello', type=str, custom_callback=cb,
252
opts, args = self.parse(options, ['--hello', 'world', '-h', 'mars'])
253
self.assertEqual(2, len(cb_calls))
254
opt,name,value,parser = cb_calls[0]
255
self.assertEqual('hello', name)
256
self.assertEqual('world', value)
257
opt,name,value,parser = cb_calls[1]
258
self.assertEqual('hello', name)
259
self.assertEqual('mars', value)
262
class TestListOptions(TestCase):
263
"""Tests for ListOption, used to specify lists on the command-line."""
265
def parse(self, options, args):
266
parser = option.get_optparser(dict((o.name, o) for o in options))
267
return parser.parse_args(args)
269
def test_list_option(self):
270
options = [option.ListOption('hello', type=str)]
271
opts, args = self.parse(options, ['--hello=world', '--hello=sailor'])
272
self.assertEqual(['world', 'sailor'], opts.hello)
274
def test_list_option_with_dash(self):
275
options = [option.ListOption('with-dash', type=str)]
276
opts, args = self.parse(options, ['--with-dash=world',
277
'--with-dash=sailor'])
278
self.assertEqual(['world', 'sailor'], opts.with_dash)
280
def test_list_option_no_arguments(self):
281
options = [option.ListOption('hello', type=str)]
282
opts, args = self.parse(options, [])
283
self.assertEqual([], opts.hello)
285
def test_list_option_with_int_type(self):
286
options = [option.ListOption('hello', type=int)]
287
opts, args = self.parse(options, ['--hello=2', '--hello=3'])
288
self.assertEqual([2, 3], opts.hello)
290
def test_list_option_with_int_type_can_be_reset(self):
291
options = [option.ListOption('hello', type=int)]
292
opts, args = self.parse(options, ['--hello=2', '--hello=3',
293
'--hello=-', '--hello=5'])
294
self.assertEqual([5], opts.hello)
296
def test_list_option_can_be_reset(self):
297
"""Passing an option of '-' to a list option should reset the list."""
298
options = [option.ListOption('hello', type=str)]
299
opts, args = self.parse(
300
options, ['--hello=a', '--hello=b', '--hello=-', '--hello=c'])
301
self.assertEqual(['c'], opts.hello)
303
def test_option_callback_list(self):
304
"""Test callbacks work for list options."""
306
def cb(option, name, value, parser):
307
# Note that the value is a reference so copy to keep it
308
cb_calls.append((option,name,value[:],parser))
309
options = [option.ListOption('hello', type=str, custom_callback=cb)]
310
opts, args = self.parse(options, ['--hello=world', '--hello=mars',
312
self.assertEqual(3, len(cb_calls))
313
opt,name,value,parser = cb_calls[0]
314
self.assertEqual('hello', name)
315
self.assertEqual(['world'], value)
316
opt,name,value,parser = cb_calls[1]
317
self.assertEqual('hello', name)
318
self.assertEqual(['world', 'mars'], value)
319
opt,name,value,parser = cb_calls[2]
320
self.assertEqual('hello', name)
321
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
class TestOptionDefinitions(TestCase):
332
"""Tests for options in the Bazaar codebase."""
334
def get_builtin_command_options(self):
336
for cmd_name in sorted(commands.all_command_names()):
337
cmd = commands.get_cmd_object(cmd_name)
338
for opt_name, opt in sorted(cmd.options().items()):
339
g.append((cmd_name, opt))
342
def test_global_options_used(self):
343
# In the distant memory, options could only be declared globally. Now
344
# we prefer to declare them in the command, unless like -r they really
345
# are used very widely with the exact same meaning. So this checks
346
# for any that should be garbage collected.
347
g = dict(option.Option.OPTIONS.items())
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):
353
if not isinstance(option_or_name, basestring):
354
self.assertIsInstance(option_or_name, option.Option)
355
elif not option_or_name in g:
356
msgs.append("apparent reference to undefined "
357
"global option %r from %r"
358
% (option_or_name, cmd))
360
used_globals.setdefault(option_or_name, []).append(cmd_name)
361
unused_globals = set(g.keys()) - set(used_globals.keys())
362
# not enforced because there might be plugins that use these globals
363
## for option_name in sorted(unused_globals):
364
## msgs.append("unused global option %r" % option_name)
365
## for option_name, cmds in sorted(used_globals.items()):
366
## if len(cmds) <= 1:
367
## msgs.append("global option %r is only used by %r"
368
## % (option_name, cmds))
370
self.fail("problems with global option definitions:\n"
373
def test_option_grammar(self):
375
# Option help should be written in sentence form, and have a final
376
# period and be all on a single line, because the display code will
378
option_re = re.compile(r'^[A-Z][^\n]+\.$')
379
for scope, opt in self.get_builtin_command_options():
381
msgs.append('%-16s %-16s %s' %
382
((scope or 'GLOBAL'), opt.name, 'NO HELP'))
383
elif not option_re.match(opt.help):
384
msgs.append('%-16s %-16s %s' %
385
((scope or 'GLOBAL'), opt.name, opt.help))
387
self.fail("The following options don't match the style guide:\n"
390
def test_is_hidden(self):
391
registry = controldir.ControlDirFormatRegistry()
392
bzrdir.register_metadir(registry, 'hidden', 'HiddenFormat',
393
'hidden help text', hidden=True)
394
bzrdir.register_metadir(registry, 'visible', 'VisibleFormat',
395
'visible help text', hidden=False)
396
format = option.RegistryOption('format', '', registry, str)
397
self.assertTrue(format.is_hidden('hidden'))
398
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
def test_option_custom_help(self):
409
the_opt = option.Option.OPTIONS['help']
410
orig_help = the_opt.help[:]
411
my_opt = option.custom_help('help', 'suggest lottery numbers')
412
# Confirm that my_opt has my help and the original is unchanged
413
self.assertEqual('suggest lottery numbers', my_opt.help)
414
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
class TestVerboseQuietLinkage(TestCase):
430
def check(self, parser, level, args):
431
option._verbosity_level = 0
432
opts, args = parser.parse_args(args)
433
self.assertEqual(level, option._verbosity_level)
435
def test_verbose_quiet_linkage(self):
436
parser = option.get_optparser(option.Option.STD_OPTIONS)
437
self.check(parser, 0, [])
438
self.check(parser, 1, ['-v'])
439
self.check(parser, 2, ['-v', '-v'])
440
self.check(parser, -1, ['-q'])
441
self.check(parser, -2, ['-qq'])
442
self.check(parser, -1, ['-v', '-v', '-q'])
443
self.check(parser, 2, ['-q', '-v', '-v'])
444
self.check(parser, 0, ['--no-verbose'])
445
self.check(parser, 0, ['-v', '-q', '--no-quiet'])
added
removed
bzrlib/tests/test_options.py
