/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_knit.py

  • Committer: Andrew Bennetts
  • Date: 2008-03-28 08:58:43 UTC
  • mto: This revision was merged to the branch mainline in revision 3321.
  • Revision ID: andrew.bennetts@canonical.com-20080328085843-pdstuawpwy1hst6r
Deprecate Transport.get_shared_medium.

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_ancestry(self):
 
632
        transport = MockTransport([
 
633
            _KnitIndex.HEADER,
 
634
            "a option 0 1 :",
 
635
            "b option 0 1 0 .e :",
 
636
            "c option 0 1 1 0 :",
 
637
            "d option 0 1 2 .f :"
 
638
            ])
 
639
        index = self.get_knit_index(transport, "filename", "r")
 
640
 
 
641
        self.assertEqual([], index.get_ancestry([]))
 
642
        self.assertEqual(["a"], index.get_ancestry(["a"]))
 
643
        self.assertEqual(["a", "b"], index.get_ancestry(["b"]))
 
644
        self.assertEqual(["a", "b", "c"], index.get_ancestry(["c"]))
 
645
        self.assertEqual(["a", "b", "c", "d"], index.get_ancestry(["d"]))
 
646
        self.assertEqual(["a", "b"], index.get_ancestry(["a", "b"]))
 
647
        self.assertEqual(["a", "b", "c"], index.get_ancestry(["a", "c"]))
 
648
 
 
649
        self.assertRaises(RevisionNotPresent, index.get_ancestry, ["e"])
 
650
 
 
651
    def test_get_ancestry_with_ghosts(self):
 
652
        transport = MockTransport([
 
653
            _KnitIndex.HEADER,
 
654
            "a option 0 1 :",
 
655
            "b option 0 1 0 .e :",
 
656
            "c option 0 1 0 .f .g :",
 
657
            "d option 0 1 2 .h .j .k :"
 
658
            ])
 
659
        index = self.get_knit_index(transport, "filename", "r")
 
660
 
 
661
        self.assertEqual([], index.get_ancestry_with_ghosts([]))
 
662
        self.assertEqual(["a"], index.get_ancestry_with_ghosts(["a"]))
 
663
        self.assertEqual(["a", "e", "b"],
 
664
            index.get_ancestry_with_ghosts(["b"]))
 
665
        self.assertEqual(["a", "g", "f", "c"],
 
666
            index.get_ancestry_with_ghosts(["c"]))
 
667
        self.assertEqual(["a", "g", "f", "c", "k", "j", "h", "d"],
 
668
            index.get_ancestry_with_ghosts(["d"]))
 
669
        self.assertEqual(["a", "e", "b"],
 
670
            index.get_ancestry_with_ghosts(["a", "b"]))
 
671
        self.assertEqual(["a", "g", "f", "c"],
 
672
            index.get_ancestry_with_ghosts(["a", "c"]))
 
673
        self.assertEqual(
 
674
            ["a", "g", "f", "c", "e", "b", "k", "j", "h", "d"],
 
675
            index.get_ancestry_with_ghosts(["b", "d"]))
 
676
 
 
677
        self.assertRaises(RevisionNotPresent,
 
678
            index.get_ancestry_with_ghosts, ["e"])
 
679
 
 
680
    def test_iter_parents(self):
 
681
        transport = MockTransport()
 
682
        index = self.get_knit_index(transport, "filename", "w", create=True)
 
683
        # no parents
 
684
        index.add_version('r0', ['option'], (None, 0, 1), [])
 
685
        # 1 parent
 
686
        index.add_version('r1', ['option'], (None, 0, 1), ['r0'])
 
687
        # 2 parents
 
688
        index.add_version('r2', ['option'], (None, 0, 1), ['r1', 'r0'])
 
689
        # XXX TODO a ghost
 
690
        # cases: each sample data individually:
 
691
        self.assertEqual(set([('r0', ())]),
 
692
            set(index.iter_parents(['r0'])))
 
693
        self.assertEqual(set([('r1', ('r0', ))]),
 
694
            set(index.iter_parents(['r1'])))
 
695
        self.assertEqual(set([('r2', ('r1', 'r0'))]),
 
696
            set(index.iter_parents(['r2'])))
 
697
        # no nodes returned for a missing node
 
698
        self.assertEqual(set(),
 
699
            set(index.iter_parents(['missing'])))
 
700
        # 1 node returned with missing nodes skipped
 
701
        self.assertEqual(set([('r1', ('r0', ))]),
 
702
            set(index.iter_parents(['ghost1', 'r1', 'ghost'])))
 
703
        # 2 nodes returned
 
704
        self.assertEqual(set([('r0', ()), ('r1', ('r0', ))]),
 
705
            set(index.iter_parents(['r0', 'r1'])))
 
706
        # 2 nodes returned, missing skipped
 
707
        self.assertEqual(set([('r0', ()), ('r1', ('r0', ))]),
 
708
            set(index.iter_parents(['a', 'r0', 'b', 'r1', 'c'])))
 
709
 
 
710
    def test_num_versions(self):
 
711
        transport = MockTransport([
 
712
            _KnitIndex.HEADER
 
713
            ])
 
714
        index = self.get_knit_index(transport, "filename", "r")
 
715
 
 
716
        self.assertEqual(0, index.num_versions())
 
717
        self.assertEqual(0, len(index))
 
718
 
 
719
        index.add_version("a", ["option"], (None, 0, 1), [])
 
720
        self.assertEqual(1, index.num_versions())
 
721
        self.assertEqual(1, len(index))
 
722
 
 
723
        index.add_version("a", ["option2"], (None, 1, 2), [])
 
724
        self.assertEqual(1, index.num_versions())
 
725
        self.assertEqual(1, len(index))
 
726
 
 
727
        index.add_version("b", ["option"], (None, 0, 1), [])
 
728
        self.assertEqual(2, index.num_versions())
 
729
        self.assertEqual(2, len(index))
 
730
 
 
731
    def test_get_versions(self):
 
732
        transport = MockTransport([
 
733
            _KnitIndex.HEADER
 
734
            ])
 
735
        index = self.get_knit_index(transport, "filename", "r")
 
736
 
 
737
        self.assertEqual([], index.get_versions())
 
738
 
 
739
        index.add_version("a", ["option"], (None, 0, 1), [])
 
740
        self.assertEqual(["a"], index.get_versions())
 
741
 
 
742
        index.add_version("a", ["option"], (None, 0, 1), [])
 
743
        self.assertEqual(["a"], index.get_versions())
 
744
 
 
745
        index.add_version("b", ["option"], (None, 0, 1), [])
 
746
        self.assertEqual(["a", "b"], index.get_versions())
 
747
 
 
748
    def test_add_version(self):
 
749
        transport = MockTransport([
 
750
            _KnitIndex.HEADER
 
751
            ])
 
752
        index = self.get_knit_index(transport, "filename", "r")
 
753
 
 
754
        index.add_version("a", ["option"], (None, 0, 1), ["b"])
 
755
        self.assertEqual(("append_bytes",
 
756
            ("filename", "\na option 0 1 .b :"),
 
757
            {}), transport.calls.pop(0))
 
758
        self.assertTrue(index.has_version("a"))
 
759
        self.assertEqual(1, index.num_versions())
 
760
        self.assertEqual((None, 0, 1), index.get_position("a"))
 
761
        self.assertEqual(["option"], index.get_options("a"))
 
762
        self.assertEqual(("b",), index.get_parents_with_ghosts("a"))
 
763
 
 
764
        index.add_version("a", ["opt"], (None, 1, 2), ["c"])
 
765
        self.assertEqual(("append_bytes",
 
766
            ("filename", "\na opt 1 2 .c :"),
 
767
            {}), transport.calls.pop(0))
 
768
        self.assertTrue(index.has_version("a"))
 
769
        self.assertEqual(1, index.num_versions())
 
770
        self.assertEqual((None, 1, 2), index.get_position("a"))
 
771
        self.assertEqual(["opt"], index.get_options("a"))
 
772
        self.assertEqual(("c",), index.get_parents_with_ghosts("a"))
 
773
 
 
774
        index.add_version("b", ["option"], (None, 2, 3), ["a"])
 
775
        self.assertEqual(("append_bytes",
 
776
            ("filename", "\nb option 2 3 0 :"),
 
777
            {}), transport.calls.pop(0))
 
778
        self.assertTrue(index.has_version("b"))
 
779
        self.assertEqual(2, index.num_versions())
 
780
        self.assertEqual((None, 2, 3), index.get_position("b"))
 
781
        self.assertEqual(["option"], index.get_options("b"))
 
782
        self.assertEqual(("a",), index.get_parents_with_ghosts("b"))
1027
783
 
1028
784
    def test_add_versions(self):
1029
785
        transport = MockTransport([
1030
 
            _KndxIndex.HEADER
 
786
            _KnitIndex.HEADER
1031
787
            ])
1032
788
        index = self.get_knit_index(transport, "filename", "r")
1033
789
 
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 +
 
790
        index.add_versions([
 
791
            ("a", ["option"], (None, 0, 1), ["b"]),
 
792
            ("a", ["opt"], (None, 1, 2), ["c"]),
 
793
            ("b", ["option"], (None, 2, 3), ["a"])
 
794
            ])
 
795
        self.assertEqual(("append_bytes", ("filename",
1042
796
            "\na option 0 1 .b :"
1043
797
            "\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)
 
798
            "\nb option 2 3 0 :"
 
799
            ), {}), transport.calls.pop(0))
 
800
        self.assertTrue(index.has_version("a"))
 
801
        self.assertTrue(index.has_version("b"))
 
802
        self.assertEqual(2, index.num_versions())
 
803
        self.assertEqual((None, 1, 2), index.get_position("a"))
 
804
        self.assertEqual((None, 2, 3), index.get_position("b"))
 
805
        self.assertEqual(["opt"], index.get_options("a"))
 
806
        self.assertEqual(["option"], index.get_options("b"))
 
807
        self.assertEqual(("c",), index.get_parents_with_ghosts("a"))
 
808
        self.assertEqual(("a",), index.get_parents_with_ghosts("b"))
1048
809
 
1049
810
    def test_add_versions_random_id_is_accepted(self):
1050
811
        transport = MockTransport([
1051
 
            _KndxIndex.HEADER
 
812
            _KnitIndex.HEADER
1052
813
            ])
1053
814
        index = self.get_knit_index(transport, "filename", "r")
1054
 
        self.add_a_b(index, random_id=True)
 
815
 
 
816
        index.add_versions([
 
817
            ("a", ["option"], (None, 0, 1), ["b"]),
 
818
            ("a", ["opt"], (None, 1, 2), ["c"]),
 
819
            ("b", ["option"], (None, 2, 3), ["a"])
 
820
            ], random_id=True)
1055
821
 
1056
822
    def test_delay_create_and_add_versions(self):
1057
823
        transport = MockTransport()
1058
824
 
1059
 
        index = self.get_knit_index(transport, "filename", "w")
1060
 
        # dir_mode=0777)
 
825
        index = self.get_knit_index(transport, "filename", "w",
 
826
            create=True, file_mode="wb", create_parent_dir=True,
 
827
            delay_create=True, dir_mode=0777)
1061
828
        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 +
 
829
 
 
830
        index.add_versions([
 
831
            ("a", ["option"], (None, 0, 1), ["b"]),
 
832
            ("a", ["opt"], (None, 1, 2), ["c"]),
 
833
            ("b", ["option"], (None, 2, 3), ["a"])
 
834
            ])
 
835
        name, (filename, f), kwargs = transport.calls.pop(0)
 
836
        self.assertEqual("put_file_non_atomic", name)
 
837
        self.assertEqual(
 
838
            {"dir_mode": 0777, "create_parent_dir": True, "mode": "wb"},
 
839
            kwargs)
 
840
        self.assertEqual("filename", filename)
 
841
        self.assertEqual(
 
842
            index.HEADER +
1082
843
            "\na option 0 1 .b :"
1083
844
            "\na opt 1 2 .c :"
1084
845
            "\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)
 
846
            f.read())
 
847
 
 
848
    def test_has_version(self):
 
849
        transport = MockTransport([
 
850
            _KnitIndex.HEADER,
 
851
            "a option 0 1 :"
 
852
            ])
 
853
        index = self.get_knit_index(transport, "filename", "r")
 
854
 
 
855
        self.assertTrue(index.has_version("a"))
 
856
        self.assertFalse(index.has_version("b"))
1107
857
 
1108
858
    def test_get_position(self):
1109
859
        transport = MockTransport([
1110
 
            _KndxIndex.HEADER,
 
860
            _KnitIndex.HEADER,
1111
861
            "a option 0 1 :",
1112
862
            "b option 1 2 :"
1113
863
            ])
1114
864
        index = self.get_knit_index(transport, "filename", "r")
1115
865
 
1116
 
        self.assertEqual((("a",), 0, 1), index.get_position(("a",)))
1117
 
        self.assertEqual((("b",), 1, 2), index.get_position(("b",)))
 
866
        self.assertEqual((None, 0, 1), index.get_position("a"))
 
867
        self.assertEqual((None, 1, 2), index.get_position("b"))
1118
868
 
1119
869
    def test_get_method(self):
1120
870
        transport = MockTransport([
1121
 
            _KndxIndex.HEADER,
 
871
            _KnitIndex.HEADER,
1122
872
            "a fulltext,unknown 0 1 :",
1123
873
            "b unknown,line-delta 1 2 :",
1124
874
            "c bad 3 4 :"
1131
881
 
1132
882
    def test_get_options(self):
1133
883
        transport = MockTransport([
1134
 
            _KndxIndex.HEADER,
 
884
            _KnitIndex.HEADER,
1135
885
            "a opt1 0 1 :",
1136
886
            "b opt2,opt3 1 2 :"
1137
887
            ])
1142
892
 
1143
893
    def test_get_parent_map(self):
1144
894
        transport = MockTransport([
1145
 
            _KndxIndex.HEADER,
 
895
            _KnitIndex.HEADER,
1146
896
            "a option 0 1 :",
1147
897
            "b option 1 2 0 .c :",
1148
898
            "c option 1 2 1 0 .e :"
1150
900
        index = self.get_knit_index(transport, "filename", "r")
1151
901
 
1152
902
        self.assertEqual({
1153
 
            ("a",):(),
1154
 
            ("b",):(("a",), ("c",)),
1155
 
            ("c",):(("b",), ("a",), ("e",)),
1156
 
            }, index.get_parent_map(index.keys()))
 
903
            "a":(),
 
904
            "b":("a", "c"),
 
905
            "c":("b", "a", "e"),
 
906
            }, index.get_parent_map(["a", "b", "c"]))
 
907
 
 
908
    def test_get_parents_with_ghosts(self):
 
909
        transport = MockTransport([
 
910
            _KnitIndex.HEADER,
 
911
            "a option 0 1 :",
 
912
            "b option 1 2 0 .c :",
 
913
            "c option 1 2 1 0 .e :"
 
914
            ])
 
915
        index = self.get_knit_index(transport, "filename", "r")
 
916
 
 
917
        self.assertEqual((), index.get_parents_with_ghosts("a"))
 
918
        self.assertEqual(("a", "c"), index.get_parents_with_ghosts("b"))
 
919
        self.assertEqual(("b", "a", "e"),
 
920
            index.get_parents_with_ghosts("c"))
 
921
 
 
922
    def test_check_versions_present(self):
 
923
        transport = MockTransport([
 
924
            _KnitIndex.HEADER,
 
925
            "a option 0 1 :",
 
926
            "b option 0 1 :"
 
927
            ])
 
928
        index = self.get_knit_index(transport, "filename", "r")
 
929
 
 
930
        check = index.check_versions_present
 
931
 
 
932
        check([])
 
933
        check(["a"])
 
934
        check(["b"])
 
935
        check(["a", "b"])
 
936
        self.assertRaises(RevisionNotPresent, check, ["c"])
 
937
        self.assertRaises(RevisionNotPresent, check, ["a", "b", "c"])
1157
938
 
1158
939
    def test_impossible_parent(self):
1159
940
        """Test we get KnitCorrupt if the parent couldn't possibly exist."""
1160
941
        transport = MockTransport([
1161
 
            _KndxIndex.HEADER,
 
942
            _KnitIndex.HEADER,
1162
943
            "a option 0 1 :",
1163
944
            "b option 0 1 4 :"  # We don't have a 4th record
1164
945
            ])
1165
 
        index = self.get_knit_index(transport, 'filename', 'r')
1166
946
        try:
1167
 
            self.assertRaises(errors.KnitCorrupt, index.keys)
 
947
            self.assertRaises(errors.KnitCorrupt,
 
948
                              self.get_knit_index, transport, 'filename', 'r')
1168
949
        except TypeError, e:
1169
950
            if (str(e) == ('exceptions must be strings, classes, or instances,'
1170
951
                           ' not exceptions.IndexError')
1177
958
 
1178
959
    def test_corrupted_parent(self):
1179
960
        transport = MockTransport([
1180
 
            _KndxIndex.HEADER,
 
961
            _KnitIndex.HEADER,
1181
962
            "a option 0 1 :",
1182
963
            "b option 0 1 :",
1183
964
            "c option 0 1 1v :", # Can't have a parent of '1v'
1184
965
            ])
1185
 
        index = self.get_knit_index(transport, 'filename', 'r')
1186
966
        try:
1187
 
            self.assertRaises(errors.KnitCorrupt, index.keys)
 
967
            self.assertRaises(errors.KnitCorrupt,
 
968
                              self.get_knit_index, transport, 'filename', 'r')
1188
969
        except TypeError, e:
1189
970
            if (str(e) == ('exceptions must be strings, classes, or instances,'
1190
971
                           ' not exceptions.ValueError')
1197
978
 
1198
979
    def test_corrupted_parent_in_list(self):
1199
980
        transport = MockTransport([
1200
 
            _KndxIndex.HEADER,
 
981
            _KnitIndex.HEADER,
1201
982
            "a option 0 1 :",
1202
983
            "b option 0 1 :",
1203
984
            "c option 0 1 1 v :", # Can't have a parent of 'v'
1204
985
            ])
1205
 
        index = self.get_knit_index(transport, 'filename', 'r')
1206
986
        try:
1207
 
            self.assertRaises(errors.KnitCorrupt, index.keys)
 
987
            self.assertRaises(errors.KnitCorrupt,
 
988
                              self.get_knit_index, transport, 'filename', 'r')
1208
989
        except TypeError, e:
1209
990
            if (str(e) == ('exceptions must be strings, classes, or instances,'
1210
991
                           ' not exceptions.ValueError')
1217
998
 
1218
999
    def test_invalid_position(self):
1219
1000
        transport = MockTransport([
1220
 
            _KndxIndex.HEADER,
 
1001
            _KnitIndex.HEADER,
1221
1002
            "a option 1v 1 :",
1222
1003
            ])
1223
 
        index = self.get_knit_index(transport, 'filename', 'r')
1224
1004
        try:
1225
 
            self.assertRaises(errors.KnitCorrupt, index.keys)
 
1005
            self.assertRaises(errors.KnitCorrupt,
 
1006
                              self.get_knit_index, transport, 'filename', 'r')
1226
1007
        except TypeError, e:
1227
1008
            if (str(e) == ('exceptions must be strings, classes, or instances,'
1228
1009
                           ' not exceptions.ValueError')
1235
1016
 
1236
1017
    def test_invalid_size(self):
1237
1018
        transport = MockTransport([
1238
 
            _KndxIndex.HEADER,
 
1019
            _KnitIndex.HEADER,
1239
1020
            "a option 1 1v :",
1240
1021
            ])
1241
 
        index = self.get_knit_index(transport, 'filename', 'r')
1242
1022
        try:
1243
 
            self.assertRaises(errors.KnitCorrupt, index.keys)
 
1023
            self.assertRaises(errors.KnitCorrupt,
 
1024
                              self.get_knit_index, transport, 'filename', 'r')
1244
1025
        except TypeError, e:
1245
1026
            if (str(e) == ('exceptions must be strings, classes, or instances,'
1246
1027
                           ' not exceptions.ValueError')
1251
1032
            else:
1252
1033
                raise
1253
1034
 
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
1035
    def test_short_line(self):
1264
1036
        transport = MockTransport([
1265
 
            _KndxIndex.HEADER,
 
1037
            _KnitIndex.HEADER,
1266
1038
            "a option 0 10  :",
1267
1039
            "b option 10 10 0", # This line isn't terminated, ignored
1268
1040
            ])
1269
1041
        index = self.get_knit_index(transport, "filename", "r")
1270
 
        self.assertEqual(set([('a',)]), index.keys())
 
1042
        self.assertEqual(['a'], index.get_versions())
1271
1043
 
1272
1044
    def test_skip_incomplete_record(self):
1273
1045
        # A line with bogus data should just be skipped
1274
1046
        transport = MockTransport([
1275
 
            _KndxIndex.HEADER,
 
1047
            _KnitIndex.HEADER,
1276
1048
            "a option 0 10  :",
1277
1049
            "b option 10 10 0", # This line isn't terminated, ignored
1278
1050
            "c option 20 10 0 :", # Properly terminated, and starts with '\n'
1279
1051
            ])
1280
1052
        index = self.get_knit_index(transport, "filename", "r")
1281
 
        self.assertEqual(set([('a',), ('c',)]), index.keys())
 
1053
        self.assertEqual(['a', 'c'], index.get_versions())
1282
1054
 
1283
1055
    def test_trailing_characters(self):
1284
1056
        # A line with bogus data should just be skipped
1285
1057
        transport = MockTransport([
1286
 
            _KndxIndex.HEADER,
 
1058
            _KnitIndex.HEADER,
1287
1059
            "a option 0 10  :",
1288
1060
            "b option 10 10 0 :a", # This line has extra trailing characters
1289
1061
            "c option 20 10 0 :", # Properly terminated, and starts with '\n'
1290
1062
            ])
1291
1063
        index = self.get_knit_index(transport, "filename", "r")
1292
 
        self.assertEqual(set([('a',), ('c',)]), index.keys())
 
1064
        self.assertEqual(['a', 'c'], index.get_versions())
1293
1065
 
1294
1066
 
1295
1067
class LowLevelKnitIndexTests_c(LowLevelKnitIndexTests):
1296
1068
 
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))
 
1069
    _test_needs_features = [CompiledKnitFeature]
 
1070
 
 
1071
    def get_knit_index(self, *args, **kwargs):
 
1072
        orig = knit._load_data
 
1073
        def reset():
 
1074
            knit._load_data = orig
 
1075
        self.addCleanup(reset)
 
1076
        from bzrlib._knit_load_data_c import _load_data_c
 
1077
        knit._load_data = _load_data_c
 
1078
        return _KnitIndex(*args, **kwargs)
 
1079
 
1468
1080
 
1469
1081
 
1470
1082
class KnitTests(TestCaseWithTransport):
1471
1083
    """Class containing knit test helper routines."""
1472
1084
 
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 ")
 
1085
    def make_test_knit(self, annotate=False, delay_create=False, index=None,
 
1086
                       name='test'):
 
1087
        if not annotate:
 
1088
            factory = KnitPlainFactory()
 
1089
        else:
 
1090
            factory = None
 
1091
        return KnitVersionedFile(name, get_transport('.'), access_mode='w',
 
1092
                                 factory=factory, create=True,
 
1093
                                 delay_create=delay_create, index=index)
 
1094
 
 
1095
    def assertRecordContentEqual(self, knit, version_id, candidate_content):
 
1096
        """Assert that some raw record content matches the raw record content
 
1097
        for a particular version_id in the given knit.
 
1098
        """
 
1099
        index_memo = knit._index.get_position(version_id)
 
1100
        record = (version_id, index_memo)
 
1101
        [(_, expected_content)] = list(knit._data.read_records_iter_raw([record]))
 
1102
        self.assertEqual(expected_content, candidate_content)
 
1103
 
 
1104
 
 
1105
class BasicKnitTests(KnitTests):
 
1106
 
 
1107
    def add_stock_one_and_one_a(self, k):
 
1108
        k.add_lines('text-1', [], split_lines(TEXT_1))
 
1109
        k.add_lines('text-1a', ['text-1'], split_lines(TEXT_1A))
 
1110
 
 
1111
    def test_knit_constructor(self):
 
1112
        """Construct empty k"""
 
1113
        self.make_test_knit()
 
1114
 
 
1115
    def test_make_explicit_index(self):
 
1116
        """We can supply an index to use."""
 
1117
        knit = KnitVersionedFile('test', get_transport('.'),
 
1118
            index='strangelove')
 
1119
        self.assertEqual(knit._index, 'strangelove')
 
1120
 
 
1121
    def test_knit_add(self):
 
1122
        """Store one text in knit and retrieve"""
 
1123
        k = self.make_test_knit()
 
1124
        k.add_lines('text-1', [], split_lines(TEXT_1))
 
1125
        self.assertTrue(k.has_version('text-1'))
 
1126
        self.assertEqualDiff(''.join(k.get_lines('text-1')), TEXT_1)
 
1127
 
 
1128
    def test_newline_empty_lines(self):
 
1129
        # ensure that ["\n"] round trips ok.
 
1130
        knit = self.make_test_knit()
 
1131
        knit.add_lines('a', [], ["\n"])
 
1132
        knit.add_lines_with_ghosts('b', [], ["\n"])
 
1133
        self.assertEqual(["\n"], knit.get_lines('a'))
 
1134
        self.assertEqual(["\n"], knit.get_lines('b'))
 
1135
        self.assertEqual(['fulltext'], knit._index.get_options('a'))
 
1136
        self.assertEqual(['fulltext'], knit._index.get_options('b'))
 
1137
        knit.add_lines('c', ['a'], ["\n"])
 
1138
        knit.add_lines_with_ghosts('d', ['b'], ["\n"])
 
1139
        self.assertEqual(["\n"], knit.get_lines('c'))
 
1140
        self.assertEqual(["\n"], knit.get_lines('d'))
 
1141
        self.assertEqual(['line-delta'], knit._index.get_options('c'))
 
1142
        self.assertEqual(['line-delta'], knit._index.get_options('d'))
 
1143
 
 
1144
    def test_empty_lines(self):
 
1145
        # bizarrely, [] is not listed as having no-eol. 
 
1146
        knit = self.make_test_knit()
 
1147
        knit.add_lines('a', [], [])
 
1148
        knit.add_lines_with_ghosts('b', [], [])
 
1149
        self.assertEqual([], knit.get_lines('a'))
 
1150
        self.assertEqual([], knit.get_lines('b'))
 
1151
        self.assertEqual(['fulltext'], knit._index.get_options('a'))
 
1152
        self.assertEqual(['fulltext'], knit._index.get_options('b'))
 
1153
        knit.add_lines('c', ['a'], [])
 
1154
        knit.add_lines_with_ghosts('d', ['b'], [])
 
1155
        self.assertEqual([], knit.get_lines('c'))
 
1156
        self.assertEqual([], knit.get_lines('d'))
 
1157
        self.assertEqual(['line-delta'], knit._index.get_options('c'))
 
1158
        self.assertEqual(['line-delta'], knit._index.get_options('d'))
 
1159
 
 
1160
    def test_knit_reload(self):
 
1161
        # test that the content in a reloaded knit is correct
 
1162
        k = self.make_test_knit()
 
1163
        k.add_lines('text-1', [], split_lines(TEXT_1))
 
1164
        del k
 
1165
        k2 = KnitVersionedFile('test', get_transport('.'), access_mode='r', factory=KnitPlainFactory(), create=True)
 
1166
        self.assertTrue(k2.has_version('text-1'))
 
1167
        self.assertEqualDiff(''.join(k2.get_lines('text-1')), TEXT_1)
 
1168
 
 
1169
    def test_knit_several(self):
 
1170
        """Store several texts in a knit"""
 
1171
        k = self.make_test_knit()
 
1172
        k.add_lines('text-1', [], split_lines(TEXT_1))
 
1173
        k.add_lines('text-2', [], split_lines(TEXT_2))
 
1174
        self.assertEqualDiff(''.join(k.get_lines('text-1')), TEXT_1)
 
1175
        self.assertEqualDiff(''.join(k.get_lines('text-2')), TEXT_2)
 
1176
        
 
1177
    def test_repeated_add(self):
 
1178
        """Knit traps attempt to replace existing version"""
 
1179
        k = self.make_test_knit()
 
1180
        k.add_lines('text-1', [], split_lines(TEXT_1))
 
1181
        self.assertRaises(RevisionAlreadyPresent, 
 
1182
                k.add_lines,
 
1183
                'text-1', [], split_lines(TEXT_1))
 
1184
 
 
1185
    def test_empty(self):
 
1186
        k = self.make_test_knit(True)
 
1187
        k.add_lines('text-1', [], [])
 
1188
        self.assertEquals(k.get_lines('text-1'), [])
 
1189
 
 
1190
    def test_incomplete(self):
 
1191
        """Test if texts without a ending line-end can be inserted and
 
1192
        extracted."""
 
1193
        k = KnitVersionedFile('test', get_transport('.'), delta=False, create=True)
 
1194
        k.add_lines('text-1', [], ['a\n',    'b'  ])
 
1195
        k.add_lines('text-2', ['text-1'], ['a\rb\n', 'b\n'])
 
1196
        # reopening ensures maximum room for confusion
 
1197
        k = KnitVersionedFile('test', get_transport('.'), delta=False, create=True)
 
1198
        self.assertEquals(k.get_lines('text-1'), ['a\n',    'b'  ])
 
1199
        self.assertEquals(k.get_lines('text-2'), ['a\rb\n', 'b\n'])
 
1200
 
 
1201
    def test_delta(self):
 
1202
        """Expression of knit delta as lines"""
 
1203
        k = self.make_test_knit()
 
1204
        td = list(line_delta(TEXT_1.splitlines(True),
 
1205
                             TEXT_1A.splitlines(True)))
 
1206
        self.assertEqualDiff(''.join(td), delta_1_1a)
 
1207
        out = apply_line_delta(TEXT_1.splitlines(True), td)
 
1208
        self.assertEqualDiff(''.join(out), TEXT_1A)
 
1209
 
 
1210
    def test_add_with_parents(self):
 
1211
        """Store in knit with parents"""
 
1212
        k = self.make_test_knit()
 
1213
        self.add_stock_one_and_one_a(k)
 
1214
        self.assertEqual({'text-1':(), 'text-1a':('text-1',)},
 
1215
            k.get_parent_map(['text-1', 'text-1a']))
 
1216
 
 
1217
    def test_ancestry(self):
 
1218
        """Store in knit with parents"""
 
1219
        k = self.make_test_knit()
 
1220
        self.add_stock_one_and_one_a(k)
 
1221
        self.assertEquals(set(k.get_ancestry(['text-1a'])), set(['text-1a', 'text-1']))
 
1222
 
 
1223
    def test_add_delta(self):
 
1224
        """Store in knit with parents"""
 
1225
        k = KnitVersionedFile('test', get_transport('.'), factory=KnitPlainFactory(),
 
1226
            delta=True, create=True)
 
1227
        self.add_stock_one_and_one_a(k)
 
1228
        k.clear_cache()
 
1229
        self.assertEqualDiff(''.join(k.get_lines('text-1a')), TEXT_1A)
 
1230
 
 
1231
    def test_add_delta_knit_graph_index(self):
 
1232
        """Does adding work with a KnitGraphIndex."""
 
1233
        index = InMemoryGraphIndex(2)
 
1234
        knit_index = KnitGraphIndex(index, add_callback=index.add_nodes,
 
1235
            deltas=True)
 
1236
        k = KnitVersionedFile('test', get_transport('.'),
 
1237
            delta=True, create=True, index=knit_index)
 
1238
        self.add_stock_one_and_one_a(k)
 
1239
        k.clear_cache()
 
1240
        self.assertEqualDiff(''.join(k.get_lines('text-1a')), TEXT_1A)
 
1241
        # check the index had the right data added.
 
1242
        self.assertEqual(set([
 
1243
            (index, ('text-1', ), ' 0 127', ((), ())),
 
1244
            (index, ('text-1a', ), ' 127 140', ((('text-1', ),), (('text-1', ),))),
 
1245
            ]), set(index.iter_all_entries()))
 
1246
        # we should not have a .kndx file
 
1247
        self.assertFalse(get_transport('.').has('test.kndx'))
 
1248
 
 
1249
    def test_annotate(self):
 
1250
        """Annotations"""
 
1251
        k = KnitVersionedFile('knit', get_transport('.'), factory=KnitAnnotateFactory(),
 
1252
            delta=True, create=True)
 
1253
        self.insert_and_test_small_annotate(k)
 
1254
 
 
1255
    def insert_and_test_small_annotate(self, k):
 
1256
        """test annotation with k works correctly."""
 
1257
        k.add_lines('text-1', [], ['a\n', 'b\n'])
 
1258
        k.add_lines('text-2', ['text-1'], ['a\n', 'c\n'])
 
1259
 
 
1260
        origins = k.annotate('text-2')
 
1261
        self.assertEquals(origins[0], ('text-1', 'a\n'))
 
1262
        self.assertEquals(origins[1], ('text-2', 'c\n'))
 
1263
 
 
1264
    def test_annotate_fulltext(self):
 
1265
        """Annotations"""
 
1266
        k = KnitVersionedFile('knit', get_transport('.'), factory=KnitAnnotateFactory(),
 
1267
            delta=False, create=True)
 
1268
        self.insert_and_test_small_annotate(k)
 
1269
 
 
1270
    def test_annotate_merge_1(self):
 
1271
        k = self.make_test_knit(True)
 
1272
        k.add_lines('text-a1', [], ['a\n', 'b\n'])
 
1273
        k.add_lines('text-a2', [], ['d\n', 'c\n'])
 
1274
        k.add_lines('text-am', ['text-a1', 'text-a2'], ['d\n', 'b\n'])
 
1275
        origins = k.annotate('text-am')
 
1276
        self.assertEquals(origins[0], ('text-a2', 'd\n'))
 
1277
        self.assertEquals(origins[1], ('text-a1', 'b\n'))
 
1278
 
 
1279
    def test_annotate_merge_2(self):
 
1280
        k = self.make_test_knit(True)
 
1281
        k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
 
1282
        k.add_lines('text-a2', [], ['x\n', 'y\n', 'z\n'])
 
1283
        k.add_lines('text-am', ['text-a1', 'text-a2'], ['a\n', 'y\n', 'c\n'])
 
1284
        origins = k.annotate('text-am')
 
1285
        self.assertEquals(origins[0], ('text-a1', 'a\n'))
 
1286
        self.assertEquals(origins[1], ('text-a2', 'y\n'))
 
1287
        self.assertEquals(origins[2], ('text-a1', 'c\n'))
 
1288
 
 
1289
    def test_annotate_merge_9(self):
 
1290
        k = self.make_test_knit(True)
 
1291
        k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
 
1292
        k.add_lines('text-a2', [], ['x\n', 'y\n', 'z\n'])
 
1293
        k.add_lines('text-am', ['text-a1', 'text-a2'], ['k\n', 'y\n', 'c\n'])
 
1294
        origins = k.annotate('text-am')
 
1295
        self.assertEquals(origins[0], ('text-am', 'k\n'))
 
1296
        self.assertEquals(origins[1], ('text-a2', 'y\n'))
 
1297
        self.assertEquals(origins[2], ('text-a1', 'c\n'))
 
1298
 
 
1299
    def test_annotate_merge_3(self):
 
1300
        k = self.make_test_knit(True)
 
1301
        k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
 
1302
        k.add_lines('text-a2', [] ,['x\n', 'y\n', 'z\n'])
 
1303
        k.add_lines('text-am', ['text-a1', 'text-a2'], ['k\n', 'y\n', 'z\n'])
 
1304
        origins = k.annotate('text-am')
 
1305
        self.assertEquals(origins[0], ('text-am', 'k\n'))
 
1306
        self.assertEquals(origins[1], ('text-a2', 'y\n'))
 
1307
        self.assertEquals(origins[2], ('text-a2', 'z\n'))
 
1308
 
 
1309
    def test_annotate_merge_4(self):
 
1310
        k = self.make_test_knit(True)
 
1311
        k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
 
1312
        k.add_lines('text-a2', [], ['x\n', 'y\n', 'z\n'])
 
1313
        k.add_lines('text-a3', ['text-a1'], ['a\n', 'b\n', 'p\n'])
 
1314
        k.add_lines('text-am', ['text-a2', 'text-a3'], ['a\n', 'b\n', 'z\n'])
 
1315
        origins = k.annotate('text-am')
 
1316
        self.assertEquals(origins[0], ('text-a1', 'a\n'))
 
1317
        self.assertEquals(origins[1], ('text-a1', 'b\n'))
 
1318
        self.assertEquals(origins[2], ('text-a2', 'z\n'))
 
1319
 
 
1320
    def test_annotate_merge_5(self):
 
1321
        k = self.make_test_knit(True)
 
1322
        k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
 
1323
        k.add_lines('text-a2', [], ['d\n', 'e\n', 'f\n'])
 
1324
        k.add_lines('text-a3', [], ['x\n', 'y\n', 'z\n'])
 
1325
        k.add_lines('text-am',
 
1326
                    ['text-a1', 'text-a2', 'text-a3'],
 
1327
                    ['a\n', 'e\n', 'z\n'])
 
1328
        origins = k.annotate('text-am')
 
1329
        self.assertEquals(origins[0], ('text-a1', 'a\n'))
 
1330
        self.assertEquals(origins[1], ('text-a2', 'e\n'))
 
1331
        self.assertEquals(origins[2], ('text-a3', 'z\n'))
 
1332
 
 
1333
    def test_annotate_file_cherry_pick(self):
 
1334
        k = self.make_test_knit(True)
 
1335
        k.add_lines('text-1', [], ['a\n', 'b\n', 'c\n'])
 
1336
        k.add_lines('text-2', ['text-1'], ['d\n', 'e\n', 'f\n'])
 
1337
        k.add_lines('text-3', ['text-2', 'text-1'], ['a\n', 'b\n', 'c\n'])
 
1338
        origins = k.annotate('text-3')
 
1339
        self.assertEquals(origins[0], ('text-1', 'a\n'))
 
1340
        self.assertEquals(origins[1], ('text-1', 'b\n'))
 
1341
        self.assertEquals(origins[2], ('text-1', 'c\n'))
 
1342
 
 
1343
    def _test_join_with_factories(self, k1_factory, k2_factory):
 
1344
        k1 = KnitVersionedFile('test1', get_transport('.'), factory=k1_factory, create=True)
 
1345
        k1.add_lines('text-a', [], ['a1\n', 'a2\n', 'a3\n'])
 
1346
        k1.add_lines('text-b', ['text-a'], ['a1\n', 'b2\n', 'a3\n'])
 
1347
        k1.add_lines('text-c', [], ['c1\n', 'c2\n', 'c3\n'])
 
1348
        k1.add_lines('text-d', ['text-c'], ['c1\n', 'd2\n', 'd3\n'])
 
1349
        k1.add_lines('text-m', ['text-b', 'text-d'], ['a1\n', 'b2\n', 'd3\n'])
 
1350
        k2 = KnitVersionedFile('test2', get_transport('.'), factory=k2_factory, create=True)
 
1351
        count = k2.join(k1, version_ids=['text-m'])
 
1352
        self.assertEquals(count, 5)
 
1353
        self.assertTrue(k2.has_version('text-a'))
 
1354
        self.assertTrue(k2.has_version('text-c'))
 
1355
        origins = k2.annotate('text-m')
 
1356
        self.assertEquals(origins[0], ('text-a', 'a1\n'))
 
1357
        self.assertEquals(origins[1], ('text-b', 'b2\n'))
 
1358
        self.assertEquals(origins[2], ('text-d', 'd3\n'))
 
1359
 
 
1360
    def test_knit_join_plain_to_plain(self):
 
1361
        """Test joining a plain knit with a plain knit."""
 
1362
        self._test_join_with_factories(KnitPlainFactory(), KnitPlainFactory())
 
1363
 
 
1364
    def test_knit_join_anno_to_anno(self):
 
1365
        """Test joining an annotated knit with an annotated knit."""
 
1366
        self._test_join_with_factories(None, None)
 
1367
 
 
1368
    def test_knit_join_anno_to_plain(self):
 
1369
        """Test joining an annotated knit with a plain knit."""
 
1370
        self._test_join_with_factories(None, KnitPlainFactory())
 
1371
 
 
1372
    def test_knit_join_plain_to_anno(self):
 
1373
        """Test joining a plain knit with an annotated knit."""
 
1374
        self._test_join_with_factories(KnitPlainFactory(), None)
 
1375
 
 
1376
    def test_reannotate(self):
 
1377
        k1 = KnitVersionedFile('knit1', get_transport('.'),
 
1378
                               factory=KnitAnnotateFactory(), create=True)
 
1379
        # 0
 
1380
        k1.add_lines('text-a', [], ['a\n', 'b\n'])
 
1381
        # 1
 
1382
        k1.add_lines('text-b', ['text-a'], ['a\n', 'c\n'])
 
1383
 
 
1384
        k2 = KnitVersionedFile('test2', get_transport('.'),
 
1385
                               factory=KnitAnnotateFactory(), create=True)
 
1386
        k2.join(k1, version_ids=['text-b'])
 
1387
 
 
1388
        # 2
 
1389
        k1.add_lines('text-X', ['text-b'], ['a\n', 'b\n'])
 
1390
        # 2
 
1391
        k2.add_lines('text-c', ['text-b'], ['z\n', 'c\n'])
 
1392
        # 3
 
1393
        k2.add_lines('text-Y', ['text-b'], ['b\n', 'c\n'])
 
1394
 
 
1395
        # test-c will have index 3
 
1396
        k1.join(k2, version_ids=['text-c'])
 
1397
 
 
1398
        lines = k1.get_lines('text-c')
 
1399
        self.assertEquals(lines, ['z\n', 'c\n'])
 
1400
 
 
1401
        origins = k1.annotate('text-c')
 
1402
        self.assertEquals(origins[0], ('text-c', 'z\n'))
 
1403
        self.assertEquals(origins[1], ('text-b', 'c\n'))
 
1404
 
 
1405
    def test_get_line_delta_texts(self):
 
1406
        """Make sure we can call get_texts on text with reused line deltas"""
 
1407
        k1 = KnitVersionedFile('test1', get_transport('.'), 
 
1408
                               factory=KnitPlainFactory(), create=True)
 
1409
        for t in range(3):
 
1410
            if t == 0:
 
1411
                parents = []
 
1412
            else:
 
1413
                parents = ['%d' % (t-1)]
 
1414
            k1.add_lines('%d' % t, parents, ['hello\n'] * t)
 
1415
        k1.get_texts(('%d' % t) for t in range(3))
 
1416
        
 
1417
    def test_iter_lines_reads_in_order(self):
 
1418
        instrumented_t = get_transport('trace+memory:///')
 
1419
        k1 = KnitVersionedFile('id', instrumented_t, create=True, delta=True)
 
1420
        self.assertEqual([('get', 'id.kndx',)], instrumented_t._activity)
 
1421
        # add texts with no required ordering
 
1422
        k1.add_lines('base', [], ['text\n'])
 
1423
        k1.add_lines('base2', [], ['text2\n'])
 
1424
        k1.clear_cache()
 
1425
        # clear the logged activity, but preserve the list instance in case of
 
1426
        # clones pointing at it.
 
1427
        del instrumented_t._activity[:]
 
1428
        # request a last-first iteration
 
1429
        results = list(k1.iter_lines_added_or_present_in_versions(
 
1430
            ['base2', 'base']))
 
1431
        self.assertEqual(
 
1432
            [('readv', 'id.knit', [(0, 87), (87, 89)], False, None)],
 
1433
            instrumented_t._activity)
 
1434
        self.assertEqual([('text\n', 'base'), ('text2\n', 'base2')], results)
 
1435
 
 
1436
    def test_create_empty_annotated(self):
 
1437
        k1 = self.make_test_knit(True)
 
1438
        # 0
 
1439
        k1.add_lines('text-a', [], ['a\n', 'b\n'])
 
1440
        k2 = k1.create_empty('t', MemoryTransport())
 
1441
        self.assertTrue(isinstance(k2.factory, KnitAnnotateFactory))
 
1442
        self.assertEqual(k1.delta, k2.delta)
 
1443
        # the generic test checks for empty content and file class
 
1444
 
 
1445
    def test_knit_format(self):
 
1446
        # this tests that a new knit index file has the expected content
 
1447
        # and that is writes the data we expect as records are added.
 
1448
        knit = self.make_test_knit(True)
 
1449
        # Now knit files are not created until we first add data to them
 
1450
        self.assertFileEqual("# bzr knit index 8\n", 'test.kndx')
 
1451
        knit.add_lines_with_ghosts('revid', ['a_ghost'], ['a\n'])
 
1452
        self.assertFileEqual(
 
1453
            "# bzr knit index 8\n"
 
1454
            "\n"
 
1455
            "revid fulltext 0 84 .a_ghost :",
 
1456
            'test.kndx')
 
1457
        knit.add_lines_with_ghosts('revid2', ['revid'], ['a\n'])
 
1458
        self.assertFileEqual(
 
1459
            "# bzr knit index 8\n"
 
1460
            "\nrevid fulltext 0 84 .a_ghost :"
 
1461
            "\nrevid2 line-delta 84 82 0 :",
 
1462
            'test.kndx')
 
1463
        # we should be able to load this file again
 
1464
        knit = KnitVersionedFile('test', get_transport('.'), access_mode='r')
 
1465
        self.assertEqual(['revid', 'revid2'], knit.versions())
 
1466
        # write a short write to the file and ensure that its ignored
 
1467
        indexfile = file('test.kndx', 'ab')
 
1468
        indexfile.write('\nrevid3 line-delta 166 82 1 2 3 4 5 .phwoar:demo ')
 
1469
        indexfile.close()
 
1470
        # we should be able to load this file again
 
1471
        knit = KnitVersionedFile('test', get_transport('.'), access_mode='w')
 
1472
        self.assertEqual(['revid', 'revid2'], knit.versions())
 
1473
        # and add a revision with the same id the failed write had
 
1474
        knit.add_lines('revid3', ['revid2'], ['a\n'])
 
1475
        # and when reading it revid3 should now appear.
 
1476
        knit = KnitVersionedFile('test', get_transport('.'), access_mode='r')
 
1477
        self.assertEqual(['revid', 'revid2', 'revid3'], knit.versions())
 
1478
        self.assertEqual({'revid3':('revid2',)}, knit.get_parent_map(['revid3']))
 
1479
 
 
1480
    def test_delay_create(self):
 
1481
        """Test that passing delay_create=True creates files late"""
 
1482
        knit = self.make_test_knit(annotate=True, delay_create=True)
 
1483
        self.failIfExists('test.knit')
 
1484
        self.failIfExists('test.kndx')
 
1485
        knit.add_lines_with_ghosts('revid', ['a_ghost'], ['a\n'])
 
1486
        self.failUnlessExists('test.knit')
 
1487
        self.assertFileEqual(
 
1488
            "# bzr knit index 8\n"
 
1489
            "\n"
 
1490
            "revid fulltext 0 84 .a_ghost :",
 
1491
            'test.kndx')
 
1492
 
 
1493
    def test_create_parent_dir(self):
 
1494
        """create_parent_dir can create knits in nonexistant dirs"""
 
1495
        # Has no effect if we don't set 'delay_create'
 
1496
        trans = get_transport('.')
 
1497
        self.assertRaises(NoSuchFile, KnitVersionedFile, 'dir/test',
 
1498
                          trans, access_mode='w', factory=None,
 
1499
                          create=True, create_parent_dir=True)
 
1500
        # Nothing should have changed yet
 
1501
        knit = KnitVersionedFile('dir/test', trans, access_mode='w',
 
1502
                                 factory=None, create=True,
 
1503
                                 create_parent_dir=True,
 
1504
                                 delay_create=True)
 
1505
        self.failIfExists('dir/test.knit')
 
1506
        self.failIfExists('dir/test.kndx')
 
1507
        self.failIfExists('dir')
 
1508
        knit.add_lines('revid', [], ['a\n'])
 
1509
        self.failUnlessExists('dir')
 
1510
        self.failUnlessExists('dir/test.knit')
 
1511
        self.assertFileEqual(
 
1512
            "# bzr knit index 8\n"
 
1513
            "\n"
 
1514
            "revid fulltext 0 84  :",
 
1515
            'dir/test.kndx')
 
1516
 
 
1517
    def test_create_mode_700(self):
 
1518
        trans = get_transport('.')
 
1519
        if not trans._can_roundtrip_unix_modebits():
 
1520
            # Can't roundtrip, so no need to run this test
 
1521
            return
 
1522
        knit = KnitVersionedFile('dir/test', trans, access_mode='w',
 
1523
                                 factory=None, create=True,
 
1524
                                 create_parent_dir=True,
 
1525
                                 delay_create=True,
 
1526
                                 file_mode=0600,
 
1527
                                 dir_mode=0700)
 
1528
        knit.add_lines('revid', [], ['a\n'])
 
1529
        self.assertTransportMode(trans, 'dir', 0700)
 
1530
        self.assertTransportMode(trans, 'dir/test.knit', 0600)
 
1531
        self.assertTransportMode(trans, 'dir/test.kndx', 0600)
 
1532
 
 
1533
    def test_create_mode_770(self):
 
1534
        trans = get_transport('.')
 
1535
        if not trans._can_roundtrip_unix_modebits():
 
1536
            # Can't roundtrip, so no need to run this test
 
1537
            return
 
1538
        knit = KnitVersionedFile('dir/test', trans, access_mode='w',
 
1539
                                 factory=None, create=True,
 
1540
                                 create_parent_dir=True,
 
1541
                                 delay_create=True,
 
1542
                                 file_mode=0660,
 
1543
                                 dir_mode=0770)
 
1544
        knit.add_lines('revid', [], ['a\n'])
 
1545
        self.assertTransportMode(trans, 'dir', 0770)
 
1546
        self.assertTransportMode(trans, 'dir/test.knit', 0660)
 
1547
        self.assertTransportMode(trans, 'dir/test.kndx', 0660)
 
1548
 
 
1549
    def test_create_mode_777(self):
 
1550
        trans = get_transport('.')
 
1551
        if not trans._can_roundtrip_unix_modebits():
 
1552
            # Can't roundtrip, so no need to run this test
 
1553
            return
 
1554
        knit = KnitVersionedFile('dir/test', trans, access_mode='w',
 
1555
                                 factory=None, create=True,
 
1556
                                 create_parent_dir=True,
 
1557
                                 delay_create=True,
 
1558
                                 file_mode=0666,
 
1559
                                 dir_mode=0777)
 
1560
        knit.add_lines('revid', [], ['a\n'])
 
1561
        self.assertTransportMode(trans, 'dir', 0777)
 
1562
        self.assertTransportMode(trans, 'dir/test.knit', 0666)
 
1563
        self.assertTransportMode(trans, 'dir/test.kndx', 0666)
 
1564
 
 
1565
    def test_plan_merge(self):
 
1566
        my_knit = self.make_test_knit(annotate=True)
 
1567
        my_knit.add_lines('text1', [], split_lines(TEXT_1))
 
1568
        my_knit.add_lines('text1a', ['text1'], split_lines(TEXT_1A))
 
1569
        my_knit.add_lines('text1b', ['text1'], split_lines(TEXT_1B))
 
1570
        plan = list(my_knit.plan_merge('text1a', 'text1b'))
 
1571
        for plan_line, expected_line in zip(plan, AB_MERGE):
 
1572
            self.assertEqual(plan_line, expected_line)
 
1573
 
 
1574
    def test_get_stream_empty(self):
 
1575
        """Get a data stream for an empty knit file."""
 
1576
        k1 = self.make_test_knit()
 
1577
        format, data_list, reader_callable = k1.get_data_stream([])
 
1578
        self.assertEqual('knit-plain', format)
 
1579
        self.assertEqual([], data_list)
 
1580
        content = reader_callable(None)
 
1581
        self.assertEqual('', content)
 
1582
        self.assertIsInstance(content, str)
 
1583
 
 
1584
    def test_get_stream_one_version(self):
 
1585
        """Get a data stream for a single record out of a knit containing just
 
1586
        one record.
 
1587
        """
 
1588
        k1 = self.make_test_knit()
 
1589
        test_data = [
 
1590
            ('text-a', [], TEXT_1),
 
1591
            ]
 
1592
        expected_data_list = [
 
1593
            # version, options, length, parents
 
1594
            ('text-a', ['fulltext'], 122, ()),
 
1595
           ]
 
1596
        for version_id, parents, lines in test_data:
 
1597
            k1.add_lines(version_id, parents, split_lines(lines))
 
1598
 
 
1599
        format, data_list, reader_callable = k1.get_data_stream(['text-a'])
 
1600
        self.assertEqual('knit-plain', format)
 
1601
        self.assertEqual(expected_data_list, data_list)
 
1602
        # There's only one record in the knit, so the content should be the
 
1603
        # entire knit data file's contents.
 
1604
        self.assertEqual(k1.transport.get_bytes(k1._data._access._filename),
 
1605
                         reader_callable(None))
 
1606
        
 
1607
    def test_get_stream_get_one_version_of_many(self):
 
1608
        """Get a data stream for just one version out of a knit containing many
 
1609
        versions.
 
1610
        """
 
1611
        k1 = self.make_test_knit()
 
1612
        # Insert the same data as test_knit_join, as they seem to cover a range
 
1613
        # of cases (no parents, one parent, multiple parents).
 
1614
        test_data = [
 
1615
            ('text-a', [], TEXT_1),
 
1616
            ('text-b', ['text-a'], TEXT_1),
 
1617
            ('text-c', [], TEXT_1),
 
1618
            ('text-d', ['text-c'], TEXT_1),
 
1619
            ('text-m', ['text-b', 'text-d'], TEXT_1),
 
1620
            ]
 
1621
        expected_data_list = [
 
1622
            # version, options, length, parents
 
1623
            ('text-m', ['line-delta'], 84, ('text-b', 'text-d')),
 
1624
            ]
 
1625
        for version_id, parents, lines in test_data:
 
1626
            k1.add_lines(version_id, parents, split_lines(lines))
 
1627
 
 
1628
        format, data_list, reader_callable = k1.get_data_stream(['text-m'])
 
1629
        self.assertEqual('knit-plain', format)
 
1630
        self.assertEqual(expected_data_list, data_list)
 
1631
        self.assertRecordContentEqual(k1, 'text-m', reader_callable(None))
 
1632
        
 
1633
    def test_get_data_stream_unordered_index(self):
 
1634
        """Get a data stream when the knit index reports versions out of order.
 
1635
 
 
1636
        https://bugs.launchpad.net/bzr/+bug/164637
 
1637
        """
 
1638
        k1 = self.make_test_knit()
 
1639
        test_data = [
 
1640
            ('text-a', [], TEXT_1),
 
1641
            ('text-b', ['text-a'], TEXT_1),
 
1642
            ('text-c', [], TEXT_1),
 
1643
            ('text-d', ['text-c'], TEXT_1),
 
1644
            ('text-m', ['text-b', 'text-d'], TEXT_1),
 
1645
            ]
 
1646
        for version_id, parents, lines in test_data:
 
1647
            k1.add_lines(version_id, parents, split_lines(lines))
 
1648
        # monkey-patch versions method to return out of order, as if coming
 
1649
        # from multiple independently indexed packs
 
1650
        original_versions = k1.versions
 
1651
        k1.versions = lambda: reversed(original_versions())
 
1652
        expected_data_list = [
 
1653
            ('text-a', ['fulltext'], 122, ()),
 
1654
            ('text-b', ['line-delta'], 84, ('text-a',))]
 
1655
        # now check the fulltext is first and the delta second
 
1656
        format, data_list, _ = k1.get_data_stream(['text-a', 'text-b'])
 
1657
        self.assertEqual('knit-plain', format)
 
1658
        self.assertEqual(expected_data_list, data_list)
 
1659
        # and that's true if we ask for them in the opposite order too
 
1660
        format, data_list, _ = k1.get_data_stream(['text-b', 'text-a'])
 
1661
        self.assertEqual(expected_data_list, data_list)
 
1662
        # also try requesting more versions
 
1663
        format, data_list, _ = k1.get_data_stream([
 
1664
            'text-m', 'text-b', 'text-a'])
 
1665
        self.assertEqual([
 
1666
            ('text-a', ['fulltext'], 122, ()),
 
1667
            ('text-b', ['line-delta'], 84, ('text-a',)),
 
1668
            ('text-m', ['line-delta'], 84, ('text-b', 'text-d')),
 
1669
            ], data_list)
 
1670
 
 
1671
    def test_get_stream_ghost_parent(self):
 
1672
        """Get a data stream for a version with a ghost parent."""
 
1673
        k1 = self.make_test_knit()
 
1674
        # Test data
 
1675
        k1.add_lines('text-a', [], split_lines(TEXT_1))
 
1676
        k1.add_lines_with_ghosts('text-b', ['text-a', 'text-ghost'],
 
1677
                                 split_lines(TEXT_1))
 
1678
        # Expected data
 
1679
        expected_data_list = [
 
1680
            # version, options, length, parents
 
1681
            ('text-b', ['line-delta'], 84, ('text-a', 'text-ghost')),
 
1682
            ]
 
1683
        
 
1684
        format, data_list, reader_callable = k1.get_data_stream(['text-b'])
 
1685
        self.assertEqual('knit-plain', format)
 
1686
        self.assertEqual(expected_data_list, data_list)
 
1687
        self.assertRecordContentEqual(k1, 'text-b', reader_callable(None))
 
1688
    
 
1689
    def test_get_stream_get_multiple_records(self):
 
1690
        """Get a stream for multiple records of a knit."""
 
1691
        k1 = self.make_test_knit()
 
1692
        # Insert the same data as test_knit_join, as they seem to cover a range
 
1693
        # of cases (no parents, one parent, multiple parents).
 
1694
        test_data = [
 
1695
            ('text-a', [], TEXT_1),
 
1696
            ('text-b', ['text-a'], TEXT_1),
 
1697
            ('text-c', [], TEXT_1),
 
1698
            ('text-d', ['text-c'], TEXT_1),
 
1699
            ('text-m', ['text-b', 'text-d'], TEXT_1),
 
1700
            ]
 
1701
        for version_id, parents, lines in test_data:
 
1702
            k1.add_lines(version_id, parents, split_lines(lines))
 
1703
 
 
1704
        # This test is actually a bit strict as the order in which they're
 
1705
        # returned is not defined.  This matches the current (deterministic)
 
1706
        # behaviour.
 
1707
        expected_data_list = [
 
1708
            # version, options, length, parents
 
1709
            ('text-d', ['line-delta'], 84, ('text-c',)),
 
1710
            ('text-b', ['line-delta'], 84, ('text-a',)),
 
1711
            ]
 
1712
        # Note that even though we request the revision IDs in a particular
 
1713
        # order, the data stream may return them in any order it likes.  In this
 
1714
        # case, they'll be in the order they were inserted into the knit.
 
1715
        format, data_list, reader_callable = k1.get_data_stream(
 
1716
            ['text-d', 'text-b'])
 
1717
        self.assertEqual('knit-plain', format)
 
1718
        self.assertEqual(expected_data_list, data_list)
 
1719
        # must match order they're returned
 
1720
        self.assertRecordContentEqual(k1, 'text-d', reader_callable(84))
 
1721
        self.assertRecordContentEqual(k1, 'text-b', reader_callable(84))
 
1722
        self.assertEqual('', reader_callable(None),
 
1723
                         "There should be no more bytes left to read.")
 
1724
 
 
1725
    def test_get_stream_all(self):
 
1726
        """Get a data stream for all the records in a knit.
 
1727
 
 
1728
        This exercises fulltext records, line-delta records, records with
 
1729
        various numbers of parents, and reading multiple records out of the
 
1730
        callable.  These cases ought to all be exercised individually by the
 
1731
        other test_get_stream_* tests; this test is basically just paranoia.
 
1732
        """
 
1733
        k1 = self.make_test_knit()
 
1734
        # Insert the same data as test_knit_join, as they seem to cover a range
 
1735
        # of cases (no parents, one parent, multiple parents).
 
1736
        test_data = [
 
1737
            ('text-a', [], TEXT_1),
 
1738
            ('text-b', ['text-a'], TEXT_1),
 
1739
            ('text-c', [], TEXT_1),
 
1740
            ('text-d', ['text-c'], TEXT_1),
 
1741
            ('text-m', ['text-b', 'text-d'], TEXT_1),
 
1742
           ]
 
1743
        for version_id, parents, lines in test_data:
 
1744
            k1.add_lines(version_id, parents, split_lines(lines))
 
1745
 
 
1746
        # This test is actually a bit strict as the order in which they're
 
1747
        # returned is not defined.  This matches the current (deterministic)
 
1748
        # behaviour.
 
1749
        expected_data_list = [
 
1750
            # version, options, length, parents
 
1751
            ('text-a', ['fulltext'], 122, ()),
 
1752
            ('text-b', ['line-delta'], 84, ('text-a',)),
 
1753
            ('text-m', ['line-delta'], 84, ('text-b', 'text-d')),
 
1754
            ('text-c', ['fulltext'], 121, ()),
 
1755
            ('text-d', ['line-delta'], 84, ('text-c',)),
 
1756
            ]
 
1757
        format, data_list, reader_callable = k1.get_data_stream(
 
1758
            ['text-a', 'text-b', 'text-c', 'text-d', 'text-m'])
 
1759
        self.assertEqual('knit-plain', format)
 
1760
        self.assertEqual(expected_data_list, data_list)
 
1761
        for version_id, options, length, parents in expected_data_list:
 
1762
            bytes = reader_callable(length)
 
1763
            self.assertRecordContentEqual(k1, version_id, bytes)
 
1764
 
 
1765
    def assertKnitFilesEqual(self, knit1, knit2):
 
1766
        """Assert that the contents of the index and data files of two knits are
 
1767
        equal.
 
1768
        """
 
1769
        self.assertEqual(
 
1770
            knit1.transport.get_bytes(knit1._data._access._filename),
 
1771
            knit2.transport.get_bytes(knit2._data._access._filename))
 
1772
        self.assertEqual(
 
1773
            knit1.transport.get_bytes(knit1._index._filename),
 
1774
            knit2.transport.get_bytes(knit2._index._filename))
 
1775
 
 
1776
    def assertKnitValuesEqual(self, left, right):
 
1777
        """Assert that the texts, annotations and graph of left and right are
 
1778
        the same.
 
1779
        """
 
1780
        self.assertEqual(set(left.versions()), set(right.versions()))
 
1781
        for version in left.versions():
 
1782
            self.assertEqual(left.get_parents_with_ghosts(version),
 
1783
                right.get_parents_with_ghosts(version))
 
1784
            self.assertEqual(left.get_lines(version),
 
1785
                right.get_lines(version))
 
1786
            self.assertEqual(left.annotate(version),
 
1787
                right.annotate(version))
 
1788
 
 
1789
    def test_insert_data_stream_empty(self):
 
1790
        """Inserting a data stream with no records should not put any data into
 
1791
        the knit.
 
1792
        """
 
1793
        k1 = self.make_test_knit()
 
1794
        k1.insert_data_stream(
 
1795
            (k1.get_format_signature(), [], lambda ignored: ''))
 
1796
        self.assertEqual('', k1.transport.get_bytes(k1._data._access._filename),
 
1797
                         "The .knit should be completely empty.")
 
1798
        self.assertEqual(k1._index.HEADER,
 
1799
                         k1.transport.get_bytes(k1._index._filename),
 
1800
                         "The .kndx should have nothing apart from the header.")
 
1801
 
 
1802
    def test_insert_data_stream_one_record(self):
 
1803
        """Inserting a data stream with one record from a knit with one record
 
1804
        results in byte-identical files.
 
1805
        """
 
1806
        source = self.make_test_knit(name='source')
 
1807
        source.add_lines('text-a', [], split_lines(TEXT_1))
 
1808
        data_stream = source.get_data_stream(['text-a'])
 
1809
        target = self.make_test_knit(name='target')
 
1810
        target.insert_data_stream(data_stream)
 
1811
        self.assertKnitFilesEqual(source, target)
 
1812
 
 
1813
    def test_insert_data_stream_annotated_unannotated(self):
 
1814
        """Inserting an annotated datastream to an unannotated knit works."""
 
1815
        # case one - full texts.
 
1816
        source = self.make_test_knit(name='source', annotate=True)
 
1817
        target = self.make_test_knit(name='target', annotate=False)
 
1818
        source.add_lines('text-a', [], split_lines(TEXT_1))
 
1819
        target.insert_data_stream(source.get_data_stream(['text-a']))
 
1820
        self.assertKnitValuesEqual(source, target)
 
1821
        # case two - deltas.
 
1822
        source.add_lines('text-b', ['text-a'], split_lines(TEXT_2))
 
1823
        target.insert_data_stream(source.get_data_stream(['text-b']))
 
1824
        self.assertKnitValuesEqual(source, target)
 
1825
 
 
1826
    def test_insert_data_stream_unannotated_annotated(self):
 
1827
        """Inserting an unannotated datastream to an annotated knit works."""
 
1828
        # case one - full texts.
 
1829
        source = self.make_test_knit(name='source', annotate=False)
 
1830
        target = self.make_test_knit(name='target', annotate=True)
 
1831
        source.add_lines('text-a', [], split_lines(TEXT_1))
 
1832
        target.insert_data_stream(source.get_data_stream(['text-a']))
 
1833
        self.assertKnitValuesEqual(source, target)
 
1834
        # case two - deltas.
 
1835
        source.add_lines('text-b', ['text-a'], split_lines(TEXT_2))
 
1836
        target.insert_data_stream(source.get_data_stream(['text-b']))
 
1837
        self.assertKnitValuesEqual(source, target)
 
1838
 
 
1839
    def test_insert_data_stream_records_already_present(self):
 
1840
        """Insert a data stream where some records are alreday present in the
 
1841
        target, and some not.  Only the new records are inserted.
 
1842
        """
 
1843
        source = self.make_test_knit(name='source')
 
1844
        target = self.make_test_knit(name='target')
 
1845
        # Insert 'text-a' into both source and target
 
1846
        source.add_lines('text-a', [], split_lines(TEXT_1))
 
1847
        target.insert_data_stream(source.get_data_stream(['text-a']))
 
1848
        # Insert 'text-b' into just the source.
 
1849
        source.add_lines('text-b', ['text-a'], split_lines(TEXT_1))
 
1850
        # Get a data stream of both text-a and text-b, and insert it.
 
1851
        data_stream = source.get_data_stream(['text-a', 'text-b'])
 
1852
        target.insert_data_stream(data_stream)
 
1853
        # The source and target will now be identical.  This means the text-a
 
1854
        # record was not added a second time.
 
1855
        self.assertKnitFilesEqual(source, target)
 
1856
 
 
1857
    def test_insert_data_stream_multiple_records(self):
 
1858
        """Inserting a data stream of all records from a knit with multiple
 
1859
        records results in byte-identical files.
 
1860
        """
 
1861
        source = self.make_test_knit(name='source')
 
1862
        source.add_lines('text-a', [], split_lines(TEXT_1))
 
1863
        source.add_lines('text-b', ['text-a'], split_lines(TEXT_1))
 
1864
        source.add_lines('text-c', [], split_lines(TEXT_1))
 
1865
        data_stream = source.get_data_stream(['text-a', 'text-b', 'text-c'])
 
1866
        
 
1867
        target = self.make_test_knit(name='target')
 
1868
        target.insert_data_stream(data_stream)
 
1869
        
 
1870
        self.assertKnitFilesEqual(source, target)
 
1871
 
 
1872
    def test_insert_data_stream_ghost_parent(self):
 
1873
        """Insert a data stream with a record that has a ghost parent."""
 
1874
        # Make a knit with a record, text-a, that has a ghost parent.
 
1875
        source = self.make_test_knit(name='source')
 
1876
        source.add_lines_with_ghosts('text-a', ['text-ghost'],
 
1877
                                     split_lines(TEXT_1))
 
1878
        data_stream = source.get_data_stream(['text-a'])
 
1879
 
 
1880
        target = self.make_test_knit(name='target')
 
1881
        target.insert_data_stream(data_stream)
 
1882
 
 
1883
        self.assertKnitFilesEqual(source, target)
 
1884
 
 
1885
        # The target knit object is in a consistent state, i.e. the record we
 
1886
        # just added is immediately visible.
 
1887
        self.assertTrue(target.has_version('text-a'))
 
1888
        self.assertFalse(target.has_version('text-ghost'))
 
1889
        self.assertEqual({'text-a':('text-ghost',)},
 
1890
            target.get_parent_map(['text-a', 'text-ghost']))
 
1891
        self.assertEqual(split_lines(TEXT_1), target.get_lines('text-a'))
 
1892
 
 
1893
    def test_insert_data_stream_inconsistent_version_lines(self):
 
1894
        """Inserting a data stream which has different content for a version_id
 
1895
        than already exists in the knit will raise KnitCorrupt.
 
1896
        """
 
1897
        source = self.make_test_knit(name='source')
 
1898
        target = self.make_test_knit(name='target')
 
1899
        # Insert a different 'text-a' into both source and target
 
1900
        source.add_lines('text-a', [], split_lines(TEXT_1))
 
1901
        target.add_lines('text-a', [], split_lines(TEXT_2))
 
1902
        # Insert a data stream with conflicting content into the target
 
1903
        data_stream = source.get_data_stream(['text-a'])
 
1904
        self.assertRaises(
 
1905
            errors.KnitCorrupt, target.insert_data_stream, data_stream)
 
1906
 
 
1907
    def test_insert_data_stream_inconsistent_version_parents(self):
 
1908
        """Inserting a data stream which has different parents for a version_id
 
1909
        than already exists in the knit will raise KnitCorrupt.
 
1910
        """
 
1911
        source = self.make_test_knit(name='source')
 
1912
        target = self.make_test_knit(name='target')
 
1913
        # Insert a different 'text-a' into both source and target.  They differ
 
1914
        # only by the parents list, the content is the same.
 
1915
        source.add_lines_with_ghosts('text-a', [], split_lines(TEXT_1))
 
1916
        target.add_lines_with_ghosts('text-a', ['a-ghost'], split_lines(TEXT_1))
 
1917
        # Insert a data stream with conflicting content into the target
 
1918
        data_stream = source.get_data_stream(['text-a'])
 
1919
        self.assertRaises(
 
1920
            errors.KnitCorrupt, target.insert_data_stream, data_stream)
 
1921
 
 
1922
    def test_insert_data_stream_unknown_format(self):
 
1923
        """A data stream in a different format to the target knit cannot be
 
1924
        inserted.
 
1925
 
 
1926
        It will raise KnitDataStreamUnknown because the fallback code will fail
 
1927
        to make a knit. In future we may need KnitDataStreamIncompatible again,
 
1928
        for more exotic cases.
 
1929
        """
 
1930
        data_stream = ('fake-format-signature', [], lambda _: '')
 
1931
        target = self.make_test_knit(name='target')
 
1932
        self.assertRaises(
 
1933
            errors.KnitDataStreamUnknown,
 
1934
            target.insert_data_stream, data_stream)
 
1935
 
 
1936
    #  * test that a stream of "already present version, then new version"
 
1937
    #    inserts correctly.
 
1938
 
 
1939
 
 
1940
    def assertMadeStreamKnit(self, source_knit, versions, target_knit):
 
1941
        """Assert that a knit made from a stream is as expected."""
 
1942
        a_stream = source_knit.get_data_stream(versions)
 
1943
        expected_data = a_stream[2](None)
 
1944
        a_stream = source_knit.get_data_stream(versions)
 
1945
        a_knit = target_knit._knit_from_datastream(a_stream)
 
1946
        self.assertEqual(source_knit.factory.__class__,
 
1947
            a_knit.factory.__class__)
 
1948
        self.assertIsInstance(a_knit._data._access, _StreamAccess)
 
1949
        self.assertIsInstance(a_knit._index, _StreamIndex)
 
1950
        self.assertEqual(a_knit._index.data_list, a_stream[1])
 
1951
        self.assertEqual(a_knit._data._access.data, expected_data)
 
1952
        self.assertEqual(a_knit.filename, target_knit.filename)
 
1953
        self.assertEqual(a_knit.transport, target_knit.transport)
 
1954
        self.assertEqual(a_knit._index, a_knit._data._access.stream_index)
 
1955
        self.assertEqual(target_knit, a_knit._data._access.backing_knit)
 
1956
        self.assertIsInstance(a_knit._data._access.orig_factory,
 
1957
            source_knit.factory.__class__)
 
1958
 
 
1959
    def test__knit_from_data_stream_empty(self):
 
1960
        """Create a knit object from a datastream."""
 
1961
        annotated = self.make_test_knit(name='source', annotate=True)
 
1962
        plain = self.make_test_knit(name='target', annotate=False)
 
1963
        # case 1: annotated source
 
1964
        self.assertMadeStreamKnit(annotated, [], annotated)
 
1965
        self.assertMadeStreamKnit(annotated, [], plain)
 
1966
        # case 2: plain source
 
1967
        self.assertMadeStreamKnit(plain, [], annotated)
 
1968
        self.assertMadeStreamKnit(plain, [], plain)
 
1969
 
 
1970
    def test__knit_from_data_stream_unknown_format(self):
 
1971
        annotated = self.make_test_knit(name='source', annotate=True)
 
1972
        self.assertRaises(errors.KnitDataStreamUnknown,
 
1973
            annotated._knit_from_datastream, ("unknown", None, None))
 
1974
 
 
1975
 
 
1976
TEXT_1 = """\
 
1977
Banana cup cakes:
 
1978
 
 
1979
- bananas
 
1980
- eggs
 
1981
- broken tea cups
 
1982
"""
 
1983
 
 
1984
TEXT_1A = """\
 
1985
Banana cup cake recipe
 
1986
(serves 6)
 
1987
 
 
1988
- bananas
 
1989
- eggs
 
1990
- broken tea cups
 
1991
- self-raising flour
 
1992
"""
 
1993
 
 
1994
TEXT_1B = """\
 
1995
Banana cup cake recipe
 
1996
 
 
1997
- bananas (do not use plantains!!!)
 
1998
- broken tea cups
 
1999
- flour
 
2000
"""
 
2001
 
 
2002
delta_1_1a = """\
 
2003
0,1,2
 
2004
Banana cup cake recipe
 
2005
(serves 6)
 
2006
5,5,1
 
2007
- self-raising flour
 
2008
"""
 
2009
 
 
2010
TEXT_2 = """\
 
2011
Boeuf bourguignon
 
2012
 
 
2013
- beef
 
2014
- red wine
 
2015
- small onions
 
2016
- carrot
 
2017
- mushrooms
 
2018
"""
 
2019
 
 
2020
AB_MERGE_TEXT="""unchanged|Banana cup cake recipe
 
2021
new-a|(serves 6)
 
2022
unchanged|
 
2023
killed-b|- bananas
 
2024
killed-b|- eggs
 
2025
new-b|- bananas (do not use plantains!!!)
 
2026
unchanged|- broken tea cups
 
2027
new-a|- self-raising flour
 
2028
new-b|- flour
 
2029
"""
 
2030
AB_MERGE=[tuple(l.split('|')) for l in AB_MERGE_TEXT.splitlines(True)]
 
2031
 
 
2032
 
 
2033
def line_delta(from_lines, to_lines):
 
2034
    """Generate line-based delta from one text to another"""
 
2035
    s = difflib.SequenceMatcher(None, from_lines, to_lines)
 
2036
    for op in s.get_opcodes():
 
2037
        if op[0] == 'equal':
 
2038
            continue
 
2039
        yield '%d,%d,%d\n' % (op[1], op[2], op[4]-op[3])
 
2040
        for i in range(op[3], op[4]):
 
2041
            yield to_lines[i]
 
2042
 
 
2043
 
 
2044
def apply_line_delta(basis_lines, delta_lines):
 
2045
    """Apply a line-based perfect diff
 
2046
    
 
2047
    basis_lines -- text to apply the patch to
 
2048
    delta_lines -- diff instructions and content
 
2049
    """
 
2050
    out = basis_lines[:]
 
2051
    i = 0
 
2052
    offset = 0
 
2053
    while i < len(delta_lines):
 
2054
        l = delta_lines[i]
 
2055
        a, b, c = map(long, l.split(','))
 
2056
        i = i + 1
 
2057
        out[offset+a:offset+b] = delta_lines[i:i+c]
 
2058
        i = i + c
 
2059
        offset = offset + (b - a) + c
 
2060
    return out
 
2061
 
 
2062
 
 
2063
class TestWeaveToKnit(KnitTests):
 
2064
 
 
2065
    def test_weave_to_knit_matches(self):
 
2066
        # check that the WeaveToKnit is_compatible function
 
2067
        # registers True for a Weave to a Knit.
 
2068
        w = Weave()
 
2069
        k = self.make_test_knit()
 
2070
        self.failUnless(WeaveToKnit.is_compatible(w, k))
 
2071
        self.failIf(WeaveToKnit.is_compatible(k, w))
 
2072
        self.failIf(WeaveToKnit.is_compatible(w, w))
 
2073
        self.failIf(WeaveToKnit.is_compatible(k, k))
 
2074
 
 
2075
 
 
2076
class TestKnitCaching(KnitTests):
 
2077
    
 
2078
    def create_knit(self):
 
2079
        k = self.make_test_knit(True)
 
2080
        k.add_lines('text-1', [], split_lines(TEXT_1))
 
2081
        k.add_lines('text-2', [], split_lines(TEXT_2))
 
2082
        return k
 
2083
 
 
2084
    def test_no_caching(self):
 
2085
        k = self.create_knit()
 
2086
        # Nothing should be cached without setting 'enable_cache'
 
2087
        self.assertEqual({}, k._data._cache)
 
2088
 
 
2089
    def test_cache_data_read_raw(self):
 
2090
        k = self.create_knit()
 
2091
 
 
2092
        # Now cache and read
 
2093
        k.enable_cache()
 
2094
 
 
2095
        def read_one_raw(version):
 
2096
            pos_map = k._get_components_positions([version])
 
2097
            method, index_memo, next = pos_map[version]
 
2098
            lst = list(k._data.read_records_iter_raw([(version, index_memo)]))
 
2099
            self.assertEqual(1, len(lst))
 
2100
            return lst[0]
 
2101
 
 
2102
        val = read_one_raw('text-1')
 
2103
        self.assertEqual({'text-1':val[1]}, k._data._cache)
 
2104
 
 
2105
        k.clear_cache()
 
2106
        # After clear, new reads are not cached
 
2107
        self.assertEqual({}, k._data._cache)
 
2108
 
 
2109
        val2 = read_one_raw('text-1')
 
2110
        self.assertEqual(val, val2)
 
2111
        self.assertEqual({}, k._data._cache)
 
2112
 
 
2113
    def test_cache_data_read(self):
 
2114
        k = self.create_knit()
 
2115
 
 
2116
        def read_one(version):
 
2117
            pos_map = k._get_components_positions([version])
 
2118
            method, index_memo, next = pos_map[version]
 
2119
            lst = list(k._data.read_records_iter([(version, index_memo)]))
 
2120
            self.assertEqual(1, len(lst))
 
2121
            return lst[0]
 
2122
 
 
2123
        # Now cache and read
 
2124
        k.enable_cache()
 
2125
 
 
2126
        val = read_one('text-2')
 
2127
        self.assertEqual(['text-2'], k._data._cache.keys())
 
2128
        self.assertEqual('text-2', val[0])
 
2129
        content, digest = k._data._parse_record('text-2',
 
2130
                                                k._data._cache['text-2'])
 
2131
        self.assertEqual(content, val[1])
 
2132
        self.assertEqual(digest, val[2])
 
2133
 
 
2134
        k.clear_cache()
 
2135
        self.assertEqual({}, k._data._cache)
 
2136
 
 
2137
        val2 = read_one('text-2')
 
2138
        self.assertEqual(val, val2)
 
2139
        self.assertEqual({}, k._data._cache)
 
2140
 
 
2141
    def test_cache_read(self):
 
2142
        k = self.create_knit()
 
2143
        k.enable_cache()
 
2144
 
 
2145
        text = k.get_text('text-1')
 
2146
        self.assertEqual(TEXT_1, text)
 
2147
        self.assertEqual(['text-1'], k._data._cache.keys())
 
2148
 
 
2149
        k.clear_cache()
 
2150
        self.assertEqual({}, k._data._cache)
 
2151
 
 
2152
        text = k.get_text('text-1')
 
2153
        self.assertEqual(TEXT_1, text)
 
2154
        self.assertEqual({}, k._data._cache)
1503
2155
 
1504
2156
 
1505
2157
class TestKnitIndex(KnitTests):
1508
2160
        """Adding versions to the index should update the lookup dict"""
1509
2161
        knit = self.make_test_knit()
1510
2162
        idx = knit._index
1511
 
        idx.add_records([(('a-1',), ['fulltext'], (('a-1',), 0, 0), [])])
 
2163
        idx.add_version('a-1', ['fulltext'], (None, 0, 0), [])
1512
2164
        self.check_file_contents('test.kndx',
1513
2165
            '# bzr knit index 8\n'
1514
2166
            '\n'
1515
2167
            'a-1 fulltext 0 0  :'
1516
2168
            )
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
 
            ])
 
2169
        idx.add_versions([('a-2', ['fulltext'], (None, 0, 0), ['a-1']),
 
2170
                          ('a-3', ['fulltext'], (None, 0, 0), ['a-2']),
 
2171
                         ])
1521
2172
        self.check_file_contents('test.kndx',
1522
2173
            '# bzr knit index 8\n'
1523
2174
            '\n'
1525
2176
            'a-2 fulltext 0 0 0 :\n'
1526
2177
            'a-3 fulltext 0 0 1 :'
1527
2178
            )
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()))
 
2179
        self.assertEqual(['a-1', 'a-2', 'a-3'], idx._history)
 
2180
        self.assertEqual({'a-1':('a-1', ['fulltext'], 0, 0, (), 0),
 
2181
                          'a-2':('a-2', ['fulltext'], 0, 0, ('a-1',), 1),
 
2182
                          'a-3':('a-3', ['fulltext'], 0, 0, ('a-2',), 2),
 
2183
                         }, idx._cache)
1538
2184
 
1539
2185
    def test_add_versions_fails_clean(self):
1540
2186
        """If add_versions fails in the middle, it restores a pristine state.
1550
2196
 
1551
2197
        knit = self.make_test_knit()
1552
2198
        idx = knit._index
1553
 
        idx.add_records([(('a-1',), ['fulltext'], (('a-1',), 0, 0), [])])
 
2199
        idx.add_version('a-1', ['fulltext'], (None, 0, 0), [])
1554
2200
 
1555
2201
        class StopEarly(Exception):
1556
2202
            pass
1557
2203
 
1558
2204
        def generate_failure():
1559
2205
            """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',))
 
2206
            yield ('a-2', ['fulltext'], (None, 0, 0), ('a-1',))
 
2207
            yield ('a-3', ['fulltext'], (None, 0, 0), ('a-2',))
1562
2208
            raise StopEarly()
1563
2209
 
1564
2210
        # 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())
 
2211
        self.assertEqual(['a-1'], idx._history)
 
2212
        self.assertEqual({'a-1':('a-1', ['fulltext'], 0, 0, (), 0)}, idx._cache)
 
2213
 
 
2214
        self.assertRaises(StopEarly, idx.add_versions, generate_failure())
 
2215
 
1574
2216
        # And it shouldn't be modified
1575
 
        assertA1Only()
 
2217
        self.assertEqual(['a-1'], idx._history)
 
2218
        self.assertEqual({'a-1':('a-1', ['fulltext'], 0, 0, (), 0)}, idx._cache)
1576
2219
 
1577
2220
    def test_knit_index_ignores_empty_files(self):
1578
2221
        # There was a race condition in older bzr, where a ^C at the right time
1587
2230
    def test_knit_index_checks_header(self):
1588
2231
        t = get_transport('.')
1589
2232
        t.put_bytes('test.kndx', '# not really a knit header\n\n')
1590
 
        k = self.make_test_knit()
1591
 
        self.assertRaises(KnitHeaderError, k.keys)
 
2233
 
 
2234
        self.assertRaises(KnitHeaderError, self.make_test_knit)
1592
2235
 
1593
2236
 
1594
2237
class TestGraphIndexKnit(KnitTests):
1633
2276
            add_callback = self.catch_add
1634
2277
        else:
1635
2278
            add_callback = None
1636
 
        return _KnitGraphIndex(combined_index, lambda:True, deltas=deltas,
 
2279
        return KnitGraphIndex(combined_index, deltas=deltas,
1637
2280
            add_callback=add_callback)
1638
2281
 
1639
 
    def test_keys(self):
1640
 
        index = self.two_graph_index()
1641
 
        self.assertEqual(set([('tail',), ('tip',), ('parent',), ('separate',)]),
1642
 
            set(index.keys()))
 
2282
    def test_get_ancestry(self):
 
2283
        # get_ancestry is defined as eliding ghosts, not erroring.
 
2284
        index = self.two_graph_index()
 
2285
        self.assertEqual([], index.get_ancestry([]))
 
2286
        self.assertEqual(['separate'], index.get_ancestry(['separate']))
 
2287
        self.assertEqual(['tail'], index.get_ancestry(['tail']))
 
2288
        self.assertEqual(['tail', 'parent'], index.get_ancestry(['parent']))
 
2289
        self.assertEqual(['tail', 'parent', 'tip'], index.get_ancestry(['tip']))
 
2290
        self.assertTrue(index.get_ancestry(['tip', 'separate']) in
 
2291
            (['tail', 'parent', 'tip', 'separate'],
 
2292
             ['separate', 'tail', 'parent', 'tip'],
 
2293
            ))
 
2294
        # and without topo_sort
 
2295
        self.assertEqual(set(['separate']),
 
2296
            set(index.get_ancestry(['separate'], topo_sorted=False)))
 
2297
        self.assertEqual(set(['tail']),
 
2298
            set(index.get_ancestry(['tail'], topo_sorted=False)))
 
2299
        self.assertEqual(set(['tail', 'parent']),
 
2300
            set(index.get_ancestry(['parent'], topo_sorted=False)))
 
2301
        self.assertEqual(set(['tail', 'parent', 'tip']),
 
2302
            set(index.get_ancestry(['tip'], topo_sorted=False)))
 
2303
        self.assertEqual(set(['separate', 'tail', 'parent', 'tip']),
 
2304
            set(index.get_ancestry(['tip', 'separate'])))
 
2305
        # asking for a ghost makes it go boom.
 
2306
        self.assertRaises(errors.RevisionNotPresent, index.get_ancestry, ['ghost'])
 
2307
 
 
2308
    def test_get_ancestry_with_ghosts(self):
 
2309
        index = self.two_graph_index()
 
2310
        self.assertEqual([], index.get_ancestry_with_ghosts([]))
 
2311
        self.assertEqual(['separate'], index.get_ancestry_with_ghosts(['separate']))
 
2312
        self.assertEqual(['tail'], index.get_ancestry_with_ghosts(['tail']))
 
2313
        self.assertTrue(index.get_ancestry_with_ghosts(['parent']) in
 
2314
            (['tail', 'ghost', 'parent'],
 
2315
             ['ghost', 'tail', 'parent'],
 
2316
            ))
 
2317
        self.assertTrue(index.get_ancestry_with_ghosts(['tip']) in
 
2318
            (['tail', 'ghost', 'parent', 'tip'],
 
2319
             ['ghost', 'tail', 'parent', 'tip'],
 
2320
            ))
 
2321
        self.assertTrue(index.get_ancestry_with_ghosts(['tip', 'separate']) in
 
2322
            (['tail', 'ghost', 'parent', 'tip', 'separate'],
 
2323
             ['ghost', 'tail', 'parent', 'tip', 'separate'],
 
2324
             ['separate', 'tail', 'ghost', 'parent', 'tip'],
 
2325
             ['separate', 'ghost', 'tail', 'parent', 'tip'],
 
2326
            ))
 
2327
        # asking for a ghost makes it go boom.
 
2328
        self.assertRaises(errors.RevisionNotPresent, index.get_ancestry_with_ghosts, ['ghost'])
 
2329
 
 
2330
    def test_num_versions(self):
 
2331
        index = self.two_graph_index()
 
2332
        self.assertEqual(4, index.num_versions())
 
2333
 
 
2334
    def test_get_versions(self):
 
2335
        index = self.two_graph_index()
 
2336
        self.assertEqual(set(['tail', 'tip', 'parent', 'separate']),
 
2337
            set(index.get_versions()))
 
2338
 
 
2339
    def test_has_version(self):
 
2340
        index = self.two_graph_index()
 
2341
        self.assertTrue(index.has_version('tail'))
 
2342
        self.assertFalse(index.has_version('ghost'))
1643
2343
 
1644
2344
    def test_get_position(self):
1645
2345
        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',)))
 
2346
        self.assertEqual((index._graph_index._indices[0], 0, 100), index.get_position('tip'))
 
2347
        self.assertEqual((index._graph_index._indices[1], 100, 78), index.get_position('parent'))
1648
2348
 
1649
2349
    def test_get_method_deltas(self):
1650
2350
        index = self.two_graph_index(deltas=True)
1651
 
        self.assertEqual('fulltext', index.get_method(('tip',)))
1652
 
        self.assertEqual('line-delta', index.get_method(('parent',)))
 
2351
        self.assertEqual('fulltext', index.get_method('tip'))
 
2352
        self.assertEqual('line-delta', index.get_method('parent'))
1653
2353
 
1654
2354
    def test_get_method_no_deltas(self):
1655
2355
        # check that the parent-history lookup is ignored with deltas=False.
1656
2356
        index = self.two_graph_index(deltas=False)
1657
 
        self.assertEqual('fulltext', index.get_method(('tip',)))
1658
 
        self.assertEqual('fulltext', index.get_method(('parent',)))
 
2357
        self.assertEqual('fulltext', index.get_method('tip'))
 
2358
        self.assertEqual('fulltext', index.get_method('parent'))
1659
2359
 
1660
2360
    def test_get_options_deltas(self):
1661
2361
        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',)))
 
2362
        self.assertEqual(['fulltext', 'no-eol'], index.get_options('tip'))
 
2363
        self.assertEqual(['line-delta'], index.get_options('parent'))
1664
2364
 
1665
2365
    def test_get_options_no_deltas(self):
1666
2366
        # check that the parent-history lookup is ignored with deltas=False.
1667
2367
        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',)]))
 
2368
        self.assertEqual(['fulltext', 'no-eol'], index.get_options('tip'))
 
2369
        self.assertEqual(['fulltext'], index.get_options('parent'))
 
2370
 
 
2371
    def test_get_parents_with_ghosts(self):
 
2372
        index = self.two_graph_index()
 
2373
        self.assertEqual(('tail', 'ghost'), index.get_parents_with_ghosts('parent'))
 
2374
        # and errors on ghosts.
 
2375
        self.assertRaises(errors.RevisionNotPresent,
 
2376
            index.get_parents_with_ghosts, 'ghost')
 
2377
 
 
2378
    def test_check_versions_present(self):
 
2379
        # ghosts should not be considered present
 
2380
        index = self.two_graph_index()
 
2381
        self.assertRaises(RevisionNotPresent, index.check_versions_present,
 
2382
            ['ghost'])
 
2383
        self.assertRaises(RevisionNotPresent, index.check_versions_present,
 
2384
            ['tail', 'ghost'])
 
2385
        index.check_versions_present(['tail', 'separate'])
1675
2386
 
1676
2387
    def catch_add(self, entries):
1677
2388
        self.caught_entries.append(entries)
1678
2389
 
1679
2390
    def test_add_no_callback_errors(self):
1680
2391
        index = self.two_graph_index()
1681
 
        self.assertRaises(errors.ReadOnlyError, index.add_records,
1682
 
            [(('new',), 'fulltext,no-eol', (None, 50, 60), ['separate'])])
 
2392
        self.assertRaises(errors.ReadOnlyError, index.add_version,
 
2393
            'new', 'fulltext,no-eol', (None, 50, 60), ['separate'])
1683
2394
 
1684
2395
    def test_add_version_smoke(self):
1685
2396
        index = self.two_graph_index(catch_adds=True)
1686
 
        index.add_records([(('new',), 'fulltext,no-eol', (None, 50, 60),
1687
 
            [('separate',)])])
 
2397
        index.add_version('new', 'fulltext,no-eol', (None, 50, 60), ['separate'])
1688
2398
        self.assertEqual([[(('new', ), 'N50 60', ((('separate',),),))]],
1689
2399
            self.caught_entries)
1690
2400
 
1691
2401
    def test_add_version_delta_not_delta_index(self):
1692
2402
        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',)])])
 
2403
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
2404
            'new', 'no-eol,line-delta', (None, 0, 100), ['parent'])
1695
2405
        self.assertEqual([], self.caught_entries)
1696
2406
 
1697
2407
    def test_add_version_same_dup(self):
1698
2408
        index = self.two_graph_index(catch_adds=True)
1699
2409
        # 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
 
 
 
2410
        index.add_version('tip', 'fulltext,no-eol', (None, 0, 100), ['parent'])
 
2411
        index.add_version('tip', 'no-eol,fulltext', (None, 0, 100), ['parent'])
 
2412
        # but neither should have added data.
 
2413
        self.assertEqual([[], []], self.caught_entries)
 
2414
        
1711
2415
    def test_add_version_different_dup(self):
1712
2416
        index = self.two_graph_index(deltas=True, catch_adds=True)
1713
2417
        # 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',)])])
 
2418
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
2419
            'tip', 'no-eol,line-delta', (None, 0, 100), ['parent'])
 
2420
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
2421
            'tip', 'line-delta,no-eol', (None, 0, 100), ['parent'])
 
2422
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
2423
            'tip', 'fulltext', (None, 0, 100), ['parent'])
 
2424
        # position/length
 
2425
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
2426
            'tip', 'fulltext,no-eol', (None, 50, 100), ['parent'])
 
2427
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
2428
            'tip', 'fulltext,no-eol', (None, 0, 1000), ['parent'])
1718
2429
        # parents
1719
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
1720
 
            [(('tip',), 'fulltext,no-eol', (None, 0, 100), [])])
 
2430
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
2431
            'tip', 'fulltext,no-eol', (None, 0, 100), [])
1721
2432
        self.assertEqual([], self.caught_entries)
1722
 
 
 
2433
        
1723
2434
    def test_add_versions_nodeltas(self):
1724
2435
        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',)]),
 
2436
        index.add_versions([
 
2437
                ('new', 'fulltext,no-eol', (None, 50, 60), ['separate']),
 
2438
                ('new2', 'fulltext', (None, 0, 6), ['new']),
1728
2439
                ])
1729
2440
        self.assertEqual([(('new', ), 'N50 60', ((('separate',),),)),
1730
2441
            (('new2', ), ' 0 6', ((('new',),),))],
1733
2444
 
1734
2445
    def test_add_versions_deltas(self):
1735
2446
        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',)]),
 
2447
        index.add_versions([
 
2448
                ('new', 'fulltext,no-eol', (None, 50, 60), ['separate']),
 
2449
                ('new2', 'line-delta', (None, 0, 6), ['new']),
1739
2450
                ])
1740
2451
        self.assertEqual([(('new', ), 'N50 60', ((('separate',),), ())),
1741
2452
            (('new2', ), ' 0 6', ((('new',),), (('new',),), ))],
1744
2455
 
1745
2456
    def test_add_versions_delta_not_delta_index(self):
1746
2457
        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',)])])
 
2458
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2459
            [('new', 'no-eol,line-delta', (None, 0, 100), ['parent'])])
1749
2460
        self.assertEqual([], self.caught_entries)
1750
2461
 
1751
2462
    def test_add_versions_random_id_accepted(self):
1752
2463
        index = self.two_graph_index(catch_adds=True)
1753
 
        index.add_records([], random_id=True)
 
2464
        index.add_versions([], random_id=True)
1754
2465
 
1755
2466
    def test_add_versions_same_dup(self):
1756
2467
        index = self.two_graph_index(catch_adds=True)
1757
2468
        # 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',)])])
 
2469
        index.add_versions([('tip', 'fulltext,no-eol', (None, 0, 100), ['parent'])])
 
2470
        index.add_versions([('tip', 'no-eol,fulltext', (None, 0, 100), ['parent'])])
1768
2471
        # but neither should have added data.
1769
 
        self.assertEqual([[], [], [], []], self.caught_entries)
1770
 
 
 
2472
        self.assertEqual([[], []], self.caught_entries)
 
2473
        
1771
2474
    def test_add_versions_different_dup(self):
1772
2475
        index = self.two_graph_index(deltas=True, catch_adds=True)
1773
2476
        # 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',)])])
 
2477
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2478
            [('tip', 'no-eol,line-delta', (None, 0, 100), ['parent'])])
 
2479
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2480
            [('tip', 'line-delta,no-eol', (None, 0, 100), ['parent'])])
 
2481
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2482
            [('tip', 'fulltext', (None, 0, 100), ['parent'])])
 
2483
        # position/length
 
2484
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2485
            [('tip', 'fulltext,no-eol', (None, 50, 100), ['parent'])])
 
2486
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2487
            [('tip', 'fulltext,no-eol', (None, 0, 1000), ['parent'])])
1778
2488
        # parents
1779
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
1780
 
            [(('tip',), 'fulltext,no-eol', (None, 0, 100), [])])
 
2489
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2490
            [('tip', 'fulltext,no-eol', (None, 0, 100), [])])
1781
2491
        # 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',)])])
 
2492
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2493
            [('tip', 'fulltext,no-eol', (None, 0, 100), ['parent']),
 
2494
             ('tip', 'no-eol,line-delta', (None, 0, 100), ['parent'])])
1785
2495
        self.assertEqual([], self.caught_entries)
1786
2496
 
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())
 
2497
    def test_iter_parents(self):
 
2498
        index1 = self.make_g_index('1', 1, [
 
2499
        # no parents
 
2500
            (('r0', ), 'N0 100', ([], )),
 
2501
        # 1 parent
 
2502
            (('r1', ), '', ([('r0', )], ))])
 
2503
        index2 = self.make_g_index('2', 1, [
 
2504
        # 2 parents
 
2505
            (('r2', ), 'N0 100', ([('r1', ), ('r0', )], )),
 
2506
            ])
 
2507
        combined_index = CombinedGraphIndex([index1, index2])
 
2508
        index = KnitGraphIndex(combined_index)
 
2509
        # XXX TODO a ghost
 
2510
        # cases: each sample data individually:
 
2511
        self.assertEqual(set([('r0', ())]),
 
2512
            set(index.iter_parents(['r0'])))
 
2513
        self.assertEqual(set([('r1', ('r0', ))]),
 
2514
            set(index.iter_parents(['r1'])))
 
2515
        self.assertEqual(set([('r2', ('r1', 'r0'))]),
 
2516
            set(index.iter_parents(['r2'])))
 
2517
        # no nodes returned for a missing node
 
2518
        self.assertEqual(set(),
 
2519
            set(index.iter_parents(['missing'])))
 
2520
        # 1 node returned with missing nodes skipped
 
2521
        self.assertEqual(set([('r1', ('r0', ))]),
 
2522
            set(index.iter_parents(['ghost1', 'r1', 'ghost'])))
 
2523
        # 2 nodes returned
 
2524
        self.assertEqual(set([('r0', ()), ('r1', ('r0', ))]),
 
2525
            set(index.iter_parents(['r0', 'r1'])))
 
2526
        # 2 nodes returned, missing skipped
 
2527
        self.assertEqual(set([('r0', ()), ('r1', ('r0', ))]),
 
2528
            set(index.iter_parents(['a', 'r0', 'b', 'r1', 'c'])))
1891
2529
 
1892
2530
 
1893
2531
class TestNoParentsGraphIndexKnit(KnitTests):
1894
 
    """Tests for knits using _KnitGraphIndex with no parents."""
 
2532
    """Tests for knits using KnitGraphIndex with no parents."""
1895
2533
 
1896
2534
    def make_g_index(self, name, ref_lists=0, nodes=[]):
1897
2535
        builder = GraphIndexBuilder(ref_lists)
1902
2540
        size = trans.put_file(name, stream)
1903
2541
        return GraphIndex(trans, name, size)
1904
2542
 
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
2543
    def test_parents_deltas_incompatible(self):
1914
2544
        index = CombinedGraphIndex([])
1915
 
        self.assertRaises(errors.KnitError, _KnitGraphIndex, lambda:True,
1916
 
            index, deltas=True, parents=False)
 
2545
        self.assertRaises(errors.KnitError, KnitGraphIndex, index,
 
2546
            deltas=True, parents=False)
1917
2547
 
1918
2548
    def two_graph_index(self, catch_adds=False):
1919
2549
        """Build a two-graph index.
1935
2565
            add_callback = self.catch_add
1936
2566
        else:
1937
2567
            add_callback = None
1938
 
        return _KnitGraphIndex(combined_index, lambda:True, parents=False,
 
2568
        return KnitGraphIndex(combined_index, parents=False,
1939
2569
            add_callback=add_callback)
1940
2570
 
1941
 
    def test_keys(self):
1942
 
        index = self.two_graph_index()
1943
 
        self.assertEqual(set([('tail',), ('tip',), ('parent',), ('separate',)]),
1944
 
            set(index.keys()))
 
2571
    def test_get_ancestry(self):
 
2572
        # with no parents, ancestry is always just the key.
 
2573
        index = self.two_graph_index()
 
2574
        self.assertEqual([], index.get_ancestry([]))
 
2575
        self.assertEqual(['separate'], index.get_ancestry(['separate']))
 
2576
        self.assertEqual(['tail'], index.get_ancestry(['tail']))
 
2577
        self.assertEqual(['parent'], index.get_ancestry(['parent']))
 
2578
        self.assertEqual(['tip'], index.get_ancestry(['tip']))
 
2579
        self.assertTrue(index.get_ancestry(['tip', 'separate']) in
 
2580
            (['tip', 'separate'],
 
2581
             ['separate', 'tip'],
 
2582
            ))
 
2583
        # asking for a ghost makes it go boom.
 
2584
        self.assertRaises(errors.RevisionNotPresent, index.get_ancestry, ['ghost'])
 
2585
 
 
2586
    def test_get_ancestry_with_ghosts(self):
 
2587
        index = self.two_graph_index()
 
2588
        self.assertEqual([], index.get_ancestry_with_ghosts([]))
 
2589
        self.assertEqual(['separate'], index.get_ancestry_with_ghosts(['separate']))
 
2590
        self.assertEqual(['tail'], index.get_ancestry_with_ghosts(['tail']))
 
2591
        self.assertEqual(['parent'], index.get_ancestry_with_ghosts(['parent']))
 
2592
        self.assertEqual(['tip'], index.get_ancestry_with_ghosts(['tip']))
 
2593
        self.assertTrue(index.get_ancestry_with_ghosts(['tip', 'separate']) in
 
2594
            (['tip', 'separate'],
 
2595
             ['separate', 'tip'],
 
2596
            ))
 
2597
        # asking for a ghost makes it go boom.
 
2598
        self.assertRaises(errors.RevisionNotPresent, index.get_ancestry_with_ghosts, ['ghost'])
 
2599
 
 
2600
    def test_num_versions(self):
 
2601
        index = self.two_graph_index()
 
2602
        self.assertEqual(4, index.num_versions())
 
2603
 
 
2604
    def test_get_versions(self):
 
2605
        index = self.two_graph_index()
 
2606
        self.assertEqual(set(['tail', 'tip', 'parent', 'separate']),
 
2607
            set(index.get_versions()))
 
2608
 
 
2609
    def test_has_version(self):
 
2610
        index = self.two_graph_index()
 
2611
        self.assertTrue(index.has_version('tail'))
 
2612
        self.assertFalse(index.has_version('ghost'))
1945
2613
 
1946
2614
    def test_get_position(self):
1947
2615
        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',)))
 
2616
        self.assertEqual((index._graph_index._indices[0], 0, 100), index.get_position('tip'))
 
2617
        self.assertEqual((index._graph_index._indices[1], 100, 78), index.get_position('parent'))
1952
2618
 
1953
2619
    def test_get_method(self):
1954
2620
        index = self.two_graph_index()
1955
 
        self.assertEqual('fulltext', index.get_method(('tip',)))
1956
 
        self.assertEqual(['fulltext'], index.get_options(('parent',)))
 
2621
        self.assertEqual('fulltext', index.get_method('tip'))
 
2622
        self.assertEqual(['fulltext'], index.get_options('parent'))
1957
2623
 
1958
2624
    def test_get_options(self):
1959
2625
        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',)]))
 
2626
        self.assertEqual(['fulltext', 'no-eol'], index.get_options('tip'))
 
2627
        self.assertEqual(['fulltext'], index.get_options('parent'))
 
2628
 
 
2629
    def test_get_parents_with_ghosts(self):
 
2630
        index = self.two_graph_index()
 
2631
        self.assertEqual((), index.get_parents_with_ghosts('parent'))
 
2632
        # and errors on ghosts.
 
2633
        self.assertRaises(errors.RevisionNotPresent,
 
2634
            index.get_parents_with_ghosts, 'ghost')
 
2635
 
 
2636
    def test_check_versions_present(self):
 
2637
        index = self.two_graph_index()
 
2638
        self.assertRaises(RevisionNotPresent, index.check_versions_present,
 
2639
            ['missing'])
 
2640
        self.assertRaises(RevisionNotPresent, index.check_versions_present,
 
2641
            ['tail', 'missing'])
 
2642
        index.check_versions_present(['tail', 'separate'])
1967
2643
 
1968
2644
    def catch_add(self, entries):
1969
2645
        self.caught_entries.append(entries)
1970
2646
 
1971
2647
    def test_add_no_callback_errors(self):
1972
2648
        index = self.two_graph_index()
1973
 
        self.assertRaises(errors.ReadOnlyError, index.add_records,
1974
 
            [(('new',), 'fulltext,no-eol', (None, 50, 60), [('separate',)])])
 
2649
        self.assertRaises(errors.ReadOnlyError, index.add_version,
 
2650
            'new', 'fulltext,no-eol', (None, 50, 60), ['separate'])
1975
2651
 
1976
2652
    def test_add_version_smoke(self):
1977
2653
        index = self.two_graph_index(catch_adds=True)
1978
 
        index.add_records([(('new',), 'fulltext,no-eol', (None, 50, 60), [])])
 
2654
        index.add_version('new', 'fulltext,no-eol', (None, 50, 60), [])
1979
2655
        self.assertEqual([[(('new', ), 'N50 60')]],
1980
2656
            self.caught_entries)
1981
2657
 
1982
2658
    def test_add_version_delta_not_delta_index(self):
1983
2659
        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), [])])
 
2660
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
2661
            'new', 'no-eol,line-delta', (None, 0, 100), [])
1986
2662
        self.assertEqual([], self.caught_entries)
1987
2663
 
1988
2664
    def test_add_version_same_dup(self):
1989
2665
        index = self.two_graph_index(catch_adds=True)
1990
2666
        # 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), [])])
 
2667
        index.add_version('tip', 'fulltext,no-eol', (None, 0, 100), [])
 
2668
        index.add_version('tip', 'no-eol,fulltext', (None, 0, 100), [])
1997
2669
        # but neither should have added data.
1998
 
        self.assertEqual([[], [], [], []], self.caught_entries)
1999
 
 
 
2670
        self.assertEqual([[], []], self.caught_entries)
 
2671
        
2000
2672
    def test_add_version_different_dup(self):
2001
2673
        index = self.two_graph_index(catch_adds=True)
2002
2674
        # 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), [])])
 
2675
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
2676
            'tip', 'no-eol,line-delta', (None, 0, 100), [])
 
2677
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
2678
            'tip', 'line-delta,no-eol', (None, 0, 100), [])
 
2679
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
2680
            'tip', 'fulltext', (None, 0, 100), [])
 
2681
        # position/length
 
2682
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
2683
            'tip', 'fulltext,no-eol', (None, 50, 100), [])
 
2684
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
2685
            'tip', 'fulltext,no-eol', (None, 0, 1000), [])
2009
2686
        # parents
2010
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
2011
 
            [(('tip',), 'fulltext,no-eol', (None, 0, 100), [('parent',)])])
 
2687
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
2688
            'tip', 'fulltext,no-eol', (None, 0, 100), ['parent'])
2012
2689
        self.assertEqual([], self.caught_entries)
2013
 
 
 
2690
        
2014
2691
    def test_add_versions(self):
2015
2692
        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), []),
 
2693
        index.add_versions([
 
2694
                ('new', 'fulltext,no-eol', (None, 50, 60), []),
 
2695
                ('new2', 'fulltext', (None, 0, 6), []),
2019
2696
                ])
2020
2697
        self.assertEqual([(('new', ), 'N50 60'), (('new2', ), ' 0 6')],
2021
2698
            sorted(self.caught_entries[0]))
2023
2700
 
2024
2701
    def test_add_versions_delta_not_delta_index(self):
2025
2702
        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',)])])
 
2703
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2704
            [('new', 'no-eol,line-delta', (None, 0, 100), ['parent'])])
2028
2705
        self.assertEqual([], self.caught_entries)
2029
2706
 
2030
2707
    def test_add_versions_parents_not_parents_index(self):
2031
2708
        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',)])])
 
2709
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2710
            [('new', 'no-eol,fulltext', (None, 0, 100), ['parent'])])
2034
2711
        self.assertEqual([], self.caught_entries)
2035
2712
 
2036
2713
    def test_add_versions_random_id_accepted(self):
2037
2714
        index = self.two_graph_index(catch_adds=True)
2038
 
        index.add_records([], random_id=True)
 
2715
        index.add_versions([], random_id=True)
2039
2716
 
2040
2717
    def test_add_versions_same_dup(self):
2041
2718
        index = self.two_graph_index(catch_adds=True)
2042
2719
        # 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), [])])
 
2720
        index.add_versions([('tip', 'fulltext,no-eol', (None, 0, 100), [])])
 
2721
        index.add_versions([('tip', 'no-eol,fulltext', (None, 0, 100), [])])
2049
2722
        # but neither should have added data.
2050
 
        self.assertEqual([[], [], [], []], self.caught_entries)
2051
 
 
 
2723
        self.assertEqual([[], []], self.caught_entries)
 
2724
        
2052
2725
    def test_add_versions_different_dup(self):
2053
2726
        index = self.two_graph_index(catch_adds=True)
2054
2727
        # 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), [])])
 
2728
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2729
            [('tip', 'no-eol,line-delta', (None, 0, 100), [])])
 
2730
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2731
            [('tip', 'line-delta,no-eol', (None, 0, 100), [])])
 
2732
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2733
            [('tip', 'fulltext', (None, 0, 100), [])])
 
2734
        # position/length
 
2735
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2736
            [('tip', 'fulltext,no-eol', (None, 50, 100), [])])
 
2737
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2738
            [('tip', 'fulltext,no-eol', (None, 0, 1000), [])])
2061
2739
        # parents
2062
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
2063
 
            [(('tip',), 'fulltext,no-eol', (None, 0, 100), [('parent',)])])
 
2740
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2741
            [('tip', 'fulltext,no-eol', (None, 0, 100), ['parent'])])
2064
2742
        # 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), [])])
 
2743
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2744
            [('tip', 'fulltext,no-eol', (None, 0, 100), []),
 
2745
             ('tip', 'no-eol,line-delta', (None, 0, 100), [])])
2068
2746
        self.assertEqual([], self.caught_entries)
2069
2747
 
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)
 
2748
    def test_iter_parents(self):
 
2749
        index = self.two_graph_index()
 
2750
        self.assertEqual(set([
 
2751
            ('tip', ()), ('tail', ()), ('parent', ()), ('separate', ())
 
2752
            ]),
 
2753
            set(index.iter_parents(['tip', 'tail', 'ghost', 'parent', 'separate'])))
 
2754
        self.assertEqual(set([('tip', ())]),
 
2755
            set(index.iter_parents(['tip'])))
 
2756
        self.assertEqual(set(),
 
2757
            set(index.iter_parents([])))
 
2758
 
 
2759
 
 
2760
class TestPackKnits(KnitTests):
 
2761
    """Tests that use a _PackAccess and KnitGraphIndex."""
 
2762
 
 
2763
    def test_get_data_stream_packs_ignores_pack_overhead(self):
 
2764
        # Packs have an encoding overhead that should not be included in the
 
2765
        # 'size' field of a data stream, because it is not returned by the
 
2766
        # raw_reading functions - it is why index_memo's are opaque, and
 
2767
        # get_data_stream was abusing this.
 
2768
        packname = 'test.pack'
 
2769
        transport = self.get_transport()
 
2770
        def write_data(bytes):
 
2771
            transport.append_bytes(packname, bytes)
 
2772
        writer = pack.ContainerWriter(write_data)
 
2773
        writer.begin()
 
2774
        index = InMemoryGraphIndex(2)
 
2775
        knit_index = KnitGraphIndex(index, add_callback=index.add_nodes,
 
2776
            deltas=True)
 
2777
        indices = {index:(transport, packname)}
 
2778
        access = _PackAccess(indices, writer=(writer, index))
 
2779
        k = KnitVersionedFile('test', get_transport('.'),
 
2780
            delta=True, create=True, index=knit_index, access_method=access)
 
2781
        # insert something into the knit
 
2782
        k.add_lines('text-1', [], ["foo\n"])
 
2783
        # get a data stream for it
 
2784
        stream = k.get_data_stream(['text-1'])
 
2785
        # if the stream has been incorrectly assembled, we will get a short read
 
2786
        # reading from the stream (as streams have no trailer)
 
2787
        expected_length = stream[1][0][2]
 
2788
        # we use -1 to do the read, so that if a trailer is added this test
 
2789
        # will fail and we'll adjust it to handle that case correctly, rather
 
2790
        # than allowing an over-read that is bogus.
 
2791
        self.assertEqual(expected_length, len(stream[2](-1)))
 
2792
 
 
2793
 
 
2794
class Test_StreamIndex(KnitTests):
 
2795
 
 
2796
    def get_index(self, knit, stream):
 
2797
        """Get a _StreamIndex from knit and stream."""
 
2798
        return knit._knit_from_datastream(stream)._index
 
2799
 
 
2800
    def assertIndexVersions(self, knit, versions):
 
2801
        """Check that the _StreamIndex versions are those of the stream."""
 
2802
        index = self.get_index(knit, knit.get_data_stream(versions))
 
2803
        self.assertEqual(set(index.get_versions()), set(versions))
 
2804
        # check we didn't get duplicates
 
2805
        self.assertEqual(len(index.get_versions()), len(versions))
 
2806
 
 
2807
    def assertIndexAncestry(self, knit, ancestry_versions, versions, result):
 
2808
        """Check the result of a get_ancestry call on knit."""
 
2809
        index = self.get_index(knit, knit.get_data_stream(versions))
 
2810
        self.assertEqual(
 
2811
            set(result),
 
2812
            set(index.get_ancestry(ancestry_versions, False)))
 
2813
 
 
2814
    def assertIterParents(self, knit, versions, parent_versions, result):
 
2815
        """Check the result of an iter_parents call on knit."""
 
2816
        index = self.get_index(knit, knit.get_data_stream(versions))
 
2817
        self.assertEqual(result, index.iter_parents(parent_versions))
 
2818
 
 
2819
    def assertGetMethod(self, knit, versions, version, result):
 
2820
        index = self.get_index(knit, knit.get_data_stream(versions))
 
2821
        self.assertEqual(result, index.get_method(version))
 
2822
 
 
2823
    def assertGetOptions(self, knit, version, options):
 
2824
        index = self.get_index(knit, knit.get_data_stream(version))
 
2825
        self.assertEqual(options, index.get_options(version))
 
2826
 
 
2827
    def assertGetPosition(self, knit, versions, version, result):
 
2828
        index = self.get_index(knit, knit.get_data_stream(versions))
 
2829
        if result[1] is None:
 
2830
            result = (result[0], index, result[2], result[3])
 
2831
        self.assertEqual(result, index.get_position(version))
 
2832
 
 
2833
    def assertGetParentsWithGhosts(self, knit, versions, version, parents):
 
2834
        index = self.get_index(knit, knit.get_data_stream(versions))
 
2835
        self.assertEqual(parents, index.get_parents_with_ghosts(version))
 
2836
 
 
2837
    def make_knit_with_4_versions_2_dags(self):
 
2838
        knit = self.make_test_knit()
 
2839
        knit.add_lines('a', [], ["foo"])
 
2840
        knit.add_lines('b', [], [])
 
2841
        knit.add_lines('c', ['b', 'a'], [])
 
2842
        knit.add_lines_with_ghosts('d', ['e', 'f'], [])
 
2843
        return knit
 
2844
 
 
2845
    def test_versions(self):
 
2846
        """The versions of a StreamIndex are those of the datastream."""
 
2847
        knit = self.make_knit_with_4_versions_2_dags()
 
2848
        # ask for most permutations, which catches bugs like falling back to the
 
2849
        # target knit, or showing ghosts, etc.
 
2850
        self.assertIndexVersions(knit, [])
 
2851
        self.assertIndexVersions(knit, ['a'])
 
2852
        self.assertIndexVersions(knit, ['b'])
 
2853
        self.assertIndexVersions(knit, ['c'])
 
2854
        self.assertIndexVersions(knit, ['d'])
 
2855
        self.assertIndexVersions(knit, ['a', 'b'])
 
2856
        self.assertIndexVersions(knit, ['b', 'c'])
 
2857
        self.assertIndexVersions(knit, ['a', 'c'])
 
2858
        self.assertIndexVersions(knit, ['a', 'b', 'c'])
 
2859
        self.assertIndexVersions(knit, ['a', 'b', 'c', 'd'])
 
2860
 
 
2861
    def test_construct(self):
 
2862
        """Constructing a StreamIndex generates index data."""
 
2863
        data_list = [('text-a', ['fulltext'], 127, []),
 
2864
            ('text-b', ['option'], 128, ['text-c'])]
 
2865
        index = _StreamIndex(data_list, None)
 
2866
        self.assertEqual({'text-a':(['fulltext'], (0, 127), []),
 
2867
            'text-b':(['option'], (127, 127 + 128), ['text-c'])},
 
2868
            index._by_version)
 
2869
 
 
2870
    def test_get_ancestry(self):
 
2871
        knit = self.make_knit_with_4_versions_2_dags()
 
2872
        self.assertIndexAncestry(knit, ['a'], ['a'], ['a'])
 
2873
        self.assertIndexAncestry(knit, ['b'], ['b'], ['b'])
 
2874
        self.assertIndexAncestry(knit, ['c'], ['c'], ['c'])
 
2875
        self.assertIndexAncestry(knit, ['c'], ['a', 'b', 'c'],
 
2876
            set(['a', 'b', 'c']))
 
2877
        self.assertIndexAncestry(knit, ['c', 'd'], ['a', 'b', 'c', 'd'],
 
2878
            set(['a', 'b', 'c', 'd']))
 
2879
 
 
2880
    def test_get_method(self):
 
2881
        knit = self.make_knit_with_4_versions_2_dags()
 
2882
        self.assertGetMethod(knit, ['a'], 'a', 'fulltext')
 
2883
        self.assertGetMethod(knit, ['c'], 'c', 'line-delta')
 
2884
        # get_method on a basis that is not in the datastream (but in the
 
2885
        # backing knit) returns 'fulltext', because thats what we'll create as
 
2886
        # we thunk across.
 
2887
        self.assertGetMethod(knit, ['c'], 'b', 'fulltext')
 
2888
 
 
2889
    def test_iter_parents(self):
 
2890
        knit = self.make_knit_with_4_versions_2_dags()
 
2891
        self.assertIterParents(knit, ['a'], ['a'], [('a', ())])
 
2892
        self.assertIterParents(knit, ['a', 'b'], ['a', 'b'],
 
2893
            [('a', ()), ('b', ())])
 
2894
        self.assertIterParents(knit, ['a', 'b', 'c'], ['a', 'b', 'c'],
 
2895
            [('a', ()), ('b', ()), ('c', ('b', 'a'))])
 
2896
        self.assertIterParents(knit, ['a', 'b', 'c', 'd'],
 
2897
            ['a', 'b', 'c', 'd'],
 
2898
            [('a', ()), ('b', ()), ('c', ('b', 'a')), ('d', ('e', 'f'))])
 
2899
        self.assertIterParents(knit, ['c'], ['a', 'b', 'c'],
 
2900
            [('c', ('b', 'a'))])
 
2901
 
 
2902
    def test_get_options(self):
 
2903
        knit = self.make_knit_with_4_versions_2_dags()
 
2904
        self.assertGetOptions(knit, 'a', ['no-eol', 'fulltext'])
 
2905
        self.assertGetOptions(knit, 'c', ['line-delta'])
 
2906
 
 
2907
    def test_get_parents_with_ghosts(self):
 
2908
        knit = self.make_knit_with_4_versions_2_dags()
 
2909
        self.assertGetParentsWithGhosts(knit, ['a'], 'a', ())
 
2910
        self.assertGetParentsWithGhosts(knit, ['c'], 'c', ('b', 'a'))
 
2911
        self.assertGetParentsWithGhosts(knit, ['d'], 'd', ('e', 'f'))
 
2912
 
 
2913
    def test_get_position(self):
 
2914
        knit = self.make_knit_with_4_versions_2_dags()
 
2915
        # get_position returns (thunk_flag, index(can be None), start, end) for
 
2916
        # _StreamAccess to use.
 
2917
        self.assertGetPosition(knit, ['a'], 'a', (False, None, 0, 78))
 
2918
        self.assertGetPosition(knit, ['a', 'c'], 'c', (False, None, 78, 156))
 
2919
        # get_position on a text that is not in the datastream (but in the
 
2920
        # backing knit) returns (True, 'versionid', None, None) - and then the
 
2921
        # access object can construct the relevant data as needed.
 
2922
        self.assertGetPosition(knit, ['a', 'c'], 'b', (True, 'b', None, None))
 
2923
 
 
2924
 
 
2925
class Test_StreamAccess(KnitTests):
 
2926
 
 
2927
    def get_index_access(self, knit, stream):
 
2928
        """Get a _StreamAccess from knit and stream."""
 
2929
        knit =  knit._knit_from_datastream(stream)
 
2930
        return knit._index, knit._data._access
 
2931
 
 
2932
    def assertGetRawRecords(self, knit, versions):
 
2933
        index, access = self.get_index_access(knit,
 
2934
            knit.get_data_stream(versions))
 
2935
        # check that every version asked for can be obtained from the resulting
 
2936
        # access object.
 
2937
        # batch
 
2938
        memos = []
 
2939
        for version in versions:
 
2940
            memos.append(knit._index.get_position(version))
 
2941
        original = {}
 
2942
        for version, data in zip(
 
2943
            versions, knit._data._access.get_raw_records(memos)):
 
2944
            original[version] = data
 
2945
        memos = []
 
2946
        for version in versions:
 
2947
            memos.append(index.get_position(version))
 
2948
        streamed = {}
 
2949
        for version, data in zip(versions, access.get_raw_records(memos)):
 
2950
            streamed[version] = data
 
2951
        self.assertEqual(original, streamed)
 
2952
        # individually
 
2953
        for version in versions:
 
2954
            data = list(access.get_raw_records(
 
2955
                [index.get_position(version)]))[0]
 
2956
            self.assertEqual(original[version], data)
 
2957
 
 
2958
    def make_knit_with_two_versions(self):
 
2959
        knit = self.make_test_knit()
 
2960
        knit.add_lines('a', [], ["foo"])
 
2961
        knit.add_lines('b', [], ["bar"])
 
2962
        return knit
 
2963
 
 
2964
    def test_get_raw_records(self):
 
2965
        knit = self.make_knit_with_two_versions()
 
2966
        self.assertGetRawRecords(knit, ['a', 'b'])
 
2967
        self.assertGetRawRecords(knit, ['a'])
 
2968
        self.assertGetRawRecords(knit, ['b'])
 
2969
    
 
2970
    def test_get_raw_record_from_backing_knit(self):
 
2971
        # the thunk layer should create an artificial A on-demand when needed.
 
2972
        source_knit = self.make_test_knit(name='plain', annotate=False)
 
2973
        target_knit = self.make_test_knit(name='annotated', annotate=True)
 
2974
        source_knit.add_lines("A", [], ["Foo\n"])
 
2975
        # Give the target A, so we can try to thunk across to it.
 
2976
        target_knit.join(source_knit)
 
2977
        index, access = self.get_index_access(target_knit,
 
2978
            source_knit.get_data_stream([]))
 
2979
        raw_data = list(access.get_raw_records([(True, "A", None, None)]))[0]
 
2980
        df = GzipFile(mode='rb', fileobj=StringIO(raw_data))
 
2981
        self.assertEqual(
 
2982
            'version A 1 5d36b88bb697a2d778f024048bafabd443d74503\n'
 
2983
            'Foo\nend A\n',
 
2984
            df.read())
 
2985
 
 
2986
    def test_asking_for_thunk_stream_is_not_plain_errors(self):
 
2987
        knit = self.make_test_knit(name='annotated', annotate=True)
 
2988
        knit.add_lines("A", [], ["Foo\n"])
 
2989
        index, access = self.get_index_access(knit,
 
2990
            knit.get_data_stream([]))
 
2991
        self.assertRaises(errors.KnitCorrupt,
 
2992
            list, access.get_raw_records([(True, "A", None, None)]))