1
# Copyright (C) 2004, 2005 by Martin Pool
2
# Copyright (C) 2005 by Canonical Ltd
1
# Copyright (C) 2005, 2006 Canonical Ltd
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
6
5
# the Free Software Foundation; either version 2 of the License, or
7
6
# (at your option) any later version.
9
8
# This program is distributed in the hope that it will be useful,
10
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
11
# GNU General Public License for more details.
14
13
# You should have received a copy of the GNU General Public License
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
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
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)
37
from bzrlib.trace import note
40
"""Check a repository"""
42
# The Check object interacts with InventoryEntry.check, etc.
44
def __init__(self, repository):
45
self.repository = repository
46
self.checked_text_cnt = 0
47
self.checked_rev_cnt = 0
49
self.repeated_text_cnt = 0
50
self.missing_parent_links = {}
51
self.missing_inventory_sha_cnt = 0
52
self.missing_revision_cnt = 0
53
# maps (file-id, version) -> sha1; used by InventoryFile._check
54
self.checked_texts = {}
55
self.checked_weaves = {}
58
self.repository.lock_read()
59
self.progress = bzrlib.ui.ui_factory.nested_progress_bar()
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
raise NotImplementedError("can't update existing inventory entry")
61
self.progress.update('retrieving inventory', 0, 0)
62
# do not put in init, as it should be done with progess,
63
# and inside the lock.
64
self.inventory_weave = self.repository.get_inventory_weave()
68
while revno < len(self.planned_revisions):
69
rev_id = self.planned_revisions[revno]
70
self.progress.update('checking revision', revno,
71
len(self.planned_revisions))
73
self.check_one_rev(rev_id)
75
self.progress.finished()
76
self.repository.unlock()
78
def plan_revisions(self):
79
repository = self.repository
80
self.planned_revisions = set(repository.all_revision_ids())
82
inventoried = set(self.inventory_weave.versions())
83
awol = self.planned_revisions - inventoried
85
raise BzrCheckError('Stored revisions missing from inventory'
86
'{%s}' % ','.join([f for f in awol]))
87
self.planned_revisions = list(self.planned_revisions)
89
def report_results(self, verbose):
90
note('checked repository %s format %s',
91
self.repository.bzrdir.root_transport,
92
self.repository._format)
93
note('%6d revisions', self.checked_rev_cnt)
94
note('%6d unique file texts', self.checked_text_cnt)
95
note('%6d repeated file texts', self.repeated_text_cnt)
96
note('%6d weaves', len(self.checked_weaves))
97
if self.missing_inventory_sha_cnt:
98
note('%6d revisions are missing inventory_sha1',
99
self.missing_inventory_sha_cnt)
100
if self.missing_revision_cnt:
101
note('%6d revisions are mentioned but not present',
102
self.missing_revision_cnt)
104
note('%6d ghost revisions', len(self.ghosts))
106
for ghost in self.ghosts:
108
if len(self.missing_parent_links):
109
note('%6d revisions missing parents in ancestry',
110
len(self.missing_parent_links))
112
for link, linkers in self.missing_parent_links.items():
113
note(' %s should be in the ancestry for:', link)
114
for linker in linkers:
115
note(' * %s', linker)
117
def check_one_rev(self, rev_id):
118
"""Check one revision.
120
rev_id - the one to check
122
rev = self.repository.get_revision(rev_id)
124
if rev.revision_id != rev_id:
125
raise BzrCheckError('wrong internal revision id in revision {%s}'
128
for parent in rev.parent_ids:
129
if not parent in self.planned_revisions:
130
missing_links = self.missing_parent_links.get(parent, [])
131
missing_links.append(rev_id)
132
self.missing_parent_links[parent] = missing_links
133
# list based so somewhat slow,
134
# TODO have a planned_revisions list and set.
135
if self.repository.has_revision(parent):
136
missing_ancestry = self.repository.get_ancestry(parent)
137
for missing in missing_ancestry:
138
if (missing is not None
139
and missing not in self.planned_revisions):
140
self.planned_revisions.append(missing)
142
self.ghosts.append(rev_id)
144
if rev.inventory_sha1:
145
inv_sha1 = self.repository.get_inventory_sha1(rev_id)
146
if inv_sha1 != rev.inventory_sha1:
147
raise BzrCheckError('Inventory sha1 hash doesn\'t match'
148
' value in revision {%s}' % rev_id)
149
self._check_revision_tree(rev_id)
150
self.checked_rev_cnt += 1
152
def check_weaves(self):
153
"""Check all the weaves we can get our hands on.
157
if self.repository.weave_store.listable():
158
weave_ids = list(self.repository.weave_store)
159
n_weaves = len(weave_ids)
160
self.progress.update('checking weave', 0, n_weaves)
161
self.inventory_weave.check(progress_bar=self.progress)
162
for i, weave_id in enumerate(weave_ids):
163
self.progress.update('checking weave', i, n_weaves)
164
w = self.repository.weave_store.get_weave(weave_id,
165
self.repository.get_transaction())
166
# No progress here, because it looks ugly.
168
self.checked_weaves[weave_id] = True
170
def _check_revision_tree(self, rev_id):
171
tree = self.repository.revision_tree(rev_id)
175
if file_id in seen_ids:
176
raise BzrCheckError('duplicated file_id {%s} '
177
'in inventory for revision {%s}'
179
seen_ids[file_id] = True
182
ie.check(self, rev_id, inv, tree)
184
for path, ie in inv.iter_entries():
185
if path in seen_names:
186
raise BzrCheckError('duplicated path %s '
187
'in inventory for revision {%s}'
189
seen_names[path] = True
192
def check(branch, verbose):
79
193
"""Run consistency checks on a branch.
81
TODO: Also check non-mainline revisions mentioned as parents.
83
TODO: Check for extra files in the control directory.
195
Results are reported through logging.
197
:raise BzrCheckError: if there's a consistency error.
85
from bzrlib.trace import mutter
86
from bzrlib.errors import BzrCheckError, NoSuchRevision
87
from bzrlib.osutils import fingerprint_file
88
from bzrlib.inventory import ROOT_ID
89
from bzrlib.branch import gen_root_id
91
199
branch.lock_read()
96
missing_inventory_sha_cnt = 0
97
missing_revision_sha_cnt = 0
98
missing_revision_cnt = 0
100
history = branch.revision_history()
102
revcount = len(history)
105
# for all texts checked, text_id -> sha1
108
progress = bzrlib.ui.ui_factory.progress_bar()
110
for rev_id in history:
112
progress.update('checking revision', revno, revcount)
113
# mutter(' revision {%s}' % rev_id)
114
rev = branch.get_revision(rev_id)
115
if rev.revision_id != rev_id:
116
raise BzrCheckError('wrong internal revision id in revision {%s}'
119
# check the previous history entry is a parent of this entry
121
if last_rev_id is None:
122
raise BzrCheckError("revision {%s} has %d parents, but is the "
123
"start of the branch"
124
% (rev_id, len(rev.parents)))
125
for prr in rev.parents:
126
if prr.revision_id == last_rev_id:
129
raise BzrCheckError("previous revision {%s} not listed among "
131
% (last_rev_id, rev_id))
133
for prr in rev.parents:
134
if prr.revision_sha1 is None:
135
missing_revision_sha_cnt += 1
137
prid = prr.revision_id
140
actual_sha = branch.get_revision_sha1(prid)
141
except NoSuchRevision:
142
missing_revision_cnt += 1
143
mutter("parent {%s} of {%s} not present in store",
147
if prr.revision_sha1 != actual_sha:
148
raise BzrCheckError("mismatched revision sha1 for "
149
"parent {%s} of {%s}: %s vs %s"
151
prr.revision_sha1, actual_sha))
153
raise BzrCheckError("revision {%s} has no parents listed but preceded "
155
% (rev_id, last_rev_id))
157
if hasattr(rev, 'inventory_id') and rev.inventory_id != rev_id:
158
mismatch_inv_id.append(rev_id)
160
## TODO: Check all the required fields are present on the revision.
162
if rev.inventory_sha1:
163
inv_sha1 = branch.get_inventory_sha1(rev_id)
164
if inv_sha1 != rev.inventory_sha1:
165
raise BzrCheckError('Inventory sha1 hash doesn\'t match'
166
' value in revision {%s}' % rev_id)
168
missing_inventory_sha_cnt += 1
169
mutter("no inventory_sha1 on revision {%s}" % rev_id)
171
inv = branch.get_inventory(rev_id)
175
## p('revision %d/%d file ids' % (revno, revcount))
177
if file_id in seen_ids:
178
raise BzrCheckError('duplicated file_id {%s} '
179
'in inventory for revision {%s}'
181
seen_ids[file_id] = True
191
if ie.parent_id != None:
192
if ie.parent_id not in seen_ids:
193
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
194
% (ie.parent_id, rev_id))
196
if ie.kind == 'file':
197
if ie.text_id in checked_texts:
198
fp = checked_texts[ie.text_id]
200
if not ie.text_id in branch.text_store:
201
raise BzrCheckError('text {%s} not in text_store' % ie.text_id)
203
tf = branch.text_store[ie.text_id]
204
fp = fingerprint_file(tf)
205
checked_texts[ie.text_id] = fp
207
if ie.text_size != fp['size']:
208
raise BzrCheckError('text {%s} wrong size' % ie.text_id)
209
if ie.text_sha1 != fp['sha1']:
210
raise BzrCheckError('text {%s} wrong sha1' % ie.text_id)
211
elif ie.kind == 'directory':
212
if ie.text_sha1 != None or ie.text_size != None or ie.text_id != None:
213
raise BzrCheckError('directory {%s} has text in revision {%s}'
217
for path, ie in inv.iter_entries():
218
if path in seen_names:
219
raise BzrCheckError('duplicated path %s '
220
'in inventory for revision {%s}'
222
seen_names[path] = True
201
branch_result = branch.check()
202
repo_result = branch.repository.check([branch.last_revision()])
230
note('checked %d revisions, %d file texts' % (revcount, len(checked_texts)))
232
if missing_inventory_sha_cnt:
233
note('%d revisions are missing inventory_sha1' % missing_inventory_sha_cnt)
235
if missing_revision_sha_cnt:
236
note('%d parent links are missing revision_sha1' % missing_revision_sha_cnt)
238
if missing_revision_cnt:
239
note('%d revisions are mentioned but not present' % missing_revision_cnt)
241
if missing_revision_cnt:
242
print '%d revisions are mentioned but not present' % missing_revision_cnt
244
# stub this out for now because the main bzr branch has references
245
# to revisions that aren't present in the store -- mbp 20050804
246
# if (missing_inventory_sha_cnt
247
# or missing_revision_sha_cnt):
248
# print ' (use "bzr upgrade" to fix them)'
251
warning('%d revisions have mismatched inventory ids:' % len(mismatch_inv_id))
252
for rev_id in mismatch_inv_id:
253
warning(' %s', rev_id)
205
branch_result.report_results(verbose)
206
repo_result.report_results(verbose)
added
removed
bzrlib/check.py
