1
# Copyright (C) 2008 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
"""Tests for foreign VCS utility code."""
33
# This is the dummy foreign revision control system, used
34
# mainly here in the testsuite to test the foreign VCS infrastructure.
35
# It is basically standard Bazaar with some minor modifications to
38
# It has the following differences to "regular" Bazaar:
39
# - The control directory is named ".dummy", not ".bzr".
40
# - The revision ids are tuples, not strings.
41
# - Doesn't support more than one parent natively
44
class DummyForeignVcsMapping(foreign.VcsMapping):
45
"""A simple mapping for the dummy Foreign VCS, for use with testing."""
47
def __eq__(self, other):
48
return type(self) == type(other)
50
def revision_id_bzr_to_foreign(self, bzr_revid):
51
return tuple(bzr_revid[len("dummy-v1:"):].split("-")), self
53
def revision_id_foreign_to_bzr(self, foreign_revid):
54
return "dummy-v1:%s-%s-%s" % foreign_revid
57
class DummyForeignVcsMappingRegistry(foreign.VcsMappingRegistry):
59
def revision_id_bzr_to_foreign(self, revid):
60
if not revid.startswith("dummy-"):
61
raise errors.InvalidRevisionId(revid, None)
62
mapping_version = revid[len("dummy-"):len("dummy-vx")]
63
mapping = self.get(mapping_version)
64
return mapping.revision_id_bzr_to_foreign(revid)
67
class DummyForeignVcs(foreign.ForeignVcs):
68
"""A dummy Foreign VCS, for use with testing.
70
It has revision ids that are a tuple with three strings.
74
self.mapping_registry = DummyForeignVcsMappingRegistry()
75
self.mapping_registry.register("v1", DummyForeignVcsMapping(self),
78
def show_foreign_revid(self, foreign_revid):
79
return { "dummy ding": "%s/%s\\%s" % foreign_revid }
82
class DummyForeignVcsBranch(branch.BzrBranch6,foreign.ForeignBranch):
83
"""A Dummy VCS Branch."""
85
def __init__(self, _format, _control_files, a_bzrdir, *args, **kwargs):
86
self._format = _format
87
self._base = a_bzrdir.transport.base
88
self._ignore_fallbacks = False
89
foreign.ForeignBranch.__init__(self,
90
DummyForeignVcsMapping(DummyForeignVcs()))
91
branch.BzrBranch6.__init__(self, _format, _control_files, a_bzrdir,
95
class InterToDummyVcsBranch(branch.GenericInterBranch,
96
foreign.InterToForeignBranch):
99
def is_compatible(source, target):
100
return isinstance(target, DummyForeignVcsBranch)
102
def lossy_push(self, stop_revision=None):
103
result = branch.BranchPushResult()
104
result.source_branch = self.source
105
result.target_branch = self.target
106
result.old_revno, result.old_revid = self.target.last_revision_info()
107
self.source.lock_read()
109
# This just handles simple cases, but that's good enough for tests
110
my_history = self.target.revision_history()
111
their_history = self.source.revision_history()
112
if their_history[:min(len(my_history), len(their_history))] != my_history:
113
raise errors.DivergedBranches(self.target, self.source)
114
todo = their_history[len(my_history):]
117
rev = self.source.repository.get_revision(revid)
118
tree = self.source.repository.revision_tree(revid)
119
def get_file_with_stat(file_id, path=None):
120
return (tree.get_file(file_id), None)
121
tree.get_file_with_stat = get_file_with_stat
122
new_revid = self.target.mapping.revision_id_foreign_to_bzr(
123
(str(rev.timestamp), str(rev.timezone),
124
str(self.target.revno())))
125
parent_revno, parent_revid= self.target.last_revision_info()
126
if parent_revid == revision.NULL_REVISION:
129
parent_revids = [parent_revid]
130
builder = self.target.get_commit_builder(parent_revids,
131
self.target.get_config(), rev.timestamp,
132
rev.timezone, rev.committer, rev.properties,
135
for path, ie in tree.inventory.iter_entries():
137
new_ie.revision = None
138
builder.record_entry_contents(new_ie,
139
[self.target.repository.revision_tree(parent_revid).inventory],
141
(ie.kind, ie.text_size, ie.executable, ie.text_sha1))
142
builder.finish_inventory()
146
revidmap[revid] = builder.commit(rev.message)
147
self.target.set_last_revision_info(parent_revno+1,
149
trace.mutter('lossily pushed revision %s -> %s',
150
revid, revidmap[revid])
153
result.new_revno, result.new_revid = self.target.last_revision_info()
154
result.revidmap = revidmap
158
class DummyForeignVcsBranchFormat(branch.BzrBranchFormat6):
160
def get_format_string(self):
161
return "Branch for Testing"
164
super(DummyForeignVcsBranchFormat, self).__init__()
165
self._matchingbzrdir = DummyForeignVcsDirFormat()
167
def open(self, a_bzrdir, _found=False):
169
raise NotImplementedError
171
transport = a_bzrdir.get_branch_transport(None)
172
control_files = lockable_files.LockableFiles(transport, 'lock',
174
return DummyForeignVcsBranch(_format=self,
175
_control_files=control_files,
177
_repository=a_bzrdir.find_repository())
178
except errors.NoSuchFile:
179
raise errors.NotBranchError(path=transport.base)
182
class DummyForeignVcsDirFormat(bzrdir.BzrDirMetaFormat1):
183
"""BzrDirFormat for the dummy foreign VCS."""
186
def get_format_string(cls):
187
return "A Dummy VCS Dir"
190
def get_format_description(cls):
191
return "A Dummy VCS Dir"
194
def is_supported(cls):
197
def get_branch_format(self):
198
return DummyForeignVcsBranchFormat()
201
def probe_transport(klass, transport):
202
"""Return the .bzrdir style format present in a directory."""
203
if not transport.has('.dummy'):
204
raise errors.NotBranchError(path=transport.base)
207
def initialize_on_transport(self, transport):
208
"""Initialize a new bzrdir in the base directory of a Transport."""
209
# Since we don't have a .bzr directory, inherit the
210
# mode from the root directory
211
temp_control = lockable_files.LockableFiles(transport,
212
'', lockable_files.TransportLock)
213
temp_control._transport.mkdir('.dummy',
214
# FIXME: RBC 20060121 don't peek under
216
mode=temp_control._dir_mode)
218
bzrdir_transport = transport.clone('.dummy')
219
# NB: no need to escape relative paths that are url safe.
220
control_files = lockable_files.LockableFiles(bzrdir_transport,
221
self._lock_file_name, self._lock_class)
222
control_files.create_lock()
223
return self.open(transport, _found=True)
225
def _open(self, transport):
226
return DummyForeignVcsDir(transport, self)
229
class DummyForeignVcsDir(bzrdir.BzrDirMeta1):
231
def __init__(self, _transport, _format):
232
self._format = _format
233
self.transport = _transport.clone('.dummy')
234
self.root_transport = _transport
235
self._mode_check_done = False
236
self._control_files = lockable_files.LockableFiles(self.transport,
237
"lock", lockable_files.TransportLock)
239
def open_branch(self, ignore_fallbacks=True):
240
return self._format.get_branch_format().open(self, _found=True)
242
def cloning_metadir(self, stacked=False):
243
"""Produce a metadir suitable for cloning with."""
244
return bzrdir.format_registry.make_bzrdir("default")
246
def sprout(self, url, revision_id=None, force_new_repo=False,
247
recurse='down', possible_transports=None,
248
accelerator_tree=None, hardlink=False, stacked=False,
250
# dirstate doesn't cope with accelerator_trees well
251
# that have a different control dir
252
return super(DummyForeignVcsDir, self).sprout(url=url,
253
revision_id=revision_id, force_new_repo=force_new_repo,
254
recurse=recurse, possible_transports=possible_transports,
255
hardlink=hardlink, stacked=stacked, source_branch=source_branch)
258
def register_dummy_foreign_for_test(testcase):
259
bzrdir.BzrDirFormat.register_control_format(DummyForeignVcsDirFormat)
260
testcase.addCleanup(bzrdir.BzrDirFormat.unregister_control_format,
261
DummyForeignVcsDirFormat)
262
# We need to register the optimiser to make the dummy appears really
263
# different from a regular bzr repository.
264
branch.InterBranch.register_optimiser(InterToDummyVcsBranch)
265
testcase.addCleanup(branch.InterBranch.unregister_optimiser,
266
InterToDummyVcsBranch)
269
class ForeignVcsRegistryTests(tests.TestCase):
270
"""Tests for the ForeignVcsRegistry class."""
272
def test_parse_revision_id_no_dash(self):
273
reg = foreign.ForeignVcsRegistry()
274
self.assertRaises(errors.InvalidRevisionId,
275
reg.parse_revision_id, "invalid")
277
def test_parse_revision_id_unknown_mapping(self):
278
reg = foreign.ForeignVcsRegistry()
279
self.assertRaises(errors.InvalidRevisionId,
280
reg.parse_revision_id, "unknown-foreignrevid")
282
def test_parse_revision_id(self):
283
reg = foreign.ForeignVcsRegistry()
284
vcs = DummyForeignVcs()
285
reg.register("dummy", vcs, "Dummy VCS")
286
self.assertEquals((("some", "foreign", "revid"), DummyForeignVcsMapping(vcs)),
287
reg.parse_revision_id("dummy-v1:some-foreign-revid"))
290
class ForeignRevisionTests(tests.TestCase):
291
"""Tests for the ForeignRevision class."""
293
def test_create(self):
294
mapp = DummyForeignVcsMapping(DummyForeignVcs())
295
rev = foreign.ForeignRevision(("a", "foreign", "revid"),
296
mapp, "roundtripped-revid")
297
self.assertEquals("", rev.inventory_sha1)
298
self.assertEquals(("a", "foreign", "revid"), rev.foreign_revid)
299
self.assertEquals(mapp, rev.mapping)
302
class WorkingTreeFileUpdateTests(tests.TestCaseWithTransport):
303
"""Tests for update_workingtree_fileids()."""
305
def test_update_workingtree(self):
306
wt = self.make_branch_and_tree('br1')
307
self.build_tree_contents([('br1/bla', 'original contents\n')])
308
wt.add('bla', 'bla-a')
310
root_id = wt.get_root_id()
311
target = wt.bzrdir.sprout('br2').open_workingtree()
312
target.unversion(['bla-a'])
313
target.add('bla', 'bla-b')
314
target.commit('bla-b')
315
target_basis = target.basis_tree()
316
target_basis.lock_read()
317
self.addCleanup(target_basis.unlock)
318
foreign.update_workingtree_fileids(wt, target_basis)
321
self.assertEquals(set([root_id, "bla-b"]), set(wt.inventory))
326
class DummyForeignVcsTests(tests.TestCaseWithTransport):
327
"""Very basic test for DummyForeignVcs."""
330
super(DummyForeignVcsTests, self).setUp()
331
register_dummy_foreign_for_test(self)
333
def test_create(self):
334
"""Test we can create dummies."""
335
self.make_branch_and_tree("d", format=DummyForeignVcsDirFormat())
336
dir = bzrdir.BzrDir.open("d")
337
self.assertEquals("A Dummy VCS Dir", dir._format.get_format_string())
338
dir.open_repository()
340
dir.open_workingtree()
342
def test_sprout(self):
343
"""Test we can clone dummies and that the format is not preserved."""
344
self.make_branch_and_tree("d", format=DummyForeignVcsDirFormat())
345
dir = bzrdir.BzrDir.open("d")
346
newdir = dir.sprout("e")
347
self.assertNotEquals("A Dummy VCS Dir",
348
newdir._format.get_format_string())
350
def test_lossy_push_empty(self):
351
source_tree = self.make_branch_and_tree("source")
352
target_tree = self.make_branch_and_tree("target",
353
format=DummyForeignVcsDirFormat())
354
pushresult = source_tree.branch.lossy_push(target_tree.branch)
355
self.assertEquals(revision.NULL_REVISION, pushresult.old_revid)
356
self.assertEquals(revision.NULL_REVISION, pushresult.new_revid)
357
self.assertEquals({}, pushresult.revidmap)
359
def test_lossy_push_simple(self):
360
source_tree = self.make_branch_and_tree("source")
361
self.build_tree(['source/a', 'source/b'])
362
source_tree.add(['a', 'b'])
363
revid1 = source_tree.commit("msg")
364
target_tree = self.make_branch_and_tree("target",
365
format=DummyForeignVcsDirFormat())
366
target_tree.branch.lock_write()
368
pushresult = source_tree.branch.lossy_push(target_tree.branch)
370
target_tree.branch.unlock()
371
self.assertEquals(revision.NULL_REVISION, pushresult.old_revid)
372
self.assertEquals({revid1:target_tree.branch.last_revision()},
374
self.assertEquals(pushresult.revidmap[revid1], pushresult.new_revid)