1
# Copyright (C) 2005 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: tests regarding version names
19
# TODO: rbc 20050108 test that join does not leave an inconsistent weave
22
"""test suite for weave algorithm"""
24
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
35
# texts for use in testing
36
TEXT_0 = ["Hello world"]
37
TEXT_1 = ["Hello world",
41
class TestBase(TestCase):
43
def check_read_write(self, k):
44
"""Check the weave k can be written & re-read."""
45
from tempfile import TemporaryFile
54
self.log('serialized weave:')
58
self.log('parents: %s' % (k._parents == k2._parents))
59
self.log(' %r' % k._parents)
60
self.log(' %r' % k2._parents)
62
self.fail('read/write check failed')
65
class WeaveContains(TestBase):
66
"""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)
79
class AnnotateOne(TestBase):
82
k.add_lines('text0', [], TEXT_0)
83
self.assertEqual(k.annotate('text0'),
84
[('text0', TEXT_0[0])])
87
class InvalidAdd(TestBase):
88
"""Try to use invalid version number during add."""
92
self.assertRaises(errors.RevisionNotPresent,
99
class RepeatedAdd(TestBase):
100
"""Add the same version twice; harmless."""
102
def test_duplicate_add(self):
104
idx = k.add_lines('text0', [], TEXT_0)
105
idx2 = k.add_lines('text0', [], TEXT_0)
106
self.assertEqual(idx, idx2)
109
class InvalidRepeatedAdd(TestBase):
112
k.add_lines('basis', [], TEXT_0)
113
idx = k.add_lines('text0', [], TEXT_0)
114
self.assertRaises(errors.RevisionAlreadyPresent,
118
['not the same text'])
119
self.assertRaises(errors.RevisionAlreadyPresent,
122
['basis'], # not the right parents
126
class InsertLines(TestBase):
127
"""Store a revision that adds one line to the original.
129
Look at the annotations to make sure that the first line is matched
130
and not stored repeatedly."""
134
k.add_lines('text0', [], ['line 1'])
135
k.add_lines('text1', ['text0'], ['line 1', 'line 2'])
137
self.assertEqual(k.annotate('text0'),
138
[('text0', 'line 1')])
140
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))))
161
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')])
168
# now multiple insertions at different places
170
['text0', 'text1', 'text3'],
171
['line 1', 'aaa', 'middle line', 'bbb', 'line 2', 'ccc'])
173
self.assertEqual(k.annotate('text4'),
174
[('text0', 'line 1'),
176
('text3', 'middle line'),
182
class DeleteLines(TestBase):
183
"""Deletion of lines from existing text.
185
Try various texts all based on a common ancestor."""
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'],
201
ver = k.add_lines('text%d' % i,
205
self.log('final weave:')
206
self.log('k._weave=' + pformat(k._weave))
208
for i in range(len(texts)):
209
self.assertEqual(k.get_lines(i+1),
213
class SuicideDelete(TestBase):
214
"""Invalid weave which tries to add and delete simultaneously."""
220
k._weave = [('{', 0),
227
################################### SKIPPED
228
# Weave.get doesn't trap this anymore
231
self.assertRaises(WeaveFormatError,
236
class CannedDelete(TestBase):
237
"""Unpack canned weave with deleted lines."""
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')]
255
self.assertEqual(k.get_lines(0),
257
'line to be deleted',
261
self.assertEqual(k.get_lines(1),
267
class CannedReplacement(TestBase):
268
"""Unpack canned weave with deleted lines."""
272
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')]
289
self.assertEqual(k.get_lines(0),
291
'line to be deleted',
295
self.assertEqual(k.get_lines(1),
302
class BadWeave(TestBase):
303
"""Test that we trap an insert which should not occur."""
307
k._parents = [frozenset(),
309
k._weave = ['bad line',
313
' added in version 1',
322
################################### SKIPPED
323
# Weave.get doesn't trap this anymore
327
self.assertRaises(WeaveFormatError,
332
class BadInsert(TestBase):
333
"""Test that we trap an insert which should not occur."""
337
k._parents = [frozenset(),
342
k._weave = [('{', 0),
345
' added in version 1',
353
# this is not currently enforced by get
354
return ##########################################
356
self.assertRaises(WeaveFormatError,
360
self.assertRaises(WeaveFormatError,
365
class InsertNested(TestBase):
366
"""Insertion with nested instructions."""
370
k._parents = [frozenset(),
375
k._weave = [('{', 0),
378
' 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}')
393
self.assertEqual(k.get_lines(0),
397
self.assertEqual(k.get_lines(1),
399
' added in version 1',
403
self.assertEqual(k.get_lines(2),
408
self.assertEqual(k.get_lines(3),
410
' added in version 1',
416
class DeleteLines2(TestBase):
417
"""Test recording revisions that delete lines.
419
This relies on the weave having a way to represent lines knocked
420
out by a later revision."""
424
k.add_lines('text0', [], ["line the first",
429
self.assertEqual(len(k.get_lines(0)), 4)
431
k.add_lines('text1', ['text0'], ["line the first",
434
self.assertEqual(k.get_lines(1),
438
self.assertEqual(k.annotate('text1'),
439
[('text0', "line the first"),
443
class IncludeVersions(TestBase):
444
"""Check texts that are stored across multiple revisions.
446
Here we manually create a weave with particular encoding and make
447
sure it unpacks properly.
449
Text 0 includes nothing; text 1 includes text 0 and adds some
456
k._parents = [frozenset(), frozenset([0])]
457
k._weave = [('{', 0),
464
k._sha1s = [sha_string('first line')
465
, sha_string('first linesecond line')]
467
self.assertEqual(k.get_lines(1),
471
self.assertEqual(k.get_lines(0),
475
class DivergedIncludes(TestBase):
476
"""Weave with two diverged texts based on version 0.
479
# FIXME make the weave, dont poke at it.
482
k._names = ['0', '1', '2']
483
k._name_map = {'0':0, '1':1, '2':2}
484
k._parents = [frozenset(),
488
k._weave = [('{', 0),
495
"alternative second line",
499
k._sha1s = [sha_string('first line')
500
, sha_string('first linesecond line')
501
, sha_string('first linealternative second line')]
503
self.assertEqual(k.get_lines(0),
506
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'])),
518
class ReplaceLine(TestBase):
522
text0 = ['cheddar', 'stilton', 'gruyere']
523
text1 = ['cheddar', 'blue vein', 'neufchatel', 'chevre']
525
k.add_lines('text0', [], text0)
526
k.add_lines('text1', ['text0'], text1)
528
self.log('k._weave=' + pformat(k._weave))
530
self.assertEqual(k.get_lines(0), text0)
531
self.assertEqual(k.get_lines(1), text1)
534
class Merge(TestBase):
535
"""Storage of versions that merge diverged parents"""
540
['header', '', 'line from 1'],
541
['header', '', 'line from 2', 'more from 2'],
542
['header', '', 'line from 1', 'fixup line', '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])
550
for i, t in enumerate(texts):
551
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'),
561
self.assertEqual(list(k.get_ancestry(['merge'])),
562
['text0', 'text1', 'text2', 'merge'])
564
self.log('k._weave=' + pformat(k._weave))
566
self.check_read_write(k)
569
class Conflicts(TestBase):
570
"""Test detection of conflicting regions during a merge.
572
A base version is inserted, then two descendents try to
573
insert different lines in the same place. These should be
574
reported as a possible conflict and forwarded to the user."""
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']],
590
class NonConflict(TestBase):
591
"""Two descendants insert compatible changes.
593
No conflict should be reported."""
598
k.add_lines([], ['aaa', 'bbb'])
599
k.add_lines([0], ['111', 'aaa', 'ccc', 'bbb'])
600
k.add_lines([1], ['aaa', 'ccc', 'bbb', '222'])
603
class Khayyam(TestBase):
604
"""Test changes to multi-line texts, and read/write"""
606
def test_multi_line_merge(self):
608
"""A Book of Verses underneath the Bough,
609
A Jug of Wine, a Loaf of Bread, -- and Thou
610
Beside me singing in the Wilderness --
611
Oh, Wilderness were Paradise enow!""",
613
"""A Book of Verses underneath the Bough,
614
A Jug of Wine, a Loaf of Bread, -- and Thou
615
Beside me singing in the Wilderness --
616
Oh, Wilderness were Paradise now!""",
618
"""A Book of poems underneath the tree,
619
A Jug of Wine, a Loaf of Bread,
621
Beside me singing in the Wilderness --
622
Oh, Wilderness were Paradise now!
626
"""A Book of Verses underneath the Bough,
627
A Jug of Wine, a Loaf of Bread,
629
Beside me singing in the Wilderness --
630
Oh, Wilderness were Paradise now!""",
632
texts = [[l.strip() for l in t.split('\n')] for t in rawtexts]
638
ver = k.add_lines('text%d' % i,
640
parents.add('text%d' % i)
643
self.log("k._weave=" + pformat(k._weave))
645
for i, t in enumerate(texts):
646
self.assertEqual(k.get_lines(i), t)
648
self.check_read_write(k)
651
class JoinWeavesTests(TestBase):
653
super(JoinWeavesTests, self).setUp()
654
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)
661
def test_join_empty(self):
662
"""Join two empty weaves."""
663
eq = self.assertEqual
669
def test_join_empty_to_nonempty(self):
670
"""Join empty weave onto nonempty."""
671
self.weave1.join(Weave())
672
self.assertEqual(len(self.weave1), 3)
674
def test_join_unrelated(self):
675
"""Join two weaves with no history in common."""
677
wb.add_lines('b1', [], ['line from b\n'])
680
eq = self.assertEqual
682
eq(sorted(w1.versions()),
683
['b1', 'v1', 'v2', 'v3'])
685
def test_join_related(self):
686
wa = self.weave1.copy()
687
wb = self.weave1.copy()
688
wa.add_lines('a1', ['v3'], ['hello\n', 'sweet\n', 'world\n'])
689
wb.add_lines('b1', ['v3'], ['hello\n', 'pale blue\n', 'world\n'])
690
eq = self.assertEquals
695
eq(wa.get_lines('b1'),
696
['hello\n', 'pale blue\n', 'world\n'])
698
def test_join_text_disagreement(self):
699
"""Cannot join weaves with different texts for a version."""
702
wa.add_lines('v1', [], ['hello\n'])
703
wb.add_lines('v1', [], ['not\n', 'hello\n'])
704
self.assertRaises(WeaveError,
707
def test_join_unordered(self):
708
"""Join weaves where indexes differ.
710
The source weave contains a different version at index 0."""
711
wa = self.weave1.copy()
713
wb.add_lines('x1', [], ['line from x1\n'])
714
wb.add_lines('v1', [], ['hello\n'])
715
wb.add_lines('v2', ['v1'], ['hello\n', 'world\n'])
717
eq = self.assertEquals
718
eq(sorted(wa.versions()), ['v1', 'v2', 'v3', 'x1',])
719
eq(wa.get_text('x1'), 'line from x1\n')
721
def test_written_detection(self):
722
# Test detection of weave file corruption.
724
# Make sure that we can detect if a weave file has
725
# been corrupted. This doesn't test all forms of corruption,
726
# but it at least helps verify the data you get, is what you want.
727
from cStringIO import StringIO
730
w.add_lines('v1', [], ['hello\n'])
731
w.add_lines('v2', ['v1'], ['hello\n', 'there\n'])
736
# Because we are corrupting, we need to make sure we have the exact text
737
self.assertEquals('# bzr weave file v5\n'
738
'i\n1 f572d396fae9206628714fb2ce00f72e94f2258f\nn v1\n\n'
739
'i 0\n1 90f265c6e75f1c8f9ab76dcf85528352c5f215ef\nn v2\n\n'
740
'w\n{ 0\n. hello\n}\n{ 1\n. there\n}\nW\n',
743
# Change a single letter
744
tmpf = StringIO('# bzr weave file v5\n'
745
'i\n1 f572d396fae9206628714fb2ce00f72e94f2258f\nn v1\n\n'
746
'i 0\n1 90f265c6e75f1c8f9ab76dcf85528352c5f215ef\nn v2\n\n'
747
'w\n{ 0\n. hello\n}\n{ 1\n. There\n}\nW\n')
751
self.assertEqual('hello\n', w.get_text('v1'))
752
self.assertRaises(errors.WeaveInvalidChecksum, w.get_text, 'v2')
753
self.assertRaises(errors.WeaveInvalidChecksum, w.get_lines, 'v2')
754
self.assertRaises(errors.WeaveInvalidChecksum, w.check)
756
# Change the sha checksum
757
tmpf = StringIO('# bzr weave file v5\n'
758
'i\n1 f572d396fae9206628714fb2ce00f72e94f2258f\nn v1\n\n'
759
'i 0\n1 f0f265c6e75f1c8f9ab76dcf85528352c5f215ef\nn v2\n\n'
760
'w\n{ 0\n. hello\n}\n{ 1\n. there\n}\nW\n')
764
self.assertEqual('hello\n', w.get_text('v1'))
765
self.assertRaises(errors.WeaveInvalidChecksum, w.get_text, 'v2')
766
self.assertRaises(errors.WeaveInvalidChecksum, w.get_lines, 'v2')
767
self.assertRaises(errors.WeaveInvalidChecksum, w.check)
770
class InstrumentedWeave(Weave):
771
"""Keep track of how many times functions are called."""
773
def __init__(self, weave_name=None):
774
self._extract_count = 0
775
Weave.__init__(self, weave_name=weave_name)
777
def _extract(self, versions):
778
self._extract_count += 1
779
return Weave._extract(self, versions)
782
class JoinOptimization(TestCase):
783
"""Test that Weave.join() doesn't extract all texts, only what must be done."""
786
w1 = InstrumentedWeave()
787
w2 = InstrumentedWeave()
790
txt1 = ['a\n', 'b\n']
791
txt2 = ['a\n', 'c\n']
792
txt3 = ['a\n', 'b\n', 'c\n']
794
w1.add_lines('txt0', [], txt0) # extract 1a
795
w2.add_lines('txt0', [], txt0) # extract 1b
796
w1.add_lines('txt1', ['txt0'], txt1)# extract 2a
797
w2.add_lines('txt2', ['txt0'], txt2)# extract 2b
798
w1.join(w2) # extract 3a to add txt2
799
w2.join(w1) # extract 3b to add txt1
801
w1.add_lines('txt3', ['txt1', 'txt2'], txt3) # extract 4a
802
w2.add_lines('txt3', ['txt2', 'txt1'], txt3) # extract 4b
803
# These secretly have inverted parents
805
# This should not have to do any extractions
806
w1.join(w2) # NO extract, texts already present with same parents
807
w2.join(w1) # NO extract, texts already present with same parents
809
self.assertEqual(4, w1._extract_count)
810
self.assertEqual(4, w2._extract_count)
812
def test_double_parent(self):
813
# It should not be considered illegal to add
814
# a revision with the same parent twice
815
w1 = InstrumentedWeave()
816
w2 = InstrumentedWeave()
819
txt1 = ['a\n', 'b\n']
820
txt2 = ['a\n', 'c\n']
821
txt3 = ['a\n', 'b\n', 'c\n']
823
w1.add_lines('txt0', [], txt0)
824
w2.add_lines('txt0', [], txt0)
825
w1.add_lines('txt1', ['txt0'], txt1)
826
w2.add_lines('txt1', ['txt0', 'txt0'], txt1)
827
# Same text, effectively the same, because the
828
# parent is only repeated
829
w1.join(w2) # extract 3a to add txt2
830
w2.join(w1) # extract 3b to add txt1
833
class TestNeedsReweave(TestCase):
834
"""Internal corner cases for when reweave is needed."""
836
def test_compatible_parents(self):
838
my_parents = set([1, 2, 3])
840
self.assertTrue(w1._compatible_parents(my_parents, set([3])))
842
self.assertTrue(w1._compatible_parents(my_parents, set(my_parents)))
843
# same empty corner case
844
self.assertTrue(w1._compatible_parents(set(), set()))
845
# other cannot contain stuff my_parents does not
846
self.assertFalse(w1._compatible_parents(set(), set([1])))
847
self.assertFalse(w1._compatible_parents(my_parents, set([1, 2, 3, 4])))
848
self.assertFalse(w1._compatible_parents(my_parents, set([4])))
851
class TestWeaveFile(TestCaseInTempDir):
853
def test_empty_file(self):
854
f = open('empty.weave', 'wb+')
856
self.assertRaises(errors.WeaveFormatError,
added
removed
bzrlib/tests/test_weave.py
