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."""
36
from bzrlib.repofmt import groupcompress_repo
38
# This is the dummy foreign revision control system, used
39
# mainly here in the testsuite to test the foreign VCS infrastructure.
40
# It is basically standard Bazaar with some minor modifications to
43
# It has the following differences to "regular" Bazaar:
44
# - The control directory is named ".dummy", not ".bzr".
45
# - The revision ids are tuples, not strings.
46
# - Doesn't support more than one parent natively
49
class DummyForeignVcsMapping(foreign.VcsMapping):
50
"""A simple mapping for the dummy Foreign VCS, for use with testing."""
52
def __eq__(self, other):
53
return type(self) == type(other)
55
def revision_id_bzr_to_foreign(self, bzr_revid):
56
return tuple(bzr_revid[len("dummy-v1:"):].split("-")), self
58
def revision_id_foreign_to_bzr(self, foreign_revid):
59
return "dummy-v1:%s-%s-%s" % foreign_revid
62
class DummyForeignVcsMappingRegistry(foreign.VcsMappingRegistry):
64
def revision_id_bzr_to_foreign(self, revid):
65
if not revid.startswith("dummy-"):
66
raise errors.InvalidRevisionId(revid, None)
67
mapping_version = revid[len("dummy-"):len("dummy-vx")]
68
mapping = self.get(mapping_version)
69
return mapping.revision_id_bzr_to_foreign(revid)
72
class DummyForeignVcs(foreign.ForeignVcs):
73
"""A dummy Foreign VCS, for use with testing.
75
It has revision ids that are a tuple with three strings.
79
self.mapping_registry = DummyForeignVcsMappingRegistry()
80
self.mapping_registry.register("v1", DummyForeignVcsMapping(self),
82
self.abbreviation = "dummy"
84
def show_foreign_revid(self, foreign_revid):
85
return { "dummy ding": "%s/%s\\%s" % foreign_revid }
87
def serialize_foreign_revid(self, foreign_revid):
88
return "%s|%s|%s" % foreign_revid
91
class DummyForeignVcsBranch(branch.BzrBranch6,foreign.ForeignBranch):
92
"""A Dummy VCS Branch."""
94
def __init__(self, _format, _control_files, a_bzrdir, *args, **kwargs):
95
self._format = _format
96
self._base = a_bzrdir.transport.base
97
self._ignore_fallbacks = False
98
self.bzrdir = a_bzrdir
99
foreign.ForeignBranch.__init__(self,
100
DummyForeignVcsMapping(DummyForeignVcs()))
101
branch.BzrBranch6.__init__(self, _format, _control_files, a_bzrdir,
104
def _get_checkout_format(self):
105
"""Return the most suitable metadir for a checkout of this branch.
106
Weaves are used if this branch's repository uses weaves.
108
return self.bzrdir.checkout_metadir()
110
def import_last_revision_info_and_tags(self, source, revno, revid,
112
interbranch = InterToDummyVcsBranch(source, self)
113
result = interbranch.push(stop_revision=revid, lossy=True)
115
revid = result.revidmap[revid]
116
return (revno, revid)
119
class DummyForeignCommitBuilder(vf_repository.VersionedFileRootCommitBuilder):
121
def _generate_revision_if_needed(self):
122
mapping = DummyForeignVcsMapping(DummyForeignVcs())
124
self._new_revision_id = mapping.revision_id_foreign_to_bzr(
125
(str(self._timestamp), str(self._timezone), "UNKNOWN"))
126
self.random_revid = False
127
elif self._new_revision_id is not None:
128
self.random_revid = False
130
self._new_revision_id = self._gen_revision_id()
131
self.random_revid = True
134
class DummyForeignVcsRepository(groupcompress_repo.CHKInventoryRepository,
135
foreign.ForeignRepository):
136
"""Dummy foreign vcs repository."""
139
class DummyForeignVcsRepositoryFormat(groupcompress_repo.RepositoryFormat2a):
141
repository_class = DummyForeignVcsRepository
142
_commit_builder_class = DummyForeignCommitBuilder
144
def get_format_string(self):
145
return "Dummy Foreign Vcs Repository"
147
def get_format_description(self):
148
return "Dummy Foreign Vcs Repository"
151
class InterToDummyVcsBranch(branch.GenericInterBranch):
154
def is_compatible(source, target):
155
return isinstance(target, DummyForeignVcsBranch)
157
def push(self, overwrite=False, stop_revision=None, lossy=False):
159
raise errors.NoRoundtrippingSupport(self.source, self.target)
160
result = branch.BranchPushResult()
161
result.source_branch = self.source
162
result.target_branch = self.target
163
result.old_revno, result.old_revid = self.target.last_revision_info()
164
self.source.lock_read()
166
graph = self.source.repository.get_graph()
167
# This just handles simple cases, but that's good enough for tests
168
my_history = self.target.revision_history()
169
if stop_revision is None:
170
stop_revision = self.source.last_revision()
171
their_history = list(graph.iter_lefthand_ancestry(stop_revision,
172
(revision.NULL_REVISION,)))
173
their_history.reverse()
174
if their_history[:min(len(my_history), len(their_history))] != my_history:
175
raise errors.DivergedBranches(self.target, self.source)
176
todo = their_history[len(my_history):]
179
rev = self.source.repository.get_revision(revid)
180
tree = self.source.repository.revision_tree(revid)
181
def get_file_with_stat(file_id, path=None):
182
return (tree.get_file(file_id), None)
183
tree.get_file_with_stat = get_file_with_stat
184
new_revid = self.target.mapping.revision_id_foreign_to_bzr(
185
(str(rev.timestamp), str(rev.timezone),
186
str(self.target.revno())))
187
parent_revno, parent_revid= self.target.last_revision_info()
188
if parent_revid == revision.NULL_REVISION:
191
parent_revids = [parent_revid]
192
builder = self.target.get_commit_builder(parent_revids,
193
self.target.get_config(), rev.timestamp,
194
rev.timezone, rev.committer, rev.properties,
197
for path, ie in tree.inventory.iter_entries():
199
new_ie.revision = None
200
builder.record_entry_contents(new_ie,
201
[self.target.repository.revision_tree(parent_revid).inventory],
203
(ie.kind, ie.text_size, ie.executable, ie.text_sha1))
204
builder.finish_inventory()
208
revidmap[revid] = builder.commit(rev.message)
209
self.target.set_last_revision_info(parent_revno+1,
211
trace.mutter('lossily pushed revision %s -> %s',
212
revid, revidmap[revid])
215
result.new_revno, result.new_revid = self.target.last_revision_info()
216
result.revidmap = revidmap
220
class DummyForeignVcsBranchFormat(branch.BzrBranchFormat6):
222
def get_format_string(self):
223
return "Branch for Testing"
226
super(DummyForeignVcsBranchFormat, self).__init__()
227
self._matchingbzrdir = DummyForeignVcsDirFormat()
229
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
230
found_repository=None):
232
raise NotImplementedError
234
transport = a_bzrdir.get_branch_transport(None, name=name)
235
control_files = lockable_files.LockableFiles(transport, 'lock',
237
if found_repository is None:
238
found_repository = a_bzrdir.find_repository()
239
return DummyForeignVcsBranch(_format=self,
240
_control_files=control_files,
242
_repository=found_repository)
243
except errors.NoSuchFile:
244
raise errors.NotBranchError(path=transport.base)
247
class DummyForeignVcsDirFormat(bzrdir.BzrDirMetaFormat1):
248
"""BzrDirFormat for the dummy foreign VCS."""
251
def get_format_string(cls):
252
return "A Dummy VCS Dir"
255
def get_format_description(cls):
256
return "A Dummy VCS Dir"
259
def is_supported(cls):
262
def get_branch_format(self):
263
return DummyForeignVcsBranchFormat()
266
def repository_format(self):
267
return DummyForeignVcsRepositoryFormat()
269
def initialize_on_transport(self, transport):
270
"""Initialize a new bzrdir in the base directory of a Transport."""
271
# Since we don't have a .bzr directory, inherit the
272
# mode from the root directory
273
temp_control = lockable_files.LockableFiles(transport,
274
'', lockable_files.TransportLock)
275
temp_control._transport.mkdir('.dummy',
276
# FIXME: RBC 20060121 don't peek under
278
mode=temp_control._dir_mode)
280
bzrdir_transport = transport.clone('.dummy')
281
# NB: no need to escape relative paths that are url safe.
282
control_files = lockable_files.LockableFiles(bzrdir_transport,
283
self._lock_file_name, self._lock_class)
284
control_files.create_lock()
285
return self.open(transport, _found=True)
287
def _open(self, transport):
288
return DummyForeignVcsDir(transport, self)
291
class DummyForeignVcsDir(bzrdir.BzrDirMeta1):
293
def __init__(self, _transport, _format):
294
self._format = _format
295
self.transport = _transport.clone('.dummy')
296
self.root_transport = _transport
297
self._mode_check_done = False
298
self._control_files = lockable_files.LockableFiles(self.transport,
299
"lock", lockable_files.TransportLock)
301
def create_workingtree(self):
302
# dirstate requires a ".bzr" entry to exist
303
self.root_transport.put_bytes(".bzr", "foo")
304
return super(DummyForeignVcsDir, self).create_workingtree()
306
def open_branch(self, name=None, unsupported=False, ignore_fallbacks=True):
308
raise errors.NoColocatedBranchSupport(self)
309
return self._format.get_branch_format().open(self, _found=True)
311
def cloning_metadir(self, stacked=False):
312
"""Produce a metadir suitable for cloning with."""
313
return bzrdir.format_registry.make_bzrdir("default")
315
def checkout_metadir(self):
316
return self.cloning_metadir()
318
def sprout(self, url, revision_id=None, force_new_repo=False,
319
recurse='down', possible_transports=None,
320
accelerator_tree=None, hardlink=False, stacked=False,
322
# dirstate doesn't cope with accelerator_trees well
323
# that have a different control dir
324
return super(DummyForeignVcsDir, self).sprout(url=url,
325
revision_id=revision_id, force_new_repo=force_new_repo,
326
recurse=recurse, possible_transports=possible_transports,
327
hardlink=hardlink, stacked=stacked, source_branch=source_branch)
330
def register_dummy_foreign_for_test(testcase):
331
controldir.ControlDirFormat.register_prober(DummyForeignProber)
332
testcase.addCleanup(controldir.ControlDirFormat.unregister_prober,
334
repository.format_registry.register(DummyForeignVcsRepositoryFormat())
335
testcase.addCleanup(repository.format_registry.remove,
336
DummyForeignVcsRepositoryFormat())
337
branch.format_registry.register(DummyForeignVcsBranchFormat())
338
testcase.addCleanup(branch.format_registry.remove,
339
DummyForeignVcsBranchFormat())
340
# We need to register the optimiser to make the dummy appears really
341
# different from a regular bzr repository.
342
branch.InterBranch.register_optimiser(InterToDummyVcsBranch)
343
testcase.addCleanup(branch.InterBranch.unregister_optimiser,
344
InterToDummyVcsBranch)
347
class DummyForeignProber(controldir.Prober):
350
def probe_transport(klass, transport):
351
"""Return the .bzrdir style format present in a directory."""
352
if not transport.has('.dummy'):
353
raise errors.NotBranchError(path=transport.base)
354
return DummyForeignVcsDirFormat()
357
def known_formats(cls):
358
return set([DummyForeignVcsDirFormat()])
361
class ForeignVcsRegistryTests(tests.TestCase):
362
"""Tests for the ForeignVcsRegistry class."""
364
def test_parse_revision_id_no_dash(self):
365
reg = foreign.ForeignVcsRegistry()
366
self.assertRaises(errors.InvalidRevisionId,
367
reg.parse_revision_id, "invalid")
369
def test_parse_revision_id_unknown_mapping(self):
370
reg = foreign.ForeignVcsRegistry()
371
self.assertRaises(errors.InvalidRevisionId,
372
reg.parse_revision_id, "unknown-foreignrevid")
374
def test_parse_revision_id(self):
375
reg = foreign.ForeignVcsRegistry()
376
vcs = DummyForeignVcs()
377
reg.register("dummy", vcs, "Dummy VCS")
379
("some", "foreign", "revid"), DummyForeignVcsMapping(vcs)),
380
reg.parse_revision_id("dummy-v1:some-foreign-revid"))
383
class ForeignRevisionTests(tests.TestCase):
384
"""Tests for the ForeignRevision class."""
386
def test_create(self):
387
mapp = DummyForeignVcsMapping(DummyForeignVcs())
388
rev = foreign.ForeignRevision(("a", "foreign", "revid"),
389
mapp, "roundtripped-revid")
390
self.assertEquals("", rev.inventory_sha1)
391
self.assertEquals(("a", "foreign", "revid"), rev.foreign_revid)
392
self.assertEquals(mapp, rev.mapping)
395
class WorkingTreeFileUpdateTests(tests.TestCaseWithTransport):
396
"""Tests for update_workingtree_fileids()."""
398
def test_update_workingtree(self):
399
wt = self.make_branch_and_tree('br1')
400
self.build_tree_contents([('br1/bla', 'original contents\n')])
401
wt.add('bla', 'bla-a')
403
root_id = wt.get_root_id()
404
target = wt.bzrdir.sprout('br2').open_workingtree()
405
target.unversion(['bla-a'])
406
target.add('bla', 'bla-b')
407
target.commit('bla-b')
408
target_basis = target.basis_tree()
409
target_basis.lock_read()
410
self.addCleanup(target_basis.unlock)
411
foreign.update_workingtree_fileids(wt, target_basis)
414
self.assertEquals(set([root_id, "bla-b"]), set(wt.inventory))
419
class DummyForeignVcsTests(tests.TestCaseWithTransport):
420
"""Very basic test for DummyForeignVcs."""
423
super(DummyForeignVcsTests, self).setUp()
424
register_dummy_foreign_for_test(self)
426
def test_create(self):
427
"""Test we can create dummies."""
428
self.make_branch_and_tree("d", format=DummyForeignVcsDirFormat())
429
dir = bzrdir.BzrDir.open("d")
430
self.assertEquals("A Dummy VCS Dir", dir._format.get_format_string())
431
dir.open_repository()
433
dir.open_workingtree()
435
def test_sprout(self):
436
"""Test we can clone dummies and that the format is not preserved."""
437
self.make_branch_and_tree("d", format=DummyForeignVcsDirFormat())
438
dir = bzrdir.BzrDir.open("d")
439
newdir = dir.sprout("e")
440
self.assertNotEquals("A Dummy VCS Dir",
441
newdir._format.get_format_string())
443
def test_push_not_supported(self):
444
source_tree = self.make_branch_and_tree("source")
445
target_tree = self.make_branch_and_tree("target",
446
format=DummyForeignVcsDirFormat())
447
self.assertRaises(errors.NoRoundtrippingSupport,
448
source_tree.branch.push, target_tree.branch)
450
def test_lossy_push_empty(self):
451
source_tree = self.make_branch_and_tree("source")
452
target_tree = self.make_branch_and_tree("target",
453
format=DummyForeignVcsDirFormat())
454
pushresult = source_tree.branch.push(target_tree.branch, lossy=True)
455
self.assertEquals(revision.NULL_REVISION, pushresult.old_revid)
456
self.assertEquals(revision.NULL_REVISION, pushresult.new_revid)
457
self.assertEquals({}, pushresult.revidmap)
459
def test_lossy_push_simple(self):
460
source_tree = self.make_branch_and_tree("source")
461
self.build_tree(['source/a', 'source/b'])
462
source_tree.add(['a', 'b'])
463
revid1 = source_tree.commit("msg")
464
target_tree = self.make_branch_and_tree("target",
465
format=DummyForeignVcsDirFormat())
466
target_tree.branch.lock_write()
468
pushresult = source_tree.branch.push(target_tree.branch, lossy=True)
470
target_tree.branch.unlock()
471
self.assertEquals(revision.NULL_REVISION, pushresult.old_revid)
472
self.assertEquals({revid1:target_tree.branch.last_revision()},
474
self.assertEquals(pushresult.revidmap[revid1], pushresult.new_revid)
added
removed
bzrlib/tests/test_foreign.py
