/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/check.py

  • Committer: Robert Collins
  • Date: 2005-10-24 08:54:33 UTC
  • Revision ID: robertc@robertcollins.net-20051024085433-5e48ed93d1546627
touch up plugin.py docstring

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/check.py
 
1
# Copyright (C) 2004, 2005 by Martin Pool
 
2
# Copyright (C) 2005 by Canonical Ltd
 
3
 
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
 
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
 
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
17
 
 
18
# TODO: Check ancestries are correct for every revision: includes
 
19
# every committed so far, and in a reasonable order.
 
20
 
 
21
# TODO: Also check non-mainline revisions mentioned as parents.
 
22
 
 
23
# TODO: Check for extra files in the control directory.
 
24
 
 
25
# TODO: Check revision, inventory and entry objects have all 
 
26
# required fields.
 
27
 
 
28
 
 
29
import bzrlib.ui
 
30
from bzrlib.trace import note, warning
 
31
from bzrlib.osutils import rename, sha_string, fingerprint_file
 
32
from bzrlib.trace import mutter
 
33
from bzrlib.errors import BzrCheckError, NoSuchRevision
 
34
from bzrlib.inventory import ROOT_ID
 
35
from bzrlib.branch import gen_root_id
 
36
 
 
37
 
 
38
class Check(object):
 
39
    """Check a branch"""
 
40
 
 
41
    def __init__(self, branch):
 
42
        self.branch = branch
 
43
        self.checked_text_cnt = 0
 
44
        self.checked_rev_cnt = 0
 
45
        self.ghosts = []
 
46
        self.repeated_text_cnt = 0
 
47
        self.missing_parent_links = {}
 
48
        self.missing_inventory_sha_cnt = 0
 
49
        self.missing_revision_cnt = 0
 
50
        # maps (file-id, version) -> sha1
 
51
        self.checked_texts = {}
 
52
 
 
53
    def check(self):
 
54
        self.branch.lock_read()
 
55
        try:
 
56
            self.history = self.branch.revision_history()
 
57
            if not len(self.history):
 
58
                # nothing to see here
 
59
                return
 
60
            self.planned_revisions = self.branch.get_ancestry(self.history[-1])
 
61
            self.planned_revisions.remove(None)
 
62
            revno = 0
 
63
    
 
64
            self.progress = bzrlib.ui.ui_factory.progress_bar()
 
65
            while revno < len(self.planned_revisions):
 
66
                rev_id = self.planned_revisions[revno]
 
67
                self.progress.update('checking revision', revno,
 
68
                                     len(self.planned_revisions))
 
69
                revno += 1
 
70
                self.check_one_rev(rev_id)
 
71
            self.progress.clear()
 
72
        finally:
 
73
            self.branch.unlock()
 
74
 
 
75
    def report_results(self, verbose):
 
76
        note('checked branch %s format %d',
 
77
             self.branch.base, 
 
78
             self.branch._branch_format)
 
79
 
 
80
        note('%6d revisions', self.checked_rev_cnt)
 
81
        note('%6d unique file texts', self.checked_text_cnt)
 
82
        note('%6d repeated file texts', self.repeated_text_cnt)
 
83
        if self.missing_inventory_sha_cnt:
 
84
            note('%6d revisions are missing inventory_sha1',
 
85
                 self.missing_inventory_sha_cnt)
 
86
        if self.missing_revision_cnt:
 
87
            note('%6d revisions are mentioned but not present',
 
88
                 self.missing_revision_cnt)
 
89
        if len(self.ghosts):
 
90
            note('%6d ghost revisions', len(self.ghosts))
 
91
            if verbose:
 
92
                for ghost in self.ghosts:
 
93
                    note('      %s', ghost)
 
94
        if len(self.missing_parent_links):
 
95
            note('%6d revisions missing parents in ancestry', 
 
96
                 len(self.missing_parent_links))
 
97
            if verbose:
 
98
                for link, linkers in self.missing_parent_links.items():
 
99
                    note('      %s should be in the ancestry for:', link)
 
100
                    for linker in linkers:
 
101
                        note('       * %s', linker)
 
102
 
 
103
    def check_one_rev(self, rev_id):
 
104
        """Check one revision.
 
105
 
 
106
        rev_id - the one to check
 
107
 
 
108
        last_rev_id - the previous one on the mainline, if any.
 
109
        """
 
110
 
 
111
        # mutter('    revision {%s}' % rev_id)
 
112
        branch = self.branch
 
113
        try:
 
114
            rev_history_position = self.history.index(rev_id)
 
115
        except ValueError:
 
116
            rev_history_position = None
 
117
        last_rev_id = None
 
118
        if rev_history_position:
 
119
            rev = branch.get_revision(rev_id)
 
120
            if rev_history_position > 0:
 
121
                last_rev_id = self.history[rev_history_position - 1]
 
122
        else:
 
123
            rev = branch.get_revision(rev_id)
 
124
                
 
125
        if rev.revision_id != rev_id:
 
126
            raise BzrCheckError('wrong internal revision id in revision {%s}'
 
127
                                % rev_id)
 
128
 
 
129
        # check the previous history entry is a parent of this entry
 
130
        if rev.parent_ids:
 
131
            if last_rev_id is not None:
 
132
                for parent_id in rev.parent_ids:
 
133
                    if parent_id == last_rev_id:
 
134
                        break
 
135
                else:
 
136
                    raise BzrCheckError("previous revision {%s} not listed among "
 
137
                                        "parents of {%s}"
 
138
                                        % (last_rev_id, rev_id))
 
139
            for parent in rev.parent_ids:
 
140
                if not parent in self.planned_revisions:
 
141
                    missing_links = self.missing_parent_links.get(parent, [])
 
142
                    missing_links.append(rev_id)
 
143
                    self.missing_parent_links[parent] = missing_links
 
144
                    # list based so slow, TODO have a planned_revisions list and set.
 
145
                    if self.branch.has_revision(parent):
 
146
                        missing_ancestry = self.branch.get_ancestry(parent)
 
147
                        for missing in missing_ancestry:
 
148
                            if (missing is not None 
 
149
                                and missing not in self.planned_revisions):
 
150
                                self.planned_revisions.append(missing)
 
151
                    else:
 
152
                        self.ghosts.append(rev_id)
 
153
        elif last_rev_id:
 
154
            raise BzrCheckError("revision {%s} has no parents listed "
 
155
                                "but preceded by {%s}"
 
156
                                % (rev_id, last_rev_id))
 
157
 
 
158
        if rev.inventory_sha1:
 
159
            inv_sha1 = branch.get_inventory_sha1(rev_id)
 
160
            if inv_sha1 != rev.inventory_sha1:
 
161
                raise BzrCheckError('Inventory sha1 hash doesn\'t match'
 
162
                    ' value in revision {%s}' % rev_id)
 
163
        else:
 
164
            missing_inventory_sha_cnt += 1
 
165
            mutter("no inventory_sha1 on revision {%s}" % rev_id)
 
166
        self._check_revision_tree(rev_id)
 
167
        self.checked_rev_cnt += 1
 
168
 
 
169
    def _check_revision_tree(self, rev_id):
 
170
        tree = self.branch.revision_tree(rev_id)
 
171
        inv = tree.inventory
 
172
        seen_ids = {}
 
173
        for file_id in inv:
 
174
            if file_id in seen_ids:
 
175
                raise BzrCheckError('duplicated file_id {%s} '
 
176
                                    'in inventory for revision {%s}'
 
177
                                    % (file_id, rev_id))
 
178
            seen_ids[file_id] = True
 
179
        for file_id in inv:
 
180
            ie = inv[file_id]
 
181
            ie.check(self, rev_id, inv, tree)
 
182
        seen_names = {}
 
183
        for path, ie in inv.iter_entries():
 
184
            if path in seen_names:
 
185
                raise BzrCheckError('duplicated path %s '
 
186
                                    'in inventory for revision {%s}'
 
187
                                    % (path, rev_id))
 
188
            seen_names[path] = True
 
189
 
 
190
 
 
191
def check(branch, verbose):
 
192
    """Run consistency checks on a branch."""
 
193
    checker = Check(branch)
 
194
    checker.check()
 
195
    checker.report_results(verbose)