252
110
            return StringIO("\n".join(self.file_lines))
 
254
 
    def readv(self, relpath, offsets):
 
255
 
        fp = self.get(relpath)
 
256
 
        for offset, size in offsets:
 
258
 
            yield offset, fp.read(size)
 
260
112
    def __getattr__(self, name):
 
261
113
        def queue_call(*args, **kwargs):
 
262
114
            self.calls.append((name, args, kwargs))
 
263
115
        return queue_call
 
266
 
class MockReadvFailingTransport(MockTransport):
 
267
 
    """Fail in the middle of a readv() result.
 
269
 
    This Transport will successfully yield the first two requested hunks, but
 
270
 
    raise NoSuchFile for the rest.
 
273
 
    def readv(self, relpath, offsets):
 
275
 
        for result in MockTransport.readv(self, relpath, offsets):
 
277
 
            # we use 2 because the first offset is the pack header, the second
 
278
 
            # is the first actual content requset
 
280
 
                raise errors.NoSuchFile(relpath)
 
284
 
class KnitRecordAccessTestsMixin(object):
 
285
 
    """Tests for getting and putting knit records."""
 
287
 
    def test_add_raw_records(self):
 
288
 
        """Add_raw_records adds records retrievable later."""
 
289
 
        access = self.get_access()
 
290
 
        memos = access.add_raw_records([('key', 10)], '1234567890')
 
291
 
        self.assertEqual(['1234567890'], list(access.get_raw_records(memos)))
 
293
 
    def test_add_several_raw_records(self):
 
294
 
        """add_raw_records with many records and read some back."""
 
295
 
        access = self.get_access()
 
296
 
        memos = access.add_raw_records([('key', 10), ('key2', 2), ('key3', 5)],
 
298
 
        self.assertEqual(['1234567890', '12', '34567'],
 
299
 
            list(access.get_raw_records(memos)))
 
300
 
        self.assertEqual(['1234567890'],
 
301
 
            list(access.get_raw_records(memos[0:1])))
 
302
 
        self.assertEqual(['12'],
 
303
 
            list(access.get_raw_records(memos[1:2])))
 
304
 
        self.assertEqual(['34567'],
 
305
 
            list(access.get_raw_records(memos[2:3])))
 
306
 
        self.assertEqual(['1234567890', '34567'],
 
307
 
            list(access.get_raw_records(memos[0:1] + memos[2:3])))
 
310
 
class TestKnitKnitAccess(TestCaseWithMemoryTransport, KnitRecordAccessTestsMixin):
 
311
 
    """Tests for the .kndx implementation."""
 
313
 
    def get_access(self):
 
314
 
        """Get a .knit style access instance."""
 
315
 
        mapper = ConstantMapper("foo")
 
316
 
        access = _KnitKeyAccess(self.get_transport(), mapper)
 
320
 
class _TestException(Exception):
 
321
 
    """Just an exception for local tests to use."""
 
324
 
class TestPackKnitAccess(TestCaseWithMemoryTransport, KnitRecordAccessTestsMixin):
 
325
 
    """Tests for the pack based access."""
 
327
 
    def get_access(self):
 
328
 
        return self._get_access()[0]
 
330
 
    def _get_access(self, packname='packfile', index='FOO'):
 
331
 
        transport = self.get_transport()
 
332
 
        def write_data(bytes):
 
333
 
            transport.append_bytes(packname, bytes)
 
334
 
        writer = pack.ContainerWriter(write_data)
 
336
 
        access = _DirectPackAccess({})
 
337
 
        access.set_writer(writer, index, (transport, packname))
 
338
 
        return access, writer
 
340
 
    def make_pack_file(self):
 
341
 
        """Create a pack file with 2 records."""
 
342
 
        access, writer = self._get_access(packname='packname', index='foo')
 
344
 
        memos.extend(access.add_raw_records([('key1', 10)], '1234567890'))
 
345
 
        memos.extend(access.add_raw_records([('key2', 5)], '12345'))
 
349
 
    def make_vf_for_retrying(self):
 
350
 
        """Create 3 packs and a reload function.
 
352
 
        Originally, 2 pack files will have the data, but one will be missing.
 
353
 
        And then the third will be used in place of the first two if reload()
 
356
 
        :return: (versioned_file, reload_counter)
 
357
 
            versioned_file  a KnitVersionedFiles using the packs for access
 
359
 
        builder = self.make_branch_builder('.', format="1.9")
 
360
 
        builder.start_series()
 
361
 
        builder.build_snapshot('rev-1', None, [
 
362
 
            ('add', ('', 'root-id', 'directory', None)),
 
363
 
            ('add', ('file', 'file-id', 'file', 'content\nrev 1\n')),
 
365
 
        builder.build_snapshot('rev-2', ['rev-1'], [
 
366
 
            ('modify', ('file-id', 'content\nrev 2\n')),
 
368
 
        builder.build_snapshot('rev-3', ['rev-2'], [
 
369
 
            ('modify', ('file-id', 'content\nrev 3\n')),
 
371
 
        builder.finish_series()
 
372
 
        b = builder.get_branch()
 
374
 
        self.addCleanup(b.unlock)
 
375
 
        # Pack these three revisions into another pack file, but don't remove
 
378
 
        collection = repo._pack_collection
 
379
 
        collection.ensure_loaded()
 
380
 
        orig_packs = collection.packs
 
381
 
        packer = pack_repo.Packer(collection, orig_packs, '.testpack')
 
382
 
        new_pack = packer.pack()
 
383
 
        # forget about the new pack
 
387
 
        # Set up a reload() function that switches to using the new pack file
 
388
 
        new_index = new_pack.revision_index
 
389
 
        access_tuple = new_pack.access_tuple()
 
390
 
        reload_counter = [0, 0, 0]
 
392
 
            reload_counter[0] += 1
 
393
 
            if reload_counter[1] > 0:
 
394
 
                # We already reloaded, nothing more to do
 
395
 
                reload_counter[2] += 1
 
397
 
            reload_counter[1] += 1
 
398
 
            vf._index._graph_index._indices[:] = [new_index]
 
399
 
            vf._access._indices.clear()
 
400
 
            vf._access._indices[new_index] = access_tuple
 
402
 
        # Delete one of the pack files so the data will need to be reloaded. We
 
403
 
        # will delete the file with 'rev-2' in it
 
404
 
        trans, name = orig_packs[1].access_tuple()
 
406
 
        # We don't have the index trigger reloading because we want to test
 
407
 
        # that we reload when the .pack disappears
 
408
 
        vf._access._reload_func = reload
 
409
 
        return vf, reload_counter
 
411
 
    def make_reload_func(self, return_val=True):
 
414
 
            reload_called[0] += 1
 
416
 
        return reload_called, reload
 
418
 
    def make_retry_exception(self):
 
419
 
        # We raise a real exception so that sys.exc_info() is properly
 
422
 
            raise _TestException('foobar')
 
423
 
        except _TestException, e:
 
424
 
            retry_exc = errors.RetryWithNewPacks(None, reload_occurred=False,
 
425
 
                                                 exc_info=sys.exc_info())
 
428
 
    def test_read_from_several_packs(self):
 
429
 
        access, writer = self._get_access()
 
431
 
        memos.extend(access.add_raw_records([('key', 10)], '1234567890'))
 
433
 
        access, writer = self._get_access('pack2', 'FOOBAR')
 
434
 
        memos.extend(access.add_raw_records([('key', 5)], '12345'))
 
436
 
        access, writer = self._get_access('pack3', 'BAZ')
 
437
 
        memos.extend(access.add_raw_records([('key', 5)], 'alpha'))
 
439
 
        transport = self.get_transport()
 
440
 
        access = _DirectPackAccess({"FOO":(transport, 'packfile'),
 
441
 
            "FOOBAR":(transport, 'pack2'),
 
442
 
            "BAZ":(transport, 'pack3')})
 
443
 
        self.assertEqual(['1234567890', '12345', 'alpha'],
 
444
 
            list(access.get_raw_records(memos)))
 
445
 
        self.assertEqual(['1234567890'],
 
446
 
            list(access.get_raw_records(memos[0:1])))
 
447
 
        self.assertEqual(['12345'],
 
448
 
            list(access.get_raw_records(memos[1:2])))
 
449
 
        self.assertEqual(['alpha'],
 
450
 
            list(access.get_raw_records(memos[2:3])))
 
451
 
        self.assertEqual(['1234567890', 'alpha'],
 
452
 
            list(access.get_raw_records(memos[0:1] + memos[2:3])))
 
454
 
    def test_set_writer(self):
 
455
 
        """The writer should be settable post construction."""
 
456
 
        access = _DirectPackAccess({})
 
457
 
        transport = self.get_transport()
 
458
 
        packname = 'packfile'
 
460
 
        def write_data(bytes):
 
461
 
            transport.append_bytes(packname, bytes)
 
462
 
        writer = pack.ContainerWriter(write_data)
 
464
 
        access.set_writer(writer, index, (transport, packname))
 
465
 
        memos = access.add_raw_records([('key', 10)], '1234567890')
 
467
 
        self.assertEqual(['1234567890'], list(access.get_raw_records(memos)))
 
469
 
    def test_missing_index_raises_retry(self):
 
470
 
        memos = self.make_pack_file()
 
471
 
        transport = self.get_transport()
 
472
 
        reload_called, reload_func = self.make_reload_func()
 
473
 
        # Note that the index key has changed from 'foo' to 'bar'
 
474
 
        access = _DirectPackAccess({'bar':(transport, 'packname')},
 
475
 
                                   reload_func=reload_func)
 
476
 
        e = self.assertListRaises(errors.RetryWithNewPacks,
 
477
 
                                  access.get_raw_records, memos)
 
478
 
        # Because a key was passed in which does not match our index list, we
 
479
 
        # assume that the listing was already reloaded
 
480
 
        self.assertTrue(e.reload_occurred)
 
481
 
        self.assertIsInstance(e.exc_info, tuple)
 
482
 
        self.assertIs(e.exc_info[0], KeyError)
 
483
 
        self.assertIsInstance(e.exc_info[1], KeyError)
 
485
 
    def test_missing_index_raises_key_error_with_no_reload(self):
 
486
 
        memos = self.make_pack_file()
 
487
 
        transport = self.get_transport()
 
488
 
        # Note that the index key has changed from 'foo' to 'bar'
 
489
 
        access = _DirectPackAccess({'bar':(transport, 'packname')})
 
490
 
        e = self.assertListRaises(KeyError, access.get_raw_records, memos)
 
492
 
    def test_missing_file_raises_retry(self):
 
493
 
        memos = self.make_pack_file()
 
494
 
        transport = self.get_transport()
 
495
 
        reload_called, reload_func = self.make_reload_func()
 
496
 
        # Note that the 'filename' has been changed to 'different-packname'
 
497
 
        access = _DirectPackAccess({'foo':(transport, 'different-packname')},
 
498
 
                                   reload_func=reload_func)
 
499
 
        e = self.assertListRaises(errors.RetryWithNewPacks,
 
500
 
                                  access.get_raw_records, memos)
 
501
 
        # The file has gone missing, so we assume we need to reload
 
502
 
        self.assertFalse(e.reload_occurred)
 
503
 
        self.assertIsInstance(e.exc_info, tuple)
 
504
 
        self.assertIs(e.exc_info[0], errors.NoSuchFile)
 
505
 
        self.assertIsInstance(e.exc_info[1], errors.NoSuchFile)
 
506
 
        self.assertEqual('different-packname', e.exc_info[1].path)
 
508
 
    def test_missing_file_raises_no_such_file_with_no_reload(self):
 
509
 
        memos = self.make_pack_file()
 
510
 
        transport = self.get_transport()
 
511
 
        # Note that the 'filename' has been changed to 'different-packname'
 
512
 
        access = _DirectPackAccess({'foo':(transport, 'different-packname')})
 
513
 
        e = self.assertListRaises(errors.NoSuchFile,
 
514
 
                                  access.get_raw_records, memos)
 
516
 
    def test_failing_readv_raises_retry(self):
 
517
 
        memos = self.make_pack_file()
 
518
 
        transport = self.get_transport()
 
519
 
        failing_transport = MockReadvFailingTransport(
 
520
 
                                [transport.get_bytes('packname')])
 
521
 
        reload_called, reload_func = self.make_reload_func()
 
522
 
        access = _DirectPackAccess({'foo':(failing_transport, 'packname')},
 
523
 
                                   reload_func=reload_func)
 
524
 
        # Asking for a single record will not trigger the Mock failure
 
525
 
        self.assertEqual(['1234567890'],
 
526
 
            list(access.get_raw_records(memos[:1])))
 
527
 
        self.assertEqual(['12345'],
 
528
 
            list(access.get_raw_records(memos[1:2])))
 
529
 
        # A multiple offset readv() will fail mid-way through
 
530
 
        e = self.assertListRaises(errors.RetryWithNewPacks,
 
531
 
                                  access.get_raw_records, memos)
 
532
 
        # The file has gone missing, so we assume we need to reload
 
533
 
        self.assertFalse(e.reload_occurred)
 
534
 
        self.assertIsInstance(e.exc_info, tuple)
 
535
 
        self.assertIs(e.exc_info[0], errors.NoSuchFile)
 
536
 
        self.assertIsInstance(e.exc_info[1], errors.NoSuchFile)
 
537
 
        self.assertEqual('packname', e.exc_info[1].path)
 
539
 
    def test_failing_readv_raises_no_such_file_with_no_reload(self):
 
540
 
        memos = self.make_pack_file()
 
541
 
        transport = self.get_transport()
 
542
 
        failing_transport = MockReadvFailingTransport(
 
543
 
                                [transport.get_bytes('packname')])
 
544
 
        reload_called, reload_func = self.make_reload_func()
 
545
 
        access = _DirectPackAccess({'foo':(failing_transport, 'packname')})
 
546
 
        # Asking for a single record will not trigger the Mock failure
 
547
 
        self.assertEqual(['1234567890'],
 
548
 
            list(access.get_raw_records(memos[:1])))
 
549
 
        self.assertEqual(['12345'],
 
550
 
            list(access.get_raw_records(memos[1:2])))
 
551
 
        # A multiple offset readv() will fail mid-way through
 
552
 
        e = self.assertListRaises(errors.NoSuchFile,
 
553
 
                                  access.get_raw_records, memos)
 
555
 
    def test_reload_or_raise_no_reload(self):
 
556
 
        access = _DirectPackAccess({}, reload_func=None)
 
557
 
        retry_exc = self.make_retry_exception()
 
558
 
        # Without a reload_func, we will just re-raise the original exception
 
559
 
        self.assertRaises(_TestException, access.reload_or_raise, retry_exc)
 
561
 
    def test_reload_or_raise_reload_changed(self):
 
562
 
        reload_called, reload_func = self.make_reload_func(return_val=True)
 
563
 
        access = _DirectPackAccess({}, reload_func=reload_func)
 
564
 
        retry_exc = self.make_retry_exception()
 
565
 
        access.reload_or_raise(retry_exc)
 
566
 
        self.assertEqual([1], reload_called)
 
567
 
        retry_exc.reload_occurred=True
 
568
 
        access.reload_or_raise(retry_exc)
 
569
 
        self.assertEqual([2], reload_called)
 
571
 
    def test_reload_or_raise_reload_no_change(self):
 
572
 
        reload_called, reload_func = self.make_reload_func(return_val=False)
 
573
 
        access = _DirectPackAccess({}, reload_func=reload_func)
 
574
 
        retry_exc = self.make_retry_exception()
 
575
 
        # If reload_occurred is False, then we consider it an error to have
 
576
 
        # reload_func() return False (no changes).
 
577
 
        self.assertRaises(_TestException, access.reload_or_raise, retry_exc)
 
578
 
        self.assertEqual([1], reload_called)
 
579
 
        retry_exc.reload_occurred=True
 
580
 
        # If reload_occurred is True, then we assume nothing changed because
 
581
 
        # it had changed earlier, but didn't change again
 
582
 
        access.reload_or_raise(retry_exc)
 
583
 
        self.assertEqual([2], reload_called)
 
585
 
    def test_annotate_retries(self):
 
586
 
        vf, reload_counter = self.make_vf_for_retrying()
 
587
 
        # It is a little bit bogus to annotate the Revision VF, but it works,
 
588
 
        # as we have ancestry stored there
 
590
 
        reload_lines = vf.annotate(key)
 
591
 
        self.assertEqual([1, 1, 0], reload_counter)
 
592
 
        plain_lines = vf.annotate(key)
 
593
 
        self.assertEqual([1, 1, 0], reload_counter) # No extra reloading
 
594
 
        if reload_lines != plain_lines:
 
595
 
            self.fail('Annotation was not identical with reloading.')
 
596
 
        # Now delete the packs-in-use, which should trigger another reload, but
 
597
 
        # this time we just raise an exception because we can't recover
 
598
 
        for trans, name in vf._access._indices.itervalues():
 
600
 
        self.assertRaises(errors.NoSuchFile, vf.annotate, key)
 
601
 
        self.assertEqual([2, 1, 1], reload_counter)
 
603
 
    def test__get_record_map_retries(self):
 
604
 
        vf, reload_counter = self.make_vf_for_retrying()
 
605
 
        keys = [('rev-1',), ('rev-2',), ('rev-3',)]
 
606
 
        records = vf._get_record_map(keys)
 
607
 
        self.assertEqual(keys, sorted(records.keys()))
 
608
 
        self.assertEqual([1, 1, 0], reload_counter)
 
609
 
        # Now delete the packs-in-use, which should trigger another reload, but
 
610
 
        # this time we just raise an exception because we can't recover
 
611
 
        for trans, name in vf._access._indices.itervalues():
 
613
 
        self.assertRaises(errors.NoSuchFile, vf._get_record_map, keys)
 
614
 
        self.assertEqual([2, 1, 1], reload_counter)
 
616
 
    def test_get_record_stream_retries(self):
 
617
 
        vf, reload_counter = self.make_vf_for_retrying()
 
618
 
        keys = [('rev-1',), ('rev-2',), ('rev-3',)]
 
619
 
        record_stream = vf.get_record_stream(keys, 'topological', False)
 
620
 
        record = record_stream.next()
 
621
 
        self.assertEqual(('rev-1',), record.key)
 
622
 
        self.assertEqual([0, 0, 0], reload_counter)
 
623
 
        record = record_stream.next()
 
624
 
        self.assertEqual(('rev-2',), record.key)
 
625
 
        self.assertEqual([1, 1, 0], reload_counter)
 
626
 
        record = record_stream.next()
 
627
 
        self.assertEqual(('rev-3',), record.key)
 
628
 
        self.assertEqual([1, 1, 0], reload_counter)
 
629
 
        # Now delete all pack files, and see that we raise the right error
 
630
 
        for trans, name in vf._access._indices.itervalues():
 
632
 
        self.assertListRaises(errors.NoSuchFile,
 
633
 
            vf.get_record_stream, keys, 'topological', False)
 
635
 
    def test_iter_lines_added_or_present_in_keys_retries(self):
 
636
 
        vf, reload_counter = self.make_vf_for_retrying()
 
637
 
        keys = [('rev-1',), ('rev-2',), ('rev-3',)]
 
638
 
        # Unfortunately, iter_lines_added_or_present_in_keys iterates the
 
639
 
        # result in random order (determined by the iteration order from a
 
640
 
        # set()), so we don't have any solid way to trigger whether data is
 
641
 
        # read before or after. However we tried to delete the middle node to
 
642
 
        # exercise the code well.
 
643
 
        # What we care about is that all lines are always yielded, but not
 
646
 
        reload_lines = sorted(vf.iter_lines_added_or_present_in_keys(keys))
 
647
 
        self.assertEqual([1, 1, 0], reload_counter)
 
648
 
        # Now do it again, to make sure the result is equivalent
 
649
 
        plain_lines = sorted(vf.iter_lines_added_or_present_in_keys(keys))
 
650
 
        self.assertEqual([1, 1, 0], reload_counter) # No extra reloading
 
651
 
        self.assertEqual(plain_lines, reload_lines)
 
652
 
        self.assertEqual(21, len(plain_lines))
 
653
 
        # Now delete all pack files, and see that we raise the right error
 
654
 
        for trans, name in vf._access._indices.itervalues():
 
656
 
        self.assertListRaises(errors.NoSuchFile,
 
657
 
            vf.iter_lines_added_or_present_in_keys, keys)
 
658
 
        self.assertEqual([2, 1, 1], reload_counter)
 
660
 
    def test_get_record_stream_yields_disk_sorted_order(self):
 
661
 
        # if we get 'unordered' pick a semi-optimal order for reading. The
 
662
 
        # order should be grouped by pack file, and then by position in file
 
663
 
        repo = self.make_repository('test', format='pack-0.92')
 
665
 
        self.addCleanup(repo.unlock)
 
666
 
        repo.start_write_group()
 
668
 
        vf.add_lines(('f-id', 'rev-5'), [('f-id', 'rev-4')], ['lines\n'])
 
669
 
        vf.add_lines(('f-id', 'rev-1'), [], ['lines\n'])
 
670
 
        vf.add_lines(('f-id', 'rev-2'), [('f-id', 'rev-1')], ['lines\n'])
 
671
 
        repo.commit_write_group()
 
672
 
        # We inserted them as rev-5, rev-1, rev-2, we should get them back in
 
674
 
        stream = vf.get_record_stream([('f-id', 'rev-1'), ('f-id', 'rev-5'),
 
675
 
                                       ('f-id', 'rev-2')], 'unordered', False)
 
676
 
        keys = [r.key for r in stream]
 
677
 
        self.assertEqual([('f-id', 'rev-5'), ('f-id', 'rev-1'),
 
678
 
                          ('f-id', 'rev-2')], keys)
 
679
 
        repo.start_write_group()
 
680
 
        vf.add_lines(('f-id', 'rev-4'), [('f-id', 'rev-3')], ['lines\n'])
 
681
 
        vf.add_lines(('f-id', 'rev-3'), [('f-id', 'rev-2')], ['lines\n'])
 
682
 
        vf.add_lines(('f-id', 'rev-6'), [('f-id', 'rev-5')], ['lines\n'])
 
683
 
        repo.commit_write_group()
 
684
 
        # Request in random order, to make sure the output order isn't based on
 
686
 
        request_keys = set(('f-id', 'rev-%d' % i) for i in range(1, 7))
 
687
 
        stream = vf.get_record_stream(request_keys, 'unordered', False)
 
688
 
        keys = [r.key for r in stream]
 
689
 
        # We want to get the keys back in disk order, but it doesn't matter
 
690
 
        # which pack we read from first. So this can come back in 2 orders
 
691
 
        alt1 = [('f-id', 'rev-%d' % i) for i in [4, 3, 6, 5, 1, 2]]
 
692
 
        alt2 = [('f-id', 'rev-%d' % i) for i in [5, 1, 2, 4, 3, 6]]
 
693
 
        if keys != alt1 and keys != alt2:
 
694
 
            self.fail('Returned key order did not match either expected order.'
 
695
 
                      ' expected %s or %s, not %s'
 
696
 
                      % (alt1, alt2, keys))
 
699
 
class LowLevelKnitDataTests(TestCase):
 
701
 
    def create_gz_content(self, text):
 
703
 
        gz_file = gzip.GzipFile(mode='wb', fileobj=sio)
 
706
 
        return sio.getvalue()
 
708
 
    def make_multiple_records(self):
 
709
 
        """Create the content for multiple records."""
 
710
 
        sha1sum = osutils.sha('foo\nbar\n').hexdigest()
 
712
 
        gz_txt = self.create_gz_content('version rev-id-1 2 %s\n'
 
717
 
        record_1 = (0, len(gz_txt), sha1sum)
 
718
 
        total_txt.append(gz_txt)
 
719
 
        sha1sum = osutils.sha('baz\n').hexdigest()
 
720
 
        gz_txt = self.create_gz_content('version rev-id-2 1 %s\n'
 
724
 
        record_2 = (record_1[1], len(gz_txt), sha1sum)
 
725
 
        total_txt.append(gz_txt)
 
726
 
        return total_txt, record_1, record_2
 
728
 
    def test_valid_knit_data(self):
 
729
 
        sha1sum = osutils.sha('foo\nbar\n').hexdigest()
 
730
 
        gz_txt = self.create_gz_content('version rev-id-1 2 %s\n'
 
735
 
        transport = MockTransport([gz_txt])
 
736
 
        access = _KnitKeyAccess(transport, ConstantMapper('filename'))
 
737
 
        knit = KnitVersionedFiles(None, access)
 
738
 
        records = [(('rev-id-1',), (('rev-id-1',), 0, len(gz_txt)))]
 
740
 
        contents = list(knit._read_records_iter(records))
 
741
 
        self.assertEqual([(('rev-id-1',), ['foo\n', 'bar\n'],
 
742
 
            '4e48e2c9a3d2ca8a708cb0cc545700544efb5021')], contents)
 
744
 
        raw_contents = list(knit._read_records_iter_raw(records))
 
745
 
        self.assertEqual([(('rev-id-1',), gz_txt, sha1sum)], raw_contents)
 
747
 
    def test_multiple_records_valid(self):
 
748
 
        total_txt, record_1, record_2 = self.make_multiple_records()
 
749
 
        transport = MockTransport([''.join(total_txt)])
 
750
 
        access = _KnitKeyAccess(transport, ConstantMapper('filename'))
 
751
 
        knit = KnitVersionedFiles(None, access)
 
752
 
        records = [(('rev-id-1',), (('rev-id-1',), record_1[0], record_1[1])),
 
753
 
                   (('rev-id-2',), (('rev-id-2',), record_2[0], record_2[1]))]
 
755
 
        contents = list(knit._read_records_iter(records))
 
756
 
        self.assertEqual([(('rev-id-1',), ['foo\n', 'bar\n'], record_1[2]),
 
757
 
                          (('rev-id-2',), ['baz\n'], record_2[2])],
 
760
 
        raw_contents = list(knit._read_records_iter_raw(records))
 
761
 
        self.assertEqual([(('rev-id-1',), total_txt[0], record_1[2]),
 
762
 
                          (('rev-id-2',), total_txt[1], record_2[2])],
 
765
 
    def test_not_enough_lines(self):
 
766
 
        sha1sum = osutils.sha('foo\n').hexdigest()
 
767
 
        # record says 2 lines data says 1
 
768
 
        gz_txt = self.create_gz_content('version rev-id-1 2 %s\n'
 
772
 
        transport = MockTransport([gz_txt])
 
773
 
        access = _KnitKeyAccess(transport, ConstantMapper('filename'))
 
774
 
        knit = KnitVersionedFiles(None, access)
 
775
 
        records = [(('rev-id-1',), (('rev-id-1',), 0, len(gz_txt)))]
 
776
 
        self.assertRaises(errors.KnitCorrupt, list,
 
777
 
            knit._read_records_iter(records))
 
779
 
        # read_records_iter_raw won't detect that sort of mismatch/corruption
 
780
 
        raw_contents = list(knit._read_records_iter_raw(records))
 
781
 
        self.assertEqual([(('rev-id-1',),  gz_txt, sha1sum)], raw_contents)
 
783
 
    def test_too_many_lines(self):
 
784
 
        sha1sum = osutils.sha('foo\nbar\n').hexdigest()
 
785
 
        # record says 1 lines data says 2
 
786
 
        gz_txt = self.create_gz_content('version rev-id-1 1 %s\n'
 
791
 
        transport = MockTransport([gz_txt])
 
792
 
        access = _KnitKeyAccess(transport, ConstantMapper('filename'))
 
793
 
        knit = KnitVersionedFiles(None, access)
 
794
 
        records = [(('rev-id-1',), (('rev-id-1',), 0, len(gz_txt)))]
 
795
 
        self.assertRaises(errors.KnitCorrupt, list,
 
796
 
            knit._read_records_iter(records))
 
798
 
        # read_records_iter_raw won't detect that sort of mismatch/corruption
 
799
 
        raw_contents = list(knit._read_records_iter_raw(records))
 
800
 
        self.assertEqual([(('rev-id-1',), gz_txt, sha1sum)], raw_contents)
 
802
 
    def test_mismatched_version_id(self):
 
803
 
        sha1sum = osutils.sha('foo\nbar\n').hexdigest()
 
804
 
        gz_txt = self.create_gz_content('version rev-id-1 2 %s\n'
 
809
 
        transport = MockTransport([gz_txt])
 
810
 
        access = _KnitKeyAccess(transport, ConstantMapper('filename'))
 
811
 
        knit = KnitVersionedFiles(None, access)
 
812
 
        # We are asking for rev-id-2, but the data is rev-id-1
 
813
 
        records = [(('rev-id-2',), (('rev-id-2',), 0, len(gz_txt)))]
 
814
 
        self.assertRaises(errors.KnitCorrupt, list,
 
815
 
            knit._read_records_iter(records))
 
817
 
        # read_records_iter_raw detects mismatches in the header
 
818
 
        self.assertRaises(errors.KnitCorrupt, list,
 
819
 
            knit._read_records_iter_raw(records))
 
821
 
    def test_uncompressed_data(self):
 
822
 
        sha1sum = osutils.sha('foo\nbar\n').hexdigest()
 
823
 
        txt = ('version rev-id-1 2 %s\n'
 
828
 
        transport = MockTransport([txt])
 
829
 
        access = _KnitKeyAccess(transport, ConstantMapper('filename'))
 
830
 
        knit = KnitVersionedFiles(None, access)
 
831
 
        records = [(('rev-id-1',), (('rev-id-1',), 0, len(txt)))]
 
833
 
        # We don't have valid gzip data ==> corrupt
 
834
 
        self.assertRaises(errors.KnitCorrupt, list,
 
835
 
            knit._read_records_iter(records))
 
837
 
        # read_records_iter_raw will notice the bad data
 
838
 
        self.assertRaises(errors.KnitCorrupt, list,
 
839
 
            knit._read_records_iter_raw(records))
 
841
 
    def test_corrupted_data(self):
 
842
 
        sha1sum = osutils.sha('foo\nbar\n').hexdigest()
 
843
 
        gz_txt = self.create_gz_content('version rev-id-1 2 %s\n'
 
848
 
        # Change 2 bytes in the middle to \xff
 
849
 
        gz_txt = gz_txt[:10] + '\xff\xff' + gz_txt[12:]
 
850
 
        transport = MockTransport([gz_txt])
 
851
 
        access = _KnitKeyAccess(transport, ConstantMapper('filename'))
 
852
 
        knit = KnitVersionedFiles(None, access)
 
853
 
        records = [(('rev-id-1',), (('rev-id-1',), 0, len(gz_txt)))]
 
854
 
        self.assertRaises(errors.KnitCorrupt, list,
 
855
 
            knit._read_records_iter(records))
 
856
 
        # read_records_iter_raw will barf on bad gz data
 
857
 
        self.assertRaises(errors.KnitCorrupt, list,
 
858
 
            knit._read_records_iter_raw(records))
 
861
118
class LowLevelKnitIndexTests(TestCase):
 
863
 
    def get_knit_index(self, transport, name, mode):
 
864
 
        mapper = ConstantMapper(name)
 
865
 
        from bzrlib._knit_load_data_py import _load_data_py
 
866
 
        self.overrideAttr(knit, '_load_data', _load_data_py)
 
867
 
        allow_writes = lambda: 'w' in mode
 
868
 
        return _KndxIndex(transport, mapper, lambda:None, allow_writes, lambda:True)
 
 
120
    def test_no_such_file(self):
 
 
121
        transport = MockTransport()
 
 
123
        self.assertRaises(NoSuchFile, _KnitIndex, transport, "filename", "r")
 
 
124
        self.assertRaises(NoSuchFile, _KnitIndex, transport,
 
 
125
            "filename", "w", create=False)
 
870
127
    def test_create_file(self):
 
871
128
        transport = MockTransport()
 
872
 
        index = self.get_knit_index(transport, "filename", "w")
 
874
 
        call = transport.calls.pop(0)
 
875
 
        # call[1][1] is a StringIO - we can't test it by simple equality.
 
876
 
        self.assertEqual('put_file_non_atomic', call[0])
 
877
 
        self.assertEqual('filename.kndx', call[1][0])
 
878
 
        # With no history, _KndxIndex writes a new index:
 
879
 
        self.assertEqual(_KndxIndex.HEADER,
 
880
 
            call[1][1].getvalue())
 
881
 
        self.assertEqual({'create_parent_dir': True}, call[2])
 
 
130
        index = _KnitIndex(transport, "filename", "w",
 
 
131
            file_mode="wb", create=True)
 
 
133
                ("put_bytes_non_atomic",
 
 
134
                    ("filename", index.HEADER), {"mode": "wb"}),
 
 
135
                transport.calls.pop(0))
 
 
137
    def test_delay_create_file(self):
 
 
138
        transport = MockTransport()
 
 
140
        index = _KnitIndex(transport, "filename", "w",
 
 
141
            create=True, file_mode="wb", create_parent_dir=True,
 
 
142
            delay_create=True, dir_mode=0777)
 
 
143
        self.assertEqual([], transport.calls)
 
 
145
        index.add_versions([])
 
 
146
        name, (filename, f), kwargs = transport.calls.pop(0)
 
 
147
        self.assertEqual("put_file_non_atomic", name)
 
 
149
            {"dir_mode": 0777, "create_parent_dir": True, "mode": "wb"},
 
 
151
        self.assertEqual("filename", filename)
 
 
152
        self.assertEqual(index.HEADER, f.read())
 
 
154
        index.add_versions([])
 
 
155
        self.assertEqual(("append_bytes", ("filename", ""), {}),
 
 
156
            transport.calls.pop(0))
 
883
158
    def test_read_utf8_version_id(self):
 
884
 
        unicode_revision_id = u"version-\N{CYRILLIC CAPITAL LETTER A}"
 
885
 
        utf8_revision_id = unicode_revision_id.encode('utf-8')
 
886
159
        transport = MockTransport([
 
888
 
            '%s option 0 1 :' % (utf8_revision_id,)
 
 
161
            u"version-\N{CYRILLIC CAPITAL LETTER A}"
 
 
162
                u" option 0 1 :".encode("utf-8")
 
890
 
        index = self.get_knit_index(transport, "filename", "r")
 
891
 
        # _KndxIndex is a private class, and deals in utf8 revision_ids, not
 
892
 
        # Unicode revision_ids.
 
893
 
        self.assertEqual({(utf8_revision_id,):()},
 
894
 
            index.get_parent_map(index.keys()))
 
895
 
        self.assertFalse((unicode_revision_id,) in index.keys())
 
 
164
        index = _KnitIndex(transport, "filename", "r")
 
 
166
            index.has_version(u"version-\N{CYRILLIC CAPITAL LETTER A}"))
 
897
168
    def test_read_utf8_parents(self):
 
898
 
        unicode_revision_id = u"version-\N{CYRILLIC CAPITAL LETTER A}"
 
899
 
        utf8_revision_id = unicode_revision_id.encode('utf-8')
 
900
169
        transport = MockTransport([
 
902
 
            "version option 0 1 .%s :" % (utf8_revision_id,)
 
 
171
            u"version option 0 1"
 
 
172
                u" .version-\N{CYRILLIC CAPITAL LETTER A} :".encode("utf-8")
 
904
 
        index = self.get_knit_index(transport, "filename", "r")
 
905
 
        self.assertEqual({("version",):((utf8_revision_id,),)},
 
906
 
            index.get_parent_map(index.keys()))
 
 
174
        index = _KnitIndex(transport, "filename", "r")
 
 
175
        self.assertEqual([u"version-\N{CYRILLIC CAPITAL LETTER A}"],
 
 
176
            index.get_parents_with_ghosts("version"))
 
908
178
    def test_read_ignore_corrupted_lines(self):
 
909
179
        transport = MockTransport([
 
912
182
            "corrupted options 0 1 .b .c ",
 
913
183
            "version options 0 1 :"
 
915
 
        index = self.get_knit_index(transport, "filename", "r")
 
916
 
        self.assertEqual(1, len(index.keys()))
 
917
 
        self.assertEqual(set([("version",)]), index.keys())
 
 
185
        index = _KnitIndex(transport, "filename", "r")
 
 
186
        self.assertEqual(1, index.num_versions())
 
 
187
        self.assertTrue(index.has_version(u"version"))
 
919
189
    def test_read_corrupted_header(self):
 
920
190
        transport = MockTransport(['not a bzr knit index header\n'])
 
921
 
        index = self.get_knit_index(transport, "filename", "r")
 
922
 
        self.assertRaises(KnitHeaderError, index.keys)
 
 
191
        self.assertRaises(KnitHeaderError,
 
 
192
            _KnitIndex, transport, "filename", "r")
 
924
194
    def test_read_duplicate_entries(self):
 
925
195
        transport = MockTransport([
 
927
197
            "parent options 0 1 :",
 
928
198
            "version options1 0 1 0 :",
 
929
199
            "version options2 1 2 .other :",
 
930
200
            "version options3 3 4 0 .other :"
 
932
 
        index = self.get_knit_index(transport, "filename", "r")
 
933
 
        self.assertEqual(2, len(index.keys()))
 
934
 
        # check that the index used is the first one written. (Specific
 
935
 
        # to KnitIndex style indices.
 
936
 
        self.assertEqual("1", index._dictionary_compress([("version",)]))
 
937
 
        self.assertEqual((("version",), 3, 4), index.get_position(("version",)))
 
938
 
        self.assertEqual(["options3"], index.get_options(("version",)))
 
939
 
        self.assertEqual({("version",):(("parent",), ("other",))},
 
940
 
            index.get_parent_map([("version",)]))
 
 
202
        index = _KnitIndex(transport, "filename", "r")
 
 
203
        self.assertEqual(2, index.num_versions())
 
 
204
        self.assertEqual(1, index.lookup(u"version"))
 
 
205
        self.assertEqual((3, 4), index.get_position(u"version"))
 
 
206
        self.assertEqual(["options3"], index.get_options(u"version"))
 
 
207
        self.assertEqual([u"parent", u"other"],
 
 
208
            index.get_parents_with_ghosts(u"version"))
 
942
210
    def test_read_compressed_parents(self):
 
943
211
        transport = MockTransport([
 
945
213
            "a option 0 1 :",
 
946
214
            "b option 0 1 0 :",
 
947
215
            "c option 0 1 1 0 :",
 
949
 
        index = self.get_knit_index(transport, "filename", "r")
 
950
 
        self.assertEqual({("b",):(("a",),), ("c",):(("b",), ("a",))},
 
951
 
            index.get_parent_map([("b",), ("c",)]))
 
 
217
        index = _KnitIndex(transport, "filename", "r")
 
 
218
        self.assertEqual([u"a"], index.get_parents(u"b"))
 
 
219
        self.assertEqual([u"b", u"a"], index.get_parents(u"c"))
 
953
221
    def test_write_utf8_version_id(self):
 
954
 
        unicode_revision_id = u"version-\N{CYRILLIC CAPITAL LETTER A}"
 
955
 
        utf8_revision_id = unicode_revision_id.encode('utf-8')
 
956
222
        transport = MockTransport([
 
959
 
        index = self.get_knit_index(transport, "filename", "r")
 
961
 
            ((utf8_revision_id,), ["option"], ((utf8_revision_id,), 0, 1), [])])
 
962
 
        call = transport.calls.pop(0)
 
963
 
        # call[1][1] is a StringIO - we can't test it by simple equality.
 
964
 
        self.assertEqual('put_file_non_atomic', call[0])
 
965
 
        self.assertEqual('filename.kndx', call[1][0])
 
966
 
        # With no history, _KndxIndex writes a new index:
 
967
 
        self.assertEqual(_KndxIndex.HEADER +
 
968
 
            "\n%s option 0 1  :" % (utf8_revision_id,),
 
969
 
            call[1][1].getvalue())
 
970
 
        self.assertEqual({'create_parent_dir': True}, call[2])
 
 
225
        index = _KnitIndex(transport, "filename", "r")
 
 
226
        index.add_version(u"version-\N{CYRILLIC CAPITAL LETTER A}",
 
 
227
            ["option"], 0, 1, [])
 
 
228
        self.assertEqual(("append_bytes", ("filename",
 
 
229
            u"\nversion-\N{CYRILLIC CAPITAL LETTER A}"
 
 
230
                u" option 0 1  :".encode("utf-8")),
 
 
232
            transport.calls.pop(0))
 
972
234
    def test_write_utf8_parents(self):
 
973
 
        unicode_revision_id = u"version-\N{CYRILLIC CAPITAL LETTER A}"
 
974
 
        utf8_revision_id = unicode_revision_id.encode('utf-8')
 
975
 
        transport = MockTransport([
 
978
 
        index = self.get_knit_index(transport, "filename", "r")
 
980
 
            (("version",), ["option"], (("version",), 0, 1), [(utf8_revision_id,)])])
 
981
 
        call = transport.calls.pop(0)
 
982
 
        # call[1][1] is a StringIO - we can't test it by simple equality.
 
983
 
        self.assertEqual('put_file_non_atomic', call[0])
 
984
 
        self.assertEqual('filename.kndx', call[1][0])
 
985
 
        # With no history, _KndxIndex writes a new index:
 
986
 
        self.assertEqual(_KndxIndex.HEADER +
 
987
 
            "\nversion option 0 1 .%s :" % (utf8_revision_id,),
 
988
 
            call[1][1].getvalue())
 
989
 
        self.assertEqual({'create_parent_dir': True}, call[2])
 
992
 
        transport = MockTransport([
 
995
 
        index = self.get_knit_index(transport, "filename", "r")
 
997
 
        self.assertEqual(set(), index.keys())
 
999
 
        index.add_records([(("a",), ["option"], (("a",), 0, 1), [])])
 
1000
 
        self.assertEqual(set([("a",)]), index.keys())
 
1002
 
        index.add_records([(("a",), ["option"], (("a",), 0, 1), [])])
 
1003
 
        self.assertEqual(set([("a",)]), index.keys())
 
1005
 
        index.add_records([(("b",), ["option"], (("b",), 0, 1), [])])
 
1006
 
        self.assertEqual(set([("a",), ("b",)]), index.keys())
 
1008
 
    def add_a_b(self, index, random_id=None):
 
1010
 
        if random_id is not None:
 
1011
 
            kwargs["random_id"] = random_id
 
1013
 
            (("a",), ["option"], (("a",), 0, 1), [("b",)]),
 
1014
 
            (("a",), ["opt"], (("a",), 1, 2), [("c",)]),
 
1015
 
            (("b",), ["option"], (("b",), 2, 3), [("a",)])
 
1018
 
    def assertIndexIsAB(self, index):
 
1023
 
            index.get_parent_map(index.keys()))
 
1024
 
        self.assertEqual((("a",), 1, 2), index.get_position(("a",)))
 
1025
 
        self.assertEqual((("b",), 2, 3), index.get_position(("b",)))
 
1026
 
        self.assertEqual(["opt"], index.get_options(("a",)))
 
 
235
        transport = MockTransport([
 
 
238
        index = _KnitIndex(transport, "filename", "r")
 
 
239
        index.add_version(u"version", ["option"], 0, 1,
 
 
240
            [u"version-\N{CYRILLIC CAPITAL LETTER A}"])
 
 
241
        self.assertEqual(("append_bytes", ("filename",
 
 
242
            u"\nversion option 0 1"
 
 
243
                u" .version-\N{CYRILLIC CAPITAL LETTER A} :".encode("utf-8")),
 
 
245
            transport.calls.pop(0))
 
 
247
    def test_get_graph(self):
 
 
248
        transport = MockTransport()
 
 
249
        index = _KnitIndex(transport, "filename", "w", create=True)
 
 
250
        self.assertEqual([], index.get_graph())
 
 
252
        index.add_version(u"a", ["option"], 0, 1, [u"b"])
 
 
253
        self.assertEqual([(u"a", [u"b"])], index.get_graph())
 
 
255
        index.add_version(u"c", ["option"], 0, 1, [u"d"])
 
 
256
        self.assertEqual([(u"a", [u"b"]), (u"c", [u"d"])],
 
 
257
            sorted(index.get_graph()))
 
 
259
    def test_get_ancestry(self):
 
 
260
        transport = MockTransport([
 
 
263
            "b option 0 1 0 .e :",
 
 
264
            "c option 0 1 1 0 :",
 
 
265
            "d option 0 1 2 .f :"
 
 
267
        index = _KnitIndex(transport, "filename", "r")
 
 
269
        self.assertEqual([], index.get_ancestry([]))
 
 
270
        self.assertEqual([u"a"], index.get_ancestry([u"a"]))
 
 
271
        self.assertEqual([u"a", u"b"], index.get_ancestry([u"b"]))
 
 
272
        self.assertEqual([u"a", u"b", u"c"], index.get_ancestry([u"c"]))
 
 
273
        self.assertEqual([u"a", u"b", u"c", u"d"], index.get_ancestry([u"d"]))
 
 
274
        self.assertEqual([u"a", u"b"], index.get_ancestry([u"a", u"b"]))
 
 
275
        self.assertEqual([u"a", u"b", u"c"], index.get_ancestry([u"a", u"c"]))
 
 
277
        self.assertRaises(RevisionNotPresent, index.get_ancestry, [u"e"])
 
 
279
    def test_get_ancestry_with_ghosts(self):
 
 
280
        transport = MockTransport([
 
 
283
            "b option 0 1 0 .e :",
 
 
284
            "c option 0 1 0 .f .g :",
 
 
285
            "d option 0 1 2 .h .j .k :"
 
 
287
        index = _KnitIndex(transport, "filename", "r")
 
 
289
        self.assertEqual([], index.get_ancestry_with_ghosts([]))
 
 
290
        self.assertEqual([u"a"], index.get_ancestry_with_ghosts([u"a"]))
 
 
291
        self.assertEqual([u"a", u"e", u"b"],
 
 
292
            index.get_ancestry_with_ghosts([u"b"]))
 
 
293
        self.assertEqual([u"a", u"g", u"f", u"c"],
 
 
294
            index.get_ancestry_with_ghosts([u"c"]))
 
 
295
        self.assertEqual([u"a", u"g", u"f", u"c", u"k", u"j", u"h", u"d"],
 
 
296
            index.get_ancestry_with_ghosts([u"d"]))
 
 
297
        self.assertEqual([u"a", u"e", u"b"],
 
 
298
            index.get_ancestry_with_ghosts([u"a", u"b"]))
 
 
299
        self.assertEqual([u"a", u"g", u"f", u"c"],
 
 
300
            index.get_ancestry_with_ghosts([u"a", u"c"]))
 
 
302
            [u"a", u"g", u"f", u"c", u"e", u"b", u"k", u"j", u"h", u"d"],
 
 
303
            index.get_ancestry_with_ghosts([u"b", u"d"]))
 
 
305
        self.assertRaises(RevisionNotPresent,
 
 
306
            index.get_ancestry_with_ghosts, [u"e"])
 
 
308
    def test_num_versions(self):
 
 
309
        transport = MockTransport([
 
 
312
        index = _KnitIndex(transport, "filename", "r")
 
 
314
        self.assertEqual(0, index.num_versions())
 
 
315
        self.assertEqual(0, len(index))
 
 
317
        index.add_version(u"a", ["option"], 0, 1, [])
 
 
318
        self.assertEqual(1, index.num_versions())
 
 
319
        self.assertEqual(1, len(index))
 
 
321
        index.add_version(u"a", ["option2"], 1, 2, [])
 
 
322
        self.assertEqual(1, index.num_versions())
 
 
323
        self.assertEqual(1, len(index))
 
 
325
        index.add_version(u"b", ["option"], 0, 1, [])
 
 
326
        self.assertEqual(2, index.num_versions())
 
 
327
        self.assertEqual(2, len(index))
 
 
329
    def test_get_versions(self):
 
 
330
        transport = MockTransport([
 
 
333
        index = _KnitIndex(transport, "filename", "r")
 
 
335
        self.assertEqual([], index.get_versions())
 
 
337
        index.add_version(u"a", ["option"], 0, 1, [])
 
 
338
        self.assertEqual([u"a"], index.get_versions())
 
 
340
        index.add_version(u"a", ["option"], 0, 1, [])
 
 
341
        self.assertEqual([u"a"], index.get_versions())
 
 
343
        index.add_version(u"b", ["option"], 0, 1, [])
 
 
344
        self.assertEqual([u"a", u"b"], index.get_versions())
 
 
346
    def test_idx_to_name(self):
 
 
347
        transport = MockTransport([
 
 
352
        index = _KnitIndex(transport, "filename", "r")
 
 
354
        self.assertEqual(u"a", index.idx_to_name(0))
 
 
355
        self.assertEqual(u"b", index.idx_to_name(1))
 
 
356
        self.assertEqual(u"b", index.idx_to_name(-1))
 
 
357
        self.assertEqual(u"a", index.idx_to_name(-2))
 
 
359
    def test_lookup(self):
 
 
360
        transport = MockTransport([
 
 
365
        index = _KnitIndex(transport, "filename", "r")
 
 
367
        self.assertEqual(0, index.lookup(u"a"))
 
 
368
        self.assertEqual(1, index.lookup(u"b"))
 
 
370
    def test_add_version(self):
 
 
371
        transport = MockTransport([
 
 
374
        index = _KnitIndex(transport, "filename", "r")
 
 
376
        index.add_version(u"a", ["option"], 0, 1, [u"b"])
 
 
377
        self.assertEqual(("append_bytes",
 
 
378
            ("filename", "\na option 0 1 .b :"),
 
 
379
            {}), transport.calls.pop(0))
 
 
380
        self.assertTrue(index.has_version(u"a"))
 
 
381
        self.assertEqual(1, index.num_versions())
 
 
382
        self.assertEqual((0, 1), index.get_position(u"a"))
 
 
383
        self.assertEqual(["option"], index.get_options(u"a"))
 
 
384
        self.assertEqual([u"b"], index.get_parents_with_ghosts(u"a"))
 
 
386
        index.add_version(u"a", ["opt"], 1, 2, [u"c"])
 
 
387
        self.assertEqual(("append_bytes",
 
 
388
            ("filename", "\na opt 1 2 .c :"),
 
 
389
            {}), transport.calls.pop(0))
 
 
390
        self.assertTrue(index.has_version(u"a"))
 
 
391
        self.assertEqual(1, index.num_versions())
 
 
392
        self.assertEqual((1, 2), index.get_position(u"a"))
 
 
393
        self.assertEqual(["opt"], index.get_options(u"a"))
 
 
394
        self.assertEqual([u"c"], index.get_parents_with_ghosts(u"a"))
 
 
396
        index.add_version(u"b", ["option"], 2, 3, [u"a"])
 
 
397
        self.assertEqual(("append_bytes",
 
 
398
            ("filename", "\nb option 2 3 0 :"),
 
 
399
            {}), transport.calls.pop(0))
 
 
400
        self.assertTrue(index.has_version(u"b"))
 
 
401
        self.assertEqual(2, index.num_versions())
 
 
402
        self.assertEqual((2, 3), index.get_position(u"b"))
 
 
403
        self.assertEqual(["option"], index.get_options(u"b"))
 
 
404
        self.assertEqual([u"a"], index.get_parents_with_ghosts(u"b"))
 
1028
406
    def test_add_versions(self):
 
1029
407
        transport = MockTransport([
 
1032
 
        index = self.get_knit_index(transport, "filename", "r")
 
 
410
        index = _KnitIndex(transport, "filename", "r")
 
1035
 
        call = transport.calls.pop(0)
 
1036
 
        # call[1][1] is a StringIO - we can't test it by simple equality.
 
1037
 
        self.assertEqual('put_file_non_atomic', call[0])
 
1038
 
        self.assertEqual('filename.kndx', call[1][0])
 
1039
 
        # With no history, _KndxIndex writes a new index:
 
 
413
            (u"a", ["option"], 0, 1, [u"b"]),
 
 
414
            (u"a", ["opt"], 1, 2, [u"c"]),
 
 
415
            (u"b", ["option"], 2, 3, [u"a"])
 
 
417
        self.assertEqual(("append_bytes", ("filename",
 
1042
418
            "\na option 0 1 .b :"
 
1043
419
            "\na opt 1 2 .c :"
 
1044
 
            "\nb option 2 3 0 :",
 
1045
 
            call[1][1].getvalue())
 
1046
 
        self.assertEqual({'create_parent_dir': True}, call[2])
 
1047
 
        self.assertIndexIsAB(index)
 
1049
 
    def test_add_versions_random_id_is_accepted(self):
 
1050
 
        transport = MockTransport([
 
1053
 
        index = self.get_knit_index(transport, "filename", "r")
 
1054
 
        self.add_a_b(index, random_id=True)
 
 
421
            ), {}), transport.calls.pop(0))
 
 
422
        self.assertTrue(index.has_version(u"a"))
 
 
423
        self.assertTrue(index.has_version(u"b"))
 
 
424
        self.assertEqual(2, index.num_versions())
 
 
425
        self.assertEqual((1, 2), index.get_position(u"a"))
 
 
426
        self.assertEqual((2, 3), index.get_position(u"b"))
 
 
427
        self.assertEqual(["opt"], index.get_options(u"a"))
 
 
428
        self.assertEqual(["option"], index.get_options(u"b"))
 
 
429
        self.assertEqual([u"c"], index.get_parents_with_ghosts(u"a"))
 
 
430
        self.assertEqual([u"a"], index.get_parents_with_ghosts(u"b"))
 
1056
432
    def test_delay_create_and_add_versions(self):
 
1057
433
        transport = MockTransport()
 
1059
 
        index = self.get_knit_index(transport, "filename", "w")
 
 
435
        index = _KnitIndex(transport, "filename", "w",
 
 
436
            create=True, file_mode="wb", create_parent_dir=True,
 
 
437
            delay_create=True, dir_mode=0777)
 
1061
438
        self.assertEqual([], transport.calls)
 
1064
 
        #[    {"dir_mode": 0777, "create_parent_dir": True, "mode": "wb"},
 
1066
 
        # Two calls: one during which we load the existing index (and when its
 
1067
 
        # missing create it), then a second where we write the contents out.
 
1068
 
        self.assertEqual(2, len(transport.calls))
 
1069
 
        call = transport.calls.pop(0)
 
1070
 
        self.assertEqual('put_file_non_atomic', call[0])
 
1071
 
        self.assertEqual('filename.kndx', call[1][0])
 
1072
 
        # With no history, _KndxIndex writes a new index:
 
1073
 
        self.assertEqual(_KndxIndex.HEADER, call[1][1].getvalue())
 
1074
 
        self.assertEqual({'create_parent_dir': True}, call[2])
 
1075
 
        call = transport.calls.pop(0)
 
1076
 
        # call[1][1] is a StringIO - we can't test it by simple equality.
 
1077
 
        self.assertEqual('put_file_non_atomic', call[0])
 
1078
 
        self.assertEqual('filename.kndx', call[1][0])
 
1079
 
        # With no history, _KndxIndex writes a new index:
 
 
441
            (u"a", ["option"], 0, 1, [u"b"]),
 
 
442
            (u"a", ["opt"], 1, 2, [u"c"]),
 
 
443
            (u"b", ["option"], 2, 3, [u"a"])
 
 
445
        name, (filename, f), kwargs = transport.calls.pop(0)
 
 
446
        self.assertEqual("put_file_non_atomic", name)
 
 
448
            {"dir_mode": 0777, "create_parent_dir": True, "mode": "wb"},
 
 
450
        self.assertEqual("filename", filename)
 
1082
453
            "\na option 0 1 .b :"
 
1083
454
            "\na opt 1 2 .c :"
 
1084
455
            "\nb option 2 3 0 :",
 
1085
 
            call[1][1].getvalue())
 
1086
 
        self.assertEqual({'create_parent_dir': True}, call[2])
 
1088
 
    def assertTotalBuildSize(self, size, keys, positions):
 
1089
 
        self.assertEqual(size,
 
1090
 
                         knit._get_total_build_size(None, keys, positions))
 
1092
 
    def test__get_total_build_size(self):
 
1094
 
            ('a',): (('fulltext', False), (('a',), 0, 100), None),
 
1095
 
            ('b',): (('line-delta', False), (('b',), 100, 21), ('a',)),
 
1096
 
            ('c',): (('line-delta', False), (('c',), 121, 35), ('b',)),
 
1097
 
            ('d',): (('line-delta', False), (('d',), 156, 12), ('b',)),
 
1099
 
        self.assertTotalBuildSize(100, [('a',)], positions)
 
1100
 
        self.assertTotalBuildSize(121, [('b',)], positions)
 
1101
 
        # c needs both a & b
 
1102
 
        self.assertTotalBuildSize(156, [('c',)], positions)
 
1103
 
        # we shouldn't count 'b' twice
 
1104
 
        self.assertTotalBuildSize(156, [('b',), ('c',)], positions)
 
1105
 
        self.assertTotalBuildSize(133, [('d',)], positions)
 
1106
 
        self.assertTotalBuildSize(168, [('c',), ('d',)], positions)
 
 
458
    def test_has_version(self):
 
 
459
        transport = MockTransport([
 
 
463
        index = _KnitIndex(transport, "filename", "r")
 
 
465
        self.assertTrue(index.has_version(u"a"))
 
 
466
        self.assertFalse(index.has_version(u"b"))
 
1108
468
    def test_get_position(self):
 
1109
469
        transport = MockTransport([
 
1111
471
            "a option 0 1 :",
 
1112
472
            "b option 1 2 :"
 
1114
 
        index = self.get_knit_index(transport, "filename", "r")
 
 
474
        index = _KnitIndex(transport, "filename", "r")
 
1116
 
        self.assertEqual((("a",), 0, 1), index.get_position(("a",)))
 
1117
 
        self.assertEqual((("b",), 1, 2), index.get_position(("b",)))
 
 
476
        self.assertEqual((0, 1), index.get_position(u"a"))
 
 
477
        self.assertEqual((1, 2), index.get_position(u"b"))
 
1119
479
    def test_get_method(self):
 
1120
480
        transport = MockTransport([
 
1122
482
            "a fulltext,unknown 0 1 :",
 
1123
483
            "b unknown,line-delta 1 2 :",
 
1126
 
        index = self.get_knit_index(transport, "filename", "r")
 
 
486
        index = _KnitIndex(transport, "filename", "r")
 
1128
 
        self.assertEqual("fulltext", index.get_method("a"))
 
1129
 
        self.assertEqual("line-delta", index.get_method("b"))
 
1130
 
        self.assertRaises(errors.KnitIndexUnknownMethod, index.get_method, "c")
 
 
488
        self.assertEqual("fulltext", index.get_method(u"a"))
 
 
489
        self.assertEqual("line-delta", index.get_method(u"b"))
 
 
490
        self.assertRaises(errors.KnitIndexUnknownMethod, index.get_method, u"c")
 
1132
492
    def test_get_options(self):
 
1133
493
        transport = MockTransport([
 
1136
496
            "b opt2,opt3 1 2 :"
 
1138
 
        index = self.get_knit_index(transport, "filename", "r")
 
1140
 
        self.assertEqual(["opt1"], index.get_options("a"))
 
1141
 
        self.assertEqual(["opt2", "opt3"], index.get_options("b"))
 
1143
 
    def test_get_parent_map(self):
 
1144
 
        transport = MockTransport([
 
1147
 
            "b option 1 2 0 .c :",
 
1148
 
            "c option 1 2 1 0 .e :"
 
1150
 
        index = self.get_knit_index(transport, "filename", "r")
 
1154
 
            ("b",):(("a",), ("c",)),
 
1155
 
            ("c",):(("b",), ("a",), ("e",)),
 
1156
 
            }, index.get_parent_map(index.keys()))
 
1158
 
    def test_impossible_parent(self):
 
1159
 
        """Test we get KnitCorrupt if the parent couldn't possibly exist."""
 
1160
 
        transport = MockTransport([
 
1163
 
            "b option 0 1 4 :"  # We don't have a 4th record
 
1165
 
        index = self.get_knit_index(transport, 'filename', 'r')
 
1167
 
            self.assertRaises(errors.KnitCorrupt, index.keys)
 
1168
 
        except TypeError, e:
 
1169
 
            if (str(e) == ('exceptions must be strings, classes, or instances,'
 
1170
 
                           ' not exceptions.IndexError')
 
1171
 
                and sys.version_info[0:2] >= (2,5)):
 
1172
 
                self.knownFailure('Pyrex <0.9.5 fails with TypeError when'
 
1173
 
                                  ' raising new style exceptions with python'
 
1178
 
    def test_corrupted_parent(self):
 
1179
 
        transport = MockTransport([
 
1183
 
            "c option 0 1 1v :", # Can't have a parent of '1v'
 
1185
 
        index = self.get_knit_index(transport, 'filename', 'r')
 
1187
 
            self.assertRaises(errors.KnitCorrupt, index.keys)
 
1188
 
        except TypeError, e:
 
1189
 
            if (str(e) == ('exceptions must be strings, classes, or instances,'
 
1190
 
                           ' not exceptions.ValueError')
 
1191
 
                and sys.version_info[0:2] >= (2,5)):
 
1192
 
                self.knownFailure('Pyrex <0.9.5 fails with TypeError when'
 
1193
 
                                  ' raising new style exceptions with python'
 
1198
 
    def test_corrupted_parent_in_list(self):
 
1199
 
        transport = MockTransport([
 
1203
 
            "c option 0 1 1 v :", # Can't have a parent of 'v'
 
1205
 
        index = self.get_knit_index(transport, 'filename', 'r')
 
1207
 
            self.assertRaises(errors.KnitCorrupt, index.keys)
 
1208
 
        except TypeError, e:
 
1209
 
            if (str(e) == ('exceptions must be strings, classes, or instances,'
 
1210
 
                           ' not exceptions.ValueError')
 
1211
 
                and sys.version_info[0:2] >= (2,5)):
 
1212
 
                self.knownFailure('Pyrex <0.9.5 fails with TypeError when'
 
1213
 
                                  ' raising new style exceptions with python'
 
1218
 
    def test_invalid_position(self):
 
1219
 
        transport = MockTransport([
 
1223
 
        index = self.get_knit_index(transport, 'filename', 'r')
 
1225
 
            self.assertRaises(errors.KnitCorrupt, index.keys)
 
1226
 
        except TypeError, e:
 
1227
 
            if (str(e) == ('exceptions must be strings, classes, or instances,'
 
1228
 
                           ' not exceptions.ValueError')
 
1229
 
                and sys.version_info[0:2] >= (2,5)):
 
1230
 
                self.knownFailure('Pyrex <0.9.5 fails with TypeError when'
 
1231
 
                                  ' raising new style exceptions with python'
 
1236
 
    def test_invalid_size(self):
 
1237
 
        transport = MockTransport([
 
1241
 
        index = self.get_knit_index(transport, 'filename', 'r')
 
1243
 
            self.assertRaises(errors.KnitCorrupt, index.keys)
 
1244
 
        except TypeError, e:
 
1245
 
            if (str(e) == ('exceptions must be strings, classes, or instances,'
 
1246
 
                           ' not exceptions.ValueError')
 
1247
 
                and sys.version_info[0:2] >= (2,5)):
 
1248
 
                self.knownFailure('Pyrex <0.9.5 fails with TypeError when'
 
1249
 
                                  ' raising new style exceptions with python'
 
1254
 
    def test_scan_unvalidated_index_not_implemented(self):
 
1255
 
        transport = MockTransport()
 
1256
 
        index = self.get_knit_index(transport, 'filename', 'r')
 
1258
 
            NotImplementedError, index.scan_unvalidated_index,
 
1259
 
            'dummy graph_index')
 
1261
 
            NotImplementedError, index.get_missing_compression_parents)
 
1263
 
    def test_short_line(self):
 
1264
 
        transport = MockTransport([
 
1267
 
            "b option 10 10 0", # This line isn't terminated, ignored
 
1269
 
        index = self.get_knit_index(transport, "filename", "r")
 
1270
 
        self.assertEqual(set([('a',)]), index.keys())
 
1272
 
    def test_skip_incomplete_record(self):
 
1273
 
        # A line with bogus data should just be skipped
 
1274
 
        transport = MockTransport([
 
1277
 
            "b option 10 10 0", # This line isn't terminated, ignored
 
1278
 
            "c option 20 10 0 :", # Properly terminated, and starts with '\n'
 
1280
 
        index = self.get_knit_index(transport, "filename", "r")
 
1281
 
        self.assertEqual(set([('a',), ('c',)]), index.keys())
 
1283
 
    def test_trailing_characters(self):
 
1284
 
        # A line with bogus data should just be skipped
 
1285
 
        transport = MockTransport([
 
1288
 
            "b option 10 10 0 :a", # This line has extra trailing characters
 
1289
 
            "c option 20 10 0 :", # Properly terminated, and starts with '\n'
 
1291
 
        index = self.get_knit_index(transport, "filename", "r")
 
1292
 
        self.assertEqual(set([('a',), ('c',)]), index.keys())
 
1295
 
class LowLevelKnitIndexTests_c(LowLevelKnitIndexTests):
 
1297
 
    _test_needs_features = [compiled_knit_feature]
 
1299
 
    def get_knit_index(self, transport, name, mode):
 
1300
 
        mapper = ConstantMapper(name)
 
1301
 
        from bzrlib._knit_load_data_pyx import _load_data_c
 
1302
 
        self.overrideAttr(knit, '_load_data', _load_data_c)
 
1303
 
        allow_writes = lambda: mode == 'w'
 
1304
 
        return _KndxIndex(transport, mapper, lambda:None,
 
1305
 
                          allow_writes, lambda:True)
 
1308
 
class Test_KnitAnnotator(TestCaseWithMemoryTransport):
 
1310
 
    def make_annotator(self):
 
1311
 
        factory = knit.make_pack_factory(True, True, 1)
 
1312
 
        vf = factory(self.get_transport())
 
1313
 
        return knit._KnitAnnotator(vf)
 
1315
 
    def test__expand_fulltext(self):
 
1316
 
        ann = self.make_annotator()
 
1317
 
        rev_key = ('rev-id',)
 
1318
 
        ann._num_compression_children[rev_key] = 1
 
1319
 
        res = ann._expand_record(rev_key, (('parent-id',),), None,
 
1320
 
                           ['line1\n', 'line2\n'], ('fulltext', True))
 
1321
 
        # The content object and text lines should be cached appropriately
 
1322
 
        self.assertEqual(['line1\n', 'line2'], res)
 
1323
 
        content_obj = ann._content_objects[rev_key]
 
1324
 
        self.assertEqual(['line1\n', 'line2\n'], content_obj._lines)
 
1325
 
        self.assertEqual(res, content_obj.text())
 
1326
 
        self.assertEqual(res, ann._text_cache[rev_key])
 
1328
 
    def test__expand_delta_comp_parent_not_available(self):
 
1329
 
        # Parent isn't available yet, so we return nothing, but queue up this
 
1330
 
        # node for later processing
 
1331
 
        ann = self.make_annotator()
 
1332
 
        rev_key = ('rev-id',)
 
1333
 
        parent_key = ('parent-id',)
 
1334
 
        record = ['0,1,1\n', 'new-line\n']
 
1335
 
        details = ('line-delta', False)
 
1336
 
        res = ann._expand_record(rev_key, (parent_key,), parent_key,
 
1338
 
        self.assertEqual(None, res)
 
1339
 
        self.assertTrue(parent_key in ann._pending_deltas)
 
1340
 
        pending = ann._pending_deltas[parent_key]
 
1341
 
        self.assertEqual(1, len(pending))
 
1342
 
        self.assertEqual((rev_key, (parent_key,), record, details), pending[0])
 
1344
 
    def test__expand_record_tracks_num_children(self):
 
1345
 
        ann = self.make_annotator()
 
1346
 
        rev_key = ('rev-id',)
 
1347
 
        rev2_key = ('rev2-id',)
 
1348
 
        parent_key = ('parent-id',)
 
1349
 
        record = ['0,1,1\n', 'new-line\n']
 
1350
 
        details = ('line-delta', False)
 
1351
 
        ann._num_compression_children[parent_key] = 2
 
1352
 
        ann._expand_record(parent_key, (), None, ['line1\n', 'line2\n'],
 
1353
 
                           ('fulltext', False))
 
1354
 
        res = ann._expand_record(rev_key, (parent_key,), parent_key,
 
1356
 
        self.assertEqual({parent_key: 1}, ann._num_compression_children)
 
1357
 
        # Expanding the second child should remove the content object, and the
 
1358
 
        # num_compression_children entry
 
1359
 
        res = ann._expand_record(rev2_key, (parent_key,), parent_key,
 
1361
 
        self.assertFalse(parent_key in ann._content_objects)
 
1362
 
        self.assertEqual({}, ann._num_compression_children)
 
1363
 
        # We should not cache the content_objects for rev2 and rev, because
 
1364
 
        # they do not have compression children of their own.
 
1365
 
        self.assertEqual({}, ann._content_objects)
 
1367
 
    def test__expand_delta_records_blocks(self):
 
1368
 
        ann = self.make_annotator()
 
1369
 
        rev_key = ('rev-id',)
 
1370
 
        parent_key = ('parent-id',)
 
1371
 
        record = ['0,1,1\n', 'new-line\n']
 
1372
 
        details = ('line-delta', True)
 
1373
 
        ann._num_compression_children[parent_key] = 2
 
1374
 
        ann._expand_record(parent_key, (), None,
 
1375
 
                           ['line1\n', 'line2\n', 'line3\n'],
 
1376
 
                           ('fulltext', False))
 
1377
 
        ann._expand_record(rev_key, (parent_key,), parent_key, record, details)
 
1378
 
        self.assertEqual({(rev_key, parent_key): [(1, 1, 1), (3, 3, 0)]},
 
1379
 
                         ann._matching_blocks)
 
1380
 
        rev2_key = ('rev2-id',)
 
1381
 
        record = ['0,1,1\n', 'new-line\n']
 
1382
 
        details = ('line-delta', False)
 
1383
 
        ann._expand_record(rev2_key, (parent_key,), parent_key, record, details)
 
1384
 
        self.assertEqual([(1, 1, 2), (3, 3, 0)],
 
1385
 
                         ann._matching_blocks[(rev2_key, parent_key)])
 
1387
 
    def test__get_parent_ann_uses_matching_blocks(self):
 
1388
 
        ann = self.make_annotator()
 
1389
 
        rev_key = ('rev-id',)
 
1390
 
        parent_key = ('parent-id',)
 
1391
 
        parent_ann = [(parent_key,)]*3
 
1392
 
        block_key = (rev_key, parent_key)
 
1393
 
        ann._annotations_cache[parent_key] = parent_ann
 
1394
 
        ann._matching_blocks[block_key] = [(0, 1, 1), (3, 3, 0)]
 
1395
 
        # We should not try to access any parent_lines content, because we know
 
1396
 
        # we already have the matching blocks
 
1397
 
        par_ann, blocks = ann._get_parent_annotations_and_matches(rev_key,
 
1398
 
                                        ['1\n', '2\n', '3\n'], parent_key)
 
1399
 
        self.assertEqual(parent_ann, par_ann)
 
1400
 
        self.assertEqual([(0, 1, 1), (3, 3, 0)], blocks)
 
1401
 
        self.assertEqual({}, ann._matching_blocks)
 
1403
 
    def test__process_pending(self):
 
1404
 
        ann = self.make_annotator()
 
1405
 
        rev_key = ('rev-id',)
 
1408
 
        record = ['0,1,1\n', 'new-line\n']
 
1409
 
        details = ('line-delta', False)
 
1410
 
        p1_record = ['line1\n', 'line2\n']
 
1411
 
        ann._num_compression_children[p1_key] = 1
 
1412
 
        res = ann._expand_record(rev_key, (p1_key,p2_key), p1_key,
 
1414
 
        self.assertEqual(None, res)
 
1415
 
        # self.assertTrue(p1_key in ann._pending_deltas)
 
1416
 
        self.assertEqual({}, ann._pending_annotation)
 
1417
 
        # Now insert p1, and we should be able to expand the delta
 
1418
 
        res = ann._expand_record(p1_key, (), None, p1_record,
 
1419
 
                                 ('fulltext', False))
 
1420
 
        self.assertEqual(p1_record, res)
 
1421
 
        ann._annotations_cache[p1_key] = [(p1_key,)]*2
 
1422
 
        res = ann._process_pending(p1_key)
 
1423
 
        self.assertEqual([], res)
 
1424
 
        self.assertFalse(p1_key in ann._pending_deltas)
 
1425
 
        self.assertTrue(p2_key in ann._pending_annotation)
 
1426
 
        self.assertEqual({p2_key: [(rev_key, (p1_key, p2_key))]},
 
1427
 
                         ann._pending_annotation)
 
1428
 
        # Now fill in parent 2, and pending annotation should be satisfied
 
1429
 
        res = ann._expand_record(p2_key, (), None, [], ('fulltext', False))
 
1430
 
        ann._annotations_cache[p2_key] = []
 
1431
 
        res = ann._process_pending(p2_key)
 
1432
 
        self.assertEqual([rev_key], res)
 
1433
 
        self.assertEqual({}, ann._pending_annotation)
 
1434
 
        self.assertEqual({}, ann._pending_deltas)
 
1436
 
    def test_record_delta_removes_basis(self):
 
1437
 
        ann = self.make_annotator()
 
1438
 
        ann._expand_record(('parent-id',), (), None,
 
1439
 
                           ['line1\n', 'line2\n'], ('fulltext', False))
 
1440
 
        ann._num_compression_children['parent-id'] = 2
 
1442
 
    def test_annotate_special_text(self):
 
1443
 
        ann = self.make_annotator()
 
1445
 
        rev1_key = ('rev-1',)
 
1446
 
        rev2_key = ('rev-2',)
 
1447
 
        rev3_key = ('rev-3',)
 
1448
 
        spec_key = ('special:',)
 
1449
 
        vf.add_lines(rev1_key, [], ['initial content\n'])
 
1450
 
        vf.add_lines(rev2_key, [rev1_key], ['initial content\n',
 
1453
 
        vf.add_lines(rev3_key, [rev1_key], ['initial content\n',
 
1456
 
        spec_text = ('initial content\n'
 
1460
 
        ann.add_special_text(spec_key, [rev2_key, rev3_key], spec_text)
 
1461
 
        anns, lines = ann.annotate(spec_key)
 
1462
 
        self.assertEqual([(rev1_key,),
 
1463
 
                          (rev2_key, rev3_key),
 
1467
 
        self.assertEqualDiff(spec_text, ''.join(lines))
 
 
498
        index = _KnitIndex(transport, "filename", "r")
 
 
500
        self.assertEqual(["opt1"], index.get_options(u"a"))
 
 
501
        self.assertEqual(["opt2", "opt3"], index.get_options(u"b"))
 
 
503
    def test_get_parents(self):
 
 
504
        transport = MockTransport([
 
 
507
            "b option 1 2 0 .c :",
 
 
508
            "c option 1 2 1 0 .e :"
 
 
510
        index = _KnitIndex(transport, "filename", "r")
 
 
512
        self.assertEqual([], index.get_parents(u"a"))
 
 
513
        self.assertEqual([u"a", u"c"], index.get_parents(u"b"))
 
 
514
        self.assertEqual([u"b", u"a"], index.get_parents(u"c"))
 
 
516
    def test_get_parents_with_ghosts(self):
 
 
517
        transport = MockTransport([
 
 
520
            "b option 1 2 0 .c :",
 
 
521
            "c option 1 2 1 0 .e :"
 
 
523
        index = _KnitIndex(transport, "filename", "r")
 
 
525
        self.assertEqual([], index.get_parents_with_ghosts(u"a"))
 
 
526
        self.assertEqual([u"a", u"c"], index.get_parents_with_ghosts(u"b"))
 
 
527
        self.assertEqual([u"b", u"a", u"e"],
 
 
528
            index.get_parents_with_ghosts(u"c"))
 
 
530
    def test_check_versions_present(self):
 
 
531
        transport = MockTransport([
 
 
536
        index = _KnitIndex(transport, "filename", "r")
 
 
538
        check = index.check_versions_present
 
 
544
        self.assertRaises(RevisionNotPresent, check, [u"c"])
 
 
545
        self.assertRaises(RevisionNotPresent, check, [u"a", u"b", u"c"])
 
1470
548
class KnitTests(TestCaseWithTransport):
 
1471
549
    """Class containing knit test helper routines."""
 
1473
 
    def make_test_knit(self, annotate=False, name='test'):
 
1474
 
        mapper = ConstantMapper(name)
 
1475
 
        return make_file_factory(annotate, mapper)(self.get_transport())
 
1478
 
class TestBadShaError(KnitTests):
 
1479
 
    """Tests for handling of sha errors."""
 
1481
 
    def test_sha_exception_has_text(self):
 
1482
 
        # having the failed text included in the error allows for recovery.
 
1483
 
        source = self.make_test_knit()
 
1484
 
        target = self.make_test_knit(name="target")
 
1485
 
        if not source._max_delta_chain:
 
1486
 
            raise TestNotApplicable(
 
1487
 
                "cannot get delta-caused sha failures without deltas.")
 
1490
 
        broken = ('broken',)
 
1491
 
        source.add_lines(basis, (), ['foo\n'])
 
1492
 
        source.add_lines(broken, (basis,), ['foo\n', 'bar\n'])
 
1493
 
        # Seed target with a bad basis text
 
1494
 
        target.add_lines(basis, (), ['gam\n'])
 
1495
 
        target.insert_record_stream(
 
1496
 
            source.get_record_stream([broken], 'unordered', False))
 
1497
 
        err = self.assertRaises(errors.KnitCorrupt,
 
1498
 
            target.get_record_stream([broken], 'unordered', True
 
1499
 
            ).next().get_bytes_as, 'chunked')
 
1500
 
        self.assertEqual(['gam\n', 'bar\n'], err.content)
 
1501
 
        # Test for formatting with live data
 
1502
 
        self.assertStartsWith(str(err), "Knit ")
 
 
551
    def make_test_knit(self, annotate=False, delay_create=False):
 
 
553
            factory = KnitPlainFactory()
 
 
556
        return KnitVersionedFile('test', get_transport('.'), access_mode='w',
 
 
557
                                 factory=factory, create=True,
 
 
558
                                 delay_create=delay_create)
 
 
561
class BasicKnitTests(KnitTests):
 
 
563
    def add_stock_one_and_one_a(self, k):
 
 
564
        k.add_lines('text-1', [], split_lines(TEXT_1))
 
 
565
        k.add_lines('text-1a', ['text-1'], split_lines(TEXT_1A))
 
 
567
    def test_knit_constructor(self):
 
 
568
        """Construct empty k"""
 
 
569
        self.make_test_knit()
 
 
571
    def test_knit_add(self):
 
 
572
        """Store one text in knit and retrieve"""
 
 
573
        k = self.make_test_knit()
 
 
574
        k.add_lines('text-1', [], split_lines(TEXT_1))
 
 
575
        self.assertTrue(k.has_version('text-1'))
 
 
576
        self.assertEqualDiff(''.join(k.get_lines('text-1')), TEXT_1)
 
 
578
    def test_knit_reload(self):
 
 
579
        # test that the content in a reloaded knit is correct
 
 
580
        k = self.make_test_knit()
 
 
581
        k.add_lines('text-1', [], split_lines(TEXT_1))
 
 
583
        k2 = KnitVersionedFile('test', get_transport('.'), access_mode='r', factory=KnitPlainFactory(), create=True)
 
 
584
        self.assertTrue(k2.has_version('text-1'))
 
 
585
        self.assertEqualDiff(''.join(k2.get_lines('text-1')), TEXT_1)
 
 
587
    def test_knit_several(self):
 
 
588
        """Store several texts in a knit"""
 
 
589
        k = self.make_test_knit()
 
 
590
        k.add_lines('text-1', [], split_lines(TEXT_1))
 
 
591
        k.add_lines('text-2', [], split_lines(TEXT_2))
 
 
592
        self.assertEqualDiff(''.join(k.get_lines('text-1')), TEXT_1)
 
 
593
        self.assertEqualDiff(''.join(k.get_lines('text-2')), TEXT_2)
 
 
595
    def test_repeated_add(self):
 
 
596
        """Knit traps attempt to replace existing version"""
 
 
597
        k = self.make_test_knit()
 
 
598
        k.add_lines('text-1', [], split_lines(TEXT_1))
 
 
599
        self.assertRaises(RevisionAlreadyPresent, 
 
 
601
                'text-1', [], split_lines(TEXT_1))
 
 
603
    def test_empty(self):
 
 
604
        k = self.make_test_knit(True)
 
 
605
        k.add_lines('text-1', [], [])
 
 
606
        self.assertEquals(k.get_lines('text-1'), [])
 
 
608
    def test_incomplete(self):
 
 
609
        """Test if texts without a ending line-end can be inserted and
 
 
611
        k = KnitVersionedFile('test', get_transport('.'), delta=False, create=True)
 
 
612
        k.add_lines('text-1', [], ['a\n',    'b'  ])
 
 
613
        k.add_lines('text-2', ['text-1'], ['a\rb\n', 'b\n'])
 
 
614
        # reopening ensures maximum room for confusion
 
 
615
        k = KnitVersionedFile('test', get_transport('.'), delta=False, create=True)
 
 
616
        self.assertEquals(k.get_lines('text-1'), ['a\n',    'b'  ])
 
 
617
        self.assertEquals(k.get_lines('text-2'), ['a\rb\n', 'b\n'])
 
 
619
    def test_delta(self):
 
 
620
        """Expression of knit delta as lines"""
 
 
621
        k = self.make_test_knit()
 
 
622
        td = list(line_delta(TEXT_1.splitlines(True),
 
 
623
                             TEXT_1A.splitlines(True)))
 
 
624
        self.assertEqualDiff(''.join(td), delta_1_1a)
 
 
625
        out = apply_line_delta(TEXT_1.splitlines(True), td)
 
 
626
        self.assertEqualDiff(''.join(out), TEXT_1A)
 
 
628
    def test_add_with_parents(self):
 
 
629
        """Store in knit with parents"""
 
 
630
        k = self.make_test_knit()
 
 
631
        self.add_stock_one_and_one_a(k)
 
 
632
        self.assertEquals(k.get_parents('text-1'), [])
 
 
633
        self.assertEquals(k.get_parents('text-1a'), ['text-1'])
 
 
635
    def test_ancestry(self):
 
 
636
        """Store in knit with parents"""
 
 
637
        k = self.make_test_knit()
 
 
638
        self.add_stock_one_and_one_a(k)
 
 
639
        self.assertEquals(set(k.get_ancestry(['text-1a'])), set(['text-1a', 'text-1']))
 
 
641
    def test_add_delta(self):
 
 
642
        """Store in knit with parents"""
 
 
643
        k = KnitVersionedFile('test', get_transport('.'), factory=KnitPlainFactory(),
 
 
644
            delta=True, create=True)
 
 
645
        self.add_stock_one_and_one_a(k)
 
 
647
        self.assertEqualDiff(''.join(k.get_lines('text-1a')), TEXT_1A)
 
 
649
    def test_annotate(self):
 
 
651
        k = KnitVersionedFile('knit', get_transport('.'), factory=KnitAnnotateFactory(),
 
 
652
            delta=True, create=True)
 
 
653
        self.insert_and_test_small_annotate(k)
 
 
655
    def insert_and_test_small_annotate(self, k):
 
 
656
        """test annotation with k works correctly."""
 
 
657
        k.add_lines('text-1', [], ['a\n', 'b\n'])
 
 
658
        k.add_lines('text-2', ['text-1'], ['a\n', 'c\n'])
 
 
660
        origins = k.annotate('text-2')
 
 
661
        self.assertEquals(origins[0], ('text-1', 'a\n'))
 
 
662
        self.assertEquals(origins[1], ('text-2', 'c\n'))
 
 
664
    def test_annotate_fulltext(self):
 
 
666
        k = KnitVersionedFile('knit', get_transport('.'), factory=KnitAnnotateFactory(),
 
 
667
            delta=False, create=True)
 
 
668
        self.insert_and_test_small_annotate(k)
 
 
670
    def test_annotate_merge_1(self):
 
 
671
        k = self.make_test_knit(True)
 
 
672
        k.add_lines('text-a1', [], ['a\n', 'b\n'])
 
 
673
        k.add_lines('text-a2', [], ['d\n', 'c\n'])
 
 
674
        k.add_lines('text-am', ['text-a1', 'text-a2'], ['d\n', 'b\n'])
 
 
675
        origins = k.annotate('text-am')
 
 
676
        self.assertEquals(origins[0], ('text-a2', 'd\n'))
 
 
677
        self.assertEquals(origins[1], ('text-a1', 'b\n'))
 
 
679
    def test_annotate_merge_2(self):
 
 
680
        k = self.make_test_knit(True)
 
 
681
        k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
 
 
682
        k.add_lines('text-a2', [], ['x\n', 'y\n', 'z\n'])
 
 
683
        k.add_lines('text-am', ['text-a1', 'text-a2'], ['a\n', 'y\n', 'c\n'])
 
 
684
        origins = k.annotate('text-am')
 
 
685
        self.assertEquals(origins[0], ('text-a1', 'a\n'))
 
 
686
        self.assertEquals(origins[1], ('text-a2', 'y\n'))
 
 
687
        self.assertEquals(origins[2], ('text-a1', 'c\n'))
 
 
689
    def test_annotate_merge_9(self):
 
 
690
        k = self.make_test_knit(True)
 
 
691
        k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
 
 
692
        k.add_lines('text-a2', [], ['x\n', 'y\n', 'z\n'])
 
 
693
        k.add_lines('text-am', ['text-a1', 'text-a2'], ['k\n', 'y\n', 'c\n'])
 
 
694
        origins = k.annotate('text-am')
 
 
695
        self.assertEquals(origins[0], ('text-am', 'k\n'))
 
 
696
        self.assertEquals(origins[1], ('text-a2', 'y\n'))
 
 
697
        self.assertEquals(origins[2], ('text-a1', 'c\n'))
 
 
699
    def test_annotate_merge_3(self):
 
 
700
        k = self.make_test_knit(True)
 
 
701
        k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
 
 
702
        k.add_lines('text-a2', [] ,['x\n', 'y\n', 'z\n'])
 
 
703
        k.add_lines('text-am', ['text-a1', 'text-a2'], ['k\n', 'y\n', 'z\n'])
 
 
704
        origins = k.annotate('text-am')
 
 
705
        self.assertEquals(origins[0], ('text-am', 'k\n'))
 
 
706
        self.assertEquals(origins[1], ('text-a2', 'y\n'))
 
 
707
        self.assertEquals(origins[2], ('text-a2', 'z\n'))
 
 
709
    def test_annotate_merge_4(self):
 
 
710
        k = self.make_test_knit(True)
 
 
711
        k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
 
 
712
        k.add_lines('text-a2', [], ['x\n', 'y\n', 'z\n'])
 
 
713
        k.add_lines('text-a3', ['text-a1'], ['a\n', 'b\n', 'p\n'])
 
 
714
        k.add_lines('text-am', ['text-a2', 'text-a3'], ['a\n', 'b\n', 'z\n'])
 
 
715
        origins = k.annotate('text-am')
 
 
716
        self.assertEquals(origins[0], ('text-a1', 'a\n'))
 
 
717
        self.assertEquals(origins[1], ('text-a1', 'b\n'))
 
 
718
        self.assertEquals(origins[2], ('text-a2', 'z\n'))
 
 
720
    def test_annotate_merge_5(self):
 
 
721
        k = self.make_test_knit(True)
 
 
722
        k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
 
 
723
        k.add_lines('text-a2', [], ['d\n', 'e\n', 'f\n'])
 
 
724
        k.add_lines('text-a3', [], ['x\n', 'y\n', 'z\n'])
 
 
725
        k.add_lines('text-am',
 
 
726
                    ['text-a1', 'text-a2', 'text-a3'],
 
 
727
                    ['a\n', 'e\n', 'z\n'])
 
 
728
        origins = k.annotate('text-am')
 
 
729
        self.assertEquals(origins[0], ('text-a1', 'a\n'))
 
 
730
        self.assertEquals(origins[1], ('text-a2', 'e\n'))
 
 
731
        self.assertEquals(origins[2], ('text-a3', 'z\n'))
 
 
733
    def test_annotate_file_cherry_pick(self):
 
 
734
        k = self.make_test_knit(True)
 
 
735
        k.add_lines('text-1', [], ['a\n', 'b\n', 'c\n'])
 
 
736
        k.add_lines('text-2', ['text-1'], ['d\n', 'e\n', 'f\n'])
 
 
737
        k.add_lines('text-3', ['text-2', 'text-1'], ['a\n', 'b\n', 'c\n'])
 
 
738
        origins = k.annotate('text-3')
 
 
739
        self.assertEquals(origins[0], ('text-1', 'a\n'))
 
 
740
        self.assertEquals(origins[1], ('text-1', 'b\n'))
 
 
741
        self.assertEquals(origins[2], ('text-1', 'c\n'))
 
 
743
    def test_knit_join(self):
 
 
744
        """Store in knit with parents"""
 
 
745
        k1 = KnitVersionedFile('test1', get_transport('.'), factory=KnitPlainFactory(), create=True)
 
 
746
        k1.add_lines('text-a', [], split_lines(TEXT_1))
 
 
747
        k1.add_lines('text-b', ['text-a'], split_lines(TEXT_1))
 
 
749
        k1.add_lines('text-c', [], split_lines(TEXT_1))
 
 
750
        k1.add_lines('text-d', ['text-c'], split_lines(TEXT_1))
 
 
752
        k1.add_lines('text-m', ['text-b', 'text-d'], split_lines(TEXT_1))
 
 
754
        k2 = KnitVersionedFile('test2', get_transport('.'), factory=KnitPlainFactory(), create=True)
 
 
755
        count = k2.join(k1, version_ids=['text-m'])
 
 
756
        self.assertEquals(count, 5)
 
 
757
        self.assertTrue(k2.has_version('text-a'))
 
 
758
        self.assertTrue(k2.has_version('text-c'))
 
 
760
    def test_reannotate(self):
 
 
761
        k1 = KnitVersionedFile('knit1', get_transport('.'),
 
 
762
                               factory=KnitAnnotateFactory(), create=True)
 
 
764
        k1.add_lines('text-a', [], ['a\n', 'b\n'])
 
 
766
        k1.add_lines('text-b', ['text-a'], ['a\n', 'c\n'])
 
 
768
        k2 = KnitVersionedFile('test2', get_transport('.'),
 
 
769
                               factory=KnitAnnotateFactory(), create=True)
 
 
770
        k2.join(k1, version_ids=['text-b'])
 
 
773
        k1.add_lines('text-X', ['text-b'], ['a\n', 'b\n'])
 
 
775
        k2.add_lines('text-c', ['text-b'], ['z\n', 'c\n'])
 
 
777
        k2.add_lines('text-Y', ['text-b'], ['b\n', 'c\n'])
 
 
779
        # test-c will have index 3
 
 
780
        k1.join(k2, version_ids=['text-c'])
 
 
782
        lines = k1.get_lines('text-c')
 
 
783
        self.assertEquals(lines, ['z\n', 'c\n'])
 
 
785
        origins = k1.annotate('text-c')
 
 
786
        self.assertEquals(origins[0], ('text-c', 'z\n'))
 
 
787
        self.assertEquals(origins[1], ('text-b', 'c\n'))
 
 
789
    def test_get_line_delta_texts(self):
 
 
790
        """Make sure we can call get_texts on text with reused line deltas"""
 
 
791
        k1 = KnitVersionedFile('test1', get_transport('.'), 
 
 
792
                               factory=KnitPlainFactory(), create=True)
 
 
797
                parents = ['%d' % (t-1)]
 
 
798
            k1.add_lines('%d' % t, parents, ['hello\n'] * t)
 
 
799
        k1.get_texts(('%d' % t) for t in range(3))
 
 
801
    def test_iter_lines_reads_in_order(self):
 
 
802
        t = MemoryTransport()
 
 
803
        instrumented_t = TransportLogger(t)
 
 
804
        k1 = KnitVersionedFile('id', instrumented_t, create=True, delta=True)
 
 
805
        self.assertEqual([('id.kndx',)], instrumented_t._calls)
 
 
806
        # add texts with no required ordering
 
 
807
        k1.add_lines('base', [], ['text\n'])
 
 
808
        k1.add_lines('base2', [], ['text2\n'])
 
 
810
        instrumented_t._calls = []
 
 
811
        # request a last-first iteration
 
 
812
        results = list(k1.iter_lines_added_or_present_in_versions(['base2', 'base']))
 
 
813
        self.assertEqual([('id.knit', [(0, 87), (87, 89)])], instrumented_t._calls)
 
 
814
        self.assertEqual(['text\n', 'text2\n'], results)
 
 
816
    def test_create_empty_annotated(self):
 
 
817
        k1 = self.make_test_knit(True)
 
 
819
        k1.add_lines('text-a', [], ['a\n', 'b\n'])
 
 
820
        k2 = k1.create_empty('t', MemoryTransport())
 
 
821
        self.assertTrue(isinstance(k2.factory, KnitAnnotateFactory))
 
 
822
        self.assertEqual(k1.delta, k2.delta)
 
 
823
        # the generic test checks for empty content and file class
 
 
825
    def test_knit_format(self):
 
 
826
        # this tests that a new knit index file has the expected content
 
 
827
        # and that is writes the data we expect as records are added.
 
 
828
        knit = self.make_test_knit(True)
 
 
829
        # Now knit files are not created until we first add data to them
 
 
830
        self.assertFileEqual("# bzr knit index 8\n", 'test.kndx')
 
 
831
        knit.add_lines_with_ghosts('revid', ['a_ghost'], ['a\n'])
 
 
832
        self.assertFileEqual(
 
 
833
            "# bzr knit index 8\n"
 
 
835
            "revid fulltext 0 84 .a_ghost :",
 
 
837
        knit.add_lines_with_ghosts('revid2', ['revid'], ['a\n'])
 
 
838
        self.assertFileEqual(
 
 
839
            "# bzr knit index 8\n"
 
 
840
            "\nrevid fulltext 0 84 .a_ghost :"
 
 
841
            "\nrevid2 line-delta 84 82 0 :",
 
 
843
        # we should be able to load this file again
 
 
844
        knit = KnitVersionedFile('test', get_transport('.'), access_mode='r')
 
 
845
        self.assertEqual(['revid', 'revid2'], knit.versions())
 
 
846
        # write a short write to the file and ensure that its ignored
 
 
847
        indexfile = file('test.kndx', 'at')
 
 
848
        indexfile.write('\nrevid3 line-delta 166 82 1 2 3 4 5 .phwoar:demo ')
 
 
850
        # we should be able to load this file again
 
 
851
        knit = KnitVersionedFile('test', get_transport('.'), access_mode='w')
 
 
852
        self.assertEqual(['revid', 'revid2'], knit.versions())
 
 
853
        # and add a revision with the same id the failed write had
 
 
854
        knit.add_lines('revid3', ['revid2'], ['a\n'])
 
 
855
        # and when reading it revid3 should now appear.
 
 
856
        knit = KnitVersionedFile('test', get_transport('.'), access_mode='r')
 
 
857
        self.assertEqual(['revid', 'revid2', 'revid3'], knit.versions())
 
 
858
        self.assertEqual(['revid2'], knit.get_parents('revid3'))
 
 
860
    def test_delay_create(self):
 
 
861
        """Test that passing delay_create=True creates files late"""
 
 
862
        knit = self.make_test_knit(annotate=True, delay_create=True)
 
 
863
        self.failIfExists('test.knit')
 
 
864
        self.failIfExists('test.kndx')
 
 
865
        knit.add_lines_with_ghosts('revid', ['a_ghost'], ['a\n'])
 
 
866
        self.failUnlessExists('test.knit')
 
 
867
        self.assertFileEqual(
 
 
868
            "# bzr knit index 8\n"
 
 
870
            "revid fulltext 0 84 .a_ghost :",
 
 
873
    def test_create_parent_dir(self):
 
 
874
        """create_parent_dir can create knits in nonexistant dirs"""
 
 
875
        # Has no effect if we don't set 'delay_create'
 
 
876
        trans = get_transport('.')
 
 
877
        self.assertRaises(NoSuchFile, KnitVersionedFile, 'dir/test',
 
 
878
                          trans, access_mode='w', factory=None,
 
 
879
                          create=True, create_parent_dir=True)
 
 
880
        # Nothing should have changed yet
 
 
881
        knit = KnitVersionedFile('dir/test', trans, access_mode='w',
 
 
882
                                 factory=None, create=True,
 
 
883
                                 create_parent_dir=True,
 
 
885
        self.failIfExists('dir/test.knit')
 
 
886
        self.failIfExists('dir/test.kndx')
 
 
887
        self.failIfExists('dir')
 
 
888
        knit.add_lines('revid', [], ['a\n'])
 
 
889
        self.failUnlessExists('dir')
 
 
890
        self.failUnlessExists('dir/test.knit')
 
 
891
        self.assertFileEqual(
 
 
892
            "# bzr knit index 8\n"
 
 
894
            "revid fulltext 0 84  :",
 
 
897
    def test_create_mode_700(self):
 
 
898
        trans = get_transport('.')
 
 
899
        if not trans._can_roundtrip_unix_modebits():
 
 
900
            # Can't roundtrip, so no need to run this test
 
 
902
        knit = KnitVersionedFile('dir/test', trans, access_mode='w',
 
 
903
                                 factory=None, create=True,
 
 
904
                                 create_parent_dir=True,
 
 
908
        knit.add_lines('revid', [], ['a\n'])
 
 
909
        self.assertTransportMode(trans, 'dir', 0700)
 
 
910
        self.assertTransportMode(trans, 'dir/test.knit', 0600)
 
 
911
        self.assertTransportMode(trans, 'dir/test.kndx', 0600)
 
 
913
    def test_create_mode_770(self):
 
 
914
        trans = get_transport('.')
 
 
915
        if not trans._can_roundtrip_unix_modebits():
 
 
916
            # Can't roundtrip, so no need to run this test
 
 
918
        knit = KnitVersionedFile('dir/test', trans, access_mode='w',
 
 
919
                                 factory=None, create=True,
 
 
920
                                 create_parent_dir=True,
 
 
924
        knit.add_lines('revid', [], ['a\n'])
 
 
925
        self.assertTransportMode(trans, 'dir', 0770)
 
 
926
        self.assertTransportMode(trans, 'dir/test.knit', 0660)
 
 
927
        self.assertTransportMode(trans, 'dir/test.kndx', 0660)
 
 
929
    def test_create_mode_777(self):
 
 
930
        trans = get_transport('.')
 
 
931
        if not trans._can_roundtrip_unix_modebits():
 
 
932
            # Can't roundtrip, so no need to run this test
 
 
934
        knit = KnitVersionedFile('dir/test', trans, access_mode='w',
 
 
935
                                 factory=None, create=True,
 
 
936
                                 create_parent_dir=True,
 
 
940
        knit.add_lines('revid', [], ['a\n'])
 
 
941
        self.assertTransportMode(trans, 'dir', 0777)
 
 
942
        self.assertTransportMode(trans, 'dir/test.knit', 0666)
 
 
943
        self.assertTransportMode(trans, 'dir/test.kndx', 0666)
 
 
945
    def test_plan_merge(self):
 
 
946
        my_knit = self.make_test_knit(annotate=True)
 
 
947
        my_knit.add_lines('text1', [], split_lines(TEXT_1))
 
 
948
        my_knit.add_lines('text1a', ['text1'], split_lines(TEXT_1A))
 
 
949
        my_knit.add_lines('text1b', ['text1'], split_lines(TEXT_1B))
 
 
950
        plan = list(my_knit.plan_merge('text1a', 'text1b'))
 
 
951
        for plan_line, expected_line in zip(plan, AB_MERGE):
 
 
952
            self.assertEqual(plan_line, expected_line)
 
 
964
Banana cup cake recipe
 
 
974
Banana cup cake recipe
 
 
976
- bananas (do not use plantains!!!)
 
 
983
Banana cup cake recipe
 
 
999
AB_MERGE_TEXT="""unchanged|Banana cup cake recipe
 
 
1004
new-b|- bananas (do not use plantains!!!)
 
 
1005
unchanged|- broken tea cups
 
 
1006
new-a|- self-raising flour
 
 
1009
AB_MERGE=[tuple(l.split('|')) for l in AB_MERGE_TEXT.splitlines(True)]
 
 
1012
def line_delta(from_lines, to_lines):
 
 
1013
    """Generate line-based delta from one text to another"""
 
 
1014
    s = difflib.SequenceMatcher(None, from_lines, to_lines)
 
 
1015
    for op in s.get_opcodes():
 
 
1016
        if op[0] == 'equal':
 
 
1018
        yield '%d,%d,%d\n' % (op[1], op[2], op[4]-op[3])
 
 
1019
        for i in range(op[3], op[4]):
 
 
1023
def apply_line_delta(basis_lines, delta_lines):
 
 
1024
    """Apply a line-based perfect diff
 
 
1026
    basis_lines -- text to apply the patch to
 
 
1027
    delta_lines -- diff instructions and content
 
 
1029
    out = basis_lines[:]
 
 
1032
    while i < len(delta_lines):
 
 
1034
        a, b, c = map(long, l.split(','))
 
 
1036
        out[offset+a:offset+b] = delta_lines[i:i+c]
 
 
1038
        offset = offset + (b - a) + c
 
 
1042
class TestWeaveToKnit(KnitTests):
 
 
1044
    def test_weave_to_knit_matches(self):
 
 
1045
        # check that the WeaveToKnit is_compatible function
 
 
1046
        # registers True for a Weave to a Knit.
 
 
1048
        k = self.make_test_knit()
 
 
1049
        self.failUnless(WeaveToKnit.is_compatible(w, k))
 
 
1050
        self.failIf(WeaveToKnit.is_compatible(k, w))
 
 
1051
        self.failIf(WeaveToKnit.is_compatible(w, w))
 
 
1052
        self.failIf(WeaveToKnit.is_compatible(k, k))
 
 
1055
class TestKnitCaching(KnitTests):
 
 
1057
    def create_knit(self, cache_add=False):
 
 
1058
        k = self.make_test_knit(True)
 
 
1062
        k.add_lines('text-1', [], split_lines(TEXT_1))
 
 
1063
        k.add_lines('text-2', [], split_lines(TEXT_2))
 
 
1066
    def test_no_caching(self):
 
 
1067
        k = self.create_knit()
 
 
1068
        # Nothing should be cached without setting 'enable_cache'
 
 
1069
        self.assertEqual({}, k._data._cache)
 
 
1071
    def test_cache_add_and_clear(self):
 
 
1072
        k = self.create_knit(True)
 
 
1074
        self.assertEqual(['text-1', 'text-2'], sorted(k._data._cache.keys()))
 
 
1077
        self.assertEqual({}, k._data._cache)
 
 
1079
    def test_cache_data_read_raw(self):
 
 
1080
        k = self.create_knit()
 
 
1082
        # Now cache and read
 
 
1085
        def read_one_raw(version):
 
 
1086
            pos_map = k._get_components_positions([version])
 
 
1087
            method, pos, size, next = pos_map[version]
 
 
1088
            lst = list(k._data.read_records_iter_raw([(version, pos, size)]))
 
 
1089
            self.assertEqual(1, len(lst))
 
 
1092
        val = read_one_raw('text-1')
 
 
1093
        self.assertEqual({'text-1':val[1]}, k._data._cache)
 
 
1096
        # After clear, new reads are not cached
 
 
1097
        self.assertEqual({}, k._data._cache)
 
 
1099
        val2 = read_one_raw('text-1')
 
 
1100
        self.assertEqual(val, val2)
 
 
1101
        self.assertEqual({}, k._data._cache)
 
 
1103
    def test_cache_data_read(self):
 
 
1104
        k = self.create_knit()
 
 
1106
        def read_one(version):
 
 
1107
            pos_map = k._get_components_positions([version])
 
 
1108
            method, pos, size, next = pos_map[version]
 
 
1109
            lst = list(k._data.read_records_iter([(version, pos, size)]))
 
 
1110
            self.assertEqual(1, len(lst))
 
 
1113
        # Now cache and read
 
 
1116
        val = read_one('text-2')
 
 
1117
        self.assertEqual(['text-2'], k._data._cache.keys())
 
 
1118
        self.assertEqual('text-2', val[0])
 
 
1119
        content, digest = k._data._parse_record('text-2',
 
 
1120
                                                k._data._cache['text-2'])
 
 
1121
        self.assertEqual(content, val[1])
 
 
1122
        self.assertEqual(digest, val[2])
 
 
1125
        self.assertEqual({}, k._data._cache)
 
 
1127
        val2 = read_one('text-2')
 
 
1128
        self.assertEqual(val, val2)
 
 
1129
        self.assertEqual({}, k._data._cache)
 
 
1131
    def test_cache_read(self):
 
 
1132
        k = self.create_knit()
 
 
1135
        text = k.get_text('text-1')
 
 
1136
        self.assertEqual(TEXT_1, text)
 
 
1137
        self.assertEqual(['text-1'], k._data._cache.keys())
 
 
1140
        self.assertEqual({}, k._data._cache)
 
 
1142
        text = k.get_text('text-1')
 
 
1143
        self.assertEqual(TEXT_1, text)
 
 
1144
        self.assertEqual({}, k._data._cache)
 
1505
1147
class TestKnitIndex(KnitTests):
 
 
1587
1220
    def test_knit_index_checks_header(self):
 
1588
1221
        t = get_transport('.')
 
1589
1222
        t.put_bytes('test.kndx', '# not really a knit header\n\n')
 
1590
 
        k = self.make_test_knit()
 
1591
 
        self.assertRaises(KnitHeaderError, k.keys)
 
1594
 
class TestGraphIndexKnit(KnitTests):
 
1595
 
    """Tests for knits using a GraphIndex rather than a KnitIndex."""
 
1597
 
    def make_g_index(self, name, ref_lists=0, nodes=[]):
 
1598
 
        builder = GraphIndexBuilder(ref_lists)
 
1599
 
        for node, references, value in nodes:
 
1600
 
            builder.add_node(node, references, value)
 
1601
 
        stream = builder.finish()
 
1602
 
        trans = self.get_transport()
 
1603
 
        size = trans.put_file(name, stream)
 
1604
 
        return GraphIndex(trans, name, size)
 
1606
 
    def two_graph_index(self, deltas=False, catch_adds=False):
 
1607
 
        """Build a two-graph index.
 
1609
 
        :param deltas: If true, use underlying indices with two node-ref
 
1610
 
            lists and 'parent' set to a delta-compressed against tail.
 
1612
 
        # build a complex graph across several indices.
 
1614
 
            # delta compression inn the index
 
1615
 
            index1 = self.make_g_index('1', 2, [
 
1616
 
                (('tip', ), 'N0 100', ([('parent', )], [], )),
 
1617
 
                (('tail', ), '', ([], []))])
 
1618
 
            index2 = self.make_g_index('2', 2, [
 
1619
 
                (('parent', ), ' 100 78', ([('tail', ), ('ghost', )], [('tail', )])),
 
1620
 
                (('separate', ), '', ([], []))])
 
1622
 
            # just blob location and graph in the index.
 
1623
 
            index1 = self.make_g_index('1', 1, [
 
1624
 
                (('tip', ), 'N0 100', ([('parent', )], )),
 
1625
 
                (('tail', ), '', ([], ))])
 
1626
 
            index2 = self.make_g_index('2', 1, [
 
1627
 
                (('parent', ), ' 100 78', ([('tail', ), ('ghost', )], )),
 
1628
 
                (('separate', ), '', ([], ))])
 
1629
 
        combined_index = CombinedGraphIndex([index1, index2])
 
1631
 
            self.combined_index = combined_index
 
1632
 
            self.caught_entries = []
 
1633
 
            add_callback = self.catch_add
 
1636
 
        return _KnitGraphIndex(combined_index, lambda:True, deltas=deltas,
 
1637
 
            add_callback=add_callback)
 
1639
 
    def test_keys(self):
 
1640
 
        index = self.two_graph_index()
 
1641
 
        self.assertEqual(set([('tail',), ('tip',), ('parent',), ('separate',)]),
 
1644
 
    def test_get_position(self):
 
1645
 
        index = self.two_graph_index()
 
1646
 
        self.assertEqual((index._graph_index._indices[0], 0, 100), index.get_position(('tip',)))
 
1647
 
        self.assertEqual((index._graph_index._indices[1], 100, 78), index.get_position(('parent',)))
 
1649
 
    def test_get_method_deltas(self):
 
1650
 
        index = self.two_graph_index(deltas=True)
 
1651
 
        self.assertEqual('fulltext', index.get_method(('tip',)))
 
1652
 
        self.assertEqual('line-delta', index.get_method(('parent',)))
 
1654
 
    def test_get_method_no_deltas(self):
 
1655
 
        # check that the parent-history lookup is ignored with deltas=False.
 
1656
 
        index = self.two_graph_index(deltas=False)
 
1657
 
        self.assertEqual('fulltext', index.get_method(('tip',)))
 
1658
 
        self.assertEqual('fulltext', index.get_method(('parent',)))
 
1660
 
    def test_get_options_deltas(self):
 
1661
 
        index = self.two_graph_index(deltas=True)
 
1662
 
        self.assertEqual(['fulltext', 'no-eol'], index.get_options(('tip',)))
 
1663
 
        self.assertEqual(['line-delta'], index.get_options(('parent',)))
 
1665
 
    def test_get_options_no_deltas(self):
 
1666
 
        # check that the parent-history lookup is ignored with deltas=False.
 
1667
 
        index = self.two_graph_index(deltas=False)
 
1668
 
        self.assertEqual(['fulltext', 'no-eol'], index.get_options(('tip',)))
 
1669
 
        self.assertEqual(['fulltext'], index.get_options(('parent',)))
 
1671
 
    def test_get_parent_map(self):
 
1672
 
        index = self.two_graph_index()
 
1673
 
        self.assertEqual({('parent',):(('tail',), ('ghost',))},
 
1674
 
            index.get_parent_map([('parent',), ('ghost',)]))
 
1676
 
    def catch_add(self, entries):
 
1677
 
        self.caught_entries.append(entries)
 
1679
 
    def test_add_no_callback_errors(self):
 
1680
 
        index = self.two_graph_index()
 
1681
 
        self.assertRaises(errors.ReadOnlyError, index.add_records,
 
1682
 
            [(('new',), 'fulltext,no-eol', (None, 50, 60), ['separate'])])
 
1684
 
    def test_add_version_smoke(self):
 
1685
 
        index = self.two_graph_index(catch_adds=True)
 
1686
 
        index.add_records([(('new',), 'fulltext,no-eol', (None, 50, 60),
 
1688
 
        self.assertEqual([[(('new', ), 'N50 60', ((('separate',),),))]],
 
1689
 
            self.caught_entries)
 
1691
 
    def test_add_version_delta_not_delta_index(self):
 
1692
 
        index = self.two_graph_index(catch_adds=True)
 
1693
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
1694
 
            [(('new',), 'no-eol,line-delta', (None, 0, 100), [('parent',)])])
 
1695
 
        self.assertEqual([], self.caught_entries)
 
1697
 
    def test_add_version_same_dup(self):
 
1698
 
        index = self.two_graph_index(catch_adds=True)
 
1699
 
        # options can be spelt two different ways
 
1700
 
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 0, 100), [('parent',)])])
 
1701
 
        index.add_records([(('tip',), 'no-eol,fulltext', (None, 0, 100), [('parent',)])])
 
1702
 
        # position/length are ignored (because each pack could have fulltext or
 
1703
 
        # delta, and be at a different position.
 
1704
 
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 50, 100),
 
1706
 
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 0, 1000),
 
1708
 
        # but neither should have added data:
 
1709
 
        self.assertEqual([[], [], [], []], self.caught_entries)
 
1711
 
    def test_add_version_different_dup(self):
 
1712
 
        index = self.two_graph_index(deltas=True, catch_adds=True)
 
1714
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
1715
 
            [(('tip',), 'line-delta', (None, 0, 100), [('parent',)])])
 
1716
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
1717
 
            [(('tip',), 'fulltext', (None, 0, 100), [('parent',)])])
 
1719
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
1720
 
            [(('tip',), 'fulltext,no-eol', (None, 0, 100), [])])
 
1721
 
        self.assertEqual([], self.caught_entries)
 
1723
 
    def test_add_versions_nodeltas(self):
 
1724
 
        index = self.two_graph_index(catch_adds=True)
 
1726
 
                (('new',), 'fulltext,no-eol', (None, 50, 60), [('separate',)]),
 
1727
 
                (('new2',), 'fulltext', (None, 0, 6), [('new',)]),
 
1729
 
        self.assertEqual([(('new', ), 'N50 60', ((('separate',),),)),
 
1730
 
            (('new2', ), ' 0 6', ((('new',),),))],
 
1731
 
            sorted(self.caught_entries[0]))
 
1732
 
        self.assertEqual(1, len(self.caught_entries))
 
1734
 
    def test_add_versions_deltas(self):
 
1735
 
        index = self.two_graph_index(deltas=True, catch_adds=True)
 
1737
 
                (('new',), 'fulltext,no-eol', (None, 50, 60), [('separate',)]),
 
1738
 
                (('new2',), 'line-delta', (None, 0, 6), [('new',)]),
 
1740
 
        self.assertEqual([(('new', ), 'N50 60', ((('separate',),), ())),
 
1741
 
            (('new2', ), ' 0 6', ((('new',),), (('new',),), ))],
 
1742
 
            sorted(self.caught_entries[0]))
 
1743
 
        self.assertEqual(1, len(self.caught_entries))
 
1745
 
    def test_add_versions_delta_not_delta_index(self):
 
1746
 
        index = self.two_graph_index(catch_adds=True)
 
1747
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
1748
 
            [(('new',), 'no-eol,line-delta', (None, 0, 100), [('parent',)])])
 
1749
 
        self.assertEqual([], self.caught_entries)
 
1751
 
    def test_add_versions_random_id_accepted(self):
 
1752
 
        index = self.two_graph_index(catch_adds=True)
 
1753
 
        index.add_records([], random_id=True)
 
1755
 
    def test_add_versions_same_dup(self):
 
1756
 
        index = self.two_graph_index(catch_adds=True)
 
1757
 
        # options can be spelt two different ways
 
1758
 
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 0, 100),
 
1760
 
        index.add_records([(('tip',), 'no-eol,fulltext', (None, 0, 100),
 
1762
 
        # position/length are ignored (because each pack could have fulltext or
 
1763
 
        # delta, and be at a different position.
 
1764
 
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 50, 100),
 
1766
 
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 0, 1000),
 
1768
 
        # but neither should have added data.
 
1769
 
        self.assertEqual([[], [], [], []], self.caught_entries)
 
1771
 
    def test_add_versions_different_dup(self):
 
1772
 
        index = self.two_graph_index(deltas=True, catch_adds=True)
 
1774
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
1775
 
            [(('tip',), 'line-delta', (None, 0, 100), [('parent',)])])
 
1776
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
1777
 
            [(('tip',), 'fulltext', (None, 0, 100), [('parent',)])])
 
1779
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
1780
 
            [(('tip',), 'fulltext,no-eol', (None, 0, 100), [])])
 
1781
 
        # change options in the second record
 
1782
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
1783
 
            [(('tip',), 'fulltext,no-eol', (None, 0, 100), [('parent',)]),
 
1784
 
             (('tip',), 'line-delta', (None, 0, 100), [('parent',)])])
 
1785
 
        self.assertEqual([], self.caught_entries)
 
1787
 
    def make_g_index_missing_compression_parent(self):
 
1788
 
        graph_index = self.make_g_index('missing_comp', 2,
 
1789
 
            [(('tip', ), ' 100 78',
 
1790
 
              ([('missing-parent', ), ('ghost', )], [('missing-parent', )]))])
 
1793
 
    def make_g_index_missing_parent(self):
 
1794
 
        graph_index = self.make_g_index('missing_parent', 2,
 
1795
 
            [(('parent', ), ' 100 78', ([], [])),
 
1796
 
             (('tip', ), ' 100 78',
 
1797
 
              ([('parent', ), ('missing-parent', )], [('parent', )])),
 
1801
 
    def make_g_index_no_external_refs(self):
 
1802
 
        graph_index = self.make_g_index('no_external_refs', 2,
 
1803
 
            [(('rev', ), ' 100 78',
 
1804
 
              ([('parent', ), ('ghost', )], []))])
 
1807
 
    def test_add_good_unvalidated_index(self):
 
1808
 
        unvalidated = self.make_g_index_no_external_refs()
 
1809
 
        combined = CombinedGraphIndex([unvalidated])
 
1810
 
        index = _KnitGraphIndex(combined, lambda: True, deltas=True)
 
1811
 
        index.scan_unvalidated_index(unvalidated)
 
1812
 
        self.assertEqual(frozenset(), index.get_missing_compression_parents())
 
1814
 
    def test_add_missing_compression_parent_unvalidated_index(self):
 
1815
 
        unvalidated = self.make_g_index_missing_compression_parent()
 
1816
 
        combined = CombinedGraphIndex([unvalidated])
 
1817
 
        index = _KnitGraphIndex(combined, lambda: True, deltas=True)
 
1818
 
        index.scan_unvalidated_index(unvalidated)
 
1819
 
        # This also checks that its only the compression parent that is
 
1820
 
        # examined, otherwise 'ghost' would also be reported as a missing
 
1823
 
            frozenset([('missing-parent',)]),
 
1824
 
            index.get_missing_compression_parents())
 
1826
 
    def test_add_missing_noncompression_parent_unvalidated_index(self):
 
1827
 
        unvalidated = self.make_g_index_missing_parent()
 
1828
 
        combined = CombinedGraphIndex([unvalidated])
 
1829
 
        index = _KnitGraphIndex(combined, lambda: True, deltas=True,
 
1830
 
            track_external_parent_refs=True)
 
1831
 
        index.scan_unvalidated_index(unvalidated)
 
1833
 
            frozenset([('missing-parent',)]), index.get_missing_parents())
 
1835
 
    def test_track_external_parent_refs(self):
 
1836
 
        g_index = self.make_g_index('empty', 2, [])
 
1837
 
        combined = CombinedGraphIndex([g_index])
 
1838
 
        index = _KnitGraphIndex(combined, lambda: True, deltas=True,
 
1839
 
            add_callback=self.catch_add, track_external_parent_refs=True)
 
1840
 
        self.caught_entries = []
 
1842
 
            (('new-key',), 'fulltext,no-eol', (None, 50, 60),
 
1843
 
             [('parent-1',), ('parent-2',)])])
 
1845
 
            frozenset([('parent-1',), ('parent-2',)]),
 
1846
 
            index.get_missing_parents())
 
1848
 
    def test_add_unvalidated_index_with_present_external_references(self):
 
1849
 
        index = self.two_graph_index(deltas=True)
 
1850
 
        # Ugly hack to get at one of the underlying GraphIndex objects that
 
1851
 
        # two_graph_index built.
 
1852
 
        unvalidated = index._graph_index._indices[1]
 
1853
 
        # 'parent' is an external ref of _indices[1] (unvalidated), but is
 
1854
 
        # present in _indices[0].
 
1855
 
        index.scan_unvalidated_index(unvalidated)
 
1856
 
        self.assertEqual(frozenset(), index.get_missing_compression_parents())
 
1858
 
    def make_new_missing_parent_g_index(self, name):
 
1859
 
        missing_parent = name + '-missing-parent'
 
1860
 
        graph_index = self.make_g_index(name, 2,
 
1861
 
            [((name + 'tip', ), ' 100 78',
 
1862
 
              ([(missing_parent, ), ('ghost', )], [(missing_parent, )]))])
 
1865
 
    def test_add_mulitiple_unvalidated_indices_with_missing_parents(self):
 
1866
 
        g_index_1 = self.make_new_missing_parent_g_index('one')
 
1867
 
        g_index_2 = self.make_new_missing_parent_g_index('two')
 
1868
 
        combined = CombinedGraphIndex([g_index_1, g_index_2])
 
1869
 
        index = _KnitGraphIndex(combined, lambda: True, deltas=True)
 
1870
 
        index.scan_unvalidated_index(g_index_1)
 
1871
 
        index.scan_unvalidated_index(g_index_2)
 
1873
 
            frozenset([('one-missing-parent',), ('two-missing-parent',)]),
 
1874
 
            index.get_missing_compression_parents())
 
1876
 
    def test_add_mulitiple_unvalidated_indices_with_mutual_dependencies(self):
 
1877
 
        graph_index_a = self.make_g_index('one', 2,
 
1878
 
            [(('parent-one', ), ' 100 78', ([('non-compression-parent',)], [])),
 
1879
 
             (('child-of-two', ), ' 100 78',
 
1880
 
              ([('parent-two',)], [('parent-two',)]))])
 
1881
 
        graph_index_b = self.make_g_index('two', 2,
 
1882
 
            [(('parent-two', ), ' 100 78', ([('non-compression-parent',)], [])),
 
1883
 
             (('child-of-one', ), ' 100 78',
 
1884
 
              ([('parent-one',)], [('parent-one',)]))])
 
1885
 
        combined = CombinedGraphIndex([graph_index_a, graph_index_b])
 
1886
 
        index = _KnitGraphIndex(combined, lambda: True, deltas=True)
 
1887
 
        index.scan_unvalidated_index(graph_index_a)
 
1888
 
        index.scan_unvalidated_index(graph_index_b)
 
1890
 
            frozenset([]), index.get_missing_compression_parents())
 
1893
 
class TestNoParentsGraphIndexKnit(KnitTests):
 
1894
 
    """Tests for knits using _KnitGraphIndex with no parents."""
 
1896
 
    def make_g_index(self, name, ref_lists=0, nodes=[]):
 
1897
 
        builder = GraphIndexBuilder(ref_lists)
 
1898
 
        for node, references in nodes:
 
1899
 
            builder.add_node(node, references)
 
1900
 
        stream = builder.finish()
 
1901
 
        trans = self.get_transport()
 
1902
 
        size = trans.put_file(name, stream)
 
1903
 
        return GraphIndex(trans, name, size)
 
1905
 
    def test_add_good_unvalidated_index(self):
 
1906
 
        unvalidated = self.make_g_index('unvalidated')
 
1907
 
        combined = CombinedGraphIndex([unvalidated])
 
1908
 
        index = _KnitGraphIndex(combined, lambda: True, parents=False)
 
1909
 
        index.scan_unvalidated_index(unvalidated)
 
1910
 
        self.assertEqual(frozenset(),
 
1911
 
            index.get_missing_compression_parents())
 
1913
 
    def test_parents_deltas_incompatible(self):
 
1914
 
        index = CombinedGraphIndex([])
 
1915
 
        self.assertRaises(errors.KnitError, _KnitGraphIndex, lambda:True,
 
1916
 
            index, deltas=True, parents=False)
 
1918
 
    def two_graph_index(self, catch_adds=False):
 
1919
 
        """Build a two-graph index.
 
1921
 
        :param deltas: If true, use underlying indices with two node-ref
 
1922
 
            lists and 'parent' set to a delta-compressed against tail.
 
1924
 
        # put several versions in the index.
 
1925
 
        index1 = self.make_g_index('1', 0, [
 
1926
 
            (('tip', ), 'N0 100'),
 
1928
 
        index2 = self.make_g_index('2', 0, [
 
1929
 
            (('parent', ), ' 100 78'),
 
1930
 
            (('separate', ), '')])
 
1931
 
        combined_index = CombinedGraphIndex([index1, index2])
 
1933
 
            self.combined_index = combined_index
 
1934
 
            self.caught_entries = []
 
1935
 
            add_callback = self.catch_add
 
1938
 
        return _KnitGraphIndex(combined_index, lambda:True, parents=False,
 
1939
 
            add_callback=add_callback)
 
1941
 
    def test_keys(self):
 
1942
 
        index = self.two_graph_index()
 
1943
 
        self.assertEqual(set([('tail',), ('tip',), ('parent',), ('separate',)]),
 
1946
 
    def test_get_position(self):
 
1947
 
        index = self.two_graph_index()
 
1948
 
        self.assertEqual((index._graph_index._indices[0], 0, 100),
 
1949
 
            index.get_position(('tip',)))
 
1950
 
        self.assertEqual((index._graph_index._indices[1], 100, 78),
 
1951
 
            index.get_position(('parent',)))
 
1953
 
    def test_get_method(self):
 
1954
 
        index = self.two_graph_index()
 
1955
 
        self.assertEqual('fulltext', index.get_method(('tip',)))
 
1956
 
        self.assertEqual(['fulltext'], index.get_options(('parent',)))
 
1958
 
    def test_get_options(self):
 
1959
 
        index = self.two_graph_index()
 
1960
 
        self.assertEqual(['fulltext', 'no-eol'], index.get_options(('tip',)))
 
1961
 
        self.assertEqual(['fulltext'], index.get_options(('parent',)))
 
1963
 
    def test_get_parent_map(self):
 
1964
 
        index = self.two_graph_index()
 
1965
 
        self.assertEqual({('parent',):None},
 
1966
 
            index.get_parent_map([('parent',), ('ghost',)]))
 
1968
 
    def catch_add(self, entries):
 
1969
 
        self.caught_entries.append(entries)
 
1971
 
    def test_add_no_callback_errors(self):
 
1972
 
        index = self.two_graph_index()
 
1973
 
        self.assertRaises(errors.ReadOnlyError, index.add_records,
 
1974
 
            [(('new',), 'fulltext,no-eol', (None, 50, 60), [('separate',)])])
 
1976
 
    def test_add_version_smoke(self):
 
1977
 
        index = self.two_graph_index(catch_adds=True)
 
1978
 
        index.add_records([(('new',), 'fulltext,no-eol', (None, 50, 60), [])])
 
1979
 
        self.assertEqual([[(('new', ), 'N50 60')]],
 
1980
 
            self.caught_entries)
 
1982
 
    def test_add_version_delta_not_delta_index(self):
 
1983
 
        index = self.two_graph_index(catch_adds=True)
 
1984
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
1985
 
            [(('new',), 'no-eol,line-delta', (None, 0, 100), [])])
 
1986
 
        self.assertEqual([], self.caught_entries)
 
1988
 
    def test_add_version_same_dup(self):
 
1989
 
        index = self.two_graph_index(catch_adds=True)
 
1990
 
        # options can be spelt two different ways
 
1991
 
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 0, 100), [])])
 
1992
 
        index.add_records([(('tip',), 'no-eol,fulltext', (None, 0, 100), [])])
 
1993
 
        # position/length are ignored (because each pack could have fulltext or
 
1994
 
        # delta, and be at a different position.
 
1995
 
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 50, 100), [])])
 
1996
 
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 0, 1000), [])])
 
1997
 
        # but neither should have added data.
 
1998
 
        self.assertEqual([[], [], [], []], self.caught_entries)
 
2000
 
    def test_add_version_different_dup(self):
 
2001
 
        index = self.two_graph_index(catch_adds=True)
 
2003
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2004
 
            [(('tip',), 'no-eol,line-delta', (None, 0, 100), [])])
 
2005
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2006
 
            [(('tip',), 'line-delta,no-eol', (None, 0, 100), [])])
 
2007
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2008
 
            [(('tip',), 'fulltext', (None, 0, 100), [])])
 
2010
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2011
 
            [(('tip',), 'fulltext,no-eol', (None, 0, 100), [('parent',)])])
 
2012
 
        self.assertEqual([], self.caught_entries)
 
2014
 
    def test_add_versions(self):
 
2015
 
        index = self.two_graph_index(catch_adds=True)
 
2017
 
                (('new',), 'fulltext,no-eol', (None, 50, 60), []),
 
2018
 
                (('new2',), 'fulltext', (None, 0, 6), []),
 
2020
 
        self.assertEqual([(('new', ), 'N50 60'), (('new2', ), ' 0 6')],
 
2021
 
            sorted(self.caught_entries[0]))
 
2022
 
        self.assertEqual(1, len(self.caught_entries))
 
2024
 
    def test_add_versions_delta_not_delta_index(self):
 
2025
 
        index = self.two_graph_index(catch_adds=True)
 
2026
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2027
 
            [(('new',), 'no-eol,line-delta', (None, 0, 100), [('parent',)])])
 
2028
 
        self.assertEqual([], self.caught_entries)
 
2030
 
    def test_add_versions_parents_not_parents_index(self):
 
2031
 
        index = self.two_graph_index(catch_adds=True)
 
2032
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2033
 
            [(('new',), 'no-eol,fulltext', (None, 0, 100), [('parent',)])])
 
2034
 
        self.assertEqual([], self.caught_entries)
 
2036
 
    def test_add_versions_random_id_accepted(self):
 
2037
 
        index = self.two_graph_index(catch_adds=True)
 
2038
 
        index.add_records([], random_id=True)
 
2040
 
    def test_add_versions_same_dup(self):
 
2041
 
        index = self.two_graph_index(catch_adds=True)
 
2042
 
        # options can be spelt two different ways
 
2043
 
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 0, 100), [])])
 
2044
 
        index.add_records([(('tip',), 'no-eol,fulltext', (None, 0, 100), [])])
 
2045
 
        # position/length are ignored (because each pack could have fulltext or
 
2046
 
        # delta, and be at a different position.
 
2047
 
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 50, 100), [])])
 
2048
 
        index.add_records([(('tip',), 'fulltext,no-eol', (None, 0, 1000), [])])
 
2049
 
        # but neither should have added data.
 
2050
 
        self.assertEqual([[], [], [], []], self.caught_entries)
 
2052
 
    def test_add_versions_different_dup(self):
 
2053
 
        index = self.two_graph_index(catch_adds=True)
 
2055
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2056
 
            [(('tip',), 'no-eol,line-delta', (None, 0, 100), [])])
 
2057
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2058
 
            [(('tip',), 'line-delta,no-eol', (None, 0, 100), [])])
 
2059
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2060
 
            [(('tip',), 'fulltext', (None, 0, 100), [])])
 
2062
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2063
 
            [(('tip',), 'fulltext,no-eol', (None, 0, 100), [('parent',)])])
 
2064
 
        # change options in the second record
 
2065
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
 
2066
 
            [(('tip',), 'fulltext,no-eol', (None, 0, 100), []),
 
2067
 
             (('tip',), 'no-eol,line-delta', (None, 0, 100), [])])
 
2068
 
        self.assertEqual([], self.caught_entries)
 
2071
 
class TestKnitVersionedFiles(KnitTests):
 
2073
 
    def assertGroupKeysForIo(self, exp_groups, keys, non_local_keys,
 
2074
 
                             positions, _min_buffer_size=None):
 
2075
 
        kvf = self.make_test_knit()
 
2076
 
        if _min_buffer_size is None:
 
2077
 
            _min_buffer_size = knit._STREAM_MIN_BUFFER_SIZE
 
2078
 
        self.assertEqual(exp_groups, kvf._group_keys_for_io(keys,
 
2079
 
                                        non_local_keys, positions,
 
2080
 
                                        _min_buffer_size=_min_buffer_size))
 
2082
 
    def assertSplitByPrefix(self, expected_map, expected_prefix_order,
 
2084
 
        split, prefix_order = KnitVersionedFiles._split_by_prefix(keys)
 
2085
 
        self.assertEqual(expected_map, split)
 
2086
 
        self.assertEqual(expected_prefix_order, prefix_order)
 
2088
 
    def test__group_keys_for_io(self):
 
2089
 
        ft_detail = ('fulltext', False)
 
2090
 
        ld_detail = ('line-delta', False)
 
2098
 
            f_a: (ft_detail, (f_a, 0, 100), None),
 
2099
 
            f_b: (ld_detail, (f_b, 100, 21), f_a),
 
2100
 
            f_c: (ld_detail, (f_c, 180, 15), f_b),
 
2101
 
            g_a: (ft_detail, (g_a, 121, 35), None),
 
2102
 
            g_b: (ld_detail, (g_b, 156, 12), g_a),
 
2103
 
            g_c: (ld_detail, (g_c, 195, 13), g_a),
 
2105
 
        self.assertGroupKeysForIo([([f_a], set())],
 
2106
 
                                  [f_a], [], positions)
 
2107
 
        self.assertGroupKeysForIo([([f_a], set([f_a]))],
 
2108
 
                                  [f_a], [f_a], positions)
 
2109
 
        self.assertGroupKeysForIo([([f_a, f_b], set([]))],
 
2110
 
                                  [f_a, f_b], [], positions)
 
2111
 
        self.assertGroupKeysForIo([([f_a, f_b], set([f_b]))],
 
2112
 
                                  [f_a, f_b], [f_b], positions)
 
2113
 
        self.assertGroupKeysForIo([([f_a, f_b, g_a, g_b], set())],
 
2114
 
                                  [f_a, g_a, f_b, g_b], [], positions)
 
2115
 
        self.assertGroupKeysForIo([([f_a, f_b, g_a, g_b], set())],
 
2116
 
                                  [f_a, g_a, f_b, g_b], [], positions,
 
2117
 
                                  _min_buffer_size=150)
 
2118
 
        self.assertGroupKeysForIo([([f_a, f_b], set()), ([g_a, g_b], set())],
 
2119
 
                                  [f_a, g_a, f_b, g_b], [], positions,
 
2120
 
                                  _min_buffer_size=100)
 
2121
 
        self.assertGroupKeysForIo([([f_c], set()), ([g_b], set())],
 
2122
 
                                  [f_c, g_b], [], positions,
 
2123
 
                                  _min_buffer_size=125)
 
2124
 
        self.assertGroupKeysForIo([([g_b, f_c], set())],
 
2125
 
                                  [g_b, f_c], [], positions,
 
2126
 
                                  _min_buffer_size=125)
 
2128
 
    def test__split_by_prefix(self):
 
2129
 
        self.assertSplitByPrefix({'f': [('f', 'a'), ('f', 'b')],
 
2130
 
                                  'g': [('g', 'b'), ('g', 'a')],
 
2132
 
                                 [('f', 'a'), ('g', 'b'),
 
2133
 
                                  ('g', 'a'), ('f', 'b')])
 
2135
 
        self.assertSplitByPrefix({'f': [('f', 'a'), ('f', 'b')],
 
2136
 
                                  'g': [('g', 'b'), ('g', 'a')],
 
2138
 
                                 [('f', 'a'), ('f', 'b'),
 
2139
 
                                  ('g', 'b'), ('g', 'a')])
 
2141
 
        self.assertSplitByPrefix({'f': [('f', 'a'), ('f', 'b')],
 
2142
 
                                  'g': [('g', 'b'), ('g', 'a')],
 
2144
 
                                 [('f', 'a'), ('f', 'b'),
 
2145
 
                                  ('g', 'b'), ('g', 'a')])
 
2147
 
        self.assertSplitByPrefix({'f': [('f', 'a'), ('f', 'b')],
 
2148
 
                                  'g': [('g', 'b'), ('g', 'a')],
 
2149
 
                                  '': [('a',), ('b',)]
 
2151
 
                                 [('f', 'a'), ('g', 'b'),
 
2153
 
                                  ('g', 'a'), ('f', 'b')])
 
2156
 
class TestStacking(KnitTests):
 
2158
 
    def get_basis_and_test_knit(self):
 
2159
 
        basis = self.make_test_knit(name='basis')
 
2160
 
        basis = RecordingVersionedFilesDecorator(basis)
 
2161
 
        test = self.make_test_knit(name='test')
 
2162
 
        test.add_fallback_versioned_files(basis)
 
2165
 
    def test_add_fallback_versioned_files(self):
 
2166
 
        basis = self.make_test_knit(name='basis')
 
2167
 
        test = self.make_test_knit(name='test')
 
2168
 
        # It must not error; other tests test that the fallback is referred to
 
2169
 
        # when accessing data.
 
2170
 
        test.add_fallback_versioned_files(basis)
 
2172
 
    def test_add_lines(self):
 
2173
 
        # lines added to the test are not added to the basis
 
2174
 
        basis, test = self.get_basis_and_test_knit()
 
2176
 
        key_basis = ('bar',)
 
2177
 
        key_cross_border = ('quux',)
 
2178
 
        key_delta = ('zaphod',)
 
2179
 
        test.add_lines(key, (), ['foo\n'])
 
2180
 
        self.assertEqual({}, basis.get_parent_map([key]))
 
2181
 
        # lines added to the test that reference across the stack do a
 
2183
 
        basis.add_lines(key_basis, (), ['foo\n'])
 
2185
 
        test.add_lines(key_cross_border, (key_basis,), ['foo\n'])
 
2186
 
        self.assertEqual('fulltext', test._index.get_method(key_cross_border))
 
2187
 
        # we don't even need to look at the basis to see that this should be
 
2188
 
        # stored as a fulltext
 
2189
 
        self.assertEqual([], basis.calls)
 
2190
 
        # Subsequent adds do delta.
 
2192
 
        test.add_lines(key_delta, (key_cross_border,), ['foo\n'])
 
2193
 
        self.assertEqual('line-delta', test._index.get_method(key_delta))
 
2194
 
        self.assertEqual([], basis.calls)
 
2196
 
    def test_annotate(self):
 
2197
 
        # annotations from the test knit are answered without asking the basis
 
2198
 
        basis, test = self.get_basis_and_test_knit()
 
2200
 
        key_basis = ('bar',)
 
2201
 
        key_missing = ('missing',)
 
2202
 
        test.add_lines(key, (), ['foo\n'])
 
2203
 
        details = test.annotate(key)
 
2204
 
        self.assertEqual([(key, 'foo\n')], details)
 
2205
 
        self.assertEqual([], basis.calls)
 
2206
 
        # But texts that are not in the test knit are looked for in the basis
 
2208
 
        basis.add_lines(key_basis, (), ['foo\n', 'bar\n'])
 
2210
 
        details = test.annotate(key_basis)
 
2211
 
        self.assertEqual([(key_basis, 'foo\n'), (key_basis, 'bar\n')], details)
 
2212
 
        # Not optimised to date:
 
2213
 
        # self.assertEqual([("annotate", key_basis)], basis.calls)
 
2214
 
        self.assertEqual([('get_parent_map', set([key_basis])),
 
2215
 
            ('get_parent_map', set([key_basis])),
 
2216
 
            ('get_record_stream', [key_basis], 'topological', True)],
 
2219
 
    def test_check(self):
 
2220
 
        # At the moment checking a stacked knit does implicitly check the
 
2222
 
        basis, test = self.get_basis_and_test_knit()
 
2225
 
    def test_get_parent_map(self):
 
2226
 
        # parents in the test knit are answered without asking the basis
 
2227
 
        basis, test = self.get_basis_and_test_knit()
 
2229
 
        key_basis = ('bar',)
 
2230
 
        key_missing = ('missing',)
 
2231
 
        test.add_lines(key, (), [])
 
2232
 
        parent_map = test.get_parent_map([key])
 
2233
 
        self.assertEqual({key: ()}, parent_map)
 
2234
 
        self.assertEqual([], basis.calls)
 
2235
 
        # But parents that are not in the test knit are looked for in the basis
 
2236
 
        basis.add_lines(key_basis, (), [])
 
2238
 
        parent_map = test.get_parent_map([key, key_basis, key_missing])
 
2239
 
        self.assertEqual({key: (),
 
2240
 
            key_basis: ()}, parent_map)
 
2241
 
        self.assertEqual([("get_parent_map", set([key_basis, key_missing]))],
 
2244
 
    def test_get_record_stream_unordered_fulltexts(self):
 
2245
 
        # records from the test knit are answered without asking the basis:
 
2246
 
        basis, test = self.get_basis_and_test_knit()
 
2248
 
        key_basis = ('bar',)
 
2249
 
        key_missing = ('missing',)
 
2250
 
        test.add_lines(key, (), ['foo\n'])
 
2251
 
        records = list(test.get_record_stream([key], 'unordered', True))
 
2252
 
        self.assertEqual(1, len(records))
 
2253
 
        self.assertEqual([], basis.calls)
 
2254
 
        # Missing (from test knit) objects are retrieved from the basis:
 
2255
 
        basis.add_lines(key_basis, (), ['foo\n', 'bar\n'])
 
2257
 
        records = list(test.get_record_stream([key_basis, key_missing],
 
2259
 
        self.assertEqual(2, len(records))
 
2260
 
        calls = list(basis.calls)
 
2261
 
        for record in records:
 
2262
 
            self.assertSubset([record.key], (key_basis, key_missing))
 
2263
 
            if record.key == key_missing:
 
2264
 
                self.assertIsInstance(record, AbsentContentFactory)
 
2266
 
                reference = list(basis.get_record_stream([key_basis],
 
2267
 
                    'unordered', True))[0]
 
2268
 
                self.assertEqual(reference.key, record.key)
 
2269
 
                self.assertEqual(reference.sha1, record.sha1)
 
2270
 
                self.assertEqual(reference.storage_kind, record.storage_kind)
 
2271
 
                self.assertEqual(reference.get_bytes_as(reference.storage_kind),
 
2272
 
                    record.get_bytes_as(record.storage_kind))
 
2273
 
                self.assertEqual(reference.get_bytes_as('fulltext'),
 
2274
 
                    record.get_bytes_as('fulltext'))
 
2275
 
        # It's not strictly minimal, but it seems reasonable for now for it to
 
2276
 
        # ask which fallbacks have which parents.
 
2278
 
            ("get_parent_map", set([key_basis, key_missing])),
 
2279
 
            ("get_record_stream", [key_basis], 'unordered', True)],
 
2282
 
    def test_get_record_stream_ordered_fulltexts(self):
 
2283
 
        # ordering is preserved down into the fallback store.
 
2284
 
        basis, test = self.get_basis_and_test_knit()
 
2286
 
        key_basis = ('bar',)
 
2287
 
        key_basis_2 = ('quux',)
 
2288
 
        key_missing = ('missing',)
 
2289
 
        test.add_lines(key, (key_basis,), ['foo\n'])
 
2290
 
        # Missing (from test knit) objects are retrieved from the basis:
 
2291
 
        basis.add_lines(key_basis, (key_basis_2,), ['foo\n', 'bar\n'])
 
2292
 
        basis.add_lines(key_basis_2, (), ['quux\n'])
 
2294
 
        # ask for in non-topological order
 
2295
 
        records = list(test.get_record_stream(
 
2296
 
            [key, key_basis, key_missing, key_basis_2], 'topological', True))
 
2297
 
        self.assertEqual(4, len(records))
 
2299
 
        for record in records:
 
2300
 
            self.assertSubset([record.key],
 
2301
 
                (key_basis, key_missing, key_basis_2, key))
 
2302
 
            if record.key == key_missing:
 
2303
 
                self.assertIsInstance(record, AbsentContentFactory)
 
2305
 
                results.append((record.key, record.sha1, record.storage_kind,
 
2306
 
                    record.get_bytes_as('fulltext')))
 
2307
 
        calls = list(basis.calls)
 
2308
 
        order = [record[0] for record in results]
 
2309
 
        self.assertEqual([key_basis_2, key_basis, key], order)
 
2310
 
        for result in results:
 
2311
 
            if result[0] == key:
 
2315
 
            record = source.get_record_stream([result[0]], 'unordered',
 
2317
 
            self.assertEqual(record.key, result[0])
 
2318
 
            self.assertEqual(record.sha1, result[1])
 
2319
 
            # We used to check that the storage kind matched, but actually it
 
2320
 
            # depends on whether it was sourced from the basis, or in a single
 
2321
 
            # group, because asking for full texts returns proxy objects to a
 
2322
 
            # _ContentMapGenerator object; so checking the kind is unneeded.
 
2323
 
            self.assertEqual(record.get_bytes_as('fulltext'), result[3])
 
2324
 
        # It's not strictly minimal, but it seems reasonable for now for it to
 
2325
 
        # ask which fallbacks have which parents.
 
2327
 
            ("get_parent_map", set([key_basis, key_basis_2, key_missing])),
 
2328
 
            # topological is requested from the fallback, because that is what
 
2329
 
            # was requested at the top level.
 
2330
 
            ("get_record_stream", [key_basis_2, key_basis], 'topological', True)],
 
2333
 
    def test_get_record_stream_unordered_deltas(self):
 
2334
 
        # records from the test knit are answered without asking the basis:
 
2335
 
        basis, test = self.get_basis_and_test_knit()
 
2337
 
        key_basis = ('bar',)
 
2338
 
        key_missing = ('missing',)
 
2339
 
        test.add_lines(key, (), ['foo\n'])
 
2340
 
        records = list(test.get_record_stream([key], 'unordered', False))
 
2341
 
        self.assertEqual(1, len(records))
 
2342
 
        self.assertEqual([], basis.calls)
 
2343
 
        # Missing (from test knit) objects are retrieved from the basis:
 
2344
 
        basis.add_lines(key_basis, (), ['foo\n', 'bar\n'])
 
2346
 
        records = list(test.get_record_stream([key_basis, key_missing],
 
2347
 
            'unordered', False))
 
2348
 
        self.assertEqual(2, len(records))
 
2349
 
        calls = list(basis.calls)
 
2350
 
        for record in records:
 
2351
 
            self.assertSubset([record.key], (key_basis, key_missing))
 
2352
 
            if record.key == key_missing:
 
2353
 
                self.assertIsInstance(record, AbsentContentFactory)
 
2355
 
                reference = list(basis.get_record_stream([key_basis],
 
2356
 
                    'unordered', False))[0]
 
2357
 
                self.assertEqual(reference.key, record.key)
 
2358
 
                self.assertEqual(reference.sha1, record.sha1)
 
2359
 
                self.assertEqual(reference.storage_kind, record.storage_kind)
 
2360
 
                self.assertEqual(reference.get_bytes_as(reference.storage_kind),
 
2361
 
                    record.get_bytes_as(record.storage_kind))
 
2362
 
        # It's not strictly minimal, but it seems reasonable for now for it to
 
2363
 
        # ask which fallbacks have which parents.
 
2365
 
            ("get_parent_map", set([key_basis, key_missing])),
 
2366
 
            ("get_record_stream", [key_basis], 'unordered', False)],
 
2369
 
    def test_get_record_stream_ordered_deltas(self):
 
2370
 
        # ordering is preserved down into the fallback store.
 
2371
 
        basis, test = self.get_basis_and_test_knit()
 
2373
 
        key_basis = ('bar',)
 
2374
 
        key_basis_2 = ('quux',)
 
2375
 
        key_missing = ('missing',)
 
2376
 
        test.add_lines(key, (key_basis,), ['foo\n'])
 
2377
 
        # Missing (from test knit) objects are retrieved from the basis:
 
2378
 
        basis.add_lines(key_basis, (key_basis_2,), ['foo\n', 'bar\n'])
 
2379
 
        basis.add_lines(key_basis_2, (), ['quux\n'])
 
2381
 
        # ask for in non-topological order
 
2382
 
        records = list(test.get_record_stream(
 
2383
 
            [key, key_basis, key_missing, key_basis_2], 'topological', False))
 
2384
 
        self.assertEqual(4, len(records))
 
2386
 
        for record in records:
 
2387
 
            self.assertSubset([record.key],
 
2388
 
                (key_basis, key_missing, key_basis_2, key))
 
2389
 
            if record.key == key_missing:
 
2390
 
                self.assertIsInstance(record, AbsentContentFactory)
 
2392
 
                results.append((record.key, record.sha1, record.storage_kind,
 
2393
 
                    record.get_bytes_as(record.storage_kind)))
 
2394
 
        calls = list(basis.calls)
 
2395
 
        order = [record[0] for record in results]
 
2396
 
        self.assertEqual([key_basis_2, key_basis, key], order)
 
2397
 
        for result in results:
 
2398
 
            if result[0] == key:
 
2402
 
            record = source.get_record_stream([result[0]], 'unordered',
 
2404
 
            self.assertEqual(record.key, result[0])
 
2405
 
            self.assertEqual(record.sha1, result[1])
 
2406
 
            self.assertEqual(record.storage_kind, result[2])
 
2407
 
            self.assertEqual(record.get_bytes_as(record.storage_kind), result[3])
 
2408
 
        # It's not strictly minimal, but it seems reasonable for now for it to
 
2409
 
        # ask which fallbacks have which parents.
 
2411
 
            ("get_parent_map", set([key_basis, key_basis_2, key_missing])),
 
2412
 
            ("get_record_stream", [key_basis_2, key_basis], 'topological', False)],
 
2415
 
    def test_get_sha1s(self):
 
2416
 
        # sha1's in the test knit are answered without asking the basis
 
2417
 
        basis, test = self.get_basis_and_test_knit()
 
2419
 
        key_basis = ('bar',)
 
2420
 
        key_missing = ('missing',)
 
2421
 
        test.add_lines(key, (), ['foo\n'])
 
2422
 
        key_sha1sum = osutils.sha('foo\n').hexdigest()
 
2423
 
        sha1s = test.get_sha1s([key])
 
2424
 
        self.assertEqual({key: key_sha1sum}, sha1s)
 
2425
 
        self.assertEqual([], basis.calls)
 
2426
 
        # But texts that are not in the test knit are looked for in the basis
 
2427
 
        # directly (rather than via text reconstruction) so that remote servers
 
2428
 
        # etc don't have to answer with full content.
 
2429
 
        basis.add_lines(key_basis, (), ['foo\n', 'bar\n'])
 
2430
 
        basis_sha1sum = osutils.sha('foo\nbar\n').hexdigest()
 
2432
 
        sha1s = test.get_sha1s([key, key_missing, key_basis])
 
2433
 
        self.assertEqual({key: key_sha1sum,
 
2434
 
            key_basis: basis_sha1sum}, sha1s)
 
2435
 
        self.assertEqual([("get_sha1s", set([key_basis, key_missing]))],
 
2438
 
    def test_insert_record_stream(self):
 
2439
 
        # records are inserted as normal; insert_record_stream builds on
 
2440
 
        # add_lines, so a smoke test should be all that's needed:
 
2442
 
        key_basis = ('bar',)
 
2443
 
        key_delta = ('zaphod',)
 
2444
 
        basis, test = self.get_basis_and_test_knit()
 
2445
 
        source = self.make_test_knit(name='source')
 
2446
 
        basis.add_lines(key_basis, (), ['foo\n'])
 
2448
 
        source.add_lines(key_basis, (), ['foo\n'])
 
2449
 
        source.add_lines(key_delta, (key_basis,), ['bar\n'])
 
2450
 
        stream = source.get_record_stream([key_delta], 'unordered', False)
 
2451
 
        test.insert_record_stream(stream)
 
2452
 
        # XXX: this does somewhat too many calls in making sure of whether it
 
2453
 
        # has to recreate the full text.
 
2454
 
        self.assertEqual([("get_parent_map", set([key_basis])),
 
2455
 
             ('get_parent_map', set([key_basis])),
 
2456
 
             ('get_record_stream', [key_basis], 'unordered', True)],
 
2458
 
        self.assertEqual({key_delta:(key_basis,)},
 
2459
 
            test.get_parent_map([key_delta]))
 
2460
 
        self.assertEqual('bar\n', test.get_record_stream([key_delta],
 
2461
 
            'unordered', True).next().get_bytes_as('fulltext'))
 
2463
 
    def test_iter_lines_added_or_present_in_keys(self):
 
2464
 
        # Lines from the basis are returned, and lines for a given key are only
 
2468
 
        # all sources are asked for keys:
 
2469
 
        basis, test = self.get_basis_and_test_knit()
 
2470
 
        basis.add_lines(key1, (), ["foo"])
 
2472
 
        lines = list(test.iter_lines_added_or_present_in_keys([key1]))
 
2473
 
        self.assertEqual([("foo\n", key1)], lines)
 
2474
 
        self.assertEqual([("iter_lines_added_or_present_in_keys", set([key1]))],
 
2476
 
        # keys in both are not duplicated:
 
2477
 
        test.add_lines(key2, (), ["bar\n"])
 
2478
 
        basis.add_lines(key2, (), ["bar\n"])
 
2480
 
        lines = list(test.iter_lines_added_or_present_in_keys([key2]))
 
2481
 
        self.assertEqual([("bar\n", key2)], lines)
 
2482
 
        self.assertEqual([], basis.calls)
 
2484
 
    def test_keys(self):
 
2487
 
        # all sources are asked for keys:
 
2488
 
        basis, test = self.get_basis_and_test_knit()
 
2490
 
        self.assertEqual(set(), set(keys))
 
2491
 
        self.assertEqual([("keys",)], basis.calls)
 
2492
 
        # keys from a basis are returned:
 
2493
 
        basis.add_lines(key1, (), [])
 
2496
 
        self.assertEqual(set([key1]), set(keys))
 
2497
 
        self.assertEqual([("keys",)], basis.calls)
 
2498
 
        # keys in both are not duplicated:
 
2499
 
        test.add_lines(key2, (), [])
 
2500
 
        basis.add_lines(key2, (), [])
 
2503
 
        self.assertEqual(2, len(keys))
 
2504
 
        self.assertEqual(set([key1, key2]), set(keys))
 
2505
 
        self.assertEqual([("keys",)], basis.calls)
 
2507
 
    def test_add_mpdiffs(self):
 
2508
 
        # records are inserted as normal; add_mpdiff builds on
 
2509
 
        # add_lines, so a smoke test should be all that's needed:
 
2511
 
        key_basis = ('bar',)
 
2512
 
        key_delta = ('zaphod',)
 
2513
 
        basis, test = self.get_basis_and_test_knit()
 
2514
 
        source = self.make_test_knit(name='source')
 
2515
 
        basis.add_lines(key_basis, (), ['foo\n'])
 
2517
 
        source.add_lines(key_basis, (), ['foo\n'])
 
2518
 
        source.add_lines(key_delta, (key_basis,), ['bar\n'])
 
2519
 
        diffs = source.make_mpdiffs([key_delta])
 
2520
 
        test.add_mpdiffs([(key_delta, (key_basis,),
 
2521
 
            source.get_sha1s([key_delta])[key_delta], diffs[0])])
 
2522
 
        self.assertEqual([("get_parent_map", set([key_basis])),
 
2523
 
            ('get_record_stream', [key_basis], 'unordered', True),],
 
2525
 
        self.assertEqual({key_delta:(key_basis,)},
 
2526
 
            test.get_parent_map([key_delta]))
 
2527
 
        self.assertEqual('bar\n', test.get_record_stream([key_delta],
 
2528
 
            'unordered', True).next().get_bytes_as('fulltext'))
 
2530
 
    def test_make_mpdiffs(self):
 
2531
 
        # Generating an mpdiff across a stacking boundary should detect parent
 
2535
 
        key_right = ('zaphod',)
 
2536
 
        basis, test = self.get_basis_and_test_knit()
 
2537
 
        basis.add_lines(key_left, (), ['bar\n'])
 
2538
 
        basis.add_lines(key_right, (), ['zaphod\n'])
 
2540
 
        test.add_lines(key, (key_left, key_right),
 
2541
 
            ['bar\n', 'foo\n', 'zaphod\n'])
 
2542
 
        diffs = test.make_mpdiffs([key])
 
2544
 
            multiparent.MultiParent([multiparent.ParentText(0, 0, 0, 1),
 
2545
 
                multiparent.NewText(['foo\n']),
 
2546
 
                multiparent.ParentText(1, 0, 2, 1)])],
 
2548
 
        self.assertEqual(3, len(basis.calls))
 
2550
 
            ("get_parent_map", set([key_left, key_right])),
 
2551
 
            ("get_parent_map", set([key_left, key_right])),
 
2554
 
        last_call = basis.calls[-1]
 
2555
 
        self.assertEqual('get_record_stream', last_call[0])
 
2556
 
        self.assertEqual(set([key_left, key_right]), set(last_call[1]))
 
2557
 
        self.assertEqual('topological', last_call[2])
 
2558
 
        self.assertEqual(True, last_call[3])
 
2561
 
class TestNetworkBehaviour(KnitTests):
 
2562
 
    """Tests for getting data out of/into knits over the network."""
 
2564
 
    def test_include_delta_closure_generates_a_knit_delta_closure(self):
 
2565
 
        vf = self.make_test_knit(name='test')
 
2566
 
        # put in three texts, giving ft, delta, delta
 
2567
 
        vf.add_lines(('base',), (), ['base\n', 'content\n'])
 
2568
 
        vf.add_lines(('d1',), (('base',),), ['d1\n'])
 
2569
 
        vf.add_lines(('d2',), (('d1',),), ['d2\n'])
 
2570
 
        # But heuristics could interfere, so check what happened:
 
2571
 
        self.assertEqual(['knit-ft-gz', 'knit-delta-gz', 'knit-delta-gz'],
 
2572
 
            [record.storage_kind for record in
 
2573
 
             vf.get_record_stream([('base',), ('d1',), ('d2',)],
 
2574
 
                'topological', False)])
 
2575
 
        # generate a stream of just the deltas include_delta_closure=True,
 
2576
 
        # serialise to the network, and check that we get a delta closure on the wire.
 
2577
 
        stream = vf.get_record_stream([('d1',), ('d2',)], 'topological', True)
 
2578
 
        netb = [record.get_bytes_as(record.storage_kind) for record in stream]
 
2579
 
        # The first bytes should be a memo from _ContentMapGenerator, and the
 
2580
 
        # second bytes should be empty (because its a API proxy not something
 
2581
 
        # for wire serialisation.
 
2582
 
        self.assertEqual('', netb[1])
 
2584
 
        kind, line_end = network_bytes_to_kind_and_offset(bytes)
 
2585
 
        self.assertEqual('knit-delta-closure', kind)
 
2588
 
class TestContentMapGenerator(KnitTests):
 
2589
 
    """Tests for ContentMapGenerator"""
 
2591
 
    def test_get_record_stream_gives_records(self):
 
2592
 
        vf = self.make_test_knit(name='test')
 
2593
 
        # put in three texts, giving ft, delta, delta
 
2594
 
        vf.add_lines(('base',), (), ['base\n', 'content\n'])
 
2595
 
        vf.add_lines(('d1',), (('base',),), ['d1\n'])
 
2596
 
        vf.add_lines(('d2',), (('d1',),), ['d2\n'])
 
2597
 
        keys = [('d1',), ('d2',)]
 
2598
 
        generator = _VFContentMapGenerator(vf, keys,
 
2599
 
            global_map=vf.get_parent_map(keys))
 
2600
 
        for record in generator.get_record_stream():
 
2601
 
            if record.key == ('d1',):
 
2602
 
                self.assertEqual('d1\n', record.get_bytes_as('fulltext'))
 
2604
 
                self.assertEqual('d2\n', record.get_bytes_as('fulltext'))
 
2606
 
    def test_get_record_stream_kinds_are_raw(self):
 
2607
 
        vf = self.make_test_knit(name='test')
 
2608
 
        # put in three texts, giving ft, delta, delta
 
2609
 
        vf.add_lines(('base',), (), ['base\n', 'content\n'])
 
2610
 
        vf.add_lines(('d1',), (('base',),), ['d1\n'])
 
2611
 
        vf.add_lines(('d2',), (('d1',),), ['d2\n'])
 
2612
 
        keys = [('base',), ('d1',), ('d2',)]
 
2613
 
        generator = _VFContentMapGenerator(vf, keys,
 
2614
 
            global_map=vf.get_parent_map(keys))
 
2615
 
        kinds = {('base',): 'knit-delta-closure',
 
2616
 
            ('d1',): 'knit-delta-closure-ref',
 
2617
 
            ('d2',): 'knit-delta-closure-ref',
 
2619
 
        for record in generator.get_record_stream():
 
2620
 
            self.assertEqual(kinds[record.key], record.storage_kind)
 
 
1224
        self.assertRaises(KnitHeaderError, self.make_test_knit)