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(b"dummy-v1:"):].split(b"-")), self
61
def revision_id_foreign_to_bzr(self, foreign_revid):
62
return b"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(b"dummy-"):
69
raise errors.InvalidRevisionId(revid, None)
70
mapping_version = revid[len(b"dummy-"):len(b"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(b"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.VersionedFileCommitBuilder):
128
def _generate_revision_if_needed(self, revid):
129
mapping = DummyForeignVcsMapping(DummyForeignVcs())
131
self._new_revision_id = mapping.revision_id_foreign_to_bzr(
132
(b'%d' % self._timestamp,
133
str(self._timezone).encode('ascii'), b"UNKNOWN"))
134
self.random_revid = False
135
elif revid is not None:
136
self._new_revision_id = revid
137
self.random_revid = False
139
self._new_revision_id = self._gen_revision_id()
140
self.random_revid = True
143
class DummyForeignVcsRepository(groupcompress_repo.CHKInventoryRepository,
144
foreign.ForeignRepository):
145
"""Dummy foreign vcs repository."""
148
class DummyForeignVcsRepositoryFormat(groupcompress_repo.RepositoryFormat2a):
150
repository_class = DummyForeignVcsRepository
151
_commit_builder_class = DummyForeignCommitBuilder
154
def get_format_string(cls):
155
return b"Dummy Foreign Vcs Repository"
157
def get_format_description(self):
158
return "Dummy Foreign Vcs Repository"
161
def branch_history(graph, revid):
162
ret = list(graph.iter_lefthand_ancestry(revid,
163
(revision.NULL_REVISION,)))
168
class InterToDummyVcsBranch(branch.GenericInterBranch):
171
def is_compatible(source, target):
172
return isinstance(target, DummyForeignVcsBranch)
174
def push(self, overwrite=False, stop_revision=None, lossy=False):
176
raise errors.NoRoundtrippingSupport(self.source, self.target)
177
result = branch.BranchPushResult()
178
result.source_branch = self.source
179
result.target_branch = self.target
180
result.old_revno, result.old_revid = self.target.last_revision_info()
181
self.source.lock_read()
183
graph = self.source.repository.get_graph()
184
# This just handles simple cases, but that's good enough for tests
185
my_history = branch_history(self.target.repository.get_graph(),
187
if stop_revision is None:
188
stop_revision = self.source.last_revision()
189
their_history = branch_history(graph, stop_revision)
190
if their_history[:min(len(my_history), len(their_history))] != my_history:
191
raise errors.DivergedBranches(self.target, self.source)
192
todo = their_history[len(my_history):]
195
rev = self.source.repository.get_revision(revid)
196
tree = self.source.repository.revision_tree(revid)
198
def get_file_with_stat(path, file_id=None):
199
return (tree.get_file(path, file_id), None)
200
tree.get_file_with_stat = get_file_with_stat
201
new_revid = self.target.mapping.revision_id_foreign_to_bzr(
202
(b'%d' % rev.timestamp, str(rev.timezone).encode('ascii'),
203
str(self.target.revno()).encode('ascii')))
204
parent_revno, parent_revid = self.target.last_revision_info()
205
if parent_revid == revision.NULL_REVISION:
208
parent_revids = [parent_revid]
209
builder = self.target.get_commit_builder(parent_revids,
210
self.target.get_config_stack(), rev.timestamp,
211
rev.timezone, rev.committer, rev.properties,
214
parent_tree = self.target.repository.revision_tree(
216
iter_changes = tree.iter_changes(parent_tree)
217
list(builder.record_iter_changes(
218
tree, parent_revid, iter_changes))
219
builder.finish_inventory()
223
revidmap[revid] = builder.commit(rev.message)
224
self.target.set_last_revision_info(parent_revno + 1,
226
trace.mutter('lossily pushed revision %s -> %s',
227
revid, revidmap[revid])
230
result.new_revno, result.new_revid = self.target.last_revision_info()
231
result.revidmap = revidmap
235
class DummyForeignVcsBranchFormat(bzrbranch.BzrBranchFormat6):
238
def get_format_string(cls):
239
return b"Branch for Testing"
242
def _matchingcontroldir(self):
243
return DummyForeignVcsDirFormat()
245
def open(self, a_controldir, name=None, _found=False, ignore_fallbacks=False,
246
found_repository=None):
248
name = a_controldir._get_selected_branch()
250
raise NotImplementedError
252
transport = a_controldir.get_branch_transport(None, name=name)
253
control_files = lockable_files.LockableFiles(transport, 'lock',
255
if found_repository is None:
256
found_repository = a_controldir.find_repository()
257
return DummyForeignVcsBranch(_format=self,
258
_control_files=control_files,
259
a_controldir=a_controldir,
260
_repository=found_repository,
262
except errors.NoSuchFile:
263
raise errors.NotBranchError(path=transport.base)
266
class DummyForeignVcsDirFormat(bzrdir.BzrDirMetaFormat1):
267
"""BzrDirFormat for the dummy foreign VCS."""
270
def get_format_string(cls):
271
return b"A Dummy VCS Dir"
274
def get_format_description(cls):
275
return "A Dummy VCS Dir"
278
def is_supported(cls):
281
def get_branch_format(self):
282
return DummyForeignVcsBranchFormat()
285
def repository_format(self):
286
return DummyForeignVcsRepositoryFormat()
288
def initialize_on_transport(self, transport):
289
"""Initialize a new bzrdir in the base directory of a Transport."""
290
# Since we don't have a .bzr directory, inherit the
291
# mode from the root directory
292
temp_control = lockable_files.LockableFiles(transport,
293
'', lockable_files.TransportLock)
294
temp_control._transport.mkdir('.dummy',
295
# FIXME: RBC 20060121 don't peek under
297
mode=temp_control._dir_mode)
299
bzrdir_transport = transport.clone('.dummy')
300
# NB: no need to escape relative paths that are url safe.
301
control_files = lockable_files.LockableFiles(bzrdir_transport,
302
self._lock_file_name, self._lock_class)
303
control_files.create_lock()
304
return self.open(transport, _found=True)
306
def _open(self, transport):
307
return DummyForeignVcsDir(transport, self)
310
class DummyForeignVcsDir(bzrdir.BzrDirMeta1):
312
def __init__(self, _transport, _format):
313
self._format = _format
314
self.transport = _transport.clone('.dummy')
315
self.root_transport = _transport
316
self._mode_check_done = False
317
self._control_files = lockable_files.LockableFiles(self.transport,
318
"lock", lockable_files.TransportLock)
320
def create_workingtree(self):
321
# dirstate requires a ".bzr" entry to exist
322
self.root_transport.put_bytes(".bzr", b"foo")
323
return super(DummyForeignVcsDir, self).create_workingtree()
325
def open_branch(self, name=None, unsupported=False, ignore_fallbacks=True,
326
possible_transports=None):
328
name = self._get_selected_branch()
330
raise errors.NoColocatedBranchSupport(self)
331
return self._format.get_branch_format().open(self, _found=True)
333
def cloning_metadir(self, stacked=False):
334
"""Produce a metadir suitable for cloning with."""
335
return controldir.format_registry.make_controldir("default")
337
def checkout_metadir(self):
338
return self.cloning_metadir()
340
def sprout(self, url, revision_id=None, force_new_repo=False,
341
recurse='down', possible_transports=None,
342
accelerator_tree=None, hardlink=False, stacked=False,
344
# dirstate doesn't cope with accelerator_trees well
345
# that have a different control dir
346
return super(DummyForeignVcsDir, self).sprout(
348
revision_id=revision_id, force_new_repo=force_new_repo,
349
recurse=recurse, possible_transports=possible_transports,
350
hardlink=hardlink, stacked=stacked, source_branch=source_branch)
353
def register_dummy_foreign_for_test(testcase):
354
controldir.ControlDirFormat.register_prober(DummyForeignProber)
355
testcase.addCleanup(controldir.ControlDirFormat.unregister_prober,
357
repository.format_registry.register(DummyForeignVcsRepositoryFormat())
358
testcase.addCleanup(repository.format_registry.remove,
359
DummyForeignVcsRepositoryFormat())
360
branch.format_registry.register(DummyForeignVcsBranchFormat())
361
testcase.addCleanup(branch.format_registry.remove,
362
DummyForeignVcsBranchFormat())
363
# We need to register the optimiser to make the dummy appears really
364
# different from a regular bzr repository.
365
branch.InterBranch.register_optimiser(InterToDummyVcsBranch)
366
testcase.addCleanup(branch.InterBranch.unregister_optimiser,
367
InterToDummyVcsBranch)
370
class DummyForeignProber(controldir.Prober):
373
def probe_transport(klass, transport):
374
"""Return the .bzrdir style format present in a directory."""
375
if not transport.has('.dummy'):
376
raise errors.NotBranchError(path=transport.base)
377
return DummyForeignVcsDirFormat()
380
def known_formats(cls):
381
return [DummyForeignVcsDirFormat()]
384
class ForeignVcsRegistryTests(tests.TestCase):
385
"""Tests for the ForeignVcsRegistry class."""
387
def test_parse_revision_id_no_dash(self):
388
reg = foreign.ForeignVcsRegistry()
389
self.assertRaises(errors.InvalidRevisionId,
390
reg.parse_revision_id, b"invalid")
392
def test_parse_revision_id_unknown_mapping(self):
393
reg = foreign.ForeignVcsRegistry()
394
self.assertRaises(errors.InvalidRevisionId,
395
reg.parse_revision_id, b"unknown-foreignrevid")
397
def test_parse_revision_id(self):
398
reg = foreign.ForeignVcsRegistry()
399
vcs = DummyForeignVcs()
400
reg.register("dummy", vcs, "Dummy VCS")
402
(b"some", b"foreign", b"revid"), DummyForeignVcsMapping(vcs)),
403
reg.parse_revision_id(b"dummy-v1:some-foreign-revid"))
406
class ForeignRevisionTests(tests.TestCase):
407
"""Tests for the ForeignRevision class."""
409
def test_create(self):
410
mapp = DummyForeignVcsMapping(DummyForeignVcs())
411
rev = foreign.ForeignRevision((b"a", b"foreign", b"revid"),
412
mapp, b"roundtripped-revid")
413
self.assertEqual(b"", rev.inventory_sha1)
414
self.assertEqual((b"a", b"foreign", b"revid"), rev.foreign_revid)
415
self.assertEqual(mapp, rev.mapping)
418
class DummyForeignVcsTests(tests.TestCaseWithTransport):
419
"""Very basic test for DummyForeignVcs."""
422
super(DummyForeignVcsTests, self).setUp()
423
register_dummy_foreign_for_test(self)
425
def test_create(self):
426
"""Test we can create dummies."""
427
self.make_branch_and_tree("d", format=DummyForeignVcsDirFormat())
428
dir = controldir.ControlDir.open("d")
429
self.assertEqual(b"A Dummy VCS Dir", dir._format.get_format_string())
430
dir.open_repository()
432
dir.open_workingtree()
434
def test_sprout(self):
435
"""Test we can clone dummies and that the format is not preserved."""
436
self.make_branch_and_tree("d", format=DummyForeignVcsDirFormat())
437
dir = controldir.ControlDir.open("d")
438
newdir = dir.sprout("e")
439
self.assertNotEqual(b"A Dummy VCS Dir",
440
newdir._format.get_format_string())
442
def test_push_not_supported(self):
443
source_tree = self.make_branch_and_tree("source")
444
target_tree = self.make_branch_and_tree(
445
"target", format=DummyForeignVcsDirFormat())
446
self.assertRaises(errors.NoRoundtrippingSupport,
447
source_tree.branch.push, target_tree.branch)
449
def test_lossy_push_empty(self):
450
source_tree = self.make_branch_and_tree("source")
451
target_tree = self.make_branch_and_tree(
452
"target", format=DummyForeignVcsDirFormat())
453
pushresult = source_tree.branch.push(target_tree.branch, lossy=True)
454
self.assertEqual(revision.NULL_REVISION, pushresult.old_revid)
455
self.assertEqual(revision.NULL_REVISION, pushresult.new_revid)
456
self.assertEqual({}, pushresult.revidmap)
458
def test_lossy_push_simple(self):
459
source_tree = self.make_branch_and_tree("source")
460
self.build_tree(['source/a', 'source/b'])
461
source_tree.add(['a', 'b'])
462
revid1 = source_tree.commit("msg")
463
target_tree = self.make_branch_and_tree(
464
"target", format=DummyForeignVcsDirFormat())
465
target_tree.branch.lock_write()
467
pushresult = source_tree.branch.push(
468
target_tree.branch, lossy=True)
470
target_tree.branch.unlock()
471
self.assertEqual(revision.NULL_REVISION, pushresult.old_revid)
472
self.assertEqual({revid1: target_tree.branch.last_revision()},
474
self.assertEqual(pushresult.revidmap[revid1], pushresult.new_revid)