~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/check.py

  • Committer: Martin Pool
  • Date: 2008-01-16 01:30:17 UTC
  • mto: (3280.2.2 prepare-1.3)
  • mto: This revision was merged to the branch mainline in revision 3284.
  • Revision ID: mbp@sourcefrog.net-20080116013017-7js5xni7kc3wf1qu
Fix ReST indents in README

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004, 2005 by Martin Pool
2
 
# Copyright (C) 2005 by Canonical Ltd
3
 
 
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
6
5
# the Free Software Foundation; either version 2 of the License, or
7
6
# (at your option) any later version.
8
 
 
 
7
#
9
8
# This program is distributed in the hope that it will be useful,
10
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
11
# GNU General Public License for more details.
13
 
 
 
12
#
14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
25
24
# TODO: Check revision, inventory and entry objects have all 
26
25
# required fields.
27
26
 
28
 
 
 
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 import errors
 
36
from bzrlib import repository as _mod_repository
 
37
from bzrlib import revision
 
38
from bzrlib.errors import BzrCheckError
29
39
import bzrlib.ui
30
 
from bzrlib.trace import note, warning
31
 
from bzrlib.osutils import rename, sha_string, fingerprint_file, sha_strings
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
 
 
 
40
from bzrlib.trace import log_error, note
37
41
 
38
42
class Check(object):
39
 
    """Check a branch"""
40
 
    def __init__(self, branch):
41
 
        self.branch = branch
42
 
        branch.lock_read()
43
 
        try:
44
 
            branch.weave_store.enable_cache = True
45
 
            branch.control_weaves.enable_cache = True
46
 
            self.run()
47
 
        finally:
48
 
            branch.unlock()
49
 
            branch.weave_store.enable_cache = False
50
 
            branch.control_weaves.enable_cache = False
51
 
 
52
 
 
53
 
    def run(self):
54
 
        branch = self.branch
55
 
 
56
 
 
 
43
    """Check a repository"""
 
44
 
 
45
    # The Check object interacts with InventoryEntry.check, etc.
 
46
 
 
47
    def __init__(self, repository):
 
48
        self.repository = repository
57
49
        self.checked_text_cnt = 0
58
50
        self.checked_rev_cnt = 0
 
51
        self.ghosts = []
59
52
        self.repeated_text_cnt = 0
 
53
        self.missing_parent_links = {}
60
54
        self.missing_inventory_sha_cnt = 0
61
55
        self.missing_revision_cnt = 0
62
 
        # maps (file-id, version) -> sha1
 
56
        # maps (file-id, version) -> sha1; used by InventoryFile._check
63
57
        self.checked_texts = {}
64
 
 
65
 
        history = branch.revision_history()
66
 
        revno = 0
67
 
        revcount = len(history)
68
 
 
69
 
        last_rev_id = None
70
 
        self.progress = bzrlib.ui.ui_factory.progress_bar()
71
 
        for rev_id in history:
72
 
            self.progress.update('checking revision', revno, revcount)
73
 
            revno += 1
74
 
            self.check_one_rev(rev_id, last_rev_id)
75
 
            last_rev_id = rev_id
 
58
        self.checked_weaves = {}
 
59
        self.unreferenced_versions = set()
 
60
        self.inconsistent_parents = []
 
61
 
 
62
    def check(self):
 
63
        self.repository.lock_read()
 
64
        self.progress = bzrlib.ui.ui_factory.nested_progress_bar()
 
65
        try:
 
66
            self.progress.update('retrieving inventory', 0, 2)
 
67
            # do not put in init, as it should be done with progess,
 
68
            # and inside the lock.
 
69
            self.inventory_weave = self.repository.get_inventory_weave()
 
70
            self.progress.update('checking revision graph', 1)
 
71
            self.check_revision_graph()
 
72
            self.plan_revisions()
 
73
            revno = 0
 
74
            while revno < len(self.planned_revisions):
 
75
                rev_id = self.planned_revisions[revno]
 
76
                self.progress.update('checking revision', revno,
 
77
                                     len(self.planned_revisions))
 
78
                revno += 1
 
79
                self.check_one_rev(rev_id)
 
80
            # check_weaves is done after the revision scan so that
 
81
            # revision index is known to be valid.
 
82
            self.check_weaves()
 
83
        finally:
 
84
            self.progress.finished()
 
85
            self.repository.unlock()
 
86
 
 
87
    def check_revision_graph(self):
 
88
        if not self.repository.revision_graph_can_have_wrong_parents():
 
89
            # This check is not necessary.
 
90
            self.revs_with_bad_parents_in_index = None
 
91
            return
 
92
        bad_revisions = self.repository._find_inconsistent_revision_parents()
 
93
        self.revs_with_bad_parents_in_index = list(bad_revisions)
 
94
 
 
95
    def plan_revisions(self):
 
96
        repository = self.repository
 
97
        self.planned_revisions = repository.all_revision_ids()
76
98
        self.progress.clear()
77
 
        self.report_results()
78
 
 
79
 
 
80
 
    def report_results(self):
81
 
        note('checked branch %s format %d',
82
 
             self.branch.base, 
83
 
             self.branch._branch_format)
84
 
 
 
99
        inventoried = set(self.inventory_weave.versions())
 
100
        awol = set(self.planned_revisions) - inventoried
 
101
        if len(awol) > 0:
 
102
            raise BzrCheckError('Stored revisions missing from inventory'
 
103
                '{%s}' % ','.join([f for f in awol]))
 
104
 
 
105
    def report_results(self, verbose):
 
106
        note('checked repository %s format %s',
 
107
             self.repository.bzrdir.root_transport,
 
108
             self.repository._format)
85
109
        note('%6d revisions', self.checked_rev_cnt)
 
110
        note('%6d file-ids', len(self.checked_weaves))
86
111
        note('%6d unique file texts', self.checked_text_cnt)
87
112
        note('%6d repeated file texts', self.repeated_text_cnt)
 
113
        note('%6d unreferenced text versions',
 
114
             len(self.unreferenced_versions))
88
115
        if self.missing_inventory_sha_cnt:
89
 
            note('%d revisions are missing inventory_sha1',
 
116
            note('%6d revisions are missing inventory_sha1',
90
117
                 self.missing_inventory_sha_cnt)
91
118
        if self.missing_revision_cnt:
92
 
            note('%d revisions are mentioned but not present',
 
119
            note('%6d revisions are mentioned but not present',
93
120
                 self.missing_revision_cnt)
94
 
 
95
 
 
96
 
    def check_one_rev(self, rev_id, last_rev_id):
 
121
        if len(self.ghosts):
 
122
            note('%6d ghost revisions', len(self.ghosts))
 
123
            if verbose:
 
124
                for ghost in self.ghosts:
 
125
                    note('      %s', ghost)
 
126
        if len(self.missing_parent_links):
 
127
            note('%6d revisions missing parents in ancestry',
 
128
                 len(self.missing_parent_links))
 
129
            if verbose:
 
130
                for link, linkers in self.missing_parent_links.items():
 
131
                    note('      %s should be in the ancestry for:', link)
 
132
                    for linker in linkers:
 
133
                        note('       * %s', linker)
 
134
            if verbose:
 
135
                for file_id, revision_id in self.unreferenced_versions:
 
136
                    log_error('unreferenced version: {%s} in %s', revision_id,
 
137
                        file_id)
 
138
        if len(self.inconsistent_parents):
 
139
            note('%6d inconsistent parents', len(self.inconsistent_parents))
 
140
            if verbose:
 
141
                for info in self.inconsistent_parents:
 
142
                    revision_id, file_id, found_parents, correct_parents = info
 
143
                    note('      * %s version %s has parents %r '
 
144
                         'but should have %r'
 
145
                         % (file_id, revision_id, found_parents,
 
146
                             correct_parents))
 
147
        if self.revs_with_bad_parents_in_index:
 
148
            note('%6d revisions have incorrect parents in the revision index',
 
149
                 len(self.revs_with_bad_parents_in_index))
 
150
            if verbose:
 
151
                for item in self.revs_with_bad_parents_in_index:
 
152
                    revision_id, index_parents, actual_parents = item
 
153
                    note(
 
154
                        '       %s has wrong parents in index: '
 
155
                        '%r should be %r',
 
156
                        revision_id, index_parents, actual_parents)
 
157
 
 
158
    def check_one_rev(self, rev_id):
97
159
        """Check one revision.
98
160
 
99
161
        rev_id - the one to check
100
 
 
101
 
        last_rev_id - the previous one on the mainline, if any.
102
162
        """
103
 
 
104
 
        # mutter('    revision {%s}' % rev_id)
105
 
        branch = self.branch
106
 
        rev = branch.get_revision(rev_id)
 
163
        rev = self.repository.get_revision(rev_id)
 
164
                
107
165
        if rev.revision_id != rev_id:
108
166
            raise BzrCheckError('wrong internal revision id in revision {%s}'
109
167
                                % rev_id)
110
168
 
111
 
        # check the previous history entry is a parent of this entry
112
 
        if rev.parent_ids:
113
 
            if last_rev_id is None:
114
 
                raise BzrCheckError("revision {%s} has %d parents, but is the "
115
 
                                    "start of the branch"
116
 
                                    % (rev_id, len(rev.parent_ids)))
117
 
            for parent_id in rev.parent_ids:
118
 
                if parent_id == last_rev_id:
119
 
                    break
120
 
            else:
121
 
                raise BzrCheckError("previous revision {%s} not listed among "
122
 
                                    "parents of {%s}"
123
 
                                    % (last_rev_id, rev_id))
124
 
        elif last_rev_id:
125
 
            raise BzrCheckError("revision {%s} has no parents listed "
126
 
                                "but preceded by {%s}"
127
 
                                % (rev_id, last_rev_id))
 
169
        for parent in rev.parent_ids:
 
170
            if not parent in self.planned_revisions:
 
171
                missing_links = self.missing_parent_links.get(parent, [])
 
172
                missing_links.append(rev_id)
 
173
                self.missing_parent_links[parent] = missing_links
 
174
                # list based so somewhat slow,
 
175
                # TODO have a planned_revisions list and set.
 
176
                if self.repository.has_revision(parent):
 
177
                    missing_ancestry = self.repository.get_ancestry(parent)
 
178
                    for missing in missing_ancestry:
 
179
                        if (missing is not None 
 
180
                            and missing not in self.planned_revisions):
 
181
                            self.planned_revisions.append(missing)
 
182
                else:
 
183
                    self.ghosts.append(rev_id)
128
184
 
129
185
        if rev.inventory_sha1:
130
 
            inv_sha1 = branch.get_inventory_sha1(rev_id)
 
186
            inv_sha1 = self.repository.get_inventory_sha1(rev_id)
131
187
            if inv_sha1 != rev.inventory_sha1:
132
188
                raise BzrCheckError('Inventory sha1 hash doesn\'t match'
133
189
                    ' value in revision {%s}' % rev_id)
134
 
        else:
135
 
            missing_inventory_sha_cnt += 1
136
 
            mutter("no inventory_sha1 on revision {%s}" % rev_id)
137
190
        self._check_revision_tree(rev_id)
138
191
        self.checked_rev_cnt += 1
139
192
 
 
193
    def check_weaves(self):
 
194
        """Check all the weaves we can get our hands on.
 
195
        """
 
196
        n_weaves = 1
 
197
        weave_ids = []
 
198
        if self.repository.weave_store.listable():
 
199
            weave_ids = list(self.repository.weave_store)
 
200
            n_weaves = len(weave_ids) + 1
 
201
        self.progress.update('checking versionedfile', 0, n_weaves)
 
202
        self.inventory_weave.check(progress_bar=self.progress)
 
203
        files_in_revisions = {}
 
204
        revisions_of_files = {}
 
205
        weave_checker = self.repository._get_versioned_file_checker()
 
206
        for i, weave_id in enumerate(weave_ids):
 
207
            self.progress.update('checking versionedfile', i, n_weaves)
 
208
            w = self.repository.weave_store.get_weave(weave_id,
 
209
                    self.repository.get_transaction())
 
210
            # No progress here, because it looks ugly.
 
211
            w.check()
 
212
            result = weave_checker.check_file_version_parents(w, weave_id)
 
213
            bad_parents, unused_versions = result
 
214
            bad_parents = bad_parents.items()
 
215
            for revision_id, (weave_parents, correct_parents) in bad_parents:
 
216
                self.inconsistent_parents.append(
 
217
                    (revision_id, weave_id, weave_parents, correct_parents))
 
218
            for revision_id in unused_versions:
 
219
                self.unreferenced_versions.add((weave_id, revision_id))
 
220
            self.checked_weaves[weave_id] = True
 
221
 
140
222
    def _check_revision_tree(self, rev_id):
141
 
        tree = self.branch.revision_tree(rev_id)
 
223
        tree = self.repository.revision_tree(rev_id)
142
224
        inv = tree.inventory
143
225
        seen_ids = {}
144
226
        for file_id in inv:
148
230
                                    % (file_id, rev_id))
149
231
            seen_ids[file_id] = True
150
232
        for file_id in inv:
151
 
            self._check_one_entry(rev_id, inv, tree, file_id)
 
233
            ie = inv[file_id]
 
234
            ie.check(self, rev_id, inv, tree)
152
235
        seen_names = {}
153
236
        for path, ie in inv.iter_entries():
154
237
            if path in seen_names:
157
240
                                    % (path, rev_id))
158
241
            seen_names[path] = True
159
242
 
160
 
        
161
 
    def _check_one_entry(self, rev_id, inv, tree, file_id):
162
 
        ie = inv[file_id]
163
 
        if ie.parent_id != None:
164
 
            if not inv.has_id(ie.parent_id):
165
 
                raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
166
 
                        % (ie.parent_id, rev_id))
167
 
        if ie.kind == 'file':
168
 
            text_version = ie.text_version
169
 
            t = (file_id, text_version)
170
 
            if t in self.checked_texts:
171
 
                prev_sha = self.checked_texts[t] 
172
 
                if prev_sha != ie.text_sha1:
173
 
                    raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
174
 
                                        (file_id, rev_id))
175
 
                else:
176
 
                    self.repeated_text_cnt += 1
177
 
                    return
178
 
            mutter('check version {%s} of {%s}', rev_id, file_id)
179
 
            file_lines = tree.get_file_lines(file_id)
180
 
            self.checked_text_cnt += 1 
181
 
            if ie.text_size != sum(map(len, file_lines)):
182
 
                raise BzrCheckError('text {%s} wrong size' % ie.text_id)
183
 
            if ie.text_sha1 != sha_strings(file_lines):
184
 
                raise BzrCheckError('text {%s} wrong sha1' % ie.text_id)
185
 
            self.checked_texts[t] = ie.text_sha1
186
 
        elif ie.kind == 'directory':
187
 
            if ie.text_sha1 != None or ie.text_size != None or ie.text_id != None:
188
 
                raise BzrCheckError('directory {%s} has text in revision {%s}'
189
 
                        % (file_id, rev_id))
190
 
        elif ie.kind == 'root_directory':
191
 
            pass
192
 
        else:
193
 
            raise BzrCheckError('unknown entry kind %r in revision {%s}' % 
194
 
                                (ie.kind, rev_id))
195
 
 
196
 
 
197
 
def check(branch):
198
 
    """Run consistency checks on a branch."""
199
 
    Check(branch)
 
243
 
 
244
def check(branch, verbose):
 
245
    """Run consistency checks on a branch.
 
246
    
 
247
    Results are reported through logging.
 
248
    
 
249
    :raise BzrCheckError: if there's a consistency error.
 
250
    """
 
251
    branch.lock_read()
 
252
    try:
 
253
        branch_result = branch.check()
 
254
        repo_result = branch.repository.check([branch.last_revision()])
 
255
    finally:
 
256
        branch.unlock()
 
257
    branch_result.report_results(verbose)
 
258
    repo_result.report_results(verbose)
 
259
 
 
260
 
 
261