← 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: Aaron Bentley
  • Date: 2007-02-06 14:52:16 UTC
  • mfrom: (2266 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2268.
  • Revision ID: abentley@panoramicfeedback.com-20070206145216-fcpi8o3ufvuzwbp9
Merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_config.py
17
17
 
18
18
"""Tests for finding and reading the bzr config file[s]."""
19
19
# import system imports here
 
20
from bzrlib.util.configobj.configobj import ConfigObj, ConfigObjError
20
21
from cStringIO import StringIO
21
22
import os
22
23
import sys
23
24
 
24
25
#import bzrlib specific imports here
25
26
from bzrlib import (
26
 
    branch,
27
 
    bzrdir,
28
27
    config,
29
28
    errors,
30
29
    osutils,
31
 
    mail_client,
32
 
    ui,
33
30
    urlutils,
34
 
    tests,
35
 
    trace,
36
 
    transport,
37
31
    )
38
 
from bzrlib.util.configobj import configobj
 
32
from bzrlib.branch import Branch
 
33
from bzrlib.bzrdir import BzrDir
 
34
from bzrlib.tests import TestCase, TestCaseInTempDir, TestCaseWithTransport
39
35
 
40
36
 
41
37
sample_long_alias="log -r-15..-1 --line"
147
143
            self.base = "http://example.com/branches/demo"
148
144
        else:
149
145
            self.base = base
150
 
        self._transport = self.control_files = \
151
 
            FakeControlFilesAndTransport(user_id=user_id)
 
146
        self.control_files = FakeControlFiles(user_id=user_id)
152
147
 
153
148
    def lock_write(self):
154
149
        pass
157
152
        pass
158
153
 
159
154
 
160
 
class FakeControlFilesAndTransport(object):
 
155
class FakeControlFiles(object):
161
156
 
162
157
    def __init__(self, user_id=None):
 
158
        self.email = user_id
163
159
        self.files = {}
164
 
        if user_id:
165
 
            self.files['email'] = user_id
166
 
        self._transport = self
167
160
 
168
161
    def get_utf8(self, filename):
169
 
        # from LockableFiles
170
 
        raise AssertionError("get_utf8 should no longer be used")
 
162
        if filename != 'email':
 
163
            raise NotImplementedError
 
164
        if self.email is not None:
 
165
            return StringIO(self.email)
 
166
        raise errors.NoSuchFile(filename)
171
167
 
172
168
    def get(self, filename):
173
 
        # from Transport
174
169
        try:
175
170
            return StringIO(self.files[filename])
176
171
        except KeyError:
177
172
            raise errors.NoSuchFile(filename)
178
173
 
179
 
    def get_bytes(self, filename):
180
 
        # from Transport
181
 
        try:
182
 
            return self.files[filename]
183
 
        except KeyError:
184
 
            raise errors.NoSuchFile(filename)
185
 
 
186
174
    def put(self, filename, fileobj):
187
175
        self.files[filename] = fileobj.read()
188
176
 
189
 
    def put_file(self, filename, fileobj):
190
 
        return self.put(filename, fileobj)
191
 
 
192
177
 
193
178
class InstrumentedConfig(config.Config):
194
179
    """An instrumented config that supplies stubs for template methods."""
195
 
 
 
180
    
196
181
    def __init__(self):
197
182
        super(InstrumentedConfig, self).__init__()
198
183
        self._calls = []
214
199
active = True
215
200
nonactive = False
216
201
"""
217
 
 
218
 
 
219
 
class TestConfigObj(tests.TestCase):
220
 
 
 
202
class TestConfigObj(TestCase):
221
203
    def test_get_bool(self):
222
 
        co = config.ConfigObj(StringIO(bool_config))
 
204
        from bzrlib.config import ConfigObj
 
205
        co = ConfigObj(StringIO(bool_config))
223
206
        self.assertIs(co.get_bool('DEFAULT', 'active'), True)
224
207
        self.assertIs(co.get_bool('DEFAULT', 'inactive'), False)
225
208
        self.assertIs(co.get_bool('UPPERCASE', 'active'), True)
226
209
        self.assertIs(co.get_bool('UPPERCASE', 'nonactive'), False)
227
210
 
228
 
    def test_hash_sign_in_value(self):
229
 
        """
230
 
        Before 4.5.0, ConfigObj did not quote # signs in values, so they'd be
231
 
        treated as comments when read in again. (#86838)
232
 
        """
233
 
        co = config.ConfigObj()
234
 
        co['test'] = 'foo#bar'
235
 
        lines = co.write()
236
 
        self.assertEqual(lines, ['test = "foo#bar"'])
237
 
        co2 = config.ConfigObj(lines)
238
 
        self.assertEqual(co2['test'], 'foo#bar')
239
 
 
240
 
 
241
 
erroneous_config = """[section] # line 1
242
 
good=good # line 2
243
 
[section] # line 3
244
 
whocares=notme # line 4
245
 
"""
246
 
 
247
 
 
248
 
class TestConfigObjErrors(tests.TestCase):
249
 
 
250
 
    def test_duplicate_section_name_error_line(self):
251
 
        try:
252
 
            co = configobj.ConfigObj(StringIO(erroneous_config),
253
 
                                     raise_errors=True)
254
 
        except config.configobj.DuplicateError, e:
255
 
            self.assertEqual(3, e.line_number)
256
 
        else:
257
 
            self.fail('Error in config file not detected')
258
 
 
259
 
 
260
 
class TestConfig(tests.TestCase):
 
211
 
 
212
class TestConfig(TestCase):
261
213
 
262
214
    def test_constructs(self):
263
215
        config.Config()
264
 
 
 
216
 
265
217
    def test_no_default_editor(self):
266
218
        self.assertRaises(NotImplementedError, config.Config().get_editor)
267
219
 
313
265
        self.assertEqual('long', my_config.log_format())
314
266
 
315
267
 
316
 
class TestConfigPath(tests.TestCase):
 
268
class TestConfigPath(TestCase):
317
269
 
318
270
    def setUp(self):
319
271
        super(TestConfigPath, self).setUp()
 
272
        self.old_home = os.environ.get('HOME', None)
 
273
        self.old_appdata = os.environ.get('APPDATA', None)
320
274
        os.environ['HOME'] = '/home/bogus'
321
 
        if sys.platform == 'win32':
322
 
            os.environ['BZR_HOME'] = \
323
 
                r'C:\Documents and Settings\bogus\Application Data'
324
 
            self.bzr_home = \
325
 
                'C:/Documents and Settings/bogus/Application Data/bazaar/2.0'
326
 
        else:
327
 
            self.bzr_home = '/home/bogus/.bazaar'
 
275
        os.environ['APPDATA'] = \
 
276
            r'C:\Documents and Settings\bogus\Application Data'
328
277
 
 
278
    def tearDown(self):
 
279
        if self.old_home is None:
 
280
            del os.environ['HOME']
 
281
        else:
 
282
            os.environ['HOME'] = self.old_home
 
283
        if self.old_appdata is None:
 
284
            del os.environ['APPDATA']
 
285
        else:
 
286
            os.environ['APPDATA'] = self.old_appdata
 
287
        super(TestConfigPath, self).tearDown()
 
288
    
329
289
    def test_config_dir(self):
330
 
        self.assertEqual(config.config_dir(), self.bzr_home)
 
290
        if sys.platform == 'win32':
 
291
            self.assertEqual(config.config_dir(), 
 
292
                'C:/Documents and Settings/bogus/Application Data/bazaar/2.0')
 
293
        else:
 
294
            self.assertEqual(config.config_dir(), '/home/bogus/.bazaar')
331
295
 
332
296
    def test_config_filename(self):
333
 
        self.assertEqual(config.config_filename(),
334
 
                         self.bzr_home + '/bazaar.conf')
 
297
        if sys.platform == 'win32':
 
298
            self.assertEqual(config.config_filename(), 
 
299
                'C:/Documents and Settings/bogus/Application Data/bazaar/2.0/bazaar.conf')
 
300
        else:
 
301
            self.assertEqual(config.config_filename(),
 
302
                             '/home/bogus/.bazaar/bazaar.conf')
335
303
 
336
304
    def test_branches_config_filename(self):
337
 
        self.assertEqual(config.branches_config_filename(),
338
 
                         self.bzr_home + '/branches.conf')
 
305
        if sys.platform == 'win32':
 
306
            self.assertEqual(config.branches_config_filename(), 
 
307
                'C:/Documents and Settings/bogus/Application Data/bazaar/2.0/branches.conf')
 
308
        else:
 
309
            self.assertEqual(config.branches_config_filename(),
 
310
                             '/home/bogus/.bazaar/branches.conf')
339
311
 
340
312
    def test_locations_config_filename(self):
341
 
        self.assertEqual(config.locations_config_filename(),
342
 
                         self.bzr_home + '/locations.conf')
343
 
 
344
 
    def test_authentication_config_filename(self):
345
 
        self.assertEqual(config.authentication_config_filename(),
346
 
                         self.bzr_home + '/authentication.conf')
347
 
 
348
 
 
349
 
class TestIniConfig(tests.TestCase):
 
313
        if sys.platform == 'win32':
 
314
            self.assertEqual(config.locations_config_filename(), 
 
315
                'C:/Documents and Settings/bogus/Application Data/bazaar/2.0/locations.conf')
 
316
        else:
 
317
            self.assertEqual(config.locations_config_filename(),
 
318
                             '/home/bogus/.bazaar/locations.conf')
 
319
 
 
320
class TestIniConfig(TestCase):
350
321
 
351
322
    def test_contructs(self):
352
323
        my_config = config.IniBasedConfig("nothing")
356
327
        my_config = config.IniBasedConfig(None)
357
328
        self.failUnless(
358
329
            isinstance(my_config._get_parser(file=config_file),
359
 
                        configobj.ConfigObj))
 
330
                        ConfigObj))
360
331
 
361
332
    def test_cached(self):
362
333
        config_file = StringIO(sample_config_text.encode('utf-8'))
365
336
        self.failUnless(my_config._get_parser() is parser)
366
337
 
367
338
 
368
 
class TestGetConfig(tests.TestCase):
 
339
class TestGetConfig(TestCase):
369
340
 
370
341
    def test_constructs(self):
371
342
        my_config = config.GlobalConfig()
372
343
 
373
344
    def test_calls_read_filenames(self):
374
 
        # replace the class that is constructed, to check its parameters
 
345
        # replace the class that is constructured, to check its parameters
375
346
        oldparserclass = config.ConfigObj
376
347
        config.ConfigObj = InstrumentedConfigObj
377
348
        my_config = config.GlobalConfig()
384
355
                                          'utf-8')])
385
356
 
386
357
 
387
 
class TestBranchConfig(tests.TestCaseWithTransport):
 
358
class TestBranchConfig(TestCaseWithTransport):
388
359
 
389
360
    def test_constructs(self):
390
361
        branch = FakeBranch()
400
371
 
401
372
    def test_get_config(self):
402
373
        """The Branch.get_config method works properly"""
403
 
        b = bzrdir.BzrDir.create_standalone_workingtree('.').branch
 
374
        b = BzrDir.create_standalone_workingtree('.').branch
404
375
        my_config = b.get_config()
405
376
        self.assertIs(my_config.get_user_option('wacky'), None)
406
377
        my_config.set_user_option('wacky', 'unlikely')
407
378
        self.assertEqual(my_config.get_user_option('wacky'), 'unlikely')
408
379
 
409
380
        # Ensure we get the same thing if we start again
410
 
        b2 = branch.Branch.open('.')
 
381
        b2 = Branch.open('.')
411
382
        my_config2 = b2.get_config()
412
383
        self.assertEqual(my_config2.get_user_option('wacky'), 'unlikely')
413
384
 
442
413
 
443
414
    def test_config_creates_local(self):
444
415
        """Creating a new entry in config uses a local path."""
445
 
        branch = self.make_branch('branch', format='knit')
 
416
        branch = self.make_branch('branch')
446
417
        branch.set_push_location('http://foobar')
447
418
        locations = config.locations_config_filename()
448
419
        local_path = osutils.getcwd().encode('utf8')
449
420
        # Surprisingly ConfigObj doesn't create a trailing newline
450
421
        self.check_file_contents(locations,
451
 
                                 '[%s/branch]\n'
452
 
                                 'push_location = http://foobar\n'
453
 
                                 'push_location:policy = norecurse\n'
454
 
                                 % (local_path,))
 
422
            '[%s/branch]\npush_location = http://foobar\npush_location:policy = norecurse' % (local_path,))
455
423
 
456
424
    def test_autonick_urlencoded(self):
457
425
        b = self.make_branch('!repo')
458
426
        self.assertEqual('!repo', b.get_config().get_nickname())
459
427
 
460
 
    def test_warn_if_masked(self):
461
 
        _warning = trace.warning
462
 
        warnings = []
463
 
        def warning(*args):
464
 
            warnings.append(args[0] % args[1:])
465
 
 
466
 
        def set_option(store, warn_masked=True):
467
 
            warnings[:] = []
468
 
            conf.set_user_option('example_option', repr(store), store=store,
469
 
                                 warn_masked=warn_masked)
470
 
        def assertWarning(warning):
471
 
            if warning is None:
472
 
                self.assertEqual(0, len(warnings))
473
 
            else:
474
 
                self.assertEqual(1, len(warnings))
475
 
                self.assertEqual(warning, warnings[0])
476
 
        trace.warning = warning
477
 
        try:
478
 
            branch = self.make_branch('.')
479
 
            conf = branch.get_config()
480
 
            set_option(config.STORE_GLOBAL)
481
 
            assertWarning(None)
482
 
            set_option(config.STORE_BRANCH)
483
 
            assertWarning(None)
484
 
            set_option(config.STORE_GLOBAL)
485
 
            assertWarning('Value "4" is masked by "3" from branch.conf')
486
 
            set_option(config.STORE_GLOBAL, warn_masked=False)
487
 
            assertWarning(None)
488
 
            set_option(config.STORE_LOCATION)
489
 
            assertWarning(None)
490
 
            set_option(config.STORE_BRANCH)
491
 
            assertWarning('Value "3" is masked by "0" from locations.conf')
492
 
            set_option(config.STORE_BRANCH, warn_masked=False)
493
 
            assertWarning(None)
494
 
        finally:
495
 
            trace.warning = _warning
496
 
 
497
 
 
498
 
class TestGlobalConfigItems(tests.TestCase):
 
428
 
 
429
class TestGlobalConfigItems(TestCase):
499
430
 
500
431
    def test_user_id(self):
501
432
        config_file = StringIO(sample_config_text.encode('utf-8'))
575
506
        my_config = self._get_sample_config()
576
507
        self.assertEqual("something",
577
508
                         my_config.get_user_option('user_global_option'))
578
 
 
 
509
        
579
510
    def test_post_commit_default(self):
580
511
        my_config = self._get_sample_config()
581
512
        self.assertEqual(None, my_config.post_commit())
588
519
        my_config = self._get_sample_config()
589
520
        self.assertEqual('help', my_config.get_alias('h'))
590
521
 
591
 
    def test_get_aliases(self):
592
 
        my_config = self._get_sample_config()
593
 
        aliases = my_config.get_aliases()
594
 
        self.assertEqual(2, len(aliases))
595
 
        sorted_keys = sorted(aliases)
596
 
        self.assertEqual('help', aliases[sorted_keys[0]])
597
 
        self.assertEqual(sample_long_alias, aliases[sorted_keys[1]])
598
 
 
599
522
    def test_get_no_alias(self):
600
523
        my_config = self._get_sample_config()
601
524
        self.assertEqual(None, my_config.get_alias('foo'))
605
528
        self.assertEqual(sample_long_alias, my_config.get_alias('ll'))
606
529
 
607
530
 
608
 
class TestGlobalConfigSavingOptions(tests.TestCaseInTempDir):
609
 
 
610
 
    def test_empty(self):
611
 
        my_config = config.GlobalConfig()
612
 
        self.assertEqual(0, len(my_config.get_aliases()))
613
 
 
614
 
    def test_set_alias(self):
615
 
        my_config = config.GlobalConfig()
616
 
        alias_value = 'commit --strict'
617
 
        my_config.set_alias('commit', alias_value)
618
 
        new_config = config.GlobalConfig()
619
 
        self.assertEqual(alias_value, new_config.get_alias('commit'))
620
 
 
621
 
    def test_remove_alias(self):
622
 
        my_config = config.GlobalConfig()
623
 
        my_config.set_alias('commit', 'commit --strict')
624
 
        # Now remove the alias again.
625
 
        my_config.unset_alias('commit')
626
 
        new_config = config.GlobalConfig()
627
 
        self.assertIs(None, new_config.get_alias('commit'))
628
 
 
629
 
 
630
 
class TestLocationConfig(tests.TestCaseInTempDir):
 
531
class TestLocationConfig(TestCaseInTempDir):
631
532
 
632
533
    def test_constructs(self):
633
534
        my_config = config.LocationConfig('http://example.com')
637
538
        # This is testing the correct file names are provided.
638
539
        # TODO: consolidate with the test for GlobalConfigs filename checks.
639
540
        #
640
 
        # replace the class that is constructed, to check its parameters
 
541
        # replace the class that is constructured, to check its parameters
641
542
        oldparserclass = config.ConfigObj
642
543
        config.ConfigObj = InstrumentedConfigObj
643
544
        try:
671
572
    def test__get_matching_sections_no_match(self):
672
573
        self.get_branch_config('/')
673
574
        self.assertEqual([], self.my_location_config._get_matching_sections())
674
 
 
 
575
        
675
576
    def test__get_matching_sections_exact(self):
676
577
        self.get_branch_config('http://www.example.com')
677
578
        self.assertEqual([('http://www.example.com', '')],
678
579
                         self.my_location_config._get_matching_sections())
679
 
 
 
580
   
680
581
    def test__get_matching_sections_suffix_does_not(self):
681
582
        self.get_branch_config('http://www.example.com-com')
682
583
        self.assertEqual([], self.my_location_config._get_matching_sections())
694
595
    def test__get_matching_sections_ignoreparent_subdir(self):
695
596
        self.get_branch_config(
696
597
            'http://www.example.com/ignoreparent/childbranch')
697
 
        self.assertEqual([('http://www.example.com/ignoreparent',
698
 
                           'childbranch')],
 
598
        self.assertEqual([('http://www.example.com/ignoreparent', 'childbranch')],
699
599
                         self.my_location_config._get_matching_sections())
700
600
 
701
601
    def test__get_matching_sections_subdir_trailing_slash(self):
781
681
        self.get_branch_config('/a/c')
782
682
        self.assertEqual(config.CHECK_NEVER,
783
683
                         self.my_config.signature_checking())
784
 
 
 
684
        
785
685
    def test_signatures_when_available(self):
786
686
        self.get_branch_config('/a/', global_config=sample_ignore_signatures)
787
687
        self.assertEqual(config.CHECK_IF_POSSIBLE,
788
688
                         self.my_config.signature_checking())
789
 
 
 
689
        
790
690
    def test_signatures_always(self):
791
691
        self.get_branch_config('/b')
792
692
        self.assertEqual(config.CHECK_ALWAYS,
793
693
                         self.my_config.signature_checking())
794
 
 
 
694
        
795
695
    def test_gpg_signing_command(self):
796
696
        self.get_branch_config('/b')
797
697
        self.assertEqual("gnome-gpg", self.my_config.gpg_signing_command())
888
788
            self.my_location_config._get_option_policy(
889
789
            'http://www.example.com/norecurse', 'normal_option'),
890
790
            config.POLICY_NORECURSE)
 
791
        
891
792
 
892
793
    def test_post_commit_default(self):
893
794
        self.get_branch_config('/a/c')
951
852
        self.assertIs(self.my_config.get_user_option('foo'), None)
952
853
        self.my_config.set_user_option('foo', 'bar')
953
854
        self.assertEqual(
954
 
            self.my_config.branch.control_files.files['branch.conf'],
955
 
            'foo = bar\n')
 
855
            self.my_config.branch.control_files.files['branch.conf'], 
 
856
            'foo = bar')
956
857
        self.assertEqual(self.my_config.get_user_option('foo'), 'bar')
957
858
        self.my_config.set_user_option('foo', 'baz',
958
859
                                       store=config.STORE_LOCATION)
959
860
        self.assertEqual(self.my_config.get_user_option('foo'), 'baz')
960
861
        self.my_config.set_user_option('foo', 'qux')
961
862
        self.assertEqual(self.my_config.get_user_option('foo'), 'baz')
962
 
 
963
 
    def test_get_bzr_remote_path(self):
964
 
        my_config = config.LocationConfig('/a/c')
965
 
        self.assertEqual('bzr', my_config.get_bzr_remote_path())
966
 
        my_config.set_user_option('bzr_remote_path', '/path-bzr')
967
 
        self.assertEqual('/path-bzr', my_config.get_bzr_remote_path())
968
 
        os.environ['BZR_REMOTE_PATH'] = '/environ-bzr'
969
 
        self.assertEqual('/environ-bzr', my_config.get_bzr_remote_path())
970
 
 
 
863
        
971
864
 
972
865
precedence_global = 'option = global'
973
866
precedence_branch = 'option = branch'
980
873
"""
981
874
 
982
875
 
983
 
class TestBranchConfigItems(tests.TestCaseInTempDir):
 
876
class TestBranchConfigItems(TestCaseInTempDir):
984
877
 
985
 
    def get_branch_config(self, global_config=None, location=None,
 
878
    def get_branch_config(self, global_config=None, location=None, 
986
879
                          location_config=None, branch_data_config=None):
987
880
        my_config = config.BranchConfig(FakeBranch(location))
988
881
        if global_config is not None:
1002
895
        my_config = config.BranchConfig(branch)
1003
896
        self.assertEqual("Robert Collins <robertc@example.net>",
1004
897
                         my_config.username())
1005
 
        my_config.branch.control_files.files['email'] = "John"
1006
 
        my_config.set_user_option('email',
 
898
        branch.control_files.email = "John"
 
899
        my_config.set_user_option('email', 
1007
900
                                  "Robert Collins <robertc@example.org>")
1008
901
        self.assertEqual("John", my_config.username())
1009
 
        del my_config.branch.control_files.files['email']
 
902
        branch.control_files.email = None
1010
903
        self.assertEqual("Robert Collins <robertc@example.org>",
1011
904
                         my_config.username())
1012
905
 
1013
906
    def test_not_set_in_branch(self):
1014
907
        my_config = self.get_branch_config(sample_config_text)
 
908
        my_config.branch.control_files.email = None
1015
909
        self.assertEqual(u"Erik B\u00e5gfors <erik@bagfors.nu>",
1016
910
                         my_config._get_user_id())
1017
 
        my_config.branch.control_files.files['email'] = "John"
 
911
        my_config.branch.control_files.email = "John"
1018
912
        self.assertEqual("John", my_config._get_user_id())
1019
913
 
1020
914
    def test_BZR_EMAIL_OVERRIDES(self):
1023
917
        my_config = config.BranchConfig(branch)
1024
918
        self.assertEqual("Robert Collins <robertc@example.org>",
1025
919
                         my_config.username())
1026
 
 
 
920
    
1027
921
    def test_signatures_forced(self):
1028
922
        my_config = self.get_branch_config(
1029
923
            global_config=sample_always_signatures)
1073
967
    def test_config_precedence(self):
1074
968
        my_config = self.get_branch_config(global_config=precedence_global)
1075
969
        self.assertEqual(my_config.get_user_option('option'), 'global')
1076
 
        my_config = self.get_branch_config(global_config=precedence_global,
 
970
        my_config = self.get_branch_config(global_config=precedence_global, 
1077
971
                                      branch_data_config=precedence_branch)
1078
972
        self.assertEqual(my_config.get_user_option('option'), 'branch')
1079
 
        my_config = self.get_branch_config(global_config=precedence_global,
 
973
        my_config = self.get_branch_config(global_config=precedence_global, 
1080
974
                                      branch_data_config=precedence_branch,
1081
975
                                      location_config=precedence_location)
1082
976
        self.assertEqual(my_config.get_user_option('option'), 'recurse')
1083
 
        my_config = self.get_branch_config(global_config=precedence_global,
 
977
        my_config = self.get_branch_config(global_config=precedence_global, 
1084
978
                                      branch_data_config=precedence_branch,
1085
979
                                      location_config=precedence_location,
1086
980
                                      location='http://example.com/specific')
1087
981
        self.assertEqual(my_config.get_user_option('option'), 'exact')
1088
982
 
1089
 
    def test_get_mail_client(self):
1090
 
        config = self.get_branch_config()
1091
 
        client = config.get_mail_client()
1092
 
        self.assertIsInstance(client, mail_client.DefaultMail)
1093
 
 
1094
 
        # Specific clients
1095
 
        config.set_user_option('mail_client', 'evolution')
1096
 
        client = config.get_mail_client()
1097
 
        self.assertIsInstance(client, mail_client.Evolution)
1098
 
 
1099
 
        config.set_user_option('mail_client', 'kmail')
1100
 
        client = config.get_mail_client()
1101
 
        self.assertIsInstance(client, mail_client.KMail)
1102
 
 
1103
 
        config.set_user_option('mail_client', 'mutt')
1104
 
        client = config.get_mail_client()
1105
 
        self.assertIsInstance(client, mail_client.Mutt)
1106
 
 
1107
 
        config.set_user_option('mail_client', 'thunderbird')
1108
 
        client = config.get_mail_client()
1109
 
        self.assertIsInstance(client, mail_client.Thunderbird)
1110
 
 
1111
 
        # Generic options
1112
 
        config.set_user_option('mail_client', 'default')
1113
 
        client = config.get_mail_client()
1114
 
        self.assertIsInstance(client, mail_client.DefaultMail)
1115
 
 
1116
 
        config.set_user_option('mail_client', 'editor')
1117
 
        client = config.get_mail_client()
1118
 
        self.assertIsInstance(client, mail_client.Editor)
1119
 
 
1120
 
        config.set_user_option('mail_client', 'mapi')
1121
 
        client = config.get_mail_client()
1122
 
        self.assertIsInstance(client, mail_client.MAPIClient)
1123
 
 
1124
 
        config.set_user_option('mail_client', 'xdg-email')
1125
 
        client = config.get_mail_client()
1126
 
        self.assertIsInstance(client, mail_client.XDGEmail)
1127
 
 
1128
 
        config.set_user_option('mail_client', 'firebird')
1129
 
        self.assertRaises(errors.UnknownMailClient, config.get_mail_client)
1130
 
 
1131
 
 
1132
 
class TestMailAddressExtraction(tests.TestCase):
 
983
 
 
984
class TestMailAddressExtraction(TestCase):
1133
985
 
1134
986
    def test_extract_email_address(self):
1135
987
        self.assertEqual('jane@test.com',
1136
988
                         config.extract_email_address('Jane <jane@test.com>'))
1137
989
        self.assertRaises(errors.NoEmailInUsername,
1138
990
                          config.extract_email_address, 'Jane Tester')
1139
 
 
1140
 
    def test_parse_username(self):
1141
 
        self.assertEqual(('', 'jdoe@example.com'),
1142
 
                         config.parse_username('jdoe@example.com'))
1143
 
        self.assertEqual(('', 'jdoe@example.com'),
1144
 
                         config.parse_username('<jdoe@example.com>'))
1145
 
        self.assertEqual(('John Doe', 'jdoe@example.com'),
1146
 
                         config.parse_username('John Doe <jdoe@example.com>'))
1147
 
        self.assertEqual(('John Doe', ''),
1148
 
                         config.parse_username('John Doe'))
1149
 
        self.assertEqual(('John Doe', 'jdoe@example.com'),
1150
 
                         config.parse_username('John Doe jdoe@example.com'))
1151
 
 
1152
 
class TestTreeConfig(tests.TestCaseWithTransport):
1153
 
 
1154
 
    def test_get_value(self):
1155
 
        """Test that retreiving a value from a section is possible"""
1156
 
        branch = self.make_branch('.')
1157
 
        tree_config = config.TreeConfig(branch)
1158
 
        tree_config.set_option('value', 'key', 'SECTION')
1159
 
        tree_config.set_option('value2', 'key2')
1160
 
        tree_config.set_option('value3-top', 'key3')
1161
 
        tree_config.set_option('value3-section', 'key3', 'SECTION')
1162
 
        value = tree_config.get_option('key', 'SECTION')
1163
 
        self.assertEqual(value, 'value')
1164
 
        value = tree_config.get_option('key2')
1165
 
        self.assertEqual(value, 'value2')
1166
 
        self.assertEqual(tree_config.get_option('non-existant'), None)
1167
 
        value = tree_config.get_option('non-existant', 'SECTION')
1168
 
        self.assertEqual(value, None)
1169
 
        value = tree_config.get_option('non-existant', default='default')
1170
 
        self.assertEqual(value, 'default')
1171
 
        self.assertEqual(tree_config.get_option('key2', 'NOSECTION'), None)
1172
 
        value = tree_config.get_option('key2', 'NOSECTION', default='default')
1173
 
        self.assertEqual(value, 'default')
1174
 
        value = tree_config.get_option('key3')
1175
 
        self.assertEqual(value, 'value3-top')
1176
 
        value = tree_config.get_option('key3', 'SECTION')
1177
 
        self.assertEqual(value, 'value3-section')
1178
 
 
1179
 
 
1180
 
class TestTransportConfig(tests.TestCaseWithTransport):
1181
 
 
1182
 
    def test_get_value(self):
1183
 
        """Test that retreiving a value from a section is possible"""
1184
 
        bzrdir_config = config.TransportConfig(transport.get_transport('.'),
1185
 
                                               'control.conf')
1186
 
        bzrdir_config.set_option('value', 'key', 'SECTION')
1187
 
        bzrdir_config.set_option('value2', 'key2')
1188
 
        bzrdir_config.set_option('value3-top', 'key3')
1189
 
        bzrdir_config.set_option('value3-section', 'key3', 'SECTION')
1190
 
        value = bzrdir_config.get_option('key', 'SECTION')
1191
 
        self.assertEqual(value, 'value')
1192
 
        value = bzrdir_config.get_option('key2')
1193
 
        self.assertEqual(value, 'value2')
1194
 
        self.assertEqual(bzrdir_config.get_option('non-existant'), None)
1195
 
        value = bzrdir_config.get_option('non-existant', 'SECTION')
1196
 
        self.assertEqual(value, None)
1197
 
        value = bzrdir_config.get_option('non-existant', default='default')
1198
 
        self.assertEqual(value, 'default')
1199
 
        self.assertEqual(bzrdir_config.get_option('key2', 'NOSECTION'), None)
1200
 
        value = bzrdir_config.get_option('key2', 'NOSECTION',
1201
 
                                         default='default')
1202
 
        self.assertEqual(value, 'default')
1203
 
        value = bzrdir_config.get_option('key3')
1204
 
        self.assertEqual(value, 'value3-top')
1205
 
        value = bzrdir_config.get_option('key3', 'SECTION')
1206
 
        self.assertEqual(value, 'value3-section')
1207
 
 
1208
 
    def test_set_unset_default_stack_on(self):
1209
 
        my_dir = self.make_bzrdir('.')
1210
 
        bzrdir_config = config.BzrDirConfig(my_dir.transport)
1211
 
        self.assertIs(None, bzrdir_config.get_default_stack_on())
1212
 
        bzrdir_config.set_default_stack_on('Foo')
1213
 
        self.assertEqual('Foo', bzrdir_config._config.get_option(
1214
 
                         'default_stack_on'))
1215
 
        self.assertEqual('Foo', bzrdir_config.get_default_stack_on())
1216
 
        bzrdir_config.set_default_stack_on(None)
1217
 
        self.assertIs(None, bzrdir_config.get_default_stack_on())
1218
 
 
1219
 
 
1220
 
class TestAuthenticationConfigFile(tests.TestCase):
1221
 
    """Test the authentication.conf file matching"""
1222
 
 
1223
 
    def _got_user_passwd(self, expected_user, expected_password,
1224
 
                         config, *args, **kwargs):
1225
 
        credentials = config.get_credentials(*args, **kwargs)
1226
 
        if credentials is None:
1227
 
            user = None
1228
 
            password = None
1229
 
        else:
1230
 
            user = credentials['user']
1231
 
            password = credentials['password']
1232
 
        self.assertEquals(expected_user, user)
1233
 
        self.assertEquals(expected_password, password)
1234
 
 
1235
 
    def test_empty_config(self):
1236
 
        conf = config.AuthenticationConfig(_file=StringIO())
1237
 
        self.assertEquals({}, conf._get_config())
1238
 
        self._got_user_passwd(None, None, conf, 'http', 'foo.net')
1239
 
 
1240
 
    def test_missing_auth_section_header(self):
1241
 
        conf = config.AuthenticationConfig(_file=StringIO('foo = bar'))
1242
 
        self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
1243
 
 
1244
 
    def test_auth_section_header_not_closed(self):
1245
 
        conf = config.AuthenticationConfig(_file=StringIO('[DEF'))
1246
 
        self.assertRaises(errors.ParseConfigError, conf._get_config)
1247
 
 
1248
 
    def test_auth_value_not_boolean(self):
1249
 
        conf = config.AuthenticationConfig(_file=StringIO(
1250
 
                """[broken]
1251
 
scheme=ftp
1252
 
user=joe
1253
 
verify_certificates=askme # Error: Not a boolean
1254
 
"""))
1255
 
        self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
1256
 
 
1257
 
    def test_auth_value_not_int(self):
1258
 
        conf = config.AuthenticationConfig(_file=StringIO(
1259
 
                """[broken]
1260
 
scheme=ftp
1261
 
user=joe
1262
 
port=port # Error: Not an int
1263
 
"""))
1264
 
        self.assertRaises(ValueError, conf.get_credentials, 'ftp', 'foo.net')
1265
 
 
1266
 
    def test_credentials_for_scheme_host(self):
1267
 
        conf = config.AuthenticationConfig(_file=StringIO(
1268
 
                """# Identity on foo.net
1269
 
[ftp definition]
1270
 
scheme=ftp
1271
 
host=foo.net
1272
 
user=joe
1273
 
password=secret-pass
1274
 
"""))
1275
 
        # Basic matching
1276
 
        self._got_user_passwd('joe', 'secret-pass', conf, 'ftp', 'foo.net')
1277
 
        # different scheme
1278
 
        self._got_user_passwd(None, None, conf, 'http', 'foo.net')
1279
 
        # different host
1280
 
        self._got_user_passwd(None, None, conf, 'ftp', 'bar.net')
1281
 
 
1282
 
    def test_credentials_for_host_port(self):
1283
 
        conf = config.AuthenticationConfig(_file=StringIO(
1284
 
                """# Identity on foo.net
1285
 
[ftp definition]
1286
 
scheme=ftp
1287
 
port=10021
1288
 
host=foo.net
1289
 
user=joe
1290
 
password=secret-pass
1291
 
"""))
1292
 
        # No port
1293
 
        self._got_user_passwd('joe', 'secret-pass',
1294
 
                              conf, 'ftp', 'foo.net', port=10021)
1295
 
        # different port
1296
 
        self._got_user_passwd(None, None, conf, 'ftp', 'foo.net')
1297
 
 
1298
 
    def test_for_matching_host(self):
1299
 
        conf = config.AuthenticationConfig(_file=StringIO(
1300
 
                """# Identity on foo.net
1301
 
[sourceforge]
1302
 
scheme=bzr
1303
 
host=bzr.sf.net
1304
 
user=joe
1305
 
password=joepass
1306
 
[sourceforge domain]
1307
 
scheme=bzr
1308
 
host=.bzr.sf.net
1309
 
user=georges
1310
 
password=bendover
1311
 
"""))
1312
 
        # matching domain
1313
 
        self._got_user_passwd('georges', 'bendover',
1314
 
                              conf, 'bzr', 'foo.bzr.sf.net')
1315
 
        # phishing attempt
1316
 
        self._got_user_passwd(None, None,
1317
 
                              conf, 'bzr', 'bbzr.sf.net')
1318
 
 
1319
 
    def test_for_matching_host_None(self):
1320
 
        conf = config.AuthenticationConfig(_file=StringIO(
1321
 
                """# Identity on foo.net
1322
 
[catchup bzr]
1323
 
scheme=bzr
1324
 
user=joe
1325
 
password=joepass
1326
 
[DEFAULT]
1327
 
user=georges
1328
 
password=bendover
1329
 
"""))
1330
 
        # match no host
1331
 
        self._got_user_passwd('joe', 'joepass',
1332
 
                              conf, 'bzr', 'quux.net')
1333
 
        # no host but different scheme
1334
 
        self._got_user_passwd('georges', 'bendover',
1335
 
                              conf, 'ftp', 'quux.net')
1336
 
 
1337
 
    def test_credentials_for_path(self):
1338
 
        conf = config.AuthenticationConfig(_file=StringIO(
1339
 
                """
1340
 
[http dir1]
1341
 
scheme=http
1342
 
host=bar.org
1343
 
path=/dir1
1344
 
user=jim
1345
 
password=jimpass
1346
 
[http dir2]
1347
 
scheme=http
1348
 
host=bar.org
1349
 
path=/dir2
1350
 
user=georges
1351
 
password=bendover
1352
 
"""))
1353
 
        # no path no dice
1354
 
        self._got_user_passwd(None, None,
1355
 
                              conf, 'http', host='bar.org', path='/dir3')
1356
 
        # matching path
1357
 
        self._got_user_passwd('georges', 'bendover',
1358
 
                              conf, 'http', host='bar.org', path='/dir2')
1359
 
        # matching subdir
1360
 
        self._got_user_passwd('jim', 'jimpass',
1361
 
                              conf, 'http', host='bar.org',path='/dir1/subdir')
1362
 
 
1363
 
    def test_credentials_for_user(self):
1364
 
        conf = config.AuthenticationConfig(_file=StringIO(
1365
 
                """
1366
 
[with user]
1367
 
scheme=http
1368
 
host=bar.org
1369
 
user=jim
1370
 
password=jimpass
1371
 
"""))
1372
 
        # Get user
1373
 
        self._got_user_passwd('jim', 'jimpass',
1374
 
                              conf, 'http', 'bar.org')
1375
 
        # Get same user
1376
 
        self._got_user_passwd('jim', 'jimpass',
1377
 
                              conf, 'http', 'bar.org', user='jim')
1378
 
        # Don't get a different user if one is specified
1379
 
        self._got_user_passwd(None, None,
1380
 
                              conf, 'http', 'bar.org', user='georges')
1381
 
 
1382
 
    def test_credentials_for_user_without_password(self):
1383
 
        conf = config.AuthenticationConfig(_file=StringIO(
1384
 
                """
1385
 
[without password]
1386
 
scheme=http
1387
 
host=bar.org
1388
 
user=jim
1389
 
"""))
1390
 
        # Get user but no password
1391
 
        self._got_user_passwd('jim', None,
1392
 
                              conf, 'http', 'bar.org')
1393
 
 
1394
 
    def test_verify_certificates(self):
1395
 
        conf = config.AuthenticationConfig(_file=StringIO(
1396
 
                """
1397
 
[self-signed]
1398
 
scheme=https
1399
 
host=bar.org
1400
 
user=jim
1401
 
password=jimpass
1402
 
verify_certificates=False
1403
 
[normal]
1404
 
scheme=https
1405
 
host=foo.net
1406
 
user=georges
1407
 
password=bendover
1408
 
"""))
1409
 
        credentials = conf.get_credentials('https', 'bar.org')
1410
 
        self.assertEquals(False, credentials.get('verify_certificates'))
1411
 
        credentials = conf.get_credentials('https', 'foo.net')
1412
 
        self.assertEquals(True, credentials.get('verify_certificates'))
1413
 
 
1414
 
 
1415
 
class TestAuthenticationConfig(tests.TestCase):
1416
 
    """Test AuthenticationConfig behaviour"""
1417
 
 
1418
 
    def _check_default_prompt(self, expected_prompt_format, scheme,
1419
 
                              host=None, port=None, realm=None, path=None):
1420
 
        if host is None:
1421
 
            host = 'bar.org'
1422
 
        user, password = 'jim', 'precious'
1423
 
        expected_prompt = expected_prompt_format % {
1424
 
            'scheme': scheme, 'host': host, 'port': port,
1425
 
            'user': user, 'realm': realm}
1426
 
 
1427
 
        stdout = tests.StringIOWrapper()
1428
 
        ui.ui_factory = tests.TestUIFactory(stdin=password + '\n',
1429
 
                                            stdout=stdout)
1430
 
        # We use an empty conf so that the user is always prompted
1431
 
        conf = config.AuthenticationConfig()
1432
 
        self.assertEquals(password,
1433
 
                          conf.get_password(scheme, host, user, port=port,
1434
 
                                            realm=realm, path=path))
1435
 
        self.assertEquals(stdout.getvalue(), expected_prompt)
1436
 
 
1437
 
    def test_default_prompts(self):
1438
 
        # HTTP prompts can't be tested here, see test_http.py
1439
 
        self._check_default_prompt('FTP %(user)s@%(host)s password: ', 'ftp')
1440
 
        self._check_default_prompt('FTP %(user)s@%(host)s:%(port)d password: ',
1441
 
                                   'ftp', port=10020)
1442
 
 
1443
 
        self._check_default_prompt('SSH %(user)s@%(host)s:%(port)d password: ',
1444
 
                                   'ssh', port=12345)
1445
 
        # SMTP port handling is a bit special (it's handled if embedded in the
1446
 
        # host too)
1447
 
        # FIXME: should we: forbid that, extend it to other schemes, leave
1448
 
        # things as they are that's fine thank you ?
1449
 
        self._check_default_prompt('SMTP %(user)s@%(host)s password: ',
1450
 
                                   'smtp')
1451
 
        self._check_default_prompt('SMTP %(user)s@%(host)s password: ',
1452
 
                                   'smtp', host='bar.org:10025')
1453
 
        self._check_default_prompt(
1454
 
            'SMTP %(user)s@%(host)s:%(port)d password: ',
1455
 
            'smtp', port=10025)
1456
 
 
1457
 
    def test_ssh_password_emits_warning(self):
1458
 
        conf = config.AuthenticationConfig(_file=StringIO(
1459
 
                """
1460
 
[ssh with password]
1461
 
scheme=ssh
1462
 
host=bar.org
1463
 
user=jim
1464
 
password=jimpass
1465
 
"""))
1466
 
        entered_password = 'typed-by-hand'
1467
 
        stdout = tests.StringIOWrapper()
1468
 
        ui.ui_factory = tests.TestUIFactory(stdin=entered_password + '\n',
1469
 
                                            stdout=stdout)
1470
 
 
1471
 
        # Since the password defined in the authentication config is ignored,
1472
 
        # the user is prompted
1473
 
        self.assertEquals(entered_password,
1474
 
                          conf.get_password('ssh', 'bar.org', user='jim'))
1475
 
        self.assertContainsRe(
1476
 
            self._get_log(keep_log_file=True),
1477
 
            'password ignored in section \[ssh with password\]')
1478
 
 
1479
 
    def test_ssh_without_password_doesnt_emit_warning(self):
1480
 
        conf = config.AuthenticationConfig(_file=StringIO(
1481
 
                """
1482
 
[ssh with password]
1483
 
scheme=ssh
1484
 
host=bar.org
1485
 
user=jim
1486
 
"""))
1487
 
        entered_password = 'typed-by-hand'
1488
 
        stdout = tests.StringIOWrapper()
1489
 
        ui.ui_factory = tests.TestUIFactory(stdin=entered_password + '\n',
1490
 
                                            stdout=stdout)
1491
 
 
1492
 
        # Since the password defined in the authentication config is ignored,
1493
 
        # the user is prompted
1494
 
        self.assertEquals(entered_password,
1495
 
                          conf.get_password('ssh', 'bar.org', user='jim'))
1496
 
        # No warning shoud be emitted since there is no password. We are only
1497
 
        # providing "user".
1498
 
        self.assertNotContainsRe(
1499
 
            self._get_log(keep_log_file=True),
1500
 
            'password ignored in section \[ssh with password\]')
1501
 
 
1502
 
 
1503
 
# FIXME: Once we have a way to declare authentication to all test servers, we
1504
 
# can implement generic tests.
1505
 
# test_user_password_in_url
1506
 
# test_user_in_url_password_from_config
1507
 
# test_user_in_url_password_prompted
1508
 
# test_user_in_config
1509
 
# test_user_getpass.getuser
1510
 
# test_user_prompted ?
1511
 
class TestAuthenticationRing(tests.TestCaseWithTransport):
1512
 
    pass