3
# Copyright (C) 2005 by Canonical Ltd
1
# Copyright (C) 2005 Canonical Ltd
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
7
5
# the Free Software Foundation; either version 2 of the License, or
8
6
# (at your option) any later version.
10
8
# This program is distributed in the hope that it will be useful,
11
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
11
# GNU General Public License for more details.
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
18
# TODO: tests regarding version names
19
# TODO: rbc 20050108 test that join does not leave an inconsistent weave
24
22
"""test suite for weave algorithm"""
26
24
from pprint import pformat
29
from bzrlib.osutils import sha_string
30
from bzrlib.tests import TestCase, TestCaseInTempDir
28
31
from bzrlib.weave import Weave, WeaveFormatError, WeaveError
29
32
from bzrlib.weavefile import write_weave, read_weave
30
from bzrlib.selftest import TestCase
31
from bzrlib.osutils import sha_string
34
35
# texts for use in testing
73
class StoreText(TestBase):
74
"""Store and retrieve a simple text."""
77
idx = k.add('text0', [], TEXT_0)
78
self.assertEqual(k.get(idx), TEXT_0)
79
self.assertEqual(idx, 0)
83
79
class AnnotateOne(TestBase):
86
k.add('text0', [], TEXT_0)
87
self.assertEqual(k.annotate(0),
91
class StoreTwo(TestBase):
95
idx = k.add('text0', [], TEXT_0)
96
self.assertEqual(idx, 0)
98
idx = k.add('text1', [], TEXT_1)
99
self.assertEqual(idx, 1)
101
self.assertEqual(k.get(0), TEXT_0)
102
self.assertEqual(k.get(1), TEXT_1)
106
class AddWithGivenSha(TestBase):
108
"""Add with caller-supplied SHA-1"""
112
k.add('text0', [], [t], sha1=sha_string(t))
82
k.add_lines('text0', [], TEXT_0)
83
self.assertEqual(k.annotate('text0'),
84
[('text0', TEXT_0[0])])
87
class GetSha1(TestBase):
88
def test_get_sha1(self):
90
k.add_lines('text0', [], 'text0')
91
self.assertEqual('34dc0e430c642a26c3dd1c2beb7a8b4f4445eb79',
93
self.assertRaises(errors.RevisionNotPresent,
95
self.assertRaises(errors.RevisionNotPresent,
116
99
class InvalidAdd(TestBase):
117
100
"""Try to use invalid version number during add."""
118
101
def runTest(self):
121
self.assertRaises(IndexError,
104
self.assertRaises(errors.RevisionNotPresent,
128
111
class RepeatedAdd(TestBase):
129
112
"""Add the same version twice; harmless."""
114
def test_duplicate_add(self):
132
idx = k.add('text0', [], TEXT_0)
133
idx2 = k.add('text0', [], TEXT_0)
116
idx = k.add_lines('text0', [], TEXT_0)
117
idx2 = k.add_lines('text0', [], TEXT_0)
134
118
self.assertEqual(idx, idx2)
138
121
class InvalidRepeatedAdd(TestBase):
139
122
def runTest(self):
141
idx = k.add('text0', [], TEXT_0)
142
self.assertRaises(WeaveError,
124
k.add_lines('basis', [], TEXT_0)
125
idx = k.add_lines('text0', [], TEXT_0)
126
self.assertRaises(errors.RevisionAlreadyPresent,
146
130
['not the same text'])
147
self.assertRaises(WeaveError,
131
self.assertRaises(errors.RevisionAlreadyPresent,
150
[12], # not the right parents
134
['basis'], # not the right parents
155
138
class InsertLines(TestBase):
156
139
"""Store a revision that adds one line to the original.
160
143
def runTest(self):
163
k.add('text0', [], ['line 1'])
164
k.add('text1', [0], ['line 1', 'line 2'])
166
self.assertEqual(k.annotate(0),
169
self.assertEqual(k.get(1),
146
k.add_lines('text0', [], ['line 1'])
147
k.add_lines('text1', ['text0'], ['line 1', 'line 2'])
149
self.assertEqual(k.annotate('text0'),
150
[('text0', 'line 1')])
152
self.assertEqual(k.get_lines(1),
173
self.assertEqual(k.annotate(1),
177
k.add('text2', [0], ['line 1', 'diverged line'])
179
self.assertEqual(k.annotate(2),
181
(2, 'diverged line')])
156
self.assertEqual(k.annotate('text1'),
157
[('text0', 'line 1'),
158
('text1', 'line 2')])
160
k.add_lines('text2', ['text0'], ['line 1', 'diverged line'])
162
self.assertEqual(k.annotate('text2'),
163
[('text0', 'line 1'),
164
('text2', 'diverged line')])
183
166
text3 = ['line 1', 'middle line', 'line 2']
188
171
# self.log("changes to text3: " + pformat(list(k._delta(set([0, 1]), text3))))
190
173
self.log("k._weave=" + pformat(k._weave))
192
self.assertEqual(k.annotate(3),
175
self.assertEqual(k.annotate('text3'),
176
[('text0', 'line 1'),
177
('text3', 'middle line'),
178
('text1', 'line 2')])
197
180
# now multiple insertions at different places
182
['text0', 'text1', 'text3'],
200
183
['line 1', 'aaa', 'middle line', 'bbb', 'line 2', 'ccc'])
202
self.assertEqual(k.annotate(4),
185
self.assertEqual(k.annotate('text4'),
186
[('text0', 'line 1'),
188
('text3', 'middle line'),
212
194
class DeleteLines(TestBase):
561
554
['header', '', 'line from 1', 'fixup line', 'line from 2'],
564
k.add('text0', [], texts[0])
565
k.add('text1', [0], texts[1])
566
k.add('text2', [0], texts[2])
567
k.add('merge', [0, 1, 2], texts[3])
557
k.add_lines('text0', [], texts[0])
558
k.add_lines('text1', ['text0'], texts[1])
559
k.add_lines('text2', ['text0'], texts[2])
560
k.add_lines('merge', ['text0', 'text1', 'text2'], texts[3])
569
562
for i, t in enumerate(texts):
570
self.assertEqual(k.get(i), t)
563
self.assertEqual(k.get_lines(i), t)
572
self.assertEqual(k.annotate(3),
565
self.assertEqual(k.annotate('merge'),
566
[('text0', 'header'),
568
('text1', 'line from 1'),
569
('merge', 'fixup line'),
570
('text2', 'line from 2'),
580
self.assertEqual(list(k.inclusions([3])),
573
self.assertEqual(list(k.get_ancestry(['merge'])),
574
['text0', 'text1', 'text2', 'merge'])
583
576
self.log('k._weave=' + pformat(k._weave))
618
k.add([], ['aaa', 'bbb'])
619
k.add([0], ['111', 'aaa', 'ccc', 'bbb'])
620
k.add([1], ['aaa', 'ccc', 'bbb', '222'])
626
class AutoMerge(TestBase):
630
texts = [['header', 'aaa', 'bbb'],
631
['header', 'aaa', 'line from 1', 'bbb'],
632
['header', 'aaa', 'bbb', 'line from 2', 'more from 2'],
635
k.add('text0', [], texts[0])
636
k.add('text1', [0], texts[1])
637
k.add('text2', [0], texts[2])
639
self.log('k._weave=' + pformat(k._weave))
641
m = list(k.mash_iter([0, 1, 2]))
647
'line from 2', 'more from 2'])
610
k.add_lines([], ['aaa', 'bbb'])
611
k.add_lines([0], ['111', 'aaa', 'ccc', 'bbb'])
612
k.add_lines([1], ['aaa', 'ccc', 'bbb', '222'])
651
615
class Khayyam(TestBase):
652
616
"""Test changes to multi-line texts, and read/write"""
618
def test_multi_line_merge(self):
655
620
"""A Book of Verses underneath the Bough,
656
621
A Jug of Wine, a Loaf of Bread, -- and Thou
685
ver = k.add('text%d' % i,
650
ver = k.add_lines('text%d' % i,
686
651
list(parents), t)
652
parents.add('text%d' % i)
690
655
self.log("k._weave=" + pformat(k._weave))
692
657
for i, t in enumerate(texts):
693
self.assertEqual(k.get(i), t)
658
self.assertEqual(k.get_lines(i), t)
695
660
self.check_read_write(k)
699
class MergeCases(TestBase):
700
def doMerge(self, base, a, b, mp):
701
from cStringIO import StringIO
702
from textwrap import dedent
708
w.add('text0', [], map(addcrlf, base))
709
w.add('text1', [0], map(addcrlf, a))
710
w.add('text2', [0], map(addcrlf, b))
712
self.log('weave is:')
715
self.log(tmpf.getvalue())
717
self.log('merge plan:')
718
p = list(w.plan_merge(1, 2))
719
for state, line in p:
721
self.log('%12s | %s' % (state, line[:-1]))
725
mt.writelines(w.weave_merge(p))
727
self.log(mt.getvalue())
729
mp = map(addcrlf, mp)
730
self.assertEqual(mt.readlines(), mp)
733
def testOneInsert(self):
739
def testSeparateInserts(self):
740
self.doMerge(['aaa', 'bbb', 'ccc'],
741
['aaa', 'xxx', 'bbb', 'ccc'],
742
['aaa', 'bbb', 'yyy', 'ccc'],
743
['aaa', 'xxx', 'bbb', 'yyy', 'ccc'])
745
def testSameInsert(self):
746
self.doMerge(['aaa', 'bbb', 'ccc'],
747
['aaa', 'xxx', 'bbb', 'ccc'],
748
['aaa', 'xxx', 'bbb', 'yyy', 'ccc'],
749
['aaa', 'xxx', 'bbb', 'yyy', 'ccc'])
751
def testOverlappedInsert(self):
752
self.doMerge(['aaa', 'bbb'],
753
['aaa', 'xxx', 'yyy', 'bbb'],
754
['aaa', 'xxx', 'bbb'],
755
['aaa', '<<<<', 'xxx', 'yyy', '====', 'xxx', '>>>>', 'bbb'])
757
# really it ought to reduce this to
758
# ['aaa', 'xxx', 'yyy', 'bbb']
761
def testClashReplace(self):
762
self.doMerge(['aaa'],
765
['<<<<', 'xxx', '====', 'yyy', 'zzz', '>>>>'])
767
def testNonClashInsert(self):
768
self.doMerge(['aaa'],
771
['<<<<', 'xxx', 'aaa', '====', 'yyy', 'zzz', '>>>>'])
773
self.doMerge(['aaa'],
779
def testDeleteAndModify(self):
780
"""Clashing delete and modification.
782
If one side modifies a region and the other deletes it then
783
there should be a conflict with one side blank.
786
#######################################
787
# skippd, not working yet
790
self.doMerge(['aaa', 'bbb', 'ccc'],
791
['aaa', 'ddd', 'ccc'],
793
['<<<<', 'aaa', '====', '>>>>', 'ccc'])
796
663
class JoinWeavesTests(TestBase):
798
665
super(JoinWeavesTests, self).setUp()
799
666
self.weave1 = Weave()
800
667
self.lines1 = ['hello\n']
801
668
self.lines3 = ['hello\n', 'cruel\n', 'world\n']
802
self.weave1.add('v1', [], self.lines1)
803
self.weave1.add('v2', [0], ['hello\n', 'world\n'])
804
self.weave1.add('v3', [1], self.lines3)
669
self.weave1.add_lines('v1', [], self.lines1)
670
self.weave1.add_lines('v2', ['v1'], ['hello\n', 'world\n'])
671
self.weave1.add_lines('v3', ['v2'], self.lines3)
806
673
def test_join_empty(self):
807
674
"""Join two empty weaves."""
840
707
eq(wa.get_lines('b1'),
841
708
['hello\n', 'pale blue\n', 'world\n'])
844
if __name__ == '__main__':
847
sys.exit(unittest.main())
710
def test_join_text_disagreement(self):
711
"""Cannot join weaves with different texts for a version."""
714
wa.add_lines('v1', [], ['hello\n'])
715
wb.add_lines('v1', [], ['not\n', 'hello\n'])
716
self.assertRaises(WeaveError,
719
def test_join_unordered(self):
720
"""Join weaves where indexes differ.
722
The source weave contains a different version at index 0."""
723
wa = self.weave1.copy()
725
wb.add_lines('x1', [], ['line from x1\n'])
726
wb.add_lines('v1', [], ['hello\n'])
727
wb.add_lines('v2', ['v1'], ['hello\n', 'world\n'])
729
eq = self.assertEquals
730
eq(sorted(wa.versions()), ['v1', 'v2', 'v3', 'x1',])
731
eq(wa.get_text('x1'), 'line from x1\n')
733
def test_written_detection(self):
734
# Test detection of weave file corruption.
736
# Make sure that we can detect if a weave file has
737
# been corrupted. This doesn't test all forms of corruption,
738
# but it at least helps verify the data you get, is what you want.
739
from cStringIO import StringIO
742
w.add_lines('v1', [], ['hello\n'])
743
w.add_lines('v2', ['v1'], ['hello\n', 'there\n'])
748
# Because we are corrupting, we need to make sure we have the exact text
749
self.assertEquals('# bzr weave file v5\n'
750
'i\n1 f572d396fae9206628714fb2ce00f72e94f2258f\nn v1\n\n'
751
'i 0\n1 90f265c6e75f1c8f9ab76dcf85528352c5f215ef\nn v2\n\n'
752
'w\n{ 0\n. hello\n}\n{ 1\n. there\n}\nW\n',
755
# Change a single letter
756
tmpf = StringIO('# bzr weave file v5\n'
757
'i\n1 f572d396fae9206628714fb2ce00f72e94f2258f\nn v1\n\n'
758
'i 0\n1 90f265c6e75f1c8f9ab76dcf85528352c5f215ef\nn v2\n\n'
759
'w\n{ 0\n. hello\n}\n{ 1\n. There\n}\nW\n')
763
self.assertEqual('hello\n', w.get_text('v1'))
764
self.assertRaises(errors.WeaveInvalidChecksum, w.get_text, 'v2')
765
self.assertRaises(errors.WeaveInvalidChecksum, w.get_lines, 'v2')
766
self.assertRaises(errors.WeaveInvalidChecksum, w.check)
768
# Change the sha checksum
769
tmpf = StringIO('# bzr weave file v5\n'
770
'i\n1 f572d396fae9206628714fb2ce00f72e94f2258f\nn v1\n\n'
771
'i 0\n1 f0f265c6e75f1c8f9ab76dcf85528352c5f215ef\nn v2\n\n'
772
'w\n{ 0\n. hello\n}\n{ 1\n. there\n}\nW\n')
776
self.assertEqual('hello\n', w.get_text('v1'))
777
self.assertRaises(errors.WeaveInvalidChecksum, w.get_text, 'v2')
778
self.assertRaises(errors.WeaveInvalidChecksum, w.get_lines, 'v2')
779
self.assertRaises(errors.WeaveInvalidChecksum, w.check)
782
class InstrumentedWeave(Weave):
783
"""Keep track of how many times functions are called."""
785
def __init__(self, weave_name=None):
786
self._extract_count = 0
787
Weave.__init__(self, weave_name=weave_name)
789
def _extract(self, versions):
790
self._extract_count += 1
791
return Weave._extract(self, versions)
794
class JoinOptimization(TestCase):
795
"""Test that Weave.join() doesn't extract all texts, only what must be done."""
798
w1 = InstrumentedWeave()
799
w2 = InstrumentedWeave()
802
txt1 = ['a\n', 'b\n']
803
txt2 = ['a\n', 'c\n']
804
txt3 = ['a\n', 'b\n', 'c\n']
806
w1.add_lines('txt0', [], txt0) # extract 1a
807
w2.add_lines('txt0', [], txt0) # extract 1b
808
w1.add_lines('txt1', ['txt0'], txt1)# extract 2a
809
w2.add_lines('txt2', ['txt0'], txt2)# extract 2b
810
w1.join(w2) # extract 3a to add txt2
811
w2.join(w1) # extract 3b to add txt1
813
w1.add_lines('txt3', ['txt1', 'txt2'], txt3) # extract 4a
814
w2.add_lines('txt3', ['txt2', 'txt1'], txt3) # extract 4b
815
# These secretly have inverted parents
817
# This should not have to do any extractions
818
w1.join(w2) # NO extract, texts already present with same parents
819
w2.join(w1) # NO extract, texts already present with same parents
821
self.assertEqual(4, w1._extract_count)
822
self.assertEqual(4, w2._extract_count)
824
def test_double_parent(self):
825
# It should not be considered illegal to add
826
# a revision with the same parent twice
827
w1 = InstrumentedWeave()
828
w2 = InstrumentedWeave()
831
txt1 = ['a\n', 'b\n']
832
txt2 = ['a\n', 'c\n']
833
txt3 = ['a\n', 'b\n', 'c\n']
835
w1.add_lines('txt0', [], txt0)
836
w2.add_lines('txt0', [], txt0)
837
w1.add_lines('txt1', ['txt0'], txt1)
838
w2.add_lines('txt1', ['txt0', 'txt0'], txt1)
839
# Same text, effectively the same, because the
840
# parent is only repeated
841
w1.join(w2) # extract 3a to add txt2
842
w2.join(w1) # extract 3b to add txt1
845
class TestNeedsReweave(TestCase):
846
"""Internal corner cases for when reweave is needed."""
848
def test_compatible_parents(self):
850
my_parents = set([1, 2, 3])
852
self.assertTrue(w1._compatible_parents(my_parents, set([3])))
854
self.assertTrue(w1._compatible_parents(my_parents, set(my_parents)))
855
# same empty corner case
856
self.assertTrue(w1._compatible_parents(set(), set()))
857
# other cannot contain stuff my_parents does not
858
self.assertFalse(w1._compatible_parents(set(), set([1])))
859
self.assertFalse(w1._compatible_parents(my_parents, set([1, 2, 3, 4])))
860
self.assertFalse(w1._compatible_parents(my_parents, set([4])))
863
class TestWeaveFile(TestCaseInTempDir):
865
def test_empty_file(self):
866
f = open('empty.weave', 'wb+')
868
self.assertRaises(errors.WeaveFormatError,