~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_config.py

  • Committer: Tarmac
  • Author(s): Florent Gallaire
  • Date: 2017-03-17 12:23:47 UTC
  • mfrom: (6621.1.1 fix-gmtime-lite)
  • Revision ID: tarmac-20170317122347-2nnf3cicpgrhux3h
Fix for Windows and 32-bit platforms buggy gmtime(). [r=vila,richard-wilbur]

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2014, 2016 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Tests for finding and reading the bzr config file[s]."""
18
 
# import system imports here
 
18
 
19
19
from cStringIO import StringIO
 
20
from textwrap import dedent
20
21
import os
21
22
import sys
22
23
import threading
23
24
 
24
 
 
25
25
from testtools import matchers
26
26
 
27
 
#import bzrlib specific imports here
28
27
from bzrlib import (
29
28
    branch,
30
 
    bzrdir,
31
29
    config,
 
30
    controldir,
32
31
    diff,
33
32
    errors,
34
33
    osutils,
35
34
    mail_client,
36
 
    mergetools,
37
35
    ui,
38
36
    urlutils,
39
 
    registry,
 
37
    registry as _mod_registry,
40
38
    remote,
41
39
    tests,
42
40
    trace,
43
 
    transport,
44
41
    )
45
42
from bzrlib.symbol_versioning import (
46
43
    deprecated_in,
47
 
    deprecated_method,
48
44
    )
49
45
from bzrlib.transport import remote as transport_remote
50
46
from bzrlib.tests import (
71
67
 
72
68
# Register helpers to build stores
73
69
config.test_store_builder_registry.register(
74
 
    'configobj', lambda test: config.IniFileStore(test.get_transport(),
75
 
                                                  'configobj.conf'))
 
70
    'configobj', lambda test: config.TransportIniFileStore(
 
71
        test.get_transport(), 'configobj.conf'))
76
72
config.test_store_builder_registry.register(
77
73
    'bazaar', lambda test: config.GlobalStore())
78
74
config.test_store_builder_registry.register(
116
112
config.test_store_builder_registry.register('branch', build_branch_store)
117
113
 
118
114
 
 
115
def build_control_store(test):
 
116
    build_backing_branch(test, 'branch')
 
117
    b = controldir.ControlDir.open('branch')
 
118
    return config.ControlStore(b)
 
119
config.test_store_builder_registry.register('control', build_control_store)
 
120
 
 
121
 
119
122
def build_remote_branch_store(test):
120
123
    # There is only one permutation (but we won't be able to handle more with
121
124
    # this design anyway)
141
144
config.test_stack_builder_registry.register('branch', build_branch_stack)
142
145
 
143
146
 
144
 
def build_remote_branch_stack(test):
145
 
    # There is only one permutation (but we won't be able to handle more with
146
 
    # this design anyway)
147
 
    (transport_class,
148
 
     server_class) = transport_remote.get_test_permutations()[0]
149
 
    build_backing_branch(test, 'branch', transport_class, server_class)
150
 
    b = branch.Branch.open(test.get_url('branch'))
151
 
    return config.BranchStack(b)
152
 
config.test_stack_builder_registry.register('remote_branch',
153
 
                                            build_remote_branch_stack)
 
147
def build_branch_only_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.BranchOnlyStack(b)
 
155
config.test_stack_builder_registry.register('branch_only',
 
156
                                            build_branch_only_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)
154
170
 
155
171
 
156
172
sample_long_alias="log -r-15..-1 --line"
167
183
user_global_option=something
168
184
bzr.mergetool.sometool=sometool {base} {this} {other} -o {result}
169
185
bzr.mergetool.funkytool=funkytool "arg with spaces" {this_temp}
 
186
bzr.mergetool.newtool='"newtool with spaces" {this_temp}'
170
187
bzr.default_mergetool=sometool
171
188
[ALIASES]
172
189
h=help
311
328
 
312
329
class FakeBranch(object):
313
330
 
314
 
    def __init__(self, base=None, user_id=None):
 
331
    def __init__(self, base=None):
315
332
        if base is None:
316
333
            self.base = "http://example.com/branches/demo"
317
334
        else:
318
335
            self.base = base
319
336
        self._transport = self.control_files = \
320
 
            FakeControlFilesAndTransport(user_id=user_id)
 
337
            FakeControlFilesAndTransport()
321
338
 
322
339
    def _get_config(self):
323
340
        return config.TransportConfig(self._transport, 'branch.conf')
331
348
 
332
349
class FakeControlFilesAndTransport(object):
333
350
 
334
 
    def __init__(self, user_id=None):
 
351
    def __init__(self):
335
352
        self.files = {}
336
 
        if user_id:
337
 
            self.files['email'] = user_id
338
353
        self._transport = self
339
354
 
340
 
    def get_utf8(self, filename):
341
 
        # from LockableFiles
342
 
        raise AssertionError("get_utf8 should no longer be used")
343
 
 
344
355
    def get(self, filename):
345
356
        # from Transport
346
357
        try:
437
448
        output = outfile.getvalue()
438
449
        # now we're trying to read it back
439
450
        co2 = config.ConfigObj(StringIO(output))
440
 
        self.assertEquals(triple_quotes_value, co2['test'])
 
451
        self.assertEqual(triple_quotes_value, co2['test'])
441
452
 
442
453
 
443
454
erroneous_config = """[section] # line 1
464
475
    def test_constructs(self):
465
476
        config.Config()
466
477
 
467
 
    def test_no_default_editor(self):
468
 
        self.assertRaises(
469
 
            NotImplementedError,
470
 
            self.applyDeprecated, deprecated_in((2, 4, 0)),
471
 
            config.Config().get_editor)
472
 
 
473
478
    def test_user_email(self):
474
479
        my_config = InstrumentedConfig()
475
480
        self.assertEqual('robert.collins@example.org', my_config.user_email())
483
488
 
484
489
    def test_signatures_default(self):
485
490
        my_config = config.Config()
486
 
        self.assertFalse(my_config.signature_needed())
 
491
        self.assertFalse(
 
492
            self.applyDeprecated(deprecated_in((2, 5, 0)),
 
493
                my_config.signature_needed))
487
494
        self.assertEqual(config.CHECK_IF_POSSIBLE,
488
 
                         my_config.signature_checking())
 
495
            self.applyDeprecated(deprecated_in((2, 5, 0)),
 
496
                my_config.signature_checking))
489
497
        self.assertEqual(config.SIGN_WHEN_REQUIRED,
490
 
                         my_config.signing_policy())
 
498
                self.applyDeprecated(deprecated_in((2, 5, 0)),
 
499
                    my_config.signing_policy))
491
500
 
492
501
    def test_signatures_template_method(self):
493
502
        my_config = InstrumentedConfig()
494
 
        self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
 
503
        self.assertEqual(config.CHECK_NEVER,
 
504
            self.applyDeprecated(deprecated_in((2, 5, 0)),
 
505
                my_config.signature_checking))
495
506
        self.assertEqual(['_get_signature_checking'], my_config._calls)
496
507
 
497
508
    def test_signatures_template_method_none(self):
498
509
        my_config = InstrumentedConfig()
499
510
        my_config._signatures = None
500
511
        self.assertEqual(config.CHECK_IF_POSSIBLE,
501
 
                         my_config.signature_checking())
 
512
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
 
513
                             my_config.signature_checking))
502
514
        self.assertEqual(['_get_signature_checking'], my_config._calls)
503
515
 
504
516
    def test_gpg_signing_command_default(self):
505
517
        my_config = config.Config()
506
 
        self.assertEqual('gpg', my_config.gpg_signing_command())
 
518
        self.assertEqual('gpg',
 
519
            self.applyDeprecated(deprecated_in((2, 5, 0)),
 
520
                my_config.gpg_signing_command))
507
521
 
508
522
    def test_get_user_option_default(self):
509
523
        my_config = config.Config()
511
525
 
512
526
    def test_post_commit_default(self):
513
527
        my_config = config.Config()
514
 
        self.assertEqual(None, my_config.post_commit())
 
528
        self.assertEqual(None, self.applyDeprecated(deprecated_in((2, 5, 0)),
 
529
                                                    my_config.post_commit))
 
530
 
515
531
 
516
532
    def test_log_format_default(self):
517
533
        my_config = config.Config()
518
 
        self.assertEqual('long', my_config.log_format())
 
534
        self.assertEqual('long',
 
535
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
 
536
                                              my_config.log_format))
519
537
 
520
538
    def test_acceptable_keys_default(self):
521
539
        my_config = config.Config()
522
 
        self.assertEqual(None, my_config.acceptable_keys())
 
540
        self.assertEqual(None, self.applyDeprecated(deprecated_in((2, 5, 0)),
 
541
            my_config.acceptable_keys))
523
542
 
524
543
    def test_validate_signatures_in_log_default(self):
525
544
        my_config = config.Config()
539
558
    def setUp(self):
540
559
        super(TestConfigPath, self).setUp()
541
560
        self.overrideEnv('HOME', '/home/bogus')
542
 
        self.overrideEnv('XDG_CACHE_DIR', '')
 
561
        self.overrideEnv('XDG_CACHE_HOME', '')
543
562
        if sys.platform == 'win32':
544
563
            self.overrideEnv(
545
564
                'BZR_HOME', r'C:\Documents and Settings\bogus\Application Data')
551
570
    def test_config_dir(self):
552
571
        self.assertEqual(config.config_dir(), self.bzr_home)
553
572
 
 
573
    def test_config_dir_is_unicode(self):
 
574
        self.assertIsInstance(config.config_dir(), unicode)
 
575
 
554
576
    def test_config_filename(self):
555
577
        self.assertEqual(config.config_filename(),
556
578
                         self.bzr_home + '/bazaar.conf')
573
595
    # subdirectory of $XDG_CONFIG_HOME
574
596
 
575
597
    def setUp(self):
576
 
        if sys.platform in ('darwin', 'win32'):
 
598
        if sys.platform == 'win32':
577
599
            raise tests.TestNotApplicable(
578
600
                'XDG config dir not used on this platform')
579
601
        super(TestXDGConfigDir, self).setUp()
606
628
class TestIniConfigBuilding(TestIniConfig):
607
629
 
608
630
    def test_contructs(self):
609
 
        my_config = config.IniBasedConfig()
 
631
        config.IniBasedConfig()
610
632
 
611
633
    def test_from_fp(self):
612
634
        my_config = config.IniBasedConfig.from_string(sample_config_text)
627
649
        self.path = self.uid = self.gid = None
628
650
        conf = config.IniBasedConfig(file_name='./foo.conf')
629
651
        conf._write_config_file()
630
 
        self.assertEquals(self.path, './foo.conf')
 
652
        self.assertEqual(self.path, './foo.conf')
631
653
        self.assertTrue(isinstance(self.uid, int))
632
654
        self.assertTrue(isinstance(self.gid, int))
633
655
 
655
677
 
656
678
    def test_saved_with_content(self):
657
679
        content = 'foo = bar\n'
658
 
        conf = config.IniBasedConfig.from_string(
659
 
            content, file_name='./test.conf', save=True)
 
680
        config.IniBasedConfig.from_string(content, file_name='./test.conf',
 
681
                                          save=True)
660
682
        self.assertFileEqual(content, 'test.conf')
661
683
 
662
684
 
663
 
class TestIniConfigOptionExpansionDefaultValue(tests.TestCaseInTempDir):
664
 
    """What is the default value of expand for config options.
665
 
 
666
 
    This is an opt-in beta feature used to evaluate whether or not option
667
 
    references can appear in dangerous place raising exceptions, disapearing
668
 
    (and as such corrupting data) or if it's safe to activate the option by
669
 
    default.
670
 
 
671
 
    Note that these tests relies on config._expand_default_value being already
672
 
    overwritten in the parent class setUp.
673
 
    """
674
 
 
675
 
    def setUp(self):
676
 
        super(TestIniConfigOptionExpansionDefaultValue, self).setUp()
677
 
        self.config = None
678
 
        self.warnings = []
679
 
        def warning(*args):
680
 
            self.warnings.append(args[0] % args[1:])
681
 
        self.overrideAttr(trace, 'warning', warning)
682
 
 
683
 
    def get_config(self, expand):
684
 
        c = config.GlobalConfig.from_string('bzr.config.expand=%s' % (expand,),
685
 
                                            save=True)
686
 
        return c
687
 
 
688
 
    def assertExpandIs(self, expected):
689
 
        actual = config._get_expand_default_value()
690
 
        #self.config.get_user_option_as_bool('bzr.config.expand')
691
 
        self.assertEquals(expected, actual)
692
 
 
693
 
    def test_default_is_None(self):
694
 
        self.assertEquals(None, config._expand_default_value)
695
 
 
696
 
    def test_default_is_False_even_if_None(self):
697
 
        self.config = self.get_config(None)
698
 
        self.assertExpandIs(False)
699
 
 
700
 
    def test_default_is_False_even_if_invalid(self):
701
 
        self.config = self.get_config('<your choice>')
702
 
        self.assertExpandIs(False)
703
 
        # ...
704
 
        # Huh ? My choice is False ? Thanks, always happy to hear that :D
705
 
        # Wait, you've been warned !
706
 
        self.assertLength(1, self.warnings)
707
 
        self.assertEquals(
708
 
            'Value "<your choice>" is not a boolean for "bzr.config.expand"',
709
 
            self.warnings[0])
710
 
 
711
 
    def test_default_is_True(self):
712
 
        self.config = self.get_config(True)
713
 
        self.assertExpandIs(True)
714
 
 
715
 
    def test_default_is_False(self):
716
 
        self.config = self.get_config(False)
717
 
        self.assertExpandIs(False)
718
 
 
719
 
 
720
685
class TestIniConfigOptionExpansion(tests.TestCase):
721
686
    """Test option expansion from the IniConfig level.
722
687
 
734
699
        return c
735
700
 
736
701
    def assertExpansion(self, expected, conf, string, env=None):
737
 
        self.assertEquals(expected, conf.expand_options(string, env))
 
702
        self.assertEqual(expected, conf.expand_options(string, env))
738
703
 
739
704
    def test_no_expansion(self):
740
705
        c = self.get_config('')
782
747
baz={foo}''')
783
748
        e = self.assertRaises(errors.OptionExpansionLoop,
784
749
                              c.expand_options, '{foo}')
785
 
        self.assertEquals('foo->bar->baz', e.refs)
786
 
        self.assertEquals('{foo}', e.string)
 
750
        self.assertEqual('foo->bar->baz', e.refs)
 
751
        self.assertEqual('{foo}', e.string)
787
752
 
788
753
    def test_list(self):
789
754
        conf = self.get_config('''
792
757
baz=end
793
758
list={foo},{bar},{baz}
794
759
''')
795
 
        self.assertEquals(['start', 'middle', 'end'],
 
760
        self.assertEqual(['start', 'middle', 'end'],
796
761
                           conf.get_user_option('list', expand=True))
797
762
 
798
763
    def test_cascading_list(self):
802
767
baz=end
803
768
list={foo}
804
769
''')
805
 
        self.assertEquals(['start', 'middle', 'end'],
 
770
        self.assertEqual(['start', 'middle', 'end'],
806
771
                           conf.get_user_option('list', expand=True))
807
772
 
808
773
    def test_pathological_hidden_list(self):
816
781
''')
817
782
        # Nope, it's either a string or a list, and the list wins as soon as a
818
783
        # ',' appears, so the string concatenation never occur.
819
 
        self.assertEquals(['{foo', '}', '{', 'bar}'],
 
784
        self.assertEqual(['{foo', '}', '{', 'bar}'],
820
785
                          conf.get_user_option('hidden', expand=True))
821
786
 
 
787
 
822
788
class TestLocationConfigOptionExpansion(tests.TestCaseInTempDir):
823
789
 
824
790
    def get_config(self, location, string=None):
849
815
[/project/branch/path]
850
816
bar = {foo}ux
851
817
''')
852
 
        self.assertEquals('quux', c.get_user_option('bar', expand=True))
 
818
        self.assertEqual('quux', c.get_user_option('bar', expand=True))
853
819
 
854
820
 
855
821
class TestIniBaseConfigOnDisk(tests.TestCaseInTempDir):
895
861
        return c
896
862
 
897
863
    def test_simple_read_access(self):
898
 
        self.assertEquals('1', self.config.get_user_option('one'))
 
864
        self.assertEqual('1', self.config.get_user_option('one'))
899
865
 
900
866
    def test_simple_write_access(self):
901
867
        self.config.set_user_option('one', 'one')
902
 
        self.assertEquals('one', self.config.get_user_option('one'))
 
868
        self.assertEqual('one', self.config.get_user_option('one'))
903
869
 
904
870
    def test_listen_to_the_last_speaker(self):
905
871
        c1 = self.config
906
872
        c2 = self.get_existing_config()
907
873
        c1.set_user_option('one', 'ONE')
908
874
        c2.set_user_option('two', 'TWO')
909
 
        self.assertEquals('ONE', c1.get_user_option('one'))
910
 
        self.assertEquals('TWO', c2.get_user_option('two'))
 
875
        self.assertEqual('ONE', c1.get_user_option('one'))
 
876
        self.assertEqual('TWO', c2.get_user_option('two'))
911
877
        # The second update respect the first one
912
 
        self.assertEquals('ONE', c2.get_user_option('one'))
 
878
        self.assertEqual('ONE', c2.get_user_option('one'))
913
879
 
914
880
    def test_last_speaker_wins(self):
915
881
        # If the same config is not shared, the same variable modified twice
918
884
        c2 = self.get_existing_config()
919
885
        c1.set_user_option('one', 'c1')
920
886
        c2.set_user_option('one', 'c2')
921
 
        self.assertEquals('c2', c2._get_user_option('one'))
 
887
        self.assertEqual('c2', c2._get_user_option('one'))
922
888
        # The first modification is still available until another refresh
923
889
        # occur
924
 
        self.assertEquals('c1', c1._get_user_option('one'))
 
890
        self.assertEqual('c1', c1._get_user_option('one'))
925
891
        c1.set_user_option('two', 'done')
926
 
        self.assertEquals('c2', c1._get_user_option('one'))
 
892
        self.assertEqual('c2', c1._get_user_option('one'))
927
893
 
928
894
    def test_writes_are_serialized(self):
929
895
        c1 = self.config
954
920
        self.assertTrue(c1._lock.is_held)
955
921
        self.assertRaises(errors.LockContention,
956
922
                          c2.set_user_option, 'one', 'c2')
957
 
        self.assertEquals('c1', c1.get_user_option('one'))
 
923
        self.assertEqual('c1', c1.get_user_option('one'))
958
924
        # Let the lock be released
959
925
        after_writing.set()
960
926
        writing_done.wait()
961
927
        c2.set_user_option('one', 'c2')
962
 
        self.assertEquals('c2', c2.get_user_option('one'))
 
928
        self.assertEqual('c2', c2.get_user_option('one'))
963
929
 
964
930
    def test_read_while_writing(self):
965
931
       c1 = self.config
987
953
       # Ensure the thread is ready to write
988
954
       ready_to_write.wait()
989
955
       self.assertTrue(c1._lock.is_held)
990
 
       self.assertEquals('c1', c1.get_user_option('one'))
 
956
       self.assertEqual('c1', c1.get_user_option('one'))
991
957
       # If we read during the write, we get the old value
992
958
       c2 = self.get_existing_config()
993
 
       self.assertEquals('1', c2.get_user_option('one'))
 
959
       self.assertEqual('1', c2.get_user_option('one'))
994
960
       # Let the writing occur and ensure it occurred
995
961
       do_writing.set()
996
962
       writing_done.wait()
997
963
       # Now we get the updated value
998
964
       c3 = self.get_existing_config()
999
 
       self.assertEquals('c1', c3.get_user_option('one'))
 
965
       self.assertEqual('c1', c3.get_user_option('one'))
1000
966
 
1001
967
 
1002
968
class TestGetUserOptionAs(TestIniConfig):
1017
983
        self.overrideAttr(trace, 'warning', warning)
1018
984
        msg = 'Value "%s" is not a boolean for "%s"'
1019
985
        self.assertIs(None, get_bool('an_invalid_bool'))
1020
 
        self.assertEquals(msg % ('maybe', 'an_invalid_bool'), warnings[0])
 
986
        self.assertEqual(msg % ('maybe', 'an_invalid_bool'), warnings[0])
1021
987
        warnings = []
1022
988
        self.assertIs(None, get_bool('not_defined_in_this_config'))
1023
 
        self.assertEquals([], warnings)
 
989
        self.assertEqual([], warnings)
1024
990
 
1025
991
    def test_get_user_option_as_list(self):
1026
992
        conf, parser = self.make_config_parser("""
1035
1001
        # automatically cast to list
1036
1002
        self.assertEqual(['x'], get_list('one_item'))
1037
1003
 
 
1004
    def test_get_user_option_as_int_from_SI(self):
 
1005
        conf, parser = self.make_config_parser("""
 
1006
plain = 100
 
1007
si_k = 5k,
 
1008
si_kb = 5kb,
 
1009
si_m = 5M,
 
1010
si_mb = 5MB,
 
1011
si_g = 5g,
 
1012
si_gb = 5gB,
 
1013
""")
 
1014
        def get_si(s, default=None):
 
1015
            return self.applyDeprecated(
 
1016
                deprecated_in((2, 5, 0)),
 
1017
                conf.get_user_option_as_int_from_SI, s, default)
 
1018
        self.assertEqual(100, get_si('plain'))
 
1019
        self.assertEqual(5000, get_si('si_k'))
 
1020
        self.assertEqual(5000, get_si('si_kb'))
 
1021
        self.assertEqual(5000000, get_si('si_m'))
 
1022
        self.assertEqual(5000000, get_si('si_mb'))
 
1023
        self.assertEqual(5000000000, get_si('si_g'))
 
1024
        self.assertEqual(5000000000, get_si('si_gb'))
 
1025
        self.assertEqual(None, get_si('non-exist'))
 
1026
        self.assertEqual(42, get_si('non-exist-with-default',  42))
 
1027
 
1038
1028
 
1039
1029
class TestSupressWarning(TestIniConfig):
1040
1030
 
1056
1046
class TestGetConfig(tests.TestCase):
1057
1047
 
1058
1048
    def test_constructs(self):
1059
 
        my_config = config.GlobalConfig()
 
1049
        config.GlobalConfig()
1060
1050
 
1061
1051
    def test_calls_read_filenames(self):
1062
1052
        # replace the class that is constructed, to check its parameters
1074
1064
 
1075
1065
class TestBranchConfig(tests.TestCaseWithTransport):
1076
1066
 
1077
 
    def test_constructs(self):
 
1067
    def test_constructs_valid(self):
1078
1068
        branch = FakeBranch()
1079
1069
        my_config = config.BranchConfig(branch)
 
1070
        self.assertIsNot(None, my_config)
 
1071
 
 
1072
    def test_constructs_error(self):
1080
1073
        self.assertRaises(TypeError, config.BranchConfig)
1081
1074
 
1082
1075
    def test_get_location_config(self):
1088
1081
 
1089
1082
    def test_get_config(self):
1090
1083
        """The Branch.get_config method works properly"""
1091
 
        b = bzrdir.BzrDir.create_standalone_workingtree('.').branch
 
1084
        b = controldir.ControlDir.create_standalone_workingtree('.').branch
1092
1085
        my_config = b.get_config()
1093
1086
        self.assertIs(my_config.get_user_option('wacky'), None)
1094
1087
        my_config.set_user_option('wacky', 'unlikely')
1114
1107
        conf = config.LocationConfig.from_string(
1115
1108
            '[%s]\nnickname = foobar' % (local_url,),
1116
1109
            local_url, save=True)
 
1110
        self.assertIsNot(None, conf)
1117
1111
        self.assertEqual('foobar', branch.nick)
1118
1112
 
1119
1113
    def test_config_local_path(self):
1122
1116
        self.assertEqual('branch', branch.nick)
1123
1117
 
1124
1118
        local_path = osutils.getcwd().encode('utf8')
1125
 
        conf = config.LocationConfig.from_string(
 
1119
        config.LocationConfig.from_string(
1126
1120
            '[%s/branch]\nnickname = barry' % (local_path,),
1127
1121
            'branch',  save=True)
 
1122
        # Now the branch will find its nick via the location config
1128
1123
        self.assertEqual('barry', branch.nick)
1129
1124
 
1130
1125
    def test_config_creates_local(self):
1143
1138
        b = self.make_branch('!repo')
1144
1139
        self.assertEqual('!repo', b.get_config().get_nickname())
1145
1140
 
 
1141
    def test_autonick_uses_branch_name(self):
 
1142
        b = self.make_branch('foo', name='bar')
 
1143
        self.assertEqual('bar', b.get_config().get_nickname())
 
1144
 
1146
1145
    def test_warn_if_masked(self):
1147
1146
        warnings = []
1148
1147
        def warning(*args):
1188
1187
        my_config = config.GlobalConfig()
1189
1188
        self.assertEqual(None, my_config._get_user_id())
1190
1189
 
1191
 
    def test_configured_editor(self):
1192
 
        my_config = config.GlobalConfig.from_string(sample_config_text)
1193
 
        editor = self.applyDeprecated(
1194
 
            deprecated_in((2, 4, 0)), my_config.get_editor)
1195
 
        self.assertEqual('vim', editor)
1196
 
 
1197
1190
    def test_signatures_always(self):
1198
1191
        my_config = config.GlobalConfig.from_string(sample_always_signatures)
1199
1192
        self.assertEqual(config.CHECK_NEVER,
1200
 
                         my_config.signature_checking())
 
1193
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1194
                             my_config.signature_checking))
1201
1195
        self.assertEqual(config.SIGN_ALWAYS,
1202
 
                         my_config.signing_policy())
1203
 
        self.assertEqual(True, my_config.signature_needed())
 
1196
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1197
                             my_config.signing_policy))
 
1198
        self.assertEqual(True,
 
1199
            self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1200
                my_config.signature_needed))
1204
1201
 
1205
1202
    def test_signatures_if_possible(self):
1206
1203
        my_config = config.GlobalConfig.from_string(sample_maybe_signatures)
1207
1204
        self.assertEqual(config.CHECK_NEVER,
1208
 
                         my_config.signature_checking())
 
1205
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1206
                             my_config.signature_checking))
1209
1207
        self.assertEqual(config.SIGN_WHEN_REQUIRED,
1210
 
                         my_config.signing_policy())
1211
 
        self.assertEqual(False, my_config.signature_needed())
 
1208
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1209
                             my_config.signing_policy))
 
1210
        self.assertEqual(False, self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1211
            my_config.signature_needed))
1212
1212
 
1213
1213
    def test_signatures_ignore(self):
1214
1214
        my_config = config.GlobalConfig.from_string(sample_ignore_signatures)
1215
1215
        self.assertEqual(config.CHECK_ALWAYS,
1216
 
                         my_config.signature_checking())
 
1216
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1217
                             my_config.signature_checking))
1217
1218
        self.assertEqual(config.SIGN_NEVER,
1218
 
                         my_config.signing_policy())
1219
 
        self.assertEqual(False, my_config.signature_needed())
 
1219
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1220
                             my_config.signing_policy))
 
1221
        self.assertEqual(False, self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1222
            my_config.signature_needed))
1220
1223
 
1221
1224
    def _get_sample_config(self):
1222
1225
        my_config = config.GlobalConfig.from_string(sample_config_text)
1224
1227
 
1225
1228
    def test_gpg_signing_command(self):
1226
1229
        my_config = self._get_sample_config()
1227
 
        self.assertEqual("gnome-gpg", my_config.gpg_signing_command())
1228
 
        self.assertEqual(False, my_config.signature_needed())
 
1230
        self.assertEqual("gnome-gpg",
 
1231
            self.applyDeprecated(
 
1232
                deprecated_in((2, 5, 0)), my_config.gpg_signing_command))
 
1233
        self.assertEqual(False, self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1234
            my_config.signature_needed))
1229
1235
 
1230
1236
    def test_gpg_signing_key(self):
1231
1237
        my_config = self._get_sample_config()
1232
 
        self.assertEqual("DD4D5088", my_config.gpg_signing_key())
 
1238
        self.assertEqual("DD4D5088",
 
1239
            self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1240
                my_config.gpg_signing_key))
1233
1241
 
1234
1242
    def _get_empty_config(self):
1235
1243
        my_config = config.GlobalConfig()
1237
1245
 
1238
1246
    def test_gpg_signing_command_unset(self):
1239
1247
        my_config = self._get_empty_config()
1240
 
        self.assertEqual("gpg", my_config.gpg_signing_command())
 
1248
        self.assertEqual("gpg",
 
1249
            self.applyDeprecated(
 
1250
                deprecated_in((2, 5, 0)), my_config.gpg_signing_command))
1241
1251
 
1242
1252
    def test_get_user_option_default(self):
1243
1253
        my_config = self._get_empty_config()
1250
1260
 
1251
1261
    def test_post_commit_default(self):
1252
1262
        my_config = self._get_sample_config()
1253
 
        self.assertEqual(None, my_config.post_commit())
 
1263
        self.assertEqual(None,
 
1264
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1265
                                              my_config.post_commit))
1254
1266
 
1255
1267
    def test_configured_logformat(self):
1256
1268
        my_config = self._get_sample_config()
1257
 
        self.assertEqual("short", my_config.log_format())
 
1269
        self.assertEqual("short",
 
1270
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1271
                                              my_config.log_format))
1258
1272
 
1259
1273
    def test_configured_acceptable_keys(self):
1260
1274
        my_config = self._get_sample_config()
1261
 
        self.assertEqual("amy", my_config.acceptable_keys())
 
1275
        self.assertEqual("amy",
 
1276
            self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1277
                my_config.acceptable_keys))
1262
1278
 
1263
1279
    def test_configured_validate_signatures_in_log(self):
1264
1280
        my_config = self._get_sample_config()
1302
1318
        self.log(repr(tools))
1303
1319
        self.assertEqual(
1304
1320
            {u'funkytool' : u'funkytool "arg with spaces" {this_temp}',
1305
 
            u'sometool' : u'sometool {base} {this} {other} -o {result}'},
 
1321
            u'sometool' : u'sometool {base} {this} {other} -o {result}',
 
1322
            u'newtool' : u'"newtool with spaces" {this_temp}'},
1306
1323
            tools)
1307
1324
 
1308
1325
    def test_get_merge_tools_empty(self):
1323
1340
    def test_find_merge_tool_known(self):
1324
1341
        conf = self._get_empty_config()
1325
1342
        cmdline = conf.find_merge_tool('kdiff3')
1326
 
        self.assertEquals('kdiff3 {base} {this} {other} -o {result}', cmdline)
 
1343
        self.assertEqual('kdiff3 {base} {this} {other} -o {result}', cmdline)
1327
1344
 
1328
1345
    def test_find_merge_tool_override_known(self):
1329
1346
        conf = self._get_empty_config()
1356
1373
 
1357
1374
class TestLocationConfig(tests.TestCaseInTempDir, TestOptionsMixin):
1358
1375
 
1359
 
    def test_constructs(self):
1360
 
        my_config = config.LocationConfig('http://example.com')
 
1376
    def test_constructs_valid(self):
 
1377
        config.LocationConfig('http://example.com')
 
1378
 
 
1379
    def test_constructs_error(self):
1361
1380
        self.assertRaises(TypeError, config.LocationConfig)
1362
1381
 
1363
1382
    def test_branch_calls_read_filenames(self):
1499
1518
        self.get_branch_config('http://www.example.com',
1500
1519
                                 global_config=sample_ignore_signatures)
1501
1520
        self.assertEqual(config.CHECK_ALWAYS,
1502
 
                         self.my_config.signature_checking())
 
1521
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1522
                             self.my_config.signature_checking))
1503
1523
        self.assertEqual(config.SIGN_NEVER,
1504
 
                         self.my_config.signing_policy())
 
1524
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1525
                             self.my_config.signing_policy))
1505
1526
 
1506
1527
    def test_signatures_never(self):
1507
1528
        self.get_branch_config('/a/c')
1508
1529
        self.assertEqual(config.CHECK_NEVER,
1509
 
                         self.my_config.signature_checking())
 
1530
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1531
                             self.my_config.signature_checking))
1510
1532
 
1511
1533
    def test_signatures_when_available(self):
1512
1534
        self.get_branch_config('/a/', global_config=sample_ignore_signatures)
1513
1535
        self.assertEqual(config.CHECK_IF_POSSIBLE,
1514
 
                         self.my_config.signature_checking())
 
1536
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1537
                             self.my_config.signature_checking))
1515
1538
 
1516
1539
    def test_signatures_always(self):
1517
1540
        self.get_branch_config('/b')
1518
1541
        self.assertEqual(config.CHECK_ALWAYS,
1519
 
                         self.my_config.signature_checking())
 
1542
            self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1543
                         self.my_config.signature_checking))
1520
1544
 
1521
1545
    def test_gpg_signing_command(self):
1522
1546
        self.get_branch_config('/b')
1523
 
        self.assertEqual("gnome-gpg", self.my_config.gpg_signing_command())
 
1547
        self.assertEqual("gnome-gpg",
 
1548
            self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1549
                self.my_config.gpg_signing_command))
1524
1550
 
1525
1551
    def test_gpg_signing_command_missing(self):
1526
1552
        self.get_branch_config('/a')
1527
 
        self.assertEqual("false", self.my_config.gpg_signing_command())
 
1553
        self.assertEqual("false",
 
1554
            self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1555
                self.my_config.gpg_signing_command))
1528
1556
 
1529
1557
    def test_gpg_signing_key(self):
1530
1558
        self.get_branch_config('/b')
1531
 
        self.assertEqual("DD4D5088", self.my_config.gpg_signing_key())
 
1559
        self.assertEqual("DD4D5088", self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1560
            self.my_config.gpg_signing_key))
1532
1561
 
1533
1562
    def test_gpg_signing_key_default(self):
1534
1563
        self.get_branch_config('/a')
1535
 
        self.assertEqual("erik@bagfors.nu", self.my_config.gpg_signing_key())
 
1564
        self.assertEqual("erik@bagfors.nu",
 
1565
            self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1566
                self.my_config.gpg_signing_key))
1536
1567
 
1537
1568
    def test_get_user_option_global(self):
1538
1569
        self.get_branch_config('/a')
1626
1657
    def test_post_commit_default(self):
1627
1658
        self.get_branch_config('/a/c')
1628
1659
        self.assertEqual('bzrlib.tests.test_config.post_commit',
1629
 
                         self.my_config.post_commit())
 
1660
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1661
                                              self.my_config.post_commit))
1630
1662
 
1631
1663
    def get_branch_config(self, location, global_config=None,
1632
1664
                          location_config=None):
1636
1668
        if location_config is None:
1637
1669
            location_config = sample_branches_text
1638
1670
 
1639
 
        my_global_config = config.GlobalConfig.from_string(global_config,
1640
 
                                                           save=True)
1641
 
        my_location_config = config.LocationConfig.from_string(
1642
 
            location_config, my_branch.base, save=True)
 
1671
        config.GlobalConfig.from_string(global_config, save=True)
 
1672
        config.LocationConfig.from_string(location_config, my_branch.base,
 
1673
                                          save=True)
1643
1674
        my_config = config.BranchConfig(my_branch)
1644
1675
        self.my_config = my_config
1645
1676
        self.my_location_config = my_config._get_location_config()
1710
1741
                          location_config=None, branch_data_config=None):
1711
1742
        my_branch = FakeBranch(location)
1712
1743
        if global_config is not None:
1713
 
            my_global_config = config.GlobalConfig.from_string(global_config,
1714
 
                                                               save=True)
 
1744
            config.GlobalConfig.from_string(global_config, save=True)
1715
1745
        if location_config is not None:
1716
 
            my_location_config = config.LocationConfig.from_string(
1717
 
                location_config, my_branch.base, save=True)
 
1746
            config.LocationConfig.from_string(location_config, my_branch.base,
 
1747
                                              save=True)
1718
1748
        my_config = config.BranchConfig(my_branch)
1719
1749
        if branch_data_config is not None:
1720
1750
            my_config.branch.control_files.files['branch.conf'] = \
1722
1752
        return my_config
1723
1753
 
1724
1754
    def test_user_id(self):
1725
 
        branch = FakeBranch(user_id='Robert Collins <robertc@example.net>')
 
1755
        branch = FakeBranch()
1726
1756
        my_config = config.BranchConfig(branch)
1727
 
        self.assertEqual("Robert Collins <robertc@example.net>",
1728
 
                         my_config.username())
 
1757
        self.assertIsNot(None, my_config.username())
1729
1758
        my_config.branch.control_files.files['email'] = "John"
1730
1759
        my_config.set_user_option('email',
1731
1760
                                  "Robert Collins <robertc@example.org>")
1732
 
        self.assertEqual("John", my_config.username())
1733
 
        del my_config.branch.control_files.files['email']
1734
1761
        self.assertEqual("Robert Collins <robertc@example.org>",
1735
 
                         my_config.username())
1736
 
 
1737
 
    def test_not_set_in_branch(self):
1738
 
        my_config = self.get_branch_config(global_config=sample_config_text)
1739
 
        self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
1740
 
                         my_config._get_user_id())
1741
 
        my_config.branch.control_files.files['email'] = "John"
1742
 
        self.assertEqual("John", my_config._get_user_id())
 
1762
                        my_config.username())
1743
1763
 
1744
1764
    def test_BZR_EMAIL_OVERRIDES(self):
1745
1765
        self.overrideEnv('BZR_EMAIL', "Robert Collins <robertc@example.org>")
1751
1771
    def test_signatures_forced(self):
1752
1772
        my_config = self.get_branch_config(
1753
1773
            global_config=sample_always_signatures)
1754
 
        self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
1755
 
        self.assertEqual(config.SIGN_ALWAYS, my_config.signing_policy())
1756
 
        self.assertTrue(my_config.signature_needed())
 
1774
        self.assertEqual(config.CHECK_NEVER,
 
1775
            self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1776
                my_config.signature_checking))
 
1777
        self.assertEqual(config.SIGN_ALWAYS,
 
1778
            self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1779
                my_config.signing_policy))
 
1780
        self.assertTrue(self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1781
            my_config.signature_needed))
1757
1782
 
1758
1783
    def test_signatures_forced_branch(self):
1759
1784
        my_config = self.get_branch_config(
1760
1785
            global_config=sample_ignore_signatures,
1761
1786
            branch_data_config=sample_always_signatures)
1762
 
        self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
1763
 
        self.assertEqual(config.SIGN_ALWAYS, my_config.signing_policy())
1764
 
        self.assertTrue(my_config.signature_needed())
 
1787
        self.assertEqual(config.CHECK_NEVER,
 
1788
            self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1789
                my_config.signature_checking))
 
1790
        self.assertEqual(config.SIGN_ALWAYS,
 
1791
            self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1792
                my_config.signing_policy))
 
1793
        self.assertTrue(self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1794
            my_config.signature_needed))
1765
1795
 
1766
1796
    def test_gpg_signing_command(self):
1767
1797
        my_config = self.get_branch_config(
1768
1798
            global_config=sample_config_text,
1769
1799
            # branch data cannot set gpg_signing_command
1770
1800
            branch_data_config="gpg_signing_command=pgp")
1771
 
        self.assertEqual('gnome-gpg', my_config.gpg_signing_command())
 
1801
        self.assertEqual('gnome-gpg',
 
1802
            self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1803
                my_config.gpg_signing_command))
1772
1804
 
1773
1805
    def test_get_user_option_global(self):
1774
1806
        my_config = self.get_branch_config(global_config=sample_config_text)
1781
1813
                                      location_config=sample_branches_text)
1782
1814
        self.assertEqual(my_config.branch.base, '/a/c')
1783
1815
        self.assertEqual('bzrlib.tests.test_config.post_commit',
1784
 
                         my_config.post_commit())
 
1816
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1817
                                              my_config.post_commit))
1785
1818
        my_config.set_user_option('post_commit', 'rmtree_root')
1786
1819
        # post-commit is ignored when present in branch data
1787
1820
        self.assertEqual('bzrlib.tests.test_config.post_commit',
1788
 
                         my_config.post_commit())
 
1821
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1822
                                              my_config.post_commit))
1789
1823
        my_config.set_user_option('post_commit', 'rmtree_root',
1790
1824
                                  store=config.STORE_LOCATION)
1791
 
        self.assertEqual('rmtree_root', my_config.post_commit())
 
1825
        self.assertEqual('rmtree_root',
 
1826
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
 
1827
                                              my_config.post_commit))
1792
1828
 
1793
1829
    def test_config_precedence(self):
1794
1830
        # FIXME: eager test, luckily no persitent config file makes it fail
1810
1846
            location='http://example.com/specific')
1811
1847
        self.assertEqual(my_config.get_user_option('option'), 'exact')
1812
1848
 
1813
 
    def test_get_mail_client(self):
1814
 
        config = self.get_branch_config()
1815
 
        client = config.get_mail_client()
1816
 
        self.assertIsInstance(client, mail_client.DefaultMail)
1817
 
 
1818
 
        # Specific clients
1819
 
        config.set_user_option('mail_client', 'evolution')
1820
 
        client = config.get_mail_client()
1821
 
        self.assertIsInstance(client, mail_client.Evolution)
1822
 
 
1823
 
        config.set_user_option('mail_client', 'kmail')
1824
 
        client = config.get_mail_client()
1825
 
        self.assertIsInstance(client, mail_client.KMail)
1826
 
 
1827
 
        config.set_user_option('mail_client', 'mutt')
1828
 
        client = config.get_mail_client()
1829
 
        self.assertIsInstance(client, mail_client.Mutt)
1830
 
 
1831
 
        config.set_user_option('mail_client', 'thunderbird')
1832
 
        client = config.get_mail_client()
1833
 
        self.assertIsInstance(client, mail_client.Thunderbird)
1834
 
 
1835
 
        # Generic options
1836
 
        config.set_user_option('mail_client', 'default')
1837
 
        client = config.get_mail_client()
1838
 
        self.assertIsInstance(client, mail_client.DefaultMail)
1839
 
 
1840
 
        config.set_user_option('mail_client', 'editor')
1841
 
        client = config.get_mail_client()
1842
 
        self.assertIsInstance(client, mail_client.Editor)
1843
 
 
1844
 
        config.set_user_option('mail_client', 'mapi')
1845
 
        client = config.get_mail_client()
1846
 
        self.assertIsInstance(client, mail_client.MAPIClient)
1847
 
 
1848
 
        config.set_user_option('mail_client', 'xdg-email')
1849
 
        client = config.get_mail_client()
1850
 
        self.assertIsInstance(client, mail_client.XDGEmail)
1851
 
 
1852
 
        config.set_user_option('mail_client', 'firebird')
1853
 
        self.assertRaises(errors.UnknownMailClient, config.get_mail_client)
1854
 
 
1855
1849
 
1856
1850
class TestMailAddressExtraction(tests.TestCase):
1857
1851
 
1912
1906
        # Store the raw content in the config file
1913
1907
        t.put_bytes('foo.conf', utf8_content)
1914
1908
        conf = config.TransportConfig(t, 'foo.conf')
1915
 
        self.assertEquals(unicode_user, conf.get_option('user'))
 
1909
        self.assertEqual(unicode_user, conf.get_option('user'))
1916
1910
 
1917
1911
    def test_load_non_ascii(self):
1918
1912
        """Ensure we display a proper error on non-ascii, non utf-8 content."""
1928
1922
        conf = config.TransportConfig(t, 'foo.conf')
1929
1923
        self.assertRaises(errors.ParseConfigError, conf._get_configobj)
1930
1924
 
 
1925
    def test_load_permission_denied(self):
 
1926
        """Ensure we get an empty config file if the file is inaccessible."""
 
1927
        warnings = []
 
1928
        def warning(*args):
 
1929
            warnings.append(args[0] % args[1:])
 
1930
        self.overrideAttr(trace, 'warning', warning)
 
1931
 
 
1932
        class DenyingTransport(object):
 
1933
 
 
1934
            def __init__(self, base):
 
1935
                self.base = base
 
1936
 
 
1937
            def get_bytes(self, relpath):
 
1938
                raise errors.PermissionDenied(relpath, "")
 
1939
 
 
1940
        cfg = config.TransportConfig(
 
1941
            DenyingTransport("nonexisting://"), 'control.conf')
 
1942
        self.assertIs(None, cfg.get_option('non-existant', 'SECTION'))
 
1943
        self.assertEqual(
 
1944
            warnings,
 
1945
            [u'Permission denied while trying to open configuration file '
 
1946
             u'nonexisting:///control.conf.'])
 
1947
 
1931
1948
    def test_get_value(self):
1932
1949
        """Test that retreiving a value from a section is possible"""
1933
1950
        bzrdir_config = config.TransportConfig(self.get_transport('.'),
1981
1998
            config.OldConfigHooks.uninstall_named_hook, 'get', None)
1982
1999
        self.assertLength(0, calls)
1983
2000
        actual_value = conf.get_user_option(name)
1984
 
        self.assertEquals(value, actual_value)
 
2001
        self.assertEqual(value, actual_value)
1985
2002
        self.assertLength(1, calls)
1986
 
        self.assertEquals((conf, name, value), calls[0])
 
2003
        self.assertEqual((conf, name, value), calls[0])
1987
2004
 
1988
2005
    def test_get_hook_bazaar(self):
1989
2006
        self.assertGetHook(self.bazaar_config, 'file', 'bazaar')
2009
2026
        # We can't assert the conf object below as different configs use
2010
2027
        # different means to implement set_user_option and we care only about
2011
2028
        # coverage here.
2012
 
        self.assertEquals((name, value), calls[0][1:])
 
2029
        self.assertEqual((name, value), calls[0][1:])
2013
2030
 
2014
2031
    def test_set_hook_bazaar(self):
2015
2032
        self.assertSetHook(self.bazaar_config, 'foo', 'bazaar')
2033
2050
        # We can't assert the conf object below as different configs use
2034
2051
        # different means to implement remove_user_option and we care only about
2035
2052
        # coverage here.
2036
 
        self.assertEquals((name,), calls[0][1:])
 
2053
        self.assertEqual((name,), calls[0][1:])
2037
2054
 
2038
2055
    def test_remove_hook_bazaar(self):
2039
2056
        self.assertRemoveHook(self.bazaar_config, 'file')
2112
2129
            config.OldConfigHooks.uninstall_named_hook, 'get', None)
2113
2130
        self.assertLength(0, calls)
2114
2131
        actual_value = conf.get_option(name)
2115
 
        self.assertEquals(value, actual_value)
 
2132
        self.assertEqual(value, actual_value)
2116
2133
        self.assertLength(1, calls)
2117
 
        self.assertEquals((conf, name, value), calls[0])
 
2134
        self.assertEqual((conf, name, value), calls[0])
2118
2135
 
2119
2136
    def test_get_hook_remote_branch(self):
2120
2137
        remote_branch = branch.Branch.open(self.get_url('tree'))
2121
2138
        self.assertGetHook(remote_branch._get_config(), 'file', 'branch')
2122
2139
 
2123
2140
    def test_get_hook_remote_bzrdir(self):
2124
 
        remote_bzrdir = bzrdir.BzrDir.open(self.get_url('tree'))
 
2141
        remote_bzrdir = controldir.ControlDir.open(self.get_url('tree'))
2125
2142
        conf = remote_bzrdir._get_config()
2126
2143
        conf.set_option('remotedir', 'file')
2127
2144
        self.assertGetHook(conf, 'file', 'remotedir')
2139
2156
        # We can't assert the conf object below as different configs use
2140
2157
        # different means to implement set_user_option and we care only about
2141
2158
        # coverage here.
2142
 
        self.assertEquals((name, value), calls[0][1:])
 
2159
        self.assertEqual((name, value), calls[0][1:])
2143
2160
 
2144
2161
    def test_set_hook_remote_branch(self):
2145
2162
        remote_branch = branch.Branch.open(self.get_url('tree'))
2149
2166
    def test_set_hook_remote_bzrdir(self):
2150
2167
        remote_branch = branch.Branch.open(self.get_url('tree'))
2151
2168
        self.addCleanup(remote_branch.lock_write().unlock)
2152
 
        remote_bzrdir = bzrdir.BzrDir.open(self.get_url('tree'))
 
2169
        remote_bzrdir = controldir.ControlDir.open(self.get_url('tree'))
2153
2170
        self.assertSetHook(remote_bzrdir._get_config(), 'file', 'remotedir')
2154
2171
 
2155
2172
    def assertLoadHook(self, expected_nb_calls, name, conf_class, *conf_args):
2172
2189
        self.assertLoadHook(1, 'file', remote.RemoteBranchConfig, remote_branch)
2173
2190
 
2174
2191
    def test_load_hook_remote_bzrdir(self):
2175
 
        remote_bzrdir = bzrdir.BzrDir.open(self.get_url('tree'))
 
2192
        remote_bzrdir = controldir.ControlDir.open(self.get_url('tree'))
2176
2193
        # The config file doesn't exist, set an option to force its creation
2177
2194
        conf = remote_bzrdir._get_config()
2178
2195
        conf.set_option('remotedir', 'file')
2203
2220
    def test_save_hook_remote_bzrdir(self):
2204
2221
        remote_branch = branch.Branch.open(self.get_url('tree'))
2205
2222
        self.addCleanup(remote_branch.lock_write().unlock)
2206
 
        remote_bzrdir = bzrdir.BzrDir.open(self.get_url('tree'))
 
2223
        remote_bzrdir = controldir.ControlDir.open(self.get_url('tree'))
2207
2224
        self.assertSaveHook(remote_bzrdir._get_config())
2208
2225
 
2209
2226
 
 
2227
class TestOptionNames(tests.TestCase):
 
2228
 
 
2229
    def is_valid(self, name):
 
2230
        return config._option_ref_re.match('{%s}' % name) is not None
 
2231
 
 
2232
    def test_valid_names(self):
 
2233
        self.assertTrue(self.is_valid('foo'))
 
2234
        self.assertTrue(self.is_valid('foo.bar'))
 
2235
        self.assertTrue(self.is_valid('f1'))
 
2236
        self.assertTrue(self.is_valid('_'))
 
2237
        self.assertTrue(self.is_valid('__bar__'))
 
2238
        self.assertTrue(self.is_valid('a_'))
 
2239
        self.assertTrue(self.is_valid('a1'))
 
2240
        # Don't break bzr-svn for no good reason
 
2241
        self.assertTrue(self.is_valid('guessed-layout'))
 
2242
 
 
2243
    def test_invalid_names(self):
 
2244
        self.assertFalse(self.is_valid(' foo'))
 
2245
        self.assertFalse(self.is_valid('foo '))
 
2246
        self.assertFalse(self.is_valid('1'))
 
2247
        self.assertFalse(self.is_valid('1,2'))
 
2248
        self.assertFalse(self.is_valid('foo$'))
 
2249
        self.assertFalse(self.is_valid('!foo'))
 
2250
        self.assertFalse(self.is_valid('foo.'))
 
2251
        self.assertFalse(self.is_valid('foo..bar'))
 
2252
        self.assertFalse(self.is_valid('{}'))
 
2253
        self.assertFalse(self.is_valid('{a}'))
 
2254
        self.assertFalse(self.is_valid('a\n'))
 
2255
        self.assertFalse(self.is_valid('-'))
 
2256
        self.assertFalse(self.is_valid('-a'))
 
2257
        self.assertFalse(self.is_valid('a-'))
 
2258
        self.assertFalse(self.is_valid('a--a'))
 
2259
 
 
2260
    def assertSingleGroup(self, reference):
 
2261
        # the regexp is used with split and as such should match the reference
 
2262
        # *only*, if more groups needs to be defined, (?:...) should be used.
 
2263
        m = config._option_ref_re.match('{a}')
 
2264
        self.assertLength(1, m.groups())
 
2265
 
 
2266
    def test_valid_references(self):
 
2267
        self.assertSingleGroup('{a}')
 
2268
        self.assertSingleGroup('{{a}}')
 
2269
 
 
2270
 
2210
2271
class TestOption(tests.TestCase):
2211
2272
 
2212
2273
    def test_default_value(self):
2213
2274
        opt = config.Option('foo', default='bar')
2214
 
        self.assertEquals('bar', opt.get_default())
 
2275
        self.assertEqual('bar', opt.get_default())
 
2276
 
 
2277
    def test_callable_default_value(self):
 
2278
        def bar_as_unicode():
 
2279
            return u'bar'
 
2280
        opt = config.Option('foo', default=bar_as_unicode)
 
2281
        self.assertEqual('bar', opt.get_default())
 
2282
 
 
2283
    def test_default_value_from_env(self):
 
2284
        opt = config.Option('foo', default='bar', default_from_env=['FOO'])
 
2285
        self.overrideEnv('FOO', 'quux')
 
2286
        # Env variable provides a default taking over the option one
 
2287
        self.assertEqual('quux', opt.get_default())
 
2288
 
 
2289
    def test_first_default_value_from_env_wins(self):
 
2290
        opt = config.Option('foo', default='bar',
 
2291
                            default_from_env=['NO_VALUE', 'FOO', 'BAZ'])
 
2292
        self.overrideEnv('FOO', 'foo')
 
2293
        self.overrideEnv('BAZ', 'baz')
 
2294
        # The first env var set wins
 
2295
        self.assertEqual('foo', opt.get_default())
 
2296
 
 
2297
    def test_not_supported_list_default_value(self):
 
2298
        self.assertRaises(AssertionError, config.Option, 'foo', default=[1])
 
2299
 
 
2300
    def test_not_supported_object_default_value(self):
 
2301
        self.assertRaises(AssertionError, config.Option, 'foo',
 
2302
                          default=object())
 
2303
 
 
2304
    def test_not_supported_callable_default_value_not_unicode(self):
 
2305
        def bar_not_unicode():
 
2306
            return 'bar'
 
2307
        opt = config.Option('foo', default=bar_not_unicode)
 
2308
        self.assertRaises(AssertionError, opt.get_default)
 
2309
 
 
2310
    def test_get_help_topic(self):
 
2311
        opt = config.Option('foo')
 
2312
        self.assertEqual('foo', opt.get_help_topic())
 
2313
 
 
2314
 
 
2315
class TestOptionConverter(tests.TestCase):
 
2316
 
 
2317
    def assertConverted(self, expected, opt, value):
 
2318
        self.assertEqual(expected, opt.convert_from_unicode(None, value))
 
2319
 
 
2320
    def assertCallsWarning(self, opt, value):
 
2321
        warnings = []
 
2322
 
 
2323
        def warning(*args):
 
2324
            warnings.append(args[0] % args[1:])
 
2325
        self.overrideAttr(trace, 'warning', warning)
 
2326
        self.assertEqual(None, opt.convert_from_unicode(None, value))
 
2327
        self.assertLength(1, warnings)
 
2328
        self.assertEqual(
 
2329
            'Value "%s" is not valid for "%s"' % (value, opt.name),
 
2330
            warnings[0])
 
2331
 
 
2332
    def assertCallsError(self, opt, value):
 
2333
        self.assertRaises(errors.ConfigOptionValueError,
 
2334
                          opt.convert_from_unicode, None, value)
 
2335
 
 
2336
    def assertConvertInvalid(self, opt, invalid_value):
 
2337
        opt.invalid = None
 
2338
        self.assertEqual(None, opt.convert_from_unicode(None, invalid_value))
 
2339
        opt.invalid = 'warning'
 
2340
        self.assertCallsWarning(opt, invalid_value)
 
2341
        opt.invalid = 'error'
 
2342
        self.assertCallsError(opt, invalid_value)
 
2343
 
 
2344
 
 
2345
class TestOptionWithBooleanConverter(TestOptionConverter):
 
2346
 
 
2347
    def get_option(self):
 
2348
        return config.Option('foo', help='A boolean.',
 
2349
                             from_unicode=config.bool_from_store)
 
2350
 
 
2351
    def test_convert_invalid(self):
 
2352
        opt = self.get_option()
 
2353
        # A string that is not recognized as a boolean
 
2354
        self.assertConvertInvalid(opt, u'invalid-boolean')
 
2355
        # A list of strings is never recognized as a boolean
 
2356
        self.assertConvertInvalid(opt, [u'not', u'a', u'boolean'])
 
2357
 
 
2358
    def test_convert_valid(self):
 
2359
        opt = self.get_option()
 
2360
        self.assertConverted(True, opt, u'True')
 
2361
        self.assertConverted(True, opt, u'1')
 
2362
        self.assertConverted(False, opt, u'False')
 
2363
 
 
2364
 
 
2365
class TestOptionWithIntegerConverter(TestOptionConverter):
 
2366
 
 
2367
    def get_option(self):
 
2368
        return config.Option('foo', help='An integer.',
 
2369
                             from_unicode=config.int_from_store)
 
2370
 
 
2371
    def test_convert_invalid(self):
 
2372
        opt = self.get_option()
 
2373
        # A string that is not recognized as an integer
 
2374
        self.assertConvertInvalid(opt, u'forty-two')
 
2375
        # A list of strings is never recognized as an integer
 
2376
        self.assertConvertInvalid(opt, [u'a', u'list'])
 
2377
 
 
2378
    def test_convert_valid(self):
 
2379
        opt = self.get_option()
 
2380
        self.assertConverted(16, opt, u'16')
 
2381
 
 
2382
 
 
2383
class TestOptionWithSIUnitConverter(TestOptionConverter):
 
2384
 
 
2385
    def get_option(self):
 
2386
        return config.Option('foo', help='An integer in SI units.',
 
2387
                             from_unicode=config.int_SI_from_store)
 
2388
 
 
2389
    def test_convert_invalid(self):
 
2390
        opt = self.get_option()
 
2391
        self.assertConvertInvalid(opt, u'not-a-unit')
 
2392
        self.assertConvertInvalid(opt, u'Gb')  # Forgot the value
 
2393
        self.assertConvertInvalid(opt, u'1b')  # Forgot the unit
 
2394
        self.assertConvertInvalid(opt, u'1GG')
 
2395
        self.assertConvertInvalid(opt, u'1Mbb')
 
2396
        self.assertConvertInvalid(opt, u'1MM')
 
2397
 
 
2398
    def test_convert_valid(self):
 
2399
        opt = self.get_option()
 
2400
        self.assertConverted(int(5e3), opt, u'5kb')
 
2401
        self.assertConverted(int(5e6), opt, u'5M')
 
2402
        self.assertConverted(int(5e6), opt, u'5MB')
 
2403
        self.assertConverted(int(5e9), opt, u'5g')
 
2404
        self.assertConverted(int(5e9), opt, u'5gB')
 
2405
        self.assertConverted(100, opt, u'100')
 
2406
 
 
2407
 
 
2408
class TestListOption(TestOptionConverter):
 
2409
 
 
2410
    def get_option(self):
 
2411
        return config.ListOption('foo', help='A list.')
 
2412
 
 
2413
    def test_convert_invalid(self):
 
2414
        opt = self.get_option()
 
2415
        # We don't even try to convert a list into a list, we only expect
 
2416
        # strings
 
2417
        self.assertConvertInvalid(opt, [1])
 
2418
        # No string is invalid as all forms can be converted to a list
 
2419
 
 
2420
    def test_convert_valid(self):
 
2421
        opt = self.get_option()
 
2422
        # An empty string is an empty list
 
2423
        self.assertConverted([], opt, '')  # Using a bare str() just in case
 
2424
        self.assertConverted([], opt, u'')
 
2425
        # A boolean
 
2426
        self.assertConverted([u'True'], opt, u'True')
 
2427
        # An integer
 
2428
        self.assertConverted([u'42'], opt, u'42')
 
2429
        # A single string
 
2430
        self.assertConverted([u'bar'], opt, u'bar')
 
2431
 
 
2432
 
 
2433
class TestRegistryOption(TestOptionConverter):
 
2434
 
 
2435
    def get_option(self, registry):
 
2436
        return config.RegistryOption('foo', registry,
 
2437
                                     help='A registry option.')
 
2438
 
 
2439
    def test_convert_invalid(self):
 
2440
        registry = _mod_registry.Registry()
 
2441
        opt = self.get_option(registry)
 
2442
        self.assertConvertInvalid(opt, [1])
 
2443
        self.assertConvertInvalid(opt, u"notregistered")
 
2444
 
 
2445
    def test_convert_valid(self):
 
2446
        registry = _mod_registry.Registry()
 
2447
        registry.register("someval", 1234)
 
2448
        opt = self.get_option(registry)
 
2449
        # Using a bare str() just in case
 
2450
        self.assertConverted(1234, opt, "someval")
 
2451
        self.assertConverted(1234, opt, u'someval')
 
2452
        self.assertConverted(None, opt, None)
 
2453
 
 
2454
    def test_help(self):
 
2455
        registry = _mod_registry.Registry()
 
2456
        registry.register("someval", 1234, help="some option")
 
2457
        registry.register("dunno", 1234, help="some other option")
 
2458
        opt = self.get_option(registry)
 
2459
        self.assertEqual(
 
2460
            'A registry option.\n'
 
2461
            '\n'
 
2462
            'The following values are supported:\n'
 
2463
            ' dunno - some other option\n'
 
2464
            ' someval - some option\n',
 
2465
            opt.help)
 
2466
 
 
2467
    def test_get_help_text(self):
 
2468
        registry = _mod_registry.Registry()
 
2469
        registry.register("someval", 1234, help="some option")
 
2470
        registry.register("dunno", 1234, help="some other option")
 
2471
        opt = self.get_option(registry)
 
2472
        self.assertEqual(
 
2473
            'A registry option.\n'
 
2474
            '\n'
 
2475
            'The following values are supported:\n'
 
2476
            ' dunno - some other option\n'
 
2477
            ' someval - some option\n',
 
2478
            opt.get_help_text())
2215
2479
 
2216
2480
 
2217
2481
class TestOptionRegistry(tests.TestCase):
2230
2494
    def test_registered_help(self):
2231
2495
        opt = config.Option('foo', help='A simple option')
2232
2496
        self.registry.register(opt)
2233
 
        self.assertEquals('A simple option', self.registry.get_help('foo'))
 
2497
        self.assertEqual('A simple option', self.registry.get_help('foo'))
 
2498
 
 
2499
    def test_dont_register_illegal_name(self):
 
2500
        self.assertRaises(errors.IllegalOptionName,
 
2501
                          self.registry.register, config.Option(' foo'))
 
2502
        self.assertRaises(errors.IllegalOptionName,
 
2503
                          self.registry.register, config.Option('bar,'))
2234
2504
 
2235
2505
    lazy_option = config.Option('lazy_foo', help='Lazy help')
2236
2506
 
2242
2512
    def test_registered_lazy_help(self):
2243
2513
        self.registry.register_lazy('lazy_foo', self.__module__,
2244
2514
                                    'TestOptionRegistry.lazy_option')
2245
 
        self.assertEquals('Lazy help', self.registry.get_help('lazy_foo'))
 
2515
        self.assertEqual('Lazy help', self.registry.get_help('lazy_foo'))
 
2516
 
 
2517
    def test_dont_lazy_register_illegal_name(self):
 
2518
        # This is where the root cause of http://pad.lv/1235099 is better
 
2519
        # understood: 'register_lazy' doc string mentions that key should match
 
2520
        # the option name which indirectly requires that the option name is a
 
2521
        # valid python identifier. We violate that rule here (using a key that
 
2522
        # doesn't match the option name) to test the option name checking.
 
2523
        self.assertRaises(errors.IllegalOptionName,
 
2524
                          self.registry.register_lazy, ' foo', self.__module__,
 
2525
                          'TestOptionRegistry.lazy_option')
 
2526
        self.assertRaises(errors.IllegalOptionName,
 
2527
                          self.registry.register_lazy, '1,2', self.__module__,
 
2528
                          'TestOptionRegistry.lazy_option')
2246
2529
 
2247
2530
 
2248
2531
class TestRegisteredOptions(tests.TestCase):
2258
2541
    def test_proper_name(self):
2259
2542
        # An option should be registered under its own name, this can't be
2260
2543
        # checked at registration time for the lazy ones.
2261
 
        self.assertEquals(self.option_name, self.option.name)
 
2544
        self.assertEqual(self.option_name, self.option.name)
2262
2545
 
2263
2546
    def test_help_is_set(self):
2264
2547
        option_help = self.registry.get_help(self.option_name)
2265
 
        self.assertNotEquals(None, option_help)
2266
2548
        # Come on, think about the user, he really wants to know what the
2267
2549
        # option is about
2268
2550
        self.assertIsNot(None, option_help)
2269
 
        self.assertNotEquals('', option_help)
 
2551
        self.assertNotEqual('', option_help)
2270
2552
 
2271
2553
 
2272
2554
class TestSection(tests.TestCase):
2277
2559
    def test_get_a_value(self):
2278
2560
        a_dict = dict(foo='bar')
2279
2561
        section = config.Section('myID', a_dict)
2280
 
        self.assertEquals('bar', section.get('foo'))
 
2562
        self.assertEqual('bar', section.get('foo'))
2281
2563
 
2282
2564
    def test_get_unknown_option(self):
2283
2565
        a_dict = dict()
2284
2566
        section = config.Section(None, a_dict)
2285
 
        self.assertEquals('out of thin air',
 
2567
        self.assertEqual('out of thin air',
2286
2568
                          section.get('foo', 'out of thin air'))
2287
2569
 
2288
2570
    def test_options_is_shared(self):
2293
2575
 
2294
2576
class TestMutableSection(tests.TestCase):
2295
2577
 
2296
 
    # FIXME: Parametrize so that all sections (including os.environ and the
2297
 
    # ones produced by Stores) run these tests -- vila 2011-04-01
 
2578
    scenarios = [('mutable',
 
2579
                  {'get_section':
 
2580
                       lambda opts: config.MutableSection('myID', opts)},),
 
2581
        ]
2298
2582
 
2299
2583
    def test_set(self):
2300
2584
        a_dict = dict(foo='bar')
2301
 
        section = config.MutableSection('myID', a_dict)
 
2585
        section = self.get_section(a_dict)
2302
2586
        section.set('foo', 'new_value')
2303
 
        self.assertEquals('new_value', section.get('foo'))
 
2587
        self.assertEqual('new_value', section.get('foo'))
2304
2588
        # The change appears in the shared section
2305
 
        self.assertEquals('new_value', a_dict.get('foo'))
 
2589
        self.assertEqual('new_value', a_dict.get('foo'))
2306
2590
        # We keep track of the change
2307
2591
        self.assertTrue('foo' in section.orig)
2308
 
        self.assertEquals('bar', section.orig.get('foo'))
 
2592
        self.assertEqual('bar', section.orig.get('foo'))
2309
2593
 
2310
2594
    def test_set_preserve_original_once(self):
2311
2595
        a_dict = dict(foo='bar')
2312
 
        section = config.MutableSection('myID', a_dict)
 
2596
        section = self.get_section(a_dict)
2313
2597
        section.set('foo', 'first_value')
2314
2598
        section.set('foo', 'second_value')
2315
2599
        # We keep track of the original value
2316
2600
        self.assertTrue('foo' in section.orig)
2317
 
        self.assertEquals('bar', section.orig.get('foo'))
 
2601
        self.assertEqual('bar', section.orig.get('foo'))
2318
2602
 
2319
2603
    def test_remove(self):
2320
2604
        a_dict = dict(foo='bar')
2321
 
        section = config.MutableSection('myID', a_dict)
 
2605
        section = self.get_section(a_dict)
2322
2606
        section.remove('foo')
2323
2607
        # We get None for unknown options via the default value
2324
 
        self.assertEquals(None, section.get('foo'))
 
2608
        self.assertEqual(None, section.get('foo'))
2325
2609
        # Or we just get the default value
2326
 
        self.assertEquals('unknown', section.get('foo', 'unknown'))
 
2610
        self.assertEqual('unknown', section.get('foo', 'unknown'))
2327
2611
        self.assertFalse('foo' in section.options)
2328
2612
        # We keep track of the deletion
2329
2613
        self.assertTrue('foo' in section.orig)
2330
 
        self.assertEquals('bar', section.orig.get('foo'))
 
2614
        self.assertEqual('bar', section.orig.get('foo'))
2331
2615
 
2332
2616
    def test_remove_new_option(self):
2333
2617
        a_dict = dict()
2334
 
        section = config.MutableSection('myID', a_dict)
 
2618
        section = self.get_section(a_dict)
2335
2619
        section.set('foo', 'bar')
2336
2620
        section.remove('foo')
2337
2621
        self.assertFalse('foo' in section.options)
2338
2622
        # The option didn't exist initially so it we need to keep track of it
2339
2623
        # with a special value
2340
2624
        self.assertTrue('foo' in section.orig)
2341
 
        self.assertEquals(config._NewlyCreatedOption, section.orig['foo'])
 
2625
        self.assertEqual(config._NewlyCreatedOption, section.orig['foo'])
 
2626
 
 
2627
 
 
2628
class TestCommandLineStore(tests.TestCase):
 
2629
 
 
2630
    def setUp(self):
 
2631
        super(TestCommandLineStore, self).setUp()
 
2632
        self.store = config.CommandLineStore()
 
2633
        self.overrideAttr(config, 'option_registry', config.OptionRegistry())
 
2634
 
 
2635
    def get_section(self):
 
2636
        """Get the unique section for the command line overrides."""
 
2637
        sections = list(self.store.get_sections())
 
2638
        self.assertLength(1, sections)
 
2639
        store, section = sections[0]
 
2640
        self.assertEqual(self.store, store)
 
2641
        return section
 
2642
 
 
2643
    def test_no_override(self):
 
2644
        self.store._from_cmdline([])
 
2645
        section = self.get_section()
 
2646
        self.assertLength(0, list(section.iter_option_names()))
 
2647
 
 
2648
    def test_simple_override(self):
 
2649
        self.store._from_cmdline(['a=b'])
 
2650
        section = self.get_section()
 
2651
        self.assertEqual('b', section.get('a'))
 
2652
 
 
2653
    def test_list_override(self):
 
2654
        opt = config.ListOption('l')
 
2655
        config.option_registry.register(opt)
 
2656
        self.store._from_cmdline(['l=1,2,3'])
 
2657
        val = self.get_section().get('l')
 
2658
        self.assertEqual('1,2,3', val)
 
2659
        # Reminder: lists should be registered as such explicitely, otherwise
 
2660
        # the conversion needs to be done afterwards.
 
2661
        self.assertEqual(['1', '2', '3'],
 
2662
                         opt.convert_from_unicode(self.store, val))
 
2663
 
 
2664
    def test_multiple_overrides(self):
 
2665
        self.store._from_cmdline(['a=b', 'x=y'])
 
2666
        section = self.get_section()
 
2667
        self.assertEqual('b', section.get('a'))
 
2668
        self.assertEqual('y', section.get('x'))
 
2669
 
 
2670
    def test_wrong_syntax(self):
 
2671
        self.assertRaises(errors.BzrCommandError,
 
2672
                          self.store._from_cmdline, ['a=b', 'c'])
 
2673
 
 
2674
class TestStoreMinimalAPI(tests.TestCaseWithTransport):
 
2675
 
 
2676
    scenarios = [(key, {'get_store': builder}) for key, builder
 
2677
                 in config.test_store_builder_registry.iteritems()] + [
 
2678
        ('cmdline', {'get_store': lambda test: config.CommandLineStore()})]
 
2679
 
 
2680
    def test_id(self):
 
2681
        store = self.get_store(self)
 
2682
        if type(store) == config.TransportIniFileStore:
 
2683
            raise tests.TestNotApplicable(
 
2684
                "%s is not a concrete Store implementation"
 
2685
                " so it doesn't need an id" % (store.__class__.__name__,))
 
2686
        self.assertIsNot(None, store.id)
2342
2687
 
2343
2688
 
2344
2689
class TestStore(tests.TestCaseWithTransport):
2345
2690
 
2346
 
    def assertSectionContent(self, expected, section):
 
2691
    def assertSectionContent(self, expected, (store, section)):
2347
2692
        """Assert that some options have the proper values in a section."""
2348
2693
        expected_name, expected_options = expected
2349
 
        self.assertEquals(expected_name, section.id)
2350
 
        self.assertEquals(
 
2694
        self.assertEqual(expected_name, section.id)
 
2695
        self.assertEqual(
2351
2696
            expected_options,
2352
2697
            dict([(k, section.get(k)) for k in expected_options.keys()]))
2353
2698
 
2357
2702
    scenarios = [(key, {'get_store': builder}) for key, builder
2358
2703
                 in config.test_store_builder_registry.iteritems()]
2359
2704
 
2360
 
    def setUp(self):
2361
 
        super(TestReadonlyStore, self).setUp()
2362
 
 
2363
2705
    def test_building_delays_load(self):
2364
2706
        store = self.get_store(self)
2365
 
        self.assertEquals(False, store.is_loaded())
 
2707
        self.assertEqual(False, store.is_loaded())
2366
2708
        store._load_from_string('')
2367
 
        self.assertEquals(True, store.is_loaded())
 
2709
        self.assertEqual(True, store.is_loaded())
2368
2710
 
2369
2711
    def test_get_no_sections_for_empty(self):
2370
2712
        store = self.get_store(self)
2371
2713
        store._load_from_string('')
2372
 
        self.assertEquals([], list(store.get_sections()))
 
2714
        self.assertEqual([], list(store.get_sections()))
2373
2715
 
2374
2716
    def test_get_default_section(self):
2375
2717
        store = self.get_store(self)
2391
2733
        self.assertRaises(AssertionError, store._load_from_string, 'bar=baz')
2392
2734
 
2393
2735
 
 
2736
class TestStoreQuoting(TestStore):
 
2737
 
 
2738
    scenarios = [(key, {'get_store': builder}) for key, builder
 
2739
                 in config.test_store_builder_registry.iteritems()]
 
2740
 
 
2741
    def setUp(self):
 
2742
        super(TestStoreQuoting, self).setUp()
 
2743
        self.store = self.get_store(self)
 
2744
        # We need a loaded store but any content will do
 
2745
        self.store._load_from_string('')
 
2746
 
 
2747
    def assertIdempotent(self, s):
 
2748
        """Assert that quoting an unquoted string is a no-op and vice-versa.
 
2749
 
 
2750
        What matters here is that option values, as they appear in a store, can
 
2751
        be safely round-tripped out of the store and back.
 
2752
 
 
2753
        :param s: A string, quoted if required.
 
2754
        """
 
2755
        self.assertEqual(s, self.store.quote(self.store.unquote(s)))
 
2756
        self.assertEqual(s, self.store.unquote(self.store.quote(s)))
 
2757
 
 
2758
    def test_empty_string(self):
 
2759
        if isinstance(self.store, config.IniFileStore):
 
2760
            # configobj._quote doesn't handle empty values
 
2761
            self.assertRaises(AssertionError,
 
2762
                              self.assertIdempotent, '')
 
2763
        else:
 
2764
            self.assertIdempotent('')
 
2765
        # But quoted empty strings are ok
 
2766
        self.assertIdempotent('""')
 
2767
 
 
2768
    def test_embedded_spaces(self):
 
2769
        self.assertIdempotent('" a b c "')
 
2770
 
 
2771
    def test_embedded_commas(self):
 
2772
        self.assertIdempotent('" a , b c "')
 
2773
 
 
2774
    def test_simple_comma(self):
 
2775
        if isinstance(self.store, config.IniFileStore):
 
2776
            # configobj requires that lists are special-cased
 
2777
           self.assertRaises(AssertionError,
 
2778
                             self.assertIdempotent, ',')
 
2779
        else:
 
2780
            self.assertIdempotent(',')
 
2781
        # When a single comma is required, quoting is also required
 
2782
        self.assertIdempotent('","')
 
2783
 
 
2784
    def test_list(self):
 
2785
        if isinstance(self.store, config.IniFileStore):
 
2786
            # configobj requires that lists are special-cased
 
2787
            self.assertRaises(AssertionError,
 
2788
                              self.assertIdempotent, 'a,b')
 
2789
        else:
 
2790
            self.assertIdempotent('a,b')
 
2791
 
 
2792
 
 
2793
class TestDictFromStore(tests.TestCase):
 
2794
 
 
2795
    def test_unquote_not_string(self):
 
2796
        conf = config.MemoryStack('x=2\n[a_section]\na=1\n')
 
2797
        value = conf.get('a_section')
 
2798
        # Urgh, despite 'conf' asking for the no-name section, we get the
 
2799
        # content of another section as a dict o_O
 
2800
        self.assertEqual({'a': '1'}, value)
 
2801
        unquoted = conf.store.unquote(value)
 
2802
        # Which cannot be unquoted but shouldn't crash either (the use cases
 
2803
        # are getting the value or displaying it. In the later case, '%s' will
 
2804
        # do).
 
2805
        self.assertEqual({'a': '1'}, unquoted)
 
2806
        self.assertEqual("{u'a': u'1'}", '%s' % (unquoted,))
 
2807
 
 
2808
 
2394
2809
class TestIniFileStoreContent(tests.TestCaseWithTransport):
2395
 
    """Simulate loading a config store without content of various encodings.
 
2810
    """Simulate loading a config store with content of various encodings.
2396
2811
 
2397
2812
    All files produced by bzr are in utf8 content.
2398
2813
 
2411
2826
        utf8_content = unicode_content.encode('utf8')
2412
2827
        # Store the raw content in the config file
2413
2828
        t.put_bytes('foo.conf', utf8_content)
2414
 
        store = config.IniFileStore(t, 'foo.conf')
 
2829
        store = config.TransportIniFileStore(t, 'foo.conf')
2415
2830
        store.load()
2416
2831
        stack = config.Stack([store.get_sections], store)
2417
 
        self.assertEquals(unicode_user, stack.get('user'))
 
2832
        self.assertEqual(unicode_user, stack.get('user'))
2418
2833
 
2419
2834
    def test_load_non_ascii(self):
2420
2835
        """Ensure we display a proper error on non-ascii, non utf-8 content."""
2421
2836
        t = self.get_transport()
2422
2837
        t.put_bytes('foo.conf', 'user=foo\n#%s\n' % (self.invalid_utf8_char,))
2423
 
        store = config.IniFileStore(t, 'foo.conf')
 
2838
        store = config.TransportIniFileStore(t, 'foo.conf')
2424
2839
        self.assertRaises(errors.ConfigContentError, store.load)
2425
2840
 
2426
2841
    def test_load_erroneous_content(self):
2427
2842
        """Ensure we display a proper error on content that can't be parsed."""
2428
2843
        t = self.get_transport()
2429
2844
        t.put_bytes('foo.conf', '[open_section\n')
2430
 
        store = config.IniFileStore(t, 'foo.conf')
 
2845
        store = config.TransportIniFileStore(t, 'foo.conf')
2431
2846
        self.assertRaises(errors.ParseConfigError, store.load)
2432
2847
 
 
2848
    def test_load_permission_denied(self):
 
2849
        """Ensure we get warned when trying to load an inaccessible file."""
 
2850
        warnings = []
 
2851
        def warning(*args):
 
2852
            warnings.append(args[0] % args[1:])
 
2853
        self.overrideAttr(trace, 'warning', warning)
 
2854
 
 
2855
        t = self.get_transport()
 
2856
 
 
2857
        def get_bytes(relpath):
 
2858
            raise errors.PermissionDenied(relpath, "")
 
2859
        t.get_bytes = get_bytes
 
2860
        store = config.TransportIniFileStore(t, 'foo.conf')
 
2861
        self.assertRaises(errors.PermissionDenied, store.load)
 
2862
        self.assertEqual(
 
2863
            warnings,
 
2864
            [u'Permission denied while trying to load configuration store %s.'
 
2865
             % store.external_url()])
 
2866
 
2433
2867
 
2434
2868
class TestIniConfigContent(tests.TestCaseWithTransport):
2435
 
    """Simulate loading a IniBasedConfig without content of various encodings.
 
2869
    """Simulate loading a IniBasedConfig with content of various encodings.
2436
2870
 
2437
2871
    All files produced by bzr are in utf8 content.
2438
2872
 
2452
2886
        with open('foo.conf', 'wb') as f:
2453
2887
            f.write(utf8_content)
2454
2888
        conf = config.IniBasedConfig(file_name='foo.conf')
2455
 
        self.assertEquals(unicode_user, conf.get_user_option('user'))
 
2889
        self.assertEqual(unicode_user, conf.get_user_option('user'))
2456
2890
 
2457
2891
    def test_load_badly_encoded_content(self):
2458
2892
        """Ensure we display a proper error on non-ascii, non utf-8 content."""
2491
2925
                'branch.conf is *always* created when a branch is initialized')
2492
2926
        store = self.get_store(self)
2493
2927
        store.save()
2494
 
        self.assertEquals(False, self.has_store(store))
 
2928
        self.assertEqual(False, self.has_store(store))
 
2929
 
 
2930
    def test_mutable_section_shared(self):
 
2931
        store = self.get_store(self)
 
2932
        store._load_from_string('foo=bar\n')
 
2933
        # FIXME: There should be a better way than relying on the test
 
2934
        # parametrization to identify branch.conf -- vila 2011-0526
 
2935
        if self.store_id in ('branch', 'remote_branch'):
 
2936
            # branch stores requires write locked branches
 
2937
            self.addCleanup(store.branch.lock_write().unlock)
 
2938
        section1 = store.get_mutable_section(None)
 
2939
        section2 = store.get_mutable_section(None)
 
2940
        # If we get different sections, different callers won't share the
 
2941
        # modification
 
2942
        self.assertIs(section1, section2)
2495
2943
 
2496
2944
    def test_save_emptied_succeeds(self):
2497
2945
        store = self.get_store(self)
2498
2946
        store._load_from_string('foo=bar\n')
 
2947
        # FIXME: There should be a better way than relying on the test
 
2948
        # parametrization to identify branch.conf -- vila 2011-0526
 
2949
        if self.store_id in ('branch', 'remote_branch'):
 
2950
            # branch stores requires write locked branches
 
2951
            self.addCleanup(store.branch.lock_write().unlock)
2499
2952
        section = store.get_mutable_section(None)
2500
2953
        section.remove('foo')
2501
2954
        store.save()
2502
 
        self.assertEquals(True, self.has_store(store))
 
2955
        self.assertEqual(True, self.has_store(store))
2503
2956
        modified_store = self.get_store(self)
2504
2957
        sections = list(modified_store.get_sections())
2505
2958
        self.assertLength(0, sections)
2512
2965
                'branch.conf is *always* created when a branch is initialized')
2513
2966
        store = self.get_store(self)
2514
2967
        store._load_from_string('foo=bar\n')
2515
 
        self.assertEquals(False, self.has_store(store))
 
2968
        self.assertEqual(False, self.has_store(store))
2516
2969
        store.save()
2517
 
        self.assertEquals(True, self.has_store(store))
 
2970
        self.assertEqual(True, self.has_store(store))
2518
2971
        modified_store = self.get_store(self)
2519
2972
        sections = list(modified_store.get_sections())
2520
2973
        self.assertLength(1, sections)
2522
2975
 
2523
2976
    def test_set_option_in_empty_store(self):
2524
2977
        store = self.get_store(self)
 
2978
        # FIXME: There should be a better way than relying on the test
 
2979
        # parametrization to identify branch.conf -- vila 2011-0526
 
2980
        if self.store_id in ('branch', 'remote_branch'):
 
2981
            # branch stores requires write locked branches
 
2982
            self.addCleanup(store.branch.lock_write().unlock)
2525
2983
        section = store.get_mutable_section(None)
2526
2984
        section.set('foo', 'bar')
2527
2985
        store.save()
2533
2991
    def test_set_option_in_default_section(self):
2534
2992
        store = self.get_store(self)
2535
2993
        store._load_from_string('')
 
2994
        # FIXME: There should be a better way than relying on the test
 
2995
        # parametrization to identify branch.conf -- vila 2011-0526
 
2996
        if self.store_id in ('branch', 'remote_branch'):
 
2997
            # branch stores requires write locked branches
 
2998
            self.addCleanup(store.branch.lock_write().unlock)
2536
2999
        section = store.get_mutable_section(None)
2537
3000
        section.set('foo', 'bar')
2538
3001
        store.save()
2544
3007
    def test_set_option_in_named_section(self):
2545
3008
        store = self.get_store(self)
2546
3009
        store._load_from_string('')
 
3010
        # FIXME: There should be a better way than relying on the test
 
3011
        # parametrization to identify branch.conf -- vila 2011-0526
 
3012
        if self.store_id in ('branch', 'remote_branch'):
 
3013
            # branch stores requires write locked branches
 
3014
            self.addCleanup(store.branch.lock_write().unlock)
2547
3015
        section = store.get_mutable_section('baz')
2548
3016
        section.set('foo', 'bar')
2549
3017
        store.save()
2553
3021
        self.assertSectionContent(('baz', {'foo': 'bar'}), sections[0])
2554
3022
 
2555
3023
    def test_load_hook(self):
2556
 
        # We first needs to ensure that the store exists
 
3024
        # First, we need to ensure that the store exists
2557
3025
        store = self.get_store(self)
 
3026
        # FIXME: There should be a better way than relying on the test
 
3027
        # parametrization to identify branch.conf -- vila 2011-0526
 
3028
        if self.store_id in ('branch', 'remote_branch'):
 
3029
            # branch stores requires write locked branches
 
3030
            self.addCleanup(store.branch.lock_write().unlock)
2558
3031
        section = store.get_mutable_section('baz')
2559
3032
        section.set('foo', 'bar')
2560
3033
        store.save()
2567
3040
        self.assertLength(0, calls)
2568
3041
        store.load()
2569
3042
        self.assertLength(1, calls)
2570
 
        self.assertEquals((store,), calls[0])
 
3043
        self.assertEqual((store,), calls[0])
2571
3044
 
2572
3045
    def test_save_hook(self):
2573
3046
        calls = []
2576
3049
        config.ConfigHooks.install_named_hook('save', hook, None)
2577
3050
        self.assertLength(0, calls)
2578
3051
        store = self.get_store(self)
 
3052
        # FIXME: There should be a better way than relying on the test
 
3053
        # parametrization to identify branch.conf -- vila 2011-0526
 
3054
        if self.store_id in ('branch', 'remote_branch'):
 
3055
            # branch stores requires write locked branches
 
3056
            self.addCleanup(store.branch.lock_write().unlock)
2579
3057
        section = store.get_mutable_section('baz')
2580
3058
        section.set('foo', 'bar')
2581
3059
        store.save()
2582
3060
        self.assertLength(1, calls)
2583
 
        self.assertEquals((store,), calls[0])
2584
 
 
2585
 
 
2586
 
class TestIniFileStore(TestStore):
 
3061
        self.assertEqual((store,), calls[0])
 
3062
 
 
3063
    def test_set_mark_dirty(self):
 
3064
        stack = config.MemoryStack('')
 
3065
        self.assertLength(0, stack.store.dirty_sections)
 
3066
        stack.set('foo', 'baz')
 
3067
        self.assertLength(1, stack.store.dirty_sections)
 
3068
        self.assertTrue(stack.store._need_saving())
 
3069
 
 
3070
    def test_remove_mark_dirty(self):
 
3071
        stack = config.MemoryStack('foo=bar')
 
3072
        self.assertLength(0, stack.store.dirty_sections)
 
3073
        stack.remove('foo')
 
3074
        self.assertLength(1, stack.store.dirty_sections)
 
3075
        self.assertTrue(stack.store._need_saving())
 
3076
 
 
3077
 
 
3078
class TestStoreSaveChanges(tests.TestCaseWithTransport):
 
3079
    """Tests that config changes are kept in memory and saved on-demand."""
 
3080
 
 
3081
    def setUp(self):
 
3082
        super(TestStoreSaveChanges, self).setUp()
 
3083
        self.transport = self.get_transport()
 
3084
        # Most of the tests involve two stores pointing to the same persistent
 
3085
        # storage to observe the effects of concurrent changes
 
3086
        self.st1 = config.TransportIniFileStore(self.transport, 'foo.conf')
 
3087
        self.st2 = config.TransportIniFileStore(self.transport, 'foo.conf')
 
3088
        self.warnings = []
 
3089
        def warning(*args):
 
3090
            self.warnings.append(args[0] % args[1:])
 
3091
        self.overrideAttr(trace, 'warning', warning)
 
3092
 
 
3093
    def has_store(self, store):
 
3094
        store_basename = urlutils.relative_url(self.transport.external_url(),
 
3095
                                               store.external_url())
 
3096
        return self.transport.has(store_basename)
 
3097
 
 
3098
    def get_stack(self, store):
 
3099
        # Any stack will do as long as it uses the right store, just a single
 
3100
        # no-name section is enough
 
3101
        return config.Stack([store.get_sections], store)
 
3102
 
 
3103
    def test_no_changes_no_save(self):
 
3104
        s = self.get_stack(self.st1)
 
3105
        s.store.save_changes()
 
3106
        self.assertEqual(False, self.has_store(self.st1))
 
3107
 
 
3108
    def test_unrelated_concurrent_update(self):
 
3109
        s1 = self.get_stack(self.st1)
 
3110
        s2 = self.get_stack(self.st2)
 
3111
        s1.set('foo', 'bar')
 
3112
        s2.set('baz', 'quux')
 
3113
        s1.store.save()
 
3114
        # Changes don't propagate magically
 
3115
        self.assertEqual(None, s1.get('baz'))
 
3116
        s2.store.save_changes()
 
3117
        self.assertEqual('quux', s2.get('baz'))
 
3118
        # Changes are acquired when saving
 
3119
        self.assertEqual('bar', s2.get('foo'))
 
3120
        # Since there is no overlap, no warnings are emitted
 
3121
        self.assertLength(0, self.warnings)
 
3122
 
 
3123
    def test_concurrent_update_modified(self):
 
3124
        s1 = self.get_stack(self.st1)
 
3125
        s2 = self.get_stack(self.st2)
 
3126
        s1.set('foo', 'bar')
 
3127
        s2.set('foo', 'baz')
 
3128
        s1.store.save()
 
3129
        # Last speaker wins
 
3130
        s2.store.save_changes()
 
3131
        self.assertEqual('baz', s2.get('foo'))
 
3132
        # But the user get a warning
 
3133
        self.assertLength(1, self.warnings)
 
3134
        warning = self.warnings[0]
 
3135
        self.assertStartsWith(warning, 'Option foo in section None')
 
3136
        self.assertEndsWith(warning, 'was changed from <CREATED> to bar.'
 
3137
                            ' The baz value will be saved.')
 
3138
 
 
3139
    def test_concurrent_deletion(self):
 
3140
        self.st1._load_from_string('foo=bar')
 
3141
        self.st1.save()
 
3142
        s1 = self.get_stack(self.st1)
 
3143
        s2 = self.get_stack(self.st2)
 
3144
        s1.remove('foo')
 
3145
        s2.remove('foo')
 
3146
        s1.store.save_changes()
 
3147
        # No warning yet
 
3148
        self.assertLength(0, self.warnings)
 
3149
        s2.store.save_changes()
 
3150
        # Now we get one
 
3151
        self.assertLength(1, self.warnings)
 
3152
        warning = self.warnings[0]
 
3153
        self.assertStartsWith(warning, 'Option foo in section None')
 
3154
        self.assertEndsWith(warning, 'was changed from bar to <CREATED>.'
 
3155
                            ' The <DELETED> value will be saved.')
 
3156
 
 
3157
 
 
3158
class TestQuotingIniFileStore(tests.TestCaseWithTransport):
 
3159
 
 
3160
    def get_store(self):
 
3161
        return config.TransportIniFileStore(self.get_transport(), 'foo.conf')
 
3162
 
 
3163
    def test_get_quoted_string(self):
 
3164
        store = self.get_store()
 
3165
        store._load_from_string('foo= " abc "')
 
3166
        stack = config.Stack([store.get_sections])
 
3167
        self.assertEqual(' abc ', stack.get('foo'))
 
3168
 
 
3169
    def test_set_quoted_string(self):
 
3170
        store = self.get_store()
 
3171
        stack = config.Stack([store.get_sections], store)
 
3172
        stack.set('foo', ' a b c ')
 
3173
        store.save()
 
3174
        self.assertFileEqual('foo = " a b c "' + os.linesep, 'foo.conf')
 
3175
 
 
3176
 
 
3177
class TestTransportIniFileStore(TestStore):
2587
3178
 
2588
3179
    def test_loading_unknown_file_fails(self):
2589
 
        store = config.IniFileStore(self.get_transport(), 'I-do-not-exist')
 
3180
        store = config.TransportIniFileStore(self.get_transport(),
 
3181
            'I-do-not-exist')
2590
3182
        self.assertRaises(errors.NoSuchFile, store.load)
2591
3183
 
2592
3184
    def test_invalid_content(self):
2593
 
        store = config.IniFileStore(self.get_transport(), 'foo.conf', )
2594
 
        self.assertEquals(False, store.is_loaded())
 
3185
        store = config.TransportIniFileStore(self.get_transport(), 'foo.conf')
 
3186
        self.assertEqual(False, store.is_loaded())
2595
3187
        exc = self.assertRaises(
2596
3188
            errors.ParseConfigError, store._load_from_string,
2597
3189
            'this is invalid !')
2598
3190
        self.assertEndsWith(exc.filename, 'foo.conf')
2599
3191
        # And the load failed
2600
 
        self.assertEquals(False, store.is_loaded())
 
3192
        self.assertEqual(False, store.is_loaded())
2601
3193
 
2602
3194
    def test_get_embedded_sections(self):
2603
3195
        # A more complicated example (which also shows that section names and
2604
3196
        # option names share the same name space...)
2605
3197
        # FIXME: This should be fixed by forbidding dicts as values ?
2606
3198
        # -- vila 2011-04-05
2607
 
        store = config.IniFileStore(self.get_transport(), 'foo.conf', )
 
3199
        store = config.TransportIniFileStore(self.get_transport(), 'foo.conf')
2608
3200
        store._load_from_string('''
2609
3201
foo=bar
2610
3202
l=1,2
2620
3212
        sections = list(store.get_sections())
2621
3213
        self.assertLength(4, sections)
2622
3214
        # The default section has no name.
2623
 
        # List values are provided as lists
2624
 
        self.assertSectionContent((None, {'foo': 'bar', 'l': ['1', '2']}),
 
3215
        # List values are provided as strings and need to be explicitly
 
3216
        # converted by specifying from_unicode=list_from_store at option
 
3217
        # registration
 
3218
        self.assertSectionContent((None, {'foo': 'bar', 'l': u'1,2'}),
2625
3219
                                  sections[0])
2626
3220
        self.assertSectionContent(
2627
3221
            ('DEFAULT', {'foo_in_DEFAULT': 'foo_DEFAULT'}), sections[1])
2657
3251
 
2658
3252
    def setUp(self):
2659
3253
        super(TestConcurrentStoreUpdates, self).setUp()
2660
 
        self._content = 'one=1\ntwo=2\n'
2661
3254
        self.stack = self.get_stack(self)
2662
3255
        if not isinstance(self.stack, config._CompatibleStack):
2663
3256
            raise tests.TestNotApplicable(
2664
3257
                '%s is not meant to be compatible with the old config design'
2665
3258
                % (self.stack,))
2666
 
        self.stack.store._load_from_string(self._content)
 
3259
        self.stack.set('one', '1')
 
3260
        self.stack.set('two', '2')
2667
3261
        # Flush the store
2668
3262
        self.stack.store.save()
2669
3263
 
2670
3264
    def test_simple_read_access(self):
2671
 
        self.assertEquals('1', self.stack.get('one'))
 
3265
        self.assertEqual('1', self.stack.get('one'))
2672
3266
 
2673
3267
    def test_simple_write_access(self):
2674
3268
        self.stack.set('one', 'one')
2675
 
        self.assertEquals('one', self.stack.get('one'))
 
3269
        self.assertEqual('one', self.stack.get('one'))
2676
3270
 
2677
3271
    def test_listen_to_the_last_speaker(self):
2678
3272
        c1 = self.stack
2679
3273
        c2 = self.get_stack(self)
2680
3274
        c1.set('one', 'ONE')
2681
3275
        c2.set('two', 'TWO')
2682
 
        self.assertEquals('ONE', c1.get('one'))
2683
 
        self.assertEquals('TWO', c2.get('two'))
 
3276
        self.assertEqual('ONE', c1.get('one'))
 
3277
        self.assertEqual('TWO', c2.get('two'))
2684
3278
        # The second update respect the first one
2685
 
        self.assertEquals('ONE', c2.get('one'))
 
3279
        self.assertEqual('ONE', c2.get('one'))
2686
3280
 
2687
3281
    def test_last_speaker_wins(self):
2688
3282
        # If the same config is not shared, the same variable modified twice
2691
3285
        c2 = self.get_stack(self)
2692
3286
        c1.set('one', 'c1')
2693
3287
        c2.set('one', 'c2')
2694
 
        self.assertEquals('c2', c2.get('one'))
 
3288
        self.assertEqual('c2', c2.get('one'))
2695
3289
        # The first modification is still available until another refresh
2696
3290
        # occur
2697
 
        self.assertEquals('c1', c1.get('one'))
 
3291
        self.assertEqual('c1', c1.get('one'))
2698
3292
        c1.set('two', 'done')
2699
 
        self.assertEquals('c2', c1.get('one'))
 
3293
        self.assertEqual('c2', c1.get('one'))
2700
3294
 
2701
3295
    def test_writes_are_serialized(self):
2702
3296
        c1 = self.stack
2726
3320
        before_writing.wait()
2727
3321
        self.assertRaises(errors.LockContention,
2728
3322
                          c2.set, 'one', 'c2')
2729
 
        self.assertEquals('c1', c1.get('one'))
 
3323
        self.assertEqual('c1', c1.get('one'))
2730
3324
        # Let the lock be released
2731
3325
        after_writing.set()
2732
3326
        writing_done.wait()
2733
3327
        c2.set('one', 'c2')
2734
 
        self.assertEquals('c2', c2.get('one'))
 
3328
        self.assertEqual('c2', c2.get('one'))
2735
3329
 
2736
3330
    def test_read_while_writing(self):
2737
3331
       c1 = self.stack
2759
3353
       t1.start()
2760
3354
       # Ensure the thread is ready to write
2761
3355
       ready_to_write.wait()
2762
 
       self.assertEquals('c1', c1.get('one'))
 
3356
       self.assertEqual('c1', c1.get('one'))
2763
3357
       # If we read during the write, we get the old value
2764
3358
       c2 = self.get_stack(self)
2765
 
       self.assertEquals('1', c2.get('one'))
 
3359
       self.assertEqual('1', c2.get('one'))
2766
3360
       # Let the writing occur and ensure it occurred
2767
3361
       do_writing.set()
2768
3362
       writing_done.wait()
2769
3363
       # Now we get the updated value
2770
3364
       c3 = self.get_stack(self)
2771
 
       self.assertEquals('c1', c3.get('one'))
 
3365
       self.assertEqual('c1', c3.get('one'))
2772
3366
 
2773
3367
    # FIXME: It may be worth looking into removing the lock dir when it's not
2774
3368
    # needed anymore and look at possible fallouts for concurrent lockers. This
2775
3369
    # will matter if/when we use config files outside of bazaar directories
2776
 
    # (.bazaar or .bzr) -- vila 20110-04-11
 
3370
    # (.bazaar or .bzr) -- vila 20110-04-111
2777
3371
 
2778
3372
 
2779
3373
class TestSectionMatcher(TestStore):
2780
3374
 
2781
 
    scenarios = [('location', {'matcher': config.LocationMatcher})]
 
3375
    scenarios = [('location', {'matcher': config.LocationMatcher}),
 
3376
                 ('id', {'matcher': config.NameMatcher}),]
2782
3377
 
2783
 
    def get_store(self, file_name):
2784
 
        return config.IniFileStore(self.get_readonly_transport(), file_name)
 
3378
    def setUp(self):
 
3379
        super(TestSectionMatcher, self).setUp()
 
3380
        # Any simple store is good enough
 
3381
        self.get_store = config.test_store_builder_registry.get('configobj')
2785
3382
 
2786
3383
    def test_no_matches_for_empty_stores(self):
2787
 
        store = self.get_store('foo.conf')
 
3384
        store = self.get_store(self)
2788
3385
        store._load_from_string('')
2789
3386
        matcher = self.matcher(store, '/bar')
2790
 
        self.assertEquals([], list(matcher.get_sections()))
 
3387
        self.assertEqual([], list(matcher.get_sections()))
2791
3388
 
2792
3389
    def test_build_doesnt_load_store(self):
2793
 
        store = self.get_store('foo.conf')
2794
 
        matcher = self.matcher(store, '/bar')
 
3390
        store = self.get_store(self)
 
3391
        self.matcher(store, '/bar')
2795
3392
        self.assertFalse(store.is_loaded())
2796
3393
 
2797
3394
 
2799
3396
 
2800
3397
    def get_section(self, options, extra_path):
2801
3398
        section = config.Section('foo', options)
2802
 
        # We don't care about the length so we use '0'
2803
 
        return config.LocationSection(section, 0, extra_path)
 
3399
        return config.LocationSection(section, extra_path)
2804
3400
 
2805
3401
    def test_simple_option(self):
2806
3402
        section = self.get_section({'foo': 'bar'}, '')
2807
 
        self.assertEquals('bar', section.get('foo'))
 
3403
        self.assertEqual('bar', section.get('foo'))
2808
3404
 
2809
3405
    def test_option_with_extra_path(self):
2810
3406
        section = self.get_section({'foo': 'bar', 'foo:policy': 'appendpath'},
2811
3407
                                   'baz')
2812
 
        self.assertEquals('bar/baz', section.get('foo'))
 
3408
        self.assertEqual('bar/baz', section.get('foo'))
2813
3409
 
2814
3410
    def test_invalid_policy(self):
2815
3411
        section = self.get_section({'foo': 'bar', 'foo:policy': 'die'},
2816
3412
                                   'baz')
2817
3413
        # invalid policies are ignored
2818
 
        self.assertEquals('bar', section.get('foo'))
 
3414
        self.assertEqual('bar', section.get('foo'))
2819
3415
 
2820
3416
 
2821
3417
class TestLocationMatcher(TestStore):
2822
3418
 
2823
 
    def get_store(self, file_name):
2824
 
        return config.IniFileStore(self.get_readonly_transport(), file_name)
 
3419
    def setUp(self):
 
3420
        super(TestLocationMatcher, self).setUp()
 
3421
        # Any simple store is good enough
 
3422
        self.get_store = config.test_store_builder_registry.get('configobj')
 
3423
 
 
3424
    def test_unrelated_section_excluded(self):
 
3425
        store = self.get_store(self)
 
3426
        store._load_from_string('''
 
3427
[/foo]
 
3428
section=/foo
 
3429
[/foo/baz]
 
3430
section=/foo/baz
 
3431
[/foo/bar]
 
3432
section=/foo/bar
 
3433
[/foo/bar/baz]
 
3434
section=/foo/bar/baz
 
3435
[/quux/quux]
 
3436
section=/quux/quux
 
3437
''')
 
3438
        self.assertEqual(['/foo', '/foo/baz', '/foo/bar', '/foo/bar/baz',
 
3439
                           '/quux/quux'],
 
3440
                          [section.id for _, section in store.get_sections()])
 
3441
        matcher = config.LocationMatcher(store, '/foo/bar/quux')
 
3442
        sections = [section for _, section in matcher.get_sections()]
 
3443
        self.assertEqual(['/foo/bar', '/foo'],
 
3444
                          [section.id for section in sections])
 
3445
        self.assertEqual(['quux', 'bar/quux'],
 
3446
                          [section.extra_path for section in sections])
2825
3447
 
2826
3448
    def test_more_specific_sections_first(self):
2827
 
        store = self.get_store('foo.conf')
 
3449
        store = self.get_store(self)
2828
3450
        store._load_from_string('''
2829
3451
[/foo]
2830
3452
section=/foo
2831
3453
[/foo/bar]
2832
3454
section=/foo/bar
2833
3455
''')
2834
 
        self.assertEquals(['/foo', '/foo/bar'],
2835
 
                          [section.id for section in store.get_sections()])
 
3456
        self.assertEqual(['/foo', '/foo/bar'],
 
3457
                          [section.id for _, section in store.get_sections()])
2836
3458
        matcher = config.LocationMatcher(store, '/foo/bar/baz')
2837
 
        sections = list(matcher.get_sections())
2838
 
        self.assertEquals([3, 2],
2839
 
                          [section.length for section in sections])
2840
 
        self.assertEquals(['/foo/bar', '/foo'],
 
3459
        sections = [section for _, section in matcher.get_sections()]
 
3460
        self.assertEqual(['/foo/bar', '/foo'],
2841
3461
                          [section.id for section in sections])
2842
 
        self.assertEquals(['baz', 'bar/baz'],
 
3462
        self.assertEqual(['baz', 'bar/baz'],
2843
3463
                          [section.extra_path for section in sections])
2844
3464
 
2845
3465
    def test_appendpath_in_no_name_section(self):
2846
3466
        # It's a bit weird to allow appendpath in a no-name section, but
2847
3467
        # someone may found a use for it
2848
 
        store = self.get_store('foo.conf')
 
3468
        store = self.get_store(self)
2849
3469
        store._load_from_string('''
2850
3470
foo=bar
2851
3471
foo:policy = appendpath
2853
3473
        matcher = config.LocationMatcher(store, 'dir/subdir')
2854
3474
        sections = list(matcher.get_sections())
2855
3475
        self.assertLength(1, sections)
2856
 
        self.assertEquals('bar/dir/subdir', sections[0].get('foo'))
 
3476
        self.assertEqual('bar/dir/subdir', sections[0][1].get('foo'))
2857
3477
 
2858
3478
    def test_file_urls_are_normalized(self):
2859
 
        store = self.get_store('foo.conf')
 
3479
        store = self.get_store(self)
2860
3480
        if sys.platform == 'win32':
2861
3481
            expected_url = 'file:///C:/dir/subdir'
2862
3482
            expected_location = 'C:/dir/subdir'
2864
3484
            expected_url = 'file:///dir/subdir'
2865
3485
            expected_location = '/dir/subdir'
2866
3486
        matcher = config.LocationMatcher(store, expected_url)
2867
 
        self.assertEquals(expected_location, matcher.location)
2868
 
 
2869
 
 
2870
 
class TestStackGet(tests.TestCase):
2871
 
 
2872
 
    # FIXME: This should be parametrized for all known Stack or dedicated
2873
 
    # paramerized tests created to avoid bloating -- vila 2011-03-31
2874
 
 
2875
 
    def overrideOptionRegistry(self):
 
3487
        self.assertEqual(expected_location, matcher.location)
 
3488
 
 
3489
    def test_branch_name_colo(self):
 
3490
        store = self.get_store(self)
 
3491
        store._load_from_string(dedent("""\
 
3492
            [/]
 
3493
            push_location=my{branchname}
 
3494
        """))
 
3495
        matcher = config.LocationMatcher(store, 'file:///,branch=example%3c')
 
3496
        self.assertEqual('example<', matcher.branch_name)
 
3497
        ((_, section),) = matcher.get_sections()
 
3498
        self.assertEqual('example<', section.locals['branchname'])
 
3499
 
 
3500
    def test_branch_name_basename(self):
 
3501
        store = self.get_store(self)
 
3502
        store._load_from_string(dedent("""\
 
3503
            [/]
 
3504
            push_location=my{branchname}
 
3505
        """))
 
3506
        matcher = config.LocationMatcher(store, 'file:///parent/example%3c')
 
3507
        self.assertEqual('example<', matcher.branch_name)
 
3508
        ((_, section),) = matcher.get_sections()
 
3509
        self.assertEqual('example<', section.locals['branchname'])
 
3510
 
 
3511
 
 
3512
class TestStartingPathMatcher(TestStore):
 
3513
 
 
3514
    def setUp(self):
 
3515
        super(TestStartingPathMatcher, self).setUp()
 
3516
        # Any simple store is good enough
 
3517
        self.store = config.IniFileStore()
 
3518
 
 
3519
    def assertSectionIDs(self, expected, location, content):
 
3520
        self.store._load_from_string(content)
 
3521
        matcher = config.StartingPathMatcher(self.store, location)
 
3522
        sections = list(matcher.get_sections())
 
3523
        self.assertLength(len(expected), sections)
 
3524
        self.assertEqual(expected, [section.id for _, section in sections])
 
3525
        return sections
 
3526
 
 
3527
    def test_empty(self):
 
3528
        self.assertSectionIDs([], self.get_url(), '')
 
3529
 
 
3530
    def test_url_vs_local_paths(self):
 
3531
        # The matcher location is an url and the section names are local paths
 
3532
        self.assertSectionIDs(['/foo/bar', '/foo'],
 
3533
                              'file:///foo/bar/baz', '''\
 
3534
[/foo]
 
3535
[/foo/bar]
 
3536
''')
 
3537
 
 
3538
    def test_local_path_vs_url(self):
 
3539
        # The matcher location is a local path and the section names are urls
 
3540
        self.assertSectionIDs(['file:///foo/bar', 'file:///foo'],
 
3541
                              '/foo/bar/baz', '''\
 
3542
[file:///foo]
 
3543
[file:///foo/bar]
 
3544
''')
 
3545
 
 
3546
 
 
3547
    def test_no_name_section_included_when_present(self):
 
3548
        # Note that other tests will cover the case where the no-name section
 
3549
        # is empty and as such, not included.
 
3550
        sections = self.assertSectionIDs(['/foo/bar', '/foo', None],
 
3551
                                         '/foo/bar/baz', '''\
 
3552
option = defined so the no-name section exists
 
3553
[/foo]
 
3554
[/foo/bar]
 
3555
''')
 
3556
        self.assertEqual(['baz', 'bar/baz', '/foo/bar/baz'],
 
3557
                          [s.locals['relpath'] for _, s in sections])
 
3558
 
 
3559
    def test_order_reversed(self):
 
3560
        self.assertSectionIDs(['/foo/bar', '/foo'], '/foo/bar/baz', '''\
 
3561
[/foo]
 
3562
[/foo/bar]
 
3563
''')
 
3564
 
 
3565
    def test_unrelated_section_excluded(self):
 
3566
        self.assertSectionIDs(['/foo/bar', '/foo'], '/foo/bar/baz', '''\
 
3567
[/foo]
 
3568
[/foo/qux]
 
3569
[/foo/bar]
 
3570
''')
 
3571
 
 
3572
    def test_glob_included(self):
 
3573
        sections = self.assertSectionIDs(['/foo/*/baz', '/foo/b*', '/foo'],
 
3574
                                         '/foo/bar/baz', '''\
 
3575
[/foo]
 
3576
[/foo/qux]
 
3577
[/foo/b*]
 
3578
[/foo/*/baz]
 
3579
''')
 
3580
        # Note that 'baz' as a relpath for /foo/b* is not fully correct, but
 
3581
        # nothing really is... as far using {relpath} to append it to something
 
3582
        # else, this seems good enough though.
 
3583
        self.assertEqual(['', 'baz', 'bar/baz'],
 
3584
                          [s.locals['relpath'] for _, s in sections])
 
3585
 
 
3586
    def test_respect_order(self):
 
3587
        self.assertSectionIDs(['/foo', '/foo/b*', '/foo/*/baz'],
 
3588
                              '/foo/bar/baz', '''\
 
3589
[/foo/*/baz]
 
3590
[/foo/qux]
 
3591
[/foo/b*]
 
3592
[/foo]
 
3593
''')
 
3594
 
 
3595
 
 
3596
class TestNameMatcher(TestStore):
 
3597
 
 
3598
    def setUp(self):
 
3599
        super(TestNameMatcher, self).setUp()
 
3600
        self.matcher = config.NameMatcher
 
3601
        # Any simple store is good enough
 
3602
        self.get_store = config.test_store_builder_registry.get('configobj')
 
3603
 
 
3604
    def get_matching_sections(self, name):
 
3605
        store = self.get_store(self)
 
3606
        store._load_from_string('''
 
3607
[foo]
 
3608
option=foo
 
3609
[foo/baz]
 
3610
option=foo/baz
 
3611
[bar]
 
3612
option=bar
 
3613
''')
 
3614
        matcher = self.matcher(store, name)
 
3615
        return list(matcher.get_sections())
 
3616
 
 
3617
    def test_matching(self):
 
3618
        sections = self.get_matching_sections('foo')
 
3619
        self.assertLength(1, sections)
 
3620
        self.assertSectionContent(('foo', {'option': 'foo'}), sections[0])
 
3621
 
 
3622
    def test_not_matching(self):
 
3623
        sections = self.get_matching_sections('baz')
 
3624
        self.assertLength(0, sections)
 
3625
 
 
3626
 
 
3627
class TestBaseStackGet(tests.TestCase):
 
3628
 
 
3629
    def setUp(self):
 
3630
        super(TestBaseStackGet, self).setUp()
2876
3631
        self.overrideAttr(config, 'option_registry', config.OptionRegistry())
2877
3632
 
2878
 
    def test_single_config_get(self):
2879
 
        conf = dict(foo='bar')
2880
 
        conf_stack = config.Stack([conf])
2881
 
        self.assertEquals('bar', conf_stack.get('foo'))
 
3633
    def test_get_first_definition(self):
 
3634
        store1 = config.IniFileStore()
 
3635
        store1._load_from_string('foo=bar')
 
3636
        store2 = config.IniFileStore()
 
3637
        store2._load_from_string('foo=baz')
 
3638
        conf = config.Stack([store1.get_sections, store2.get_sections])
 
3639
        self.assertEqual('bar', conf.get('foo'))
2882
3640
 
2883
3641
    def test_get_with_registered_default_value(self):
2884
 
        conf_stack = config.Stack([dict()])
2885
 
        opt = config.Option('foo', default='bar')
2886
 
        self.overrideOptionRegistry()
2887
 
        config.option_registry.register('foo', opt)
2888
 
        self.assertEquals('bar', conf_stack.get('foo'))
 
3642
        config.option_registry.register(config.Option('foo', default='bar'))
 
3643
        conf_stack = config.Stack([])
 
3644
        self.assertEqual('bar', conf_stack.get('foo'))
2889
3645
 
2890
3646
    def test_get_without_registered_default_value(self):
2891
 
        conf_stack = config.Stack([dict()])
2892
 
        opt = config.Option('foo')
2893
 
        self.overrideOptionRegistry()
2894
 
        config.option_registry.register('foo', opt)
2895
 
        self.assertEquals(None, conf_stack.get('foo'))
 
3647
        config.option_registry.register(config.Option('foo'))
 
3648
        conf_stack = config.Stack([])
 
3649
        self.assertEqual(None, conf_stack.get('foo'))
2896
3650
 
2897
3651
    def test_get_without_default_value_for_not_registered(self):
2898
 
        conf_stack = config.Stack([dict()])
2899
 
        opt = config.Option('foo')
2900
 
        self.overrideOptionRegistry()
2901
 
        self.assertEquals(None, conf_stack.get('foo'))
2902
 
 
2903
 
    def test_get_first_definition(self):
2904
 
        conf1 = dict(foo='bar')
2905
 
        conf2 = dict(foo='baz')
2906
 
        conf_stack = config.Stack([conf1, conf2])
2907
 
        self.assertEquals('bar', conf_stack.get('foo'))
2908
 
 
2909
 
    def test_get_embedded_definition(self):
2910
 
        conf1 = dict(yy='12')
2911
 
        conf2 = config.Stack([dict(xx='42'), dict(foo='baz')])
2912
 
        conf_stack = config.Stack([conf1, conf2])
2913
 
        self.assertEquals('baz', conf_stack.get('foo'))
 
3652
        conf_stack = config.Stack([])
 
3653
        self.assertEqual(None, conf_stack.get('foo'))
2914
3654
 
2915
3655
    def test_get_for_empty_section_callable(self):
2916
3656
        conf_stack = config.Stack([lambda : []])
2917
 
        self.assertEquals(None, conf_stack.get('foo'))
 
3657
        self.assertEqual(None, conf_stack.get('foo'))
2918
3658
 
2919
3659
    def test_get_for_broken_callable(self):
2920
3660
        # Trying to use and invalid callable raises an exception on first use
2921
 
        conf_stack = config.Stack([lambda : object()])
 
3661
        conf_stack = config.Stack([object])
2922
3662
        self.assertRaises(TypeError, conf_stack.get, 'foo')
2923
3663
 
2924
3664
 
 
3665
class TestStackWithSimpleStore(tests.TestCase):
 
3666
 
 
3667
    def setUp(self):
 
3668
        super(TestStackWithSimpleStore, self).setUp()
 
3669
        self.overrideAttr(config, 'option_registry', config.OptionRegistry())
 
3670
        self.registry = config.option_registry
 
3671
 
 
3672
    def get_conf(self, content=None):
 
3673
        return config.MemoryStack(content)
 
3674
 
 
3675
    def test_override_value_from_env(self):
 
3676
        self.overrideEnv('FOO', None)
 
3677
        self.registry.register(
 
3678
            config.Option('foo', default='bar', override_from_env=['FOO']))
 
3679
        self.overrideEnv('FOO', 'quux')
 
3680
        # Env variable provides a default taking over the option one
 
3681
        conf = self.get_conf('foo=store')
 
3682
        self.assertEqual('quux', conf.get('foo'))
 
3683
 
 
3684
    def test_first_override_value_from_env_wins(self):
 
3685
        self.overrideEnv('NO_VALUE', None)
 
3686
        self.overrideEnv('FOO', None)
 
3687
        self.overrideEnv('BAZ', None)
 
3688
        self.registry.register(
 
3689
            config.Option('foo', default='bar',
 
3690
                          override_from_env=['NO_VALUE', 'FOO', 'BAZ']))
 
3691
        self.overrideEnv('FOO', 'foo')
 
3692
        self.overrideEnv('BAZ', 'baz')
 
3693
        # The first env var set wins
 
3694
        conf = self.get_conf('foo=store')
 
3695
        self.assertEqual('foo', conf.get('foo'))
 
3696
 
 
3697
 
 
3698
class TestMemoryStack(tests.TestCase):
 
3699
 
 
3700
    def test_get(self):
 
3701
        conf = config.MemoryStack('foo=bar')
 
3702
        self.assertEqual('bar', conf.get('foo'))
 
3703
 
 
3704
    def test_set(self):
 
3705
        conf = config.MemoryStack('foo=bar')
 
3706
        conf.set('foo', 'baz')
 
3707
        self.assertEqual('baz', conf.get('foo'))
 
3708
 
 
3709
    def test_no_content(self):
 
3710
        conf = config.MemoryStack()
 
3711
        # No content means no loading
 
3712
        self.assertFalse(conf.store.is_loaded())
 
3713
        self.assertRaises(NotImplementedError, conf.get, 'foo')
 
3714
        # But a content can still be provided
 
3715
        conf.store._load_from_string('foo=bar')
 
3716
        self.assertEqual('bar', conf.get('foo'))
 
3717
 
 
3718
 
 
3719
class TestStackIterSections(tests.TestCase):
 
3720
 
 
3721
    def test_empty_stack(self):
 
3722
        conf = config.Stack([])
 
3723
        sections = list(conf.iter_sections())
 
3724
        self.assertLength(0, sections)
 
3725
 
 
3726
    def test_empty_store(self):
 
3727
        store = config.IniFileStore()
 
3728
        store._load_from_string('')
 
3729
        conf = config.Stack([store.get_sections])
 
3730
        sections = list(conf.iter_sections())
 
3731
        self.assertLength(0, sections)
 
3732
 
 
3733
    def test_simple_store(self):
 
3734
        store = config.IniFileStore()
 
3735
        store._load_from_string('foo=bar')
 
3736
        conf = config.Stack([store.get_sections])
 
3737
        tuples = list(conf.iter_sections())
 
3738
        self.assertLength(1, tuples)
 
3739
        (found_store, found_section) = tuples[0]
 
3740
        self.assertIs(store, found_store)
 
3741
 
 
3742
    def test_two_stores(self):
 
3743
        store1 = config.IniFileStore()
 
3744
        store1._load_from_string('foo=bar')
 
3745
        store2 = config.IniFileStore()
 
3746
        store2._load_from_string('bar=qux')
 
3747
        conf = config.Stack([store1.get_sections, store2.get_sections])
 
3748
        tuples = list(conf.iter_sections())
 
3749
        self.assertLength(2, tuples)
 
3750
        self.assertIs(store1, tuples[0][0])
 
3751
        self.assertIs(store2, tuples[1][0])
 
3752
 
 
3753
 
2925
3754
class TestStackWithTransport(tests.TestCaseWithTransport):
2926
3755
 
2927
3756
    scenarios = [(key, {'get_stack': builder}) for key, builder
2932
3761
 
2933
3762
    def test_build_stack(self):
2934
3763
        # Just a smoke test to help debug builders
2935
 
        stack = self.get_stack(self)
 
3764
        self.get_stack(self)
2936
3765
 
2937
3766
 
2938
3767
class TestStackGet(TestStackWithTransport):
2942
3771
        self.conf = self.get_stack(self)
2943
3772
 
2944
3773
    def test_get_for_empty_stack(self):
2945
 
        self.assertEquals(None, self.conf.get('foo'))
 
3774
        self.assertEqual(None, self.conf.get('foo'))
2946
3775
 
2947
3776
    def test_get_hook(self):
2948
 
        self.conf.store._load_from_string('foo=bar')
 
3777
        self.conf.set('foo', 'bar')
2949
3778
        calls = []
2950
3779
        def hook(*args):
2951
3780
            calls.append(args)
2952
3781
        config.ConfigHooks.install_named_hook('get', hook, None)
2953
3782
        self.assertLength(0, calls)
2954
3783
        value = self.conf.get('foo')
2955
 
        self.assertEquals('bar', value)
 
3784
        self.assertEqual('bar', value)
2956
3785
        self.assertLength(1, calls)
2957
 
        self.assertEquals((self.conf, 'foo', 'bar'), calls[0])
2958
 
 
2959
 
 
2960
 
class TestStackGetWithConverter(TestStackGet):
 
3786
        self.assertEqual((self.conf, 'foo', 'bar'), calls[0])
 
3787
 
 
3788
 
 
3789
class TestStackGetWithConverter(tests.TestCase):
2961
3790
 
2962
3791
    def setUp(self):
2963
3792
        super(TestStackGetWithConverter, self).setUp()
2964
3793
        self.overrideAttr(config, 'option_registry', config.OptionRegistry())
2965
3794
        self.registry = config.option_registry
2966
3795
 
2967
 
    def register_bool_option(self, name, default, invalid=None):
2968
 
        b = config.Option(name, default=default, help='A boolean.',
2969
 
                          from_unicode=config.bool_from_store,
2970
 
                          invalid=invalid)
 
3796
    def get_conf(self, content=None):
 
3797
        return config.MemoryStack(content)
 
3798
 
 
3799
    def register_bool_option(self, name, default=None, default_from_env=None):
 
3800
        b = config.Option(name, help='A boolean.',
 
3801
                          default=default, default_from_env=default_from_env,
 
3802
                          from_unicode=config.bool_from_store)
2971
3803
        self.registry.register(b)
2972
3804
 
2973
 
    def test_get_with_bool_not_defined_default_true(self):
2974
 
        self.register_bool_option('foo', True)
2975
 
        self.assertEquals(True, self.conf.get('foo'))
2976
 
 
2977
 
    def test_get_with_bool_not_defined_default_false(self):
2978
 
        self.register_bool_option('foo', False)
2979
 
        self.assertEquals(False, self.conf.get('foo'))
2980
 
 
2981
 
    def test_get_with_bool_converter_not_default(self):
2982
 
        self.register_bool_option('foo', False)
2983
 
        self.conf.store._load_from_string('foo=yes')
2984
 
        self.assertEquals(True, self.conf.get('foo'))
2985
 
 
2986
 
    def test_get_with_bool_converter_invalid_string(self):
2987
 
        self.register_bool_option('foo', False)
2988
 
        self.conf.store._load_from_string('foo=not-a-boolean')
2989
 
        self.assertEquals(False, self.conf.get('foo'))
2990
 
 
2991
 
    def test_get_with_bool_converter_invalid_list(self):
2992
 
        self.register_bool_option('foo', False)
2993
 
        self.conf.store._load_from_string('foo=not,a,boolean')
2994
 
        self.assertEquals(False, self.conf.get('foo'))
2995
 
 
2996
 
    def test_get_invalid_warns(self):
2997
 
        self.register_bool_option('foo', False, invalid='warning')
2998
 
        self.conf.store._load_from_string('foo=not-a-boolean')
2999
 
        warnings = []
3000
 
        def warning(*args):
3001
 
            warnings.append(args[0] % args[1:])
3002
 
        self.overrideAttr(trace, 'warning', warning)
3003
 
        self.assertEquals(False, self.conf.get('foo'))
3004
 
        self.assertLength(1, warnings)
3005
 
        self.assertEquals('Value "not-a-boolean" is not valid for "foo"',
3006
 
                          warnings[0])
3007
 
 
3008
 
    def test_get_invalid_errors(self):
3009
 
        self.register_bool_option('foo', False, invalid='error')
3010
 
        self.conf.store._load_from_string('foo=not-a-boolean')
3011
 
        self.assertRaises(errors.ConfigOptionValueError, self.conf.get, 'foo')
3012
 
 
3013
 
    def register_integer_option(self, name, default):
3014
 
        i = config.Option(name, default=default, help='An integer.',
 
3805
    def test_get_default_bool_None(self):
 
3806
        self.register_bool_option('foo')
 
3807
        conf = self.get_conf('')
 
3808
        self.assertEqual(None, conf.get('foo'))
 
3809
 
 
3810
    def test_get_default_bool_True(self):
 
3811
        self.register_bool_option('foo', u'True')
 
3812
        conf = self.get_conf('')
 
3813
        self.assertEqual(True, conf.get('foo'))
 
3814
 
 
3815
    def test_get_default_bool_False(self):
 
3816
        self.register_bool_option('foo', False)
 
3817
        conf = self.get_conf('')
 
3818
        self.assertEqual(False, conf.get('foo'))
 
3819
 
 
3820
    def test_get_default_bool_False_as_string(self):
 
3821
        self.register_bool_option('foo', u'False')
 
3822
        conf = self.get_conf('')
 
3823
        self.assertEqual(False, conf.get('foo'))
 
3824
 
 
3825
    def test_get_default_bool_from_env_converted(self):
 
3826
        self.register_bool_option('foo', u'True', default_from_env=['FOO'])
 
3827
        self.overrideEnv('FOO', 'False')
 
3828
        conf = self.get_conf('')
 
3829
        self.assertEqual(False, conf.get('foo'))
 
3830
 
 
3831
    def test_get_default_bool_when_conversion_fails(self):
 
3832
        self.register_bool_option('foo', default='True')
 
3833
        conf = self.get_conf('foo=invalid boolean')
 
3834
        self.assertEqual(True, conf.get('foo'))
 
3835
 
 
3836
    def register_integer_option(self, name,
 
3837
                                default=None, default_from_env=None):
 
3838
        i = config.Option(name, help='An integer.',
 
3839
                          default=default, default_from_env=default_from_env,
3015
3840
                          from_unicode=config.int_from_store)
3016
3841
        self.registry.register(i)
3017
3842
 
3018
 
    def test_get_with_integer_not_defined_returns_default(self):
3019
 
        self.register_integer_option('foo', 42)
3020
 
        self.assertEquals(42, self.conf.get('foo'))
3021
 
 
3022
 
    def test_get_with_integer_converter_not_default(self):
3023
 
        self.register_integer_option('foo', 42)
3024
 
        self.conf.store._load_from_string('foo=16')
3025
 
        self.assertEquals(16, self.conf.get('foo'))
3026
 
 
3027
 
    def test_get_with_integer_converter_invalid_string(self):
3028
 
        # We don't set a default value
3029
 
        self.register_integer_option('foo', None)
3030
 
        self.conf.store._load_from_string('foo=forty-two')
3031
 
        # No default value, so we should get None
3032
 
        self.assertEquals(None, self.conf.get('foo'))
3033
 
 
3034
 
    def test_get_with_integer_converter_invalid_list(self):
3035
 
        # We don't set a default value
3036
 
        self.register_integer_option('foo', None)
3037
 
        self.conf.store._load_from_string('foo=a,list')
3038
 
        # No default value, so we should get None
3039
 
        self.assertEquals(None, self.conf.get('foo'))
3040
 
 
3041
 
    def register_list_option(self, name, default):
3042
 
        l = config.Option(name, default=default, help='A list.',
3043
 
                          from_unicode=config.list_from_store)
 
3843
    def test_get_default_integer_None(self):
 
3844
        self.register_integer_option('foo')
 
3845
        conf = self.get_conf('')
 
3846
        self.assertEqual(None, conf.get('foo'))
 
3847
 
 
3848
    def test_get_default_integer(self):
 
3849
        self.register_integer_option('foo', 42)
 
3850
        conf = self.get_conf('')
 
3851
        self.assertEqual(42, conf.get('foo'))
 
3852
 
 
3853
    def test_get_default_integer_as_string(self):
 
3854
        self.register_integer_option('foo', u'42')
 
3855
        conf = self.get_conf('')
 
3856
        self.assertEqual(42, conf.get('foo'))
 
3857
 
 
3858
    def test_get_default_integer_from_env(self):
 
3859
        self.register_integer_option('foo', default_from_env=['FOO'])
 
3860
        self.overrideEnv('FOO', '18')
 
3861
        conf = self.get_conf('')
 
3862
        self.assertEqual(18, conf.get('foo'))
 
3863
 
 
3864
    def test_get_default_integer_when_conversion_fails(self):
 
3865
        self.register_integer_option('foo', default='12')
 
3866
        conf = self.get_conf('foo=invalid integer')
 
3867
        self.assertEqual(12, conf.get('foo'))
 
3868
 
 
3869
    def register_list_option(self, name, default=None, default_from_env=None):
 
3870
        l = config.ListOption(name, help='A list.', default=default,
 
3871
                              default_from_env=default_from_env)
3044
3872
        self.registry.register(l)
3045
3873
 
3046
 
    def test_get_with_list_not_defined_returns_default(self):
3047
 
        self.register_list_option('foo', [])
3048
 
        self.assertEquals([], self.conf.get('foo'))
3049
 
 
3050
 
    def test_get_with_list_converter_nothing(self):
3051
 
        self.register_list_option('foo', [1])
3052
 
        self.conf.store._load_from_string('foo=')
3053
 
        self.assertEquals([], self.conf.get('foo'))
 
3874
    def test_get_default_list_None(self):
 
3875
        self.register_list_option('foo')
 
3876
        conf = self.get_conf('')
 
3877
        self.assertEqual(None, conf.get('foo'))
 
3878
 
 
3879
    def test_get_default_list_empty(self):
 
3880
        self.register_list_option('foo', '')
 
3881
        conf = self.get_conf('')
 
3882
        self.assertEqual([], conf.get('foo'))
 
3883
 
 
3884
    def test_get_default_list_from_env(self):
 
3885
        self.register_list_option('foo', default_from_env=['FOO'])
 
3886
        self.overrideEnv('FOO', '')
 
3887
        conf = self.get_conf('')
 
3888
        self.assertEqual([], conf.get('foo'))
3054
3889
 
3055
3890
    def test_get_with_list_converter_no_item(self):
3056
 
        self.register_list_option('foo', [1])
3057
 
        self.conf.store._load_from_string('foo=,')
3058
 
        self.assertEquals([], self.conf.get('foo'))
3059
 
 
3060
 
    def test_get_with_list_converter_one_boolean(self):
3061
 
        self.register_list_option('foo', [1])
3062
 
        self.conf.store._load_from_string('foo=True')
3063
 
        # We get a list of one string
3064
 
        self.assertEquals(['True'], self.conf.get('foo'))
3065
 
 
3066
 
    def test_get_with_list_converter_one_integer(self):
3067
 
        self.register_list_option('foo', [1])
3068
 
        self.conf.store._load_from_string('foo=2')
3069
 
        # We get a list of one string
3070
 
        self.assertEquals(['2'], self.conf.get('foo'))
3071
 
 
3072
 
    def test_get_with_list_converter_one_string(self):
3073
 
        self.register_list_option('foo', ['foo'])
3074
 
        self.conf.store._load_from_string('foo=bar')
3075
 
        # We get a list of one string
3076
 
        self.assertEquals(['bar'], self.conf.get('foo'))
 
3891
        self.register_list_option('foo', None)
 
3892
        conf = self.get_conf('foo=,')
 
3893
        self.assertEqual([], conf.get('foo'))
3077
3894
 
3078
3895
    def test_get_with_list_converter_many_items(self):
3079
 
        self.register_list_option('foo', [1])
3080
 
        self.conf.store._load_from_string('foo=m,o,r,e')
3081
 
        self.assertEquals(['m', 'o', 'r', 'e'], self.conf.get('foo'))
 
3896
        self.register_list_option('foo', None)
 
3897
        conf = self.get_conf('foo=m,o,r,e')
 
3898
        self.assertEqual(['m', 'o', 'r', 'e'], conf.get('foo'))
 
3899
 
 
3900
    def test_get_with_list_converter_embedded_spaces_many_items(self):
 
3901
        self.register_list_option('foo', None)
 
3902
        conf = self.get_conf('foo=" bar", "baz "')
 
3903
        self.assertEqual([' bar', 'baz '], conf.get('foo'))
 
3904
 
 
3905
    def test_get_with_list_converter_stripped_spaces_many_items(self):
 
3906
        self.register_list_option('foo', None)
 
3907
        conf = self.get_conf('foo= bar ,  baz ')
 
3908
        self.assertEqual(['bar', 'baz'], conf.get('foo'))
 
3909
 
 
3910
 
 
3911
class TestIterOptionRefs(tests.TestCase):
 
3912
    """iter_option_refs is a bit unusual, document some cases."""
 
3913
 
 
3914
    def assertRefs(self, expected, string):
 
3915
        self.assertEqual(expected, list(config.iter_option_refs(string)))
 
3916
 
 
3917
    def test_empty(self):
 
3918
        self.assertRefs([(False, '')], '')
 
3919
 
 
3920
    def test_no_refs(self):
 
3921
        self.assertRefs([(False, 'foo bar')], 'foo bar')
 
3922
 
 
3923
    def test_single_ref(self):
 
3924
        self.assertRefs([(False, ''), (True, '{foo}'), (False, '')], '{foo}')
 
3925
 
 
3926
    def test_broken_ref(self):
 
3927
        self.assertRefs([(False, '{foo')], '{foo')
 
3928
 
 
3929
    def test_embedded_ref(self):
 
3930
        self.assertRefs([(False, '{'), (True, '{foo}'), (False, '}')],
 
3931
                        '{{foo}}')
 
3932
 
 
3933
    def test_two_refs(self):
 
3934
        self.assertRefs([(False, ''), (True, '{foo}'),
 
3935
                         (False, ''), (True, '{bar}'),
 
3936
                         (False, ''),],
 
3937
                        '{foo}{bar}')
 
3938
 
 
3939
    def test_newline_in_refs_are_not_matched(self):
 
3940
        self.assertRefs([(False, '{\nxx}{xx\n}{{\n}}')], '{\nxx}{xx\n}{{\n}}')
 
3941
 
 
3942
 
 
3943
class TestStackExpandOptions(tests.TestCaseWithTransport):
 
3944
 
 
3945
    def setUp(self):
 
3946
        super(TestStackExpandOptions, self).setUp()
 
3947
        self.overrideAttr(config, 'option_registry', config.OptionRegistry())
 
3948
        self.registry = config.option_registry
 
3949
        store = config.TransportIniFileStore(self.get_transport(), 'foo.conf')
 
3950
        self.conf = config.Stack([store.get_sections], store)
 
3951
 
 
3952
    def assertExpansion(self, expected, string, env=None):
 
3953
        self.assertEqual(expected, self.conf.expand_options(string, env))
 
3954
 
 
3955
    def test_no_expansion(self):
 
3956
        self.assertExpansion('foo', 'foo')
 
3957
 
 
3958
    def test_expand_default_value(self):
 
3959
        self.conf.store._load_from_string('bar=baz')
 
3960
        self.registry.register(config.Option('foo', default=u'{bar}'))
 
3961
        self.assertEqual('baz', self.conf.get('foo', expand=True))
 
3962
 
 
3963
    def test_expand_default_from_env(self):
 
3964
        self.conf.store._load_from_string('bar=baz')
 
3965
        self.registry.register(config.Option('foo', default_from_env=['FOO']))
 
3966
        self.overrideEnv('FOO', '{bar}')
 
3967
        self.assertEqual('baz', self.conf.get('foo', expand=True))
 
3968
 
 
3969
    def test_expand_default_on_failed_conversion(self):
 
3970
        self.conf.store._load_from_string('baz=bogus\nbar=42\nfoo={baz}')
 
3971
        self.registry.register(
 
3972
            config.Option('foo', default=u'{bar}',
 
3973
                          from_unicode=config.int_from_store))
 
3974
        self.assertEqual(42, self.conf.get('foo', expand=True))
 
3975
 
 
3976
    def test_env_adding_options(self):
 
3977
        self.assertExpansion('bar', '{foo}', {'foo': 'bar'})
 
3978
 
 
3979
    def test_env_overriding_options(self):
 
3980
        self.conf.store._load_from_string('foo=baz')
 
3981
        self.assertExpansion('bar', '{foo}', {'foo': 'bar'})
 
3982
 
 
3983
    def test_simple_ref(self):
 
3984
        self.conf.store._load_from_string('foo=xxx')
 
3985
        self.assertExpansion('xxx', '{foo}')
 
3986
 
 
3987
    def test_unknown_ref(self):
 
3988
        self.assertRaises(errors.ExpandingUnknownOption,
 
3989
                          self.conf.expand_options, '{foo}')
 
3990
 
 
3991
    def test_illegal_def_is_ignored(self):
 
3992
        self.assertExpansion('{1,2}', '{1,2}')
 
3993
        self.assertExpansion('{ }', '{ }')
 
3994
        self.assertExpansion('${Foo,f}', '${Foo,f}')
 
3995
 
 
3996
    def test_indirect_ref(self):
 
3997
        self.conf.store._load_from_string('''
 
3998
foo=xxx
 
3999
bar={foo}
 
4000
''')
 
4001
        self.assertExpansion('xxx', '{bar}')
 
4002
 
 
4003
    def test_embedded_ref(self):
 
4004
        self.conf.store._load_from_string('''
 
4005
foo=xxx
 
4006
bar=foo
 
4007
''')
 
4008
        self.assertExpansion('xxx', '{{bar}}')
 
4009
 
 
4010
    def test_simple_loop(self):
 
4011
        self.conf.store._load_from_string('foo={foo}')
 
4012
        self.assertRaises(errors.OptionExpansionLoop,
 
4013
                          self.conf.expand_options, '{foo}')
 
4014
 
 
4015
    def test_indirect_loop(self):
 
4016
        self.conf.store._load_from_string('''
 
4017
foo={bar}
 
4018
bar={baz}
 
4019
baz={foo}''')
 
4020
        e = self.assertRaises(errors.OptionExpansionLoop,
 
4021
                              self.conf.expand_options, '{foo}')
 
4022
        self.assertEqual('foo->bar->baz', e.refs)
 
4023
        self.assertEqual('{foo}', e.string)
 
4024
 
 
4025
    def test_list(self):
 
4026
        self.conf.store._load_from_string('''
 
4027
foo=start
 
4028
bar=middle
 
4029
baz=end
 
4030
list={foo},{bar},{baz}
 
4031
''')
 
4032
        self.registry.register(
 
4033
            config.ListOption('list'))
 
4034
        self.assertEqual(['start', 'middle', 'end'],
 
4035
                           self.conf.get('list', expand=True))
 
4036
 
 
4037
    def test_cascading_list(self):
 
4038
        self.conf.store._load_from_string('''
 
4039
foo=start,{bar}
 
4040
bar=middle,{baz}
 
4041
baz=end
 
4042
list={foo}
 
4043
''')
 
4044
        self.registry.register(config.ListOption('list'))
 
4045
        # Register an intermediate option as a list to ensure no conversion
 
4046
        # happen while expanding. Conversion should only occur for the original
 
4047
        # option ('list' here).
 
4048
        self.registry.register(config.ListOption('baz'))
 
4049
        self.assertEqual(['start', 'middle', 'end'],
 
4050
                           self.conf.get('list', expand=True))
 
4051
 
 
4052
    def test_pathologically_hidden_list(self):
 
4053
        self.conf.store._load_from_string('''
 
4054
foo=bin
 
4055
bar=go
 
4056
start={foo
 
4057
middle=},{
 
4058
end=bar}
 
4059
hidden={start}{middle}{end}
 
4060
''')
 
4061
        # What matters is what the registration says, the conversion happens
 
4062
        # only after all expansions have been performed
 
4063
        self.registry.register(config.ListOption('hidden'))
 
4064
        self.assertEqual(['bin', 'go'],
 
4065
                          self.conf.get('hidden', expand=True))
 
4066
 
 
4067
 
 
4068
class TestStackCrossSectionsExpand(tests.TestCaseWithTransport):
 
4069
 
 
4070
    def setUp(self):
 
4071
        super(TestStackCrossSectionsExpand, self).setUp()
 
4072
 
 
4073
    def get_config(self, location, string):
 
4074
        if string is None:
 
4075
            string = ''
 
4076
        # Since we don't save the config we won't strictly require to inherit
 
4077
        # from TestCaseInTempDir, but an error occurs so quickly...
 
4078
        c = config.LocationStack(location)
 
4079
        c.store._load_from_string(string)
 
4080
        return c
 
4081
 
 
4082
    def test_dont_cross_unrelated_section(self):
 
4083
        c = self.get_config('/another/branch/path','''
 
4084
[/one/branch/path]
 
4085
foo = hello
 
4086
bar = {foo}/2
 
4087
 
 
4088
[/another/branch/path]
 
4089
bar = {foo}/2
 
4090
''')
 
4091
        self.assertRaises(errors.ExpandingUnknownOption,
 
4092
                          c.get, 'bar', expand=True)
 
4093
 
 
4094
    def test_cross_related_sections(self):
 
4095
        c = self.get_config('/project/branch/path','''
 
4096
[/project]
 
4097
foo = qu
 
4098
 
 
4099
[/project/branch/path]
 
4100
bar = {foo}ux
 
4101
''')
 
4102
        self.assertEqual('quux', c.get('bar', expand=True))
 
4103
 
 
4104
 
 
4105
class TestStackCrossStoresExpand(tests.TestCaseWithTransport):
 
4106
 
 
4107
    def test_cross_global_locations(self):
 
4108
        l_store = config.LocationStore()
 
4109
        l_store._load_from_string('''
 
4110
[/branch]
 
4111
lfoo = loc-foo
 
4112
lbar = {gbar}
 
4113
''')
 
4114
        l_store.save()
 
4115
        g_store = config.GlobalStore()
 
4116
        g_store._load_from_string('''
 
4117
[DEFAULT]
 
4118
gfoo = {lfoo}
 
4119
gbar = glob-bar
 
4120
''')
 
4121
        g_store.save()
 
4122
        stack = config.LocationStack('/branch')
 
4123
        self.assertEqual('glob-bar', stack.get('lbar', expand=True))
 
4124
        self.assertEqual('loc-foo', stack.get('gfoo', expand=True))
 
4125
 
 
4126
 
 
4127
class TestStackExpandSectionLocals(tests.TestCaseWithTransport):
 
4128
 
 
4129
    def test_expand_locals_empty(self):
 
4130
        l_store = config.LocationStore()
 
4131
        l_store._load_from_string('''
 
4132
[/home/user/project]
 
4133
base = {basename}
 
4134
rel = {relpath}
 
4135
''')
 
4136
        l_store.save()
 
4137
        stack = config.LocationStack('/home/user/project/')
 
4138
        self.assertEqual('', stack.get('base', expand=True))
 
4139
        self.assertEqual('', stack.get('rel', expand=True))
 
4140
 
 
4141
    def test_expand_basename_locally(self):
 
4142
        l_store = config.LocationStore()
 
4143
        l_store._load_from_string('''
 
4144
[/home/user/project]
 
4145
bfoo = {basename}
 
4146
''')
 
4147
        l_store.save()
 
4148
        stack = config.LocationStack('/home/user/project/branch')
 
4149
        self.assertEqual('branch', stack.get('bfoo', expand=True))
 
4150
 
 
4151
    def test_expand_basename_locally_longer_path(self):
 
4152
        l_store = config.LocationStore()
 
4153
        l_store._load_from_string('''
 
4154
[/home/user]
 
4155
bfoo = {basename}
 
4156
''')
 
4157
        l_store.save()
 
4158
        stack = config.LocationStack('/home/user/project/dir/branch')
 
4159
        self.assertEqual('branch', stack.get('bfoo', expand=True))
 
4160
 
 
4161
    def test_expand_relpath_locally(self):
 
4162
        l_store = config.LocationStore()
 
4163
        l_store._load_from_string('''
 
4164
[/home/user/project]
 
4165
lfoo = loc-foo/{relpath}
 
4166
''')
 
4167
        l_store.save()
 
4168
        stack = config.LocationStack('/home/user/project/branch')
 
4169
        self.assertEqual('loc-foo/branch', stack.get('lfoo', expand=True))
 
4170
 
 
4171
    def test_expand_relpath_unknonw_in_global(self):
 
4172
        g_store = config.GlobalStore()
 
4173
        g_store._load_from_string('''
 
4174
[DEFAULT]
 
4175
gfoo = {relpath}
 
4176
''')
 
4177
        g_store.save()
 
4178
        stack = config.LocationStack('/home/user/project/branch')
 
4179
        self.assertRaises(errors.ExpandingUnknownOption,
 
4180
                          stack.get, 'gfoo', expand=True)
 
4181
 
 
4182
    def test_expand_local_option_locally(self):
 
4183
        l_store = config.LocationStore()
 
4184
        l_store._load_from_string('''
 
4185
[/home/user/project]
 
4186
lfoo = loc-foo/{relpath}
 
4187
lbar = {gbar}
 
4188
''')
 
4189
        l_store.save()
 
4190
        g_store = config.GlobalStore()
 
4191
        g_store._load_from_string('''
 
4192
[DEFAULT]
 
4193
gfoo = {lfoo}
 
4194
gbar = glob-bar
 
4195
''')
 
4196
        g_store.save()
 
4197
        stack = config.LocationStack('/home/user/project/branch')
 
4198
        self.assertEqual('glob-bar', stack.get('lbar', expand=True))
 
4199
        self.assertEqual('loc-foo/branch', stack.get('gfoo', expand=True))
 
4200
 
 
4201
    def test_locals_dont_leak(self):
 
4202
        """Make sure we chose the right local in presence of several sections.
 
4203
        """
 
4204
        l_store = config.LocationStore()
 
4205
        l_store._load_from_string('''
 
4206
[/home/user]
 
4207
lfoo = loc-foo/{relpath}
 
4208
[/home/user/project]
 
4209
lfoo = loc-foo/{relpath}
 
4210
''')
 
4211
        l_store.save()
 
4212
        stack = config.LocationStack('/home/user/project/branch')
 
4213
        self.assertEqual('loc-foo/branch', stack.get('lfoo', expand=True))
 
4214
        stack = config.LocationStack('/home/user/bar/baz')
 
4215
        self.assertEqual('loc-foo/bar/baz', stack.get('lfoo', expand=True))
 
4216
 
3082
4217
 
3083
4218
 
3084
4219
class TestStackSet(TestStackWithTransport):
3085
4220
 
3086
4221
    def test_simple_set(self):
3087
4222
        conf = self.get_stack(self)
3088
 
        conf.store._load_from_string('foo=bar')
3089
 
        self.assertEquals('bar', conf.get('foo'))
 
4223
        self.assertEqual(None, conf.get('foo'))
3090
4224
        conf.set('foo', 'baz')
3091
4225
        # Did we get it back ?
3092
 
        self.assertEquals('baz', conf.get('foo'))
 
4226
        self.assertEqual('baz', conf.get('foo'))
3093
4227
 
3094
4228
    def test_set_creates_a_new_section(self):
3095
4229
        conf = self.get_stack(self)
3096
4230
        conf.set('foo', 'baz')
3097
 
        self.assertEquals, 'baz', conf.get('foo')
 
4231
        self.assertEqual, 'baz', conf.get('foo')
3098
4232
 
3099
4233
    def test_set_hook(self):
3100
4234
        calls = []
3105
4239
        conf = self.get_stack(self)
3106
4240
        conf.set('foo', 'bar')
3107
4241
        self.assertLength(1, calls)
3108
 
        self.assertEquals((conf, 'foo', 'bar'), calls[0])
 
4242
        self.assertEqual((conf, 'foo', 'bar'), calls[0])
3109
4243
 
3110
4244
 
3111
4245
class TestStackRemove(TestStackWithTransport):
3112
4246
 
3113
4247
    def test_remove_existing(self):
3114
4248
        conf = self.get_stack(self)
3115
 
        conf.store._load_from_string('foo=bar')
3116
 
        self.assertEquals('bar', conf.get('foo'))
 
4249
        conf.set('foo', 'bar')
 
4250
        self.assertEqual('bar', conf.get('foo'))
3117
4251
        conf.remove('foo')
3118
4252
        # Did we get it back ?
3119
 
        self.assertEquals(None, conf.get('foo'))
 
4253
        self.assertEqual(None, conf.get('foo'))
3120
4254
 
3121
4255
    def test_remove_unknown(self):
3122
4256
        conf = self.get_stack(self)
3129
4263
        config.ConfigHooks.install_named_hook('remove', hook, None)
3130
4264
        self.assertLength(0, calls)
3131
4265
        conf = self.get_stack(self)
3132
 
        conf.store._load_from_string('foo=bar')
 
4266
        conf.set('foo', 'bar')
3133
4267
        conf.remove('foo')
3134
4268
        self.assertLength(1, calls)
3135
 
        self.assertEquals((conf, 'foo'), calls[0])
 
4269
        self.assertEqual((conf, 'foo'), calls[0])
3136
4270
 
3137
4271
 
3138
4272
class TestConfigGetOptions(tests.TestCaseWithTransport, TestOptionsMixin):
3236
4370
        """
3237
4371
        sections = list(conf._get_sections(name))
3238
4372
        self.assertLength(len(expected), sections)
3239
 
        self.assertEqual(expected, [name for name, _, _ in sections])
 
4373
        self.assertEqual(expected, [n for n, _, _ in sections])
3240
4374
 
3241
4375
    def test_bazaar_default_section(self):
3242
4376
        self.assertSectionNames(['DEFAULT'], self.bazaar_config)
3286
4420
        self.assertSectionNames(['ALIASES'], self.bazaar_config, 'ALIASES')
3287
4421
 
3288
4422
 
 
4423
class TestSharedStores(tests.TestCaseInTempDir):
 
4424
 
 
4425
    def test_bazaar_conf_shared(self):
 
4426
        g1 = config.GlobalStack()
 
4427
        g2 = config.GlobalStack()
 
4428
        # The two stacks share the same store
 
4429
        self.assertIs(g1.store, g2.store)
 
4430
 
 
4431
 
3289
4432
class TestAuthenticationConfigFile(tests.TestCase):
3290
4433
    """Test the authentication.conf file matching"""
3291
4434
 
3298
4441
        else:
3299
4442
            user = credentials['user']
3300
4443
            password = credentials['password']
3301
 
        self.assertEquals(expected_user, user)
3302
 
        self.assertEquals(expected_password, password)
 
4444
        self.assertEqual(expected_user, user)
 
4445
        self.assertEqual(expected_password, password)
3303
4446
 
3304
4447
    def test_empty_config(self):
3305
4448
        conf = config.AuthenticationConfig(_file=StringIO())
3306
 
        self.assertEquals({}, conf._get_config())
 
4449
        self.assertEqual({}, conf._get_config())
3307
4450
        self._got_user_passwd(None, None, conf, 'http', 'foo.net')
3308
4451
 
3309
4452
    def test_non_utf8_config(self):
3491
4634
password=bendover
3492
4635
"""))
3493
4636
        credentials = conf.get_credentials('https', 'bar.org')
3494
 
        self.assertEquals(False, credentials.get('verify_certificates'))
 
4637
        self.assertEqual(False, credentials.get('verify_certificates'))
3495
4638
        credentials = conf.get_credentials('https', 'foo.net')
3496
 
        self.assertEquals(True, credentials.get('verify_certificates'))
 
4639
        self.assertEqual(True, credentials.get('verify_certificates'))
3497
4640
 
3498
4641
 
3499
4642
class TestAuthenticationStorage(tests.TestCaseInTempDir):
3506
4649
                                           port=99, path='/foo',
3507
4650
                                           realm='realm')
3508
4651
        CREDENTIALS = {'name': 'name', 'user': 'user', 'password': 'password',
3509
 
                       'verify_certificates': False, 'scheme': 'scheme', 
3510
 
                       'host': 'host', 'port': 99, 'path': '/foo', 
 
4652
                       'verify_certificates': False, 'scheme': 'scheme',
 
4653
                       'host': 'host', 'port': 99, 'path': '/foo',
3511
4654
                       'realm': 'realm'}
3512
4655
        self.assertEqual(CREDENTIALS, credentials)
3513
4656
        credentials_from_disk = config.AuthenticationConfig().get_credentials(
3521
4664
        self.assertIs(None, conf._get_config().get('name'))
3522
4665
        credentials = conf.get_credentials(host='host', scheme='scheme')
3523
4666
        CREDENTIALS = {'name': 'name2', 'user': 'user2', 'password':
3524
 
                       'password', 'verify_certificates': True, 
3525
 
                       'scheme': 'scheme', 'host': 'host', 'port': None, 
 
4667
                       'password', 'verify_certificates': True,
 
4668
                       'scheme': 'scheme', 'host': 'host', 'port': None,
3526
4669
                       'path': None, 'realm': None}
3527
4670
        self.assertEqual(CREDENTIALS, credentials)
3528
4671
 
3546
4689
                                            stdout=stdout, stderr=stderr)
3547
4690
        # We use an empty conf so that the user is always prompted
3548
4691
        conf = config.AuthenticationConfig()
3549
 
        self.assertEquals(password,
 
4692
        self.assertEqual(password,
3550
4693
                          conf.get_password(scheme, host, user, port=port,
3551
4694
                                            realm=realm, path=path))
3552
 
        self.assertEquals(expected_prompt, stderr.getvalue())
3553
 
        self.assertEquals('', stdout.getvalue())
 
4695
        self.assertEqual(expected_prompt, stderr.getvalue())
 
4696
        self.assertEqual('', stdout.getvalue())
3554
4697
 
3555
4698
    def _check_default_username_prompt(self, expected_prompt_format, scheme,
3556
4699
                                       host=None, port=None, realm=None,
3567
4710
                                            stdout=stdout, stderr=stderr)
3568
4711
        # We use an empty conf so that the user is always prompted
3569
4712
        conf = config.AuthenticationConfig()
3570
 
        self.assertEquals(username, conf.get_user(scheme, host, port=port,
 
4713
        self.assertEqual(username, conf.get_user(scheme, host, port=port,
3571
4714
                          realm=realm, path=path, ask=True))
3572
 
        self.assertEquals(expected_prompt, stderr.getvalue())
3573
 
        self.assertEquals('', stdout.getvalue())
 
4715
        self.assertEqual(expected_prompt, stderr.getvalue())
 
4716
        self.assertEqual('', stdout.getvalue())
3574
4717
 
3575
4718
    def test_username_defaults_prompts(self):
3576
4719
        # HTTP prompts can't be tested here, see test_http.py
3582
4725
 
3583
4726
    def test_username_default_no_prompt(self):
3584
4727
        conf = config.AuthenticationConfig()
3585
 
        self.assertEquals(None,
 
4728
        self.assertEqual(None,
3586
4729
            conf.get_user('ftp', 'example.com'))
3587
 
        self.assertEquals("explicitdefault",
 
4730
        self.assertEqual("explicitdefault",
3588
4731
            conf.get_user('ftp', 'example.com', default="explicitdefault"))
3589
4732
 
3590
4733
    def test_password_default_prompts(self):
3623
4766
 
3624
4767
        # Since the password defined in the authentication config is ignored,
3625
4768
        # the user is prompted
3626
 
        self.assertEquals(entered_password,
 
4769
        self.assertEqual(entered_password,
3627
4770
                          conf.get_password('ssh', 'bar.org', user='jim'))
3628
4771
        self.assertContainsRe(
3629
4772
            self.get_log(),
3646
4789
 
3647
4790
        # Since the password defined in the authentication config is ignored,
3648
4791
        # the user is prompted
3649
 
        self.assertEquals(entered_password,
 
4792
        self.assertEqual(entered_password,
3650
4793
                          conf.get_password('ssh', 'bar.org', user='jim'))
3651
4794
        # No warning shoud be emitted since there is no password. We are only
3652
4795
        # providing "user".
3662
4805
        config.credential_store_registry.register("stub", store, fallback=True)
3663
4806
        conf = config.AuthenticationConfig(_file=StringIO())
3664
4807
        creds = conf.get_credentials("http", "example.com")
3665
 
        self.assertEquals("joe", creds["user"])
3666
 
        self.assertEquals("secret", creds["password"])
 
4808
        self.assertEqual("joe", creds["user"])
 
4809
        self.assertEqual("secret", creds["password"])
3667
4810
 
3668
4811
 
3669
4812
class StubCredentialStore(config.CredentialStore):
3714
4857
 
3715
4858
    def test_fallback_none_registered(self):
3716
4859
        r = config.CredentialStoreRegistry()
3717
 
        self.assertEquals(None,
 
4860
        self.assertEqual(None,
3718
4861
                          r.get_fallback_credentials("http", "example.com"))
3719
4862
 
3720
4863
    def test_register(self):
3721
4864
        r = config.CredentialStoreRegistry()
3722
4865
        r.register("stub", StubCredentialStore(), fallback=False)
3723
4866
        r.register("another", StubCredentialStore(), fallback=True)
3724
 
        self.assertEquals(["another", "stub"], r.keys())
 
4867
        self.assertEqual(["another", "stub"], r.keys())
3725
4868
 
3726
4869
    def test_register_lazy(self):
3727
4870
        r = config.CredentialStoreRegistry()
3728
4871
        r.register_lazy("stub", "bzrlib.tests.test_config",
3729
4872
                        "StubCredentialStore", fallback=False)
3730
 
        self.assertEquals(["stub"], r.keys())
 
4873
        self.assertEqual(["stub"], r.keys())
3731
4874
        self.assertIsInstance(r.get_credential_store("stub"),
3732
4875
                              StubCredentialStore)
3733
4876
 
3735
4878
        r = config.CredentialStoreRegistry()
3736
4879
        r.register("stub1", None, fallback=False)
3737
4880
        r.register("stub2", None, fallback=True)
3738
 
        self.assertEquals(False, r.is_fallback("stub1"))
3739
 
        self.assertEquals(True, r.is_fallback("stub2"))
 
4881
        self.assertEqual(False, r.is_fallback("stub1"))
 
4882
        self.assertEqual(True, r.is_fallback("stub2"))
3740
4883
 
3741
4884
    def test_no_fallback(self):
3742
4885
        r = config.CredentialStoreRegistry()
3743
4886
        store = CountingCredentialStore()
3744
4887
        r.register("count", store, fallback=False)
3745
 
        self.assertEquals(None,
 
4888
        self.assertEqual(None,
3746
4889
                          r.get_fallback_credentials("http", "example.com"))
3747
 
        self.assertEquals(0, store._calls)
 
4890
        self.assertEqual(0, store._calls)
3748
4891
 
3749
4892
    def test_fallback_credentials(self):
3750
4893
        r = config.CredentialStoreRegistry()
3753
4896
                              "somebody", "geheim")
3754
4897
        r.register("stub", store, fallback=True)
3755
4898
        creds = r.get_fallback_credentials("http", "example.com")
3756
 
        self.assertEquals("somebody", creds["user"])
3757
 
        self.assertEquals("geheim", creds["password"])
 
4899
        self.assertEqual("somebody", creds["user"])
 
4900
        self.assertEqual("geheim", creds["password"])
3758
4901
 
3759
4902
    def test_fallback_first_wins(self):
3760
4903
        r = config.CredentialStoreRegistry()
3767
4910
                              "somebody", "stub2")
3768
4911
        r.register("stub2", stub1, fallback=True)
3769
4912
        creds = r.get_fallback_credentials("http", "example.com")
3770
 
        self.assertEquals("somebody", creds["user"])
3771
 
        self.assertEquals("stub1", creds["password"])
 
4913
        self.assertEqual("somebody", creds["user"])
 
4914
        self.assertEqual("stub1", creds["password"])
3772
4915
 
3773
4916
 
3774
4917
class TestPlainTextCredentialStore(tests.TestCase):
3777
4920
        r = config.credential_store_registry
3778
4921
        plain_text = r.get_credential_store()
3779
4922
        decoded = plain_text.decode_password(dict(password='secret'))
3780
 
        self.assertEquals('secret', decoded)
 
4923
        self.assertEqual('secret', decoded)
 
4924
 
 
4925
 
 
4926
class TestBase64CredentialStore(tests.TestCase):
 
4927
 
 
4928
    def test_decode_password(self):
 
4929
        r = config.credential_store_registry
 
4930
        plain_text = r.get_credential_store('base64')
 
4931
        decoded = plain_text.decode_password(dict(password='c2VjcmV0'))
 
4932
        self.assertEqual('secret', decoded)
3781
4933
 
3782
4934
 
3783
4935
# FIXME: Once we have a way to declare authentication to all test servers, we
3797
4949
 
3798
4950
    def test_auto_user_id(self):
3799
4951
        """Automatic inference of user name.
3800
 
        
 
4952
 
3801
4953
        This is a bit hard to test in an isolated way, because it depends on
3802
4954
        system functions that go direct to /etc or perhaps somewhere else.
3803
4955
        But it's reasonable to say that on Unix, with an /etc/mailname, we ought
3811
4963
            self.assertIsNot(None, realname)
3812
4964
            self.assertIsNot(None, address)
3813
4965
        else:
3814
 
            self.assertEquals((None, None), (realname, address))
3815
 
 
 
4966
            self.assertEqual((None, None), (realname, address))
 
4967
 
 
4968
 
 
4969
class TestDefaultMailDomain(tests.TestCaseInTempDir):
 
4970
    """Test retrieving default domain from mailname file"""
 
4971
 
 
4972
    def test_default_mail_domain_simple(self):
 
4973
        f = file('simple', 'w')
 
4974
        try:
 
4975
            f.write("domainname.com\n")
 
4976
        finally:
 
4977
            f.close()
 
4978
        r = config._get_default_mail_domain('simple')
 
4979
        self.assertEqual('domainname.com', r)
 
4980
 
 
4981
    def test_default_mail_domain_no_eol(self):
 
4982
        f = file('no_eol', 'w')
 
4983
        try:
 
4984
            f.write("domainname.com")
 
4985
        finally:
 
4986
            f.close()
 
4987
        r = config._get_default_mail_domain('no_eol')
 
4988
        self.assertEqual('domainname.com', r)
 
4989
 
 
4990
    def test_default_mail_domain_multiple_lines(self):
 
4991
        f = file('multiple_lines', 'w')
 
4992
        try:
 
4993
            f.write("domainname.com\nsome other text\n")
 
4994
        finally:
 
4995
            f.close()
 
4996
        r = config._get_default_mail_domain('multiple_lines')
 
4997
        self.assertEqual('domainname.com', r)
 
4998
 
 
4999
 
 
5000
class EmailOptionTests(tests.TestCase):
 
5001
 
 
5002
    def test_default_email_uses_BZR_EMAIL(self):
 
5003
        conf = config.MemoryStack('email=jelmer@debian.org')
 
5004
        # BZR_EMAIL takes precedence over EMAIL
 
5005
        self.overrideEnv('BZR_EMAIL', 'jelmer@samba.org')
 
5006
        self.overrideEnv('EMAIL', 'jelmer@apache.org')
 
5007
        self.assertEqual('jelmer@samba.org', conf.get('email'))
 
5008
 
 
5009
    def test_default_email_uses_EMAIL(self):
 
5010
        conf = config.MemoryStack('')
 
5011
        self.overrideEnv('BZR_EMAIL', None)
 
5012
        self.overrideEnv('EMAIL', 'jelmer@apache.org')
 
5013
        self.assertEqual('jelmer@apache.org', conf.get('email'))
 
5014
 
 
5015
    def test_BZR_EMAIL_overrides(self):
 
5016
        conf = config.MemoryStack('email=jelmer@debian.org')
 
5017
        self.overrideEnv('BZR_EMAIL', 'jelmer@apache.org')
 
5018
        self.assertEqual('jelmer@apache.org', conf.get('email'))
 
5019
        self.overrideEnv('BZR_EMAIL', None)
 
5020
        self.overrideEnv('EMAIL', 'jelmer@samba.org')
 
5021
        self.assertEqual('jelmer@debian.org', conf.get('email'))
 
5022
 
 
5023
 
 
5024
class MailClientOptionTests(tests.TestCase):
 
5025
 
 
5026
    def test_default(self):
 
5027
        conf = config.MemoryStack('')
 
5028
        client = conf.get('mail_client')
 
5029
        self.assertIs(client, mail_client.DefaultMail)
 
5030
 
 
5031
    def test_evolution(self):
 
5032
        conf = config.MemoryStack('mail_client=evolution')
 
5033
        client = conf.get('mail_client')
 
5034
        self.assertIs(client, mail_client.Evolution)
 
5035
 
 
5036
    def test_kmail(self):
 
5037
        conf = config.MemoryStack('mail_client=kmail')
 
5038
        client = conf.get('mail_client')
 
5039
        self.assertIs(client, mail_client.KMail)
 
5040
 
 
5041
    def test_mutt(self):
 
5042
        conf = config.MemoryStack('mail_client=mutt')
 
5043
        client = conf.get('mail_client')
 
5044
        self.assertIs(client, mail_client.Mutt)
 
5045
 
 
5046
    def test_thunderbird(self):
 
5047
        conf = config.MemoryStack('mail_client=thunderbird')
 
5048
        client = conf.get('mail_client')
 
5049
        self.assertIs(client, mail_client.Thunderbird)
 
5050
 
 
5051
    def test_explicit_default(self):
 
5052
        conf = config.MemoryStack('mail_client=default')
 
5053
        client = conf.get('mail_client')
 
5054
        self.assertIs(client, mail_client.DefaultMail)
 
5055
 
 
5056
    def test_editor(self):
 
5057
        conf = config.MemoryStack('mail_client=editor')
 
5058
        client = conf.get('mail_client')
 
5059
        self.assertIs(client, mail_client.Editor)
 
5060
 
 
5061
    def test_mapi(self):
 
5062
        conf = config.MemoryStack('mail_client=mapi')
 
5063
        client = conf.get('mail_client')
 
5064
        self.assertIs(client, mail_client.MAPIClient)
 
5065
 
 
5066
    def test_xdg_email(self):
 
5067
        conf = config.MemoryStack('mail_client=xdg-email')
 
5068
        client = conf.get('mail_client')
 
5069
        self.assertIs(client, mail_client.XDGEmail)
 
5070
 
 
5071
    def test_unknown(self):
 
5072
        conf = config.MemoryStack('mail_client=firebird')
 
5073
        self.assertRaises(errors.ConfigOptionValueError, conf.get,
 
5074
                'mail_client')