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):
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):
41
60
def test_default_format(self):
42
61
# update this if you change the default branch format
43
self.assertIsInstance(_mod_branch.BranchFormat.get_default_format(),
44
_mod_branch.BzrBranchFormat7)
62
self.assertIsInstance(BranchFormat.get_default_format(),
46
65
def test_default_format_is_same_as_bzrdir_default(self):
47
66
# XXX: it might be nice if there was only one place the default was
48
67
# set, but at the moment that's not true -- mbp 20070814 --
49
68
# https://bugs.launchpad.net/bzr/+bug/132376
51
_mod_branch.BranchFormat.get_default_format(),
52
bzrdir.BzrDirFormat.get_default_format().get_branch_format())
69
self.assertEqual(BranchFormat.get_default_format(),
70
BzrDirFormat.get_default_format().get_branch_format())
54
72
def test_get_set_default_format(self):
55
73
# 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())
74
old_format = BranchFormat.get_default_format()
75
BranchFormat.set_default_format(SampleBranchFormat())
59
77
# the default branch format is used by the meta dir format
60
78
# which is not the default bzrdir format at this point
61
dir = bzrdir.BzrDirMetaFormat1().initialize('memory:///')
79
dir = BzrDirMetaFormat1().initialize('memory:///')
62
80
result = dir.create_branch()
63
81
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):
83
BranchFormat.set_default_format(old_format)
84
self.assertEqual(old_format, BranchFormat.get_default_format())
87
class TestBranchFormat5(TestCaseWithTransport):
71
88
"""Tests specific to branch format 5"""
73
90
def test_branch_format_5_uses_lockdir(self):
74
91
url = self.get_url()
75
bdir = bzrdir.BzrDirMetaFormat1().initialize(url)
76
bdir.create_repository()
77
branch = bdir.create_branch()
92
bzrdir = BzrDirMetaFormat1().initialize(url)
93
bzrdir.create_repository()
94
branch = bzrdir.create_branch()
78
95
t = self.get_transport()
79
96
self.log("branch instance is %r" % branch)
80
self.assert_(isinstance(branch, _mod_branch.BzrBranch5))
97
self.assert_(isinstance(branch, BzrBranch5))
81
98
self.assertIsDirectory('.', t)
82
99
self.assertIsDirectory('.bzr/branch', t)
83
100
self.assertIsDirectory('.bzr/branch/lock', t)
84
101
branch.lock_write()
85
self.addCleanup(branch.unlock)
86
self.assertIsDirectory('.bzr/branch/lock/held', t)
103
self.assertIsDirectory('.bzr/branch/lock/held', t)
88
107
def test_set_push_location(self):
89
conf = config.LocationConfig.from_string('# comment\n', '.', save=True)
108
from bzrlib.config import (locations_config_filename,
109
ensure_config_dir_exists)
110
ensure_config_dir_exists()
111
fn = locations_config_filename()
112
# write correct newlines to locations.conf
113
# by default ConfigObj uses native line-endings for new files
114
# but uses already existing line-endings if file is not empty
117
f.write('# comment\n')
91
121
branch = self.make_branch('.', format='knit')
92
122
branch.set_push_location('foo')
112
142
"""See BzrBranchFormat.get_format_string()."""
113
143
return "Sample branch format."
115
def initialize(self, a_bzrdir, name=None):
145
def initialize(self, a_bzrdir):
116
146
"""Format 4 branches cannot be created."""
117
t = a_bzrdir.get_branch_transport(self, name=name)
147
t = a_bzrdir.get_branch_transport(self)
118
148
t.put_bytes('format', self.get_format_string())
119
149
return 'A branch'
121
151
def is_supported(self):
124
def open(self, transport, name=None, _found=False, ignore_fallbacks=False):
154
def open(self, transport, _found=False, ignore_fallbacks=False):
125
155
return "opened branch."
128
# Demonstrating how lazy loading is often implemented:
129
# A constant string is created.
130
SampleSupportedBranchFormatString = "Sample supported branch format."
132
# And the format class can then reference the constant to avoid skew.
133
class SampleSupportedBranchFormat(_mod_branch.BranchFormat):
134
"""A sample supported format."""
136
def get_format_string(self):
137
"""See BzrBranchFormat.get_format_string()."""
138
return SampleSupportedBranchFormatString
140
def initialize(self, a_bzrdir, name=None):
141
t = a_bzrdir.get_branch_transport(self, name=name)
142
t.put_bytes('format', self.get_format_string())
145
def open(self, transport, name=None, _found=False, ignore_fallbacks=False):
146
return "opened supported branch."
149
class TestBzrBranchFormat(tests.TestCaseWithTransport):
158
class TestBzrBranchFormat(TestCaseWithTransport):
150
159
"""Tests for the BzrBranchFormat facility."""
152
161
def test_find_format(self):
158
167
dir = format._matchingbzrdir.initialize(url)
159
168
dir.create_repository()
160
169
format.initialize(dir)
161
found_format = _mod_branch.BranchFormat.find_format(dir)
170
found_format = BranchFormat.find_format(dir)
162
171
self.failUnless(isinstance(found_format, format.__class__))
163
check_format(_mod_branch.BzrBranchFormat5(), "bar")
165
def test_find_format_factory(self):
166
dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
167
SampleSupportedBranchFormat().initialize(dir)
168
factory = _mod_branch.MetaDirBranchFormatFactory(
169
SampleSupportedBranchFormatString,
170
"bzrlib.tests.test_branch", "SampleSupportedBranchFormat")
171
_mod_branch.BranchFormat.register_format(factory)
172
self.addCleanup(_mod_branch.BranchFormat.unregister_format, factory)
173
b = _mod_branch.Branch.open(self.get_url())
174
self.assertEqual(b, "opened supported branch.")
172
check_format(BzrBranchFormat5(), "bar")
176
174
def test_find_format_not_branch(self):
177
175
dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
178
self.assertRaises(errors.NotBranchError,
179
_mod_branch.BranchFormat.find_format,
176
self.assertRaises(NotBranchError,
177
BranchFormat.find_format,
182
180
def test_find_format_unknown_format(self):
183
181
dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
184
182
SampleBranchFormat().initialize(dir)
185
self.assertRaises(errors.UnknownFormatError,
186
_mod_branch.BranchFormat.find_format,
183
self.assertRaises(UnknownFormatError,
184
BranchFormat.find_format,
189
187
def test_register_unregister_format(self):
194
192
format.initialize(dir)
195
193
# register a format for it.
196
_mod_branch.BranchFormat.register_format(format)
194
BranchFormat.register_format(format)
197
195
# which branch.Open will refuse (not supported)
198
self.assertRaises(errors.UnsupportedFormatError,
199
_mod_branch.Branch.open, self.get_url())
196
self.assertRaises(UnsupportedFormatError, Branch.open, self.get_url())
200
197
self.make_branch_and_tree('foo')
201
198
# but open_downlevel will work
204
bzrdir.BzrDir.open(self.get_url()).open_branch(unsupported=True))
199
self.assertEqual(format.open(dir), bzrdir.BzrDir.open(self.get_url()).open_branch(unsupported=True))
205
200
# unregister the format
206
_mod_branch.BranchFormat.unregister_format(format)
201
BranchFormat.unregister_format(format)
207
202
self.make_branch_and_tree('bar')
210
#Used by TestMetaDirBranchFormatFactory
211
FakeLazyFormat = None
214
class TestMetaDirBranchFormatFactory(tests.TestCase):
216
def test_get_format_string_does_not_load(self):
217
"""Formats have a static format string."""
218
factory = _mod_branch.MetaDirBranchFormatFactory("yo", None, None)
219
self.assertEqual("yo", factory.get_format_string())
221
def test_call_loads(self):
222
# __call__ is used by the network_format_registry interface to get a
224
global FakeLazyFormat
226
factory = _mod_branch.MetaDirBranchFormatFactory(None,
227
"bzrlib.tests.test_branch", "FakeLazyFormat")
228
self.assertRaises(AttributeError, factory)
230
def test_call_returns_call_of_referenced_object(self):
231
global FakeLazyFormat
232
FakeLazyFormat = lambda:'called'
233
factory = _mod_branch.MetaDirBranchFormatFactory(None,
234
"bzrlib.tests.test_branch", "FakeLazyFormat")
235
self.assertEqual('called', factory())
238
205
class TestBranch67(object):
239
206
"""Common tests for both branch 6 and 7 which are mostly the same."""
469
435
branch.lock_write()
470
436
branch.set_reference_info('file-id', 'path2', 'location2')
472
doppelganger = _mod_branch.Branch.open('branch')
438
doppelganger = Branch.open('branch')
473
439
doppelganger.set_reference_info('file-id', 'path3', 'location3')
474
440
self.assertEqual(('path3', 'location3'),
475
441
branch.get_reference_info('file-id'))
477
class TestBranchReference(tests.TestCaseWithTransport):
443
class TestBranchReference(TestCaseWithTransport):
478
444
"""Tests for the branch reference facility."""
480
446
def test_create_open_reference(self):
481
447
bzrdirformat = bzrdir.BzrDirMetaFormat1()
482
t = transport.get_transport(self.get_url('.'))
448
t = get_transport(self.get_url('.'))
484
450
dir = bzrdirformat.initialize(self.get_url('repo'))
485
451
dir.create_repository()
486
452
target_branch = dir.create_branch()
487
453
t.mkdir('branch')
488
454
branch_dir = bzrdirformat.initialize(self.get_url('branch'))
489
made_branch = _mod_branch.BranchReferenceFormat().initialize(
490
branch_dir, target_branch=target_branch)
455
made_branch = BranchReferenceFormat().initialize(branch_dir, target_branch)
491
456
self.assertEqual(made_branch.base, target_branch.base)
492
457
opened_branch = branch_dir.open_branch()
493
458
self.assertEqual(opened_branch.base, target_branch.base)
504
469
_mod_branch.BranchReferenceFormat().get_reference(checkout.bzrdir))
507
class TestHooks(tests.TestCaseWithTransport):
472
class TestHooks(TestCase):
509
474
def test_constructor(self):
510
475
"""Check that creating a BranchHooks instance has the right defaults."""
511
hooks = _mod_branch.BranchHooks()
476
hooks = BranchHooks()
512
477
self.assertTrue("set_rh" in hooks, "set_rh not in %s" % hooks)
513
478
self.assertTrue("post_push" in hooks, "post_push not in %s" % hooks)
514
479
self.assertTrue("post_commit" in hooks, "post_commit not in %s" % hooks)
515
480
self.assertTrue("pre_commit" in hooks, "pre_commit not in %s" % hooks)
516
481
self.assertTrue("post_pull" in hooks, "post_pull not in %s" % hooks)
517
self.assertTrue("post_uncommit" in hooks,
518
"post_uncommit not in %s" % hooks)
482
self.assertTrue("post_uncommit" in hooks, "post_uncommit not in %s" % hooks)
519
483
self.assertTrue("post_change_branch_tip" in hooks,
520
484
"post_change_branch_tip not in %s" % hooks)
521
self.assertTrue("post_branch_init" in hooks,
522
"post_branch_init not in %s" % hooks)
523
self.assertTrue("post_switch" in hooks,
524
"post_switch not in %s" % hooks)
526
486
def test_installed_hooks_are_BranchHooks(self):
527
487
"""The installed hooks object should be a BranchHooks."""
528
488
# the installed hooks are saved in self._preserved_hooks.
529
489
self.assertIsInstance(self._preserved_hooks[_mod_branch.Branch][1],
530
_mod_branch.BranchHooks)
532
def test_post_branch_init_hook(self):
534
_mod_branch.Branch.hooks.install_named_hook('post_branch_init',
536
self.assertLength(0, calls)
537
branch = self.make_branch('a')
538
self.assertLength(1, calls)
540
self.assertIsInstance(params, _mod_branch.BranchInitHookParams)
541
self.assertTrue(hasattr(params, 'bzrdir'))
542
self.assertTrue(hasattr(params, 'branch'))
544
def test_post_branch_init_hook_repr(self):
546
_mod_branch.Branch.hooks.install_named_hook('post_branch_init',
547
lambda params: param_reprs.append(repr(params)), None)
548
branch = self.make_branch('a')
549
self.assertLength(1, param_reprs)
550
param_repr = param_reprs[0]
551
self.assertStartsWith(param_repr, '<BranchInitHookParams of ')
553
def test_post_switch_hook(self):
554
from bzrlib import switch
556
_mod_branch.Branch.hooks.install_named_hook('post_switch',
558
tree = self.make_branch_and_tree('branch-1')
559
self.build_tree(['branch-1/file-1'])
562
to_branch = tree.bzrdir.sprout('branch-2').open_branch()
563
self.build_tree(['branch-1/file-2'])
565
tree.remove('file-1')
567
checkout = tree.branch.create_checkout('checkout')
568
self.assertLength(0, calls)
569
switch.switch(checkout.bzrdir, to_branch)
570
self.assertLength(1, calls)
572
self.assertIsInstance(params, _mod_branch.SwitchHookParams)
573
self.assertTrue(hasattr(params, 'to_branch'))
574
self.assertTrue(hasattr(params, 'revision_id'))
577
class TestBranchOptions(tests.TestCaseWithTransport):
580
super(TestBranchOptions, self).setUp()
581
self.branch = self.make_branch('.')
582
self.config = self.branch.get_config()
584
def check_append_revisions_only(self, expected_value, value=None):
585
"""Set append_revisions_only in config and check its interpretation."""
586
if value is not None:
587
self.config.set_user_option('append_revisions_only', value)
588
self.assertEqual(expected_value,
589
self.branch._get_append_revisions_only())
591
def test_valid_append_revisions_only(self):
592
self.assertEquals(None,
593
self.config.get_user_option('append_revisions_only'))
594
self.check_append_revisions_only(None)
595
self.check_append_revisions_only(False, 'False')
596
self.check_append_revisions_only(True, 'True')
597
# The following values will cause compatibility problems on projects
598
# using older bzr versions (<2.2) but are accepted
599
self.check_append_revisions_only(False, 'false')
600
self.check_append_revisions_only(True, 'true')
602
def test_invalid_append_revisions_only(self):
603
"""Ensure warning is noted on invalid settings"""
606
self.warnings.append(args[0] % args[1:])
607
self.overrideAttr(trace, 'warning', warning)
608
self.check_append_revisions_only(None, 'not-a-bool')
609
self.assertLength(1, self.warnings)
611
'Value "not-a-bool" is not a boolean for "append_revisions_only"',
615
class TestPullResult(tests.TestCase):
493
class TestPullResult(TestCase):
617
495
def test_pull_result_to_int(self):
618
496
# to support old code, the pull result can be used as an int
619
r = _mod_branch.PullResult()
622
500
# this usage of results is not recommended for new code (because it
693
554
def test_exception_unlocks_and_propagates(self):
694
555
lockable = _StubLockable(self._calls)
695
556
self.assertRaises(_ErrorFromCallable,
696
_mod_branch._run_with_write_locked_target,
697
lockable, self.func_that_raises)
557
_run_with_write_locked_target, lockable, self.func_that_raises)
698
558
self.assertEqual(['lock_write', 'func called', 'unlock'], self._calls)
700
560
def test_callable_succeeds_but_error_during_unlock(self):
701
561
lockable = _StubLockable(self._calls, unlock_exc=_ErrorFromUnlock())
702
562
self.assertRaises(_ErrorFromUnlock,
703
_mod_branch._run_with_write_locked_target,
704
lockable, self.func_that_returns_ok)
563
_run_with_write_locked_target, lockable, self.func_that_returns_ok)
705
564
self.assertEqual(['lock_write', 'func called', 'unlock'], self._calls)
707
566
def test_error_during_unlock_does_not_mask_original_error(self):
708
567
lockable = _StubLockable(self._calls, unlock_exc=_ErrorFromUnlock())
709
568
self.assertRaises(_ErrorFromCallable,
710
_mod_branch._run_with_write_locked_target,
711
lockable, self.func_that_raises)
569
_run_with_write_locked_target, lockable, self.func_that_raises)
712
570
self.assertEqual(['lock_write', 'func called', 'unlock'], self._calls)