22
22
"""test suite for weave algorithm"""
24
from io import BytesIO
25
24
from pprint import pformat
30
from ..osutils import sha_string
31
from . import TestCase, TestCaseInTempDir
32
from ..bzr.weave import Weave, WeaveFormatError, WeaveInvalidChecksum
33
from ..bzr.weavefile import write_weave, read_weave
29
from brzlib.osutils import sha_string
30
from brzlib.tests import TestCase, TestCaseInTempDir
31
from brzlib.weave import Weave, WeaveFormatError
32
from brzlib.weavefile import write_weave, read_weave
36
35
# texts for use in testing
37
TEXT_0 = [b"Hello world"]
38
TEXT_1 = [b"Hello world",
36
TEXT_0 = ["Hello world"]
37
TEXT_1 = ["Hello world",
42
41
class TestBase(TestCase):
67
66
"""Weave __contains__ operator"""
70
k = Weave(get_scope=lambda: None)
71
self.assertFalse(b'foo' in k)
72
k.add_lines(b'foo', [], TEXT_1)
73
self.assertTrue(b'foo' in k)
69
k = Weave(get_scope=lambda:None)
70
self.assertFalse('foo' in k)
71
k.add_lines('foo', [], TEXT_1)
72
self.assertTrue('foo' in k)
76
75
class Easy(TestBase):
82
81
class AnnotateOne(TestBase):
86
k.add_lines(b'text0', [], TEXT_0)
87
self.assertEqual(k.annotate(b'text0'),
88
[(b'text0', TEXT_0[0])])
85
k.add_lines('text0', [], TEXT_0)
86
self.assertEqual(k.annotate('text0'),
87
[('text0', TEXT_0[0])])
91
90
class InvalidAdd(TestBase):
135
134
Look at the annotations to make sure that the first line is matched
136
135
and not stored repeatedly."""
138
136
def runTest(self):
141
k.add_lines(b'text0', [], [b'line 1'])
142
k.add_lines(b'text1', [b'text0'], [b'line 1', b'line 2'])
139
k.add_lines('text0', [], ['line 1'])
140
k.add_lines('text1', ['text0'], ['line 1', 'line 2'])
144
self.assertEqual(k.annotate(b'text0'),
145
[(b'text0', b'line 1')])
142
self.assertEqual(k.annotate('text0'),
143
[('text0', 'line 1')])
147
145
self.assertEqual(k.get_lines(1),
151
self.assertEqual(k.annotate(b'text1'),
152
[(b'text0', b'line 1'),
153
(b'text1', b'line 2')])
155
k.add_lines(b'text2', [b'text0'], [b'line 1', b'diverged line'])
157
self.assertEqual(k.annotate(b'text2'),
158
[(b'text0', b'line 1'),
159
(b'text2', b'diverged line')])
161
text3 = [b'line 1', b'middle line', b'line 2']
162
k.add_lines(b'text3',
163
[b'text0', b'text1'],
166
# self.log("changes to text3: " + pformat(list(k._delta(set([0, 1]),
149
self.assertEqual(k.annotate('text1'),
150
[('text0', 'line 1'),
151
('text1', 'line 2')])
153
k.add_lines('text2', ['text0'], ['line 1', 'diverged line'])
155
self.assertEqual(k.annotate('text2'),
156
[('text0', 'line 1'),
157
('text2', 'diverged line')])
159
text3 = ['line 1', 'middle line', 'line 2']
164
# self.log("changes to text3: " + pformat(list(k._delta(set([0, 1]), text3))))
169
166
self.log("k._weave=" + pformat(k._weave))
171
self.assertEqual(k.annotate(b'text3'),
172
[(b'text0', b'line 1'),
173
(b'text3', b'middle line'),
174
(b'text1', b'line 2')])
168
self.assertEqual(k.annotate('text3'),
169
[('text0', 'line 1'),
170
('text3', 'middle line'),
171
('text1', 'line 2')])
176
173
# now multiple insertions at different places
178
b'text4', [b'text0', b'text1', b'text3'],
179
[b'line 1', b'aaa', b'middle line', b'bbb', b'line 2', b'ccc'])
175
['text0', 'text1', 'text3'],
176
['line 1', 'aaa', 'middle line', 'bbb', 'line 2', 'ccc'])
181
self.assertEqual(k.annotate(b'text4'),
182
[(b'text0', b'line 1'),
184
(b'text3', b'middle line'),
186
(b'text1', b'line 2'),
178
self.assertEqual(k.annotate('text4'),
179
[('text0', 'line 1'),
181
('text3', 'middle line'),
190
187
class DeleteLines(TestBase):
191
188
"""Deletion of lines from existing text.
193
190
Try various texts all based on a common ancestor."""
195
191
def runTest(self):
198
base_text = [b'one', b'two', b'three', b'four']
200
k.add_lines(b'text0', [], base_text)
202
texts = [[b'one', b'two', b'three'],
203
[b'two', b'three', b'four'],
205
[b'one', b'two', b'three', b'four'],
194
base_text = ['one', 'two', 'three', 'four']
196
k.add_lines('text0', [], base_text)
198
texts = [['one', 'two', 'three'],
199
['two', 'three', 'four'],
201
['one', 'two', 'three', 'four'],
210
k.add_lines(b'text%d' % i, [b'text0'], t)
206
ver = k.add_lines('text%d' % i,
213
210
self.log('final weave:')
214
211
self.log('k._weave=' + pformat(k._weave))
216
213
for i in range(len(texts)):
217
self.assertEqual(k.get_lines(i + 1),
214
self.assertEqual(k.get_lines(i+1),
221
218
class SuicideDelete(TestBase):
222
219
"""Invalid weave which tries to add and delete simultaneously."""
224
220
def runTest(self):
227
223
k._parents = [(),
229
k._weave = [(b'{', 0),
225
k._weave = [('{', 0),
232
################################### SKIPPED
237
233
# Weave.get doesn't trap this anymore
245
241
class CannedDelete(TestBase):
246
242
"""Unpack canned weave with deleted lines."""
248
243
def runTest(self):
251
246
k._parents = [(),
254
k._weave = [(b'{', 0),
257
b'line to be deleted',
263
sha_string(b'first lineline to be deletedlast line'),
264
sha_string(b'first linelast line')]
249
k._weave = [('{', 0),
252
'line to be deleted',
257
k._sha1s = [sha_string('first lineline to be deletedlast line')
258
, sha_string('first linelast line')]
266
260
self.assertEqual(k.get_lines(0),
268
b'line to be deleted',
262
'line to be deleted',
272
266
self.assertEqual(k.get_lines(1),
278
272
class CannedReplacement(TestBase):
279
273
"""Unpack canned weave with deleted lines."""
281
274
def runTest(self):
284
277
k._parents = [frozenset(),
287
k._weave = [(b'{', 0),
290
b'line to be deleted',
299
sha_string(b'first lineline to be deletedlast line'),
300
sha_string(b'first linereplacement linelast line')]
280
k._weave = [('{', 0),
283
'line to be deleted',
291
k._sha1s = [sha_string('first lineline to be deletedlast line')
292
, sha_string('first linereplacement linelast line')]
302
294
self.assertEqual(k.get_lines(0),
304
b'line to be deleted',
296
'line to be deleted',
308
300
self.assertEqual(k.get_lines(1),
315
307
class BadWeave(TestBase):
316
308
"""Test that we trap an insert which should not occur."""
318
309
def runTest(self):
321
312
k._parents = [frozenset(),
323
k._weave = [b'bad line',
327
b' added in version 1',
314
k._weave = ['bad line',
318
' added in version 1',
327
################################### SKIPPED
337
328
# Weave.get doesn't trap this anymore
340
332
self.assertRaises(WeaveFormatError,
378
370
class InsertNested(TestBase):
379
371
"""Insertion with nested instructions."""
381
372
def runTest(self):
384
375
k._parents = [frozenset(),
387
frozenset([0, 1, 2]),
389
k._weave = [(b'{', 0),
392
b' added in version 1',
380
k._weave = [('{', 0),
383
' added in version 1',
402
sha_string(b'foo {}'),
403
sha_string(b'foo { added in version 1 also from v1}'),
404
sha_string(b'foo { added in v2}'),
406
b'foo { added in version 1 added in v2 also from v1}')
392
k._sha1s = [sha_string('foo {}')
393
, sha_string('foo { added in version 1 also from v1}')
394
, sha_string('foo { added in v2}')
395
, sha_string('foo { added in version 1 added in v2 also from v1}')
409
398
self.assertEqual(k.get_lines(0),
413
402
self.assertEqual(k.get_lines(1),
415
b' added in version 1',
404
' added in version 1',
419
408
self.assertEqual(k.get_lines(2),
424
413
self.assertEqual(k.get_lines(3),
426
b' added in version 1',
415
' added in version 1',
432
421
class DeleteLines2(TestBase):
435
424
This relies on the weave having a way to represent lines knocked
436
425
out by a later revision."""
438
426
def runTest(self):
441
k.add_lines(b'text0', [], [b"line the first",
429
k.add_lines('text0', [], ["line the first",
446
434
self.assertEqual(len(k.get_lines(0)), 4)
448
k.add_lines(b'text1', [b'text0'], [b"line the first",
436
k.add_lines('text1', ['text0'], ["line the first",
451
439
self.assertEqual(k.get_lines(1),
455
self.assertEqual(k.annotate(b'text1'),
456
[(b'text0', b"line the first"),
457
(b'text0', b"fine")])
443
self.assertEqual(k.annotate('text1'),
444
[('text0', "line the first"),
460
448
class IncludeVersions(TestBase):
473
461
k._parents = [frozenset(), frozenset([0])]
474
k._weave = [(b'{', 0),
462
k._weave = [('{', 0),
481
k._sha1s = [sha_string(b'first line'), sha_string(
482
b'first linesecond line')]
469
k._sha1s = [sha_string('first line')
470
, sha_string('first linesecond line')]
484
472
self.assertEqual(k.get_lines(1),
488
476
self.assertEqual(k.get_lines(0),
492
480
class DivergedIncludes(TestBase):
493
481
"""Weave with two diverged texts based on version 0.
496
483
def runTest(self):
497
484
# FIXME make the weave, dont poke at it.
500
k._names = [b'0', b'1', b'2']
501
k._name_map = {b'0': 0, b'1': 1, b'2': 2}
487
k._names = ['0', '1', '2']
488
k._name_map = {'0':0, '1':1, '2':2}
502
489
k._parents = [frozenset(),
506
k._weave = [(b'{', 0),
513
b"alternative second line",
493
k._weave = [('{', 0),
500
"alternative second line",
518
sha_string(b'first line'),
519
sha_string(b'first linesecond line'),
520
sha_string(b'first linealternative second line')]
504
k._sha1s = [sha_string('first line')
505
, sha_string('first linesecond line')
506
, sha_string('first linealternative second line')]
522
508
self.assertEqual(k.get_lines(0),
525
511
self.assertEqual(k.get_lines(1),
529
self.assertEqual(k.get_lines(b'2'),
531
b"alternative second line"])
533
self.assertEqual(list(k.get_ancestry([b'2'])),
515
self.assertEqual(k.get_lines('2'),
517
"alternative second line"])
519
self.assertEqual(list(k.get_ancestry(['2'])),
537
523
class ReplaceLine(TestBase):
538
524
def runTest(self):
541
text0 = [b'cheddar', b'stilton', b'gruyere']
542
text1 = [b'cheddar', b'blue vein', b'neufchatel', b'chevre']
527
text0 = ['cheddar', 'stilton', 'gruyere']
528
text1 = ['cheddar', 'blue vein', 'neufchatel', 'chevre']
544
k.add_lines(b'text0', [], text0)
545
k.add_lines(b'text1', [b'text0'], text1)
530
k.add_lines('text0', [], text0)
531
k.add_lines('text1', ['text0'], text1)
547
533
self.log('k._weave=' + pformat(k._weave))
556
542
def runTest(self):
561
[b'header', b'', b'line from 1'],
562
[b'header', b'', b'line from 2', b'more from 2'],
563
[b'header', b'', b'line from 1', b'fixup line', b'line from 2'],
546
['header', '', 'line from 1'],
547
['header', '', 'line from 2', 'more from 2'],
548
['header', '', 'line from 1', 'fixup line', 'line from 2'],
566
k.add_lines(b'text0', [], texts[0])
567
k.add_lines(b'text1', [b'text0'], texts[1])
568
k.add_lines(b'text2', [b'text0'], texts[2])
569
k.add_lines(b'merge', [b'text0', b'text1', b'text2'], texts[3])
551
k.add_lines('text0', [], texts[0])
552
k.add_lines('text1', ['text0'], texts[1])
553
k.add_lines('text2', ['text0'], texts[2])
554
k.add_lines('merge', ['text0', 'text1', 'text2'], texts[3])
571
556
for i, t in enumerate(texts):
572
557
self.assertEqual(k.get_lines(i), t)
574
self.assertEqual(k.annotate(b'merge'),
575
[(b'text0', b'header'),
577
(b'text1', b'line from 1'),
578
(b'merge', b'fixup line'),
579
(b'text2', b'line from 2'),
559
self.assertEqual(k.annotate('merge'),
560
[('text0', 'header'),
562
('text1', 'line from 1'),
563
('merge', 'fixup line'),
564
('text2', 'line from 2'),
582
self.assertEqual(list(k.get_ancestry([b'merge'])),
583
[b'text0', b'text1', b'text2', b'merge'])
567
self.assertEqual(list(k.get_ancestry(['merge'])),
568
['text0', 'text1', 'text2', 'merge'])
585
570
self.log('k._weave=' + pformat(k._weave))
593
578
A base version is inserted, then two descendents try to
594
579
insert different lines in the same place. These should be
595
580
reported as a possible conflict and forwarded to the user."""
597
581
def runTest(self):
601
k.add_lines([], [b'aaa', b'bbb'])
602
k.add_lines([0], [b'aaa', b'111', b'bbb'])
603
k.add_lines([1], [b'aaa', b'222', b'bbb'])
607
self.assertEqual([[[b'aaa']],
608
[[b'111'], [b'222']],
585
k.add_lines([], ['aaa', 'bbb'])
586
k.add_lines([0], ['aaa', '111', 'bbb'])
587
k.add_lines([1], ['aaa', '222', 'bbb'])
589
merged = k.merge([1, 2])
591
self.assertEqual([[['aaa']],
612
596
class NonConflict(TestBase):
613
597
"""Two descendants insert compatible changes.
615
599
No conflict should be reported."""
617
600
def runTest(self):
621
k.add_lines([], [b'aaa', b'bbb'])
622
k.add_lines([0], [b'111', b'aaa', b'ccc', b'bbb'])
623
k.add_lines([1], [b'aaa', b'ccc', b'bbb', b'222'])
604
k.add_lines([], ['aaa', 'bbb'])
605
k.add_lines([0], ['111', 'aaa', 'ccc', 'bbb'])
606
k.add_lines([1], ['aaa', 'ccc', 'bbb', '222'])
626
609
class Khayyam(TestBase):
629
612
def test_multi_line_merge(self):
631
b"""A Book of Verses underneath the Bough,
614
"""A Book of Verses underneath the Bough,
632
615
A Jug of Wine, a Loaf of Bread, -- and Thou
633
616
Beside me singing in the Wilderness --
634
617
Oh, Wilderness were Paradise enow!""",
636
b"""A Book of Verses underneath the Bough,
619
"""A Book of Verses underneath the Bough,
637
620
A Jug of Wine, a Loaf of Bread, -- and Thou
638
621
Beside me singing in the Wilderness --
639
622
Oh, Wilderness were Paradise now!""",
641
b"""A Book of poems underneath the tree,
624
"""A Book of poems underneath the tree,
642
625
A Jug of Wine, a Loaf of Bread,
644
627
Beside me singing in the Wilderness --
676
660
super(JoinWeavesTests, self).setUp()
677
661
self.weave1 = Weave()
678
self.lines1 = [b'hello\n']
679
self.lines3 = [b'hello\n', b'cruel\n', b'world\n']
680
self.weave1.add_lines(b'v1', [], self.lines1)
681
self.weave1.add_lines(b'v2', [b'v1'], [b'hello\n', b'world\n'])
682
self.weave1.add_lines(b'v3', [b'v2'], self.lines3)
662
self.lines1 = ['hello\n']
663
self.lines3 = ['hello\n', 'cruel\n', 'world\n']
664
self.weave1.add_lines('v1', [], self.lines1)
665
self.weave1.add_lines('v2', ['v1'], ['hello\n', 'world\n'])
666
self.weave1.add_lines('v3', ['v2'], self.lines3)
684
668
def test_written_detection(self):
685
669
# Test detection of weave file corruption.
687
671
# Make sure that we can detect if a weave file has
688
672
# been corrupted. This doesn't test all forms of corruption,
689
673
# but it at least helps verify the data you get, is what you want.
674
from cStringIO import StringIO
692
w.add_lines(b'v1', [], [b'hello\n'])
693
w.add_lines(b'v2', [b'v1'], [b'hello\n', b'there\n'])
677
w.add_lines('v1', [], ['hello\n'])
678
w.add_lines('v2', ['v1'], ['hello\n', 'there\n'])
696
681
write_weave(w, tmpf)
698
# Because we are corrupting, we need to make sure we have the exact
701
b'# bzr weave file v5\n'
702
b'i\n1 f572d396fae9206628714fb2ce00f72e94f2258f\nn v1\n\n'
703
b'i 0\n1 90f265c6e75f1c8f9ab76dcf85528352c5f215ef\nn v2\n\n'
704
b'w\n{ 0\n. hello\n}\n{ 1\n. there\n}\nW\n',
683
# Because we are corrupting, we need to make sure we have the exact text
684
self.assertEqual('# bzr weave file v5\n'
685
'i\n1 f572d396fae9206628714fb2ce00f72e94f2258f\nn v1\n\n'
686
'i 0\n1 90f265c6e75f1c8f9ab76dcf85528352c5f215ef\nn v2\n\n'
687
'w\n{ 0\n. hello\n}\n{ 1\n. there\n}\nW\n',
707
690
# Change a single letter
709
b'# bzr weave file v5\n'
710
b'i\n1 f572d396fae9206628714fb2ce00f72e94f2258f\nn v1\n\n'
711
b'i 0\n1 90f265c6e75f1c8f9ab76dcf85528352c5f215ef\nn v2\n\n'
712
b'w\n{ 0\n. hello\n}\n{ 1\n. There\n}\nW\n')
691
tmpf = StringIO('# bzr weave file v5\n'
692
'i\n1 f572d396fae9206628714fb2ce00f72e94f2258f\nn v1\n\n'
693
'i 0\n1 90f265c6e75f1c8f9ab76dcf85528352c5f215ef\nn v2\n\n'
694
'w\n{ 0\n. hello\n}\n{ 1\n. There\n}\nW\n')
714
696
w = read_weave(tmpf)
716
self.assertEqual(b'hello\n', w.get_text(b'v1'))
717
self.assertRaises(WeaveInvalidChecksum, w.get_text, b'v2')
718
self.assertRaises(WeaveInvalidChecksum, w.get_lines, b'v2')
719
self.assertRaises(WeaveInvalidChecksum, w.check)
698
self.assertEqual('hello\n', w.get_text('v1'))
699
self.assertRaises(errors.WeaveInvalidChecksum, w.get_text, 'v2')
700
self.assertRaises(errors.WeaveInvalidChecksum, w.get_lines, 'v2')
701
self.assertRaises(errors.WeaveInvalidChecksum, w.check)
721
703
# Change the sha checksum
723
b'# bzr weave file v5\n'
724
b'i\n1 f572d396fae9206628714fb2ce00f72e94f2258f\nn v1\n\n'
725
b'i 0\n1 f0f265c6e75f1c8f9ab76dcf85528352c5f215ef\nn v2\n\n'
726
b'w\n{ 0\n. hello\n}\n{ 1\n. there\n}\nW\n')
704
tmpf = StringIO('# bzr weave file v5\n'
705
'i\n1 f572d396fae9206628714fb2ce00f72e94f2258f\nn v1\n\n'
706
'i 0\n1 f0f265c6e75f1c8f9ab76dcf85528352c5f215ef\nn v2\n\n'
707
'w\n{ 0\n. hello\n}\n{ 1\n. there\n}\nW\n')
728
709
w = read_weave(tmpf)
730
self.assertEqual(b'hello\n', w.get_text(b'v1'))
731
self.assertRaises(WeaveInvalidChecksum, w.get_text, b'v2')
732
self.assertRaises(WeaveInvalidChecksum, w.get_lines, b'v2')
733
self.assertRaises(WeaveInvalidChecksum, w.check)
711
self.assertEqual('hello\n', w.get_text('v1'))
712
self.assertRaises(errors.WeaveInvalidChecksum, w.get_text, 'v2')
713
self.assertRaises(errors.WeaveInvalidChecksum, w.get_lines, 'v2')
714
self.assertRaises(errors.WeaveInvalidChecksum, w.check)
736
717
class TestWeave(TestCase):
738
719
def test_allow_reserved_false(self):
739
720
w = Weave('name', allow_reserved=False)
740
721
# Add lines is checked at the WeaveFile level, not at the Weave level
741
w.add_lines(b'name:', [], TEXT_1)
722
w.add_lines('name:', [], TEXT_1)
742
723
# But get_lines is checked at this level
743
self.assertRaises(errors.ReservedId, w.get_lines, b'name:')
724
self.assertRaises(errors.ReservedId, w.get_lines, 'name:')
745
726
def test_allow_reserved_true(self):
746
727
w = Weave('name', allow_reserved=True)
747
w.add_lines(b'name:', [], TEXT_1)
748
self.assertEqual(TEXT_1, w.get_lines(b'name:'))
728
w.add_lines('name:', [], TEXT_1)
729
self.assertEqual(TEXT_1, w.get_lines('name:'))
751
732
class InstrumentedWeave(Weave):
766
747
def test_compatible_parents(self):
768
my_parents = {1, 2, 3}
749
my_parents = set([1, 2, 3])
770
self.assertTrue(w1._compatible_parents(my_parents, {3}))
751
self.assertTrue(w1._compatible_parents(my_parents, set([3])))
772
753
self.assertTrue(w1._compatible_parents(my_parents, set(my_parents)))
773
754
# same empty corner case
774
755
self.assertTrue(w1._compatible_parents(set(), set()))
775
756
# other cannot contain stuff my_parents does not
776
self.assertFalse(w1._compatible_parents(set(), {1}))
777
self.assertFalse(w1._compatible_parents(my_parents, {1, 2, 3, 4}))
778
self.assertFalse(w1._compatible_parents(my_parents, {4}))
757
self.assertFalse(w1._compatible_parents(set(), set([1])))
758
self.assertFalse(w1._compatible_parents(my_parents, set([1, 2, 3, 4])))
759
self.assertFalse(w1._compatible_parents(my_parents, set([4])))
781
762
class TestWeaveFile(TestCaseInTempDir):
783
764
def test_empty_file(self):
784
with open('empty.weave', 'wb+') as f:
785
self.assertRaises(WeaveFormatError, read_weave, f)
765
f = open('empty.weave', 'wb+')
767
self.assertRaises(errors.WeaveFormatError,