1
# Copyright (C) 2005 by 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 bzrlib.util.configobj.configobj import ConfigObj, ConfigObjError
21
from cStringIO import StringIO
25
#import bzrlib specific imports here
26
import bzrlib.config as config
27
import bzrlib.errors as errors
28
from bzrlib.tests import TestCase, TestCaseInTempDir
31
sample_long_alias="log -r-15..-1 --line"
32
sample_config_text = ("[DEFAULT]\n"
33
u"email=Erik B\u00e5gfors <erik@bagfors.nu>\n"
35
"gpg_signing_command=gnome-gpg\n"
37
"user_global_option=something\n"
40
"ll=" + sample_long_alias + "\n")
43
sample_always_signatures = ("[DEFAULT]\n"
44
"check_signatures=require\n")
47
sample_ignore_signatures = ("[DEFAULT]\n"
48
"check_signatures=ignore\n")
51
sample_maybe_signatures = ("[DEFAULT]\n"
52
"check_signatures=check-available\n")
55
sample_branches_text = ("[http://www.example.com]\n"
56
"# Top level policy\n"
57
"email=Robert Collins <robertc@example.org>\n"
58
"[http://www.example.com/useglobal]\n"
59
"# different project, forces global lookup\n"
62
"check_signatures=require\n"
63
"# test trailing / matching with no children\n"
65
"check_signatures=check-available\n"
66
"gpg_signing_command=false\n"
67
"user_local_option=local\n"
68
"# test trailing / matching\n"
70
"#subdirs will match but not the parent\n"
73
"check_signatures=ignore\n"
74
"post_commit=bzrlib.tests.test_config.post_commit\n"
75
"#testing explicit beats globs\n")
79
class InstrumentedConfigObj(object):
80
"""A config obj look-enough-alike to record calls made to it."""
82
def __contains__(self, thing):
83
self._calls.append(('__contains__', thing))
86
def __getitem__(self, key):
87
self._calls.append(('__getitem__', key))
90
def __init__(self, input, encoding=None):
91
self._calls = [('__init__', input, encoding)]
93
def __setitem__(self, key, value):
94
self._calls.append(('__setitem__', key, value))
97
self._calls.append(('write',))
100
class FakeBranch(object):
103
self.base = "http://example.com/branches/demo"
104
self.control_files = FakeControlFiles()
107
class FakeControlFiles(object):
110
self.email = 'Robert Collins <robertc@example.net>\n'
112
def get_utf8(self, filename):
113
if filename != 'email':
114
raise NotImplementedError
115
if self.email is not None:
116
return StringIO(self.email)
117
raise errors.NoSuchFile(filename)
120
class InstrumentedConfig(config.Config):
121
"""An instrumented config that supplies stubs for template methods."""
124
super(InstrumentedConfig, self).__init__()
126
self._signatures = config.CHECK_NEVER
128
def _get_user_id(self):
129
self._calls.append('_get_user_id')
130
return "Robert Collins <robert.collins@example.org>"
132
def _get_signature_checking(self):
133
self._calls.append('_get_signature_checking')
134
return self._signatures
137
bool_config = """[DEFAULT]
144
class TestConfigObj(TestCase):
145
def test_get_bool(self):
146
from bzrlib.config import ConfigObj
147
co = ConfigObj(StringIO(bool_config))
148
self.assertIs(co.get_bool('DEFAULT', 'active'), True)
149
self.assertIs(co.get_bool('DEFAULT', 'inactive'), False)
150
self.assertIs(co.get_bool('UPPERCASE', 'active'), True)
151
self.assertIs(co.get_bool('UPPERCASE', 'nonactive'), False)
154
class TestConfig(TestCase):
156
def test_constructs(self):
159
def test_no_default_editor(self):
160
self.assertRaises(NotImplementedError, config.Config().get_editor)
162
def test_user_email(self):
163
my_config = InstrumentedConfig()
164
self.assertEqual('robert.collins@example.org', my_config.user_email())
165
self.assertEqual(['_get_user_id'], my_config._calls)
167
def test_username(self):
168
my_config = InstrumentedConfig()
169
self.assertEqual('Robert Collins <robert.collins@example.org>',
170
my_config.username())
171
self.assertEqual(['_get_user_id'], my_config._calls)
173
def test_signatures_default(self):
174
my_config = config.Config()
175
self.assertEqual(config.CHECK_IF_POSSIBLE,
176
my_config.signature_checking())
178
def test_signatures_template_method(self):
179
my_config = InstrumentedConfig()
180
self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
181
self.assertEqual(['_get_signature_checking'], my_config._calls)
183
def test_signatures_template_method_none(self):
184
my_config = InstrumentedConfig()
185
my_config._signatures = None
186
self.assertEqual(config.CHECK_IF_POSSIBLE,
187
my_config.signature_checking())
188
self.assertEqual(['_get_signature_checking'], my_config._calls)
190
def test_gpg_signing_command_default(self):
191
my_config = config.Config()
192
self.assertEqual('gpg', my_config.gpg_signing_command())
194
def test_get_user_option_default(self):
195
my_config = config.Config()
196
self.assertEqual(None, my_config.get_user_option('no_option'))
198
def test_post_commit_default(self):
199
my_config = config.Config()
200
self.assertEqual(None, my_config.post_commit())
202
def test_log_format_default(self):
203
my_config = config.Config()
204
self.assertEqual('long', my_config.log_format())
207
class TestConfigPath(TestCase):
210
super(TestConfigPath, self).setUp()
211
self.old_home = os.environ.get('HOME', None)
212
self.old_appdata = os.environ.get('APPDATA', None)
213
os.environ['HOME'] = '/home/bogus'
214
os.environ['APPDATA'] = \
215
r'C:\Documents and Settings\bogus\Application Data'
218
if self.old_home is None:
219
del os.environ['HOME']
221
os.environ['HOME'] = self.old_home
222
if self.old_appdata is None:
223
del os.environ['APPDATA']
225
os.environ['APPDATA'] = self.old_appdata
226
super(TestConfigPath, self).tearDown()
228
def test_config_dir(self):
229
if sys.platform == 'win32':
230
self.assertEqual(config.config_dir(),
231
'C:/Documents and Settings/bogus/Application Data/bazaar/2.0')
233
self.assertEqual(config.config_dir(), '/home/bogus/.bazaar')
235
def test_config_filename(self):
236
if sys.platform == 'win32':
237
self.assertEqual(config.config_filename(),
238
'C:/Documents and Settings/bogus/Application Data/bazaar/2.0/bazaar.conf')
240
self.assertEqual(config.config_filename(),
241
'/home/bogus/.bazaar/bazaar.conf')
243
def test_branches_config_filename(self):
244
if sys.platform == 'win32':
245
self.assertEqual(config.branches_config_filename(),
246
'C:/Documents and Settings/bogus/Application Data/bazaar/2.0/branches.conf')
248
self.assertEqual(config.branches_config_filename(),
249
'/home/bogus/.bazaar/branches.conf')
251
class TestIniConfig(TestCase):
253
def test_contructs(self):
254
my_config = config.IniBasedConfig("nothing")
256
def test_from_fp(self):
257
config_file = StringIO(sample_config_text.encode('utf-8'))
258
my_config = config.IniBasedConfig(None)
260
isinstance(my_config._get_parser(file=config_file),
263
def test_cached(self):
264
config_file = StringIO(sample_config_text.encode('utf-8'))
265
my_config = config.IniBasedConfig(None)
266
parser = my_config._get_parser(file=config_file)
267
self.failUnless(my_config._get_parser() is parser)
270
class TestGetConfig(TestCase):
272
def test_constructs(self):
273
my_config = config.GlobalConfig()
275
def test_calls_read_filenames(self):
276
# replace the class that is constructured, to check its parameters
277
oldparserclass = config.ConfigObj
278
config.ConfigObj = InstrumentedConfigObj
279
my_config = config.GlobalConfig()
281
parser = my_config._get_parser()
283
config.ConfigObj = oldparserclass
284
self.failUnless(isinstance(parser, InstrumentedConfigObj))
285
self.assertEqual(parser._calls, [('__init__', config.config_filename(),
289
class TestBranchConfig(TestCaseInTempDir):
291
def test_constructs(self):
292
branch = FakeBranch()
293
my_config = config.BranchConfig(branch)
294
self.assertRaises(TypeError, config.BranchConfig)
296
def test_get_location_config(self):
297
branch = FakeBranch()
298
my_config = config.BranchConfig(branch)
299
location_config = my_config._get_location_config()
300
self.assertEqual(branch.base, location_config.location)
301
self.failUnless(location_config is my_config._get_location_config())
304
class TestGlobalConfigItems(TestCase):
306
def test_user_id(self):
307
config_file = StringIO(sample_config_text.encode('utf-8'))
308
my_config = config.GlobalConfig()
309
my_config._parser = my_config._get_parser(file=config_file)
310
self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
311
my_config._get_user_id())
313
def test_absent_user_id(self):
314
config_file = StringIO("")
315
my_config = config.GlobalConfig()
316
my_config._parser = my_config._get_parser(file=config_file)
317
self.assertEqual(None, my_config._get_user_id())
319
def test_configured_editor(self):
320
config_file = StringIO(sample_config_text.encode('utf-8'))
321
my_config = config.GlobalConfig()
322
my_config._parser = my_config._get_parser(file=config_file)
323
self.assertEqual("vim", my_config.get_editor())
325
def test_signatures_always(self):
326
config_file = StringIO(sample_always_signatures)
327
my_config = config.GlobalConfig()
328
my_config._parser = my_config._get_parser(file=config_file)
329
self.assertEqual(config.CHECK_ALWAYS,
330
my_config.signature_checking())
331
self.assertEqual(True, my_config.signature_needed())
333
def test_signatures_if_possible(self):
334
config_file = StringIO(sample_maybe_signatures)
335
my_config = config.GlobalConfig()
336
my_config._parser = my_config._get_parser(file=config_file)
337
self.assertEqual(config.CHECK_IF_POSSIBLE,
338
my_config.signature_checking())
339
self.assertEqual(False, my_config.signature_needed())
341
def test_signatures_ignore(self):
342
config_file = StringIO(sample_ignore_signatures)
343
my_config = config.GlobalConfig()
344
my_config._parser = my_config._get_parser(file=config_file)
345
self.assertEqual(config.CHECK_NEVER,
346
my_config.signature_checking())
347
self.assertEqual(False, my_config.signature_needed())
349
def _get_sample_config(self):
350
config_file = StringIO(sample_config_text.encode('utf-8'))
351
my_config = config.GlobalConfig()
352
my_config._parser = my_config._get_parser(file=config_file)
355
def test_gpg_signing_command(self):
356
my_config = self._get_sample_config()
357
self.assertEqual("gnome-gpg", my_config.gpg_signing_command())
358
self.assertEqual(False, my_config.signature_needed())
360
def _get_empty_config(self):
361
config_file = StringIO("")
362
my_config = config.GlobalConfig()
363
my_config._parser = my_config._get_parser(file=config_file)
366
def test_gpg_signing_command_unset(self):
367
my_config = self._get_empty_config()
368
self.assertEqual("gpg", my_config.gpg_signing_command())
370
def test_get_user_option_default(self):
371
my_config = self._get_empty_config()
372
self.assertEqual(None, my_config.get_user_option('no_option'))
374
def test_get_user_option_global(self):
375
my_config = self._get_sample_config()
376
self.assertEqual("something",
377
my_config.get_user_option('user_global_option'))
379
def test_post_commit_default(self):
380
my_config = self._get_sample_config()
381
self.assertEqual(None, my_config.post_commit())
383
def test_configured_logformat(self):
384
my_config = self._get_sample_config()
385
self.assertEqual("short", my_config.log_format())
387
def test_get_alias(self):
388
my_config = self._get_sample_config()
389
self.assertEqual('help', my_config.get_alias('h'))
391
def test_get_no_alias(self):
392
my_config = self._get_sample_config()
393
self.assertEqual(None, my_config.get_alias('foo'))
395
def test_get_long_alias(self):
396
my_config = self._get_sample_config()
397
self.assertEqual(sample_long_alias, my_config.get_alias('ll'))
399
class TestLocationConfig(TestCase):
401
def test_constructs(self):
402
my_config = config.LocationConfig('http://example.com')
403
self.assertRaises(TypeError, config.LocationConfig)
405
def test_branch_calls_read_filenames(self):
406
# This is testing the correct file names are provided.
407
# TODO: consolidate with the test for GlobalConfigs filename checks.
409
# replace the class that is constructured, to check its parameters
410
oldparserclass = config.ConfigObj
411
config.ConfigObj = InstrumentedConfigObj
412
my_config = config.LocationConfig('http://www.example.com')
414
parser = my_config._get_parser()
416
config.ConfigObj = oldparserclass
417
self.failUnless(isinstance(parser, InstrumentedConfigObj))
418
self.assertEqual(parser._calls,
419
[('__init__', config.branches_config_filename())])
421
def test_get_global_config(self):
422
my_config = config.LocationConfig('http://example.com')
423
global_config = my_config._get_global_config()
424
self.failUnless(isinstance(global_config, config.GlobalConfig))
425
self.failUnless(global_config is my_config._get_global_config())
427
def test__get_section_no_match(self):
428
self.get_location_config('/')
429
self.assertEqual(None, self.my_config._get_section())
431
def test__get_section_exact(self):
432
self.get_location_config('http://www.example.com')
433
self.assertEqual('http://www.example.com',
434
self.my_config._get_section())
436
def test__get_section_suffix_does_not(self):
437
self.get_location_config('http://www.example.com-com')
438
self.assertEqual(None, self.my_config._get_section())
440
def test__get_section_subdir_recursive(self):
441
self.get_location_config('http://www.example.com/com')
442
self.assertEqual('http://www.example.com',
443
self.my_config._get_section())
445
def test__get_section_subdir_matches(self):
446
self.get_location_config('http://www.example.com/useglobal')
447
self.assertEqual('http://www.example.com/useglobal',
448
self.my_config._get_section())
450
def test__get_section_subdir_nonrecursive(self):
451
self.get_location_config(
452
'http://www.example.com/useglobal/childbranch')
453
self.assertEqual('http://www.example.com',
454
self.my_config._get_section())
456
def test__get_section_subdir_trailing_slash(self):
457
self.get_location_config('/b')
458
self.assertEqual('/b/', self.my_config._get_section())
460
def test__get_section_subdir_child(self):
461
self.get_location_config('/a/foo')
462
self.assertEqual('/a/*', self.my_config._get_section())
464
def test__get_section_subdir_child_child(self):
465
self.get_location_config('/a/foo/bar')
466
self.assertEqual('/a/', self.my_config._get_section())
468
def test__get_section_trailing_slash_with_children(self):
469
self.get_location_config('/a/')
470
self.assertEqual('/a/', self.my_config._get_section())
472
def test__get_section_explicit_over_glob(self):
473
self.get_location_config('/a/c')
474
self.assertEqual('/a/c', self.my_config._get_section())
476
def get_location_config(self, location, global_config=None):
477
if global_config is None:
478
global_file = StringIO(sample_config_text)
480
global_file = StringIO(global_config)
481
branches_file = StringIO(sample_branches_text)
482
self.my_config = config.LocationConfig(location)
483
self.my_config._get_parser(branches_file)
484
self.my_config._get_global_config()._get_parser(global_file)
486
def test_location_without_username(self):
487
self.get_location_config('http://www.example.com/useglobal')
488
self.assertEqual('Robert Collins <robertc@example.com>',
489
self.my_config.username())
491
def test_location_not_listed(self):
492
self.get_location_config('/home/robertc/sources')
493
self.assertEqual('Robert Collins <robertc@example.com>',
494
self.my_config.username())
496
def test_overriding_location(self):
497
self.get_location_config('http://www.example.com/foo')
498
self.assertEqual('Robert Collins <robertc@example.org>',
499
self.my_config.username())
501
def test_signatures_not_set(self):
502
self.get_location_config('http://www.example.com',
503
global_config=sample_ignore_signatures)
504
self.assertEqual(config.CHECK_NEVER,
505
self.my_config.signature_checking())
507
def test_signatures_never(self):
508
self.get_location_config('/a/c')
509
self.assertEqual(config.CHECK_NEVER,
510
self.my_config.signature_checking())
512
def test_signatures_when_available(self):
513
self.get_location_config('/a/', global_config=sample_ignore_signatures)
514
self.assertEqual(config.CHECK_IF_POSSIBLE,
515
self.my_config.signature_checking())
517
def test_signatures_always(self):
518
self.get_location_config('/b')
519
self.assertEqual(config.CHECK_ALWAYS,
520
self.my_config.signature_checking())
522
def test_gpg_signing_command(self):
523
self.get_location_config('/b')
524
self.assertEqual("gnome-gpg", self.my_config.gpg_signing_command())
526
def test_gpg_signing_command_missing(self):
527
self.get_location_config('/a')
528
self.assertEqual("false", self.my_config.gpg_signing_command())
530
def test_get_user_option_global(self):
531
self.get_location_config('/a')
532
self.assertEqual('something',
533
self.my_config.get_user_option('user_global_option'))
535
def test_get_user_option_local(self):
536
self.get_location_config('/a')
537
self.assertEqual('local',
538
self.my_config.get_user_option('user_local_option'))
540
def test_post_commit_default(self):
541
self.get_location_config('/a/c')
542
self.assertEqual('bzrlib.tests.test_config.post_commit',
543
self.my_config.post_commit())
546
class TestLocationConfig(TestCaseInTempDir):
548
def get_location_config(self, location, global_config=None):
549
if global_config is None:
550
global_file = StringIO(sample_config_text.encode('utf-8'))
552
global_file = StringIO(global_config.encode('utf-8'))
553
branches_file = StringIO(sample_branches_text.encode('utf-8'))
554
self.my_config = config.LocationConfig(location)
555
self.my_config._get_parser(branches_file)
556
self.my_config._get_global_config()._get_parser(global_file)
558
def test_set_user_setting_sets_and_saves(self):
559
self.get_location_config('/a/c')
560
record = InstrumentedConfigObj("foo")
561
self.my_config._parser = record
563
real_mkdir = os.mkdir
565
def checked_mkdir(path, mode=0777):
566
self.log('making directory: %s', path)
567
real_mkdir(path, mode)
570
os.mkdir = checked_mkdir
572
self.my_config.set_user_option('foo', 'bar')
574
os.mkdir = real_mkdir
576
self.failUnless(self.created, 'Failed to create ~/.bazaar')
577
self.assertEqual([('__contains__', '/a/c'),
578
('__contains__', '/a/c/'),
579
('__setitem__', '/a/c', {}),
580
('__getitem__', '/a/c'),
581
('__setitem__', 'foo', 'bar'),
586
class TestBranchConfigItems(TestCase):
588
def test_user_id(self):
589
branch = FakeBranch()
590
my_config = config.BranchConfig(branch)
591
self.assertEqual("Robert Collins <robertc@example.net>",
592
my_config._get_user_id())
593
branch.control_files.email = "John"
594
self.assertEqual("John", my_config._get_user_id())
596
def test_not_set_in_branch(self):
597
branch = FakeBranch()
598
my_config = config.BranchConfig(branch)
599
branch.control_files.email = None
600
config_file = StringIO(sample_config_text.encode('utf-8'))
601
(my_config._get_location_config().
602
_get_global_config()._get_parser(config_file))
603
self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
604
my_config._get_user_id())
605
branch.control_files.email = "John"
606
self.assertEqual("John", my_config._get_user_id())
608
def test_BZREMAIL_OVERRIDES(self):
609
os.environ['BZREMAIL'] = "Robert Collins <robertc@example.org>"
610
branch = FakeBranch()
611
my_config = config.BranchConfig(branch)
612
self.assertEqual("Robert Collins <robertc@example.org>",
613
my_config.username())
615
def test_signatures_forced(self):
616
branch = FakeBranch()
617
my_config = config.BranchConfig(branch)
618
config_file = StringIO(sample_always_signatures)
619
(my_config._get_location_config().
620
_get_global_config()._get_parser(config_file))
621
self.assertEqual(config.CHECK_ALWAYS, my_config.signature_checking())
623
def test_gpg_signing_command(self):
624
branch = FakeBranch()
625
my_config = config.BranchConfig(branch)
626
config_file = StringIO(sample_config_text.encode('utf-8'))
627
(my_config._get_location_config().
628
_get_global_config()._get_parser(config_file))
629
self.assertEqual('gnome-gpg', my_config.gpg_signing_command())
631
def test_get_user_option_global(self):
632
branch = FakeBranch()
633
my_config = config.BranchConfig(branch)
634
config_file = StringIO(sample_config_text.encode('utf-8'))
635
(my_config._get_location_config().
636
_get_global_config()._get_parser(config_file))
637
self.assertEqual('something',
638
my_config.get_user_option('user_global_option'))
640
def test_post_commit_default(self):
641
branch = FakeBranch()
643
my_config = config.BranchConfig(branch)
644
config_file = StringIO(sample_config_text.encode('utf-8'))
645
(my_config._get_location_config().
646
_get_global_config()._get_parser(config_file))
647
branch_file = StringIO(sample_branches_text)
648
my_config._get_location_config()._get_parser(branch_file)
649
self.assertEqual('bzrlib.tests.test_config.post_commit',
650
my_config.post_commit())
653
class TestMailAddressExtraction(TestCase):
655
def test_extract_email_address(self):
656
self.assertEqual('jane@test.com',
657
config.extract_email_address('Jane <jane@test.com>'))
658
self.assertRaises(errors.BzrError,
659
config.extract_email_address, 'Jane Tester')
added
removed
bzrlib/tests/test_config.py
