~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/selftest/testconfig.py

  • Committer: Martin Pool
  • Date: 2005-11-04 01:46:31 UTC
  • mto: (1185.33.49 bzr.dev)
  • mto: This revision was merged to the branch mainline in revision 1512.
  • Revision ID: mbp@sourcefrog.net-20051104014631-750e0ad4172c952c
Make biobench directly executable

Show diffs side-by-side

added added

removed removed

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