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
|
# 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
from bzrlib import (
builtins,
bzrdir,
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)*file containing commit'
' message')
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_get_short_name(self):
file_opt = option.Option.OPTIONS['file']
self.assertEquals(file_opt.short_name(), 'F')
force_opt = option.Option.OPTIONS['force']
self.assertEquals(force_opt.short_name(), None)
def test_set_short_name(self):
o = option.Option('wiggle')
o.set_short_name('w')
self.assertEqual(o.short_name(), 'w')
def test_old_short_names(self):
# test the deprecated method for getting and setting short option
# names
expected_warning = (
"access to SHORT_OPTIONS was deprecated in version 0.14."
" Set the short option name when constructing the Option.",
DeprecationWarning, 2)
_warnings = []
def capture_warning(message, category, stacklevel=None):
_warnings.append((message, category, stacklevel))
old_warning_method = symbol_versioning.warn
try:
# an example of the kind of thing plugins might want to do through
# the old interface - make a new option and then give it a short
# name.
symbol_versioning.set_warning_method(capture_warning)
example_opt = option.Option('example', help='example option')
option.Option.SHORT_OPTIONS['w'] = example_opt
self.assertEqual(example_opt.short_name(), 'w')
self.assertEqual([expected_warning], _warnings)
# now check that it can actually be parsed with the registered
# value
opts, args = parse([example_opt], ['-w', 'foo'])
self.assertEqual(opts.example, True)
self.assertEqual(args, ['foo'])
finally:
symbol_versioning.set_warning_method(old_warning_method)
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.assertEqual(option.OptionParser.DEFAULT_VALUE, 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_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()])
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'),
])
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)
|