13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
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,
45
from bzrlib.bzrdir import (BzrDirMetaFormat1, BzrDirMeta1,
47
from bzrlib.errors import (NotBranchError,
50
UnsupportedFormatError,
53
from bzrlib.tests import TestCase, TestCaseWithTransport
54
from bzrlib.transport import get_transport
57
class TestDefaultFormat(TestCase):
39
class TestDefaultFormat(tests.TestCase):
59
41
def test_default_format(self):
60
42
# update this if you change the default branch format
61
self.assertIsInstance(BranchFormat.get_default_format(),
43
self.assertIsInstance(_mod_branch.BranchFormat.get_default_format(),
44
_mod_branch.BzrBranchFormat7)
64
46
def test_default_format_is_same_as_bzrdir_default(self):
65
47
# XXX: it might be nice if there was only one place the default was
66
# set, but at the moment that's not true -- mbp 20070814 --
48
# set, but at the moment that's not true -- mbp 20070814 --
67
49
# https://bugs.launchpad.net/bzr/+bug/132376
68
self.assertEqual(BranchFormat.get_default_format(),
69
BzrDirFormat.get_default_format().get_branch_format())
51
_mod_branch.BranchFormat.get_default_format(),
52
bzrdir.BzrDirFormat.get_default_format().get_branch_format())
71
54
def test_get_set_default_format(self):
72
55
# set the format and then set it back again
73
old_format = BranchFormat.get_default_format()
74
BranchFormat.set_default_format(SampleBranchFormat())
56
old_format = _mod_branch.BranchFormat.get_default_format()
57
_mod_branch.BranchFormat.set_default_format(SampleBranchFormat())
76
59
# the default branch format is used by the meta dir format
77
60
# which is not the default bzrdir format at this point
78
dir = BzrDirMetaFormat1().initialize('memory:///')
61
dir = bzrdir.BzrDirMetaFormat1().initialize('memory:///')
79
62
result = dir.create_branch()
80
63
self.assertEqual(result, 'A branch')
82
BranchFormat.set_default_format(old_format)
83
self.assertEqual(old_format, BranchFormat.get_default_format())
86
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):
87
71
"""Tests specific to branch format 5"""
89
73
def test_branch_format_5_uses_lockdir(self):
90
74
url = self.get_url()
91
bzrdir = BzrDirMetaFormat1().initialize(url)
92
bzrdir.create_repository()
93
branch = bzrdir.create_branch()
75
bdir = bzrdir.BzrDirMetaFormat1().initialize(url)
76
bdir.create_repository()
77
branch = bdir.create_branch()
94
78
t = self.get_transport()
95
79
self.log("branch instance is %r" % branch)
96
self.assert_(isinstance(branch, BzrBranch5))
80
self.assert_(isinstance(branch, _mod_branch.BzrBranch5))
97
81
self.assertIsDirectory('.', t)
98
82
self.assertIsDirectory('.bzr/branch', t)
99
83
self.assertIsDirectory('.bzr/branch/lock', t)
100
84
branch.lock_write()
102
self.assertIsDirectory('.bzr/branch/lock/held', t)
85
self.addCleanup(branch.unlock)
86
self.assertIsDirectory('.bzr/branch/lock/held', t)
106
88
def test_set_push_location(self):
107
89
from bzrlib.config import (locations_config_filename,
141
123
"""See BzrBranchFormat.get_format_string()."""
142
124
return "Sample branch format."
144
def initialize(self, a_bzrdir):
126
def initialize(self, a_bzrdir, name=None):
145
127
"""Format 4 branches cannot be created."""
146
t = a_bzrdir.get_branch_transport(self)
128
t = a_bzrdir.get_branch_transport(self, name=name)
147
129
t.put_bytes('format', self.get_format_string())
148
130
return 'A branch'
150
132
def is_supported(self):
153
def open(self, transport, _found=False):
135
def open(self, transport, name=None, _found=False, ignore_fallbacks=False):
154
136
return "opened branch."
157
class TestBzrBranchFormat(TestCaseWithTransport):
139
class TestBzrBranchFormat(tests.TestCaseWithTransport):
158
140
"""Tests for the BzrBranchFormat facility."""
160
142
def test_find_format(self):
161
143
# is the right format object found for a branch?
162
144
# create a branch with a few known format objects.
163
# this is not quite the same as
145
# this is not quite the same as
164
146
self.build_tree(["foo/", "bar/"])
165
147
def check_format(format, url):
166
148
dir = format._matchingbzrdir.initialize(url)
167
149
dir.create_repository()
168
150
format.initialize(dir)
169
found_format = BranchFormat.find_format(dir)
151
found_format = _mod_branch.BranchFormat.find_format(dir)
170
152
self.failUnless(isinstance(found_format, format.__class__))
171
check_format(BzrBranchFormat5(), "bar")
153
check_format(_mod_branch.BzrBranchFormat5(), "bar")
173
155
def test_find_format_not_branch(self):
174
156
dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
175
self.assertRaises(NotBranchError,
176
BranchFormat.find_format,
157
self.assertRaises(errors.NotBranchError,
158
_mod_branch.BranchFormat.find_format,
179
161
def test_find_format_unknown_format(self):
180
162
dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
181
163
SampleBranchFormat().initialize(dir)
182
self.assertRaises(UnknownFormatError,
183
BranchFormat.find_format,
164
self.assertRaises(errors.UnknownFormatError,
165
_mod_branch.BranchFormat.find_format,
186
168
def test_register_unregister_format(self):
191
173
format.initialize(dir)
192
174
# register a format for it.
193
BranchFormat.register_format(format)
175
_mod_branch.BranchFormat.register_format(format)
194
176
# which branch.Open will refuse (not supported)
195
self.assertRaises(UnsupportedFormatError, Branch.open, self.get_url())
177
self.assertRaises(errors.UnsupportedFormatError,
178
_mod_branch.Branch.open, self.get_url())
196
179
self.make_branch_and_tree('foo')
197
180
# but open_downlevel will work
198
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))
199
184
# unregister the format
200
BranchFormat.unregister_format(format)
185
_mod_branch.BranchFormat.unregister_format(format)
201
186
self.make_branch_and_tree('bar')
377
363
self.assertTrue(branch.repository.has_revision(revid))
380
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):
381
429
"""Tests for the branch reference facility."""
383
431
def test_create_open_reference(self):
384
432
bzrdirformat = bzrdir.BzrDirMetaFormat1()
385
t = get_transport(self.get_url('.'))
433
t = transport.get_transport(self.get_url('.'))
387
435
dir = bzrdirformat.initialize(self.get_url('repo'))
388
436
dir.create_repository()
389
437
target_branch = dir.create_branch()
390
438
t.mkdir('branch')
391
439
branch_dir = bzrdirformat.initialize(self.get_url('branch'))
392
made_branch = BranchReferenceFormat().initialize(branch_dir, target_branch)
440
made_branch = _mod_branch.BranchReferenceFormat().initialize(
441
branch_dir, target_branch=target_branch)
393
442
self.assertEqual(made_branch.base, target_branch.base)
394
443
opened_branch = branch_dir.open_branch()
395
444
self.assertEqual(opened_branch.base, target_branch.base)
406
455
_mod_branch.BranchReferenceFormat().get_reference(checkout.bzrdir))
409
class TestHooks(TestCase):
458
class TestHooks(tests.TestCase):
411
460
def test_constructor(self):
412
461
"""Check that creating a BranchHooks instance has the right defaults."""
413
hooks = BranchHooks()
462
hooks = _mod_branch.BranchHooks()
414
463
self.assertTrue("set_rh" in hooks, "set_rh not in %s" % hooks)
415
464
self.assertTrue("post_push" in hooks, "post_push not in %s" % hooks)
416
465
self.assertTrue("post_commit" in hooks, "post_commit not in %s" % hooks)
417
466
self.assertTrue("pre_commit" in hooks, "pre_commit not in %s" % hooks)
418
467
self.assertTrue("post_pull" in hooks, "post_pull not in %s" % hooks)
419
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)
420
470
self.assertTrue("post_change_branch_tip" in hooks,
421
471
"post_change_branch_tip not in %s" % hooks)
423
473
def test_installed_hooks_are_BranchHooks(self):
424
474
"""The installed hooks object should be a BranchHooks."""
425
475
# the installed hooks are saved in self._preserved_hooks.
426
self.assertIsInstance(self._preserved_hooks[_mod_branch.Branch], BranchHooks)
429
class TestPullResult(TestCase):
476
self.assertIsInstance(self._preserved_hooks[_mod_branch.Branch][1],
477
_mod_branch.BranchHooks)
480
class TestPullResult(tests.TestCase):
431
482
def test_pull_result_to_int(self):
432
483
# to support old code, the pull result can be used as an int
484
r = _mod_branch.PullResult()
436
487
# this usage of results is not recommended for new code (because it
438
489
# it's still supported
439
490
a = "%d revisions pulled" % r
440
491
self.assertEqual(a, "10 revisions pulled")
493
def test_report_changed(self):
494
r = _mod_branch.PullResult()
495
r.old_revid = "old-revid"
497
r.new_revid = "new-revid"
501
self.assertEqual("Now on revision 20.\n", f.getvalue())
503
def test_report_unchanged(self):
504
r = _mod_branch.PullResult()
505
r.old_revid = "same-revid"
506
r.new_revid = "same-revid"
509
self.assertEqual("No revisions to pull.\n", f.getvalue())
512
class _StubLockable(object):
513
"""Helper for TestRunWithWriteLockedTarget."""
515
def __init__(self, calls, unlock_exc=None):
517
self.unlock_exc = unlock_exc
519
def lock_write(self):
520
self.calls.append('lock_write')
523
self.calls.append('unlock')
524
if self.unlock_exc is not None:
525
raise self.unlock_exc
528
class _ErrorFromCallable(Exception):
529
"""Helper for TestRunWithWriteLockedTarget."""
532
class _ErrorFromUnlock(Exception):
533
"""Helper for TestRunWithWriteLockedTarget."""
536
class TestRunWithWriteLockedTarget(tests.TestCase):
537
"""Tests for _run_with_write_locked_target."""
540
tests.TestCase.setUp(self)
543
def func_that_returns_ok(self):
544
self._calls.append('func called')
547
def func_that_raises(self):
548
self._calls.append('func called')
549
raise _ErrorFromCallable()
551
def test_success_unlocks(self):
552
lockable = _StubLockable(self._calls)
553
result = _mod_branch._run_with_write_locked_target(
554
lockable, self.func_that_returns_ok)
555
self.assertEqual('ok', result)
556
self.assertEqual(['lock_write', 'func called', 'unlock'], self._calls)
558
def test_exception_unlocks_and_propagates(self):
559
lockable = _StubLockable(self._calls)
560
self.assertRaises(_ErrorFromCallable,
561
_mod_branch._run_with_write_locked_target,
562
lockable, self.func_that_raises)
563
self.assertEqual(['lock_write', 'func called', 'unlock'], self._calls)
565
def test_callable_succeeds_but_error_during_unlock(self):
566
lockable = _StubLockable(self._calls, unlock_exc=_ErrorFromUnlock())
567
self.assertRaises(_ErrorFromUnlock,
568
_mod_branch._run_with_write_locked_target,
569
lockable, self.func_that_returns_ok)
570
self.assertEqual(['lock_write', 'func called', 'unlock'], self._calls)
572
def test_error_during_unlock_does_not_mask_original_error(self):
573
lockable = _StubLockable(self._calls, unlock_exc=_ErrorFromUnlock())
574
self.assertRaises(_ErrorFromCallable,
575
_mod_branch._run_with_write_locked_target,
576
lockable, self.func_that_raises)
577
self.assertEqual(['lock_write', 'func called', 'unlock'], self._calls)