1
# Copyright (C) 2004, 2005 by Martin Pool
 
 
2
# Copyright (C) 2005 by Canonical Ltd
 
 
4
# This program is free software; you can redistribute it and/or modify
 
 
5
# it under the terms of the GNU General Public License as published by
 
 
6
# the Free Software Foundation; either version 2 of the License, or
 
 
7
# (at your option) any later version.
 
 
9
# This program is distributed in the hope that it will be useful,
 
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
12
# GNU General Public License for more details.
 
 
14
# You should have received a copy of the GNU General Public License
 
 
15
# along with this program; if not, write to the Free Software
 
 
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
22
    """Run consistency checks on a branch.
 
 
24
    TODO: Also check non-mainline revisions mentioned as parents.
 
 
26
    TODO: Check for extra files in the control directory.
 
 
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
 
 
36
        pb = ProgressBar(show_spinner=True)
 
 
39
        missing_inventory_sha_cnt = 0
 
 
40
        missing_revision_sha_cnt = 0
 
 
42
        history = branch.revision_history()
 
 
44
        revcount = len(history)
 
 
47
        # for all texts checked, text_id -> sha1
 
 
50
        for rev_id in history:
 
 
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}'
 
 
59
            # check the previous history entry is a parent of this entry
 
 
61
                if last_rev_id is None:
 
 
62
                    raise BzrCheckError("revision {%s} has %d parents, but is the "
 
 
64
                                        % (rev_id, len(rev.parents)))
 
 
65
                for prr in rev.parents:
 
 
66
                    if prr.revision_id == last_rev_id:
 
 
69
                    raise BzrCheckError("previous revision {%s} not listed among "
 
 
71
                                        % (last_rev_id, rev_id))
 
 
73
                for prr in rev.parents:
 
 
74
                    if prr.revision_sha1 is None:
 
 
75
                        missing_revision_sha_cnt += 1
 
 
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"
 
 
83
                                               prr.revision_sha1, actual_sha))
 
 
85
                raise BzrCheckError("revision {%s} has no parents listed but preceded "
 
 
87
                                    % (rev_id, last_rev_id))
 
 
89
            if rev.inventory_id != rev_id:
 
 
90
                mismatch_inv_id.append(rev_id)
 
 
92
            ## TODO: Check all the required fields are present on the revision.
 
 
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)
 
 
100
                missing_inventory_sha_cnt += 1
 
 
101
                mutter("no inventory_sha1 on revision {%s}" % rev_id)
 
 
103
            inv = branch.get_inventory(rev.inventory_id)
 
 
107
            ## p('revision %d/%d file ids' % (revno, revcount))
 
 
109
                if file_id in seen_ids:
 
 
110
                    raise BzrCheckError('duplicated file_id {%s} '
 
 
111
                                        'in inventory for revision {%s}'
 
 
113
                seen_ids[file_id] = True
 
 
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))
 
 
128
                if ie.kind == 'file':
 
 
129
                    if ie.text_id in checked_texts:
 
 
130
                        fp = checked_texts[ie.text_id]
 
 
132
                        if not ie.text_id in branch.text_store:
 
 
133
                            raise BzrCheckError('text {%s} not in text_store' % ie.text_id)
 
 
135
                        tf = branch.text_store[ie.text_id]
 
 
136
                        fp = fingerprint_file(tf)
 
 
137
                        checked_texts[ie.text_id] = fp
 
 
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}'
 
 
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}'
 
 
154
            seen_names[path] = True
 
 
162
    print 'checked %d revisions, %d file texts' % (revcount, len(checked_texts))
 
 
164
    if missing_inventory_sha_cnt:
 
 
165
        print '%d revisions are missing inventory_sha1' % missing_inventory_sha_cnt
 
 
167
    if missing_revision_sha_cnt:
 
 
168
        print '%d parent links are missing revision_sha1' % missing_revision_sha_cnt
 
 
170
    if (missing_inventory_sha_cnt
 
 
171
        or missing_revision_sha_cnt):
 
 
172
        print '  (use "bzr upgrade" to fix them)'
 
 
175
        print '%d revisions have mismatched inventory ids:' % len(mismatch_inv_id)
 
 
176
        for rev_id in mismatch_inv_id: