1
# Copyright (C) 2008 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."""
29
from bzrlib.bzrdir import (
36
from bzrlib.inventory import Inventory
37
from bzrlib.revision import Revision
38
from bzrlib.tests import (
40
TestCaseWithTransport,
43
# This is the dummy foreign revision control system, used
44
# mainly here in the testsuite to test the foreign VCS infrastructure.
45
# It is basically standard Bazaar with some minor modifications to
48
# It has the following differences to "regular" Bazaar:
49
# - The control directory is named ".dummy", not ".bzr".
50
# - The revision ids are tuples, not strings.
51
# - Doesn't support more than one parent natively
54
class DummyForeignVcsMapping(foreign.VcsMapping):
55
"""A simple mapping for the dummy Foreign VCS, for use with testing."""
57
def __eq__(self, other):
58
return type(self) == type(other)
60
def revision_id_bzr_to_foreign(self, bzr_revid):
61
return tuple(bzr_revid[len("dummy-v1:"):].split("-")), self
63
def revision_id_foreign_to_bzr(self, foreign_revid):
64
return "dummy-v1:%s-%s-%s" % foreign_revid
67
class DummyForeignVcsMappingRegistry(foreign.VcsMappingRegistry):
69
def revision_id_bzr_to_foreign(self, revid):
70
if not revid.startswith("dummy-"):
71
raise errors.InvalidRevisionId(revid, None)
72
mapping_version = revid[len("dummy-"):len("dummy-vx")]
73
mapping = self.get(mapping_version)
74
return mapping.revision_id_bzr_to_foreign(revid)
77
class DummyForeignVcs(foreign.ForeignVcs):
78
"""A dummy Foreign VCS, for use with testing.
80
It has revision ids that are a tuple with three strings.
84
self.mapping_registry = DummyForeignVcsMappingRegistry()
85
self.mapping_registry.register("v1", DummyForeignVcsMapping(self),
88
def show_foreign_revid(self, foreign_revid):
89
return { "dummy ding": "%s/%s\\%s" % foreign_revid }
92
class DummyForeignVcsBranch(branch.BzrBranch6,foreign.ForeignBranch):
93
"""A Dummy VCS Branch."""
95
def __init__(self, _format, _control_files, a_bzrdir, *args, **kwargs):
96
self._format = _format
97
self._base = a_bzrdir.transport.base
98
self._ignore_fallbacks = False
99
foreign.ForeignBranch.__init__(self,
100
DummyForeignVcsMapping(DummyForeignVcs()))
101
branch.BzrBranch6.__init__(self, _format, _control_files, a_bzrdir,
105
class InterToDummyVcsBranch(branch.GenericInterBranch,
106
foreign.InterToForeignBranch):
109
def is_compatible(source, target):
110
return isinstance(target, DummyForeignVcsBranch)
112
def lossy_push(self, stop_revision=None):
113
self.source.lock_read()
115
# This just handles simple cases, but that's good enough for tests
116
my_history = self.target.revision_history()
117
their_history = self.source.revision_history()
118
if their_history[:min(len(my_history), len(their_history))] != my_history:
119
raise errors.DivergedBranches(self.target, self.source)
120
todo = their_history[len(my_history):]
123
rev = self.source.repository.get_revision(revid)
124
tree = self.source.repository.revision_tree(revid)
125
def get_file_with_stat(file_id, path=None):
126
return (tree.get_file(file_id), None)
127
tree.get_file_with_stat = get_file_with_stat
128
new_revid = self.target.mapping.revision_id_foreign_to_bzr(
129
(str(rev.timestamp), str(rev.timezone),
130
str(self.target.revno())))
131
parent_revno, parent_revid= self.target.last_revision_info()
132
builder = self.target.get_commit_builder([parent_revid],
133
self.target.get_config(), rev.timestamp,
134
rev.timezone, rev.committer, rev.properties,
137
for path, ie in tree.inventory.iter_entries():
139
new_ie.revision = None
140
builder.record_entry_contents(new_ie,
141
[self.target.repository.get_inventory(parent_revid)],
143
(ie.kind, ie.text_size, ie.executable, ie.text_sha1))
144
builder.finish_inventory()
148
revidmap[revid] = builder.commit(rev.message)
149
self.target.set_last_revision_info(parent_revno+1,
151
trace.mutter('lossily pushed revision %s -> %s',
152
revid, revidmap[revid])
158
class DummyForeignVcsBranchFormat(branch.BzrBranchFormat6):
160
def get_format_string(self):
161
return "Branch for Testing"
164
super(DummyForeignVcsBranchFormat, self).__init__()
165
self._matchingbzrdir = DummyForeignVcsDirFormat()
167
def open(self, a_bzrdir, _found=False):
169
raise NotImplementedError
171
transport = a_bzrdir.get_branch_transport(None)
172
control_files = lockable_files.LockableFiles(transport, 'lock',
174
return DummyForeignVcsBranch(_format=self,
175
_control_files=control_files,
177
_repository=a_bzrdir.find_repository())
178
except errors.NoSuchFile:
179
raise errors.NotBranchError(path=transport.base)
182
class DummyForeignVcsDirFormat(BzrDirMetaFormat1):
183
"""BzrDirFormat for the dummy foreign VCS."""
186
def get_format_string(cls):
187
return "A Dummy VCS Dir"
190
def get_format_description(cls):
191
return "A Dummy VCS Dir"
194
def is_supported(cls):
197
def get_branch_format(self):
198
return DummyForeignVcsBranchFormat()
201
def probe_transport(klass, transport):
202
"""Return the .bzrdir style format present in a directory."""
203
if not transport.has('.dummy'):
204
raise errors.NotBranchError(path=transport.base)
207
def initialize_on_transport(self, transport):
208
"""Initialize a new bzrdir in the base directory of a Transport."""
209
# Since we don't have a .bzr directory, inherit the
210
# mode from the root directory
211
temp_control = lockable_files.LockableFiles(transport,
212
'', lockable_files.TransportLock)
213
temp_control._transport.mkdir('.dummy',
214
# FIXME: RBC 20060121 don't peek under
216
mode=temp_control._dir_mode)
218
bzrdir_transport = transport.clone('.dummy')
219
# NB: no need to escape relative paths that are url safe.
220
control_files = lockable_files.LockableFiles(bzrdir_transport,
221
self._lock_file_name, self._lock_class)
222
control_files.create_lock()
223
return self.open(transport, _found=True)
225
def _open(self, transport):
226
return DummyForeignVcsDir(transport, self)
229
class DummyForeignVcsDir(BzrDirMeta1):
231
def __init__(self, _transport, _format):
232
self._format = _format
233
self.transport = _transport.clone('.dummy')
234
self.root_transport = _transport
235
self._mode_check_done = False
236
self._control_files = lockable_files.LockableFiles(self.transport,
237
"lock", lockable_files.TransportLock)
239
def open_branch(self, ignore_fallbacks=True):
240
return self._format.get_branch_format().open(self, _found=True)
242
def cloning_metadir(self, stacked=False):
243
"""Produce a metadir suitable for cloning with."""
244
return format_registry.make_bzrdir("default")
246
def sprout(self, url, revision_id=None, force_new_repo=False,
247
recurse='down', possible_transports=None,
248
accelerator_tree=None, hardlink=False, stacked=False,
250
# dirstate doesn't cope with accelerator_trees well
251
# that have a different control dir
252
return super(DummyForeignVcsDir, self).sprout(url=url,
253
revision_id=revision_id, force_new_repo=force_new_repo,
254
recurse=recurse, possible_transports=possible_transports,
255
hardlink=hardlink, stacked=stacked, source_branch=source_branch)
258
class ForeignVcsRegistryTests(TestCase):
259
"""Tests for the ForeignVcsRegistry class."""
261
def test_parse_revision_id_no_dash(self):
262
reg = foreign.ForeignVcsRegistry()
263
self.assertRaises(errors.InvalidRevisionId,
264
reg.parse_revision_id, "invalid")
266
def test_parse_revision_id_unknown_mapping(self):
267
reg = foreign.ForeignVcsRegistry()
268
self.assertRaises(errors.InvalidRevisionId,
269
reg.parse_revision_id, "unknown-foreignrevid")
271
def test_parse_revision_id(self):
272
reg = foreign.ForeignVcsRegistry()
273
vcs = DummyForeignVcs()
274
reg.register("dummy", vcs, "Dummy VCS")
275
self.assertEquals((("some", "foreign", "revid"), DummyForeignVcsMapping(vcs)),
276
reg.parse_revision_id("dummy-v1:some-foreign-revid"))
279
class ForeignRevisionTests(TestCase):
280
"""Tests for the ForeignRevision class."""
282
def test_create(self):
283
mapp = DummyForeignVcsMapping(DummyForeignVcs())
284
rev = foreign.ForeignRevision(("a", "foreign", "revid"),
285
mapp, "roundtripped-revid")
286
self.assertEquals("", rev.inventory_sha1)
287
self.assertEquals(("a", "foreign", "revid"), rev.foreign_revid)
288
self.assertEquals(mapp, rev.mapping)
291
class ShowForeignPropertiesTests(TestCase):
292
"""Tests for the show_foreign_properties() function."""
295
super(ShowForeignPropertiesTests, self).setUp()
296
self.vcs = DummyForeignVcs()
297
foreign.foreign_vcs_registry.register("dummy",
298
self.vcs, "Dummy VCS")
301
super(ShowForeignPropertiesTests, self).tearDown()
302
foreign.foreign_vcs_registry.remove("dummy")
304
def test_show_non_foreign(self):
305
"""Test use with a native (non-foreign) bzr revision."""
306
self.assertEquals({}, foreign.show_foreign_properties(Revision("arevid")))
308
def test_show_imported(self):
309
rev = Revision("dummy-v1:my-foreign-revid")
310
self.assertEquals({ "dummy ding": "my/foreign\\revid" },
311
foreign.show_foreign_properties(rev))
313
def test_show_direct(self):
314
rev = foreign.ForeignRevision(("some", "foreign", "revid"),
315
DummyForeignVcsMapping(self.vcs),
317
self.assertEquals({ "dummy ding": "some/foreign\\revid" },
318
foreign.show_foreign_properties(rev))
321
class WorkingTreeFileUpdateTests(TestCaseWithTransport):
322
"""Tests for update_workingtree_fileids()."""
324
def test_update_workingtree(self):
325
wt = self.make_branch_and_tree('br1')
326
self.build_tree_contents([('br1/bla', 'original contents\n')])
327
wt.add('bla', 'bla-a')
329
target = wt.bzrdir.sprout('br2').open_workingtree()
330
target.unversion(['bla-a'])
331
target.add('bla', 'bla-b')
332
target.commit('bla-b')
333
target_basis = target.basis_tree()
334
target_basis.lock_read()
335
self.addCleanup(target_basis.unlock)
336
foreign.update_workingtree_fileids(wt, target_basis)
339
self.assertEquals(["TREE_ROOT", "bla-b"], list(wt.inventory))
344
class DummyForeignVcsTests(TestCaseWithTransport):
345
"""Very basic test for DummyForeignVcs."""
348
BzrDirFormat.register_control_format(DummyForeignVcsDirFormat)
349
branch.InterBranch.register_optimiser(InterToDummyVcsBranch)
350
self.addCleanup(self.unregister)
351
super(DummyForeignVcsTests, self).setUp()
353
def unregister(self):
355
BzrDirFormat.unregister_control_format(DummyForeignVcsDirFormat)
358
branch.InterBranch.unregister_optimiser(InterToDummyVcsBranch)
360
def test_create(self):
361
"""Test we can create dummies."""
362
self.make_branch_and_tree("d", format=DummyForeignVcsDirFormat())
363
dir = BzrDir.open("d")
364
self.assertEquals("A Dummy VCS Dir", dir._format.get_format_string())
365
dir.open_repository()
367
dir.open_workingtree()
369
def test_sprout(self):
370
"""Test we can clone dummies and that the format is not preserved."""
371
self.make_branch_and_tree("d", format=DummyForeignVcsDirFormat())
372
dir = BzrDir.open("d")
373
newdir = dir.sprout("e")
374
self.assertNotEquals("A Dummy VCS Dir", newdir._format.get_format_string())