← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_options.py

  • Committer: Vincent Ladeuil
  • Date: 2007-09-24 15:01:26 UTC
  • mfrom: (2853 +trunk)
  • mto: (2885.1.1 140432)
  • mto: This revision was merged to the branch mainline in revision 2886.
  • Revision ID: v.ladeuil+lp@free.fr-20070924150126-nll7i0385kisklyj
Merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_options.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
import re
18
18
 
19
19
from bzrlib import (
 
20
    builtins,
20
21
    bzrdir,
21
22
    commands,
22
 
    controldir,
23
23
    errors,
24
24
    option,
 
25
    repository,
 
26
    symbol_versioning,
25
27
    )
26
 
from bzrlib.builtins import cmd_commit
 
28
from bzrlib.builtins import cmd_commit, cmd_log, cmd_status
27
29
from bzrlib.commands import Command, parse_args
28
30
from bzrlib.tests import TestCase
29
31
from bzrlib.repofmt import knitrepo
39
41
 
40
42
    def test_parse_args(self):
41
43
        """Option parser"""
42
 
        # XXX: Using cmd_commit makes these tests overly sensitive to changes
43
 
        # to cmd_commit, when they are meant to be about option parsing in
44
 
        # general.
45
 
        self.assertEqual(parse_args(cmd_commit(), ['--help']),
46
 
           ([], {'author': [], 'exclude': [], 'fixes': [], 'help': True}))
47
 
        self.assertEqual(parse_args(cmd_commit(), ['--message=biter']),
48
 
           ([], {'author': [], 'exclude': [], 'fixes': [], 'message': 'biter'}))
 
44
        eq = self.assertEquals
 
45
        eq(parse_args(cmd_commit(), ['--help']),
 
46
           ([], {'fixes': [], 'help': True}))
 
47
        eq(parse_args(cmd_commit(), ['--message=biter']),
 
48
           ([], {'fixes': [], 'message': 'biter'}))
49
49
 
50
50
    def test_no_more_opts(self):
51
51
        """Terminated options"""
52
 
        self.assertEqual(parse_args(cmd_commit(), ['--', '-file-with-dashes']),
53
 
                          (['-file-with-dashes'], {'author': [], 'exclude': [], 'fixes': []}))
 
52
        self.assertEquals(parse_args(cmd_commit(), ['--', '-file-with-dashes']),
 
53
                          (['-file-with-dashes'], {'fixes': []}))
54
54
 
55
55
    def test_option_help(self):
56
56
        """Options have help strings."""
67
67
    def test_option_arg_help(self):
68
68
        """Help message shows option arguments."""
69
69
        out, err = self.run_bzr('help commit')
70
 
        self.assertEqual(err, '')
 
70
        self.assertEquals(err, '')
71
71
        self.assertContainsRe(out, r'--file[ =]MSGFILE')
72
72
 
73
73
    def test_unknown_short_opt(self):
81
81
 
82
82
    def test_allow_dash(self):
83
83
        """Test that we can pass a plain '-' as an argument."""
84
 
        self.assertEqual((['-']), parse_args(cmd_commit(), ['-'])[0])
 
84
        self.assertEqual(
 
85
            (['-'], {'fixes': []}), parse_args(cmd_commit(), ['-']))
85
86
 
86
87
    def parse(self, options, args):
87
88
        parser = option.get_optparser(dict((o.name, o) for o in options))
103
104
        self.assertRaises(errors.BzrCommandError, self.parse, options,
104
105
                          ['--no-number'])
105
106
 
106
 
    def test_is_hidden(self):
107
 
        self.assertTrue(option.Option('foo', hidden=True).is_hidden('foo'))
108
 
        self.assertFalse(option.Option('foo', hidden=False).is_hidden('foo'))
109
 
 
110
107
    def test_registry_conversion(self):
111
 
        registry = controldir.ControlDirFormatRegistry()
112
 
        bzrdir.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
113
 
        bzrdir.register_metadir(registry, 'two', 'RepositoryFormatKnit1', 'two help')
114
 
        bzrdir.register_metadir(registry, 'hidden', 'RepositoryFormatKnit1',
 
108
        registry = bzrdir.BzrDirFormatRegistry()
 
109
        registry.register_metadir('one', 'RepositoryFormat7', 'one help')
 
110
        registry.register_metadir('two', 'RepositoryFormatKnit1', 'two help')
 
111
        registry.register_metadir('hidden', 'RepositoryFormatKnit1',
115
112
            'two help', hidden=True)
116
113
        registry.set_default('one')
117
114
        options = [option.RegistryOption('format', '', registry, str)]
156
153
        self.assertIsInstance(opts.format.repository_format,
157
154
                              knitrepo.RepositoryFormatKnit1)
158
155
 
159
 
    def test_lazy_registry(self):
160
 
        options = [option.RegistryOption('format', '',
161
 
                   lazy_registry=('bzrlib.bzrdir','format_registry'),
162
 
                   converter=str)]
163
 
        opts, args = self.parse(options, ['--format', 'knit'])
164
 
        self.assertEqual({'format': 'knit'}, opts)
165
 
        self.assertRaises(
166
 
            errors.BadOptionValue, self.parse, options, ['--format', 'BAD'])
167
 
 
168
156
    def test_from_kwargs(self):
169
157
        my_option = option.RegistryOption.from_kwargs('my-option',
170
158
            help='test option', short='be short', be_long='go long')
178
166
        self.assertEqual('test option', my_option.help)
179
167
 
180
168
    def test_help(self):
181
 
        registry = controldir.ControlDirFormatRegistry()
182
 
        bzrdir.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
183
 
        bzrdir.register_metadir(registry, 'two',
 
169
        registry = bzrdir.BzrDirFormatRegistry()
 
170
        registry.register_metadir('one', 'RepositoryFormat7', 'one help')
 
171
        registry.register_metadir('two',
184
172
            'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
185
173
            'two help',
186
174
            )
187
 
        bzrdir.register_metadir(registry, 'hidden', 'RepositoryFormat7', 'hidden help',
 
175
        registry.register_metadir('hidden', 'RepositoryFormat7', 'hidden help',
188
176
            hidden=True)
189
177
        registry.set_default('one')
190
178
        options = [option.RegistryOption('format', 'format help', registry,
206
194
        opt = option.Option('hello', help='fg', type=int, argname='gar')
207
195
        self.assertEqual(list(opt.iter_switches()),
208
196
                         [('hello', None, 'GAR', 'fg')])
209
 
        registry = controldir.ControlDirFormatRegistry()
210
 
        bzrdir.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
211
 
        bzrdir.register_metadir(registry, 'two',
 
197
        registry = bzrdir.BzrDirFormatRegistry()
 
198
        registry.register_metadir('one', 'RepositoryFormat7', 'one help')
 
199
        registry.register_metadir('two',
212
200
                'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
213
201
                'two help',
214
202
                )
270
258
        opts, args = self.parse(options, ['--hello=world', '--hello=sailor'])
271
259
        self.assertEqual(['world', 'sailor'], opts.hello)
272
260
 
273
 
    def test_list_option_with_dash(self):
274
 
        options = [option.ListOption('with-dash', type=str)]
275
 
        opts, args = self.parse(options, ['--with-dash=world',
276
 
                                          '--with-dash=sailor'])
277
 
        self.assertEqual(['world', 'sailor'], opts.with_dash)
278
 
 
279
261
    def test_list_option_no_arguments(self):
280
262
        options = [option.ListOption('hello', type=str)]
281
263
        opts, args = self.parse(options, [])
319
301
        self.assertEqual('hello', name)
320
302
        self.assertEqual([], value)
321
303
 
322
 
    def test_list_option_param_name(self):
323
 
        """Test list options can have their param_name set."""
324
 
        options = [option.ListOption('hello', type=str, param_name='greeting')]
325
 
        opts, args = self.parse(
326
 
            options, ['--hello=world', '--hello=sailor'])
327
 
        self.assertEqual(['world', 'sailor'], opts.greeting)
328
 
 
329
304
 
330
305
class TestOptionDefinitions(TestCase):
331
306
    """Tests for options in the Bazaar codebase."""
332
307
 
333
308
    def get_builtin_command_options(self):
334
309
        g = []
335
 
        for cmd_name in sorted(commands.all_command_names()):
336
 
            cmd = commands.get_cmd_object(cmd_name)
 
310
        for cmd_name, cmd_class in sorted(commands.get_all_cmds()):
 
311
            cmd = cmd_class()
337
312
            for opt_name, opt in sorted(cmd.options().items()):
338
313
                g.append((cmd_name, opt))
339
314
        return g
346
321
        g = dict(option.Option.OPTIONS.items())
347
322
        used_globals = {}
348
323
        msgs = []
349
 
        for cmd_name in sorted(commands.all_command_names()):
350
 
            cmd = commands.get_cmd_object(cmd_name)
351
 
            for option_or_name in sorted(cmd.takes_options):
 
324
        for cmd_name, cmd_class in sorted(commands.get_all_cmds()):
 
325
            for option_or_name in sorted(cmd_class.takes_options):
352
326
                if not isinstance(option_or_name, basestring):
353
327
                    self.assertIsInstance(option_or_name, option.Option)
354
328
                elif not option_or_name in g:
355
329
                    msgs.append("apparent reference to undefined "
356
330
                        "global option %r from %r"
357
 
                        % (option_or_name, cmd))
 
331
                        % (option_or_name, cmd_class))
358
332
                else:
359
333
                    used_globals.setdefault(option_or_name, []).append(cmd_name)
360
334
        unused_globals = set(g.keys()) - set(used_globals.keys())
375
349
        # period and be all on a single line, because the display code will
376
350
        # wrap it.
377
351
        option_re = re.compile(r'^[A-Z][^\n]+\.$')
378
 
        for scope, opt in self.get_builtin_command_options():
379
 
            if not opt.help:
380
 
                msgs.append('%-16s %-16s %s' %
381
 
                       ((scope or 'GLOBAL'), opt.name, 'NO HELP'))
382
 
            elif not option_re.match(opt.help):
383
 
                msgs.append('%-16s %-16s %s' %
384
 
                        ((scope or 'GLOBAL'), opt.name, opt.help))
 
352
        for scope, option in self.get_builtin_command_options():
 
353
            if not option.help:
 
354
                msgs.append('%-16s %-16s %s' %
 
355
                       ((scope or 'GLOBAL'), option.name, 'NO HELP'))
 
356
            elif not option_re.match(option.help):
 
357
                msgs.append('%-16s %-16s %s' %
 
358
                        ((scope or 'GLOBAL'), option.name, option.help))
385
359
        if msgs:
386
360
            self.fail("The following options don't match the style guide:\n"
387
361
                    + '\n'.join(msgs))
388
362
 
389
363
    def test_is_hidden(self):
390
 
        registry = controldir.ControlDirFormatRegistry()
391
 
        bzrdir.register_metadir(registry, 'hidden', 'HiddenFormat',
 
364
        registry = bzrdir.BzrDirFormatRegistry()
 
365
        registry.register_metadir('hidden', 'HiddenFormat',
392
366
            'hidden help text', hidden=True)
393
 
        bzrdir.register_metadir(registry, 'visible', 'VisibleFormat',
 
367
        registry.register_metadir('visible', 'VisibleFormat',
394
368
            'visible help text', hidden=False)
395
369
        format = option.RegistryOption('format', '', registry, str)
396
370
        self.assertTrue(format.is_hidden('hidden'))