← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_options.py

(jameinel) Allow 'bzr serve' to interpret SIGHUP as a graceful shutdown.
 (bug #795025) (John A Meinel)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_options.py
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
import re
18
18
 
19
19
from bzrlib import (
20
20
    bzrdir,
21
21
    commands,
 
22
    controldir,
22
23
    errors,
23
24
    option,
 
25
    registry,
24
26
    )
25
27
from bzrlib.builtins import cmd_commit
26
 
from bzrlib.commands import Command, parse_args
 
28
from bzrlib.commands import parse_args
27
29
from bzrlib.tests import TestCase
28
30
from bzrlib.repofmt import knitrepo
29
31
 
42
44
        # to cmd_commit, when they are meant to be about option parsing in
43
45
        # general.
44
46
        self.assertEqual(parse_args(cmd_commit(), ['--help']),
45
 
           ([], {'exclude': [], 'fixes': [], 'help': True}))
 
47
           ([], {'author': [], 'exclude': [], 'fixes': [], 'help': True}))
46
48
        self.assertEqual(parse_args(cmd_commit(), ['--message=biter']),
47
 
           ([], {'exclude': [], 'fixes': [], 'message': 'biter'}))
 
49
           ([], {'author': [], 'exclude': [], 'fixes': [], 'message': 'biter'}))
48
50
 
49
51
    def test_no_more_opts(self):
50
52
        """Terminated options"""
51
53
        self.assertEqual(parse_args(cmd_commit(), ['--', '-file-with-dashes']),
52
 
                          (['-file-with-dashes'], {'exclude': [], 'fixes': []}))
 
54
                          (['-file-with-dashes'], {'author': [], 'exclude': [], 'fixes': []}))
53
55
 
54
56
    def test_option_help(self):
55
57
        """Options have help strings."""
102
104
        self.assertRaises(errors.BzrCommandError, self.parse, options,
103
105
                          ['--no-number'])
104
106
 
 
107
    def test_is_hidden(self):
 
108
        self.assertTrue(option.Option('foo', hidden=True).is_hidden('foo'))
 
109
        self.assertFalse(option.Option('foo', hidden=False).is_hidden('foo'))
 
110
 
105
111
    def test_registry_conversion(self):
106
 
        registry = bzrdir.BzrDirFormatRegistry()
107
 
        registry.register_metadir('one', 'RepositoryFormat7', 'one help')
108
 
        registry.register_metadir('two', 'RepositoryFormatKnit1', 'two help')
109
 
        registry.register_metadir('hidden', 'RepositoryFormatKnit1',
 
112
        registry = controldir.ControlDirFormatRegistry()
 
113
        bzrdir.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
 
114
        bzrdir.register_metadir(registry, 'two', 'RepositoryFormatKnit1', 'two help')
 
115
        bzrdir.register_metadir(registry, 'hidden', 'RepositoryFormatKnit1',
110
116
            'two help', hidden=True)
111
117
        registry.set_default('one')
112
118
        options = [option.RegistryOption('format', '', registry, str)]
173
179
        self.assertEqual('test option', my_option.help)
174
180
 
175
181
    def test_help(self):
176
 
        registry = bzrdir.BzrDirFormatRegistry()
177
 
        registry.register_metadir('one', 'RepositoryFormat7', 'one help')
178
 
        registry.register_metadir('two',
 
182
        registry = controldir.ControlDirFormatRegistry()
 
183
        bzrdir.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
 
184
        bzrdir.register_metadir(registry, 'two',
179
185
            'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
180
186
            'two help',
181
187
            )
182
 
        registry.register_metadir('hidden', 'RepositoryFormat7', 'hidden help',
 
188
        bzrdir.register_metadir(registry, 'hidden', 'RepositoryFormat7', 'hidden help',
183
189
            hidden=True)
184
190
        registry.set_default('one')
185
191
        options = [option.RegistryOption('format', 'format help', registry,
201
207
        opt = option.Option('hello', help='fg', type=int, argname='gar')
202
208
        self.assertEqual(list(opt.iter_switches()),
203
209
                         [('hello', None, 'GAR', 'fg')])
204
 
        registry = bzrdir.BzrDirFormatRegistry()
205
 
        registry.register_metadir('one', 'RepositoryFormat7', 'one help')
206
 
        registry.register_metadir('two',
 
210
        registry = controldir.ControlDirFormatRegistry()
 
211
        bzrdir.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
 
212
        bzrdir.register_metadir(registry, 'two',
207
213
                'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
208
214
                'two help',
209
215
                )
314
320
        self.assertEqual('hello', name)
315
321
        self.assertEqual([], value)
316
322
 
 
323
    def test_list_option_param_name(self):
 
324
        """Test list options can have their param_name set."""
 
325
        options = [option.ListOption('hello', type=str, param_name='greeting')]
 
326
        opts, args = self.parse(
 
327
            options, ['--hello=world', '--hello=sailor'])
 
328
        self.assertEqual(['world', 'sailor'], opts.greeting)
 
329
 
317
330
 
318
331
class TestOptionDefinitions(TestCase):
319
332
    """Tests for options in the Bazaar codebase."""
320
333
 
321
334
    def get_builtin_command_options(self):
322
335
        g = []
323
 
        for cmd_name, cmd_class in sorted(commands.get_all_cmds()):
324
 
            cmd = cmd_class()
 
336
        for cmd_name in sorted(commands.all_command_names()):
 
337
            cmd = commands.get_cmd_object(cmd_name)
325
338
            for opt_name, opt in sorted(cmd.options().items()):
326
339
                g.append((cmd_name, opt))
327
340
        return g
334
347
        g = dict(option.Option.OPTIONS.items())
335
348
        used_globals = {}
336
349
        msgs = []
337
 
        for cmd_name, cmd_class in sorted(commands.get_all_cmds()):
338
 
            for option_or_name in sorted(cmd_class.takes_options):
 
350
        for cmd_name in sorted(commands.all_command_names()):
 
351
            cmd = commands.get_cmd_object(cmd_name)
 
352
            for option_or_name in sorted(cmd.takes_options):
339
353
                if not isinstance(option_or_name, basestring):
340
354
                    self.assertIsInstance(option_or_name, option.Option)
341
355
                elif not option_or_name in g:
342
356
                    msgs.append("apparent reference to undefined "
343
357
                        "global option %r from %r"
344
 
                        % (option_or_name, cmd_class))
 
358
                        % (option_or_name, cmd))
345
359
                else:
346
360
                    used_globals.setdefault(option_or_name, []).append(cmd_name)
347
361
        unused_globals = set(g.keys()) - set(used_globals.keys())
374
388
                    + '\n'.join(msgs))
375
389
 
376
390
    def test_is_hidden(self):
377
 
        registry = bzrdir.BzrDirFormatRegistry()
378
 
        registry.register_metadir('hidden', 'HiddenFormat',
 
391
        registry = controldir.ControlDirFormatRegistry()
 
392
        bzrdir.register_metadir(registry, 'hidden', 'HiddenFormat',
379
393
            'hidden help text', hidden=True)
380
 
        registry.register_metadir('visible', 'VisibleFormat',
 
394
        bzrdir.register_metadir(registry, 'visible', 'VisibleFormat',
381
395
            'visible help text', hidden=False)
382
396
        format = option.RegistryOption('format', '', registry, str)
383
397
        self.assertTrue(format.is_hidden('hidden'))
384
398
        self.assertFalse(format.is_hidden('visible'))
385
399
 
 
400
    def test_short_name(self):
 
401
        registry = controldir.ControlDirFormatRegistry()
 
402
        opt = option.RegistryOption('format', help='', registry=registry)
 
403
        self.assertEquals(None, opt.short_name())
 
404
        opt = option.RegistryOption('format', short_name='F', help='',
 
405
            registry=registry)
 
406
        self.assertEquals('F', opt.short_name())
 
407
 
386
408
    def test_option_custom_help(self):
387
409
        the_opt = option.Option.OPTIONS['help']
388
410
        orig_help = the_opt.help[:]
391
413
        self.assertEqual('suggest lottery numbers', my_opt.help)
392
414
        self.assertEqual(orig_help, the_opt.help)
393
415
 
 
416
    def test_short_value_switches(self):
 
417
        reg = registry.Registry()
 
418
        reg.register('short', 'ShortChoice')
 
419
        reg.register('long', 'LongChoice')
 
420
        ropt = option.RegistryOption('choice', '', reg, value_switches=True,
 
421
            short_value_switches={'short': 's'})
 
422
        opts, args = parse([ropt], ['--short'])
 
423
        self.assertEqual('ShortChoice', opts.choice)
 
424
        opts, args = parse([ropt], ['-s'])
 
425
        self.assertEqual('ShortChoice', opts.choice)
 
426
 
394
427
 
395
428
class TestVerboseQuietLinkage(TestCase):
396
429