/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_knit.py

  • Committer: Robert Collins
  • Date: 2007-08-22 23:43:36 UTC
  • mto: This revision was merged to the branch mainline in revision 2744.
  • Revision ID: robertc@robertcollins.net-20070822234336-pl9dspu4z6kbt8lg
Tighten the revision store implementation tests surrounding the
None/null: difference. (Robert Collins)

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.weave import Weave
 
61
 
 
62
 
 
63
class _CompiledKnitFeature(Feature):
 
64
 
 
65
    def _probe(self):
 
66
        try:
 
67
            import bzrlib._knit_load_data_c
 
68
        except ImportError:
 
69
            return False
 
70
        return True
 
71
 
 
72
    def feature_name(self):
 
73
        return 'bzrlib._knit_load_data_c'
 
74
 
 
75
CompiledKnitFeature = _CompiledKnitFeature()
 
76
 
 
77
 
 
78
class KnitContentTests(TestCase):
78
79
 
79
80
    def test_constructor(self):
80
 
        content = self._make_content([])
 
81
        content = KnitContent([])
81
82
 
82
83
    def test_text(self):
83
 
        content = self._make_content([])
 
84
        content = KnitContent([])
84
85
        self.assertEqual(content.text(), [])
85
86
 
86
 
        content = self._make_content([("origin1", "text1"), ("origin2", "text2")])
 
87
        content = KnitContent([("origin1", "text1"), ("origin2", "text2")])
87
88
        self.assertEqual(content.text(), ["text1", "text2"])
88
89
 
 
90
    def test_annotate(self):
 
91
        content = KnitContent([])
 
92
        self.assertEqual(content.annotate(), [])
 
93
 
 
94
        content = KnitContent([("origin1", "text1"), ("origin2", "text2")])
 
95
        self.assertEqual(content.annotate(),
 
96
            [("origin1", "text1"), ("origin2", "text2")])
 
97
 
 
98
    def test_annotate_iter(self):
 
99
        content = KnitContent([])
 
100
        it = content.annotate_iter()
 
101
        self.assertRaises(StopIteration, it.next)
 
102
 
 
103
        content = KnitContent([("origin1", "text1"), ("origin2", "text2")])
 
104
        it = content.annotate_iter()
 
105
        self.assertEqual(it.next(), ("origin1", "text1"))
 
106
        self.assertEqual(it.next(), ("origin2", "text2"))
 
107
        self.assertRaises(StopIteration, it.next)
 
108
 
89
109
    def test_copy(self):
90
 
        content = self._make_content([("origin1", "text1"), ("origin2", "text2")])
 
110
        content = KnitContent([("origin1", "text1"), ("origin2", "text2")])
91
111
        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(),
 
112
        self.assertIsInstance(copy, KnitContent)
 
113
        self.assertEqual(copy.annotate(),
224
114
            [("origin1", "text1"), ("origin2", "text2")])
225
115
 
226
116
    def test_line_delta(self):
227
 
        content1 = self._make_content([("", "a"), ("", "b")])
228
 
        content2 = self._make_content([("", "a"), ("", "a"), ("", "c")])
 
117
        content1 = KnitContent([("", "a"), ("", "b")])
 
118
        content2 = KnitContent([("", "a"), ("", "a"), ("", "c")])
229
119
        self.assertEqual(content1.line_delta(content2),
230
120
            [(1, 2, 2, [("", "a"), ("", "c")])])
231
121
 
232
122
    def test_line_delta_iter(self):
233
 
        content1 = self._make_content([("", "a"), ("", "b")])
234
 
        content2 = self._make_content([("", "a"), ("", "a"), ("", "c")])
 
123
        content1 = KnitContent([("", "a"), ("", "b")])
 
124
        content2 = KnitContent([("", "a"), ("", "a"), ("", "c")])
235
125
        it = content1.line_delta_iter(content2)
236
126
        self.assertEqual(it.next(), (1, 2, 2, [("", "a"), ("", "c")]))
237
127
        self.assertRaises(StopIteration, it.next)
263
153
        return queue_call
264
154
 
265
155
 
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
156
class KnitRecordAccessTestsMixin(object):
285
157
    """Tests for getting and putting knit records."""
286
158
 
 
159
    def assertAccessExists(self, access):
 
160
        """Ensure the data area for access has been initialised/exists."""
 
161
        raise NotImplementedError(self.assertAccessExists)
 
162
 
287
163
    def test_add_raw_records(self):
288
164
        """Add_raw_records adds records retrievable later."""
289
165
        access = self.get_access()
290
 
        memos = access.add_raw_records([('key', 10)], '1234567890')
 
166
        memos = access.add_raw_records([10], '1234567890')
291
167
        self.assertEqual(['1234567890'], list(access.get_raw_records(memos)))
292
 
 
 
168
 
293
169
    def test_add_several_raw_records(self):
294
170
        """add_raw_records with many records and read some back."""
295
171
        access = self.get_access()
296
 
        memos = access.add_raw_records([('key', 10), ('key2', 2), ('key3', 5)],
297
 
            '12345678901234567')
 
172
        memos = access.add_raw_records([10, 2, 5], '12345678901234567')
298
173
        self.assertEqual(['1234567890', '12', '34567'],
299
174
            list(access.get_raw_records(memos)))
300
175
        self.assertEqual(['1234567890'],
306
181
        self.assertEqual(['1234567890', '34567'],
307
182
            list(access.get_raw_records(memos[0:1] + memos[2:3])))
308
183
 
 
184
    def test_create(self):
 
185
        """create() should make a file on disk."""
 
186
        access = self.get_access()
 
187
        access.create()
 
188
        self.assertAccessExists(access)
 
189
 
 
190
    def test_open_file(self):
 
191
        """open_file never errors."""
 
192
        access = self.get_access()
 
193
        access.open_file()
 
194
 
309
195
 
310
196
class TestKnitKnitAccess(TestCaseWithMemoryTransport, KnitRecordAccessTestsMixin):
311
197
    """Tests for the .kndx implementation."""
312
198
 
 
199
    def assertAccessExists(self, access):
 
200
        self.assertNotEqual(None, access.open_file())
 
201
 
313
202
    def get_access(self):
314
203
        """Get a .knit style access instance."""
315
 
        mapper = ConstantMapper("foo")
316
 
        access = _KnitKeyAccess(self.get_transport(), mapper)
 
204
        access = _KnitAccess(self.get_transport(), "foo.knit", None, None,
 
205
            False, False)
317
206
        return access
318
 
 
319
 
 
320
 
class _TestException(Exception):
321
 
    """Just an exception for local tests to use."""
322
 
 
 
207
    
323
208
 
324
209
class TestPackKnitAccess(TestCaseWithMemoryTransport, KnitRecordAccessTestsMixin):
325
210
    """Tests for the pack based access."""
326
211
 
 
212
    def assertAccessExists(self, access):
 
213
        # as pack based access has no backing unless an index maps data, this
 
214
        # is a no-op.
 
215
        pass
 
216
 
327
217
    def get_access(self):
328
218
        return self._get_access()[0]
329
219
 
333
223
            transport.append_bytes(packname, bytes)
334
224
        writer = pack.ContainerWriter(write_data)
335
225
        writer.begin()
336
 
        access = _DirectPackAccess({})
337
 
        access.set_writer(writer, index, (transport, packname))
 
226
        indices = {index:(transport, packname)}
 
227
        access = _PackAccess(indices, writer=(writer, index))
338
228
        return access, writer
339
229
 
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
230
    def test_read_from_several_packs(self):
429
231
        access, writer = self._get_access()
430
232
        memos = []
431
 
        memos.extend(access.add_raw_records([('key', 10)], '1234567890'))
 
233
        memos.extend(access.add_raw_records([10], '1234567890'))
432
234
        writer.end()
433
235
        access, writer = self._get_access('pack2', 'FOOBAR')
434
 
        memos.extend(access.add_raw_records([('key', 5)], '12345'))
 
236
        memos.extend(access.add_raw_records([5], '12345'))
435
237
        writer.end()
436
238
        access, writer = self._get_access('pack3', 'BAZ')
437
 
        memos.extend(access.add_raw_records([('key', 5)], 'alpha'))
 
239
        memos.extend(access.add_raw_records([5], 'alpha'))
438
240
        writer.end()
439
241
        transport = self.get_transport()
440
 
        access = _DirectPackAccess({"FOO":(transport, 'packfile'),
 
242
        access = _PackAccess({"FOO":(transport, 'packfile'),
441
243
            "FOOBAR":(transport, 'pack2'),
442
244
            "BAZ":(transport, 'pack3')})
443
245
        self.assertEqual(['1234567890', '12345', 'alpha'],
453
255
 
454
256
    def test_set_writer(self):
455
257
        """The writer should be settable post construction."""
456
 
        access = _DirectPackAccess({})
 
258
        access = _PackAccess({})
457
259
        transport = self.get_transport()
458
260
        packname = 'packfile'
459
261
        index = 'foo'
462
264
        writer = pack.ContainerWriter(write_data)
463
265
        writer.begin()
464
266
        access.set_writer(writer, index, (transport, packname))
465
 
        memos = access.add_raw_records([('key', 10)], '1234567890')
 
267
        memos = access.add_raw_records([10], '1234567890')
466
268
        writer.end()
467
269
        self.assertEqual(['1234567890'], list(access.get_raw_records(memos)))
468
270
 
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
271
 
699
272
class LowLevelKnitDataTests(TestCase):
700
273
 
705
278
        gz_file.close()
706
279
        return sio.getvalue()
707
280
 
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
281
    def test_valid_knit_data(self):
729
 
        sha1sum = osutils.sha('foo\nbar\n').hexdigest()
 
282
        sha1sum = sha.new('foo\nbar\n').hexdigest()
730
283
        gz_txt = self.create_gz_content('version rev-id-1 2 %s\n'
731
284
                                        'foo\n'
732
285
                                        'bar\n'
733
286
                                        'end rev-id-1\n'
734
287
                                        % (sha1sum,))
735
288
        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)
 
289
        access = _KnitAccess(transport, 'filename', None, None, False, False)
 
290
        data = _KnitData(access=access)
 
291
        records = [('rev-id-1', (None, 0, len(gz_txt)))]
 
292
 
 
293
        contents = data.read_records(records)
 
294
        self.assertEqual({'rev-id-1':(['foo\n', 'bar\n'], sha1sum)}, contents)
 
295
 
 
296
        raw_contents = list(data.read_records_iter_raw(records))
 
297
        self.assertEqual([('rev-id-1', gz_txt)], raw_contents)
764
298
 
765
299
    def test_not_enough_lines(self):
766
 
        sha1sum = osutils.sha('foo\n').hexdigest()
 
300
        sha1sum = sha.new('foo\n').hexdigest()
767
301
        # record says 2 lines data says 1
768
302
        gz_txt = self.create_gz_content('version rev-id-1 2 %s\n'
769
303
                                        'foo\n'
770
304
                                        'end rev-id-1\n'
771
305
                                        % (sha1sum,))
772
306
        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))
 
307
        access = _KnitAccess(transport, 'filename', None, None, False, False)
 
308
        data = _KnitData(access=access)
 
309
        records = [('rev-id-1', (None, 0, len(gz_txt)))]
 
310
        self.assertRaises(errors.KnitCorrupt, data.read_records, records)
778
311
 
779
312
        # 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)
 
313
        raw_contents = list(data.read_records_iter_raw(records))
 
314
        self.assertEqual([('rev-id-1', gz_txt)], raw_contents)
782
315
 
783
316
    def test_too_many_lines(self):
784
 
        sha1sum = osutils.sha('foo\nbar\n').hexdigest()
 
317
        sha1sum = sha.new('foo\nbar\n').hexdigest()
785
318
        # record says 1 lines data says 2
786
319
        gz_txt = self.create_gz_content('version rev-id-1 1 %s\n'
787
320
                                        'foo\n'
789
322
                                        'end rev-id-1\n'
790
323
                                        % (sha1sum,))
791
324
        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))
 
325
        access = _KnitAccess(transport, 'filename', None, None, False, False)
 
326
        data = _KnitData(access=access)
 
327
        records = [('rev-id-1', (None, 0, len(gz_txt)))]
 
328
        self.assertRaises(errors.KnitCorrupt, data.read_records, records)
797
329
 
798
330
        # 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)
 
331
        raw_contents = list(data.read_records_iter_raw(records))
 
332
        self.assertEqual([('rev-id-1', gz_txt)], raw_contents)
801
333
 
802
334
    def test_mismatched_version_id(self):
803
 
        sha1sum = osutils.sha('foo\nbar\n').hexdigest()
 
335
        sha1sum = sha.new('foo\nbar\n').hexdigest()
804
336
        gz_txt = self.create_gz_content('version rev-id-1 2 %s\n'
805
337
                                        'foo\n'
806
338
                                        'bar\n'
807
339
                                        'end rev-id-1\n'
808
340
                                        % (sha1sum,))
809
341
        transport = MockTransport([gz_txt])
810
 
        access = _KnitKeyAccess(transport, ConstantMapper('filename'))
811
 
        knit = KnitVersionedFiles(None, access)
 
342
        access = _KnitAccess(transport, 'filename', None, None, False, False)
 
343
        data = _KnitData(access=access)
812
344
        # 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))
 
345
        records = [('rev-id-2', (None, 0, len(gz_txt)))]
 
346
        self.assertRaises(errors.KnitCorrupt, data.read_records, records)
816
347
 
817
 
        # read_records_iter_raw detects mismatches in the header
 
348
        # read_records_iter_raw will notice if we request the wrong version.
818
349
        self.assertRaises(errors.KnitCorrupt, list,
819
 
            knit._read_records_iter_raw(records))
 
350
                          data.read_records_iter_raw(records))
820
351
 
821
352
    def test_uncompressed_data(self):
822
 
        sha1sum = osutils.sha('foo\nbar\n').hexdigest()
 
353
        sha1sum = sha.new('foo\nbar\n').hexdigest()
823
354
        txt = ('version rev-id-1 2 %s\n'
824
355
               'foo\n'
825
356
               'bar\n'
826
357
               'end rev-id-1\n'
827
358
               % (sha1sum,))
828
359
        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)))]
 
360
        access = _KnitAccess(transport, 'filename', None, None, False, False)
 
361
        data = _KnitData(access=access)
 
362
        records = [('rev-id-1', (None, 0, len(txt)))]
832
363
 
833
364
        # We don't have valid gzip data ==> corrupt
834
 
        self.assertRaises(errors.KnitCorrupt, list,
835
 
            knit._read_records_iter(records))
 
365
        self.assertRaises(errors.KnitCorrupt, data.read_records, records)
836
366
 
837
367
        # read_records_iter_raw will notice the bad data
838
368
        self.assertRaises(errors.KnitCorrupt, list,
839
 
            knit._read_records_iter_raw(records))
 
369
                          data.read_records_iter_raw(records))
840
370
 
841
371
    def test_corrupted_data(self):
842
 
        sha1sum = osutils.sha('foo\nbar\n').hexdigest()
 
372
        sha1sum = sha.new('foo\nbar\n').hexdigest()
843
373
        gz_txt = self.create_gz_content('version rev-id-1 2 %s\n'
844
374
                                        'foo\n'
845
375
                                        'bar\n'
848
378
        # Change 2 bytes in the middle to \xff
849
379
        gz_txt = gz_txt[:10] + '\xff\xff' + gz_txt[12:]
850
380
        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))
 
381
        access = _KnitAccess(transport, 'filename', None, None, False, False)
 
382
        data = _KnitData(access=access)
 
383
        records = [('rev-id-1', (None, 0, len(gz_txt)))]
 
384
 
 
385
        self.assertRaises(errors.KnitCorrupt, data.read_records, records)
 
386
 
 
387
        # read_records_iter_raw will notice if we request the wrong version.
 
388
        self.assertRaises(errors.KnitCorrupt, list,
 
389
                          data.read_records_iter_raw(records))
859
390
 
860
391
 
861
392
class LowLevelKnitIndexTests(TestCase):
862
393
 
863
 
    def get_knit_index(self, transport, name, mode):
864
 
        mapper = ConstantMapper(name)
 
394
    def get_knit_index(self, *args, **kwargs):
 
395
        orig = knit._load_data
 
396
        def reset():
 
397
            knit._load_data = orig
 
398
        self.addCleanup(reset)
865
399
        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)
 
400
        knit._load_data = _load_data_py
 
401
        return _KnitIndex(*args, **kwargs)
 
402
 
 
403
    def test_no_such_file(self):
 
404
        transport = MockTransport()
 
405
 
 
406
        self.assertRaises(NoSuchFile, self.get_knit_index,
 
407
                          transport, "filename", "r")
 
408
        self.assertRaises(NoSuchFile, self.get_knit_index,
 
409
                          transport, "filename", "w", create=False)
869
410
 
870
411
    def test_create_file(self):
871
412
        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])
 
413
 
 
414
        index = self.get_knit_index(transport, "filename", "w",
 
415
            file_mode="wb", create=True)
 
416
        self.assertEqual(
 
417
                ("put_bytes_non_atomic",
 
418
                    ("filename", index.HEADER), {"mode": "wb"}),
 
419
                transport.calls.pop(0))
 
420
 
 
421
    def test_delay_create_file(self):
 
422
        transport = MockTransport()
 
423
 
 
424
        index = self.get_knit_index(transport, "filename", "w",
 
425
            create=True, file_mode="wb", create_parent_dir=True,
 
426
            delay_create=True, dir_mode=0777)
 
427
        self.assertEqual([], transport.calls)
 
428
 
 
429
        index.add_versions([])
 
430
        name, (filename, f), kwargs = transport.calls.pop(0)
 
431
        self.assertEqual("put_file_non_atomic", name)
 
432
        self.assertEqual(
 
433
            {"dir_mode": 0777, "create_parent_dir": True, "mode": "wb"},
 
434
            kwargs)
 
435
        self.assertEqual("filename", filename)
 
436
        self.assertEqual(index.HEADER, f.read())
 
437
 
 
438
        index.add_versions([])
 
439
        self.assertEqual(("append_bytes", ("filename", ""), {}),
 
440
            transport.calls.pop(0))
882
441
 
883
442
    def test_read_utf8_version_id(self):
884
443
        unicode_revision_id = u"version-\N{CYRILLIC CAPITAL LETTER A}"
885
444
        utf8_revision_id = unicode_revision_id.encode('utf-8')
886
445
        transport = MockTransport([
887
 
            _KndxIndex.HEADER,
 
446
            _KnitIndex.HEADER,
888
447
            '%s option 0 1 :' % (utf8_revision_id,)
889
448
            ])
890
449
        index = self.get_knit_index(transport, "filename", "r")
891
 
        # _KndxIndex is a private class, and deals in utf8 revision_ids, not
 
450
        # _KnitIndex is a private class, and deals in utf8 revision_ids, not
892
451
        # 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())
 
452
        self.assertTrue(index.has_version(utf8_revision_id))
 
453
        self.assertFalse(index.has_version(unicode_revision_id))
896
454
 
897
455
    def test_read_utf8_parents(self):
898
456
        unicode_revision_id = u"version-\N{CYRILLIC CAPITAL LETTER A}"
899
457
        utf8_revision_id = unicode_revision_id.encode('utf-8')
900
458
        transport = MockTransport([
901
 
            _KndxIndex.HEADER,
 
459
            _KnitIndex.HEADER,
902
460
            "version option 0 1 .%s :" % (utf8_revision_id,)
903
461
            ])
904
462
        index = self.get_knit_index(transport, "filename", "r")
905
 
        self.assertEqual({("version",):((utf8_revision_id,),)},
906
 
            index.get_parent_map(index.keys()))
 
463
        self.assertEqual([utf8_revision_id],
 
464
            index.get_parents_with_ghosts("version"))
907
465
 
908
466
    def test_read_ignore_corrupted_lines(self):
909
467
        transport = MockTransport([
910
 
            _KndxIndex.HEADER,
 
468
            _KnitIndex.HEADER,
911
469
            "corrupted",
912
470
            "corrupted options 0 1 .b .c ",
913
471
            "version options 0 1 :"
914
472
            ])
915
473
        index = self.get_knit_index(transport, "filename", "r")
916
 
        self.assertEqual(1, len(index.keys()))
917
 
        self.assertEqual(set([("version",)]), index.keys())
 
474
        self.assertEqual(1, index.num_versions())
 
475
        self.assertTrue(index.has_version("version"))
918
476
 
919
477
    def test_read_corrupted_header(self):
920
478
        transport = MockTransport(['not a bzr knit index header\n'])
921
 
        index = self.get_knit_index(transport, "filename", "r")
922
 
        self.assertRaises(KnitHeaderError, index.keys)
 
479
        self.assertRaises(KnitHeaderError,
 
480
            self.get_knit_index, transport, "filename", "r")
923
481
 
924
482
    def test_read_duplicate_entries(self):
925
483
        transport = MockTransport([
926
 
            _KndxIndex.HEADER,
 
484
            _KnitIndex.HEADER,
927
485
            "parent options 0 1 :",
928
486
            "version options1 0 1 0 :",
929
487
            "version options2 1 2 .other :",
930
488
            "version options3 3 4 0 .other :"
931
489
            ])
932
490
        index = self.get_knit_index(transport, "filename", "r")
933
 
        self.assertEqual(2, len(index.keys()))
 
491
        self.assertEqual(2, index.num_versions())
934
492
        # check that the index used is the first one written. (Specific
935
493
        # 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",)]))
 
494
        self.assertEqual("1", index._version_list_to_index(["version"]))
 
495
        self.assertEqual((None, 3, 4), index.get_position("version"))
 
496
        self.assertEqual(["options3"], index.get_options("version"))
 
497
        self.assertEqual(["parent", "other"],
 
498
            index.get_parents_with_ghosts("version"))
941
499
 
942
500
    def test_read_compressed_parents(self):
943
501
        transport = MockTransport([
944
 
            _KndxIndex.HEADER,
 
502
            _KnitIndex.HEADER,
945
503
            "a option 0 1 :",
946
504
            "b option 0 1 0 :",
947
505
            "c option 0 1 1 0 :",
948
506
            ])
949
507
        index = self.get_knit_index(transport, "filename", "r")
950
 
        self.assertEqual({("b",):(("a",),), ("c",):(("b",), ("a",))},
951
 
            index.get_parent_map([("b",), ("c",)]))
 
508
        self.assertEqual(["a"], index.get_parents("b"))
 
509
        self.assertEqual(["b", "a"], index.get_parents("c"))
952
510
 
953
511
    def test_write_utf8_version_id(self):
954
512
        unicode_revision_id = u"version-\N{CYRILLIC CAPITAL LETTER A}"
955
513
        utf8_revision_id = unicode_revision_id.encode('utf-8')
956
514
        transport = MockTransport([
957
 
            _KndxIndex.HEADER
 
515
            _KnitIndex.HEADER
958
516
            ])
959
517
        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])
 
518
        index.add_version(utf8_revision_id, ["option"], (None, 0, 1), [])
 
519
        self.assertEqual(("append_bytes", ("filename",
 
520
            "\n%s option 0 1  :" % (utf8_revision_id,)),
 
521
            {}),
 
522
            transport.calls.pop(0))
971
523
 
972
524
    def test_write_utf8_parents(self):
973
525
        unicode_revision_id = u"version-\N{CYRILLIC CAPITAL LETTER A}"
974
526
        utf8_revision_id = unicode_revision_id.encode('utf-8')
975
527
        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",)))
 
528
            _KnitIndex.HEADER
 
529
            ])
 
530
        index = self.get_knit_index(transport, "filename", "r")
 
531
        index.add_version("version", ["option"], (None, 0, 1), [utf8_revision_id])
 
532
        self.assertEqual(("append_bytes", ("filename",
 
533
            "\nversion option 0 1 .%s :" % (utf8_revision_id,)),
 
534
            {}),
 
535
            transport.calls.pop(0))
 
536
 
 
537
    def test_get_graph(self):
 
538
        transport = MockTransport()
 
539
        index = self.get_knit_index(transport, "filename", "w", create=True)
 
540
        self.assertEqual([], index.get_graph())
 
541
 
 
542
        index.add_version("a", ["option"], (None, 0, 1), ["b"])
 
543
        self.assertEqual([("a", ["b"])], index.get_graph())
 
544
 
 
545
        index.add_version("c", ["option"], (None, 0, 1), ["d"])
 
546
        self.assertEqual([("a", ["b"]), ("c", ["d"])],
 
547
            sorted(index.get_graph()))
 
548
 
 
549
    def test_get_ancestry(self):
 
550
        transport = MockTransport([
 
551
            _KnitIndex.HEADER,
 
552
            "a option 0 1 :",
 
553
            "b option 0 1 0 .e :",
 
554
            "c option 0 1 1 0 :",
 
555
            "d option 0 1 2 .f :"
 
556
            ])
 
557
        index = self.get_knit_index(transport, "filename", "r")
 
558
 
 
559
        self.assertEqual([], index.get_ancestry([]))
 
560
        self.assertEqual(["a"], index.get_ancestry(["a"]))
 
561
        self.assertEqual(["a", "b"], index.get_ancestry(["b"]))
 
562
        self.assertEqual(["a", "b", "c"], index.get_ancestry(["c"]))
 
563
        self.assertEqual(["a", "b", "c", "d"], index.get_ancestry(["d"]))
 
564
        self.assertEqual(["a", "b"], index.get_ancestry(["a", "b"]))
 
565
        self.assertEqual(["a", "b", "c"], index.get_ancestry(["a", "c"]))
 
566
 
 
567
        self.assertRaises(RevisionNotPresent, index.get_ancestry, ["e"])
 
568
 
 
569
    def test_get_ancestry_with_ghosts(self):
 
570
        transport = MockTransport([
 
571
            _KnitIndex.HEADER,
 
572
            "a option 0 1 :",
 
573
            "b option 0 1 0 .e :",
 
574
            "c option 0 1 0 .f .g :",
 
575
            "d option 0 1 2 .h .j .k :"
 
576
            ])
 
577
        index = self.get_knit_index(transport, "filename", "r")
 
578
 
 
579
        self.assertEqual([], index.get_ancestry_with_ghosts([]))
 
580
        self.assertEqual(["a"], index.get_ancestry_with_ghosts(["a"]))
 
581
        self.assertEqual(["a", "e", "b"],
 
582
            index.get_ancestry_with_ghosts(["b"]))
 
583
        self.assertEqual(["a", "g", "f", "c"],
 
584
            index.get_ancestry_with_ghosts(["c"]))
 
585
        self.assertEqual(["a", "g", "f", "c", "k", "j", "h", "d"],
 
586
            index.get_ancestry_with_ghosts(["d"]))
 
587
        self.assertEqual(["a", "e", "b"],
 
588
            index.get_ancestry_with_ghosts(["a", "b"]))
 
589
        self.assertEqual(["a", "g", "f", "c"],
 
590
            index.get_ancestry_with_ghosts(["a", "c"]))
 
591
        self.assertEqual(
 
592
            ["a", "g", "f", "c", "e", "b", "k", "j", "h", "d"],
 
593
            index.get_ancestry_with_ghosts(["b", "d"]))
 
594
 
 
595
        self.assertRaises(RevisionNotPresent,
 
596
            index.get_ancestry_with_ghosts, ["e"])
 
597
 
 
598
    def test_iter_parents(self):
 
599
        transport = MockTransport()
 
600
        index = self.get_knit_index(transport, "filename", "w", create=True)
 
601
        # no parents
 
602
        index.add_version('r0', ['option'], (None, 0, 1), [])
 
603
        # 1 parent
 
604
        index.add_version('r1', ['option'], (None, 0, 1), ['r0'])
 
605
        # 2 parents
 
606
        index.add_version('r2', ['option'], (None, 0, 1), ['r1', 'r0'])
 
607
        # XXX TODO a ghost
 
608
        # cases: each sample data individually:
 
609
        self.assertEqual(set([('r0', ())]),
 
610
            set(index.iter_parents(['r0'])))
 
611
        self.assertEqual(set([('r1', ('r0', ))]),
 
612
            set(index.iter_parents(['r1'])))
 
613
        self.assertEqual(set([('r2', ('r1', 'r0'))]),
 
614
            set(index.iter_parents(['r2'])))
 
615
        # no nodes returned for a missing node
 
616
        self.assertEqual(set(),
 
617
            set(index.iter_parents(['missing'])))
 
618
        # 1 node returned with missing nodes skipped
 
619
        self.assertEqual(set([('r1', ('r0', ))]),
 
620
            set(index.iter_parents(['ghost1', 'r1', 'ghost'])))
 
621
        # 2 nodes returned
 
622
        self.assertEqual(set([('r0', ()), ('r1', ('r0', ))]),
 
623
            set(index.iter_parents(['r0', 'r1'])))
 
624
        # 2 nodes returned, missing skipped
 
625
        self.assertEqual(set([('r0', ()), ('r1', ('r0', ))]),
 
626
            set(index.iter_parents(['a', 'r0', 'b', 'r1', 'c'])))
 
627
 
 
628
    def test_num_versions(self):
 
629
        transport = MockTransport([
 
630
            _KnitIndex.HEADER
 
631
            ])
 
632
        index = self.get_knit_index(transport, "filename", "r")
 
633
 
 
634
        self.assertEqual(0, index.num_versions())
 
635
        self.assertEqual(0, len(index))
 
636
 
 
637
        index.add_version("a", ["option"], (None, 0, 1), [])
 
638
        self.assertEqual(1, index.num_versions())
 
639
        self.assertEqual(1, len(index))
 
640
 
 
641
        index.add_version("a", ["option2"], (None, 1, 2), [])
 
642
        self.assertEqual(1, index.num_versions())
 
643
        self.assertEqual(1, len(index))
 
644
 
 
645
        index.add_version("b", ["option"], (None, 0, 1), [])
 
646
        self.assertEqual(2, index.num_versions())
 
647
        self.assertEqual(2, len(index))
 
648
 
 
649
    def test_get_versions(self):
 
650
        transport = MockTransport([
 
651
            _KnitIndex.HEADER
 
652
            ])
 
653
        index = self.get_knit_index(transport, "filename", "r")
 
654
 
 
655
        self.assertEqual([], index.get_versions())
 
656
 
 
657
        index.add_version("a", ["option"], (None, 0, 1), [])
 
658
        self.assertEqual(["a"], index.get_versions())
 
659
 
 
660
        index.add_version("a", ["option"], (None, 0, 1), [])
 
661
        self.assertEqual(["a"], index.get_versions())
 
662
 
 
663
        index.add_version("b", ["option"], (None, 0, 1), [])
 
664
        self.assertEqual(["a", "b"], index.get_versions())
 
665
 
 
666
    def test_add_version(self):
 
667
        transport = MockTransport([
 
668
            _KnitIndex.HEADER
 
669
            ])
 
670
        index = self.get_knit_index(transport, "filename", "r")
 
671
 
 
672
        index.add_version("a", ["option"], (None, 0, 1), ["b"])
 
673
        self.assertEqual(("append_bytes",
 
674
            ("filename", "\na option 0 1 .b :"),
 
675
            {}), transport.calls.pop(0))
 
676
        self.assertTrue(index.has_version("a"))
 
677
        self.assertEqual(1, index.num_versions())
 
678
        self.assertEqual((None, 0, 1), index.get_position("a"))
 
679
        self.assertEqual(["option"], index.get_options("a"))
 
680
        self.assertEqual(["b"], index.get_parents_with_ghosts("a"))
 
681
 
 
682
        index.add_version("a", ["opt"], (None, 1, 2), ["c"])
 
683
        self.assertEqual(("append_bytes",
 
684
            ("filename", "\na opt 1 2 .c :"),
 
685
            {}), transport.calls.pop(0))
 
686
        self.assertTrue(index.has_version("a"))
 
687
        self.assertEqual(1, index.num_versions())
 
688
        self.assertEqual((None, 1, 2), index.get_position("a"))
 
689
        self.assertEqual(["opt"], index.get_options("a"))
 
690
        self.assertEqual(["c"], index.get_parents_with_ghosts("a"))
 
691
 
 
692
        index.add_version("b", ["option"], (None, 2, 3), ["a"])
 
693
        self.assertEqual(("append_bytes",
 
694
            ("filename", "\nb option 2 3 0 :"),
 
695
            {}), transport.calls.pop(0))
 
696
        self.assertTrue(index.has_version("b"))
 
697
        self.assertEqual(2, index.num_versions())
 
698
        self.assertEqual((None, 2, 3), index.get_position("b"))
 
699
        self.assertEqual(["option"], index.get_options("b"))
 
700
        self.assertEqual(["a"], index.get_parents_with_ghosts("b"))
1027
701
 
1028
702
    def test_add_versions(self):
1029
703
        transport = MockTransport([
1030
 
            _KndxIndex.HEADER
 
704
            _KnitIndex.HEADER
1031
705
            ])
1032
706
        index = self.get_knit_index(transport, "filename", "r")
1033
707
 
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 +
 
708
        index.add_versions([
 
709
            ("a", ["option"], (None, 0, 1), ["b"]),
 
710
            ("a", ["opt"], (None, 1, 2), ["c"]),
 
711
            ("b", ["option"], (None, 2, 3), ["a"])
 
712
            ])
 
713
        self.assertEqual(("append_bytes", ("filename",
1042
714
            "\na option 0 1 .b :"
1043
715
            "\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)
 
716
            "\nb option 2 3 0 :"
 
717
            ), {}), transport.calls.pop(0))
 
718
        self.assertTrue(index.has_version("a"))
 
719
        self.assertTrue(index.has_version("b"))
 
720
        self.assertEqual(2, index.num_versions())
 
721
        self.assertEqual((None, 1, 2), index.get_position("a"))
 
722
        self.assertEqual((None, 2, 3), index.get_position("b"))
 
723
        self.assertEqual(["opt"], index.get_options("a"))
 
724
        self.assertEqual(["option"], index.get_options("b"))
 
725
        self.assertEqual(["c"], index.get_parents_with_ghosts("a"))
 
726
        self.assertEqual(["a"], index.get_parents_with_ghosts("b"))
1055
727
 
1056
728
    def test_delay_create_and_add_versions(self):
1057
729
        transport = MockTransport()
1058
730
 
1059
 
        index = self.get_knit_index(transport, "filename", "w")
1060
 
        # dir_mode=0777)
 
731
        index = self.get_knit_index(transport, "filename", "w",
 
732
            create=True, file_mode="wb", create_parent_dir=True,
 
733
            delay_create=True, dir_mode=0777)
1061
734
        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 +
 
735
 
 
736
        index.add_versions([
 
737
            ("a", ["option"], (None, 0, 1), ["b"]),
 
738
            ("a", ["opt"], (None, 1, 2), ["c"]),
 
739
            ("b", ["option"], (None, 2, 3), ["a"])
 
740
            ])
 
741
        name, (filename, f), kwargs = transport.calls.pop(0)
 
742
        self.assertEqual("put_file_non_atomic", name)
 
743
        self.assertEqual(
 
744
            {"dir_mode": 0777, "create_parent_dir": True, "mode": "wb"},
 
745
            kwargs)
 
746
        self.assertEqual("filename", filename)
 
747
        self.assertEqual(
 
748
            index.HEADER +
1082
749
            "\na option 0 1 .b :"
1083
750
            "\na opt 1 2 .c :"
1084
751
            "\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)
 
752
            f.read())
 
753
 
 
754
    def test_has_version(self):
 
755
        transport = MockTransport([
 
756
            _KnitIndex.HEADER,
 
757
            "a option 0 1 :"
 
758
            ])
 
759
        index = self.get_knit_index(transport, "filename", "r")
 
760
 
 
761
        self.assertTrue(index.has_version("a"))
 
762
        self.assertFalse(index.has_version("b"))
1107
763
 
1108
764
    def test_get_position(self):
1109
765
        transport = MockTransport([
1110
 
            _KndxIndex.HEADER,
 
766
            _KnitIndex.HEADER,
1111
767
            "a option 0 1 :",
1112
768
            "b option 1 2 :"
1113
769
            ])
1114
770
        index = self.get_knit_index(transport, "filename", "r")
1115
771
 
1116
 
        self.assertEqual((("a",), 0, 1), index.get_position(("a",)))
1117
 
        self.assertEqual((("b",), 1, 2), index.get_position(("b",)))
 
772
        self.assertEqual((None, 0, 1), index.get_position("a"))
 
773
        self.assertEqual((None, 1, 2), index.get_position("b"))
1118
774
 
1119
775
    def test_get_method(self):
1120
776
        transport = MockTransport([
1121
 
            _KndxIndex.HEADER,
 
777
            _KnitIndex.HEADER,
1122
778
            "a fulltext,unknown 0 1 :",
1123
779
            "b unknown,line-delta 1 2 :",
1124
780
            "c bad 3 4 :"
1131
787
 
1132
788
    def test_get_options(self):
1133
789
        transport = MockTransport([
1134
 
            _KndxIndex.HEADER,
 
790
            _KnitIndex.HEADER,
1135
791
            "a opt1 0 1 :",
1136
792
            "b opt2,opt3 1 2 :"
1137
793
            ])
1140
796
        self.assertEqual(["opt1"], index.get_options("a"))
1141
797
        self.assertEqual(["opt2", "opt3"], index.get_options("b"))
1142
798
 
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()))
 
799
    def test_get_parents(self):
 
800
        transport = MockTransport([
 
801
            _KnitIndex.HEADER,
 
802
            "a option 0 1 :",
 
803
            "b option 1 2 0 .c :",
 
804
            "c option 1 2 1 0 .e :"
 
805
            ])
 
806
        index = self.get_knit_index(transport, "filename", "r")
 
807
 
 
808
        self.assertEqual([], index.get_parents("a"))
 
809
        self.assertEqual(["a", "c"], index.get_parents("b"))
 
810
        self.assertEqual(["b", "a"], index.get_parents("c"))
 
811
 
 
812
    def test_get_parents_with_ghosts(self):
 
813
        transport = MockTransport([
 
814
            _KnitIndex.HEADER,
 
815
            "a option 0 1 :",
 
816
            "b option 1 2 0 .c :",
 
817
            "c option 1 2 1 0 .e :"
 
818
            ])
 
819
        index = self.get_knit_index(transport, "filename", "r")
 
820
 
 
821
        self.assertEqual([], index.get_parents_with_ghosts("a"))
 
822
        self.assertEqual(["a", "c"], index.get_parents_with_ghosts("b"))
 
823
        self.assertEqual(["b", "a", "e"],
 
824
            index.get_parents_with_ghosts("c"))
 
825
 
 
826
    def test_check_versions_present(self):
 
827
        transport = MockTransport([
 
828
            _KnitIndex.HEADER,
 
829
            "a option 0 1 :",
 
830
            "b option 0 1 :"
 
831
            ])
 
832
        index = self.get_knit_index(transport, "filename", "r")
 
833
 
 
834
        check = index.check_versions_present
 
835
 
 
836
        check([])
 
837
        check(["a"])
 
838
        check(["b"])
 
839
        check(["a", "b"])
 
840
        self.assertRaises(RevisionNotPresent, check, ["c"])
 
841
        self.assertRaises(RevisionNotPresent, check, ["a", "b", "c"])
1157
842
 
1158
843
    def test_impossible_parent(self):
1159
844
        """Test we get KnitCorrupt if the parent couldn't possibly exist."""
1160
845
        transport = MockTransport([
1161
 
            _KndxIndex.HEADER,
 
846
            _KnitIndex.HEADER,
1162
847
            "a option 0 1 :",
1163
848
            "b option 0 1 4 :"  # We don't have a 4th record
1164
849
            ])
1165
 
        index = self.get_knit_index(transport, 'filename', 'r')
1166
850
        try:
1167
 
            self.assertRaises(errors.KnitCorrupt, index.keys)
 
851
            self.assertRaises(errors.KnitCorrupt,
 
852
                              self.get_knit_index, transport, 'filename', 'r')
1168
853
        except TypeError, e:
1169
854
            if (str(e) == ('exceptions must be strings, classes, or instances,'
1170
855
                           ' not exceptions.IndexError')
1177
862
 
1178
863
    def test_corrupted_parent(self):
1179
864
        transport = MockTransport([
1180
 
            _KndxIndex.HEADER,
 
865
            _KnitIndex.HEADER,
1181
866
            "a option 0 1 :",
1182
867
            "b option 0 1 :",
1183
868
            "c option 0 1 1v :", # Can't have a parent of '1v'
1184
869
            ])
1185
 
        index = self.get_knit_index(transport, 'filename', 'r')
1186
870
        try:
1187
 
            self.assertRaises(errors.KnitCorrupt, index.keys)
 
871
            self.assertRaises(errors.KnitCorrupt,
 
872
                              self.get_knit_index, transport, 'filename', 'r')
1188
873
        except TypeError, e:
1189
874
            if (str(e) == ('exceptions must be strings, classes, or instances,'
1190
875
                           ' not exceptions.ValueError')
1197
882
 
1198
883
    def test_corrupted_parent_in_list(self):
1199
884
        transport = MockTransport([
1200
 
            _KndxIndex.HEADER,
 
885
            _KnitIndex.HEADER,
1201
886
            "a option 0 1 :",
1202
887
            "b option 0 1 :",
1203
888
            "c option 0 1 1 v :", # Can't have a parent of 'v'
1204
889
            ])
1205
 
        index = self.get_knit_index(transport, 'filename', 'r')
1206
890
        try:
1207
 
            self.assertRaises(errors.KnitCorrupt, index.keys)
 
891
            self.assertRaises(errors.KnitCorrupt,
 
892
                              self.get_knit_index, transport, 'filename', 'r')
1208
893
        except TypeError, e:
1209
894
            if (str(e) == ('exceptions must be strings, classes, or instances,'
1210
895
                           ' not exceptions.ValueError')
1217
902
 
1218
903
    def test_invalid_position(self):
1219
904
        transport = MockTransport([
1220
 
            _KndxIndex.HEADER,
 
905
            _KnitIndex.HEADER,
1221
906
            "a option 1v 1 :",
1222
907
            ])
1223
 
        index = self.get_knit_index(transport, 'filename', 'r')
1224
908
        try:
1225
 
            self.assertRaises(errors.KnitCorrupt, index.keys)
 
909
            self.assertRaises(errors.KnitCorrupt,
 
910
                              self.get_knit_index, transport, 'filename', 'r')
1226
911
        except TypeError, e:
1227
912
            if (str(e) == ('exceptions must be strings, classes, or instances,'
1228
913
                           ' not exceptions.ValueError')
1235
920
 
1236
921
    def test_invalid_size(self):
1237
922
        transport = MockTransport([
1238
 
            _KndxIndex.HEADER,
 
923
            _KnitIndex.HEADER,
1239
924
            "a option 1 1v :",
1240
925
            ])
1241
 
        index = self.get_knit_index(transport, 'filename', 'r')
1242
926
        try:
1243
 
            self.assertRaises(errors.KnitCorrupt, index.keys)
 
927
            self.assertRaises(errors.KnitCorrupt,
 
928
                              self.get_knit_index, transport, 'filename', 'r')
1244
929
        except TypeError, e:
1245
930
            if (str(e) == ('exceptions must be strings, classes, or instances,'
1246
931
                           ' not exceptions.ValueError')
1251
936
            else:
1252
937
                raise
1253
938
 
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
939
    def test_short_line(self):
1264
940
        transport = MockTransport([
1265
 
            _KndxIndex.HEADER,
 
941
            _KnitIndex.HEADER,
1266
942
            "a option 0 10  :",
1267
943
            "b option 10 10 0", # This line isn't terminated, ignored
1268
944
            ])
1269
945
        index = self.get_knit_index(transport, "filename", "r")
1270
 
        self.assertEqual(set([('a',)]), index.keys())
 
946
        self.assertEqual(['a'], index.get_versions())
1271
947
 
1272
948
    def test_skip_incomplete_record(self):
1273
949
        # A line with bogus data should just be skipped
1274
950
        transport = MockTransport([
1275
 
            _KndxIndex.HEADER,
 
951
            _KnitIndex.HEADER,
1276
952
            "a option 0 10  :",
1277
953
            "b option 10 10 0", # This line isn't terminated, ignored
1278
954
            "c option 20 10 0 :", # Properly terminated, and starts with '\n'
1279
955
            ])
1280
956
        index = self.get_knit_index(transport, "filename", "r")
1281
 
        self.assertEqual(set([('a',), ('c',)]), index.keys())
 
957
        self.assertEqual(['a', 'c'], index.get_versions())
1282
958
 
1283
959
    def test_trailing_characters(self):
1284
960
        # A line with bogus data should just be skipped
1285
961
        transport = MockTransport([
1286
 
            _KndxIndex.HEADER,
 
962
            _KnitIndex.HEADER,
1287
963
            "a option 0 10  :",
1288
964
            "b option 10 10 0 :a", # This line has extra trailing characters
1289
965
            "c option 20 10 0 :", # Properly terminated, and starts with '\n'
1290
966
            ])
1291
967
        index = self.get_knit_index(transport, "filename", "r")
1292
 
        self.assertEqual(set([('a',), ('c',)]), index.keys())
 
968
        self.assertEqual(['a', 'c'], index.get_versions())
1293
969
 
1294
970
 
1295
971
class LowLevelKnitIndexTests_c(LowLevelKnitIndexTests):
1296
972
 
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))
 
973
    _test_needs_features = [CompiledKnitFeature]
 
974
 
 
975
    def get_knit_index(self, *args, **kwargs):
 
976
        orig = knit._load_data
 
977
        def reset():
 
978
            knit._load_data = orig
 
979
        self.addCleanup(reset)
 
980
        from bzrlib._knit_load_data_c import _load_data_c
 
981
        knit._load_data = _load_data_c
 
982
        return _KnitIndex(*args, **kwargs)
 
983
 
1468
984
 
1469
985
 
1470
986
class KnitTests(TestCaseWithTransport):
1471
987
    """Class containing knit test helper routines."""
1472
988
 
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 ")
 
989
    def make_test_knit(self, annotate=False, delay_create=False, index=None):
 
990
        if not annotate:
 
991
            factory = KnitPlainFactory()
 
992
        else:
 
993
            factory = None
 
994
        return KnitVersionedFile('test', get_transport('.'), access_mode='w',
 
995
                                 factory=factory, create=True,
 
996
                                 delay_create=delay_create, index=index)
 
997
 
 
998
 
 
999
class BasicKnitTests(KnitTests):
 
1000
 
 
1001
    def add_stock_one_and_one_a(self, k):
 
1002
        k.add_lines('text-1', [], split_lines(TEXT_1))
 
1003
        k.add_lines('text-1a', ['text-1'], split_lines(TEXT_1A))
 
1004
 
 
1005
    def test_knit_constructor(self):
 
1006
        """Construct empty k"""
 
1007
        self.make_test_knit()
 
1008
 
 
1009
    def test_make_explicit_index(self):
 
1010
        """We can supply an index to use."""
 
1011
        knit = KnitVersionedFile('test', get_transport('.'),
 
1012
            index='strangelove')
 
1013
        self.assertEqual(knit._index, 'strangelove')
 
1014
 
 
1015
    def test_knit_add(self):
 
1016
        """Store one text in knit and retrieve"""
 
1017
        k = self.make_test_knit()
 
1018
        k.add_lines('text-1', [], split_lines(TEXT_1))
 
1019
        self.assertTrue(k.has_version('text-1'))
 
1020
        self.assertEqualDiff(''.join(k.get_lines('text-1')), TEXT_1)
 
1021
 
 
1022
    def test_knit_reload(self):
 
1023
        # test that the content in a reloaded knit is correct
 
1024
        k = self.make_test_knit()
 
1025
        k.add_lines('text-1', [], split_lines(TEXT_1))
 
1026
        del k
 
1027
        k2 = KnitVersionedFile('test', get_transport('.'), access_mode='r', factory=KnitPlainFactory(), create=True)
 
1028
        self.assertTrue(k2.has_version('text-1'))
 
1029
        self.assertEqualDiff(''.join(k2.get_lines('text-1')), TEXT_1)
 
1030
 
 
1031
    def test_knit_several(self):
 
1032
        """Store several texts in a knit"""
 
1033
        k = self.make_test_knit()
 
1034
        k.add_lines('text-1', [], split_lines(TEXT_1))
 
1035
        k.add_lines('text-2', [], split_lines(TEXT_2))
 
1036
        self.assertEqualDiff(''.join(k.get_lines('text-1')), TEXT_1)
 
1037
        self.assertEqualDiff(''.join(k.get_lines('text-2')), TEXT_2)
 
1038
        
 
1039
    def test_repeated_add(self):
 
1040
        """Knit traps attempt to replace existing version"""
 
1041
        k = self.make_test_knit()
 
1042
        k.add_lines('text-1', [], split_lines(TEXT_1))
 
1043
        self.assertRaises(RevisionAlreadyPresent, 
 
1044
                k.add_lines,
 
1045
                'text-1', [], split_lines(TEXT_1))
 
1046
 
 
1047
    def test_empty(self):
 
1048
        k = self.make_test_knit(True)
 
1049
        k.add_lines('text-1', [], [])
 
1050
        self.assertEquals(k.get_lines('text-1'), [])
 
1051
 
 
1052
    def test_incomplete(self):
 
1053
        """Test if texts without a ending line-end can be inserted and
 
1054
        extracted."""
 
1055
        k = KnitVersionedFile('test', get_transport('.'), delta=False, create=True)
 
1056
        k.add_lines('text-1', [], ['a\n',    'b'  ])
 
1057
        k.add_lines('text-2', ['text-1'], ['a\rb\n', 'b\n'])
 
1058
        # reopening ensures maximum room for confusion
 
1059
        k = KnitVersionedFile('test', get_transport('.'), delta=False, create=True)
 
1060
        self.assertEquals(k.get_lines('text-1'), ['a\n',    'b'  ])
 
1061
        self.assertEquals(k.get_lines('text-2'), ['a\rb\n', 'b\n'])
 
1062
 
 
1063
    def test_delta(self):
 
1064
        """Expression of knit delta as lines"""
 
1065
        k = self.make_test_knit()
 
1066
        KnitContent
 
1067
        td = list(line_delta(TEXT_1.splitlines(True),
 
1068
                             TEXT_1A.splitlines(True)))
 
1069
        self.assertEqualDiff(''.join(td), delta_1_1a)
 
1070
        out = apply_line_delta(TEXT_1.splitlines(True), td)
 
1071
        self.assertEqualDiff(''.join(out), TEXT_1A)
 
1072
 
 
1073
    def assertDerivedBlocksEqual(self, source, target, noeol=False):
 
1074
        """Assert that the derived matching blocks match real output"""
 
1075
        source_lines = source.splitlines(True)
 
1076
        target_lines = target.splitlines(True)
 
1077
        def nl(line):
 
1078
            if noeol and not line.endswith('\n'):
 
1079
                return line + '\n'
 
1080
            else:
 
1081
                return line
 
1082
        source_content = KnitContent([(None, nl(l)) for l in source_lines])
 
1083
        target_content = KnitContent([(None, nl(l)) for l in target_lines])
 
1084
        line_delta = source_content.line_delta(target_content)
 
1085
        delta_blocks = list(KnitContent.get_line_delta_blocks(line_delta,
 
1086
            source_lines, target_lines))
 
1087
        matcher = KnitSequenceMatcher(None, source_lines, target_lines)
 
1088
        matcher_blocks = list(list(matcher.get_matching_blocks()))
 
1089
        self.assertEqual(matcher_blocks, delta_blocks)
 
1090
 
 
1091
    def test_get_line_delta_blocks(self):
 
1092
        self.assertDerivedBlocksEqual('a\nb\nc\n', 'q\nc\n')
 
1093
        self.assertDerivedBlocksEqual(TEXT_1, TEXT_1)
 
1094
        self.assertDerivedBlocksEqual(TEXT_1, TEXT_1A)
 
1095
        self.assertDerivedBlocksEqual(TEXT_1, TEXT_1B)
 
1096
        self.assertDerivedBlocksEqual(TEXT_1B, TEXT_1A)
 
1097
        self.assertDerivedBlocksEqual(TEXT_1A, TEXT_1B)
 
1098
        self.assertDerivedBlocksEqual(TEXT_1A, '')
 
1099
        self.assertDerivedBlocksEqual('', TEXT_1A)
 
1100
        self.assertDerivedBlocksEqual('', '')
 
1101
        self.assertDerivedBlocksEqual('a\nb\nc', 'a\nb\nc\nd')
 
1102
 
 
1103
    def test_get_line_delta_blocks_noeol(self):
 
1104
        """Handle historical knit deltas safely
 
1105
 
 
1106
        Some existing knit deltas don't consider the last line to differ
 
1107
        when the only difference whether it has a final newline.
 
1108
 
 
1109
        New knit deltas appear to always consider the last line to differ
 
1110
        in this case.
 
1111
        """
 
1112
        self.assertDerivedBlocksEqual('a\nb\nc', 'a\nb\nc\nd\n', noeol=True)
 
1113
        self.assertDerivedBlocksEqual('a\nb\nc\nd\n', 'a\nb\nc', noeol=True)
 
1114
        self.assertDerivedBlocksEqual('a\nb\nc\n', 'a\nb\nc', noeol=True)
 
1115
        self.assertDerivedBlocksEqual('a\nb\nc', 'a\nb\nc\n', noeol=True)
 
1116
 
 
1117
    def test_add_with_parents(self):
 
1118
        """Store in knit with parents"""
 
1119
        k = self.make_test_knit()
 
1120
        self.add_stock_one_and_one_a(k)
 
1121
        self.assertEquals(k.get_parents('text-1'), [])
 
1122
        self.assertEquals(k.get_parents('text-1a'), ['text-1'])
 
1123
 
 
1124
    def test_ancestry(self):
 
1125
        """Store in knit with parents"""
 
1126
        k = self.make_test_knit()
 
1127
        self.add_stock_one_and_one_a(k)
 
1128
        self.assertEquals(set(k.get_ancestry(['text-1a'])), set(['text-1a', 'text-1']))
 
1129
 
 
1130
    def test_add_delta(self):
 
1131
        """Store in knit with parents"""
 
1132
        k = KnitVersionedFile('test', get_transport('.'), factory=KnitPlainFactory(),
 
1133
            delta=True, create=True)
 
1134
        self.add_stock_one_and_one_a(k)
 
1135
        k.clear_cache()
 
1136
        self.assertEqualDiff(''.join(k.get_lines('text-1a')), TEXT_1A)
 
1137
 
 
1138
    def test_add_delta_knit_graph_index(self):
 
1139
        """Does adding work with a KnitGraphIndex."""
 
1140
        index = InMemoryGraphIndex(2)
 
1141
        knit_index = KnitGraphIndex(index, add_callback=index.add_nodes,
 
1142
            deltas=True)
 
1143
        k = KnitVersionedFile('test', get_transport('.'),
 
1144
            delta=True, create=True, index=knit_index)
 
1145
        self.add_stock_one_and_one_a(k)
 
1146
        k.clear_cache()
 
1147
        self.assertEqualDiff(''.join(k.get_lines('text-1a')), TEXT_1A)
 
1148
        # check the index had the right data added.
 
1149
        self.assertEqual(set([
 
1150
            (index, ('text-1', ), ' 0 127', ((), ())),
 
1151
            (index, ('text-1a', ), ' 127 140', ((('text-1', ),), (('text-1', ),))),
 
1152
            ]), set(index.iter_all_entries()))
 
1153
        # we should not have a .kndx file
 
1154
        self.assertFalse(get_transport('.').has('test.kndx'))
 
1155
 
 
1156
    def test_annotate(self):
 
1157
        """Annotations"""
 
1158
        k = KnitVersionedFile('knit', get_transport('.'), factory=KnitAnnotateFactory(),
 
1159
            delta=True, create=True)
 
1160
        self.insert_and_test_small_annotate(k)
 
1161
 
 
1162
    def insert_and_test_small_annotate(self, k):
 
1163
        """test annotation with k works correctly."""
 
1164
        k.add_lines('text-1', [], ['a\n', 'b\n'])
 
1165
        k.add_lines('text-2', ['text-1'], ['a\n', 'c\n'])
 
1166
 
 
1167
        origins = k.annotate('text-2')
 
1168
        self.assertEquals(origins[0], ('text-1', 'a\n'))
 
1169
        self.assertEquals(origins[1], ('text-2', 'c\n'))
 
1170
 
 
1171
    def test_annotate_fulltext(self):
 
1172
        """Annotations"""
 
1173
        k = KnitVersionedFile('knit', get_transport('.'), factory=KnitAnnotateFactory(),
 
1174
            delta=False, create=True)
 
1175
        self.insert_and_test_small_annotate(k)
 
1176
 
 
1177
    def test_annotate_merge_1(self):
 
1178
        k = self.make_test_knit(True)
 
1179
        k.add_lines('text-a1', [], ['a\n', 'b\n'])
 
1180
        k.add_lines('text-a2', [], ['d\n', 'c\n'])
 
1181
        k.add_lines('text-am', ['text-a1', 'text-a2'], ['d\n', 'b\n'])
 
1182
        origins = k.annotate('text-am')
 
1183
        self.assertEquals(origins[0], ('text-a2', 'd\n'))
 
1184
        self.assertEquals(origins[1], ('text-a1', 'b\n'))
 
1185
 
 
1186
    def test_annotate_merge_2(self):
 
1187
        k = self.make_test_knit(True)
 
1188
        k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
 
1189
        k.add_lines('text-a2', [], ['x\n', 'y\n', 'z\n'])
 
1190
        k.add_lines('text-am', ['text-a1', 'text-a2'], ['a\n', 'y\n', 'c\n'])
 
1191
        origins = k.annotate('text-am')
 
1192
        self.assertEquals(origins[0], ('text-a1', 'a\n'))
 
1193
        self.assertEquals(origins[1], ('text-a2', 'y\n'))
 
1194
        self.assertEquals(origins[2], ('text-a1', 'c\n'))
 
1195
 
 
1196
    def test_annotate_merge_9(self):
 
1197
        k = self.make_test_knit(True)
 
1198
        k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
 
1199
        k.add_lines('text-a2', [], ['x\n', 'y\n', 'z\n'])
 
1200
        k.add_lines('text-am', ['text-a1', 'text-a2'], ['k\n', 'y\n', 'c\n'])
 
1201
        origins = k.annotate('text-am')
 
1202
        self.assertEquals(origins[0], ('text-am', 'k\n'))
 
1203
        self.assertEquals(origins[1], ('text-a2', 'y\n'))
 
1204
        self.assertEquals(origins[2], ('text-a1', 'c\n'))
 
1205
 
 
1206
    def test_annotate_merge_3(self):
 
1207
        k = self.make_test_knit(True)
 
1208
        k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
 
1209
        k.add_lines('text-a2', [] ,['x\n', 'y\n', 'z\n'])
 
1210
        k.add_lines('text-am', ['text-a1', 'text-a2'], ['k\n', 'y\n', 'z\n'])
 
1211
        origins = k.annotate('text-am')
 
1212
        self.assertEquals(origins[0], ('text-am', 'k\n'))
 
1213
        self.assertEquals(origins[1], ('text-a2', 'y\n'))
 
1214
        self.assertEquals(origins[2], ('text-a2', 'z\n'))
 
1215
 
 
1216
    def test_annotate_merge_4(self):
 
1217
        k = self.make_test_knit(True)
 
1218
        k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
 
1219
        k.add_lines('text-a2', [], ['x\n', 'y\n', 'z\n'])
 
1220
        k.add_lines('text-a3', ['text-a1'], ['a\n', 'b\n', 'p\n'])
 
1221
        k.add_lines('text-am', ['text-a2', 'text-a3'], ['a\n', 'b\n', 'z\n'])
 
1222
        origins = k.annotate('text-am')
 
1223
        self.assertEquals(origins[0], ('text-a1', 'a\n'))
 
1224
        self.assertEquals(origins[1], ('text-a1', 'b\n'))
 
1225
        self.assertEquals(origins[2], ('text-a2', 'z\n'))
 
1226
 
 
1227
    def test_annotate_merge_5(self):
 
1228
        k = self.make_test_knit(True)
 
1229
        k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
 
1230
        k.add_lines('text-a2', [], ['d\n', 'e\n', 'f\n'])
 
1231
        k.add_lines('text-a3', [], ['x\n', 'y\n', 'z\n'])
 
1232
        k.add_lines('text-am',
 
1233
                    ['text-a1', 'text-a2', 'text-a3'],
 
1234
                    ['a\n', 'e\n', 'z\n'])
 
1235
        origins = k.annotate('text-am')
 
1236
        self.assertEquals(origins[0], ('text-a1', 'a\n'))
 
1237
        self.assertEquals(origins[1], ('text-a2', 'e\n'))
 
1238
        self.assertEquals(origins[2], ('text-a3', 'z\n'))
 
1239
 
 
1240
    def test_annotate_file_cherry_pick(self):
 
1241
        k = self.make_test_knit(True)
 
1242
        k.add_lines('text-1', [], ['a\n', 'b\n', 'c\n'])
 
1243
        k.add_lines('text-2', ['text-1'], ['d\n', 'e\n', 'f\n'])
 
1244
        k.add_lines('text-3', ['text-2', 'text-1'], ['a\n', 'b\n', 'c\n'])
 
1245
        origins = k.annotate('text-3')
 
1246
        self.assertEquals(origins[0], ('text-1', 'a\n'))
 
1247
        self.assertEquals(origins[1], ('text-1', 'b\n'))
 
1248
        self.assertEquals(origins[2], ('text-1', 'c\n'))
 
1249
 
 
1250
    def test_knit_join(self):
 
1251
        """Store in knit with parents"""
 
1252
        k1 = KnitVersionedFile('test1', get_transport('.'), factory=KnitPlainFactory(), create=True)
 
1253
        k1.add_lines('text-a', [], split_lines(TEXT_1))
 
1254
        k1.add_lines('text-b', ['text-a'], split_lines(TEXT_1))
 
1255
 
 
1256
        k1.add_lines('text-c', [], split_lines(TEXT_1))
 
1257
        k1.add_lines('text-d', ['text-c'], split_lines(TEXT_1))
 
1258
 
 
1259
        k1.add_lines('text-m', ['text-b', 'text-d'], split_lines(TEXT_1))
 
1260
 
 
1261
        k2 = KnitVersionedFile('test2', get_transport('.'), factory=KnitPlainFactory(), create=True)
 
1262
        count = k2.join(k1, version_ids=['text-m'])
 
1263
        self.assertEquals(count, 5)
 
1264
        self.assertTrue(k2.has_version('text-a'))
 
1265
        self.assertTrue(k2.has_version('text-c'))
 
1266
 
 
1267
    def test_reannotate(self):
 
1268
        k1 = KnitVersionedFile('knit1', get_transport('.'),
 
1269
                               factory=KnitAnnotateFactory(), create=True)
 
1270
        # 0
 
1271
        k1.add_lines('text-a', [], ['a\n', 'b\n'])
 
1272
        # 1
 
1273
        k1.add_lines('text-b', ['text-a'], ['a\n', 'c\n'])
 
1274
 
 
1275
        k2 = KnitVersionedFile('test2', get_transport('.'),
 
1276
                               factory=KnitAnnotateFactory(), create=True)
 
1277
        k2.join(k1, version_ids=['text-b'])
 
1278
 
 
1279
        # 2
 
1280
        k1.add_lines('text-X', ['text-b'], ['a\n', 'b\n'])
 
1281
        # 2
 
1282
        k2.add_lines('text-c', ['text-b'], ['z\n', 'c\n'])
 
1283
        # 3
 
1284
        k2.add_lines('text-Y', ['text-b'], ['b\n', 'c\n'])
 
1285
 
 
1286
        # test-c will have index 3
 
1287
        k1.join(k2, version_ids=['text-c'])
 
1288
 
 
1289
        lines = k1.get_lines('text-c')
 
1290
        self.assertEquals(lines, ['z\n', 'c\n'])
 
1291
 
 
1292
        origins = k1.annotate('text-c')
 
1293
        self.assertEquals(origins[0], ('text-c', 'z\n'))
 
1294
        self.assertEquals(origins[1], ('text-b', 'c\n'))
 
1295
 
 
1296
    def test_get_line_delta_texts(self):
 
1297
        """Make sure we can call get_texts on text with reused line deltas"""
 
1298
        k1 = KnitVersionedFile('test1', get_transport('.'), 
 
1299
                               factory=KnitPlainFactory(), create=True)
 
1300
        for t in range(3):
 
1301
            if t == 0:
 
1302
                parents = []
 
1303
            else:
 
1304
                parents = ['%d' % (t-1)]
 
1305
            k1.add_lines('%d' % t, parents, ['hello\n'] * t)
 
1306
        k1.get_texts(('%d' % t) for t in range(3))
 
1307
        
 
1308
    def test_iter_lines_reads_in_order(self):
 
1309
        t = MemoryTransport()
 
1310
        instrumented_t = TransportLogger(t)
 
1311
        k1 = KnitVersionedFile('id', instrumented_t, create=True, delta=True)
 
1312
        self.assertEqual([('id.kndx',)], instrumented_t._calls)
 
1313
        # add texts with no required ordering
 
1314
        k1.add_lines('base', [], ['text\n'])
 
1315
        k1.add_lines('base2', [], ['text2\n'])
 
1316
        k1.clear_cache()
 
1317
        instrumented_t._calls = []
 
1318
        # request a last-first iteration
 
1319
        results = list(k1.iter_lines_added_or_present_in_versions(['base2', 'base']))
 
1320
        self.assertEqual([('id.knit', [(0, 87), (87, 89)])], instrumented_t._calls)
 
1321
        self.assertEqual(['text\n', 'text2\n'], results)
 
1322
 
 
1323
    def test_create_empty_annotated(self):
 
1324
        k1 = self.make_test_knit(True)
 
1325
        # 0
 
1326
        k1.add_lines('text-a', [], ['a\n', 'b\n'])
 
1327
        k2 = k1.create_empty('t', MemoryTransport())
 
1328
        self.assertTrue(isinstance(k2.factory, KnitAnnotateFactory))
 
1329
        self.assertEqual(k1.delta, k2.delta)
 
1330
        # the generic test checks for empty content and file class
 
1331
 
 
1332
    def test_knit_format(self):
 
1333
        # this tests that a new knit index file has the expected content
 
1334
        # and that is writes the data we expect as records are added.
 
1335
        knit = self.make_test_knit(True)
 
1336
        # Now knit files are not created until we first add data to them
 
1337
        self.assertFileEqual("# bzr knit index 8\n", 'test.kndx')
 
1338
        knit.add_lines_with_ghosts('revid', ['a_ghost'], ['a\n'])
 
1339
        self.assertFileEqual(
 
1340
            "# bzr knit index 8\n"
 
1341
            "\n"
 
1342
            "revid fulltext 0 84 .a_ghost :",
 
1343
            'test.kndx')
 
1344
        knit.add_lines_with_ghosts('revid2', ['revid'], ['a\n'])
 
1345
        self.assertFileEqual(
 
1346
            "# bzr knit index 8\n"
 
1347
            "\nrevid fulltext 0 84 .a_ghost :"
 
1348
            "\nrevid2 line-delta 84 82 0 :",
 
1349
            'test.kndx')
 
1350
        # we should be able to load this file again
 
1351
        knit = KnitVersionedFile('test', get_transport('.'), access_mode='r')
 
1352
        self.assertEqual(['revid', 'revid2'], knit.versions())
 
1353
        # write a short write to the file and ensure that its ignored
 
1354
        indexfile = file('test.kndx', 'ab')
 
1355
        indexfile.write('\nrevid3 line-delta 166 82 1 2 3 4 5 .phwoar:demo ')
 
1356
        indexfile.close()
 
1357
        # we should be able to load this file again
 
1358
        knit = KnitVersionedFile('test', get_transport('.'), access_mode='w')
 
1359
        self.assertEqual(['revid', 'revid2'], knit.versions())
 
1360
        # and add a revision with the same id the failed write had
 
1361
        knit.add_lines('revid3', ['revid2'], ['a\n'])
 
1362
        # and when reading it revid3 should now appear.
 
1363
        knit = KnitVersionedFile('test', get_transport('.'), access_mode='r')
 
1364
        self.assertEqual(['revid', 'revid2', 'revid3'], knit.versions())
 
1365
        self.assertEqual(['revid2'], knit.get_parents('revid3'))
 
1366
 
 
1367
    def test_delay_create(self):
 
1368
        """Test that passing delay_create=True creates files late"""
 
1369
        knit = self.make_test_knit(annotate=True, delay_create=True)
 
1370
        self.failIfExists('test.knit')
 
1371
        self.failIfExists('test.kndx')
 
1372
        knit.add_lines_with_ghosts('revid', ['a_ghost'], ['a\n'])
 
1373
        self.failUnlessExists('test.knit')
 
1374
        self.assertFileEqual(
 
1375
            "# bzr knit index 8\n"
 
1376
            "\n"
 
1377
            "revid fulltext 0 84 .a_ghost :",
 
1378
            'test.kndx')
 
1379
 
 
1380
    def test_create_parent_dir(self):
 
1381
        """create_parent_dir can create knits in nonexistant dirs"""
 
1382
        # Has no effect if we don't set 'delay_create'
 
1383
        trans = get_transport('.')
 
1384
        self.assertRaises(NoSuchFile, KnitVersionedFile, 'dir/test',
 
1385
                          trans, access_mode='w', factory=None,
 
1386
                          create=True, create_parent_dir=True)
 
1387
        # Nothing should have changed yet
 
1388
        knit = KnitVersionedFile('dir/test', trans, access_mode='w',
 
1389
                                 factory=None, create=True,
 
1390
                                 create_parent_dir=True,
 
1391
                                 delay_create=True)
 
1392
        self.failIfExists('dir/test.knit')
 
1393
        self.failIfExists('dir/test.kndx')
 
1394
        self.failIfExists('dir')
 
1395
        knit.add_lines('revid', [], ['a\n'])
 
1396
        self.failUnlessExists('dir')
 
1397
        self.failUnlessExists('dir/test.knit')
 
1398
        self.assertFileEqual(
 
1399
            "# bzr knit index 8\n"
 
1400
            "\n"
 
1401
            "revid fulltext 0 84  :",
 
1402
            'dir/test.kndx')
 
1403
 
 
1404
    def test_create_mode_700(self):
 
1405
        trans = get_transport('.')
 
1406
        if not trans._can_roundtrip_unix_modebits():
 
1407
            # Can't roundtrip, so no need to run this test
 
1408
            return
 
1409
        knit = KnitVersionedFile('dir/test', trans, access_mode='w',
 
1410
                                 factory=None, create=True,
 
1411
                                 create_parent_dir=True,
 
1412
                                 delay_create=True,
 
1413
                                 file_mode=0600,
 
1414
                                 dir_mode=0700)
 
1415
        knit.add_lines('revid', [], ['a\n'])
 
1416
        self.assertTransportMode(trans, 'dir', 0700)
 
1417
        self.assertTransportMode(trans, 'dir/test.knit', 0600)
 
1418
        self.assertTransportMode(trans, 'dir/test.kndx', 0600)
 
1419
 
 
1420
    def test_create_mode_770(self):
 
1421
        trans = get_transport('.')
 
1422
        if not trans._can_roundtrip_unix_modebits():
 
1423
            # Can't roundtrip, so no need to run this test
 
1424
            return
 
1425
        knit = KnitVersionedFile('dir/test', trans, access_mode='w',
 
1426
                                 factory=None, create=True,
 
1427
                                 create_parent_dir=True,
 
1428
                                 delay_create=True,
 
1429
                                 file_mode=0660,
 
1430
                                 dir_mode=0770)
 
1431
        knit.add_lines('revid', [], ['a\n'])
 
1432
        self.assertTransportMode(trans, 'dir', 0770)
 
1433
        self.assertTransportMode(trans, 'dir/test.knit', 0660)
 
1434
        self.assertTransportMode(trans, 'dir/test.kndx', 0660)
 
1435
 
 
1436
    def test_create_mode_777(self):
 
1437
        trans = get_transport('.')
 
1438
        if not trans._can_roundtrip_unix_modebits():
 
1439
            # Can't roundtrip, so no need to run this test
 
1440
            return
 
1441
        knit = KnitVersionedFile('dir/test', trans, access_mode='w',
 
1442
                                 factory=None, create=True,
 
1443
                                 create_parent_dir=True,
 
1444
                                 delay_create=True,
 
1445
                                 file_mode=0666,
 
1446
                                 dir_mode=0777)
 
1447
        knit.add_lines('revid', [], ['a\n'])
 
1448
        self.assertTransportMode(trans, 'dir', 0777)
 
1449
        self.assertTransportMode(trans, 'dir/test.knit', 0666)
 
1450
        self.assertTransportMode(trans, 'dir/test.kndx', 0666)
 
1451
 
 
1452
    def test_plan_merge(self):
 
1453
        my_knit = self.make_test_knit(annotate=True)
 
1454
        my_knit.add_lines('text1', [], split_lines(TEXT_1))
 
1455
        my_knit.add_lines('text1a', ['text1'], split_lines(TEXT_1A))
 
1456
        my_knit.add_lines('text1b', ['text1'], split_lines(TEXT_1B))
 
1457
        plan = list(my_knit.plan_merge('text1a', 'text1b'))
 
1458
        for plan_line, expected_line in zip(plan, AB_MERGE):
 
1459
            self.assertEqual(plan_line, expected_line)
 
1460
 
 
1461
 
 
1462
TEXT_1 = """\
 
1463
Banana cup cakes:
 
1464
 
 
1465
- bananas
 
1466
- eggs
 
1467
- broken tea cups
 
1468
"""
 
1469
 
 
1470
TEXT_1A = """\
 
1471
Banana cup cake recipe
 
1472
(serves 6)
 
1473
 
 
1474
- bananas
 
1475
- eggs
 
1476
- broken tea cups
 
1477
- self-raising flour
 
1478
"""
 
1479
 
 
1480
TEXT_1B = """\
 
1481
Banana cup cake recipe
 
1482
 
 
1483
- bananas (do not use plantains!!!)
 
1484
- broken tea cups
 
1485
- flour
 
1486
"""
 
1487
 
 
1488
delta_1_1a = """\
 
1489
0,1,2
 
1490
Banana cup cake recipe
 
1491
(serves 6)
 
1492
5,5,1
 
1493
- self-raising flour
 
1494
"""
 
1495
 
 
1496
TEXT_2 = """\
 
1497
Boeuf bourguignon
 
1498
 
 
1499
- beef
 
1500
- red wine
 
1501
- small onions
 
1502
- carrot
 
1503
- mushrooms
 
1504
"""
 
1505
 
 
1506
AB_MERGE_TEXT="""unchanged|Banana cup cake recipe
 
1507
new-a|(serves 6)
 
1508
unchanged|
 
1509
killed-b|- bananas
 
1510
killed-b|- eggs
 
1511
new-b|- bananas (do not use plantains!!!)
 
1512
unchanged|- broken tea cups
 
1513
new-a|- self-raising flour
 
1514
new-b|- flour
 
1515
"""
 
1516
AB_MERGE=[tuple(l.split('|')) for l in AB_MERGE_TEXT.splitlines(True)]
 
1517
 
 
1518
 
 
1519
def line_delta(from_lines, to_lines):
 
1520
    """Generate line-based delta from one text to another"""
 
1521
    s = difflib.SequenceMatcher(None, from_lines, to_lines)
 
1522
    for op in s.get_opcodes():
 
1523
        if op[0] == 'equal':
 
1524
            continue
 
1525
        yield '%d,%d,%d\n' % (op[1], op[2], op[4]-op[3])
 
1526
        for i in range(op[3], op[4]):
 
1527
            yield to_lines[i]
 
1528
 
 
1529
 
 
1530
def apply_line_delta(basis_lines, delta_lines):
 
1531
    """Apply a line-based perfect diff
 
1532
    
 
1533
    basis_lines -- text to apply the patch to
 
1534
    delta_lines -- diff instructions and content
 
1535
    """
 
1536
    out = basis_lines[:]
 
1537
    i = 0
 
1538
    offset = 0
 
1539
    while i < len(delta_lines):
 
1540
        l = delta_lines[i]
 
1541
        a, b, c = map(long, l.split(','))
 
1542
        i = i + 1
 
1543
        out[offset+a:offset+b] = delta_lines[i:i+c]
 
1544
        i = i + c
 
1545
        offset = offset + (b - a) + c
 
1546
    return out
 
1547
 
 
1548
 
 
1549
class TestWeaveToKnit(KnitTests):
 
1550
 
 
1551
    def test_weave_to_knit_matches(self):
 
1552
        # check that the WeaveToKnit is_compatible function
 
1553
        # registers True for a Weave to a Knit.
 
1554
        w = Weave()
 
1555
        k = self.make_test_knit()
 
1556
        self.failUnless(WeaveToKnit.is_compatible(w, k))
 
1557
        self.failIf(WeaveToKnit.is_compatible(k, w))
 
1558
        self.failIf(WeaveToKnit.is_compatible(w, w))
 
1559
        self.failIf(WeaveToKnit.is_compatible(k, k))
 
1560
 
 
1561
 
 
1562
class TestKnitCaching(KnitTests):
 
1563
    
 
1564
    def create_knit(self, cache_add=False):
 
1565
        k = self.make_test_knit(True)
 
1566
        if cache_add:
 
1567
            k.enable_cache()
 
1568
 
 
1569
        k.add_lines('text-1', [], split_lines(TEXT_1))
 
1570
        k.add_lines('text-2', [], split_lines(TEXT_2))
 
1571
        return k
 
1572
 
 
1573
    def test_no_caching(self):
 
1574
        k = self.create_knit()
 
1575
        # Nothing should be cached without setting 'enable_cache'
 
1576
        self.assertEqual({}, k._data._cache)
 
1577
 
 
1578
    def test_cache_add_and_clear(self):
 
1579
        k = self.create_knit(True)
 
1580
 
 
1581
        self.assertEqual(['text-1', 'text-2'], sorted(k._data._cache.keys()))
 
1582
 
 
1583
        k.clear_cache()
 
1584
        self.assertEqual({}, k._data._cache)
 
1585
 
 
1586
    def test_cache_data_read_raw(self):
 
1587
        k = self.create_knit()
 
1588
 
 
1589
        # Now cache and read
 
1590
        k.enable_cache()
 
1591
 
 
1592
        def read_one_raw(version):
 
1593
            pos_map = k._get_components_positions([version])
 
1594
            method, index_memo, next = pos_map[version]
 
1595
            lst = list(k._data.read_records_iter_raw([(version, index_memo)]))
 
1596
            self.assertEqual(1, len(lst))
 
1597
            return lst[0]
 
1598
 
 
1599
        val = read_one_raw('text-1')
 
1600
        self.assertEqual({'text-1':val[1]}, k._data._cache)
 
1601
 
 
1602
        k.clear_cache()
 
1603
        # After clear, new reads are not cached
 
1604
        self.assertEqual({}, k._data._cache)
 
1605
 
 
1606
        val2 = read_one_raw('text-1')
 
1607
        self.assertEqual(val, val2)
 
1608
        self.assertEqual({}, k._data._cache)
 
1609
 
 
1610
    def test_cache_data_read(self):
 
1611
        k = self.create_knit()
 
1612
 
 
1613
        def read_one(version):
 
1614
            pos_map = k._get_components_positions([version])
 
1615
            method, index_memo, next = pos_map[version]
 
1616
            lst = list(k._data.read_records_iter([(version, index_memo)]))
 
1617
            self.assertEqual(1, len(lst))
 
1618
            return lst[0]
 
1619
 
 
1620
        # Now cache and read
 
1621
        k.enable_cache()
 
1622
 
 
1623
        val = read_one('text-2')
 
1624
        self.assertEqual(['text-2'], k._data._cache.keys())
 
1625
        self.assertEqual('text-2', val[0])
 
1626
        content, digest = k._data._parse_record('text-2',
 
1627
                                                k._data._cache['text-2'])
 
1628
        self.assertEqual(content, val[1])
 
1629
        self.assertEqual(digest, val[2])
 
1630
 
 
1631
        k.clear_cache()
 
1632
        self.assertEqual({}, k._data._cache)
 
1633
 
 
1634
        val2 = read_one('text-2')
 
1635
        self.assertEqual(val, val2)
 
1636
        self.assertEqual({}, k._data._cache)
 
1637
 
 
1638
    def test_cache_read(self):
 
1639
        k = self.create_knit()
 
1640
        k.enable_cache()
 
1641
 
 
1642
        text = k.get_text('text-1')
 
1643
        self.assertEqual(TEXT_1, text)
 
1644
        self.assertEqual(['text-1'], k._data._cache.keys())
 
1645
 
 
1646
        k.clear_cache()
 
1647
        self.assertEqual({}, k._data._cache)
 
1648
 
 
1649
        text = k.get_text('text-1')
 
1650
        self.assertEqual(TEXT_1, text)
 
1651
        self.assertEqual({}, k._data._cache)
1503
1652
 
1504
1653
 
1505
1654
class TestKnitIndex(KnitTests):
1508
1657
        """Adding versions to the index should update the lookup dict"""
1509
1658
        knit = self.make_test_knit()
1510
1659
        idx = knit._index
1511
 
        idx.add_records([(('a-1',), ['fulltext'], (('a-1',), 0, 0), [])])
 
1660
        idx.add_version('a-1', ['fulltext'], (None, 0, 0), [])
1512
1661
        self.check_file_contents('test.kndx',
1513
1662
            '# bzr knit index 8\n'
1514
1663
            '\n'
1515
1664
            'a-1 fulltext 0 0  :'
1516
1665
            )
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
 
            ])
 
1666
        idx.add_versions([('a-2', ['fulltext'], (None, 0, 0), ['a-1']),
 
1667
                          ('a-3', ['fulltext'], (None, 0, 0), ['a-2']),
 
1668
                         ])
1521
1669
        self.check_file_contents('test.kndx',
1522
1670
            '# bzr knit index 8\n'
1523
1671
            '\n'
1525
1673
            'a-2 fulltext 0 0 0 :\n'
1526
1674
            'a-3 fulltext 0 0 1 :'
1527
1675
            )
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()))
 
1676
        self.assertEqual(['a-1', 'a-2', 'a-3'], idx._history)
 
1677
        self.assertEqual({'a-1':('a-1', ['fulltext'], 0, 0, [], 0),
 
1678
                          'a-2':('a-2', ['fulltext'], 0, 0, ['a-1'], 1),
 
1679
                          'a-3':('a-3', ['fulltext'], 0, 0, ['a-2'], 2),
 
1680
                         }, idx._cache)
1538
1681
 
1539
1682
    def test_add_versions_fails_clean(self):
1540
1683
        """If add_versions fails in the middle, it restores a pristine state.
1550
1693
 
1551
1694
        knit = self.make_test_knit()
1552
1695
        idx = knit._index
1553
 
        idx.add_records([(('a-1',), ['fulltext'], (('a-1',), 0, 0), [])])
 
1696
        idx.add_version('a-1', ['fulltext'], (None, 0, 0), [])
1554
1697
 
1555
1698
        class StopEarly(Exception):
1556
1699
            pass
1557
1700
 
1558
1701
        def generate_failure():
1559
1702
            """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',))
 
1703
            yield ('a-2', ['fulltext'], (None, 0, 0), ['a-1'])
 
1704
            yield ('a-3', ['fulltext'], (None, 0, 0), ['a-2'])
1562
1705
            raise StopEarly()
1563
1706
 
1564
1707
        # 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())
 
1708
        self.assertEqual(['a-1'], idx._history)
 
1709
        self.assertEqual({'a-1':('a-1', ['fulltext'], 0, 0, [], 0)}, idx._cache)
 
1710
 
 
1711
        self.assertRaises(StopEarly, idx.add_versions, generate_failure())
 
1712
 
1574
1713
        # And it shouldn't be modified
1575
 
        assertA1Only()
 
1714
        self.assertEqual(['a-1'], idx._history)
 
1715
        self.assertEqual({'a-1':('a-1', ['fulltext'], 0, 0, [], 0)}, idx._cache)
1576
1716
 
1577
1717
    def test_knit_index_ignores_empty_files(self):
1578
1718
        # There was a race condition in older bzr, where a ^C at the right time
1587
1727
    def test_knit_index_checks_header(self):
1588
1728
        t = get_transport('.')
1589
1729
        t.put_bytes('test.kndx', '# not really a knit header\n\n')
1590
 
        k = self.make_test_knit()
1591
 
        self.assertRaises(KnitHeaderError, k.keys)
 
1730
 
 
1731
        self.assertRaises(KnitHeaderError, self.make_test_knit)
1592
1732
 
1593
1733
 
1594
1734
class TestGraphIndexKnit(KnitTests):
1600
1740
            builder.add_node(node, references, value)
1601
1741
        stream = builder.finish()
1602
1742
        trans = self.get_transport()
1603
 
        size = trans.put_file(name, stream)
1604
 
        return GraphIndex(trans, name, size)
 
1743
        trans.put_file(name, stream)
 
1744
        return GraphIndex(trans, name)
1605
1745
 
1606
1746
    def two_graph_index(self, deltas=False, catch_adds=False):
1607
1747
        """Build a two-graph index.
1633
1773
            add_callback = self.catch_add
1634
1774
        else:
1635
1775
            add_callback = None
1636
 
        return _KnitGraphIndex(combined_index, lambda:True, deltas=deltas,
 
1776
        return KnitGraphIndex(combined_index, deltas=deltas,
1637
1777
            add_callback=add_callback)
1638
1778
 
1639
 
    def test_keys(self):
1640
 
        index = self.two_graph_index()
1641
 
        self.assertEqual(set([('tail',), ('tip',), ('parent',), ('separate',)]),
1642
 
            set(index.keys()))
 
1779
    def test_get_graph(self):
 
1780
        index = self.two_graph_index()
 
1781
        self.assertEqual(set([
 
1782
            ('tip', ('parent', )),
 
1783
            ('tail', ()),
 
1784
            ('parent', ('tail', 'ghost')),
 
1785
            ('separate', ()),
 
1786
            ]), set(index.get_graph()))
 
1787
 
 
1788
    def test_get_ancestry(self):
 
1789
        # get_ancestry is defined as eliding ghosts, not erroring.
 
1790
        index = self.two_graph_index()
 
1791
        self.assertEqual([], index.get_ancestry([]))
 
1792
        self.assertEqual(['separate'], index.get_ancestry(['separate']))
 
1793
        self.assertEqual(['tail'], index.get_ancestry(['tail']))
 
1794
        self.assertEqual(['tail', 'parent'], index.get_ancestry(['parent']))
 
1795
        self.assertEqual(['tail', 'parent', 'tip'], index.get_ancestry(['tip']))
 
1796
        self.assertTrue(index.get_ancestry(['tip', 'separate']) in
 
1797
            (['tail', 'parent', 'tip', 'separate'],
 
1798
             ['separate', 'tail', 'parent', 'tip'],
 
1799
            ))
 
1800
        # and without topo_sort
 
1801
        self.assertEqual(set(['separate']),
 
1802
            set(index.get_ancestry(['separate'], topo_sorted=False)))
 
1803
        self.assertEqual(set(['tail']),
 
1804
            set(index.get_ancestry(['tail'], topo_sorted=False)))
 
1805
        self.assertEqual(set(['tail', 'parent']),
 
1806
            set(index.get_ancestry(['parent'], topo_sorted=False)))
 
1807
        self.assertEqual(set(['tail', 'parent', 'tip']),
 
1808
            set(index.get_ancestry(['tip'], topo_sorted=False)))
 
1809
        self.assertEqual(set(['separate', 'tail', 'parent', 'tip']),
 
1810
            set(index.get_ancestry(['tip', 'separate'])))
 
1811
        # asking for a ghost makes it go boom.
 
1812
        self.assertRaises(errors.RevisionNotPresent, index.get_ancestry, ['ghost'])
 
1813
 
 
1814
    def test_get_ancestry_with_ghosts(self):
 
1815
        index = self.two_graph_index()
 
1816
        self.assertEqual([], index.get_ancestry_with_ghosts([]))
 
1817
        self.assertEqual(['separate'], index.get_ancestry_with_ghosts(['separate']))
 
1818
        self.assertEqual(['tail'], index.get_ancestry_with_ghosts(['tail']))
 
1819
        self.assertTrue(index.get_ancestry_with_ghosts(['parent']) in
 
1820
            (['tail', 'ghost', 'parent'],
 
1821
             ['ghost', 'tail', 'parent'],
 
1822
            ))
 
1823
        self.assertTrue(index.get_ancestry_with_ghosts(['tip']) in
 
1824
            (['tail', 'ghost', 'parent', 'tip'],
 
1825
             ['ghost', 'tail', 'parent', 'tip'],
 
1826
            ))
 
1827
        self.assertTrue(index.get_ancestry_with_ghosts(['tip', 'separate']) in
 
1828
            (['tail', 'ghost', 'parent', 'tip', 'separate'],
 
1829
             ['ghost', 'tail', 'parent', 'tip', 'separate'],
 
1830
             ['separate', 'tail', 'ghost', 'parent', 'tip'],
 
1831
             ['separate', 'ghost', 'tail', 'parent', 'tip'],
 
1832
            ))
 
1833
        # asking for a ghost makes it go boom.
 
1834
        self.assertRaises(errors.RevisionNotPresent, index.get_ancestry_with_ghosts, ['ghost'])
 
1835
 
 
1836
    def test_num_versions(self):
 
1837
        index = self.two_graph_index()
 
1838
        self.assertEqual(4, index.num_versions())
 
1839
 
 
1840
    def test_get_versions(self):
 
1841
        index = self.two_graph_index()
 
1842
        self.assertEqual(set(['tail', 'tip', 'parent', 'separate']),
 
1843
            set(index.get_versions()))
 
1844
 
 
1845
    def test_has_version(self):
 
1846
        index = self.two_graph_index()
 
1847
        self.assertTrue(index.has_version('tail'))
 
1848
        self.assertFalse(index.has_version('ghost'))
1643
1849
 
1644
1850
    def test_get_position(self):
1645
1851
        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',)))
 
1852
        self.assertEqual((index._graph_index._indices[0], 0, 100), index.get_position('tip'))
 
1853
        self.assertEqual((index._graph_index._indices[1], 100, 78), index.get_position('parent'))
1648
1854
 
1649
1855
    def test_get_method_deltas(self):
1650
1856
        index = self.two_graph_index(deltas=True)
1651
 
        self.assertEqual('fulltext', index.get_method(('tip',)))
1652
 
        self.assertEqual('line-delta', index.get_method(('parent',)))
 
1857
        self.assertEqual('fulltext', index.get_method('tip'))
 
1858
        self.assertEqual('line-delta', index.get_method('parent'))
1653
1859
 
1654
1860
    def test_get_method_no_deltas(self):
1655
1861
        # check that the parent-history lookup is ignored with deltas=False.
1656
1862
        index = self.two_graph_index(deltas=False)
1657
 
        self.assertEqual('fulltext', index.get_method(('tip',)))
1658
 
        self.assertEqual('fulltext', index.get_method(('parent',)))
 
1863
        self.assertEqual('fulltext', index.get_method('tip'))
 
1864
        self.assertEqual('fulltext', index.get_method('parent'))
1659
1865
 
1660
1866
    def test_get_options_deltas(self):
1661
1867
        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',)))
 
1868
        self.assertEqual(['fulltext', 'no-eol'], index.get_options('tip'))
 
1869
        self.assertEqual(['line-delta'], index.get_options('parent'))
1664
1870
 
1665
1871
    def test_get_options_no_deltas(self):
1666
1872
        # check that the parent-history lookup is ignored with deltas=False.
1667
1873
        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',)]))
 
1874
        self.assertEqual(['fulltext', 'no-eol'], index.get_options('tip'))
 
1875
        self.assertEqual(['fulltext'], index.get_options('parent'))
 
1876
 
 
1877
    def test_get_parents(self):
 
1878
        # get_parents ignores ghosts
 
1879
        index = self.two_graph_index()
 
1880
        self.assertEqual(('tail', ), index.get_parents('parent'))
 
1881
        # and errors on ghosts.
 
1882
        self.assertRaises(errors.RevisionNotPresent,
 
1883
            index.get_parents, 'ghost')
 
1884
 
 
1885
    def test_get_parents_with_ghosts(self):
 
1886
        index = self.two_graph_index()
 
1887
        self.assertEqual(('tail', 'ghost'), index.get_parents_with_ghosts('parent'))
 
1888
        # and errors on ghosts.
 
1889
        self.assertRaises(errors.RevisionNotPresent,
 
1890
            index.get_parents_with_ghosts, 'ghost')
 
1891
 
 
1892
    def test_check_versions_present(self):
 
1893
        # ghosts should not be considered present
 
1894
        index = self.two_graph_index()
 
1895
        self.assertRaises(RevisionNotPresent, index.check_versions_present,
 
1896
            ['ghost'])
 
1897
        self.assertRaises(RevisionNotPresent, index.check_versions_present,
 
1898
            ['tail', 'ghost'])
 
1899
        index.check_versions_present(['tail', 'separate'])
1675
1900
 
1676
1901
    def catch_add(self, entries):
1677
1902
        self.caught_entries.append(entries)
1678
1903
 
1679
1904
    def test_add_no_callback_errors(self):
1680
1905
        index = self.two_graph_index()
1681
 
        self.assertRaises(errors.ReadOnlyError, index.add_records,
1682
 
            [(('new',), 'fulltext,no-eol', (None, 50, 60), ['separate'])])
 
1906
        self.assertRaises(errors.ReadOnlyError, index.add_version,
 
1907
            'new', 'fulltext,no-eol', (None, 50, 60), ['separate'])
1683
1908
 
1684
1909
    def test_add_version_smoke(self):
1685
1910
        index = self.two_graph_index(catch_adds=True)
1686
 
        index.add_records([(('new',), 'fulltext,no-eol', (None, 50, 60),
1687
 
            [('separate',)])])
 
1911
        index.add_version('new', 'fulltext,no-eol', (None, 50, 60), ['separate'])
1688
1912
        self.assertEqual([[(('new', ), 'N50 60', ((('separate',),),))]],
1689
1913
            self.caught_entries)
1690
1914
 
1691
1915
    def test_add_version_delta_not_delta_index(self):
1692
1916
        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',)])])
 
1917
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
1918
            'new', 'no-eol,line-delta', (None, 0, 100), ['parent'])
1695
1919
        self.assertEqual([], self.caught_entries)
1696
1920
 
1697
1921
    def test_add_version_same_dup(self):
1698
1922
        index = self.two_graph_index(catch_adds=True)
1699
1923
        # 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
 
 
 
1924
        index.add_version('tip', 'fulltext,no-eol', (None, 0, 100), ['parent'])
 
1925
        index.add_version('tip', 'no-eol,fulltext', (None, 0, 100), ['parent'])
 
1926
        # but neither should have added data.
 
1927
        self.assertEqual([[], []], self.caught_entries)
 
1928
        
1711
1929
    def test_add_version_different_dup(self):
1712
1930
        index = self.two_graph_index(deltas=True, catch_adds=True)
1713
1931
        # 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',)])])
 
1932
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
1933
            'tip', 'no-eol,line-delta', (None, 0, 100), ['parent'])
 
1934
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
1935
            'tip', 'line-delta,no-eol', (None, 0, 100), ['parent'])
 
1936
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
1937
            'tip', 'fulltext', (None, 0, 100), ['parent'])
 
1938
        # position/length
 
1939
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
1940
            'tip', 'fulltext,no-eol', (None, 50, 100), ['parent'])
 
1941
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
1942
            'tip', 'fulltext,no-eol', (None, 0, 1000), ['parent'])
1718
1943
        # parents
1719
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
1720
 
            [(('tip',), 'fulltext,no-eol', (None, 0, 100), [])])
 
1944
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
1945
            'tip', 'fulltext,no-eol', (None, 0, 100), [])
1721
1946
        self.assertEqual([], self.caught_entries)
1722
 
 
 
1947
        
1723
1948
    def test_add_versions_nodeltas(self):
1724
1949
        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',)]),
 
1950
        index.add_versions([
 
1951
                ('new', 'fulltext,no-eol', (None, 50, 60), ['separate']),
 
1952
                ('new2', 'fulltext', (None, 0, 6), ['new']),
1728
1953
                ])
1729
1954
        self.assertEqual([(('new', ), 'N50 60', ((('separate',),),)),
1730
1955
            (('new2', ), ' 0 6', ((('new',),),))],
1733
1958
 
1734
1959
    def test_add_versions_deltas(self):
1735
1960
        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',)]),
 
1961
        index.add_versions([
 
1962
                ('new', 'fulltext,no-eol', (None, 50, 60), ['separate']),
 
1963
                ('new2', 'line-delta', (None, 0, 6), ['new']),
1739
1964
                ])
1740
1965
        self.assertEqual([(('new', ), 'N50 60', ((('separate',),), ())),
1741
1966
            (('new2', ), ' 0 6', ((('new',),), (('new',),), ))],
1744
1969
 
1745
1970
    def test_add_versions_delta_not_delta_index(self):
1746
1971
        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',)])])
 
1972
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
1973
            [('new', 'no-eol,line-delta', (None, 0, 100), ['parent'])])
1749
1974
        self.assertEqual([], self.caught_entries)
1750
1975
 
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
1976
    def test_add_versions_same_dup(self):
1756
1977
        index = self.two_graph_index(catch_adds=True)
1757
1978
        # 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',)])])
 
1979
        index.add_versions([('tip', 'fulltext,no-eol', (None, 0, 100), ['parent'])])
 
1980
        index.add_versions([('tip', 'no-eol,fulltext', (None, 0, 100), ['parent'])])
1768
1981
        # but neither should have added data.
1769
 
        self.assertEqual([[], [], [], []], self.caught_entries)
1770
 
 
 
1982
        self.assertEqual([[], []], self.caught_entries)
 
1983
        
1771
1984
    def test_add_versions_different_dup(self):
1772
1985
        index = self.two_graph_index(deltas=True, catch_adds=True)
1773
1986
        # 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',)])])
 
1987
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
1988
            [('tip', 'no-eol,line-delta', (None, 0, 100), ['parent'])])
 
1989
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
1990
            [('tip', 'line-delta,no-eol', (None, 0, 100), ['parent'])])
 
1991
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
1992
            [('tip', 'fulltext', (None, 0, 100), ['parent'])])
 
1993
        # position/length
 
1994
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
1995
            [('tip', 'fulltext,no-eol', (None, 50, 100), ['parent'])])
 
1996
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
1997
            [('tip', 'fulltext,no-eol', (None, 0, 1000), ['parent'])])
1778
1998
        # parents
1779
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
1780
 
            [(('tip',), 'fulltext,no-eol', (None, 0, 100), [])])
 
1999
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2000
            [('tip', 'fulltext,no-eol', (None, 0, 100), [])])
1781
2001
        # 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',)])])
 
2002
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2003
            [('tip', 'fulltext,no-eol', (None, 0, 100), ['parent']),
 
2004
             ('tip', 'no-eol,line-delta', (None, 0, 100), ['parent'])])
1785
2005
        self.assertEqual([], self.caught_entries)
1786
2006
 
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())
 
2007
    def test_iter_parents(self):
 
2008
        index1 = self.make_g_index('1', 1, [
 
2009
        # no parents
 
2010
            (('r0', ), 'N0 100', ([], )),
 
2011
        # 1 parent
 
2012
            (('r1', ), '', ([('r0', )], ))])
 
2013
        index2 = self.make_g_index('2', 1, [
 
2014
        # 2 parents
 
2015
            (('r2', ), 'N0 100', ([('r1', ), ('r0', )], )),
 
2016
            ])
 
2017
        combined_index = CombinedGraphIndex([index1, index2])
 
2018
        index = KnitGraphIndex(combined_index)
 
2019
        # XXX TODO a ghost
 
2020
        # cases: each sample data individually:
 
2021
        self.assertEqual(set([('r0', ())]),
 
2022
            set(index.iter_parents(['r0'])))
 
2023
        self.assertEqual(set([('r1', ('r0', ))]),
 
2024
            set(index.iter_parents(['r1'])))
 
2025
        self.assertEqual(set([('r2', ('r1', 'r0'))]),
 
2026
            set(index.iter_parents(['r2'])))
 
2027
        # no nodes returned for a missing node
 
2028
        self.assertEqual(set(),
 
2029
            set(index.iter_parents(['missing'])))
 
2030
        # 1 node returned with missing nodes skipped
 
2031
        self.assertEqual(set([('r1', ('r0', ))]),
 
2032
            set(index.iter_parents(['ghost1', 'r1', 'ghost'])))
 
2033
        # 2 nodes returned
 
2034
        self.assertEqual(set([('r0', ()), ('r1', ('r0', ))]),
 
2035
            set(index.iter_parents(['r0', 'r1'])))
 
2036
        # 2 nodes returned, missing skipped
 
2037
        self.assertEqual(set([('r0', ()), ('r1', ('r0', ))]),
 
2038
            set(index.iter_parents(['a', 'r0', 'b', 'r1', 'c'])))
1891
2039
 
1892
2040
 
1893
2041
class TestNoParentsGraphIndexKnit(KnitTests):
1894
 
    """Tests for knits using _KnitGraphIndex with no parents."""
 
2042
    """Tests for knits using KnitGraphIndex with no parents."""
1895
2043
 
1896
2044
    def make_g_index(self, name, ref_lists=0, nodes=[]):
1897
2045
        builder = GraphIndexBuilder(ref_lists)
1899
2047
            builder.add_node(node, references)
1900
2048
        stream = builder.finish()
1901
2049
        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())
 
2050
        trans.put_file(name, stream)
 
2051
        return GraphIndex(trans, name)
1912
2052
 
1913
2053
    def test_parents_deltas_incompatible(self):
1914
2054
        index = CombinedGraphIndex([])
1915
 
        self.assertRaises(errors.KnitError, _KnitGraphIndex, lambda:True,
1916
 
            index, deltas=True, parents=False)
 
2055
        self.assertRaises(errors.KnitError, KnitGraphIndex, index,
 
2056
            deltas=True, parents=False)
1917
2057
 
1918
2058
    def two_graph_index(self, catch_adds=False):
1919
2059
        """Build a two-graph index.
1935
2075
            add_callback = self.catch_add
1936
2076
        else:
1937
2077
            add_callback = None
1938
 
        return _KnitGraphIndex(combined_index, lambda:True, parents=False,
 
2078
        return KnitGraphIndex(combined_index, parents=False,
1939
2079
            add_callback=add_callback)
1940
2080
 
1941
 
    def test_keys(self):
1942
 
        index = self.two_graph_index()
1943
 
        self.assertEqual(set([('tail',), ('tip',), ('parent',), ('separate',)]),
1944
 
            set(index.keys()))
 
2081
    def test_get_graph(self):
 
2082
        index = self.two_graph_index()
 
2083
        self.assertEqual(set([
 
2084
            ('tip', ()),
 
2085
            ('tail', ()),
 
2086
            ('parent', ()),
 
2087
            ('separate', ()),
 
2088
            ]), set(index.get_graph()))
 
2089
 
 
2090
    def test_get_ancestry(self):
 
2091
        # with no parents, ancestry is always just the key.
 
2092
        index = self.two_graph_index()
 
2093
        self.assertEqual([], index.get_ancestry([]))
 
2094
        self.assertEqual(['separate'], index.get_ancestry(['separate']))
 
2095
        self.assertEqual(['tail'], index.get_ancestry(['tail']))
 
2096
        self.assertEqual(['parent'], index.get_ancestry(['parent']))
 
2097
        self.assertEqual(['tip'], index.get_ancestry(['tip']))
 
2098
        self.assertTrue(index.get_ancestry(['tip', 'separate']) in
 
2099
            (['tip', 'separate'],
 
2100
             ['separate', 'tip'],
 
2101
            ))
 
2102
        # asking for a ghost makes it go boom.
 
2103
        self.assertRaises(errors.RevisionNotPresent, index.get_ancestry, ['ghost'])
 
2104
 
 
2105
    def test_get_ancestry_with_ghosts(self):
 
2106
        index = self.two_graph_index()
 
2107
        self.assertEqual([], index.get_ancestry_with_ghosts([]))
 
2108
        self.assertEqual(['separate'], index.get_ancestry_with_ghosts(['separate']))
 
2109
        self.assertEqual(['tail'], index.get_ancestry_with_ghosts(['tail']))
 
2110
        self.assertEqual(['parent'], index.get_ancestry_with_ghosts(['parent']))
 
2111
        self.assertEqual(['tip'], index.get_ancestry_with_ghosts(['tip']))
 
2112
        self.assertTrue(index.get_ancestry_with_ghosts(['tip', 'separate']) in
 
2113
            (['tip', 'separate'],
 
2114
             ['separate', 'tip'],
 
2115
            ))
 
2116
        # asking for a ghost makes it go boom.
 
2117
        self.assertRaises(errors.RevisionNotPresent, index.get_ancestry_with_ghosts, ['ghost'])
 
2118
 
 
2119
    def test_num_versions(self):
 
2120
        index = self.two_graph_index()
 
2121
        self.assertEqual(4, index.num_versions())
 
2122
 
 
2123
    def test_get_versions(self):
 
2124
        index = self.two_graph_index()
 
2125
        self.assertEqual(set(['tail', 'tip', 'parent', 'separate']),
 
2126
            set(index.get_versions()))
 
2127
 
 
2128
    def test_has_version(self):
 
2129
        index = self.two_graph_index()
 
2130
        self.assertTrue(index.has_version('tail'))
 
2131
        self.assertFalse(index.has_version('ghost'))
1945
2132
 
1946
2133
    def test_get_position(self):
1947
2134
        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',)))
 
2135
        self.assertEqual((index._graph_index._indices[0], 0, 100), index.get_position('tip'))
 
2136
        self.assertEqual((index._graph_index._indices[1], 100, 78), index.get_position('parent'))
1952
2137
 
1953
2138
    def test_get_method(self):
1954
2139
        index = self.two_graph_index()
1955
 
        self.assertEqual('fulltext', index.get_method(('tip',)))
1956
 
        self.assertEqual(['fulltext'], index.get_options(('parent',)))
 
2140
        self.assertEqual('fulltext', index.get_method('tip'))
 
2141
        self.assertEqual(['fulltext'], index.get_options('parent'))
1957
2142
 
1958
2143
    def test_get_options(self):
1959
2144
        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',)]))
 
2145
        self.assertEqual(['fulltext', 'no-eol'], index.get_options('tip'))
 
2146
        self.assertEqual(['fulltext'], index.get_options('parent'))
 
2147
 
 
2148
    def test_get_parents(self):
 
2149
        index = self.two_graph_index()
 
2150
        self.assertEqual((), index.get_parents('parent'))
 
2151
        # and errors on ghosts.
 
2152
        self.assertRaises(errors.RevisionNotPresent,
 
2153
            index.get_parents, 'ghost')
 
2154
 
 
2155
    def test_get_parents_with_ghosts(self):
 
2156
        index = self.two_graph_index()
 
2157
        self.assertEqual((), index.get_parents_with_ghosts('parent'))
 
2158
        # and errors on ghosts.
 
2159
        self.assertRaises(errors.RevisionNotPresent,
 
2160
            index.get_parents_with_ghosts, 'ghost')
 
2161
 
 
2162
    def test_check_versions_present(self):
 
2163
        index = self.two_graph_index()
 
2164
        self.assertRaises(RevisionNotPresent, index.check_versions_present,
 
2165
            ['missing'])
 
2166
        self.assertRaises(RevisionNotPresent, index.check_versions_present,
 
2167
            ['tail', 'missing'])
 
2168
        index.check_versions_present(['tail', 'separate'])
1967
2169
 
1968
2170
    def catch_add(self, entries):
1969
2171
        self.caught_entries.append(entries)
1970
2172
 
1971
2173
    def test_add_no_callback_errors(self):
1972
2174
        index = self.two_graph_index()
1973
 
        self.assertRaises(errors.ReadOnlyError, index.add_records,
1974
 
            [(('new',), 'fulltext,no-eol', (None, 50, 60), [('separate',)])])
 
2175
        self.assertRaises(errors.ReadOnlyError, index.add_version,
 
2176
            'new', 'fulltext,no-eol', (None, 50, 60), ['separate'])
1975
2177
 
1976
2178
    def test_add_version_smoke(self):
1977
2179
        index = self.two_graph_index(catch_adds=True)
1978
 
        index.add_records([(('new',), 'fulltext,no-eol', (None, 50, 60), [])])
 
2180
        index.add_version('new', 'fulltext,no-eol', (None, 50, 60), [])
1979
2181
        self.assertEqual([[(('new', ), 'N50 60')]],
1980
2182
            self.caught_entries)
1981
2183
 
1982
2184
    def test_add_version_delta_not_delta_index(self):
1983
2185
        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), [])])
 
2186
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
2187
            'new', 'no-eol,line-delta', (None, 0, 100), [])
1986
2188
        self.assertEqual([], self.caught_entries)
1987
2189
 
1988
2190
    def test_add_version_same_dup(self):
1989
2191
        index = self.two_graph_index(catch_adds=True)
1990
2192
        # 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), [])])
 
2193
        index.add_version('tip', 'fulltext,no-eol', (None, 0, 100), [])
 
2194
        index.add_version('tip', 'no-eol,fulltext', (None, 0, 100), [])
1997
2195
        # but neither should have added data.
1998
 
        self.assertEqual([[], [], [], []], self.caught_entries)
1999
 
 
 
2196
        self.assertEqual([[], []], self.caught_entries)
 
2197
        
2000
2198
    def test_add_version_different_dup(self):
2001
2199
        index = self.two_graph_index(catch_adds=True)
2002
2200
        # 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), [])])
 
2201
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
2202
            'tip', 'no-eol,line-delta', (None, 0, 100), [])
 
2203
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
2204
            'tip', 'line-delta,no-eol', (None, 0, 100), [])
 
2205
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
2206
            'tip', 'fulltext', (None, 0, 100), [])
 
2207
        # position/length
 
2208
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
2209
            'tip', 'fulltext,no-eol', (None, 50, 100), [])
 
2210
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
2211
            'tip', 'fulltext,no-eol', (None, 0, 1000), [])
2009
2212
        # parents
2010
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
2011
 
            [(('tip',), 'fulltext,no-eol', (None, 0, 100), [('parent',)])])
 
2213
        self.assertRaises(errors.KnitCorrupt, index.add_version,
 
2214
            'tip', 'fulltext,no-eol', (None, 0, 100), ['parent'])
2012
2215
        self.assertEqual([], self.caught_entries)
2013
 
 
 
2216
        
2014
2217
    def test_add_versions(self):
2015
2218
        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), []),
 
2219
        index.add_versions([
 
2220
                ('new', 'fulltext,no-eol', (None, 50, 60), []),
 
2221
                ('new2', 'fulltext', (None, 0, 6), []),
2019
2222
                ])
2020
2223
        self.assertEqual([(('new', ), 'N50 60'), (('new2', ), ' 0 6')],
2021
2224
            sorted(self.caught_entries[0]))
2023
2226
 
2024
2227
    def test_add_versions_delta_not_delta_index(self):
2025
2228
        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',)])])
 
2229
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2230
            [('new', 'no-eol,line-delta', (None, 0, 100), ['parent'])])
2028
2231
        self.assertEqual([], self.caught_entries)
2029
2232
 
2030
2233
    def test_add_versions_parents_not_parents_index(self):
2031
2234
        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',)])])
 
2235
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2236
            [('new', 'no-eol,fulltext', (None, 0, 100), ['parent'])])
2034
2237
        self.assertEqual([], self.caught_entries)
2035
2238
 
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
2239
    def test_add_versions_same_dup(self):
2041
2240
        index = self.two_graph_index(catch_adds=True)
2042
2241
        # 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), [])])
 
2242
        index.add_versions([('tip', 'fulltext,no-eol', (None, 0, 100), [])])
 
2243
        index.add_versions([('tip', 'no-eol,fulltext', (None, 0, 100), [])])
2049
2244
        # but neither should have added data.
2050
 
        self.assertEqual([[], [], [], []], self.caught_entries)
2051
 
 
 
2245
        self.assertEqual([[], []], self.caught_entries)
 
2246
        
2052
2247
    def test_add_versions_different_dup(self):
2053
2248
        index = self.two_graph_index(catch_adds=True)
2054
2249
        # 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), [])])
 
2250
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2251
            [('tip', 'no-eol,line-delta', (None, 0, 100), [])])
 
2252
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2253
            [('tip', 'line-delta,no-eol', (None, 0, 100), [])])
 
2254
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2255
            [('tip', 'fulltext', (None, 0, 100), [])])
 
2256
        # position/length
 
2257
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2258
            [('tip', 'fulltext,no-eol', (None, 50, 100), [])])
 
2259
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2260
            [('tip', 'fulltext,no-eol', (None, 0, 1000), [])])
2061
2261
        # parents
2062
 
        self.assertRaises(errors.KnitCorrupt, index.add_records,
2063
 
            [(('tip',), 'fulltext,no-eol', (None, 0, 100), [('parent',)])])
 
2262
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2263
            [('tip', 'fulltext,no-eol', (None, 0, 100), ['parent'])])
2064
2264
        # 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), [])])
 
2265
        self.assertRaises(errors.KnitCorrupt, index.add_versions,
 
2266
            [('tip', 'fulltext,no-eol', (None, 0, 100), []),
 
2267
             ('tip', 'no-eol,line-delta', (None, 0, 100), [])])
2068
2268
        self.assertEqual([], self.caught_entries)
2069
2269
 
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)
 
2270
    def test_iter_parents(self):
 
2271
        index = self.two_graph_index()
 
2272
        self.assertEqual(set([
 
2273
            ('tip', ()), ('tail', ()), ('parent', ()), ('separate', ())
 
2274
            ]),
 
2275
            set(index.iter_parents(['tip', 'tail', 'ghost', 'parent', 'separate'])))
 
2276
        self.assertEqual(set([('tip', ())]),
 
2277
            set(index.iter_parents(['tip'])))
 
2278
        self.assertEqual(set(),
 
2279
            set(index.iter_parents([])))