1
# Copyright (C) 2005, 2006, 2008 Canonical Ltd
2
# Authors: Robert Collins <robert.collins@canonical.com>
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
"""Tests for finding and reading the bzr config file[s]."""
19
# import system imports here
20
from cStringIO import StringIO
24
#import bzrlib specific imports here
38
from bzrlib.util.configobj import configobj
41
sample_long_alias="log -r-15..-1 --line"
42
sample_config_text = u"""
44
email=Erik B\u00e5gfors <erik@bagfors.nu>
46
gpg_signing_command=gnome-gpg
48
user_global_option=something
51
ll=""" + sample_long_alias + "\n"
54
sample_always_signatures = """
56
check_signatures=ignore
57
create_signatures=always
60
sample_ignore_signatures = """
62
check_signatures=require
63
create_signatures=never
66
sample_maybe_signatures = """
68
check_signatures=ignore
69
create_signatures=when-required
72
sample_branches_text = """
73
[http://www.example.com]
75
email=Robert Collins <robertc@example.org>
76
normal_option = normal
77
appendpath_option = append
78
appendpath_option:policy = appendpath
79
norecurse_option = norecurse
80
norecurse_option:policy = norecurse
81
[http://www.example.com/ignoreparent]
82
# different project: ignore parent dir config
84
[http://www.example.com/norecurse]
85
# configuration items that only apply to this dir
87
normal_option = norecurse
88
[http://www.example.com/dir]
89
appendpath_option = normal
91
check_signatures=require
92
# test trailing / matching with no children
94
check_signatures=check-available
95
gpg_signing_command=false
96
user_local_option=local
97
# test trailing / matching
99
#subdirs will match but not the parent
101
check_signatures=ignore
102
post_commit=bzrlib.tests.test_config.post_commit
103
#testing explicit beats globs
107
class InstrumentedConfigObj(object):
108
"""A config obj look-enough-alike to record calls made to it."""
110
def __contains__(self, thing):
111
self._calls.append(('__contains__', thing))
114
def __getitem__(self, key):
115
self._calls.append(('__getitem__', key))
118
def __init__(self, input, encoding=None):
119
self._calls = [('__init__', input, encoding)]
121
def __setitem__(self, key, value):
122
self._calls.append(('__setitem__', key, value))
124
def __delitem__(self, key):
125
self._calls.append(('__delitem__', key))
128
self._calls.append(('keys',))
131
def write(self, arg):
132
self._calls.append(('write',))
134
def as_bool(self, value):
135
self._calls.append(('as_bool', value))
138
def get_value(self, section, name):
139
self._calls.append(('get_value', section, name))
143
class FakeBranch(object):
145
def __init__(self, base=None, user_id=None):
147
self.base = "http://example.com/branches/demo"
150
self._transport = self.control_files = \
151
FakeControlFilesAndTransport(user_id=user_id)
153
def _get_config(self):
154
return config.TransportConfig(self._transport, 'branch.conf')
156
def lock_write(self):
163
class FakeControlFilesAndTransport(object):
165
def __init__(self, user_id=None):
168
self.files['email'] = user_id
169
self._transport = self
171
def get_utf8(self, filename):
173
raise AssertionError("get_utf8 should no longer be used")
175
def get(self, filename):
178
return StringIO(self.files[filename])
180
raise errors.NoSuchFile(filename)
182
def get_bytes(self, filename):
185
return self.files[filename]
187
raise errors.NoSuchFile(filename)
189
def put(self, filename, fileobj):
190
self.files[filename] = fileobj.read()
192
def put_file(self, filename, fileobj):
193
return self.put(filename, fileobj)
196
class InstrumentedConfig(config.Config):
197
"""An instrumented config that supplies stubs for template methods."""
200
super(InstrumentedConfig, self).__init__()
202
self._signatures = config.CHECK_NEVER
204
def _get_user_id(self):
205
self._calls.append('_get_user_id')
206
return "Robert Collins <robert.collins@example.org>"
208
def _get_signature_checking(self):
209
self._calls.append('_get_signature_checking')
210
return self._signatures
213
bool_config = """[DEFAULT]
222
class TestConfigObj(tests.TestCase):
224
def test_get_bool(self):
225
co = config.ConfigObj(StringIO(bool_config))
226
self.assertIs(co.get_bool('DEFAULT', 'active'), True)
227
self.assertIs(co.get_bool('DEFAULT', 'inactive'), False)
228
self.assertIs(co.get_bool('UPPERCASE', 'active'), True)
229
self.assertIs(co.get_bool('UPPERCASE', 'nonactive'), False)
231
def test_hash_sign_in_value(self):
233
Before 4.5.0, ConfigObj did not quote # signs in values, so they'd be
234
treated as comments when read in again. (#86838)
236
co = config.ConfigObj()
237
co['test'] = 'foo#bar'
239
self.assertEqual(lines, ['test = "foo#bar"'])
240
co2 = config.ConfigObj(lines)
241
self.assertEqual(co2['test'], 'foo#bar')
244
erroneous_config = """[section] # line 1
247
whocares=notme # line 4
251
class TestConfigObjErrors(tests.TestCase):
253
def test_duplicate_section_name_error_line(self):
255
co = configobj.ConfigObj(StringIO(erroneous_config),
257
except config.configobj.DuplicateError, e:
258
self.assertEqual(3, e.line_number)
260
self.fail('Error in config file not detected')
263
class TestConfig(tests.TestCase):
265
def test_constructs(self):
268
def test_no_default_editor(self):
269
self.assertRaises(NotImplementedError, config.Config().get_editor)
271
def test_user_email(self):
272
my_config = InstrumentedConfig()
273
self.assertEqual('robert.collins@example.org', my_config.user_email())
274
self.assertEqual(['_get_user_id'], my_config._calls)
276
def test_username(self):
277
my_config = InstrumentedConfig()
278
self.assertEqual('Robert Collins <robert.collins@example.org>',
279
my_config.username())
280
self.assertEqual(['_get_user_id'], my_config._calls)
282
def test_signatures_default(self):
283
my_config = config.Config()
284
self.assertFalse(my_config.signature_needed())
285
self.assertEqual(config.CHECK_IF_POSSIBLE,
286
my_config.signature_checking())
287
self.assertEqual(config.SIGN_WHEN_REQUIRED,
288
my_config.signing_policy())
290
def test_signatures_template_method(self):
291
my_config = InstrumentedConfig()
292
self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
293
self.assertEqual(['_get_signature_checking'], my_config._calls)
295
def test_signatures_template_method_none(self):
296
my_config = InstrumentedConfig()
297
my_config._signatures = None
298
self.assertEqual(config.CHECK_IF_POSSIBLE,
299
my_config.signature_checking())
300
self.assertEqual(['_get_signature_checking'], my_config._calls)
302
def test_gpg_signing_command_default(self):
303
my_config = config.Config()
304
self.assertEqual('gpg', my_config.gpg_signing_command())
306
def test_get_user_option_default(self):
307
my_config = config.Config()
308
self.assertEqual(None, my_config.get_user_option('no_option'))
310
def test_post_commit_default(self):
311
my_config = config.Config()
312
self.assertEqual(None, my_config.post_commit())
314
def test_log_format_default(self):
315
my_config = config.Config()
316
self.assertEqual('long', my_config.log_format())
319
class TestConfigPath(tests.TestCase):
322
super(TestConfigPath, self).setUp()
323
os.environ['HOME'] = '/home/bogus'
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')
352
class TestIniConfig(tests.TestCase):
354
def test_contructs(self):
355
my_config = config.IniBasedConfig("nothing")
357
def test_from_fp(self):
358
config_file = StringIO(sample_config_text.encode('utf-8'))
359
my_config = config.IniBasedConfig(None)
361
isinstance(my_config._get_parser(file=config_file),
362
configobj.ConfigObj))
364
def test_cached(self):
365
config_file = StringIO(sample_config_text.encode('utf-8'))
366
my_config = config.IniBasedConfig(None)
367
parser = my_config._get_parser(file=config_file)
368
self.failUnless(my_config._get_parser() is parser)
371
class TestGetConfig(tests.TestCase):
373
def test_constructs(self):
374
my_config = config.GlobalConfig()
376
def test_calls_read_filenames(self):
377
# replace the class that is constructed, to check its parameters
378
oldparserclass = config.ConfigObj
379
config.ConfigObj = InstrumentedConfigObj
380
my_config = config.GlobalConfig()
382
parser = my_config._get_parser()
384
config.ConfigObj = oldparserclass
385
self.failUnless(isinstance(parser, InstrumentedConfigObj))
386
self.assertEqual(parser._calls, [('__init__', config.config_filename(),
390
class TestBranchConfig(tests.TestCaseWithTransport):
392
def test_constructs(self):
393
branch = FakeBranch()
394
my_config = config.BranchConfig(branch)
395
self.assertRaises(TypeError, config.BranchConfig)
397
def test_get_location_config(self):
398
branch = FakeBranch()
399
my_config = config.BranchConfig(branch)
400
location_config = my_config._get_location_config()
401
self.assertEqual(branch.base, location_config.location)
402
self.failUnless(location_config is my_config._get_location_config())
404
def test_get_config(self):
405
"""The Branch.get_config method works properly"""
406
b = bzrdir.BzrDir.create_standalone_workingtree('.').branch
407
my_config = b.get_config()
408
self.assertIs(my_config.get_user_option('wacky'), None)
409
my_config.set_user_option('wacky', 'unlikely')
410
self.assertEqual(my_config.get_user_option('wacky'), 'unlikely')
412
# Ensure we get the same thing if we start again
413
b2 = branch.Branch.open('.')
414
my_config2 = b2.get_config()
415
self.assertEqual(my_config2.get_user_option('wacky'), 'unlikely')
417
def test_has_explicit_nickname(self):
418
b = self.make_branch('.')
419
self.assertFalse(b.get_config().has_explicit_nickname())
421
self.assertTrue(b.get_config().has_explicit_nickname())
423
def test_config_url(self):
424
"""The Branch.get_config will use section that uses a local url"""
425
branch = self.make_branch('branch')
426
self.assertEqual('branch', branch.nick)
428
locations = config.locations_config_filename()
429
config.ensure_config_dir_exists()
430
local_url = urlutils.local_path_to_url('branch')
431
open(locations, 'wb').write('[%s]\nnickname = foobar'
433
self.assertEqual('foobar', branch.nick)
435
def test_config_local_path(self):
436
"""The Branch.get_config will use a local system path"""
437
branch = self.make_branch('branch')
438
self.assertEqual('branch', branch.nick)
440
locations = config.locations_config_filename()
441
config.ensure_config_dir_exists()
442
open(locations, 'wb').write('[%s/branch]\nnickname = barry'
443
% (osutils.getcwd().encode('utf8'),))
444
self.assertEqual('barry', branch.nick)
446
def test_config_creates_local(self):
447
"""Creating a new entry in config uses a local path."""
448
branch = self.make_branch('branch', format='knit')
449
branch.set_push_location('http://foobar')
450
locations = config.locations_config_filename()
451
local_path = osutils.getcwd().encode('utf8')
452
# Surprisingly ConfigObj doesn't create a trailing newline
453
self.check_file_contents(locations,
455
'push_location = http://foobar\n'
456
'push_location:policy = norecurse\n'
459
def test_autonick_urlencoded(self):
460
b = self.make_branch('!repo')
461
self.assertEqual('!repo', b.get_config().get_nickname())
463
def test_warn_if_masked(self):
464
_warning = trace.warning
467
warnings.append(args[0] % args[1:])
469
def set_option(store, warn_masked=True):
471
conf.set_user_option('example_option', repr(store), store=store,
472
warn_masked=warn_masked)
473
def assertWarning(warning):
475
self.assertEqual(0, len(warnings))
477
self.assertEqual(1, len(warnings))
478
self.assertEqual(warning, warnings[0])
479
trace.warning = warning
481
branch = self.make_branch('.')
482
conf = branch.get_config()
483
set_option(config.STORE_GLOBAL)
485
set_option(config.STORE_BRANCH)
487
set_option(config.STORE_GLOBAL)
488
assertWarning('Value "4" is masked by "3" from branch.conf')
489
set_option(config.STORE_GLOBAL, warn_masked=False)
491
set_option(config.STORE_LOCATION)
493
set_option(config.STORE_BRANCH)
494
assertWarning('Value "3" is masked by "0" from locations.conf')
495
set_option(config.STORE_BRANCH, warn_masked=False)
498
trace.warning = _warning
501
class TestGlobalConfigItems(tests.TestCase):
503
def test_user_id(self):
504
config_file = StringIO(sample_config_text.encode('utf-8'))
505
my_config = config.GlobalConfig()
506
my_config._parser = my_config._get_parser(file=config_file)
507
self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
508
my_config._get_user_id())
510
def test_absent_user_id(self):
511
config_file = StringIO("")
512
my_config = config.GlobalConfig()
513
my_config._parser = my_config._get_parser(file=config_file)
514
self.assertEqual(None, my_config._get_user_id())
516
def test_configured_editor(self):
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)
520
self.assertEqual("vim", my_config.get_editor())
522
def test_signatures_always(self):
523
config_file = StringIO(sample_always_signatures)
524
my_config = config.GlobalConfig()
525
my_config._parser = my_config._get_parser(file=config_file)
526
self.assertEqual(config.CHECK_NEVER,
527
my_config.signature_checking())
528
self.assertEqual(config.SIGN_ALWAYS,
529
my_config.signing_policy())
530
self.assertEqual(True, my_config.signature_needed())
532
def test_signatures_if_possible(self):
533
config_file = StringIO(sample_maybe_signatures)
534
my_config = config.GlobalConfig()
535
my_config._parser = my_config._get_parser(file=config_file)
536
self.assertEqual(config.CHECK_NEVER,
537
my_config.signature_checking())
538
self.assertEqual(config.SIGN_WHEN_REQUIRED,
539
my_config.signing_policy())
540
self.assertEqual(False, my_config.signature_needed())
542
def test_signatures_ignore(self):
543
config_file = StringIO(sample_ignore_signatures)
544
my_config = config.GlobalConfig()
545
my_config._parser = my_config._get_parser(file=config_file)
546
self.assertEqual(config.CHECK_ALWAYS,
547
my_config.signature_checking())
548
self.assertEqual(config.SIGN_NEVER,
549
my_config.signing_policy())
550
self.assertEqual(False, my_config.signature_needed())
552
def _get_sample_config(self):
553
config_file = StringIO(sample_config_text.encode('utf-8'))
554
my_config = config.GlobalConfig()
555
my_config._parser = my_config._get_parser(file=config_file)
558
def test_gpg_signing_command(self):
559
my_config = self._get_sample_config()
560
self.assertEqual("gnome-gpg", my_config.gpg_signing_command())
561
self.assertEqual(False, my_config.signature_needed())
563
def _get_empty_config(self):
564
config_file = StringIO("")
565
my_config = config.GlobalConfig()
566
my_config._parser = my_config._get_parser(file=config_file)
569
def test_gpg_signing_command_unset(self):
570
my_config = self._get_empty_config()
571
self.assertEqual("gpg", my_config.gpg_signing_command())
573
def test_get_user_option_default(self):
574
my_config = self._get_empty_config()
575
self.assertEqual(None, my_config.get_user_option('no_option'))
577
def test_get_user_option_global(self):
578
my_config = self._get_sample_config()
579
self.assertEqual("something",
580
my_config.get_user_option('user_global_option'))
582
def test_post_commit_default(self):
583
my_config = self._get_sample_config()
584
self.assertEqual(None, my_config.post_commit())
586
def test_configured_logformat(self):
587
my_config = self._get_sample_config()
588
self.assertEqual("short", my_config.log_format())
590
def test_get_alias(self):
591
my_config = self._get_sample_config()
592
self.assertEqual('help', my_config.get_alias('h'))
594
def test_get_aliases(self):
595
my_config = self._get_sample_config()
596
aliases = my_config.get_aliases()
597
self.assertEqual(2, len(aliases))
598
sorted_keys = sorted(aliases)
599
self.assertEqual('help', aliases[sorted_keys[0]])
600
self.assertEqual(sample_long_alias, aliases[sorted_keys[1]])
602
def test_get_no_alias(self):
603
my_config = self._get_sample_config()
604
self.assertEqual(None, my_config.get_alias('foo'))
606
def test_get_long_alias(self):
607
my_config = self._get_sample_config()
608
self.assertEqual(sample_long_alias, my_config.get_alias('ll'))
611
class TestGlobalConfigSavingOptions(tests.TestCaseInTempDir):
613
def test_empty(self):
614
my_config = config.GlobalConfig()
615
self.assertEqual(0, len(my_config.get_aliases()))
617
def test_set_alias(self):
618
my_config = config.GlobalConfig()
619
alias_value = 'commit --strict'
620
my_config.set_alias('commit', alias_value)
621
new_config = config.GlobalConfig()
622
self.assertEqual(alias_value, new_config.get_alias('commit'))
624
def test_remove_alias(self):
625
my_config = config.GlobalConfig()
626
my_config.set_alias('commit', 'commit --strict')
627
# Now remove the alias again.
628
my_config.unset_alias('commit')
629
new_config = config.GlobalConfig()
630
self.assertIs(None, new_config.get_alias('commit'))
633
class TestLocationConfig(tests.TestCaseInTempDir):
635
def test_constructs(self):
636
my_config = config.LocationConfig('http://example.com')
637
self.assertRaises(TypeError, config.LocationConfig)
639
def test_branch_calls_read_filenames(self):
640
# This is testing the correct file names are provided.
641
# TODO: consolidate with the test for GlobalConfigs filename checks.
643
# replace the class that is constructed, to check its parameters
644
oldparserclass = config.ConfigObj
645
config.ConfigObj = InstrumentedConfigObj
647
my_config = config.LocationConfig('http://www.example.com')
648
parser = my_config._get_parser()
650
config.ConfigObj = oldparserclass
651
self.failUnless(isinstance(parser, InstrumentedConfigObj))
652
self.assertEqual(parser._calls,
653
[('__init__', config.locations_config_filename(),
655
config.ensure_config_dir_exists()
656
#os.mkdir(config.config_dir())
657
f = file(config.branches_config_filename(), 'wb')
660
oldparserclass = config.ConfigObj
661
config.ConfigObj = InstrumentedConfigObj
663
my_config = config.LocationConfig('http://www.example.com')
664
parser = my_config._get_parser()
666
config.ConfigObj = oldparserclass
668
def test_get_global_config(self):
669
my_config = config.BranchConfig(FakeBranch('http://example.com'))
670
global_config = my_config._get_global_config()
671
self.failUnless(isinstance(global_config, config.GlobalConfig))
672
self.failUnless(global_config is my_config._get_global_config())
674
def test__get_matching_sections_no_match(self):
675
self.get_branch_config('/')
676
self.assertEqual([], self.my_location_config._get_matching_sections())
678
def test__get_matching_sections_exact(self):
679
self.get_branch_config('http://www.example.com')
680
self.assertEqual([('http://www.example.com', '')],
681
self.my_location_config._get_matching_sections())
683
def test__get_matching_sections_suffix_does_not(self):
684
self.get_branch_config('http://www.example.com-com')
685
self.assertEqual([], self.my_location_config._get_matching_sections())
687
def test__get_matching_sections_subdir_recursive(self):
688
self.get_branch_config('http://www.example.com/com')
689
self.assertEqual([('http://www.example.com', 'com')],
690
self.my_location_config._get_matching_sections())
692
def test__get_matching_sections_ignoreparent(self):
693
self.get_branch_config('http://www.example.com/ignoreparent')
694
self.assertEqual([('http://www.example.com/ignoreparent', '')],
695
self.my_location_config._get_matching_sections())
697
def test__get_matching_sections_ignoreparent_subdir(self):
698
self.get_branch_config(
699
'http://www.example.com/ignoreparent/childbranch')
700
self.assertEqual([('http://www.example.com/ignoreparent',
702
self.my_location_config._get_matching_sections())
704
def test__get_matching_sections_subdir_trailing_slash(self):
705
self.get_branch_config('/b')
706
self.assertEqual([('/b/', '')],
707
self.my_location_config._get_matching_sections())
709
def test__get_matching_sections_subdir_child(self):
710
self.get_branch_config('/a/foo')
711
self.assertEqual([('/a/*', ''), ('/a/', 'foo')],
712
self.my_location_config._get_matching_sections())
714
def test__get_matching_sections_subdir_child_child(self):
715
self.get_branch_config('/a/foo/bar')
716
self.assertEqual([('/a/*', 'bar'), ('/a/', 'foo/bar')],
717
self.my_location_config._get_matching_sections())
719
def test__get_matching_sections_trailing_slash_with_children(self):
720
self.get_branch_config('/a/')
721
self.assertEqual([('/a/', '')],
722
self.my_location_config._get_matching_sections())
724
def test__get_matching_sections_explicit_over_glob(self):
725
# XXX: 2006-09-08 jamesh
726
# This test only passes because ord('c') > ord('*'). If there
727
# was a config section for '/a/?', it would get precedence
729
self.get_branch_config('/a/c')
730
self.assertEqual([('/a/c', ''), ('/a/*', ''), ('/a/', 'c')],
731
self.my_location_config._get_matching_sections())
733
def test__get_option_policy_normal(self):
734
self.get_branch_config('http://www.example.com')
736
self.my_location_config._get_config_policy(
737
'http://www.example.com', 'normal_option'),
740
def test__get_option_policy_norecurse(self):
741
self.get_branch_config('http://www.example.com')
743
self.my_location_config._get_option_policy(
744
'http://www.example.com', 'norecurse_option'),
745
config.POLICY_NORECURSE)
746
# Test old recurse=False setting:
748
self.my_location_config._get_option_policy(
749
'http://www.example.com/norecurse', 'normal_option'),
750
config.POLICY_NORECURSE)
752
def test__get_option_policy_normal(self):
753
self.get_branch_config('http://www.example.com')
755
self.my_location_config._get_option_policy(
756
'http://www.example.com', 'appendpath_option'),
757
config.POLICY_APPENDPATH)
759
def test_location_without_username(self):
760
self.get_branch_config('http://www.example.com/ignoreparent')
761
self.assertEqual(u'Erik B\u00e5gfors <erik@bagfors.nu>',
762
self.my_config.username())
764
def test_location_not_listed(self):
765
"""Test that the global username is used when no location matches"""
766
self.get_branch_config('/home/robertc/sources')
767
self.assertEqual(u'Erik B\u00e5gfors <erik@bagfors.nu>',
768
self.my_config.username())
770
def test_overriding_location(self):
771
self.get_branch_config('http://www.example.com/foo')
772
self.assertEqual('Robert Collins <robertc@example.org>',
773
self.my_config.username())
775
def test_signatures_not_set(self):
776
self.get_branch_config('http://www.example.com',
777
global_config=sample_ignore_signatures)
778
self.assertEqual(config.CHECK_ALWAYS,
779
self.my_config.signature_checking())
780
self.assertEqual(config.SIGN_NEVER,
781
self.my_config.signing_policy())
783
def test_signatures_never(self):
784
self.get_branch_config('/a/c')
785
self.assertEqual(config.CHECK_NEVER,
786
self.my_config.signature_checking())
788
def test_signatures_when_available(self):
789
self.get_branch_config('/a/', global_config=sample_ignore_signatures)
790
self.assertEqual(config.CHECK_IF_POSSIBLE,
791
self.my_config.signature_checking())
793
def test_signatures_always(self):
794
self.get_branch_config('/b')
795
self.assertEqual(config.CHECK_ALWAYS,
796
self.my_config.signature_checking())
798
def test_gpg_signing_command(self):
799
self.get_branch_config('/b')
800
self.assertEqual("gnome-gpg", self.my_config.gpg_signing_command())
802
def test_gpg_signing_command_missing(self):
803
self.get_branch_config('/a')
804
self.assertEqual("false", self.my_config.gpg_signing_command())
806
def test_get_user_option_global(self):
807
self.get_branch_config('/a')
808
self.assertEqual('something',
809
self.my_config.get_user_option('user_global_option'))
811
def test_get_user_option_local(self):
812
self.get_branch_config('/a')
813
self.assertEqual('local',
814
self.my_config.get_user_option('user_local_option'))
816
def test_get_user_option_appendpath(self):
817
# returned as is for the base path:
818
self.get_branch_config('http://www.example.com')
819
self.assertEqual('append',
820
self.my_config.get_user_option('appendpath_option'))
821
# Extra path components get appended:
822
self.get_branch_config('http://www.example.com/a/b/c')
823
self.assertEqual('append/a/b/c',
824
self.my_config.get_user_option('appendpath_option'))
825
# Overriden for http://www.example.com/dir, where it is a
827
self.get_branch_config('http://www.example.com/dir/a/b/c')
828
self.assertEqual('normal',
829
self.my_config.get_user_option('appendpath_option'))
831
def test_get_user_option_norecurse(self):
832
self.get_branch_config('http://www.example.com')
833
self.assertEqual('norecurse',
834
self.my_config.get_user_option('norecurse_option'))
835
self.get_branch_config('http://www.example.com/dir')
836
self.assertEqual(None,
837
self.my_config.get_user_option('norecurse_option'))
838
# http://www.example.com/norecurse is a recurse=False section
839
# that redefines normal_option. Subdirectories do not pick up
841
self.get_branch_config('http://www.example.com/norecurse')
842
self.assertEqual('norecurse',
843
self.my_config.get_user_option('normal_option'))
844
self.get_branch_config('http://www.example.com/norecurse/subdir')
845
self.assertEqual('normal',
846
self.my_config.get_user_option('normal_option'))
848
def test_set_user_option_norecurse(self):
849
self.get_branch_config('http://www.example.com')
850
self.my_config.set_user_option('foo', 'bar',
851
store=config.STORE_LOCATION_NORECURSE)
853
self.my_location_config._get_option_policy(
854
'http://www.example.com', 'foo'),
855
config.POLICY_NORECURSE)
857
def test_set_user_option_appendpath(self):
858
self.get_branch_config('http://www.example.com')
859
self.my_config.set_user_option('foo', 'bar',
860
store=config.STORE_LOCATION_APPENDPATH)
862
self.my_location_config._get_option_policy(
863
'http://www.example.com', 'foo'),
864
config.POLICY_APPENDPATH)
866
def test_set_user_option_change_policy(self):
867
self.get_branch_config('http://www.example.com')
868
self.my_config.set_user_option('norecurse_option', 'normal',
869
store=config.STORE_LOCATION)
871
self.my_location_config._get_option_policy(
872
'http://www.example.com', 'norecurse_option'),
875
def test_set_user_option_recurse_false_section(self):
876
# The following section has recurse=False set. The test is to
877
# make sure that a normal option can be added to the section,
878
# converting recurse=False to the norecurse policy.
879
self.get_branch_config('http://www.example.com/norecurse')
880
self.callDeprecated(['The recurse option is deprecated as of 0.14. '
881
'The section "http://www.example.com/norecurse" '
882
'has been converted to use policies.'],
883
self.my_config.set_user_option,
884
'foo', 'bar', store=config.STORE_LOCATION)
886
self.my_location_config._get_option_policy(
887
'http://www.example.com/norecurse', 'foo'),
889
# The previously existing option is still norecurse:
891
self.my_location_config._get_option_policy(
892
'http://www.example.com/norecurse', 'normal_option'),
893
config.POLICY_NORECURSE)
895
def test_post_commit_default(self):
896
self.get_branch_config('/a/c')
897
self.assertEqual('bzrlib.tests.test_config.post_commit',
898
self.my_config.post_commit())
900
def get_branch_config(self, location, global_config=None):
901
if global_config is None:
902
global_file = StringIO(sample_config_text.encode('utf-8'))
904
global_file = StringIO(global_config.encode('utf-8'))
905
branches_file = StringIO(sample_branches_text.encode('utf-8'))
906
self.my_config = config.BranchConfig(FakeBranch(location))
907
# Force location config to use specified file
908
self.my_location_config = self.my_config._get_location_config()
909
self.my_location_config._get_parser(branches_file)
910
# Force global config to use specified file
911
self.my_config._get_global_config()._get_parser(global_file)
913
def test_set_user_setting_sets_and_saves(self):
914
self.get_branch_config('/a/c')
915
record = InstrumentedConfigObj("foo")
916
self.my_location_config._parser = record
918
real_mkdir = os.mkdir
920
def checked_mkdir(path, mode=0777):
921
self.log('making directory: %s', path)
922
real_mkdir(path, mode)
925
os.mkdir = checked_mkdir
927
self.callDeprecated(['The recurse option is deprecated as of '
928
'0.14. The section "/a/c" has been '
929
'converted to use policies.'],
930
self.my_config.set_user_option,
931
'foo', 'bar', store=config.STORE_LOCATION)
933
os.mkdir = real_mkdir
935
self.failUnless(self.created, 'Failed to create ~/.bazaar')
936
self.assertEqual([('__contains__', '/a/c'),
937
('__contains__', '/a/c/'),
938
('__setitem__', '/a/c', {}),
939
('__getitem__', '/a/c'),
940
('__setitem__', 'foo', 'bar'),
941
('__getitem__', '/a/c'),
942
('as_bool', 'recurse'),
943
('__getitem__', '/a/c'),
944
('__delitem__', 'recurse'),
945
('__getitem__', '/a/c'),
947
('__getitem__', '/a/c'),
948
('__contains__', 'foo:policy'),
952
def test_set_user_setting_sets_and_saves2(self):
953
self.get_branch_config('/a/c')
954
self.assertIs(self.my_config.get_user_option('foo'), None)
955
self.my_config.set_user_option('foo', 'bar')
957
self.my_config.branch.control_files.files['branch.conf'].strip(),
959
self.assertEqual(self.my_config.get_user_option('foo'), 'bar')
960
self.my_config.set_user_option('foo', 'baz',
961
store=config.STORE_LOCATION)
962
self.assertEqual(self.my_config.get_user_option('foo'), 'baz')
963
self.my_config.set_user_option('foo', 'qux')
964
self.assertEqual(self.my_config.get_user_option('foo'), 'baz')
966
def test_get_bzr_remote_path(self):
967
my_config = config.LocationConfig('/a/c')
968
self.assertEqual('bzr', my_config.get_bzr_remote_path())
969
my_config.set_user_option('bzr_remote_path', '/path-bzr')
970
self.assertEqual('/path-bzr', my_config.get_bzr_remote_path())
971
os.environ['BZR_REMOTE_PATH'] = '/environ-bzr'
972
self.assertEqual('/environ-bzr', my_config.get_bzr_remote_path())
975
precedence_global = 'option = global'
976
precedence_branch = 'option = branch'
977
precedence_location = """
981
[http://example.com/specific]
986
class TestBranchConfigItems(tests.TestCaseInTempDir):
988
def get_branch_config(self, global_config=None, location=None,
989
location_config=None, branch_data_config=None):
990
my_config = config.BranchConfig(FakeBranch(location))
991
if global_config is not None:
992
global_file = StringIO(global_config.encode('utf-8'))
993
my_config._get_global_config()._get_parser(global_file)
994
self.my_location_config = my_config._get_location_config()
995
if location_config is not None:
996
location_file = StringIO(location_config.encode('utf-8'))
997
self.my_location_config._get_parser(location_file)
998
if branch_data_config is not None:
999
my_config.branch.control_files.files['branch.conf'] = \
1003
def test_user_id(self):
1004
branch = FakeBranch(user_id='Robert Collins <robertc@example.net>')
1005
my_config = config.BranchConfig(branch)
1006
self.assertEqual("Robert Collins <robertc@example.net>",
1007
my_config.username())
1008
my_config.branch.control_files.files['email'] = "John"
1009
my_config.set_user_option('email',
1010
"Robert Collins <robertc@example.org>")
1011
self.assertEqual("John", my_config.username())
1012
del my_config.branch.control_files.files['email']
1013
self.assertEqual("Robert Collins <robertc@example.org>",
1014
my_config.username())
1016
def test_not_set_in_branch(self):
1017
my_config = self.get_branch_config(sample_config_text)
1018
self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
1019
my_config._get_user_id())
1020
my_config.branch.control_files.files['email'] = "John"
1021
self.assertEqual("John", my_config._get_user_id())
1023
def test_BZR_EMAIL_OVERRIDES(self):
1024
os.environ['BZR_EMAIL'] = "Robert Collins <robertc@example.org>"
1025
branch = FakeBranch()
1026
my_config = config.BranchConfig(branch)
1027
self.assertEqual("Robert Collins <robertc@example.org>",
1028
my_config.username())
1030
def test_signatures_forced(self):
1031
my_config = self.get_branch_config(
1032
global_config=sample_always_signatures)
1033
self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
1034
self.assertEqual(config.SIGN_ALWAYS, my_config.signing_policy())
1035
self.assertTrue(my_config.signature_needed())
1037
def test_signatures_forced_branch(self):
1038
my_config = self.get_branch_config(
1039
global_config=sample_ignore_signatures,
1040
branch_data_config=sample_always_signatures)
1041
self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
1042
self.assertEqual(config.SIGN_ALWAYS, my_config.signing_policy())
1043
self.assertTrue(my_config.signature_needed())
1045
def test_gpg_signing_command(self):
1046
my_config = self.get_branch_config(
1047
# branch data cannot set gpg_signing_command
1048
branch_data_config="gpg_signing_command=pgp")
1049
config_file = StringIO(sample_config_text.encode('utf-8'))
1050
my_config._get_global_config()._get_parser(config_file)
1051
self.assertEqual('gnome-gpg', my_config.gpg_signing_command())
1053
def test_get_user_option_global(self):
1054
branch = FakeBranch()
1055
my_config = config.BranchConfig(branch)
1056
config_file = StringIO(sample_config_text.encode('utf-8'))
1057
(my_config._get_global_config()._get_parser(config_file))
1058
self.assertEqual('something',
1059
my_config.get_user_option('user_global_option'))
1061
def test_post_commit_default(self):
1062
branch = FakeBranch()
1063
my_config = self.get_branch_config(sample_config_text, '/a/c',
1064
sample_branches_text)
1065
self.assertEqual(my_config.branch.base, '/a/c')
1066
self.assertEqual('bzrlib.tests.test_config.post_commit',
1067
my_config.post_commit())
1068
my_config.set_user_option('post_commit', 'rmtree_root')
1069
# post-commit is ignored when bresent in branch data
1070
self.assertEqual('bzrlib.tests.test_config.post_commit',
1071
my_config.post_commit())
1072
my_config.set_user_option('post_commit', 'rmtree_root',
1073
store=config.STORE_LOCATION)
1074
self.assertEqual('rmtree_root', my_config.post_commit())
1076
def test_config_precedence(self):
1077
my_config = self.get_branch_config(global_config=precedence_global)
1078
self.assertEqual(my_config.get_user_option('option'), 'global')
1079
my_config = self.get_branch_config(global_config=precedence_global,
1080
branch_data_config=precedence_branch)
1081
self.assertEqual(my_config.get_user_option('option'), 'branch')
1082
my_config = self.get_branch_config(global_config=precedence_global,
1083
branch_data_config=precedence_branch,
1084
location_config=precedence_location)
1085
self.assertEqual(my_config.get_user_option('option'), 'recurse')
1086
my_config = self.get_branch_config(global_config=precedence_global,
1087
branch_data_config=precedence_branch,
1088
location_config=precedence_location,
1089
location='http://example.com/specific')
1090
self.assertEqual(my_config.get_user_option('option'), 'exact')
1092
def test_get_mail_client(self):
1093
config = self.get_branch_config()
1094
client = config.get_mail_client()
1095
self.assertIsInstance(client, mail_client.DefaultMail)
1098
config.set_user_option('mail_client', 'evolution')
1099
client = config.get_mail_client()
1100
self.assertIsInstance(client, mail_client.Evolution)
1102
config.set_user_option('mail_client', 'kmail')
1103
client = config.get_mail_client()
1104
self.assertIsInstance(client, mail_client.KMail)
1106
config.set_user_option('mail_client', 'mutt')
1107
client = config.get_mail_client()
1108
self.assertIsInstance(client, mail_client.Mutt)
1110
config.set_user_option('mail_client', 'thunderbird')
1111
client = config.get_mail_client()
1112
self.assertIsInstance(client, mail_client.Thunderbird)
1115
config.set_user_option('mail_client', 'default')
1116
client = config.get_mail_client()
1117
self.assertIsInstance(client, mail_client.DefaultMail)
1119
config.set_user_option('mail_client', 'editor')
1120
client = config.get_mail_client()
1121
self.assertIsInstance(client, mail_client.Editor)
1123
config.set_user_option('mail_client', 'mapi')
1124
client = config.get_mail_client()
1125
self.assertIsInstance(client, mail_client.MAPIClient)
1127
config.set_user_option('mail_client', 'xdg-email')
1128
client = config.get_mail_client()
1129
self.assertIsInstance(client, mail_client.XDGEmail)
1131
config.set_user_option('mail_client', 'firebird')
1132
self.assertRaises(errors.UnknownMailClient, config.get_mail_client)
1135
class TestMailAddressExtraction(tests.TestCase):
1137
def test_extract_email_address(self):
1138
self.assertEqual('jane@test.com',
1139
config.extract_email_address('Jane <jane@test.com>'))
1140
self.assertRaises(errors.NoEmailInUsername,
1141
config.extract_email_address, 'Jane Tester')
1143
def test_parse_username(self):
1144
self.assertEqual(('', 'jdoe@example.com'),
1145
config.parse_username('jdoe@example.com'))
1146
self.assertEqual(('', 'jdoe@example.com'),
1147
config.parse_username('<jdoe@example.com>'))
1148
self.assertEqual(('John Doe', 'jdoe@example.com'),
1149
config.parse_username('John Doe <jdoe@example.com>'))
1150
self.assertEqual(('John Doe', ''),
1151
config.parse_username('John Doe'))
1152
self.assertEqual(('John Doe', 'jdoe@example.com'),
1153
config.parse_username('John Doe jdoe@example.com'))
1155
class TestTreeConfig(tests.TestCaseWithTransport):
1157
def test_get_value(self):
1158
"""Test that retreiving a value from a section is possible"""
1159
branch = self.make_branch('.')
1160
tree_config = config.TreeConfig(branch)
1161
tree_config.set_option('value', 'key', 'SECTION')
1162
tree_config.set_option('value2', 'key2')
1163
tree_config.set_option('value3-top', 'key3')
1164
tree_config.set_option('value3-section', 'key3', 'SECTION')
1165
value = tree_config.get_option('key', 'SECTION')
1166
self.assertEqual(value, 'value')
1167
value = tree_config.get_option('key2')
1168
self.assertEqual(value, 'value2')
1169
self.assertEqual(tree_config.get_option('non-existant'), None)
1170
value = tree_config.get_option('non-existant', 'SECTION')
1171
self.assertEqual(value, None)
1172
value = tree_config.get_option('non-existant', default='default')
1173
self.assertEqual(value, 'default')
1174
self.assertEqual(tree_config.get_option('key2', 'NOSECTION'), None)
1175
value = tree_config.get_option('key2', 'NOSECTION', default='default')
1176
self.assertEqual(value, 'default')
1177
value = tree_config.get_option('key3')
1178
self.assertEqual(value, 'value3-top')
1179
value = tree_config.get_option('key3', 'SECTION')
1180
self.assertEqual(value, 'value3-section')
1183
class TestTransportConfig(tests.TestCaseWithTransport):
1185
def test_get_value(self):
1186
"""Test that retreiving a value from a section is possible"""
1187
bzrdir_config = config.TransportConfig(transport.get_transport('.'),
1189
bzrdir_config.set_option('value', 'key', 'SECTION')
1190
bzrdir_config.set_option('value2', 'key2')
1191
bzrdir_config.set_option('value3-top', 'key3')
1192
bzrdir_config.set_option('value3-section', 'key3', 'SECTION')
1193
value = bzrdir_config.get_option('key', 'SECTION')
1194
self.assertEqual(value, 'value')
1195
value = bzrdir_config.get_option('key2')
1196
self.assertEqual(value, 'value2')
1197
self.assertEqual(bzrdir_config.get_option('non-existant'), None)
1198
value = bzrdir_config.get_option('non-existant', 'SECTION')
1199
self.assertEqual(value, None)
1200
value = bzrdir_config.get_option('non-existant', default='default')
1201
self.assertEqual(value, 'default')
1202
self.assertEqual(bzrdir_config.get_option('key2', 'NOSECTION'), None)
1203
value = bzrdir_config.get_option('key2', 'NOSECTION',
1205
self.assertEqual(value, 'default')
1206
value = bzrdir_config.get_option('key3')
1207
self.assertEqual(value, 'value3-top')
1208
value = bzrdir_config.get_option('key3', 'SECTION')
1209
self.assertEqual(value, 'value3-section')
1211
def test_set_unset_default_stack_on(self):
1212
my_dir = self.make_bzrdir('.')
1213
bzrdir_config = config.BzrDirConfig(my_dir)
1214
self.assertIs(None, bzrdir_config.get_default_stack_on())
1215
bzrdir_config.set_default_stack_on('Foo')
1216
self.assertEqual('Foo', bzrdir_config._config.get_option(
1217
'default_stack_on'))
1218
self.assertEqual('Foo', bzrdir_config.get_default_stack_on())
1219
bzrdir_config.set_default_stack_on(None)
1220
self.assertIs(None, bzrdir_config.get_default_stack_on())
1223
class TestAuthenticationConfigFile(tests.TestCase):
1224
"""Test the authentication.conf file matching"""
1226
def _got_user_passwd(self, expected_user, expected_password,
1227
config, *args, **kwargs):
1228
credentials = config.get_credentials(*args, **kwargs)
1229
if credentials is None:
1233
user = credentials['user']
1234
password = credentials['password']
1235
self.assertEquals(expected_user, user)
1236
self.assertEquals(expected_password, password)
1238
def test_empty_config(self):
1239
conf = config.AuthenticationConfig(_file=StringIO())
1240
self.assertEquals({}, conf._get_config())
1241
self._got_user_passwd(None, None, conf, 'http', 'foo.net')
1243
def test_missing_auth_section_header(self):
1244
conf = config.AuthenticationConfig(_file=StringIO('foo = bar'))
1245
self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
1247
def test_auth_section_header_not_closed(self):
1248
conf = config.AuthenticationConfig(_file=StringIO('[DEF'))
1249
self.assertRaises(errors.ParseConfigError, conf._get_config)
1251
def test_auth_value_not_boolean(self):
1252
conf = config.AuthenticationConfig(_file=StringIO(
1256
verify_certificates=askme # Error: Not a boolean
1258
self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
1260
def test_auth_value_not_int(self):
1261
conf = config.AuthenticationConfig(_file=StringIO(
1265
port=port # Error: Not an int
1267
self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
1269
def test_unknown_password_encoding(self):
1270
conf = config.AuthenticationConfig(_file=StringIO(
1274
password_encoding=unknown
1276
self.assertRaises(ValueError, conf.get_password,
1277
'ftp', 'foo.net', 'joe')
1279
def test_credentials_for_scheme_host(self):
1280
conf = config.AuthenticationConfig(_file=StringIO(
1281
"""# Identity on foo.net
1286
password=secret-pass
1289
self._got_user_passwd('joe', 'secret-pass', conf, 'ftp', 'foo.net')
1291
self._got_user_passwd(None, None, conf, 'http', 'foo.net')
1293
self._got_user_passwd(None, None, conf, 'ftp', 'bar.net')
1295
def test_credentials_for_host_port(self):
1296
conf = config.AuthenticationConfig(_file=StringIO(
1297
"""# Identity on foo.net
1303
password=secret-pass
1306
self._got_user_passwd('joe', 'secret-pass',
1307
conf, 'ftp', 'foo.net', port=10021)
1309
self._got_user_passwd(None, None, conf, 'ftp', 'foo.net')
1311
def test_for_matching_host(self):
1312
conf = config.AuthenticationConfig(_file=StringIO(
1313
"""# Identity on foo.net
1319
[sourceforge domain]
1326
self._got_user_passwd('georges', 'bendover',
1327
conf, 'bzr', 'foo.bzr.sf.net')
1329
self._got_user_passwd(None, None,
1330
conf, 'bzr', 'bbzr.sf.net')
1332
def test_for_matching_host_None(self):
1333
conf = config.AuthenticationConfig(_file=StringIO(
1334
"""# Identity on foo.net
1344
self._got_user_passwd('joe', 'joepass',
1345
conf, 'bzr', 'quux.net')
1346
# no host but different scheme
1347
self._got_user_passwd('georges', 'bendover',
1348
conf, 'ftp', 'quux.net')
1350
def test_credentials_for_path(self):
1351
conf = config.AuthenticationConfig(_file=StringIO(
1367
self._got_user_passwd(None, None,
1368
conf, 'http', host='bar.org', path='/dir3')
1370
self._got_user_passwd('georges', 'bendover',
1371
conf, 'http', host='bar.org', path='/dir2')
1373
self._got_user_passwd('jim', 'jimpass',
1374
conf, 'http', host='bar.org',path='/dir1/subdir')
1376
def test_credentials_for_user(self):
1377
conf = config.AuthenticationConfig(_file=StringIO(
1386
self._got_user_passwd('jim', 'jimpass',
1387
conf, 'http', 'bar.org')
1389
self._got_user_passwd('jim', 'jimpass',
1390
conf, 'http', 'bar.org', user='jim')
1391
# Don't get a different user if one is specified
1392
self._got_user_passwd(None, None,
1393
conf, 'http', 'bar.org', user='georges')
1395
def test_credentials_for_user_without_password(self):
1396
conf = config.AuthenticationConfig(_file=StringIO(
1403
# Get user but no password
1404
self._got_user_passwd('jim', None,
1405
conf, 'http', 'bar.org')
1407
def test_verify_certificates(self):
1408
conf = config.AuthenticationConfig(_file=StringIO(
1415
verify_certificates=False
1422
credentials = conf.get_credentials('https', 'bar.org')
1423
self.assertEquals(False, credentials.get('verify_certificates'))
1424
credentials = conf.get_credentials('https', 'foo.net')
1425
self.assertEquals(True, credentials.get('verify_certificates'))
1428
class TestAuthenticationStorage(tests.TestCaseInTempDir):
1430
def test_set_credentials(self):
1431
conf = config.AuthenticationConfig()
1432
conf.set_credentials('name', 'host', 'user', 'scheme', 'password',
1433
99, path='/foo', verify_certificates=False, realm='realm')
1434
credentials = conf.get_credentials(host='host', scheme='scheme',
1435
port=99, path='/foo',
1437
CREDENTIALS = {'name': 'name', 'user': 'user', 'password': 'password',
1438
'verify_certificates': False, 'scheme': 'scheme',
1439
'host': 'host', 'port': 99, 'path': '/foo',
1441
self.assertEqual(CREDENTIALS, credentials)
1442
credentials_from_disk = config.AuthenticationConfig().get_credentials(
1443
host='host', scheme='scheme', port=99, path='/foo', realm='realm')
1444
self.assertEqual(CREDENTIALS, credentials_from_disk)
1446
def test_reset_credentials_different_name(self):
1447
conf = config.AuthenticationConfig()
1448
conf.set_credentials('name', 'host', 'user', 'scheme', 'password'),
1449
conf.set_credentials('name2', 'host', 'user2', 'scheme', 'password'),
1450
self.assertIs(None, conf._get_config().get('name'))
1451
credentials = conf.get_credentials(host='host', scheme='scheme')
1452
CREDENTIALS = {'name': 'name2', 'user': 'user2', 'password':
1453
'password', 'verify_certificates': True,
1454
'scheme': 'scheme', 'host': 'host', 'port': None,
1455
'path': None, 'realm': None}
1456
self.assertEqual(CREDENTIALS, credentials)
1459
class TestAuthenticationConfig(tests.TestCase):
1460
"""Test AuthenticationConfig behaviour"""
1462
def _check_default_password_prompt(self, expected_prompt_format, scheme,
1463
host=None, port=None, realm=None,
1467
user, password = 'jim', 'precious'
1468
expected_prompt = expected_prompt_format % {
1469
'scheme': scheme, 'host': host, 'port': port,
1470
'user': user, 'realm': realm}
1472
stdout = tests.StringIOWrapper()
1473
stderr = tests.StringIOWrapper()
1474
ui.ui_factory = tests.TestUIFactory(stdin=password + '\n',
1475
stdout=stdout, stderr=stderr)
1476
# We use an empty conf so that the user is always prompted
1477
conf = config.AuthenticationConfig()
1478
self.assertEquals(password,
1479
conf.get_password(scheme, host, user, port=port,
1480
realm=realm, path=path))
1481
self.assertEquals(expected_prompt, stderr.getvalue())
1482
self.assertEquals('', stdout.getvalue())
1484
def _check_default_username_prompt(self, expected_prompt_format, scheme,
1485
host=None, port=None, realm=None,
1490
expected_prompt = expected_prompt_format % {
1491
'scheme': scheme, 'host': host, 'port': port,
1493
stdout = tests.StringIOWrapper()
1494
stderr = tests.StringIOWrapper()
1495
ui.ui_factory = tests.TestUIFactory(stdin=username+ '\n',
1496
stdout=stdout, stderr=stderr)
1497
# We use an empty conf so that the user is always prompted
1498
conf = config.AuthenticationConfig()
1499
self.assertEquals(username, conf.get_user(scheme, host, port=port,
1500
realm=realm, path=path, ask=True))
1501
self.assertEquals(expected_prompt, stderr.getvalue())
1502
self.assertEquals('', stdout.getvalue())
1504
def test_username_defaults_prompts(self):
1505
# HTTP prompts can't be tested here, see test_http.py
1506
self._check_default_username_prompt('FTP %(host)s username: ', 'ftp')
1507
self._check_default_username_prompt(
1508
'FTP %(host)s:%(port)d username: ', 'ftp', port=10020)
1509
self._check_default_username_prompt(
1510
'SSH %(host)s:%(port)d username: ', 'ssh', port=12345)
1512
def test_username_default_no_prompt(self):
1513
conf = config.AuthenticationConfig()
1514
self.assertEquals(None,
1515
conf.get_user('ftp', 'example.com'))
1516
self.assertEquals("explicitdefault",
1517
conf.get_user('ftp', 'example.com', default="explicitdefault"))
1519
def test_password_default_prompts(self):
1520
# HTTP prompts can't be tested here, see test_http.py
1521
self._check_default_password_prompt(
1522
'FTP %(user)s@%(host)s password: ', 'ftp')
1523
self._check_default_password_prompt(
1524
'FTP %(user)s@%(host)s:%(port)d password: ', 'ftp', port=10020)
1525
self._check_default_password_prompt(
1526
'SSH %(user)s@%(host)s:%(port)d password: ', 'ssh', port=12345)
1527
# SMTP port handling is a bit special (it's handled if embedded in the
1529
# FIXME: should we: forbid that, extend it to other schemes, leave
1530
# things as they are that's fine thank you ?
1531
self._check_default_password_prompt('SMTP %(user)s@%(host)s password: ',
1533
self._check_default_password_prompt('SMTP %(user)s@%(host)s password: ',
1534
'smtp', host='bar.org:10025')
1535
self._check_default_password_prompt(
1536
'SMTP %(user)s@%(host)s:%(port)d password: ',
1539
def test_ssh_password_emits_warning(self):
1540
conf = config.AuthenticationConfig(_file=StringIO(
1548
entered_password = 'typed-by-hand'
1549
stdout = tests.StringIOWrapper()
1550
ui.ui_factory = tests.TestUIFactory(stdin=entered_password + '\n',
1553
# Since the password defined in the authentication config is ignored,
1554
# the user is prompted
1555
self.assertEquals(entered_password,
1556
conf.get_password('ssh', 'bar.org', user='jim'))
1557
self.assertContainsRe(
1558
self._get_log(keep_log_file=True),
1559
'password ignored in section \[ssh with password\]')
1561
def test_ssh_without_password_doesnt_emit_warning(self):
1562
conf = config.AuthenticationConfig(_file=StringIO(
1569
entered_password = 'typed-by-hand'
1570
stdout = tests.StringIOWrapper()
1571
ui.ui_factory = tests.TestUIFactory(stdin=entered_password + '\n',
1574
# Since the password defined in the authentication config is ignored,
1575
# the user is prompted
1576
self.assertEquals(entered_password,
1577
conf.get_password('ssh', 'bar.org', user='jim'))
1578
# No warning shoud be emitted since there is no password. We are only
1580
self.assertNotContainsRe(
1581
self._get_log(keep_log_file=True),
1582
'password ignored in section \[ssh with password\]')
1584
def test_uses_fallback_stores(self):
1585
self._old_cs_registry = config.credential_store_registry
1587
config.credential_store_registry = self._old_cs_registry
1588
self.addCleanup(restore)
1589
config.credential_store_registry = config.CredentialStoreRegistry()
1590
store = StubCredentialStore()
1591
store.add_credentials("http", "example.com", "joe", "secret")
1592
config.credential_store_registry.register("stub", store, fallback=True)
1593
conf = config.AuthenticationConfig(_file=StringIO())
1594
creds = conf.get_credentials("http", "example.com")
1595
self.assertEquals("joe", creds["user"])
1596
self.assertEquals("secret", creds["password"])
1599
class StubCredentialStore(config.CredentialStore):
1605
def add_credentials(self, scheme, host, user, password=None):
1606
self._username[(scheme, host)] = user
1607
self._password[(scheme, host)] = password
1609
def get_credentials(self, scheme, host, port=None, user=None,
1610
path=None, realm=None):
1611
key = (scheme, host)
1612
if not key in self._username:
1614
return { "scheme": scheme, "host": host, "port": port,
1615
"user": self._username[key], "password": self._password[key]}
1618
class CountingCredentialStore(config.CredentialStore):
1623
def get_credentials(self, scheme, host, port=None, user=None,
1624
path=None, realm=None):
1629
class TestCredentialStoreRegistry(tests.TestCase):
1631
def _get_cs_registry(self):
1632
return config.credential_store_registry
1634
def test_default_credential_store(self):
1635
r = self._get_cs_registry()
1636
default = r.get_credential_store(None)
1637
self.assertIsInstance(default, config.PlainTextCredentialStore)
1639
def test_unknown_credential_store(self):
1640
r = self._get_cs_registry()
1641
# It's hard to imagine someone creating a credential store named
1642
# 'unknown' so we use that as an never registered key.
1643
self.assertRaises(KeyError, r.get_credential_store, 'unknown')
1645
def test_fallback_none_registered(self):
1646
r = config.CredentialStoreRegistry()
1647
self.assertEquals(None,
1648
r.get_fallback_credentials("http", "example.com"))
1650
def test_register(self):
1651
r = config.CredentialStoreRegistry()
1652
r.register("stub", StubCredentialStore(), fallback=False)
1653
r.register("another", StubCredentialStore(), fallback=True)
1654
self.assertEquals(["another", "stub"], r.keys())
1656
def test_register_lazy(self):
1657
r = config.CredentialStoreRegistry()
1658
r.register_lazy("stub", "bzrlib.tests.test_config",
1659
"StubCredentialStore", fallback=False)
1660
self.assertEquals(["stub"], r.keys())
1661
self.assertIsInstance(r.get_credential_store("stub"),
1662
StubCredentialStore)
1664
def test_is_fallback(self):
1665
r = config.CredentialStoreRegistry()
1666
r.register("stub1", None, fallback=False)
1667
r.register("stub2", None, fallback=True)
1668
self.assertEquals(False, r.is_fallback("stub1"))
1669
self.assertEquals(True, r.is_fallback("stub2"))
1671
def test_no_fallback(self):
1672
r = config.CredentialStoreRegistry()
1673
store = CountingCredentialStore()
1674
r.register("count", store, fallback=False)
1675
self.assertEquals(None,
1676
r.get_fallback_credentials("http", "example.com"))
1677
self.assertEquals(0, store._calls)
1679
def test_fallback_credentials(self):
1680
r = config.CredentialStoreRegistry()
1681
store = StubCredentialStore()
1682
store.add_credentials("http", "example.com",
1683
"somebody", "geheim")
1684
r.register("stub", store, fallback=True)
1685
creds = r.get_fallback_credentials("http", "example.com")
1686
self.assertEquals("somebody", creds["user"])
1687
self.assertEquals("geheim", creds["password"])
1689
def test_fallback_first_wins(self):
1690
r = config.CredentialStoreRegistry()
1691
stub1 = StubCredentialStore()
1692
stub1.add_credentials("http", "example.com",
1693
"somebody", "stub1")
1694
r.register("stub1", stub1, fallback=True)
1695
stub2 = StubCredentialStore()
1696
stub2.add_credentials("http", "example.com",
1697
"somebody", "stub2")
1698
r.register("stub2", stub1, fallback=True)
1699
creds = r.get_fallback_credentials("http", "example.com")
1700
self.assertEquals("somebody", creds["user"])
1701
self.assertEquals("stub1", creds["password"])
1704
class TestPlainTextCredentialStore(tests.TestCase):
1706
def test_decode_password(self):
1707
r = config.credential_store_registry
1708
plain_text = r.get_credential_store()
1709
decoded = plain_text.decode_password(dict(password='secret'))
1710
self.assertEquals('secret', decoded)
1713
# FIXME: Once we have a way to declare authentication to all test servers, we
1714
# can implement generic tests.
1715
# test_user_password_in_url
1716
# test_user_in_url_password_from_config
1717
# test_user_in_url_password_prompted
1718
# test_user_in_config
1719
# test_user_getpass.getuser
1720
# test_user_prompted ?
1721
class TestAuthenticationRing(tests.TestCaseWithTransport):
added
removed
bzrlib/tests/test_config.py
