← 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-09-30 05:56:05 UTC
  • mto: (1185.14.2)
  • mto: This revision was merged to the branch mainline in revision 1396.
  • Revision ID: mbp@sourcefrog.net-20050930055605-a2c534529b392a7d
- fix upgrade for transport changes

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
24
25
# TODO: Check revision, inventory and entry objects have all 
25
26
# required fields.
26
27
 
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
 
28
 
36
29
import bzrlib.ui
37
 
from bzrlib.trace import note
 
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
 
38
37
 
39
38
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
 
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
 
46
57
        self.checked_text_cnt = 0
47
58
        self.checked_rev_cnt = 0
48
 
        self.ghosts = []
49
59
        self.repeated_text_cnt = 0
50
 
        self.missing_parent_links = {}
51
60
        self.missing_inventory_sha_cnt = 0
52
61
        self.missing_revision_cnt = 0
53
 
        # maps (file-id, version) -> sha1; used by InventoryFile._check
 
62
        # maps (file-id, version) -> sha1
54
63
        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())
 
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
81
76
        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)
 
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
 
93
85
        note('%6d revisions', self.checked_rev_cnt)
94
86
        note('%6d unique file texts', self.checked_text_cnt)
95
87
        note('%6d repeated file texts', self.repeated_text_cnt)
96
 
        note('%6d weaves', len(self.checked_weaves))
97
88
        if self.missing_inventory_sha_cnt:
98
 
            note('%6d revisions are missing inventory_sha1',
 
89
            note('%d revisions are missing inventory_sha1',
99
90
                 self.missing_inventory_sha_cnt)
100
91
        if self.missing_revision_cnt:
101
 
            note('%6d revisions are mentioned but not present',
 
92
            note('%d revisions are mentioned but not present',
102
93
                 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):
 
94
 
 
95
 
 
96
    def check_one_rev(self, rev_id, last_rev_id):
118
97
        """Check one revision.
119
98
 
120
99
        rev_id - the one to check
 
100
 
 
101
        last_rev_id - the previous one on the mainline, if any.
121
102
        """
122
 
        rev = self.repository.get_revision(rev_id)
123
 
                
 
103
 
 
104
        # mutter('    revision {%s}' % rev_id)
 
105
        branch = self.branch
 
106
        rev = branch.get_revision(rev_id)
124
107
        if rev.revision_id != rev_id:
125
108
            raise BzrCheckError('wrong internal revision id in revision {%s}'
126
109
                                % rev_id)
127
110
 
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)
 
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))
143
128
 
144
129
        if rev.inventory_sha1:
145
 
            inv_sha1 = self.repository.get_inventory_sha1(rev_id)
 
130
            inv_sha1 = branch.get_inventory_sha1(rev_id)
146
131
            if inv_sha1 != rev.inventory_sha1:
147
132
                raise BzrCheckError('Inventory sha1 hash doesn\'t match'
148
133
                    ' value in revision {%s}' % rev_id)
 
134
        else:
 
135
            missing_inventory_sha_cnt += 1
 
136
            mutter("no inventory_sha1 on revision {%s}" % rev_id)
149
137
        self._check_revision_tree(rev_id)
150
138
        self.checked_rev_cnt += 1
151
139
 
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
140
    def _check_revision_tree(self, rev_id):
171
 
        tree = self.repository.revision_tree(rev_id)
 
141
        tree = self.branch.revision_tree(rev_id)
172
142
        inv = tree.inventory
173
143
        seen_ids = {}
174
144
        for file_id in inv:
178
148
                                    % (file_id, rev_id))
179
149
            seen_ids[file_id] = True
180
150
        for file_id in inv:
181
 
            ie = inv[file_id]
182
 
            ie.check(self, rev_id, inv, tree)
 
151
            self._check_one_entry(rev_id, inv, tree, file_id)
183
152
        seen_names = {}
184
153
        for path, ie in inv.iter_entries():
185
154
            if path in seen_names:
188
157
                                    % (path, rev_id))
189
158
            seen_names[path] = True
190
159
 
191
 
 
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)
 
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)