← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_versionedfile.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-09-11 06:10:59 UTC
  • mfrom: (3702.1.1 trivial)
  • Revision ID: pqm@pqm.ubuntu.com-20080911061059-svzqfejar17ui4zw
(mbp) KnitVersionedFiles repr

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_versionedfile.py
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2005 Canonical Ltd
2
2
#
3
3
# Authors:
4
4
#   Johan Rydberg <jrydberg@gnu.org>
15
15
#
16
16
# You should have received a copy of the GNU General Public License
17
17
# along with this program; if not, write to the Free Software
18
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
18
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
19
 
20
20
 
21
21
# TODO: might be nice to create a versionedfile with some type of corruption
22
22
# considered typical and check that it can be detected/corrected.
23
23
 
24
 
from gzip import GzipFile
25
 
from itertools import chain, izip
 
24
from itertools import chain
26
25
from StringIO import StringIO
27
26
 
 
27
import bzrlib
28
28
from bzrlib import (
29
29
    errors,
30
 
    graph as _mod_graph,
31
 
    groupcompress,
32
 
    knit as _mod_knit,
33
30
    osutils,
34
31
    progress,
35
 
    transport,
36
 
    ui,
37
32
    )
38
33
from bzrlib.errors import (
39
34
                           RevisionNotPresent,
40
35
                           RevisionAlreadyPresent,
 
36
                           WeaveParentMismatch
41
37
                           )
 
38
from bzrlib import knit as _mod_knit
42
39
from bzrlib.knit import (
43
40
    cleanup_pack_knit,
44
41
    make_file_factory,
45
42
    make_pack_factory,
 
43
    KnitAnnotateFactory,
 
44
    KnitPlainFactory,
46
45
    )
 
46
from bzrlib.symbol_versioning import one_four, one_five
47
47
from bzrlib.tests import (
48
48
    TestCase,
49
49
    TestCaseWithMemoryTransport,
50
 
    TestNotApplicable,
 
50
    TestScenarioApplier,
51
51
    TestSkipped,
 
52
    condition_isinstance,
 
53
    split_suite_by_condition,
 
54
    iter_suite_tests,
52
55
    )
53
56
from bzrlib.tests.http_utils import TestCaseWithWebserver
 
57
from bzrlib.trace import mutter
 
58
from bzrlib.transport import get_transport
54
59
from bzrlib.transport.memory import MemoryTransport
 
60
from bzrlib.tsort import topo_sort
 
61
from bzrlib.tuned_gzip import GzipFile
55
62
import bzrlib.versionedfile as versionedfile
56
63
from bzrlib.versionedfile import (
57
64
    ConstantMapper,
61
68
    make_versioned_files_factory,
62
69
    )
63
70
from bzrlib.weave import WeaveFile
64
 
from bzrlib.weavefile import write_weave
65
 
from bzrlib.tests.scenarios import load_tests_apply_scenarios
66
 
 
67
 
 
68
 
load_tests = load_tests_apply_scenarios
 
71
from bzrlib.weavefile import read_weave, write_weave
 
72
 
 
73
 
 
74
def load_tests(standard_tests, module, loader):
 
75
    """Parameterize VersionedFiles tests for different implementations."""
 
76
    to_adapt, result = split_suite_by_condition(
 
77
        standard_tests, condition_isinstance(TestVersionedFiles))
 
78
    len_one_adapter = TestScenarioApplier()
 
79
    len_two_adapter = TestScenarioApplier()
 
80
    # We want to be sure of behaviour for:
 
81
    # weaves prefix layout (weave texts)
 
82
    # individually named weaves (weave inventories)
 
83
    # annotated knits - prefix|hash|hash-escape layout, we test the third only
 
84
    #                   as it is the most complex mapper.
 
85
    # individually named knits
 
86
    # individual no-graph knits in packs (signatures)
 
87
    # individual graph knits in packs (inventories)
 
88
    # individual graph nocompression knits in packs (revisions)
 
89
    # plain text knits in packs (texts)
 
90
    len_one_adapter.scenarios = [
 
91
        ('weave-named', {
 
92
            'cleanup':None,
 
93
            'factory':make_versioned_files_factory(WeaveFile,
 
94
                ConstantMapper('inventory')),
 
95
            'graph':True,
 
96
            'key_length':1,
 
97
            }),
 
98
        ('named-knit', {
 
99
            'cleanup':None,
 
100
            'factory':make_file_factory(False, ConstantMapper('revisions')),
 
101
            'graph':True,
 
102
            'key_length':1,
 
103
            }),
 
104
        ('named-nograph-knit-pack', {
 
105
            'cleanup':cleanup_pack_knit,
 
106
            'factory':make_pack_factory(False, False, 1),
 
107
            'graph':False,
 
108
            'key_length':1,
 
109
            }),
 
110
        ('named-graph-knit-pack', {
 
111
            'cleanup':cleanup_pack_knit,
 
112
            'factory':make_pack_factory(True, True, 1),
 
113
            'graph':True,
 
114
            'key_length':1,
 
115
            }),
 
116
        ('named-graph-nodelta-knit-pack', {
 
117
            'cleanup':cleanup_pack_knit,
 
118
            'factory':make_pack_factory(True, False, 1),
 
119
            'graph':True,
 
120
            'key_length':1,
 
121
            }),
 
122
        ]
 
123
    len_two_adapter.scenarios = [
 
124
        ('weave-prefix', {
 
125
            'cleanup':None,
 
126
            'factory':make_versioned_files_factory(WeaveFile,
 
127
                PrefixMapper()),
 
128
            'graph':True,
 
129
            'key_length':2,
 
130
            }),
 
131
        ('annotated-knit-escape', {
 
132
            'cleanup':None,
 
133
            'factory':make_file_factory(True, HashEscapedPrefixMapper()),
 
134
            'graph':True,
 
135
            'key_length':2,
 
136
            }),
 
137
        ('plain-knit-pack', {
 
138
            'cleanup':cleanup_pack_knit,
 
139
            'factory':make_pack_factory(True, True, 2),
 
140
            'graph':True,
 
141
            'key_length':2,
 
142
            }),
 
143
        ]
 
144
    for test in iter_suite_tests(to_adapt):
 
145
        result.addTests(len_one_adapter.adapt(test))
 
146
        result.addTests(len_two_adapter.adapt(test))
 
147
    return result
69
148
 
70
149
 
71
150
def get_diamond_vf(f, trailing_eol=True, left_only=False):
72
151
    """Get a diamond graph to exercise deltas and merges.
73
 
 
 
152
    
74
153
    :param trailing_eol: If True end the last line with \n.
75
154
    """
76
155
    parents = {
97
176
 
98
177
 
99
178
def get_diamond_files(files, key_length, trailing_eol=True, left_only=False,
100
 
    nograph=False, nokeys=False):
 
179
    nograph=False):
101
180
    """Get a diamond graph to exercise deltas and merges.
102
181
 
103
182
    This creates a 5-node graph in files. If files supports 2-length keys two
104
183
    graphs are made to exercise the support for multiple ids.
105
 
 
 
184
    
106
185
    :param trailing_eol: If True end the last line with \n.
107
186
    :param key_length: The length of keys in files. Currently supports length 1
108
187
        and 2 keys.
110
189
    :param nograph: If True, do not provide parents to the add_lines calls;
111
190
        this is useful for tests that need inserted data but have graphless
112
191
        stores.
113
 
    :param nokeys: If True, pass None is as the key for all insertions.
114
 
        Currently implies nograph.
115
192
    :return: The results of the add_lines calls.
116
193
    """
117
 
    if nokeys:
118
 
        nograph = True
119
194
    if key_length == 1:
120
195
        prefixes = [()]
121
196
    else:
132
207
        else:
133
208
            result = [prefix + suffix for suffix in suffix_list]
134
209
            return result
135
 
    def get_key(suffix):
136
 
        if nokeys:
137
 
            return (None, )
138
 
        else:
139
 
            return (suffix,)
140
210
    # we loop over each key because that spreads the inserts across prefixes,
141
211
    # which is how commit operates.
142
212
    for prefix in prefixes:
143
 
        result.append(files.add_lines(prefix + get_key('origin'), (),
 
213
        result.append(files.add_lines(prefix + ('origin',), (),
144
214
            ['origin' + last_char]))
145
215
    for prefix in prefixes:
146
 
        result.append(files.add_lines(prefix + get_key('base'),
 
216
        result.append(files.add_lines(prefix + ('base',),
147
217
            get_parents([('origin',)]), ['base' + last_char]))
148
218
    for prefix in prefixes:
149
 
        result.append(files.add_lines(prefix + get_key('left'),
 
219
        result.append(files.add_lines(prefix + ('left',),
150
220
            get_parents([('base',)]),
151
221
            ['base\n', 'left' + last_char]))
152
222
    if not left_only:
153
223
        for prefix in prefixes:
154
 
            result.append(files.add_lines(prefix + get_key('right'),
 
224
            result.append(files.add_lines(prefix + ('right',),
155
225
                get_parents([('base',)]),
156
226
                ['base\n', 'right' + last_char]))
157
227
        for prefix in prefixes:
158
 
            result.append(files.add_lines(prefix + get_key('merged'),
 
228
            result.append(files.add_lines(prefix + ('merged',),
159
229
                get_parents([('left',), ('right',)]),
160
230
                ['base\n', 'left\n', 'right\n', 'merged' + last_char]))
161
231
    return result
187
257
            self.assertEquals(f.get_lines('r1'), ['b\n', 'c\n'])
188
258
            self.assertEqual(2, len(f))
189
259
            self.assertEqual(2, f.num_versions())
190
 
 
 
260
    
191
261
            self.assertRaises(RevisionNotPresent,
192
262
                f.add_lines, 'r2', ['foo'], [])
193
263
            self.assertRaises(RevisionAlreadyPresent,
232
302
        verify_file(f)
233
303
 
234
304
    def test_add_unicode_content(self):
235
 
        # unicode content is not permitted in versioned files.
 
305
        # unicode content is not permitted in versioned files. 
236
306
        # versioned files version sequences of bytes only.
237
307
        vf = self.get_file()
238
308
        self.assertRaises(errors.BzrBadParameterUnicode,
261
331
    def test_inline_newline_throws(self):
262
332
        # \r characters are not permitted in lines being added
263
333
        vf = self.get_file()
264
 
        self.assertRaises(errors.BzrBadParameterContainsNewline,
 
334
        self.assertRaises(errors.BzrBadParameterContainsNewline, 
265
335
            vf.add_lines, 'a', [], ['a\n\n'])
266
336
        self.assertRaises(
267
337
            (errors.BzrBadParameterContainsNewline, NotImplementedError),
466
536
        f.add_lines('noeolbase', [], ['line'])
467
537
        # noeol preceeding its leftmost parent in the output:
468
538
        # this is done by making it a merge of two parents with no common
469
 
        # anestry: noeolbase and noeol with the
 
539
        # anestry: noeolbase and noeol with the 
470
540
        # later-inserted parent the leftmost.
471
541
        f.add_lines('eolbeforefirstparent', ['noeolbase', 'noeol'], ['line'])
472
542
        # two identical eol texts
553
623
        self._transaction = 'after'
554
624
        self.assertRaises(errors.OutSideTransaction, f.add_lines, '', [], [])
555
625
        self.assertRaises(errors.OutSideTransaction, f.add_lines_with_ghosts, '', [], [])
556
 
 
 
626
        
557
627
    def test_copy_to(self):
558
628
        f = self.get_file()
559
629
        f.add_lines('0', [], ['a\n'])
632
702
 
633
703
    def test_iter_lines_added_or_present_in_versions(self):
634
704
        # test that we get at least an equalset of the lines added by
635
 
        # versions in the weave
 
705
        # versions in the weave 
636
706
        # the ordering here is to make a tree so that dumb searches have
637
707
        # more changes to muck up.
638
708
 
639
 
        class InstrumentedProgress(progress.ProgressTask):
 
709
        class InstrumentedProgress(progress.DummyProgress):
640
710
 
641
711
            def __init__(self):
642
 
                progress.ProgressTask.__init__(self)
 
712
 
 
713
                progress.DummyProgress.__init__(self)
643
714
                self.updates = []
644
715
 
645
716
            def update(self, msg=None, current=None, total=None):
671
742
                self.assertEqual(expected, progress.updates)
672
743
            return lines
673
744
        lines = iter_with_versions(['child', 'otherchild'],
674
 
                                   [('Walking content', 0, 2),
675
 
                                    ('Walking content', 1, 2),
676
 
                                    ('Walking content', 2, 2)])
 
745
                                   [('Walking content.', 0, 2),
 
746
                                    ('Walking content.', 1, 2),
 
747
                                    ('Walking content.', 2, 2)])
677
748
        # we must see child and otherchild
678
749
        self.assertTrue(lines[('child\n', 'child')] > 0)
679
750
        self.assertTrue(lines[('otherchild\n', 'otherchild')] > 0)
680
751
        # we dont care if we got more than that.
681
 
 
 
752
        
682
753
        # test all lines
683
 
        lines = iter_with_versions(None, [('Walking content', 0, 5),
684
 
                                          ('Walking content', 1, 5),
685
 
                                          ('Walking content', 2, 5),
686
 
                                          ('Walking content', 3, 5),
687
 
                                          ('Walking content', 4, 5),
688
 
                                          ('Walking content', 5, 5)])
 
754
        lines = iter_with_versions(None, [('Walking content.', 0, 5),
 
755
                                          ('Walking content.', 1, 5),
 
756
                                          ('Walking content.', 2, 5),
 
757
                                          ('Walking content.', 3, 5),
 
758
                                          ('Walking content.', 4, 5),
 
759
                                          ('Walking content.', 5, 5)])
689
760
        # all lines must be seen at least once
690
761
        self.assertTrue(lines[('base\n', 'base')] > 0)
691
762
        self.assertTrue(lines[('lancestor\n', 'lancestor')] > 0)
751
822
        self.assertEquals(('references_ghost', 'line_c\n'), origins[2])
752
823
 
753
824
    def test_readonly_mode(self):
754
 
        t = self.get_transport()
 
825
        transport = get_transport(self.get_url('.'))
755
826
        factory = self.get_factory()
756
 
        vf = factory('id', t, 0777, create=True, access_mode='w')
757
 
        vf = factory('id', t, access_mode='r')
 
827
        vf = factory('id', transport, 0777, create=True, access_mode='w')
 
828
        vf = factory('id', transport, access_mode='r')
758
829
        self.assertRaises(errors.ReadOnlyError, vf.add_lines, 'base', [], [])
759
830
        self.assertRaises(errors.ReadOnlyError,
760
831
                          vf.add_lines_with_ghosts,
761
832
                          'base',
762
833
                          [],
763
834
                          [])
764
 
 
 
835
    
765
836
    def test_get_sha1s(self):
766
837
        # check the sha1 data is available
767
838
        vf = self.get_file()
777
848
            'b': '3f786850e387550fdab836ed7e6dc881de23001b',
778
849
            },
779
850
            vf.get_sha1s(['a', 'c', 'b']))
780
 
 
 
851
        
781
852
 
782
853
class TestWeave(TestCaseWithMemoryTransport, VersionedFileTestMixIn):
783
854
 
784
855
    def get_file(self, name='foo'):
785
 
        return WeaveFile(name, self.get_transport(),
786
 
                         create=True,
787
 
                         get_scope=self.get_transaction)
 
856
        return WeaveFile(name, get_transport(self.get_url('.')), create=True,
 
857
            get_scope=self.get_transaction)
788
858
 
789
859
    def get_file_corrupted_text(self):
790
 
        w = WeaveFile('foo', self.get_transport(),
791
 
                      create=True,
792
 
                      get_scope=self.get_transaction)
 
860
        w = WeaveFile('foo', get_transport(self.get_url('.')), create=True,
 
861
            get_scope=self.get_transaction)
793
862
        w.add_lines('v1', [], ['hello\n'])
794
863
        w.add_lines('v2', ['v1'], ['hello\n', 'there\n'])
795
 
 
 
864
        
796
865
        # We are going to invasively corrupt the text
797
866
        # Make sure the internals of weave are the same
798
867
        self.assertEqual([('{', 0)
802
871
                        , 'there\n'
803
872
                        , ('}', None)
804
873
                        ], w._weave)
805
 
 
 
874
        
806
875
        self.assertEqual(['f572d396fae9206628714fb2ce00f72e94f2258f'
807
876
                        , '90f265c6e75f1c8f9ab76dcf85528352c5f215ef'
808
877
                        ], w._sha1s)
809
878
        w.check()
810
 
 
 
879
        
811
880
        # Corrupted
812
881
        w._weave[4] = 'There\n'
813
882
        return w
817
886
        # Corrected
818
887
        w._weave[4] = 'there\n'
819
888
        self.assertEqual('hello\nthere\n', w.get_text('v2'))
820
 
 
 
889
        
821
890
        #Invalid checksum, first digit changed
822
891
        w._sha1s[1] =  'f0f265c6e75f1c8f9ab76dcf85528352c5f215ef'
823
892
        return w
824
893
 
825
894
    def reopen_file(self, name='foo', create=False):
826
 
        return WeaveFile(name, self.get_transport(),
827
 
                         create=create,
828
 
                         get_scope=self.get_transaction)
 
895
        return WeaveFile(name, get_transport(self.get_url('.')), create=create,
 
896
            get_scope=self.get_transaction)
829
897
 
830
898
    def test_no_implicit_create(self):
831
899
        self.assertRaises(errors.NoSuchFile,
832
900
                          WeaveFile,
833
901
                          'foo',
834
 
                          self.get_transport(),
 
902
                          get_transport(self.get_url('.')),
835
903
                          get_scope=self.get_transaction)
836
904
 
837
905
    def get_factory(self):
904
972
        # we should be able to read from http with a versioned file.
905
973
        vf = self.get_file()
906
974
        # try an empty file access
907
 
        readonly_vf = self.get_factory()('foo', transport.get_transport(
908
 
                self.get_readonly_url('.')))
 
975
        readonly_vf = self.get_factory()('foo', get_transport(self.get_readonly_url('.')))
909
976
        self.assertEqual([], readonly_vf.versions())
910
 
 
911
 
    def test_readonly_http_works_with_feeling(self):
912
 
        # we should be able to read from http with a versioned file.
913
 
        vf = self.get_file()
914
977
        # now with feeling.
915
978
        vf.add_lines('1', [], ['a\n'])
916
979
        vf.add_lines('2', ['1'], ['b\n', 'a\n'])
917
 
        readonly_vf = self.get_factory()('foo', transport.get_transport(
918
 
                self.get_readonly_url('.')))
 
980
        readonly_vf = self.get_factory()('foo', get_transport(self.get_readonly_url('.')))
919
981
        self.assertEqual(['1', '2'], vf.versions())
920
 
        self.assertEqual(['1', '2'], readonly_vf.versions())
921
982
        for version in readonly_vf.versions():
922
983
            readonly_vf.get_lines(version)
923
984
 
925
986
class TestWeaveHTTP(TestCaseWithWebserver, TestReadonlyHttpMixin):
926
987
 
927
988
    def get_file(self):
928
 
        return WeaveFile('foo', self.get_transport(),
929
 
                         create=True,
930
 
                         get_scope=self.get_transaction)
 
989
        return WeaveFile('foo', get_transport(self.get_url('.')), create=True,
 
990
            get_scope=self.get_transaction)
931
991
 
932
992
    def get_factory(self):
933
993
        return WeaveFile
941
1001
 
942
1002
        def addcrlf(x):
943
1003
            return x + '\n'
944
 
 
 
1004
        
945
1005
        w = self.get_file()
946
1006
        w.add_lines('text0', [], map(addcrlf, base))
947
1007
        w.add_lines('text1', ['text0'], map(addcrlf, a))
963
1023
 
964
1024
        mp = map(addcrlf, mp)
965
1025
        self.assertEqual(mt.readlines(), mp)
966
 
 
967
 
 
 
1026
        
 
1027
        
968
1028
    def testOneInsert(self):
969
1029
        self.doMerge([],
970
1030
                     ['aa'],
988
1048
                     ['aaa', 'xxx', 'yyy', 'bbb'],
989
1049
                     ['aaa', 'xxx', 'bbb'], self.overlappedInsertExpected)
990
1050
 
991
 
        # really it ought to reduce this to
 
1051
        # really it ought to reduce this to 
992
1052
        # ['aaa', 'xxx', 'yyy', 'bbb']
993
1053
 
994
1054
 
996
1056
        self.doMerge(['aaa'],
997
1057
                     ['xxx'],
998
1058
                     ['yyy', 'zzz'],
999
 
                     ['<<<<<<< ', 'xxx', '=======', 'yyy', 'zzz',
 
1059
                     ['<<<<<<< ', 'xxx', '=======', 'yyy', 'zzz', 
1000
1060
                      '>>>>>>> '])
1001
1061
 
1002
1062
    def testNonClashInsert1(self):
1003
1063
        self.doMerge(['aaa'],
1004
1064
                     ['xxx', 'aaa'],
1005
1065
                     ['yyy', 'zzz'],
1006
 
                     ['<<<<<<< ', 'xxx', 'aaa', '=======', 'yyy', 'zzz',
 
1066
                     ['<<<<<<< ', 'xxx', 'aaa', '=======', 'yyy', 'zzz', 
1007
1067
                      '>>>>>>> '])
1008
1068
 
1009
1069
    def testNonClashInsert2(self):
1023
1083
        #######################################
1024
1084
        # skippd, not working yet
1025
1085
        return
1026
 
 
 
1086
        
1027
1087
        self.doMerge(['aaa', 'bbb', 'ccc'],
1028
1088
                     ['aaa', 'ddd', 'ccc'],
1029
1089
                     ['aaa', 'ccc'],
1066
1126
            """
1067
1127
        result = """\
1068
1128
            line 1
1069
 
<<<<<<<\x20
1070
 
            line 2
1071
 
=======
1072
 
>>>>>>>\x20
1073
1129
            """
1074
1130
        self._test_merge_from_strings(base, a, b, result)
1075
1131
 
1076
1132
    def test_deletion_overlap(self):
1077
1133
        """Delete overlapping regions with no other conflict.
1078
1134
 
1079
 
        Arguably it'd be better to treat these as agreement, rather than
 
1135
        Arguably it'd be better to treat these as agreement, rather than 
1080
1136
        conflict, but for now conflict is safer.
1081
1137
        """
1082
1138
        base = """\
1098
1154
            """
1099
1155
        result = """\
1100
1156
            start context
1101
 
<<<<<<<\x20
 
1157
<<<<<<< 
1102
1158
            int a() {}
1103
1159
=======
1104
1160
            int c() {}
1105
 
>>>>>>>\x20
 
1161
>>>>>>> 
1106
1162
            end context
1107
1163
            """
1108
1164
        self._test_merge_from_strings(base, a, b, result)
1134
1190
 
1135
1191
    def test_sync_on_deletion(self):
1136
1192
        """Specific case of merge where we can synchronize incorrectly.
1137
 
 
 
1193
        
1138
1194
        A previous version of the weave merge concluded that the two versions
1139
1195
        agreed on deleting line 2, and this could be a synchronization point.
1140
 
        Line 1 was then considered in isolation, and thought to be deleted on
 
1196
        Line 1 was then considered in isolation, and thought to be deleted on 
1141
1197
        both sides.
1142
1198
 
1143
1199
        It's better to consider the whole thing as a disagreement region.
1162
1218
            """
1163
1219
        result = """\
1164
1220
            start context
1165
 
<<<<<<<\x20
 
1221
<<<<<<< 
1166
1222
            base line 1
1167
1223
            a's replacement line 2
1168
1224
=======
1169
1225
            b replaces
1170
1226
            both lines
1171
 
>>>>>>>\x20
 
1227
>>>>>>> 
1172
1228
            end context
1173
1229
            """
1174
1230
        self._test_merge_from_strings(base, a, b, result)
1177
1233
class TestWeaveMerge(TestCaseWithMemoryTransport, MergeCasesMixin):
1178
1234
 
1179
1235
    def get_file(self, name='foo'):
1180
 
        return WeaveFile(name, self.get_transport(),
1181
 
                         create=True)
 
1236
        return WeaveFile(name, get_transport(self.get_url('.')), create=True)
1182
1237
 
1183
1238
    def log_contents(self, w):
1184
1239
        self.log('weave is:')
1186
1241
        write_weave(w, tmpf)
1187
1242
        self.log(tmpf.getvalue())
1188
1243
 
1189
 
    overlappedInsertExpected = ['aaa', '<<<<<<< ', 'xxx', 'yyy', '=======',
 
1244
    overlappedInsertExpected = ['aaa', '<<<<<<< ', 'xxx', 'yyy', '=======', 
1190
1245
                                'xxx', '>>>>>>> ', 'bbb']
1191
1246
 
1192
1247
 
1224
1279
        # origin is a fulltext
1225
1280
        entries = f.get_record_stream([('origin',)], 'unordered', False)
1226
1281
        base = entries.next()
1227
 
        ft_data = ft_adapter.get_bytes(base)
 
1282
        ft_data = ft_adapter.get_bytes(base, base.get_bytes_as(base.storage_kind))
1228
1283
        # merged is both a delta and multiple parents.
1229
1284
        entries = f.get_record_stream([('merged',)], 'unordered', False)
1230
1285
        merged = entries.next()
1231
 
        delta_data = delta_adapter.get_bytes(merged)
 
1286
        delta_data = delta_adapter.get_bytes(merged,
 
1287
            merged.get_bytes_as(merged.storage_kind))
1232
1288
        return ft_data, delta_data
1233
1289
 
1234
1290
    def test_deannotation_noeol(self):
1301
1357
 
1302
1358
    def test_unannotated_to_fulltext(self):
1303
1359
        """Test adapting unannotated knits to full texts.
1304
 
 
 
1360
        
1305
1361
        This is used for -> weaves, and for -> annotated knits.
1306
1362
        """
1307
1363
        # we need a full text, and a delta
1320
1376
 
1321
1377
    def test_unannotated_to_fulltext_no_eol(self):
1322
1378
        """Test adapting unannotated knits to full texts.
1323
 
 
 
1379
        
1324
1380
        This is used for -> weaves, and for -> annotated knits.
1325
1381
        """
1326
1382
        # we need a full text, and a delta
1377
1433
class TestVersionedFiles(TestCaseWithMemoryTransport):
1378
1434
    """Tests for the multiple-file variant of VersionedFile."""
1379
1435
 
1380
 
    # We want to be sure of behaviour for:
1381
 
    # weaves prefix layout (weave texts)
1382
 
    # individually named weaves (weave inventories)
1383
 
    # annotated knits - prefix|hash|hash-escape layout, we test the third only
1384
 
    #                   as it is the most complex mapper.
1385
 
    # individually named knits
1386
 
    # individual no-graph knits in packs (signatures)
1387
 
    # individual graph knits in packs (inventories)
1388
 
    # individual graph nocompression knits in packs (revisions)
1389
 
    # plain text knits in packs (texts)
1390
 
    len_one_scenarios = [
1391
 
        ('weave-named', {
1392
 
            'cleanup':None,
1393
 
            'factory':make_versioned_files_factory(WeaveFile,
1394
 
                ConstantMapper('inventory')),
1395
 
            'graph':True,
1396
 
            'key_length':1,
1397
 
            'support_partial_insertion': False,
1398
 
            }),
1399
 
        ('named-knit', {
1400
 
            'cleanup':None,
1401
 
            'factory':make_file_factory(False, ConstantMapper('revisions')),
1402
 
            'graph':True,
1403
 
            'key_length':1,
1404
 
            'support_partial_insertion': False,
1405
 
            }),
1406
 
        ('named-nograph-nodelta-knit-pack', {
1407
 
            'cleanup':cleanup_pack_knit,
1408
 
            'factory':make_pack_factory(False, False, 1),
1409
 
            'graph':False,
1410
 
            'key_length':1,
1411
 
            'support_partial_insertion': False,
1412
 
            }),
1413
 
        ('named-graph-knit-pack', {
1414
 
            'cleanup':cleanup_pack_knit,
1415
 
            'factory':make_pack_factory(True, True, 1),
1416
 
            'graph':True,
1417
 
            'key_length':1,
1418
 
            'support_partial_insertion': True,
1419
 
            }),
1420
 
        ('named-graph-nodelta-knit-pack', {
1421
 
            'cleanup':cleanup_pack_knit,
1422
 
            'factory':make_pack_factory(True, False, 1),
1423
 
            'graph':True,
1424
 
            'key_length':1,
1425
 
            'support_partial_insertion': False,
1426
 
            }),
1427
 
        ('groupcompress-nograph', {
1428
 
            'cleanup':groupcompress.cleanup_pack_group,
1429
 
            'factory':groupcompress.make_pack_factory(False, False, 1),
1430
 
            'graph': False,
1431
 
            'key_length':1,
1432
 
            'support_partial_insertion':False,
1433
 
            }),
1434
 
        ]
1435
 
    len_two_scenarios = [
1436
 
        ('weave-prefix', {
1437
 
            'cleanup':None,
1438
 
            'factory':make_versioned_files_factory(WeaveFile,
1439
 
                PrefixMapper()),
1440
 
            'graph':True,
1441
 
            'key_length':2,
1442
 
            'support_partial_insertion': False,
1443
 
            }),
1444
 
        ('annotated-knit-escape', {
1445
 
            'cleanup':None,
1446
 
            'factory':make_file_factory(True, HashEscapedPrefixMapper()),
1447
 
            'graph':True,
1448
 
            'key_length':2,
1449
 
            'support_partial_insertion': False,
1450
 
            }),
1451
 
        ('plain-knit-pack', {
1452
 
            'cleanup':cleanup_pack_knit,
1453
 
            'factory':make_pack_factory(True, True, 2),
1454
 
            'graph':True,
1455
 
            'key_length':2,
1456
 
            'support_partial_insertion': True,
1457
 
            }),
1458
 
        ('groupcompress', {
1459
 
            'cleanup':groupcompress.cleanup_pack_group,
1460
 
            'factory':groupcompress.make_pack_factory(True, False, 1),
1461
 
            'graph': True,
1462
 
            'key_length':1,
1463
 
            'support_partial_insertion':False,
1464
 
            }),
1465
 
        ]
1466
 
 
1467
 
    scenarios = len_one_scenarios + len_two_scenarios
1468
 
 
1469
1436
    def get_versionedfiles(self, relpath='files'):
1470
1437
        transport = self.get_transport(relpath)
1471
1438
        if relpath != '.':
1472
1439
            transport.mkdir('.')
1473
1440
        files = self.factory(transport)
1474
1441
        if self.cleanup is not None:
1475
 
            self.addCleanup(self.cleanup, files)
 
1442
            self.addCleanup(lambda:self.cleanup(files))
1476
1443
        return files
1477
1444
 
1478
 
    def get_simple_key(self, suffix):
1479
 
        """Return a key for the object under test."""
1480
 
        if self.key_length == 1:
1481
 
            return (suffix,)
1482
 
        else:
1483
 
            return ('FileA',) + (suffix,)
1484
 
 
1485
 
    def test_add_fallback_implies_without_fallbacks(self):
1486
 
        f = self.get_versionedfiles('files')
1487
 
        if getattr(f, 'add_fallback_versioned_files', None) is None:
1488
 
            raise TestNotApplicable("%s doesn't support fallbacks"
1489
 
                                    % (f.__class__.__name__,))
1490
 
        g = self.get_versionedfiles('fallback')
1491
 
        key_a = self.get_simple_key('a')
1492
 
        g.add_lines(key_a, [], ['\n'])
1493
 
        f.add_fallback_versioned_files(g)
1494
 
        self.assertTrue(key_a in f.get_parent_map([key_a]))
1495
 
        self.assertFalse(key_a in f.without_fallbacks().get_parent_map([key_a]))
1496
 
 
1497
 
    def test_add_lines(self):
1498
 
        f = self.get_versionedfiles()
1499
 
        key0 = self.get_simple_key('r0')
1500
 
        key1 = self.get_simple_key('r1')
1501
 
        key2 = self.get_simple_key('r2')
1502
 
        keyf = self.get_simple_key('foo')
1503
 
        f.add_lines(key0, [], ['a\n', 'b\n'])
1504
 
        if self.graph:
1505
 
            f.add_lines(key1, [key0], ['b\n', 'c\n'])
1506
 
        else:
1507
 
            f.add_lines(key1, [], ['b\n', 'c\n'])
1508
 
        keys = f.keys()
1509
 
        self.assertTrue(key0 in keys)
1510
 
        self.assertTrue(key1 in keys)
1511
 
        records = []
1512
 
        for record in f.get_record_stream([key0, key1], 'unordered', True):
1513
 
            records.append((record.key, record.get_bytes_as('fulltext')))
1514
 
        records.sort()
1515
 
        self.assertEqual([(key0, 'a\nb\n'), (key1, 'b\nc\n')], records)
1516
 
 
1517
 
    def test__add_text(self):
1518
 
        f = self.get_versionedfiles()
1519
 
        key0 = self.get_simple_key('r0')
1520
 
        key1 = self.get_simple_key('r1')
1521
 
        key2 = self.get_simple_key('r2')
1522
 
        keyf = self.get_simple_key('foo')
1523
 
        f._add_text(key0, [], 'a\nb\n')
1524
 
        if self.graph:
1525
 
            f._add_text(key1, [key0], 'b\nc\n')
1526
 
        else:
1527
 
            f._add_text(key1, [], 'b\nc\n')
1528
 
        keys = f.keys()
1529
 
        self.assertTrue(key0 in keys)
1530
 
        self.assertTrue(key1 in keys)
1531
 
        records = []
1532
 
        for record in f.get_record_stream([key0, key1], 'unordered', True):
1533
 
            records.append((record.key, record.get_bytes_as('fulltext')))
1534
 
        records.sort()
1535
 
        self.assertEqual([(key0, 'a\nb\n'), (key1, 'b\nc\n')], records)
1536
 
 
1537
1445
    def test_annotate(self):
1538
1446
        files = self.get_versionedfiles()
1539
1447
        self.get_diamond_files(files)
1573
1481
        self.assertRaises(RevisionNotPresent,
1574
1482
            files.annotate, prefix + ('missing-key',))
1575
1483
 
1576
 
    def test_check_no_parameters(self):
1577
 
        files = self.get_versionedfiles()
1578
 
 
1579
 
    def test_check_progressbar_parameter(self):
1580
 
        """A progress bar can be supplied because check can be a generator."""
1581
 
        pb = ui.ui_factory.nested_progress_bar()
1582
 
        self.addCleanup(pb.finished)
1583
 
        files = self.get_versionedfiles()
1584
 
        files.check(progress_bar=pb)
1585
 
 
1586
 
    def test_check_with_keys_becomes_generator(self):
1587
 
        files = self.get_versionedfiles()
1588
 
        self.get_diamond_files(files)
1589
 
        keys = files.keys()
1590
 
        entries = files.check(keys=keys)
1591
 
        seen = set()
1592
 
        # Texts output should be fulltexts.
1593
 
        self.capture_stream(files, entries, seen.add,
1594
 
            files.get_parent_map(keys), require_fulltext=True)
1595
 
        # All texts should be output.
1596
 
        self.assertEqual(set(keys), seen)
1597
 
 
1598
 
    def test_clear_cache(self):
1599
 
        files = self.get_versionedfiles()
1600
 
        files.clear_cache()
1601
 
 
1602
1484
    def test_construct(self):
1603
1485
        """Each parameterised test can be constructed on a transport."""
1604
1486
        files = self.get_versionedfiles()
1605
1487
 
1606
 
    def get_diamond_files(self, files, trailing_eol=True, left_only=False,
1607
 
        nokeys=False):
 
1488
    def get_diamond_files(self, files, trailing_eol=True, left_only=False):
1608
1489
        return get_diamond_files(files, self.key_length,
1609
1490
            trailing_eol=trailing_eol, nograph=not self.graph,
1610
 
            left_only=left_only, nokeys=nokeys)
1611
 
 
1612
 
    def _add_content_nostoresha(self, add_lines):
1613
 
        """When nostore_sha is supplied using old content raises."""
1614
 
        vf = self.get_versionedfiles()
1615
 
        empty_text = ('a', [])
1616
 
        sample_text_nl = ('b', ["foo\n", "bar\n"])
1617
 
        sample_text_no_nl = ('c', ["foo\n", "bar"])
1618
 
        shas = []
1619
 
        for version, lines in (empty_text, sample_text_nl, sample_text_no_nl):
1620
 
            if add_lines:
1621
 
                sha, _, _ = vf.add_lines(self.get_simple_key(version), [],
1622
 
                                         lines)
1623
 
            else:
1624
 
                sha, _, _ = vf._add_text(self.get_simple_key(version), [],
1625
 
                                         ''.join(lines))
1626
 
            shas.append(sha)
1627
 
        # we now have a copy of all the lines in the vf.
1628
 
        for sha, (version, lines) in zip(
1629
 
            shas, (empty_text, sample_text_nl, sample_text_no_nl)):
1630
 
            new_key = self.get_simple_key(version + "2")
1631
 
            self.assertRaises(errors.ExistingContent,
1632
 
                vf.add_lines, new_key, [], lines,
1633
 
                nostore_sha=sha)
1634
 
            self.assertRaises(errors.ExistingContent,
1635
 
                vf._add_text, new_key, [], ''.join(lines),
1636
 
                nostore_sha=sha)
1637
 
            # and no new version should have been added.
1638
 
            record = vf.get_record_stream([new_key], 'unordered', True).next()
1639
 
            self.assertEqual('absent', record.storage_kind)
1640
 
 
1641
 
    def test_add_lines_nostoresha(self):
1642
 
        self._add_content_nostoresha(add_lines=True)
1643
 
 
1644
 
    def test__add_text_nostoresha(self):
1645
 
        self._add_content_nostoresha(add_lines=False)
 
1491
            left_only=left_only)
1646
1492
 
1647
1493
    def test_add_lines_return(self):
1648
1494
        files = self.get_versionedfiles()
1675
1521
                ('ed8bce375198ea62444dc71952b22cfc2b09226d', 23)],
1676
1522
                results)
1677
1523
 
1678
 
    def test_add_lines_no_key_generates_chk_key(self):
1679
 
        files = self.get_versionedfiles()
1680
 
        # save code by using the stock data insertion helper.
1681
 
        adds = self.get_diamond_files(files, nokeys=True)
1682
 
        results = []
1683
 
        # We can only validate the first 2 elements returned from add_lines.
1684
 
        for add in adds:
1685
 
            self.assertEqual(3, len(add))
1686
 
            results.append(add[:2])
1687
 
        if self.key_length == 1:
1688
 
            self.assertEqual([
1689
 
                ('00e364d235126be43292ab09cb4686cf703ddc17', 7),
1690
 
                ('51c64a6f4fc375daf0d24aafbabe4d91b6f4bb44', 5),
1691
 
                ('a8478686da38e370e32e42e8a0c220e33ee9132f', 10),
1692
 
                ('9ef09dfa9d86780bdec9219a22560c6ece8e0ef1', 11),
1693
 
                ('ed8bce375198ea62444dc71952b22cfc2b09226d', 23)],
1694
 
                results)
1695
 
            # Check the added items got CHK keys.
1696
 
            self.assertEqual(set([
1697
 
                ('sha1:00e364d235126be43292ab09cb4686cf703ddc17',),
1698
 
                ('sha1:51c64a6f4fc375daf0d24aafbabe4d91b6f4bb44',),
1699
 
                ('sha1:9ef09dfa9d86780bdec9219a22560c6ece8e0ef1',),
1700
 
                ('sha1:a8478686da38e370e32e42e8a0c220e33ee9132f',),
1701
 
                ('sha1:ed8bce375198ea62444dc71952b22cfc2b09226d',),
1702
 
                ]),
1703
 
                files.keys())
1704
 
        elif self.key_length == 2:
1705
 
            self.assertEqual([
1706
 
                ('00e364d235126be43292ab09cb4686cf703ddc17', 7),
1707
 
                ('00e364d235126be43292ab09cb4686cf703ddc17', 7),
1708
 
                ('51c64a6f4fc375daf0d24aafbabe4d91b6f4bb44', 5),
1709
 
                ('51c64a6f4fc375daf0d24aafbabe4d91b6f4bb44', 5),
1710
 
                ('a8478686da38e370e32e42e8a0c220e33ee9132f', 10),
1711
 
                ('a8478686da38e370e32e42e8a0c220e33ee9132f', 10),
1712
 
                ('9ef09dfa9d86780bdec9219a22560c6ece8e0ef1', 11),
1713
 
                ('9ef09dfa9d86780bdec9219a22560c6ece8e0ef1', 11),
1714
 
                ('ed8bce375198ea62444dc71952b22cfc2b09226d', 23),
1715
 
                ('ed8bce375198ea62444dc71952b22cfc2b09226d', 23)],
1716
 
                results)
1717
 
            # Check the added items got CHK keys.
1718
 
            self.assertEqual(set([
1719
 
                ('FileA', 'sha1:00e364d235126be43292ab09cb4686cf703ddc17'),
1720
 
                ('FileA', 'sha1:51c64a6f4fc375daf0d24aafbabe4d91b6f4bb44'),
1721
 
                ('FileA', 'sha1:9ef09dfa9d86780bdec9219a22560c6ece8e0ef1'),
1722
 
                ('FileA', 'sha1:a8478686da38e370e32e42e8a0c220e33ee9132f'),
1723
 
                ('FileA', 'sha1:ed8bce375198ea62444dc71952b22cfc2b09226d'),
1724
 
                ('FileB', 'sha1:00e364d235126be43292ab09cb4686cf703ddc17'),
1725
 
                ('FileB', 'sha1:51c64a6f4fc375daf0d24aafbabe4d91b6f4bb44'),
1726
 
                ('FileB', 'sha1:9ef09dfa9d86780bdec9219a22560c6ece8e0ef1'),
1727
 
                ('FileB', 'sha1:a8478686da38e370e32e42e8a0c220e33ee9132f'),
1728
 
                ('FileB', 'sha1:ed8bce375198ea62444dc71952b22cfc2b09226d'),
1729
 
                ]),
1730
 
                files.keys())
1731
 
 
1732
1524
    def test_empty_lines(self):
1733
1525
        """Empty files can be stored."""
1734
1526
        f = self.get_versionedfiles()
1756
1548
            f.get_record_stream([key_b], 'unordered', True
1757
1549
                ).next().get_bytes_as('fulltext'))
1758
1550
 
1759
 
    def test_get_known_graph_ancestry(self):
1760
 
        f = self.get_versionedfiles()
1761
 
        if not self.graph:
1762
 
            raise TestNotApplicable('ancestry info only relevant with graph.')
1763
 
        key_a = self.get_simple_key('a')
1764
 
        key_b = self.get_simple_key('b')
1765
 
        key_c = self.get_simple_key('c')
1766
 
        # A
1767
 
        # |\
1768
 
        # | B
1769
 
        # |/
1770
 
        # C
1771
 
        f.add_lines(key_a, [], ['\n'])
1772
 
        f.add_lines(key_b, [key_a], ['\n'])
1773
 
        f.add_lines(key_c, [key_a, key_b], ['\n'])
1774
 
        kg = f.get_known_graph_ancestry([key_c])
1775
 
        self.assertIsInstance(kg, _mod_graph.KnownGraph)
1776
 
        self.assertEqual([key_a, key_b, key_c], list(kg.topo_sort()))
1777
 
 
1778
 
    def test_known_graph_with_fallbacks(self):
1779
 
        f = self.get_versionedfiles('files')
1780
 
        if not self.graph:
1781
 
            raise TestNotApplicable('ancestry info only relevant with graph.')
1782
 
        if getattr(f, 'add_fallback_versioned_files', None) is None:
1783
 
            raise TestNotApplicable("%s doesn't support fallbacks"
1784
 
                                    % (f.__class__.__name__,))
1785
 
        key_a = self.get_simple_key('a')
1786
 
        key_b = self.get_simple_key('b')
1787
 
        key_c = self.get_simple_key('c')
1788
 
        # A     only in fallback
1789
 
        # |\
1790
 
        # | B
1791
 
        # |/
1792
 
        # C
1793
 
        g = self.get_versionedfiles('fallback')
1794
 
        g.add_lines(key_a, [], ['\n'])
1795
 
        f.add_fallback_versioned_files(g)
1796
 
        f.add_lines(key_b, [key_a], ['\n'])
1797
 
        f.add_lines(key_c, [key_a, key_b], ['\n'])
1798
 
        kg = f.get_known_graph_ancestry([key_c])
1799
 
        self.assertEqual([key_a, key_b, key_c], list(kg.topo_sort()))
1800
 
 
1801
1551
    def test_get_record_stream_empty(self):
1802
1552
        """An empty stream can be requested without error."""
1803
1553
        f = self.get_versionedfiles()
1808
1558
        """Assert that storage_kind is a valid storage_kind."""
1809
1559
        self.assertSubset([storage_kind],
1810
1560
            ['mpdiff', 'knit-annotated-ft', 'knit-annotated-delta',
1811
 
             'knit-ft', 'knit-delta', 'chunked', 'fulltext',
1812
 
             'knit-annotated-ft-gz', 'knit-annotated-delta-gz', 'knit-ft-gz',
1813
 
             'knit-delta-gz',
1814
 
             'knit-delta-closure', 'knit-delta-closure-ref',
1815
 
             'groupcompress-block', 'groupcompress-block-ref'])
 
1561
             'knit-ft', 'knit-delta', 'fulltext', 'knit-annotated-ft-gz',
 
1562
             'knit-annotated-delta-gz', 'knit-ft-gz', 'knit-delta-gz'])
1816
1563
 
1817
 
    def capture_stream(self, f, entries, on_seen, parents,
1818
 
        require_fulltext=False):
 
1564
    def capture_stream(self, f, entries, on_seen, parents):
1819
1565
        """Capture a stream for testing."""
1820
1566
        for factory in entries:
1821
1567
            on_seen(factory.key)
1822
1568
            self.assertValidStorageKind(factory.storage_kind)
1823
 
            if factory.sha1 is not None:
1824
 
                self.assertEqual(f.get_sha1s([factory.key])[factory.key],
1825
 
                    factory.sha1)
 
1569
            self.assertEqual(f.get_sha1s([factory.key])[factory.key],
 
1570
                factory.sha1)
1826
1571
            self.assertEqual(parents[factory.key], factory.parents)
1827
1572
            self.assertIsInstance(factory.get_bytes_as(factory.storage_kind),
1828
1573
                str)
1829
 
            if require_fulltext:
1830
 
                factory.get_bytes_as('fulltext')
1831
1574
 
1832
1575
    def test_get_record_stream_interface(self):
1833
1576
        """each item in a stream has to provide a regular interface."""
1840
1583
        self.capture_stream(files, entries, seen.add, parent_map)
1841
1584
        self.assertEqual(set(keys), seen)
1842
1585
 
 
1586
    def get_simple_key(self, suffix):
 
1587
        """Return a key for the object under test."""
 
1588
        if self.key_length == 1:
 
1589
            return (suffix,)
 
1590
        else:
 
1591
            return ('FileA',) + (suffix,)
 
1592
 
1843
1593
    def get_keys_and_sort_order(self):
1844
1594
        """Get diamond test keys list, and their sort ordering."""
1845
1595
        if self.key_length == 1:
1860
1610
                }
1861
1611
        return keys, sort_order
1862
1612
 
1863
 
    def get_keys_and_groupcompress_sort_order(self):
1864
 
        """Get diamond test keys list, and their groupcompress sort ordering."""
1865
 
        if self.key_length == 1:
1866
 
            keys = [('merged',), ('left',), ('right',), ('base',)]
1867
 
            sort_order = {('merged',):0, ('left',):1, ('right',):1, ('base',):2}
1868
 
        else:
1869
 
            keys = [
1870
 
                ('FileA', 'merged'), ('FileA', 'left'), ('FileA', 'right'),
1871
 
                ('FileA', 'base'),
1872
 
                ('FileB', 'merged'), ('FileB', 'left'), ('FileB', 'right'),
1873
 
                ('FileB', 'base'),
1874
 
                ]
1875
 
            sort_order = {
1876
 
                ('FileA', 'merged'):0, ('FileA', 'left'):1, ('FileA', 'right'):1,
1877
 
                ('FileA', 'base'):2,
1878
 
                ('FileB', 'merged'):3, ('FileB', 'left'):4, ('FileB', 'right'):4,
1879
 
                ('FileB', 'base'):5,
1880
 
                }
1881
 
        return keys, sort_order
1882
 
 
1883
1613
    def test_get_record_stream_interface_ordered(self):
1884
1614
        """each item in a stream has to provide a regular interface."""
1885
1615
        files = self.get_versionedfiles()
1906
1636
                [None, files.get_sha1s([factory.key])[factory.key]])
1907
1637
            self.assertEqual(parent_map[factory.key], factory.parents)
1908
1638
            # self.assertEqual(files.get_text(factory.key),
1909
 
            ft_bytes = factory.get_bytes_as('fulltext')
1910
 
            self.assertIsInstance(ft_bytes, str)
1911
 
            chunked_bytes = factory.get_bytes_as('chunked')
1912
 
            self.assertEqualDiff(ft_bytes, ''.join(chunked_bytes))
1913
 
 
1914
 
        self.assertStreamOrder(sort_order, seen, keys)
1915
 
 
1916
 
    def test_get_record_stream_interface_groupcompress(self):
1917
 
        """each item in a stream has to provide a regular interface."""
1918
 
        files = self.get_versionedfiles()
1919
 
        self.get_diamond_files(files)
1920
 
        keys, sort_order = self.get_keys_and_groupcompress_sort_order()
1921
 
        parent_map = files.get_parent_map(keys)
1922
 
        entries = files.get_record_stream(keys, 'groupcompress', False)
1923
 
        seen = []
1924
 
        self.capture_stream(files, entries, seen.append, parent_map)
 
1639
            self.assertIsInstance(factory.get_bytes_as('fulltext'), str)
 
1640
            self.assertIsInstance(factory.get_bytes_as(factory.storage_kind),
 
1641
                str)
1925
1642
        self.assertStreamOrder(sort_order, seen, keys)
1926
1643
 
1927
1644
    def assertStreamOrder(self, sort_order, seen, keys):
1960
1677
        for factory in entries:
1961
1678
            seen.add(factory.key)
1962
1679
            self.assertValidStorageKind(factory.storage_kind)
1963
 
            if factory.sha1 is not None:
1964
 
                self.assertEqual(files.get_sha1s([factory.key])[factory.key],
1965
 
                                 factory.sha1)
 
1680
            self.assertEqual(files.get_sha1s([factory.key])[factory.key],
 
1681
                factory.sha1)
1966
1682
            self.assertEqual(parent_map[factory.key], factory.parents)
1967
1683
            # currently no stream emits mpdiff
1968
1684
            self.assertRaises(errors.UnavailableRepresentation,
1990
1706
        entries = files.get_record_stream(keys, 'topological', False)
1991
1707
        self.assertAbsentRecord(files, keys, parent_map, entries)
1992
1708
 
1993
 
    def assertRecordHasContent(self, record, bytes):
1994
 
        """Assert that record has the bytes bytes."""
1995
 
        self.assertEqual(bytes, record.get_bytes_as('fulltext'))
1996
 
        self.assertEqual(bytes, ''.join(record.get_bytes_as('chunked')))
1997
 
 
1998
 
    def test_get_record_stream_native_formats_are_wire_ready_one_ft(self):
1999
 
        files = self.get_versionedfiles()
2000
 
        key = self.get_simple_key('foo')
2001
 
        files.add_lines(key, (), ['my text\n', 'content'])
2002
 
        stream = files.get_record_stream([key], 'unordered', False)
2003
 
        record = stream.next()
2004
 
        if record.storage_kind in ('chunked', 'fulltext'):
2005
 
            # chunked and fulltext representations are for direct use not wire
2006
 
            # serialisation: check they are able to be used directly. To send
2007
 
            # such records over the wire translation will be needed.
2008
 
            self.assertRecordHasContent(record, "my text\ncontent")
2009
 
        else:
2010
 
            bytes = [record.get_bytes_as(record.storage_kind)]
2011
 
            network_stream = versionedfile.NetworkRecordStream(bytes).read()
2012
 
            source_record = record
2013
 
            records = []
2014
 
            for record in network_stream:
2015
 
                records.append(record)
2016
 
                self.assertEqual(source_record.storage_kind,
2017
 
                    record.storage_kind)
2018
 
                self.assertEqual(source_record.parents, record.parents)
2019
 
                self.assertEqual(
2020
 
                    source_record.get_bytes_as(source_record.storage_kind),
2021
 
                    record.get_bytes_as(record.storage_kind))
2022
 
            self.assertEqual(1, len(records))
2023
 
 
2024
 
    def assertStreamMetaEqual(self, records, expected, stream):
2025
 
        """Assert that streams expected and stream have the same records.
2026
 
 
2027
 
        :param records: A list to collect the seen records.
2028
 
        :return: A generator of the records in stream.
2029
 
        """
2030
 
        # We make assertions during copying to catch things early for
2031
 
        # easier debugging.
2032
 
        for record, ref_record in izip(stream, expected):
2033
 
            records.append(record)
2034
 
            self.assertEqual(ref_record.key, record.key)
2035
 
            self.assertEqual(ref_record.storage_kind, record.storage_kind)
2036
 
            self.assertEqual(ref_record.parents, record.parents)
2037
 
            yield record
2038
 
 
2039
 
    def stream_to_bytes_or_skip_counter(self, skipped_records, full_texts,
2040
 
        stream):
2041
 
        """Convert a stream to a bytes iterator.
2042
 
 
2043
 
        :param skipped_records: A list with one element to increment when a
2044
 
            record is skipped.
2045
 
        :param full_texts: A dict from key->fulltext representation, for
2046
 
            checking chunked or fulltext stored records.
2047
 
        :param stream: A record_stream.
2048
 
        :return: An iterator over the bytes of each record.
2049
 
        """
2050
 
        for record in stream:
2051
 
            if record.storage_kind in ('chunked', 'fulltext'):
2052
 
                skipped_records[0] += 1
2053
 
                # check the content is correct for direct use.
2054
 
                self.assertRecordHasContent(record, full_texts[record.key])
2055
 
            else:
2056
 
                yield record.get_bytes_as(record.storage_kind)
2057
 
 
2058
 
    def test_get_record_stream_native_formats_are_wire_ready_ft_delta(self):
2059
 
        files = self.get_versionedfiles()
2060
 
        target_files = self.get_versionedfiles('target')
2061
 
        key = self.get_simple_key('ft')
2062
 
        key_delta = self.get_simple_key('delta')
2063
 
        files.add_lines(key, (), ['my text\n', 'content'])
2064
 
        if self.graph:
2065
 
            delta_parents = (key,)
2066
 
        else:
2067
 
            delta_parents = ()
2068
 
        files.add_lines(key_delta, delta_parents, ['different\n', 'content\n'])
2069
 
        local = files.get_record_stream([key, key_delta], 'unordered', False)
2070
 
        ref = files.get_record_stream([key, key_delta], 'unordered', False)
2071
 
        skipped_records = [0]
2072
 
        full_texts = {
2073
 
            key: "my text\ncontent",
2074
 
            key_delta: "different\ncontent\n",
2075
 
            }
2076
 
        byte_stream = self.stream_to_bytes_or_skip_counter(
2077
 
            skipped_records, full_texts, local)
2078
 
        network_stream = versionedfile.NetworkRecordStream(byte_stream).read()
2079
 
        records = []
2080
 
        # insert the stream from the network into a versioned files object so we can
2081
 
        # check the content was carried across correctly without doing delta
2082
 
        # inspection.
2083
 
        target_files.insert_record_stream(
2084
 
            self.assertStreamMetaEqual(records, ref, network_stream))
2085
 
        # No duplicates on the wire thank you!
2086
 
        self.assertEqual(2, len(records) + skipped_records[0])
2087
 
        if len(records):
2088
 
            # if any content was copied it all must have all been.
2089
 
            self.assertIdenticalVersionedFile(files, target_files)
2090
 
 
2091
 
    def test_get_record_stream_native_formats_are_wire_ready_delta(self):
2092
 
        # copy a delta over the wire
2093
 
        files = self.get_versionedfiles()
2094
 
        target_files = self.get_versionedfiles('target')
2095
 
        key = self.get_simple_key('ft')
2096
 
        key_delta = self.get_simple_key('delta')
2097
 
        files.add_lines(key, (), ['my text\n', 'content'])
2098
 
        if self.graph:
2099
 
            delta_parents = (key,)
2100
 
        else:
2101
 
            delta_parents = ()
2102
 
        files.add_lines(key_delta, delta_parents, ['different\n', 'content\n'])
2103
 
        # Copy the basis text across so we can reconstruct the delta during
2104
 
        # insertion into target.
2105
 
        target_files.insert_record_stream(files.get_record_stream([key],
2106
 
            'unordered', False))
2107
 
        local = files.get_record_stream([key_delta], 'unordered', False)
2108
 
        ref = files.get_record_stream([key_delta], 'unordered', False)
2109
 
        skipped_records = [0]
2110
 
        full_texts = {
2111
 
            key_delta: "different\ncontent\n",
2112
 
            }
2113
 
        byte_stream = self.stream_to_bytes_or_skip_counter(
2114
 
            skipped_records, full_texts, local)
2115
 
        network_stream = versionedfile.NetworkRecordStream(byte_stream).read()
2116
 
        records = []
2117
 
        # insert the stream from the network into a versioned files object so we can
2118
 
        # check the content was carried across correctly without doing delta
2119
 
        # inspection during check_stream.
2120
 
        target_files.insert_record_stream(
2121
 
            self.assertStreamMetaEqual(records, ref, network_stream))
2122
 
        # No duplicates on the wire thank you!
2123
 
        self.assertEqual(1, len(records) + skipped_records[0])
2124
 
        if len(records):
2125
 
            # if any content was copied it all must have all been
2126
 
            self.assertIdenticalVersionedFile(files, target_files)
2127
 
 
2128
 
    def test_get_record_stream_wire_ready_delta_closure_included(self):
2129
 
        # copy a delta over the wire with the ability to get its full text.
2130
 
        files = self.get_versionedfiles()
2131
 
        key = self.get_simple_key('ft')
2132
 
        key_delta = self.get_simple_key('delta')
2133
 
        files.add_lines(key, (), ['my text\n', 'content'])
2134
 
        if self.graph:
2135
 
            delta_parents = (key,)
2136
 
        else:
2137
 
            delta_parents = ()
2138
 
        files.add_lines(key_delta, delta_parents, ['different\n', 'content\n'])
2139
 
        local = files.get_record_stream([key_delta], 'unordered', True)
2140
 
        ref = files.get_record_stream([key_delta], 'unordered', True)
2141
 
        skipped_records = [0]
2142
 
        full_texts = {
2143
 
            key_delta: "different\ncontent\n",
2144
 
            }
2145
 
        byte_stream = self.stream_to_bytes_or_skip_counter(
2146
 
            skipped_records, full_texts, local)
2147
 
        network_stream = versionedfile.NetworkRecordStream(byte_stream).read()
2148
 
        records = []
2149
 
        # insert the stream from the network into a versioned files object so we can
2150
 
        # check the content was carried across correctly without doing delta
2151
 
        # inspection during check_stream.
2152
 
        for record in self.assertStreamMetaEqual(records, ref, network_stream):
2153
 
            # we have to be able to get the full text out:
2154
 
            self.assertRecordHasContent(record, full_texts[record.key])
2155
 
        # No duplicates on the wire thank you!
2156
 
        self.assertEqual(1, len(records) + skipped_records[0])
2157
 
 
2158
1709
    def assertAbsentRecord(self, files, keys, parents, entries):
2159
1710
        """Helper for test_get_record_stream_missing_records_are_absent."""
2160
1711
        seen = set()
2166
1717
                self.assertEqual(None, factory.parents)
2167
1718
            else:
2168
1719
                self.assertValidStorageKind(factory.storage_kind)
2169
 
                if factory.sha1 is not None:
2170
 
                    sha1 = files.get_sha1s([factory.key])[factory.key]
2171
 
                    self.assertEqual(sha1, factory.sha1)
 
1720
                self.assertEqual(files.get_sha1s([factory.key])[factory.key],
 
1721
                    factory.sha1)
2172
1722
                self.assertEqual(parents[factory.key], factory.parents)
2173
1723
                self.assertIsInstance(factory.get_bytes_as(factory.storage_kind),
2174
1724
                    str)
2208
1758
        else:
2209
1759
            return None
2210
1760
 
2211
 
    def test_get_annotator(self):
2212
 
        files = self.get_versionedfiles()
2213
 
        self.get_diamond_files(files)
2214
 
        origin_key = self.get_simple_key('origin')
2215
 
        base_key = self.get_simple_key('base')
2216
 
        left_key = self.get_simple_key('left')
2217
 
        right_key = self.get_simple_key('right')
2218
 
        merged_key = self.get_simple_key('merged')
2219
 
        # annotator = files.get_annotator()
2220
 
        # introduced full text
2221
 
        origins, lines = files.get_annotator().annotate(origin_key)
2222
 
        self.assertEqual([(origin_key,)], origins)
2223
 
        self.assertEqual(['origin\n'], lines)
2224
 
        # a delta
2225
 
        origins, lines = files.get_annotator().annotate(base_key)
2226
 
        self.assertEqual([(base_key,)], origins)
2227
 
        # a merge
2228
 
        origins, lines = files.get_annotator().annotate(merged_key)
2229
 
        if self.graph:
2230
 
            self.assertEqual([
2231
 
                (base_key,),
2232
 
                (left_key,),
2233
 
                (right_key,),
2234
 
                (merged_key,),
2235
 
                ], origins)
2236
 
        else:
2237
 
            # Without a graph everything is new.
2238
 
            self.assertEqual([
2239
 
                (merged_key,),
2240
 
                (merged_key,),
2241
 
                (merged_key,),
2242
 
                (merged_key,),
2243
 
                ], origins)
2244
 
        self.assertRaises(RevisionNotPresent,
2245
 
            files.get_annotator().annotate, self.get_simple_key('missing-key'))
2246
 
 
2247
1761
    def test_get_parent_map(self):
2248
1762
        files = self.get_versionedfiles()
2249
1763
        if self.key_length == 1:
2300
1814
            keys[4]: '9ef09dfa9d86780bdec9219a22560c6ece8e0ef1',
2301
1815
            },
2302
1816
            files.get_sha1s(keys))
2303
 
 
 
1817
        
2304
1818
    def test_insert_record_stream_empty(self):
2305
1819
        """Inserting an empty record stream should work."""
2306
1820
        files = self.get_versionedfiles()
2452
1966
        else:
2453
1967
            self.assertIdenticalVersionedFile(source, files)
2454
1968
 
2455
 
    def test_insert_record_stream_long_parent_chain_out_of_order(self):
2456
 
        """An out of order stream can either error or work."""
2457
 
        if not self.graph:
2458
 
            raise TestNotApplicable('ancestry info only relevant with graph.')
2459
 
        # Create a reasonably long chain of records based on each other, where
2460
 
        # most will be deltas.
2461
 
        source = self.get_versionedfiles('source')
2462
 
        parents = ()
2463
 
        keys = []
2464
 
        content = [('same same %d\n' % n) for n in range(500)]
2465
 
        for letter in 'abcdefghijklmnopqrstuvwxyz':
2466
 
            key = ('key-' + letter,)
2467
 
            if self.key_length == 2:
2468
 
                key = ('prefix',) + key
2469
 
            content.append('content for ' + letter + '\n')
2470
 
            source.add_lines(key, parents, content)
2471
 
            keys.append(key)
2472
 
            parents = (key,)
2473
 
        # Create a stream of these records, excluding the first record that the
2474
 
        # rest ultimately depend upon, and insert it into a new vf.
2475
 
        streams = []
2476
 
        for key in reversed(keys):
2477
 
            streams.append(source.get_record_stream([key], 'unordered', False))
2478
 
        deltas = chain(*streams[:-1])
2479
 
        files = self.get_versionedfiles()
2480
 
        try:
2481
 
            files.insert_record_stream(deltas)
2482
 
        except RevisionNotPresent:
2483
 
            # Must not have corrupted the file.
2484
 
            files.check()
2485
 
        else:
2486
 
            # Must only report either just the first key as a missing parent,
2487
 
            # no key as missing (for nodelta scenarios).
2488
 
            missing = set(files.get_missing_compression_parent_keys())
2489
 
            missing.discard(keys[0])
2490
 
            self.assertEqual(set(), missing)
2491
 
 
2492
 
    def get_knit_delta_source(self):
2493
 
        """Get a source that can produce a stream with knit delta records,
2494
 
        regardless of this test's scenario.
2495
 
        """
2496
 
        mapper = self.get_mapper()
2497
 
        source_transport = self.get_transport('source')
2498
 
        source_transport.mkdir('.')
2499
 
        source = make_file_factory(False, mapper)(source_transport)
2500
 
        get_diamond_files(source, self.key_length, trailing_eol=True,
2501
 
            nograph=False, left_only=False)
2502
 
        return source
2503
 
 
2504
1969
    def test_insert_record_stream_delta_missing_basis_no_corruption(self):
2505
 
        """Insertion where a needed basis is not included notifies the caller
2506
 
        of the missing basis.  In the meantime a record missing its basis is
2507
 
        not added.
2508
 
        """
2509
 
        source = self.get_knit_delta_source()
2510
 
        keys = [self.get_simple_key('origin'), self.get_simple_key('merged')]
2511
 
        entries = source.get_record_stream(keys, 'unordered', False)
2512
 
        files = self.get_versionedfiles()
2513
 
        if self.support_partial_insertion:
2514
 
            self.assertEqual([],
2515
 
                list(files.get_missing_compression_parent_keys()))
2516
 
            files.insert_record_stream(entries)
2517
 
            missing_bases = files.get_missing_compression_parent_keys()
2518
 
            self.assertEqual(set([self.get_simple_key('left')]),
2519
 
                set(missing_bases))
2520
 
            self.assertEqual(set(keys), set(files.get_parent_map(keys)))
2521
 
        else:
2522
 
            self.assertRaises(
2523
 
                errors.RevisionNotPresent, files.insert_record_stream, entries)
2524
 
            files.check()
2525
 
 
2526
 
    def test_insert_record_stream_delta_missing_basis_can_be_added_later(self):
2527
 
        """Insertion where a needed basis is not included notifies the caller
2528
 
        of the missing basis.  That basis can be added in a second
2529
 
        insert_record_stream call that does not need to repeat records present
2530
 
        in the previous stream.  The record(s) that required that basis are
2531
 
        fully inserted once their basis is no longer missing.
2532
 
        """
2533
 
        if not self.support_partial_insertion:
2534
 
            raise TestNotApplicable(
2535
 
                'versioned file scenario does not support partial insertion')
2536
 
        source = self.get_knit_delta_source()
2537
 
        entries = source.get_record_stream([self.get_simple_key('origin'),
2538
 
            self.get_simple_key('merged')], 'unordered', False)
2539
 
        files = self.get_versionedfiles()
2540
 
        files.insert_record_stream(entries)
2541
 
        missing_bases = files.get_missing_compression_parent_keys()
2542
 
        self.assertEqual(set([self.get_simple_key('left')]),
2543
 
            set(missing_bases))
2544
 
        # 'merged' is inserted (although a commit of a write group involving
2545
 
        # this versionedfiles would fail).
2546
 
        merged_key = self.get_simple_key('merged')
2547
 
        self.assertEqual(
2548
 
            [merged_key], files.get_parent_map([merged_key]).keys())
2549
 
        # Add the full delta closure of the missing records
2550
 
        missing_entries = source.get_record_stream(
2551
 
            missing_bases, 'unordered', True)
2552
 
        files.insert_record_stream(missing_entries)
2553
 
        # Now 'merged' is fully inserted (and a commit would succeed).
2554
 
        self.assertEqual([], list(files.get_missing_compression_parent_keys()))
2555
 
        self.assertEqual(
2556
 
            [merged_key], files.get_parent_map([merged_key]).keys())
 
1970
        """Insertion where a needed basis is not included aborts safely."""
 
1971
        # We use a knit always here to be sure we are getting a binary delta.
 
1972
        mapper = self.get_mapper()
 
1973
        source_transport = self.get_transport('source')
 
1974
        source_transport.mkdir('.')
 
1975
        source = make_file_factory(False, mapper)(source_transport)
 
1976
        self.get_diamond_files(source)
 
1977
        entries = source.get_record_stream(['origin', 'merged'], 'unordered', False)
 
1978
        files = self.get_versionedfiles()
 
1979
        self.assertRaises(RevisionNotPresent, files.insert_record_stream,
 
1980
            entries)
2557
1981
        files.check()
 
1982
        self.assertEqual({}, files.get_parent_map([]))
2558
1983
 
2559
1984
    def test_iter_lines_added_or_present_in_keys(self):
2560
1985
        # test that we get at least an equalset of the lines added by
2562
1987
        # the ordering here is to make a tree so that dumb searches have
2563
1988
        # more changes to muck up.
2564
1989
 
2565
 
        class InstrumentedProgress(progress.ProgressTask):
 
1990
        class InstrumentedProgress(progress.DummyProgress):
2566
1991
 
2567
1992
            def __init__(self):
2568
 
                progress.ProgressTask.__init__(self)
 
1993
 
 
1994
                progress.DummyProgress.__init__(self)
2569
1995
                self.updates = []
2570
1996
 
2571
1997
            def update(self, msg=None, current=None, total=None):
2602
2028
            return lines
2603
2029
        lines = iter_with_keys(
2604
2030
            [self.get_simple_key('child'), self.get_simple_key('otherchild')],
2605
 
            [('Walking content', 0, 2),
2606
 
             ('Walking content', 1, 2),
2607
 
             ('Walking content', 2, 2)])
 
2031
            [('Walking content.', 0, 2),
 
2032
             ('Walking content.', 1, 2),
 
2033
             ('Walking content.', 2, 2)])
2608
2034
        # we must see child and otherchild
2609
2035
        self.assertTrue(lines[('child\n', self.get_simple_key('child'))] > 0)
2610
2036
        self.assertTrue(
2611
2037
            lines[('otherchild\n', self.get_simple_key('otherchild'))] > 0)
2612
2038
        # we dont care if we got more than that.
2613
 
 
 
2039
        
2614
2040
        # test all lines
2615
2041
        lines = iter_with_keys(files.keys(),
2616
 
            [('Walking content', 0, 5),
2617
 
             ('Walking content', 1, 5),
2618
 
             ('Walking content', 2, 5),
2619
 
             ('Walking content', 3, 5),
2620
 
             ('Walking content', 4, 5),
2621
 
             ('Walking content', 5, 5)])
 
2042
            [('Walking content.', 0, 5),
 
2043
             ('Walking content.', 1, 5),
 
2044
             ('Walking content.', 2, 5),
 
2045
             ('Walking content.', 3, 5),
 
2046
             ('Walking content.', 4, 5),
 
2047
             ('Walking content.', 5, 5)])
2622
2048
        # all lines must be seen at least once
2623
2049
        self.assertTrue(lines[('base\n', self.get_simple_key('base'))] > 0)
2624
2050
        self.assertTrue(
2657
2083
        files.add_lines(self.get_simple_key('noeolbase'), [], ['line'])
2658
2084
        # noeol preceeding its leftmost parent in the output:
2659
2085
        # this is done by making it a merge of two parents with no common
2660
 
        # anestry: noeolbase and noeol with the
 
2086
        # anestry: noeolbase and noeol with the 
2661
2087
        # later-inserted parent the leftmost.
2662
2088
        files.add_lines(self.get_simple_key('eolbeforefirstparent'),
2663
2089
            self.get_parents([self.get_simple_key('noeolbase'),
2749
2175
        TestCase.setUp(self)
2750
2176
        self._lines = {}
2751
2177
        self._parent_map = {}
2752
 
        self.texts = VirtualVersionedFiles(self._get_parent_map,
 
2178
        self.texts = VirtualVersionedFiles(self._get_parent_map, 
2753
2179
                                           self._lines.get)
2754
2180
 
2755
2181
    def test_add_lines(self):
2756
 
        self.assertRaises(NotImplementedError,
 
2182
        self.assertRaises(NotImplementedError, 
2757
2183
                self.texts.add_lines, "foo", [], [])
2758
2184
 
2759
2185
    def test_add_mpdiffs(self):
2760
 
        self.assertRaises(NotImplementedError,
 
2186
        self.assertRaises(NotImplementedError, 
2761
2187
                self.texts.add_mpdiffs, [])
2762
2188
 
2763
 
    def test_check_noerrors(self):
2764
 
        self.texts.check()
 
2189
    def test_check(self):
 
2190
        self.assertTrue(self.texts.check())
2765
2191
 
2766
2192
    def test_insert_record_stream(self):
2767
2193
        self.assertRaises(NotImplementedError, self.texts.insert_record_stream,
2777
2203
 
2778
2204
    def test_get_parent_map(self):
2779
2205
        self._parent_map = {"G": ("A", "B")}
2780
 
        self.assertEquals({("G",): (("A",),("B",))},
 
2206
        self.assertEquals({("G",): (("A",),("B",))}, 
2781
2207
                          self.texts.get_parent_map([("G",), ("L",)]))
2782
2208
 
2783
2209
    def test_get_record_stream(self):
2784
2210
        self._lines["A"] = ["FOO", "BAR"]
2785
2211
        it = self.texts.get_record_stream([("A",)], "unordered", True)
2786
2212
        record = it.next()
2787
 
        self.assertEquals("chunked", record.storage_kind)
 
2213
        self.assertEquals("fulltext", record.storage_kind)
2788
2214
        self.assertEquals("FOOBAR", record.get_bytes_as("fulltext"))
2789
 
        self.assertEquals(["FOO", "BAR"], record.get_bytes_as("chunked"))
2790
2215
 
2791
2216
    def test_get_record_stream_absent(self):
2792
2217
        it = self.texts.get_record_stream([("A",)], "unordered", True)
2793
2218
        record = it.next()
2794
2219
        self.assertEquals("absent", record.storage_kind)
2795
2220
 
2796
 
    def test_iter_lines_added_or_present_in_keys(self):
2797
 
        self._lines["A"] = ["FOO", "BAR"]
2798
 
        self._lines["B"] = ["HEY"]
2799
 
        self._lines["C"] = ["Alberta"]
2800
 
        it = self.texts.iter_lines_added_or_present_in_keys([("A",), ("B",)])
2801
 
        self.assertEquals(sorted([("FOO", "A"), ("BAR", "A"), ("HEY", "B")]),
2802
 
            sorted(list(it)))
2803
 
 
2804
 
 
2805
 
class TestOrderingVersionedFilesDecorator(TestCaseWithMemoryTransport):
2806
 
 
2807
 
    def get_ordering_vf(self, key_priority):
2808
 
        builder = self.make_branch_builder('test')
2809
 
        builder.start_series()
2810
 
        builder.build_snapshot('A', None, [
2811
 
            ('add', ('', 'TREE_ROOT', 'directory', None))])
2812
 
        builder.build_snapshot('B', ['A'], [])
2813
 
        builder.build_snapshot('C', ['B'], [])
2814
 
        builder.build_snapshot('D', ['C'], [])
2815
 
        builder.finish_series()
2816
 
        b = builder.get_branch()
2817
 
        b.lock_read()
2818
 
        self.addCleanup(b.unlock)
2819
 
        vf = b.repository.inventories
2820
 
        return versionedfile.OrderingVersionedFilesDecorator(vf, key_priority)
2821
 
 
2822
 
    def test_get_empty(self):
2823
 
        vf = self.get_ordering_vf({})
2824
 
        self.assertEqual([], vf.calls)
2825
 
 
2826
 
    def test_get_record_stream_topological(self):
2827
 
        vf = self.get_ordering_vf({('A',): 3, ('B',): 2, ('C',): 4, ('D',): 1})
2828
 
        request_keys = [('B',), ('C',), ('D',), ('A',)]
2829
 
        keys = [r.key for r in vf.get_record_stream(request_keys,
2830
 
                                    'topological', False)]
2831
 
        # We should have gotten the keys in topological order
2832
 
        self.assertEqual([('A',), ('B',), ('C',), ('D',)], keys)
2833
 
        # And recorded that the request was made
2834
 
        self.assertEqual([('get_record_stream', request_keys, 'topological',
2835
 
                           False)], vf.calls)
2836
 
 
2837
 
    def test_get_record_stream_ordered(self):
2838
 
        vf = self.get_ordering_vf({('A',): 3, ('B',): 2, ('C',): 4, ('D',): 1})
2839
 
        request_keys = [('B',), ('C',), ('D',), ('A',)]
2840
 
        keys = [r.key for r in vf.get_record_stream(request_keys,
2841
 
                                   'unordered', False)]
2842
 
        # They should be returned based on their priority
2843
 
        self.assertEqual([('D',), ('B',), ('A',), ('C',)], keys)
2844
 
        # And the request recorded
2845
 
        self.assertEqual([('get_record_stream', request_keys, 'unordered',
2846
 
                           False)], vf.calls)
2847
 
 
2848
 
    def test_get_record_stream_implicit_order(self):
2849
 
        vf = self.get_ordering_vf({('B',): 2, ('D',): 1})
2850
 
        request_keys = [('B',), ('C',), ('D',), ('A',)]
2851
 
        keys = [r.key for r in vf.get_record_stream(request_keys,
2852
 
                                   'unordered', False)]
2853
 
        # A and C are not in the map, so they get sorted to the front. A comes
2854
 
        # before C alphabetically, so it comes back first
2855
 
        self.assertEqual([('A',), ('C',), ('D',), ('B',)], keys)
2856
 
        # And the request recorded
2857
 
        self.assertEqual([('get_record_stream', request_keys, 'unordered',
2858
 
                           False)], vf.calls)