1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
|
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
import re
from bzrlib import (
builtins,
bzrdir,
commands,
errors,
option,
repository,
symbol_versioning,
)
from bzrlib.builtins import cmd_commit, cmd_log, cmd_status
from bzrlib.commands import Command, parse_args
from bzrlib.tests import TestCase
from bzrlib.repofmt import knitrepo
def parse(options, args):
parser = option.get_optparser(dict((o.name, o) for o in options))
return parser.parse_args(args)
class OptionTests(TestCase):
"""Command-line option tests"""
def test_parse_args(self):
"""Option parser"""
eq = self.assertEquals
eq(parse_args(cmd_commit(), ['--help']),
([], {'fixes': [], 'help': True}))
eq(parse_args(cmd_commit(), ['--message=biter']),
([], {'fixes': [], 'message': 'biter'}))
def test_no_more_opts(self):
"""Terminated options"""
self.assertEquals(parse_args(cmd_commit(), ['--', '-file-with-dashes']),
(['-file-with-dashes'], {'fixes': []}))
def test_option_help(self):
"""Options have help strings."""
out, err = self.run_bzr('commit --help')
self.assertContainsRe(out,
r'--file(.|\n)*Take commit message from this file\.')
self.assertContainsRe(out, r'-h.*--help')
def test_option_help_global(self):
"""Global options have help strings."""
out, err = self.run_bzr('help status')
self.assertContainsRe(out, r'--show-ids.*Show internal object.')
def test_option_arg_help(self):
"""Help message shows option arguments."""
out, err = self.run_bzr('help commit')
self.assertEquals(err, '')
self.assertContainsRe(out, r'--file[ =]MSGFILE')
def test_unknown_short_opt(self):
out, err = self.run_bzr('help -r', retcode=3)
self.assertContainsRe(err, r'no such option')
def test_set_short_name(self):
o = option.Option('wiggle')
o.set_short_name('w')
self.assertEqual(o.short_name(), 'w')
def test_allow_dash(self):
"""Test that we can pass a plain '-' as an argument."""
self.assertEqual(
(['-'], {'fixes': []}), parse_args(cmd_commit(), ['-']))
def parse(self, options, args):
parser = option.get_optparser(dict((o.name, o) for o in options))
return parser.parse_args(args)
def test_conversion(self):
options = [option.Option('hello')]
opts, args = self.parse(options, ['--no-hello', '--hello'])
self.assertEqual(True, opts.hello)
opts, args = self.parse(options, [])
self.assertFalse(hasattr(opts, 'hello'))
opts, args = self.parse(options, ['--hello', '--no-hello'])
self.assertEqual(False, opts.hello)
options = [option.Option('number', type=int)]
opts, args = self.parse(options, ['--number', '6'])
self.assertEqual(6, opts.number)
self.assertRaises(errors.BzrCommandError, self.parse, options,
['--number'])
self.assertRaises(errors.BzrCommandError, self.parse, options,
['--no-number'])
def test_registry_conversion(self):
registry = bzrdir.BzrDirFormatRegistry()
registry.register_metadir('one', 'RepositoryFormat7', 'one help')
registry.register_metadir('two', 'RepositoryFormatKnit1', 'two help')
registry.register_metadir('hidden', 'RepositoryFormatKnit1',
'two help', hidden=True)
registry.set_default('one')
options = [option.RegistryOption('format', '', registry, str)]
opts, args = self.parse(options, ['--format', 'one'])
self.assertEqual({'format':'one'}, opts)
opts, args = self.parse(options, ['--format', 'two'])
self.assertEqual({'format':'two'}, opts)
self.assertRaises(errors.BadOptionValue, self.parse, options,
['--format', 'three'])
self.assertRaises(errors.BzrCommandError, self.parse, options,
['--two'])
options = [option.RegistryOption('format', '', registry, str,
value_switches=True)]
opts, args = self.parse(options, ['--two'])
self.assertEqual({'format':'two'}, opts)
opts, args = self.parse(options, ['--two', '--one'])
self.assertEqual({'format':'one'}, opts)
opts, args = self.parse(options, ['--two', '--one',
'--format', 'two'])
self.assertEqual({'format':'two'}, opts)
options = [option.RegistryOption('format', '', registry, str,
enum_switch=False)]
self.assertRaises(errors.BzrCommandError, self.parse, options,
['--format', 'two'])
def test_override(self):
options = [option.Option('hello', type=str),
option.Option('hi', type=str, param_name='hello')]
opts, args = self.parse(options, ['--hello', 'a', '--hello', 'b'])
self.assertEqual('b', opts.hello)
opts, args = self.parse(options, ['--hello', 'b', '--hello', 'a'])
self.assertEqual('a', opts.hello)
opts, args = self.parse(options, ['--hello', 'a', '--hi', 'b'])
self.assertEqual('b', opts.hello)
opts, args = self.parse(options, ['--hi', 'b', '--hello', 'a'])
self.assertEqual('a', opts.hello)
def test_registry_converter(self):
options = [option.RegistryOption('format', '',
bzrdir.format_registry, bzrdir.format_registry.make_bzrdir)]
opts, args = self.parse(options, ['--format', 'knit'])
self.assertIsInstance(opts.format.repository_format,
knitrepo.RepositoryFormatKnit1)
def test_from_kwargs(self):
my_option = option.RegistryOption.from_kwargs('my-option',
help='test option', short='be short', be_long='go long')
self.assertEqual(['my-option'],
[x[0] for x in my_option.iter_switches()])
my_option = option.RegistryOption.from_kwargs('my-option',
help='test option', title="My option", short='be short',
be_long='go long', value_switches=True)
self.assertEqual(['my-option', 'be-long', 'short'],
[x[0] for x in my_option.iter_switches()])
self.assertEqual('test option', my_option.help)
def test_help(self):
registry = bzrdir.BzrDirFormatRegistry()
registry.register_metadir('one', 'RepositoryFormat7', 'one help')
registry.register_metadir('two',
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
'two help',
)
registry.register_metadir('hidden', 'RepositoryFormat7', 'hidden help',
hidden=True)
registry.set_default('one')
options = [option.RegistryOption('format', 'format help', registry,
str, value_switches=True, title='Formats')]
parser = option.get_optparser(dict((o.name, o) for o in options))
value = parser.format_option_help()
self.assertContainsRe(value, 'format.*format help')
self.assertContainsRe(value, 'one.*one help')
self.assertContainsRe(value, 'Formats:\n *--format')
self.assertNotContainsRe(value, 'hidden help')
def test_iter_switches(self):
opt = option.Option('hello', help='fg')
self.assertEqual(list(opt.iter_switches()),
[('hello', None, None, 'fg')])
opt = option.Option('hello', help='fg', type=int)
self.assertEqual(list(opt.iter_switches()),
[('hello', None, 'ARG', 'fg')])
opt = option.Option('hello', help='fg', type=int, argname='gar')
self.assertEqual(list(opt.iter_switches()),
[('hello', None, 'GAR', 'fg')])
registry = bzrdir.BzrDirFormatRegistry()
registry.register_metadir('one', 'RepositoryFormat7', 'one help')
registry.register_metadir('two',
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
'two help',
)
registry.set_default('one')
opt = option.RegistryOption('format', 'format help', registry,
value_switches=False)
self.assertEqual(list(opt.iter_switches()),
[('format', None, 'ARG', 'format help')])
opt = option.RegistryOption('format', 'format help', registry,
value_switches=True)
self.assertEqual(list(opt.iter_switches()),
[('format', None, 'ARG', 'format help'),
('default', None, None, 'one help'),
('one', None, None, 'one help'),
('two', None, None, 'two help'),
])
def test_option_callback_bool(self):
"Test booleans get True and False passed correctly to a callback."""
cb_calls = []
def cb(option, name, value, parser):
cb_calls.append((option,name,value,parser))
options = [option.Option('hello', custom_callback=cb)]
opts, args = self.parse(options, ['--hello', '--no-hello'])
self.assertEqual(2, len(cb_calls))
opt,name,value,parser = cb_calls[0]
self.assertEqual('hello', name)
self.assertTrue(value)
opt,name,value,parser = cb_calls[1]
self.assertEqual('hello', name)
self.assertFalse(value)
def test_option_callback_str(self):
"""Test callbacks work for string options both long and short."""
cb_calls = []
def cb(option, name, value, parser):
cb_calls.append((option,name,value,parser))
options = [option.Option('hello', type=str, custom_callback=cb,
short_name='h')]
opts, args = self.parse(options, ['--hello', 'world', '-h', 'mars'])
self.assertEqual(2, len(cb_calls))
opt,name,value,parser = cb_calls[0]
self.assertEqual('hello', name)
self.assertEqual('world', value)
opt,name,value,parser = cb_calls[1]
self.assertEqual('hello', name)
self.assertEqual('mars', value)
class TestListOptions(TestCase):
"""Tests for ListOption, used to specify lists on the command-line."""
def parse(self, options, args):
parser = option.get_optparser(dict((o.name, o) for o in options))
return parser.parse_args(args)
def test_list_option(self):
options = [option.ListOption('hello', type=str)]
opts, args = self.parse(options, ['--hello=world', '--hello=sailor'])
self.assertEqual(['world', 'sailor'], opts.hello)
def test_list_option_no_arguments(self):
options = [option.ListOption('hello', type=str)]
opts, args = self.parse(options, [])
self.assertEqual([], opts.hello)
def test_list_option_with_int_type(self):
options = [option.ListOption('hello', type=int)]
opts, args = self.parse(options, ['--hello=2', '--hello=3'])
self.assertEqual([2, 3], opts.hello)
def test_list_option_with_int_type_can_be_reset(self):
options = [option.ListOption('hello', type=int)]
opts, args = self.parse(options, ['--hello=2', '--hello=3',
'--hello=-', '--hello=5'])
self.assertEqual([5], opts.hello)
def test_list_option_can_be_reset(self):
"""Passing an option of '-' to a list option should reset the list."""
options = [option.ListOption('hello', type=str)]
opts, args = self.parse(
options, ['--hello=a', '--hello=b', '--hello=-', '--hello=c'])
self.assertEqual(['c'], opts.hello)
def test_option_callback_list(self):
"""Test callbacks work for list options."""
cb_calls = []
def cb(option, name, value, parser):
# Note that the value is a reference so copy to keep it
cb_calls.append((option,name,value[:],parser))
options = [option.ListOption('hello', type=str, custom_callback=cb)]
opts, args = self.parse(options, ['--hello=world', '--hello=mars',
'--hello=-'])
self.assertEqual(3, len(cb_calls))
opt,name,value,parser = cb_calls[0]
self.assertEqual('hello', name)
self.assertEqual(['world'], value)
opt,name,value,parser = cb_calls[1]
self.assertEqual('hello', name)
self.assertEqual(['world', 'mars'], value)
opt,name,value,parser = cb_calls[2]
self.assertEqual('hello', name)
self.assertEqual([], value)
class TestOptionDefinitions(TestCase):
"""Tests for options in the Bazaar codebase."""
def get_builtin_command_options(self):
g = []
for cmd_name, cmd_class in sorted(commands.get_all_cmds()):
cmd = cmd_class()
for opt_name, opt in sorted(cmd.options().items()):
g.append((cmd_name, opt))
return g
def test_global_options_used(self):
# In the distant memory, options could only be declared globally. Now
# we prefer to declare them in the command, unless like -r they really
# are used very widely with the exact same meaning. So this checks
# for any that should be garbage collected.
g = dict(option.Option.OPTIONS.items())
used_globals = {}
msgs = []
for cmd_name, cmd_class in sorted(commands.get_all_cmds()):
for option_or_name in sorted(cmd_class.takes_options):
if not isinstance(option_or_name, basestring):
self.assertIsInstance(option_or_name, option.Option)
elif not option_or_name in g:
msgs.append("apparent reference to undefined "
"global option %r from %r"
% (option_or_name, cmd_class))
else:
used_globals.setdefault(option_or_name, []).append(cmd_name)
unused_globals = set(g.keys()) - set(used_globals.keys())
# not enforced because there might be plugins that use these globals
## for option_name in sorted(unused_globals):
## msgs.append("unused global option %r" % option_name)
## for option_name, cmds in sorted(used_globals.items()):
## if len(cmds) <= 1:
## msgs.append("global option %r is only used by %r"
## % (option_name, cmds))
if msgs:
self.fail("problems with global option definitions:\n"
+ '\n'.join(msgs))
def test_option_grammar(self):
msgs = []
# Option help should be written in sentence form, and have a final
# period and be all on a single line, because the display code will
# wrap it.
option_re = re.compile(r'^[A-Z][^\n]+\.$')
for scope, option in self.get_builtin_command_options():
if not option.help:
msgs.append('%-16s %-16s %s' %
((scope or 'GLOBAL'), option.name, 'NO HELP'))
elif not option_re.match(option.help):
msgs.append('%-16s %-16s %s' %
((scope or 'GLOBAL'), option.name, option.help))
if msgs:
self.fail("The following options don't match the style guide:\n"
+ '\n'.join(msgs))
def test_is_hidden(self):
registry = bzrdir.BzrDirFormatRegistry()
registry.register_metadir('hidden', 'HiddenFormat',
'hidden help text', hidden=True)
registry.register_metadir('visible', 'VisibleFormat',
'visible help text', hidden=False)
format = option.RegistryOption('format', '', registry, str)
self.assertTrue(format.is_hidden('hidden'))
self.assertFalse(format.is_hidden('visible'))
def test_option_custom_help(self):
the_opt = option.Option.OPTIONS['help']
orig_help = the_opt.help[:]
my_opt = option.custom_help('help', 'suggest lottery numbers')
# Confirm that my_opt has my help and the original is unchanged
self.assertEqual('suggest lottery numbers', my_opt.help)
self.assertEqual(orig_help, the_opt.help)
class TestVerboseQuietLinkage(TestCase):
def check(self, parser, level, args):
option._verbosity_level = 0
opts, args = parser.parse_args(args)
self.assertEqual(level, option._verbosity_level)
def test_verbose_quiet_linkage(self):
parser = option.get_optparser(option.Option.STD_OPTIONS)
self.check(parser, 0, [])
self.check(parser, 1, ['-v'])
self.check(parser, 2, ['-v', '-v'])
self.check(parser, -1, ['-q'])
self.check(parser, -2, ['-qq'])
self.check(parser, -1, ['-v', '-v', '-q'])
self.check(parser, 2, ['-q', '-v', '-v'])
self.check(parser, 0, ['--no-verbose'])
self.check(parser, 0, ['-v', '-q', '--no-quiet'])
|