1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Tests for the Branch facility that are not interface tests.
19
For interface tests see tests/branch_implementations/*.py.
21
For concrete class tests see this file, and for meta-branch tests
25
from StringIO import StringIO
28
branch as _mod_branch,
33
from bzrlib.branch import (
37
BranchReferenceFormat,
42
from bzrlib.bzrdir import (BzrDirMetaFormat1, BzrDirMeta1,
44
from bzrlib.errors import (NotBranchError,
47
UnsupportedFormatError,
50
from bzrlib.tests import TestCase, TestCaseWithTransport
51
from bzrlib.transport import get_transport
53
class TestDefaultFormat(TestCase):
55
def test_get_set_default_format(self):
56
old_format = BranchFormat.get_default_format()
58
self.assertTrue(isinstance(old_format, BzrBranchFormat5))
59
BranchFormat.set_default_format(SampleBranchFormat())
61
# the default branch format is used by the meta dir format
62
# which is not the default bzrdir format at this point
63
dir = BzrDirMetaFormat1().initialize('memory:///')
64
result = dir.create_branch()
65
self.assertEqual(result, 'A branch')
67
BranchFormat.set_default_format(old_format)
68
self.assertEqual(old_format, BranchFormat.get_default_format())
71
class TestBranchFormat5(TestCaseWithTransport):
72
"""Tests specific to branch format 5"""
74
def test_branch_format_5_uses_lockdir(self):
76
bzrdir = BzrDirMetaFormat1().initialize(url)
77
bzrdir.create_repository()
78
branch = bzrdir.create_branch()
79
t = self.get_transport()
80
self.log("branch instance is %r" % branch)
81
self.assert_(isinstance(branch, BzrBranch5))
82
self.assertIsDirectory('.', t)
83
self.assertIsDirectory('.bzr/branch', t)
84
self.assertIsDirectory('.bzr/branch/lock', t)
87
self.assertIsDirectory('.bzr/branch/lock/held', t)
91
def test_set_push_location(self):
92
from bzrlib.config import (locations_config_filename,
93
ensure_config_dir_exists)
94
ensure_config_dir_exists()
95
fn = locations_config_filename()
96
branch = self.make_branch('.', format='knit')
97
branch.set_push_location('foo')
98
local_path = urlutils.local_path_from_url(branch.base[:-1])
99
self.assertFileEqual("[%s]\n"
100
"push_location = foo\n"
101
"push_location:policy = norecurse" % local_path,
104
# TODO RBC 20051029 test getting a push location from a branch in a
105
# recursive section - that is, it appends the branch name.
108
class SampleBranchFormat(BranchFormat):
111
this format is initializable, unsupported to aid in testing the
112
open and open_downlevel routines.
115
def get_format_string(self):
116
"""See BzrBranchFormat.get_format_string()."""
117
return "Sample branch format."
119
def initialize(self, a_bzrdir):
120
"""Format 4 branches cannot be created."""
121
t = a_bzrdir.get_branch_transport(self)
122
t.put_bytes('format', self.get_format_string())
125
def is_supported(self):
128
def open(self, transport, _found=False):
129
return "opened branch."
132
class TestBzrBranchFormat(TestCaseWithTransport):
133
"""Tests for the BzrBranchFormat facility."""
135
def test_find_format(self):
136
# is the right format object found for a branch?
137
# create a branch with a few known format objects.
138
# this is not quite the same as
139
self.build_tree(["foo/", "bar/"])
140
def check_format(format, url):
141
dir = format._matchingbzrdir.initialize(url)
142
dir.create_repository()
143
format.initialize(dir)
144
found_format = BranchFormat.find_format(dir)
145
self.failUnless(isinstance(found_format, format.__class__))
146
check_format(BzrBranchFormat5(), "bar")
148
def test_find_format_not_branch(self):
149
dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
150
self.assertRaises(NotBranchError,
151
BranchFormat.find_format,
154
def test_find_format_unknown_format(self):
155
dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
156
SampleBranchFormat().initialize(dir)
157
self.assertRaises(UnknownFormatError,
158
BranchFormat.find_format,
161
def test_register_unregister_format(self):
162
format = SampleBranchFormat()
164
dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
166
format.initialize(dir)
167
# register a format for it.
168
BranchFormat.register_format(format)
169
# which branch.Open will refuse (not supported)
170
self.assertRaises(UnsupportedFormatError, Branch.open, self.get_url())
171
self.make_branch_and_tree('foo')
172
# but open_downlevel will work
173
self.assertEqual(format.open(dir), bzrdir.BzrDir.open(self.get_url()).open_branch(unsupported=True))
174
# unregister the format
175
BranchFormat.unregister_format(format)
176
self.make_branch_and_tree('bar')
179
class TestBranch6(TestCaseWithTransport):
181
def test_creation(self):
182
format = BzrDirMetaFormat1()
183
format.set_branch_format(_mod_branch.BzrBranchFormat6())
184
branch = self.make_branch('a', format=format)
185
self.assertIsInstance(branch, _mod_branch.BzrBranch6)
186
branch = self.make_branch('b', format='dirstate-tags')
187
self.assertIsInstance(branch, _mod_branch.BzrBranch6)
188
branch = _mod_branch.Branch.open('a')
189
self.assertIsInstance(branch, _mod_branch.BzrBranch6)
191
def test_layout(self):
192
branch = self.make_branch('a', format='dirstate-tags')
193
self.failUnlessExists('a/.bzr/branch/last-revision')
194
self.failIfExists('a/.bzr/branch/revision-history')
196
def test_config(self):
197
"""Ensure that all configuration data is stored in the branch"""
198
branch = self.make_branch('a', format='dirstate-tags')
199
branch.set_parent('http://bazaar-vcs.org')
200
self.failIfExists('a/.bzr/branch/parent')
201
self.assertEqual('http://bazaar-vcs.org', branch.get_parent())
202
branch.set_push_location('sftp://bazaar-vcs.org')
203
config = branch.get_config()._get_branch_data_config()
204
self.assertEqual('sftp://bazaar-vcs.org',
205
config.get_user_option('push_location'))
206
branch.set_bound_location('ftp://bazaar-vcs.org')
207
self.failIfExists('a/.bzr/branch/bound')
208
self.assertEqual('ftp://bazaar-vcs.org', branch.get_bound_location())
210
def test_set_revision_history(self):
211
tree = self.make_branch_and_memory_tree('.',
212
format='dirstate-tags')
216
tree.commit('foo', rev_id='foo')
217
tree.commit('bar', rev_id='bar')
218
tree.branch.set_revision_history(['foo', 'bar'])
219
tree.branch.set_revision_history(['foo'])
220
self.assertRaises(errors.NotLefthandHistory,
221
tree.branch.set_revision_history, ['bar'])
225
def test_append_revision(self):
226
tree = self.make_branch_and_tree('branch1',
227
format='dirstate-tags')
230
tree.commit('foo', rev_id='foo')
231
tree.commit('bar', rev_id='bar')
232
tree.commit('baz', rev_id='baz')
233
tree.set_last_revision('bar')
234
tree.branch.set_last_revision_info(2, 'bar')
235
tree.commit('qux', rev_id='qux')
236
tree.add_parent_tree_id('baz')
237
tree.commit('qux', rev_id='quxx')
238
tree.branch.set_last_revision_info(0, 'null:')
239
self.assertRaises(errors.NotLeftParentDescendant,
240
tree.branch.append_revision, 'bar')
241
tree.branch.append_revision('foo')
242
self.assertRaises(errors.NotLeftParentDescendant,
243
tree.branch.append_revision, 'baz')
244
tree.branch.append_revision('bar')
245
tree.branch.append_revision('baz')
246
self.assertRaises(errors.NotLeftParentDescendant,
247
tree.branch.append_revision, 'quxx')
251
def do_checkout_test(self, lightweight=False):
252
tree = self.make_branch_and_tree('source', format='dirstate-with-subtree')
253
subtree = self.make_branch_and_tree('source/subtree',
254
format='dirstate-with-subtree')
255
subsubtree = self.make_branch_and_tree('source/subtree/subsubtree',
256
format='dirstate-with-subtree')
257
self.build_tree(['source/subtree/file',
258
'source/subtree/subsubtree/file'])
259
subsubtree.add('file')
261
subtree.add_reference(subsubtree)
262
tree.add_reference(subtree)
263
tree.commit('a revision')
264
subtree.commit('a subtree file')
265
subsubtree.commit('a subsubtree file')
266
tree.branch.create_checkout('target', lightweight=lightweight)
267
self.failUnlessExists('target')
268
self.failUnlessExists('target/subtree')
269
self.failUnlessExists('target/subtree/file')
270
self.failUnlessExists('target/subtree/subsubtree/file')
271
subbranch = _mod_branch.Branch.open('target/subtree/subsubtree')
273
self.assertEndsWith(subbranch.base, 'source/subtree/subsubtree/')
275
self.assertEndsWith(subbranch.base, 'target/subtree/subsubtree/')
278
def test_checkout_with_references(self):
279
self.do_checkout_test()
281
def test_light_checkout_with_references(self):
282
self.do_checkout_test(lightweight=True)
284
class TestBranchReference(TestCaseWithTransport):
285
"""Tests for the branch reference facility."""
287
def test_create_open_reference(self):
288
bzrdirformat = bzrdir.BzrDirMetaFormat1()
289
t = get_transport(self.get_url('.'))
291
dir = bzrdirformat.initialize(self.get_url('repo'))
292
dir.create_repository()
293
target_branch = dir.create_branch()
295
branch_dir = bzrdirformat.initialize(self.get_url('branch'))
296
made_branch = BranchReferenceFormat().initialize(branch_dir, target_branch)
297
self.assertEqual(made_branch.base, target_branch.base)
298
opened_branch = branch_dir.open_branch()
299
self.assertEqual(opened_branch.base, target_branch.base)
301
def test_get_reference(self):
302
"""For a BranchReference, get_reference should reutrn the location."""
303
branch = self.make_branch('target')
304
checkout = branch.create_checkout('checkout', lightweight=True)
305
reference_url = branch.bzrdir.root_transport.abspath('') + '/'
306
# if the api for create_checkout changes to return different checkout types
307
# then this file read will fail.
308
self.assertFileEqual(reference_url, 'checkout/.bzr/branch/location')
309
self.assertEqual(reference_url,
310
_mod_branch.BranchReferenceFormat().get_reference(checkout.bzrdir))
313
class TestHooks(TestCase):
315
def test_constructor(self):
316
"""Check that creating a BranchHooks instance has the right defaults."""
317
hooks = BranchHooks()
318
self.assertTrue("set_rh" in hooks, "set_rh not in %s" % hooks)
319
self.assertTrue("post_push" in hooks, "post_push not in %s" % hooks)
320
self.assertTrue("post_commit" in hooks, "post_commit not in %s" % hooks)
321
self.assertTrue("post_pull" in hooks, "post_pull not in %s" % hooks)
322
self.assertTrue("post_uncommit" in hooks, "post_uncommit not in %s" % hooks)
324
def test_installed_hooks_are_BranchHooks(self):
325
"""The installed hooks object should be a BranchHooks."""
326
# the installed hooks are saved in self._preserved_hooks.
327
self.assertIsInstance(self._preserved_hooks[_mod_branch.Branch], BranchHooks)
329
def test_install_hook_raises_unknown_hook(self):
330
"""install_hook should raise UnknownHook if a hook is unknown."""
331
hooks = BranchHooks()
332
self.assertRaises(UnknownHook, hooks.install_hook, 'silly', None)
334
def test_install_hook_appends_known_hook(self):
335
"""install_hook should append the callable for known hooks."""
336
hooks = BranchHooks()
337
hooks.install_hook('set_rh', None)
338
self.assertEqual(hooks['set_rh'], [None])
341
class TestPullResult(TestCase):
343
def test_pull_result_to_int(self):
344
# to support old code, the pull result can be used as an int
348
# this usage of results is not recommended for new code (because it
349
# doesn't describe very well what happened), but for api stability
350
# it's still supported
351
a = "%d revisions pulled" % r
352
self.assertEqual(a, "10 revisions pulled")