~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_knit.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-03-16 14:01:20 UTC
  • mfrom: (3280.2.5 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20080316140120-i3yq8yr1l66m11h7
Start 1.4 development

Show diffs side-by-side

added added

removed removed

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