1
# Copyright (C) 2008-2011 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."""
34
# This is the dummy foreign revision control system, used
35
# mainly here in the testsuite to test the foreign VCS infrastructure.
36
# It is basically standard Bazaar with some minor modifications to
39
# It has the following differences to "regular" Bazaar:
40
# - The control directory is named ".dummy", not ".bzr".
41
# - The revision ids are tuples, not strings.
42
# - Doesn't support more than one parent natively
45
class DummyForeignVcsMapping(foreign.VcsMapping):
46
"""A simple mapping for the dummy Foreign VCS, for use with testing."""
48
def __eq__(self, other):
49
return type(self) == type(other)
51
def revision_id_bzr_to_foreign(self, bzr_revid):
52
return tuple(bzr_revid[len("dummy-v1:"):].split("-")), self
54
def revision_id_foreign_to_bzr(self, foreign_revid):
55
return "dummy-v1:%s-%s-%s" % foreign_revid
58
class DummyForeignVcsMappingRegistry(foreign.VcsMappingRegistry):
60
def revision_id_bzr_to_foreign(self, revid):
61
if not revid.startswith("dummy-"):
62
raise errors.InvalidRevisionId(revid, None)
63
mapping_version = revid[len("dummy-"):len("dummy-vx")]
64
mapping = self.get(mapping_version)
65
return mapping.revision_id_bzr_to_foreign(revid)
68
class DummyForeignVcs(foreign.ForeignVcs):
69
"""A dummy Foreign VCS, for use with testing.
71
It has revision ids that are a tuple with three strings.
75
self.mapping_registry = DummyForeignVcsMappingRegistry()
76
self.mapping_registry.register("v1", DummyForeignVcsMapping(self),
78
self.abbreviation = "dummy"
80
def show_foreign_revid(self, foreign_revid):
81
return { "dummy ding": "%s/%s\\%s" % foreign_revid }
83
def serialize_foreign_revid(self, foreign_revid):
84
return "%s|%s|%s" % foreign_revid
87
class DummyForeignVcsBranch(branch.BzrBranch6,foreign.ForeignBranch):
88
"""A Dummy VCS Branch."""
90
def __init__(self, _format, _control_files, a_bzrdir, *args, **kwargs):
91
self._format = _format
92
self._base = a_bzrdir.transport.base
93
self._ignore_fallbacks = False
94
self.bzrdir = a_bzrdir
95
foreign.ForeignBranch.__init__(self,
96
DummyForeignVcsMapping(DummyForeignVcs()))
97
branch.BzrBranch6.__init__(self, _format, _control_files, a_bzrdir,
101
class InterToDummyVcsBranch(branch.GenericInterBranch,
102
foreign.InterToForeignBranch):
105
def is_compatible(source, target):
106
return isinstance(target, DummyForeignVcsBranch)
108
def push(self, overwrite=False, stop_revision=None):
109
raise errors.NoRoundtrippingSupport(self.source, self.target)
111
def lossy_push(self, stop_revision=None):
112
result = branch.BranchPushResult()
113
result.source_branch = self.source
114
result.target_branch = self.target
115
result.old_revno, result.old_revid = self.target.last_revision_info()
116
self.source.lock_read()
118
# This just handles simple cases, but that's good enough for tests
119
my_history = self.target.revision_history()
120
their_history = self.source.revision_history()
121
if their_history[:min(len(my_history), len(their_history))] != my_history:
122
raise errors.DivergedBranches(self.target, self.source)
123
todo = their_history[len(my_history):]
126
rev = self.source.repository.get_revision(revid)
127
tree = self.source.repository.revision_tree(revid)
128
def get_file_with_stat(file_id, path=None):
129
return (tree.get_file(file_id), None)
130
tree.get_file_with_stat = get_file_with_stat
131
new_revid = self.target.mapping.revision_id_foreign_to_bzr(
132
(str(rev.timestamp), str(rev.timezone),
133
str(self.target.revno())))
134
parent_revno, parent_revid= self.target.last_revision_info()
135
if parent_revid == revision.NULL_REVISION:
138
parent_revids = [parent_revid]
139
builder = self.target.get_commit_builder(parent_revids,
140
self.target.get_config(), rev.timestamp,
141
rev.timezone, rev.committer, rev.properties,
144
for path, ie in tree.inventory.iter_entries():
146
new_ie.revision = None
147
builder.record_entry_contents(new_ie,
148
[self.target.repository.revision_tree(parent_revid).inventory],
150
(ie.kind, ie.text_size, ie.executable, ie.text_sha1))
151
builder.finish_inventory()
155
revidmap[revid] = builder.commit(rev.message)
156
self.target.set_last_revision_info(parent_revno+1,
158
trace.mutter('lossily pushed revision %s -> %s',
159
revid, revidmap[revid])
162
result.new_revno, result.new_revid = self.target.last_revision_info()
163
result.revidmap = revidmap
167
class DummyForeignVcsBranchFormat(branch.BzrBranchFormat6):
169
def get_format_string(self):
170
return "Branch for Testing"
173
super(DummyForeignVcsBranchFormat, self).__init__()
174
self._matchingbzrdir = DummyForeignVcsDirFormat()
176
def open(self, a_bzrdir, name=None, _found=False, found_repository=None):
178
raise NotImplementedError
180
transport = a_bzrdir.get_branch_transport(None, name=name)
181
control_files = lockable_files.LockableFiles(transport, 'lock',
183
if found_repository is None:
184
found_repository = a_bzrdir.find_repository()
185
return DummyForeignVcsBranch(_format=self,
186
_control_files=control_files,
188
_repository=found_repository)
189
except errors.NoSuchFile:
190
raise errors.NotBranchError(path=transport.base)
193
class DummyForeignVcsDirFormat(bzrdir.BzrDirMetaFormat1):
194
"""BzrDirFormat for the dummy foreign VCS."""
197
def get_format_string(cls):
198
return "A Dummy VCS Dir"
201
def get_format_description(cls):
202
return "A Dummy VCS Dir"
205
def is_supported(cls):
208
def get_branch_format(self):
209
return DummyForeignVcsBranchFormat()
211
def initialize_on_transport(self, transport):
212
"""Initialize a new bzrdir in the base directory of a Transport."""
213
# Since we don't have a .bzr directory, inherit the
214
# mode from the root directory
215
temp_control = lockable_files.LockableFiles(transport,
216
'', lockable_files.TransportLock)
217
temp_control._transport.mkdir('.dummy',
218
# FIXME: RBC 20060121 don't peek under
220
mode=temp_control._dir_mode)
222
bzrdir_transport = transport.clone('.dummy')
223
# NB: no need to escape relative paths that are url safe.
224
control_files = lockable_files.LockableFiles(bzrdir_transport,
225
self._lock_file_name, self._lock_class)
226
control_files.create_lock()
227
return self.open(transport, _found=True)
229
def _open(self, transport):
230
return DummyForeignVcsDir(transport, self)
233
class DummyForeignVcsDir(bzrdir.BzrDirMeta1):
235
def __init__(self, _transport, _format):
236
self._format = _format
237
self.transport = _transport.clone('.dummy')
238
self.root_transport = _transport
239
self._mode_check_done = False
240
self._control_files = lockable_files.LockableFiles(self.transport,
241
"lock", lockable_files.TransportLock)
243
def open_branch(self, name=None, unsupported=False, ignore_fallbacks=True):
245
raise errors.NoColocatedBranchSupport(self)
246
return self._format.get_branch_format().open(self, _found=True)
248
def cloning_metadir(self, stacked=False):
249
"""Produce a metadir suitable for cloning with."""
250
return bzrdir.format_registry.make_bzrdir("default")
252
def sprout(self, url, revision_id=None, force_new_repo=False,
253
recurse='down', possible_transports=None,
254
accelerator_tree=None, hardlink=False, stacked=False,
256
# dirstate doesn't cope with accelerator_trees well
257
# that have a different control dir
258
return super(DummyForeignVcsDir, self).sprout(url=url,
259
revision_id=revision_id, force_new_repo=force_new_repo,
260
recurse=recurse, possible_transports=possible_transports,
261
hardlink=hardlink, stacked=stacked, source_branch=source_branch)
264
def register_dummy_foreign_for_test(testcase):
265
controldir.ControlDirFormat.register_format(DummyForeignVcsDirFormat)
266
testcase.addCleanup(controldir.ControlDirFormat.unregister_format,
267
DummyForeignVcsDirFormat)
268
controldir.ControlDirFormat.register_prober(DummyForeignProber)
269
testcase.addCleanup(controldir.ControlDirFormat.unregister_prober,
271
# We need to register the optimiser to make the dummy appears really
272
# different from a regular bzr repository.
273
branch.InterBranch.register_optimiser(InterToDummyVcsBranch)
274
testcase.addCleanup(branch.InterBranch.unregister_optimiser,
275
InterToDummyVcsBranch)
278
class DummyForeignProber(controldir.Prober):
281
def probe_transport(klass, transport):
282
"""Return the .bzrdir style format present in a directory."""
283
if not transport.has('.dummy'):
284
raise errors.NotBranchError(path=transport.base)
285
return DummyForeignVcsDirFormat()
288
class ForeignVcsRegistryTests(tests.TestCase):
289
"""Tests for the ForeignVcsRegistry class."""
291
def test_parse_revision_id_no_dash(self):
292
reg = foreign.ForeignVcsRegistry()
293
self.assertRaises(errors.InvalidRevisionId,
294
reg.parse_revision_id, "invalid")
296
def test_parse_revision_id_unknown_mapping(self):
297
reg = foreign.ForeignVcsRegistry()
298
self.assertRaises(errors.InvalidRevisionId,
299
reg.parse_revision_id, "unknown-foreignrevid")
301
def test_parse_revision_id(self):
302
reg = foreign.ForeignVcsRegistry()
303
vcs = DummyForeignVcs()
304
reg.register("dummy", vcs, "Dummy VCS")
305
self.assertEquals((("some", "foreign", "revid"), DummyForeignVcsMapping(vcs)),
306
reg.parse_revision_id("dummy-v1:some-foreign-revid"))
309
class ForeignRevisionTests(tests.TestCase):
310
"""Tests for the ForeignRevision class."""
312
def test_create(self):
313
mapp = DummyForeignVcsMapping(DummyForeignVcs())
314
rev = foreign.ForeignRevision(("a", "foreign", "revid"),
315
mapp, "roundtripped-revid")
316
self.assertEquals("", rev.inventory_sha1)
317
self.assertEquals(("a", "foreign", "revid"), rev.foreign_revid)
318
self.assertEquals(mapp, rev.mapping)
321
class WorkingTreeFileUpdateTests(tests.TestCaseWithTransport):
322
"""Tests for update_workingtree_fileids()."""
324
def test_update_workingtree(self):
325
wt = self.make_branch_and_tree('br1')
326
self.build_tree_contents([('br1/bla', 'original contents\n')])
327
wt.add('bla', 'bla-a')
329
root_id = wt.get_root_id()
330
target = wt.bzrdir.sprout('br2').open_workingtree()
331
target.unversion(['bla-a'])
332
target.add('bla', 'bla-b')
333
target.commit('bla-b')
334
target_basis = target.basis_tree()
335
target_basis.lock_read()
336
self.addCleanup(target_basis.unlock)
337
foreign.update_workingtree_fileids(wt, target_basis)
340
self.assertEquals(set([root_id, "bla-b"]), set(wt.inventory))
345
class DummyForeignVcsTests(tests.TestCaseWithTransport):
346
"""Very basic test for DummyForeignVcs."""
349
super(DummyForeignVcsTests, self).setUp()
350
register_dummy_foreign_for_test(self)
352
def test_create(self):
353
"""Test we can create dummies."""
354
self.make_branch_and_tree("d", format=DummyForeignVcsDirFormat())
355
dir = bzrdir.BzrDir.open("d")
356
self.assertEquals("A Dummy VCS Dir", dir._format.get_format_string())
357
dir.open_repository()
359
dir.open_workingtree()
361
def test_sprout(self):
362
"""Test we can clone dummies and that the format is not preserved."""
363
self.make_branch_and_tree("d", format=DummyForeignVcsDirFormat())
364
dir = bzrdir.BzrDir.open("d")
365
newdir = dir.sprout("e")
366
self.assertNotEquals("A Dummy VCS Dir",
367
newdir._format.get_format_string())
369
def test_push_not_supported(self):
370
source_tree = self.make_branch_and_tree("source")
371
target_tree = self.make_branch_and_tree("target",
372
format=DummyForeignVcsDirFormat())
373
self.assertRaises(errors.NoRoundtrippingSupport,
374
source_tree.branch.push, target_tree.branch)
376
def test_lossy_push_empty(self):
377
source_tree = self.make_branch_and_tree("source")
378
target_tree = self.make_branch_and_tree("target",
379
format=DummyForeignVcsDirFormat())
380
pushresult = source_tree.branch.lossy_push(target_tree.branch)
381
self.assertEquals(revision.NULL_REVISION, pushresult.old_revid)
382
self.assertEquals(revision.NULL_REVISION, pushresult.new_revid)
383
self.assertEquals({}, pushresult.revidmap)
385
def test_lossy_push_simple(self):
386
source_tree = self.make_branch_and_tree("source")
387
self.build_tree(['source/a', 'source/b'])
388
source_tree.add(['a', 'b'])
389
revid1 = source_tree.commit("msg")
390
target_tree = self.make_branch_and_tree("target",
391
format=DummyForeignVcsDirFormat())
392
target_tree.branch.lock_write()
394
pushresult = source_tree.branch.lossy_push(target_tree.branch)
396
target_tree.branch.unlock()
397
self.assertEquals(revision.NULL_REVISION, pushresult.old_revid)
398
self.assertEquals({revid1:target_tree.branch.last_revision()},
400
self.assertEquals(pushresult.revidmap[revid1], pushresult.new_revid)