1
# Copyright (C) 2005-2011, 2016 Canonical Ltd
3
# Copyright (C) 2005 by Canonical Ltd
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
5
7
# the Free Software Foundation; either version 2 of the License, or
6
8
# (at your option) any later version.
8
10
# This program is distributed in the hope that it will be useful,
9
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
13
# GNU General Public License for more details.
13
15
# You should have received a copy of the GNU General Public License
14
16
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
20
# TODO: tests regarding version names
19
# TODO: rbc 20050108 test that join does not leave an inconsistent weave
22
24
"""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
28
from bzrlib.weave import Weave, WeaveFormatError
32
29
from bzrlib.weavefile import write_weave, read_weave
30
from pprint import pformat
37
from sets import Set, ImmutableSet
39
frozenset = ImmutableSet
35
44
# texts for use in testing
59
68
self.log(' %r' % k._parents)
60
69
self.log(' %r' % k2._parents)
62
73
self.fail('read/write check failed')
65
class WeaveContains(TestBase):
66
"""Weave __contains__ operator"""
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)
75
78
class Easy(TestBase):
83
class StoreText(TestBase):
84
"""Store and retrieve a simple text."""
87
idx = k.add('text0', [], TEXT_0)
88
self.assertEqual(k.get(idx), TEXT_0)
89
self.assertEqual(idx, 0)
81
93
class AnnotateOne(TestBase):
85
k.add_lines('text0', [], TEXT_0)
86
self.assertEqual(k.annotate('text0'),
87
[('text0', TEXT_0[0])])
96
k.add('text0', [], TEXT_0)
97
self.assertEqual(k.annotate(0),
101
class StoreTwo(TestBase):
105
idx = k.add('text0', [], TEXT_0)
106
self.assertEqual(idx, 0)
108
idx = k.add('text1', [], TEXT_1)
109
self.assertEqual(idx, 1)
111
self.assertEqual(k.get(0), TEXT_0)
112
self.assertEqual(k.get(1), TEXT_1)
114
k.dump(self.TEST_LOG)
90
118
class InvalidAdd(TestBase):
91
119
"""Try to use invalid version number during add."""
93
120
def runTest(self):
96
self.assertRaises(errors.RevisionNotPresent,
123
self.assertRaises(IndexError,
103
class RepeatedAdd(TestBase):
104
"""Add the same version twice; harmless."""
106
def test_duplicate_add(self):
108
idx = k.add_lines('text0', [], TEXT_0)
109
idx2 = k.add_lines('text0', [], TEXT_0)
110
self.assertEqual(idx, idx2)
113
class InvalidRepeatedAdd(TestBase):
117
k.add_lines('basis', [], TEXT_0)
118
idx = k.add_lines('text0', [], TEXT_0)
119
self.assertRaises(errors.RevisionAlreadyPresent,
123
['not the same text'])
124
self.assertRaises(errors.RevisionAlreadyPresent,
127
['basis'], # not the right parents
131
130
class InsertLines(TestBase):
132
131
"""Store a revision that adds one line to the original.
136
135
def runTest(self):
139
k.add_lines('text0', [], ['line 1'])
140
k.add_lines('text1', ['text0'], ['line 1', 'line 2'])
142
self.assertEqual(k.annotate('text0'),
143
[('text0', 'line 1')])
145
self.assertEqual(k.get_lines(1),
138
k.add('text0', [], ['line 1'])
139
k.add('text1', [0], ['line 1', 'line 2'])
141
self.assertEqual(k.annotate(0),
144
self.assertEqual(k.get(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')])
148
self.assertEqual(k.annotate(1),
152
k.add('text2', [0], ['line 1', 'diverged line'])
154
self.assertEqual(k.annotate(2),
156
(2, 'diverged line')])
159
158
text3 = ['line 1', 'middle line', 'line 2']
164
163
# self.log("changes to text3: " + pformat(list(k._delta(set([0, 1]), text3))))
166
165
self.log("k._weave=" + pformat(k._weave))
168
self.assertEqual(k.annotate('text3'),
169
[('text0', 'line 1'),
170
('text3', 'middle line'),
171
('text1', 'line 2')])
167
self.assertEqual(k.annotate(3),
173
172
# now multiple insertions at different places
175
['text0', 'text1', 'text3'],
176
175
['line 1', 'aaa', 'middle line', 'bbb', 'line 2', 'ccc'])
178
self.assertEqual(k.annotate('text4'),
179
[('text0', 'line 1'),
181
('text3', 'middle line'),
177
self.assertEqual(k.annotate(4),
187
187
class DeleteLines(TestBase):
548
538
['header', '', 'line from 1', 'fixup line', 'line from 2'],
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])
541
k.add('text0', [], texts[0])
542
k.add('text1', [0], texts[1])
543
k.add('text2', [0], texts[2])
544
k.add('merge', [0, 1, 2], texts[3])
556
546
for i, t in enumerate(texts):
557
self.assertEqual(k.get_lines(i), t)
547
self.assertEqual(k.get(i), t)
559
self.assertEqual(k.annotate('merge'),
560
[('text0', 'header'),
562
('text1', 'line from 1'),
563
('merge', 'fixup line'),
564
('text2', 'line from 2'),
549
self.assertEqual(k.annotate(3),
567
self.assertEqual(list(k.get_ancestry(['merge'])),
568
['text0', 'text1', 'text2', 'merge'])
557
self.assertEqual(list(k.inclusions([3])),
570
560
self.log('k._weave=' + pformat(k._weave))
604
k.add_lines([], ['aaa', 'bbb'])
605
k.add_lines([0], ['111', 'aaa', 'ccc', 'bbb'])
606
k.add_lines([1], ['aaa', 'ccc', 'bbb', '222'])
595
k.add([], ['aaa', 'bbb'])
596
k.add([0], ['111', 'aaa', 'ccc', 'bbb'])
597
k.add([1], ['aaa', 'ccc', 'bbb', '222'])
603
class AutoMerge(TestBase):
607
texts = [['header', 'aaa', 'bbb'],
608
['header', 'aaa', 'line from 1', 'bbb'],
609
['header', 'aaa', 'bbb', 'line from 2', 'more from 2'],
612
k.add('text0', [], texts[0])
613
k.add('text1', [0], texts[1])
614
k.add('text2', [0], texts[2])
616
self.log('k._weave=' + pformat(k._weave))
618
m = list(k.mash_iter([0, 1, 2]))
624
'line from 2', 'more from 2'])
609
628
class Khayyam(TestBase):
610
629
"""Test changes to multi-line texts, and read/write"""
612
def test_multi_line_merge(self):
614
632
"""A Book of Verses underneath the Bough,
615
633
A Jug of Wine, a Loaf of Bread, -- and Thou
616
634
Beside me singing in the Wilderness --
617
635
Oh, Wilderness were Paradise enow!""",
619
637
"""A Book of Verses underneath the Bough,
620
638
A Jug of Wine, a Loaf of Bread, -- and Thou
621
639
Beside me singing in the Wilderness --
644
ver = k.add_lines('text%d' % i,
662
ver = k.add('text%d' % i,
645
663
list(parents), t)
646
parents.add('text%d' % i)
649
667
self.log("k._weave=" + pformat(k._weave))
651
669
for i, t in enumerate(texts):
652
self.assertEqual(k.get_lines(i), t)
670
self.assertEqual(k.get(i), t)
654
672
self.check_read_write(k)
657
class JoinWeavesTests(TestBase):
660
super(JoinWeavesTests, self).setUp()
661
self.weave1 = Weave()
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)
668
def test_written_detection(self):
669
# Test detection of weave file corruption.
671
# Make sure that we can detect if a weave file has
672
# been corrupted. This doesn't test all forms of corruption,
673
# but it at least helps verify the data you get, is what you want.
676
class MergeCases(TestBase):
677
def doMerge(self, base, a, b, mp):
674
678
from cStringIO import StringIO
679
from textwrap import dedent
677
w.add_lines('v1', [], ['hello\n'])
678
w.add_lines('v2', ['v1'], ['hello\n', 'there\n'])
685
w.add('text0', [], map(addcrlf, base))
686
w.add('text1', [0], map(addcrlf, a))
687
w.add('text2', [0], map(addcrlf, b))
689
self.log('weave is:')
680
690
tmpf = StringIO()
681
691
write_weave(w, tmpf)
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',
690
# Change a single letter
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')
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)
703
# Change the sha checksum
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')
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)
717
class TestWeave(TestCase):
719
def test_allow_reserved_false(self):
720
w = Weave('name', allow_reserved=False)
721
# Add lines is checked at the WeaveFile level, not at the Weave level
722
w.add_lines('name:', [], TEXT_1)
723
# But get_lines is checked at this level
724
self.assertRaises(errors.ReservedId, w.get_lines, 'name:')
726
def test_allow_reserved_true(self):
727
w = Weave('name', allow_reserved=True)
728
w.add_lines('name:', [], TEXT_1)
729
self.assertEqual(TEXT_1, w.get_lines('name:'))
732
class InstrumentedWeave(Weave):
733
"""Keep track of how many times functions are called."""
735
def __init__(self, weave_name=None):
736
self._extract_count = 0
737
Weave.__init__(self, weave_name=weave_name)
739
def _extract(self, versions):
740
self._extract_count += 1
741
return Weave._extract(self, versions)
744
class TestNeedsReweave(TestCase):
745
"""Internal corner cases for when reweave is needed."""
747
def test_compatible_parents(self):
749
my_parents = set([1, 2, 3])
751
self.assertTrue(w1._compatible_parents(my_parents, set([3])))
753
self.assertTrue(w1._compatible_parents(my_parents, set(my_parents)))
754
# same empty corner case
755
self.assertTrue(w1._compatible_parents(set(), set()))
756
# other cannot contain stuff my_parents does not
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])))
762
class TestWeaveFile(TestCaseInTempDir):
764
def test_empty_file(self):
765
f = open('empty.weave', 'wb+')
767
self.assertRaises(errors.WeaveFormatError,
692
self.log(tmpf.getvalue())
694
self.log('merge plan:')
695
p = list(w.plan_merge(1, 2))
696
for state, line in p:
698
self.log('%12s | %s' % (state, line[:-1]))
702
mt.writelines(w.weave_merge(p))
704
self.log(mt.getvalue())
706
mp = map(addcrlf, mp)
707
self.assertEqual(mt.readlines(), mp)
710
def testOneInsert(self):
716
def testSeparateInserts(self):
717
self.doMerge(['aaa', 'bbb', 'ccc'],
718
['aaa', 'xxx', 'bbb', 'ccc'],
719
['aaa', 'bbb', 'yyy', 'ccc'],
720
['aaa', 'xxx', 'bbb', 'yyy', 'ccc'])
722
def testSameInsert(self):
723
self.doMerge(['aaa', 'bbb', 'ccc'],
724
['aaa', 'xxx', 'bbb', 'ccc'],
725
['aaa', 'xxx', 'bbb', 'yyy', 'ccc'],
726
['aaa', 'xxx', 'bbb', 'yyy', 'ccc'])
728
def testOverlappedInsert(self):
729
self.doMerge(['aaa', 'bbb'],
730
['aaa', 'xxx', 'yyy', 'bbb'],
731
['aaa', 'xxx', 'bbb'],
732
['aaa', '<<<<', 'xxx', 'yyy', '====', 'xxx', '>>>>', 'bbb'])
734
# really it ought to reduce this to
735
# ['aaa', 'xxx', 'yyy', 'bbb']
738
def testClashReplace(self):
739
self.doMerge(['aaa'],
742
['<<<<', 'xxx', '====', 'yyy', 'zzz', '>>>>'])
744
def testNonClashInsert(self):
745
self.doMerge(['aaa'],
748
['<<<<', 'xxx', 'aaa', '====', 'yyy', 'zzz', '>>>>'])
750
self.doMerge(['aaa'],
756
def testDeleteAndModify(self):
757
"""Clashing delete and modification.
759
If one side modifies a region and the other deletes it then
760
there should be a conflict with one side blank.
763
#######################################
764
# skippd, not working yet
767
self.doMerge(['aaa', 'bbb', 'ccc'],
768
['aaa', 'ddd', 'ccc'],
770
['<<<<', 'aaa', '====', '>>>>', 'ccc'])
776
from unittest import TestSuite, TestLoader
781
suite.addTest(tl.loadTestsFromModule(testweave))
783
return int(not testsweet.run_suite(suite)) # for shell 0=true
786
if __name__ == '__main__':
788
sys.exit(testweave())