← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/testament.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 05:06:57 UTC
  • mfrom: (6603.4.1 bzr)
  • Revision ID: pqm@pqm.ubuntu.com-20160421050657-ygnzfybewvudf1j9
(richard-wilbur) Use initial_comment as commit_message for lp_propose.(Shawn
 Wang) (Shawn Wang)

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."""
 
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."""
101
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
125
        if contains_whitespace(self.revision_id):
110
126
            raise ValueError(self.revision_id)
140
156
        return [line.encode('utf-8') for line in r]
141
157
 
142
158
    def _get_entries(self):
143
 
        entries = self.inventory.iter_entries()
144
 
        entries.next()
145
 
        return entries
 
159
        return ((path, ie) for (path, versioned, kind, file_id, ie) in
 
160
                self.tree.list_files(include_root=self.include_root))
146
161
 
147
162
    def _escape_path(self, path):
148
163
        if contains_linebreaks(path):
177
192
 
178
193
    def as_short_text(self):
179
194
        """Return short digest-based testament."""
180
 
        return (self.short_header + 
 
195
        return (self.short_header +
181
196
                'revision-id: %s\n'
182
197
                'sha1: %s\n'
183
198
                % (self.revision_id, self.as_sha1()))
196
211
        return r
197
212
 
198
213
    def as_sha1(self):
199
 
        s = sha()
200
 
        map(s.update, self.as_text_lines())
201
 
        return s.hexdigest()
 
214
        return sha_strings(self.as_text_lines())
202
215
 
203
216
 
204
217
class StrictTestament(Testament):
206
219
 
207
220
    long_header = 'bazaar-ng testament version 2.1\n'
208
221
    short_header = 'bazaar-ng testament short form 2.1\n'
 
222
    include_root = False
209
223
    def _entry_to_line(self, path, ie):
210
224
        l = Testament._entry_to_line(self, path, ie)[:-1]
211
225
        l += ' ' + ie.revision
215
229
 
216
230
class StrictTestament3(StrictTestament):
217
231
    """This testament format is for use as a checksum in bundle format 0.9+
218
 
    
 
232
 
219
233
    It differs from StrictTestament by including data about the tree root.
220
234
    """
221
235
 
222
236
    long_header = 'bazaar testament version 3 strict\n'
223
237
    short_header = 'bazaar testament short form 3 strict\n'
224
 
    def _get_entries(self):
225
 
        return self.inventory.iter_entries()
 
238
    include_root = True
226
239
 
227
240
    def _escape_path(self, path):
228
241
        if contains_linebreaks(path):