48
49
# set, but at the moment that's not true -- mbp 20070814 --
49
50
# https://bugs.launchpad.net/bzr/+bug/132376
51
_mod_branch.BranchFormat.get_default_format(),
52
_mod_branch.format_registry.get_default(),
52
53
bzrdir.BzrDirFormat.get_default_format().get_branch_format())
54
55
def test_get_set_default_format(self):
55
56
# 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())
57
old_format = _mod_branch.format_registry.get_default()
58
_mod_branch.format_registry.set_default(SampleBranchFormat())
59
60
# the default branch format is used by the meta dir format
60
61
# which is not the default bzrdir format at this point
86
87
self.assertIsDirectory('.bzr/branch/lock/held', t)
88
89
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')
90
conf = config.LocationConfig.from_string('# comment\n', '.', save=True)
102
92
branch = self.make_branch('.', format='knit')
103
93
branch.set_push_location('foo')
107
97
"push_location = foo\n"
108
98
"push_location:policy = norecurse\n" % local_path,
99
config.locations_config_filename())
111
101
# TODO RBC 20051029 test getting a push location from a branch in a
112
102
# recursive section - that is, it appends the branch name.
115
class SampleBranchFormat(_mod_branch.BranchFormat):
105
class SampleBranchFormat(_mod_branch.BranchFormatMetadir):
116
106
"""A sample format
118
108
this format is initializable, unsupported to aid in testing the
119
109
open and open_downlevel routines.
122
def get_format_string(self):
113
def get_format_string(cls):
123
114
"""See BzrBranchFormat.get_format_string()."""
124
115
return "Sample branch format."
126
def initialize(self, a_bzrdir, name=None):
117
def initialize(self, a_bzrdir, name=None, repository=None,
118
append_revisions_only=None):
127
119
"""Format 4 branches cannot be created."""
128
120
t = a_bzrdir.get_branch_transport(self, name=name)
129
121
t.put_bytes('format', self.get_format_string())
132
124
def is_supported(self):
135
def open(self, transport, name=None, _found=False, ignore_fallbacks=False):
127
def open(self, transport, name=None, _found=False, ignore_fallbacks=False,
128
possible_transports=None):
136
129
return "opened branch."
132
# Demonstrating how lazy loading is often implemented:
133
# A constant string is created.
134
SampleSupportedBranchFormatString = "Sample supported branch format."
136
# And the format class can then reference the constant to avoid skew.
137
class SampleSupportedBranchFormat(_mod_branch.BranchFormatMetadir):
138
"""A sample supported format."""
141
def get_format_string(cls):
142
"""See BzrBranchFormat.get_format_string()."""
143
return SampleSupportedBranchFormatString
145
def initialize(self, a_bzrdir, name=None, append_revisions_only=None):
146
t = a_bzrdir.get_branch_transport(self, name=name)
147
t.put_bytes('format', self.get_format_string())
150
def open(self, transport, name=None, _found=False, ignore_fallbacks=False,
151
possible_transports=None):
152
return "opened supported branch."
155
class SampleExtraBranchFormat(_mod_branch.BranchFormat):
156
"""A sample format that is not usable in a metadir."""
158
def get_format_string(self):
159
# This format is not usable in a metadir.
162
def network_name(self):
163
# Network name always has to be provided.
166
def initialize(self, a_bzrdir, name=None):
167
raise NotImplementedError(self.initialize)
169
def open(self, transport, name=None, _found=False, ignore_fallbacks=False,
170
possible_transports=None):
171
raise NotImplementedError(self.open)
139
174
class TestBzrBranchFormat(tests.TestCaseWithTransport):
140
175
"""Tests for the BzrBranchFormat facility."""
148
183
dir = format._matchingbzrdir.initialize(url)
149
184
dir.create_repository()
150
185
format.initialize(dir)
151
found_format = _mod_branch.BranchFormat.find_format(dir)
152
self.failUnless(isinstance(found_format, format.__class__))
186
found_format = _mod_branch.BranchFormatMetadir.find_format(dir)
187
self.assertIsInstance(found_format, format.__class__)
153
188
check_format(_mod_branch.BzrBranchFormat5(), "bar")
190
def test_find_format_factory(self):
191
dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
192
SampleSupportedBranchFormat().initialize(dir)
193
factory = _mod_branch.MetaDirBranchFormatFactory(
194
SampleSupportedBranchFormatString,
195
"bzrlib.tests.test_branch", "SampleSupportedBranchFormat")
196
_mod_branch.format_registry.register(factory)
197
self.addCleanup(_mod_branch.format_registry.remove, factory)
198
b = _mod_branch.Branch.open(self.get_url())
199
self.assertEqual(b, "opened supported branch.")
201
def test_from_string(self):
202
self.assertIsInstance(
203
SampleBranchFormat.from_string("Sample branch format."),
205
self.assertRaises(AssertionError,
206
SampleBranchFormat.from_string, "Different branch format.")
155
208
def test_find_format_not_branch(self):
156
209
dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
157
210
self.assertRaises(errors.NotBranchError,
158
_mod_branch.BranchFormat.find_format,
211
_mod_branch.BranchFormatMetadir.find_format,
161
214
def test_find_format_unknown_format(self):
162
215
dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
163
216
SampleBranchFormat().initialize(dir)
164
217
self.assertRaises(errors.UnknownFormatError,
165
_mod_branch.BranchFormat.find_format,
218
_mod_branch.BranchFormatMetadir.find_format,
221
def test_find_format_with_features(self):
222
tree = self.make_branch_and_tree('.', format='2a')
223
tree.branch.update_feature_flags({"name": "optional"})
224
found_format = _mod_branch.BranchFormatMetadir.find_format(tree.bzrdir)
225
self.assertIsInstance(found_format, _mod_branch.BranchFormatMetadir)
226
self.assertEquals(found_format.features.get("name"), "optional")
227
tree.branch.update_feature_flags({"name": None})
228
branch = _mod_branch.Branch.open('.')
229
self.assertEquals(branch._format.features, {})
168
231
def test_register_unregister_format(self):
232
# Test the deprecated format registration functions
169
233
format = SampleBranchFormat()
170
234
# make a control dir
171
235
dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
173
237
format.initialize(dir)
174
238
# register a format for it.
175
_mod_branch.BranchFormat.register_format(format)
239
self.applyDeprecated(symbol_versioning.deprecated_in((2, 4, 0)),
240
_mod_branch.BranchFormat.register_format, format)
176
241
# which branch.Open will refuse (not supported)
177
242
self.assertRaises(errors.UnsupportedFormatError,
178
243
_mod_branch.Branch.open, self.get_url())
180
245
# but open_downlevel will work
181
246
self.assertEqual(
182
247
format.open(dir),
183
bzrdir.BzrDir.open(self.get_url()).open_branch(unsupported=True))
248
controldir.ControlDir.open(self.get_url()).open_branch(unsupported=True))
184
249
# unregister the format
185
_mod_branch.BranchFormat.unregister_format(format)
250
self.applyDeprecated(symbol_versioning.deprecated_in((2, 4, 0)),
251
_mod_branch.BranchFormat.unregister_format, format)
186
252
self.make_branch_and_tree('bar')
255
class TestBranchFormatRegistry(tests.TestCase):
258
super(TestBranchFormatRegistry, self).setUp()
259
self.registry = _mod_branch.BranchFormatRegistry()
261
def test_default(self):
262
self.assertIs(None, self.registry.get_default())
263
format = SampleBranchFormat()
264
self.registry.set_default(format)
265
self.assertEquals(format, self.registry.get_default())
267
def test_register_unregister_format(self):
268
format = SampleBranchFormat()
269
self.registry.register(format)
270
self.assertEquals(format,
271
self.registry.get("Sample branch format."))
272
self.registry.remove(format)
273
self.assertRaises(KeyError, self.registry.get,
274
"Sample branch format.")
276
def test_get_all(self):
277
format = SampleBranchFormat()
278
self.assertEquals([], self.registry._get_all())
279
self.registry.register(format)
280
self.assertEquals([format], self.registry._get_all())
282
def test_register_extra(self):
283
format = SampleExtraBranchFormat()
284
self.assertEquals([], self.registry._get_all())
285
self.registry.register_extra(format)
286
self.assertEquals([format], self.registry._get_all())
288
def test_register_extra_lazy(self):
289
self.assertEquals([], self.registry._get_all())
290
self.registry.register_extra_lazy("bzrlib.tests.test_branch",
291
"SampleExtraBranchFormat")
292
formats = self.registry._get_all()
293
self.assertEquals(1, len(formats))
294
self.assertIsInstance(formats[0], SampleExtraBranchFormat)
297
#Used by TestMetaDirBranchFormatFactory
298
FakeLazyFormat = None
301
class TestMetaDirBranchFormatFactory(tests.TestCase):
303
def test_get_format_string_does_not_load(self):
304
"""Formats have a static format string."""
305
factory = _mod_branch.MetaDirBranchFormatFactory("yo", None, None)
306
self.assertEqual("yo", factory.get_format_string())
308
def test_call_loads(self):
309
# __call__ is used by the network_format_registry interface to get a
311
global FakeLazyFormat
313
factory = _mod_branch.MetaDirBranchFormatFactory(None,
314
"bzrlib.tests.test_branch", "FakeLazyFormat")
315
self.assertRaises(AttributeError, factory)
317
def test_call_returns_call_of_referenced_object(self):
318
global FakeLazyFormat
319
FakeLazyFormat = lambda:'called'
320
factory = _mod_branch.MetaDirBranchFormatFactory(None,
321
"bzrlib.tests.test_branch", "FakeLazyFormat")
322
self.assertEqual('called', factory())
189
325
class TestBranch67(object):
190
326
"""Common tests for both branch 6 and 7 which are mostly the same."""
211
347
def test_layout(self):
212
348
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')
349
self.assertPathExists('a/.bzr/branch/last-revision')
350
self.assertPathDoesNotExist('a/.bzr/branch/revision-history')
351
self.assertPathDoesNotExist('a/.bzr/branch/references')
217
353
def test_config(self):
218
354
"""Ensure that all configuration data is stored in the branch"""
219
355
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())
356
branch.set_parent('http://example.com')
357
self.assertPathDoesNotExist('a/.bzr/branch/parent')
358
self.assertEqual('http://example.com', branch.get_parent())
359
branch.set_push_location('sftp://example.com')
360
conf = branch.get_config_stack()
361
self.assertEqual('sftp://example.com', conf.get('push_location'))
362
branch.set_bound_location('ftp://example.com')
363
self.assertPathDoesNotExist('a/.bzr/branch/bound')
364
self.assertEqual('ftp://example.com', branch.get_bound_location())
231
366
def test_set_revision_history(self):
232
367
builder = self.make_branch_builder('.', format=self.get_format_name())
237
372
branch = builder.get_branch()
238
373
branch.lock_write()
239
374
self.addCleanup(branch.unlock)
240
branch.set_revision_history(['foo', 'bar'])
241
branch.set_revision_history(['foo'])
375
self.applyDeprecated(symbol_versioning.deprecated_in((2, 4, 0)),
376
branch.set_revision_history, ['foo', 'bar'])
377
self.applyDeprecated(symbol_versioning.deprecated_in((2, 4, 0)),
378
branch.set_revision_history, ['foo'])
242
379
self.assertRaises(errors.NotLefthandHistory,
243
branch.set_revision_history, ['bar'])
380
self.applyDeprecated, symbol_versioning.deprecated_in((2, 4, 0)),
381
branch.set_revision_history, ['bar'])
245
383
def do_checkout_test(self, lightweight=False):
246
384
tree = self.make_branch_and_tree('source',
259
397
subtree.commit('a subtree file')
260
398
subsubtree.commit('a subsubtree file')
261
399
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')
400
self.assertPathExists('target')
401
self.assertPathExists('target/subtree')
402
self.assertPathExists('target/subtree/file')
403
self.assertPathExists('target/subtree/subsubtree/file')
266
404
subbranch = _mod_branch.Branch.open('target/subtree/subsubtree')
268
406
self.assertEndsWith(subbranch.base, 'source/subtree/subsubtree/')
275
413
def test_light_checkout_with_references(self):
276
414
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
417
class TestBranch6(TestBranch67, tests.TestCaseWithTransport):
425
547
self.assertEqual(('path3', 'location3'),
426
548
branch.get_reference_info('file-id'))
550
def _recordParentMapCalls(self, repo):
551
self._parent_map_calls = []
552
orig_get_parent_map = repo.revisions.get_parent_map
553
def get_parent_map(q):
555
self._parent_map_calls.extend([e[0] for e in q])
556
return orig_get_parent_map(q)
557
repo.revisions.get_parent_map = get_parent_map
428
560
class TestBranchReference(tests.TestCaseWithTransport):
429
561
"""Tests for the branch reference facility."""
431
563
def test_create_open_reference(self):
432
564
bzrdirformat = bzrdir.BzrDirMetaFormat1()
433
t = transport.get_transport(self.get_url('.'))
565
t = self.get_transport()
435
567
dir = bzrdirformat.initialize(self.get_url('repo'))
436
568
dir.create_repository()
492
624
self.assertTrue(hasattr(params, 'bzrdir'))
493
625
self.assertTrue(hasattr(params, 'branch'))
627
def test_post_branch_init_hook_repr(self):
629
_mod_branch.Branch.hooks.install_named_hook('post_branch_init',
630
lambda params: param_reprs.append(repr(params)), None)
631
branch = self.make_branch('a')
632
self.assertLength(1, param_reprs)
633
param_repr = param_reprs[0]
634
self.assertStartsWith(param_repr, '<BranchInitHookParams of ')
495
636
def test_post_switch_hook(self):
496
637
from bzrlib import switch
522
663
super(TestBranchOptions, self).setUp()
523
664
self.branch = self.make_branch('.')
524
self.config = self.branch.get_config()
665
self.config_stack = self.branch.get_config_stack()
526
667
def check_append_revisions_only(self, expected_value, value=None):
527
668
"""Set append_revisions_only in config and check its interpretation."""
528
669
if value is not None:
529
self.config.set_user_option('append_revisions_only', value)
670
self.config_stack.set('append_revisions_only', value)
530
671
self.assertEqual(expected_value,
531
self.branch._get_append_revisions_only())
672
self.branch.get_append_revisions_only())
533
674
def test_valid_append_revisions_only(self):
534
675
self.assertEquals(None,
535
self.config.get_user_option('append_revisions_only'))
676
self.config_stack.get('append_revisions_only'))
536
677
self.check_append_revisions_only(None)
537
678
self.check_append_revisions_only(False, 'False')
538
679
self.check_append_revisions_only(True, 'True')
550
691
self.check_append_revisions_only(None, 'not-a-bool')
551
692
self.assertLength(1, self.warnings)
552
693
self.assertEqual(
553
'Value "not-a-bool" is not a boolean for "append_revisions_only"',
694
'Value "not-a-bool" is not valid for "append_revisions_only"',
554
695
self.warnings[0])
697
def test_use_fresh_values(self):
698
copy = _mod_branch.Branch.open(self.branch.base)
701
copy.get_config_stack().set('foo', 'bar')
704
self.assertFalse(self.branch.is_locked())
705
result = self.branch.get_config_stack().get('foo')
706
# Bug: https://bugs.launchpad.net/bzr/+bug/948339
707
self.expectFailure('Unlocked branches cache their configs',
708
self.assertEqual, 'bar', result)
710
def test_set_from_config_get_from_config_stack(self):
711
self.branch.lock_write()
712
self.addCleanup(self.branch.unlock)
713
self.branch.get_config().set_user_option('foo', 'bar')
714
result = self.branch.get_config_stack().get('foo')
715
# https://bugs.launchpad.net/bzr/+bug/948344
716
self.expectFailure('BranchStack uses cache after set_user_option',
717
self.assertEqual, 'bar', result)
719
def test_set_from_config_stack_get_from_config(self):
720
self.branch.lock_write()
721
self.addCleanup(self.branch.unlock)
722
self.branch.get_config_stack().set('foo', 'bar')
723
self.assertEqual('bar',
724
self.branch.get_config().get_user_option('foo'))
726
def test_set_delays_write(self):
727
self.branch.lock_write()
728
self.addCleanup(self.branch.unlock)
729
self.branch.get_config_stack().set('foo', 'bar')
730
copy = _mod_branch.Branch.open(self.branch.base)
731
result = copy.get_config_stack().get('foo')
732
# Bug: https://bugs.launchpad.net/bzr/+bug/948339
733
self.expectFailure("Config writes are not cached.", self.assertIs,
557
737
class TestPullResult(tests.TestCase):
564
744
# this usage of results is not recommended for new code (because it
565
745
# doesn't describe very well what happened), but for api stability
566
746
# it's still supported
567
a = "%d revisions pulled" % r
568
self.assertEqual(a, "10 revisions pulled")
747
self.assertEqual(self.applyDeprecated(
748
symbol_versioning.deprecated_in((2, 3, 0)),
570
752
def test_report_changed(self):
571
753
r = _mod_branch.PullResult()
583
766
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)
769
self.assertEqual("No revisions or tags to pull.\n", f.getvalue())