~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_knit.py

  • Committer: Patch Queue Manager
  • Date: 2012-03-12 15:03:17 UTC
  • mfrom: (6491.2.2 lazy-lp-plugin)
  • Revision ID: pqm@pqm.ubuntu.com-20120312150317-nrt00el7ooyvbk94
(jelmer) Lazily load launchpad plugin commands. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2006-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Tests for Knit data structure"""
18
18
 
19
19
from cStringIO import StringIO
20
 
import difflib
21
20
import gzip
22
 
import sha
23
21
import sys
24
22
 
25
23
from bzrlib import (
26
24
    errors,
27
 
    generate_ids,
28
25
    knit,
 
26
    multiparent,
 
27
    osutils,
29
28
    pack,
 
29
    tests,
 
30
    transport,
30
31
    )
31
32
from bzrlib.errors import (
32
 
    RevisionAlreadyPresent,
33
33
    KnitHeaderError,
34
 
    RevisionNotPresent,
35
34
    NoSuchFile,
36
35
    )
37
36
from bzrlib.index import *
38
37
from bzrlib.knit import (
 
38
    AnnotatedKnitContent,
39
39
    KnitContent,
40
 
    KnitGraphIndex,
41
 
    KnitVersionedFile,
42
 
    KnitPlainFactory,
43
 
    KnitAnnotateFactory,
44
 
    _KnitAccess,
45
 
    _KnitData,
46
 
    _KnitIndex,
47
 
    _PackAccess,
48
 
    WeaveToKnit,
49
 
    KnitSequenceMatcher,
50
 
    )
51
 
from bzrlib.osutils import split_lines
 
40
    KnitVersionedFiles,
 
41
    PlainKnitContent,
 
42
    _VFContentMapGenerator,
 
43
    _KndxIndex,
 
44
    _KnitGraphIndex,
 
45
    _KnitKeyAccess,
 
46
    make_file_factory,
 
47
    )
 
48
from bzrlib.patiencediff import PatienceSequenceMatcher
 
49
from bzrlib.repofmt import (
 
50
    knitpack_repo,
 
51
    pack_repo,
 
52
    )
52
53
from bzrlib.tests import (
53
 
    Feature,
54
54
    TestCase,
55
55
    TestCaseWithMemoryTransport,
56
56
    TestCaseWithTransport,
57
 
    )
58
 
from bzrlib.transport import TransportLogger, get_transport
59
 
from bzrlib.transport.memory import MemoryTransport
60
 
from bzrlib.util import bencode
61
 
from bzrlib.weave import Weave
62
 
 
63
 
 
64
 
class _CompiledKnitFeature(Feature):
65
 
 
66
 
    def _probe(self):
67
 
        try:
68
 
            import bzrlib._knit_load_data_c
69
 
        except ImportError:
70
 
            return False
71
 
        return True
72
 
 
73
 
    def feature_name(self):
74
 
        return 'bzrlib._knit_load_data_c'
75
 
 
76
 
CompiledKnitFeature = _CompiledKnitFeature()
77
 
 
78
 
 
79
 
class KnitContentTests(TestCase):
 
57
    TestNotApplicable,
 
58
    )
 
59
from bzrlib.versionedfile import (
 
60
    AbsentContentFactory,
 
61
    ConstantMapper,
 
62
    network_bytes_to_kind_and_offset,
 
63
    RecordingVersionedFilesDecorator,
 
64
    )
 
65
from bzrlib.tests import (
 
66
    features,
 
67
    )
 
68
 
 
69
 
 
70
compiled_knit_feature = features.ModuleAvailableFeature(
 
71
    'bzrlib._knit_load_data_pyx')
 
72
 
 
73
 
 
74
class KnitContentTestsMixin(object):
80
75
 
81
76
    def test_constructor(self):
82
 
        content = KnitContent([])
 
77
        content = self._make_content([])
83
78
 
84
79
    def test_text(self):
85
 
        content = KnitContent([])
 
80
        content = self._make_content([])
86
81
        self.assertEqual(content.text(), [])
87
82
 
88
 
        content = KnitContent([("origin1", "text1"), ("origin2", "text2")])
 
83
        content = self._make_content([("origin1", "text1"), ("origin2", "text2")])
89
84
        self.assertEqual(content.text(), ["text1", "text2"])
90
85
 
91
 
    def test_annotate(self):
92
 
        content = KnitContent([])
93
 
        self.assertEqual(content.annotate(), [])
94
 
 
95
 
        content = KnitContent([("origin1", "text1"), ("origin2", "text2")])
96
 
        self.assertEqual(content.annotate(),
97
 
            [("origin1", "text1"), ("origin2", "text2")])
98
 
 
99
 
    def test_annotate_iter(self):
100
 
        content = KnitContent([])
101
 
        it = content.annotate_iter()
102
 
        self.assertRaises(StopIteration, it.next)
103
 
 
104
 
        content = KnitContent([("origin1", "text1"), ("origin2", "text2")])
105
 
        it = content.annotate_iter()
106
 
        self.assertEqual(it.next(), ("origin1", "text1"))
107
 
        self.assertEqual(it.next(), ("origin2", "text2"))
108
 
        self.assertRaises(StopIteration, it.next)
109
 
 
110
86
    def test_copy(self):
111
 
        content = KnitContent([("origin1", "text1"), ("origin2", "text2")])
 
87
        content = self._make_content([("origin1", "text1"), ("origin2", "text2")])
112
88
        copy = content.copy()
113
 
        self.assertIsInstance(copy, KnitContent)
114
 
        self.assertEqual(copy.annotate(),
 
89
        self.assertIsInstance(copy, content.__class__)
 
90
        self.assertEqual(copy.annotate(), content.annotate())
 
91
 
 
92
    def assertDerivedBlocksEqual(self, source, target, noeol=False):
 
93
        """Assert that the derived matching blocks match real output"""
 
94
        source_lines = source.splitlines(True)
 
95
        target_lines = target.splitlines(True)
 
96
        def nl(line):
 
97
            if noeol and not line.endswith('\n'):
 
98
                return line + '\n'
 
99
            else:
 
100
                return line
 
101
        source_content = self._make_content([(None, nl(l)) for l in source_lines])
 
102
        target_content = self._make_content([(None, nl(l)) for l in target_lines])
 
103
        line_delta = source_content.line_delta(target_content)
 
104
        delta_blocks = list(KnitContent.get_line_delta_blocks(line_delta,
 
105
            source_lines, target_lines))
 
106
        matcher = PatienceSequenceMatcher(None, source_lines, target_lines)
 
107
        matcher_blocks = list(matcher.get_matching_blocks())
 
108
        self.assertEqual(matcher_blocks, delta_blocks)
 
109
 
 
110
    def test_get_line_delta_blocks(self):
 
111
        self.assertDerivedBlocksEqual('a\nb\nc\n', 'q\nc\n')
 
112
        self.assertDerivedBlocksEqual(TEXT_1, TEXT_1)
 
113
        self.assertDerivedBlocksEqual(TEXT_1, TEXT_1A)
 
114
        self.assertDerivedBlocksEqual(TEXT_1, TEXT_1B)
 
115
        self.assertDerivedBlocksEqual(TEXT_1B, TEXT_1A)
 
116
        self.assertDerivedBlocksEqual(TEXT_1A, TEXT_1B)
 
117
        self.assertDerivedBlocksEqual(TEXT_1A, '')
 
118
        self.assertDerivedBlocksEqual('', TEXT_1A)
 
119
        self.assertDerivedBlocksEqual('', '')
 
120
        self.assertDerivedBlocksEqual('a\nb\nc', 'a\nb\nc\nd')
 
121
 
 
122
    def test_get_line_delta_blocks_noeol(self):
 
123
        """Handle historical knit deltas safely
 
124
 
 
125
        Some existing knit deltas don't consider the last line to differ
 
126
        when the only difference whether it has a final newline.
 
127
 
 
128
        New knit deltas appear to always consider the last line to differ
 
129
        in this case.
 
130
        """
 
131
        self.assertDerivedBlocksEqual('a\nb\nc', 'a\nb\nc\nd\n', noeol=True)
 
132
        self.assertDerivedBlocksEqual('a\nb\nc\nd\n', 'a\nb\nc', noeol=True)
 
133
        self.assertDerivedBlocksEqual('a\nb\nc\n', 'a\nb\nc', noeol=True)
 
134
        self.assertDerivedBlocksEqual('a\nb\nc', 'a\nb\nc\n', noeol=True)
 
135
 
 
136
 
 
137
TEXT_1 = """\
 
138
Banana cup cakes:
 
139
 
 
140
- bananas
 
141
- eggs
 
142
- broken tea cups
 
143
"""
 
144
 
 
145
TEXT_1A = """\
 
146
Banana cup cake recipe
 
147
(serves 6)
 
148
 
 
149
- bananas
 
150
- eggs
 
151
- broken tea cups
 
152
- self-raising flour
 
153
"""
 
154
 
 
155
TEXT_1B = """\
 
156
Banana cup cake recipe
 
157
 
 
158
- bananas (do not use plantains!!!)
 
159
- broken tea cups
 
160
- flour
 
161
"""
 
162
 
 
163
delta_1_1a = """\
 
164
0,1,2
 
165
Banana cup cake recipe
 
166
(serves 6)
 
167
5,5,1
 
168
- self-raising flour
 
169
"""
 
170
 
 
171
TEXT_2 = """\
 
172
Boeuf bourguignon
 
173
 
 
174
- beef
 
175
- red wine
 
176
- small onions
 
177
- carrot
 
178
- mushrooms
 
179
"""
 
180
 
 
181
 
 
182
class TestPlainKnitContent(TestCase, KnitContentTestsMixin):
 
183
 
 
184
    def _make_content(self, lines):
 
185
        annotated_content = AnnotatedKnitContent(lines)
 
186
        return PlainKnitContent(annotated_content.text(), 'bogus')
 
187
 
 
188
    def test_annotate(self):
 
189
        content = self._make_content([])
 
190
        self.assertEqual(content.annotate(), [])
 
191
 
 
192
        content = self._make_content([("origin1", "text1"), ("origin2", "text2")])
 
193
        self.assertEqual(content.annotate(),
 
194
            [("bogus", "text1"), ("bogus", "text2")])
 
195
 
 
196
    def test_line_delta(self):
 
197
        content1 = self._make_content([("", "a"), ("", "b")])
 
198
        content2 = self._make_content([("", "a"), ("", "a"), ("", "c")])
 
199
        self.assertEqual(content1.line_delta(content2),
 
200
            [(1, 2, 2, ["a", "c"])])
 
201
 
 
202
    def test_line_delta_iter(self):
 
203
        content1 = self._make_content([("", "a"), ("", "b")])
 
204
        content2 = self._make_content([("", "a"), ("", "a"), ("", "c")])
 
205
        it = content1.line_delta_iter(content2)
 
206
        self.assertEqual(it.next(), (1, 2, 2, ["a", "c"]))
 
207
        self.assertRaises(StopIteration, it.next)
 
208
 
 
209
 
 
210
class TestAnnotatedKnitContent(TestCase, KnitContentTestsMixin):
 
211
 
 
212
    def _make_content(self, lines):
 
213
        return AnnotatedKnitContent(lines)
 
214
 
 
215
    def test_annotate(self):
 
216
        content = self._make_content([])
 
217
        self.assertEqual(content.annotate(), [])
 
218
 
 
219
        content = self._make_content([("origin1", "text1"), ("origin2", "text2")])
 
220
        self.assertEqual(content.annotate(),
115
221
            [("origin1", "text1"), ("origin2", "text2")])
116
222
 
117
223
    def test_line_delta(self):
118
 
        content1 = KnitContent([("", "a"), ("", "b")])
119
 
        content2 = KnitContent([("", "a"), ("", "a"), ("", "c")])
 
224
        content1 = self._make_content([("", "a"), ("", "b")])
 
225
        content2 = self._make_content([("", "a"), ("", "a"), ("", "c")])
120
226
        self.assertEqual(content1.line_delta(content2),
121
227
            [(1, 2, 2, [("", "a"), ("", "c")])])
122
228
 
123
229
    def test_line_delta_iter(self):
124
 
        content1 = KnitContent([("", "a"), ("", "b")])
125
 
        content2 = KnitContent([("", "a"), ("", "a"), ("", "c")])
 
230
        content1 = self._make_content([("", "a"), ("", "b")])
 
231
        content2 = self._make_content([("", "a"), ("", "a"), ("", "c")])
126
232
        it = content1.line_delta_iter(content2)
127
233
        self.assertEqual(it.next(), (1, 2, 2, [("", "a"), ("", "c")]))
128
234
        self.assertRaises(StopIteration, it.next)
154
260
        return queue_call
155
261
 
156
262
 
 
263
class MockReadvFailingTransport(MockTransport):
 
264
    """Fail in the middle of a readv() result.
 
265
 
 
266
    This Transport will successfully yield the first two requested hunks, but
 
267
    raise NoSuchFile for the rest.
 
268
    """
 
269
 
 
270
    def readv(self, relpath, offsets):
 
271
        count = 0
 
272
        for result in MockTransport.readv(self, relpath, offsets):
 
273
            count += 1
 
274
            # we use 2 because the first offset is the pack header, the second
 
275
            # is the first actual content requset
 
276
            if count > 2:
 
277
                raise errors.NoSuchFile(relpath)
 
278
            yield result
 
279
 
 
280
 
157
281
class KnitRecordAccessTestsMixin(object):
158
282
    """Tests for getting and putting knit records."""
159
283
 
160
 
    def assertAccessExists(self, access):
161
 
        """Ensure the data area for access has been initialised/exists."""
162
 
        raise NotImplementedError(self.assertAccessExists)
163
 
 
164
284
    def test_add_raw_records(self):
165
285
        """Add_raw_records adds records retrievable later."""
166
286
        access = self.get_access()
167
 
        memos = access.add_raw_records([10], '1234567890')
 
287
        memos = access.add_raw_records([('key', 10)], '1234567890')
168
288
        self.assertEqual(['1234567890'], list(access.get_raw_records(memos)))
169
 
 
 
289
 
170
290
    def test_add_several_raw_records(self):
171
291
        """add_raw_records with many records and read some back."""
172
292
        access = self.get_access()
173
 
        memos = access.add_raw_records([10, 2, 5], '12345678901234567')
 
293
        memos = access.add_raw_records([('key', 10), ('key2', 2), ('key3', 5)],
 
294
            '12345678901234567')
174
295
        self.assertEqual(['1234567890', '12', '34567'],
175
296
            list(access.get_raw_records(memos)))
176
297
        self.assertEqual(['1234567890'],
182
303
        self.assertEqual(['1234567890', '34567'],
183
304
            list(access.get_raw_records(memos[0:1] + memos[2:3])))
184
305
 
185
 
    def test_create(self):
186
 
        """create() should make a file on disk."""
187
 
        access = self.get_access()
188
 
        access.create()
189
 
        self.assertAccessExists(access)
190
 
 
191
 
    def test_open_file(self):
192
 
        """open_file never errors."""
193
 
        access = self.get_access()
194
 
        access.open_file()
195
 
 
196
306
 
197
307
class TestKnitKnitAccess(TestCaseWithMemoryTransport, KnitRecordAccessTestsMixin):
198
308
    """Tests for the .kndx implementation."""
199
309
 
200
 
    def assertAccessExists(self, access):
201
 
        self.assertNotEqual(None, access.open_file())
202
 
 
203
310
    def get_access(self):
204
311
        """Get a .knit style access instance."""
205
 
        access = _KnitAccess(self.get_transport(), "foo.knit", None, None,
206
 
            False, False)
 
312
        mapper = ConstantMapper("foo")
 
313
        access = _KnitKeyAccess(self.get_transport(), mapper)
207
314
        return access
208
 
    
 
315
 
 
316
 
 
317
class _TestException(Exception):
 
318
    """Just an exception for local tests to use."""
 
319
 
209
320
 
210
321
class TestPackKnitAccess(TestCaseWithMemoryTransport, KnitRecordAccessTestsMixin):
211
322
    """Tests for the pack based access."""
212
323
 
213
 
    def assertAccessExists(self, access):
214
 
        # as pack based access has no backing unless an index maps data, this
215
 
        # is a no-op.
216
 
        pass
217
 
 
218
324
    def get_access(self):
219
325
        return self._get_access()[0]
220
326
 
224
330
            transport.append_bytes(packname, bytes)
225
331
        writer = pack.ContainerWriter(write_data)
226
332
        writer.begin()
227
 
        indices = {index:(transport, packname)}
228
 
        access = _PackAccess(indices, writer=(writer, index))
 
333
        access = pack_repo._DirectPackAccess({})
 
334
        access.set_writer(writer, index, (transport, packname))
229
335
        return access, writer
230
336
 
 
337
    def make_pack_file(self):
 
338
        """Create a pack file with 2 records."""
 
339
        access, writer = self._get_access(packname='packname', index='foo')
 
340
        memos = []
 
341
        memos.extend(access.add_raw_records([('key1', 10)], '1234567890'))
 
342
        memos.extend(access.add_raw_records([('key2', 5)], '12345'))
 
343
        writer.end()
 
344
        return memos
 
345
 
 
346
    def test_pack_collection_pack_retries(self):
 
347
        """An explicit pack of a pack collection succeeds even when a
 
348
        concurrent pack happens.
 
349
        """
 
350
        builder = self.make_branch_builder('.')
 
351
        builder.start_series()
 
352
        builder.build_snapshot('rev-1', None, [
 
353
            ('add', ('', 'root-id', 'directory', None)),
 
354
            ('add', ('file', 'file-id', 'file', 'content\nrev 1\n')),
 
355
            ])
 
356
        builder.build_snapshot('rev-2', ['rev-1'], [
 
357
            ('modify', ('file-id', 'content\nrev 2\n')),
 
358
            ])
 
359
        builder.build_snapshot('rev-3', ['rev-2'], [
 
360
            ('modify', ('file-id', 'content\nrev 3\n')),
 
361
            ])
 
362
        self.addCleanup(builder.finish_series)
 
363
        b = builder.get_branch()
 
364
        self.addCleanup(b.lock_write().unlock)
 
365
        repo = b.repository
 
366
        collection = repo._pack_collection
 
367
        # Concurrently repack the repo.
 
368
        reopened_repo = repo.bzrdir.open_repository()
 
369
        reopened_repo.pack()
 
370
        # Pack the new pack.
 
371
        collection.pack()
 
372
 
 
373
    def make_vf_for_retrying(self):
 
374
        """Create 3 packs and a reload function.
 
375
 
 
376
        Originally, 2 pack files will have the data, but one will be missing.
 
377
        And then the third will be used in place of the first two if reload()
 
378
        is called.
 
379
 
 
380
        :return: (versioned_file, reload_counter)
 
381
            versioned_file  a KnitVersionedFiles using the packs for access
 
382
        """
 
383
        builder = self.make_branch_builder('.', format="1.9")
 
384
        builder.start_series()
 
385
        builder.build_snapshot('rev-1', None, [
 
386
            ('add', ('', 'root-id', 'directory', None)),
 
387
            ('add', ('file', 'file-id', 'file', 'content\nrev 1\n')),
 
388
            ])
 
389
        builder.build_snapshot('rev-2', ['rev-1'], [
 
390
            ('modify', ('file-id', 'content\nrev 2\n')),
 
391
            ])
 
392
        builder.build_snapshot('rev-3', ['rev-2'], [
 
393
            ('modify', ('file-id', 'content\nrev 3\n')),
 
394
            ])
 
395
        builder.finish_series()
 
396
        b = builder.get_branch()
 
397
        b.lock_write()
 
398
        self.addCleanup(b.unlock)
 
399
        # Pack these three revisions into another pack file, but don't remove
 
400
        # the originals
 
401
        repo = b.repository
 
402
        collection = repo._pack_collection
 
403
        collection.ensure_loaded()
 
404
        orig_packs = collection.packs
 
405
        packer = knitpack_repo.KnitPacker(collection, orig_packs, '.testpack')
 
406
        new_pack = packer.pack()
 
407
        # forget about the new pack
 
408
        collection.reset()
 
409
        repo.refresh_data()
 
410
        vf = repo.revisions
 
411
        # Set up a reload() function that switches to using the new pack file
 
412
        new_index = new_pack.revision_index
 
413
        access_tuple = new_pack.access_tuple()
 
414
        reload_counter = [0, 0, 0]
 
415
        def reload():
 
416
            reload_counter[0] += 1
 
417
            if reload_counter[1] > 0:
 
418
                # We already reloaded, nothing more to do
 
419
                reload_counter[2] += 1
 
420
                return False
 
421
            reload_counter[1] += 1
 
422
            vf._index._graph_index._indices[:] = [new_index]
 
423
            vf._access._indices.clear()
 
424
            vf._access._indices[new_index] = access_tuple
 
425
            return True
 
426
        # Delete one of the pack files so the data will need to be reloaded. We
 
427
        # will delete the file with 'rev-2' in it
 
428
        trans, name = orig_packs[1].access_tuple()
 
429
        trans.delete(name)
 
430
        # We don't have the index trigger reloading because we want to test
 
431
        # that we reload when the .pack disappears
 
432
        vf._access._reload_func = reload
 
433
        return vf, reload_counter
 
434
 
 
435
    def make_reload_func(self, return_val=True):
 
436
        reload_called = [0]
 
437
        def reload():
 
438
            reload_called[0] += 1
 
439
            return return_val
 
440
        return reload_called, reload
 
441
 
 
442
    def make_retry_exception(self):
 
443
        # We raise a real exception so that sys.exc_info() is properly
 
444
        # populated
 
445
        try:
 
446
            raise _TestException('foobar')
 
447
        except _TestException, e:
 
448
            retry_exc = errors.RetryWithNewPacks(None, reload_occurred=False,
 
449
                                                 exc_info=sys.exc_info())
 
450
        # GZ 2010-08-10: Cycle with exc_info affects 3 tests
 
451
        return retry_exc
 
452
 
231
453
    def test_read_from_several_packs(self):
232
454
        access, writer = self._get_access()
233
455
        memos = []
234
 
        memos.extend(access.add_raw_records([10], '1234567890'))
 
456
        memos.extend(access.add_raw_records([('key', 10)], '1234567890'))
235
457
        writer.end()
236
458
        access, writer = self._get_access('pack2', 'FOOBAR')
237
 
        memos.extend(access.add_raw_records([5], '12345'))
 
459
        memos.extend(access.add_raw_records([('key', 5)], '12345'))
238
460
        writer.end()
239
461
        access, writer = self._get_access('pack3', 'BAZ')
240
 
        memos.extend(access.add_raw_records([5], 'alpha'))
 
462
        memos.extend(access.add_raw_records([('key', 5)], 'alpha'))
241
463
        writer.end()
242
464
        transport = self.get_transport()
243
 
        access = _PackAccess({"FOO":(transport, 'packfile'),
 
465
        access = pack_repo._DirectPackAccess({"FOO":(transport, 'packfile'),
244
466
            "FOOBAR":(transport, 'pack2'),
245
467
            "BAZ":(transport, 'pack3')})
246
468
        self.assertEqual(['1234567890', '12345', 'alpha'],
256
478
 
257
479
    def test_set_writer(self):
258
480
        """The writer should be settable post construction."""
259
 
        access = _PackAccess({})
 
481
        access = pack_repo._DirectPackAccess({})
260
482
        transport = self.get_transport()
261
483
        packname = 'packfile'
262
484
        index = 'foo'
265
487
        writer = pack.ContainerWriter(write_data)
266
488
        writer.begin()
267
489
        access.set_writer(writer, index, (transport, packname))
268
 
        memos = access.add_raw_records([10], '1234567890')
 
490
        memos = access.add_raw_records([('key', 10)], '1234567890')
269
491
        writer.end()
270
492
        self.assertEqual(['1234567890'], list(access.get_raw_records(memos)))
271
493
 
 
494
    def test_missing_index_raises_retry(self):
 
495
        memos = self.make_pack_file()
 
496
        transport = self.get_transport()
 
497
        reload_called, reload_func = self.make_reload_func()
 
498
        # Note that the index key has changed from 'foo' to 'bar'
 
499
        access = pack_repo._DirectPackAccess({'bar':(transport, 'packname')},
 
500
                                   reload_func=reload_func)
 
501
        e = self.assertListRaises(errors.RetryWithNewPacks,
 
502
                                  access.get_raw_records, memos)
 
503
        # Because a key was passed in which does not match our index list, we
 
504
        # assume that the listing was already reloaded
 
505
        self.assertTrue(e.reload_occurred)
 
506
        self.assertIsInstance(e.exc_info, tuple)
 
507
        self.assertIs(e.exc_info[0], KeyError)
 
508
        self.assertIsInstance(e.exc_info[1], KeyError)
 
509
 
 
510
    def test_missing_index_raises_key_error_with_no_reload(self):
 
511
        memos = self.make_pack_file()
 
512
        transport = self.get_transport()
 
513
        # Note that the index key has changed from 'foo' to 'bar'
 
514
        access = pack_repo._DirectPackAccess({'bar':(transport, 'packname')})
 
515
        e = self.assertListRaises(KeyError, access.get_raw_records, memos)
 
516
 
 
517
    def test_missing_file_raises_retry(self):
 
518
        memos = self.make_pack_file()
 
519
        transport = self.get_transport()
 
520
        reload_called, reload_func = self.make_reload_func()
 
521
        # Note that the 'filename' has been changed to 'different-packname'
 
522
        access = pack_repo._DirectPackAccess(
 
523
            {'foo':(transport, 'different-packname')},
 
524
            reload_func=reload_func)
 
525
        e = self.assertListRaises(errors.RetryWithNewPacks,
 
526
                                  access.get_raw_records, memos)
 
527
        # The file has gone missing, so we assume we need to reload
 
528
        self.assertFalse(e.reload_occurred)
 
529
        self.assertIsInstance(e.exc_info, tuple)
 
530
        self.assertIs(e.exc_info[0], errors.NoSuchFile)
 
531
        self.assertIsInstance(e.exc_info[1], errors.NoSuchFile)
 
532
        self.assertEqual('different-packname', e.exc_info[1].path)
 
533
 
 
534
    def test_missing_file_raises_no_such_file_with_no_reload(self):
 
535
        memos = self.make_pack_file()
 
536
        transport = self.get_transport()
 
537
        # Note that the 'filename' has been changed to 'different-packname'
 
538
        access = pack_repo._DirectPackAccess(
 
539
            {'foo': (transport, 'different-packname')})
 
540
        e = self.assertListRaises(errors.NoSuchFile,
 
541
                                  access.get_raw_records, memos)
 
542
 
 
543
    def test_failing_readv_raises_retry(self):
 
544
        memos = self.make_pack_file()
 
545
        transport = self.get_transport()
 
546
        failing_transport = MockReadvFailingTransport(
 
547
                                [transport.get_bytes('packname')])
 
548
        reload_called, reload_func = self.make_reload_func()
 
549
        access = pack_repo._DirectPackAccess(
 
550
            {'foo': (failing_transport, 'packname')},
 
551
            reload_func=reload_func)
 
552
        # Asking for a single record will not trigger the Mock failure
 
553
        self.assertEqual(['1234567890'],
 
554
            list(access.get_raw_records(memos[:1])))
 
555
        self.assertEqual(['12345'],
 
556
            list(access.get_raw_records(memos[1:2])))
 
557
        # A multiple offset readv() will fail mid-way through
 
558
        e = self.assertListRaises(errors.RetryWithNewPacks,
 
559
                                  access.get_raw_records, memos)
 
560
        # The file has gone missing, so we assume we need to reload
 
561
        self.assertFalse(e.reload_occurred)
 
562
        self.assertIsInstance(e.exc_info, tuple)
 
563
        self.assertIs(e.exc_info[0], errors.NoSuchFile)
 
564
        self.assertIsInstance(e.exc_info[1], errors.NoSuchFile)
 
565
        self.assertEqual('packname', e.exc_info[1].path)
 
566
 
 
567
    def test_failing_readv_raises_no_such_file_with_no_reload(self):
 
568
        memos = self.make_pack_file()
 
569
        transport = self.get_transport()
 
570
        failing_transport = MockReadvFailingTransport(
 
571
                                [transport.get_bytes('packname')])
 
572
        reload_called, reload_func = self.make_reload_func()
 
573
        access = pack_repo._DirectPackAccess(
 
574
            {'foo':(failing_transport, 'packname')})
 
575
        # Asking for a single record will not trigger the Mock failure
 
576
        self.assertEqual(['1234567890'],
 
577
            list(access.get_raw_records(memos[:1])))
 
578
        self.assertEqual(['12345'],
 
579
            list(access.get_raw_records(memos[1:2])))
 
580
        # A multiple offset readv() will fail mid-way through
 
581
        e = self.assertListRaises(errors.NoSuchFile,
 
582
                                  access.get_raw_records, memos)
 
583
 
 
584
    def test_reload_or_raise_no_reload(self):
 
585
        access = pack_repo._DirectPackAccess({}, reload_func=None)
 
586
        retry_exc = self.make_retry_exception()
 
587
        # Without a reload_func, we will just re-raise the original exception
 
588
        self.assertRaises(_TestException, access.reload_or_raise, retry_exc)
 
589
 
 
590
    def test_reload_or_raise_reload_changed(self):
 
591
        reload_called, reload_func = self.make_reload_func(return_val=True)
 
592
        access = pack_repo._DirectPackAccess({}, reload_func=reload_func)
 
593
        retry_exc = self.make_retry_exception()
 
594
        access.reload_or_raise(retry_exc)
 
595
        self.assertEqual([1], reload_called)
 
596
        retry_exc.reload_occurred=True
 
597
        access.reload_or_raise(retry_exc)
 
598
        self.assertEqual([2], reload_called)
 
599
 
 
600
    def test_reload_or_raise_reload_no_change(self):
 
601
        reload_called, reload_func = self.make_reload_func(return_val=False)
 
602
        access = pack_repo._DirectPackAccess({}, reload_func=reload_func)
 
603
        retry_exc = self.make_retry_exception()
 
604
        # If reload_occurred is False, then we consider it an error to have
 
605
        # reload_func() return False (no changes).
 
606
        self.assertRaises(_TestException, access.reload_or_raise, retry_exc)
 
607
        self.assertEqual([1], reload_called)
 
608
        retry_exc.reload_occurred=True
 
609
        # If reload_occurred is True, then we assume nothing changed because
 
610
        # it had changed earlier, but didn't change again
 
611
        access.reload_or_raise(retry_exc)
 
612
        self.assertEqual([2], reload_called)
 
613
 
 
614
    def test_annotate_retries(self):
 
615
        vf, reload_counter = self.make_vf_for_retrying()
 
616
        # It is a little bit bogus to annotate the Revision VF, but it works,
 
617
        # as we have ancestry stored there
 
618
        key = ('rev-3',)
 
619
        reload_lines = vf.annotate(key)
 
620
        self.assertEqual([1, 1, 0], reload_counter)
 
621
        plain_lines = vf.annotate(key)
 
622
        self.assertEqual([1, 1, 0], reload_counter) # No extra reloading
 
623
        if reload_lines != plain_lines:
 
624
            self.fail('Annotation was not identical with reloading.')
 
625
        # Now delete the packs-in-use, which should trigger another reload, but
 
626
        # this time we just raise an exception because we can't recover
 
627
        for trans, name in vf._access._indices.itervalues():
 
628
            trans.delete(name)
 
629
        self.assertRaises(errors.NoSuchFile, vf.annotate, key)
 
630
        self.assertEqual([2, 1, 1], reload_counter)
 
631
 
 
632
    def test__get_record_map_retries(self):
 
633
        vf, reload_counter = self.make_vf_for_retrying()
 
634
        keys = [('rev-1',), ('rev-2',), ('rev-3',)]
 
635
        records = vf._get_record_map(keys)
 
636
        self.assertEqual(keys, sorted(records.keys()))
 
637
        self.assertEqual([1, 1, 0], reload_counter)
 
638
        # Now delete the packs-in-use, which should trigger another reload, but
 
639
        # this time we just raise an exception because we can't recover
 
640
        for trans, name in vf._access._indices.itervalues():
 
641
            trans.delete(name)
 
642
        self.assertRaises(errors.NoSuchFile, vf._get_record_map, keys)
 
643
        self.assertEqual([2, 1, 1], reload_counter)
 
644
 
 
645
    def test_get_record_stream_retries(self):
 
646
        vf, reload_counter = self.make_vf_for_retrying()
 
647
        keys = [('rev-1',), ('rev-2',), ('rev-3',)]
 
648
        record_stream = vf.get_record_stream(keys, 'topological', False)
 
649
        record = record_stream.next()
 
650
        self.assertEqual(('rev-1',), record.key)
 
651
        self.assertEqual([0, 0, 0], reload_counter)
 
652
        record = record_stream.next()
 
653
        self.assertEqual(('rev-2',), record.key)
 
654
        self.assertEqual([1, 1, 0], reload_counter)
 
655
        record = record_stream.next()
 
656
        self.assertEqual(('rev-3',), record.key)
 
657
        self.assertEqual([1, 1, 0], reload_counter)
 
658
        # Now delete all pack files, and see that we raise the right error
 
659
        for trans, name in vf._access._indices.itervalues():
 
660
            trans.delete(name)
 
661
        self.assertListRaises(errors.NoSuchFile,
 
662
            vf.get_record_stream, keys, 'topological', False)
 
663
 
 
664
    def test_iter_lines_added_or_present_in_keys_retries(self):
 
665
        vf, reload_counter = self.make_vf_for_retrying()
 
666
        keys = [('rev-1',), ('rev-2',), ('rev-3',)]
 
667
        # Unfortunately, iter_lines_added_or_present_in_keys iterates the
 
668
        # result in random order (determined by the iteration order from a
 
669
        # set()), so we don't have any solid way to trigger whether data is
 
670
        # read before or after. However we tried to delete the middle node to
 
671
        # exercise the code well.
 
672
        # What we care about is that all lines are always yielded, but not
 
673
        # duplicated
 
674
        count = 0
 
675
        reload_lines = sorted(vf.iter_lines_added_or_present_in_keys(keys))
 
676
        self.assertEqual([1, 1, 0], reload_counter)
 
677
        # Now do it again, to make sure the result is equivalent
 
678
        plain_lines = sorted(vf.iter_lines_added_or_present_in_keys(keys))
 
679
        self.assertEqual([1, 1, 0], reload_counter) # No extra reloading
 
680
        self.assertEqual(plain_lines, reload_lines)
 
681
        self.assertEqual(21, len(plain_lines))
 
682
        # Now delete all pack files, and see that we raise the right error
 
683
        for trans, name in vf._access._indices.itervalues():
 
684
            trans.delete(name)
 
685
        self.assertListRaises(errors.NoSuchFile,
 
686
            vf.iter_lines_added_or_present_in_keys, keys)
 
687
        self.assertEqual([2, 1, 1], reload_counter)
 
688
 
 
689
    def test_get_record_stream_yields_disk_sorted_order(self):
 
690
        # if we get 'unordered' pick a semi-optimal order for reading. The
 
691
        # order should be grouped by pack file, and then by position in file
 
692
        repo = self.make_repository('test', format='pack-0.92')
 
693
        repo.lock_write()
 
694
        self.addCleanup(repo.unlock)
 
695
        repo.start_write_group()
 
696
        vf = repo.texts
 
697
        vf.add_lines(('f-id', 'rev-5'), [('f-id', 'rev-4')], ['lines\n'])
 
698
        vf.add_lines(('f-id', 'rev-1'), [], ['lines\n'])
 
699
        vf.add_lines(('f-id', 'rev-2'), [('f-id', 'rev-1')], ['lines\n'])
 
700
        repo.commit_write_group()
 
701
        # We inserted them as rev-5, rev-1, rev-2, we should get them back in
 
702
        # the same order
 
703
        stream = vf.get_record_stream([('f-id', 'rev-1'), ('f-id', 'rev-5'),
 
704
                                       ('f-id', 'rev-2')], 'unordered', False)
 
705
        keys = [r.key for r in stream]
 
706
        self.assertEqual([('f-id', 'rev-5'), ('f-id', 'rev-1'),
 
707
                          ('f-id', 'rev-2')], keys)
 
708
        repo.start_write_group()
 
709
        vf.add_lines(('f-id', 'rev-4'), [('f-id', 'rev-3')], ['lines\n'])
 
710
        vf.add_lines(('f-id', 'rev-3'), [('f-id', 'rev-2')], ['lines\n'])
 
711
        vf.add_lines(('f-id', 'rev-6'), [('f-id', 'rev-5')], ['lines\n'])
 
712
        repo.commit_write_group()
 
713
        # Request in random order, to make sure the output order isn't based on
 
714
        # the request
 
715
        request_keys = set(('f-id', 'rev-%d' % i) for i in range(1, 7))
 
716
        stream = vf.get_record_stream(request_keys, 'unordered', False)
 
717
        keys = [r.key for r in stream]
 
718
        # We want to get the keys back in disk order, but it doesn't matter
 
719
        # which pack we read from first. So this can come back in 2 orders
 
720
        alt1 = [('f-id', 'rev-%d' % i) for i in [4, 3, 6, 5, 1, 2]]
 
721
        alt2 = [('f-id', 'rev-%d' % i) for i in [5, 1, 2, 4, 3, 6]]
 
722
        if keys != alt1 and keys != alt2:
 
723
            self.fail('Returned key order did not match either expected order.'
 
724
                      ' expected %s or %s, not %s'
 
725
                      % (alt1, alt2, keys))
 
726
 
272
727
 
273
728
class LowLevelKnitDataTests(TestCase):
274
729
 
279
734
        gz_file.close()
280
735
        return sio.getvalue()
281
736
 
 
737
    def make_multiple_records(self):
 
738
        """Create the content for multiple records."""
 
739
        sha1sum = osutils.sha_string('foo\nbar\n')
 
740
        total_txt = []
 
741
        gz_txt = self.create_gz_content('version rev-id-1 2 %s\n'
 
742
                                        'foo\n'
 
743
                                        'bar\n'
 
744
                                        'end rev-id-1\n'
 
745
                                        % (sha1sum,))
 
746
        record_1 = (0, len(gz_txt), sha1sum)
 
747
        total_txt.append(gz_txt)
 
748
        sha1sum = osutils.sha_string('baz\n')
 
749
        gz_txt = self.create_gz_content('version rev-id-2 1 %s\n'
 
750
                                        'baz\n'
 
751
                                        'end rev-id-2\n'
 
752
                                        % (sha1sum,))
 
753
        record_2 = (record_1[1], len(gz_txt), sha1sum)
 
754
        total_txt.append(gz_txt)
 
755
        return total_txt, record_1, record_2
 
756
 
282
757
    def test_valid_knit_data(self):
283
 
        sha1sum = sha.new('foo\nbar\n').hexdigest()
 
758
        sha1sum = osutils.sha_string('foo\nbar\n')
284
759
        gz_txt = self.create_gz_content('version rev-id-1 2 %s\n'
285
760
                                        'foo\n'
286
761
                                        'bar\n'
287
762
                                        'end rev-id-1\n'
288
763
                                        % (sha1sum,))
289
764
        transport = MockTransport([gz_txt])
290
 
        access = _KnitAccess(transport, 'filename', None, None, False, False)
291
 
        data = _KnitData(access=access)
292
 
        records = [('rev-id-1', (None, 0, len(gz_txt)))]
293
 
 
294
 
        contents = data.read_records(records)
295
 
        self.assertEqual({'rev-id-1':(['foo\n', 'bar\n'], sha1sum)}, contents)
296
 
 
297
 
        raw_contents = list(data.read_records_iter_raw(records))
298
 
        self.assertEqual([('rev-id-1', gz_txt)], raw_contents)
 
765
        access = _KnitKeyAccess(transport, ConstantMapper('filename'))
 
766
        knit = KnitVersionedFiles(None, access)
 
767
        records = [(('rev-id-1',), (('rev-id-1',), 0, len(gz_txt)))]
 
768
 
 
769
        contents = list(knit._read_records_iter(records))
 
770
        self.assertEqual([(('rev-id-1',), ['foo\n', 'bar\n'],
 
771
            '4e48e2c9a3d2ca8a708cb0cc545700544efb5021')], contents)
 
772
 
 
773
        raw_contents = list(knit._read_records_iter_raw(records))
 
774
        self.assertEqual([(('rev-id-1',), gz_txt, sha1sum)], raw_contents)
 
775
 
 
776
    def test_multiple_records_valid(self):
 
777
        total_txt, record_1, record_2 = self.make_multiple_records()
 
778
        transport = MockTransport([''.join(total_txt)])
 
779
        access = _KnitKeyAccess(transport, ConstantMapper('filename'))
 
780
        knit = KnitVersionedFiles(None, access)
 
781
        records = [(('rev-id-1',), (('rev-id-1',), record_1[0], record_1[1])),
 
782
                   (('rev-id-2',), (('rev-id-2',), record_2[0], record_2[1]))]
 
783
 
 
784
        contents = list(knit._read_records_iter(records))
 
785
        self.assertEqual([(('rev-id-1',), ['foo\n', 'bar\n'], record_1[2]),
 
786
                          (('rev-id-2',), ['baz\n'], record_2[2])],
 
787
                         contents)
 
788
 
 
789
        raw_contents = list(knit._read_records_iter_raw(records))
 
790
        self.assertEqual([(('rev-id-1',), total_txt[0], record_1[2]),
 
791
                          (('rev-id-2',), total_txt[1], record_2[2])],
 
792
                         raw_contents)
299
793
 
300
794
    def test_not_enough_lines(self):
301
 
        sha1sum = sha.new('foo\n').hexdigest()
 
795
        sha1sum = osutils.sha_string('foo\n')
302
796
        # record says 2 lines data says 1
303
797
        gz_txt = self.create_gz_content('version rev-id-1 2 %s\n'
304
798
                                        'foo\n'
305
799
                                        'end rev-id-1\n'
306
800
                                        % (sha1sum,))
307
801
        transport = MockTransport([gz_txt])
308
 
        access = _KnitAccess(transport, 'filename', None, None, False, False)
309
 
        data = _KnitData(access=access)
310
 
        records = [('rev-id-1', (None, 0, len(gz_txt)))]
311
 
        self.assertRaises(errors.KnitCorrupt, data.read_records, records)
 
802
        access = _KnitKeyAccess(transport, ConstantMapper('filename'))
 
803
        knit = KnitVersionedFiles(None, access)
 
804
        records = [(('rev-id-1',), (('rev-id-1',), 0, len(gz_txt)))]
 
805
        self.assertRaises(errors.KnitCorrupt, list,
 
806
            knit._read_records_iter(records))
312
807
 
313
808
        # read_records_iter_raw won't detect that sort of mismatch/corruption
314
 
        raw_contents = list(data.read_records_iter_raw(records))
315
 
        self.assertEqual([('rev-id-1', gz_txt)], raw_contents)
 
809
        raw_contents = list(knit._read_records_iter_raw(records))
 
810
        self.assertEqual([(('rev-id-1',),  gz_txt, sha1sum)], raw_contents)
316
811
 
317
812
    def test_too_many_lines(self):
318
 
        sha1sum = sha.new('foo\nbar\n').hexdigest()
 
813
        sha1sum = osutils.sha_string('foo\nbar\n')
319
814
        # record says 1 lines data says 2
320
815
        gz_txt = self.create_gz_content('version rev-id-1 1 %s\n'
321
816
                                        'foo\n'
323
818
                                        'end rev-id-1\n'
324
819
                                        % (sha1sum,))
325
820
        transport = MockTransport([gz_txt])
326
 
        access = _KnitAccess(transport, 'filename', None, None, False, False)
327
 
        data = _KnitData(access=access)
328
 
        records = [('rev-id-1', (None, 0, len(gz_txt)))]
329
 
        self.assertRaises(errors.KnitCorrupt, data.read_records, records)
 
821
        access = _KnitKeyAccess(transport, ConstantMapper('filename'))
 
822
        knit = KnitVersionedFiles(None, access)
 
823
        records = [(('rev-id-1',), (('rev-id-1',), 0, len(gz_txt)))]
 
824
        self.assertRaises(errors.KnitCorrupt, list,
 
825
            knit._read_records_iter(records))
330
826
 
331
827
        # read_records_iter_raw won't detect that sort of mismatch/corruption
332
 
        raw_contents = list(data.read_records_iter_raw(records))
333
 
        self.assertEqual([('rev-id-1', gz_txt)], raw_contents)
 
828
        raw_contents = list(knit._read_records_iter_raw(records))
 
829
        self.assertEqual([(('rev-id-1',), gz_txt, sha1sum)], raw_contents)
334
830
 
335
831
    def test_mismatched_version_id(self):
336
 
        sha1sum = sha.new('foo\nbar\n').hexdigest()
 
832
        sha1sum = osutils.sha_string('foo\nbar\n')
337
833
        gz_txt = self.create_gz_content('version rev-id-1 2 %s\n'
338
834
                                        'foo\n'
339
835
                                        'bar\n'
340
836
                                        'end rev-id-1\n'
341
837
                                        % (sha1sum,))
342
838
        transport = MockTransport([gz_txt])
343
 
        access = _KnitAccess(transport, 'filename', None, None, False, False)
344
 
        data = _KnitData(access=access)
 
839
        access = _KnitKeyAccess(transport, ConstantMapper('filename'))
 
840
        knit = KnitVersionedFiles(None, access)
345
841
        # We are asking for rev-id-2, but the data is rev-id-1
346
 
        records = [('rev-id-2', (None, 0, len(gz_txt)))]
347
 
        self.assertRaises(errors.KnitCorrupt, data.read_records, records)
 
842
        records = [(('rev-id-2',), (('rev-id-2',), 0, len(gz_txt)))]
 
843
        self.assertRaises(errors.KnitCorrupt, list,
 
844
            knit._read_records_iter(records))
348
845
 
349
 
        # read_records_iter_raw will notice if we request the wrong version.
 
846
        # read_records_iter_raw detects mismatches in the header
350
847
        self.assertRaises(errors.KnitCorrupt, list,
351
 
                          data.read_records_iter_raw(records))
 
848
            knit._read_records_iter_raw(records))
352
849
 
353
850
    def test_uncompressed_data(self):
354
 
        sha1sum = sha.new('foo\nbar\n').hexdigest()
 
851
        sha1sum = osutils.sha_string('foo\nbar\n')
355
852
        txt = ('version rev-id-1 2 %s\n'
356
853
               'foo\n'
357
854
               'bar\n'
358
855
               'end rev-id-1\n'
359
856
               % (sha1sum,))
360
857
        transport = MockTransport([txt])
361
 
        access = _KnitAccess(transport, 'filename', None, None, False, False)
362
 
        data = _KnitData(access=access)
363
 
        records = [('rev-id-1', (None, 0, len(txt)))]
 
858
        access = _KnitKeyAccess(transport, ConstantMapper('filename'))
 
859
        knit = KnitVersionedFiles(None, access)
 
860
        records = [(('rev-id-1',), (('rev-id-1',), 0, len(txt)))]
364
861
 
365
862
        # We don't have valid gzip data ==> corrupt
366
 
        self.assertRaises(errors.KnitCorrupt, data.read_records, records)
 
863
        self.assertRaises(errors.KnitCorrupt, list,
 
864
            knit._read_records_iter(records))
367
865
 
368
866
        # read_records_iter_raw will notice the bad data
369
867
        self.assertRaises(errors.KnitCorrupt, list,
370
 
                          data.read_records_iter_raw(records))
 
868
            knit._read_records_iter_raw(records))
371
869
 
372
870
    def test_corrupted_data(self):
373
 
        sha1sum = sha.new('foo\nbar\n').hexdigest()
 
871
        sha1sum = osutils.sha_string('foo\nbar\n')
374
872
        gz_txt = self.create_gz_content('version rev-id-1 2 %s\n'
375
873
                                        'foo\n'
376
874
                                        'bar\n'
379
877
        # Change 2 bytes in the middle to \xff
380
878
        gz_txt = gz_txt[:10] + '\xff\xff' + gz_txt[12:]
381
879
        transport = MockTransport([gz_txt])
382
 
        access = _KnitAccess(transport, 'filename', None, None, False, False)
383
 
        data = _KnitData(access=access)
384
 
        records = [('rev-id-1', (None, 0, len(gz_txt)))]
385
 
 
386
 
        self.assertRaises(errors.KnitCorrupt, data.read_records, records)
387
 
 
388
 
        # read_records_iter_raw will notice if we request the wrong version.
389
 
        self.assertRaises(errors.KnitCorrupt, list,
390
 
                          data.read_records_iter_raw(records))
 
880
        access = _KnitKeyAccess(transport, ConstantMapper('filename'))
 
881
        knit = KnitVersionedFiles(None, access)
 
882
        records = [(('rev-id-1',), (('rev-id-1',), 0, len(gz_txt)))]
 
883
        self.assertRaises(errors.KnitCorrupt, list,
 
884
            knit._read_records_iter(records))
 
885
        # read_records_iter_raw will barf on bad gz data
 
886
        self.assertRaises(errors.KnitCorrupt, list,
 
887
            knit._read_records_iter_raw(records))
391
888
 
392
889
 
393
890
class LowLevelKnitIndexTests(TestCase):
394
891
 
395
 
    def get_knit_index(self, *args, **kwargs):
396
 
        orig = knit._load_data
397
 
        def reset():
398
 
            knit._load_data = orig
399
 
        self.addCleanup(reset)
 
892
    def get_knit_index(self, transport, name, mode):
 
893
        mapper = ConstantMapper(name)
400
894
        from bzrlib._knit_load_data_py import _load_data_py
401
 
        knit._load_data = _load_data_py
402
 
        return _KnitIndex(*args, **kwargs)
403
 
 
404
 
    def test_no_such_file(self):
405
 
        transport = MockTransport()
406
 
 
407
 
        self.assertRaises(NoSuchFile, self.get_knit_index,
408
 
                          transport, "filename", "r")
409
 
        self.assertRaises(NoSuchFile, self.get_knit_index,
410
 
                          transport, "filename", "w", create=False)
 
895
        self.overrideAttr(knit, '_load_data', _load_data_py)
 
896
        allow_writes = lambda: 'w' in mode
 
897
        return _KndxIndex(transport, mapper, lambda:None, allow_writes, lambda:True)
411
898
 
412
899
    def test_create_file(self):
413
900
        transport = MockTransport()
414
 
 
415
 
        index = self.get_knit_index(transport, "filename", "w",
416
 
            file_mode="wb", create=True)
417
 
        self.assertEqual(
418
 
                ("put_bytes_non_atomic",
419
 
                    ("filename", index.HEADER), {"mode": "wb"}),
420
 
                transport.calls.pop(0))
421
 
 
422
 
    def test_delay_create_file(self):
423
 
        transport = MockTransport()
424
 
 
425
 
        index = self.get_knit_index(transport, "filename", "w",
426
 
            create=True, file_mode="wb", create_parent_dir=True,
427
 
            delay_create=True, dir_mode=0777)
428
 
        self.assertEqual([], transport.calls)
429
 
 
430
 
        index.add_versions([])
431
 
        name, (filename, f), kwargs = transport.calls.pop(0)
432
 
        self.assertEqual("put_file_non_atomic", name)
433
 
        self.assertEqual(
434
 
            {"dir_mode": 0777, "create_parent_dir": True, "mode": "wb"},
435
 
            kwargs)
436
 
        self.assertEqual("filename", filename)
437
 
        self.assertEqual(index.HEADER, f.read())
438
 
 
439
 
        index.add_versions([])
440
 
        self.assertEqual(("append_bytes", ("filename", ""), {}),
441
 
            transport.calls.pop(0))
 
901
        index = self.get_knit_index(transport, "filename", "w")
 
902
        index.keys()
 
903
        call = transport.calls.pop(0)
 
904
        # call[1][1] is a StringIO - we can't test it by simple equality.
 
905
        self.assertEqual('put_file_non_atomic', call[0])
 
906
        self.assertEqual('filename.kndx', call[1][0])
 
907
        # With no history, _KndxIndex writes a new index:
 
908
        self.assertEqual(_KndxIndex.HEADER,
 
909
            call[1][1].getvalue())
 
910
        self.assertEqual({'create_parent_dir': True}, call[2])
442
911
 
443
912
    def test_read_utf8_version_id(self):
444
913
        unicode_revision_id = u"version-\N{CYRILLIC CAPITAL LETTER A}"
445
914
        utf8_revision_id = unicode_revision_id.encode('utf-8')
446
915
        transport = MockTransport([
447
 
            _KnitIndex.HEADER,
 
916
            _KndxIndex.HEADER,
448
917
            '%s option 0 1 :' % (utf8_revision_id,)
449
918
            ])
450
919
        index = self.get_knit_index(transport, "filename", "r")
451
 
        # _KnitIndex is a private class, and deals in utf8 revision_ids, not
 
920
        # _KndxIndex is a private class, and deals in utf8 revision_ids, not
452
921
        # Unicode revision_ids.
453
 
        self.assertTrue(index.has_version(utf8_revision_id))
454
 
        self.assertFalse(index.has_version(unicode_revision_id))
 
922
        self.assertEqual({(utf8_revision_id,):()},
 
923
            index.get_parent_map(index.keys()))
 
924
        self.assertFalse((unicode_revision_id,) in index.keys())
455
925
 
456
926
    def test_read_utf8_parents(self):
457
927
        unicode_revision_id = u"version-\N{CYRILLIC CAPITAL LETTER A}"
458
928
        utf8_revision_id = unicode_revision_id.encode('utf-8')
459
929
        transport = MockTransport([
460
 
            _KnitIndex.HEADER,
 
930
            _KndxIndex.HEADER,
461
931
            "version option 0 1 .%s :" % (utf8_revision_id,)
462
932
            ])
463
933
        index = self.get_knit_index(transport, "filename", "r")
464
 
        self.assertEqual([utf8_revision_id],
465
 
            index.get_parents_with_ghosts("version"))
 
934
        self.assertEqual({("version",):((utf8_revision_id,),)},
 
935
            index.get_parent_map(index.keys()))
466
936
 
467
937
    def test_read_ignore_corrupted_lines(self):
468
938
        transport = MockTransport([
469
 
            _KnitIndex.HEADER,
 
939
            _KndxIndex.HEADER,
470
940
            "corrupted",
471
941
            "corrupted options 0 1 .b .c ",
472
942
            "version options 0 1 :"
473
943
            ])
474
944
        index = self.get_knit_index(transport, "filename", "r")
475
 
        self.assertEqual(1, index.num_versions())
476
 
        self.assertTrue(index.has_version("version"))
 
945
        self.assertEqual(1, len(index.keys()))
 
946
        self.assertEqual(set([("version",)]), index.keys())
477
947
 
478
948
    def test_read_corrupted_header(self):
479
949
        transport = MockTransport(['not a bzr knit index header\n'])
480
 
        self.assertRaises(KnitHeaderError,
481
 
            self.get_knit_index, transport, "filename", "r")
 
950
        index = self.get_knit_index(transport, "filename", "r")
 
951
        self.assertRaises(KnitHeaderError, index.keys)
482
952
 
483
953
    def test_read_duplicate_entries(self):
484
954
        transport = MockTransport([
485
 
            _KnitIndex.HEADER,
 
955
            _KndxIndex.HEADER,
486
956
            "parent options 0 1 :",
487
957
            "version options1 0 1 0 :",
488
958
            "version options2 1 2 .other :",
489
959
            "version options3 3 4 0 .other :"
490
960
            ])
491
961
        index = self.get_knit_index(transport, "filename", "r")
492
 
        self.assertEqual(2, index.num_versions())
 
962
        self.assertEqual(2, len(index.keys()))
493
963
        # check that the index used is the first one written. (Specific
494
964
        # to KnitIndex style indices.
495
 
        self.assertEqual("1", index._version_list_to_index(["version"]))
496
 
        self.assertEqual((None, 3, 4), index.get_position("version"))
497
 
        self.assertEqual(["options3"], index.get_options("version"))
498
 
        self.assertEqual(["parent", "other"],
499
 
            index.get_parents_with_ghosts("version"))
 
965
        self.assertEqual("1", index._dictionary_compress([("version",)]))
 
966
        self.assertEqual((("version",), 3, 4), index.get_position(("version",)))
 
967
        self.assertEqual(["options3"], index.get_options(("version",)))
 
968
        self.assertEqual({("version",):(("parent",), ("other",))},
 
969
            index.get_parent_map([("version",)]))
500
970
 
501
971
    def test_read_compressed_parents(self):
502
972
        transport = MockTransport([
503
 
            _KnitIndex.HEADER,
 
973
            _KndxIndex.HEADER,
504
974
            "a option 0 1 :",
505
975
            "b option 0 1 0 :",
506
976
            "c option 0 1 1 0 :",
507
977
            ])
508
978
        index = self.get_knit_index(transport, "filename", "r")
509
 
        self.assertEqual(["a"], index.get_parents("b"))
510
 
        self.assertEqual(["b", "a"], index.get_parents("c"))
 
979
        self.assertEqual({("b",):(("a",),), ("c",):(("b",), ("a",))},
 
980
            index.get_parent_map([("b",), ("c",)]))
511
981
 
512
982
    def test_write_utf8_version_id(self):
513
983
        unicode_revision_id = u"version-\N{CYRILLIC CAPITAL LETTER A}"
514
984
        utf8_revision_id = unicode_revision_id.encode('utf-8')
515
985
        transport = MockTransport([
516
 
            _KnitIndex.HEADER
 
986
            _KndxIndex.HEADER
517
987
            ])
518
988
        index = self.get_knit_index(transport, "filename", "r")
519
 
        index.add_version(utf8_revision_id, ["option"], (None, 0, 1), [])
520
 
        self.assertEqual(("append_bytes", ("filename",
521
 
            "\n%s option 0 1  :" % (utf8_revision_id,)),
522
 
            {}),
523
 
            transport.calls.pop(0))
 
989
        index.add_records([
 
990
            ((utf8_revision_id,), ["option"], ((utf8_revision_id,), 0, 1), [])])
 
991
        call = transport.calls.pop(0)
 
992
        # call[1][1] is a StringIO - we can't test it by simple equality.
 
993
        self.assertEqual('put_file_non_atomic', call[0])
 
994
        self.assertEqual('filename.kndx', call[1][0])
 
995
        # With no history, _KndxIndex writes a new index:
 
996
        self.assertEqual(_KndxIndex.HEADER +
 
997
            "\n%s option 0 1  :" % (utf8_revision_id,),
 
998
            call[1][1].getvalue())
 
999
        self.assertEqual({'create_parent_dir': True}, call[2])
524
1000
 
525
1001
    def test_write_utf8_parents(self):
526
1002
        unicode_revision_id = u"version-\N{CYRILLIC CAPITAL LETTER A}"
527
1003
        utf8_revision_id = unicode_revision_id.encode('utf-8')
528
1004
        transport = MockTransport([
529
 
            _KnitIndex.HEADER
530
 
            ])
531
 
        index = self.get_knit_index(transport, "filename", "r")
532
 
        index.add_version("version", ["option"], (None, 0, 1), [utf8_revision_id])
533
 
        self.assertEqual(("append_bytes", ("filename",
534
 
            "\nversion option 0 1 .%s :" % (utf8_revision_id,)),
535
 
            {}),
536
 
            transport.calls.pop(0))
537
 
 
538
 
    def test_get_graph(self):
539
 
        transport = MockTransport()
540
 
        index = self.get_knit_index(transport, "filename", "w", create=True)
541
 
        self.assertEqual([], index.get_graph())
542
 
 
543
 
        index.add_version("a", ["option"], (None, 0, 1), ["b"])
544
 
        self.assertEqual([("a", ["b"])], index.get_graph())
545
 
 
546
 
        index.add_version("c", ["option"], (None, 0, 1), ["d"])
547
 
        self.assertEqual([("a", ["b"]), ("c", ["d"])],
548
 
            sorted(index.get_graph()))
549
 
 
550
 
    def test_get_ancestry(self):
551
 
        transport = MockTransport([
552
 
            _KnitIndex.HEADER,
553
 
            "a option 0 1 :",
554
 
            "b option 0 1 0 .e :",
555
 
            "c option 0 1 1 0 :",
556
 
            "d option 0 1 2 .f :"
557
 
            ])
558
 
        index = self.get_knit_index(transport, "filename", "r")
559
 
 
560
 
        self.assertEqual([], index.get_ancestry([]))
561
 
        self.assertEqual(["a"], index.get_ancestry(["a"]))
562
 
        self.assertEqual(["a", "b"], index.get_ancestry(["b"]))
563
 
        self.assertEqual(["a", "b", "c"], index.get_ancestry(["c"]))
564
 
        self.assertEqual(["a", "b", "c", "d"], index.get_ancestry(["d"]))
565
 
        self.assertEqual(["a", "b"], index.get_ancestry(["a", "b"]))
566
 
        self.assertEqual(["a", "b", "c"], index.get_ancestry(["a", "c"]))
567
 
 
568
 
        self.assertRaises(RevisionNotPresent, index.get_ancestry, ["e"])
569
 
 
570
 
    def test_get_ancestry_with_ghosts(self):
571
 
        transport = MockTransport([
572
 
            _KnitIndex.HEADER,
573
 
            "a option 0 1 :",
574
 
            "b option 0 1 0 .e :",
575
 
            "c option 0 1 0 .f .g :",
576
 
            "d option 0 1 2 .h .j .k :"
577
 
            ])
578
 
        index = self.get_knit_index(transport, "filename", "r")
579
 
 
580
 
        self.assertEqual([], index.get_ancestry_with_ghosts([]))
581
 
        self.assertEqual(["a"], index.get_ancestry_with_ghosts(["a"]))
582
 
        self.assertEqual(["a", "e", "b"],
583
 
            index.get_ancestry_with_ghosts(["b"]))
584
 
        self.assertEqual(["a", "g", "f", "c"],
585
 
            index.get_ancestry_with_ghosts(["c"]))
586
 
        self.assertEqual(["a", "g", "f", "c", "k", "j", "h", "d"],
587
 
            index.get_ancestry_with_ghosts(["d"]))
588
 
        self.assertEqual(["a", "e", "b"],
589
 
            index.get_ancestry_with_ghosts(["a", "b"]))
590
 
        self.assertEqual(["a", "g", "f", "c"],
591
 
            index.get_ancestry_with_ghosts(["a", "c"]))
 
1005
            _KndxIndex.HEADER
 
1006
            ])
 
1007
        index = self.get_knit_index(transport, "filename", "r")
 
1008
        index.add_records([
 
1009
            (("version",), ["option"], (("version",), 0, 1), [(utf8_revision_id,)])])
 
1010
        call = transport.calls.pop(0)
 
1011
        # call[1][1] is a StringIO - we can't test it by simple equality.
 
1012
        self.assertEqual('put_file_non_atomic', call[0])
 
1013
        self.assertEqual('filename.kndx', call[1][0])
 
1014
        # With no history, _KndxIndex writes a new index:
 
1015
        self.assertEqual(_KndxIndex.HEADER +
 
1016
            "\nversion option 0 1 .%s :" % (utf8_revision_id,),
 
1017
            call[1][1].getvalue())
 
1018
        self.assertEqual({'create_parent_dir': True}, call[2])
 
1019
 
 
1020
    def test_keys(self):
 
1021
        transport = MockTransport([
 
1022
            _KndxIndex.HEADER
 
1023
            ])
 
1024
        index = self.get_knit_index(transport, "filename", "r")
 
1025
 
 
1026
        self.assertEqual(set(), index.keys())
 
1027
 
 
1028
        index.add_records([(("a",), ["option"], (("a",), 0, 1), [])])
 
1029
        self.assertEqual(set([("a",)]), index.keys())
 
1030
 
 
1031
        index.add_records([(("a",), ["option"], (("a",), 0, 1), [])])
 
1032
        self.assertEqual(set([("a",)]), index.keys())
 
1033
 
 
1034
        index.add_records([(("b",), ["option"], (("b",), 0, 1), [])])
 
1035
        self.assertEqual(set([("a",), ("b",)]), index.keys())
 
1036
 
 
1037
    def add_a_b(self, index, random_id=None):
 
1038
        kwargs = {}
 
1039
        if random_id is not None:
 
1040
            kwargs["random_id"] = random_id
 
1041
        index.add_records([
 
1042
            (("a",), ["option"], (("a",), 0, 1), [("b",)]),
 
1043
            (("a",), ["opt"], (("a",), 1, 2), [("c",)]),
 
1044
            (("b",), ["option"], (("b",), 2, 3), [("a",)])
 
1045
            ], **kwargs)
 
1046
 
 
1047
    def assertIndexIsAB(self, index):
 
1048
        self.assertEqual({
 
1049
            ('a',): (('c',),),
 
1050
            ('b',): (('a',),),
 
1051
            },
 
1052
            index.get_parent_map(index.keys()))
 
1053
        self.assertEqual((("a",), 1, 2), index.get_position(("a",)))
 
1054
        self.assertEqual((("b",), 2, 3), index.get_position(("b",)))
 
1055
        self.assertEqual(["opt"], index.get_options(("a",)))
 
1056
 
 
1057
    def test_add_versions(self):
 
1058
        transport = MockTransport([
 
1059
            _KndxIndex.HEADER
 
1060
            ])
 
1061
        index = self.get_knit_index(transport, "filename", "r")
 
1062
 
 
1063
        self.add_a_b(index)
 
1064
        call = transport.calls.pop(0)
 
1065
        # call[1][1] is a StringIO - we can't test it by simple equality.
 
1066
        self.assertEqual('put_file_non_atomic', call[0])
 
1067
        self.assertEqual('filename.kndx', call[1][0])
 
1068
        # With no history, _KndxIndex writes a new index:
592
1069
        self.assertEqual(
593
 
            ["a", "g", "f", "c", "e", "b", "k", "j", "h", "d"],
594
 
            index.get_ancestry_with_ghosts(["b", "d"]))
595
 
 
596
 
        self.assertRaises(RevisionNotPresent,
597
 
            index.get_ancestry_with_ghosts, ["e"])
598
 
 
599
 
    def test_iter_parents(self):
600
 
        transport = MockTransport()
601
 
        index = self.get_knit_index(transport, "filename", "w", create=True)
602
 
        # no parents
603
 
        index.add_version('r0', ['option'], (None, 0, 1), [])
604
 
        # 1 parent
605
 
        index.add_version('r1', ['option'], (None, 0, 1), ['r0'])
606
 
        # 2 parents
607
 
        index.add_version('r2', ['option'], (None, 0, 1), ['r1', 'r0'])
608
 
        # XXX TODO a ghost
609
 
        # cases: each sample data individually:
610
 
        self.assertEqual(set([('r0', ())]),
611
 
            set(index.iter_parents(['r0'])))
612
 
        self.assertEqual(set([('r1', ('r0', ))]),
613
 
            set(index.iter_parents(['r1'])))
614
 
        self.assertEqual(set([('r2', ('r1', 'r0'))]),
615
 
            set(index.iter_parents(['r2'])))
616
 
        # no nodes returned for a missing node
617
 
        self.assertEqual(set(),
618
 
            set(index.iter_parents(['missing'])))
619
 
        # 1 node returned with missing nodes skipped
620
 
        self.assertEqual(set([('r1', ('r0', ))]),
621
 
            set(index.iter_parents(['ghost1', 'r1', 'ghost'])))
622
 
        # 2 nodes returned
623
 
        self.assertEqual(set([('r0', ()), ('r1', ('r0', ))]),
624
 
            set(index.iter_parents(['r0', 'r1'])))
625
 
        # 2 nodes returned, missing skipped
626
 
        self.assertEqual(set([('r0', ()), ('r1', ('r0', ))]),
627
 
            set(index.iter_parents(['a', 'r0', 'b', 'r1', 'c'])))
628
 
 
629
 
    def test_num_versions(self):
630
 
        transport = MockTransport([
631
 
            _KnitIndex.HEADER
632
 
            ])
633
 
        index = self.get_knit_index(transport, "filename", "r")
634
 
 
635
 
        self.assertEqual(0, index.num_versions())
636
 
        self.assertEqual(0, len(index))
637
 
 
638
 
        index.add_version("a", ["option"], (None, 0, 1), [])
639
 
        self.assertEqual(1, index.num_versions())
640
 
        self.assertEqual(1, len(index))
641
 
 
642
 
        index.add_version("a", ["option2"], (None, 1, 2), [])
643
 
        self.assertEqual(1, index.num_versions())
644
 
        self.assertEqual(1, len(index))
645
 
 
646
 
        index.add_version("b", ["option"], (None, 0, 1), [])
647
 
        self.assertEqual(2, index.num_versions())
648
 
        self.assertEqual(2, len(index))
649
 
 
650
 
    def test_get_versions(self):
651
 
        transport = MockTransport([
652
 
            _KnitIndex.HEADER
653
 
            ])
654
 
        index = self.get_knit_index(transport, "filename", "r")
655
 
 
656
 
        self.assertEqual([], index.get_versions())
657
 
 
658
 
        index.add_version("a", ["option"], (None, 0, 1), [])
659
 
        self.assertEqual(["a"], index.get_versions())
660
 
 
661
 
        index.add_version("a", ["option"], (None, 0, 1), [])
662
 
        self.assertEqual(["a"], index.get_versions())
663
 
 
664
 
        index.add_version("b", ["option"], (None, 0, 1), [])
665
 
        self.assertEqual(["a", "b"], index.get_versions())
666
 
 
667
 
    def test_add_version(self):
668
 
        transport = MockTransport([
669
 
            _KnitIndex.HEADER
670
 
            ])
671
 
        index = self.get_knit_index(transport, "filename", "r")
672
 
 
673
 
        index.add_version("a", ["option"], (None, 0, 1), ["b"])
674
 
        self.assertEqual(("append_bytes",
675
 
            ("filename", "\na option 0 1 .b :"),
676
 
            {}), transport.calls.pop(0))
677
 
        self.assertTrue(index.has_version("a"))
678
 
        self.assertEqual(1, index.num_versions())
679
 
        self.assertEqual((None, 0, 1), index.get_position("a"))
680
 
        self.assertEqual(["option"], index.get_options("a"))
681
 
        self.assertEqual(["b"], index.get_parents_with_ghosts("a"))
682
 
 
683
 
        index.add_version("a", ["opt"], (None, 1, 2), ["c"])
684
 
        self.assertEqual(("append_bytes",
685
 
            ("filename", "\na opt 1 2 .c :"),
686
 
            {}), transport.calls.pop(0))
687
 
        self.assertTrue(index.has_version("a"))
688
 
        self.assertEqual(1, index.num_versions())
689
 
        self.assertEqual((None, 1, 2), index.get_position("a"))
690
 
        self.assertEqual(["opt"], index.get_options("a"))
691
 
        self.assertEqual(["c"], index.get_parents_with_ghosts("a"))
692
 
 
693
 
        index.add_version("b", ["option"], (None, 2, 3), ["a"])
694
 
        self.assertEqual(("append_bytes",
695
 
            ("filename", "\nb option 2 3 0 :"),
696
 
            {}), transport.calls.pop(0))
697
 
        self.assertTrue(index.has_version("b"))
698
 
        self.assertEqual(2, index.num_versions())
699
 
        self.assertEqual((None, 2, 3), index.get_position("b"))
700
 
        self.assertEqual(["option"], index.get_options("b"))
701
 
        self.assertEqual(["a"], index.get_parents_with_ghosts("b"))
702
 
 
703
 
    def test_add_versions(self):
704
 
        transport = MockTransport([
705
 
            _KnitIndex.HEADER
706
 
            ])
707
 
        index = self.get_knit_index(transport, "filename", "r")
708
 
 
709
 
        index.add_versions([
710
 
            ("a", ["option"], (None, 0, 1), ["b"]),
711
 
            ("a", ["opt"], (None, 1, 2), ["c"]),
712
 
            ("b", ["option"], (None, 2, 3), ["a"])
713
 
            ])
714
 
        self.assertEqual(("append_bytes", ("filename",
 
1070
            _KndxIndex.HEADER +
715
1071
            "\na option 0 1 .b :"
716
1072
            "\na opt 1 2 .c :"
717
 
            "\nb option 2 3 0 :"
718
 
            ), {}), transport.calls.pop(0))
719
 
        self.assertTrue(index.has_version("a"))
720
 
        self.assertTrue(index.has_version("b"))
721
 
        self.assertEqual(2, index.num_versions())
722
 
        self.assertEqual((None, 1, 2), index.get_position("a"))
723
 
        self.assertEqual((None, 2, 3), index.get_position("b"))
724
 
        self.assertEqual(["opt"], index.get_options("a"))
725
 
        self.assertEqual(["option"], index.get_options("b"))
726
 
        self.assertEqual(["c"], index.get_parents_with_ghosts("a"))
727
 
        self.assertEqual(["a"], index.get_parents_with_ghosts("b"))
 
1073
            "\nb option 2 3 0 :",
 
1074
            call[1][1].getvalue())
 
1075
        self.assertEqual({'create_parent_dir': True}, call[2])
 
1076
        self.assertIndexIsAB(index)
 
1077
 
 
1078
    def test_add_versions_random_id_is_accepted(self):
 
1079
        transport = MockTransport([
 
1080
            _KndxIndex.HEADER
 
1081
            ])
 
1082
        index = self.get_knit_index(transport, "filename", "r")
 
1083
        self.add_a_b(index, random_id=True)
728
1084
 
729
1085
    def test_delay_create_and_add_versions(self):
730
1086
        transport = MockTransport()
731
1087
 
732
 
        index = self.get_knit_index(transport, "filename", "w",
733
 
            create=True, file_mode="wb", create_parent_dir=True,
734
 
            delay_create=True, dir_mode=0777)
 
1088
        index = self.get_knit_index(transport, "filename", "w")
 
1089
        # dir_mode=0777)
735
1090
        self.assertEqual([], transport.calls)
736
 
 
737
 
        index.add_versions([
738
 
            ("a", ["option"], (None, 0, 1), ["b"]),
739
 
            ("a", ["opt"], (None, 1, 2), ["c"]),
740
 
            ("b", ["option"], (None, 2, 3), ["a"])
741
 
            ])
742
 
        name, (filename, f), kwargs = transport.calls.pop(0)
743
 
        self.assertEqual("put_file_non_atomic", name)
744
 
        self.assertEqual(
745
 
            {"dir_mode": 0777, "create_parent_dir": True, "mode": "wb"},
746
 
            kwargs)
747
 
        self.assertEqual("filename", filename)
748
 
        self.assertEqual(
749
 
            index.HEADER +
 
1091
        self.add_a_b(index)
 
1092
        #self.assertEqual(
 
1093
        #[    {"dir_mode": 0777, "create_parent_dir": True, "mode": "wb"},
 
1094
        #    kwargs)
 
1095
        # Two calls: one during which we load the existing index (and when its
 
1096
        # missing create it), then a second where we write the contents out.
 
1097
        self.assertEqual(2, len(transport.calls))
 
1098
        call = transport.calls.pop(0)
 
1099
        self.assertEqual('put_file_non_atomic', call[0])
 
1100
        self.assertEqual('filename.kndx', call[1][0])
 
1101
        # With no history, _KndxIndex writes a new index:
 
1102
        self.assertEqual(_KndxIndex.HEADER, call[1][1].getvalue())
 
1103
        self.assertEqual({'create_parent_dir': True}, call[2])
 
1104
        call = transport.calls.pop(0)
 
1105
        # call[1][1] is a StringIO - we can't test it by simple equality.
 
1106
        self.assertEqual('put_file_non_atomic', call[0])
 
1107
        self.assertEqual('filename.kndx', call[1][0])
 
1108
        # With no history, _KndxIndex writes a new index:
 
1109
        self.assertEqual(
 
1110
            _KndxIndex.HEADER +
750
1111
            "\na option 0 1 .b :"
751
1112
            "\na opt 1 2 .c :"
752
1113
            "\nb option 2 3 0 :",
753
 
            f.read())
754
 
 
755
 
    def test_has_version(self):
756
 
        transport = MockTransport([
757
 
            _KnitIndex.HEADER,
758
 
            "a option 0 1 :"
759
 
            ])
760
 
        index = self.get_knit_index(transport, "filename", "r")
761
 
 
762
 
        self.assertTrue(index.has_version("a"))
763
 
        self.assertFalse(index.has_version("b"))
 
1114
            call[1][1].getvalue())
 
1115
        self.assertEqual({'create_parent_dir': True}, call[2])
 
1116
 
 
1117
    def assertTotalBuildSize(self, size, keys, positions):
 
1118
        self.assertEqual(size,
 
1119
                         knit._get_total_build_size(None, keys, positions))
 
1120
 
 
1121
    def test__get_total_build_size(self):
 
1122
        positions = {
 
1123
            ('a',): (('fulltext', False), (('a',), 0, 100), None),
 
1124
            ('b',): (('line-delta', False), (('b',), 100, 21), ('a',)),
 
1125
            ('c',): (('line-delta', False), (('c',), 121, 35), ('b',)),
 
1126
            ('d',): (('line-delta', False), (('d',), 156, 12), ('b',)),
 
1127
            }
 
1128
        self.assertTotalBuildSize(100, [('a',)], positions)
 
1129
        self.assertTotalBuildSize(121, [('b',)], positions)
 
1130
        # c needs both a & b
 
1131
        self.assertTotalBuildSize(156, [('c',)], positions)
 
1132
        # we shouldn't count 'b' twice
 
1133
        self.assertTotalBuildSize(156, [('b',), ('c',)], positions)
 
1134
        self.assertTotalBuildSize(133, [('d',)], positions)
 
1135
        self.assertTotalBuildSize(168, [('c',), ('d',)], positions)
764
1136
 
765
1137
    def test_get_position(self):
766
1138
        transport = MockTransport([
767
 
            _KnitIndex.HEADER,
 
1139
            _KndxIndex.HEADER,
768
1140
            "a option 0 1 :",
769
1141
            "b option 1 2 :"
770
1142
            ])
771
1143
        index = self.get_knit_index(transport, "filename", "r")
772
1144
 
773
 
        self.assertEqual((None, 0, 1), index.get_position("a"))
774
 
        self.assertEqual((None, 1, 2), index.get_position("b"))
 
1145
        self.assertEqual((("a",), 0, 1), index.get_position(("a",)))
 
1146
        self.assertEqual((("b",), 1, 2), index.get_position(("b",)))
775
1147
 
776
1148
    def test_get_method(self):
777
1149
        transport = MockTransport([
778
 
            _KnitIndex.HEADER,
 
1150
            _KndxIndex.HEADER,
779
1151
            "a fulltext,unknown 0 1 :",
780
1152
            "b unknown,line-delta 1 2 :",
781
1153
            "c bad 3 4 :"
788
1160
 
789
1161
    def test_get_options(self):
790
1162
        transport = MockTransport([
791
 
            _KnitIndex.HEADER,
 
1163
            _KndxIndex.HEADER,
792
1164
            "a opt1 0 1 :",
793
1165
            "b opt2,opt3 1 2 :"
794
1166
            ])
797
1169
        self.assertEqual(["opt1"], index.get_options("a"))
798
1170
        self.assertEqual(["opt2", "opt3"], index.get_options("b"))
799
1171
 
800
 
    def test_get_parents(self):
801
 
        transport = MockTransport([
802
 
            _KnitIndex.HEADER,
803
 
            "a option 0 1 :",
804
 
            "b option 1 2 0 .c :",
805
 
            "c option 1 2 1 0 .e :"
806
 
            ])
807
 
        index = self.get_knit_index(transport, "filename", "r")
808
 
 
809
 
        self.assertEqual([], index.get_parents("a"))
810
 
        self.assertEqual(["a", "c"], index.get_parents("b"))
811
 
        self.assertEqual(["b", "a"], index.get_parents("c"))
812
 
 
813
 
    def test_get_parents_with_ghosts(self):
814
 
        transport = MockTransport([
815
 
            _KnitIndex.HEADER,
816
 
            "a option 0 1 :",
817
 
            "b option 1 2 0 .c :",
818
 
            "c option 1 2 1 0 .e :"
819
 
            ])
820
 
        index = self.get_knit_index(transport, "filename", "r")
821
 
 
822
 
        self.assertEqual([], index.get_parents_with_ghosts("a"))
823
 
        self.assertEqual(["a", "c"], index.get_parents_with_ghosts("b"))
824
 
        self.assertEqual(["b", "a", "e"],
825
 
            index.get_parents_with_ghosts("c"))
826
 
 
827
 
    def test_check_versions_present(self):
828
 
        transport = MockTransport([
829
 
            _KnitIndex.HEADER,
830
 
            "a option 0 1 :",
831
 
            "b option 0 1 :"
832
 
            ])
833
 
        index = self.get_knit_index(transport, "filename", "r")
834
 
 
835
 
        check = index.check_versions_present
836
 
 
837
 
        check([])
838
 
        check(["a"])
839
 
        check(["b"])
840
 
        check(["a", "b"])
841
 
        self.assertRaises(RevisionNotPresent, check, ["c"])
842
 
        self.assertRaises(RevisionNotPresent, check, ["a", "b", "c"])
 
1172
    def test_get_parent_map(self):
 
1173
        transport = MockTransport([
 
1174
            _KndxIndex.HEADER,
 
1175
            "a option 0 1 :",
 
1176
            "b option 1 2 0 .c :",
 
1177
            "c option 1 2 1 0 .e :"
 
1178
            ])
 
1179
        index = self.get_knit_index(transport, "filename", "r")
 
1180
 
 
1181
        self.assertEqual({
 
1182
            ("a",):(),
 
1183
            ("b",):(("a",), ("c",)),
 
1184
            ("c",):(("b",), ("a",), ("e",)),
 
1185
            }, index.get_parent_map(index.keys()))
843
1186
 
844
1187
    def test_impossible_parent(self):
845
1188
        """Test we get KnitCorrupt if the parent couldn't possibly exist."""
846
1189
        transport = MockTransport([
847
 
            _KnitIndex.HEADER,
 
1190
            _KndxIndex.HEADER,
848
1191
            "a option 0 1 :",
849
1192
            "b option 0 1 4 :"  # We don't have a 4th record
850
1193
            ])
 
1194
        index = self.get_knit_index(transport, 'filename', 'r')
851
1195
        try:
852
 
            self.assertRaises(errors.KnitCorrupt,
853
 
                              self.get_knit_index, transport, 'filename', 'r')
 
1196
            self.assertRaises(errors.KnitCorrupt, index.keys)
854
1197
        except TypeError, e:
855
1198
            if (str(e) == ('exceptions must be strings, classes, or instances,'
856
 
                           ' not exceptions.IndexError')
857
 
                and sys.version_info[0:2] >= (2,5)):
 
1199
                           ' not exceptions.IndexError')):
858
1200
                self.knownFailure('Pyrex <0.9.5 fails with TypeError when'
859
1201
                                  ' raising new style exceptions with python'
860
1202
                                  ' >=2.5')
863
1205
 
864
1206
    def test_corrupted_parent(self):
865
1207
        transport = MockTransport([
866
 
            _KnitIndex.HEADER,
 
1208
            _KndxIndex.HEADER,
867
1209
            "a option 0 1 :",
868
1210
            "b option 0 1 :",
869
1211
            "c option 0 1 1v :", # Can't have a parent of '1v'
870
1212
            ])
 
1213
        index = self.get_knit_index(transport, 'filename', 'r')
871
1214
        try:
872
 
            self.assertRaises(errors.KnitCorrupt,
873
 
                              self.get_knit_index, transport, 'filename', 'r')
 
1215
            self.assertRaises(errors.KnitCorrupt, index.keys)
874
1216
        except TypeError, e:
875
1217
            if (str(e) == ('exceptions must be strings, classes, or instances,'
876
 
                           ' not exceptions.ValueError')
877
 
                and sys.version_info[0:2] >= (2,5)):
 
1218
                           ' not exceptions.ValueError')):
878
1219
                self.knownFailure('Pyrex <0.9.5 fails with TypeError when'
879
1220
                                  ' raising new style exceptions with python'
880
1221
                                  ' >=2.5')
883
1224
 
884
1225
    def test_corrupted_parent_in_list(self):
885
1226
        transport = MockTransport([
886
 
            _KnitIndex.HEADER,
 
1227
            _KndxIndex.HEADER,
887
1228
            "a option 0 1 :",
888
1229
            "b option 0 1 :",
889
1230
            "c option 0 1 1 v :", # Can't have a parent of 'v'
890
1231
            ])
 
1232
        index = self.get_knit_index(transport, 'filename', 'r')
891
1233
        try:
892
 
            self.assertRaises(errors.KnitCorrupt,
893
 
                              self.get_knit_index, transport, 'filename', 'r')
 
1234
            self.assertRaises(errors.KnitCorrupt, index.keys)
894
1235
        except TypeError, e:
895
1236
            if (str(e) == ('exceptions must be strings, classes, or instances,'
896
 
                           ' not exceptions.ValueError')
897
 
                and sys.version_info[0:2] >= (2,5)):
 
1237
                           ' not exceptions.ValueError')):
898
1238
                self.knownFailure('Pyrex <0.9.5 fails with TypeError when'
899
1239
                                  ' raising new style exceptions with python'
900
1240
                                  ' >=2.5')
903
1243
 
904
1244
    def test_invalid_position(self):
905
1245
        transport = MockTransport([
906
 
            _KnitIndex.HEADER,
 
1246
            _KndxIndex.HEADER,
907
1247
            "a option 1v 1 :",
908
1248
            ])
 
1249
        index = self.get_knit_index(transport, 'filename', 'r')
909
1250
        try:
910
 
            self.assertRaises(errors.KnitCorrupt,
911
 
                              self.get_knit_index, transport, 'filename', 'r')
 
1251
            self.assertRaises(errors.KnitCorrupt, index.keys)
912
1252
        except TypeError, e:
913
1253
            if (str(e) == ('exceptions must be strings, classes, or instances,'
914
 
                           ' not exceptions.ValueError')
915
 
                and sys.version_info[0:2] >= (2,5)):
 
1254
                           ' not exceptions.ValueError')):
916
1255
                self.knownFailure('Pyrex <0.9.5 fails with TypeError when'
917
1256
                                  ' raising new style exceptions with python'
918
1257
                                  ' >=2.5')
921
1260
 
922
1261
    def test_invalid_size(self):
923
1262
        transport = MockTransport([
924
 
            _KnitIndex.HEADER,
 
1263
            _KndxIndex.HEADER,
925
1264
            "a option 1 1v :",
926
1265
            ])
 
1266
        index = self.get_knit_index(transport, 'filename', 'r')
927
1267
        try:
928
 
            self.assertRaises(errors.KnitCorrupt,
929
 
                              self.get_knit_index, transport, 'filename', 'r')
 
1268
            self.assertRaises(errors.KnitCorrupt, index.keys)
930
1269
        except TypeError, e:
931
1270
            if (str(e) == ('exceptions must be strings, classes, or instances,'
932
 
                           ' not exceptions.ValueError')
933
 
                and sys.version_info[0:2] >= (2,5)):
 
1271
                           ' not exceptions.ValueError')):
934
1272
                self.knownFailure('Pyrex <0.9.5 fails with TypeError when'
935
1273
                                  ' raising new style exceptions with python'
936
1274
                                  ' >=2.5')
937
1275
            else:
938
1276
                raise
939
1277
 
 
1278
    def test_scan_unvalidated_index_not_implemented(self):
 
1279
        transport = MockTransport()
 
1280
        index = self.get_knit_index(transport, 'filename', 'r')
 
1281
        self.assertRaises(
 
1282
            NotImplementedError, index.scan_unvalidated_index,
 
1283
            'dummy graph_index')
 
1284
        self.assertRaises(
 
1285
            NotImplementedError, index.get_missing_compression_parents)
 
1286
 
940
1287
    def test_short_line(self):
941
1288
        transport = MockTransport([
942
 
            _KnitIndex.HEADER,
 
1289
            _KndxIndex.HEADER,
943
1290
            "a option 0 10  :",
944
1291
            "b option 10 10 0", # This line isn't terminated, ignored
945
1292
            ])
946
1293
        index = self.get_knit_index(transport, "filename", "r")
947
 
        self.assertEqual(['a'], index.get_versions())
 
1294
        self.assertEqual(set([('a',)]), index.keys())
948
1295
 
949
1296
    def test_skip_incomplete_record(self):
950
1297
        # A line with bogus data should just be skipped
951
1298
        transport = MockTransport([
952
 
            _KnitIndex.HEADER,
 
1299
            _KndxIndex.HEADER,
953
1300
            "a option 0 10  :",
954
1301
            "b option 10 10 0", # This line isn't terminated, ignored
955
1302
            "c option 20 10 0 :", # Properly terminated, and starts with '\n'
956
1303
            ])
957
1304
        index = self.get_knit_index(transport, "filename", "r")
958
 
        self.assertEqual(['a', 'c'], index.get_versions())
 
1305
        self.assertEqual(set([('a',), ('c',)]), index.keys())
959
1306
 
960
1307
    def test_trailing_characters(self):
961
1308
        # A line with bogus data should just be skipped
962
1309
        transport = MockTransport([
963
 
            _KnitIndex.HEADER,
 
1310
            _KndxIndex.HEADER,
964
1311
            "a option 0 10  :",
965
1312
            "b option 10 10 0 :a", # This line has extra trailing characters
966
1313
            "c option 20 10 0 :", # Properly terminated, and starts with '\n'
967
1314
            ])
968
1315
        index = self.get_knit_index(transport, "filename", "r")
969
 
        self.assertEqual(['a', 'c'], index.get_versions())
 
1316
        self.assertEqual(set([('a',), ('c',)]), index.keys())
970
1317
 
971
1318
 
972
1319
class LowLevelKnitIndexTests_c(LowLevelKnitIndexTests):
973
1320
 
974
 
    _test_needs_features = [CompiledKnitFeature]
975
 
 
976
 
    def get_knit_index(self, *args, **kwargs):
977
 
        orig = knit._load_data
978
 
        def reset():
979
 
            knit._load_data = orig
980
 
        self.addCleanup(reset)
981
 
        from bzrlib._knit_load_data_c import _load_data_c
982
 
        knit._load_data = _load_data_c
983
 
        return _KnitIndex(*args, **kwargs)
984
 
 
 
1321
    _test_needs_features = [compiled_knit_feature]
 
1322
 
 
1323
    def get_knit_index(self, transport, name, mode):
 
1324
        mapper = ConstantMapper(name)
 
1325
        from bzrlib._knit_load_data_pyx import _load_data_c
 
1326
        self.overrideAttr(knit, '_load_data', _load_data_c)
 
1327
        allow_writes = lambda: mode == 'w'
 
1328
        return _KndxIndex(transport, mapper, lambda:None,
 
1329
                          allow_writes, lambda:True)
 
1330
 
 
1331
 
 
1332
class Test_KnitAnnotator(TestCaseWithMemoryTransport):
 
1333
 
 
1334
    def make_annotator(self):
 
1335
        factory = knit.make_pack_factory(True, True, 1)
 
1336
        vf = factory(self.get_transport())
 
1337
        return knit._KnitAnnotator(vf)
 
1338
 
 
1339
    def test__expand_fulltext(self):
 
1340
        ann = self.make_annotator()
 
1341
        rev_key = ('rev-id',)
 
1342
        ann._num_compression_children[rev_key] = 1
 
1343
        res = ann._expand_record(rev_key, (('parent-id',),), None,
 
1344
                           ['line1\n', 'line2\n'], ('fulltext', True))
 
1345
        # The content object and text lines should be cached appropriately
 
1346
        self.assertEqual(['line1\n', 'line2'], res)
 
1347
        content_obj = ann._content_objects[rev_key]
 
1348
        self.assertEqual(['line1\n', 'line2\n'], content_obj._lines)
 
1349
        self.assertEqual(res, content_obj.text())
 
1350
        self.assertEqual(res, ann._text_cache[rev_key])
 
1351
 
 
1352
    def test__expand_delta_comp_parent_not_available(self):
 
1353
        # Parent isn't available yet, so we return nothing, but queue up this
 
1354
        # node for later processing
 
1355
        ann = self.make_annotator()
 
1356
        rev_key = ('rev-id',)
 
1357
        parent_key = ('parent-id',)
 
1358
        record = ['0,1,1\n', 'new-line\n']
 
1359
        details = ('line-delta', False)
 
1360
        res = ann._expand_record(rev_key, (parent_key,), parent_key,
 
1361
                                 record, details)
 
1362
        self.assertEqual(None, res)
 
1363
        self.assertTrue(parent_key in ann._pending_deltas)
 
1364
        pending = ann._pending_deltas[parent_key]
 
1365
        self.assertEqual(1, len(pending))
 
1366
        self.assertEqual((rev_key, (parent_key,), record, details), pending[0])
 
1367
 
 
1368
    def test__expand_record_tracks_num_children(self):
 
1369
        ann = self.make_annotator()
 
1370
        rev_key = ('rev-id',)
 
1371
        rev2_key = ('rev2-id',)
 
1372
        parent_key = ('parent-id',)
 
1373
        record = ['0,1,1\n', 'new-line\n']
 
1374
        details = ('line-delta', False)
 
1375
        ann._num_compression_children[parent_key] = 2
 
1376
        ann._expand_record(parent_key, (), None, ['line1\n', 'line2\n'],
 
1377
                           ('fulltext', False))
 
1378
        res = ann._expand_record(rev_key, (parent_key,), parent_key,
 
1379
                                 record, details)
 
1380
        self.assertEqual({parent_key: 1}, ann._num_compression_children)
 
1381
        # Expanding the second child should remove the content object, and the
 
1382
        # num_compression_children entry
 
1383
        res = ann._expand_record(rev2_key, (parent_key,), parent_key,
 
1384
                                 record, details)
 
1385
        self.assertFalse(parent_key in ann._content_objects)
 
1386
        self.assertEqual({}, ann._num_compression_children)
 
1387
        # We should not cache the content_objects for rev2 and rev, because
 
1388
        # they do not have compression children of their own.
 
1389
        self.assertEqual({}, ann._content_objects)
 
1390
 
 
1391
    def test__expand_delta_records_blocks(self):
 
1392
        ann = self.make_annotator()
 
1393
        rev_key = ('rev-id',)
 
1394
        parent_key = ('parent-id',)
 
1395
        record = ['0,1,1\n', 'new-line\n']
 
1396
        details = ('line-delta', True)
 
1397
        ann._num_compression_children[parent_key] = 2
 
1398
        ann._expand_record(parent_key, (), None,
 
1399
                           ['line1\n', 'line2\n', 'line3\n'],
 
1400
                           ('fulltext', False))
 
1401
        ann._expand_record(rev_key, (parent_key,), parent_key, record, details)
 
1402
        self.assertEqual({(rev_key, parent_key): [(1, 1, 1), (3, 3, 0)]},
 
1403
                         ann._matching_blocks)
 
1404
        rev2_key = ('rev2-id',)
 
1405
        record = ['0,1,1\n', 'new-line\n']
 
1406
        details = ('line-delta', False)
 
1407
        ann._expand_record(rev2_key, (parent_key,), parent_key, record, details)
 
1408
        self.assertEqual([(1, 1, 2), (3, 3, 0)],
 
1409
                         ann._matching_blocks[(rev2_key, parent_key)])
 
1410
 
 
1411
    def test__get_parent_ann_uses_matching_blocks(self):
 
1412
        ann = self.make_annotator()
 
1413
        rev_key = ('rev-id',)
 
1414
        parent_key = ('parent-id',)
 
1415
        parent_ann = [(parent_key,)]*3
 
1416
        block_key = (rev_key, parent_key)
 
1417
        ann._annotations_cache[parent_key] = parent_ann
 
1418
        ann._matching_blocks[block_key] = [(0, 1, 1), (3, 3, 0)]
 
1419
        # We should not try to access any parent_lines content, because we know
 
1420
        # we already have the matching blocks
 
1421
        par_ann, blocks = ann._get_parent_annotations_and_matches(rev_key,
 
1422
                                        ['1\n', '2\n', '3\n'], parent_key)
 
1423
        self.assertEqual(parent_ann, par_ann)
 
1424
        self.assertEqual([(0, 1, 1), (3, 3, 0)], blocks)
 
1425
        self.assertEqual({}, ann._matching_blocks)
 
1426
 
 
1427
    def test__process_pending(self):
 
1428
        ann = self.make_annotator()
 
1429
        rev_key = ('rev-id',)
 
1430
        p1_key = ('p1-id',)
 
1431
        p2_key = ('p2-id',)
 
1432
        record = ['0,1,1\n', 'new-line\n']
 
1433
        details = ('line-delta', False)
 
1434
        p1_record = ['line1\n', 'line2\n']
 
1435
        ann._num_compression_children[p1_key] = 1
 
1436
        res = ann._expand_record(rev_key, (p1_key,p2_key), p1_key,
 
1437
                                 record, details)
 
1438
        self.assertEqual(None, res)
 
1439
        # self.assertTrue(p1_key in ann._pending_deltas)
 
1440
        self.assertEqual({}, ann._pending_annotation)
 
1441
        # Now insert p1, and we should be able to expand the delta
 
1442
        res = ann._expand_record(p1_key, (), None, p1_record,
 
1443
                                 ('fulltext', False))
 
1444
        self.assertEqual(p1_record, res)
 
1445
        ann._annotations_cache[p1_key] = [(p1_key,)]*2
 
1446
        res = ann._process_pending(p1_key)
 
1447
        self.assertEqual([], res)
 
1448
        self.assertFalse(p1_key in ann._pending_deltas)
 
1449
        self.assertTrue(p2_key in ann._pending_annotation)
 
1450
        self.assertEqual({p2_key: [(rev_key, (p1_key, p2_key))]},
 
1451
                         ann._pending_annotation)
 
1452
        # Now fill in parent 2, and pending annotation should be satisfied
 
1453
        res = ann._expand_record(p2_key, (), None, [], ('fulltext', False))
 
1454
        ann._annotations_cache[p2_key] = []
 
1455
        res = ann._process_pending(p2_key)
 
1456
        self.assertEqual([rev_key], res)
 
1457
        self.assertEqual({}, ann._pending_annotation)
 
1458
        self.assertEqual({}, ann._pending_deltas)
 
1459
 
 
1460
    def test_record_delta_removes_basis(self):
 
1461
        ann = self.make_annotator()
 
1462
        ann._expand_record(('parent-id',), (), None,
 
1463
                           ['line1\n', 'line2\n'], ('fulltext', False))
 
1464
        ann._num_compression_children['parent-id'] = 2
 
1465
 
 
1466
    def test_annotate_special_text(self):
 
1467
        ann = self.make_annotator()
 
1468
        vf = ann._vf
 
1469
        rev1_key = ('rev-1',)
 
1470
        rev2_key = ('rev-2',)
 
1471
        rev3_key = ('rev-3',)
 
1472
        spec_key = ('special:',)
 
1473
        vf.add_lines(rev1_key, [], ['initial content\n'])
 
1474
        vf.add_lines(rev2_key, [rev1_key], ['initial content\n',
 
1475
                                            'common content\n',
 
1476
                                            'content in 2\n'])
 
1477
        vf.add_lines(rev3_key, [rev1_key], ['initial content\n',
 
1478
                                            'common content\n',
 
1479
                                            'content in 3\n'])
 
1480
        spec_text = ('initial content\n'
 
1481
                     'common content\n'
 
1482
                     'content in 2\n'
 
1483
                     'content in 3\n')
 
1484
        ann.add_special_text(spec_key, [rev2_key, rev3_key], spec_text)
 
1485
        anns, lines = ann.annotate(spec_key)
 
1486
        self.assertEqual([(rev1_key,),
 
1487
                          (rev2_key, rev3_key),
 
1488
                          (rev2_key,),
 
1489
                          (rev3_key,),
 
1490
                         ], anns)
 
1491
        self.assertEqualDiff(spec_text, ''.join(lines))
985
1492
 
986
1493
 
987
1494
class KnitTests(TestCaseWithTransport):
988
1495
    """Class containing knit test helper routines."""
989
1496
 
990
 
    def make_test_knit(self, annotate=False, delay_create=False, index=None,
991
 
                       name='test'):
992
 
        if not annotate:
993
 
            factory = KnitPlainFactory()
994
 
        else:
995
 
            factory = None
996
 
        return KnitVersionedFile(name, get_transport('.'), access_mode='w',
997
 
                                 factory=factory, create=True,
998
 
                                 delay_create=delay_create, index=index)
999
 
 
1000
 
    def assertRecordContentEqual(self, knit, version_id, candidate_content):
1001
 
        """Assert that some raw record content matches the raw record content
1002
 
        for a particular version_id in the given knit.
1003
 
        """
1004
 
        index_memo = knit._index.get_position(version_id)
1005
 
        record = (version_id, index_memo)
1006
 
        [(_, expected_content)] = list(knit._data.read_records_iter_raw([record]))
1007
 
        self.assertEqual(expected_content, candidate_content)
1008
 
 
1009
 
 
1010
 
class BasicKnitTests(KnitTests):
1011
 
 
1012
 
    def add_stock_one_and_one_a(self, k):
1013
 
        k.add_lines('text-1', [], split_lines(TEXT_1))
1014
 
        k.add_lines('text-1a', ['text-1'], split_lines(TEXT_1A))
1015
 
 
1016
 
    def test_knit_constructor(self):
1017
 
        """Construct empty k"""
1018
 
        self.make_test_knit()
1019
 
 
1020
 
    def test_make_explicit_index(self):
1021
 
        """We can supply an index to use."""
1022
 
        knit = KnitVersionedFile('test', get_transport('.'),
1023
 
            index='strangelove')
1024
 
        self.assertEqual(knit._index, 'strangelove')
1025
 
 
1026
 
    def test_knit_add(self):
1027
 
        """Store one text in knit and retrieve"""
1028
 
        k = self.make_test_knit()
1029
 
        k.add_lines('text-1', [], split_lines(TEXT_1))
1030
 
        self.assertTrue(k.has_version('text-1'))
1031
 
        self.assertEqualDiff(''.join(k.get_lines('text-1')), TEXT_1)
1032
 
 
1033
 
    def test_knit_reload(self):
1034
 
        # test that the content in a reloaded knit is correct
1035
 
        k = self.make_test_knit()
1036
 
        k.add_lines('text-1', [], split_lines(TEXT_1))
1037
 
        del k
1038
 
        k2 = KnitVersionedFile('test', get_transport('.'), access_mode='r', factory=KnitPlainFactory(), create=True)
1039
 
        self.assertTrue(k2.has_version('text-1'))
1040
 
        self.assertEqualDiff(''.join(k2.get_lines('text-1')), TEXT_1)
1041
 
 
1042
 
    def test_knit_several(self):
1043
 
        """Store several texts in a knit"""
1044
 
        k = self.make_test_knit()
1045
 
        k.add_lines('text-1', [], split_lines(TEXT_1))
1046
 
        k.add_lines('text-2', [], split_lines(TEXT_2))
1047
 
        self.assertEqualDiff(''.join(k.get_lines('text-1')), TEXT_1)
1048
 
        self.assertEqualDiff(''.join(k.get_lines('text-2')), TEXT_2)
1049
 
        
1050
 
    def test_repeated_add(self):
1051
 
        """Knit traps attempt to replace existing version"""
1052
 
        k = self.make_test_knit()
1053
 
        k.add_lines('text-1', [], split_lines(TEXT_1))
1054
 
        self.assertRaises(RevisionAlreadyPresent, 
1055
 
                k.add_lines,
1056
 
                'text-1', [], split_lines(TEXT_1))
1057
 
 
1058
 
    def test_empty(self):
1059
 
        k = self.make_test_knit(True)
1060
 
        k.add_lines('text-1', [], [])
1061
 
        self.assertEquals(k.get_lines('text-1'), [])
1062
 
 
1063
 
    def test_incomplete(self):
1064
 
        """Test if texts without a ending line-end can be inserted and
1065
 
        extracted."""
1066
 
        k = KnitVersionedFile('test', get_transport('.'), delta=False, create=True)
1067
 
        k.add_lines('text-1', [], ['a\n',    'b'  ])
1068
 
        k.add_lines('text-2', ['text-1'], ['a\rb\n', 'b\n'])
1069
 
        # reopening ensures maximum room for confusion
1070
 
        k = KnitVersionedFile('test', get_transport('.'), delta=False, create=True)
1071
 
        self.assertEquals(k.get_lines('text-1'), ['a\n',    'b'  ])
1072
 
        self.assertEquals(k.get_lines('text-2'), ['a\rb\n', 'b\n'])
1073
 
 
1074
 
    def test_delta(self):
1075
 
        """Expression of knit delta as lines"""
1076
 
        k = self.make_test_knit()
1077
 
        KnitContent
1078
 
        td = list(line_delta(TEXT_1.splitlines(True),
1079
 
                             TEXT_1A.splitlines(True)))
1080
 
        self.assertEqualDiff(''.join(td), delta_1_1a)
1081
 
        out = apply_line_delta(TEXT_1.splitlines(True), td)
1082
 
        self.assertEqualDiff(''.join(out), TEXT_1A)
1083
 
 
1084
 
    def assertDerivedBlocksEqual(self, source, target, noeol=False):
1085
 
        """Assert that the derived matching blocks match real output"""
1086
 
        source_lines = source.splitlines(True)
1087
 
        target_lines = target.splitlines(True)
1088
 
        def nl(line):
1089
 
            if noeol and not line.endswith('\n'):
1090
 
                return line + '\n'
1091
 
            else:
1092
 
                return line
1093
 
        source_content = KnitContent([(None, nl(l)) for l in source_lines])
1094
 
        target_content = KnitContent([(None, nl(l)) for l in target_lines])
1095
 
        line_delta = source_content.line_delta(target_content)
1096
 
        delta_blocks = list(KnitContent.get_line_delta_blocks(line_delta,
1097
 
            source_lines, target_lines))
1098
 
        matcher = KnitSequenceMatcher(None, source_lines, target_lines)
1099
 
        matcher_blocks = list(list(matcher.get_matching_blocks()))
1100
 
        self.assertEqual(matcher_blocks, delta_blocks)
1101
 
 
1102
 
    def test_get_line_delta_blocks(self):
1103
 
        self.assertDerivedBlocksEqual('a\nb\nc\n', 'q\nc\n')
1104
 
        self.assertDerivedBlocksEqual(TEXT_1, TEXT_1)
1105
 
        self.assertDerivedBlocksEqual(TEXT_1, TEXT_1A)
1106
 
        self.assertDerivedBlocksEqual(TEXT_1, TEXT_1B)
1107
 
        self.assertDerivedBlocksEqual(TEXT_1B, TEXT_1A)
1108
 
        self.assertDerivedBlocksEqual(TEXT_1A, TEXT_1B)
1109
 
        self.assertDerivedBlocksEqual(TEXT_1A, '')
1110
 
        self.assertDerivedBlocksEqual('', TEXT_1A)
1111
 
        self.assertDerivedBlocksEqual('', '')
1112
 
        self.assertDerivedBlocksEqual('a\nb\nc', 'a\nb\nc\nd')
1113
 
 
1114
 
    def test_get_line_delta_blocks_noeol(self):
1115
 
        """Handle historical knit deltas safely
1116
 
 
1117
 
        Some existing knit deltas don't consider the last line to differ
1118
 
        when the only difference whether it has a final newline.
1119
 
 
1120
 
        New knit deltas appear to always consider the last line to differ
1121
 
        in this case.
1122
 
        """
1123
 
        self.assertDerivedBlocksEqual('a\nb\nc', 'a\nb\nc\nd\n', noeol=True)
1124
 
        self.assertDerivedBlocksEqual('a\nb\nc\nd\n', 'a\nb\nc', noeol=True)
1125
 
        self.assertDerivedBlocksEqual('a\nb\nc\n', 'a\nb\nc', noeol=True)
1126
 
        self.assertDerivedBlocksEqual('a\nb\nc', 'a\nb\nc\n', noeol=True)
1127
 
 
1128
 
    def test_add_with_parents(self):
1129
 
        """Store in knit with parents"""
1130
 
        k = self.make_test_knit()
1131
 
        self.add_stock_one_and_one_a(k)
1132
 
        self.assertEquals(k.get_parents('text-1'), [])
1133
 
        self.assertEquals(k.get_parents('text-1a'), ['text-1'])
1134
 
 
1135
 
    def test_ancestry(self):
1136
 
        """Store in knit with parents"""
1137
 
        k = self.make_test_knit()
1138
 
        self.add_stock_one_and_one_a(k)
1139
 
        self.assertEquals(set(k.get_ancestry(['text-1a'])), set(['text-1a', 'text-1']))
1140
 
 
1141
 
    def test_add_delta(self):
1142
 
        """Store in knit with parents"""
1143
 
        k = KnitVersionedFile('test', get_transport('.'), factory=KnitPlainFactory(),
1144
 
            delta=True, create=True)
1145
 
        self.add_stock_one_and_one_a(k)
1146
 
        k.clear_cache()
1147
 
        self.assertEqualDiff(''.join(k.get_lines('text-1a')), TEXT_1A)
1148
 
 
1149
 
    def test_add_delta_knit_graph_index(self):
1150
 
        """Does adding work with a KnitGraphIndex."""
1151
 
        index = InMemoryGraphIndex(2)
1152
 
        knit_index = KnitGraphIndex(index, add_callback=index.add_nodes,
1153
 
            deltas=True)
1154
 
        k = KnitVersionedFile('test', get_transport('.'),
1155
 
            delta=True, create=True, index=knit_index)
1156
 
        self.add_stock_one_and_one_a(k)
1157
 
        k.clear_cache()
1158
 
        self.assertEqualDiff(''.join(k.get_lines('text-1a')), TEXT_1A)
1159
 
        # check the index had the right data added.
1160
 
        self.assertEqual(set([
1161
 
            (index, ('text-1', ), ' 0 127', ((), ())),
1162
 
            (index, ('text-1a', ), ' 127 140', ((('text-1', ),), (('text-1', ),))),
1163
 
            ]), set(index.iter_all_entries()))
1164
 
        # we should not have a .kndx file
1165
 
        self.assertFalse(get_transport('.').has('test.kndx'))
1166
 
 
1167
 
    def test_annotate(self):
1168
 
        """Annotations"""
1169
 
        k = KnitVersionedFile('knit', get_transport('.'), factory=KnitAnnotateFactory(),
1170
 
            delta=True, create=True)
1171
 
        self.insert_and_test_small_annotate(k)
1172
 
 
1173
 
    def insert_and_test_small_annotate(self, k):
1174
 
        """test annotation with k works correctly."""
1175
 
        k.add_lines('text-1', [], ['a\n', 'b\n'])
1176
 
        k.add_lines('text-2', ['text-1'], ['a\n', 'c\n'])
1177
 
 
1178
 
        origins = k.annotate('text-2')
1179
 
        self.assertEquals(origins[0], ('text-1', 'a\n'))
1180
 
        self.assertEquals(origins[1], ('text-2', 'c\n'))
1181
 
 
1182
 
    def test_annotate_fulltext(self):
1183
 
        """Annotations"""
1184
 
        k = KnitVersionedFile('knit', get_transport('.'), factory=KnitAnnotateFactory(),
1185
 
            delta=False, create=True)
1186
 
        self.insert_and_test_small_annotate(k)
1187
 
 
1188
 
    def test_annotate_merge_1(self):
1189
 
        k = self.make_test_knit(True)
1190
 
        k.add_lines('text-a1', [], ['a\n', 'b\n'])
1191
 
        k.add_lines('text-a2', [], ['d\n', 'c\n'])
1192
 
        k.add_lines('text-am', ['text-a1', 'text-a2'], ['d\n', 'b\n'])
1193
 
        origins = k.annotate('text-am')
1194
 
        self.assertEquals(origins[0], ('text-a2', 'd\n'))
1195
 
        self.assertEquals(origins[1], ('text-a1', 'b\n'))
1196
 
 
1197
 
    def test_annotate_merge_2(self):
1198
 
        k = self.make_test_knit(True)
1199
 
        k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
1200
 
        k.add_lines('text-a2', [], ['x\n', 'y\n', 'z\n'])
1201
 
        k.add_lines('text-am', ['text-a1', 'text-a2'], ['a\n', 'y\n', 'c\n'])
1202
 
        origins = k.annotate('text-am')
1203
 
        self.assertEquals(origins[0], ('text-a1', 'a\n'))
1204
 
        self.assertEquals(origins[1], ('text-a2', 'y\n'))
1205
 
        self.assertEquals(origins[2], ('text-a1', 'c\n'))
1206
 
 
1207
 
    def test_annotate_merge_9(self):
1208
 
        k = self.make_test_knit(True)
1209
 
        k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
1210
 
        k.add_lines('text-a2', [], ['x\n', 'y\n', 'z\n'])
1211
 
        k.add_lines('text-am', ['text-a1', 'text-a2'], ['k\n', 'y\n', 'c\n'])
1212
 
        origins = k.annotate('text-am')
1213
 
        self.assertEquals(origins[0], ('text-am', 'k\n'))
1214
 
        self.assertEquals(origins[1], ('text-a2', 'y\n'))
1215
 
        self.assertEquals(origins[2], ('text-a1', 'c\n'))
1216
 
 
1217
 
    def test_annotate_merge_3(self):
1218
 
        k = self.make_test_knit(True)
1219
 
        k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
1220
 
        k.add_lines('text-a2', [] ,['x\n', 'y\n', 'z\n'])
1221
 
        k.add_lines('text-am', ['text-a1', 'text-a2'], ['k\n', 'y\n', 'z\n'])
1222
 
        origins = k.annotate('text-am')
1223
 
        self.assertEquals(origins[0], ('text-am', 'k\n'))
1224
 
        self.assertEquals(origins[1], ('text-a2', 'y\n'))
1225
 
        self.assertEquals(origins[2], ('text-a2', 'z\n'))
1226
 
 
1227
 
    def test_annotate_merge_4(self):
1228
 
        k = self.make_test_knit(True)
1229
 
        k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
1230
 
        k.add_lines('text-a2', [], ['x\n', 'y\n', 'z\n'])
1231
 
        k.add_lines('text-a3', ['text-a1'], ['a\n', 'b\n', 'p\n'])
1232
 
        k.add_lines('text-am', ['text-a2', 'text-a3'], ['a\n', 'b\n', 'z\n'])
1233
 
        origins = k.annotate('text-am')
1234
 
        self.assertEquals(origins[0], ('text-a1', 'a\n'))
1235
 
        self.assertEquals(origins[1], ('text-a1', 'b\n'))
1236
 
        self.assertEquals(origins[2], ('text-a2', 'z\n'))
1237
 
 
1238
 
    def test_annotate_merge_5(self):
1239
 
        k = self.make_test_knit(True)
1240
 
        k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
1241
 
        k.add_lines('text-a2', [], ['d\n', 'e\n', 'f\n'])
1242
 
        k.add_lines('text-a3', [], ['x\n', 'y\n', 'z\n'])
1243
 
        k.add_lines('text-am',
1244
 
                    ['text-a1', 'text-a2', 'text-a3'],
1245
 
                    ['a\n', 'e\n', 'z\n'])
1246
 
        origins = k.annotate('text-am')
1247
 
        self.assertEquals(origins[0], ('text-a1', 'a\n'))
1248
 
        self.assertEquals(origins[1], ('text-a2', 'e\n'))
1249
 
        self.assertEquals(origins[2], ('text-a3', 'z\n'))
1250
 
 
1251
 
    def test_annotate_file_cherry_pick(self):
1252
 
        k = self.make_test_knit(True)
1253
 
        k.add_lines('text-1', [], ['a\n', 'b\n', 'c\n'])
1254
 
        k.add_lines('text-2', ['text-1'], ['d\n', 'e\n', 'f\n'])
1255
 
        k.add_lines('text-3', ['text-2', 'text-1'], ['a\n', 'b\n', 'c\n'])
1256
 
        origins = k.annotate('text-3')
1257
 
        self.assertEquals(origins[0], ('text-1', 'a\n'))
1258
 
        self.assertEquals(origins[1], ('text-1', 'b\n'))
1259
 
        self.assertEquals(origins[2], ('text-1', 'c\n'))
1260
 
 
1261
 
    def test_knit_join(self):
1262
 
        """Store in knit with parents"""
1263
 
        k1 = KnitVersionedFile('test1', get_transport('.'), factory=KnitPlainFactory(), create=True)
1264
 
        k1.add_lines('text-a', [], split_lines(TEXT_1))
1265
 
        k1.add_lines('text-b', ['text-a'], split_lines(TEXT_1))
1266
 
 
1267
 
        k1.add_lines('text-c', [], split_lines(TEXT_1))
1268
 
        k1.add_lines('text-d', ['text-c'], split_lines(TEXT_1))
1269
 
 
1270
 
        k1.add_lines('text-m', ['text-b', 'text-d'], split_lines(TEXT_1))
1271
 
 
1272
 
        k2 = KnitVersionedFile('test2', get_transport('.'), factory=KnitPlainFactory(), create=True)
1273
 
        count = k2.join(k1, version_ids=['text-m'])
1274
 
        self.assertEquals(count, 5)
1275
 
        self.assertTrue(k2.has_version('text-a'))
1276
 
        self.assertTrue(k2.has_version('text-c'))
1277
 
 
1278
 
    def test_reannotate(self):
1279
 
        k1 = KnitVersionedFile('knit1', get_transport('.'),
1280
 
                               factory=KnitAnnotateFactory(), create=True)
1281
 
        # 0
1282
 
        k1.add_lines('text-a', [], ['a\n', 'b\n'])
1283
 
        # 1
1284
 
        k1.add_lines('text-b', ['text-a'], ['a\n', 'c\n'])
1285
 
 
1286
 
        k2 = KnitVersionedFile('test2', get_transport('.'),
1287
 
                               factory=KnitAnnotateFactory(), create=True)
1288
 
        k2.join(k1, version_ids=['text-b'])
1289
 
 
1290
 
        # 2
1291
 
        k1.add_lines('text-X', ['text-b'], ['a\n', 'b\n'])
1292
 
        # 2
1293
 
        k2.add_lines('text-c', ['text-b'], ['z\n', 'c\n'])
1294
 
        # 3
1295
 
        k2.add_lines('text-Y', ['text-b'], ['b\n', 'c\n'])
1296
 
 
1297
 
        # test-c will have index 3
1298
 
        k1.join(k2, version_ids=['text-c'])
1299
 
 
1300
 
        lines = k1.get_lines('text-c')
1301
 
        self.assertEquals(lines, ['z\n', 'c\n'])
1302
 
 
1303
 
        origins = k1.annotate('text-c')
1304
 
        self.assertEquals(origins[0], ('text-c', 'z\n'))
1305
 
        self.assertEquals(origins[1], ('text-b', 'c\n'))
1306
 
 
1307
 
    def test_get_line_delta_texts(self):
1308
 
        """Make sure we can call get_texts on text with reused line deltas"""
1309
 
        k1 = KnitVersionedFile('test1', get_transport('.'), 
1310
 
                               factory=KnitPlainFactory(), create=True)
1311
 
        for t in range(3):
1312
 
            if t == 0:
1313
 
                parents = []
1314
 
            else:
1315
 
                parents = ['%d' % (t-1)]
1316
 
            k1.add_lines('%d' % t, parents, ['hello\n'] * t)
1317
 
        k1.get_texts(('%d' % t) for t in range(3))
1318
 
        
1319
 
    def test_iter_lines_reads_in_order(self):
1320
 
        t = MemoryTransport()
1321
 
        instrumented_t = TransportLogger(t)
1322
 
        k1 = KnitVersionedFile('id', instrumented_t, create=True, delta=True)
1323
 
        self.assertEqual([('id.kndx',)], instrumented_t._calls)
1324
 
        # add texts with no required ordering
1325
 
        k1.add_lines('base', [], ['text\n'])
1326
 
        k1.add_lines('base2', [], ['text2\n'])
1327
 
        k1.clear_cache()
1328
 
        instrumented_t._calls = []
1329
 
        # request a last-first iteration
1330
 
        results = list(k1.iter_lines_added_or_present_in_versions(['base2', 'base']))
1331
 
        self.assertEqual([('id.knit', [(0, 87), (87, 89)])], instrumented_t._calls)
1332
 
        self.assertEqual(['text\n', 'text2\n'], results)
1333
 
 
1334
 
    def test_create_empty_annotated(self):
1335
 
        k1 = self.make_test_knit(True)
1336
 
        # 0
1337
 
        k1.add_lines('text-a', [], ['a\n', 'b\n'])
1338
 
        k2 = k1.create_empty('t', MemoryTransport())
1339
 
        self.assertTrue(isinstance(k2.factory, KnitAnnotateFactory))
1340
 
        self.assertEqual(k1.delta, k2.delta)
1341
 
        # the generic test checks for empty content and file class
1342
 
 
1343
 
    def test_knit_format(self):
1344
 
        # this tests that a new knit index file has the expected content
1345
 
        # and that is writes the data we expect as records are added.
1346
 
        knit = self.make_test_knit(True)
1347
 
        # Now knit files are not created until we first add data to them
1348
 
        self.assertFileEqual("# bzr knit index 8\n", 'test.kndx')
1349
 
        knit.add_lines_with_ghosts('revid', ['a_ghost'], ['a\n'])
1350
 
        self.assertFileEqual(
1351
 
            "# bzr knit index 8\n"
1352
 
            "\n"
1353
 
            "revid fulltext 0 84 .a_ghost :",
1354
 
            'test.kndx')
1355
 
        knit.add_lines_with_ghosts('revid2', ['revid'], ['a\n'])
1356
 
        self.assertFileEqual(
1357
 
            "# bzr knit index 8\n"
1358
 
            "\nrevid fulltext 0 84 .a_ghost :"
1359
 
            "\nrevid2 line-delta 84 82 0 :",
1360
 
            'test.kndx')
1361
 
        # we should be able to load this file again
1362
 
        knit = KnitVersionedFile('test', get_transport('.'), access_mode='r')
1363
 
        self.assertEqual(['revid', 'revid2'], knit.versions())
1364
 
        # write a short write to the file and ensure that its ignored
1365
 
        indexfile = file('test.kndx', 'ab')
1366
 
        indexfile.write('\nrevid3 line-delta 166 82 1 2 3 4 5 .phwoar:demo ')
1367
 
        indexfile.close()
1368
 
        # we should be able to load this file again
1369
 
        knit = KnitVersionedFile('test', get_transport('.'), access_mode='w')
1370
 
        self.assertEqual(['revid', 'revid2'], knit.versions())
1371
 
        # and add a revision with the same id the failed write had
1372
 
        knit.add_lines('revid3', ['revid2'], ['a\n'])
1373
 
        # and when reading it revid3 should now appear.
1374
 
        knit = KnitVersionedFile('test', get_transport('.'), access_mode='r')
1375
 
        self.assertEqual(['revid', 'revid2', 'revid3'], knit.versions())
1376
 
        self.assertEqual(['revid2'], knit.get_parents('revid3'))
1377
 
 
1378
 
    def test_delay_create(self):
1379
 
        """Test that passing delay_create=True creates files late"""
1380
 
        knit = self.make_test_knit(annotate=True, delay_create=True)
1381
 
        self.failIfExists('test.knit')
1382
 
        self.failIfExists('test.kndx')
1383
 
        knit.add_lines_with_ghosts('revid', ['a_ghost'], ['a\n'])
1384
 
        self.failUnlessExists('test.knit')
1385
 
        self.assertFileEqual(
1386
 
            "# bzr knit index 8\n"
1387
 
            "\n"
1388
 
            "revid fulltext 0 84 .a_ghost :",
1389
 
            'test.kndx')
1390
 
 
1391
 
    def test_create_parent_dir(self):
1392
 
        """create_parent_dir can create knits in nonexistant dirs"""
1393
 
        # Has no effect if we don't set 'delay_create'
1394
 
        trans = get_transport('.')
1395
 
        self.assertRaises(NoSuchFile, KnitVersionedFile, 'dir/test',
1396
 
                          trans, access_mode='w', factory=None,
1397
 
                          create=True, create_parent_dir=True)
1398
 
        # Nothing should have changed yet
1399
 
        knit = KnitVersionedFile('dir/test', trans, access_mode='w',
1400
 
                                 factory=None, create=True,
1401
 
                                 create_parent_dir=True,
1402
 
                                 delay_create=True)
1403
 
        self.failIfExists('dir/test.knit')
1404
 
        self.failIfExists('dir/test.kndx')
1405
 
        self.failIfExists('dir')
1406
 
        knit.add_lines('revid', [], ['a\n'])
1407
 
        self.failUnlessExists('dir')
1408
 
        self.failUnlessExists('dir/test.knit')
1409
 
        self.assertFileEqual(
1410
 
            "# bzr knit index 8\n"
1411
 
            "\n"
1412
 
            "revid fulltext 0 84  :",
1413
 
            'dir/test.kndx')
1414
 
 
1415
 
    def test_create_mode_700(self):
1416
 
        trans = get_transport('.')
1417
 
        if not trans._can_roundtrip_unix_modebits():
1418
 
            # Can't roundtrip, so no need to run this test
1419
 
            return
1420
 
        knit = KnitVersionedFile('dir/test', trans, access_mode='w',
1421
 
                                 factory=None, create=True,
1422
 
                                 create_parent_dir=True,
1423
 
                                 delay_create=True,
1424
 
                                 file_mode=0600,
1425
 
                                 dir_mode=0700)
1426
 
        knit.add_lines('revid', [], ['a\n'])
1427
 
        self.assertTransportMode(trans, 'dir', 0700)
1428
 
        self.assertTransportMode(trans, 'dir/test.knit', 0600)
1429
 
        self.assertTransportMode(trans, 'dir/test.kndx', 0600)
1430
 
 
1431
 
    def test_create_mode_770(self):
1432
 
        trans = get_transport('.')
1433
 
        if not trans._can_roundtrip_unix_modebits():
1434
 
            # Can't roundtrip, so no need to run this test
1435
 
            return
1436
 
        knit = KnitVersionedFile('dir/test', trans, access_mode='w',
1437
 
                                 factory=None, create=True,
1438
 
                                 create_parent_dir=True,
1439
 
                                 delay_create=True,
1440
 
                                 file_mode=0660,
1441
 
                                 dir_mode=0770)
1442
 
        knit.add_lines('revid', [], ['a\n'])
1443
 
        self.assertTransportMode(trans, 'dir', 0770)
1444
 
        self.assertTransportMode(trans, 'dir/test.knit', 0660)
1445
 
        self.assertTransportMode(trans, 'dir/test.kndx', 0660)
1446
 
 
1447
 
    def test_create_mode_777(self):
1448
 
        trans = get_transport('.')
1449
 
        if not trans._can_roundtrip_unix_modebits():
1450
 
            # Can't roundtrip, so no need to run this test
1451
 
            return
1452
 
        knit = KnitVersionedFile('dir/test', trans, access_mode='w',
1453
 
                                 factory=None, create=True,
1454
 
                                 create_parent_dir=True,
1455
 
                                 delay_create=True,
1456
 
                                 file_mode=0666,
1457
 
                                 dir_mode=0777)
1458
 
        knit.add_lines('revid', [], ['a\n'])
1459
 
        self.assertTransportMode(trans, 'dir', 0777)
1460
 
        self.assertTransportMode(trans, 'dir/test.knit', 0666)
1461
 
        self.assertTransportMode(trans, 'dir/test.kndx', 0666)
1462
 
 
1463
 
    def test_plan_merge(self):
1464
 
        my_knit = self.make_test_knit(annotate=True)
1465
 
        my_knit.add_lines('text1', [], split_lines(TEXT_1))
1466
 
        my_knit.add_lines('text1a', ['text1'], split_lines(TEXT_1A))
1467
 
        my_knit.add_lines('text1b', ['text1'], split_lines(TEXT_1B))
1468
 
        plan = list(my_knit.plan_merge('text1a', 'text1b'))
1469
 
        for plan_line, expected_line in zip(plan, AB_MERGE):
1470
 
            self.assertEqual(plan_line, expected_line)
1471
 
 
1472
 
    def test_get_stream_empty(self):
1473
 
        """Get a data stream for an empty knit file."""
1474
 
        k1 = self.make_test_knit()
1475
 
        format, data_list, reader_callable = k1.get_data_stream([])
1476
 
        self.assertEqual('knit-plain', format)
1477
 
        self.assertEqual([], data_list)
1478
 
        content = reader_callable(None)
1479
 
        self.assertEqual('', content)
1480
 
        self.assertIsInstance(content, str)
1481
 
 
1482
 
    def test_get_stream_one_version(self):
1483
 
        """Get a data stream for a single record out of a knit containing just
1484
 
        one record.
1485
 
        """
1486
 
        k1 = self.make_test_knit()
1487
 
        test_data = [
1488
 
            ('text-a', [], TEXT_1),
1489
 
            ]
1490
 
        expected_data_list = [
1491
 
            # version, options, length, parents
1492
 
            ('text-a', ['fulltext'], 122, []),
1493
 
           ]
1494
 
        for version_id, parents, lines in test_data:
1495
 
            k1.add_lines(version_id, parents, split_lines(lines))
1496
 
 
1497
 
        format, data_list, reader_callable = k1.get_data_stream(['text-a'])
1498
 
        self.assertEqual('knit-plain', format)
1499
 
        self.assertEqual(expected_data_list, data_list)
1500
 
        # There's only one record in the knit, so the content should be the
1501
 
        # entire knit data file's contents.
1502
 
        self.assertEqual(k1.transport.get_bytes(k1._data._access._filename),
1503
 
                         reader_callable(None))
1504
 
        
1505
 
    def test_get_stream_get_one_version_of_many(self):
1506
 
        """Get a data stream for just one version out of a knit containing many
1507
 
        versions.
1508
 
        """
1509
 
        k1 = self.make_test_knit()
1510
 
        # Insert the same data as test_knit_join, as they seem to cover a range
1511
 
        # of cases (no parents, one parent, multiple parents).
1512
 
        test_data = [
1513
 
            ('text-a', [], TEXT_1),
1514
 
            ('text-b', ['text-a'], TEXT_1),
1515
 
            ('text-c', [], TEXT_1),
1516
 
            ('text-d', ['text-c'], TEXT_1),
1517
 
            ('text-m', ['text-b', 'text-d'], TEXT_1),
1518
 
            ]
1519
 
        expected_data_list = [
1520
 
            # version, options, length, parents
1521
 
            ('text-m', ['line-delta'], 84, ['text-b', 'text-d']),
1522
 
            ]
1523
 
        for version_id, parents, lines in test_data:
1524
 
            k1.add_lines(version_id, parents, split_lines(lines))
1525
 
 
1526
 
        format, data_list, reader_callable = k1.get_data_stream(['text-m'])
1527
 
        self.assertEqual('knit-plain', format)
1528
 
        self.assertEqual(expected_data_list, data_list)
1529
 
        self.assertRecordContentEqual(k1, 'text-m', reader_callable(None))
1530
 
        
1531
 
    def test_get_stream_ghost_parent(self):
1532
 
        """Get a data stream for a version with a ghost parent."""
1533
 
        k1 = self.make_test_knit()
1534
 
        # Test data
1535
 
        k1.add_lines('text-a', [], split_lines(TEXT_1))
1536
 
        k1.add_lines_with_ghosts('text-b', ['text-a', 'text-ghost'],
1537
 
                                 split_lines(TEXT_1))
1538
 
        # Expected data
1539
 
        expected_data_list = [
1540
 
            # version, options, length, parents
1541
 
            ('text-b', ['line-delta'], 84, ['text-a', 'text-ghost']),
1542
 
            ]
1543
 
        
1544
 
        format, data_list, reader_callable = k1.get_data_stream(['text-b'])
1545
 
        self.assertEqual('knit-plain', format)
1546
 
        self.assertEqual(expected_data_list, data_list)
1547
 
        self.assertRecordContentEqual(k1, 'text-b', reader_callable(None))
1548
 
    
1549
 
    def test_get_stream_get_multiple_records(self):
1550
 
        """Get a stream for multiple records of a knit."""
1551
 
        k1 = self.make_test_knit()
1552
 
        # Insert the same data as test_knit_join, as they seem to cover a range
1553
 
        # of cases (no parents, one parent, multiple parents).
1554
 
        test_data = [
1555
 
            ('text-a', [], TEXT_1),
1556
 
            ('text-b', ['text-a'], TEXT_1),
1557
 
            ('text-c', [], TEXT_1),
1558
 
            ('text-d', ['text-c'], TEXT_1),
1559
 
            ('text-m', ['text-b', 'text-d'], TEXT_1),
1560
 
            ]
1561
 
        expected_data_list = [
1562
 
            # version, options, length, parents
1563
 
            ('text-b', ['line-delta'], 84, ['text-a']),
1564
 
            ('text-d', ['line-delta'], 84, ['text-c']),
1565
 
            ]
1566
 
        for version_id, parents, lines in test_data:
1567
 
            k1.add_lines(version_id, parents, split_lines(lines))
1568
 
 
1569
 
        # Note that even though we request the revision IDs in a particular
1570
 
        # order, the data stream may return them in any order it likes.  In this
1571
 
        # case, they'll be in the order they were inserted into the knit.
1572
 
        format, data_list, reader_callable = k1.get_data_stream(
1573
 
            ['text-d', 'text-b'])
1574
 
        self.assertEqual('knit-plain', format)
1575
 
        self.assertEqual(expected_data_list, data_list)
1576
 
        self.assertRecordContentEqual(k1, 'text-b', reader_callable(84))
1577
 
        self.assertRecordContentEqual(k1, 'text-d', reader_callable(84))
1578
 
        self.assertEqual('', reader_callable(None),
1579
 
                         "There should be no more bytes left to read.")
1580
 
 
1581
 
    def test_get_stream_all(self):
1582
 
        """Get a data stream for all the records in a knit.
1583
 
 
1584
 
        This exercises fulltext records, line-delta records, records with
1585
 
        various numbers of parents, and reading multiple records out of the
1586
 
        callable.  These cases ought to all be exercised individually by the
1587
 
        other test_get_stream_* tests; this test is basically just paranoia.
1588
 
        """
1589
 
        k1 = self.make_test_knit()
1590
 
        # Insert the same data as test_knit_join, as they seem to cover a range
1591
 
        # of cases (no parents, one parent, multiple parents).
1592
 
        test_data = [
1593
 
            ('text-a', [], TEXT_1),
1594
 
            ('text-b', ['text-a'], TEXT_1),
1595
 
            ('text-c', [], TEXT_1),
1596
 
            ('text-d', ['text-c'], TEXT_1),
1597
 
            ('text-m', ['text-b', 'text-d'], TEXT_1),
1598
 
           ]
1599
 
        expected_data_list = [
1600
 
            # version, options, length, parents
1601
 
            ('text-a', ['fulltext'], 122, []),
1602
 
            ('text-b', ['line-delta'], 84, ['text-a']),
1603
 
            ('text-c', ['fulltext'], 121, []),
1604
 
            ('text-d', ['line-delta'], 84, ['text-c']),
1605
 
            ('text-m', ['line-delta'], 84, ['text-b', 'text-d']),
1606
 
            ]
1607
 
        for version_id, parents, lines in test_data:
1608
 
            k1.add_lines(version_id, parents, split_lines(lines))
1609
 
 
1610
 
        format, data_list, reader_callable = k1.get_data_stream(
1611
 
            ['text-a', 'text-b', 'text-c', 'text-d', 'text-m'])
1612
 
        self.assertEqual('knit-plain', format)
1613
 
        self.assertEqual(expected_data_list, data_list)
1614
 
        for version_id, options, length, parents in expected_data_list:
1615
 
            bytes = reader_callable(length)
1616
 
            self.assertRecordContentEqual(k1, version_id, bytes)
1617
 
 
1618
 
    def assertKnitFilesEqual(self, knit1, knit2):
1619
 
        """Assert that the contents of the index and data files of two knits are
1620
 
        equal.
1621
 
        """
1622
 
        self.assertEqual(
1623
 
            knit1.transport.get_bytes(knit1._data._access._filename),
1624
 
            knit2.transport.get_bytes(knit2._data._access._filename))
1625
 
        self.assertEqual(
1626
 
            knit1.transport.get_bytes(knit1._index._filename),
1627
 
            knit2.transport.get_bytes(knit2._index._filename))
1628
 
 
1629
 
    def test_insert_data_stream_empty(self):
1630
 
        """Inserting a data stream with no records should not put any data into
1631
 
        the knit.
1632
 
        """
1633
 
        k1 = self.make_test_knit()
1634
 
        k1.insert_data_stream(
1635
 
            (k1.get_format_signature(), [], lambda ignored: ''))
1636
 
        self.assertEqual('', k1.transport.get_bytes(k1._data._access._filename),
1637
 
                         "The .knit should be completely empty.")
1638
 
        self.assertEqual(k1._index.HEADER,
1639
 
                         k1.transport.get_bytes(k1._index._filename),
1640
 
                         "The .kndx should have nothing apart from the header.")
1641
 
 
1642
 
    def test_insert_data_stream_one_record(self):
1643
 
        """Inserting a data stream with one record from a knit with one record
1644
 
        results in byte-identical files.
1645
 
        """
1646
 
        source = self.make_test_knit(name='source')
1647
 
        source.add_lines('text-a', [], split_lines(TEXT_1))
1648
 
        data_stream = source.get_data_stream(['text-a'])
1649
 
        
1650
 
        target = self.make_test_knit(name='target')
1651
 
        target.insert_data_stream(data_stream)
1652
 
        
1653
 
        self.assertKnitFilesEqual(source, target)
1654
 
 
1655
 
    def test_insert_data_stream_records_already_present(self):
1656
 
        """Insert a data stream where some records are alreday present in the
1657
 
        target, and some not.  Only the new records are inserted.
1658
 
        """
1659
 
        source = self.make_test_knit(name='source')
1660
 
        target = self.make_test_knit(name='target')
1661
 
        # Insert 'text-a' into both source and target
1662
 
        source.add_lines('text-a', [], split_lines(TEXT_1))
1663
 
        target.insert_data_stream(source.get_data_stream(['text-a']))
1664
 
        # Insert 'text-b' into just the source.
1665
 
        source.add_lines('text-b', ['text-a'], split_lines(TEXT_1))
1666
 
        # Get a data stream of both text-a and text-b, and insert it.
1667
 
        data_stream = source.get_data_stream(['text-a', 'text-b'])
1668
 
        target.insert_data_stream(data_stream)
1669
 
        # The source and target will now be identical.  This means the text-a
1670
 
        # record was not added a second time.
1671
 
        self.assertKnitFilesEqual(source, target)
1672
 
 
1673
 
    def test_insert_data_stream_multiple_records(self):
1674
 
        """Inserting a data stream of all records from a knit with multiple
1675
 
        records results in byte-identical files.
1676
 
        """
1677
 
        source = self.make_test_knit(name='source')
1678
 
        source.add_lines('text-a', [], split_lines(TEXT_1))
1679
 
        source.add_lines('text-b', ['text-a'], split_lines(TEXT_1))
1680
 
        source.add_lines('text-c', [], split_lines(TEXT_1))
1681
 
        data_stream = source.get_data_stream(['text-a', 'text-b', 'text-c'])
1682
 
        
1683
 
        target = self.make_test_knit(name='target')
1684
 
        target.insert_data_stream(data_stream)
1685
 
        
1686
 
        self.assertKnitFilesEqual(source, target)
1687
 
 
1688
 
    def test_insert_data_stream_ghost_parent(self):
1689
 
        """Insert a data stream with a record that has a ghost parent."""
1690
 
        # Make a knit with a record, text-a, that has a ghost parent.
1691
 
        source = self.make_test_knit(name='source')
1692
 
        source.add_lines_with_ghosts('text-a', ['text-ghost'],
1693
 
                                     split_lines(TEXT_1))
1694
 
        data_stream = source.get_data_stream(['text-a'])
1695
 
 
1696
 
        target = self.make_test_knit(name='target')
1697
 
        target.insert_data_stream(data_stream)
1698
 
 
1699
 
        self.assertKnitFilesEqual(source, target)
1700
 
 
1701
 
        # The target knit object is in a consistent state, i.e. the record we
1702
 
        # just added is immediately visible.
1703
 
        self.assertTrue(target.has_version('text-a'))
1704
 
        self.assertTrue(target.has_ghost('text-ghost'))
1705
 
        self.assertEqual(split_lines(TEXT_1), target.get_lines('text-a'))
1706
 
 
1707
 
    def test_insert_data_stream_inconsistent_version_lines(self):
1708
 
        """Inserting a data stream which has different content for a version_id
1709
 
        than already exists in the knit will raise KnitCorrupt.
1710
 
        """
1711
 
        source = self.make_test_knit(name='source')
1712
 
        target = self.make_test_knit(name='target')
1713
 
        # Insert a different 'text-a' into both source and target
1714
 
        source.add_lines('text-a', [], split_lines(TEXT_1))
1715
 
        target.add_lines('text-a', [], split_lines(TEXT_2))
1716
 
        # Insert a data stream with conflicting content into the target
1717
 
        data_stream = source.get_data_stream(['text-a'])
1718
 
        self.assertRaises(
1719
 
            errors.KnitCorrupt, target.insert_data_stream, data_stream)
1720
 
 
1721
 
    def test_insert_data_stream_inconsistent_version_parents(self):
1722
 
        """Inserting a data stream which has different parents for a version_id
1723
 
        than already exists in the knit will raise KnitCorrupt.
1724
 
        """
1725
 
        source = self.make_test_knit(name='source')
1726
 
        target = self.make_test_knit(name='target')
1727
 
        # Insert a different 'text-a' into both source and target.  They differ
1728
 
        # only by the parents list, the content is the same.
1729
 
        source.add_lines_with_ghosts('text-a', [], split_lines(TEXT_1))
1730
 
        target.add_lines_with_ghosts('text-a', ['a-ghost'], split_lines(TEXT_1))
1731
 
        # Insert a data stream with conflicting content into the target
1732
 
        data_stream = source.get_data_stream(['text-a'])
1733
 
        self.assertRaises(
1734
 
            errors.KnitCorrupt, target.insert_data_stream, data_stream)
1735
 
 
1736
 
    def test_insert_data_stream_incompatible_format(self):
1737
 
        """A data stream in a different format to the target knit cannot be
1738
 
        inserted.
1739
 
 
1740
 
        It will raise KnitDataStreamIncompatible.
1741
 
        """
1742
 
        data_stream = ('fake-format-signature', [], lambda _: '')
1743
 
        target = self.make_test_knit(name='target')
1744
 
        self.assertRaises(
1745
 
            errors.KnitDataStreamIncompatible,
1746
 
            target.insert_data_stream, data_stream)
1747
 
 
1748
 
    #  * test that a stream of "already present version, then new version"
1749
 
    #    inserts correctly.
1750
 
 
1751
 
TEXT_1 = """\
1752
 
Banana cup cakes:
1753
 
 
1754
 
- bananas
1755
 
- eggs
1756
 
- broken tea cups
1757
 
"""
1758
 
 
1759
 
TEXT_1A = """\
1760
 
Banana cup cake recipe
1761
 
(serves 6)
1762
 
 
1763
 
- bananas
1764
 
- eggs
1765
 
- broken tea cups
1766
 
- self-raising flour
1767
 
"""
1768
 
 
1769
 
TEXT_1B = """\
1770
 
Banana cup cake recipe
1771
 
 
1772
 
- bananas (do not use plantains!!!)
1773
 
- broken tea cups
1774
 
- flour
1775
 
"""
1776
 
 
1777
 
delta_1_1a = """\
1778
 
0,1,2
1779
 
Banana cup cake recipe
1780
 
(serves 6)
1781
 
5,5,1
1782
 
- self-raising flour
1783
 
"""
1784
 
 
1785
 
TEXT_2 = """\
1786
 
Boeuf bourguignon
1787
 
 
1788
 
- beef
1789
 
- red wine
1790
 
- small onions
1791
 
- carrot
1792
 
- mushrooms
1793
 
"""
1794
 
 
1795
 
AB_MERGE_TEXT="""unchanged|Banana cup cake recipe
1796
 
new-a|(serves 6)
1797
 
unchanged|
1798
 
killed-b|- bananas
1799
 
killed-b|- eggs
1800
 
new-b|- bananas (do not use plantains!!!)
1801
 
unchanged|- broken tea cups
1802
 
new-a|- self-raising flour
1803
 
new-b|- flour
1804
 
"""
1805
 
AB_MERGE=[tuple(l.split('|')) for l in AB_MERGE_TEXT.splitlines(True)]
1806
 
 
1807
 
 
1808
 
def line_delta(from_lines, to_lines):
1809
 
    """Generate line-based delta from one text to another"""
1810
 
    s = difflib.SequenceMatcher(None, from_lines, to_lines)
1811
 
    for op in s.get_opcodes():
1812
 
        if op[0] == 'equal':
1813
 
            continue
1814
 
        yield '%d,%d,%d\n' % (op[1], op[2], op[4]-op[3])
1815
 
        for i in range(op[3], op[4]):
1816
 
            yield to_lines[i]
1817
 
 
1818
 
 
1819
 
def apply_line_delta(basis_lines, delta_lines):
1820
 
    """Apply a line-based perfect diff
1821
 
    
1822
 
    basis_lines -- text to apply the patch to
1823
 
    delta_lines -- diff instructions and content
1824
 
    """
1825
 
    out = basis_lines[:]
1826
 
    i = 0
1827
 
    offset = 0
1828
 
    while i < len(delta_lines):
1829
 
        l = delta_lines[i]
1830
 
        a, b, c = map(long, l.split(','))
1831
 
        i = i + 1
1832
 
        out[offset+a:offset+b] = delta_lines[i:i+c]
1833
 
        i = i + c
1834
 
        offset = offset + (b - a) + c
1835
 
    return out
1836
 
 
1837
 
 
1838
 
class TestWeaveToKnit(KnitTests):
1839
 
 
1840
 
    def test_weave_to_knit_matches(self):
1841
 
        # check that the WeaveToKnit is_compatible function
1842
 
        # registers True for a Weave to a Knit.
1843
 
        w = Weave()
1844
 
        k = self.make_test_knit()
1845
 
        self.failUnless(WeaveToKnit.is_compatible(w, k))
1846
 
        self.failIf(WeaveToKnit.is_compatible(k, w))
1847
 
        self.failIf(WeaveToKnit.is_compatible(w, w))
1848
 
        self.failIf(WeaveToKnit.is_compatible(k, k))
1849
 
 
1850
 
 
1851
 
class TestKnitCaching(KnitTests):
1852
 
    
1853
 
    def create_knit(self, cache_add=False):
1854
 
        k = self.make_test_knit(True)
1855
 
        if cache_add:
1856
 
            k.enable_cache()
1857
 
 
1858
 
        k.add_lines('text-1', [], split_lines(TEXT_1))
1859
 
        k.add_lines('text-2', [], split_lines(TEXT_2))
1860
 
        return k
1861
 
 
1862
 
    def test_no_caching(self):
1863
 
        k = self.create_knit()
1864
 
        # Nothing should be cached without setting 'enable_cache'
1865
 
        self.assertEqual({}, k._data._cache)
1866
 
 
1867
 
    def test_cache_add_and_clear(self):
1868
 
        k = self.create_knit(True)
1869
 
 
1870
 
        self.assertEqual(['text-1', 'text-2'], sorted(k._data._cache.keys()))
1871
 
 
1872
 
        k.clear_cache()
1873
 
        self.assertEqual({}, k._data._cache)
1874
 
 
1875
 
    def test_cache_data_read_raw(self):
1876
 
        k = self.create_knit()
1877
 
 
1878
 
        # Now cache and read
1879
 
        k.enable_cache()
1880
 
 
1881
 
        def read_one_raw(version):
1882
 
            pos_map = k._get_components_positions([version])
1883
 
            method, index_memo, next = pos_map[version]
1884
 
            lst = list(k._data.read_records_iter_raw([(version, index_memo)]))
1885
 
            self.assertEqual(1, len(lst))
1886
 
            return lst[0]
1887
 
 
1888
 
        val = read_one_raw('text-1')
1889
 
        self.assertEqual({'text-1':val[1]}, k._data._cache)
1890
 
 
1891
 
        k.clear_cache()
1892
 
        # After clear, new reads are not cached
1893
 
        self.assertEqual({}, k._data._cache)
1894
 
 
1895
 
        val2 = read_one_raw('text-1')
1896
 
        self.assertEqual(val, val2)
1897
 
        self.assertEqual({}, k._data._cache)
1898
 
 
1899
 
    def test_cache_data_read(self):
1900
 
        k = self.create_knit()
1901
 
 
1902
 
        def read_one(version):
1903
 
            pos_map = k._get_components_positions([version])
1904
 
            method, index_memo, next = pos_map[version]
1905
 
            lst = list(k._data.read_records_iter([(version, index_memo)]))
1906
 
            self.assertEqual(1, len(lst))
1907
 
            return lst[0]
1908
 
 
1909
 
        # Now cache and read
1910
 
        k.enable_cache()
1911
 
 
1912
 
        val = read_one('text-2')
1913
 
        self.assertEqual(['text-2'], k._data._cache.keys())
1914
 
        self.assertEqual('text-2', val[0])
1915
 
        content, digest = k._data._parse_record('text-2',
1916
 
                                                k._data._cache['text-2'])
1917
 
        self.assertEqual(content, val[1])
1918
 
        self.assertEqual(digest, val[2])
1919
 
 
1920
 
        k.clear_cache()
1921
 
        self.assertEqual({}, k._data._cache)
1922
 
 
1923
 
        val2 = read_one('text-2')
1924
 
        self.assertEqual(val, val2)
1925
 
        self.assertEqual({}, k._data._cache)
1926
 
 
1927
 
    def test_cache_read(self):
1928
 
        k = self.create_knit()
1929
 
        k.enable_cache()
1930
 
 
1931
 
        text = k.get_text('text-1')
1932
 
        self.assertEqual(TEXT_1, text)
1933
 
        self.assertEqual(['text-1'], k._data._cache.keys())
1934
 
 
1935
 
        k.clear_cache()
1936
 
        self.assertEqual({}, k._data._cache)
1937
 
 
1938
 
        text = k.get_text('text-1')
1939
 
        self.assertEqual(TEXT_1, text)
1940
 
        self.assertEqual({}, k._data._cache)
 
1497
    def make_test_knit(self, annotate=False, name='test'):
 
1498
        mapper = ConstantMapper(name)
 
1499
        return make_file_factory(annotate, mapper)(self.get_transport())
 
1500
 
 
1501
 
 
1502
class TestBadShaError(KnitTests):
 
1503
    """Tests for handling of sha errors."""
 
1504
 
 
1505
    def test_sha_exception_has_text(self):
 
1506
        # having the failed text included in the error allows for recovery.
 
1507
        source = self.make_test_knit()
 
1508
        target = self.make_test_knit(name="target")
 
1509
        if not source._max_delta_chain:
 
1510
            raise TestNotApplicable(
 
1511
                "cannot get delta-caused sha failures without deltas.")
 
1512
        # create a basis
 
1513
        basis = ('basis',)
 
1514
        broken = ('broken',)
 
1515
        source.add_lines(basis, (), ['foo\n'])
 
1516
        source.add_lines(broken, (basis,), ['foo\n', 'bar\n'])
 
1517
        # Seed target with a bad basis text
 
1518
        target.add_lines(basis, (), ['gam\n'])
 
1519
        target.insert_record_stream(
 
1520
            source.get_record_stream([broken], 'unordered', False))
 
1521
        err = self.assertRaises(errors.KnitCorrupt,
 
1522
            target.get_record_stream([broken], 'unordered', True
 
1523
            ).next().get_bytes_as, 'chunked')
 
1524
        self.assertEqual(['gam\n', 'bar\n'], err.content)
 
1525
        # Test for formatting with live data
 
1526
        self.assertStartsWith(str(err), "Knit ")
1941
1527
 
1942
1528
 
1943
1529
class TestKnitIndex(KnitTests):
1946
1532
        """Adding versions to the index should update the lookup dict"""
1947
1533
        knit = self.make_test_knit()
1948
1534
        idx = knit._index
1949
 
        idx.add_version('a-1', ['fulltext'], (None, 0, 0), [])
 
1535
        idx.add_records([(('a-1',), ['fulltext'], (('a-1',), 0, 0), [])])
1950
1536
        self.check_file_contents('test.kndx',
1951
1537
            '# bzr knit index 8\n'
1952
1538
            '\n'
1953
1539
            'a-1 fulltext 0 0  :'
1954
1540
            )
1955
 
        idx.add_versions([('a-2', ['fulltext'], (None, 0, 0), ['a-1']),
1956
 
                          ('a-3', ['fulltext'], (None, 0, 0), ['a-2']),
1957
 
                         ])
 
1541
        idx.add_records([
 
1542
            (('a-2',), ['fulltext'], (('a-2',), 0, 0), [('a-1',)]),
 
1543
            (('a-3',), ['fulltext'], (('a-3',), 0, 0), [('a-2',)]),
 
1544
            ])
1958
1545
        self.check_file_contents('test.kndx',
1959
1546
            '# bzr knit index 8\n'
1960
1547
            '\n'
1962
1549
            'a-2 fulltext 0 0 0 :\n'
1963
1550
            'a-3 fulltext 0 0 1 :'
1964
1551
            )
1965
 
        self.assertEqual(['a-1', 'a-2', 'a-3'], idx._history)
1966
 
        self.assertEqual({'a-1':('a-1', ['fulltext'], 0, 0, [], 0),
1967
 
                          'a-2':('a-2', ['fulltext'], 0, 0, ['a-1'], 1),
1968
 
                          'a-3':('a-3', ['fulltext'], 0, 0, ['a-2'], 2),
1969
 
                         }, idx._cache)
 
1552
        self.assertEqual(set([('a-3',), ('a-1',), ('a-2',)]), idx.keys())
 
1553
        self.assertEqual({
 
1554
            ('a-1',): ((('a-1',), 0, 0), None, (), ('fulltext', False)),
 
1555
            ('a-2',): ((('a-2',), 0, 0), None, (('a-1',),), ('fulltext', False)),
 
1556
            ('a-3',): ((('a-3',), 0, 0), None, (('a-2',),), ('fulltext', False)),
 
1557
            }, idx.get_build_details(idx.keys()))
 
1558
        self.assertEqual({('a-1',):(),
 
1559
            ('a-2',):(('a-1',),),
 
1560
            ('a-3',):(('a-2',),),},
 
1561
            idx.get_parent_map(idx.keys()))
1970
1562
 
1971
1563
    def test_add_versions_fails_clean(self):
1972
1564
        """If add_versions fails in the middle, it restores a pristine state.
1982
1574
 
1983
1575
        knit = self.make_test_knit()
1984
1576
        idx = knit._index
1985
 
        idx.add_version('a-1', ['fulltext'], (None, 0, 0), [])
 
1577
        idx.add_records([(('a-1',), ['fulltext'], (('a-1',), 0, 0), [])])
1986
1578
 
1987
1579
        class StopEarly(Exception):
1988
1580
            pass
1989
1581
 
1990
1582
        def generate_failure():
1991
1583
            """Add some entries and then raise an exception"""
1992
 
            yield ('a-2', ['fulltext'], (None, 0, 0), ['a-1'])
1993
 
            yield ('a-3', ['fulltext'], (None, 0, 0), ['a-2'])
 
1584
            yield (('a-2',), ['fulltext'], (None, 0, 0), ('a-1',))
 
1585
            yield (('a-3',), ['fulltext'], (None, 0, 0), ('a-2',))
1994
1586
            raise StopEarly()
1995
1587
 
1996
1588
        # Assert the pre-condition
1997
 
        self.assertEqual(['a-1'], idx._history)
1998
 
        self.assertEqual({'a-1':('a-1', ['fulltext'], 0, 0, [], 0)}, idx._cache)
1999
 
 
2000
 
        self.assertRaises(StopEarly, idx.add_versions, generate_failure())
2001
 
 
 
1589
        def assertA1Only():
 
1590
            self.assertEqual(set([('a-1',)]), set(idx.keys()))
 
1591
            self.assertEqual(
 
1592
                {('a-1',): ((('a-1',), 0, 0), None, (), ('fulltext', False))},
 
1593
                idx.get_build_details([('a-1',)]))
 
1594
            self.assertEqual({('a-1',):()}, idx.get_parent_map(idx.keys()))
 
1595
 
 
1596
        assertA1Only()
 
1597
        self.assertRaises(StopEarly, idx.add_records, generate_failure())
2002
1598
        # And it shouldn't be modified
2003
 
        self.assertEqual(['a-1'], idx._history)
2004
 
        self.assertEqual({'a-1':('a-1', ['fulltext'], 0, 0, [], 0)}, idx._cache)
 
1599
        assertA1Only()
2005
1600
 
2006
1601
    def test_knit_index_ignores_empty_files(self):
2007
1602
        # There was a race condition in older bzr, where a ^C at the right time
2008
1603
        # could leave an empty .kndx file, which bzr would later claim was a
2009
1604
        # corrupted file since the header was not present. In reality, the file
2010
1605
        # just wasn't created, so it should be ignored.
2011
 
        t = get_transport('.')
 
1606
        t = transport.get_transport_from_path('.')
2012
1607
        t.put_bytes('test.kndx', '')
2013
1608
 
2014
1609
        knit = self.make_test_knit()
2015
1610
 
2016
1611
    def test_knit_index_checks_header(self):
2017
 
        t = get_transport('.')
 
1612
        t = transport.get_transport_from_path('.')
2018
1613
        t.put_bytes('test.kndx', '# not really a knit header\n\n')
2019
 
 
2020
 
        self.assertRaises(KnitHeaderError, self.make_test_knit)
 
1614
        k = self.make_test_knit()
 
1615
        self.assertRaises(KnitHeaderError, k.keys)
2021
1616
 
2022
1617
 
2023
1618
class TestGraphIndexKnit(KnitTests):
2029
1624
            builder.add_node(node, references, value)
2030
1625
        stream = builder.finish()
2031
1626
        trans = self.get_transport()
2032
 
        trans.put_file(name, stream)
2033
 
        return GraphIndex(trans, name)
 
1627
        size = trans.put_file(name, stream)
 
1628
        return GraphIndex(trans, name, size)
2034
1629
 
2035
1630
    def two_graph_index(self, deltas=False, catch_adds=False):
2036
1631
        """Build a two-graph index.
2062
1657
            add_callback = self.catch_add
2063
1658
        else:
2064
1659
            add_callback = None
2065
 
        return KnitGraphIndex(combined_index, deltas=deltas,
 
1660
        return _KnitGraphIndex(combined_index, lambda:True, deltas=deltas,
2066
1661
            add_callback=add_callback)
2067
1662
 
2068
 
    def test_get_graph(self):
2069
 
        index = self.two_graph_index()
2070
 
        self.assertEqual(set([
2071
 
            ('tip', ('parent', )),
2072
 
            ('tail', ()),
2073
 
            ('parent', ('tail', 'ghost')),
2074
 
            ('separate', ()),
2075
 
            ]), set(index.get_graph()))
2076
 
 
2077
 
    def test_get_ancestry(self):
2078
 
        # get_ancestry is defined as eliding ghosts, not erroring.
2079
 
        index = self.two_graph_index()
2080
 
        self.assertEqual([], index.get_ancestry([]))
2081
 
        self.assertEqual(['separate'], index.get_ancestry(['separate']))
2082
 
        self.assertEqual(['tail'], index.get_ancestry(['tail']))
2083
 
        self.assertEqual(['tail', 'parent'], index.get_ancestry(['parent']))
2084
 
        self.assertEqual(['tail', 'parent', 'tip'], index.get_ancestry(['tip']))
2085
 
        self.assertTrue(index.get_ancestry(['tip', 'separate']) in
2086
 
            (['tail', 'parent', 'tip', 'separate'],
2087
 
             ['separate', 'tail', 'parent', 'tip'],
2088
 
            ))
2089
 
        # and without topo_sort
2090
 
        self.assertEqual(set(['separate']),
2091
 
            set(index.get_ancestry(['separate'], topo_sorted=False)))
2092
 
        self.assertEqual(set(['tail']),
2093
 
            set(index.get_ancestry(['tail'], topo_sorted=False)))
2094
 
        self.assertEqual(set(['tail', 'parent']),
2095
 
            set(index.get_ancestry(['parent'], topo_sorted=False)))
2096
 
        self.assertEqual(set(['tail', 'parent', 'tip']),
2097
 
            set(index.get_ancestry(['tip'], topo_sorted=False)))
2098
 
        self.assertEqual(set(['separate', 'tail', 'parent', 'tip']),
2099
 
            set(index.get_ancestry(['tip', 'separate'])))
2100
 
        # asking for a ghost makes it go boom.
2101
 
        self.assertRaises(errors.RevisionNotPresent, index.get_ancestry, ['ghost'])
2102
 
 
2103
 
    def test_get_ancestry_with_ghosts(self):
2104
 
        index = self.two_graph_index()
2105
 
        self.assertEqual([], index.get_ancestry_with_ghosts([]))
2106
 
        self.assertEqual(['separate'], index.get_ancestry_with_ghosts(['separate']))
2107
 
        self.assertEqual(['tail'], index.get_ancestry_with_ghosts(['tail']))
2108
 
        self.assertTrue(index.get_ancestry_with_ghosts(['parent']) in
2109
 
            (['tail', 'ghost', 'parent'],
2110
 
             ['ghost', 'tail', 'parent'],
2111
 
            ))
2112
 
        self.assertTrue(index.get_ancestry_with_ghosts(['tip']) in
2113
 
            (['tail', 'ghost', 'parent', 'tip'],
2114
 
             ['ghost', 'tail', 'parent', 'tip'],
2115
 
            ))
2116
 
        self.assertTrue(index.get_ancestry_with_ghosts(['tip', 'separate']) in
2117
 
            (['tail', 'ghost', 'parent', 'tip', 'separate'],
2118
 
             ['ghost', 'tail', 'parent', 'tip', 'separate'],
2119
 
             ['separate', 'tail', 'ghost', 'parent', 'tip'],
2120
 
             ['separate', 'ghost', 'tail', 'parent', 'tip'],
2121
 
            ))
2122
 
        # asking for a ghost makes it go boom.
2123
 
        self.assertRaises(errors.RevisionNotPresent, index.get_ancestry_with_ghosts, ['ghost'])
2124
 
 
2125
 
    def test_num_versions(self):
2126
 
        index = self.two_graph_index()
2127
 
        self.assertEqual(4, index.num_versions())
2128
 
 
2129
 
    def test_get_versions(self):
2130
 
        index = self.two_graph_index()
2131
 
        self.assertEqual(set(['tail', 'tip', 'parent', 'separate']),
2132
 
            set(index.get_versions()))
2133
 
 
2134
 
    def test_has_version(self):
2135
 
        index = self.two_graph_index()
2136
 
        self.assertTrue(index.has_version('tail'))
2137
 
        self.assertFalse(index.has_version('ghost'))
 
1663
    def test_keys(self):
 
1664
        index = self.two_graph_index()
 
1665
        self.assertEqual(set([('tail',), ('tip',), ('parent',), ('separate',)]),
 
1666
            set(index.keys()))
2138
1667
 
2139
1668
    def test_get_position(self):
2140
1669
        index = self.two_graph_index()
2141
 
        self.assertEqual((index._graph_index._indices[0], 0, 100), index.get_position('tip'))
2142
 
        self.assertEqual((index._graph_index._indices[1], 100, 78), index.get_position('parent'))
 
1670
        self.assertEqual((index._graph_index._indices[0], 0, 100), index.get_position(('tip',)))
 
1671
        self.assertEqual((index._graph_index._indices[1], 100, 78), index.get_position(('parent',)))
2143
1672
 
2144
1673
    def test_get_method_deltas(self):
2145
1674
        index = self.two_graph_index(deltas=True)
2146
 
        self.assertEqual('fulltext', index.get_method('tip'))
2147
 
        self.assertEqual('line-delta', index.get_method('parent'))
 
1675
        self.assertEqual('fulltext', index.get_method(('tip',)))
 
1676
        self.assertEqual('line-delta', index.get_method(('parent',)))
2148
1677
 
2149
1678
    def test_get_method_no_deltas(self):
2150
1679
        # check that the parent-history lookup is ignored with deltas=False.
2151
1680
        index = self.two_graph_index(deltas=False)
2152
 
        self.assertEqual('fulltext', index.get_method('tip'))
2153
 
        self.assertEqual('fulltext', index.get_method('parent'))
 
1681
        self.assertEqual('fulltext', index.get_method(('tip',)))
 
1682
        self.assertEqual('fulltext', index.get_method(('parent',)))
2154
1683
 
2155
1684
    def test_get_options_deltas(self):
2156
1685
        index = self.two_graph_index(deltas=True)
2157
 
        self.assertEqual(['fulltext', 'no-eol'], index.get_options('tip'))
2158
 
        self.assertEqual(['line-delta'], index.get_options('parent'))
 
1686
        self.assertEqual(['fulltext', 'no-eol'], index.get_options(('tip',)))
 
1687
        self.assertEqual(['line-delta'], index.get_options(('parent',)))
2159
1688
 
2160
1689
    def test_get_options_no_deltas(self):
2161
1690
        # check that the parent-history lookup is ignored with deltas=False.
2162
1691
        index = self.two_graph_index(deltas=False)
2163
 
        self.assertEqual(['fulltext', 'no-eol'], index.get_options('tip'))
2164
 
        self.assertEqual(['fulltext'], index.get_options('parent'))
2165
 
 
2166
 
    def test_get_parents(self):
2167
 
        # get_parents ignores ghosts
2168
 
        index = self.two_graph_index()
2169
 
        self.assertEqual(('tail', ), index.get_parents('parent'))
2170
 
        # and errors on ghosts.
2171
 
        self.assertRaises(errors.RevisionNotPresent,
2172
 
            index.get_parents, 'ghost')
2173
 
 
2174
 
    def test_get_parents_with_ghosts(self):
2175
 
        index = self.two_graph_index()
2176
 
        self.assertEqual(('tail', 'ghost'), index.get_parents_with_ghosts('parent'))
2177
 
        # and errors on ghosts.
2178
 
        self.assertRaises(errors.RevisionNotPresent,
2179
 
            index.get_parents_with_ghosts, 'ghost')
2180
 
 
2181
 
    def test_check_versions_present(self):
2182
 
        # ghosts should not be considered present
2183
 
        index = self.two_graph_index()
2184
 
        self.assertRaises(RevisionNotPresent, index.check_versions_present,
2185
 
            ['ghost'])
2186
 
        self.assertRaises(RevisionNotPresent, index.check_versions_present,
2187
 
            ['tail', 'ghost'])
2188
 
        index.check_versions_present(['tail', 'separate'])
 
1692
        self.assertEqual(['fulltext', 'no-eol'], index.get_options(('tip',)))
 
1693
        self.assertEqual(['fulltext'], index.get_options(('parent',)))
 
1694
 
 
1695
    def test_get_parent_map(self):
 
1696
        index = self.two_graph_index()
 
1697
        self.assertEqual({('parent',):(('tail',), ('ghost',))},
 
1698
            index.get_parent_map([('parent',), ('ghost',)]))
2189
1699
 
2190
1700
    def catch_add(self, entries):
2191
1701
        self.caught_entries.append(entries)
2192
1702
 
2193
1703
    def test_add_no_callback_errors(self):
2194
1704
        index = self.two_graph_index()
2195
 
        self.assertRaises(errors.ReadOnlyError, index.add_version,
2196
 
            'new', 'fulltext,no-eol', (None, 50, 60), ['separate'])
 
1705
        self.assertRaises(errors.ReadOnlyError, index.add_records,
 
1706
            [(('new',), 'fulltext,no-eol', (None, 50, 60), ['separate'])])
2197
1707
 
2198
1708
    def test_add_version_smoke(self):
2199
1709
        index = self.two_graph_index(catch_adds=True)
2200
 
        index.add_version('new', 'fulltext,no-eol', (None, 50, 60), ['separate'])
 
1710
        index.add_records([(('new',), 'fulltext,no-eol', (None, 50, 60),
 
1711
            [('separate',)])])
2201
1712
        self.assertEqual([[(('new', ), 'N50 60', ((('separate',),),))]],
2202
1713
            self.caught_entries)
2203
1714
 
2204
1715
    def test_add_version_delta_not_delta_index(self):
2205
1716
        index = self.two_graph_index(catch_adds=True)
2206
 
        self.assertRaises(errors.KnitCorrupt, index.add_version,
2207
 
            'new', 'no-eol,line-delta', (None, 0, 100), ['parent'])
 
1717
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
1718
            [(('new',), 'no-eol,line-delta', (None, 0, 100), [('parent',)])])
2208
1719
        self.assertEqual([], self.caught_entries)
2209
1720
 
2210
1721
    def test_add_version_same_dup(self):
2211
1722
        index = self.two_graph_index(catch_adds=True)
2212
1723
        # options can be spelt two different ways
2213
 
        index.add_version('tip', 'fulltext,no-eol', (None, 0, 100), ['parent'])
2214
 
        index.add_version('tip', 'no-eol,fulltext', (None, 0, 100), ['parent'])
2215
 
        # but neither should have added data.
2216
 
        self.assertEqual([[], []], self.caught_entries)
2217
 
        
 
1724
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 0, 100), [('parent',)])])
 
1725
        index.add_records([(('tip',), 'no-eol,fulltext', (None, 0, 100), [('parent',)])])
 
1726
        # position/length are ignored (because each pack could have fulltext or
 
1727
        # delta, and be at a different position.
 
1728
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 50, 100),
 
1729
            [('parent',)])])
 
1730
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 0, 1000),
 
1731
            [('parent',)])])
 
1732
        # but neither should have added data:
 
1733
        self.assertEqual([[], [], [], []], self.caught_entries)
 
1734
 
2218
1735
    def test_add_version_different_dup(self):
2219
1736
        index = self.two_graph_index(deltas=True, catch_adds=True)
2220
1737
        # change options
2221
 
        self.assertRaises(errors.KnitCorrupt, index.add_version,
2222
 
            'tip', 'no-eol,line-delta', (None, 0, 100), ['parent'])
2223
 
        self.assertRaises(errors.KnitCorrupt, index.add_version,
2224
 
            'tip', 'line-delta,no-eol', (None, 0, 100), ['parent'])
2225
 
        self.assertRaises(errors.KnitCorrupt, index.add_version,
2226
 
            'tip', 'fulltext', (None, 0, 100), ['parent'])
2227
 
        # position/length
2228
 
        self.assertRaises(errors.KnitCorrupt, index.add_version,
2229
 
            'tip', 'fulltext,no-eol', (None, 50, 100), ['parent'])
2230
 
        self.assertRaises(errors.KnitCorrupt, index.add_version,
2231
 
            'tip', 'fulltext,no-eol', (None, 0, 1000), ['parent'])
 
1738
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
1739
            [(('tip',), 'line-delta', (None, 0, 100), [('parent',)])])
 
1740
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
1741
            [(('tip',), 'fulltext', (None, 0, 100), [('parent',)])])
2232
1742
        # parents
2233
 
        self.assertRaises(errors.KnitCorrupt, index.add_version,
2234
 
            'tip', 'fulltext,no-eol', (None, 0, 100), [])
 
1743
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
1744
            [(('tip',), 'fulltext,no-eol', (None, 0, 100), [])])
2235
1745
        self.assertEqual([], self.caught_entries)
2236
 
        
 
1746
 
2237
1747
    def test_add_versions_nodeltas(self):
2238
1748
        index = self.two_graph_index(catch_adds=True)
2239
 
        index.add_versions([
2240
 
                ('new', 'fulltext,no-eol', (None, 50, 60), ['separate']),
2241
 
                ('new2', 'fulltext', (None, 0, 6), ['new']),
 
1749
        index.add_records([
 
1750
                (('new',), 'fulltext,no-eol', (None, 50, 60), [('separate',)]),
 
1751
                (('new2',), 'fulltext', (None, 0, 6), [('new',)]),
2242
1752
                ])
2243
1753
        self.assertEqual([(('new', ), 'N50 60', ((('separate',),),)),
2244
1754
            (('new2', ), ' 0 6', ((('new',),),))],
2247
1757
 
2248
1758
    def test_add_versions_deltas(self):
2249
1759
        index = self.two_graph_index(deltas=True, catch_adds=True)
2250
 
        index.add_versions([
2251
 
                ('new', 'fulltext,no-eol', (None, 50, 60), ['separate']),
2252
 
                ('new2', 'line-delta', (None, 0, 6), ['new']),
 
1760
        index.add_records([
 
1761
                (('new',), 'fulltext,no-eol', (None, 50, 60), [('separate',)]),
 
1762
                (('new2',), 'line-delta', (None, 0, 6), [('new',)]),
2253
1763
                ])
2254
1764
        self.assertEqual([(('new', ), 'N50 60', ((('separate',),), ())),
2255
1765
            (('new2', ), ' 0 6', ((('new',),), (('new',),), ))],
2258
1768
 
2259
1769
    def test_add_versions_delta_not_delta_index(self):
2260
1770
        index = self.two_graph_index(catch_adds=True)
2261
 
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
2262
 
            [('new', 'no-eol,line-delta', (None, 0, 100), ['parent'])])
 
1771
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
1772
            [(('new',), 'no-eol,line-delta', (None, 0, 100), [('parent',)])])
2263
1773
        self.assertEqual([], self.caught_entries)
2264
1774
 
 
1775
    def test_add_versions_random_id_accepted(self):
 
1776
        index = self.two_graph_index(catch_adds=True)
 
1777
        index.add_records([], random_id=True)
 
1778
 
2265
1779
    def test_add_versions_same_dup(self):
2266
1780
        index = self.two_graph_index(catch_adds=True)
2267
1781
        # options can be spelt two different ways
2268
 
        index.add_versions([('tip', 'fulltext,no-eol', (None, 0, 100), ['parent'])])
2269
 
        index.add_versions([('tip', 'no-eol,fulltext', (None, 0, 100), ['parent'])])
 
1782
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 0, 100),
 
1783
            [('parent',)])])
 
1784
        index.add_records([(('tip',), 'no-eol,fulltext', (None, 0, 100),
 
1785
            [('parent',)])])
 
1786
        # position/length are ignored (because each pack could have fulltext or
 
1787
        # delta, and be at a different position.
 
1788
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 50, 100),
 
1789
            [('parent',)])])
 
1790
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 0, 1000),
 
1791
            [('parent',)])])
2270
1792
        # but neither should have added data.
2271
 
        self.assertEqual([[], []], self.caught_entries)
2272
 
        
 
1793
        self.assertEqual([[], [], [], []], self.caught_entries)
 
1794
 
2273
1795
    def test_add_versions_different_dup(self):
2274
1796
        index = self.two_graph_index(deltas=True, catch_adds=True)
2275
1797
        # change options
2276
 
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
2277
 
            [('tip', 'no-eol,line-delta', (None, 0, 100), ['parent'])])
2278
 
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
2279
 
            [('tip', 'line-delta,no-eol', (None, 0, 100), ['parent'])])
2280
 
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
2281
 
            [('tip', 'fulltext', (None, 0, 100), ['parent'])])
2282
 
        # position/length
2283
 
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
2284
 
            [('tip', 'fulltext,no-eol', (None, 50, 100), ['parent'])])
2285
 
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
2286
 
            [('tip', 'fulltext,no-eol', (None, 0, 1000), ['parent'])])
 
1798
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
1799
            [(('tip',), 'line-delta', (None, 0, 100), [('parent',)])])
 
1800
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
1801
            [(('tip',), 'fulltext', (None, 0, 100), [('parent',)])])
2287
1802
        # parents
2288
 
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
2289
 
            [('tip', 'fulltext,no-eol', (None, 0, 100), [])])
 
1803
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
1804
            [(('tip',), 'fulltext,no-eol', (None, 0, 100), [])])
2290
1805
        # change options in the second record
2291
 
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
2292
 
            [('tip', 'fulltext,no-eol', (None, 0, 100), ['parent']),
2293
 
             ('tip', 'no-eol,line-delta', (None, 0, 100), ['parent'])])
 
1806
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
1807
            [(('tip',), 'fulltext,no-eol', (None, 0, 100), [('parent',)]),
 
1808
             (('tip',), 'line-delta', (None, 0, 100), [('parent',)])])
2294
1809
        self.assertEqual([], self.caught_entries)
2295
1810
 
2296
 
    def test_iter_parents(self):
2297
 
        index1 = self.make_g_index('1', 1, [
2298
 
        # no parents
2299
 
            (('r0', ), 'N0 100', ([], )),
2300
 
        # 1 parent
2301
 
            (('r1', ), '', ([('r0', )], ))])
2302
 
        index2 = self.make_g_index('2', 1, [
2303
 
        # 2 parents
2304
 
            (('r2', ), 'N0 100', ([('r1', ), ('r0', )], )),
2305
 
            ])
2306
 
        combined_index = CombinedGraphIndex([index1, index2])
2307
 
        index = KnitGraphIndex(combined_index)
2308
 
        # XXX TODO a ghost
2309
 
        # cases: each sample data individually:
2310
 
        self.assertEqual(set([('r0', ())]),
2311
 
            set(index.iter_parents(['r0'])))
2312
 
        self.assertEqual(set([('r1', ('r0', ))]),
2313
 
            set(index.iter_parents(['r1'])))
2314
 
        self.assertEqual(set([('r2', ('r1', 'r0'))]),
2315
 
            set(index.iter_parents(['r2'])))
2316
 
        # no nodes returned for a missing node
2317
 
        self.assertEqual(set(),
2318
 
            set(index.iter_parents(['missing'])))
2319
 
        # 1 node returned with missing nodes skipped
2320
 
        self.assertEqual(set([('r1', ('r0', ))]),
2321
 
            set(index.iter_parents(['ghost1', 'r1', 'ghost'])))
2322
 
        # 2 nodes returned
2323
 
        self.assertEqual(set([('r0', ()), ('r1', ('r0', ))]),
2324
 
            set(index.iter_parents(['r0', 'r1'])))
2325
 
        # 2 nodes returned, missing skipped
2326
 
        self.assertEqual(set([('r0', ()), ('r1', ('r0', ))]),
2327
 
            set(index.iter_parents(['a', 'r0', 'b', 'r1', 'c'])))
 
1811
    def make_g_index_missing_compression_parent(self):
 
1812
        graph_index = self.make_g_index('missing_comp', 2,
 
1813
            [(('tip', ), ' 100 78',
 
1814
              ([('missing-parent', ), ('ghost', )], [('missing-parent', )]))])
 
1815
        return graph_index
 
1816
 
 
1817
    def make_g_index_missing_parent(self):
 
1818
        graph_index = self.make_g_index('missing_parent', 2,
 
1819
            [(('parent', ), ' 100 78', ([], [])),
 
1820
             (('tip', ), ' 100 78',
 
1821
              ([('parent', ), ('missing-parent', )], [('parent', )])),
 
1822
              ])
 
1823
        return graph_index
 
1824
 
 
1825
    def make_g_index_no_external_refs(self):
 
1826
        graph_index = self.make_g_index('no_external_refs', 2,
 
1827
            [(('rev', ), ' 100 78',
 
1828
              ([('parent', ), ('ghost', )], []))])
 
1829
        return graph_index
 
1830
 
 
1831
    def test_add_good_unvalidated_index(self):
 
1832
        unvalidated = self.make_g_index_no_external_refs()
 
1833
        combined = CombinedGraphIndex([unvalidated])
 
1834
        index = _KnitGraphIndex(combined, lambda: True, deltas=True)
 
1835
        index.scan_unvalidated_index(unvalidated)
 
1836
        self.assertEqual(frozenset(), index.get_missing_compression_parents())
 
1837
 
 
1838
    def test_add_missing_compression_parent_unvalidated_index(self):
 
1839
        unvalidated = self.make_g_index_missing_compression_parent()
 
1840
        combined = CombinedGraphIndex([unvalidated])
 
1841
        index = _KnitGraphIndex(combined, lambda: True, deltas=True)
 
1842
        index.scan_unvalidated_index(unvalidated)
 
1843
        # This also checks that its only the compression parent that is
 
1844
        # examined, otherwise 'ghost' would also be reported as a missing
 
1845
        # parent.
 
1846
        self.assertEqual(
 
1847
            frozenset([('missing-parent',)]),
 
1848
            index.get_missing_compression_parents())
 
1849
 
 
1850
    def test_add_missing_noncompression_parent_unvalidated_index(self):
 
1851
        unvalidated = self.make_g_index_missing_parent()
 
1852
        combined = CombinedGraphIndex([unvalidated])
 
1853
        index = _KnitGraphIndex(combined, lambda: True, deltas=True,
 
1854
            track_external_parent_refs=True)
 
1855
        index.scan_unvalidated_index(unvalidated)
 
1856
        self.assertEqual(
 
1857
            frozenset([('missing-parent',)]), index.get_missing_parents())
 
1858
 
 
1859
    def test_track_external_parent_refs(self):
 
1860
        g_index = self.make_g_index('empty', 2, [])
 
1861
        combined = CombinedGraphIndex([g_index])
 
1862
        index = _KnitGraphIndex(combined, lambda: True, deltas=True,
 
1863
            add_callback=self.catch_add, track_external_parent_refs=True)
 
1864
        self.caught_entries = []
 
1865
        index.add_records([
 
1866
            (('new-key',), 'fulltext,no-eol', (None, 50, 60),
 
1867
             [('parent-1',), ('parent-2',)])])
 
1868
        self.assertEqual(
 
1869
            frozenset([('parent-1',), ('parent-2',)]),
 
1870
            index.get_missing_parents())
 
1871
 
 
1872
    def test_add_unvalidated_index_with_present_external_references(self):
 
1873
        index = self.two_graph_index(deltas=True)
 
1874
        # Ugly hack to get at one of the underlying GraphIndex objects that
 
1875
        # two_graph_index built.
 
1876
        unvalidated = index._graph_index._indices[1]
 
1877
        # 'parent' is an external ref of _indices[1] (unvalidated), but is
 
1878
        # present in _indices[0].
 
1879
        index.scan_unvalidated_index(unvalidated)
 
1880
        self.assertEqual(frozenset(), index.get_missing_compression_parents())
 
1881
 
 
1882
    def make_new_missing_parent_g_index(self, name):
 
1883
        missing_parent = name + '-missing-parent'
 
1884
        graph_index = self.make_g_index(name, 2,
 
1885
            [((name + 'tip', ), ' 100 78',
 
1886
              ([(missing_parent, ), ('ghost', )], [(missing_parent, )]))])
 
1887
        return graph_index
 
1888
 
 
1889
    def test_add_mulitiple_unvalidated_indices_with_missing_parents(self):
 
1890
        g_index_1 = self.make_new_missing_parent_g_index('one')
 
1891
        g_index_2 = self.make_new_missing_parent_g_index('two')
 
1892
        combined = CombinedGraphIndex([g_index_1, g_index_2])
 
1893
        index = _KnitGraphIndex(combined, lambda: True, deltas=True)
 
1894
        index.scan_unvalidated_index(g_index_1)
 
1895
        index.scan_unvalidated_index(g_index_2)
 
1896
        self.assertEqual(
 
1897
            frozenset([('one-missing-parent',), ('two-missing-parent',)]),
 
1898
            index.get_missing_compression_parents())
 
1899
 
 
1900
    def test_add_mulitiple_unvalidated_indices_with_mutual_dependencies(self):
 
1901
        graph_index_a = self.make_g_index('one', 2,
 
1902
            [(('parent-one', ), ' 100 78', ([('non-compression-parent',)], [])),
 
1903
             (('child-of-two', ), ' 100 78',
 
1904
              ([('parent-two',)], [('parent-two',)]))])
 
1905
        graph_index_b = self.make_g_index('two', 2,
 
1906
            [(('parent-two', ), ' 100 78', ([('non-compression-parent',)], [])),
 
1907
             (('child-of-one', ), ' 100 78',
 
1908
              ([('parent-one',)], [('parent-one',)]))])
 
1909
        combined = CombinedGraphIndex([graph_index_a, graph_index_b])
 
1910
        index = _KnitGraphIndex(combined, lambda: True, deltas=True)
 
1911
        index.scan_unvalidated_index(graph_index_a)
 
1912
        index.scan_unvalidated_index(graph_index_b)
 
1913
        self.assertEqual(
 
1914
            frozenset([]), index.get_missing_compression_parents())
2328
1915
 
2329
1916
 
2330
1917
class TestNoParentsGraphIndexKnit(KnitTests):
2331
 
    """Tests for knits using KnitGraphIndex with no parents."""
 
1918
    """Tests for knits using _KnitGraphIndex with no parents."""
2332
1919
 
2333
1920
    def make_g_index(self, name, ref_lists=0, nodes=[]):
2334
1921
        builder = GraphIndexBuilder(ref_lists)
2336
1923
            builder.add_node(node, references)
2337
1924
        stream = builder.finish()
2338
1925
        trans = self.get_transport()
2339
 
        trans.put_file(name, stream)
2340
 
        return GraphIndex(trans, name)
 
1926
        size = trans.put_file(name, stream)
 
1927
        return GraphIndex(trans, name, size)
 
1928
 
 
1929
    def test_add_good_unvalidated_index(self):
 
1930
        unvalidated = self.make_g_index('unvalidated')
 
1931
        combined = CombinedGraphIndex([unvalidated])
 
1932
        index = _KnitGraphIndex(combined, lambda: True, parents=False)
 
1933
        index.scan_unvalidated_index(unvalidated)
 
1934
        self.assertEqual(frozenset(),
 
1935
            index.get_missing_compression_parents())
2341
1936
 
2342
1937
    def test_parents_deltas_incompatible(self):
2343
1938
        index = CombinedGraphIndex([])
2344
 
        self.assertRaises(errors.KnitError, KnitGraphIndex, index,
2345
 
            deltas=True, parents=False)
 
1939
        self.assertRaises(errors.KnitError, _KnitGraphIndex, lambda:True,
 
1940
            index, deltas=True, parents=False)
2346
1941
 
2347
1942
    def two_graph_index(self, catch_adds=False):
2348
1943
        """Build a two-graph index.
2364
1959
            add_callback = self.catch_add
2365
1960
        else:
2366
1961
            add_callback = None
2367
 
        return KnitGraphIndex(combined_index, parents=False,
 
1962
        return _KnitGraphIndex(combined_index, lambda:True, parents=False,
2368
1963
            add_callback=add_callback)
2369
1964
 
2370
 
    def test_get_graph(self):
2371
 
        index = self.two_graph_index()
2372
 
        self.assertEqual(set([
2373
 
            ('tip', ()),
2374
 
            ('tail', ()),
2375
 
            ('parent', ()),
2376
 
            ('separate', ()),
2377
 
            ]), set(index.get_graph()))
2378
 
 
2379
 
    def test_get_ancestry(self):
2380
 
        # with no parents, ancestry is always just the key.
2381
 
        index = self.two_graph_index()
2382
 
        self.assertEqual([], index.get_ancestry([]))
2383
 
        self.assertEqual(['separate'], index.get_ancestry(['separate']))
2384
 
        self.assertEqual(['tail'], index.get_ancestry(['tail']))
2385
 
        self.assertEqual(['parent'], index.get_ancestry(['parent']))
2386
 
        self.assertEqual(['tip'], index.get_ancestry(['tip']))
2387
 
        self.assertTrue(index.get_ancestry(['tip', 'separate']) in
2388
 
            (['tip', 'separate'],
2389
 
             ['separate', 'tip'],
2390
 
            ))
2391
 
        # asking for a ghost makes it go boom.
2392
 
        self.assertRaises(errors.RevisionNotPresent, index.get_ancestry, ['ghost'])
2393
 
 
2394
 
    def test_get_ancestry_with_ghosts(self):
2395
 
        index = self.two_graph_index()
2396
 
        self.assertEqual([], index.get_ancestry_with_ghosts([]))
2397
 
        self.assertEqual(['separate'], index.get_ancestry_with_ghosts(['separate']))
2398
 
        self.assertEqual(['tail'], index.get_ancestry_with_ghosts(['tail']))
2399
 
        self.assertEqual(['parent'], index.get_ancestry_with_ghosts(['parent']))
2400
 
        self.assertEqual(['tip'], index.get_ancestry_with_ghosts(['tip']))
2401
 
        self.assertTrue(index.get_ancestry_with_ghosts(['tip', 'separate']) in
2402
 
            (['tip', 'separate'],
2403
 
             ['separate', 'tip'],
2404
 
            ))
2405
 
        # asking for a ghost makes it go boom.
2406
 
        self.assertRaises(errors.RevisionNotPresent, index.get_ancestry_with_ghosts, ['ghost'])
2407
 
 
2408
 
    def test_num_versions(self):
2409
 
        index = self.two_graph_index()
2410
 
        self.assertEqual(4, index.num_versions())
2411
 
 
2412
 
    def test_get_versions(self):
2413
 
        index = self.two_graph_index()
2414
 
        self.assertEqual(set(['tail', 'tip', 'parent', 'separate']),
2415
 
            set(index.get_versions()))
2416
 
 
2417
 
    def test_has_version(self):
2418
 
        index = self.two_graph_index()
2419
 
        self.assertTrue(index.has_version('tail'))
2420
 
        self.assertFalse(index.has_version('ghost'))
 
1965
    def test_keys(self):
 
1966
        index = self.two_graph_index()
 
1967
        self.assertEqual(set([('tail',), ('tip',), ('parent',), ('separate',)]),
 
1968
            set(index.keys()))
2421
1969
 
2422
1970
    def test_get_position(self):
2423
1971
        index = self.two_graph_index()
2424
 
        self.assertEqual((index._graph_index._indices[0], 0, 100), index.get_position('tip'))
2425
 
        self.assertEqual((index._graph_index._indices[1], 100, 78), index.get_position('parent'))
 
1972
        self.assertEqual((index._graph_index._indices[0], 0, 100),
 
1973
            index.get_position(('tip',)))
 
1974
        self.assertEqual((index._graph_index._indices[1], 100, 78),
 
1975
            index.get_position(('parent',)))
2426
1976
 
2427
1977
    def test_get_method(self):
2428
1978
        index = self.two_graph_index()
2429
 
        self.assertEqual('fulltext', index.get_method('tip'))
2430
 
        self.assertEqual(['fulltext'], index.get_options('parent'))
 
1979
        self.assertEqual('fulltext', index.get_method(('tip',)))
 
1980
        self.assertEqual(['fulltext'], index.get_options(('parent',)))
2431
1981
 
2432
1982
    def test_get_options(self):
2433
1983
        index = self.two_graph_index()
2434
 
        self.assertEqual(['fulltext', 'no-eol'], index.get_options('tip'))
2435
 
        self.assertEqual(['fulltext'], index.get_options('parent'))
2436
 
 
2437
 
    def test_get_parents(self):
2438
 
        index = self.two_graph_index()
2439
 
        self.assertEqual((), index.get_parents('parent'))
2440
 
        # and errors on ghosts.
2441
 
        self.assertRaises(errors.RevisionNotPresent,
2442
 
            index.get_parents, 'ghost')
2443
 
 
2444
 
    def test_get_parents_with_ghosts(self):
2445
 
        index = self.two_graph_index()
2446
 
        self.assertEqual((), index.get_parents_with_ghosts('parent'))
2447
 
        # and errors on ghosts.
2448
 
        self.assertRaises(errors.RevisionNotPresent,
2449
 
            index.get_parents_with_ghosts, 'ghost')
2450
 
 
2451
 
    def test_check_versions_present(self):
2452
 
        index = self.two_graph_index()
2453
 
        self.assertRaises(RevisionNotPresent, index.check_versions_present,
2454
 
            ['missing'])
2455
 
        self.assertRaises(RevisionNotPresent, index.check_versions_present,
2456
 
            ['tail', 'missing'])
2457
 
        index.check_versions_present(['tail', 'separate'])
 
1984
        self.assertEqual(['fulltext', 'no-eol'], index.get_options(('tip',)))
 
1985
        self.assertEqual(['fulltext'], index.get_options(('parent',)))
 
1986
 
 
1987
    def test_get_parent_map(self):
 
1988
        index = self.two_graph_index()
 
1989
        self.assertEqual({('parent',):None},
 
1990
            index.get_parent_map([('parent',), ('ghost',)]))
2458
1991
 
2459
1992
    def catch_add(self, entries):
2460
1993
        self.caught_entries.append(entries)
2461
1994
 
2462
1995
    def test_add_no_callback_errors(self):
2463
1996
        index = self.two_graph_index()
2464
 
        self.assertRaises(errors.ReadOnlyError, index.add_version,
2465
 
            'new', 'fulltext,no-eol', (None, 50, 60), ['separate'])
 
1997
        self.assertRaises(errors.ReadOnlyError, index.add_records,
 
1998
            [(('new',), 'fulltext,no-eol', (None, 50, 60), [('separate',)])])
2466
1999
 
2467
2000
    def test_add_version_smoke(self):
2468
2001
        index = self.two_graph_index(catch_adds=True)
2469
 
        index.add_version('new', 'fulltext,no-eol', (None, 50, 60), [])
 
2002
        index.add_records([(('new',), 'fulltext,no-eol', (None, 50, 60), [])])
2470
2003
        self.assertEqual([[(('new', ), 'N50 60')]],
2471
2004
            self.caught_entries)
2472
2005
 
2473
2006
    def test_add_version_delta_not_delta_index(self):
2474
2007
        index = self.two_graph_index(catch_adds=True)
2475
 
        self.assertRaises(errors.KnitCorrupt, index.add_version,
2476
 
            'new', 'no-eol,line-delta', (None, 0, 100), [])
 
2008
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2009
            [(('new',), 'no-eol,line-delta', (None, 0, 100), [])])
2477
2010
        self.assertEqual([], self.caught_entries)
2478
2011
 
2479
2012
    def test_add_version_same_dup(self):
2480
2013
        index = self.two_graph_index(catch_adds=True)
2481
2014
        # options can be spelt two different ways
2482
 
        index.add_version('tip', 'fulltext,no-eol', (None, 0, 100), [])
2483
 
        index.add_version('tip', 'no-eol,fulltext', (None, 0, 100), [])
 
2015
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 0, 100), [])])
 
2016
        index.add_records([(('tip',), 'no-eol,fulltext', (None, 0, 100), [])])
 
2017
        # position/length are ignored (because each pack could have fulltext or
 
2018
        # delta, and be at a different position.
 
2019
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 50, 100), [])])
 
2020
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 0, 1000), [])])
2484
2021
        # but neither should have added data.
2485
 
        self.assertEqual([[], []], self.caught_entries)
2486
 
        
 
2022
        self.assertEqual([[], [], [], []], self.caught_entries)
 
2023
 
2487
2024
    def test_add_version_different_dup(self):
2488
2025
        index = self.two_graph_index(catch_adds=True)
2489
2026
        # change options
2490
 
        self.assertRaises(errors.KnitCorrupt, index.add_version,
2491
 
            'tip', 'no-eol,line-delta', (None, 0, 100), [])
2492
 
        self.assertRaises(errors.KnitCorrupt, index.add_version,
2493
 
            'tip', 'line-delta,no-eol', (None, 0, 100), [])
2494
 
        self.assertRaises(errors.KnitCorrupt, index.add_version,
2495
 
            'tip', 'fulltext', (None, 0, 100), [])
2496
 
        # position/length
2497
 
        self.assertRaises(errors.KnitCorrupt, index.add_version,
2498
 
            'tip', 'fulltext,no-eol', (None, 50, 100), [])
2499
 
        self.assertRaises(errors.KnitCorrupt, index.add_version,
2500
 
            'tip', 'fulltext,no-eol', (None, 0, 1000), [])
 
2027
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2028
            [(('tip',), 'no-eol,line-delta', (None, 0, 100), [])])
 
2029
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2030
            [(('tip',), 'line-delta,no-eol', (None, 0, 100), [])])
 
2031
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2032
            [(('tip',), 'fulltext', (None, 0, 100), [])])
2501
2033
        # parents
2502
 
        self.assertRaises(errors.KnitCorrupt, index.add_version,
2503
 
            'tip', 'fulltext,no-eol', (None, 0, 100), ['parent'])
 
2034
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2035
            [(('tip',), 'fulltext,no-eol', (None, 0, 100), [('parent',)])])
2504
2036
        self.assertEqual([], self.caught_entries)
2505
 
        
 
2037
 
2506
2038
    def test_add_versions(self):
2507
2039
        index = self.two_graph_index(catch_adds=True)
2508
 
        index.add_versions([
2509
 
                ('new', 'fulltext,no-eol', (None, 50, 60), []),
2510
 
                ('new2', 'fulltext', (None, 0, 6), []),
 
2040
        index.add_records([
 
2041
                (('new',), 'fulltext,no-eol', (None, 50, 60), []),
 
2042
                (('new2',), 'fulltext', (None, 0, 6), []),
2511
2043
                ])
2512
2044
        self.assertEqual([(('new', ), 'N50 60'), (('new2', ), ' 0 6')],
2513
2045
            sorted(self.caught_entries[0]))
2515
2047
 
2516
2048
    def test_add_versions_delta_not_delta_index(self):
2517
2049
        index = self.two_graph_index(catch_adds=True)
2518
 
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
2519
 
            [('new', 'no-eol,line-delta', (None, 0, 100), ['parent'])])
 
2050
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2051
            [(('new',), 'no-eol,line-delta', (None, 0, 100), [('parent',)])])
2520
2052
        self.assertEqual([], self.caught_entries)
2521
2053
 
2522
2054
    def test_add_versions_parents_not_parents_index(self):
2523
2055
        index = self.two_graph_index(catch_adds=True)
2524
 
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
2525
 
            [('new', 'no-eol,fulltext', (None, 0, 100), ['parent'])])
 
2056
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2057
            [(('new',), 'no-eol,fulltext', (None, 0, 100), [('parent',)])])
2526
2058
        self.assertEqual([], self.caught_entries)
2527
2059
 
 
2060
    def test_add_versions_random_id_accepted(self):
 
2061
        index = self.two_graph_index(catch_adds=True)
 
2062
        index.add_records([], random_id=True)
 
2063
 
2528
2064
    def test_add_versions_same_dup(self):
2529
2065
        index = self.two_graph_index(catch_adds=True)
2530
2066
        # options can be spelt two different ways
2531
 
        index.add_versions([('tip', 'fulltext,no-eol', (None, 0, 100), [])])
2532
 
        index.add_versions([('tip', 'no-eol,fulltext', (None, 0, 100), [])])
 
2067
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 0, 100), [])])
 
2068
        index.add_records([(('tip',), 'no-eol,fulltext', (None, 0, 100), [])])
 
2069
        # position/length are ignored (because each pack could have fulltext or
 
2070
        # delta, and be at a different position.
 
2071
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 50, 100), [])])
 
2072
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 0, 1000), [])])
2533
2073
        # but neither should have added data.
2534
 
        self.assertEqual([[], []], self.caught_entries)
2535
 
        
 
2074
        self.assertEqual([[], [], [], []], self.caught_entries)
 
2075
 
2536
2076
    def test_add_versions_different_dup(self):
2537
2077
        index = self.two_graph_index(catch_adds=True)
2538
2078
        # change options
2539
 
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
2540
 
            [('tip', 'no-eol,line-delta', (None, 0, 100), [])])
2541
 
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
2542
 
            [('tip', 'line-delta,no-eol', (None, 0, 100), [])])
2543
 
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
2544
 
            [('tip', 'fulltext', (None, 0, 100), [])])
2545
 
        # position/length
2546
 
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
2547
 
            [('tip', 'fulltext,no-eol', (None, 50, 100), [])])
2548
 
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
2549
 
            [('tip', 'fulltext,no-eol', (None, 0, 1000), [])])
 
2079
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2080
            [(('tip',), 'no-eol,line-delta', (None, 0, 100), [])])
 
2081
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2082
            [(('tip',), 'line-delta,no-eol', (None, 0, 100), [])])
 
2083
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2084
            [(('tip',), 'fulltext', (None, 0, 100), [])])
2550
2085
        # parents
2551
 
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
2552
 
            [('tip', 'fulltext,no-eol', (None, 0, 100), ['parent'])])
 
2086
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2087
            [(('tip',), 'fulltext,no-eol', (None, 0, 100), [('parent',)])])
2553
2088
        # change options in the second record
2554
 
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
2555
 
            [('tip', 'fulltext,no-eol', (None, 0, 100), []),
2556
 
             ('tip', 'no-eol,line-delta', (None, 0, 100), [])])
 
2089
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2090
            [(('tip',), 'fulltext,no-eol', (None, 0, 100), []),
 
2091
             (('tip',), 'no-eol,line-delta', (None, 0, 100), [])])
2557
2092
        self.assertEqual([], self.caught_entries)
2558
2093
 
2559
 
    def test_iter_parents(self):
2560
 
        index = self.two_graph_index()
2561
 
        self.assertEqual(set([
2562
 
            ('tip', ()), ('tail', ()), ('parent', ()), ('separate', ())
2563
 
            ]),
2564
 
            set(index.iter_parents(['tip', 'tail', 'ghost', 'parent', 'separate'])))
2565
 
        self.assertEqual(set([('tip', ())]),
2566
 
            set(index.iter_parents(['tip'])))
2567
 
        self.assertEqual(set(),
2568
 
            set(index.iter_parents([])))
 
2094
 
 
2095
class TestKnitVersionedFiles(KnitTests):
 
2096
 
 
2097
    def assertGroupKeysForIo(self, exp_groups, keys, non_local_keys,
 
2098
                             positions, _min_buffer_size=None):
 
2099
        kvf = self.make_test_knit()
 
2100
        if _min_buffer_size is None:
 
2101
            _min_buffer_size = knit._STREAM_MIN_BUFFER_SIZE
 
2102
        self.assertEqual(exp_groups, kvf._group_keys_for_io(keys,
 
2103
                                        non_local_keys, positions,
 
2104
                                        _min_buffer_size=_min_buffer_size))
 
2105
 
 
2106
    def assertSplitByPrefix(self, expected_map, expected_prefix_order,
 
2107
                            keys):
 
2108
        split, prefix_order = KnitVersionedFiles._split_by_prefix(keys)
 
2109
        self.assertEqual(expected_map, split)
 
2110
        self.assertEqual(expected_prefix_order, prefix_order)
 
2111
 
 
2112
    def test__group_keys_for_io(self):
 
2113
        ft_detail = ('fulltext', False)
 
2114
        ld_detail = ('line-delta', False)
 
2115
        f_a = ('f', 'a')
 
2116
        f_b = ('f', 'b')
 
2117
        f_c = ('f', 'c')
 
2118
        g_a = ('g', 'a')
 
2119
        g_b = ('g', 'b')
 
2120
        g_c = ('g', 'c')
 
2121
        positions = {
 
2122
            f_a: (ft_detail, (f_a, 0, 100), None),
 
2123
            f_b: (ld_detail, (f_b, 100, 21), f_a),
 
2124
            f_c: (ld_detail, (f_c, 180, 15), f_b),
 
2125
            g_a: (ft_detail, (g_a, 121, 35), None),
 
2126
            g_b: (ld_detail, (g_b, 156, 12), g_a),
 
2127
            g_c: (ld_detail, (g_c, 195, 13), g_a),
 
2128
            }
 
2129
        self.assertGroupKeysForIo([([f_a], set())],
 
2130
                                  [f_a], [], positions)
 
2131
        self.assertGroupKeysForIo([([f_a], set([f_a]))],
 
2132
                                  [f_a], [f_a], positions)
 
2133
        self.assertGroupKeysForIo([([f_a, f_b], set([]))],
 
2134
                                  [f_a, f_b], [], positions)
 
2135
        self.assertGroupKeysForIo([([f_a, f_b], set([f_b]))],
 
2136
                                  [f_a, f_b], [f_b], positions)
 
2137
        self.assertGroupKeysForIo([([f_a, f_b, g_a, g_b], set())],
 
2138
                                  [f_a, g_a, f_b, g_b], [], positions)
 
2139
        self.assertGroupKeysForIo([([f_a, f_b, g_a, g_b], set())],
 
2140
                                  [f_a, g_a, f_b, g_b], [], positions,
 
2141
                                  _min_buffer_size=150)
 
2142
        self.assertGroupKeysForIo([([f_a, f_b], set()), ([g_a, g_b], set())],
 
2143
                                  [f_a, g_a, f_b, g_b], [], positions,
 
2144
                                  _min_buffer_size=100)
 
2145
        self.assertGroupKeysForIo([([f_c], set()), ([g_b], set())],
 
2146
                                  [f_c, g_b], [], positions,
 
2147
                                  _min_buffer_size=125)
 
2148
        self.assertGroupKeysForIo([([g_b, f_c], set())],
 
2149
                                  [g_b, f_c], [], positions,
 
2150
                                  _min_buffer_size=125)
 
2151
 
 
2152
    def test__split_by_prefix(self):
 
2153
        self.assertSplitByPrefix({'f': [('f', 'a'), ('f', 'b')],
 
2154
                                  'g': [('g', 'b'), ('g', 'a')],
 
2155
                                 }, ['f', 'g'],
 
2156
                                 [('f', 'a'), ('g', 'b'),
 
2157
                                  ('g', 'a'), ('f', 'b')])
 
2158
 
 
2159
        self.assertSplitByPrefix({'f': [('f', 'a'), ('f', 'b')],
 
2160
                                  'g': [('g', 'b'), ('g', 'a')],
 
2161
                                 }, ['f', 'g'],
 
2162
                                 [('f', 'a'), ('f', 'b'),
 
2163
                                  ('g', 'b'), ('g', 'a')])
 
2164
 
 
2165
        self.assertSplitByPrefix({'f': [('f', 'a'), ('f', 'b')],
 
2166
                                  'g': [('g', 'b'), ('g', 'a')],
 
2167
                                 }, ['f', 'g'],
 
2168
                                 [('f', 'a'), ('f', 'b'),
 
2169
                                  ('g', 'b'), ('g', 'a')])
 
2170
 
 
2171
        self.assertSplitByPrefix({'f': [('f', 'a'), ('f', 'b')],
 
2172
                                  'g': [('g', 'b'), ('g', 'a')],
 
2173
                                  '': [('a',), ('b',)]
 
2174
                                 }, ['f', 'g', ''],
 
2175
                                 [('f', 'a'), ('g', 'b'),
 
2176
                                  ('a',), ('b',),
 
2177
                                  ('g', 'a'), ('f', 'b')])
 
2178
 
 
2179
 
 
2180
class TestStacking(KnitTests):
 
2181
 
 
2182
    def get_basis_and_test_knit(self):
 
2183
        basis = self.make_test_knit(name='basis')
 
2184
        basis = RecordingVersionedFilesDecorator(basis)
 
2185
        test = self.make_test_knit(name='test')
 
2186
        test.add_fallback_versioned_files(basis)
 
2187
        return basis, test
 
2188
 
 
2189
    def test_add_fallback_versioned_files(self):
 
2190
        basis = self.make_test_knit(name='basis')
 
2191
        test = self.make_test_knit(name='test')
 
2192
        # It must not error; other tests test that the fallback is referred to
 
2193
        # when accessing data.
 
2194
        test.add_fallback_versioned_files(basis)
 
2195
 
 
2196
    def test_add_lines(self):
 
2197
        # lines added to the test are not added to the basis
 
2198
        basis, test = self.get_basis_and_test_knit()
 
2199
        key = ('foo',)
 
2200
        key_basis = ('bar',)
 
2201
        key_cross_border = ('quux',)
 
2202
        key_delta = ('zaphod',)
 
2203
        test.add_lines(key, (), ['foo\n'])
 
2204
        self.assertEqual({}, basis.get_parent_map([key]))
 
2205
        # lines added to the test that reference across the stack do a
 
2206
        # fulltext.
 
2207
        basis.add_lines(key_basis, (), ['foo\n'])
 
2208
        basis.calls = []
 
2209
        test.add_lines(key_cross_border, (key_basis,), ['foo\n'])
 
2210
        self.assertEqual('fulltext', test._index.get_method(key_cross_border))
 
2211
        # we don't even need to look at the basis to see that this should be
 
2212
        # stored as a fulltext
 
2213
        self.assertEqual([], basis.calls)
 
2214
        # Subsequent adds do delta.
 
2215
        basis.calls = []
 
2216
        test.add_lines(key_delta, (key_cross_border,), ['foo\n'])
 
2217
        self.assertEqual('line-delta', test._index.get_method(key_delta))
 
2218
        self.assertEqual([], basis.calls)
 
2219
 
 
2220
    def test_annotate(self):
 
2221
        # annotations from the test knit are answered without asking the basis
 
2222
        basis, test = self.get_basis_and_test_knit()
 
2223
        key = ('foo',)
 
2224
        key_basis = ('bar',)
 
2225
        key_missing = ('missing',)
 
2226
        test.add_lines(key, (), ['foo\n'])
 
2227
        details = test.annotate(key)
 
2228
        self.assertEqual([(key, 'foo\n')], details)
 
2229
        self.assertEqual([], basis.calls)
 
2230
        # But texts that are not in the test knit are looked for in the basis
 
2231
        # directly.
 
2232
        basis.add_lines(key_basis, (), ['foo\n', 'bar\n'])
 
2233
        basis.calls = []
 
2234
        details = test.annotate(key_basis)
 
2235
        self.assertEqual([(key_basis, 'foo\n'), (key_basis, 'bar\n')], details)
 
2236
        # Not optimised to date:
 
2237
        # self.assertEqual([("annotate", key_basis)], basis.calls)
 
2238
        self.assertEqual([('get_parent_map', set([key_basis])),
 
2239
            ('get_parent_map', set([key_basis])),
 
2240
            ('get_record_stream', [key_basis], 'topological', True)],
 
2241
            basis.calls)
 
2242
 
 
2243
    def test_check(self):
 
2244
        # At the moment checking a stacked knit does implicitly check the
 
2245
        # fallback files.
 
2246
        basis, test = self.get_basis_and_test_knit()
 
2247
        test.check()
 
2248
 
 
2249
    def test_get_parent_map(self):
 
2250
        # parents in the test knit are answered without asking the basis
 
2251
        basis, test = self.get_basis_and_test_knit()
 
2252
        key = ('foo',)
 
2253
        key_basis = ('bar',)
 
2254
        key_missing = ('missing',)
 
2255
        test.add_lines(key, (), [])
 
2256
        parent_map = test.get_parent_map([key])
 
2257
        self.assertEqual({key: ()}, parent_map)
 
2258
        self.assertEqual([], basis.calls)
 
2259
        # But parents that are not in the test knit are looked for in the basis
 
2260
        basis.add_lines(key_basis, (), [])
 
2261
        basis.calls = []
 
2262
        parent_map = test.get_parent_map([key, key_basis, key_missing])
 
2263
        self.assertEqual({key: (),
 
2264
            key_basis: ()}, parent_map)
 
2265
        self.assertEqual([("get_parent_map", set([key_basis, key_missing]))],
 
2266
            basis.calls)
 
2267
 
 
2268
    def test_get_record_stream_unordered_fulltexts(self):
 
2269
        # records from the test knit are answered without asking the basis:
 
2270
        basis, test = self.get_basis_and_test_knit()
 
2271
        key = ('foo',)
 
2272
        key_basis = ('bar',)
 
2273
        key_missing = ('missing',)
 
2274
        test.add_lines(key, (), ['foo\n'])
 
2275
        records = list(test.get_record_stream([key], 'unordered', True))
 
2276
        self.assertEqual(1, len(records))
 
2277
        self.assertEqual([], basis.calls)
 
2278
        # Missing (from test knit) objects are retrieved from the basis:
 
2279
        basis.add_lines(key_basis, (), ['foo\n', 'bar\n'])
 
2280
        basis.calls = []
 
2281
        records = list(test.get_record_stream([key_basis, key_missing],
 
2282
            'unordered', True))
 
2283
        self.assertEqual(2, len(records))
 
2284
        calls = list(basis.calls)
 
2285
        for record in records:
 
2286
            self.assertSubset([record.key], (key_basis, key_missing))
 
2287
            if record.key == key_missing:
 
2288
                self.assertIsInstance(record, AbsentContentFactory)
 
2289
            else:
 
2290
                reference = list(basis.get_record_stream([key_basis],
 
2291
                    'unordered', True))[0]
 
2292
                self.assertEqual(reference.key, record.key)
 
2293
                self.assertEqual(reference.sha1, record.sha1)
 
2294
                self.assertEqual(reference.storage_kind, record.storage_kind)
 
2295
                self.assertEqual(reference.get_bytes_as(reference.storage_kind),
 
2296
                    record.get_bytes_as(record.storage_kind))
 
2297
                self.assertEqual(reference.get_bytes_as('fulltext'),
 
2298
                    record.get_bytes_as('fulltext'))
 
2299
        # It's not strictly minimal, but it seems reasonable for now for it to
 
2300
        # ask which fallbacks have which parents.
 
2301
        self.assertEqual([
 
2302
            ("get_parent_map", set([key_basis, key_missing])),
 
2303
            ("get_record_stream", [key_basis], 'unordered', True)],
 
2304
            calls)
 
2305
 
 
2306
    def test_get_record_stream_ordered_fulltexts(self):
 
2307
        # ordering is preserved down into the fallback store.
 
2308
        basis, test = self.get_basis_and_test_knit()
 
2309
        key = ('foo',)
 
2310
        key_basis = ('bar',)
 
2311
        key_basis_2 = ('quux',)
 
2312
        key_missing = ('missing',)
 
2313
        test.add_lines(key, (key_basis,), ['foo\n'])
 
2314
        # Missing (from test knit) objects are retrieved from the basis:
 
2315
        basis.add_lines(key_basis, (key_basis_2,), ['foo\n', 'bar\n'])
 
2316
        basis.add_lines(key_basis_2, (), ['quux\n'])
 
2317
        basis.calls = []
 
2318
        # ask for in non-topological order
 
2319
        records = list(test.get_record_stream(
 
2320
            [key, key_basis, key_missing, key_basis_2], 'topological', True))
 
2321
        self.assertEqual(4, len(records))
 
2322
        results = []
 
2323
        for record in records:
 
2324
            self.assertSubset([record.key],
 
2325
                (key_basis, key_missing, key_basis_2, key))
 
2326
            if record.key == key_missing:
 
2327
                self.assertIsInstance(record, AbsentContentFactory)
 
2328
            else:
 
2329
                results.append((record.key, record.sha1, record.storage_kind,
 
2330
                    record.get_bytes_as('fulltext')))
 
2331
        calls = list(basis.calls)
 
2332
        order = [record[0] for record in results]
 
2333
        self.assertEqual([key_basis_2, key_basis, key], order)
 
2334
        for result in results:
 
2335
            if result[0] == key:
 
2336
                source = test
 
2337
            else:
 
2338
                source = basis
 
2339
            record = source.get_record_stream([result[0]], 'unordered',
 
2340
                True).next()
 
2341
            self.assertEqual(record.key, result[0])
 
2342
            self.assertEqual(record.sha1, result[1])
 
2343
            # We used to check that the storage kind matched, but actually it
 
2344
            # depends on whether it was sourced from the basis, or in a single
 
2345
            # group, because asking for full texts returns proxy objects to a
 
2346
            # _ContentMapGenerator object; so checking the kind is unneeded.
 
2347
            self.assertEqual(record.get_bytes_as('fulltext'), result[3])
 
2348
        # It's not strictly minimal, but it seems reasonable for now for it to
 
2349
        # ask which fallbacks have which parents.
 
2350
        self.assertEqual([
 
2351
            ("get_parent_map", set([key_basis, key_basis_2, key_missing])),
 
2352
            # topological is requested from the fallback, because that is what
 
2353
            # was requested at the top level.
 
2354
            ("get_record_stream", [key_basis_2, key_basis], 'topological', True)],
 
2355
            calls)
 
2356
 
 
2357
    def test_get_record_stream_unordered_deltas(self):
 
2358
        # records from the test knit are answered without asking the basis:
 
2359
        basis, test = self.get_basis_and_test_knit()
 
2360
        key = ('foo',)
 
2361
        key_basis = ('bar',)
 
2362
        key_missing = ('missing',)
 
2363
        test.add_lines(key, (), ['foo\n'])
 
2364
        records = list(test.get_record_stream([key], 'unordered', False))
 
2365
        self.assertEqual(1, len(records))
 
2366
        self.assertEqual([], basis.calls)
 
2367
        # Missing (from test knit) objects are retrieved from the basis:
 
2368
        basis.add_lines(key_basis, (), ['foo\n', 'bar\n'])
 
2369
        basis.calls = []
 
2370
        records = list(test.get_record_stream([key_basis, key_missing],
 
2371
            'unordered', False))
 
2372
        self.assertEqual(2, len(records))
 
2373
        calls = list(basis.calls)
 
2374
        for record in records:
 
2375
            self.assertSubset([record.key], (key_basis, key_missing))
 
2376
            if record.key == key_missing:
 
2377
                self.assertIsInstance(record, AbsentContentFactory)
 
2378
            else:
 
2379
                reference = list(basis.get_record_stream([key_basis],
 
2380
                    'unordered', False))[0]
 
2381
                self.assertEqual(reference.key, record.key)
 
2382
                self.assertEqual(reference.sha1, record.sha1)
 
2383
                self.assertEqual(reference.storage_kind, record.storage_kind)
 
2384
                self.assertEqual(reference.get_bytes_as(reference.storage_kind),
 
2385
                    record.get_bytes_as(record.storage_kind))
 
2386
        # It's not strictly minimal, but it seems reasonable for now for it to
 
2387
        # ask which fallbacks have which parents.
 
2388
        self.assertEqual([
 
2389
            ("get_parent_map", set([key_basis, key_missing])),
 
2390
            ("get_record_stream", [key_basis], 'unordered', False)],
 
2391
            calls)
 
2392
 
 
2393
    def test_get_record_stream_ordered_deltas(self):
 
2394
        # ordering is preserved down into the fallback store.
 
2395
        basis, test = self.get_basis_and_test_knit()
 
2396
        key = ('foo',)
 
2397
        key_basis = ('bar',)
 
2398
        key_basis_2 = ('quux',)
 
2399
        key_missing = ('missing',)
 
2400
        test.add_lines(key, (key_basis,), ['foo\n'])
 
2401
        # Missing (from test knit) objects are retrieved from the basis:
 
2402
        basis.add_lines(key_basis, (key_basis_2,), ['foo\n', 'bar\n'])
 
2403
        basis.add_lines(key_basis_2, (), ['quux\n'])
 
2404
        basis.calls = []
 
2405
        # ask for in non-topological order
 
2406
        records = list(test.get_record_stream(
 
2407
            [key, key_basis, key_missing, key_basis_2], 'topological', False))
 
2408
        self.assertEqual(4, len(records))
 
2409
        results = []
 
2410
        for record in records:
 
2411
            self.assertSubset([record.key],
 
2412
                (key_basis, key_missing, key_basis_2, key))
 
2413
            if record.key == key_missing:
 
2414
                self.assertIsInstance(record, AbsentContentFactory)
 
2415
            else:
 
2416
                results.append((record.key, record.sha1, record.storage_kind,
 
2417
                    record.get_bytes_as(record.storage_kind)))
 
2418
        calls = list(basis.calls)
 
2419
        order = [record[0] for record in results]
 
2420
        self.assertEqual([key_basis_2, key_basis, key], order)
 
2421
        for result in results:
 
2422
            if result[0] == key:
 
2423
                source = test
 
2424
            else:
 
2425
                source = basis
 
2426
            record = source.get_record_stream([result[0]], 'unordered',
 
2427
                False).next()
 
2428
            self.assertEqual(record.key, result[0])
 
2429
            self.assertEqual(record.sha1, result[1])
 
2430
            self.assertEqual(record.storage_kind, result[2])
 
2431
            self.assertEqual(record.get_bytes_as(record.storage_kind), result[3])
 
2432
        # It's not strictly minimal, but it seems reasonable for now for it to
 
2433
        # ask which fallbacks have which parents.
 
2434
        self.assertEqual([
 
2435
            ("get_parent_map", set([key_basis, key_basis_2, key_missing])),
 
2436
            ("get_record_stream", [key_basis_2, key_basis], 'topological', False)],
 
2437
            calls)
 
2438
 
 
2439
    def test_get_sha1s(self):
 
2440
        # sha1's in the test knit are answered without asking the basis
 
2441
        basis, test = self.get_basis_and_test_knit()
 
2442
        key = ('foo',)
 
2443
        key_basis = ('bar',)
 
2444
        key_missing = ('missing',)
 
2445
        test.add_lines(key, (), ['foo\n'])
 
2446
        key_sha1sum = osutils.sha_string('foo\n')
 
2447
        sha1s = test.get_sha1s([key])
 
2448
        self.assertEqual({key: key_sha1sum}, sha1s)
 
2449
        self.assertEqual([], basis.calls)
 
2450
        # But texts that are not in the test knit are looked for in the basis
 
2451
        # directly (rather than via text reconstruction) so that remote servers
 
2452
        # etc don't have to answer with full content.
 
2453
        basis.add_lines(key_basis, (), ['foo\n', 'bar\n'])
 
2454
        basis_sha1sum = osutils.sha_string('foo\nbar\n')
 
2455
        basis.calls = []
 
2456
        sha1s = test.get_sha1s([key, key_missing, key_basis])
 
2457
        self.assertEqual({key: key_sha1sum,
 
2458
            key_basis: basis_sha1sum}, sha1s)
 
2459
        self.assertEqual([("get_sha1s", set([key_basis, key_missing]))],
 
2460
            basis.calls)
 
2461
 
 
2462
    def test_insert_record_stream(self):
 
2463
        # records are inserted as normal; insert_record_stream builds on
 
2464
        # add_lines, so a smoke test should be all that's needed:
 
2465
        key = ('foo',)
 
2466
        key_basis = ('bar',)
 
2467
        key_delta = ('zaphod',)
 
2468
        basis, test = self.get_basis_and_test_knit()
 
2469
        source = self.make_test_knit(name='source')
 
2470
        basis.add_lines(key_basis, (), ['foo\n'])
 
2471
        basis.calls = []
 
2472
        source.add_lines(key_basis, (), ['foo\n'])
 
2473
        source.add_lines(key_delta, (key_basis,), ['bar\n'])
 
2474
        stream = source.get_record_stream([key_delta], 'unordered', False)
 
2475
        test.insert_record_stream(stream)
 
2476
        # XXX: this does somewhat too many calls in making sure of whether it
 
2477
        # has to recreate the full text.
 
2478
        self.assertEqual([("get_parent_map", set([key_basis])),
 
2479
             ('get_parent_map', set([key_basis])),
 
2480
             ('get_record_stream', [key_basis], 'unordered', True)],
 
2481
            basis.calls)
 
2482
        self.assertEqual({key_delta:(key_basis,)},
 
2483
            test.get_parent_map([key_delta]))
 
2484
        self.assertEqual('bar\n', test.get_record_stream([key_delta],
 
2485
            'unordered', True).next().get_bytes_as('fulltext'))
 
2486
 
 
2487
    def test_iter_lines_added_or_present_in_keys(self):
 
2488
        # Lines from the basis are returned, and lines for a given key are only
 
2489
        # returned once.
 
2490
        key1 = ('foo1',)
 
2491
        key2 = ('foo2',)
 
2492
        # all sources are asked for keys:
 
2493
        basis, test = self.get_basis_and_test_knit()
 
2494
        basis.add_lines(key1, (), ["foo"])
 
2495
        basis.calls = []
 
2496
        lines = list(test.iter_lines_added_or_present_in_keys([key1]))
 
2497
        self.assertEqual([("foo\n", key1)], lines)
 
2498
        self.assertEqual([("iter_lines_added_or_present_in_keys", set([key1]))],
 
2499
            basis.calls)
 
2500
        # keys in both are not duplicated:
 
2501
        test.add_lines(key2, (), ["bar\n"])
 
2502
        basis.add_lines(key2, (), ["bar\n"])
 
2503
        basis.calls = []
 
2504
        lines = list(test.iter_lines_added_or_present_in_keys([key2]))
 
2505
        self.assertEqual([("bar\n", key2)], lines)
 
2506
        self.assertEqual([], basis.calls)
 
2507
 
 
2508
    def test_keys(self):
 
2509
        key1 = ('foo1',)
 
2510
        key2 = ('foo2',)
 
2511
        # all sources are asked for keys:
 
2512
        basis, test = self.get_basis_and_test_knit()
 
2513
        keys = test.keys()
 
2514
        self.assertEqual(set(), set(keys))
 
2515
        self.assertEqual([("keys",)], basis.calls)
 
2516
        # keys from a basis are returned:
 
2517
        basis.add_lines(key1, (), [])
 
2518
        basis.calls = []
 
2519
        keys = test.keys()
 
2520
        self.assertEqual(set([key1]), set(keys))
 
2521
        self.assertEqual([("keys",)], basis.calls)
 
2522
        # keys in both are not duplicated:
 
2523
        test.add_lines(key2, (), [])
 
2524
        basis.add_lines(key2, (), [])
 
2525
        basis.calls = []
 
2526
        keys = test.keys()
 
2527
        self.assertEqual(2, len(keys))
 
2528
        self.assertEqual(set([key1, key2]), set(keys))
 
2529
        self.assertEqual([("keys",)], basis.calls)
 
2530
 
 
2531
    def test_add_mpdiffs(self):
 
2532
        # records are inserted as normal; add_mpdiff builds on
 
2533
        # add_lines, so a smoke test should be all that's needed:
 
2534
        key = ('foo',)
 
2535
        key_basis = ('bar',)
 
2536
        key_delta = ('zaphod',)
 
2537
        basis, test = self.get_basis_and_test_knit()
 
2538
        source = self.make_test_knit(name='source')
 
2539
        basis.add_lines(key_basis, (), ['foo\n'])
 
2540
        basis.calls = []
 
2541
        source.add_lines(key_basis, (), ['foo\n'])
 
2542
        source.add_lines(key_delta, (key_basis,), ['bar\n'])
 
2543
        diffs = source.make_mpdiffs([key_delta])
 
2544
        test.add_mpdiffs([(key_delta, (key_basis,),
 
2545
            source.get_sha1s([key_delta])[key_delta], diffs[0])])
 
2546
        self.assertEqual([("get_parent_map", set([key_basis])),
 
2547
            ('get_record_stream', [key_basis], 'unordered', True),],
 
2548
            basis.calls)
 
2549
        self.assertEqual({key_delta:(key_basis,)},
 
2550
            test.get_parent_map([key_delta]))
 
2551
        self.assertEqual('bar\n', test.get_record_stream([key_delta],
 
2552
            'unordered', True).next().get_bytes_as('fulltext'))
 
2553
 
 
2554
    def test_make_mpdiffs(self):
 
2555
        # Generating an mpdiff across a stacking boundary should detect parent
 
2556
        # texts regions.
 
2557
        key = ('foo',)
 
2558
        key_left = ('bar',)
 
2559
        key_right = ('zaphod',)
 
2560
        basis, test = self.get_basis_and_test_knit()
 
2561
        basis.add_lines(key_left, (), ['bar\n'])
 
2562
        basis.add_lines(key_right, (), ['zaphod\n'])
 
2563
        basis.calls = []
 
2564
        test.add_lines(key, (key_left, key_right),
 
2565
            ['bar\n', 'foo\n', 'zaphod\n'])
 
2566
        diffs = test.make_mpdiffs([key])
 
2567
        self.assertEqual([
 
2568
            multiparent.MultiParent([multiparent.ParentText(0, 0, 0, 1),
 
2569
                multiparent.NewText(['foo\n']),
 
2570
                multiparent.ParentText(1, 0, 2, 1)])],
 
2571
            diffs)
 
2572
        self.assertEqual(3, len(basis.calls))
 
2573
        self.assertEqual([
 
2574
            ("get_parent_map", set([key_left, key_right])),
 
2575
            ("get_parent_map", set([key_left, key_right])),
 
2576
            ],
 
2577
            basis.calls[:-1])
 
2578
        last_call = basis.calls[-1]
 
2579
        self.assertEqual('get_record_stream', last_call[0])
 
2580
        self.assertEqual(set([key_left, key_right]), set(last_call[1]))
 
2581
        self.assertEqual('topological', last_call[2])
 
2582
        self.assertEqual(True, last_call[3])
 
2583
 
 
2584
 
 
2585
class TestNetworkBehaviour(KnitTests):
 
2586
    """Tests for getting data out of/into knits over the network."""
 
2587
 
 
2588
    def test_include_delta_closure_generates_a_knit_delta_closure(self):
 
2589
        vf = self.make_test_knit(name='test')
 
2590
        # put in three texts, giving ft, delta, delta
 
2591
        vf.add_lines(('base',), (), ['base\n', 'content\n'])
 
2592
        vf.add_lines(('d1',), (('base',),), ['d1\n'])
 
2593
        vf.add_lines(('d2',), (('d1',),), ['d2\n'])
 
2594
        # But heuristics could interfere, so check what happened:
 
2595
        self.assertEqual(['knit-ft-gz', 'knit-delta-gz', 'knit-delta-gz'],
 
2596
            [record.storage_kind for record in
 
2597
             vf.get_record_stream([('base',), ('d1',), ('d2',)],
 
2598
                'topological', False)])
 
2599
        # generate a stream of just the deltas include_delta_closure=True,
 
2600
        # serialise to the network, and check that we get a delta closure on the wire.
 
2601
        stream = vf.get_record_stream([('d1',), ('d2',)], 'topological', True)
 
2602
        netb = [record.get_bytes_as(record.storage_kind) for record in stream]
 
2603
        # The first bytes should be a memo from _ContentMapGenerator, and the
 
2604
        # second bytes should be empty (because its a API proxy not something
 
2605
        # for wire serialisation.
 
2606
        self.assertEqual('', netb[1])
 
2607
        bytes = netb[0]
 
2608
        kind, line_end = network_bytes_to_kind_and_offset(bytes)
 
2609
        self.assertEqual('knit-delta-closure', kind)
 
2610
 
 
2611
 
 
2612
class TestContentMapGenerator(KnitTests):
 
2613
    """Tests for ContentMapGenerator"""
 
2614
 
 
2615
    def test_get_record_stream_gives_records(self):
 
2616
        vf = self.make_test_knit(name='test')
 
2617
        # put in three texts, giving ft, delta, delta
 
2618
        vf.add_lines(('base',), (), ['base\n', 'content\n'])
 
2619
        vf.add_lines(('d1',), (('base',),), ['d1\n'])
 
2620
        vf.add_lines(('d2',), (('d1',),), ['d2\n'])
 
2621
        keys = [('d1',), ('d2',)]
 
2622
        generator = _VFContentMapGenerator(vf, keys,
 
2623
            global_map=vf.get_parent_map(keys))
 
2624
        for record in generator.get_record_stream():
 
2625
            if record.key == ('d1',):
 
2626
                self.assertEqual('d1\n', record.get_bytes_as('fulltext'))
 
2627
            else:
 
2628
                self.assertEqual('d2\n', record.get_bytes_as('fulltext'))
 
2629
 
 
2630
    def test_get_record_stream_kinds_are_raw(self):
 
2631
        vf = self.make_test_knit(name='test')
 
2632
        # put in three texts, giving ft, delta, delta
 
2633
        vf.add_lines(('base',), (), ['base\n', 'content\n'])
 
2634
        vf.add_lines(('d1',), (('base',),), ['d1\n'])
 
2635
        vf.add_lines(('d2',), (('d1',),), ['d2\n'])
 
2636
        keys = [('base',), ('d1',), ('d2',)]
 
2637
        generator = _VFContentMapGenerator(vf, keys,
 
2638
            global_map=vf.get_parent_map(keys))
 
2639
        kinds = {('base',): 'knit-delta-closure',
 
2640
            ('d1',): 'knit-delta-closure-ref',
 
2641
            ('d2',): 'knit-delta-closure-ref',
 
2642
            }
 
2643
        for record in generator.get_record_stream():
 
2644
            self.assertEqual(kinds[record.key], record.storage_kind)