← 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: 2015-11-15 02:30:05 UTC
  • mto: This revision was merged to the branch mainline in revision 6609.
  • Revision ID: jelmer@jelmer.uk-20151115023005-fcfi763b5eu1ne2o
Fix auodoc_rstx when running with LANG=C.

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
59
59
* the testament uses unix line-endings (\n)
60
60
"""
61
61
 
 
62
from __future__ import absolute_import
 
63
 
62
64
# XXX: At the moment, clients trust that the graph described in a weave
63
65
# 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 
 
66
# fix is when verifying a revision to make sure that every file mentioned
65
67
# in the revision has compatible ancestry links.
66
68
 
67
69
# TODO: perhaps write timestamp in a more readable form
70
72
# revisions can be serialized.
71
73
 
72
74
from copy import copy
73
 
from sha import sha
74
75
 
75
 
from bzrlib.osutils import contains_whitespace, contains_linebreaks
 
76
from bzrlib.osutils import (
 
77
    contains_whitespace,
 
78
    contains_linebreaks,
 
79
    sha_strings,
 
80
    )
 
81
from bzrlib.tree import Tree
76
82
 
77
83
 
78
84
class Testament(object):
79
85
    """Reduced summary of a revision.
80
86
 
81
 
    Testaments can be 
 
87
    Testaments can be
82
88
 
83
89
      - produced from a revision
84
90
      - written to a stream
88
94
 
89
95
    long_header = 'bazaar-ng testament version 1\n'
90
96
    short_header = 'bazaar-ng testament short form 1\n'
 
97
    include_root = False
91
98
 
92
99
    @classmethod
93
100
    def from_revision(cls, repository, revision_id):
94
 
        """Produce a new testament from a historical revision"""
 
101
        """Produce a new testament from a historical revision."""
95
102
        rev = repository.get_revision(revision_id)
96
 
        inventory = repository.get_inventory(revision_id)
97
 
        return cls(rev, inventory)
98
 
 
99
 
    def __init__(self, rev, inventory):
100
 
        """Create a new testament for rev using inventory."""
101
 
        self.revision_id = str(rev.revision_id)
 
103
        tree = repository.revision_tree(revision_id)
 
104
        return cls(rev, tree)
 
105
 
 
106
    @classmethod
 
107
    def from_revision_tree(cls, tree):
 
108
        """Produce a new testament from a revision tree."""
 
109
        rev = tree._repository.get_revision(tree.get_revision_id())
 
110
        return cls(rev, tree)
 
111
 
 
112
    def __init__(self, rev, tree):
 
113
        """Create a new testament for rev using tree."""
 
114
        self.revision_id = rev.revision_id
102
115
        self.committer = rev.committer
103
116
        self.timezone = rev.timezone or 0
104
117
        self.timestamp = rev.timestamp
105
118
        self.message = rev.message
106
119
        self.parent_ids = rev.parent_ids[:]
107
 
        self.inventory = inventory
 
120
        if not isinstance(tree, Tree):
 
121
            raise TypeError("As of bzr 2.4 Testament.__init__() takes a "
 
122
                "Revision and a Tree.")
 
123
        self.tree = tree
108
124
        self.revprops = copy(rev.properties)
109
 
        assert not contains_whitespace(self.revision_id)
110
 
        assert not contains_linebreaks(self.committer)
 
125
        if contains_whitespace(self.revision_id):
 
126
            raise ValueError(self.revision_id)
 
127
        if contains_linebreaks(self.committer):
 
128
            raise ValueError(self.committer)
111
129
 
112
130
    def as_text_lines(self):
113
131
        """Yield text form as a sequence of lines.
125
143
        # inventory length contains the root, which is not shown here
126
144
        a('parents:\n')
127
145
        for parent_id in sorted(self.parent_ids):
128
 
            assert not contains_whitespace(parent_id)
 
146
            if contains_whitespace(parent_id):
 
147
                raise ValueError(parent_id)
129
148
            a('  %s\n' % parent_id)
130
149
        a('message:\n')
131
150
        for l in self.message.splitlines():
134
153
        for path, ie in self._get_entries():
135
154
            a(self._entry_to_line(path, ie))
136
155
        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
156
        return [line.encode('utf-8') for line in r]
142
157
 
143
158
    def _get_entries(self):
144
 
        entries = self.inventory.iter_entries()
145
 
        entries.next()
146
 
        return entries
 
159
        return ((path, ie) for (path, versioned, kind, file_id, ie) in
 
160
                self.tree.list_files(include_root=self.include_root))
147
161
 
148
162
    def _escape_path(self, path):
149
 
        assert not contains_linebreaks(path)
 
163
        if contains_linebreaks(path):
 
164
            raise ValueError(path)
150
165
        return unicode(path.replace('\\', '/').replace(' ', '\ '))
151
166
 
152
167
    def _entry_to_line(self, path, ie):
153
168
        """Turn an inventory entry into a testament line"""
154
 
        assert not contains_whitespace(ie.file_id)
155
 
 
 
169
        if contains_whitespace(ie.file_id):
 
170
            raise ValueError(ie.file_id)
156
171
        content = ''
157
172
        content_spacer=''
158
173
        if ie.kind == 'file':
159
174
            # TODO: avoid switching on kind
160
 
            assert ie.text_sha1
 
175
            if not ie.text_sha1:
 
176
                raise AssertionError()
161
177
            content = ie.text_sha1
162
178
            content_spacer = ' '
163
179
        elif ie.kind == 'symlink':
164
 
            assert ie.symlink_target
 
180
            if not ie.symlink_target:
 
181
                raise AssertionError()
165
182
            content = self._escape_path(ie.symlink_target)
166
183
            content_spacer = ' '
167
184
 
168
185
        l = u'  %s %s %s%s%s\n' % (ie.kind, self._escape_path(path),
169
 
                                   unicode(ie.file_id),
 
186
                                   ie.file_id.decode('utf8'),
170
187
                                   content_spacer, content)
171
188
        return l
172
189
 
175
192
 
176
193
    def as_short_text(self):
177
194
        """Return short digest-based testament."""
178
 
        return (self.short_header + 
 
195
        return (self.short_header +
179
196
                'revision-id: %s\n'
180
197
                'sha1: %s\n'
181
198
                % (self.revision_id, self.as_sha1()))
186
203
            return []
187
204
        r = ['properties:\n']
188
205
        for name, value in sorted(self.revprops.items()):
189
 
            assert isinstance(name, str)
190
 
            assert not contains_whitespace(name)
 
206
            if contains_whitespace(name):
 
207
                raise ValueError(name)
191
208
            r.append('  %s:\n' % name)
192
209
            for line in value.splitlines():
193
210
                r.append(u'    %s\n' % line)
194
211
        return r
195
212
 
196
213
    def as_sha1(self):
197
 
        s = sha()
198
 
        map(s.update, self.as_text_lines())
199
 
        return s.hexdigest()
 
214
        return sha_strings(self.as_text_lines())
200
215
 
201
216
 
202
217
class StrictTestament(Testament):
204
219
 
205
220
    long_header = 'bazaar-ng testament version 2.1\n'
206
221
    short_header = 'bazaar-ng testament short form 2.1\n'
 
222
    include_root = False
207
223
    def _entry_to_line(self, path, ie):
208
224
        l = Testament._entry_to_line(self, path, ie)[:-1]
209
225
        l += ' ' + ie.revision
213
229
 
214
230
class StrictTestament3(StrictTestament):
215
231
    """This testament format is for use as a checksum in bundle format 0.9+
216
 
    
 
232
 
217
233
    It differs from StrictTestament by including data about the tree root.
218
234
    """
219
235
 
220
236
    long_header = 'bazaar testament version 3 strict\n'
221
237
    short_header = 'bazaar testament short form 3 strict\n'
222
 
    def _get_entries(self):
223
 
        return self.inventory.iter_entries()
 
238
    include_root = True
224
239
 
225
240
    def _escape_path(self, path):
226
 
        assert not contains_linebreaks(path)
 
241
        if contains_linebreaks(path):
 
242
            raise ValueError(path)
227
243
        if path == '':
228
244
            path = '.'
229
245
        return unicode(path.replace('\\', '/').replace(' ', '\ '))