/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-08 23:30:31 UTC
  • mto: This revision was merged to the branch mainline in revision 6690.
  • Revision ID: jelmer@jelmer.uk-20170608233031-3qavls2o7a1pqllj
Update imports.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/tests/test_options.py
17
17
import re
18
18
 
19
19
from .. import (
20
 
    bzr,
21
20
    commands,
22
21
    controldir,
23
22
    errors,
24
23
    option,
25
24
    registry,
26
25
    )
 
26
from ..bzr import (
 
27
    bzrdir,
 
28
    )
27
29
from ..builtins import cmd_commit
28
30
from ..commands import parse_args
29
31
from . import TestCase
30
 
from ..bzr import knitrepo
 
32
from ..repofmt import knitrepo
31
33
 
32
34
 
33
35
def parse(options, args):
34
 
    parser = option.get_optparser(options)
 
36
    parser = option.get_optparser(dict((o.name, o) for o in options))
35
37
    return parser.parse_args(args)
36
38
 
37
39
 
44
46
        # to cmd_commit, when they are meant to be about option parsing in
45
47
        # general.
46
48
        self.assertEqual(
47
 
            ([], {'author': [], 'exclude': [], 'fixes': [], 'help': True,
48
 
                  'bugs': []}),
49
 
            parse_args(cmd_commit(), ['--help']))
 
49
           ([], {'author': [], 'exclude': [], 'fixes': [], 'help': True}),
 
50
           parse_args(cmd_commit(), ['--help']))
50
51
        self.assertEqual(
51
 
            ([], {'author': [], 'exclude': [], 'fixes': [], 'message': 'biter',
52
 
                  'bugs': []}),
53
 
            parse_args(cmd_commit(), ['--message=biter']))
 
52
           ([], {'author': [], 'exclude': [], 'fixes': [], 'message': 'biter'}),
 
53
           parse_args(cmd_commit(), ['--message=biter']))
54
54
 
55
55
    def test_no_more_opts(self):
56
56
        """Terminated options"""
57
57
        self.assertEqual(
58
 
            (['-file-with-dashes'], {
59
 
                'author': [], 'exclude': [], 'fixes': [], 'bugs': []}),
 
58
            (['-file-with-dashes'], {'author': [], 'exclude': [], 'fixes': []}),
60
59
            parse_args(cmd_commit(), ['--', '-file-with-dashes']))
61
60
 
62
61
    def test_option_help(self):
63
62
        """Options have help strings."""
64
63
        out, err = self.run_bzr('commit --help')
65
64
        self.assertContainsRe(out,
66
 
                              r'--file(.|\n)*Take commit message from this file\.')
 
65
                r'--file(.|\n)*Take commit message from this file\.')
67
66
        self.assertContainsRe(out, r'-h.*--help')
68
67
 
69
68
    def test_option_help_global(self):
96
95
        self.assertEqual((['-']), parse_args(cmd_commit(), ['-'])[0])
97
96
 
98
97
    def parse(self, options, args):
99
 
        parser = option.get_optparser(options)
 
98
        parser = option.get_optparser(dict((o.name, o) for o in options))
100
99
        return parser.parse_args(args)
101
100
 
102
101
    def test_conversion(self):
110
109
        options = [option.Option('number', type=int)]
111
110
        opts, args = self.parse(options, ['--number', '6'])
112
111
        self.assertEqual(6, opts.number)
113
 
        self.assertRaises(errors.CommandError, self.parse, options,
 
112
        self.assertRaises(errors.BzrCommandError, self.parse, options,
114
113
                          ['--number'])
115
 
        self.assertRaises(errors.CommandError, self.parse, options,
 
114
        self.assertRaises(errors.BzrCommandError, self.parse, options,
116
115
                          ['--no-number'])
117
 
        self.assertRaises(errors.CommandError, self.parse, options,
118
 
                          ['--number', 'a'])
119
116
 
120
117
    def test_is_hidden(self):
121
118
        self.assertTrue(option.Option('foo', hidden=True).is_hidden('foo'))
123
120
 
124
121
    def test_registry_conversion(self):
125
122
        registry = controldir.ControlDirFormatRegistry()
126
 
        bzr.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
127
 
        bzr.register_metadir(
128
 
            registry, 'two', 'RepositoryFormatKnit1', 'two help')
129
 
        bzr.register_metadir(registry, 'hidden', 'RepositoryFormatKnit1',
130
 
                             'two help', hidden=True)
 
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',
 
126
            'two help', hidden=True)
131
127
        registry.set_default('one')
132
128
        options = [option.RegistryOption('format', '', registry, str)]
133
129
        opts, args = self.parse(options, ['--format', 'one'])
134
 
        self.assertEqual({'format': 'one'}, opts)
 
130
        self.assertEqual({'format':'one'}, opts)
135
131
        opts, args = self.parse(options, ['--format', 'two'])
136
 
        self.assertEqual({'format': 'two'}, opts)
137
 
        self.assertRaises(option.BadOptionValue, self.parse, options,
 
132
        self.assertEqual({'format':'two'}, opts)
 
133
        self.assertRaises(errors.BadOptionValue, self.parse, options,
138
134
                          ['--format', 'three'])
139
 
        self.assertRaises(errors.CommandError, self.parse, options,
 
135
        self.assertRaises(errors.BzrCommandError, self.parse, options,
140
136
                          ['--two'])
141
137
        options = [option.RegistryOption('format', '', registry, str,
142
 
                                         value_switches=True)]
 
138
                   value_switches=True)]
143
139
        opts, args = self.parse(options, ['--two'])
144
 
        self.assertEqual({'format': 'two'}, opts)
 
140
        self.assertEqual({'format':'two'}, opts)
145
141
        opts, args = self.parse(options, ['--two', '--one'])
146
 
        self.assertEqual({'format': 'one'}, opts)
 
142
        self.assertEqual({'format':'one'}, opts)
147
143
        opts, args = self.parse(options, ['--two', '--one',
148
144
                                          '--format', 'two'])
149
 
        self.assertEqual({'format': 'two'}, opts)
 
145
        self.assertEqual({'format':'two'}, opts)
150
146
        options = [option.RegistryOption('format', '', registry, str,
151
 
                                         enum_switch=False)]
152
 
        self.assertRaises(errors.CommandError, self.parse, options,
 
147
                   enum_switch=False)]
 
148
        self.assertRaises(errors.BzrCommandError, self.parse, options,
153
149
                          ['--format', 'two'])
154
150
 
155
151
    def test_override(self):
166
162
 
167
163
    def test_registry_converter(self):
168
164
        options = [option.RegistryOption('format', '',
169
 
                                         controldir.format_registry, controldir.format_registry.make_controldir)]
 
165
                   controldir.format_registry, controldir.format_registry.make_bzrdir)]
170
166
        opts, args = self.parse(options, ['--format', 'knit'])
171
167
        self.assertIsInstance(opts.format.repository_format,
172
168
                              knitrepo.RepositoryFormatKnit1)
173
169
 
174
170
    def test_lazy_registry(self):
175
171
        options = [option.RegistryOption('format', '',
176
 
                                         lazy_registry=(
177
 
                                             'breezy.controldir', 'format_registry'),
178
 
                                         converter=str)]
 
172
                   lazy_registry=('breezy.controldir','format_registry'),
 
173
                   converter=str)]
179
174
        opts, args = self.parse(options, ['--format', 'knit'])
180
175
        self.assertEqual({'format': 'knit'}, opts)
181
176
        self.assertRaises(
182
 
            option.BadOptionValue, self.parse, options, ['--format', 'BAD'])
 
177
            errors.BadOptionValue, self.parse, options, ['--format', 'BAD'])
183
178
 
184
179
    def test_from_kwargs(self):
185
180
        my_option = option.RegistryOption.from_kwargs('my-option',
186
 
                                                      help='test option', short='be short', be_long='go long')
 
181
            help='test option', short='be short', be_long='go long')
187
182
        self.assertEqual(['my-option'],
188
 
                         [x[0] for x in my_option.iter_switches()])
 
183
            [x[0] for x in my_option.iter_switches()])
189
184
        my_option = option.RegistryOption.from_kwargs('my-option',
190
 
                                                      help='test option', title="My option", short='be short',
191
 
                                                      be_long='go long', value_switches=True)
 
185
            help='test option', title="My option", short='be short',
 
186
            be_long='go long', value_switches=True)
192
187
        self.assertEqual(['my-option', 'be-long', 'short'],
193
 
                         [x[0] for x in my_option.iter_switches()])
 
188
            [x[0] for x in my_option.iter_switches()])
194
189
        self.assertEqual('test option', my_option.help)
195
190
 
196
191
    def test_help(self):
197
192
        registry = controldir.ControlDirFormatRegistry()
198
 
        bzr.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
199
 
        bzr.register_metadir(registry, 'two',
200
 
                             'breezy.bzr.knitrepo.RepositoryFormatKnit1',
201
 
                             'two help',
202
 
                             )
203
 
        bzr.register_metadir(registry, 'hidden', 'RepositoryFormat7', 'hidden help',
204
 
                             hidden=True)
 
193
        bzrdir.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
 
194
        bzrdir.register_metadir(registry, 'two',
 
195
            'breezy.repofmt.knitrepo.RepositoryFormatKnit1',
 
196
            'two help',
 
197
            )
 
198
        bzrdir.register_metadir(registry, 'hidden', 'RepositoryFormat7', 'hidden help',
 
199
            hidden=True)
205
200
        registry.set_default('one')
206
201
        options = [option.RegistryOption('format', 'format help', registry,
207
 
                                         str, value_switches=True, title='Formats')]
208
 
        parser = option.get_optparser(options)
 
202
                   str, value_switches=True, title='Formats')]
 
203
        parser = option.get_optparser(dict((o.name, o) for o in options))
209
204
        value = parser.format_option_help()
210
205
        self.assertContainsRe(value, 'format.*format help')
211
206
        self.assertContainsRe(value, 'one.*one help')
223
218
        self.assertEqual(list(opt.iter_switches()),
224
219
                         [('hello', None, 'GAR', 'fg')])
225
220
        registry = controldir.ControlDirFormatRegistry()
226
 
        bzr.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
227
 
        bzr.register_metadir(registry, 'two',
228
 
                             'breezy.bzr.knitrepo.RepositoryFormatKnit1',
229
 
                             'two help',
230
 
                             )
 
221
        bzrdir.register_metadir(registry, 'one', 'RepositoryFormat7', 'one help')
 
222
        bzrdir.register_metadir(registry, 'two',
 
223
                'breezy.repofmt.knitrepo.RepositoryFormatKnit1',
 
224
                'two help',
 
225
                )
231
226
        registry.set_default('one')
232
227
        opt = option.RegistryOption('format', 'format help', registry,
233
228
                                    value_switches=False)
245
240
    def test_option_callback_bool(self):
246
241
        "Test booleans get True and False passed correctly to a callback."""
247
242
        cb_calls = []
248
 
 
249
243
        def cb(option, name, value, parser):
250
 
            cb_calls.append((option, name, value, parser))
 
244
            cb_calls.append((option,name,value,parser))
251
245
        options = [option.Option('hello', custom_callback=cb)]
252
246
        opts, args = self.parse(options, ['--hello', '--no-hello'])
253
247
        self.assertEqual(2, len(cb_calls))
254
 
        opt, name, value, parser = cb_calls[0]
 
248
        opt,name,value,parser = cb_calls[0]
255
249
        self.assertEqual('hello', name)
256
250
        self.assertTrue(value)
257
 
        opt, name, value, parser = cb_calls[1]
 
251
        opt,name,value,parser = cb_calls[1]
258
252
        self.assertEqual('hello', name)
259
253
        self.assertFalse(value)
260
254
 
261
255
    def test_option_callback_str(self):
262
256
        """Test callbacks work for string options both long and short."""
263
257
        cb_calls = []
264
 
 
265
258
        def cb(option, name, value, parser):
266
 
            cb_calls.append((option, name, value, parser))
 
259
            cb_calls.append((option,name,value,parser))
267
260
        options = [option.Option('hello', type=str, custom_callback=cb,
268
 
                                 short_name='h')]
 
261
            short_name='h')]
269
262
        opts, args = self.parse(options, ['--hello', 'world', '-h', 'mars'])
270
263
        self.assertEqual(2, len(cb_calls))
271
 
        opt, name, value, parser = cb_calls[0]
 
264
        opt,name,value,parser = cb_calls[0]
272
265
        self.assertEqual('hello', name)
273
266
        self.assertEqual('world', value)
274
 
        opt, name, value, parser = cb_calls[1]
 
267
        opt,name,value,parser = cb_calls[1]
275
268
        self.assertEqual('hello', name)
276
269
        self.assertEqual('mars', value)
277
270
 
280
273
    """Tests for ListOption, used to specify lists on the command-line."""
281
274
 
282
275
    def parse(self, options, args):
283
 
        parser = option.get_optparser(options)
 
276
        parser = option.get_optparser(dict((o.name, o) for o in options))
284
277
        return parser.parse_args(args)
285
278
 
286
279
    def test_list_option(self):
320
313
    def test_option_callback_list(self):
321
314
        """Test callbacks work for list options."""
322
315
        cb_calls = []
323
 
 
324
316
        def cb(option, name, value, parser):
325
317
            # Note that the value is a reference so copy to keep it
326
 
            cb_calls.append((option, name, value[:], parser))
 
318
            cb_calls.append((option,name,value[:],parser))
327
319
        options = [option.ListOption('hello', type=str, custom_callback=cb)]
328
320
        opts, args = self.parse(options, ['--hello=world', '--hello=mars',
329
 
                                          '--hello=-'])
 
321
            '--hello=-'])
330
322
        self.assertEqual(3, len(cb_calls))
331
 
        opt, name, value, parser = cb_calls[0]
 
323
        opt,name,value,parser = cb_calls[0]
332
324
        self.assertEqual('hello', name)
333
325
        self.assertEqual(['world'], value)
334
 
        opt, name, value, parser = cb_calls[1]
 
326
        opt,name,value,parser = cb_calls[1]
335
327
        self.assertEqual('hello', name)
336
328
        self.assertEqual(['world', 'mars'], value)
337
 
        opt, name, value, parser = cb_calls[2]
 
329
        opt,name,value,parser = cb_calls[2]
338
330
        self.assertEqual('hello', name)
339
331
        self.assertEqual([], value)
340
332
 
371
363
                    name = "/".join([opt.name, name])
372
364
                if not helptxt:
373
365
                    msgs.append('%-16s %-16s %s' %
374
 
                                ((scope or 'GLOBAL'), name, 'NO HELP'))
 
366
                           ((scope or 'GLOBAL'), name, 'NO HELP'))
375
367
                elif not option_re.match(helptxt):
 
368
                    if name.startswith("format/"):
 
369
                        # Don't complain about the odd format registry help
 
370
                        continue
376
371
                    msgs.append('%-16s %-16s %s' %
377
 
                                ((scope or 'GLOBAL'), name, helptxt))
 
372
                            ((scope or 'GLOBAL'), name, helptxt))
378
373
        if msgs:
379
374
            self.fail("The following options don't match the style guide:\n"
380
 
                      + '\n'.join(msgs))
 
375
                    + '\n'.join(msgs))
381
376
 
382
377
 
383
378
class TestOptionMisc(TestCase):
384
379
 
385
380
    def test_is_hidden(self):
386
381
        registry = controldir.ControlDirFormatRegistry()
387
 
        bzr.register_metadir(registry, 'hidden', 'HiddenFormat',
388
 
                             'hidden help text', hidden=True)
389
 
        bzr.register_metadir(registry, 'visible', 'VisibleFormat',
390
 
                             'visible help text', hidden=False)
 
382
        bzrdir.register_metadir(registry, 'hidden', 'HiddenFormat',
 
383
            'hidden help text', hidden=True)
 
384
        bzrdir.register_metadir(registry, 'visible', 'VisibleFormat',
 
385
            'visible help text', hidden=False)
391
386
        format = option.RegistryOption('format', '', registry, str)
392
387
        self.assertTrue(format.is_hidden('hidden'))
393
388
        self.assertFalse(format.is_hidden('visible'))
397
392
        opt = option.RegistryOption('format', help='', registry=registry)
398
393
        self.assertEqual(None, opt.short_name())
399
394
        opt = option.RegistryOption('format', short_name='F', help='',
400
 
                                    registry=registry)
 
395
            registry=registry)
401
396
        self.assertEqual('F', opt.short_name())
402
397
 
403
398
    def test_option_custom_help(self):
413
408
        reg.register('short', 'ShortChoice')
414
409
        reg.register('long', 'LongChoice')
415
410
        ropt = option.RegistryOption('choice', '', reg, value_switches=True,
416
 
                                     short_value_switches={'short': 's'})
 
411
            short_value_switches={'short': 's'})
417
412
        opts, args = parse([ropt], ['--short'])
418
413
        self.assertEqual('ShortChoice', opts.choice)
419
414
        opts, args = parse([ropt], ['-s'])
428
423
        self.assertEqual(level, option._verbosity_level)
429
424
 
430
425
    def test_verbose_quiet_linkage(self):
431
 
        parser = option.get_optparser(
432
 
            [v for k, v in sorted(option.Option.STD_OPTIONS.items())])
 
426
        parser = option.get_optparser(option.Option.STD_OPTIONS)
433
427
        self.check(parser, 0, [])
434
428
        self.check(parser, 1, ['-v'])
435
429
        self.check(parser, 2, ['-v', '-v'])