~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/check.py

  • Committer: Martin Pool
  • Date: 2005-07-04 08:06:51 UTC
  • Revision ID: mbp@sourcefrog.net-20050704080651-6ecec49164359e48
- track pending-merges

- unit tests for this

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
21
17
 
22
18
 
23
19
 
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()
 
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
 
41
 
 
42
        history = branch.revision_history()
 
43
        revno = 0
 
44
        revcount = len(history)
 
45
 
 
46
        # for all texts checked, text_id -> sha1
 
47
        checked_texts = {}
 
48
 
 
49
        for rev_id in history:
 
50
            revno += 1
 
51
            pb.update('checking revision', revno, revcount)
 
52
            mutter('    revision {%s}' % rev_id)
 
53
            rev = branch.get_revision(rev_id)
 
54
            if rev.revision_id != rev_id:
 
55
                raise BzrCheckError('wrong internal revision id in revision {%s}'
 
56
                                    % rev_id)
 
57
 
 
58
            # check the previous history entry is a parent of this entry
 
59
            if rev.parents:
 
60
                if last_rev_id is None:
 
61
                    raise BzrCheckError("revision {%s} has %d parents, but is the "
 
62
                                        "start of the branch"
 
63
                                        % (rev_id, len(rev.parents)))
 
64
                for prr in rev.parents:
 
65
                    if prr.revision_id == last_rev_id:
 
66
                        break
 
67
                else:
 
68
                    raise BzrCheckError("previous revision {%s} not listed among "
 
69
                                        "parents of {%s}"
 
70
                                        % (last_rev_id, rev_id))
 
71
 
 
72
                for prr in rev.parents:
 
73
                    if prr.revision_sha1 is None:
 
74
                        missing_revision_sha_cnt += 1
 
75
                        continue
 
76
                    prid = prr.revision_id
 
77
                    actual_sha = branch.get_revision_sha1(prid)
 
78
                    if prr.revision_sha1 != actual_sha:
 
79
                        raise BzrCheckError("mismatched revision sha1 for "
 
80
                                            "parent {%s} of {%s}: %s vs %s"
 
81
                                            % (prid, rev_id,
 
82
                                               prr.revision_sha1, actual_sha))
 
83
            elif last_rev_id:
 
84
                raise BzrCheckError("revision {%s} has no parents listed but preceded "
 
85
                                    "by {%s}"
 
86
                                    % (rev_id, last_rev_id))
 
87
 
 
88
            ## TODO: Check all the required fields are present on the revision.
 
89
 
 
90
            if rev.inventory_sha1:
 
91
                inv_sha1 = branch.get_inventory_sha1(rev.inventory_id)
 
92
                if inv_sha1 != rev.inventory_sha1:
 
93
                    raise BzrCheckError('Inventory sha1 hash doesn\'t match'
 
94
                        ' value in revision {%s}' % rev_id)
 
95
            else:
 
96
                missing_inventory_sha_cnt += 1
 
97
                mutter("no inventory_sha1 on revision {%s}" % rev_id)
 
98
 
 
99
            inv = branch.get_inventory(rev.inventory_id)
 
100
            seen_ids = {}
 
101
            seen_names = {}
 
102
 
 
103
            ## p('revision %d/%d file ids' % (revno, revcount))
 
104
            for file_id in inv:
 
105
                if file_id in seen_ids:
 
106
                    raise BzrCheckError('duplicated file_id {%s} '
 
107
                                        'in inventory for revision {%s}'
 
108
                                        % (file_id, rev_id))
 
109
                seen_ids[file_id] = True
 
110
 
 
111
            i = 0
 
112
            for file_id in inv:
 
113
                i += 1
 
114
                if i & 31 == 0:
 
115
                    pb.tick()
 
116
 
 
117
                ie = inv[file_id]
 
118
 
 
119
                if ie.parent_id != None:
 
120
                    if ie.parent_id not in seen_ids:
 
121
                        raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
 
122
                                % (ie.parent_id, rev_id))
 
123
 
 
124
                if ie.kind == 'file':
 
125
                    if ie.text_id in checked_texts:
 
126
                        fp = checked_texts[ie.text_id]
 
127
                    else:
 
128
                        if not ie.text_id in branch.text_store:
 
129
                            raise BzrCheckError('text {%s} not in text_store' % ie.text_id)
 
130
 
 
131
                        tf = branch.text_store[ie.text_id]
 
132
                        fp = fingerprint_file(tf)
 
133
                        checked_texts[ie.text_id] = fp
 
134
 
 
135
                    if ie.text_size != fp['size']:
 
136
                        raise BzrCheckError('text {%s} wrong size' % ie.text_id)
 
137
                    if ie.text_sha1 != fp['sha1']:
 
138
                        raise BzrCheckError('text {%s} wrong sha1' % ie.text_id)
 
139
                elif ie.kind == 'directory':
 
140
                    if ie.text_sha1 != None or ie.text_size != None or ie.text_id != None:
 
141
                        raise BzrCheckError('directory {%s} has text in revision {%s}'
 
142
                                % (file_id, rev_id))
 
143
 
 
144
            pb.tick()
 
145
            for path, ie in inv.iter_entries():
 
146
                if path in seen_names:
 
147
                    raise BzrCheckError('duplicated path %s '
 
148
                                        'in inventory for revision {%s}'
 
149
                                        % (path, rev_id))
 
150
            seen_names[path] = True
 
151
            last_rev_id = rev_id
 
152
 
 
153
    finally:
 
154
        branch.unlock()
 
155
 
 
156
    pb.clear()
 
157
 
 
158
    print 'checked %d revisions, %d file texts' % (revcount, len(checked_texts))
57
159
    
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
 
 
 
160
    if missing_inventory_sha_cnt:
 
161
        print '%d revisions are missing inventory_sha1' % missing_inventory_sha_cnt
 
162
 
 
163
    if missing_revision_sha_cnt:
 
164
        print '%d parent links are missing revision_sha1' % missing_revision_sha_cnt
 
165
 
 
166
    if (missing_inventory_sha_cnt
 
167
        or missing_revision_sha_cnt):
 
168
        print '  (use "bzr upgrade" to fix them)'