1
# Copyright (C) 2005, 2006, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Tests for finding and reading the bzr config file[s]."""
18
# import system imports here
19
from cStringIO import StringIO
23
#import bzrlib specific imports here
37
from bzrlib.util.configobj import configobj
40
sample_long_alias="log -r-15..-1 --line"
41
sample_config_text = u"""
43
email=Erik B\u00e5gfors <erik@bagfors.nu>
45
gpg_signing_command=gnome-gpg
47
user_global_option=something
50
ll=""" + sample_long_alias + "\n"
53
sample_always_signatures = """
55
check_signatures=ignore
56
create_signatures=always
59
sample_ignore_signatures = """
61
check_signatures=require
62
create_signatures=never
65
sample_maybe_signatures = """
67
check_signatures=ignore
68
create_signatures=when-required
71
sample_branches_text = """
72
[http://www.example.com]
74
email=Robert Collins <robertc@example.org>
75
normal_option = normal
76
appendpath_option = append
77
appendpath_option:policy = appendpath
78
norecurse_option = norecurse
79
norecurse_option:policy = norecurse
80
[http://www.example.com/ignoreparent]
81
# different project: ignore parent dir config
83
[http://www.example.com/norecurse]
84
# configuration items that only apply to this dir
86
normal_option = norecurse
87
[http://www.example.com/dir]
88
appendpath_option = normal
90
check_signatures=require
91
# test trailing / matching with no children
93
check_signatures=check-available
94
gpg_signing_command=false
95
user_local_option=local
96
# test trailing / matching
98
#subdirs will match but not the parent
100
check_signatures=ignore
101
post_commit=bzrlib.tests.test_config.post_commit
102
#testing explicit beats globs
106
class InstrumentedConfigObj(object):
107
"""A config obj look-enough-alike to record calls made to it."""
109
def __contains__(self, thing):
110
self._calls.append(('__contains__', thing))
113
def __getitem__(self, key):
114
self._calls.append(('__getitem__', key))
117
def __init__(self, input, encoding=None):
118
self._calls = [('__init__', input, encoding)]
120
def __setitem__(self, key, value):
121
self._calls.append(('__setitem__', key, value))
123
def __delitem__(self, key):
124
self._calls.append(('__delitem__', key))
127
self._calls.append(('keys',))
130
def write(self, arg):
131
self._calls.append(('write',))
133
def as_bool(self, value):
134
self._calls.append(('as_bool', value))
137
def get_value(self, section, name):
138
self._calls.append(('get_value', section, name))
142
class FakeBranch(object):
144
def __init__(self, base=None, user_id=None):
146
self.base = "http://example.com/branches/demo"
149
self._transport = self.control_files = \
150
FakeControlFilesAndTransport(user_id=user_id)
152
def _get_config(self):
153
return config.TransportConfig(self._transport, 'branch.conf')
155
def lock_write(self):
162
class FakeControlFilesAndTransport(object):
164
def __init__(self, user_id=None):
167
self.files['email'] = user_id
168
self._transport = self
170
def get_utf8(self, filename):
172
raise AssertionError("get_utf8 should no longer be used")
174
def get(self, filename):
177
return StringIO(self.files[filename])
179
raise errors.NoSuchFile(filename)
181
def get_bytes(self, filename):
184
return self.files[filename]
186
raise errors.NoSuchFile(filename)
188
def put(self, filename, fileobj):
189
self.files[filename] = fileobj.read()
191
def put_file(self, filename, fileobj):
192
return self.put(filename, fileobj)
195
class InstrumentedConfig(config.Config):
196
"""An instrumented config that supplies stubs for template methods."""
199
super(InstrumentedConfig, self).__init__()
201
self._signatures = config.CHECK_NEVER
203
def _get_user_id(self):
204
self._calls.append('_get_user_id')
205
return "Robert Collins <robert.collins@example.org>"
207
def _get_signature_checking(self):
208
self._calls.append('_get_signature_checking')
209
return self._signatures
212
bool_config = """[DEFAULT]
221
class TestConfigObj(tests.TestCase):
223
def test_get_bool(self):
224
co = config.ConfigObj(StringIO(bool_config))
225
self.assertIs(co.get_bool('DEFAULT', 'active'), True)
226
self.assertIs(co.get_bool('DEFAULT', 'inactive'), False)
227
self.assertIs(co.get_bool('UPPERCASE', 'active'), True)
228
self.assertIs(co.get_bool('UPPERCASE', 'nonactive'), False)
230
def test_hash_sign_in_value(self):
232
Before 4.5.0, ConfigObj did not quote # signs in values, so they'd be
233
treated as comments when read in again. (#86838)
235
co = config.ConfigObj()
236
co['test'] = 'foo#bar'
238
self.assertEqual(lines, ['test = "foo#bar"'])
239
co2 = config.ConfigObj(lines)
240
self.assertEqual(co2['test'], 'foo#bar')
243
erroneous_config = """[section] # line 1
246
whocares=notme # line 4
250
class TestConfigObjErrors(tests.TestCase):
252
def test_duplicate_section_name_error_line(self):
254
co = configobj.ConfigObj(StringIO(erroneous_config),
256
except config.configobj.DuplicateError, e:
257
self.assertEqual(3, e.line_number)
259
self.fail('Error in config file not detected')
262
class TestConfig(tests.TestCase):
264
def test_constructs(self):
267
def test_no_default_editor(self):
268
self.assertRaises(NotImplementedError, config.Config().get_editor)
270
def test_user_email(self):
271
my_config = InstrumentedConfig()
272
self.assertEqual('robert.collins@example.org', my_config.user_email())
273
self.assertEqual(['_get_user_id'], my_config._calls)
275
def test_username(self):
276
my_config = InstrumentedConfig()
277
self.assertEqual('Robert Collins <robert.collins@example.org>',
278
my_config.username())
279
self.assertEqual(['_get_user_id'], my_config._calls)
281
def test_signatures_default(self):
282
my_config = config.Config()
283
self.assertFalse(my_config.signature_needed())
284
self.assertEqual(config.CHECK_IF_POSSIBLE,
285
my_config.signature_checking())
286
self.assertEqual(config.SIGN_WHEN_REQUIRED,
287
my_config.signing_policy())
289
def test_signatures_template_method(self):
290
my_config = InstrumentedConfig()
291
self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
292
self.assertEqual(['_get_signature_checking'], my_config._calls)
294
def test_signatures_template_method_none(self):
295
my_config = InstrumentedConfig()
296
my_config._signatures = None
297
self.assertEqual(config.CHECK_IF_POSSIBLE,
298
my_config.signature_checking())
299
self.assertEqual(['_get_signature_checking'], my_config._calls)
301
def test_gpg_signing_command_default(self):
302
my_config = config.Config()
303
self.assertEqual('gpg', my_config.gpg_signing_command())
305
def test_get_user_option_default(self):
306
my_config = config.Config()
307
self.assertEqual(None, my_config.get_user_option('no_option'))
309
def test_post_commit_default(self):
310
my_config = config.Config()
311
self.assertEqual(None, my_config.post_commit())
313
def test_log_format_default(self):
314
my_config = config.Config()
315
self.assertEqual('long', my_config.log_format())
318
class TestConfigPath(tests.TestCase):
321
super(TestConfigPath, self).setUp()
322
os.environ['HOME'] = '/home/bogus'
323
os.environ['XDG_CACHE_DIR'] = ''
324
if sys.platform == 'win32':
325
os.environ['BZR_HOME'] = \
326
r'C:\Documents and Settings\bogus\Application Data'
328
'C:/Documents and Settings/bogus/Application Data/bazaar/2.0'
330
self.bzr_home = '/home/bogus/.bazaar'
332
def test_config_dir(self):
333
self.assertEqual(config.config_dir(), self.bzr_home)
335
def test_config_filename(self):
336
self.assertEqual(config.config_filename(),
337
self.bzr_home + '/bazaar.conf')
339
def test_branches_config_filename(self):
340
self.assertEqual(config.branches_config_filename(),
341
self.bzr_home + '/branches.conf')
343
def test_locations_config_filename(self):
344
self.assertEqual(config.locations_config_filename(),
345
self.bzr_home + '/locations.conf')
347
def test_authentication_config_filename(self):
348
self.assertEqual(config.authentication_config_filename(),
349
self.bzr_home + '/authentication.conf')
351
def test_xdg_cache_dir(self):
352
self.assertEqual(config.xdg_cache_dir(),
353
'/home/bogus/.cache')
356
class TestIniConfig(tests.TestCase):
358
def test_contructs(self):
359
my_config = config.IniBasedConfig("nothing")
361
def test_from_fp(self):
362
config_file = StringIO(sample_config_text.encode('utf-8'))
363
my_config = config.IniBasedConfig(None)
365
isinstance(my_config._get_parser(file=config_file),
366
configobj.ConfigObj))
368
def test_cached(self):
369
config_file = StringIO(sample_config_text.encode('utf-8'))
370
my_config = config.IniBasedConfig(None)
371
parser = my_config._get_parser(file=config_file)
372
self.failUnless(my_config._get_parser() is parser)
374
def test_get_user_option_as_bool(self):
375
config_file = StringIO("""
378
an_invalid_bool = maybe
379
a_list = hmm, who knows ? # This interpreted as a list !
381
my_config = config.IniBasedConfig(None)
382
parser = my_config._get_parser(file=config_file)
383
get_option = my_config.get_user_option_as_bool
384
self.assertEqual(True, get_option('a_true_bool'))
385
self.assertEqual(False, get_option('a_false_bool'))
386
self.assertIs(None, get_option('an_invalid_bool'))
387
self.assertIs(None, get_option('not_defined_in_this_config'))
389
class TestGetConfig(tests.TestCase):
391
def test_constructs(self):
392
my_config = config.GlobalConfig()
394
def test_calls_read_filenames(self):
395
# replace the class that is constructed, to check its parameters
396
oldparserclass = config.ConfigObj
397
config.ConfigObj = InstrumentedConfigObj
398
my_config = config.GlobalConfig()
400
parser = my_config._get_parser()
402
config.ConfigObj = oldparserclass
403
self.failUnless(isinstance(parser, InstrumentedConfigObj))
404
self.assertEqual(parser._calls, [('__init__', config.config_filename(),
408
class TestBranchConfig(tests.TestCaseWithTransport):
410
def test_constructs(self):
411
branch = FakeBranch()
412
my_config = config.BranchConfig(branch)
413
self.assertRaises(TypeError, config.BranchConfig)
415
def test_get_location_config(self):
416
branch = FakeBranch()
417
my_config = config.BranchConfig(branch)
418
location_config = my_config._get_location_config()
419
self.assertEqual(branch.base, location_config.location)
420
self.failUnless(location_config is my_config._get_location_config())
422
def test_get_config(self):
423
"""The Branch.get_config method works properly"""
424
b = bzrdir.BzrDir.create_standalone_workingtree('.').branch
425
my_config = b.get_config()
426
self.assertIs(my_config.get_user_option('wacky'), None)
427
my_config.set_user_option('wacky', 'unlikely')
428
self.assertEqual(my_config.get_user_option('wacky'), 'unlikely')
430
# Ensure we get the same thing if we start again
431
b2 = branch.Branch.open('.')
432
my_config2 = b2.get_config()
433
self.assertEqual(my_config2.get_user_option('wacky'), 'unlikely')
435
def test_has_explicit_nickname(self):
436
b = self.make_branch('.')
437
self.assertFalse(b.get_config().has_explicit_nickname())
439
self.assertTrue(b.get_config().has_explicit_nickname())
441
def test_config_url(self):
442
"""The Branch.get_config will use section that uses a local url"""
443
branch = self.make_branch('branch')
444
self.assertEqual('branch', branch.nick)
446
locations = config.locations_config_filename()
447
config.ensure_config_dir_exists()
448
local_url = urlutils.local_path_to_url('branch')
449
open(locations, 'wb').write('[%s]\nnickname = foobar'
451
self.assertEqual('foobar', branch.nick)
453
def test_config_local_path(self):
454
"""The Branch.get_config will use a local system path"""
455
branch = self.make_branch('branch')
456
self.assertEqual('branch', branch.nick)
458
locations = config.locations_config_filename()
459
config.ensure_config_dir_exists()
460
open(locations, 'wb').write('[%s/branch]\nnickname = barry'
461
% (osutils.getcwd().encode('utf8'),))
462
self.assertEqual('barry', branch.nick)
464
def test_config_creates_local(self):
465
"""Creating a new entry in config uses a local path."""
466
branch = self.make_branch('branch', format='knit')
467
branch.set_push_location('http://foobar')
468
locations = config.locations_config_filename()
469
local_path = osutils.getcwd().encode('utf8')
470
# Surprisingly ConfigObj doesn't create a trailing newline
471
self.check_file_contents(locations,
473
'push_location = http://foobar\n'
474
'push_location:policy = norecurse\n'
477
def test_autonick_urlencoded(self):
478
b = self.make_branch('!repo')
479
self.assertEqual('!repo', b.get_config().get_nickname())
481
def test_warn_if_masked(self):
482
_warning = trace.warning
485
warnings.append(args[0] % args[1:])
487
def set_option(store, warn_masked=True):
489
conf.set_user_option('example_option', repr(store), store=store,
490
warn_masked=warn_masked)
491
def assertWarning(warning):
493
self.assertEqual(0, len(warnings))
495
self.assertEqual(1, len(warnings))
496
self.assertEqual(warning, warnings[0])
497
trace.warning = warning
499
branch = self.make_branch('.')
500
conf = branch.get_config()
501
set_option(config.STORE_GLOBAL)
503
set_option(config.STORE_BRANCH)
505
set_option(config.STORE_GLOBAL)
506
assertWarning('Value "4" is masked by "3" from branch.conf')
507
set_option(config.STORE_GLOBAL, warn_masked=False)
509
set_option(config.STORE_LOCATION)
511
set_option(config.STORE_BRANCH)
512
assertWarning('Value "3" is masked by "0" from locations.conf')
513
set_option(config.STORE_BRANCH, warn_masked=False)
516
trace.warning = _warning
519
class TestGlobalConfigItems(tests.TestCase):
521
def test_user_id(self):
522
config_file = StringIO(sample_config_text.encode('utf-8'))
523
my_config = config.GlobalConfig()
524
my_config._parser = my_config._get_parser(file=config_file)
525
self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
526
my_config._get_user_id())
528
def test_absent_user_id(self):
529
config_file = StringIO("")
530
my_config = config.GlobalConfig()
531
my_config._parser = my_config._get_parser(file=config_file)
532
self.assertEqual(None, my_config._get_user_id())
534
def test_configured_editor(self):
535
config_file = StringIO(sample_config_text.encode('utf-8'))
536
my_config = config.GlobalConfig()
537
my_config._parser = my_config._get_parser(file=config_file)
538
self.assertEqual("vim", my_config.get_editor())
540
def test_signatures_always(self):
541
config_file = StringIO(sample_always_signatures)
542
my_config = config.GlobalConfig()
543
my_config._parser = my_config._get_parser(file=config_file)
544
self.assertEqual(config.CHECK_NEVER,
545
my_config.signature_checking())
546
self.assertEqual(config.SIGN_ALWAYS,
547
my_config.signing_policy())
548
self.assertEqual(True, my_config.signature_needed())
550
def test_signatures_if_possible(self):
551
config_file = StringIO(sample_maybe_signatures)
552
my_config = config.GlobalConfig()
553
my_config._parser = my_config._get_parser(file=config_file)
554
self.assertEqual(config.CHECK_NEVER,
555
my_config.signature_checking())
556
self.assertEqual(config.SIGN_WHEN_REQUIRED,
557
my_config.signing_policy())
558
self.assertEqual(False, my_config.signature_needed())
560
def test_signatures_ignore(self):
561
config_file = StringIO(sample_ignore_signatures)
562
my_config = config.GlobalConfig()
563
my_config._parser = my_config._get_parser(file=config_file)
564
self.assertEqual(config.CHECK_ALWAYS,
565
my_config.signature_checking())
566
self.assertEqual(config.SIGN_NEVER,
567
my_config.signing_policy())
568
self.assertEqual(False, my_config.signature_needed())
570
def _get_sample_config(self):
571
config_file = StringIO(sample_config_text.encode('utf-8'))
572
my_config = config.GlobalConfig()
573
my_config._parser = my_config._get_parser(file=config_file)
576
def test_gpg_signing_command(self):
577
my_config = self._get_sample_config()
578
self.assertEqual("gnome-gpg", my_config.gpg_signing_command())
579
self.assertEqual(False, my_config.signature_needed())
581
def _get_empty_config(self):
582
config_file = StringIO("")
583
my_config = config.GlobalConfig()
584
my_config._parser = my_config._get_parser(file=config_file)
587
def test_gpg_signing_command_unset(self):
588
my_config = self._get_empty_config()
589
self.assertEqual("gpg", my_config.gpg_signing_command())
591
def test_get_user_option_default(self):
592
my_config = self._get_empty_config()
593
self.assertEqual(None, my_config.get_user_option('no_option'))
595
def test_get_user_option_global(self):
596
my_config = self._get_sample_config()
597
self.assertEqual("something",
598
my_config.get_user_option('user_global_option'))
600
def test_post_commit_default(self):
601
my_config = self._get_sample_config()
602
self.assertEqual(None, my_config.post_commit())
604
def test_configured_logformat(self):
605
my_config = self._get_sample_config()
606
self.assertEqual("short", my_config.log_format())
608
def test_get_alias(self):
609
my_config = self._get_sample_config()
610
self.assertEqual('help', my_config.get_alias('h'))
612
def test_get_aliases(self):
613
my_config = self._get_sample_config()
614
aliases = my_config.get_aliases()
615
self.assertEqual(2, len(aliases))
616
sorted_keys = sorted(aliases)
617
self.assertEqual('help', aliases[sorted_keys[0]])
618
self.assertEqual(sample_long_alias, aliases[sorted_keys[1]])
620
def test_get_no_alias(self):
621
my_config = self._get_sample_config()
622
self.assertEqual(None, my_config.get_alias('foo'))
624
def test_get_long_alias(self):
625
my_config = self._get_sample_config()
626
self.assertEqual(sample_long_alias, my_config.get_alias('ll'))
629
class TestGlobalConfigSavingOptions(tests.TestCaseInTempDir):
631
def test_empty(self):
632
my_config = config.GlobalConfig()
633
self.assertEqual(0, len(my_config.get_aliases()))
635
def test_set_alias(self):
636
my_config = config.GlobalConfig()
637
alias_value = 'commit --strict'
638
my_config.set_alias('commit', alias_value)
639
new_config = config.GlobalConfig()
640
self.assertEqual(alias_value, new_config.get_alias('commit'))
642
def test_remove_alias(self):
643
my_config = config.GlobalConfig()
644
my_config.set_alias('commit', 'commit --strict')
645
# Now remove the alias again.
646
my_config.unset_alias('commit')
647
new_config = config.GlobalConfig()
648
self.assertIs(None, new_config.get_alias('commit'))
651
class TestLocationConfig(tests.TestCaseInTempDir):
653
def test_constructs(self):
654
my_config = config.LocationConfig('http://example.com')
655
self.assertRaises(TypeError, config.LocationConfig)
657
def test_branch_calls_read_filenames(self):
658
# This is testing the correct file names are provided.
659
# TODO: consolidate with the test for GlobalConfigs filename checks.
661
# replace the class that is constructed, to check its parameters
662
oldparserclass = config.ConfigObj
663
config.ConfigObj = InstrumentedConfigObj
665
my_config = config.LocationConfig('http://www.example.com')
666
parser = my_config._get_parser()
668
config.ConfigObj = oldparserclass
669
self.failUnless(isinstance(parser, InstrumentedConfigObj))
670
self.assertEqual(parser._calls,
671
[('__init__', config.locations_config_filename(),
673
config.ensure_config_dir_exists()
674
#os.mkdir(config.config_dir())
675
f = file(config.branches_config_filename(), 'wb')
678
oldparserclass = config.ConfigObj
679
config.ConfigObj = InstrumentedConfigObj
681
my_config = config.LocationConfig('http://www.example.com')
682
parser = my_config._get_parser()
684
config.ConfigObj = oldparserclass
686
def test_get_global_config(self):
687
my_config = config.BranchConfig(FakeBranch('http://example.com'))
688
global_config = my_config._get_global_config()
689
self.failUnless(isinstance(global_config, config.GlobalConfig))
690
self.failUnless(global_config is my_config._get_global_config())
692
def test__get_matching_sections_no_match(self):
693
self.get_branch_config('/')
694
self.assertEqual([], self.my_location_config._get_matching_sections())
696
def test__get_matching_sections_exact(self):
697
self.get_branch_config('http://www.example.com')
698
self.assertEqual([('http://www.example.com', '')],
699
self.my_location_config._get_matching_sections())
701
def test__get_matching_sections_suffix_does_not(self):
702
self.get_branch_config('http://www.example.com-com')
703
self.assertEqual([], self.my_location_config._get_matching_sections())
705
def test__get_matching_sections_subdir_recursive(self):
706
self.get_branch_config('http://www.example.com/com')
707
self.assertEqual([('http://www.example.com', 'com')],
708
self.my_location_config._get_matching_sections())
710
def test__get_matching_sections_ignoreparent(self):
711
self.get_branch_config('http://www.example.com/ignoreparent')
712
self.assertEqual([('http://www.example.com/ignoreparent', '')],
713
self.my_location_config._get_matching_sections())
715
def test__get_matching_sections_ignoreparent_subdir(self):
716
self.get_branch_config(
717
'http://www.example.com/ignoreparent/childbranch')
718
self.assertEqual([('http://www.example.com/ignoreparent',
720
self.my_location_config._get_matching_sections())
722
def test__get_matching_sections_subdir_trailing_slash(self):
723
self.get_branch_config('/b')
724
self.assertEqual([('/b/', '')],
725
self.my_location_config._get_matching_sections())
727
def test__get_matching_sections_subdir_child(self):
728
self.get_branch_config('/a/foo')
729
self.assertEqual([('/a/*', ''), ('/a/', 'foo')],
730
self.my_location_config._get_matching_sections())
732
def test__get_matching_sections_subdir_child_child(self):
733
self.get_branch_config('/a/foo/bar')
734
self.assertEqual([('/a/*', 'bar'), ('/a/', 'foo/bar')],
735
self.my_location_config._get_matching_sections())
737
def test__get_matching_sections_trailing_slash_with_children(self):
738
self.get_branch_config('/a/')
739
self.assertEqual([('/a/', '')],
740
self.my_location_config._get_matching_sections())
742
def test__get_matching_sections_explicit_over_glob(self):
743
# XXX: 2006-09-08 jamesh
744
# This test only passes because ord('c') > ord('*'). If there
745
# was a config section for '/a/?', it would get precedence
747
self.get_branch_config('/a/c')
748
self.assertEqual([('/a/c', ''), ('/a/*', ''), ('/a/', 'c')],
749
self.my_location_config._get_matching_sections())
751
def test__get_option_policy_normal(self):
752
self.get_branch_config('http://www.example.com')
754
self.my_location_config._get_config_policy(
755
'http://www.example.com', 'normal_option'),
758
def test__get_option_policy_norecurse(self):
759
self.get_branch_config('http://www.example.com')
761
self.my_location_config._get_option_policy(
762
'http://www.example.com', 'norecurse_option'),
763
config.POLICY_NORECURSE)
764
# Test old recurse=False setting:
766
self.my_location_config._get_option_policy(
767
'http://www.example.com/norecurse', 'normal_option'),
768
config.POLICY_NORECURSE)
770
def test__get_option_policy_normal(self):
771
self.get_branch_config('http://www.example.com')
773
self.my_location_config._get_option_policy(
774
'http://www.example.com', 'appendpath_option'),
775
config.POLICY_APPENDPATH)
777
def test_location_without_username(self):
778
self.get_branch_config('http://www.example.com/ignoreparent')
779
self.assertEqual(u'Erik B\u00e5gfors <erik@bagfors.nu>',
780
self.my_config.username())
782
def test_location_not_listed(self):
783
"""Test that the global username is used when no location matches"""
784
self.get_branch_config('/home/robertc/sources')
785
self.assertEqual(u'Erik B\u00e5gfors <erik@bagfors.nu>',
786
self.my_config.username())
788
def test_overriding_location(self):
789
self.get_branch_config('http://www.example.com/foo')
790
self.assertEqual('Robert Collins <robertc@example.org>',
791
self.my_config.username())
793
def test_signatures_not_set(self):
794
self.get_branch_config('http://www.example.com',
795
global_config=sample_ignore_signatures)
796
self.assertEqual(config.CHECK_ALWAYS,
797
self.my_config.signature_checking())
798
self.assertEqual(config.SIGN_NEVER,
799
self.my_config.signing_policy())
801
def test_signatures_never(self):
802
self.get_branch_config('/a/c')
803
self.assertEqual(config.CHECK_NEVER,
804
self.my_config.signature_checking())
806
def test_signatures_when_available(self):
807
self.get_branch_config('/a/', global_config=sample_ignore_signatures)
808
self.assertEqual(config.CHECK_IF_POSSIBLE,
809
self.my_config.signature_checking())
811
def test_signatures_always(self):
812
self.get_branch_config('/b')
813
self.assertEqual(config.CHECK_ALWAYS,
814
self.my_config.signature_checking())
816
def test_gpg_signing_command(self):
817
self.get_branch_config('/b')
818
self.assertEqual("gnome-gpg", self.my_config.gpg_signing_command())
820
def test_gpg_signing_command_missing(self):
821
self.get_branch_config('/a')
822
self.assertEqual("false", self.my_config.gpg_signing_command())
824
def test_get_user_option_global(self):
825
self.get_branch_config('/a')
826
self.assertEqual('something',
827
self.my_config.get_user_option('user_global_option'))
829
def test_get_user_option_local(self):
830
self.get_branch_config('/a')
831
self.assertEqual('local',
832
self.my_config.get_user_option('user_local_option'))
834
def test_get_user_option_appendpath(self):
835
# returned as is for the base path:
836
self.get_branch_config('http://www.example.com')
837
self.assertEqual('append',
838
self.my_config.get_user_option('appendpath_option'))
839
# Extra path components get appended:
840
self.get_branch_config('http://www.example.com/a/b/c')
841
self.assertEqual('append/a/b/c',
842
self.my_config.get_user_option('appendpath_option'))
843
# Overriden for http://www.example.com/dir, where it is a
845
self.get_branch_config('http://www.example.com/dir/a/b/c')
846
self.assertEqual('normal',
847
self.my_config.get_user_option('appendpath_option'))
849
def test_get_user_option_norecurse(self):
850
self.get_branch_config('http://www.example.com')
851
self.assertEqual('norecurse',
852
self.my_config.get_user_option('norecurse_option'))
853
self.get_branch_config('http://www.example.com/dir')
854
self.assertEqual(None,
855
self.my_config.get_user_option('norecurse_option'))
856
# http://www.example.com/norecurse is a recurse=False section
857
# that redefines normal_option. Subdirectories do not pick up
859
self.get_branch_config('http://www.example.com/norecurse')
860
self.assertEqual('norecurse',
861
self.my_config.get_user_option('normal_option'))
862
self.get_branch_config('http://www.example.com/norecurse/subdir')
863
self.assertEqual('normal',
864
self.my_config.get_user_option('normal_option'))
866
def test_set_user_option_norecurse(self):
867
self.get_branch_config('http://www.example.com')
868
self.my_config.set_user_option('foo', 'bar',
869
store=config.STORE_LOCATION_NORECURSE)
871
self.my_location_config._get_option_policy(
872
'http://www.example.com', 'foo'),
873
config.POLICY_NORECURSE)
875
def test_set_user_option_appendpath(self):
876
self.get_branch_config('http://www.example.com')
877
self.my_config.set_user_option('foo', 'bar',
878
store=config.STORE_LOCATION_APPENDPATH)
880
self.my_location_config._get_option_policy(
881
'http://www.example.com', 'foo'),
882
config.POLICY_APPENDPATH)
884
def test_set_user_option_change_policy(self):
885
self.get_branch_config('http://www.example.com')
886
self.my_config.set_user_option('norecurse_option', 'normal',
887
store=config.STORE_LOCATION)
889
self.my_location_config._get_option_policy(
890
'http://www.example.com', 'norecurse_option'),
893
def test_set_user_option_recurse_false_section(self):
894
# The following section has recurse=False set. The test is to
895
# make sure that a normal option can be added to the section,
896
# converting recurse=False to the norecurse policy.
897
self.get_branch_config('http://www.example.com/norecurse')
898
self.callDeprecated(['The recurse option is deprecated as of 0.14. '
899
'The section "http://www.example.com/norecurse" '
900
'has been converted to use policies.'],
901
self.my_config.set_user_option,
902
'foo', 'bar', store=config.STORE_LOCATION)
904
self.my_location_config._get_option_policy(
905
'http://www.example.com/norecurse', 'foo'),
907
# The previously existing option is still norecurse:
909
self.my_location_config._get_option_policy(
910
'http://www.example.com/norecurse', 'normal_option'),
911
config.POLICY_NORECURSE)
913
def test_post_commit_default(self):
914
self.get_branch_config('/a/c')
915
self.assertEqual('bzrlib.tests.test_config.post_commit',
916
self.my_config.post_commit())
918
def get_branch_config(self, location, global_config=None):
919
if global_config is None:
920
global_file = StringIO(sample_config_text.encode('utf-8'))
922
global_file = StringIO(global_config.encode('utf-8'))
923
branches_file = StringIO(sample_branches_text.encode('utf-8'))
924
self.my_config = config.BranchConfig(FakeBranch(location))
925
# Force location config to use specified file
926
self.my_location_config = self.my_config._get_location_config()
927
self.my_location_config._get_parser(branches_file)
928
# Force global config to use specified file
929
self.my_config._get_global_config()._get_parser(global_file)
931
def test_set_user_setting_sets_and_saves(self):
932
self.get_branch_config('/a/c')
933
record = InstrumentedConfigObj("foo")
934
self.my_location_config._parser = record
936
real_mkdir = os.mkdir
938
def checked_mkdir(path, mode=0777):
939
self.log('making directory: %s', path)
940
real_mkdir(path, mode)
943
os.mkdir = checked_mkdir
945
self.callDeprecated(['The recurse option is deprecated as of '
946
'0.14. The section "/a/c" has been '
947
'converted to use policies.'],
948
self.my_config.set_user_option,
949
'foo', 'bar', store=config.STORE_LOCATION)
951
os.mkdir = real_mkdir
953
self.failUnless(self.created, 'Failed to create ~/.bazaar')
954
self.assertEqual([('__contains__', '/a/c'),
955
('__contains__', '/a/c/'),
956
('__setitem__', '/a/c', {}),
957
('__getitem__', '/a/c'),
958
('__setitem__', 'foo', 'bar'),
959
('__getitem__', '/a/c'),
960
('as_bool', 'recurse'),
961
('__getitem__', '/a/c'),
962
('__delitem__', 'recurse'),
963
('__getitem__', '/a/c'),
965
('__getitem__', '/a/c'),
966
('__contains__', 'foo:policy'),
970
def test_set_user_setting_sets_and_saves2(self):
971
self.get_branch_config('/a/c')
972
self.assertIs(self.my_config.get_user_option('foo'), None)
973
self.my_config.set_user_option('foo', 'bar')
975
self.my_config.branch.control_files.files['branch.conf'].strip(),
977
self.assertEqual(self.my_config.get_user_option('foo'), 'bar')
978
self.my_config.set_user_option('foo', 'baz',
979
store=config.STORE_LOCATION)
980
self.assertEqual(self.my_config.get_user_option('foo'), 'baz')
981
self.my_config.set_user_option('foo', 'qux')
982
self.assertEqual(self.my_config.get_user_option('foo'), 'baz')
984
def test_get_bzr_remote_path(self):
985
my_config = config.LocationConfig('/a/c')
986
self.assertEqual('bzr', my_config.get_bzr_remote_path())
987
my_config.set_user_option('bzr_remote_path', '/path-bzr')
988
self.assertEqual('/path-bzr', my_config.get_bzr_remote_path())
989
os.environ['BZR_REMOTE_PATH'] = '/environ-bzr'
990
self.assertEqual('/environ-bzr', my_config.get_bzr_remote_path())
993
precedence_global = 'option = global'
994
precedence_branch = 'option = branch'
995
precedence_location = """
999
[http://example.com/specific]
1004
class TestBranchConfigItems(tests.TestCaseInTempDir):
1006
def get_branch_config(self, global_config=None, location=None,
1007
location_config=None, branch_data_config=None):
1008
my_config = config.BranchConfig(FakeBranch(location))
1009
if global_config is not None:
1010
global_file = StringIO(global_config.encode('utf-8'))
1011
my_config._get_global_config()._get_parser(global_file)
1012
self.my_location_config = my_config._get_location_config()
1013
if location_config is not None:
1014
location_file = StringIO(location_config.encode('utf-8'))
1015
self.my_location_config._get_parser(location_file)
1016
if branch_data_config is not None:
1017
my_config.branch.control_files.files['branch.conf'] = \
1021
def test_user_id(self):
1022
branch = FakeBranch(user_id='Robert Collins <robertc@example.net>')
1023
my_config = config.BranchConfig(branch)
1024
self.assertEqual("Robert Collins <robertc@example.net>",
1025
my_config.username())
1026
my_config.branch.control_files.files['email'] = "John"
1027
my_config.set_user_option('email',
1028
"Robert Collins <robertc@example.org>")
1029
self.assertEqual("John", my_config.username())
1030
del my_config.branch.control_files.files['email']
1031
self.assertEqual("Robert Collins <robertc@example.org>",
1032
my_config.username())
1034
def test_not_set_in_branch(self):
1035
my_config = self.get_branch_config(sample_config_text)
1036
self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
1037
my_config._get_user_id())
1038
my_config.branch.control_files.files['email'] = "John"
1039
self.assertEqual("John", my_config._get_user_id())
1041
def test_BZR_EMAIL_OVERRIDES(self):
1042
os.environ['BZR_EMAIL'] = "Robert Collins <robertc@example.org>"
1043
branch = FakeBranch()
1044
my_config = config.BranchConfig(branch)
1045
self.assertEqual("Robert Collins <robertc@example.org>",
1046
my_config.username())
1048
def test_signatures_forced(self):
1049
my_config = self.get_branch_config(
1050
global_config=sample_always_signatures)
1051
self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
1052
self.assertEqual(config.SIGN_ALWAYS, my_config.signing_policy())
1053
self.assertTrue(my_config.signature_needed())
1055
def test_signatures_forced_branch(self):
1056
my_config = self.get_branch_config(
1057
global_config=sample_ignore_signatures,
1058
branch_data_config=sample_always_signatures)
1059
self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
1060
self.assertEqual(config.SIGN_ALWAYS, my_config.signing_policy())
1061
self.assertTrue(my_config.signature_needed())
1063
def test_gpg_signing_command(self):
1064
my_config = self.get_branch_config(
1065
# branch data cannot set gpg_signing_command
1066
branch_data_config="gpg_signing_command=pgp")
1067
config_file = StringIO(sample_config_text.encode('utf-8'))
1068
my_config._get_global_config()._get_parser(config_file)
1069
self.assertEqual('gnome-gpg', my_config.gpg_signing_command())
1071
def test_get_user_option_global(self):
1072
branch = FakeBranch()
1073
my_config = config.BranchConfig(branch)
1074
config_file = StringIO(sample_config_text.encode('utf-8'))
1075
(my_config._get_global_config()._get_parser(config_file))
1076
self.assertEqual('something',
1077
my_config.get_user_option('user_global_option'))
1079
def test_post_commit_default(self):
1080
branch = FakeBranch()
1081
my_config = self.get_branch_config(sample_config_text, '/a/c',
1082
sample_branches_text)
1083
self.assertEqual(my_config.branch.base, '/a/c')
1084
self.assertEqual('bzrlib.tests.test_config.post_commit',
1085
my_config.post_commit())
1086
my_config.set_user_option('post_commit', 'rmtree_root')
1087
# post-commit is ignored when bresent in branch data
1088
self.assertEqual('bzrlib.tests.test_config.post_commit',
1089
my_config.post_commit())
1090
my_config.set_user_option('post_commit', 'rmtree_root',
1091
store=config.STORE_LOCATION)
1092
self.assertEqual('rmtree_root', my_config.post_commit())
1094
def test_config_precedence(self):
1095
my_config = self.get_branch_config(global_config=precedence_global)
1096
self.assertEqual(my_config.get_user_option('option'), 'global')
1097
my_config = self.get_branch_config(global_config=precedence_global,
1098
branch_data_config=precedence_branch)
1099
self.assertEqual(my_config.get_user_option('option'), 'branch')
1100
my_config = self.get_branch_config(global_config=precedence_global,
1101
branch_data_config=precedence_branch,
1102
location_config=precedence_location)
1103
self.assertEqual(my_config.get_user_option('option'), 'recurse')
1104
my_config = self.get_branch_config(global_config=precedence_global,
1105
branch_data_config=precedence_branch,
1106
location_config=precedence_location,
1107
location='http://example.com/specific')
1108
self.assertEqual(my_config.get_user_option('option'), 'exact')
1110
def test_get_mail_client(self):
1111
config = self.get_branch_config()
1112
client = config.get_mail_client()
1113
self.assertIsInstance(client, mail_client.DefaultMail)
1116
config.set_user_option('mail_client', 'evolution')
1117
client = config.get_mail_client()
1118
self.assertIsInstance(client, mail_client.Evolution)
1120
config.set_user_option('mail_client', 'kmail')
1121
client = config.get_mail_client()
1122
self.assertIsInstance(client, mail_client.KMail)
1124
config.set_user_option('mail_client', 'mutt')
1125
client = config.get_mail_client()
1126
self.assertIsInstance(client, mail_client.Mutt)
1128
config.set_user_option('mail_client', 'thunderbird')
1129
client = config.get_mail_client()
1130
self.assertIsInstance(client, mail_client.Thunderbird)
1133
config.set_user_option('mail_client', 'default')
1134
client = config.get_mail_client()
1135
self.assertIsInstance(client, mail_client.DefaultMail)
1137
config.set_user_option('mail_client', 'editor')
1138
client = config.get_mail_client()
1139
self.assertIsInstance(client, mail_client.Editor)
1141
config.set_user_option('mail_client', 'mapi')
1142
client = config.get_mail_client()
1143
self.assertIsInstance(client, mail_client.MAPIClient)
1145
config.set_user_option('mail_client', 'xdg-email')
1146
client = config.get_mail_client()
1147
self.assertIsInstance(client, mail_client.XDGEmail)
1149
config.set_user_option('mail_client', 'firebird')
1150
self.assertRaises(errors.UnknownMailClient, config.get_mail_client)
1153
class TestMailAddressExtraction(tests.TestCase):
1155
def test_extract_email_address(self):
1156
self.assertEqual('jane@test.com',
1157
config.extract_email_address('Jane <jane@test.com>'))
1158
self.assertRaises(errors.NoEmailInUsername,
1159
config.extract_email_address, 'Jane Tester')
1161
def test_parse_username(self):
1162
self.assertEqual(('', 'jdoe@example.com'),
1163
config.parse_username('jdoe@example.com'))
1164
self.assertEqual(('', 'jdoe@example.com'),
1165
config.parse_username('<jdoe@example.com>'))
1166
self.assertEqual(('John Doe', 'jdoe@example.com'),
1167
config.parse_username('John Doe <jdoe@example.com>'))
1168
self.assertEqual(('John Doe', ''),
1169
config.parse_username('John Doe'))
1170
self.assertEqual(('John Doe', 'jdoe@example.com'),
1171
config.parse_username('John Doe jdoe@example.com'))
1173
class TestTreeConfig(tests.TestCaseWithTransport):
1175
def test_get_value(self):
1176
"""Test that retreiving a value from a section is possible"""
1177
branch = self.make_branch('.')
1178
tree_config = config.TreeConfig(branch)
1179
tree_config.set_option('value', 'key', 'SECTION')
1180
tree_config.set_option('value2', 'key2')
1181
tree_config.set_option('value3-top', 'key3')
1182
tree_config.set_option('value3-section', 'key3', 'SECTION')
1183
value = tree_config.get_option('key', 'SECTION')
1184
self.assertEqual(value, 'value')
1185
value = tree_config.get_option('key2')
1186
self.assertEqual(value, 'value2')
1187
self.assertEqual(tree_config.get_option('non-existant'), None)
1188
value = tree_config.get_option('non-existant', 'SECTION')
1189
self.assertEqual(value, None)
1190
value = tree_config.get_option('non-existant', default='default')
1191
self.assertEqual(value, 'default')
1192
self.assertEqual(tree_config.get_option('key2', 'NOSECTION'), None)
1193
value = tree_config.get_option('key2', 'NOSECTION', default='default')
1194
self.assertEqual(value, 'default')
1195
value = tree_config.get_option('key3')
1196
self.assertEqual(value, 'value3-top')
1197
value = tree_config.get_option('key3', 'SECTION')
1198
self.assertEqual(value, 'value3-section')
1201
class TestTransportConfig(tests.TestCaseWithTransport):
1203
def test_get_value(self):
1204
"""Test that retreiving a value from a section is possible"""
1205
bzrdir_config = config.TransportConfig(transport.get_transport('.'),
1207
bzrdir_config.set_option('value', 'key', 'SECTION')
1208
bzrdir_config.set_option('value2', 'key2')
1209
bzrdir_config.set_option('value3-top', 'key3')
1210
bzrdir_config.set_option('value3-section', 'key3', 'SECTION')
1211
value = bzrdir_config.get_option('key', 'SECTION')
1212
self.assertEqual(value, 'value')
1213
value = bzrdir_config.get_option('key2')
1214
self.assertEqual(value, 'value2')
1215
self.assertEqual(bzrdir_config.get_option('non-existant'), None)
1216
value = bzrdir_config.get_option('non-existant', 'SECTION')
1217
self.assertEqual(value, None)
1218
value = bzrdir_config.get_option('non-existant', default='default')
1219
self.assertEqual(value, 'default')
1220
self.assertEqual(bzrdir_config.get_option('key2', 'NOSECTION'), None)
1221
value = bzrdir_config.get_option('key2', 'NOSECTION',
1223
self.assertEqual(value, 'default')
1224
value = bzrdir_config.get_option('key3')
1225
self.assertEqual(value, 'value3-top')
1226
value = bzrdir_config.get_option('key3', 'SECTION')
1227
self.assertEqual(value, 'value3-section')
1229
def test_set_unset_default_stack_on(self):
1230
my_dir = self.make_bzrdir('.')
1231
bzrdir_config = config.BzrDirConfig(my_dir)
1232
self.assertIs(None, bzrdir_config.get_default_stack_on())
1233
bzrdir_config.set_default_stack_on('Foo')
1234
self.assertEqual('Foo', bzrdir_config._config.get_option(
1235
'default_stack_on'))
1236
self.assertEqual('Foo', bzrdir_config.get_default_stack_on())
1237
bzrdir_config.set_default_stack_on(None)
1238
self.assertIs(None, bzrdir_config.get_default_stack_on())
1241
class TestAuthenticationConfigFile(tests.TestCase):
1242
"""Test the authentication.conf file matching"""
1244
def _got_user_passwd(self, expected_user, expected_password,
1245
config, *args, **kwargs):
1246
credentials = config.get_credentials(*args, **kwargs)
1247
if credentials is None:
1251
user = credentials['user']
1252
password = credentials['password']
1253
self.assertEquals(expected_user, user)
1254
self.assertEquals(expected_password, password)
1256
def test_empty_config(self):
1257
conf = config.AuthenticationConfig(_file=StringIO())
1258
self.assertEquals({}, conf._get_config())
1259
self._got_user_passwd(None, None, conf, 'http', 'foo.net')
1261
def test_missing_auth_section_header(self):
1262
conf = config.AuthenticationConfig(_file=StringIO('foo = bar'))
1263
self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
1265
def test_auth_section_header_not_closed(self):
1266
conf = config.AuthenticationConfig(_file=StringIO('[DEF'))
1267
self.assertRaises(errors.ParseConfigError, conf._get_config)
1269
def test_auth_value_not_boolean(self):
1270
conf = config.AuthenticationConfig(_file=StringIO(
1274
verify_certificates=askme # Error: Not a boolean
1276
self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
1278
def test_auth_value_not_int(self):
1279
conf = config.AuthenticationConfig(_file=StringIO(
1283
port=port # Error: Not an int
1285
self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
1287
def test_unknown_password_encoding(self):
1288
conf = config.AuthenticationConfig(_file=StringIO(
1292
password_encoding=unknown
1294
self.assertRaises(ValueError, conf.get_password,
1295
'ftp', 'foo.net', 'joe')
1297
def test_credentials_for_scheme_host(self):
1298
conf = config.AuthenticationConfig(_file=StringIO(
1299
"""# Identity on foo.net
1304
password=secret-pass
1307
self._got_user_passwd('joe', 'secret-pass', conf, 'ftp', 'foo.net')
1309
self._got_user_passwd(None, None, conf, 'http', 'foo.net')
1311
self._got_user_passwd(None, None, conf, 'ftp', 'bar.net')
1313
def test_credentials_for_host_port(self):
1314
conf = config.AuthenticationConfig(_file=StringIO(
1315
"""# Identity on foo.net
1321
password=secret-pass
1324
self._got_user_passwd('joe', 'secret-pass',
1325
conf, 'ftp', 'foo.net', port=10021)
1327
self._got_user_passwd(None, None, conf, 'ftp', 'foo.net')
1329
def test_for_matching_host(self):
1330
conf = config.AuthenticationConfig(_file=StringIO(
1331
"""# Identity on foo.net
1337
[sourceforge domain]
1344
self._got_user_passwd('georges', 'bendover',
1345
conf, 'bzr', 'foo.bzr.sf.net')
1347
self._got_user_passwd(None, None,
1348
conf, 'bzr', 'bbzr.sf.net')
1350
def test_for_matching_host_None(self):
1351
conf = config.AuthenticationConfig(_file=StringIO(
1352
"""# Identity on foo.net
1362
self._got_user_passwd('joe', 'joepass',
1363
conf, 'bzr', 'quux.net')
1364
# no host but different scheme
1365
self._got_user_passwd('georges', 'bendover',
1366
conf, 'ftp', 'quux.net')
1368
def test_credentials_for_path(self):
1369
conf = config.AuthenticationConfig(_file=StringIO(
1385
self._got_user_passwd(None, None,
1386
conf, 'http', host='bar.org', path='/dir3')
1388
self._got_user_passwd('georges', 'bendover',
1389
conf, 'http', host='bar.org', path='/dir2')
1391
self._got_user_passwd('jim', 'jimpass',
1392
conf, 'http', host='bar.org',path='/dir1/subdir')
1394
def test_credentials_for_user(self):
1395
conf = config.AuthenticationConfig(_file=StringIO(
1404
self._got_user_passwd('jim', 'jimpass',
1405
conf, 'http', 'bar.org')
1407
self._got_user_passwd('jim', 'jimpass',
1408
conf, 'http', 'bar.org', user='jim')
1409
# Don't get a different user if one is specified
1410
self._got_user_passwd(None, None,
1411
conf, 'http', 'bar.org', user='georges')
1413
def test_credentials_for_user_without_password(self):
1414
conf = config.AuthenticationConfig(_file=StringIO(
1421
# Get user but no password
1422
self._got_user_passwd('jim', None,
1423
conf, 'http', 'bar.org')
1425
def test_verify_certificates(self):
1426
conf = config.AuthenticationConfig(_file=StringIO(
1433
verify_certificates=False
1440
credentials = conf.get_credentials('https', 'bar.org')
1441
self.assertEquals(False, credentials.get('verify_certificates'))
1442
credentials = conf.get_credentials('https', 'foo.net')
1443
self.assertEquals(True, credentials.get('verify_certificates'))
1446
class TestAuthenticationStorage(tests.TestCaseInTempDir):
1448
def test_set_credentials(self):
1449
conf = config.AuthenticationConfig()
1450
conf.set_credentials('name', 'host', 'user', 'scheme', 'password',
1451
99, path='/foo', verify_certificates=False, realm='realm')
1452
credentials = conf.get_credentials(host='host', scheme='scheme',
1453
port=99, path='/foo',
1455
CREDENTIALS = {'name': 'name', 'user': 'user', 'password': 'password',
1456
'verify_certificates': False, 'scheme': 'scheme',
1457
'host': 'host', 'port': 99, 'path': '/foo',
1459
self.assertEqual(CREDENTIALS, credentials)
1460
credentials_from_disk = config.AuthenticationConfig().get_credentials(
1461
host='host', scheme='scheme', port=99, path='/foo', realm='realm')
1462
self.assertEqual(CREDENTIALS, credentials_from_disk)
1464
def test_reset_credentials_different_name(self):
1465
conf = config.AuthenticationConfig()
1466
conf.set_credentials('name', 'host', 'user', 'scheme', 'password'),
1467
conf.set_credentials('name2', 'host', 'user2', 'scheme', 'password'),
1468
self.assertIs(None, conf._get_config().get('name'))
1469
credentials = conf.get_credentials(host='host', scheme='scheme')
1470
CREDENTIALS = {'name': 'name2', 'user': 'user2', 'password':
1471
'password', 'verify_certificates': True,
1472
'scheme': 'scheme', 'host': 'host', 'port': None,
1473
'path': None, 'realm': None}
1474
self.assertEqual(CREDENTIALS, credentials)
1477
class TestAuthenticationConfig(tests.TestCase):
1478
"""Test AuthenticationConfig behaviour"""
1480
def _check_default_password_prompt(self, expected_prompt_format, scheme,
1481
host=None, port=None, realm=None,
1485
user, password = 'jim', 'precious'
1486
expected_prompt = expected_prompt_format % {
1487
'scheme': scheme, 'host': host, 'port': port,
1488
'user': user, 'realm': realm}
1490
stdout = tests.StringIOWrapper()
1491
stderr = tests.StringIOWrapper()
1492
ui.ui_factory = tests.TestUIFactory(stdin=password + '\n',
1493
stdout=stdout, stderr=stderr)
1494
# We use an empty conf so that the user is always prompted
1495
conf = config.AuthenticationConfig()
1496
self.assertEquals(password,
1497
conf.get_password(scheme, host, user, port=port,
1498
realm=realm, path=path))
1499
self.assertEquals(expected_prompt, stderr.getvalue())
1500
self.assertEquals('', stdout.getvalue())
1502
def _check_default_username_prompt(self, expected_prompt_format, scheme,
1503
host=None, port=None, realm=None,
1508
expected_prompt = expected_prompt_format % {
1509
'scheme': scheme, 'host': host, 'port': port,
1511
stdout = tests.StringIOWrapper()
1512
stderr = tests.StringIOWrapper()
1513
ui.ui_factory = tests.TestUIFactory(stdin=username+ '\n',
1514
stdout=stdout, stderr=stderr)
1515
# We use an empty conf so that the user is always prompted
1516
conf = config.AuthenticationConfig()
1517
self.assertEquals(username, conf.get_user(scheme, host, port=port,
1518
realm=realm, path=path, ask=True))
1519
self.assertEquals(expected_prompt, stderr.getvalue())
1520
self.assertEquals('', stdout.getvalue())
1522
def test_username_defaults_prompts(self):
1523
# HTTP prompts can't be tested here, see test_http.py
1524
self._check_default_username_prompt('FTP %(host)s username: ', 'ftp')
1525
self._check_default_username_prompt(
1526
'FTP %(host)s:%(port)d username: ', 'ftp', port=10020)
1527
self._check_default_username_prompt(
1528
'SSH %(host)s:%(port)d username: ', 'ssh', port=12345)
1530
def test_username_default_no_prompt(self):
1531
conf = config.AuthenticationConfig()
1532
self.assertEquals(None,
1533
conf.get_user('ftp', 'example.com'))
1534
self.assertEquals("explicitdefault",
1535
conf.get_user('ftp', 'example.com', default="explicitdefault"))
1537
def test_password_default_prompts(self):
1538
# HTTP prompts can't be tested here, see test_http.py
1539
self._check_default_password_prompt(
1540
'FTP %(user)s@%(host)s password: ', 'ftp')
1541
self._check_default_password_prompt(
1542
'FTP %(user)s@%(host)s:%(port)d password: ', 'ftp', port=10020)
1543
self._check_default_password_prompt(
1544
'SSH %(user)s@%(host)s:%(port)d password: ', 'ssh', port=12345)
1545
# SMTP port handling is a bit special (it's handled if embedded in the
1547
# FIXME: should we: forbid that, extend it to other schemes, leave
1548
# things as they are that's fine thank you ?
1549
self._check_default_password_prompt('SMTP %(user)s@%(host)s password: ',
1551
self._check_default_password_prompt('SMTP %(user)s@%(host)s password: ',
1552
'smtp', host='bar.org:10025')
1553
self._check_default_password_prompt(
1554
'SMTP %(user)s@%(host)s:%(port)d password: ',
1557
def test_ssh_password_emits_warning(self):
1558
conf = config.AuthenticationConfig(_file=StringIO(
1566
entered_password = 'typed-by-hand'
1567
stdout = tests.StringIOWrapper()
1568
stderr = tests.StringIOWrapper()
1569
ui.ui_factory = tests.TestUIFactory(stdin=entered_password + '\n',
1570
stdout=stdout, stderr=stderr)
1572
# Since the password defined in the authentication config is ignored,
1573
# the user is prompted
1574
self.assertEquals(entered_password,
1575
conf.get_password('ssh', 'bar.org', user='jim'))
1576
self.assertContainsRe(
1577
self._get_log(keep_log_file=True),
1578
'password ignored in section \[ssh with password\]')
1580
def test_ssh_without_password_doesnt_emit_warning(self):
1581
conf = config.AuthenticationConfig(_file=StringIO(
1588
entered_password = 'typed-by-hand'
1589
stdout = tests.StringIOWrapper()
1590
stderr = tests.StringIOWrapper()
1591
ui.ui_factory = tests.TestUIFactory(stdin=entered_password + '\n',
1595
# Since the password defined in the authentication config is ignored,
1596
# the user is prompted
1597
self.assertEquals(entered_password,
1598
conf.get_password('ssh', 'bar.org', user='jim'))
1599
# No warning shoud be emitted since there is no password. We are only
1601
self.assertNotContainsRe(
1602
self._get_log(keep_log_file=True),
1603
'password ignored in section \[ssh with password\]')
1605
def test_uses_fallback_stores(self):
1606
self._old_cs_registry = config.credential_store_registry
1608
config.credential_store_registry = self._old_cs_registry
1609
self.addCleanup(restore)
1610
config.credential_store_registry = config.CredentialStoreRegistry()
1611
store = StubCredentialStore()
1612
store.add_credentials("http", "example.com", "joe", "secret")
1613
config.credential_store_registry.register("stub", store, fallback=True)
1614
conf = config.AuthenticationConfig(_file=StringIO())
1615
creds = conf.get_credentials("http", "example.com")
1616
self.assertEquals("joe", creds["user"])
1617
self.assertEquals("secret", creds["password"])
1620
class StubCredentialStore(config.CredentialStore):
1626
def add_credentials(self, scheme, host, user, password=None):
1627
self._username[(scheme, host)] = user
1628
self._password[(scheme, host)] = password
1630
def get_credentials(self, scheme, host, port=None, user=None,
1631
path=None, realm=None):
1632
key = (scheme, host)
1633
if not key in self._username:
1635
return { "scheme": scheme, "host": host, "port": port,
1636
"user": self._username[key], "password": self._password[key]}
1639
class CountingCredentialStore(config.CredentialStore):
1644
def get_credentials(self, scheme, host, port=None, user=None,
1645
path=None, realm=None):
1650
class TestCredentialStoreRegistry(tests.TestCase):
1652
def _get_cs_registry(self):
1653
return config.credential_store_registry
1655
def test_default_credential_store(self):
1656
r = self._get_cs_registry()
1657
default = r.get_credential_store(None)
1658
self.assertIsInstance(default, config.PlainTextCredentialStore)
1660
def test_unknown_credential_store(self):
1661
r = self._get_cs_registry()
1662
# It's hard to imagine someone creating a credential store named
1663
# 'unknown' so we use that as an never registered key.
1664
self.assertRaises(KeyError, r.get_credential_store, 'unknown')
1666
def test_fallback_none_registered(self):
1667
r = config.CredentialStoreRegistry()
1668
self.assertEquals(None,
1669
r.get_fallback_credentials("http", "example.com"))
1671
def test_register(self):
1672
r = config.CredentialStoreRegistry()
1673
r.register("stub", StubCredentialStore(), fallback=False)
1674
r.register("another", StubCredentialStore(), fallback=True)
1675
self.assertEquals(["another", "stub"], r.keys())
1677
def test_register_lazy(self):
1678
r = config.CredentialStoreRegistry()
1679
r.register_lazy("stub", "bzrlib.tests.test_config",
1680
"StubCredentialStore", fallback=False)
1681
self.assertEquals(["stub"], r.keys())
1682
self.assertIsInstance(r.get_credential_store("stub"),
1683
StubCredentialStore)
1685
def test_is_fallback(self):
1686
r = config.CredentialStoreRegistry()
1687
r.register("stub1", None, fallback=False)
1688
r.register("stub2", None, fallback=True)
1689
self.assertEquals(False, r.is_fallback("stub1"))
1690
self.assertEquals(True, r.is_fallback("stub2"))
1692
def test_no_fallback(self):
1693
r = config.CredentialStoreRegistry()
1694
store = CountingCredentialStore()
1695
r.register("count", store, fallback=False)
1696
self.assertEquals(None,
1697
r.get_fallback_credentials("http", "example.com"))
1698
self.assertEquals(0, store._calls)
1700
def test_fallback_credentials(self):
1701
r = config.CredentialStoreRegistry()
1702
store = StubCredentialStore()
1703
store.add_credentials("http", "example.com",
1704
"somebody", "geheim")
1705
r.register("stub", store, fallback=True)
1706
creds = r.get_fallback_credentials("http", "example.com")
1707
self.assertEquals("somebody", creds["user"])
1708
self.assertEquals("geheim", creds["password"])
1710
def test_fallback_first_wins(self):
1711
r = config.CredentialStoreRegistry()
1712
stub1 = StubCredentialStore()
1713
stub1.add_credentials("http", "example.com",
1714
"somebody", "stub1")
1715
r.register("stub1", stub1, fallback=True)
1716
stub2 = StubCredentialStore()
1717
stub2.add_credentials("http", "example.com",
1718
"somebody", "stub2")
1719
r.register("stub2", stub1, fallback=True)
1720
creds = r.get_fallback_credentials("http", "example.com")
1721
self.assertEquals("somebody", creds["user"])
1722
self.assertEquals("stub1", creds["password"])
1725
class TestPlainTextCredentialStore(tests.TestCase):
1727
def test_decode_password(self):
1728
r = config.credential_store_registry
1729
plain_text = r.get_credential_store()
1730
decoded = plain_text.decode_password(dict(password='secret'))
1731
self.assertEquals('secret', decoded)
1734
# FIXME: Once we have a way to declare authentication to all test servers, we
1735
# can implement generic tests.
1736
# test_user_password_in_url
1737
# test_user_in_url_password_from_config
1738
# test_user_in_url_password_prompted
1739
# test_user_in_config
1740
# test_user_getpass.getuser
1741
# test_user_prompted ?
1742
class TestAuthenticationRing(tests.TestCaseWithTransport):
added
removed
bzrlib/tests/test_config.py
