~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/check.py

  • Committer: Martin Pool
  • Date: 2005-07-11 03:42:53 UTC
  • Revision ID: mbp@sourcefrog.net-20050711034253-412281abeb9f56ad
doc

Show diffs side-by-side

added added

removed removed

Lines of Context:
15
15
# along with this program; if not, write to the Free Software
16
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
17
 
18
 
# TODO: Check ancestries are correct for every revision: includes
19
 
# every committed so far, and in a reasonable order.
20
 
 
21
 
# TODO: Also check non-mainline revisions mentioned as parents.
22
 
 
23
 
# TODO: Check for extra files in the control directory.
24
 
 
25
 
# TODO: Check revision, inventory and entry objects have all 
26
 
# required fields.
27
 
 
28
 
 
29
 
import bzrlib.ui
30
 
from bzrlib.trace import note, warning
31
 
from bzrlib.osutils import rename, sha_string, fingerprint_file
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
 
 
37
 
 
38
 
class Check(object):
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
 
 
57
 
        self.checked_text_cnt = 0
58
 
        self.checked_rev_cnt = 0
59
 
        self.repeated_text_cnt = 0
60
 
        self.missing_inventory_sha_cnt = 0
61
 
        self.missing_revision_cnt = 0
62
 
        # maps (file-id, version) -> sha1
63
 
        self.checked_texts = {}
 
18
 
 
19
 
 
20
 
 
21
def check(branch):
 
22
    """Run consistency checks on a branch.
 
23
 
 
24
    TODO: Also check non-mainline revisions mentioned as parents.
 
25
 
 
26
    TODO: Check for extra files in the control directory.
 
27
    """
 
28
    from bzrlib.trace import mutter
 
29
    from bzrlib.errors import BzrCheckError
 
30
    from bzrlib.osutils import fingerprint_file
 
31
    from bzrlib.progress import ProgressBar
 
32
 
 
33
    branch.lock_read()
 
34
 
 
35
    try:
 
36
        pb = ProgressBar(show_spinner=True)
 
37
        last_rev_id = None
 
38
 
 
39
        missing_inventory_sha_cnt = 0
 
40
        missing_revision_sha_cnt = 0
64
41
 
65
42
        history = branch.revision_history()
66
43
        revno = 0
67
44
        revcount = len(history)
68
 
 
69
 
        last_rev_id = None
70
 
        self.progress = bzrlib.ui.ui_factory.progress_bar()
 
45
        mismatch_inv_id = []
 
46
 
 
47
        # for all texts checked, text_id -> sha1
 
48
        checked_texts = {}
 
49
 
71
50
        for rev_id in history:
72
 
            self.progress.update('checking revision', revno, revcount)
73
51
            revno += 1
74
 
            self.check_one_rev(rev_id, last_rev_id)
75
 
            last_rev_id = rev_id
76
 
        self.progress.clear()
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
 
 
85
 
        note('%6d revisions', self.checked_rev_cnt)
86
 
        note('%6d unique file texts', self.checked_text_cnt)
87
 
        note('%6d repeated file texts', self.repeated_text_cnt)
88
 
        if self.missing_inventory_sha_cnt:
89
 
            note('%d revisions are missing inventory_sha1',
90
 
                 self.missing_inventory_sha_cnt)
91
 
        if self.missing_revision_cnt:
92
 
            note('%d revisions are mentioned but not present',
93
 
                 self.missing_revision_cnt)
94
 
 
95
 
 
96
 
    def check_one_rev(self, rev_id, last_rev_id):
97
 
        """Check one revision.
98
 
 
99
 
        rev_id - the one to check
100
 
 
101
 
        last_rev_id - the previous one on the mainline, if any.
102
 
        """
103
 
 
104
 
        # mutter('    revision {%s}' % rev_id)
105
 
        branch = self.branch
106
 
        rev = branch.get_revision(rev_id)
107
 
        if rev.revision_id != rev_id:
108
 
            raise BzrCheckError('wrong internal revision id in revision {%s}'
109
 
                                % rev_id)
110
 
 
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
 
52
            pb.update('checking revision', revno, revcount)
 
53
            mutter('    revision {%s}' % rev_id)
 
54
            rev = branch.get_revision(rev_id)
 
55
            if rev.revision_id != rev_id:
 
56
                raise BzrCheckError('wrong internal revision id in revision {%s}'
 
57
                                    % rev_id)
 
58
 
 
59
            # check the previous history entry is a parent of this entry
 
60
            if rev.parents:
 
61
                if last_rev_id is None:
 
62
                    raise BzrCheckError("revision {%s} has %d parents, but is the "
 
63
                                        "start of the branch"
 
64
                                        % (rev_id, len(rev.parents)))
 
65
                for prr in rev.parents:
 
66
                    if prr.revision_id == last_rev_id:
 
67
                        break
 
68
                else:
 
69
                    raise BzrCheckError("previous revision {%s} not listed among "
 
70
                                        "parents of {%s}"
 
71
                                        % (last_rev_id, rev_id))
 
72
 
 
73
                for prr in rev.parents:
 
74
                    if prr.revision_sha1 is None:
 
75
                        missing_revision_sha_cnt += 1
 
76
                        continue
 
77
                    prid = prr.revision_id
 
78
                    actual_sha = branch.get_revision_sha1(prid)
 
79
                    if prr.revision_sha1 != actual_sha:
 
80
                        raise BzrCheckError("mismatched revision sha1 for "
 
81
                                            "parent {%s} of {%s}: %s vs %s"
 
82
                                            % (prid, rev_id,
 
83
                                               prr.revision_sha1, actual_sha))
 
84
            elif last_rev_id:
 
85
                raise BzrCheckError("revision {%s} has no parents listed but preceded "
 
86
                                    "by {%s}"
 
87
                                    % (rev_id, last_rev_id))
 
88
 
 
89
            if rev.inventory_id != rev_id:
 
90
                mismatch_inv_id.append(rev_id)
 
91
 
 
92
            ## TODO: Check all the required fields are present on the revision.
 
93
 
 
94
            if rev.inventory_sha1:
 
95
                inv_sha1 = branch.get_inventory_sha1(rev.inventory_id)
 
96
                if inv_sha1 != rev.inventory_sha1:
 
97
                    raise BzrCheckError('Inventory sha1 hash doesn\'t match'
 
98
                        ' value in revision {%s}' % rev_id)
120
99
            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))
128
 
 
129
 
        if rev.inventory_sha1:
130
 
            inv_sha1 = branch.get_inventory_sha1(rev_id)
131
 
            if inv_sha1 != rev.inventory_sha1:
132
 
                raise BzrCheckError('Inventory sha1 hash doesn\'t match'
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)
137
 
        self._check_revision_tree(rev_id)
138
 
        self.checked_rev_cnt += 1
139
 
 
140
 
    def _check_revision_tree(self, rev_id):
141
 
        tree = self.branch.revision_tree(rev_id)
142
 
        inv = tree.inventory
143
 
        seen_ids = {}
144
 
        for file_id in inv:
145
 
            if file_id in seen_ids:
146
 
                raise BzrCheckError('duplicated file_id {%s} '
147
 
                                    'in inventory for revision {%s}'
148
 
                                    % (file_id, rev_id))
149
 
            seen_ids[file_id] = True
150
 
        for file_id in inv:
151
 
            ie = inv[file_id]
152
 
            ie.check(self, rev_id, inv, tree)
153
 
        seen_names = {}
154
 
        for path, ie in inv.iter_entries():
155
 
            if path in seen_names:
156
 
                raise BzrCheckError('duplicated path %s '
157
 
                                    'in inventory for revision {%s}'
158
 
                                    % (path, rev_id))
 
100
                missing_inventory_sha_cnt += 1
 
101
                mutter("no inventory_sha1 on revision {%s}" % rev_id)
 
102
 
 
103
            inv = branch.get_inventory(rev.inventory_id)
 
104
            seen_ids = {}
 
105
            seen_names = {}
 
106
 
 
107
            ## p('revision %d/%d file ids' % (revno, revcount))
 
108
            for file_id in inv:
 
109
                if file_id in seen_ids:
 
110
                    raise BzrCheckError('duplicated file_id {%s} '
 
111
                                        'in inventory for revision {%s}'
 
112
                                        % (file_id, rev_id))
 
113
                seen_ids[file_id] = True
 
114
 
 
115
            i = 0
 
116
            for file_id in inv:
 
117
                i += 1
 
118
                if i & 31 == 0:
 
119
                    pb.tick()
 
120
 
 
121
                ie = inv[file_id]
 
122
 
 
123
                if ie.parent_id != None:
 
124
                    if ie.parent_id not in seen_ids:
 
125
                        raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
 
126
                                % (ie.parent_id, rev_id))
 
127
 
 
128
                if ie.kind == 'file':
 
129
                    if ie.text_id in checked_texts:
 
130
                        fp = checked_texts[ie.text_id]
 
131
                    else:
 
132
                        if not ie.text_id in branch.text_store:
 
133
                            raise BzrCheckError('text {%s} not in text_store' % ie.text_id)
 
134
 
 
135
                        tf = branch.text_store[ie.text_id]
 
136
                        fp = fingerprint_file(tf)
 
137
                        checked_texts[ie.text_id] = fp
 
138
 
 
139
                    if ie.text_size != fp['size']:
 
140
                        raise BzrCheckError('text {%s} wrong size' % ie.text_id)
 
141
                    if ie.text_sha1 != fp['sha1']:
 
142
                        raise BzrCheckError('text {%s} wrong sha1' % ie.text_id)
 
143
                elif ie.kind == 'directory':
 
144
                    if ie.text_sha1 != None or ie.text_size != None or ie.text_id != None:
 
145
                        raise BzrCheckError('directory {%s} has text in revision {%s}'
 
146
                                % (file_id, rev_id))
 
147
 
 
148
            pb.tick()
 
149
            for path, ie in inv.iter_entries():
 
150
                if path in seen_names:
 
151
                    raise BzrCheckError('duplicated path %s '
 
152
                                        'in inventory for revision {%s}'
 
153
                                        % (path, rev_id))
159
154
            seen_names[path] = True
160
 
 
161
 
 
162
 
def check(branch):
163
 
    """Run consistency checks on a branch."""
164
 
    Check(branch)
 
155
            last_rev_id = rev_id
 
156
 
 
157
    finally:
 
158
        branch.unlock()
 
159
 
 
160
    pb.clear()
 
161
 
 
162
    print 'checked %d revisions, %d file texts' % (revcount, len(checked_texts))
 
163
    
 
164
    if missing_inventory_sha_cnt:
 
165
        print '%d revisions are missing inventory_sha1' % missing_inventory_sha_cnt
 
166
 
 
167
    if missing_revision_sha_cnt:
 
168
        print '%d parent links are missing revision_sha1' % missing_revision_sha_cnt
 
169
 
 
170
    if (missing_inventory_sha_cnt
 
171
        or missing_revision_sha_cnt):
 
172
        print '  (use "bzr upgrade" to fix them)'
 
173
 
 
174
    if mismatch_inv_id:
 
175
        print '%d revisions have mismatched inventory ids:' % len(mismatch_inv_id)
 
176
        for rev_id in mismatch_inv_id:
 
177
            print '  ', rev_id