~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/check.py

  • Committer: Martin Pool
  • Date: 2005-08-25 07:46:11 UTC
  • Revision ID: mbp@sourcefrog.net-20050825074611-98130ea6d05d9d2a
- add functions to enable and disable default logging, so that we can
  turn it off while running the tests

- default logging gets turned on from the bzr main function so that
  other applications using the library can make their own decisions

Show diffs side-by-side

added added

removed removed

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