1
# Copyright (C) 2005, 2006 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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
37
from bzrlib.util.configobj import configobj
40
sample_long_alias="log -r-15..-1 --line"
41
sample_config_text = u"""
43
email=Erik B\u00e5gfors <erik@bagfors.nu>
45
gpg_signing_command=gnome-gpg
47
user_global_option=something
50
ll=""" + sample_long_alias + "\n"
53
sample_always_signatures = """
55
check_signatures=ignore
56
create_signatures=always
59
sample_ignore_signatures = """
61
check_signatures=require
62
create_signatures=never
65
sample_maybe_signatures = """
67
check_signatures=ignore
68
create_signatures=when-required
71
sample_branches_text = """
72
[http://www.example.com]
74
email=Robert Collins <robertc@example.org>
75
normal_option = normal
76
appendpath_option = append
77
appendpath_option:policy = appendpath
78
norecurse_option = norecurse
79
norecurse_option:policy = norecurse
80
[http://www.example.com/ignoreparent]
81
# different project: ignore parent dir config
83
[http://www.example.com/norecurse]
84
# configuration items that only apply to this dir
86
normal_option = norecurse
87
[http://www.example.com/dir]
88
appendpath_option = normal
90
check_signatures=require
91
# test trailing / matching with no children
93
check_signatures=check-available
94
gpg_signing_command=false
95
user_local_option=local
96
# test trailing / matching
98
#subdirs will match but not the parent
100
check_signatures=ignore
101
post_commit=bzrlib.tests.test_config.post_commit
102
#testing explicit beats globs
106
class InstrumentedConfigObj(object):
107
"""A config obj look-enough-alike to record calls made to it."""
109
def __contains__(self, thing):
110
self._calls.append(('__contains__', thing))
113
def __getitem__(self, key):
114
self._calls.append(('__getitem__', key))
117
def __init__(self, input, encoding=None):
118
self._calls = [('__init__', input, encoding)]
120
def __setitem__(self, key, value):
121
self._calls.append(('__setitem__', key, value))
123
def __delitem__(self, key):
124
self._calls.append(('__delitem__', key))
127
self._calls.append(('keys',))
130
def write(self, arg):
131
self._calls.append(('write',))
133
def as_bool(self, value):
134
self._calls.append(('as_bool', value))
137
def get_value(self, section, name):
138
self._calls.append(('get_value', section, name))
142
class FakeBranch(object):
144
def __init__(self, base=None, user_id=None):
146
self.base = "http://example.com/branches/demo"
149
self.control_files = FakeControlFiles(user_id=user_id)
151
def lock_write(self):
158
class FakeControlFiles(object):
160
def __init__(self, user_id=None):
164
def get_utf8(self, filename):
165
if filename != 'email':
166
raise NotImplementedError
167
if self.email is not None:
168
return StringIO(self.email)
169
raise errors.NoSuchFile(filename)
171
def get(self, filename):
173
return StringIO(self.files[filename])
175
raise errors.NoSuchFile(filename)
177
def put(self, filename, fileobj):
178
self.files[filename] = fileobj.read()
181
class InstrumentedConfig(config.Config):
182
"""An instrumented config that supplies stubs for template methods."""
185
super(InstrumentedConfig, self).__init__()
187
self._signatures = config.CHECK_NEVER
189
def _get_user_id(self):
190
self._calls.append('_get_user_id')
191
return "Robert Collins <robert.collins@example.org>"
193
def _get_signature_checking(self):
194
self._calls.append('_get_signature_checking')
195
return self._signatures
198
bool_config = """[DEFAULT]
207
class TestConfigObj(tests.TestCase):
208
def test_get_bool(self):
209
co = config.ConfigObj(StringIO(bool_config))
210
self.assertIs(co.get_bool('DEFAULT', 'active'), True)
211
self.assertIs(co.get_bool('DEFAULT', 'inactive'), False)
212
self.assertIs(co.get_bool('UPPERCASE', 'active'), True)
213
self.assertIs(co.get_bool('UPPERCASE', 'nonactive'), False)
216
erroneous_config = """[section] # line 1
219
whocares=notme # line 4
223
class TestConfigObjErrors(tests.TestCase):
225
def test_duplicate_section_name_error_line(self):
227
co = configobj.ConfigObj(StringIO(erroneous_config),
229
except config.configobj.DuplicateError, e:
230
self.assertEqual(3, e.line_number)
232
self.fail('Error in config file not detected')
235
class TestConfig(tests.TestCase):
237
def test_constructs(self):
240
def test_no_default_editor(self):
241
self.assertRaises(NotImplementedError, config.Config().get_editor)
243
def test_user_email(self):
244
my_config = InstrumentedConfig()
245
self.assertEqual('robert.collins@example.org', my_config.user_email())
246
self.assertEqual(['_get_user_id'], my_config._calls)
248
def test_username(self):
249
my_config = InstrumentedConfig()
250
self.assertEqual('Robert Collins <robert.collins@example.org>',
251
my_config.username())
252
self.assertEqual(['_get_user_id'], my_config._calls)
254
def test_signatures_default(self):
255
my_config = config.Config()
256
self.assertFalse(my_config.signature_needed())
257
self.assertEqual(config.CHECK_IF_POSSIBLE,
258
my_config.signature_checking())
259
self.assertEqual(config.SIGN_WHEN_REQUIRED,
260
my_config.signing_policy())
262
def test_signatures_template_method(self):
263
my_config = InstrumentedConfig()
264
self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
265
self.assertEqual(['_get_signature_checking'], my_config._calls)
267
def test_signatures_template_method_none(self):
268
my_config = InstrumentedConfig()
269
my_config._signatures = None
270
self.assertEqual(config.CHECK_IF_POSSIBLE,
271
my_config.signature_checking())
272
self.assertEqual(['_get_signature_checking'], my_config._calls)
274
def test_gpg_signing_command_default(self):
275
my_config = config.Config()
276
self.assertEqual('gpg', my_config.gpg_signing_command())
278
def test_get_user_option_default(self):
279
my_config = config.Config()
280
self.assertEqual(None, my_config.get_user_option('no_option'))
282
def test_post_commit_default(self):
283
my_config = config.Config()
284
self.assertEqual(None, my_config.post_commit())
286
def test_log_format_default(self):
287
my_config = config.Config()
288
self.assertEqual('long', my_config.log_format())
291
class TestConfigPath(tests.TestCase):
294
super(TestConfigPath, self).setUp()
295
os.environ['HOME'] = '/home/bogus'
296
if sys.platform == 'win32':
297
os.environ['BZR_HOME'] = \
298
r'C:\Documents and Settings\bogus\Application Data'
300
'C:/Documents and Settings/bogus/Application Data/bazaar/2.0'
302
self.bzr_home = '/home/bogus/.bazaar'
304
def test_config_dir(self):
305
self.assertEqual(config.config_dir(), self.bzr_home)
307
def test_config_filename(self):
308
self.assertEqual(config.config_filename(),
309
self.bzr_home + '/bazaar.conf')
311
def test_branches_config_filename(self):
312
self.assertEqual(config.branches_config_filename(),
313
self.bzr_home + '/branches.conf')
315
def test_locations_config_filename(self):
316
self.assertEqual(config.locations_config_filename(),
317
self.bzr_home + '/locations.conf')
319
def test_authentication_config_filename(self):
320
self.assertEqual(config.authentication_config_filename(),
321
self.bzr_home + '/authentication.conf')
324
class TestIniConfig(tests.TestCase):
326
def test_contructs(self):
327
my_config = config.IniBasedConfig("nothing")
329
def test_from_fp(self):
330
config_file = StringIO(sample_config_text.encode('utf-8'))
331
my_config = config.IniBasedConfig(None)
333
isinstance(my_config._get_parser(file=config_file),
334
configobj.ConfigObj))
336
def test_cached(self):
337
config_file = StringIO(sample_config_text.encode('utf-8'))
338
my_config = config.IniBasedConfig(None)
339
parser = my_config._get_parser(file=config_file)
340
self.failUnless(my_config._get_parser() is parser)
343
class TestGetConfig(tests.TestCase):
345
def test_constructs(self):
346
my_config = config.GlobalConfig()
348
def test_calls_read_filenames(self):
349
# replace the class that is constructed, to check its parameters
350
oldparserclass = config.ConfigObj
351
config.ConfigObj = InstrumentedConfigObj
352
my_config = config.GlobalConfig()
354
parser = my_config._get_parser()
356
config.ConfigObj = oldparserclass
357
self.failUnless(isinstance(parser, InstrumentedConfigObj))
358
self.assertEqual(parser._calls, [('__init__', config.config_filename(),
362
class TestBranchConfig(tests.TestCaseWithTransport):
364
def test_constructs(self):
365
branch = FakeBranch()
366
my_config = config.BranchConfig(branch)
367
self.assertRaises(TypeError, config.BranchConfig)
369
def test_get_location_config(self):
370
branch = FakeBranch()
371
my_config = config.BranchConfig(branch)
372
location_config = my_config._get_location_config()
373
self.assertEqual(branch.base, location_config.location)
374
self.failUnless(location_config is my_config._get_location_config())
376
def test_get_config(self):
377
"""The Branch.get_config method works properly"""
378
b = bzrdir.BzrDir.create_standalone_workingtree('.').branch
379
my_config = b.get_config()
380
self.assertIs(my_config.get_user_option('wacky'), None)
381
my_config.set_user_option('wacky', 'unlikely')
382
self.assertEqual(my_config.get_user_option('wacky'), 'unlikely')
384
# Ensure we get the same thing if we start again
385
b2 = branch.Branch.open('.')
386
my_config2 = b2.get_config()
387
self.assertEqual(my_config2.get_user_option('wacky'), 'unlikely')
389
def test_has_explicit_nickname(self):
390
b = self.make_branch('.')
391
self.assertFalse(b.get_config().has_explicit_nickname())
393
self.assertTrue(b.get_config().has_explicit_nickname())
395
def test_config_url(self):
396
"""The Branch.get_config will use section that uses a local url"""
397
branch = self.make_branch('branch')
398
self.assertEqual('branch', branch.nick)
400
locations = config.locations_config_filename()
401
config.ensure_config_dir_exists()
402
local_url = urlutils.local_path_to_url('branch')
403
open(locations, 'wb').write('[%s]\nnickname = foobar'
405
self.assertEqual('foobar', branch.nick)
407
def test_config_local_path(self):
408
"""The Branch.get_config will use a local system path"""
409
branch = self.make_branch('branch')
410
self.assertEqual('branch', branch.nick)
412
locations = config.locations_config_filename()
413
config.ensure_config_dir_exists()
414
open(locations, 'wb').write('[%s/branch]\nnickname = barry'
415
% (osutils.getcwd().encode('utf8'),))
416
self.assertEqual('barry', branch.nick)
418
def test_config_creates_local(self):
419
"""Creating a new entry in config uses a local path."""
420
branch = self.make_branch('branch', format='knit')
421
branch.set_push_location('http://foobar')
422
locations = config.locations_config_filename()
423
local_path = osutils.getcwd().encode('utf8')
424
# Surprisingly ConfigObj doesn't create a trailing newline
425
self.check_file_contents(locations,
427
'push_location = http://foobar\n'
428
'push_location:policy = norecurse'
431
def test_autonick_urlencoded(self):
432
b = self.make_branch('!repo')
433
self.assertEqual('!repo', b.get_config().get_nickname())
435
def test_warn_if_masked(self):
436
_warning = trace.warning
439
warnings.append(args[0] % args[1:])
441
def set_option(store, warn_masked=True):
443
conf.set_user_option('example_option', repr(store), store=store,
444
warn_masked=warn_masked)
445
def assertWarning(warning):
447
self.assertEqual(0, len(warnings))
449
self.assertEqual(1, len(warnings))
450
self.assertEqual(warning, warnings[0])
451
trace.warning = warning
453
branch = self.make_branch('.')
454
conf = branch.get_config()
455
set_option(config.STORE_GLOBAL)
457
set_option(config.STORE_BRANCH)
459
set_option(config.STORE_GLOBAL)
460
assertWarning('Value "4" is masked by "3" from branch.conf')
461
set_option(config.STORE_GLOBAL, warn_masked=False)
463
set_option(config.STORE_LOCATION)
465
set_option(config.STORE_BRANCH)
466
assertWarning('Value "3" is masked by "0" from locations.conf')
467
set_option(config.STORE_BRANCH, warn_masked=False)
470
trace.warning = _warning
473
class TestGlobalConfigItems(tests.TestCase):
475
def test_user_id(self):
476
config_file = StringIO(sample_config_text.encode('utf-8'))
477
my_config = config.GlobalConfig()
478
my_config._parser = my_config._get_parser(file=config_file)
479
self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
480
my_config._get_user_id())
482
def test_absent_user_id(self):
483
config_file = StringIO("")
484
my_config = config.GlobalConfig()
485
my_config._parser = my_config._get_parser(file=config_file)
486
self.assertEqual(None, my_config._get_user_id())
488
def test_configured_editor(self):
489
config_file = StringIO(sample_config_text.encode('utf-8'))
490
my_config = config.GlobalConfig()
491
my_config._parser = my_config._get_parser(file=config_file)
492
self.assertEqual("vim", my_config.get_editor())
494
def test_signatures_always(self):
495
config_file = StringIO(sample_always_signatures)
496
my_config = config.GlobalConfig()
497
my_config._parser = my_config._get_parser(file=config_file)
498
self.assertEqual(config.CHECK_NEVER,
499
my_config.signature_checking())
500
self.assertEqual(config.SIGN_ALWAYS,
501
my_config.signing_policy())
502
self.assertEqual(True, my_config.signature_needed())
504
def test_signatures_if_possible(self):
505
config_file = StringIO(sample_maybe_signatures)
506
my_config = config.GlobalConfig()
507
my_config._parser = my_config._get_parser(file=config_file)
508
self.assertEqual(config.CHECK_NEVER,
509
my_config.signature_checking())
510
self.assertEqual(config.SIGN_WHEN_REQUIRED,
511
my_config.signing_policy())
512
self.assertEqual(False, my_config.signature_needed())
514
def test_signatures_ignore(self):
515
config_file = StringIO(sample_ignore_signatures)
516
my_config = config.GlobalConfig()
517
my_config._parser = my_config._get_parser(file=config_file)
518
self.assertEqual(config.CHECK_ALWAYS,
519
my_config.signature_checking())
520
self.assertEqual(config.SIGN_NEVER,
521
my_config.signing_policy())
522
self.assertEqual(False, my_config.signature_needed())
524
def _get_sample_config(self):
525
config_file = StringIO(sample_config_text.encode('utf-8'))
526
my_config = config.GlobalConfig()
527
my_config._parser = my_config._get_parser(file=config_file)
530
def test_gpg_signing_command(self):
531
my_config = self._get_sample_config()
532
self.assertEqual("gnome-gpg", my_config.gpg_signing_command())
533
self.assertEqual(False, my_config.signature_needed())
535
def _get_empty_config(self):
536
config_file = StringIO("")
537
my_config = config.GlobalConfig()
538
my_config._parser = my_config._get_parser(file=config_file)
541
def test_gpg_signing_command_unset(self):
542
my_config = self._get_empty_config()
543
self.assertEqual("gpg", my_config.gpg_signing_command())
545
def test_get_user_option_default(self):
546
my_config = self._get_empty_config()
547
self.assertEqual(None, my_config.get_user_option('no_option'))
549
def test_get_user_option_global(self):
550
my_config = self._get_sample_config()
551
self.assertEqual("something",
552
my_config.get_user_option('user_global_option'))
554
def test_post_commit_default(self):
555
my_config = self._get_sample_config()
556
self.assertEqual(None, my_config.post_commit())
558
def test_configured_logformat(self):
559
my_config = self._get_sample_config()
560
self.assertEqual("short", my_config.log_format())
562
def test_get_alias(self):
563
my_config = self._get_sample_config()
564
self.assertEqual('help', my_config.get_alias('h'))
566
def test_get_no_alias(self):
567
my_config = self._get_sample_config()
568
self.assertEqual(None, my_config.get_alias('foo'))
570
def test_get_long_alias(self):
571
my_config = self._get_sample_config()
572
self.assertEqual(sample_long_alias, my_config.get_alias('ll'))
575
class TestLocationConfig(tests.TestCaseInTempDir):
577
def test_constructs(self):
578
my_config = config.LocationConfig('http://example.com')
579
self.assertRaises(TypeError, config.LocationConfig)
581
def test_branch_calls_read_filenames(self):
582
# This is testing the correct file names are provided.
583
# TODO: consolidate with the test for GlobalConfigs filename checks.
585
# replace the class that is constructed, to check its parameters
586
oldparserclass = config.ConfigObj
587
config.ConfigObj = InstrumentedConfigObj
589
my_config = config.LocationConfig('http://www.example.com')
590
parser = my_config._get_parser()
592
config.ConfigObj = oldparserclass
593
self.failUnless(isinstance(parser, InstrumentedConfigObj))
594
self.assertEqual(parser._calls,
595
[('__init__', config.locations_config_filename(),
597
config.ensure_config_dir_exists()
598
#os.mkdir(config.config_dir())
599
f = file(config.branches_config_filename(), 'wb')
602
oldparserclass = config.ConfigObj
603
config.ConfigObj = InstrumentedConfigObj
605
my_config = config.LocationConfig('http://www.example.com')
606
parser = my_config._get_parser()
608
config.ConfigObj = oldparserclass
610
def test_get_global_config(self):
611
my_config = config.BranchConfig(FakeBranch('http://example.com'))
612
global_config = my_config._get_global_config()
613
self.failUnless(isinstance(global_config, config.GlobalConfig))
614
self.failUnless(global_config is my_config._get_global_config())
616
def test__get_matching_sections_no_match(self):
617
self.get_branch_config('/')
618
self.assertEqual([], self.my_location_config._get_matching_sections())
620
def test__get_matching_sections_exact(self):
621
self.get_branch_config('http://www.example.com')
622
self.assertEqual([('http://www.example.com', '')],
623
self.my_location_config._get_matching_sections())
625
def test__get_matching_sections_suffix_does_not(self):
626
self.get_branch_config('http://www.example.com-com')
627
self.assertEqual([], self.my_location_config._get_matching_sections())
629
def test__get_matching_sections_subdir_recursive(self):
630
self.get_branch_config('http://www.example.com/com')
631
self.assertEqual([('http://www.example.com', 'com')],
632
self.my_location_config._get_matching_sections())
634
def test__get_matching_sections_ignoreparent(self):
635
self.get_branch_config('http://www.example.com/ignoreparent')
636
self.assertEqual([('http://www.example.com/ignoreparent', '')],
637
self.my_location_config._get_matching_sections())
639
def test__get_matching_sections_ignoreparent_subdir(self):
640
self.get_branch_config(
641
'http://www.example.com/ignoreparent/childbranch')
642
self.assertEqual([('http://www.example.com/ignoreparent',
644
self.my_location_config._get_matching_sections())
646
def test__get_matching_sections_subdir_trailing_slash(self):
647
self.get_branch_config('/b')
648
self.assertEqual([('/b/', '')],
649
self.my_location_config._get_matching_sections())
651
def test__get_matching_sections_subdir_child(self):
652
self.get_branch_config('/a/foo')
653
self.assertEqual([('/a/*', ''), ('/a/', 'foo')],
654
self.my_location_config._get_matching_sections())
656
def test__get_matching_sections_subdir_child_child(self):
657
self.get_branch_config('/a/foo/bar')
658
self.assertEqual([('/a/*', 'bar'), ('/a/', 'foo/bar')],
659
self.my_location_config._get_matching_sections())
661
def test__get_matching_sections_trailing_slash_with_children(self):
662
self.get_branch_config('/a/')
663
self.assertEqual([('/a/', '')],
664
self.my_location_config._get_matching_sections())
666
def test__get_matching_sections_explicit_over_glob(self):
667
# XXX: 2006-09-08 jamesh
668
# This test only passes because ord('c') > ord('*'). If there
669
# was a config section for '/a/?', it would get precedence
671
self.get_branch_config('/a/c')
672
self.assertEqual([('/a/c', ''), ('/a/*', ''), ('/a/', 'c')],
673
self.my_location_config._get_matching_sections())
675
def test__get_option_policy_normal(self):
676
self.get_branch_config('http://www.example.com')
678
self.my_location_config._get_config_policy(
679
'http://www.example.com', 'normal_option'),
682
def test__get_option_policy_norecurse(self):
683
self.get_branch_config('http://www.example.com')
685
self.my_location_config._get_option_policy(
686
'http://www.example.com', 'norecurse_option'),
687
config.POLICY_NORECURSE)
688
# Test old recurse=False setting:
690
self.my_location_config._get_option_policy(
691
'http://www.example.com/norecurse', 'normal_option'),
692
config.POLICY_NORECURSE)
694
def test__get_option_policy_normal(self):
695
self.get_branch_config('http://www.example.com')
697
self.my_location_config._get_option_policy(
698
'http://www.example.com', 'appendpath_option'),
699
config.POLICY_APPENDPATH)
701
def test_location_without_username(self):
702
self.get_branch_config('http://www.example.com/ignoreparent')
703
self.assertEqual(u'Erik B\u00e5gfors <erik@bagfors.nu>',
704
self.my_config.username())
706
def test_location_not_listed(self):
707
"""Test that the global username is used when no location matches"""
708
self.get_branch_config('/home/robertc/sources')
709
self.assertEqual(u'Erik B\u00e5gfors <erik@bagfors.nu>',
710
self.my_config.username())
712
def test_overriding_location(self):
713
self.get_branch_config('http://www.example.com/foo')
714
self.assertEqual('Robert Collins <robertc@example.org>',
715
self.my_config.username())
717
def test_signatures_not_set(self):
718
self.get_branch_config('http://www.example.com',
719
global_config=sample_ignore_signatures)
720
self.assertEqual(config.CHECK_ALWAYS,
721
self.my_config.signature_checking())
722
self.assertEqual(config.SIGN_NEVER,
723
self.my_config.signing_policy())
725
def test_signatures_never(self):
726
self.get_branch_config('/a/c')
727
self.assertEqual(config.CHECK_NEVER,
728
self.my_config.signature_checking())
730
def test_signatures_when_available(self):
731
self.get_branch_config('/a/', global_config=sample_ignore_signatures)
732
self.assertEqual(config.CHECK_IF_POSSIBLE,
733
self.my_config.signature_checking())
735
def test_signatures_always(self):
736
self.get_branch_config('/b')
737
self.assertEqual(config.CHECK_ALWAYS,
738
self.my_config.signature_checking())
740
def test_gpg_signing_command(self):
741
self.get_branch_config('/b')
742
self.assertEqual("gnome-gpg", self.my_config.gpg_signing_command())
744
def test_gpg_signing_command_missing(self):
745
self.get_branch_config('/a')
746
self.assertEqual("false", self.my_config.gpg_signing_command())
748
def test_get_user_option_global(self):
749
self.get_branch_config('/a')
750
self.assertEqual('something',
751
self.my_config.get_user_option('user_global_option'))
753
def test_get_user_option_local(self):
754
self.get_branch_config('/a')
755
self.assertEqual('local',
756
self.my_config.get_user_option('user_local_option'))
758
def test_get_user_option_appendpath(self):
759
# returned as is for the base path:
760
self.get_branch_config('http://www.example.com')
761
self.assertEqual('append',
762
self.my_config.get_user_option('appendpath_option'))
763
# Extra path components get appended:
764
self.get_branch_config('http://www.example.com/a/b/c')
765
self.assertEqual('append/a/b/c',
766
self.my_config.get_user_option('appendpath_option'))
767
# Overriden for http://www.example.com/dir, where it is a
769
self.get_branch_config('http://www.example.com/dir/a/b/c')
770
self.assertEqual('normal',
771
self.my_config.get_user_option('appendpath_option'))
773
def test_get_user_option_norecurse(self):
774
self.get_branch_config('http://www.example.com')
775
self.assertEqual('norecurse',
776
self.my_config.get_user_option('norecurse_option'))
777
self.get_branch_config('http://www.example.com/dir')
778
self.assertEqual(None,
779
self.my_config.get_user_option('norecurse_option'))
780
# http://www.example.com/norecurse is a recurse=False section
781
# that redefines normal_option. Subdirectories do not pick up
783
self.get_branch_config('http://www.example.com/norecurse')
784
self.assertEqual('norecurse',
785
self.my_config.get_user_option('normal_option'))
786
self.get_branch_config('http://www.example.com/norecurse/subdir')
787
self.assertEqual('normal',
788
self.my_config.get_user_option('normal_option'))
790
def test_set_user_option_norecurse(self):
791
self.get_branch_config('http://www.example.com')
792
self.my_config.set_user_option('foo', 'bar',
793
store=config.STORE_LOCATION_NORECURSE)
795
self.my_location_config._get_option_policy(
796
'http://www.example.com', 'foo'),
797
config.POLICY_NORECURSE)
799
def test_set_user_option_appendpath(self):
800
self.get_branch_config('http://www.example.com')
801
self.my_config.set_user_option('foo', 'bar',
802
store=config.STORE_LOCATION_APPENDPATH)
804
self.my_location_config._get_option_policy(
805
'http://www.example.com', 'foo'),
806
config.POLICY_APPENDPATH)
808
def test_set_user_option_change_policy(self):
809
self.get_branch_config('http://www.example.com')
810
self.my_config.set_user_option('norecurse_option', 'normal',
811
store=config.STORE_LOCATION)
813
self.my_location_config._get_option_policy(
814
'http://www.example.com', 'norecurse_option'),
817
def test_set_user_option_recurse_false_section(self):
818
# The following section has recurse=False set. The test is to
819
# make sure that a normal option can be added to the section,
820
# converting recurse=False to the norecurse policy.
821
self.get_branch_config('http://www.example.com/norecurse')
822
self.callDeprecated(['The recurse option is deprecated as of 0.14. '
823
'The section "http://www.example.com/norecurse" '
824
'has been converted to use policies.'],
825
self.my_config.set_user_option,
826
'foo', 'bar', store=config.STORE_LOCATION)
828
self.my_location_config._get_option_policy(
829
'http://www.example.com/norecurse', 'foo'),
831
# The previously existing option is still norecurse:
833
self.my_location_config._get_option_policy(
834
'http://www.example.com/norecurse', 'normal_option'),
835
config.POLICY_NORECURSE)
837
def test_post_commit_default(self):
838
self.get_branch_config('/a/c')
839
self.assertEqual('bzrlib.tests.test_config.post_commit',
840
self.my_config.post_commit())
842
def get_branch_config(self, location, global_config=None):
843
if global_config is None:
844
global_file = StringIO(sample_config_text.encode('utf-8'))
846
global_file = StringIO(global_config.encode('utf-8'))
847
branches_file = StringIO(sample_branches_text.encode('utf-8'))
848
self.my_config = config.BranchConfig(FakeBranch(location))
849
# Force location config to use specified file
850
self.my_location_config = self.my_config._get_location_config()
851
self.my_location_config._get_parser(branches_file)
852
# Force global config to use specified file
853
self.my_config._get_global_config()._get_parser(global_file)
855
def test_set_user_setting_sets_and_saves(self):
856
self.get_branch_config('/a/c')
857
record = InstrumentedConfigObj("foo")
858
self.my_location_config._parser = record
860
real_mkdir = os.mkdir
862
def checked_mkdir(path, mode=0777):
863
self.log('making directory: %s', path)
864
real_mkdir(path, mode)
867
os.mkdir = checked_mkdir
869
self.callDeprecated(['The recurse option is deprecated as of '
870
'0.14. The section "/a/c" has been '
871
'converted to use policies.'],
872
self.my_config.set_user_option,
873
'foo', 'bar', store=config.STORE_LOCATION)
875
os.mkdir = real_mkdir
877
self.failUnless(self.created, 'Failed to create ~/.bazaar')
878
self.assertEqual([('__contains__', '/a/c'),
879
('__contains__', '/a/c/'),
880
('__setitem__', '/a/c', {}),
881
('__getitem__', '/a/c'),
882
('__setitem__', 'foo', 'bar'),
883
('__getitem__', '/a/c'),
884
('as_bool', 'recurse'),
885
('__getitem__', '/a/c'),
886
('__delitem__', 'recurse'),
887
('__getitem__', '/a/c'),
889
('__getitem__', '/a/c'),
890
('__contains__', 'foo:policy'),
894
def test_set_user_setting_sets_and_saves2(self):
895
self.get_branch_config('/a/c')
896
self.assertIs(self.my_config.get_user_option('foo'), None)
897
self.my_config.set_user_option('foo', 'bar')
899
self.my_config.branch.control_files.files['branch.conf'],
901
self.assertEqual(self.my_config.get_user_option('foo'), 'bar')
902
self.my_config.set_user_option('foo', 'baz',
903
store=config.STORE_LOCATION)
904
self.assertEqual(self.my_config.get_user_option('foo'), 'baz')
905
self.my_config.set_user_option('foo', 'qux')
906
self.assertEqual(self.my_config.get_user_option('foo'), 'baz')
908
def test_get_bzr_remote_path(self):
909
my_config = config.LocationConfig('/a/c')
910
self.assertEqual('bzr', my_config.get_bzr_remote_path())
911
my_config.set_user_option('bzr_remote_path', '/path-bzr')
912
self.assertEqual('/path-bzr', my_config.get_bzr_remote_path())
913
os.environ['BZR_REMOTE_PATH'] = '/environ-bzr'
914
self.assertEqual('/environ-bzr', my_config.get_bzr_remote_path())
917
precedence_global = 'option = global'
918
precedence_branch = 'option = branch'
919
precedence_location = """
923
[http://example.com/specific]
928
class TestBranchConfigItems(tests.TestCaseInTempDir):
930
def get_branch_config(self, global_config=None, location=None,
931
location_config=None, branch_data_config=None):
932
my_config = config.BranchConfig(FakeBranch(location))
933
if global_config is not None:
934
global_file = StringIO(global_config.encode('utf-8'))
935
my_config._get_global_config()._get_parser(global_file)
936
self.my_location_config = my_config._get_location_config()
937
if location_config is not None:
938
location_file = StringIO(location_config.encode('utf-8'))
939
self.my_location_config._get_parser(location_file)
940
if branch_data_config is not None:
941
my_config.branch.control_files.files['branch.conf'] = \
945
def test_user_id(self):
946
branch = FakeBranch(user_id='Robert Collins <robertc@example.net>')
947
my_config = config.BranchConfig(branch)
948
self.assertEqual("Robert Collins <robertc@example.net>",
949
my_config.username())
950
branch.control_files.email = "John"
951
my_config.set_user_option('email',
952
"Robert Collins <robertc@example.org>")
953
self.assertEqual("John", my_config.username())
954
branch.control_files.email = None
955
self.assertEqual("Robert Collins <robertc@example.org>",
956
my_config.username())
958
def test_not_set_in_branch(self):
959
my_config = self.get_branch_config(sample_config_text)
960
my_config.branch.control_files.email = None
961
self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
962
my_config._get_user_id())
963
my_config.branch.control_files.email = "John"
964
self.assertEqual("John", my_config._get_user_id())
966
def test_BZR_EMAIL_OVERRIDES(self):
967
os.environ['BZR_EMAIL'] = "Robert Collins <robertc@example.org>"
968
branch = FakeBranch()
969
my_config = config.BranchConfig(branch)
970
self.assertEqual("Robert Collins <robertc@example.org>",
971
my_config.username())
973
def test_signatures_forced(self):
974
my_config = self.get_branch_config(
975
global_config=sample_always_signatures)
976
self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
977
self.assertEqual(config.SIGN_ALWAYS, my_config.signing_policy())
978
self.assertTrue(my_config.signature_needed())
980
def test_signatures_forced_branch(self):
981
my_config = self.get_branch_config(
982
global_config=sample_ignore_signatures,
983
branch_data_config=sample_always_signatures)
984
self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
985
self.assertEqual(config.SIGN_ALWAYS, my_config.signing_policy())
986
self.assertTrue(my_config.signature_needed())
988
def test_gpg_signing_command(self):
989
my_config = self.get_branch_config(
990
# branch data cannot set gpg_signing_command
991
branch_data_config="gpg_signing_command=pgp")
992
config_file = StringIO(sample_config_text.encode('utf-8'))
993
my_config._get_global_config()._get_parser(config_file)
994
self.assertEqual('gnome-gpg', my_config.gpg_signing_command())
996
def test_get_user_option_global(self):
997
branch = FakeBranch()
998
my_config = config.BranchConfig(branch)
999
config_file = StringIO(sample_config_text.encode('utf-8'))
1000
(my_config._get_global_config()._get_parser(config_file))
1001
self.assertEqual('something',
1002
my_config.get_user_option('user_global_option'))
1004
def test_post_commit_default(self):
1005
branch = FakeBranch()
1006
my_config = self.get_branch_config(sample_config_text, '/a/c',
1007
sample_branches_text)
1008
self.assertEqual(my_config.branch.base, '/a/c')
1009
self.assertEqual('bzrlib.tests.test_config.post_commit',
1010
my_config.post_commit())
1011
my_config.set_user_option('post_commit', 'rmtree_root')
1012
# post-commit is ignored when bresent in branch data
1013
self.assertEqual('bzrlib.tests.test_config.post_commit',
1014
my_config.post_commit())
1015
my_config.set_user_option('post_commit', 'rmtree_root',
1016
store=config.STORE_LOCATION)
1017
self.assertEqual('rmtree_root', my_config.post_commit())
1019
def test_config_precedence(self):
1020
my_config = self.get_branch_config(global_config=precedence_global)
1021
self.assertEqual(my_config.get_user_option('option'), 'global')
1022
my_config = self.get_branch_config(global_config=precedence_global,
1023
branch_data_config=precedence_branch)
1024
self.assertEqual(my_config.get_user_option('option'), 'branch')
1025
my_config = self.get_branch_config(global_config=precedence_global,
1026
branch_data_config=precedence_branch,
1027
location_config=precedence_location)
1028
self.assertEqual(my_config.get_user_option('option'), 'recurse')
1029
my_config = self.get_branch_config(global_config=precedence_global,
1030
branch_data_config=precedence_branch,
1031
location_config=precedence_location,
1032
location='http://example.com/specific')
1033
self.assertEqual(my_config.get_user_option('option'), 'exact')
1035
def test_get_mail_client(self):
1036
config = self.get_branch_config()
1037
client = config.get_mail_client()
1038
self.assertIsInstance(client, mail_client.DefaultMail)
1041
config.set_user_option('mail_client', 'evolution')
1042
client = config.get_mail_client()
1043
self.assertIsInstance(client, mail_client.Evolution)
1045
config.set_user_option('mail_client', 'kmail')
1046
client = config.get_mail_client()
1047
self.assertIsInstance(client, mail_client.KMail)
1049
config.set_user_option('mail_client', 'mutt')
1050
client = config.get_mail_client()
1051
self.assertIsInstance(client, mail_client.Mutt)
1053
config.set_user_option('mail_client', 'thunderbird')
1054
client = config.get_mail_client()
1055
self.assertIsInstance(client, mail_client.Thunderbird)
1058
config.set_user_option('mail_client', 'default')
1059
client = config.get_mail_client()
1060
self.assertIsInstance(client, mail_client.DefaultMail)
1062
config.set_user_option('mail_client', 'editor')
1063
client = config.get_mail_client()
1064
self.assertIsInstance(client, mail_client.Editor)
1066
config.set_user_option('mail_client', 'mapi')
1067
client = config.get_mail_client()
1068
self.assertIsInstance(client, mail_client.MAPIClient)
1070
config.set_user_option('mail_client', 'xdg-email')
1071
client = config.get_mail_client()
1072
self.assertIsInstance(client, mail_client.XDGEmail)
1074
config.set_user_option('mail_client', 'firebird')
1075
self.assertRaises(errors.UnknownMailClient, config.get_mail_client)
1078
class TestMailAddressExtraction(tests.TestCase):
1080
def test_extract_email_address(self):
1081
self.assertEqual('jane@test.com',
1082
config.extract_email_address('Jane <jane@test.com>'))
1083
self.assertRaises(errors.NoEmailInUsername,
1084
config.extract_email_address, 'Jane Tester')
1086
def test_parse_username(self):
1087
self.assertEqual(('', 'jdoe@example.com'),
1088
config.parse_username('jdoe@example.com'))
1089
self.assertEqual(('', 'jdoe@example.com'),
1090
config.parse_username('<jdoe@example.com>'))
1091
self.assertEqual(('John Doe', 'jdoe@example.com'),
1092
config.parse_username('John Doe <jdoe@example.com>'))
1093
self.assertEqual(('John Doe', ''),
1094
config.parse_username('John Doe'))
1095
self.assertEqual(('John Doe', 'jdoe@example.com'),
1096
config.parse_username('John Doe jdoe@example.com'))
1098
class TestTreeConfig(tests.TestCaseWithTransport):
1100
def test_get_value(self):
1101
"""Test that retreiving a value from a section is possible"""
1102
branch = self.make_branch('.')
1103
tree_config = config.TreeConfig(branch)
1104
tree_config.set_option('value', 'key', 'SECTION')
1105
tree_config.set_option('value2', 'key2')
1106
tree_config.set_option('value3-top', 'key3')
1107
tree_config.set_option('value3-section', 'key3', 'SECTION')
1108
value = tree_config.get_option('key', 'SECTION')
1109
self.assertEqual(value, 'value')
1110
value = tree_config.get_option('key2')
1111
self.assertEqual(value, 'value2')
1112
self.assertEqual(tree_config.get_option('non-existant'), None)
1113
value = tree_config.get_option('non-existant', 'SECTION')
1114
self.assertEqual(value, None)
1115
value = tree_config.get_option('non-existant', default='default')
1116
self.assertEqual(value, 'default')
1117
self.assertEqual(tree_config.get_option('key2', 'NOSECTION'), None)
1118
value = tree_config.get_option('key2', 'NOSECTION', default='default')
1119
self.assertEqual(value, 'default')
1120
value = tree_config.get_option('key3')
1121
self.assertEqual(value, 'value3-top')
1122
value = tree_config.get_option('key3', 'SECTION')
1123
self.assertEqual(value, 'value3-section')
1126
class TestAuthenticationConfigFile(tests.TestCase):
1127
"""Test the authentication.conf file matching"""
1129
def _got_user_passwd(self, expected_user, expected_password,
1130
config, *args, **kwargs):
1131
credentials = config.get_credentials(*args, **kwargs)
1132
if credentials is None:
1136
user = credentials['user']
1137
password = credentials['password']
1138
self.assertEquals(expected_user, user)
1139
self.assertEquals(expected_password, password)
1141
def test_empty_config(self):
1142
conf = config.AuthenticationConfig(_file=StringIO())
1143
self.assertEquals({}, conf._get_config())
1144
self._got_user_passwd(None, None, conf, 'http', 'foo.net')
1146
def test_broken_config(self):
1147
conf = config.AuthenticationConfig(_file=StringIO('[DEF'))
1148
self.assertRaises(errors.ParseConfigError, conf._get_config)
1150
conf = config.AuthenticationConfig(_file=StringIO(
1154
verify_certificates=askme # Error: Not a boolean
1156
self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
1157
conf = config.AuthenticationConfig(_file=StringIO(
1161
port=port # Error: Not an int
1163
self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
1165
def test_credentials_for_scheme_host(self):
1166
conf = config.AuthenticationConfig(_file=StringIO(
1167
"""# Identity on foo.net
1172
password=secret-pass
1175
self._got_user_passwd('joe', 'secret-pass', conf, 'ftp', 'foo.net')
1177
self._got_user_passwd(None, None, conf, 'http', 'foo.net')
1179
self._got_user_passwd(None, None, conf, 'ftp', 'bar.net')
1181
def test_credentials_for_host_port(self):
1182
conf = config.AuthenticationConfig(_file=StringIO(
1183
"""# Identity on foo.net
1189
password=secret-pass
1192
self._got_user_passwd('joe', 'secret-pass',
1193
conf, 'ftp', 'foo.net', port=10021)
1195
self._got_user_passwd(None, None, conf, 'ftp', 'foo.net')
1197
def test_for_matching_host(self):
1198
conf = config.AuthenticationConfig(_file=StringIO(
1199
"""# Identity on foo.net
1205
[sourceforge domain]
1212
self._got_user_passwd('georges', 'bendover',
1213
conf, 'bzr', 'foo.bzr.sf.net')
1215
self._got_user_passwd(None, None,
1216
conf, 'bzr', 'bbzr.sf.net')
1218
def test_for_matching_host_None(self):
1219
conf = config.AuthenticationConfig(_file=StringIO(
1220
"""# Identity on foo.net
1230
self._got_user_passwd('joe', 'joepass',
1231
conf, 'bzr', 'quux.net')
1232
# no host but different scheme
1233
self._got_user_passwd('georges', 'bendover',
1234
conf, 'ftp', 'quux.net')
1236
def test_credentials_for_path(self):
1237
conf = config.AuthenticationConfig(_file=StringIO(
1253
self._got_user_passwd(None, None,
1254
conf, 'http', host='bar.org', path='/dir3')
1256
self._got_user_passwd('georges', 'bendover',
1257
conf, 'http', host='bar.org', path='/dir2')
1259
self._got_user_passwd('jim', 'jimpass',
1260
conf, 'http', host='bar.org',path='/dir1/subdir')
1262
def test_credentials_for_user(self):
1263
conf = config.AuthenticationConfig(_file=StringIO(
1272
self._got_user_passwd('jim', 'jimpass',
1273
conf, 'http', 'bar.org')
1275
self._got_user_passwd('jim', 'jimpass',
1276
conf, 'http', 'bar.org', user='jim')
1277
# Don't get a different user if one is specified
1278
self._got_user_passwd(None, None,
1279
conf, 'http', 'bar.org', user='georges')
1281
def test_verify_certificates(self):
1282
conf = config.AuthenticationConfig(_file=StringIO(
1289
verify_certificates=False
1296
credentials = conf.get_credentials('https', 'bar.org')
1297
self.assertEquals(False, credentials.get('verify_certificates'))
1298
credentials = conf.get_credentials('https', 'foo.net')
1299
self.assertEquals(True, credentials.get('verify_certificates'))
1302
class TestAuthenticationConfig(tests.TestCase):
1303
"""Test AuthenticationConfig behaviour"""
1305
def _check_default_prompt(self, expected_prompt_format, scheme,
1306
host=None, port=None, realm=None, path=None):
1309
user, password = 'jim', 'precious'
1310
expected_prompt = expected_prompt_format % {
1311
'scheme': scheme, 'host': host, 'port': port,
1312
'user': user, 'realm': realm}
1314
stdout = tests.StringIOWrapper()
1315
ui.ui_factory = tests.TestUIFactory(stdin=password + '\n',
1317
# We use an empty conf so that the user is always prompted
1318
conf = config.AuthenticationConfig()
1319
self.assertEquals(password,
1320
conf.get_password(scheme, host, user, port=port,
1321
realm=realm, path=path))
1322
self.assertEquals(stdout.getvalue(), expected_prompt)
1324
def test_default_prompts(self):
1325
# HTTP prompts can't be tested here, see test_http.py
1326
self._check_default_prompt('FTP %(user)s@%(host)s password: ', 'ftp')
1327
self._check_default_prompt('FTP %(user)s@%(host)s:%(port)d password: ',
1330
self._check_default_prompt('SSH %(user)s@%(host)s:%(port)d password: ',
1332
# SMTP port handling is a bit special (it's handled if embedded in the
1334
# FIXME: should we: forbid that, extend it to other schemes, leave
1335
# things as they are that's fine thank you ?
1336
self._check_default_prompt('SMTP %(user)s@%(host)s password: ',
1338
self._check_default_prompt('SMTP %(user)s@%(host)s password: ',
1339
'smtp', host='bar.org:10025')
1340
self._check_default_prompt(
1341
'SMTP %(user)s@%(host)s:%(port)d password: ',
1345
# FIXME: Once we have a way to declare authentication to all test servers, we
1346
# can implement generic tests.
1347
# test_user_password_in_url
1348
# test_user_in_url_password_from_config
1349
# test_user_in_url_password_prompted
1350
# test_user_in_config
1351
# test_user_getpass.getuser
1352
# test_user_prompted ?
1353
class TestAuthenticationRing(tests.TestCaseWithTransport):
added
removed
bzrlib/tests/test_config.py
