~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_knit.py

  • Committer: Robert Collins
  • Date: 2007-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

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