/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/tests/test_options.py

  • Committer: Jelmer Vernooij
  • Date: 2017-06-10 21:59:15 UTC
  • mto: This revision was merged to the branch mainline in revision 6690.
  • Revision ID: jelmer@jelmer.uk-20170610215915-zcpu0in3r1irx3ml
Move serializer to bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/tests/test_options.py
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005-2012, 2016 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
16
16
 
17
17
import re
18
18
 
19
 
from bzrlib import (
20
 
    bzrdir,
 
19
from .. import (
21
20
    commands,
 
21
    controldir,
22
22
    errors,
23
23
    option,
24
 
    )
25
 
from bzrlib.builtins import cmd_commit
26
 
from bzrlib.commands import Command, parse_args
27
 
from bzrlib.tests import TestCase
28
 
from bzrlib.repofmt import knitrepo
 
24
    registry,
 
25
    )
 
26
from ..bzr import (
 
27
    bzrdir,
 
28
    )
 
29
from ..builtins import cmd_commit
 
30
from ..commands import parse_args
 
31
from . import TestCase
 
32
from ..bzr import knitrepo
29
33
 
30
34
 
31
35
def parse(options, args):
41
45
        # XXX: Using cmd_commit makes these tests overly sensitive to changes
42
46
        # to cmd_commit, when they are meant to be about option parsing in
43
47
        # general.
44
 
        self.assertEqual(parse_args(cmd_commit(), ['--help']),
45
 
           ([], {'author': [], 'exclude': [], 'fixes': [], 'help': True}))
46
 
        self.assertEqual(parse_args(cmd_commit(), ['--message=biter']),
47
 
           ([], {'author': [], 'exclude': [], 'fixes': [], 'message': 'biter'}))
 
48
        self.assertEqual(
 
49
           ([], {'author': [], 'exclude': [], 'fixes': [], 'help': True}),
 
50
           parse_args(cmd_commit(), ['--help']))
 
51
        self.assertEqual(
 
52
           ([], {'author': [], 'exclude': [], 'fixes': [], 'message': 'biter'}),
 
53
           parse_args(cmd_commit(), ['--message=biter']))
48
54
 
49
55
    def test_no_more_opts(self):
50
56
        """Terminated options"""
51
 
        self.assertEqual(parse_args(cmd_commit(), ['--', '-file-with-dashes']),
52
 
                          (['-file-with-dashes'], {'author': [], 'exclude': [], 'fixes': []}))
 
57
        self.assertEqual(
 
58
            (['-file-with-dashes'], {'author': [], 'exclude': [], 'fixes': []}),
 
59
            parse_args(cmd_commit(), ['--', '-file-with-dashes']))
53
60
 
54
61
    def test_option_help(self):
55
62
        """Options have help strings."""
63
70
        out, err = self.run_bzr('help status')
64
71
        self.assertContainsRe(out, r'--show-ids.*Show internal object.')
65
72
 
 
73
    def test_option_help_global_hidden(self):
 
74
        """Hidden global options have no help strings."""
 
75
        out, err = self.run_bzr('help log')
 
76
        self.assertNotContainsRe(out, r'--message')
 
77
 
66
78
    def test_option_arg_help(self):
67
79
        """Help message shows option arguments."""
68
80
        out, err = self.run_bzr('help commit')
107
119
        self.assertFalse(option.Option('foo', hidden=False).is_hidden('foo'))
108
120
 
109
121
    def test_registry_conversion(self):
110
 
        registry = bzrdir.BzrDirFormatRegistry()
111
 
        registry.register_metadir('one', 'RepositoryFormat7', 'one help')
112
 
        registry.register_metadir('two', 'RepositoryFormatKnit1', 'two help')
113
 
        registry.register_metadir('hidden', 'RepositoryFormatKnit1',
 
122
        registry = controldir.ControlDirFormatRegistry()
 
123
        bzrdir.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
 
124
        bzrdir.register_metadir(registry, 'two', 'RepositoryFormatKnit1', 'two help')
 
125
        bzrdir.register_metadir(registry, 'hidden', 'RepositoryFormatKnit1',
114
126
            'two help', hidden=True)
115
127
        registry.set_default('one')
116
128
        options = [option.RegistryOption('format', '', registry, str)]
150
162
 
151
163
    def test_registry_converter(self):
152
164
        options = [option.RegistryOption('format', '',
153
 
                   bzrdir.format_registry, bzrdir.format_registry.make_bzrdir)]
 
165
                   controldir.format_registry, controldir.format_registry.make_controldir)]
154
166
        opts, args = self.parse(options, ['--format', 'knit'])
155
167
        self.assertIsInstance(opts.format.repository_format,
156
168
                              knitrepo.RepositoryFormatKnit1)
157
169
 
158
170
    def test_lazy_registry(self):
159
171
        options = [option.RegistryOption('format', '',
160
 
                   lazy_registry=('bzrlib.bzrdir','format_registry'),
 
172
                   lazy_registry=('breezy.controldir','format_registry'),
161
173
                   converter=str)]
162
174
        opts, args = self.parse(options, ['--format', 'knit'])
163
175
        self.assertEqual({'format': 'knit'}, opts)
177
189
        self.assertEqual('test option', my_option.help)
178
190
 
179
191
    def test_help(self):
180
 
        registry = bzrdir.BzrDirFormatRegistry()
181
 
        registry.register_metadir('one', 'RepositoryFormat7', 'one help')
182
 
        registry.register_metadir('two',
183
 
            'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
192
        registry = controldir.ControlDirFormatRegistry()
 
193
        bzrdir.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
 
194
        bzrdir.register_metadir(registry, 'two',
 
195
            'breezy.bzr.knitrepo.RepositoryFormatKnit1',
184
196
            'two help',
185
197
            )
186
 
        registry.register_metadir('hidden', 'RepositoryFormat7', 'hidden help',
 
198
        bzrdir.register_metadir(registry, 'hidden', 'RepositoryFormat7', 'hidden help',
187
199
            hidden=True)
188
200
        registry.set_default('one')
189
201
        options = [option.RegistryOption('format', 'format help', registry,
205
217
        opt = option.Option('hello', help='fg', type=int, argname='gar')
206
218
        self.assertEqual(list(opt.iter_switches()),
207
219
                         [('hello', None, 'GAR', 'fg')])
208
 
        registry = bzrdir.BzrDirFormatRegistry()
209
 
        registry.register_metadir('one', 'RepositoryFormat7', 'one help')
210
 
        registry.register_metadir('two',
211
 
                'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
220
        registry = controldir.ControlDirFormatRegistry()
 
221
        bzrdir.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
 
222
        bzrdir.register_metadir(registry, 'two',
 
223
                'breezy.bzr.knitrepo.RepositoryFormatKnit1',
212
224
                'two help',
213
225
                )
214
226
        registry.set_default('one')
331
343
 
332
344
    def get_builtin_command_options(self):
333
345
        g = []
334
 
        for cmd_name in sorted(commands.all_command_names()):
 
346
        commands.install_bzr_command_hooks()
 
347
        for cmd_name in sorted(commands.builtin_command_names()):
335
348
            cmd = commands.get_cmd_object(cmd_name)
336
349
            for opt_name, opt in sorted(cmd.options().items()):
337
350
                g.append((cmd_name, opt))
 
351
        self.assertTrue(g)
338
352
        return g
339
353
 
340
 
    def test_global_options_used(self):
341
 
        # In the distant memory, options could only be declared globally.  Now
342
 
        # we prefer to declare them in the command, unless like -r they really
343
 
        # are used very widely with the exact same meaning.  So this checks
344
 
        # for any that should be garbage collected.
345
 
        g = dict(option.Option.OPTIONS.items())
346
 
        used_globals = {}
347
 
        msgs = []
348
 
        for cmd_name in sorted(commands.all_command_names()):
349
 
            cmd = commands.get_cmd_object(cmd_name)
350
 
            for option_or_name in sorted(cmd.takes_options):
351
 
                if not isinstance(option_or_name, basestring):
352
 
                    self.assertIsInstance(option_or_name, option.Option)
353
 
                elif not option_or_name in g:
354
 
                    msgs.append("apparent reference to undefined "
355
 
                        "global option %r from %r"
356
 
                        % (option_or_name, cmd))
357
 
                else:
358
 
                    used_globals.setdefault(option_or_name, []).append(cmd_name)
359
 
        unused_globals = set(g.keys()) - set(used_globals.keys())
360
 
        # not enforced because there might be plugins that use these globals
361
 
        ## for option_name in sorted(unused_globals):
362
 
        ##    msgs.append("unused global option %r" % option_name)
363
 
        ## for option_name, cmds in sorted(used_globals.items()):
364
 
        ##     if len(cmds) <= 1:
365
 
        ##         msgs.append("global option %r is only used by %r"
366
 
        ##                 % (option_name, cmds))
367
 
        if msgs:
368
 
            self.fail("problems with global option definitions:\n"
369
 
                    + '\n'.join(msgs))
370
 
 
371
354
    def test_option_grammar(self):
372
355
        msgs = []
373
356
        # Option help should be written in sentence form, and have a final
374
 
        # period and be all on a single line, because the display code will
375
 
        # wrap it.
376
 
        option_re = re.compile(r'^[A-Z][^\n]+\.$')
 
357
        # period with an optional bracketed suffix. All the text should be on
 
358
        # one line, because the display code will wrap it.
 
359
        option_re = re.compile(r'^[A-Z][^\n]+\.(?: \([^\n]+\))?$')
377
360
        for scope, opt in self.get_builtin_command_options():
378
 
            if not opt.help:
379
 
                msgs.append('%-16s %-16s %s' %
380
 
                       ((scope or 'GLOBAL'), opt.name, 'NO HELP'))
381
 
            elif not option_re.match(opt.help):
382
 
                msgs.append('%-16s %-16s %s' %
383
 
                        ((scope or 'GLOBAL'), opt.name, opt.help))
 
361
            for name, _, _, helptxt in opt.iter_switches():
 
362
                if name != opt.name:
 
363
                    name = "/".join([opt.name, name])
 
364
                if not helptxt:
 
365
                    msgs.append('%-16s %-16s %s' %
 
366
                           ((scope or 'GLOBAL'), name, 'NO HELP'))
 
367
                elif not option_re.match(helptxt):
 
368
                    if name.startswith("format/"):
 
369
                        # Don't complain about the odd format registry help
 
370
                        continue
 
371
                    msgs.append('%-16s %-16s %s' %
 
372
                            ((scope or 'GLOBAL'), name, helptxt))
384
373
        if msgs:
385
374
            self.fail("The following options don't match the style guide:\n"
386
375
                    + '\n'.join(msgs))
387
376
 
 
377
 
 
378
class TestOptionMisc(TestCase):
 
379
 
388
380
    def test_is_hidden(self):
389
 
        registry = bzrdir.BzrDirFormatRegistry()
390
 
        registry.register_metadir('hidden', 'HiddenFormat',
 
381
        registry = controldir.ControlDirFormatRegistry()
 
382
        bzrdir.register_metadir(registry, 'hidden', 'HiddenFormat',
391
383
            'hidden help text', hidden=True)
392
 
        registry.register_metadir('visible', 'VisibleFormat',
 
384
        bzrdir.register_metadir(registry, 'visible', 'VisibleFormat',
393
385
            'visible help text', hidden=False)
394
386
        format = option.RegistryOption('format', '', registry, str)
395
387
        self.assertTrue(format.is_hidden('hidden'))
396
388
        self.assertFalse(format.is_hidden('visible'))
397
389
 
 
390
    def test_short_name(self):
 
391
        registry = controldir.ControlDirFormatRegistry()
 
392
        opt = option.RegistryOption('format', help='', registry=registry)
 
393
        self.assertEqual(None, opt.short_name())
 
394
        opt = option.RegistryOption('format', short_name='F', help='',
 
395
            registry=registry)
 
396
        self.assertEqual('F', opt.short_name())
 
397
 
398
398
    def test_option_custom_help(self):
399
399
        the_opt = option.Option.OPTIONS['help']
400
400
        orig_help = the_opt.help[:]
403
403
        self.assertEqual('suggest lottery numbers', my_opt.help)
404
404
        self.assertEqual(orig_help, the_opt.help)
405
405
 
 
406
    def test_short_value_switches(self):
 
407
        reg = registry.Registry()
 
408
        reg.register('short', 'ShortChoice')
 
409
        reg.register('long', 'LongChoice')
 
410
        ropt = option.RegistryOption('choice', '', reg, value_switches=True,
 
411
            short_value_switches={'short': 's'})
 
412
        opts, args = parse([ropt], ['--short'])
 
413
        self.assertEqual('ShortChoice', opts.choice)
 
414
        opts, args = parse([ropt], ['-s'])
 
415
        self.assertEqual('ShortChoice', opts.choice)
 
416
 
406
417
 
407
418
class TestVerboseQuietLinkage(TestCase):
408
419