~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_knit.py

  • Committer: Ian Clatworthy
  • Date: 2008-03-27 07:51:10 UTC
  • mto: (3311.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3312.
  • Revision ID: ian.clatworthy@canonical.com-20080327075110-afgd7x03ybju06ez
Reduce evangelism in the User Guide

Show diffs side-by-side

added added

removed removed

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