/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
4763.2.4 by John Arbash Meinel
merge bzr.2.1 in preparation for NEWS entry.
1
# Copyright (C) 2005-2010 Canonical Ltd
1442.1.1 by Robert Collins
move config_dir into bzrlib.config
2
#
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
7
#
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
12
#
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
1442.1.1 by Robert Collins
move config_dir into bzrlib.config
16
17
"""Tests for finding and reading the bzr config file[s]."""
18
# import system imports here
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
19
from cStringIO import StringIO
1442.1.1 by Robert Collins
move config_dir into bzrlib.config
20
import os
21
import sys
22
23
#import bzrlib specific imports here
1878.1.3 by John Arbash Meinel
some test cleanups
24
from bzrlib import (
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
25
    branch,
26
    bzrdir,
1878.1.3 by John Arbash Meinel
some test cleanups
27
    config,
4603.1.10 by Aaron Bentley
Provide change editor via config.
28
    diff,
1878.1.3 by John Arbash Meinel
some test cleanups
29
    errors,
30
    osutils,
2681.1.8 by Aaron Bentley
Add Thunderbird support to bzr send
31
    mail_client,
2900.2.14 by Vincent Ladeuil
More tests.
32
    ui,
1878.1.3 by John Arbash Meinel
some test cleanups
33
    urlutils,
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
34
    tests,
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
35
    trace,
3242.1.2 by Aaron Bentley
Turn BzrDirConfig into TransportConfig, reduce code duplication
36
    transport,
1878.1.3 by John Arbash Meinel
some test cleanups
37
    )
2991.2.4 by Vincent Ladeuil
Various fixes following local testing environment rebuild.
38
from bzrlib.util.configobj import configobj
1442.1.1 by Robert Collins
move config_dir into bzrlib.config
39
40
1553.6.12 by Erik Bågfors
remove AliasConfig, based on input from abentley
41
sample_long_alias="log -r-15..-1 --line"
2120.6.2 by James Henstridge
remove get_matching_sections() norecurse tests, since that feature is handled in the config policy code now
42
sample_config_text = u"""
43
[DEFAULT]
44
email=Erik B\u00e5gfors <erik@bagfors.nu>
45
editor=vim
4603.1.20 by Aaron Bentley
Use string.Template substitution with @ as delimiter.
46
change_editor=vimdiff -of @new_path @old_path
2120.6.2 by James Henstridge
remove get_matching_sections() norecurse tests, since that feature is handled in the config policy code now
47
gpg_signing_command=gnome-gpg
48
log_format=short
49
user_global_option=something
50
[ALIASES]
51
h=help
52
ll=""" + sample_long_alias + "\n"
53
54
55
sample_always_signatures = """
56
[DEFAULT]
57
check_signatures=ignore
58
create_signatures=always
59
"""
60
61
sample_ignore_signatures = """
62
[DEFAULT]
63
check_signatures=require
64
create_signatures=never
65
"""
66
67
sample_maybe_signatures = """
68
[DEFAULT]
69
check_signatures=ignore
70
create_signatures=when-required
71
"""
72
73
sample_branches_text = """
74
[http://www.example.com]
75
# Top level policy
76
email=Robert Collins <robertc@example.org>
2120.6.3 by James Henstridge
add some more tests for getting policy options, and behaviour of get_user_option in the presence of config policies
77
normal_option = normal
78
appendpath_option = append
2120.6.8 by James Henstridge
Change syntax for setting config option policies. Rather than
79
appendpath_option:policy = appendpath
2120.6.3 by James Henstridge
add some more tests for getting policy options, and behaviour of get_user_option in the presence of config policies
80
norecurse_option = norecurse
2120.6.8 by James Henstridge
Change syntax for setting config option policies. Rather than
81
norecurse_option:policy = norecurse
2120.6.2 by James Henstridge
remove get_matching_sections() norecurse tests, since that feature is handled in the config policy code now
82
[http://www.example.com/ignoreparent]
83
# different project: ignore parent dir config
84
ignore_parents=true
85
[http://www.example.com/norecurse]
86
# configuration items that only apply to this dir
87
recurse=false
2120.6.3 by James Henstridge
add some more tests for getting policy options, and behaviour of get_user_option in the presence of config policies
88
normal_option = norecurse
89
[http://www.example.com/dir]
90
appendpath_option = normal
2120.6.2 by James Henstridge
remove get_matching_sections() norecurse tests, since that feature is handled in the config policy code now
91
[/b/]
92
check_signatures=require
93
# test trailing / matching with no children
94
[/a/]
95
check_signatures=check-available
96
gpg_signing_command=false
97
user_local_option=local
98
# test trailing / matching
99
[/a/*]
100
#subdirs will match but not the parent
101
[/a/c]
102
check_signatures=ignore
103
post_commit=bzrlib.tests.test_config.post_commit
104
#testing explicit beats globs
105
"""
1553.6.3 by Erik Bågfors
tests for AliasesConfig
106
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
107
1474 by Robert Collins
Merge from Aaron Bentley.
108
class InstrumentedConfigObj(object):
109
    """A config obj look-enough-alike to record calls made to it."""
110
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
111
    def __contains__(self, thing):
112
        self._calls.append(('__contains__', thing))
113
        return False
114
115
    def __getitem__(self, key):
116
        self._calls.append(('__getitem__', key))
117
        return self
118
1551.2.20 by Aaron Bentley
Treated config files as utf-8
119
    def __init__(self, input, encoding=None):
120
        self._calls = [('__init__', input, encoding)]
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
121
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
122
    def __setitem__(self, key, value):
123
        self._calls.append(('__setitem__', key, value))
124
2120.6.4 by James Henstridge
add support for specifying policy when storing options
125
    def __delitem__(self, key):
126
        self._calls.append(('__delitem__', key))
127
128
    def keys(self):
129
        self._calls.append(('keys',))
130
        return []
131
1551.2.49 by abentley
Made ConfigObj output binary-identical files on win32 and *nix
132
    def write(self, arg):
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
133
        self._calls.append(('write',))
134
2120.6.4 by James Henstridge
add support for specifying policy when storing options
135
    def as_bool(self, value):
136
        self._calls.append(('as_bool', value))
137
        return False
138
139
    def get_value(self, section, name):
140
        self._calls.append(('get_value', section, name))
141
        return None
142
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
143
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
144
class FakeBranch(object):
145
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
146
    def __init__(self, base=None, user_id=None):
147
        if base is None:
148
            self.base = "http://example.com/branches/demo"
149
        else:
150
            self.base = base
3407.2.13 by Martin Pool
Remove indirection through control_files to get transports
151
        self._transport = self.control_files = \
152
            FakeControlFilesAndTransport(user_id=user_id)
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
153
4226.1.7 by Robert Collins
Alter test_config.FakeBranch in accordance with the Branch change to have a _get_config.
154
    def _get_config(self):
155
        return config.TransportConfig(self._transport, 'branch.conf')
156
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
157
    def lock_write(self):
158
        pass
159
160
    def unlock(self):
161
        pass
1185.65.11 by Robert Collins
Disable inheritance for getting at LockableFiles, rather use composition.
162
163
3407.2.13 by Martin Pool
Remove indirection through control_files to get transports
164
class FakeControlFilesAndTransport(object):
1185.65.11 by Robert Collins
Disable inheritance for getting at LockableFiles, rather use composition.
165
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
166
    def __init__(self, user_id=None):
167
        self.files = {}
3388.2.3 by Martin Pool
Fix up more uses of LockableFiles.get_utf8 in tests
168
        if user_id:
169
            self.files['email'] = user_id
3242.1.2 by Aaron Bentley
Turn BzrDirConfig into TransportConfig, reduce code duplication
170
        self._transport = self
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
171
1185.65.29 by Robert Collins
Implement final review suggestions.
172
    def get_utf8(self, filename):
3388.2.3 by Martin Pool
Fix up more uses of LockableFiles.get_utf8 in tests
173
        # from LockableFiles
174
        raise AssertionError("get_utf8 should no longer be used")
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
175
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
176
    def get(self, filename):
3388.2.3 by Martin Pool
Fix up more uses of LockableFiles.get_utf8 in tests
177
        # from Transport
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
178
        try:
179
            return StringIO(self.files[filename])
180
        except KeyError:
181
            raise errors.NoSuchFile(filename)
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
182
3388.2.3 by Martin Pool
Fix up more uses of LockableFiles.get_utf8 in tests
183
    def get_bytes(self, filename):
184
        # from Transport
185
        try:
186
            return self.files[filename]
187
        except KeyError:
188
            raise errors.NoSuchFile(filename)
189
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
190
    def put(self, filename, fileobj):
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
191
        self.files[filename] = fileobj.read()
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
192
3242.1.2 by Aaron Bentley
Turn BzrDirConfig into TransportConfig, reduce code duplication
193
    def put_file(self, filename, fileobj):
194
        return self.put(filename, fileobj)
195
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
196
197
class InstrumentedConfig(config.Config):
198
    """An instrumented config that supplies stubs for template methods."""
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
199
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
200
    def __init__(self):
201
        super(InstrumentedConfig, self).__init__()
202
        self._calls = []
1442.1.15 by Robert Collins
make getting the signature checking policy a template method
203
        self._signatures = config.CHECK_NEVER
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
204
205
    def _get_user_id(self):
206
        self._calls.append('_get_user_id')
207
        return "Robert Collins <robert.collins@example.org>"
208
1442.1.15 by Robert Collins
make getting the signature checking policy a template method
209
    def _get_signature_checking(self):
210
        self._calls.append('_get_signature_checking')
211
        return self._signatures
212
4603.1.10 by Aaron Bentley
Provide change editor via config.
213
    def _get_change_editor(self):
214
        self._calls.append('_get_change_editor')
4603.1.20 by Aaron Bentley
Use string.Template substitution with @ as delimiter.
215
        return 'vimdiff -fo @new_path @old_path'
4603.1.10 by Aaron Bentley
Provide change editor via config.
216
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
217
1556.2.2 by Aaron Bentley
Fixed get_bool
218
bool_config = """[DEFAULT]
219
active = true
220
inactive = false
221
[UPPERCASE]
222
active = True
223
nonactive = False
224
"""
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
225
226
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
227
class TestConfigObj(tests.TestCase):
3221.7.4 by Matt Nordhoff
Add test for bug #86838.
228
1556.2.2 by Aaron Bentley
Fixed get_bool
229
    def test_get_bool(self):
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
230
        co = config.ConfigObj(StringIO(bool_config))
1556.2.2 by Aaron Bentley
Fixed get_bool
231
        self.assertIs(co.get_bool('DEFAULT', 'active'), True)
232
        self.assertIs(co.get_bool('DEFAULT', 'inactive'), False)
233
        self.assertIs(co.get_bool('UPPERCASE', 'active'), True)
234
        self.assertIs(co.get_bool('UPPERCASE', 'nonactive'), False)
235
3221.7.4 by Matt Nordhoff
Add test for bug #86838.
236
    def test_hash_sign_in_value(self):
237
        """
238
        Before 4.5.0, ConfigObj did not quote # signs in values, so they'd be
239
        treated as comments when read in again. (#86838)
240
        """
241
        co = config.ConfigObj()
242
        co['test'] = 'foo#bar'
243
        lines = co.write()
244
        self.assertEqual(lines, ['test = "foo#bar"'])
245
        co2 = config.ConfigObj(lines)
246
        self.assertEqual(co2['test'], 'foo#bar')
247
1556.2.2 by Aaron Bentley
Fixed get_bool
248
2900.1.1 by Vincent Ladeuil
249
erroneous_config = """[section] # line 1
250
good=good # line 2
251
[section] # line 3
252
whocares=notme # line 4
253
"""
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
254
255
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
256
class TestConfigObjErrors(tests.TestCase):
2900.1.1 by Vincent Ladeuil
257
258
    def test_duplicate_section_name_error_line(self):
259
        try:
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
260
            co = configobj.ConfigObj(StringIO(erroneous_config),
261
                                     raise_errors=True)
2900.1.1 by Vincent Ladeuil
262
        except config.configobj.DuplicateError, e:
263
            self.assertEqual(3, e.line_number)
264
        else:
265
            self.fail('Error in config file not detected')
266
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
267
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
268
class TestConfig(tests.TestCase):
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
269
270
    def test_constructs(self):
271
        config.Config()
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
272
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
273
    def test_no_default_editor(self):
274
        self.assertRaises(NotImplementedError, config.Config().get_editor)
275
276
    def test_user_email(self):
277
        my_config = InstrumentedConfig()
278
        self.assertEqual('robert.collins@example.org', my_config.user_email())
279
        self.assertEqual(['_get_user_id'], my_config._calls)
280
281
    def test_username(self):
282
        my_config = InstrumentedConfig()
283
        self.assertEqual('Robert Collins <robert.collins@example.org>',
284
                         my_config.username())
285
        self.assertEqual(['_get_user_id'], my_config._calls)
1442.1.14 by Robert Collins
Create a default signature checking policy of CHECK_IF_POSSIBLE
286
287
    def test_signatures_default(self):
288
        my_config = config.Config()
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
289
        self.assertFalse(my_config.signature_needed())
1442.1.14 by Robert Collins
Create a default signature checking policy of CHECK_IF_POSSIBLE
290
        self.assertEqual(config.CHECK_IF_POSSIBLE,
291
                         my_config.signature_checking())
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
292
        self.assertEqual(config.SIGN_WHEN_REQUIRED,
293
                         my_config.signing_policy())
1442.1.14 by Robert Collins
Create a default signature checking policy of CHECK_IF_POSSIBLE
294
1442.1.15 by Robert Collins
make getting the signature checking policy a template method
295
    def test_signatures_template_method(self):
296
        my_config = InstrumentedConfig()
297
        self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
298
        self.assertEqual(['_get_signature_checking'], my_config._calls)
299
300
    def test_signatures_template_method_none(self):
301
        my_config = InstrumentedConfig()
302
        my_config._signatures = None
303
        self.assertEqual(config.CHECK_IF_POSSIBLE,
304
                         my_config.signature_checking())
305
        self.assertEqual(['_get_signature_checking'], my_config._calls)
306
1442.1.56 by Robert Collins
gpg_signing_command configuration item
307
    def test_gpg_signing_command_default(self):
308
        my_config = config.Config()
309
        self.assertEqual('gpg', my_config.gpg_signing_command())
310
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
311
    def test_get_user_option_default(self):
312
        my_config = config.Config()
313
        self.assertEqual(None, my_config.get_user_option('no_option'))
314
1472 by Robert Collins
post commit hook, first pass implementation
315
    def test_post_commit_default(self):
316
        my_config = config.Config()
317
        self.assertEqual(None, my_config.post_commit())
318
1553.2.9 by Erik Bågfors
log_formatter => log_format for "named" formatters
319
    def test_log_format_default(self):
1553.2.8 by Erik Bågfors
tests for config log_formatter
320
        my_config = config.Config()
1553.2.9 by Erik Bågfors
log_formatter => log_format for "named" formatters
321
        self.assertEqual('long', my_config.log_format())
1553.2.8 by Erik Bågfors
tests for config log_formatter
322
4603.1.10 by Aaron Bentley
Provide change editor via config.
323
    def test_get_change_editor(self):
324
        my_config = InstrumentedConfig()
325
        change_editor = my_config.get_change_editor('old_tree', 'new_tree')
326
        self.assertEqual(['_get_change_editor'], my_config._calls)
327
        self.assertIs(diff.DiffFromTool, change_editor.__class__)
4603.1.20 by Aaron Bentley
Use string.Template substitution with @ as delimiter.
328
        self.assertEqual(['vimdiff', '-fo', '@new_path', '@old_path'],
4603.1.10 by Aaron Bentley
Provide change editor via config.
329
                         change_editor.command_template)
330
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
331
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
332
class TestConfigPath(tests.TestCase):
1442.1.1 by Robert Collins
move config_dir into bzrlib.config
333
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
334
    def setUp(self):
335
        super(TestConfigPath, self).setUp()
336
        os.environ['HOME'] = '/home/bogus'
4584.3.23 by Martin Pool
Correction to xdg_cache_dir and add a simple test
337
        os.environ['XDG_CACHE_DIR'] = ''
2309.2.6 by Alexander Belchenko
bzr now use Win32 API to determine Application Data location, and don't rely solely on $APPDATA
338
        if sys.platform == 'win32':
339
            os.environ['BZR_HOME'] = \
340
                r'C:\Documents and Settings\bogus\Application Data'
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
341
            self.bzr_home = \
342
                'C:/Documents and Settings/bogus/Application Data/bazaar/2.0'
343
        else:
344
            self.bzr_home = '/home/bogus/.bazaar'
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
345
1442.1.1 by Robert Collins
move config_dir into bzrlib.config
346
    def test_config_dir(self):
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
347
        self.assertEqual(config.config_dir(), self.bzr_home)
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
348
349
    def test_config_filename(self):
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
350
        self.assertEqual(config.config_filename(),
351
                         self.bzr_home + '/bazaar.conf')
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
352
1770.2.2 by Aaron Bentley
Rename branches.conf to locations.conf
353
    def test_locations_config_filename(self):
2991.2.4 by Vincent Ladeuil
Various fixes following local testing environment rebuild.
354
        self.assertEqual(config.locations_config_filename(),
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
355
                         self.bzr_home + '/locations.conf')
1770.2.2 by Aaron Bentley
Rename branches.conf to locations.conf
356
2900.2.5 by Vincent Ladeuil
ake ftp aware of authentication config.
357
    def test_authentication_config_filename(self):
2991.2.4 by Vincent Ladeuil
Various fixes following local testing environment rebuild.
358
        self.assertEqual(config.authentication_config_filename(),
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
359
                         self.bzr_home + '/authentication.conf')
360
4584.3.23 by Martin Pool
Correction to xdg_cache_dir and add a simple test
361
    def test_xdg_cache_dir(self):
362
        self.assertEqual(config.xdg_cache_dir(),
363
            '/home/bogus/.cache')
364
2900.2.5 by Vincent Ladeuil
ake ftp aware of authentication config.
365
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
366
class TestIniConfig(tests.TestCase):
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
367
4840.2.6 by Vincent Ladeuil
Implement config.suppress_warning.
368
    def make_config_parser(self, s):
5345.1.4 by Vincent Ladeuil
Deprecate the ``file`` parameter of the ``config._get_parser()`` method.
369
        conf = config.IniBasedConfig(_content=StringIO(s.encode('utf-8')))
370
        return conf, conf._get_parser()
4840.2.6 by Vincent Ladeuil
Implement config.suppress_warning.
371
372
373
class TestIniConfigBuilding(TestIniConfig):
374
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
375
    def test_contructs(self):
5345.1.1 by Vincent Ladeuil
Deprecate the get_filename parameter in IniBasedConfig.
376
        my_config = config.IniBasedConfig()
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
377
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
378
    def test_from_fp(self):
1551.2.20 by Aaron Bentley
Treated config files as utf-8
379
        config_file = StringIO(sample_config_text.encode('utf-8'))
5345.1.4 by Vincent Ladeuil
Deprecate the ``file`` parameter of the ``config._get_parser()`` method.
380
        my_config = config.IniBasedConfig(_content=config_file)
381
        self.assertIsInstance(my_config._get_parser(), configobj.ConfigObj)
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
382
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
383
    def test_cached(self):
1551.2.20 by Aaron Bentley
Treated config files as utf-8
384
        config_file = StringIO(sample_config_text.encode('utf-8'))
5345.1.4 by Vincent Ladeuil
Deprecate the ``file`` parameter of the ``config._get_parser()`` method.
385
        my_config = config.IniBasedConfig(_content=config_file)
386
        parser = my_config._get_parser()
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
387
        self.failUnless(my_config._get_parser() is parser)
388
5345.1.1 by Vincent Ladeuil
Deprecate the get_filename parameter in IniBasedConfig.
389
    def test_get_filename_parameter_is_deprecated_(self):
390
        conf = self.callDeprecated([
391
            'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
392
            ' Use file_name instead.'],
393
            config.IniBasedConfig, lambda: 'ini.conf')
5345.3.1 by Vincent Ladeuil
Check that _get_filename() is called and produces the desired side effect.
394
        self.assertEqual('ini.conf', conf.file_name)
5345.1.1 by Vincent Ladeuil
Deprecate the get_filename parameter in IniBasedConfig.
395
5345.1.4 by Vincent Ladeuil
Deprecate the ``file`` parameter of the ``config._get_parser()`` method.
396
    def test_get_parser_file_parameter_is_deprecated_(self):
397
        config_file = StringIO(sample_config_text.encode('utf-8'))
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
398
        conf = config.IniBasedConfig(_content=config_file)
5345.1.4 by Vincent Ladeuil
Deprecate the ``file`` parameter of the ``config._get_parser()`` method.
399
        conf = self.callDeprecated([
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
400
            'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
401
            ' Use IniBasedConfig(_content=xxx) instead.'],
402
            conf._get_parser, file=config_file)
5345.1.4 by Vincent Ladeuil
Deprecate the ``file`` parameter of the ``config._get_parser()`` method.
403
5345.1.1 by Vincent Ladeuil
Deprecate the get_filename parameter in IniBasedConfig.
404
    def test_cant_save_without_a_file_name(self):
405
        conf = config.IniBasedConfig()
406
        self.assertRaises(AssertionError, conf._write_config_file)
407
4840.2.5 by Vincent Ladeuil
Refactor get_user_option_as_* tests.
408
4840.2.6 by Vincent Ladeuil
Implement config.suppress_warning.
409
class TestGetUserOptionAs(TestIniConfig):
4840.2.5 by Vincent Ladeuil
Refactor get_user_option_as_* tests.
410
4503.2.2 by Vincent Ladeuil
Get a bool or none from a config file.
411
    def test_get_user_option_as_bool(self):
4840.2.6 by Vincent Ladeuil
Implement config.suppress_warning.
412
        conf, parser = self.make_config_parser("""
4503.2.2 by Vincent Ladeuil
Get a bool or none from a config file.
413
a_true_bool = true
414
a_false_bool = 0
415
an_invalid_bool = maybe
4840.2.4 by Vincent Ladeuil
Implement config.get_user_option_as_list.
416
a_list = hmm, who knows ? # This is interpreted as a list !
4840.2.5 by Vincent Ladeuil
Refactor get_user_option_as_* tests.
417
""")
4840.2.6 by Vincent Ladeuil
Implement config.suppress_warning.
418
        get_bool = conf.get_user_option_as_bool
419
        self.assertEqual(True, get_bool('a_true_bool'))
420
        self.assertEqual(False, get_bool('a_false_bool'))
4989.2.12 by Vincent Ladeuil
Display a warning if an option value is not boolean.
421
        warnings = []
422
        def warning(*args):
423
            warnings.append(args[0] % args[1:])
424
        self.overrideAttr(trace, 'warning', warning)
425
        msg = 'Value "%s" is not a boolean for "%s"'
4840.2.6 by Vincent Ladeuil
Implement config.suppress_warning.
426
        self.assertIs(None, get_bool('an_invalid_bool'))
4989.2.12 by Vincent Ladeuil
Display a warning if an option value is not boolean.
427
        self.assertEquals(msg % ('maybe', 'an_invalid_bool'), warnings[0])
428
        warnings = []
4840.2.6 by Vincent Ladeuil
Implement config.suppress_warning.
429
        self.assertIs(None, get_bool('not_defined_in_this_config'))
4989.2.12 by Vincent Ladeuil
Display a warning if an option value is not boolean.
430
        self.assertEquals([], warnings)
4840.2.4 by Vincent Ladeuil
Implement config.get_user_option_as_list.
431
432
    def test_get_user_option_as_list(self):
4840.2.6 by Vincent Ladeuil
Implement config.suppress_warning.
433
        conf, parser = self.make_config_parser("""
4840.2.4 by Vincent Ladeuil
Implement config.get_user_option_as_list.
434
a_list = a,b,c
435
length_1 = 1,
436
one_item = x
4840.2.6 by Vincent Ladeuil
Implement config.suppress_warning.
437
""")
438
        get_list = conf.get_user_option_as_list
4840.2.4 by Vincent Ladeuil
Implement config.get_user_option_as_list.
439
        self.assertEqual(['a', 'b', 'c'], get_list('a_list'))
440
        self.assertEqual(['1'], get_list('length_1'))
4840.2.6 by Vincent Ladeuil
Implement config.suppress_warning.
441
        self.assertEqual('x', conf.get_user_option('one_item'))
4840.2.4 by Vincent Ladeuil
Implement config.get_user_option_as_list.
442
        # automatically cast to list
443
        self.assertEqual(['x'], get_list('one_item'))
444
445
4840.2.6 by Vincent Ladeuil
Implement config.suppress_warning.
446
class TestSupressWarning(TestIniConfig):
447
448
    def make_warnings_config(self, s):
449
        conf, parser = self.make_config_parser(s)
450
        return conf.suppress_warning
451
452
    def test_suppress_warning_unknown(self):
453
        suppress_warning = self.make_warnings_config('')
454
        self.assertEqual(False, suppress_warning('unknown_warning'))
455
456
    def test_suppress_warning_known(self):
457
        suppress_warning = self.make_warnings_config('suppress_warnings=a,b')
458
        self.assertEqual(False, suppress_warning('c'))
459
        self.assertEqual(True, suppress_warning('a'))
460
        self.assertEqual(True, suppress_warning('b'))
461
462
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
463
class TestGetConfig(tests.TestCase):
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
464
465
    def test_constructs(self):
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
466
        my_config = config.GlobalConfig()
467
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
468
    def test_calls_read_filenames(self):
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
469
        # replace the class that is constructed, to check its parameters
1474 by Robert Collins
Merge from Aaron Bentley.
470
        oldparserclass = config.ConfigObj
471
        config.ConfigObj = InstrumentedConfigObj
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
472
        my_config = config.GlobalConfig()
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
473
        try:
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
474
            parser = my_config._get_parser()
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
475
        finally:
1474 by Robert Collins
Merge from Aaron Bentley.
476
            config.ConfigObj = oldparserclass
477
        self.failUnless(isinstance(parser, InstrumentedConfigObj))
1551.2.20 by Aaron Bentley
Treated config files as utf-8
478
        self.assertEqual(parser._calls, [('__init__', config.config_filename(),
479
                                          'utf-8')])
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
480
481
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
482
class TestBranchConfig(tests.TestCaseWithTransport):
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
483
484
    def test_constructs(self):
485
        branch = FakeBranch()
486
        my_config = config.BranchConfig(branch)
487
        self.assertRaises(TypeError, config.BranchConfig)
488
489
    def test_get_location_config(self):
490
        branch = FakeBranch()
491
        my_config = config.BranchConfig(branch)
492
        location_config = my_config._get_location_config()
493
        self.assertEqual(branch.base, location_config.location)
494
        self.failUnless(location_config is my_config._get_location_config())
495
1770.2.9 by Aaron Bentley
Add Branch.get_config, update BranchConfig() callers
496
    def test_get_config(self):
497
        """The Branch.get_config method works properly"""
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
498
        b = bzrdir.BzrDir.create_standalone_workingtree('.').branch
1770.2.9 by Aaron Bentley
Add Branch.get_config, update BranchConfig() callers
499
        my_config = b.get_config()
500
        self.assertIs(my_config.get_user_option('wacky'), None)
501
        my_config.set_user_option('wacky', 'unlikely')
502
        self.assertEqual(my_config.get_user_option('wacky'), 'unlikely')
503
504
        # Ensure we get the same thing if we start again
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
505
        b2 = branch.Branch.open('.')
1770.2.9 by Aaron Bentley
Add Branch.get_config, update BranchConfig() callers
506
        my_config2 = b2.get_config()
507
        self.assertEqual(my_config2.get_user_option('wacky'), 'unlikely')
508
1824.1.1 by Robert Collins
Add BranchConfig.has_explicit_nickname call.
509
    def test_has_explicit_nickname(self):
510
        b = self.make_branch('.')
511
        self.assertFalse(b.get_config().has_explicit_nickname())
512
        b.nick = 'foo'
513
        self.assertTrue(b.get_config().has_explicit_nickname())
514
1878.1.1 by John Arbash Meinel
Entries in locations.conf should prefer local paths if available (bug #53653)
515
    def test_config_url(self):
516
        """The Branch.get_config will use section that uses a local url"""
517
        branch = self.make_branch('branch')
518
        self.assertEqual('branch', branch.nick)
519
520
        locations = config.locations_config_filename()
521
        config.ensure_config_dir_exists()
522
        local_url = urlutils.local_path_to_url('branch')
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
523
        open(locations, 'wb').write('[%s]\nnickname = foobar'
1878.1.1 by John Arbash Meinel
Entries in locations.conf should prefer local paths if available (bug #53653)
524
                                    % (local_url,))
525
        self.assertEqual('foobar', branch.nick)
526
527
    def test_config_local_path(self):
528
        """The Branch.get_config will use a local system path"""
529
        branch = self.make_branch('branch')
530
        self.assertEqual('branch', branch.nick)
531
532
        locations = config.locations_config_filename()
533
        config.ensure_config_dir_exists()
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
534
        open(locations, 'wb').write('[%s/branch]\nnickname = barry'
1878.1.1 by John Arbash Meinel
Entries in locations.conf should prefer local paths if available (bug #53653)
535
                                    % (osutils.getcwd().encode('utf8'),))
536
        self.assertEqual('barry', branch.nick)
537
1878.1.2 by John Arbash Meinel
Add a test that new locations.conf entries are created with a local path, rather than a URL
538
    def test_config_creates_local(self):
539
        """Creating a new entry in config uses a local path."""
2230.3.6 by Aaron Bentley
work in progress bind stuff
540
        branch = self.make_branch('branch', format='knit')
1878.1.2 by John Arbash Meinel
Add a test that new locations.conf entries are created with a local path, rather than a URL
541
        branch.set_push_location('http://foobar')
542
        locations = config.locations_config_filename()
543
        local_path = osutils.getcwd().encode('utf8')
544
        # Surprisingly ConfigObj doesn't create a trailing newline
545
        self.check_file_contents(locations,
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
546
                                 '[%s/branch]\n'
547
                                 'push_location = http://foobar\n'
3221.7.1 by Matt Nordhoff
Upgrade ConfigObj to version 4.5.1.
548
                                 'push_location:policy = norecurse\n'
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
549
                                 % (local_path,))
1878.1.2 by John Arbash Meinel
Add a test that new locations.conf entries are created with a local path, rather than a URL
550
2120.5.4 by Alexander Belchenko
Whitebox test for Config.get_nickname (req. by Aaron Bentley)
551
    def test_autonick_urlencoded(self):
552
        b = self.make_branch('!repo')
553
        self.assertEqual('!repo', b.get_config().get_nickname())
554
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
555
    def test_warn_if_masked(self):
556
        _warning = trace.warning
557
        warnings = []
558
        def warning(*args):
559
            warnings.append(args[0] % args[1:])
560
561
        def set_option(store, warn_masked=True):
562
            warnings[:] = []
563
            conf.set_user_option('example_option', repr(store), store=store,
564
                                 warn_masked=warn_masked)
565
        def assertWarning(warning):
566
            if warning is None:
567
                self.assertEqual(0, len(warnings))
568
            else:
569
                self.assertEqual(1, len(warnings))
570
                self.assertEqual(warning, warnings[0])
571
        trace.warning = warning
572
        try:
573
            branch = self.make_branch('.')
574
            conf = branch.get_config()
575
            set_option(config.STORE_GLOBAL)
576
            assertWarning(None)
577
            set_option(config.STORE_BRANCH)
578
            assertWarning(None)
579
            set_option(config.STORE_GLOBAL)
580
            assertWarning('Value "4" is masked by "3" from branch.conf')
581
            set_option(config.STORE_GLOBAL, warn_masked=False)
582
            assertWarning(None)
583
            set_option(config.STORE_LOCATION)
584
            assertWarning(None)
585
            set_option(config.STORE_BRANCH)
586
            assertWarning('Value "3" is masked by "0" from locations.conf')
587
            set_option(config.STORE_BRANCH, warn_masked=False)
588
            assertWarning(None)
589
        finally:
590
            trace.warning = _warning
591
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
592
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
593
class TestGlobalConfigItems(tests.TestCase):
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
594
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
595
    def test_user_id(self):
1551.2.20 by Aaron Bentley
Treated config files as utf-8
596
        config_file = StringIO(sample_config_text.encode('utf-8'))
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
597
        my_config = config.GlobalConfig(_content=config_file)
1551.2.21 by Aaron Bentley
Formatted unicode config tests as ASCII
598
        self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
599
                         my_config._get_user_id())
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
600
601
    def test_absent_user_id(self):
602
        config_file = StringIO("")
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
603
        my_config = config.GlobalConfig(_content=config_file)
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
604
        self.assertEqual(None, my_config._get_user_id())
605
606
    def test_configured_editor(self):
1551.2.20 by Aaron Bentley
Treated config files as utf-8
607
        config_file = StringIO(sample_config_text.encode('utf-8'))
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
608
        my_config = config.GlobalConfig(_content=config_file)
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
609
        self.assertEqual("vim", my_config.get_editor())
610
1442.1.17 by Robert Collins
allow global overriding of signature policy to force checking, or (pointless but allowed) to set auto checking
611
    def test_signatures_always(self):
612
        config_file = StringIO(sample_always_signatures)
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
613
        my_config = config.GlobalConfig(_content=config_file)
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
614
        self.assertEqual(config.CHECK_NEVER,
1442.1.17 by Robert Collins
allow global overriding of signature policy to force checking, or (pointless but allowed) to set auto checking
615
                         my_config.signature_checking())
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
616
        self.assertEqual(config.SIGN_ALWAYS,
617
                         my_config.signing_policy())
1442.1.21 by Robert Collins
create signature_needed() call for commit to trigger creating signatures
618
        self.assertEqual(True, my_config.signature_needed())
1442.1.17 by Robert Collins
allow global overriding of signature policy to force checking, or (pointless but allowed) to set auto checking
619
620
    def test_signatures_if_possible(self):
621
        config_file = StringIO(sample_maybe_signatures)
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
622
        my_config = config.GlobalConfig(_content=config_file)
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
623
        self.assertEqual(config.CHECK_NEVER,
1442.1.17 by Robert Collins
allow global overriding of signature policy to force checking, or (pointless but allowed) to set auto checking
624
                         my_config.signature_checking())
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
625
        self.assertEqual(config.SIGN_WHEN_REQUIRED,
626
                         my_config.signing_policy())
1442.1.21 by Robert Collins
create signature_needed() call for commit to trigger creating signatures
627
        self.assertEqual(False, my_config.signature_needed())
1442.1.17 by Robert Collins
allow global overriding of signature policy to force checking, or (pointless but allowed) to set auto checking
628
1442.1.16 by Robert Collins
allow global overriding of signature policy to never check
629
    def test_signatures_ignore(self):
630
        config_file = StringIO(sample_ignore_signatures)
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
631
        my_config = config.GlobalConfig(_content=config_file)
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
632
        self.assertEqual(config.CHECK_ALWAYS,
1442.1.16 by Robert Collins
allow global overriding of signature policy to never check
633
                         my_config.signature_checking())
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
634
        self.assertEqual(config.SIGN_NEVER,
635
                         my_config.signing_policy())
1442.1.21 by Robert Collins
create signature_needed() call for commit to trigger creating signatures
636
        self.assertEqual(False, my_config.signature_needed())
1442.1.16 by Robert Collins
allow global overriding of signature policy to never check
637
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
638
    def _get_sample_config(self):
1551.2.20 by Aaron Bentley
Treated config files as utf-8
639
        config_file = StringIO(sample_config_text.encode('utf-8'))
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
640
        my_config = config.GlobalConfig(_content=config_file)
1534.7.154 by Aaron Bentley
Removed changes from bzr.ab 1529..1536
641
        return my_config
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
642
1442.1.56 by Robert Collins
gpg_signing_command configuration item
643
    def test_gpg_signing_command(self):
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
644
        my_config = self._get_sample_config()
1442.1.56 by Robert Collins
gpg_signing_command configuration item
645
        self.assertEqual("gnome-gpg", my_config.gpg_signing_command())
646
        self.assertEqual(False, my_config.signature_needed())
647
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
648
    def _get_empty_config(self):
649
        config_file = StringIO("")
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
650
        my_config = config.GlobalConfig(_content=config_file)
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
651
        return my_config
652
1442.1.59 by Robert Collins
Add re-sign command to generate a digital signature on a single revision.
653
    def test_gpg_signing_command_unset(self):
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
654
        my_config = self._get_empty_config()
1442.1.59 by Robert Collins
Add re-sign command to generate a digital signature on a single revision.
655
        self.assertEqual("gpg", my_config.gpg_signing_command())
656
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
657
    def test_get_user_option_default(self):
658
        my_config = self._get_empty_config()
659
        self.assertEqual(None, my_config.get_user_option('no_option'))
660
661
    def test_get_user_option_global(self):
662
        my_config = self._get_sample_config()
663
        self.assertEqual("something",
664
                         my_config.get_user_option('user_global_option'))
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
665
1472 by Robert Collins
post commit hook, first pass implementation
666
    def test_post_commit_default(self):
667
        my_config = self._get_sample_config()
668
        self.assertEqual(None, my_config.post_commit())
669
1553.2.9 by Erik Bågfors
log_formatter => log_format for "named" formatters
670
    def test_configured_logformat(self):
1553.2.8 by Erik Bågfors
tests for config log_formatter
671
        my_config = self._get_sample_config()
1553.2.9 by Erik Bågfors
log_formatter => log_format for "named" formatters
672
        self.assertEqual("short", my_config.log_format())
1553.2.8 by Erik Bågfors
tests for config log_formatter
673
1553.6.12 by Erik Bågfors
remove AliasConfig, based on input from abentley
674
    def test_get_alias(self):
675
        my_config = self._get_sample_config()
676
        self.assertEqual('help', my_config.get_alias('h'))
677
2900.3.6 by Tim Penhey
Added tests.
678
    def test_get_aliases(self):
679
        my_config = self._get_sample_config()
680
        aliases = my_config.get_aliases()
681
        self.assertEqual(2, len(aliases))
682
        sorted_keys = sorted(aliases)
683
        self.assertEqual('help', aliases[sorted_keys[0]])
684
        self.assertEqual(sample_long_alias, aliases[sorted_keys[1]])
685
1553.6.12 by Erik Bågfors
remove AliasConfig, based on input from abentley
686
    def test_get_no_alias(self):
687
        my_config = self._get_sample_config()
688
        self.assertEqual(None, my_config.get_alias('foo'))
689
690
    def test_get_long_alias(self):
691
        my_config = self._get_sample_config()
692
        self.assertEqual(sample_long_alias, my_config.get_alias('ll'))
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
693
4603.1.10 by Aaron Bentley
Provide change editor via config.
694
    def test_get_change_editor(self):
695
        my_config = self._get_sample_config()
696
        change_editor = my_config.get_change_editor('old', 'new')
697
        self.assertIs(diff.DiffFromTool, change_editor.__class__)
4603.1.20 by Aaron Bentley
Use string.Template substitution with @ as delimiter.
698
        self.assertEqual('vimdiff -of @new_path @old_path',
4603.1.10 by Aaron Bentley
Provide change editor via config.
699
                         ' '.join(change_editor.command_template))
700
701
    def test_get_no_change_editor(self):
702
        my_config = self._get_empty_config()
703
        change_editor = my_config.get_change_editor('old', 'new')
704
        self.assertIs(None, change_editor)
705
1704.2.18 by Martin Pool
Remove duplicated TestLocationConfig and update previously hidden tests. (#32587)
706
2900.3.6 by Tim Penhey
Added tests.
707
class TestGlobalConfigSavingOptions(tests.TestCaseInTempDir):
708
709
    def test_empty(self):
710
        my_config = config.GlobalConfig()
711
        self.assertEqual(0, len(my_config.get_aliases()))
712
713
    def test_set_alias(self):
714
        my_config = config.GlobalConfig()
715
        alias_value = 'commit --strict'
716
        my_config.set_alias('commit', alias_value)
717
        new_config = config.GlobalConfig()
718
        self.assertEqual(alias_value, new_config.get_alias('commit'))
719
720
    def test_remove_alias(self):
721
        my_config = config.GlobalConfig()
722
        my_config.set_alias('commit', 'commit --strict')
723
        # Now remove the alias again.
724
        my_config.unset_alias('commit')
725
        new_config = config.GlobalConfig()
726
        self.assertIs(None, new_config.get_alias('commit'))
727
728
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
729
class TestLocationConfig(tests.TestCaseInTempDir):
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
730
731
    def test_constructs(self):
732
        my_config = config.LocationConfig('http://example.com')
733
        self.assertRaises(TypeError, config.LocationConfig)
734
735
    def test_branch_calls_read_filenames(self):
1474 by Robert Collins
Merge from Aaron Bentley.
736
        # This is testing the correct file names are provided.
737
        # TODO: consolidate with the test for GlobalConfigs filename checks.
738
        #
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
739
        # replace the class that is constructed, to check its parameters
1474 by Robert Collins
Merge from Aaron Bentley.
740
        oldparserclass = config.ConfigObj
741
        config.ConfigObj = InstrumentedConfigObj
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
742
        try:
1770.2.2 by Aaron Bentley
Rename branches.conf to locations.conf
743
            my_config = config.LocationConfig('http://www.example.com')
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
744
            parser = my_config._get_parser()
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
745
        finally:
1474 by Robert Collins
Merge from Aaron Bentley.
746
            config.ConfigObj = oldparserclass
747
        self.failUnless(isinstance(parser, InstrumentedConfigObj))
748
        self.assertEqual(parser._calls,
1770.2.2 by Aaron Bentley
Rename branches.conf to locations.conf
749
                         [('__init__', config.locations_config_filename(),
1704.2.18 by Martin Pool
Remove duplicated TestLocationConfig and update previously hidden tests. (#32587)
750
                           'utf-8')])
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
751
752
    def test_get_global_config(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
753
        my_config = config.BranchConfig(FakeBranch('http://example.com'))
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
754
        global_config = my_config._get_global_config()
755
        self.failUnless(isinstance(global_config, config.GlobalConfig))
756
        self.failUnless(global_config is my_config._get_global_config())
757
1993.3.1 by James Henstridge
first go at making location config lookup recursive
758
    def test__get_matching_sections_no_match(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
759
        self.get_branch_config('/')
1993.3.1 by James Henstridge
first go at making location config lookup recursive
760
        self.assertEqual([], self.my_location_config._get_matching_sections())
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
761
1993.3.1 by James Henstridge
first go at making location config lookup recursive
762
    def test__get_matching_sections_exact(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
763
        self.get_branch_config('http://www.example.com')
1993.3.3 by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match
764
        self.assertEqual([('http://www.example.com', '')],
1993.3.1 by James Henstridge
first go at making location config lookup recursive
765
                         self.my_location_config._get_matching_sections())
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
766
1993.3.1 by James Henstridge
first go at making location config lookup recursive
767
    def test__get_matching_sections_suffix_does_not(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
768
        self.get_branch_config('http://www.example.com-com')
1993.3.1 by James Henstridge
first go at making location config lookup recursive
769
        self.assertEqual([], self.my_location_config._get_matching_sections())
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
770
1993.3.1 by James Henstridge
first go at making location config lookup recursive
771
    def test__get_matching_sections_subdir_recursive(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
772
        self.get_branch_config('http://www.example.com/com')
1993.3.3 by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match
773
        self.assertEqual([('http://www.example.com', 'com')],
1993.3.1 by James Henstridge
first go at making location config lookup recursive
774
                         self.my_location_config._get_matching_sections())
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
775
1993.3.5 by James Henstridge
add back recurse=False option to config file
776
    def test__get_matching_sections_ignoreparent(self):
1993.3.3 by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match
777
        self.get_branch_config('http://www.example.com/ignoreparent')
778
        self.assertEqual([('http://www.example.com/ignoreparent', '')],
1993.3.1 by James Henstridge
first go at making location config lookup recursive
779
                         self.my_location_config._get_matching_sections())
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
780
1993.3.5 by James Henstridge
add back recurse=False option to config file
781
    def test__get_matching_sections_ignoreparent_subdir(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
782
        self.get_branch_config(
1993.3.3 by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match
783
            'http://www.example.com/ignoreparent/childbranch')
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
784
        self.assertEqual([('http://www.example.com/ignoreparent',
785
                           'childbranch')],
1993.3.1 by James Henstridge
first go at making location config lookup recursive
786
                         self.my_location_config._get_matching_sections())
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
787
1993.3.1 by James Henstridge
first go at making location config lookup recursive
788
    def test__get_matching_sections_subdir_trailing_slash(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
789
        self.get_branch_config('/b')
1993.3.3 by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match
790
        self.assertEqual([('/b/', '')],
1993.3.1 by James Henstridge
first go at making location config lookup recursive
791
                         self.my_location_config._get_matching_sections())
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
792
1993.3.1 by James Henstridge
first go at making location config lookup recursive
793
    def test__get_matching_sections_subdir_child(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
794
        self.get_branch_config('/a/foo')
1993.3.3 by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match
795
        self.assertEqual([('/a/*', ''), ('/a/', 'foo')],
1993.3.1 by James Henstridge
first go at making location config lookup recursive
796
                         self.my_location_config._get_matching_sections())
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
797
1993.3.1 by James Henstridge
first go at making location config lookup recursive
798
    def test__get_matching_sections_subdir_child_child(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
799
        self.get_branch_config('/a/foo/bar')
1993.3.3 by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match
800
        self.assertEqual([('/a/*', 'bar'), ('/a/', 'foo/bar')],
1993.3.1 by James Henstridge
first go at making location config lookup recursive
801
                         self.my_location_config._get_matching_sections())
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
802
1993.3.1 by James Henstridge
first go at making location config lookup recursive
803
    def test__get_matching_sections_trailing_slash_with_children(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
804
        self.get_branch_config('/a/')
1993.3.3 by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match
805
        self.assertEqual([('/a/', '')],
1993.3.1 by James Henstridge
first go at making location config lookup recursive
806
                         self.my_location_config._get_matching_sections())
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
807
1993.3.1 by James Henstridge
first go at making location config lookup recursive
808
    def test__get_matching_sections_explicit_over_glob(self):
809
        # XXX: 2006-09-08 jamesh
810
        # This test only passes because ord('c') > ord('*').  If there
811
        # was a config section for '/a/?', it would get precedence
812
        # over '/a/c'.
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
813
        self.get_branch_config('/a/c')
1993.3.3 by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match
814
        self.assertEqual([('/a/c', ''), ('/a/*', ''), ('/a/', 'c')],
1993.3.1 by James Henstridge
first go at making location config lookup recursive
815
                         self.my_location_config._get_matching_sections())
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
816
2120.6.3 by James Henstridge
add some more tests for getting policy options, and behaviour of get_user_option in the presence of config policies
817
    def test__get_option_policy_normal(self):
818
        self.get_branch_config('http://www.example.com')
819
        self.assertEqual(
820
            self.my_location_config._get_config_policy(
821
            'http://www.example.com', 'normal_option'),
822
            config.POLICY_NONE)
823
824
    def test__get_option_policy_norecurse(self):
825
        self.get_branch_config('http://www.example.com')
826
        self.assertEqual(
827
            self.my_location_config._get_option_policy(
828
            'http://www.example.com', 'norecurse_option'),
829
            config.POLICY_NORECURSE)
830
        # Test old recurse=False setting:
831
        self.assertEqual(
832
            self.my_location_config._get_option_policy(
833
            'http://www.example.com/norecurse', 'normal_option'),
834
            config.POLICY_NORECURSE)
835
836
    def test__get_option_policy_normal(self):
837
        self.get_branch_config('http://www.example.com')
838
        self.assertEqual(
839
            self.my_location_config._get_option_policy(
840
            'http://www.example.com', 'appendpath_option'),
841
            config.POLICY_APPENDPATH)
842
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
843
    def test_location_without_username(self):
1993.3.3 by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match
844
        self.get_branch_config('http://www.example.com/ignoreparent')
1704.2.18 by Martin Pool
Remove duplicated TestLocationConfig and update previously hidden tests. (#32587)
845
        self.assertEqual(u'Erik B\u00e5gfors <erik@bagfors.nu>',
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
846
                         self.my_config.username())
847
848
    def test_location_not_listed(self):
1704.2.18 by Martin Pool
Remove duplicated TestLocationConfig and update previously hidden tests. (#32587)
849
        """Test that the global username is used when no location matches"""
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
850
        self.get_branch_config('/home/robertc/sources')
1704.2.18 by Martin Pool
Remove duplicated TestLocationConfig and update previously hidden tests. (#32587)
851
        self.assertEqual(u'Erik B\u00e5gfors <erik@bagfors.nu>',
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
852
                         self.my_config.username())
853
1442.1.13 by Robert Collins
branches.conf is now able to override the users email
854
    def test_overriding_location(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
855
        self.get_branch_config('http://www.example.com/foo')
1442.1.13 by Robert Collins
branches.conf is now able to override the users email
856
        self.assertEqual('Robert Collins <robertc@example.org>',
857
                         self.my_config.username())
1442.1.16 by Robert Collins
allow global overriding of signature policy to never check
858
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
859
    def test_signatures_not_set(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
860
        self.get_branch_config('http://www.example.com',
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
861
                                 global_config=sample_ignore_signatures)
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
862
        self.assertEqual(config.CHECK_ALWAYS,
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
863
                         self.my_config.signature_checking())
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
864
        self.assertEqual(config.SIGN_NEVER,
865
                         self.my_config.signing_policy())
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
866
867
    def test_signatures_never(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
868
        self.get_branch_config('/a/c')
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
869
        self.assertEqual(config.CHECK_NEVER,
870
                         self.my_config.signature_checking())
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
871
1442.1.16 by Robert Collins
allow global overriding of signature policy to never check
872
    def test_signatures_when_available(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
873
        self.get_branch_config('/a/', global_config=sample_ignore_signatures)
1442.1.16 by Robert Collins
allow global overriding of signature policy to never check
874
        self.assertEqual(config.CHECK_IF_POSSIBLE,
875
                         self.my_config.signature_checking())
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
876
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
877
    def test_signatures_always(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
878
        self.get_branch_config('/b')
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
879
        self.assertEqual(config.CHECK_ALWAYS,
880
                         self.my_config.signature_checking())
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
881
1442.1.56 by Robert Collins
gpg_signing_command configuration item
882
    def test_gpg_signing_command(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
883
        self.get_branch_config('/b')
1442.1.56 by Robert Collins
gpg_signing_command configuration item
884
        self.assertEqual("gnome-gpg", self.my_config.gpg_signing_command())
885
886
    def test_gpg_signing_command_missing(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
887
        self.get_branch_config('/a')
1442.1.56 by Robert Collins
gpg_signing_command configuration item
888
        self.assertEqual("false", self.my_config.gpg_signing_command())
889
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
890
    def test_get_user_option_global(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
891
        self.get_branch_config('/a')
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
892
        self.assertEqual('something',
893
                         self.my_config.get_user_option('user_global_option'))
894
895
    def test_get_user_option_local(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
896
        self.get_branch_config('/a')
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
897
        self.assertEqual('local',
898
                         self.my_config.get_user_option('user_local_option'))
1993.3.3 by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match
899
2120.6.3 by James Henstridge
add some more tests for getting policy options, and behaviour of get_user_option in the presence of config policies
900
    def test_get_user_option_appendpath(self):
901
        # returned as is for the base path:
902
        self.get_branch_config('http://www.example.com')
903
        self.assertEqual('append',
904
                         self.my_config.get_user_option('appendpath_option'))
905
        # Extra path components get appended:
906
        self.get_branch_config('http://www.example.com/a/b/c')
907
        self.assertEqual('append/a/b/c',
908
                         self.my_config.get_user_option('appendpath_option'))
909
        # Overriden for http://www.example.com/dir, where it is a
910
        # normal option:
911
        self.get_branch_config('http://www.example.com/dir/a/b/c')
912
        self.assertEqual('normal',
913
                         self.my_config.get_user_option('appendpath_option'))
914
915
    def test_get_user_option_norecurse(self):
916
        self.get_branch_config('http://www.example.com')
917
        self.assertEqual('norecurse',
918
                         self.my_config.get_user_option('norecurse_option'))
919
        self.get_branch_config('http://www.example.com/dir')
920
        self.assertEqual(None,
921
                         self.my_config.get_user_option('norecurse_option'))
922
        # http://www.example.com/norecurse is a recurse=False section
923
        # that redefines normal_option.  Subdirectories do not pick up
924
        # this redefinition.
925
        self.get_branch_config('http://www.example.com/norecurse')
926
        self.assertEqual('norecurse',
927
                         self.my_config.get_user_option('normal_option'))
928
        self.get_branch_config('http://www.example.com/norecurse/subdir')
929
        self.assertEqual('normal',
930
                         self.my_config.get_user_option('normal_option'))
931
2120.6.4 by James Henstridge
add support for specifying policy when storing options
932
    def test_set_user_option_norecurse(self):
933
        self.get_branch_config('http://www.example.com')
934
        self.my_config.set_user_option('foo', 'bar',
935
                                       store=config.STORE_LOCATION_NORECURSE)
936
        self.assertEqual(
937
            self.my_location_config._get_option_policy(
938
            'http://www.example.com', 'foo'),
939
            config.POLICY_NORECURSE)
940
941
    def test_set_user_option_appendpath(self):
942
        self.get_branch_config('http://www.example.com')
943
        self.my_config.set_user_option('foo', 'bar',
944
                                       store=config.STORE_LOCATION_APPENDPATH)
945
        self.assertEqual(
946
            self.my_location_config._get_option_policy(
947
            'http://www.example.com', 'foo'),
948
            config.POLICY_APPENDPATH)
949
950
    def test_set_user_option_change_policy(self):
951
        self.get_branch_config('http://www.example.com')
952
        self.my_config.set_user_option('norecurse_option', 'normal',
953
                                       store=config.STORE_LOCATION)
954
        self.assertEqual(
955
            self.my_location_config._get_option_policy(
956
            'http://www.example.com', 'norecurse_option'),
957
            config.POLICY_NONE)
958
959
    def test_set_user_option_recurse_false_section(self):
2120.6.9 by James Henstridge
Fixes for issues brought up in John's review
960
        # The following section has recurse=False set.  The test is to
961
        # make sure that a normal option can be added to the section,
962
        # converting recurse=False to the norecurse policy.
2120.6.4 by James Henstridge
add support for specifying policy when storing options
963
        self.get_branch_config('http://www.example.com/norecurse')
2120.6.11 by James Henstridge
s/0.13/0.14/ in deprecation warning
964
        self.callDeprecated(['The recurse option is deprecated as of 0.14.  '
2120.6.9 by James Henstridge
Fixes for issues brought up in John's review
965
                             'The section "http://www.example.com/norecurse" '
966
                             'has been converted to use policies.'],
967
                            self.my_config.set_user_option,
968
                            'foo', 'bar', store=config.STORE_LOCATION)
2120.6.4 by James Henstridge
add support for specifying policy when storing options
969
        self.assertEqual(
970
            self.my_location_config._get_option_policy(
971
            'http://www.example.com/norecurse', 'foo'),
972
            config.POLICY_NONE)
973
        # The previously existing option is still norecurse:
974
        self.assertEqual(
975
            self.my_location_config._get_option_policy(
976
            'http://www.example.com/norecurse', 'normal_option'),
977
            config.POLICY_NORECURSE)
978
1472 by Robert Collins
post commit hook, first pass implementation
979
    def test_post_commit_default(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
980
        self.get_branch_config('/a/c')
1185.31.25 by John Arbash Meinel
Renamed all of the tests from selftest/foo.py to tests/test_foo.py
981
        self.assertEqual('bzrlib.tests.test_config.post_commit',
1472 by Robert Collins
post commit hook, first pass implementation
982
                         self.my_config.post_commit())
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
983
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
984
    def get_branch_config(self, location, global_config=None):
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
985
        my_branch = FakeBranch(location)
1502 by Robert Collins
Bugfix the config test suite to not create .bazaar in the dir where it is run.
986
        if global_config is None:
1551.2.20 by Aaron Bentley
Treated config files as utf-8
987
            global_file = StringIO(sample_config_text.encode('utf-8'))
1502 by Robert Collins
Bugfix the config test suite to not create .bazaar in the dir where it is run.
988
        else:
1551.2.20 by Aaron Bentley
Treated config files as utf-8
989
            global_file = StringIO(global_config.encode('utf-8'))
990
        branches_file = StringIO(sample_branches_text.encode('utf-8'))
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
991
992
        config.ensure_config_dir_exists()
993
        my_global_config = config.GlobalConfig(_content=global_file)
994
        my_global_config._write_config_file()
995
        my_location_config = config.LocationConfig(my_branch.base,
996
                                                   _content=branches_file)
997
        my_location_config._write_config_file()
998
999
        my_config = config.BranchConfig(my_branch)
1000
        self.my_config = my_config
1001
        self.my_location_config = my_config._get_location_config()
1502 by Robert Collins
Bugfix the config test suite to not create .bazaar in the dir where it is run.
1002
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1003
    def test_set_user_setting_sets_and_saves(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
1004
        self.get_branch_config('/a/c')
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1005
        record = InstrumentedConfigObj("foo")
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
1006
        self.my_location_config._parser = record
1185.62.6 by John Arbash Meinel
Updated test_set_user_setting_sets_and_saves to remove the print statement, and make sure it is doing the right thing
1007
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
1008
        self.callDeprecated(['The recurse option is deprecated as of '
1009
                             '0.14.  The section "/a/c" has been '
1010
                             'converted to use policies.'],
1011
                            self.my_config.set_user_option,
1012
                            'foo', 'bar', store=config.STORE_LOCATION)
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1013
        self.assertEqual([('__contains__', '/a/c'),
1014
                          ('__contains__', '/a/c/'),
1015
                          ('__setitem__', '/a/c', {}),
1016
                          ('__getitem__', '/a/c'),
1017
                          ('__setitem__', 'foo', 'bar'),
2120.6.4 by James Henstridge
add support for specifying policy when storing options
1018
                          ('__getitem__', '/a/c'),
1019
                          ('as_bool', 'recurse'),
1020
                          ('__getitem__', '/a/c'),
1021
                          ('__delitem__', 'recurse'),
1022
                          ('__getitem__', '/a/c'),
1023
                          ('keys',),
2120.6.8 by James Henstridge
Change syntax for setting config option policies. Rather than
1024
                          ('__getitem__', '/a/c'),
1025
                          ('__contains__', 'foo:policy'),
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1026
                          ('write',)],
1027
                         record._calls[1:])
1028
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1029
    def test_set_user_setting_sets_and_saves2(self):
1030
        self.get_branch_config('/a/c')
1031
        self.assertIs(self.my_config.get_user_option('foo'), None)
1032
        self.my_config.set_user_option('foo', 'bar')
1033
        self.assertEqual(
3616.2.6 by Mark Hammond
Fix test_set_user_setting_sets_and_saves2 on windows by stripping EOL
1034
            self.my_config.branch.control_files.files['branch.conf'].strip(),
1035
            'foo = bar')
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1036
        self.assertEqual(self.my_config.get_user_option('foo'), 'bar')
2120.6.4 by James Henstridge
add support for specifying policy when storing options
1037
        self.my_config.set_user_option('foo', 'baz',
1038
                                       store=config.STORE_LOCATION)
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1039
        self.assertEqual(self.my_config.get_user_option('foo'), 'baz')
1040
        self.my_config.set_user_option('foo', 'qux')
1041
        self.assertEqual(self.my_config.get_user_option('foo'), 'baz')
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
1042
1551.18.17 by Aaron Bentley
Introduce bzr_remote_path configuration variable
1043
    def test_get_bzr_remote_path(self):
1044
        my_config = config.LocationConfig('/a/c')
1045
        self.assertEqual('bzr', my_config.get_bzr_remote_path())
1046
        my_config.set_user_option('bzr_remote_path', '/path-bzr')
1047
        self.assertEqual('/path-bzr', my_config.get_bzr_remote_path())
1048
        os.environ['BZR_REMOTE_PATH'] = '/environ-bzr'
1049
        self.assertEqual('/environ-bzr', my_config.get_bzr_remote_path())
1050
1185.62.7 by John Arbash Meinel
Whitespace cleanup.
1051
1770.2.8 by Aaron Bentley
Add precedence test
1052
precedence_global = 'option = global'
1053
precedence_branch = 'option = branch'
1054
precedence_location = """
1055
[http://]
1056
recurse = true
1057
option = recurse
1058
[http://example.com/specific]
1059
option = exact
1060
"""
1061
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
1062
class TestBranchConfigItems(tests.TestCaseInTempDir):
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
1063
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
1064
    def get_branch_config(self, global_config=None, location=None,
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1065
                          location_config=None, branch_data_config=None):
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
1066
        my_branch = FakeBranch(location)
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
1067
        if global_config is not None:
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
1068
            my_global_config = config.GlobalConfig(
1069
                _content=StringIO(global_config.encode('utf-8')))
1070
            config.ensure_config_dir_exists()
1071
            my_global_config._write_config_file()
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
1072
        if location_config is not None:
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
1073
            my_location_config = config.LocationConfig(
1074
                my_branch.base,
1075
                _content=StringIO(location_config.encode('utf-8')))
1076
            config.ensure_config_dir_exists()
1077
            my_location_config._write_config_file()
1078
        my_config = config.BranchConfig(my_branch)
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1079
        if branch_data_config is not None:
1080
            my_config.branch.control_files.files['branch.conf'] = \
1081
                branch_data_config
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
1082
        return my_config
1083
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
1084
    def test_user_id(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
1085
        branch = FakeBranch(user_id='Robert Collins <robertc@example.net>')
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
1086
        my_config = config.BranchConfig(branch)
1087
        self.assertEqual("Robert Collins <robertc@example.net>",
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1088
                         my_config.username())
3388.2.3 by Martin Pool
Fix up more uses of LockableFiles.get_utf8 in tests
1089
        my_config.branch.control_files.files['email'] = "John"
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
1090
        my_config.set_user_option('email',
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1091
                                  "Robert Collins <robertc@example.org>")
1092
        self.assertEqual("John", my_config.username())
3388.2.3 by Martin Pool
Fix up more uses of LockableFiles.get_utf8 in tests
1093
        del my_config.branch.control_files.files['email']
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1094
        self.assertEqual("Robert Collins <robertc@example.org>",
1095
                         my_config.username())
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
1096
1097
    def test_not_set_in_branch(self):
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
1098
        my_config = self.get_branch_config(global_config=sample_config_text)
1551.2.21 by Aaron Bentley
Formatted unicode config tests as ASCII
1099
        self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
1100
                         my_config._get_user_id())
3388.2.3 by Martin Pool
Fix up more uses of LockableFiles.get_utf8 in tests
1101
        my_config.branch.control_files.files['email'] = "John"
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
1102
        self.assertEqual("John", my_config._get_user_id())
1103
1861.4.1 by Matthieu Moy
BZREMAIL renamed to BZR_EMAIL.
1104
    def test_BZR_EMAIL_OVERRIDES(self):
1105
        os.environ['BZR_EMAIL'] = "Robert Collins <robertc@example.org>"
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
1106
        branch = FakeBranch()
1107
        my_config = config.BranchConfig(branch)
1108
        self.assertEqual("Robert Collins <robertc@example.org>",
1109
                         my_config.username())
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
1110
1442.1.19 by Robert Collins
BranchConfigs inherit signature_checking policy from their LocationConfig.
1111
    def test_signatures_forced(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
1112
        my_config = self.get_branch_config(
1113
            global_config=sample_always_signatures)
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
1114
        self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
1115
        self.assertEqual(config.SIGN_ALWAYS, my_config.signing_policy())
1116
        self.assertTrue(my_config.signature_needed())
1442.1.56 by Robert Collins
gpg_signing_command configuration item
1117
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1118
    def test_signatures_forced_branch(self):
1119
        my_config = self.get_branch_config(
1120
            global_config=sample_ignore_signatures,
1121
            branch_data_config=sample_always_signatures)
1122
        self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
1123
        self.assertEqual(config.SIGN_ALWAYS, my_config.signing_policy())
1124
        self.assertTrue(my_config.signature_needed())
1125
1442.1.56 by Robert Collins
gpg_signing_command configuration item
1126
    def test_gpg_signing_command(self):
1770.2.10 by Aaron Bentley
Added test that branch_config can't influence gpg_signing_command
1127
        my_config = self.get_branch_config(
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
1128
            global_config=sample_config_text,
1770.2.10 by Aaron Bentley
Added test that branch_config can't influence gpg_signing_command
1129
            # branch data cannot set gpg_signing_command
1130
            branch_data_config="gpg_signing_command=pgp")
1442.1.56 by Robert Collins
gpg_signing_command configuration item
1131
        self.assertEqual('gnome-gpg', my_config.gpg_signing_command())
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
1132
1133
    def test_get_user_option_global(self):
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
1134
        my_config = self.get_branch_config(global_config=sample_config_text)
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
1135
        self.assertEqual('something',
1136
                         my_config.get_user_option('user_global_option'))
1472 by Robert Collins
post commit hook, first pass implementation
1137
1138
    def test_post_commit_default(self):
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
1139
        my_config = self.get_branch_config(global_config=sample_config_text,
1140
                                      location='/a/c',
1141
                                      location_config=sample_branches_text)
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
1142
        self.assertEqual(my_config.branch.base, '/a/c')
1185.31.25 by John Arbash Meinel
Renamed all of the tests from selftest/foo.py to tests/test_foo.py
1143
        self.assertEqual('bzrlib.tests.test_config.post_commit',
1472 by Robert Collins
post commit hook, first pass implementation
1144
                         my_config.post_commit())
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1145
        my_config.set_user_option('post_commit', 'rmtree_root')
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
1146
        # post-commit is ignored when present in branch data
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1147
        self.assertEqual('bzrlib.tests.test_config.post_commit',
1148
                         my_config.post_commit())
2120.6.4 by James Henstridge
add support for specifying policy when storing options
1149
        my_config.set_user_option('post_commit', 'rmtree_root',
1150
                                  store=config.STORE_LOCATION)
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1151
        self.assertEqual('rmtree_root', my_config.post_commit())
1185.33.31 by Martin Pool
Make annotate cope better with revisions committed without a valid
1152
1770.2.8 by Aaron Bentley
Add precedence test
1153
    def test_config_precedence(self):
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
1154
        # FIXME: eager test, luckily no persitent config file makes it fail
1155
        # -- vila 20100716
1770.2.8 by Aaron Bentley
Add precedence test
1156
        my_config = self.get_branch_config(global_config=precedence_global)
1157
        self.assertEqual(my_config.get_user_option('option'), 'global')
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
1158
        my_config = self.get_branch_config(global_config=precedence_global,
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
1159
                                           branch_data_config=precedence_branch)
1770.2.8 by Aaron Bentley
Add precedence test
1160
        self.assertEqual(my_config.get_user_option('option'), 'branch')
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
1161
        my_config = self.get_branch_config(
1162
            global_config=precedence_global,
1163
            branch_data_config=precedence_branch,
1164
            location_config=precedence_location)
1770.2.8 by Aaron Bentley
Add precedence test
1165
        self.assertEqual(my_config.get_user_option('option'), 'recurse')
5345.1.5 by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light.
1166
        my_config = self.get_branch_config(
1167
            global_config=precedence_global,
1168
            branch_data_config=precedence_branch,
1169
            location_config=precedence_location,
1170
            location='http://example.com/specific')
1770.2.8 by Aaron Bentley
Add precedence test
1171
        self.assertEqual(my_config.get_user_option('option'), 'exact')
1172
2681.1.8 by Aaron Bentley
Add Thunderbird support to bzr send
1173
    def test_get_mail_client(self):
1174
        config = self.get_branch_config()
1175
        client = config.get_mail_client()
2681.1.24 by Aaron Bentley
Handle default mail client by trying xdg-email, falling back to editor
1176
        self.assertIsInstance(client, mail_client.DefaultMail)
1177
2790.2.2 by Keir Mierle
Change alphabetic ordering into two categories; one for specific clients the other for generic options.
1178
        # Specific clients
2681.1.21 by Aaron Bentley
Refactor prompt generation to make it testable, test it with unicode
1179
        config.set_user_option('mail_client', 'evolution')
1180
        client = config.get_mail_client()
1181
        self.assertIsInstance(client, mail_client.Evolution)
1182
2681.5.1 by ghigo
Add KMail support to bzr send
1183
        config.set_user_option('mail_client', 'kmail')
1184
        client = config.get_mail_client()
1185
        self.assertIsInstance(client, mail_client.KMail)
1186
2790.2.1 by Keir Mierle
Add Mutt as a supported client email program. Also rearranges various listings
1187
        config.set_user_option('mail_client', 'mutt')
1188
        client = config.get_mail_client()
1189
        self.assertIsInstance(client, mail_client.Mutt)
1190
1191
        config.set_user_option('mail_client', 'thunderbird')
1192
        client = config.get_mail_client()
1193
        self.assertIsInstance(client, mail_client.Thunderbird)
1194
2790.2.2 by Keir Mierle
Change alphabetic ordering into two categories; one for specific clients the other for generic options.
1195
        # Generic options
1196
        config.set_user_option('mail_client', 'default')
1197
        client = config.get_mail_client()
1198
        self.assertIsInstance(client, mail_client.DefaultMail)
1199
1200
        config.set_user_option('mail_client', 'editor')
1201
        client = config.get_mail_client()
1202
        self.assertIsInstance(client, mail_client.Editor)
1203
1204
        config.set_user_option('mail_client', 'mapi')
1205
        client = config.get_mail_client()
1206
        self.assertIsInstance(client, mail_client.MAPIClient)
1207
2681.1.23 by Aaron Bentley
Add support for xdg-email
1208
        config.set_user_option('mail_client', 'xdg-email')
1209
        client = config.get_mail_client()
1210
        self.assertIsInstance(client, mail_client.XDGEmail)
1211
2681.1.10 by Aaron Bentley
Clean up handling of unknown mail clients
1212
        config.set_user_option('mail_client', 'firebird')
1213
        self.assertRaises(errors.UnknownMailClient, config.get_mail_client)
1214
1185.33.31 by Martin Pool
Make annotate cope better with revisions committed without a valid
1215
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
1216
class TestMailAddressExtraction(tests.TestCase):
1185.33.31 by Martin Pool
Make annotate cope better with revisions committed without a valid
1217
1218
    def test_extract_email_address(self):
1219
        self.assertEqual('jane@test.com',
1220
                         config.extract_email_address('Jane <jane@test.com>'))
2055.2.2 by John Arbash Meinel
Switch extract_email_address() to use a more specific exception
1221
        self.assertRaises(errors.NoEmailInUsername,
1185.33.31 by Martin Pool
Make annotate cope better with revisions committed without a valid
1222
                          config.extract_email_address, 'Jane Tester')
2533.1.1 by James Westby
Fix TreeConfig to return values from sections.
1223
3063.3.2 by Lukáš Lalinský
Move the name and e-mail address extraction logic to config.parse_username.
1224
    def test_parse_username(self):
1225
        self.assertEqual(('', 'jdoe@example.com'),
1226
                         config.parse_username('jdoe@example.com'))
1227
        self.assertEqual(('', 'jdoe@example.com'),
1228
                         config.parse_username('<jdoe@example.com>'))
1229
        self.assertEqual(('John Doe', 'jdoe@example.com'),
1230
                         config.parse_username('John Doe <jdoe@example.com>'))
1231
        self.assertEqual(('John Doe', ''),
1232
                         config.parse_username('John Doe'))
3063.3.3 by Lukáš Lalinský
Add one more test for config.parse_username().
1233
        self.assertEqual(('John Doe', 'jdoe@example.com'),
1234
                         config.parse_username('John Doe jdoe@example.com'))
2562.1.2 by John Arbash Meinel
Clean up whitespace
1235
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
1236
class TestTreeConfig(tests.TestCaseWithTransport):
2533.1.1 by James Westby
Fix TreeConfig to return values from sections.
1237
1238
    def test_get_value(self):
1239
        """Test that retreiving a value from a section is possible"""
1240
        branch = self.make_branch('.')
1241
        tree_config = config.TreeConfig(branch)
1242
        tree_config.set_option('value', 'key', 'SECTION')
1243
        tree_config.set_option('value2', 'key2')
1244
        tree_config.set_option('value3-top', 'key3')
1245
        tree_config.set_option('value3-section', 'key3', 'SECTION')
1246
        value = tree_config.get_option('key', 'SECTION')
1247
        self.assertEqual(value, 'value')
1248
        value = tree_config.get_option('key2')
1249
        self.assertEqual(value, 'value2')
1250
        self.assertEqual(tree_config.get_option('non-existant'), None)
1251
        value = tree_config.get_option('non-existant', 'SECTION')
1252
        self.assertEqual(value, None)
1253
        value = tree_config.get_option('non-existant', default='default')
1254
        self.assertEqual(value, 'default')
1255
        self.assertEqual(tree_config.get_option('key2', 'NOSECTION'), None)
1256
        value = tree_config.get_option('key2', 'NOSECTION', default='default')
1257
        self.assertEqual(value, 'default')
1258
        value = tree_config.get_option('key3')
1259
        self.assertEqual(value, 'value3-top')
1260
        value = tree_config.get_option('key3', 'SECTION')
1261
        self.assertEqual(value, 'value3-section')
2900.2.3 by Vincent Ladeuil
Credentials matching implementation.
1262
1263
3242.1.2 by Aaron Bentley
Turn BzrDirConfig into TransportConfig, reduce code duplication
1264
class TestTransportConfig(tests.TestCaseWithTransport):
3242.1.1 by Aaron Bentley
Implement BzrDir configuration
1265
1266
    def test_get_value(self):
1267
        """Test that retreiving a value from a section is possible"""
3242.1.2 by Aaron Bentley
Turn BzrDirConfig into TransportConfig, reduce code duplication
1268
        bzrdir_config = config.TransportConfig(transport.get_transport('.'),
1269
                                               'control.conf')
3242.1.1 by Aaron Bentley
Implement BzrDir configuration
1270
        bzrdir_config.set_option('value', 'key', 'SECTION')
1271
        bzrdir_config.set_option('value2', 'key2')
1272
        bzrdir_config.set_option('value3-top', 'key3')
1273
        bzrdir_config.set_option('value3-section', 'key3', 'SECTION')
1274
        value = bzrdir_config.get_option('key', 'SECTION')
1275
        self.assertEqual(value, 'value')
1276
        value = bzrdir_config.get_option('key2')
1277
        self.assertEqual(value, 'value2')
1278
        self.assertEqual(bzrdir_config.get_option('non-existant'), None)
1279
        value = bzrdir_config.get_option('non-existant', 'SECTION')
1280
        self.assertEqual(value, None)
1281
        value = bzrdir_config.get_option('non-existant', default='default')
1282
        self.assertEqual(value, 'default')
1283
        self.assertEqual(bzrdir_config.get_option('key2', 'NOSECTION'), None)
1284
        value = bzrdir_config.get_option('key2', 'NOSECTION',
1285
                                         default='default')
1286
        self.assertEqual(value, 'default')
1287
        value = bzrdir_config.get_option('key3')
1288
        self.assertEqual(value, 'value3-top')
1289
        value = bzrdir_config.get_option('key3', 'SECTION')
1290
        self.assertEqual(value, 'value3-section')
1291
3242.3.11 by Aaron Bentley
Clean up BzrDirConfig usage
1292
    def test_set_unset_default_stack_on(self):
1293
        my_dir = self.make_bzrdir('.')
4288.1.3 by Robert Collins
Fix BzrDirConfig tests.
1294
        bzrdir_config = config.BzrDirConfig(my_dir)
3242.3.11 by Aaron Bentley
Clean up BzrDirConfig usage
1295
        self.assertIs(None, bzrdir_config.get_default_stack_on())
1296
        bzrdir_config.set_default_stack_on('Foo')
3242.3.14 by Aaron Bentley
Make BzrDirConfig use TransportConfig
1297
        self.assertEqual('Foo', bzrdir_config._config.get_option(
1298
                         'default_stack_on'))
3242.3.11 by Aaron Bentley
Clean up BzrDirConfig usage
1299
        self.assertEqual('Foo', bzrdir_config.get_default_stack_on())
1300
        bzrdir_config.set_default_stack_on(None)
1301
        self.assertIs(None, bzrdir_config.get_default_stack_on())
1302
3242.1.1 by Aaron Bentley
Implement BzrDir configuration
1303
2900.2.5 by Vincent Ladeuil
ake ftp aware of authentication config.
1304
class TestAuthenticationConfigFile(tests.TestCase):
2900.2.14 by Vincent Ladeuil
More tests.
1305
    """Test the authentication.conf file matching"""
2900.2.3 by Vincent Ladeuil
Credentials matching implementation.
1306
1307
    def _got_user_passwd(self, expected_user, expected_password,
1308
                         config, *args, **kwargs):
1309
        credentials = config.get_credentials(*args, **kwargs)
1310
        if credentials is None:
1311
            user = None
1312
            password = None
1313
        else:
1314
            user = credentials['user']
1315
            password = credentials['password']
1316
        self.assertEquals(expected_user, user)
1317
        self.assertEquals(expected_password, password)
1318
2978.5.1 by John Arbash Meinel
Fix bug #162494, 'bzr register-branch' needs proper auth handling.
1319
    def test_empty_config(self):
2900.2.3 by Vincent Ladeuil
Credentials matching implementation.
1320
        conf = config.AuthenticationConfig(_file=StringIO())
1321
        self.assertEquals({}, conf._get_config())
1322
        self._got_user_passwd(None, None, conf, 'http', 'foo.net')
1323
3418.2.1 by Vincent Ladeuil
Fix #217650 by catching declarations outside sections.
1324
    def test_missing_auth_section_header(self):
1325
        conf = config.AuthenticationConfig(_file=StringIO('foo = bar'))
1326
        self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
1327
1328
    def test_auth_section_header_not_closed(self):
2900.2.3 by Vincent Ladeuil
Credentials matching implementation.
1329
        conf = config.AuthenticationConfig(_file=StringIO('[DEF'))
1330
        self.assertRaises(errors.ParseConfigError, conf._get_config)
2900.2.15 by Vincent Ladeuil
AuthenticationConfig can be queried for logins too (first step).
1331
3418.2.1 by Vincent Ladeuil
Fix #217650 by catching declarations outside sections.
1332
    def test_auth_value_not_boolean(self):
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
1333
        conf = config.AuthenticationConfig(_file=StringIO(
1334
                """[broken]
1335
scheme=ftp
1336
user=joe
2900.2.15 by Vincent Ladeuil
AuthenticationConfig can be queried for logins too (first step).
1337
verify_certificates=askme # Error: Not a boolean
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
1338
"""))
1339
        self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
3418.2.1 by Vincent Ladeuil
Fix #217650 by catching declarations outside sections.
1340
1341
    def test_auth_value_not_int(self):
2900.2.22 by Vincent Ladeuil
Polishing.
1342
        conf = config.AuthenticationConfig(_file=StringIO(
1343
                """[broken]
1344
scheme=ftp
1345
user=joe
1346
port=port # Error: Not an int
1347
"""))
1348
        self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
2900.2.3 by Vincent Ladeuil
Credentials matching implementation.
1349
3757.3.1 by Vincent Ladeuil
Add credential stores plugging.
1350
    def test_unknown_password_encoding(self):
1351
        conf = config.AuthenticationConfig(_file=StringIO(
1352
                """[broken]
1353
scheme=ftp
1354
user=joe
1355
password_encoding=unknown
1356
"""))
1357
        self.assertRaises(ValueError, conf.get_password,
1358
                          'ftp', 'foo.net', 'joe')
1359
2900.2.3 by Vincent Ladeuil
Credentials matching implementation.
1360
    def test_credentials_for_scheme_host(self):
1361
        conf = config.AuthenticationConfig(_file=StringIO(
1362
                """# Identity on foo.net
1363
[ftp definition]
1364
scheme=ftp
1365
host=foo.net
1366
user=joe
1367
password=secret-pass
1368
"""))
1369
        # Basic matching
1370
        self._got_user_passwd('joe', 'secret-pass', conf, 'ftp', 'foo.net')
1371
        # different scheme
1372
        self._got_user_passwd(None, None, conf, 'http', 'foo.net')
1373
        # different host
1374
        self._got_user_passwd(None, None, conf, 'ftp', 'bar.net')
1375
1376
    def test_credentials_for_host_port(self):
1377
        conf = config.AuthenticationConfig(_file=StringIO(
1378
                """# Identity on foo.net
1379
[ftp definition]
1380
scheme=ftp
1381
port=10021
1382
host=foo.net
1383
user=joe
1384
password=secret-pass
1385
"""))
1386
        # No port
1387
        self._got_user_passwd('joe', 'secret-pass',
1388
                              conf, 'ftp', 'foo.net', port=10021)
1389
        # different port
1390
        self._got_user_passwd(None, None, conf, 'ftp', 'foo.net')
1391
1392
    def test_for_matching_host(self):
1393
        conf = config.AuthenticationConfig(_file=StringIO(
1394
                """# Identity on foo.net
1395
[sourceforge]
1396
scheme=bzr
1397
host=bzr.sf.net
1398
user=joe
1399
password=joepass
1400
[sourceforge domain]
1401
scheme=bzr
1402
host=.bzr.sf.net
1403
user=georges
1404
password=bendover
1405
"""))
1406
        # matching domain
1407
        self._got_user_passwd('georges', 'bendover',
1408
                              conf, 'bzr', 'foo.bzr.sf.net')
1409
        # phishing attempt
1410
        self._got_user_passwd(None, None,
1411
                              conf, 'bzr', 'bbzr.sf.net')
1412
1413
    def test_for_matching_host_None(self):
1414
        conf = config.AuthenticationConfig(_file=StringIO(
1415
                """# Identity on foo.net
1416
[catchup bzr]
1417
scheme=bzr
1418
user=joe
1419
password=joepass
1420
[DEFAULT]
1421
user=georges
1422
password=bendover
1423
"""))
1424
        # match no host
1425
        self._got_user_passwd('joe', 'joepass',
1426
                              conf, 'bzr', 'quux.net')
1427
        # no host but different scheme
1428
        self._got_user_passwd('georges', 'bendover',
1429
                              conf, 'ftp', 'quux.net')
1430
1431
    def test_credentials_for_path(self):
1432
        conf = config.AuthenticationConfig(_file=StringIO(
1433
                """
1434
[http dir1]
1435
scheme=http
1436
host=bar.org
1437
path=/dir1
1438
user=jim
1439
password=jimpass
1440
[http dir2]
1441
scheme=http
1442
host=bar.org
1443
path=/dir2
1444
user=georges
1445
password=bendover
1446
"""))
1447
        # no path no dice
1448
        self._got_user_passwd(None, None,
1449
                              conf, 'http', host='bar.org', path='/dir3')
1450
        # matching path
1451
        self._got_user_passwd('georges', 'bendover',
1452
                              conf, 'http', host='bar.org', path='/dir2')
1453
        # matching subdir
1454
        self._got_user_passwd('jim', 'jimpass',
1455
                              conf, 'http', host='bar.org',path='/dir1/subdir')
1456
1457
    def test_credentials_for_user(self):
1458
        conf = config.AuthenticationConfig(_file=StringIO(
1459
                """
1460
[with user]
1461
scheme=http
1462
host=bar.org
1463
user=jim
1464
password=jimpass
1465
"""))
1466
        # Get user
1467
        self._got_user_passwd('jim', 'jimpass',
1468
                              conf, 'http', 'bar.org')
1469
        # Get same user
1470
        self._got_user_passwd('jim', 'jimpass',
1471
                              conf, 'http', 'bar.org', user='jim')
1472
        # Don't get a different user if one is specified
1473
        self._got_user_passwd(None, None,
1474
                              conf, 'http', 'bar.org', user='georges')
1475
3418.4.1 by Vincent Ladeuil
Reproduce bug 199440.
1476
    def test_credentials_for_user_without_password(self):
1477
        conf = config.AuthenticationConfig(_file=StringIO(
1478
                """
1479
[without password]
1480
scheme=http
1481
host=bar.org
1482
user=jim
1483
"""))
1484
        # Get user but no password
1485
        self._got_user_passwd('jim', None,
1486
                              conf, 'http', 'bar.org')
1487
2900.2.3 by Vincent Ladeuil
Credentials matching implementation.
1488
    def test_verify_certificates(self):
1489
        conf = config.AuthenticationConfig(_file=StringIO(
1490
                """
1491
[self-signed]
1492
scheme=https
1493
host=bar.org
1494
user=jim
1495
password=jimpass
1496
verify_certificates=False
1497
[normal]
1498
scheme=https
1499
host=foo.net
1500
user=georges
1501
password=bendover
1502
"""))
1503
        credentials = conf.get_credentials('https', 'bar.org')
1504
        self.assertEquals(False, credentials.get('verify_certificates'))
1505
        credentials = conf.get_credentials('https', 'foo.net')
1506
        self.assertEquals(True, credentials.get('verify_certificates'))
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
1507
3777.1.10 by Aaron Bentley
Ensure credentials are stored
1508
1509
class TestAuthenticationStorage(tests.TestCaseInTempDir):
1510
3777.1.8 by Aaron Bentley
Commit work-in-progress
1511
    def test_set_credentials(self):
3777.1.10 by Aaron Bentley
Ensure credentials are stored
1512
        conf = config.AuthenticationConfig()
3777.3.2 by Aaron Bentley
Reverse order of scheme and password
1513
        conf.set_credentials('name', 'host', 'user', 'scheme', 'password',
4081.1.1 by Jean-Francois Roy
A 'realm' optional argument was added to the get_credentials and set_credentials
1514
        99, path='/foo', verify_certificates=False, realm='realm')
3777.1.8 by Aaron Bentley
Commit work-in-progress
1515
        credentials = conf.get_credentials(host='host', scheme='scheme',
4081.1.1 by Jean-Francois Roy
A 'realm' optional argument was added to the get_credentials and set_credentials
1516
                                           port=99, path='/foo',
1517
                                           realm='realm')
3777.1.10 by Aaron Bentley
Ensure credentials are stored
1518
        CREDENTIALS = {'name': 'name', 'user': 'user', 'password': 'password',
4107.1.8 by Jean-Francois Roy
Updated test_config to account for the new credentials keys.
1519
                       'verify_certificates': False, 'scheme': 'scheme', 
1520
                       'host': 'host', 'port': 99, 'path': '/foo', 
1521
                       'realm': 'realm'}
3777.1.10 by Aaron Bentley
Ensure credentials are stored
1522
        self.assertEqual(CREDENTIALS, credentials)
1523
        credentials_from_disk = config.AuthenticationConfig().get_credentials(
4081.1.1 by Jean-Francois Roy
A 'realm' optional argument was added to the get_credentials and set_credentials
1524
            host='host', scheme='scheme', port=99, path='/foo', realm='realm')
3777.1.10 by Aaron Bentley
Ensure credentials are stored
1525
        self.assertEqual(CREDENTIALS, credentials_from_disk)
3777.1.8 by Aaron Bentley
Commit work-in-progress
1526
3777.1.11 by Aaron Bentley
Ensure changed-name updates clear old values
1527
    def test_reset_credentials_different_name(self):
1528
        conf = config.AuthenticationConfig()
3777.3.2 by Aaron Bentley
Reverse order of scheme and password
1529
        conf.set_credentials('name', 'host', 'user', 'scheme', 'password'),
1530
        conf.set_credentials('name2', 'host', 'user2', 'scheme', 'password'),
3777.1.11 by Aaron Bentley
Ensure changed-name updates clear old values
1531
        self.assertIs(None, conf._get_config().get('name'))
1532
        credentials = conf.get_credentials(host='host', scheme='scheme')
1533
        CREDENTIALS = {'name': 'name2', 'user': 'user2', 'password':
4107.1.8 by Jean-Francois Roy
Updated test_config to account for the new credentials keys.
1534
                       'password', 'verify_certificates': True, 
1535
                       'scheme': 'scheme', 'host': 'host', 'port': None, 
1536
                       'path': None, 'realm': None}
3777.1.11 by Aaron Bentley
Ensure changed-name updates clear old values
1537
        self.assertEqual(CREDENTIALS, credentials)
1538
2900.2.5 by Vincent Ladeuil
ake ftp aware of authentication config.
1539
2900.2.14 by Vincent Ladeuil
More tests.
1540
class TestAuthenticationConfig(tests.TestCase):
1541
    """Test AuthenticationConfig behaviour"""
1542
4222.3.1 by Jelmer Vernooij
Mention password when checking default prompt.
1543
    def _check_default_password_prompt(self, expected_prompt_format, scheme,
4368.3.1 by Vincent Ladeuil
Use stderr for UI prompt to address bug #376582.
1544
                                       host=None, port=None, realm=None,
1545
                                       path=None):
2900.2.14 by Vincent Ladeuil
More tests.
1546
        if host is None:
1547
            host = 'bar.org'
1548
        user, password = 'jim', 'precious'
1549
        expected_prompt = expected_prompt_format % {
1550
            'scheme': scheme, 'host': host, 'port': port,
1551
            'user': user, 'realm': realm}
1552
1553
        stdout = tests.StringIOWrapper()
4368.3.1 by Vincent Ladeuil
Use stderr for UI prompt to address bug #376582.
1554
        stderr = tests.StringIOWrapper()
2900.2.14 by Vincent Ladeuil
More tests.
1555
        ui.ui_factory = tests.TestUIFactory(stdin=password + '\n',
4368.3.1 by Vincent Ladeuil
Use stderr for UI prompt to address bug #376582.
1556
                                            stdout=stdout, stderr=stderr)
2900.2.14 by Vincent Ladeuil
More tests.
1557
        # We use an empty conf so that the user is always prompted
1558
        conf = config.AuthenticationConfig()
1559
        self.assertEquals(password,
1560
                          conf.get_password(scheme, host, user, port=port,
1561
                                            realm=realm, path=path))
4368.3.1 by Vincent Ladeuil
Use stderr for UI prompt to address bug #376582.
1562
        self.assertEquals(expected_prompt, stderr.getvalue())
1563
        self.assertEquals('', stdout.getvalue())
2900.2.14 by Vincent Ladeuil
More tests.
1564
4222.3.2 by Jelmer Vernooij
Prompt for user names if they are not in the configuration.
1565
    def _check_default_username_prompt(self, expected_prompt_format, scheme,
4368.3.1 by Vincent Ladeuil
Use stderr for UI prompt to address bug #376582.
1566
                                       host=None, port=None, realm=None,
1567
                                       path=None):
4222.3.2 by Jelmer Vernooij
Prompt for user names if they are not in the configuration.
1568
        if host is None:
1569
            host = 'bar.org'
1570
        username = 'jim'
1571
        expected_prompt = expected_prompt_format % {
1572
            'scheme': scheme, 'host': host, 'port': port,
1573
            'realm': realm}
1574
        stdout = tests.StringIOWrapper()
4368.3.1 by Vincent Ladeuil
Use stderr for UI prompt to address bug #376582.
1575
        stderr = tests.StringIOWrapper()
4222.3.2 by Jelmer Vernooij
Prompt for user names if they are not in the configuration.
1576
        ui.ui_factory = tests.TestUIFactory(stdin=username+ '\n',
4368.3.1 by Vincent Ladeuil
Use stderr for UI prompt to address bug #376582.
1577
                                            stdout=stdout, stderr=stderr)
4222.3.2 by Jelmer Vernooij
Prompt for user names if they are not in the configuration.
1578
        # We use an empty conf so that the user is always prompted
1579
        conf = config.AuthenticationConfig()
4222.3.5 by Jelmer Vernooij
Fix test.
1580
        self.assertEquals(username, conf.get_user(scheme, host, port=port,
1581
                          realm=realm, path=path, ask=True))
4368.3.1 by Vincent Ladeuil
Use stderr for UI prompt to address bug #376582.
1582
        self.assertEquals(expected_prompt, stderr.getvalue())
1583
        self.assertEquals('', stdout.getvalue())
4222.3.2 by Jelmer Vernooij
Prompt for user names if they are not in the configuration.
1584
1585
    def test_username_defaults_prompts(self):
1586
        # HTTP prompts can't be tested here, see test_http.py
1587
        self._check_default_username_prompt('FTP %(host)s username: ', 'ftp')
1588
        self._check_default_username_prompt(
1589
            'FTP %(host)s:%(port)d username: ', 'ftp', port=10020)
1590
        self._check_default_username_prompt(
1591
            'SSH %(host)s:%(port)d username: ', 'ssh', port=12345)
1592
4222.3.11 by Jelmer Vernooij
Add test to make sure the default= parameter works.
1593
    def test_username_default_no_prompt(self):
1594
        conf = config.AuthenticationConfig()
4304.2.1 by Vincent Ladeuil
Fix bug #367726 by reverting some default user handling introduced
1595
        self.assertEquals(None,
4222.3.11 by Jelmer Vernooij
Add test to make sure the default= parameter works.
1596
            conf.get_user('ftp', 'example.com'))
4304.2.1 by Vincent Ladeuil
Fix bug #367726 by reverting some default user handling introduced
1597
        self.assertEquals("explicitdefault",
4222.3.11 by Jelmer Vernooij
Add test to make sure the default= parameter works.
1598
            conf.get_user('ftp', 'example.com', default="explicitdefault"))
1599
4222.3.1 by Jelmer Vernooij
Mention password when checking default prompt.
1600
    def test_password_default_prompts(self):
2900.2.19 by Vincent Ladeuil
Mention proxy and https in the password prompts, with tests.
1601
        # HTTP prompts can't be tested here, see test_http.py
4222.3.1 by Jelmer Vernooij
Mention password when checking default prompt.
1602
        self._check_default_password_prompt(
1603
            'FTP %(user)s@%(host)s password: ', 'ftp')
1604
        self._check_default_password_prompt(
1605
            'FTP %(user)s@%(host)s:%(port)d password: ', 'ftp', port=10020)
1606
        self._check_default_password_prompt(
1607
            'SSH %(user)s@%(host)s:%(port)d password: ', 'ssh', port=12345)
2900.2.14 by Vincent Ladeuil
More tests.
1608
        # SMTP port handling is a bit special (it's handled if embedded in the
1609
        # host too)
2900.2.22 by Vincent Ladeuil
Polishing.
1610
        # FIXME: should we: forbid that, extend it to other schemes, leave
1611
        # things as they are that's fine thank you ?
4222.3.1 by Jelmer Vernooij
Mention password when checking default prompt.
1612
        self._check_default_password_prompt('SMTP %(user)s@%(host)s password: ',
4304.2.1 by Vincent Ladeuil
Fix bug #367726 by reverting some default user handling introduced
1613
                                            'smtp')
4222.3.1 by Jelmer Vernooij
Mention password when checking default prompt.
1614
        self._check_default_password_prompt('SMTP %(user)s@%(host)s password: ',
4304.2.1 by Vincent Ladeuil
Fix bug #367726 by reverting some default user handling introduced
1615
                                            'smtp', host='bar.org:10025')
4222.3.1 by Jelmer Vernooij
Mention password when checking default prompt.
1616
        self._check_default_password_prompt(
2900.2.14 by Vincent Ladeuil
More tests.
1617
            'SMTP %(user)s@%(host)s:%(port)d password: ',
1618
            'smtp', port=10025)
1619
3420.1.2 by Vincent Ladeuil
Fix bug #203186 by ignoring passwords for ssh and warning user.
1620
    def test_ssh_password_emits_warning(self):
1621
        conf = config.AuthenticationConfig(_file=StringIO(
1622
                """
1623
[ssh with password]
1624
scheme=ssh
1625
host=bar.org
1626
user=jim
1627
password=jimpass
1628
"""))
1629
        entered_password = 'typed-by-hand'
1630
        stdout = tests.StringIOWrapper()
4449.3.30 by Martin Pool
Tweaks to test_config ui factory use
1631
        stderr = tests.StringIOWrapper()
3420.1.2 by Vincent Ladeuil
Fix bug #203186 by ignoring passwords for ssh and warning user.
1632
        ui.ui_factory = tests.TestUIFactory(stdin=entered_password + '\n',
4449.3.30 by Martin Pool
Tweaks to test_config ui factory use
1633
                                            stdout=stdout, stderr=stderr)
3420.1.2 by Vincent Ladeuil
Fix bug #203186 by ignoring passwords for ssh and warning user.
1634
1635
        # Since the password defined in the authentication config is ignored,
1636
        # the user is prompted
1637
        self.assertEquals(entered_password,
1638
                          conf.get_password('ssh', 'bar.org', user='jim'))
1639
        self.assertContainsRe(
4794.1.17 by Robert Collins
Fix from vila for type log_log.
1640
            self.get_log(),
3420.1.2 by Vincent Ladeuil
Fix bug #203186 by ignoring passwords for ssh and warning user.
1641
            'password ignored in section \[ssh with password\]')
1642
3420.1.3 by Vincent Ladeuil
John's review feedback.
1643
    def test_ssh_without_password_doesnt_emit_warning(self):
1644
        conf = config.AuthenticationConfig(_file=StringIO(
1645
                """
1646
[ssh with password]
1647
scheme=ssh
1648
host=bar.org
1649
user=jim
1650
"""))
1651
        entered_password = 'typed-by-hand'
1652
        stdout = tests.StringIOWrapper()
4449.3.30 by Martin Pool
Tweaks to test_config ui factory use
1653
        stderr = tests.StringIOWrapper()
3420.1.3 by Vincent Ladeuil
John's review feedback.
1654
        ui.ui_factory = tests.TestUIFactory(stdin=entered_password + '\n',
4449.3.30 by Martin Pool
Tweaks to test_config ui factory use
1655
                                            stdout=stdout,
1656
                                            stderr=stderr)
3420.1.3 by Vincent Ladeuil
John's review feedback.
1657
1658
        # Since the password defined in the authentication config is ignored,
1659
        # the user is prompted
1660
        self.assertEquals(entered_password,
1661
                          conf.get_password('ssh', 'bar.org', user='jim'))
3420.1.4 by Vincent Ladeuil
Fix comment.
1662
        # No warning shoud be emitted since there is no password. We are only
1663
        # providing "user".
3420.1.3 by Vincent Ladeuil
John's review feedback.
1664
        self.assertNotContainsRe(
4794.1.15 by Robert Collins
Review feedback.
1665
            self.get_log(),
3420.1.3 by Vincent Ladeuil
John's review feedback.
1666
            'password ignored in section \[ssh with password\]')
1667
4283.1.3 by Jelmer Vernooij
Add test to make sure AuthenticationConfig queries for fallback credentials.
1668
    def test_uses_fallback_stores(self):
4985.1.5 by Vincent Ladeuil
Deploying the new overrideAttr facility further reduces the complexity
1669
        self.overrideAttr(config, 'credential_store_registry',
1670
                          config.CredentialStoreRegistry())
4283.1.3 by Jelmer Vernooij
Add test to make sure AuthenticationConfig queries for fallback credentials.
1671
        store = StubCredentialStore()
1672
        store.add_credentials("http", "example.com", "joe", "secret")
1673
        config.credential_store_registry.register("stub", store, fallback=True)
1674
        conf = config.AuthenticationConfig(_file=StringIO())
1675
        creds = conf.get_credentials("http", "example.com")
1676
        self.assertEquals("joe", creds["user"])
1677
        self.assertEquals("secret", creds["password"])
1678
2900.2.14 by Vincent Ladeuil
More tests.
1679
4283.1.2 by Jelmer Vernooij
Add tests, NEWS item.
1680
class StubCredentialStore(config.CredentialStore):
1681
1682
    def __init__(self):
1683
        self._username = {}
1684
        self._password = {}
1685
1686
    def add_credentials(self, scheme, host, user, password=None):
1687
        self._username[(scheme, host)] = user
1688
        self._password[(scheme, host)] = password
1689
1690
    def get_credentials(self, scheme, host, port=None, user=None,
1691
        path=None, realm=None):
4283.2.1 by Vincent Ladeuil
Add a test and cleanup some PEP8 issues.
1692
        key = (scheme, host)
4283.1.2 by Jelmer Vernooij
Add tests, NEWS item.
1693
        if not key in self._username:
1694
            return None
4283.2.1 by Vincent Ladeuil
Add a test and cleanup some PEP8 issues.
1695
        return { "scheme": scheme, "host": host, "port": port,
4283.1.2 by Jelmer Vernooij
Add tests, NEWS item.
1696
                "user": self._username[key], "password": self._password[key]}
1697
1698
1699
class CountingCredentialStore(config.CredentialStore):
1700
1701
    def __init__(self):
1702
        self._calls = 0
1703
1704
    def get_credentials(self, scheme, host, port=None, user=None,
1705
        path=None, realm=None):
1706
        self._calls += 1
1707
        return None
1708
1709
3757.3.1 by Vincent Ladeuil
Add credential stores plugging.
1710
class TestCredentialStoreRegistry(tests.TestCase):
1711
1712
    def _get_cs_registry(self):
1713
        return config.credential_store_registry
1714
1715
    def test_default_credential_store(self):
1716
        r = self._get_cs_registry()
1717
        default = r.get_credential_store(None)
1718
        self.assertIsInstance(default, config.PlainTextCredentialStore)
1719
1720
    def test_unknown_credential_store(self):
1721
        r = self._get_cs_registry()
1722
        # It's hard to imagine someone creating a credential store named
1723
        # 'unknown' so we use that as an never registered key.
1724
        self.assertRaises(KeyError, r.get_credential_store, 'unknown')
1725
4283.1.2 by Jelmer Vernooij
Add tests, NEWS item.
1726
    def test_fallback_none_registered(self):
1727
        r = config.CredentialStoreRegistry()
4283.2.1 by Vincent Ladeuil
Add a test and cleanup some PEP8 issues.
1728
        self.assertEquals(None,
1729
                          r.get_fallback_credentials("http", "example.com"))
4283.1.2 by Jelmer Vernooij
Add tests, NEWS item.
1730
1731
    def test_register(self):
1732
        r = config.CredentialStoreRegistry()
1733
        r.register("stub", StubCredentialStore(), fallback=False)
1734
        r.register("another", StubCredentialStore(), fallback=True)
1735
        self.assertEquals(["another", "stub"], r.keys())
1736
1737
    def test_register_lazy(self):
1738
        r = config.CredentialStoreRegistry()
4283.2.1 by Vincent Ladeuil
Add a test and cleanup some PEP8 issues.
1739
        r.register_lazy("stub", "bzrlib.tests.test_config",
1740
                        "StubCredentialStore", fallback=False)
4283.1.2 by Jelmer Vernooij
Add tests, NEWS item.
1741
        self.assertEquals(["stub"], r.keys())
4283.2.1 by Vincent Ladeuil
Add a test and cleanup some PEP8 issues.
1742
        self.assertIsInstance(r.get_credential_store("stub"),
1743
                              StubCredentialStore)
4283.1.2 by Jelmer Vernooij
Add tests, NEWS item.
1744
1745
    def test_is_fallback(self):
1746
        r = config.CredentialStoreRegistry()
1747
        r.register("stub1", None, fallback=False)
1748
        r.register("stub2", None, fallback=True)
1749
        self.assertEquals(False, r.is_fallback("stub1"))
1750
        self.assertEquals(True, r.is_fallback("stub2"))
1751
1752
    def test_no_fallback(self):
1753
        r = config.CredentialStoreRegistry()
1754
        store = CountingCredentialStore()
1755
        r.register("count", store, fallback=False)
4283.2.1 by Vincent Ladeuil
Add a test and cleanup some PEP8 issues.
1756
        self.assertEquals(None,
1757
                          r.get_fallback_credentials("http", "example.com"))
4283.1.2 by Jelmer Vernooij
Add tests, NEWS item.
1758
        self.assertEquals(0, store._calls)
1759
1760
    def test_fallback_credentials(self):
1761
        r = config.CredentialStoreRegistry()
1762
        store = StubCredentialStore()
4283.2.1 by Vincent Ladeuil
Add a test and cleanup some PEP8 issues.
1763
        store.add_credentials("http", "example.com",
1764
                              "somebody", "geheim")
4283.1.2 by Jelmer Vernooij
Add tests, NEWS item.
1765
        r.register("stub", store, fallback=True)
1766
        creds = r.get_fallback_credentials("http", "example.com")
1767
        self.assertEquals("somebody", creds["user"])
1768
        self.assertEquals("geheim", creds["password"])
1769
4283.2.1 by Vincent Ladeuil
Add a test and cleanup some PEP8 issues.
1770
    def test_fallback_first_wins(self):
1771
        r = config.CredentialStoreRegistry()
1772
        stub1 = StubCredentialStore()
1773
        stub1.add_credentials("http", "example.com",
1774
                              "somebody", "stub1")
1775
        r.register("stub1", stub1, fallback=True)
1776
        stub2 = StubCredentialStore()
1777
        stub2.add_credentials("http", "example.com",
1778
                              "somebody", "stub2")
1779
        r.register("stub2", stub1, fallback=True)
1780
        creds = r.get_fallback_credentials("http", "example.com")
1781
        self.assertEquals("somebody", creds["user"])
1782
        self.assertEquals("stub1", creds["password"])
1783
3757.3.1 by Vincent Ladeuil
Add credential stores plugging.
1784
1785
class TestPlainTextCredentialStore(tests.TestCase):
1786
1787
    def test_decode_password(self):
1788
        r = config.credential_store_registry
1789
        plain_text = r.get_credential_store()
1790
        decoded = plain_text.decode_password(dict(password='secret'))
1791
        self.assertEquals('secret', decoded)
1792
1793
2900.2.14 by Vincent Ladeuil
More tests.
1794
# FIXME: Once we have a way to declare authentication to all test servers, we
2900.2.5 by Vincent Ladeuil
ake ftp aware of authentication config.
1795
# can implement generic tests.
2900.2.15 by Vincent Ladeuil
AuthenticationConfig can be queried for logins too (first step).
1796
# test_user_password_in_url
1797
# test_user_in_url_password_from_config
1798
# test_user_in_url_password_prompted
1799
# test_user_in_config
1800
# test_user_getpass.getuser
1801
# test_user_prompted ?
2900.2.5 by Vincent Ladeuil
ake ftp aware of authentication config.
1802
class TestAuthenticationRing(tests.TestCaseWithTransport):
1803
    pass