~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/check.py

  • Committer: Martin Pool
  • Date: 2005-05-17 06:51:31 UTC
  • Revision ID: mbp@sourcefrog.net-20050517065131-96113900760a324f
doc

Show diffs side-by-side

added added

removed removed

Lines of Context:
16
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
17
 
18
18
 
19
 
def _update_store_entry(obj, obj_id, branch, store_name, store):
20
 
    """This is just a meta-function, which handles both revision entries
21
 
    and inventory entries.
22
 
    """
23
 
    from bzrlib.trace import mutter
24
 
    import tempfile, os, errno
25
 
    from osutils import rename
26
 
    obj_tmp = tempfile.TemporaryFile()
27
 
    obj.write_xml(obj_tmp)
28
 
    obj_tmp.seek(0)
29
 
 
30
 
    tmpfd, tmp_path = tempfile.mkstemp(prefix=obj_id, suffix='.gz',
31
 
        dir=branch.controlfilename(store_name))
32
 
    os.close(tmpfd)
33
 
    try:
34
 
        orig_obj_path = branch.controlfilename([store_name, obj_id+'.gz'])
35
 
        # Remove the old entry out of the way
36
 
        rename(orig_obj_path, tmp_path)
37
 
        try:
38
 
            # TODO: We may need to handle the case where the old
39
 
            # entry was not compressed (and thus did not end with .gz)
40
 
 
41
 
            store.add(obj_tmp, obj_id) # Add the new one
42
 
            os.remove(tmp_path) # Remove the old name
43
 
            mutter('    Updated %s entry {%s}' % (store_name, obj_id))
44
 
        except:
45
 
            # On any exception, restore the old entry
46
 
            rename(tmp_path, orig_obj_path)
47
 
            raise
48
 
    finally:
49
 
        if os.path.exists(tmp_path):
50
 
            # Unfortunately, the next command might throw
51
 
            # an exception, which will mask a previous exception.
52
 
            os.remove(tmp_path)
53
 
        obj_tmp.close()
54
 
 
55
 
def _update_revision_entry(rev, branch):
56
 
    """After updating the values in a revision, make sure to
57
 
    write out the data, but try to do it in an atomic manner.
58
 
 
59
 
    :param rev:    The Revision object to store
60
 
    :param branch: The Branch object where this Revision is to be stored.
61
 
    """
62
 
    _update_store_entry(rev, rev.revision_id, branch,
63
 
            'revision-store', branch.revision_store)
64
 
 
65
 
def _update_inventory_entry(inv, inv_id, branch):
66
 
    """When an inventory has been modified (such as by adding a unique tree root)
67
 
    this atomically re-generates the file.
68
 
 
69
 
    :param inv:     The Inventory
70
 
    :param inv_id:  The inventory id for this inventory
71
 
    :param branch:  The Branch where this entry will be stored.
72
 
    """
73
 
    _update_store_entry(inv, inv_id, branch,
74
 
            'inventory-store', branch.inventory_store)
75
 
 
76
 
def check(branch):
77
 
    """Run consistency checks on a branch.
78
 
 
79
 
    TODO: Also check non-mainline revisions mentioned as parents.
80
 
 
81
 
    TODO: Check for extra files in the control directory.
82
 
    """
83
 
    from bzrlib.trace import mutter
84
 
    from bzrlib.errors import BzrCheckError
85
 
    from bzrlib.osutils import fingerprint_file
86
 
    from bzrlib.progress import ProgressBar
87
 
    from bzrlib.inventory import ROOT_ID
88
 
    from bzrlib.branch import gen_root_id
89
 
 
90
 
    branch.lock_read()
91
 
 
92
 
    try:
93
 
        pb = ProgressBar(show_spinner=True)
94
 
        last_rev_id = None
95
 
 
96
 
        missing_inventory_sha_cnt = 0
97
 
        missing_revision_sha_cnt = 0
98
 
 
99
 
        history = branch.revision_history()
100
 
        revno = 0
101
 
        revcount = len(history)
102
 
        mismatch_inv_id = []
103
 
 
104
 
        # for all texts checked, text_id -> sha1
105
 
        checked_texts = {}
106
 
 
107
 
        for rev_id in history:
108
 
            revno += 1
109
 
            pb.update('checking revision', revno, revcount)
110
 
            mutter('    revision {%s}' % rev_id)
111
 
            rev = branch.get_revision(rev_id)
112
 
            if rev.revision_id != rev_id:
113
 
                raise BzrCheckError('wrong internal revision id in revision {%s}'
114
 
                                    % rev_id)
115
 
 
116
 
            # check the previous history entry is a parent of this entry
117
 
            if rev.parents:
118
 
                if last_rev_id is None:
119
 
                    raise BzrCheckError("revision {%s} has %d parents, but is the "
120
 
                                        "start of the branch"
121
 
                                        % (rev_id, len(rev.parents)))
122
 
                for prr in rev.parents:
123
 
                    if prr.revision_id == last_rev_id:
124
 
                        break
 
19
 
 
20
######################################################################
 
21
# consistency checks
 
22
 
 
23
import sys
 
24
from sets import Set
 
25
 
 
26
from trace import mutter
 
27
from errors import bailout
 
28
import osutils
 
29
 
 
30
def check(branch, progress=True):
 
31
    out = sys.stdout
 
32
 
 
33
    # TODO: factor out
 
34
    if not (hasattr(out, 'isatty') and out.isatty()):
 
35
        progress=False
 
36
 
 
37
    if progress:
 
38
        def p(m):
 
39
            mutter('checking ' + m)
 
40
            out.write('\rchecking: %-50.50s' % m)
 
41
            out.flush()
 
42
    else:
 
43
        def p(m):
 
44
            mutter('checking ' + m)
 
45
 
 
46
    p('history of %r' % branch.base)
 
47
    last_ptr = None
 
48
    checked_revs = Set()
 
49
    
 
50
    history = branch.revision_history()
 
51
    revno = 0
 
52
    revcount = len(history)
 
53
 
 
54
    checked_texts = {}
 
55
    
 
56
    for rid in history:
 
57
        revno += 1
 
58
        p('revision %d/%d' % (revno, revcount))
 
59
        mutter('    revision {%s}' % rid)
 
60
        rev = branch.get_revision(rid)
 
61
        if rev.revision_id != rid:
 
62
            bailout('wrong internal revision id in revision {%s}' % rid)
 
63
        if rev.precursor != last_ptr:
 
64
            bailout('mismatched precursor in revision {%s}' % rid)
 
65
        last_ptr = rid
 
66
        if rid in checked_revs:
 
67
            bailout('repeated revision {%s}' % rid)
 
68
        checked_revs.add(rid)
 
69
 
 
70
        ## TODO: Check all the required fields are present on the revision.
 
71
 
 
72
        inv = branch.get_inventory(rev.inventory_id)
 
73
        seen_ids = Set()
 
74
        seen_names = Set()
 
75
 
 
76
        p('revision %d/%d file ids' % (revno, revcount))
 
77
        for file_id in inv:
 
78
            if file_id in seen_ids:
 
79
                bailout('duplicated file_id {%s} in inventory for revision {%s}'
 
80
                        % (file_id, rid))
 
81
            seen_ids.add(file_id)
 
82
 
 
83
        i = 0
 
84
        len_inv = len(inv)
 
85
        for file_id in inv:
 
86
            i += 1
 
87
            if (i % 100) == 0:
 
88
                p('revision %d/%d file text %d/%d' % (revno, revcount, i, len_inv))
 
89
 
 
90
            ie = inv[file_id]
 
91
 
 
92
            if ie.parent_id != None:
 
93
                if ie.parent_id not in seen_ids:
 
94
                    bailout('missing parent {%s} in inventory for revision {%s}'
 
95
                            % (ie.parent_id, rid))
 
96
 
 
97
            if ie.kind == 'file':
 
98
                if ie.text_id in checked_texts:
 
99
                    fp = checked_texts[ie.text_id]
125
100
                else:
126
 
                    raise BzrCheckError("previous revision {%s} not listed among "
127
 
                                        "parents of {%s}"
128
 
                                        % (last_rev_id, rev_id))
129
 
 
130
 
                for prr in rev.parents:
131
 
                    if prr.revision_sha1 is None:
132
 
                        missing_revision_sha_cnt += 1
133
 
                        continue
134
 
                    prid = prr.revision_id
135
 
                    actual_sha = branch.get_revision_sha1(prid)
136
 
                    if prr.revision_sha1 != actual_sha:
137
 
                        raise BzrCheckError("mismatched revision sha1 for "
138
 
                                            "parent {%s} of {%s}: %s vs %s"
139
 
                                            % (prid, rev_id,
140
 
                                               prr.revision_sha1, actual_sha))
141
 
            elif last_rev_id:
142
 
                raise BzrCheckError("revision {%s} has no parents listed but preceded "
143
 
                                    "by {%s}"
144
 
                                    % (rev_id, last_rev_id))
145
 
 
146
 
            if rev.inventory_id != rev_id:
147
 
                mismatch_inv_id.append(rev_id)
148
 
 
149
 
            ## TODO: Check all the required fields are present on the revision.
150
 
 
151
 
            if rev.inventory_sha1:
152
 
                inv_sha1 = branch.get_inventory_sha1(rev.inventory_id)
153
 
                if inv_sha1 != rev.inventory_sha1:
154
 
                    raise BzrCheckError('Inventory sha1 hash doesn\'t match'
155
 
                        ' value in revision {%s}' % rev_id)
156
 
            else:
157
 
                missing_inventory_sha_cnt += 1
158
 
                mutter("no inventory_sha1 on revision {%s}" % rev_id)
159
 
 
160
 
            inv = branch.get_inventory(rev.inventory_id)
161
 
            seen_ids = {}
162
 
            seen_names = {}
163
 
 
164
 
            ## p('revision %d/%d file ids' % (revno, revcount))
165
 
            for file_id in inv:
166
 
                if file_id in seen_ids:
167
 
                    raise BzrCheckError('duplicated file_id {%s} '
168
 
                                        'in inventory for revision {%s}'
169
 
                                        % (file_id, rev_id))
170
 
                seen_ids[file_id] = True
171
 
 
172
 
            i = 0
173
 
            for file_id in inv:
174
 
                i += 1
175
 
                if i & 31 == 0:
176
 
                    pb.tick()
177
 
 
178
 
                ie = inv[file_id]
179
 
 
180
 
                if ie.parent_id != None:
181
 
                    if ie.parent_id not in seen_ids:
182
 
                        raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
183
 
                                % (ie.parent_id, rev_id))
184
 
 
185
 
                if ie.kind == 'file':
186
 
                    if ie.text_id in checked_texts:
187
 
                        fp = checked_texts[ie.text_id]
188
 
                    else:
189
 
                        if not ie.text_id in branch.text_store:
190
 
                            raise BzrCheckError('text {%s} not in text_store' % ie.text_id)
191
 
 
192
 
                        tf = branch.text_store[ie.text_id]
193
 
                        fp = fingerprint_file(tf)
194
 
                        checked_texts[ie.text_id] = fp
195
 
 
196
 
                    if ie.text_size != fp['size']:
197
 
                        raise BzrCheckError('text {%s} wrong size' % ie.text_id)
198
 
                    if ie.text_sha1 != fp['sha1']:
199
 
                        raise BzrCheckError('text {%s} wrong sha1' % ie.text_id)
200
 
                elif ie.kind == 'directory':
201
 
                    if ie.text_sha1 != None or ie.text_size != None or ie.text_id != None:
202
 
                        raise BzrCheckError('directory {%s} has text in revision {%s}'
203
 
                                % (file_id, rev_id))
204
 
 
205
 
            pb.tick()
206
 
            for path, ie in inv.iter_entries():
207
 
                if path in seen_names:
208
 
                    raise BzrCheckError('duplicated path %s '
209
 
                                        'in inventory for revision {%s}'
210
 
                                        % (path, rev_id))
211
 
            seen_names[path] = True
212
 
            last_rev_id = rev_id
213
 
 
214
 
    finally:
215
 
        branch.unlock()
216
 
 
217
 
    pb.clear()
218
 
 
 
101
                    if not ie.text_id in branch.text_store:
 
102
                        bailout('text {%s} not in text_store' % ie.text_id)
 
103
 
 
104
                    tf = branch.text_store[ie.text_id]
 
105
                    fp = osutils.fingerprint_file(tf)
 
106
                    checked_texts[ie.text_id] = fp
 
107
 
 
108
                if ie.text_size != fp['size']:
 
109
                    bailout('text {%s} wrong size' % ie.text_id)
 
110
                if ie.text_sha1 != fp['sha1']:
 
111
                    bailout('text {%s} wrong sha1' % ie.text_id)
 
112
            elif ie.kind == 'directory':
 
113
                if ie.text_sha1 != None or ie.text_size != None or ie.text_id != None:
 
114
                    bailout('directory {%s} has text in revision {%s}'
 
115
                            % (file_id, rid))
 
116
 
 
117
        p('revision %d/%d file paths' % (revno, revcount))
 
118
        for path, ie in inv.iter_entries():
 
119
            if path in seen_names:
 
120
                bailout('duplicated path %r in inventory for revision {%s}' % (path, revid))
 
121
            seen_names.add(path)
 
122
 
 
123
 
 
124
    p('done')
 
125
    if progress:
 
126
        print 
219
127
    print 'checked %d revisions, %d file texts' % (revcount, len(checked_texts))
220
 
    
221
 
    if missing_inventory_sha_cnt:
222
 
        print '%d revisions are missing inventory_sha1' % missing_inventory_sha_cnt
223
 
 
224
 
    if missing_revision_sha_cnt:
225
 
        print '%d parent links are missing revision_sha1' % missing_revision_sha_cnt
226
 
 
227
 
    # stub this out for now because the main bzr branch has references
228
 
    # to revisions that aren't present in the store -- mbp 20050804
229
 
#    if (missing_inventory_sha_cnt
230
 
#        or missing_revision_sha_cnt):
231
 
#        print '  (use "bzr upgrade" to fix them)'
232
 
 
233
 
    if mismatch_inv_id:
234
 
        print '%d revisions have mismatched inventory ids:' % len(mismatch_inv_id)
235
 
        for rev_id in mismatch_inv_id:
236
 
            print '  ', rev_id
 
128