~bzr-pqm/bzr/bzr.dev

1 by mbp at sourcefrog
import from baz patch-364
1
# Copyright (C) 2004, 2005 by Martin Pool
2
# Copyright (C) 2005 by Canonical Ltd
3
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
8
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
# GNU General Public License for more details.
13
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
1104 by Martin Pool
- Add a simple UIFactory
18
import bzrlib.ui
1 by mbp at sourcefrog
import from baz patch-364
19
909 by Martin Pool
- merge John's code to give the tree root an explicit file id
20
def _update_store_entry(obj, obj_id, branch, store_name, store):
21
    """This is just a meta-function, which handles both revision entries
22
    and inventory entries.
23
    """
24
    from bzrlib.trace import mutter
25
    import tempfile, os, errno
26
    from osutils import rename
27
    obj_tmp = tempfile.TemporaryFile()
28
    obj.write_xml(obj_tmp)
29
    obj_tmp.seek(0)
30
31
    tmpfd, tmp_path = tempfile.mkstemp(prefix=obj_id, suffix='.gz',
32
        dir=branch.controlfilename(store_name))
33
    os.close(tmpfd)
34
    try:
35
        orig_obj_path = branch.controlfilename([store_name, obj_id+'.gz'])
36
        # Remove the old entry out of the way
37
        rename(orig_obj_path, tmp_path)
38
        try:
39
            # TODO: We may need to handle the case where the old
40
            # entry was not compressed (and thus did not end with .gz)
41
42
            store.add(obj_tmp, obj_id) # Add the new one
43
            os.remove(tmp_path) # Remove the old name
44
            mutter('    Updated %s entry {%s}' % (store_name, obj_id))
45
        except:
46
            # On any exception, restore the old entry
47
            rename(tmp_path, orig_obj_path)
48
            raise
49
    finally:
50
        if os.path.exists(tmp_path):
51
            # Unfortunately, the next command might throw
52
            # an exception, which will mask a previous exception.
53
            os.remove(tmp_path)
54
        obj_tmp.close()
55
56
def _update_revision_entry(rev, branch):
57
    """After updating the values in a revision, make sure to
58
    write out the data, but try to do it in an atomic manner.
59
60
    :param rev:    The Revision object to store
61
    :param branch: The Branch object where this Revision is to be stored.
62
    """
63
    _update_store_entry(rev, rev.revision_id, branch,
64
            'revision-store', branch.revision_store)
65
66
def _update_inventory_entry(inv, inv_id, branch):
67
    """When an inventory has been modified (such as by adding a unique tree root)
68
    this atomically re-generates the file.
69
70
    :param inv:     The Inventory
71
    :param inv_id:  The inventory id for this inventory
72
    :param branch:  The Branch where this entry will be stored.
73
    """
74
    _update_store_entry(inv, inv_id, branch,
75
            'inventory-store', branch.inventory_store)
1 by mbp at sourcefrog
import from baz patch-364
76
1104 by Martin Pool
- Add a simple UIFactory
77
703 by Martin Pool
- split out a new 'bzr upgrade' command separate from
78
def check(branch):
654 by Martin Pool
- update check command to use aaron's progress code
79
    """Run consistency checks on a branch.
705 by Martin Pool
- updated check for revision parents and sha1
80
813 by Martin Pool
doc
81
    TODO: Also check non-mainline revisions mentioned as parents.
82
83
    TODO: Check for extra files in the control directory.
654 by Martin Pool
- update check command to use aaron's progress code
84
    """
651 by Martin Pool
- clean up imports
85
    from bzrlib.trace import mutter
1118 by Martin Pool
- bzr check doesn't abort when trying to read a revision that's not
86
    from bzrlib.errors import BzrCheckError, NoSuchRevision
651 by Martin Pool
- clean up imports
87
    from bzrlib.osutils import fingerprint_file
909 by Martin Pool
- merge John's code to give the tree root an explicit file id
88
    from bzrlib.inventory import ROOT_ID
89
    from bzrlib.branch import gen_root_id
676 by Martin Pool
- lock branch while checking
90
703 by Martin Pool
- split out a new 'bzr upgrade' command separate from
91
    branch.lock_read()
676 by Martin Pool
- lock branch while checking
92
93
    try:
705 by Martin Pool
- updated check for revision parents and sha1
94
        last_rev_id = None
676 by Martin Pool
- lock branch while checking
95
96
        missing_inventory_sha_cnt = 0
705 by Martin Pool
- updated check for revision parents and sha1
97
        missing_revision_sha_cnt = 0
1118 by Martin Pool
- bzr check doesn't abort when trying to read a revision that's not
98
        missing_revision_cnt = 0
676 by Martin Pool
- lock branch while checking
99
100
        history = branch.revision_history()
101
        revno = 0
102
        revcount = len(history)
819 by Martin Pool
- check command checks that all inventory-ids are the same as in the revision.
103
        mismatch_inv_id = []
676 by Martin Pool
- lock branch while checking
104
705 by Martin Pool
- updated check for revision parents and sha1
105
        # for all texts checked, text_id -> sha1
676 by Martin Pool
- lock branch while checking
106
        checked_texts = {}
107
1104 by Martin Pool
- Add a simple UIFactory
108
        progress = bzrlib.ui.ui_factory.progress_bar()
109
703 by Martin Pool
- split out a new 'bzr upgrade' command separate from
110
        for rev_id in history:
676 by Martin Pool
- lock branch while checking
111
            revno += 1
1104 by Martin Pool
- Add a simple UIFactory
112
            progress.update('checking revision', revno, revcount)
1097 by Martin Pool
- send trace messages out through python logging module
113
            # mutter('    revision {%s}' % rev_id)
703 by Martin Pool
- split out a new 'bzr upgrade' command separate from
114
            rev = branch.get_revision(rev_id)
115
            if rev.revision_id != rev_id:
705 by Martin Pool
- updated check for revision parents and sha1
116
                raise BzrCheckError('wrong internal revision id in revision {%s}'
117
                                    % rev_id)
118
119
            # check the previous history entry is a parent of this entry
120
            if rev.parents:
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:
127
                        break
128
                else:
129
                    raise BzrCheckError("previous revision {%s} not listed among "
130
                                        "parents of {%s}"
131
                                        % (last_rev_id, rev_id))
132
133
                for prr in rev.parents:
134
                    if prr.revision_sha1 is None:
135
                        missing_revision_sha_cnt += 1
136
                        continue
137
                    prid = prr.revision_id
1118 by Martin Pool
- bzr check doesn't abort when trying to read a revision that's not
138
                    
139
                    try:
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",
144
                               prid, rev_id)
145
                        continue
146
                        
705 by Martin Pool
- updated check for revision parents and sha1
147
                    if prr.revision_sha1 != actual_sha:
148
                        raise BzrCheckError("mismatched revision sha1 for "
149
                                            "parent {%s} of {%s}: %s vs %s"
150
                                            % (prid, rev_id,
151
                                               prr.revision_sha1, actual_sha))
152
            elif last_rev_id:
153
                raise BzrCheckError("revision {%s} has no parents listed but preceded "
154
                                    "by {%s}"
155
                                    % (rev_id, last_rev_id))
676 by Martin Pool
- lock branch while checking
156
819 by Martin Pool
- check command checks that all inventory-ids are the same as in the revision.
157
            if rev.inventory_id != rev_id:
158
                mismatch_inv_id.append(rev_id)
159
676 by Martin Pool
- lock branch while checking
160
            ## TODO: Check all the required fields are present on the revision.
161
162
            if rev.inventory_sha1:
163
                inv_sha1 = branch.get_inventory_sha1(rev.inventory_id)
164
                if inv_sha1 != rev.inventory_sha1:
165
                    raise BzrCheckError('Inventory sha1 hash doesn\'t match'
703 by Martin Pool
- split out a new 'bzr upgrade' command separate from
166
                        ' value in revision {%s}' % rev_id)
676 by Martin Pool
- lock branch while checking
167
            else:
168
                missing_inventory_sha_cnt += 1
703 by Martin Pool
- split out a new 'bzr upgrade' command separate from
169
                mutter("no inventory_sha1 on revision {%s}" % rev_id)
676 by Martin Pool
- lock branch while checking
170
171
            inv = branch.get_inventory(rev.inventory_id)
172
            seen_ids = {}
173
            seen_names = {}
174
175
            ## p('revision %d/%d file ids' % (revno, revcount))
176
            for file_id in inv:
177
                if file_id in seen_ids:
178
                    raise BzrCheckError('duplicated file_id {%s} '
179
                                        'in inventory for revision {%s}'
703 by Martin Pool
- split out a new 'bzr upgrade' command separate from
180
                                        % (file_id, rev_id))
676 by Martin Pool
- lock branch while checking
181
                seen_ids[file_id] = True
182
183
            i = 0
184
            for file_id in inv:
185
                i += 1
186
                if i & 31 == 0:
1104 by Martin Pool
- Add a simple UIFactory
187
                    progress.tick()
676 by Martin Pool
- lock branch while checking
188
189
                ie = inv[file_id]
190
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}'
703 by Martin Pool
- split out a new 'bzr upgrade' command separate from
194
                                % (ie.parent_id, rev_id))
676 by Martin Pool
- lock branch while checking
195
196
                if ie.kind == 'file':
197
                    if ie.text_id in checked_texts:
198
                        fp = checked_texts[ie.text_id]
199
                    else:
200
                        if not ie.text_id in branch.text_store:
201
                            raise BzrCheckError('text {%s} not in text_store' % ie.text_id)
202
203
                        tf = branch.text_store[ie.text_id]
204
                        fp = fingerprint_file(tf)
205
                        checked_texts[ie.text_id] = fp
206
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}'
703 by Martin Pool
- split out a new 'bzr upgrade' command separate from
214
                                % (file_id, rev_id))
676 by Martin Pool
- lock branch while checking
215
1104 by Martin Pool
- Add a simple UIFactory
216
            progress.tick()
676 by Martin Pool
- lock branch while checking
217
            for path, ie in inv.iter_entries():
218
                if path in seen_names:
703 by Martin Pool
- split out a new 'bzr upgrade' command separate from
219
                    raise BzrCheckError('duplicated path %s '
676 by Martin Pool
- lock branch while checking
220
                                        'in inventory for revision {%s}'
703 by Martin Pool
- split out a new 'bzr upgrade' command separate from
221
                                        % (path, rev_id))
543 by Martin Pool
- More cleanups for set type
222
            seen_names[path] = True
705 by Martin Pool
- updated check for revision parents and sha1
223
            last_rev_id = rev_id
125 by mbp at sourcefrog
- check progress indicator for file texts
224
676 by Martin Pool
- lock branch while checking
225
    finally:
226
        branch.unlock()
121 by mbp at sourcefrog
- progress indicator while checking
227
1104 by Martin Pool
- Add a simple UIFactory
228
    progress.clear()
674 by Martin Pool
- check command now also checks new inventory_sha1 and
229
248 by mbp at sourcefrog
- Better progress and completion indicator from check command
230
    print 'checked %d revisions, %d file texts' % (revcount, len(checked_texts))
705 by Martin Pool
- updated check for revision parents and sha1
231
    
674 by Martin Pool
- check command now also checks new inventory_sha1 and
232
    if missing_inventory_sha_cnt:
233
        print '%d revisions are missing inventory_sha1' % missing_inventory_sha_cnt
705 by Martin Pool
- updated check for revision parents and sha1
234
235
    if missing_revision_sha_cnt:
236
        print '%d parent links are missing revision_sha1' % missing_revision_sha_cnt
237
1118 by Martin Pool
- bzr check doesn't abort when trying to read a revision that's not
238
    if missing_revision_cnt:
239
        print '%d revisions are mentioned but not present' % missing_revision_cnt
240
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
241
    # stub this out for now because the main bzr branch has references
242
    # to revisions that aren't present in the store -- mbp 20050804
243
#    if (missing_inventory_sha_cnt
244
#        or missing_revision_sha_cnt):
245
#        print '  (use "bzr upgrade" to fix them)'
819 by Martin Pool
- check command checks that all inventory-ids are the same as in the revision.
246
247
    if mismatch_inv_id:
248
        print '%d revisions have mismatched inventory ids:' % len(mismatch_inv_id)
249
        for rev_id in mismatch_inv_id:
250
            print '  ', rev_id