← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/testament.py

  • Committer: Jelmer Vernooij
  • Date: 2010-01-20 23:26:31 UTC
  • mto: This revision was merged to the branch mainline in revision 4977.
  • Revision ID: jelmer@samba.org-20100120232631-b9mz0z55712eaxfa
https://launchpad.net/bugs/295611
Cope with ghosts in 'bzr diff'

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