371
395
class TestIniConfig(tests.TestCaseInTempDir):
373
397
def make_config_parser(self, s):
374
conf = config.IniBasedConfig(None)
375
parser = conf._get_parser(file=StringIO(s.encode('utf-8')))
398
conf = config.IniBasedConfig.from_string(s)
399
return conf, conf._get_parser()
379
402
class TestIniConfigBuilding(TestIniConfig):
381
404
def test_contructs(self):
382
my_config = config.IniBasedConfig("nothing")
405
my_config = config.IniBasedConfig()
384
407
def test_from_fp(self):
385
config_file = StringIO(sample_config_text.encode('utf-8'))
386
my_config = config.IniBasedConfig(None)
388
isinstance(my_config._get_parser(file=config_file),
389
configobj.ConfigObj))
408
my_config = config.IniBasedConfig.from_string(sample_config_text)
409
self.assertIsInstance(my_config._get_parser(), configobj.ConfigObj)
391
411
def test_cached(self):
392
config_file = StringIO(sample_config_text.encode('utf-8'))
393
my_config = config.IniBasedConfig(None)
394
parser = my_config._get_parser(file=config_file)
412
my_config = config.IniBasedConfig.from_string(sample_config_text)
413
parser = my_config._get_parser()
395
414
self.failUnless(my_config._get_parser() is parser)
397
416
def _dummy_chown(self, path, uid, gid):
398
417
self.path, self.uid, self.gid = path, uid, gid
400
419
def test_ini_config_ownership(self):
401
"""Ensure that chown is happening during _write_config_file.
420
"""Ensure that chown is happening during _write_config_file"""
403
421
self.requireFeature(features.chown_feature)
404
422
self.overrideAttr(os, 'chown', self._dummy_chown)
405
423
self.path = self.uid = self.gid = None
408
conf = config.IniBasedConfig(get_filename)
424
conf = config.IniBasedConfig(file_name='./foo.conf')
409
425
conf._write_config_file()
410
self.assertEquals(self.path, 'foo.conf')
426
self.assertEquals(self.path, './foo.conf')
411
427
self.assertTrue(isinstance(self.uid, int))
412
428
self.assertTrue(isinstance(self.gid, int))
430
def test_get_filename_parameter_is_deprecated_(self):
431
conf = self.callDeprecated([
432
'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
433
' Use file_name instead.'],
434
config.IniBasedConfig, lambda: 'ini.conf')
435
self.assertEqual('ini.conf', conf.file_name)
437
def test_get_parser_file_parameter_is_deprecated_(self):
438
config_file = StringIO(sample_config_text.encode('utf-8'))
439
conf = config.IniBasedConfig.from_string(sample_config_text)
440
conf = self.callDeprecated([
441
'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
442
' Use IniBasedConfig(_content=xxx) instead.'],
443
conf._get_parser, file=config_file)
445
class TestIniConfigSaving(tests.TestCaseInTempDir):
447
def test_cant_save_without_a_file_name(self):
448
conf = config.IniBasedConfig()
449
self.assertRaises(AssertionError, conf._write_config_file)
451
def test_saved_with_content(self):
452
content = 'foo = bar\n'
453
conf = config.IniBasedConfig.from_string(
454
content, file_name='./test.conf', save=True)
455
self.assertFileEqual(content, 'test.conf')
458
class TestIniBaseConfigOnDisk(tests.TestCaseInTempDir):
460
def test_cannot_reload_without_name(self):
461
conf = config.IniBasedConfig.from_string(sample_config_text)
462
self.assertRaises(AssertionError, conf.reload)
464
def test_reload_see_new_value(self):
465
c1 = config.IniBasedConfig.from_string('editor=vim\n',
466
file_name='./test/conf')
467
c1._write_config_file()
468
c2 = config.IniBasedConfig.from_string('editor=emacs\n',
469
file_name='./test/conf')
470
c2._write_config_file()
471
self.assertEqual('vim', c1.get_user_option('editor'))
472
self.assertEqual('emacs', c2.get_user_option('editor'))
473
# Make sure we get the Right value
475
self.assertEqual('emacs', c1.get_user_option('editor'))
478
class TestLockableConfig(tests.TestCaseInTempDir):
483
config_section = None
486
super(TestLockableConfig, self).setUp()
487
self._content = '[%s]\none=1\ntwo=2\n' % (self.config_section,)
488
self.config = self.create_config(self._content)
490
def get_existing_config(self):
491
return self.config_class(*self.config_args)
493
def create_config(self, content):
494
c = self.config_class.from_string(content, *self.config_args, save=True)
497
def test_simple_read_access(self):
498
self.assertEquals('1', self.config.get_user_option('one'))
500
def test_simple_write_access(self):
501
self.config.set_user_option('one', 'one')
502
self.assertEquals('one', self.config.get_user_option('one'))
504
def test_listen_to_the_last_speaker(self):
506
c2 = self.get_existing_config()
507
c1.set_user_option('one', 'ONE')
508
c2.set_user_option('two', 'TWO')
509
self.assertEquals('ONE', c1.get_user_option('one'))
510
self.assertEquals('TWO', c2.get_user_option('two'))
511
# The second update respect the first one
512
self.assertEquals('ONE', c2.get_user_option('one'))
514
def test_last_speaker_wins(self):
515
# If the same config is not shared, the same variable modified twice
516
# can only see a single result.
518
c2 = self.get_existing_config()
519
c1.set_user_option('one', 'c1')
520
c2.set_user_option('one', 'c2')
521
self.assertEquals('c2', c2._get_user_option('one'))
522
# The first modification is still available until another refresh
524
self.assertEquals('c1', c1._get_user_option('one'))
525
c1.set_user_option('two', 'done')
526
self.assertEquals('c2', c1._get_user_option('one'))
528
def test_writes_are_serialized(self):
530
c2 = self.get_existing_config()
532
# We spawn a thread that will pause *during* the write
533
before_writing = threading.Event()
534
after_writing = threading.Event()
535
writing_done = threading.Event()
536
c1_orig = c1._write_config_file
537
def c1_write_config_file():
540
# The lock is held we wait for the main thread to decide when to
543
c1._write_config_file = c1_write_config_file
545
c1.set_user_option('one', 'c1')
547
t1 = threading.Thread(target=c1_set_option)
548
# Collect the thread after the test
549
self.addCleanup(t1.join)
550
# Be ready to unblock the thread if the test goes wrong
551
self.addCleanup(after_writing.set)
553
before_writing.wait()
554
self.assertTrue(c1._lock.is_held)
555
self.assertRaises(errors.LockContention,
556
c2.set_user_option, 'one', 'c2')
557
self.assertEquals('c1', c1.get_user_option('one'))
558
# Let the lock be released
561
c2.set_user_option('one', 'c2')
562
self.assertEquals('c2', c2.get_user_option('one'))
564
def test_read_while_writing(self):
566
# We spawn a thread that will pause *during* the write
567
ready_to_write = threading.Event()
568
do_writing = threading.Event()
569
writing_done = threading.Event()
570
c1_orig = c1._write_config_file
571
def c1_write_config_file():
573
# The lock is held we wait for the main thread to decide when to
578
c1._write_config_file = c1_write_config_file
580
c1.set_user_option('one', 'c1')
581
t1 = threading.Thread(target=c1_set_option)
582
# Collect the thread after the test
583
self.addCleanup(t1.join)
584
# Be ready to unblock the thread if the test goes wrong
585
self.addCleanup(do_writing.set)
587
# Ensure the thread is ready to write
588
ready_to_write.wait()
589
self.assertTrue(c1._lock.is_held)
590
self.assertEquals('c1', c1.get_user_option('one'))
591
# If we read during the write, we get the old value
592
c2 = self.get_existing_config()
593
self.assertEquals('1', c2.get_user_option('one'))
594
# Let the writing occur and ensure it occurred
597
# Now we get the updated value
598
c3 = self.get_existing_config()
599
self.assertEquals('c1', c3.get_user_option('one'))
414
602
class TestGetUserOptionAs(TestIniConfig):
416
604
def test_get_user_option_as_bool(self):
574
760
self.assertEqual(1, len(warnings))
575
761
self.assertEqual(warning, warnings[0])
576
trace.warning = warning
578
branch = self.make_branch('.')
579
conf = branch.get_config()
580
set_option(config.STORE_GLOBAL)
582
set_option(config.STORE_BRANCH)
584
set_option(config.STORE_GLOBAL)
585
assertWarning('Value "4" is masked by "3" from branch.conf')
586
set_option(config.STORE_GLOBAL, warn_masked=False)
588
set_option(config.STORE_LOCATION)
590
set_option(config.STORE_BRANCH)
591
assertWarning('Value "3" is masked by "0" from locations.conf')
592
set_option(config.STORE_BRANCH, warn_masked=False)
595
trace.warning = _warning
762
branch = self.make_branch('.')
763
conf = branch.get_config()
764
set_option(config.STORE_GLOBAL)
766
set_option(config.STORE_BRANCH)
768
set_option(config.STORE_GLOBAL)
769
assertWarning('Value "4" is masked by "3" from branch.conf')
770
set_option(config.STORE_GLOBAL, warn_masked=False)
772
set_option(config.STORE_LOCATION)
774
set_option(config.STORE_BRANCH)
775
assertWarning('Value "3" is masked by "0" from locations.conf')
776
set_option(config.STORE_BRANCH, warn_masked=False)
598
780
class TestGlobalConfigItems(tests.TestCase):
600
782
def test_user_id(self):
601
config_file = StringIO(sample_config_text.encode('utf-8'))
602
my_config = config.GlobalConfig()
603
my_config._parser = my_config._get_parser(file=config_file)
783
my_config = config.GlobalConfig.from_string(sample_config_text)
604
784
self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
605
785
my_config._get_user_id())
607
787
def test_absent_user_id(self):
608
config_file = StringIO("")
609
788
my_config = config.GlobalConfig()
610
my_config._parser = my_config._get_parser(file=config_file)
611
789
self.assertEqual(None, my_config._get_user_id())
613
791
def test_configured_editor(self):
614
config_file = StringIO(sample_config_text.encode('utf-8'))
615
my_config = config.GlobalConfig()
616
my_config._parser = my_config._get_parser(file=config_file)
792
my_config = config.GlobalConfig.from_string(sample_config_text)
617
793
self.assertEqual("vim", my_config.get_editor())
619
795
def test_signatures_always(self):
620
config_file = StringIO(sample_always_signatures)
621
my_config = config.GlobalConfig()
622
my_config._parser = my_config._get_parser(file=config_file)
796
my_config = config.GlobalConfig.from_string(sample_always_signatures)
623
797
self.assertEqual(config.CHECK_NEVER,
624
798
my_config.signature_checking())
625
799
self.assertEqual(config.SIGN_ALWAYS,
1007
1161
self.my_config.post_commit())
1009
1163
def get_branch_config(self, location, global_config=None):
1164
my_branch = FakeBranch(location)
1010
1165
if global_config is None:
1011
global_file = StringIO(sample_config_text.encode('utf-8'))
1013
global_file = StringIO(global_config.encode('utf-8'))
1014
branches_file = StringIO(sample_branches_text.encode('utf-8'))
1015
self.my_config = config.BranchConfig(FakeBranch(location))
1016
# Force location config to use specified file
1017
self.my_location_config = self.my_config._get_location_config()
1018
self.my_location_config._get_parser(branches_file)
1019
# Force global config to use specified file
1020
self.my_config._get_global_config()._get_parser(global_file)
1166
global_config = sample_config_text
1168
my_global_config = config.GlobalConfig.from_string(global_config,
1170
my_location_config = config.LocationConfig.from_string(
1171
sample_branches_text, my_branch.base, save=True)
1172
my_config = config.BranchConfig(my_branch)
1173
self.my_config = my_config
1174
self.my_location_config = my_config._get_location_config()
1022
1176
def test_set_user_setting_sets_and_saves(self):
1023
1177
self.get_branch_config('/a/c')
1024
1178
record = InstrumentedConfigObj("foo")
1025
1179
self.my_location_config._parser = record
1027
real_mkdir = os.mkdir
1028
self.created = False
1029
def checked_mkdir(path, mode=0777):
1030
self.log('making directory: %s', path)
1031
real_mkdir(path, mode)
1034
os.mkdir = checked_mkdir
1036
self.callDeprecated(['The recurse option is deprecated as of '
1037
'0.14. The section "/a/c" has been '
1038
'converted to use policies.'],
1039
self.my_config.set_user_option,
1040
'foo', 'bar', store=config.STORE_LOCATION)
1042
os.mkdir = real_mkdir
1044
self.failUnless(self.created, 'Failed to create ~/.bazaar')
1045
self.assertEqual([('__contains__', '/a/c'),
1181
self.callDeprecated(['The recurse option is deprecated as of '
1182
'0.14. The section "/a/c" has been '
1183
'converted to use policies.'],
1184
self.my_config.set_user_option,
1185
'foo', 'bar', store=config.STORE_LOCATION)
1186
self.assertEqual([('reload',),
1187
('__contains__', '/a/c'),
1046
1188
('__contains__', '/a/c/'),
1047
1189
('__setitem__', '/a/c', {}),
1048
1190
('__getitem__', '/a/c'),
1183
1320
self.assertEqual('rmtree_root', my_config.post_commit())
1185
1322
def test_config_precedence(self):
1323
# FIXME: eager test, luckily no persitent config file makes it fail
1186
1325
my_config = self.get_branch_config(global_config=precedence_global)
1187
1326
self.assertEqual(my_config.get_user_option('option'), 'global')
1188
1327
my_config = self.get_branch_config(global_config=precedence_global,
1189
branch_data_config=precedence_branch)
1328
branch_data_config=precedence_branch)
1190
1329
self.assertEqual(my_config.get_user_option('option'), 'branch')
1191
my_config = self.get_branch_config(global_config=precedence_global,
1192
branch_data_config=precedence_branch,
1193
location_config=precedence_location)
1330
my_config = self.get_branch_config(
1331
global_config=precedence_global,
1332
branch_data_config=precedence_branch,
1333
location_config=precedence_location)
1194
1334
self.assertEqual(my_config.get_user_option('option'), 'recurse')
1195
my_config = self.get_branch_config(global_config=precedence_global,
1196
branch_data_config=precedence_branch,
1197
location_config=precedence_location,
1198
location='http://example.com/specific')
1335
my_config = self.get_branch_config(
1336
global_config=precedence_global,
1337
branch_data_config=precedence_branch,
1338
location_config=precedence_location,
1339
location='http://example.com/specific')
1199
1340
self.assertEqual(my_config.get_user_option('option'), 'exact')
1201
1342
def test_get_mail_client(self):