1
# Copyright (C) 2008-2012, 2016 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."""
39
from ..bzr import groupcompress_repo
41
# This is the dummy foreign revision control system, used
42
# mainly here in the testsuite to test the foreign VCS infrastructure.
43
# It is basically standard Bazaar with some minor modifications to
46
# It has the following differences to "regular" Bazaar:
47
# - The control directory is named ".dummy", not ".bzr".
48
# - The revision ids are tuples, not strings.
49
# - Doesn't support more than one parent natively
52
class DummyForeignVcsMapping(foreign.VcsMapping):
53
"""A simple mapping for the dummy Foreign VCS, for use with testing."""
55
def __eq__(self, other):
56
return isinstance(self, type(other))
58
def revision_id_bzr_to_foreign(self, bzr_revid):
59
return tuple(bzr_revid[len("dummy-v1:"):].split("-")), self
61
def revision_id_foreign_to_bzr(self, foreign_revid):
62
return "dummy-v1:%s-%s-%s" % foreign_revid
65
class DummyForeignVcsMappingRegistry(foreign.VcsMappingRegistry):
67
def revision_id_bzr_to_foreign(self, revid):
68
if not revid.startswith("dummy-"):
69
raise errors.InvalidRevisionId(revid, None)
70
mapping_version = revid[len("dummy-"):len("dummy-vx")]
71
mapping = self.get(mapping_version)
72
return mapping.revision_id_bzr_to_foreign(revid)
75
class DummyForeignVcs(foreign.ForeignVcs):
76
"""A dummy Foreign VCS, for use with testing.
78
It has revision ids that are a tuple with three strings.
82
self.mapping_registry = DummyForeignVcsMappingRegistry()
83
self.mapping_registry.register("v1", DummyForeignVcsMapping(self),
85
self.abbreviation = "dummy"
87
def show_foreign_revid(self, foreign_revid):
88
return { "dummy ding": "%s/%s\\%s" % foreign_revid }
90
def serialize_foreign_revid(self, foreign_revid):
91
return "%s|%s|%s" % foreign_revid
94
class DummyForeignVcsBranch(bzrbranch.BzrBranch6,foreign.ForeignBranch):
95
"""A Dummy VCS Branch."""
98
def user_transport(self):
99
return self.controldir.user_transport
101
def __init__(self, _format, _control_files, a_controldir, *args, **kwargs):
102
self._format = _format
103
self._base = a_controldir.transport.base
104
self._ignore_fallbacks = False
105
self.controldir = a_controldir
106
foreign.ForeignBranch.__init__(self,
107
DummyForeignVcsMapping(DummyForeignVcs()))
108
bzrbranch.BzrBranch6.__init__(self, _format, _control_files, a_controldir,
111
def _get_checkout_format(self, lightweight=False):
112
"""Return the most suitable metadir for a checkout of this branch.
113
Weaves are used if this branch's repository uses weaves.
115
return self.controldir.checkout_metadir()
117
def import_last_revision_info_and_tags(self, source, revno, revid,
119
interbranch = InterToDummyVcsBranch(source, self)
120
result = interbranch.push(stop_revision=revid, lossy=True)
122
revid = result.revidmap[revid]
123
return (revno, revid)
126
class DummyForeignCommitBuilder(vf_repository.VersionedFileRootCommitBuilder):
128
def _generate_revision_if_needed(self):
129
mapping = DummyForeignVcsMapping(DummyForeignVcs())
131
self._new_revision_id = mapping.revision_id_foreign_to_bzr(
132
(str(self._timestamp), str(self._timezone), "UNKNOWN"))
133
self.random_revid = False
134
elif self._new_revision_id is not None:
135
self.random_revid = False
137
self._new_revision_id = self._gen_revision_id()
138
self.random_revid = True
141
class DummyForeignVcsRepository(groupcompress_repo.CHKInventoryRepository,
142
foreign.ForeignRepository):
143
"""Dummy foreign vcs repository."""
146
class DummyForeignVcsRepositoryFormat(groupcompress_repo.RepositoryFormat2a):
148
repository_class = DummyForeignVcsRepository
149
_commit_builder_class = DummyForeignCommitBuilder
152
def get_format_string(cls):
153
return "Dummy Foreign Vcs Repository"
155
def get_format_description(self):
156
return "Dummy Foreign Vcs Repository"
159
def branch_history(graph, revid):
160
ret = list(graph.iter_lefthand_ancestry(revid,
161
(revision.NULL_REVISION,)))
166
class InterToDummyVcsBranch(branch.GenericInterBranch):
169
def is_compatible(source, target):
170
return isinstance(target, DummyForeignVcsBranch)
172
def push(self, overwrite=False, stop_revision=None, lossy=False):
174
raise errors.NoRoundtrippingSupport(self.source, self.target)
175
result = branch.BranchPushResult()
176
result.source_branch = self.source
177
result.target_branch = self.target
178
result.old_revno, result.old_revid = self.target.last_revision_info()
179
self.source.lock_read()
181
graph = self.source.repository.get_graph()
182
# This just handles simple cases, but that's good enough for tests
183
my_history = branch_history(self.target.repository.get_graph(),
185
if stop_revision is None:
186
stop_revision = self.source.last_revision()
187
their_history = branch_history(graph, stop_revision)
188
if their_history[:min(len(my_history), len(their_history))] != my_history:
189
raise errors.DivergedBranches(self.target, self.source)
190
todo = their_history[len(my_history):]
193
rev = self.source.repository.get_revision(revid)
194
tree = self.source.repository.revision_tree(revid)
195
def get_file_with_stat(file_id, path=None):
196
return (tree.get_file(file_id), None)
197
tree.get_file_with_stat = get_file_with_stat
198
new_revid = self.target.mapping.revision_id_foreign_to_bzr(
199
(str(rev.timestamp), str(rev.timezone),
200
str(self.target.revno())))
201
parent_revno, parent_revid= self.target.last_revision_info()
202
if parent_revid == revision.NULL_REVISION:
205
parent_revids = [parent_revid]
206
builder = self.target.get_commit_builder(parent_revids,
207
self.target.get_config_stack(), rev.timestamp,
208
rev.timezone, rev.committer, rev.properties,
211
parent_tree = self.target.repository.revision_tree(
213
for path, ie in tree.iter_entries_by_dir():
215
new_ie.revision = None
216
builder.record_entry_contents(new_ie,
217
[parent_tree.root_inventory],
219
(ie.kind, ie.text_size, ie.executable, ie.text_sha1))
220
builder.finish_inventory()
224
revidmap[revid] = builder.commit(rev.message)
225
self.target.set_last_revision_info(parent_revno+1,
227
trace.mutter('lossily pushed revision %s -> %s',
228
revid, revidmap[revid])
231
result.new_revno, result.new_revid = self.target.last_revision_info()
232
result.revidmap = revidmap
236
class DummyForeignVcsBranchFormat(bzrbranch.BzrBranchFormat6):
239
def get_format_string(cls):
240
return "Branch for Testing"
243
def _matchingbzrdir(self):
244
return DummyForeignVcsDirFormat()
246
def open(self, a_controldir, name=None, _found=False, ignore_fallbacks=False,
247
found_repository=None):
249
name = a_controldir._get_selected_branch()
251
raise NotImplementedError
253
transport = a_controldir.get_branch_transport(None, name=name)
254
control_files = lockable_files.LockableFiles(transport, 'lock',
256
if found_repository is None:
257
found_repository = a_controldir.find_repository()
258
return DummyForeignVcsBranch(_format=self,
259
_control_files=control_files,
260
a_controldir=a_controldir,
261
_repository=found_repository,
263
except errors.NoSuchFile:
264
raise errors.NotBranchError(path=transport.base)
267
class DummyForeignVcsDirFormat(bzrdir.BzrDirMetaFormat1):
268
"""BzrDirFormat for the dummy foreign VCS."""
271
def get_format_string(cls):
272
return "A Dummy VCS Dir"
275
def get_format_description(cls):
276
return "A Dummy VCS Dir"
279
def is_supported(cls):
282
def get_branch_format(self):
283
return DummyForeignVcsBranchFormat()
286
def repository_format(self):
287
return DummyForeignVcsRepositoryFormat()
289
def initialize_on_transport(self, transport):
290
"""Initialize a new bzrdir in the base directory of a Transport."""
291
# Since we don't have a .bzr directory, inherit the
292
# mode from the root directory
293
temp_control = lockable_files.LockableFiles(transport,
294
'', lockable_files.TransportLock)
295
temp_control._transport.mkdir('.dummy',
296
# FIXME: RBC 20060121 don't peek under
298
mode=temp_control._dir_mode)
300
bzrdir_transport = transport.clone('.dummy')
301
# NB: no need to escape relative paths that are url safe.
302
control_files = lockable_files.LockableFiles(bzrdir_transport,
303
self._lock_file_name, self._lock_class)
304
control_files.create_lock()
305
return self.open(transport, _found=True)
307
def _open(self, transport):
308
return DummyForeignVcsDir(transport, self)
311
class DummyForeignVcsDir(bzrdir.BzrDirMeta1):
313
def __init__(self, _transport, _format):
314
self._format = _format
315
self.transport = _transport.clone('.dummy')
316
self.root_transport = _transport
317
self._mode_check_done = False
318
self._control_files = lockable_files.LockableFiles(self.transport,
319
"lock", lockable_files.TransportLock)
321
def create_workingtree(self):
322
# dirstate requires a ".bzr" entry to exist
323
self.root_transport.put_bytes(".bzr", "foo")
324
return super(DummyForeignVcsDir, self).create_workingtree()
326
def open_branch(self, name=None, unsupported=False, ignore_fallbacks=True,
327
possible_transports=None):
329
name = self._get_selected_branch()
331
raise errors.NoColocatedBranchSupport(self)
332
return self._format.get_branch_format().open(self, _found=True)
334
def cloning_metadir(self, stacked=False):
335
"""Produce a metadir suitable for cloning with."""
336
return controldir.format_registry.make_controldir("default")
338
def checkout_metadir(self):
339
return self.cloning_metadir()
341
def sprout(self, url, revision_id=None, force_new_repo=False,
342
recurse='down', possible_transports=None,
343
accelerator_tree=None, hardlink=False, stacked=False,
345
# dirstate doesn't cope with accelerator_trees well
346
# that have a different control dir
347
return super(DummyForeignVcsDir, self).sprout(
349
revision_id=revision_id, force_new_repo=force_new_repo,
350
recurse=recurse, possible_transports=possible_transports,
351
hardlink=hardlink, stacked=stacked, source_branch=source_branch)
354
def register_dummy_foreign_for_test(testcase):
355
controldir.ControlDirFormat.register_prober(DummyForeignProber)
356
testcase.addCleanup(controldir.ControlDirFormat.unregister_prober,
358
repository.format_registry.register(DummyForeignVcsRepositoryFormat())
359
testcase.addCleanup(repository.format_registry.remove,
360
DummyForeignVcsRepositoryFormat())
361
branch.format_registry.register(DummyForeignVcsBranchFormat())
362
testcase.addCleanup(branch.format_registry.remove,
363
DummyForeignVcsBranchFormat())
364
# We need to register the optimiser to make the dummy appears really
365
# different from a regular bzr repository.
366
branch.InterBranch.register_optimiser(InterToDummyVcsBranch)
367
testcase.addCleanup(branch.InterBranch.unregister_optimiser,
368
InterToDummyVcsBranch)
371
class DummyForeignProber(controldir.Prober):
374
def probe_transport(klass, transport):
375
"""Return the .bzrdir style format present in a directory."""
376
if not transport.has('.dummy'):
377
raise errors.NotBranchError(path=transport.base)
378
return DummyForeignVcsDirFormat()
381
def known_formats(cls):
382
return {DummyForeignVcsDirFormat()}
385
class ForeignVcsRegistryTests(tests.TestCase):
386
"""Tests for the ForeignVcsRegistry class."""
388
def test_parse_revision_id_no_dash(self):
389
reg = foreign.ForeignVcsRegistry()
390
self.assertRaises(errors.InvalidRevisionId,
391
reg.parse_revision_id, "invalid")
393
def test_parse_revision_id_unknown_mapping(self):
394
reg = foreign.ForeignVcsRegistry()
395
self.assertRaises(errors.InvalidRevisionId,
396
reg.parse_revision_id, "unknown-foreignrevid")
398
def test_parse_revision_id(self):
399
reg = foreign.ForeignVcsRegistry()
400
vcs = DummyForeignVcs()
401
reg.register("dummy", vcs, "Dummy VCS")
403
("some", "foreign", "revid"), DummyForeignVcsMapping(vcs)),
404
reg.parse_revision_id("dummy-v1:some-foreign-revid"))
407
class ForeignRevisionTests(tests.TestCase):
408
"""Tests for the ForeignRevision class."""
410
def test_create(self):
411
mapp = DummyForeignVcsMapping(DummyForeignVcs())
412
rev = foreign.ForeignRevision(("a", "foreign", "revid"),
413
mapp, "roundtripped-revid")
414
self.assertEqual("", rev.inventory_sha1)
415
self.assertEqual(("a", "foreign", "revid"), rev.foreign_revid)
416
self.assertEqual(mapp, rev.mapping)
419
class WorkingTreeFileUpdateTests(tests.TestCaseWithTransport):
420
"""Tests for update_workingtree_fileids()."""
422
def test_update_workingtree(self):
423
wt = self.make_branch_and_tree('br1')
424
self.build_tree_contents([('br1/bla', 'original contents\n')])
425
wt.add('bla', 'bla-a')
427
root_id = wt.get_root_id()
428
target = wt.controldir.sprout('br2').open_workingtree()
429
target.unversion(['bla-a'])
430
target.add('bla', 'bla-b')
431
target.commit('bla-b')
432
target_basis = target.basis_tree()
433
target_basis.lock_read()
434
self.addCleanup(target_basis.unlock)
435
foreign.update_workingtree_fileids(wt, target_basis)
438
self.assertEqual({root_id, "bla-b"}, set(wt.all_file_ids()))
443
class DummyForeignVcsTests(tests.TestCaseWithTransport):
444
"""Very basic test for DummyForeignVcs."""
447
super(DummyForeignVcsTests, self).setUp()
448
register_dummy_foreign_for_test(self)
450
def test_create(self):
451
"""Test we can create dummies."""
452
self.make_branch_and_tree("d", format=DummyForeignVcsDirFormat())
453
dir = controldir.ControlDir.open("d")
454
self.assertEqual("A Dummy VCS Dir", dir._format.get_format_string())
455
dir.open_repository()
457
dir.open_workingtree()
459
def test_sprout(self):
460
"""Test we can clone dummies and that the format is not preserved."""
461
self.make_branch_and_tree("d", format=DummyForeignVcsDirFormat())
462
dir = controldir.ControlDir.open("d")
463
newdir = dir.sprout("e")
464
self.assertNotEqual("A Dummy VCS Dir",
465
newdir._format.get_format_string())
467
def test_push_not_supported(self):
468
source_tree = self.make_branch_and_tree("source")
469
target_tree = self.make_branch_and_tree(
470
"target", format=DummyForeignVcsDirFormat())
471
self.assertRaises(errors.NoRoundtrippingSupport,
472
source_tree.branch.push, target_tree.branch)
474
def test_lossy_push_empty(self):
475
source_tree = self.make_branch_and_tree("source")
476
target_tree = self.make_branch_and_tree(
477
"target", format=DummyForeignVcsDirFormat())
478
pushresult = source_tree.branch.push(target_tree.branch, lossy=True)
479
self.assertEqual(revision.NULL_REVISION, pushresult.old_revid)
480
self.assertEqual(revision.NULL_REVISION, pushresult.new_revid)
481
self.assertEqual({}, pushresult.revidmap)
483
def test_lossy_push_simple(self):
484
source_tree = self.make_branch_and_tree("source")
485
self.build_tree(['source/a', 'source/b'])
486
source_tree.add(['a', 'b'])
487
revid1 = source_tree.commit("msg")
488
target_tree = self.make_branch_and_tree(
489
"target", format=DummyForeignVcsDirFormat())
490
target_tree.branch.lock_write()
492
pushresult = source_tree.branch.push(
493
target_tree.branch, lossy=True)
495
target_tree.branch.unlock()
496
self.assertEqual(revision.NULL_REVISION, pushresult.old_revid)
497
self.assertEqual({revid1: target_tree.branch.last_revision()},
499
self.assertEqual(pushresult.revidmap[revid1], pushresult.new_revid)