/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/revisiontree.py

  • Committer: Andrew Bennetts
  • Date: 2008-08-12 14:53:26 UTC
  • mto: This revision was merged to the branch mainline in revision 3624.
  • Revision ID: andrew.bennetts@canonical.com-20080812145326-yx693x2jc4rcovb7
Move the notes on writing tests out of HACKING into a new file, and improve
them.

Many of the testing notes in the HACKING file were in duplicated in two places
in that file!  This change removes that duplication.  It also adds new sections
on “Where should I put a new test?” and “TestCase and its subclasses”, and
others like “Test feature dependencies” have been expanded.  The whole document
has generally been edited to be a bit more coherent. 

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revisiontree.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2007 Canonical Ltd
2
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
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
17
"""RevisionTree - a Tree implementation backed by repository data for a revision."""
18
18
 
20
20
 
21
21
from bzrlib import (
22
22
    errors,
 
23
    osutils,
23
24
    revision,
24
 
    tree,
 
25
    symbol_versioning,
25
26
    )
26
 
 
27
 
 
28
 
class RevisionTree(tree.Tree):
 
27
from bzrlib.tree import Tree
 
28
 
 
29
 
 
30
class RevisionTree(Tree):
29
31
    """Tree viewing a previous revision.
30
32
 
31
33
    File text can be retrieved from the text store.
32
34
    """
33
35
 
34
36
    def __init__(self, branch, inv, revision_id):
35
 
        # for compatability the 'branch' parameter has not been renamed to
 
37
        # for compatability the 'branch' parameter has not been renamed to 
36
38
        # repository at this point. However, we should change RevisionTree's
37
 
        # construction to always be via Repository and not via direct
 
39
        # construction to always be via Repository and not via direct 
38
40
        # construction - this will mean that we can change the constructor
39
41
        # with much less chance of breaking client code.
40
42
        self._repository = branch
43
45
        self._rules_searcher = None
44
46
 
45
47
    def supports_tree_reference(self):
46
 
        return getattr(self._repository._format, "supports_tree_reference",
47
 
            False)
 
48
        return True
48
49
 
49
50
    def get_parent_ids(self):
50
51
        """See Tree.get_parent_ids.
57
58
            parent_ids = self._repository.get_revision(
58
59
                self._revision_id).parent_ids
59
60
        return parent_ids
60
 
 
 
61
        
61
62
    def get_revision_id(self):
62
63
        """Return the revision id associated with this tree."""
63
64
        return self._revision_id
64
65
 
65
 
    def get_file_text(self, file_id, path=None):
66
 
        _, content = list(self.iter_files_bytes([(file_id, None)]))[0]
67
 
        return ''.join(content)
 
66
    def get_file_lines(self, file_id):
 
67
        return osutils.split_lines(self.get_file_text(file_id))
 
68
 
 
69
    def get_file_text(self, file_id):
 
70
        return list(self.iter_files_bytes([(file_id, None)]))[0][1]
68
71
 
69
72
    def get_file(self, file_id, path=None):
70
73
        return StringIO(self.get_file_text(file_id))
85
88
                      default_revision=revision.CURRENT_REVISION):
86
89
        """See Tree.annotate_iter"""
87
90
        text_key = (file_id, self.inventory[file_id].revision)
88
 
        annotator = self._repository.texts.get_annotator()
89
 
        annotations = annotator.annotate_flat(text_key)
 
91
        annotations = self._repository.texts.annotate(text_key)
90
92
        return [(key[-1], line) for key, line in annotations]
91
93
 
92
94
    def get_file_size(self, file_id):
101
103
 
102
104
    def get_file_mtime(self, file_id, path=None):
103
105
        ie = self._inventory[file_id]
104
 
        try:
105
 
            revision = self._repository.get_revision(ie.revision)
106
 
        except errors.NoSuchRevision:
107
 
            raise errors.FileTimestampUnavailable(self.id2path(file_id))
 
106
        revision = self._repository.get_revision(ie.revision)
108
107
        return revision.timestamp
109
108
 
110
109
    def is_executable(self, file_id, path=None):
116
115
    def has_filename(self, filename):
117
116
        return bool(self.inventory.path2id(filename))
118
117
 
119
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
118
    def list_files(self, include_root=False):
120
119
        # The only files returned by this are those from the version
121
 
        inv = self.inventory
122
 
        if from_dir is None:
123
 
            from_dir_id = None
124
 
        else:
125
 
            from_dir_id = inv.path2id(from_dir)
126
 
            if from_dir_id is None:
127
 
                # Directory not versioned
128
 
                return
129
 
        entries = inv.iter_entries(from_dir=from_dir_id, recursive=recursive)
130
 
        if inv.root is not None and not include_root and from_dir is None:
 
120
        entries = self.inventory.iter_entries()
 
121
        # skip the root for compatability with the current apis.
 
122
        if self.inventory.root is not None and not include_root:
131
123
            # skip the root for compatability with the current apis.
132
124
            entries.next()
133
125
        for path, entry in entries:
135
127
 
136
128
    def get_symlink_target(self, file_id):
137
129
        ie = self._inventory[file_id]
138
 
        # Inventories store symlink targets in unicode
139
 
        return ie.symlink_target
 
130
        return ie.symlink_target;
140
131
 
141
132
    def get_reference_revision(self, file_id, path=None):
142
133
        return self.inventory[file_id].reference_revision
219
210
            self._rules_searcher = super(RevisionTree,
220
211
                self)._get_rules_searcher(default_searcher)
221
212
        return self._rules_searcher
222
 
 
223
 
 
224
 
class InterCHKRevisionTree(tree.InterTree):
225
 
    """Fast path optimiser for RevisionTrees with CHK inventories."""
226
 
 
227
 
    @staticmethod
228
 
    def is_compatible(source, target):
229
 
        if (isinstance(source, RevisionTree)
230
 
            and isinstance(target, RevisionTree)):
231
 
            try:
232
 
                # Only CHK inventories have id_to_entry attribute
233
 
                source.inventory.id_to_entry
234
 
                target.inventory.id_to_entry
235
 
                return True
236
 
            except AttributeError:
237
 
                pass
238
 
        return False
239
 
 
240
 
    def iter_changes(self, include_unchanged=False,
241
 
                     specific_files=None, pb=None, extra_trees=[],
242
 
                     require_versioned=True, want_unversioned=False):
243
 
        lookup_trees = [self.source]
244
 
        if extra_trees:
245
 
             lookup_trees.extend(extra_trees)
246
 
        # The ids of items we need to examine to insure delta consistency.
247
 
        precise_file_ids = set()
248
 
        discarded_changes = {}
249
 
        if specific_files == []:
250
 
            specific_file_ids = []
251
 
        else:
252
 
            specific_file_ids = self.target.paths2ids(specific_files,
253
 
                lookup_trees, require_versioned=require_versioned)
254
 
        # FIXME: It should be possible to delegate include_unchanged handling
255
 
        # to CHKInventory.iter_changes and do a better job there -- vila
256
 
        # 20090304
257
 
        changed_file_ids = set()
258
 
        for result in self.target.inventory.iter_changes(self.source.inventory):
259
 
            if specific_file_ids is not None:
260
 
                file_id = result[0]
261
 
                if file_id not in specific_file_ids:
262
 
                    # A change from the whole tree that we don't want to show yet.
263
 
                    # We may find that we need to show it for delta consistency, so
264
 
                    # stash it.
265
 
                    discarded_changes[result[0]] = result
266
 
                    continue
267
 
                new_parent_id = result[4][1]
268
 
                precise_file_ids.add(new_parent_id)
269
 
            yield result
270
 
            changed_file_ids.add(result[0])
271
 
        if specific_file_ids is not None:
272
 
            for result in self._handle_precise_ids(precise_file_ids,
273
 
                changed_file_ids, discarded_changes=discarded_changes):
274
 
                yield result
275
 
        if include_unchanged:
276
 
            # CHKMap avoid being O(tree), so we go to O(tree) only if
277
 
            # required to.
278
 
            # Now walk the whole inventory, excluding the already yielded
279
 
            # file ids
280
 
            changed_file_ids = set(changed_file_ids)
281
 
            for relpath, entry in self.target.inventory.iter_entries():
282
 
                if (specific_file_ids is not None
283
 
                    and not entry.file_id in specific_file_ids):
284
 
                    continue
285
 
                if not entry.file_id in changed_file_ids:
286
 
                    yield (entry.file_id,
287
 
                           (relpath, relpath), # Not renamed
288
 
                           False, # Not modified
289
 
                           (True, True), # Still  versioned
290
 
                           (entry.parent_id, entry.parent_id),
291
 
                           (entry.name, entry.name),
292
 
                           (entry.kind, entry.kind),
293
 
                           (entry.executable, entry.executable))
294
 
 
295
 
 
296
 
tree.InterTree.register_optimiser(InterCHKRevisionTree)