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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""Tests for the Branch facility that are not interface tests.
19
For interface tests see tests/per_branch/*.py.
19
For interface tests see tests/branch_implementations/*.py.
21
21
For concrete class tests see this file, and for meta-branch tests
22
22
also see this file.
25
from cStringIO import StringIO
25
from StringIO import StringIO
27
27
from bzrlib import (
28
28
branch as _mod_branch,
39
class TestDefaultFormat(tests.TestCase):
41
def test_default_format(self):
42
# update this if you change the default branch format
43
self.assertIsInstance(_mod_branch.BranchFormat.get_default_format(),
44
_mod_branch.BzrBranchFormat7)
46
def test_default_format_is_same_as_bzrdir_default(self):
47
# XXX: it might be nice if there was only one place the default was
48
# set, but at the moment that's not true -- mbp 20070814 --
49
# https://bugs.launchpad.net/bzr/+bug/132376
51
_mod_branch.BranchFormat.get_default_format(),
52
bzrdir.BzrDirFormat.get_default_format().get_branch_format())
34
from bzrlib.branch import (BzrBranch5,
36
from bzrlib.bzrdir import (BzrDirMetaFormat1, BzrDirMeta1,
38
from bzrlib.errors import (NotBranchError,
41
UnsupportedFormatError,
44
from bzrlib.tests import TestCase, TestCaseWithTransport
45
from bzrlib.transport import get_transport
47
class TestDefaultFormat(TestCase):
54
49
def test_get_set_default_format(self):
55
# set the format and then set it back again
56
old_format = _mod_branch.BranchFormat.get_default_format()
57
_mod_branch.BranchFormat.set_default_format(SampleBranchFormat())
50
old_format = bzrlib.branch.BranchFormat.get_default_format()
52
self.assertTrue(isinstance(old_format, bzrlib.branch.BzrBranchFormat5))
53
bzrlib.branch.BranchFormat.set_default_format(SampleBranchFormat())
59
55
# the default branch format is used by the meta dir format
60
56
# which is not the default bzrdir format at this point
61
dir = bzrdir.BzrDirMetaFormat1().initialize('memory:///')
57
dir = BzrDirMetaFormat1().initialize('memory:///')
62
58
result = dir.create_branch()
63
59
self.assertEqual(result, 'A branch')
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):
61
bzrlib.branch.BranchFormat.set_default_format(old_format)
62
self.assertEqual(old_format, bzrlib.branch.BranchFormat.get_default_format())
65
class TestBranchFormat5(TestCaseWithTransport):
71
66
"""Tests specific to branch format 5"""
73
68
def test_branch_format_5_uses_lockdir(self):
74
69
url = self.get_url()
75
bdir = bzrdir.BzrDirMetaFormat1().initialize(url)
76
bdir.create_repository()
77
branch = bdir.create_branch()
70
bzrdir = BzrDirMetaFormat1().initialize(url)
71
bzrdir.create_repository()
72
branch = bzrdir.create_branch()
78
73
t = self.get_transport()
79
74
self.log("branch instance is %r" % branch)
80
self.assert_(isinstance(branch, _mod_branch.BzrBranch5))
75
self.assert_(isinstance(branch, BzrBranch5))
81
76
self.assertIsDirectory('.', t)
82
77
self.assertIsDirectory('.bzr/branch', t)
83
78
self.assertIsDirectory('.bzr/branch/lock', t)
84
79
branch.lock_write()
85
self.addCleanup(branch.unlock)
86
self.assertIsDirectory('.bzr/branch/lock/held', t)
81
self.assertIsDirectory('.bzr/branch/lock/held', t)
88
85
def test_set_push_location(self):
89
86
from bzrlib.config import (locations_config_filename,
90
87
ensure_config_dir_exists)
91
88
ensure_config_dir_exists()
92
89
fn = locations_config_filename()
93
# write correct newlines to locations.conf
94
# by default ConfigObj uses native line-endings for new files
95
# but uses already existing line-endings if file is not empty
98
f.write('# comment\n')
102
90
branch = self.make_branch('.', format='knit')
103
91
branch.set_push_location('foo')
104
92
local_path = urlutils.local_path_from_url(branch.base[:-1])
105
self.assertFileEqual("# comment\n"
93
self.assertFileEqual("[%s]\n"
107
94
"push_location = foo\n"
108
"push_location:policy = norecurse\n" % local_path,
95
"push_location:policy = norecurse" % local_path,
111
98
# TODO RBC 20051029 test getting a push location from a branch in a
112
99
# recursive section - that is, it appends the branch name.
115
class SampleBranchFormat(_mod_branch.BranchFormat):
102
class SampleBranchFormat(bzrlib.branch.BranchFormat):
116
103
"""A sample format
118
this format is initializable, unsupported to aid in testing the
105
this format is initializable, unsupported to aid in testing the
119
106
open and open_downlevel routines.
229
209
self.assertEqual('ftp://bazaar-vcs.org', branch.get_bound_location())
231
211
def test_set_revision_history(self):
232
builder = self.make_branch_builder('.', format=self.get_format_name())
233
builder.build_snapshot('foo', None,
234
[('add', ('', None, 'directory', None))],
236
builder.build_snapshot('bar', None, [], message='bar')
237
branch = builder.get_branch()
239
self.addCleanup(branch.unlock)
240
branch.set_revision_history(['foo', 'bar'])
241
branch.set_revision_history(['foo'])
242
self.assertRaises(errors.NotLefthandHistory,
243
branch.set_revision_history, ['bar'])
245
def do_checkout_test(self, lightweight=False):
246
tree = self.make_branch_and_tree('source',
247
format=self.get_format_name_subtree())
248
subtree = self.make_branch_and_tree('source/subtree',
249
format=self.get_format_name_subtree())
250
subsubtree = self.make_branch_and_tree('source/subtree/subsubtree',
251
format=self.get_format_name_subtree())
252
self.build_tree(['source/subtree/file',
253
'source/subtree/subsubtree/file'])
254
subsubtree.add('file')
256
subtree.add_reference(subsubtree)
257
tree.add_reference(subtree)
258
tree.commit('a revision')
259
subtree.commit('a subtree file')
260
subsubtree.commit('a subsubtree file')
261
tree.branch.create_checkout('target', lightweight=lightweight)
262
self.failUnlessExists('target')
263
self.failUnlessExists('target/subtree')
264
self.failUnlessExists('target/subtree/file')
265
self.failUnlessExists('target/subtree/subsubtree/file')
266
subbranch = _mod_branch.Branch.open('target/subtree/subsubtree')
268
self.assertEndsWith(subbranch.base, 'source/subtree/subsubtree/')
270
self.assertEndsWith(subbranch.base, 'target/subtree/subsubtree/')
272
def test_checkout_with_references(self):
273
self.do_checkout_test()
275
def test_light_checkout_with_references(self):
276
self.do_checkout_test(lightweight=True)
278
def test_set_push(self):
279
branch = self.make_branch('source', format=self.get_format_name())
280
branch.get_config().set_user_option('push_location', 'old',
281
store=config.STORE_LOCATION)
284
warnings.append(args[0] % args[1:])
285
_warning = trace.warning
286
trace.warning = warning
288
branch.set_push_location('new')
290
trace.warning = _warning
291
self.assertEqual(warnings[0], 'Value "new" is masked by "old" from '
295
class TestBranch6(TestBranch67, tests.TestCaseWithTransport):
298
return _mod_branch.BzrBranch6
300
def get_format_name(self):
301
return "dirstate-tags"
303
def get_format_name_subtree(self):
304
return "dirstate-with-subtree"
306
def test_set_stacked_on_url_errors(self):
307
branch = self.make_branch('a', format=self.get_format_name())
308
self.assertRaises(errors.UnstackableBranchFormat,
309
branch.set_stacked_on_url, None)
311
def test_default_stacked_location(self):
312
branch = self.make_branch('a', format=self.get_format_name())
313
self.assertRaises(errors.UnstackableBranchFormat, branch.get_stacked_on_url)
316
class TestBranch7(TestBranch67, tests.TestCaseWithTransport):
319
return _mod_branch.BzrBranch7
321
def get_format_name(self):
324
def get_format_name_subtree(self):
325
return "development-subtree"
327
def test_set_stacked_on_url_unstackable_repo(self):
328
repo = self.make_repository('a', format='dirstate-tags')
329
control = repo.bzrdir
330
branch = _mod_branch.BzrBranchFormat7().initialize(control)
331
target = self.make_branch('b')
332
self.assertRaises(errors.UnstackableRepositoryFormat,
333
branch.set_stacked_on_url, target.base)
335
def test_clone_stacked_on_unstackable_repo(self):
336
repo = self.make_repository('a', format='dirstate-tags')
337
control = repo.bzrdir
338
branch = _mod_branch.BzrBranchFormat7().initialize(control)
339
# Calling clone should not raise UnstackableRepositoryFormat.
340
cloned_bzrdir = control.clone('cloned')
342
def _test_default_stacked_location(self):
343
branch = self.make_branch('a', format=self.get_format_name())
344
self.assertRaises(errors.NotStacked, branch.get_stacked_on_url)
346
def test_stack_and_unstack(self):
347
branch = self.make_branch('a', format=self.get_format_name())
348
target = self.make_branch_and_tree('b', format=self.get_format_name())
349
branch.set_stacked_on_url(target.branch.base)
350
self.assertEqual(target.branch.base, branch.get_stacked_on_url())
351
revid = target.commit('foo')
352
self.assertTrue(branch.repository.has_revision(revid))
353
branch.set_stacked_on_url(None)
354
self.assertRaises(errors.NotStacked, branch.get_stacked_on_url)
355
self.assertFalse(branch.repository.has_revision(revid))
357
def test_open_opens_stacked_reference(self):
358
branch = self.make_branch('a', format=self.get_format_name())
359
target = self.make_branch_and_tree('b', format=self.get_format_name())
360
branch.set_stacked_on_url(target.branch.base)
361
branch = branch.bzrdir.open_branch()
362
revid = target.commit('foo')
363
self.assertTrue(branch.repository.has_revision(revid))
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):
212
tree = self.make_branch_and_memory_tree('.',
213
format='experimental-branch6')
217
tree.commit('foo', rev_id='foo')
218
tree.commit('bar', rev_id='bar')
219
tree.branch.set_revision_history(['foo', 'bar'])
220
tree.branch.set_revision_history(['foo'])
221
self.assertRaises(errors.NotLefthandHistory,
222
tree.branch.set_revision_history, ['bar'])
226
def test_append_revision(self):
227
tree = self.make_branch_and_tree('branch1',
228
format='experimental-branch6')
232
tree.commit('foo', rev_id='foo')
233
tree.commit('bar', rev_id='bar')
234
tree.commit('baz', rev_id='baz')
235
tree.set_last_revision('bar')
236
tree.branch.set_last_revision_info(2, 'bar')
237
tree.commit('qux', rev_id='qux')
238
tree.add_parent_tree_id('baz')
239
tree.commit('qux', rev_id='quxx')
240
tree.branch.set_last_revision_info(0, 'null:')
241
self.assertRaises(errors.NotLeftParentDescendant,
242
tree.branch.append_revision, 'bar')
243
tree.branch.append_revision('foo')
244
self.assertRaises(errors.NotLeftParentDescendant,
245
tree.branch.append_revision, 'baz')
246
tree.branch.append_revision('bar')
247
tree.branch.append_revision('baz')
248
self.assertRaises(errors.NotLeftParentDescendant,
249
tree.branch.append_revision, 'quxx')
254
class TestBranchReference(TestCaseWithTransport):
429
255
"""Tests for the branch reference facility."""
431
257
def test_create_open_reference(self):
432
258
bzrdirformat = bzrdir.BzrDirMetaFormat1()
433
t = transport.get_transport(self.get_url('.'))
259
t = get_transport(self.get_url('.'))
435
261
dir = bzrdirformat.initialize(self.get_url('repo'))
436
262
dir.create_repository()
437
263
target_branch = dir.create_branch()
438
264
t.mkdir('branch')
439
265
branch_dir = bzrdirformat.initialize(self.get_url('branch'))
440
made_branch = _mod_branch.BranchReferenceFormat().initialize(
441
branch_dir, target_branch=target_branch)
266
made_branch = bzrlib.branch.BranchReferenceFormat().initialize(branch_dir, target_branch)
442
267
self.assertEqual(made_branch.base, target_branch.base)
443
268
opened_branch = branch_dir.open_branch()
444
269
self.assertEqual(opened_branch.base, target_branch.base)
446
def test_get_reference(self):
447
"""For a BranchReference, get_reference should reutrn the location."""
448
branch = self.make_branch('target')
449
checkout = branch.create_checkout('checkout', lightweight=True)
450
reference_url = branch.bzrdir.root_transport.abspath('') + '/'
451
# if the api for create_checkout changes to return different checkout types
452
# then this file read will fail.
453
self.assertFileEqual(reference_url, 'checkout/.bzr/branch/location')
454
self.assertEqual(reference_url,
455
_mod_branch.BranchReferenceFormat().get_reference(checkout.bzrdir))
458
class TestHooks(tests.TestCaseWithTransport):
272
class TestHooks(TestCase):
460
274
def test_constructor(self):
461
275
"""Check that creating a BranchHooks instance has the right defaults."""
462
hooks = _mod_branch.BranchHooks()
276
hooks = bzrlib.branch.BranchHooks()
463
277
self.assertTrue("set_rh" in hooks, "set_rh not in %s" % hooks)
464
278
self.assertTrue("post_push" in hooks, "post_push not in %s" % hooks)
465
279
self.assertTrue("post_commit" in hooks, "post_commit not in %s" % hooks)
466
self.assertTrue("pre_commit" in hooks, "pre_commit not in %s" % hooks)
467
280
self.assertTrue("post_pull" in hooks, "post_pull not in %s" % hooks)
468
self.assertTrue("post_uncommit" in hooks,
469
"post_uncommit not in %s" % hooks)
470
self.assertTrue("post_change_branch_tip" in hooks,
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)
281
self.assertTrue("post_uncommit" in hooks, "post_uncommit not in %s" % hooks)
477
283
def test_installed_hooks_are_BranchHooks(self):
478
284
"""The installed hooks object should be a BranchHooks."""
479
285
# the installed hooks are saved in self._preserved_hooks.
480
self.assertIsInstance(self._preserved_hooks[_mod_branch.Branch][1],
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):
559
def test_pull_result_to_int(self):
560
# to support old code, the pull result can be used as an int
561
r = _mod_branch.PullResult()
564
# this usage of results is not recommended for new code (because it
565
# doesn't describe very well what happened), but for api stability
566
# it's still supported
567
a = "%d revisions pulled" % r
568
self.assertEqual(a, "10 revisions pulled")
570
def test_report_changed(self):
571
r = _mod_branch.PullResult()
572
r.old_revid = "old-revid"
574
r.new_revid = "new-revid"
578
self.assertEqual("Now on revision 20.\n", f.getvalue())
580
def test_report_unchanged(self):
581
r = _mod_branch.PullResult()
582
r.old_revid = "same-revid"
583
r.new_revid = "same-revid"
586
self.assertEqual("No revisions to pull.\n", f.getvalue())
589
class _StubLockable(object):
590
"""Helper for TestRunWithWriteLockedTarget."""
592
def __init__(self, calls, unlock_exc=None):
594
self.unlock_exc = unlock_exc
596
def lock_write(self):
597
self.calls.append('lock_write')
600
self.calls.append('unlock')
601
if self.unlock_exc is not None:
602
raise self.unlock_exc
605
class _ErrorFromCallable(Exception):
606
"""Helper for TestRunWithWriteLockedTarget."""
609
class _ErrorFromUnlock(Exception):
610
"""Helper for TestRunWithWriteLockedTarget."""
613
class TestRunWithWriteLockedTarget(tests.TestCase):
614
"""Tests for _run_with_write_locked_target."""
617
tests.TestCase.setUp(self)
620
def func_that_returns_ok(self):
621
self._calls.append('func called')
624
def func_that_raises(self):
625
self._calls.append('func called')
626
raise _ErrorFromCallable()
628
def test_success_unlocks(self):
629
lockable = _StubLockable(self._calls)
630
result = _mod_branch._run_with_write_locked_target(
631
lockable, self.func_that_returns_ok)
632
self.assertEqual('ok', result)
633
self.assertEqual(['lock_write', 'func called', 'unlock'], self._calls)
635
def test_exception_unlocks_and_propagates(self):
636
lockable = _StubLockable(self._calls)
637
self.assertRaises(_ErrorFromCallable,
638
_mod_branch._run_with_write_locked_target,
639
lockable, self.func_that_raises)
640
self.assertEqual(['lock_write', 'func called', 'unlock'], self._calls)
642
def test_callable_succeeds_but_error_during_unlock(self):
643
lockable = _StubLockable(self._calls, unlock_exc=_ErrorFromUnlock())
644
self.assertRaises(_ErrorFromUnlock,
645
_mod_branch._run_with_write_locked_target,
646
lockable, self.func_that_returns_ok)
647
self.assertEqual(['lock_write', 'func called', 'unlock'], self._calls)
649
def test_error_during_unlock_does_not_mask_original_error(self):
650
lockable = _StubLockable(self._calls, unlock_exc=_ErrorFromUnlock())
651
self.assertRaises(_ErrorFromCallable,
652
_mod_branch._run_with_write_locked_target,
653
lockable, self.func_that_raises)
654
self.assertEqual(['lock_write', 'func called', 'unlock'], self._calls)
286
self.assertIsInstance(self._preserved_hooks, bzrlib.branch.BranchHooks)
288
def test_install_hook_raises_unknown_hook(self):
289
"""install_hook should raise UnknownHook if a hook is unknown."""
290
hooks = bzrlib.branch.BranchHooks()
291
self.assertRaises(UnknownHook, hooks.install_hook, 'silly', None)
293
def test_install_hook_appends_known_hook(self):
294
"""install_hook should append the callable for known hooks."""
295
hooks = bzrlib.branch.BranchHooks()
296
hooks.install_hook('set_rh', None)
297
self.assertEqual(hooks['set_rh'], [None])