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."""
95
def user_transport(self):
96
return self.bzrdir.user_transport
98
def __init__(self, _format, _control_files, a_bzrdir, *args, **kwargs):
99
self._format = _format
100
self._base = a_bzrdir.transport.base
101
self._ignore_fallbacks = False
102
self.bzrdir = a_bzrdir
103
foreign.ForeignBranch.__init__(self,
104
DummyForeignVcsMapping(DummyForeignVcs()))
105
branch.BzrBranch6.__init__(self, _format, _control_files, a_bzrdir,
108
def _get_checkout_format(self, lightweight=False):
109
"""Return the most suitable metadir for a checkout of this branch.
110
Weaves are used if this branch's repository uses weaves.
112
return self.bzrdir.checkout_metadir()
114
def import_last_revision_info_and_tags(self, source, revno, revid,
116
interbranch = InterToDummyVcsBranch(source, self)
117
result = interbranch.push(stop_revision=revid, lossy=True)
119
revid = result.revidmap[revid]
120
return (revno, revid)
123
class DummyForeignCommitBuilder(vf_repository.VersionedFileRootCommitBuilder):
125
def _generate_revision_if_needed(self):
126
mapping = DummyForeignVcsMapping(DummyForeignVcs())
128
self._new_revision_id = mapping.revision_id_foreign_to_bzr(
129
(str(self._timestamp), str(self._timezone), "UNKNOWN"))
130
self.random_revid = False
131
elif self._new_revision_id is not None:
132
self.random_revid = False
134
self._new_revision_id = self._gen_revision_id()
135
self.random_revid = True
138
class DummyForeignVcsRepository(groupcompress_repo.CHKInventoryRepository,
139
foreign.ForeignRepository):
140
"""Dummy foreign vcs repository."""
143
class DummyForeignVcsRepositoryFormat(groupcompress_repo.RepositoryFormat2a):
145
repository_class = DummyForeignVcsRepository
146
_commit_builder_class = DummyForeignCommitBuilder
148
def get_format_string(self):
149
return "Dummy Foreign Vcs Repository"
151
def get_format_description(self):
152
return "Dummy Foreign Vcs Repository"
155
def branch_history(graph, revid):
156
ret = list(graph.iter_lefthand_ancestry(revid,
157
(revision.NULL_REVISION,)))
162
class InterToDummyVcsBranch(branch.GenericInterBranch):
165
def is_compatible(source, target):
166
return isinstance(target, DummyForeignVcsBranch)
168
def push(self, overwrite=False, stop_revision=None, lossy=False):
170
raise errors.NoRoundtrippingSupport(self.source, self.target)
171
result = branch.BranchPushResult()
172
result.source_branch = self.source
173
result.target_branch = self.target
174
result.old_revno, result.old_revid = self.target.last_revision_info()
175
self.source.lock_read()
177
graph = self.source.repository.get_graph()
178
# This just handles simple cases, but that's good enough for tests
179
my_history = branch_history(self.target.repository.get_graph(),
181
if stop_revision is None:
182
stop_revision = self.source.last_revision()
183
their_history = branch_history(graph, stop_revision)
184
if their_history[:min(len(my_history), len(their_history))] != my_history:
185
raise errors.DivergedBranches(self.target, self.source)
186
todo = their_history[len(my_history):]
189
rev = self.source.repository.get_revision(revid)
190
tree = self.source.repository.revision_tree(revid)
191
def get_file_with_stat(file_id, path=None):
192
return (tree.get_file(file_id), None)
193
tree.get_file_with_stat = get_file_with_stat
194
new_revid = self.target.mapping.revision_id_foreign_to_bzr(
195
(str(rev.timestamp), str(rev.timezone),
196
str(self.target.revno())))
197
parent_revno, parent_revid= self.target.last_revision_info()
198
if parent_revid == revision.NULL_REVISION:
201
parent_revids = [parent_revid]
202
builder = self.target.get_commit_builder(parent_revids,
203
self.target.get_config(), rev.timestamp,
204
rev.timezone, rev.committer, rev.properties,
207
for path, ie in tree.inventory.iter_entries():
209
new_ie.revision = None
210
builder.record_entry_contents(new_ie,
211
[self.target.repository.revision_tree(parent_revid).inventory],
213
(ie.kind, ie.text_size, ie.executable, ie.text_sha1))
214
builder.finish_inventory()
218
revidmap[revid] = builder.commit(rev.message)
219
self.target.set_last_revision_info(parent_revno+1,
221
trace.mutter('lossily pushed revision %s -> %s',
222
revid, revidmap[revid])
225
result.new_revno, result.new_revid = self.target.last_revision_info()
226
result.revidmap = revidmap
230
class DummyForeignVcsBranchFormat(branch.BzrBranchFormat6):
232
def get_format_string(self):
233
return "Branch for Testing"
236
def _matchingbzrdir(self):
237
return DummyForeignVcsDirFormat()
239
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
240
found_repository=None):
242
raise NotImplementedError
244
transport = a_bzrdir.get_branch_transport(None, name=name)
245
control_files = lockable_files.LockableFiles(transport, 'lock',
247
if found_repository is None:
248
found_repository = a_bzrdir.find_repository()
249
return DummyForeignVcsBranch(_format=self,
250
_control_files=control_files,
252
_repository=found_repository)
253
except errors.NoSuchFile:
254
raise errors.NotBranchError(path=transport.base)
257
class DummyForeignVcsDirFormat(bzrdir.BzrDirMetaFormat1):
258
"""BzrDirFormat for the dummy foreign VCS."""
261
def get_format_string(cls):
262
return "A Dummy VCS Dir"
265
def get_format_description(cls):
266
return "A Dummy VCS Dir"
269
def is_supported(cls):
272
def get_branch_format(self):
273
return DummyForeignVcsBranchFormat()
276
def repository_format(self):
277
return DummyForeignVcsRepositoryFormat()
279
def initialize_on_transport(self, transport):
280
"""Initialize a new bzrdir in the base directory of a Transport."""
281
# Since we don't have a .bzr directory, inherit the
282
# mode from the root directory
283
temp_control = lockable_files.LockableFiles(transport,
284
'', lockable_files.TransportLock)
285
temp_control._transport.mkdir('.dummy',
286
# FIXME: RBC 20060121 don't peek under
288
mode=temp_control._dir_mode)
290
bzrdir_transport = transport.clone('.dummy')
291
# NB: no need to escape relative paths that are url safe.
292
control_files = lockable_files.LockableFiles(bzrdir_transport,
293
self._lock_file_name, self._lock_class)
294
control_files.create_lock()
295
return self.open(transport, _found=True)
297
def _open(self, transport):
298
return DummyForeignVcsDir(transport, self)
301
class DummyForeignVcsDir(bzrdir.BzrDirMeta1):
303
def __init__(self, _transport, _format):
304
self._format = _format
305
self.transport = _transport.clone('.dummy')
306
self.root_transport = _transport
307
self._mode_check_done = False
308
self._control_files = lockable_files.LockableFiles(self.transport,
309
"lock", lockable_files.TransportLock)
311
def create_workingtree(self):
312
# dirstate requires a ".bzr" entry to exist
313
self.root_transport.put_bytes(".bzr", "foo")
314
return super(DummyForeignVcsDir, self).create_workingtree()
316
def open_branch(self, name=None, unsupported=False, ignore_fallbacks=True,
317
possible_transports=None):
319
raise errors.NoColocatedBranchSupport(self)
320
return self._format.get_branch_format().open(self, _found=True)
322
def cloning_metadir(self, stacked=False):
323
"""Produce a metadir suitable for cloning with."""
324
return bzrdir.format_registry.make_bzrdir("default")
326
def checkout_metadir(self):
327
return self.cloning_metadir()
329
def sprout(self, url, revision_id=None, force_new_repo=False,
330
recurse='down', possible_transports=None,
331
accelerator_tree=None, hardlink=False, stacked=False,
333
# dirstate doesn't cope with accelerator_trees well
334
# that have a different control dir
335
return super(DummyForeignVcsDir, self).sprout(url=url,
336
revision_id=revision_id, force_new_repo=force_new_repo,
337
recurse=recurse, possible_transports=possible_transports,
338
hardlink=hardlink, stacked=stacked, source_branch=source_branch)
341
def register_dummy_foreign_for_test(testcase):
342
controldir.ControlDirFormat.register_prober(DummyForeignProber)
343
testcase.addCleanup(controldir.ControlDirFormat.unregister_prober,
345
repository.format_registry.register(DummyForeignVcsRepositoryFormat())
346
testcase.addCleanup(repository.format_registry.remove,
347
DummyForeignVcsRepositoryFormat())
348
branch.format_registry.register(DummyForeignVcsBranchFormat())
349
testcase.addCleanup(branch.format_registry.remove,
350
DummyForeignVcsBranchFormat())
351
# We need to register the optimiser to make the dummy appears really
352
# different from a regular bzr repository.
353
branch.InterBranch.register_optimiser(InterToDummyVcsBranch)
354
testcase.addCleanup(branch.InterBranch.unregister_optimiser,
355
InterToDummyVcsBranch)
358
class DummyForeignProber(controldir.Prober):
361
def probe_transport(klass, transport):
362
"""Return the .bzrdir style format present in a directory."""
363
if not transport.has('.dummy'):
364
raise errors.NotBranchError(path=transport.base)
365
return DummyForeignVcsDirFormat()
368
def known_formats(cls):
369
return set([DummyForeignVcsDirFormat()])
372
class ForeignVcsRegistryTests(tests.TestCase):
373
"""Tests for the ForeignVcsRegistry class."""
375
def test_parse_revision_id_no_dash(self):
376
reg = foreign.ForeignVcsRegistry()
377
self.assertRaises(errors.InvalidRevisionId,
378
reg.parse_revision_id, "invalid")
380
def test_parse_revision_id_unknown_mapping(self):
381
reg = foreign.ForeignVcsRegistry()
382
self.assertRaises(errors.InvalidRevisionId,
383
reg.parse_revision_id, "unknown-foreignrevid")
385
def test_parse_revision_id(self):
386
reg = foreign.ForeignVcsRegistry()
387
vcs = DummyForeignVcs()
388
reg.register("dummy", vcs, "Dummy VCS")
390
("some", "foreign", "revid"), DummyForeignVcsMapping(vcs)),
391
reg.parse_revision_id("dummy-v1:some-foreign-revid"))
394
class ForeignRevisionTests(tests.TestCase):
395
"""Tests for the ForeignRevision class."""
397
def test_create(self):
398
mapp = DummyForeignVcsMapping(DummyForeignVcs())
399
rev = foreign.ForeignRevision(("a", "foreign", "revid"),
400
mapp, "roundtripped-revid")
401
self.assertEquals("", rev.inventory_sha1)
402
self.assertEquals(("a", "foreign", "revid"), rev.foreign_revid)
403
self.assertEquals(mapp, rev.mapping)
406
class WorkingTreeFileUpdateTests(tests.TestCaseWithTransport):
407
"""Tests for update_workingtree_fileids()."""
409
def test_update_workingtree(self):
410
wt = self.make_branch_and_tree('br1')
411
self.build_tree_contents([('br1/bla', 'original contents\n')])
412
wt.add('bla', 'bla-a')
414
root_id = wt.get_root_id()
415
target = wt.bzrdir.sprout('br2').open_workingtree()
416
target.unversion(['bla-a'])
417
target.add('bla', 'bla-b')
418
target.commit('bla-b')
419
target_basis = target.basis_tree()
420
target_basis.lock_read()
421
self.addCleanup(target_basis.unlock)
422
foreign.update_workingtree_fileids(wt, target_basis)
425
self.assertEquals(set([root_id, "bla-b"]), set(wt.inventory))
430
class DummyForeignVcsTests(tests.TestCaseWithTransport):
431
"""Very basic test for DummyForeignVcs."""
434
super(DummyForeignVcsTests, self).setUp()
435
register_dummy_foreign_for_test(self)
437
def test_create(self):
438
"""Test we can create dummies."""
439
self.make_branch_and_tree("d", format=DummyForeignVcsDirFormat())
440
dir = bzrdir.BzrDir.open("d")
441
self.assertEquals("A Dummy VCS Dir", dir._format.get_format_string())
442
dir.open_repository()
444
dir.open_workingtree()
446
def test_sprout(self):
447
"""Test we can clone dummies and that the format is not preserved."""
448
self.make_branch_and_tree("d", format=DummyForeignVcsDirFormat())
449
dir = bzrdir.BzrDir.open("d")
450
newdir = dir.sprout("e")
451
self.assertNotEquals("A Dummy VCS Dir",
452
newdir._format.get_format_string())
454
def test_push_not_supported(self):
455
source_tree = self.make_branch_and_tree("source")
456
target_tree = self.make_branch_and_tree("target",
457
format=DummyForeignVcsDirFormat())
458
self.assertRaises(errors.NoRoundtrippingSupport,
459
source_tree.branch.push, target_tree.branch)
461
def test_lossy_push_empty(self):
462
source_tree = self.make_branch_and_tree("source")
463
target_tree = self.make_branch_and_tree("target",
464
format=DummyForeignVcsDirFormat())
465
pushresult = source_tree.branch.push(target_tree.branch, lossy=True)
466
self.assertEquals(revision.NULL_REVISION, pushresult.old_revid)
467
self.assertEquals(revision.NULL_REVISION, pushresult.new_revid)
468
self.assertEquals({}, pushresult.revidmap)
470
def test_lossy_push_simple(self):
471
source_tree = self.make_branch_and_tree("source")
472
self.build_tree(['source/a', 'source/b'])
473
source_tree.add(['a', 'b'])
474
revid1 = source_tree.commit("msg")
475
target_tree = self.make_branch_and_tree("target",
476
format=DummyForeignVcsDirFormat())
477
target_tree.branch.lock_write()
479
pushresult = source_tree.branch.push(
480
target_tree.branch, lossy=True)
482
target_tree.branch.unlock()
483
self.assertEquals(revision.NULL_REVISION, pushresult.old_revid)
484
self.assertEquals({revid1:target_tree.branch.last_revision()},
486
self.assertEquals(pushresult.revidmap[revid1], pushresult.new_revid)
added
removed
bzrlib/tests/test_foreign.py
