← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/testament.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

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
74
76
from bzrlib.osutils import (
75
77
    contains_whitespace,
76
78
    contains_linebreaks,
77
 
    sha,
 
79
    sha_strings,
78
80
    )
 
81
from bzrlib.tree import Tree
79
82
 
80
83
 
81
84
class Testament(object):
82
85
    """Reduced summary of a revision.
83
86
 
84
 
    Testaments can be 
 
87
    Testaments can be
85
88
 
86
89
      - produced from a revision
87
90
      - written to a stream
91
94
 
92
95
    long_header = 'bazaar-ng testament version 1\n'
93
96
    short_header = 'bazaar-ng testament short form 1\n'
 
97
    include_root = False
94
98
 
95
99
    @classmethod
96
100
    def from_revision(cls, repository, revision_id):
97
 
        """Produce a new testament from a historical revision"""
 
101
        """Produce a new testament from a historical revision."""
98
102
        rev = repository.get_revision(revision_id)
99
 
        inventory = repository.get_inventory(revision_id)
100
 
        return cls(rev, inventory)
101
 
 
102
 
    def __init__(self, rev, inventory):
103
 
        """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."""
104
114
        self.revision_id = rev.revision_id
105
115
        self.committer = rev.committer
106
116
        self.timezone = rev.timezone or 0
107
117
        self.timestamp = rev.timestamp
108
118
        self.message = rev.message
109
119
        self.parent_ids = rev.parent_ids[:]
110
 
        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
111
124
        self.revprops = copy(rev.properties)
112
125
        if contains_whitespace(self.revision_id):
113
126
            raise ValueError(self.revision_id)
143
156
        return [line.encode('utf-8') for line in r]
144
157
 
145
158
    def _get_entries(self):
146
 
        entries = self.inventory.iter_entries()
147
 
        entries.next()
148
 
        return entries
 
159
        return ((path, ie) for (path, versioned, kind, file_id, ie) in
 
160
                self.tree.list_files(include_root=self.include_root))
149
161
 
150
162
    def _escape_path(self, path):
151
163
        if contains_linebreaks(path):
180
192
 
181
193
    def as_short_text(self):
182
194
        """Return short digest-based testament."""
183
 
        return (self.short_header + 
 
195
        return (self.short_header +
184
196
                'revision-id: %s\n'
185
197
                'sha1: %s\n'
186
198
                % (self.revision_id, self.as_sha1()))
199
211
        return r
200
212
 
201
213
    def as_sha1(self):
202
 
        s = sha()
203
 
        map(s.update, self.as_text_lines())
204
 
        return s.hexdigest()
 
214
        return sha_strings(self.as_text_lines())
205
215
 
206
216
 
207
217
class StrictTestament(Testament):
209
219
 
210
220
    long_header = 'bazaar-ng testament version 2.1\n'
211
221
    short_header = 'bazaar-ng testament short form 2.1\n'
 
222
    include_root = False
212
223
    def _entry_to_line(self, path, ie):
213
224
        l = Testament._entry_to_line(self, path, ie)[:-1]
214
225
        l += ' ' + ie.revision
218
229
 
219
230
class StrictTestament3(StrictTestament):
220
231
    """This testament format is for use as a checksum in bundle format 0.9+
221
 
    
 
232
 
222
233
    It differs from StrictTestament by including data about the tree root.
223
234
    """
224
235
 
225
236
    long_header = 'bazaar testament version 3 strict\n'
226
237
    short_header = 'bazaar testament short form 3 strict\n'
227
 
    def _get_entries(self):
228
 
        return self.inventory.iter_entries()
 
238
    include_root = True
229
239
 
230
240
    def _escape_path(self, path):
231
241
        if contains_linebreaks(path):