~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/check.py

  • Committer: Martin Pool
  • Date: 2005-05-26 16:09:45 UTC
  • Revision ID: mbp@sourcefrog.net-20050526160945-7574594a45ba1c9c
- more invariant checks in AtomicFile

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2004, 2005 by Martin Pool
 
2
# Copyright (C) 2005 by Canonical Ltd
 
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
5
6
# the Free Software Foundation; either version 2 of the License, or
6
7
# (at your option) any later version.
7
 
#
 
8
 
8
9
# This program is distributed in the hope that it will be useful,
9
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
12
# GNU General Public License for more details.
12
 
#
 
13
 
13
14
# You should have received a copy of the GNU General Public License
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
 
from bzrlib.errors import BzrCheckError
36
 
import bzrlib.ui
37
 
from bzrlib.trace import note
38
 
 
39
 
class Check(object):
40
 
    """Check a repository"""
41
 
 
42
 
    # The Check object interacts with InventoryEntry.check, etc.
43
 
 
44
 
    def __init__(self, repository):
45
 
        self.repository = repository
46
 
        self.checked_text_cnt = 0
47
 
        self.checked_rev_cnt = 0
48
 
        self.ghosts = []
49
 
        self.repeated_text_cnt = 0
50
 
        self.missing_parent_links = {}
51
 
        self.missing_inventory_sha_cnt = 0
52
 
        self.missing_revision_cnt = 0
53
 
        # maps (file-id, version) -> sha1; used by InventoryFile._check
54
 
        self.checked_texts = {}
55
 
        self.checked_weaves = {}
56
 
 
57
 
    def check(self):
58
 
        self.repository.lock_read()
59
 
        self.progress = bzrlib.ui.ui_factory.nested_progress_bar()
60
 
        try:
61
 
            self.progress.update('retrieving inventory', 0, 0)
62
 
            # do not put in init, as it should be done with progess,
63
 
            # and inside the lock.
64
 
            self.inventory_weave = self.repository.get_inventory_weave()
65
 
            self.plan_revisions()
66
 
            revno = 0
67
 
            self.check_weaves()
68
 
            while revno < len(self.planned_revisions):
69
 
                rev_id = self.planned_revisions[revno]
70
 
                self.progress.update('checking revision', revno,
71
 
                                     len(self.planned_revisions))
72
 
                revno += 1
73
 
                self.check_one_rev(rev_id)
74
 
        finally:
75
 
            self.progress.finished()
76
 
            self.repository.unlock()
77
 
 
78
 
    def plan_revisions(self):
79
 
        repository = self.repository
80
 
        self.planned_revisions = set(repository.all_revision_ids())
81
 
        self.progress.clear()
82
 
        inventoried = set(self.inventory_weave.versions())
83
 
        awol = self.planned_revisions - inventoried
84
 
        if len(awol) > 0:
85
 
            raise BzrCheckError('Stored revisions missing from inventory'
86
 
                '{%s}' % ','.join([f for f in awol]))
87
 
        self.planned_revisions = list(self.planned_revisions)
88
 
 
89
 
    def report_results(self, verbose):
90
 
        note('checked repository %s format %s',
91
 
             self.repository.bzrdir.root_transport,
92
 
             self.repository._format)
93
 
        note('%6d revisions', self.checked_rev_cnt)
94
 
        note('%6d unique file texts', self.checked_text_cnt)
95
 
        note('%6d repeated file texts', self.repeated_text_cnt)
96
 
        note('%6d weaves', len(self.checked_weaves))
97
 
        if self.missing_inventory_sha_cnt:
98
 
            note('%6d revisions are missing inventory_sha1',
99
 
                 self.missing_inventory_sha_cnt)
100
 
        if self.missing_revision_cnt:
101
 
            note('%6d revisions are mentioned but not present',
102
 
                 self.missing_revision_cnt)
103
 
        if len(self.ghosts):
104
 
            note('%6d ghost revisions', len(self.ghosts))
105
 
            if verbose:
106
 
                for ghost in self.ghosts:
107
 
                    note('      %s', ghost)
108
 
        if len(self.missing_parent_links):
109
 
            note('%6d revisions missing parents in ancestry',
110
 
                 len(self.missing_parent_links))
111
 
            if verbose:
112
 
                for link, linkers in self.missing_parent_links.items():
113
 
                    note('      %s should be in the ancestry for:', link)
114
 
                    for linker in linkers:
115
 
                        note('       * %s', linker)
116
 
 
117
 
    def check_one_rev(self, rev_id):
118
 
        """Check one revision.
119
 
 
120
 
        rev_id - the one to check
121
 
        """
122
 
        rev = self.repository.get_revision(rev_id)
123
 
                
124
 
        if rev.revision_id != rev_id:
125
 
            raise BzrCheckError('wrong internal revision id in revision {%s}'
126
 
                                % rev_id)
127
 
 
128
 
        for parent in rev.parent_ids:
129
 
            if not parent in self.planned_revisions:
130
 
                missing_links = self.missing_parent_links.get(parent, [])
131
 
                missing_links.append(rev_id)
132
 
                self.missing_parent_links[parent] = missing_links
133
 
                # list based so somewhat slow,
134
 
                # TODO have a planned_revisions list and set.
135
 
                if self.repository.has_revision(parent):
136
 
                    missing_ancestry = self.repository.get_ancestry(parent)
137
 
                    for missing in missing_ancestry:
138
 
                        if (missing is not None 
139
 
                            and missing not in self.planned_revisions):
140
 
                            self.planned_revisions.append(missing)
141
 
                else:
142
 
                    self.ghosts.append(rev_id)
143
 
 
144
 
        if rev.inventory_sha1:
145
 
            inv_sha1 = self.repository.get_inventory_sha1(rev_id)
146
 
            if inv_sha1 != rev.inventory_sha1:
147
 
                raise BzrCheckError('Inventory sha1 hash doesn\'t match'
148
 
                    ' value in revision {%s}' % rev_id)
149
 
        self._check_revision_tree(rev_id)
150
 
        self.checked_rev_cnt += 1
151
 
 
152
 
    def check_weaves(self):
153
 
        """Check all the weaves we can get our hands on.
154
 
        """
155
 
        n_weaves = 1
156
 
        weave_ids = []
157
 
        if self.repository.weave_store.listable():
158
 
            weave_ids = list(self.repository.weave_store)
159
 
            n_weaves = len(weave_ids)
160
 
        self.progress.update('checking weave', 0, n_weaves)
161
 
        self.inventory_weave.check(progress_bar=self.progress)
162
 
        for i, weave_id in enumerate(weave_ids):
163
 
            self.progress.update('checking weave', i, n_weaves)
164
 
            w = self.repository.weave_store.get_weave(weave_id,
165
 
                    self.repository.get_transaction())
166
 
            # No progress here, because it looks ugly.
167
 
            w.check()
168
 
            self.checked_weaves[weave_id] = True
169
 
 
170
 
    def _check_revision_tree(self, rev_id):
171
 
        tree = self.repository.revision_tree(rev_id)
172
 
        inv = tree.inventory
 
18
 
 
19
 
 
20
######################################################################
 
21
# consistency checks
 
22
 
 
23
import sys
 
24
 
 
25
from trace import mutter
 
26
from errors import bailout
 
27
import osutils
 
28
 
 
29
def check(branch, progress=True):
 
30
    out = sys.stdout
 
31
 
 
32
    # TODO: factor out
 
33
    if not (hasattr(out, 'isatty') and out.isatty()):
 
34
        progress=False
 
35
 
 
36
    if progress:
 
37
        def p(m):
 
38
            mutter('checking ' + m)
 
39
            out.write('\rchecking: %-50.50s' % m)
 
40
            out.flush()
 
41
    else:
 
42
        def p(m):
 
43
            mutter('checking ' + m)
 
44
 
 
45
    p('history of %r' % branch.base)
 
46
    last_ptr = None
 
47
    checked_revs = {}
 
48
    
 
49
    history = branch.revision_history()
 
50
    revno = 0
 
51
    revcount = len(history)
 
52
 
 
53
    checked_texts = {}
 
54
    
 
55
    for rid in history:
 
56
        revno += 1
 
57
        p('revision %d/%d' % (revno, revcount))
 
58
        mutter('    revision {%s}' % rid)
 
59
        rev = branch.get_revision(rid)
 
60
        if rev.revision_id != rid:
 
61
            bailout('wrong internal revision id in revision {%s}' % rid)
 
62
        if rev.precursor != last_ptr:
 
63
            bailout('mismatched precursor in revision {%s}' % rid)
 
64
        last_ptr = rid
 
65
        if rid in checked_revs:
 
66
            bailout('repeated revision {%s}' % rid)
 
67
        checked_revs[rid] = True
 
68
 
 
69
        ## TODO: Check all the required fields are present on the revision.
 
70
 
 
71
        inv = branch.get_inventory(rev.inventory_id)
173
72
        seen_ids = {}
 
73
        seen_names = {}
 
74
 
 
75
        p('revision %d/%d file ids' % (revno, revcount))
174
76
        for file_id in inv:
175
77
            if file_id in seen_ids:
176
 
                raise BzrCheckError('duplicated file_id {%s} '
177
 
                                    'in inventory for revision {%s}'
178
 
                                    % (file_id, rev_id))
 
78
                bailout('duplicated file_id {%s} in inventory for revision {%s}'
 
79
                        % (file_id, rid))
179
80
            seen_ids[file_id] = True
 
81
 
 
82
        i = 0
 
83
        len_inv = len(inv)
180
84
        for file_id in inv:
 
85
            i += 1
 
86
            if (i % 100) == 0:
 
87
                p('revision %d/%d file text %d/%d' % (revno, revcount, i, len_inv))
 
88
 
181
89
            ie = inv[file_id]
182
 
            ie.check(self, rev_id, inv, tree)
183
 
        seen_names = {}
 
90
 
 
91
            if ie.parent_id != None:
 
92
                if ie.parent_id not in seen_ids:
 
93
                    bailout('missing parent {%s} in inventory for revision {%s}'
 
94
                            % (ie.parent_id, rid))
 
95
 
 
96
            if ie.kind == 'file':
 
97
                if ie.text_id in checked_texts:
 
98
                    fp = checked_texts[ie.text_id]
 
99
                else:
 
100
                    if not ie.text_id in branch.text_store:
 
101
                        bailout('text {%s} not in text_store' % ie.text_id)
 
102
 
 
103
                    tf = branch.text_store[ie.text_id]
 
104
                    fp = osutils.fingerprint_file(tf)
 
105
                    checked_texts[ie.text_id] = fp
 
106
 
 
107
                if ie.text_size != fp['size']:
 
108
                    bailout('text {%s} wrong size' % ie.text_id)
 
109
                if ie.text_sha1 != fp['sha1']:
 
110
                    bailout('text {%s} wrong sha1' % ie.text_id)
 
111
            elif ie.kind == 'directory':
 
112
                if ie.text_sha1 != None or ie.text_size != None or ie.text_id != None:
 
113
                    bailout('directory {%s} has text in revision {%s}'
 
114
                            % (file_id, rid))
 
115
 
 
116
        p('revision %d/%d file paths' % (revno, revcount))
184
117
        for path, ie in inv.iter_entries():
185
118
            if path in seen_names:
186
 
                raise BzrCheckError('duplicated path %s '
187
 
                                    'in inventory for revision {%s}'
188
 
                                    % (path, rev_id))
 
119
                bailout('duplicated path %r in inventory for revision {%s}' % (path, revid))
189
120
            seen_names[path] = True
190
121
 
191
122
 
192
 
def check(branch, verbose):
193
 
    """Run consistency checks on a branch.
194
 
    
195
 
    Results are reported through logging.
196
 
    
197
 
    :raise BzrCheckError: if there's a consistency error.
198
 
    """
199
 
    branch.lock_read()
200
 
    try:
201
 
        branch_result = branch.check()
202
 
        repo_result = branch.repository.check([branch.last_revision()])
203
 
    finally:
204
 
        branch.unlock()
205
 
    branch_result.report_results(verbose)
206
 
    repo_result.report_results(verbose)
 
123
    p('done')
 
124
    if progress:
 
125
        print 
 
126
    print 'checked %d revisions, %d file texts' % (revcount, len(checked_texts))
 
127