← 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-08-17 18:13:57 UTC
  • mfrom: (5268.7.29 transport-segments)
  • Revision ID: pqm@pqm.ubuntu.com-20110817181357-y5q5eth1hk8bl3om
(jelmer) Allow specifying the colocated branch to use in the branch URL,
 and retrieving the branch name using ControlDir._get_selected_branch.
 (Jelmer Vernooij)

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