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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25
from bzrlib.builtins import cmd_commit, cmd_log, cmd_status
26
from bzrlib.commands import Command, parse_args
27
from bzrlib.tests import TestCase
28
from bzrlib.repofmt import knitrepo
31
def parse(options, args):
32
parser = option.get_optparser(dict((o.name, o) for o in options))
33
return parser.parse_args(args)
36
class OptionTests(TestCase):
37
"""Command-line option tests"""
39
def test_parse_args(self):
41
eq = self.assertEquals
42
eq(parse_args(cmd_commit(), ['--help']),
43
([], {'fixes': [], 'help': True}))
44
eq(parse_args(cmd_commit(), ['--message=biter']),
45
([], {'fixes': [], 'message': 'biter'}))
47
def test_no_more_opts(self):
48
"""Terminated options"""
49
self.assertEquals(parse_args(cmd_commit(), ['--', '-file-with-dashes']),
50
(['-file-with-dashes'], {'fixes': []}))
52
def test_option_help(self):
53
"""Options have help strings."""
54
out, err = self.run_bzr_captured(['commit', '--help'])
55
self.assertContainsRe(out, r'--file(.|\n)*file containing commit'
57
self.assertContainsRe(out, r'-h.*--help')
59
def test_option_help_global(self):
60
"""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
def test_option_arg_help(self):
65
"""Help message shows option arguments."""
66
out, err = self.run_bzr_captured(['help', 'commit'])
67
self.assertEquals(err, '')
68
self.assertContainsRe(out, r'--file[ =]MSGFILE')
70
def test_unknown_short_opt(self):
71
out, err = self.run_bzr_captured(['help', '-r'], retcode=3)
72
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
def test_set_short_name(self):
81
o = option.Option('wiggle')
83
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
def test_allow_dash(self):
114
"""Test that we can pass a plain '-' as an argument."""
116
(['-'], {'fixes': []}), parse_args(cmd_commit(), ['-']))
118
def parse(self, options, args):
119
parser = option.get_optparser(dict((o.name, o) for o in options))
120
return parser.parse_args(args)
122
def test_conversion(self):
123
options = [option.Option('hello')]
124
opts, args = self.parse(options, ['--no-hello', '--hello'])
125
self.assertEqual(True, opts.hello)
126
opts, args = self.parse(options, [])
127
self.assertEqual(option.OptionParser.DEFAULT_VALUE, opts.hello)
128
opts, args = self.parse(options, ['--hello', '--no-hello'])
129
self.assertEqual(False, opts.hello)
130
options = [option.Option('number', type=int)]
131
opts, args = self.parse(options, ['--number', '6'])
132
self.assertEqual(6, opts.number)
133
self.assertRaises(errors.BzrCommandError, self.parse, options,
135
self.assertRaises(errors.BzrCommandError, self.parse, options,
138
def test_registry_conversion(self):
139
registry = bzrdir.BzrDirFormatRegistry()
140
registry.register_metadir('one', 'RepositoryFormat7', 'one help')
141
registry.register_metadir('two', 'RepositoryFormatKnit1', 'two help')
142
registry.register_metadir('hidden', 'RepositoryFormatKnit1',
143
'two help', hidden=True)
144
registry.set_default('one')
145
options = [option.RegistryOption('format', '', registry, str)]
146
opts, args = self.parse(options, ['--format', 'one'])
147
self.assertEqual({'format':'one'}, opts)
148
opts, args = self.parse(options, ['--format', 'two'])
149
self.assertEqual({'format':'two'}, opts)
150
self.assertRaises(errors.BadOptionValue, self.parse, options,
151
['--format', 'three'])
152
self.assertRaises(errors.BzrCommandError, self.parse, options,
154
options = [option.RegistryOption('format', '', registry, str,
155
value_switches=True)]
156
opts, args = self.parse(options, ['--two'])
157
self.assertEqual({'format':'two'}, opts)
158
opts, args = self.parse(options, ['--two', '--one'])
159
self.assertEqual({'format':'one'}, opts)
160
opts, args = self.parse(options, ['--two', '--one',
162
self.assertEqual({'format':'two'}, opts)
163
options = [option.RegistryOption('format', '', registry, str,
165
self.assertRaises(errors.BzrCommandError, self.parse, options,
168
def test_registry_converter(self):
169
options = [option.RegistryOption('format', '',
170
bzrdir.format_registry, bzrdir.format_registry.make_bzrdir)]
171
opts, args = self.parse(options, ['--format', 'knit'])
172
self.assertIsInstance(opts.format.repository_format,
173
knitrepo.RepositoryFormatKnit1)
175
def test_from_kwargs(self):
176
my_option = option.RegistryOption.from_kwargs('my-option',
177
help='test option', short='be short', be_long='go long')
178
self.assertEqual(['my-option'],
179
[x[0] for x in my_option.iter_switches()])
180
my_option = option.RegistryOption.from_kwargs('my-option',
181
help='test option', title="My option", short='be short',
182
be_long='go long', value_switches=True)
183
self.assertEqual(['my-option', 'be-long', 'short'],
184
[x[0] for x in my_option.iter_switches()])
187
registry = bzrdir.BzrDirFormatRegistry()
188
registry.register_metadir('one', 'RepositoryFormat7', 'one help')
189
registry.register_metadir('two',
190
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
193
registry.register_metadir('hidden', 'RepositoryFormat7', 'hidden help',
195
registry.set_default('one')
196
options = [option.RegistryOption('format', 'format help', registry,
197
str, value_switches=True, title='Formats')]
198
parser = option.get_optparser(dict((o.name, o) for o in options))
199
value = parser.format_option_help()
200
self.assertContainsRe(value, 'format.*format help')
201
self.assertContainsRe(value, 'one.*one help')
202
self.assertContainsRe(value, 'Formats:\n *--format')
203
self.assertNotContainsRe(value, 'hidden help')
205
def test_iter_switches(self):
206
opt = option.Option('hello', help='fg')
207
self.assertEqual(list(opt.iter_switches()),
208
[('hello', None, None, 'fg')])
209
opt = option.Option('hello', help='fg', type=int)
210
self.assertEqual(list(opt.iter_switches()),
211
[('hello', None, 'ARG', 'fg')])
212
opt = option.Option('hello', help='fg', type=int, argname='gar')
213
self.assertEqual(list(opt.iter_switches()),
214
[('hello', None, 'GAR', 'fg')])
215
registry = bzrdir.BzrDirFormatRegistry()
216
registry.register_metadir('one', 'RepositoryFormat7', 'one help')
217
registry.register_metadir('two',
218
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
221
registry.set_default('one')
222
opt = option.RegistryOption('format', 'format help', registry,
223
value_switches=False)
224
self.assertEqual(list(opt.iter_switches()),
225
[('format', None, 'ARG', 'format help')])
226
opt = option.RegistryOption('format', 'format help', registry,
228
self.assertEqual(list(opt.iter_switches()),
229
[('format', None, 'ARG', 'format help'),
230
('default', None, None, 'one help'),
231
('one', None, None, 'one help'),
232
('two', None, None, 'two help'),
236
class TestListOptions(TestCase):
237
"""Tests for ListOption, used to specify lists on the command-line."""
239
def parse(self, options, args):
240
parser = option.get_optparser(dict((o.name, o) for o in options))
241
return parser.parse_args(args)
243
def test_list_option(self):
244
options = [option.ListOption('hello', type=str)]
245
opts, args = self.parse(options, ['--hello=world', '--hello=sailor'])
246
self.assertEqual(['world', 'sailor'], opts.hello)
248
def test_list_option_no_arguments(self):
249
options = [option.ListOption('hello', type=str)]
250
opts, args = self.parse(options, [])
251
self.assertEqual([], opts.hello)
253
def test_list_option_with_int_type(self):
254
options = [option.ListOption('hello', type=int)]
255
opts, args = self.parse(options, ['--hello=2', '--hello=3'])
256
self.assertEqual([2, 3], opts.hello)
258
def test_list_option_with_int_type_can_be_reset(self):
259
options = [option.ListOption('hello', type=int)]
260
opts, args = self.parse(options, ['--hello=2', '--hello=3',
261
'--hello=-', '--hello=5'])
262
self.assertEqual([5], opts.hello)
264
def test_list_option_can_be_reset(self):
265
"""Passing an option of '-' to a list option should reset the list."""
266
options = [option.ListOption('hello', type=str)]
267
opts, args = self.parse(
268
options, ['--hello=a', '--hello=b', '--hello=-', '--hello=c'])
269
self.assertEqual(['c'], opts.hello)
added
removed
bzrlib/tests/test_options.py
