~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_config.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-03-16 14:01:20 UTC
  • mfrom: (3280.2.5 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20080316140120-i3yq8yr1l66m11h7
Start 1.4 development

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#   Authors: Robert Collins <robert.collins@canonical.com>
2
3
#
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
12
13
#
13
14
# You should have received a copy of the GNU General Public License
14
15
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
17
 
17
18
"""Tests for finding and reading the bzr config file[s]."""
18
19
# import system imports here
19
20
from cStringIO import StringIO
20
21
import os
21
22
import sys
22
 
import threading
23
23
 
24
24
#import bzrlib specific imports here
25
25
from bzrlib import (
26
26
    branch,
27
27
    bzrdir,
28
28
    config,
29
 
    diff,
30
29
    errors,
31
30
    osutils,
32
31
    mail_client,
34
33
    urlutils,
35
34
    tests,
36
35
    trace,
37
 
    transport,
38
36
    )
39
 
from bzrlib.tests import features
40
37
from bzrlib.util.configobj import configobj
41
38
 
42
39
 
43
 
def lockable_config_scenarios():
44
 
    return [
45
 
        ('global',
46
 
         {'config_class': config.GlobalConfig,
47
 
          'config_args': [],
48
 
          'config_section': 'DEFAULT'}),
49
 
        ('locations',
50
 
         {'config_class': config.LocationConfig,
51
 
          'config_args': ['.'],
52
 
          'config_section': '.'}),]
53
 
 
54
 
 
55
 
def load_tests(standard_tests, module, loader):
56
 
    suite = loader.suiteClass()
57
 
 
58
 
    lc_tests, remaining_tests = tests.split_suite_by_condition(
59
 
        standard_tests, tests.condition_isinstance((
60
 
                TestLockableConfig,
61
 
                )))
62
 
    tests.multiply_tests(lc_tests, lockable_config_scenarios(), suite)
63
 
    suite.addTest(remaining_tests)
64
 
    return suite
65
 
 
66
 
 
67
40
sample_long_alias="log -r-15..-1 --line"
68
41
sample_config_text = u"""
69
42
[DEFAULT]
70
43
email=Erik B\u00e5gfors <erik@bagfors.nu>
71
44
editor=vim
72
 
change_editor=vimdiff -of @new_path @old_path
73
45
gpg_signing_command=gnome-gpg
74
46
log_format=short
75
47
user_global_option=something
155
127
        self._calls.append(('keys',))
156
128
        return []
157
129
 
158
 
    def reload(self):
159
 
        self._calls.append(('reload',))
160
 
 
161
130
    def write(self, arg):
162
131
        self._calls.append(('write',))
163
132
 
177
146
            self.base = "http://example.com/branches/demo"
178
147
        else:
179
148
            self.base = base
180
 
        self._transport = self.control_files = \
181
 
            FakeControlFilesAndTransport(user_id=user_id)
182
 
 
183
 
    def _get_config(self):
184
 
        return config.TransportConfig(self._transport, 'branch.conf')
 
149
        self.control_files = FakeControlFiles(user_id=user_id)
185
150
 
186
151
    def lock_write(self):
187
152
        pass
190
155
        pass
191
156
 
192
157
 
193
 
class FakeControlFilesAndTransport(object):
 
158
class FakeControlFiles(object):
194
159
 
195
160
    def __init__(self, user_id=None):
 
161
        self.email = user_id
196
162
        self.files = {}
197
 
        if user_id:
198
 
            self.files['email'] = user_id
199
 
        self._transport = self
200
163
 
201
164
    def get_utf8(self, filename):
202
 
        # from LockableFiles
203
 
        raise AssertionError("get_utf8 should no longer be used")
 
165
        if filename != 'email':
 
166
            raise NotImplementedError
 
167
        if self.email is not None:
 
168
            return StringIO(self.email)
 
169
        raise errors.NoSuchFile(filename)
204
170
 
205
171
    def get(self, filename):
206
 
        # from Transport
207
172
        try:
208
173
            return StringIO(self.files[filename])
209
174
        except KeyError:
210
175
            raise errors.NoSuchFile(filename)
211
176
 
212
 
    def get_bytes(self, filename):
213
 
        # from Transport
214
 
        try:
215
 
            return self.files[filename]
216
 
        except KeyError:
217
 
            raise errors.NoSuchFile(filename)
218
 
 
219
177
    def put(self, filename, fileobj):
220
178
        self.files[filename] = fileobj.read()
221
179
 
222
 
    def put_file(self, filename, fileobj):
223
 
        return self.put(filename, fileobj)
224
 
 
225
180
 
226
181
class InstrumentedConfig(config.Config):
227
182
    """An instrumented config that supplies stubs for template methods."""
239
194
        self._calls.append('_get_signature_checking')
240
195
        return self._signatures
241
196
 
242
 
    def _get_change_editor(self):
243
 
        self._calls.append('_get_change_editor')
244
 
        return 'vimdiff -fo @new_path @old_path'
245
 
 
246
197
 
247
198
bool_config = """[DEFAULT]
248
199
active = true
349
300
        my_config = config.Config()
350
301
        self.assertEqual('long', my_config.log_format())
351
302
 
352
 
    def test_get_change_editor(self):
353
 
        my_config = InstrumentedConfig()
354
 
        change_editor = my_config.get_change_editor('old_tree', 'new_tree')
355
 
        self.assertEqual(['_get_change_editor'], my_config._calls)
356
 
        self.assertIs(diff.DiffFromTool, change_editor.__class__)
357
 
        self.assertEqual(['vimdiff', '-fo', '@new_path', '@old_path'],
358
 
                         change_editor.command_template)
359
 
 
360
303
 
361
304
class TestConfigPath(tests.TestCase):
362
305
 
363
306
    def setUp(self):
364
307
        super(TestConfigPath, self).setUp()
365
308
        os.environ['HOME'] = '/home/bogus'
366
 
        os.environ['XDG_CACHE_DIR'] = ''
367
309
        if sys.platform == 'win32':
368
310
            os.environ['BZR_HOME'] = \
369
311
                r'C:\Documents and Settings\bogus\Application Data'
379
321
        self.assertEqual(config.config_filename(),
380
322
                         self.bzr_home + '/bazaar.conf')
381
323
 
 
324
    def test_branches_config_filename(self):
 
325
        self.assertEqual(config.branches_config_filename(),
 
326
                         self.bzr_home + '/branches.conf')
 
327
 
382
328
    def test_locations_config_filename(self):
383
329
        self.assertEqual(config.locations_config_filename(),
384
330
                         self.bzr_home + '/locations.conf')
387
333
        self.assertEqual(config.authentication_config_filename(),
388
334
                         self.bzr_home + '/authentication.conf')
389
335
 
390
 
    def test_xdg_cache_dir(self):
391
 
        self.assertEqual(config.xdg_cache_dir(),
392
 
            '/home/bogus/.cache')
393
 
 
394
 
 
395
 
class TestIniConfig(tests.TestCaseInTempDir):
396
 
 
397
 
    def make_config_parser(self, s):
398
 
        conf = config.IniBasedConfig.from_string(s)
399
 
        return conf, conf._get_parser()
400
 
 
401
 
 
402
 
class TestIniConfigBuilding(TestIniConfig):
 
336
 
 
337
class TestIniConfig(tests.TestCase):
403
338
 
404
339
    def test_contructs(self):
405
 
        my_config = config.IniBasedConfig()
 
340
        my_config = config.IniBasedConfig("nothing")
406
341
 
407
342
    def test_from_fp(self):
408
 
        my_config = config.IniBasedConfig.from_string(sample_config_text)
409
 
        self.assertIsInstance(my_config._get_parser(), configobj.ConfigObj)
 
343
        config_file = StringIO(sample_config_text.encode('utf-8'))
 
344
        my_config = config.IniBasedConfig(None)
 
345
        self.failUnless(
 
346
            isinstance(my_config._get_parser(file=config_file),
 
347
                        configobj.ConfigObj))
410
348
 
411
349
    def test_cached(self):
412
 
        my_config = config.IniBasedConfig.from_string(sample_config_text)
413
 
        parser = my_config._get_parser()
 
350
        config_file = StringIO(sample_config_text.encode('utf-8'))
 
351
        my_config = config.IniBasedConfig(None)
 
352
        parser = my_config._get_parser(file=config_file)
414
353
        self.failUnless(my_config._get_parser() is parser)
415
354
 
416
 
    def _dummy_chown(self, path, uid, gid):
417
 
        self.path, self.uid, self.gid = path, uid, gid
418
 
 
419
 
    def test_ini_config_ownership(self):
420
 
        """Ensure that chown is happening during _write_config_file"""
421
 
        self.requireFeature(features.chown_feature)
422
 
        self.overrideAttr(os, 'chown', self._dummy_chown)
423
 
        self.path = self.uid = self.gid = None
424
 
        conf = config.IniBasedConfig(file_name='./foo.conf')
425
 
        conf._write_config_file()
426
 
        self.assertEquals(self.path, './foo.conf')
427
 
        self.assertTrue(isinstance(self.uid, int))
428
 
        self.assertTrue(isinstance(self.gid, int))
429
 
 
430
 
    def test_get_filename_parameter_is_deprecated_(self):
431
 
        conf = self.callDeprecated([
432
 
            'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
433
 
            ' Use file_name instead.'],
434
 
            config.IniBasedConfig, lambda: 'ini.conf')
435
 
        self.assertEqual('ini.conf', conf.file_name)
436
 
 
437
 
    def test_get_parser_file_parameter_is_deprecated_(self):
438
 
        config_file = StringIO(sample_config_text.encode('utf-8'))
439
 
        conf = config.IniBasedConfig.from_string(sample_config_text)
440
 
        conf = self.callDeprecated([
441
 
            'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
442
 
            ' Use IniBasedConfig(_content=xxx) instead.'],
443
 
            conf._get_parser, file=config_file)
444
 
 
445
 
class TestIniConfigSaving(tests.TestCaseInTempDir):
446
 
 
447
 
    def test_cant_save_without_a_file_name(self):
448
 
        conf = config.IniBasedConfig()
449
 
        self.assertRaises(AssertionError, conf._write_config_file)
450
 
 
451
 
    def test_saved_with_content(self):
452
 
        content = 'foo = bar\n'
453
 
        conf = config.IniBasedConfig.from_string(
454
 
            content, file_name='./test.conf', save=True)
455
 
        self.assertFileEqual(content, 'test.conf')
456
 
 
457
 
 
458
 
class TestIniBaseConfigOnDisk(tests.TestCaseInTempDir):
459
 
 
460
 
    def test_cannot_reload_without_name(self):
461
 
        conf = config.IniBasedConfig.from_string(sample_config_text)
462
 
        self.assertRaises(AssertionError, conf.reload)
463
 
 
464
 
    def test_reload_see_new_value(self):
465
 
        c1 = config.IniBasedConfig.from_string('editor=vim\n',
466
 
                                               file_name='./test/conf')
467
 
        c1._write_config_file()
468
 
        c2 = config.IniBasedConfig.from_string('editor=emacs\n',
469
 
                                               file_name='./test/conf')
470
 
        c2._write_config_file()
471
 
        self.assertEqual('vim', c1.get_user_option('editor'))
472
 
        self.assertEqual('emacs', c2.get_user_option('editor'))
473
 
        # Make sure we get the Right value
474
 
        c1.reload()
475
 
        self.assertEqual('emacs', c1.get_user_option('editor'))
476
 
 
477
 
 
478
 
class TestLockableConfig(tests.TestCaseInTempDir):
479
 
 
480
 
    # Set by load_tests
481
 
    config_class = None
482
 
    config_args = None
483
 
    config_section = None
484
 
 
485
 
    def setUp(self):
486
 
        super(TestLockableConfig, self).setUp()
487
 
        self._content = '[%s]\none=1\ntwo=2\n' % (self.config_section,)
488
 
        self.config = self.create_config(self._content)
489
 
 
490
 
    def get_existing_config(self):
491
 
        return self.config_class(*self.config_args)
492
 
 
493
 
    def create_config(self, content):
494
 
        kwargs = dict(save=True)
495
 
        c = self.config_class.from_string(content, *self.config_args, **kwargs)
496
 
        return c
497
 
 
498
 
    def test_simple_read_access(self):
499
 
        self.assertEquals('1', self.config.get_user_option('one'))
500
 
 
501
 
    def test_simple_write_access(self):
502
 
        self.config.set_user_option('one', 'one')
503
 
        self.assertEquals('one', self.config.get_user_option('one'))
504
 
 
505
 
    def test_listen_to_the_last_speaker(self):
506
 
        c1 = self.config
507
 
        c2 = self.get_existing_config()
508
 
        c1.set_user_option('one', 'ONE')
509
 
        c2.set_user_option('two', 'TWO')
510
 
        self.assertEquals('ONE', c1.get_user_option('one'))
511
 
        self.assertEquals('TWO', c2.get_user_option('two'))
512
 
        # The second update respect the first one
513
 
        self.assertEquals('ONE', c2.get_user_option('one'))
514
 
 
515
 
    def test_last_speaker_wins(self):
516
 
        # If the same config is not shared, the same variable modified twice
517
 
        # can only see a single result.
518
 
        c1 = self.config
519
 
        c2 = self.get_existing_config()
520
 
        c1.set_user_option('one', 'c1')
521
 
        c2.set_user_option('one', 'c2')
522
 
        self.assertEquals('c2', c2._get_user_option('one'))
523
 
        # The first modification is still available until another refresh
524
 
        # occur
525
 
        self.assertEquals('c1', c1._get_user_option('one'))
526
 
        c1.set_user_option('two', 'done')
527
 
        self.assertEquals('c2', c1._get_user_option('one'))
528
 
 
529
 
    def test_writes_are_serialized(self):
530
 
        c1 = self.config
531
 
        c2 = self.get_existing_config()
532
 
 
533
 
        # We spawn a thread that will pause *during* the write
534
 
        before_writing = threading.Event()
535
 
        after_writing = threading.Event()
536
 
        writing_done = threading.Event()
537
 
        c1_orig = c1._write_config_file
538
 
        def c1_write_config_file():
539
 
            before_writing.set()
540
 
            c1_orig()
541
 
            # The lock is held we wait for the main thread to decide when to
542
 
            # continue
543
 
            after_writing.wait()
544
 
        c1._write_config_file = c1_write_config_file
545
 
        def c1_set_option():
546
 
            c1.set_user_option('one', 'c1')
547
 
            writing_done.set()
548
 
        t1 = threading.Thread(target=c1_set_option)
549
 
        # Collect the thread after the test
550
 
        self.addCleanup(t1.join)
551
 
        # Be ready to unblock the thread if the test goes wrong
552
 
        self.addCleanup(after_writing.set)
553
 
        t1.start()
554
 
        before_writing.wait()
555
 
        self.assertTrue(c1._lock.is_held)
556
 
        self.assertRaises(errors.LockContention,
557
 
                          c2.set_user_option, 'one', 'c2')
558
 
        self.assertEquals('c1', c1.get_user_option('one'))
559
 
        # Let the lock be released
560
 
        after_writing.set()
561
 
        writing_done.wait()
562
 
        c2.set_user_option('one', 'c2')
563
 
        self.assertEquals('c2', c2.get_user_option('one'))
564
 
 
565
 
    def test_read_while_writing(self):
566
 
       c1 = self.config
567
 
       # We spawn a thread that will pause *during* the write
568
 
       ready_to_write = threading.Event()
569
 
       do_writing = threading.Event()
570
 
       writing_done = threading.Event()
571
 
       c1_orig = c1._write_config_file
572
 
       def c1_write_config_file():
573
 
           ready_to_write.set()
574
 
           # The lock is held we wait for the main thread to decide when to
575
 
           # continue
576
 
           do_writing.wait()
577
 
           c1_orig()
578
 
           writing_done.set()
579
 
       c1._write_config_file = c1_write_config_file
580
 
       def c1_set_option():
581
 
           c1.set_user_option('one', 'c1')
582
 
       t1 = threading.Thread(target=c1_set_option)
583
 
       # Collect the thread after the test
584
 
       self.addCleanup(t1.join)
585
 
       # Be ready to unblock the thread if the test goes wrong
586
 
       self.addCleanup(do_writing.set)
587
 
       t1.start()
588
 
       # Ensure the thread is ready to write
589
 
       ready_to_write.wait()
590
 
       self.assertTrue(c1._lock.is_held)
591
 
       self.assertEquals('c1', c1.get_user_option('one'))
592
 
       # If we read during the write, we get the old value
593
 
       c2 = self.get_existing_config()
594
 
       self.assertEquals('1', c2.get_user_option('one'))
595
 
       # Let the writing occur and ensure it occurred
596
 
       do_writing.set()
597
 
       writing_done.wait()
598
 
       # Now we get the updated value
599
 
       c3 = self.get_existing_config()
600
 
       self.assertEquals('c1', c3.get_user_option('one'))
601
 
 
602
 
 
603
 
class TestGetUserOptionAs(TestIniConfig):
604
 
 
605
 
    def test_get_user_option_as_bool(self):
606
 
        conf, parser = self.make_config_parser("""
607
 
a_true_bool = true
608
 
a_false_bool = 0
609
 
an_invalid_bool = maybe
610
 
a_list = hmm, who knows ? # This is interpreted as a list !
611
 
""")
612
 
        get_bool = conf.get_user_option_as_bool
613
 
        self.assertEqual(True, get_bool('a_true_bool'))
614
 
        self.assertEqual(False, get_bool('a_false_bool'))
615
 
        warnings = []
616
 
        def warning(*args):
617
 
            warnings.append(args[0] % args[1:])
618
 
        self.overrideAttr(trace, 'warning', warning)
619
 
        msg = 'Value "%s" is not a boolean for "%s"'
620
 
        self.assertIs(None, get_bool('an_invalid_bool'))
621
 
        self.assertEquals(msg % ('maybe', 'an_invalid_bool'), warnings[0])
622
 
        warnings = []
623
 
        self.assertIs(None, get_bool('not_defined_in_this_config'))
624
 
        self.assertEquals([], warnings)
625
 
 
626
 
    def test_get_user_option_as_list(self):
627
 
        conf, parser = self.make_config_parser("""
628
 
a_list = a,b,c
629
 
length_1 = 1,
630
 
one_item = x
631
 
""")
632
 
        get_list = conf.get_user_option_as_list
633
 
        self.assertEqual(['a', 'b', 'c'], get_list('a_list'))
634
 
        self.assertEqual(['1'], get_list('length_1'))
635
 
        self.assertEqual('x', conf.get_user_option('one_item'))
636
 
        # automatically cast to list
637
 
        self.assertEqual(['x'], get_list('one_item'))
638
 
 
639
 
 
640
 
class TestSupressWarning(TestIniConfig):
641
 
 
642
 
    def make_warnings_config(self, s):
643
 
        conf, parser = self.make_config_parser(s)
644
 
        return conf.suppress_warning
645
 
 
646
 
    def test_suppress_warning_unknown(self):
647
 
        suppress_warning = self.make_warnings_config('')
648
 
        self.assertEqual(False, suppress_warning('unknown_warning'))
649
 
 
650
 
    def test_suppress_warning_known(self):
651
 
        suppress_warning = self.make_warnings_config('suppress_warnings=a,b')
652
 
        self.assertEqual(False, suppress_warning('c'))
653
 
        self.assertEqual(True, suppress_warning('a'))
654
 
        self.assertEqual(True, suppress_warning('b'))
655
 
 
656
355
 
657
356
class TestGetConfig(tests.TestCase):
658
357
 
711
410
        branch = self.make_branch('branch')
712
411
        self.assertEqual('branch', branch.nick)
713
412
 
 
413
        locations = config.locations_config_filename()
 
414
        config.ensure_config_dir_exists()
714
415
        local_url = urlutils.local_path_to_url('branch')
715
 
        conf = config.LocationConfig.from_string(
716
 
            '[%s]\nnickname = foobar' % (local_url,),
717
 
            local_url, save=True)
 
416
        open(locations, 'wb').write('[%s]\nnickname = foobar' 
 
417
                                    % (local_url,))
718
418
        self.assertEqual('foobar', branch.nick)
719
419
 
720
420
    def test_config_local_path(self):
722
422
        branch = self.make_branch('branch')
723
423
        self.assertEqual('branch', branch.nick)
724
424
 
725
 
        local_path = osutils.getcwd().encode('utf8')
726
 
        conf = config.LocationConfig.from_string(
727
 
            '[%s/branch]\nnickname = barry' % (local_path,),
728
 
            'branch',  save=True)
 
425
        locations = config.locations_config_filename()
 
426
        config.ensure_config_dir_exists()
 
427
        open(locations, 'wb').write('[%s/branch]\nnickname = barry' 
 
428
                                    % (osutils.getcwd().encode('utf8'),))
729
429
        self.assertEqual('barry', branch.nick)
730
430
 
731
431
    def test_config_creates_local(self):
732
432
        """Creating a new entry in config uses a local path."""
733
433
        branch = self.make_branch('branch', format='knit')
734
434
        branch.set_push_location('http://foobar')
 
435
        locations = config.locations_config_filename()
735
436
        local_path = osutils.getcwd().encode('utf8')
736
437
        # Surprisingly ConfigObj doesn't create a trailing newline
737
 
        self.check_file_contents(config.locations_config_filename(),
 
438
        self.check_file_contents(locations,
738
439
                                 '[%s/branch]\n'
739
440
                                 'push_location = http://foobar\n'
740
441
                                 'push_location:policy = norecurse\n'
745
446
        self.assertEqual('!repo', b.get_config().get_nickname())
746
447
 
747
448
    def test_warn_if_masked(self):
 
449
        _warning = trace.warning
748
450
        warnings = []
749
451
        def warning(*args):
750
452
            warnings.append(args[0] % args[1:])
751
 
        self.overrideAttr(trace, 'warning', warning)
752
453
 
753
454
        def set_option(store, warn_masked=True):
754
455
            warnings[:] = []
760
461
            else:
761
462
                self.assertEqual(1, len(warnings))
762
463
                self.assertEqual(warning, warnings[0])
763
 
        branch = self.make_branch('.')
764
 
        conf = branch.get_config()
765
 
        set_option(config.STORE_GLOBAL)
766
 
        assertWarning(None)
767
 
        set_option(config.STORE_BRANCH)
768
 
        assertWarning(None)
769
 
        set_option(config.STORE_GLOBAL)
770
 
        assertWarning('Value "4" is masked by "3" from branch.conf')
771
 
        set_option(config.STORE_GLOBAL, warn_masked=False)
772
 
        assertWarning(None)
773
 
        set_option(config.STORE_LOCATION)
774
 
        assertWarning(None)
775
 
        set_option(config.STORE_BRANCH)
776
 
        assertWarning('Value "3" is masked by "0" from locations.conf')
777
 
        set_option(config.STORE_BRANCH, warn_masked=False)
778
 
        assertWarning(None)
 
464
        trace.warning = warning
 
465
        try:
 
466
            branch = self.make_branch('.')
 
467
            conf = branch.get_config()
 
468
            set_option(config.STORE_GLOBAL)
 
469
            assertWarning(None)
 
470
            set_option(config.STORE_BRANCH)
 
471
            assertWarning(None)
 
472
            set_option(config.STORE_GLOBAL)
 
473
            assertWarning('Value "4" is masked by "3" from branch.conf')
 
474
            set_option(config.STORE_GLOBAL, warn_masked=False)
 
475
            assertWarning(None)
 
476
            set_option(config.STORE_LOCATION)
 
477
            assertWarning(None)
 
478
            set_option(config.STORE_BRANCH)
 
479
            assertWarning('Value "3" is masked by "0" from locations.conf')
 
480
            set_option(config.STORE_BRANCH, warn_masked=False)
 
481
            assertWarning(None)
 
482
        finally:
 
483
            trace.warning = _warning
779
484
 
780
485
 
781
486
class TestGlobalConfigItems(tests.TestCase):
782
487
 
783
488
    def test_user_id(self):
784
 
        my_config = config.GlobalConfig.from_string(sample_config_text)
 
489
        config_file = StringIO(sample_config_text.encode('utf-8'))
 
490
        my_config = config.GlobalConfig()
 
491
        my_config._parser = my_config._get_parser(file=config_file)
785
492
        self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
786
493
                         my_config._get_user_id())
787
494
 
788
495
    def test_absent_user_id(self):
 
496
        config_file = StringIO("")
789
497
        my_config = config.GlobalConfig()
 
498
        my_config._parser = my_config._get_parser(file=config_file)
790
499
        self.assertEqual(None, my_config._get_user_id())
791
500
 
792
501
    def test_configured_editor(self):
793
 
        my_config = config.GlobalConfig.from_string(sample_config_text)
 
502
        config_file = StringIO(sample_config_text.encode('utf-8'))
 
503
        my_config = config.GlobalConfig()
 
504
        my_config._parser = my_config._get_parser(file=config_file)
794
505
        self.assertEqual("vim", my_config.get_editor())
795
506
 
796
507
    def test_signatures_always(self):
797
 
        my_config = config.GlobalConfig.from_string(sample_always_signatures)
 
508
        config_file = StringIO(sample_always_signatures)
 
509
        my_config = config.GlobalConfig()
 
510
        my_config._parser = my_config._get_parser(file=config_file)
798
511
        self.assertEqual(config.CHECK_NEVER,
799
512
                         my_config.signature_checking())
800
513
        self.assertEqual(config.SIGN_ALWAYS,
802
515
        self.assertEqual(True, my_config.signature_needed())
803
516
 
804
517
    def test_signatures_if_possible(self):
805
 
        my_config = config.GlobalConfig.from_string(sample_maybe_signatures)
 
518
        config_file = StringIO(sample_maybe_signatures)
 
519
        my_config = config.GlobalConfig()
 
520
        my_config._parser = my_config._get_parser(file=config_file)
806
521
        self.assertEqual(config.CHECK_NEVER,
807
522
                         my_config.signature_checking())
808
523
        self.assertEqual(config.SIGN_WHEN_REQUIRED,
810
525
        self.assertEqual(False, my_config.signature_needed())
811
526
 
812
527
    def test_signatures_ignore(self):
813
 
        my_config = config.GlobalConfig.from_string(sample_ignore_signatures)
 
528
        config_file = StringIO(sample_ignore_signatures)
 
529
        my_config = config.GlobalConfig()
 
530
        my_config._parser = my_config._get_parser(file=config_file)
814
531
        self.assertEqual(config.CHECK_ALWAYS,
815
532
                         my_config.signature_checking())
816
533
        self.assertEqual(config.SIGN_NEVER,
818
535
        self.assertEqual(False, my_config.signature_needed())
819
536
 
820
537
    def _get_sample_config(self):
821
 
        my_config = config.GlobalConfig.from_string(sample_config_text)
 
538
        config_file = StringIO(sample_config_text.encode('utf-8'))
 
539
        my_config = config.GlobalConfig()
 
540
        my_config._parser = my_config._get_parser(file=config_file)
822
541
        return my_config
823
542
 
824
543
    def test_gpg_signing_command(self):
827
546
        self.assertEqual(False, my_config.signature_needed())
828
547
 
829
548
    def _get_empty_config(self):
 
549
        config_file = StringIO("")
830
550
        my_config = config.GlobalConfig()
 
551
        my_config._parser = my_config._get_parser(file=config_file)
831
552
        return my_config
832
553
 
833
554
    def test_gpg_signing_command_unset(self):
855
576
        my_config = self._get_sample_config()
856
577
        self.assertEqual('help', my_config.get_alias('h'))
857
578
 
858
 
    def test_get_aliases(self):
859
 
        my_config = self._get_sample_config()
860
 
        aliases = my_config.get_aliases()
861
 
        self.assertEqual(2, len(aliases))
862
 
        sorted_keys = sorted(aliases)
863
 
        self.assertEqual('help', aliases[sorted_keys[0]])
864
 
        self.assertEqual(sample_long_alias, aliases[sorted_keys[1]])
865
 
 
866
579
    def test_get_no_alias(self):
867
580
        my_config = self._get_sample_config()
868
581
        self.assertEqual(None, my_config.get_alias('foo'))
871
584
        my_config = self._get_sample_config()
872
585
        self.assertEqual(sample_long_alias, my_config.get_alias('ll'))
873
586
 
874
 
    def test_get_change_editor(self):
875
 
        my_config = self._get_sample_config()
876
 
        change_editor = my_config.get_change_editor('old', 'new')
877
 
        self.assertIs(diff.DiffFromTool, change_editor.__class__)
878
 
        self.assertEqual('vimdiff -of @new_path @old_path',
879
 
                         ' '.join(change_editor.command_template))
880
 
 
881
 
    def test_get_no_change_editor(self):
882
 
        my_config = self._get_empty_config()
883
 
        change_editor = my_config.get_change_editor('old', 'new')
884
 
        self.assertIs(None, change_editor)
885
 
 
886
 
 
887
 
class TestGlobalConfigSavingOptions(tests.TestCaseInTempDir):
888
 
 
889
 
    def test_empty(self):
890
 
        my_config = config.GlobalConfig()
891
 
        self.assertEqual(0, len(my_config.get_aliases()))
892
 
 
893
 
    def test_set_alias(self):
894
 
        my_config = config.GlobalConfig()
895
 
        alias_value = 'commit --strict'
896
 
        my_config.set_alias('commit', alias_value)
897
 
        new_config = config.GlobalConfig()
898
 
        self.assertEqual(alias_value, new_config.get_alias('commit'))
899
 
 
900
 
    def test_remove_alias(self):
901
 
        my_config = config.GlobalConfig()
902
 
        my_config.set_alias('commit', 'commit --strict')
903
 
        # Now remove the alias again.
904
 
        my_config.unset_alias('commit')
905
 
        new_config = config.GlobalConfig()
906
 
        self.assertIs(None, new_config.get_alias('commit'))
907
 
 
908
587
 
909
588
class TestLocationConfig(tests.TestCaseInTempDir):
910
589
 
928
607
        self.assertEqual(parser._calls,
929
608
                         [('__init__', config.locations_config_filename(),
930
609
                           'utf-8')])
 
610
        config.ensure_config_dir_exists()
 
611
        #os.mkdir(config.config_dir())
 
612
        f = file(config.branches_config_filename(), 'wb')
 
613
        f.write('')
 
614
        f.close()
 
615
        oldparserclass = config.ConfigObj
 
616
        config.ConfigObj = InstrumentedConfigObj
 
617
        try:
 
618
            my_config = config.LocationConfig('http://www.example.com')
 
619
            parser = my_config._get_parser()
 
620
        finally:
 
621
            config.ConfigObj = oldparserclass
931
622
 
932
623
    def test_get_global_config(self):
933
624
        my_config = config.BranchConfig(FakeBranch('http://example.com'))
1162
853
                         self.my_config.post_commit())
1163
854
 
1164
855
    def get_branch_config(self, location, global_config=None):
1165
 
        my_branch = FakeBranch(location)
1166
856
        if global_config is None:
1167
 
            global_config = sample_config_text
1168
 
 
1169
 
        my_global_config = config.GlobalConfig.from_string(global_config,
1170
 
                                                           save=True)
1171
 
        my_location_config = config.LocationConfig.from_string(
1172
 
            sample_branches_text, my_branch.base, save=True)
1173
 
        my_config = config.BranchConfig(my_branch)
1174
 
        self.my_config = my_config
1175
 
        self.my_location_config = my_config._get_location_config()
 
857
            global_file = StringIO(sample_config_text.encode('utf-8'))
 
858
        else:
 
859
            global_file = StringIO(global_config.encode('utf-8'))
 
860
        branches_file = StringIO(sample_branches_text.encode('utf-8'))
 
861
        self.my_config = config.BranchConfig(FakeBranch(location))
 
862
        # Force location config to use specified file
 
863
        self.my_location_config = self.my_config._get_location_config()
 
864
        self.my_location_config._get_parser(branches_file)
 
865
        # Force global config to use specified file
 
866
        self.my_config._get_global_config()._get_parser(global_file)
1176
867
 
1177
868
    def test_set_user_setting_sets_and_saves(self):
1178
869
        self.get_branch_config('/a/c')
1179
870
        record = InstrumentedConfigObj("foo")
1180
871
        self.my_location_config._parser = record
1181
872
 
1182
 
        self.callDeprecated(['The recurse option is deprecated as of '
1183
 
                             '0.14.  The section "/a/c" has been '
1184
 
                             'converted to use policies.'],
1185
 
                            self.my_config.set_user_option,
1186
 
                            'foo', 'bar', store=config.STORE_LOCATION)
1187
 
        self.assertEqual([('reload',),
1188
 
                          ('__contains__', '/a/c'),
 
873
        real_mkdir = os.mkdir
 
874
        self.created = False
 
875
        def checked_mkdir(path, mode=0777):
 
876
            self.log('making directory: %s', path)
 
877
            real_mkdir(path, mode)
 
878
            self.created = True
 
879
 
 
880
        os.mkdir = checked_mkdir
 
881
        try:
 
882
            self.callDeprecated(['The recurse option is deprecated as of '
 
883
                                 '0.14.  The section "/a/c" has been '
 
884
                                 'converted to use policies.'],
 
885
                                self.my_config.set_user_option,
 
886
                                'foo', 'bar', store=config.STORE_LOCATION)
 
887
        finally:
 
888
            os.mkdir = real_mkdir
 
889
 
 
890
        self.failUnless(self.created, 'Failed to create ~/.bazaar')
 
891
        self.assertEqual([('__contains__', '/a/c'),
1189
892
                          ('__contains__', '/a/c/'),
1190
893
                          ('__setitem__', '/a/c', {}),
1191
894
                          ('__getitem__', '/a/c'),
1206
909
        self.assertIs(self.my_config.get_user_option('foo'), None)
1207
910
        self.my_config.set_user_option('foo', 'bar')
1208
911
        self.assertEqual(
1209
 
            self.my_config.branch.control_files.files['branch.conf'].strip(),
1210
 
            'foo = bar')
 
912
            self.my_config.branch.control_files.files['branch.conf'],
 
913
            'foo = bar\n')
1211
914
        self.assertEqual(self.my_config.get_user_option('foo'), 'bar')
1212
915
        self.my_config.set_user_option('foo', 'baz',
1213
916
                                       store=config.STORE_LOCATION)
1234
937
option = exact
1235
938
"""
1236
939
 
 
940
 
1237
941
class TestBranchConfigItems(tests.TestCaseInTempDir):
1238
942
 
1239
943
    def get_branch_config(self, global_config=None, location=None,
1240
944
                          location_config=None, branch_data_config=None):
1241
 
        my_branch = FakeBranch(location)
 
945
        my_config = config.BranchConfig(FakeBranch(location))
1242
946
        if global_config is not None:
1243
 
            my_global_config = config.GlobalConfig.from_string(global_config,
1244
 
                                                               save=True)
 
947
            global_file = StringIO(global_config.encode('utf-8'))
 
948
            my_config._get_global_config()._get_parser(global_file)
 
949
        self.my_location_config = my_config._get_location_config()
1245
950
        if location_config is not None:
1246
 
            my_location_config = config.LocationConfig.from_string(
1247
 
                location_config, my_branch.base, save=True)
1248
 
        my_config = config.BranchConfig(my_branch)
 
951
            location_file = StringIO(location_config.encode('utf-8'))
 
952
            self.my_location_config._get_parser(location_file)
1249
953
        if branch_data_config is not None:
1250
954
            my_config.branch.control_files.files['branch.conf'] = \
1251
955
                branch_data_config
1256
960
        my_config = config.BranchConfig(branch)
1257
961
        self.assertEqual("Robert Collins <robertc@example.net>",
1258
962
                         my_config.username())
1259
 
        my_config.branch.control_files.files['email'] = "John"
 
963
        branch.control_files.email = "John"
1260
964
        my_config.set_user_option('email',
1261
965
                                  "Robert Collins <robertc@example.org>")
1262
966
        self.assertEqual("John", my_config.username())
1263
 
        del my_config.branch.control_files.files['email']
 
967
        branch.control_files.email = None
1264
968
        self.assertEqual("Robert Collins <robertc@example.org>",
1265
969
                         my_config.username())
1266
970
 
1267
971
    def test_not_set_in_branch(self):
1268
 
        my_config = self.get_branch_config(global_config=sample_config_text)
 
972
        my_config = self.get_branch_config(sample_config_text)
 
973
        my_config.branch.control_files.email = None
1269
974
        self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
1270
975
                         my_config._get_user_id())
1271
 
        my_config.branch.control_files.files['email'] = "John"
 
976
        my_config.branch.control_files.email = "John"
1272
977
        self.assertEqual("John", my_config._get_user_id())
1273
978
 
1274
979
    def test_BZR_EMAIL_OVERRIDES(self):
1295
1000
 
1296
1001
    def test_gpg_signing_command(self):
1297
1002
        my_config = self.get_branch_config(
1298
 
            global_config=sample_config_text,
1299
1003
            # branch data cannot set gpg_signing_command
1300
1004
            branch_data_config="gpg_signing_command=pgp")
 
1005
        config_file = StringIO(sample_config_text.encode('utf-8'))
 
1006
        my_config._get_global_config()._get_parser(config_file)
1301
1007
        self.assertEqual('gnome-gpg', my_config.gpg_signing_command())
1302
1008
 
1303
1009
    def test_get_user_option_global(self):
1304
 
        my_config = self.get_branch_config(global_config=sample_config_text)
 
1010
        branch = FakeBranch()
 
1011
        my_config = config.BranchConfig(branch)
 
1012
        config_file = StringIO(sample_config_text.encode('utf-8'))
 
1013
        (my_config._get_global_config()._get_parser(config_file))
1305
1014
        self.assertEqual('something',
1306
1015
                         my_config.get_user_option('user_global_option'))
1307
1016
 
1308
1017
    def test_post_commit_default(self):
1309
 
        my_config = self.get_branch_config(global_config=sample_config_text,
1310
 
                                      location='/a/c',
1311
 
                                      location_config=sample_branches_text)
 
1018
        branch = FakeBranch()
 
1019
        my_config = self.get_branch_config(sample_config_text, '/a/c',
 
1020
                                           sample_branches_text)
1312
1021
        self.assertEqual(my_config.branch.base, '/a/c')
1313
1022
        self.assertEqual('bzrlib.tests.test_config.post_commit',
1314
1023
                         my_config.post_commit())
1315
1024
        my_config.set_user_option('post_commit', 'rmtree_root')
1316
 
        # post-commit is ignored when present in branch data
 
1025
        # post-commit is ignored when bresent in branch data
1317
1026
        self.assertEqual('bzrlib.tests.test_config.post_commit',
1318
1027
                         my_config.post_commit())
1319
1028
        my_config.set_user_option('post_commit', 'rmtree_root',
1321
1030
        self.assertEqual('rmtree_root', my_config.post_commit())
1322
1031
 
1323
1032
    def test_config_precedence(self):
1324
 
        # FIXME: eager test, luckily no persitent config file makes it fail
1325
 
        # -- vila 20100716
1326
1033
        my_config = self.get_branch_config(global_config=precedence_global)
1327
1034
        self.assertEqual(my_config.get_user_option('option'), 'global')
1328
1035
        my_config = self.get_branch_config(global_config=precedence_global,
1329
 
                                           branch_data_config=precedence_branch)
 
1036
                                      branch_data_config=precedence_branch)
1330
1037
        self.assertEqual(my_config.get_user_option('option'), 'branch')
1331
 
        my_config = self.get_branch_config(
1332
 
            global_config=precedence_global,
1333
 
            branch_data_config=precedence_branch,
1334
 
            location_config=precedence_location)
 
1038
        my_config = self.get_branch_config(global_config=precedence_global,
 
1039
                                      branch_data_config=precedence_branch,
 
1040
                                      location_config=precedence_location)
1335
1041
        self.assertEqual(my_config.get_user_option('option'), 'recurse')
1336
 
        my_config = self.get_branch_config(
1337
 
            global_config=precedence_global,
1338
 
            branch_data_config=precedence_branch,
1339
 
            location_config=precedence_location,
1340
 
            location='http://example.com/specific')
 
1042
        my_config = self.get_branch_config(global_config=precedence_global,
 
1043
                                      branch_data_config=precedence_branch,
 
1044
                                      location_config=precedence_location,
 
1045
                                      location='http://example.com/specific')
1341
1046
        self.assertEqual(my_config.get_user_option('option'), 'exact')
1342
1047
 
1343
1048
    def test_get_mail_client(self):
1431
1136
        self.assertEqual(value, 'value3-section')
1432
1137
 
1433
1138
 
1434
 
class TestTransportConfig(tests.TestCaseWithTransport):
1435
 
 
1436
 
    def test_get_value(self):
1437
 
        """Test that retreiving a value from a section is possible"""
1438
 
        bzrdir_config = config.TransportConfig(transport.get_transport('.'),
1439
 
                                               'control.conf')
1440
 
        bzrdir_config.set_option('value', 'key', 'SECTION')
1441
 
        bzrdir_config.set_option('value2', 'key2')
1442
 
        bzrdir_config.set_option('value3-top', 'key3')
1443
 
        bzrdir_config.set_option('value3-section', 'key3', 'SECTION')
1444
 
        value = bzrdir_config.get_option('key', 'SECTION')
1445
 
        self.assertEqual(value, 'value')
1446
 
        value = bzrdir_config.get_option('key2')
1447
 
        self.assertEqual(value, 'value2')
1448
 
        self.assertEqual(bzrdir_config.get_option('non-existant'), None)
1449
 
        value = bzrdir_config.get_option('non-existant', 'SECTION')
1450
 
        self.assertEqual(value, None)
1451
 
        value = bzrdir_config.get_option('non-existant', default='default')
1452
 
        self.assertEqual(value, 'default')
1453
 
        self.assertEqual(bzrdir_config.get_option('key2', 'NOSECTION'), None)
1454
 
        value = bzrdir_config.get_option('key2', 'NOSECTION',
1455
 
                                         default='default')
1456
 
        self.assertEqual(value, 'default')
1457
 
        value = bzrdir_config.get_option('key3')
1458
 
        self.assertEqual(value, 'value3-top')
1459
 
        value = bzrdir_config.get_option('key3', 'SECTION')
1460
 
        self.assertEqual(value, 'value3-section')
1461
 
 
1462
 
    def test_set_unset_default_stack_on(self):
1463
 
        my_dir = self.make_bzrdir('.')
1464
 
        bzrdir_config = config.BzrDirConfig(my_dir)
1465
 
        self.assertIs(None, bzrdir_config.get_default_stack_on())
1466
 
        bzrdir_config.set_default_stack_on('Foo')
1467
 
        self.assertEqual('Foo', bzrdir_config._config.get_option(
1468
 
                         'default_stack_on'))
1469
 
        self.assertEqual('Foo', bzrdir_config.get_default_stack_on())
1470
 
        bzrdir_config.set_default_stack_on(None)
1471
 
        self.assertIs(None, bzrdir_config.get_default_stack_on())
1472
 
 
1473
 
 
1474
1139
class TestAuthenticationConfigFile(tests.TestCase):
1475
1140
    """Test the authentication.conf file matching"""
1476
1141
 
1491
1156
        self.assertEquals({}, conf._get_config())
1492
1157
        self._got_user_passwd(None, None, conf, 'http', 'foo.net')
1493
1158
 
1494
 
    def test_missing_auth_section_header(self):
1495
 
        conf = config.AuthenticationConfig(_file=StringIO('foo = bar'))
1496
 
        self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
1497
 
 
1498
 
    def test_auth_section_header_not_closed(self):
 
1159
    def test_broken_config(self):
1499
1160
        conf = config.AuthenticationConfig(_file=StringIO('[DEF'))
1500
1161
        self.assertRaises(errors.ParseConfigError, conf._get_config)
1501
1162
 
1502
 
    def test_auth_value_not_boolean(self):
1503
1163
        conf = config.AuthenticationConfig(_file=StringIO(
1504
1164
                """[broken]
1505
1165
scheme=ftp
1507
1167
verify_certificates=askme # Error: Not a boolean
1508
1168
"""))
1509
1169
        self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
1510
 
 
1511
 
    def test_auth_value_not_int(self):
1512
1170
        conf = config.AuthenticationConfig(_file=StringIO(
1513
1171
                """[broken]
1514
1172
scheme=ftp
1517
1175
"""))
1518
1176
        self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
1519
1177
 
1520
 
    def test_unknown_password_encoding(self):
1521
 
        conf = config.AuthenticationConfig(_file=StringIO(
1522
 
                """[broken]
1523
 
scheme=ftp
1524
 
user=joe
1525
 
password_encoding=unknown
1526
 
"""))
1527
 
        self.assertRaises(ValueError, conf.get_password,
1528
 
                          'ftp', 'foo.net', 'joe')
1529
 
 
1530
1178
    def test_credentials_for_scheme_host(self):
1531
1179
        conf = config.AuthenticationConfig(_file=StringIO(
1532
1180
                """# Identity on foo.net
1643
1291
        self._got_user_passwd(None, None,
1644
1292
                              conf, 'http', 'bar.org', user='georges')
1645
1293
 
1646
 
    def test_credentials_for_user_without_password(self):
1647
 
        conf = config.AuthenticationConfig(_file=StringIO(
1648
 
                """
1649
 
[without password]
1650
 
scheme=http
1651
 
host=bar.org
1652
 
user=jim
1653
 
"""))
1654
 
        # Get user but no password
1655
 
        self._got_user_passwd('jim', None,
1656
 
                              conf, 'http', 'bar.org')
1657
 
 
1658
1294
    def test_verify_certificates(self):
1659
1295
        conf = config.AuthenticationConfig(_file=StringIO(
1660
1296
                """
1676
1312
        self.assertEquals(True, credentials.get('verify_certificates'))
1677
1313
 
1678
1314
 
1679
 
class TestAuthenticationStorage(tests.TestCaseInTempDir):
1680
 
 
1681
 
    def test_set_credentials(self):
1682
 
        conf = config.AuthenticationConfig()
1683
 
        conf.set_credentials('name', 'host', 'user', 'scheme', 'password',
1684
 
        99, path='/foo', verify_certificates=False, realm='realm')
1685
 
        credentials = conf.get_credentials(host='host', scheme='scheme',
1686
 
                                           port=99, path='/foo',
1687
 
                                           realm='realm')
1688
 
        CREDENTIALS = {'name': 'name', 'user': 'user', 'password': 'password',
1689
 
                       'verify_certificates': False, 'scheme': 'scheme', 
1690
 
                       'host': 'host', 'port': 99, 'path': '/foo', 
1691
 
                       'realm': 'realm'}
1692
 
        self.assertEqual(CREDENTIALS, credentials)
1693
 
        credentials_from_disk = config.AuthenticationConfig().get_credentials(
1694
 
            host='host', scheme='scheme', port=99, path='/foo', realm='realm')
1695
 
        self.assertEqual(CREDENTIALS, credentials_from_disk)
1696
 
 
1697
 
    def test_reset_credentials_different_name(self):
1698
 
        conf = config.AuthenticationConfig()
1699
 
        conf.set_credentials('name', 'host', 'user', 'scheme', 'password'),
1700
 
        conf.set_credentials('name2', 'host', 'user2', 'scheme', 'password'),
1701
 
        self.assertIs(None, conf._get_config().get('name'))
1702
 
        credentials = conf.get_credentials(host='host', scheme='scheme')
1703
 
        CREDENTIALS = {'name': 'name2', 'user': 'user2', 'password':
1704
 
                       'password', 'verify_certificates': True, 
1705
 
                       'scheme': 'scheme', 'host': 'host', 'port': None, 
1706
 
                       'path': None, 'realm': None}
1707
 
        self.assertEqual(CREDENTIALS, credentials)
1708
 
 
1709
 
 
1710
1315
class TestAuthenticationConfig(tests.TestCase):
1711
1316
    """Test AuthenticationConfig behaviour"""
1712
1317
 
1713
 
    def _check_default_password_prompt(self, expected_prompt_format, scheme,
1714
 
                                       host=None, port=None, realm=None,
1715
 
                                       path=None):
 
1318
    def _check_default_prompt(self, expected_prompt_format, scheme,
 
1319
                              host=None, port=None, realm=None, path=None):
1716
1320
        if host is None:
1717
1321
            host = 'bar.org'
1718
1322
        user, password = 'jim', 'precious'
1721
1325
            'user': user, 'realm': realm}
1722
1326
 
1723
1327
        stdout = tests.StringIOWrapper()
1724
 
        stderr = tests.StringIOWrapper()
1725
1328
        ui.ui_factory = tests.TestUIFactory(stdin=password + '\n',
1726
 
                                            stdout=stdout, stderr=stderr)
 
1329
                                            stdout=stdout)
1727
1330
        # We use an empty conf so that the user is always prompted
1728
1331
        conf = config.AuthenticationConfig()
1729
1332
        self.assertEquals(password,
1730
1333
                          conf.get_password(scheme, host, user, port=port,
1731
1334
                                            realm=realm, path=path))
1732
 
        self.assertEquals(expected_prompt, stderr.getvalue())
1733
 
        self.assertEquals('', stdout.getvalue())
1734
 
 
1735
 
    def _check_default_username_prompt(self, expected_prompt_format, scheme,
1736
 
                                       host=None, port=None, realm=None,
1737
 
                                       path=None):
1738
 
        if host is None:
1739
 
            host = 'bar.org'
1740
 
        username = 'jim'
1741
 
        expected_prompt = expected_prompt_format % {
1742
 
            'scheme': scheme, 'host': host, 'port': port,
1743
 
            'realm': realm}
1744
 
        stdout = tests.StringIOWrapper()
1745
 
        stderr = tests.StringIOWrapper()
1746
 
        ui.ui_factory = tests.TestUIFactory(stdin=username+ '\n',
1747
 
                                            stdout=stdout, stderr=stderr)
1748
 
        # We use an empty conf so that the user is always prompted
1749
 
        conf = config.AuthenticationConfig()
1750
 
        self.assertEquals(username, conf.get_user(scheme, host, port=port,
1751
 
                          realm=realm, path=path, ask=True))
1752
 
        self.assertEquals(expected_prompt, stderr.getvalue())
1753
 
        self.assertEquals('', stdout.getvalue())
1754
 
 
1755
 
    def test_username_defaults_prompts(self):
1756
 
        # HTTP prompts can't be tested here, see test_http.py
1757
 
        self._check_default_username_prompt('FTP %(host)s username: ', 'ftp')
1758
 
        self._check_default_username_prompt(
1759
 
            'FTP %(host)s:%(port)d username: ', 'ftp', port=10020)
1760
 
        self._check_default_username_prompt(
1761
 
            'SSH %(host)s:%(port)d username: ', 'ssh', port=12345)
1762
 
 
1763
 
    def test_username_default_no_prompt(self):
1764
 
        conf = config.AuthenticationConfig()
1765
 
        self.assertEquals(None,
1766
 
            conf.get_user('ftp', 'example.com'))
1767
 
        self.assertEquals("explicitdefault",
1768
 
            conf.get_user('ftp', 'example.com', default="explicitdefault"))
1769
 
 
1770
 
    def test_password_default_prompts(self):
1771
 
        # HTTP prompts can't be tested here, see test_http.py
1772
 
        self._check_default_password_prompt(
1773
 
            'FTP %(user)s@%(host)s password: ', 'ftp')
1774
 
        self._check_default_password_prompt(
1775
 
            'FTP %(user)s@%(host)s:%(port)d password: ', 'ftp', port=10020)
1776
 
        self._check_default_password_prompt(
1777
 
            'SSH %(user)s@%(host)s:%(port)d password: ', 'ssh', port=12345)
 
1335
        self.assertEquals(stdout.getvalue(), expected_prompt)
 
1336
 
 
1337
    def test_default_prompts(self):
 
1338
        # HTTP prompts can't be tested here, see test_http.py
 
1339
        self._check_default_prompt('FTP %(user)s@%(host)s password: ', 'ftp')
 
1340
        self._check_default_prompt('FTP %(user)s@%(host)s:%(port)d password: ',
 
1341
                                   'ftp', port=10020)
 
1342
 
 
1343
        self._check_default_prompt('SSH %(user)s@%(host)s:%(port)d password: ',
 
1344
                                   'ssh', port=12345)
1778
1345
        # SMTP port handling is a bit special (it's handled if embedded in the
1779
1346
        # host too)
1780
1347
        # FIXME: should we: forbid that, extend it to other schemes, leave
1781
1348
        # things as they are that's fine thank you ?
1782
 
        self._check_default_password_prompt('SMTP %(user)s@%(host)s password: ',
1783
 
                                            'smtp')
1784
 
        self._check_default_password_prompt('SMTP %(user)s@%(host)s password: ',
1785
 
                                            'smtp', host='bar.org:10025')
1786
 
        self._check_default_password_prompt(
 
1349
        self._check_default_prompt('SMTP %(user)s@%(host)s password: ',
 
1350
                                   'smtp')
 
1351
        self._check_default_prompt('SMTP %(user)s@%(host)s password: ',
 
1352
                                   'smtp', host='bar.org:10025')
 
1353
        self._check_default_prompt(
1787
1354
            'SMTP %(user)s@%(host)s:%(port)d password: ',
1788
1355
            'smtp', port=10025)
1789
1356
 
1790
 
    def test_ssh_password_emits_warning(self):
1791
 
        conf = config.AuthenticationConfig(_file=StringIO(
1792
 
                """
1793
 
[ssh with password]
1794
 
scheme=ssh
1795
 
host=bar.org
1796
 
user=jim
1797
 
password=jimpass
1798
 
"""))
1799
 
        entered_password = 'typed-by-hand'
1800
 
        stdout = tests.StringIOWrapper()
1801
 
        stderr = tests.StringIOWrapper()
1802
 
        ui.ui_factory = tests.TestUIFactory(stdin=entered_password + '\n',
1803
 
                                            stdout=stdout, stderr=stderr)
1804
 
 
1805
 
        # Since the password defined in the authentication config is ignored,
1806
 
        # the user is prompted
1807
 
        self.assertEquals(entered_password,
1808
 
                          conf.get_password('ssh', 'bar.org', user='jim'))
1809
 
        self.assertContainsRe(
1810
 
            self.get_log(),
1811
 
            'password ignored in section \[ssh with password\]')
1812
 
 
1813
 
    def test_ssh_without_password_doesnt_emit_warning(self):
1814
 
        conf = config.AuthenticationConfig(_file=StringIO(
1815
 
                """
1816
 
[ssh with password]
1817
 
scheme=ssh
1818
 
host=bar.org
1819
 
user=jim
1820
 
"""))
1821
 
        entered_password = 'typed-by-hand'
1822
 
        stdout = tests.StringIOWrapper()
1823
 
        stderr = tests.StringIOWrapper()
1824
 
        ui.ui_factory = tests.TestUIFactory(stdin=entered_password + '\n',
1825
 
                                            stdout=stdout,
1826
 
                                            stderr=stderr)
1827
 
 
1828
 
        # Since the password defined in the authentication config is ignored,
1829
 
        # the user is prompted
1830
 
        self.assertEquals(entered_password,
1831
 
                          conf.get_password('ssh', 'bar.org', user='jim'))
1832
 
        # No warning shoud be emitted since there is no password. We are only
1833
 
        # providing "user".
1834
 
        self.assertNotContainsRe(
1835
 
            self.get_log(),
1836
 
            'password ignored in section \[ssh with password\]')
1837
 
 
1838
 
    def test_uses_fallback_stores(self):
1839
 
        self.overrideAttr(config, 'credential_store_registry',
1840
 
                          config.CredentialStoreRegistry())
1841
 
        store = StubCredentialStore()
1842
 
        store.add_credentials("http", "example.com", "joe", "secret")
1843
 
        config.credential_store_registry.register("stub", store, fallback=True)
1844
 
        conf = config.AuthenticationConfig(_file=StringIO())
1845
 
        creds = conf.get_credentials("http", "example.com")
1846
 
        self.assertEquals("joe", creds["user"])
1847
 
        self.assertEquals("secret", creds["password"])
1848
 
 
1849
 
 
1850
 
class StubCredentialStore(config.CredentialStore):
1851
 
 
1852
 
    def __init__(self):
1853
 
        self._username = {}
1854
 
        self._password = {}
1855
 
 
1856
 
    def add_credentials(self, scheme, host, user, password=None):
1857
 
        self._username[(scheme, host)] = user
1858
 
        self._password[(scheme, host)] = password
1859
 
 
1860
 
    def get_credentials(self, scheme, host, port=None, user=None,
1861
 
        path=None, realm=None):
1862
 
        key = (scheme, host)
1863
 
        if not key in self._username:
1864
 
            return None
1865
 
        return { "scheme": scheme, "host": host, "port": port,
1866
 
                "user": self._username[key], "password": self._password[key]}
1867
 
 
1868
 
 
1869
 
class CountingCredentialStore(config.CredentialStore):
1870
 
 
1871
 
    def __init__(self):
1872
 
        self._calls = 0
1873
 
 
1874
 
    def get_credentials(self, scheme, host, port=None, user=None,
1875
 
        path=None, realm=None):
1876
 
        self._calls += 1
1877
 
        return None
1878
 
 
1879
 
 
1880
 
class TestCredentialStoreRegistry(tests.TestCase):
1881
 
 
1882
 
    def _get_cs_registry(self):
1883
 
        return config.credential_store_registry
1884
 
 
1885
 
    def test_default_credential_store(self):
1886
 
        r = self._get_cs_registry()
1887
 
        default = r.get_credential_store(None)
1888
 
        self.assertIsInstance(default, config.PlainTextCredentialStore)
1889
 
 
1890
 
    def test_unknown_credential_store(self):
1891
 
        r = self._get_cs_registry()
1892
 
        # It's hard to imagine someone creating a credential store named
1893
 
        # 'unknown' so we use that as an never registered key.
1894
 
        self.assertRaises(KeyError, r.get_credential_store, 'unknown')
1895
 
 
1896
 
    def test_fallback_none_registered(self):
1897
 
        r = config.CredentialStoreRegistry()
1898
 
        self.assertEquals(None,
1899
 
                          r.get_fallback_credentials("http", "example.com"))
1900
 
 
1901
 
    def test_register(self):
1902
 
        r = config.CredentialStoreRegistry()
1903
 
        r.register("stub", StubCredentialStore(), fallback=False)
1904
 
        r.register("another", StubCredentialStore(), fallback=True)
1905
 
        self.assertEquals(["another", "stub"], r.keys())
1906
 
 
1907
 
    def test_register_lazy(self):
1908
 
        r = config.CredentialStoreRegistry()
1909
 
        r.register_lazy("stub", "bzrlib.tests.test_config",
1910
 
                        "StubCredentialStore", fallback=False)
1911
 
        self.assertEquals(["stub"], r.keys())
1912
 
        self.assertIsInstance(r.get_credential_store("stub"),
1913
 
                              StubCredentialStore)
1914
 
 
1915
 
    def test_is_fallback(self):
1916
 
        r = config.CredentialStoreRegistry()
1917
 
        r.register("stub1", None, fallback=False)
1918
 
        r.register("stub2", None, fallback=True)
1919
 
        self.assertEquals(False, r.is_fallback("stub1"))
1920
 
        self.assertEquals(True, r.is_fallback("stub2"))
1921
 
 
1922
 
    def test_no_fallback(self):
1923
 
        r = config.CredentialStoreRegistry()
1924
 
        store = CountingCredentialStore()
1925
 
        r.register("count", store, fallback=False)
1926
 
        self.assertEquals(None,
1927
 
                          r.get_fallback_credentials("http", "example.com"))
1928
 
        self.assertEquals(0, store._calls)
1929
 
 
1930
 
    def test_fallback_credentials(self):
1931
 
        r = config.CredentialStoreRegistry()
1932
 
        store = StubCredentialStore()
1933
 
        store.add_credentials("http", "example.com",
1934
 
                              "somebody", "geheim")
1935
 
        r.register("stub", store, fallback=True)
1936
 
        creds = r.get_fallback_credentials("http", "example.com")
1937
 
        self.assertEquals("somebody", creds["user"])
1938
 
        self.assertEquals("geheim", creds["password"])
1939
 
 
1940
 
    def test_fallback_first_wins(self):
1941
 
        r = config.CredentialStoreRegistry()
1942
 
        stub1 = StubCredentialStore()
1943
 
        stub1.add_credentials("http", "example.com",
1944
 
                              "somebody", "stub1")
1945
 
        r.register("stub1", stub1, fallback=True)
1946
 
        stub2 = StubCredentialStore()
1947
 
        stub2.add_credentials("http", "example.com",
1948
 
                              "somebody", "stub2")
1949
 
        r.register("stub2", stub1, fallback=True)
1950
 
        creds = r.get_fallback_credentials("http", "example.com")
1951
 
        self.assertEquals("somebody", creds["user"])
1952
 
        self.assertEquals("stub1", creds["password"])
1953
 
 
1954
 
 
1955
 
class TestPlainTextCredentialStore(tests.TestCase):
1956
 
 
1957
 
    def test_decode_password(self):
1958
 
        r = config.credential_store_registry
1959
 
        plain_text = r.get_credential_store()
1960
 
        decoded = plain_text.decode_password(dict(password='secret'))
1961
 
        self.assertEquals('secret', decoded)
1962
 
 
1963
1357
 
1964
1358
# FIXME: Once we have a way to declare authentication to all test servers, we
1965
1359
# can implement generic tests.