/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/check.py

  • Committer: Martin Pool
  • Date: 2009-03-12 05:32:56 UTC
  • mfrom: (4124 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4140.
  • Revision ID: mbp@sourcefrog.net-20090312053256-071khr6k4wwuuyja
merge news

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/check.py
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
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 import errors, osutils
 
36
from bzrlib import repository as _mod_repository
 
37
from bzrlib import revision
 
38
from bzrlib.branch import Branch
 
39
from bzrlib.bzrdir import BzrDir
 
40
from bzrlib.errors import BzrCheckError
 
41
from bzrlib.repository import Repository
 
42
from bzrlib.symbol_versioning import deprecated_function, deprecated_in
 
43
from bzrlib.trace import log_error, note
 
44
import bzrlib.ui
 
45
from bzrlib.workingtree import WorkingTree
 
46
 
 
47
class Check(object):
 
48
    """Check a repository"""
 
49
 
 
50
    # The Check object interacts with InventoryEntry.check, etc.
 
51
 
 
52
    def __init__(self, repository):
 
53
        self.repository = repository
 
54
        self.checked_text_cnt = 0
 
55
        self.checked_rev_cnt = 0
 
56
        self.ghosts = []
 
57
        self.repeated_text_cnt = 0
 
58
        self.missing_parent_links = {}
 
59
        self.missing_inventory_sha_cnt = 0
 
60
        self.missing_revision_cnt = 0
 
61
        # maps (file-id, version) -> sha1; used by InventoryFile._check
 
62
        self.checked_texts = {}
 
63
        self.checked_weaves = set()
 
64
        self.unreferenced_versions = set()
 
65
        self.inconsistent_parents = []
 
66
 
 
67
    def check(self):
 
68
        self.repository.lock_read()
 
69
        self.progress = bzrlib.ui.ui_factory.nested_progress_bar()
 
70
        try:
 
71
            self.progress.update('retrieving inventory', 0, 2)
 
72
            # do not put in init, as it should be done with progess,
 
73
            # and inside the lock.
 
74
            self.inventory_weave = self.repository.inventories
 
75
            self.progress.update('checking revision graph', 1)
 
76
            self.check_revision_graph()
 
77
            self.plan_revisions()
 
78
            revno = 0
 
79
            while revno < len(self.planned_revisions):
 
80
                rev_id = self.planned_revisions[revno]
 
81
                self.progress.update('checking revision', revno,
 
82
                                     len(self.planned_revisions))
 
83
                revno += 1
 
84
                self.check_one_rev(rev_id)
 
85
            # check_weaves is done after the revision scan so that
 
86
            # revision index is known to be valid.
 
87
            self.check_weaves()
 
88
        finally:
 
89
            self.progress.finished()
 
90
            self.repository.unlock()
 
91
 
 
92
    def check_revision_graph(self):
 
93
        if not self.repository.revision_graph_can_have_wrong_parents():
 
94
            # This check is not necessary.
 
95
            self.revs_with_bad_parents_in_index = None
 
96
            return
 
97
        bad_revisions = self.repository._find_inconsistent_revision_parents()
 
98
        self.revs_with_bad_parents_in_index = list(bad_revisions)
 
99
 
 
100
    def plan_revisions(self):
 
101
        repository = self.repository
 
102
        self.planned_revisions = repository.all_revision_ids()
 
103
        self.progress.clear()
 
104
        inventoried = set(key[-1] for key in self.inventory_weave.keys())
 
105
        awol = set(self.planned_revisions) - inventoried
 
106
        if len(awol) > 0:
 
107
            raise BzrCheckError('Stored revisions missing from inventory'
 
108
                '{%s}' % ','.join([f for f in awol]))
 
109
 
 
110
    def report_results(self, verbose):
 
111
        note('checked repository %s format %s',
 
112
             self.repository.bzrdir.root_transport,
 
113
             self.repository._format)
 
114
        note('%6d revisions', self.checked_rev_cnt)
 
115
        note('%6d file-ids', len(self.checked_weaves))
 
116
        note('%6d unique file texts', self.checked_text_cnt)
 
117
        note('%6d repeated file texts', self.repeated_text_cnt)
 
118
        note('%6d unreferenced text versions',
 
119
             len(self.unreferenced_versions))
 
120
        if self.missing_inventory_sha_cnt:
 
121
            note('%6d revisions are missing inventory_sha1',
 
122
                 self.missing_inventory_sha_cnt)
 
123
        if self.missing_revision_cnt:
 
124
            note('%6d revisions are mentioned but not present',
 
125
                 self.missing_revision_cnt)
 
126
        if len(self.ghosts):
 
127
            note('%6d ghost revisions', len(self.ghosts))
 
128
            if verbose:
 
129
                for ghost in self.ghosts:
 
130
                    note('      %s', ghost)
 
131
        if len(self.missing_parent_links):
 
132
            note('%6d revisions missing parents in ancestry',
 
133
                 len(self.missing_parent_links))
 
134
            if verbose:
 
135
                for link, linkers in self.missing_parent_links.items():
 
136
                    note('      %s should be in the ancestry for:', link)
 
137
                    for linker in linkers:
 
138
                        note('       * %s', linker)
 
139
            if verbose:
 
140
                for file_id, revision_id in self.unreferenced_versions:
 
141
                    log_error('unreferenced version: {%s} in %s', revision_id,
 
142
                        file_id)
 
143
        if len(self.inconsistent_parents):
 
144
            note('%6d inconsistent parents', len(self.inconsistent_parents))
 
145
            if verbose:
 
146
                for info in self.inconsistent_parents:
 
147
                    revision_id, file_id, found_parents, correct_parents = info
 
148
                    note('      * %s version %s has parents %r '
 
149
                         'but should have %r'
 
150
                         % (file_id, revision_id, found_parents,
 
151
                             correct_parents))
 
152
        if self.revs_with_bad_parents_in_index:
 
153
            note('%6d revisions have incorrect parents in the revision index',
 
154
                 len(self.revs_with_bad_parents_in_index))
 
155
            if verbose:
 
156
                for item in self.revs_with_bad_parents_in_index:
 
157
                    revision_id, index_parents, actual_parents = item
 
158
                    note(
 
159
                        '       %s has wrong parents in index: '
 
160
                        '%r should be %r',
 
161
                        revision_id, index_parents, actual_parents)
 
162
 
 
163
    def check_one_rev(self, rev_id):
 
164
        """Check one revision.
 
165
 
 
166
        rev_id - the one to check
 
167
        """
 
168
        rev = self.repository.get_revision(rev_id)
 
169
 
 
170
        if rev.revision_id != rev_id:
 
171
            raise BzrCheckError('wrong internal revision id in revision {%s}'
 
172
                                % rev_id)
 
173
 
 
174
        for parent in rev.parent_ids:
 
175
            if not parent in self.planned_revisions:
 
176
                # rev has a parent we didn't know about.
 
177
                missing_links = self.missing_parent_links.get(parent, [])
 
178
                missing_links.append(rev_id)
 
179
                self.missing_parent_links[parent] = missing_links
 
180
                # list based so somewhat slow,
 
181
                # TODO have a planned_revisions list and set.
 
182
                if self.repository.has_revision(parent):
 
183
                    missing_ancestry = self.repository.get_ancestry(parent)
 
184
                    for missing in missing_ancestry:
 
185
                        if (missing is not None
 
186
                            and missing not in self.planned_revisions):
 
187
                            self.planned_revisions.append(missing)
 
188
                else:
 
189
                    self.ghosts.append(rev_id)
 
190
 
 
191
        if rev.inventory_sha1:
 
192
            # Loopback - this is currently circular logic as the
 
193
            # knit get_inventory_sha1 call returns rev.inventory_sha1.
 
194
            # Repository.py's get_inventory_sha1 should instead return
 
195
            # inventories.get_record_stream([(revid,)]).next().sha1 or
 
196
            # similar.
 
197
            inv_sha1 = self.repository.get_inventory_sha1(rev_id)
 
198
            if inv_sha1 != rev.inventory_sha1:
 
199
                raise BzrCheckError('Inventory sha1 hash doesn\'t match'
 
200
                    ' value in revision {%s}' % rev_id)
 
201
        self._check_revision_tree(rev_id)
 
202
        self.checked_rev_cnt += 1
 
203
 
 
204
    def check_weaves(self):
 
205
        """Check all the weaves we can get our hands on.
 
206
        """
 
207
        weave_ids = []
 
208
        self.progress.update('checking inventory', 0, 2)
 
209
        self.inventory_weave.check(progress_bar=self.progress)
 
210
        self.progress.update('checking text storage', 1, 2)
 
211
        self.repository.texts.check(progress_bar=self.progress)
 
212
        weave_checker = self.repository._get_versioned_file_checker()
 
213
        result = weave_checker.check_file_version_parents(
 
214
            self.repository.texts, progress_bar=self.progress)
 
215
        self.checked_weaves = weave_checker.file_ids
 
216
        bad_parents, unused_versions = result
 
217
        bad_parents = bad_parents.items()
 
218
        for text_key, (stored_parents, correct_parents) in bad_parents:
 
219
            # XXX not ready for id join/split operations.
 
220
            weave_id = text_key[0]
 
221
            revision_id = text_key[-1]
 
222
            weave_parents = tuple([parent[-1] for parent in stored_parents])
 
223
            correct_parents = tuple([parent[-1] for parent in correct_parents])
 
224
            self.inconsistent_parents.append(
 
225
                (revision_id, weave_id, weave_parents, correct_parents))
 
226
        self.unreferenced_versions.update(unused_versions)
 
227
 
 
228
    def _check_revision_tree(self, rev_id):
 
229
        tree = self.repository.revision_tree(rev_id)
 
230
        inv = tree.inventory
 
231
        seen_ids = {}
 
232
        for file_id in inv:
 
233
            if file_id in seen_ids:
 
234
                raise BzrCheckError('duplicated file_id {%s} '
 
235
                                    'in inventory for revision {%s}'
 
236
                                    % (file_id, rev_id))
 
237
            seen_ids[file_id] = True
 
238
        for file_id in inv:
 
239
            ie = inv[file_id]
 
240
            ie.check(self, rev_id, inv, tree)
 
241
        seen_names = {}
 
242
        for path, ie in inv.iter_entries():
 
243
            if path in seen_names:
 
244
                raise BzrCheckError('duplicated path %s '
 
245
                                    'in inventory for revision {%s}'
 
246
                                    % (path, rev_id))
 
247
            seen_names[path] = True
 
248
 
 
249
 
 
250
@deprecated_function(deprecated_in((1,6,0)))
 
251
def check(branch, verbose):
 
252
    """Run consistency checks on a branch.
 
253
 
 
254
    Results are reported through logging.
 
255
 
 
256
    Deprecated in 1.6.  Please use check_branch instead.
 
257
 
 
258
    :raise BzrCheckError: if there's a consistency error.
 
259
    """
 
260
    check_branch(branch, verbose)
 
261
 
 
262
 
 
263
def check_branch(branch, verbose):
 
264
    """Run consistency checks on a branch.
 
265
 
 
266
    Results are reported through logging.
 
267
 
 
268
    :raise BzrCheckError: if there's a consistency error.
 
269
    """
 
270
    branch.lock_read()
 
271
    try:
 
272
        branch_result = branch.check()
 
273
    finally:
 
274
        branch.unlock()
 
275
    branch_result.report_results(verbose)
 
276
 
 
277
 
 
278
def check_dwim(path, verbose, do_branch=False, do_repo=False, do_tree=False):
 
279
    try:
 
280
        tree, branch, repo, relpath = \
 
281
                        BzrDir.open_containing_tree_branch_or_repository(path)
 
282
    except errors.NotBranchError:
 
283
        tree = branch = repo = None
 
284
 
 
285
    if do_tree:
 
286
        if tree is not None:
 
287
            note("Checking working tree at '%s'."
 
288
                 % (tree.bzrdir.root_transport.base,))
 
289
            tree._check()
 
290
        else:
 
291
            log_error("No working tree found at specified location.")
 
292
 
 
293
    if branch is not None:
 
294
        # We have a branch
 
295
        if repo is None:
 
296
            # The branch is in a shared repository
 
297
            repo = branch.repository
 
298
        branches = [branch]
 
299
    elif repo is not None:
 
300
        branches = repo.find_branches(using=True)
 
301
 
 
302
    if repo is not None:
 
303
        repo.lock_read()
 
304
        try:
 
305
            if do_repo:
 
306
                note("Checking repository at '%s'."
 
307
                     % (repo.bzrdir.root_transport.base,))
 
308
                result = repo.check()
 
309
                result.report_results(verbose)
 
310
            if do_branch:
 
311
                if branches == []:
 
312
                    log_error("No branch found at specified location.")
 
313
                else:
 
314
                    for branch in branches:
 
315
                        note("Checking branch at '%s'."
 
316
                             % (branch.bzrdir.root_transport.base,))
 
317
                        check_branch(branch, verbose)
 
318
        finally:
 
319
            repo.unlock()
 
320
    else:
 
321
        if do_branch:
 
322
            log_error("No branch found at specified location.")
 
323
        if do_repo:
 
324
            log_error("No repository found at specified location.")