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/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 cStringIO import StringIO
28
26
branch as _mod_branch,
35
branch as _mod_bzrbranch,
38
from ..bzr.fullhistory import (
42
from ..sixish import (
47
class TestErrors(tests.TestCase):
49
def test_unstackable_branch_format(self):
52
error = _mod_branch.UnstackableBranchFormat(format, url)
54
"The branch '/foo'(foo) is not a stackable format. "
55
"You will need to upgrade the branch to permit branch stacking.",
39
59
class TestDefaultFormat(tests.TestCase):
41
61
def test_default_format(self):
42
62
# update this if you change the default branch format
43
self.assertIsInstance(_mod_branch.BranchFormat.get_default_format(),
44
_mod_branch.BzrBranchFormat7)
63
self.assertIsInstance(_mod_branch.format_registry.get_default(),
64
_mod_bzrbranch.BzrBranchFormat7)
46
66
def test_default_format_is_same_as_bzrdir_default(self):
47
67
# XXX: it might be nice if there was only one place the default was
48
68
# set, but at the moment that's not true -- mbp 20070814 --
49
69
# https://bugs.launchpad.net/bzr/+bug/132376
51
_mod_branch.BranchFormat.get_default_format(),
71
_mod_branch.format_registry.get_default(),
52
72
bzrdir.BzrDirFormat.get_default_format().get_branch_format())
54
74
def test_get_set_default_format(self):
55
75
# 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())
76
old_format = _mod_branch.format_registry.get_default()
77
_mod_branch.format_registry.set_default(
59
80
# the default branch format is used by the meta dir format
60
81
# which is not the default bzrdir format at this point
86
107
self.assertIsDirectory('.bzr/branch/lock/held', t)
88
109
def test_set_push_location(self):
89
from bzrlib.config import (locations_config_filename,
90
ensure_config_dir_exists)
91
ensure_config_dir_exists()
92
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')
110
conf = config.LocationConfig.from_string('# comment\n', '.', save=True)
102
112
branch = self.make_branch('.', format='knit')
103
113
branch.set_push_location('foo')
104
114
local_path = urlutils.local_path_from_url(branch.base[:-1])
105
self.assertFileEqual("# comment\n"
107
"push_location = foo\n"
108
"push_location:policy = norecurse\n" % local_path,
115
self.assertFileEqual(b"# comment\n"
117
b"push_location = foo\n"
118
b"push_location:policy = norecurse\n" % local_path,
119
config.locations_config_filename())
111
121
# TODO RBC 20051029 test getting a push location from a branch in a
112
122
# recursive section - that is, it appends the branch name.
115
class SampleBranchFormat(_mod_branch.BranchFormat):
125
class SampleBranchFormat(_mod_bzrbranch.BranchFormatMetadir):
116
126
"""A sample format
118
128
this format is initializable, unsupported to aid in testing the
119
129
open and open_downlevel routines.
122
def get_format_string(self):
133
def get_format_string(cls):
123
134
"""See BzrBranchFormat.get_format_string()."""
124
return "Sample branch format."
135
return b"Sample branch format."
126
def initialize(self, a_bzrdir, name=None):
137
def initialize(self, a_controldir, name=None, repository=None,
138
append_revisions_only=None):
127
139
"""Format 4 branches cannot be created."""
128
t = a_bzrdir.get_branch_transport(self, name=name)
140
t = a_controldir.get_branch_transport(self, name=name)
129
141
t.put_bytes('format', self.get_format_string())
130
142
return 'A branch'
132
144
def is_supported(self):
135
def open(self, transport, name=None, _found=False, ignore_fallbacks=False):
147
def open(self, transport, name=None, _found=False, ignore_fallbacks=False,
148
possible_transports=None):
136
149
return "opened branch."
152
# Demonstrating how lazy loading is often implemented:
153
# A constant string is created.
154
SampleSupportedBranchFormatString = b"Sample supported branch format."
156
# And the format class can then reference the constant to avoid skew.
157
class SampleSupportedBranchFormat(_mod_bzrbranch.BranchFormatMetadir):
158
"""A sample supported format."""
161
def get_format_string(cls):
162
"""See BzrBranchFormat.get_format_string()."""
163
return SampleSupportedBranchFormatString
165
def initialize(self, a_controldir, name=None, append_revisions_only=None):
166
t = a_controldir.get_branch_transport(self, name=name)
167
t.put_bytes('format', self.get_format_string())
170
def open(self, transport, name=None, _found=False, ignore_fallbacks=False,
171
possible_transports=None):
172
return "opened supported branch."
175
class SampleExtraBranchFormat(_mod_branch.BranchFormat):
176
"""A sample format that is not usable in a metadir."""
178
def get_format_string(self):
179
# This format is not usable in a metadir.
182
def network_name(self):
183
# Network name always has to be provided.
186
def initialize(self, a_controldir, name=None):
187
raise NotImplementedError(self.initialize)
189
def open(self, transport, name=None, _found=False, ignore_fallbacks=False,
190
possible_transports=None):
191
raise NotImplementedError(self.open)
139
194
class TestBzrBranchFormat(tests.TestCaseWithTransport):
140
195
"""Tests for the BzrBranchFormat facility."""
145
200
# this is not quite the same as
146
201
self.build_tree(["foo/", "bar/"])
147
202
def check_format(format, url):
148
dir = format._matchingbzrdir.initialize(url)
203
dir = format._matchingcontroldir.initialize(url)
149
204
dir.create_repository()
150
205
format.initialize(dir)
151
found_format = _mod_branch.BranchFormat.find_format(dir)
152
self.failUnless(isinstance(found_format, format.__class__))
153
check_format(_mod_branch.BzrBranchFormat5(), "bar")
206
found_format = _mod_bzrbranch.BranchFormatMetadir.find_format(dir)
207
self.assertIsInstance(found_format, format.__class__)
208
check_format(BzrBranchFormat5(), "bar")
210
def test_from_string(self):
211
self.assertIsInstance(
212
SampleBranchFormat.from_string(b"Sample branch format."),
214
self.assertRaises(AssertionError,
215
SampleBranchFormat.from_string, b"Different branch format.")
155
217
def test_find_format_not_branch(self):
156
218
dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
157
219
self.assertRaises(errors.NotBranchError,
158
_mod_branch.BranchFormat.find_format,
220
_mod_bzrbranch.BranchFormatMetadir.find_format,
161
223
def test_find_format_unknown_format(self):
162
224
dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
163
225
SampleBranchFormat().initialize(dir)
164
226
self.assertRaises(errors.UnknownFormatError,
165
_mod_branch.BranchFormat.find_format,
227
_mod_bzrbranch.BranchFormatMetadir.find_format,
230
def test_find_format_with_features(self):
231
tree = self.make_branch_and_tree('.', format='2a')
232
tree.branch.update_feature_flags({b"name": b"optional"})
233
found_format = _mod_bzrbranch.BranchFormatMetadir.find_format(tree.controldir)
234
self.assertIsInstance(found_format, _mod_bzrbranch.BranchFormatMetadir)
235
self.assertEqual(found_format.features.get(b"name"), b"optional")
236
tree.branch.update_feature_flags({b"name": None})
237
branch = _mod_branch.Branch.open('.')
238
self.assertEqual(branch._format.features, {})
241
class TestBranchFormatRegistry(tests.TestCase):
244
super(TestBranchFormatRegistry, self).setUp()
245
self.registry = _mod_branch.BranchFormatRegistry()
247
def test_default(self):
248
self.assertIs(None, self.registry.get_default())
249
format = SampleBranchFormat()
250
self.registry.set_default(format)
251
self.assertEqual(format, self.registry.get_default())
168
253
def test_register_unregister_format(self):
169
254
format = SampleBranchFormat()
171
dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
173
format.initialize(dir)
174
# register a format for it.
175
_mod_branch.BranchFormat.register_format(format)
176
# which branch.Open will refuse (not supported)
177
self.assertRaises(errors.UnsupportedFormatError,
178
_mod_branch.Branch.open, self.get_url())
179
self.make_branch_and_tree('foo')
180
# but open_downlevel will work
183
bzrdir.BzrDir.open(self.get_url()).open_branch(unsupported=True))
184
# unregister the format
185
_mod_branch.BranchFormat.unregister_format(format)
186
self.make_branch_and_tree('bar')
255
self.registry.register(format)
256
self.assertEqual(format,
257
self.registry.get(b"Sample branch format."))
258
self.registry.remove(format)
259
self.assertRaises(KeyError, self.registry.get,
260
b"Sample branch format.")
262
def test_get_all(self):
263
format = SampleBranchFormat()
264
self.assertEqual([], self.registry._get_all())
265
self.registry.register(format)
266
self.assertEqual([format], self.registry._get_all())
268
def test_register_extra(self):
269
format = SampleExtraBranchFormat()
270
self.assertEqual([], self.registry._get_all())
271
self.registry.register_extra(format)
272
self.assertEqual([format], self.registry._get_all())
274
def test_register_extra_lazy(self):
275
self.assertEqual([], self.registry._get_all())
276
self.registry.register_extra_lazy("breezy.tests.test_branch",
277
"SampleExtraBranchFormat")
278
formats = self.registry._get_all()
279
self.assertEqual(1, len(formats))
280
self.assertIsInstance(formats[0], SampleExtraBranchFormat)
189
283
class TestBranch67(object):
211
305
def test_layout(self):
212
306
branch = self.make_branch('a', format=self.get_format_name())
213
self.failUnlessExists('a/.bzr/branch/last-revision')
214
self.failIfExists('a/.bzr/branch/revision-history')
215
self.failIfExists('a/.bzr/branch/references')
307
self.assertPathExists('a/.bzr/branch/last-revision')
308
self.assertPathDoesNotExist('a/.bzr/branch/revision-history')
309
self.assertPathDoesNotExist('a/.bzr/branch/references')
217
311
def test_config(self):
218
312
"""Ensure that all configuration data is stored in the branch"""
219
313
branch = self.make_branch('a', format=self.get_format_name())
220
branch.set_parent('http://bazaar-vcs.org')
221
self.failIfExists('a/.bzr/branch/parent')
222
self.assertEqual('http://bazaar-vcs.org', branch.get_parent())
223
branch.set_push_location('sftp://bazaar-vcs.org')
224
config = branch.get_config()._get_branch_data_config()
225
self.assertEqual('sftp://bazaar-vcs.org',
226
config.get_user_option('push_location'))
227
branch.set_bound_location('ftp://bazaar-vcs.org')
228
self.failIfExists('a/.bzr/branch/bound')
229
self.assertEqual('ftp://bazaar-vcs.org', branch.get_bound_location())
231
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'])
314
branch.set_parent('http://example.com')
315
self.assertPathDoesNotExist('a/.bzr/branch/parent')
316
self.assertEqual('http://example.com', branch.get_parent())
317
branch.set_push_location('sftp://example.com')
318
conf = branch.get_config_stack()
319
self.assertEqual('sftp://example.com', conf.get('push_location'))
320
branch.set_bound_location('ftp://example.com')
321
self.assertPathDoesNotExist('a/.bzr/branch/bound')
322
self.assertEqual('ftp://example.com', branch.get_bound_location())
245
324
def do_checkout_test(self, lightweight=False):
246
325
tree = self.make_branch_and_tree('source',
409
472
branch.lock_write()
410
473
self.instrument_branch(branch, gets)
411
474
self.addCleanup(branch.unlock)
412
branch._set_all_reference_info({'file-id': ('path2', 'location2')})
413
path, location = branch.get_reference_info('file-id')
475
branch._set_all_reference_info({'path2': ('location2', b'file-id')})
476
location, file_id = branch.get_reference_info('path2')
414
477
self.assertEqual(0, len(gets))
415
self.assertEqual('path2', path)
478
self.assertEqual(b'file-id', file_id)
416
479
self.assertEqual('location2', location)
418
481
def test_reference_info_caches_cleared(self):
419
482
branch = self.make_branch('branch')
421
branch.set_reference_info('file-id', 'path2', 'location2')
483
with branch.lock_write():
484
branch.set_reference_info('path2', 'location2', b'file-id')
423
485
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'))
486
doppelganger.set_reference_info('path3', 'location3', b'file-id')
487
self.assertEqual(('location3', b'file-id'),
488
branch.get_reference_info('path3'))
490
def _recordParentMapCalls(self, repo):
491
self._parent_map_calls = []
492
orig_get_parent_map = repo.revisions.get_parent_map
493
def get_parent_map(q):
495
self._parent_map_calls.extend([e[0] for e in q])
496
return orig_get_parent_map(q)
497
repo.revisions.get_parent_map = get_parent_map
428
500
class TestBranchReference(tests.TestCaseWithTransport):
429
501
"""Tests for the branch reference facility."""
431
503
def test_create_open_reference(self):
432
504
bzrdirformat = bzrdir.BzrDirMetaFormat1()
433
t = transport.get_transport(self.get_url('.'))
505
t = self.get_transport()
435
507
dir = bzrdirformat.initialize(self.get_url('repo'))
436
508
dir.create_repository()
437
509
target_branch = dir.create_branch()
438
510
t.mkdir('branch')
439
511
branch_dir = bzrdirformat.initialize(self.get_url('branch'))
440
made_branch = _mod_branch.BranchReferenceFormat().initialize(
512
made_branch = _mod_bzrbranch.BranchReferenceFormat().initialize(
441
513
branch_dir, target_branch=target_branch)
442
514
self.assertEqual(made_branch.base, target_branch.base)
443
515
opened_branch = branch_dir.open_branch()
444
516
self.assertEqual(opened_branch.base, target_branch.base)
446
518
def test_get_reference(self):
447
"""For a BranchReference, get_reference should reutrn the location."""
519
"""For a BranchReference, get_reference should return the location."""
448
520
branch = self.make_branch('target')
449
521
checkout = branch.create_checkout('checkout', lightweight=True)
450
reference_url = branch.bzrdir.root_transport.abspath('') + '/'
522
reference_url = branch.controldir.root_transport.abspath('') + '/'
451
523
# if the api for create_checkout changes to return different checkout types
452
524
# then this file read will fail.
453
self.assertFileEqual(reference_url, 'checkout/.bzr/branch/location')
525
self.assertFileEqual(reference_url.encode('utf-8'),
526
'checkout/.bzr/branch/location')
454
527
self.assertEqual(reference_url,
455
_mod_branch.BranchReferenceFormat().get_reference(checkout.bzrdir))
528
_mod_bzrbranch.BranchReferenceFormat().get_reference(checkout.controldir))
458
531
class TestHooks(tests.TestCaseWithTransport):
550
631
self.check_append_revisions_only(None, 'not-a-bool')
551
632
self.assertLength(1, self.warnings)
552
633
self.assertEqual(
553
'Value "not-a-bool" is not a boolean for "append_revisions_only"',
634
'Value "not-a-bool" is not valid for "append_revisions_only"',
554
635
self.warnings[0])
637
def test_use_fresh_values(self):
638
copy = _mod_branch.Branch.open(self.branch.base)
641
copy.get_config_stack().set('foo', 'bar')
644
self.assertFalse(self.branch.is_locked())
645
# Since the branch is locked, the option value won't be saved on disk
646
# so trying to access the config of locked branch via another older
647
# non-locked branch object pointing to the same branch is not supported
648
self.assertEqual(None, self.branch.get_config_stack().get('foo'))
649
# Using a newly created branch object works as expected
650
fresh = _mod_branch.Branch.open(self.branch.base)
651
self.assertEqual('bar', fresh.get_config_stack().get('foo'))
653
def test_set_from_config_get_from_config_stack(self):
654
self.branch.lock_write()
655
self.addCleanup(self.branch.unlock)
656
self.branch.get_config().set_user_option('foo', 'bar')
657
result = self.branch.get_config_stack().get('foo')
658
# https://bugs.launchpad.net/bzr/+bug/948344
659
self.expectFailure('BranchStack uses cache after set_user_option',
660
self.assertEqual, 'bar', result)
662
def test_set_from_config_stack_get_from_config(self):
663
self.branch.lock_write()
664
self.addCleanup(self.branch.unlock)
665
self.branch.get_config_stack().set('foo', 'bar')
666
# Since the branch is locked, the option value won't be saved on disk
667
# so mixing get() and get_user_option() is broken by design.
668
self.assertEqual(None,
669
self.branch.get_config().get_user_option('foo'))
671
def test_set_delays_write_when_branch_is_locked(self):
672
self.branch.lock_write()
673
self.addCleanup(self.branch.unlock)
674
self.branch.get_config_stack().set('foo', 'bar')
675
copy = _mod_branch.Branch.open(self.branch.base)
676
result = copy.get_config_stack().get('foo')
677
# Accessing from a different branch object is like accessing from a
678
# different process: the option has not been saved yet and the new
679
# value cannot be seen.
680
self.assertIs(None, result)
557
683
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
685
def test_report_changed(self):
571
686
r = _mod_branch.PullResult()
572
r.old_revid = "old-revid"
687
r.old_revid = b"old-revid"
574
r.new_revid = "new-revid"
689
r.new_revid = b"new-revid"
578
self.assertEqual("Now on revision 20.\n", f.getvalue())
693
self.assertEqual(b"Now on revision 20.\n", f.getvalue())
694
self.assertEqual(b"Now on revision 20.\n", f.getvalue())
580
696
def test_report_unchanged(self):
581
697
r = _mod_branch.PullResult()
582
r.old_revid = "same-revid"
583
r.new_revid = "same-revid"
698
r.old_revid = b"same-revid"
699
r.new_revid = b"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)
702
self.assertEqual(b"No revisions or tags to pull.\n", f.getvalue())