~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_knit.py

Merge up bzr.dev.

Show diffs side-by-side

added added

removed removed

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