1
# Copyright (C) 2005, 2006, 2007 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
26
from bzrlib.builtins import cmd_commit
27
from bzrlib.commands import Command, parse_args
28
from bzrlib.tests import TestCase
29
from bzrlib.repofmt import knitrepo
32
def parse(options, args):
33
parser = option.get_optparser(dict((o.name, o) for o in options))
34
return parser.parse_args(args)
37
class OptionTests(TestCase):
38
"""Command-line option tests"""
40
def test_parse_args(self):
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'}))
50
def test_no_more_opts(self):
51
"""Terminated options"""
52
self.assertEqual(parse_args(cmd_commit(), ['--', '-file-with-dashes']),
53
(['-file-with-dashes'], {'author': [], 'exclude': [], 'fixes': []}))
55
def test_option_help(self):
56
"""Options have help strings."""
57
out, err = self.run_bzr('commit --help')
58
self.assertContainsRe(out,
59
r'--file(.|\n)*Take commit message from this file\.')
60
self.assertContainsRe(out, r'-h.*--help')
62
def test_option_help_global(self):
63
"""Global options have help strings."""
64
out, err = self.run_bzr('help status')
65
self.assertContainsRe(out, r'--show-ids.*Show internal object.')
67
def test_option_arg_help(self):
68
"""Help message shows option arguments."""
69
out, err = self.run_bzr('help commit')
70
self.assertEqual(err, '')
71
self.assertContainsRe(out, r'--file[ =]MSGFILE')
73
def test_unknown_short_opt(self):
74
out, err = self.run_bzr('help -r', retcode=3)
75
self.assertContainsRe(err, r'no such option')
77
def test_set_short_name(self):
78
o = option.Option('wiggle')
80
self.assertEqual(o.short_name(), 'w')
82
def test_allow_dash(self):
83
"""Test that we can pass a plain '-' as an argument."""
84
self.assertEqual((['-']), parse_args(cmd_commit(), ['-'])[0])
86
def parse(self, options, args):
87
parser = option.get_optparser(dict((o.name, o) for o in options))
88
return parser.parse_args(args)
90
def test_conversion(self):
91
options = [option.Option('hello')]
92
opts, args = self.parse(options, ['--no-hello', '--hello'])
93
self.assertEqual(True, opts.hello)
94
opts, args = self.parse(options, [])
95
self.assertFalse(hasattr(opts, 'hello'))
96
opts, args = self.parse(options, ['--hello', '--no-hello'])
97
self.assertEqual(False, opts.hello)
98
options = [option.Option('number', type=int)]
99
opts, args = self.parse(options, ['--number', '6'])
100
self.assertEqual(6, opts.number)
101
self.assertRaises(errors.BzrCommandError, self.parse, options,
103
self.assertRaises(errors.BzrCommandError, self.parse, options,
106
def test_is_hidden(self):
107
self.assertTrue(option.Option('foo', hidden=True).is_hidden('foo'))
108
self.assertFalse(option.Option('foo', hidden=False).is_hidden('foo'))
110
def test_registry_conversion(self):
111
registry = controldir.ControlDirFormatRegistry()
112
bzrdir.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
113
bzrdir.register_metadir(registry, 'two', 'RepositoryFormatKnit1', 'two help')
114
bzrdir.register_metadir(registry, 'hidden', 'RepositoryFormatKnit1',
115
'two help', hidden=True)
116
registry.set_default('one')
117
options = [option.RegistryOption('format', '', registry, str)]
118
opts, args = self.parse(options, ['--format', 'one'])
119
self.assertEqual({'format':'one'}, opts)
120
opts, args = self.parse(options, ['--format', 'two'])
121
self.assertEqual({'format':'two'}, opts)
122
self.assertRaises(errors.BadOptionValue, self.parse, options,
123
['--format', 'three'])
124
self.assertRaises(errors.BzrCommandError, self.parse, options,
126
options = [option.RegistryOption('format', '', registry, str,
127
value_switches=True)]
128
opts, args = self.parse(options, ['--two'])
129
self.assertEqual({'format':'two'}, opts)
130
opts, args = self.parse(options, ['--two', '--one'])
131
self.assertEqual({'format':'one'}, opts)
132
opts, args = self.parse(options, ['--two', '--one',
134
self.assertEqual({'format':'two'}, opts)
135
options = [option.RegistryOption('format', '', registry, str,
137
self.assertRaises(errors.BzrCommandError, self.parse, options,
140
def test_override(self):
141
options = [option.Option('hello', type=str),
142
option.Option('hi', type=str, param_name='hello')]
143
opts, args = self.parse(options, ['--hello', 'a', '--hello', 'b'])
144
self.assertEqual('b', opts.hello)
145
opts, args = self.parse(options, ['--hello', 'b', '--hello', 'a'])
146
self.assertEqual('a', opts.hello)
147
opts, args = self.parse(options, ['--hello', 'a', '--hi', 'b'])
148
self.assertEqual('b', opts.hello)
149
opts, args = self.parse(options, ['--hi', 'b', '--hello', 'a'])
150
self.assertEqual('a', opts.hello)
152
def test_registry_converter(self):
153
options = [option.RegistryOption('format', '',
154
bzrdir.format_registry, bzrdir.format_registry.make_bzrdir)]
155
opts, args = self.parse(options, ['--format', 'knit'])
156
self.assertIsInstance(opts.format.repository_format,
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)
181
registry = controldir.ControlDirFormatRegistry()
182
bzrdir.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
183
bzrdir.register_metadir(registry, 'two',
184
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
187
bzrdir.register_metadir(registry, 'hidden', 'RepositoryFormat7', 'hidden help',
189
registry.set_default('one')
190
options = [option.RegistryOption('format', 'format help', registry,
191
str, value_switches=True, title='Formats')]
192
parser = option.get_optparser(dict((o.name, o) for o in options))
193
value = parser.format_option_help()
194
self.assertContainsRe(value, 'format.*format help')
195
self.assertContainsRe(value, 'one.*one help')
196
self.assertContainsRe(value, 'Formats:\n *--format')
197
self.assertNotContainsRe(value, 'hidden help')
199
def test_iter_switches(self):
200
opt = option.Option('hello', help='fg')
201
self.assertEqual(list(opt.iter_switches()),
202
[('hello', None, None, 'fg')])
203
opt = option.Option('hello', help='fg', type=int)
204
self.assertEqual(list(opt.iter_switches()),
205
[('hello', None, 'ARG', 'fg')])
206
opt = option.Option('hello', help='fg', type=int, argname='gar')
207
self.assertEqual(list(opt.iter_switches()),
208
[('hello', None, 'GAR', 'fg')])
209
registry = controldir.ControlDirFormatRegistry()
210
bzrdir.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
211
bzrdir.register_metadir(registry, 'two',
212
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
215
registry.set_default('one')
216
opt = option.RegistryOption('format', 'format help', registry,
217
value_switches=False)
218
self.assertEqual(list(opt.iter_switches()),
219
[('format', None, 'ARG', 'format help')])
220
opt = option.RegistryOption('format', 'format help', registry,
222
self.assertEqual(list(opt.iter_switches()),
223
[('format', None, 'ARG', 'format help'),
224
('default', None, None, 'one help'),
225
('one', None, None, 'one help'),
226
('two', None, None, 'two help'),
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_option_custom_help(self):
400
the_opt = option.Option.OPTIONS['help']
401
orig_help = the_opt.help[:]
402
my_opt = option.custom_help('help', 'suggest lottery numbers')
403
# Confirm that my_opt has my help and the original is unchanged
404
self.assertEqual('suggest lottery numbers', my_opt.help)
405
self.assertEqual(orig_help, the_opt.help)
408
class TestVerboseQuietLinkage(TestCase):
410
def check(self, parser, level, args):
411
option._verbosity_level = 0
412
opts, args = parser.parse_args(args)
413
self.assertEqual(level, option._verbosity_level)
415
def test_verbose_quiet_linkage(self):
416
parser = option.get_optparser(option.Option.STD_OPTIONS)
417
self.check(parser, 0, [])
418
self.check(parser, 1, ['-v'])
419
self.check(parser, 2, ['-v', '-v'])
420
self.check(parser, -1, ['-q'])
421
self.check(parser, -2, ['-qq'])
422
self.check(parser, -1, ['-v', '-v', '-q'])
423
self.check(parser, 2, ['-q', '-v', '-v'])
424
self.check(parser, 0, ['--no-verbose'])
425
self.check(parser, 0, ['-v', '-q', '--no-quiet'])
added
removed
bzrlib/tests/test_options.py
