~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-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

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