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