~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_config.py

  • Committer: Jelmer Vernooij
  • Date: 2011-09-26 15:21:01 UTC
  • mfrom: (6165.2.3 avoid-revision-history)
  • mto: This revision was merged to the branch mainline in revision 6216.
  • Revision ID: jelmer@samba.org-20110926152101-afcxw1hikybyivfd
merge avoid-revision-history.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2008, 2009 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
19
19
from cStringIO import StringIO
20
20
import os
21
21
import sys
 
22
import threading
 
23
 
 
24
 
 
25
from testtools import matchers
22
26
 
23
27
#import bzrlib specific imports here
24
28
from bzrlib import (
31
35
    mail_client,
32
36
    ui,
33
37
    urlutils,
 
38
    remote,
34
39
    tests,
35
40
    trace,
36
 
    transport,
 
41
    )
 
42
from bzrlib.symbol_versioning import (
 
43
    deprecated_in,
 
44
    )
 
45
from bzrlib.transport import remote as transport_remote
 
46
from bzrlib.tests import (
 
47
    features,
 
48
    scenarios,
 
49
    test_server,
37
50
    )
38
51
from bzrlib.util.configobj import configobj
39
52
 
40
53
 
 
54
def lockable_config_scenarios():
 
55
    return [
 
56
        ('global',
 
57
         {'config_class': config.GlobalConfig,
 
58
          'config_args': [],
 
59
          'config_section': 'DEFAULT'}),
 
60
        ('locations',
 
61
         {'config_class': config.LocationConfig,
 
62
          'config_args': ['.'],
 
63
          'config_section': '.'}),]
 
64
 
 
65
 
 
66
load_tests = scenarios.load_tests_apply_scenarios
 
67
 
 
68
# Register helpers to build stores
 
69
config.test_store_builder_registry.register(
 
70
    'configobj', lambda test: config.IniFileStore(test.get_transport(),
 
71
                                                  'configobj.conf'))
 
72
config.test_store_builder_registry.register(
 
73
    'bazaar', lambda test: config.GlobalStore())
 
74
config.test_store_builder_registry.register(
 
75
    'location', lambda test: config.LocationStore())
 
76
 
 
77
 
 
78
def build_backing_branch(test, relpath,
 
79
                         transport_class=None, server_class=None):
 
80
    """Test helper to create a backing branch only once.
 
81
 
 
82
    Some tests needs multiple stores/stacks to check concurrent update
 
83
    behaviours. As such, they need to build different branch *objects* even if
 
84
    they share the branch on disk.
 
85
 
 
86
    :param relpath: The relative path to the branch. (Note that the helper
 
87
        should always specify the same relpath).
 
88
 
 
89
    :param transport_class: The Transport class the test needs to use.
 
90
 
 
91
    :param server_class: The server associated with the ``transport_class``
 
92
        above.
 
93
 
 
94
    Either both or neither of ``transport_class`` and ``server_class`` should
 
95
    be specified.
 
96
    """
 
97
    if transport_class is not None and server_class is not None:
 
98
        test.transport_class = transport_class
 
99
        test.transport_server = server_class
 
100
    elif not (transport_class is None and server_class is None):
 
101
        raise AssertionError('Specify both ``transport_class`` and '
 
102
                             '``server_class`` or neither of them')
 
103
    if getattr(test, 'backing_branch', None) is None:
 
104
        # First call, let's build the branch on disk
 
105
        test.backing_branch = test.make_branch(relpath)
 
106
 
 
107
 
 
108
def build_branch_store(test):
 
109
    build_backing_branch(test, 'branch')
 
110
    b = branch.Branch.open('branch')
 
111
    return config.BranchStore(b)
 
112
config.test_store_builder_registry.register('branch', build_branch_store)
 
113
 
 
114
 
 
115
def build_control_store(test):
 
116
    build_backing_branch(test, 'branch')
 
117
    b = bzrdir.BzrDir.open('branch')
 
118
    return config.ControlStore(b)
 
119
config.test_store_builder_registry.register('control', build_control_store)
 
120
 
 
121
 
 
122
def build_remote_branch_store(test):
 
123
    # There is only one permutation (but we won't be able to handle more with
 
124
    # this design anyway)
 
125
    (transport_class,
 
126
     server_class) = transport_remote.get_test_permutations()[0]
 
127
    build_backing_branch(test, 'branch', transport_class, server_class)
 
128
    b = branch.Branch.open(test.get_url('branch'))
 
129
    return config.BranchStore(b)
 
130
config.test_store_builder_registry.register('remote_branch',
 
131
                                            build_remote_branch_store)
 
132
 
 
133
 
 
134
config.test_stack_builder_registry.register(
 
135
    'bazaar', lambda test: config.GlobalStack())
 
136
config.test_stack_builder_registry.register(
 
137
    'location', lambda test: config.LocationStack('.'))
 
138
 
 
139
 
 
140
def build_branch_stack(test):
 
141
    build_backing_branch(test, 'branch')
 
142
    b = branch.Branch.open('branch')
 
143
    return config.BranchStack(b)
 
144
config.test_stack_builder_registry.register('branch', build_branch_stack)
 
145
 
 
146
 
 
147
def build_remote_branch_stack(test):
 
148
    # There is only one permutation (but we won't be able to handle more with
 
149
    # this design anyway)
 
150
    (transport_class,
 
151
     server_class) = transport_remote.get_test_permutations()[0]
 
152
    build_backing_branch(test, 'branch', transport_class, server_class)
 
153
    b = branch.Branch.open(test.get_url('branch'))
 
154
    return config.RemoteBranchStack(b)
 
155
config.test_stack_builder_registry.register('remote_branch',
 
156
                                            build_remote_branch_stack)
 
157
 
 
158
def build_remote_control_stack(test):
 
159
    # There is only one permutation (but we won't be able to handle more with
 
160
    # this design anyway)
 
161
    (transport_class,
 
162
     server_class) = transport_remote.get_test_permutations()[0]
 
163
    # We need only a bzrdir for this, not a full branch, but it's not worth
 
164
    # creating a dedicated helper to create only the bzrdir
 
165
    build_backing_branch(test, 'branch', transport_class, server_class)
 
166
    b = branch.Branch.open(test.get_url('branch'))
 
167
    return config.RemoteControlStack(b.bzrdir)
 
168
config.test_stack_builder_registry.register('remote_control',
 
169
                                            build_remote_control_stack)
 
170
 
 
171
 
41
172
sample_long_alias="log -r-15..-1 --line"
42
173
sample_config_text = u"""
43
174
[DEFAULT]
45
176
editor=vim
46
177
change_editor=vimdiff -of @new_path @old_path
47
178
gpg_signing_command=gnome-gpg
 
179
gpg_signing_key=DD4D5088
48
180
log_format=short
 
181
validate_signatures_in_log=true
 
182
acceptable_keys=amy
49
183
user_global_option=something
 
184
bzr.mergetool.sometool=sometool {base} {this} {other} -o {result}
 
185
bzr.mergetool.funkytool=funkytool "arg with spaces" {this_temp}
 
186
bzr.mergetool.newtool='"newtool with spaces" {this_temp}'
 
187
bzr.default_mergetool=sometool
50
188
[ALIASES]
51
189
h=help
52
190
ll=""" + sample_long_alias + "\n"
94
232
[/a/]
95
233
check_signatures=check-available
96
234
gpg_signing_command=false
 
235
gpg_signing_key=default
97
236
user_local_option=local
98
237
# test trailing / matching
99
238
[/a/*]
105
244
"""
106
245
 
107
246
 
 
247
def create_configs(test):
 
248
    """Create configuration files for a given test.
 
249
 
 
250
    This requires creating a tree (and populate the ``test.tree`` attribute)
 
251
    and its associated branch and will populate the following attributes:
 
252
 
 
253
    - branch_config: A BranchConfig for the associated branch.
 
254
 
 
255
    - locations_config : A LocationConfig for the associated branch
 
256
 
 
257
    - bazaar_config: A GlobalConfig.
 
258
 
 
259
    The tree and branch are created in a 'tree' subdirectory so the tests can
 
260
    still use the test directory to stay outside of the branch.
 
261
    """
 
262
    tree = test.make_branch_and_tree('tree')
 
263
    test.tree = tree
 
264
    test.branch_config = config.BranchConfig(tree.branch)
 
265
    test.locations_config = config.LocationConfig(tree.basedir)
 
266
    test.bazaar_config = config.GlobalConfig()
 
267
 
 
268
 
 
269
def create_configs_with_file_option(test):
 
270
    """Create configuration files with a ``file`` option set in each.
 
271
 
 
272
    This builds on ``create_configs`` and add one ``file`` option in each
 
273
    configuration with a value which allows identifying the configuration file.
 
274
    """
 
275
    create_configs(test)
 
276
    test.bazaar_config.set_user_option('file', 'bazaar')
 
277
    test.locations_config.set_user_option('file', 'locations')
 
278
    test.branch_config.set_user_option('file', 'branch')
 
279
 
 
280
 
 
281
class TestOptionsMixin:
 
282
 
 
283
    def assertOptions(self, expected, conf):
 
284
        # We don't care about the parser (as it will make tests hard to write
 
285
        # and error-prone anyway)
 
286
        self.assertThat([opt[:4] for opt in conf._get_options()],
 
287
                        matchers.Equals(expected))
 
288
 
 
289
 
108
290
class InstrumentedConfigObj(object):
109
291
    """A config obj look-enough-alike to record calls made to it."""
110
292
 
129
311
        self._calls.append(('keys',))
130
312
        return []
131
313
 
 
314
    def reload(self):
 
315
        self._calls.append(('reload',))
 
316
 
132
317
    def write(self, arg):
133
318
        self._calls.append(('write',))
134
319
 
240
425
        """
241
426
        co = config.ConfigObj()
242
427
        co['test'] = 'foo#bar'
243
 
        lines = co.write()
 
428
        outfile = StringIO()
 
429
        co.write(outfile=outfile)
 
430
        lines = outfile.getvalue().splitlines()
244
431
        self.assertEqual(lines, ['test = "foo#bar"'])
245
432
        co2 = config.ConfigObj(lines)
246
433
        self.assertEqual(co2['test'], 'foo#bar')
247
434
 
 
435
    def test_triple_quotes(self):
 
436
        # Bug #710410: if the value string has triple quotes
 
437
        # then ConfigObj versions up to 4.7.2 will quote them wrong
 
438
        # and won't able to read them back
 
439
        triple_quotes_value = '''spam
 
440
""" that's my spam """
 
441
eggs'''
 
442
        co = config.ConfigObj()
 
443
        co['test'] = triple_quotes_value
 
444
        # While writing this test another bug in ConfigObj has been found:
 
445
        # method co.write() without arguments produces list of lines
 
446
        # one option per line, and multiline values are not split
 
447
        # across multiple lines,
 
448
        # and that breaks the parsing these lines back by ConfigObj.
 
449
        # This issue only affects test, but it's better to avoid
 
450
        # `co.write()` construct at all.
 
451
        # [bialix 20110222] bug report sent to ConfigObj's author
 
452
        outfile = StringIO()
 
453
        co.write(outfile=outfile)
 
454
        output = outfile.getvalue()
 
455
        # now we're trying to read it back
 
456
        co2 = config.ConfigObj(StringIO(output))
 
457
        self.assertEquals(triple_quotes_value, co2['test'])
 
458
 
248
459
 
249
460
erroneous_config = """[section] # line 1
250
461
good=good # line 2
271
482
        config.Config()
272
483
 
273
484
    def test_no_default_editor(self):
274
 
        self.assertRaises(NotImplementedError, config.Config().get_editor)
 
485
        self.assertRaises(
 
486
            NotImplementedError,
 
487
            self.applyDeprecated, deprecated_in((2, 4, 0)),
 
488
            config.Config().get_editor)
275
489
 
276
490
    def test_user_email(self):
277
491
        my_config = InstrumentedConfig()
320
534
        my_config = config.Config()
321
535
        self.assertEqual('long', my_config.log_format())
322
536
 
 
537
    def test_acceptable_keys_default(self):
 
538
        my_config = config.Config()
 
539
        self.assertEqual(None, my_config.acceptable_keys())
 
540
 
 
541
    def test_validate_signatures_in_log_default(self):
 
542
        my_config = config.Config()
 
543
        self.assertEqual(False, my_config.validate_signatures_in_log())
 
544
 
323
545
    def test_get_change_editor(self):
324
546
        my_config = InstrumentedConfig()
325
547
        change_editor = my_config.get_change_editor('old_tree', 'new_tree')
333
555
 
334
556
    def setUp(self):
335
557
        super(TestConfigPath, self).setUp()
336
 
        os.environ['HOME'] = '/home/bogus'
337
 
        os.environ['XDG_CACHE_DIR'] = ''
 
558
        self.overrideEnv('HOME', '/home/bogus')
 
559
        self.overrideEnv('XDG_CACHE_DIR', '')
338
560
        if sys.platform == 'win32':
339
 
            os.environ['BZR_HOME'] = \
340
 
                r'C:\Documents and Settings\bogus\Application Data'
 
561
            self.overrideEnv(
 
562
                'BZR_HOME', r'C:\Documents and Settings\bogus\Application Data')
341
563
            self.bzr_home = \
342
564
                'C:/Documents and Settings/bogus/Application Data/bazaar/2.0'
343
565
        else:
350
572
        self.assertEqual(config.config_filename(),
351
573
                         self.bzr_home + '/bazaar.conf')
352
574
 
353
 
    def test_branches_config_filename(self):
354
 
        self.assertEqual(config.branches_config_filename(),
355
 
                         self.bzr_home + '/branches.conf')
356
 
 
357
575
    def test_locations_config_filename(self):
358
576
        self.assertEqual(config.locations_config_filename(),
359
577
                         self.bzr_home + '/locations.conf')
367
585
            '/home/bogus/.cache')
368
586
 
369
587
 
370
 
class TestIniConfig(tests.TestCase):
 
588
class TestXDGConfigDir(tests.TestCaseInTempDir):
 
589
    # must be in temp dir because config tests for the existence of the bazaar
 
590
    # subdirectory of $XDG_CONFIG_HOME
 
591
 
 
592
    def setUp(self):
 
593
        if sys.platform in ('darwin', 'win32'):
 
594
            raise tests.TestNotApplicable(
 
595
                'XDG config dir not used on this platform')
 
596
        super(TestXDGConfigDir, self).setUp()
 
597
        self.overrideEnv('HOME', self.test_home_dir)
 
598
        # BZR_HOME overrides everything we want to test so unset it.
 
599
        self.overrideEnv('BZR_HOME', None)
 
600
 
 
601
    def test_xdg_config_dir_exists(self):
 
602
        """When ~/.config/bazaar exists, use it as the config dir."""
 
603
        newdir = osutils.pathjoin(self.test_home_dir, '.config', 'bazaar')
 
604
        os.makedirs(newdir)
 
605
        self.assertEqual(config.config_dir(), newdir)
 
606
 
 
607
    def test_xdg_config_home(self):
 
608
        """When XDG_CONFIG_HOME is set, use it."""
 
609
        xdgconfigdir = osutils.pathjoin(self.test_home_dir, 'xdgconfig')
 
610
        self.overrideEnv('XDG_CONFIG_HOME', xdgconfigdir)
 
611
        newdir = osutils.pathjoin(xdgconfigdir, 'bazaar')
 
612
        os.makedirs(newdir)
 
613
        self.assertEqual(config.config_dir(), newdir)
 
614
 
 
615
 
 
616
class TestIniConfig(tests.TestCaseInTempDir):
371
617
 
372
618
    def make_config_parser(self, s):
373
 
        conf = config.IniBasedConfig(None)
374
 
        parser = conf._get_parser(file=StringIO(s.encode('utf-8')))
375
 
        return conf, parser
 
619
        conf = config.IniBasedConfig.from_string(s)
 
620
        return conf, conf._get_parser()
376
621
 
377
622
 
378
623
class TestIniConfigBuilding(TestIniConfig):
379
624
 
380
625
    def test_contructs(self):
381
 
        my_config = config.IniBasedConfig("nothing")
 
626
        my_config = config.IniBasedConfig()
382
627
 
383
628
    def test_from_fp(self):
384
 
        config_file = StringIO(sample_config_text.encode('utf-8'))
385
 
        my_config = config.IniBasedConfig(None)
386
 
        self.failUnless(
387
 
            isinstance(my_config._get_parser(file=config_file),
388
 
                        configobj.ConfigObj))
 
629
        my_config = config.IniBasedConfig.from_string(sample_config_text)
 
630
        self.assertIsInstance(my_config._get_parser(), configobj.ConfigObj)
389
631
 
390
632
    def test_cached(self):
 
633
        my_config = config.IniBasedConfig.from_string(sample_config_text)
 
634
        parser = my_config._get_parser()
 
635
        self.assertTrue(my_config._get_parser() is parser)
 
636
 
 
637
    def _dummy_chown(self, path, uid, gid):
 
638
        self.path, self.uid, self.gid = path, uid, gid
 
639
 
 
640
    def test_ini_config_ownership(self):
 
641
        """Ensure that chown is happening during _write_config_file"""
 
642
        self.requireFeature(features.chown_feature)
 
643
        self.overrideAttr(os, 'chown', self._dummy_chown)
 
644
        self.path = self.uid = self.gid = None
 
645
        conf = config.IniBasedConfig(file_name='./foo.conf')
 
646
        conf._write_config_file()
 
647
        self.assertEquals(self.path, './foo.conf')
 
648
        self.assertTrue(isinstance(self.uid, int))
 
649
        self.assertTrue(isinstance(self.gid, int))
 
650
 
 
651
    def test_get_filename_parameter_is_deprecated_(self):
 
652
        conf = self.callDeprecated([
 
653
            'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
 
654
            ' Use file_name instead.'],
 
655
            config.IniBasedConfig, lambda: 'ini.conf')
 
656
        self.assertEqual('ini.conf', conf.file_name)
 
657
 
 
658
    def test_get_parser_file_parameter_is_deprecated_(self):
391
659
        config_file = StringIO(sample_config_text.encode('utf-8'))
392
 
        my_config = config.IniBasedConfig(None)
393
 
        parser = my_config._get_parser(file=config_file)
394
 
        self.failUnless(my_config._get_parser() is parser)
 
660
        conf = config.IniBasedConfig.from_string(sample_config_text)
 
661
        conf = self.callDeprecated([
 
662
            'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
 
663
            ' Use IniBasedConfig(_content=xxx) instead.'],
 
664
            conf._get_parser, file=config_file)
 
665
 
 
666
 
 
667
class TestIniConfigSaving(tests.TestCaseInTempDir):
 
668
 
 
669
    def test_cant_save_without_a_file_name(self):
 
670
        conf = config.IniBasedConfig()
 
671
        self.assertRaises(AssertionError, conf._write_config_file)
 
672
 
 
673
    def test_saved_with_content(self):
 
674
        content = 'foo = bar\n'
 
675
        conf = config.IniBasedConfig.from_string(
 
676
            content, file_name='./test.conf', save=True)
 
677
        self.assertFileEqual(content, 'test.conf')
 
678
 
 
679
 
 
680
class TestIniConfigOptionExpansionDefaultValue(tests.TestCaseInTempDir):
 
681
    """What is the default value of expand for config options.
 
682
 
 
683
    This is an opt-in beta feature used to evaluate whether or not option
 
684
    references can appear in dangerous place raising exceptions, disapearing
 
685
    (and as such corrupting data) or if it's safe to activate the option by
 
686
    default.
 
687
 
 
688
    Note that these tests relies on config._expand_default_value being already
 
689
    overwritten in the parent class setUp.
 
690
    """
 
691
 
 
692
    def setUp(self):
 
693
        super(TestIniConfigOptionExpansionDefaultValue, self).setUp()
 
694
        self.config = None
 
695
        self.warnings = []
 
696
        def warning(*args):
 
697
            self.warnings.append(args[0] % args[1:])
 
698
        self.overrideAttr(trace, 'warning', warning)
 
699
 
 
700
    def get_config(self, expand):
 
701
        c = config.GlobalConfig.from_string('bzr.config.expand=%s' % (expand,),
 
702
                                            save=True)
 
703
        return c
 
704
 
 
705
    def assertExpandIs(self, expected):
 
706
        actual = config._get_expand_default_value()
 
707
        #self.config.get_user_option_as_bool('bzr.config.expand')
 
708
        self.assertEquals(expected, actual)
 
709
 
 
710
    def test_default_is_None(self):
 
711
        self.assertEquals(None, config._expand_default_value)
 
712
 
 
713
    def test_default_is_False_even_if_None(self):
 
714
        self.config = self.get_config(None)
 
715
        self.assertExpandIs(False)
 
716
 
 
717
    def test_default_is_False_even_if_invalid(self):
 
718
        self.config = self.get_config('<your choice>')
 
719
        self.assertExpandIs(False)
 
720
        # ...
 
721
        # Huh ? My choice is False ? Thanks, always happy to hear that :D
 
722
        # Wait, you've been warned !
 
723
        self.assertLength(1, self.warnings)
 
724
        self.assertEquals(
 
725
            'Value "<your choice>" is not a boolean for "bzr.config.expand"',
 
726
            self.warnings[0])
 
727
 
 
728
    def test_default_is_True(self):
 
729
        self.config = self.get_config(True)
 
730
        self.assertExpandIs(True)
 
731
 
 
732
    def test_default_is_False(self):
 
733
        self.config = self.get_config(False)
 
734
        self.assertExpandIs(False)
 
735
 
 
736
 
 
737
class TestIniConfigOptionExpansion(tests.TestCase):
 
738
    """Test option expansion from the IniConfig level.
 
739
 
 
740
    What we really want here is to test the Config level, but the class being
 
741
    abstract as far as storing values is concerned, this can't be done
 
742
    properly (yet).
 
743
    """
 
744
    # FIXME: This should be rewritten when all configs share a storage
 
745
    # implementation -- vila 2011-02-18
 
746
 
 
747
    def get_config(self, string=None):
 
748
        if string is None:
 
749
            string = ''
 
750
        c = config.IniBasedConfig.from_string(string)
 
751
        return c
 
752
 
 
753
    def assertExpansion(self, expected, conf, string, env=None):
 
754
        self.assertEquals(expected, conf.expand_options(string, env))
 
755
 
 
756
    def test_no_expansion(self):
 
757
        c = self.get_config('')
 
758
        self.assertExpansion('foo', c, 'foo')
 
759
 
 
760
    def test_env_adding_options(self):
 
761
        c = self.get_config('')
 
762
        self.assertExpansion('bar', c, '{foo}', {'foo': 'bar'})
 
763
 
 
764
    def test_env_overriding_options(self):
 
765
        c = self.get_config('foo=baz')
 
766
        self.assertExpansion('bar', c, '{foo}', {'foo': 'bar'})
 
767
 
 
768
    def test_simple_ref(self):
 
769
        c = self.get_config('foo=xxx')
 
770
        self.assertExpansion('xxx', c, '{foo}')
 
771
 
 
772
    def test_unknown_ref(self):
 
773
        c = self.get_config('')
 
774
        self.assertRaises(errors.ExpandingUnknownOption,
 
775
                          c.expand_options, '{foo}')
 
776
 
 
777
    def test_indirect_ref(self):
 
778
        c = self.get_config('''
 
779
foo=xxx
 
780
bar={foo}
 
781
''')
 
782
        self.assertExpansion('xxx', c, '{bar}')
 
783
 
 
784
    def test_embedded_ref(self):
 
785
        c = self.get_config('''
 
786
foo=xxx
 
787
bar=foo
 
788
''')
 
789
        self.assertExpansion('xxx', c, '{{bar}}')
 
790
 
 
791
    def test_simple_loop(self):
 
792
        c = self.get_config('foo={foo}')
 
793
        self.assertRaises(errors.OptionExpansionLoop, c.expand_options, '{foo}')
 
794
 
 
795
    def test_indirect_loop(self):
 
796
        c = self.get_config('''
 
797
foo={bar}
 
798
bar={baz}
 
799
baz={foo}''')
 
800
        e = self.assertRaises(errors.OptionExpansionLoop,
 
801
                              c.expand_options, '{foo}')
 
802
        self.assertEquals('foo->bar->baz', e.refs)
 
803
        self.assertEquals('{foo}', e.string)
 
804
 
 
805
    def test_list(self):
 
806
        conf = self.get_config('''
 
807
foo=start
 
808
bar=middle
 
809
baz=end
 
810
list={foo},{bar},{baz}
 
811
''')
 
812
        self.assertEquals(['start', 'middle', 'end'],
 
813
                           conf.get_user_option('list', expand=True))
 
814
 
 
815
    def test_cascading_list(self):
 
816
        conf = self.get_config('''
 
817
foo=start,{bar}
 
818
bar=middle,{baz}
 
819
baz=end
 
820
list={foo}
 
821
''')
 
822
        self.assertEquals(['start', 'middle', 'end'],
 
823
                           conf.get_user_option('list', expand=True))
 
824
 
 
825
    def test_pathological_hidden_list(self):
 
826
        conf = self.get_config('''
 
827
foo=bin
 
828
bar=go
 
829
start={foo
 
830
middle=},{
 
831
end=bar}
 
832
hidden={start}{middle}{end}
 
833
''')
 
834
        # Nope, it's either a string or a list, and the list wins as soon as a
 
835
        # ',' appears, so the string concatenation never occur.
 
836
        self.assertEquals(['{foo', '}', '{', 'bar}'],
 
837
                          conf.get_user_option('hidden', expand=True))
 
838
 
 
839
 
 
840
class TestLocationConfigOptionExpansion(tests.TestCaseInTempDir):
 
841
 
 
842
    def get_config(self, location, string=None):
 
843
        if string is None:
 
844
            string = ''
 
845
        # Since we don't save the config we won't strictly require to inherit
 
846
        # from TestCaseInTempDir, but an error occurs so quickly...
 
847
        c = config.LocationConfig.from_string(string, location)
 
848
        return c
 
849
 
 
850
    def test_dont_cross_unrelated_section(self):
 
851
        c = self.get_config('/another/branch/path','''
 
852
[/one/branch/path]
 
853
foo = hello
 
854
bar = {foo}/2
 
855
 
 
856
[/another/branch/path]
 
857
bar = {foo}/2
 
858
''')
 
859
        self.assertRaises(errors.ExpandingUnknownOption,
 
860
                          c.get_user_option, 'bar', expand=True)
 
861
 
 
862
    def test_cross_related_sections(self):
 
863
        c = self.get_config('/project/branch/path','''
 
864
[/project]
 
865
foo = qu
 
866
 
 
867
[/project/branch/path]
 
868
bar = {foo}ux
 
869
''')
 
870
        self.assertEquals('quux', c.get_user_option('bar', expand=True))
 
871
 
 
872
 
 
873
class TestIniBaseConfigOnDisk(tests.TestCaseInTempDir):
 
874
 
 
875
    def test_cannot_reload_without_name(self):
 
876
        conf = config.IniBasedConfig.from_string(sample_config_text)
 
877
        self.assertRaises(AssertionError, conf.reload)
 
878
 
 
879
    def test_reload_see_new_value(self):
 
880
        c1 = config.IniBasedConfig.from_string('editor=vim\n',
 
881
                                               file_name='./test/conf')
 
882
        c1._write_config_file()
 
883
        c2 = config.IniBasedConfig.from_string('editor=emacs\n',
 
884
                                               file_name='./test/conf')
 
885
        c2._write_config_file()
 
886
        self.assertEqual('vim', c1.get_user_option('editor'))
 
887
        self.assertEqual('emacs', c2.get_user_option('editor'))
 
888
        # Make sure we get the Right value
 
889
        c1.reload()
 
890
        self.assertEqual('emacs', c1.get_user_option('editor'))
 
891
 
 
892
 
 
893
class TestLockableConfig(tests.TestCaseInTempDir):
 
894
 
 
895
    scenarios = lockable_config_scenarios()
 
896
 
 
897
    # Set by load_tests
 
898
    config_class = None
 
899
    config_args = None
 
900
    config_section = None
 
901
 
 
902
    def setUp(self):
 
903
        super(TestLockableConfig, self).setUp()
 
904
        self._content = '[%s]\none=1\ntwo=2\n' % (self.config_section,)
 
905
        self.config = self.create_config(self._content)
 
906
 
 
907
    def get_existing_config(self):
 
908
        return self.config_class(*self.config_args)
 
909
 
 
910
    def create_config(self, content):
 
911
        kwargs = dict(save=True)
 
912
        c = self.config_class.from_string(content, *self.config_args, **kwargs)
 
913
        return c
 
914
 
 
915
    def test_simple_read_access(self):
 
916
        self.assertEquals('1', self.config.get_user_option('one'))
 
917
 
 
918
    def test_simple_write_access(self):
 
919
        self.config.set_user_option('one', 'one')
 
920
        self.assertEquals('one', self.config.get_user_option('one'))
 
921
 
 
922
    def test_listen_to_the_last_speaker(self):
 
923
        c1 = self.config
 
924
        c2 = self.get_existing_config()
 
925
        c1.set_user_option('one', 'ONE')
 
926
        c2.set_user_option('two', 'TWO')
 
927
        self.assertEquals('ONE', c1.get_user_option('one'))
 
928
        self.assertEquals('TWO', c2.get_user_option('two'))
 
929
        # The second update respect the first one
 
930
        self.assertEquals('ONE', c2.get_user_option('one'))
 
931
 
 
932
    def test_last_speaker_wins(self):
 
933
        # If the same config is not shared, the same variable modified twice
 
934
        # can only see a single result.
 
935
        c1 = self.config
 
936
        c2 = self.get_existing_config()
 
937
        c1.set_user_option('one', 'c1')
 
938
        c2.set_user_option('one', 'c2')
 
939
        self.assertEquals('c2', c2._get_user_option('one'))
 
940
        # The first modification is still available until another refresh
 
941
        # occur
 
942
        self.assertEquals('c1', c1._get_user_option('one'))
 
943
        c1.set_user_option('two', 'done')
 
944
        self.assertEquals('c2', c1._get_user_option('one'))
 
945
 
 
946
    def test_writes_are_serialized(self):
 
947
        c1 = self.config
 
948
        c2 = self.get_existing_config()
 
949
 
 
950
        # We spawn a thread that will pause *during* the write
 
951
        before_writing = threading.Event()
 
952
        after_writing = threading.Event()
 
953
        writing_done = threading.Event()
 
954
        c1_orig = c1._write_config_file
 
955
        def c1_write_config_file():
 
956
            before_writing.set()
 
957
            c1_orig()
 
958
            # The lock is held. We wait for the main thread to decide when to
 
959
            # continue
 
960
            after_writing.wait()
 
961
        c1._write_config_file = c1_write_config_file
 
962
        def c1_set_option():
 
963
            c1.set_user_option('one', 'c1')
 
964
            writing_done.set()
 
965
        t1 = threading.Thread(target=c1_set_option)
 
966
        # Collect the thread after the test
 
967
        self.addCleanup(t1.join)
 
968
        # Be ready to unblock the thread if the test goes wrong
 
969
        self.addCleanup(after_writing.set)
 
970
        t1.start()
 
971
        before_writing.wait()
 
972
        self.assertTrue(c1._lock.is_held)
 
973
        self.assertRaises(errors.LockContention,
 
974
                          c2.set_user_option, 'one', 'c2')
 
975
        self.assertEquals('c1', c1.get_user_option('one'))
 
976
        # Let the lock be released
 
977
        after_writing.set()
 
978
        writing_done.wait()
 
979
        c2.set_user_option('one', 'c2')
 
980
        self.assertEquals('c2', c2.get_user_option('one'))
 
981
 
 
982
    def test_read_while_writing(self):
 
983
       c1 = self.config
 
984
       # We spawn a thread that will pause *during* the write
 
985
       ready_to_write = threading.Event()
 
986
       do_writing = threading.Event()
 
987
       writing_done = threading.Event()
 
988
       c1_orig = c1._write_config_file
 
989
       def c1_write_config_file():
 
990
           ready_to_write.set()
 
991
           # The lock is held. We wait for the main thread to decide when to
 
992
           # continue
 
993
           do_writing.wait()
 
994
           c1_orig()
 
995
           writing_done.set()
 
996
       c1._write_config_file = c1_write_config_file
 
997
       def c1_set_option():
 
998
           c1.set_user_option('one', 'c1')
 
999
       t1 = threading.Thread(target=c1_set_option)
 
1000
       # Collect the thread after the test
 
1001
       self.addCleanup(t1.join)
 
1002
       # Be ready to unblock the thread if the test goes wrong
 
1003
       self.addCleanup(do_writing.set)
 
1004
       t1.start()
 
1005
       # Ensure the thread is ready to write
 
1006
       ready_to_write.wait()
 
1007
       self.assertTrue(c1._lock.is_held)
 
1008
       self.assertEquals('c1', c1.get_user_option('one'))
 
1009
       # If we read during the write, we get the old value
 
1010
       c2 = self.get_existing_config()
 
1011
       self.assertEquals('1', c2.get_user_option('one'))
 
1012
       # Let the writing occur and ensure it occurred
 
1013
       do_writing.set()
 
1014
       writing_done.wait()
 
1015
       # Now we get the updated value
 
1016
       c3 = self.get_existing_config()
 
1017
       self.assertEquals('c1', c3.get_user_option('one'))
395
1018
 
396
1019
 
397
1020
class TestGetUserOptionAs(TestIniConfig):
406
1029
        get_bool = conf.get_user_option_as_bool
407
1030
        self.assertEqual(True, get_bool('a_true_bool'))
408
1031
        self.assertEqual(False, get_bool('a_false_bool'))
 
1032
        warnings = []
 
1033
        def warning(*args):
 
1034
            warnings.append(args[0] % args[1:])
 
1035
        self.overrideAttr(trace, 'warning', warning)
 
1036
        msg = 'Value "%s" is not a boolean for "%s"'
409
1037
        self.assertIs(None, get_bool('an_invalid_bool'))
 
1038
        self.assertEquals(msg % ('maybe', 'an_invalid_bool'), warnings[0])
 
1039
        warnings = []
410
1040
        self.assertIs(None, get_bool('not_defined_in_this_config'))
411
 
 
 
1041
        self.assertEquals([], warnings)
412
1042
 
413
1043
    def test_get_user_option_as_list(self):
414
1044
        conf, parser = self.make_config_parser("""
423
1053
        # automatically cast to list
424
1054
        self.assertEqual(['x'], get_list('one_item'))
425
1055
 
 
1056
    def test_get_user_option_as_int_from_SI(self):
 
1057
        conf, parser = self.make_config_parser("""
 
1058
plain = 100
 
1059
si_k = 5k,
 
1060
si_kb = 5kb,
 
1061
si_m = 5M,
 
1062
si_mb = 5MB,
 
1063
si_g = 5g,
 
1064
si_gb = 5gB,
 
1065
""")
 
1066
        get_si = conf.get_user_option_as_int_from_SI
 
1067
        self.assertEqual(100, get_si('plain'))
 
1068
        self.assertEqual(5000, get_si('si_k'))
 
1069
        self.assertEqual(5000, get_si('si_kb'))
 
1070
        self.assertEqual(5000000, get_si('si_m'))
 
1071
        self.assertEqual(5000000, get_si('si_mb'))
 
1072
        self.assertEqual(5000000000, get_si('si_g'))
 
1073
        self.assertEqual(5000000000, get_si('si_gb'))
 
1074
        self.assertEqual(None, get_si('non-exist'))
 
1075
        self.assertEqual(42, get_si('non-exist-with-default',  42))
426
1076
 
427
1077
class TestSupressWarning(TestIniConfig):
428
1078
 
455
1105
            parser = my_config._get_parser()
456
1106
        finally:
457
1107
            config.ConfigObj = oldparserclass
458
 
        self.failUnless(isinstance(parser, InstrumentedConfigObj))
 
1108
        self.assertIsInstance(parser, InstrumentedConfigObj)
459
1109
        self.assertEqual(parser._calls, [('__init__', config.config_filename(),
460
1110
                                          'utf-8')])
461
1111
 
472
1122
        my_config = config.BranchConfig(branch)
473
1123
        location_config = my_config._get_location_config()
474
1124
        self.assertEqual(branch.base, location_config.location)
475
 
        self.failUnless(location_config is my_config._get_location_config())
 
1125
        self.assertIs(location_config, my_config._get_location_config())
476
1126
 
477
1127
    def test_get_config(self):
478
1128
        """The Branch.get_config method works properly"""
498
1148
        branch = self.make_branch('branch')
499
1149
        self.assertEqual('branch', branch.nick)
500
1150
 
501
 
        locations = config.locations_config_filename()
502
 
        config.ensure_config_dir_exists()
503
1151
        local_url = urlutils.local_path_to_url('branch')
504
 
        open(locations, 'wb').write('[%s]\nnickname = foobar'
505
 
                                    % (local_url,))
 
1152
        conf = config.LocationConfig.from_string(
 
1153
            '[%s]\nnickname = foobar' % (local_url,),
 
1154
            local_url, save=True)
506
1155
        self.assertEqual('foobar', branch.nick)
507
1156
 
508
1157
    def test_config_local_path(self):
510
1159
        branch = self.make_branch('branch')
511
1160
        self.assertEqual('branch', branch.nick)
512
1161
 
513
 
        locations = config.locations_config_filename()
514
 
        config.ensure_config_dir_exists()
515
 
        open(locations, 'wb').write('[%s/branch]\nnickname = barry'
516
 
                                    % (osutils.getcwd().encode('utf8'),))
 
1162
        local_path = osutils.getcwd().encode('utf8')
 
1163
        conf = config.LocationConfig.from_string(
 
1164
            '[%s/branch]\nnickname = barry' % (local_path,),
 
1165
            'branch',  save=True)
517
1166
        self.assertEqual('barry', branch.nick)
518
1167
 
519
1168
    def test_config_creates_local(self):
520
1169
        """Creating a new entry in config uses a local path."""
521
1170
        branch = self.make_branch('branch', format='knit')
522
1171
        branch.set_push_location('http://foobar')
523
 
        locations = config.locations_config_filename()
524
1172
        local_path = osutils.getcwd().encode('utf8')
525
1173
        # Surprisingly ConfigObj doesn't create a trailing newline
526
 
        self.check_file_contents(locations,
 
1174
        self.check_file_contents(config.locations_config_filename(),
527
1175
                                 '[%s/branch]\n'
528
1176
                                 'push_location = http://foobar\n'
529
1177
                                 'push_location:policy = norecurse\n'
534
1182
        self.assertEqual('!repo', b.get_config().get_nickname())
535
1183
 
536
1184
    def test_warn_if_masked(self):
537
 
        _warning = trace.warning
538
1185
        warnings = []
539
1186
        def warning(*args):
540
1187
            warnings.append(args[0] % args[1:])
 
1188
        self.overrideAttr(trace, 'warning', warning)
541
1189
 
542
1190
        def set_option(store, warn_masked=True):
543
1191
            warnings[:] = []
549
1197
            else:
550
1198
                self.assertEqual(1, len(warnings))
551
1199
                self.assertEqual(warning, warnings[0])
552
 
        trace.warning = warning
553
 
        try:
554
 
            branch = self.make_branch('.')
555
 
            conf = branch.get_config()
556
 
            set_option(config.STORE_GLOBAL)
557
 
            assertWarning(None)
558
 
            set_option(config.STORE_BRANCH)
559
 
            assertWarning(None)
560
 
            set_option(config.STORE_GLOBAL)
561
 
            assertWarning('Value "4" is masked by "3" from branch.conf')
562
 
            set_option(config.STORE_GLOBAL, warn_masked=False)
563
 
            assertWarning(None)
564
 
            set_option(config.STORE_LOCATION)
565
 
            assertWarning(None)
566
 
            set_option(config.STORE_BRANCH)
567
 
            assertWarning('Value "3" is masked by "0" from locations.conf')
568
 
            set_option(config.STORE_BRANCH, warn_masked=False)
569
 
            assertWarning(None)
570
 
        finally:
571
 
            trace.warning = _warning
572
 
 
573
 
 
574
 
class TestGlobalConfigItems(tests.TestCase):
 
1200
        branch = self.make_branch('.')
 
1201
        conf = branch.get_config()
 
1202
        set_option(config.STORE_GLOBAL)
 
1203
        assertWarning(None)
 
1204
        set_option(config.STORE_BRANCH)
 
1205
        assertWarning(None)
 
1206
        set_option(config.STORE_GLOBAL)
 
1207
        assertWarning('Value "4" is masked by "3" from branch.conf')
 
1208
        set_option(config.STORE_GLOBAL, warn_masked=False)
 
1209
        assertWarning(None)
 
1210
        set_option(config.STORE_LOCATION)
 
1211
        assertWarning(None)
 
1212
        set_option(config.STORE_BRANCH)
 
1213
        assertWarning('Value "3" is masked by "0" from locations.conf')
 
1214
        set_option(config.STORE_BRANCH, warn_masked=False)
 
1215
        assertWarning(None)
 
1216
 
 
1217
 
 
1218
class TestGlobalConfigItems(tests.TestCaseInTempDir):
575
1219
 
576
1220
    def test_user_id(self):
577
 
        config_file = StringIO(sample_config_text.encode('utf-8'))
578
 
        my_config = config.GlobalConfig()
579
 
        my_config._parser = my_config._get_parser(file=config_file)
 
1221
        my_config = config.GlobalConfig.from_string(sample_config_text)
580
1222
        self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
581
1223
                         my_config._get_user_id())
582
1224
 
583
1225
    def test_absent_user_id(self):
584
 
        config_file = StringIO("")
585
1226
        my_config = config.GlobalConfig()
586
 
        my_config._parser = my_config._get_parser(file=config_file)
587
1227
        self.assertEqual(None, my_config._get_user_id())
588
1228
 
589
1229
    def test_configured_editor(self):
590
 
        config_file = StringIO(sample_config_text.encode('utf-8'))
591
 
        my_config = config.GlobalConfig()
592
 
        my_config._parser = my_config._get_parser(file=config_file)
593
 
        self.assertEqual("vim", my_config.get_editor())
 
1230
        my_config = config.GlobalConfig.from_string(sample_config_text)
 
1231
        editor = self.applyDeprecated(
 
1232
            deprecated_in((2, 4, 0)), my_config.get_editor)
 
1233
        self.assertEqual('vim', editor)
594
1234
 
595
1235
    def test_signatures_always(self):
596
 
        config_file = StringIO(sample_always_signatures)
597
 
        my_config = config.GlobalConfig()
598
 
        my_config._parser = my_config._get_parser(file=config_file)
 
1236
        my_config = config.GlobalConfig.from_string(sample_always_signatures)
599
1237
        self.assertEqual(config.CHECK_NEVER,
600
1238
                         my_config.signature_checking())
601
1239
        self.assertEqual(config.SIGN_ALWAYS,
603
1241
        self.assertEqual(True, my_config.signature_needed())
604
1242
 
605
1243
    def test_signatures_if_possible(self):
606
 
        config_file = StringIO(sample_maybe_signatures)
607
 
        my_config = config.GlobalConfig()
608
 
        my_config._parser = my_config._get_parser(file=config_file)
 
1244
        my_config = config.GlobalConfig.from_string(sample_maybe_signatures)
609
1245
        self.assertEqual(config.CHECK_NEVER,
610
1246
                         my_config.signature_checking())
611
1247
        self.assertEqual(config.SIGN_WHEN_REQUIRED,
613
1249
        self.assertEqual(False, my_config.signature_needed())
614
1250
 
615
1251
    def test_signatures_ignore(self):
616
 
        config_file = StringIO(sample_ignore_signatures)
617
 
        my_config = config.GlobalConfig()
618
 
        my_config._parser = my_config._get_parser(file=config_file)
 
1252
        my_config = config.GlobalConfig.from_string(sample_ignore_signatures)
619
1253
        self.assertEqual(config.CHECK_ALWAYS,
620
1254
                         my_config.signature_checking())
621
1255
        self.assertEqual(config.SIGN_NEVER,
623
1257
        self.assertEqual(False, my_config.signature_needed())
624
1258
 
625
1259
    def _get_sample_config(self):
626
 
        config_file = StringIO(sample_config_text.encode('utf-8'))
627
 
        my_config = config.GlobalConfig()
628
 
        my_config._parser = my_config._get_parser(file=config_file)
 
1260
        my_config = config.GlobalConfig.from_string(sample_config_text)
629
1261
        return my_config
630
1262
 
631
1263
    def test_gpg_signing_command(self):
633
1265
        self.assertEqual("gnome-gpg", my_config.gpg_signing_command())
634
1266
        self.assertEqual(False, my_config.signature_needed())
635
1267
 
 
1268
    def test_gpg_signing_key(self):
 
1269
        my_config = self._get_sample_config()
 
1270
        self.assertEqual("DD4D5088", my_config.gpg_signing_key())
 
1271
 
636
1272
    def _get_empty_config(self):
637
 
        config_file = StringIO("")
638
1273
        my_config = config.GlobalConfig()
639
 
        my_config._parser = my_config._get_parser(file=config_file)
640
1274
        return my_config
641
1275
 
642
1276
    def test_gpg_signing_command_unset(self):
660
1294
        my_config = self._get_sample_config()
661
1295
        self.assertEqual("short", my_config.log_format())
662
1296
 
 
1297
    def test_configured_acceptable_keys(self):
 
1298
        my_config = self._get_sample_config()
 
1299
        self.assertEqual("amy", my_config.acceptable_keys())
 
1300
 
 
1301
    def test_configured_validate_signatures_in_log(self):
 
1302
        my_config = self._get_sample_config()
 
1303
        self.assertEqual(True, my_config.validate_signatures_in_log())
 
1304
 
663
1305
    def test_get_alias(self):
664
1306
        my_config = self._get_sample_config()
665
1307
        self.assertEqual('help', my_config.get_alias('h'))
692
1334
        change_editor = my_config.get_change_editor('old', 'new')
693
1335
        self.assertIs(None, change_editor)
694
1336
 
 
1337
    def test_get_merge_tools(self):
 
1338
        conf = self._get_sample_config()
 
1339
        tools = conf.get_merge_tools()
 
1340
        self.log(repr(tools))
 
1341
        self.assertEqual(
 
1342
            {u'funkytool' : u'funkytool "arg with spaces" {this_temp}',
 
1343
            u'sometool' : u'sometool {base} {this} {other} -o {result}',
 
1344
            u'newtool' : u'"newtool with spaces" {this_temp}'},
 
1345
            tools)
 
1346
 
 
1347
    def test_get_merge_tools_empty(self):
 
1348
        conf = self._get_empty_config()
 
1349
        tools = conf.get_merge_tools()
 
1350
        self.assertEqual({}, tools)
 
1351
 
 
1352
    def test_find_merge_tool(self):
 
1353
        conf = self._get_sample_config()
 
1354
        cmdline = conf.find_merge_tool('sometool')
 
1355
        self.assertEqual('sometool {base} {this} {other} -o {result}', cmdline)
 
1356
 
 
1357
    def test_find_merge_tool_not_found(self):
 
1358
        conf = self._get_sample_config()
 
1359
        cmdline = conf.find_merge_tool('DOES NOT EXIST')
 
1360
        self.assertIs(cmdline, None)
 
1361
 
 
1362
    def test_find_merge_tool_known(self):
 
1363
        conf = self._get_empty_config()
 
1364
        cmdline = conf.find_merge_tool('kdiff3')
 
1365
        self.assertEquals('kdiff3 {base} {this} {other} -o {result}', cmdline)
 
1366
 
 
1367
    def test_find_merge_tool_override_known(self):
 
1368
        conf = self._get_empty_config()
 
1369
        conf.set_user_option('bzr.mergetool.kdiff3', 'kdiff3 blah')
 
1370
        cmdline = conf.find_merge_tool('kdiff3')
 
1371
        self.assertEqual('kdiff3 blah', cmdline)
 
1372
 
695
1373
 
696
1374
class TestGlobalConfigSavingOptions(tests.TestCaseInTempDir):
697
1375
 
715
1393
        self.assertIs(None, new_config.get_alias('commit'))
716
1394
 
717
1395
 
718
 
class TestLocationConfig(tests.TestCaseInTempDir):
 
1396
class TestLocationConfig(tests.TestCaseInTempDir, TestOptionsMixin):
719
1397
 
720
1398
    def test_constructs(self):
721
1399
        my_config = config.LocationConfig('http://example.com')
733
1411
            parser = my_config._get_parser()
734
1412
        finally:
735
1413
            config.ConfigObj = oldparserclass
736
 
        self.failUnless(isinstance(parser, InstrumentedConfigObj))
 
1414
        self.assertIsInstance(parser, InstrumentedConfigObj)
737
1415
        self.assertEqual(parser._calls,
738
1416
                         [('__init__', config.locations_config_filename(),
739
1417
                           'utf-8')])
740
 
        config.ensure_config_dir_exists()
741
 
        #os.mkdir(config.config_dir())
742
 
        f = file(config.branches_config_filename(), 'wb')
743
 
        f.write('')
744
 
        f.close()
745
 
        oldparserclass = config.ConfigObj
746
 
        config.ConfigObj = InstrumentedConfigObj
747
 
        try:
748
 
            my_config = config.LocationConfig('http://www.example.com')
749
 
            parser = my_config._get_parser()
750
 
        finally:
751
 
            config.ConfigObj = oldparserclass
752
1418
 
753
1419
    def test_get_global_config(self):
754
1420
        my_config = config.BranchConfig(FakeBranch('http://example.com'))
755
1421
        global_config = my_config._get_global_config()
756
 
        self.failUnless(isinstance(global_config, config.GlobalConfig))
757
 
        self.failUnless(global_config is my_config._get_global_config())
 
1422
        self.assertIsInstance(global_config, config.GlobalConfig)
 
1423
        self.assertIs(global_config, my_config._get_global_config())
 
1424
 
 
1425
    def assertLocationMatching(self, expected):
 
1426
        self.assertEqual(expected,
 
1427
                         list(self.my_location_config._get_matching_sections()))
758
1428
 
759
1429
    def test__get_matching_sections_no_match(self):
760
1430
        self.get_branch_config('/')
761
 
        self.assertEqual([], self.my_location_config._get_matching_sections())
 
1431
        self.assertLocationMatching([])
762
1432
 
763
1433
    def test__get_matching_sections_exact(self):
764
1434
        self.get_branch_config('http://www.example.com')
765
 
        self.assertEqual([('http://www.example.com', '')],
766
 
                         self.my_location_config._get_matching_sections())
 
1435
        self.assertLocationMatching([('http://www.example.com', '')])
767
1436
 
768
1437
    def test__get_matching_sections_suffix_does_not(self):
769
1438
        self.get_branch_config('http://www.example.com-com')
770
 
        self.assertEqual([], self.my_location_config._get_matching_sections())
 
1439
        self.assertLocationMatching([])
771
1440
 
772
1441
    def test__get_matching_sections_subdir_recursive(self):
773
1442
        self.get_branch_config('http://www.example.com/com')
774
 
        self.assertEqual([('http://www.example.com', 'com')],
775
 
                         self.my_location_config._get_matching_sections())
 
1443
        self.assertLocationMatching([('http://www.example.com', 'com')])
776
1444
 
777
1445
    def test__get_matching_sections_ignoreparent(self):
778
1446
        self.get_branch_config('http://www.example.com/ignoreparent')
779
 
        self.assertEqual([('http://www.example.com/ignoreparent', '')],
780
 
                         self.my_location_config._get_matching_sections())
 
1447
        self.assertLocationMatching([('http://www.example.com/ignoreparent',
 
1448
                                      '')])
781
1449
 
782
1450
    def test__get_matching_sections_ignoreparent_subdir(self):
783
1451
        self.get_branch_config(
784
1452
            'http://www.example.com/ignoreparent/childbranch')
785
 
        self.assertEqual([('http://www.example.com/ignoreparent',
786
 
                           'childbranch')],
787
 
                         self.my_location_config._get_matching_sections())
 
1453
        self.assertLocationMatching([('http://www.example.com/ignoreparent',
 
1454
                                      'childbranch')])
788
1455
 
789
1456
    def test__get_matching_sections_subdir_trailing_slash(self):
790
1457
        self.get_branch_config('/b')
791
 
        self.assertEqual([('/b/', '')],
792
 
                         self.my_location_config._get_matching_sections())
 
1458
        self.assertLocationMatching([('/b/', '')])
793
1459
 
794
1460
    def test__get_matching_sections_subdir_child(self):
795
1461
        self.get_branch_config('/a/foo')
796
 
        self.assertEqual([('/a/*', ''), ('/a/', 'foo')],
797
 
                         self.my_location_config._get_matching_sections())
 
1462
        self.assertLocationMatching([('/a/*', ''), ('/a/', 'foo')])
798
1463
 
799
1464
    def test__get_matching_sections_subdir_child_child(self):
800
1465
        self.get_branch_config('/a/foo/bar')
801
 
        self.assertEqual([('/a/*', 'bar'), ('/a/', 'foo/bar')],
802
 
                         self.my_location_config._get_matching_sections())
 
1466
        self.assertLocationMatching([('/a/*', 'bar'), ('/a/', 'foo/bar')])
803
1467
 
804
1468
    def test__get_matching_sections_trailing_slash_with_children(self):
805
1469
        self.get_branch_config('/a/')
806
 
        self.assertEqual([('/a/', '')],
807
 
                         self.my_location_config._get_matching_sections())
 
1470
        self.assertLocationMatching([('/a/', '')])
808
1471
 
809
1472
    def test__get_matching_sections_explicit_over_glob(self):
810
1473
        # XXX: 2006-09-08 jamesh
812
1475
        # was a config section for '/a/?', it would get precedence
813
1476
        # over '/a/c'.
814
1477
        self.get_branch_config('/a/c')
815
 
        self.assertEqual([('/a/c', ''), ('/a/*', ''), ('/a/', 'c')],
816
 
                         self.my_location_config._get_matching_sections())
 
1478
        self.assertLocationMatching([('/a/c', ''), ('/a/*', ''), ('/a/', 'c')])
817
1479
 
818
1480
    def test__get_option_policy_normal(self):
819
1481
        self.get_branch_config('http://www.example.com')
841
1503
            'http://www.example.com', 'appendpath_option'),
842
1504
            config.POLICY_APPENDPATH)
843
1505
 
 
1506
    def test__get_options_with_policy(self):
 
1507
        self.get_branch_config('/dir/subdir',
 
1508
                               location_config="""\
 
1509
[/dir]
 
1510
other_url = /other-dir
 
1511
other_url:policy = appendpath
 
1512
[/dir/subdir]
 
1513
other_url = /other-subdir
 
1514
""")
 
1515
        self.assertOptions(
 
1516
            [(u'other_url', u'/other-subdir', u'/dir/subdir', 'locations'),
 
1517
             (u'other_url', u'/other-dir', u'/dir', 'locations'),
 
1518
             (u'other_url:policy', u'appendpath', u'/dir', 'locations')],
 
1519
            self.my_location_config)
 
1520
 
844
1521
    def test_location_without_username(self):
845
1522
        self.get_branch_config('http://www.example.com/ignoreparent')
846
1523
        self.assertEqual(u'Erik B\u00e5gfors <erik@bagfors.nu>',
888
1565
        self.get_branch_config('/a')
889
1566
        self.assertEqual("false", self.my_config.gpg_signing_command())
890
1567
 
 
1568
    def test_gpg_signing_key(self):
 
1569
        self.get_branch_config('/b')
 
1570
        self.assertEqual("DD4D5088", self.my_config.gpg_signing_key())
 
1571
 
 
1572
    def test_gpg_signing_key_default(self):
 
1573
        self.get_branch_config('/a')
 
1574
        self.assertEqual("erik@bagfors.nu", self.my_config.gpg_signing_key())
 
1575
 
891
1576
    def test_get_user_option_global(self):
892
1577
        self.get_branch_config('/a')
893
1578
        self.assertEqual('something',
982
1667
        self.assertEqual('bzrlib.tests.test_config.post_commit',
983
1668
                         self.my_config.post_commit())
984
1669
 
985
 
    def get_branch_config(self, location, global_config=None):
 
1670
    def get_branch_config(self, location, global_config=None,
 
1671
                          location_config=None):
 
1672
        my_branch = FakeBranch(location)
986
1673
        if global_config is None:
987
 
            global_file = StringIO(sample_config_text.encode('utf-8'))
988
 
        else:
989
 
            global_file = StringIO(global_config.encode('utf-8'))
990
 
        branches_file = StringIO(sample_branches_text.encode('utf-8'))
991
 
        self.my_config = config.BranchConfig(FakeBranch(location))
992
 
        # Force location config to use specified file
993
 
        self.my_location_config = self.my_config._get_location_config()
994
 
        self.my_location_config._get_parser(branches_file)
995
 
        # Force global config to use specified file
996
 
        self.my_config._get_global_config()._get_parser(global_file)
 
1674
            global_config = sample_config_text
 
1675
        if location_config is None:
 
1676
            location_config = sample_branches_text
 
1677
 
 
1678
        my_global_config = config.GlobalConfig.from_string(global_config,
 
1679
                                                           save=True)
 
1680
        my_location_config = config.LocationConfig.from_string(
 
1681
            location_config, my_branch.base, save=True)
 
1682
        my_config = config.BranchConfig(my_branch)
 
1683
        self.my_config = my_config
 
1684
        self.my_location_config = my_config._get_location_config()
997
1685
 
998
1686
    def test_set_user_setting_sets_and_saves(self):
999
1687
        self.get_branch_config('/a/c')
1000
1688
        record = InstrumentedConfigObj("foo")
1001
1689
        self.my_location_config._parser = record
1002
1690
 
1003
 
        real_mkdir = os.mkdir
1004
 
        self.created = False
1005
 
        def checked_mkdir(path, mode=0777):
1006
 
            self.log('making directory: %s', path)
1007
 
            real_mkdir(path, mode)
1008
 
            self.created = True
1009
 
 
1010
 
        os.mkdir = checked_mkdir
1011
 
        try:
1012
 
            self.callDeprecated(['The recurse option is deprecated as of '
1013
 
                                 '0.14.  The section "/a/c" has been '
1014
 
                                 'converted to use policies.'],
1015
 
                                self.my_config.set_user_option,
1016
 
                                'foo', 'bar', store=config.STORE_LOCATION)
1017
 
        finally:
1018
 
            os.mkdir = real_mkdir
1019
 
 
1020
 
        self.failUnless(self.created, 'Failed to create ~/.bazaar')
1021
 
        self.assertEqual([('__contains__', '/a/c'),
 
1691
        self.callDeprecated(['The recurse option is deprecated as of '
 
1692
                             '0.14.  The section "/a/c" has been '
 
1693
                             'converted to use policies.'],
 
1694
                            self.my_config.set_user_option,
 
1695
                            'foo', 'bar', store=config.STORE_LOCATION)
 
1696
        self.assertEqual([('reload',),
 
1697
                          ('__contains__', '/a/c'),
1022
1698
                          ('__contains__', '/a/c/'),
1023
1699
                          ('__setitem__', '/a/c', {}),
1024
1700
                          ('__getitem__', '/a/c'),
1053
1729
        self.assertEqual('bzr', my_config.get_bzr_remote_path())
1054
1730
        my_config.set_user_option('bzr_remote_path', '/path-bzr')
1055
1731
        self.assertEqual('/path-bzr', my_config.get_bzr_remote_path())
1056
 
        os.environ['BZR_REMOTE_PATH'] = '/environ-bzr'
 
1732
        self.overrideEnv('BZR_REMOTE_PATH', '/environ-bzr')
1057
1733
        self.assertEqual('/environ-bzr', my_config.get_bzr_remote_path())
1058
1734
 
1059
1735
 
1067
1743
option = exact
1068
1744
"""
1069
1745
 
1070
 
 
1071
1746
class TestBranchConfigItems(tests.TestCaseInTempDir):
1072
1747
 
1073
1748
    def get_branch_config(self, global_config=None, location=None,
1074
1749
                          location_config=None, branch_data_config=None):
1075
 
        my_config = config.BranchConfig(FakeBranch(location))
 
1750
        my_branch = FakeBranch(location)
1076
1751
        if global_config is not None:
1077
 
            global_file = StringIO(global_config.encode('utf-8'))
1078
 
            my_config._get_global_config()._get_parser(global_file)
1079
 
        self.my_location_config = my_config._get_location_config()
 
1752
            my_global_config = config.GlobalConfig.from_string(global_config,
 
1753
                                                               save=True)
1080
1754
        if location_config is not None:
1081
 
            location_file = StringIO(location_config.encode('utf-8'))
1082
 
            self.my_location_config._get_parser(location_file)
 
1755
            my_location_config = config.LocationConfig.from_string(
 
1756
                location_config, my_branch.base, save=True)
 
1757
        my_config = config.BranchConfig(my_branch)
1083
1758
        if branch_data_config is not None:
1084
1759
            my_config.branch.control_files.files['branch.conf'] = \
1085
1760
                branch_data_config
1099
1774
                         my_config.username())
1100
1775
 
1101
1776
    def test_not_set_in_branch(self):
1102
 
        my_config = self.get_branch_config(sample_config_text)
 
1777
        my_config = self.get_branch_config(global_config=sample_config_text)
1103
1778
        self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
1104
1779
                         my_config._get_user_id())
1105
1780
        my_config.branch.control_files.files['email'] = "John"
1106
1781
        self.assertEqual("John", my_config._get_user_id())
1107
1782
 
1108
1783
    def test_BZR_EMAIL_OVERRIDES(self):
1109
 
        os.environ['BZR_EMAIL'] = "Robert Collins <robertc@example.org>"
 
1784
        self.overrideEnv('BZR_EMAIL', "Robert Collins <robertc@example.org>")
1110
1785
        branch = FakeBranch()
1111
1786
        my_config = config.BranchConfig(branch)
1112
1787
        self.assertEqual("Robert Collins <robertc@example.org>",
1129
1804
 
1130
1805
    def test_gpg_signing_command(self):
1131
1806
        my_config = self.get_branch_config(
 
1807
            global_config=sample_config_text,
1132
1808
            # branch data cannot set gpg_signing_command
1133
1809
            branch_data_config="gpg_signing_command=pgp")
1134
 
        config_file = StringIO(sample_config_text.encode('utf-8'))
1135
 
        my_config._get_global_config()._get_parser(config_file)
1136
1810
        self.assertEqual('gnome-gpg', my_config.gpg_signing_command())
1137
1811
 
1138
1812
    def test_get_user_option_global(self):
1139
 
        branch = FakeBranch()
1140
 
        my_config = config.BranchConfig(branch)
1141
 
        config_file = StringIO(sample_config_text.encode('utf-8'))
1142
 
        (my_config._get_global_config()._get_parser(config_file))
 
1813
        my_config = self.get_branch_config(global_config=sample_config_text)
1143
1814
        self.assertEqual('something',
1144
1815
                         my_config.get_user_option('user_global_option'))
1145
1816
 
1146
1817
    def test_post_commit_default(self):
1147
 
        branch = FakeBranch()
1148
 
        my_config = self.get_branch_config(sample_config_text, '/a/c',
1149
 
                                           sample_branches_text)
 
1818
        my_config = self.get_branch_config(global_config=sample_config_text,
 
1819
                                      location='/a/c',
 
1820
                                      location_config=sample_branches_text)
1150
1821
        self.assertEqual(my_config.branch.base, '/a/c')
1151
1822
        self.assertEqual('bzrlib.tests.test_config.post_commit',
1152
1823
                         my_config.post_commit())
1153
1824
        my_config.set_user_option('post_commit', 'rmtree_root')
1154
 
        # post-commit is ignored when bresent in branch data
 
1825
        # post-commit is ignored when present in branch data
1155
1826
        self.assertEqual('bzrlib.tests.test_config.post_commit',
1156
1827
                         my_config.post_commit())
1157
1828
        my_config.set_user_option('post_commit', 'rmtree_root',
1159
1830
        self.assertEqual('rmtree_root', my_config.post_commit())
1160
1831
 
1161
1832
    def test_config_precedence(self):
 
1833
        # FIXME: eager test, luckily no persitent config file makes it fail
 
1834
        # -- vila 20100716
1162
1835
        my_config = self.get_branch_config(global_config=precedence_global)
1163
1836
        self.assertEqual(my_config.get_user_option('option'), 'global')
1164
1837
        my_config = self.get_branch_config(global_config=precedence_global,
1165
 
                                      branch_data_config=precedence_branch)
 
1838
                                           branch_data_config=precedence_branch)
1166
1839
        self.assertEqual(my_config.get_user_option('option'), 'branch')
1167
 
        my_config = self.get_branch_config(global_config=precedence_global,
1168
 
                                      branch_data_config=precedence_branch,
1169
 
                                      location_config=precedence_location)
 
1840
        my_config = self.get_branch_config(
 
1841
            global_config=precedence_global,
 
1842
            branch_data_config=precedence_branch,
 
1843
            location_config=precedence_location)
1170
1844
        self.assertEqual(my_config.get_user_option('option'), 'recurse')
1171
 
        my_config = self.get_branch_config(global_config=precedence_global,
1172
 
                                      branch_data_config=precedence_branch,
1173
 
                                      location_config=precedence_location,
1174
 
                                      location='http://example.com/specific')
 
1845
        my_config = self.get_branch_config(
 
1846
            global_config=precedence_global,
 
1847
            branch_data_config=precedence_branch,
 
1848
            location_config=precedence_location,
 
1849
            location='http://example.com/specific')
1175
1850
        self.assertEqual(my_config.get_user_option('option'), 'exact')
1176
1851
 
1177
1852
    def test_get_mail_client(self):
1267
1942
 
1268
1943
class TestTransportConfig(tests.TestCaseWithTransport):
1269
1944
 
 
1945
    def test_load_utf8(self):
 
1946
        """Ensure we can load an utf8-encoded file."""
 
1947
        t = self.get_transport()
 
1948
        unicode_user = u'b\N{Euro Sign}ar'
 
1949
        unicode_content = u'user=%s' % (unicode_user,)
 
1950
        utf8_content = unicode_content.encode('utf8')
 
1951
        # Store the raw content in the config file
 
1952
        t.put_bytes('foo.conf', utf8_content)
 
1953
        conf = config.TransportConfig(t, 'foo.conf')
 
1954
        self.assertEquals(unicode_user, conf.get_option('user'))
 
1955
 
 
1956
    def test_load_non_ascii(self):
 
1957
        """Ensure we display a proper error on non-ascii, non utf-8 content."""
 
1958
        t = self.get_transport()
 
1959
        t.put_bytes('foo.conf', 'user=foo\n#\xff\n')
 
1960
        conf = config.TransportConfig(t, 'foo.conf')
 
1961
        self.assertRaises(errors.ConfigContentError, conf._get_configobj)
 
1962
 
 
1963
    def test_load_erroneous_content(self):
 
1964
        """Ensure we display a proper error on content that can't be parsed."""
 
1965
        t = self.get_transport()
 
1966
        t.put_bytes('foo.conf', '[open_section\n')
 
1967
        conf = config.TransportConfig(t, 'foo.conf')
 
1968
        self.assertRaises(errors.ParseConfigError, conf._get_configobj)
 
1969
 
 
1970
    def test_load_permission_denied(self):
 
1971
        """Ensure we get an empty config file if the file is inaccessible."""
 
1972
        warnings = []
 
1973
        def warning(*args):
 
1974
            warnings.append(args[0] % args[1:])
 
1975
        self.overrideAttr(trace, 'warning', warning)
 
1976
 
 
1977
        class DenyingTransport(object):
 
1978
 
 
1979
            def __init__(self, base):
 
1980
                self.base = base
 
1981
 
 
1982
            def get_bytes(self, relpath):
 
1983
                raise errors.PermissionDenied(relpath, "")
 
1984
 
 
1985
        cfg = config.TransportConfig(
 
1986
            DenyingTransport("nonexisting://"), 'control.conf')
 
1987
        self.assertIs(None, cfg.get_option('non-existant', 'SECTION'))
 
1988
        self.assertEquals(
 
1989
            warnings,
 
1990
            [u'Permission denied while trying to open configuration file '
 
1991
             u'nonexisting:///control.conf.'])
 
1992
 
1270
1993
    def test_get_value(self):
1271
1994
        """Test that retreiving a value from a section is possible"""
1272
 
        bzrdir_config = config.TransportConfig(transport.get_transport('.'),
 
1995
        bzrdir_config = config.TransportConfig(self.get_transport('.'),
1273
1996
                                               'control.conf')
1274
1997
        bzrdir_config.set_option('value', 'key', 'SECTION')
1275
1998
        bzrdir_config.set_option('value2', 'key2')
1305
2028
        self.assertIs(None, bzrdir_config.get_default_stack_on())
1306
2029
 
1307
2030
 
 
2031
class TestOldConfigHooks(tests.TestCaseWithTransport):
 
2032
 
 
2033
    def setUp(self):
 
2034
        super(TestOldConfigHooks, self).setUp()
 
2035
        create_configs_with_file_option(self)
 
2036
 
 
2037
    def assertGetHook(self, conf, name, value):
 
2038
        calls = []
 
2039
        def hook(*args):
 
2040
            calls.append(args)
 
2041
        config.OldConfigHooks.install_named_hook('get', hook, None)
 
2042
        self.addCleanup(
 
2043
            config.OldConfigHooks.uninstall_named_hook, 'get', None)
 
2044
        self.assertLength(0, calls)
 
2045
        actual_value = conf.get_user_option(name)
 
2046
        self.assertEquals(value, actual_value)
 
2047
        self.assertLength(1, calls)
 
2048
        self.assertEquals((conf, name, value), calls[0])
 
2049
 
 
2050
    def test_get_hook_bazaar(self):
 
2051
        self.assertGetHook(self.bazaar_config, 'file', 'bazaar')
 
2052
 
 
2053
    def test_get_hook_locations(self):
 
2054
        self.assertGetHook(self.locations_config, 'file', 'locations')
 
2055
 
 
2056
    def test_get_hook_branch(self):
 
2057
        # Since locations masks branch, we define a different option
 
2058
        self.branch_config.set_user_option('file2', 'branch')
 
2059
        self.assertGetHook(self.branch_config, 'file2', 'branch')
 
2060
 
 
2061
    def assertSetHook(self, conf, name, value):
 
2062
        calls = []
 
2063
        def hook(*args):
 
2064
            calls.append(args)
 
2065
        config.OldConfigHooks.install_named_hook('set', hook, None)
 
2066
        self.addCleanup(
 
2067
            config.OldConfigHooks.uninstall_named_hook, 'set', None)
 
2068
        self.assertLength(0, calls)
 
2069
        conf.set_user_option(name, value)
 
2070
        self.assertLength(1, calls)
 
2071
        # We can't assert the conf object below as different configs use
 
2072
        # different means to implement set_user_option and we care only about
 
2073
        # coverage here.
 
2074
        self.assertEquals((name, value), calls[0][1:])
 
2075
 
 
2076
    def test_set_hook_bazaar(self):
 
2077
        self.assertSetHook(self.bazaar_config, 'foo', 'bazaar')
 
2078
 
 
2079
    def test_set_hook_locations(self):
 
2080
        self.assertSetHook(self.locations_config, 'foo', 'locations')
 
2081
 
 
2082
    def test_set_hook_branch(self):
 
2083
        self.assertSetHook(self.branch_config, 'foo', 'branch')
 
2084
 
 
2085
    def assertRemoveHook(self, conf, name, section_name=None):
 
2086
        calls = []
 
2087
        def hook(*args):
 
2088
            calls.append(args)
 
2089
        config.OldConfigHooks.install_named_hook('remove', hook, None)
 
2090
        self.addCleanup(
 
2091
            config.OldConfigHooks.uninstall_named_hook, 'remove', None)
 
2092
        self.assertLength(0, calls)
 
2093
        conf.remove_user_option(name, section_name)
 
2094
        self.assertLength(1, calls)
 
2095
        # We can't assert the conf object below as different configs use
 
2096
        # different means to implement remove_user_option and we care only about
 
2097
        # coverage here.
 
2098
        self.assertEquals((name,), calls[0][1:])
 
2099
 
 
2100
    def test_remove_hook_bazaar(self):
 
2101
        self.assertRemoveHook(self.bazaar_config, 'file')
 
2102
 
 
2103
    def test_remove_hook_locations(self):
 
2104
        self.assertRemoveHook(self.locations_config, 'file',
 
2105
                              self.locations_config.location)
 
2106
 
 
2107
    def test_remove_hook_branch(self):
 
2108
        self.assertRemoveHook(self.branch_config, 'file')
 
2109
 
 
2110
    def assertLoadHook(self, name, conf_class, *conf_args):
 
2111
        calls = []
 
2112
        def hook(*args):
 
2113
            calls.append(args)
 
2114
        config.OldConfigHooks.install_named_hook('load', hook, None)
 
2115
        self.addCleanup(
 
2116
            config.OldConfigHooks.uninstall_named_hook, 'load', None)
 
2117
        self.assertLength(0, calls)
 
2118
        # Build a config
 
2119
        conf = conf_class(*conf_args)
 
2120
        # Access an option to trigger a load
 
2121
        conf.get_user_option(name)
 
2122
        self.assertLength(1, calls)
 
2123
        # Since we can't assert about conf, we just use the number of calls ;-/
 
2124
 
 
2125
    def test_load_hook_bazaar(self):
 
2126
        self.assertLoadHook('file', config.GlobalConfig)
 
2127
 
 
2128
    def test_load_hook_locations(self):
 
2129
        self.assertLoadHook('file', config.LocationConfig, self.tree.basedir)
 
2130
 
 
2131
    def test_load_hook_branch(self):
 
2132
        self.assertLoadHook('file', config.BranchConfig, self.tree.branch)
 
2133
 
 
2134
    def assertSaveHook(self, conf):
 
2135
        calls = []
 
2136
        def hook(*args):
 
2137
            calls.append(args)
 
2138
        config.OldConfigHooks.install_named_hook('save', hook, None)
 
2139
        self.addCleanup(
 
2140
            config.OldConfigHooks.uninstall_named_hook, 'save', None)
 
2141
        self.assertLength(0, calls)
 
2142
        # Setting an option triggers a save
 
2143
        conf.set_user_option('foo', 'bar')
 
2144
        self.assertLength(1, calls)
 
2145
        # Since we can't assert about conf, we just use the number of calls ;-/
 
2146
 
 
2147
    def test_save_hook_bazaar(self):
 
2148
        self.assertSaveHook(self.bazaar_config)
 
2149
 
 
2150
    def test_save_hook_locations(self):
 
2151
        self.assertSaveHook(self.locations_config)
 
2152
 
 
2153
    def test_save_hook_branch(self):
 
2154
        self.assertSaveHook(self.branch_config)
 
2155
 
 
2156
 
 
2157
class TestOldConfigHooksForRemote(tests.TestCaseWithTransport):
 
2158
    """Tests config hooks for remote configs.
 
2159
 
 
2160
    No tests for the remove hook as this is not implemented there.
 
2161
    """
 
2162
 
 
2163
    def setUp(self):
 
2164
        super(TestOldConfigHooksForRemote, self).setUp()
 
2165
        self.transport_server = test_server.SmartTCPServer_for_testing
 
2166
        create_configs_with_file_option(self)
 
2167
 
 
2168
    def assertGetHook(self, conf, name, value):
 
2169
        calls = []
 
2170
        def hook(*args):
 
2171
            calls.append(args)
 
2172
        config.OldConfigHooks.install_named_hook('get', hook, None)
 
2173
        self.addCleanup(
 
2174
            config.OldConfigHooks.uninstall_named_hook, 'get', None)
 
2175
        self.assertLength(0, calls)
 
2176
        actual_value = conf.get_option(name)
 
2177
        self.assertEquals(value, actual_value)
 
2178
        self.assertLength(1, calls)
 
2179
        self.assertEquals((conf, name, value), calls[0])
 
2180
 
 
2181
    def test_get_hook_remote_branch(self):
 
2182
        remote_branch = branch.Branch.open(self.get_url('tree'))
 
2183
        self.assertGetHook(remote_branch._get_config(), 'file', 'branch')
 
2184
 
 
2185
    def test_get_hook_remote_bzrdir(self):
 
2186
        remote_bzrdir = bzrdir.BzrDir.open(self.get_url('tree'))
 
2187
        conf = remote_bzrdir._get_config()
 
2188
        conf.set_option('remotedir', 'file')
 
2189
        self.assertGetHook(conf, 'file', 'remotedir')
 
2190
 
 
2191
    def assertSetHook(self, conf, name, value):
 
2192
        calls = []
 
2193
        def hook(*args):
 
2194
            calls.append(args)
 
2195
        config.OldConfigHooks.install_named_hook('set', hook, None)
 
2196
        self.addCleanup(
 
2197
            config.OldConfigHooks.uninstall_named_hook, 'set', None)
 
2198
        self.assertLength(0, calls)
 
2199
        conf.set_option(value, name)
 
2200
        self.assertLength(1, calls)
 
2201
        # We can't assert the conf object below as different configs use
 
2202
        # different means to implement set_user_option and we care only about
 
2203
        # coverage here.
 
2204
        self.assertEquals((name, value), calls[0][1:])
 
2205
 
 
2206
    def test_set_hook_remote_branch(self):
 
2207
        remote_branch = branch.Branch.open(self.get_url('tree'))
 
2208
        self.addCleanup(remote_branch.lock_write().unlock)
 
2209
        self.assertSetHook(remote_branch._get_config(), 'file', 'remote')
 
2210
 
 
2211
    def test_set_hook_remote_bzrdir(self):
 
2212
        remote_branch = branch.Branch.open(self.get_url('tree'))
 
2213
        self.addCleanup(remote_branch.lock_write().unlock)
 
2214
        remote_bzrdir = bzrdir.BzrDir.open(self.get_url('tree'))
 
2215
        self.assertSetHook(remote_bzrdir._get_config(), 'file', 'remotedir')
 
2216
 
 
2217
    def assertLoadHook(self, expected_nb_calls, name, conf_class, *conf_args):
 
2218
        calls = []
 
2219
        def hook(*args):
 
2220
            calls.append(args)
 
2221
        config.OldConfigHooks.install_named_hook('load', hook, None)
 
2222
        self.addCleanup(
 
2223
            config.OldConfigHooks.uninstall_named_hook, 'load', None)
 
2224
        self.assertLength(0, calls)
 
2225
        # Build a config
 
2226
        conf = conf_class(*conf_args)
 
2227
        # Access an option to trigger a load
 
2228
        conf.get_option(name)
 
2229
        self.assertLength(expected_nb_calls, calls)
 
2230
        # Since we can't assert about conf, we just use the number of calls ;-/
 
2231
 
 
2232
    def test_load_hook_remote_branch(self):
 
2233
        remote_branch = branch.Branch.open(self.get_url('tree'))
 
2234
        self.assertLoadHook(1, 'file', remote.RemoteBranchConfig, remote_branch)
 
2235
 
 
2236
    def test_load_hook_remote_bzrdir(self):
 
2237
        remote_bzrdir = bzrdir.BzrDir.open(self.get_url('tree'))
 
2238
        # The config file doesn't exist, set an option to force its creation
 
2239
        conf = remote_bzrdir._get_config()
 
2240
        conf.set_option('remotedir', 'file')
 
2241
        # We get one call for the server and one call for the client, this is
 
2242
        # caused by the differences in implementations betwen
 
2243
        # SmartServerBzrDirRequestConfigFile (in smart/bzrdir.py) and
 
2244
        # SmartServerBranchGetConfigFile (in smart/branch.py)
 
2245
        self.assertLoadHook(2 ,'file', remote.RemoteBzrDirConfig, remote_bzrdir)
 
2246
 
 
2247
    def assertSaveHook(self, conf):
 
2248
        calls = []
 
2249
        def hook(*args):
 
2250
            calls.append(args)
 
2251
        config.OldConfigHooks.install_named_hook('save', hook, None)
 
2252
        self.addCleanup(
 
2253
            config.OldConfigHooks.uninstall_named_hook, 'save', None)
 
2254
        self.assertLength(0, calls)
 
2255
        # Setting an option triggers a save
 
2256
        conf.set_option('foo', 'bar')
 
2257
        self.assertLength(1, calls)
 
2258
        # Since we can't assert about conf, we just use the number of calls ;-/
 
2259
 
 
2260
    def test_save_hook_remote_branch(self):
 
2261
        remote_branch = branch.Branch.open(self.get_url('tree'))
 
2262
        self.addCleanup(remote_branch.lock_write().unlock)
 
2263
        self.assertSaveHook(remote_branch._get_config())
 
2264
 
 
2265
    def test_save_hook_remote_bzrdir(self):
 
2266
        remote_branch = branch.Branch.open(self.get_url('tree'))
 
2267
        self.addCleanup(remote_branch.lock_write().unlock)
 
2268
        remote_bzrdir = bzrdir.BzrDir.open(self.get_url('tree'))
 
2269
        self.assertSaveHook(remote_bzrdir._get_config())
 
2270
 
 
2271
 
 
2272
class TestOption(tests.TestCase):
 
2273
 
 
2274
    def test_default_value(self):
 
2275
        opt = config.Option('foo', default='bar')
 
2276
        self.assertEquals('bar', opt.get_default())
 
2277
 
 
2278
    def test_default_value_from_env(self):
 
2279
        opt = config.Option('foo', default='bar', default_from_env=['FOO'])
 
2280
        self.overrideEnv('FOO', 'quux')
 
2281
        # Env variable provides a default taking over the option one
 
2282
        self.assertEquals('quux', opt.get_default())
 
2283
 
 
2284
    def test_first_default_value_from_env_wins(self):
 
2285
        opt = config.Option('foo', default='bar',
 
2286
                            default_from_env=['NO_VALUE', 'FOO', 'BAZ'])
 
2287
        self.overrideEnv('FOO', 'foo')
 
2288
        self.overrideEnv('BAZ', 'baz')
 
2289
        # The first env var set wins
 
2290
        self.assertEquals('foo', opt.get_default())
 
2291
 
 
2292
    def test_not_supported_list_default_value(self):
 
2293
        self.assertRaises(AssertionError, config.Option, 'foo', default=[1])
 
2294
 
 
2295
    def test_not_supported_object_default_value(self):
 
2296
        self.assertRaises(AssertionError, config.Option, 'foo',
 
2297
                          default=object())
 
2298
 
 
2299
 
 
2300
class TestOptionConverterMixin(object):
 
2301
 
 
2302
    def assertConverted(self, expected, opt, value):
 
2303
        self.assertEquals(expected, opt.convert_from_unicode(value))
 
2304
 
 
2305
    def assertWarns(self, opt, value):
 
2306
        warnings = []
 
2307
        def warning(*args):
 
2308
            warnings.append(args[0] % args[1:])
 
2309
        self.overrideAttr(trace, 'warning', warning)
 
2310
        self.assertEquals(None, opt.convert_from_unicode(value))
 
2311
        self.assertLength(1, warnings)
 
2312
        self.assertEquals(
 
2313
            'Value "%s" is not valid for "%s"' % (value, opt.name),
 
2314
            warnings[0])
 
2315
 
 
2316
    def assertErrors(self, opt, value):
 
2317
        self.assertRaises(errors.ConfigOptionValueError,
 
2318
                          opt.convert_from_unicode, value)
 
2319
 
 
2320
    def assertConvertInvalid(self, opt, invalid_value):
 
2321
        opt.invalid = None
 
2322
        self.assertEquals(None, opt.convert_from_unicode(invalid_value))
 
2323
        opt.invalid = 'warning'
 
2324
        self.assertWarns(opt, invalid_value)
 
2325
        opt.invalid = 'error'
 
2326
        self.assertErrors(opt, invalid_value)
 
2327
 
 
2328
 
 
2329
class TestOptionWithBooleanConverter(tests.TestCase, TestOptionConverterMixin):
 
2330
 
 
2331
    def get_option(self):
 
2332
        return config.Option('foo', help='A boolean.',
 
2333
                             from_unicode=config.bool_from_store)
 
2334
 
 
2335
    def test_convert_invalid(self):
 
2336
        opt = self.get_option()
 
2337
        # A string that is not recognized as a boolean
 
2338
        self.assertConvertInvalid(opt, u'invalid-boolean')
 
2339
        # A list of strings is never recognized as a boolean
 
2340
        self.assertConvertInvalid(opt, [u'not', u'a', u'boolean'])
 
2341
 
 
2342
    def test_convert_valid(self):
 
2343
        opt = self.get_option()
 
2344
        self.assertConverted(True, opt, u'True')
 
2345
        self.assertConverted(True, opt, u'1')
 
2346
        self.assertConverted(False, opt, u'False')
 
2347
 
 
2348
 
 
2349
class TestOptionWithIntegerConverter(tests.TestCase, TestOptionConverterMixin):
 
2350
 
 
2351
    def get_option(self):
 
2352
        return config.Option('foo', help='An integer.',
 
2353
                             from_unicode=config.int_from_store)
 
2354
 
 
2355
    def test_convert_invalid(self):
 
2356
        opt = self.get_option()
 
2357
        # A string that is not recognized as an integer
 
2358
        self.assertConvertInvalid(opt, u'forty-two')
 
2359
        # A list of strings is never recognized as an integer
 
2360
        self.assertConvertInvalid(opt, [u'a', u'list'])
 
2361
 
 
2362
    def test_convert_valid(self):
 
2363
        opt = self.get_option()
 
2364
        self.assertConverted(16, opt, u'16')
 
2365
 
 
2366
class TestOptionWithListConverter(tests.TestCase, TestOptionConverterMixin):
 
2367
 
 
2368
    def get_option(self):
 
2369
        return config.Option('foo', help='A list.',
 
2370
                             from_unicode=config.list_from_store)
 
2371
 
 
2372
    def test_convert_invalid(self):
 
2373
        # No string is invalid as all forms can be converted to a list
 
2374
        pass
 
2375
 
 
2376
    def test_convert_valid(self):
 
2377
        opt = self.get_option()
 
2378
        # An empty string is an empty list
 
2379
        self.assertConverted([], opt, '') # Using a bare str() just in case
 
2380
        self.assertConverted([], opt, u'')
 
2381
        # A boolean
 
2382
        self.assertConverted([u'True'], opt, u'True')
 
2383
        # An integer
 
2384
        self.assertConverted([u'42'], opt, u'42')
 
2385
        # A single string
 
2386
        self.assertConverted([u'bar'], opt, u'bar')
 
2387
        # A list remains a list (configObj will turn a string containing commas
 
2388
        # into a list, but that's not what we're testing here)
 
2389
        self.assertConverted([u'foo', u'1', u'True'],
 
2390
                             opt, [u'foo', u'1', u'True'])
 
2391
 
 
2392
 
 
2393
class TestOptionConverterMixin(object):
 
2394
 
 
2395
    def assertConverted(self, expected, opt, value):
 
2396
        self.assertEquals(expected, opt.convert_from_unicode(value))
 
2397
 
 
2398
    def assertWarns(self, opt, value):
 
2399
        warnings = []
 
2400
        def warning(*args):
 
2401
            warnings.append(args[0] % args[1:])
 
2402
        self.overrideAttr(trace, 'warning', warning)
 
2403
        self.assertEquals(None, opt.convert_from_unicode(value))
 
2404
        self.assertLength(1, warnings)
 
2405
        self.assertEquals(
 
2406
            'Value "%s" is not valid for "%s"' % (value, opt.name),
 
2407
            warnings[0])
 
2408
 
 
2409
    def assertErrors(self, opt, value):
 
2410
        self.assertRaises(errors.ConfigOptionValueError,
 
2411
                          opt.convert_from_unicode, value)
 
2412
 
 
2413
    def assertConvertInvalid(self, opt, invalid_value):
 
2414
        opt.invalid = None
 
2415
        self.assertEquals(None, opt.convert_from_unicode(invalid_value))
 
2416
        opt.invalid = 'warning'
 
2417
        self.assertWarns(opt, invalid_value)
 
2418
        opt.invalid = 'error'
 
2419
        self.assertErrors(opt, invalid_value)
 
2420
 
 
2421
 
 
2422
class TestOptionWithBooleanConverter(tests.TestCase, TestOptionConverterMixin):
 
2423
 
 
2424
    def get_option(self):
 
2425
        return config.Option('foo', help='A boolean.',
 
2426
                             from_unicode=config.bool_from_store)
 
2427
 
 
2428
    def test_convert_invalid(self):
 
2429
        opt = self.get_option()
 
2430
        # A string that is not recognized as a boolean
 
2431
        self.assertConvertInvalid(opt, u'invalid-boolean')
 
2432
        # A list of strings is never recognized as a boolean
 
2433
        self.assertConvertInvalid(opt, [u'not', u'a', u'boolean'])
 
2434
 
 
2435
    def test_convert_valid(self):
 
2436
        opt = self.get_option()
 
2437
        self.assertConverted(True, opt, u'True')
 
2438
        self.assertConverted(True, opt, u'1')
 
2439
        self.assertConverted(False, opt, u'False')
 
2440
 
 
2441
 
 
2442
class TestOptionWithIntegerConverter(tests.TestCase, TestOptionConverterMixin):
 
2443
 
 
2444
    def get_option(self):
 
2445
        return config.Option('foo', help='An integer.',
 
2446
                             from_unicode=config.int_from_store)
 
2447
 
 
2448
    def test_convert_invalid(self):
 
2449
        opt = self.get_option()
 
2450
        # A string that is not recognized as an integer
 
2451
        self.assertConvertInvalid(opt, u'forty-two')
 
2452
        # A list of strings is never recognized as an integer
 
2453
        self.assertConvertInvalid(opt, [u'a', u'list'])
 
2454
 
 
2455
    def test_convert_valid(self):
 
2456
        opt = self.get_option()
 
2457
        self.assertConverted(16, opt, u'16')
 
2458
 
 
2459
 
 
2460
class TestOptionWithListConverter(tests.TestCase, TestOptionConverterMixin):
 
2461
 
 
2462
    def get_option(self):
 
2463
        return config.Option('foo', help='A list.',
 
2464
                             from_unicode=config.list_from_store)
 
2465
 
 
2466
    def test_convert_invalid(self):
 
2467
        opt = self.get_option()
 
2468
        # We don't even try to convert a list into a list, we only expect
 
2469
        # strings
 
2470
        self.assertConvertInvalid(opt, [1])
 
2471
        # No string is invalid as all forms can be converted to a list
 
2472
 
 
2473
    def test_convert_valid(self):
 
2474
        opt = self.get_option()
 
2475
        # An empty string is an empty list
 
2476
        self.assertConverted([], opt, '') # Using a bare str() just in case
 
2477
        self.assertConverted([], opt, u'')
 
2478
        # A boolean
 
2479
        self.assertConverted([u'True'], opt, u'True')
 
2480
        # An integer
 
2481
        self.assertConverted([u'42'], opt, u'42')
 
2482
        # A single string
 
2483
        self.assertConverted([u'bar'], opt, u'bar')
 
2484
 
 
2485
 
 
2486
class TestOptionRegistry(tests.TestCase):
 
2487
 
 
2488
    def setUp(self):
 
2489
        super(TestOptionRegistry, self).setUp()
 
2490
        # Always start with an empty registry
 
2491
        self.overrideAttr(config, 'option_registry', config.OptionRegistry())
 
2492
        self.registry = config.option_registry
 
2493
 
 
2494
    def test_register(self):
 
2495
        opt = config.Option('foo')
 
2496
        self.registry.register(opt)
 
2497
        self.assertIs(opt, self.registry.get('foo'))
 
2498
 
 
2499
    def test_registered_help(self):
 
2500
        opt = config.Option('foo', help='A simple option')
 
2501
        self.registry.register(opt)
 
2502
        self.assertEquals('A simple option', self.registry.get_help('foo'))
 
2503
 
 
2504
    lazy_option = config.Option('lazy_foo', help='Lazy help')
 
2505
 
 
2506
    def test_register_lazy(self):
 
2507
        self.registry.register_lazy('lazy_foo', self.__module__,
 
2508
                                    'TestOptionRegistry.lazy_option')
 
2509
        self.assertIs(self.lazy_option, self.registry.get('lazy_foo'))
 
2510
 
 
2511
    def test_registered_lazy_help(self):
 
2512
        self.registry.register_lazy('lazy_foo', self.__module__,
 
2513
                                    'TestOptionRegistry.lazy_option')
 
2514
        self.assertEquals('Lazy help', self.registry.get_help('lazy_foo'))
 
2515
 
 
2516
 
 
2517
class TestRegisteredOptions(tests.TestCase):
 
2518
    """All registered options should verify some constraints."""
 
2519
 
 
2520
    scenarios = [(key, {'option_name': key, 'option': option}) for key, option
 
2521
                 in config.option_registry.iteritems()]
 
2522
 
 
2523
    def setUp(self):
 
2524
        super(TestRegisteredOptions, self).setUp()
 
2525
        self.registry = config.option_registry
 
2526
 
 
2527
    def test_proper_name(self):
 
2528
        # An option should be registered under its own name, this can't be
 
2529
        # checked at registration time for the lazy ones.
 
2530
        self.assertEquals(self.option_name, self.option.name)
 
2531
 
 
2532
    def test_help_is_set(self):
 
2533
        option_help = self.registry.get_help(self.option_name)
 
2534
        self.assertNotEquals(None, option_help)
 
2535
        # Come on, think about the user, he really wants to know what the
 
2536
        # option is about
 
2537
        self.assertIsNot(None, option_help)
 
2538
        self.assertNotEquals('', option_help)
 
2539
 
 
2540
 
 
2541
class TestSection(tests.TestCase):
 
2542
 
 
2543
    # FIXME: Parametrize so that all sections produced by Stores run these
 
2544
    # tests -- vila 2011-04-01
 
2545
 
 
2546
    def test_get_a_value(self):
 
2547
        a_dict = dict(foo='bar')
 
2548
        section = config.Section('myID', a_dict)
 
2549
        self.assertEquals('bar', section.get('foo'))
 
2550
 
 
2551
    def test_get_unknown_option(self):
 
2552
        a_dict = dict()
 
2553
        section = config.Section(None, a_dict)
 
2554
        self.assertEquals('out of thin air',
 
2555
                          section.get('foo', 'out of thin air'))
 
2556
 
 
2557
    def test_options_is_shared(self):
 
2558
        a_dict = dict()
 
2559
        section = config.Section(None, a_dict)
 
2560
        self.assertIs(a_dict, section.options)
 
2561
 
 
2562
 
 
2563
class TestMutableSection(tests.TestCase):
 
2564
 
 
2565
    # FIXME: Parametrize so that all sections (including os.environ and the
 
2566
    # ones produced by Stores) run these tests -- vila 2011-04-01
 
2567
 
 
2568
    def test_set(self):
 
2569
        a_dict = dict(foo='bar')
 
2570
        section = config.MutableSection('myID', a_dict)
 
2571
        section.set('foo', 'new_value')
 
2572
        self.assertEquals('new_value', section.get('foo'))
 
2573
        # The change appears in the shared section
 
2574
        self.assertEquals('new_value', a_dict.get('foo'))
 
2575
        # We keep track of the change
 
2576
        self.assertTrue('foo' in section.orig)
 
2577
        self.assertEquals('bar', section.orig.get('foo'))
 
2578
 
 
2579
    def test_set_preserve_original_once(self):
 
2580
        a_dict = dict(foo='bar')
 
2581
        section = config.MutableSection('myID', a_dict)
 
2582
        section.set('foo', 'first_value')
 
2583
        section.set('foo', 'second_value')
 
2584
        # We keep track of the original value
 
2585
        self.assertTrue('foo' in section.orig)
 
2586
        self.assertEquals('bar', section.orig.get('foo'))
 
2587
 
 
2588
    def test_remove(self):
 
2589
        a_dict = dict(foo='bar')
 
2590
        section = config.MutableSection('myID', a_dict)
 
2591
        section.remove('foo')
 
2592
        # We get None for unknown options via the default value
 
2593
        self.assertEquals(None, section.get('foo'))
 
2594
        # Or we just get the default value
 
2595
        self.assertEquals('unknown', section.get('foo', 'unknown'))
 
2596
        self.assertFalse('foo' in section.options)
 
2597
        # We keep track of the deletion
 
2598
        self.assertTrue('foo' in section.orig)
 
2599
        self.assertEquals('bar', section.orig.get('foo'))
 
2600
 
 
2601
    def test_remove_new_option(self):
 
2602
        a_dict = dict()
 
2603
        section = config.MutableSection('myID', a_dict)
 
2604
        section.set('foo', 'bar')
 
2605
        section.remove('foo')
 
2606
        self.assertFalse('foo' in section.options)
 
2607
        # The option didn't exist initially so it we need to keep track of it
 
2608
        # with a special value
 
2609
        self.assertTrue('foo' in section.orig)
 
2610
        self.assertEquals(config._NewlyCreatedOption, section.orig['foo'])
 
2611
 
 
2612
 
 
2613
class TestStore(tests.TestCaseWithTransport):
 
2614
 
 
2615
    def assertSectionContent(self, expected, section):
 
2616
        """Assert that some options have the proper values in a section."""
 
2617
        expected_name, expected_options = expected
 
2618
        self.assertEquals(expected_name, section.id)
 
2619
        self.assertEquals(
 
2620
            expected_options,
 
2621
            dict([(k, section.get(k)) for k in expected_options.keys()]))
 
2622
 
 
2623
 
 
2624
class TestReadonlyStore(TestStore):
 
2625
 
 
2626
    scenarios = [(key, {'get_store': builder}) for key, builder
 
2627
                 in config.test_store_builder_registry.iteritems()]
 
2628
 
 
2629
    def test_building_delays_load(self):
 
2630
        store = self.get_store(self)
 
2631
        self.assertEquals(False, store.is_loaded())
 
2632
        store._load_from_string('')
 
2633
        self.assertEquals(True, store.is_loaded())
 
2634
 
 
2635
    def test_get_no_sections_for_empty(self):
 
2636
        store = self.get_store(self)
 
2637
        store._load_from_string('')
 
2638
        self.assertEquals([], list(store.get_sections()))
 
2639
 
 
2640
    def test_get_default_section(self):
 
2641
        store = self.get_store(self)
 
2642
        store._load_from_string('foo=bar')
 
2643
        sections = list(store.get_sections())
 
2644
        self.assertLength(1, sections)
 
2645
        self.assertSectionContent((None, {'foo': 'bar'}), sections[0])
 
2646
 
 
2647
    def test_get_named_section(self):
 
2648
        store = self.get_store(self)
 
2649
        store._load_from_string('[baz]\nfoo=bar')
 
2650
        sections = list(store.get_sections())
 
2651
        self.assertLength(1, sections)
 
2652
        self.assertSectionContent(('baz', {'foo': 'bar'}), sections[0])
 
2653
 
 
2654
    def test_load_from_string_fails_for_non_empty_store(self):
 
2655
        store = self.get_store(self)
 
2656
        store._load_from_string('foo=bar')
 
2657
        self.assertRaises(AssertionError, store._load_from_string, 'bar=baz')
 
2658
 
 
2659
 
 
2660
class TestIniFileStoreContent(tests.TestCaseWithTransport):
 
2661
    """Simulate loading a config store with content of various encodings.
 
2662
 
 
2663
    All files produced by bzr are in utf8 content.
 
2664
 
 
2665
    Users may modify them manually and end up with a file that can't be
 
2666
    loaded. We need to issue proper error messages in this case.
 
2667
    """
 
2668
 
 
2669
    invalid_utf8_char = '\xff'
 
2670
 
 
2671
    def test_load_utf8(self):
 
2672
        """Ensure we can load an utf8-encoded file."""
 
2673
        t = self.get_transport()
 
2674
        # From http://pad.lv/799212
 
2675
        unicode_user = u'b\N{Euro Sign}ar'
 
2676
        unicode_content = u'user=%s' % (unicode_user,)
 
2677
        utf8_content = unicode_content.encode('utf8')
 
2678
        # Store the raw content in the config file
 
2679
        t.put_bytes('foo.conf', utf8_content)
 
2680
        store = config.IniFileStore(t, 'foo.conf')
 
2681
        store.load()
 
2682
        stack = config.Stack([store.get_sections], store)
 
2683
        self.assertEquals(unicode_user, stack.get('user'))
 
2684
 
 
2685
    def test_load_non_ascii(self):
 
2686
        """Ensure we display a proper error on non-ascii, non utf-8 content."""
 
2687
        t = self.get_transport()
 
2688
        t.put_bytes('foo.conf', 'user=foo\n#%s\n' % (self.invalid_utf8_char,))
 
2689
        store = config.IniFileStore(t, 'foo.conf')
 
2690
        self.assertRaises(errors.ConfigContentError, store.load)
 
2691
 
 
2692
    def test_load_erroneous_content(self):
 
2693
        """Ensure we display a proper error on content that can't be parsed."""
 
2694
        t = self.get_transport()
 
2695
        t.put_bytes('foo.conf', '[open_section\n')
 
2696
        store = config.IniFileStore(t, 'foo.conf')
 
2697
        self.assertRaises(errors.ParseConfigError, store.load)
 
2698
 
 
2699
    def test_load_permission_denied(self):
 
2700
        """Ensure we get warned when trying to load an inaccessible file."""
 
2701
        warnings = []
 
2702
        def warning(*args):
 
2703
            warnings.append(args[0] % args[1:])
 
2704
        self.overrideAttr(trace, 'warning', warning)
 
2705
 
 
2706
        t = self.get_transport()
 
2707
 
 
2708
        def get_bytes(relpath):
 
2709
            raise errors.PermissionDenied(relpath, "")
 
2710
        t.get_bytes = get_bytes
 
2711
        store = config.IniFileStore(t, 'foo.conf')
 
2712
        self.assertRaises(errors.PermissionDenied, store.load)
 
2713
        self.assertEquals(
 
2714
            warnings,
 
2715
            [u'Permission denied while trying to load configuration store %s.'
 
2716
             % store.external_url()])
 
2717
 
 
2718
 
 
2719
class TestIniConfigContent(tests.TestCaseWithTransport):
 
2720
    """Simulate loading a IniBasedConfig with content of various encodings.
 
2721
 
 
2722
    All files produced by bzr are in utf8 content.
 
2723
 
 
2724
    Users may modify them manually and end up with a file that can't be
 
2725
    loaded. We need to issue proper error messages in this case.
 
2726
    """
 
2727
 
 
2728
    invalid_utf8_char = '\xff'
 
2729
 
 
2730
    def test_load_utf8(self):
 
2731
        """Ensure we can load an utf8-encoded file."""
 
2732
        # From http://pad.lv/799212
 
2733
        unicode_user = u'b\N{Euro Sign}ar'
 
2734
        unicode_content = u'user=%s' % (unicode_user,)
 
2735
        utf8_content = unicode_content.encode('utf8')
 
2736
        # Store the raw content in the config file
 
2737
        with open('foo.conf', 'wb') as f:
 
2738
            f.write(utf8_content)
 
2739
        conf = config.IniBasedConfig(file_name='foo.conf')
 
2740
        self.assertEquals(unicode_user, conf.get_user_option('user'))
 
2741
 
 
2742
    def test_load_badly_encoded_content(self):
 
2743
        """Ensure we display a proper error on non-ascii, non utf-8 content."""
 
2744
        with open('foo.conf', 'wb') as f:
 
2745
            f.write('user=foo\n#%s\n' % (self.invalid_utf8_char,))
 
2746
        conf = config.IniBasedConfig(file_name='foo.conf')
 
2747
        self.assertRaises(errors.ConfigContentError, conf._get_parser)
 
2748
 
 
2749
    def test_load_erroneous_content(self):
 
2750
        """Ensure we display a proper error on content that can't be parsed."""
 
2751
        with open('foo.conf', 'wb') as f:
 
2752
            f.write('[open_section\n')
 
2753
        conf = config.IniBasedConfig(file_name='foo.conf')
 
2754
        self.assertRaises(errors.ParseConfigError, conf._get_parser)
 
2755
 
 
2756
 
 
2757
class TestMutableStore(TestStore):
 
2758
 
 
2759
    scenarios = [(key, {'store_id': key, 'get_store': builder}) for key, builder
 
2760
                 in config.test_store_builder_registry.iteritems()]
 
2761
 
 
2762
    def setUp(self):
 
2763
        super(TestMutableStore, self).setUp()
 
2764
        self.transport = self.get_transport()
 
2765
 
 
2766
    def has_store(self, store):
 
2767
        store_basename = urlutils.relative_url(self.transport.external_url(),
 
2768
                                               store.external_url())
 
2769
        return self.transport.has(store_basename)
 
2770
 
 
2771
    def test_save_empty_creates_no_file(self):
 
2772
        # FIXME: There should be a better way than relying on the test
 
2773
        # parametrization to identify branch.conf -- vila 2011-0526
 
2774
        if self.store_id in ('branch', 'remote_branch'):
 
2775
            raise tests.TestNotApplicable(
 
2776
                'branch.conf is *always* created when a branch is initialized')
 
2777
        store = self.get_store(self)
 
2778
        store.save()
 
2779
        self.assertEquals(False, self.has_store(store))
 
2780
 
 
2781
    def test_save_emptied_succeeds(self):
 
2782
        store = self.get_store(self)
 
2783
        store._load_from_string('foo=bar\n')
 
2784
        section = store.get_mutable_section(None)
 
2785
        section.remove('foo')
 
2786
        store.save()
 
2787
        self.assertEquals(True, self.has_store(store))
 
2788
        modified_store = self.get_store(self)
 
2789
        sections = list(modified_store.get_sections())
 
2790
        self.assertLength(0, sections)
 
2791
 
 
2792
    def test_save_with_content_succeeds(self):
 
2793
        # FIXME: There should be a better way than relying on the test
 
2794
        # parametrization to identify branch.conf -- vila 2011-0526
 
2795
        if self.store_id in ('branch', 'remote_branch'):
 
2796
            raise tests.TestNotApplicable(
 
2797
                'branch.conf is *always* created when a branch is initialized')
 
2798
        store = self.get_store(self)
 
2799
        store._load_from_string('foo=bar\n')
 
2800
        self.assertEquals(False, self.has_store(store))
 
2801
        store.save()
 
2802
        self.assertEquals(True, self.has_store(store))
 
2803
        modified_store = self.get_store(self)
 
2804
        sections = list(modified_store.get_sections())
 
2805
        self.assertLength(1, sections)
 
2806
        self.assertSectionContent((None, {'foo': 'bar'}), sections[0])
 
2807
 
 
2808
    def test_set_option_in_empty_store(self):
 
2809
        store = self.get_store(self)
 
2810
        section = store.get_mutable_section(None)
 
2811
        section.set('foo', 'bar')
 
2812
        store.save()
 
2813
        modified_store = self.get_store(self)
 
2814
        sections = list(modified_store.get_sections())
 
2815
        self.assertLength(1, sections)
 
2816
        self.assertSectionContent((None, {'foo': 'bar'}), sections[0])
 
2817
 
 
2818
    def test_set_option_in_default_section(self):
 
2819
        store = self.get_store(self)
 
2820
        store._load_from_string('')
 
2821
        section = store.get_mutable_section(None)
 
2822
        section.set('foo', 'bar')
 
2823
        store.save()
 
2824
        modified_store = self.get_store(self)
 
2825
        sections = list(modified_store.get_sections())
 
2826
        self.assertLength(1, sections)
 
2827
        self.assertSectionContent((None, {'foo': 'bar'}), sections[0])
 
2828
 
 
2829
    def test_set_option_in_named_section(self):
 
2830
        store = self.get_store(self)
 
2831
        store._load_from_string('')
 
2832
        section = store.get_mutable_section('baz')
 
2833
        section.set('foo', 'bar')
 
2834
        store.save()
 
2835
        modified_store = self.get_store(self)
 
2836
        sections = list(modified_store.get_sections())
 
2837
        self.assertLength(1, sections)
 
2838
        self.assertSectionContent(('baz', {'foo': 'bar'}), sections[0])
 
2839
 
 
2840
    def test_load_hook(self):
 
2841
        # We first needs to ensure that the store exists
 
2842
        store = self.get_store(self)
 
2843
        section = store.get_mutable_section('baz')
 
2844
        section.set('foo', 'bar')
 
2845
        store.save()
 
2846
        # Now we can try to load it
 
2847
        store = self.get_store(self)
 
2848
        calls = []
 
2849
        def hook(*args):
 
2850
            calls.append(args)
 
2851
        config.ConfigHooks.install_named_hook('load', hook, None)
 
2852
        self.assertLength(0, calls)
 
2853
        store.load()
 
2854
        self.assertLength(1, calls)
 
2855
        self.assertEquals((store,), calls[0])
 
2856
 
 
2857
    def test_save_hook(self):
 
2858
        calls = []
 
2859
        def hook(*args):
 
2860
            calls.append(args)
 
2861
        config.ConfigHooks.install_named_hook('save', hook, None)
 
2862
        self.assertLength(0, calls)
 
2863
        store = self.get_store(self)
 
2864
        section = store.get_mutable_section('baz')
 
2865
        section.set('foo', 'bar')
 
2866
        store.save()
 
2867
        self.assertLength(1, calls)
 
2868
        self.assertEquals((store,), calls[0])
 
2869
 
 
2870
 
 
2871
class TestIniFileStore(TestStore):
 
2872
 
 
2873
    def test_loading_unknown_file_fails(self):
 
2874
        store = config.IniFileStore(self.get_transport(), 'I-do-not-exist')
 
2875
        self.assertRaises(errors.NoSuchFile, store.load)
 
2876
 
 
2877
    def test_invalid_content(self):
 
2878
        store = config.IniFileStore(self.get_transport(), 'foo.conf', )
 
2879
        self.assertEquals(False, store.is_loaded())
 
2880
        exc = self.assertRaises(
 
2881
            errors.ParseConfigError, store._load_from_string,
 
2882
            'this is invalid !')
 
2883
        self.assertEndsWith(exc.filename, 'foo.conf')
 
2884
        # And the load failed
 
2885
        self.assertEquals(False, store.is_loaded())
 
2886
 
 
2887
    def test_get_embedded_sections(self):
 
2888
        # A more complicated example (which also shows that section names and
 
2889
        # option names share the same name space...)
 
2890
        # FIXME: This should be fixed by forbidding dicts as values ?
 
2891
        # -- vila 2011-04-05
 
2892
        store = config.IniFileStore(self.get_transport(), 'foo.conf', )
 
2893
        store._load_from_string('''
 
2894
foo=bar
 
2895
l=1,2
 
2896
[DEFAULT]
 
2897
foo_in_DEFAULT=foo_DEFAULT
 
2898
[bar]
 
2899
foo_in_bar=barbar
 
2900
[baz]
 
2901
foo_in_baz=barbaz
 
2902
[[qux]]
 
2903
foo_in_qux=quux
 
2904
''')
 
2905
        sections = list(store.get_sections())
 
2906
        self.assertLength(4, sections)
 
2907
        # The default section has no name.
 
2908
        # List values are provided as strings and need to be explicitly
 
2909
        # converted by specifying from_unicode=list_from_store at option
 
2910
        # registration
 
2911
        self.assertSectionContent((None, {'foo': 'bar', 'l': u'1,2'}),
 
2912
                                  sections[0])
 
2913
        self.assertSectionContent(
 
2914
            ('DEFAULT', {'foo_in_DEFAULT': 'foo_DEFAULT'}), sections[1])
 
2915
        self.assertSectionContent(
 
2916
            ('bar', {'foo_in_bar': 'barbar'}), sections[2])
 
2917
        # sub sections are provided as embedded dicts.
 
2918
        self.assertSectionContent(
 
2919
            ('baz', {'foo_in_baz': 'barbaz', 'qux': {'foo_in_qux': 'quux'}}),
 
2920
            sections[3])
 
2921
 
 
2922
 
 
2923
class TestLockableIniFileStore(TestStore):
 
2924
 
 
2925
    def test_create_store_in_created_dir(self):
 
2926
        self.assertPathDoesNotExist('dir')
 
2927
        t = self.get_transport('dir/subdir')
 
2928
        store = config.LockableIniFileStore(t, 'foo.conf')
 
2929
        store.get_mutable_section(None).set('foo', 'bar')
 
2930
        store.save()
 
2931
        self.assertPathExists('dir/subdir')
 
2932
 
 
2933
 
 
2934
class TestConcurrentStoreUpdates(TestStore):
 
2935
    """Test that Stores properly handle conccurent updates.
 
2936
 
 
2937
    New Store implementation may fail some of these tests but until such
 
2938
    implementations exist it's hard to properly filter them from the scenarios
 
2939
    applied here. If you encounter such a case, contact the bzr devs.
 
2940
    """
 
2941
 
 
2942
    scenarios = [(key, {'get_stack': builder}) for key, builder
 
2943
                 in config.test_stack_builder_registry.iteritems()]
 
2944
 
 
2945
    def setUp(self):
 
2946
        super(TestConcurrentStoreUpdates, self).setUp()
 
2947
        self._content = 'one=1\ntwo=2\n'
 
2948
        self.stack = self.get_stack(self)
 
2949
        if not isinstance(self.stack, config._CompatibleStack):
 
2950
            raise tests.TestNotApplicable(
 
2951
                '%s is not meant to be compatible with the old config design'
 
2952
                % (self.stack,))
 
2953
        self.stack.store._load_from_string(self._content)
 
2954
        # Flush the store
 
2955
        self.stack.store.save()
 
2956
 
 
2957
    def test_simple_read_access(self):
 
2958
        self.assertEquals('1', self.stack.get('one'))
 
2959
 
 
2960
    def test_simple_write_access(self):
 
2961
        self.stack.set('one', 'one')
 
2962
        self.assertEquals('one', self.stack.get('one'))
 
2963
 
 
2964
    def test_listen_to_the_last_speaker(self):
 
2965
        c1 = self.stack
 
2966
        c2 = self.get_stack(self)
 
2967
        c1.set('one', 'ONE')
 
2968
        c2.set('two', 'TWO')
 
2969
        self.assertEquals('ONE', c1.get('one'))
 
2970
        self.assertEquals('TWO', c2.get('two'))
 
2971
        # The second update respect the first one
 
2972
        self.assertEquals('ONE', c2.get('one'))
 
2973
 
 
2974
    def test_last_speaker_wins(self):
 
2975
        # If the same config is not shared, the same variable modified twice
 
2976
        # can only see a single result.
 
2977
        c1 = self.stack
 
2978
        c2 = self.get_stack(self)
 
2979
        c1.set('one', 'c1')
 
2980
        c2.set('one', 'c2')
 
2981
        self.assertEquals('c2', c2.get('one'))
 
2982
        # The first modification is still available until another refresh
 
2983
        # occur
 
2984
        self.assertEquals('c1', c1.get('one'))
 
2985
        c1.set('two', 'done')
 
2986
        self.assertEquals('c2', c1.get('one'))
 
2987
 
 
2988
    def test_writes_are_serialized(self):
 
2989
        c1 = self.stack
 
2990
        c2 = self.get_stack(self)
 
2991
 
 
2992
        # We spawn a thread that will pause *during* the config saving.
 
2993
        before_writing = threading.Event()
 
2994
        after_writing = threading.Event()
 
2995
        writing_done = threading.Event()
 
2996
        c1_save_without_locking_orig = c1.store.save_without_locking
 
2997
        def c1_save_without_locking():
 
2998
            before_writing.set()
 
2999
            c1_save_without_locking_orig()
 
3000
            # The lock is held. We wait for the main thread to decide when to
 
3001
            # continue
 
3002
            after_writing.wait()
 
3003
        c1.store.save_without_locking = c1_save_without_locking
 
3004
        def c1_set():
 
3005
            c1.set('one', 'c1')
 
3006
            writing_done.set()
 
3007
        t1 = threading.Thread(target=c1_set)
 
3008
        # Collect the thread after the test
 
3009
        self.addCleanup(t1.join)
 
3010
        # Be ready to unblock the thread if the test goes wrong
 
3011
        self.addCleanup(after_writing.set)
 
3012
        t1.start()
 
3013
        before_writing.wait()
 
3014
        self.assertRaises(errors.LockContention,
 
3015
                          c2.set, 'one', 'c2')
 
3016
        self.assertEquals('c1', c1.get('one'))
 
3017
        # Let the lock be released
 
3018
        after_writing.set()
 
3019
        writing_done.wait()
 
3020
        c2.set('one', 'c2')
 
3021
        self.assertEquals('c2', c2.get('one'))
 
3022
 
 
3023
    def test_read_while_writing(self):
 
3024
       c1 = self.stack
 
3025
       # We spawn a thread that will pause *during* the write
 
3026
       ready_to_write = threading.Event()
 
3027
       do_writing = threading.Event()
 
3028
       writing_done = threading.Event()
 
3029
       # We override the _save implementation so we know the store is locked
 
3030
       c1_save_without_locking_orig = c1.store.save_without_locking
 
3031
       def c1_save_without_locking():
 
3032
           ready_to_write.set()
 
3033
           # The lock is held. We wait for the main thread to decide when to
 
3034
           # continue
 
3035
           do_writing.wait()
 
3036
           c1_save_without_locking_orig()
 
3037
           writing_done.set()
 
3038
       c1.store.save_without_locking = c1_save_without_locking
 
3039
       def c1_set():
 
3040
           c1.set('one', 'c1')
 
3041
       t1 = threading.Thread(target=c1_set)
 
3042
       # Collect the thread after the test
 
3043
       self.addCleanup(t1.join)
 
3044
       # Be ready to unblock the thread if the test goes wrong
 
3045
       self.addCleanup(do_writing.set)
 
3046
       t1.start()
 
3047
       # Ensure the thread is ready to write
 
3048
       ready_to_write.wait()
 
3049
       self.assertEquals('c1', c1.get('one'))
 
3050
       # If we read during the write, we get the old value
 
3051
       c2 = self.get_stack(self)
 
3052
       self.assertEquals('1', c2.get('one'))
 
3053
       # Let the writing occur and ensure it occurred
 
3054
       do_writing.set()
 
3055
       writing_done.wait()
 
3056
       # Now we get the updated value
 
3057
       c3 = self.get_stack(self)
 
3058
       self.assertEquals('c1', c3.get('one'))
 
3059
 
 
3060
    # FIXME: It may be worth looking into removing the lock dir when it's not
 
3061
    # needed anymore and look at possible fallouts for concurrent lockers. This
 
3062
    # will matter if/when we use config files outside of bazaar directories
 
3063
    # (.bazaar or .bzr) -- vila 20110-04-111
 
3064
 
 
3065
 
 
3066
class TestSectionMatcher(TestStore):
 
3067
 
 
3068
    scenarios = [('location', {'matcher': config.LocationMatcher}),
 
3069
                 ('id', {'matcher': config.NameMatcher}),]
 
3070
 
 
3071
    def get_store(self, file_name):
 
3072
        return config.IniFileStore(self.get_readonly_transport(), file_name)
 
3073
 
 
3074
    def test_no_matches_for_empty_stores(self):
 
3075
        store = self.get_store('foo.conf')
 
3076
        store._load_from_string('')
 
3077
        matcher = self.matcher(store, '/bar')
 
3078
        self.assertEquals([], list(matcher.get_sections()))
 
3079
 
 
3080
    def test_build_doesnt_load_store(self):
 
3081
        store = self.get_store('foo.conf')
 
3082
        matcher = self.matcher(store, '/bar')
 
3083
        self.assertFalse(store.is_loaded())
 
3084
 
 
3085
 
 
3086
class TestLocationSection(tests.TestCase):
 
3087
 
 
3088
    def get_section(self, options, extra_path):
 
3089
        section = config.Section('foo', options)
 
3090
        # We don't care about the length so we use '0'
 
3091
        return config.LocationSection(section, 0, extra_path)
 
3092
 
 
3093
    def test_simple_option(self):
 
3094
        section = self.get_section({'foo': 'bar'}, '')
 
3095
        self.assertEquals('bar', section.get('foo'))
 
3096
 
 
3097
    def test_option_with_extra_path(self):
 
3098
        section = self.get_section({'foo': 'bar', 'foo:policy': 'appendpath'},
 
3099
                                   'baz')
 
3100
        self.assertEquals('bar/baz', section.get('foo'))
 
3101
 
 
3102
    def test_invalid_policy(self):
 
3103
        section = self.get_section({'foo': 'bar', 'foo:policy': 'die'},
 
3104
                                   'baz')
 
3105
        # invalid policies are ignored
 
3106
        self.assertEquals('bar', section.get('foo'))
 
3107
 
 
3108
 
 
3109
class TestLocationMatcher(TestStore):
 
3110
 
 
3111
    def get_store(self, file_name):
 
3112
        return config.IniFileStore(self.get_readonly_transport(), file_name)
 
3113
 
 
3114
    def test_unrelated_section_excluded(self):
 
3115
        store = self.get_store('foo.conf')
 
3116
        store._load_from_string('''
 
3117
[/foo]
 
3118
section=/foo
 
3119
[/foo/baz]
 
3120
section=/foo/baz
 
3121
[/foo/bar]
 
3122
section=/foo/bar
 
3123
[/foo/bar/baz]
 
3124
section=/foo/bar/baz
 
3125
[/quux/quux]
 
3126
section=/quux/quux
 
3127
''')
 
3128
        self.assertEquals(['/foo', '/foo/baz', '/foo/bar', '/foo/bar/baz',
 
3129
                           '/quux/quux'],
 
3130
                          [section.id for section in store.get_sections()])
 
3131
        matcher = config.LocationMatcher(store, '/foo/bar/quux')
 
3132
        sections = list(matcher.get_sections())
 
3133
        self.assertEquals([3, 2],
 
3134
                          [section.length for section in sections])
 
3135
        self.assertEquals(['/foo/bar', '/foo'],
 
3136
                          [section.id for section in sections])
 
3137
        self.assertEquals(['quux', 'bar/quux'],
 
3138
                          [section.extra_path for section in sections])
 
3139
 
 
3140
    def test_more_specific_sections_first(self):
 
3141
        store = self.get_store('foo.conf')
 
3142
        store._load_from_string('''
 
3143
[/foo]
 
3144
section=/foo
 
3145
[/foo/bar]
 
3146
section=/foo/bar
 
3147
''')
 
3148
        self.assertEquals(['/foo', '/foo/bar'],
 
3149
                          [section.id for section in store.get_sections()])
 
3150
        matcher = config.LocationMatcher(store, '/foo/bar/baz')
 
3151
        sections = list(matcher.get_sections())
 
3152
        self.assertEquals([3, 2],
 
3153
                          [section.length for section in sections])
 
3154
        self.assertEquals(['/foo/bar', '/foo'],
 
3155
                          [section.id for section in sections])
 
3156
        self.assertEquals(['baz', 'bar/baz'],
 
3157
                          [section.extra_path for section in sections])
 
3158
 
 
3159
    def test_appendpath_in_no_name_section(self):
 
3160
        # It's a bit weird to allow appendpath in a no-name section, but
 
3161
        # someone may found a use for it
 
3162
        store = self.get_store('foo.conf')
 
3163
        store._load_from_string('''
 
3164
foo=bar
 
3165
foo:policy = appendpath
 
3166
''')
 
3167
        matcher = config.LocationMatcher(store, 'dir/subdir')
 
3168
        sections = list(matcher.get_sections())
 
3169
        self.assertLength(1, sections)
 
3170
        self.assertEquals('bar/dir/subdir', sections[0].get('foo'))
 
3171
 
 
3172
    def test_file_urls_are_normalized(self):
 
3173
        store = self.get_store('foo.conf')
 
3174
        if sys.platform == 'win32':
 
3175
            expected_url = 'file:///C:/dir/subdir'
 
3176
            expected_location = 'C:/dir/subdir'
 
3177
        else:
 
3178
            expected_url = 'file:///dir/subdir'
 
3179
            expected_location = '/dir/subdir'
 
3180
        matcher = config.LocationMatcher(store, expected_url)
 
3181
        self.assertEquals(expected_location, matcher.location)
 
3182
 
 
3183
 
 
3184
class TestNameMatcher(TestStore):
 
3185
 
 
3186
    def setUp(self):
 
3187
        super(TestNameMatcher, self).setUp()
 
3188
        self.store = config.IniFileStore(self.get_readonly_transport(),
 
3189
                                         'foo.conf')
 
3190
        self.store._load_from_string('''
 
3191
[foo]
 
3192
option=foo
 
3193
[foo/baz]
 
3194
option=foo/baz
 
3195
[bar]
 
3196
option=bar
 
3197
''')
 
3198
 
 
3199
    def get_matching_sections(self, name):
 
3200
        matcher = config.NameMatcher(self.store, name)
 
3201
        return list(matcher.get_sections())
 
3202
 
 
3203
    def test_matching(self):
 
3204
        sections = self.get_matching_sections('foo')
 
3205
        self.assertLength(1, sections)
 
3206
        self.assertSectionContent(('foo', {'option': 'foo'}), sections[0])
 
3207
 
 
3208
    def test_not_matching(self):
 
3209
        sections = self.get_matching_sections('baz')
 
3210
        self.assertLength(0, sections)
 
3211
 
 
3212
 
 
3213
class TestStackGet(tests.TestCase):
 
3214
 
 
3215
    # FIXME: This should be parametrized for all known Stack or dedicated
 
3216
    # paramerized tests created to avoid bloating -- vila 2011-03-31
 
3217
 
 
3218
    def overrideOptionRegistry(self):
 
3219
        self.overrideAttr(config, 'option_registry', config.OptionRegistry())
 
3220
 
 
3221
    def test_single_config_get(self):
 
3222
        conf = dict(foo='bar')
 
3223
        conf_stack = config.Stack([conf])
 
3224
        self.assertEquals('bar', conf_stack.get('foo'))
 
3225
 
 
3226
    def test_get_with_registered_default_value(self):
 
3227
        conf_stack = config.Stack([dict()])
 
3228
        opt = config.Option('foo', default='bar')
 
3229
        self.overrideOptionRegistry()
 
3230
        config.option_registry.register('foo', opt)
 
3231
        self.assertEquals('bar', conf_stack.get('foo'))
 
3232
 
 
3233
    def test_get_without_registered_default_value(self):
 
3234
        conf_stack = config.Stack([dict()])
 
3235
        opt = config.Option('foo')
 
3236
        self.overrideOptionRegistry()
 
3237
        config.option_registry.register('foo', opt)
 
3238
        self.assertEquals(None, conf_stack.get('foo'))
 
3239
 
 
3240
    def test_get_without_default_value_for_not_registered(self):
 
3241
        conf_stack = config.Stack([dict()])
 
3242
        opt = config.Option('foo')
 
3243
        self.overrideOptionRegistry()
 
3244
        self.assertEquals(None, conf_stack.get('foo'))
 
3245
 
 
3246
    def test_get_first_definition(self):
 
3247
        conf1 = dict(foo='bar')
 
3248
        conf2 = dict(foo='baz')
 
3249
        conf_stack = config.Stack([conf1, conf2])
 
3250
        self.assertEquals('bar', conf_stack.get('foo'))
 
3251
 
 
3252
    def test_get_embedded_definition(self):
 
3253
        conf1 = dict(yy='12')
 
3254
        conf2 = config.Stack([dict(xx='42'), dict(foo='baz')])
 
3255
        conf_stack = config.Stack([conf1, conf2])
 
3256
        self.assertEquals('baz', conf_stack.get('foo'))
 
3257
 
 
3258
    def test_get_for_empty_section_callable(self):
 
3259
        conf_stack = config.Stack([lambda : []])
 
3260
        self.assertEquals(None, conf_stack.get('foo'))
 
3261
 
 
3262
    def test_get_for_broken_callable(self):
 
3263
        # Trying to use and invalid callable raises an exception on first use
 
3264
        conf_stack = config.Stack([lambda : object()])
 
3265
        self.assertRaises(TypeError, conf_stack.get, 'foo')
 
3266
 
 
3267
 
 
3268
class TestStackWithTransport(tests.TestCaseWithTransport):
 
3269
 
 
3270
    scenarios = [(key, {'get_stack': builder}) for key, builder
 
3271
                 in config.test_stack_builder_registry.iteritems()]
 
3272
 
 
3273
 
 
3274
class TestConcreteStacks(TestStackWithTransport):
 
3275
 
 
3276
    def test_build_stack(self):
 
3277
        # Just a smoke test to help debug builders
 
3278
        stack = self.get_stack(self)
 
3279
 
 
3280
 
 
3281
class TestStackGet(TestStackWithTransport):
 
3282
 
 
3283
    def setUp(self):
 
3284
        super(TestStackGet, self).setUp()
 
3285
        self.conf = self.get_stack(self)
 
3286
 
 
3287
    def test_get_for_empty_stack(self):
 
3288
        self.assertEquals(None, self.conf.get('foo'))
 
3289
 
 
3290
    def test_get_hook(self):
 
3291
        self.conf.store._load_from_string('foo=bar')
 
3292
        calls = []
 
3293
        def hook(*args):
 
3294
            calls.append(args)
 
3295
        config.ConfigHooks.install_named_hook('get', hook, None)
 
3296
        self.assertLength(0, calls)
 
3297
        value = self.conf.get('foo')
 
3298
        self.assertEquals('bar', value)
 
3299
        self.assertLength(1, calls)
 
3300
        self.assertEquals((self.conf, 'foo', 'bar'), calls[0])
 
3301
 
 
3302
 
 
3303
class TestStackGetWithConverter(TestStackGet):
 
3304
 
 
3305
    def setUp(self):
 
3306
        super(TestStackGetWithConverter, self).setUp()
 
3307
        self.overrideAttr(config, 'option_registry', config.OptionRegistry())
 
3308
        self.registry = config.option_registry
 
3309
 
 
3310
    def register_bool_option(self, name, default=None, default_from_env=None):
 
3311
        b = config.Option(name, help='A boolean.',
 
3312
                          default=default, default_from_env=default_from_env,
 
3313
                          from_unicode=config.bool_from_store)
 
3314
        self.registry.register(b)
 
3315
 
 
3316
    def test_get_default_bool_None(self):
 
3317
        self.register_bool_option('foo')
 
3318
        self.assertEquals(None, self.conf.get('foo'))
 
3319
 
 
3320
    def test_get_default_bool_True(self):
 
3321
        self.register_bool_option('foo', u'True')
 
3322
        self.assertEquals(True, self.conf.get('foo'))
 
3323
 
 
3324
    def test_get_default_bool_False(self):
 
3325
        self.register_bool_option('foo', False)
 
3326
        self.assertEquals(False, self.conf.get('foo'))
 
3327
 
 
3328
    def test_get_default_bool_False_as_string(self):
 
3329
        self.register_bool_option('foo', u'False')
 
3330
        self.assertEquals(False, self.conf.get('foo'))
 
3331
 
 
3332
    def test_get_default_bool_from_env_converted(self):
 
3333
        self.register_bool_option('foo', u'True', default_from_env=['FOO'])
 
3334
        self.overrideEnv('FOO', 'False')
 
3335
        self.assertEquals(False, self.conf.get('foo'))
 
3336
 
 
3337
    def test_get_default_bool_when_conversion_fails(self):
 
3338
        self.register_bool_option('foo', default='True')
 
3339
        self.conf.store._load_from_string('foo=invalid boolean')
 
3340
        self.assertEquals(True, self.conf.get('foo'))
 
3341
 
 
3342
    def register_integer_option(self, name,
 
3343
                                default=None, default_from_env=None):
 
3344
        i = config.Option(name, help='An integer.',
 
3345
                          default=default, default_from_env=default_from_env,
 
3346
                          from_unicode=config.int_from_store)
 
3347
        self.registry.register(i)
 
3348
 
 
3349
    def test_get_default_integer_None(self):
 
3350
        self.register_integer_option('foo')
 
3351
        self.assertEquals(None, self.conf.get('foo'))
 
3352
 
 
3353
    def test_get_default_integer(self):
 
3354
        self.register_integer_option('foo', 42)
 
3355
        self.assertEquals(42, self.conf.get('foo'))
 
3356
 
 
3357
    def test_get_default_integer_as_string(self):
 
3358
        self.register_integer_option('foo', u'42')
 
3359
        self.assertEquals(42, self.conf.get('foo'))
 
3360
 
 
3361
    def test_get_default_integer_from_env(self):
 
3362
        self.register_integer_option('foo', default_from_env=['FOO'])
 
3363
        self.overrideEnv('FOO', '18')
 
3364
        self.assertEquals(18, self.conf.get('foo'))
 
3365
 
 
3366
    def test_get_default_integer_when_conversion_fails(self):
 
3367
        self.register_integer_option('foo', default='12')
 
3368
        self.conf.store._load_from_string('foo=invalid integer')
 
3369
        self.assertEquals(12, self.conf.get('foo'))
 
3370
 
 
3371
    def register_list_option(self, name, default=None, default_from_env=None):
 
3372
        l = config.Option(name, help='A list.',
 
3373
                          default=default, default_from_env=default_from_env,
 
3374
                          from_unicode=config.list_from_store)
 
3375
        self.registry.register(l)
 
3376
 
 
3377
    def test_get_default_list_None(self):
 
3378
        self.register_list_option('foo')
 
3379
        self.assertEquals(None, self.conf.get('foo'))
 
3380
 
 
3381
    def test_get_default_list_empty(self):
 
3382
        self.register_list_option('foo', '')
 
3383
        self.assertEquals([], self.conf.get('foo'))
 
3384
 
 
3385
    def test_get_default_list_from_env(self):
 
3386
        self.register_list_option('foo', default_from_env=['FOO'])
 
3387
        self.overrideEnv('FOO', '')
 
3388
        self.assertEquals([], self.conf.get('foo'))
 
3389
 
 
3390
    def test_get_with_list_converter_no_item(self):
 
3391
        self.register_list_option('foo', None)
 
3392
        self.conf.store._load_from_string('foo=,')
 
3393
        self.assertEquals([], self.conf.get('foo'))
 
3394
 
 
3395
    def test_get_with_list_converter_many_items(self):
 
3396
        self.register_list_option('foo', None)
 
3397
        self.conf.store._load_from_string('foo=m,o,r,e')
 
3398
        self.assertEquals(['m', 'o', 'r', 'e'], self.conf.get('foo'))
 
3399
 
 
3400
    def test_get_with_list_converter_embedded_spaces_many_items(self):
 
3401
        self.register_list_option('foo', None)
 
3402
        self.conf.store._load_from_string('foo=" bar", "baz "')
 
3403
        self.assertEquals([' bar', 'baz '], self.conf.get('foo'))
 
3404
 
 
3405
    def test_get_with_list_converter_stripped_spaces_many_items(self):
 
3406
        self.register_list_option('foo', None)
 
3407
        self.conf.store._load_from_string('foo= bar ,  baz ')
 
3408
        self.assertEquals(['bar', 'baz'], self.conf.get('foo'))
 
3409
 
 
3410
 
 
3411
class TestStackExpandOptions(tests.TestCaseWithTransport):
 
3412
 
 
3413
    def setUp(self):
 
3414
        super(TestStackExpandOptions, self).setUp()
 
3415
        self.overrideAttr(config, 'option_registry', config.OptionRegistry())
 
3416
        self.registry = config.option_registry
 
3417
        self.conf = build_branch_stack(self)
 
3418
 
 
3419
    def assertExpansion(self, expected, string, env=None):
 
3420
        self.assertEquals(expected, self.conf.expand_options(string, env))
 
3421
 
 
3422
    def test_no_expansion(self):
 
3423
        self.assertExpansion('foo', 'foo')
 
3424
 
 
3425
    def test_expand_default_value(self):
 
3426
        self.conf.store._load_from_string('bar=baz')
 
3427
        self.registry.register(config.Option('foo', default=u'{bar}'))
 
3428
        self.assertEquals('baz', self.conf.get('foo', expand=True))
 
3429
 
 
3430
    def test_expand_default_from_env(self):
 
3431
        self.conf.store._load_from_string('bar=baz')
 
3432
        self.registry.register(config.Option('foo', default_from_env=['FOO']))
 
3433
        self.overrideEnv('FOO', '{bar}')
 
3434
        self.assertEquals('baz', self.conf.get('foo', expand=True))
 
3435
 
 
3436
    def test_expand_default_on_failed_conversion(self):
 
3437
        self.conf.store._load_from_string('baz=bogus\nbar=42\nfoo={baz}')
 
3438
        self.registry.register(
 
3439
            config.Option('foo', default=u'{bar}',
 
3440
                          from_unicode=config.int_from_store))
 
3441
        self.assertEquals(42, self.conf.get('foo', expand=True))
 
3442
 
 
3443
    def test_env_adding_options(self):
 
3444
        self.assertExpansion('bar', '{foo}', {'foo': 'bar'})
 
3445
 
 
3446
    def test_env_overriding_options(self):
 
3447
        self.conf.store._load_from_string('foo=baz')
 
3448
        self.assertExpansion('bar', '{foo}', {'foo': 'bar'})
 
3449
 
 
3450
    def test_simple_ref(self):
 
3451
        self.conf.store._load_from_string('foo=xxx')
 
3452
        self.assertExpansion('xxx', '{foo}')
 
3453
 
 
3454
    def test_unknown_ref(self):
 
3455
        self.assertRaises(errors.ExpandingUnknownOption,
 
3456
                          self.conf.expand_options, '{foo}')
 
3457
 
 
3458
    def test_indirect_ref(self):
 
3459
        self.conf.store._load_from_string('''
 
3460
foo=xxx
 
3461
bar={foo}
 
3462
''')
 
3463
        self.assertExpansion('xxx', '{bar}')
 
3464
 
 
3465
    def test_embedded_ref(self):
 
3466
        self.conf.store._load_from_string('''
 
3467
foo=xxx
 
3468
bar=foo
 
3469
''')
 
3470
        self.assertExpansion('xxx', '{{bar}}')
 
3471
 
 
3472
    def test_simple_loop(self):
 
3473
        self.conf.store._load_from_string('foo={foo}')
 
3474
        self.assertRaises(errors.OptionExpansionLoop,
 
3475
                          self.conf.expand_options, '{foo}')
 
3476
 
 
3477
    def test_indirect_loop(self):
 
3478
        self.conf.store._load_from_string('''
 
3479
foo={bar}
 
3480
bar={baz}
 
3481
baz={foo}''')
 
3482
        e = self.assertRaises(errors.OptionExpansionLoop,
 
3483
                              self.conf.expand_options, '{foo}')
 
3484
        self.assertEquals('foo->bar->baz', e.refs)
 
3485
        self.assertEquals('{foo}', e.string)
 
3486
 
 
3487
    def test_list(self):
 
3488
        self.conf.store._load_from_string('''
 
3489
foo=start
 
3490
bar=middle
 
3491
baz=end
 
3492
list={foo},{bar},{baz}
 
3493
''')
 
3494
        self.registry.register(
 
3495
            config.Option('list', from_unicode=config.list_from_store))
 
3496
        self.assertEquals(['start', 'middle', 'end'],
 
3497
                           self.conf.get('list', expand=True))
 
3498
 
 
3499
    def test_cascading_list(self):
 
3500
        self.conf.store._load_from_string('''
 
3501
foo=start,{bar}
 
3502
bar=middle,{baz}
 
3503
baz=end
 
3504
list={foo}
 
3505
''')
 
3506
        self.registry.register(
 
3507
            config.Option('list', from_unicode=config.list_from_store))
 
3508
        self.assertEquals(['start', 'middle', 'end'],
 
3509
                           self.conf.get('list', expand=True))
 
3510
 
 
3511
    def test_pathologically_hidden_list(self):
 
3512
        self.conf.store._load_from_string('''
 
3513
foo=bin
 
3514
bar=go
 
3515
start={foo
 
3516
middle=},{
 
3517
end=bar}
 
3518
hidden={start}{middle}{end}
 
3519
''')
 
3520
        # What matters is what the registration says, the conversion happens
 
3521
        # only after all expansions have been performed
 
3522
        self.registry.register(
 
3523
            config.Option('hidden', from_unicode=config.list_from_store))
 
3524
        self.assertEquals(['bin', 'go'],
 
3525
                          self.conf.get('hidden', expand=True))
 
3526
 
 
3527
 
 
3528
class TestStackCrossSectionsExpand(tests.TestCaseWithTransport):
 
3529
 
 
3530
    def setUp(self):
 
3531
        super(TestStackCrossSectionsExpand, self).setUp()
 
3532
 
 
3533
    def get_config(self, location, string):
 
3534
        if string is None:
 
3535
            string = ''
 
3536
        # Since we don't save the config we won't strictly require to inherit
 
3537
        # from TestCaseInTempDir, but an error occurs so quickly...
 
3538
        c = config.LocationStack(location)
 
3539
        c.store._load_from_string(string)
 
3540
        return c
 
3541
 
 
3542
    def test_dont_cross_unrelated_section(self):
 
3543
        c = self.get_config('/another/branch/path','''
 
3544
[/one/branch/path]
 
3545
foo = hello
 
3546
bar = {foo}/2
 
3547
 
 
3548
[/another/branch/path]
 
3549
bar = {foo}/2
 
3550
''')
 
3551
        self.assertRaises(errors.ExpandingUnknownOption,
 
3552
                          c.get, 'bar', expand=True)
 
3553
 
 
3554
    def test_cross_related_sections(self):
 
3555
        c = self.get_config('/project/branch/path','''
 
3556
[/project]
 
3557
foo = qu
 
3558
 
 
3559
[/project/branch/path]
 
3560
bar = {foo}ux
 
3561
''')
 
3562
        self.assertEquals('quux', c.get('bar', expand=True))
 
3563
 
 
3564
 
 
3565
class TestStackSet(TestStackWithTransport):
 
3566
 
 
3567
    def test_simple_set(self):
 
3568
        conf = self.get_stack(self)
 
3569
        conf.store._load_from_string('foo=bar')
 
3570
        self.assertEquals('bar', conf.get('foo'))
 
3571
        conf.set('foo', 'baz')
 
3572
        # Did we get it back ?
 
3573
        self.assertEquals('baz', conf.get('foo'))
 
3574
 
 
3575
    def test_set_creates_a_new_section(self):
 
3576
        conf = self.get_stack(self)
 
3577
        conf.set('foo', 'baz')
 
3578
        self.assertEquals, 'baz', conf.get('foo')
 
3579
 
 
3580
    def test_set_hook(self):
 
3581
        calls = []
 
3582
        def hook(*args):
 
3583
            calls.append(args)
 
3584
        config.ConfigHooks.install_named_hook('set', hook, None)
 
3585
        self.assertLength(0, calls)
 
3586
        conf = self.get_stack(self)
 
3587
        conf.set('foo', 'bar')
 
3588
        self.assertLength(1, calls)
 
3589
        self.assertEquals((conf, 'foo', 'bar'), calls[0])
 
3590
 
 
3591
 
 
3592
class TestStackRemove(TestStackWithTransport):
 
3593
 
 
3594
    def test_remove_existing(self):
 
3595
        conf = self.get_stack(self)
 
3596
        conf.store._load_from_string('foo=bar')
 
3597
        self.assertEquals('bar', conf.get('foo'))
 
3598
        conf.remove('foo')
 
3599
        # Did we get it back ?
 
3600
        self.assertEquals(None, conf.get('foo'))
 
3601
 
 
3602
    def test_remove_unknown(self):
 
3603
        conf = self.get_stack(self)
 
3604
        self.assertRaises(KeyError, conf.remove, 'I_do_not_exist')
 
3605
 
 
3606
    def test_remove_hook(self):
 
3607
        calls = []
 
3608
        def hook(*args):
 
3609
            calls.append(args)
 
3610
        config.ConfigHooks.install_named_hook('remove', hook, None)
 
3611
        self.assertLength(0, calls)
 
3612
        conf = self.get_stack(self)
 
3613
        conf.store._load_from_string('foo=bar')
 
3614
        conf.remove('foo')
 
3615
        self.assertLength(1, calls)
 
3616
        self.assertEquals((conf, 'foo'), calls[0])
 
3617
 
 
3618
 
 
3619
class TestConfigGetOptions(tests.TestCaseWithTransport, TestOptionsMixin):
 
3620
 
 
3621
    def setUp(self):
 
3622
        super(TestConfigGetOptions, self).setUp()
 
3623
        create_configs(self)
 
3624
 
 
3625
    def test_no_variable(self):
 
3626
        # Using branch should query branch, locations and bazaar
 
3627
        self.assertOptions([], self.branch_config)
 
3628
 
 
3629
    def test_option_in_bazaar(self):
 
3630
        self.bazaar_config.set_user_option('file', 'bazaar')
 
3631
        self.assertOptions([('file', 'bazaar', 'DEFAULT', 'bazaar')],
 
3632
                           self.bazaar_config)
 
3633
 
 
3634
    def test_option_in_locations(self):
 
3635
        self.locations_config.set_user_option('file', 'locations')
 
3636
        self.assertOptions(
 
3637
            [('file', 'locations', self.tree.basedir, 'locations')],
 
3638
            self.locations_config)
 
3639
 
 
3640
    def test_option_in_branch(self):
 
3641
        self.branch_config.set_user_option('file', 'branch')
 
3642
        self.assertOptions([('file', 'branch', 'DEFAULT', 'branch')],
 
3643
                           self.branch_config)
 
3644
 
 
3645
    def test_option_in_bazaar_and_branch(self):
 
3646
        self.bazaar_config.set_user_option('file', 'bazaar')
 
3647
        self.branch_config.set_user_option('file', 'branch')
 
3648
        self.assertOptions([('file', 'branch', 'DEFAULT', 'branch'),
 
3649
                            ('file', 'bazaar', 'DEFAULT', 'bazaar'),],
 
3650
                           self.branch_config)
 
3651
 
 
3652
    def test_option_in_branch_and_locations(self):
 
3653
        # Hmm, locations override branch :-/
 
3654
        self.locations_config.set_user_option('file', 'locations')
 
3655
        self.branch_config.set_user_option('file', 'branch')
 
3656
        self.assertOptions(
 
3657
            [('file', 'locations', self.tree.basedir, 'locations'),
 
3658
             ('file', 'branch', 'DEFAULT', 'branch'),],
 
3659
            self.branch_config)
 
3660
 
 
3661
    def test_option_in_bazaar_locations_and_branch(self):
 
3662
        self.bazaar_config.set_user_option('file', 'bazaar')
 
3663
        self.locations_config.set_user_option('file', 'locations')
 
3664
        self.branch_config.set_user_option('file', 'branch')
 
3665
        self.assertOptions(
 
3666
            [('file', 'locations', self.tree.basedir, 'locations'),
 
3667
             ('file', 'branch', 'DEFAULT', 'branch'),
 
3668
             ('file', 'bazaar', 'DEFAULT', 'bazaar'),],
 
3669
            self.branch_config)
 
3670
 
 
3671
 
 
3672
class TestConfigRemoveOption(tests.TestCaseWithTransport, TestOptionsMixin):
 
3673
 
 
3674
    def setUp(self):
 
3675
        super(TestConfigRemoveOption, self).setUp()
 
3676
        create_configs_with_file_option(self)
 
3677
 
 
3678
    def test_remove_in_locations(self):
 
3679
        self.locations_config.remove_user_option('file', self.tree.basedir)
 
3680
        self.assertOptions(
 
3681
            [('file', 'branch', 'DEFAULT', 'branch'),
 
3682
             ('file', 'bazaar', 'DEFAULT', 'bazaar'),],
 
3683
            self.branch_config)
 
3684
 
 
3685
    def test_remove_in_branch(self):
 
3686
        self.branch_config.remove_user_option('file')
 
3687
        self.assertOptions(
 
3688
            [('file', 'locations', self.tree.basedir, 'locations'),
 
3689
             ('file', 'bazaar', 'DEFAULT', 'bazaar'),],
 
3690
            self.branch_config)
 
3691
 
 
3692
    def test_remove_in_bazaar(self):
 
3693
        self.bazaar_config.remove_user_option('file')
 
3694
        self.assertOptions(
 
3695
            [('file', 'locations', self.tree.basedir, 'locations'),
 
3696
             ('file', 'branch', 'DEFAULT', 'branch'),],
 
3697
            self.branch_config)
 
3698
 
 
3699
 
 
3700
class TestConfigGetSections(tests.TestCaseWithTransport):
 
3701
 
 
3702
    def setUp(self):
 
3703
        super(TestConfigGetSections, self).setUp()
 
3704
        create_configs(self)
 
3705
 
 
3706
    def assertSectionNames(self, expected, conf, name=None):
 
3707
        """Check which sections are returned for a given config.
 
3708
 
 
3709
        If fallback configurations exist their sections can be included.
 
3710
 
 
3711
        :param expected: A list of section names.
 
3712
 
 
3713
        :param conf: The configuration that will be queried.
 
3714
 
 
3715
        :param name: An optional section name that will be passed to
 
3716
            get_sections().
 
3717
        """
 
3718
        sections = list(conf._get_sections(name))
 
3719
        self.assertLength(len(expected), sections)
 
3720
        self.assertEqual(expected, [name for name, _, _ in sections])
 
3721
 
 
3722
    def test_bazaar_default_section(self):
 
3723
        self.assertSectionNames(['DEFAULT'], self.bazaar_config)
 
3724
 
 
3725
    def test_locations_default_section(self):
 
3726
        # No sections are defined in an empty file
 
3727
        self.assertSectionNames([], self.locations_config)
 
3728
 
 
3729
    def test_locations_named_section(self):
 
3730
        self.locations_config.set_user_option('file', 'locations')
 
3731
        self.assertSectionNames([self.tree.basedir], self.locations_config)
 
3732
 
 
3733
    def test_locations_matching_sections(self):
 
3734
        loc_config = self.locations_config
 
3735
        loc_config.set_user_option('file', 'locations')
 
3736
        # We need to cheat a bit here to create an option in sections above and
 
3737
        # below the 'location' one.
 
3738
        parser = loc_config._get_parser()
 
3739
        # locations.cong deals with '/' ignoring native os.sep
 
3740
        location_names = self.tree.basedir.split('/')
 
3741
        parent = '/'.join(location_names[:-1])
 
3742
        child = '/'.join(location_names + ['child'])
 
3743
        parser[parent] = {}
 
3744
        parser[parent]['file'] = 'parent'
 
3745
        parser[child] = {}
 
3746
        parser[child]['file'] = 'child'
 
3747
        self.assertSectionNames([self.tree.basedir, parent], loc_config)
 
3748
 
 
3749
    def test_branch_data_default_section(self):
 
3750
        self.assertSectionNames([None],
 
3751
                                self.branch_config._get_branch_data_config())
 
3752
 
 
3753
    def test_branch_default_sections(self):
 
3754
        # No sections are defined in an empty locations file
 
3755
        self.assertSectionNames([None, 'DEFAULT'],
 
3756
                                self.branch_config)
 
3757
        # Unless we define an option
 
3758
        self.branch_config._get_location_config().set_user_option(
 
3759
            'file', 'locations')
 
3760
        self.assertSectionNames([self.tree.basedir, None, 'DEFAULT'],
 
3761
                                self.branch_config)
 
3762
 
 
3763
    def test_bazaar_named_section(self):
 
3764
        # We need to cheat as the API doesn't give direct access to sections
 
3765
        # other than DEFAULT.
 
3766
        self.bazaar_config.set_alias('bazaar', 'bzr')
 
3767
        self.assertSectionNames(['ALIASES'], self.bazaar_config, 'ALIASES')
 
3768
 
 
3769
 
1308
3770
class TestAuthenticationConfigFile(tests.TestCase):
1309
3771
    """Test the authentication.conf file matching"""
1310
3772
 
1325
3787
        self.assertEquals({}, conf._get_config())
1326
3788
        self._got_user_passwd(None, None, conf, 'http', 'foo.net')
1327
3789
 
 
3790
    def test_non_utf8_config(self):
 
3791
        conf = config.AuthenticationConfig(_file=StringIO(
 
3792
                'foo = bar\xff'))
 
3793
        self.assertRaises(errors.ConfigContentError, conf._get_config)
 
3794
 
1328
3795
    def test_missing_auth_section_header(self):
1329
3796
        conf = config.AuthenticationConfig(_file=StringIO('foo = bar'))
1330
3797
        self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
1588
4055
 
1589
4056
    def test_username_defaults_prompts(self):
1590
4057
        # HTTP prompts can't be tested here, see test_http.py
1591
 
        self._check_default_username_prompt('FTP %(host)s username: ', 'ftp')
1592
 
        self._check_default_username_prompt(
1593
 
            'FTP %(host)s:%(port)d username: ', 'ftp', port=10020)
1594
 
        self._check_default_username_prompt(
1595
 
            'SSH %(host)s:%(port)d username: ', 'ssh', port=12345)
 
4058
        self._check_default_username_prompt(u'FTP %(host)s username: ', 'ftp')
 
4059
        self._check_default_username_prompt(
 
4060
            u'FTP %(host)s:%(port)d username: ', 'ftp', port=10020)
 
4061
        self._check_default_username_prompt(
 
4062
            u'SSH %(host)s:%(port)d username: ', 'ssh', port=12345)
1596
4063
 
1597
4064
    def test_username_default_no_prompt(self):
1598
4065
        conf = config.AuthenticationConfig()
1604
4071
    def test_password_default_prompts(self):
1605
4072
        # HTTP prompts can't be tested here, see test_http.py
1606
4073
        self._check_default_password_prompt(
1607
 
            'FTP %(user)s@%(host)s password: ', 'ftp')
1608
 
        self._check_default_password_prompt(
1609
 
            'FTP %(user)s@%(host)s:%(port)d password: ', 'ftp', port=10020)
1610
 
        self._check_default_password_prompt(
1611
 
            'SSH %(user)s@%(host)s:%(port)d password: ', 'ssh', port=12345)
 
4074
            u'FTP %(user)s@%(host)s password: ', 'ftp')
 
4075
        self._check_default_password_prompt(
 
4076
            u'FTP %(user)s@%(host)s:%(port)d password: ', 'ftp', port=10020)
 
4077
        self._check_default_password_prompt(
 
4078
            u'SSH %(user)s@%(host)s:%(port)d password: ', 'ssh', port=12345)
1612
4079
        # SMTP port handling is a bit special (it's handled if embedded in the
1613
4080
        # host too)
1614
4081
        # FIXME: should we: forbid that, extend it to other schemes, leave
1615
4082
        # things as they are that's fine thank you ?
1616
 
        self._check_default_password_prompt('SMTP %(user)s@%(host)s password: ',
1617
 
                                            'smtp')
1618
 
        self._check_default_password_prompt('SMTP %(user)s@%(host)s password: ',
1619
 
                                            'smtp', host='bar.org:10025')
1620
 
        self._check_default_password_prompt(
1621
 
            'SMTP %(user)s@%(host)s:%(port)d password: ',
1622
 
            'smtp', port=10025)
 
4083
        self._check_default_password_prompt(
 
4084
            u'SMTP %(user)s@%(host)s password: ', 'smtp')
 
4085
        self._check_default_password_prompt(
 
4086
            u'SMTP %(user)s@%(host)s password: ', 'smtp', host='bar.org:10025')
 
4087
        self._check_default_password_prompt(
 
4088
            u'SMTP %(user)s@%(host)s:%(port)d password: ', 'smtp', port=10025)
1623
4089
 
1624
4090
    def test_ssh_password_emits_warning(self):
1625
4091
        conf = config.AuthenticationConfig(_file=StringIO(
1805
4271
# test_user_prompted ?
1806
4272
class TestAuthenticationRing(tests.TestCaseWithTransport):
1807
4273
    pass
 
4274
 
 
4275
 
 
4276
class TestAutoUserId(tests.TestCase):
 
4277
    """Test inferring an automatic user name."""
 
4278
 
 
4279
    def test_auto_user_id(self):
 
4280
        """Automatic inference of user name.
 
4281
        
 
4282
        This is a bit hard to test in an isolated way, because it depends on
 
4283
        system functions that go direct to /etc or perhaps somewhere else.
 
4284
        But it's reasonable to say that on Unix, with an /etc/mailname, we ought
 
4285
        to be able to choose a user name with no configuration.
 
4286
        """
 
4287
        if sys.platform == 'win32':
 
4288
            raise tests.TestSkipped(
 
4289
                "User name inference not implemented on win32")
 
4290
        realname, address = config._auto_user_id()
 
4291
        if os.path.exists('/etc/mailname'):
 
4292
            self.assertIsNot(None, realname)
 
4293
            self.assertIsNot(None, address)
 
4294
        else:
 
4295
            self.assertEquals((None, None), (realname, address))
 
4296