~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-02-06 01:45:28 UTC
  • mfrom: (3211.5.4 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20080206014528-rb8v4hl04mgxulb7
(robertc) Tune RemoteRepository.get_parent_map to not send duplicate
        results, and to compress the data,
        reducing round trips further. (Robert Collins)

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