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, {})
232
class TestBranchFormatRegistry(tests.TestCase):
235
super(TestBranchFormatRegistry, self).setUp()
236
self.registry = _mod_branch.BranchFormatRegistry()
238
def test_default(self):
239
self.assertIs(None, self.registry.get_default())
240
format = SampleBranchFormat()
241
self.registry.set_default(format)
242
self.assertEquals(format, self.registry.get_default())
168
244
def test_register_unregister_format(self):
169
245
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')
246
self.registry.register(format)
247
self.assertEquals(format,
248
self.registry.get("Sample branch format."))
249
self.registry.remove(format)
250
self.assertRaises(KeyError, self.registry.get,
251
"Sample branch format.")
253
def test_get_all(self):
254
format = SampleBranchFormat()
255
self.assertEquals([], self.registry._get_all())
256
self.registry.register(format)
257
self.assertEquals([format], self.registry._get_all())
259
def test_register_extra(self):
260
format = SampleExtraBranchFormat()
261
self.assertEquals([], self.registry._get_all())
262
self.registry.register_extra(format)
263
self.assertEquals([format], self.registry._get_all())
265
def test_register_extra_lazy(self):
266
self.assertEquals([], self.registry._get_all())
267
self.registry.register_extra_lazy("bzrlib.tests.test_branch",
268
"SampleExtraBranchFormat")
269
formats = self.registry._get_all()
270
self.assertEquals(1, len(formats))
271
self.assertIsInstance(formats[0], SampleExtraBranchFormat)
274
#Used by TestMetaDirBranchFormatFactory
275
FakeLazyFormat = None
278
class TestMetaDirBranchFormatFactory(tests.TestCase):
280
def test_get_format_string_does_not_load(self):
281
"""Formats have a static format string."""
282
factory = _mod_branch.MetaDirBranchFormatFactory("yo", None, None)
283
self.assertEqual("yo", factory.get_format_string())
285
def test_call_loads(self):
286
# __call__ is used by the network_format_registry interface to get a
288
global FakeLazyFormat
290
factory = _mod_branch.MetaDirBranchFormatFactory(None,
291
"bzrlib.tests.test_branch", "FakeLazyFormat")
292
self.assertRaises(AttributeError, factory)
294
def test_call_returns_call_of_referenced_object(self):
295
global FakeLazyFormat
296
FakeLazyFormat = lambda:'called'
297
factory = _mod_branch.MetaDirBranchFormatFactory(None,
298
"bzrlib.tests.test_branch", "FakeLazyFormat")
299
self.assertEqual('called', factory())
189
302
class TestBranch67(object):
211
324
def test_layout(self):
212
325
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')
326
self.assertPathExists('a/.bzr/branch/last-revision')
327
self.assertPathDoesNotExist('a/.bzr/branch/revision-history')
328
self.assertPathDoesNotExist('a/.bzr/branch/references')
217
330
def test_config(self):
218
331
"""Ensure that all configuration data is stored in the branch"""
219
332
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'])
333
branch.set_parent('http://example.com')
334
self.assertPathDoesNotExist('a/.bzr/branch/parent')
335
self.assertEqual('http://example.com', branch.get_parent())
336
branch.set_push_location('sftp://example.com')
337
conf = branch.get_config_stack()
338
self.assertEqual('sftp://example.com', conf.get('push_location'))
339
branch.set_bound_location('ftp://example.com')
340
self.assertPathDoesNotExist('a/.bzr/branch/bound')
341
self.assertEqual('ftp://example.com', branch.get_bound_location())
245
343
def do_checkout_test(self, lightweight=False):
246
344
tree = self.make_branch_and_tree('source',
522
622
super(TestBranchOptions, self).setUp()
523
623
self.branch = self.make_branch('.')
524
self.config = self.branch.get_config()
624
self.config_stack = self.branch.get_config_stack()
526
626
def check_append_revisions_only(self, expected_value, value=None):
527
627
"""Set append_revisions_only in config and check its interpretation."""
528
628
if value is not None:
529
self.config.set_user_option('append_revisions_only', value)
629
self.config_stack.set('append_revisions_only', value)
530
630
self.assertEqual(expected_value,
531
self.branch._get_append_revisions_only())
631
self.branch.get_append_revisions_only())
533
633
def test_valid_append_revisions_only(self):
534
634
self.assertEquals(None,
535
self.config.get_user_option('append_revisions_only'))
635
self.config_stack.get('append_revisions_only'))
536
636
self.check_append_revisions_only(None)
537
637
self.check_append_revisions_only(False, 'False')
538
638
self.check_append_revisions_only(True, 'True')
550
650
self.check_append_revisions_only(None, 'not-a-bool')
551
651
self.assertLength(1, self.warnings)
552
652
self.assertEqual(
553
'Value "not-a-bool" is not a boolean for "append_revisions_only"',
653
'Value "not-a-bool" is not valid for "append_revisions_only"',
554
654
self.warnings[0])
656
def test_use_fresh_values(self):
657
copy = _mod_branch.Branch.open(self.branch.base)
660
copy.get_config_stack().set('foo', 'bar')
663
self.assertFalse(self.branch.is_locked())
664
# Since the branch is locked, the option value won't be saved on disk
665
# so trying to access the config of locked branch via another older
666
# non-locked branch object pointing to the same branch is not supported
667
self.assertEqual(None, self.branch.get_config_stack().get('foo'))
668
# Using a newly created branch object works as expected
669
fresh = _mod_branch.Branch.open(self.branch.base)
670
self.assertEqual('bar', fresh.get_config_stack().get('foo'))
672
def test_set_from_config_get_from_config_stack(self):
673
self.branch.lock_write()
674
self.addCleanup(self.branch.unlock)
675
self.branch.get_config().set_user_option('foo', 'bar')
676
result = self.branch.get_config_stack().get('foo')
677
# https://bugs.launchpad.net/bzr/+bug/948344
678
self.expectFailure('BranchStack uses cache after set_user_option',
679
self.assertEqual, 'bar', result)
681
def test_set_from_config_stack_get_from_config(self):
682
self.branch.lock_write()
683
self.addCleanup(self.branch.unlock)
684
self.branch.get_config_stack().set('foo', 'bar')
685
# Since the branch is locked, the option value won't be saved on disk
686
# so mixing get() and get_user_option() is broken by design.
687
self.assertEqual(None,
688
self.branch.get_config().get_user_option('foo'))
690
def test_set_delays_write_when_branch_is_locked(self):
691
self.branch.lock_write()
692
self.addCleanup(self.branch.unlock)
693
self.branch.get_config_stack().set('foo', 'bar')
694
copy = _mod_branch.Branch.open(self.branch.base)
695
result = copy.get_config_stack().get('foo')
696
# Accessing from a different branch object is like accessing from a
697
# different process: the option has not been saved yet and the new
698
# value cannot be seen.
699
self.assertIs(None, result)
557
702
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
704
def test_report_changed(self):
571
705
r = _mod_branch.PullResult()
572
706
r.old_revid = "old-revid"
583
718
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)
721
self.assertEqual("No revisions or tags to pull.\n", f.getvalue())