~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_config.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-05-29 15:57:16 UTC
  • mfrom: (3427.5.9 dep_warnings)
  • Revision ID: pqm@pqm.ubuntu.com-20080529155716-0w3kic8lioa63231
(jam) Enable Deprecation Warnings when running -Werror and when
        running selftest

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 by Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
2
#   Authors: Robert Collins <robert.collins@canonical.com>
3
3
#
4
4
# This program is free software; you can redistribute it and/or modify
17
17
 
18
18
"""Tests for finding and reading the bzr config file[s]."""
19
19
# import system imports here
20
 
from bzrlib.util.configobj.configobj import ConfigObj, ConfigObjError
21
20
from cStringIO import StringIO
22
21
import os
23
22
import sys
24
23
 
25
24
#import bzrlib specific imports here
26
 
import bzrlib.config as config
27
 
import bzrlib.errors as errors
28
 
from bzrlib.tests import TestCase, TestCaseInTempDir
 
25
from bzrlib import (
 
26
    branch,
 
27
    bzrdir,
 
28
    config,
 
29
    errors,
 
30
    osutils,
 
31
    mail_client,
 
32
    ui,
 
33
    urlutils,
 
34
    tests,
 
35
    trace,
 
36
    transport,
 
37
    )
 
38
from bzrlib.util.configobj import configobj
29
39
 
30
40
 
31
41
sample_long_alias="log -r-15..-1 --line"
32
 
sample_config_text = ("[DEFAULT]\n"
33
 
                      u"email=Erik B\u00e5gfors <erik@bagfors.nu>\n"
34
 
                      "editor=vim\n"
35
 
                      "gpg_signing_command=gnome-gpg\n"
36
 
                      "log_format=short\n"
37
 
                      "user_global_option=something\n"
38
 
                      "[ALIASES]\n"
39
 
                      "h=help\n"
40
 
                      "ll=" + sample_long_alias + "\n")
41
 
 
42
 
 
43
 
sample_always_signatures = ("[DEFAULT]\n"
44
 
                            "check_signatures=require\n")
45
 
 
46
 
 
47
 
sample_ignore_signatures = ("[DEFAULT]\n"
48
 
                            "check_signatures=ignore\n")
49
 
 
50
 
 
51
 
sample_maybe_signatures = ("[DEFAULT]\n"
52
 
                            "check_signatures=check-available\n")
53
 
 
54
 
 
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"
60
 
                        "recurse=false\n"
61
 
                        "[/b/]\n"
62
 
                        "check_signatures=require\n"
63
 
                        "# test trailing / matching with no children\n"
64
 
                        "[/a/]\n"
65
 
                        "check_signatures=check-available\n"
66
 
                        "gpg_signing_command=false\n"
67
 
                        "user_local_option=local\n"
68
 
                        "# test trailing / matching\n"
69
 
                        "[/a/*]\n"
70
 
                        "#subdirs will match but not the parent\n"
71
 
                        "recurse=False\n"
72
 
                        "[/a/c]\n"
73
 
                        "check_signatures=ignore\n"
74
 
                        "post_commit=bzrlib.tests.test_config.post_commit\n"
75
 
                        "#testing explicit beats globs\n")
76
 
 
 
42
sample_config_text = u"""
 
43
[DEFAULT]
 
44
email=Erik B\u00e5gfors <erik@bagfors.nu>
 
45
editor=vim
 
46
gpg_signing_command=gnome-gpg
 
47
log_format=short
 
48
user_global_option=something
 
49
[ALIASES]
 
50
h=help
 
51
ll=""" + sample_long_alias + "\n"
 
52
 
 
53
 
 
54
sample_always_signatures = """
 
55
[DEFAULT]
 
56
check_signatures=ignore
 
57
create_signatures=always
 
58
"""
 
59
 
 
60
sample_ignore_signatures = """
 
61
[DEFAULT]
 
62
check_signatures=require
 
63
create_signatures=never
 
64
"""
 
65
 
 
66
sample_maybe_signatures = """
 
67
[DEFAULT]
 
68
check_signatures=ignore
 
69
create_signatures=when-required
 
70
"""
 
71
 
 
72
sample_branches_text = """
 
73
[http://www.example.com]
 
74
# Top level policy
 
75
email=Robert Collins <robertc@example.org>
 
76
normal_option = normal
 
77
appendpath_option = append
 
78
appendpath_option:policy = appendpath
 
79
norecurse_option = norecurse
 
80
norecurse_option:policy = norecurse
 
81
[http://www.example.com/ignoreparent]
 
82
# different project: ignore parent dir config
 
83
ignore_parents=true
 
84
[http://www.example.com/norecurse]
 
85
# configuration items that only apply to this dir
 
86
recurse=false
 
87
normal_option = norecurse
 
88
[http://www.example.com/dir]
 
89
appendpath_option = normal
 
90
[/b/]
 
91
check_signatures=require
 
92
# test trailing / matching with no children
 
93
[/a/]
 
94
check_signatures=check-available
 
95
gpg_signing_command=false
 
96
user_local_option=local
 
97
# test trailing / matching
 
98
[/a/*]
 
99
#subdirs will match but not the parent
 
100
[/a/c]
 
101
check_signatures=ignore
 
102
post_commit=bzrlib.tests.test_config.post_commit
 
103
#testing explicit beats globs
 
104
"""
77
105
 
78
106
 
79
107
class InstrumentedConfigObj(object):
93
121
    def __setitem__(self, key, value):
94
122
        self._calls.append(('__setitem__', key, value))
95
123
 
 
124
    def __delitem__(self, key):
 
125
        self._calls.append(('__delitem__', key))
 
126
 
 
127
    def keys(self):
 
128
        self._calls.append(('keys',))
 
129
        return []
 
130
 
96
131
    def write(self, arg):
97
132
        self._calls.append(('write',))
98
133
 
 
134
    def as_bool(self, value):
 
135
        self._calls.append(('as_bool', value))
 
136
        return False
 
137
 
 
138
    def get_value(self, section, name):
 
139
        self._calls.append(('get_value', section, name))
 
140
        return None
 
141
 
99
142
 
100
143
class FakeBranch(object):
101
144
 
102
 
    def __init__(self):
103
 
        self.base = "http://example.com/branches/demo"
104
 
        self.control_files = FakeControlFiles()
105
 
 
106
 
 
107
 
class FakeControlFiles(object):
108
 
 
109
 
    def __init__(self):
110
 
        self.email = 'Robert Collins <robertc@example.net>\n'
 
145
    def __init__(self, base=None, user_id=None):
 
146
        if base is None:
 
147
            self.base = "http://example.com/branches/demo"
 
148
        else:
 
149
            self.base = base
 
150
        self._transport = self.control_files = \
 
151
            FakeControlFilesAndTransport(user_id=user_id)
 
152
 
 
153
    def lock_write(self):
 
154
        pass
 
155
 
 
156
    def unlock(self):
 
157
        pass
 
158
 
 
159
 
 
160
class FakeControlFilesAndTransport(object):
 
161
 
 
162
    def __init__(self, user_id=None):
 
163
        self.files = {}
 
164
        if user_id:
 
165
            self.files['email'] = user_id
 
166
        self._transport = self
111
167
 
112
168
    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)
 
169
        # from LockableFiles
 
170
        raise AssertionError("get_utf8 should no longer be used")
 
171
 
 
172
    def get(self, filename):
 
173
        # from Transport
 
174
        try:
 
175
            return StringIO(self.files[filename])
 
176
        except KeyError:
 
177
            raise errors.NoSuchFile(filename)
 
178
 
 
179
    def get_bytes(self, filename):
 
180
        # from Transport
 
181
        try:
 
182
            return self.files[filename]
 
183
        except KeyError:
 
184
            raise errors.NoSuchFile(filename)
 
185
 
 
186
    def put(self, filename, fileobj):
 
187
        self.files[filename] = fileobj.read()
 
188
 
 
189
    def put_file(self, filename, fileobj):
 
190
        return self.put(filename, fileobj)
118
191
 
119
192
 
120
193
class InstrumentedConfig(config.Config):
121
194
    """An instrumented config that supplies stubs for template methods."""
122
 
    
 
195
 
123
196
    def __init__(self):
124
197
        super(InstrumentedConfig, self).__init__()
125
198
        self._calls = []
141
214
active = True
142
215
nonactive = False
143
216
"""
144
 
class TestConfigObj(TestCase):
 
217
 
 
218
 
 
219
class TestConfigObj(tests.TestCase):
 
220
 
145
221
    def test_get_bool(self):
146
 
        from bzrlib.config import ConfigObj
147
 
        co = ConfigObj(StringIO(bool_config))
 
222
        co = config.ConfigObj(StringIO(bool_config))
148
223
        self.assertIs(co.get_bool('DEFAULT', 'active'), True)
149
224
        self.assertIs(co.get_bool('DEFAULT', 'inactive'), False)
150
225
        self.assertIs(co.get_bool('UPPERCASE', 'active'), True)
151
226
        self.assertIs(co.get_bool('UPPERCASE', 'nonactive'), False)
152
227
 
153
 
 
154
 
class TestConfig(TestCase):
 
228
    def test_hash_sign_in_value(self):
 
229
        """
 
230
        Before 4.5.0, ConfigObj did not quote # signs in values, so they'd be
 
231
        treated as comments when read in again. (#86838)
 
232
        """
 
233
        co = config.ConfigObj()
 
234
        co['test'] = 'foo#bar'
 
235
        lines = co.write()
 
236
        self.assertEqual(lines, ['test = "foo#bar"'])
 
237
        co2 = config.ConfigObj(lines)
 
238
        self.assertEqual(co2['test'], 'foo#bar')
 
239
 
 
240
 
 
241
erroneous_config = """[section] # line 1
 
242
good=good # line 2
 
243
[section] # line 3
 
244
whocares=notme # line 4
 
245
"""
 
246
 
 
247
 
 
248
class TestConfigObjErrors(tests.TestCase):
 
249
 
 
250
    def test_duplicate_section_name_error_line(self):
 
251
        try:
 
252
            co = configobj.ConfigObj(StringIO(erroneous_config),
 
253
                                     raise_errors=True)
 
254
        except config.configobj.DuplicateError, e:
 
255
            self.assertEqual(3, e.line_number)
 
256
        else:
 
257
            self.fail('Error in config file not detected')
 
258
 
 
259
 
 
260
class TestConfig(tests.TestCase):
155
261
 
156
262
    def test_constructs(self):
157
263
        config.Config()
158
 
 
 
264
 
159
265
    def test_no_default_editor(self):
160
266
        self.assertRaises(NotImplementedError, config.Config().get_editor)
161
267
 
172
278
 
173
279
    def test_signatures_default(self):
174
280
        my_config = config.Config()
 
281
        self.assertFalse(my_config.signature_needed())
175
282
        self.assertEqual(config.CHECK_IF_POSSIBLE,
176
283
                         my_config.signature_checking())
 
284
        self.assertEqual(config.SIGN_WHEN_REQUIRED,
 
285
                         my_config.signing_policy())
177
286
 
178
287
    def test_signatures_template_method(self):
179
288
        my_config = InstrumentedConfig()
204
313
        self.assertEqual('long', my_config.log_format())
205
314
 
206
315
 
207
 
class TestConfigPath(TestCase):
 
316
class TestConfigPath(tests.TestCase):
208
317
 
209
318
    def setUp(self):
210
319
        super(TestConfigPath, self).setUp()
211
 
        self.old_home = os.environ.get('HOME', None)
212
 
        self.old_appdata = os.environ.get('APPDATA', None)
213
320
        os.environ['HOME'] = '/home/bogus'
214
 
        os.environ['APPDATA'] = \
215
 
            r'C:\Documents and Settings\bogus\Application Data'
 
321
        if sys.platform == 'win32':
 
322
            os.environ['BZR_HOME'] = \
 
323
                r'C:\Documents and Settings\bogus\Application Data'
 
324
            self.bzr_home = \
 
325
                'C:/Documents and Settings/bogus/Application Data/bazaar/2.0'
 
326
        else:
 
327
            self.bzr_home = '/home/bogus/.bazaar'
216
328
 
217
 
    def tearDown(self):
218
 
        if self.old_home is None:
219
 
            del os.environ['HOME']
220
 
        else:
221
 
            os.environ['HOME'] = self.old_home
222
 
        if self.old_appdata is None:
223
 
            del os.environ['APPDATA']
224
 
        else:
225
 
            os.environ['APPDATA'] = self.old_appdata
226
 
        super(TestConfigPath, self).tearDown()
227
 
    
228
329
    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')
232
 
        else:
233
 
            self.assertEqual(config.config_dir(), '/home/bogus/.bazaar')
 
330
        self.assertEqual(config.config_dir(), self.bzr_home)
234
331
 
235
332
    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')
239
 
        else:
240
 
            self.assertEqual(config.config_filename(),
241
 
                             '/home/bogus/.bazaar/bazaar.conf')
 
333
        self.assertEqual(config.config_filename(),
 
334
                         self.bzr_home + '/bazaar.conf')
242
335
 
243
336
    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')
247
 
        else:
248
 
            self.assertEqual(config.branches_config_filename(),
249
 
                             '/home/bogus/.bazaar/branches.conf')
250
 
 
251
 
class TestIniConfig(TestCase):
 
337
        self.assertEqual(config.branches_config_filename(),
 
338
                         self.bzr_home + '/branches.conf')
 
339
 
 
340
    def test_locations_config_filename(self):
 
341
        self.assertEqual(config.locations_config_filename(),
 
342
                         self.bzr_home + '/locations.conf')
 
343
 
 
344
    def test_authentication_config_filename(self):
 
345
        self.assertEqual(config.authentication_config_filename(),
 
346
                         self.bzr_home + '/authentication.conf')
 
347
 
 
348
 
 
349
class TestIniConfig(tests.TestCase):
252
350
 
253
351
    def test_contructs(self):
254
352
        my_config = config.IniBasedConfig("nothing")
258
356
        my_config = config.IniBasedConfig(None)
259
357
        self.failUnless(
260
358
            isinstance(my_config._get_parser(file=config_file),
261
 
                        ConfigObj))
 
359
                        configobj.ConfigObj))
262
360
 
263
361
    def test_cached(self):
264
362
        config_file = StringIO(sample_config_text.encode('utf-8'))
267
365
        self.failUnless(my_config._get_parser() is parser)
268
366
 
269
367
 
270
 
class TestGetConfig(TestCase):
 
368
class TestGetConfig(tests.TestCase):
271
369
 
272
370
    def test_constructs(self):
273
371
        my_config = config.GlobalConfig()
274
372
 
275
373
    def test_calls_read_filenames(self):
276
 
        # replace the class that is constructured, to check its parameters
 
374
        # replace the class that is constructed, to check its parameters
277
375
        oldparserclass = config.ConfigObj
278
376
        config.ConfigObj = InstrumentedConfigObj
279
377
        my_config = config.GlobalConfig()
286
384
                                          'utf-8')])
287
385
 
288
386
 
289
 
class TestBranchConfig(TestCaseInTempDir):
 
387
class TestBranchConfig(tests.TestCaseWithTransport):
290
388
 
291
389
    def test_constructs(self):
292
390
        branch = FakeBranch()
300
398
        self.assertEqual(branch.base, location_config.location)
301
399
        self.failUnless(location_config is my_config._get_location_config())
302
400
 
303
 
 
304
 
class TestGlobalConfigItems(TestCase):
 
401
    def test_get_config(self):
 
402
        """The Branch.get_config method works properly"""
 
403
        b = bzrdir.BzrDir.create_standalone_workingtree('.').branch
 
404
        my_config = b.get_config()
 
405
        self.assertIs(my_config.get_user_option('wacky'), None)
 
406
        my_config.set_user_option('wacky', 'unlikely')
 
407
        self.assertEqual(my_config.get_user_option('wacky'), 'unlikely')
 
408
 
 
409
        # Ensure we get the same thing if we start again
 
410
        b2 = branch.Branch.open('.')
 
411
        my_config2 = b2.get_config()
 
412
        self.assertEqual(my_config2.get_user_option('wacky'), 'unlikely')
 
413
 
 
414
    def test_has_explicit_nickname(self):
 
415
        b = self.make_branch('.')
 
416
        self.assertFalse(b.get_config().has_explicit_nickname())
 
417
        b.nick = 'foo'
 
418
        self.assertTrue(b.get_config().has_explicit_nickname())
 
419
 
 
420
    def test_config_url(self):
 
421
        """The Branch.get_config will use section that uses a local url"""
 
422
        branch = self.make_branch('branch')
 
423
        self.assertEqual('branch', branch.nick)
 
424
 
 
425
        locations = config.locations_config_filename()
 
426
        config.ensure_config_dir_exists()
 
427
        local_url = urlutils.local_path_to_url('branch')
 
428
        open(locations, 'wb').write('[%s]\nnickname = foobar' 
 
429
                                    % (local_url,))
 
430
        self.assertEqual('foobar', branch.nick)
 
431
 
 
432
    def test_config_local_path(self):
 
433
        """The Branch.get_config will use a local system path"""
 
434
        branch = self.make_branch('branch')
 
435
        self.assertEqual('branch', branch.nick)
 
436
 
 
437
        locations = config.locations_config_filename()
 
438
        config.ensure_config_dir_exists()
 
439
        open(locations, 'wb').write('[%s/branch]\nnickname = barry' 
 
440
                                    % (osutils.getcwd().encode('utf8'),))
 
441
        self.assertEqual('barry', branch.nick)
 
442
 
 
443
    def test_config_creates_local(self):
 
444
        """Creating a new entry in config uses a local path."""
 
445
        branch = self.make_branch('branch', format='knit')
 
446
        branch.set_push_location('http://foobar')
 
447
        locations = config.locations_config_filename()
 
448
        local_path = osutils.getcwd().encode('utf8')
 
449
        # Surprisingly ConfigObj doesn't create a trailing newline
 
450
        self.check_file_contents(locations,
 
451
                                 '[%s/branch]\n'
 
452
                                 'push_location = http://foobar\n'
 
453
                                 'push_location:policy = norecurse\n'
 
454
                                 % (local_path,))
 
455
 
 
456
    def test_autonick_urlencoded(self):
 
457
        b = self.make_branch('!repo')
 
458
        self.assertEqual('!repo', b.get_config().get_nickname())
 
459
 
 
460
    def test_warn_if_masked(self):
 
461
        _warning = trace.warning
 
462
        warnings = []
 
463
        def warning(*args):
 
464
            warnings.append(args[0] % args[1:])
 
465
 
 
466
        def set_option(store, warn_masked=True):
 
467
            warnings[:] = []
 
468
            conf.set_user_option('example_option', repr(store), store=store,
 
469
                                 warn_masked=warn_masked)
 
470
        def assertWarning(warning):
 
471
            if warning is None:
 
472
                self.assertEqual(0, len(warnings))
 
473
            else:
 
474
                self.assertEqual(1, len(warnings))
 
475
                self.assertEqual(warning, warnings[0])
 
476
        trace.warning = warning
 
477
        try:
 
478
            branch = self.make_branch('.')
 
479
            conf = branch.get_config()
 
480
            set_option(config.STORE_GLOBAL)
 
481
            assertWarning(None)
 
482
            set_option(config.STORE_BRANCH)
 
483
            assertWarning(None)
 
484
            set_option(config.STORE_GLOBAL)
 
485
            assertWarning('Value "4" is masked by "3" from branch.conf')
 
486
            set_option(config.STORE_GLOBAL, warn_masked=False)
 
487
            assertWarning(None)
 
488
            set_option(config.STORE_LOCATION)
 
489
            assertWarning(None)
 
490
            set_option(config.STORE_BRANCH)
 
491
            assertWarning('Value "3" is masked by "0" from locations.conf')
 
492
            set_option(config.STORE_BRANCH, warn_masked=False)
 
493
            assertWarning(None)
 
494
        finally:
 
495
            trace.warning = _warning
 
496
 
 
497
 
 
498
class TestGlobalConfigItems(tests.TestCase):
305
499
 
306
500
    def test_user_id(self):
307
501
        config_file = StringIO(sample_config_text.encode('utf-8'))
326
520
        config_file = StringIO(sample_always_signatures)
327
521
        my_config = config.GlobalConfig()
328
522
        my_config._parser = my_config._get_parser(file=config_file)
329
 
        self.assertEqual(config.CHECK_ALWAYS,
 
523
        self.assertEqual(config.CHECK_NEVER,
330
524
                         my_config.signature_checking())
 
525
        self.assertEqual(config.SIGN_ALWAYS,
 
526
                         my_config.signing_policy())
331
527
        self.assertEqual(True, my_config.signature_needed())
332
528
 
333
529
    def test_signatures_if_possible(self):
334
530
        config_file = StringIO(sample_maybe_signatures)
335
531
        my_config = config.GlobalConfig()
336
532
        my_config._parser = my_config._get_parser(file=config_file)
337
 
        self.assertEqual(config.CHECK_IF_POSSIBLE,
 
533
        self.assertEqual(config.CHECK_NEVER,
338
534
                         my_config.signature_checking())
 
535
        self.assertEqual(config.SIGN_WHEN_REQUIRED,
 
536
                         my_config.signing_policy())
339
537
        self.assertEqual(False, my_config.signature_needed())
340
538
 
341
539
    def test_signatures_ignore(self):
342
540
        config_file = StringIO(sample_ignore_signatures)
343
541
        my_config = config.GlobalConfig()
344
542
        my_config._parser = my_config._get_parser(file=config_file)
345
 
        self.assertEqual(config.CHECK_NEVER,
 
543
        self.assertEqual(config.CHECK_ALWAYS,
346
544
                         my_config.signature_checking())
 
545
        self.assertEqual(config.SIGN_NEVER,
 
546
                         my_config.signing_policy())
347
547
        self.assertEqual(False, my_config.signature_needed())
348
548
 
349
549
    def _get_sample_config(self):
375
575
        my_config = self._get_sample_config()
376
576
        self.assertEqual("something",
377
577
                         my_config.get_user_option('user_global_option'))
378
 
        
 
578
 
379
579
    def test_post_commit_default(self):
380
580
        my_config = self._get_sample_config()
381
581
        self.assertEqual(None, my_config.post_commit())
396
596
        my_config = self._get_sample_config()
397
597
        self.assertEqual(sample_long_alias, my_config.get_alias('ll'))
398
598
 
399
 
class TestLocationConfig(TestCase):
 
599
 
 
600
class TestLocationConfig(tests.TestCaseInTempDir):
400
601
 
401
602
    def test_constructs(self):
402
603
        my_config = config.LocationConfig('http://example.com')
406
607
        # This is testing the correct file names are provided.
407
608
        # TODO: consolidate with the test for GlobalConfigs filename checks.
408
609
        #
409
 
        # replace the class that is constructured, to check its parameters
 
610
        # replace the class that is constructed, to check its parameters
410
611
        oldparserclass = config.ConfigObj
411
612
        config.ConfigObj = InstrumentedConfigObj
412
 
        my_config = config.LocationConfig('http://www.example.com')
413
613
        try:
 
614
            my_config = config.LocationConfig('http://www.example.com')
414
615
            parser = my_config._get_parser()
415
616
        finally:
416
617
            config.ConfigObj = oldparserclass
417
618
        self.failUnless(isinstance(parser, InstrumentedConfigObj))
418
619
        self.assertEqual(parser._calls,
419
 
                         [('__init__', config.branches_config_filename())])
 
620
                         [('__init__', config.locations_config_filename(),
 
621
                           'utf-8')])
 
622
        config.ensure_config_dir_exists()
 
623
        #os.mkdir(config.config_dir())
 
624
        f = file(config.branches_config_filename(), 'wb')
 
625
        f.write('')
 
626
        f.close()
 
627
        oldparserclass = config.ConfigObj
 
628
        config.ConfigObj = InstrumentedConfigObj
 
629
        try:
 
630
            my_config = config.LocationConfig('http://www.example.com')
 
631
            parser = my_config._get_parser()
 
632
        finally:
 
633
            config.ConfigObj = oldparserclass
420
634
 
421
635
    def test_get_global_config(self):
422
 
        my_config = config.LocationConfig('http://example.com')
 
636
        my_config = config.BranchConfig(FakeBranch('http://example.com'))
423
637
        global_config = my_config._get_global_config()
424
638
        self.failUnless(isinstance(global_config, config.GlobalConfig))
425
639
        self.failUnless(global_config is my_config._get_global_config())
426
640
 
427
 
    def test__get_section_no_match(self):
428
 
        self.get_location_config('/')
429
 
        self.assertEqual(None, self.my_config._get_section())
430
 
        
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())
435
 
   
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())
439
 
 
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())
444
 
 
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())
449
 
 
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())
455
 
 
456
 
    def test__get_section_subdir_trailing_slash(self):
457
 
        self.get_location_config('/b')
458
 
        self.assertEqual('/b/', self.my_config._get_section())
459
 
 
460
 
    def test__get_section_subdir_child(self):
461
 
        self.get_location_config('/a/foo')
462
 
        self.assertEqual('/a/*', self.my_config._get_section())
463
 
 
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())
467
 
 
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())
471
 
 
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())
475
 
 
476
 
    def get_location_config(self, location, global_config=None):
477
 
        if global_config is None:
478
 
            global_file = StringIO(sample_config_text)
479
 
        else:
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)
 
641
    def test__get_matching_sections_no_match(self):
 
642
        self.get_branch_config('/')
 
643
        self.assertEqual([], self.my_location_config._get_matching_sections())
 
644
 
 
645
    def test__get_matching_sections_exact(self):
 
646
        self.get_branch_config('http://www.example.com')
 
647
        self.assertEqual([('http://www.example.com', '')],
 
648
                         self.my_location_config._get_matching_sections())
 
649
 
 
650
    def test__get_matching_sections_suffix_does_not(self):
 
651
        self.get_branch_config('http://www.example.com-com')
 
652
        self.assertEqual([], self.my_location_config._get_matching_sections())
 
653
 
 
654
    def test__get_matching_sections_subdir_recursive(self):
 
655
        self.get_branch_config('http://www.example.com/com')
 
656
        self.assertEqual([('http://www.example.com', 'com')],
 
657
                         self.my_location_config._get_matching_sections())
 
658
 
 
659
    def test__get_matching_sections_ignoreparent(self):
 
660
        self.get_branch_config('http://www.example.com/ignoreparent')
 
661
        self.assertEqual([('http://www.example.com/ignoreparent', '')],
 
662
                         self.my_location_config._get_matching_sections())
 
663
 
 
664
    def test__get_matching_sections_ignoreparent_subdir(self):
 
665
        self.get_branch_config(
 
666
            'http://www.example.com/ignoreparent/childbranch')
 
667
        self.assertEqual([('http://www.example.com/ignoreparent',
 
668
                           'childbranch')],
 
669
                         self.my_location_config._get_matching_sections())
 
670
 
 
671
    def test__get_matching_sections_subdir_trailing_slash(self):
 
672
        self.get_branch_config('/b')
 
673
        self.assertEqual([('/b/', '')],
 
674
                         self.my_location_config._get_matching_sections())
 
675
 
 
676
    def test__get_matching_sections_subdir_child(self):
 
677
        self.get_branch_config('/a/foo')
 
678
        self.assertEqual([('/a/*', ''), ('/a/', 'foo')],
 
679
                         self.my_location_config._get_matching_sections())
 
680
 
 
681
    def test__get_matching_sections_subdir_child_child(self):
 
682
        self.get_branch_config('/a/foo/bar')
 
683
        self.assertEqual([('/a/*', 'bar'), ('/a/', 'foo/bar')],
 
684
                         self.my_location_config._get_matching_sections())
 
685
 
 
686
    def test__get_matching_sections_trailing_slash_with_children(self):
 
687
        self.get_branch_config('/a/')
 
688
        self.assertEqual([('/a/', '')],
 
689
                         self.my_location_config._get_matching_sections())
 
690
 
 
691
    def test__get_matching_sections_explicit_over_glob(self):
 
692
        # XXX: 2006-09-08 jamesh
 
693
        # This test only passes because ord('c') > ord('*').  If there
 
694
        # was a config section for '/a/?', it would get precedence
 
695
        # over '/a/c'.
 
696
        self.get_branch_config('/a/c')
 
697
        self.assertEqual([('/a/c', ''), ('/a/*', ''), ('/a/', 'c')],
 
698
                         self.my_location_config._get_matching_sections())
 
699
 
 
700
    def test__get_option_policy_normal(self):
 
701
        self.get_branch_config('http://www.example.com')
 
702
        self.assertEqual(
 
703
            self.my_location_config._get_config_policy(
 
704
            'http://www.example.com', 'normal_option'),
 
705
            config.POLICY_NONE)
 
706
 
 
707
    def test__get_option_policy_norecurse(self):
 
708
        self.get_branch_config('http://www.example.com')
 
709
        self.assertEqual(
 
710
            self.my_location_config._get_option_policy(
 
711
            'http://www.example.com', 'norecurse_option'),
 
712
            config.POLICY_NORECURSE)
 
713
        # Test old recurse=False setting:
 
714
        self.assertEqual(
 
715
            self.my_location_config._get_option_policy(
 
716
            'http://www.example.com/norecurse', 'normal_option'),
 
717
            config.POLICY_NORECURSE)
 
718
 
 
719
    def test__get_option_policy_normal(self):
 
720
        self.get_branch_config('http://www.example.com')
 
721
        self.assertEqual(
 
722
            self.my_location_config._get_option_policy(
 
723
            'http://www.example.com', 'appendpath_option'),
 
724
            config.POLICY_APPENDPATH)
485
725
 
486
726
    def test_location_without_username(self):
487
 
        self.get_location_config('http://www.example.com/useglobal')
488
 
        self.assertEqual('Robert Collins <robertc@example.com>',
 
727
        self.get_branch_config('http://www.example.com/ignoreparent')
 
728
        self.assertEqual(u'Erik B\u00e5gfors <erik@bagfors.nu>',
489
729
                         self.my_config.username())
490
730
 
491
731
    def test_location_not_listed(self):
492
 
        self.get_location_config('/home/robertc/sources')
493
 
        self.assertEqual('Robert Collins <robertc@example.com>',
 
732
        """Test that the global username is used when no location matches"""
 
733
        self.get_branch_config('/home/robertc/sources')
 
734
        self.assertEqual(u'Erik B\u00e5gfors <erik@bagfors.nu>',
494
735
                         self.my_config.username())
495
736
 
496
737
    def test_overriding_location(self):
497
 
        self.get_location_config('http://www.example.com/foo')
 
738
        self.get_branch_config('http://www.example.com/foo')
498
739
        self.assertEqual('Robert Collins <robertc@example.org>',
499
740
                         self.my_config.username())
500
741
 
501
742
    def test_signatures_not_set(self):
502
 
        self.get_location_config('http://www.example.com',
 
743
        self.get_branch_config('http://www.example.com',
503
744
                                 global_config=sample_ignore_signatures)
504
 
        self.assertEqual(config.CHECK_NEVER,
 
745
        self.assertEqual(config.CHECK_ALWAYS,
505
746
                         self.my_config.signature_checking())
 
747
        self.assertEqual(config.SIGN_NEVER,
 
748
                         self.my_config.signing_policy())
506
749
 
507
750
    def test_signatures_never(self):
508
 
        self.get_location_config('/a/c')
 
751
        self.get_branch_config('/a/c')
509
752
        self.assertEqual(config.CHECK_NEVER,
510
753
                         self.my_config.signature_checking())
511
 
        
 
754
 
512
755
    def test_signatures_when_available(self):
513
 
        self.get_location_config('/a/', global_config=sample_ignore_signatures)
 
756
        self.get_branch_config('/a/', global_config=sample_ignore_signatures)
514
757
        self.assertEqual(config.CHECK_IF_POSSIBLE,
515
758
                         self.my_config.signature_checking())
516
 
        
 
759
 
517
760
    def test_signatures_always(self):
518
 
        self.get_location_config('/b')
 
761
        self.get_branch_config('/b')
519
762
        self.assertEqual(config.CHECK_ALWAYS,
520
763
                         self.my_config.signature_checking())
521
 
        
 
764
 
522
765
    def test_gpg_signing_command(self):
523
 
        self.get_location_config('/b')
 
766
        self.get_branch_config('/b')
524
767
        self.assertEqual("gnome-gpg", self.my_config.gpg_signing_command())
525
768
 
526
769
    def test_gpg_signing_command_missing(self):
527
 
        self.get_location_config('/a')
 
770
        self.get_branch_config('/a')
528
771
        self.assertEqual("false", self.my_config.gpg_signing_command())
529
772
 
530
773
    def test_get_user_option_global(self):
531
 
        self.get_location_config('/a')
 
774
        self.get_branch_config('/a')
532
775
        self.assertEqual('something',
533
776
                         self.my_config.get_user_option('user_global_option'))
534
777
 
535
778
    def test_get_user_option_local(self):
536
 
        self.get_location_config('/a')
 
779
        self.get_branch_config('/a')
537
780
        self.assertEqual('local',
538
781
                         self.my_config.get_user_option('user_local_option'))
539
 
        
 
782
 
 
783
    def test_get_user_option_appendpath(self):
 
784
        # returned as is for the base path:
 
785
        self.get_branch_config('http://www.example.com')
 
786
        self.assertEqual('append',
 
787
                         self.my_config.get_user_option('appendpath_option'))
 
788
        # Extra path components get appended:
 
789
        self.get_branch_config('http://www.example.com/a/b/c')
 
790
        self.assertEqual('append/a/b/c',
 
791
                         self.my_config.get_user_option('appendpath_option'))
 
792
        # Overriden for http://www.example.com/dir, where it is a
 
793
        # normal option:
 
794
        self.get_branch_config('http://www.example.com/dir/a/b/c')
 
795
        self.assertEqual('normal',
 
796
                         self.my_config.get_user_option('appendpath_option'))
 
797
 
 
798
    def test_get_user_option_norecurse(self):
 
799
        self.get_branch_config('http://www.example.com')
 
800
        self.assertEqual('norecurse',
 
801
                         self.my_config.get_user_option('norecurse_option'))
 
802
        self.get_branch_config('http://www.example.com/dir')
 
803
        self.assertEqual(None,
 
804
                         self.my_config.get_user_option('norecurse_option'))
 
805
        # http://www.example.com/norecurse is a recurse=False section
 
806
        # that redefines normal_option.  Subdirectories do not pick up
 
807
        # this redefinition.
 
808
        self.get_branch_config('http://www.example.com/norecurse')
 
809
        self.assertEqual('norecurse',
 
810
                         self.my_config.get_user_option('normal_option'))
 
811
        self.get_branch_config('http://www.example.com/norecurse/subdir')
 
812
        self.assertEqual('normal',
 
813
                         self.my_config.get_user_option('normal_option'))
 
814
 
 
815
    def test_set_user_option_norecurse(self):
 
816
        self.get_branch_config('http://www.example.com')
 
817
        self.my_config.set_user_option('foo', 'bar',
 
818
                                       store=config.STORE_LOCATION_NORECURSE)
 
819
        self.assertEqual(
 
820
            self.my_location_config._get_option_policy(
 
821
            'http://www.example.com', 'foo'),
 
822
            config.POLICY_NORECURSE)
 
823
 
 
824
    def test_set_user_option_appendpath(self):
 
825
        self.get_branch_config('http://www.example.com')
 
826
        self.my_config.set_user_option('foo', 'bar',
 
827
                                       store=config.STORE_LOCATION_APPENDPATH)
 
828
        self.assertEqual(
 
829
            self.my_location_config._get_option_policy(
 
830
            'http://www.example.com', 'foo'),
 
831
            config.POLICY_APPENDPATH)
 
832
 
 
833
    def test_set_user_option_change_policy(self):
 
834
        self.get_branch_config('http://www.example.com')
 
835
        self.my_config.set_user_option('norecurse_option', 'normal',
 
836
                                       store=config.STORE_LOCATION)
 
837
        self.assertEqual(
 
838
            self.my_location_config._get_option_policy(
 
839
            'http://www.example.com', 'norecurse_option'),
 
840
            config.POLICY_NONE)
 
841
 
 
842
    def test_set_user_option_recurse_false_section(self):
 
843
        # The following section has recurse=False set.  The test is to
 
844
        # make sure that a normal option can be added to the section,
 
845
        # converting recurse=False to the norecurse policy.
 
846
        self.get_branch_config('http://www.example.com/norecurse')
 
847
        self.callDeprecated(['The recurse option is deprecated as of 0.14.  '
 
848
                             'The section "http://www.example.com/norecurse" '
 
849
                             'has been converted to use policies.'],
 
850
                            self.my_config.set_user_option,
 
851
                            'foo', 'bar', store=config.STORE_LOCATION)
 
852
        self.assertEqual(
 
853
            self.my_location_config._get_option_policy(
 
854
            'http://www.example.com/norecurse', 'foo'),
 
855
            config.POLICY_NONE)
 
856
        # The previously existing option is still norecurse:
 
857
        self.assertEqual(
 
858
            self.my_location_config._get_option_policy(
 
859
            'http://www.example.com/norecurse', 'normal_option'),
 
860
            config.POLICY_NORECURSE)
 
861
 
540
862
    def test_post_commit_default(self):
541
 
        self.get_location_config('/a/c')
 
863
        self.get_branch_config('/a/c')
542
864
        self.assertEqual('bzrlib.tests.test_config.post_commit',
543
865
                         self.my_config.post_commit())
544
866
 
545
 
 
546
 
class TestLocationConfig(TestCaseInTempDir):
547
 
 
548
 
    def get_location_config(self, location, global_config=None):
 
867
    def get_branch_config(self, location, global_config=None):
549
868
        if global_config is None:
550
869
            global_file = StringIO(sample_config_text.encode('utf-8'))
551
870
        else:
552
871
            global_file = StringIO(global_config.encode('utf-8'))
553
872
        branches_file = StringIO(sample_branches_text.encode('utf-8'))
554
 
        self.my_config = config.LocationConfig(location)
555
 
        self.my_config._get_parser(branches_file)
 
873
        self.my_config = config.BranchConfig(FakeBranch(location))
 
874
        # Force location config to use specified file
 
875
        self.my_location_config = self.my_config._get_location_config()
 
876
        self.my_location_config._get_parser(branches_file)
 
877
        # Force global config to use specified file
556
878
        self.my_config._get_global_config()._get_parser(global_file)
557
879
 
558
880
    def test_set_user_setting_sets_and_saves(self):
559
 
        self.get_location_config('/a/c')
 
881
        self.get_branch_config('/a/c')
560
882
        record = InstrumentedConfigObj("foo")
561
 
        self.my_config._parser = record
 
883
        self.my_location_config._parser = record
562
884
 
563
885
        real_mkdir = os.mkdir
564
886
        self.created = False
569
891
 
570
892
        os.mkdir = checked_mkdir
571
893
        try:
572
 
            self.my_config.set_user_option('foo', 'bar')
 
894
            self.callDeprecated(['The recurse option is deprecated as of '
 
895
                                 '0.14.  The section "/a/c" has been '
 
896
                                 'converted to use policies.'],
 
897
                                self.my_config.set_user_option,
 
898
                                'foo', 'bar', store=config.STORE_LOCATION)
573
899
        finally:
574
900
            os.mkdir = real_mkdir
575
901
 
579
905
                          ('__setitem__', '/a/c', {}),
580
906
                          ('__getitem__', '/a/c'),
581
907
                          ('__setitem__', 'foo', 'bar'),
 
908
                          ('__getitem__', '/a/c'),
 
909
                          ('as_bool', 'recurse'),
 
910
                          ('__getitem__', '/a/c'),
 
911
                          ('__delitem__', 'recurse'),
 
912
                          ('__getitem__', '/a/c'),
 
913
                          ('keys',),
 
914
                          ('__getitem__', '/a/c'),
 
915
                          ('__contains__', 'foo:policy'),
582
916
                          ('write',)],
583
917
                         record._calls[1:])
584
918
 
585
 
 
586
 
class TestBranchConfigItems(TestCase):
 
919
    def test_set_user_setting_sets_and_saves2(self):
 
920
        self.get_branch_config('/a/c')
 
921
        self.assertIs(self.my_config.get_user_option('foo'), None)
 
922
        self.my_config.set_user_option('foo', 'bar')
 
923
        self.assertEqual(
 
924
            self.my_config.branch.control_files.files['branch.conf'],
 
925
            'foo = bar\n')
 
926
        self.assertEqual(self.my_config.get_user_option('foo'), 'bar')
 
927
        self.my_config.set_user_option('foo', 'baz',
 
928
                                       store=config.STORE_LOCATION)
 
929
        self.assertEqual(self.my_config.get_user_option('foo'), 'baz')
 
930
        self.my_config.set_user_option('foo', 'qux')
 
931
        self.assertEqual(self.my_config.get_user_option('foo'), 'baz')
 
932
 
 
933
    def test_get_bzr_remote_path(self):
 
934
        my_config = config.LocationConfig('/a/c')
 
935
        self.assertEqual('bzr', my_config.get_bzr_remote_path())
 
936
        my_config.set_user_option('bzr_remote_path', '/path-bzr')
 
937
        self.assertEqual('/path-bzr', my_config.get_bzr_remote_path())
 
938
        os.environ['BZR_REMOTE_PATH'] = '/environ-bzr'
 
939
        self.assertEqual('/environ-bzr', my_config.get_bzr_remote_path())
 
940
 
 
941
 
 
942
precedence_global = 'option = global'
 
943
precedence_branch = 'option = branch'
 
944
precedence_location = """
 
945
[http://]
 
946
recurse = true
 
947
option = recurse
 
948
[http://example.com/specific]
 
949
option = exact
 
950
"""
 
951
 
 
952
 
 
953
class TestBranchConfigItems(tests.TestCaseInTempDir):
 
954
 
 
955
    def get_branch_config(self, global_config=None, location=None,
 
956
                          location_config=None, branch_data_config=None):
 
957
        my_config = config.BranchConfig(FakeBranch(location))
 
958
        if global_config is not None:
 
959
            global_file = StringIO(global_config.encode('utf-8'))
 
960
            my_config._get_global_config()._get_parser(global_file)
 
961
        self.my_location_config = my_config._get_location_config()
 
962
        if location_config is not None:
 
963
            location_file = StringIO(location_config.encode('utf-8'))
 
964
            self.my_location_config._get_parser(location_file)
 
965
        if branch_data_config is not None:
 
966
            my_config.branch.control_files.files['branch.conf'] = \
 
967
                branch_data_config
 
968
        return my_config
587
969
 
588
970
    def test_user_id(self):
589
 
        branch = FakeBranch()
 
971
        branch = FakeBranch(user_id='Robert Collins <robertc@example.net>')
590
972
        my_config = config.BranchConfig(branch)
591
973
        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())
 
974
                         my_config.username())
 
975
        my_config.branch.control_files.files['email'] = "John"
 
976
        my_config.set_user_option('email',
 
977
                                  "Robert Collins <robertc@example.org>")
 
978
        self.assertEqual("John", my_config.username())
 
979
        del my_config.branch.control_files.files['email']
 
980
        self.assertEqual("Robert Collins <robertc@example.org>",
 
981
                         my_config.username())
595
982
 
596
983
    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))
 
984
        my_config = self.get_branch_config(sample_config_text)
603
985
        self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
604
986
                         my_config._get_user_id())
605
 
        branch.control_files.email = "John"
 
987
        my_config.branch.control_files.files['email'] = "John"
606
988
        self.assertEqual("John", my_config._get_user_id())
607
989
 
608
 
    def test_BZREMAIL_OVERRIDES(self):
609
 
        os.environ['BZREMAIL'] = "Robert Collins <robertc@example.org>"
 
990
    def test_BZR_EMAIL_OVERRIDES(self):
 
991
        os.environ['BZR_EMAIL'] = "Robert Collins <robertc@example.org>"
610
992
        branch = FakeBranch()
611
993
        my_config = config.BranchConfig(branch)
612
994
        self.assertEqual("Robert Collins <robertc@example.org>",
613
995
                         my_config.username())
614
 
    
 
996
 
615
997
    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())
 
998
        my_config = self.get_branch_config(
 
999
            global_config=sample_always_signatures)
 
1000
        self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
 
1001
        self.assertEqual(config.SIGN_ALWAYS, my_config.signing_policy())
 
1002
        self.assertTrue(my_config.signature_needed())
 
1003
 
 
1004
    def test_signatures_forced_branch(self):
 
1005
        my_config = self.get_branch_config(
 
1006
            global_config=sample_ignore_signatures,
 
1007
            branch_data_config=sample_always_signatures)
 
1008
        self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
 
1009
        self.assertEqual(config.SIGN_ALWAYS, my_config.signing_policy())
 
1010
        self.assertTrue(my_config.signature_needed())
622
1011
 
623
1012
    def test_gpg_signing_command(self):
624
 
        branch = FakeBranch()
625
 
        my_config = config.BranchConfig(branch)
 
1013
        my_config = self.get_branch_config(
 
1014
            # branch data cannot set gpg_signing_command
 
1015
            branch_data_config="gpg_signing_command=pgp")
626
1016
        config_file = StringIO(sample_config_text.encode('utf-8'))
627
 
        (my_config._get_location_config().
628
 
            _get_global_config()._get_parser(config_file))
 
1017
        my_config._get_global_config()._get_parser(config_file)
629
1018
        self.assertEqual('gnome-gpg', my_config.gpg_signing_command())
630
1019
 
631
1020
    def test_get_user_option_global(self):
632
1021
        branch = FakeBranch()
633
1022
        my_config = config.BranchConfig(branch)
634
1023
        config_file = StringIO(sample_config_text.encode('utf-8'))
635
 
        (my_config._get_location_config().
636
 
            _get_global_config()._get_parser(config_file))
 
1024
        (my_config._get_global_config()._get_parser(config_file))
637
1025
        self.assertEqual('something',
638
1026
                         my_config.get_user_option('user_global_option'))
639
1027
 
640
1028
    def test_post_commit_default(self):
641
1029
        branch = FakeBranch()
642
 
        branch.base='/a/c'
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())
651
 
 
652
 
 
653
 
class TestMailAddressExtraction(TestCase):
 
1030
        my_config = self.get_branch_config(sample_config_text, '/a/c',
 
1031
                                           sample_branches_text)
 
1032
        self.assertEqual(my_config.branch.base, '/a/c')
 
1033
        self.assertEqual('bzrlib.tests.test_config.post_commit',
 
1034
                         my_config.post_commit())
 
1035
        my_config.set_user_option('post_commit', 'rmtree_root')
 
1036
        # post-commit is ignored when bresent in branch data
 
1037
        self.assertEqual('bzrlib.tests.test_config.post_commit',
 
1038
                         my_config.post_commit())
 
1039
        my_config.set_user_option('post_commit', 'rmtree_root',
 
1040
                                  store=config.STORE_LOCATION)
 
1041
        self.assertEqual('rmtree_root', my_config.post_commit())
 
1042
 
 
1043
    def test_config_precedence(self):
 
1044
        my_config = self.get_branch_config(global_config=precedence_global)
 
1045
        self.assertEqual(my_config.get_user_option('option'), 'global')
 
1046
        my_config = self.get_branch_config(global_config=precedence_global,
 
1047
                                      branch_data_config=precedence_branch)
 
1048
        self.assertEqual(my_config.get_user_option('option'), 'branch')
 
1049
        my_config = self.get_branch_config(global_config=precedence_global,
 
1050
                                      branch_data_config=precedence_branch,
 
1051
                                      location_config=precedence_location)
 
1052
        self.assertEqual(my_config.get_user_option('option'), 'recurse')
 
1053
        my_config = self.get_branch_config(global_config=precedence_global,
 
1054
                                      branch_data_config=precedence_branch,
 
1055
                                      location_config=precedence_location,
 
1056
                                      location='http://example.com/specific')
 
1057
        self.assertEqual(my_config.get_user_option('option'), 'exact')
 
1058
 
 
1059
    def test_get_mail_client(self):
 
1060
        config = self.get_branch_config()
 
1061
        client = config.get_mail_client()
 
1062
        self.assertIsInstance(client, mail_client.DefaultMail)
 
1063
 
 
1064
        # Specific clients
 
1065
        config.set_user_option('mail_client', 'evolution')
 
1066
        client = config.get_mail_client()
 
1067
        self.assertIsInstance(client, mail_client.Evolution)
 
1068
 
 
1069
        config.set_user_option('mail_client', 'kmail')
 
1070
        client = config.get_mail_client()
 
1071
        self.assertIsInstance(client, mail_client.KMail)
 
1072
 
 
1073
        config.set_user_option('mail_client', 'mutt')
 
1074
        client = config.get_mail_client()
 
1075
        self.assertIsInstance(client, mail_client.Mutt)
 
1076
 
 
1077
        config.set_user_option('mail_client', 'thunderbird')
 
1078
        client = config.get_mail_client()
 
1079
        self.assertIsInstance(client, mail_client.Thunderbird)
 
1080
 
 
1081
        # Generic options
 
1082
        config.set_user_option('mail_client', 'default')
 
1083
        client = config.get_mail_client()
 
1084
        self.assertIsInstance(client, mail_client.DefaultMail)
 
1085
 
 
1086
        config.set_user_option('mail_client', 'editor')
 
1087
        client = config.get_mail_client()
 
1088
        self.assertIsInstance(client, mail_client.Editor)
 
1089
 
 
1090
        config.set_user_option('mail_client', 'mapi')
 
1091
        client = config.get_mail_client()
 
1092
        self.assertIsInstance(client, mail_client.MAPIClient)
 
1093
 
 
1094
        config.set_user_option('mail_client', 'xdg-email')
 
1095
        client = config.get_mail_client()
 
1096
        self.assertIsInstance(client, mail_client.XDGEmail)
 
1097
 
 
1098
        config.set_user_option('mail_client', 'firebird')
 
1099
        self.assertRaises(errors.UnknownMailClient, config.get_mail_client)
 
1100
 
 
1101
 
 
1102
class TestMailAddressExtraction(tests.TestCase):
654
1103
 
655
1104
    def test_extract_email_address(self):
656
1105
        self.assertEqual('jane@test.com',
657
1106
                         config.extract_email_address('Jane <jane@test.com>'))
658
 
        self.assertRaises(errors.BzrError,
 
1107
        self.assertRaises(errors.NoEmailInUsername,
659
1108
                          config.extract_email_address, 'Jane Tester')
 
1109
 
 
1110
    def test_parse_username(self):
 
1111
        self.assertEqual(('', 'jdoe@example.com'),
 
1112
                         config.parse_username('jdoe@example.com'))
 
1113
        self.assertEqual(('', 'jdoe@example.com'),
 
1114
                         config.parse_username('<jdoe@example.com>'))
 
1115
        self.assertEqual(('John Doe', 'jdoe@example.com'),
 
1116
                         config.parse_username('John Doe <jdoe@example.com>'))
 
1117
        self.assertEqual(('John Doe', ''),
 
1118
                         config.parse_username('John Doe'))
 
1119
        self.assertEqual(('John Doe', 'jdoe@example.com'),
 
1120
                         config.parse_username('John Doe jdoe@example.com'))
 
1121
 
 
1122
class TestTreeConfig(tests.TestCaseWithTransport):
 
1123
 
 
1124
    def test_get_value(self):
 
1125
        """Test that retreiving a value from a section is possible"""
 
1126
        branch = self.make_branch('.')
 
1127
        tree_config = config.TreeConfig(branch)
 
1128
        tree_config.set_option('value', 'key', 'SECTION')
 
1129
        tree_config.set_option('value2', 'key2')
 
1130
        tree_config.set_option('value3-top', 'key3')
 
1131
        tree_config.set_option('value3-section', 'key3', 'SECTION')
 
1132
        value = tree_config.get_option('key', 'SECTION')
 
1133
        self.assertEqual(value, 'value')
 
1134
        value = tree_config.get_option('key2')
 
1135
        self.assertEqual(value, 'value2')
 
1136
        self.assertEqual(tree_config.get_option('non-existant'), None)
 
1137
        value = tree_config.get_option('non-existant', 'SECTION')
 
1138
        self.assertEqual(value, None)
 
1139
        value = tree_config.get_option('non-existant', default='default')
 
1140
        self.assertEqual(value, 'default')
 
1141
        self.assertEqual(tree_config.get_option('key2', 'NOSECTION'), None)
 
1142
        value = tree_config.get_option('key2', 'NOSECTION', default='default')
 
1143
        self.assertEqual(value, 'default')
 
1144
        value = tree_config.get_option('key3')
 
1145
        self.assertEqual(value, 'value3-top')
 
1146
        value = tree_config.get_option('key3', 'SECTION')
 
1147
        self.assertEqual(value, 'value3-section')
 
1148
 
 
1149
 
 
1150
class TestTransportConfig(tests.TestCaseWithTransport):
 
1151
 
 
1152
    def test_get_value(self):
 
1153
        """Test that retreiving a value from a section is possible"""
 
1154
        bzrdir_config = config.TransportConfig(transport.get_transport('.'),
 
1155
                                               'control.conf')
 
1156
        bzrdir_config.set_option('value', 'key', 'SECTION')
 
1157
        bzrdir_config.set_option('value2', 'key2')
 
1158
        bzrdir_config.set_option('value3-top', 'key3')
 
1159
        bzrdir_config.set_option('value3-section', 'key3', 'SECTION')
 
1160
        value = bzrdir_config.get_option('key', 'SECTION')
 
1161
        self.assertEqual(value, 'value')
 
1162
        value = bzrdir_config.get_option('key2')
 
1163
        self.assertEqual(value, 'value2')
 
1164
        self.assertEqual(bzrdir_config.get_option('non-existant'), None)
 
1165
        value = bzrdir_config.get_option('non-existant', 'SECTION')
 
1166
        self.assertEqual(value, None)
 
1167
        value = bzrdir_config.get_option('non-existant', default='default')
 
1168
        self.assertEqual(value, 'default')
 
1169
        self.assertEqual(bzrdir_config.get_option('key2', 'NOSECTION'), None)
 
1170
        value = bzrdir_config.get_option('key2', 'NOSECTION',
 
1171
                                         default='default')
 
1172
        self.assertEqual(value, 'default')
 
1173
        value = bzrdir_config.get_option('key3')
 
1174
        self.assertEqual(value, 'value3-top')
 
1175
        value = bzrdir_config.get_option('key3', 'SECTION')
 
1176
        self.assertEqual(value, 'value3-section')
 
1177
 
 
1178
 
 
1179
class TestAuthenticationConfigFile(tests.TestCase):
 
1180
    """Test the authentication.conf file matching"""
 
1181
 
 
1182
    def _got_user_passwd(self, expected_user, expected_password,
 
1183
                         config, *args, **kwargs):
 
1184
        credentials = config.get_credentials(*args, **kwargs)
 
1185
        if credentials is None:
 
1186
            user = None
 
1187
            password = None
 
1188
        else:
 
1189
            user = credentials['user']
 
1190
            password = credentials['password']
 
1191
        self.assertEquals(expected_user, user)
 
1192
        self.assertEquals(expected_password, password)
 
1193
 
 
1194
    def test_empty_config(self):
 
1195
        conf = config.AuthenticationConfig(_file=StringIO())
 
1196
        self.assertEquals({}, conf._get_config())
 
1197
        self._got_user_passwd(None, None, conf, 'http', 'foo.net')
 
1198
 
 
1199
    def test_missing_auth_section_header(self):
 
1200
        conf = config.AuthenticationConfig(_file=StringIO('foo = bar'))
 
1201
        self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
 
1202
 
 
1203
    def test_auth_section_header_not_closed(self):
 
1204
        conf = config.AuthenticationConfig(_file=StringIO('[DEF'))
 
1205
        self.assertRaises(errors.ParseConfigError, conf._get_config)
 
1206
 
 
1207
    def test_auth_value_not_boolean(self):
 
1208
        conf = config.AuthenticationConfig(_file=StringIO(
 
1209
                """[broken]
 
1210
scheme=ftp
 
1211
user=joe
 
1212
verify_certificates=askme # Error: Not a boolean
 
1213
"""))
 
1214
        self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
 
1215
 
 
1216
    def test_auth_value_not_int(self):
 
1217
        conf = config.AuthenticationConfig(_file=StringIO(
 
1218
                """[broken]
 
1219
scheme=ftp
 
1220
user=joe
 
1221
port=port # Error: Not an int
 
1222
"""))
 
1223
        self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
 
1224
 
 
1225
    def test_credentials_for_scheme_host(self):
 
1226
        conf = config.AuthenticationConfig(_file=StringIO(
 
1227
                """# Identity on foo.net
 
1228
[ftp definition]
 
1229
scheme=ftp
 
1230
host=foo.net
 
1231
user=joe
 
1232
password=secret-pass
 
1233
"""))
 
1234
        # Basic matching
 
1235
        self._got_user_passwd('joe', 'secret-pass', conf, 'ftp', 'foo.net')
 
1236
        # different scheme
 
1237
        self._got_user_passwd(None, None, conf, 'http', 'foo.net')
 
1238
        # different host
 
1239
        self._got_user_passwd(None, None, conf, 'ftp', 'bar.net')
 
1240
 
 
1241
    def test_credentials_for_host_port(self):
 
1242
        conf = config.AuthenticationConfig(_file=StringIO(
 
1243
                """# Identity on foo.net
 
1244
[ftp definition]
 
1245
scheme=ftp
 
1246
port=10021
 
1247
host=foo.net
 
1248
user=joe
 
1249
password=secret-pass
 
1250
"""))
 
1251
        # No port
 
1252
        self._got_user_passwd('joe', 'secret-pass',
 
1253
                              conf, 'ftp', 'foo.net', port=10021)
 
1254
        # different port
 
1255
        self._got_user_passwd(None, None, conf, 'ftp', 'foo.net')
 
1256
 
 
1257
    def test_for_matching_host(self):
 
1258
        conf = config.AuthenticationConfig(_file=StringIO(
 
1259
                """# Identity on foo.net
 
1260
[sourceforge]
 
1261
scheme=bzr
 
1262
host=bzr.sf.net
 
1263
user=joe
 
1264
password=joepass
 
1265
[sourceforge domain]
 
1266
scheme=bzr
 
1267
host=.bzr.sf.net
 
1268
user=georges
 
1269
password=bendover
 
1270
"""))
 
1271
        # matching domain
 
1272
        self._got_user_passwd('georges', 'bendover',
 
1273
                              conf, 'bzr', 'foo.bzr.sf.net')
 
1274
        # phishing attempt
 
1275
        self._got_user_passwd(None, None,
 
1276
                              conf, 'bzr', 'bbzr.sf.net')
 
1277
 
 
1278
    def test_for_matching_host_None(self):
 
1279
        conf = config.AuthenticationConfig(_file=StringIO(
 
1280
                """# Identity on foo.net
 
1281
[catchup bzr]
 
1282
scheme=bzr
 
1283
user=joe
 
1284
password=joepass
 
1285
[DEFAULT]
 
1286
user=georges
 
1287
password=bendover
 
1288
"""))
 
1289
        # match no host
 
1290
        self._got_user_passwd('joe', 'joepass',
 
1291
                              conf, 'bzr', 'quux.net')
 
1292
        # no host but different scheme
 
1293
        self._got_user_passwd('georges', 'bendover',
 
1294
                              conf, 'ftp', 'quux.net')
 
1295
 
 
1296
    def test_credentials_for_path(self):
 
1297
        conf = config.AuthenticationConfig(_file=StringIO(
 
1298
                """
 
1299
[http dir1]
 
1300
scheme=http
 
1301
host=bar.org
 
1302
path=/dir1
 
1303
user=jim
 
1304
password=jimpass
 
1305
[http dir2]
 
1306
scheme=http
 
1307
host=bar.org
 
1308
path=/dir2
 
1309
user=georges
 
1310
password=bendover
 
1311
"""))
 
1312
        # no path no dice
 
1313
        self._got_user_passwd(None, None,
 
1314
                              conf, 'http', host='bar.org', path='/dir3')
 
1315
        # matching path
 
1316
        self._got_user_passwd('georges', 'bendover',
 
1317
                              conf, 'http', host='bar.org', path='/dir2')
 
1318
        # matching subdir
 
1319
        self._got_user_passwd('jim', 'jimpass',
 
1320
                              conf, 'http', host='bar.org',path='/dir1/subdir')
 
1321
 
 
1322
    def test_credentials_for_user(self):
 
1323
        conf = config.AuthenticationConfig(_file=StringIO(
 
1324
                """
 
1325
[with user]
 
1326
scheme=http
 
1327
host=bar.org
 
1328
user=jim
 
1329
password=jimpass
 
1330
"""))
 
1331
        # Get user
 
1332
        self._got_user_passwd('jim', 'jimpass',
 
1333
                              conf, 'http', 'bar.org')
 
1334
        # Get same user
 
1335
        self._got_user_passwd('jim', 'jimpass',
 
1336
                              conf, 'http', 'bar.org', user='jim')
 
1337
        # Don't get a different user if one is specified
 
1338
        self._got_user_passwd(None, None,
 
1339
                              conf, 'http', 'bar.org', user='georges')
 
1340
 
 
1341
    def test_credentials_for_user_without_password(self):
 
1342
        conf = config.AuthenticationConfig(_file=StringIO(
 
1343
                """
 
1344
[without password]
 
1345
scheme=http
 
1346
host=bar.org
 
1347
user=jim
 
1348
"""))
 
1349
        # Get user but no password
 
1350
        self._got_user_passwd('jim', None,
 
1351
                              conf, 'http', 'bar.org')
 
1352
 
 
1353
    def test_verify_certificates(self):
 
1354
        conf = config.AuthenticationConfig(_file=StringIO(
 
1355
                """
 
1356
[self-signed]
 
1357
scheme=https
 
1358
host=bar.org
 
1359
user=jim
 
1360
password=jimpass
 
1361
verify_certificates=False
 
1362
[normal]
 
1363
scheme=https
 
1364
host=foo.net
 
1365
user=georges
 
1366
password=bendover
 
1367
"""))
 
1368
        credentials = conf.get_credentials('https', 'bar.org')
 
1369
        self.assertEquals(False, credentials.get('verify_certificates'))
 
1370
        credentials = conf.get_credentials('https', 'foo.net')
 
1371
        self.assertEquals(True, credentials.get('verify_certificates'))
 
1372
 
 
1373
 
 
1374
class TestAuthenticationConfig(tests.TestCase):
 
1375
    """Test AuthenticationConfig behaviour"""
 
1376
 
 
1377
    def _check_default_prompt(self, expected_prompt_format, scheme,
 
1378
                              host=None, port=None, realm=None, path=None):
 
1379
        if host is None:
 
1380
            host = 'bar.org'
 
1381
        user, password = 'jim', 'precious'
 
1382
        expected_prompt = expected_prompt_format % {
 
1383
            'scheme': scheme, 'host': host, 'port': port,
 
1384
            'user': user, 'realm': realm}
 
1385
 
 
1386
        stdout = tests.StringIOWrapper()
 
1387
        ui.ui_factory = tests.TestUIFactory(stdin=password + '\n',
 
1388
                                            stdout=stdout)
 
1389
        # We use an empty conf so that the user is always prompted
 
1390
        conf = config.AuthenticationConfig()
 
1391
        self.assertEquals(password,
 
1392
                          conf.get_password(scheme, host, user, port=port,
 
1393
                                            realm=realm, path=path))
 
1394
        self.assertEquals(stdout.getvalue(), expected_prompt)
 
1395
 
 
1396
    def test_default_prompts(self):
 
1397
        # HTTP prompts can't be tested here, see test_http.py
 
1398
        self._check_default_prompt('FTP %(user)s@%(host)s password: ', 'ftp')
 
1399
        self._check_default_prompt('FTP %(user)s@%(host)s:%(port)d password: ',
 
1400
                                   'ftp', port=10020)
 
1401
 
 
1402
        self._check_default_prompt('SSH %(user)s@%(host)s:%(port)d password: ',
 
1403
                                   'ssh', port=12345)
 
1404
        # SMTP port handling is a bit special (it's handled if embedded in the
 
1405
        # host too)
 
1406
        # FIXME: should we: forbid that, extend it to other schemes, leave
 
1407
        # things as they are that's fine thank you ?
 
1408
        self._check_default_prompt('SMTP %(user)s@%(host)s password: ',
 
1409
                                   'smtp')
 
1410
        self._check_default_prompt('SMTP %(user)s@%(host)s password: ',
 
1411
                                   'smtp', host='bar.org:10025')
 
1412
        self._check_default_prompt(
 
1413
            'SMTP %(user)s@%(host)s:%(port)d password: ',
 
1414
            'smtp', port=10025)
 
1415
 
 
1416
    def test_ssh_password_emits_warning(self):
 
1417
        conf = config.AuthenticationConfig(_file=StringIO(
 
1418
                """
 
1419
[ssh with password]
 
1420
scheme=ssh
 
1421
host=bar.org
 
1422
user=jim
 
1423
password=jimpass
 
1424
"""))
 
1425
        entered_password = 'typed-by-hand'
 
1426
        stdout = tests.StringIOWrapper()
 
1427
        ui.ui_factory = tests.TestUIFactory(stdin=entered_password + '\n',
 
1428
                                            stdout=stdout)
 
1429
 
 
1430
        # Since the password defined in the authentication config is ignored,
 
1431
        # the user is prompted
 
1432
        self.assertEquals(entered_password,
 
1433
                          conf.get_password('ssh', 'bar.org', user='jim'))
 
1434
        self.assertContainsRe(
 
1435
            self._get_log(keep_log_file=True),
 
1436
            'password ignored in section \[ssh with password\]')
 
1437
 
 
1438
    def test_ssh_without_password_doesnt_emit_warning(self):
 
1439
        conf = config.AuthenticationConfig(_file=StringIO(
 
1440
                """
 
1441
[ssh with password]
 
1442
scheme=ssh
 
1443
host=bar.org
 
1444
user=jim
 
1445
"""))
 
1446
        entered_password = 'typed-by-hand'
 
1447
        stdout = tests.StringIOWrapper()
 
1448
        ui.ui_factory = tests.TestUIFactory(stdin=entered_password + '\n',
 
1449
                                            stdout=stdout)
 
1450
 
 
1451
        # Since the password defined in the authentication config is ignored,
 
1452
        # the user is prompted
 
1453
        self.assertEquals(entered_password,
 
1454
                          conf.get_password('ssh', 'bar.org', user='jim'))
 
1455
        # No warning shoud be emitted since there is no password. We are only
 
1456
        # providing "user".
 
1457
        self.assertNotContainsRe(
 
1458
            self._get_log(keep_log_file=True),
 
1459
            'password ignored in section \[ssh with password\]')
 
1460
 
 
1461
 
 
1462
# FIXME: Once we have a way to declare authentication to all test servers, we
 
1463
# can implement generic tests.
 
1464
# test_user_password_in_url
 
1465
# test_user_in_url_password_from_config
 
1466
# test_user_in_url_password_prompted
 
1467
# test_user_in_config
 
1468
# test_user_getpass.getuser
 
1469
# test_user_prompted ?
 
1470
class TestAuthenticationRing(tests.TestCaseWithTransport):
 
1471
    pass