14
15
# along with this program; if not, write to the Free Software
15
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
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
35
from bzrlib.errors import BzrCheckError, NoSuchRevision
36
from bzrlib.symbol_versioning import *
37
from bzrlib.trace import mutter, note, warning
42
"""Check a repository"""
44
# The Check object interacts with InventoryEntry.check, etc.
46
def __init__(self, repository):
47
self.repository = repository
48
self.checked_text_cnt = 0
49
self.checked_rev_cnt = 0
51
self.repeated_text_cnt = 0
52
self.missing_parent_links = {}
53
self.missing_inventory_sha_cnt = 0
54
self.missing_revision_cnt = 0
55
# maps (file-id, version) -> sha1; used by InventoryFile._check
56
self.checked_texts = {}
57
self.checked_weaves = {}
60
self.repository.lock_read()
61
self.progress = bzrlib.ui.ui_factory.nested_progress_bar()
19
from bzrlib.trace import note, warning
21
def _update_store_entry(obj, obj_id, branch, store_name, store):
22
"""This is just a meta-function, which handles both revision entries
23
and inventory entries.
25
from bzrlib.trace import mutter
26
import tempfile, os, errno
27
from osutils import rename
28
obj_tmp = tempfile.TemporaryFile()
29
obj.write_xml(obj_tmp)
32
tmpfd, tmp_path = tempfile.mkstemp(prefix=obj_id, suffix='.gz',
33
dir=branch.controlfilename(store_name))
36
orig_obj_path = branch.controlfilename([store_name, obj_id+'.gz'])
37
# Remove the old entry out of the way
38
rename(orig_obj_path, tmp_path)
63
self.progress.update('retrieving inventory', 0, 0)
64
# do not put in init, as it should be done with progess,
65
# and inside the lock.
66
self.inventory_weave = self.repository.get_inventory_weave()
70
while revno < len(self.planned_revisions):
71
rev_id = self.planned_revisions[revno]
72
self.progress.update('checking revision', revno,
73
len(self.planned_revisions))
75
self.check_one_rev(rev_id)
77
self.progress.finished()
78
self.repository.unlock()
80
def plan_revisions(self):
81
repository = self.repository
82
self.planned_revisions = set(repository.all_revision_ids())
84
inventoried = set(self.inventory_weave.versions())
85
awol = self.planned_revisions - inventoried
87
raise BzrCheckError('Stored revisions missing from inventory'
88
'{%s}' % ','.join([f for f in awol]))
89
self.planned_revisions = list(self.planned_revisions)
91
def report_results(self, verbose):
92
note('checked repository %s format %s',
93
self.repository.bzrdir.root_transport,
94
self.repository._format)
95
note('%6d revisions', self.checked_rev_cnt)
96
note('%6d unique file texts', self.checked_text_cnt)
97
note('%6d repeated file texts', self.repeated_text_cnt)
98
note('%6d weaves', len(self.checked_weaves))
99
if self.missing_inventory_sha_cnt:
100
note('%6d revisions are missing inventory_sha1',
101
self.missing_inventory_sha_cnt)
102
if self.missing_revision_cnt:
103
note('%6d revisions are mentioned but not present',
104
self.missing_revision_cnt)
106
note('%6d ghost revisions', len(self.ghosts))
108
for ghost in self.ghosts:
110
if len(self.missing_parent_links):
111
note('%6d revisions missing parents in ancestry',
112
len(self.missing_parent_links))
114
for link, linkers in self.missing_parent_links.items():
115
note(' %s should be in the ancestry for:', link)
116
for linker in linkers:
117
note(' * %s', linker)
119
def check_one_rev(self, rev_id):
120
"""Check one revision.
122
rev_id - the one to check
124
rev = self.repository.get_revision(rev_id)
126
if rev.revision_id != rev_id:
127
raise BzrCheckError('wrong internal revision id in revision {%s}'
130
for parent in rev.parent_ids:
131
if not parent in self.planned_revisions:
132
missing_links = self.missing_parent_links.get(parent, [])
133
missing_links.append(rev_id)
134
self.missing_parent_links[parent] = missing_links
135
# list based so somewhat slow,
136
# TODO have a planned_revisions list and set.
137
if self.repository.has_revision(parent):
138
missing_ancestry = self.repository.get_ancestry(parent)
139
for missing in missing_ancestry:
140
if (missing is not None
141
and missing not in self.planned_revisions):
142
self.planned_revisions.append(missing)
40
# TODO: We may need to handle the case where the old
41
# entry was not compressed (and thus did not end with .gz)
43
store.add(obj_tmp, obj_id) # Add the new one
44
os.remove(tmp_path) # Remove the old name
45
mutter(' Updated %s entry {%s}' % (store_name, obj_id))
47
# On any exception, restore the old entry
48
rename(tmp_path, orig_obj_path)
51
if os.path.exists(tmp_path):
52
# Unfortunately, the next command might throw
53
# an exception, which will mask a previous exception.
57
def _update_revision_entry(rev, branch):
58
"""After updating the values in a revision, make sure to
59
write out the data, but try to do it in an atomic manner.
61
:param rev: The Revision object to store
62
:param branch: The Branch object where this Revision is to be stored.
64
_update_store_entry(rev, rev.revision_id, branch,
65
'revision-store', branch.revision_store)
67
def _update_inventory_entry(inv, inv_id, branch):
68
"""When an inventory has been modified (such as by adding a unique tree root)
69
this atomically re-generates the file.
71
:param inv: The Inventory
72
:param inv_id: The inventory id for this inventory
73
:param branch: The Branch where this entry will be stored.
75
_update_store_entry(inv, inv_id, branch,
76
'inventory-store', branch.inventory_store)
80
"""Run consistency checks on a branch.
82
TODO: Also check non-mainline revisions mentioned as parents.
84
TODO: Check for extra files in the control directory.
86
from bzrlib.trace import mutter
87
from bzrlib.errors import BzrCheckError, NoSuchRevision
88
from bzrlib.osutils import fingerprint_file
89
from bzrlib.inventory import ROOT_ID
90
from bzrlib.branch import gen_root_id
97
missing_inventory_sha_cnt = 0
98
missing_revision_sha_cnt = 0
99
missing_revision_cnt = 0
101
history = branch.revision_history()
103
revcount = len(history)
106
# for all texts checked, text_id -> sha1
109
progress = bzrlib.ui.ui_factory.progress_bar()
111
for rev_id in history:
113
progress.update('checking revision', revno, revcount)
114
# mutter(' revision {%s}' % rev_id)
115
rev = branch.get_revision(rev_id)
116
if rev.revision_id != rev_id:
117
raise BzrCheckError('wrong internal revision id in revision {%s}'
120
# check the previous history entry is a parent of this entry
122
if last_rev_id is None:
123
raise BzrCheckError("revision {%s} has %d parents, but is the "
124
"start of the branch"
125
% (rev_id, len(rev.parents)))
126
for prr in rev.parents:
127
if prr.revision_id == last_rev_id:
144
self.ghosts.append(rev_id)
146
if rev.inventory_sha1:
147
inv_sha1 = self.repository.get_inventory_sha1(rev_id)
148
if inv_sha1 != rev.inventory_sha1:
149
raise BzrCheckError('Inventory sha1 hash doesn\'t match'
150
' value in revision {%s}' % rev_id)
152
self.missing_inventory_sha_cnt += 1
153
mutter("no inventory_sha1 on revision {%s}", rev_id)
154
self._check_revision_tree(rev_id)
155
self.checked_rev_cnt += 1
157
def check_weaves(self):
158
"""Check all the weaves we can get our hands on.
162
if self.repository.weave_store.listable():
163
weave_ids = list(self.repository.weave_store)
164
n_weaves = len(weave_ids)
165
self.progress.update('checking weave', 0, n_weaves)
166
self.inventory_weave.check(progress_bar=self.progress)
167
for i, weave_id in enumerate(weave_ids):
168
self.progress.update('checking weave', i, n_weaves)
169
w = self.repository.weave_store.get_weave(weave_id,
170
self.repository.get_transaction())
171
# No progress here, because it looks ugly.
173
self.checked_weaves[weave_id] = True
175
def _check_revision_tree(self, rev_id):
176
tree = self.repository.revision_tree(rev_id)
180
if file_id in seen_ids:
181
raise BzrCheckError('duplicated file_id {%s} '
182
'in inventory for revision {%s}'
184
seen_ids[file_id] = True
187
ie.check(self, rev_id, inv, tree)
189
for path, ie in inv.iter_entries():
190
if path in seen_names:
191
raise BzrCheckError('duplicated path %s '
192
'in inventory for revision {%s}'
130
raise BzrCheckError("previous revision {%s} not listed among "
132
% (last_rev_id, rev_id))
134
for prr in rev.parents:
135
if prr.revision_sha1 is None:
136
missing_revision_sha_cnt += 1
138
prid = prr.revision_id
141
actual_sha = branch.get_revision_sha1(prid)
142
except NoSuchRevision:
143
missing_revision_cnt += 1
144
mutter("parent {%s} of {%s} not present in store",
148
if prr.revision_sha1 != actual_sha:
149
raise BzrCheckError("mismatched revision sha1 for "
150
"parent {%s} of {%s}: %s vs %s"
152
prr.revision_sha1, actual_sha))
154
raise BzrCheckError("revision {%s} has no parents listed but preceded "
156
% (rev_id, last_rev_id))
158
if rev.inventory_id != rev_id:
159
mismatch_inv_id.append(rev_id)
161
## TODO: Check all the required fields are present on the revision.
163
if rev.inventory_sha1:
164
inv_sha1 = branch.get_inventory_sha1(rev.inventory_id)
165
if inv_sha1 != rev.inventory_sha1:
166
raise BzrCheckError('Inventory sha1 hash doesn\'t match'
167
' value in revision {%s}' % rev_id)
169
missing_inventory_sha_cnt += 1
170
mutter("no inventory_sha1 on revision {%s}" % rev_id)
172
inv = branch.get_inventory(rev.inventory_id)
176
## p('revision %d/%d file ids' % (revno, revcount))
178
if file_id in seen_ids:
179
raise BzrCheckError('duplicated file_id {%s} '
180
'in inventory for revision {%s}'
182
seen_ids[file_id] = True
192
if ie.parent_id != None:
193
if ie.parent_id not in seen_ids:
194
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
195
% (ie.parent_id, rev_id))
197
if ie.kind == 'file':
198
if ie.text_id in checked_texts:
199
fp = checked_texts[ie.text_id]
201
if not ie.text_id in branch.text_store:
202
raise BzrCheckError('text {%s} not in text_store' % ie.text_id)
204
tf = branch.text_store[ie.text_id]
205
fp = fingerprint_file(tf)
206
checked_texts[ie.text_id] = fp
208
if ie.text_size != fp['size']:
209
raise BzrCheckError('text {%s} wrong size' % ie.text_id)
210
if ie.text_sha1 != fp['sha1']:
211
raise BzrCheckError('text {%s} wrong sha1' % ie.text_id)
212
elif ie.kind == 'directory':
213
if ie.text_sha1 != None or ie.text_size != None or ie.text_id != None:
214
raise BzrCheckError('directory {%s} has text in revision {%s}'
218
for path, ie in inv.iter_entries():
219
if path in seen_names:
220
raise BzrCheckError('duplicated path %s '
221
'in inventory for revision {%s}'
194
223
seen_names[path] = True
197
def check(branch, verbose):
198
"""Run consistency checks on a branch.
200
Results are reported through logging.
202
:raise BzrCheckError: if there's a consistency error.
206
branch_result = branch.check()
207
repo_result = branch.repository.check([branch.last_revision()])
210
branch_result.report_results(verbose)
211
repo_result.report_results(verbose)
231
note('checked %d revisions, %d file texts' % (revcount, len(checked_texts)))
233
if missing_inventory_sha_cnt:
234
note('%d revisions are missing inventory_sha1' % missing_inventory_sha_cnt)
236
if missing_revision_sha_cnt:
237
note('%d parent links are missing revision_sha1' % missing_revision_sha_cnt)
239
if missing_revision_cnt:
240
note('%d revisions are mentioned but not present' % missing_revision_cnt)
242
if missing_revision_cnt:
243
print '%d revisions are mentioned but not present' % missing_revision_cnt
245
# stub this out for now because the main bzr branch has references
246
# to revisions that aren't present in the store -- mbp 20050804
247
# if (missing_inventory_sha_cnt
248
# or missing_revision_sha_cnt):
249
# print ' (use "bzr upgrade" to fix them)'
252
warning('%d revisions have mismatched inventory ids:' % len(mismatch_inv_id))
253
for rev_id in mismatch_inv_id:
254
warning(' %s', rev_id)
added
removed
bzrlib/check.py
