← 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-21 08:57:13 UTC
  • Revision ID: mbp@sourcefrog.net-20050921085713-541dec922df6225d
- remove dead code from bzrlib.check

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
17
18
# TODO: Check ancestries are correct for every revision: includes
18
19
# every committed so far, and in a reasonable order.
19
20
 
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
21
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
173
 
        seen_ids = {}
174
 
        for file_id in inv:
175
 
            if file_id in seen_ids:
176
 
                raise BzrCheckError('duplicated file_id {%s} '
177
 
                                    'in inventory for revision {%s}'
178
 
                                    % (file_id, rev_id))
179
 
            seen_ids[file_id] = True
180
 
        for file_id in inv:
181
 
            ie = inv[file_id]
182
 
            ie.check(self, rev_id, inv, tree)
183
 
        seen_names = {}
184
 
        for path, ie in inv.iter_entries():
185
 
            if path in seen_names:
186
 
                raise BzrCheckError('duplicated path %s '
187
 
                                    'in inventory for revision {%s}'
188
 
                                    % (path, rev_id))
189
 
            seen_names[path] = True
190
 
 
191
 
 
192
 
def check(branch, verbose):
 
22
from bzrlib.trace import note, warning
 
23
from bzrlib.osutils import rename, sha_string, fingerprint_file
 
24
from bzrlib.trace import mutter
 
25
from bzrlib.errors import BzrCheckError, NoSuchRevision
 
26
from bzrlib.inventory import ROOT_ID
 
27
from bzrlib.branch import gen_root_id
 
28
 
 
29
 
 
30
def check(branch):
193
31
    """Run consistency checks on a branch.
194
 
    
195
 
    Results are reported through logging.
196
 
    
197
 
    :raise BzrCheckError: if there's a consistency error.
 
32
 
 
33
    TODO: Also check non-mainline revisions mentioned as parents.
 
34
 
 
35
    TODO: Check for extra files in the control directory.
198
36
    """
199
37
    branch.lock_read()
 
38
 
200
39
    try:
201
 
        branch_result = branch.check()
202
 
        repo_result = branch.repository.check([branch.last_revision()])
 
40
        last_rev_id = None
 
41
 
 
42
        missing_inventory_sha_cnt = 0
 
43
        missing_revision_sha_cnt = 0
 
44
        missing_revision_cnt = 0
 
45
 
 
46
        history = branch.revision_history()
 
47
        revno = 0
 
48
        revcount = len(history)
 
49
 
 
50
        checked_text_count = 0
 
51
 
 
52
        progress = bzrlib.ui.ui_factory.progress_bar()
 
53
 
 
54
        for rev_id in history:
 
55
            revno += 1
 
56
            progress.update('checking revision', revno, revcount)
 
57
            # mutter('    revision {%s}' % rev_id)
 
58
            rev = branch.get_revision(rev_id)
 
59
            if rev.revision_id != rev_id:
 
60
                raise BzrCheckError('wrong internal revision id in revision {%s}'
 
61
                                    % rev_id)
 
62
 
 
63
            # check the previous history entry is a parent of this entry
 
64
            if rev.parent_ids:
 
65
                if last_rev_id is None:
 
66
                    raise BzrCheckError("revision {%s} has %d parents, but is the "
 
67
                                        "start of the branch"
 
68
                                        % (rev_id, len(rev.parent_ids)))
 
69
                for parent_id in rev.parent_ids:
 
70
                    if parent_id == last_rev_id:
 
71
                        break
 
72
                else:
 
73
                    raise BzrCheckError("previous revision {%s} not listed among "
 
74
                                        "parents of {%s}"
 
75
                                        % (last_rev_id, rev_id))
 
76
            elif last_rev_id:
 
77
                raise BzrCheckError("revision {%s} has no parents listed "
 
78
                                    "but preceded by {%s}"
 
79
                                    % (rev_id, last_rev_id))
 
80
 
 
81
            ## TODO: Check all the required fields are present on the revision.
 
82
 
 
83
            if rev.inventory_sha1:
 
84
                inv_sha1 = branch.get_inventory_sha1(rev_id)
 
85
                if inv_sha1 != rev.inventory_sha1:
 
86
                    raise BzrCheckError('Inventory sha1 hash doesn\'t match'
 
87
                        ' value in revision {%s}' % rev_id)
 
88
            else:
 
89
                missing_inventory_sha_cnt += 1
 
90
                mutter("no inventory_sha1 on revision {%s}" % rev_id)
 
91
 
 
92
            tree = branch.revision_tree(rev_id)
 
93
            inv = tree.inventory
 
94
            seen_ids = {}
 
95
            seen_names = {}
 
96
 
 
97
            ## p('revision %d/%d file ids' % (revno, revcount))
 
98
            for file_id in inv:
 
99
                if file_id in seen_ids:
 
100
                    raise BzrCheckError('duplicated file_id {%s} '
 
101
                                        'in inventory for revision {%s}'
 
102
                                        % (file_id, rev_id))
 
103
                seen_ids[file_id] = True
 
104
 
 
105
            i = 0
 
106
            for file_id in inv:
 
107
                i += 1
 
108
                if i & 31 == 0:
 
109
                    progress.tick()
 
110
 
 
111
                ie = inv[file_id]
 
112
 
 
113
                if ie.parent_id != None:
 
114
                    if ie.parent_id not in seen_ids:
 
115
                        raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
 
116
                                % (ie.parent_id, rev_id))
 
117
 
 
118
                if ie.kind == 'file':
 
119
                    text = tree.get_file_text(file_id)
 
120
                    checked_text_count += 1 
 
121
                    if ie.text_size != len(text):
 
122
                        raise BzrCheckError('text {%s} wrong size' % ie.text_id)
 
123
                    if ie.text_sha1 != sha_string(text):
 
124
                        raise BzrCheckError('text {%s} wrong sha1' % ie.text_id)
 
125
                elif ie.kind == 'directory':
 
126
                    if ie.text_sha1 != None or ie.text_size != None or ie.text_id != None:
 
127
                        raise BzrCheckError('directory {%s} has text in revision {%s}'
 
128
                                % (file_id, rev_id))
 
129
 
 
130
            progress.tick()
 
131
            for path, ie in inv.iter_entries():
 
132
                if path in seen_names:
 
133
                    raise BzrCheckError('duplicated path %s '
 
134
                                        'in inventory for revision {%s}'
 
135
                                        % (path, rev_id))
 
136
                seen_names[path] = True
 
137
            last_rev_id = rev_id
 
138
 
203
139
    finally:
204
140
        branch.unlock()
205
 
    branch_result.report_results(verbose)
206
 
    repo_result.report_results(verbose)
 
141
 
 
142
    progress.clear()
 
143
 
 
144
    note('checked %d revisions, %d file texts' % (revcount, checked_text_count))
 
145
    
 
146
    if missing_inventory_sha_cnt:
 
147
        note('%d revisions are missing inventory_sha1' % missing_inventory_sha_cnt)
 
148
 
 
149
    ##if missing_revision_sha_cnt:
 
150
    ##    note('%d parent links are missing revision_sha1' % missing_revision_sha_cnt)
 
151
 
 
152
    if missing_revision_cnt:
 
153
        note('%d revisions are mentioned but not present' % missing_revision_cnt)
 
154
 
 
155
    if missing_revision_cnt:
 
156
        print '%d revisions are mentioned but not present' % missing_revision_cnt
 
157
 
 
158
    # stub this out for now because the main bzr branch has references
 
159
    # to revisions that aren't present in the store -- mbp 20050804
 
160
#    if (missing_inventory_sha_cnt
 
161
#        or missing_revision_sha_cnt):
 
162
#        print '  (use "bzr upgrade" to fix them)'