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):
209
def test_get_bool(self):
210
co = config.ConfigObj(StringIO(bool_config))
211
self.assertIs(co.get_bool('DEFAULT', 'active'), True)
212
self.assertIs(co.get_bool('DEFAULT', 'inactive'), False)
213
self.assertIs(co.get_bool('UPPERCASE', 'active'), True)
214
self.assertIs(co.get_bool('UPPERCASE', 'nonactive'), False)
216
def test_hash_sign_in_value(self):
218
Before 4.5.0, ConfigObj did not quote # signs in values, so they'd be
219
treated as comments when read in again. (#86838)
221
co = config.ConfigObj()
222
co['test'] = 'foo#bar'
224
self.assertEqual(lines, ['test = "foo#bar"'])
225
co2 = config.ConfigObj(lines)
226
self.assertEqual(co2['test'], 'foo#bar')
229
erroneous_config = """[section] # line 1
232
whocares=notme # line 4
236
class TestConfigObjErrors(tests.TestCase):
238
def test_duplicate_section_name_error_line(self):
240
co = configobj.ConfigObj(StringIO(erroneous_config),
242
except config.configobj.DuplicateError, e:
243
self.assertEqual(3, e.line_number)
245
self.fail('Error in config file not detected')
248
class TestConfig(tests.TestCase):
250
def test_constructs(self):
253
def test_no_default_editor(self):
254
self.assertRaises(NotImplementedError, config.Config().get_editor)
256
def test_user_email(self):
257
my_config = InstrumentedConfig()
258
self.assertEqual('robert.collins@example.org', my_config.user_email())
259
self.assertEqual(['_get_user_id'], my_config._calls)
261
def test_username(self):
262
my_config = InstrumentedConfig()
263
self.assertEqual('Robert Collins <robert.collins@example.org>',
264
my_config.username())
265
self.assertEqual(['_get_user_id'], my_config._calls)
267
def test_signatures_default(self):
268
my_config = config.Config()
269
self.assertFalse(my_config.signature_needed())
270
self.assertEqual(config.CHECK_IF_POSSIBLE,
271
my_config.signature_checking())
272
self.assertEqual(config.SIGN_WHEN_REQUIRED,
273
my_config.signing_policy())
275
def test_signatures_template_method(self):
276
my_config = InstrumentedConfig()
277
self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
278
self.assertEqual(['_get_signature_checking'], my_config._calls)
280
def test_signatures_template_method_none(self):
281
my_config = InstrumentedConfig()
282
my_config._signatures = None
283
self.assertEqual(config.CHECK_IF_POSSIBLE,
284
my_config.signature_checking())
285
self.assertEqual(['_get_signature_checking'], my_config._calls)
287
def test_gpg_signing_command_default(self):
288
my_config = config.Config()
289
self.assertEqual('gpg', my_config.gpg_signing_command())
291
def test_get_user_option_default(self):
292
my_config = config.Config()
293
self.assertEqual(None, my_config.get_user_option('no_option'))
295
def test_post_commit_default(self):
296
my_config = config.Config()
297
self.assertEqual(None, my_config.post_commit())
299
def test_log_format_default(self):
300
my_config = config.Config()
301
self.assertEqual('long', my_config.log_format())
304
class TestConfigPath(tests.TestCase):
307
super(TestConfigPath, self).setUp()
308
os.environ['HOME'] = '/home/bogus'
309
if sys.platform == 'win32':
310
os.environ['BZR_HOME'] = \
311
r'C:\Documents and Settings\bogus\Application Data'
313
'C:/Documents and Settings/bogus/Application Data/bazaar/2.0'
315
self.bzr_home = '/home/bogus/.bazaar'
317
def test_config_dir(self):
318
self.assertEqual(config.config_dir(), self.bzr_home)
320
def test_config_filename(self):
321
self.assertEqual(config.config_filename(),
322
self.bzr_home + '/bazaar.conf')
324
def test_branches_config_filename(self):
325
self.assertEqual(config.branches_config_filename(),
326
self.bzr_home + '/branches.conf')
328
def test_locations_config_filename(self):
329
self.assertEqual(config.locations_config_filename(),
330
self.bzr_home + '/locations.conf')
332
def test_authentication_config_filename(self):
333
self.assertEqual(config.authentication_config_filename(),
334
self.bzr_home + '/authentication.conf')
337
class TestIniConfig(tests.TestCase):
339
def test_contructs(self):
340
my_config = config.IniBasedConfig("nothing")
342
def test_from_fp(self):
343
config_file = StringIO(sample_config_text.encode('utf-8'))
344
my_config = config.IniBasedConfig(None)
346
isinstance(my_config._get_parser(file=config_file),
347
configobj.ConfigObj))
349
def test_cached(self):
350
config_file = StringIO(sample_config_text.encode('utf-8'))
351
my_config = config.IniBasedConfig(None)
352
parser = my_config._get_parser(file=config_file)
353
self.failUnless(my_config._get_parser() is parser)
356
class TestGetConfig(tests.TestCase):
358
def test_constructs(self):
359
my_config = config.GlobalConfig()
361
def test_calls_read_filenames(self):
362
# replace the class that is constructed, to check its parameters
363
oldparserclass = config.ConfigObj
364
config.ConfigObj = InstrumentedConfigObj
365
my_config = config.GlobalConfig()
367
parser = my_config._get_parser()
369
config.ConfigObj = oldparserclass
370
self.failUnless(isinstance(parser, InstrumentedConfigObj))
371
self.assertEqual(parser._calls, [('__init__', config.config_filename(),
375
class TestBranchConfig(tests.TestCaseWithTransport):
377
def test_constructs(self):
378
branch = FakeBranch()
379
my_config = config.BranchConfig(branch)
380
self.assertRaises(TypeError, config.BranchConfig)
382
def test_get_location_config(self):
383
branch = FakeBranch()
384
my_config = config.BranchConfig(branch)
385
location_config = my_config._get_location_config()
386
self.assertEqual(branch.base, location_config.location)
387
self.failUnless(location_config is my_config._get_location_config())
389
def test_get_config(self):
390
"""The Branch.get_config method works properly"""
391
b = bzrdir.BzrDir.create_standalone_workingtree('.').branch
392
my_config = b.get_config()
393
self.assertIs(my_config.get_user_option('wacky'), None)
394
my_config.set_user_option('wacky', 'unlikely')
395
self.assertEqual(my_config.get_user_option('wacky'), 'unlikely')
397
# Ensure we get the same thing if we start again
398
b2 = branch.Branch.open('.')
399
my_config2 = b2.get_config()
400
self.assertEqual(my_config2.get_user_option('wacky'), 'unlikely')
402
def test_has_explicit_nickname(self):
403
b = self.make_branch('.')
404
self.assertFalse(b.get_config().has_explicit_nickname())
406
self.assertTrue(b.get_config().has_explicit_nickname())
408
def test_config_url(self):
409
"""The Branch.get_config will use section that uses a local url"""
410
branch = self.make_branch('branch')
411
self.assertEqual('branch', branch.nick)
413
locations = config.locations_config_filename()
414
config.ensure_config_dir_exists()
415
local_url = urlutils.local_path_to_url('branch')
416
open(locations, 'wb').write('[%s]\nnickname = foobar'
418
self.assertEqual('foobar', branch.nick)
420
def test_config_local_path(self):
421
"""The Branch.get_config will use a local system path"""
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
open(locations, 'wb').write('[%s/branch]\nnickname = barry'
428
% (osutils.getcwd().encode('utf8'),))
429
self.assertEqual('barry', branch.nick)
431
def test_config_creates_local(self):
432
"""Creating a new entry in config uses a local path."""
433
branch = self.make_branch('branch', format='knit')
434
branch.set_push_location('http://foobar')
435
locations = config.locations_config_filename()
436
local_path = osutils.getcwd().encode('utf8')
437
# Surprisingly ConfigObj doesn't create a trailing newline
438
self.check_file_contents(locations,
440
'push_location = http://foobar\n'
441
'push_location:policy = norecurse\n'
444
def test_autonick_urlencoded(self):
445
b = self.make_branch('!repo')
446
self.assertEqual('!repo', b.get_config().get_nickname())
448
def test_warn_if_masked(self):
449
_warning = trace.warning
452
warnings.append(args[0] % args[1:])
454
def set_option(store, warn_masked=True):
456
conf.set_user_option('example_option', repr(store), store=store,
457
warn_masked=warn_masked)
458
def assertWarning(warning):
460
self.assertEqual(0, len(warnings))
462
self.assertEqual(1, len(warnings))
463
self.assertEqual(warning, warnings[0])
464
trace.warning = warning
466
branch = self.make_branch('.')
467
conf = branch.get_config()
468
set_option(config.STORE_GLOBAL)
470
set_option(config.STORE_BRANCH)
472
set_option(config.STORE_GLOBAL)
473
assertWarning('Value "4" is masked by "3" from branch.conf')
474
set_option(config.STORE_GLOBAL, warn_masked=False)
476
set_option(config.STORE_LOCATION)
478
set_option(config.STORE_BRANCH)
479
assertWarning('Value "3" is masked by "0" from locations.conf')
480
set_option(config.STORE_BRANCH, warn_masked=False)
483
trace.warning = _warning
486
class TestGlobalConfigItems(tests.TestCase):
488
def test_user_id(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(u"Erik B\u00e5gfors <erik@bagfors.nu>",
493
my_config._get_user_id())
495
def test_absent_user_id(self):
496
config_file = StringIO("")
497
my_config = config.GlobalConfig()
498
my_config._parser = my_config._get_parser(file=config_file)
499
self.assertEqual(None, my_config._get_user_id())
501
def test_configured_editor(self):
502
config_file = StringIO(sample_config_text.encode('utf-8'))
503
my_config = config.GlobalConfig()
504
my_config._parser = my_config._get_parser(file=config_file)
505
self.assertEqual("vim", my_config.get_editor())
507
def test_signatures_always(self):
508
config_file = StringIO(sample_always_signatures)
509
my_config = config.GlobalConfig()
510
my_config._parser = my_config._get_parser(file=config_file)
511
self.assertEqual(config.CHECK_NEVER,
512
my_config.signature_checking())
513
self.assertEqual(config.SIGN_ALWAYS,
514
my_config.signing_policy())
515
self.assertEqual(True, my_config.signature_needed())
517
def test_signatures_if_possible(self):
518
config_file = StringIO(sample_maybe_signatures)
519
my_config = config.GlobalConfig()
520
my_config._parser = my_config._get_parser(file=config_file)
521
self.assertEqual(config.CHECK_NEVER,
522
my_config.signature_checking())
523
self.assertEqual(config.SIGN_WHEN_REQUIRED,
524
my_config.signing_policy())
525
self.assertEqual(False, my_config.signature_needed())
527
def test_signatures_ignore(self):
528
config_file = StringIO(sample_ignore_signatures)
529
my_config = config.GlobalConfig()
530
my_config._parser = my_config._get_parser(file=config_file)
531
self.assertEqual(config.CHECK_ALWAYS,
532
my_config.signature_checking())
533
self.assertEqual(config.SIGN_NEVER,
534
my_config.signing_policy())
535
self.assertEqual(False, my_config.signature_needed())
537
def _get_sample_config(self):
538
config_file = StringIO(sample_config_text.encode('utf-8'))
539
my_config = config.GlobalConfig()
540
my_config._parser = my_config._get_parser(file=config_file)
543
def test_gpg_signing_command(self):
544
my_config = self._get_sample_config()
545
self.assertEqual("gnome-gpg", my_config.gpg_signing_command())
546
self.assertEqual(False, my_config.signature_needed())
548
def _get_empty_config(self):
549
config_file = StringIO("")
550
my_config = config.GlobalConfig()
551
my_config._parser = my_config._get_parser(file=config_file)
554
def test_gpg_signing_command_unset(self):
555
my_config = self._get_empty_config()
556
self.assertEqual("gpg", my_config.gpg_signing_command())
558
def test_get_user_option_default(self):
559
my_config = self._get_empty_config()
560
self.assertEqual(None, my_config.get_user_option('no_option'))
562
def test_get_user_option_global(self):
563
my_config = self._get_sample_config()
564
self.assertEqual("something",
565
my_config.get_user_option('user_global_option'))
567
def test_post_commit_default(self):
568
my_config = self._get_sample_config()
569
self.assertEqual(None, my_config.post_commit())
571
def test_configured_logformat(self):
572
my_config = self._get_sample_config()
573
self.assertEqual("short", my_config.log_format())
575
def test_get_alias(self):
576
my_config = self._get_sample_config()
577
self.assertEqual('help', my_config.get_alias('h'))
579
def test_get_no_alias(self):
580
my_config = self._get_sample_config()
581
self.assertEqual(None, my_config.get_alias('foo'))
583
def test_get_long_alias(self):
584
my_config = self._get_sample_config()
585
self.assertEqual(sample_long_alias, my_config.get_alias('ll'))
588
class TestLocationConfig(tests.TestCaseInTempDir):
590
def test_constructs(self):
591
my_config = config.LocationConfig('http://example.com')
592
self.assertRaises(TypeError, config.LocationConfig)
594
def test_branch_calls_read_filenames(self):
595
# This is testing the correct file names are provided.
596
# TODO: consolidate with the test for GlobalConfigs filename checks.
598
# replace the class that is constructed, to check its parameters
599
oldparserclass = config.ConfigObj
600
config.ConfigObj = InstrumentedConfigObj
602
my_config = config.LocationConfig('http://www.example.com')
603
parser = my_config._get_parser()
605
config.ConfigObj = oldparserclass
606
self.failUnless(isinstance(parser, InstrumentedConfigObj))
607
self.assertEqual(parser._calls,
608
[('__init__', config.locations_config_filename(),
610
config.ensure_config_dir_exists()
611
#os.mkdir(config.config_dir())
612
f = file(config.branches_config_filename(), 'wb')
615
oldparserclass = config.ConfigObj
616
config.ConfigObj = InstrumentedConfigObj
618
my_config = config.LocationConfig('http://www.example.com')
619
parser = my_config._get_parser()
621
config.ConfigObj = oldparserclass
623
def test_get_global_config(self):
624
my_config = config.BranchConfig(FakeBranch('http://example.com'))
625
global_config = my_config._get_global_config()
626
self.failUnless(isinstance(global_config, config.GlobalConfig))
627
self.failUnless(global_config is my_config._get_global_config())
629
def test__get_matching_sections_no_match(self):
630
self.get_branch_config('/')
631
self.assertEqual([], self.my_location_config._get_matching_sections())
633
def test__get_matching_sections_exact(self):
634
self.get_branch_config('http://www.example.com')
635
self.assertEqual([('http://www.example.com', '')],
636
self.my_location_config._get_matching_sections())
638
def test__get_matching_sections_suffix_does_not(self):
639
self.get_branch_config('http://www.example.com-com')
640
self.assertEqual([], self.my_location_config._get_matching_sections())
642
def test__get_matching_sections_subdir_recursive(self):
643
self.get_branch_config('http://www.example.com/com')
644
self.assertEqual([('http://www.example.com', 'com')],
645
self.my_location_config._get_matching_sections())
647
def test__get_matching_sections_ignoreparent(self):
648
self.get_branch_config('http://www.example.com/ignoreparent')
649
self.assertEqual([('http://www.example.com/ignoreparent', '')],
650
self.my_location_config._get_matching_sections())
652
def test__get_matching_sections_ignoreparent_subdir(self):
653
self.get_branch_config(
654
'http://www.example.com/ignoreparent/childbranch')
655
self.assertEqual([('http://www.example.com/ignoreparent',
657
self.my_location_config._get_matching_sections())
659
def test__get_matching_sections_subdir_trailing_slash(self):
660
self.get_branch_config('/b')
661
self.assertEqual([('/b/', '')],
662
self.my_location_config._get_matching_sections())
664
def test__get_matching_sections_subdir_child(self):
665
self.get_branch_config('/a/foo')
666
self.assertEqual([('/a/*', ''), ('/a/', 'foo')],
667
self.my_location_config._get_matching_sections())
669
def test__get_matching_sections_subdir_child_child(self):
670
self.get_branch_config('/a/foo/bar')
671
self.assertEqual([('/a/*', 'bar'), ('/a/', 'foo/bar')],
672
self.my_location_config._get_matching_sections())
674
def test__get_matching_sections_trailing_slash_with_children(self):
675
self.get_branch_config('/a/')
676
self.assertEqual([('/a/', '')],
677
self.my_location_config._get_matching_sections())
679
def test__get_matching_sections_explicit_over_glob(self):
680
# XXX: 2006-09-08 jamesh
681
# This test only passes because ord('c') > ord('*'). If there
682
# was a config section for '/a/?', it would get precedence
684
self.get_branch_config('/a/c')
685
self.assertEqual([('/a/c', ''), ('/a/*', ''), ('/a/', 'c')],
686
self.my_location_config._get_matching_sections())
688
def test__get_option_policy_normal(self):
689
self.get_branch_config('http://www.example.com')
691
self.my_location_config._get_config_policy(
692
'http://www.example.com', 'normal_option'),
695
def test__get_option_policy_norecurse(self):
696
self.get_branch_config('http://www.example.com')
698
self.my_location_config._get_option_policy(
699
'http://www.example.com', 'norecurse_option'),
700
config.POLICY_NORECURSE)
701
# Test old recurse=False setting:
703
self.my_location_config._get_option_policy(
704
'http://www.example.com/norecurse', 'normal_option'),
705
config.POLICY_NORECURSE)
707
def test__get_option_policy_normal(self):
708
self.get_branch_config('http://www.example.com')
710
self.my_location_config._get_option_policy(
711
'http://www.example.com', 'appendpath_option'),
712
config.POLICY_APPENDPATH)
714
def test_location_without_username(self):
715
self.get_branch_config('http://www.example.com/ignoreparent')
716
self.assertEqual(u'Erik B\u00e5gfors <erik@bagfors.nu>',
717
self.my_config.username())
719
def test_location_not_listed(self):
720
"""Test that the global username is used when no location matches"""
721
self.get_branch_config('/home/robertc/sources')
722
self.assertEqual(u'Erik B\u00e5gfors <erik@bagfors.nu>',
723
self.my_config.username())
725
def test_overriding_location(self):
726
self.get_branch_config('http://www.example.com/foo')
727
self.assertEqual('Robert Collins <robertc@example.org>',
728
self.my_config.username())
730
def test_signatures_not_set(self):
731
self.get_branch_config('http://www.example.com',
732
global_config=sample_ignore_signatures)
733
self.assertEqual(config.CHECK_ALWAYS,
734
self.my_config.signature_checking())
735
self.assertEqual(config.SIGN_NEVER,
736
self.my_config.signing_policy())
738
def test_signatures_never(self):
739
self.get_branch_config('/a/c')
740
self.assertEqual(config.CHECK_NEVER,
741
self.my_config.signature_checking())
743
def test_signatures_when_available(self):
744
self.get_branch_config('/a/', global_config=sample_ignore_signatures)
745
self.assertEqual(config.CHECK_IF_POSSIBLE,
746
self.my_config.signature_checking())
748
def test_signatures_always(self):
749
self.get_branch_config('/b')
750
self.assertEqual(config.CHECK_ALWAYS,
751
self.my_config.signature_checking())
753
def test_gpg_signing_command(self):
754
self.get_branch_config('/b')
755
self.assertEqual("gnome-gpg", self.my_config.gpg_signing_command())
757
def test_gpg_signing_command_missing(self):
758
self.get_branch_config('/a')
759
self.assertEqual("false", self.my_config.gpg_signing_command())
761
def test_get_user_option_global(self):
762
self.get_branch_config('/a')
763
self.assertEqual('something',
764
self.my_config.get_user_option('user_global_option'))
766
def test_get_user_option_local(self):
767
self.get_branch_config('/a')
768
self.assertEqual('local',
769
self.my_config.get_user_option('user_local_option'))
771
def test_get_user_option_appendpath(self):
772
# returned as is for the base path:
773
self.get_branch_config('http://www.example.com')
774
self.assertEqual('append',
775
self.my_config.get_user_option('appendpath_option'))
776
# Extra path components get appended:
777
self.get_branch_config('http://www.example.com/a/b/c')
778
self.assertEqual('append/a/b/c',
779
self.my_config.get_user_option('appendpath_option'))
780
# Overriden for http://www.example.com/dir, where it is a
782
self.get_branch_config('http://www.example.com/dir/a/b/c')
783
self.assertEqual('normal',
784
self.my_config.get_user_option('appendpath_option'))
786
def test_get_user_option_norecurse(self):
787
self.get_branch_config('http://www.example.com')
788
self.assertEqual('norecurse',
789
self.my_config.get_user_option('norecurse_option'))
790
self.get_branch_config('http://www.example.com/dir')
791
self.assertEqual(None,
792
self.my_config.get_user_option('norecurse_option'))
793
# http://www.example.com/norecurse is a recurse=False section
794
# that redefines normal_option. Subdirectories do not pick up
796
self.get_branch_config('http://www.example.com/norecurse')
797
self.assertEqual('norecurse',
798
self.my_config.get_user_option('normal_option'))
799
self.get_branch_config('http://www.example.com/norecurse/subdir')
800
self.assertEqual('normal',
801
self.my_config.get_user_option('normal_option'))
803
def test_set_user_option_norecurse(self):
804
self.get_branch_config('http://www.example.com')
805
self.my_config.set_user_option('foo', 'bar',
806
store=config.STORE_LOCATION_NORECURSE)
808
self.my_location_config._get_option_policy(
809
'http://www.example.com', 'foo'),
810
config.POLICY_NORECURSE)
812
def test_set_user_option_appendpath(self):
813
self.get_branch_config('http://www.example.com')
814
self.my_config.set_user_option('foo', 'bar',
815
store=config.STORE_LOCATION_APPENDPATH)
817
self.my_location_config._get_option_policy(
818
'http://www.example.com', 'foo'),
819
config.POLICY_APPENDPATH)
821
def test_set_user_option_change_policy(self):
822
self.get_branch_config('http://www.example.com')
823
self.my_config.set_user_option('norecurse_option', 'normal',
824
store=config.STORE_LOCATION)
826
self.my_location_config._get_option_policy(
827
'http://www.example.com', 'norecurse_option'),
830
def test_set_user_option_recurse_false_section(self):
831
# The following section has recurse=False set. The test is to
832
# make sure that a normal option can be added to the section,
833
# converting recurse=False to the norecurse policy.
834
self.get_branch_config('http://www.example.com/norecurse')
835
self.callDeprecated(['The recurse option is deprecated as of 0.14. '
836
'The section "http://www.example.com/norecurse" '
837
'has been converted to use policies.'],
838
self.my_config.set_user_option,
839
'foo', 'bar', store=config.STORE_LOCATION)
841
self.my_location_config._get_option_policy(
842
'http://www.example.com/norecurse', 'foo'),
844
# The previously existing option is still norecurse:
846
self.my_location_config._get_option_policy(
847
'http://www.example.com/norecurse', 'normal_option'),
848
config.POLICY_NORECURSE)
850
def test_post_commit_default(self):
851
self.get_branch_config('/a/c')
852
self.assertEqual('bzrlib.tests.test_config.post_commit',
853
self.my_config.post_commit())
855
def get_branch_config(self, location, global_config=None):
856
if global_config is None:
857
global_file = StringIO(sample_config_text.encode('utf-8'))
859
global_file = StringIO(global_config.encode('utf-8'))
860
branches_file = StringIO(sample_branches_text.encode('utf-8'))
861
self.my_config = config.BranchConfig(FakeBranch(location))
862
# Force location config to use specified file
863
self.my_location_config = self.my_config._get_location_config()
864
self.my_location_config._get_parser(branches_file)
865
# Force global config to use specified file
866
self.my_config._get_global_config()._get_parser(global_file)
868
def test_set_user_setting_sets_and_saves(self):
869
self.get_branch_config('/a/c')
870
record = InstrumentedConfigObj("foo")
871
self.my_location_config._parser = record
873
real_mkdir = os.mkdir
875
def checked_mkdir(path, mode=0777):
876
self.log('making directory: %s', path)
877
real_mkdir(path, mode)
880
os.mkdir = checked_mkdir
882
self.callDeprecated(['The recurse option is deprecated as of '
883
'0.14. The section "/a/c" has been '
884
'converted to use policies.'],
885
self.my_config.set_user_option,
886
'foo', 'bar', store=config.STORE_LOCATION)
888
os.mkdir = real_mkdir
890
self.failUnless(self.created, 'Failed to create ~/.bazaar')
891
self.assertEqual([('__contains__', '/a/c'),
892
('__contains__', '/a/c/'),
893
('__setitem__', '/a/c', {}),
894
('__getitem__', '/a/c'),
895
('__setitem__', 'foo', 'bar'),
896
('__getitem__', '/a/c'),
897
('as_bool', 'recurse'),
898
('__getitem__', '/a/c'),
899
('__delitem__', 'recurse'),
900
('__getitem__', '/a/c'),
902
('__getitem__', '/a/c'),
903
('__contains__', 'foo:policy'),
907
def test_set_user_setting_sets_and_saves2(self):
908
self.get_branch_config('/a/c')
909
self.assertIs(self.my_config.get_user_option('foo'), None)
910
self.my_config.set_user_option('foo', 'bar')
912
self.my_config.branch.control_files.files['branch.conf'],
914
self.assertEqual(self.my_config.get_user_option('foo'), 'bar')
915
self.my_config.set_user_option('foo', 'baz',
916
store=config.STORE_LOCATION)
917
self.assertEqual(self.my_config.get_user_option('foo'), 'baz')
918
self.my_config.set_user_option('foo', 'qux')
919
self.assertEqual(self.my_config.get_user_option('foo'), 'baz')
921
def test_get_bzr_remote_path(self):
922
my_config = config.LocationConfig('/a/c')
923
self.assertEqual('bzr', my_config.get_bzr_remote_path())
924
my_config.set_user_option('bzr_remote_path', '/path-bzr')
925
self.assertEqual('/path-bzr', my_config.get_bzr_remote_path())
926
os.environ['BZR_REMOTE_PATH'] = '/environ-bzr'
927
self.assertEqual('/environ-bzr', my_config.get_bzr_remote_path())
930
precedence_global = 'option = global'
931
precedence_branch = 'option = branch'
932
precedence_location = """
936
[http://example.com/specific]
941
class TestBranchConfigItems(tests.TestCaseInTempDir):
943
def get_branch_config(self, global_config=None, location=None,
944
location_config=None, branch_data_config=None):
945
my_config = config.BranchConfig(FakeBranch(location))
946
if global_config is not None:
947
global_file = StringIO(global_config.encode('utf-8'))
948
my_config._get_global_config()._get_parser(global_file)
949
self.my_location_config = my_config._get_location_config()
950
if location_config is not None:
951
location_file = StringIO(location_config.encode('utf-8'))
952
self.my_location_config._get_parser(location_file)
953
if branch_data_config is not None:
954
my_config.branch.control_files.files['branch.conf'] = \
958
def test_user_id(self):
959
branch = FakeBranch(user_id='Robert Collins <robertc@example.net>')
960
my_config = config.BranchConfig(branch)
961
self.assertEqual("Robert Collins <robertc@example.net>",
962
my_config.username())
963
branch.control_files.email = "John"
964
my_config.set_user_option('email',
965
"Robert Collins <robertc@example.org>")
966
self.assertEqual("John", my_config.username())
967
branch.control_files.email = None
968
self.assertEqual("Robert Collins <robertc@example.org>",
969
my_config.username())
971
def test_not_set_in_branch(self):
972
my_config = self.get_branch_config(sample_config_text)
973
my_config.branch.control_files.email = None
974
self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
975
my_config._get_user_id())
976
my_config.branch.control_files.email = "John"
977
self.assertEqual("John", my_config._get_user_id())
979
def test_BZR_EMAIL_OVERRIDES(self):
980
os.environ['BZR_EMAIL'] = "Robert Collins <robertc@example.org>"
981
branch = FakeBranch()
982
my_config = config.BranchConfig(branch)
983
self.assertEqual("Robert Collins <robertc@example.org>",
984
my_config.username())
986
def test_signatures_forced(self):
987
my_config = self.get_branch_config(
988
global_config=sample_always_signatures)
989
self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
990
self.assertEqual(config.SIGN_ALWAYS, my_config.signing_policy())
991
self.assertTrue(my_config.signature_needed())
993
def test_signatures_forced_branch(self):
994
my_config = self.get_branch_config(
995
global_config=sample_ignore_signatures,
996
branch_data_config=sample_always_signatures)
997
self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
998
self.assertEqual(config.SIGN_ALWAYS, my_config.signing_policy())
999
self.assertTrue(my_config.signature_needed())
1001
def test_gpg_signing_command(self):
1002
my_config = self.get_branch_config(
1003
# branch data cannot set gpg_signing_command
1004
branch_data_config="gpg_signing_command=pgp")
1005
config_file = StringIO(sample_config_text.encode('utf-8'))
1006
my_config._get_global_config()._get_parser(config_file)
1007
self.assertEqual('gnome-gpg', my_config.gpg_signing_command())
1009
def test_get_user_option_global(self):
1010
branch = FakeBranch()
1011
my_config = config.BranchConfig(branch)
1012
config_file = StringIO(sample_config_text.encode('utf-8'))
1013
(my_config._get_global_config()._get_parser(config_file))
1014
self.assertEqual('something',
1015
my_config.get_user_option('user_global_option'))
1017
def test_post_commit_default(self):
1018
branch = FakeBranch()
1019
my_config = self.get_branch_config(sample_config_text, '/a/c',
1020
sample_branches_text)
1021
self.assertEqual(my_config.branch.base, '/a/c')
1022
self.assertEqual('bzrlib.tests.test_config.post_commit',
1023
my_config.post_commit())
1024
my_config.set_user_option('post_commit', 'rmtree_root')
1025
# post-commit is ignored when bresent in branch data
1026
self.assertEqual('bzrlib.tests.test_config.post_commit',
1027
my_config.post_commit())
1028
my_config.set_user_option('post_commit', 'rmtree_root',
1029
store=config.STORE_LOCATION)
1030
self.assertEqual('rmtree_root', my_config.post_commit())
1032
def test_config_precedence(self):
1033
my_config = self.get_branch_config(global_config=precedence_global)
1034
self.assertEqual(my_config.get_user_option('option'), 'global')
1035
my_config = self.get_branch_config(global_config=precedence_global,
1036
branch_data_config=precedence_branch)
1037
self.assertEqual(my_config.get_user_option('option'), 'branch')
1038
my_config = self.get_branch_config(global_config=precedence_global,
1039
branch_data_config=precedence_branch,
1040
location_config=precedence_location)
1041
self.assertEqual(my_config.get_user_option('option'), 'recurse')
1042
my_config = self.get_branch_config(global_config=precedence_global,
1043
branch_data_config=precedence_branch,
1044
location_config=precedence_location,
1045
location='http://example.com/specific')
1046
self.assertEqual(my_config.get_user_option('option'), 'exact')
1048
def test_get_mail_client(self):
1049
config = self.get_branch_config()
1050
client = config.get_mail_client()
1051
self.assertIsInstance(client, mail_client.DefaultMail)
1054
config.set_user_option('mail_client', 'evolution')
1055
client = config.get_mail_client()
1056
self.assertIsInstance(client, mail_client.Evolution)
1058
config.set_user_option('mail_client', 'kmail')
1059
client = config.get_mail_client()
1060
self.assertIsInstance(client, mail_client.KMail)
1062
config.set_user_option('mail_client', 'mutt')
1063
client = config.get_mail_client()
1064
self.assertIsInstance(client, mail_client.Mutt)
1066
config.set_user_option('mail_client', 'thunderbird')
1067
client = config.get_mail_client()
1068
self.assertIsInstance(client, mail_client.Thunderbird)
1071
config.set_user_option('mail_client', 'default')
1072
client = config.get_mail_client()
1073
self.assertIsInstance(client, mail_client.DefaultMail)
1075
config.set_user_option('mail_client', 'editor')
1076
client = config.get_mail_client()
1077
self.assertIsInstance(client, mail_client.Editor)
1079
config.set_user_option('mail_client', 'mapi')
1080
client = config.get_mail_client()
1081
self.assertIsInstance(client, mail_client.MAPIClient)
1083
config.set_user_option('mail_client', 'xdg-email')
1084
client = config.get_mail_client()
1085
self.assertIsInstance(client, mail_client.XDGEmail)
1087
config.set_user_option('mail_client', 'firebird')
1088
self.assertRaises(errors.UnknownMailClient, config.get_mail_client)
1091
class TestMailAddressExtraction(tests.TestCase):
1093
def test_extract_email_address(self):
1094
self.assertEqual('jane@test.com',
1095
config.extract_email_address('Jane <jane@test.com>'))
1096
self.assertRaises(errors.NoEmailInUsername,
1097
config.extract_email_address, 'Jane Tester')
1099
def test_parse_username(self):
1100
self.assertEqual(('', 'jdoe@example.com'),
1101
config.parse_username('jdoe@example.com'))
1102
self.assertEqual(('', 'jdoe@example.com'),
1103
config.parse_username('<jdoe@example.com>'))
1104
self.assertEqual(('John Doe', 'jdoe@example.com'),
1105
config.parse_username('John Doe <jdoe@example.com>'))
1106
self.assertEqual(('John Doe', ''),
1107
config.parse_username('John Doe'))
1108
self.assertEqual(('John Doe', 'jdoe@example.com'),
1109
config.parse_username('John Doe jdoe@example.com'))
1111
class TestTreeConfig(tests.TestCaseWithTransport):
1113
def test_get_value(self):
1114
"""Test that retreiving a value from a section is possible"""
1115
branch = self.make_branch('.')
1116
tree_config = config.TreeConfig(branch)
1117
tree_config.set_option('value', 'key', 'SECTION')
1118
tree_config.set_option('value2', 'key2')
1119
tree_config.set_option('value3-top', 'key3')
1120
tree_config.set_option('value3-section', 'key3', 'SECTION')
1121
value = tree_config.get_option('key', 'SECTION')
1122
self.assertEqual(value, 'value')
1123
value = tree_config.get_option('key2')
1124
self.assertEqual(value, 'value2')
1125
self.assertEqual(tree_config.get_option('non-existant'), None)
1126
value = tree_config.get_option('non-existant', 'SECTION')
1127
self.assertEqual(value, None)
1128
value = tree_config.get_option('non-existant', default='default')
1129
self.assertEqual(value, 'default')
1130
self.assertEqual(tree_config.get_option('key2', 'NOSECTION'), None)
1131
value = tree_config.get_option('key2', 'NOSECTION', default='default')
1132
self.assertEqual(value, 'default')
1133
value = tree_config.get_option('key3')
1134
self.assertEqual(value, 'value3-top')
1135
value = tree_config.get_option('key3', 'SECTION')
1136
self.assertEqual(value, 'value3-section')
1139
class TestAuthenticationConfigFile(tests.TestCase):
1140
"""Test the authentication.conf file matching"""
1142
def _got_user_passwd(self, expected_user, expected_password,
1143
config, *args, **kwargs):
1144
credentials = config.get_credentials(*args, **kwargs)
1145
if credentials is None:
1149
user = credentials['user']
1150
password = credentials['password']
1151
self.assertEquals(expected_user, user)
1152
self.assertEquals(expected_password, password)
1154
def test_empty_config(self):
1155
conf = config.AuthenticationConfig(_file=StringIO())
1156
self.assertEquals({}, conf._get_config())
1157
self._got_user_passwd(None, None, conf, 'http', 'foo.net')
1159
def test_broken_config(self):
1160
conf = config.AuthenticationConfig(_file=StringIO('[DEF'))
1161
self.assertRaises(errors.ParseConfigError, conf._get_config)
1163
conf = config.AuthenticationConfig(_file=StringIO(
1167
verify_certificates=askme # Error: Not a boolean
1169
self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
1170
conf = config.AuthenticationConfig(_file=StringIO(
1174
port=port # Error: Not an int
1176
self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
1178
def test_credentials_for_scheme_host(self):
1179
conf = config.AuthenticationConfig(_file=StringIO(
1180
"""# Identity on foo.net
1185
password=secret-pass
1188
self._got_user_passwd('joe', 'secret-pass', conf, 'ftp', 'foo.net')
1190
self._got_user_passwd(None, None, conf, 'http', 'foo.net')
1192
self._got_user_passwd(None, None, conf, 'ftp', 'bar.net')
1194
def test_credentials_for_host_port(self):
1195
conf = config.AuthenticationConfig(_file=StringIO(
1196
"""# Identity on foo.net
1202
password=secret-pass
1205
self._got_user_passwd('joe', 'secret-pass',
1206
conf, 'ftp', 'foo.net', port=10021)
1208
self._got_user_passwd(None, None, conf, 'ftp', 'foo.net')
1210
def test_for_matching_host(self):
1211
conf = config.AuthenticationConfig(_file=StringIO(
1212
"""# Identity on foo.net
1218
[sourceforge domain]
1225
self._got_user_passwd('georges', 'bendover',
1226
conf, 'bzr', 'foo.bzr.sf.net')
1228
self._got_user_passwd(None, None,
1229
conf, 'bzr', 'bbzr.sf.net')
1231
def test_for_matching_host_None(self):
1232
conf = config.AuthenticationConfig(_file=StringIO(
1233
"""# Identity on foo.net
1243
self._got_user_passwd('joe', 'joepass',
1244
conf, 'bzr', 'quux.net')
1245
# no host but different scheme
1246
self._got_user_passwd('georges', 'bendover',
1247
conf, 'ftp', 'quux.net')
1249
def test_credentials_for_path(self):
1250
conf = config.AuthenticationConfig(_file=StringIO(
1266
self._got_user_passwd(None, None,
1267
conf, 'http', host='bar.org', path='/dir3')
1269
self._got_user_passwd('georges', 'bendover',
1270
conf, 'http', host='bar.org', path='/dir2')
1272
self._got_user_passwd('jim', 'jimpass',
1273
conf, 'http', host='bar.org',path='/dir1/subdir')
1275
def test_credentials_for_user(self):
1276
conf = config.AuthenticationConfig(_file=StringIO(
1285
self._got_user_passwd('jim', 'jimpass',
1286
conf, 'http', 'bar.org')
1288
self._got_user_passwd('jim', 'jimpass',
1289
conf, 'http', 'bar.org', user='jim')
1290
# Don't get a different user if one is specified
1291
self._got_user_passwd(None, None,
1292
conf, 'http', 'bar.org', user='georges')
1294
def test_verify_certificates(self):
1295
conf = config.AuthenticationConfig(_file=StringIO(
1302
verify_certificates=False
1309
credentials = conf.get_credentials('https', 'bar.org')
1310
self.assertEquals(False, credentials.get('verify_certificates'))
1311
credentials = conf.get_credentials('https', 'foo.net')
1312
self.assertEquals(True, credentials.get('verify_certificates'))
1315
class TestAuthenticationConfig(tests.TestCase):
1316
"""Test AuthenticationConfig behaviour"""
1318
def _check_default_prompt(self, expected_prompt_format, scheme,
1319
host=None, port=None, realm=None, path=None):
1322
user, password = 'jim', 'precious'
1323
expected_prompt = expected_prompt_format % {
1324
'scheme': scheme, 'host': host, 'port': port,
1325
'user': user, 'realm': realm}
1327
stdout = tests.StringIOWrapper()
1328
ui.ui_factory = tests.TestUIFactory(stdin=password + '\n',
1330
# We use an empty conf so that the user is always prompted
1331
conf = config.AuthenticationConfig()
1332
self.assertEquals(password,
1333
conf.get_password(scheme, host, user, port=port,
1334
realm=realm, path=path))
1335
self.assertEquals(stdout.getvalue(), expected_prompt)
1337
def test_default_prompts(self):
1338
# HTTP prompts can't be tested here, see test_http.py
1339
self._check_default_prompt('FTP %(user)s@%(host)s password: ', 'ftp')
1340
self._check_default_prompt('FTP %(user)s@%(host)s:%(port)d password: ',
1343
self._check_default_prompt('SSH %(user)s@%(host)s:%(port)d password: ',
1345
# SMTP port handling is a bit special (it's handled if embedded in the
1347
# FIXME: should we: forbid that, extend it to other schemes, leave
1348
# things as they are that's fine thank you ?
1349
self._check_default_prompt('SMTP %(user)s@%(host)s password: ',
1351
self._check_default_prompt('SMTP %(user)s@%(host)s password: ',
1352
'smtp', host='bar.org:10025')
1353
self._check_default_prompt(
1354
'SMTP %(user)s@%(host)s:%(port)d password: ',
1358
# FIXME: Once we have a way to declare authentication to all test servers, we
1359
# can implement generic tests.
1360
# test_user_password_in_url
1361
# test_user_in_url_password_from_config
1362
# test_user_in_url_password_prompted
1363
# test_user_in_config
1364
# test_user_getpass.getuser
1365
# test_user_prompted ?
1366
class TestAuthenticationRing(tests.TestCaseWithTransport):
added
removed
bzrlib/tests/test_config.py
