← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/testament.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-05-04 12:10:51 UTC
  • mfrom: (5819.1.4 777007-developer-doc)
  • Revision ID: pqm@pqm.ubuntu.com-20110504121051-aovlsmqiivjmc4fc
(jelmer) Small fixes to developer documentation. (Jonathan Riddell)

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
    )
 
79
from bzrlib.tree import Tree
76
80
 
77
81
 
78
82
class Testament(object):
79
83
    """Reduced summary of a revision.
80
84
 
81
 
    Testaments can be 
 
85
    Testaments can be
82
86
 
83
87
      - produced from a revision
84
88
      - written to a stream
88
92
 
89
93
    long_header = 'bazaar-ng testament version 1\n'
90
94
    short_header = 'bazaar-ng testament short form 1\n'
 
95
    include_root = False
91
96
 
92
97
    @classmethod
93
98
    def from_revision(cls, repository, revision_id):
94
 
        """Produce a new testament from a historical revision"""
 
99
        """Produce a new testament from a historical revision."""
95
100
        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)
 
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
102
113
        self.committer = rev.committer
103
114
        self.timezone = rev.timezone or 0
104
115
        self.timestamp = rev.timestamp
105
116
        self.message = rev.message
106
117
        self.parent_ids = rev.parent_ids[:]
107
 
        self.inventory = inventory
 
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
108
122
        self.revprops = copy(rev.properties)
109
 
        assert not contains_whitespace(self.revision_id)
110
 
        assert not contains_linebreaks(self.committer)
 
123
        if contains_whitespace(self.revision_id):
 
124
            raise ValueError(self.revision_id)
 
125
        if contains_linebreaks(self.committer):
 
126
            raise ValueError(self.committer)
111
127
 
112
128
    def as_text_lines(self):
113
129
        """Yield text form as a sequence of lines.
125
141
        # inventory length contains the root, which is not shown here
126
142
        a('parents:\n')
127
143
        for parent_id in sorted(self.parent_ids):
128
 
            assert not contains_whitespace(parent_id)
 
144
            if contains_whitespace(parent_id):
 
145
                raise ValueError(parent_id)
129
146
            a('  %s\n' % parent_id)
130
147
        a('message:\n')
131
148
        for l in self.message.splitlines():
134
151
        for path, ie in self._get_entries():
135
152
            a(self._entry_to_line(path, ie))
136
153
        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
154
        return [line.encode('utf-8') for line in r]
142
155
 
143
156
    def _get_entries(self):
144
 
        entries = self.inventory.iter_entries()
145
 
        entries.next()
146
 
        return entries
 
157
        return ((path, ie) for (path, versioned, kind, file_id, ie) in
 
158
                self.tree.list_files(include_root=self.include_root))
147
159
 
148
160
    def _escape_path(self, path):
149
 
        assert not contains_linebreaks(path)
 
161
        if contains_linebreaks(path):
 
162
            raise ValueError(path)
150
163
        return unicode(path.replace('\\', '/').replace(' ', '\ '))
151
164
 
152
165
    def _entry_to_line(self, path, ie):
153
166
        """Turn an inventory entry into a testament line"""
154
 
        assert not contains_whitespace(ie.file_id)
155
 
 
 
167
        if contains_whitespace(ie.file_id):
 
168
            raise ValueError(ie.file_id)
156
169
        content = ''
157
170
        content_spacer=''
158
171
        if ie.kind == 'file':
159
172
            # TODO: avoid switching on kind
160
 
            assert ie.text_sha1
 
173
            if not ie.text_sha1:
 
174
                raise AssertionError()
161
175
            content = ie.text_sha1
162
176
            content_spacer = ' '
163
177
        elif ie.kind == 'symlink':
164
 
            assert ie.symlink_target
 
178
            if not ie.symlink_target:
 
179
                raise AssertionError()
165
180
            content = self._escape_path(ie.symlink_target)
166
181
            content_spacer = ' '
167
182
 
168
183
        l = u'  %s %s %s%s%s\n' % (ie.kind, self._escape_path(path),
169
 
                                   unicode(ie.file_id),
 
184
                                   ie.file_id.decode('utf8'),
170
185
                                   content_spacer, content)
171
186
        return l
172
187
 
175
190
 
176
191
    def as_short_text(self):
177
192
        """Return short digest-based testament."""
178
 
        return (self.short_header + 
 
193
        return (self.short_header +
179
194
                'revision-id: %s\n'
180
195
                'sha1: %s\n'
181
196
                % (self.revision_id, self.as_sha1()))
186
201
            return []
187
202
        r = ['properties:\n']
188
203
        for name, value in sorted(self.revprops.items()):
189
 
            assert isinstance(name, str)
190
 
            assert not contains_whitespace(name)
 
204
            if contains_whitespace(name):
 
205
                raise ValueError(name)
191
206
            r.append('  %s:\n' % name)
192
207
            for line in value.splitlines():
193
208
                r.append(u'    %s\n' % line)
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(' ', '\ '))