~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_knit.py

Merge bzr.dev

Show diffs side-by-side

added added

removed removed

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