← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/testament.py

  • Committer: Robert Collins
  • Date: 2005-10-22 13:27:47 UTC
  • Revision ID: robertc@robertcollins.net-20051022132747-706eed356bb1a11e
convert versioning tests to use self.run_bzr, making the test suite quieter

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/testament.py
1
 
# Copyright (C) 2005 Canonical Ltd
 
1
# Copyright (C) 2005 by Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Testament - a summary of a revision for signing.
18
18
 
19
 
A testament can be defined as "something that serves as tangible
 
19
A testament can be defined as "something that serves as tangible 
20
20
proof or evidence."  In bzr we use them to allow people to certify
21
 
particular revisions as authentic.
 
21
particular revisions as authentic.  
22
22
 
23
23
The goal is that if two revisions are semantically equal, then they will
24
24
have a byte-for-byte equal testament.  We can define different versions of
61
61
 
62
62
# XXX: At the moment, clients trust that the graph described in a weave
63
63
# is accurate, but that's not covered by the testament.  Perhaps the best
64
 
# fix is when verifying a revision to make sure that every file mentioned
 
64
# fix is when verifying a revision to make sure that every file mentioned 
65
65
# in the revision has compatible ancestry links.
66
66
 
67
67
# TODO: perhaps write timestamp in a more readable form
70
70
# revisions can be serialized.
71
71
 
72
72
from copy import copy
73
 
 
74
 
from bzrlib.osutils import (
75
 
    contains_whitespace,
76
 
    contains_linebreaks,
77
 
    sha_strings,
78
 
    )
79
 
from bzrlib.tree import Tree
80
 
 
 
73
from cStringIO import StringIO
 
74
import string
 
75
from sha import sha
 
76
 
 
77
from bzrlib.osutils import contains_whitespace, contains_linebreaks
81
78
 
82
79
class Testament(object):
83
80
    """Reduced summary of a revision.
84
81
 
85
 
    Testaments can be
 
82
    Testaments can be 
86
83
 
87
84
      - produced from a revision
88
 
      - written to a stream
 
85
      - writen to a stream
89
86
      - loaded from a stream
90
87
      - compared to a revision
91
88
    """
92
89
 
93
 
    long_header = 'bazaar-ng testament version 1\n'
94
 
    short_header = 'bazaar-ng testament short form 1\n'
95
 
    include_root = False
96
 
 
97
 
    @classmethod
98
 
    def from_revision(cls, repository, revision_id):
99
 
        """Produce a new testament from a historical revision."""
100
 
        rev = repository.get_revision(revision_id)
101
 
        tree = repository.revision_tree(revision_id)
102
 
        return cls(rev, tree)
103
 
 
104
 
    @classmethod
105
 
    def from_revision_tree(cls, tree):
106
 
        """Produce a new testament from a revision tree."""
107
 
        rev = tree._repository.get_revision(tree.get_revision_id())
108
 
        return cls(rev, tree)
109
 
 
110
 
    def __init__(self, rev, tree):
111
 
        """Create a new testament for rev using tree."""
112
 
        self.revision_id = rev.revision_id
 
90
    @classmethod
 
91
    def from_revision(cls, branch, revision_id):
 
92
        """Produce a new testament from a historical revision"""
 
93
        rev = branch.get_revision(revision_id)
 
94
        inventory = branch.get_inventory(revision_id)
 
95
        return cls(rev, inventory)
 
96
 
 
97
    def __init__(self, rev, inventory):
 
98
        """Create a new testament for rev using inventory."""
 
99
        self.revision_id = str(rev.revision_id)
113
100
        self.committer = rev.committer
114
101
        self.timezone = rev.timezone or 0
115
102
        self.timestamp = rev.timestamp
116
103
        self.message = rev.message
117
104
        self.parent_ids = rev.parent_ids[:]
118
 
        if not isinstance(tree, Tree):
119
 
            raise TypeError("As of bzr 2.4 Testament.__init__() takes a "
120
 
                "Revision and a Tree.")
121
 
        self.tree = tree
 
105
        self.inventory = inventory
122
106
        self.revprops = copy(rev.properties)
123
 
        if contains_whitespace(self.revision_id):
124
 
            raise ValueError(self.revision_id)
125
 
        if contains_linebreaks(self.committer):
126
 
            raise ValueError(self.committer)
 
107
        assert not contains_whitespace(self.revision_id)
 
108
        assert not contains_linebreaks(self.committer)
127
109
 
128
110
    def as_text_lines(self):
129
111
        """Yield text form as a sequence of lines.
132
114
        hashed in that encoding.
133
115
        """
134
116
        r = []
135
 
        a = r.append
136
 
        a(self.long_header)
 
117
        def a(s):
 
118
            r.append(s)
 
119
        a('bazaar-ng testament version 1\n')
137
120
        a('revision-id: %s\n' % self.revision_id)
138
121
        a('committer: %s\n' % self.committer)
139
122
        a('timestamp: %d\n' % self.timestamp)
141
124
        # inventory length contains the root, which is not shown here
142
125
        a('parents:\n')
143
126
        for parent_id in sorted(self.parent_ids):
144
 
            if contains_whitespace(parent_id):
145
 
                raise ValueError(parent_id)
 
127
            assert not contains_whitespace(parent_id)
146
128
            a('  %s\n' % parent_id)
147
129
        a('message:\n')
148
130
        for l in self.message.splitlines():
149
131
            a('  %s\n' % l)
150
132
        a('inventory:\n')
151
 
        for path, ie in self._get_entries():
 
133
        for path, ie in self.inventory.iter_entries():
152
134
            a(self._entry_to_line(path, ie))
153
135
        r.extend(self._revprops_to_lines())
154
 
        return [line.encode('utf-8') for line in r]
155
 
 
156
 
    def _get_entries(self):
157
 
        return ((path, ie) for (path, versioned, kind, file_id, ie) in
158
 
                self.tree.list_files(include_root=self.include_root))
 
136
        if __debug__:
 
137
            for l in r:
 
138
                assert isinstance(l, basestring), \
 
139
                    '%r of type %s is not a plain string' % (l, type(l))
 
140
        return r
159
141
 
160
142
    def _escape_path(self, path):
161
 
        if contains_linebreaks(path):
162
 
            raise ValueError(path)
163
 
        return unicode(path.replace('\\', '/').replace(' ', '\ '))
 
143
        assert not contains_linebreaks(path)
 
144
        return unicode(path.replace('\\', '/').replace(' ', '\ ')).encode('utf-8')
164
145
 
165
146
    def _entry_to_line(self, path, ie):
166
147
        """Turn an inventory entry into a testament line"""
167
 
        if contains_whitespace(ie.file_id):
168
 
            raise ValueError(ie.file_id)
169
 
        content = ''
170
 
        content_spacer=''
 
148
        l = '  ' + str(ie.kind)
 
149
        l += ' ' + self._escape_path(path)
 
150
        assert not contains_whitespace(ie.file_id)
 
151
        l += ' ' + unicode(ie.file_id).encode('utf-8')
171
152
        if ie.kind == 'file':
172
153
            # TODO: avoid switching on kind
173
 
            if not ie.text_sha1:
174
 
                raise AssertionError()
175
 
            content = ie.text_sha1
176
 
            content_spacer = ' '
 
154
            assert ie.text_sha1
 
155
            l += ' ' + ie.text_sha1
177
156
        elif ie.kind == 'symlink':
178
 
            if not ie.symlink_target:
179
 
                raise AssertionError()
180
 
            content = self._escape_path(ie.symlink_target)
181
 
            content_spacer = ' '
182
 
 
183
 
        l = u'  %s %s %s%s%s\n' % (ie.kind, self._escape_path(path),
184
 
                                   ie.file_id.decode('utf8'),
185
 
                                   content_spacer, content)
 
157
            assert ie.symlink_target
 
158
            l += ' ' + self._escape_path(ie.symlink_target)
 
159
        l += '\n'
186
160
        return l
187
161
 
188
162
    def as_text(self):
190
164
 
191
165
    def as_short_text(self):
192
166
        """Return short digest-based testament."""
193
 
        return (self.short_header +
 
167
        s = sha()
 
168
        map(s.update, self.as_text_lines())
 
169
        return ('bazaar-ng testament short form 1\n'
194
170
                'revision-id: %s\n'
195
171
                'sha1: %s\n'
196
 
                % (self.revision_id, self.as_sha1()))
 
172
                % (self.revision_id, s.hexdigest()))
197
173
 
198
174
    def _revprops_to_lines(self):
199
175
        """Pack up revision properties."""
201
177
            return []
202
178
        r = ['properties:\n']
203
179
        for name, value in sorted(self.revprops.items()):
204
 
            if contains_whitespace(name):
205
 
                raise ValueError(name)
 
180
            assert isinstance(name, str)
 
181
            assert not contains_whitespace(name)
206
182
            r.append('  %s:\n' % name)
207
183
            for line in value.splitlines():
208
 
                r.append(u'    %s\n' % line)
 
184
                if not isinstance(line, str):
 
185
                    line = line.encode('utf-8')
 
186
                r.append('    %s\n' % line)
209
187
        return r
210
 
 
211
 
    def as_sha1(self):
212
 
        return sha_strings(self.as_text_lines())
213
 
 
214
 
 
215
 
class StrictTestament(Testament):
216
 
    """This testament format is for use as a checksum in bundle format 0.8"""
217
 
 
218
 
    long_header = 'bazaar-ng testament version 2.1\n'
219
 
    short_header = 'bazaar-ng testament short form 2.1\n'
220
 
    include_root = False
221
 
    def _entry_to_line(self, path, ie):
222
 
        l = Testament._entry_to_line(self, path, ie)[:-1]
223
 
        l += ' ' + ie.revision
224
 
        l += {True: ' yes\n', False: ' no\n'}[ie.executable]
225
 
        return l
226
 
 
227
 
 
228
 
class StrictTestament3(StrictTestament):
229
 
    """This testament format is for use as a checksum in bundle format 0.9+
230
 
 
231
 
    It differs from StrictTestament by including data about the tree root.
232
 
    """
233
 
 
234
 
    long_header = 'bazaar testament version 3 strict\n'
235
 
    short_header = 'bazaar testament short form 3 strict\n'
236
 
    include_root = True
237
 
 
238
 
    def _escape_path(self, path):
239
 
        if contains_linebreaks(path):
240
 
            raise ValueError(path)
241
 
        if path == '':
242
 
            path = '.'
243
 
        return unicode(path.replace('\\', '/').replace(' ', '\ '))