~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_weave.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-13 14:33:10 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813143310-twhj4la0qnupvze8
Added Quick Start Summary

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2009, 2011 Canonical Ltd
 
1
# Copyright (C) 2005 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
18
# TODO: tests regarding version names
19
 
# TODO: rbc 20050108 test that join does not leave an inconsistent weave
 
19
# TODO: rbc 20050108 test that join does not leave an inconsistent weave 
20
20
#       if it fails.
21
21
 
22
22
"""test suite for weave algorithm"""
28
28
    )
29
29
from bzrlib.osutils import sha_string
30
30
from bzrlib.tests import TestCase, TestCaseInTempDir
31
 
from bzrlib.weave import Weave, WeaveFormatError
 
31
from bzrlib.weave import Weave, WeaveFormatError, WeaveError, reweave
32
32
from bzrlib.weavefile import write_weave, read_weave
33
33
 
34
34
 
39
39
 
40
40
 
41
41
class TestBase(TestCase):
42
 
 
43
42
    def check_read_write(self, k):
44
43
        """Check the weave k can be written & re-read."""
45
44
        from tempfile import TemporaryFile
64
63
 
65
64
class WeaveContains(TestBase):
66
65
    """Weave __contains__ operator"""
67
 
 
68
66
    def runTest(self):
69
 
        k = Weave(get_scope=lambda:None)
 
67
        k = Weave()
70
68
        self.assertFalse('foo' in k)
71
69
        k.add_lines('foo', [], TEXT_1)
72
70
        self.assertTrue('foo' in k)
73
71
 
74
72
 
75
73
class Easy(TestBase):
76
 
 
77
74
    def runTest(self):
78
75
        k = Weave()
79
76
 
80
77
 
 
78
class StoreText(TestBase):
 
79
    """Store and retrieve a simple text."""
 
80
 
 
81
    def test_storing_text(self):
 
82
        k = Weave()
 
83
        idx = k.add_lines('text0', [], TEXT_0)
 
84
        self.assertEqual(k.get_lines(idx), TEXT_0)
 
85
        self.assertEqual(idx, 0)
 
86
 
 
87
 
81
88
class AnnotateOne(TestBase):
82
 
 
83
89
    def runTest(self):
84
90
        k = Weave()
85
91
        k.add_lines('text0', [], TEXT_0)
87
93
                         [('text0', TEXT_0[0])])
88
94
 
89
95
 
 
96
class StoreTwo(TestBase):
 
97
    def runTest(self):
 
98
        k = Weave()
 
99
 
 
100
        idx = k.add_lines('text0', [], TEXT_0)
 
101
        self.assertEqual(idx, 0)
 
102
 
 
103
        idx = k.add_lines('text1', [], TEXT_1)
 
104
        self.assertEqual(idx, 1)
 
105
 
 
106
        self.assertEqual(k.get_lines(0), TEXT_0)
 
107
        self.assertEqual(k.get_lines(1), TEXT_1)
 
108
 
 
109
 
 
110
class GetSha1(TestBase):
 
111
    def test_get_sha1(self):
 
112
        k = Weave()
 
113
        k.add_lines('text0', [], 'text0')
 
114
        self.assertEqual('34dc0e430c642a26c3dd1c2beb7a8b4f4445eb79',
 
115
                         k.get_sha1('text0'))
 
116
        self.assertRaises(errors.RevisionNotPresent,
 
117
                          k.get_sha1, 0)
 
118
        self.assertRaises(errors.RevisionNotPresent,
 
119
                          k.get_sha1, 'text1')
 
120
                        
 
121
 
90
122
class InvalidAdd(TestBase):
91
123
    """Try to use invalid version number during add."""
92
 
 
93
124
    def runTest(self):
94
125
        k = Weave()
95
126
 
102
133
 
103
134
class RepeatedAdd(TestBase):
104
135
    """Add the same version twice; harmless."""
105
 
 
106
 
    def test_duplicate_add(self):
 
136
    def runTest(self):
107
137
        k = Weave()
108
138
        idx = k.add_lines('text0', [], TEXT_0)
109
139
        idx2 = k.add_lines('text0', [], TEXT_0)
111
141
 
112
142
 
113
143
class InvalidRepeatedAdd(TestBase):
114
 
 
115
144
    def runTest(self):
116
145
        k = Weave()
117
146
        k.add_lines('basis', [], TEXT_0)
126
155
                          'text0',
127
156
                          ['basis'],         # not the right parents
128
157
                          TEXT_0)
129
 
 
 
158
        
130
159
 
131
160
class InsertLines(TestBase):
132
161
    """Store a revision that adds one line to the original.
175
204
              ['text0', 'text1', 'text3'],
176
205
              ['line 1', 'aaa', 'middle line', 'bbb', 'line 2', 'ccc'])
177
206
 
178
 
        self.assertEqual(k.annotate('text4'),
 
207
        self.assertEqual(k.annotate('text4'), 
179
208
                         [('text0', 'line 1'),
180
209
                          ('text4', 'aaa'),
181
210
                          ('text3', 'middle line'),
194
223
        base_text = ['one', 'two', 'three', 'four']
195
224
 
196
225
        k.add_lines('text0', [], base_text)
197
 
 
 
226
        
198
227
        texts = [['one', 'two', 'three'],
199
228
                 ['two', 'three', 'four'],
200
229
                 ['one', 'four'],
231
260
                ]
232
261
        ################################### SKIPPED
233
262
        # Weave.get doesn't trap this anymore
234
 
        return
 
263
        return 
235
264
 
236
265
        self.assertRaises(WeaveFormatError,
237
266
                          k.get_lines,
238
 
                          0)
 
267
                          0)        
239
268
 
240
269
 
241
270
class CannedDelete(TestBase):
283
312
                'line to be deleted',
284
313
                (']', 1),
285
314
                ('{', 1),
286
 
                'replacement line',
 
315
                'replacement line',                
287
316
                ('}', 1),
288
317
                'last line',
289
318
                ('}', 0),
326
355
 
327
356
        ################################### SKIPPED
328
357
        # Weave.get doesn't trap this anymore
329
 
        return
 
358
        return 
330
359
 
331
360
 
332
361
        self.assertRaises(WeaveFormatError,
404
433
                          '  added in version 1',
405
434
                          '  also from v1',
406
435
                          '}'])
407
 
 
 
436
                       
408
437
        self.assertEqual(k.get_lines(2),
409
438
                         ['foo {',
410
439
                          '  added in v2',
416
445
                          '  added in v2',
417
446
                          '  also from v1',
418
447
                          '}'])
419
 
 
 
448
                         
420
449
 
421
450
class DeleteLines2(TestBase):
422
451
    """Test recording revisions that delete lines.
498
527
                ('}', 1),
499
528
                ('{', 2),
500
529
                "alternative second line",
501
 
                ('}', 2),
 
530
                ('}', 2),                
502
531
                ]
503
532
 
504
533
        k._sha1s = [sha_string('first line')
526
555
 
527
556
        text0 = ['cheddar', 'stilton', 'gruyere']
528
557
        text1 = ['cheddar', 'blue vein', 'neufchatel', 'chevre']
529
 
 
 
558
        
530
559
        k.add_lines('text0', [], text0)
531
560
        k.add_lines('text1', ['text0'], text1)
532
561
 
538
567
 
539
568
class Merge(TestBase):
540
569
    """Storage of versions that merge diverged parents"""
541
 
 
542
570
    def runTest(self):
543
571
        k = Weave()
544
572
 
615
643
            A Jug of Wine, a Loaf of Bread, -- and Thou
616
644
            Beside me singing in the Wilderness --
617
645
            Oh, Wilderness were Paradise enow!""",
618
 
 
 
646
            
619
647
            """A Book of Verses underneath the Bough,
620
648
            A Jug of Wine, a Loaf of Bread, -- and Thou
621
649
            Beside me singing in the Wilderness --
655
683
 
656
684
 
657
685
class JoinWeavesTests(TestBase):
658
 
 
659
686
    def setUp(self):
660
687
        super(JoinWeavesTests, self).setUp()
661
688
        self.weave1 = Weave()
664
691
        self.weave1.add_lines('v1', [], self.lines1)
665
692
        self.weave1.add_lines('v2', ['v1'], ['hello\n', 'world\n'])
666
693
        self.weave1.add_lines('v3', ['v2'], self.lines3)
 
694
        
 
695
    def test_join_empty(self):
 
696
        """Join two empty weaves."""
 
697
        eq = self.assertEqual
 
698
        w1 = Weave()
 
699
        w2 = Weave()
 
700
        w1.join(w2)
 
701
        eq(len(w1), 0)
 
702
        
 
703
    def test_join_empty_to_nonempty(self):
 
704
        """Join empty weave onto nonempty."""
 
705
        self.weave1.join(Weave())
 
706
        self.assertEqual(len(self.weave1), 3)
 
707
 
 
708
    def test_join_unrelated(self):
 
709
        """Join two weaves with no history in common."""
 
710
        wb = Weave()
 
711
        wb.add_lines('b1', [], ['line from b\n'])
 
712
        w1 = self.weave1
 
713
        w1.join(wb)
 
714
        eq = self.assertEqual
 
715
        eq(len(w1), 4)
 
716
        eq(sorted(w1.versions()),
 
717
           ['b1', 'v1', 'v2', 'v3'])
 
718
 
 
719
    def test_join_related(self):
 
720
        wa = self.weave1.copy()
 
721
        wb = self.weave1.copy()
 
722
        wa.add_lines('a1', ['v3'], ['hello\n', 'sweet\n', 'world\n'])
 
723
        wb.add_lines('b1', ['v3'], ['hello\n', 'pale blue\n', 'world\n'])
 
724
        eq = self.assertEquals
 
725
        eq(len(wa), 4)
 
726
        eq(len(wb), 4)
 
727
        wa.join(wb)
 
728
        eq(len(wa), 5)
 
729
        eq(wa.get_lines('b1'),
 
730
           ['hello\n', 'pale blue\n', 'world\n'])
 
731
 
 
732
    def test_join_parent_disagreement(self):
 
733
        #join reconciles differening parents into a union.
 
734
        wa = Weave()
 
735
        wb = Weave()
 
736
        wa.add_lines('v1', [], ['hello\n'])
 
737
        wb.add_lines('v0', [], [])
 
738
        wb.add_lines('v1', ['v0'], ['hello\n'])
 
739
        wa.join(wb)
 
740
        self.assertEqual(['v0'], wa.get_parents('v1'))
 
741
 
 
742
    def test_join_text_disagreement(self):
 
743
        """Cannot join weaves with different texts for a version."""
 
744
        wa = Weave()
 
745
        wb = Weave()
 
746
        wa.add_lines('v1', [], ['hello\n'])
 
747
        wb.add_lines('v1', [], ['not\n', 'hello\n'])
 
748
        self.assertRaises(WeaveError,
 
749
                          wa.join, wb)
 
750
 
 
751
    def test_join_unordered(self):
 
752
        """Join weaves where indexes differ.
 
753
        
 
754
        The source weave contains a different version at index 0."""
 
755
        wa = self.weave1.copy()
 
756
        wb = Weave()
 
757
        wb.add_lines('x1', [], ['line from x1\n'])
 
758
        wb.add_lines('v1', [], ['hello\n'])
 
759
        wb.add_lines('v2', ['v1'], ['hello\n', 'world\n'])
 
760
        wa.join(wb)
 
761
        eq = self.assertEquals
 
762
        eq(sorted(wa.versions()), ['v1', 'v2', 'v3', 'x1',])
 
763
        eq(wa.get_text('x1'), 'line from x1\n')
667
764
 
668
765
    def test_written_detection(self):
669
766
        # Test detection of weave file corruption.
714
811
        self.assertRaises(errors.WeaveInvalidChecksum, w.check)
715
812
 
716
813
 
717
 
class TestWeave(TestCase):
718
 
 
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:')
725
 
 
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:'))
730
 
 
731
 
 
732
814
class InstrumentedWeave(Weave):
733
815
    """Keep track of how many times functions are called."""
734
 
 
 
816
    
735
817
    def __init__(self, weave_name=None):
736
818
        self._extract_count = 0
737
819
        Weave.__init__(self, weave_name=weave_name)
741
823
        return Weave._extract(self, versions)
742
824
 
743
825
 
 
826
class JoinOptimization(TestCase):
 
827
    """Test that Weave.join() doesn't extract all texts, only what must be done."""
 
828
 
 
829
    def test_join(self):
 
830
        w1 = InstrumentedWeave()
 
831
        w2 = InstrumentedWeave()
 
832
 
 
833
        txt0 = ['a\n']
 
834
        txt1 = ['a\n', 'b\n']
 
835
        txt2 = ['a\n', 'c\n']
 
836
        txt3 = ['a\n', 'b\n', 'c\n']
 
837
 
 
838
        w1.add_lines('txt0', [], txt0) # extract 1a
 
839
        w2.add_lines('txt0', [], txt0) # extract 1b
 
840
        w1.add_lines('txt1', ['txt0'], txt1)# extract 2a
 
841
        w2.add_lines('txt2', ['txt0'], txt2)# extract 2b
 
842
        w1.join(w2) # extract 3a to add txt2 
 
843
        w2.join(w1) # extract 3b to add txt1 
 
844
 
 
845
        w1.add_lines('txt3', ['txt1', 'txt2'], txt3) # extract 4a 
 
846
        w2.add_lines('txt3', ['txt2', 'txt1'], txt3) # extract 4b
 
847
        # These secretly have inverted parents
 
848
 
 
849
        # This should not have to do any extractions
 
850
        w1.join(w2) # NO extract, texts already present with same parents
 
851
        w2.join(w1) # NO extract, texts already present with same parents
 
852
 
 
853
        self.assertEqual(4, w1._extract_count)
 
854
        self.assertEqual(4, w2._extract_count)
 
855
 
 
856
    def test_double_parent(self):
 
857
        # It should not be considered illegal to add
 
858
        # a revision with the same parent twice
 
859
        w1 = InstrumentedWeave()
 
860
        w2 = InstrumentedWeave()
 
861
 
 
862
        txt0 = ['a\n']
 
863
        txt1 = ['a\n', 'b\n']
 
864
        txt2 = ['a\n', 'c\n']
 
865
        txt3 = ['a\n', 'b\n', 'c\n']
 
866
 
 
867
        w1.add_lines('txt0', [], txt0)
 
868
        w2.add_lines('txt0', [], txt0)
 
869
        w1.add_lines('txt1', ['txt0'], txt1)
 
870
        w2.add_lines('txt1', ['txt0', 'txt0'], txt1)
 
871
        # Same text, effectively the same, because the
 
872
        # parent is only repeated
 
873
        w1.join(w2) # extract 3a to add txt2 
 
874
        w2.join(w1) # extract 3b to add txt1 
 
875
 
 
876
 
744
877
class TestNeedsReweave(TestCase):
745
878
    """Internal corner cases for when reweave is needed."""
746
879
 
760
893
 
761
894
 
762
895
class TestWeaveFile(TestCaseInTempDir):
763
 
 
 
896
    
764
897
    def test_empty_file(self):
765
898
        f = open('empty.weave', 'wb+')
766
899
        try: