/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.1 by Vincent Ladeuil
Deprecate the get_filename parameter in IniBasedConfig.
369
        conf = config.IniBasedConfig()
4840.2.6 by Vincent Ladeuil
Implement config.suppress_warning.
370
        parser = conf._get_parser(file=StringIO(s.encode('utf-8')))
371
        return conf, parser
372
373
374
class TestIniConfigBuilding(TestIniConfig):
375
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
376
    def test_contructs(self):
5345.1.1 by Vincent Ladeuil
Deprecate the get_filename parameter in IniBasedConfig.
377
        my_config = config.IniBasedConfig()
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
378
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
379
    def test_from_fp(self):
1551.2.20 by Aaron Bentley
Treated config files as utf-8
380
        config_file = StringIO(sample_config_text.encode('utf-8'))
5345.1.1 by Vincent Ladeuil
Deprecate the get_filename parameter in IniBasedConfig.
381
        my_config = config.IniBasedConfig()
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
382
        self.failUnless(
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
383
            isinstance(my_config._get_parser(file=config_file),
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
384
                        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.
385
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
386
    def test_cached(self):
1551.2.20 by Aaron Bentley
Treated config files as utf-8
387
        config_file = StringIO(sample_config_text.encode('utf-8'))
5345.1.1 by Vincent Ladeuil
Deprecate the get_filename parameter in IniBasedConfig.
388
        my_config = config.IniBasedConfig()
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
389
        parser = my_config._get_parser(file=config_file)
390
        self.failUnless(my_config._get_parser() is parser)
391
5345.1.1 by Vincent Ladeuil
Deprecate the get_filename parameter in IniBasedConfig.
392
    def test_get_filename_parameter_is_deprecated_(self):
393
        conf = self.callDeprecated([
394
            'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
395
            ' Use file_name instead.'],
396
            config.IniBasedConfig, lambda: 'ini.conf')
5345.3.1 by Vincent Ladeuil
Check that _get_filename() is called and produces the desired side effect.
397
        self.assertEqual('ini.conf', conf.file_name)
5345.1.1 by Vincent Ladeuil
Deprecate the get_filename parameter in IniBasedConfig.
398
399
    def test_cant_save_without_a_file_name(self):
400
        conf = config.IniBasedConfig()
401
        self.assertRaises(AssertionError, conf._write_config_file)
402
4840.2.5 by Vincent Ladeuil
Refactor get_user_option_as_* tests.
403
4840.2.6 by Vincent Ladeuil
Implement config.suppress_warning.
404
class TestGetUserOptionAs(TestIniConfig):
4840.2.5 by Vincent Ladeuil
Refactor get_user_option_as_* tests.
405
4503.2.2 by Vincent Ladeuil
Get a bool or none from a config file.
406
    def test_get_user_option_as_bool(self):
4840.2.6 by Vincent Ladeuil
Implement config.suppress_warning.
407
        conf, parser = self.make_config_parser("""
4503.2.2 by Vincent Ladeuil
Get a bool or none from a config file.
408
a_true_bool = true
409
a_false_bool = 0
410
an_invalid_bool = maybe
4840.2.4 by Vincent Ladeuil
Implement config.get_user_option_as_list.
411
a_list = hmm, who knows ? # This is interpreted as a list !
4840.2.5 by Vincent Ladeuil
Refactor get_user_option_as_* tests.
412
""")
4840.2.6 by Vincent Ladeuil
Implement config.suppress_warning.
413
        get_bool = conf.get_user_option_as_bool
414
        self.assertEqual(True, get_bool('a_true_bool'))
415
        self.assertEqual(False, get_bool('a_false_bool'))
4989.2.12 by Vincent Ladeuil
Display a warning if an option value is not boolean.
416
        warnings = []
417
        def warning(*args):
418
            warnings.append(args[0] % args[1:])
419
        self.overrideAttr(trace, 'warning', warning)
420
        msg = 'Value "%s" is not a boolean for "%s"'
4840.2.6 by Vincent Ladeuil
Implement config.suppress_warning.
421
        self.assertIs(None, get_bool('an_invalid_bool'))
4989.2.12 by Vincent Ladeuil
Display a warning if an option value is not boolean.
422
        self.assertEquals(msg % ('maybe', 'an_invalid_bool'), warnings[0])
423
        warnings = []
4840.2.6 by Vincent Ladeuil
Implement config.suppress_warning.
424
        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.
425
        self.assertEquals([], warnings)
4840.2.4 by Vincent Ladeuil
Implement config.get_user_option_as_list.
426
427
    def test_get_user_option_as_list(self):
4840.2.6 by Vincent Ladeuil
Implement config.suppress_warning.
428
        conf, parser = self.make_config_parser("""
4840.2.4 by Vincent Ladeuil
Implement config.get_user_option_as_list.
429
a_list = a,b,c
430
length_1 = 1,
431
one_item = x
4840.2.6 by Vincent Ladeuil
Implement config.suppress_warning.
432
""")
433
        get_list = conf.get_user_option_as_list
4840.2.4 by Vincent Ladeuil
Implement config.get_user_option_as_list.
434
        self.assertEqual(['a', 'b', 'c'], get_list('a_list'))
435
        self.assertEqual(['1'], get_list('length_1'))
4840.2.6 by Vincent Ladeuil
Implement config.suppress_warning.
436
        self.assertEqual('x', conf.get_user_option('one_item'))
4840.2.4 by Vincent Ladeuil
Implement config.get_user_option_as_list.
437
        # automatically cast to list
438
        self.assertEqual(['x'], get_list('one_item'))
439
440
4840.2.6 by Vincent Ladeuil
Implement config.suppress_warning.
441
class TestSupressWarning(TestIniConfig):
442
443
    def make_warnings_config(self, s):
444
        conf, parser = self.make_config_parser(s)
445
        return conf.suppress_warning
446
447
    def test_suppress_warning_unknown(self):
448
        suppress_warning = self.make_warnings_config('')
449
        self.assertEqual(False, suppress_warning('unknown_warning'))
450
451
    def test_suppress_warning_known(self):
452
        suppress_warning = self.make_warnings_config('suppress_warnings=a,b')
453
        self.assertEqual(False, suppress_warning('c'))
454
        self.assertEqual(True, suppress_warning('a'))
455
        self.assertEqual(True, suppress_warning('b'))
456
457
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
458
class TestGetConfig(tests.TestCase):
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
459
460
    def test_constructs(self):
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
461
        my_config = config.GlobalConfig()
462
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
463
    def test_calls_read_filenames(self):
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
464
        # replace the class that is constructed, to check its parameters
1474 by Robert Collins
Merge from Aaron Bentley.
465
        oldparserclass = config.ConfigObj
466
        config.ConfigObj = InstrumentedConfigObj
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
467
        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.
468
        try:
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
469
            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.
470
        finally:
1474 by Robert Collins
Merge from Aaron Bentley.
471
            config.ConfigObj = oldparserclass
472
        self.failUnless(isinstance(parser, InstrumentedConfigObj))
1551.2.20 by Aaron Bentley
Treated config files as utf-8
473
        self.assertEqual(parser._calls, [('__init__', config.config_filename(),
474
                                          '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.
475
476
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
477
class TestBranchConfig(tests.TestCaseWithTransport):
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
478
479
    def test_constructs(self):
480
        branch = FakeBranch()
481
        my_config = config.BranchConfig(branch)
482
        self.assertRaises(TypeError, config.BranchConfig)
483
484
    def test_get_location_config(self):
485
        branch = FakeBranch()
486
        my_config = config.BranchConfig(branch)
487
        location_config = my_config._get_location_config()
488
        self.assertEqual(branch.base, location_config.location)
489
        self.failUnless(location_config is my_config._get_location_config())
490
1770.2.9 by Aaron Bentley
Add Branch.get_config, update BranchConfig() callers
491
    def test_get_config(self):
492
        """The Branch.get_config method works properly"""
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
493
        b = bzrdir.BzrDir.create_standalone_workingtree('.').branch
1770.2.9 by Aaron Bentley
Add Branch.get_config, update BranchConfig() callers
494
        my_config = b.get_config()
495
        self.assertIs(my_config.get_user_option('wacky'), None)
496
        my_config.set_user_option('wacky', 'unlikely')
497
        self.assertEqual(my_config.get_user_option('wacky'), 'unlikely')
498
499
        # Ensure we get the same thing if we start again
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
500
        b2 = branch.Branch.open('.')
1770.2.9 by Aaron Bentley
Add Branch.get_config, update BranchConfig() callers
501
        my_config2 = b2.get_config()
502
        self.assertEqual(my_config2.get_user_option('wacky'), 'unlikely')
503
1824.1.1 by Robert Collins
Add BranchConfig.has_explicit_nickname call.
504
    def test_has_explicit_nickname(self):
505
        b = self.make_branch('.')
506
        self.assertFalse(b.get_config().has_explicit_nickname())
507
        b.nick = 'foo'
508
        self.assertTrue(b.get_config().has_explicit_nickname())
509
1878.1.1 by John Arbash Meinel
Entries in locations.conf should prefer local paths if available (bug #53653)
510
    def test_config_url(self):
511
        """The Branch.get_config will use section that uses a local url"""
512
        branch = self.make_branch('branch')
513
        self.assertEqual('branch', branch.nick)
514
515
        locations = config.locations_config_filename()
516
        config.ensure_config_dir_exists()
517
        local_url = urlutils.local_path_to_url('branch')
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
518
        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)
519
                                    % (local_url,))
520
        self.assertEqual('foobar', branch.nick)
521
522
    def test_config_local_path(self):
523
        """The Branch.get_config will use a local system path"""
524
        branch = self.make_branch('branch')
525
        self.assertEqual('branch', branch.nick)
526
527
        locations = config.locations_config_filename()
528
        config.ensure_config_dir_exists()
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
529
        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)
530
                                    % (osutils.getcwd().encode('utf8'),))
531
        self.assertEqual('barry', branch.nick)
532
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
533
    def test_config_creates_local(self):
534
        """Creating a new entry in config uses a local path."""
2230.3.6 by Aaron Bentley
work in progress bind stuff
535
        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
536
        branch.set_push_location('http://foobar')
537
        locations = config.locations_config_filename()
538
        local_path = osutils.getcwd().encode('utf8')
539
        # Surprisingly ConfigObj doesn't create a trailing newline
540
        self.check_file_contents(locations,
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
541
                                 '[%s/branch]\n'
542
                                 'push_location = http://foobar\n'
3221.7.1 by Matt Nordhoff
Upgrade ConfigObj to version 4.5.1.
543
                                 'push_location:policy = norecurse\n'
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
544
                                 % (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
545
2120.5.4 by Alexander Belchenko
Whitebox test for Config.get_nickname (req. by Aaron Bentley)
546
    def test_autonick_urlencoded(self):
547
        b = self.make_branch('!repo')
548
        self.assertEqual('!repo', b.get_config().get_nickname())
549
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
550
    def test_warn_if_masked(self):
551
        _warning = trace.warning
552
        warnings = []
553
        def warning(*args):
554
            warnings.append(args[0] % args[1:])
555
556
        def set_option(store, warn_masked=True):
557
            warnings[:] = []
558
            conf.set_user_option('example_option', repr(store), store=store,
559
                                 warn_masked=warn_masked)
560
        def assertWarning(warning):
561
            if warning is None:
562
                self.assertEqual(0, len(warnings))
563
            else:
564
                self.assertEqual(1, len(warnings))
565
                self.assertEqual(warning, warnings[0])
566
        trace.warning = warning
567
        try:
568
            branch = self.make_branch('.')
569
            conf = branch.get_config()
570
            set_option(config.STORE_GLOBAL)
571
            assertWarning(None)
572
            set_option(config.STORE_BRANCH)
573
            assertWarning(None)
574
            set_option(config.STORE_GLOBAL)
575
            assertWarning('Value "4" is masked by "3" from branch.conf')
576
            set_option(config.STORE_GLOBAL, warn_masked=False)
577
            assertWarning(None)
578
            set_option(config.STORE_LOCATION)
579
            assertWarning(None)
580
            set_option(config.STORE_BRANCH)
581
            assertWarning('Value "3" is masked by "0" from locations.conf')
582
            set_option(config.STORE_BRANCH, warn_masked=False)
583
            assertWarning(None)
584
        finally:
585
            trace.warning = _warning
586
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
587
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
588
class TestGlobalConfigItems(tests.TestCase):
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
589
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
590
    def test_user_id(self):
1551.2.20 by Aaron Bentley
Treated config files as utf-8
591
        config_file = StringIO(sample_config_text.encode('utf-8'))
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
592
        my_config = config.GlobalConfig()
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
593
        my_config._parser = my_config._get_parser(file=config_file)
1551.2.21 by Aaron Bentley
Formatted unicode config tests as ASCII
594
        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
595
                         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.
596
597
    def test_absent_user_id(self):
598
        config_file = StringIO("")
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
599
        my_config = config.GlobalConfig()
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
600
        my_config._parser = my_config._get_parser(file=config_file)
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
601
        self.assertEqual(None, my_config._get_user_id())
602
603
    def test_configured_editor(self):
1551.2.20 by Aaron Bentley
Treated config files as utf-8
604
        config_file = StringIO(sample_config_text.encode('utf-8'))
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
605
        my_config = config.GlobalConfig()
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
606
        my_config._parser = my_config._get_parser(file=config_file)
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
607
        self.assertEqual("vim", my_config.get_editor())
608
1442.1.17 by Robert Collins
allow global overriding of signature policy to force checking, or (pointless but allowed) to set auto checking
609
    def test_signatures_always(self):
610
        config_file = StringIO(sample_always_signatures)
611
        my_config = config.GlobalConfig()
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
612
        my_config._parser = my_config._get_parser(file=config_file)
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
613
        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
614
                         my_config.signature_checking())
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
615
        self.assertEqual(config.SIGN_ALWAYS,
616
                         my_config.signing_policy())
1442.1.21 by Robert Collins
create signature_needed() call for commit to trigger creating signatures
617
        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
618
619
    def test_signatures_if_possible(self):
620
        config_file = StringIO(sample_maybe_signatures)
621
        my_config = config.GlobalConfig()
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
622
        my_config._parser = my_config._get_parser(file=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)
631
        my_config = config.GlobalConfig()
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
632
        my_config._parser = my_config._get_parser(file=config_file)
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
633
        self.assertEqual(config.CHECK_ALWAYS,
1442.1.16 by Robert Collins
allow global overriding of signature policy to never check
634
                         my_config.signature_checking())
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
635
        self.assertEqual(config.SIGN_NEVER,
636
                         my_config.signing_policy())
1442.1.21 by Robert Collins
create signature_needed() call for commit to trigger creating signatures
637
        self.assertEqual(False, my_config.signature_needed())
1442.1.16 by Robert Collins
allow global overriding of signature policy to never check
638
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
639
    def _get_sample_config(self):
1551.2.20 by Aaron Bentley
Treated config files as utf-8
640
        config_file = StringIO(sample_config_text.encode('utf-8'))
1534.7.154 by Aaron Bentley
Removed changes from bzr.ab 1529..1536
641
        my_config = config.GlobalConfig()
642
        my_config._parser = my_config._get_parser(file=config_file)
643
        return my_config
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
644
1442.1.56 by Robert Collins
gpg_signing_command configuration item
645
    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.
646
        my_config = self._get_sample_config()
1442.1.56 by Robert Collins
gpg_signing_command configuration item
647
        self.assertEqual("gnome-gpg", my_config.gpg_signing_command())
648
        self.assertEqual(False, my_config.signature_needed())
649
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
650
    def _get_empty_config(self):
651
        config_file = StringIO("")
652
        my_config = config.GlobalConfig()
653
        my_config._parser = my_config._get_parser(file=config_file)
654
        return my_config
655
1442.1.59 by Robert Collins
Add re-sign command to generate a digital signature on a single revision.
656
    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.
657
        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.
658
        self.assertEqual("gpg", my_config.gpg_signing_command())
659
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
660
    def test_get_user_option_default(self):
661
        my_config = self._get_empty_config()
662
        self.assertEqual(None, my_config.get_user_option('no_option'))
663
664
    def test_get_user_option_global(self):
665
        my_config = self._get_sample_config()
666
        self.assertEqual("something",
667
                         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.
668
1472 by Robert Collins
post commit hook, first pass implementation
669
    def test_post_commit_default(self):
670
        my_config = self._get_sample_config()
671
        self.assertEqual(None, my_config.post_commit())
672
1553.2.9 by Erik Bågfors
log_formatter => log_format for "named" formatters
673
    def test_configured_logformat(self):
1553.2.8 by Erik Bågfors
tests for config log_formatter
674
        my_config = self._get_sample_config()
1553.2.9 by Erik Bågfors
log_formatter => log_format for "named" formatters
675
        self.assertEqual("short", my_config.log_format())
1553.2.8 by Erik Bågfors
tests for config log_formatter
676
1553.6.12 by Erik Bågfors
remove AliasConfig, based on input from abentley
677
    def test_get_alias(self):
678
        my_config = self._get_sample_config()
679
        self.assertEqual('help', my_config.get_alias('h'))
680
2900.3.6 by Tim Penhey
Added tests.
681
    def test_get_aliases(self):
682
        my_config = self._get_sample_config()
683
        aliases = my_config.get_aliases()
684
        self.assertEqual(2, len(aliases))
685
        sorted_keys = sorted(aliases)
686
        self.assertEqual('help', aliases[sorted_keys[0]])
687
        self.assertEqual(sample_long_alias, aliases[sorted_keys[1]])
688
1553.6.12 by Erik Bågfors
remove AliasConfig, based on input from abentley
689
    def test_get_no_alias(self):
690
        my_config = self._get_sample_config()
691
        self.assertEqual(None, my_config.get_alias('foo'))
692
693
    def test_get_long_alias(self):
694
        my_config = self._get_sample_config()
695
        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.
696
4603.1.10 by Aaron Bentley
Provide change editor via config.
697
    def test_get_change_editor(self):
698
        my_config = self._get_sample_config()
699
        change_editor = my_config.get_change_editor('old', 'new')
700
        self.assertIs(diff.DiffFromTool, change_editor.__class__)
4603.1.20 by Aaron Bentley
Use string.Template substitution with @ as delimiter.
701
        self.assertEqual('vimdiff -of @new_path @old_path',
4603.1.10 by Aaron Bentley
Provide change editor via config.
702
                         ' '.join(change_editor.command_template))
703
704
    def test_get_no_change_editor(self):
705
        my_config = self._get_empty_config()
706
        change_editor = my_config.get_change_editor('old', 'new')
707
        self.assertIs(None, change_editor)
708
1704.2.18 by Martin Pool
Remove duplicated TestLocationConfig and update previously hidden tests. (#32587)
709
2900.3.6 by Tim Penhey
Added tests.
710
class TestGlobalConfigSavingOptions(tests.TestCaseInTempDir):
711
712
    def test_empty(self):
713
        my_config = config.GlobalConfig()
714
        self.assertEqual(0, len(my_config.get_aliases()))
715
716
    def test_set_alias(self):
717
        my_config = config.GlobalConfig()
718
        alias_value = 'commit --strict'
719
        my_config.set_alias('commit', alias_value)
720
        new_config = config.GlobalConfig()
721
        self.assertEqual(alias_value, new_config.get_alias('commit'))
722
723
    def test_remove_alias(self):
724
        my_config = config.GlobalConfig()
725
        my_config.set_alias('commit', 'commit --strict')
726
        # Now remove the alias again.
727
        my_config.unset_alias('commit')
728
        new_config = config.GlobalConfig()
729
        self.assertIs(None, new_config.get_alias('commit'))
730
731
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
732
class TestLocationConfig(tests.TestCaseInTempDir):
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
733
734
    def test_constructs(self):
735
        my_config = config.LocationConfig('http://example.com')
736
        self.assertRaises(TypeError, config.LocationConfig)
737
738
    def test_branch_calls_read_filenames(self):
1474 by Robert Collins
Merge from Aaron Bentley.
739
        # This is testing the correct file names are provided.
740
        # TODO: consolidate with the test for GlobalConfigs filename checks.
741
        #
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
742
        # replace the class that is constructed, to check its parameters
1474 by Robert Collins
Merge from Aaron Bentley.
743
        oldparserclass = config.ConfigObj
744
        config.ConfigObj = InstrumentedConfigObj
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
745
        try:
1770.2.2 by Aaron Bentley
Rename branches.conf to locations.conf
746
            my_config = config.LocationConfig('http://www.example.com')
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
747
            parser = my_config._get_parser()
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
748
        finally:
1474 by Robert Collins
Merge from Aaron Bentley.
749
            config.ConfigObj = oldparserclass
750
        self.failUnless(isinstance(parser, InstrumentedConfigObj))
751
        self.assertEqual(parser._calls,
1770.2.2 by Aaron Bentley
Rename branches.conf to locations.conf
752
                         [('__init__', config.locations_config_filename(),
1704.2.18 by Martin Pool
Remove duplicated TestLocationConfig and update previously hidden tests. (#32587)
753
                           'utf-8')])
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
754
755
    def test_get_global_config(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
756
        my_config = config.BranchConfig(FakeBranch('http://example.com'))
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
757
        global_config = my_config._get_global_config()
758
        self.failUnless(isinstance(global_config, config.GlobalConfig))
759
        self.failUnless(global_config is my_config._get_global_config())
760
1993.3.1 by James Henstridge
first go at making location config lookup recursive
761
    def test__get_matching_sections_no_match(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
762
        self.get_branch_config('/')
1993.3.1 by James Henstridge
first go at making location config lookup recursive
763
        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.
764
1993.3.1 by James Henstridge
first go at making location config lookup recursive
765
    def test__get_matching_sections_exact(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
766
        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
767
        self.assertEqual([('http://www.example.com', '')],
1993.3.1 by James Henstridge
first go at making location config lookup recursive
768
                         self.my_location_config._get_matching_sections())
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
769
1993.3.1 by James Henstridge
first go at making location config lookup recursive
770
    def test__get_matching_sections_suffix_does_not(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
771
        self.get_branch_config('http://www.example.com-com')
1993.3.1 by James Henstridge
first go at making location config lookup recursive
772
        self.assertEqual([], self.my_location_config._get_matching_sections())
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
773
1993.3.1 by James Henstridge
first go at making location config lookup recursive
774
    def test__get_matching_sections_subdir_recursive(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
775
        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
776
        self.assertEqual([('http://www.example.com', 'com')],
1993.3.1 by James Henstridge
first go at making location config lookup recursive
777
                         self.my_location_config._get_matching_sections())
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
778
1993.3.5 by James Henstridge
add back recurse=False option to config file
779
    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
780
        self.get_branch_config('http://www.example.com/ignoreparent')
781
        self.assertEqual([('http://www.example.com/ignoreparent', '')],
1993.3.1 by James Henstridge
first go at making location config lookup recursive
782
                         self.my_location_config._get_matching_sections())
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
783
1993.3.5 by James Henstridge
add back recurse=False option to config file
784
    def test__get_matching_sections_ignoreparent_subdir(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
785
        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
786
            'http://www.example.com/ignoreparent/childbranch')
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
787
        self.assertEqual([('http://www.example.com/ignoreparent',
788
                           'childbranch')],
1993.3.1 by James Henstridge
first go at making location config lookup recursive
789
                         self.my_location_config._get_matching_sections())
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
790
1993.3.1 by James Henstridge
first go at making location config lookup recursive
791
    def test__get_matching_sections_subdir_trailing_slash(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
792
        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
793
        self.assertEqual([('/b/', '')],
1993.3.1 by James Henstridge
first go at making location config lookup recursive
794
                         self.my_location_config._get_matching_sections())
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
795
1993.3.1 by James Henstridge
first go at making location config lookup recursive
796
    def test__get_matching_sections_subdir_child(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
797
        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
798
        self.assertEqual([('/a/*', ''), ('/a/', 'foo')],
1993.3.1 by James Henstridge
first go at making location config lookup recursive
799
                         self.my_location_config._get_matching_sections())
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
800
1993.3.1 by James Henstridge
first go at making location config lookup recursive
801
    def test__get_matching_sections_subdir_child_child(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
802
        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
803
        self.assertEqual([('/a/*', 'bar'), ('/a/', 'foo/bar')],
1993.3.1 by James Henstridge
first go at making location config lookup recursive
804
                         self.my_location_config._get_matching_sections())
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
805
1993.3.1 by James Henstridge
first go at making location config lookup recursive
806
    def test__get_matching_sections_trailing_slash_with_children(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
807
        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
808
        self.assertEqual([('/a/', '')],
1993.3.1 by James Henstridge
first go at making location config lookup recursive
809
                         self.my_location_config._get_matching_sections())
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
810
1993.3.1 by James Henstridge
first go at making location config lookup recursive
811
    def test__get_matching_sections_explicit_over_glob(self):
812
        # XXX: 2006-09-08 jamesh
813
        # This test only passes because ord('c') > ord('*').  If there
814
        # was a config section for '/a/?', it would get precedence
815
        # over '/a/c'.
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
816
        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
817
        self.assertEqual([('/a/c', ''), ('/a/*', ''), ('/a/', 'c')],
1993.3.1 by James Henstridge
first go at making location config lookup recursive
818
                         self.my_location_config._get_matching_sections())
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
819
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
820
    def test__get_option_policy_normal(self):
821
        self.get_branch_config('http://www.example.com')
822
        self.assertEqual(
823
            self.my_location_config._get_config_policy(
824
            'http://www.example.com', 'normal_option'),
825
            config.POLICY_NONE)
826
827
    def test__get_option_policy_norecurse(self):
828
        self.get_branch_config('http://www.example.com')
829
        self.assertEqual(
830
            self.my_location_config._get_option_policy(
831
            'http://www.example.com', 'norecurse_option'),
832
            config.POLICY_NORECURSE)
833
        # Test old recurse=False setting:
834
        self.assertEqual(
835
            self.my_location_config._get_option_policy(
836
            'http://www.example.com/norecurse', 'normal_option'),
837
            config.POLICY_NORECURSE)
838
839
    def test__get_option_policy_normal(self):
840
        self.get_branch_config('http://www.example.com')
841
        self.assertEqual(
842
            self.my_location_config._get_option_policy(
843
            'http://www.example.com', 'appendpath_option'),
844
            config.POLICY_APPENDPATH)
845
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
846
    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
847
        self.get_branch_config('http://www.example.com/ignoreparent')
1704.2.18 by Martin Pool
Remove duplicated TestLocationConfig and update previously hidden tests. (#32587)
848
        self.assertEqual(u'Erik B\u00e5gfors <erik@bagfors.nu>',
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
849
                         self.my_config.username())
850
851
    def test_location_not_listed(self):
1704.2.18 by Martin Pool
Remove duplicated TestLocationConfig and update previously hidden tests. (#32587)
852
        """Test that the global username is used when no location matches"""
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
853
        self.get_branch_config('/home/robertc/sources')
1704.2.18 by Martin Pool
Remove duplicated TestLocationConfig and update previously hidden tests. (#32587)
854
        self.assertEqual(u'Erik B\u00e5gfors <erik@bagfors.nu>',
1442.1.8 by Robert Collins
preparing some tests for LocationConfig
855
                         self.my_config.username())
856
1442.1.13 by Robert Collins
branches.conf is now able to override the users email
857
    def test_overriding_location(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
858
        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
859
        self.assertEqual('Robert Collins <robertc@example.org>',
860
                         self.my_config.username())
1442.1.16 by Robert Collins
allow global overriding of signature policy to never check
861
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
862
    def test_signatures_not_set(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
863
        self.get_branch_config('http://www.example.com',
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
864
                                 global_config=sample_ignore_signatures)
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
865
        self.assertEqual(config.CHECK_ALWAYS,
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
866
                         self.my_config.signature_checking())
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
867
        self.assertEqual(config.SIGN_NEVER,
868
                         self.my_config.signing_policy())
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
869
870
    def test_signatures_never(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
871
        self.get_branch_config('/a/c')
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
872
        self.assertEqual(config.CHECK_NEVER,
873
                         self.my_config.signature_checking())
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
874
1442.1.16 by Robert Collins
allow global overriding of signature policy to never check
875
    def test_signatures_when_available(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
876
        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
877
        self.assertEqual(config.CHECK_IF_POSSIBLE,
878
                         self.my_config.signature_checking())
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
879
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
880
    def test_signatures_always(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
881
        self.get_branch_config('/b')
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
882
        self.assertEqual(config.CHECK_ALWAYS,
883
                         self.my_config.signature_checking())
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
884
1442.1.56 by Robert Collins
gpg_signing_command configuration item
885
    def test_gpg_signing_command(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
886
        self.get_branch_config('/b')
1442.1.56 by Robert Collins
gpg_signing_command configuration item
887
        self.assertEqual("gnome-gpg", self.my_config.gpg_signing_command())
888
889
    def test_gpg_signing_command_missing(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
890
        self.get_branch_config('/a')
1442.1.56 by Robert Collins
gpg_signing_command configuration item
891
        self.assertEqual("false", self.my_config.gpg_signing_command())
892
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
893
    def test_get_user_option_global(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
894
        self.get_branch_config('/a')
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
895
        self.assertEqual('something',
896
                         self.my_config.get_user_option('user_global_option'))
897
898
    def test_get_user_option_local(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
899
        self.get_branch_config('/a')
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
900
        self.assertEqual('local',
901
                         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
902
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
903
    def test_get_user_option_appendpath(self):
904
        # returned as is for the base path:
905
        self.get_branch_config('http://www.example.com')
906
        self.assertEqual('append',
907
                         self.my_config.get_user_option('appendpath_option'))
908
        # Extra path components get appended:
909
        self.get_branch_config('http://www.example.com/a/b/c')
910
        self.assertEqual('append/a/b/c',
911
                         self.my_config.get_user_option('appendpath_option'))
912
        # Overriden for http://www.example.com/dir, where it is a
913
        # normal option:
914
        self.get_branch_config('http://www.example.com/dir/a/b/c')
915
        self.assertEqual('normal',
916
                         self.my_config.get_user_option('appendpath_option'))
917
918
    def test_get_user_option_norecurse(self):
919
        self.get_branch_config('http://www.example.com')
920
        self.assertEqual('norecurse',
921
                         self.my_config.get_user_option('norecurse_option'))
922
        self.get_branch_config('http://www.example.com/dir')
923
        self.assertEqual(None,
924
                         self.my_config.get_user_option('norecurse_option'))
925
        # http://www.example.com/norecurse is a recurse=False section
926
        # that redefines normal_option.  Subdirectories do not pick up
927
        # this redefinition.
928
        self.get_branch_config('http://www.example.com/norecurse')
929
        self.assertEqual('norecurse',
930
                         self.my_config.get_user_option('normal_option'))
931
        self.get_branch_config('http://www.example.com/norecurse/subdir')
932
        self.assertEqual('normal',
933
                         self.my_config.get_user_option('normal_option'))
934
2120.6.4 by James Henstridge
add support for specifying policy when storing options
935
    def test_set_user_option_norecurse(self):
936
        self.get_branch_config('http://www.example.com')
937
        self.my_config.set_user_option('foo', 'bar',
938
                                       store=config.STORE_LOCATION_NORECURSE)
939
        self.assertEqual(
940
            self.my_location_config._get_option_policy(
941
            'http://www.example.com', 'foo'),
942
            config.POLICY_NORECURSE)
943
944
    def test_set_user_option_appendpath(self):
945
        self.get_branch_config('http://www.example.com')
946
        self.my_config.set_user_option('foo', 'bar',
947
                                       store=config.STORE_LOCATION_APPENDPATH)
948
        self.assertEqual(
949
            self.my_location_config._get_option_policy(
950
            'http://www.example.com', 'foo'),
951
            config.POLICY_APPENDPATH)
952
953
    def test_set_user_option_change_policy(self):
954
        self.get_branch_config('http://www.example.com')
955
        self.my_config.set_user_option('norecurse_option', 'normal',
956
                                       store=config.STORE_LOCATION)
957
        self.assertEqual(
958
            self.my_location_config._get_option_policy(
959
            'http://www.example.com', 'norecurse_option'),
960
            config.POLICY_NONE)
961
962
    def test_set_user_option_recurse_false_section(self):
2120.6.9 by James Henstridge
Fixes for issues brought up in John's review
963
        # The following section has recurse=False set.  The test is to
964
        # make sure that a normal option can be added to the section,
965
        # converting recurse=False to the norecurse policy.
2120.6.4 by James Henstridge
add support for specifying policy when storing options
966
        self.get_branch_config('http://www.example.com/norecurse')
2120.6.11 by James Henstridge
s/0.13/0.14/ in deprecation warning
967
        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
968
                             'The section "http://www.example.com/norecurse" '
969
                             'has been converted to use policies.'],
970
                            self.my_config.set_user_option,
971
                            'foo', 'bar', store=config.STORE_LOCATION)
2120.6.4 by James Henstridge
add support for specifying policy when storing options
972
        self.assertEqual(
973
            self.my_location_config._get_option_policy(
974
            'http://www.example.com/norecurse', 'foo'),
975
            config.POLICY_NONE)
976
        # The previously existing option is still norecurse:
977
        self.assertEqual(
978
            self.my_location_config._get_option_policy(
979
            'http://www.example.com/norecurse', 'normal_option'),
980
            config.POLICY_NORECURSE)
981
1472 by Robert Collins
post commit hook, first pass implementation
982
    def test_post_commit_default(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
983
        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
984
        self.assertEqual('bzrlib.tests.test_config.post_commit',
1472 by Robert Collins
post commit hook, first pass implementation
985
                         self.my_config.post_commit())
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
986
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
987
    def get_branch_config(self, location, global_config=None):
1502 by Robert Collins
Bugfix the config test suite to not create .bazaar in the dir where it is run.
988
        if global_config is None:
1551.2.20 by Aaron Bentley
Treated config files as utf-8
989
            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.
990
        else:
1551.2.20 by Aaron Bentley
Treated config files as utf-8
991
            global_file = StringIO(global_config.encode('utf-8'))
992
        branches_file = StringIO(sample_branches_text.encode('utf-8'))
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
993
        self.my_config = config.BranchConfig(FakeBranch(location))
994
        # Force location config to use specified file
995
        self.my_location_config = self.my_config._get_location_config()
996
        self.my_location_config._get_parser(branches_file)
997
        # Force global config to use specified file
1502 by Robert Collins
Bugfix the config test suite to not create .bazaar in the dir where it is run.
998
        self.my_config._get_global_config()._get_parser(global_file)
999
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1000
    def test_set_user_setting_sets_and_saves(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
1001
        self.get_branch_config('/a/c')
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1002
        record = InstrumentedConfigObj("foo")
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
1003
        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
1004
1005
        real_mkdir = os.mkdir
1006
        self.created = False
1007
        def checked_mkdir(path, mode=0777):
1008
            self.log('making directory: %s', path)
1009
            real_mkdir(path, mode)
1010
            self.created = True
1011
1012
        os.mkdir = checked_mkdir
1013
        try:
2120.6.10 by James Henstridge
Catch another deprecation warning, and more cleanup
1014
            self.callDeprecated(['The recurse option is deprecated as of '
2120.6.11 by James Henstridge
s/0.13/0.14/ in deprecation warning
1015
                                 '0.14.  The section "/a/c" has been '
2120.6.10 by James Henstridge
Catch another deprecation warning, and more cleanup
1016
                                 'converted to use policies.'],
1017
                                self.my_config.set_user_option,
1018
                                'foo', 'bar', store=config.STORE_LOCATION)
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
1019
        finally:
1020
            os.mkdir = real_mkdir
1021
1022
        self.failUnless(self.created, 'Failed to create ~/.bazaar')
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1023
        self.assertEqual([('__contains__', '/a/c'),
1024
                          ('__contains__', '/a/c/'),
1025
                          ('__setitem__', '/a/c', {}),
1026
                          ('__getitem__', '/a/c'),
1027
                          ('__setitem__', 'foo', 'bar'),
2120.6.4 by James Henstridge
add support for specifying policy when storing options
1028
                          ('__getitem__', '/a/c'),
1029
                          ('as_bool', 'recurse'),
1030
                          ('__getitem__', '/a/c'),
1031
                          ('__delitem__', 'recurse'),
1032
                          ('__getitem__', '/a/c'),
1033
                          ('keys',),
2120.6.8 by James Henstridge
Change syntax for setting config option policies. Rather than
1034
                          ('__getitem__', '/a/c'),
1035
                          ('__contains__', 'foo:policy'),
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1036
                          ('write',)],
1037
                         record._calls[1:])
1038
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1039
    def test_set_user_setting_sets_and_saves2(self):
1040
        self.get_branch_config('/a/c')
1041
        self.assertIs(self.my_config.get_user_option('foo'), None)
1042
        self.my_config.set_user_option('foo', 'bar')
1043
        self.assertEqual(
3616.2.6 by Mark Hammond
Fix test_set_user_setting_sets_and_saves2 on windows by stripping EOL
1044
            self.my_config.branch.control_files.files['branch.conf'].strip(),
1045
            'foo = bar')
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1046
        self.assertEqual(self.my_config.get_user_option('foo'), 'bar')
2120.6.4 by James Henstridge
add support for specifying policy when storing options
1047
        self.my_config.set_user_option('foo', 'baz',
1048
                                       store=config.STORE_LOCATION)
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1049
        self.assertEqual(self.my_config.get_user_option('foo'), 'baz')
1050
        self.my_config.set_user_option('foo', 'qux')
1051
        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.
1052
1551.18.17 by Aaron Bentley
Introduce bzr_remote_path configuration variable
1053
    def test_get_bzr_remote_path(self):
1054
        my_config = config.LocationConfig('/a/c')
1055
        self.assertEqual('bzr', my_config.get_bzr_remote_path())
1056
        my_config.set_user_option('bzr_remote_path', '/path-bzr')
1057
        self.assertEqual('/path-bzr', my_config.get_bzr_remote_path())
1058
        os.environ['BZR_REMOTE_PATH'] = '/environ-bzr'
1059
        self.assertEqual('/environ-bzr', my_config.get_bzr_remote_path())
1060
1185.62.7 by John Arbash Meinel
Whitespace cleanup.
1061
1770.2.8 by Aaron Bentley
Add precedence test
1062
precedence_global = 'option = global'
1063
precedence_branch = 'option = branch'
1064
precedence_location = """
1065
[http://]
1066
recurse = true
1067
option = recurse
1068
[http://example.com/specific]
1069
option = exact
1070
"""
1071
1072
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
1073
class TestBranchConfigItems(tests.TestCaseInTempDir):
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
1074
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
1075
    def get_branch_config(self, global_config=None, location=None,
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1076
                          location_config=None, branch_data_config=None):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
1077
        my_config = config.BranchConfig(FakeBranch(location))
1078
        if global_config is not None:
1079
            global_file = StringIO(global_config.encode('utf-8'))
1080
            my_config._get_global_config()._get_parser(global_file)
1081
        self.my_location_config = my_config._get_location_config()
1082
        if location_config is not None:
1083
            location_file = StringIO(location_config.encode('utf-8'))
1084
            self.my_location_config._get_parser(location_file)
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1085
        if branch_data_config is not None:
1086
            my_config.branch.control_files.files['branch.conf'] = \
1087
                branch_data_config
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
1088
        return my_config
1089
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
1090
    def test_user_id(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
1091
        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
1092
        my_config = config.BranchConfig(branch)
1093
        self.assertEqual("Robert Collins <robertc@example.net>",
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1094
                         my_config.username())
3388.2.3 by Martin Pool
Fix up more uses of LockableFiles.get_utf8 in tests
1095
        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.
1096
        my_config.set_user_option('email',
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1097
                                  "Robert Collins <robertc@example.org>")
1098
        self.assertEqual("John", my_config.username())
3388.2.3 by Martin Pool
Fix up more uses of LockableFiles.get_utf8 in tests
1099
        del my_config.branch.control_files.files['email']
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1100
        self.assertEqual("Robert Collins <robertc@example.org>",
1101
                         my_config.username())
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
1102
1103
    def test_not_set_in_branch(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
1104
        my_config = self.get_branch_config(sample_config_text)
1551.2.21 by Aaron Bentley
Formatted unicode config tests as ASCII
1105
        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
1106
                         my_config._get_user_id())
3388.2.3 by Martin Pool
Fix up more uses of LockableFiles.get_utf8 in tests
1107
        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
1108
        self.assertEqual("John", my_config._get_user_id())
1109
1861.4.1 by Matthieu Moy
BZREMAIL renamed to BZR_EMAIL.
1110
    def test_BZR_EMAIL_OVERRIDES(self):
1111
        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
1112
        branch = FakeBranch()
1113
        my_config = config.BranchConfig(branch)
1114
        self.assertEqual("Robert Collins <robertc@example.org>",
1115
                         my_config.username())
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
1116
1442.1.19 by Robert Collins
BranchConfigs inherit signature_checking policy from their LocationConfig.
1117
    def test_signatures_forced(self):
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
1118
        my_config = self.get_branch_config(
1119
            global_config=sample_always_signatures)
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
1120
        self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
1121
        self.assertEqual(config.SIGN_ALWAYS, my_config.signing_policy())
1122
        self.assertTrue(my_config.signature_needed())
1442.1.56 by Robert Collins
gpg_signing_command configuration item
1123
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1124
    def test_signatures_forced_branch(self):
1125
        my_config = self.get_branch_config(
1126
            global_config=sample_ignore_signatures,
1127
            branch_data_config=sample_always_signatures)
1128
        self.assertEqual(config.CHECK_NEVER, my_config.signature_checking())
1129
        self.assertEqual(config.SIGN_ALWAYS, my_config.signing_policy())
1130
        self.assertTrue(my_config.signature_needed())
1131
1442.1.56 by Robert Collins
gpg_signing_command configuration item
1132
    def test_gpg_signing_command(self):
1770.2.10 by Aaron Bentley
Added test that branch_config can't influence gpg_signing_command
1133
        my_config = self.get_branch_config(
1134
            # branch data cannot set gpg_signing_command
1135
            branch_data_config="gpg_signing_command=pgp")
1551.2.20 by Aaron Bentley
Treated config files as utf-8
1136
        config_file = StringIO(sample_config_text.encode('utf-8'))
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
1137
        my_config._get_global_config()._get_parser(config_file)
1442.1.56 by Robert Collins
gpg_signing_command configuration item
1138
        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.
1139
1140
    def test_get_user_option_global(self):
1141
        branch = FakeBranch()
1142
        my_config = config.BranchConfig(branch)
1551.2.20 by Aaron Bentley
Treated config files as utf-8
1143
        config_file = StringIO(sample_config_text.encode('utf-8'))
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
1144
        (my_config._get_global_config()._get_parser(config_file))
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
1145
        self.assertEqual('something',
1146
                         my_config.get_user_option('user_global_option'))
1472 by Robert Collins
post commit hook, first pass implementation
1147
1148
    def test_post_commit_default(self):
1149
        branch = FakeBranch()
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
1150
        my_config = self.get_branch_config(sample_config_text, '/a/c',
1151
                                           sample_branches_text)
1152
        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
1153
        self.assertEqual('bzrlib.tests.test_config.post_commit',
1472 by Robert Collins
post commit hook, first pass implementation
1154
                         my_config.post_commit())
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1155
        my_config.set_user_option('post_commit', 'rmtree_root')
1156
        # post-commit is ignored when bresent in branch data
1157
        self.assertEqual('bzrlib.tests.test_config.post_commit',
1158
                         my_config.post_commit())
2120.6.4 by James Henstridge
add support for specifying policy when storing options
1159
        my_config.set_user_option('post_commit', 'rmtree_root',
1160
                                  store=config.STORE_LOCATION)
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
1161
        self.assertEqual('rmtree_root', my_config.post_commit())
1185.33.31 by Martin Pool
Make annotate cope better with revisions committed without a valid
1162
1770.2.8 by Aaron Bentley
Add precedence test
1163
    def test_config_precedence(self):
1164
        my_config = self.get_branch_config(global_config=precedence_global)
1165
        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.
1166
        my_config = self.get_branch_config(global_config=precedence_global,
1770.2.8 by Aaron Bentley
Add precedence test
1167
                                      branch_data_config=precedence_branch)
1168
        self.assertEqual(my_config.get_user_option('option'), 'branch')
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
1169
        my_config = self.get_branch_config(global_config=precedence_global,
1770.2.8 by Aaron Bentley
Add precedence test
1170
                                      branch_data_config=precedence_branch,
1171
                                      location_config=precedence_location)
1172
        self.assertEqual(my_config.get_user_option('option'), 'recurse')
2991.2.2 by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0.
1173
        my_config = self.get_branch_config(global_config=precedence_global,
1770.2.8 by Aaron Bentley
Add precedence test
1174
                                      branch_data_config=precedence_branch,
1175
                                      location_config=precedence_location,
1176
                                      location='http://example.com/specific')
1177
        self.assertEqual(my_config.get_user_option('option'), 'exact')
1178
2681.1.8 by Aaron Bentley
Add Thunderbird support to bzr send
1179
    def test_get_mail_client(self):
1180
        config = self.get_branch_config()
1181
        client = config.get_mail_client()
2681.1.24 by Aaron Bentley
Handle default mail client by trying xdg-email, falling back to editor
1182
        self.assertIsInstance(client, mail_client.DefaultMail)
1183
2790.2.2 by Keir Mierle
Change alphabetic ordering into two categories; one for specific clients the other for generic options.
1184
        # Specific clients
2681.1.21 by Aaron Bentley
Refactor prompt generation to make it testable, test it with unicode
1185
        config.set_user_option('mail_client', 'evolution')
1186
        client = config.get_mail_client()
1187
        self.assertIsInstance(client, mail_client.Evolution)
1188
2681.5.1 by ghigo
Add KMail support to bzr send
1189
        config.set_user_option('mail_client', 'kmail')
1190
        client = config.get_mail_client()
1191
        self.assertIsInstance(client, mail_client.KMail)
1192
2790.2.1 by Keir Mierle
Add Mutt as a supported client email program. Also rearranges various listings
1193
        config.set_user_option('mail_client', 'mutt')
1194
        client = config.get_mail_client()
1195
        self.assertIsInstance(client, mail_client.Mutt)
1196
1197
        config.set_user_option('mail_client', 'thunderbird')
1198
        client = config.get_mail_client()
1199
        self.assertIsInstance(client, mail_client.Thunderbird)
1200
2790.2.2 by Keir Mierle
Change alphabetic ordering into two categories; one for specific clients the other for generic options.
1201
        # Generic options
1202
        config.set_user_option('mail_client', 'default')
1203
        client = config.get_mail_client()
1204
        self.assertIsInstance(client, mail_client.DefaultMail)
1205
1206
        config.set_user_option('mail_client', 'editor')
1207
        client = config.get_mail_client()
1208
        self.assertIsInstance(client, mail_client.Editor)
1209
1210
        config.set_user_option('mail_client', 'mapi')
1211
        client = config.get_mail_client()
1212
        self.assertIsInstance(client, mail_client.MAPIClient)
1213
2681.1.23 by Aaron Bentley
Add support for xdg-email
1214
        config.set_user_option('mail_client', 'xdg-email')
1215
        client = config.get_mail_client()
1216
        self.assertIsInstance(client, mail_client.XDGEmail)
1217
2681.1.10 by Aaron Bentley
Clean up handling of unknown mail clients
1218
        config.set_user_option('mail_client', 'firebird')
1219
        self.assertRaises(errors.UnknownMailClient, config.get_mail_client)
1220
1185.33.31 by Martin Pool
Make annotate cope better with revisions committed without a valid
1221
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
1222
class TestMailAddressExtraction(tests.TestCase):
1185.33.31 by Martin Pool
Make annotate cope better with revisions committed without a valid
1223
1224
    def test_extract_email_address(self):
1225
        self.assertEqual('jane@test.com',
1226
                         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
1227
        self.assertRaises(errors.NoEmailInUsername,
1185.33.31 by Martin Pool
Make annotate cope better with revisions committed without a valid
1228
                          config.extract_email_address, 'Jane Tester')
2533.1.1 by James Westby
Fix TreeConfig to return values from sections.
1229
3063.3.2 by Lukáš Lalinský
Move the name and e-mail address extraction logic to config.parse_username.
1230
    def test_parse_username(self):
1231
        self.assertEqual(('', 'jdoe@example.com'),
1232
                         config.parse_username('jdoe@example.com'))
1233
        self.assertEqual(('', 'jdoe@example.com'),
1234
                         config.parse_username('<jdoe@example.com>'))
1235
        self.assertEqual(('John Doe', 'jdoe@example.com'),
1236
                         config.parse_username('John Doe <jdoe@example.com>'))
1237
        self.assertEqual(('John Doe', ''),
1238
                         config.parse_username('John Doe'))
3063.3.3 by Lukáš Lalinský
Add one more test for config.parse_username().
1239
        self.assertEqual(('John Doe', 'jdoe@example.com'),
1240
                         config.parse_username('John Doe jdoe@example.com'))
2562.1.2 by John Arbash Meinel
Clean up whitespace
1241
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
1242
class TestTreeConfig(tests.TestCaseWithTransport):
2533.1.1 by James Westby
Fix TreeConfig to return values from sections.
1243
1244
    def test_get_value(self):
1245
        """Test that retreiving a value from a section is possible"""
1246
        branch = self.make_branch('.')
1247
        tree_config = config.TreeConfig(branch)
1248
        tree_config.set_option('value', 'key', 'SECTION')
1249
        tree_config.set_option('value2', 'key2')
1250
        tree_config.set_option('value3-top', 'key3')
1251
        tree_config.set_option('value3-section', 'key3', 'SECTION')
1252
        value = tree_config.get_option('key', 'SECTION')
1253
        self.assertEqual(value, 'value')
1254
        value = tree_config.get_option('key2')
1255
        self.assertEqual(value, 'value2')
1256
        self.assertEqual(tree_config.get_option('non-existant'), None)
1257
        value = tree_config.get_option('non-existant', 'SECTION')
1258
        self.assertEqual(value, None)
1259
        value = tree_config.get_option('non-existant', default='default')
1260
        self.assertEqual(value, 'default')
1261
        self.assertEqual(tree_config.get_option('key2', 'NOSECTION'), None)
1262
        value = tree_config.get_option('key2', 'NOSECTION', default='default')
1263
        self.assertEqual(value, 'default')
1264
        value = tree_config.get_option('key3')
1265
        self.assertEqual(value, 'value3-top')
1266
        value = tree_config.get_option('key3', 'SECTION')
1267
        self.assertEqual(value, 'value3-section')
2900.2.3 by Vincent Ladeuil
Credentials matching implementation.
1268
1269
3242.1.2 by Aaron Bentley
Turn BzrDirConfig into TransportConfig, reduce code duplication
1270
class TestTransportConfig(tests.TestCaseWithTransport):
3242.1.1 by Aaron Bentley
Implement BzrDir configuration
1271
1272
    def test_get_value(self):
1273
        """Test that retreiving a value from a section is possible"""
3242.1.2 by Aaron Bentley
Turn BzrDirConfig into TransportConfig, reduce code duplication
1274
        bzrdir_config = config.TransportConfig(transport.get_transport('.'),
1275
                                               'control.conf')
3242.1.1 by Aaron Bentley
Implement BzrDir configuration
1276
        bzrdir_config.set_option('value', 'key', 'SECTION')
1277
        bzrdir_config.set_option('value2', 'key2')
1278
        bzrdir_config.set_option('value3-top', 'key3')
1279
        bzrdir_config.set_option('value3-section', 'key3', 'SECTION')
1280
        value = bzrdir_config.get_option('key', 'SECTION')
1281
        self.assertEqual(value, 'value')
1282
        value = bzrdir_config.get_option('key2')
1283
        self.assertEqual(value, 'value2')
1284
        self.assertEqual(bzrdir_config.get_option('non-existant'), None)
1285
        value = bzrdir_config.get_option('non-existant', 'SECTION')
1286
        self.assertEqual(value, None)
1287
        value = bzrdir_config.get_option('non-existant', default='default')
1288
        self.assertEqual(value, 'default')
1289
        self.assertEqual(bzrdir_config.get_option('key2', 'NOSECTION'), None)
1290
        value = bzrdir_config.get_option('key2', 'NOSECTION',
1291
                                         default='default')
1292
        self.assertEqual(value, 'default')
1293
        value = bzrdir_config.get_option('key3')
1294
        self.assertEqual(value, 'value3-top')
1295
        value = bzrdir_config.get_option('key3', 'SECTION')
1296
        self.assertEqual(value, 'value3-section')
1297
3242.3.11 by Aaron Bentley
Clean up BzrDirConfig usage
1298
    def test_set_unset_default_stack_on(self):
1299
        my_dir = self.make_bzrdir('.')
4288.1.3 by Robert Collins
Fix BzrDirConfig tests.
1300
        bzrdir_config = config.BzrDirConfig(my_dir)
3242.3.11 by Aaron Bentley
Clean up BzrDirConfig usage
1301
        self.assertIs(None, bzrdir_config.get_default_stack_on())
1302
        bzrdir_config.set_default_stack_on('Foo')
3242.3.14 by Aaron Bentley
Make BzrDirConfig use TransportConfig
1303
        self.assertEqual('Foo', bzrdir_config._config.get_option(
1304
                         'default_stack_on'))
3242.3.11 by Aaron Bentley
Clean up BzrDirConfig usage
1305
        self.assertEqual('Foo', bzrdir_config.get_default_stack_on())
1306
        bzrdir_config.set_default_stack_on(None)
1307
        self.assertIs(None, bzrdir_config.get_default_stack_on())
1308
3242.1.1 by Aaron Bentley
Implement BzrDir configuration
1309
2900.2.5 by Vincent Ladeuil
ake ftp aware of authentication config.
1310
class TestAuthenticationConfigFile(tests.TestCase):
2900.2.14 by Vincent Ladeuil
More tests.
1311
    """Test the authentication.conf file matching"""
2900.2.3 by Vincent Ladeuil
Credentials matching implementation.
1312
1313
    def _got_user_passwd(self, expected_user, expected_password,
1314
                         config, *args, **kwargs):
1315
        credentials = config.get_credentials(*args, **kwargs)
1316
        if credentials is None:
1317
            user = None
1318
            password = None
1319
        else:
1320
            user = credentials['user']
1321
            password = credentials['password']
1322
        self.assertEquals(expected_user, user)
1323
        self.assertEquals(expected_password, password)
1324
2978.5.1 by John Arbash Meinel
Fix bug #162494, 'bzr register-branch' needs proper auth handling.
1325
    def test_empty_config(self):
2900.2.3 by Vincent Ladeuil
Credentials matching implementation.
1326
        conf = config.AuthenticationConfig(_file=StringIO())
1327
        self.assertEquals({}, conf._get_config())
1328
        self._got_user_passwd(None, None, conf, 'http', 'foo.net')
1329
3418.2.1 by Vincent Ladeuil
Fix #217650 by catching declarations outside sections.
1330
    def test_missing_auth_section_header(self):
1331
        conf = config.AuthenticationConfig(_file=StringIO('foo = bar'))
1332
        self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
1333
1334
    def test_auth_section_header_not_closed(self):
2900.2.3 by Vincent Ladeuil
Credentials matching implementation.
1335
        conf = config.AuthenticationConfig(_file=StringIO('[DEF'))
1336
        self.assertRaises(errors.ParseConfigError, conf._get_config)
2900.2.15 by Vincent Ladeuil
AuthenticationConfig can be queried for logins too (first step).
1337
3418.2.1 by Vincent Ladeuil
Fix #217650 by catching declarations outside sections.
1338
    def test_auth_value_not_boolean(self):
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
1339
        conf = config.AuthenticationConfig(_file=StringIO(
1340
                """[broken]
1341
scheme=ftp
1342
user=joe
2900.2.15 by Vincent Ladeuil
AuthenticationConfig can be queried for logins too (first step).
1343
verify_certificates=askme # Error: Not a boolean
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
1344
"""))
1345
        self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
3418.2.1 by Vincent Ladeuil
Fix #217650 by catching declarations outside sections.
1346
1347
    def test_auth_value_not_int(self):
2900.2.22 by Vincent Ladeuil
Polishing.
1348
        conf = config.AuthenticationConfig(_file=StringIO(
1349
                """[broken]
1350
scheme=ftp
1351
user=joe
1352
port=port # Error: Not an int
1353
"""))
1354
        self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
2900.2.3 by Vincent Ladeuil
Credentials matching implementation.
1355
3757.3.1 by Vincent Ladeuil
Add credential stores plugging.
1356
    def test_unknown_password_encoding(self):
1357
        conf = config.AuthenticationConfig(_file=StringIO(
1358
                """[broken]
1359
scheme=ftp
1360
user=joe
1361
password_encoding=unknown
1362
"""))
1363
        self.assertRaises(ValueError, conf.get_password,
1364
                          'ftp', 'foo.net', 'joe')
1365
2900.2.3 by Vincent Ladeuil
Credentials matching implementation.
1366
    def test_credentials_for_scheme_host(self):
1367
        conf = config.AuthenticationConfig(_file=StringIO(
1368
                """# Identity on foo.net
1369
[ftp definition]
1370
scheme=ftp
1371
host=foo.net
1372
user=joe
1373
password=secret-pass
1374
"""))
1375
        # Basic matching
1376
        self._got_user_passwd('joe', 'secret-pass', conf, 'ftp', 'foo.net')
1377
        # different scheme
1378
        self._got_user_passwd(None, None, conf, 'http', 'foo.net')
1379
        # different host
1380
        self._got_user_passwd(None, None, conf, 'ftp', 'bar.net')
1381
1382
    def test_credentials_for_host_port(self):
1383
        conf = config.AuthenticationConfig(_file=StringIO(
1384
                """# Identity on foo.net
1385
[ftp definition]
1386
scheme=ftp
1387
port=10021
1388
host=foo.net
1389
user=joe
1390
password=secret-pass
1391
"""))
1392
        # No port
1393
        self._got_user_passwd('joe', 'secret-pass',
1394
                              conf, 'ftp', 'foo.net', port=10021)
1395
        # different port
1396
        self._got_user_passwd(None, None, conf, 'ftp', 'foo.net')
1397
1398
    def test_for_matching_host(self):
1399
        conf = config.AuthenticationConfig(_file=StringIO(
1400
                """# Identity on foo.net
1401
[sourceforge]
1402
scheme=bzr
1403
host=bzr.sf.net
1404
user=joe
1405
password=joepass
1406
[sourceforge domain]
1407
scheme=bzr
1408
host=.bzr.sf.net
1409
user=georges
1410
password=bendover
1411
"""))
1412
        # matching domain
1413
        self._got_user_passwd('georges', 'bendover',
1414
                              conf, 'bzr', 'foo.bzr.sf.net')
1415
        # phishing attempt
1416
        self._got_user_passwd(None, None,
1417
                              conf, 'bzr', 'bbzr.sf.net')
1418
1419
    def test_for_matching_host_None(self):
1420
        conf = config.AuthenticationConfig(_file=StringIO(
1421
                """# Identity on foo.net
1422
[catchup bzr]
1423
scheme=bzr
1424
user=joe
1425
password=joepass
1426
[DEFAULT]
1427
user=georges
1428
password=bendover
1429
"""))
1430
        # match no host
1431
        self._got_user_passwd('joe', 'joepass',
1432
                              conf, 'bzr', 'quux.net')
1433
        # no host but different scheme
1434
        self._got_user_passwd('georges', 'bendover',
1435
                              conf, 'ftp', 'quux.net')
1436
1437
    def test_credentials_for_path(self):
1438
        conf = config.AuthenticationConfig(_file=StringIO(
1439
                """
1440
[http dir1]
1441
scheme=http
1442
host=bar.org
1443
path=/dir1
1444
user=jim
1445
password=jimpass
1446
[http dir2]
1447
scheme=http
1448
host=bar.org
1449
path=/dir2
1450
user=georges
1451
password=bendover
1452
"""))
1453
        # no path no dice
1454
        self._got_user_passwd(None, None,
1455
                              conf, 'http', host='bar.org', path='/dir3')
1456
        # matching path
1457
        self._got_user_passwd('georges', 'bendover',
1458
                              conf, 'http', host='bar.org', path='/dir2')
1459
        # matching subdir
1460
        self._got_user_passwd('jim', 'jimpass',
1461
                              conf, 'http', host='bar.org',path='/dir1/subdir')
1462
1463
    def test_credentials_for_user(self):
1464
        conf = config.AuthenticationConfig(_file=StringIO(
1465
                """
1466
[with user]
1467
scheme=http
1468
host=bar.org
1469
user=jim
1470
password=jimpass
1471
"""))
1472
        # Get user
1473
        self._got_user_passwd('jim', 'jimpass',
1474
                              conf, 'http', 'bar.org')
1475
        # Get same user
1476
        self._got_user_passwd('jim', 'jimpass',
1477
                              conf, 'http', 'bar.org', user='jim')
1478
        # Don't get a different user if one is specified
1479
        self._got_user_passwd(None, None,
1480
                              conf, 'http', 'bar.org', user='georges')
1481
3418.4.1 by Vincent Ladeuil
Reproduce bug 199440.
1482
    def test_credentials_for_user_without_password(self):
1483
        conf = config.AuthenticationConfig(_file=StringIO(
1484
                """
1485
[without password]
1486
scheme=http
1487
host=bar.org
1488
user=jim
1489
"""))
1490
        # Get user but no password
1491
        self._got_user_passwd('jim', None,
1492
                              conf, 'http', 'bar.org')
1493
2900.2.3 by Vincent Ladeuil
Credentials matching implementation.
1494
    def test_verify_certificates(self):
1495
        conf = config.AuthenticationConfig(_file=StringIO(
1496
                """
1497
[self-signed]
1498
scheme=https
1499
host=bar.org
1500
user=jim
1501
password=jimpass
1502
verify_certificates=False
1503
[normal]
1504
scheme=https
1505
host=foo.net
1506
user=georges
1507
password=bendover
1508
"""))
1509
        credentials = conf.get_credentials('https', 'bar.org')
1510
        self.assertEquals(False, credentials.get('verify_certificates'))
1511
        credentials = conf.get_credentials('https', 'foo.net')
1512
        self.assertEquals(True, credentials.get('verify_certificates'))
2900.2.4 by Vincent Ladeuil
Cosmetic changes.
1513
3777.1.10 by Aaron Bentley
Ensure credentials are stored
1514
1515
class TestAuthenticationStorage(tests.TestCaseInTempDir):
1516
3777.1.8 by Aaron Bentley
Commit work-in-progress
1517
    def test_set_credentials(self):
3777.1.10 by Aaron Bentley
Ensure credentials are stored
1518
        conf = config.AuthenticationConfig()
3777.3.2 by Aaron Bentley
Reverse order of scheme and password
1519
        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
1520
        99, path='/foo', verify_certificates=False, realm='realm')
3777.1.8 by Aaron Bentley
Commit work-in-progress
1521
        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
1522
                                           port=99, path='/foo',
1523
                                           realm='realm')
3777.1.10 by Aaron Bentley
Ensure credentials are stored
1524
        CREDENTIALS = {'name': 'name', 'user': 'user', 'password': 'password',
4107.1.8 by Jean-Francois Roy
Updated test_config to account for the new credentials keys.
1525
                       'verify_certificates': False, 'scheme': 'scheme', 
1526
                       'host': 'host', 'port': 99, 'path': '/foo', 
1527
                       'realm': 'realm'}
3777.1.10 by Aaron Bentley
Ensure credentials are stored
1528
        self.assertEqual(CREDENTIALS, credentials)
1529
        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
1530
            host='host', scheme='scheme', port=99, path='/foo', realm='realm')
3777.1.10 by Aaron Bentley
Ensure credentials are stored
1531
        self.assertEqual(CREDENTIALS, credentials_from_disk)
3777.1.8 by Aaron Bentley
Commit work-in-progress
1532
3777.1.11 by Aaron Bentley
Ensure changed-name updates clear old values
1533
    def test_reset_credentials_different_name(self):
1534
        conf = config.AuthenticationConfig()
3777.3.2 by Aaron Bentley
Reverse order of scheme and password
1535
        conf.set_credentials('name', 'host', 'user', 'scheme', 'password'),
1536
        conf.set_credentials('name2', 'host', 'user2', 'scheme', 'password'),
3777.1.11 by Aaron Bentley
Ensure changed-name updates clear old values
1537
        self.assertIs(None, conf._get_config().get('name'))
1538
        credentials = conf.get_credentials(host='host', scheme='scheme')
1539
        CREDENTIALS = {'name': 'name2', 'user': 'user2', 'password':
4107.1.8 by Jean-Francois Roy
Updated test_config to account for the new credentials keys.
1540
                       'password', 'verify_certificates': True, 
1541
                       'scheme': 'scheme', 'host': 'host', 'port': None, 
1542
                       'path': None, 'realm': None}
3777.1.11 by Aaron Bentley
Ensure changed-name updates clear old values
1543
        self.assertEqual(CREDENTIALS, credentials)
1544
2900.2.5 by Vincent Ladeuil
ake ftp aware of authentication config.
1545
2900.2.14 by Vincent Ladeuil
More tests.
1546
class TestAuthenticationConfig(tests.TestCase):
1547
    """Test AuthenticationConfig behaviour"""
1548
4222.3.1 by Jelmer Vernooij
Mention password when checking default prompt.
1549
    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.
1550
                                       host=None, port=None, realm=None,
1551
                                       path=None):
2900.2.14 by Vincent Ladeuil
More tests.
1552
        if host is None:
1553
            host = 'bar.org'
1554
        user, password = 'jim', 'precious'
1555
        expected_prompt = expected_prompt_format % {
1556
            'scheme': scheme, 'host': host, 'port': port,
1557
            'user': user, 'realm': realm}
1558
1559
        stdout = tests.StringIOWrapper()
4368.3.1 by Vincent Ladeuil
Use stderr for UI prompt to address bug #376582.
1560
        stderr = tests.StringIOWrapper()
2900.2.14 by Vincent Ladeuil
More tests.
1561
        ui.ui_factory = tests.TestUIFactory(stdin=password + '\n',
4368.3.1 by Vincent Ladeuil
Use stderr for UI prompt to address bug #376582.
1562
                                            stdout=stdout, stderr=stderr)
2900.2.14 by Vincent Ladeuil
More tests.
1563
        # We use an empty conf so that the user is always prompted
1564
        conf = config.AuthenticationConfig()
1565
        self.assertEquals(password,
1566
                          conf.get_password(scheme, host, user, port=port,
1567
                                            realm=realm, path=path))
4368.3.1 by Vincent Ladeuil
Use stderr for UI prompt to address bug #376582.
1568
        self.assertEquals(expected_prompt, stderr.getvalue())
1569
        self.assertEquals('', stdout.getvalue())
2900.2.14 by Vincent Ladeuil
More tests.
1570
4222.3.2 by Jelmer Vernooij
Prompt for user names if they are not in the configuration.
1571
    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.
1572
                                       host=None, port=None, realm=None,
1573
                                       path=None):
4222.3.2 by Jelmer Vernooij
Prompt for user names if they are not in the configuration.
1574
        if host is None:
1575
            host = 'bar.org'
1576
        username = 'jim'
1577
        expected_prompt = expected_prompt_format % {
1578
            'scheme': scheme, 'host': host, 'port': port,
1579
            'realm': realm}
1580
        stdout = tests.StringIOWrapper()
4368.3.1 by Vincent Ladeuil
Use stderr for UI prompt to address bug #376582.
1581
        stderr = tests.StringIOWrapper()
4222.3.2 by Jelmer Vernooij
Prompt for user names if they are not in the configuration.
1582
        ui.ui_factory = tests.TestUIFactory(stdin=username+ '\n',
4368.3.1 by Vincent Ladeuil
Use stderr for UI prompt to address bug #376582.
1583
                                            stdout=stdout, stderr=stderr)
4222.3.2 by Jelmer Vernooij
Prompt for user names if they are not in the configuration.
1584
        # We use an empty conf so that the user is always prompted
1585
        conf = config.AuthenticationConfig()
4222.3.5 by Jelmer Vernooij
Fix test.
1586
        self.assertEquals(username, conf.get_user(scheme, host, port=port,
1587
                          realm=realm, path=path, ask=True))
4368.3.1 by Vincent Ladeuil
Use stderr for UI prompt to address bug #376582.
1588
        self.assertEquals(expected_prompt, stderr.getvalue())
1589
        self.assertEquals('', stdout.getvalue())
4222.3.2 by Jelmer Vernooij
Prompt for user names if they are not in the configuration.
1590
1591
    def test_username_defaults_prompts(self):
1592
        # HTTP prompts can't be tested here, see test_http.py
1593
        self._check_default_username_prompt('FTP %(host)s username: ', 'ftp')
1594
        self._check_default_username_prompt(
1595
            'FTP %(host)s:%(port)d username: ', 'ftp', port=10020)
1596
        self._check_default_username_prompt(
1597
            'SSH %(host)s:%(port)d username: ', 'ssh', port=12345)
1598
4222.3.11 by Jelmer Vernooij
Add test to make sure the default= parameter works.
1599
    def test_username_default_no_prompt(self):
1600
        conf = config.AuthenticationConfig()
4304.2.1 by Vincent Ladeuil
Fix bug #367726 by reverting some default user handling introduced
1601
        self.assertEquals(None,
4222.3.11 by Jelmer Vernooij
Add test to make sure the default= parameter works.
1602
            conf.get_user('ftp', 'example.com'))
4304.2.1 by Vincent Ladeuil
Fix bug #367726 by reverting some default user handling introduced
1603
        self.assertEquals("explicitdefault",
4222.3.11 by Jelmer Vernooij
Add test to make sure the default= parameter works.
1604
            conf.get_user('ftp', 'example.com', default="explicitdefault"))
1605
4222.3.1 by Jelmer Vernooij
Mention password when checking default prompt.
1606
    def test_password_default_prompts(self):
2900.2.19 by Vincent Ladeuil
Mention proxy and https in the password prompts, with tests.
1607
        # HTTP prompts can't be tested here, see test_http.py
4222.3.1 by Jelmer Vernooij
Mention password when checking default prompt.
1608
        self._check_default_password_prompt(
1609
            'FTP %(user)s@%(host)s password: ', 'ftp')
1610
        self._check_default_password_prompt(
1611
            'FTP %(user)s@%(host)s:%(port)d password: ', 'ftp', port=10020)
1612
        self._check_default_password_prompt(
1613
            'SSH %(user)s@%(host)s:%(port)d password: ', 'ssh', port=12345)
2900.2.14 by Vincent Ladeuil
More tests.
1614
        # SMTP port handling is a bit special (it's handled if embedded in the
1615
        # host too)
2900.2.22 by Vincent Ladeuil
Polishing.
1616
        # FIXME: should we: forbid that, extend it to other schemes, leave
1617
        # things as they are that's fine thank you ?
4222.3.1 by Jelmer Vernooij
Mention password when checking default prompt.
1618
        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
1619
                                            'smtp')
4222.3.1 by Jelmer Vernooij
Mention password when checking default prompt.
1620
        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
1621
                                            'smtp', host='bar.org:10025')
4222.3.1 by Jelmer Vernooij
Mention password when checking default prompt.
1622
        self._check_default_password_prompt(
2900.2.14 by Vincent Ladeuil
More tests.
1623
            'SMTP %(user)s@%(host)s:%(port)d password: ',
1624
            'smtp', port=10025)
1625
3420.1.2 by Vincent Ladeuil
Fix bug #203186 by ignoring passwords for ssh and warning user.
1626
    def test_ssh_password_emits_warning(self):
1627
        conf = config.AuthenticationConfig(_file=StringIO(
1628
                """
1629
[ssh with password]
1630
scheme=ssh
1631
host=bar.org
1632
user=jim
1633
password=jimpass
1634
"""))
1635
        entered_password = 'typed-by-hand'
1636
        stdout = tests.StringIOWrapper()
4449.3.30 by Martin Pool
Tweaks to test_config ui factory use
1637
        stderr = tests.StringIOWrapper()
3420.1.2 by Vincent Ladeuil
Fix bug #203186 by ignoring passwords for ssh and warning user.
1638
        ui.ui_factory = tests.TestUIFactory(stdin=entered_password + '\n',
4449.3.30 by Martin Pool
Tweaks to test_config ui factory use
1639
                                            stdout=stdout, stderr=stderr)
3420.1.2 by Vincent Ladeuil
Fix bug #203186 by ignoring passwords for ssh and warning user.
1640
1641
        # Since the password defined in the authentication config is ignored,
1642
        # the user is prompted
1643
        self.assertEquals(entered_password,
1644
                          conf.get_password('ssh', 'bar.org', user='jim'))
1645
        self.assertContainsRe(
4794.1.17 by Robert Collins
Fix from vila for type log_log.
1646
            self.get_log(),
3420.1.2 by Vincent Ladeuil
Fix bug #203186 by ignoring passwords for ssh and warning user.
1647
            'password ignored in section \[ssh with password\]')
1648
3420.1.3 by Vincent Ladeuil
John's review feedback.
1649
    def test_ssh_without_password_doesnt_emit_warning(self):
1650
        conf = config.AuthenticationConfig(_file=StringIO(
1651
                """
1652
[ssh with password]
1653
scheme=ssh
1654
host=bar.org
1655
user=jim
1656
"""))
1657
        entered_password = 'typed-by-hand'
1658
        stdout = tests.StringIOWrapper()
4449.3.30 by Martin Pool
Tweaks to test_config ui factory use
1659
        stderr = tests.StringIOWrapper()
3420.1.3 by Vincent Ladeuil
John's review feedback.
1660
        ui.ui_factory = tests.TestUIFactory(stdin=entered_password + '\n',
4449.3.30 by Martin Pool
Tweaks to test_config ui factory use
1661
                                            stdout=stdout,
1662
                                            stderr=stderr)
3420.1.3 by Vincent Ladeuil
John's review feedback.
1663
1664
        # Since the password defined in the authentication config is ignored,
1665
        # the user is prompted
1666
        self.assertEquals(entered_password,
1667
                          conf.get_password('ssh', 'bar.org', user='jim'))
3420.1.4 by Vincent Ladeuil
Fix comment.
1668
        # No warning shoud be emitted since there is no password. We are only
1669
        # providing "user".
3420.1.3 by Vincent Ladeuil
John's review feedback.
1670
        self.assertNotContainsRe(
4794.1.15 by Robert Collins
Review feedback.
1671
            self.get_log(),
3420.1.3 by Vincent Ladeuil
John's review feedback.
1672
            'password ignored in section \[ssh with password\]')
1673
4283.1.3 by Jelmer Vernooij
Add test to make sure AuthenticationConfig queries for fallback credentials.
1674
    def test_uses_fallback_stores(self):
4985.1.5 by Vincent Ladeuil
Deploying the new overrideAttr facility further reduces the complexity
1675
        self.overrideAttr(config, 'credential_store_registry',
1676
                          config.CredentialStoreRegistry())
4283.1.3 by Jelmer Vernooij
Add test to make sure AuthenticationConfig queries for fallback credentials.
1677
        store = StubCredentialStore()
1678
        store.add_credentials("http", "example.com", "joe", "secret")
1679
        config.credential_store_registry.register("stub", store, fallback=True)
1680
        conf = config.AuthenticationConfig(_file=StringIO())
1681
        creds = conf.get_credentials("http", "example.com")
1682
        self.assertEquals("joe", creds["user"])
1683
        self.assertEquals("secret", creds["password"])
1684
2900.2.14 by Vincent Ladeuil
More tests.
1685
4283.1.2 by Jelmer Vernooij
Add tests, NEWS item.
1686
class StubCredentialStore(config.CredentialStore):
1687
1688
    def __init__(self):
1689
        self._username = {}
1690
        self._password = {}
1691
1692
    def add_credentials(self, scheme, host, user, password=None):
1693
        self._username[(scheme, host)] = user
1694
        self._password[(scheme, host)] = password
1695
1696
    def get_credentials(self, scheme, host, port=None, user=None,
1697
        path=None, realm=None):
4283.2.1 by Vincent Ladeuil
Add a test and cleanup some PEP8 issues.
1698
        key = (scheme, host)
4283.1.2 by Jelmer Vernooij
Add tests, NEWS item.
1699
        if not key in self._username:
1700
            return None
4283.2.1 by Vincent Ladeuil
Add a test and cleanup some PEP8 issues.
1701
        return { "scheme": scheme, "host": host, "port": port,
4283.1.2 by Jelmer Vernooij
Add tests, NEWS item.
1702
                "user": self._username[key], "password": self._password[key]}
1703
1704
1705
class CountingCredentialStore(config.CredentialStore):
1706
1707
    def __init__(self):
1708
        self._calls = 0
1709
1710
    def get_credentials(self, scheme, host, port=None, user=None,
1711
        path=None, realm=None):
1712
        self._calls += 1
1713
        return None
1714
1715
3757.3.1 by Vincent Ladeuil
Add credential stores plugging.
1716
class TestCredentialStoreRegistry(tests.TestCase):
1717
1718
    def _get_cs_registry(self):
1719
        return config.credential_store_registry
1720
1721
    def test_default_credential_store(self):
1722
        r = self._get_cs_registry()
1723
        default = r.get_credential_store(None)
1724
        self.assertIsInstance(default, config.PlainTextCredentialStore)
1725
1726
    def test_unknown_credential_store(self):
1727
        r = self._get_cs_registry()
1728
        # It's hard to imagine someone creating a credential store named
1729
        # 'unknown' so we use that as an never registered key.
1730
        self.assertRaises(KeyError, r.get_credential_store, 'unknown')
1731
4283.1.2 by Jelmer Vernooij
Add tests, NEWS item.
1732
    def test_fallback_none_registered(self):
1733
        r = config.CredentialStoreRegistry()
4283.2.1 by Vincent Ladeuil
Add a test and cleanup some PEP8 issues.
1734
        self.assertEquals(None,
1735
                          r.get_fallback_credentials("http", "example.com"))
4283.1.2 by Jelmer Vernooij
Add tests, NEWS item.
1736
1737
    def test_register(self):
1738
        r = config.CredentialStoreRegistry()
1739
        r.register("stub", StubCredentialStore(), fallback=False)
1740
        r.register("another", StubCredentialStore(), fallback=True)
1741
        self.assertEquals(["another", "stub"], r.keys())
1742
1743
    def test_register_lazy(self):
1744
        r = config.CredentialStoreRegistry()
4283.2.1 by Vincent Ladeuil
Add a test and cleanup some PEP8 issues.
1745
        r.register_lazy("stub", "bzrlib.tests.test_config",
1746
                        "StubCredentialStore", fallback=False)
4283.1.2 by Jelmer Vernooij
Add tests, NEWS item.
1747
        self.assertEquals(["stub"], r.keys())
4283.2.1 by Vincent Ladeuil
Add a test and cleanup some PEP8 issues.
1748
        self.assertIsInstance(r.get_credential_store("stub"),
1749
                              StubCredentialStore)
4283.1.2 by Jelmer Vernooij
Add tests, NEWS item.
1750
1751
    def test_is_fallback(self):
1752
        r = config.CredentialStoreRegistry()
1753
        r.register("stub1", None, fallback=False)
1754
        r.register("stub2", None, fallback=True)
1755
        self.assertEquals(False, r.is_fallback("stub1"))
1756
        self.assertEquals(True, r.is_fallback("stub2"))
1757
1758
    def test_no_fallback(self):
1759
        r = config.CredentialStoreRegistry()
1760
        store = CountingCredentialStore()
1761
        r.register("count", store, fallback=False)
4283.2.1 by Vincent Ladeuil
Add a test and cleanup some PEP8 issues.
1762
        self.assertEquals(None,
1763
                          r.get_fallback_credentials("http", "example.com"))
4283.1.2 by Jelmer Vernooij
Add tests, NEWS item.
1764
        self.assertEquals(0, store._calls)
1765
1766
    def test_fallback_credentials(self):
1767
        r = config.CredentialStoreRegistry()
1768
        store = StubCredentialStore()
4283.2.1 by Vincent Ladeuil
Add a test and cleanup some PEP8 issues.
1769
        store.add_credentials("http", "example.com",
1770
                              "somebody", "geheim")
4283.1.2 by Jelmer Vernooij
Add tests, NEWS item.
1771
        r.register("stub", store, fallback=True)
1772
        creds = r.get_fallback_credentials("http", "example.com")
1773
        self.assertEquals("somebody", creds["user"])
1774
        self.assertEquals("geheim", creds["password"])
1775
4283.2.1 by Vincent Ladeuil
Add a test and cleanup some PEP8 issues.
1776
    def test_fallback_first_wins(self):
1777
        r = config.CredentialStoreRegistry()
1778
        stub1 = StubCredentialStore()
1779
        stub1.add_credentials("http", "example.com",
1780
                              "somebody", "stub1")
1781
        r.register("stub1", stub1, fallback=True)
1782
        stub2 = StubCredentialStore()
1783
        stub2.add_credentials("http", "example.com",
1784
                              "somebody", "stub2")
1785
        r.register("stub2", stub1, fallback=True)
1786
        creds = r.get_fallback_credentials("http", "example.com")
1787
        self.assertEquals("somebody", creds["user"])
1788
        self.assertEquals("stub1", creds["password"])
1789
3757.3.1 by Vincent Ladeuil
Add credential stores plugging.
1790
1791
class TestPlainTextCredentialStore(tests.TestCase):
1792
1793
    def test_decode_password(self):
1794
        r = config.credential_store_registry
1795
        plain_text = r.get_credential_store()
1796
        decoded = plain_text.decode_password(dict(password='secret'))
1797
        self.assertEquals('secret', decoded)
1798
1799
2900.2.14 by Vincent Ladeuil
More tests.
1800
# 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.
1801
# can implement generic tests.
2900.2.15 by Vincent Ladeuil
AuthenticationConfig can be queried for logins too (first step).
1802
# test_user_password_in_url
1803
# test_user_in_url_password_from_config
1804
# test_user_in_url_password_prompted
1805
# test_user_in_config
1806
# test_user_getpass.getuser
1807
# test_user_prompted ?
2900.2.5 by Vincent Ladeuil
ake ftp aware of authentication config.
1808
class TestAuthenticationRing(tests.TestCaseWithTransport):
1809
    pass