387
347
self.assertEqual(config.authentication_config_filename(),
388
348
self.bzr_home + '/authentication.conf')
390
def test_xdg_cache_dir(self):
391
self.assertEqual(config.xdg_cache_dir(),
392
'/home/bogus/.cache')
395
class TestIniConfig(tests.TestCaseInTempDir):
397
def make_config_parser(self, s):
398
conf = config.IniBasedConfig.from_string(s)
399
return conf, conf._get_parser()
402
class TestIniConfigBuilding(TestIniConfig):
351
class TestIniConfig(tests.TestCase):
404
353
def test_contructs(self):
405
my_config = config.IniBasedConfig()
354
my_config = config.IniBasedConfig("nothing")
407
356
def test_from_fp(self):
408
my_config = config.IniBasedConfig.from_string(sample_config_text)
409
self.assertIsInstance(my_config._get_parser(), configobj.ConfigObj)
357
config_file = StringIO(sample_config_text.encode('utf-8'))
358
my_config = config.IniBasedConfig(None)
360
isinstance(my_config._get_parser(file=config_file),
361
configobj.ConfigObj))
411
363
def test_cached(self):
412
my_config = config.IniBasedConfig.from_string(sample_config_text)
413
parser = my_config._get_parser()
364
config_file = StringIO(sample_config_text.encode('utf-8'))
365
my_config = config.IniBasedConfig(None)
366
parser = my_config._get_parser(file=config_file)
414
367
self.failUnless(my_config._get_parser() is parser)
416
def _dummy_chown(self, path, uid, gid):
417
self.path, self.uid, self.gid = path, uid, gid
419
def test_ini_config_ownership(self):
420
"""Ensure that chown is happening during _write_config_file"""
421
self.requireFeature(features.chown_feature)
422
self.overrideAttr(os, 'chown', self._dummy_chown)
423
self.path = self.uid = self.gid = None
424
conf = config.IniBasedConfig(file_name='./foo.conf')
425
conf._write_config_file()
426
self.assertEquals(self.path, './foo.conf')
427
self.assertTrue(isinstance(self.uid, int))
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
kwargs = dict(save=True)
495
c = self.config_class.from_string(content, *self.config_args, **kwargs)
498
def test_simple_read_access(self):
499
self.assertEquals('1', self.config.get_user_option('one'))
501
def test_simple_write_access(self):
502
self.config.set_user_option('one', 'one')
503
self.assertEquals('one', self.config.get_user_option('one'))
505
def test_listen_to_the_last_speaker(self):
507
c2 = self.get_existing_config()
508
c1.set_user_option('one', 'ONE')
509
c2.set_user_option('two', 'TWO')
510
self.assertEquals('ONE', c1.get_user_option('one'))
511
self.assertEquals('TWO', c2.get_user_option('two'))
512
# The second update respect the first one
513
self.assertEquals('ONE', c2.get_user_option('one'))
515
def test_last_speaker_wins(self):
516
# If the same config is not shared, the same variable modified twice
517
# can only see a single result.
519
c2 = self.get_existing_config()
520
c1.set_user_option('one', 'c1')
521
c2.set_user_option('one', 'c2')
522
self.assertEquals('c2', c2._get_user_option('one'))
523
# The first modification is still available until another refresh
525
self.assertEquals('c1', c1._get_user_option('one'))
526
c1.set_user_option('two', 'done')
527
self.assertEquals('c2', c1._get_user_option('one'))
529
def test_writes_are_serialized(self):
531
c2 = self.get_existing_config()
533
# We spawn a thread that will pause *during* the write
534
before_writing = threading.Event()
535
after_writing = threading.Event()
536
writing_done = threading.Event()
537
c1_orig = c1._write_config_file
538
def c1_write_config_file():
541
# The lock is held we wait for the main thread to decide when to
544
c1._write_config_file = c1_write_config_file
546
c1.set_user_option('one', 'c1')
548
t1 = threading.Thread(target=c1_set_option)
549
# Collect the thread after the test
550
self.addCleanup(t1.join)
551
# Be ready to unblock the thread if the test goes wrong
552
self.addCleanup(after_writing.set)
554
before_writing.wait()
555
self.assertTrue(c1._lock.is_held)
556
self.assertRaises(errors.LockContention,
557
c2.set_user_option, 'one', 'c2')
558
self.assertEquals('c1', c1.get_user_option('one'))
559
# Let the lock be released
562
c2.set_user_option('one', 'c2')
563
self.assertEquals('c2', c2.get_user_option('one'))
565
def test_read_while_writing(self):
567
# We spawn a thread that will pause *during* the write
568
ready_to_write = threading.Event()
569
do_writing = threading.Event()
570
writing_done = threading.Event()
571
c1_orig = c1._write_config_file
572
def c1_write_config_file():
574
# The lock is held we wait for the main thread to decide when to
579
c1._write_config_file = c1_write_config_file
581
c1.set_user_option('one', 'c1')
582
t1 = threading.Thread(target=c1_set_option)
583
# Collect the thread after the test
584
self.addCleanup(t1.join)
585
# Be ready to unblock the thread if the test goes wrong
586
self.addCleanup(do_writing.set)
588
# Ensure the thread is ready to write
589
ready_to_write.wait()
590
self.assertTrue(c1._lock.is_held)
591
self.assertEquals('c1', c1.get_user_option('one'))
592
# If we read during the write, we get the old value
593
c2 = self.get_existing_config()
594
self.assertEquals('1', c2.get_user_option('one'))
595
# Let the writing occur and ensure it occurred
598
# Now we get the updated value
599
c3 = self.get_existing_config()
600
self.assertEquals('c1', c3.get_user_option('one'))
603
class TestGetUserOptionAs(TestIniConfig):
605
369
def test_get_user_option_as_bool(self):
606
conf, parser = self.make_config_parser("""
370
config_file = StringIO("""
607
371
a_true_bool = true
609
373
an_invalid_bool = maybe
610
a_list = hmm, who knows ? # This is interpreted as a list !
612
get_bool = conf.get_user_option_as_bool
613
self.assertEqual(True, get_bool('a_true_bool'))
614
self.assertEqual(False, get_bool('a_false_bool'))
617
warnings.append(args[0] % args[1:])
618
self.overrideAttr(trace, 'warning', warning)
619
msg = 'Value "%s" is not a boolean for "%s"'
620
self.assertIs(None, get_bool('an_invalid_bool'))
621
self.assertEquals(msg % ('maybe', 'an_invalid_bool'), warnings[0])
623
self.assertIs(None, get_bool('not_defined_in_this_config'))
624
self.assertEquals([], warnings)
626
def test_get_user_option_as_list(self):
627
conf, parser = self.make_config_parser("""
632
get_list = conf.get_user_option_as_list
633
self.assertEqual(['a', 'b', 'c'], get_list('a_list'))
634
self.assertEqual(['1'], get_list('length_1'))
635
self.assertEqual('x', conf.get_user_option('one_item'))
636
# automatically cast to list
637
self.assertEqual(['x'], get_list('one_item'))
640
class TestSupressWarning(TestIniConfig):
642
def make_warnings_config(self, s):
643
conf, parser = self.make_config_parser(s)
644
return conf.suppress_warning
646
def test_suppress_warning_unknown(self):
647
suppress_warning = self.make_warnings_config('')
648
self.assertEqual(False, suppress_warning('unknown_warning'))
650
def test_suppress_warning_known(self):
651
suppress_warning = self.make_warnings_config('suppress_warnings=a,b')
652
self.assertEqual(False, suppress_warning('c'))
653
self.assertEqual(True, suppress_warning('a'))
654
self.assertEqual(True, suppress_warning('b'))
374
a_list = hmm, who knows ? # This interpreted as a list !
376
my_config = config.IniBasedConfig(None)
377
parser = my_config._get_parser(file=config_file)
378
get_option = my_config.get_user_option_as_bool
379
self.assertEqual(True, get_option('a_true_bool'))
380
self.assertEqual(False, get_option('a_false_bool'))
381
self.assertIs(None, get_option('an_invalid_bool'))
382
self.assertIs(None, get_option('not_defined_in_this_config'))
657
384
class TestGetConfig(tests.TestCase):
761
490
self.assertEqual(1, len(warnings))
762
491
self.assertEqual(warning, warnings[0])
763
branch = self.make_branch('.')
764
conf = branch.get_config()
765
set_option(config.STORE_GLOBAL)
767
set_option(config.STORE_BRANCH)
769
set_option(config.STORE_GLOBAL)
770
assertWarning('Value "4" is masked by "3" from branch.conf')
771
set_option(config.STORE_GLOBAL, warn_masked=False)
773
set_option(config.STORE_LOCATION)
775
set_option(config.STORE_BRANCH)
776
assertWarning('Value "3" is masked by "0" from locations.conf')
777
set_option(config.STORE_BRANCH, warn_masked=False)
492
trace.warning = warning
494
branch = self.make_branch('.')
495
conf = branch.get_config()
496
set_option(config.STORE_GLOBAL)
498
set_option(config.STORE_BRANCH)
500
set_option(config.STORE_GLOBAL)
501
assertWarning('Value "4" is masked by "3" from branch.conf')
502
set_option(config.STORE_GLOBAL, warn_masked=False)
504
set_option(config.STORE_LOCATION)
506
set_option(config.STORE_BRANCH)
507
assertWarning('Value "3" is masked by "0" from locations.conf')
508
set_option(config.STORE_BRANCH, warn_masked=False)
511
trace.warning = _warning
781
514
class TestGlobalConfigItems(tests.TestCase):
783
516
def test_user_id(self):
784
my_config = config.GlobalConfig.from_string(sample_config_text)
517
config_file = StringIO(sample_config_text.encode('utf-8'))
518
my_config = config.GlobalConfig()
519
my_config._parser = my_config._get_parser(file=config_file)
785
520
self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
786
521
my_config._get_user_id())
788
523
def test_absent_user_id(self):
524
config_file = StringIO("")
789
525
my_config = config.GlobalConfig()
526
my_config._parser = my_config._get_parser(file=config_file)
790
527
self.assertEqual(None, my_config._get_user_id())
792
529
def test_configured_editor(self):
793
my_config = config.GlobalConfig.from_string(sample_config_text)
530
config_file = StringIO(sample_config_text.encode('utf-8'))
531
my_config = config.GlobalConfig()
532
my_config._parser = my_config._get_parser(file=config_file)
794
533
self.assertEqual("vim", my_config.get_editor())
796
535
def test_signatures_always(self):
797
my_config = config.GlobalConfig.from_string(sample_always_signatures)
536
config_file = StringIO(sample_always_signatures)
537
my_config = config.GlobalConfig()
538
my_config._parser = my_config._get_parser(file=config_file)
798
539
self.assertEqual(config.CHECK_NEVER,
799
540
my_config.signature_checking())
800
541
self.assertEqual(config.SIGN_ALWAYS,
1162
911
self.my_config.post_commit())
1164
913
def get_branch_config(self, location, global_config=None):
1165
my_branch = FakeBranch(location)
1166
914
if global_config is None:
1167
global_config = sample_config_text
1169
my_global_config = config.GlobalConfig.from_string(global_config,
1171
my_location_config = config.LocationConfig.from_string(
1172
sample_branches_text, my_branch.base, save=True)
1173
my_config = config.BranchConfig(my_branch)
1174
self.my_config = my_config
1175
self.my_location_config = my_config._get_location_config()
915
global_file = StringIO(sample_config_text.encode('utf-8'))
917
global_file = StringIO(global_config.encode('utf-8'))
918
branches_file = StringIO(sample_branches_text.encode('utf-8'))
919
self.my_config = config.BranchConfig(FakeBranch(location))
920
# Force location config to use specified file
921
self.my_location_config = self.my_config._get_location_config()
922
self.my_location_config._get_parser(branches_file)
923
# Force global config to use specified file
924
self.my_config._get_global_config()._get_parser(global_file)
1177
926
def test_set_user_setting_sets_and_saves(self):
1178
927
self.get_branch_config('/a/c')
1179
928
record = InstrumentedConfigObj("foo")
1180
929
self.my_location_config._parser = record
1182
self.callDeprecated(['The recurse option is deprecated as of '
1183
'0.14. The section "/a/c" has been '
1184
'converted to use policies.'],
1185
self.my_config.set_user_option,
1186
'foo', 'bar', store=config.STORE_LOCATION)
1187
self.assertEqual([('reload',),
1188
('__contains__', '/a/c'),
931
real_mkdir = os.mkdir
933
def checked_mkdir(path, mode=0777):
934
self.log('making directory: %s', path)
935
real_mkdir(path, mode)
938
os.mkdir = checked_mkdir
940
self.callDeprecated(['The recurse option is deprecated as of '
941
'0.14. The section "/a/c" has been '
942
'converted to use policies.'],
943
self.my_config.set_user_option,
944
'foo', 'bar', store=config.STORE_LOCATION)
946
os.mkdir = real_mkdir
948
self.failUnless(self.created, 'Failed to create ~/.bazaar')
949
self.assertEqual([('__contains__', '/a/c'),
1189
950
('__contains__', '/a/c/'),
1190
951
('__setitem__', '/a/c', {}),
1191
952
('__getitem__', '/a/c'),