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
30
def parse(options, args):
31
parser = option.get_optparser(dict((o.name, o) for o in options))
32
return parser.parse_args(args)
34
class OptionTests(TestCase):
35
"""Command-line option tests"""
37
def test_parse_args(self):
39
eq = self.assertEquals
40
eq(parse_args(cmd_commit(), ['--help']),
42
eq(parse_args(cmd_commit(), ['--message=biter']),
43
([], {'message': 'biter'}))
44
## eq(parse_args(cmd_log(), '-r 500'.split()),
45
## ([], {'revision': RevisionSpec_int(500)}))
47
def test_no_more_opts(self):
48
"""Terminated options"""
49
self.assertEquals(parse_args(cmd_commit(), ['--', '-file-with-dashes']),
50
(['-file-with-dashes'], {}))
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."""
115
self.assertEqual((['-'], {}), parse_args(cmd_commit(), ['-']))
117
def parse(self, options, args):
118
parser = option.get_optparser(dict((o.name, o) for o in options))
119
return parser.parse_args(args)
121
def test_conversion(self):
122
options = [option.Option('hello')]
123
opts, args = self.parse(options, ['--no-hello', '--hello'])
124
self.assertEqual(True, opts.hello)
125
opts, args = self.parse(options, [])
126
self.assertEqual(option.OptionParser.DEFAULT_VALUE, opts.hello)
127
opts, args = self.parse(options, ['--hello', '--no-hello'])
128
self.assertEqual(False, opts.hello)
129
options = [option.Option('number', type=int)]
130
opts, args = self.parse(options, ['--number', '6'])
131
self.assertEqual(6, opts.number)
132
self.assertRaises(errors.BzrCommandError, self.parse, options,
134
self.assertRaises(errors.BzrCommandError, self.parse, options,
137
def test_registry_conversion(self):
138
registry = bzrdir.BzrDirFormatRegistry()
139
registry.register_metadir('one', 'RepositoryFormat7', 'one help')
140
registry.register_metadir('two', 'RepositoryFormatKnit1', 'two help')
141
registry.register_metadir('hidden', 'RepositoryFormatKnit1',
142
'two help', hidden=True)
143
registry.set_default('one')
144
options = [option.RegistryOption('format', '', registry, str)]
145
opts, args = self.parse(options, ['--format', 'one'])
146
self.assertEqual({'format':'one'}, opts)
147
opts, args = self.parse(options, ['--format', 'two'])
148
self.assertEqual({'format':'two'}, opts)
149
self.assertRaises(errors.BadOptionValue, self.parse, options,
150
['--format', 'three'])
151
self.assertRaises(errors.BzrCommandError, self.parse, options,
153
options = [option.RegistryOption('format', '', registry, str,
154
value_switches=True)]
155
opts, args = self.parse(options, ['--two'])
156
self.assertEqual({'format':'two'}, opts)
157
opts, args = self.parse(options, ['--two', '--one'])
158
self.assertEqual({'format':'one'}, opts)
159
opts, args = self.parse(options, ['--two', '--one',
161
self.assertEqual({'format':'two'}, opts)
162
options = [option.RegistryOption('format', '', registry, str,
164
self.assertRaises(errors.BzrCommandError, self.parse, options,
167
def test_registry_converter(self):
168
options = [option.RegistryOption('format', '',
169
bzrdir.format_registry, bzrdir.format_registry.make_bzrdir)]
170
opts, args = self.parse(options, ['--format', 'knit'])
171
self.assertIsInstance(opts.format.repository_format,
172
knitrepo.RepositoryFormatKnit1)
174
def test_from_kwargs(self):
175
my_option = option.RegistryOption.from_kwargs('my-option',
176
help='test option', short='be short', be_long='go long')
177
self.assertEqual(['my-option'],
178
[x[0] for x in my_option.iter_switches()])
179
my_option = option.RegistryOption.from_kwargs('my-option',
180
help='test option', title="My option", short='be short',
181
be_long='go long', value_switches=True)
182
self.assertEqual(['my-option', 'be-long', 'short'],
183
[x[0] for x in my_option.iter_switches()])
186
registry = bzrdir.BzrDirFormatRegistry()
187
registry.register_metadir('one', 'RepositoryFormat7', 'one help')
188
registry.register_metadir('two',
189
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
192
registry.register_metadir('hidden', 'RepositoryFormat7', 'hidden help',
194
registry.set_default('one')
195
options = [option.RegistryOption('format', 'format help', registry,
196
str, value_switches=True, title='Formats')]
197
parser = option.get_optparser(dict((o.name, o) for o in options))
198
value = parser.format_option_help()
199
self.assertContainsRe(value, 'format.*format help')
200
self.assertContainsRe(value, 'one.*one help')
201
self.assertContainsRe(value, 'Formats:\n *--format')
202
self.assertNotContainsRe(value, 'hidden help')
204
def test_iter_switches(self):
205
opt = option.Option('hello', help='fg')
206
self.assertEqual(list(opt.iter_switches()),
207
[('hello', None, None, 'fg')])
208
opt = option.Option('hello', help='fg', type=int)
209
self.assertEqual(list(opt.iter_switches()),
210
[('hello', None, 'ARG', 'fg')])
211
opt = option.Option('hello', help='fg', type=int, argname='gar')
212
self.assertEqual(list(opt.iter_switches()),
213
[('hello', None, 'GAR', 'fg')])
214
registry = bzrdir.BzrDirFormatRegistry()
215
registry.register_metadir('one', 'RepositoryFormat7', 'one help')
216
registry.register_metadir('two',
217
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
220
registry.set_default('one')
221
opt = option.RegistryOption('format', 'format help', registry,
222
value_switches=False)
223
self.assertEqual(list(opt.iter_switches()),
224
[('format', None, 'ARG', 'format help')])
225
opt = option.RegistryOption('format', 'format help', registry,
227
self.assertEqual(list(opt.iter_switches()),
228
[('format', None, 'ARG', 'format help'),
229
('default', None, None, 'one help'),
230
('one', None, None, 'one help'),
231
('two', None, None, 'two help'),
234
# >>> parse_args('log -r 500'.split())
235
# (['log'], {'revision': [<RevisionSpec_int 500>]})
236
# >>> parse_args('log -r500..600'.split())
237
# (['log'], {'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
238
# >>> parse_args('log -vr500..600'.split())
239
# (['log'], {'verbose': True, 'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
240
# >>> parse_args('log -rrevno:500..600'.split()) #the r takes an argument
241
# (['log'], {'revision': [<RevisionSpec_revno revno:500>, <RevisionSpec_int 600>]})
added
removed
bzrlib/tests/test_options.py
