1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
|
# Copyright (C) 2006-2010 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""Tests for reconciliation of repositories."""
import bzrlib
from bzrlib import (
errors,
)
from bzrlib.bzrdir import BzrDir
from bzrlib.inventory import Inventory
from bzrlib.reconcile import reconcile, Reconciler
from bzrlib.revision import Revision
from bzrlib.tests import TestSkipped
from bzrlib.tests.per_repository_vf.helpers import (
TestCaseWithBrokenRevisionIndex,
)
from bzrlib.tests.per_repository_vf import (
TestCaseWithRepository,
all_repository_vf_format_scenarios,
)
from bzrlib.tests.matchers import MatchesAncestry
from bzrlib.tests.scenarios import load_tests_apply_scenarios
from bzrlib.uncommit import uncommit
load_tests = load_tests_apply_scenarios
class TestReconcile(TestCaseWithRepository):
scenarios = all_repository_vf_format_scenarios()
def checkUnreconciled(self, d, reconciler):
"""Check that d did not get reconciled."""
# nothing should have been fixed yet:
self.assertEqual(0, reconciler.inconsistent_parents)
# and no garbage inventories
self.assertEqual(0, reconciler.garbage_inventories)
self.checkNoBackupInventory(d)
def checkNoBackupInventory(self, aBzrDir):
"""Check that there is no backup inventory in aBzrDir."""
repo = aBzrDir.open_repository()
for path in repo.control_transport.list_dir('.'):
self.assertFalse('inventory.backup' in path)
class TestBadRevisionParents(TestCaseWithBrokenRevisionIndex):
scenarios = all_repository_vf_format_scenarios()
def test_aborts_if_bad_parents_in_index(self):
"""Reconcile refuses to proceed if the revision index is wrong when
checked against the revision texts, so that it does not generate broken
data.
Ideally reconcile would fix this, but until we implement that we just
make sure we safely detect this problem.
"""
repo = self.make_repo_with_extra_ghost_index()
reconciler = repo.reconcile(thorough=True)
self.assertTrue(reconciler.aborted,
"reconcile should have aborted due to bad parents.")
def test_does_not_abort_on_clean_repo(self):
repo = self.make_repository('.')
reconciler = repo.reconcile(thorough=True)
self.assertFalse(reconciler.aborted,
"reconcile should not have aborted on an unbroken repository.")
class TestsNeedingReweave(TestReconcile):
def setUp(self):
super(TestsNeedingReweave, self).setUp()
t = self.get_transport()
# an empty inventory with no revision for testing with.
repo = self.make_repository('inventory_without_revision')
repo.lock_write()
repo.start_write_group()
inv = Inventory(revision_id='missing')
inv.root.revision = 'missing'
repo.add_inventory('missing', inv, [])
repo.commit_write_group()
repo.unlock()
def add_commit(repo, revision_id, parent_ids):
repo.lock_write()
repo.start_write_group()
inv = Inventory(revision_id=revision_id)
inv.root.revision = revision_id
root_id = inv.root.file_id
sha1 = repo.add_inventory(revision_id, inv, parent_ids)
repo.texts.add_lines((root_id, revision_id), [], [])
rev = bzrlib.revision.Revision(timestamp=0,
timezone=None,
committer="Foo Bar <foo@example.com>",
message="Message",
inventory_sha1=sha1,
revision_id=revision_id)
rev.parent_ids = parent_ids
repo.add_revision(revision_id, rev)
repo.commit_write_group()
repo.unlock()
# an empty inventory with no revision for testing with.
# this is referenced by 'references_missing' to let us test
# that all the cached data is correctly converted into ghost links
# and the referenced inventory still cleaned.
repo = self.make_repository('inventory_without_revision_and_ghost')
repo.lock_write()
repo.start_write_group()
repo.add_inventory('missing', inv, [])
repo.commit_write_group()
repo.unlock()
add_commit(repo, 'references_missing', ['missing'])
# a inventory with no parents and the revision has parents..
# i.e. a ghost.
repo = self.make_repository('inventory_one_ghost')
add_commit(repo, 'ghost', ['the_ghost'])
# a inventory with a ghost that can be corrected now.
t.copy_tree('inventory_one_ghost', 'inventory_ghost_present')
bzrdir_url = self.get_url('inventory_ghost_present')
bzrdir = BzrDir.open(bzrdir_url)
repo = bzrdir.open_repository()
add_commit(repo, 'the_ghost', [])
def checkEmptyReconcile(self, **kwargs):
"""Check a reconcile on an empty repository."""
self.make_repository('empty')
d = BzrDir.open(self.get_url('empty'))
# calling on a empty repository should do nothing
reconciler = d.find_repository().reconcile(**kwargs)
# no inconsistent parents should have been found
self.assertEqual(0, reconciler.inconsistent_parents)
# and no garbage inventories
self.assertEqual(0, reconciler.garbage_inventories)
# and no backup weave should have been needed/made.
self.checkNoBackupInventory(d)
def test_reconcile_empty(self):
# in an empty repo, theres nothing to do.
self.checkEmptyReconcile()
def test_repo_has_reconcile_does_inventory_gc_attribute(self):
repo = self.make_repository('repo')
self.assertNotEqual(None, repo._reconcile_does_inventory_gc)
def test_reconcile_empty_thorough(self):
# reconcile should accept thorough=True
self.checkEmptyReconcile(thorough=True)
def test_convenience_reconcile_inventory_without_revision_reconcile(self):
# smoke test for the all in one ui tool
bzrdir_url = self.get_url('inventory_without_revision')
bzrdir = BzrDir.open(bzrdir_url)
repo = bzrdir.open_repository()
if not repo._reconcile_does_inventory_gc:
raise TestSkipped('Irrelevant test')
reconcile(bzrdir)
# now the backup should have it but not the current inventory
repo = bzrdir.open_repository()
self.check_missing_was_removed(repo)
def test_reweave_inventory_without_revision(self):
# an excess inventory on its own is only reconciled by using thorough
d_url = self.get_url('inventory_without_revision')
d = BzrDir.open(d_url)
repo = d.open_repository()
if not repo._reconcile_does_inventory_gc:
raise TestSkipped('Irrelevant test')
self.checkUnreconciled(d, repo.reconcile())
reconciler = repo.reconcile(thorough=True)
# no bad parents
self.assertEqual(0, reconciler.inconsistent_parents)
# and one garbage inventory
self.assertEqual(1, reconciler.garbage_inventories)
self.check_missing_was_removed(repo)
def check_thorough_reweave_missing_revision(self, aBzrDir, reconcile,
**kwargs):
# actual low level test.
repo = aBzrDir.open_repository()
if not repo.has_revision('missing'):
# the repo handles ghosts without corruption, so reconcile has
# nothing to do here. Specifically, this test has the inventory
# 'missing' present and the revision 'missing' missing, so clearly
# 'missing' cannot be reported in the present ancestry -> missing
# is something that can be filled as a ghost.
expected_inconsistent_parents = 0
else:
expected_inconsistent_parents = 1
reconciler = reconcile(**kwargs)
# some number of inconsistent parents should have been found
self.assertEqual(expected_inconsistent_parents,
reconciler.inconsistent_parents)
# and one garbage inventories
self.assertEqual(1, reconciler.garbage_inventories)
# now the backup should have it but not the current inventory
repo = aBzrDir.open_repository()
self.check_missing_was_removed(repo)
# and the parent list for 'references_missing' should have that
# revision a ghost now.
self.assertFalse(repo.has_revision('missing'))
def check_missing_was_removed(self, repo):
if repo._reconcile_backsup_inventory:
backed_up = False
for path in repo.control_transport.list_dir('.'):
if 'inventory.backup' in path:
backed_up = True
self.assertTrue(backed_up)
# Not clear how to do this at an interface level:
# self.assertTrue('missing' in backup.versions())
self.assertRaises(errors.NoSuchRevision, repo.get_inventory, 'missing')
def test_reweave_inventory_without_revision_reconciler(self):
# smoke test for the all in one Reconciler class,
# other tests use the lower level repo.reconcile()
d_url = self.get_url('inventory_without_revision_and_ghost')
d = BzrDir.open(d_url)
if not d.open_repository()._reconcile_does_inventory_gc:
raise TestSkipped('Irrelevant test')
def reconcile():
reconciler = Reconciler(d)
reconciler.reconcile()
return reconciler
self.check_thorough_reweave_missing_revision(d, reconcile)
def test_reweave_inventory_without_revision_and_ghost(self):
# actual low level test.
d_url = self.get_url('inventory_without_revision_and_ghost')
d = BzrDir.open(d_url)
repo = d.open_repository()
if not repo._reconcile_does_inventory_gc:
raise TestSkipped('Irrelevant test')
# nothing should have been altered yet : inventories without
# revisions are not data loss incurring for current format
self.check_thorough_reweave_missing_revision(d, repo.reconcile,
thorough=True)
def test_reweave_inventory_preserves_a_revision_with_ghosts(self):
d = BzrDir.open(self.get_url('inventory_one_ghost'))
reconciler = d.open_repository().reconcile(thorough=True)
# no inconsistent parents should have been found:
# the lack of a parent for ghost is normal
self.assertEqual(0, reconciler.inconsistent_parents)
# and one garbage inventories
self.assertEqual(0, reconciler.garbage_inventories)
# now the current inventory should still have 'ghost'
repo = d.open_repository()
repo.get_inventory('ghost')
self.assertThat(['ghost', 'the_ghost'], MatchesAncestry(repo, 'ghost'))
def test_reweave_inventory_fixes_ancestryfor_a_present_ghost(self):
d = BzrDir.open(self.get_url('inventory_ghost_present'))
repo = d.open_repository()
m = MatchesAncestry(repo, 'ghost')
if m.match(['the_ghost', 'ghost']) is None:
# the repo handles ghosts without corruption, so reconcile has
# nothing to do
return
self.assertThat(['ghost'], m)
reconciler = repo.reconcile()
# this is a data corrupting error, so a normal reconcile should fix it.
# one inconsistent parents should have been found : the
# available but not reference parent for ghost.
self.assertEqual(1, reconciler.inconsistent_parents)
# and no garbage inventories
self.assertEqual(0, reconciler.garbage_inventories)
# now the current inventory should still have 'ghost'
repo = d.open_repository()
repo.get_inventory('ghost')
repo.get_inventory('the_ghost')
self.assertThat(['the_ghost', 'ghost'],
MatchesAncestry(repo, 'ghost'))
self.assertThat(['the_ghost'],
MatchesAncestry(repo, 'the_ghost'))
def test_text_from_ghost_revision(self):
repo = self.make_repository('text-from-ghost')
inv = Inventory(revision_id='final-revid')
inv.root.revision = 'root-revid'
ie = inv.add_path('bla', 'file', 'myfileid')
ie.revision = 'ghostrevid'
ie.text_size = 42
ie.text_sha1 = "bee68c8acd989f5f1765b4660695275948bf5c00"
rev = bzrlib.revision.Revision(timestamp=0,
timezone=None,
committer="Foo Bar <foo@example.com>",
message="Message",
revision_id='final-revid')
repo.lock_write()
try:
repo.start_write_group()
try:
repo.add_revision('final-revid', rev, inv)
try:
repo.texts.add_lines(('myfileid', 'ghostrevid'),
(('myfileid', 'ghost-text-parent'),),
["line1\n", "line2\n"])
except errors.RevisionNotPresent:
raise TestSkipped("text ghost parents not supported")
if repo.supports_rich_root():
root_id = inv.root.file_id
repo.texts.add_lines((inv.root.file_id, inv.root.revision),
[], [])
finally:
repo.commit_write_group()
finally:
repo.unlock()
repo.reconcile(thorough=True)
class TestReconcileWithIncorrectRevisionCache(TestReconcile):
"""Ancestry data gets cached in knits and weaves should be reconcilable.
This class tests that reconcile can correct invalid caches (such as after
a reconcile).
"""
def setUp(self):
self.reduceLockdirTimeout()
super(TestReconcileWithIncorrectRevisionCache, self).setUp()
t = self.get_transport()
# we need a revision with two parents in the wrong order
# which should trigger reinsertion.
# and another with the first one correct but the other two not
# which should not trigger reinsertion.
# these need to be in different repositories so that we don't
# trigger a reconcile based on the other case.
# there is no api to construct a broken knit repository at
# this point. if we ever encounter a bad graph in a knit repo
# we should add a lower level api to allow constructing such cases.
# first off the common logic:
self.first_tree = self.make_branch_and_tree('wrong-first-parent')
self.second_tree = self.make_branch_and_tree(
'reversed-secondary-parents')
for t in [self.first_tree, self.second_tree]:
t.commit('1', rev_id='1')
uncommit(t.branch, tree=t)
t.commit('2', rev_id='2')
uncommit(t.branch, tree=t)
t.commit('3', rev_id='3')
uncommit(t.branch, tree=t)
#second_tree = self.make_branch_and_tree('reversed-secondary-parents')
#second_tree.pull(tree) # XXX won't copy the repo?
repo_secondary = self.second_tree.branch.repository
# now setup the wrong-first parent case
repo = self.first_tree.branch.repository
repo.lock_write()
repo.start_write_group()
inv = Inventory(revision_id='wrong-first-parent')
inv.root.revision = 'wrong-first-parent'
if repo.supports_rich_root():
root_id = inv.root.file_id
repo.texts.add_lines((root_id, 'wrong-first-parent'), [], [])
sha1 = repo.add_inventory('wrong-first-parent', inv, ['2', '1'])
rev = Revision(timestamp=0,
timezone=None,
committer="Foo Bar <foo@example.com>",
message="Message",
inventory_sha1=sha1,
revision_id='wrong-first-parent')
rev.parent_ids = ['1', '2']
repo.add_revision('wrong-first-parent', rev)
repo.commit_write_group()
repo.unlock()
# now setup the wrong-secondary parent case
repo = repo_secondary
repo.lock_write()
repo.start_write_group()
inv = Inventory(revision_id='wrong-secondary-parent')
inv.root.revision = 'wrong-secondary-parent'
if repo.supports_rich_root():
root_id = inv.root.file_id
repo.texts.add_lines((root_id, 'wrong-secondary-parent'), [], [])
sha1 = repo.add_inventory('wrong-secondary-parent', inv, ['1', '3', '2'])
rev = Revision(timestamp=0,
timezone=None,
committer="Foo Bar <foo@example.com>",
message="Message",
inventory_sha1=sha1,
revision_id='wrong-secondary-parent')
rev.parent_ids = ['1', '2', '3']
repo.add_revision('wrong-secondary-parent', rev)
repo.commit_write_group()
repo.unlock()
def test_reconcile_wrong_order(self):
# a wrong order in primary parents is optionally correctable
repo = self.first_tree.branch.repository
repo.lock_read()
try:
g = repo.get_graph()
if g.get_parent_map(['wrong-first-parent'])['wrong-first-parent'] \
== ('1', '2'):
raise TestSkipped('wrong-first-parent is not setup for testing')
finally:
repo.unlock()
self.checkUnreconciled(repo.bzrdir, repo.reconcile())
# nothing should have been altered yet : inventories without
# revisions are not data loss incurring for current format
reconciler = repo.reconcile(thorough=True)
# these show up as inconsistent parents
self.assertEqual(1, reconciler.inconsistent_parents)
# and no garbage inventories
self.assertEqual(0, reconciler.garbage_inventories)
# and should have been fixed:
repo.lock_read()
self.addCleanup(repo.unlock)
g = repo.get_graph()
self.assertEqual(
{'wrong-first-parent':('1', '2')},
g.get_parent_map(['wrong-first-parent']))
def test_reconcile_wrong_order_secondary_inventory(self):
# a wrong order in the parents for inventories is ignored.
repo = self.second_tree.branch.repository
self.checkUnreconciled(repo.bzrdir, repo.reconcile())
self.checkUnreconciled(repo.bzrdir, repo.reconcile(thorough=True))
|