259
532
def test_post_commit_default(self):
260
533
my_config = config.Config()
261
self.assertEqual(None, my_config.post_commit())
534
self.assertEqual(None, self.applyDeprecated(deprecated_in((2, 5, 0)),
535
my_config.post_commit))
263
538
def test_log_format_default(self):
264
539
my_config = config.Config()
265
540
self.assertEqual('long', my_config.log_format())
268
class TestConfigPath(TestCase):
542
def test_acceptable_keys_default(self):
543
my_config = config.Config()
544
self.assertEqual(None, self.applyDeprecated(deprecated_in((2, 5, 0)),
545
my_config.acceptable_keys))
547
def test_validate_signatures_in_log_default(self):
548
my_config = config.Config()
549
self.assertEqual(False, my_config.validate_signatures_in_log())
551
def test_get_change_editor(self):
552
my_config = InstrumentedConfig()
553
change_editor = my_config.get_change_editor('old_tree', 'new_tree')
554
self.assertEqual(['_get_change_editor'], my_config._calls)
555
self.assertIs(diff.DiffFromTool, change_editor.__class__)
556
self.assertEqual(['vimdiff', '-fo', '@new_path', '@old_path'],
557
change_editor.command_template)
560
class TestConfigPath(tests.TestCase):
271
563
super(TestConfigPath, self).setUp()
272
self.old_home = os.environ.get('HOME', None)
273
self.old_appdata = os.environ.get('APPDATA', None)
274
os.environ['HOME'] = '/home/bogus'
275
os.environ['APPDATA'] = \
276
r'C:\Documents and Settings\bogus\Application Data'
564
self.overrideEnv('HOME', '/home/bogus')
565
self.overrideEnv('XDG_CACHE_DIR', '')
566
if sys.platform == 'win32':
568
'BZR_HOME', r'C:\Documents and Settings\bogus\Application Data')
570
'C:/Documents and Settings/bogus/Application Data/bazaar/2.0'
572
self.bzr_home = '/home/bogus/.bazaar'
279
if self.old_home is None:
280
del os.environ['HOME']
282
os.environ['HOME'] = self.old_home
283
if self.old_appdata is None:
284
del os.environ['APPDATA']
286
os.environ['APPDATA'] = self.old_appdata
287
super(TestConfigPath, self).tearDown()
289
574
def test_config_dir(self):
290
if sys.platform == 'win32':
291
self.assertEqual(config.config_dir(),
292
'C:/Documents and Settings/bogus/Application Data/bazaar/2.0')
294
self.assertEqual(config.config_dir(), '/home/bogus/.bazaar')
575
self.assertEqual(config.config_dir(), self.bzr_home)
296
577
def test_config_filename(self):
297
if sys.platform == 'win32':
298
self.assertEqual(config.config_filename(),
299
'C:/Documents and Settings/bogus/Application Data/bazaar/2.0/bazaar.conf')
301
self.assertEqual(config.config_filename(),
302
'/home/bogus/.bazaar/bazaar.conf')
304
def test_branches_config_filename(self):
305
if sys.platform == 'win32':
306
self.assertEqual(config.branches_config_filename(),
307
'C:/Documents and Settings/bogus/Application Data/bazaar/2.0/branches.conf')
309
self.assertEqual(config.branches_config_filename(),
310
'/home/bogus/.bazaar/branches.conf')
578
self.assertEqual(config.config_filename(),
579
self.bzr_home + '/bazaar.conf')
312
581
def test_locations_config_filename(self):
313
if sys.platform == 'win32':
314
self.assertEqual(config.locations_config_filename(),
315
'C:/Documents and Settings/bogus/Application Data/bazaar/2.0/locations.conf')
317
self.assertEqual(config.locations_config_filename(),
318
'/home/bogus/.bazaar/locations.conf')
320
class TestIniConfig(TestCase):
582
self.assertEqual(config.locations_config_filename(),
583
self.bzr_home + '/locations.conf')
585
def test_authentication_config_filename(self):
586
self.assertEqual(config.authentication_config_filename(),
587
self.bzr_home + '/authentication.conf')
589
def test_xdg_cache_dir(self):
590
self.assertEqual(config.xdg_cache_dir(),
591
'/home/bogus/.cache')
594
class TestXDGConfigDir(tests.TestCaseInTempDir):
595
# must be in temp dir because config tests for the existence of the bazaar
596
# subdirectory of $XDG_CONFIG_HOME
599
if sys.platform in ('darwin', 'win32'):
600
raise tests.TestNotApplicable(
601
'XDG config dir not used on this platform')
602
super(TestXDGConfigDir, self).setUp()
603
self.overrideEnv('HOME', self.test_home_dir)
604
# BZR_HOME overrides everything we want to test so unset it.
605
self.overrideEnv('BZR_HOME', None)
607
def test_xdg_config_dir_exists(self):
608
"""When ~/.config/bazaar exists, use it as the config dir."""
609
newdir = osutils.pathjoin(self.test_home_dir, '.config', 'bazaar')
611
self.assertEqual(config.config_dir(), newdir)
613
def test_xdg_config_home(self):
614
"""When XDG_CONFIG_HOME is set, use it."""
615
xdgconfigdir = osutils.pathjoin(self.test_home_dir, 'xdgconfig')
616
self.overrideEnv('XDG_CONFIG_HOME', xdgconfigdir)
617
newdir = osutils.pathjoin(xdgconfigdir, 'bazaar')
619
self.assertEqual(config.config_dir(), newdir)
622
class TestIniConfig(tests.TestCaseInTempDir):
624
def make_config_parser(self, s):
625
conf = config.IniBasedConfig.from_string(s)
626
return conf, conf._get_parser()
629
class TestIniConfigBuilding(TestIniConfig):
322
631
def test_contructs(self):
323
my_config = config.IniBasedConfig("nothing")
632
my_config = config.IniBasedConfig()
325
634
def test_from_fp(self):
326
config_file = StringIO(sample_config_text.encode('utf-8'))
327
my_config = config.IniBasedConfig(None)
329
isinstance(my_config._get_parser(file=config_file),
635
my_config = config.IniBasedConfig.from_string(sample_config_text)
636
self.assertIsInstance(my_config._get_parser(), configobj.ConfigObj)
332
638
def test_cached(self):
639
my_config = config.IniBasedConfig.from_string(sample_config_text)
640
parser = my_config._get_parser()
641
self.assertTrue(my_config._get_parser() is parser)
643
def _dummy_chown(self, path, uid, gid):
644
self.path, self.uid, self.gid = path, uid, gid
646
def test_ini_config_ownership(self):
647
"""Ensure that chown is happening during _write_config_file"""
648
self.requireFeature(features.chown_feature)
649
self.overrideAttr(os, 'chown', self._dummy_chown)
650
self.path = self.uid = self.gid = None
651
conf = config.IniBasedConfig(file_name='./foo.conf')
652
conf._write_config_file()
653
self.assertEquals(self.path, './foo.conf')
654
self.assertTrue(isinstance(self.uid, int))
655
self.assertTrue(isinstance(self.gid, int))
657
def test_get_filename_parameter_is_deprecated_(self):
658
conf = self.callDeprecated([
659
'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
660
' Use file_name instead.'],
661
config.IniBasedConfig, lambda: 'ini.conf')
662
self.assertEqual('ini.conf', conf.file_name)
664
def test_get_parser_file_parameter_is_deprecated_(self):
333
665
config_file = StringIO(sample_config_text.encode('utf-8'))
334
my_config = config.IniBasedConfig(None)
335
parser = my_config._get_parser(file=config_file)
336
self.failUnless(my_config._get_parser() is parser)
339
class TestGetConfig(TestCase):
666
conf = config.IniBasedConfig.from_string(sample_config_text)
667
conf = self.callDeprecated([
668
'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
669
' Use IniBasedConfig(_content=xxx) instead.'],
670
conf._get_parser, file=config_file)
673
class TestIniConfigSaving(tests.TestCaseInTempDir):
675
def test_cant_save_without_a_file_name(self):
676
conf = config.IniBasedConfig()
677
self.assertRaises(AssertionError, conf._write_config_file)
679
def test_saved_with_content(self):
680
content = 'foo = bar\n'
681
conf = config.IniBasedConfig.from_string(
682
content, file_name='./test.conf', save=True)
683
self.assertFileEqual(content, 'test.conf')
686
class TestIniConfigOptionExpansionDefaultValue(tests.TestCaseInTempDir):
687
"""What is the default value of expand for config options.
689
This is an opt-in beta feature used to evaluate whether or not option
690
references can appear in dangerous place raising exceptions, disapearing
691
(and as such corrupting data) or if it's safe to activate the option by
694
Note that these tests relies on config._expand_default_value being already
695
overwritten in the parent class setUp.
699
super(TestIniConfigOptionExpansionDefaultValue, self).setUp()
703
self.warnings.append(args[0] % args[1:])
704
self.overrideAttr(trace, 'warning', warning)
706
def get_config(self, expand):
707
c = config.GlobalConfig.from_string('bzr.config.expand=%s' % (expand,),
711
def assertExpandIs(self, expected):
712
actual = config._get_expand_default_value()
713
#self.config.get_user_option_as_bool('bzr.config.expand')
714
self.assertEquals(expected, actual)
716
def test_default_is_None(self):
717
self.assertEquals(None, config._expand_default_value)
719
def test_default_is_False_even_if_None(self):
720
self.config = self.get_config(None)
721
self.assertExpandIs(False)
723
def test_default_is_False_even_if_invalid(self):
724
self.config = self.get_config('<your choice>')
725
self.assertExpandIs(False)
727
# Huh ? My choice is False ? Thanks, always happy to hear that :D
728
# Wait, you've been warned !
729
self.assertLength(1, self.warnings)
731
'Value "<your choice>" is not a boolean for "bzr.config.expand"',
734
def test_default_is_True(self):
735
self.config = self.get_config(True)
736
self.assertExpandIs(True)
738
def test_default_is_False(self):
739
self.config = self.get_config(False)
740
self.assertExpandIs(False)
743
class TestIniConfigOptionExpansion(tests.TestCase):
744
"""Test option expansion from the IniConfig level.
746
What we really want here is to test the Config level, but the class being
747
abstract as far as storing values is concerned, this can't be done
750
# FIXME: This should be rewritten when all configs share a storage
751
# implementation -- vila 2011-02-18
753
def get_config(self, string=None):
756
c = config.IniBasedConfig.from_string(string)
759
def assertExpansion(self, expected, conf, string, env=None):
760
self.assertEquals(expected, conf.expand_options(string, env))
762
def test_no_expansion(self):
763
c = self.get_config('')
764
self.assertExpansion('foo', c, 'foo')
766
def test_env_adding_options(self):
767
c = self.get_config('')
768
self.assertExpansion('bar', c, '{foo}', {'foo': 'bar'})
770
def test_env_overriding_options(self):
771
c = self.get_config('foo=baz')
772
self.assertExpansion('bar', c, '{foo}', {'foo': 'bar'})
774
def test_simple_ref(self):
775
c = self.get_config('foo=xxx')
776
self.assertExpansion('xxx', c, '{foo}')
778
def test_unknown_ref(self):
779
c = self.get_config('')
780
self.assertRaises(errors.ExpandingUnknownOption,
781
c.expand_options, '{foo}')
783
def test_indirect_ref(self):
784
c = self.get_config('''
788
self.assertExpansion('xxx', c, '{bar}')
790
def test_embedded_ref(self):
791
c = self.get_config('''
795
self.assertExpansion('xxx', c, '{{bar}}')
797
def test_simple_loop(self):
798
c = self.get_config('foo={foo}')
799
self.assertRaises(errors.OptionExpansionLoop, c.expand_options, '{foo}')
801
def test_indirect_loop(self):
802
c = self.get_config('''
806
e = self.assertRaises(errors.OptionExpansionLoop,
807
c.expand_options, '{foo}')
808
self.assertEquals('foo->bar->baz', e.refs)
809
self.assertEquals('{foo}', e.string)
812
conf = self.get_config('''
816
list={foo},{bar},{baz}
818
self.assertEquals(['start', 'middle', 'end'],
819
conf.get_user_option('list', expand=True))
821
def test_cascading_list(self):
822
conf = self.get_config('''
828
self.assertEquals(['start', 'middle', 'end'],
829
conf.get_user_option('list', expand=True))
831
def test_pathological_hidden_list(self):
832
conf = self.get_config('''
838
hidden={start}{middle}{end}
840
# Nope, it's either a string or a list, and the list wins as soon as a
841
# ',' appears, so the string concatenation never occur.
842
self.assertEquals(['{foo', '}', '{', 'bar}'],
843
conf.get_user_option('hidden', expand=True))
846
class TestLocationConfigOptionExpansion(tests.TestCaseInTempDir):
848
def get_config(self, location, string=None):
851
# Since we don't save the config we won't strictly require to inherit
852
# from TestCaseInTempDir, but an error occurs so quickly...
853
c = config.LocationConfig.from_string(string, location)
856
def test_dont_cross_unrelated_section(self):
857
c = self.get_config('/another/branch/path','''
862
[/another/branch/path]
865
self.assertRaises(errors.ExpandingUnknownOption,
866
c.get_user_option, 'bar', expand=True)
868
def test_cross_related_sections(self):
869
c = self.get_config('/project/branch/path','''
873
[/project/branch/path]
876
self.assertEquals('quux', c.get_user_option('bar', expand=True))
879
class TestIniBaseConfigOnDisk(tests.TestCaseInTempDir):
881
def test_cannot_reload_without_name(self):
882
conf = config.IniBasedConfig.from_string(sample_config_text)
883
self.assertRaises(AssertionError, conf.reload)
885
def test_reload_see_new_value(self):
886
c1 = config.IniBasedConfig.from_string('editor=vim\n',
887
file_name='./test/conf')
888
c1._write_config_file()
889
c2 = config.IniBasedConfig.from_string('editor=emacs\n',
890
file_name='./test/conf')
891
c2._write_config_file()
892
self.assertEqual('vim', c1.get_user_option('editor'))
893
self.assertEqual('emacs', c2.get_user_option('editor'))
894
# Make sure we get the Right value
896
self.assertEqual('emacs', c1.get_user_option('editor'))
899
class TestLockableConfig(tests.TestCaseInTempDir):
901
scenarios = lockable_config_scenarios()
906
config_section = None
909
super(TestLockableConfig, self).setUp()
910
self._content = '[%s]\none=1\ntwo=2\n' % (self.config_section,)
911
self.config = self.create_config(self._content)
913
def get_existing_config(self):
914
return self.config_class(*self.config_args)
916
def create_config(self, content):
917
kwargs = dict(save=True)
918
c = self.config_class.from_string(content, *self.config_args, **kwargs)
921
def test_simple_read_access(self):
922
self.assertEquals('1', self.config.get_user_option('one'))
924
def test_simple_write_access(self):
925
self.config.set_user_option('one', 'one')
926
self.assertEquals('one', self.config.get_user_option('one'))
928
def test_listen_to_the_last_speaker(self):
930
c2 = self.get_existing_config()
931
c1.set_user_option('one', 'ONE')
932
c2.set_user_option('two', 'TWO')
933
self.assertEquals('ONE', c1.get_user_option('one'))
934
self.assertEquals('TWO', c2.get_user_option('two'))
935
# The second update respect the first one
936
self.assertEquals('ONE', c2.get_user_option('one'))
938
def test_last_speaker_wins(self):
939
# If the same config is not shared, the same variable modified twice
940
# can only see a single result.
942
c2 = self.get_existing_config()
943
c1.set_user_option('one', 'c1')
944
c2.set_user_option('one', 'c2')
945
self.assertEquals('c2', c2._get_user_option('one'))
946
# The first modification is still available until another refresh
948
self.assertEquals('c1', c1._get_user_option('one'))
949
c1.set_user_option('two', 'done')
950
self.assertEquals('c2', c1._get_user_option('one'))
952
def test_writes_are_serialized(self):
954
c2 = self.get_existing_config()
956
# We spawn a thread that will pause *during* the write
957
before_writing = threading.Event()
958
after_writing = threading.Event()
959
writing_done = threading.Event()
960
c1_orig = c1._write_config_file
961
def c1_write_config_file():
964
# The lock is held. We wait for the main thread to decide when to
967
c1._write_config_file = c1_write_config_file
969
c1.set_user_option('one', 'c1')
971
t1 = threading.Thread(target=c1_set_option)
972
# Collect the thread after the test
973
self.addCleanup(t1.join)
974
# Be ready to unblock the thread if the test goes wrong
975
self.addCleanup(after_writing.set)
977
before_writing.wait()
978
self.assertTrue(c1._lock.is_held)
979
self.assertRaises(errors.LockContention,
980
c2.set_user_option, 'one', 'c2')
981
self.assertEquals('c1', c1.get_user_option('one'))
982
# Let the lock be released
985
c2.set_user_option('one', 'c2')
986
self.assertEquals('c2', c2.get_user_option('one'))
988
def test_read_while_writing(self):
990
# We spawn a thread that will pause *during* the write
991
ready_to_write = threading.Event()
992
do_writing = threading.Event()
993
writing_done = threading.Event()
994
c1_orig = c1._write_config_file
995
def c1_write_config_file():
997
# The lock is held. We wait for the main thread to decide when to
1002
c1._write_config_file = c1_write_config_file
1003
def c1_set_option():
1004
c1.set_user_option('one', 'c1')
1005
t1 = threading.Thread(target=c1_set_option)
1006
# Collect the thread after the test
1007
self.addCleanup(t1.join)
1008
# Be ready to unblock the thread if the test goes wrong
1009
self.addCleanup(do_writing.set)
1011
# Ensure the thread is ready to write
1012
ready_to_write.wait()
1013
self.assertTrue(c1._lock.is_held)
1014
self.assertEquals('c1', c1.get_user_option('one'))
1015
# If we read during the write, we get the old value
1016
c2 = self.get_existing_config()
1017
self.assertEquals('1', c2.get_user_option('one'))
1018
# Let the writing occur and ensure it occurred
1021
# Now we get the updated value
1022
c3 = self.get_existing_config()
1023
self.assertEquals('c1', c3.get_user_option('one'))
1026
class TestGetUserOptionAs(TestIniConfig):
1028
def test_get_user_option_as_bool(self):
1029
conf, parser = self.make_config_parser("""
1032
an_invalid_bool = maybe
1033
a_list = hmm, who knows ? # This is interpreted as a list !
1035
get_bool = conf.get_user_option_as_bool
1036
self.assertEqual(True, get_bool('a_true_bool'))
1037
self.assertEqual(False, get_bool('a_false_bool'))
1040
warnings.append(args[0] % args[1:])
1041
self.overrideAttr(trace, 'warning', warning)
1042
msg = 'Value "%s" is not a boolean for "%s"'
1043
self.assertIs(None, get_bool('an_invalid_bool'))
1044
self.assertEquals(msg % ('maybe', 'an_invalid_bool'), warnings[0])
1046
self.assertIs(None, get_bool('not_defined_in_this_config'))
1047
self.assertEquals([], warnings)
1049
def test_get_user_option_as_list(self):
1050
conf, parser = self.make_config_parser("""
1055
get_list = conf.get_user_option_as_list
1056
self.assertEqual(['a', 'b', 'c'], get_list('a_list'))
1057
self.assertEqual(['1'], get_list('length_1'))
1058
self.assertEqual('x', conf.get_user_option('one_item'))
1059
# automatically cast to list
1060
self.assertEqual(['x'], get_list('one_item'))
1062
def test_get_user_option_as_int_from_SI(self):
1063
conf, parser = self.make_config_parser("""
1072
get_si = conf.get_user_option_as_int_from_SI
1073
self.assertEqual(100, get_si('plain'))
1074
self.assertEqual(5000, get_si('si_k'))
1075
self.assertEqual(5000, get_si('si_kb'))
1076
self.assertEqual(5000000, get_si('si_m'))
1077
self.assertEqual(5000000, get_si('si_mb'))
1078
self.assertEqual(5000000000, get_si('si_g'))
1079
self.assertEqual(5000000000, get_si('si_gb'))
1080
self.assertEqual(None, get_si('non-exist'))
1081
self.assertEqual(42, get_si('non-exist-with-default', 42))
1083
class TestSupressWarning(TestIniConfig):
1085
def make_warnings_config(self, s):
1086
conf, parser = self.make_config_parser(s)
1087
return conf.suppress_warning
1089
def test_suppress_warning_unknown(self):
1090
suppress_warning = self.make_warnings_config('')
1091
self.assertEqual(False, suppress_warning('unknown_warning'))
1093
def test_suppress_warning_known(self):
1094
suppress_warning = self.make_warnings_config('suppress_warnings=a,b')
1095
self.assertEqual(False, suppress_warning('c'))
1096
self.assertEqual(True, suppress_warning('a'))
1097
self.assertEqual(True, suppress_warning('b'))
1100
class TestGetConfig(tests.TestCase):
341
1102
def test_constructs(self):
342
1103
my_config = config.GlobalConfig()
344
1105
def test_calls_read_filenames(self):
345
# replace the class that is constructured, to check its parameters
1106
# replace the class that is constructed, to check its parameters
346
1107
oldparserclass = config.ConfigObj
347
1108
config.ConfigObj = InstrumentedConfigObj
348
1109
my_config = config.GlobalConfig()
876
class TestBranchConfigItems(TestCaseInTempDir):
878
def get_branch_config(self, global_config=None, location=None,
1786
class TestBranchConfigItems(tests.TestCaseInTempDir):
1788
def get_branch_config(self, global_config=None, location=None,
879
1789
location_config=None, branch_data_config=None):
880
my_config = config.BranchConfig(FakeBranch(location))
1790
my_branch = FakeBranch(location)
881
1791
if global_config is not None:
882
global_file = StringIO(global_config.encode('utf-8'))
883
my_config._get_global_config()._get_parser(global_file)
884
self.my_location_config = my_config._get_location_config()
1792
my_global_config = config.GlobalConfig.from_string(global_config,
885
1794
if location_config is not None:
886
location_file = StringIO(location_config.encode('utf-8'))
887
self.my_location_config._get_parser(location_file)
1795
my_location_config = config.LocationConfig.from_string(
1796
location_config, my_branch.base, save=True)
1797
my_config = config.BranchConfig(my_branch)
888
1798
if branch_data_config is not None:
889
1799
my_config.branch.control_files.files['branch.conf'] = \
890
1800
branch_data_config
891
1801
return my_config
893
1803
def test_user_id(self):
894
branch = FakeBranch(user_id='Robert Collins <robertc@example.net>')
1804
branch = FakeBranch()
895
1805
my_config = config.BranchConfig(branch)
896
self.assertEqual("Robert Collins <robertc@example.net>",
897
my_config.username())
898
branch.control_files.email = "John"
899
my_config.set_user_option('email',
1806
self.assertIsNot(None, my_config.username())
1807
my_config.branch.control_files.files['email'] = "John"
1808
my_config.set_user_option('email',
900
1809
"Robert Collins <robertc@example.org>")
901
self.assertEqual("John", my_config.username())
902
branch.control_files.email = None
903
1810
self.assertEqual("Robert Collins <robertc@example.org>",
904
my_config.username())
906
def test_not_set_in_branch(self):
907
my_config = self.get_branch_config(sample_config_text)
908
my_config.branch.control_files.email = None
909
self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
910
my_config._get_user_id())
911
my_config.branch.control_files.email = "John"
912
self.assertEqual("John", my_config._get_user_id())
1811
my_config.username())
914
1813
def test_BZR_EMAIL_OVERRIDES(self):
915
os.environ['BZR_EMAIL'] = "Robert Collins <robertc@example.org>"
1814
self.overrideEnv('BZR_EMAIL', "Robert Collins <robertc@example.org>")
916
1815
branch = FakeBranch()
917
1816
my_config = config.BranchConfig(branch)
918
1817
self.assertEqual("Robert Collins <robertc@example.org>",
919
1818
my_config.username())
921
1820
def test_signatures_forced(self):
922
1821
my_config = self.get_branch_config(
923
1822
global_config=sample_always_signatures)
924
self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
925
self.assertEqual(config.SIGN_ALWAYS, my_config.signing_policy())
926
self.assertTrue(my_config.signature_needed())
1823
self.assertEqual(config.CHECK_NEVER,
1824
self.applyDeprecated(deprecated_in((2, 5, 0)),
1825
my_config.signature_checking))
1826
self.assertEqual(config.SIGN_ALWAYS,
1827
self.applyDeprecated(deprecated_in((2, 5, 0)),
1828
my_config.signing_policy))
1829
self.assertTrue(self.applyDeprecated(deprecated_in((2, 5, 0)),
1830
my_config.signature_needed))
928
1832
def test_signatures_forced_branch(self):
929
1833
my_config = self.get_branch_config(
930
1834
global_config=sample_ignore_signatures,
931
1835
branch_data_config=sample_always_signatures)
932
self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
933
self.assertEqual(config.SIGN_ALWAYS, my_config.signing_policy())
934
self.assertTrue(my_config.signature_needed())
1836
self.assertEqual(config.CHECK_NEVER,
1837
self.applyDeprecated(deprecated_in((2, 5, 0)),
1838
my_config.signature_checking))
1839
self.assertEqual(config.SIGN_ALWAYS,
1840
self.applyDeprecated(deprecated_in((2, 5, 0)),
1841
my_config.signing_policy))
1842
self.assertTrue(self.applyDeprecated(deprecated_in((2, 5, 0)),
1843
my_config.signature_needed))
936
1845
def test_gpg_signing_command(self):
937
1846
my_config = self.get_branch_config(
1847
global_config=sample_config_text,
938
1848
# branch data cannot set gpg_signing_command
939
1849
branch_data_config="gpg_signing_command=pgp")
940
config_file = StringIO(sample_config_text.encode('utf-8'))
941
my_config._get_global_config()._get_parser(config_file)
942
self.assertEqual('gnome-gpg', my_config.gpg_signing_command())
1850
self.assertEqual('gnome-gpg',
1851
self.applyDeprecated(deprecated_in((2, 5, 0)),
1852
my_config.gpg_signing_command))
944
1854
def test_get_user_option_global(self):
945
branch = FakeBranch()
946
my_config = config.BranchConfig(branch)
947
config_file = StringIO(sample_config_text.encode('utf-8'))
948
(my_config._get_global_config()._get_parser(config_file))
1855
my_config = self.get_branch_config(global_config=sample_config_text)
949
1856
self.assertEqual('something',
950
1857
my_config.get_user_option('user_global_option'))
952
1859
def test_post_commit_default(self):
953
branch = FakeBranch()
954
my_config = self.get_branch_config(sample_config_text, '/a/c',
955
sample_branches_text)
1860
my_config = self.get_branch_config(global_config=sample_config_text,
1862
location_config=sample_branches_text)
956
1863
self.assertEqual(my_config.branch.base, '/a/c')
957
1864
self.assertEqual('bzrlib.tests.test_config.post_commit',
958
my_config.post_commit())
1865
self.applyDeprecated(deprecated_in((2, 5, 0)),
1866
my_config.post_commit))
959
1867
my_config.set_user_option('post_commit', 'rmtree_root')
960
# post-commit is ignored when bresent in branch data
1868
# post-commit is ignored when present in branch data
961
1869
self.assertEqual('bzrlib.tests.test_config.post_commit',
962
my_config.post_commit())
1870
self.applyDeprecated(deprecated_in((2, 5, 0)),
1871
my_config.post_commit))
963
1872
my_config.set_user_option('post_commit', 'rmtree_root',
964
1873
store=config.STORE_LOCATION)
965
self.assertEqual('rmtree_root', my_config.post_commit())
1874
self.assertEqual('rmtree_root',
1875
self.applyDeprecated(deprecated_in((2, 5, 0)),
1876
my_config.post_commit))
967
1878
def test_config_precedence(self):
1879
# FIXME: eager test, luckily no persitent config file makes it fail
968
1881
my_config = self.get_branch_config(global_config=precedence_global)
969
1882
self.assertEqual(my_config.get_user_option('option'), 'global')
970
my_config = self.get_branch_config(global_config=precedence_global,
971
branch_data_config=precedence_branch)
1883
my_config = self.get_branch_config(global_config=precedence_global,
1884
branch_data_config=precedence_branch)
972
1885
self.assertEqual(my_config.get_user_option('option'), 'branch')
973
my_config = self.get_branch_config(global_config=precedence_global,
974
branch_data_config=precedence_branch,
975
location_config=precedence_location)
1886
my_config = self.get_branch_config(
1887
global_config=precedence_global,
1888
branch_data_config=precedence_branch,
1889
location_config=precedence_location)
976
1890
self.assertEqual(my_config.get_user_option('option'), 'recurse')
977
my_config = self.get_branch_config(global_config=precedence_global,
978
branch_data_config=precedence_branch,
979
location_config=precedence_location,
980
location='http://example.com/specific')
1891
my_config = self.get_branch_config(
1892
global_config=precedence_global,
1893
branch_data_config=precedence_branch,
1894
location_config=precedence_location,
1895
location='http://example.com/specific')
981
1896
self.assertEqual(my_config.get_user_option('option'), 'exact')
984
class TestMailAddressExtraction(TestCase):
1898
def test_get_mail_client(self):
1899
config = self.get_branch_config()
1900
client = config.get_mail_client()
1901
self.assertIsInstance(client, mail_client.DefaultMail)
1904
config.set_user_option('mail_client', 'evolution')
1905
client = config.get_mail_client()
1906
self.assertIsInstance(client, mail_client.Evolution)
1908
config.set_user_option('mail_client', 'kmail')
1909
client = config.get_mail_client()
1910
self.assertIsInstance(client, mail_client.KMail)
1912
config.set_user_option('mail_client', 'mutt')
1913
client = config.get_mail_client()
1914
self.assertIsInstance(client, mail_client.Mutt)
1916
config.set_user_option('mail_client', 'thunderbird')
1917
client = config.get_mail_client()
1918
self.assertIsInstance(client, mail_client.Thunderbird)
1921
config.set_user_option('mail_client', 'default')
1922
client = config.get_mail_client()
1923
self.assertIsInstance(client, mail_client.DefaultMail)
1925
config.set_user_option('mail_client', 'editor')
1926
client = config.get_mail_client()
1927
self.assertIsInstance(client, mail_client.Editor)
1929
config.set_user_option('mail_client', 'mapi')
1930
client = config.get_mail_client()
1931
self.assertIsInstance(client, mail_client.MAPIClient)
1933
config.set_user_option('mail_client', 'xdg-email')
1934
client = config.get_mail_client()
1935
self.assertIsInstance(client, mail_client.XDGEmail)
1937
config.set_user_option('mail_client', 'firebird')
1938
self.assertRaises(errors.UnknownMailClient, config.get_mail_client)
1941
class TestMailAddressExtraction(tests.TestCase):
986
1943
def test_extract_email_address(self):
987
1944
self.assertEqual('jane@test.com',
988
1945
config.extract_email_address('Jane <jane@test.com>'))
989
1946
self.assertRaises(errors.NoEmailInUsername,
990
1947
config.extract_email_address, 'Jane Tester')
1949
def test_parse_username(self):
1950
self.assertEqual(('', 'jdoe@example.com'),
1951
config.parse_username('jdoe@example.com'))
1952
self.assertEqual(('', 'jdoe@example.com'),
1953
config.parse_username('<jdoe@example.com>'))
1954
self.assertEqual(('John Doe', 'jdoe@example.com'),
1955
config.parse_username('John Doe <jdoe@example.com>'))
1956
self.assertEqual(('John Doe', ''),
1957
config.parse_username('John Doe'))
1958
self.assertEqual(('John Doe', 'jdoe@example.com'),
1959
config.parse_username('John Doe jdoe@example.com'))
1961
class TestTreeConfig(tests.TestCaseWithTransport):
1963
def test_get_value(self):
1964
"""Test that retreiving a value from a section is possible"""
1965
branch = self.make_branch('.')
1966
tree_config = config.TreeConfig(branch)
1967
tree_config.set_option('value', 'key', 'SECTION')
1968
tree_config.set_option('value2', 'key2')
1969
tree_config.set_option('value3-top', 'key3')
1970
tree_config.set_option('value3-section', 'key3', 'SECTION')
1971
value = tree_config.get_option('key', 'SECTION')
1972
self.assertEqual(value, 'value')
1973
value = tree_config.get_option('key2')
1974
self.assertEqual(value, 'value2')
1975
self.assertEqual(tree_config.get_option('non-existant'), None)
1976
value = tree_config.get_option('non-existant', 'SECTION')
1977
self.assertEqual(value, None)
1978
value = tree_config.get_option('non-existant', default='default')
1979
self.assertEqual(value, 'default')
1980
self.assertEqual(tree_config.get_option('key2', 'NOSECTION'), None)
1981
value = tree_config.get_option('key2', 'NOSECTION', default='default')
1982
self.assertEqual(value, 'default')
1983
value = tree_config.get_option('key3')
1984
self.assertEqual(value, 'value3-top')
1985
value = tree_config.get_option('key3', 'SECTION')
1986
self.assertEqual(value, 'value3-section')
1989
class TestTransportConfig(tests.TestCaseWithTransport):
1991
def test_load_utf8(self):
1992
"""Ensure we can load an utf8-encoded file."""
1993
t = self.get_transport()
1994
unicode_user = u'b\N{Euro Sign}ar'
1995
unicode_content = u'user=%s' % (unicode_user,)
1996
utf8_content = unicode_content.encode('utf8')
1997
# Store the raw content in the config file
1998
t.put_bytes('foo.conf', utf8_content)
1999
conf = config.TransportConfig(t, 'foo.conf')
2000
self.assertEquals(unicode_user, conf.get_option('user'))
2002
def test_load_non_ascii(self):
2003
"""Ensure we display a proper error on non-ascii, non utf-8 content."""
2004
t = self.get_transport()
2005
t.put_bytes('foo.conf', 'user=foo\n#\xff\n')
2006
conf = config.TransportConfig(t, 'foo.conf')
2007
self.assertRaises(errors.ConfigContentError, conf._get_configobj)
2009
def test_load_erroneous_content(self):
2010
"""Ensure we display a proper error on content that can't be parsed."""
2011
t = self.get_transport()
2012
t.put_bytes('foo.conf', '[open_section\n')
2013
conf = config.TransportConfig(t, 'foo.conf')
2014
self.assertRaises(errors.ParseConfigError, conf._get_configobj)
2016
def test_load_permission_denied(self):
2017
"""Ensure we get an empty config file if the file is inaccessible."""
2020
warnings.append(args[0] % args[1:])
2021
self.overrideAttr(trace, 'warning', warning)
2023
class DenyingTransport(object):
2025
def __init__(self, base):
2028
def get_bytes(self, relpath):
2029
raise errors.PermissionDenied(relpath, "")
2031
cfg = config.TransportConfig(
2032
DenyingTransport("nonexisting://"), 'control.conf')
2033
self.assertIs(None, cfg.get_option('non-existant', 'SECTION'))
2036
[u'Permission denied while trying to open configuration file '
2037
u'nonexisting:///control.conf.'])
2039
def test_get_value(self):
2040
"""Test that retreiving a value from a section is possible"""
2041
bzrdir_config = config.TransportConfig(self.get_transport('.'),
2043
bzrdir_config.set_option('value', 'key', 'SECTION')
2044
bzrdir_config.set_option('value2', 'key2')
2045
bzrdir_config.set_option('value3-top', 'key3')
2046
bzrdir_config.set_option('value3-section', 'key3', 'SECTION')
2047
value = bzrdir_config.get_option('key', 'SECTION')
2048
self.assertEqual(value, 'value')
2049
value = bzrdir_config.get_option('key2')
2050
self.assertEqual(value, 'value2')
2051
self.assertEqual(bzrdir_config.get_option('non-existant'), None)
2052
value = bzrdir_config.get_option('non-existant', 'SECTION')
2053
self.assertEqual(value, None)
2054
value = bzrdir_config.get_option('non-existant', default='default')
2055
self.assertEqual(value, 'default')
2056
self.assertEqual(bzrdir_config.get_option('key2', 'NOSECTION'), None)
2057
value = bzrdir_config.get_option('key2', 'NOSECTION',
2059
self.assertEqual(value, 'default')
2060
value = bzrdir_config.get_option('key3')
2061
self.assertEqual(value, 'value3-top')
2062
value = bzrdir_config.get_option('key3', 'SECTION')
2063
self.assertEqual(value, 'value3-section')
2065
def test_set_unset_default_stack_on(self):
2066
my_dir = self.make_bzrdir('.')
2067
bzrdir_config = config.BzrDirConfig(my_dir)
2068
self.assertIs(None, bzrdir_config.get_default_stack_on())
2069
bzrdir_config.set_default_stack_on('Foo')
2070
self.assertEqual('Foo', bzrdir_config._config.get_option(
2071
'default_stack_on'))
2072
self.assertEqual('Foo', bzrdir_config.get_default_stack_on())
2073
bzrdir_config.set_default_stack_on(None)
2074
self.assertIs(None, bzrdir_config.get_default_stack_on())
2077
class TestOldConfigHooks(tests.TestCaseWithTransport):
2080
super(TestOldConfigHooks, self).setUp()
2081
create_configs_with_file_option(self)
2083
def assertGetHook(self, conf, name, value):
2087
config.OldConfigHooks.install_named_hook('get', hook, None)
2089
config.OldConfigHooks.uninstall_named_hook, 'get', None)
2090
self.assertLength(0, calls)
2091
actual_value = conf.get_user_option(name)
2092
self.assertEquals(value, actual_value)
2093
self.assertLength(1, calls)
2094
self.assertEquals((conf, name, value), calls[0])
2096
def test_get_hook_bazaar(self):
2097
self.assertGetHook(self.bazaar_config, 'file', 'bazaar')
2099
def test_get_hook_locations(self):
2100
self.assertGetHook(self.locations_config, 'file', 'locations')
2102
def test_get_hook_branch(self):
2103
# Since locations masks branch, we define a different option
2104
self.branch_config.set_user_option('file2', 'branch')
2105
self.assertGetHook(self.branch_config, 'file2', 'branch')
2107
def assertSetHook(self, conf, name, value):
2111
config.OldConfigHooks.install_named_hook('set', hook, None)
2113
config.OldConfigHooks.uninstall_named_hook, 'set', None)
2114
self.assertLength(0, calls)
2115
conf.set_user_option(name, value)
2116
self.assertLength(1, calls)
2117
# We can't assert the conf object below as different configs use
2118
# different means to implement set_user_option and we care only about
2120
self.assertEquals((name, value), calls[0][1:])
2122
def test_set_hook_bazaar(self):
2123
self.assertSetHook(self.bazaar_config, 'foo', 'bazaar')
2125
def test_set_hook_locations(self):
2126
self.assertSetHook(self.locations_config, 'foo', 'locations')
2128
def test_set_hook_branch(self):
2129
self.assertSetHook(self.branch_config, 'foo', 'branch')
2131
def assertRemoveHook(self, conf, name, section_name=None):
2135
config.OldConfigHooks.install_named_hook('remove', hook, None)
2137
config.OldConfigHooks.uninstall_named_hook, 'remove', None)
2138
self.assertLength(0, calls)
2139
conf.remove_user_option(name, section_name)
2140
self.assertLength(1, calls)
2141
# We can't assert the conf object below as different configs use
2142
# different means to implement remove_user_option and we care only about
2144
self.assertEquals((name,), calls[0][1:])
2146
def test_remove_hook_bazaar(self):
2147
self.assertRemoveHook(self.bazaar_config, 'file')
2149
def test_remove_hook_locations(self):
2150
self.assertRemoveHook(self.locations_config, 'file',
2151
self.locations_config.location)
2153
def test_remove_hook_branch(self):
2154
self.assertRemoveHook(self.branch_config, 'file')
2156
def assertLoadHook(self, name, conf_class, *conf_args):
2160
config.OldConfigHooks.install_named_hook('load', hook, None)
2162
config.OldConfigHooks.uninstall_named_hook, 'load', None)
2163
self.assertLength(0, calls)
2165
conf = conf_class(*conf_args)
2166
# Access an option to trigger a load
2167
conf.get_user_option(name)
2168
self.assertLength(1, calls)
2169
# Since we can't assert about conf, we just use the number of calls ;-/
2171
def test_load_hook_bazaar(self):
2172
self.assertLoadHook('file', config.GlobalConfig)
2174
def test_load_hook_locations(self):
2175
self.assertLoadHook('file', config.LocationConfig, self.tree.basedir)
2177
def test_load_hook_branch(self):
2178
self.assertLoadHook('file', config.BranchConfig, self.tree.branch)
2180
def assertSaveHook(self, conf):
2184
config.OldConfigHooks.install_named_hook('save', hook, None)
2186
config.OldConfigHooks.uninstall_named_hook, 'save', None)
2187
self.assertLength(0, calls)
2188
# Setting an option triggers a save
2189
conf.set_user_option('foo', 'bar')
2190
self.assertLength(1, calls)
2191
# Since we can't assert about conf, we just use the number of calls ;-/
2193
def test_save_hook_bazaar(self):
2194
self.assertSaveHook(self.bazaar_config)
2196
def test_save_hook_locations(self):
2197
self.assertSaveHook(self.locations_config)
2199
def test_save_hook_branch(self):
2200
self.assertSaveHook(self.branch_config)
2203
class TestOldConfigHooksForRemote(tests.TestCaseWithTransport):
2204
"""Tests config hooks for remote configs.
2206
No tests for the remove hook as this is not implemented there.
2210
super(TestOldConfigHooksForRemote, self).setUp()
2211
self.transport_server = test_server.SmartTCPServer_for_testing
2212
create_configs_with_file_option(self)
2214
def assertGetHook(self, conf, name, value):
2218
config.OldConfigHooks.install_named_hook('get', hook, None)
2220
config.OldConfigHooks.uninstall_named_hook, 'get', None)
2221
self.assertLength(0, calls)
2222
actual_value = conf.get_option(name)
2223
self.assertEquals(value, actual_value)
2224
self.assertLength(1, calls)
2225
self.assertEquals((conf, name, value), calls[0])
2227
def test_get_hook_remote_branch(self):
2228
remote_branch = branch.Branch.open(self.get_url('tree'))
2229
self.assertGetHook(remote_branch._get_config(), 'file', 'branch')
2231
def test_get_hook_remote_bzrdir(self):
2232
remote_bzrdir = bzrdir.BzrDir.open(self.get_url('tree'))
2233
conf = remote_bzrdir._get_config()
2234
conf.set_option('remotedir', 'file')
2235
self.assertGetHook(conf, 'file', 'remotedir')
2237
def assertSetHook(self, conf, name, value):
2241
config.OldConfigHooks.install_named_hook('set', hook, None)
2243
config.OldConfigHooks.uninstall_named_hook, 'set', None)
2244
self.assertLength(0, calls)
2245
conf.set_option(value, name)
2246
self.assertLength(1, calls)
2247
# We can't assert the conf object below as different configs use
2248
# different means to implement set_user_option and we care only about
2250
self.assertEquals((name, value), calls[0][1:])
2252
def test_set_hook_remote_branch(self):
2253
remote_branch = branch.Branch.open(self.get_url('tree'))
2254
self.addCleanup(remote_branch.lock_write().unlock)
2255
self.assertSetHook(remote_branch._get_config(), 'file', 'remote')
2257
def test_set_hook_remote_bzrdir(self):
2258
remote_branch = branch.Branch.open(self.get_url('tree'))
2259
self.addCleanup(remote_branch.lock_write().unlock)
2260
remote_bzrdir = bzrdir.BzrDir.open(self.get_url('tree'))
2261
self.assertSetHook(remote_bzrdir._get_config(), 'file', 'remotedir')
2263
def assertLoadHook(self, expected_nb_calls, name, conf_class, *conf_args):
2267
config.OldConfigHooks.install_named_hook('load', hook, None)
2269
config.OldConfigHooks.uninstall_named_hook, 'load', None)
2270
self.assertLength(0, calls)
2272
conf = conf_class(*conf_args)
2273
# Access an option to trigger a load
2274
conf.get_option(name)
2275
self.assertLength(expected_nb_calls, calls)
2276
# Since we can't assert about conf, we just use the number of calls ;-/
2278
def test_load_hook_remote_branch(self):
2279
remote_branch = branch.Branch.open(self.get_url('tree'))
2280
self.assertLoadHook(1, 'file', remote.RemoteBranchConfig, remote_branch)
2282
def test_load_hook_remote_bzrdir(self):
2283
remote_bzrdir = bzrdir.BzrDir.open(self.get_url('tree'))
2284
# The config file doesn't exist, set an option to force its creation
2285
conf = remote_bzrdir._get_config()
2286
conf.set_option('remotedir', 'file')
2287
# We get one call for the server and one call for the client, this is
2288
# caused by the differences in implementations betwen
2289
# SmartServerBzrDirRequestConfigFile (in smart/bzrdir.py) and
2290
# SmartServerBranchGetConfigFile (in smart/branch.py)
2291
self.assertLoadHook(2 ,'file', remote.RemoteBzrDirConfig, remote_bzrdir)
2293
def assertSaveHook(self, conf):
2297
config.OldConfigHooks.install_named_hook('save', hook, None)
2299
config.OldConfigHooks.uninstall_named_hook, 'save', None)
2300
self.assertLength(0, calls)
2301
# Setting an option triggers a save
2302
conf.set_option('foo', 'bar')
2303
self.assertLength(1, calls)
2304
# Since we can't assert about conf, we just use the number of calls ;-/
2306
def test_save_hook_remote_branch(self):
2307
remote_branch = branch.Branch.open(self.get_url('tree'))
2308
self.addCleanup(remote_branch.lock_write().unlock)
2309
self.assertSaveHook(remote_branch._get_config())
2311
def test_save_hook_remote_bzrdir(self):
2312
remote_branch = branch.Branch.open(self.get_url('tree'))
2313
self.addCleanup(remote_branch.lock_write().unlock)
2314
remote_bzrdir = bzrdir.BzrDir.open(self.get_url('tree'))
2315
self.assertSaveHook(remote_bzrdir._get_config())
2318
class TestOption(tests.TestCase):
2320
def test_default_value(self):
2321
opt = config.Option('foo', default='bar')
2322
self.assertEquals('bar', opt.get_default())
2324
def test_callable_default_value(self):
2325
def bar_as_unicode():
2327
opt = config.Option('foo', default=bar_as_unicode)
2328
self.assertEquals('bar', opt.get_default())
2330
def test_default_value_from_env(self):
2331
opt = config.Option('foo', default='bar', default_from_env=['FOO'])
2332
self.overrideEnv('FOO', 'quux')
2333
# Env variable provides a default taking over the option one
2334
self.assertEquals('quux', opt.get_default())
2336
def test_first_default_value_from_env_wins(self):
2337
opt = config.Option('foo', default='bar',
2338
default_from_env=['NO_VALUE', 'FOO', 'BAZ'])
2339
self.overrideEnv('FOO', 'foo')
2340
self.overrideEnv('BAZ', 'baz')
2341
# The first env var set wins
2342
self.assertEquals('foo', opt.get_default())
2344
def test_not_supported_list_default_value(self):
2345
self.assertRaises(AssertionError, config.Option, 'foo', default=[1])
2347
def test_not_supported_object_default_value(self):
2348
self.assertRaises(AssertionError, config.Option, 'foo',
2351
def test_not_supported_callable_default_value_not_unicode(self):
2352
def bar_not_unicode():
2354
opt = config.Option('foo', default=bar_not_unicode)
2355
self.assertRaises(AssertionError, opt.get_default)
2358
class TestOptionConverterMixin(object):
2360
def assertConverted(self, expected, opt, value):
2361
self.assertEquals(expected, opt.convert_from_unicode(value))
2363
def assertWarns(self, opt, value):
2366
warnings.append(args[0] % args[1:])
2367
self.overrideAttr(trace, 'warning', warning)
2368
self.assertEquals(None, opt.convert_from_unicode(value))
2369
self.assertLength(1, warnings)
2371
'Value "%s" is not valid for "%s"' % (value, opt.name),
2374
def assertErrors(self, opt, value):
2375
self.assertRaises(errors.ConfigOptionValueError,
2376
opt.convert_from_unicode, value)
2378
def assertConvertInvalid(self, opt, invalid_value):
2380
self.assertEquals(None, opt.convert_from_unicode(invalid_value))
2381
opt.invalid = 'warning'
2382
self.assertWarns(opt, invalid_value)
2383
opt.invalid = 'error'
2384
self.assertErrors(opt, invalid_value)
2387
class TestOptionWithBooleanConverter(tests.TestCase, TestOptionConverterMixin):
2389
def get_option(self):
2390
return config.Option('foo', help='A boolean.',
2391
from_unicode=config.bool_from_store)
2393
def test_convert_invalid(self):
2394
opt = self.get_option()
2395
# A string that is not recognized as a boolean
2396
self.assertConvertInvalid(opt, u'invalid-boolean')
2397
# A list of strings is never recognized as a boolean
2398
self.assertConvertInvalid(opt, [u'not', u'a', u'boolean'])
2400
def test_convert_valid(self):
2401
opt = self.get_option()
2402
self.assertConverted(True, opt, u'True')
2403
self.assertConverted(True, opt, u'1')
2404
self.assertConverted(False, opt, u'False')
2407
class TestOptionWithIntegerConverter(tests.TestCase, TestOptionConverterMixin):
2409
def get_option(self):
2410
return config.Option('foo', help='An integer.',
2411
from_unicode=config.int_from_store)
2413
def test_convert_invalid(self):
2414
opt = self.get_option()
2415
# A string that is not recognized as an integer
2416
self.assertConvertInvalid(opt, u'forty-two')
2417
# A list of strings is never recognized as an integer
2418
self.assertConvertInvalid(opt, [u'a', u'list'])
2420
def test_convert_valid(self):
2421
opt = self.get_option()
2422
self.assertConverted(16, opt, u'16')
2425
class TestOptionWithListConverter(tests.TestCase, TestOptionConverterMixin):
2427
def get_option(self):
2428
return config.Option('foo', help='A list.',
2429
from_unicode=config.list_from_store)
2431
def test_convert_invalid(self):
2432
# No string is invalid as all forms can be converted to a list
2435
def test_convert_valid(self):
2436
opt = self.get_option()
2437
# An empty string is an empty list
2438
self.assertConverted([], opt, '') # Using a bare str() just in case
2439
self.assertConverted([], opt, u'')
2441
self.assertConverted([u'True'], opt, u'True')
2443
self.assertConverted([u'42'], opt, u'42')
2445
self.assertConverted([u'bar'], opt, u'bar')
2446
# A list remains a list (configObj will turn a string containing commas
2447
# into a list, but that's not what we're testing here)
2448
self.assertConverted([u'foo', u'1', u'True'],
2449
opt, [u'foo', u'1', u'True'])
2452
class TestOptionConverterMixin(object):
2454
def assertConverted(self, expected, opt, value):
2455
self.assertEquals(expected, opt.convert_from_unicode(value))
2457
def assertWarns(self, opt, value):
2460
warnings.append(args[0] % args[1:])
2461
self.overrideAttr(trace, 'warning', warning)
2462
self.assertEquals(None, opt.convert_from_unicode(value))
2463
self.assertLength(1, warnings)
2465
'Value "%s" is not valid for "%s"' % (value, opt.name),
2468
def assertErrors(self, opt, value):
2469
self.assertRaises(errors.ConfigOptionValueError,
2470
opt.convert_from_unicode, value)
2472
def assertConvertInvalid(self, opt, invalid_value):
2474
self.assertEquals(None, opt.convert_from_unicode(invalid_value))
2475
opt.invalid = 'warning'
2476
self.assertWarns(opt, invalid_value)
2477
opt.invalid = 'error'
2478
self.assertErrors(opt, invalid_value)
2481
class TestOptionWithBooleanConverter(tests.TestCase, TestOptionConverterMixin):
2483
def get_option(self):
2484
return config.Option('foo', help='A boolean.',
2485
from_unicode=config.bool_from_store)
2487
def test_convert_invalid(self):
2488
opt = self.get_option()
2489
# A string that is not recognized as a boolean
2490
self.assertConvertInvalid(opt, u'invalid-boolean')
2491
# A list of strings is never recognized as a boolean
2492
self.assertConvertInvalid(opt, [u'not', u'a', u'boolean'])
2494
def test_convert_valid(self):
2495
opt = self.get_option()
2496
self.assertConverted(True, opt, u'True')
2497
self.assertConverted(True, opt, u'1')
2498
self.assertConverted(False, opt, u'False')
2501
class TestOptionWithIntegerConverter(tests.TestCase, TestOptionConverterMixin):
2503
def get_option(self):
2504
return config.Option('foo', help='An integer.',
2505
from_unicode=config.int_from_store)
2507
def test_convert_invalid(self):
2508
opt = self.get_option()
2509
# A string that is not recognized as an integer
2510
self.assertConvertInvalid(opt, u'forty-two')
2511
# A list of strings is never recognized as an integer
2512
self.assertConvertInvalid(opt, [u'a', u'list'])
2514
def test_convert_valid(self):
2515
opt = self.get_option()
2516
self.assertConverted(16, opt, u'16')
2519
class TestOptionWithListConverter(tests.TestCase, TestOptionConverterMixin):
2521
def get_option(self):
2522
return config.Option('foo', help='A list.',
2523
from_unicode=config.list_from_store)
2525
def test_convert_invalid(self):
2526
opt = self.get_option()
2527
# We don't even try to convert a list into a list, we only expect
2529
self.assertConvertInvalid(opt, [1])
2530
# No string is invalid as all forms can be converted to a list
2532
def test_convert_valid(self):
2533
opt = self.get_option()
2534
# An empty string is an empty list
2535
self.assertConverted([], opt, '') # Using a bare str() just in case
2536
self.assertConverted([], opt, u'')
2538
self.assertConverted([u'True'], opt, u'True')
2540
self.assertConverted([u'42'], opt, u'42')
2542
self.assertConverted([u'bar'], opt, u'bar')
2545
class TestOptionRegistry(tests.TestCase):
2548
super(TestOptionRegistry, self).setUp()
2549
# Always start with an empty registry
2550
self.overrideAttr(config, 'option_registry', config.OptionRegistry())
2551
self.registry = config.option_registry
2553
def test_register(self):
2554
opt = config.Option('foo')
2555
self.registry.register(opt)
2556
self.assertIs(opt, self.registry.get('foo'))
2558
def test_registered_help(self):
2559
opt = config.Option('foo', help='A simple option')
2560
self.registry.register(opt)
2561
self.assertEquals('A simple option', self.registry.get_help('foo'))
2563
lazy_option = config.Option('lazy_foo', help='Lazy help')
2565
def test_register_lazy(self):
2566
self.registry.register_lazy('lazy_foo', self.__module__,
2567
'TestOptionRegistry.lazy_option')
2568
self.assertIs(self.lazy_option, self.registry.get('lazy_foo'))
2570
def test_registered_lazy_help(self):
2571
self.registry.register_lazy('lazy_foo', self.__module__,
2572
'TestOptionRegistry.lazy_option')
2573
self.assertEquals('Lazy help', self.registry.get_help('lazy_foo'))
2576
class TestRegisteredOptions(tests.TestCase):
2577
"""All registered options should verify some constraints."""
2579
scenarios = [(key, {'option_name': key, 'option': option}) for key, option
2580
in config.option_registry.iteritems()]
2583
super(TestRegisteredOptions, self).setUp()
2584
self.registry = config.option_registry
2586
def test_proper_name(self):
2587
# An option should be registered under its own name, this can't be
2588
# checked at registration time for the lazy ones.
2589
self.assertEquals(self.option_name, self.option.name)
2591
def test_help_is_set(self):
2592
option_help = self.registry.get_help(self.option_name)
2593
self.assertNotEquals(None, option_help)
2594
# Come on, think about the user, he really wants to know what the
2596
self.assertIsNot(None, option_help)
2597
self.assertNotEquals('', option_help)
2600
class TestSection(tests.TestCase):
2602
# FIXME: Parametrize so that all sections produced by Stores run these
2603
# tests -- vila 2011-04-01
2605
def test_get_a_value(self):
2606
a_dict = dict(foo='bar')
2607
section = config.Section('myID', a_dict)
2608
self.assertEquals('bar', section.get('foo'))
2610
def test_get_unknown_option(self):
2612
section = config.Section(None, a_dict)
2613
self.assertEquals('out of thin air',
2614
section.get('foo', 'out of thin air'))
2616
def test_options_is_shared(self):
2618
section = config.Section(None, a_dict)
2619
self.assertIs(a_dict, section.options)
2622
class TestMutableSection(tests.TestCase):
2624
scenarios = [('mutable',
2626
lambda opts: config.MutableSection('myID', opts)},),
2630
a_dict = dict(foo='bar')
2631
section = self.get_section(a_dict)
2632
section.set('foo', 'new_value')
2633
self.assertEquals('new_value', section.get('foo'))
2634
# The change appears in the shared section
2635
self.assertEquals('new_value', a_dict.get('foo'))
2636
# We keep track of the change
2637
self.assertTrue('foo' in section.orig)
2638
self.assertEquals('bar', section.orig.get('foo'))
2640
def test_set_preserve_original_once(self):
2641
a_dict = dict(foo='bar')
2642
section = self.get_section(a_dict)
2643
section.set('foo', 'first_value')
2644
section.set('foo', 'second_value')
2645
# We keep track of the original value
2646
self.assertTrue('foo' in section.orig)
2647
self.assertEquals('bar', section.orig.get('foo'))
2649
def test_remove(self):
2650
a_dict = dict(foo='bar')
2651
section = self.get_section(a_dict)
2652
section.remove('foo')
2653
# We get None for unknown options via the default value
2654
self.assertEquals(None, section.get('foo'))
2655
# Or we just get the default value
2656
self.assertEquals('unknown', section.get('foo', 'unknown'))
2657
self.assertFalse('foo' in section.options)
2658
# We keep track of the deletion
2659
self.assertTrue('foo' in section.orig)
2660
self.assertEquals('bar', section.orig.get('foo'))
2662
def test_remove_new_option(self):
2664
section = self.get_section(a_dict)
2665
section.set('foo', 'bar')
2666
section.remove('foo')
2667
self.assertFalse('foo' in section.options)
2668
# The option didn't exist initially so it we need to keep track of it
2669
# with a special value
2670
self.assertTrue('foo' in section.orig)
2671
self.assertEquals(config._NewlyCreatedOption, section.orig['foo'])
2674
class TestCommandLineStore(tests.TestCase):
2677
super(TestCommandLineStore, self).setUp()
2678
self.store = config.CommandLineStore()
2680
def get_section(self):
2681
"""Get the unique section for the command line overrides."""
2682
sections = list(self.store.get_sections())
2683
self.assertLength(1, sections)
2684
store, section = sections[0]
2685
self.assertEquals(self.store, store)
2688
def test_no_override(self):
2689
self.store._from_cmdline([])
2690
section = self.get_section()
2691
self.assertLength(0, list(section.iter_option_names()))
2693
def test_simple_override(self):
2694
self.store._from_cmdline(['a=b'])
2695
section = self.get_section()
2696
self.assertEqual('b', section.get('a'))
2698
def test_list_override(self):
2699
self.store._from_cmdline(['l=1,2,3'])
2700
val = self.get_section().get('l')
2701
self.assertEqual('1,2,3', val)
2702
# Reminder: lists should be registered as such explicitely, otherwise
2703
# the conversion needs to be done afterwards.
2704
self.assertEqual(['1', '2', '3'], config.list_from_store(val))
2706
def test_multiple_overrides(self):
2707
self.store._from_cmdline(['a=b', 'x=y'])
2708
section = self.get_section()
2709
self.assertEquals('b', section.get('a'))
2710
self.assertEquals('y', section.get('x'))
2712
def test_wrong_syntax(self):
2713
self.assertRaises(errors.BzrCommandError,
2714
self.store._from_cmdline, ['a=b', 'c'])
2717
class TestStore(tests.TestCaseWithTransport):
2719
def assertSectionContent(self, expected, (store, section)):
2720
"""Assert that some options have the proper values in a section."""
2721
expected_name, expected_options = expected
2722
self.assertEquals(expected_name, section.id)
2725
dict([(k, section.get(k)) for k in expected_options.keys()]))
2728
class TestReadonlyStore(TestStore):
2730
scenarios = [(key, {'get_store': builder}) for key, builder
2731
in config.test_store_builder_registry.iteritems()]
2733
def test_building_delays_load(self):
2734
store = self.get_store(self)
2735
self.assertEquals(False, store.is_loaded())
2736
store._load_from_string('')
2737
self.assertEquals(True, store.is_loaded())
2739
def test_get_no_sections_for_empty(self):
2740
store = self.get_store(self)
2741
store._load_from_string('')
2742
self.assertEquals([], list(store.get_sections()))
2744
def test_get_default_section(self):
2745
store = self.get_store(self)
2746
store._load_from_string('foo=bar')
2747
sections = list(store.get_sections())
2748
self.assertLength(1, sections)
2749
self.assertSectionContent((None, {'foo': 'bar'}), sections[0])
2751
def test_get_named_section(self):
2752
store = self.get_store(self)
2753
store._load_from_string('[baz]\nfoo=bar')
2754
sections = list(store.get_sections())
2755
self.assertLength(1, sections)
2756
self.assertSectionContent(('baz', {'foo': 'bar'}), sections[0])
2758
def test_load_from_string_fails_for_non_empty_store(self):
2759
store = self.get_store(self)
2760
store._load_from_string('foo=bar')
2761
self.assertRaises(AssertionError, store._load_from_string, 'bar=baz')
2764
class TestIniFileStoreContent(tests.TestCaseWithTransport):
2765
"""Simulate loading a config store with content of various encodings.
2767
All files produced by bzr are in utf8 content.
2769
Users may modify them manually and end up with a file that can't be
2770
loaded. We need to issue proper error messages in this case.
2773
invalid_utf8_char = '\xff'
2775
def test_load_utf8(self):
2776
"""Ensure we can load an utf8-encoded file."""
2777
t = self.get_transport()
2778
# From http://pad.lv/799212
2779
unicode_user = u'b\N{Euro Sign}ar'
2780
unicode_content = u'user=%s' % (unicode_user,)
2781
utf8_content = unicode_content.encode('utf8')
2782
# Store the raw content in the config file
2783
t.put_bytes('foo.conf', utf8_content)
2784
store = config.TransportIniFileStore(t, 'foo.conf')
2786
stack = config.Stack([store.get_sections], store)
2787
self.assertEquals(unicode_user, stack.get('user'))
2789
def test_load_non_ascii(self):
2790
"""Ensure we display a proper error on non-ascii, non utf-8 content."""
2791
t = self.get_transport()
2792
t.put_bytes('foo.conf', 'user=foo\n#%s\n' % (self.invalid_utf8_char,))
2793
store = config.TransportIniFileStore(t, 'foo.conf')
2794
self.assertRaises(errors.ConfigContentError, store.load)
2796
def test_load_erroneous_content(self):
2797
"""Ensure we display a proper error on content that can't be parsed."""
2798
t = self.get_transport()
2799
t.put_bytes('foo.conf', '[open_section\n')
2800
store = config.TransportIniFileStore(t, 'foo.conf')
2801
self.assertRaises(errors.ParseConfigError, store.load)
2803
def test_load_permission_denied(self):
2804
"""Ensure we get warned when trying to load an inaccessible file."""
2807
warnings.append(args[0] % args[1:])
2808
self.overrideAttr(trace, 'warning', warning)
2810
t = self.get_transport()
2812
def get_bytes(relpath):
2813
raise errors.PermissionDenied(relpath, "")
2814
t.get_bytes = get_bytes
2815
store = config.TransportIniFileStore(t, 'foo.conf')
2816
self.assertRaises(errors.PermissionDenied, store.load)
2819
[u'Permission denied while trying to load configuration store %s.'
2820
% store.external_url()])
2823
class TestIniConfigContent(tests.TestCaseWithTransport):
2824
"""Simulate loading a IniBasedConfig with content of various encodings.
2826
All files produced by bzr are in utf8 content.
2828
Users may modify them manually and end up with a file that can't be
2829
loaded. We need to issue proper error messages in this case.
2832
invalid_utf8_char = '\xff'
2834
def test_load_utf8(self):
2835
"""Ensure we can load an utf8-encoded file."""
2836
# From http://pad.lv/799212
2837
unicode_user = u'b\N{Euro Sign}ar'
2838
unicode_content = u'user=%s' % (unicode_user,)
2839
utf8_content = unicode_content.encode('utf8')
2840
# Store the raw content in the config file
2841
with open('foo.conf', 'wb') as f:
2842
f.write(utf8_content)
2843
conf = config.IniBasedConfig(file_name='foo.conf')
2844
self.assertEquals(unicode_user, conf.get_user_option('user'))
2846
def test_load_badly_encoded_content(self):
2847
"""Ensure we display a proper error on non-ascii, non utf-8 content."""
2848
with open('foo.conf', 'wb') as f:
2849
f.write('user=foo\n#%s\n' % (self.invalid_utf8_char,))
2850
conf = config.IniBasedConfig(file_name='foo.conf')
2851
self.assertRaises(errors.ConfigContentError, conf._get_parser)
2853
def test_load_erroneous_content(self):
2854
"""Ensure we display a proper error on content that can't be parsed."""
2855
with open('foo.conf', 'wb') as f:
2856
f.write('[open_section\n')
2857
conf = config.IniBasedConfig(file_name='foo.conf')
2858
self.assertRaises(errors.ParseConfigError, conf._get_parser)
2861
class TestMutableStore(TestStore):
2863
scenarios = [(key, {'store_id': key, 'get_store': builder}) for key, builder
2864
in config.test_store_builder_registry.iteritems()]
2867
super(TestMutableStore, self).setUp()
2868
self.transport = self.get_transport()
2870
def has_store(self, store):
2871
store_basename = urlutils.relative_url(self.transport.external_url(),
2872
store.external_url())
2873
return self.transport.has(store_basename)
2875
def test_save_empty_creates_no_file(self):
2876
# FIXME: There should be a better way than relying on the test
2877
# parametrization to identify branch.conf -- vila 2011-0526
2878
if self.store_id in ('branch', 'remote_branch'):
2879
raise tests.TestNotApplicable(
2880
'branch.conf is *always* created when a branch is initialized')
2881
store = self.get_store(self)
2883
self.assertEquals(False, self.has_store(store))
2885
def test_save_emptied_succeeds(self):
2886
store = self.get_store(self)
2887
store._load_from_string('foo=bar\n')
2888
section = store.get_mutable_section(None)
2889
section.remove('foo')
2891
self.assertEquals(True, self.has_store(store))
2892
modified_store = self.get_store(self)
2893
sections = list(modified_store.get_sections())
2894
self.assertLength(0, sections)
2896
def test_save_with_content_succeeds(self):
2897
# FIXME: There should be a better way than relying on the test
2898
# parametrization to identify branch.conf -- vila 2011-0526
2899
if self.store_id in ('branch', 'remote_branch'):
2900
raise tests.TestNotApplicable(
2901
'branch.conf is *always* created when a branch is initialized')
2902
store = self.get_store(self)
2903
store._load_from_string('foo=bar\n')
2904
self.assertEquals(False, self.has_store(store))
2906
self.assertEquals(True, self.has_store(store))
2907
modified_store = self.get_store(self)
2908
sections = list(modified_store.get_sections())
2909
self.assertLength(1, sections)
2910
self.assertSectionContent((None, {'foo': 'bar'}), sections[0])
2912
def test_set_option_in_empty_store(self):
2913
store = self.get_store(self)
2914
section = store.get_mutable_section(None)
2915
section.set('foo', 'bar')
2917
modified_store = self.get_store(self)
2918
sections = list(modified_store.get_sections())
2919
self.assertLength(1, sections)
2920
self.assertSectionContent((None, {'foo': 'bar'}), sections[0])
2922
def test_set_option_in_default_section(self):
2923
store = self.get_store(self)
2924
store._load_from_string('')
2925
section = store.get_mutable_section(None)
2926
section.set('foo', 'bar')
2928
modified_store = self.get_store(self)
2929
sections = list(modified_store.get_sections())
2930
self.assertLength(1, sections)
2931
self.assertSectionContent((None, {'foo': 'bar'}), sections[0])
2933
def test_set_option_in_named_section(self):
2934
store = self.get_store(self)
2935
store._load_from_string('')
2936
section = store.get_mutable_section('baz')
2937
section.set('foo', 'bar')
2939
modified_store = self.get_store(self)
2940
sections = list(modified_store.get_sections())
2941
self.assertLength(1, sections)
2942
self.assertSectionContent(('baz', {'foo': 'bar'}), sections[0])
2944
def test_load_hook(self):
2945
# We first needs to ensure that the store exists
2946
store = self.get_store(self)
2947
section = store.get_mutable_section('baz')
2948
section.set('foo', 'bar')
2950
# Now we can try to load it
2951
store = self.get_store(self)
2955
config.ConfigHooks.install_named_hook('load', hook, None)
2956
self.assertLength(0, calls)
2958
self.assertLength(1, calls)
2959
self.assertEquals((store,), calls[0])
2961
def test_save_hook(self):
2965
config.ConfigHooks.install_named_hook('save', hook, None)
2966
self.assertLength(0, calls)
2967
store = self.get_store(self)
2968
section = store.get_mutable_section('baz')
2969
section.set('foo', 'bar')
2971
self.assertLength(1, calls)
2972
self.assertEquals((store,), calls[0])
2975
class TestTransportIniFileStore(TestStore):
2977
def test_loading_unknown_file_fails(self):
2978
store = config.TransportIniFileStore(self.get_transport(),
2980
self.assertRaises(errors.NoSuchFile, store.load)
2982
def test_invalid_content(self):
2983
store = config.TransportIniFileStore(self.get_transport(), 'foo.conf')
2984
self.assertEquals(False, store.is_loaded())
2985
exc = self.assertRaises(
2986
errors.ParseConfigError, store._load_from_string,
2987
'this is invalid !')
2988
self.assertEndsWith(exc.filename, 'foo.conf')
2989
# And the load failed
2990
self.assertEquals(False, store.is_loaded())
2992
def test_get_embedded_sections(self):
2993
# A more complicated example (which also shows that section names and
2994
# option names share the same name space...)
2995
# FIXME: This should be fixed by forbidding dicts as values ?
2996
# -- vila 2011-04-05
2997
store = config.TransportIniFileStore(self.get_transport(), 'foo.conf')
2998
store._load_from_string('''
3002
foo_in_DEFAULT=foo_DEFAULT
3010
sections = list(store.get_sections())
3011
self.assertLength(4, sections)
3012
# The default section has no name.
3013
# List values are provided as strings and need to be explicitly
3014
# converted by specifying from_unicode=list_from_store at option
3016
self.assertSectionContent((None, {'foo': 'bar', 'l': u'1,2'}),
3018
self.assertSectionContent(
3019
('DEFAULT', {'foo_in_DEFAULT': 'foo_DEFAULT'}), sections[1])
3020
self.assertSectionContent(
3021
('bar', {'foo_in_bar': 'barbar'}), sections[2])
3022
# sub sections are provided as embedded dicts.
3023
self.assertSectionContent(
3024
('baz', {'foo_in_baz': 'barbaz', 'qux': {'foo_in_qux': 'quux'}}),
3028
class TestLockableIniFileStore(TestStore):
3030
def test_create_store_in_created_dir(self):
3031
self.assertPathDoesNotExist('dir')
3032
t = self.get_transport('dir/subdir')
3033
store = config.LockableIniFileStore(t, 'foo.conf')
3034
store.get_mutable_section(None).set('foo', 'bar')
3036
self.assertPathExists('dir/subdir')
3039
class TestConcurrentStoreUpdates(TestStore):
3040
"""Test that Stores properly handle conccurent updates.
3042
New Store implementation may fail some of these tests but until such
3043
implementations exist it's hard to properly filter them from the scenarios
3044
applied here. If you encounter such a case, contact the bzr devs.
3047
scenarios = [(key, {'get_stack': builder}) for key, builder
3048
in config.test_stack_builder_registry.iteritems()]
3051
super(TestConcurrentStoreUpdates, self).setUp()
3052
self.stack = self.get_stack(self)
3053
if not isinstance(self.stack, config._CompatibleStack):
3054
raise tests.TestNotApplicable(
3055
'%s is not meant to be compatible with the old config design'
3057
self.stack.set('one', '1')
3058
self.stack.set('two', '2')
3060
self.stack.store.save()
3062
def test_simple_read_access(self):
3063
self.assertEquals('1', self.stack.get('one'))
3065
def test_simple_write_access(self):
3066
self.stack.set('one', 'one')
3067
self.assertEquals('one', self.stack.get('one'))
3069
def test_listen_to_the_last_speaker(self):
3071
c2 = self.get_stack(self)
3072
c1.set('one', 'ONE')
3073
c2.set('two', 'TWO')
3074
self.assertEquals('ONE', c1.get('one'))
3075
self.assertEquals('TWO', c2.get('two'))
3076
# The second update respect the first one
3077
self.assertEquals('ONE', c2.get('one'))
3079
def test_last_speaker_wins(self):
3080
# If the same config is not shared, the same variable modified twice
3081
# can only see a single result.
3083
c2 = self.get_stack(self)
3086
self.assertEquals('c2', c2.get('one'))
3087
# The first modification is still available until another refresh
3089
self.assertEquals('c1', c1.get('one'))
3090
c1.set('two', 'done')
3091
self.assertEquals('c2', c1.get('one'))
3093
def test_writes_are_serialized(self):
3095
c2 = self.get_stack(self)
3097
# We spawn a thread that will pause *during* the config saving.
3098
before_writing = threading.Event()
3099
after_writing = threading.Event()
3100
writing_done = threading.Event()
3101
c1_save_without_locking_orig = c1.store.save_without_locking
3102
def c1_save_without_locking():
3103
before_writing.set()
3104
c1_save_without_locking_orig()
3105
# The lock is held. We wait for the main thread to decide when to
3107
after_writing.wait()
3108
c1.store.save_without_locking = c1_save_without_locking
3112
t1 = threading.Thread(target=c1_set)
3113
# Collect the thread after the test
3114
self.addCleanup(t1.join)
3115
# Be ready to unblock the thread if the test goes wrong
3116
self.addCleanup(after_writing.set)
3118
before_writing.wait()
3119
self.assertRaises(errors.LockContention,
3120
c2.set, 'one', 'c2')
3121
self.assertEquals('c1', c1.get('one'))
3122
# Let the lock be released
3126
self.assertEquals('c2', c2.get('one'))
3128
def test_read_while_writing(self):
3130
# We spawn a thread that will pause *during* the write
3131
ready_to_write = threading.Event()
3132
do_writing = threading.Event()
3133
writing_done = threading.Event()
3134
# We override the _save implementation so we know the store is locked
3135
c1_save_without_locking_orig = c1.store.save_without_locking
3136
def c1_save_without_locking():
3137
ready_to_write.set()
3138
# The lock is held. We wait for the main thread to decide when to
3141
c1_save_without_locking_orig()
3143
c1.store.save_without_locking = c1_save_without_locking
3146
t1 = threading.Thread(target=c1_set)
3147
# Collect the thread after the test
3148
self.addCleanup(t1.join)
3149
# Be ready to unblock the thread if the test goes wrong
3150
self.addCleanup(do_writing.set)
3152
# Ensure the thread is ready to write
3153
ready_to_write.wait()
3154
self.assertEquals('c1', c1.get('one'))
3155
# If we read during the write, we get the old value
3156
c2 = self.get_stack(self)
3157
self.assertEquals('1', c2.get('one'))
3158
# Let the writing occur and ensure it occurred
3161
# Now we get the updated value
3162
c3 = self.get_stack(self)
3163
self.assertEquals('c1', c3.get('one'))
3165
# FIXME: It may be worth looking into removing the lock dir when it's not
3166
# needed anymore and look at possible fallouts for concurrent lockers. This
3167
# will matter if/when we use config files outside of bazaar directories
3168
# (.bazaar or .bzr) -- vila 20110-04-111
3171
class TestSectionMatcher(TestStore):
3173
scenarios = [('location', {'matcher': config.LocationMatcher}),
3174
('id', {'matcher': config.NameMatcher}),]
3177
super(TestSectionMatcher, self).setUp()
3178
# Any simple store is good enough
3179
self.get_store = config.test_store_builder_registry.get('configobj')
3181
def test_no_matches_for_empty_stores(self):
3182
store = self.get_store(self)
3183
store._load_from_string('')
3184
matcher = self.matcher(store, '/bar')
3185
self.assertEquals([], list(matcher.get_sections()))
3187
def test_build_doesnt_load_store(self):
3188
store = self.get_store(self)
3189
matcher = self.matcher(store, '/bar')
3190
self.assertFalse(store.is_loaded())
3193
class TestLocationSection(tests.TestCase):
3195
def get_section(self, options, extra_path):
3196
section = config.Section('foo', options)
3197
# We don't care about the length so we use '0'
3198
return config.LocationSection(section, 0, extra_path)
3200
def test_simple_option(self):
3201
section = self.get_section({'foo': 'bar'}, '')
3202
self.assertEquals('bar', section.get('foo'))
3204
def test_option_with_extra_path(self):
3205
section = self.get_section({'foo': 'bar', 'foo:policy': 'appendpath'},
3207
self.assertEquals('bar/baz', section.get('foo'))
3209
def test_invalid_policy(self):
3210
section = self.get_section({'foo': 'bar', 'foo:policy': 'die'},
3212
# invalid policies are ignored
3213
self.assertEquals('bar', section.get('foo'))
3216
class TestLocationMatcher(TestStore):
3219
super(TestLocationMatcher, self).setUp()
3220
# Any simple store is good enough
3221
self.get_store = config.test_store_builder_registry.get('configobj')
3223
def test_unrelated_section_excluded(self):
3224
store = self.get_store(self)
3225
store._load_from_string('''
3233
section=/foo/bar/baz
3237
self.assertEquals(['/foo', '/foo/baz', '/foo/bar', '/foo/bar/baz',
3239
[section.id for _, section in store.get_sections()])
3240
matcher = config.LocationMatcher(store, '/foo/bar/quux')
3241
sections = [section for s, section in matcher.get_sections()]
3242
self.assertEquals([3, 2],
3243
[section.length for section in sections])
3244
self.assertEquals(['/foo/bar', '/foo'],
3245
[section.id for section in sections])
3246
self.assertEquals(['quux', 'bar/quux'],
3247
[section.extra_path for section in sections])
3249
def test_more_specific_sections_first(self):
3250
store = self.get_store(self)
3251
store._load_from_string('''
3257
self.assertEquals(['/foo', '/foo/bar'],
3258
[section.id for _, section in store.get_sections()])
3259
matcher = config.LocationMatcher(store, '/foo/bar/baz')
3260
sections = [section for s, section in matcher.get_sections()]
3261
self.assertEquals([3, 2],
3262
[section.length for section in sections])
3263
self.assertEquals(['/foo/bar', '/foo'],
3264
[section.id for section in sections])
3265
self.assertEquals(['baz', 'bar/baz'],
3266
[section.extra_path for section in sections])
3268
def test_appendpath_in_no_name_section(self):
3269
# It's a bit weird to allow appendpath in a no-name section, but
3270
# someone may found a use for it
3271
store = self.get_store(self)
3272
store._load_from_string('''
3274
foo:policy = appendpath
3276
matcher = config.LocationMatcher(store, 'dir/subdir')
3277
sections = list(matcher.get_sections())
3278
self.assertLength(1, sections)
3279
self.assertEquals('bar/dir/subdir', sections[0][1].get('foo'))
3281
def test_file_urls_are_normalized(self):
3282
store = self.get_store(self)
3283
if sys.platform == 'win32':
3284
expected_url = 'file:///C:/dir/subdir'
3285
expected_location = 'C:/dir/subdir'
3287
expected_url = 'file:///dir/subdir'
3288
expected_location = '/dir/subdir'
3289
matcher = config.LocationMatcher(store, expected_url)
3290
self.assertEquals(expected_location, matcher.location)
3293
class TestNameMatcher(TestStore):
3296
super(TestNameMatcher, self).setUp()
3297
self.matcher = config.NameMatcher
3298
# Any simple store is good enough
3299
self.get_store = config.test_store_builder_registry.get('configobj')
3301
def get_matching_sections(self, name):
3302
store = self.get_store(self)
3303
store._load_from_string('''
3311
matcher = self.matcher(store, name)
3312
return list(matcher.get_sections())
3314
def test_matching(self):
3315
sections = self.get_matching_sections('foo')
3316
self.assertLength(1, sections)
3317
self.assertSectionContent(('foo', {'option': 'foo'}), sections[0])
3319
def test_not_matching(self):
3320
sections = self.get_matching_sections('baz')
3321
self.assertLength(0, sections)
3324
class TestStackGet(tests.TestCase):
3326
# FIXME: This should be parametrized for all known Stack or dedicated
3327
# paramerized tests created to avoid bloating -- vila 2011-03-31
3329
def overrideOptionRegistry(self):
3330
self.overrideAttr(config, 'option_registry', config.OptionRegistry())
3332
def test_single_config_get(self):
3333
conf = dict(foo='bar')
3334
conf_stack = config.Stack([conf])
3335
self.assertEquals('bar', conf_stack.get('foo'))
3337
def test_get_with_registered_default_value(self):
3338
conf_stack = config.Stack([dict()])
3339
opt = config.Option('foo', default='bar')
3340
self.overrideOptionRegistry()
3341
config.option_registry.register('foo', opt)
3342
self.assertEquals('bar', conf_stack.get('foo'))
3344
def test_get_without_registered_default_value(self):
3345
conf_stack = config.Stack([dict()])
3346
opt = config.Option('foo')
3347
self.overrideOptionRegistry()
3348
config.option_registry.register('foo', opt)
3349
self.assertEquals(None, conf_stack.get('foo'))
3351
def test_get_without_default_value_for_not_registered(self):
3352
conf_stack = config.Stack([dict()])
3353
opt = config.Option('foo')
3354
self.overrideOptionRegistry()
3355
self.assertEquals(None, conf_stack.get('foo'))
3357
def test_get_first_definition(self):
3358
conf1 = dict(foo='bar')
3359
conf2 = dict(foo='baz')
3360
conf_stack = config.Stack([conf1, conf2])
3361
self.assertEquals('bar', conf_stack.get('foo'))
3363
def test_get_embedded_definition(self):
3364
conf1 = dict(yy='12')
3365
conf2 = config.Stack([dict(xx='42'), dict(foo='baz')])
3366
conf_stack = config.Stack([conf1, conf2])
3367
self.assertEquals('baz', conf_stack.get('foo'))
3369
def test_get_for_empty_section_callable(self):
3370
conf_stack = config.Stack([lambda : []])
3371
self.assertEquals(None, conf_stack.get('foo'))
3373
def test_get_for_broken_callable(self):
3374
# Trying to use and invalid callable raises an exception on first use
3375
conf_stack = config.Stack([lambda : object()])
3376
self.assertRaises(TypeError, conf_stack.get, 'foo')
3379
class TestStackWithTransport(tests.TestCaseWithTransport):
3381
scenarios = [(key, {'get_stack': builder}) for key, builder
3382
in config.test_stack_builder_registry.iteritems()]
3385
class TestConcreteStacks(TestStackWithTransport):
3387
def test_build_stack(self):
3388
# Just a smoke test to help debug builders
3389
stack = self.get_stack(self)
3392
class TestStackGet(TestStackWithTransport):
3395
super(TestStackGet, self).setUp()
3396
self.conf = self.get_stack(self)
3398
def test_get_for_empty_stack(self):
3399
self.assertEquals(None, self.conf.get('foo'))
3401
def test_get_hook(self):
3402
self.conf.set('foo', 'bar')
3406
config.ConfigHooks.install_named_hook('get', hook, None)
3407
self.assertLength(0, calls)
3408
value = self.conf.get('foo')
3409
self.assertEquals('bar', value)
3410
self.assertLength(1, calls)
3411
self.assertEquals((self.conf, 'foo', 'bar'), calls[0])
3414
class TestStackGetWithConverter(tests.TestCaseWithTransport):
3417
super(TestStackGetWithConverter, self).setUp()
3418
self.overrideAttr(config, 'option_registry', config.OptionRegistry())
3419
self.registry = config.option_registry
3420
# We just want a simple stack with a simple store so we can inject
3421
# whatever content the tests need without caring about what section
3422
# names are valid for a given store/stack.
3423
store = config.TransportIniFileStore(self.get_transport(), 'foo.conf')
3424
self.conf = config.Stack([store.get_sections], store)
3426
def register_bool_option(self, name, default=None, default_from_env=None):
3427
b = config.Option(name, help='A boolean.',
3428
default=default, default_from_env=default_from_env,
3429
from_unicode=config.bool_from_store)
3430
self.registry.register(b)
3432
def test_get_default_bool_None(self):
3433
self.register_bool_option('foo')
3434
self.assertEquals(None, self.conf.get('foo'))
3436
def test_get_default_bool_True(self):
3437
self.register_bool_option('foo', u'True')
3438
self.assertEquals(True, self.conf.get('foo'))
3440
def test_get_default_bool_False(self):
3441
self.register_bool_option('foo', False)
3442
self.assertEquals(False, self.conf.get('foo'))
3444
def test_get_default_bool_False_as_string(self):
3445
self.register_bool_option('foo', u'False')
3446
self.assertEquals(False, self.conf.get('foo'))
3448
def test_get_default_bool_from_env_converted(self):
3449
self.register_bool_option('foo', u'True', default_from_env=['FOO'])
3450
self.overrideEnv('FOO', 'False')
3451
self.assertEquals(False, self.conf.get('foo'))
3453
def test_get_default_bool_when_conversion_fails(self):
3454
self.register_bool_option('foo', default='True')
3455
self.conf.store._load_from_string('foo=invalid boolean')
3456
self.assertEquals(True, self.conf.get('foo'))
3458
def register_integer_option(self, name,
3459
default=None, default_from_env=None):
3460
i = config.Option(name, help='An integer.',
3461
default=default, default_from_env=default_from_env,
3462
from_unicode=config.int_from_store)
3463
self.registry.register(i)
3465
def test_get_default_integer_None(self):
3466
self.register_integer_option('foo')
3467
self.assertEquals(None, self.conf.get('foo'))
3469
def test_get_default_integer(self):
3470
self.register_integer_option('foo', 42)
3471
self.assertEquals(42, self.conf.get('foo'))
3473
def test_get_default_integer_as_string(self):
3474
self.register_integer_option('foo', u'42')
3475
self.assertEquals(42, self.conf.get('foo'))
3477
def test_get_default_integer_from_env(self):
3478
self.register_integer_option('foo', default_from_env=['FOO'])
3479
self.overrideEnv('FOO', '18')
3480
self.assertEquals(18, self.conf.get('foo'))
3482
def test_get_default_integer_when_conversion_fails(self):
3483
self.register_integer_option('foo', default='12')
3484
self.conf.store._load_from_string('foo=invalid integer')
3485
self.assertEquals(12, self.conf.get('foo'))
3487
def register_list_option(self, name, default=None, default_from_env=None):
3488
l = config.Option(name, help='A list.',
3489
default=default, default_from_env=default_from_env,
3490
from_unicode=config.list_from_store)
3491
self.registry.register(l)
3493
def test_get_default_list_None(self):
3494
self.register_list_option('foo')
3495
self.assertEquals(None, self.conf.get('foo'))
3497
def test_get_default_list_empty(self):
3498
self.register_list_option('foo', '')
3499
self.assertEquals([], self.conf.get('foo'))
3501
def test_get_default_list_from_env(self):
3502
self.register_list_option('foo', default_from_env=['FOO'])
3503
self.overrideEnv('FOO', '')
3504
self.assertEquals([], self.conf.get('foo'))
3506
def test_get_with_list_converter_no_item(self):
3507
self.register_list_option('foo', None)
3508
self.conf.store._load_from_string('foo=,')
3509
self.assertEquals([], self.conf.get('foo'))
3511
def test_get_with_list_converter_many_items(self):
3512
self.register_list_option('foo', None)
3513
self.conf.store._load_from_string('foo=m,o,r,e')
3514
self.assertEquals(['m', 'o', 'r', 'e'], self.conf.get('foo'))
3516
def test_get_with_list_converter_embedded_spaces_many_items(self):
3517
self.register_list_option('foo', None)
3518
self.conf.store._load_from_string('foo=" bar", "baz "')
3519
self.assertEquals([' bar', 'baz '], self.conf.get('foo'))
3521
def test_get_with_list_converter_stripped_spaces_many_items(self):
3522
self.register_list_option('foo', None)
3523
self.conf.store._load_from_string('foo= bar , baz ')
3524
self.assertEquals(['bar', 'baz'], self.conf.get('foo'))
3527
class TestIterOptionRefs(tests.TestCase):
3528
"""iter_option_refs is a bit unusual, document some cases."""
3530
def assertRefs(self, expected, string):
3531
self.assertEquals(expected, list(config.iter_option_refs(string)))
3533
def test_empty(self):
3534
self.assertRefs([(False, '')], '')
3536
def test_no_refs(self):
3537
self.assertRefs([(False, 'foo bar')], 'foo bar')
3539
def test_single_ref(self):
3540
self.assertRefs([(False, ''), (True, '{foo}'), (False, '')], '{foo}')
3542
def test_broken_ref(self):
3543
self.assertRefs([(False, '{foo')], '{foo')
3545
def test_embedded_ref(self):
3546
self.assertRefs([(False, '{'), (True, '{foo}'), (False, '}')],
3549
def test_two_refs(self):
3550
self.assertRefs([(False, ''), (True, '{foo}'),
3551
(False, ''), (True, '{bar}'),
3555
def test_newline_in_refs_are_not_matched(self):
3556
self.assertRefs([(False, '{\nxx}{xx\n}{{\n}}')], '{\nxx}{xx\n}{{\n}}')
3559
class TestStackExpandOptions(tests.TestCaseWithTransport):
3562
super(TestStackExpandOptions, self).setUp()
3563
self.overrideAttr(config, 'option_registry', config.OptionRegistry())
3564
self.registry = config.option_registry
3565
self.conf = build_branch_stack(self)
3567
def assertExpansion(self, expected, string, env=None):
3568
self.assertEquals(expected, self.conf.expand_options(string, env))
3570
def test_no_expansion(self):
3571
self.assertExpansion('foo', 'foo')
3573
def test_expand_default_value(self):
3574
self.conf.store._load_from_string('bar=baz')
3575
self.registry.register(config.Option('foo', default=u'{bar}'))
3576
self.assertEquals('baz', self.conf.get('foo', expand=True))
3578
def test_expand_default_from_env(self):
3579
self.conf.store._load_from_string('bar=baz')
3580
self.registry.register(config.Option('foo', default_from_env=['FOO']))
3581
self.overrideEnv('FOO', '{bar}')
3582
self.assertEquals('baz', self.conf.get('foo', expand=True))
3584
def test_expand_default_on_failed_conversion(self):
3585
self.conf.store._load_from_string('baz=bogus\nbar=42\nfoo={baz}')
3586
self.registry.register(
3587
config.Option('foo', default=u'{bar}',
3588
from_unicode=config.int_from_store))
3589
self.assertEquals(42, self.conf.get('foo', expand=True))
3591
def test_env_adding_options(self):
3592
self.assertExpansion('bar', '{foo}', {'foo': 'bar'})
3594
def test_env_overriding_options(self):
3595
self.conf.store._load_from_string('foo=baz')
3596
self.assertExpansion('bar', '{foo}', {'foo': 'bar'})
3598
def test_simple_ref(self):
3599
self.conf.store._load_from_string('foo=xxx')
3600
self.assertExpansion('xxx', '{foo}')
3602
def test_unknown_ref(self):
3603
self.assertRaises(errors.ExpandingUnknownOption,
3604
self.conf.expand_options, '{foo}')
3606
def test_indirect_ref(self):
3607
self.conf.store._load_from_string('''
3611
self.assertExpansion('xxx', '{bar}')
3613
def test_embedded_ref(self):
3614
self.conf.store._load_from_string('''
3618
self.assertExpansion('xxx', '{{bar}}')
3620
def test_simple_loop(self):
3621
self.conf.store._load_from_string('foo={foo}')
3622
self.assertRaises(errors.OptionExpansionLoop,
3623
self.conf.expand_options, '{foo}')
3625
def test_indirect_loop(self):
3626
self.conf.store._load_from_string('''
3630
e = self.assertRaises(errors.OptionExpansionLoop,
3631
self.conf.expand_options, '{foo}')
3632
self.assertEquals('foo->bar->baz', e.refs)
3633
self.assertEquals('{foo}', e.string)
3635
def test_list(self):
3636
self.conf.store._load_from_string('''
3640
list={foo},{bar},{baz}
3642
self.registry.register(
3643
config.Option('list', from_unicode=config.list_from_store))
3644
self.assertEquals(['start', 'middle', 'end'],
3645
self.conf.get('list', expand=True))
3647
def test_cascading_list(self):
3648
self.conf.store._load_from_string('''
3654
self.registry.register(
3655
config.Option('list', from_unicode=config.list_from_store))
3656
self.assertEquals(['start', 'middle', 'end'],
3657
self.conf.get('list', expand=True))
3659
def test_pathologically_hidden_list(self):
3660
self.conf.store._load_from_string('''
3666
hidden={start}{middle}{end}
3668
# What matters is what the registration says, the conversion happens
3669
# only after all expansions have been performed
3670
self.registry.register(
3671
config.Option('hidden', from_unicode=config.list_from_store))
3672
self.assertEquals(['bin', 'go'],
3673
self.conf.get('hidden', expand=True))
3676
class TestStackCrossSectionsExpand(tests.TestCaseWithTransport):
3679
super(TestStackCrossSectionsExpand, self).setUp()
3681
def get_config(self, location, string):
3684
# Since we don't save the config we won't strictly require to inherit
3685
# from TestCaseInTempDir, but an error occurs so quickly...
3686
c = config.LocationStack(location)
3687
c.store._load_from_string(string)
3690
def test_dont_cross_unrelated_section(self):
3691
c = self.get_config('/another/branch/path','''
3696
[/another/branch/path]
3699
self.assertRaises(errors.ExpandingUnknownOption,
3700
c.get, 'bar', expand=True)
3702
def test_cross_related_sections(self):
3703
c = self.get_config('/project/branch/path','''
3707
[/project/branch/path]
3710
self.assertEquals('quux', c.get('bar', expand=True))
3713
class TestStackCrossStoresExpand(tests.TestCaseWithTransport):
3715
def test_cross_global_locations(self):
3716
l_store = config.LocationStore()
3717
l_store._load_from_string('''
3723
g_store = config.GlobalStore()
3724
g_store._load_from_string('''
3730
stack = config.LocationStack('/branch')
3731
self.assertEquals('glob-bar', stack.get('lbar', expand=True))
3732
self.assertEquals('loc-foo', stack.get('gfoo', expand=True))
3735
class TestStackExpandSectionLocals(tests.TestCaseWithTransport):
3737
def test_expand_locals_empty(self):
3738
l_store = config.LocationStore()
3739
l_store._load_from_string('''
3740
[/home/user/project]
3745
stack = config.LocationStack('/home/user/project/')
3746
self.assertEquals('', stack.get('base', expand=True))
3747
self.assertEquals('', stack.get('rel', expand=True))
3749
def test_expand_basename_locally(self):
3750
l_store = config.LocationStore()
3751
l_store._load_from_string('''
3752
[/home/user/project]
3756
stack = config.LocationStack('/home/user/project/branch')
3757
self.assertEquals('branch', stack.get('bfoo', expand=True))
3759
def test_expand_basename_locally_longer_path(self):
3760
l_store = config.LocationStore()
3761
l_store._load_from_string('''
3766
stack = config.LocationStack('/home/user/project/dir/branch')
3767
self.assertEquals('branch', stack.get('bfoo', expand=True))
3769
def test_expand_relpath_locally(self):
3770
l_store = config.LocationStore()
3771
l_store._load_from_string('''
3772
[/home/user/project]
3773
lfoo = loc-foo/{relpath}
3776
stack = config.LocationStack('/home/user/project/branch')
3777
self.assertEquals('loc-foo/branch', stack.get('lfoo', expand=True))
3779
def test_expand_relpath_unknonw_in_global(self):
3780
g_store = config.GlobalStore()
3781
g_store._load_from_string('''
3786
stack = config.LocationStack('/home/user/project/branch')
3787
self.assertRaises(errors.ExpandingUnknownOption,
3788
stack.get, 'gfoo', expand=True)
3790
def test_expand_local_option_locally(self):
3791
l_store = config.LocationStore()
3792
l_store._load_from_string('''
3793
[/home/user/project]
3794
lfoo = loc-foo/{relpath}
3798
g_store = config.GlobalStore()
3799
g_store._load_from_string('''
3805
stack = config.LocationStack('/home/user/project/branch')
3806
self.assertEquals('glob-bar', stack.get('lbar', expand=True))
3807
self.assertEquals('loc-foo/branch', stack.get('gfoo', expand=True))
3809
def test_locals_dont_leak(self):
3810
"""Make sure we chose the right local in presence of several sections.
3812
l_store = config.LocationStore()
3813
l_store._load_from_string('''
3815
lfoo = loc-foo/{relpath}
3816
[/home/user/project]
3817
lfoo = loc-foo/{relpath}
3820
stack = config.LocationStack('/home/user/project/branch')
3821
self.assertEquals('loc-foo/branch', stack.get('lfoo', expand=True))
3822
stack = config.LocationStack('/home/user/bar/baz')
3823
self.assertEquals('loc-foo/bar/baz', stack.get('lfoo', expand=True))
3827
class TestStackSet(TestStackWithTransport):
3829
def test_simple_set(self):
3830
conf = self.get_stack(self)
3831
self.assertEquals(None, conf.get('foo'))
3832
conf.set('foo', 'baz')
3833
# Did we get it back ?
3834
self.assertEquals('baz', conf.get('foo'))
3836
def test_set_creates_a_new_section(self):
3837
conf = self.get_stack(self)
3838
conf.set('foo', 'baz')
3839
self.assertEquals, 'baz', conf.get('foo')
3841
def test_set_hook(self):
3845
config.ConfigHooks.install_named_hook('set', hook, None)
3846
self.assertLength(0, calls)
3847
conf = self.get_stack(self)
3848
conf.set('foo', 'bar')
3849
self.assertLength(1, calls)
3850
self.assertEquals((conf, 'foo', 'bar'), calls[0])
3853
class TestStackRemove(TestStackWithTransport):
3855
def test_remove_existing(self):
3856
conf = self.get_stack(self)
3857
conf.set('foo', 'bar')
3858
self.assertEquals('bar', conf.get('foo'))
3860
# Did we get it back ?
3861
self.assertEquals(None, conf.get('foo'))
3863
def test_remove_unknown(self):
3864
conf = self.get_stack(self)
3865
self.assertRaises(KeyError, conf.remove, 'I_do_not_exist')
3867
def test_remove_hook(self):
3871
config.ConfigHooks.install_named_hook('remove', hook, None)
3872
self.assertLength(0, calls)
3873
conf = self.get_stack(self)
3874
conf.set('foo', 'bar')
3876
self.assertLength(1, calls)
3877
self.assertEquals((conf, 'foo'), calls[0])
3880
class TestConfigGetOptions(tests.TestCaseWithTransport, TestOptionsMixin):
3883
super(TestConfigGetOptions, self).setUp()
3884
create_configs(self)
3886
def test_no_variable(self):
3887
# Using branch should query branch, locations and bazaar
3888
self.assertOptions([], self.branch_config)
3890
def test_option_in_bazaar(self):
3891
self.bazaar_config.set_user_option('file', 'bazaar')
3892
self.assertOptions([('file', 'bazaar', 'DEFAULT', 'bazaar')],
3895
def test_option_in_locations(self):
3896
self.locations_config.set_user_option('file', 'locations')
3898
[('file', 'locations', self.tree.basedir, 'locations')],
3899
self.locations_config)
3901
def test_option_in_branch(self):
3902
self.branch_config.set_user_option('file', 'branch')
3903
self.assertOptions([('file', 'branch', 'DEFAULT', 'branch')],
3906
def test_option_in_bazaar_and_branch(self):
3907
self.bazaar_config.set_user_option('file', 'bazaar')
3908
self.branch_config.set_user_option('file', 'branch')
3909
self.assertOptions([('file', 'branch', 'DEFAULT', 'branch'),
3910
('file', 'bazaar', 'DEFAULT', 'bazaar'),],
3913
def test_option_in_branch_and_locations(self):
3914
# Hmm, locations override branch :-/
3915
self.locations_config.set_user_option('file', 'locations')
3916
self.branch_config.set_user_option('file', 'branch')
3918
[('file', 'locations', self.tree.basedir, 'locations'),
3919
('file', 'branch', 'DEFAULT', 'branch'),],
3922
def test_option_in_bazaar_locations_and_branch(self):
3923
self.bazaar_config.set_user_option('file', 'bazaar')
3924
self.locations_config.set_user_option('file', 'locations')
3925
self.branch_config.set_user_option('file', 'branch')
3927
[('file', 'locations', self.tree.basedir, 'locations'),
3928
('file', 'branch', 'DEFAULT', 'branch'),
3929
('file', 'bazaar', 'DEFAULT', 'bazaar'),],
3933
class TestConfigRemoveOption(tests.TestCaseWithTransport, TestOptionsMixin):
3936
super(TestConfigRemoveOption, self).setUp()
3937
create_configs_with_file_option(self)
3939
def test_remove_in_locations(self):
3940
self.locations_config.remove_user_option('file', self.tree.basedir)
3942
[('file', 'branch', 'DEFAULT', 'branch'),
3943
('file', 'bazaar', 'DEFAULT', 'bazaar'),],
3946
def test_remove_in_branch(self):
3947
self.branch_config.remove_user_option('file')
3949
[('file', 'locations', self.tree.basedir, 'locations'),
3950
('file', 'bazaar', 'DEFAULT', 'bazaar'),],
3953
def test_remove_in_bazaar(self):
3954
self.bazaar_config.remove_user_option('file')
3956
[('file', 'locations', self.tree.basedir, 'locations'),
3957
('file', 'branch', 'DEFAULT', 'branch'),],
3961
class TestConfigGetSections(tests.TestCaseWithTransport):
3964
super(TestConfigGetSections, self).setUp()
3965
create_configs(self)
3967
def assertSectionNames(self, expected, conf, name=None):
3968
"""Check which sections are returned for a given config.
3970
If fallback configurations exist their sections can be included.
3972
:param expected: A list of section names.
3974
:param conf: The configuration that will be queried.
3976
:param name: An optional section name that will be passed to
3979
sections = list(conf._get_sections(name))
3980
self.assertLength(len(expected), sections)
3981
self.assertEqual(expected, [name for name, _, _ in sections])
3983
def test_bazaar_default_section(self):
3984
self.assertSectionNames(['DEFAULT'], self.bazaar_config)
3986
def test_locations_default_section(self):
3987
# No sections are defined in an empty file
3988
self.assertSectionNames([], self.locations_config)
3990
def test_locations_named_section(self):
3991
self.locations_config.set_user_option('file', 'locations')
3992
self.assertSectionNames([self.tree.basedir], self.locations_config)
3994
def test_locations_matching_sections(self):
3995
loc_config = self.locations_config
3996
loc_config.set_user_option('file', 'locations')
3997
# We need to cheat a bit here to create an option in sections above and
3998
# below the 'location' one.
3999
parser = loc_config._get_parser()
4000
# locations.cong deals with '/' ignoring native os.sep
4001
location_names = self.tree.basedir.split('/')
4002
parent = '/'.join(location_names[:-1])
4003
child = '/'.join(location_names + ['child'])
4005
parser[parent]['file'] = 'parent'
4007
parser[child]['file'] = 'child'
4008
self.assertSectionNames([self.tree.basedir, parent], loc_config)
4010
def test_branch_data_default_section(self):
4011
self.assertSectionNames([None],
4012
self.branch_config._get_branch_data_config())
4014
def test_branch_default_sections(self):
4015
# No sections are defined in an empty locations file
4016
self.assertSectionNames([None, 'DEFAULT'],
4018
# Unless we define an option
4019
self.branch_config._get_location_config().set_user_option(
4020
'file', 'locations')
4021
self.assertSectionNames([self.tree.basedir, None, 'DEFAULT'],
4024
def test_bazaar_named_section(self):
4025
# We need to cheat as the API doesn't give direct access to sections
4026
# other than DEFAULT.
4027
self.bazaar_config.set_alias('bazaar', 'bzr')
4028
self.assertSectionNames(['ALIASES'], self.bazaar_config, 'ALIASES')
4031
class TestAuthenticationConfigFile(tests.TestCase):
4032
"""Test the authentication.conf file matching"""
4034
def _got_user_passwd(self, expected_user, expected_password,
4035
config, *args, **kwargs):
4036
credentials = config.get_credentials(*args, **kwargs)
4037
if credentials is None:
4041
user = credentials['user']
4042
password = credentials['password']
4043
self.assertEquals(expected_user, user)
4044
self.assertEquals(expected_password, password)
4046
def test_empty_config(self):
4047
conf = config.AuthenticationConfig(_file=StringIO())
4048
self.assertEquals({}, conf._get_config())
4049
self._got_user_passwd(None, None, conf, 'http', 'foo.net')
4051
def test_non_utf8_config(self):
4052
conf = config.AuthenticationConfig(_file=StringIO(
4054
self.assertRaises(errors.ConfigContentError, conf._get_config)
4056
def test_missing_auth_section_header(self):
4057
conf = config.AuthenticationConfig(_file=StringIO('foo = bar'))
4058
self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
4060
def test_auth_section_header_not_closed(self):
4061
conf = config.AuthenticationConfig(_file=StringIO('[DEF'))
4062
self.assertRaises(errors.ParseConfigError, conf._get_config)
4064
def test_auth_value_not_boolean(self):
4065
conf = config.AuthenticationConfig(_file=StringIO(
4069
verify_certificates=askme # Error: Not a boolean
4071
self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
4073
def test_auth_value_not_int(self):
4074
conf = config.AuthenticationConfig(_file=StringIO(
4078
port=port # Error: Not an int
4080
self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
4082
def test_unknown_password_encoding(self):
4083
conf = config.AuthenticationConfig(_file=StringIO(
4087
password_encoding=unknown
4089
self.assertRaises(ValueError, conf.get_password,
4090
'ftp', 'foo.net', 'joe')
4092
def test_credentials_for_scheme_host(self):
4093
conf = config.AuthenticationConfig(_file=StringIO(
4094
"""# Identity on foo.net
4099
password=secret-pass
4102
self._got_user_passwd('joe', 'secret-pass', conf, 'ftp', 'foo.net')
4104
self._got_user_passwd(None, None, conf, 'http', 'foo.net')
4106
self._got_user_passwd(None, None, conf, 'ftp', 'bar.net')
4108
def test_credentials_for_host_port(self):
4109
conf = config.AuthenticationConfig(_file=StringIO(
4110
"""# Identity on foo.net
4116
password=secret-pass
4119
self._got_user_passwd('joe', 'secret-pass',
4120
conf, 'ftp', 'foo.net', port=10021)
4122
self._got_user_passwd(None, None, conf, 'ftp', 'foo.net')
4124
def test_for_matching_host(self):
4125
conf = config.AuthenticationConfig(_file=StringIO(
4126
"""# Identity on foo.net
4132
[sourceforge domain]
4139
self._got_user_passwd('georges', 'bendover',
4140
conf, 'bzr', 'foo.bzr.sf.net')
4142
self._got_user_passwd(None, None,
4143
conf, 'bzr', 'bbzr.sf.net')
4145
def test_for_matching_host_None(self):
4146
conf = config.AuthenticationConfig(_file=StringIO(
4147
"""# Identity on foo.net
4157
self._got_user_passwd('joe', 'joepass',
4158
conf, 'bzr', 'quux.net')
4159
# no host but different scheme
4160
self._got_user_passwd('georges', 'bendover',
4161
conf, 'ftp', 'quux.net')
4163
def test_credentials_for_path(self):
4164
conf = config.AuthenticationConfig(_file=StringIO(
4180
self._got_user_passwd(None, None,
4181
conf, 'http', host='bar.org', path='/dir3')
4183
self._got_user_passwd('georges', 'bendover',
4184
conf, 'http', host='bar.org', path='/dir2')
4186
self._got_user_passwd('jim', 'jimpass',
4187
conf, 'http', host='bar.org',path='/dir1/subdir')
4189
def test_credentials_for_user(self):
4190
conf = config.AuthenticationConfig(_file=StringIO(
4199
self._got_user_passwd('jim', 'jimpass',
4200
conf, 'http', 'bar.org')
4202
self._got_user_passwd('jim', 'jimpass',
4203
conf, 'http', 'bar.org', user='jim')
4204
# Don't get a different user if one is specified
4205
self._got_user_passwd(None, None,
4206
conf, 'http', 'bar.org', user='georges')
4208
def test_credentials_for_user_without_password(self):
4209
conf = config.AuthenticationConfig(_file=StringIO(
4216
# Get user but no password
4217
self._got_user_passwd('jim', None,
4218
conf, 'http', 'bar.org')
4220
def test_verify_certificates(self):
4221
conf = config.AuthenticationConfig(_file=StringIO(
4228
verify_certificates=False
4235
credentials = conf.get_credentials('https', 'bar.org')
4236
self.assertEquals(False, credentials.get('verify_certificates'))
4237
credentials = conf.get_credentials('https', 'foo.net')
4238
self.assertEquals(True, credentials.get('verify_certificates'))
4241
class TestAuthenticationStorage(tests.TestCaseInTempDir):
4243
def test_set_credentials(self):
4244
conf = config.AuthenticationConfig()
4245
conf.set_credentials('name', 'host', 'user', 'scheme', 'password',
4246
99, path='/foo', verify_certificates=False, realm='realm')
4247
credentials = conf.get_credentials(host='host', scheme='scheme',
4248
port=99, path='/foo',
4250
CREDENTIALS = {'name': 'name', 'user': 'user', 'password': 'password',
4251
'verify_certificates': False, 'scheme': 'scheme',
4252
'host': 'host', 'port': 99, 'path': '/foo',
4254
self.assertEqual(CREDENTIALS, credentials)
4255
credentials_from_disk = config.AuthenticationConfig().get_credentials(
4256
host='host', scheme='scheme', port=99, path='/foo', realm='realm')
4257
self.assertEqual(CREDENTIALS, credentials_from_disk)
4259
def test_reset_credentials_different_name(self):
4260
conf = config.AuthenticationConfig()
4261
conf.set_credentials('name', 'host', 'user', 'scheme', 'password'),
4262
conf.set_credentials('name2', 'host', 'user2', 'scheme', 'password'),
4263
self.assertIs(None, conf._get_config().get('name'))
4264
credentials = conf.get_credentials(host='host', scheme='scheme')
4265
CREDENTIALS = {'name': 'name2', 'user': 'user2', 'password':
4266
'password', 'verify_certificates': True,
4267
'scheme': 'scheme', 'host': 'host', 'port': None,
4268
'path': None, 'realm': None}
4269
self.assertEqual(CREDENTIALS, credentials)
4272
class TestAuthenticationConfig(tests.TestCase):
4273
"""Test AuthenticationConfig behaviour"""
4275
def _check_default_password_prompt(self, expected_prompt_format, scheme,
4276
host=None, port=None, realm=None,
4280
user, password = 'jim', 'precious'
4281
expected_prompt = expected_prompt_format % {
4282
'scheme': scheme, 'host': host, 'port': port,
4283
'user': user, 'realm': realm}
4285
stdout = tests.StringIOWrapper()
4286
stderr = tests.StringIOWrapper()
4287
ui.ui_factory = tests.TestUIFactory(stdin=password + '\n',
4288
stdout=stdout, stderr=stderr)
4289
# We use an empty conf so that the user is always prompted
4290
conf = config.AuthenticationConfig()
4291
self.assertEquals(password,
4292
conf.get_password(scheme, host, user, port=port,
4293
realm=realm, path=path))
4294
self.assertEquals(expected_prompt, stderr.getvalue())
4295
self.assertEquals('', stdout.getvalue())
4297
def _check_default_username_prompt(self, expected_prompt_format, scheme,
4298
host=None, port=None, realm=None,
4303
expected_prompt = expected_prompt_format % {
4304
'scheme': scheme, 'host': host, 'port': port,
4306
stdout = tests.StringIOWrapper()
4307
stderr = tests.StringIOWrapper()
4308
ui.ui_factory = tests.TestUIFactory(stdin=username+ '\n',
4309
stdout=stdout, stderr=stderr)
4310
# We use an empty conf so that the user is always prompted
4311
conf = config.AuthenticationConfig()
4312
self.assertEquals(username, conf.get_user(scheme, host, port=port,
4313
realm=realm, path=path, ask=True))
4314
self.assertEquals(expected_prompt, stderr.getvalue())
4315
self.assertEquals('', stdout.getvalue())
4317
def test_username_defaults_prompts(self):
4318
# HTTP prompts can't be tested here, see test_http.py
4319
self._check_default_username_prompt(u'FTP %(host)s username: ', 'ftp')
4320
self._check_default_username_prompt(
4321
u'FTP %(host)s:%(port)d username: ', 'ftp', port=10020)
4322
self._check_default_username_prompt(
4323
u'SSH %(host)s:%(port)d username: ', 'ssh', port=12345)
4325
def test_username_default_no_prompt(self):
4326
conf = config.AuthenticationConfig()
4327
self.assertEquals(None,
4328
conf.get_user('ftp', 'example.com'))
4329
self.assertEquals("explicitdefault",
4330
conf.get_user('ftp', 'example.com', default="explicitdefault"))
4332
def test_password_default_prompts(self):
4333
# HTTP prompts can't be tested here, see test_http.py
4334
self._check_default_password_prompt(
4335
u'FTP %(user)s@%(host)s password: ', 'ftp')
4336
self._check_default_password_prompt(
4337
u'FTP %(user)s@%(host)s:%(port)d password: ', 'ftp', port=10020)
4338
self._check_default_password_prompt(
4339
u'SSH %(user)s@%(host)s:%(port)d password: ', 'ssh', port=12345)
4340
# SMTP port handling is a bit special (it's handled if embedded in the
4342
# FIXME: should we: forbid that, extend it to other schemes, leave
4343
# things as they are that's fine thank you ?
4344
self._check_default_password_prompt(
4345
u'SMTP %(user)s@%(host)s password: ', 'smtp')
4346
self._check_default_password_prompt(
4347
u'SMTP %(user)s@%(host)s password: ', 'smtp', host='bar.org:10025')
4348
self._check_default_password_prompt(
4349
u'SMTP %(user)s@%(host)s:%(port)d password: ', 'smtp', port=10025)
4351
def test_ssh_password_emits_warning(self):
4352
conf = config.AuthenticationConfig(_file=StringIO(
4360
entered_password = 'typed-by-hand'
4361
stdout = tests.StringIOWrapper()
4362
stderr = tests.StringIOWrapper()
4363
ui.ui_factory = tests.TestUIFactory(stdin=entered_password + '\n',
4364
stdout=stdout, stderr=stderr)
4366
# Since the password defined in the authentication config is ignored,
4367
# the user is prompted
4368
self.assertEquals(entered_password,
4369
conf.get_password('ssh', 'bar.org', user='jim'))
4370
self.assertContainsRe(
4372
'password ignored in section \[ssh with password\]')
4374
def test_ssh_without_password_doesnt_emit_warning(self):
4375
conf = config.AuthenticationConfig(_file=StringIO(
4382
entered_password = 'typed-by-hand'
4383
stdout = tests.StringIOWrapper()
4384
stderr = tests.StringIOWrapper()
4385
ui.ui_factory = tests.TestUIFactory(stdin=entered_password + '\n',
4389
# Since the password defined in the authentication config is ignored,
4390
# the user is prompted
4391
self.assertEquals(entered_password,
4392
conf.get_password('ssh', 'bar.org', user='jim'))
4393
# No warning shoud be emitted since there is no password. We are only
4395
self.assertNotContainsRe(
4397
'password ignored in section \[ssh with password\]')
4399
def test_uses_fallback_stores(self):
4400
self.overrideAttr(config, 'credential_store_registry',
4401
config.CredentialStoreRegistry())
4402
store = StubCredentialStore()
4403
store.add_credentials("http", "example.com", "joe", "secret")
4404
config.credential_store_registry.register("stub", store, fallback=True)
4405
conf = config.AuthenticationConfig(_file=StringIO())
4406
creds = conf.get_credentials("http", "example.com")
4407
self.assertEquals("joe", creds["user"])
4408
self.assertEquals("secret", creds["password"])
4411
class StubCredentialStore(config.CredentialStore):
4417
def add_credentials(self, scheme, host, user, password=None):
4418
self._username[(scheme, host)] = user
4419
self._password[(scheme, host)] = password
4421
def get_credentials(self, scheme, host, port=None, user=None,
4422
path=None, realm=None):
4423
key = (scheme, host)
4424
if not key in self._username:
4426
return { "scheme": scheme, "host": host, "port": port,
4427
"user": self._username[key], "password": self._password[key]}
4430
class CountingCredentialStore(config.CredentialStore):
4435
def get_credentials(self, scheme, host, port=None, user=None,
4436
path=None, realm=None):
4441
class TestCredentialStoreRegistry(tests.TestCase):
4443
def _get_cs_registry(self):
4444
return config.credential_store_registry
4446
def test_default_credential_store(self):
4447
r = self._get_cs_registry()
4448
default = r.get_credential_store(None)
4449
self.assertIsInstance(default, config.PlainTextCredentialStore)
4451
def test_unknown_credential_store(self):
4452
r = self._get_cs_registry()
4453
# It's hard to imagine someone creating a credential store named
4454
# 'unknown' so we use that as an never registered key.
4455
self.assertRaises(KeyError, r.get_credential_store, 'unknown')
4457
def test_fallback_none_registered(self):
4458
r = config.CredentialStoreRegistry()
4459
self.assertEquals(None,
4460
r.get_fallback_credentials("http", "example.com"))
4462
def test_register(self):
4463
r = config.CredentialStoreRegistry()
4464
r.register("stub", StubCredentialStore(), fallback=False)
4465
r.register("another", StubCredentialStore(), fallback=True)
4466
self.assertEquals(["another", "stub"], r.keys())
4468
def test_register_lazy(self):
4469
r = config.CredentialStoreRegistry()
4470
r.register_lazy("stub", "bzrlib.tests.test_config",
4471
"StubCredentialStore", fallback=False)
4472
self.assertEquals(["stub"], r.keys())
4473
self.assertIsInstance(r.get_credential_store("stub"),
4474
StubCredentialStore)
4476
def test_is_fallback(self):
4477
r = config.CredentialStoreRegistry()
4478
r.register("stub1", None, fallback=False)
4479
r.register("stub2", None, fallback=True)
4480
self.assertEquals(False, r.is_fallback("stub1"))
4481
self.assertEquals(True, r.is_fallback("stub2"))
4483
def test_no_fallback(self):
4484
r = config.CredentialStoreRegistry()
4485
store = CountingCredentialStore()
4486
r.register("count", store, fallback=False)
4487
self.assertEquals(None,
4488
r.get_fallback_credentials("http", "example.com"))
4489
self.assertEquals(0, store._calls)
4491
def test_fallback_credentials(self):
4492
r = config.CredentialStoreRegistry()
4493
store = StubCredentialStore()
4494
store.add_credentials("http", "example.com",
4495
"somebody", "geheim")
4496
r.register("stub", store, fallback=True)
4497
creds = r.get_fallback_credentials("http", "example.com")
4498
self.assertEquals("somebody", creds["user"])
4499
self.assertEquals("geheim", creds["password"])
4501
def test_fallback_first_wins(self):
4502
r = config.CredentialStoreRegistry()
4503
stub1 = StubCredentialStore()
4504
stub1.add_credentials("http", "example.com",
4505
"somebody", "stub1")
4506
r.register("stub1", stub1, fallback=True)
4507
stub2 = StubCredentialStore()
4508
stub2.add_credentials("http", "example.com",
4509
"somebody", "stub2")
4510
r.register("stub2", stub1, fallback=True)
4511
creds = r.get_fallback_credentials("http", "example.com")
4512
self.assertEquals("somebody", creds["user"])
4513
self.assertEquals("stub1", creds["password"])
4516
class TestPlainTextCredentialStore(tests.TestCase):
4518
def test_decode_password(self):
4519
r = config.credential_store_registry
4520
plain_text = r.get_credential_store()
4521
decoded = plain_text.decode_password(dict(password='secret'))
4522
self.assertEquals('secret', decoded)
4525
# FIXME: Once we have a way to declare authentication to all test servers, we
4526
# can implement generic tests.
4527
# test_user_password_in_url
4528
# test_user_in_url_password_from_config
4529
# test_user_in_url_password_prompted
4530
# test_user_in_config
4531
# test_user_getpass.getuser
4532
# test_user_prompted ?
4533
class TestAuthenticationRing(tests.TestCaseWithTransport):
4537
class TestAutoUserId(tests.TestCase):
4538
"""Test inferring an automatic user name."""
4540
def test_auto_user_id(self):
4541
"""Automatic inference of user name.
4543
This is a bit hard to test in an isolated way, because it depends on
4544
system functions that go direct to /etc or perhaps somewhere else.
4545
But it's reasonable to say that on Unix, with an /etc/mailname, we ought
4546
to be able to choose a user name with no configuration.
4548
if sys.platform == 'win32':
4549
raise tests.TestSkipped(
4550
"User name inference not implemented on win32")
4551
realname, address = config._auto_user_id()
4552
if os.path.exists('/etc/mailname'):
4553
self.assertIsNot(None, realname)
4554
self.assertIsNot(None, address)
4556
self.assertEquals((None, None), (realname, address))
4559
class EmailOptionTests(tests.TestCase):
4561
def test_default_email_uses_BZR_EMAIL(self):
4562
# BZR_EMAIL takes precedence over EMAIL
4563
self.overrideEnv('BZR_EMAIL', 'jelmer@samba.org')
4564
self.overrideEnv('EMAIL', 'jelmer@apache.org')
4565
self.assertEquals('jelmer@samba.org', config.default_email())
4567
def test_default_email_uses_EMAIL(self):
4568
self.overrideEnv('BZR_EMAIL', None)
4569
self.overrideEnv('EMAIL', 'jelmer@apache.org')
4570
self.assertEquals('jelmer@apache.org', config.default_email())
4572
def test_BZR_EMAIL_overrides(self):
4573
self.overrideEnv('BZR_EMAIL', 'jelmer@apache.org')
4574
self.assertEquals('jelmer@apache.org',
4575
config.email_from_store('jelmer@debian.org'))
4576
self.overrideEnv('BZR_EMAIL', None)
4577
self.overrideEnv('EMAIL', 'jelmer@samba.org')
4578
self.assertEquals('jelmer@debian.org',
4579
config.email_from_store('jelmer@debian.org'))
added
removed
bzrlib/tests/test_config.py
