~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/check.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-09 04:51:05 UTC
  • Revision ID: mbp@sourcefrog.net-20050309045105-d02cd410a115da2c
import all docs from arch

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
#! /usr/bin/python
 
2
 
 
3
 
1
4
# Copyright (C) 2004, 2005 by Martin Pool
2
5
# Copyright (C) 2005 by Canonical Ltd
3
6
 
 
7
 
4
8
# This program is free software; you can redistribute it and/or modify
5
9
# it under the terms of the GNU General Public License as published by
6
10
# the Free Software Foundation; either version 2 of the License, or
17
21
 
18
22
 
19
23
 
20
 
 
21
 
def check(branch):
22
 
    """Run consistency checks on a branch.
23
 
 
24
 
    TODO: Also check non-mailine revisions mentioned as parents.
25
 
    """
26
 
    from bzrlib.trace import mutter
27
 
    from bzrlib.errors import BzrCheckError
28
 
    from bzrlib.osutils import fingerprint_file
29
 
    from bzrlib.progress import ProgressBar
30
 
 
31
 
    branch.lock_read()
32
 
 
33
 
    try:
34
 
        pb = ProgressBar(show_spinner=True)
35
 
        last_rev_id = None
36
 
 
37
 
        missing_inventory_sha_cnt = 0
38
 
        missing_revision_sha_cnt = 0
39
 
 
40
 
        history = branch.revision_history()
41
 
        revno = 0
42
 
        revcount = len(history)
43
 
 
44
 
        # for all texts checked, text_id -> sha1
45
 
        checked_texts = {}
46
 
 
47
 
        for rev_id in history:
48
 
            revno += 1
49
 
            pb.update('checking revision', revno, revcount)
50
 
            mutter('    revision {%s}' % rev_id)
51
 
            rev = branch.get_revision(rev_id)
52
 
            if rev.revision_id != rev_id:
53
 
                raise BzrCheckError('wrong internal revision id in revision {%s}'
54
 
                                    % rev_id)
55
 
 
56
 
            # check the previous history entry is a parent of this entry
57
 
            if rev.parents:
58
 
                if last_rev_id is None:
59
 
                    raise BzrCheckError("revision {%s} has %d parents, but is the "
60
 
                                        "start of the branch"
61
 
                                        % (rev_id, len(rev.parents)))
62
 
                for prr in rev.parents:
63
 
                    if prr.revision_id == last_rev_id:
64
 
                        break
65
 
                else:
66
 
                    raise BzrCheckError("previous revision {%s} not listed among "
67
 
                                        "parents of {%s}"
68
 
                                        % (last_rev_id, rev_id))
69
 
 
70
 
                for prr in rev.parents:
71
 
                    if prr.revision_sha1 is None:
72
 
                        missing_revision_sha_cnt += 1
73
 
                        continue
74
 
                    prid = prr.revision_id
75
 
                    actual_sha = branch.get_revision_sha1(prid)
76
 
                    if prr.revision_sha1 != actual_sha:
77
 
                        raise BzrCheckError("mismatched revision sha1 for "
78
 
                                            "parent {%s} of {%s}: %s vs %s"
79
 
                                            % (prid, rev_id,
80
 
                                               prr.revision_sha1, actual_sha))
81
 
            elif last_rev_id:
82
 
                raise BzrCheckError("revision {%s} has no parents listed but preceded "
83
 
                                    "by {%s}"
84
 
                                    % (rev_id, last_rev_id))
85
 
 
86
 
            ## TODO: Check all the required fields are present on the revision.
87
 
 
88
 
            if rev.inventory_sha1:
89
 
                inv_sha1 = branch.get_inventory_sha1(rev.inventory_id)
90
 
                if inv_sha1 != rev.inventory_sha1:
91
 
                    raise BzrCheckError('Inventory sha1 hash doesn\'t match'
92
 
                        ' value in revision {%s}' % rev_id)
93
 
            else:
94
 
                missing_inventory_sha_cnt += 1
95
 
                mutter("no inventory_sha1 on revision {%s}" % rev_id)
96
 
 
97
 
            inv = branch.get_inventory(rev.inventory_id)
98
 
            seen_ids = {}
99
 
            seen_names = {}
100
 
 
101
 
            ## p('revision %d/%d file ids' % (revno, revcount))
102
 
            for file_id in inv:
103
 
                if file_id in seen_ids:
104
 
                    raise BzrCheckError('duplicated file_id {%s} '
105
 
                                        'in inventory for revision {%s}'
106
 
                                        % (file_id, rev_id))
107
 
                seen_ids[file_id] = True
108
 
 
109
 
            i = 0
110
 
            for file_id in inv:
111
 
                i += 1
112
 
                if i & 31 == 0:
113
 
                    pb.tick()
114
 
 
115
 
                ie = inv[file_id]
116
 
 
117
 
                if ie.parent_id != None:
118
 
                    if ie.parent_id not in seen_ids:
119
 
                        raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
120
 
                                % (ie.parent_id, rev_id))
121
 
 
122
 
                if ie.kind == 'file':
123
 
                    if ie.text_id in checked_texts:
124
 
                        fp = checked_texts[ie.text_id]
125
 
                    else:
126
 
                        if not ie.text_id in branch.text_store:
127
 
                            raise BzrCheckError('text {%s} not in text_store' % ie.text_id)
128
 
 
129
 
                        tf = branch.text_store[ie.text_id]
130
 
                        fp = fingerprint_file(tf)
131
 
                        checked_texts[ie.text_id] = fp
132
 
 
133
 
                    if ie.text_size != fp['size']:
134
 
                        raise BzrCheckError('text {%s} wrong size' % ie.text_id)
135
 
                    if ie.text_sha1 != fp['sha1']:
136
 
                        raise BzrCheckError('text {%s} wrong sha1' % ie.text_id)
137
 
                elif ie.kind == 'directory':
138
 
                    if ie.text_sha1 != None or ie.text_size != None or ie.text_id != None:
139
 
                        raise BzrCheckError('directory {%s} has text in revision {%s}'
140
 
                                % (file_id, rev_id))
141
 
 
142
 
            pb.tick()
143
 
            for path, ie in inv.iter_entries():
144
 
                if path in seen_names:
145
 
                    raise BzrCheckError('duplicated path %s '
146
 
                                        'in inventory for revision {%s}'
147
 
                                        % (path, rev_id))
148
 
            seen_names[path] = True
149
 
            last_rev_id = rev_id
150
 
 
151
 
    finally:
152
 
        branch.unlock()
153
 
 
154
 
    pb.clear()
155
 
 
156
 
    print 'checked %d revisions, %d file texts' % (revcount, len(checked_texts))
 
24
######################################################################
 
25
# consistency checks
 
26
 
 
27
def check():
 
28
    """Consistency check of tree."""
 
29
    assert_in_tree()
 
30
    mutter("checking tree")
 
31
    check_patches_exist()
 
32
    check_patch_chaining()
 
33
    check_patch_uniqueness()
 
34
    check_inventory()
 
35
    mutter("tree looks OK")
 
36
    ## TODO: Check that previous-inventory and previous-manifest
 
37
    ## are the same as those stored in the previous changeset.
 
38
 
 
39
    ## TODO: Check all patches present in patch directory are
 
40
    ## mentioned in patch history; having an orphaned patch only gives
 
41
    ## a warning.
 
42
 
 
43
    ## TODO: Check cached data is consistent with data reconstructed
 
44
    ## from scratch.
 
45
 
 
46
    ## TODO: Check no control files are versioned.
 
47
 
 
48
    ## TODO: Check that the before-hash of each file in a later
 
49
    ## revision matches the after-hash in the previous revision to
 
50
    ## touch it.
 
51
 
 
52
 
 
53
def check_inventory():
 
54
    mutter("checking inventory file and ids...")
 
55
    seen_ids = Set()
 
56
    seen_names = Set()
157
57
    
158
 
    if missing_inventory_sha_cnt:
159
 
        print '%d revisions are missing inventory_sha1' % missing_inventory_sha_cnt
160
 
 
161
 
    if missing_revision_sha_cnt:
162
 
        print '%d parent links are missing revision_sha1' % missing_revision_sha_cnt
163
 
 
164
 
    if (missing_inventory_sha_cnt
165
 
        or missing_revision_sha_cnt):
166
 
        print '  (use "bzr upgrade" to fix them)'
 
58
    for l in controlfile('inventory').readlines():
 
59
        parts = l.split()
 
60
        if len(parts) != 2:
 
61
            bailout("malformed inventory line: " + `l`)
 
62
        file_id, name = parts
 
63
        
 
64
        if file_id in seen_ids:
 
65
            bailout("duplicated file id " + file_id)
 
66
        seen_ids.add(file_id)
 
67
 
 
68
        if name in seen_names:
 
69
            bailout("duplicated file name in inventory: " + quotefn(name))
 
70
        seen_names.add(name)
 
71
        
 
72
        if is_control_file(name):
 
73
            raise BzrError("control file %s present in inventory" % quotefn(name))
 
74
 
 
75
 
 
76
def check_patches_exist():
 
77
    """Check constraint of current version: all patches exist"""
 
78
    mutter("checking all patches are present...")
 
79
    for pid in revision_history():
 
80
        read_patch_header(pid)
 
81
 
 
82
 
 
83
def check_patch_chaining():
 
84
    """Check ancestry of patches and history file is consistent"""
 
85
    mutter("checking patch chaining...")
 
86
    prev = None
 
87
    for pid in revision_history():
 
88
        log_prev = read_patch_header(pid).precursor
 
89
        if log_prev != prev:
 
90
            bailout("inconsistent precursor links on " + pid)
 
91
        prev = pid
 
92
 
 
93
 
 
94
def check_patch_uniqueness():
 
95
    """Make sure no patch is listed twice in the history.
 
96
 
 
97
    This should be implied by having correct ancestry but I'll check it
 
98
    anyhow."""
 
99
    mutter("checking history for duplicates...")
 
100
    seen = Set()
 
101
    for pid in revision_history():
 
102
        if pid in seen:
 
103
            bailout("patch " + pid + " appears twice in history")
 
104
        seen.add(pid)
 
105
        
 
106