22
22
"""test suite for weave algorithm"""
24
from io import BytesIO
24
25
from pprint import pformat
29
from bzrlib.osutils import sha_string
30
from bzrlib.tests import TestCase, TestCaseInTempDir
31
from bzrlib.weave import Weave, WeaveFormatError, WeaveError
32
from bzrlib.weavefile import write_weave, read_weave
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
35
36
# texts for use in testing
36
TEXT_0 = ["Hello world"]
37
TEXT_1 = ["Hello world",
37
TEXT_0 = [b"Hello world"]
38
TEXT_1 = [b"Hello world",
41
42
class TestBase(TestCase):
65
66
class WeaveContains(TestBase):
66
67
"""Weave __contains__ operator"""
68
k = Weave(get_scope=lambda:None)
69
self.assertFalse('foo' in k)
70
k.add_lines('foo', [], TEXT_1)
71
self.assertTrue('foo' in k)
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)
74
76
class Easy(TestBase):
79
82
class AnnotateOne(TestBase):
82
k.add_lines('text0', [], TEXT_0)
83
self.assertEqual(k.annotate('text0'),
84
[('text0', TEXT_0[0])])
86
k.add_lines(b'text0', [], TEXT_0)
87
self.assertEqual(k.annotate(b'text0'),
88
[(b'text0', TEXT_0[0])])
87
91
class InvalidAdd(TestBase):
88
92
"""Try to use invalid version number during add."""
92
97
self.assertRaises(errors.RevisionNotPresent,
99
104
class RepeatedAdd(TestBase):
102
107
def test_duplicate_add(self):
104
idx = k.add_lines('text0', [], TEXT_0)
105
idx2 = k.add_lines('text0', [], TEXT_0)
109
idx = k.add_lines(b'text0', [], TEXT_0)
110
idx2 = k.add_lines(b'text0', [], TEXT_0)
106
111
self.assertEqual(idx, idx2)
109
114
class InvalidRepeatedAdd(TestBase):
110
116
def runTest(self):
112
k.add_lines('basis', [], TEXT_0)
113
idx = k.add_lines('text0', [], TEXT_0)
118
k.add_lines(b'basis', [], TEXT_0)
119
k.add_lines(b'text0', [], TEXT_0)
114
120
self.assertRaises(errors.RevisionAlreadyPresent,
118
['not the same text'])
124
[b'not the same text'])
119
125
self.assertRaises(errors.RevisionAlreadyPresent,
122
['basis'], # not the right parents
128
[b'basis'], # not the right parents
129
135
Look at the annotations to make sure that the first line is matched
130
136
and not stored repeatedly."""
131
138
def runTest(self):
134
k.add_lines('text0', [], ['line 1'])
135
k.add_lines('text1', ['text0'], ['line 1', 'line 2'])
141
k.add_lines(b'text0', [], [b'line 1'])
142
k.add_lines(b'text1', [b'text0'], [b'line 1', b'line 2'])
137
self.assertEqual(k.annotate('text0'),
138
[('text0', 'line 1')])
144
self.assertEqual(k.annotate(b'text0'),
145
[(b'text0', b'line 1')])
140
147
self.assertEqual(k.get_lines(1),
144
self.assertEqual(k.annotate('text1'),
145
[('text0', 'line 1'),
146
('text1', 'line 2')])
148
k.add_lines('text2', ['text0'], ['line 1', 'diverged line'])
150
self.assertEqual(k.annotate('text2'),
151
[('text0', 'line 1'),
152
('text2', 'diverged line')])
154
text3 = ['line 1', 'middle line', 'line 2']
159
# self.log("changes to text3: " + pformat(list(k._delta(set([0, 1]), text3))))
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]),
161
169
self.log("k._weave=" + pformat(k._weave))
163
self.assertEqual(k.annotate('text3'),
164
[('text0', 'line 1'),
165
('text3', 'middle line'),
166
('text1', 'line 2')])
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
176
# now multiple insertions at different places
170
['text0', 'text1', 'text3'],
171
['line 1', 'aaa', 'middle line', 'bbb', 'line 2', 'ccc'])
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'])
173
self.assertEqual(k.annotate('text4'),
174
[('text0', 'line 1'),
176
('text3', 'middle line'),
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'),
182
190
class DeleteLines(TestBase):
183
191
"""Deletion of lines from existing text.
185
193
Try various texts all based on a common ancestor."""
186
195
def runTest(self):
189
base_text = ['one', 'two', 'three', 'four']
191
k.add_lines('text0', [], base_text)
193
texts = [['one', 'two', 'three'],
194
['two', 'three', 'four'],
196
['one', 'two', 'three', 'four'],
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'],
201
ver = k.add_lines('text%d' % i,
210
k.add_lines(b'text%d' % i, [b'text0'], t)
205
213
self.log('final weave:')
206
214
self.log('k._weave=' + pformat(k._weave))
208
216
for i in range(len(texts)):
209
self.assertEqual(k.get_lines(i+1),
217
self.assertEqual(k.get_lines(i + 1),
213
221
class SuicideDelete(TestBase):
214
222
"""Invalid weave which tries to add and delete simultaneously."""
215
224
def runTest(self):
218
227
k._parents = [(),
220
k._weave = [('{', 0),
227
################################### SKIPPED
229
k._weave = [(b'{', 0),
228
237
# Weave.get doesn't trap this anymore
236
245
class CannedDelete(TestBase):
237
246
"""Unpack canned weave with deleted lines."""
238
248
def runTest(self):
241
251
k._parents = [(),
244
k._weave = [('{', 0),
247
'line to be deleted',
252
k._sha1s = [sha_string('first lineline to be deletedlast line')
253
, sha_string('first linelast line')]
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')]
255
266
self.assertEqual(k.get_lines(0),
257
'line to be deleted',
268
b'line to be deleted',
261
272
self.assertEqual(k.get_lines(1),
267
278
class CannedReplacement(TestBase):
268
279
"""Unpack canned weave with deleted lines."""
269
281
def runTest(self):
272
284
k._parents = [frozenset(),
275
k._weave = [('{', 0),
278
'line to be deleted',
286
k._sha1s = [sha_string('first lineline to be deletedlast line')
287
, sha_string('first linereplacement linelast line')]
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')]
289
302
self.assertEqual(k.get_lines(0),
291
'line to be deleted',
304
b'line to be deleted',
295
308
self.assertEqual(k.get_lines(1),
302
315
class BadWeave(TestBase):
303
316
"""Test that we trap an insert which should not occur."""
304
318
def runTest(self):
307
321
k._parents = [frozenset(),
309
k._weave = ['bad line',
313
' added in version 1',
323
k._weave = [b'bad line',
327
b' added in version 1',
322
################################### SKIPPED
323
337
# Weave.get doesn't trap this anymore
327
340
self.assertRaises(WeaveFormatError,
365
378
class InsertNested(TestBase):
366
379
"""Insertion with nested instructions."""
367
381
def runTest(self):
370
384
k._parents = [frozenset(),
375
k._weave = [('{', 0),
378
' added in version 1',
387
frozenset([0, 1, 2]),
389
k._weave = [(b'{', 0),
392
b' added in version 1',
387
k._sha1s = [sha_string('foo {}')
388
, sha_string('foo { added in version 1 also from v1}')
389
, sha_string('foo { added in v2}')
390
, sha_string('foo { added in version 1 added in v2 also from v1}')
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}')
393
409
self.assertEqual(k.get_lines(0),
397
413
self.assertEqual(k.get_lines(1),
399
' added in version 1',
415
b' added in version 1',
403
419
self.assertEqual(k.get_lines(2),
408
424
self.assertEqual(k.get_lines(3),
410
' added in version 1',
426
b' added in version 1',
416
432
class DeleteLines2(TestBase):
419
435
This relies on the weave having a way to represent lines knocked
420
436
out by a later revision."""
421
438
def runTest(self):
424
k.add_lines('text0', [], ["line the first",
441
k.add_lines(b'text0', [], [b"line the first",
429
446
self.assertEqual(len(k.get_lines(0)), 4)
431
k.add_lines('text1', ['text0'], ["line the first",
448
k.add_lines(b'text1', [b'text0'], [b"line the first",
434
451
self.assertEqual(k.get_lines(1),
438
self.assertEqual(k.annotate('text1'),
439
[('text0', "line the first"),
455
self.assertEqual(k.annotate(b'text1'),
456
[(b'text0', b"line the first"),
457
(b'text0', b"fine")])
443
460
class IncludeVersions(TestBase):
456
473
k._parents = [frozenset(), frozenset([0])]
457
k._weave = [('{', 0),
474
k._weave = [(b'{', 0),
464
k._sha1s = [sha_string('first line')
465
, sha_string('first linesecond line')]
481
k._sha1s = [sha_string(b'first line'), sha_string(
482
b'first linesecond line')]
467
484
self.assertEqual(k.get_lines(1),
471
488
self.assertEqual(k.get_lines(0),
475
492
class DivergedIncludes(TestBase):
476
493
"""Weave with two diverged texts based on version 0.
478
496
def runTest(self):
479
497
# FIXME make the weave, dont poke at it.
482
k._names = ['0', '1', '2']
483
k._name_map = {'0':0, '1':1, '2':2}
500
k._names = [b'0', b'1', b'2']
501
k._name_map = {b'0': 0, b'1': 1, b'2': 2}
484
502
k._parents = [frozenset(),
488
k._weave = [('{', 0),
495
"alternative second line",
506
k._weave = [(b'{', 0),
513
b"alternative second line",
499
k._sha1s = [sha_string('first line')
500
, sha_string('first linesecond line')
501
, sha_string('first linealternative second line')]
518
sha_string(b'first line'),
519
sha_string(b'first linesecond line'),
520
sha_string(b'first linealternative second line')]
503
522
self.assertEqual(k.get_lines(0),
506
525
self.assertEqual(k.get_lines(1),
510
self.assertEqual(k.get_lines('2'),
512
"alternative second line"])
514
self.assertEqual(list(k.get_ancestry(['2'])),
529
self.assertEqual(k.get_lines(b'2'),
531
b"alternative second line"])
533
self.assertEqual(list(k.get_ancestry([b'2'])),
518
537
class ReplaceLine(TestBase):
519
538
def runTest(self):
522
text0 = ['cheddar', 'stilton', 'gruyere']
523
text1 = ['cheddar', 'blue vein', 'neufchatel', 'chevre']
541
text0 = [b'cheddar', b'stilton', b'gruyere']
542
text1 = [b'cheddar', b'blue vein', b'neufchatel', b'chevre']
525
k.add_lines('text0', [], text0)
526
k.add_lines('text1', ['text0'], text1)
544
k.add_lines(b'text0', [], text0)
545
k.add_lines(b'text1', [b'text0'], text1)
528
547
self.log('k._weave=' + pformat(k._weave))
534
553
class Merge(TestBase):
535
554
"""Storage of versions that merge diverged parents"""
536
556
def runTest(self):
540
['header', '', 'line from 1'],
541
['header', '', 'line from 2', 'more from 2'],
542
['header', '', 'line from 1', 'fixup line', 'line from 2'],
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'],
545
k.add_lines('text0', [], texts[0])
546
k.add_lines('text1', ['text0'], texts[1])
547
k.add_lines('text2', ['text0'], texts[2])
548
k.add_lines('merge', ['text0', 'text1', 'text2'], texts[3])
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])
550
571
for i, t in enumerate(texts):
551
572
self.assertEqual(k.get_lines(i), t)
553
self.assertEqual(k.annotate('merge'),
554
[('text0', 'header'),
556
('text1', 'line from 1'),
557
('merge', 'fixup line'),
558
('text2', 'line from 2'),
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'),
561
self.assertEqual(list(k.get_ancestry(['merge'])),
562
['text0', 'text1', 'text2', 'merge'])
582
self.assertEqual(list(k.get_ancestry([b'merge'])),
583
[b'text0', b'text1', b'text2', b'merge'])
564
585
self.log('k._weave=' + pformat(k._weave))
572
593
A base version is inserted, then two descendents try to
573
594
insert different lines in the same place. These should be
574
595
reported as a possible conflict and forwarded to the user."""
575
597
def runTest(self):
579
k.add_lines([], ['aaa', 'bbb'])
580
k.add_lines([0], ['aaa', '111', 'bbb'])
581
k.add_lines([1], ['aaa', '222', 'bbb'])
583
merged = k.merge([1, 2])
585
self.assertEquals([[['aaa']],
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']],
590
612
class NonConflict(TestBase):
591
613
"""Two descendants insert compatible changes.
593
615
No conflict should be reported."""
594
617
def runTest(self):
598
k.add_lines([], ['aaa', 'bbb'])
599
k.add_lines([0], ['111', 'aaa', 'ccc', 'bbb'])
600
k.add_lines([1], ['aaa', 'ccc', 'bbb', '222'])
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'])
603
626
class Khayyam(TestBase):
606
629
def test_multi_line_merge(self):
608
"""A Book of Verses underneath the Bough,
631
b"""A Book of Verses underneath the Bough,
609
632
A Jug of Wine, a Loaf of Bread, -- and Thou
610
633
Beside me singing in the Wilderness --
611
634
Oh, Wilderness were Paradise enow!""",
613
"""A Book of Verses underneath the Bough,
636
b"""A Book of Verses underneath the Bough,
614
637
A Jug of Wine, a Loaf of Bread, -- and Thou
615
638
Beside me singing in the Wilderness --
616
639
Oh, Wilderness were Paradise now!""",
618
"""A Book of poems underneath the tree,
641
b"""A Book of poems underneath the tree,
619
642
A Jug of Wine, a Loaf of Bread,
621
644
Beside me singing in the Wilderness --
651
673
class JoinWeavesTests(TestBase):
653
676
super(JoinWeavesTests, self).setUp()
654
677
self.weave1 = Weave()
655
self.lines1 = ['hello\n']
656
self.lines3 = ['hello\n', 'cruel\n', 'world\n']
657
self.weave1.add_lines('v1', [], self.lines1)
658
self.weave1.add_lines('v2', ['v1'], ['hello\n', 'world\n'])
659
self.weave1.add_lines('v3', ['v2'], self.lines3)
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)
661
684
def test_written_detection(self):
662
685
# Test detection of weave file corruption.
664
687
# Make sure that we can detect if a weave file has
665
688
# been corrupted. This doesn't test all forms of corruption,
666
689
# but it at least helps verify the data you get, is what you want.
667
from cStringIO import StringIO
670
w.add_lines('v1', [], ['hello\n'])
671
w.add_lines('v2', ['v1'], ['hello\n', 'there\n'])
692
w.add_lines(b'v1', [], [b'hello\n'])
693
w.add_lines(b'v2', [b'v1'], [b'hello\n', b'there\n'])
674
696
write_weave(w, tmpf)
676
# Because we are corrupting, we need to make sure we have the exact text
677
self.assertEquals('# bzr weave file v5\n'
678
'i\n1 f572d396fae9206628714fb2ce00f72e94f2258f\nn v1\n\n'
679
'i 0\n1 90f265c6e75f1c8f9ab76dcf85528352c5f215ef\nn v2\n\n'
680
'w\n{ 0\n. hello\n}\n{ 1\n. there\n}\nW\n',
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
707
# Change a single letter
684
tmpf = StringIO('# 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')
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')
689
714
w = read_weave(tmpf)
691
self.assertEqual('hello\n', w.get_text('v1'))
692
self.assertRaises(errors.WeaveInvalidChecksum, w.get_text, 'v2')
693
self.assertRaises(errors.WeaveInvalidChecksum, w.get_lines, 'v2')
694
self.assertRaises(errors.WeaveInvalidChecksum, w.check)
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)
696
721
# Change the sha checksum
697
tmpf = StringIO('# bzr weave file v5\n'
698
'i\n1 f572d396fae9206628714fb2ce00f72e94f2258f\nn v1\n\n'
699
'i 0\n1 f0f265c6e75f1c8f9ab76dcf85528352c5f215ef\nn v2\n\n'
700
'w\n{ 0\n. hello\n}\n{ 1\n. there\n}\nW\n')
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')
702
728
w = read_weave(tmpf)
704
self.assertEqual('hello\n', w.get_text('v1'))
705
self.assertRaises(errors.WeaveInvalidChecksum, w.get_text, 'v2')
706
self.assertRaises(errors.WeaveInvalidChecksum, w.get_lines, 'v2')
707
self.assertRaises(errors.WeaveInvalidChecksum, w.check)
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)
710
736
class TestWeave(TestCase):
712
738
def test_allow_reserved_false(self):
713
739
w = Weave('name', allow_reserved=False)
714
740
# Add lines is checked at the WeaveFile level, not at the Weave level
715
w.add_lines('name:', [], TEXT_1)
741
w.add_lines(b'name:', [], TEXT_1)
716
742
# But get_lines is checked at this level
717
self.assertRaises(errors.ReservedId, w.get_lines, 'name:')
743
self.assertRaises(errors.ReservedId, w.get_lines, b'name:')
719
745
def test_allow_reserved_true(self):
720
746
w = Weave('name', allow_reserved=True)
721
w.add_lines('name:', [], TEXT_1)
722
self.assertEqual(TEXT_1, w.get_lines('name:'))
747
w.add_lines(b'name:', [], TEXT_1)
748
self.assertEqual(TEXT_1, w.get_lines(b'name:'))
725
751
class InstrumentedWeave(Weave):
740
766
def test_compatible_parents(self):
742
my_parents = set([1, 2, 3])
768
my_parents = {1, 2, 3}
744
self.assertTrue(w1._compatible_parents(my_parents, set([3])))
770
self.assertTrue(w1._compatible_parents(my_parents, {3}))
746
772
self.assertTrue(w1._compatible_parents(my_parents, set(my_parents)))
747
773
# same empty corner case
748
774
self.assertTrue(w1._compatible_parents(set(), set()))
749
775
# other cannot contain stuff my_parents does not
750
self.assertFalse(w1._compatible_parents(set(), set([1])))
751
self.assertFalse(w1._compatible_parents(my_parents, set([1, 2, 3, 4])))
752
self.assertFalse(w1._compatible_parents(my_parents, set([4])))
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}))
755
781
class TestWeaveFile(TestCaseInTempDir):
757
783
def test_empty_file(self):
758
f = open('empty.weave', 'wb+')
760
self.assertRaises(errors.WeaveFormatError,
784
with open('empty.weave', 'wb+') as f:
785
self.assertRaises(WeaveFormatError, read_weave, f)