/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to mapping.py

Add function for verifying reconstruction of objects still works.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mapping.py
1
1
# Copyright (C) 2007 Canonical Ltd
2
 
# Copyright (C) 2008-2010 Jelmer Vernooij <jelmer@samba.org>
 
2
# Copyright (C) 2008-2009 Jelmer Vernooij <jelmer@samba.org>
3
3
# Copyright (C) 2008 John Carr
4
4
#
5
5
# This program is free software; you can redistribute it and/or modify
22
22
import stat
23
23
 
24
24
from bzrlib import (
25
 
    bencode,
26
25
    errors,
27
26
    foreign,
 
27
    osutils,
28
28
    trace,
 
29
    urlutils,
29
30
    )
 
31
try:
 
32
    from bzrlib import bencode
 
33
except ImportError:
 
34
    from bzrlib.util import bencode
30
35
from bzrlib.inventory import (
31
36
    ROOT_ID,
32
37
    )
42
47
    format_hg_metadata,
43
48
    extract_hg_metadata,
44
49
    )
45
 
from bzrlib.plugins.git.roundtrip import (
46
 
    extract_bzr_metadata,
47
 
    inject_bzr_metadata,
48
 
    BzrGitRevisionMetadata,
49
 
    deserialize_fileid_map,
50
 
    serialize_fileid_map,
51
 
    )
52
50
 
53
51
DEFAULT_FILE_MODE = stat.S_IFREG | 0644
54
52
 
92
90
                 "property. ", mode, path, commit)
93
91
 
94
92
 
 
93
def squash_revision(target_repo, rev):
 
94
    """Remove characters that can't be stored from a revision, if necessary.
 
95
 
 
96
    :param target_repo: Repository in which the revision will be stored
 
97
    :param rev: Revision object, will be modified in-place
 
98
    """
 
99
    if not getattr(target_repo._serializer, "squashes_xml_invalid_characters", True):
 
100
        return
 
101
    from bzrlib.xml_serializer import escape_invalid_chars
 
102
    rev.message, num_escaped = escape_invalid_chars(rev.message)
 
103
    if num_escaped:
 
104
        warn_escaped(rev.foreign_revid, num_escaped)
 
105
    if 'author' in rev.properties:
 
106
        rev.properties['author'], num_escaped = escape_invalid_chars(
 
107
            rev.properties['author'])
 
108
        if num_escaped:
 
109
            warn_escaped(rev.foreign_revid, num_escaped)
 
110
    rev.committer, num_escaped = escape_invalid_chars(rev.committer)
 
111
    if num_escaped:
 
112
        warn_escaped(rev.foreign_revid, num_escaped)
 
113
 
 
114
 
95
115
class BzrGitMapping(foreign.VcsMapping):
96
116
    """Class that maps between Git and Bazaar semantics."""
97
117
    experimental = False
98
118
 
99
 
    BZR_FILE_IDS_FILE = None
100
 
 
101
 
    BZR_DUMMY_FILE = None
102
 
 
103
119
    def __init__(self):
104
120
        super(BzrGitMapping, self).__init__(foreign_git)
105
121
 
106
122
    def __eq__(self, other):
107
 
        return (type(self) == type(other) and
 
123
        return (type(self) == type(other) and 
108
124
                self.revid_prefix == other.revid_prefix)
109
125
 
110
126
    @classmethod
111
127
    def revision_id_foreign_to_bzr(cls, git_rev_id):
112
128
        """Convert a git revision id handle to a Bazaar revision id."""
113
 
        from dulwich.protocol import ZERO_SHA
114
 
        if git_rev_id == ZERO_SHA:
 
129
        if git_rev_id == "0" * 40:
115
130
            return NULL_REVISION
116
131
        return "%s:%s" % (cls.revid_prefix, git_rev_id)
117
132
 
127
142
        # We must just hope they are valid UTF-8..
128
143
        if path == "":
129
144
            return ROOT_ID
130
 
        if type(path) is unicode:
131
 
            path = path.encode("utf-8")
132
145
        return escape_file_id(path)
133
146
 
134
 
    def is_control_file(self, path):
135
 
        return path in (self.BZR_FILE_IDS_FILE, self.BZR_DUMMY_FILE)
136
 
 
137
147
    def parse_file_id(self, file_id):
138
148
        if file_id == ROOT_ID:
139
149
            return ""
140
150
        return unescape_file_id(file_id)
141
151
 
142
 
    def revid_as_refname(self, revid):
143
 
        import urllib
144
 
        return "refs/bzr/%s" % urllib.quote(revid)
145
 
 
146
152
    def import_unusual_file_modes(self, rev, unusual_file_modes):
147
153
        if unusual_file_modes:
148
154
            ret = [(path, unusual_file_modes[path])
151
157
 
152
158
    def export_unusual_file_modes(self, rev):
153
159
        try:
154
 
            file_modes = rev.properties['file-modes']
 
160
            return dict([(self.generate_file_id(path), mode) for (path, mode) in bencode.bdecode(rev.properties['file-modes'].encode("utf-8"))])
155
161
        except KeyError:
156
162
            return {}
157
 
        else:
158
 
            return dict([(self.generate_file_id(path), mode) for (path, mode) in bencode.bdecode(file_modes.encode("utf-8"))])
159
163
 
160
164
    def _generate_git_svn_metadata(self, rev, encoding):
161
165
        try:
162
 
            git_svn_id = rev.properties["git-svn-id"]
 
166
            return "\ngit-svn-id: %s\n" % rev.properties["git-svn-id"].encode(
 
167
                encoding)
163
168
        except KeyError:
164
169
            return ""
165
 
        else:
166
 
            return "\ngit-svn-id: %s\n" % git_svn_id.encode(encoding)
167
170
 
168
171
    def _generate_hg_message_tail(self, rev):
169
172
        extra = {}
185
188
 
186
189
    def _extract_git_svn_metadata(self, rev, message):
187
190
        lines = message.split("\n")
188
 
        if not (lines[-1] == "" and len(lines) >= 2 and lines[-2].startswith("git-svn-id:")):
 
191
        if not (lines[-1] == "" and lines[-2].startswith("git-svn-id:")):
189
192
            return message
190
193
        git_svn_id = lines[-2].split(": ", 1)[1]
191
194
        rev.properties['git-svn-id'] = git_svn_id
206
209
                [(new, old) for (old, new) in renames.iteritems()]))
207
210
        return message
208
211
 
209
 
    def _extract_bzr_metadata(self, rev, message):
210
 
        (message, metadata) = extract_bzr_metadata(message)
211
 
        return message, metadata
212
 
 
213
212
    def _decode_commit_message(self, rev, message, encoding):
214
 
        return message.decode(encoding), BzrGitRevisionMetadata()
 
213
        return message.decode(encoding)
215
214
 
216
215
    def _encode_commit_message(self, rev, message, encoding):
217
216
        return message.encode(encoding)
218
217
 
219
 
    def export_fileid_map(self, fileid_map):
220
 
        """Export a file id map to a fileid map.
221
 
 
222
 
        :param fileid_map: File id map, mapping paths to file ids
223
 
        :return: A Git blob object
224
 
        """
225
 
        from dulwich.objects import Blob
226
 
        b = Blob()
227
 
        b.set_raw_chunks(serialize_fileid_map(fileid_map))
228
 
        return b
229
 
 
230
 
    def export_commit(self, rev, tree_sha, parent_lookup, roundtrip,
231
 
                      verifiers):
 
218
    def export_commit(self, rev, tree_sha, parent_lookup):
232
219
        """Turn a Bazaar revision in to a Git commit
233
220
 
234
221
        :param tree_sha: Tree sha for the commit
235
222
        :param parent_lookup: Function for looking up the GIT sha equiv of a
236
223
            bzr revision
237
 
        :param roundtrip: Whether to store roundtripping information.
238
 
        :param verifiers: Verifiers info
239
224
        :return dulwich.objects.Commit represent the revision:
240
225
        """
241
226
        from dulwich.objects import Commit
242
227
        commit = Commit()
243
228
        commit.tree = tree_sha
244
 
        if roundtrip:
245
 
            metadata = BzrGitRevisionMetadata()
246
 
            metadata.verifiers = verifiers
247
 
        else:
248
 
            metadata = None
249
 
        parents = []
250
229
        for p in rev.parent_ids:
251
230
            try:
252
231
                git_p = parent_lookup(p)
253
232
            except KeyError:
254
233
                git_p = None
255
 
                if metadata is not None:
256
 
                    metadata.explicit_parent_ids = rev.parent_ids
257
234
            if git_p is not None:
258
235
                assert len(git_p) == 40, "unexpected length for %r" % git_p
259
 
                parents.append(git_p)
260
 
        commit.parents = parents
 
236
                commit.parents.append(git_p)
261
237
        try:
262
238
            encoding = rev.properties['git-explicit-encoding']
263
239
        except KeyError:
272
248
            commit.author_time = long(rev.properties['author-timestamp'])
273
249
        else:
274
250
            commit.author_time = commit.commit_time
275
 
        commit._commit_timezone_neg_utc = "commit-timezone-neg-utc" in rev.properties
276
251
        commit.commit_timezone = rev.timezone
277
 
        commit._author_timezone_neg_utc = "author-timezone-neg-utc" in rev.properties
278
252
        if 'author-timezone' in rev.properties:
279
253
            commit.author_timezone = int(rev.properties['author-timezone'])
280
254
        else:
281
255
            commit.author_timezone = commit.commit_timezone
282
256
        commit.message = self._encode_commit_message(rev, rev.message, 
283
257
            encoding)
284
 
        assert type(commit.message) == str
285
 
        if metadata is not None:
286
 
            try:
287
 
                mapping_registry.parse_revision_id(rev.revision_id)
288
 
            except errors.InvalidRevisionId:
289
 
                metadata.revision_id = rev.revision_id
290
 
            mapping_properties = set(
291
 
                ['author', 'author-timezone', 'author-timezone-neg-utc',
292
 
                 'commit-timezone-neg-utc', 'git-implicit-encoding',
293
 
                 'git-explicit-encoding', 'author-timestamp', 'file-modes'])
294
 
            for k, v in rev.properties.iteritems():
295
 
                if not k in mapping_properties:
296
 
                    metadata.properties[k] = v
297
 
        if self.roundtripping:
298
 
            commit.message = inject_bzr_metadata(commit.message, metadata, 
299
 
                                                 encoding)
300
 
        assert type(commit.message) == str
301
258
        return commit
302
259
 
303
 
    def import_fileid_map(self, blob):
304
 
        """Convert a git file id map blob.
305
 
 
306
 
        :param blob: Git blob object with fileid map
307
 
        :return: Dictionary mapping paths to file ids
308
 
        """
309
 
        return deserialize_fileid_map(blob.data)
310
 
 
311
 
    def import_commit(self, commit, lookup_parent_revid):
 
260
    def import_commit(self, commit):
312
261
        """Convert a git commit to a bzr revision.
313
262
 
314
 
        :return: a `bzrlib.revision.Revision` object, foreign revid and a
315
 
            testament sha1
 
263
        :return: a `bzrlib.revision.Revision` object.
316
264
        """
317
265
        if commit is None:
318
266
            raise AssertionError("Commit object can't be None")
319
267
        rev = ForeignRevision(commit.id, self,
320
268
                self.revision_id_foreign_to_bzr(commit.id))
321
 
        rev.parent_ids = tuple([lookup_parent_revid(p) for p in commit.parents])
322
 
        rev.git_metadata = None
 
269
        rev.parent_ids = tuple([self.revision_id_foreign_to_bzr(p) for p in commit.parents])
323
270
        def decode_using_encoding(rev, commit, encoding):
324
271
            rev.committer = str(commit.committer).decode(encoding)
325
272
            if commit.committer != commit.author:
326
273
                rev.properties['author'] = str(commit.author).decode(encoding)
327
 
            rev.message, rev.git_metadata = self._decode_commit_message(
328
 
                rev, commit.message, encoding)
 
274
            rev.message = self._decode_commit_message(rev, commit.message, 
 
275
                encoding)
329
276
        if commit.encoding is not None:
330
277
            rev.properties['git-explicit-encoding'] = commit.encoding
331
278
            decode_using_encoding(rev, commit, commit.encoding)
343
290
            rev.properties['author-timestamp'] = str(commit.author_time)
344
291
        if commit.commit_timezone != commit.author_timezone:
345
292
            rev.properties['author-timezone'] = "%d" % commit.author_timezone
346
 
        if commit._author_timezone_neg_utc:
347
 
            rev.properties['author-timezone-neg-utc'] = ""
348
 
        if commit._commit_timezone_neg_utc:
349
 
            rev.properties['commit-timezone-neg-utc'] = ""
350
293
        rev.timestamp = commit.commit_time
351
294
        rev.timezone = commit.commit_timezone
352
 
        if rev.git_metadata is not None:
353
 
            md = rev.git_metadata
354
 
            roundtrip_revid = md.revision_id
355
 
            if md.explicit_parent_ids:
356
 
                rev.parent_ids = md.explicit_parent_ids
357
 
            rev.properties.update(md.properties)
358
 
            verifiers = md.verifiers
359
 
        else:
360
 
            roundtrip_revid = None
361
 
            verifiers = {}
362
 
        return rev, roundtrip_revid, verifiers
363
 
 
364
 
    def get_fileid_map(self, lookup_object, tree_sha):
365
 
        """Obtain a fileid map for a particular tree.
366
 
 
367
 
        :param lookup_object: Function for looking up an object
368
 
        :param tree_sha: SHA of the root tree
369
 
        :return: GitFileIdMap instance
370
 
        """
371
 
        try:
372
 
            file_id_map_sha = lookup_object(tree_sha)[self.BZR_FILE_IDS_FILE][1]
373
 
        except KeyError:
374
 
            file_ids = {}
375
 
        else:
376
 
            file_ids = self.import_fileid_map(lookup_object(file_id_map_sha))
377
 
        return GitFileIdMap(file_ids, self)
 
295
        return rev
378
296
 
379
297
 
380
298
class BzrGitMappingv1(BzrGitMapping):
388
306
class BzrGitMappingExperimental(BzrGitMappingv1):
389
307
    revid_prefix = 'git-experimental'
390
308
    experimental = True
391
 
    roundtripping = True
392
 
 
393
 
    BZR_FILE_IDS_FILE = '.bzrfileids'
394
 
 
395
 
    BZR_DUMMY_FILE = '.bzrdummy'
396
309
 
397
310
    def _decode_commit_message(self, rev, message, encoding):
398
311
        message = self._extract_hg_metadata(rev, message)
399
312
        message = self._extract_git_svn_metadata(rev, message)
400
 
        message, metadata = self._extract_bzr_metadata(rev, message)
401
 
        return message.decode(encoding), metadata
 
313
        return message.decode(encoding)
402
314
 
403
315
    def _encode_commit_message(self, rev, message, encoding):
404
316
        ret = message.encode(encoding)
406
318
        ret += self._generate_git_svn_metadata(rev, encoding)
407
319
        return ret
408
320
 
409
 
    def import_commit(self, commit, lookup_parent_revid):
410
 
        rev, roundtrip_revid, verifiers = super(BzrGitMappingExperimental, self).import_commit(commit, lookup_parent_revid)
 
321
    def import_commit(self, commit):
 
322
        rev = super(BzrGitMappingExperimental, self).import_commit(commit)
411
323
        rev.properties['converted_revision'] = "git %s\n" % commit.id
412
 
        return rev, roundtrip_revid, verifiers
 
324
        return rev
413
325
 
414
326
 
415
327
class GitMappingRegistry(VcsMappingRegistry):
417
329
 
418
330
    def revision_id_bzr_to_foreign(self, bzr_revid):
419
331
        if bzr_revid == NULL_REVISION:
420
 
            from dulwich.protocol import ZERO_SHA
421
 
            return ZERO_SHA, None
 
332
            return "0" * 20, None
422
333
        if not bzr_revid.startswith("git-"):
423
334
            raise errors.InvalidRevisionId(bzr_revid, None)
424
335
        (mapping_version, git_sha) = bzr_revid.split(":", 1)
527
438
    return object_mode(entry.kind, entry.executable)
528
439
 
529
440
 
530
 
def directory_to_tree(entry, lookup_ie_sha1, unusual_modes, empty_file_name):
531
 
    """Create a Git Tree object from a Bazaar directory.
532
 
 
533
 
    :param entry: Inventory entry
534
 
    :param lookup_ie_sha1: Lookup the Git SHA1 for a inventory entry
535
 
    :param unusual_modes: Dictionary with unusual file modes by file ids
536
 
    :param empty_file_name: Name to use for dummy files in empty directories,
537
 
        None to ignore empty directories.
538
 
    """
539
 
    from dulwich.objects import Blob, Tree
 
441
def directory_to_tree(entry, lookup_ie_sha1, unusual_modes):
 
442
    from dulwich.objects import Tree
540
443
    tree = Tree()
541
444
    for name, value in entry.children.iteritems():
542
445
        ie = entry.children[name]
549
452
            tree.add(mode, name.encode("utf-8"), hexsha)
550
453
    if entry.parent_id is not None and len(tree) == 0:
551
454
        # Only the root can be an empty tree
552
 
        if empty_file_name is not None:
553
 
            tree.add(stat.S_IFREG | 0644, empty_file_name, 
554
 
                Blob().id)
555
 
        else:
556
 
            return None
 
455
        return None
557
456
    return tree
558
457
 
559
458
 
571
470
    (head, uuid) = text.rsplit(" ", 1)
572
471
    (full_url, rev) = head.rsplit("@", 1)
573
472
    return (full_url, int(rev), uuid)
574
 
 
575
 
 
576
 
class GitFileIdMap(object):
577
 
 
578
 
    def __init__(self, file_ids, mapping):
579
 
        self.file_ids = file_ids
580
 
        self.paths = None
581
 
        self.mapping = mapping
582
 
 
583
 
    def lookup_file_id(self, path):
584
 
        assert type(path) is str
585
 
        try:
586
 
            file_id = self.file_ids[path]
587
 
        except KeyError:
588
 
            file_id = self.mapping.generate_file_id(path)
589
 
        assert type(file_id) is str
590
 
        return file_id
591
 
 
592
 
    def lookup_path(self, file_id):
593
 
        if self.paths is None:
594
 
            self.paths = {}
595
 
            for k, v in self.file_ids.iteritems():
596
 
                self.paths[v] = k
597
 
        try:
598
 
            path = self.paths[file_id]
599
 
        except KeyError:
600
 
            return self.mapping.parse_file_id(file_id)
601
 
        else:
602
 
            assert type(path) is str
603
 
            return path