~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_config.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-05-11 15:04:23 UTC
  • mfrom: (5848.1.1 2.4-cython-first)
  • Revision ID: pqm@pqm.ubuntu.com-20110511150423-tpm1ablukqalkvim
(jameinel) Default to using Cython for compiling code,
 rather than Pyrex. (John A Meinel)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2014, 2016 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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
 
 
 
18
# import system imports here
19
19
from cStringIO import StringIO
20
 
from textwrap import dedent
21
20
import os
22
21
import sys
23
22
import threading
24
23
 
 
24
 
25
25
from testtools import matchers
26
26
 
 
27
#import bzrlib specific imports here
27
28
from bzrlib import (
28
29
    branch,
 
30
    bzrdir,
29
31
    config,
30
 
    controldir,
31
32
    diff,
32
33
    errors,
33
34
    osutils,
34
35
    mail_client,
 
36
    mergetools,
35
37
    ui,
36
38
    urlutils,
37
 
    registry as _mod_registry,
38
 
    remote,
 
39
    registry,
39
40
    tests,
40
41
    trace,
41
 
    )
42
 
from bzrlib.symbol_versioning import (
43
 
    deprecated_in,
44
 
    )
45
 
from bzrlib.transport import remote as transport_remote
 
42
    transport,
 
43
    )
46
44
from bzrlib.tests import (
47
45
    features,
 
46
    TestSkipped,
48
47
    scenarios,
49
 
    test_server,
50
48
    )
51
49
from bzrlib.util.configobj import configobj
52
50
 
65
63
 
66
64
load_tests = scenarios.load_tests_apply_scenarios
67
65
 
68
 
# Register helpers to build stores
69
 
config.test_store_builder_registry.register(
70
 
    'configobj', lambda test: config.TransportIniFileStore(
71
 
        test.get_transport(), 'configobj.conf'))
72
 
config.test_store_builder_registry.register(
 
66
# We need adapters that can build a config store in a test context. Test
 
67
# classes, based on TestCaseWithTransport, can use the registry to parametrize
 
68
# themselves. The builder will receive a test instance and should return a
 
69
# ready-to-use store.  Plugins that defines new stores can also register
 
70
# themselves here to be tested against the tests defined below.
 
71
 
 
72
# FIXME: plugins should *not* need to import test_config to register their
 
73
# helpers (or selftest -s xxx will be broken), the following registry should be
 
74
# moved to bzrlib.config instead so that selftest -s bt.test_config also runs
 
75
# the plugin specific tests (selftest -s bp.xxx won't, that would be against
 
76
# the spirit of '-s') -- vila 20110503
 
77
test_store_builder_registry = registry.Registry()
 
78
test_store_builder_registry.register(
 
79
    'configobj', lambda test: config.IniFileStore(test.get_transport(),
 
80
                                                  'configobj.conf'))
 
81
test_store_builder_registry.register(
73
82
    'bazaar', lambda test: config.GlobalStore())
74
 
config.test_store_builder_registry.register(
 
83
test_store_builder_registry.register(
75
84
    'location', lambda test: config.LocationStore())
76
 
 
77
 
 
78
 
def build_backing_branch(test, relpath,
79
 
                         transport_class=None, server_class=None):
80
 
    """Test helper to create a backing branch only once.
81
 
 
82
 
    Some tests needs multiple stores/stacks to check concurrent update
83
 
    behaviours. As such, they need to build different branch *objects* even if
84
 
    they share the branch on disk.
85
 
 
86
 
    :param relpath: The relative path to the branch. (Note that the helper
87
 
        should always specify the same relpath).
88
 
 
89
 
    :param transport_class: The Transport class the test needs to use.
90
 
 
91
 
    :param server_class: The server associated with the ``transport_class``
92
 
        above.
93
 
 
94
 
    Either both or neither of ``transport_class`` and ``server_class`` should
95
 
    be specified.
96
 
    """
97
 
    if transport_class is not None and server_class is not None:
98
 
        test.transport_class = transport_class
99
 
        test.transport_server = server_class
100
 
    elif not (transport_class is None and server_class is None):
101
 
        raise AssertionError('Specify both ``transport_class`` and '
102
 
                             '``server_class`` or neither of them')
103
 
    if getattr(test, 'backing_branch', None) is None:
104
 
        # First call, let's build the branch on disk
105
 
        test.backing_branch = test.make_branch(relpath)
106
 
 
107
 
 
108
 
def build_branch_store(test):
109
 
    build_backing_branch(test, 'branch')
110
 
    b = branch.Branch.open('branch')
111
 
    return config.BranchStore(b)
112
 
config.test_store_builder_registry.register('branch', build_branch_store)
113
 
 
114
 
 
115
 
def build_control_store(test):
116
 
    build_backing_branch(test, 'branch')
117
 
    b = controldir.ControlDir.open('branch')
118
 
    return config.ControlStore(b)
119
 
config.test_store_builder_registry.register('control', build_control_store)
120
 
 
121
 
 
122
 
def build_remote_branch_store(test):
123
 
    # There is only one permutation (but we won't be able to handle more with
124
 
    # this design anyway)
125
 
    (transport_class,
126
 
     server_class) = transport_remote.get_test_permutations()[0]
127
 
    build_backing_branch(test, 'branch', transport_class, server_class)
128
 
    b = branch.Branch.open(test.get_url('branch'))
129
 
    return config.BranchStore(b)
130
 
config.test_store_builder_registry.register('remote_branch',
131
 
                                            build_remote_branch_store)
132
 
 
133
 
 
134
 
config.test_stack_builder_registry.register(
135
 
    'bazaar', lambda test: config.GlobalStack())
136
 
config.test_stack_builder_registry.register(
137
 
    'location', lambda test: config.LocationStack('.'))
138
 
 
139
 
 
140
 
def build_branch_stack(test):
141
 
    build_backing_branch(test, 'branch')
142
 
    b = branch.Branch.open('branch')
143
 
    return config.BranchStack(b)
144
 
config.test_stack_builder_registry.register('branch', build_branch_stack)
145
 
 
146
 
 
147
 
def build_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)
 
85
test_store_builder_registry.register(
 
86
    'branch', lambda test: config.BranchStore(test.branch))
 
87
 
170
88
 
171
89
 
172
90
sample_long_alias="log -r-15..-1 --line"
176
94
editor=vim
177
95
change_editor=vimdiff -of @new_path @old_path
178
96
gpg_signing_command=gnome-gpg
179
 
gpg_signing_key=DD4D5088
180
97
log_format=short
181
 
validate_signatures_in_log=true
182
 
acceptable_keys=amy
183
98
user_global_option=something
184
99
bzr.mergetool.sometool=sometool {base} {this} {other} -o {result}
185
100
bzr.mergetool.funkytool=funkytool "arg with spaces" {this_temp}
186
 
bzr.mergetool.newtool='"newtool with spaces" {this_temp}'
187
101
bzr.default_mergetool=sometool
188
102
[ALIASES]
189
103
h=help
232
146
[/a/]
233
147
check_signatures=check-available
234
148
gpg_signing_command=false
235
 
gpg_signing_key=default
236
149
user_local_option=local
237
150
# test trailing / matching
238
151
[/a/*]
328
241
 
329
242
class FakeBranch(object):
330
243
 
331
 
    def __init__(self, base=None):
 
244
    def __init__(self, base=None, user_id=None):
332
245
        if base is None:
333
246
            self.base = "http://example.com/branches/demo"
334
247
        else:
335
248
            self.base = base
336
249
        self._transport = self.control_files = \
337
 
            FakeControlFilesAndTransport()
 
250
            FakeControlFilesAndTransport(user_id=user_id)
338
251
 
339
252
    def _get_config(self):
340
253
        return config.TransportConfig(self._transport, 'branch.conf')
348
261
 
349
262
class FakeControlFilesAndTransport(object):
350
263
 
351
 
    def __init__(self):
 
264
    def __init__(self, user_id=None):
352
265
        self.files = {}
 
266
        if user_id:
 
267
            self.files['email'] = user_id
353
268
        self._transport = self
354
269
 
 
270
    def get_utf8(self, filename):
 
271
        # from LockableFiles
 
272
        raise AssertionError("get_utf8 should no longer be used")
 
273
 
355
274
    def get(self, filename):
356
275
        # from Transport
357
276
        try:
448
367
        output = outfile.getvalue()
449
368
        # now we're trying to read it back
450
369
        co2 = config.ConfigObj(StringIO(output))
451
 
        self.assertEqual(triple_quotes_value, co2['test'])
 
370
        self.assertEquals(triple_quotes_value, co2['test'])
452
371
 
453
372
 
454
373
erroneous_config = """[section] # line 1
475
394
    def test_constructs(self):
476
395
        config.Config()
477
396
 
 
397
    def test_no_default_editor(self):
 
398
        self.assertRaises(NotImplementedError, config.Config().get_editor)
 
399
 
478
400
    def test_user_email(self):
479
401
        my_config = InstrumentedConfig()
480
402
        self.assertEqual('robert.collins@example.org', my_config.user_email())
488
410
 
489
411
    def test_signatures_default(self):
490
412
        my_config = config.Config()
491
 
        self.assertFalse(
492
 
            self.applyDeprecated(deprecated_in((2, 5, 0)),
493
 
                my_config.signature_needed))
 
413
        self.assertFalse(my_config.signature_needed())
494
414
        self.assertEqual(config.CHECK_IF_POSSIBLE,
495
 
            self.applyDeprecated(deprecated_in((2, 5, 0)),
496
 
                my_config.signature_checking))
 
415
                         my_config.signature_checking())
497
416
        self.assertEqual(config.SIGN_WHEN_REQUIRED,
498
 
                self.applyDeprecated(deprecated_in((2, 5, 0)),
499
 
                    my_config.signing_policy))
 
417
                         my_config.signing_policy())
500
418
 
501
419
    def test_signatures_template_method(self):
502
420
        my_config = InstrumentedConfig()
503
 
        self.assertEqual(config.CHECK_NEVER,
504
 
            self.applyDeprecated(deprecated_in((2, 5, 0)),
505
 
                my_config.signature_checking))
 
421
        self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
506
422
        self.assertEqual(['_get_signature_checking'], my_config._calls)
507
423
 
508
424
    def test_signatures_template_method_none(self):
509
425
        my_config = InstrumentedConfig()
510
426
        my_config._signatures = None
511
427
        self.assertEqual(config.CHECK_IF_POSSIBLE,
512
 
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
513
 
                             my_config.signature_checking))
 
428
                         my_config.signature_checking())
514
429
        self.assertEqual(['_get_signature_checking'], my_config._calls)
515
430
 
516
431
    def test_gpg_signing_command_default(self):
517
432
        my_config = config.Config()
518
 
        self.assertEqual('gpg',
519
 
            self.applyDeprecated(deprecated_in((2, 5, 0)),
520
 
                my_config.gpg_signing_command))
 
433
        self.assertEqual('gpg', my_config.gpg_signing_command())
521
434
 
522
435
    def test_get_user_option_default(self):
523
436
        my_config = config.Config()
525
438
 
526
439
    def test_post_commit_default(self):
527
440
        my_config = config.Config()
528
 
        self.assertEqual(None, self.applyDeprecated(deprecated_in((2, 5, 0)),
529
 
                                                    my_config.post_commit))
530
 
 
 
441
        self.assertEqual(None, my_config.post_commit())
531
442
 
532
443
    def test_log_format_default(self):
533
444
        my_config = config.Config()
534
 
        self.assertEqual('long',
535
 
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
536
 
                                              my_config.log_format))
537
 
 
538
 
    def test_acceptable_keys_default(self):
539
 
        my_config = config.Config()
540
 
        self.assertEqual(None, self.applyDeprecated(deprecated_in((2, 5, 0)),
541
 
            my_config.acceptable_keys))
542
 
 
543
 
    def test_validate_signatures_in_log_default(self):
544
 
        my_config = config.Config()
545
 
        self.assertEqual(False, my_config.validate_signatures_in_log())
 
445
        self.assertEqual('long', my_config.log_format())
546
446
 
547
447
    def test_get_change_editor(self):
548
448
        my_config = InstrumentedConfig()
558
458
    def setUp(self):
559
459
        super(TestConfigPath, self).setUp()
560
460
        self.overrideEnv('HOME', '/home/bogus')
561
 
        self.overrideEnv('XDG_CACHE_HOME', '')
 
461
        self.overrideEnv('XDG_CACHE_DIR', '')
562
462
        if sys.platform == 'win32':
563
463
            self.overrideEnv(
564
464
                'BZR_HOME', r'C:\Documents and Settings\bogus\Application Data')
570
470
    def test_config_dir(self):
571
471
        self.assertEqual(config.config_dir(), self.bzr_home)
572
472
 
573
 
    def test_config_dir_is_unicode(self):
574
 
        self.assertIsInstance(config.config_dir(), unicode)
575
 
 
576
473
    def test_config_filename(self):
577
474
        self.assertEqual(config.config_filename(),
578
475
                         self.bzr_home + '/bazaar.conf')
595
492
    # subdirectory of $XDG_CONFIG_HOME
596
493
 
597
494
    def setUp(self):
598
 
        if sys.platform == 'win32':
 
495
        if sys.platform in ('darwin', 'win32'):
599
496
            raise tests.TestNotApplicable(
600
497
                'XDG config dir not used on this platform')
601
498
        super(TestXDGConfigDir, self).setUp()
628
525
class TestIniConfigBuilding(TestIniConfig):
629
526
 
630
527
    def test_contructs(self):
631
 
        config.IniBasedConfig()
 
528
        my_config = config.IniBasedConfig()
632
529
 
633
530
    def test_from_fp(self):
634
531
        my_config = config.IniBasedConfig.from_string(sample_config_text)
649
546
        self.path = self.uid = self.gid = None
650
547
        conf = config.IniBasedConfig(file_name='./foo.conf')
651
548
        conf._write_config_file()
652
 
        self.assertEqual(self.path, './foo.conf')
 
549
        self.assertEquals(self.path, './foo.conf')
653
550
        self.assertTrue(isinstance(self.uid, int))
654
551
        self.assertTrue(isinstance(self.gid, int))
655
552
 
677
574
 
678
575
    def test_saved_with_content(self):
679
576
        content = 'foo = bar\n'
680
 
        config.IniBasedConfig.from_string(content, file_name='./test.conf',
681
 
                                          save=True)
 
577
        conf = config.IniBasedConfig.from_string(
 
578
            content, file_name='./test.conf', save=True)
682
579
        self.assertFileEqual(content, 'test.conf')
683
580
 
684
581
 
 
582
class TestIniConfigOptionExpansionDefaultValue(tests.TestCaseInTempDir):
 
583
    """What is the default value of expand for config options.
 
584
 
 
585
    This is an opt-in beta feature used to evaluate whether or not option
 
586
    references can appear in dangerous place raising exceptions, disapearing
 
587
    (and as such corrupting data) or if it's safe to activate the option by
 
588
    default.
 
589
 
 
590
    Note that these tests relies on config._expand_default_value being already
 
591
    overwritten in the parent class setUp.
 
592
    """
 
593
 
 
594
    def setUp(self):
 
595
        super(TestIniConfigOptionExpansionDefaultValue, self).setUp()
 
596
        self.config = None
 
597
        self.warnings = []
 
598
        def warning(*args):
 
599
            self.warnings.append(args[0] % args[1:])
 
600
        self.overrideAttr(trace, 'warning', warning)
 
601
 
 
602
    def get_config(self, expand):
 
603
        c = config.GlobalConfig.from_string('bzr.config.expand=%s' % (expand,),
 
604
                                            save=True)
 
605
        return c
 
606
 
 
607
    def assertExpandIs(self, expected):
 
608
        actual = config._get_expand_default_value()
 
609
        #self.config.get_user_option_as_bool('bzr.config.expand')
 
610
        self.assertEquals(expected, actual)
 
611
 
 
612
    def test_default_is_None(self):
 
613
        self.assertEquals(None, config._expand_default_value)
 
614
 
 
615
    def test_default_is_False_even_if_None(self):
 
616
        self.config = self.get_config(None)
 
617
        self.assertExpandIs(False)
 
618
 
 
619
    def test_default_is_False_even_if_invalid(self):
 
620
        self.config = self.get_config('<your choice>')
 
621
        self.assertExpandIs(False)
 
622
        # ...
 
623
        # Huh ? My choice is False ? Thanks, always happy to hear that :D
 
624
        # Wait, you've been warned !
 
625
        self.assertLength(1, self.warnings)
 
626
        self.assertEquals(
 
627
            'Value "<your choice>" is not a boolean for "bzr.config.expand"',
 
628
            self.warnings[0])
 
629
 
 
630
    def test_default_is_True(self):
 
631
        self.config = self.get_config(True)
 
632
        self.assertExpandIs(True)
 
633
        
 
634
    def test_default_is_False(self):
 
635
        self.config = self.get_config(False)
 
636
        self.assertExpandIs(False)
 
637
        
 
638
 
685
639
class TestIniConfigOptionExpansion(tests.TestCase):
686
640
    """Test option expansion from the IniConfig level.
687
641
 
699
653
        return c
700
654
 
701
655
    def assertExpansion(self, expected, conf, string, env=None):
702
 
        self.assertEqual(expected, conf.expand_options(string, env))
 
656
        self.assertEquals(expected, conf.expand_options(string, env))
703
657
 
704
658
    def test_no_expansion(self):
705
659
        c = self.get_config('')
747
701
baz={foo}''')
748
702
        e = self.assertRaises(errors.OptionExpansionLoop,
749
703
                              c.expand_options, '{foo}')
750
 
        self.assertEqual('foo->bar->baz', e.refs)
751
 
        self.assertEqual('{foo}', e.string)
 
704
        self.assertEquals('foo->bar->baz', e.refs)
 
705
        self.assertEquals('{foo}', e.string)
752
706
 
753
707
    def test_list(self):
754
708
        conf = self.get_config('''
757
711
baz=end
758
712
list={foo},{bar},{baz}
759
713
''')
760
 
        self.assertEqual(['start', 'middle', 'end'],
 
714
        self.assertEquals(['start', 'middle', 'end'],
761
715
                           conf.get_user_option('list', expand=True))
762
716
 
763
717
    def test_cascading_list(self):
767
721
baz=end
768
722
list={foo}
769
723
''')
770
 
        self.assertEqual(['start', 'middle', 'end'],
 
724
        self.assertEquals(['start', 'middle', 'end'],
771
725
                           conf.get_user_option('list', expand=True))
772
726
 
773
727
    def test_pathological_hidden_list(self):
781
735
''')
782
736
        # Nope, it's either a string or a list, and the list wins as soon as a
783
737
        # ',' appears, so the string concatenation never occur.
784
 
        self.assertEqual(['{foo', '}', '{', 'bar}'],
 
738
        self.assertEquals(['{foo', '}', '{', 'bar}'],
785
739
                          conf.get_user_option('hidden', expand=True))
786
740
 
787
 
 
788
741
class TestLocationConfigOptionExpansion(tests.TestCaseInTempDir):
789
742
 
790
743
    def get_config(self, location, string=None):
815
768
[/project/branch/path]
816
769
bar = {foo}ux
817
770
''')
818
 
        self.assertEqual('quux', c.get_user_option('bar', expand=True))
 
771
        self.assertEquals('quux', c.get_user_option('bar', expand=True))
819
772
 
820
773
 
821
774
class TestIniBaseConfigOnDisk(tests.TestCaseInTempDir):
861
814
        return c
862
815
 
863
816
    def test_simple_read_access(self):
864
 
        self.assertEqual('1', self.config.get_user_option('one'))
 
817
        self.assertEquals('1', self.config.get_user_option('one'))
865
818
 
866
819
    def test_simple_write_access(self):
867
820
        self.config.set_user_option('one', 'one')
868
 
        self.assertEqual('one', self.config.get_user_option('one'))
 
821
        self.assertEquals('one', self.config.get_user_option('one'))
869
822
 
870
823
    def test_listen_to_the_last_speaker(self):
871
824
        c1 = self.config
872
825
        c2 = self.get_existing_config()
873
826
        c1.set_user_option('one', 'ONE')
874
827
        c2.set_user_option('two', 'TWO')
875
 
        self.assertEqual('ONE', c1.get_user_option('one'))
876
 
        self.assertEqual('TWO', c2.get_user_option('two'))
 
828
        self.assertEquals('ONE', c1.get_user_option('one'))
 
829
        self.assertEquals('TWO', c2.get_user_option('two'))
877
830
        # The second update respect the first one
878
 
        self.assertEqual('ONE', c2.get_user_option('one'))
 
831
        self.assertEquals('ONE', c2.get_user_option('one'))
879
832
 
880
833
    def test_last_speaker_wins(self):
881
834
        # If the same config is not shared, the same variable modified twice
884
837
        c2 = self.get_existing_config()
885
838
        c1.set_user_option('one', 'c1')
886
839
        c2.set_user_option('one', 'c2')
887
 
        self.assertEqual('c2', c2._get_user_option('one'))
 
840
        self.assertEquals('c2', c2._get_user_option('one'))
888
841
        # The first modification is still available until another refresh
889
842
        # occur
890
 
        self.assertEqual('c1', c1._get_user_option('one'))
 
843
        self.assertEquals('c1', c1._get_user_option('one'))
891
844
        c1.set_user_option('two', 'done')
892
 
        self.assertEqual('c2', c1._get_user_option('one'))
 
845
        self.assertEquals('c2', c1._get_user_option('one'))
893
846
 
894
847
    def test_writes_are_serialized(self):
895
848
        c1 = self.config
920
873
        self.assertTrue(c1._lock.is_held)
921
874
        self.assertRaises(errors.LockContention,
922
875
                          c2.set_user_option, 'one', 'c2')
923
 
        self.assertEqual('c1', c1.get_user_option('one'))
 
876
        self.assertEquals('c1', c1.get_user_option('one'))
924
877
        # Let the lock be released
925
878
        after_writing.set()
926
879
        writing_done.wait()
927
880
        c2.set_user_option('one', 'c2')
928
 
        self.assertEqual('c2', c2.get_user_option('one'))
 
881
        self.assertEquals('c2', c2.get_user_option('one'))
929
882
 
930
883
    def test_read_while_writing(self):
931
884
       c1 = self.config
953
906
       # Ensure the thread is ready to write
954
907
       ready_to_write.wait()
955
908
       self.assertTrue(c1._lock.is_held)
956
 
       self.assertEqual('c1', c1.get_user_option('one'))
 
909
       self.assertEquals('c1', c1.get_user_option('one'))
957
910
       # If we read during the write, we get the old value
958
911
       c2 = self.get_existing_config()
959
 
       self.assertEqual('1', c2.get_user_option('one'))
 
912
       self.assertEquals('1', c2.get_user_option('one'))
960
913
       # Let the writing occur and ensure it occurred
961
914
       do_writing.set()
962
915
       writing_done.wait()
963
916
       # Now we get the updated value
964
917
       c3 = self.get_existing_config()
965
 
       self.assertEqual('c1', c3.get_user_option('one'))
 
918
       self.assertEquals('c1', c3.get_user_option('one'))
966
919
 
967
920
 
968
921
class TestGetUserOptionAs(TestIniConfig):
983
936
        self.overrideAttr(trace, 'warning', warning)
984
937
        msg = 'Value "%s" is not a boolean for "%s"'
985
938
        self.assertIs(None, get_bool('an_invalid_bool'))
986
 
        self.assertEqual(msg % ('maybe', 'an_invalid_bool'), warnings[0])
 
939
        self.assertEquals(msg % ('maybe', 'an_invalid_bool'), warnings[0])
987
940
        warnings = []
988
941
        self.assertIs(None, get_bool('not_defined_in_this_config'))
989
 
        self.assertEqual([], warnings)
 
942
        self.assertEquals([], warnings)
990
943
 
991
944
    def test_get_user_option_as_list(self):
992
945
        conf, parser = self.make_config_parser("""
1001
954
        # automatically cast to list
1002
955
        self.assertEqual(['x'], get_list('one_item'))
1003
956
 
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
 
 
1028
957
 
1029
958
class TestSupressWarning(TestIniConfig):
1030
959
 
1046
975
class TestGetConfig(tests.TestCase):
1047
976
 
1048
977
    def test_constructs(self):
1049
 
        config.GlobalConfig()
 
978
        my_config = config.GlobalConfig()
1050
979
 
1051
980
    def test_calls_read_filenames(self):
1052
981
        # replace the class that is constructed, to check its parameters
1064
993
 
1065
994
class TestBranchConfig(tests.TestCaseWithTransport):
1066
995
 
1067
 
    def test_constructs_valid(self):
 
996
    def test_constructs(self):
1068
997
        branch = FakeBranch()
1069
998
        my_config = config.BranchConfig(branch)
1070
 
        self.assertIsNot(None, my_config)
1071
 
 
1072
 
    def test_constructs_error(self):
1073
999
        self.assertRaises(TypeError, config.BranchConfig)
1074
1000
 
1075
1001
    def test_get_location_config(self):
1081
1007
 
1082
1008
    def test_get_config(self):
1083
1009
        """The Branch.get_config method works properly"""
1084
 
        b = controldir.ControlDir.create_standalone_workingtree('.').branch
 
1010
        b = bzrdir.BzrDir.create_standalone_workingtree('.').branch
1085
1011
        my_config = b.get_config()
1086
1012
        self.assertIs(my_config.get_user_option('wacky'), None)
1087
1013
        my_config.set_user_option('wacky', 'unlikely')
1107
1033
        conf = config.LocationConfig.from_string(
1108
1034
            '[%s]\nnickname = foobar' % (local_url,),
1109
1035
            local_url, save=True)
1110
 
        self.assertIsNot(None, conf)
1111
1036
        self.assertEqual('foobar', branch.nick)
1112
1037
 
1113
1038
    def test_config_local_path(self):
1116
1041
        self.assertEqual('branch', branch.nick)
1117
1042
 
1118
1043
        local_path = osutils.getcwd().encode('utf8')
1119
 
        config.LocationConfig.from_string(
 
1044
        conf = config.LocationConfig.from_string(
1120
1045
            '[%s/branch]\nnickname = barry' % (local_path,),
1121
1046
            'branch',  save=True)
1122
 
        # Now the branch will find its nick via the location config
1123
1047
        self.assertEqual('barry', branch.nick)
1124
1048
 
1125
1049
    def test_config_creates_local(self):
1138
1062
        b = self.make_branch('!repo')
1139
1063
        self.assertEqual('!repo', b.get_config().get_nickname())
1140
1064
 
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
 
 
1145
1065
    def test_warn_if_masked(self):
1146
1066
        warnings = []
1147
1067
        def warning(*args):
1187
1107
        my_config = config.GlobalConfig()
1188
1108
        self.assertEqual(None, my_config._get_user_id())
1189
1109
 
 
1110
    def test_configured_editor(self):
 
1111
        my_config = config.GlobalConfig.from_string(sample_config_text)
 
1112
        self.assertEqual("vim", my_config.get_editor())
 
1113
 
1190
1114
    def test_signatures_always(self):
1191
1115
        my_config = config.GlobalConfig.from_string(sample_always_signatures)
1192
1116
        self.assertEqual(config.CHECK_NEVER,
1193
 
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
1194
 
                             my_config.signature_checking))
 
1117
                         my_config.signature_checking())
1195
1118
        self.assertEqual(config.SIGN_ALWAYS,
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))
 
1119
                         my_config.signing_policy())
 
1120
        self.assertEqual(True, my_config.signature_needed())
1201
1121
 
1202
1122
    def test_signatures_if_possible(self):
1203
1123
        my_config = config.GlobalConfig.from_string(sample_maybe_signatures)
1204
1124
        self.assertEqual(config.CHECK_NEVER,
1205
 
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
1206
 
                             my_config.signature_checking))
 
1125
                         my_config.signature_checking())
1207
1126
        self.assertEqual(config.SIGN_WHEN_REQUIRED,
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))
 
1127
                         my_config.signing_policy())
 
1128
        self.assertEqual(False, my_config.signature_needed())
1212
1129
 
1213
1130
    def test_signatures_ignore(self):
1214
1131
        my_config = config.GlobalConfig.from_string(sample_ignore_signatures)
1215
1132
        self.assertEqual(config.CHECK_ALWAYS,
1216
 
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
1217
 
                             my_config.signature_checking))
 
1133
                         my_config.signature_checking())
1218
1134
        self.assertEqual(config.SIGN_NEVER,
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))
 
1135
                         my_config.signing_policy())
 
1136
        self.assertEqual(False, my_config.signature_needed())
1223
1137
 
1224
1138
    def _get_sample_config(self):
1225
1139
        my_config = config.GlobalConfig.from_string(sample_config_text)
1227
1141
 
1228
1142
    def test_gpg_signing_command(self):
1229
1143
        my_config = self._get_sample_config()
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))
1235
 
 
1236
 
    def test_gpg_signing_key(self):
1237
 
        my_config = self._get_sample_config()
1238
 
        self.assertEqual("DD4D5088",
1239
 
            self.applyDeprecated(deprecated_in((2, 5, 0)),
1240
 
                my_config.gpg_signing_key))
 
1144
        self.assertEqual("gnome-gpg", my_config.gpg_signing_command())
 
1145
        self.assertEqual(False, my_config.signature_needed())
1241
1146
 
1242
1147
    def _get_empty_config(self):
1243
1148
        my_config = config.GlobalConfig()
1245
1150
 
1246
1151
    def test_gpg_signing_command_unset(self):
1247
1152
        my_config = self._get_empty_config()
1248
 
        self.assertEqual("gpg",
1249
 
            self.applyDeprecated(
1250
 
                deprecated_in((2, 5, 0)), my_config.gpg_signing_command))
 
1153
        self.assertEqual("gpg", my_config.gpg_signing_command())
1251
1154
 
1252
1155
    def test_get_user_option_default(self):
1253
1156
        my_config = self._get_empty_config()
1260
1163
 
1261
1164
    def test_post_commit_default(self):
1262
1165
        my_config = self._get_sample_config()
1263
 
        self.assertEqual(None,
1264
 
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
1265
 
                                              my_config.post_commit))
 
1166
        self.assertEqual(None, my_config.post_commit())
1266
1167
 
1267
1168
    def test_configured_logformat(self):
1268
1169
        my_config = self._get_sample_config()
1269
 
        self.assertEqual("short",
1270
 
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
1271
 
                                              my_config.log_format))
1272
 
 
1273
 
    def test_configured_acceptable_keys(self):
1274
 
        my_config = self._get_sample_config()
1275
 
        self.assertEqual("amy",
1276
 
            self.applyDeprecated(deprecated_in((2, 5, 0)),
1277
 
                my_config.acceptable_keys))
1278
 
 
1279
 
    def test_configured_validate_signatures_in_log(self):
1280
 
        my_config = self._get_sample_config()
1281
 
        self.assertEqual(True, my_config.validate_signatures_in_log())
 
1170
        self.assertEqual("short", my_config.log_format())
1282
1171
 
1283
1172
    def test_get_alias(self):
1284
1173
        my_config = self._get_sample_config()
1318
1207
        self.log(repr(tools))
1319
1208
        self.assertEqual(
1320
1209
            {u'funkytool' : u'funkytool "arg with spaces" {this_temp}',
1321
 
            u'sometool' : u'sometool {base} {this} {other} -o {result}',
1322
 
            u'newtool' : u'"newtool with spaces" {this_temp}'},
 
1210
            u'sometool' : u'sometool {base} {this} {other} -o {result}'},
1323
1211
            tools)
1324
1212
 
1325
1213
    def test_get_merge_tools_empty(self):
1340
1228
    def test_find_merge_tool_known(self):
1341
1229
        conf = self._get_empty_config()
1342
1230
        cmdline = conf.find_merge_tool('kdiff3')
1343
 
        self.assertEqual('kdiff3 {base} {this} {other} -o {result}', cmdline)
 
1231
        self.assertEquals('kdiff3 {base} {this} {other} -o {result}', cmdline)
1344
1232
 
1345
1233
    def test_find_merge_tool_override_known(self):
1346
1234
        conf = self._get_empty_config()
1373
1261
 
1374
1262
class TestLocationConfig(tests.TestCaseInTempDir, TestOptionsMixin):
1375
1263
 
1376
 
    def test_constructs_valid(self):
1377
 
        config.LocationConfig('http://example.com')
1378
 
 
1379
 
    def test_constructs_error(self):
 
1264
    def test_constructs(self):
 
1265
        my_config = config.LocationConfig('http://example.com')
1380
1266
        self.assertRaises(TypeError, config.LocationConfig)
1381
1267
 
1382
1268
    def test_branch_calls_read_filenames(self):
1518
1404
        self.get_branch_config('http://www.example.com',
1519
1405
                                 global_config=sample_ignore_signatures)
1520
1406
        self.assertEqual(config.CHECK_ALWAYS,
1521
 
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
1522
 
                             self.my_config.signature_checking))
 
1407
                         self.my_config.signature_checking())
1523
1408
        self.assertEqual(config.SIGN_NEVER,
1524
 
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
1525
 
                             self.my_config.signing_policy))
 
1409
                         self.my_config.signing_policy())
1526
1410
 
1527
1411
    def test_signatures_never(self):
1528
1412
        self.get_branch_config('/a/c')
1529
1413
        self.assertEqual(config.CHECK_NEVER,
1530
 
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
1531
 
                             self.my_config.signature_checking))
 
1414
                         self.my_config.signature_checking())
1532
1415
 
1533
1416
    def test_signatures_when_available(self):
1534
1417
        self.get_branch_config('/a/', global_config=sample_ignore_signatures)
1535
1418
        self.assertEqual(config.CHECK_IF_POSSIBLE,
1536
 
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
1537
 
                             self.my_config.signature_checking))
 
1419
                         self.my_config.signature_checking())
1538
1420
 
1539
1421
    def test_signatures_always(self):
1540
1422
        self.get_branch_config('/b')
1541
1423
        self.assertEqual(config.CHECK_ALWAYS,
1542
 
            self.applyDeprecated(deprecated_in((2, 5, 0)),
1543
 
                         self.my_config.signature_checking))
 
1424
                         self.my_config.signature_checking())
1544
1425
 
1545
1426
    def test_gpg_signing_command(self):
1546
1427
        self.get_branch_config('/b')
1547
 
        self.assertEqual("gnome-gpg",
1548
 
            self.applyDeprecated(deprecated_in((2, 5, 0)),
1549
 
                self.my_config.gpg_signing_command))
 
1428
        self.assertEqual("gnome-gpg", self.my_config.gpg_signing_command())
1550
1429
 
1551
1430
    def test_gpg_signing_command_missing(self):
1552
1431
        self.get_branch_config('/a')
1553
 
        self.assertEqual("false",
1554
 
            self.applyDeprecated(deprecated_in((2, 5, 0)),
1555
 
                self.my_config.gpg_signing_command))
1556
 
 
1557
 
    def test_gpg_signing_key(self):
1558
 
        self.get_branch_config('/b')
1559
 
        self.assertEqual("DD4D5088", self.applyDeprecated(deprecated_in((2, 5, 0)),
1560
 
            self.my_config.gpg_signing_key))
1561
 
 
1562
 
    def test_gpg_signing_key_default(self):
1563
 
        self.get_branch_config('/a')
1564
 
        self.assertEqual("erik@bagfors.nu",
1565
 
            self.applyDeprecated(deprecated_in((2, 5, 0)),
1566
 
                self.my_config.gpg_signing_key))
 
1432
        self.assertEqual("false", self.my_config.gpg_signing_command())
1567
1433
 
1568
1434
    def test_get_user_option_global(self):
1569
1435
        self.get_branch_config('/a')
1657
1523
    def test_post_commit_default(self):
1658
1524
        self.get_branch_config('/a/c')
1659
1525
        self.assertEqual('bzrlib.tests.test_config.post_commit',
1660
 
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
1661
 
                                              self.my_config.post_commit))
 
1526
                         self.my_config.post_commit())
1662
1527
 
1663
1528
    def get_branch_config(self, location, global_config=None,
1664
1529
                          location_config=None):
1668
1533
        if location_config is None:
1669
1534
            location_config = sample_branches_text
1670
1535
 
1671
 
        config.GlobalConfig.from_string(global_config, save=True)
1672
 
        config.LocationConfig.from_string(location_config, my_branch.base,
1673
 
                                          save=True)
 
1536
        my_global_config = config.GlobalConfig.from_string(global_config,
 
1537
                                                           save=True)
 
1538
        my_location_config = config.LocationConfig.from_string(
 
1539
            location_config, my_branch.base, save=True)
1674
1540
        my_config = config.BranchConfig(my_branch)
1675
1541
        self.my_config = my_config
1676
1542
        self.my_location_config = my_config._get_location_config()
1741
1607
                          location_config=None, branch_data_config=None):
1742
1608
        my_branch = FakeBranch(location)
1743
1609
        if global_config is not None:
1744
 
            config.GlobalConfig.from_string(global_config, save=True)
 
1610
            my_global_config = config.GlobalConfig.from_string(global_config,
 
1611
                                                               save=True)
1745
1612
        if location_config is not None:
1746
 
            config.LocationConfig.from_string(location_config, my_branch.base,
1747
 
                                              save=True)
 
1613
            my_location_config = config.LocationConfig.from_string(
 
1614
                location_config, my_branch.base, save=True)
1748
1615
        my_config = config.BranchConfig(my_branch)
1749
1616
        if branch_data_config is not None:
1750
1617
            my_config.branch.control_files.files['branch.conf'] = \
1752
1619
        return my_config
1753
1620
 
1754
1621
    def test_user_id(self):
1755
 
        branch = FakeBranch()
 
1622
        branch = FakeBranch(user_id='Robert Collins <robertc@example.net>')
1756
1623
        my_config = config.BranchConfig(branch)
1757
 
        self.assertIsNot(None, my_config.username())
 
1624
        self.assertEqual("Robert Collins <robertc@example.net>",
 
1625
                         my_config.username())
1758
1626
        my_config.branch.control_files.files['email'] = "John"
1759
1627
        my_config.set_user_option('email',
1760
1628
                                  "Robert Collins <robertc@example.org>")
 
1629
        self.assertEqual("John", my_config.username())
 
1630
        del my_config.branch.control_files.files['email']
1761
1631
        self.assertEqual("Robert Collins <robertc@example.org>",
1762
 
                        my_config.username())
 
1632
                         my_config.username())
 
1633
 
 
1634
    def test_not_set_in_branch(self):
 
1635
        my_config = self.get_branch_config(global_config=sample_config_text)
 
1636
        self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
 
1637
                         my_config._get_user_id())
 
1638
        my_config.branch.control_files.files['email'] = "John"
 
1639
        self.assertEqual("John", my_config._get_user_id())
1763
1640
 
1764
1641
    def test_BZR_EMAIL_OVERRIDES(self):
1765
1642
        self.overrideEnv('BZR_EMAIL', "Robert Collins <robertc@example.org>")
1771
1648
    def test_signatures_forced(self):
1772
1649
        my_config = self.get_branch_config(
1773
1650
            global_config=sample_always_signatures)
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))
 
1651
        self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
 
1652
        self.assertEqual(config.SIGN_ALWAYS, my_config.signing_policy())
 
1653
        self.assertTrue(my_config.signature_needed())
1782
1654
 
1783
1655
    def test_signatures_forced_branch(self):
1784
1656
        my_config = self.get_branch_config(
1785
1657
            global_config=sample_ignore_signatures,
1786
1658
            branch_data_config=sample_always_signatures)
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))
 
1659
        self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
 
1660
        self.assertEqual(config.SIGN_ALWAYS, my_config.signing_policy())
 
1661
        self.assertTrue(my_config.signature_needed())
1795
1662
 
1796
1663
    def test_gpg_signing_command(self):
1797
1664
        my_config = self.get_branch_config(
1798
1665
            global_config=sample_config_text,
1799
1666
            # branch data cannot set gpg_signing_command
1800
1667
            branch_data_config="gpg_signing_command=pgp")
1801
 
        self.assertEqual('gnome-gpg',
1802
 
            self.applyDeprecated(deprecated_in((2, 5, 0)),
1803
 
                my_config.gpg_signing_command))
 
1668
        self.assertEqual('gnome-gpg', my_config.gpg_signing_command())
1804
1669
 
1805
1670
    def test_get_user_option_global(self):
1806
1671
        my_config = self.get_branch_config(global_config=sample_config_text)
1813
1678
                                      location_config=sample_branches_text)
1814
1679
        self.assertEqual(my_config.branch.base, '/a/c')
1815
1680
        self.assertEqual('bzrlib.tests.test_config.post_commit',
1816
 
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
1817
 
                                              my_config.post_commit))
 
1681
                         my_config.post_commit())
1818
1682
        my_config.set_user_option('post_commit', 'rmtree_root')
1819
1683
        # post-commit is ignored when present in branch data
1820
1684
        self.assertEqual('bzrlib.tests.test_config.post_commit',
1821
 
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
1822
 
                                              my_config.post_commit))
 
1685
                         my_config.post_commit())
1823
1686
        my_config.set_user_option('post_commit', 'rmtree_root',
1824
1687
                                  store=config.STORE_LOCATION)
1825
 
        self.assertEqual('rmtree_root',
1826
 
                         self.applyDeprecated(deprecated_in((2, 5, 0)),
1827
 
                                              my_config.post_commit))
 
1688
        self.assertEqual('rmtree_root', my_config.post_commit())
1828
1689
 
1829
1690
    def test_config_precedence(self):
1830
1691
        # FIXME: eager test, luckily no persitent config file makes it fail
1846
1707
            location='http://example.com/specific')
1847
1708
        self.assertEqual(my_config.get_user_option('option'), 'exact')
1848
1709
 
 
1710
    def test_get_mail_client(self):
 
1711
        config = self.get_branch_config()
 
1712
        client = config.get_mail_client()
 
1713
        self.assertIsInstance(client, mail_client.DefaultMail)
 
1714
 
 
1715
        # Specific clients
 
1716
        config.set_user_option('mail_client', 'evolution')
 
1717
        client = config.get_mail_client()
 
1718
        self.assertIsInstance(client, mail_client.Evolution)
 
1719
 
 
1720
        config.set_user_option('mail_client', 'kmail')
 
1721
        client = config.get_mail_client()
 
1722
        self.assertIsInstance(client, mail_client.KMail)
 
1723
 
 
1724
        config.set_user_option('mail_client', 'mutt')
 
1725
        client = config.get_mail_client()
 
1726
        self.assertIsInstance(client, mail_client.Mutt)
 
1727
 
 
1728
        config.set_user_option('mail_client', 'thunderbird')
 
1729
        client = config.get_mail_client()
 
1730
        self.assertIsInstance(client, mail_client.Thunderbird)
 
1731
 
 
1732
        # Generic options
 
1733
        config.set_user_option('mail_client', 'default')
 
1734
        client = config.get_mail_client()
 
1735
        self.assertIsInstance(client, mail_client.DefaultMail)
 
1736
 
 
1737
        config.set_user_option('mail_client', 'editor')
 
1738
        client = config.get_mail_client()
 
1739
        self.assertIsInstance(client, mail_client.Editor)
 
1740
 
 
1741
        config.set_user_option('mail_client', 'mapi')
 
1742
        client = config.get_mail_client()
 
1743
        self.assertIsInstance(client, mail_client.MAPIClient)
 
1744
 
 
1745
        config.set_user_option('mail_client', 'xdg-email')
 
1746
        client = config.get_mail_client()
 
1747
        self.assertIsInstance(client, mail_client.XDGEmail)
 
1748
 
 
1749
        config.set_user_option('mail_client', 'firebird')
 
1750
        self.assertRaises(errors.UnknownMailClient, config.get_mail_client)
 
1751
 
1849
1752
 
1850
1753
class TestMailAddressExtraction(tests.TestCase):
1851
1754
 
1897
1800
 
1898
1801
class TestTransportConfig(tests.TestCaseWithTransport):
1899
1802
 
1900
 
    def test_load_utf8(self):
1901
 
        """Ensure we can load an utf8-encoded file."""
1902
 
        t = self.get_transport()
1903
 
        unicode_user = u'b\N{Euro Sign}ar'
1904
 
        unicode_content = u'user=%s' % (unicode_user,)
1905
 
        utf8_content = unicode_content.encode('utf8')
1906
 
        # Store the raw content in the config file
1907
 
        t.put_bytes('foo.conf', utf8_content)
1908
 
        conf = config.TransportConfig(t, 'foo.conf')
1909
 
        self.assertEqual(unicode_user, conf.get_option('user'))
1910
 
 
1911
 
    def test_load_non_ascii(self):
1912
 
        """Ensure we display a proper error on non-ascii, non utf-8 content."""
1913
 
        t = self.get_transport()
1914
 
        t.put_bytes('foo.conf', 'user=foo\n#\xff\n')
1915
 
        conf = config.TransportConfig(t, 'foo.conf')
1916
 
        self.assertRaises(errors.ConfigContentError, conf._get_configobj)
1917
 
 
1918
 
    def test_load_erroneous_content(self):
1919
 
        """Ensure we display a proper error on content that can't be parsed."""
1920
 
        t = self.get_transport()
1921
 
        t.put_bytes('foo.conf', '[open_section\n')
1922
 
        conf = config.TransportConfig(t, 'foo.conf')
1923
 
        self.assertRaises(errors.ParseConfigError, conf._get_configobj)
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
 
 
1948
1803
    def test_get_value(self):
1949
1804
        """Test that retreiving a value from a section is possible"""
1950
 
        bzrdir_config = config.TransportConfig(self.get_transport('.'),
 
1805
        bzrdir_config = config.TransportConfig(transport.get_transport('.'),
1951
1806
                                               'control.conf')
1952
1807
        bzrdir_config.set_option('value', 'key', 'SECTION')
1953
1808
        bzrdir_config.set_option('value2', 'key2')
1983
1838
        self.assertIs(None, bzrdir_config.get_default_stack_on())
1984
1839
 
1985
1840
 
1986
 
class TestOldConfigHooks(tests.TestCaseWithTransport):
1987
 
 
1988
 
    def setUp(self):
1989
 
        super(TestOldConfigHooks, self).setUp()
1990
 
        create_configs_with_file_option(self)
1991
 
 
1992
 
    def assertGetHook(self, conf, name, value):
1993
 
        calls = []
1994
 
        def hook(*args):
1995
 
            calls.append(args)
1996
 
        config.OldConfigHooks.install_named_hook('get', hook, None)
1997
 
        self.addCleanup(
1998
 
            config.OldConfigHooks.uninstall_named_hook, 'get', None)
1999
 
        self.assertLength(0, calls)
2000
 
        actual_value = conf.get_user_option(name)
2001
 
        self.assertEqual(value, actual_value)
2002
 
        self.assertLength(1, calls)
2003
 
        self.assertEqual((conf, name, value), calls[0])
2004
 
 
2005
 
    def test_get_hook_bazaar(self):
2006
 
        self.assertGetHook(self.bazaar_config, 'file', 'bazaar')
2007
 
 
2008
 
    def test_get_hook_locations(self):
2009
 
        self.assertGetHook(self.locations_config, 'file', 'locations')
2010
 
 
2011
 
    def test_get_hook_branch(self):
2012
 
        # Since locations masks branch, we define a different option
2013
 
        self.branch_config.set_user_option('file2', 'branch')
2014
 
        self.assertGetHook(self.branch_config, 'file2', 'branch')
2015
 
 
2016
 
    def assertSetHook(self, conf, name, value):
2017
 
        calls = []
2018
 
        def hook(*args):
2019
 
            calls.append(args)
2020
 
        config.OldConfigHooks.install_named_hook('set', hook, None)
2021
 
        self.addCleanup(
2022
 
            config.OldConfigHooks.uninstall_named_hook, 'set', None)
2023
 
        self.assertLength(0, calls)
2024
 
        conf.set_user_option(name, value)
2025
 
        self.assertLength(1, calls)
2026
 
        # We can't assert the conf object below as different configs use
2027
 
        # different means to implement set_user_option and we care only about
2028
 
        # coverage here.
2029
 
        self.assertEqual((name, value), calls[0][1:])
2030
 
 
2031
 
    def test_set_hook_bazaar(self):
2032
 
        self.assertSetHook(self.bazaar_config, 'foo', 'bazaar')
2033
 
 
2034
 
    def test_set_hook_locations(self):
2035
 
        self.assertSetHook(self.locations_config, 'foo', 'locations')
2036
 
 
2037
 
    def test_set_hook_branch(self):
2038
 
        self.assertSetHook(self.branch_config, 'foo', 'branch')
2039
 
 
2040
 
    def assertRemoveHook(self, conf, name, section_name=None):
2041
 
        calls = []
2042
 
        def hook(*args):
2043
 
            calls.append(args)
2044
 
        config.OldConfigHooks.install_named_hook('remove', hook, None)
2045
 
        self.addCleanup(
2046
 
            config.OldConfigHooks.uninstall_named_hook, 'remove', None)
2047
 
        self.assertLength(0, calls)
2048
 
        conf.remove_user_option(name, section_name)
2049
 
        self.assertLength(1, calls)
2050
 
        # We can't assert the conf object below as different configs use
2051
 
        # different means to implement remove_user_option and we care only about
2052
 
        # coverage here.
2053
 
        self.assertEqual((name,), calls[0][1:])
2054
 
 
2055
 
    def test_remove_hook_bazaar(self):
2056
 
        self.assertRemoveHook(self.bazaar_config, 'file')
2057
 
 
2058
 
    def test_remove_hook_locations(self):
2059
 
        self.assertRemoveHook(self.locations_config, 'file',
2060
 
                              self.locations_config.location)
2061
 
 
2062
 
    def test_remove_hook_branch(self):
2063
 
        self.assertRemoveHook(self.branch_config, 'file')
2064
 
 
2065
 
    def assertLoadHook(self, name, conf_class, *conf_args):
2066
 
        calls = []
2067
 
        def hook(*args):
2068
 
            calls.append(args)
2069
 
        config.OldConfigHooks.install_named_hook('load', hook, None)
2070
 
        self.addCleanup(
2071
 
            config.OldConfigHooks.uninstall_named_hook, 'load', None)
2072
 
        self.assertLength(0, calls)
2073
 
        # Build a config
2074
 
        conf = conf_class(*conf_args)
2075
 
        # Access an option to trigger a load
2076
 
        conf.get_user_option(name)
2077
 
        self.assertLength(1, calls)
2078
 
        # Since we can't assert about conf, we just use the number of calls ;-/
2079
 
 
2080
 
    def test_load_hook_bazaar(self):
2081
 
        self.assertLoadHook('file', config.GlobalConfig)
2082
 
 
2083
 
    def test_load_hook_locations(self):
2084
 
        self.assertLoadHook('file', config.LocationConfig, self.tree.basedir)
2085
 
 
2086
 
    def test_load_hook_branch(self):
2087
 
        self.assertLoadHook('file', config.BranchConfig, self.tree.branch)
2088
 
 
2089
 
    def assertSaveHook(self, conf):
2090
 
        calls = []
2091
 
        def hook(*args):
2092
 
            calls.append(args)
2093
 
        config.OldConfigHooks.install_named_hook('save', hook, None)
2094
 
        self.addCleanup(
2095
 
            config.OldConfigHooks.uninstall_named_hook, 'save', None)
2096
 
        self.assertLength(0, calls)
2097
 
        # Setting an option triggers a save
2098
 
        conf.set_user_option('foo', 'bar')
2099
 
        self.assertLength(1, calls)
2100
 
        # Since we can't assert about conf, we just use the number of calls ;-/
2101
 
 
2102
 
    def test_save_hook_bazaar(self):
2103
 
        self.assertSaveHook(self.bazaar_config)
2104
 
 
2105
 
    def test_save_hook_locations(self):
2106
 
        self.assertSaveHook(self.locations_config)
2107
 
 
2108
 
    def test_save_hook_branch(self):
2109
 
        self.assertSaveHook(self.branch_config)
2110
 
 
2111
 
 
2112
 
class TestOldConfigHooksForRemote(tests.TestCaseWithTransport):
2113
 
    """Tests config hooks for remote configs.
2114
 
 
2115
 
    No tests for the remove hook as this is not implemented there.
2116
 
    """
2117
 
 
2118
 
    def setUp(self):
2119
 
        super(TestOldConfigHooksForRemote, self).setUp()
2120
 
        self.transport_server = test_server.SmartTCPServer_for_testing
2121
 
        create_configs_with_file_option(self)
2122
 
 
2123
 
    def assertGetHook(self, conf, name, value):
2124
 
        calls = []
2125
 
        def hook(*args):
2126
 
            calls.append(args)
2127
 
        config.OldConfigHooks.install_named_hook('get', hook, None)
2128
 
        self.addCleanup(
2129
 
            config.OldConfigHooks.uninstall_named_hook, 'get', None)
2130
 
        self.assertLength(0, calls)
2131
 
        actual_value = conf.get_option(name)
2132
 
        self.assertEqual(value, actual_value)
2133
 
        self.assertLength(1, calls)
2134
 
        self.assertEqual((conf, name, value), calls[0])
2135
 
 
2136
 
    def test_get_hook_remote_branch(self):
2137
 
        remote_branch = branch.Branch.open(self.get_url('tree'))
2138
 
        self.assertGetHook(remote_branch._get_config(), 'file', 'branch')
2139
 
 
2140
 
    def test_get_hook_remote_bzrdir(self):
2141
 
        remote_bzrdir = controldir.ControlDir.open(self.get_url('tree'))
2142
 
        conf = remote_bzrdir._get_config()
2143
 
        conf.set_option('remotedir', 'file')
2144
 
        self.assertGetHook(conf, 'file', 'remotedir')
2145
 
 
2146
 
    def assertSetHook(self, conf, name, value):
2147
 
        calls = []
2148
 
        def hook(*args):
2149
 
            calls.append(args)
2150
 
        config.OldConfigHooks.install_named_hook('set', hook, None)
2151
 
        self.addCleanup(
2152
 
            config.OldConfigHooks.uninstall_named_hook, 'set', None)
2153
 
        self.assertLength(0, calls)
2154
 
        conf.set_option(value, name)
2155
 
        self.assertLength(1, calls)
2156
 
        # We can't assert the conf object below as different configs use
2157
 
        # different means to implement set_user_option and we care only about
2158
 
        # coverage here.
2159
 
        self.assertEqual((name, value), calls[0][1:])
2160
 
 
2161
 
    def test_set_hook_remote_branch(self):
2162
 
        remote_branch = branch.Branch.open(self.get_url('tree'))
2163
 
        self.addCleanup(remote_branch.lock_write().unlock)
2164
 
        self.assertSetHook(remote_branch._get_config(), 'file', 'remote')
2165
 
 
2166
 
    def test_set_hook_remote_bzrdir(self):
2167
 
        remote_branch = branch.Branch.open(self.get_url('tree'))
2168
 
        self.addCleanup(remote_branch.lock_write().unlock)
2169
 
        remote_bzrdir = controldir.ControlDir.open(self.get_url('tree'))
2170
 
        self.assertSetHook(remote_bzrdir._get_config(), 'file', 'remotedir')
2171
 
 
2172
 
    def assertLoadHook(self, expected_nb_calls, name, conf_class, *conf_args):
2173
 
        calls = []
2174
 
        def hook(*args):
2175
 
            calls.append(args)
2176
 
        config.OldConfigHooks.install_named_hook('load', hook, None)
2177
 
        self.addCleanup(
2178
 
            config.OldConfigHooks.uninstall_named_hook, 'load', None)
2179
 
        self.assertLength(0, calls)
2180
 
        # Build a config
2181
 
        conf = conf_class(*conf_args)
2182
 
        # Access an option to trigger a load
2183
 
        conf.get_option(name)
2184
 
        self.assertLength(expected_nb_calls, calls)
2185
 
        # Since we can't assert about conf, we just use the number of calls ;-/
2186
 
 
2187
 
    def test_load_hook_remote_branch(self):
2188
 
        remote_branch = branch.Branch.open(self.get_url('tree'))
2189
 
        self.assertLoadHook(1, 'file', remote.RemoteBranchConfig, remote_branch)
2190
 
 
2191
 
    def test_load_hook_remote_bzrdir(self):
2192
 
        remote_bzrdir = controldir.ControlDir.open(self.get_url('tree'))
2193
 
        # The config file doesn't exist, set an option to force its creation
2194
 
        conf = remote_bzrdir._get_config()
2195
 
        conf.set_option('remotedir', 'file')
2196
 
        # We get one call for the server and one call for the client, this is
2197
 
        # caused by the differences in implementations betwen
2198
 
        # SmartServerBzrDirRequestConfigFile (in smart/bzrdir.py) and
2199
 
        # SmartServerBranchGetConfigFile (in smart/branch.py)
2200
 
        self.assertLoadHook(2 ,'file', remote.RemoteBzrDirConfig, remote_bzrdir)
2201
 
 
2202
 
    def assertSaveHook(self, conf):
2203
 
        calls = []
2204
 
        def hook(*args):
2205
 
            calls.append(args)
2206
 
        config.OldConfigHooks.install_named_hook('save', hook, None)
2207
 
        self.addCleanup(
2208
 
            config.OldConfigHooks.uninstall_named_hook, 'save', None)
2209
 
        self.assertLength(0, calls)
2210
 
        # Setting an option triggers a save
2211
 
        conf.set_option('foo', 'bar')
2212
 
        self.assertLength(1, calls)
2213
 
        # Since we can't assert about conf, we just use the number of calls ;-/
2214
 
 
2215
 
    def test_save_hook_remote_branch(self):
2216
 
        remote_branch = branch.Branch.open(self.get_url('tree'))
2217
 
        self.addCleanup(remote_branch.lock_write().unlock)
2218
 
        self.assertSaveHook(remote_branch._get_config())
2219
 
 
2220
 
    def test_save_hook_remote_bzrdir(self):
2221
 
        remote_branch = branch.Branch.open(self.get_url('tree'))
2222
 
        self.addCleanup(remote_branch.lock_write().unlock)
2223
 
        remote_bzrdir = controldir.ControlDir.open(self.get_url('tree'))
2224
 
        self.assertSaveHook(remote_bzrdir._get_config())
2225
 
 
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
 
 
2271
 
class TestOption(tests.TestCase):
2272
 
 
2273
 
    def test_default_value(self):
2274
 
        opt = config.Option('foo', default='bar')
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())
2479
 
 
2480
 
 
2481
 
class TestOptionRegistry(tests.TestCase):
2482
 
 
2483
 
    def setUp(self):
2484
 
        super(TestOptionRegistry, self).setUp()
2485
 
        # Always start with an empty registry
2486
 
        self.overrideAttr(config, 'option_registry', config.OptionRegistry())
2487
 
        self.registry = config.option_registry
2488
 
 
2489
 
    def test_register(self):
2490
 
        opt = config.Option('foo')
2491
 
        self.registry.register(opt)
2492
 
        self.assertIs(opt, self.registry.get('foo'))
2493
 
 
2494
 
    def test_registered_help(self):
2495
 
        opt = config.Option('foo', help='A simple option')
2496
 
        self.registry.register(opt)
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,'))
2504
 
 
2505
 
    lazy_option = config.Option('lazy_foo', help='Lazy help')
2506
 
 
2507
 
    def test_register_lazy(self):
2508
 
        self.registry.register_lazy('lazy_foo', self.__module__,
2509
 
                                    'TestOptionRegistry.lazy_option')
2510
 
        self.assertIs(self.lazy_option, self.registry.get('lazy_foo'))
2511
 
 
2512
 
    def test_registered_lazy_help(self):
2513
 
        self.registry.register_lazy('lazy_foo', self.__module__,
2514
 
                                    'TestOptionRegistry.lazy_option')
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')
2529
 
 
2530
 
 
2531
 
class TestRegisteredOptions(tests.TestCase):
2532
 
    """All registered options should verify some constraints."""
2533
 
 
2534
 
    scenarios = [(key, {'option_name': key, 'option': option}) for key, option
2535
 
                 in config.option_registry.iteritems()]
2536
 
 
2537
 
    def setUp(self):
2538
 
        super(TestRegisteredOptions, self).setUp()
2539
 
        self.registry = config.option_registry
2540
 
 
2541
 
    def test_proper_name(self):
2542
 
        # An option should be registered under its own name, this can't be
2543
 
        # checked at registration time for the lazy ones.
2544
 
        self.assertEqual(self.option_name, self.option.name)
2545
 
 
2546
 
    def test_help_is_set(self):
2547
 
        option_help = self.registry.get_help(self.option_name)
2548
 
        # Come on, think about the user, he really wants to know what the
2549
 
        # option is about
2550
 
        self.assertIsNot(None, option_help)
2551
 
        self.assertNotEqual('', option_help)
2552
 
 
2553
 
 
2554
1841
class TestSection(tests.TestCase):
2555
1842
 
2556
1843
    # FIXME: Parametrize so that all sections produced by Stores run these
2559
1846
    def test_get_a_value(self):
2560
1847
        a_dict = dict(foo='bar')
2561
1848
        section = config.Section('myID', a_dict)
2562
 
        self.assertEqual('bar', section.get('foo'))
 
1849
        self.assertEquals('bar', section.get('foo'))
2563
1850
 
2564
1851
    def test_get_unknown_option(self):
2565
1852
        a_dict = dict()
2566
1853
        section = config.Section(None, a_dict)
2567
 
        self.assertEqual('out of thin air',
 
1854
        self.assertEquals('out of thin air',
2568
1855
                          section.get('foo', 'out of thin air'))
2569
1856
 
2570
1857
    def test_options_is_shared(self):
2575
1862
 
2576
1863
class TestMutableSection(tests.TestCase):
2577
1864
 
2578
 
    scenarios = [('mutable',
2579
 
                  {'get_section':
2580
 
                       lambda opts: config.MutableSection('myID', opts)},),
2581
 
        ]
 
1865
    # FIXME: Parametrize so that all sections (including os.environ and the
 
1866
    # ones produced by Stores) run these tests -- vila 2011-04-01
2582
1867
 
2583
1868
    def test_set(self):
2584
1869
        a_dict = dict(foo='bar')
2585
 
        section = self.get_section(a_dict)
 
1870
        section = config.MutableSection('myID', a_dict)
2586
1871
        section.set('foo', 'new_value')
2587
 
        self.assertEqual('new_value', section.get('foo'))
 
1872
        self.assertEquals('new_value', section.get('foo'))
2588
1873
        # The change appears in the shared section
2589
 
        self.assertEqual('new_value', a_dict.get('foo'))
 
1874
        self.assertEquals('new_value', a_dict.get('foo'))
2590
1875
        # We keep track of the change
2591
1876
        self.assertTrue('foo' in section.orig)
2592
 
        self.assertEqual('bar', section.orig.get('foo'))
 
1877
        self.assertEquals('bar', section.orig.get('foo'))
2593
1878
 
2594
1879
    def test_set_preserve_original_once(self):
2595
1880
        a_dict = dict(foo='bar')
2596
 
        section = self.get_section(a_dict)
 
1881
        section = config.MutableSection('myID', a_dict)
2597
1882
        section.set('foo', 'first_value')
2598
1883
        section.set('foo', 'second_value')
2599
1884
        # We keep track of the original value
2600
1885
        self.assertTrue('foo' in section.orig)
2601
 
        self.assertEqual('bar', section.orig.get('foo'))
 
1886
        self.assertEquals('bar', section.orig.get('foo'))
2602
1887
 
2603
1888
    def test_remove(self):
2604
1889
        a_dict = dict(foo='bar')
2605
 
        section = self.get_section(a_dict)
 
1890
        section = config.MutableSection('myID', a_dict)
2606
1891
        section.remove('foo')
2607
1892
        # We get None for unknown options via the default value
2608
 
        self.assertEqual(None, section.get('foo'))
 
1893
        self.assertEquals(None, section.get('foo'))
2609
1894
        # Or we just get the default value
2610
 
        self.assertEqual('unknown', section.get('foo', 'unknown'))
 
1895
        self.assertEquals('unknown', section.get('foo', 'unknown'))
2611
1896
        self.assertFalse('foo' in section.options)
2612
1897
        # We keep track of the deletion
2613
1898
        self.assertTrue('foo' in section.orig)
2614
 
        self.assertEqual('bar', section.orig.get('foo'))
 
1899
        self.assertEquals('bar', section.orig.get('foo'))
2615
1900
 
2616
1901
    def test_remove_new_option(self):
2617
1902
        a_dict = dict()
2618
 
        section = self.get_section(a_dict)
 
1903
        section = config.MutableSection('myID', a_dict)
2619
1904
        section.set('foo', 'bar')
2620
1905
        section.remove('foo')
2621
1906
        self.assertFalse('foo' in section.options)
2622
1907
        # The option didn't exist initially so it we need to keep track of it
2623
1908
        # with a special value
2624
1909
        self.assertTrue('foo' in section.orig)
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)
 
1910
        self.assertEquals(config._NewlyCreatedOption, section.orig['foo'])
2687
1911
 
2688
1912
 
2689
1913
class TestStore(tests.TestCaseWithTransport):
2690
1914
 
2691
 
    def assertSectionContent(self, expected, (store, section)):
 
1915
    def assertSectionContent(self, expected, section):
2692
1916
        """Assert that some options have the proper values in a section."""
2693
1917
        expected_name, expected_options = expected
2694
 
        self.assertEqual(expected_name, section.id)
2695
 
        self.assertEqual(
 
1918
        self.assertEquals(expected_name, section.id)
 
1919
        self.assertEquals(
2696
1920
            expected_options,
2697
1921
            dict([(k, section.get(k)) for k in expected_options.keys()]))
2698
1922
 
2699
1923
 
2700
1924
class TestReadonlyStore(TestStore):
2701
1925
 
2702
 
    scenarios = [(key, {'get_store': builder}) for key, builder
2703
 
                 in config.test_store_builder_registry.iteritems()]
 
1926
    scenarios = [(key, {'get_store': builder})
 
1927
                 for key, builder in test_store_builder_registry.iteritems()]
 
1928
 
 
1929
    def setUp(self):
 
1930
        super(TestReadonlyStore, self).setUp()
 
1931
        self.branch = self.make_branch('branch')
2704
1932
 
2705
1933
    def test_building_delays_load(self):
2706
1934
        store = self.get_store(self)
2707
 
        self.assertEqual(False, store.is_loaded())
 
1935
        self.assertEquals(False, store.is_loaded())
2708
1936
        store._load_from_string('')
2709
 
        self.assertEqual(True, store.is_loaded())
 
1937
        self.assertEquals(True, store.is_loaded())
2710
1938
 
2711
1939
    def test_get_no_sections_for_empty(self):
2712
1940
        store = self.get_store(self)
2713
1941
        store._load_from_string('')
2714
 
        self.assertEqual([], list(store.get_sections()))
 
1942
        self.assertEquals([], list(store.get_sections()))
2715
1943
 
2716
1944
    def test_get_default_section(self):
2717
1945
        store = self.get_store(self)
2733
1961
        self.assertRaises(AssertionError, store._load_from_string, 'bar=baz')
2734
1962
 
2735
1963
 
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
 
 
2809
 
class TestIniFileStoreContent(tests.TestCaseWithTransport):
2810
 
    """Simulate loading a config store with content of various encodings.
2811
 
 
2812
 
    All files produced by bzr are in utf8 content.
2813
 
 
2814
 
    Users may modify them manually and end up with a file that can't be
2815
 
    loaded. We need to issue proper error messages in this case.
2816
 
    """
2817
 
 
2818
 
    invalid_utf8_char = '\xff'
2819
 
 
2820
 
    def test_load_utf8(self):
2821
 
        """Ensure we can load an utf8-encoded file."""
2822
 
        t = self.get_transport()
2823
 
        # From http://pad.lv/799212
2824
 
        unicode_user = u'b\N{Euro Sign}ar'
2825
 
        unicode_content = u'user=%s' % (unicode_user,)
2826
 
        utf8_content = unicode_content.encode('utf8')
2827
 
        # Store the raw content in the config file
2828
 
        t.put_bytes('foo.conf', utf8_content)
2829
 
        store = config.TransportIniFileStore(t, 'foo.conf')
2830
 
        store.load()
2831
 
        stack = config.Stack([store.get_sections], store)
2832
 
        self.assertEqual(unicode_user, stack.get('user'))
2833
 
 
2834
 
    def test_load_non_ascii(self):
2835
 
        """Ensure we display a proper error on non-ascii, non utf-8 content."""
2836
 
        t = self.get_transport()
2837
 
        t.put_bytes('foo.conf', 'user=foo\n#%s\n' % (self.invalid_utf8_char,))
2838
 
        store = config.TransportIniFileStore(t, 'foo.conf')
2839
 
        self.assertRaises(errors.ConfigContentError, store.load)
2840
 
 
2841
 
    def test_load_erroneous_content(self):
2842
 
        """Ensure we display a proper error on content that can't be parsed."""
2843
 
        t = self.get_transport()
2844
 
        t.put_bytes('foo.conf', '[open_section\n')
2845
 
        store = config.TransportIniFileStore(t, 'foo.conf')
2846
 
        self.assertRaises(errors.ParseConfigError, store.load)
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
 
 
2867
 
 
2868
 
class TestIniConfigContent(tests.TestCaseWithTransport):
2869
 
    """Simulate loading a IniBasedConfig with content of various encodings.
2870
 
 
2871
 
    All files produced by bzr are in utf8 content.
2872
 
 
2873
 
    Users may modify them manually and end up with a file that can't be
2874
 
    loaded. We need to issue proper error messages in this case.
2875
 
    """
2876
 
 
2877
 
    invalid_utf8_char = '\xff'
2878
 
 
2879
 
    def test_load_utf8(self):
2880
 
        """Ensure we can load an utf8-encoded file."""
2881
 
        # From http://pad.lv/799212
2882
 
        unicode_user = u'b\N{Euro Sign}ar'
2883
 
        unicode_content = u'user=%s' % (unicode_user,)
2884
 
        utf8_content = unicode_content.encode('utf8')
2885
 
        # Store the raw content in the config file
2886
 
        with open('foo.conf', 'wb') as f:
2887
 
            f.write(utf8_content)
2888
 
        conf = config.IniBasedConfig(file_name='foo.conf')
2889
 
        self.assertEqual(unicode_user, conf.get_user_option('user'))
2890
 
 
2891
 
    def test_load_badly_encoded_content(self):
2892
 
        """Ensure we display a proper error on non-ascii, non utf-8 content."""
2893
 
        with open('foo.conf', 'wb') as f:
2894
 
            f.write('user=foo\n#%s\n' % (self.invalid_utf8_char,))
2895
 
        conf = config.IniBasedConfig(file_name='foo.conf')
2896
 
        self.assertRaises(errors.ConfigContentError, conf._get_parser)
2897
 
 
2898
 
    def test_load_erroneous_content(self):
2899
 
        """Ensure we display a proper error on content that can't be parsed."""
2900
 
        with open('foo.conf', 'wb') as f:
2901
 
            f.write('[open_section\n')
2902
 
        conf = config.IniBasedConfig(file_name='foo.conf')
2903
 
        self.assertRaises(errors.ParseConfigError, conf._get_parser)
2904
 
 
2905
 
 
2906
1964
class TestMutableStore(TestStore):
2907
1965
 
2908
 
    scenarios = [(key, {'store_id': key, 'get_store': builder}) for key, builder
2909
 
                 in config.test_store_builder_registry.iteritems()]
 
1966
    scenarios = [(key, {'store_id': key, 'get_store': builder})
 
1967
                 for key, builder in test_store_builder_registry.iteritems()]
2910
1968
 
2911
1969
    def setUp(self):
2912
1970
        super(TestMutableStore, self).setUp()
2913
1971
        self.transport = self.get_transport()
 
1972
        self.branch = self.make_branch('branch')
2914
1973
 
2915
1974
    def has_store(self, store):
2916
1975
        store_basename = urlutils.relative_url(self.transport.external_url(),
2918
1977
        return self.transport.has(store_basename)
2919
1978
 
2920
1979
    def test_save_empty_creates_no_file(self):
2921
 
        # FIXME: There should be a better way than relying on the test
2922
 
        # parametrization to identify branch.conf -- vila 2011-0526
2923
 
        if self.store_id in ('branch', 'remote_branch'):
 
1980
        if self.store_id == 'branch':
2924
1981
            raise tests.TestNotApplicable(
2925
1982
                'branch.conf is *always* created when a branch is initialized')
2926
1983
        store = self.get_store(self)
2927
1984
        store.save()
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)
 
1985
        self.assertEquals(False, self.has_store(store))
2943
1986
 
2944
1987
    def test_save_emptied_succeeds(self):
2945
1988
        store = self.get_store(self)
2946
1989
        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)
2952
1990
        section = store.get_mutable_section(None)
2953
1991
        section.remove('foo')
2954
1992
        store.save()
2955
 
        self.assertEqual(True, self.has_store(store))
 
1993
        self.assertEquals(True, self.has_store(store))
2956
1994
        modified_store = self.get_store(self)
2957
1995
        sections = list(modified_store.get_sections())
2958
1996
        self.assertLength(0, sections)
2959
1997
 
2960
1998
    def test_save_with_content_succeeds(self):
2961
 
        # FIXME: There should be a better way than relying on the test
2962
 
        # parametrization to identify branch.conf -- vila 2011-0526
2963
 
        if self.store_id in ('branch', 'remote_branch'):
 
1999
        if self.store_id == 'branch':
2964
2000
            raise tests.TestNotApplicable(
2965
2001
                'branch.conf is *always* created when a branch is initialized')
2966
2002
        store = self.get_store(self)
2967
2003
        store._load_from_string('foo=bar\n')
2968
 
        self.assertEqual(False, self.has_store(store))
 
2004
        self.assertEquals(False, self.has_store(store))
2969
2005
        store.save()
2970
 
        self.assertEqual(True, self.has_store(store))
 
2006
        self.assertEquals(True, self.has_store(store))
2971
2007
        modified_store = self.get_store(self)
2972
2008
        sections = list(modified_store.get_sections())
2973
2009
        self.assertLength(1, sections)
2975
2011
 
2976
2012
    def test_set_option_in_empty_store(self):
2977
2013
        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)
2983
2014
        section = store.get_mutable_section(None)
2984
2015
        section.set('foo', 'bar')
2985
2016
        store.save()
2991
2022
    def test_set_option_in_default_section(self):
2992
2023
        store = self.get_store(self)
2993
2024
        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)
2999
2025
        section = store.get_mutable_section(None)
3000
2026
        section.set('foo', 'bar')
3001
2027
        store.save()
3007
2033
    def test_set_option_in_named_section(self):
3008
2034
        store = self.get_store(self)
3009
2035
        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)
3015
2036
        section = store.get_mutable_section('baz')
3016
2037
        section.set('foo', 'bar')
3017
2038
        store.save()
3020
2041
        self.assertLength(1, sections)
3021
2042
        self.assertSectionContent(('baz', {'foo': 'bar'}), sections[0])
3022
2043
 
3023
 
    def test_load_hook(self):
3024
 
        # First, we need to ensure that the store exists
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)
3031
 
        section = store.get_mutable_section('baz')
3032
 
        section.set('foo', 'bar')
3033
 
        store.save()
3034
 
        # Now we can try to load it
3035
 
        store = self.get_store(self)
3036
 
        calls = []
3037
 
        def hook(*args):
3038
 
            calls.append(args)
3039
 
        config.ConfigHooks.install_named_hook('load', hook, None)
3040
 
        self.assertLength(0, calls)
3041
 
        store.load()
3042
 
        self.assertLength(1, calls)
3043
 
        self.assertEqual((store,), calls[0])
3044
 
 
3045
 
    def test_save_hook(self):
3046
 
        calls = []
3047
 
        def hook(*args):
3048
 
            calls.append(args)
3049
 
        config.ConfigHooks.install_named_hook('save', hook, None)
3050
 
        self.assertLength(0, calls)
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)
3057
 
        section = store.get_mutable_section('baz')
3058
 
        section.set('foo', 'bar')
3059
 
        store.save()
3060
 
        self.assertLength(1, calls)
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):
 
2044
 
 
2045
class TestIniFileStore(TestStore):
3178
2046
 
3179
2047
    def test_loading_unknown_file_fails(self):
3180
 
        store = config.TransportIniFileStore(self.get_transport(),
3181
 
            'I-do-not-exist')
 
2048
        store = config.IniFileStore(self.get_transport(), 'I-do-not-exist')
3182
2049
        self.assertRaises(errors.NoSuchFile, store.load)
3183
2050
 
3184
2051
    def test_invalid_content(self):
3185
 
        store = config.TransportIniFileStore(self.get_transport(), 'foo.conf')
3186
 
        self.assertEqual(False, store.is_loaded())
 
2052
        store = config.IniFileStore(self.get_transport(), 'foo.conf', )
 
2053
        self.assertEquals(False, store.is_loaded())
3187
2054
        exc = self.assertRaises(
3188
2055
            errors.ParseConfigError, store._load_from_string,
3189
2056
            'this is invalid !')
3190
2057
        self.assertEndsWith(exc.filename, 'foo.conf')
3191
2058
        # And the load failed
3192
 
        self.assertEqual(False, store.is_loaded())
 
2059
        self.assertEquals(False, store.is_loaded())
3193
2060
 
3194
2061
    def test_get_embedded_sections(self):
3195
2062
        # A more complicated example (which also shows that section names and
3196
2063
        # option names share the same name space...)
3197
2064
        # FIXME: This should be fixed by forbidding dicts as values ?
3198
2065
        # -- vila 2011-04-05
3199
 
        store = config.TransportIniFileStore(self.get_transport(), 'foo.conf')
 
2066
        store = config.IniFileStore(self.get_transport(), 'foo.conf', )
3200
2067
        store._load_from_string('''
3201
2068
foo=bar
3202
2069
l=1,2
3212
2079
        sections = list(store.get_sections())
3213
2080
        self.assertLength(4, sections)
3214
2081
        # The default section has no name.
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'}),
 
2082
        # List values are provided as lists
 
2083
        self.assertSectionContent((None, {'foo': 'bar', 'l': ['1', '2']}),
3219
2084
                                  sections[0])
3220
2085
        self.assertSectionContent(
3221
2086
            ('DEFAULT', {'foo_in_DEFAULT': 'foo_DEFAULT'}), sections[1])
3230
2095
class TestLockableIniFileStore(TestStore):
3231
2096
 
3232
2097
    def test_create_store_in_created_dir(self):
3233
 
        self.assertPathDoesNotExist('dir')
3234
2098
        t = self.get_transport('dir/subdir')
3235
2099
        store = config.LockableIniFileStore(t, 'foo.conf')
3236
2100
        store.get_mutable_section(None).set('foo', 'bar')
3237
2101
        store.save()
3238
 
        self.assertPathExists('dir/subdir')
3239
 
 
3240
 
 
3241
 
class TestConcurrentStoreUpdates(TestStore):
3242
 
    """Test that Stores properly handle conccurent updates.
3243
 
 
3244
 
    New Store implementation may fail some of these tests but until such
3245
 
    implementations exist it's hard to properly filter them from the scenarios
3246
 
    applied here. If you encounter such a case, contact the bzr devs.
3247
 
    """
3248
 
 
3249
 
    scenarios = [(key, {'get_stack': builder}) for key, builder
3250
 
                 in config.test_stack_builder_registry.iteritems()]
3251
 
 
3252
 
    def setUp(self):
3253
 
        super(TestConcurrentStoreUpdates, self).setUp()
3254
 
        self.stack = self.get_stack(self)
3255
 
        if not isinstance(self.stack, config._CompatibleStack):
3256
 
            raise tests.TestNotApplicable(
3257
 
                '%s is not meant to be compatible with the old config design'
3258
 
                % (self.stack,))
3259
 
        self.stack.set('one', '1')
3260
 
        self.stack.set('two', '2')
3261
 
        # Flush the store
3262
 
        self.stack.store.save()
3263
 
 
3264
 
    def test_simple_read_access(self):
3265
 
        self.assertEqual('1', self.stack.get('one'))
3266
 
 
3267
 
    def test_simple_write_access(self):
3268
 
        self.stack.set('one', 'one')
3269
 
        self.assertEqual('one', self.stack.get('one'))
3270
 
 
3271
 
    def test_listen_to_the_last_speaker(self):
3272
 
        c1 = self.stack
3273
 
        c2 = self.get_stack(self)
3274
 
        c1.set('one', 'ONE')
3275
 
        c2.set('two', 'TWO')
3276
 
        self.assertEqual('ONE', c1.get('one'))
3277
 
        self.assertEqual('TWO', c2.get('two'))
3278
 
        # The second update respect the first one
3279
 
        self.assertEqual('ONE', c2.get('one'))
3280
 
 
3281
 
    def test_last_speaker_wins(self):
3282
 
        # If the same config is not shared, the same variable modified twice
3283
 
        # can only see a single result.
3284
 
        c1 = self.stack
3285
 
        c2 = self.get_stack(self)
3286
 
        c1.set('one', 'c1')
3287
 
        c2.set('one', 'c2')
3288
 
        self.assertEqual('c2', c2.get('one'))
3289
 
        # The first modification is still available until another refresh
3290
 
        # occur
3291
 
        self.assertEqual('c1', c1.get('one'))
3292
 
        c1.set('two', 'done')
3293
 
        self.assertEqual('c2', c1.get('one'))
3294
 
 
3295
 
    def test_writes_are_serialized(self):
3296
 
        c1 = self.stack
3297
 
        c2 = self.get_stack(self)
3298
 
 
3299
 
        # We spawn a thread that will pause *during* the config saving.
3300
 
        before_writing = threading.Event()
3301
 
        after_writing = threading.Event()
3302
 
        writing_done = threading.Event()
3303
 
        c1_save_without_locking_orig = c1.store.save_without_locking
3304
 
        def c1_save_without_locking():
3305
 
            before_writing.set()
3306
 
            c1_save_without_locking_orig()
3307
 
            # The lock is held. We wait for the main thread to decide when to
3308
 
            # continue
3309
 
            after_writing.wait()
3310
 
        c1.store.save_without_locking = c1_save_without_locking
3311
 
        def c1_set():
3312
 
            c1.set('one', 'c1')
3313
 
            writing_done.set()
3314
 
        t1 = threading.Thread(target=c1_set)
3315
 
        # Collect the thread after the test
3316
 
        self.addCleanup(t1.join)
3317
 
        # Be ready to unblock the thread if the test goes wrong
3318
 
        self.addCleanup(after_writing.set)
3319
 
        t1.start()
3320
 
        before_writing.wait()
3321
 
        self.assertRaises(errors.LockContention,
3322
 
                          c2.set, 'one', 'c2')
3323
 
        self.assertEqual('c1', c1.get('one'))
3324
 
        # Let the lock be released
3325
 
        after_writing.set()
3326
 
        writing_done.wait()
3327
 
        c2.set('one', 'c2')
3328
 
        self.assertEqual('c2', c2.get('one'))
3329
 
 
3330
 
    def test_read_while_writing(self):
3331
 
       c1 = self.stack
3332
 
       # We spawn a thread that will pause *during* the write
3333
 
       ready_to_write = threading.Event()
3334
 
       do_writing = threading.Event()
3335
 
       writing_done = threading.Event()
3336
 
       # We override the _save implementation so we know the store is locked
3337
 
       c1_save_without_locking_orig = c1.store.save_without_locking
3338
 
       def c1_save_without_locking():
3339
 
           ready_to_write.set()
3340
 
           # The lock is held. We wait for the main thread to decide when to
3341
 
           # continue
3342
 
           do_writing.wait()
3343
 
           c1_save_without_locking_orig()
3344
 
           writing_done.set()
3345
 
       c1.store.save_without_locking = c1_save_without_locking
3346
 
       def c1_set():
3347
 
           c1.set('one', 'c1')
3348
 
       t1 = threading.Thread(target=c1_set)
3349
 
       # Collect the thread after the test
3350
 
       self.addCleanup(t1.join)
3351
 
       # Be ready to unblock the thread if the test goes wrong
3352
 
       self.addCleanup(do_writing.set)
3353
 
       t1.start()
3354
 
       # Ensure the thread is ready to write
3355
 
       ready_to_write.wait()
3356
 
       self.assertEqual('c1', c1.get('one'))
3357
 
       # If we read during the write, we get the old value
3358
 
       c2 = self.get_stack(self)
3359
 
       self.assertEqual('1', c2.get('one'))
3360
 
       # Let the writing occur and ensure it occurred
3361
 
       do_writing.set()
3362
 
       writing_done.wait()
3363
 
       # Now we get the updated value
3364
 
       c3 = self.get_stack(self)
3365
 
       self.assertEqual('c1', c3.get('one'))
3366
 
 
3367
 
    # FIXME: It may be worth looking into removing the lock dir when it's not
3368
 
    # needed anymore and look at possible fallouts for concurrent lockers. This
3369
 
    # will matter if/when we use config files outside of bazaar directories
3370
 
    # (.bazaar or .bzr) -- vila 20110-04-111
 
2102
 
 
2103
    # FIXME: We should adapt the tests in TestLockableConfig about concurrent
 
2104
    # writes. Since this requires a clearer rewrite, I'll just rely on using
 
2105
    # the same code in LockableIniFileStore (copied from LockableConfig, but
 
2106
    # trivial enough, the main difference is that we add @needs_write_lock on
 
2107
    # save() instead of set_user_option() and remove_user_option()). The intent
 
2108
    # is to ensure that we always get a valid content for the store even when
 
2109
    # concurrent accesses occur, read/write, write/write. It may be worth
 
2110
    # looking into removing the lock dir when it;s not needed anymore and look
 
2111
    # at possible fallouts for concurrent lockers -- vila 20110-04-06
3371
2112
 
3372
2113
 
3373
2114
class TestSectionMatcher(TestStore):
3374
2115
 
3375
 
    scenarios = [('location', {'matcher': config.LocationMatcher}),
3376
 
                 ('id', {'matcher': config.NameMatcher}),]
 
2116
    scenarios = [('location', {'matcher': config.LocationMatcher})]
3377
2117
 
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')
 
2118
    def get_store(self, file_name):
 
2119
        return config.IniFileStore(self.get_readonly_transport(), file_name)
3382
2120
 
3383
2121
    def test_no_matches_for_empty_stores(self):
3384
 
        store = self.get_store(self)
 
2122
        store = self.get_store('foo.conf')
3385
2123
        store._load_from_string('')
3386
2124
        matcher = self.matcher(store, '/bar')
3387
 
        self.assertEqual([], list(matcher.get_sections()))
 
2125
        self.assertEquals([], list(matcher.get_sections()))
3388
2126
 
3389
2127
    def test_build_doesnt_load_store(self):
3390
 
        store = self.get_store(self)
3391
 
        self.matcher(store, '/bar')
 
2128
        store = self.get_store('foo.conf')
 
2129
        matcher = self.matcher(store, '/bar')
3392
2130
        self.assertFalse(store.is_loaded())
3393
2131
 
3394
2132
 
3396
2134
 
3397
2135
    def get_section(self, options, extra_path):
3398
2136
        section = config.Section('foo', options)
3399
 
        return config.LocationSection(section, extra_path)
 
2137
        # We don't care about the length so we use '0'
 
2138
        return config.LocationSection(section, 0, extra_path)
3400
2139
 
3401
2140
    def test_simple_option(self):
3402
2141
        section = self.get_section({'foo': 'bar'}, '')
3403
 
        self.assertEqual('bar', section.get('foo'))
 
2142
        self.assertEquals('bar', section.get('foo'))
3404
2143
 
3405
2144
    def test_option_with_extra_path(self):
3406
2145
        section = self.get_section({'foo': 'bar', 'foo:policy': 'appendpath'},
3407
2146
                                   'baz')
3408
 
        self.assertEqual('bar/baz', section.get('foo'))
 
2147
        self.assertEquals('bar/baz', section.get('foo'))
3409
2148
 
3410
2149
    def test_invalid_policy(self):
3411
2150
        section = self.get_section({'foo': 'bar', 'foo:policy': 'die'},
3412
2151
                                   'baz')
3413
2152
        # invalid policies are ignored
3414
 
        self.assertEqual('bar', section.get('foo'))
 
2153
        self.assertEquals('bar', section.get('foo'))
3415
2154
 
3416
2155
 
3417
2156
class TestLocationMatcher(TestStore):
3418
2157
 
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])
 
2158
    def get_store(self, file_name):
 
2159
        return config.IniFileStore(self.get_readonly_transport(), file_name)
3447
2160
 
3448
2161
    def test_more_specific_sections_first(self):
3449
 
        store = self.get_store(self)
 
2162
        store = self.get_store('foo.conf')
3450
2163
        store._load_from_string('''
3451
2164
[/foo]
3452
2165
section=/foo
3453
2166
[/foo/bar]
3454
2167
section=/foo/bar
3455
2168
''')
3456
 
        self.assertEqual(['/foo', '/foo/bar'],
3457
 
                          [section.id for _, section in store.get_sections()])
 
2169
        self.assertEquals(['/foo', '/foo/bar'],
 
2170
                          [section.id for section in store.get_sections()])
3458
2171
        matcher = config.LocationMatcher(store, '/foo/bar/baz')
3459
 
        sections = [section for _, section in matcher.get_sections()]
3460
 
        self.assertEqual(['/foo/bar', '/foo'],
 
2172
        sections = list(matcher.get_sections())
 
2173
        self.assertEquals([3, 2],
 
2174
                          [section.length for section in sections])
 
2175
        self.assertEquals(['/foo/bar', '/foo'],
3461
2176
                          [section.id for section in sections])
3462
 
        self.assertEqual(['baz', 'bar/baz'],
 
2177
        self.assertEquals(['baz', 'bar/baz'],
3463
2178
                          [section.extra_path for section in sections])
3464
2179
 
3465
 
    def test_appendpath_in_no_name_section(self):
3466
 
        # It's a bit weird to allow appendpath in a no-name section, but
3467
 
        # someone may found a use for it
3468
 
        store = self.get_store(self)
3469
 
        store._load_from_string('''
3470
 
foo=bar
3471
 
foo:policy = appendpath
3472
 
''')
3473
 
        matcher = config.LocationMatcher(store, 'dir/subdir')
3474
 
        sections = list(matcher.get_sections())
3475
 
        self.assertLength(1, sections)
3476
 
        self.assertEqual('bar/dir/subdir', sections[0][1].get('foo'))
3477
 
 
3478
 
    def test_file_urls_are_normalized(self):
3479
 
        store = self.get_store(self)
3480
 
        if sys.platform == 'win32':
3481
 
            expected_url = 'file:///C:/dir/subdir'
3482
 
            expected_location = 'C:/dir/subdir'
3483
 
        else:
3484
 
            expected_url = 'file:///dir/subdir'
3485
 
            expected_location = '/dir/subdir'
3486
 
        matcher = config.LocationMatcher(store, expected_url)
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()
3631
 
        self.overrideAttr(config, 'option_registry', config.OptionRegistry())
 
2180
 
 
2181
 
 
2182
class TestStackGet(tests.TestCase):
 
2183
 
 
2184
    # FIXME: This should be parametrized for all known Stack or dedicated
 
2185
    # paramerized tests created to avoid bloating -- vila 2011-03-31
 
2186
 
 
2187
    def test_single_config_get(self):
 
2188
        conf = dict(foo='bar')
 
2189
        conf_stack = config.Stack([conf])
 
2190
        self.assertEquals('bar', conf_stack.get('foo'))
3632
2191
 
3633
2192
    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'))
3640
 
 
3641
 
    def test_get_with_registered_default_value(self):
3642
 
        config.option_registry.register(config.Option('foo', default='bar'))
3643
 
        conf_stack = config.Stack([])
3644
 
        self.assertEqual('bar', conf_stack.get('foo'))
3645
 
 
3646
 
    def test_get_without_registered_default_value(self):
3647
 
        config.option_registry.register(config.Option('foo'))
3648
 
        conf_stack = config.Stack([])
3649
 
        self.assertEqual(None, conf_stack.get('foo'))
3650
 
 
3651
 
    def test_get_without_default_value_for_not_registered(self):
3652
 
        conf_stack = config.Stack([])
3653
 
        self.assertEqual(None, conf_stack.get('foo'))
 
2193
        conf1 = dict(foo='bar')
 
2194
        conf2 = dict(foo='baz')
 
2195
        conf_stack = config.Stack([conf1, conf2])
 
2196
        self.assertEquals('bar', conf_stack.get('foo'))
 
2197
 
 
2198
    def test_get_embedded_definition(self):
 
2199
        conf1 = dict(yy='12')
 
2200
        conf2 = config.Stack([dict(xx='42'), dict(foo='baz')])
 
2201
        conf_stack = config.Stack([conf1, conf2])
 
2202
        self.assertEquals('baz', conf_stack.get('foo'))
 
2203
 
 
2204
    def test_get_for_empty_stack(self):
 
2205
        conf_stack = config.Stack([])
 
2206
        self.assertEquals(None, conf_stack.get('foo'))
3654
2207
 
3655
2208
    def test_get_for_empty_section_callable(self):
3656
2209
        conf_stack = config.Stack([lambda : []])
3657
 
        self.assertEqual(None, conf_stack.get('foo'))
 
2210
        self.assertEquals(None, conf_stack.get('foo'))
3658
2211
 
3659
2212
    def test_get_for_broken_callable(self):
3660
2213
        # Trying to use and invalid callable raises an exception on first use
3661
 
        conf_stack = config.Stack([object])
 
2214
        conf_stack = config.Stack([lambda : object()])
3662
2215
        self.assertRaises(TypeError, conf_stack.get, 'foo')
3663
2216
 
3664
2217
 
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
 
 
3754
 
class TestStackWithTransport(tests.TestCaseWithTransport):
3755
 
 
3756
 
    scenarios = [(key, {'get_stack': builder}) for key, builder
3757
 
                 in config.test_stack_builder_registry.iteritems()]
3758
 
 
3759
 
 
3760
 
class TestConcreteStacks(TestStackWithTransport):
3761
 
 
3762
 
    def test_build_stack(self):
3763
 
        # Just a smoke test to help debug builders
3764
 
        self.get_stack(self)
3765
 
 
3766
 
 
3767
 
class TestStackGet(TestStackWithTransport):
3768
 
 
3769
 
    def setUp(self):
3770
 
        super(TestStackGet, self).setUp()
3771
 
        self.conf = self.get_stack(self)
3772
 
 
3773
 
    def test_get_for_empty_stack(self):
3774
 
        self.assertEqual(None, self.conf.get('foo'))
3775
 
 
3776
 
    def test_get_hook(self):
3777
 
        self.conf.set('foo', 'bar')
3778
 
        calls = []
3779
 
        def hook(*args):
3780
 
            calls.append(args)
3781
 
        config.ConfigHooks.install_named_hook('get', hook, None)
3782
 
        self.assertLength(0, calls)
3783
 
        value = self.conf.get('foo')
3784
 
        self.assertEqual('bar', value)
3785
 
        self.assertLength(1, calls)
3786
 
        self.assertEqual((self.conf, 'foo', 'bar'), calls[0])
3787
 
 
3788
 
 
3789
 
class TestStackGetWithConverter(tests.TestCase):
3790
 
 
3791
 
    def setUp(self):
3792
 
        super(TestStackGetWithConverter, self).setUp()
3793
 
        self.overrideAttr(config, 'option_registry', config.OptionRegistry())
3794
 
        self.registry = config.option_registry
3795
 
 
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)
3803
 
        self.registry.register(b)
3804
 
 
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,
3840
 
                          from_unicode=config.int_from_store)
3841
 
        self.registry.register(i)
3842
 
 
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)
3872
 
        self.registry.register(l)
3873
 
 
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'))
3889
 
 
3890
 
    def test_get_with_list_converter_no_item(self):
3891
 
        self.register_list_option('foo', None)
3892
 
        conf = self.get_conf('foo=,')
3893
 
        self.assertEqual([], conf.get('foo'))
3894
 
 
3895
 
    def test_get_with_list_converter_many_items(self):
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
 
 
4217
 
 
4218
 
 
4219
 
class TestStackSet(TestStackWithTransport):
 
2218
class TestStackSet(tests.TestCaseWithTransport):
 
2219
 
 
2220
    # FIXME: This should be parametrized for all known Stack or dedicated
 
2221
    # paramerized tests created to avoid bloating -- vila 2011-04-05
4220
2222
 
4221
2223
    def test_simple_set(self):
4222
 
        conf = self.get_stack(self)
4223
 
        self.assertEqual(None, conf.get('foo'))
 
2224
        store = config.IniFileStore(self.get_transport(), 'test.conf')
 
2225
        store._load_from_string('foo=bar')
 
2226
        conf = config.Stack([store.get_sections], store)
 
2227
        self.assertEquals('bar', conf.get('foo'))
4224
2228
        conf.set('foo', 'baz')
4225
2229
        # Did we get it back ?
4226
 
        self.assertEqual('baz', conf.get('foo'))
 
2230
        self.assertEquals('baz', conf.get('foo'))
4227
2231
 
4228
2232
    def test_set_creates_a_new_section(self):
4229
 
        conf = self.get_stack(self)
 
2233
        store = config.IniFileStore(self.get_transport(), 'test.conf')
 
2234
        conf = config.Stack([store.get_sections], store)
4230
2235
        conf.set('foo', 'baz')
4231
 
        self.assertEqual, 'baz', conf.get('foo')
4232
 
 
4233
 
    def test_set_hook(self):
4234
 
        calls = []
4235
 
        def hook(*args):
4236
 
            calls.append(args)
4237
 
        config.ConfigHooks.install_named_hook('set', hook, None)
4238
 
        self.assertLength(0, calls)
4239
 
        conf = self.get_stack(self)
4240
 
        conf.set('foo', 'bar')
4241
 
        self.assertLength(1, calls)
4242
 
        self.assertEqual((conf, 'foo', 'bar'), calls[0])
4243
 
 
4244
 
 
4245
 
class TestStackRemove(TestStackWithTransport):
 
2236
        self.assertEquals, 'baz', conf.get('foo')
 
2237
 
 
2238
 
 
2239
class TestStackRemove(tests.TestCaseWithTransport):
 
2240
 
 
2241
    # FIXME: This should be parametrized for all known Stack or dedicated
 
2242
    # paramerized tests created to avoid bloating -- vila 2011-04-06
4246
2243
 
4247
2244
    def test_remove_existing(self):
4248
 
        conf = self.get_stack(self)
4249
 
        conf.set('foo', 'bar')
4250
 
        self.assertEqual('bar', conf.get('foo'))
 
2245
        store = config.IniFileStore(self.get_transport(), 'test.conf')
 
2246
        store._load_from_string('foo=bar')
 
2247
        conf = config.Stack([store.get_sections], store)
 
2248
        self.assertEquals('bar', conf.get('foo'))
4251
2249
        conf.remove('foo')
4252
2250
        # Did we get it back ?
4253
 
        self.assertEqual(None, conf.get('foo'))
 
2251
        self.assertEquals(None, conf.get('foo'))
4254
2252
 
4255
2253
    def test_remove_unknown(self):
4256
 
        conf = self.get_stack(self)
 
2254
        store = config.IniFileStore(self.get_transport(), 'test.conf')
 
2255
        conf = config.Stack([store.get_sections], store)
4257
2256
        self.assertRaises(KeyError, conf.remove, 'I_do_not_exist')
4258
2257
 
4259
 
    def test_remove_hook(self):
4260
 
        calls = []
4261
 
        def hook(*args):
4262
 
            calls.append(args)
4263
 
        config.ConfigHooks.install_named_hook('remove', hook, None)
4264
 
        self.assertLength(0, calls)
4265
 
        conf = self.get_stack(self)
4266
 
        conf.set('foo', 'bar')
4267
 
        conf.remove('foo')
4268
 
        self.assertLength(1, calls)
4269
 
        self.assertEqual((conf, 'foo'), calls[0])
4270
 
 
4271
2258
 
4272
2259
class TestConfigGetOptions(tests.TestCaseWithTransport, TestOptionsMixin):
4273
2260
 
4370
2357
        """
4371
2358
        sections = list(conf._get_sections(name))
4372
2359
        self.assertLength(len(expected), sections)
4373
 
        self.assertEqual(expected, [n for n, _, _ in sections])
 
2360
        self.assertEqual(expected, [name for name, _, _ in sections])
4374
2361
 
4375
2362
    def test_bazaar_default_section(self):
4376
2363
        self.assertSectionNames(['DEFAULT'], self.bazaar_config)
4420
2407
        self.assertSectionNames(['ALIASES'], self.bazaar_config, 'ALIASES')
4421
2408
 
4422
2409
 
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
 
 
4432
2410
class TestAuthenticationConfigFile(tests.TestCase):
4433
2411
    """Test the authentication.conf file matching"""
4434
2412
 
4441
2419
        else:
4442
2420
            user = credentials['user']
4443
2421
            password = credentials['password']
4444
 
        self.assertEqual(expected_user, user)
4445
 
        self.assertEqual(expected_password, password)
 
2422
        self.assertEquals(expected_user, user)
 
2423
        self.assertEquals(expected_password, password)
4446
2424
 
4447
2425
    def test_empty_config(self):
4448
2426
        conf = config.AuthenticationConfig(_file=StringIO())
4449
 
        self.assertEqual({}, conf._get_config())
 
2427
        self.assertEquals({}, conf._get_config())
4450
2428
        self._got_user_passwd(None, None, conf, 'http', 'foo.net')
4451
2429
 
4452
 
    def test_non_utf8_config(self):
4453
 
        conf = config.AuthenticationConfig(_file=StringIO(
4454
 
                'foo = bar\xff'))
4455
 
        self.assertRaises(errors.ConfigContentError, conf._get_config)
4456
 
 
4457
2430
    def test_missing_auth_section_header(self):
4458
2431
        conf = config.AuthenticationConfig(_file=StringIO('foo = bar'))
4459
2432
        self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
4634
2607
password=bendover
4635
2608
"""))
4636
2609
        credentials = conf.get_credentials('https', 'bar.org')
4637
 
        self.assertEqual(False, credentials.get('verify_certificates'))
 
2610
        self.assertEquals(False, credentials.get('verify_certificates'))
4638
2611
        credentials = conf.get_credentials('https', 'foo.net')
4639
 
        self.assertEqual(True, credentials.get('verify_certificates'))
 
2612
        self.assertEquals(True, credentials.get('verify_certificates'))
4640
2613
 
4641
2614
 
4642
2615
class TestAuthenticationStorage(tests.TestCaseInTempDir):
4649
2622
                                           port=99, path='/foo',
4650
2623
                                           realm='realm')
4651
2624
        CREDENTIALS = {'name': 'name', 'user': 'user', 'password': 'password',
4652
 
                       'verify_certificates': False, 'scheme': 'scheme',
4653
 
                       'host': 'host', 'port': 99, 'path': '/foo',
 
2625
                       'verify_certificates': False, 'scheme': 'scheme', 
 
2626
                       'host': 'host', 'port': 99, 'path': '/foo', 
4654
2627
                       'realm': 'realm'}
4655
2628
        self.assertEqual(CREDENTIALS, credentials)
4656
2629
        credentials_from_disk = config.AuthenticationConfig().get_credentials(
4664
2637
        self.assertIs(None, conf._get_config().get('name'))
4665
2638
        credentials = conf.get_credentials(host='host', scheme='scheme')
4666
2639
        CREDENTIALS = {'name': 'name2', 'user': 'user2', 'password':
4667
 
                       'password', 'verify_certificates': True,
4668
 
                       'scheme': 'scheme', 'host': 'host', 'port': None,
 
2640
                       'password', 'verify_certificates': True, 
 
2641
                       'scheme': 'scheme', 'host': 'host', 'port': None, 
4669
2642
                       'path': None, 'realm': None}
4670
2643
        self.assertEqual(CREDENTIALS, credentials)
4671
2644
 
4689
2662
                                            stdout=stdout, stderr=stderr)
4690
2663
        # We use an empty conf so that the user is always prompted
4691
2664
        conf = config.AuthenticationConfig()
4692
 
        self.assertEqual(password,
 
2665
        self.assertEquals(password,
4693
2666
                          conf.get_password(scheme, host, user, port=port,
4694
2667
                                            realm=realm, path=path))
4695
 
        self.assertEqual(expected_prompt, stderr.getvalue())
4696
 
        self.assertEqual('', stdout.getvalue())
 
2668
        self.assertEquals(expected_prompt, stderr.getvalue())
 
2669
        self.assertEquals('', stdout.getvalue())
4697
2670
 
4698
2671
    def _check_default_username_prompt(self, expected_prompt_format, scheme,
4699
2672
                                       host=None, port=None, realm=None,
4710
2683
                                            stdout=stdout, stderr=stderr)
4711
2684
        # We use an empty conf so that the user is always prompted
4712
2685
        conf = config.AuthenticationConfig()
4713
 
        self.assertEqual(username, conf.get_user(scheme, host, port=port,
 
2686
        self.assertEquals(username, conf.get_user(scheme, host, port=port,
4714
2687
                          realm=realm, path=path, ask=True))
4715
 
        self.assertEqual(expected_prompt, stderr.getvalue())
4716
 
        self.assertEqual('', stdout.getvalue())
 
2688
        self.assertEquals(expected_prompt, stderr.getvalue())
 
2689
        self.assertEquals('', stdout.getvalue())
4717
2690
 
4718
2691
    def test_username_defaults_prompts(self):
4719
2692
        # HTTP prompts can't be tested here, see test_http.py
4720
 
        self._check_default_username_prompt(u'FTP %(host)s username: ', 'ftp')
4721
 
        self._check_default_username_prompt(
4722
 
            u'FTP %(host)s:%(port)d username: ', 'ftp', port=10020)
4723
 
        self._check_default_username_prompt(
4724
 
            u'SSH %(host)s:%(port)d username: ', 'ssh', port=12345)
 
2693
        self._check_default_username_prompt('FTP %(host)s username: ', 'ftp')
 
2694
        self._check_default_username_prompt(
 
2695
            'FTP %(host)s:%(port)d username: ', 'ftp', port=10020)
 
2696
        self._check_default_username_prompt(
 
2697
            'SSH %(host)s:%(port)d username: ', 'ssh', port=12345)
4725
2698
 
4726
2699
    def test_username_default_no_prompt(self):
4727
2700
        conf = config.AuthenticationConfig()
4728
 
        self.assertEqual(None,
 
2701
        self.assertEquals(None,
4729
2702
            conf.get_user('ftp', 'example.com'))
4730
 
        self.assertEqual("explicitdefault",
 
2703
        self.assertEquals("explicitdefault",
4731
2704
            conf.get_user('ftp', 'example.com', default="explicitdefault"))
4732
2705
 
4733
2706
    def test_password_default_prompts(self):
4734
2707
        # HTTP prompts can't be tested here, see test_http.py
4735
2708
        self._check_default_password_prompt(
4736
 
            u'FTP %(user)s@%(host)s password: ', 'ftp')
4737
 
        self._check_default_password_prompt(
4738
 
            u'FTP %(user)s@%(host)s:%(port)d password: ', 'ftp', port=10020)
4739
 
        self._check_default_password_prompt(
4740
 
            u'SSH %(user)s@%(host)s:%(port)d password: ', 'ssh', port=12345)
 
2709
            'FTP %(user)s@%(host)s password: ', 'ftp')
 
2710
        self._check_default_password_prompt(
 
2711
            'FTP %(user)s@%(host)s:%(port)d password: ', 'ftp', port=10020)
 
2712
        self._check_default_password_prompt(
 
2713
            'SSH %(user)s@%(host)s:%(port)d password: ', 'ssh', port=12345)
4741
2714
        # SMTP port handling is a bit special (it's handled if embedded in the
4742
2715
        # host too)
4743
2716
        # FIXME: should we: forbid that, extend it to other schemes, leave
4744
2717
        # things as they are that's fine thank you ?
4745
 
        self._check_default_password_prompt(
4746
 
            u'SMTP %(user)s@%(host)s password: ', 'smtp')
4747
 
        self._check_default_password_prompt(
4748
 
            u'SMTP %(user)s@%(host)s password: ', 'smtp', host='bar.org:10025')
4749
 
        self._check_default_password_prompt(
4750
 
            u'SMTP %(user)s@%(host)s:%(port)d password: ', 'smtp', port=10025)
 
2718
        self._check_default_password_prompt('SMTP %(user)s@%(host)s password: ',
 
2719
                                            'smtp')
 
2720
        self._check_default_password_prompt('SMTP %(user)s@%(host)s password: ',
 
2721
                                            'smtp', host='bar.org:10025')
 
2722
        self._check_default_password_prompt(
 
2723
            'SMTP %(user)s@%(host)s:%(port)d password: ',
 
2724
            'smtp', port=10025)
4751
2725
 
4752
2726
    def test_ssh_password_emits_warning(self):
4753
2727
        conf = config.AuthenticationConfig(_file=StringIO(
4766
2740
 
4767
2741
        # Since the password defined in the authentication config is ignored,
4768
2742
        # the user is prompted
4769
 
        self.assertEqual(entered_password,
 
2743
        self.assertEquals(entered_password,
4770
2744
                          conf.get_password('ssh', 'bar.org', user='jim'))
4771
2745
        self.assertContainsRe(
4772
2746
            self.get_log(),
4789
2763
 
4790
2764
        # Since the password defined in the authentication config is ignored,
4791
2765
        # the user is prompted
4792
 
        self.assertEqual(entered_password,
 
2766
        self.assertEquals(entered_password,
4793
2767
                          conf.get_password('ssh', 'bar.org', user='jim'))
4794
2768
        # No warning shoud be emitted since there is no password. We are only
4795
2769
        # providing "user".
4805
2779
        config.credential_store_registry.register("stub", store, fallback=True)
4806
2780
        conf = config.AuthenticationConfig(_file=StringIO())
4807
2781
        creds = conf.get_credentials("http", "example.com")
4808
 
        self.assertEqual("joe", creds["user"])
4809
 
        self.assertEqual("secret", creds["password"])
 
2782
        self.assertEquals("joe", creds["user"])
 
2783
        self.assertEquals("secret", creds["password"])
4810
2784
 
4811
2785
 
4812
2786
class StubCredentialStore(config.CredentialStore):
4857
2831
 
4858
2832
    def test_fallback_none_registered(self):
4859
2833
        r = config.CredentialStoreRegistry()
4860
 
        self.assertEqual(None,
 
2834
        self.assertEquals(None,
4861
2835
                          r.get_fallback_credentials("http", "example.com"))
4862
2836
 
4863
2837
    def test_register(self):
4864
2838
        r = config.CredentialStoreRegistry()
4865
2839
        r.register("stub", StubCredentialStore(), fallback=False)
4866
2840
        r.register("another", StubCredentialStore(), fallback=True)
4867
 
        self.assertEqual(["another", "stub"], r.keys())
 
2841
        self.assertEquals(["another", "stub"], r.keys())
4868
2842
 
4869
2843
    def test_register_lazy(self):
4870
2844
        r = config.CredentialStoreRegistry()
4871
2845
        r.register_lazy("stub", "bzrlib.tests.test_config",
4872
2846
                        "StubCredentialStore", fallback=False)
4873
 
        self.assertEqual(["stub"], r.keys())
 
2847
        self.assertEquals(["stub"], r.keys())
4874
2848
        self.assertIsInstance(r.get_credential_store("stub"),
4875
2849
                              StubCredentialStore)
4876
2850
 
4878
2852
        r = config.CredentialStoreRegistry()
4879
2853
        r.register("stub1", None, fallback=False)
4880
2854
        r.register("stub2", None, fallback=True)
4881
 
        self.assertEqual(False, r.is_fallback("stub1"))
4882
 
        self.assertEqual(True, r.is_fallback("stub2"))
 
2855
        self.assertEquals(False, r.is_fallback("stub1"))
 
2856
        self.assertEquals(True, r.is_fallback("stub2"))
4883
2857
 
4884
2858
    def test_no_fallback(self):
4885
2859
        r = config.CredentialStoreRegistry()
4886
2860
        store = CountingCredentialStore()
4887
2861
        r.register("count", store, fallback=False)
4888
 
        self.assertEqual(None,
 
2862
        self.assertEquals(None,
4889
2863
                          r.get_fallback_credentials("http", "example.com"))
4890
 
        self.assertEqual(0, store._calls)
 
2864
        self.assertEquals(0, store._calls)
4891
2865
 
4892
2866
    def test_fallback_credentials(self):
4893
2867
        r = config.CredentialStoreRegistry()
4896
2870
                              "somebody", "geheim")
4897
2871
        r.register("stub", store, fallback=True)
4898
2872
        creds = r.get_fallback_credentials("http", "example.com")
4899
 
        self.assertEqual("somebody", creds["user"])
4900
 
        self.assertEqual("geheim", creds["password"])
 
2873
        self.assertEquals("somebody", creds["user"])
 
2874
        self.assertEquals("geheim", creds["password"])
4901
2875
 
4902
2876
    def test_fallback_first_wins(self):
4903
2877
        r = config.CredentialStoreRegistry()
4910
2884
                              "somebody", "stub2")
4911
2885
        r.register("stub2", stub1, fallback=True)
4912
2886
        creds = r.get_fallback_credentials("http", "example.com")
4913
 
        self.assertEqual("somebody", creds["user"])
4914
 
        self.assertEqual("stub1", creds["password"])
 
2887
        self.assertEquals("somebody", creds["user"])
 
2888
        self.assertEquals("stub1", creds["password"])
4915
2889
 
4916
2890
 
4917
2891
class TestPlainTextCredentialStore(tests.TestCase):
4920
2894
        r = config.credential_store_registry
4921
2895
        plain_text = r.get_credential_store()
4922
2896
        decoded = plain_text.decode_password(dict(password='secret'))
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)
 
2897
        self.assertEquals('secret', decoded)
4933
2898
 
4934
2899
 
4935
2900
# FIXME: Once we have a way to declare authentication to all test servers, we
4949
2914
 
4950
2915
    def test_auto_user_id(self):
4951
2916
        """Automatic inference of user name.
4952
 
 
 
2917
        
4953
2918
        This is a bit hard to test in an isolated way, because it depends on
4954
2919
        system functions that go direct to /etc or perhaps somewhere else.
4955
2920
        But it's reasonable to say that on Unix, with an /etc/mailname, we ought
4956
2921
        to be able to choose a user name with no configuration.
4957
2922
        """
4958
2923
        if sys.platform == 'win32':
4959
 
            raise tests.TestSkipped(
4960
 
                "User name inference not implemented on win32")
 
2924
            raise TestSkipped("User name inference not implemented on win32")
4961
2925
        realname, address = config._auto_user_id()
4962
2926
        if os.path.exists('/etc/mailname'):
4963
2927
            self.assertIsNot(None, realname)
4964
2928
            self.assertIsNot(None, address)
4965
2929
        else:
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')
 
2930
            self.assertEquals((None, None), (realname, address))
 
2931