48
48
# set, but at the moment that's not true -- mbp 20070814 --
49
49
# https://bugs.launchpad.net/bzr/+bug/132376
51
_mod_branch.BranchFormat.get_default_format(),
51
_mod_branch.format_registry.get_default(),
52
52
bzrdir.BzrDirFormat.get_default_format().get_branch_format())
54
54
def test_get_set_default_format(self):
55
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())
56
old_format = _mod_branch.format_registry.get_default()
57
_mod_branch.format_registry.set_default(SampleBranchFormat())
59
59
# the default branch format is used by the meta dir format
60
60
# which is not the default bzrdir format at this point
86
86
self.assertIsDirectory('.bzr/branch/lock/held', t)
88
88
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')
89
conf = config.LocationConfig.from_string('# comment\n', '.', save=True)
102
91
branch = self.make_branch('.', format='knit')
103
92
branch.set_push_location('foo')
107
96
"push_location = foo\n"
108
97
"push_location:policy = norecurse\n" % local_path,
98
config.locations_config_filename())
111
100
# TODO RBC 20051029 test getting a push location from a branch in a
112
101
# recursive section - that is, it appends the branch name.
115
class SampleBranchFormat(_mod_branch.BranchFormat):
104
class SampleBranchFormat(_mod_branch.BranchFormatMetadir):
116
105
"""A sample format
118
107
this format is initializable, unsupported to aid in testing the
119
108
open and open_downlevel routines.
122
def get_format_string(self):
112
def get_format_string(cls):
123
113
"""See BzrBranchFormat.get_format_string()."""
124
114
return "Sample branch format."
126
def initialize(self, a_bzrdir):
116
def initialize(self, a_bzrdir, name=None, repository=None,
117
append_revisions_only=None):
127
118
"""Format 4 branches cannot be created."""
128
t = a_bzrdir.get_branch_transport(self)
119
t = a_bzrdir.get_branch_transport(self, name=name)
129
120
t.put_bytes('format', self.get_format_string())
130
121
return 'A branch'
132
123
def is_supported(self):
135
def open(self, transport, _found=False, ignore_fallbacks=False):
126
def open(self, transport, name=None, _found=False, ignore_fallbacks=False,
127
possible_transports=None):
136
128
return "opened branch."
131
# Demonstrating how lazy loading is often implemented:
132
# A constant string is created.
133
SampleSupportedBranchFormatString = "Sample supported branch format."
135
# And the format class can then reference the constant to avoid skew.
136
class SampleSupportedBranchFormat(_mod_branch.BranchFormatMetadir):
137
"""A sample supported format."""
140
def get_format_string(cls):
141
"""See BzrBranchFormat.get_format_string()."""
142
return SampleSupportedBranchFormatString
144
def initialize(self, a_bzrdir, name=None, append_revisions_only=None):
145
t = a_bzrdir.get_branch_transport(self, name=name)
146
t.put_bytes('format', self.get_format_string())
149
def open(self, transport, name=None, _found=False, ignore_fallbacks=False,
150
possible_transports=None):
151
return "opened supported branch."
154
class SampleExtraBranchFormat(_mod_branch.BranchFormat):
155
"""A sample format that is not usable in a metadir."""
157
def get_format_string(self):
158
# This format is not usable in a metadir.
161
def network_name(self):
162
# Network name always has to be provided.
165
def initialize(self, a_bzrdir, name=None):
166
raise NotImplementedError(self.initialize)
168
def open(self, transport, name=None, _found=False, ignore_fallbacks=False,
169
possible_transports=None):
170
raise NotImplementedError(self.open)
139
173
class TestBzrBranchFormat(tests.TestCaseWithTransport):
140
174
"""Tests for the BzrBranchFormat facility."""
148
182
dir = format._matchingbzrdir.initialize(url)
149
183
dir.create_repository()
150
184
format.initialize(dir)
151
found_format = _mod_branch.BranchFormat.find_format(dir)
152
self.failUnless(isinstance(found_format, format.__class__))
185
found_format = _mod_branch.BranchFormatMetadir.find_format(dir)
186
self.assertIsInstance(found_format, format.__class__)
153
187
check_format(_mod_branch.BzrBranchFormat5(), "bar")
189
def test_find_format_factory(self):
190
dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
191
SampleSupportedBranchFormat().initialize(dir)
192
factory = _mod_branch.MetaDirBranchFormatFactory(
193
SampleSupportedBranchFormatString,
194
"bzrlib.tests.test_branch", "SampleSupportedBranchFormat")
195
_mod_branch.format_registry.register(factory)
196
self.addCleanup(_mod_branch.format_registry.remove, factory)
197
b = _mod_branch.Branch.open(self.get_url())
198
self.assertEqual(b, "opened supported branch.")
200
def test_from_string(self):
201
self.assertIsInstance(
202
SampleBranchFormat.from_string("Sample branch format."),
204
self.assertRaises(AssertionError,
205
SampleBranchFormat.from_string, "Different branch format.")
155
207
def test_find_format_not_branch(self):
156
208
dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
157
209
self.assertRaises(errors.NotBranchError,
158
_mod_branch.BranchFormat.find_format,
210
_mod_branch.BranchFormatMetadir.find_format,
161
213
def test_find_format_unknown_format(self):
162
214
dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
163
215
SampleBranchFormat().initialize(dir)
164
216
self.assertRaises(errors.UnknownFormatError,
165
_mod_branch.BranchFormat.find_format,
217
_mod_branch.BranchFormatMetadir.find_format,
220
def test_find_format_with_features(self):
221
tree = self.make_branch_and_tree('.', format='2a')
222
tree.branch.update_feature_flags({"name": "optional"})
223
found_format = _mod_branch.BranchFormatMetadir.find_format(tree.bzrdir)
224
self.assertIsInstance(found_format, _mod_branch.BranchFormatMetadir)
225
self.assertEquals(found_format.features.get("name"), "optional")
226
tree.branch.update_feature_flags({"name": None})
227
branch = _mod_branch.Branch.open('.')
228
self.assertEquals(branch._format.features, {})
168
230
def test_register_unregister_format(self):
231
# Test the deprecated format registration functions
169
232
format = SampleBranchFormat()
170
233
# make a control dir
171
234
dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
173
236
format.initialize(dir)
174
237
# register a format for it.
175
_mod_branch.BranchFormat.register_format(format)
238
self.applyDeprecated(symbol_versioning.deprecated_in((2, 4, 0)),
239
_mod_branch.BranchFormat.register_format, format)
176
240
# which branch.Open will refuse (not supported)
177
241
self.assertRaises(errors.UnsupportedFormatError,
178
242
_mod_branch.Branch.open, self.get_url())
182
246
format.open(dir),
183
247
bzrdir.BzrDir.open(self.get_url()).open_branch(unsupported=True))
184
248
# unregister the format
185
_mod_branch.BranchFormat.unregister_format(format)
249
self.applyDeprecated(symbol_versioning.deprecated_in((2, 4, 0)),
250
_mod_branch.BranchFormat.unregister_format, format)
186
251
self.make_branch_and_tree('bar')
254
class TestBranchFormatRegistry(tests.TestCase):
257
super(TestBranchFormatRegistry, self).setUp()
258
self.registry = _mod_branch.BranchFormatRegistry()
260
def test_default(self):
261
self.assertIs(None, self.registry.get_default())
262
format = SampleBranchFormat()
263
self.registry.set_default(format)
264
self.assertEquals(format, self.registry.get_default())
266
def test_register_unregister_format(self):
267
format = SampleBranchFormat()
268
self.registry.register(format)
269
self.assertEquals(format,
270
self.registry.get("Sample branch format."))
271
self.registry.remove(format)
272
self.assertRaises(KeyError, self.registry.get,
273
"Sample branch format.")
275
def test_get_all(self):
276
format = SampleBranchFormat()
277
self.assertEquals([], self.registry._get_all())
278
self.registry.register(format)
279
self.assertEquals([format], self.registry._get_all())
281
def test_register_extra(self):
282
format = SampleExtraBranchFormat()
283
self.assertEquals([], self.registry._get_all())
284
self.registry.register_extra(format)
285
self.assertEquals([format], self.registry._get_all())
287
def test_register_extra_lazy(self):
288
self.assertEquals([], self.registry._get_all())
289
self.registry.register_extra_lazy("bzrlib.tests.test_branch",
290
"SampleExtraBranchFormat")
291
formats = self.registry._get_all()
292
self.assertEquals(1, len(formats))
293
self.assertIsInstance(formats[0], SampleExtraBranchFormat)
296
#Used by TestMetaDirBranchFormatFactory
297
FakeLazyFormat = None
300
class TestMetaDirBranchFormatFactory(tests.TestCase):
302
def test_get_format_string_does_not_load(self):
303
"""Formats have a static format string."""
304
factory = _mod_branch.MetaDirBranchFormatFactory("yo", None, None)
305
self.assertEqual("yo", factory.get_format_string())
307
def test_call_loads(self):
308
# __call__ is used by the network_format_registry interface to get a
310
global FakeLazyFormat
312
factory = _mod_branch.MetaDirBranchFormatFactory(None,
313
"bzrlib.tests.test_branch", "FakeLazyFormat")
314
self.assertRaises(AttributeError, factory)
316
def test_call_returns_call_of_referenced_object(self):
317
global FakeLazyFormat
318
FakeLazyFormat = lambda:'called'
319
factory = _mod_branch.MetaDirBranchFormatFactory(None,
320
"bzrlib.tests.test_branch", "FakeLazyFormat")
321
self.assertEqual('called', factory())
189
324
class TestBranch67(object):
190
325
"""Common tests for both branch 6 and 7 which are mostly the same."""
211
346
def test_layout(self):
212
347
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')
348
self.assertPathExists('a/.bzr/branch/last-revision')
349
self.assertPathDoesNotExist('a/.bzr/branch/revision-history')
350
self.assertPathDoesNotExist('a/.bzr/branch/references')
217
352
def test_config(self):
218
353
"""Ensure that all configuration data is stored in the branch"""
219
354
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())
355
branch.set_parent('http://example.com')
356
self.assertPathDoesNotExist('a/.bzr/branch/parent')
357
self.assertEqual('http://example.com', branch.get_parent())
358
branch.set_push_location('sftp://example.com')
359
config = branch.get_config_stack()
360
self.assertEqual('sftp://example.com', config.get('push_location'))
361
branch.set_bound_location('ftp://example.com')
362
self.assertPathDoesNotExist('a/.bzr/branch/bound')
363
self.assertEqual('ftp://example.com', branch.get_bound_location())
231
365
def test_set_revision_history(self):
232
366
builder = self.make_branch_builder('.', format=self.get_format_name())
237
371
branch = builder.get_branch()
238
372
branch.lock_write()
239
373
self.addCleanup(branch.unlock)
240
branch.set_revision_history(['foo', 'bar'])
241
branch.set_revision_history(['foo'])
374
self.applyDeprecated(symbol_versioning.deprecated_in((2, 4, 0)),
375
branch.set_revision_history, ['foo', 'bar'])
376
self.applyDeprecated(symbol_versioning.deprecated_in((2, 4, 0)),
377
branch.set_revision_history, ['foo'])
242
378
self.assertRaises(errors.NotLefthandHistory,
243
branch.set_revision_history, ['bar'])
379
self.applyDeprecated, symbol_versioning.deprecated_in((2, 4, 0)),
380
branch.set_revision_history, ['bar'])
245
382
def do_checkout_test(self, lightweight=False):
246
383
tree = self.make_branch_and_tree('source',
259
396
subtree.commit('a subtree file')
260
397
subsubtree.commit('a subsubtree file')
261
398
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')
399
self.assertPathExists('target')
400
self.assertPathExists('target/subtree')
401
self.assertPathExists('target/subtree/file')
402
self.assertPathExists('target/subtree/subsubtree/file')
266
403
subbranch = _mod_branch.Branch.open('target/subtree/subsubtree')
268
405
self.assertEndsWith(subbranch.base, 'source/subtree/subsubtree/')
275
412
def test_light_checkout_with_references(self):
276
413
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
416
class TestBranch6(TestBranch67, tests.TestCaseWithTransport):
425
546
self.assertEqual(('path3', 'location3'),
426
547
branch.get_reference_info('file-id'))
549
def _recordParentMapCalls(self, repo):
550
self._parent_map_calls = []
551
orig_get_parent_map = repo.revisions.get_parent_map
552
def get_parent_map(q):
554
self._parent_map_calls.extend([e[0] for e in q])
555
return orig_get_parent_map(q)
556
repo.revisions.get_parent_map = get_parent_map
428
559
class TestBranchReference(tests.TestCaseWithTransport):
429
560
"""Tests for the branch reference facility."""
431
562
def test_create_open_reference(self):
432
563
bzrdirformat = bzrdir.BzrDirMetaFormat1()
433
t = transport.get_transport(self.get_url('.'))
564
t = self.get_transport()
435
566
dir = bzrdirformat.initialize(self.get_url('repo'))
436
567
dir.create_repository()
438
569
t.mkdir('branch')
439
570
branch_dir = bzrdirformat.initialize(self.get_url('branch'))
440
571
made_branch = _mod_branch.BranchReferenceFormat().initialize(
441
branch_dir, target_branch)
572
branch_dir, target_branch=target_branch)
442
573
self.assertEqual(made_branch.base, target_branch.base)
443
574
opened_branch = branch_dir.open_branch()
444
575
self.assertEqual(opened_branch.base, target_branch.base)
446
577
def test_get_reference(self):
447
"""For a BranchReference, get_reference should reutrn the location."""
578
"""For a BranchReference, get_reference should return the location."""
448
579
branch = self.make_branch('target')
449
580
checkout = branch.create_checkout('checkout', lightweight=True)
450
581
reference_url = branch.bzrdir.root_transport.abspath('') + '/'
476
611
self.assertIsInstance(self._preserved_hooks[_mod_branch.Branch][1],
477
612
_mod_branch.BranchHooks)
614
def test_post_branch_init_hook(self):
616
_mod_branch.Branch.hooks.install_named_hook('post_branch_init',
618
self.assertLength(0, calls)
619
branch = self.make_branch('a')
620
self.assertLength(1, calls)
622
self.assertIsInstance(params, _mod_branch.BranchInitHookParams)
623
self.assertTrue(hasattr(params, 'bzrdir'))
624
self.assertTrue(hasattr(params, 'branch'))
626
def test_post_branch_init_hook_repr(self):
628
_mod_branch.Branch.hooks.install_named_hook('post_branch_init',
629
lambda params: param_reprs.append(repr(params)), None)
630
branch = self.make_branch('a')
631
self.assertLength(1, param_reprs)
632
param_repr = param_reprs[0]
633
self.assertStartsWith(param_repr, '<BranchInitHookParams of ')
635
def test_post_switch_hook(self):
636
from bzrlib import switch
638
_mod_branch.Branch.hooks.install_named_hook('post_switch',
640
tree = self.make_branch_and_tree('branch-1')
641
self.build_tree(['branch-1/file-1'])
644
to_branch = tree.bzrdir.sprout('branch-2').open_branch()
645
self.build_tree(['branch-1/file-2'])
647
tree.remove('file-1')
649
checkout = tree.branch.create_checkout('checkout')
650
self.assertLength(0, calls)
651
switch.switch(checkout.bzrdir, to_branch)
652
self.assertLength(1, calls)
654
self.assertIsInstance(params, _mod_branch.SwitchHookParams)
655
self.assertTrue(hasattr(params, 'to_branch'))
656
self.assertTrue(hasattr(params, 'revision_id'))
659
class TestBranchOptions(tests.TestCaseWithTransport):
662
super(TestBranchOptions, self).setUp()
663
self.branch = self.make_branch('.')
664
self.config_stack = self.branch.get_config_stack()
666
def check_append_revisions_only(self, expected_value, value=None):
667
"""Set append_revisions_only in config and check its interpretation."""
668
if value is not None:
669
self.config_stack.set('append_revisions_only', value)
670
self.assertEqual(expected_value,
671
self.branch.get_append_revisions_only())
673
def test_valid_append_revisions_only(self):
674
self.assertEquals(None,
675
self.config_stack.get('append_revisions_only'))
676
self.check_append_revisions_only(None)
677
self.check_append_revisions_only(False, 'False')
678
self.check_append_revisions_only(True, 'True')
679
# The following values will cause compatibility problems on projects
680
# using older bzr versions (<2.2) but are accepted
681
self.check_append_revisions_only(False, 'false')
682
self.check_append_revisions_only(True, 'true')
684
def test_invalid_append_revisions_only(self):
685
"""Ensure warning is noted on invalid settings"""
688
self.warnings.append(args[0] % args[1:])
689
self.overrideAttr(trace, 'warning', warning)
690
self.check_append_revisions_only(None, 'not-a-bool')
691
self.assertLength(1, self.warnings)
693
'Value "not-a-bool" is not valid for "append_revisions_only"',
480
697
class TestPullResult(tests.TestCase):
506
726
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)
729
self.assertEqual("No revisions or tags to pull.\n", f.getvalue())