~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/check.py

  • Committer: Andrew Bennetts
  • Date: 2010-07-29 11:17:57 UTC
  • mfrom: (5050.3.17 2.2)
  • mto: This revision was merged to the branch mainline in revision 5365.
  • Revision ID: andrew.bennetts@canonical.com-20100729111757-018h3pcefo7z0dnq
Merge lp:bzr/2.2 into lp:bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
39
39
so that when the dependent object is checked, matches can be pulled out and
40
40
evaluated in-line rather than re-reading the same data many times.
41
41
check_refs are tuples (kind, value). Currently defined kinds are:
42
 
 
43
42
* 'trees', where value is a revid and the looked up objects are revision trees.
44
43
* 'lefthand-distance', where value is a revid and the looked up objects are the
45
44
  distance along the lefthand path to NULL for that revid.
47
46
  indicating that the revision was found/not found.
48
47
"""
49
48
 
50
 
from bzrlib import (
51
 
    errors,
52
 
    ui,
53
 
    )
 
49
from bzrlib import errors
54
50
from bzrlib.branch import Branch
55
 
from bzrlib.controldir import ControlDir
 
51
from bzrlib.bzrdir import BzrDir
56
52
from bzrlib.revision import NULL_REVISION
 
53
from bzrlib.symbol_versioning import deprecated_function, deprecated_in
57
54
from bzrlib.trace import note
 
55
import bzrlib.ui
58
56
from bzrlib.workingtree import WorkingTree
59
 
from bzrlib.i18n import gettext
60
57
 
61
58
class Check(object):
62
59
    """Check a repository"""
63
60
 
64
 
    def __init__(self, repository, check_repo=True):
65
 
        self.repository = repository
66
 
 
67
 
    def report_results(self, verbose):
68
 
        raise NotImplementedError(self.report_results)
69
 
 
70
 
 
71
 
class VersionedFileCheck(Check):
72
 
    """Check a versioned file repository"""
73
 
 
74
61
    # The Check object interacts with InventoryEntry.check, etc.
75
62
 
76
63
    def __init__(self, repository, check_repo=True):
101
88
        if callback_refs is None:
102
89
            callback_refs = {}
103
90
        self.repository.lock_read()
104
 
        self.progress = ui.ui_factory.nested_progress_bar()
 
91
        self.progress = bzrlib.ui.ui_factory.nested_progress_bar()
105
92
        try:
106
 
            self.progress.update(gettext('check'), 0, 4)
 
93
            self.progress.update('check', 0, 4)
107
94
            if self.check_repo:
108
 
                self.progress.update(gettext('checking revisions'), 0)
 
95
                self.progress.update('checking revisions', 0)
109
96
                self.check_revisions()
110
 
                self.progress.update(gettext('checking commit contents'), 1)
 
97
                self.progress.update('checking commit contents', 1)
111
98
                self.repository._check_inventories(self)
112
 
                self.progress.update(gettext('checking file graphs'), 2)
 
99
                self.progress.update('checking file graphs', 2)
113
100
                # check_weaves is done after the revision scan so that
114
101
                # revision index is known to be valid.
115
102
                self.check_weaves()
116
 
            self.progress.update(gettext('checking branches and trees'), 3)
 
103
            self.progress.update('checking branches and trees', 3)
117
104
            if callback_refs:
118
105
                repo = self.repository
119
106
                # calculate all refs, and callback the objects requesting them.
183
170
        # - we can fill out existence flags at this point
184
171
        # - we can read the revision inventory sha at this point
185
172
        # - we can check properties and serialisers etc.
186
 
        if not self.repository._format.revision_graph_can_have_wrong_parents:
 
173
        if not self.repository.revision_graph_can_have_wrong_parents():
187
174
            # The check against the index isn't needed.
188
175
            self.revs_with_bad_parents_in_index = None
189
176
            for thing in revision_iterator:
200
187
            result.report_results(verbose)
201
188
 
202
189
    def _report_repo_results(self, verbose):
203
 
        note(gettext('checked repository {0} format {1}').format(
 
190
        note('checked repository %s format %s',
204
191
            self.repository.user_url,
205
 
            self.repository._format))
206
 
        note(gettext('%6d revisions'), self.checked_rev_cnt)
207
 
        note(gettext('%6d file-ids'), len(self.checked_weaves))
 
192
            self.repository._format)
 
193
        note('%6d revisions', self.checked_rev_cnt)
 
194
        note('%6d file-ids', len(self.checked_weaves))
208
195
        if verbose:
209
 
            note(gettext('%6d unreferenced text versions'),
 
196
            note('%6d unreferenced text versions',
210
197
                len(self.unreferenced_versions))
211
198
        if verbose and len(self.unreferenced_versions):
212
199
                for file_id, revision_id in self.unreferenced_versions:
213
 
                    note(gettext('unreferenced version: {{{0}}} in {1}').format(revision_id,
214
 
                        file_id))
 
200
                    note('unreferenced version: {%s} in %s', revision_id,
 
201
                        file_id)
215
202
        if self.missing_inventory_sha_cnt:
216
 
            note(gettext('%6d revisions are missing inventory_sha1'),
 
203
            note('%6d revisions are missing inventory_sha1',
217
204
                 self.missing_inventory_sha_cnt)
218
205
        if self.missing_revision_cnt:
219
 
            note(gettext('%6d revisions are mentioned but not present'),
 
206
            note('%6d revisions are mentioned but not present',
220
207
                 self.missing_revision_cnt)
221
208
        if len(self.ghosts):
222
 
            note(gettext('%6d ghost revisions'), len(self.ghosts))
 
209
            note('%6d ghost revisions', len(self.ghosts))
223
210
            if verbose:
224
211
                for ghost in self.ghosts:
225
212
                    note('      %s', ghost)
226
213
        if len(self.missing_parent_links):
227
 
            note(gettext('%6d revisions missing parents in ancestry'),
 
214
            note('%6d revisions missing parents in ancestry',
228
215
                 len(self.missing_parent_links))
229
216
            if verbose:
230
217
                for link, linkers in self.missing_parent_links.items():
231
 
                    note(gettext('      %s should be in the ancestry for:'), link)
 
218
                    note('      %s should be in the ancestry for:', link)
232
219
                    for linker in linkers:
233
220
                        note('       * %s', linker)
234
221
        if len(self.inconsistent_parents):
235
 
            note(gettext('%6d inconsistent parents'), len(self.inconsistent_parents))
 
222
            note('%6d inconsistent parents', len(self.inconsistent_parents))
236
223
            if verbose:
237
224
                for info in self.inconsistent_parents:
238
225
                    revision_id, file_id, found_parents, correct_parents = info
239
 
                    note(gettext('      * {0} version {1} has parents {2!r} '
240
 
                         'but should have {3!r}').format(
241
 
                         file_id, revision_id, found_parents,
 
226
                    note('      * %s version %s has parents %r '
 
227
                         'but should have %r'
 
228
                         % (file_id, revision_id, found_parents,
242
229
                             correct_parents))
243
230
        if self.revs_with_bad_parents_in_index:
244
 
            note(gettext(
245
 
                 '%6d revisions have incorrect parents in the revision index'),
 
231
            note('%6d revisions have incorrect parents in the revision index',
246
232
                 len(self.revs_with_bad_parents_in_index))
247
233
            if verbose:
248
234
                for item in self.revs_with_bad_parents_in_index:
249
235
                    revision_id, index_parents, actual_parents = item
250
 
                    note(gettext(
251
 
                        '       {0} has wrong parents in index: '
252
 
                        '{1!r} should be {2!r}').format(
253
 
                        revision_id, index_parents, actual_parents))
 
236
                    note(
 
237
                        '       %s has wrong parents in index: '
 
238
                        '%r should be %r',
 
239
                        revision_id, index_parents, actual_parents)
254
240
        for item in self._report_items:
255
241
            note(item)
256
242
 
261
247
        :param rev: A revision or None to indicate a missing revision.
262
248
        """
263
249
        if rev.revision_id != rev_id:
264
 
            self._report_items.append(gettext(
265
 
                'Mismatched internal revid {{{0}}} and index revid {{{1}}}').format(
 
250
            self._report_items.append(
 
251
                'Mismatched internal revid {%s} and index revid {%s}' % (
266
252
                rev.revision_id, rev_id))
267
253
            rev_id = rev.revision_id
268
254
        # Check this revision tree etc, and count as seen when we encounter a
291
277
        existing = self.pending_keys.get(key)
292
278
        if existing:
293
279
            if sha1 != existing[1]:
294
 
                self._report_items.append(gettext('Multiple expected sha1s for {0}. {{{1}}}'
295
 
                    ' expects {{{2}}}, {{{3}}} expects {{{4}}}').format(
 
280
                self._report_items.append('Multiple expected sha1s for %s. {%s}'
 
281
                    ' expects {%s}, {%s} expects {%s}', (
296
282
                    key, referer, sha1, existing[1], existing[0]))
297
283
        else:
298
284
            self.pending_keys[key] = (kind, sha1, referer)
301
287
        """Check all the weaves we can get our hands on.
302
288
        """
303
289
        weave_ids = []
304
 
        storebar = ui.ui_factory.nested_progress_bar()
 
290
        storebar = bzrlib.ui.ui_factory.nested_progress_bar()
305
291
        try:
306
292
            self._check_weaves(storebar)
307
293
        finally:
342
328
            self.text_key_references[key] = True
343
329
 
344
330
 
 
331
@deprecated_function(deprecated_in((1,6,0)))
 
332
def check(branch, verbose):
 
333
    """Run consistency checks on a branch.
 
334
 
 
335
    Results are reported through logging.
 
336
 
 
337
    Deprecated in 1.6.  Please use check_dwim instead.
 
338
 
 
339
    :raise BzrCheckError: if there's a consistency error.
 
340
    """
 
341
    check_branch(branch, verbose)
 
342
 
 
343
 
 
344
@deprecated_function(deprecated_in((1,16,0)))
 
345
def check_branch(branch, verbose):
 
346
    """Run consistency checks on a branch.
 
347
 
 
348
    Results are reported through logging.
 
349
 
 
350
    :raise BzrCheckError: if there's a consistency error.
 
351
    """
 
352
    branch.lock_read()
 
353
    try:
 
354
        needed_refs = {}
 
355
        for ref in branch._get_check_refs():
 
356
            needed_refs.setdefault(ref, []).append(branch)
 
357
        result = branch.repository.check([branch.last_revision()], needed_refs)
 
358
        branch_result = result.other_results[0]
 
359
    finally:
 
360
        branch.unlock()
 
361
    branch_result.report_results(verbose)
 
362
 
 
363
 
345
364
def scan_branch(branch, needed_refs, to_unlock):
346
365
    """Scan a branch for refs.
347
366
 
349
368
    :param needed_refs: Refs we are accumulating.
350
369
    :param to_unlock: The unlock list accumulating.
351
370
    """
352
 
    note(gettext("Checking branch at '%s'.") % (branch.base,))
 
371
    note("Checking branch at '%s'." % (branch.base,))
353
372
    branch.lock_read()
354
373
    to_unlock.append(branch)
355
374
    branch_refs = branch._get_check_refs()
369
388
    """
370
389
    if base_tree is not None and tree.basedir == base_tree.basedir:
371
390
        return
372
 
    note(gettext("Checking working tree at '%s'.") % (tree.basedir,))
 
391
    note("Checking working tree at '%s'." % (tree.basedir,))
373
392
    tree.lock_read()
374
393
    to_unlock.append(tree)
375
394
    tree_refs = tree._get_check_refs()
386
405
    """
387
406
    try:
388
407
        base_tree, branch, repo, relpath = \
389
 
                        ControlDir.open_containing_tree_branch_or_repository(path)
 
408
                        BzrDir.open_containing_tree_branch_or_repository(path)
390
409
    except errors.NotBranchError:
391
410
        base_tree = branch = repo = None
392
411
 
422
441
                    if do_branch:
423
442
                        scan_branch(branch, needed_refs, to_unlock)
424
443
            if do_branch and not branches:
425
 
                note(gettext("No branch found at specified location."))
 
444
                note("No branch found at specified location.")
426
445
            if do_tree and base_tree is None and not saw_tree:
427
 
                note(gettext("No working tree found at specified location."))
 
446
                note("No working tree found at specified location.")
428
447
            if do_repo or do_branch or do_tree:
429
448
                if do_repo:
430
 
                    note(gettext("Checking repository at '%s'.")
 
449
                    note("Checking repository at '%s'."
431
450
                         % (repo.user_url,))
432
451
                result = repo.check(None, callback_refs=needed_refs,
433
452
                    check_repo=do_repo)
434
453
                result.report_results(verbose)
435
454
        else:
436
455
            if do_tree:
437
 
                note(gettext("No working tree found at specified location."))
 
456
                note("No working tree found at specified location.")
438
457
            if do_branch:
439
 
                note(gettext("No branch found at specified location."))
 
458
                note("No branch found at specified location.")
440
459
            if do_repo:
441
 
                note(gettext("No repository found at specified location."))
 
460
                note("No repository found at specified location.")
442
461
    finally:
443
462
        for thing in to_unlock:
444
463
            thing.unlock()