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, lightweight=False):
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
def branch_history(graph, revid):
152
ret = list(graph.iter_lefthand_ancestry(revid,
153
(revision.NULL_REVISION,)))
158
class InterToDummyVcsBranch(branch.GenericInterBranch):
161
def is_compatible(source, target):
162
return isinstance(target, DummyForeignVcsBranch)
164
def push(self, overwrite=False, stop_revision=None, lossy=False):
166
raise errors.NoRoundtrippingSupport(self.source, self.target)
167
result = branch.BranchPushResult()
168
result.source_branch = self.source
169
result.target_branch = self.target
170
result.old_revno, result.old_revid = self.target.last_revision_info()
171
self.source.lock_read()
173
graph = self.source.repository.get_graph()
174
# This just handles simple cases, but that's good enough for tests
175
my_history = branch_history(self.target.repository.get_graph(),
177
if stop_revision is None:
178
stop_revision = self.source.last_revision()
179
their_history = branch_history(graph, stop_revision)
180
if their_history[:min(len(my_history), len(their_history))] != my_history:
181
raise errors.DivergedBranches(self.target, self.source)
182
todo = their_history[len(my_history):]
185
rev = self.source.repository.get_revision(revid)
186
tree = self.source.repository.revision_tree(revid)
187
def get_file_with_stat(file_id, path=None):
188
return (tree.get_file(file_id), None)
189
tree.get_file_with_stat = get_file_with_stat
190
new_revid = self.target.mapping.revision_id_foreign_to_bzr(
191
(str(rev.timestamp), str(rev.timezone),
192
str(self.target.revno())))
193
parent_revno, parent_revid= self.target.last_revision_info()
194
if parent_revid == revision.NULL_REVISION:
197
parent_revids = [parent_revid]
198
builder = self.target.get_commit_builder(parent_revids,
199
self.target.get_config(), rev.timestamp,
200
rev.timezone, rev.committer, rev.properties,
203
for path, ie in tree.inventory.iter_entries():
205
new_ie.revision = None
206
builder.record_entry_contents(new_ie,
207
[self.target.repository.revision_tree(parent_revid).inventory],
209
(ie.kind, ie.text_size, ie.executable, ie.text_sha1))
210
builder.finish_inventory()
214
revidmap[revid] = builder.commit(rev.message)
215
self.target.set_last_revision_info(parent_revno+1,
217
trace.mutter('lossily pushed revision %s -> %s',
218
revid, revidmap[revid])
221
result.new_revno, result.new_revid = self.target.last_revision_info()
222
result.revidmap = revidmap
226
class DummyForeignVcsBranchFormat(branch.BzrBranchFormat6):
228
def get_format_string(self):
229
return "Branch for Testing"
232
def _matchingbzrdir(self):
233
return DummyForeignVcsDirFormat()
235
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
236
found_repository=None):
238
raise NotImplementedError
240
transport = a_bzrdir.get_branch_transport(None, name=name)
241
control_files = lockable_files.LockableFiles(transport, 'lock',
243
if found_repository is None:
244
found_repository = a_bzrdir.find_repository()
245
return DummyForeignVcsBranch(_format=self,
246
_control_files=control_files,
248
_repository=found_repository)
249
except errors.NoSuchFile:
250
raise errors.NotBranchError(path=transport.base)
253
class DummyForeignVcsDirFormat(bzrdir.BzrDirMetaFormat1):
254
"""BzrDirFormat for the dummy foreign VCS."""
257
def get_format_string(cls):
258
return "A Dummy VCS Dir"
261
def get_format_description(cls):
262
return "A Dummy VCS Dir"
265
def is_supported(cls):
268
def get_branch_format(self):
269
return DummyForeignVcsBranchFormat()
272
def repository_format(self):
273
return DummyForeignVcsRepositoryFormat()
275
def initialize_on_transport(self, transport):
276
"""Initialize a new bzrdir in the base directory of a Transport."""
277
# Since we don't have a .bzr directory, inherit the
278
# mode from the root directory
279
temp_control = lockable_files.LockableFiles(transport,
280
'', lockable_files.TransportLock)
281
temp_control._transport.mkdir('.dummy',
282
# FIXME: RBC 20060121 don't peek under
284
mode=temp_control._dir_mode)
286
bzrdir_transport = transport.clone('.dummy')
287
# NB: no need to escape relative paths that are url safe.
288
control_files = lockable_files.LockableFiles(bzrdir_transport,
289
self._lock_file_name, self._lock_class)
290
control_files.create_lock()
291
return self.open(transport, _found=True)
293
def _open(self, transport):
294
return DummyForeignVcsDir(transport, self)
297
class DummyForeignVcsDir(bzrdir.BzrDirMeta1):
299
def __init__(self, _transport, _format):
300
self._format = _format
301
self.transport = _transport.clone('.dummy')
302
self.root_transport = _transport
303
self._mode_check_done = False
304
self._control_files = lockable_files.LockableFiles(self.transport,
305
"lock", lockable_files.TransportLock)
307
def create_workingtree(self):
308
# dirstate requires a ".bzr" entry to exist
309
self.root_transport.put_bytes(".bzr", "foo")
310
return super(DummyForeignVcsDir, self).create_workingtree()
312
def open_branch(self, name=None, unsupported=False, ignore_fallbacks=True):
314
raise errors.NoColocatedBranchSupport(self)
315
return self._format.get_branch_format().open(self, _found=True)
317
def cloning_metadir(self, stacked=False):
318
"""Produce a metadir suitable for cloning with."""
319
return bzrdir.format_registry.make_bzrdir("default")
321
def checkout_metadir(self):
322
return self.cloning_metadir()
324
def sprout(self, url, revision_id=None, force_new_repo=False,
325
recurse='down', possible_transports=None,
326
accelerator_tree=None, hardlink=False, stacked=False,
328
# dirstate doesn't cope with accelerator_trees well
329
# that have a different control dir
330
return super(DummyForeignVcsDir, self).sprout(url=url,
331
revision_id=revision_id, force_new_repo=force_new_repo,
332
recurse=recurse, possible_transports=possible_transports,
333
hardlink=hardlink, stacked=stacked, source_branch=source_branch)
336
def register_dummy_foreign_for_test(testcase):
337
controldir.ControlDirFormat.register_prober(DummyForeignProber)
338
testcase.addCleanup(controldir.ControlDirFormat.unregister_prober,
340
repository.format_registry.register(DummyForeignVcsRepositoryFormat())
341
testcase.addCleanup(repository.format_registry.remove,
342
DummyForeignVcsRepositoryFormat())
343
branch.format_registry.register(DummyForeignVcsBranchFormat())
344
testcase.addCleanup(branch.format_registry.remove,
345
DummyForeignVcsBranchFormat())
346
# We need to register the optimiser to make the dummy appears really
347
# different from a regular bzr repository.
348
branch.InterBranch.register_optimiser(InterToDummyVcsBranch)
349
testcase.addCleanup(branch.InterBranch.unregister_optimiser,
350
InterToDummyVcsBranch)
353
class DummyForeignProber(controldir.Prober):
356
def probe_transport(klass, transport):
357
"""Return the .bzrdir style format present in a directory."""
358
if not transport.has('.dummy'):
359
raise errors.NotBranchError(path=transport.base)
360
return DummyForeignVcsDirFormat()
363
def known_formats(cls):
364
return set([DummyForeignVcsDirFormat()])
367
class ForeignVcsRegistryTests(tests.TestCase):
368
"""Tests for the ForeignVcsRegistry class."""
370
def test_parse_revision_id_no_dash(self):
371
reg = foreign.ForeignVcsRegistry()
372
self.assertRaises(errors.InvalidRevisionId,
373
reg.parse_revision_id, "invalid")
375
def test_parse_revision_id_unknown_mapping(self):
376
reg = foreign.ForeignVcsRegistry()
377
self.assertRaises(errors.InvalidRevisionId,
378
reg.parse_revision_id, "unknown-foreignrevid")
380
def test_parse_revision_id(self):
381
reg = foreign.ForeignVcsRegistry()
382
vcs = DummyForeignVcs()
383
reg.register("dummy", vcs, "Dummy VCS")
385
("some", "foreign", "revid"), DummyForeignVcsMapping(vcs)),
386
reg.parse_revision_id("dummy-v1:some-foreign-revid"))
389
class ForeignRevisionTests(tests.TestCase):
390
"""Tests for the ForeignRevision class."""
392
def test_create(self):
393
mapp = DummyForeignVcsMapping(DummyForeignVcs())
394
rev = foreign.ForeignRevision(("a", "foreign", "revid"),
395
mapp, "roundtripped-revid")
396
self.assertEquals("", rev.inventory_sha1)
397
self.assertEquals(("a", "foreign", "revid"), rev.foreign_revid)
398
self.assertEquals(mapp, rev.mapping)
401
class WorkingTreeFileUpdateTests(tests.TestCaseWithTransport):
402
"""Tests for update_workingtree_fileids()."""
404
def test_update_workingtree(self):
405
wt = self.make_branch_and_tree('br1')
406
self.build_tree_contents([('br1/bla', 'original contents\n')])
407
wt.add('bla', 'bla-a')
409
root_id = wt.get_root_id()
410
target = wt.bzrdir.sprout('br2').open_workingtree()
411
target.unversion(['bla-a'])
412
target.add('bla', 'bla-b')
413
target.commit('bla-b')
414
target_basis = target.basis_tree()
415
target_basis.lock_read()
416
self.addCleanup(target_basis.unlock)
417
foreign.update_workingtree_fileids(wt, target_basis)
420
self.assertEquals(set([root_id, "bla-b"]), set(wt.inventory))
425
class DummyForeignVcsTests(tests.TestCaseWithTransport):
426
"""Very basic test for DummyForeignVcs."""
429
super(DummyForeignVcsTests, self).setUp()
430
register_dummy_foreign_for_test(self)
432
def test_create(self):
433
"""Test we can create dummies."""
434
self.make_branch_and_tree("d", format=DummyForeignVcsDirFormat())
435
dir = bzrdir.BzrDir.open("d")
436
self.assertEquals("A Dummy VCS Dir", dir._format.get_format_string())
437
dir.open_repository()
439
dir.open_workingtree()
441
def test_sprout(self):
442
"""Test we can clone dummies and that the format is not preserved."""
443
self.make_branch_and_tree("d", format=DummyForeignVcsDirFormat())
444
dir = bzrdir.BzrDir.open("d")
445
newdir = dir.sprout("e")
446
self.assertNotEquals("A Dummy VCS Dir",
447
newdir._format.get_format_string())
449
def test_push_not_supported(self):
450
source_tree = self.make_branch_and_tree("source")
451
target_tree = self.make_branch_and_tree("target",
452
format=DummyForeignVcsDirFormat())
453
self.assertRaises(errors.NoRoundtrippingSupport,
454
source_tree.branch.push, target_tree.branch)
456
def test_lossy_push_empty(self):
457
source_tree = self.make_branch_and_tree("source")
458
target_tree = self.make_branch_and_tree("target",
459
format=DummyForeignVcsDirFormat())
460
pushresult = source_tree.branch.push(target_tree.branch, lossy=True)
461
self.assertEquals(revision.NULL_REVISION, pushresult.old_revid)
462
self.assertEquals(revision.NULL_REVISION, pushresult.new_revid)
463
self.assertEquals({}, pushresult.revidmap)
465
def test_lossy_push_simple(self):
466
source_tree = self.make_branch_and_tree("source")
467
self.build_tree(['source/a', 'source/b'])
468
source_tree.add(['a', 'b'])
469
revid1 = source_tree.commit("msg")
470
target_tree = self.make_branch_and_tree("target",
471
format=DummyForeignVcsDirFormat())
472
target_tree.branch.lock_write()
474
pushresult = source_tree.branch.push(
475
target_tree.branch, lossy=True)
477
target_tree.branch.unlock()
478
self.assertEquals(revision.NULL_REVISION, pushresult.old_revid)
479
self.assertEquals({revid1:target_tree.branch.last_revision()},
481
self.assertEquals(pushresult.revidmap[revid1], pushresult.new_revid)
added
removed
bzrlib/tests/test_foreign.py
