← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_config.py

  • Committer: Jelmer Vernooij
  • Date: 2009-05-27 08:33:37 UTC
  • mto: (4398.5.1 bencode_serializer)
  • mto: This revision was merged to the branch mainline in revision 4410.
  • Revision ID: jelmer@samba.org-20090527083337-fij2klthhtsdl2hy
Fix copyright headers, add _bencode_py.py to the list of files that do not have to have canonical copyright.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_config.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2008 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
17
18
"""Tests for finding and reading the bzr config file[s]."""
18
19
# import system imports here
19
20
from cStringIO import StringIO
 
21
import getpass
20
22
import os
21
23
import sys
22
24
 
25
27
    branch,
26
28
    bzrdir,
27
29
    config,
28
 
    diff,
29
30
    errors,
30
31
    osutils,
31
32
    mail_client,
43
44
[DEFAULT]
44
45
email=Erik B\u00e5gfors <erik@bagfors.nu>
45
46
editor=vim
46
 
change_editor=vimdiff -of @new_path @old_path
47
47
gpg_signing_command=gnome-gpg
48
48
log_format=short
49
49
user_global_option=something
210
210
        self._calls.append('_get_signature_checking')
211
211
        return self._signatures
212
212
 
213
 
    def _get_change_editor(self):
214
 
        self._calls.append('_get_change_editor')
215
 
        return 'vimdiff -fo @new_path @old_path'
216
 
 
217
213
 
218
214
bool_config = """[DEFAULT]
219
215
active = true
320
316
        my_config = config.Config()
321
317
        self.assertEqual('long', my_config.log_format())
322
318
 
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__)
328
 
        self.assertEqual(['vimdiff', '-fo', '@new_path', '@old_path'],
329
 
                         change_editor.command_template)
330
 
 
331
319
 
332
320
class TestConfigPath(tests.TestCase):
333
321
 
334
322
    def setUp(self):
335
323
        super(TestConfigPath, self).setUp()
336
324
        os.environ['HOME'] = '/home/bogus'
337
 
        os.environ['XDG_CACHE_DIR'] = ''
338
325
        if sys.platform == 'win32':
339
326
            os.environ['BZR_HOME'] = \
340
327
                r'C:\Documents and Settings\bogus\Application Data'
362
349
        self.assertEqual(config.authentication_config_filename(),
363
350
                         self.bzr_home + '/authentication.conf')
364
351
 
365
 
    def test_xdg_cache_dir(self):
366
 
        self.assertEqual(config.xdg_cache_dir(),
367
 
            '/home/bogus/.cache')
368
 
 
369
352
 
370
353
class TestIniConfig(tests.TestCase):
371
354
 
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
 
 
380
355
    def test_contructs(self):
381
356
        my_config = config.IniBasedConfig("nothing")
382
357
 
394
369
        self.failUnless(my_config._get_parser() is parser)
395
370
 
396
371
 
397
 
class TestGetUserOptionAs(TestIniConfig):
398
 
 
399
 
    def test_get_user_option_as_bool(self):
400
 
        conf, parser = self.make_config_parser("""
401
 
a_true_bool = true
402
 
a_false_bool = 0
403
 
an_invalid_bool = maybe
404
 
a_list = hmm, who knows ? # This is interpreted as a list !
405
 
""")
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'))
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"'
414
 
        self.assertIs(None, get_bool('an_invalid_bool'))
415
 
        self.assertEquals(msg % ('maybe', 'an_invalid_bool'), warnings[0])
416
 
        warnings = []
417
 
        self.assertIs(None, get_bool('not_defined_in_this_config'))
418
 
        self.assertEquals([], warnings)
419
 
 
420
 
    def test_get_user_option_as_list(self):
421
 
        conf, parser = self.make_config_parser("""
422
 
a_list = a,b,c
423
 
length_1 = 1,
424
 
one_item = x
425
 
""")
426
 
        get_list = conf.get_user_option_as_list
427
 
        self.assertEqual(['a', 'b', 'c'], get_list('a_list'))
428
 
        self.assertEqual(['1'], get_list('length_1'))
429
 
        self.assertEqual('x', conf.get_user_option('one_item'))
430
 
        # automatically cast to list
431
 
        self.assertEqual(['x'], get_list('one_item'))
432
 
 
433
 
 
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
 
 
451
372
class TestGetConfig(tests.TestCase):
452
373
 
453
374
    def test_constructs(self):
687
608
        my_config = self._get_sample_config()
688
609
        self.assertEqual(sample_long_alias, my_config.get_alias('ll'))
689
610
 
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__)
694
 
        self.assertEqual('vimdiff -of @new_path @old_path',
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
 
 
702
611
 
703
612
class TestGlobalConfigSavingOptions(tests.TestCaseInTempDir):
704
613
 
1552
1461
    """Test AuthenticationConfig behaviour"""
1553
1462
 
1554
1463
    def _check_default_password_prompt(self, expected_prompt_format, scheme,
1555
 
                                       host=None, port=None, realm=None,
1556
 
                                       path=None):
 
1464
                              host=None, port=None, realm=None, path=None):
1557
1465
        if host is None:
1558
1466
            host = 'bar.org'
1559
1467
        user, password = 'jim', 'precious'
1562
1470
            'user': user, 'realm': realm}
1563
1471
 
1564
1472
        stdout = tests.StringIOWrapper()
1565
 
        stderr = tests.StringIOWrapper()
1566
1473
        ui.ui_factory = tests.TestUIFactory(stdin=password + '\n',
1567
 
                                            stdout=stdout, stderr=stderr)
 
1474
                                            stdout=stdout)
1568
1475
        # We use an empty conf so that the user is always prompted
1569
1476
        conf = config.AuthenticationConfig()
1570
1477
        self.assertEquals(password,
1571
1478
                          conf.get_password(scheme, host, user, port=port,
1572
1479
                                            realm=realm, path=path))
1573
 
        self.assertEquals(expected_prompt, stderr.getvalue())
1574
 
        self.assertEquals('', stdout.getvalue())
 
1480
        self.assertEquals(stdout.getvalue(), expected_prompt)
1575
1481
 
1576
1482
    def _check_default_username_prompt(self, expected_prompt_format, scheme,
1577
 
                                       host=None, port=None, realm=None,
1578
 
                                       path=None):
 
1483
                              host=None, port=None, realm=None, path=None):
1579
1484
        if host is None:
1580
1485
            host = 'bar.org'
1581
1486
        username = 'jim'
1583
1488
            'scheme': scheme, 'host': host, 'port': port,
1584
1489
            'realm': realm}
1585
1490
        stdout = tests.StringIOWrapper()
1586
 
        stderr = tests.StringIOWrapper()
1587
1491
        ui.ui_factory = tests.TestUIFactory(stdin=username+ '\n',
1588
 
                                            stdout=stdout, stderr=stderr)
 
1492
                                            stdout=stdout)
1589
1493
        # We use an empty conf so that the user is always prompted
1590
1494
        conf = config.AuthenticationConfig()
1591
1495
        self.assertEquals(username, conf.get_user(scheme, host, port=port,
1592
1496
                          realm=realm, path=path, ask=True))
1593
 
        self.assertEquals(expected_prompt, stderr.getvalue())
1594
 
        self.assertEquals('', stdout.getvalue())
 
1497
        self.assertEquals(stdout.getvalue(), expected_prompt)
1595
1498
 
1596
1499
    def test_username_defaults_prompts(self):
1597
1500
        # HTTP prompts can't be tested here, see test_http.py
1639
1542
"""))
1640
1543
        entered_password = 'typed-by-hand'
1641
1544
        stdout = tests.StringIOWrapper()
1642
 
        stderr = tests.StringIOWrapper()
1643
1545
        ui.ui_factory = tests.TestUIFactory(stdin=entered_password + '\n',
1644
 
                                            stdout=stdout, stderr=stderr)
 
1546
                                            stdout=stdout)
1645
1547
 
1646
1548
        # Since the password defined in the authentication config is ignored,
1647
1549
        # the user is prompted
1648
1550
        self.assertEquals(entered_password,
1649
1551
                          conf.get_password('ssh', 'bar.org', user='jim'))
1650
1552
        self.assertContainsRe(
1651
 
            self.get_log(),
 
1553
            self._get_log(keep_log_file=True),
1652
1554
            'password ignored in section \[ssh with password\]')
1653
1555
 
1654
1556
    def test_ssh_without_password_doesnt_emit_warning(self):
1661
1563
"""))
1662
1564
        entered_password = 'typed-by-hand'
1663
1565
        stdout = tests.StringIOWrapper()
1664
 
        stderr = tests.StringIOWrapper()
1665
1566
        ui.ui_factory = tests.TestUIFactory(stdin=entered_password + '\n',
1666
 
                                            stdout=stdout,
1667
 
                                            stderr=stderr)
 
1567
                                            stdout=stdout)
1668
1568
 
1669
1569
        # Since the password defined in the authentication config is ignored,
1670
1570
        # the user is prompted
1673
1573
        # No warning shoud be emitted since there is no password. We are only
1674
1574
        # providing "user".
1675
1575
        self.assertNotContainsRe(
1676
 
            self.get_log(),
 
1576
            self._get_log(keep_log_file=True),
1677
1577
            'password ignored in section \[ssh with password\]')
1678
1578
 
1679
1579
    def test_uses_fallback_stores(self):
1680
 
        self.overrideAttr(config, 'credential_store_registry',
1681
 
                          config.CredentialStoreRegistry())
 
1580
        self._old_cs_registry = config.credential_store_registry
 
1581
        def restore():
 
1582
            config.credential_store_registry = self._old_cs_registry
 
1583
        self.addCleanup(restore)
 
1584
        config.credential_store_registry = config.CredentialStoreRegistry()
1682
1585
        store = StubCredentialStore()
1683
1586
        store.add_credentials("http", "example.com", "joe", "secret")
1684
1587
        config.credential_store_registry.register("stub", store, fallback=True)