/brz/remove-bazaar

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