← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_options.py

Merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_options.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
2
16
 
 
17
from bzrlib import (
 
18
    builtins,
 
19
    bzrdir,
 
20
    errors,
 
21
    option,
 
22
    repository,
 
23
    symbol_versioning,
 
24
    )
 
25
from bzrlib.builtins import cmd_commit, cmd_log, cmd_status
 
26
from bzrlib.commands import Command, parse_args
3
27
from bzrlib.tests import TestCase
4
 
from bzrlib.commands import Command, parse_args
5
 
from bzrlib.builtins import cmd_commit, cmd_log, cmd_status
 
28
from bzrlib.repofmt import knitrepo
6
29
 
7
 
# TODO: might be nice to just parse them into a structured form and test
8
 
# against that, rather than running the whole command.
 
30
def parse(options, args):
 
31
    parser = option.get_optparser(dict((o.name, o) for o in options))
 
32
    return parser.parse_args(args)
9
33
 
10
34
class OptionTests(TestCase):
11
35
    """Command-line option tests"""
15
39
        eq = self.assertEquals
16
40
        eq(parse_args(cmd_commit(), ['--help']),
17
41
           ([], {'help': True}))
18
 
        eq(parse_args(cmd_status(), ['--all']),
19
 
           ([], {'all': True}))
20
42
        eq(parse_args(cmd_commit(), ['--message=biter']),
21
43
           ([], {'message': 'biter'}))
22
44
        ## eq(parse_args(cmd_log(),  '-r 500'.split()),
30
52
    def test_option_help(self):
31
53
        """Options have help strings."""
32
54
        out, err = self.run_bzr_captured(['commit', '--help'])
33
 
        self.assertContainsRe(out, r'--file.*file containing commit message')
34
 
        self.assertContainsRe(out, r'--help.*-h')
 
55
        self.assertContainsRe(out, r'--file(.|\n)*file containing commit'
 
56
                                   ' message')
 
57
        self.assertContainsRe(out, r'-h.*--help')
35
58
 
36
59
    def test_option_help_global(self):
37
60
        """Global options have help strings."""
46
69
 
47
70
    def test_unknown_short_opt(self):
48
71
        out, err = self.run_bzr_captured(['help', '-r'], retcode=3)
49
 
        self.assertContainsRe(err, r'unknown short option')
50
 
 
 
72
        self.assertContainsRe(err, r'no such option')
 
73
 
 
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)
 
79
 
 
80
    def test_set_short_name(self):
 
81
        o = option.Option('wiggle')
 
82
        o.set_short_name('w')
 
83
        self.assertEqual(o.short_name(), 'w')
 
84
 
 
85
    def test_old_short_names(self):
 
86
        # test the deprecated method for getting and setting short option
 
87
        # names
 
88
        expected_warning = (
 
89
            "access to SHORT_OPTIONS was deprecated in version 0.14."
 
90
            " Set the short option name when constructing the Option.",
 
91
            DeprecationWarning, 2)
 
92
        _warnings = []
 
93
        def capture_warning(message, category, stacklevel=None):
 
94
            _warnings.append((message, category, stacklevel))
 
95
        old_warning_method = symbol_versioning.warn
 
96
        try:
 
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
 
99
            # name.
 
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
 
106
            # value
 
107
            opts, args = parse([example_opt], ['-w', 'foo'])
 
108
            self.assertEqual(opts.example, True)
 
109
            self.assertEqual(args, ['foo'])
 
110
        finally:
 
111
            symbol_versioning.set_warning_method(old_warning_method)
 
112
 
 
113
    def test_allow_dash(self):
 
114
        """Test that we can pass a plain '-' as an argument."""
 
115
        self.assertEqual((['-'], {}), parse_args(cmd_commit(), ['-']))
 
116
 
 
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)
 
120
 
 
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,
 
133
                          ['--number'])
 
134
        self.assertRaises(errors.BzrCommandError, self.parse, options,
 
135
                          ['--no-number'])
 
136
 
 
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.set_default('one')
 
142
        options = [option.RegistryOption('format', '', registry, str)]
 
143
        opts, args = self.parse(options, ['--format', 'one'])
 
144
        self.assertEqual({'format':'one'}, opts)
 
145
        opts, args = self.parse(options, ['--format', 'two'])
 
146
        self.assertEqual({'format':'two'}, opts)
 
147
        self.assertRaises(errors.BadOptionValue, self.parse, options,
 
148
                          ['--format', 'three'])
 
149
        self.assertRaises(errors.BzrCommandError, self.parse, options,
 
150
                          ['--two'])
 
151
        options = [option.RegistryOption('format', '', registry, str,
 
152
                   value_switches=True)]
 
153
        opts, args = self.parse(options, ['--two'])
 
154
        self.assertEqual({'format':'two'}, opts)
 
155
        opts, args = self.parse(options, ['--two', '--one'])
 
156
        self.assertEqual({'format':'one'}, opts)
 
157
        opts, args = self.parse(options, ['--two', '--one',
 
158
                                          '--format', 'two'])
 
159
        self.assertEqual({'format':'two'}, opts)
 
160
        options = [option.RegistryOption('format', '', registry, str,
 
161
                   enum_switch=False)]
 
162
        self.assertRaises(errors.BzrCommandError, self.parse, options,
 
163
                          ['--format', 'two'])
 
164
 
 
165
    def test_registry_converter(self):
 
166
        options = [option.RegistryOption('format', '',
 
167
                   bzrdir.format_registry, bzrdir.format_registry.make_bzrdir)]
 
168
        opts, args = self.parse(options, ['--format', 'knit'])
 
169
        self.assertIsInstance(opts.format.repository_format,
 
170
                              knitrepo.RepositoryFormatKnit1)
 
171
 
 
172
    def test_from_kwargs(self):
 
173
        my_option = option.RegistryOption.from_kwargs('my-option',
 
174
            help='test option', short='be short', be_long='go long')
 
175
        self.assertEqual(['my-option'],
 
176
            [x[0] for x in my_option.iter_switches()])
 
177
        my_option = option.RegistryOption.from_kwargs('my-option',
 
178
            help='test option', title="My option", short='be short',
 
179
            be_long='go long', value_switches=True)
 
180
        self.assertEqual(['my-option', 'be-long', 'short'],
 
181
            [x[0] for x in my_option.iter_switches()])
 
182
 
 
183
    def test_help(self):
 
184
        registry = bzrdir.BzrDirFormatRegistry()
 
185
        registry.register_metadir('one', 'RepositoryFormat7', 'one help')
 
186
        registry.register_metadir('two',
 
187
            'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
188
            'two help',
 
189
            )
 
190
        registry.set_default('one')
 
191
        options = [option.RegistryOption('format', 'format help', registry,
 
192
                   str, value_switches=True, title='Formats')]
 
193
        parser = option.get_optparser(dict((o.name, o) for o in options))
 
194
        value = parser.format_option_help()
 
195
        self.assertContainsRe(value, 'format.*format help')
 
196
        self.assertContainsRe(value, 'one.*one help')
 
197
        self.assertContainsRe(value, 'Formats:\n *--format')
 
198
 
 
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 = bzrdir.BzrDirFormatRegistry()
 
210
        registry.register_metadir('one', 'RepositoryFormat7', 'one help')
 
211
        registry.register_metadir('two',
 
212
                'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
213
                'two help',
 
214
                )
 
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,
 
221
                                    value_switches=True)
 
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'),
 
227
                          ])
51
228
 
52
229
#     >>> parse_args('log -r 500'.split())
53
230
#     (['log'], {'revision': [<RevisionSpec_int 500>]})