~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_knit.py

  • Committer: Andrew Bennetts
  • Date: 2007-10-29 08:34:38 UTC
  • mto: (2535.4.22 streaming-smart-fetch)
  • mto: This revision was merged to the branch mainline in revision 2981.
  • Revision ID: andrew.bennetts@canonical.com-20071029083438-ke1vsv97dvgrvup5
Improve some docstrings.

Show diffs side-by-side

added added

removed removed

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