~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_versionedfile.py

  • Committer: Jelmer Vernooij
  • Date: 2009-01-28 18:42:55 UTC
  • mto: This revision was merged to the branch mainline in revision 3968.
  • Revision ID: jelmer@samba.org-20090128184255-bdmklkvm83ltk191
Update NEWS

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
24
25
from StringIO import StringIO
25
26
 
26
27
import bzrlib
27
28
from bzrlib import (
28
29
    errors,
 
30
    osutils,
29
31
    progress,
30
32
    )
31
33
from bzrlib.errors import (
32
 
                           RevisionNotPresent, 
 
34
                           RevisionNotPresent,
33
35
                           RevisionAlreadyPresent,
34
36
                           WeaveParentMismatch
35
37
                           )
36
 
from bzrlib.knit import KnitVersionedFile, \
37
 
     KnitAnnotateFactory
38
 
from bzrlib.tests import TestCaseWithTransport
39
 
from bzrlib.tests.HTTPTestUtil import TestCaseWithWebserver
 
38
from bzrlib import knit as _mod_knit
 
39
from bzrlib.knit import (
 
40
    cleanup_pack_knit,
 
41
    make_file_factory,
 
42
    make_pack_factory,
 
43
    KnitAnnotateFactory,
 
44
    KnitPlainFactory,
 
45
    )
 
46
from bzrlib.symbol_versioning import one_four, one_five
 
47
from bzrlib.tests import (
 
48
    TestCase,
 
49
    TestCaseWithMemoryTransport,
 
50
    TestScenarioApplier,
 
51
    TestSkipped,
 
52
    condition_isinstance,
 
53
    split_suite_by_condition,
 
54
    iter_suite_tests,
 
55
    )
 
56
from bzrlib.tests.http_utils import TestCaseWithWebserver
40
57
from bzrlib.trace import mutter
41
58
from bzrlib.transport import get_transport
42
59
from bzrlib.transport.memory import MemoryTransport
43
60
from bzrlib.tsort import topo_sort
 
61
from bzrlib.tuned_gzip import GzipFile
44
62
import bzrlib.versionedfile as versionedfile
 
63
from bzrlib.versionedfile import (
 
64
    ConstantMapper,
 
65
    HashEscapedPrefixMapper,
 
66
    PrefixMapper,
 
67
    VirtualVersionedFiles,
 
68
    make_versioned_files_factory,
 
69
    )
45
70
from bzrlib.weave import WeaveFile
46
71
from bzrlib.weavefile import read_weave, write_weave
47
72
 
48
73
 
 
74
def load_tests(standard_tests, module, loader):
 
75
    """Parameterize VersionedFiles tests for different implementations."""
 
76
    to_adapt, result = split_suite_by_condition(
 
77
        standard_tests, condition_isinstance(TestVersionedFiles))
 
78
    len_one_adapter = TestScenarioApplier()
 
79
    len_two_adapter = TestScenarioApplier()
 
80
    # We want to be sure of behaviour for:
 
81
    # weaves prefix layout (weave texts)
 
82
    # individually named weaves (weave inventories)
 
83
    # annotated knits - prefix|hash|hash-escape layout, we test the third only
 
84
    #                   as it is the most complex mapper.
 
85
    # individually named knits
 
86
    # individual no-graph knits in packs (signatures)
 
87
    # individual graph knits in packs (inventories)
 
88
    # individual graph nocompression knits in packs (revisions)
 
89
    # plain text knits in packs (texts)
 
90
    len_one_adapter.scenarios = [
 
91
        ('weave-named', {
 
92
            'cleanup':None,
 
93
            'factory':make_versioned_files_factory(WeaveFile,
 
94
                ConstantMapper('inventory')),
 
95
            'graph':True,
 
96
            'key_length':1,
 
97
            }),
 
98
        ('named-knit', {
 
99
            'cleanup':None,
 
100
            'factory':make_file_factory(False, ConstantMapper('revisions')),
 
101
            'graph':True,
 
102
            'key_length':1,
 
103
            }),
 
104
        ('named-nograph-knit-pack', {
 
105
            'cleanup':cleanup_pack_knit,
 
106
            'factory':make_pack_factory(False, False, 1),
 
107
            'graph':False,
 
108
            'key_length':1,
 
109
            }),
 
110
        ('named-graph-knit-pack', {
 
111
            'cleanup':cleanup_pack_knit,
 
112
            'factory':make_pack_factory(True, True, 1),
 
113
            'graph':True,
 
114
            'key_length':1,
 
115
            }),
 
116
        ('named-graph-nodelta-knit-pack', {
 
117
            'cleanup':cleanup_pack_knit,
 
118
            'factory':make_pack_factory(True, False, 1),
 
119
            'graph':True,
 
120
            'key_length':1,
 
121
            }),
 
122
        ]
 
123
    len_two_adapter.scenarios = [
 
124
        ('weave-prefix', {
 
125
            'cleanup':None,
 
126
            'factory':make_versioned_files_factory(WeaveFile,
 
127
                PrefixMapper()),
 
128
            'graph':True,
 
129
            'key_length':2,
 
130
            }),
 
131
        ('annotated-knit-escape', {
 
132
            'cleanup':None,
 
133
            'factory':make_file_factory(True, HashEscapedPrefixMapper()),
 
134
            'graph':True,
 
135
            'key_length':2,
 
136
            }),
 
137
        ('plain-knit-pack', {
 
138
            'cleanup':cleanup_pack_knit,
 
139
            'factory':make_pack_factory(True, True, 2),
 
140
            'graph':True,
 
141
            'key_length':2,
 
142
            }),
 
143
        ]
 
144
    for test in iter_suite_tests(to_adapt):
 
145
        result.addTests(len_one_adapter.adapt(test))
 
146
        result.addTests(len_two_adapter.adapt(test))
 
147
    return result
 
148
 
 
149
 
 
150
def get_diamond_vf(f, trailing_eol=True, left_only=False):
 
151
    """Get a diamond graph to exercise deltas and merges.
 
152
    
 
153
    :param trailing_eol: If True end the last line with \n.
 
154
    """
 
155
    parents = {
 
156
        'origin': (),
 
157
        'base': (('origin',),),
 
158
        'left': (('base',),),
 
159
        'right': (('base',),),
 
160
        'merged': (('left',), ('right',)),
 
161
        }
 
162
    # insert a diamond graph to exercise deltas and merges.
 
163
    if trailing_eol:
 
164
        last_char = '\n'
 
165
    else:
 
166
        last_char = ''
 
167
    f.add_lines('origin', [], ['origin' + last_char])
 
168
    f.add_lines('base', ['origin'], ['base' + last_char])
 
169
    f.add_lines('left', ['base'], ['base\n', 'left' + last_char])
 
170
    if not left_only:
 
171
        f.add_lines('right', ['base'],
 
172
            ['base\n', 'right' + last_char])
 
173
        f.add_lines('merged', ['left', 'right'],
 
174
            ['base\n', 'left\n', 'right\n', 'merged' + last_char])
 
175
    return f, parents
 
176
 
 
177
 
 
178
def get_diamond_files(files, key_length, trailing_eol=True, left_only=False,
 
179
    nograph=False):
 
180
    """Get a diamond graph to exercise deltas and merges.
 
181
 
 
182
    This creates a 5-node graph in files. If files supports 2-length keys two
 
183
    graphs are made to exercise the support for multiple ids.
 
184
    
 
185
    :param trailing_eol: If True end the last line with \n.
 
186
    :param key_length: The length of keys in files. Currently supports length 1
 
187
        and 2 keys.
 
188
    :param left_only: If True do not add the right and merged nodes.
 
189
    :param nograph: If True, do not provide parents to the add_lines calls;
 
190
        this is useful for tests that need inserted data but have graphless
 
191
        stores.
 
192
    :return: The results of the add_lines calls.
 
193
    """
 
194
    if key_length == 1:
 
195
        prefixes = [()]
 
196
    else:
 
197
        prefixes = [('FileA',), ('FileB',)]
 
198
    # insert a diamond graph to exercise deltas and merges.
 
199
    if trailing_eol:
 
200
        last_char = '\n'
 
201
    else:
 
202
        last_char = ''
 
203
    result = []
 
204
    def get_parents(suffix_list):
 
205
        if nograph:
 
206
            return ()
 
207
        else:
 
208
            result = [prefix + suffix for suffix in suffix_list]
 
209
            return result
 
210
    # we loop over each key because that spreads the inserts across prefixes,
 
211
    # which is how commit operates.
 
212
    for prefix in prefixes:
 
213
        result.append(files.add_lines(prefix + ('origin',), (),
 
214
            ['origin' + last_char]))
 
215
    for prefix in prefixes:
 
216
        result.append(files.add_lines(prefix + ('base',),
 
217
            get_parents([('origin',)]), ['base' + last_char]))
 
218
    for prefix in prefixes:
 
219
        result.append(files.add_lines(prefix + ('left',),
 
220
            get_parents([('base',)]),
 
221
            ['base\n', 'left' + last_char]))
 
222
    if not left_only:
 
223
        for prefix in prefixes:
 
224
            result.append(files.add_lines(prefix + ('right',),
 
225
                get_parents([('base',)]),
 
226
                ['base\n', 'right' + last_char]))
 
227
        for prefix in prefixes:
 
228
            result.append(files.add_lines(prefix + ('merged',),
 
229
                get_parents([('left',), ('right',)]),
 
230
                ['base\n', 'left\n', 'right\n', 'merged' + last_char]))
 
231
    return result
 
232
 
 
233
 
49
234
class VersionedFileTestMixIn(object):
50
235
    """A mixin test class for testing VersionedFiles.
51
236
 
54
239
    they are strictly controlled by their owning repositories.
55
240
    """
56
241
 
 
242
    def get_transaction(self):
 
243
        if not hasattr(self, '_transaction'):
 
244
            self._transaction = None
 
245
        return self._transaction
 
246
 
57
247
    def test_add(self):
58
248
        f = self.get_file()
59
249
        f.add_lines('r0', [], ['a\n', 'b\n'])
80
270
    def test_adds_with_parent_texts(self):
81
271
        f = self.get_file()
82
272
        parent_texts = {}
83
 
        parent_texts['r0'] = f.add_lines('r0', [], ['a\n', 'b\n'])
 
273
        _, _, parent_texts['r0'] = f.add_lines('r0', [], ['a\n', 'b\n'])
84
274
        try:
85
 
            parent_texts['r1'] = f.add_lines_with_ghosts('r1',
86
 
                                                         ['r0', 'ghost'], 
87
 
                                                         ['b\n', 'c\n'],
88
 
                                                         parent_texts=parent_texts)
 
275
            _, _, parent_texts['r1'] = f.add_lines_with_ghosts('r1',
 
276
                ['r0', 'ghost'], ['b\n', 'c\n'], parent_texts=parent_texts)
89
277
        except NotImplementedError:
90
278
            # if the format doesn't support ghosts, just add normally.
91
 
            parent_texts['r1'] = f.add_lines('r1',
92
 
                                             ['r0'], 
93
 
                                             ['b\n', 'c\n'],
94
 
                                             parent_texts=parent_texts)
 
279
            _, _, parent_texts['r1'] = f.add_lines('r1',
 
280
                ['r0'], ['b\n', 'c\n'], parent_texts=parent_texts)
95
281
        f.add_lines('r2', ['r1'], ['c\n', 'd\n'], parent_texts=parent_texts)
96
282
        self.assertNotEqual(None, parent_texts['r0'])
97
283
        self.assertNotEqual(None, parent_texts['r1'])
125
311
            (errors.BzrBadParameterUnicode, NotImplementedError),
126
312
            vf.add_lines_with_ghosts, 'a', [], ['a\n', u'b\n', 'c\n'])
127
313
 
 
314
    def test_add_follows_left_matching_blocks(self):
 
315
        """If we change left_matching_blocks, delta changes
 
316
 
 
317
        Note: There are multiple correct deltas in this case, because
 
318
        we start with 1 "a" and we get 3.
 
319
        """
 
320
        vf = self.get_file()
 
321
        if isinstance(vf, WeaveFile):
 
322
            raise TestSkipped("WeaveFile ignores left_matching_blocks")
 
323
        vf.add_lines('1', [], ['a\n'])
 
324
        vf.add_lines('2', ['1'], ['a\n', 'a\n', 'a\n'],
 
325
                     left_matching_blocks=[(0, 0, 1), (1, 3, 0)])
 
326
        self.assertEqual(['a\n', 'a\n', 'a\n'], vf.get_lines('2'))
 
327
        vf.add_lines('3', ['1'], ['a\n', 'a\n', 'a\n'],
 
328
                     left_matching_blocks=[(0, 2, 1), (1, 3, 0)])
 
329
        self.assertEqual(['a\n', 'a\n', 'a\n'], vf.get_lines('3'))
 
330
 
128
331
    def test_inline_newline_throws(self):
129
332
        # \r characters are not permitted in lines being added
130
333
        vf = self.get_file()
145
348
        self.assertRaises(errors.ReservedId,
146
349
            vf.add_lines, 'a:', [], ['a\n', 'b\n', 'c\n'])
147
350
 
148
 
        self.assertRaises(errors.ReservedId,
149
 
            vf.add_delta, 'a:', [], None, 'sha1', False, ((0, 0, 0, []),))
 
351
    def test_add_lines_nostoresha(self):
 
352
        """When nostore_sha is supplied using old content raises."""
 
353
        vf = self.get_file()
 
354
        empty_text = ('a', [])
 
355
        sample_text_nl = ('b', ["foo\n", "bar\n"])
 
356
        sample_text_no_nl = ('c', ["foo\n", "bar"])
 
357
        shas = []
 
358
        for version, lines in (empty_text, sample_text_nl, sample_text_no_nl):
 
359
            sha, _, _ = vf.add_lines(version, [], lines)
 
360
            shas.append(sha)
 
361
        # we now have a copy of all the lines in the vf.
 
362
        for sha, (version, lines) in zip(
 
363
            shas, (empty_text, sample_text_nl, sample_text_no_nl)):
 
364
            self.assertRaises(errors.ExistingContent,
 
365
                vf.add_lines, version + "2", [], lines,
 
366
                nostore_sha=sha)
 
367
            # and no new version should have been added.
 
368
            self.assertRaises(errors.RevisionNotPresent, vf.get_lines,
 
369
                version + "2")
 
370
 
 
371
    def test_add_lines_with_ghosts_nostoresha(self):
 
372
        """When nostore_sha is supplied using old content raises."""
 
373
        vf = self.get_file()
 
374
        empty_text = ('a', [])
 
375
        sample_text_nl = ('b', ["foo\n", "bar\n"])
 
376
        sample_text_no_nl = ('c', ["foo\n", "bar"])
 
377
        shas = []
 
378
        for version, lines in (empty_text, sample_text_nl, sample_text_no_nl):
 
379
            sha, _, _ = vf.add_lines(version, [], lines)
 
380
            shas.append(sha)
 
381
        # we now have a copy of all the lines in the vf.
 
382
        # is the test applicable to this vf implementation?
 
383
        try:
 
384
            vf.add_lines_with_ghosts('d', [], [])
 
385
        except NotImplementedError:
 
386
            raise TestSkipped("add_lines_with_ghosts is optional")
 
387
        for sha, (version, lines) in zip(
 
388
            shas, (empty_text, sample_text_nl, sample_text_no_nl)):
 
389
            self.assertRaises(errors.ExistingContent,
 
390
                vf.add_lines_with_ghosts, version + "2", [], lines,
 
391
                nostore_sha=sha)
 
392
            # and no new version should have been added.
 
393
            self.assertRaises(errors.RevisionNotPresent, vf.get_lines,
 
394
                version + "2")
 
395
 
 
396
    def test_add_lines_return_value(self):
 
397
        # add_lines should return the sha1 and the text size.
 
398
        vf = self.get_file()
 
399
        empty_text = ('a', [])
 
400
        sample_text_nl = ('b', ["foo\n", "bar\n"])
 
401
        sample_text_no_nl = ('c', ["foo\n", "bar"])
 
402
        # check results for the three cases:
 
403
        for version, lines in (empty_text, sample_text_nl, sample_text_no_nl):
 
404
            # the first two elements are the same for all versioned files:
 
405
            # - the digest and the size of the text. For some versioned files
 
406
            #   additional data is returned in additional tuple elements.
 
407
            result = vf.add_lines(version, [], lines)
 
408
            self.assertEqual(3, len(result))
 
409
            self.assertEqual((osutils.sha_strings(lines), sum(map(len, lines))),
 
410
                result[0:2])
 
411
        # parents should not affect the result:
 
412
        lines = sample_text_nl[1]
 
413
        self.assertEqual((osutils.sha_strings(lines), sum(map(len, lines))),
 
414
            vf.add_lines('d', ['b', 'c'], lines)[0:2])
150
415
 
151
416
    def test_get_reserved(self):
152
417
        vf = self.get_file()
153
 
        self.assertRaises(errors.ReservedId, vf.get_delta, 'b:')
154
418
        self.assertRaises(errors.ReservedId, vf.get_texts, ['b:'])
155
419
        self.assertRaises(errors.ReservedId, vf.get_lines, 'b:')
156
420
        self.assertRaises(errors.ReservedId, vf.get_text, 'b:')
157
421
 
158
 
    def test_get_delta(self):
159
 
        f = self.get_file()
160
 
        sha1s = self._setup_for_deltas(f)
161
 
        expected_delta = (None, '6bfa09d82ce3e898ad4641ae13dd4fdb9cf0d76b', False, 
162
 
                          [(0, 0, 1, [('base', 'line\n')])])
163
 
        self.assertEqual(expected_delta, f.get_delta('base'))
164
 
        next_parent = 'base'
165
 
        text_name = 'chain1-'
166
 
        for depth in range(26):
167
 
            new_version = text_name + '%s' % depth
168
 
            expected_delta = (next_parent, sha1s[depth], 
169
 
                              False,
170
 
                              [(depth + 1, depth + 1, 1, [(new_version, 'line\n')])])
171
 
            self.assertEqual(expected_delta, f.get_delta(new_version))
172
 
            next_parent = new_version
173
 
        next_parent = 'base'
174
 
        text_name = 'chain2-'
175
 
        for depth in range(26):
176
 
            new_version = text_name + '%s' % depth
177
 
            expected_delta = (next_parent, sha1s[depth], False,
178
 
                              [(depth + 1, depth + 1, 1, [(new_version, 'line\n')])])
179
 
            self.assertEqual(expected_delta, f.get_delta(new_version))
180
 
            next_parent = new_version
181
 
        # smoke test for eol support
182
 
        expected_delta = ('base', '264f39cab871e4cfd65b3a002f7255888bb5ed97', True, [])
183
 
        self.assertEqual(['line'], f.get_lines('noeol'))
184
 
        self.assertEqual(expected_delta, f.get_delta('noeol'))
185
 
 
186
 
    def test_get_deltas(self):
187
 
        f = self.get_file()
188
 
        sha1s = self._setup_for_deltas(f)
189
 
        deltas = f.get_deltas(f.versions())
190
 
        expected_delta = (None, '6bfa09d82ce3e898ad4641ae13dd4fdb9cf0d76b', False, 
191
 
                          [(0, 0, 1, [('base', 'line\n')])])
192
 
        self.assertEqual(expected_delta, deltas['base'])
193
 
        next_parent = 'base'
194
 
        text_name = 'chain1-'
195
 
        for depth in range(26):
196
 
            new_version = text_name + '%s' % depth
197
 
            expected_delta = (next_parent, sha1s[depth], 
198
 
                              False,
199
 
                              [(depth + 1, depth + 1, 1, [(new_version, 'line\n')])])
200
 
            self.assertEqual(expected_delta, deltas[new_version])
201
 
            next_parent = new_version
202
 
        next_parent = 'base'
203
 
        text_name = 'chain2-'
204
 
        for depth in range(26):
205
 
            new_version = text_name + '%s' % depth
206
 
            expected_delta = (next_parent, sha1s[depth], False,
207
 
                              [(depth + 1, depth + 1, 1, [(new_version, 'line\n')])])
208
 
            self.assertEqual(expected_delta, deltas[new_version])
209
 
            next_parent = new_version
210
 
        # smoke tests for eol support
211
 
        expected_delta = ('base', '264f39cab871e4cfd65b3a002f7255888bb5ed97', True, [])
212
 
        self.assertEqual(['line'], f.get_lines('noeol'))
213
 
        self.assertEqual(expected_delta, deltas['noeol'])
214
 
        # smoke tests for eol support - two noeol in a row same content
215
 
        expected_deltas = (('noeol', '3ad7ee82dbd8f29ecba073f96e43e414b3f70a4d', True, 
216
 
                          [(0, 1, 2, [('noeolsecond', 'line\n'), ('noeolsecond', 'line\n')])]),
217
 
                          ('noeol', '3ad7ee82dbd8f29ecba073f96e43e414b3f70a4d', True, 
218
 
                           [(0, 0, 1, [('noeolsecond', 'line\n')]), (1, 1, 0, [])]))
219
 
        self.assertEqual(['line\n', 'line'], f.get_lines('noeolsecond'))
220
 
        self.assertTrue(deltas['noeolsecond'] in expected_deltas)
221
 
        # two no-eol in a row, different content
222
 
        expected_delta = ('noeolsecond', '8bb553a84e019ef1149db082d65f3133b195223b', True, 
223
 
                          [(1, 2, 1, [('noeolnotshared', 'phone\n')])])
224
 
        self.assertEqual(['line\n', 'phone'], f.get_lines('noeolnotshared'))
225
 
        self.assertEqual(expected_delta, deltas['noeolnotshared'])
226
 
        # eol folling a no-eol with content change
227
 
        expected_delta = ('noeol', 'a61f6fb6cfc4596e8d88c34a308d1e724caf8977', False, 
228
 
                          [(0, 1, 1, [('eol', 'phone\n')])])
229
 
        self.assertEqual(['phone\n'], f.get_lines('eol'))
230
 
        self.assertEqual(expected_delta, deltas['eol'])
231
 
        # eol folling a no-eol with content change
232
 
        expected_delta = ('noeol', '6bfa09d82ce3e898ad4641ae13dd4fdb9cf0d76b', False, 
233
 
                          [(0, 1, 1, [('eolline', 'line\n')])])
234
 
        self.assertEqual(['line\n'], f.get_lines('eolline'))
235
 
        self.assertEqual(expected_delta, deltas['eolline'])
236
 
        # eol with no parents
237
 
        expected_delta = (None, '264f39cab871e4cfd65b3a002f7255888bb5ed97', True, 
238
 
                          [(0, 0, 1, [('noeolbase', 'line\n')])])
239
 
        self.assertEqual(['line'], f.get_lines('noeolbase'))
240
 
        self.assertEqual(expected_delta, deltas['noeolbase'])
241
 
        # eol with two parents, in inverse insertion order
242
 
        expected_deltas = (('noeolbase', '264f39cab871e4cfd65b3a002f7255888bb5ed97', True,
243
 
                            [(0, 1, 1, [('eolbeforefirstparent', 'line\n')])]),
244
 
                           ('noeolbase', '264f39cab871e4cfd65b3a002f7255888bb5ed97', True,
245
 
                            [(0, 1, 1, [('eolbeforefirstparent', 'line\n')])]))
246
 
        self.assertEqual(['line'], f.get_lines('eolbeforefirstparent'))
247
 
        #self.assertTrue(deltas['eolbeforefirstparent'] in expected_deltas)
 
422
    def test_add_unchanged_last_line_noeol_snapshot(self):
 
423
        """Add a text with an unchanged last line with no eol should work."""
 
424
        # Test adding this in a number of chain lengths; because the interface
 
425
        # for VersionedFile does not allow forcing a specific chain length, we
 
426
        # just use a small base to get the first snapshot, then a much longer
 
427
        # first line for the next add (which will make the third add snapshot)
 
428
        # and so on. 20 has been chosen as an aribtrary figure - knits use 200
 
429
        # as a capped delta length, but ideally we would have some way of
 
430
        # tuning the test to the store (e.g. keep going until a snapshot
 
431
        # happens).
 
432
        for length in range(20):
 
433
            version_lines = {}
 
434
            vf = self.get_file('case-%d' % length)
 
435
            prefix = 'step-%d'
 
436
            parents = []
 
437
            for step in range(length):
 
438
                version = prefix % step
 
439
                lines = (['prelude \n'] * step) + ['line']
 
440
                vf.add_lines(version, parents, lines)
 
441
                version_lines[version] = lines
 
442
                parents = [version]
 
443
            vf.add_lines('no-eol', parents, ['line'])
 
444
            vf.get_texts(version_lines.keys())
 
445
            self.assertEqualDiff('line', vf.get_text('no-eol'))
 
446
 
 
447
    def test_get_texts_eol_variation(self):
 
448
        # similar to the failure in <http://bugs.launchpad.net/234748>
 
449
        vf = self.get_file()
 
450
        sample_text_nl = ["line\n"]
 
451
        sample_text_no_nl = ["line"]
 
452
        versions = []
 
453
        version_lines = {}
 
454
        parents = []
 
455
        for i in range(4):
 
456
            version = 'v%d' % i
 
457
            if i % 2:
 
458
                lines = sample_text_nl
 
459
            else:
 
460
                lines = sample_text_no_nl
 
461
            # left_matching blocks is an internal api; it operates on the
 
462
            # *internal* representation for a knit, which is with *all* lines
 
463
            # being normalised to end with \n - even the final line in a no_nl
 
464
            # file. Using it here ensures that a broken internal implementation
 
465
            # (which is what this test tests) will generate a correct line
 
466
            # delta (which is to say, an empty delta).
 
467
            vf.add_lines(version, parents, lines,
 
468
                left_matching_blocks=[(0, 0, 1)])
 
469
            parents = [version]
 
470
            versions.append(version)
 
471
            version_lines[version] = lines
 
472
        vf.check()
 
473
        vf.get_texts(versions)
 
474
        vf.get_texts(reversed(versions))
 
475
 
 
476
    def test_add_lines_with_matching_blocks_noeol_last_line(self):
 
477
        """Add a text with an unchanged last line with no eol should work."""
 
478
        from bzrlib import multiparent
 
479
        # Hand verified sha1 of the text we're adding.
 
480
        sha1 = '6a1d115ec7b60afb664dc14890b5af5ce3c827a4'
 
481
        # Create a mpdiff which adds a new line before the trailing line, and
 
482
        # reuse the last line unaltered (which can cause annotation reuse).
 
483
        # Test adding this in two situations:
 
484
        # On top of a new insertion
 
485
        vf = self.get_file('fulltext')
 
486
        vf.add_lines('noeol', [], ['line'])
 
487
        vf.add_lines('noeol2', ['noeol'], ['newline\n', 'line'],
 
488
            left_matching_blocks=[(0, 1, 1)])
 
489
        self.assertEqualDiff('newline\nline', vf.get_text('noeol2'))
 
490
        # On top of a delta
 
491
        vf = self.get_file('delta')
 
492
        vf.add_lines('base', [], ['line'])
 
493
        vf.add_lines('noeol', ['base'], ['prelude\n', 'line'])
 
494
        vf.add_lines('noeol2', ['noeol'], ['newline\n', 'line'],
 
495
            left_matching_blocks=[(1, 1, 1)])
 
496
        self.assertEqualDiff('newline\nline', vf.get_text('noeol2'))
 
497
 
 
498
    def test_make_mpdiffs(self):
 
499
        from bzrlib import multiparent
 
500
        vf = self.get_file('foo')
 
501
        sha1s = self._setup_for_deltas(vf)
 
502
        new_vf = self.get_file('bar')
 
503
        for version in multiparent.topo_iter(vf):
 
504
            mpdiff = vf.make_mpdiffs([version])[0]
 
505
            new_vf.add_mpdiffs([(version, vf.get_parent_map([version])[version],
 
506
                                 vf.get_sha1s([version])[version], mpdiff)])
 
507
            self.assertEqualDiff(vf.get_text(version),
 
508
                                 new_vf.get_text(version))
 
509
 
 
510
    def test_make_mpdiffs_with_ghosts(self):
 
511
        vf = self.get_file('foo')
 
512
        try:
 
513
            vf.add_lines_with_ghosts('text', ['ghost'], ['line\n'])
 
514
        except NotImplementedError:
 
515
            # old Weave formats do not allow ghosts
 
516
            return
 
517
        self.assertRaises(errors.RevisionNotPresent, vf.make_mpdiffs, ['ghost'])
248
518
 
249
519
    def _setup_for_deltas(self, f):
250
 
        self.assertRaises(errors.RevisionNotPresent, f.get_delta, 'base')
 
520
        self.assertFalse(f.has_version('base'))
251
521
        # add texts that should trip the knit maximum delta chain threshold
252
522
        # as well as doing parallel chains of data in knits.
253
523
        # this is done by two chains of 25 insertions
316
586
            next_parent = new_version
317
587
        return sha1s
318
588
 
319
 
    def test_add_delta(self):
320
 
        # tests for the add-delta facility.
321
 
        # at this point, optimising for speed, we assume no checks when deltas are inserted.
322
 
        # this may need to be revisited.
323
 
        source = self.get_file('source')
324
 
        source.add_lines('base', [], ['line\n'])
325
 
        next_parent = 'base'
326
 
        text_name = 'chain1-'
327
 
        text = ['line\n']
328
 
        for depth in range(26):
329
 
            new_version = text_name + '%s' % depth
330
 
            text = text + ['line\n']
331
 
            source.add_lines(new_version, [next_parent], text)
332
 
            next_parent = new_version
333
 
        next_parent = 'base'
334
 
        text_name = 'chain2-'
335
 
        text = ['line\n']
336
 
        for depth in range(26):
337
 
            new_version = text_name + '%s' % depth
338
 
            text = text + ['line\n']
339
 
            source.add_lines(new_version, [next_parent], text)
340
 
            next_parent = new_version
341
 
        source.add_lines('noeol', ['base'], ['line'])
342
 
        
343
 
        target = self.get_file('target')
344
 
        for version in source.versions():
345
 
            parent, sha1, noeol, delta = source.get_delta(version)
346
 
            target.add_delta(version,
347
 
                             source.get_parents(version),
348
 
                             parent,
349
 
                             sha1,
350
 
                             noeol,
351
 
                             delta)
352
 
        self.assertRaises(RevisionAlreadyPresent,
353
 
                          target.add_delta, 'base', [], None, '', False, [])
354
 
        for version in source.versions():
355
 
            self.assertEqual(source.get_lines(version),
356
 
                             target.get_lines(version))
357
 
 
358
589
    def test_ancestry(self):
359
590
        f = self.get_file()
360
591
        self.assertEqual([], f.get_ancestry([]))
383
614
        self.assertRaises(RevisionNotPresent,
384
615
            f.get_ancestry, ['rM', 'rX'])
385
616
 
 
617
        self.assertEqual(set(f.get_ancestry('rM')),
 
618
            set(f.get_ancestry('rM', topo_sorted=False)))
 
619
 
386
620
    def test_mutate_after_finish(self):
 
621
        self._transaction = 'before'
387
622
        f = self.get_file()
388
 
        f.transaction_finished()
389
 
        self.assertRaises(errors.OutSideTransaction, f.add_delta, '', [], '', '', False, [])
 
623
        self._transaction = 'after'
390
624
        self.assertRaises(errors.OutSideTransaction, f.add_lines, '', [], [])
391
625
        self.assertRaises(errors.OutSideTransaction, f.add_lines_with_ghosts, '', [], [])
392
 
        self.assertRaises(errors.OutSideTransaction, f.fix_parents, '', [])
393
 
        self.assertRaises(errors.OutSideTransaction, f.join, '')
394
 
        self.assertRaises(errors.OutSideTransaction, f.clone_text, 'base', 'bar', ['foo'])
395
626
        
396
 
    def test_clear_cache(self):
397
 
        f = self.get_file()
398
 
        # on a new file it should not error
399
 
        f.clear_cache()
400
 
        # and after adding content, doing a clear_cache and a get should work.
401
 
        f.add_lines('0', [], ['a'])
402
 
        f.clear_cache()
403
 
        self.assertEqual(['a'], f.get_lines('0'))
404
 
 
405
 
    def test_clone_text(self):
406
 
        f = self.get_file()
407
 
        f.add_lines('r0', [], ['a\n', 'b\n'])
408
 
        f.clone_text('r1', 'r0', ['r0'])
409
 
        def verify_file(f):
410
 
            self.assertEquals(f.get_lines('r1'), f.get_lines('r0'))
411
 
            self.assertEquals(f.get_lines('r1'), ['a\n', 'b\n'])
412
 
            self.assertEquals(f.get_parents('r1'), ['r0'])
413
 
    
414
 
            self.assertRaises(RevisionNotPresent,
415
 
                f.clone_text, 'r2', 'rX', [])
416
 
            self.assertRaises(RevisionAlreadyPresent,
417
 
                f.clone_text, 'r1', 'r0', [])
418
 
        verify_file(f)
419
 
        verify_file(self.reopen_file())
420
 
 
421
 
    def test_create_empty(self):
422
 
        f = self.get_file()
423
 
        f.add_lines('0', [], ['a\n'])
424
 
        new_f = f.create_empty('t', MemoryTransport())
425
 
        # smoke test, specific types should check it is honoured correctly for
426
 
        # non type attributes
427
 
        self.assertEqual([], new_f.versions())
428
 
        self.assertTrue(isinstance(new_f, f.__class__))
429
 
 
430
627
    def test_copy_to(self):
431
628
        f = self.get_file()
432
629
        f.add_lines('0', [], ['a\n'])
433
630
        t = MemoryTransport()
434
631
        f.copy_to('foo', t)
435
 
        for suffix in f.__class__.get_suffixes():
 
632
        for suffix in self.get_factory().get_suffixes():
436
633
            self.assertTrue(t.has('foo' + suffix))
437
634
 
438
635
    def test_get_suffixes(self):
439
636
        f = self.get_file()
440
 
        # should be the same
441
 
        self.assertEqual(f.__class__.get_suffixes(), f.__class__.get_suffixes())
442
637
        # and should be a list
443
 
        self.assertTrue(isinstance(f.__class__.get_suffixes(), list))
444
 
 
445
 
    def build_graph(self, file, graph):
446
 
        for node in topo_sort(graph.items()):
447
 
            file.add_lines(node, graph[node], [])
448
 
 
449
 
    def test_get_graph(self):
450
 
        f = self.get_file()
451
 
        graph = {
452
 
            'v1': [],
453
 
            'v2': ['v1'],
454
 
            'v3': ['v2']}
455
 
        self.build_graph(f, graph)
456
 
        self.assertEqual(graph, f.get_graph())
457
 
    
458
 
    def test_get_graph_partial(self):
459
 
        f = self.get_file()
460
 
        complex_graph = {}
461
 
        simple_a = {
462
 
            'c': [],
463
 
            'b': ['c'],
464
 
            'a': ['b'],
465
 
            }
466
 
        complex_graph.update(simple_a)
467
 
        simple_b = {
468
 
            'c': [],
469
 
            'b': ['c'],
470
 
            }
471
 
        complex_graph.update(simple_b)
472
 
        simple_gam = {
473
 
            'c': [],
474
 
            'oo': [],
475
 
            'bar': ['oo', 'c'],
476
 
            'gam': ['bar'],
477
 
            }
478
 
        complex_graph.update(simple_gam)
479
 
        simple_b_gam = {}
480
 
        simple_b_gam.update(simple_gam)
481
 
        simple_b_gam.update(simple_b)
482
 
        self.build_graph(f, complex_graph)
483
 
        self.assertEqual(simple_a, f.get_graph(['a']))
484
 
        self.assertEqual(simple_b, f.get_graph(['b']))
485
 
        self.assertEqual(simple_gam, f.get_graph(['gam']))
486
 
        self.assertEqual(simple_b_gam, f.get_graph(['b', 'gam']))
487
 
 
488
 
    def test_get_parents(self):
 
638
        self.assertTrue(isinstance(self.get_factory().get_suffixes(), list))
 
639
 
 
640
    def test_get_parent_map(self):
489
641
        f = self.get_file()
490
642
        f.add_lines('r0', [], ['a\n', 'b\n'])
491
 
        f.add_lines('r1', [], ['a\n', 'b\n'])
 
643
        self.assertEqual(
 
644
            {'r0':()}, f.get_parent_map(['r0']))
 
645
        f.add_lines('r1', ['r0'], ['a\n', 'b\n'])
 
646
        self.assertEqual(
 
647
            {'r1':('r0',)}, f.get_parent_map(['r1']))
 
648
        self.assertEqual(
 
649
            {'r0':(),
 
650
             'r1':('r0',)},
 
651
            f.get_parent_map(['r0', 'r1']))
492
652
        f.add_lines('r2', [], ['a\n', 'b\n'])
493
653
        f.add_lines('r3', [], ['a\n', 'b\n'])
494
654
        f.add_lines('m', ['r0', 'r1', 'r2', 'r3'], ['a\n', 'b\n'])
495
 
        self.assertEquals(f.get_parents('m'), ['r0', 'r1', 'r2', 'r3'])
496
 
 
497
 
        self.assertRaises(RevisionNotPresent,
498
 
            f.get_parents, 'y')
 
655
        self.assertEqual(
 
656
            {'m':('r0', 'r1', 'r2', 'r3')}, f.get_parent_map(['m']))
 
657
        self.assertEqual({}, f.get_parent_map('y'))
 
658
        self.assertEqual(
 
659
            {'r0':(),
 
660
             'r1':('r0',)},
 
661
            f.get_parent_map(['r0', 'y', 'r1']))
499
662
 
500
663
    def test_annotate(self):
501
664
        f = self.get_file()
508
671
        self.assertRaises(RevisionNotPresent,
509
672
            f.annotate, 'foo')
510
673
 
511
 
    def test_walk(self):
512
 
        # tests that walk returns all the inclusions for the requested
513
 
        # revisions as well as the revisions changes themselves.
514
 
        f = self.get_file('1')
515
 
        f.add_lines('r0', [], ['a\n', 'b\n'])
516
 
        f.add_lines('r1', ['r0'], ['c\n', 'b\n'])
517
 
        f.add_lines('rX', ['r1'], ['d\n', 'b\n'])
518
 
        f.add_lines('rY', ['r1'], ['c\n', 'e\n'])
519
 
 
520
 
        lines = {}
521
 
        for lineno, insert, dset, text in f.walk(['rX', 'rY']):
522
 
            lines[text] = (insert, dset)
523
 
 
524
 
        self.assertTrue(lines['a\n'], ('r0', set(['r1'])))
525
 
        self.assertTrue(lines['b\n'], ('r0', set(['rY'])))
526
 
        self.assertTrue(lines['c\n'], ('r1', set(['rX'])))
527
 
        self.assertTrue(lines['d\n'], ('rX', set([])))
528
 
        self.assertTrue(lines['e\n'], ('rY', set([])))
529
 
 
530
674
    def test_detection(self):
531
675
        # Test weaves detect corruption.
532
676
        #
587
731
                     ['base\n', 'lancestor\n', 'otherchild\n'])
588
732
        def iter_with_versions(versions, expected):
589
733
            # now we need to see what lines are returned, and how often.
590
 
            lines = {'base\n':0,
591
 
                     'lancestor\n':0,
592
 
                     'rancestor\n':0,
593
 
                     'child\n':0,
594
 
                     'otherchild\n':0,
595
 
                     }
 
734
            lines = {}
596
735
            progress = InstrumentedProgress()
597
736
            # iterate over the lines
598
 
            for line in vf.iter_lines_added_or_present_in_versions(versions, 
 
737
            for line in vf.iter_lines_added_or_present_in_versions(versions,
599
738
                pb=progress):
 
739
                lines.setdefault(line, 0)
600
740
                lines[line] += 1
601
 
            if []!= progress.updates: 
 
741
            if []!= progress.updates:
602
742
                self.assertEqual(expected, progress.updates)
603
743
            return lines
604
744
        lines = iter_with_versions(['child', 'otherchild'],
606
746
                                    ('Walking content.', 1, 2),
607
747
                                    ('Walking content.', 2, 2)])
608
748
        # we must see child and otherchild
609
 
        self.assertTrue(lines['child\n'] > 0)
610
 
        self.assertTrue(lines['otherchild\n'] > 0)
 
749
        self.assertTrue(lines[('child\n', 'child')] > 0)
 
750
        self.assertTrue(lines[('otherchild\n', 'otherchild')] > 0)
611
751
        # we dont care if we got more than that.
612
752
        
613
753
        # test all lines
618
758
                                          ('Walking content.', 4, 5),
619
759
                                          ('Walking content.', 5, 5)])
620
760
        # all lines must be seen at least once
621
 
        self.assertTrue(lines['base\n'] > 0)
622
 
        self.assertTrue(lines['lancestor\n'] > 0)
623
 
        self.assertTrue(lines['rancestor\n'] > 0)
624
 
        self.assertTrue(lines['child\n'] > 0)
625
 
        self.assertTrue(lines['otherchild\n'] > 0)
626
 
 
627
 
    def test_fix_parents(self):
628
 
        # some versioned files allow incorrect parents to be corrected after
629
 
        # insertion - this may not fix ancestry..
630
 
        # if they do not supported, they just do not implement it.
631
 
        # we test this as an interface test to ensure that those that *do*
632
 
        # implementent it get it right.
633
 
        vf = self.get_file()
634
 
        vf.add_lines('notbase', [], [])
635
 
        vf.add_lines('base', [], [])
636
 
        try:
637
 
            vf.fix_parents('notbase', ['base'])
638
 
        except NotImplementedError:
639
 
            return
640
 
        self.assertEqual(['base'], vf.get_parents('notbase'))
641
 
        # open again, check it stuck.
642
 
        vf = self.get_file()
643
 
        self.assertEqual(['base'], vf.get_parents('notbase'))
644
 
 
645
 
    def test_fix_parents_with_ghosts(self):
646
 
        # when fixing parents, ghosts that are listed should not be ghosts
647
 
        # anymore.
648
 
        vf = self.get_file()
649
 
 
650
 
        try:
651
 
            vf.add_lines_with_ghosts('notbase', ['base', 'stillghost'], [])
652
 
        except NotImplementedError:
653
 
            return
654
 
        vf.add_lines('base', [], [])
655
 
        vf.fix_parents('notbase', ['base', 'stillghost'])
656
 
        self.assertEqual(['base'], vf.get_parents('notbase'))
657
 
        # open again, check it stuck.
658
 
        vf = self.get_file()
659
 
        self.assertEqual(['base'], vf.get_parents('notbase'))
660
 
        # and check the ghosts
661
 
        self.assertEqual(['base', 'stillghost'],
662
 
                         vf.get_parents_with_ghosts('notbase'))
 
761
        self.assertTrue(lines[('base\n', 'base')] > 0)
 
762
        self.assertTrue(lines[('lancestor\n', 'lancestor')] > 0)
 
763
        self.assertTrue(lines[('rancestor\n', 'rancestor')] > 0)
 
764
        self.assertTrue(lines[('child\n', 'child')] > 0)
 
765
        self.assertTrue(lines[('otherchild\n', 'otherchild')] > 0)
663
766
 
664
767
    def test_add_lines_with_ghosts(self):
665
768
        # some versioned file formats allow lines to be added with parent
672
775
        parent_id_unicode = u'b\xbfse'
673
776
        parent_id_utf8 = parent_id_unicode.encode('utf8')
674
777
        try:
675
 
            vf.add_lines_with_ghosts(u'notbxbfse', [parent_id_utf8], [])
 
778
            vf.add_lines_with_ghosts('notbxbfse', [parent_id_utf8], [])
676
779
        except NotImplementedError:
677
780
            # check the other ghost apis are also not implemented
678
 
            self.assertRaises(NotImplementedError, vf.has_ghost, 'foo')
679
781
            self.assertRaises(NotImplementedError, vf.get_ancestry_with_ghosts, ['foo'])
680
782
            self.assertRaises(NotImplementedError, vf.get_parents_with_ghosts, 'foo')
681
 
            self.assertRaises(NotImplementedError, vf.get_graph_with_ghosts)
682
783
            return
683
784
        vf = self.reopen_file()
684
785
        # test key graph related apis: getncestry, _graph, get_parents
685
786
        # has_version
686
787
        # - these are ghost unaware and must not be reflect ghosts
687
788
        self.assertEqual(['notbxbfse'], vf.get_ancestry('notbxbfse'))
688
 
        self.assertEqual([], vf.get_parents('notbxbfse'))
689
 
        self.assertEqual({'notbxbfse':[]}, vf.get_graph())
690
 
        self.assertFalse(vf.has_version(parent_id_unicode))
691
789
        self.assertFalse(vf.has_version(parent_id_utf8))
692
790
        # we have _with_ghost apis to give us ghost information.
693
791
        self.assertEqual([parent_id_utf8, 'notbxbfse'], vf.get_ancestry_with_ghosts(['notbxbfse']))
694
792
        self.assertEqual([parent_id_utf8], vf.get_parents_with_ghosts('notbxbfse'))
695
 
        self.assertEqual({'notbxbfse':[parent_id_utf8]}, vf.get_graph_with_ghosts())
696
 
        self.assertTrue(vf.has_ghost(parent_id_unicode))
697
 
        self.assertTrue(vf.has_ghost(parent_id_utf8))
698
793
        # if we add something that is a ghost of another, it should correct the
699
794
        # results of the prior apis
700
 
        vf.add_lines(parent_id_unicode, [], [])
 
795
        vf.add_lines(parent_id_utf8, [], [])
701
796
        self.assertEqual([parent_id_utf8, 'notbxbfse'], vf.get_ancestry(['notbxbfse']))
702
 
        self.assertEqual([parent_id_utf8], vf.get_parents('notbxbfse'))
703
 
        self.assertEqual({parent_id_utf8:[],
704
 
                          'notbxbfse':[parent_id_utf8],
705
 
                          },
706
 
                         vf.get_graph())
707
 
        self.assertTrue(vf.has_version(parent_id_unicode))
 
797
        self.assertEqual({'notbxbfse':(parent_id_utf8,)},
 
798
            vf.get_parent_map(['notbxbfse']))
708
799
        self.assertTrue(vf.has_version(parent_id_utf8))
709
800
        # we have _with_ghost apis to give us ghost information.
710
 
        self.assertEqual([parent_id_utf8, 'notbxbfse'], vf.get_ancestry_with_ghosts(['notbxbfse']))
 
801
        self.assertEqual([parent_id_utf8, 'notbxbfse'],
 
802
            vf.get_ancestry_with_ghosts(['notbxbfse']))
711
803
        self.assertEqual([parent_id_utf8], vf.get_parents_with_ghosts('notbxbfse'))
712
 
        self.assertEqual({parent_id_utf8:[],
713
 
                          'notbxbfse':[parent_id_utf8],
714
 
                          },
715
 
                         vf.get_graph_with_ghosts())
716
 
        self.assertFalse(vf.has_ghost(parent_id_unicode))
717
 
        self.assertFalse(vf.has_ghost(parent_id_utf8))
718
804
 
719
805
    def test_add_lines_with_ghosts_after_normal_revs(self):
720
806
        # some versioned file formats allow lines to be added with parent
724
810
        vf = self.get_file()
725
811
        # probe for ghost support
726
812
        try:
727
 
            vf.has_ghost('hoo')
 
813
            vf.add_lines_with_ghosts('base', [], ['line\n', 'line_b\n'])
728
814
        except NotImplementedError:
729
815
            return
730
 
        vf.add_lines_with_ghosts('base', [], ['line\n', 'line_b\n'])
731
816
        vf.add_lines_with_ghosts('references_ghost',
732
817
                                 ['base', 'a_ghost'],
733
818
                                 ['line\n', 'line_b\n', 'line_c\n'])
741
826
        factory = self.get_factory()
742
827
        vf = factory('id', transport, 0777, create=True, access_mode='w')
743
828
        vf = factory('id', transport, access_mode='r')
744
 
        self.assertRaises(errors.ReadOnlyError, vf.add_delta, '', [], '', '', False, [])
745
829
        self.assertRaises(errors.ReadOnlyError, vf.add_lines, 'base', [], [])
746
830
        self.assertRaises(errors.ReadOnlyError,
747
831
                          vf.add_lines_with_ghosts,
748
832
                          'base',
749
833
                          [],
750
834
                          [])
751
 
        self.assertRaises(errors.ReadOnlyError, vf.fix_parents, 'base', [])
752
 
        self.assertRaises(errors.ReadOnlyError, vf.join, 'base')
753
 
        self.assertRaises(errors.ReadOnlyError, vf.clone_text, 'base', 'bar', ['foo'])
754
835
    
755
 
    def test_get_sha1(self):
 
836
    def test_get_sha1s(self):
756
837
        # check the sha1 data is available
757
838
        vf = self.get_file()
758
839
        # a simple file
761
842
        vf.add_lines('b', ['a'], ['a\n'])
762
843
        # a file differing only in last newline.
763
844
        vf.add_lines('c', [], ['a'])
764
 
        self.assertEqual(
765
 
            '3f786850e387550fdab836ed7e6dc881de23001b', vf.get_sha1('a'))
766
 
        self.assertEqual(
767
 
            '3f786850e387550fdab836ed7e6dc881de23001b', vf.get_sha1('b'))
768
 
        self.assertEqual(
769
 
            '86f7e437faa5a7fce15d1ddcb9eaeaea377667b8', vf.get_sha1('c'))
 
845
        self.assertEqual({
 
846
            'a': '3f786850e387550fdab836ed7e6dc881de23001b',
 
847
            'c': '86f7e437faa5a7fce15d1ddcb9eaeaea377667b8',
 
848
            'b': '3f786850e387550fdab836ed7e6dc881de23001b',
 
849
            },
 
850
            vf.get_sha1s(['a', 'c', 'b']))
770
851
        
771
852
 
772
 
class TestWeave(TestCaseWithTransport, VersionedFileTestMixIn):
 
853
class TestWeave(TestCaseWithMemoryTransport, VersionedFileTestMixIn):
773
854
 
774
855
    def get_file(self, name='foo'):
775
 
        return WeaveFile(name, get_transport(self.get_url('.')), create=True)
 
856
        return WeaveFile(name, get_transport(self.get_url('.')), create=True,
 
857
            get_scope=self.get_transaction)
776
858
 
777
859
    def get_file_corrupted_text(self):
778
 
        w = WeaveFile('foo', get_transport(self.get_url('.')), create=True)
 
860
        w = WeaveFile('foo', get_transport(self.get_url('.')), create=True,
 
861
            get_scope=self.get_transaction)
779
862
        w.add_lines('v1', [], ['hello\n'])
780
863
        w.add_lines('v2', ['v1'], ['hello\n', 'there\n'])
781
864
        
809
892
        return w
810
893
 
811
894
    def reopen_file(self, name='foo', create=False):
812
 
        return WeaveFile(name, get_transport(self.get_url('.')), create=create)
 
895
        return WeaveFile(name, get_transport(self.get_url('.')), create=create,
 
896
            get_scope=self.get_transaction)
813
897
 
814
898
    def test_no_implicit_create(self):
815
899
        self.assertRaises(errors.NoSuchFile,
816
900
                          WeaveFile,
817
901
                          'foo',
818
 
                          get_transport(self.get_url('.')))
 
902
                          get_transport(self.get_url('.')),
 
903
                          get_scope=self.get_transaction)
819
904
 
820
905
    def get_factory(self):
821
906
        return WeaveFile
822
907
 
823
908
 
824
 
class TestKnit(TestCaseWithTransport, VersionedFileTestMixIn):
825
 
 
826
 
    def get_file(self, name='foo'):
827
 
        return KnitVersionedFile(name, get_transport(self.get_url('.')),
828
 
                                 delta=True, create=True)
829
 
 
830
 
    def get_factory(self):
831
 
        return KnitVersionedFile
832
 
 
833
 
    def get_file_corrupted_text(self):
834
 
        knit = self.get_file()
835
 
        knit.add_lines('v1', [], ['hello\n'])
836
 
        knit.add_lines('v2', ['v1'], ['hello\n', 'there\n'])
837
 
        return knit
838
 
 
839
 
    def reopen_file(self, name='foo', create=False):
840
 
        return KnitVersionedFile(name, get_transport(self.get_url('.')),
841
 
            delta=True,
842
 
            create=create)
843
 
 
844
 
    def test_detection(self):
845
 
        knit = self.get_file()
846
 
        knit.check()
847
 
 
848
 
    def test_no_implicit_create(self):
849
 
        self.assertRaises(errors.NoSuchFile,
850
 
                          KnitVersionedFile,
851
 
                          'foo',
852
 
                          get_transport(self.get_url('.')))
853
 
 
854
 
 
855
 
class InterString(versionedfile.InterVersionedFile):
856
 
    """An inter-versionedfile optimised code path for strings.
857
 
 
858
 
    This is for use during testing where we use strings as versionedfiles
859
 
    so that none of the default regsitered interversionedfile classes will
860
 
    match - which lets us test the match logic.
861
 
    """
862
 
 
863
 
    @staticmethod
864
 
    def is_compatible(source, target):
865
 
        """InterString is compatible with strings-as-versionedfiles."""
866
 
        return isinstance(source, str) and isinstance(target, str)
867
 
 
868
 
 
869
 
# TODO this and the InterRepository core logic should be consolidatable
870
 
# if we make the registry a separate class though we still need to 
871
 
# test the behaviour in the active registry to catch failure-to-handle-
872
 
# stange-objects
873
 
class TestInterVersionedFile(TestCaseWithTransport):
874
 
 
875
 
    def test_get_default_inter_versionedfile(self):
876
 
        # test that the InterVersionedFile.get(a, b) probes
877
 
        # for a class where is_compatible(a, b) returns
878
 
        # true and returns a default interversionedfile otherwise.
879
 
        # This also tests that the default registered optimised interversionedfile
880
 
        # classes do not barf inappropriately when a surprising versionedfile type
881
 
        # is handed to them.
882
 
        dummy_a = "VersionedFile 1."
883
 
        dummy_b = "VersionedFile 2."
884
 
        self.assertGetsDefaultInterVersionedFile(dummy_a, dummy_b)
885
 
 
886
 
    def assertGetsDefaultInterVersionedFile(self, a, b):
887
 
        """Asserts that InterVersionedFile.get(a, b) -> the default."""
888
 
        inter = versionedfile.InterVersionedFile.get(a, b)
889
 
        self.assertEqual(versionedfile.InterVersionedFile,
890
 
                         inter.__class__)
891
 
        self.assertEqual(a, inter.source)
892
 
        self.assertEqual(b, inter.target)
893
 
 
894
 
    def test_register_inter_versionedfile_class(self):
895
 
        # test that a optimised code path provider - a
896
 
        # InterVersionedFile subclass can be registered and unregistered
897
 
        # and that it is correctly selected when given a versionedfile
898
 
        # pair that it returns true on for the is_compatible static method
899
 
        # check
900
 
        dummy_a = "VersionedFile 1."
901
 
        dummy_b = "VersionedFile 2."
902
 
        versionedfile.InterVersionedFile.register_optimiser(InterString)
903
 
        try:
904
 
            # we should get the default for something InterString returns False
905
 
            # to
906
 
            self.assertFalse(InterString.is_compatible(dummy_a, None))
907
 
            self.assertGetsDefaultInterVersionedFile(dummy_a, None)
908
 
            # and we should get an InterString for a pair it 'likes'
909
 
            self.assertTrue(InterString.is_compatible(dummy_a, dummy_b))
910
 
            inter = versionedfile.InterVersionedFile.get(dummy_a, dummy_b)
911
 
            self.assertEqual(InterString, inter.__class__)
912
 
            self.assertEqual(dummy_a, inter.source)
913
 
            self.assertEqual(dummy_b, inter.target)
914
 
        finally:
915
 
            versionedfile.InterVersionedFile.unregister_optimiser(InterString)
916
 
        # now we should get the default InterVersionedFile object again.
917
 
        self.assertGetsDefaultInterVersionedFile(dummy_a, dummy_b)
 
909
class TestPlanMergeVersionedFile(TestCaseWithMemoryTransport):
 
910
 
 
911
    def setUp(self):
 
912
        TestCaseWithMemoryTransport.setUp(self)
 
913
        mapper = PrefixMapper()
 
914
        factory = make_file_factory(True, mapper)
 
915
        self.vf1 = factory(self.get_transport('root-1'))
 
916
        self.vf2 = factory(self.get_transport('root-2'))
 
917
        self.plan_merge_vf = versionedfile._PlanMergeVersionedFile('root')
 
918
        self.plan_merge_vf.fallback_versionedfiles.extend([self.vf1, self.vf2])
 
919
 
 
920
    def test_add_lines(self):
 
921
        self.plan_merge_vf.add_lines(('root', 'a:'), [], [])
 
922
        self.assertRaises(ValueError, self.plan_merge_vf.add_lines,
 
923
            ('root', 'a'), [], [])
 
924
        self.assertRaises(ValueError, self.plan_merge_vf.add_lines,
 
925
            ('root', 'a:'), None, [])
 
926
        self.assertRaises(ValueError, self.plan_merge_vf.add_lines,
 
927
            ('root', 'a:'), [], None)
 
928
 
 
929
    def setup_abcde(self):
 
930
        self.vf1.add_lines(('root', 'A'), [], ['a'])
 
931
        self.vf1.add_lines(('root', 'B'), [('root', 'A')], ['b'])
 
932
        self.vf2.add_lines(('root', 'C'), [], ['c'])
 
933
        self.vf2.add_lines(('root', 'D'), [('root', 'C')], ['d'])
 
934
        self.plan_merge_vf.add_lines(('root', 'E:'),
 
935
            [('root', 'B'), ('root', 'D')], ['e'])
 
936
 
 
937
    def test_get_parents(self):
 
938
        self.setup_abcde()
 
939
        self.assertEqual({('root', 'B'):(('root', 'A'),)},
 
940
            self.plan_merge_vf.get_parent_map([('root', 'B')]))
 
941
        self.assertEqual({('root', 'D'):(('root', 'C'),)},
 
942
            self.plan_merge_vf.get_parent_map([('root', 'D')]))
 
943
        self.assertEqual({('root', 'E:'):(('root', 'B'),('root', 'D'))},
 
944
            self.plan_merge_vf.get_parent_map([('root', 'E:')]))
 
945
        self.assertEqual({},
 
946
            self.plan_merge_vf.get_parent_map([('root', 'F')]))
 
947
        self.assertEqual({
 
948
                ('root', 'B'):(('root', 'A'),),
 
949
                ('root', 'D'):(('root', 'C'),),
 
950
                ('root', 'E:'):(('root', 'B'),('root', 'D')),
 
951
                },
 
952
            self.plan_merge_vf.get_parent_map(
 
953
                [('root', 'B'), ('root', 'D'), ('root', 'E:'), ('root', 'F')]))
 
954
 
 
955
    def test_get_record_stream(self):
 
956
        self.setup_abcde()
 
957
        def get_record(suffix):
 
958
            return self.plan_merge_vf.get_record_stream(
 
959
                [('root', suffix)], 'unordered', True).next()
 
960
        self.assertEqual('a', get_record('A').get_bytes_as('fulltext'))
 
961
        self.assertEqual('c', get_record('C').get_bytes_as('fulltext'))
 
962
        self.assertEqual('e', get_record('E:').get_bytes_as('fulltext'))
 
963
        self.assertEqual('absent', get_record('F').storage_kind)
918
964
 
919
965
 
920
966
class TestReadonlyHttpMixin(object):
921
967
 
 
968
    def get_transaction(self):
 
969
        return 1
 
970
 
922
971
    def test_readonly_http_works(self):
923
972
        # we should be able to read from http with a versioned file.
924
973
        vf = self.get_file()
937
986
class TestWeaveHTTP(TestCaseWithWebserver, TestReadonlyHttpMixin):
938
987
 
939
988
    def get_file(self):
940
 
        return WeaveFile('foo', get_transport(self.get_url('.')), create=True)
 
989
        return WeaveFile('foo', get_transport(self.get_url('.')), create=True,
 
990
            get_scope=self.get_transaction)
941
991
 
942
992
    def get_factory(self):
943
993
        return WeaveFile
944
994
 
945
995
 
946
 
class TestKnitHTTP(TestCaseWithWebserver, TestReadonlyHttpMixin):
947
 
 
948
 
    def get_file(self):
949
 
        return KnitVersionedFile('foo', get_transport(self.get_url('.')),
950
 
                                 delta=True, create=True)
951
 
 
952
 
    def get_factory(self):
953
 
        return KnitVersionedFile
954
 
 
955
 
 
956
996
class MergeCasesMixin(object):
957
997
 
958
998
    def doMerge(self, base, a, b, mp):
1190
1230
        self._test_merge_from_strings(base, a, b, result)
1191
1231
 
1192
1232
 
1193
 
class TestKnitMerge(TestCaseWithTransport, MergeCasesMixin):
1194
 
 
1195
 
    def get_file(self, name='foo'):
1196
 
        return KnitVersionedFile(name, get_transport(self.get_url('.')),
1197
 
                                 delta=True, create=True)
1198
 
 
1199
 
    def log_contents(self, w):
1200
 
        pass
1201
 
 
1202
 
 
1203
 
class TestWeaveMerge(TestCaseWithTransport, MergeCasesMixin):
 
1233
class TestWeaveMerge(TestCaseWithMemoryTransport, MergeCasesMixin):
1204
1234
 
1205
1235
    def get_file(self, name='foo'):
1206
1236
        return WeaveFile(name, get_transport(self.get_url('.')), create=True)
1213
1243
 
1214
1244
    overlappedInsertExpected = ['aaa', '<<<<<<< ', 'xxx', 'yyy', '=======', 
1215
1245
                                'xxx', '>>>>>>> ', 'bbb']
 
1246
 
 
1247
 
 
1248
class TestContentFactoryAdaption(TestCaseWithMemoryTransport):
 
1249
 
 
1250
    def test_select_adaptor(self):
 
1251
        """Test expected adapters exist."""
 
1252
        # One scenario for each lookup combination we expect to use.
 
1253
        # Each is source_kind, requested_kind, adapter class
 
1254
        scenarios = [
 
1255
            ('knit-delta-gz', 'fulltext', _mod_knit.DeltaPlainToFullText),
 
1256
            ('knit-ft-gz', 'fulltext', _mod_knit.FTPlainToFullText),
 
1257
            ('knit-annotated-delta-gz', 'knit-delta-gz',
 
1258
                _mod_knit.DeltaAnnotatedToUnannotated),
 
1259
            ('knit-annotated-delta-gz', 'fulltext',
 
1260
                _mod_knit.DeltaAnnotatedToFullText),
 
1261
            ('knit-annotated-ft-gz', 'knit-ft-gz',
 
1262
                _mod_knit.FTAnnotatedToUnannotated),
 
1263
            ('knit-annotated-ft-gz', 'fulltext',
 
1264
                _mod_knit.FTAnnotatedToFullText),
 
1265
            ]
 
1266
        for source, requested, klass in scenarios:
 
1267
            adapter_factory = versionedfile.adapter_registry.get(
 
1268
                (source, requested))
 
1269
            adapter = adapter_factory(None)
 
1270
            self.assertIsInstance(adapter, klass)
 
1271
 
 
1272
    def get_knit(self, annotated=True):
 
1273
        mapper = ConstantMapper('knit')
 
1274
        transport = self.get_transport()
 
1275
        return make_file_factory(annotated, mapper)(transport)
 
1276
 
 
1277
    def helpGetBytes(self, f, ft_adapter, delta_adapter):
 
1278
        """Grab the interested adapted texts for tests."""
 
1279
        # origin is a fulltext
 
1280
        entries = f.get_record_stream([('origin',)], 'unordered', False)
 
1281
        base = entries.next()
 
1282
        ft_data = ft_adapter.get_bytes(base, base.get_bytes_as(base.storage_kind))
 
1283
        # merged is both a delta and multiple parents.
 
1284
        entries = f.get_record_stream([('merged',)], 'unordered', False)
 
1285
        merged = entries.next()
 
1286
        delta_data = delta_adapter.get_bytes(merged,
 
1287
            merged.get_bytes_as(merged.storage_kind))
 
1288
        return ft_data, delta_data
 
1289
 
 
1290
    def test_deannotation_noeol(self):
 
1291
        """Test converting annotated knits to unannotated knits."""
 
1292
        # we need a full text, and a delta
 
1293
        f = self.get_knit()
 
1294
        get_diamond_files(f, 1, trailing_eol=False)
 
1295
        ft_data, delta_data = self.helpGetBytes(f,
 
1296
            _mod_knit.FTAnnotatedToUnannotated(None),
 
1297
            _mod_knit.DeltaAnnotatedToUnannotated(None))
 
1298
        self.assertEqual(
 
1299
            'version origin 1 b284f94827db1fa2970d9e2014f080413b547a7e\n'
 
1300
            'origin\n'
 
1301
            'end origin\n',
 
1302
            GzipFile(mode='rb', fileobj=StringIO(ft_data)).read())
 
1303
        self.assertEqual(
 
1304
            'version merged 4 32c2e79763b3f90e8ccde37f9710b6629c25a796\n'
 
1305
            '1,2,3\nleft\nright\nmerged\nend merged\n',
 
1306
            GzipFile(mode='rb', fileobj=StringIO(delta_data)).read())
 
1307
 
 
1308
    def test_deannotation(self):
 
1309
        """Test converting annotated knits to unannotated knits."""
 
1310
        # we need a full text, and a delta
 
1311
        f = self.get_knit()
 
1312
        get_diamond_files(f, 1)
 
1313
        ft_data, delta_data = self.helpGetBytes(f,
 
1314
            _mod_knit.FTAnnotatedToUnannotated(None),
 
1315
            _mod_knit.DeltaAnnotatedToUnannotated(None))
 
1316
        self.assertEqual(
 
1317
            'version origin 1 00e364d235126be43292ab09cb4686cf703ddc17\n'
 
1318
            'origin\n'
 
1319
            'end origin\n',
 
1320
            GzipFile(mode='rb', fileobj=StringIO(ft_data)).read())
 
1321
        self.assertEqual(
 
1322
            'version merged 3 ed8bce375198ea62444dc71952b22cfc2b09226d\n'
 
1323
            '2,2,2\nright\nmerged\nend merged\n',
 
1324
            GzipFile(mode='rb', fileobj=StringIO(delta_data)).read())
 
1325
 
 
1326
    def test_annotated_to_fulltext_no_eol(self):
 
1327
        """Test adapting annotated knits to full texts (for -> weaves)."""
 
1328
        # we need a full text, and a delta
 
1329
        f = self.get_knit()
 
1330
        get_diamond_files(f, 1, trailing_eol=False)
 
1331
        # Reconstructing a full text requires a backing versioned file, and it
 
1332
        # must have the base lines requested from it.
 
1333
        logged_vf = versionedfile.RecordingVersionedFilesDecorator(f)
 
1334
        ft_data, delta_data = self.helpGetBytes(f,
 
1335
            _mod_knit.FTAnnotatedToFullText(None),
 
1336
            _mod_knit.DeltaAnnotatedToFullText(logged_vf))
 
1337
        self.assertEqual('origin', ft_data)
 
1338
        self.assertEqual('base\nleft\nright\nmerged', delta_data)
 
1339
        self.assertEqual([('get_record_stream', [('left',)], 'unordered',
 
1340
            True)], logged_vf.calls)
 
1341
 
 
1342
    def test_annotated_to_fulltext(self):
 
1343
        """Test adapting annotated knits to full texts (for -> weaves)."""
 
1344
        # we need a full text, and a delta
 
1345
        f = self.get_knit()
 
1346
        get_diamond_files(f, 1)
 
1347
        # Reconstructing a full text requires a backing versioned file, and it
 
1348
        # must have the base lines requested from it.
 
1349
        logged_vf = versionedfile.RecordingVersionedFilesDecorator(f)
 
1350
        ft_data, delta_data = self.helpGetBytes(f,
 
1351
            _mod_knit.FTAnnotatedToFullText(None),
 
1352
            _mod_knit.DeltaAnnotatedToFullText(logged_vf))
 
1353
        self.assertEqual('origin\n', ft_data)
 
1354
        self.assertEqual('base\nleft\nright\nmerged\n', delta_data)
 
1355
        self.assertEqual([('get_record_stream', [('left',)], 'unordered',
 
1356
            True)], logged_vf.calls)
 
1357
 
 
1358
    def test_unannotated_to_fulltext(self):
 
1359
        """Test adapting unannotated knits to full texts.
 
1360
        
 
1361
        This is used for -> weaves, and for -> annotated knits.
 
1362
        """
 
1363
        # we need a full text, and a delta
 
1364
        f = self.get_knit(annotated=False)
 
1365
        get_diamond_files(f, 1)
 
1366
        # Reconstructing a full text requires a backing versioned file, and it
 
1367
        # must have the base lines requested from it.
 
1368
        logged_vf = versionedfile.RecordingVersionedFilesDecorator(f)
 
1369
        ft_data, delta_data = self.helpGetBytes(f,
 
1370
            _mod_knit.FTPlainToFullText(None),
 
1371
            _mod_knit.DeltaPlainToFullText(logged_vf))
 
1372
        self.assertEqual('origin\n', ft_data)
 
1373
        self.assertEqual('base\nleft\nright\nmerged\n', delta_data)
 
1374
        self.assertEqual([('get_record_stream', [('left',)], 'unordered',
 
1375
            True)], logged_vf.calls)
 
1376
 
 
1377
    def test_unannotated_to_fulltext_no_eol(self):
 
1378
        """Test adapting unannotated knits to full texts.
 
1379
        
 
1380
        This is used for -> weaves, and for -> annotated knits.
 
1381
        """
 
1382
        # we need a full text, and a delta
 
1383
        f = self.get_knit(annotated=False)
 
1384
        get_diamond_files(f, 1, trailing_eol=False)
 
1385
        # Reconstructing a full text requires a backing versioned file, and it
 
1386
        # must have the base lines requested from it.
 
1387
        logged_vf = versionedfile.RecordingVersionedFilesDecorator(f)
 
1388
        ft_data, delta_data = self.helpGetBytes(f,
 
1389
            _mod_knit.FTPlainToFullText(None),
 
1390
            _mod_knit.DeltaPlainToFullText(logged_vf))
 
1391
        self.assertEqual('origin', ft_data)
 
1392
        self.assertEqual('base\nleft\nright\nmerged', delta_data)
 
1393
        self.assertEqual([('get_record_stream', [('left',)], 'unordered',
 
1394
            True)], logged_vf.calls)
 
1395
 
 
1396
 
 
1397
class TestKeyMapper(TestCaseWithMemoryTransport):
 
1398
    """Tests for various key mapping logic."""
 
1399
 
 
1400
    def test_identity_mapper(self):
 
1401
        mapper = versionedfile.ConstantMapper("inventory")
 
1402
        self.assertEqual("inventory", mapper.map(('foo@ar',)))
 
1403
        self.assertEqual("inventory", mapper.map(('quux',)))
 
1404
 
 
1405
    def test_prefix_mapper(self):
 
1406
        #format5: plain
 
1407
        mapper = versionedfile.PrefixMapper()
 
1408
        self.assertEqual("file-id", mapper.map(("file-id", "revision-id")))
 
1409
        self.assertEqual("new-id", mapper.map(("new-id", "revision-id")))
 
1410
        self.assertEqual(('file-id',), mapper.unmap("file-id"))
 
1411
        self.assertEqual(('new-id',), mapper.unmap("new-id"))
 
1412
 
 
1413
    def test_hash_prefix_mapper(self):
 
1414
        #format6: hash + plain
 
1415
        mapper = versionedfile.HashPrefixMapper()
 
1416
        self.assertEqual("9b/file-id", mapper.map(("file-id", "revision-id")))
 
1417
        self.assertEqual("45/new-id", mapper.map(("new-id", "revision-id")))
 
1418
        self.assertEqual(('file-id',), mapper.unmap("9b/file-id"))
 
1419
        self.assertEqual(('new-id',), mapper.unmap("45/new-id"))
 
1420
 
 
1421
    def test_hash_escaped_mapper(self):
 
1422
        #knit1: hash + escaped
 
1423
        mapper = versionedfile.HashEscapedPrefixMapper()
 
1424
        self.assertEqual("88/%2520", mapper.map((" ", "revision-id")))
 
1425
        self.assertEqual("ed/fil%2545-%2549d", mapper.map(("filE-Id",
 
1426
            "revision-id")))
 
1427
        self.assertEqual("88/ne%2557-%2549d", mapper.map(("neW-Id",
 
1428
            "revision-id")))
 
1429
        self.assertEqual(('filE-Id',), mapper.unmap("ed/fil%2545-%2549d"))
 
1430
        self.assertEqual(('neW-Id',), mapper.unmap("88/ne%2557-%2549d"))
 
1431
 
 
1432
 
 
1433
class TestVersionedFiles(TestCaseWithMemoryTransport):
 
1434
    """Tests for the multiple-file variant of VersionedFile."""
 
1435
 
 
1436
    def get_versionedfiles(self, relpath='files'):
 
1437
        transport = self.get_transport(relpath)
 
1438
        if relpath != '.':
 
1439
            transport.mkdir('.')
 
1440
        files = self.factory(transport)
 
1441
        if self.cleanup is not None:
 
1442
            self.addCleanup(lambda:self.cleanup(files))
 
1443
        return files
 
1444
 
 
1445
    def test_annotate(self):
 
1446
        files = self.get_versionedfiles()
 
1447
        self.get_diamond_files(files)
 
1448
        if self.key_length == 1:
 
1449
            prefix = ()
 
1450
        else:
 
1451
            prefix = ('FileA',)
 
1452
        # introduced full text
 
1453
        origins = files.annotate(prefix + ('origin',))
 
1454
        self.assertEqual([
 
1455
            (prefix + ('origin',), 'origin\n')],
 
1456
            origins)
 
1457
        # a delta
 
1458
        origins = files.annotate(prefix + ('base',))
 
1459
        self.assertEqual([
 
1460
            (prefix + ('base',), 'base\n')],
 
1461
            origins)
 
1462
        # a merge
 
1463
        origins = files.annotate(prefix + ('merged',))
 
1464
        if self.graph:
 
1465
            self.assertEqual([
 
1466
                (prefix + ('base',), 'base\n'),
 
1467
                (prefix + ('left',), 'left\n'),
 
1468
                (prefix + ('right',), 'right\n'),
 
1469
                (prefix + ('merged',), 'merged\n')
 
1470
                ],
 
1471
                origins)
 
1472
        else:
 
1473
            # Without a graph everything is new.
 
1474
            self.assertEqual([
 
1475
                (prefix + ('merged',), 'base\n'),
 
1476
                (prefix + ('merged',), 'left\n'),
 
1477
                (prefix + ('merged',), 'right\n'),
 
1478
                (prefix + ('merged',), 'merged\n')
 
1479
                ],
 
1480
                origins)
 
1481
        self.assertRaises(RevisionNotPresent,
 
1482
            files.annotate, prefix + ('missing-key',))
 
1483
 
 
1484
    def test_construct(self):
 
1485
        """Each parameterised test can be constructed on a transport."""
 
1486
        files = self.get_versionedfiles()
 
1487
 
 
1488
    def get_diamond_files(self, files, trailing_eol=True, left_only=False):
 
1489
        return get_diamond_files(files, self.key_length,
 
1490
            trailing_eol=trailing_eol, nograph=not self.graph,
 
1491
            left_only=left_only)
 
1492
 
 
1493
    def test_add_lines_return(self):
 
1494
        files = self.get_versionedfiles()
 
1495
        # save code by using the stock data insertion helper.
 
1496
        adds = self.get_diamond_files(files)
 
1497
        results = []
 
1498
        # We can only validate the first 2 elements returned from add_lines.
 
1499
        for add in adds:
 
1500
            self.assertEqual(3, len(add))
 
1501
            results.append(add[:2])
 
1502
        if self.key_length == 1:
 
1503
            self.assertEqual([
 
1504
                ('00e364d235126be43292ab09cb4686cf703ddc17', 7),
 
1505
                ('51c64a6f4fc375daf0d24aafbabe4d91b6f4bb44', 5),
 
1506
                ('a8478686da38e370e32e42e8a0c220e33ee9132f', 10),
 
1507
                ('9ef09dfa9d86780bdec9219a22560c6ece8e0ef1', 11),
 
1508
                ('ed8bce375198ea62444dc71952b22cfc2b09226d', 23)],
 
1509
                results)
 
1510
        elif self.key_length == 2:
 
1511
            self.assertEqual([
 
1512
                ('00e364d235126be43292ab09cb4686cf703ddc17', 7),
 
1513
                ('00e364d235126be43292ab09cb4686cf703ddc17', 7),
 
1514
                ('51c64a6f4fc375daf0d24aafbabe4d91b6f4bb44', 5),
 
1515
                ('51c64a6f4fc375daf0d24aafbabe4d91b6f4bb44', 5),
 
1516
                ('a8478686da38e370e32e42e8a0c220e33ee9132f', 10),
 
1517
                ('a8478686da38e370e32e42e8a0c220e33ee9132f', 10),
 
1518
                ('9ef09dfa9d86780bdec9219a22560c6ece8e0ef1', 11),
 
1519
                ('9ef09dfa9d86780bdec9219a22560c6ece8e0ef1', 11),
 
1520
                ('ed8bce375198ea62444dc71952b22cfc2b09226d', 23),
 
1521
                ('ed8bce375198ea62444dc71952b22cfc2b09226d', 23)],
 
1522
                results)
 
1523
 
 
1524
    def test_empty_lines(self):
 
1525
        """Empty files can be stored."""
 
1526
        f = self.get_versionedfiles()
 
1527
        key_a = self.get_simple_key('a')
 
1528
        f.add_lines(key_a, [], [])
 
1529
        self.assertEqual('',
 
1530
            f.get_record_stream([key_a], 'unordered', True
 
1531
                ).next().get_bytes_as('fulltext'))
 
1532
        key_b = self.get_simple_key('b')
 
1533
        f.add_lines(key_b, self.get_parents([key_a]), [])
 
1534
        self.assertEqual('',
 
1535
            f.get_record_stream([key_b], 'unordered', True
 
1536
                ).next().get_bytes_as('fulltext'))
 
1537
 
 
1538
    def test_newline_only(self):
 
1539
        f = self.get_versionedfiles()
 
1540
        key_a = self.get_simple_key('a')
 
1541
        f.add_lines(key_a, [], ['\n'])
 
1542
        self.assertEqual('\n',
 
1543
            f.get_record_stream([key_a], 'unordered', True
 
1544
                ).next().get_bytes_as('fulltext'))
 
1545
        key_b = self.get_simple_key('b')
 
1546
        f.add_lines(key_b, self.get_parents([key_a]), ['\n'])
 
1547
        self.assertEqual('\n',
 
1548
            f.get_record_stream([key_b], 'unordered', True
 
1549
                ).next().get_bytes_as('fulltext'))
 
1550
 
 
1551
    def test_get_record_stream_empty(self):
 
1552
        """An empty stream can be requested without error."""
 
1553
        f = self.get_versionedfiles()
 
1554
        entries = f.get_record_stream([], 'unordered', False)
 
1555
        self.assertEqual([], list(entries))
 
1556
 
 
1557
    def assertValidStorageKind(self, storage_kind):
 
1558
        """Assert that storage_kind is a valid storage_kind."""
 
1559
        self.assertSubset([storage_kind],
 
1560
            ['mpdiff', 'knit-annotated-ft', 'knit-annotated-delta',
 
1561
             'knit-ft', 'knit-delta', 'chunked', 'fulltext',
 
1562
             'knit-annotated-ft-gz', 'knit-annotated-delta-gz', 'knit-ft-gz',
 
1563
             'knit-delta-gz'])
 
1564
 
 
1565
    def capture_stream(self, f, entries, on_seen, parents):
 
1566
        """Capture a stream for testing."""
 
1567
        for factory in entries:
 
1568
            on_seen(factory.key)
 
1569
            self.assertValidStorageKind(factory.storage_kind)
 
1570
            self.assertEqual(f.get_sha1s([factory.key])[factory.key],
 
1571
                factory.sha1)
 
1572
            self.assertEqual(parents[factory.key], factory.parents)
 
1573
            self.assertIsInstance(factory.get_bytes_as(factory.storage_kind),
 
1574
                str)
 
1575
 
 
1576
    def test_get_record_stream_interface(self):
 
1577
        """each item in a stream has to provide a regular interface."""
 
1578
        files = self.get_versionedfiles()
 
1579
        self.get_diamond_files(files)
 
1580
        keys, _ = self.get_keys_and_sort_order()
 
1581
        parent_map = files.get_parent_map(keys)
 
1582
        entries = files.get_record_stream(keys, 'unordered', False)
 
1583
        seen = set()
 
1584
        self.capture_stream(files, entries, seen.add, parent_map)
 
1585
        self.assertEqual(set(keys), seen)
 
1586
 
 
1587
    def get_simple_key(self, suffix):
 
1588
        """Return a key for the object under test."""
 
1589
        if self.key_length == 1:
 
1590
            return (suffix,)
 
1591
        else:
 
1592
            return ('FileA',) + (suffix,)
 
1593
 
 
1594
    def get_keys_and_sort_order(self):
 
1595
        """Get diamond test keys list, and their sort ordering."""
 
1596
        if self.key_length == 1:
 
1597
            keys = [('merged',), ('left',), ('right',), ('base',)]
 
1598
            sort_order = {('merged',):2, ('left',):1, ('right',):1, ('base',):0}
 
1599
        else:
 
1600
            keys = [
 
1601
                ('FileA', 'merged'), ('FileA', 'left'), ('FileA', 'right'),
 
1602
                ('FileA', 'base'),
 
1603
                ('FileB', 'merged'), ('FileB', 'left'), ('FileB', 'right'),
 
1604
                ('FileB', 'base'),
 
1605
                ]
 
1606
            sort_order = {
 
1607
                ('FileA', 'merged'):2, ('FileA', 'left'):1, ('FileA', 'right'):1,
 
1608
                ('FileA', 'base'):0,
 
1609
                ('FileB', 'merged'):2, ('FileB', 'left'):1, ('FileB', 'right'):1,
 
1610
                ('FileB', 'base'):0,
 
1611
                }
 
1612
        return keys, sort_order
 
1613
 
 
1614
    def test_get_record_stream_interface_ordered(self):
 
1615
        """each item in a stream has to provide a regular interface."""
 
1616
        files = self.get_versionedfiles()
 
1617
        self.get_diamond_files(files)
 
1618
        keys, sort_order = self.get_keys_and_sort_order()
 
1619
        parent_map = files.get_parent_map(keys)
 
1620
        entries = files.get_record_stream(keys, 'topological', False)
 
1621
        seen = []
 
1622
        self.capture_stream(files, entries, seen.append, parent_map)
 
1623
        self.assertStreamOrder(sort_order, seen, keys)
 
1624
 
 
1625
    def test_get_record_stream_interface_ordered_with_delta_closure(self):
 
1626
        """each item must be accessible as a fulltext."""
 
1627
        files = self.get_versionedfiles()
 
1628
        self.get_diamond_files(files)
 
1629
        keys, sort_order = self.get_keys_and_sort_order()
 
1630
        parent_map = files.get_parent_map(keys)
 
1631
        entries = files.get_record_stream(keys, 'topological', True)
 
1632
        seen = []
 
1633
        for factory in entries:
 
1634
            seen.append(factory.key)
 
1635
            self.assertValidStorageKind(factory.storage_kind)
 
1636
            self.assertSubset([factory.sha1],
 
1637
                [None, files.get_sha1s([factory.key])[factory.key]])
 
1638
            self.assertEqual(parent_map[factory.key], factory.parents)
 
1639
            # self.assertEqual(files.get_text(factory.key),
 
1640
            ft_bytes = factory.get_bytes_as('fulltext')
 
1641
            self.assertIsInstance(ft_bytes, str)
 
1642
            chunked_bytes = factory.get_bytes_as('chunked')
 
1643
            self.assertEqualDiff(ft_bytes, ''.join(chunked_bytes))
 
1644
 
 
1645
        self.assertStreamOrder(sort_order, seen, keys)
 
1646
 
 
1647
    def assertStreamOrder(self, sort_order, seen, keys):
 
1648
        self.assertEqual(len(set(seen)), len(keys))
 
1649
        if self.key_length == 1:
 
1650
            lows = {():0}
 
1651
        else:
 
1652
            lows = {('FileA',):0, ('FileB',):0}
 
1653
        if not self.graph:
 
1654
            self.assertEqual(set(keys), set(seen))
 
1655
        else:
 
1656
            for key in seen:
 
1657
                sort_pos = sort_order[key]
 
1658
                self.assertTrue(sort_pos >= lows[key[:-1]],
 
1659
                    "Out of order in sorted stream: %r, %r" % (key, seen))
 
1660
                lows[key[:-1]] = sort_pos
 
1661
 
 
1662
    def test_get_record_stream_unknown_storage_kind_raises(self):
 
1663
        """Asking for a storage kind that the stream cannot supply raises."""
 
1664
        files = self.get_versionedfiles()
 
1665
        self.get_diamond_files(files)
 
1666
        if self.key_length == 1:
 
1667
            keys = [('merged',), ('left',), ('right',), ('base',)]
 
1668
        else:
 
1669
            keys = [
 
1670
                ('FileA', 'merged'), ('FileA', 'left'), ('FileA', 'right'),
 
1671
                ('FileA', 'base'),
 
1672
                ('FileB', 'merged'), ('FileB', 'left'), ('FileB', 'right'),
 
1673
                ('FileB', 'base'),
 
1674
                ]
 
1675
        parent_map = files.get_parent_map(keys)
 
1676
        entries = files.get_record_stream(keys, 'unordered', False)
 
1677
        # We track the contents because we should be able to try, fail a
 
1678
        # particular kind and then ask for one that works and continue.
 
1679
        seen = set()
 
1680
        for factory in entries:
 
1681
            seen.add(factory.key)
 
1682
            self.assertValidStorageKind(factory.storage_kind)
 
1683
            self.assertEqual(files.get_sha1s([factory.key])[factory.key],
 
1684
                factory.sha1)
 
1685
            self.assertEqual(parent_map[factory.key], factory.parents)
 
1686
            # currently no stream emits mpdiff
 
1687
            self.assertRaises(errors.UnavailableRepresentation,
 
1688
                factory.get_bytes_as, 'mpdiff')
 
1689
            self.assertIsInstance(factory.get_bytes_as(factory.storage_kind),
 
1690
                str)
 
1691
        self.assertEqual(set(keys), seen)
 
1692
 
 
1693
    def test_get_record_stream_missing_records_are_absent(self):
 
1694
        files = self.get_versionedfiles()
 
1695
        self.get_diamond_files(files)
 
1696
        if self.key_length == 1:
 
1697
            keys = [('merged',), ('left',), ('right',), ('absent',), ('base',)]
 
1698
        else:
 
1699
            keys = [
 
1700
                ('FileA', 'merged'), ('FileA', 'left'), ('FileA', 'right'),
 
1701
                ('FileA', 'absent'), ('FileA', 'base'),
 
1702
                ('FileB', 'merged'), ('FileB', 'left'), ('FileB', 'right'),
 
1703
                ('FileB', 'absent'), ('FileB', 'base'),
 
1704
                ('absent', 'absent'),
 
1705
                ]
 
1706
        parent_map = files.get_parent_map(keys)
 
1707
        entries = files.get_record_stream(keys, 'unordered', False)
 
1708
        self.assertAbsentRecord(files, keys, parent_map, entries)
 
1709
        entries = files.get_record_stream(keys, 'topological', False)
 
1710
        self.assertAbsentRecord(files, keys, parent_map, entries)
 
1711
 
 
1712
    def assertAbsentRecord(self, files, keys, parents, entries):
 
1713
        """Helper for test_get_record_stream_missing_records_are_absent."""
 
1714
        seen = set()
 
1715
        for factory in entries:
 
1716
            seen.add(factory.key)
 
1717
            if factory.key[-1] == 'absent':
 
1718
                self.assertEqual('absent', factory.storage_kind)
 
1719
                self.assertEqual(None, factory.sha1)
 
1720
                self.assertEqual(None, factory.parents)
 
1721
            else:
 
1722
                self.assertValidStorageKind(factory.storage_kind)
 
1723
                self.assertEqual(files.get_sha1s([factory.key])[factory.key],
 
1724
                    factory.sha1)
 
1725
                self.assertEqual(parents[factory.key], factory.parents)
 
1726
                self.assertIsInstance(factory.get_bytes_as(factory.storage_kind),
 
1727
                    str)
 
1728
        self.assertEqual(set(keys), seen)
 
1729
 
 
1730
    def test_filter_absent_records(self):
 
1731
        """Requested missing records can be filter trivially."""
 
1732
        files = self.get_versionedfiles()
 
1733
        self.get_diamond_files(files)
 
1734
        keys, _ = self.get_keys_and_sort_order()
 
1735
        parent_map = files.get_parent_map(keys)
 
1736
        # Add an absent record in the middle of the present keys. (We don't ask
 
1737
        # for just absent keys to ensure that content before and after the
 
1738
        # absent keys is still delivered).
 
1739
        present_keys = list(keys)
 
1740
        if self.key_length == 1:
 
1741
            keys.insert(2, ('extra',))
 
1742
        else:
 
1743
            keys.insert(2, ('extra', 'extra'))
 
1744
        entries = files.get_record_stream(keys, 'unordered', False)
 
1745
        seen = set()
 
1746
        self.capture_stream(files, versionedfile.filter_absent(entries), seen.add,
 
1747
            parent_map)
 
1748
        self.assertEqual(set(present_keys), seen)
 
1749
 
 
1750
    def get_mapper(self):
 
1751
        """Get a mapper suitable for the key length of the test interface."""
 
1752
        if self.key_length == 1:
 
1753
            return ConstantMapper('source')
 
1754
        else:
 
1755
            return HashEscapedPrefixMapper()
 
1756
 
 
1757
    def get_parents(self, parents):
 
1758
        """Get parents, taking self.graph into consideration."""
 
1759
        if self.graph:
 
1760
            return parents
 
1761
        else:
 
1762
            return None
 
1763
 
 
1764
    def test_get_parent_map(self):
 
1765
        files = self.get_versionedfiles()
 
1766
        if self.key_length == 1:
 
1767
            parent_details = [
 
1768
                (('r0',), self.get_parents(())),
 
1769
                (('r1',), self.get_parents((('r0',),))),
 
1770
                (('r2',), self.get_parents(())),
 
1771
                (('r3',), self.get_parents(())),
 
1772
                (('m',), self.get_parents((('r0',),('r1',),('r2',),('r3',)))),
 
1773
                ]
 
1774
        else:
 
1775
            parent_details = [
 
1776
                (('FileA', 'r0'), self.get_parents(())),
 
1777
                (('FileA', 'r1'), self.get_parents((('FileA', 'r0'),))),
 
1778
                (('FileA', 'r2'), self.get_parents(())),
 
1779
                (('FileA', 'r3'), self.get_parents(())),
 
1780
                (('FileA', 'm'), self.get_parents((('FileA', 'r0'),
 
1781
                    ('FileA', 'r1'), ('FileA', 'r2'), ('FileA', 'r3')))),
 
1782
                ]
 
1783
        for key, parents in parent_details:
 
1784
            files.add_lines(key, parents, [])
 
1785
            # immediately after adding it should be queryable.
 
1786
            self.assertEqual({key:parents}, files.get_parent_map([key]))
 
1787
        # We can ask for an empty set
 
1788
        self.assertEqual({}, files.get_parent_map([]))
 
1789
        # We can ask for many keys
 
1790
        all_parents = dict(parent_details)
 
1791
        self.assertEqual(all_parents, files.get_parent_map(all_parents.keys()))
 
1792
        # Absent keys are just not included in the result.
 
1793
        keys = all_parents.keys()
 
1794
        if self.key_length == 1:
 
1795
            keys.insert(1, ('missing',))
 
1796
        else:
 
1797
            keys.insert(1, ('missing', 'missing'))
 
1798
        # Absent keys are just ignored
 
1799
        self.assertEqual(all_parents, files.get_parent_map(keys))
 
1800
 
 
1801
    def test_get_sha1s(self):
 
1802
        files = self.get_versionedfiles()
 
1803
        self.get_diamond_files(files)
 
1804
        if self.key_length == 1:
 
1805
            keys = [('base',), ('origin',), ('left',), ('merged',), ('right',)]
 
1806
        else:
 
1807
            # ask for shas from different prefixes.
 
1808
            keys = [
 
1809
                ('FileA', 'base'), ('FileB', 'origin'), ('FileA', 'left'),
 
1810
                ('FileA', 'merged'), ('FileB', 'right'),
 
1811
                ]
 
1812
        self.assertEqual({
 
1813
            keys[0]: '51c64a6f4fc375daf0d24aafbabe4d91b6f4bb44',
 
1814
            keys[1]: '00e364d235126be43292ab09cb4686cf703ddc17',
 
1815
            keys[2]: 'a8478686da38e370e32e42e8a0c220e33ee9132f',
 
1816
            keys[3]: 'ed8bce375198ea62444dc71952b22cfc2b09226d',
 
1817
            keys[4]: '9ef09dfa9d86780bdec9219a22560c6ece8e0ef1',
 
1818
            },
 
1819
            files.get_sha1s(keys))
 
1820
        
 
1821
    def test_insert_record_stream_empty(self):
 
1822
        """Inserting an empty record stream should work."""
 
1823
        files = self.get_versionedfiles()
 
1824
        files.insert_record_stream([])
 
1825
 
 
1826
    def assertIdenticalVersionedFile(self, expected, actual):
 
1827
        """Assert that left and right have the same contents."""
 
1828
        self.assertEqual(set(actual.keys()), set(expected.keys()))
 
1829
        actual_parents = actual.get_parent_map(actual.keys())
 
1830
        if self.graph:
 
1831
            self.assertEqual(actual_parents, expected.get_parent_map(expected.keys()))
 
1832
        else:
 
1833
            for key, parents in actual_parents.items():
 
1834
                self.assertEqual(None, parents)
 
1835
        for key in actual.keys():
 
1836
            actual_text = actual.get_record_stream(
 
1837
                [key], 'unordered', True).next().get_bytes_as('fulltext')
 
1838
            expected_text = expected.get_record_stream(
 
1839
                [key], 'unordered', True).next().get_bytes_as('fulltext')
 
1840
            self.assertEqual(actual_text, expected_text)
 
1841
 
 
1842
    def test_insert_record_stream_fulltexts(self):
 
1843
        """Any file should accept a stream of fulltexts."""
 
1844
        files = self.get_versionedfiles()
 
1845
        mapper = self.get_mapper()
 
1846
        source_transport = self.get_transport('source')
 
1847
        source_transport.mkdir('.')
 
1848
        # weaves always output fulltexts.
 
1849
        source = make_versioned_files_factory(WeaveFile, mapper)(
 
1850
            source_transport)
 
1851
        self.get_diamond_files(source, trailing_eol=False)
 
1852
        stream = source.get_record_stream(source.keys(), 'topological',
 
1853
            False)
 
1854
        files.insert_record_stream(stream)
 
1855
        self.assertIdenticalVersionedFile(source, files)
 
1856
 
 
1857
    def test_insert_record_stream_fulltexts_noeol(self):
 
1858
        """Any file should accept a stream of fulltexts."""
 
1859
        files = self.get_versionedfiles()
 
1860
        mapper = self.get_mapper()
 
1861
        source_transport = self.get_transport('source')
 
1862
        source_transport.mkdir('.')
 
1863
        # weaves always output fulltexts.
 
1864
        source = make_versioned_files_factory(WeaveFile, mapper)(
 
1865
            source_transport)
 
1866
        self.get_diamond_files(source, trailing_eol=False)
 
1867
        stream = source.get_record_stream(source.keys(), 'topological',
 
1868
            False)
 
1869
        files.insert_record_stream(stream)
 
1870
        self.assertIdenticalVersionedFile(source, files)
 
1871
 
 
1872
    def test_insert_record_stream_annotated_knits(self):
 
1873
        """Any file should accept a stream from plain knits."""
 
1874
        files = self.get_versionedfiles()
 
1875
        mapper = self.get_mapper()
 
1876
        source_transport = self.get_transport('source')
 
1877
        source_transport.mkdir('.')
 
1878
        source = make_file_factory(True, mapper)(source_transport)
 
1879
        self.get_diamond_files(source)
 
1880
        stream = source.get_record_stream(source.keys(), 'topological',
 
1881
            False)
 
1882
        files.insert_record_stream(stream)
 
1883
        self.assertIdenticalVersionedFile(source, files)
 
1884
 
 
1885
    def test_insert_record_stream_annotated_knits_noeol(self):
 
1886
        """Any file should accept a stream from plain knits."""
 
1887
        files = self.get_versionedfiles()
 
1888
        mapper = self.get_mapper()
 
1889
        source_transport = self.get_transport('source')
 
1890
        source_transport.mkdir('.')
 
1891
        source = make_file_factory(True, mapper)(source_transport)
 
1892
        self.get_diamond_files(source, trailing_eol=False)
 
1893
        stream = source.get_record_stream(source.keys(), 'topological',
 
1894
            False)
 
1895
        files.insert_record_stream(stream)
 
1896
        self.assertIdenticalVersionedFile(source, files)
 
1897
 
 
1898
    def test_insert_record_stream_plain_knits(self):
 
1899
        """Any file should accept a stream from plain knits."""
 
1900
        files = self.get_versionedfiles()
 
1901
        mapper = self.get_mapper()
 
1902
        source_transport = self.get_transport('source')
 
1903
        source_transport.mkdir('.')
 
1904
        source = make_file_factory(False, mapper)(source_transport)
 
1905
        self.get_diamond_files(source)
 
1906
        stream = source.get_record_stream(source.keys(), 'topological',
 
1907
            False)
 
1908
        files.insert_record_stream(stream)
 
1909
        self.assertIdenticalVersionedFile(source, files)
 
1910
 
 
1911
    def test_insert_record_stream_plain_knits_noeol(self):
 
1912
        """Any file should accept a stream from plain knits."""
 
1913
        files = self.get_versionedfiles()
 
1914
        mapper = self.get_mapper()
 
1915
        source_transport = self.get_transport('source')
 
1916
        source_transport.mkdir('.')
 
1917
        source = make_file_factory(False, mapper)(source_transport)
 
1918
        self.get_diamond_files(source, trailing_eol=False)
 
1919
        stream = source.get_record_stream(source.keys(), 'topological',
 
1920
            False)
 
1921
        files.insert_record_stream(stream)
 
1922
        self.assertIdenticalVersionedFile(source, files)
 
1923
 
 
1924
    def test_insert_record_stream_existing_keys(self):
 
1925
        """Inserting keys already in a file should not error."""
 
1926
        files = self.get_versionedfiles()
 
1927
        source = self.get_versionedfiles('source')
 
1928
        self.get_diamond_files(source)
 
1929
        # insert some keys into f.
 
1930
        self.get_diamond_files(files, left_only=True)
 
1931
        stream = source.get_record_stream(source.keys(), 'topological',
 
1932
            False)
 
1933
        files.insert_record_stream(stream)
 
1934
        self.assertIdenticalVersionedFile(source, files)
 
1935
 
 
1936
    def test_insert_record_stream_missing_keys(self):
 
1937
        """Inserting a stream with absent keys should raise an error."""
 
1938
        files = self.get_versionedfiles()
 
1939
        source = self.get_versionedfiles('source')
 
1940
        stream = source.get_record_stream([('missing',) * self.key_length],
 
1941
            'topological', False)
 
1942
        self.assertRaises(errors.RevisionNotPresent, files.insert_record_stream,
 
1943
            stream)
 
1944
 
 
1945
    def test_insert_record_stream_out_of_order(self):
 
1946
        """An out of order stream can either error or work."""
 
1947
        files = self.get_versionedfiles()
 
1948
        source = self.get_versionedfiles('source')
 
1949
        self.get_diamond_files(source)
 
1950
        if self.key_length == 1:
 
1951
            origin_keys = [('origin',)]
 
1952
            end_keys = [('merged',), ('left',)]
 
1953
            start_keys = [('right',), ('base',)]
 
1954
        else:
 
1955
            origin_keys = [('FileA', 'origin'), ('FileB', 'origin')]
 
1956
            end_keys = [('FileA', 'merged',), ('FileA', 'left',),
 
1957
                ('FileB', 'merged',), ('FileB', 'left',)]
 
1958
            start_keys = [('FileA', 'right',), ('FileA', 'base',),
 
1959
                ('FileB', 'right',), ('FileB', 'base',)]
 
1960
        origin_entries = source.get_record_stream(origin_keys, 'unordered', False)
 
1961
        end_entries = source.get_record_stream(end_keys, 'topological', False)
 
1962
        start_entries = source.get_record_stream(start_keys, 'topological', False)
 
1963
        entries = chain(origin_entries, end_entries, start_entries)
 
1964
        try:
 
1965
            files.insert_record_stream(entries)
 
1966
        except RevisionNotPresent:
 
1967
            # Must not have corrupted the file.
 
1968
            files.check()
 
1969
        else:
 
1970
            self.assertIdenticalVersionedFile(source, files)
 
1971
 
 
1972
    def test_insert_record_stream_delta_missing_basis_no_corruption(self):
 
1973
        """Insertion where a needed basis is not included aborts safely."""
 
1974
        # We use a knit always here to be sure we are getting a binary delta.
 
1975
        mapper = self.get_mapper()
 
1976
        source_transport = self.get_transport('source')
 
1977
        source_transport.mkdir('.')
 
1978
        source = make_file_factory(False, mapper)(source_transport)
 
1979
        self.get_diamond_files(source)
 
1980
        entries = source.get_record_stream(['origin', 'merged'], 'unordered', False)
 
1981
        files = self.get_versionedfiles()
 
1982
        self.assertRaises(RevisionNotPresent, files.insert_record_stream,
 
1983
            entries)
 
1984
        files.check()
 
1985
        self.assertEqual({}, files.get_parent_map([]))
 
1986
 
 
1987
    def test_iter_lines_added_or_present_in_keys(self):
 
1988
        # test that we get at least an equalset of the lines added by
 
1989
        # versions in the store.
 
1990
        # the ordering here is to make a tree so that dumb searches have
 
1991
        # more changes to muck up.
 
1992
 
 
1993
        class InstrumentedProgress(progress.DummyProgress):
 
1994
 
 
1995
            def __init__(self):
 
1996
 
 
1997
                progress.DummyProgress.__init__(self)
 
1998
                self.updates = []
 
1999
 
 
2000
            def update(self, msg=None, current=None, total=None):
 
2001
                self.updates.append((msg, current, total))
 
2002
 
 
2003
        files = self.get_versionedfiles()
 
2004
        # add a base to get included
 
2005
        files.add_lines(self.get_simple_key('base'), (), ['base\n'])
 
2006
        # add a ancestor to be included on one side
 
2007
        files.add_lines(self.get_simple_key('lancestor'), (), ['lancestor\n'])
 
2008
        # add a ancestor to be included on the other side
 
2009
        files.add_lines(self.get_simple_key('rancestor'),
 
2010
            self.get_parents([self.get_simple_key('base')]), ['rancestor\n'])
 
2011
        # add a child of rancestor with no eofile-nl
 
2012
        files.add_lines(self.get_simple_key('child'),
 
2013
            self.get_parents([self.get_simple_key('rancestor')]),
 
2014
            ['base\n', 'child\n'])
 
2015
        # add a child of lancestor and base to join the two roots
 
2016
        files.add_lines(self.get_simple_key('otherchild'),
 
2017
            self.get_parents([self.get_simple_key('lancestor'),
 
2018
                self.get_simple_key('base')]),
 
2019
            ['base\n', 'lancestor\n', 'otherchild\n'])
 
2020
        def iter_with_keys(keys, expected):
 
2021
            # now we need to see what lines are returned, and how often.
 
2022
            lines = {}
 
2023
            progress = InstrumentedProgress()
 
2024
            # iterate over the lines
 
2025
            for line in files.iter_lines_added_or_present_in_keys(keys,
 
2026
                pb=progress):
 
2027
                lines.setdefault(line, 0)
 
2028
                lines[line] += 1
 
2029
            if []!= progress.updates:
 
2030
                self.assertEqual(expected, progress.updates)
 
2031
            return lines
 
2032
        lines = iter_with_keys(
 
2033
            [self.get_simple_key('child'), self.get_simple_key('otherchild')],
 
2034
            [('Walking content.', 0, 2),
 
2035
             ('Walking content.', 1, 2),
 
2036
             ('Walking content.', 2, 2)])
 
2037
        # we must see child and otherchild
 
2038
        self.assertTrue(lines[('child\n', self.get_simple_key('child'))] > 0)
 
2039
        self.assertTrue(
 
2040
            lines[('otherchild\n', self.get_simple_key('otherchild'))] > 0)
 
2041
        # we dont care if we got more than that.
 
2042
        
 
2043
        # test all lines
 
2044
        lines = iter_with_keys(files.keys(),
 
2045
            [('Walking content.', 0, 5),
 
2046
             ('Walking content.', 1, 5),
 
2047
             ('Walking content.', 2, 5),
 
2048
             ('Walking content.', 3, 5),
 
2049
             ('Walking content.', 4, 5),
 
2050
             ('Walking content.', 5, 5)])
 
2051
        # all lines must be seen at least once
 
2052
        self.assertTrue(lines[('base\n', self.get_simple_key('base'))] > 0)
 
2053
        self.assertTrue(
 
2054
            lines[('lancestor\n', self.get_simple_key('lancestor'))] > 0)
 
2055
        self.assertTrue(
 
2056
            lines[('rancestor\n', self.get_simple_key('rancestor'))] > 0)
 
2057
        self.assertTrue(lines[('child\n', self.get_simple_key('child'))] > 0)
 
2058
        self.assertTrue(
 
2059
            lines[('otherchild\n', self.get_simple_key('otherchild'))] > 0)
 
2060
 
 
2061
    def test_make_mpdiffs(self):
 
2062
        from bzrlib import multiparent
 
2063
        files = self.get_versionedfiles('source')
 
2064
        # add texts that should trip the knit maximum delta chain threshold
 
2065
        # as well as doing parallel chains of data in knits.
 
2066
        # this is done by two chains of 25 insertions
 
2067
        files.add_lines(self.get_simple_key('base'), [], ['line\n'])
 
2068
        files.add_lines(self.get_simple_key('noeol'),
 
2069
            self.get_parents([self.get_simple_key('base')]), ['line'])
 
2070
        # detailed eol tests:
 
2071
        # shared last line with parent no-eol
 
2072
        files.add_lines(self.get_simple_key('noeolsecond'),
 
2073
            self.get_parents([self.get_simple_key('noeol')]),
 
2074
                ['line\n', 'line'])
 
2075
        # differing last line with parent, both no-eol
 
2076
        files.add_lines(self.get_simple_key('noeolnotshared'),
 
2077
            self.get_parents([self.get_simple_key('noeolsecond')]),
 
2078
                ['line\n', 'phone'])
 
2079
        # add eol following a noneol parent, change content
 
2080
        files.add_lines(self.get_simple_key('eol'),
 
2081
            self.get_parents([self.get_simple_key('noeol')]), ['phone\n'])
 
2082
        # add eol following a noneol parent, no change content
 
2083
        files.add_lines(self.get_simple_key('eolline'),
 
2084
            self.get_parents([self.get_simple_key('noeol')]), ['line\n'])
 
2085
        # noeol with no parents:
 
2086
        files.add_lines(self.get_simple_key('noeolbase'), [], ['line'])
 
2087
        # noeol preceeding its leftmost parent in the output:
 
2088
        # this is done by making it a merge of two parents with no common
 
2089
        # anestry: noeolbase and noeol with the 
 
2090
        # later-inserted parent the leftmost.
 
2091
        files.add_lines(self.get_simple_key('eolbeforefirstparent'),
 
2092
            self.get_parents([self.get_simple_key('noeolbase'),
 
2093
                self.get_simple_key('noeol')]),
 
2094
            ['line'])
 
2095
        # two identical eol texts
 
2096
        files.add_lines(self.get_simple_key('noeoldup'),
 
2097
            self.get_parents([self.get_simple_key('noeol')]), ['line'])
 
2098
        next_parent = self.get_simple_key('base')
 
2099
        text_name = 'chain1-'
 
2100
        text = ['line\n']
 
2101
        sha1s = {0 :'da6d3141cb4a5e6f464bf6e0518042ddc7bfd079',
 
2102
                 1 :'45e21ea146a81ea44a821737acdb4f9791c8abe7',
 
2103
                 2 :'e1f11570edf3e2a070052366c582837a4fe4e9fa',
 
2104
                 3 :'26b4b8626da827088c514b8f9bbe4ebf181edda1',
 
2105
                 4 :'e28a5510be25ba84d31121cff00956f9970ae6f6',
 
2106
                 5 :'d63ec0ce22e11dcf65a931b69255d3ac747a318d',
 
2107
                 6 :'2c2888d288cb5e1d98009d822fedfe6019c6a4ea',
 
2108
                 7 :'95c14da9cafbf828e3e74a6f016d87926ba234ab',
 
2109
                 8 :'779e9a0b28f9f832528d4b21e17e168c67697272',
 
2110
                 9 :'1f8ff4e5c6ff78ac106fcfe6b1e8cb8740ff9a8f',
 
2111
                 10:'131a2ae712cf51ed62f143e3fbac3d4206c25a05',
 
2112
                 11:'c5a9d6f520d2515e1ec401a8f8a67e6c3c89f199',
 
2113
                 12:'31a2286267f24d8bedaa43355f8ad7129509ea85',
 
2114
                 13:'dc2a7fe80e8ec5cae920973973a8ee28b2da5e0a',
 
2115
                 14:'2c4b1736566b8ca6051e668de68650686a3922f2',
 
2116
                 15:'5912e4ecd9b0c07be4d013e7e2bdcf9323276cde',
 
2117
                 16:'b0d2e18d3559a00580f6b49804c23fea500feab3',
 
2118
                 17:'8e1d43ad72f7562d7cb8f57ee584e20eb1a69fc7',
 
2119
                 18:'5cf64a3459ae28efa60239e44b20312d25b253f3',
 
2120
                 19:'1ebed371807ba5935958ad0884595126e8c4e823',
 
2121
                 20:'2aa62a8b06fb3b3b892a3292a068ade69d5ee0d3',
 
2122
                 21:'01edc447978004f6e4e962b417a4ae1955b6fe5d',
 
2123
                 22:'d8d8dc49c4bf0bab401e0298bb5ad827768618bb',
 
2124
                 23:'c21f62b1c482862983a8ffb2b0c64b3451876e3f',
 
2125
                 24:'c0593fe795e00dff6b3c0fe857a074364d5f04fc',
 
2126
                 25:'dd1a1cf2ba9cc225c3aff729953e6364bf1d1855',
 
2127
                 }
 
2128
        for depth in range(26):
 
2129
            new_version = self.get_simple_key(text_name + '%s' % depth)
 
2130
            text = text + ['line\n']
 
2131
            files.add_lines(new_version, self.get_parents([next_parent]), text)
 
2132
            next_parent = new_version
 
2133
        next_parent = self.get_simple_key('base')
 
2134
        text_name = 'chain2-'
 
2135
        text = ['line\n']
 
2136
        for depth in range(26):
 
2137
            new_version = self.get_simple_key(text_name + '%s' % depth)
 
2138
            text = text + ['line\n']
 
2139
            files.add_lines(new_version, self.get_parents([next_parent]), text)
 
2140
            next_parent = new_version
 
2141
        target = self.get_versionedfiles('target')
 
2142
        for key in multiparent.topo_iter_keys(files, files.keys()):
 
2143
            mpdiff = files.make_mpdiffs([key])[0]
 
2144
            parents = files.get_parent_map([key])[key] or []
 
2145
            target.add_mpdiffs(
 
2146
                [(key, parents, files.get_sha1s([key])[key], mpdiff)])
 
2147
            self.assertEqualDiff(
 
2148
                files.get_record_stream([key], 'unordered',
 
2149
                    True).next().get_bytes_as('fulltext'),
 
2150
                target.get_record_stream([key], 'unordered',
 
2151
                    True).next().get_bytes_as('fulltext')
 
2152
                )
 
2153
 
 
2154
    def test_keys(self):
 
2155
        # While use is discouraged, versions() is still needed by aspects of
 
2156
        # bzr.
 
2157
        files = self.get_versionedfiles()
 
2158
        self.assertEqual(set(), set(files.keys()))
 
2159
        if self.key_length == 1:
 
2160
            key = ('foo',)
 
2161
        else:
 
2162
            key = ('foo', 'bar',)
 
2163
        files.add_lines(key, (), [])
 
2164
        self.assertEqual(set([key]), set(files.keys()))
 
2165
 
 
2166
 
 
2167
class VirtualVersionedFilesTests(TestCase):
 
2168
    """Basic tests for the VirtualVersionedFiles implementations."""
 
2169
 
 
2170
    def _get_parent_map(self, keys):
 
2171
        ret = {}
 
2172
        for k in keys:
 
2173
            if k in self._parent_map:
 
2174
                ret[k] = self._parent_map[k]
 
2175
        return ret
 
2176
 
 
2177
    def setUp(self):
 
2178
        TestCase.setUp(self)
 
2179
        self._lines = {}
 
2180
        self._parent_map = {}
 
2181
        self.texts = VirtualVersionedFiles(self._get_parent_map, 
 
2182
                                           self._lines.get)
 
2183
 
 
2184
    def test_add_lines(self):
 
2185
        self.assertRaises(NotImplementedError, 
 
2186
                self.texts.add_lines, "foo", [], [])
 
2187
 
 
2188
    def test_add_mpdiffs(self):
 
2189
        self.assertRaises(NotImplementedError, 
 
2190
                self.texts.add_mpdiffs, [])
 
2191
 
 
2192
    def test_check(self):
 
2193
        self.assertTrue(self.texts.check())
 
2194
 
 
2195
    def test_insert_record_stream(self):
 
2196
        self.assertRaises(NotImplementedError, self.texts.insert_record_stream,
 
2197
                          [])
 
2198
 
 
2199
    def test_get_sha1s_nonexistent(self):
 
2200
        self.assertEquals({}, self.texts.get_sha1s([("NONEXISTENT",)]))
 
2201
 
 
2202
    def test_get_sha1s(self):
 
2203
        self._lines["key"] = ["dataline1", "dataline2"]
 
2204
        self.assertEquals({("key",): osutils.sha_strings(self._lines["key"])},
 
2205
                           self.texts.get_sha1s([("key",)]))
 
2206
 
 
2207
    def test_get_parent_map(self):
 
2208
        self._parent_map = {"G": ("A", "B")}
 
2209
        self.assertEquals({("G",): (("A",),("B",))}, 
 
2210
                          self.texts.get_parent_map([("G",), ("L",)]))
 
2211
 
 
2212
    def test_get_record_stream(self):
 
2213
        self._lines["A"] = ["FOO", "BAR"]
 
2214
        it = self.texts.get_record_stream([("A",)], "unordered", True)
 
2215
        record = it.next()
 
2216
        self.assertEquals("chunked", record.storage_kind)
 
2217
        self.assertEquals("FOOBAR", record.get_bytes_as("fulltext"))
 
2218
        self.assertEquals(["FOO", "BAR"], record.get_bytes_as("chunked"))
 
2219
 
 
2220
    def test_get_record_stream_absent(self):
 
2221
        it = self.texts.get_record_stream([("A",)], "unordered", True)
 
2222
        record = it.next()
 
2223
        self.assertEquals("absent", record.storage_kind)
 
2224
 
 
2225
    def test_iter_lines_added_or_present_in_keys(self):
 
2226
        self._lines["A"] = ["FOO", "BAR"]
 
2227
        self._lines["B"] = ["HEY"]
 
2228
        self._lines["C"] = ["Alberta"]
 
2229
        it = self.texts.iter_lines_added_or_present_in_keys([("A",), ("B",)])
 
2230
        self.assertEquals(sorted([("FOO", "A"), ("BAR", "A"), ("HEY", "B")]), 
 
2231
            sorted(list(it)))
 
2232
 
 
2233
 
 
2234
class TestOrderingVersionedFilesDecorator(TestCaseWithMemoryTransport):
 
2235
 
 
2236
    def get_ordering_vf(self, key_priority):
 
2237
        builder = self.make_branch_builder('test')
 
2238
        builder.start_series()
 
2239
        builder.build_snapshot('A', None, [
 
2240
            ('add', ('', 'TREE_ROOT', 'directory', None))])
 
2241
        builder.build_snapshot('B', ['A'], [])
 
2242
        builder.build_snapshot('C', ['B'], [])
 
2243
        builder.build_snapshot('D', ['C'], [])
 
2244
        builder.finish_series()
 
2245
        b = builder.get_branch()
 
2246
        b.lock_read()
 
2247
        self.addCleanup(b.unlock)
 
2248
        vf = b.repository.inventories
 
2249
        return versionedfile.OrderingVersionedFilesDecorator(vf, key_priority)
 
2250
 
 
2251
    def test_get_empty(self):
 
2252
        vf = self.get_ordering_vf({})
 
2253
        self.assertEqual([], vf.calls)
 
2254
 
 
2255
    def test_get_record_stream_topological(self):
 
2256
        vf = self.get_ordering_vf({('A',): 3, ('B',): 2, ('C',): 4, ('D',): 1})
 
2257
        request_keys = [('B',), ('C',), ('D',), ('A',)]
 
2258
        keys = [r.key for r in vf.get_record_stream(request_keys,
 
2259
                                    'topological', False)]
 
2260
        # We should have gotten the keys in topological order
 
2261
        self.assertEqual([('A',), ('B',), ('C',), ('D',)], keys)
 
2262
        # And recorded that the request was made
 
2263
        self.assertEqual([('get_record_stream', request_keys, 'topological',
 
2264
                           False)], vf.calls)
 
2265
 
 
2266
    def test_get_record_stream_ordered(self):
 
2267
        vf = self.get_ordering_vf({('A',): 3, ('B',): 2, ('C',): 4, ('D',): 1})
 
2268
        request_keys = [('B',), ('C',), ('D',), ('A',)]
 
2269
        keys = [r.key for r in vf.get_record_stream(request_keys,
 
2270
                                   'unordered', False)]
 
2271
        # They should be returned based on their priority
 
2272
        self.assertEqual([('D',), ('B',), ('A',), ('C',)], keys)
 
2273
        # And the request recorded
 
2274
        self.assertEqual([('get_record_stream', request_keys, 'unordered',
 
2275
                           False)], vf.calls)
 
2276
 
 
2277
    def test_get_record_stream_implicit_order(self):
 
2278
        vf = self.get_ordering_vf({('B',): 2, ('D',): 1})
 
2279
        request_keys = [('B',), ('C',), ('D',), ('A',)]
 
2280
        keys = [r.key for r in vf.get_record_stream(request_keys,
 
2281
                                   'unordered', False)]
 
2282
        # A and C are not in the map, so they get sorted to the front. A comes
 
2283
        # before C alphabetically, so it comes back first
 
2284
        self.assertEqual([('A',), ('C',), ('D',), ('B',)], keys)
 
2285
        # And the request recorded
 
2286
        self.assertEqual([('get_record_stream', request_keys, 'unordered',
 
2287
                           False)], vf.calls)