← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/check.py

  • Committer: Martin Pool
  • Date: 2005-11-04 01:46:31 UTC
  • mto: (1185.33.49 bzr.dev)
  • mto: This revision was merged to the branch mainline in revision 1512.
  • Revision ID: mbp@sourcefrog.net-20051104014631-750e0ad4172c952c
Make biobench directly executable

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/check.py
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
27
28
# TODO: Get every revision in the revision-store even if they're not
28
29
# referenced by history and make sure they're all valid.
29
30
 
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
39
31
import bzrlib.ui
40
 
from bzrlib.trace import log_error, note
 
32
from bzrlib.trace import note, warning
 
33
from bzrlib.osutils import rename, sha_string, fingerprint_file
 
34
from bzrlib.trace import mutter
 
35
from bzrlib.errors import BzrCheckError, NoSuchRevision
 
36
from bzrlib.inventory import ROOT_ID
 
37
from bzrlib.branch import gen_root_id
 
38
 
41
39
 
42
40
class Check(object):
43
 
    """Check a repository"""
44
 
 
45
 
    # The Check object interacts with InventoryEntry.check, etc.
46
 
 
47
 
    def __init__(self, repository):
48
 
        self.repository = repository
 
41
    """Check a branch"""
 
42
 
 
43
    def __init__(self, branch):
 
44
        self.branch = branch
49
45
        self.checked_text_cnt = 0
50
46
        self.checked_rev_cnt = 0
51
47
        self.ghosts = []
53
49
        self.missing_parent_links = {}
54
50
        self.missing_inventory_sha_cnt = 0
55
51
        self.missing_revision_cnt = 0
56
 
        # maps (file-id, version) -> sha1; used by InventoryFile._check
 
52
        # maps (file-id, version) -> sha1
57
53
        self.checked_texts = {}
58
 
        self.checked_weaves = {}
59
 
        self.unreferenced_versions = set()
60
 
        self.inconsistent_parents = []
61
54
 
62
55
    def check(self):
63
 
        self.repository.lock_read()
64
 
        self.progress = bzrlib.ui.ui_factory.nested_progress_bar()
 
56
        self.branch.lock_read()
65
57
        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()
 
58
            self.history = self.branch.revision_history()
 
59
            if not len(self.history):
 
60
                # nothing to see here
 
61
                return
 
62
            self.planned_revisions = self.branch.get_ancestry(self.history[-1])
 
63
            self.planned_revisions.remove(None)
73
64
            revno = 0
 
65
    
 
66
            self.progress = bzrlib.ui.ui_factory.progress_bar()
74
67
            while revno < len(self.planned_revisions):
75
68
                rev_id = self.planned_revisions[revno]
76
69
                self.progress.update('checking revision', revno,
77
70
                                     len(self.planned_revisions))
78
71
                revno += 1
79
72
                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()
 
73
            self.progress.clear()
83
74
        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()
98
 
        self.progress.clear()
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]))
 
75
            self.branch.unlock()
104
76
 
105
77
    def report_results(self, verbose):
106
 
        note('checked repository %s format %s',
107
 
             self.repository.bzrdir.root_transport,
108
 
             self.repository._format)
 
78
        note('checked branch %s format %d',
 
79
             self.branch.base, 
 
80
             self.branch._branch_format)
 
81
 
109
82
        note('%6d revisions', self.checked_rev_cnt)
110
 
        note('%6d file-ids', len(self.checked_weaves))
111
83
        note('%6d unique file texts', self.checked_text_cnt)
112
84
        note('%6d repeated file texts', self.repeated_text_cnt)
113
 
        note('%6d unreferenced text versions',
114
 
             len(self.unreferenced_versions))
115
85
        if self.missing_inventory_sha_cnt:
116
86
            note('%6d revisions are missing inventory_sha1',
117
87
                 self.missing_inventory_sha_cnt)
124
94
                for ghost in self.ghosts:
125
95
                    note('      %s', ghost)
126
96
        if len(self.missing_parent_links):
127
 
            note('%6d revisions missing parents in ancestry',
 
97
            note('%6d revisions missing parents in ancestry', 
128
98
                 len(self.missing_parent_links))
129
99
            if verbose:
130
100
                for link, linkers in self.missing_parent_links.items():
131
101
                    note('      %s should be in the ancestry for:', link)
132
102
                    for linker in linkers:
133
103
                        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
104
 
158
105
    def check_one_rev(self, rev_id):
159
106
        """Check one revision.
160
107
 
161
108
        rev_id - the one to check
 
109
 
 
110
        last_rev_id - the previous one on the mainline, if any.
162
111
        """
163
 
        rev = self.repository.get_revision(rev_id)
 
112
 
 
113
        # mutter('    revision {%s}' % rev_id)
 
114
        branch = self.branch
 
115
        try:
 
116
            rev_history_position = self.history.index(rev_id)
 
117
        except ValueError:
 
118
            rev_history_position = None
 
119
        last_rev_id = None
 
120
        if rev_history_position:
 
121
            rev = branch.get_revision(rev_id)
 
122
            if rev_history_position > 0:
 
123
                last_rev_id = self.history[rev_history_position - 1]
 
124
        else:
 
125
            rev = branch.get_revision(rev_id)
164
126
                
165
127
        if rev.revision_id != rev_id:
166
128
            raise BzrCheckError('wrong internal revision id in revision {%s}'
167
129
                                % rev_id)
168
130
 
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)
 
131
        # check the previous history entry is a parent of this entry
 
132
        if rev.parent_ids:
 
133
            if last_rev_id is not None:
 
134
                for parent_id in rev.parent_ids:
 
135
                    if parent_id == last_rev_id:
 
136
                        break
182
137
                else:
183
 
                    self.ghosts.append(rev_id)
 
138
                    raise BzrCheckError("previous revision {%s} not listed among "
 
139
                                        "parents of {%s}"
 
140
                                        % (last_rev_id, rev_id))
 
141
            for parent in rev.parent_ids:
 
142
                if not parent in self.planned_revisions:
 
143
                    missing_links = self.missing_parent_links.get(parent, [])
 
144
                    missing_links.append(rev_id)
 
145
                    self.missing_parent_links[parent] = missing_links
 
146
                    # list based so slow, TODO have a planned_revisions list and set.
 
147
                    if self.branch.has_revision(parent):
 
148
                        missing_ancestry = self.branch.get_ancestry(parent)
 
149
                        for missing in missing_ancestry:
 
150
                            if (missing is not None 
 
151
                                and missing not in self.planned_revisions):
 
152
                                self.planned_revisions.append(missing)
 
153
                    else:
 
154
                        self.ghosts.append(rev_id)
 
155
        elif last_rev_id:
 
156
            raise BzrCheckError("revision {%s} has no parents listed "
 
157
                                "but preceded by {%s}"
 
158
                                % (rev_id, last_rev_id))
184
159
 
185
160
        if rev.inventory_sha1:
186
 
            inv_sha1 = self.repository.get_inventory_sha1(rev_id)
 
161
            inv_sha1 = branch.get_inventory_sha1(rev_id)
187
162
            if inv_sha1 != rev.inventory_sha1:
188
163
                raise BzrCheckError('Inventory sha1 hash doesn\'t match'
189
164
                    ' value in revision {%s}' % rev_id)
 
165
        else:
 
166
            missing_inventory_sha_cnt += 1
 
167
            mutter("no inventory_sha1 on revision {%s}" % rev_id)
190
168
        self._check_revision_tree(rev_id)
191
169
        self.checked_rev_cnt += 1
192
170
 
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
 
 
222
171
    def _check_revision_tree(self, rev_id):
223
 
        tree = self.repository.revision_tree(rev_id)
 
172
        tree = self.branch.revision_tree(rev_id)
224
173
        inv = tree.inventory
225
174
        seen_ids = {}
226
175
        for file_id in inv:
242
191
 
243
192
 
244
193
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
 
 
 
194
    """Run consistency checks on a branch."""
 
195
    checker = Check(branch)
 
196
    checker.check()
 
197
    checker.report_results(verbose)