~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_versionedfile.py

  • Committer: Robert Collins
  • Date: 2007-07-19 06:34:09 UTC
  • mto: (2592.3.46 repository)
  • mto: This revision was merged to the branch mainline in revision 2651.
  • Revision ID: robertc@robertcollins.net-20070719063409-stu9sckrxp8wp3mo
LIBRARY API BREAKS:

  * KnitIndex.get_parents now returns tuples. (Robert Collins)

INTERNALS:

  * Unused functions on the private interface KnitIndex have been removed.
    (Robert Collins)

  * New ``knit.KnitGraphIndex`` which provides a ``KnitIndex`` layered on top
    of a ``index.GraphIndex``. (Robert Collins)

  * New ``knit.KnitVersionedFile.iter_parents`` method that allows querying
    the parents of many knit nodes at once, reducing round trips to the 
    underlying index. (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2009 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 itertools import chain, izip
25
24
from StringIO import StringIO
26
25
 
 
26
import bzrlib
27
27
from bzrlib import (
28
28
    errors,
29
 
    groupcompress,
30
 
    knit as _mod_knit,
31
29
    osutils,
32
30
    progress,
33
31
    )
34
32
from bzrlib.errors import (
35
 
                           RevisionNotPresent,
 
33
                           RevisionNotPresent, 
36
34
                           RevisionAlreadyPresent,
37
35
                           WeaveParentMismatch
38
36
                           )
39
 
from bzrlib.knit import (
40
 
    cleanup_pack_knit,
41
 
    make_file_factory,
42
 
    make_pack_factory,
43
 
    KnitAnnotateFactory,
44
 
    KnitPlainFactory,
45
 
    )
46
 
from bzrlib.tests import (
47
 
    TestCase,
48
 
    TestCaseWithMemoryTransport,
49
 
    TestNotApplicable,
50
 
    TestSkipped,
51
 
    condition_isinstance,
52
 
    split_suite_by_condition,
53
 
    multiply_tests,
54
 
    )
55
 
from bzrlib.tests.http_utils import TestCaseWithWebserver
 
37
from bzrlib.knit import KnitVersionedFile, \
 
38
     KnitAnnotateFactory
 
39
from bzrlib.tests import TestCaseWithTransport
 
40
from bzrlib.tests.HTTPTestUtil import TestCaseWithWebserver
56
41
from bzrlib.trace import mutter
57
42
from bzrlib.transport import get_transport
58
43
from bzrlib.transport.memory import MemoryTransport
59
44
from bzrlib.tsort import topo_sort
60
 
from bzrlib.tuned_gzip import GzipFile
61
45
import bzrlib.versionedfile as versionedfile
62
 
from bzrlib.versionedfile import (
63
 
    ConstantMapper,
64
 
    HashEscapedPrefixMapper,
65
 
    PrefixMapper,
66
 
    VirtualVersionedFiles,
67
 
    make_versioned_files_factory,
68
 
    )
69
46
from bzrlib.weave import WeaveFile
70
47
from bzrlib.weavefile import read_weave, write_weave
71
48
 
72
49
 
73
 
def load_tests(standard_tests, module, loader):
74
 
    """Parameterize VersionedFiles tests for different implementations."""
75
 
    to_adapt, result = split_suite_by_condition(
76
 
        standard_tests, condition_isinstance(TestVersionedFiles))
77
 
    # We want to be sure of behaviour for:
78
 
    # weaves prefix layout (weave texts)
79
 
    # individually named weaves (weave inventories)
80
 
    # annotated knits - prefix|hash|hash-escape layout, we test the third only
81
 
    #                   as it is the most complex mapper.
82
 
    # individually named knits
83
 
    # individual no-graph knits in packs (signatures)
84
 
    # individual graph knits in packs (inventories)
85
 
    # individual graph nocompression knits in packs (revisions)
86
 
    # plain text knits in packs (texts)
87
 
    len_one_scenarios = [
88
 
        ('weave-named', {
89
 
            'cleanup':None,
90
 
            'factory':make_versioned_files_factory(WeaveFile,
91
 
                ConstantMapper('inventory')),
92
 
            'graph':True,
93
 
            'key_length':1,
94
 
            'support_partial_insertion': False,
95
 
            }),
96
 
        ('named-knit', {
97
 
            'cleanup':None,
98
 
            'factory':make_file_factory(False, ConstantMapper('revisions')),
99
 
            'graph':True,
100
 
            'key_length':1,
101
 
            'support_partial_insertion': False,
102
 
            }),
103
 
        ('named-nograph-nodelta-knit-pack', {
104
 
            'cleanup':cleanup_pack_knit,
105
 
            'factory':make_pack_factory(False, False, 1),
106
 
            'graph':False,
107
 
            'key_length':1,
108
 
            'support_partial_insertion': False,
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
 
            'support_partial_insertion': True,
116
 
            }),
117
 
        ('named-graph-nodelta-knit-pack', {
118
 
            'cleanup':cleanup_pack_knit,
119
 
            'factory':make_pack_factory(True, False, 1),
120
 
            'graph':True,
121
 
            'key_length':1,
122
 
            'support_partial_insertion': False,
123
 
            }),
124
 
        ('groupcompress-nograph', {
125
 
            'cleanup':groupcompress.cleanup_pack_group,
126
 
            'factory':groupcompress.make_pack_factory(False, False, 1),
127
 
            'graph': False,
128
 
            'key_length':1,
129
 
            'support_partial_insertion':False,
130
 
            }),
131
 
        ]
132
 
    len_two_scenarios = [
133
 
        ('weave-prefix', {
134
 
            'cleanup':None,
135
 
            'factory':make_versioned_files_factory(WeaveFile,
136
 
                PrefixMapper()),
137
 
            'graph':True,
138
 
            'key_length':2,
139
 
            'support_partial_insertion': False,
140
 
            }),
141
 
        ('annotated-knit-escape', {
142
 
            'cleanup':None,
143
 
            'factory':make_file_factory(True, HashEscapedPrefixMapper()),
144
 
            'graph':True,
145
 
            'key_length':2,
146
 
            'support_partial_insertion': False,
147
 
            }),
148
 
        ('plain-knit-pack', {
149
 
            'cleanup':cleanup_pack_knit,
150
 
            'factory':make_pack_factory(True, True, 2),
151
 
            'graph':True,
152
 
            'key_length':2,
153
 
            'support_partial_insertion': True,
154
 
            }),
155
 
        ('groupcompress', {
156
 
            'cleanup':groupcompress.cleanup_pack_group,
157
 
            'factory':groupcompress.make_pack_factory(True, False, 1),
158
 
            'graph': True,
159
 
            'key_length':1,
160
 
            'support_partial_insertion':False,
161
 
            }),
162
 
        ]
163
 
    scenarios = len_one_scenarios + len_two_scenarios
164
 
    return multiply_tests(to_adapt, scenarios, result)
165
 
 
166
 
 
167
 
def get_diamond_vf(f, trailing_eol=True, left_only=False):
168
 
    """Get a diamond graph to exercise deltas and merges.
169
 
 
170
 
    :param trailing_eol: If True end the last line with \n.
171
 
    """
172
 
    parents = {
173
 
        'origin': (),
174
 
        'base': (('origin',),),
175
 
        'left': (('base',),),
176
 
        'right': (('base',),),
177
 
        'merged': (('left',), ('right',)),
178
 
        }
179
 
    # insert a diamond graph to exercise deltas and merges.
180
 
    if trailing_eol:
181
 
        last_char = '\n'
182
 
    else:
183
 
        last_char = ''
184
 
    f.add_lines('origin', [], ['origin' + last_char])
185
 
    f.add_lines('base', ['origin'], ['base' + last_char])
186
 
    f.add_lines('left', ['base'], ['base\n', 'left' + last_char])
187
 
    if not left_only:
188
 
        f.add_lines('right', ['base'],
189
 
            ['base\n', 'right' + last_char])
190
 
        f.add_lines('merged', ['left', 'right'],
191
 
            ['base\n', 'left\n', 'right\n', 'merged' + last_char])
192
 
    return f, parents
193
 
 
194
 
 
195
 
def get_diamond_files(files, key_length, trailing_eol=True, left_only=False,
196
 
    nograph=False, nokeys=False):
197
 
    """Get a diamond graph to exercise deltas and merges.
198
 
 
199
 
    This creates a 5-node graph in files. If files supports 2-length keys two
200
 
    graphs are made to exercise the support for multiple ids.
201
 
 
202
 
    :param trailing_eol: If True end the last line with \n.
203
 
    :param key_length: The length of keys in files. Currently supports length 1
204
 
        and 2 keys.
205
 
    :param left_only: If True do not add the right and merged nodes.
206
 
    :param nograph: If True, do not provide parents to the add_lines calls;
207
 
        this is useful for tests that need inserted data but have graphless
208
 
        stores.
209
 
    :param nokeys: If True, pass None is as the key for all insertions.
210
 
        Currently implies nograph.
211
 
    :return: The results of the add_lines calls.
212
 
    """
213
 
    if nokeys:
214
 
        nograph = True
215
 
    if key_length == 1:
216
 
        prefixes = [()]
217
 
    else:
218
 
        prefixes = [('FileA',), ('FileB',)]
219
 
    # insert a diamond graph to exercise deltas and merges.
220
 
    if trailing_eol:
221
 
        last_char = '\n'
222
 
    else:
223
 
        last_char = ''
224
 
    result = []
225
 
    def get_parents(suffix_list):
226
 
        if nograph:
227
 
            return ()
228
 
        else:
229
 
            result = [prefix + suffix for suffix in suffix_list]
230
 
            return result
231
 
    def get_key(suffix):
232
 
        if nokeys:
233
 
            return (None, )
234
 
        else:
235
 
            return (suffix,)
236
 
    # we loop over each key because that spreads the inserts across prefixes,
237
 
    # which is how commit operates.
238
 
    for prefix in prefixes:
239
 
        result.append(files.add_lines(prefix + get_key('origin'), (),
240
 
            ['origin' + last_char]))
241
 
    for prefix in prefixes:
242
 
        result.append(files.add_lines(prefix + get_key('base'),
243
 
            get_parents([('origin',)]), ['base' + last_char]))
244
 
    for prefix in prefixes:
245
 
        result.append(files.add_lines(prefix + get_key('left'),
246
 
            get_parents([('base',)]),
247
 
            ['base\n', 'left' + last_char]))
248
 
    if not left_only:
249
 
        for prefix in prefixes:
250
 
            result.append(files.add_lines(prefix + get_key('right'),
251
 
                get_parents([('base',)]),
252
 
                ['base\n', 'right' + last_char]))
253
 
        for prefix in prefixes:
254
 
            result.append(files.add_lines(prefix + get_key('merged'),
255
 
                get_parents([('left',), ('right',)]),
256
 
                ['base\n', 'left\n', 'right\n', 'merged' + last_char]))
257
 
    return result
258
 
 
259
 
 
260
50
class VersionedFileTestMixIn(object):
261
51
    """A mixin test class for testing VersionedFiles.
262
52
 
265
55
    they are strictly controlled by their owning repositories.
266
56
    """
267
57
 
268
 
    def get_transaction(self):
269
 
        if not hasattr(self, '_transaction'):
270
 
            self._transaction = None
271
 
        return self._transaction
272
 
 
273
58
    def test_add(self):
274
59
        f = self.get_file()
275
60
        f.add_lines('r0', [], ['a\n', 'b\n'])
283
68
            self.assertEquals(f.get_lines('r1'), ['b\n', 'c\n'])
284
69
            self.assertEqual(2, len(f))
285
70
            self.assertEqual(2, f.num_versions())
286
 
 
 
71
    
287
72
            self.assertRaises(RevisionNotPresent,
288
73
                f.add_lines, 'r2', ['foo'], [])
289
74
            self.assertRaises(RevisionAlreadyPresent,
296
81
    def test_adds_with_parent_texts(self):
297
82
        f = self.get_file()
298
83
        parent_texts = {}
299
 
        _, _, parent_texts['r0'] = f.add_lines('r0', [], ['a\n', 'b\n'])
 
84
        parent_texts['r0'] = f.add_lines('r0', [], ['a\n', 'b\n'])
300
85
        try:
301
 
            _, _, parent_texts['r1'] = f.add_lines_with_ghosts('r1',
302
 
                ['r0', 'ghost'], ['b\n', 'c\n'], parent_texts=parent_texts)
 
86
            parent_texts['r1'] = f.add_lines_with_ghosts('r1',
 
87
                                                         ['r0', 'ghost'], 
 
88
                                                         ['b\n', 'c\n'],
 
89
                                                         parent_texts=parent_texts)
303
90
        except NotImplementedError:
304
91
            # if the format doesn't support ghosts, just add normally.
305
 
            _, _, parent_texts['r1'] = f.add_lines('r1',
306
 
                ['r0'], ['b\n', 'c\n'], parent_texts=parent_texts)
 
92
            parent_texts['r1'] = f.add_lines('r1',
 
93
                                             ['r0'], 
 
94
                                             ['b\n', 'c\n'],
 
95
                                             parent_texts=parent_texts)
307
96
        f.add_lines('r2', ['r1'], ['c\n', 'd\n'], parent_texts=parent_texts)
308
97
        self.assertNotEqual(None, parent_texts['r0'])
309
98
        self.assertNotEqual(None, parent_texts['r1'])
328
117
        verify_file(f)
329
118
 
330
119
    def test_add_unicode_content(self):
331
 
        # unicode content is not permitted in versioned files.
 
120
        # unicode content is not permitted in versioned files. 
332
121
        # versioned files version sequences of bytes only.
333
122
        vf = self.get_file()
334
123
        self.assertRaises(errors.BzrBadParameterUnicode,
337
126
            (errors.BzrBadParameterUnicode, NotImplementedError),
338
127
            vf.add_lines_with_ghosts, 'a', [], ['a\n', u'b\n', 'c\n'])
339
128
 
340
 
    def test_add_follows_left_matching_blocks(self):
341
 
        """If we change left_matching_blocks, delta changes
342
 
 
343
 
        Note: There are multiple correct deltas in this case, because
344
 
        we start with 1 "a" and we get 3.
345
 
        """
346
 
        vf = self.get_file()
347
 
        if isinstance(vf, WeaveFile):
348
 
            raise TestSkipped("WeaveFile ignores left_matching_blocks")
349
 
        vf.add_lines('1', [], ['a\n'])
350
 
        vf.add_lines('2', ['1'], ['a\n', 'a\n', 'a\n'],
351
 
                     left_matching_blocks=[(0, 0, 1), (1, 3, 0)])
352
 
        self.assertEqual(['a\n', 'a\n', 'a\n'], vf.get_lines('2'))
353
 
        vf.add_lines('3', ['1'], ['a\n', 'a\n', 'a\n'],
354
 
                     left_matching_blocks=[(0, 2, 1), (1, 3, 0)])
355
 
        self.assertEqual(['a\n', 'a\n', 'a\n'], vf.get_lines('3'))
356
 
 
357
129
    def test_inline_newline_throws(self):
358
130
        # \r characters are not permitted in lines being added
359
131
        vf = self.get_file()
360
 
        self.assertRaises(errors.BzrBadParameterContainsNewline,
 
132
        self.assertRaises(errors.BzrBadParameterContainsNewline, 
361
133
            vf.add_lines, 'a', [], ['a\n\n'])
362
134
        self.assertRaises(
363
135
            (errors.BzrBadParameterContainsNewline, NotImplementedError),
374
146
        self.assertRaises(errors.ReservedId,
375
147
            vf.add_lines, 'a:', [], ['a\n', 'b\n', 'c\n'])
376
148
 
377
 
    def test_add_lines_nostoresha(self):
378
 
        """When nostore_sha is supplied using old content raises."""
379
 
        vf = self.get_file()
380
 
        empty_text = ('a', [])
381
 
        sample_text_nl = ('b', ["foo\n", "bar\n"])
382
 
        sample_text_no_nl = ('c', ["foo\n", "bar"])
383
 
        shas = []
384
 
        for version, lines in (empty_text, sample_text_nl, sample_text_no_nl):
385
 
            sha, _, _ = vf.add_lines(version, [], lines)
386
 
            shas.append(sha)
387
 
        # we now have a copy of all the lines in the vf.
388
 
        for sha, (version, lines) in zip(
389
 
            shas, (empty_text, sample_text_nl, sample_text_no_nl)):
390
 
            self.assertRaises(errors.ExistingContent,
391
 
                vf.add_lines, version + "2", [], lines,
392
 
                nostore_sha=sha)
393
 
            # and no new version should have been added.
394
 
            self.assertRaises(errors.RevisionNotPresent, vf.get_lines,
395
 
                version + "2")
396
 
 
397
 
    def test_add_lines_with_ghosts_nostoresha(self):
398
 
        """When nostore_sha is supplied using old content raises."""
399
 
        vf = self.get_file()
400
 
        empty_text = ('a', [])
401
 
        sample_text_nl = ('b', ["foo\n", "bar\n"])
402
 
        sample_text_no_nl = ('c', ["foo\n", "bar"])
403
 
        shas = []
404
 
        for version, lines in (empty_text, sample_text_nl, sample_text_no_nl):
405
 
            sha, _, _ = vf.add_lines(version, [], lines)
406
 
            shas.append(sha)
407
 
        # we now have a copy of all the lines in the vf.
408
 
        # is the test applicable to this vf implementation?
409
 
        try:
410
 
            vf.add_lines_with_ghosts('d', [], [])
411
 
        except NotImplementedError:
412
 
            raise TestSkipped("add_lines_with_ghosts is optional")
413
 
        for sha, (version, lines) in zip(
414
 
            shas, (empty_text, sample_text_nl, sample_text_no_nl)):
415
 
            self.assertRaises(errors.ExistingContent,
416
 
                vf.add_lines_with_ghosts, version + "2", [], lines,
417
 
                nostore_sha=sha)
418
 
            # and no new version should have been added.
419
 
            self.assertRaises(errors.RevisionNotPresent, vf.get_lines,
420
 
                version + "2")
421
 
 
422
 
    def test_add_lines_return_value(self):
423
 
        # add_lines should return the sha1 and the text size.
424
 
        vf = self.get_file()
425
 
        empty_text = ('a', [])
426
 
        sample_text_nl = ('b', ["foo\n", "bar\n"])
427
 
        sample_text_no_nl = ('c', ["foo\n", "bar"])
428
 
        # check results for the three cases:
429
 
        for version, lines in (empty_text, sample_text_nl, sample_text_no_nl):
430
 
            # the first two elements are the same for all versioned files:
431
 
            # - the digest and the size of the text. For some versioned files
432
 
            #   additional data is returned in additional tuple elements.
433
 
            result = vf.add_lines(version, [], lines)
434
 
            self.assertEqual(3, len(result))
435
 
            self.assertEqual((osutils.sha_strings(lines), sum(map(len, lines))),
436
 
                result[0:2])
437
 
        # parents should not affect the result:
438
 
        lines = sample_text_nl[1]
439
 
        self.assertEqual((osutils.sha_strings(lines), sum(map(len, lines))),
440
 
            vf.add_lines('d', ['b', 'c'], lines)[0:2])
 
149
        self.assertRaises(errors.ReservedId,
 
150
            vf.add_delta, 'a:', [], None, 'sha1', False, ((0, 0, 0, []),))
441
151
 
442
152
    def test_get_reserved(self):
443
153
        vf = self.get_file()
 
154
        self.assertRaises(errors.ReservedId, vf.get_delta, 'b:')
444
155
        self.assertRaises(errors.ReservedId, vf.get_texts, ['b:'])
445
156
        self.assertRaises(errors.ReservedId, vf.get_lines, 'b:')
446
157
        self.assertRaises(errors.ReservedId, vf.get_text, 'b:')
447
158
 
448
 
    def test_add_unchanged_last_line_noeol_snapshot(self):
449
 
        """Add a text with an unchanged last line with no eol should work."""
450
 
        # Test adding this in a number of chain lengths; because the interface
451
 
        # for VersionedFile does not allow forcing a specific chain length, we
452
 
        # just use a small base to get the first snapshot, then a much longer
453
 
        # first line for the next add (which will make the third add snapshot)
454
 
        # and so on. 20 has been chosen as an aribtrary figure - knits use 200
455
 
        # as a capped delta length, but ideally we would have some way of
456
 
        # tuning the test to the store (e.g. keep going until a snapshot
457
 
        # happens).
458
 
        for length in range(20):
459
 
            version_lines = {}
460
 
            vf = self.get_file('case-%d' % length)
461
 
            prefix = 'step-%d'
462
 
            parents = []
463
 
            for step in range(length):
464
 
                version = prefix % step
465
 
                lines = (['prelude \n'] * step) + ['line']
466
 
                vf.add_lines(version, parents, lines)
467
 
                version_lines[version] = lines
468
 
                parents = [version]
469
 
            vf.add_lines('no-eol', parents, ['line'])
470
 
            vf.get_texts(version_lines.keys())
471
 
            self.assertEqualDiff('line', vf.get_text('no-eol'))
472
 
 
473
 
    def test_get_texts_eol_variation(self):
474
 
        # similar to the failure in <http://bugs.launchpad.net/234748>
475
 
        vf = self.get_file()
476
 
        sample_text_nl = ["line\n"]
477
 
        sample_text_no_nl = ["line"]
478
 
        versions = []
479
 
        version_lines = {}
480
 
        parents = []
481
 
        for i in range(4):
482
 
            version = 'v%d' % i
483
 
            if i % 2:
484
 
                lines = sample_text_nl
485
 
            else:
486
 
                lines = sample_text_no_nl
487
 
            # left_matching blocks is an internal api; it operates on the
488
 
            # *internal* representation for a knit, which is with *all* lines
489
 
            # being normalised to end with \n - even the final line in a no_nl
490
 
            # file. Using it here ensures that a broken internal implementation
491
 
            # (which is what this test tests) will generate a correct line
492
 
            # delta (which is to say, an empty delta).
493
 
            vf.add_lines(version, parents, lines,
494
 
                left_matching_blocks=[(0, 0, 1)])
495
 
            parents = [version]
496
 
            versions.append(version)
497
 
            version_lines[version] = lines
498
 
        vf.check()
499
 
        vf.get_texts(versions)
500
 
        vf.get_texts(reversed(versions))
501
 
 
502
 
    def test_add_lines_with_matching_blocks_noeol_last_line(self):
503
 
        """Add a text with an unchanged last line with no eol should work."""
504
 
        from bzrlib import multiparent
505
 
        # Hand verified sha1 of the text we're adding.
506
 
        sha1 = '6a1d115ec7b60afb664dc14890b5af5ce3c827a4'
507
 
        # Create a mpdiff which adds a new line before the trailing line, and
508
 
        # reuse the last line unaltered (which can cause annotation reuse).
509
 
        # Test adding this in two situations:
510
 
        # On top of a new insertion
511
 
        vf = self.get_file('fulltext')
512
 
        vf.add_lines('noeol', [], ['line'])
513
 
        vf.add_lines('noeol2', ['noeol'], ['newline\n', 'line'],
514
 
            left_matching_blocks=[(0, 1, 1)])
515
 
        self.assertEqualDiff('newline\nline', vf.get_text('noeol2'))
516
 
        # On top of a delta
517
 
        vf = self.get_file('delta')
518
 
        vf.add_lines('base', [], ['line'])
519
 
        vf.add_lines('noeol', ['base'], ['prelude\n', 'line'])
520
 
        vf.add_lines('noeol2', ['noeol'], ['newline\n', 'line'],
521
 
            left_matching_blocks=[(1, 1, 1)])
522
 
        self.assertEqualDiff('newline\nline', vf.get_text('noeol2'))
523
 
 
524
 
    def test_make_mpdiffs(self):
525
 
        from bzrlib import multiparent
526
 
        vf = self.get_file('foo')
527
 
        sha1s = self._setup_for_deltas(vf)
528
 
        new_vf = self.get_file('bar')
529
 
        for version in multiparent.topo_iter(vf):
530
 
            mpdiff = vf.make_mpdiffs([version])[0]
531
 
            new_vf.add_mpdiffs([(version, vf.get_parent_map([version])[version],
532
 
                                 vf.get_sha1s([version])[version], mpdiff)])
533
 
            self.assertEqualDiff(vf.get_text(version),
534
 
                                 new_vf.get_text(version))
535
 
 
536
 
    def test_make_mpdiffs_with_ghosts(self):
537
 
        vf = self.get_file('foo')
538
 
        try:
539
 
            vf.add_lines_with_ghosts('text', ['ghost'], ['line\n'])
540
 
        except NotImplementedError:
541
 
            # old Weave formats do not allow ghosts
542
 
            return
543
 
        self.assertRaises(errors.RevisionNotPresent, vf.make_mpdiffs, ['ghost'])
 
159
    def test_get_delta(self):
 
160
        f = self.get_file()
 
161
        sha1s = self._setup_for_deltas(f)
 
162
        expected_delta = (None, '6bfa09d82ce3e898ad4641ae13dd4fdb9cf0d76b', False, 
 
163
                          [(0, 0, 1, [('base', 'line\n')])])
 
164
        self.assertEqual(expected_delta, f.get_delta('base'))
 
165
        next_parent = 'base'
 
166
        text_name = 'chain1-'
 
167
        for depth in range(26):
 
168
            new_version = text_name + '%s' % depth
 
169
            expected_delta = (next_parent, sha1s[depth], 
 
170
                              False,
 
171
                              [(depth + 1, depth + 1, 1, [(new_version, 'line\n')])])
 
172
            self.assertEqual(expected_delta, f.get_delta(new_version))
 
173
            next_parent = new_version
 
174
        next_parent = 'base'
 
175
        text_name = 'chain2-'
 
176
        for depth in range(26):
 
177
            new_version = text_name + '%s' % depth
 
178
            expected_delta = (next_parent, sha1s[depth], False,
 
179
                              [(depth + 1, depth + 1, 1, [(new_version, 'line\n')])])
 
180
            self.assertEqual(expected_delta, f.get_delta(new_version))
 
181
            next_parent = new_version
 
182
        # smoke test for eol support
 
183
        expected_delta = ('base', '264f39cab871e4cfd65b3a002f7255888bb5ed97', True, [])
 
184
        self.assertEqual(['line'], f.get_lines('noeol'))
 
185
        self.assertEqual(expected_delta, f.get_delta('noeol'))
 
186
 
 
187
    def test_get_deltas(self):
 
188
        f = self.get_file()
 
189
        sha1s = self._setup_for_deltas(f)
 
190
        deltas = f.get_deltas(f.versions())
 
191
        expected_delta = (None, '6bfa09d82ce3e898ad4641ae13dd4fdb9cf0d76b', False, 
 
192
                          [(0, 0, 1, [('base', 'line\n')])])
 
193
        self.assertEqual(expected_delta, deltas['base'])
 
194
        next_parent = 'base'
 
195
        text_name = 'chain1-'
 
196
        for depth in range(26):
 
197
            new_version = text_name + '%s' % depth
 
198
            expected_delta = (next_parent, sha1s[depth], 
 
199
                              False,
 
200
                              [(depth + 1, depth + 1, 1, [(new_version, 'line\n')])])
 
201
            self.assertEqual(expected_delta, deltas[new_version])
 
202
            next_parent = new_version
 
203
        next_parent = 'base'
 
204
        text_name = 'chain2-'
 
205
        for depth in range(26):
 
206
            new_version = text_name + '%s' % depth
 
207
            expected_delta = (next_parent, sha1s[depth], False,
 
208
                              [(depth + 1, depth + 1, 1, [(new_version, 'line\n')])])
 
209
            self.assertEqual(expected_delta, deltas[new_version])
 
210
            next_parent = new_version
 
211
        # smoke tests for eol support
 
212
        expected_delta = ('base', '264f39cab871e4cfd65b3a002f7255888bb5ed97', True, [])
 
213
        self.assertEqual(['line'], f.get_lines('noeol'))
 
214
        self.assertEqual(expected_delta, deltas['noeol'])
 
215
        # smoke tests for eol support - two noeol in a row same content
 
216
        expected_deltas = (('noeol', '3ad7ee82dbd8f29ecba073f96e43e414b3f70a4d', True, 
 
217
                          [(0, 1, 2, [('noeolsecond', 'line\n'), ('noeolsecond', 'line\n')])]),
 
218
                          ('noeol', '3ad7ee82dbd8f29ecba073f96e43e414b3f70a4d', True, 
 
219
                           [(0, 0, 1, [('noeolsecond', 'line\n')]), (1, 1, 0, [])]))
 
220
        self.assertEqual(['line\n', 'line'], f.get_lines('noeolsecond'))
 
221
        self.assertTrue(deltas['noeolsecond'] in expected_deltas)
 
222
        # two no-eol in a row, different content
 
223
        expected_delta = ('noeolsecond', '8bb553a84e019ef1149db082d65f3133b195223b', True, 
 
224
                          [(1, 2, 1, [('noeolnotshared', 'phone\n')])])
 
225
        self.assertEqual(['line\n', 'phone'], f.get_lines('noeolnotshared'))
 
226
        self.assertEqual(expected_delta, deltas['noeolnotshared'])
 
227
        # eol folling a no-eol with content change
 
228
        expected_delta = ('noeol', 'a61f6fb6cfc4596e8d88c34a308d1e724caf8977', False, 
 
229
                          [(0, 1, 1, [('eol', 'phone\n')])])
 
230
        self.assertEqual(['phone\n'], f.get_lines('eol'))
 
231
        self.assertEqual(expected_delta, deltas['eol'])
 
232
        # eol folling a no-eol with content change
 
233
        expected_delta = ('noeol', '6bfa09d82ce3e898ad4641ae13dd4fdb9cf0d76b', False, 
 
234
                          [(0, 1, 1, [('eolline', 'line\n')])])
 
235
        self.assertEqual(['line\n'], f.get_lines('eolline'))
 
236
        self.assertEqual(expected_delta, deltas['eolline'])
 
237
        # eol with no parents
 
238
        expected_delta = (None, '264f39cab871e4cfd65b3a002f7255888bb5ed97', True, 
 
239
                          [(0, 0, 1, [('noeolbase', 'line\n')])])
 
240
        self.assertEqual(['line'], f.get_lines('noeolbase'))
 
241
        self.assertEqual(expected_delta, deltas['noeolbase'])
 
242
        # eol with two parents, in inverse insertion order
 
243
        expected_deltas = (('noeolbase', '264f39cab871e4cfd65b3a002f7255888bb5ed97', True,
 
244
                            [(0, 1, 1, [('eolbeforefirstparent', 'line\n')])]),
 
245
                           ('noeolbase', '264f39cab871e4cfd65b3a002f7255888bb5ed97', True,
 
246
                            [(0, 1, 1, [('eolbeforefirstparent', 'line\n')])]))
 
247
        self.assertEqual(['line'], f.get_lines('eolbeforefirstparent'))
 
248
        #self.assertTrue(deltas['eolbeforefirstparent'] in expected_deltas)
544
249
 
545
250
    def _setup_for_deltas(self, f):
546
 
        self.assertFalse(f.has_version('base'))
 
251
        self.assertRaises(errors.RevisionNotPresent, f.get_delta, 'base')
547
252
        # add texts that should trip the knit maximum delta chain threshold
548
253
        # as well as doing parallel chains of data in knits.
549
254
        # this is done by two chains of 25 insertions
562
267
        f.add_lines('noeolbase', [], ['line'])
563
268
        # noeol preceeding its leftmost parent in the output:
564
269
        # this is done by making it a merge of two parents with no common
565
 
        # anestry: noeolbase and noeol with the
 
270
        # anestry: noeolbase and noeol with the 
566
271
        # later-inserted parent the leftmost.
567
272
        f.add_lines('eolbeforefirstparent', ['noeolbase', 'noeol'], ['line'])
568
273
        # two identical eol texts
612
317
            next_parent = new_version
613
318
        return sha1s
614
319
 
 
320
    def test_add_delta(self):
 
321
        # tests for the add-delta facility.
 
322
        # at this point, optimising for speed, we assume no checks when deltas are inserted.
 
323
        # this may need to be revisited.
 
324
        source = self.get_file('source')
 
325
        source.add_lines('base', [], ['line\n'])
 
326
        next_parent = 'base'
 
327
        text_name = 'chain1-'
 
328
        text = ['line\n']
 
329
        for depth in range(26):
 
330
            new_version = text_name + '%s' % depth
 
331
            text = text + ['line\n']
 
332
            source.add_lines(new_version, [next_parent], text)
 
333
            next_parent = new_version
 
334
        next_parent = 'base'
 
335
        text_name = 'chain2-'
 
336
        text = ['line\n']
 
337
        for depth in range(26):
 
338
            new_version = text_name + '%s' % depth
 
339
            text = text + ['line\n']
 
340
            source.add_lines(new_version, [next_parent], text)
 
341
            next_parent = new_version
 
342
        source.add_lines('noeol', ['base'], ['line'])
 
343
        
 
344
        target = self.get_file('target')
 
345
        for version in source.versions():
 
346
            parent, sha1, noeol, delta = source.get_delta(version)
 
347
            target.add_delta(version,
 
348
                             source.get_parents(version),
 
349
                             parent,
 
350
                             sha1,
 
351
                             noeol,
 
352
                             delta)
 
353
        self.assertRaises(RevisionAlreadyPresent,
 
354
                          target.add_delta, 'base', [], None, '', False, [])
 
355
        for version in source.versions():
 
356
            self.assertEqual(source.get_lines(version),
 
357
                             target.get_lines(version))
 
358
 
615
359
    def test_ancestry(self):
616
360
        f = self.get_file()
617
361
        self.assertEqual([], f.get_ancestry([]))
644
388
            set(f.get_ancestry('rM', topo_sorted=False)))
645
389
 
646
390
    def test_mutate_after_finish(self):
647
 
        self._transaction = 'before'
648
391
        f = self.get_file()
649
 
        self._transaction = 'after'
 
392
        f.transaction_finished()
 
393
        self.assertRaises(errors.OutSideTransaction, f.add_delta, '', [], '', '', False, [])
650
394
        self.assertRaises(errors.OutSideTransaction, f.add_lines, '', [], [])
651
395
        self.assertRaises(errors.OutSideTransaction, f.add_lines_with_ghosts, '', [], [])
 
396
        self.assertRaises(errors.OutSideTransaction, f.fix_parents, '', [])
 
397
        self.assertRaises(errors.OutSideTransaction, f.join, '')
 
398
        self.assertRaises(errors.OutSideTransaction, f.clone_text, 'base', 'bar', ['foo'])
 
399
        
 
400
    def test_clear_cache(self):
 
401
        f = self.get_file()
 
402
        # on a new file it should not error
 
403
        f.clear_cache()
 
404
        # and after adding content, doing a clear_cache and a get should work.
 
405
        f.add_lines('0', [], ['a'])
 
406
        f.clear_cache()
 
407
        self.assertEqual(['a'], f.get_lines('0'))
 
408
 
 
409
    def test_clone_text(self):
 
410
        f = self.get_file()
 
411
        f.add_lines('r0', [], ['a\n', 'b\n'])
 
412
        f.clone_text('r1', 'r0', ['r0'])
 
413
        def verify_file(f):
 
414
            self.assertEquals(f.get_lines('r1'), f.get_lines('r0'))
 
415
            self.assertEquals(f.get_lines('r1'), ['a\n', 'b\n'])
 
416
            self.assertEquals(f.get_parents('r1'), ['r0'])
 
417
    
 
418
            self.assertRaises(RevisionNotPresent,
 
419
                f.clone_text, 'r2', 'rX', [])
 
420
            self.assertRaises(RevisionAlreadyPresent,
 
421
                f.clone_text, 'r1', 'r0', [])
 
422
        verify_file(f)
 
423
        verify_file(self.reopen_file())
 
424
 
 
425
    def test_create_empty(self):
 
426
        f = self.get_file()
 
427
        f.add_lines('0', [], ['a\n'])
 
428
        new_f = f.create_empty('t', MemoryTransport())
 
429
        # smoke test, specific types should check it is honoured correctly for
 
430
        # non type attributes
 
431
        self.assertEqual([], new_f.versions())
 
432
        self.assertTrue(isinstance(new_f, f.__class__))
652
433
 
653
434
    def test_copy_to(self):
654
435
        f = self.get_file()
655
436
        f.add_lines('0', [], ['a\n'])
656
437
        t = MemoryTransport()
657
438
        f.copy_to('foo', t)
658
 
        for suffix in self.get_factory().get_suffixes():
 
439
        for suffix in f.__class__.get_suffixes():
659
440
            self.assertTrue(t.has('foo' + suffix))
660
441
 
661
442
    def test_get_suffixes(self):
662
443
        f = self.get_file()
 
444
        # should be the same
 
445
        self.assertEqual(f.__class__.get_suffixes(), f.__class__.get_suffixes())
663
446
        # and should be a list
664
 
        self.assertTrue(isinstance(self.get_factory().get_suffixes(), list))
665
 
 
666
 
    def test_get_parent_map(self):
 
447
        self.assertTrue(isinstance(f.__class__.get_suffixes(), list))
 
448
 
 
449
    def build_graph(self, file, graph):
 
450
        for node in topo_sort(graph.items()):
 
451
            file.add_lines(node, graph[node], [])
 
452
 
 
453
    def test_get_graph(self):
 
454
        f = self.get_file()
 
455
        graph = {
 
456
            'v1': (),
 
457
            'v2': ('v1', ),
 
458
            'v3': ('v2', )}
 
459
        self.build_graph(f, graph)
 
460
        self.assertEqual(graph, f.get_graph())
 
461
    
 
462
    def test_get_graph_partial(self):
 
463
        f = self.get_file()
 
464
        complex_graph = {}
 
465
        simple_a = {
 
466
            'c': (),
 
467
            'b': ('c', ),
 
468
            'a': ('b', ),
 
469
            }
 
470
        complex_graph.update(simple_a)
 
471
        simple_b = {
 
472
            'c': (),
 
473
            'b': ('c', ),
 
474
            }
 
475
        complex_graph.update(simple_b)
 
476
        simple_gam = {
 
477
            'c': (),
 
478
            'oo': (),
 
479
            'bar': ('oo', 'c'),
 
480
            'gam': ('bar', ),
 
481
            }
 
482
        complex_graph.update(simple_gam)
 
483
        simple_b_gam = {}
 
484
        simple_b_gam.update(simple_gam)
 
485
        simple_b_gam.update(simple_b)
 
486
        self.build_graph(f, complex_graph)
 
487
        self.assertEqual(simple_a, f.get_graph(['a']))
 
488
        self.assertEqual(simple_b, f.get_graph(['b']))
 
489
        self.assertEqual(simple_gam, f.get_graph(['gam']))
 
490
        self.assertEqual(simple_b_gam, f.get_graph(['b', 'gam']))
 
491
 
 
492
    def test_get_parents(self):
667
493
        f = self.get_file()
668
494
        f.add_lines('r0', [], ['a\n', 'b\n'])
669
 
        self.assertEqual(
670
 
            {'r0':()}, f.get_parent_map(['r0']))
671
 
        f.add_lines('r1', ['r0'], ['a\n', 'b\n'])
672
 
        self.assertEqual(
673
 
            {'r1':('r0',)}, f.get_parent_map(['r1']))
674
 
        self.assertEqual(
675
 
            {'r0':(),
676
 
             'r1':('r0',)},
677
 
            f.get_parent_map(['r0', 'r1']))
 
495
        f.add_lines('r1', [], ['a\n', 'b\n'])
678
496
        f.add_lines('r2', [], ['a\n', 'b\n'])
679
497
        f.add_lines('r3', [], ['a\n', 'b\n'])
680
498
        f.add_lines('m', ['r0', 'r1', 'r2', 'r3'], ['a\n', 'b\n'])
681
 
        self.assertEqual(
682
 
            {'m':('r0', 'r1', 'r2', 'r3')}, f.get_parent_map(['m']))
683
 
        self.assertEqual({}, f.get_parent_map('y'))
684
 
        self.assertEqual(
685
 
            {'r0':(),
686
 
             'r1':('r0',)},
687
 
            f.get_parent_map(['r0', 'y', 'r1']))
 
499
        self.assertEquals(f.get_parents('m'), ['r0', 'r1', 'r2', 'r3'])
 
500
 
 
501
        self.assertRaises(RevisionNotPresent,
 
502
            f.get_parents, 'y')
688
503
 
689
504
    def test_annotate(self):
690
505
        f = self.get_file()
697
512
        self.assertRaises(RevisionNotPresent,
698
513
            f.annotate, 'foo')
699
514
 
 
515
    def test_walk(self):
 
516
        # tests that walk returns all the inclusions for the requested
 
517
        # revisions as well as the revisions changes themselves.
 
518
        f = self.get_file('1')
 
519
        f.add_lines('r0', [], ['a\n', 'b\n'])
 
520
        f.add_lines('r1', ['r0'], ['c\n', 'b\n'])
 
521
        f.add_lines('rX', ['r1'], ['d\n', 'b\n'])
 
522
        f.add_lines('rY', ['r1'], ['c\n', 'e\n'])
 
523
 
 
524
        lines = {}
 
525
        for lineno, insert, dset, text in f.walk(['rX', 'rY']):
 
526
            lines[text] = (insert, dset)
 
527
 
 
528
        self.assertTrue(lines['a\n'], ('r0', set(['r1'])))
 
529
        self.assertTrue(lines['b\n'], ('r0', set(['rY'])))
 
530
        self.assertTrue(lines['c\n'], ('r1', set(['rX'])))
 
531
        self.assertTrue(lines['d\n'], ('rX', set([])))
 
532
        self.assertTrue(lines['e\n'], ('rY', set([])))
 
533
 
700
534
    def test_detection(self):
701
535
        # Test weaves detect corruption.
702
536
        #
726
560
        """Open the versioned file from disk again."""
727
561
        raise NotImplementedError(self.reopen_file)
728
562
 
 
563
    def test_iter_parents(self):
 
564
        """iter_parents returns the parents for many nodes."""
 
565
        f = self.get_file()
 
566
        # sample data:
 
567
        # no parents
 
568
        f.add_lines('r0', [], ['a\n', 'b\n'])
 
569
        # 1 parents
 
570
        f.add_lines('r1', ['r0'], ['a\n', 'b\n'])
 
571
        # 2 parents
 
572
        f.add_lines('r2', ['r1', 'r0'], ['a\n', 'b\n'])
 
573
        # XXX TODO a ghost
 
574
        # cases: each sample data individually:
 
575
        self.assertEqual(set([('r0', ())]),
 
576
            set(f.iter_parents(['r0'])))
 
577
        self.assertEqual(set([('r1', ('r0', ))]),
 
578
            set(f.iter_parents(['r1'])))
 
579
        self.assertEqual(set([('r2', ('r1', 'r0'))]),
 
580
            set(f.iter_parents(['r2'])))
 
581
        # no nodes returned for a missing node
 
582
        self.assertEqual(set(),
 
583
            set(f.iter_parents(['missing'])))
 
584
        # 1 node returned with missing nodes skipped
 
585
        self.assertEqual(set([('r1', ('r0', ))]),
 
586
            set(f.iter_parents(['ghost1', 'r1', 'ghost'])))
 
587
        # 2 nodes returned
 
588
        self.assertEqual(set([('r0', ()), ('r1', ('r0', ))]),
 
589
            set(f.iter_parents(['r0', 'r1'])))
 
590
        # 2 nodes returned, missing skipped
 
591
        self.assertEqual(set([('r0', ()), ('r1', ('r0', ))]),
 
592
            set(f.iter_parents(['a', 'r0', 'b', 'r1', 'c'])))
 
593
 
729
594
    def test_iter_lines_added_or_present_in_versions(self):
730
595
        # test that we get at least an equalset of the lines added by
731
 
        # versions in the weave
 
596
        # versions in the weave 
732
597
        # the ordering here is to make a tree so that dumb searches have
733
598
        # more changes to muck up.
734
599
 
757
622
                     ['base\n', 'lancestor\n', 'otherchild\n'])
758
623
        def iter_with_versions(versions, expected):
759
624
            # now we need to see what lines are returned, and how often.
760
 
            lines = {}
 
625
            lines = {'base\n':0,
 
626
                     'lancestor\n':0,
 
627
                     'rancestor\n':0,
 
628
                     'child\n':0,
 
629
                     'otherchild\n':0,
 
630
                     }
761
631
            progress = InstrumentedProgress()
762
632
            # iterate over the lines
763
 
            for line in vf.iter_lines_added_or_present_in_versions(versions,
 
633
            for line in vf.iter_lines_added_or_present_in_versions(versions, 
764
634
                pb=progress):
765
 
                lines.setdefault(line, 0)
766
635
                lines[line] += 1
767
 
            if []!= progress.updates:
 
636
            if []!= progress.updates: 
768
637
                self.assertEqual(expected, progress.updates)
769
638
            return lines
770
639
        lines = iter_with_versions(['child', 'otherchild'],
771
 
                                   [('Walking content', 0, 2),
772
 
                                    ('Walking content', 1, 2),
773
 
                                    ('Walking content', 2, 2)])
 
640
                                   [('Walking content.', 0, 2),
 
641
                                    ('Walking content.', 1, 2),
 
642
                                    ('Walking content.', 2, 2)])
774
643
        # we must see child and otherchild
775
 
        self.assertTrue(lines[('child\n', 'child')] > 0)
776
 
        self.assertTrue(lines[('otherchild\n', 'otherchild')] > 0)
 
644
        self.assertTrue(lines['child\n'] > 0)
 
645
        self.assertTrue(lines['otherchild\n'] > 0)
777
646
        # we dont care if we got more than that.
778
 
 
 
647
        
779
648
        # test all lines
780
 
        lines = iter_with_versions(None, [('Walking content', 0, 5),
781
 
                                          ('Walking content', 1, 5),
782
 
                                          ('Walking content', 2, 5),
783
 
                                          ('Walking content', 3, 5),
784
 
                                          ('Walking content', 4, 5),
785
 
                                          ('Walking content', 5, 5)])
 
649
        lines = iter_with_versions(None, [('Walking content.', 0, 5),
 
650
                                          ('Walking content.', 1, 5),
 
651
                                          ('Walking content.', 2, 5),
 
652
                                          ('Walking content.', 3, 5),
 
653
                                          ('Walking content.', 4, 5),
 
654
                                          ('Walking content.', 5, 5)])
786
655
        # all lines must be seen at least once
787
 
        self.assertTrue(lines[('base\n', 'base')] > 0)
788
 
        self.assertTrue(lines[('lancestor\n', 'lancestor')] > 0)
789
 
        self.assertTrue(lines[('rancestor\n', 'rancestor')] > 0)
790
 
        self.assertTrue(lines[('child\n', 'child')] > 0)
791
 
        self.assertTrue(lines[('otherchild\n', 'otherchild')] > 0)
 
656
        self.assertTrue(lines['base\n'] > 0)
 
657
        self.assertTrue(lines['lancestor\n'] > 0)
 
658
        self.assertTrue(lines['rancestor\n'] > 0)
 
659
        self.assertTrue(lines['child\n'] > 0)
 
660
        self.assertTrue(lines['otherchild\n'] > 0)
 
661
 
 
662
    def test_fix_parents(self):
 
663
        # some versioned files allow incorrect parents to be corrected after
 
664
        # insertion - this may not fix ancestry..
 
665
        # if they do not supported, they just do not implement it.
 
666
        # we test this as an interface test to ensure that those that *do*
 
667
        # implementent it get it right.
 
668
        vf = self.get_file()
 
669
        vf.add_lines('notbase', [], [])
 
670
        vf.add_lines('base', [], [])
 
671
        try:
 
672
            vf.fix_parents('notbase', ['base'])
 
673
        except NotImplementedError:
 
674
            return
 
675
        self.assertEqual(['base'], vf.get_parents('notbase'))
 
676
        # open again, check it stuck.
 
677
        vf = self.get_file()
 
678
        self.assertEqual(['base'], vf.get_parents('notbase'))
 
679
 
 
680
    def test_fix_parents_with_ghosts(self):
 
681
        # when fixing parents, ghosts that are listed should not be ghosts
 
682
        # anymore.
 
683
        vf = self.get_file()
 
684
 
 
685
        try:
 
686
            vf.add_lines_with_ghosts('notbase', ['base', 'stillghost'], [])
 
687
        except NotImplementedError:
 
688
            return
 
689
        vf.add_lines('base', [], [])
 
690
        vf.fix_parents('notbase', ['base', 'stillghost'])
 
691
        self.assertEqual(['base'], vf.get_parents('notbase'))
 
692
        # open again, check it stuck.
 
693
        vf = self.get_file()
 
694
        self.assertEqual(['base'], vf.get_parents('notbase'))
 
695
        # and check the ghosts
 
696
        self.assertEqual(['base', 'stillghost'],
 
697
                         vf.get_parents_with_ghosts('notbase'))
792
698
 
793
699
    def test_add_lines_with_ghosts(self):
794
700
        # some versioned file formats allow lines to be added with parent
804
710
            vf.add_lines_with_ghosts('notbxbfse', [parent_id_utf8], [])
805
711
        except NotImplementedError:
806
712
            # check the other ghost apis are also not implemented
 
713
            self.assertRaises(NotImplementedError, vf.has_ghost, 'foo')
807
714
            self.assertRaises(NotImplementedError, vf.get_ancestry_with_ghosts, ['foo'])
808
715
            self.assertRaises(NotImplementedError, vf.get_parents_with_ghosts, 'foo')
 
716
            self.assertRaises(NotImplementedError, vf.get_graph_with_ghosts)
809
717
            return
810
718
        vf = self.reopen_file()
811
719
        # test key graph related apis: getncestry, _graph, get_parents
812
720
        # has_version
813
721
        # - these are ghost unaware and must not be reflect ghosts
814
722
        self.assertEqual(['notbxbfse'], vf.get_ancestry('notbxbfse'))
 
723
        self.assertEqual([], vf.get_parents('notbxbfse'))
 
724
        self.assertEqual({'notbxbfse':()}, vf.get_graph())
 
725
        self.assertFalse(self.callDeprecated([osutils._revision_id_warning],
 
726
                         vf.has_version, parent_id_unicode))
815
727
        self.assertFalse(vf.has_version(parent_id_utf8))
816
728
        # we have _with_ghost apis to give us ghost information.
817
729
        self.assertEqual([parent_id_utf8, 'notbxbfse'], vf.get_ancestry_with_ghosts(['notbxbfse']))
818
730
        self.assertEqual([parent_id_utf8], vf.get_parents_with_ghosts('notbxbfse'))
 
731
        self.assertEqual({'notbxbfse':[parent_id_utf8]}, vf.get_graph_with_ghosts())
 
732
        self.assertTrue(self.callDeprecated([osutils._revision_id_warning],
 
733
                        vf.has_ghost, parent_id_unicode))
 
734
        self.assertTrue(vf.has_ghost(parent_id_utf8))
819
735
        # if we add something that is a ghost of another, it should correct the
820
736
        # results of the prior apis
821
 
        vf.add_lines(parent_id_utf8, [], [])
 
737
        self.callDeprecated([osutils._revision_id_warning],
 
738
                            vf.add_lines, parent_id_unicode, [], [])
822
739
        self.assertEqual([parent_id_utf8, 'notbxbfse'], vf.get_ancestry(['notbxbfse']))
823
 
        self.assertEqual({'notbxbfse':(parent_id_utf8,)},
824
 
            vf.get_parent_map(['notbxbfse']))
 
740
        self.assertEqual([parent_id_utf8], vf.get_parents('notbxbfse'))
 
741
        self.assertEqual({parent_id_utf8:(),
 
742
                          'notbxbfse':(parent_id_utf8, ),
 
743
                          },
 
744
                         vf.get_graph())
 
745
        self.assertTrue(self.callDeprecated([osutils._revision_id_warning],
 
746
                        vf.has_version, parent_id_unicode))
825
747
        self.assertTrue(vf.has_version(parent_id_utf8))
826
748
        # we have _with_ghost apis to give us ghost information.
827
 
        self.assertEqual([parent_id_utf8, 'notbxbfse'],
828
 
            vf.get_ancestry_with_ghosts(['notbxbfse']))
 
749
        self.assertEqual([parent_id_utf8, 'notbxbfse'], vf.get_ancestry_with_ghosts(['notbxbfse']))
829
750
        self.assertEqual([parent_id_utf8], vf.get_parents_with_ghosts('notbxbfse'))
 
751
        self.assertEqual({parent_id_utf8:[],
 
752
                          'notbxbfse':[parent_id_utf8],
 
753
                          },
 
754
                         vf.get_graph_with_ghosts())
 
755
        self.assertFalse(self.callDeprecated([osutils._revision_id_warning],
 
756
                         vf.has_ghost, parent_id_unicode))
 
757
        self.assertFalse(vf.has_ghost(parent_id_utf8))
830
758
 
831
759
    def test_add_lines_with_ghosts_after_normal_revs(self):
832
760
        # some versioned file formats allow lines to be added with parent
836
764
        vf = self.get_file()
837
765
        # probe for ghost support
838
766
        try:
839
 
            vf.add_lines_with_ghosts('base', [], ['line\n', 'line_b\n'])
 
767
            vf.has_ghost('hoo')
840
768
        except NotImplementedError:
841
769
            return
 
770
        vf.add_lines_with_ghosts('base', [], ['line\n', 'line_b\n'])
842
771
        vf.add_lines_with_ghosts('references_ghost',
843
772
                                 ['base', 'a_ghost'],
844
773
                                 ['line\n', 'line_b\n', 'line_c\n'])
852
781
        factory = self.get_factory()
853
782
        vf = factory('id', transport, 0777, create=True, access_mode='w')
854
783
        vf = factory('id', transport, access_mode='r')
 
784
        self.assertRaises(errors.ReadOnlyError, vf.add_delta, '', [], '', '', False, [])
855
785
        self.assertRaises(errors.ReadOnlyError, vf.add_lines, 'base', [], [])
856
786
        self.assertRaises(errors.ReadOnlyError,
857
787
                          vf.add_lines_with_ghosts,
858
788
                          'base',
859
789
                          [],
860
790
                          [])
861
 
 
862
 
    def test_get_sha1s(self):
 
791
        self.assertRaises(errors.ReadOnlyError, vf.fix_parents, 'base', [])
 
792
        self.assertRaises(errors.ReadOnlyError, vf.join, 'base')
 
793
        self.assertRaises(errors.ReadOnlyError, vf.clone_text, 'base', 'bar', ['foo'])
 
794
    
 
795
    def test_get_sha1(self):
863
796
        # check the sha1 data is available
864
797
        vf = self.get_file()
865
798
        # a simple file
868
801
        vf.add_lines('b', ['a'], ['a\n'])
869
802
        # a file differing only in last newline.
870
803
        vf.add_lines('c', [], ['a'])
871
 
        self.assertEqual({
872
 
            'a': '3f786850e387550fdab836ed7e6dc881de23001b',
873
 
            'c': '86f7e437faa5a7fce15d1ddcb9eaeaea377667b8',
874
 
            'b': '3f786850e387550fdab836ed7e6dc881de23001b',
875
 
            },
876
 
            vf.get_sha1s(['a', 'c', 'b']))
877
 
 
878
 
 
879
 
class TestWeave(TestCaseWithMemoryTransport, VersionedFileTestMixIn):
 
804
        self.assertEqual(
 
805
            '3f786850e387550fdab836ed7e6dc881de23001b', vf.get_sha1('a'))
 
806
        self.assertEqual(
 
807
            '3f786850e387550fdab836ed7e6dc881de23001b', vf.get_sha1('b'))
 
808
        self.assertEqual(
 
809
            '86f7e437faa5a7fce15d1ddcb9eaeaea377667b8', vf.get_sha1('c'))
 
810
        
 
811
 
 
812
class TestWeave(TestCaseWithTransport, VersionedFileTestMixIn):
880
813
 
881
814
    def get_file(self, name='foo'):
882
 
        return WeaveFile(name, get_transport(self.get_url('.')), create=True,
883
 
            get_scope=self.get_transaction)
 
815
        return WeaveFile(name, get_transport(self.get_url('.')), create=True)
884
816
 
885
817
    def get_file_corrupted_text(self):
886
 
        w = WeaveFile('foo', get_transport(self.get_url('.')), create=True,
887
 
            get_scope=self.get_transaction)
 
818
        w = WeaveFile('foo', get_transport(self.get_url('.')), create=True)
888
819
        w.add_lines('v1', [], ['hello\n'])
889
820
        w.add_lines('v2', ['v1'], ['hello\n', 'there\n'])
890
 
 
 
821
        
891
822
        # We are going to invasively corrupt the text
892
823
        # Make sure the internals of weave are the same
893
824
        self.assertEqual([('{', 0)
897
828
                        , 'there\n'
898
829
                        , ('}', None)
899
830
                        ], w._weave)
900
 
 
 
831
        
901
832
        self.assertEqual(['f572d396fae9206628714fb2ce00f72e94f2258f'
902
833
                        , '90f265c6e75f1c8f9ab76dcf85528352c5f215ef'
903
834
                        ], w._sha1s)
904
835
        w.check()
905
 
 
 
836
        
906
837
        # Corrupted
907
838
        w._weave[4] = 'There\n'
908
839
        return w
912
843
        # Corrected
913
844
        w._weave[4] = 'there\n'
914
845
        self.assertEqual('hello\nthere\n', w.get_text('v2'))
915
 
 
 
846
        
916
847
        #Invalid checksum, first digit changed
917
848
        w._sha1s[1] =  'f0f265c6e75f1c8f9ab76dcf85528352c5f215ef'
918
849
        return w
919
850
 
920
851
    def reopen_file(self, name='foo', create=False):
921
 
        return WeaveFile(name, get_transport(self.get_url('.')), create=create,
922
 
            get_scope=self.get_transaction)
 
852
        return WeaveFile(name, get_transport(self.get_url('.')), create=create)
923
853
 
924
854
    def test_no_implicit_create(self):
925
855
        self.assertRaises(errors.NoSuchFile,
926
856
                          WeaveFile,
927
857
                          'foo',
928
 
                          get_transport(self.get_url('.')),
929
 
                          get_scope=self.get_transaction)
 
858
                          get_transport(self.get_url('.')))
930
859
 
931
860
    def get_factory(self):
932
861
        return WeaveFile
933
862
 
934
863
 
935
 
class TestPlanMergeVersionedFile(TestCaseWithMemoryTransport):
936
 
 
937
 
    def setUp(self):
938
 
        TestCaseWithMemoryTransport.setUp(self)
939
 
        mapper = PrefixMapper()
940
 
        factory = make_file_factory(True, mapper)
941
 
        self.vf1 = factory(self.get_transport('root-1'))
942
 
        self.vf2 = factory(self.get_transport('root-2'))
943
 
        self.plan_merge_vf = versionedfile._PlanMergeVersionedFile('root')
944
 
        self.plan_merge_vf.fallback_versionedfiles.extend([self.vf1, self.vf2])
945
 
 
946
 
    def test_add_lines(self):
947
 
        self.plan_merge_vf.add_lines(('root', 'a:'), [], [])
948
 
        self.assertRaises(ValueError, self.plan_merge_vf.add_lines,
949
 
            ('root', 'a'), [], [])
950
 
        self.assertRaises(ValueError, self.plan_merge_vf.add_lines,
951
 
            ('root', 'a:'), None, [])
952
 
        self.assertRaises(ValueError, self.plan_merge_vf.add_lines,
953
 
            ('root', 'a:'), [], None)
954
 
 
955
 
    def setup_abcde(self):
956
 
        self.vf1.add_lines(('root', 'A'), [], ['a'])
957
 
        self.vf1.add_lines(('root', 'B'), [('root', 'A')], ['b'])
958
 
        self.vf2.add_lines(('root', 'C'), [], ['c'])
959
 
        self.vf2.add_lines(('root', 'D'), [('root', 'C')], ['d'])
960
 
        self.plan_merge_vf.add_lines(('root', 'E:'),
961
 
            [('root', 'B'), ('root', 'D')], ['e'])
962
 
 
963
 
    def test_get_parents(self):
964
 
        self.setup_abcde()
965
 
        self.assertEqual({('root', 'B'):(('root', 'A'),)},
966
 
            self.plan_merge_vf.get_parent_map([('root', 'B')]))
967
 
        self.assertEqual({('root', 'D'):(('root', 'C'),)},
968
 
            self.plan_merge_vf.get_parent_map([('root', 'D')]))
969
 
        self.assertEqual({('root', 'E:'):(('root', 'B'),('root', 'D'))},
970
 
            self.plan_merge_vf.get_parent_map([('root', 'E:')]))
971
 
        self.assertEqual({},
972
 
            self.plan_merge_vf.get_parent_map([('root', 'F')]))
973
 
        self.assertEqual({
974
 
                ('root', 'B'):(('root', 'A'),),
975
 
                ('root', 'D'):(('root', 'C'),),
976
 
                ('root', 'E:'):(('root', 'B'),('root', 'D')),
977
 
                },
978
 
            self.plan_merge_vf.get_parent_map(
979
 
                [('root', 'B'), ('root', 'D'), ('root', 'E:'), ('root', 'F')]))
980
 
 
981
 
    def test_get_record_stream(self):
982
 
        self.setup_abcde()
983
 
        def get_record(suffix):
984
 
            return self.plan_merge_vf.get_record_stream(
985
 
                [('root', suffix)], 'unordered', True).next()
986
 
        self.assertEqual('a', get_record('A').get_bytes_as('fulltext'))
987
 
        self.assertEqual('c', get_record('C').get_bytes_as('fulltext'))
988
 
        self.assertEqual('e', get_record('E:').get_bytes_as('fulltext'))
989
 
        self.assertEqual('absent', get_record('F').storage_kind)
 
864
class TestKnit(TestCaseWithTransport, VersionedFileTestMixIn):
 
865
 
 
866
    def get_file(self, name='foo'):
 
867
        return KnitVersionedFile(name, get_transport(self.get_url('.')),
 
868
                                 delta=True, create=True)
 
869
 
 
870
    def get_factory(self):
 
871
        return KnitVersionedFile
 
872
 
 
873
    def get_file_corrupted_text(self):
 
874
        knit = self.get_file()
 
875
        knit.add_lines('v1', [], ['hello\n'])
 
876
        knit.add_lines('v2', ['v1'], ['hello\n', 'there\n'])
 
877
        return knit
 
878
 
 
879
    def reopen_file(self, name='foo', create=False):
 
880
        return KnitVersionedFile(name, get_transport(self.get_url('.')),
 
881
            delta=True,
 
882
            create=create)
 
883
 
 
884
    def test_detection(self):
 
885
        knit = self.get_file()
 
886
        knit.check()
 
887
 
 
888
    def test_no_implicit_create(self):
 
889
        self.assertRaises(errors.NoSuchFile,
 
890
                          KnitVersionedFile,
 
891
                          'foo',
 
892
                          get_transport(self.get_url('.')))
 
893
 
 
894
 
 
895
class InterString(versionedfile.InterVersionedFile):
 
896
    """An inter-versionedfile optimised code path for strings.
 
897
 
 
898
    This is for use during testing where we use strings as versionedfiles
 
899
    so that none of the default regsitered interversionedfile classes will
 
900
    match - which lets us test the match logic.
 
901
    """
 
902
 
 
903
    @staticmethod
 
904
    def is_compatible(source, target):
 
905
        """InterString is compatible with strings-as-versionedfiles."""
 
906
        return isinstance(source, str) and isinstance(target, str)
 
907
 
 
908
 
 
909
# TODO this and the InterRepository core logic should be consolidatable
 
910
# if we make the registry a separate class though we still need to 
 
911
# test the behaviour in the active registry to catch failure-to-handle-
 
912
# stange-objects
 
913
class TestInterVersionedFile(TestCaseWithTransport):
 
914
 
 
915
    def test_get_default_inter_versionedfile(self):
 
916
        # test that the InterVersionedFile.get(a, b) probes
 
917
        # for a class where is_compatible(a, b) returns
 
918
        # true and returns a default interversionedfile otherwise.
 
919
        # This also tests that the default registered optimised interversionedfile
 
920
        # classes do not barf inappropriately when a surprising versionedfile type
 
921
        # is handed to them.
 
922
        dummy_a = "VersionedFile 1."
 
923
        dummy_b = "VersionedFile 2."
 
924
        self.assertGetsDefaultInterVersionedFile(dummy_a, dummy_b)
 
925
 
 
926
    def assertGetsDefaultInterVersionedFile(self, a, b):
 
927
        """Asserts that InterVersionedFile.get(a, b) -> the default."""
 
928
        inter = versionedfile.InterVersionedFile.get(a, b)
 
929
        self.assertEqual(versionedfile.InterVersionedFile,
 
930
                         inter.__class__)
 
931
        self.assertEqual(a, inter.source)
 
932
        self.assertEqual(b, inter.target)
 
933
 
 
934
    def test_register_inter_versionedfile_class(self):
 
935
        # test that a optimised code path provider - a
 
936
        # InterVersionedFile subclass can be registered and unregistered
 
937
        # and that it is correctly selected when given a versionedfile
 
938
        # pair that it returns true on for the is_compatible static method
 
939
        # check
 
940
        dummy_a = "VersionedFile 1."
 
941
        dummy_b = "VersionedFile 2."
 
942
        versionedfile.InterVersionedFile.register_optimiser(InterString)
 
943
        try:
 
944
            # we should get the default for something InterString returns False
 
945
            # to
 
946
            self.assertFalse(InterString.is_compatible(dummy_a, None))
 
947
            self.assertGetsDefaultInterVersionedFile(dummy_a, None)
 
948
            # and we should get an InterString for a pair it 'likes'
 
949
            self.assertTrue(InterString.is_compatible(dummy_a, dummy_b))
 
950
            inter = versionedfile.InterVersionedFile.get(dummy_a, dummy_b)
 
951
            self.assertEqual(InterString, inter.__class__)
 
952
            self.assertEqual(dummy_a, inter.source)
 
953
            self.assertEqual(dummy_b, inter.target)
 
954
        finally:
 
955
            versionedfile.InterVersionedFile.unregister_optimiser(InterString)
 
956
        # now we should get the default InterVersionedFile object again.
 
957
        self.assertGetsDefaultInterVersionedFile(dummy_a, dummy_b)
990
958
 
991
959
 
992
960
class TestReadonlyHttpMixin(object):
993
961
 
994
 
    def get_transaction(self):
995
 
        return 1
996
 
 
997
962
    def test_readonly_http_works(self):
998
963
        # we should be able to read from http with a versioned file.
999
964
        vf = self.get_file()
1012
977
class TestWeaveHTTP(TestCaseWithWebserver, TestReadonlyHttpMixin):
1013
978
 
1014
979
    def get_file(self):
1015
 
        return WeaveFile('foo', get_transport(self.get_url('.')), create=True,
1016
 
            get_scope=self.get_transaction)
 
980
        return WeaveFile('foo', get_transport(self.get_url('.')), create=True)
1017
981
 
1018
982
    def get_factory(self):
1019
983
        return WeaveFile
1020
984
 
1021
985
 
 
986
class TestKnitHTTP(TestCaseWithWebserver, TestReadonlyHttpMixin):
 
987
 
 
988
    def get_file(self):
 
989
        return KnitVersionedFile('foo', get_transport(self.get_url('.')),
 
990
                                 delta=True, create=True)
 
991
 
 
992
    def get_factory(self):
 
993
        return KnitVersionedFile
 
994
 
 
995
 
1022
996
class MergeCasesMixin(object):
1023
997
 
1024
998
    def doMerge(self, base, a, b, mp):
1027
1001
 
1028
1002
        def addcrlf(x):
1029
1003
            return x + '\n'
1030
 
 
 
1004
        
1031
1005
        w = self.get_file()
1032
1006
        w.add_lines('text0', [], map(addcrlf, base))
1033
1007
        w.add_lines('text1', ['text0'], map(addcrlf, a))
1049
1023
 
1050
1024
        mp = map(addcrlf, mp)
1051
1025
        self.assertEqual(mt.readlines(), mp)
1052
 
 
1053
 
 
 
1026
        
 
1027
        
1054
1028
    def testOneInsert(self):
1055
1029
        self.doMerge([],
1056
1030
                     ['aa'],
1074
1048
                     ['aaa', 'xxx', 'yyy', 'bbb'],
1075
1049
                     ['aaa', 'xxx', 'bbb'], self.overlappedInsertExpected)
1076
1050
 
1077
 
        # really it ought to reduce this to
 
1051
        # really it ought to reduce this to 
1078
1052
        # ['aaa', 'xxx', 'yyy', 'bbb']
1079
1053
 
1080
1054
 
1082
1056
        self.doMerge(['aaa'],
1083
1057
                     ['xxx'],
1084
1058
                     ['yyy', 'zzz'],
1085
 
                     ['<<<<<<< ', 'xxx', '=======', 'yyy', 'zzz',
 
1059
                     ['<<<<<<< ', 'xxx', '=======', 'yyy', 'zzz', 
1086
1060
                      '>>>>>>> '])
1087
1061
 
1088
1062
    def testNonClashInsert1(self):
1089
1063
        self.doMerge(['aaa'],
1090
1064
                     ['xxx', 'aaa'],
1091
1065
                     ['yyy', 'zzz'],
1092
 
                     ['<<<<<<< ', 'xxx', 'aaa', '=======', 'yyy', 'zzz',
 
1066
                     ['<<<<<<< ', 'xxx', 'aaa', '=======', 'yyy', 'zzz', 
1093
1067
                      '>>>>>>> '])
1094
1068
 
1095
1069
    def testNonClashInsert2(self):
1109
1083
        #######################################
1110
1084
        # skippd, not working yet
1111
1085
        return
1112
 
 
 
1086
        
1113
1087
        self.doMerge(['aaa', 'bbb', 'ccc'],
1114
1088
                     ['aaa', 'ddd', 'ccc'],
1115
1089
                     ['aaa', 'ccc'],
1158
1132
    def test_deletion_overlap(self):
1159
1133
        """Delete overlapping regions with no other conflict.
1160
1134
 
1161
 
        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 
1162
1136
        conflict, but for now conflict is safer.
1163
1137
        """
1164
1138
        base = """\
1180
1154
            """
1181
1155
        result = """\
1182
1156
            start context
1183
 
<<<<<<<\x20
 
1157
<<<<<<< 
1184
1158
            int a() {}
1185
1159
=======
1186
1160
            int c() {}
1187
 
>>>>>>>\x20
 
1161
>>>>>>> 
1188
1162
            end context
1189
1163
            """
1190
1164
        self._test_merge_from_strings(base, a, b, result)
1216
1190
 
1217
1191
    def test_sync_on_deletion(self):
1218
1192
        """Specific case of merge where we can synchronize incorrectly.
1219
 
 
 
1193
        
1220
1194
        A previous version of the weave merge concluded that the two versions
1221
1195
        agreed on deleting line 2, and this could be a synchronization point.
1222
 
        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 
1223
1197
        both sides.
1224
1198
 
1225
1199
        It's better to consider the whole thing as a disagreement region.
1244
1218
            """
1245
1219
        result = """\
1246
1220
            start context
1247
 
<<<<<<<\x20
 
1221
<<<<<<< 
1248
1222
            base line 1
1249
1223
            a's replacement line 2
1250
1224
=======
1251
1225
            b replaces
1252
1226
            both lines
1253
 
>>>>>>>\x20
 
1227
>>>>>>> 
1254
1228
            end context
1255
1229
            """
1256
1230
        self._test_merge_from_strings(base, a, b, result)
1257
1231
 
1258
1232
 
1259
 
class TestWeaveMerge(TestCaseWithMemoryTransport, MergeCasesMixin):
 
1233
class TestKnitMerge(TestCaseWithTransport, MergeCasesMixin):
 
1234
 
 
1235
    def get_file(self, name='foo'):
 
1236
        return KnitVersionedFile(name, get_transport(self.get_url('.')),
 
1237
                                 delta=True, create=True)
 
1238
 
 
1239
    def log_contents(self, w):
 
1240
        pass
 
1241
 
 
1242
 
 
1243
class TestWeaveMerge(TestCaseWithTransport, MergeCasesMixin):
1260
1244
 
1261
1245
    def get_file(self, name='foo'):
1262
1246
        return WeaveFile(name, get_transport(self.get_url('.')), create=True)
1267
1251
        write_weave(w, tmpf)
1268
1252
        self.log(tmpf.getvalue())
1269
1253
 
1270
 
    overlappedInsertExpected = ['aaa', '<<<<<<< ', 'xxx', 'yyy', '=======',
 
1254
    overlappedInsertExpected = ['aaa', '<<<<<<< ', 'xxx', 'yyy', '=======', 
1271
1255
                                'xxx', '>>>>>>> ', 'bbb']
1272
 
 
1273
 
 
1274
 
class TestContentFactoryAdaption(TestCaseWithMemoryTransport):
1275
 
 
1276
 
    def test_select_adaptor(self):
1277
 
        """Test expected adapters exist."""
1278
 
        # One scenario for each lookup combination we expect to use.
1279
 
        # Each is source_kind, requested_kind, adapter class
1280
 
        scenarios = [
1281
 
            ('knit-delta-gz', 'fulltext', _mod_knit.DeltaPlainToFullText),
1282
 
            ('knit-ft-gz', 'fulltext', _mod_knit.FTPlainToFullText),
1283
 
            ('knit-annotated-delta-gz', 'knit-delta-gz',
1284
 
                _mod_knit.DeltaAnnotatedToUnannotated),
1285
 
            ('knit-annotated-delta-gz', 'fulltext',
1286
 
                _mod_knit.DeltaAnnotatedToFullText),
1287
 
            ('knit-annotated-ft-gz', 'knit-ft-gz',
1288
 
                _mod_knit.FTAnnotatedToUnannotated),
1289
 
            ('knit-annotated-ft-gz', 'fulltext',
1290
 
                _mod_knit.FTAnnotatedToFullText),
1291
 
            ]
1292
 
        for source, requested, klass in scenarios:
1293
 
            adapter_factory = versionedfile.adapter_registry.get(
1294
 
                (source, requested))
1295
 
            adapter = adapter_factory(None)
1296
 
            self.assertIsInstance(adapter, klass)
1297
 
 
1298
 
    def get_knit(self, annotated=True):
1299
 
        mapper = ConstantMapper('knit')
1300
 
        transport = self.get_transport()
1301
 
        return make_file_factory(annotated, mapper)(transport)
1302
 
 
1303
 
    def helpGetBytes(self, f, ft_adapter, delta_adapter):
1304
 
        """Grab the interested adapted texts for tests."""
1305
 
        # origin is a fulltext
1306
 
        entries = f.get_record_stream([('origin',)], 'unordered', False)
1307
 
        base = entries.next()
1308
 
        ft_data = ft_adapter.get_bytes(base)
1309
 
        # merged is both a delta and multiple parents.
1310
 
        entries = f.get_record_stream([('merged',)], 'unordered', False)
1311
 
        merged = entries.next()
1312
 
        delta_data = delta_adapter.get_bytes(merged)
1313
 
        return ft_data, delta_data
1314
 
 
1315
 
    def test_deannotation_noeol(self):
1316
 
        """Test converting annotated knits to unannotated knits."""
1317
 
        # we need a full text, and a delta
1318
 
        f = self.get_knit()
1319
 
        get_diamond_files(f, 1, trailing_eol=False)
1320
 
        ft_data, delta_data = self.helpGetBytes(f,
1321
 
            _mod_knit.FTAnnotatedToUnannotated(None),
1322
 
            _mod_knit.DeltaAnnotatedToUnannotated(None))
1323
 
        self.assertEqual(
1324
 
            'version origin 1 b284f94827db1fa2970d9e2014f080413b547a7e\n'
1325
 
            'origin\n'
1326
 
            'end origin\n',
1327
 
            GzipFile(mode='rb', fileobj=StringIO(ft_data)).read())
1328
 
        self.assertEqual(
1329
 
            'version merged 4 32c2e79763b3f90e8ccde37f9710b6629c25a796\n'
1330
 
            '1,2,3\nleft\nright\nmerged\nend merged\n',
1331
 
            GzipFile(mode='rb', fileobj=StringIO(delta_data)).read())
1332
 
 
1333
 
    def test_deannotation(self):
1334
 
        """Test converting annotated knits to unannotated knits."""
1335
 
        # we need a full text, and a delta
1336
 
        f = self.get_knit()
1337
 
        get_diamond_files(f, 1)
1338
 
        ft_data, delta_data = self.helpGetBytes(f,
1339
 
            _mod_knit.FTAnnotatedToUnannotated(None),
1340
 
            _mod_knit.DeltaAnnotatedToUnannotated(None))
1341
 
        self.assertEqual(
1342
 
            'version origin 1 00e364d235126be43292ab09cb4686cf703ddc17\n'
1343
 
            'origin\n'
1344
 
            'end origin\n',
1345
 
            GzipFile(mode='rb', fileobj=StringIO(ft_data)).read())
1346
 
        self.assertEqual(
1347
 
            'version merged 3 ed8bce375198ea62444dc71952b22cfc2b09226d\n'
1348
 
            '2,2,2\nright\nmerged\nend merged\n',
1349
 
            GzipFile(mode='rb', fileobj=StringIO(delta_data)).read())
1350
 
 
1351
 
    def test_annotated_to_fulltext_no_eol(self):
1352
 
        """Test adapting annotated knits to full texts (for -> weaves)."""
1353
 
        # we need a full text, and a delta
1354
 
        f = self.get_knit()
1355
 
        get_diamond_files(f, 1, trailing_eol=False)
1356
 
        # Reconstructing a full text requires a backing versioned file, and it
1357
 
        # must have the base lines requested from it.
1358
 
        logged_vf = versionedfile.RecordingVersionedFilesDecorator(f)
1359
 
        ft_data, delta_data = self.helpGetBytes(f,
1360
 
            _mod_knit.FTAnnotatedToFullText(None),
1361
 
            _mod_knit.DeltaAnnotatedToFullText(logged_vf))
1362
 
        self.assertEqual('origin', ft_data)
1363
 
        self.assertEqual('base\nleft\nright\nmerged', delta_data)
1364
 
        self.assertEqual([('get_record_stream', [('left',)], 'unordered',
1365
 
            True)], logged_vf.calls)
1366
 
 
1367
 
    def test_annotated_to_fulltext(self):
1368
 
        """Test adapting annotated knits to full texts (for -> weaves)."""
1369
 
        # we need a full text, and a delta
1370
 
        f = self.get_knit()
1371
 
        get_diamond_files(f, 1)
1372
 
        # Reconstructing a full text requires a backing versioned file, and it
1373
 
        # must have the base lines requested from it.
1374
 
        logged_vf = versionedfile.RecordingVersionedFilesDecorator(f)
1375
 
        ft_data, delta_data = self.helpGetBytes(f,
1376
 
            _mod_knit.FTAnnotatedToFullText(None),
1377
 
            _mod_knit.DeltaAnnotatedToFullText(logged_vf))
1378
 
        self.assertEqual('origin\n', ft_data)
1379
 
        self.assertEqual('base\nleft\nright\nmerged\n', delta_data)
1380
 
        self.assertEqual([('get_record_stream', [('left',)], 'unordered',
1381
 
            True)], logged_vf.calls)
1382
 
 
1383
 
    def test_unannotated_to_fulltext(self):
1384
 
        """Test adapting unannotated knits to full texts.
1385
 
 
1386
 
        This is used for -> weaves, and for -> annotated knits.
1387
 
        """
1388
 
        # we need a full text, and a delta
1389
 
        f = self.get_knit(annotated=False)
1390
 
        get_diamond_files(f, 1)
1391
 
        # Reconstructing a full text requires a backing versioned file, and it
1392
 
        # must have the base lines requested from it.
1393
 
        logged_vf = versionedfile.RecordingVersionedFilesDecorator(f)
1394
 
        ft_data, delta_data = self.helpGetBytes(f,
1395
 
            _mod_knit.FTPlainToFullText(None),
1396
 
            _mod_knit.DeltaPlainToFullText(logged_vf))
1397
 
        self.assertEqual('origin\n', ft_data)
1398
 
        self.assertEqual('base\nleft\nright\nmerged\n', delta_data)
1399
 
        self.assertEqual([('get_record_stream', [('left',)], 'unordered',
1400
 
            True)], logged_vf.calls)
1401
 
 
1402
 
    def test_unannotated_to_fulltext_no_eol(self):
1403
 
        """Test adapting unannotated knits to full texts.
1404
 
 
1405
 
        This is used for -> weaves, and for -> annotated knits.
1406
 
        """
1407
 
        # we need a full text, and a delta
1408
 
        f = self.get_knit(annotated=False)
1409
 
        get_diamond_files(f, 1, trailing_eol=False)
1410
 
        # Reconstructing a full text requires a backing versioned file, and it
1411
 
        # must have the base lines requested from it.
1412
 
        logged_vf = versionedfile.RecordingVersionedFilesDecorator(f)
1413
 
        ft_data, delta_data = self.helpGetBytes(f,
1414
 
            _mod_knit.FTPlainToFullText(None),
1415
 
            _mod_knit.DeltaPlainToFullText(logged_vf))
1416
 
        self.assertEqual('origin', ft_data)
1417
 
        self.assertEqual('base\nleft\nright\nmerged', delta_data)
1418
 
        self.assertEqual([('get_record_stream', [('left',)], 'unordered',
1419
 
            True)], logged_vf.calls)
1420
 
 
1421
 
 
1422
 
class TestKeyMapper(TestCaseWithMemoryTransport):
1423
 
    """Tests for various key mapping logic."""
1424
 
 
1425
 
    def test_identity_mapper(self):
1426
 
        mapper = versionedfile.ConstantMapper("inventory")
1427
 
        self.assertEqual("inventory", mapper.map(('foo@ar',)))
1428
 
        self.assertEqual("inventory", mapper.map(('quux',)))
1429
 
 
1430
 
    def test_prefix_mapper(self):
1431
 
        #format5: plain
1432
 
        mapper = versionedfile.PrefixMapper()
1433
 
        self.assertEqual("file-id", mapper.map(("file-id", "revision-id")))
1434
 
        self.assertEqual("new-id", mapper.map(("new-id", "revision-id")))
1435
 
        self.assertEqual(('file-id',), mapper.unmap("file-id"))
1436
 
        self.assertEqual(('new-id',), mapper.unmap("new-id"))
1437
 
 
1438
 
    def test_hash_prefix_mapper(self):
1439
 
        #format6: hash + plain
1440
 
        mapper = versionedfile.HashPrefixMapper()
1441
 
        self.assertEqual("9b/file-id", mapper.map(("file-id", "revision-id")))
1442
 
        self.assertEqual("45/new-id", mapper.map(("new-id", "revision-id")))
1443
 
        self.assertEqual(('file-id',), mapper.unmap("9b/file-id"))
1444
 
        self.assertEqual(('new-id',), mapper.unmap("45/new-id"))
1445
 
 
1446
 
    def test_hash_escaped_mapper(self):
1447
 
        #knit1: hash + escaped
1448
 
        mapper = versionedfile.HashEscapedPrefixMapper()
1449
 
        self.assertEqual("88/%2520", mapper.map((" ", "revision-id")))
1450
 
        self.assertEqual("ed/fil%2545-%2549d", mapper.map(("filE-Id",
1451
 
            "revision-id")))
1452
 
        self.assertEqual("88/ne%2557-%2549d", mapper.map(("neW-Id",
1453
 
            "revision-id")))
1454
 
        self.assertEqual(('filE-Id',), mapper.unmap("ed/fil%2545-%2549d"))
1455
 
        self.assertEqual(('neW-Id',), mapper.unmap("88/ne%2557-%2549d"))
1456
 
 
1457
 
 
1458
 
class TestVersionedFiles(TestCaseWithMemoryTransport):
1459
 
    """Tests for the multiple-file variant of VersionedFile."""
1460
 
 
1461
 
    def get_versionedfiles(self, relpath='files'):
1462
 
        transport = self.get_transport(relpath)
1463
 
        if relpath != '.':
1464
 
            transport.mkdir('.')
1465
 
        files = self.factory(transport)
1466
 
        if self.cleanup is not None:
1467
 
            self.addCleanup(lambda:self.cleanup(files))
1468
 
        return files
1469
 
 
1470
 
    def test_annotate(self):
1471
 
        files = self.get_versionedfiles()
1472
 
        self.get_diamond_files(files)
1473
 
        if self.key_length == 1:
1474
 
            prefix = ()
1475
 
        else:
1476
 
            prefix = ('FileA',)
1477
 
        # introduced full text
1478
 
        origins = files.annotate(prefix + ('origin',))
1479
 
        self.assertEqual([
1480
 
            (prefix + ('origin',), 'origin\n')],
1481
 
            origins)
1482
 
        # a delta
1483
 
        origins = files.annotate(prefix + ('base',))
1484
 
        self.assertEqual([
1485
 
            (prefix + ('base',), 'base\n')],
1486
 
            origins)
1487
 
        # a merge
1488
 
        origins = files.annotate(prefix + ('merged',))
1489
 
        if self.graph:
1490
 
            self.assertEqual([
1491
 
                (prefix + ('base',), 'base\n'),
1492
 
                (prefix + ('left',), 'left\n'),
1493
 
                (prefix + ('right',), 'right\n'),
1494
 
                (prefix + ('merged',), 'merged\n')
1495
 
                ],
1496
 
                origins)
1497
 
        else:
1498
 
            # Without a graph everything is new.
1499
 
            self.assertEqual([
1500
 
                (prefix + ('merged',), 'base\n'),
1501
 
                (prefix + ('merged',), 'left\n'),
1502
 
                (prefix + ('merged',), 'right\n'),
1503
 
                (prefix + ('merged',), 'merged\n')
1504
 
                ],
1505
 
                origins)
1506
 
        self.assertRaises(RevisionNotPresent,
1507
 
            files.annotate, prefix + ('missing-key',))
1508
 
 
1509
 
    def test_construct(self):
1510
 
        """Each parameterised test can be constructed on a transport."""
1511
 
        files = self.get_versionedfiles()
1512
 
 
1513
 
    def get_diamond_files(self, files, trailing_eol=True, left_only=False,
1514
 
        nokeys=False):
1515
 
        return get_diamond_files(files, self.key_length,
1516
 
            trailing_eol=trailing_eol, nograph=not self.graph,
1517
 
            left_only=left_only, nokeys=nokeys)
1518
 
 
1519
 
    def test_add_lines_nostoresha(self):
1520
 
        """When nostore_sha is supplied using old content raises."""
1521
 
        vf = self.get_versionedfiles()
1522
 
        empty_text = ('a', [])
1523
 
        sample_text_nl = ('b', ["foo\n", "bar\n"])
1524
 
        sample_text_no_nl = ('c', ["foo\n", "bar"])
1525
 
        shas = []
1526
 
        for version, lines in (empty_text, sample_text_nl, sample_text_no_nl):
1527
 
            sha, _, _ = vf.add_lines(self.get_simple_key(version), [], lines)
1528
 
            shas.append(sha)
1529
 
        # we now have a copy of all the lines in the vf.
1530
 
        for sha, (version, lines) in zip(
1531
 
            shas, (empty_text, sample_text_nl, sample_text_no_nl)):
1532
 
            new_key = self.get_simple_key(version + "2")
1533
 
            self.assertRaises(errors.ExistingContent,
1534
 
                vf.add_lines, new_key, [], lines,
1535
 
                nostore_sha=sha)
1536
 
            # and no new version should have been added.
1537
 
            record = vf.get_record_stream([new_key], 'unordered', True).next()
1538
 
            self.assertEqual('absent', record.storage_kind)
1539
 
 
1540
 
    def test_add_lines_return(self):
1541
 
        files = self.get_versionedfiles()
1542
 
        # save code by using the stock data insertion helper.
1543
 
        adds = self.get_diamond_files(files)
1544
 
        results = []
1545
 
        # We can only validate the first 2 elements returned from add_lines.
1546
 
        for add in adds:
1547
 
            self.assertEqual(3, len(add))
1548
 
            results.append(add[:2])
1549
 
        if self.key_length == 1:
1550
 
            self.assertEqual([
1551
 
                ('00e364d235126be43292ab09cb4686cf703ddc17', 7),
1552
 
                ('51c64a6f4fc375daf0d24aafbabe4d91b6f4bb44', 5),
1553
 
                ('a8478686da38e370e32e42e8a0c220e33ee9132f', 10),
1554
 
                ('9ef09dfa9d86780bdec9219a22560c6ece8e0ef1', 11),
1555
 
                ('ed8bce375198ea62444dc71952b22cfc2b09226d', 23)],
1556
 
                results)
1557
 
        elif self.key_length == 2:
1558
 
            self.assertEqual([
1559
 
                ('00e364d235126be43292ab09cb4686cf703ddc17', 7),
1560
 
                ('00e364d235126be43292ab09cb4686cf703ddc17', 7),
1561
 
                ('51c64a6f4fc375daf0d24aafbabe4d91b6f4bb44', 5),
1562
 
                ('51c64a6f4fc375daf0d24aafbabe4d91b6f4bb44', 5),
1563
 
                ('a8478686da38e370e32e42e8a0c220e33ee9132f', 10),
1564
 
                ('a8478686da38e370e32e42e8a0c220e33ee9132f', 10),
1565
 
                ('9ef09dfa9d86780bdec9219a22560c6ece8e0ef1', 11),
1566
 
                ('9ef09dfa9d86780bdec9219a22560c6ece8e0ef1', 11),
1567
 
                ('ed8bce375198ea62444dc71952b22cfc2b09226d', 23),
1568
 
                ('ed8bce375198ea62444dc71952b22cfc2b09226d', 23)],
1569
 
                results)
1570
 
 
1571
 
    def test_add_lines_no_key_generates_chk_key(self):
1572
 
        files = self.get_versionedfiles()
1573
 
        # save code by using the stock data insertion helper.
1574
 
        adds = self.get_diamond_files(files, nokeys=True)
1575
 
        results = []
1576
 
        # We can only validate the first 2 elements returned from add_lines.
1577
 
        for add in adds:
1578
 
            self.assertEqual(3, len(add))
1579
 
            results.append(add[:2])
1580
 
        if self.key_length == 1:
1581
 
            self.assertEqual([
1582
 
                ('00e364d235126be43292ab09cb4686cf703ddc17', 7),
1583
 
                ('51c64a6f4fc375daf0d24aafbabe4d91b6f4bb44', 5),
1584
 
                ('a8478686da38e370e32e42e8a0c220e33ee9132f', 10),
1585
 
                ('9ef09dfa9d86780bdec9219a22560c6ece8e0ef1', 11),
1586
 
                ('ed8bce375198ea62444dc71952b22cfc2b09226d', 23)],
1587
 
                results)
1588
 
            # Check the added items got CHK keys.
1589
 
            self.assertEqual(set([
1590
 
                ('sha1:00e364d235126be43292ab09cb4686cf703ddc17',),
1591
 
                ('sha1:51c64a6f4fc375daf0d24aafbabe4d91b6f4bb44',),
1592
 
                ('sha1:9ef09dfa9d86780bdec9219a22560c6ece8e0ef1',),
1593
 
                ('sha1:a8478686da38e370e32e42e8a0c220e33ee9132f',),
1594
 
                ('sha1:ed8bce375198ea62444dc71952b22cfc2b09226d',),
1595
 
                ]),
1596
 
                files.keys())
1597
 
        elif self.key_length == 2:
1598
 
            self.assertEqual([
1599
 
                ('00e364d235126be43292ab09cb4686cf703ddc17', 7),
1600
 
                ('00e364d235126be43292ab09cb4686cf703ddc17', 7),
1601
 
                ('51c64a6f4fc375daf0d24aafbabe4d91b6f4bb44', 5),
1602
 
                ('51c64a6f4fc375daf0d24aafbabe4d91b6f4bb44', 5),
1603
 
                ('a8478686da38e370e32e42e8a0c220e33ee9132f', 10),
1604
 
                ('a8478686da38e370e32e42e8a0c220e33ee9132f', 10),
1605
 
                ('9ef09dfa9d86780bdec9219a22560c6ece8e0ef1', 11),
1606
 
                ('9ef09dfa9d86780bdec9219a22560c6ece8e0ef1', 11),
1607
 
                ('ed8bce375198ea62444dc71952b22cfc2b09226d', 23),
1608
 
                ('ed8bce375198ea62444dc71952b22cfc2b09226d', 23)],
1609
 
                results)
1610
 
            # Check the added items got CHK keys.
1611
 
            self.assertEqual(set([
1612
 
                ('FileA', 'sha1:00e364d235126be43292ab09cb4686cf703ddc17'),
1613
 
                ('FileA', 'sha1:51c64a6f4fc375daf0d24aafbabe4d91b6f4bb44'),
1614
 
                ('FileA', 'sha1:9ef09dfa9d86780bdec9219a22560c6ece8e0ef1'),
1615
 
                ('FileA', 'sha1:a8478686da38e370e32e42e8a0c220e33ee9132f'),
1616
 
                ('FileA', 'sha1:ed8bce375198ea62444dc71952b22cfc2b09226d'),
1617
 
                ('FileB', 'sha1:00e364d235126be43292ab09cb4686cf703ddc17'),
1618
 
                ('FileB', 'sha1:51c64a6f4fc375daf0d24aafbabe4d91b6f4bb44'),
1619
 
                ('FileB', 'sha1:9ef09dfa9d86780bdec9219a22560c6ece8e0ef1'),
1620
 
                ('FileB', 'sha1:a8478686da38e370e32e42e8a0c220e33ee9132f'),
1621
 
                ('FileB', 'sha1:ed8bce375198ea62444dc71952b22cfc2b09226d'),
1622
 
                ]),
1623
 
                files.keys())
1624
 
 
1625
 
    def test_empty_lines(self):
1626
 
        """Empty files can be stored."""
1627
 
        f = self.get_versionedfiles()
1628
 
        key_a = self.get_simple_key('a')
1629
 
        f.add_lines(key_a, [], [])
1630
 
        self.assertEqual('',
1631
 
            f.get_record_stream([key_a], 'unordered', True
1632
 
                ).next().get_bytes_as('fulltext'))
1633
 
        key_b = self.get_simple_key('b')
1634
 
        f.add_lines(key_b, self.get_parents([key_a]), [])
1635
 
        self.assertEqual('',
1636
 
            f.get_record_stream([key_b], 'unordered', True
1637
 
                ).next().get_bytes_as('fulltext'))
1638
 
 
1639
 
    def test_newline_only(self):
1640
 
        f = self.get_versionedfiles()
1641
 
        key_a = self.get_simple_key('a')
1642
 
        f.add_lines(key_a, [], ['\n'])
1643
 
        self.assertEqual('\n',
1644
 
            f.get_record_stream([key_a], 'unordered', True
1645
 
                ).next().get_bytes_as('fulltext'))
1646
 
        key_b = self.get_simple_key('b')
1647
 
        f.add_lines(key_b, self.get_parents([key_a]), ['\n'])
1648
 
        self.assertEqual('\n',
1649
 
            f.get_record_stream([key_b], 'unordered', True
1650
 
                ).next().get_bytes_as('fulltext'))
1651
 
 
1652
 
    def test_get_record_stream_empty(self):
1653
 
        """An empty stream can be requested without error."""
1654
 
        f = self.get_versionedfiles()
1655
 
        entries = f.get_record_stream([], 'unordered', False)
1656
 
        self.assertEqual([], list(entries))
1657
 
 
1658
 
    def assertValidStorageKind(self, storage_kind):
1659
 
        """Assert that storage_kind is a valid storage_kind."""
1660
 
        self.assertSubset([storage_kind],
1661
 
            ['mpdiff', 'knit-annotated-ft', 'knit-annotated-delta',
1662
 
             'knit-ft', 'knit-delta', 'chunked', 'fulltext',
1663
 
             'knit-annotated-ft-gz', 'knit-annotated-delta-gz', 'knit-ft-gz',
1664
 
             'knit-delta-gz',
1665
 
             'knit-delta-closure', 'knit-delta-closure-ref',
1666
 
             'groupcompress-block', 'groupcompress-block-ref'])
1667
 
 
1668
 
    def capture_stream(self, f, entries, on_seen, parents):
1669
 
        """Capture a stream for testing."""
1670
 
        for factory in entries:
1671
 
            on_seen(factory.key)
1672
 
            self.assertValidStorageKind(factory.storage_kind)
1673
 
            if factory.sha1 is not None:
1674
 
                self.assertEqual(f.get_sha1s([factory.key])[factory.key],
1675
 
                    factory.sha1)
1676
 
            self.assertEqual(parents[factory.key], factory.parents)
1677
 
            self.assertIsInstance(factory.get_bytes_as(factory.storage_kind),
1678
 
                str)
1679
 
 
1680
 
    def test_get_record_stream_interface(self):
1681
 
        """each item in a stream has to provide a regular interface."""
1682
 
        files = self.get_versionedfiles()
1683
 
        self.get_diamond_files(files)
1684
 
        keys, _ = self.get_keys_and_sort_order()
1685
 
        parent_map = files.get_parent_map(keys)
1686
 
        entries = files.get_record_stream(keys, 'unordered', False)
1687
 
        seen = set()
1688
 
        self.capture_stream(files, entries, seen.add, parent_map)
1689
 
        self.assertEqual(set(keys), seen)
1690
 
 
1691
 
    def get_simple_key(self, suffix):
1692
 
        """Return a key for the object under test."""
1693
 
        if self.key_length == 1:
1694
 
            return (suffix,)
1695
 
        else:
1696
 
            return ('FileA',) + (suffix,)
1697
 
 
1698
 
    def get_keys_and_sort_order(self):
1699
 
        """Get diamond test keys list, and their sort ordering."""
1700
 
        if self.key_length == 1:
1701
 
            keys = [('merged',), ('left',), ('right',), ('base',)]
1702
 
            sort_order = {('merged',):2, ('left',):1, ('right',):1, ('base',):0}
1703
 
        else:
1704
 
            keys = [
1705
 
                ('FileA', 'merged'), ('FileA', 'left'), ('FileA', 'right'),
1706
 
                ('FileA', 'base'),
1707
 
                ('FileB', 'merged'), ('FileB', 'left'), ('FileB', 'right'),
1708
 
                ('FileB', 'base'),
1709
 
                ]
1710
 
            sort_order = {
1711
 
                ('FileA', 'merged'):2, ('FileA', 'left'):1, ('FileA', 'right'):1,
1712
 
                ('FileA', 'base'):0,
1713
 
                ('FileB', 'merged'):2, ('FileB', 'left'):1, ('FileB', 'right'):1,
1714
 
                ('FileB', 'base'):0,
1715
 
                }
1716
 
        return keys, sort_order
1717
 
 
1718
 
    def get_keys_and_groupcompress_sort_order(self):
1719
 
        """Get diamond test keys list, and their groupcompress sort ordering."""
1720
 
        if self.key_length == 1:
1721
 
            keys = [('merged',), ('left',), ('right',), ('base',)]
1722
 
            sort_order = {('merged',):0, ('left',):1, ('right',):1, ('base',):2}
1723
 
        else:
1724
 
            keys = [
1725
 
                ('FileA', 'merged'), ('FileA', 'left'), ('FileA', 'right'),
1726
 
                ('FileA', 'base'),
1727
 
                ('FileB', 'merged'), ('FileB', 'left'), ('FileB', 'right'),
1728
 
                ('FileB', 'base'),
1729
 
                ]
1730
 
            sort_order = {
1731
 
                ('FileA', 'merged'):0, ('FileA', 'left'):1, ('FileA', 'right'):1,
1732
 
                ('FileA', 'base'):2,
1733
 
                ('FileB', 'merged'):3, ('FileB', 'left'):4, ('FileB', 'right'):4,
1734
 
                ('FileB', 'base'):5,
1735
 
                }
1736
 
        return keys, sort_order
1737
 
 
1738
 
    def test_get_record_stream_interface_ordered(self):
1739
 
        """each item in a stream has to provide a regular interface."""
1740
 
        files = self.get_versionedfiles()
1741
 
        self.get_diamond_files(files)
1742
 
        keys, sort_order = self.get_keys_and_sort_order()
1743
 
        parent_map = files.get_parent_map(keys)
1744
 
        entries = files.get_record_stream(keys, 'topological', False)
1745
 
        seen = []
1746
 
        self.capture_stream(files, entries, seen.append, parent_map)
1747
 
        self.assertStreamOrder(sort_order, seen, keys)
1748
 
 
1749
 
    def test_get_record_stream_interface_ordered_with_delta_closure(self):
1750
 
        """each item must be accessible as a fulltext."""
1751
 
        files = self.get_versionedfiles()
1752
 
        self.get_diamond_files(files)
1753
 
        keys, sort_order = self.get_keys_and_sort_order()
1754
 
        parent_map = files.get_parent_map(keys)
1755
 
        entries = files.get_record_stream(keys, 'topological', True)
1756
 
        seen = []
1757
 
        for factory in entries:
1758
 
            seen.append(factory.key)
1759
 
            self.assertValidStorageKind(factory.storage_kind)
1760
 
            self.assertSubset([factory.sha1],
1761
 
                [None, files.get_sha1s([factory.key])[factory.key]])
1762
 
            self.assertEqual(parent_map[factory.key], factory.parents)
1763
 
            # self.assertEqual(files.get_text(factory.key),
1764
 
            ft_bytes = factory.get_bytes_as('fulltext')
1765
 
            self.assertIsInstance(ft_bytes, str)
1766
 
            chunked_bytes = factory.get_bytes_as('chunked')
1767
 
            self.assertEqualDiff(ft_bytes, ''.join(chunked_bytes))
1768
 
 
1769
 
        self.assertStreamOrder(sort_order, seen, keys)
1770
 
 
1771
 
    def test_get_record_stream_interface_groupcompress(self):
1772
 
        """each item in a stream has to provide a regular interface."""
1773
 
        files = self.get_versionedfiles()
1774
 
        self.get_diamond_files(files)
1775
 
        keys, sort_order = self.get_keys_and_groupcompress_sort_order()
1776
 
        parent_map = files.get_parent_map(keys)
1777
 
        entries = files.get_record_stream(keys, 'groupcompress', False)
1778
 
        seen = []
1779
 
        self.capture_stream(files, entries, seen.append, parent_map)
1780
 
        self.assertStreamOrder(sort_order, seen, keys)
1781
 
 
1782
 
    def assertStreamOrder(self, sort_order, seen, keys):
1783
 
        self.assertEqual(len(set(seen)), len(keys))
1784
 
        if self.key_length == 1:
1785
 
            lows = {():0}
1786
 
        else:
1787
 
            lows = {('FileA',):0, ('FileB',):0}
1788
 
        if not self.graph:
1789
 
            self.assertEqual(set(keys), set(seen))
1790
 
        else:
1791
 
            for key in seen:
1792
 
                sort_pos = sort_order[key]
1793
 
                self.assertTrue(sort_pos >= lows[key[:-1]],
1794
 
                    "Out of order in sorted stream: %r, %r" % (key, seen))
1795
 
                lows[key[:-1]] = sort_pos
1796
 
 
1797
 
    def test_get_record_stream_unknown_storage_kind_raises(self):
1798
 
        """Asking for a storage kind that the stream cannot supply raises."""
1799
 
        files = self.get_versionedfiles()
1800
 
        self.get_diamond_files(files)
1801
 
        if self.key_length == 1:
1802
 
            keys = [('merged',), ('left',), ('right',), ('base',)]
1803
 
        else:
1804
 
            keys = [
1805
 
                ('FileA', 'merged'), ('FileA', 'left'), ('FileA', 'right'),
1806
 
                ('FileA', 'base'),
1807
 
                ('FileB', 'merged'), ('FileB', 'left'), ('FileB', 'right'),
1808
 
                ('FileB', 'base'),
1809
 
                ]
1810
 
        parent_map = files.get_parent_map(keys)
1811
 
        entries = files.get_record_stream(keys, 'unordered', False)
1812
 
        # We track the contents because we should be able to try, fail a
1813
 
        # particular kind and then ask for one that works and continue.
1814
 
        seen = set()
1815
 
        for factory in entries:
1816
 
            seen.add(factory.key)
1817
 
            self.assertValidStorageKind(factory.storage_kind)
1818
 
            if factory.sha1 is not None:
1819
 
                self.assertEqual(files.get_sha1s([factory.key])[factory.key],
1820
 
                                 factory.sha1)
1821
 
            self.assertEqual(parent_map[factory.key], factory.parents)
1822
 
            # currently no stream emits mpdiff
1823
 
            self.assertRaises(errors.UnavailableRepresentation,
1824
 
                factory.get_bytes_as, 'mpdiff')
1825
 
            self.assertIsInstance(factory.get_bytes_as(factory.storage_kind),
1826
 
                str)
1827
 
        self.assertEqual(set(keys), seen)
1828
 
 
1829
 
    def test_get_record_stream_missing_records_are_absent(self):
1830
 
        files = self.get_versionedfiles()
1831
 
        self.get_diamond_files(files)
1832
 
        if self.key_length == 1:
1833
 
            keys = [('merged',), ('left',), ('right',), ('absent',), ('base',)]
1834
 
        else:
1835
 
            keys = [
1836
 
                ('FileA', 'merged'), ('FileA', 'left'), ('FileA', 'right'),
1837
 
                ('FileA', 'absent'), ('FileA', 'base'),
1838
 
                ('FileB', 'merged'), ('FileB', 'left'), ('FileB', 'right'),
1839
 
                ('FileB', 'absent'), ('FileB', 'base'),
1840
 
                ('absent', 'absent'),
1841
 
                ]
1842
 
        parent_map = files.get_parent_map(keys)
1843
 
        entries = files.get_record_stream(keys, 'unordered', False)
1844
 
        self.assertAbsentRecord(files, keys, parent_map, entries)
1845
 
        entries = files.get_record_stream(keys, 'topological', False)
1846
 
        self.assertAbsentRecord(files, keys, parent_map, entries)
1847
 
 
1848
 
    def assertRecordHasContent(self, record, bytes):
1849
 
        """Assert that record has the bytes bytes."""
1850
 
        self.assertEqual(bytes, record.get_bytes_as('fulltext'))
1851
 
        self.assertEqual(bytes, ''.join(record.get_bytes_as('chunked')))
1852
 
 
1853
 
    def test_get_record_stream_native_formats_are_wire_ready_one_ft(self):
1854
 
        files = self.get_versionedfiles()
1855
 
        key = self.get_simple_key('foo')
1856
 
        files.add_lines(key, (), ['my text\n', 'content'])
1857
 
        stream = files.get_record_stream([key], 'unordered', False)
1858
 
        record = stream.next()
1859
 
        if record.storage_kind in ('chunked', 'fulltext'):
1860
 
            # chunked and fulltext representations are for direct use not wire
1861
 
            # serialisation: check they are able to be used directly. To send
1862
 
            # such records over the wire translation will be needed.
1863
 
            self.assertRecordHasContent(record, "my text\ncontent")
1864
 
        else:
1865
 
            bytes = [record.get_bytes_as(record.storage_kind)]
1866
 
            network_stream = versionedfile.NetworkRecordStream(bytes).read()
1867
 
            source_record = record
1868
 
            records = []
1869
 
            for record in network_stream:
1870
 
                records.append(record)
1871
 
                self.assertEqual(source_record.storage_kind,
1872
 
                    record.storage_kind)
1873
 
                self.assertEqual(source_record.parents, record.parents)
1874
 
                self.assertEqual(
1875
 
                    source_record.get_bytes_as(source_record.storage_kind),
1876
 
                    record.get_bytes_as(record.storage_kind))
1877
 
            self.assertEqual(1, len(records))
1878
 
 
1879
 
    def assertStreamMetaEqual(self, records, expected, stream):
1880
 
        """Assert that streams expected and stream have the same records.
1881
 
 
1882
 
        :param records: A list to collect the seen records.
1883
 
        :return: A generator of the records in stream.
1884
 
        """
1885
 
        # We make assertions during copying to catch things early for
1886
 
        # easier debugging.
1887
 
        for record, ref_record in izip(stream, expected):
1888
 
            records.append(record)
1889
 
            self.assertEqual(ref_record.key, record.key)
1890
 
            self.assertEqual(ref_record.storage_kind, record.storage_kind)
1891
 
            self.assertEqual(ref_record.parents, record.parents)
1892
 
            yield record
1893
 
 
1894
 
    def stream_to_bytes_or_skip_counter(self, skipped_records, full_texts,
1895
 
        stream):
1896
 
        """Convert a stream to a bytes iterator.
1897
 
 
1898
 
        :param skipped_records: A list with one element to increment when a
1899
 
            record is skipped.
1900
 
        :param full_texts: A dict from key->fulltext representation, for
1901
 
            checking chunked or fulltext stored records.
1902
 
        :param stream: A record_stream.
1903
 
        :return: An iterator over the bytes of each record.
1904
 
        """
1905
 
        for record in stream:
1906
 
            if record.storage_kind in ('chunked', 'fulltext'):
1907
 
                skipped_records[0] += 1
1908
 
                # check the content is correct for direct use.
1909
 
                self.assertRecordHasContent(record, full_texts[record.key])
1910
 
            else:
1911
 
                yield record.get_bytes_as(record.storage_kind)
1912
 
 
1913
 
    def test_get_record_stream_native_formats_are_wire_ready_ft_delta(self):
1914
 
        files = self.get_versionedfiles()
1915
 
        target_files = self.get_versionedfiles('target')
1916
 
        key = self.get_simple_key('ft')
1917
 
        key_delta = self.get_simple_key('delta')
1918
 
        files.add_lines(key, (), ['my text\n', 'content'])
1919
 
        if self.graph:
1920
 
            delta_parents = (key,)
1921
 
        else:
1922
 
            delta_parents = ()
1923
 
        files.add_lines(key_delta, delta_parents, ['different\n', 'content\n'])
1924
 
        local = files.get_record_stream([key, key_delta], 'unordered', False)
1925
 
        ref = files.get_record_stream([key, key_delta], 'unordered', False)
1926
 
        skipped_records = [0]
1927
 
        full_texts = {
1928
 
            key: "my text\ncontent",
1929
 
            key_delta: "different\ncontent\n",
1930
 
            }
1931
 
        byte_stream = self.stream_to_bytes_or_skip_counter(
1932
 
            skipped_records, full_texts, local)
1933
 
        network_stream = versionedfile.NetworkRecordStream(byte_stream).read()
1934
 
        records = []
1935
 
        # insert the stream from the network into a versioned files object so we can
1936
 
        # check the content was carried across correctly without doing delta
1937
 
        # inspection.
1938
 
        target_files.insert_record_stream(
1939
 
            self.assertStreamMetaEqual(records, ref, network_stream))
1940
 
        # No duplicates on the wire thank you!
1941
 
        self.assertEqual(2, len(records) + skipped_records[0])
1942
 
        if len(records):
1943
 
            # if any content was copied it all must have all been.
1944
 
            self.assertIdenticalVersionedFile(files, target_files)
1945
 
 
1946
 
    def test_get_record_stream_native_formats_are_wire_ready_delta(self):
1947
 
        # copy a delta over the wire
1948
 
        files = self.get_versionedfiles()
1949
 
        target_files = self.get_versionedfiles('target')
1950
 
        key = self.get_simple_key('ft')
1951
 
        key_delta = self.get_simple_key('delta')
1952
 
        files.add_lines(key, (), ['my text\n', 'content'])
1953
 
        if self.graph:
1954
 
            delta_parents = (key,)
1955
 
        else:
1956
 
            delta_parents = ()
1957
 
        files.add_lines(key_delta, delta_parents, ['different\n', 'content\n'])
1958
 
        # Copy the basis text across so we can reconstruct the delta during
1959
 
        # insertion into target.
1960
 
        target_files.insert_record_stream(files.get_record_stream([key],
1961
 
            'unordered', False))
1962
 
        local = files.get_record_stream([key_delta], 'unordered', False)
1963
 
        ref = files.get_record_stream([key_delta], 'unordered', False)
1964
 
        skipped_records = [0]
1965
 
        full_texts = {
1966
 
            key_delta: "different\ncontent\n",
1967
 
            }
1968
 
        byte_stream = self.stream_to_bytes_or_skip_counter(
1969
 
            skipped_records, full_texts, local)
1970
 
        network_stream = versionedfile.NetworkRecordStream(byte_stream).read()
1971
 
        records = []
1972
 
        # insert the stream from the network into a versioned files object so we can
1973
 
        # check the content was carried across correctly without doing delta
1974
 
        # inspection during check_stream.
1975
 
        target_files.insert_record_stream(
1976
 
            self.assertStreamMetaEqual(records, ref, network_stream))
1977
 
        # No duplicates on the wire thank you!
1978
 
        self.assertEqual(1, len(records) + skipped_records[0])
1979
 
        if len(records):
1980
 
            # if any content was copied it all must have all been
1981
 
            self.assertIdenticalVersionedFile(files, target_files)
1982
 
 
1983
 
    def test_get_record_stream_wire_ready_delta_closure_included(self):
1984
 
        # copy a delta over the wire with the ability to get its full text.
1985
 
        files = self.get_versionedfiles()
1986
 
        key = self.get_simple_key('ft')
1987
 
        key_delta = self.get_simple_key('delta')
1988
 
        files.add_lines(key, (), ['my text\n', 'content'])
1989
 
        if self.graph:
1990
 
            delta_parents = (key,)
1991
 
        else:
1992
 
            delta_parents = ()
1993
 
        files.add_lines(key_delta, delta_parents, ['different\n', 'content\n'])
1994
 
        local = files.get_record_stream([key_delta], 'unordered', True)
1995
 
        ref = files.get_record_stream([key_delta], 'unordered', True)
1996
 
        skipped_records = [0]
1997
 
        full_texts = {
1998
 
            key_delta: "different\ncontent\n",
1999
 
            }
2000
 
        byte_stream = self.stream_to_bytes_or_skip_counter(
2001
 
            skipped_records, full_texts, local)
2002
 
        network_stream = versionedfile.NetworkRecordStream(byte_stream).read()
2003
 
        records = []
2004
 
        # insert the stream from the network into a versioned files object so we can
2005
 
        # check the content was carried across correctly without doing delta
2006
 
        # inspection during check_stream.
2007
 
        for record in self.assertStreamMetaEqual(records, ref, network_stream):
2008
 
            # we have to be able to get the full text out:
2009
 
            self.assertRecordHasContent(record, full_texts[record.key])
2010
 
        # No duplicates on the wire thank you!
2011
 
        self.assertEqual(1, len(records) + skipped_records[0])
2012
 
 
2013
 
    def assertAbsentRecord(self, files, keys, parents, entries):
2014
 
        """Helper for test_get_record_stream_missing_records_are_absent."""
2015
 
        seen = set()
2016
 
        for factory in entries:
2017
 
            seen.add(factory.key)
2018
 
            if factory.key[-1] == 'absent':
2019
 
                self.assertEqual('absent', factory.storage_kind)
2020
 
                self.assertEqual(None, factory.sha1)
2021
 
                self.assertEqual(None, factory.parents)
2022
 
            else:
2023
 
                self.assertValidStorageKind(factory.storage_kind)
2024
 
                if factory.sha1 is not None:
2025
 
                    sha1 = files.get_sha1s([factory.key])[factory.key]
2026
 
                    self.assertEqual(sha1, factory.sha1)
2027
 
                self.assertEqual(parents[factory.key], factory.parents)
2028
 
                self.assertIsInstance(factory.get_bytes_as(factory.storage_kind),
2029
 
                    str)
2030
 
        self.assertEqual(set(keys), seen)
2031
 
 
2032
 
    def test_filter_absent_records(self):
2033
 
        """Requested missing records can be filter trivially."""
2034
 
        files = self.get_versionedfiles()
2035
 
        self.get_diamond_files(files)
2036
 
        keys, _ = self.get_keys_and_sort_order()
2037
 
        parent_map = files.get_parent_map(keys)
2038
 
        # Add an absent record in the middle of the present keys. (We don't ask
2039
 
        # for just absent keys to ensure that content before and after the
2040
 
        # absent keys is still delivered).
2041
 
        present_keys = list(keys)
2042
 
        if self.key_length == 1:
2043
 
            keys.insert(2, ('extra',))
2044
 
        else:
2045
 
            keys.insert(2, ('extra', 'extra'))
2046
 
        entries = files.get_record_stream(keys, 'unordered', False)
2047
 
        seen = set()
2048
 
        self.capture_stream(files, versionedfile.filter_absent(entries), seen.add,
2049
 
            parent_map)
2050
 
        self.assertEqual(set(present_keys), seen)
2051
 
 
2052
 
    def get_mapper(self):
2053
 
        """Get a mapper suitable for the key length of the test interface."""
2054
 
        if self.key_length == 1:
2055
 
            return ConstantMapper('source')
2056
 
        else:
2057
 
            return HashEscapedPrefixMapper()
2058
 
 
2059
 
    def get_parents(self, parents):
2060
 
        """Get parents, taking self.graph into consideration."""
2061
 
        if self.graph:
2062
 
            return parents
2063
 
        else:
2064
 
            return None
2065
 
 
2066
 
    def test_get_parent_map(self):
2067
 
        files = self.get_versionedfiles()
2068
 
        if self.key_length == 1:
2069
 
            parent_details = [
2070
 
                (('r0',), self.get_parents(())),
2071
 
                (('r1',), self.get_parents((('r0',),))),
2072
 
                (('r2',), self.get_parents(())),
2073
 
                (('r3',), self.get_parents(())),
2074
 
                (('m',), self.get_parents((('r0',),('r1',),('r2',),('r3',)))),
2075
 
                ]
2076
 
        else:
2077
 
            parent_details = [
2078
 
                (('FileA', 'r0'), self.get_parents(())),
2079
 
                (('FileA', 'r1'), self.get_parents((('FileA', 'r0'),))),
2080
 
                (('FileA', 'r2'), self.get_parents(())),
2081
 
                (('FileA', 'r3'), self.get_parents(())),
2082
 
                (('FileA', 'm'), self.get_parents((('FileA', 'r0'),
2083
 
                    ('FileA', 'r1'), ('FileA', 'r2'), ('FileA', 'r3')))),
2084
 
                ]
2085
 
        for key, parents in parent_details:
2086
 
            files.add_lines(key, parents, [])
2087
 
            # immediately after adding it should be queryable.
2088
 
            self.assertEqual({key:parents}, files.get_parent_map([key]))
2089
 
        # We can ask for an empty set
2090
 
        self.assertEqual({}, files.get_parent_map([]))
2091
 
        # We can ask for many keys
2092
 
        all_parents = dict(parent_details)
2093
 
        self.assertEqual(all_parents, files.get_parent_map(all_parents.keys()))
2094
 
        # Absent keys are just not included in the result.
2095
 
        keys = all_parents.keys()
2096
 
        if self.key_length == 1:
2097
 
            keys.insert(1, ('missing',))
2098
 
        else:
2099
 
            keys.insert(1, ('missing', 'missing'))
2100
 
        # Absent keys are just ignored
2101
 
        self.assertEqual(all_parents, files.get_parent_map(keys))
2102
 
 
2103
 
    def test_get_sha1s(self):
2104
 
        files = self.get_versionedfiles()
2105
 
        self.get_diamond_files(files)
2106
 
        if self.key_length == 1:
2107
 
            keys = [('base',), ('origin',), ('left',), ('merged',), ('right',)]
2108
 
        else:
2109
 
            # ask for shas from different prefixes.
2110
 
            keys = [
2111
 
                ('FileA', 'base'), ('FileB', 'origin'), ('FileA', 'left'),
2112
 
                ('FileA', 'merged'), ('FileB', 'right'),
2113
 
                ]
2114
 
        self.assertEqual({
2115
 
            keys[0]: '51c64a6f4fc375daf0d24aafbabe4d91b6f4bb44',
2116
 
            keys[1]: '00e364d235126be43292ab09cb4686cf703ddc17',
2117
 
            keys[2]: 'a8478686da38e370e32e42e8a0c220e33ee9132f',
2118
 
            keys[3]: 'ed8bce375198ea62444dc71952b22cfc2b09226d',
2119
 
            keys[4]: '9ef09dfa9d86780bdec9219a22560c6ece8e0ef1',
2120
 
            },
2121
 
            files.get_sha1s(keys))
2122
 
 
2123
 
    def test_insert_record_stream_empty(self):
2124
 
        """Inserting an empty record stream should work."""
2125
 
        files = self.get_versionedfiles()
2126
 
        files.insert_record_stream([])
2127
 
 
2128
 
    def assertIdenticalVersionedFile(self, expected, actual):
2129
 
        """Assert that left and right have the same contents."""
2130
 
        self.assertEqual(set(actual.keys()), set(expected.keys()))
2131
 
        actual_parents = actual.get_parent_map(actual.keys())
2132
 
        if self.graph:
2133
 
            self.assertEqual(actual_parents, expected.get_parent_map(expected.keys()))
2134
 
        else:
2135
 
            for key, parents in actual_parents.items():
2136
 
                self.assertEqual(None, parents)
2137
 
        for key in actual.keys():
2138
 
            actual_text = actual.get_record_stream(
2139
 
                [key], 'unordered', True).next().get_bytes_as('fulltext')
2140
 
            expected_text = expected.get_record_stream(
2141
 
                [key], 'unordered', True).next().get_bytes_as('fulltext')
2142
 
            self.assertEqual(actual_text, expected_text)
2143
 
 
2144
 
    def test_insert_record_stream_fulltexts(self):
2145
 
        """Any file should accept a stream of fulltexts."""
2146
 
        files = self.get_versionedfiles()
2147
 
        mapper = self.get_mapper()
2148
 
        source_transport = self.get_transport('source')
2149
 
        source_transport.mkdir('.')
2150
 
        # weaves always output fulltexts.
2151
 
        source = make_versioned_files_factory(WeaveFile, mapper)(
2152
 
            source_transport)
2153
 
        self.get_diamond_files(source, trailing_eol=False)
2154
 
        stream = source.get_record_stream(source.keys(), 'topological',
2155
 
            False)
2156
 
        files.insert_record_stream(stream)
2157
 
        self.assertIdenticalVersionedFile(source, files)
2158
 
 
2159
 
    def test_insert_record_stream_fulltexts_noeol(self):
2160
 
        """Any file should accept a stream of fulltexts."""
2161
 
        files = self.get_versionedfiles()
2162
 
        mapper = self.get_mapper()
2163
 
        source_transport = self.get_transport('source')
2164
 
        source_transport.mkdir('.')
2165
 
        # weaves always output fulltexts.
2166
 
        source = make_versioned_files_factory(WeaveFile, mapper)(
2167
 
            source_transport)
2168
 
        self.get_diamond_files(source, trailing_eol=False)
2169
 
        stream = source.get_record_stream(source.keys(), 'topological',
2170
 
            False)
2171
 
        files.insert_record_stream(stream)
2172
 
        self.assertIdenticalVersionedFile(source, files)
2173
 
 
2174
 
    def test_insert_record_stream_annotated_knits(self):
2175
 
        """Any file should accept a stream from plain knits."""
2176
 
        files = self.get_versionedfiles()
2177
 
        mapper = self.get_mapper()
2178
 
        source_transport = self.get_transport('source')
2179
 
        source_transport.mkdir('.')
2180
 
        source = make_file_factory(True, mapper)(source_transport)
2181
 
        self.get_diamond_files(source)
2182
 
        stream = source.get_record_stream(source.keys(), 'topological',
2183
 
            False)
2184
 
        files.insert_record_stream(stream)
2185
 
        self.assertIdenticalVersionedFile(source, files)
2186
 
 
2187
 
    def test_insert_record_stream_annotated_knits_noeol(self):
2188
 
        """Any file should accept a stream from plain knits."""
2189
 
        files = self.get_versionedfiles()
2190
 
        mapper = self.get_mapper()
2191
 
        source_transport = self.get_transport('source')
2192
 
        source_transport.mkdir('.')
2193
 
        source = make_file_factory(True, mapper)(source_transport)
2194
 
        self.get_diamond_files(source, trailing_eol=False)
2195
 
        stream = source.get_record_stream(source.keys(), 'topological',
2196
 
            False)
2197
 
        files.insert_record_stream(stream)
2198
 
        self.assertIdenticalVersionedFile(source, files)
2199
 
 
2200
 
    def test_insert_record_stream_plain_knits(self):
2201
 
        """Any file should accept a stream from plain knits."""
2202
 
        files = self.get_versionedfiles()
2203
 
        mapper = self.get_mapper()
2204
 
        source_transport = self.get_transport('source')
2205
 
        source_transport.mkdir('.')
2206
 
        source = make_file_factory(False, mapper)(source_transport)
2207
 
        self.get_diamond_files(source)
2208
 
        stream = source.get_record_stream(source.keys(), 'topological',
2209
 
            False)
2210
 
        files.insert_record_stream(stream)
2211
 
        self.assertIdenticalVersionedFile(source, files)
2212
 
 
2213
 
    def test_insert_record_stream_plain_knits_noeol(self):
2214
 
        """Any file should accept a stream from plain knits."""
2215
 
        files = self.get_versionedfiles()
2216
 
        mapper = self.get_mapper()
2217
 
        source_transport = self.get_transport('source')
2218
 
        source_transport.mkdir('.')
2219
 
        source = make_file_factory(False, mapper)(source_transport)
2220
 
        self.get_diamond_files(source, trailing_eol=False)
2221
 
        stream = source.get_record_stream(source.keys(), 'topological',
2222
 
            False)
2223
 
        files.insert_record_stream(stream)
2224
 
        self.assertIdenticalVersionedFile(source, files)
2225
 
 
2226
 
    def test_insert_record_stream_existing_keys(self):
2227
 
        """Inserting keys already in a file should not error."""
2228
 
        files = self.get_versionedfiles()
2229
 
        source = self.get_versionedfiles('source')
2230
 
        self.get_diamond_files(source)
2231
 
        # insert some keys into f.
2232
 
        self.get_diamond_files(files, left_only=True)
2233
 
        stream = source.get_record_stream(source.keys(), 'topological',
2234
 
            False)
2235
 
        files.insert_record_stream(stream)
2236
 
        self.assertIdenticalVersionedFile(source, files)
2237
 
 
2238
 
    def test_insert_record_stream_missing_keys(self):
2239
 
        """Inserting a stream with absent keys should raise an error."""
2240
 
        files = self.get_versionedfiles()
2241
 
        source = self.get_versionedfiles('source')
2242
 
        stream = source.get_record_stream([('missing',) * self.key_length],
2243
 
            'topological', False)
2244
 
        self.assertRaises(errors.RevisionNotPresent, files.insert_record_stream,
2245
 
            stream)
2246
 
 
2247
 
    def test_insert_record_stream_out_of_order(self):
2248
 
        """An out of order stream can either error or work."""
2249
 
        files = self.get_versionedfiles()
2250
 
        source = self.get_versionedfiles('source')
2251
 
        self.get_diamond_files(source)
2252
 
        if self.key_length == 1:
2253
 
            origin_keys = [('origin',)]
2254
 
            end_keys = [('merged',), ('left',)]
2255
 
            start_keys = [('right',), ('base',)]
2256
 
        else:
2257
 
            origin_keys = [('FileA', 'origin'), ('FileB', 'origin')]
2258
 
            end_keys = [('FileA', 'merged',), ('FileA', 'left',),
2259
 
                ('FileB', 'merged',), ('FileB', 'left',)]
2260
 
            start_keys = [('FileA', 'right',), ('FileA', 'base',),
2261
 
                ('FileB', 'right',), ('FileB', 'base',)]
2262
 
        origin_entries = source.get_record_stream(origin_keys, 'unordered', False)
2263
 
        end_entries = source.get_record_stream(end_keys, 'topological', False)
2264
 
        start_entries = source.get_record_stream(start_keys, 'topological', False)
2265
 
        entries = chain(origin_entries, end_entries, start_entries)
2266
 
        try:
2267
 
            files.insert_record_stream(entries)
2268
 
        except RevisionNotPresent:
2269
 
            # Must not have corrupted the file.
2270
 
            files.check()
2271
 
        else:
2272
 
            self.assertIdenticalVersionedFile(source, files)
2273
 
 
2274
 
    def get_knit_delta_source(self):
2275
 
        """Get a source that can produce a stream with knit delta records,
2276
 
        regardless of this test's scenario.
2277
 
        """
2278
 
        mapper = self.get_mapper()
2279
 
        source_transport = self.get_transport('source')
2280
 
        source_transport.mkdir('.')
2281
 
        source = make_file_factory(False, mapper)(source_transport)
2282
 
        get_diamond_files(source, self.key_length, trailing_eol=True,
2283
 
            nograph=False, left_only=False)
2284
 
        return source
2285
 
 
2286
 
    def test_insert_record_stream_delta_missing_basis_no_corruption(self):
2287
 
        """Insertion where a needed basis is not included notifies the caller
2288
 
        of the missing basis.  In the meantime a record missing its basis is
2289
 
        not added.
2290
 
        """
2291
 
        source = self.get_knit_delta_source()
2292
 
        keys = [self.get_simple_key('origin'), self.get_simple_key('merged')]
2293
 
        entries = source.get_record_stream(keys, 'unordered', False)
2294
 
        files = self.get_versionedfiles()
2295
 
        if self.support_partial_insertion:
2296
 
            self.assertEqual([],
2297
 
                list(files.get_missing_compression_parent_keys()))
2298
 
            files.insert_record_stream(entries)
2299
 
            missing_bases = files.get_missing_compression_parent_keys()
2300
 
            self.assertEqual(set([self.get_simple_key('left')]),
2301
 
                set(missing_bases))
2302
 
            self.assertEqual(set(keys), set(files.get_parent_map(keys)))
2303
 
        else:
2304
 
            self.assertRaises(
2305
 
                errors.RevisionNotPresent, files.insert_record_stream, entries)
2306
 
            files.check()
2307
 
 
2308
 
    def test_insert_record_stream_delta_missing_basis_can_be_added_later(self):
2309
 
        """Insertion where a needed basis is not included notifies the caller
2310
 
        of the missing basis.  That basis can be added in a second
2311
 
        insert_record_stream call that does not need to repeat records present
2312
 
        in the previous stream.  The record(s) that required that basis are
2313
 
        fully inserted once their basis is no longer missing.
2314
 
        """
2315
 
        if not self.support_partial_insertion:
2316
 
            raise TestNotApplicable(
2317
 
                'versioned file scenario does not support partial insertion')
2318
 
        source = self.get_knit_delta_source()
2319
 
        entries = source.get_record_stream([self.get_simple_key('origin'),
2320
 
            self.get_simple_key('merged')], 'unordered', False)
2321
 
        files = self.get_versionedfiles()
2322
 
        files.insert_record_stream(entries)
2323
 
        missing_bases = files.get_missing_compression_parent_keys()
2324
 
        self.assertEqual(set([self.get_simple_key('left')]),
2325
 
            set(missing_bases))
2326
 
        # 'merged' is inserted (although a commit of a write group involving
2327
 
        # this versionedfiles would fail).
2328
 
        merged_key = self.get_simple_key('merged')
2329
 
        self.assertEqual(
2330
 
            [merged_key], files.get_parent_map([merged_key]).keys())
2331
 
        # Add the full delta closure of the missing records
2332
 
        missing_entries = source.get_record_stream(
2333
 
            missing_bases, 'unordered', True)
2334
 
        files.insert_record_stream(missing_entries)
2335
 
        # Now 'merged' is fully inserted (and a commit would succeed).
2336
 
        self.assertEqual([], list(files.get_missing_compression_parent_keys()))
2337
 
        self.assertEqual(
2338
 
            [merged_key], files.get_parent_map([merged_key]).keys())
2339
 
        files.check()
2340
 
 
2341
 
    def test_iter_lines_added_or_present_in_keys(self):
2342
 
        # test that we get at least an equalset of the lines added by
2343
 
        # versions in the store.
2344
 
        # the ordering here is to make a tree so that dumb searches have
2345
 
        # more changes to muck up.
2346
 
 
2347
 
        class InstrumentedProgress(progress.DummyProgress):
2348
 
 
2349
 
            def __init__(self):
2350
 
 
2351
 
                progress.DummyProgress.__init__(self)
2352
 
                self.updates = []
2353
 
 
2354
 
            def update(self, msg=None, current=None, total=None):
2355
 
                self.updates.append((msg, current, total))
2356
 
 
2357
 
        files = self.get_versionedfiles()
2358
 
        # add a base to get included
2359
 
        files.add_lines(self.get_simple_key('base'), (), ['base\n'])
2360
 
        # add a ancestor to be included on one side
2361
 
        files.add_lines(self.get_simple_key('lancestor'), (), ['lancestor\n'])
2362
 
        # add a ancestor to be included on the other side
2363
 
        files.add_lines(self.get_simple_key('rancestor'),
2364
 
            self.get_parents([self.get_simple_key('base')]), ['rancestor\n'])
2365
 
        # add a child of rancestor with no eofile-nl
2366
 
        files.add_lines(self.get_simple_key('child'),
2367
 
            self.get_parents([self.get_simple_key('rancestor')]),
2368
 
            ['base\n', 'child\n'])
2369
 
        # add a child of lancestor and base to join the two roots
2370
 
        files.add_lines(self.get_simple_key('otherchild'),
2371
 
            self.get_parents([self.get_simple_key('lancestor'),
2372
 
                self.get_simple_key('base')]),
2373
 
            ['base\n', 'lancestor\n', 'otherchild\n'])
2374
 
        def iter_with_keys(keys, expected):
2375
 
            # now we need to see what lines are returned, and how often.
2376
 
            lines = {}
2377
 
            progress = InstrumentedProgress()
2378
 
            # iterate over the lines
2379
 
            for line in files.iter_lines_added_or_present_in_keys(keys,
2380
 
                pb=progress):
2381
 
                lines.setdefault(line, 0)
2382
 
                lines[line] += 1
2383
 
            if []!= progress.updates:
2384
 
                self.assertEqual(expected, progress.updates)
2385
 
            return lines
2386
 
        lines = iter_with_keys(
2387
 
            [self.get_simple_key('child'), self.get_simple_key('otherchild')],
2388
 
            [('Walking content', 0, 2),
2389
 
             ('Walking content', 1, 2),
2390
 
             ('Walking content', 2, 2)])
2391
 
        # we must see child and otherchild
2392
 
        self.assertTrue(lines[('child\n', self.get_simple_key('child'))] > 0)
2393
 
        self.assertTrue(
2394
 
            lines[('otherchild\n', self.get_simple_key('otherchild'))] > 0)
2395
 
        # we dont care if we got more than that.
2396
 
 
2397
 
        # test all lines
2398
 
        lines = iter_with_keys(files.keys(),
2399
 
            [('Walking content', 0, 5),
2400
 
             ('Walking content', 1, 5),
2401
 
             ('Walking content', 2, 5),
2402
 
             ('Walking content', 3, 5),
2403
 
             ('Walking content', 4, 5),
2404
 
             ('Walking content', 5, 5)])
2405
 
        # all lines must be seen at least once
2406
 
        self.assertTrue(lines[('base\n', self.get_simple_key('base'))] > 0)
2407
 
        self.assertTrue(
2408
 
            lines[('lancestor\n', self.get_simple_key('lancestor'))] > 0)
2409
 
        self.assertTrue(
2410
 
            lines[('rancestor\n', self.get_simple_key('rancestor'))] > 0)
2411
 
        self.assertTrue(lines[('child\n', self.get_simple_key('child'))] > 0)
2412
 
        self.assertTrue(
2413
 
            lines[('otherchild\n', self.get_simple_key('otherchild'))] > 0)
2414
 
 
2415
 
    def test_make_mpdiffs(self):
2416
 
        from bzrlib import multiparent
2417
 
        files = self.get_versionedfiles('source')
2418
 
        # add texts that should trip the knit maximum delta chain threshold
2419
 
        # as well as doing parallel chains of data in knits.
2420
 
        # this is done by two chains of 25 insertions
2421
 
        files.add_lines(self.get_simple_key('base'), [], ['line\n'])
2422
 
        files.add_lines(self.get_simple_key('noeol'),
2423
 
            self.get_parents([self.get_simple_key('base')]), ['line'])
2424
 
        # detailed eol tests:
2425
 
        # shared last line with parent no-eol
2426
 
        files.add_lines(self.get_simple_key('noeolsecond'),
2427
 
            self.get_parents([self.get_simple_key('noeol')]),
2428
 
                ['line\n', 'line'])
2429
 
        # differing last line with parent, both no-eol
2430
 
        files.add_lines(self.get_simple_key('noeolnotshared'),
2431
 
            self.get_parents([self.get_simple_key('noeolsecond')]),
2432
 
                ['line\n', 'phone'])
2433
 
        # add eol following a noneol parent, change content
2434
 
        files.add_lines(self.get_simple_key('eol'),
2435
 
            self.get_parents([self.get_simple_key('noeol')]), ['phone\n'])
2436
 
        # add eol following a noneol parent, no change content
2437
 
        files.add_lines(self.get_simple_key('eolline'),
2438
 
            self.get_parents([self.get_simple_key('noeol')]), ['line\n'])
2439
 
        # noeol with no parents:
2440
 
        files.add_lines(self.get_simple_key('noeolbase'), [], ['line'])
2441
 
        # noeol preceeding its leftmost parent in the output:
2442
 
        # this is done by making it a merge of two parents with no common
2443
 
        # anestry: noeolbase and noeol with the
2444
 
        # later-inserted parent the leftmost.
2445
 
        files.add_lines(self.get_simple_key('eolbeforefirstparent'),
2446
 
            self.get_parents([self.get_simple_key('noeolbase'),
2447
 
                self.get_simple_key('noeol')]),
2448
 
            ['line'])
2449
 
        # two identical eol texts
2450
 
        files.add_lines(self.get_simple_key('noeoldup'),
2451
 
            self.get_parents([self.get_simple_key('noeol')]), ['line'])
2452
 
        next_parent = self.get_simple_key('base')
2453
 
        text_name = 'chain1-'
2454
 
        text = ['line\n']
2455
 
        sha1s = {0 :'da6d3141cb4a5e6f464bf6e0518042ddc7bfd079',
2456
 
                 1 :'45e21ea146a81ea44a821737acdb4f9791c8abe7',
2457
 
                 2 :'e1f11570edf3e2a070052366c582837a4fe4e9fa',
2458
 
                 3 :'26b4b8626da827088c514b8f9bbe4ebf181edda1',
2459
 
                 4 :'e28a5510be25ba84d31121cff00956f9970ae6f6',
2460
 
                 5 :'d63ec0ce22e11dcf65a931b69255d3ac747a318d',
2461
 
                 6 :'2c2888d288cb5e1d98009d822fedfe6019c6a4ea',
2462
 
                 7 :'95c14da9cafbf828e3e74a6f016d87926ba234ab',
2463
 
                 8 :'779e9a0b28f9f832528d4b21e17e168c67697272',
2464
 
                 9 :'1f8ff4e5c6ff78ac106fcfe6b1e8cb8740ff9a8f',
2465
 
                 10:'131a2ae712cf51ed62f143e3fbac3d4206c25a05',
2466
 
                 11:'c5a9d6f520d2515e1ec401a8f8a67e6c3c89f199',
2467
 
                 12:'31a2286267f24d8bedaa43355f8ad7129509ea85',
2468
 
                 13:'dc2a7fe80e8ec5cae920973973a8ee28b2da5e0a',
2469
 
                 14:'2c4b1736566b8ca6051e668de68650686a3922f2',
2470
 
                 15:'5912e4ecd9b0c07be4d013e7e2bdcf9323276cde',
2471
 
                 16:'b0d2e18d3559a00580f6b49804c23fea500feab3',
2472
 
                 17:'8e1d43ad72f7562d7cb8f57ee584e20eb1a69fc7',
2473
 
                 18:'5cf64a3459ae28efa60239e44b20312d25b253f3',
2474
 
                 19:'1ebed371807ba5935958ad0884595126e8c4e823',
2475
 
                 20:'2aa62a8b06fb3b3b892a3292a068ade69d5ee0d3',
2476
 
                 21:'01edc447978004f6e4e962b417a4ae1955b6fe5d',
2477
 
                 22:'d8d8dc49c4bf0bab401e0298bb5ad827768618bb',
2478
 
                 23:'c21f62b1c482862983a8ffb2b0c64b3451876e3f',
2479
 
                 24:'c0593fe795e00dff6b3c0fe857a074364d5f04fc',
2480
 
                 25:'dd1a1cf2ba9cc225c3aff729953e6364bf1d1855',
2481
 
                 }
2482
 
        for depth in range(26):
2483
 
            new_version = self.get_simple_key(text_name + '%s' % depth)
2484
 
            text = text + ['line\n']
2485
 
            files.add_lines(new_version, self.get_parents([next_parent]), text)
2486
 
            next_parent = new_version
2487
 
        next_parent = self.get_simple_key('base')
2488
 
        text_name = 'chain2-'
2489
 
        text = ['line\n']
2490
 
        for depth in range(26):
2491
 
            new_version = self.get_simple_key(text_name + '%s' % depth)
2492
 
            text = text + ['line\n']
2493
 
            files.add_lines(new_version, self.get_parents([next_parent]), text)
2494
 
            next_parent = new_version
2495
 
        target = self.get_versionedfiles('target')
2496
 
        for key in multiparent.topo_iter_keys(files, files.keys()):
2497
 
            mpdiff = files.make_mpdiffs([key])[0]
2498
 
            parents = files.get_parent_map([key])[key] or []
2499
 
            target.add_mpdiffs(
2500
 
                [(key, parents, files.get_sha1s([key])[key], mpdiff)])
2501
 
            self.assertEqualDiff(
2502
 
                files.get_record_stream([key], 'unordered',
2503
 
                    True).next().get_bytes_as('fulltext'),
2504
 
                target.get_record_stream([key], 'unordered',
2505
 
                    True).next().get_bytes_as('fulltext')
2506
 
                )
2507
 
 
2508
 
    def test_keys(self):
2509
 
        # While use is discouraged, versions() is still needed by aspects of
2510
 
        # bzr.
2511
 
        files = self.get_versionedfiles()
2512
 
        self.assertEqual(set(), set(files.keys()))
2513
 
        if self.key_length == 1:
2514
 
            key = ('foo',)
2515
 
        else:
2516
 
            key = ('foo', 'bar',)
2517
 
        files.add_lines(key, (), [])
2518
 
        self.assertEqual(set([key]), set(files.keys()))
2519
 
 
2520
 
 
2521
 
class VirtualVersionedFilesTests(TestCase):
2522
 
    """Basic tests for the VirtualVersionedFiles implementations."""
2523
 
 
2524
 
    def _get_parent_map(self, keys):
2525
 
        ret = {}
2526
 
        for k in keys:
2527
 
            if k in self._parent_map:
2528
 
                ret[k] = self._parent_map[k]
2529
 
        return ret
2530
 
 
2531
 
    def setUp(self):
2532
 
        TestCase.setUp(self)
2533
 
        self._lines = {}
2534
 
        self._parent_map = {}
2535
 
        self.texts = VirtualVersionedFiles(self._get_parent_map,
2536
 
                                           self._lines.get)
2537
 
 
2538
 
    def test_add_lines(self):
2539
 
        self.assertRaises(NotImplementedError,
2540
 
                self.texts.add_lines, "foo", [], [])
2541
 
 
2542
 
    def test_add_mpdiffs(self):
2543
 
        self.assertRaises(NotImplementedError,
2544
 
                self.texts.add_mpdiffs, [])
2545
 
 
2546
 
    def test_check(self):
2547
 
        self.assertTrue(self.texts.check())
2548
 
 
2549
 
    def test_insert_record_stream(self):
2550
 
        self.assertRaises(NotImplementedError, self.texts.insert_record_stream,
2551
 
                          [])
2552
 
 
2553
 
    def test_get_sha1s_nonexistent(self):
2554
 
        self.assertEquals({}, self.texts.get_sha1s([("NONEXISTENT",)]))
2555
 
 
2556
 
    def test_get_sha1s(self):
2557
 
        self._lines["key"] = ["dataline1", "dataline2"]
2558
 
        self.assertEquals({("key",): osutils.sha_strings(self._lines["key"])},
2559
 
                           self.texts.get_sha1s([("key",)]))
2560
 
 
2561
 
    def test_get_parent_map(self):
2562
 
        self._parent_map = {"G": ("A", "B")}
2563
 
        self.assertEquals({("G",): (("A",),("B",))},
2564
 
                          self.texts.get_parent_map([("G",), ("L",)]))
2565
 
 
2566
 
    def test_get_record_stream(self):
2567
 
        self._lines["A"] = ["FOO", "BAR"]
2568
 
        it = self.texts.get_record_stream([("A",)], "unordered", True)
2569
 
        record = it.next()
2570
 
        self.assertEquals("chunked", record.storage_kind)
2571
 
        self.assertEquals("FOOBAR", record.get_bytes_as("fulltext"))
2572
 
        self.assertEquals(["FOO", "BAR"], record.get_bytes_as("chunked"))
2573
 
 
2574
 
    def test_get_record_stream_absent(self):
2575
 
        it = self.texts.get_record_stream([("A",)], "unordered", True)
2576
 
        record = it.next()
2577
 
        self.assertEquals("absent", record.storage_kind)
2578
 
 
2579
 
    def test_iter_lines_added_or_present_in_keys(self):
2580
 
        self._lines["A"] = ["FOO", "BAR"]
2581
 
        self._lines["B"] = ["HEY"]
2582
 
        self._lines["C"] = ["Alberta"]
2583
 
        it = self.texts.iter_lines_added_or_present_in_keys([("A",), ("B",)])
2584
 
        self.assertEquals(sorted([("FOO", "A"), ("BAR", "A"), ("HEY", "B")]),
2585
 
            sorted(list(it)))
2586
 
 
2587
 
 
2588
 
class TestOrderingVersionedFilesDecorator(TestCaseWithMemoryTransport):
2589
 
 
2590
 
    def get_ordering_vf(self, key_priority):
2591
 
        builder = self.make_branch_builder('test')
2592
 
        builder.start_series()
2593
 
        builder.build_snapshot('A', None, [
2594
 
            ('add', ('', 'TREE_ROOT', 'directory', None))])
2595
 
        builder.build_snapshot('B', ['A'], [])
2596
 
        builder.build_snapshot('C', ['B'], [])
2597
 
        builder.build_snapshot('D', ['C'], [])
2598
 
        builder.finish_series()
2599
 
        b = builder.get_branch()
2600
 
        b.lock_read()
2601
 
        self.addCleanup(b.unlock)
2602
 
        vf = b.repository.inventories
2603
 
        return versionedfile.OrderingVersionedFilesDecorator(vf, key_priority)
2604
 
 
2605
 
    def test_get_empty(self):
2606
 
        vf = self.get_ordering_vf({})
2607
 
        self.assertEqual([], vf.calls)
2608
 
 
2609
 
    def test_get_record_stream_topological(self):
2610
 
        vf = self.get_ordering_vf({('A',): 3, ('B',): 2, ('C',): 4, ('D',): 1})
2611
 
        request_keys = [('B',), ('C',), ('D',), ('A',)]
2612
 
        keys = [r.key for r in vf.get_record_stream(request_keys,
2613
 
                                    'topological', False)]
2614
 
        # We should have gotten the keys in topological order
2615
 
        self.assertEqual([('A',), ('B',), ('C',), ('D',)], keys)
2616
 
        # And recorded that the request was made
2617
 
        self.assertEqual([('get_record_stream', request_keys, 'topological',
2618
 
                           False)], vf.calls)
2619
 
 
2620
 
    def test_get_record_stream_ordered(self):
2621
 
        vf = self.get_ordering_vf({('A',): 3, ('B',): 2, ('C',): 4, ('D',): 1})
2622
 
        request_keys = [('B',), ('C',), ('D',), ('A',)]
2623
 
        keys = [r.key for r in vf.get_record_stream(request_keys,
2624
 
                                   'unordered', False)]
2625
 
        # They should be returned based on their priority
2626
 
        self.assertEqual([('D',), ('B',), ('A',), ('C',)], keys)
2627
 
        # And the request recorded
2628
 
        self.assertEqual([('get_record_stream', request_keys, 'unordered',
2629
 
                           False)], vf.calls)
2630
 
 
2631
 
    def test_get_record_stream_implicit_order(self):
2632
 
        vf = self.get_ordering_vf({('B',): 2, ('D',): 1})
2633
 
        request_keys = [('B',), ('C',), ('D',), ('A',)]
2634
 
        keys = [r.key for r in vf.get_record_stream(request_keys,
2635
 
                                   'unordered', False)]
2636
 
        # A and C are not in the map, so they get sorted to the front. A comes
2637
 
        # before C alphabetically, so it comes back first
2638
 
        self.assertEqual([('A',), ('C',), ('D',), ('B',)], keys)
2639
 
        # And the request recorded
2640
 
        self.assertEqual([('get_record_stream', request_keys, 'unordered',
2641
 
                           False)], vf.calls)