← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

Add a test environment for InterRepository objects, and remove the fetch corner case tests from test_repository.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revision.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
2
 
#
 
1
# (C) 2005 Canonical
 
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
# TODO: Some kind of command-line display of revision properties:
 
17
# TODO: Some kind of command-line display of revision properties: 
18
18
# perhaps show them in log -v and allow them as options to the commit command.
19
19
 
20
 
 
21
 
from bzrlib.lazy_import import lazy_import
22
 
lazy_import(globals(), """
23
 
from bzrlib import deprecated_graph
24
 
from bzrlib import bugtracker
25
 
""")
26
 
from bzrlib import (
27
 
    errors,
28
 
    symbol_versioning,
29
 
    )
 
20
import bzrlib.errors
 
21
from bzrlib.graph import node_distances, select_farthest, all_descendants
30
22
from bzrlib.osutils import contains_whitespace
31
23
 
32
24
NULL_REVISION="null:"
33
 
CURRENT_REVISION="current:"
34
 
 
35
25
 
36
26
class Revision(object):
37
27
    """Single revision on a branch.
47
37
 
48
38
    properties
49
39
        Dictionary of revision properties.  These are attached to the
50
 
        revision as extra metadata.  The name must be a single
 
40
        revision as extra metadata.  The name must be a single 
51
41
        word; the value can be an arbitrary string.
52
42
    """
53
 
 
 
43
    
54
44
    def __init__(self, revision_id, properties=None, **args):
55
45
        self.revision_id = revision_id
56
 
        if properties is None:
57
 
            self.properties = {}
58
 
        else:
59
 
            self.properties = properties
60
 
            self._check_properties()
61
 
        self.committer = None
 
46
        self.properties = properties or {}
 
47
        self._check_properties()
62
48
        self.parent_ids = []
63
49
        self.parent_sha1s = []
64
 
        """Not used anymore - legacy from for 4."""
65
50
        self.__dict__.update(args)
66
51
 
67
52
    def __repr__(self):
70
55
    def __eq__(self, other):
71
56
        if not isinstance(other, Revision):
72
57
            return False
 
58
        # FIXME: rbc 20050930 parent_ids are not being compared
73
59
        return (
74
60
                self.inventory_sha1 == other.inventory_sha1
75
61
                and self.revision_id == other.revision_id
77
63
                and self.message == other.message
78
64
                and self.timezone == other.timezone
79
65
                and self.committer == other.committer
80
 
                and self.properties == other.properties
81
 
                and self.parent_ids == other.parent_ids)
 
66
                and self.properties == other.properties)
82
67
 
83
68
    def __ne__(self, other):
84
69
        return not self.__eq__(other)
85
70
 
86
71
    def _check_properties(self):
87
 
        """Verify that all revision properties are OK."""
 
72
        """Verify that all revision properties are OK.
 
73
        """
88
74
        for name, value in self.properties.iteritems():
89
75
            if not isinstance(name, basestring) or contains_whitespace(name):
90
76
                raise ValueError("invalid property name %r" % name)
91
77
            if not isinstance(value, basestring):
92
 
                raise ValueError("invalid property value %r for %r" %
93
 
                                 (value, name))
 
78
                raise ValueError("invalid property value %r for %r" % 
 
79
                                 (name, value))
94
80
 
95
81
    def get_history(self, repository):
96
82
        """Return the canonical line-of-history for this revision.
111
97
        reversed_result.reverse()
112
98
        return reversed_result
113
99
 
114
 
    def get_summary(self):
115
 
        """Get the first line of the log message for this revision.
116
 
 
117
 
        Return an empty string if message is None.
118
 
        """
119
 
        if self.message:
120
 
            return self.message.lstrip().split('\n', 1)[0]
121
 
        else:
122
 
            return ''
123
 
 
124
 
    def get_apparent_authors(self):
125
 
        """Return the apparent authors of this revision.
126
 
 
127
 
        If the revision properties contain the names of the authors,
128
 
        return them. Otherwise return the committer name.
129
 
 
130
 
        The return value will be a list containing at least one element.
131
 
        """
132
 
        authors = self.properties.get('authors', None)
133
 
        if authors is None:
134
 
            author = self.properties.get('author', self.committer)
135
 
            if author is None:
136
 
                return []
137
 
            return [author]
138
 
        else:
139
 
            return authors.split("\n")
140
 
 
141
 
    def iter_bugs(self):
142
 
        """Iterate over the bugs associated with this revision."""
143
 
        bug_property = self.properties.get('bugs', None)
144
 
        if bug_property is None:
145
 
            return
146
 
        for line in bug_property.splitlines():
147
 
            try:
148
 
                url, status = line.split(None, 2)
149
 
            except ValueError:
150
 
                raise errors.InvalidLineInBugsProperty(line)
151
 
            if status not in bugtracker.ALLOWED_BUG_STATUSES:
152
 
                raise errors.InvalidBugStatus(status)
153
 
            yield url, status
 
100
 
 
101
def is_ancestor(revision_id, candidate_id, branch):
 
102
    """Return true if candidate_id is an ancestor of revision_id.
 
103
 
 
104
    A false negative will be returned if any intermediate descendent of
 
105
    candidate_id is not present in any of the revision_sources.
 
106
    
 
107
    revisions_source is an object supporting a get_revision operation that
 
108
    behaves like Branch's.
 
109
    """
 
110
    return candidate_id in branch.repository.get_ancestry(revision_id)
154
111
 
155
112
 
156
113
def iter_ancestors(revision_id, revision_source, only_present=False):
163
120
                yield ancestor, distance
164
121
            try:
165
122
                revision = revision_source.get_revision(ancestor)
166
 
            except errors.NoSuchRevision, e:
 
123
            except bzrlib.errors.NoSuchRevision, e:
167
124
                if e.revision == revision_id:
168
 
                    raise
 
125
                    raise 
169
126
                else:
170
127
                    continue
171
128
            if only_present:
179
136
    """Return the ancestors of a revision present in a branch.
180
137
 
181
138
    It's possible that a branch won't have the complete ancestry of
182
 
    one of its revisions.
 
139
    one of its revisions.  
183
140
 
184
141
    """
185
142
    found_ancestors = {}
186
143
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
187
144
                         only_present=True))
188
145
    for anc_order, (anc_id, anc_distance) in anc_iter:
189
 
        if anc_id not in found_ancestors:
 
146
        if not found_ancestors.has_key(anc_id):
190
147
            found_ancestors[anc_id] = (anc_order, anc_distance)
191
148
    return found_ancestors
192
 
 
 
149
    
193
150
 
194
151
def __get_closest(intersection):
195
152
    intersection.sort()
196
 
    matches = []
 
153
    matches = [] 
197
154
    for entry in intersection:
198
155
        if entry[0] == intersection[0][0]:
199
156
            matches.append(entry[2])
200
157
    return matches
201
158
 
202
159
 
203
 
def is_reserved_id(revision_id):
204
 
    """Determine whether a revision id is reserved
205
 
 
206
 
    :return: True if the revision is reserved, False otherwise
 
160
def old_common_ancestor(revision_a, revision_b, revision_source):
 
161
    """Find the ancestor common to both revisions that is closest to both.
207
162
    """
208
 
    return isinstance(revision_id, basestring) and revision_id.endswith(':')
209
 
 
210
 
 
211
 
def check_not_reserved_id(revision_id):
212
 
    """Raise ReservedId if the supplied revision_id is reserved"""
213
 
    if is_reserved_id(revision_id):
214
 
        raise errors.ReservedId(revision_id)
215
 
 
216
 
 
217
 
def ensure_null(revision_id):
218
 
    """Ensure only NULL_REVISION is used to represent the null revision"""
219
 
    if revision_id is None:
220
 
        symbol_versioning.warn('NULL_REVISION should be used for the null'
221
 
            ' revision instead of None, as of bzr 0.91.',
222
 
            DeprecationWarning, stacklevel=2)
223
 
        return NULL_REVISION
 
163
    from bzrlib.trace import mutter
 
164
    a_ancestors = find_present_ancestors(revision_a, revision_source)
 
165
    b_ancestors = find_present_ancestors(revision_b, revision_source)
 
166
    a_intersection = []
 
167
    b_intersection = []
 
168
    # a_order is used as a tie-breaker when two equally-good bases are found
 
169
    for revision, (a_order, a_distance) in a_ancestors.iteritems():
 
170
        if b_ancestors.has_key(revision):
 
171
            a_intersection.append((a_distance, a_order, revision))
 
172
            b_intersection.append((b_ancestors[revision][1], a_order, revision))
 
173
    mutter("a intersection: %r", a_intersection)
 
174
    mutter("b intersection: %r", b_intersection)
 
175
 
 
176
    a_closest = __get_closest(a_intersection)
 
177
    if len(a_closest) == 0:
 
178
        return None
 
179
    b_closest = __get_closest(b_intersection)
 
180
    assert len(b_closest) != 0
 
181
    mutter ("a_closest %r", a_closest)
 
182
    mutter ("b_closest %r", b_closest)
 
183
    if a_closest[0] in b_closest:
 
184
        return a_closest[0]
 
185
    elif b_closest[0] in a_closest:
 
186
        return b_closest[0]
224
187
    else:
225
 
        return revision_id
226
 
 
227
 
 
228
 
def is_null(revision_id):
229
 
    if revision_id is None:
230
 
        symbol_versioning.warn('NULL_REVISION should be used for the null'
231
 
            ' revision instead of None, as of bzr 0.90.',
232
 
            DeprecationWarning, stacklevel=2)
233
 
    return revision_id in (None, NULL_REVISION)
 
188
        raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
 
189
    return a_closest[0]
 
190
 
 
191
def revision_graph(revision, revision_source):
 
192
    """Produce a graph of the ancestry of the specified revision.
 
193
    Return root, ancestors map, descendants map
 
194
 
 
195
    TODO: Produce graphs with the NULL revision as root, so that we can find
 
196
    a common even when trees are not branches don't represent a single line
 
197
    of descent.
 
198
    RBC: 20051024: note that when we have two partial histories, this may not
 
199
         be possible. But if we are willing to pretend :)... sure.
 
200
    """
 
201
    ancestors = {}
 
202
    descendants = {}
 
203
    lines = [revision]
 
204
    root = None
 
205
    descendants[revision] = {}
 
206
    while len(lines) > 0:
 
207
        new_lines = set()
 
208
        for line in lines:
 
209
            if line == NULL_REVISION:
 
210
                parents = []
 
211
                root = NULL_REVISION
 
212
            else:
 
213
                try:
 
214
                    rev = revision_source.get_revision(line)
 
215
                    parents = list(rev.parent_ids)
 
216
                    if len(parents) == 0:
 
217
                        parents = [NULL_REVISION]
 
218
                except bzrlib.errors.NoSuchRevision:
 
219
                    if line == revision:
 
220
                        raise
 
221
                    parents = None
 
222
            if parents is not None:
 
223
                for parent in parents:
 
224
                    if parent not in ancestors:
 
225
                        new_lines.add(parent)
 
226
                    if parent not in descendants:
 
227
                        descendants[parent] = {}
 
228
                    descendants[parent][line] = 1
 
229
            if parents is not None:
 
230
                ancestors[line] = set(parents)
 
231
        lines = new_lines
 
232
    if root is None:
 
233
        # The history for revision becomes inaccessible without
 
234
        # actually hitting a no-parents revision. This then
 
235
        # makes these asserts below trigger. So, if root is None
 
236
        # determine the actual root by walking the accessible tree
 
237
        # and then stash NULL_REVISION at the end.
 
238
        root = NULL_REVISION
 
239
        descendants[root] = {}
 
240
        # for every revision, check we can access at least
 
241
        # one parent, if we cant, add NULL_REVISION and
 
242
        # a link
 
243
        for rev in ancestors:
 
244
            if len(ancestors[rev]) == 0:
 
245
                raise RuntimeError('unreachable code ?!')
 
246
            ok = False
 
247
            for parent in ancestors[rev]:
 
248
                if parent in ancestors:
 
249
                    ok = True
 
250
            if ok:
 
251
                continue
 
252
            descendants[root][rev] = 1
 
253
            ancestors[rev].add(root)
 
254
        ancestors[root] = set()
 
255
    assert root not in descendants[root]
 
256
    assert root not in ancestors[root]
 
257
    return root, ancestors, descendants
 
258
 
 
259
 
 
260
def combined_graph(revision_a, revision_b, revision_source):
 
261
    """Produce a combined ancestry graph.
 
262
    Return graph root, ancestors map, descendants map, set of common nodes"""
 
263
    root, ancestors, descendants = revision_graph(revision_a, revision_source)
 
264
    root_b, ancestors_b, descendants_b = revision_graph(revision_b, 
 
265
                                                        revision_source)
 
266
    if root != root_b:
 
267
        raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
 
268
    common = set()
 
269
    for node, node_anc in ancestors_b.iteritems():
 
270
        if node in ancestors:
 
271
            common.add(node)
 
272
        else:
 
273
            ancestors[node] = set()
 
274
        ancestors[node].update(node_anc)
 
275
    for node, node_dec in descendants_b.iteritems():
 
276
        if node not in descendants:
 
277
            descendants[node] = {}
 
278
        descendants[node].update(node_dec)
 
279
    return root, ancestors, descendants, common
 
280
 
 
281
 
 
282
def common_ancestor(revision_a, revision_b, revision_source):
 
283
    try:
 
284
        root, ancestors, descendants, common = \
 
285
            combined_graph(revision_a, revision_b, revision_source)
 
286
    except bzrlib.errors.NoCommonRoot:
 
287
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
 
288
        
 
289
    distances = node_distances (descendants, ancestors, root)
 
290
    farthest = select_farthest(distances, common)
 
291
    if farthest is None or farthest == NULL_REVISION:
 
292
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
 
293
    return farthest
 
294
 
 
295
 
 
296
class MultipleRevisionSources(object):
 
297
    """Proxy that looks in multiple branches for revisions."""
 
298
    def __init__(self, *args):
 
299
        object.__init__(self)
 
300
        assert len(args) != 0
 
301
        self._revision_sources = args
 
302
 
 
303
    def get_revision(self, revision_id):
 
304
        for source in self._revision_sources:
 
305
            try:
 
306
                return source.get_revision(revision_id)
 
307
            except bzrlib.errors.NoSuchRevision, e:
 
308
                pass
 
309
        raise e
 
310
 
 
311
def get_intervening_revisions(ancestor_id, rev_id, rev_source, 
 
312
                              revision_history=None):
 
313
    """Find the longest line of descent from maybe_ancestor to revision.
 
314
    Revision history is followed where possible.
 
315
 
 
316
    If ancestor_id == rev_id, list will be empty.
 
317
    Otherwise, rev_id will be the last entry.  ancestor_id will never appear.
 
318
    If ancestor_id is not an ancestor, NotAncestor will be thrown
 
319
    """
 
320
    root, ancestors, descendants = revision_graph(rev_id, rev_source)
 
321
    if len(descendants) == 0:
 
322
        raise NoSuchRevision(rev_source, rev_id)
 
323
    if ancestor_id not in descendants:
 
324
        rev_source.get_revision(ancestor_id)
 
325
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
 
326
    root_descendants = all_descendants(descendants, ancestor_id)
 
327
    root_descendants.add(ancestor_id)
 
328
    if rev_id not in root_descendants:
 
329
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
 
330
    distances = node_distances(descendants, ancestors, ancestor_id,
 
331
                               root_descendants=root_descendants)
 
332
 
 
333
    def best_ancestor(rev_id):
 
334
        best = None
 
335
        for anc_id in ancestors[rev_id]:
 
336
            try:
 
337
                distance = distances[anc_id]
 
338
            except KeyError:
 
339
                continue
 
340
            if revision_history is not None and anc_id in revision_history:
 
341
                return anc_id
 
342
            elif best is None or distance > best[1]:
 
343
                best = (anc_id, distance)
 
344
        return best[0]
 
345
 
 
346
    next = rev_id
 
347
    path = []
 
348
    while next != ancestor_id:
 
349
        path.append(next)
 
350
        next = best_ancestor(next)
 
351
    path.reverse()
 
352
    return path