← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/testament.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-13 14:33:10 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813143310-twhj4la0qnupvze8
Added Quick Start Summary

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/testament.py
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
from sha import sha
73
74
 
74
 
from bzrlib.osutils import (
75
 
    contains_whitespace,
76
 
    contains_linebreaks,
77
 
    sha,
78
 
    )
 
75
from bzrlib.osutils import contains_whitespace, contains_linebreaks
79
76
 
80
77
 
81
78
class Testament(object):
82
79
    """Reduced summary of a revision.
83
80
 
84
 
    Testaments can be
 
81
    Testaments can be 
85
82
 
86
83
      - produced from a revision
87
84
      - written to a stream
109
106
        self.parent_ids = rev.parent_ids[:]
110
107
        self.inventory = inventory
111
108
        self.revprops = copy(rev.properties)
112
 
        if contains_whitespace(self.revision_id):
113
 
            raise ValueError(self.revision_id)
114
 
        if contains_linebreaks(self.committer):
115
 
            raise ValueError(self.committer)
 
109
        assert not contains_whitespace(self.revision_id)
 
110
        assert not contains_linebreaks(self.committer)
116
111
 
117
112
    def as_text_lines(self):
118
113
        """Yield text form as a sequence of lines.
130
125
        # inventory length contains the root, which is not shown here
131
126
        a('parents:\n')
132
127
        for parent_id in sorted(self.parent_ids):
133
 
            if contains_whitespace(parent_id):
134
 
                raise ValueError(parent_id)
 
128
            assert not contains_whitespace(parent_id)
135
129
            a('  %s\n' % parent_id)
136
130
        a('message:\n')
137
131
        for l in self.message.splitlines():
140
134
        for path, ie in self._get_entries():
141
135
            a(self._entry_to_line(path, ie))
142
136
        r.extend(self._revprops_to_lines())
 
137
        if __debug__:
 
138
            for l in r:
 
139
                assert isinstance(l, basestring), \
 
140
                    '%r of type %s is not a plain string' % (l, type(l))
143
141
        return [line.encode('utf-8') for line in r]
144
142
 
145
143
    def _get_entries(self):
148
146
        return entries
149
147
 
150
148
    def _escape_path(self, path):
151
 
        if contains_linebreaks(path):
152
 
            raise ValueError(path)
 
149
        assert not contains_linebreaks(path)
153
150
        return unicode(path.replace('\\', '/').replace(' ', '\ '))
154
151
 
155
152
    def _entry_to_line(self, path, ie):
156
153
        """Turn an inventory entry into a testament line"""
157
 
        if contains_whitespace(ie.file_id):
158
 
            raise ValueError(ie.file_id)
 
154
        assert not contains_whitespace(ie.file_id)
 
155
 
159
156
        content = ''
160
157
        content_spacer=''
161
158
        if ie.kind == 'file':
162
159
            # TODO: avoid switching on kind
163
 
            if not ie.text_sha1:
164
 
                raise AssertionError()
 
160
            assert ie.text_sha1
165
161
            content = ie.text_sha1
166
162
            content_spacer = ' '
167
163
        elif ie.kind == 'symlink':
168
 
            if not ie.symlink_target:
169
 
                raise AssertionError()
 
164
            assert ie.symlink_target
170
165
            content = self._escape_path(ie.symlink_target)
171
166
            content_spacer = ' '
172
167
 
180
175
 
181
176
    def as_short_text(self):
182
177
        """Return short digest-based testament."""
183
 
        return (self.short_header +
 
178
        return (self.short_header + 
184
179
                'revision-id: %s\n'
185
180
                'sha1: %s\n'
186
181
                % (self.revision_id, self.as_sha1()))
191
186
            return []
192
187
        r = ['properties:\n']
193
188
        for name, value in sorted(self.revprops.items()):
194
 
            if contains_whitespace(name):
195
 
                raise ValueError(name)
 
189
            assert isinstance(name, str)
 
190
            assert not contains_whitespace(name)
196
191
            r.append('  %s:\n' % name)
197
192
            for line in value.splitlines():
198
193
                r.append(u'    %s\n' % line)
218
213
 
219
214
class StrictTestament3(StrictTestament):
220
215
    """This testament format is for use as a checksum in bundle format 0.9+
221
 
 
 
216
    
222
217
    It differs from StrictTestament by including data about the tree root.
223
218
    """
224
219
 
228
223
        return self.inventory.iter_entries()
229
224
 
230
225
    def _escape_path(self, path):
231
 
        if contains_linebreaks(path):
232
 
            raise ValueError(path)
 
226
        assert not contains_linebreaks(path)
233
227
        if path == '':
234
228
            path = '.'
235
229
        return unicode(path.replace('\\', '/').replace(' ', '\ '))