~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_knit.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-13 14:16:53 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813141653-3cbrp00xowq58zv1
Added mini tutorial

Show diffs side-by-side

added added

removed removed

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