~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/check.py

  • Committer: Martin Pool
  • Date: 2005-06-11 01:33:22 UTC
  • Revision ID: mbp@sourcefrog.net-20050611013322-f12014bf65accd0c
- don't show progress bar unless completion is known

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 by Canonical Ltd
 
1
# Copyright (C) 2004, 2005 by Martin Pool
 
2
# Copyright (C) 2005 by Canonical Ltd
2
3
 
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
14
15
# along with this program; if not, write to the Free Software
15
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
17
 
17
 
# TODO: Check ancestries are correct for every revision: includes
18
 
# every committed so far, and in a reasonable order.
19
 
 
20
 
# TODO: Also check non-mainline revisions mentioned as parents.
21
 
 
22
 
# TODO: Check for extra files in the control directory.
23
 
 
24
 
# TODO: Check revision, inventory and entry objects have all 
25
 
# required fields.
26
 
 
27
 
# TODO: Get every revision in the revision-store even if they're not
28
 
# referenced by history and make sure they're all valid.
29
 
 
30
 
# TODO: Perhaps have a way to record errors other than by raising exceptions;
31
 
# would perhaps be enough to accumulate exception objects in a list without
32
 
# raising them.  If there's more than one exception it'd be good to see them
33
 
# all.
34
 
 
35
 
import bzrlib.ui
36
 
from bzrlib.trace import note, warning
37
 
from bzrlib.osutils import rename, sha_string, fingerprint_file
38
 
from bzrlib.trace import mutter
39
 
from bzrlib.errors import BzrCheckError, NoSuchRevision
40
 
from bzrlib.inventory import ROOT_ID
41
 
 
42
 
 
43
 
class Check(object):
44
 
    """Check a branch"""
45
 
 
46
 
    # The Check object interacts with InventoryEntry.check, etc.
47
 
 
48
 
    def __init__(self, branch):
49
 
        self.branch = branch
50
 
        self.repository = branch.repository
51
 
        self.checked_text_cnt = 0
52
 
        self.checked_rev_cnt = 0
53
 
        self.ghosts = []
54
 
        self.repeated_text_cnt = 0
55
 
        self.missing_parent_links = {}
56
 
        self.missing_inventory_sha_cnt = 0
57
 
        self.missing_revision_cnt = 0
58
 
        # maps (file-id, version) -> sha1; used by InventoryFile._check
59
 
        self.checked_texts = {}
60
 
        self.checked_weaves = {}
61
 
 
62
 
    def check(self):
63
 
        self.branch.lock_read()
64
 
        self.progress = bzrlib.ui.ui_factory.nested_progress_bar()
65
 
        try:
66
 
            self.progress.update('retrieving inventory', 0, 0)
67
 
            # do not put in init, as it should be done with progess,
68
 
            # and inside the lock.
69
 
            self.inventory_weave = self.branch.repository.get_inventory_weave()
70
 
            self.history = self.branch.revision_history()
71
 
            if not len(self.history):
72
 
                # nothing to see here
73
 
                return
74
 
            self.plan_revisions()
75
 
            revno = 0
76
 
            self.check_weaves()
77
 
            while revno < len(self.planned_revisions):
78
 
                rev_id = self.planned_revisions[revno]
79
 
                self.progress.update('checking revision', revno,
80
 
                                     len(self.planned_revisions))
81
 
                revno += 1
82
 
                self.check_one_rev(rev_id)
83
 
        finally:
84
 
            self.progress.finished()
85
 
            self.branch.unlock()
86
 
 
87
 
    def plan_revisions(self):
88
 
        repository = self.branch.repository
89
 
        self.planned_revisions = set(repository.all_revision_ids())
90
 
        self.progress.clear()
91
 
        inventoried = set(self.inventory_weave.versions())
92
 
        awol = self.planned_revisions - inventoried
93
 
        if len(awol) > 0:
94
 
            raise BzrCheckError('Stored revisions missing from inventory'
95
 
                '{%s}' % ','.join([f for f in awol]))
96
 
        self.planned_revisions = list(self.planned_revisions)
97
 
 
98
 
    def report_results(self, verbose):
99
 
        note('checked branch %s format %s',
100
 
             self.branch.base, 
101
 
             self.branch._format)
102
 
 
103
 
        note('%6d revisions', self.checked_rev_cnt)
104
 
        note('%6d unique file texts', self.checked_text_cnt)
105
 
        note('%6d repeated file texts', self.repeated_text_cnt)
106
 
        note('%6d weaves', len(self.checked_weaves))
107
 
        if self.missing_inventory_sha_cnt:
108
 
            note('%6d revisions are missing inventory_sha1',
109
 
                 self.missing_inventory_sha_cnt)
110
 
        if self.missing_revision_cnt:
111
 
            note('%6d revisions are mentioned but not present',
112
 
                 self.missing_revision_cnt)
113
 
        if len(self.ghosts):
114
 
            note('%6d ghost revisions', len(self.ghosts))
115
 
            if verbose:
116
 
                for ghost in self.ghosts:
117
 
                    note('      %s', ghost)
118
 
        if len(self.missing_parent_links):
119
 
            note('%6d revisions missing parents in ancestry', 
120
 
                 len(self.missing_parent_links))
121
 
            if verbose:
122
 
                for link, linkers in self.missing_parent_links.items():
123
 
                    note('      %s should be in the ancestry for:', link)
124
 
                    for linker in linkers:
125
 
                        note('       * %s', linker)
126
 
 
127
 
    def check_one_rev(self, rev_id):
128
 
        """Check one revision.
129
 
 
130
 
        rev_id - the one to check
131
 
 
132
 
        last_rev_id - the previous one on the mainline, if any.
133
 
        """
134
 
 
135
 
        # mutter('    revision {%s}', rev_id)
136
 
        branch = self.branch
137
 
        try:
138
 
            rev_history_position = self.history.index(rev_id)
139
 
        except ValueError:
140
 
            rev_history_position = None
141
 
        last_rev_id = None
142
 
        if rev_history_position:
143
 
            rev = branch.repository.get_revision(rev_id)
144
 
            if rev_history_position > 0:
145
 
                last_rev_id = self.history[rev_history_position - 1]
146
 
        else:
147
 
            rev = branch.repository.get_revision(rev_id)
148
 
                
149
 
        if rev.revision_id != rev_id:
150
 
            raise BzrCheckError('wrong internal revision id in revision {%s}'
151
 
                                % rev_id)
152
 
 
153
 
        # check the previous history entry is a parent of this entry
154
 
        if rev.parent_ids:
155
 
            if last_rev_id is not None:
156
 
                for parent_id in rev.parent_ids:
157
 
                    if parent_id == last_rev_id:
158
 
                        break
159
 
                else:
160
 
                    raise BzrCheckError("previous revision {%s} not listed among "
161
 
                                        "parents of {%s}"
162
 
                                        % (last_rev_id, rev_id))
163
 
            for parent in rev.parent_ids:
164
 
                if not parent in self.planned_revisions:
165
 
                    missing_links = self.missing_parent_links.get(parent, [])
166
 
                    missing_links.append(rev_id)
167
 
                    self.missing_parent_links[parent] = missing_links
168
 
                    # list based so somewhat slow,
169
 
                    # TODO have a planned_revisions list and set.
170
 
                    if self.branch.repository.has_revision(parent):
171
 
                        missing_ancestry = self.repository.get_ancestry(parent)
172
 
                        for missing in missing_ancestry:
173
 
                            if (missing is not None 
174
 
                                and missing not in self.planned_revisions):
175
 
                                self.planned_revisions.append(missing)
176
 
                    else:
177
 
                        self.ghosts.append(rev_id)
178
 
        elif last_rev_id:
179
 
            raise BzrCheckError("revision {%s} has no parents listed "
180
 
                                "but preceded by {%s}"
181
 
                                % (rev_id, last_rev_id))
182
 
 
183
 
        if rev.inventory_sha1:
184
 
            inv_sha1 = branch.repository.get_inventory_sha1(rev_id)
185
 
            if inv_sha1 != rev.inventory_sha1:
186
 
                raise BzrCheckError('Inventory sha1 hash doesn\'t match'
187
 
                    ' value in revision {%s}' % rev_id)
188
 
        else:
189
 
            missing_inventory_sha_cnt += 1
190
 
            mutter("no inventory_sha1 on revision {%s}", rev_id)
191
 
        self._check_revision_tree(rev_id)
192
 
        self.checked_rev_cnt += 1
193
 
 
194
 
    def check_weaves(self):
195
 
        """Check all the weaves we can get our hands on.
196
 
        """
197
 
        n_weaves = 1
198
 
        weave_ids = []
199
 
        if self.branch.repository.weave_store.listable():
200
 
            weave_ids = list(self.branch.repository.weave_store)
201
 
            n_weaves = len(weave_ids)
202
 
        self.progress.update('checking weave', 0, n_weaves)
203
 
        self.inventory_weave.check(progress_bar=self.progress)
204
 
        for i, weave_id in enumerate(weave_ids):
205
 
            self.progress.update('checking weave', i, n_weaves)
206
 
            w = self.branch.repository.weave_store.get_weave(weave_id,
207
 
                    self.branch.repository.get_transaction())
208
 
            # No progress here, because it looks ugly.
209
 
            w.check()
210
 
            self.checked_weaves[weave_id] = True
211
 
 
212
 
    def _check_revision_tree(self, rev_id):
213
 
        tree = self.branch.repository.revision_tree(rev_id)
214
 
        inv = tree.inventory
 
18
 
 
19
 
 
20
 
 
21
def check(branch):
 
22
    """Run consistency checks on a branch.
 
23
    """
 
24
    import sys
 
25
 
 
26
    from bzrlib.trace import mutter
 
27
    from bzrlib.errors import BzrCheckError
 
28
    from bzrlib.osutils import fingerprint_file
 
29
    from bzrlib.progress import ProgressBar
 
30
    
 
31
    out = sys.stdout
 
32
 
 
33
    pb = ProgressBar(show_spinner=True)
 
34
    last_ptr = None
 
35
    checked_revs = {}
 
36
    
 
37
    history = branch.revision_history()
 
38
    revno = 0
 
39
    revcount = len(history)
 
40
 
 
41
    checked_texts = {}
 
42
    
 
43
    for rid in history:
 
44
        revno += 1
 
45
        pb.update('checking revision', revno, revcount)
 
46
        mutter('    revision {%s}' % rid)
 
47
        rev = branch.get_revision(rid)
 
48
        if rev.revision_id != rid:
 
49
            raise BzrCheckError('wrong internal revision id in revision {%s}' % rid)
 
50
        if rev.precursor != last_ptr:
 
51
            raise BzrCheckError('mismatched precursor in revision {%s}' % rid)
 
52
        last_ptr = rid
 
53
        if rid in checked_revs:
 
54
            raise BzrCheckError('repeated revision {%s}' % rid)
 
55
        checked_revs[rid] = True
 
56
 
 
57
        ## TODO: Check all the required fields are present on the revision.
 
58
 
 
59
        inv = branch.get_inventory(rev.inventory_id)
215
60
        seen_ids = {}
 
61
        seen_names = {}
 
62
 
 
63
        ## p('revision %d/%d file ids' % (revno, revcount))
216
64
        for file_id in inv:
217
65
            if file_id in seen_ids:
218
66
                raise BzrCheckError('duplicated file_id {%s} '
219
67
                                    'in inventory for revision {%s}'
220
 
                                    % (file_id, rev_id))
 
68
                                    % (file_id, rid))
221
69
            seen_ids[file_id] = True
 
70
 
 
71
        i = 0
 
72
        len_inv = len(inv)
222
73
        for file_id in inv:
 
74
            i += 1
 
75
            if i & 31 == 0:
 
76
                pb.tick()
 
77
 
223
78
            ie = inv[file_id]
224
 
            ie.check(self, rev_id, inv, tree)
225
 
        seen_names = {}
 
79
 
 
80
            if ie.parent_id != None:
 
81
                if ie.parent_id not in seen_ids:
 
82
                    raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
 
83
                            % (ie.parent_id, rid))
 
84
 
 
85
            if ie.kind == 'file':
 
86
                if ie.text_id in checked_texts:
 
87
                    fp = checked_texts[ie.text_id]
 
88
                else:
 
89
                    if not ie.text_id in branch.text_store:
 
90
                        raise BzrCheckError('text {%s} not in text_store' % ie.text_id)
 
91
 
 
92
                    tf = branch.text_store[ie.text_id]
 
93
                    fp = fingerprint_file(tf)
 
94
                    checked_texts[ie.text_id] = fp
 
95
 
 
96
                if ie.text_size != fp['size']:
 
97
                    raise BzrCheckError('text {%s} wrong size' % ie.text_id)
 
98
                if ie.text_sha1 != fp['sha1']:
 
99
                    raise BzrCheckError('text {%s} wrong sha1' % ie.text_id)
 
100
            elif ie.kind == 'directory':
 
101
                if ie.text_sha1 != None or ie.text_size != None or ie.text_id != None:
 
102
                    raise BzrCheckError('directory {%s} has text in revision {%s}'
 
103
                            % (file_id, rid))
 
104
 
 
105
        pb.tick()
226
106
        for path, ie in inv.iter_entries():
227
107
            if path in seen_names:
228
 
                raise BzrCheckError('duplicated path %s '
 
108
                raise BzrCheckError('duplicated path %r '
229
109
                                    'in inventory for revision {%s}'
230
 
                                    % (path, rev_id))
 
110
                                    % (path, revid))
231
111
            seen_names[path] = True
232
112
 
233
113
 
234
 
def check(branch, verbose):
235
 
    """Run consistency checks on a branch."""
236
 
    checker = Check(branch)
237
 
    checker.check()
238
 
    checker.report_results(verbose)
 
114
    pb.clear()
 
115
    print 'checked %d revisions, %d file texts' % (revcount, len(checked_texts))
 
116