~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/check.py

  • Committer: Robert Collins
  • Date: 2005-10-30 00:00:09 UTC
  • mfrom: (1185.16.134)
  • Revision ID: robertc@robertcollins.net-20051030000009-9db99a338a0dfdac
MergeĀ fromĀ Martin.

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
 
 
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)
 
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
# TODO: Get every revision in the revision-store even if they're not
 
29
# referenced by history and make sure they're all valid.
 
30
 
 
31
import bzrlib.ui
 
32
from bzrlib.trace import note, warning
 
33
from bzrlib.osutils import rename, sha_string, fingerprint_file
 
34
from bzrlib.trace import mutter
 
35
from bzrlib.errors import BzrCheckError, NoSuchRevision
 
36
from bzrlib.inventory import ROOT_ID
 
37
from bzrlib.branch import gen_root_id
 
38
 
 
39
 
 
40
class Check(object):
 
41
    """Check a branch"""
 
42
 
 
43
    def __init__(self, branch):
 
44
        self.branch = branch
 
45
        self.checked_text_cnt = 0
 
46
        self.checked_rev_cnt = 0
 
47
        self.ghosts = []
 
48
        self.repeated_text_cnt = 0
 
49
        self.missing_parent_links = {}
 
50
        self.missing_inventory_sha_cnt = 0
 
51
        self.missing_revision_cnt = 0
 
52
        # maps (file-id, version) -> sha1
 
53
        self.checked_texts = {}
 
54
 
 
55
    def check(self):
 
56
        self.branch.lock_read()
 
57
        try:
 
58
            self.history = self.branch.revision_history()
 
59
            if not len(self.history):
 
60
                # nothing to see here
 
61
                return
 
62
            self.planned_revisions = self.branch.get_ancestry(self.history[-1])
 
63
            self.planned_revisions.remove(None)
 
64
            revno = 0
 
65
    
 
66
            self.progress = bzrlib.ui.ui_factory.progress_bar()
 
67
            while revno < len(self.planned_revisions):
 
68
                rev_id = self.planned_revisions[revno]
 
69
                self.progress.update('checking revision', revno,
 
70
                                     len(self.planned_revisions))
 
71
                revno += 1
 
72
                self.check_one_rev(rev_id)
 
73
            self.progress.clear()
 
74
        finally:
 
75
            self.branch.unlock()
 
76
 
 
77
    def report_results(self, verbose):
 
78
        note('checked branch %s format %d',
 
79
             self.branch.base, 
 
80
             self.branch._branch_format)
 
81
 
 
82
        note('%6d revisions', self.checked_rev_cnt)
 
83
        note('%6d unique file texts', self.checked_text_cnt)
 
84
        note('%6d repeated file texts', self.repeated_text_cnt)
 
85
        if self.missing_inventory_sha_cnt:
 
86
            note('%6d revisions are missing inventory_sha1',
 
87
                 self.missing_inventory_sha_cnt)
 
88
        if self.missing_revision_cnt:
 
89
            note('%6d revisions are mentioned but not present',
 
90
                 self.missing_revision_cnt)
 
91
        if len(self.ghosts):
 
92
            note('%6d ghost revisions', len(self.ghosts))
 
93
            if verbose:
 
94
                for ghost in self.ghosts:
 
95
                    note('      %s', ghost)
 
96
        if len(self.missing_parent_links):
 
97
            note('%6d revisions missing parents in ancestry', 
 
98
                 len(self.missing_parent_links))
 
99
            if verbose:
 
100
                for link, linkers in self.missing_parent_links.items():
 
101
                    note('      %s should be in the ancestry for:', link)
 
102
                    for linker in linkers:
 
103
                        note('       * %s', linker)
 
104
 
 
105
    def check_one_rev(self, rev_id):
 
106
        """Check one revision.
 
107
 
 
108
        rev_id - the one to check
 
109
 
 
110
        last_rev_id - the previous one on the mainline, if any.
 
111
        """
 
112
 
 
113
        # mutter('    revision {%s}' % rev_id)
 
114
        branch = self.branch
 
115
        try:
 
116
            rev_history_position = self.history.index(rev_id)
 
117
        except ValueError:
 
118
            rev_history_position = None
37
119
        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
 
        mismatch_inv_id = []
46
 
 
47
 
        # for all texts checked, text_id -> sha1
48
 
        checked_texts = {}
49
 
 
50
 
        for rev_id in history:
51
 
            revno += 1
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:
 
120
        if rev_history_position:
 
121
            rev = branch.get_revision(rev_id)
 
122
            if rev_history_position > 0:
 
123
                last_rev_id = self.history[rev_history_position - 1]
 
124
        else:
 
125
            rev = branch.get_revision(rev_id)
 
126
                
 
127
        if rev.revision_id != rev_id:
 
128
            raise BzrCheckError('wrong internal revision id in revision {%s}'
 
129
                                % rev_id)
 
130
 
 
131
        # check the previous history entry is a parent of this entry
 
132
        if rev.parent_ids:
 
133
            if last_rev_id is not None:
 
134
                for parent_id in rev.parent_ids:
 
135
                    if parent_id == last_rev_id:
67
136
                        break
68
137
                else:
69
138
                    raise BzrCheckError("previous revision {%s} not listed among "
70
139
                                        "parents of {%s}"
71
140
                                        % (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)
99
 
            else:
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]
 
141
            for parent in rev.parent_ids:
 
142
                if not parent in self.planned_revisions:
 
143
                    missing_links = self.missing_parent_links.get(parent, [])
 
144
                    missing_links.append(rev_id)
 
145
                    self.missing_parent_links[parent] = missing_links
 
146
                    # list based so slow, TODO have a planned_revisions list and set.
 
147
                    if self.branch.has_revision(parent):
 
148
                        missing_ancestry = self.branch.get_ancestry(parent)
 
149
                        for missing in missing_ancestry:
 
150
                            if (missing is not None 
 
151
                                and missing not in self.planned_revisions):
 
152
                                self.planned_revisions.append(missing)
131
153
                    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))
 
154
                        self.ghosts.append(rev_id)
 
155
        elif last_rev_id:
 
156
            raise BzrCheckError("revision {%s} has no parents listed "
 
157
                                "but preceded by {%s}"
 
158
                                % (rev_id, last_rev_id))
 
159
 
 
160
        if rev.inventory_sha1:
 
161
            inv_sha1 = branch.get_inventory_sha1(rev_id)
 
162
            if inv_sha1 != rev.inventory_sha1:
 
163
                raise BzrCheckError('Inventory sha1 hash doesn\'t match'
 
164
                    ' value in revision {%s}' % rev_id)
 
165
        else:
 
166
            missing_inventory_sha_cnt += 1
 
167
            mutter("no inventory_sha1 on revision {%s}" % rev_id)
 
168
        self._check_revision_tree(rev_id)
 
169
        self.checked_rev_cnt += 1
 
170
 
 
171
    def _check_revision_tree(self, rev_id):
 
172
        tree = self.branch.revision_tree(rev_id)
 
173
        inv = tree.inventory
 
174
        seen_ids = {}
 
175
        for file_id in inv:
 
176
            if file_id in seen_ids:
 
177
                raise BzrCheckError('duplicated file_id {%s} '
 
178
                                    'in inventory for revision {%s}'
 
179
                                    % (file_id, rev_id))
 
180
            seen_ids[file_id] = True
 
181
        for file_id in inv:
 
182
            ie = inv[file_id]
 
183
            ie.check(self, rev_id, inv, tree)
 
184
        seen_names = {}
 
185
        for path, ie in inv.iter_entries():
 
186
            if path in seen_names:
 
187
                raise BzrCheckError('duplicated path %s '
 
188
                                    'in inventory for revision {%s}'
 
189
                                    % (path, rev_id))
154
190
            seen_names[path] = True
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
 
191
 
 
192
 
 
193
def check(branch, verbose):
 
194
    """Run consistency checks on a branch."""
 
195
    checker = Check(branch)
 
196
    checker.check()
 
197
    checker.report_results(verbose)