~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/check.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-19 01:41:44 UTC
  • Revision ID: mbp@sourcefrog.net-20050319014144-5298a74caebaf378
fix local-time-offset calculation

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
#! /usr/bin/python
 
2
 
 
3
 
1
4
# Copyright (C) 2004, 2005 by Martin Pool
2
5
# Copyright (C) 2005 by Canonical Ltd
3
6
 
 
7
 
4
8
# This program is free software; you can redistribute it and/or modify
5
9
# it under the terms of the GNU General Public License as published by
6
10
# the Free Software Foundation; either version 2 of the License, or
15
19
# along with this program; if not, write to the Free Software
16
20
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
21
 
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
 
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()
65
57
    
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
119
 
        last_rev_id = None
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:
136
 
                        break
137
 
                else:
138
 
                    raise BzrCheckError("previous revision {%s} not listed among "
139
 
                                        "parents of {%s}"
140
 
                                        % (last_rev_id, rev_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)
153
 
                    else:
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))
190
 
            seen_names[path] = True
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)
 
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