17
17
"""Tests for the Branch facility that are not interface tests.
19
For interface tests see tests/branch_implementations/*.py.
19
For interface tests see tests/per_branch/*.py.
21
21
For concrete class tests see this file, and for meta-branch tests
22
22
also see this file.
25
from StringIO import StringIO
25
from cStringIO import StringIO
27
27
from bzrlib import (
28
28
branch as _mod_branch,
35
from bzrlib.branch import (
39
BranchReferenceFormat,
44
_run_with_write_locked_target,
46
from bzrlib.bzrdir import (BzrDirMetaFormat1, BzrDirMeta1,
48
from bzrlib.errors import (NotBranchError,
51
UnsupportedFormatError,
54
from bzrlib.tests import TestCase, TestCaseWithTransport
55
from bzrlib.transport import get_transport
58
class TestDefaultFormat(TestCase):
39
class TestDefaultFormat(tests.TestCase):
60
41
def test_default_format(self):
61
42
# update this if you change the default branch format
62
self.assertIsInstance(BranchFormat.get_default_format(),
43
self.assertIsInstance(_mod_branch.BranchFormat.get_default_format(),
44
_mod_branch.BzrBranchFormat7)
65
46
def test_default_format_is_same_as_bzrdir_default(self):
66
47
# XXX: it might be nice if there was only one place the default was
67
48
# set, but at the moment that's not true -- mbp 20070814 --
68
49
# https://bugs.launchpad.net/bzr/+bug/132376
69
self.assertEqual(BranchFormat.get_default_format(),
70
BzrDirFormat.get_default_format().get_branch_format())
51
_mod_branch.BranchFormat.get_default_format(),
52
bzrdir.BzrDirFormat.get_default_format().get_branch_format())
72
54
def test_get_set_default_format(self):
73
55
# set the format and then set it back again
74
old_format = BranchFormat.get_default_format()
75
BranchFormat.set_default_format(SampleBranchFormat())
56
old_format = _mod_branch.BranchFormat.get_default_format()
57
_mod_branch.BranchFormat.set_default_format(SampleBranchFormat())
77
59
# the default branch format is used by the meta dir format
78
60
# which is not the default bzrdir format at this point
79
dir = BzrDirMetaFormat1().initialize('memory:///')
61
dir = bzrdir.BzrDirMetaFormat1().initialize('memory:///')
80
62
result = dir.create_branch()
81
63
self.assertEqual(result, 'A branch')
83
BranchFormat.set_default_format(old_format)
84
self.assertEqual(old_format, BranchFormat.get_default_format())
87
class TestBranchFormat5(TestCaseWithTransport):
65
_mod_branch.BranchFormat.set_default_format(old_format)
66
self.assertEqual(old_format,
67
_mod_branch.BranchFormat.get_default_format())
70
class TestBranchFormat5(tests.TestCaseWithTransport):
88
71
"""Tests specific to branch format 5"""
90
73
def test_branch_format_5_uses_lockdir(self):
91
74
url = self.get_url()
92
bzrdir = BzrDirMetaFormat1().initialize(url)
93
bzrdir.create_repository()
94
branch = bzrdir.create_branch()
75
bdir = bzrdir.BzrDirMetaFormat1().initialize(url)
76
bdir.create_repository()
77
branch = bdir.create_branch()
95
78
t = self.get_transport()
96
79
self.log("branch instance is %r" % branch)
97
self.assert_(isinstance(branch, BzrBranch5))
80
self.assert_(isinstance(branch, _mod_branch.BzrBranch5))
98
81
self.assertIsDirectory('.', t)
99
82
self.assertIsDirectory('.bzr/branch', t)
100
83
self.assertIsDirectory('.bzr/branch/lock', t)
101
84
branch.lock_write()
103
self.assertIsDirectory('.bzr/branch/lock/held', t)
85
self.addCleanup(branch.unlock)
86
self.assertIsDirectory('.bzr/branch/lock/held', t)
107
88
def test_set_push_location(self):
108
89
from bzrlib.config import (locations_config_filename,
142
123
"""See BzrBranchFormat.get_format_string()."""
143
124
return "Sample branch format."
145
def initialize(self, a_bzrdir):
126
def initialize(self, a_bzrdir, name=None):
146
127
"""Format 4 branches cannot be created."""
147
t = a_bzrdir.get_branch_transport(self)
128
t = a_bzrdir.get_branch_transport(self, name=name)
148
129
t.put_bytes('format', self.get_format_string())
149
130
return 'A branch'
151
132
def is_supported(self):
154
def open(self, transport, _found=False, ignore_fallbacks=False):
135
def open(self, transport, name=None, _found=False, ignore_fallbacks=False):
155
136
return "opened branch."
158
class TestBzrBranchFormat(TestCaseWithTransport):
139
class TestBzrBranchFormat(tests.TestCaseWithTransport):
159
140
"""Tests for the BzrBranchFormat facility."""
161
142
def test_find_format(self):
167
148
dir = format._matchingbzrdir.initialize(url)
168
149
dir.create_repository()
169
150
format.initialize(dir)
170
found_format = BranchFormat.find_format(dir)
151
found_format = _mod_branch.BranchFormat.find_format(dir)
171
152
self.failUnless(isinstance(found_format, format.__class__))
172
check_format(BzrBranchFormat5(), "bar")
153
check_format(_mod_branch.BzrBranchFormat5(), "bar")
174
155
def test_find_format_not_branch(self):
175
156
dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
176
self.assertRaises(NotBranchError,
177
BranchFormat.find_format,
157
self.assertRaises(errors.NotBranchError,
158
_mod_branch.BranchFormat.find_format,
180
161
def test_find_format_unknown_format(self):
181
162
dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
182
163
SampleBranchFormat().initialize(dir)
183
self.assertRaises(UnknownFormatError,
184
BranchFormat.find_format,
164
self.assertRaises(errors.UnknownFormatError,
165
_mod_branch.BranchFormat.find_format,
187
168
def test_register_unregister_format(self):
192
173
format.initialize(dir)
193
174
# register a format for it.
194
BranchFormat.register_format(format)
175
_mod_branch.BranchFormat.register_format(format)
195
176
# which branch.Open will refuse (not supported)
196
self.assertRaises(UnsupportedFormatError, Branch.open, self.get_url())
177
self.assertRaises(errors.UnsupportedFormatError,
178
_mod_branch.Branch.open, self.get_url())
197
179
self.make_branch_and_tree('foo')
198
180
# but open_downlevel will work
199
self.assertEqual(format.open(dir), bzrdir.BzrDir.open(self.get_url()).open_branch(unsupported=True))
183
bzrdir.BzrDir.open(self.get_url()).open_branch(unsupported=True))
200
184
# unregister the format
201
BranchFormat.unregister_format(format)
185
_mod_branch.BranchFormat.unregister_format(format)
202
186
self.make_branch_and_tree('bar')
378
363
self.assertTrue(branch.repository.has_revision(revid))
381
class TestBranchReference(TestCaseWithTransport):
366
class BzrBranch8(tests.TestCaseWithTransport):
368
def make_branch(self, location, format=None):
370
format = bzrdir.format_registry.make_bzrdir('1.9')
371
format.set_branch_format(_mod_branch.BzrBranchFormat8())
372
return tests.TestCaseWithTransport.make_branch(
373
self, location, format=format)
375
def create_branch_with_reference(self):
376
branch = self.make_branch('branch')
377
branch._set_all_reference_info({'file-id': ('path', 'location')})
381
def instrument_branch(branch, gets):
382
old_get = branch._transport.get
383
def get(*args, **kwargs):
384
gets.append((args, kwargs))
385
return old_get(*args, **kwargs)
386
branch._transport.get = get
388
def test_reference_info_caching_read_locked(self):
390
branch = self.create_branch_with_reference()
392
self.addCleanup(branch.unlock)
393
self.instrument_branch(branch, gets)
394
branch.get_reference_info('file-id')
395
branch.get_reference_info('file-id')
396
self.assertEqual(1, len(gets))
398
def test_reference_info_caching_read_unlocked(self):
400
branch = self.create_branch_with_reference()
401
self.instrument_branch(branch, gets)
402
branch.get_reference_info('file-id')
403
branch.get_reference_info('file-id')
404
self.assertEqual(2, len(gets))
406
def test_reference_info_caching_write_locked(self):
408
branch = self.make_branch('branch')
410
self.instrument_branch(branch, gets)
411
self.addCleanup(branch.unlock)
412
branch._set_all_reference_info({'file-id': ('path2', 'location2')})
413
path, location = branch.get_reference_info('file-id')
414
self.assertEqual(0, len(gets))
415
self.assertEqual('path2', path)
416
self.assertEqual('location2', location)
418
def test_reference_info_caches_cleared(self):
419
branch = self.make_branch('branch')
421
branch.set_reference_info('file-id', 'path2', 'location2')
423
doppelganger = _mod_branch.Branch.open('branch')
424
doppelganger.set_reference_info('file-id', 'path3', 'location3')
425
self.assertEqual(('path3', 'location3'),
426
branch.get_reference_info('file-id'))
428
class TestBranchReference(tests.TestCaseWithTransport):
382
429
"""Tests for the branch reference facility."""
384
431
def test_create_open_reference(self):
385
432
bzrdirformat = bzrdir.BzrDirMetaFormat1()
386
t = get_transport(self.get_url('.'))
433
t = transport.get_transport(self.get_url('.'))
388
435
dir = bzrdirformat.initialize(self.get_url('repo'))
389
436
dir.create_repository()
390
437
target_branch = dir.create_branch()
391
438
t.mkdir('branch')
392
439
branch_dir = bzrdirformat.initialize(self.get_url('branch'))
393
made_branch = BranchReferenceFormat().initialize(branch_dir, target_branch)
440
made_branch = _mod_branch.BranchReferenceFormat().initialize(
441
branch_dir, target_branch=target_branch)
394
442
self.assertEqual(made_branch.base, target_branch.base)
395
443
opened_branch = branch_dir.open_branch()
396
444
self.assertEqual(opened_branch.base, target_branch.base)
407
455
_mod_branch.BranchReferenceFormat().get_reference(checkout.bzrdir))
410
class TestHooks(TestCase):
458
class TestHooks(tests.TestCaseWithTransport):
412
460
def test_constructor(self):
413
461
"""Check that creating a BranchHooks instance has the right defaults."""
414
hooks = BranchHooks()
462
hooks = _mod_branch.BranchHooks()
415
463
self.assertTrue("set_rh" in hooks, "set_rh not in %s" % hooks)
416
464
self.assertTrue("post_push" in hooks, "post_push not in %s" % hooks)
417
465
self.assertTrue("post_commit" in hooks, "post_commit not in %s" % hooks)
418
466
self.assertTrue("pre_commit" in hooks, "pre_commit not in %s" % hooks)
419
467
self.assertTrue("post_pull" in hooks, "post_pull not in %s" % hooks)
420
self.assertTrue("post_uncommit" in hooks, "post_uncommit not in %s" % hooks)
468
self.assertTrue("post_uncommit" in hooks,
469
"post_uncommit not in %s" % hooks)
421
470
self.assertTrue("post_change_branch_tip" in hooks,
422
471
"post_change_branch_tip not in %s" % hooks)
472
self.assertTrue("post_branch_init" in hooks,
473
"post_branch_init not in %s" % hooks)
474
self.assertTrue("post_switch" in hooks,
475
"post_switch not in %s" % hooks)
424
477
def test_installed_hooks_are_BranchHooks(self):
425
478
"""The installed hooks object should be a BranchHooks."""
426
479
# the installed hooks are saved in self._preserved_hooks.
427
480
self.assertIsInstance(self._preserved_hooks[_mod_branch.Branch][1],
431
class TestPullResult(TestCase):
481
_mod_branch.BranchHooks)
483
def test_post_branch_init_hook(self):
485
_mod_branch.Branch.hooks.install_named_hook('post_branch_init',
487
self.assertLength(0, calls)
488
branch = self.make_branch('a')
489
self.assertLength(1, calls)
491
self.assertIsInstance(params, _mod_branch.BranchInitHookParams)
492
self.assertTrue(hasattr(params, 'bzrdir'))
493
self.assertTrue(hasattr(params, 'branch'))
495
def test_post_switch_hook(self):
496
from bzrlib import switch
498
_mod_branch.Branch.hooks.install_named_hook('post_switch',
500
tree = self.make_branch_and_tree('branch-1')
501
self.build_tree(['branch-1/file-1'])
504
to_branch = tree.bzrdir.sprout('branch-2').open_branch()
505
self.build_tree(['branch-1/file-2'])
507
tree.remove('file-1')
509
checkout = tree.branch.create_checkout('checkout')
510
self.assertLength(0, calls)
511
switch.switch(checkout.bzrdir, to_branch)
512
self.assertLength(1, calls)
514
self.assertIsInstance(params, _mod_branch.SwitchHookParams)
515
self.assertTrue(hasattr(params, 'to_branch'))
516
self.assertTrue(hasattr(params, 'revision_id'))
519
class TestBranchOptions(tests.TestCaseWithTransport):
522
super(TestBranchOptions, self).setUp()
523
self.branch = self.make_branch('.')
524
self.config = self.branch.get_config()
526
def check_append_revisions_only(self, expected_value, value=None):
527
"""Set append_revisions_only in config and check its interpretation."""
528
if value is not None:
529
self.config.set_user_option('append_revisions_only', value)
530
self.assertEqual(expected_value,
531
self.branch._get_append_revisions_only())
533
def test_valid_append_revisions_only(self):
534
self.assertEquals(None,
535
self.config.get_user_option('append_revisions_only'))
536
self.check_append_revisions_only(None)
537
self.check_append_revisions_only(False, 'False')
538
self.check_append_revisions_only(True, 'True')
539
# The following values will cause compatibility problems on projects
540
# using older bzr versions (<2.2) but are accepted
541
self.check_append_revisions_only(False, 'false')
542
self.check_append_revisions_only(True, 'true')
544
def test_invalid_append_revisions_only(self):
545
"""Ensure warning is noted on invalid settings"""
548
self.warnings.append(args[0] % args[1:])
549
self.overrideAttr(trace, 'warning', warning)
550
self.check_append_revisions_only(None, 'not-a-bool')
551
self.assertLength(1, self.warnings)
553
'Value "not-a-bool" is not a boolean for "append_revisions_only"',
557
class TestPullResult(tests.TestCase):
433
559
def test_pull_result_to_int(self):
434
560
# to support old code, the pull result can be used as an int
561
r = _mod_branch.PullResult()
438
564
# this usage of results is not recommended for new code (because it
492
635
def test_exception_unlocks_and_propagates(self):
493
636
lockable = _StubLockable(self._calls)
494
637
self.assertRaises(_ErrorFromCallable,
495
_run_with_write_locked_target, lockable, self.func_that_raises)
638
_mod_branch._run_with_write_locked_target,
639
lockable, self.func_that_raises)
496
640
self.assertEqual(['lock_write', 'func called', 'unlock'], self._calls)
498
642
def test_callable_succeeds_but_error_during_unlock(self):
499
643
lockable = _StubLockable(self._calls, unlock_exc=_ErrorFromUnlock())
500
644
self.assertRaises(_ErrorFromUnlock,
501
_run_with_write_locked_target, lockable, self.func_that_returns_ok)
645
_mod_branch._run_with_write_locked_target,
646
lockable, self.func_that_returns_ok)
502
647
self.assertEqual(['lock_write', 'func called', 'unlock'], self._calls)
504
649
def test_error_during_unlock_does_not_mask_original_error(self):
505
650
lockable = _StubLockable(self._calls, unlock_exc=_ErrorFromUnlock())
506
651
self.assertRaises(_ErrorFromCallable,
507
_run_with_write_locked_target, lockable, self.func_that_raises)
652
_mod_branch._run_with_write_locked_target,
653
lockable, self.func_that_raises)
508
654
self.assertEqual(['lock_write', 'func called', 'unlock'], self._calls)