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 lock_write(self):
160
class FakeControlFilesAndTransport(object):
162
def __init__(self, user_id=None):
165
self.files['email'] = user_id
166
self._transport = self
168
def get_utf8(self, filename):
170
raise AssertionError("get_utf8 should no longer be used")
172
def get(self, filename):
175
return StringIO(self.files[filename])
177
raise errors.NoSuchFile(filename)
179
def get_bytes(self, filename):
182
return self.files[filename]
184
raise errors.NoSuchFile(filename)
186
def put(self, filename, fileobj):
187
self.files[filename] = fileobj.read()
189
def put_file(self, filename, fileobj):
190
return self.put(filename, fileobj)
193
class InstrumentedConfig(config.Config):
194
"""An instrumented config that supplies stubs for template methods."""
197
super(InstrumentedConfig, self).__init__()
199
self._signatures = config.CHECK_NEVER
201
def _get_user_id(self):
202
self._calls.append('_get_user_id')
203
return "Robert Collins <robert.collins@example.org>"
205
def _get_signature_checking(self):
206
self._calls.append('_get_signature_checking')
207
return self._signatures
210
bool_config = """[DEFAULT]
219
class TestConfigObj(tests.TestCase):
221
def test_get_bool(self):
222
co = config.ConfigObj(StringIO(bool_config))
223
self.assertIs(co.get_bool('DEFAULT', 'active'), True)
224
self.assertIs(co.get_bool('DEFAULT', 'inactive'), False)
225
self.assertIs(co.get_bool('UPPERCASE', 'active'), True)
226
self.assertIs(co.get_bool('UPPERCASE', 'nonactive'), False)
228
def test_hash_sign_in_value(self):
230
Before 4.5.0, ConfigObj did not quote # signs in values, so they'd be
231
treated as comments when read in again. (#86838)
233
co = config.ConfigObj()
234
co['test'] = 'foo#bar'
236
self.assertEqual(lines, ['test = "foo#bar"'])
237
co2 = config.ConfigObj(lines)
238
self.assertEqual(co2['test'], 'foo#bar')
241
erroneous_config = """[section] # line 1
244
whocares=notme # line 4
248
class TestConfigObjErrors(tests.TestCase):
250
def test_duplicate_section_name_error_line(self):
252
co = configobj.ConfigObj(StringIO(erroneous_config),
254
except config.configobj.DuplicateError, e:
255
self.assertEqual(3, e.line_number)
257
self.fail('Error in config file not detected')
260
class TestConfig(tests.TestCase):
262
def test_constructs(self):
265
def test_no_default_editor(self):
266
self.assertRaises(NotImplementedError, config.Config().get_editor)
268
def test_user_email(self):
269
my_config = InstrumentedConfig()
270
self.assertEqual('robert.collins@example.org', my_config.user_email())
271
self.assertEqual(['_get_user_id'], my_config._calls)
273
def test_username(self):
274
my_config = InstrumentedConfig()
275
self.assertEqual('Robert Collins <robert.collins@example.org>',
276
my_config.username())
277
self.assertEqual(['_get_user_id'], my_config._calls)
279
def test_signatures_default(self):
280
my_config = config.Config()
281
self.assertFalse(my_config.signature_needed())
282
self.assertEqual(config.CHECK_IF_POSSIBLE,
283
my_config.signature_checking())
284
self.assertEqual(config.SIGN_WHEN_REQUIRED,
285
my_config.signing_policy())
287
def test_signatures_template_method(self):
288
my_config = InstrumentedConfig()
289
self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
290
self.assertEqual(['_get_signature_checking'], my_config._calls)
292
def test_signatures_template_method_none(self):
293
my_config = InstrumentedConfig()
294
my_config._signatures = None
295
self.assertEqual(config.CHECK_IF_POSSIBLE,
296
my_config.signature_checking())
297
self.assertEqual(['_get_signature_checking'], my_config._calls)
299
def test_gpg_signing_command_default(self):
300
my_config = config.Config()
301
self.assertEqual('gpg', my_config.gpg_signing_command())
303
def test_get_user_option_default(self):
304
my_config = config.Config()
305
self.assertEqual(None, my_config.get_user_option('no_option'))
307
def test_post_commit_default(self):
308
my_config = config.Config()
309
self.assertEqual(None, my_config.post_commit())
311
def test_log_format_default(self):
312
my_config = config.Config()
313
self.assertEqual('long', my_config.log_format())
316
class TestConfigPath(tests.TestCase):
319
super(TestConfigPath, self).setUp()
320
os.environ['HOME'] = '/home/bogus'
321
if sys.platform == 'win32':
322
os.environ['BZR_HOME'] = \
323
r'C:\Documents and Settings\bogus\Application Data'
325
'C:/Documents and Settings/bogus/Application Data/bazaar/2.0'
327
self.bzr_home = '/home/bogus/.bazaar'
329
def test_config_dir(self):
330
self.assertEqual(config.config_dir(), self.bzr_home)
332
def test_config_filename(self):
333
self.assertEqual(config.config_filename(),
334
self.bzr_home + '/bazaar.conf')
336
def test_branches_config_filename(self):
337
self.assertEqual(config.branches_config_filename(),
338
self.bzr_home + '/branches.conf')
340
def test_locations_config_filename(self):
341
self.assertEqual(config.locations_config_filename(),
342
self.bzr_home + '/locations.conf')
344
def test_authentication_config_filename(self):
345
self.assertEqual(config.authentication_config_filename(),
346
self.bzr_home + '/authentication.conf')
349
class TestIniConfig(tests.TestCase):
351
def test_contructs(self):
352
my_config = config.IniBasedConfig("nothing")
354
def test_from_fp(self):
355
config_file = StringIO(sample_config_text.encode('utf-8'))
356
my_config = config.IniBasedConfig(None)
358
isinstance(my_config._get_parser(file=config_file),
359
configobj.ConfigObj))
361
def test_cached(self):
362
config_file = StringIO(sample_config_text.encode('utf-8'))
363
my_config = config.IniBasedConfig(None)
364
parser = my_config._get_parser(file=config_file)
365
self.failUnless(my_config._get_parser() is parser)
368
class TestGetConfig(tests.TestCase):
370
def test_constructs(self):
371
my_config = config.GlobalConfig()
373
def test_calls_read_filenames(self):
374
# replace the class that is constructed, to check its parameters
375
oldparserclass = config.ConfigObj
376
config.ConfigObj = InstrumentedConfigObj
377
my_config = config.GlobalConfig()
379
parser = my_config._get_parser()
381
config.ConfigObj = oldparserclass
382
self.failUnless(isinstance(parser, InstrumentedConfigObj))
383
self.assertEqual(parser._calls, [('__init__', config.config_filename(),
387
class TestBranchConfig(tests.TestCaseWithTransport):
389
def test_constructs(self):
390
branch = FakeBranch()
391
my_config = config.BranchConfig(branch)
392
self.assertRaises(TypeError, config.BranchConfig)
394
def test_get_location_config(self):
395
branch = FakeBranch()
396
my_config = config.BranchConfig(branch)
397
location_config = my_config._get_location_config()
398
self.assertEqual(branch.base, location_config.location)
399
self.failUnless(location_config is my_config._get_location_config())
401
def test_get_config(self):
402
"""The Branch.get_config method works properly"""
403
b = bzrdir.BzrDir.create_standalone_workingtree('.').branch
404
my_config = b.get_config()
405
self.assertIs(my_config.get_user_option('wacky'), None)
406
my_config.set_user_option('wacky', 'unlikely')
407
self.assertEqual(my_config.get_user_option('wacky'), 'unlikely')
409
# Ensure we get the same thing if we start again
410
b2 = branch.Branch.open('.')
411
my_config2 = b2.get_config()
412
self.assertEqual(my_config2.get_user_option('wacky'), 'unlikely')
414
def test_has_explicit_nickname(self):
415
b = self.make_branch('.')
416
self.assertFalse(b.get_config().has_explicit_nickname())
418
self.assertTrue(b.get_config().has_explicit_nickname())
420
def test_config_url(self):
421
"""The Branch.get_config will use section that uses a local url"""
422
branch = self.make_branch('branch')
423
self.assertEqual('branch', branch.nick)
425
locations = config.locations_config_filename()
426
config.ensure_config_dir_exists()
427
local_url = urlutils.local_path_to_url('branch')
428
open(locations, 'wb').write('[%s]\nnickname = foobar'
430
self.assertEqual('foobar', branch.nick)
432
def test_config_local_path(self):
433
"""The Branch.get_config will use a local system path"""
434
branch = self.make_branch('branch')
435
self.assertEqual('branch', branch.nick)
437
locations = config.locations_config_filename()
438
config.ensure_config_dir_exists()
439
open(locations, 'wb').write('[%s/branch]\nnickname = barry'
440
% (osutils.getcwd().encode('utf8'),))
441
self.assertEqual('barry', branch.nick)
443
def test_config_creates_local(self):
444
"""Creating a new entry in config uses a local path."""
445
branch = self.make_branch('branch', format='knit')
446
branch.set_push_location('http://foobar')
447
locations = config.locations_config_filename()
448
local_path = osutils.getcwd().encode('utf8')
449
# Surprisingly ConfigObj doesn't create a trailing newline
450
self.check_file_contents(locations,
452
'push_location = http://foobar\n'
453
'push_location:policy = norecurse\n'
456
def test_autonick_urlencoded(self):
457
b = self.make_branch('!repo')
458
self.assertEqual('!repo', b.get_config().get_nickname())
460
def test_warn_if_masked(self):
461
_warning = trace.warning
464
warnings.append(args[0] % args[1:])
466
def set_option(store, warn_masked=True):
468
conf.set_user_option('example_option', repr(store), store=store,
469
warn_masked=warn_masked)
470
def assertWarning(warning):
472
self.assertEqual(0, len(warnings))
474
self.assertEqual(1, len(warnings))
475
self.assertEqual(warning, warnings[0])
476
trace.warning = warning
478
branch = self.make_branch('.')
479
conf = branch.get_config()
480
set_option(config.STORE_GLOBAL)
482
set_option(config.STORE_BRANCH)
484
set_option(config.STORE_GLOBAL)
485
assertWarning('Value "4" is masked by "3" from branch.conf')
486
set_option(config.STORE_GLOBAL, warn_masked=False)
488
set_option(config.STORE_LOCATION)
490
set_option(config.STORE_BRANCH)
491
assertWarning('Value "3" is masked by "0" from locations.conf')
492
set_option(config.STORE_BRANCH, warn_masked=False)
495
trace.warning = _warning
498
class TestGlobalConfigItems(tests.TestCase):
500
def test_user_id(self):
501
config_file = StringIO(sample_config_text.encode('utf-8'))
502
my_config = config.GlobalConfig()
503
my_config._parser = my_config._get_parser(file=config_file)
504
self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
505
my_config._get_user_id())
507
def test_absent_user_id(self):
508
config_file = StringIO("")
509
my_config = config.GlobalConfig()
510
my_config._parser = my_config._get_parser(file=config_file)
511
self.assertEqual(None, my_config._get_user_id())
513
def test_configured_editor(self):
514
config_file = StringIO(sample_config_text.encode('utf-8'))
515
my_config = config.GlobalConfig()
516
my_config._parser = my_config._get_parser(file=config_file)
517
self.assertEqual("vim", my_config.get_editor())
519
def test_signatures_always(self):
520
config_file = StringIO(sample_always_signatures)
521
my_config = config.GlobalConfig()
522
my_config._parser = my_config._get_parser(file=config_file)
523
self.assertEqual(config.CHECK_NEVER,
524
my_config.signature_checking())
525
self.assertEqual(config.SIGN_ALWAYS,
526
my_config.signing_policy())
527
self.assertEqual(True, my_config.signature_needed())
529
def test_signatures_if_possible(self):
530
config_file = StringIO(sample_maybe_signatures)
531
my_config = config.GlobalConfig()
532
my_config._parser = my_config._get_parser(file=config_file)
533
self.assertEqual(config.CHECK_NEVER,
534
my_config.signature_checking())
535
self.assertEqual(config.SIGN_WHEN_REQUIRED,
536
my_config.signing_policy())
537
self.assertEqual(False, my_config.signature_needed())
539
def test_signatures_ignore(self):
540
config_file = StringIO(sample_ignore_signatures)
541
my_config = config.GlobalConfig()
542
my_config._parser = my_config._get_parser(file=config_file)
543
self.assertEqual(config.CHECK_ALWAYS,
544
my_config.signature_checking())
545
self.assertEqual(config.SIGN_NEVER,
546
my_config.signing_policy())
547
self.assertEqual(False, my_config.signature_needed())
549
def _get_sample_config(self):
550
config_file = StringIO(sample_config_text.encode('utf-8'))
551
my_config = config.GlobalConfig()
552
my_config._parser = my_config._get_parser(file=config_file)
555
def test_gpg_signing_command(self):
556
my_config = self._get_sample_config()
557
self.assertEqual("gnome-gpg", my_config.gpg_signing_command())
558
self.assertEqual(False, my_config.signature_needed())
560
def _get_empty_config(self):
561
config_file = StringIO("")
562
my_config = config.GlobalConfig()
563
my_config._parser = my_config._get_parser(file=config_file)
566
def test_gpg_signing_command_unset(self):
567
my_config = self._get_empty_config()
568
self.assertEqual("gpg", my_config.gpg_signing_command())
570
def test_get_user_option_default(self):
571
my_config = self._get_empty_config()
572
self.assertEqual(None, my_config.get_user_option('no_option'))
574
def test_get_user_option_global(self):
575
my_config = self._get_sample_config()
576
self.assertEqual("something",
577
my_config.get_user_option('user_global_option'))
579
def test_post_commit_default(self):
580
my_config = self._get_sample_config()
581
self.assertEqual(None, my_config.post_commit())
583
def test_configured_logformat(self):
584
my_config = self._get_sample_config()
585
self.assertEqual("short", my_config.log_format())
587
def test_get_alias(self):
588
my_config = self._get_sample_config()
589
self.assertEqual('help', my_config.get_alias('h'))
591
def test_get_aliases(self):
592
my_config = self._get_sample_config()
593
aliases = my_config.get_aliases()
594
self.assertEqual(2, len(aliases))
595
sorted_keys = sorted(aliases)
596
self.assertEqual('help', aliases[sorted_keys[0]])
597
self.assertEqual(sample_long_alias, aliases[sorted_keys[1]])
599
def test_get_no_alias(self):
600
my_config = self._get_sample_config()
601
self.assertEqual(None, my_config.get_alias('foo'))
603
def test_get_long_alias(self):
604
my_config = self._get_sample_config()
605
self.assertEqual(sample_long_alias, my_config.get_alias('ll'))
608
class TestGlobalConfigSavingOptions(tests.TestCaseInTempDir):
610
def test_empty(self):
611
my_config = config.GlobalConfig()
612
self.assertEqual(0, len(my_config.get_aliases()))
614
def test_set_alias(self):
615
my_config = config.GlobalConfig()
616
alias_value = 'commit --strict'
617
my_config.set_alias('commit', alias_value)
618
new_config = config.GlobalConfig()
619
self.assertEqual(alias_value, new_config.get_alias('commit'))
621
def test_remove_alias(self):
622
my_config = config.GlobalConfig()
623
my_config.set_alias('commit', 'commit --strict')
624
# Now remove the alias again.
625
my_config.unset_alias('commit')
626
new_config = config.GlobalConfig()
627
self.assertIs(None, new_config.get_alias('commit'))
630
class TestLocationConfig(tests.TestCaseInTempDir):
632
def test_constructs(self):
633
my_config = config.LocationConfig('http://example.com')
634
self.assertRaises(TypeError, config.LocationConfig)
636
def test_branch_calls_read_filenames(self):
637
# This is testing the correct file names are provided.
638
# TODO: consolidate with the test for GlobalConfigs filename checks.
640
# replace the class that is constructed, to check its parameters
641
oldparserclass = config.ConfigObj
642
config.ConfigObj = InstrumentedConfigObj
644
my_config = config.LocationConfig('http://www.example.com')
645
parser = my_config._get_parser()
647
config.ConfigObj = oldparserclass
648
self.failUnless(isinstance(parser, InstrumentedConfigObj))
649
self.assertEqual(parser._calls,
650
[('__init__', config.locations_config_filename(),
652
config.ensure_config_dir_exists()
653
#os.mkdir(config.config_dir())
654
f = file(config.branches_config_filename(), 'wb')
657
oldparserclass = config.ConfigObj
658
config.ConfigObj = InstrumentedConfigObj
660
my_config = config.LocationConfig('http://www.example.com')
661
parser = my_config._get_parser()
663
config.ConfigObj = oldparserclass
665
def test_get_global_config(self):
666
my_config = config.BranchConfig(FakeBranch('http://example.com'))
667
global_config = my_config._get_global_config()
668
self.failUnless(isinstance(global_config, config.GlobalConfig))
669
self.failUnless(global_config is my_config._get_global_config())
671
def test__get_matching_sections_no_match(self):
672
self.get_branch_config('/')
673
self.assertEqual([], self.my_location_config._get_matching_sections())
675
def test__get_matching_sections_exact(self):
676
self.get_branch_config('http://www.example.com')
677
self.assertEqual([('http://www.example.com', '')],
678
self.my_location_config._get_matching_sections())
680
def test__get_matching_sections_suffix_does_not(self):
681
self.get_branch_config('http://www.example.com-com')
682
self.assertEqual([], self.my_location_config._get_matching_sections())
684
def test__get_matching_sections_subdir_recursive(self):
685
self.get_branch_config('http://www.example.com/com')
686
self.assertEqual([('http://www.example.com', 'com')],
687
self.my_location_config._get_matching_sections())
689
def test__get_matching_sections_ignoreparent(self):
690
self.get_branch_config('http://www.example.com/ignoreparent')
691
self.assertEqual([('http://www.example.com/ignoreparent', '')],
692
self.my_location_config._get_matching_sections())
694
def test__get_matching_sections_ignoreparent_subdir(self):
695
self.get_branch_config(
696
'http://www.example.com/ignoreparent/childbranch')
697
self.assertEqual([('http://www.example.com/ignoreparent',
699
self.my_location_config._get_matching_sections())
701
def test__get_matching_sections_subdir_trailing_slash(self):
702
self.get_branch_config('/b')
703
self.assertEqual([('/b/', '')],
704
self.my_location_config._get_matching_sections())
706
def test__get_matching_sections_subdir_child(self):
707
self.get_branch_config('/a/foo')
708
self.assertEqual([('/a/*', ''), ('/a/', 'foo')],
709
self.my_location_config._get_matching_sections())
711
def test__get_matching_sections_subdir_child_child(self):
712
self.get_branch_config('/a/foo/bar')
713
self.assertEqual([('/a/*', 'bar'), ('/a/', 'foo/bar')],
714
self.my_location_config._get_matching_sections())
716
def test__get_matching_sections_trailing_slash_with_children(self):
717
self.get_branch_config('/a/')
718
self.assertEqual([('/a/', '')],
719
self.my_location_config._get_matching_sections())
721
def test__get_matching_sections_explicit_over_glob(self):
722
# XXX: 2006-09-08 jamesh
723
# This test only passes because ord('c') > ord('*'). If there
724
# was a config section for '/a/?', it would get precedence
726
self.get_branch_config('/a/c')
727
self.assertEqual([('/a/c', ''), ('/a/*', ''), ('/a/', 'c')],
728
self.my_location_config._get_matching_sections())
730
def test__get_option_policy_normal(self):
731
self.get_branch_config('http://www.example.com')
733
self.my_location_config._get_config_policy(
734
'http://www.example.com', 'normal_option'),
737
def test__get_option_policy_norecurse(self):
738
self.get_branch_config('http://www.example.com')
740
self.my_location_config._get_option_policy(
741
'http://www.example.com', 'norecurse_option'),
742
config.POLICY_NORECURSE)
743
# Test old recurse=False setting:
745
self.my_location_config._get_option_policy(
746
'http://www.example.com/norecurse', 'normal_option'),
747
config.POLICY_NORECURSE)
749
def test__get_option_policy_normal(self):
750
self.get_branch_config('http://www.example.com')
752
self.my_location_config._get_option_policy(
753
'http://www.example.com', 'appendpath_option'),
754
config.POLICY_APPENDPATH)
756
def test_location_without_username(self):
757
self.get_branch_config('http://www.example.com/ignoreparent')
758
self.assertEqual(u'Erik B\u00e5gfors <erik@bagfors.nu>',
759
self.my_config.username())
761
def test_location_not_listed(self):
762
"""Test that the global username is used when no location matches"""
763
self.get_branch_config('/home/robertc/sources')
764
self.assertEqual(u'Erik B\u00e5gfors <erik@bagfors.nu>',
765
self.my_config.username())
767
def test_overriding_location(self):
768
self.get_branch_config('http://www.example.com/foo')
769
self.assertEqual('Robert Collins <robertc@example.org>',
770
self.my_config.username())
772
def test_signatures_not_set(self):
773
self.get_branch_config('http://www.example.com',
774
global_config=sample_ignore_signatures)
775
self.assertEqual(config.CHECK_ALWAYS,
776
self.my_config.signature_checking())
777
self.assertEqual(config.SIGN_NEVER,
778
self.my_config.signing_policy())
780
def test_signatures_never(self):
781
self.get_branch_config('/a/c')
782
self.assertEqual(config.CHECK_NEVER,
783
self.my_config.signature_checking())
785
def test_signatures_when_available(self):
786
self.get_branch_config('/a/', global_config=sample_ignore_signatures)
787
self.assertEqual(config.CHECK_IF_POSSIBLE,
788
self.my_config.signature_checking())
790
def test_signatures_always(self):
791
self.get_branch_config('/b')
792
self.assertEqual(config.CHECK_ALWAYS,
793
self.my_config.signature_checking())
795
def test_gpg_signing_command(self):
796
self.get_branch_config('/b')
797
self.assertEqual("gnome-gpg", self.my_config.gpg_signing_command())
799
def test_gpg_signing_command_missing(self):
800
self.get_branch_config('/a')
801
self.assertEqual("false", self.my_config.gpg_signing_command())
803
def test_get_user_option_global(self):
804
self.get_branch_config('/a')
805
self.assertEqual('something',
806
self.my_config.get_user_option('user_global_option'))
808
def test_get_user_option_local(self):
809
self.get_branch_config('/a')
810
self.assertEqual('local',
811
self.my_config.get_user_option('user_local_option'))
813
def test_get_user_option_appendpath(self):
814
# returned as is for the base path:
815
self.get_branch_config('http://www.example.com')
816
self.assertEqual('append',
817
self.my_config.get_user_option('appendpath_option'))
818
# Extra path components get appended:
819
self.get_branch_config('http://www.example.com/a/b/c')
820
self.assertEqual('append/a/b/c',
821
self.my_config.get_user_option('appendpath_option'))
822
# Overriden for http://www.example.com/dir, where it is a
824
self.get_branch_config('http://www.example.com/dir/a/b/c')
825
self.assertEqual('normal',
826
self.my_config.get_user_option('appendpath_option'))
828
def test_get_user_option_norecurse(self):
829
self.get_branch_config('http://www.example.com')
830
self.assertEqual('norecurse',
831
self.my_config.get_user_option('norecurse_option'))
832
self.get_branch_config('http://www.example.com/dir')
833
self.assertEqual(None,
834
self.my_config.get_user_option('norecurse_option'))
835
# http://www.example.com/norecurse is a recurse=False section
836
# that redefines normal_option. Subdirectories do not pick up
838
self.get_branch_config('http://www.example.com/norecurse')
839
self.assertEqual('norecurse',
840
self.my_config.get_user_option('normal_option'))
841
self.get_branch_config('http://www.example.com/norecurse/subdir')
842
self.assertEqual('normal',
843
self.my_config.get_user_option('normal_option'))
845
def test_set_user_option_norecurse(self):
846
self.get_branch_config('http://www.example.com')
847
self.my_config.set_user_option('foo', 'bar',
848
store=config.STORE_LOCATION_NORECURSE)
850
self.my_location_config._get_option_policy(
851
'http://www.example.com', 'foo'),
852
config.POLICY_NORECURSE)
854
def test_set_user_option_appendpath(self):
855
self.get_branch_config('http://www.example.com')
856
self.my_config.set_user_option('foo', 'bar',
857
store=config.STORE_LOCATION_APPENDPATH)
859
self.my_location_config._get_option_policy(
860
'http://www.example.com', 'foo'),
861
config.POLICY_APPENDPATH)
863
def test_set_user_option_change_policy(self):
864
self.get_branch_config('http://www.example.com')
865
self.my_config.set_user_option('norecurse_option', 'normal',
866
store=config.STORE_LOCATION)
868
self.my_location_config._get_option_policy(
869
'http://www.example.com', 'norecurse_option'),
872
def test_set_user_option_recurse_false_section(self):
873
# The following section has recurse=False set. The test is to
874
# make sure that a normal option can be added to the section,
875
# converting recurse=False to the norecurse policy.
876
self.get_branch_config('http://www.example.com/norecurse')
877
self.callDeprecated(['The recurse option is deprecated as of 0.14. '
878
'The section "http://www.example.com/norecurse" '
879
'has been converted to use policies.'],
880
self.my_config.set_user_option,
881
'foo', 'bar', store=config.STORE_LOCATION)
883
self.my_location_config._get_option_policy(
884
'http://www.example.com/norecurse', 'foo'),
886
# The previously existing option is still norecurse:
888
self.my_location_config._get_option_policy(
889
'http://www.example.com/norecurse', 'normal_option'),
890
config.POLICY_NORECURSE)
892
def test_post_commit_default(self):
893
self.get_branch_config('/a/c')
894
self.assertEqual('bzrlib.tests.test_config.post_commit',
895
self.my_config.post_commit())
897
def get_branch_config(self, location, global_config=None):
898
if global_config is None:
899
global_file = StringIO(sample_config_text.encode('utf-8'))
901
global_file = StringIO(global_config.encode('utf-8'))
902
branches_file = StringIO(sample_branches_text.encode('utf-8'))
903
self.my_config = config.BranchConfig(FakeBranch(location))
904
# Force location config to use specified file
905
self.my_location_config = self.my_config._get_location_config()
906
self.my_location_config._get_parser(branches_file)
907
# Force global config to use specified file
908
self.my_config._get_global_config()._get_parser(global_file)
910
def test_set_user_setting_sets_and_saves(self):
911
self.get_branch_config('/a/c')
912
record = InstrumentedConfigObj("foo")
913
self.my_location_config._parser = record
915
real_mkdir = os.mkdir
917
def checked_mkdir(path, mode=0777):
918
self.log('making directory: %s', path)
919
real_mkdir(path, mode)
922
os.mkdir = checked_mkdir
924
self.callDeprecated(['The recurse option is deprecated as of '
925
'0.14. The section "/a/c" has been '
926
'converted to use policies.'],
927
self.my_config.set_user_option,
928
'foo', 'bar', store=config.STORE_LOCATION)
930
os.mkdir = real_mkdir
932
self.failUnless(self.created, 'Failed to create ~/.bazaar')
933
self.assertEqual([('__contains__', '/a/c'),
934
('__contains__', '/a/c/'),
935
('__setitem__', '/a/c', {}),
936
('__getitem__', '/a/c'),
937
('__setitem__', 'foo', 'bar'),
938
('__getitem__', '/a/c'),
939
('as_bool', 'recurse'),
940
('__getitem__', '/a/c'),
941
('__delitem__', 'recurse'),
942
('__getitem__', '/a/c'),
944
('__getitem__', '/a/c'),
945
('__contains__', 'foo:policy'),
949
def test_set_user_setting_sets_and_saves2(self):
950
self.get_branch_config('/a/c')
951
self.assertIs(self.my_config.get_user_option('foo'), None)
952
self.my_config.set_user_option('foo', 'bar')
954
self.my_config.branch.control_files.files['branch.conf'].strip(),
956
self.assertEqual(self.my_config.get_user_option('foo'), 'bar')
957
self.my_config.set_user_option('foo', 'baz',
958
store=config.STORE_LOCATION)
959
self.assertEqual(self.my_config.get_user_option('foo'), 'baz')
960
self.my_config.set_user_option('foo', 'qux')
961
self.assertEqual(self.my_config.get_user_option('foo'), 'baz')
963
def test_get_bzr_remote_path(self):
964
my_config = config.LocationConfig('/a/c')
965
self.assertEqual('bzr', my_config.get_bzr_remote_path())
966
my_config.set_user_option('bzr_remote_path', '/path-bzr')
967
self.assertEqual('/path-bzr', my_config.get_bzr_remote_path())
968
os.environ['BZR_REMOTE_PATH'] = '/environ-bzr'
969
self.assertEqual('/environ-bzr', my_config.get_bzr_remote_path())
972
precedence_global = 'option = global'
973
precedence_branch = 'option = branch'
974
precedence_location = """
978
[http://example.com/specific]
983
class TestBranchConfigItems(tests.TestCaseInTempDir):
985
def get_branch_config(self, global_config=None, location=None,
986
location_config=None, branch_data_config=None):
987
my_config = config.BranchConfig(FakeBranch(location))
988
if global_config is not None:
989
global_file = StringIO(global_config.encode('utf-8'))
990
my_config._get_global_config()._get_parser(global_file)
991
self.my_location_config = my_config._get_location_config()
992
if location_config is not None:
993
location_file = StringIO(location_config.encode('utf-8'))
994
self.my_location_config._get_parser(location_file)
995
if branch_data_config is not None:
996
my_config.branch.control_files.files['branch.conf'] = \
1000
def test_user_id(self):
1001
branch = FakeBranch(user_id='Robert Collins <robertc@example.net>')
1002
my_config = config.BranchConfig(branch)
1003
self.assertEqual("Robert Collins <robertc@example.net>",
1004
my_config.username())
1005
my_config.branch.control_files.files['email'] = "John"
1006
my_config.set_user_option('email',
1007
"Robert Collins <robertc@example.org>")
1008
self.assertEqual("John", my_config.username())
1009
del my_config.branch.control_files.files['email']
1010
self.assertEqual("Robert Collins <robertc@example.org>",
1011
my_config.username())
1013
def test_not_set_in_branch(self):
1014
my_config = self.get_branch_config(sample_config_text)
1015
self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
1016
my_config._get_user_id())
1017
my_config.branch.control_files.files['email'] = "John"
1018
self.assertEqual("John", my_config._get_user_id())
1020
def test_BZR_EMAIL_OVERRIDES(self):
1021
os.environ['BZR_EMAIL'] = "Robert Collins <robertc@example.org>"
1022
branch = FakeBranch()
1023
my_config = config.BranchConfig(branch)
1024
self.assertEqual("Robert Collins <robertc@example.org>",
1025
my_config.username())
1027
def test_signatures_forced(self):
1028
my_config = self.get_branch_config(
1029
global_config=sample_always_signatures)
1030
self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
1031
self.assertEqual(config.SIGN_ALWAYS, my_config.signing_policy())
1032
self.assertTrue(my_config.signature_needed())
1034
def test_signatures_forced_branch(self):
1035
my_config = self.get_branch_config(
1036
global_config=sample_ignore_signatures,
1037
branch_data_config=sample_always_signatures)
1038
self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
1039
self.assertEqual(config.SIGN_ALWAYS, my_config.signing_policy())
1040
self.assertTrue(my_config.signature_needed())
1042
def test_gpg_signing_command(self):
1043
my_config = self.get_branch_config(
1044
# branch data cannot set gpg_signing_command
1045
branch_data_config="gpg_signing_command=pgp")
1046
config_file = StringIO(sample_config_text.encode('utf-8'))
1047
my_config._get_global_config()._get_parser(config_file)
1048
self.assertEqual('gnome-gpg', my_config.gpg_signing_command())
1050
def test_get_user_option_global(self):
1051
branch = FakeBranch()
1052
my_config = config.BranchConfig(branch)
1053
config_file = StringIO(sample_config_text.encode('utf-8'))
1054
(my_config._get_global_config()._get_parser(config_file))
1055
self.assertEqual('something',
1056
my_config.get_user_option('user_global_option'))
1058
def test_post_commit_default(self):
1059
branch = FakeBranch()
1060
my_config = self.get_branch_config(sample_config_text, '/a/c',
1061
sample_branches_text)
1062
self.assertEqual(my_config.branch.base, '/a/c')
1063
self.assertEqual('bzrlib.tests.test_config.post_commit',
1064
my_config.post_commit())
1065
my_config.set_user_option('post_commit', 'rmtree_root')
1066
# post-commit is ignored when bresent in branch data
1067
self.assertEqual('bzrlib.tests.test_config.post_commit',
1068
my_config.post_commit())
1069
my_config.set_user_option('post_commit', 'rmtree_root',
1070
store=config.STORE_LOCATION)
1071
self.assertEqual('rmtree_root', my_config.post_commit())
1073
def test_config_precedence(self):
1074
my_config = self.get_branch_config(global_config=precedence_global)
1075
self.assertEqual(my_config.get_user_option('option'), 'global')
1076
my_config = self.get_branch_config(global_config=precedence_global,
1077
branch_data_config=precedence_branch)
1078
self.assertEqual(my_config.get_user_option('option'), 'branch')
1079
my_config = self.get_branch_config(global_config=precedence_global,
1080
branch_data_config=precedence_branch,
1081
location_config=precedence_location)
1082
self.assertEqual(my_config.get_user_option('option'), 'recurse')
1083
my_config = self.get_branch_config(global_config=precedence_global,
1084
branch_data_config=precedence_branch,
1085
location_config=precedence_location,
1086
location='http://example.com/specific')
1087
self.assertEqual(my_config.get_user_option('option'), 'exact')
1089
def test_get_mail_client(self):
1090
config = self.get_branch_config()
1091
client = config.get_mail_client()
1092
self.assertIsInstance(client, mail_client.DefaultMail)
1095
config.set_user_option('mail_client', 'evolution')
1096
client = config.get_mail_client()
1097
self.assertIsInstance(client, mail_client.Evolution)
1099
config.set_user_option('mail_client', 'kmail')
1100
client = config.get_mail_client()
1101
self.assertIsInstance(client, mail_client.KMail)
1103
config.set_user_option('mail_client', 'mutt')
1104
client = config.get_mail_client()
1105
self.assertIsInstance(client, mail_client.Mutt)
1107
config.set_user_option('mail_client', 'thunderbird')
1108
client = config.get_mail_client()
1109
self.assertIsInstance(client, mail_client.Thunderbird)
1112
config.set_user_option('mail_client', 'default')
1113
client = config.get_mail_client()
1114
self.assertIsInstance(client, mail_client.DefaultMail)
1116
config.set_user_option('mail_client', 'editor')
1117
client = config.get_mail_client()
1118
self.assertIsInstance(client, mail_client.Editor)
1120
config.set_user_option('mail_client', 'mapi')
1121
client = config.get_mail_client()
1122
self.assertIsInstance(client, mail_client.MAPIClient)
1124
config.set_user_option('mail_client', 'xdg-email')
1125
client = config.get_mail_client()
1126
self.assertIsInstance(client, mail_client.XDGEmail)
1128
config.set_user_option('mail_client', 'firebird')
1129
self.assertRaises(errors.UnknownMailClient, config.get_mail_client)
1132
class TestMailAddressExtraction(tests.TestCase):
1134
def test_extract_email_address(self):
1135
self.assertEqual('jane@test.com',
1136
config.extract_email_address('Jane <jane@test.com>'))
1137
self.assertRaises(errors.NoEmailInUsername,
1138
config.extract_email_address, 'Jane Tester')
1140
def test_parse_username(self):
1141
self.assertEqual(('', 'jdoe@example.com'),
1142
config.parse_username('jdoe@example.com'))
1143
self.assertEqual(('', 'jdoe@example.com'),
1144
config.parse_username('<jdoe@example.com>'))
1145
self.assertEqual(('John Doe', 'jdoe@example.com'),
1146
config.parse_username('John Doe <jdoe@example.com>'))
1147
self.assertEqual(('John Doe', ''),
1148
config.parse_username('John Doe'))
1149
self.assertEqual(('John Doe', 'jdoe@example.com'),
1150
config.parse_username('John Doe jdoe@example.com'))
1152
class TestTreeConfig(tests.TestCaseWithTransport):
1154
def test_get_value(self):
1155
"""Test that retreiving a value from a section is possible"""
1156
branch = self.make_branch('.')
1157
tree_config = config.TreeConfig(branch)
1158
tree_config.set_option('value', 'key', 'SECTION')
1159
tree_config.set_option('value2', 'key2')
1160
tree_config.set_option('value3-top', 'key3')
1161
tree_config.set_option('value3-section', 'key3', 'SECTION')
1162
value = tree_config.get_option('key', 'SECTION')
1163
self.assertEqual(value, 'value')
1164
value = tree_config.get_option('key2')
1165
self.assertEqual(value, 'value2')
1166
self.assertEqual(tree_config.get_option('non-existant'), None)
1167
value = tree_config.get_option('non-existant', 'SECTION')
1168
self.assertEqual(value, None)
1169
value = tree_config.get_option('non-existant', default='default')
1170
self.assertEqual(value, 'default')
1171
self.assertEqual(tree_config.get_option('key2', 'NOSECTION'), None)
1172
value = tree_config.get_option('key2', 'NOSECTION', default='default')
1173
self.assertEqual(value, 'default')
1174
value = tree_config.get_option('key3')
1175
self.assertEqual(value, 'value3-top')
1176
value = tree_config.get_option('key3', 'SECTION')
1177
self.assertEqual(value, 'value3-section')
1180
class TestTransportConfig(tests.TestCaseWithTransport):
1182
def test_get_value(self):
1183
"""Test that retreiving a value from a section is possible"""
1184
bzrdir_config = config.TransportConfig(transport.get_transport('.'),
1186
bzrdir_config.set_option('value', 'key', 'SECTION')
1187
bzrdir_config.set_option('value2', 'key2')
1188
bzrdir_config.set_option('value3-top', 'key3')
1189
bzrdir_config.set_option('value3-section', 'key3', 'SECTION')
1190
value = bzrdir_config.get_option('key', 'SECTION')
1191
self.assertEqual(value, 'value')
1192
value = bzrdir_config.get_option('key2')
1193
self.assertEqual(value, 'value2')
1194
self.assertEqual(bzrdir_config.get_option('non-existant'), None)
1195
value = bzrdir_config.get_option('non-existant', 'SECTION')
1196
self.assertEqual(value, None)
1197
value = bzrdir_config.get_option('non-existant', default='default')
1198
self.assertEqual(value, 'default')
1199
self.assertEqual(bzrdir_config.get_option('key2', 'NOSECTION'), None)
1200
value = bzrdir_config.get_option('key2', 'NOSECTION',
1202
self.assertEqual(value, 'default')
1203
value = bzrdir_config.get_option('key3')
1204
self.assertEqual(value, 'value3-top')
1205
value = bzrdir_config.get_option('key3', 'SECTION')
1206
self.assertEqual(value, 'value3-section')
1208
def test_set_unset_default_stack_on(self):
1209
my_dir = self.make_bzrdir('.')
1210
bzrdir_config = config.BzrDirConfig(my_dir.transport)
1211
self.assertIs(None, bzrdir_config.get_default_stack_on())
1212
bzrdir_config.set_default_stack_on('Foo')
1213
self.assertEqual('Foo', bzrdir_config._config.get_option(
1214
'default_stack_on'))
1215
self.assertEqual('Foo', bzrdir_config.get_default_stack_on())
1216
bzrdir_config.set_default_stack_on(None)
1217
self.assertIs(None, bzrdir_config.get_default_stack_on())
1220
class TestAuthenticationConfigFile(tests.TestCase):
1221
"""Test the authentication.conf file matching"""
1223
def _got_user_passwd(self, expected_user, expected_password,
1224
config, *args, **kwargs):
1225
credentials = config.get_credentials(*args, **kwargs)
1226
if credentials is None:
1230
user = credentials['user']
1231
password = credentials['password']
1232
self.assertEquals(expected_user, user)
1233
self.assertEquals(expected_password, password)
1235
def test_empty_config(self):
1236
conf = config.AuthenticationConfig(_file=StringIO())
1237
self.assertEquals({}, conf._get_config())
1238
self._got_user_passwd(None, None, conf, 'http', 'foo.net')
1240
def test_missing_auth_section_header(self):
1241
conf = config.AuthenticationConfig(_file=StringIO('foo = bar'))
1242
self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
1244
def test_auth_section_header_not_closed(self):
1245
conf = config.AuthenticationConfig(_file=StringIO('[DEF'))
1246
self.assertRaises(errors.ParseConfigError, conf._get_config)
1248
def test_auth_value_not_boolean(self):
1249
conf = config.AuthenticationConfig(_file=StringIO(
1253
verify_certificates=askme # Error: Not a boolean
1255
self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
1257
def test_auth_value_not_int(self):
1258
conf = config.AuthenticationConfig(_file=StringIO(
1262
port=port # Error: Not an int
1264
self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
1266
def test_unknown_password_encoding(self):
1267
conf = config.AuthenticationConfig(_file=StringIO(
1271
password_encoding=unknown
1273
self.assertRaises(ValueError, conf.get_password,
1274
'ftp', 'foo.net', 'joe')
1276
def test_credentials_for_scheme_host(self):
1277
conf = config.AuthenticationConfig(_file=StringIO(
1278
"""# Identity on foo.net
1283
password=secret-pass
1286
self._got_user_passwd('joe', 'secret-pass', conf, 'ftp', 'foo.net')
1288
self._got_user_passwd(None, None, conf, 'http', 'foo.net')
1290
self._got_user_passwd(None, None, conf, 'ftp', 'bar.net')
1292
def test_credentials_for_host_port(self):
1293
conf = config.AuthenticationConfig(_file=StringIO(
1294
"""# Identity on foo.net
1300
password=secret-pass
1303
self._got_user_passwd('joe', 'secret-pass',
1304
conf, 'ftp', 'foo.net', port=10021)
1306
self._got_user_passwd(None, None, conf, 'ftp', 'foo.net')
1308
def test_for_matching_host(self):
1309
conf = config.AuthenticationConfig(_file=StringIO(
1310
"""# Identity on foo.net
1316
[sourceforge domain]
1323
self._got_user_passwd('georges', 'bendover',
1324
conf, 'bzr', 'foo.bzr.sf.net')
1326
self._got_user_passwd(None, None,
1327
conf, 'bzr', 'bbzr.sf.net')
1329
def test_for_matching_host_None(self):
1330
conf = config.AuthenticationConfig(_file=StringIO(
1331
"""# Identity on foo.net
1341
self._got_user_passwd('joe', 'joepass',
1342
conf, 'bzr', 'quux.net')
1343
# no host but different scheme
1344
self._got_user_passwd('georges', 'bendover',
1345
conf, 'ftp', 'quux.net')
1347
def test_credentials_for_path(self):
1348
conf = config.AuthenticationConfig(_file=StringIO(
1364
self._got_user_passwd(None, None,
1365
conf, 'http', host='bar.org', path='/dir3')
1367
self._got_user_passwd('georges', 'bendover',
1368
conf, 'http', host='bar.org', path='/dir2')
1370
self._got_user_passwd('jim', 'jimpass',
1371
conf, 'http', host='bar.org',path='/dir1/subdir')
1373
def test_credentials_for_user(self):
1374
conf = config.AuthenticationConfig(_file=StringIO(
1383
self._got_user_passwd('jim', 'jimpass',
1384
conf, 'http', 'bar.org')
1386
self._got_user_passwd('jim', 'jimpass',
1387
conf, 'http', 'bar.org', user='jim')
1388
# Don't get a different user if one is specified
1389
self._got_user_passwd(None, None,
1390
conf, 'http', 'bar.org', user='georges')
1392
def test_credentials_for_user_without_password(self):
1393
conf = config.AuthenticationConfig(_file=StringIO(
1400
# Get user but no password
1401
self._got_user_passwd('jim', None,
1402
conf, 'http', 'bar.org')
1404
def test_verify_certificates(self):
1405
conf = config.AuthenticationConfig(_file=StringIO(
1412
verify_certificates=False
1419
credentials = conf.get_credentials('https', 'bar.org')
1420
self.assertEquals(False, credentials.get('verify_certificates'))
1421
credentials = conf.get_credentials('https', 'foo.net')
1422
self.assertEquals(True, credentials.get('verify_certificates'))
1425
class TestAuthenticationStorage(tests.TestCaseInTempDir):
1427
def test_set_credentials(self):
1428
conf = config.AuthenticationConfig()
1429
conf.set_credentials('name', 'host', 'user', 'scheme', 'password',
1430
99, path='/foo', verify_certificates=False, realm='realm')
1431
credentials = conf.get_credentials(host='host', scheme='scheme',
1432
port=99, path='/foo',
1434
CREDENTIALS = {'name': 'name', 'user': 'user', 'password': 'password',
1435
'verify_certificates': False, 'scheme': 'scheme',
1436
'host': 'host', 'port': 99, 'path': '/foo',
1438
self.assertEqual(CREDENTIALS, credentials)
1439
credentials_from_disk = config.AuthenticationConfig().get_credentials(
1440
host='host', scheme='scheme', port=99, path='/foo', realm='realm')
1441
self.assertEqual(CREDENTIALS, credentials_from_disk)
1443
def test_reset_credentials_different_name(self):
1444
conf = config.AuthenticationConfig()
1445
conf.set_credentials('name', 'host', 'user', 'scheme', 'password'),
1446
conf.set_credentials('name2', 'host', 'user2', 'scheme', 'password'),
1447
self.assertIs(None, conf._get_config().get('name'))
1448
credentials = conf.get_credentials(host='host', scheme='scheme')
1449
CREDENTIALS = {'name': 'name2', 'user': 'user2', 'password':
1450
'password', 'verify_certificates': True,
1451
'scheme': 'scheme', 'host': 'host', 'port': None,
1452
'path': None, 'realm': None}
1453
self.assertEqual(CREDENTIALS, credentials)
1456
class TestAuthenticationConfig(tests.TestCase):
1457
"""Test AuthenticationConfig behaviour"""
1459
def _check_default_prompt(self, expected_prompt_format, scheme,
1460
host=None, port=None, realm=None, path=None):
1463
user, password = 'jim', 'precious'
1464
expected_prompt = expected_prompt_format % {
1465
'scheme': scheme, 'host': host, 'port': port,
1466
'user': user, 'realm': realm}
1468
stdout = tests.StringIOWrapper()
1469
ui.ui_factory = tests.TestUIFactory(stdin=password + '\n',
1471
# We use an empty conf so that the user is always prompted
1472
conf = config.AuthenticationConfig()
1473
self.assertEquals(password,
1474
conf.get_password(scheme, host, user, port=port,
1475
realm=realm, path=path))
1476
self.assertEquals(stdout.getvalue(), expected_prompt)
1478
def test_default_prompts(self):
1479
# HTTP prompts can't be tested here, see test_http.py
1480
self._check_default_prompt('FTP %(user)s@%(host)s password: ', 'ftp')
1481
self._check_default_prompt('FTP %(user)s@%(host)s:%(port)d password: ',
1484
self._check_default_prompt('SSH %(user)s@%(host)s:%(port)d password: ',
1486
# SMTP port handling is a bit special (it's handled if embedded in the
1488
# FIXME: should we: forbid that, extend it to other schemes, leave
1489
# things as they are that's fine thank you ?
1490
self._check_default_prompt('SMTP %(user)s@%(host)s password: ',
1492
self._check_default_prompt('SMTP %(user)s@%(host)s password: ',
1493
'smtp', host='bar.org:10025')
1494
self._check_default_prompt(
1495
'SMTP %(user)s@%(host)s:%(port)d password: ',
1498
def test_ssh_password_emits_warning(self):
1499
conf = config.AuthenticationConfig(_file=StringIO(
1507
entered_password = 'typed-by-hand'
1508
stdout = tests.StringIOWrapper()
1509
ui.ui_factory = tests.TestUIFactory(stdin=entered_password + '\n',
1512
# Since the password defined in the authentication config is ignored,
1513
# the user is prompted
1514
self.assertEquals(entered_password,
1515
conf.get_password('ssh', 'bar.org', user='jim'))
1516
self.assertContainsRe(
1517
self._get_log(keep_log_file=True),
1518
'password ignored in section \[ssh with password\]')
1520
def test_ssh_without_password_doesnt_emit_warning(self):
1521
conf = config.AuthenticationConfig(_file=StringIO(
1528
entered_password = 'typed-by-hand'
1529
stdout = tests.StringIOWrapper()
1530
ui.ui_factory = tests.TestUIFactory(stdin=entered_password + '\n',
1533
# Since the password defined in the authentication config is ignored,
1534
# the user is prompted
1535
self.assertEquals(entered_password,
1536
conf.get_password('ssh', 'bar.org', user='jim'))
1537
# No warning shoud be emitted since there is no password. We are only
1539
self.assertNotContainsRe(
1540
self._get_log(keep_log_file=True),
1541
'password ignored in section \[ssh with password\]')
1544
class TestCredentialStoreRegistry(tests.TestCase):
1546
def _get_cs_registry(self):
1547
return config.credential_store_registry
1549
def test_default_credential_store(self):
1550
r = self._get_cs_registry()
1551
default = r.get_credential_store(None)
1552
self.assertIsInstance(default, config.PlainTextCredentialStore)
1554
def test_unknown_credential_store(self):
1555
r = self._get_cs_registry()
1556
# It's hard to imagine someone creating a credential store named
1557
# 'unknown' so we use that as an never registered key.
1558
self.assertRaises(KeyError, r.get_credential_store, 'unknown')
1561
class TestPlainTextCredentialStore(tests.TestCase):
1563
def test_decode_password(self):
1564
r = config.credential_store_registry
1565
plain_text = r.get_credential_store()
1566
decoded = plain_text.decode_password(dict(password='secret'))
1567
self.assertEquals('secret', decoded)
1570
# FIXME: Once we have a way to declare authentication to all test servers, we
1571
# can implement generic tests.
1572
# test_user_password_in_url
1573
# test_user_in_url_password_from_config
1574
# test_user_in_url_password_prompted
1575
# test_user_in_config
1576
# test_user_getpass.getuser
1577
# test_user_prompted ?
1578
class TestAuthenticationRing(tests.TestCaseWithTransport):
added
removed
bzrlib/tests/test_config.py
