15
14
# along with this program; if not, write to the Free Software
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22
"""Run consistency checks on a branch.
24
TODO: Also check non-mailine revisions mentioned as parents.
26
from bzrlib.trace import mutter
27
from bzrlib.errors import BzrCheckError
28
from bzrlib.osutils import fingerprint_file
29
from bzrlib.progress import ProgressBar
34
pb = ProgressBar(show_spinner=True)
17
# TODO: Check ancestries are correct for every revision: includes
18
# every committed so far, and in a reasonable order.
20
# TODO: Also check non-mainline revisions mentioned as parents.
22
# TODO: Check for extra files in the control directory.
24
# TODO: Check revision, inventory and entry objects have all
27
# TODO: Get every revision in the revision-store even if they're not
28
# referenced by history and make sure they're all valid.
30
# TODO: Perhaps have a way to record errors other than by raising exceptions;
31
# would perhaps be enough to accumulate exception objects in a list without
32
# raising them. If there's more than one exception it'd be good to see them
36
from bzrlib.trace import note, warning
37
from bzrlib.osutils import rename, sha_string, fingerprint_file
38
from bzrlib.trace import mutter
39
from bzrlib.errors import BzrCheckError, NoSuchRevision
40
from bzrlib.inventory import ROOT_ID
46
# The Check object interacts with InventoryEntry.check, etc.
48
def __init__(self, branch):
50
self.repository = branch.repository
51
self.checked_text_cnt = 0
52
self.checked_rev_cnt = 0
54
self.repeated_text_cnt = 0
55
self.missing_parent_links = {}
56
self.missing_inventory_sha_cnt = 0
57
self.missing_revision_cnt = 0
58
# maps (file-id, version) -> sha1; used by InventoryFile._check
59
self.checked_texts = {}
60
self.checked_weaves = {}
63
self.branch.lock_read()
64
self.progress = bzrlib.ui.ui_factory.nested_progress_bar()
66
self.progress.update('retrieving inventory', 0, 0)
67
# do not put in init, as it should be done with progess,
68
# and inside the lock.
69
self.inventory_weave = self.branch.repository.get_inventory_weave()
70
self.history = self.branch.revision_history()
71
if not len(self.history):
77
while revno < len(self.planned_revisions):
78
rev_id = self.planned_revisions[revno]
79
self.progress.update('checking revision', revno,
80
len(self.planned_revisions))
82
self.check_one_rev(rev_id)
84
self.progress.finished()
87
def plan_revisions(self):
88
repository = self.branch.repository
89
self.planned_revisions = set(repository.all_revision_ids())
91
inventoried = set(self.inventory_weave.versions())
92
awol = self.planned_revisions - inventoried
94
raise BzrCheckError('Stored revisions missing from inventory'
95
'{%s}' % ','.join([f for f in awol]))
96
self.planned_revisions = list(self.planned_revisions)
98
def report_results(self, verbose):
99
note('checked branch %s format %s',
103
note('%6d revisions', self.checked_rev_cnt)
104
note('%6d unique file texts', self.checked_text_cnt)
105
note('%6d repeated file texts', self.repeated_text_cnt)
106
note('%6d weaves', len(self.checked_weaves))
107
if self.missing_inventory_sha_cnt:
108
note('%6d revisions are missing inventory_sha1',
109
self.missing_inventory_sha_cnt)
110
if self.missing_revision_cnt:
111
note('%6d revisions are mentioned but not present',
112
self.missing_revision_cnt)
114
note('%6d ghost revisions', len(self.ghosts))
116
for ghost in self.ghosts:
118
if len(self.missing_parent_links):
119
note('%6d revisions missing parents in ancestry',
120
len(self.missing_parent_links))
122
for link, linkers in self.missing_parent_links.items():
123
note(' %s should be in the ancestry for:', link)
124
for linker in linkers:
125
note(' * %s', linker)
127
def check_one_rev(self, rev_id):
128
"""Check one revision.
130
rev_id - the one to check
132
last_rev_id - the previous one on the mainline, if any.
135
# mutter(' revision {%s}', rev_id)
138
rev_history_position = self.history.index(rev_id)
140
rev_history_position = None
35
141
last_rev_id = None
37
missing_inventory_sha_cnt = 0
38
missing_revision_sha_cnt = 0
40
history = branch.revision_history()
42
revcount = len(history)
44
# for all texts checked, text_id -> sha1
47
for rev_id in history:
49
pb.update('checking revision', revno, revcount)
50
mutter(' revision {%s}' % rev_id)
51
rev = branch.get_revision(rev_id)
52
if rev.revision_id != rev_id:
53
raise BzrCheckError('wrong internal revision id in revision {%s}'
56
# check the previous history entry is a parent of this entry
58
if last_rev_id is None:
59
raise BzrCheckError("revision {%s} has %d parents, but is the "
61
% (rev_id, len(rev.parents)))
62
for prr in rev.parents:
63
if prr.revision_id == last_rev_id:
142
if rev_history_position:
143
rev = branch.repository.get_revision(rev_id)
144
if rev_history_position > 0:
145
last_rev_id = self.history[rev_history_position - 1]
147
rev = branch.repository.get_revision(rev_id)
149
if rev.revision_id != rev_id:
150
raise BzrCheckError('wrong internal revision id in revision {%s}'
153
# check the previous history entry is a parent of this entry
155
if last_rev_id is not None:
156
for parent_id in rev.parent_ids:
157
if parent_id == last_rev_id:
66
160
raise BzrCheckError("previous revision {%s} not listed among "
68
162
% (last_rev_id, rev_id))
70
for prr in rev.parents:
71
if prr.revision_sha1 is None:
72
missing_revision_sha_cnt += 1
74
prid = prr.revision_id
75
actual_sha = branch.get_revision_sha1(prid)
76
if prr.revision_sha1 != actual_sha:
77
raise BzrCheckError("mismatched revision sha1 for "
78
"parent {%s} of {%s}: %s vs %s"
80
prr.revision_sha1, actual_sha))
82
raise BzrCheckError("revision {%s} has no parents listed but preceded "
84
% (rev_id, last_rev_id))
86
## TODO: Check all the required fields are present on the revision.
88
if rev.inventory_sha1:
89
inv_sha1 = branch.get_inventory_sha1(rev.inventory_id)
90
if inv_sha1 != rev.inventory_sha1:
91
raise BzrCheckError('Inventory sha1 hash doesn\'t match'
92
' value in revision {%s}' % rev_id)
94
missing_inventory_sha_cnt += 1
95
mutter("no inventory_sha1 on revision {%s}" % rev_id)
97
inv = branch.get_inventory(rev.inventory_id)
101
## p('revision %d/%d file ids' % (revno, revcount))
103
if file_id in seen_ids:
104
raise BzrCheckError('duplicated file_id {%s} '
105
'in inventory for revision {%s}'
107
seen_ids[file_id] = True
117
if ie.parent_id != None:
118
if ie.parent_id not in seen_ids:
119
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
120
% (ie.parent_id, rev_id))
122
if ie.kind == 'file':
123
if ie.text_id in checked_texts:
124
fp = checked_texts[ie.text_id]
163
for parent in rev.parent_ids:
164
if not parent in self.planned_revisions:
165
missing_links = self.missing_parent_links.get(parent, [])
166
missing_links.append(rev_id)
167
self.missing_parent_links[parent] = missing_links
168
# list based so somewhat slow,
169
# TODO have a planned_revisions list and set.
170
if self.branch.repository.has_revision(parent):
171
missing_ancestry = self.repository.get_ancestry(parent)
172
for missing in missing_ancestry:
173
if (missing is not None
174
and missing not in self.planned_revisions):
175
self.planned_revisions.append(missing)
126
if not ie.text_id in branch.text_store:
127
raise BzrCheckError('text {%s} not in text_store' % ie.text_id)
129
tf = branch.text_store[ie.text_id]
130
fp = fingerprint_file(tf)
131
checked_texts[ie.text_id] = fp
133
if ie.text_size != fp['size']:
134
raise BzrCheckError('text {%s} wrong size' % ie.text_id)
135
if ie.text_sha1 != fp['sha1']:
136
raise BzrCheckError('text {%s} wrong sha1' % ie.text_id)
137
elif ie.kind == 'directory':
138
if ie.text_sha1 != None or ie.text_size != None or ie.text_id != None:
139
raise BzrCheckError('directory {%s} has text in revision {%s}'
143
for path, ie in inv.iter_entries():
144
if path in seen_names:
145
raise BzrCheckError('duplicated path %s '
146
'in inventory for revision {%s}'
177
self.ghosts.append(rev_id)
179
raise BzrCheckError("revision {%s} has no parents listed "
180
"but preceded by {%s}"
181
% (rev_id, last_rev_id))
183
if rev.inventory_sha1:
184
inv_sha1 = branch.repository.get_inventory_sha1(rev_id)
185
if inv_sha1 != rev.inventory_sha1:
186
raise BzrCheckError('Inventory sha1 hash doesn\'t match'
187
' value in revision {%s}' % rev_id)
189
missing_inventory_sha_cnt += 1
190
mutter("no inventory_sha1 on revision {%s}", rev_id)
191
self._check_revision_tree(rev_id)
192
self.checked_rev_cnt += 1
194
def check_weaves(self):
195
"""Check all the weaves we can get our hands on.
199
if self.branch.repository.weave_store.listable():
200
weave_ids = list(self.branch.repository.weave_store)
201
n_weaves = len(weave_ids)
202
self.progress.update('checking weave', 0, n_weaves)
203
self.inventory_weave.check(progress_bar=self.progress)
204
for i, weave_id in enumerate(weave_ids):
205
self.progress.update('checking weave', i, n_weaves)
206
w = self.branch.repository.weave_store.get_weave(weave_id,
207
self.branch.repository.get_transaction())
208
# No progress here, because it looks ugly.
210
self.checked_weaves[weave_id] = True
212
def _check_revision_tree(self, rev_id):
213
tree = self.branch.repository.revision_tree(rev_id)
217
if file_id in seen_ids:
218
raise BzrCheckError('duplicated file_id {%s} '
219
'in inventory for revision {%s}'
221
seen_ids[file_id] = True
224
ie.check(self, rev_id, inv, tree)
226
for path, ie in inv.iter_entries():
227
if path in seen_names:
228
raise BzrCheckError('duplicated path %s '
229
'in inventory for revision {%s}'
148
231
seen_names[path] = True
156
print 'checked %d revisions, %d file texts' % (revcount, len(checked_texts))
158
if missing_inventory_sha_cnt:
159
print '%d revisions are missing inventory_sha1' % missing_inventory_sha_cnt
161
if missing_revision_sha_cnt:
162
print '%d parent links are missing revision_sha1' % missing_revision_sha_cnt
164
if (missing_inventory_sha_cnt
165
or missing_revision_sha_cnt):
166
print ' (use "bzr upgrade" to fix them)'
234
def check(branch, verbose):
235
"""Run consistency checks on a branch."""
236
checker = Check(branch)
238
checker.report_results(verbose)
added
removed
bzrlib/check.py
