← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_btree_index.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-10-05 15:41:35 UTC
  • mfrom: (4725.2.1 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20091005154135-k407ea8ssyhayv10
(vila) Disambiguate per_transport test IDs

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_btree_index.py
1
 
# Copyright (C) 2008-2011 Canonical Ltd
 
1
# Copyright (C) 2008, 2009 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
23
23
from bzrlib import (
24
24
    btree_index,
25
25
    errors,
26
 
    fifo_cache,
27
 
    lru_cache,
28
26
    osutils,
29
27
    tests,
30
 
    transport,
31
28
    )
32
29
from bzrlib.tests import (
33
30
    TestCaseWithTransport,
34
 
    scenarios,
35
 
    )
36
 
from bzrlib.tests import (
37
 
    features,
38
 
    )
39
 
 
40
 
 
41
 
load_tests = scenarios.load_tests_apply_scenarios
42
 
 
43
 
 
44
 
def btreeparser_scenarios():
 
31
    condition_isinstance,
 
32
    multiply_tests,
 
33
    split_suite_by_condition,
 
34
    )
 
35
from bzrlib.transport import get_transport
 
36
 
 
37
 
 
38
def load_tests(standard_tests, module, loader):
 
39
    # parameterise the TestBTreeNodes tests
 
40
    node_tests, others = split_suite_by_condition(standard_tests,
 
41
        condition_isinstance(TestBTreeNodes))
45
42
    import bzrlib._btree_serializer_py as py_module
46
43
    scenarios = [('python', {'parse_btree': py_module})]
47
 
    if compiled_btreeparser_feature.available():
48
 
        scenarios.append(('C', 
49
 
            {'parse_btree': compiled_btreeparser_feature.module}))
50
 
    return scenarios
51
 
 
52
 
 
53
 
compiled_btreeparser_feature = features.ModuleAvailableFeature(
54
 
    'bzrlib._btree_serializer_pyx')
 
44
    if CompiledBtreeParserFeature.available():
 
45
        # Is there a way to do this that gets missing feature failures rather
 
46
        # than no indication to the user?
 
47
        import bzrlib._btree_serializer_pyx as c_module
 
48
        scenarios.append(('C', {'parse_btree': c_module}))
 
49
    return multiply_tests(node_tests, scenarios, others)
 
50
 
 
51
 
 
52
class _CompiledBtreeParserFeature(tests.Feature):
 
53
    def _probe(self):
 
54
        try:
 
55
            import bzrlib._btree_serializer_pyx
 
56
        except ImportError:
 
57
            return False
 
58
        return True
 
59
 
 
60
    def feature_name(self):
 
61
        return 'bzrlib._btree_serializer_pyx'
 
62
 
 
63
CompiledBtreeParserFeature = _CompiledBtreeParserFeature()
55
64
 
56
65
 
57
66
class BTreeTestCase(TestCaseWithTransport):
60
69
 
61
70
    def setUp(self):
62
71
        TestCaseWithTransport.setUp(self)
63
 
        self.overrideAttr(btree_index, '_RESERVED_HEADER_BYTES', 100)
 
72
        self._original_header = btree_index._RESERVED_HEADER_BYTES
 
73
        def restore():
 
74
            btree_index._RESERVED_HEADER_BYTES = self._original_header
 
75
        self.addCleanup(restore)
 
76
        btree_index._RESERVED_HEADER_BYTES = 100
64
77
 
65
78
    def make_nodes(self, count, key_elements, reference_lists):
66
79
        """Generate count*key_elements sample nodes."""
100
113
 
101
114
    def shrink_page_size(self):
102
115
        """Shrink the default page size so that less fits in a page."""
103
 
        self.overrideAttr(btree_index, '_PAGE_SIZE')
 
116
        old_page_size = btree_index._PAGE_SIZE
 
117
        def cleanup():
 
118
            btree_index._PAGE_SIZE = old_page_size
 
119
        self.addCleanup(cleanup)
104
120
        btree_index._PAGE_SIZE = 2048
105
121
 
106
122
 
107
123
class TestBTreeBuilder(BTreeTestCase):
108
124
 
109
 
    def test_clear_cache(self):
110
 
        builder = btree_index.BTreeBuilder(reference_lists=0, key_elements=1)
111
 
        # This is a no-op, but we need the api to be consistent with other
112
 
        # BTreeGraphIndex apis.
113
 
        builder.clear_cache()
114
 
 
115
125
    def test_empty_1_0(self):
116
126
        builder = btree_index.BTreeBuilder(key_elements=1, reference_lists=0)
117
127
        # NamedTemporaryFile dies on builder.finish().read(). weird.
143
153
        temp_file = builder.finish()
144
154
        content = temp_file.read()
145
155
        del temp_file
146
 
        self.assertEqual(131, len(content))
 
156
        self.assertEqual(158, len(content))
147
157
        self.assertEqual(
148
158
            "B+Tree Graph Index 2\nnode_ref_lists=0\nkey_elements=1\nlen=5\n"
149
159
            "row_lengths=1\n",
167
177
        temp_file = builder.finish()
168
178
        content = temp_file.read()
169
179
        del temp_file
170
 
        self.assertEqual(238, len(content))
 
180
        self.assertEqual(264, len(content))
171
181
        self.assertEqual(
172
182
            "B+Tree Graph Index 2\nnode_ref_lists=2\nkey_elements=2\nlen=10\n"
173
183
            "row_lengths=1\n",
217
227
        leaf1_bytes = zlib.decompress(leaf1)
218
228
        sorted_node_keys = sorted(node[0] for node in nodes)
219
229
        node = btree_index._LeafNode(leaf1_bytes, 1, 0)
220
 
        self.assertEqual(231, len(node))
221
 
        self.assertEqual(sorted_node_keys[:231], node.all_keys())
 
230
        self.assertEqual(231, len(node.keys))
 
231
        self.assertEqual(sorted_node_keys[:231], sorted(node.keys))
222
232
        leaf2_bytes = zlib.decompress(leaf2)
223
233
        node = btree_index._LeafNode(leaf2_bytes, 1, 0)
224
 
        self.assertEqual(400 - 231, len(node))
225
 
        self.assertEqual(sorted_node_keys[231:], node.all_keys())
 
234
        self.assertEqual(400 - 231, len(node.keys))
 
235
        self.assertEqual(sorted_node_keys[231:], sorted(node.keys))
226
236
 
227
237
    def test_last_page_rounded_1_layer(self):
228
238
        builder = btree_index.BTreeBuilder(key_elements=1, reference_lists=0)
233
243
        temp_file = builder.finish()
234
244
        content = temp_file.read()
235
245
        del temp_file
236
 
        self.assertEqual(155, len(content))
 
246
        self.assertEqual(181, len(content))
237
247
        self.assertEqual(
238
248
            "B+Tree Graph Index 2\nnode_ref_lists=0\nkey_elements=1\nlen=10\n"
239
249
            "row_lengths=1\n",
242
252
        leaf2 = content[74:]
243
253
        leaf2_bytes = zlib.decompress(leaf2)
244
254
        node = btree_index._LeafNode(leaf2_bytes, 1, 0)
245
 
        self.assertEqual(10, len(node))
 
255
        self.assertEqual(10, len(node.keys))
246
256
        sorted_node_keys = sorted(node[0] for node in nodes)
247
 
        self.assertEqual(sorted_node_keys, node.all_keys())
 
257
        self.assertEqual(sorted_node_keys, sorted(node.keys))
248
258
 
249
259
    def test_last_page_not_rounded_2_layer(self):
250
260
        builder = btree_index.BTreeBuilder(key_elements=1, reference_lists=0)
264
274
        leaf2 = content[8192:]
265
275
        leaf2_bytes = zlib.decompress(leaf2)
266
276
        node = btree_index._LeafNode(leaf2_bytes, 1, 0)
267
 
        self.assertEqual(400 - 231, len(node))
 
277
        self.assertEqual(400 - 231, len(node.keys))
268
278
        sorted_node_keys = sorted(node[0] for node in nodes)
269
 
        self.assertEqual(sorted_node_keys[231:], node.all_keys())
 
279
        self.assertEqual(sorted_node_keys[231:], sorted(node.keys))
270
280
 
271
281
    def test_three_level_tree_details(self):
272
282
        # The left most pointer in the second internal node in a row should
281
291
 
282
292
        for node in nodes:
283
293
            builder.add_node(*node)
284
 
        t = transport.get_transport('trace+' + self.get_url(''))
285
 
        size = t.put_file('index', self.time(builder.finish))
 
294
        transport = get_transport('trace+' + self.get_url(''))
 
295
        size = transport.put_file('index', self.time(builder.finish))
286
296
        del builder
287
 
        index = btree_index.BTreeGraphIndex(t, 'index', size)
 
297
        index = btree_index.BTreeGraphIndex(transport, 'index', size)
288
298
        # Seed the metadata, we're using internal calls now.
289
299
        index.key_count()
290
300
        self.assertEqual(3, len(index._row_lengths),
303
313
        # in the second node it points at
304
314
        pos = index._row_offsets[2] + internal_node2.offset + 1
305
315
        leaf = index._get_leaf_nodes([pos])[pos]
306
 
        self.assertTrue(internal_node2.keys[0] in leaf)
 
316
        self.assertTrue(internal_node2.keys[0] in leaf.keys)
307
317
 
308
318
    def test_2_leaves_2_2(self):
309
319
        builder = btree_index.BTreeBuilder(key_elements=2, reference_lists=2)
341
351
        # Test the parts of the index that take up memory are doing so
342
352
        # predictably.
343
353
        self.assertEqual(1, len(builder._nodes))
 
354
        self.assertEqual(1, len(builder._keys))
344
355
        self.assertIs(None, builder._nodes_by_key)
345
356
        builder.add_node(*nodes[1])
346
357
        self.assertEqual(0, len(builder._nodes))
 
358
        self.assertEqual(0, len(builder._keys))
347
359
        self.assertIs(None, builder._nodes_by_key)
348
360
        self.assertEqual(1, len(builder._backing_indices))
349
361
        self.assertEqual(2, builder._backing_indices[0].key_count())
350
362
        # now back to memory
351
363
        builder.add_node(*nodes[2])
352
364
        self.assertEqual(1, len(builder._nodes))
 
365
        self.assertEqual(1, len(builder._keys))
353
366
        self.assertIs(None, builder._nodes_by_key)
354
367
        # And spills to a second backing index combing all
355
368
        builder.add_node(*nodes[3])
356
369
        self.assertEqual(0, len(builder._nodes))
 
370
        self.assertEqual(0, len(builder._keys))
357
371
        self.assertIs(None, builder._nodes_by_key)
358
372
        self.assertEqual(2, len(builder._backing_indices))
359
373
        self.assertEqual(None, builder._backing_indices[0])
362
376
        builder.add_node(*nodes[4])
363
377
        builder.add_node(*nodes[5])
364
378
        self.assertEqual(0, len(builder._nodes))
 
379
        self.assertEqual(0, len(builder._keys))
365
380
        self.assertIs(None, builder._nodes_by_key)
366
381
        self.assertEqual(2, len(builder._backing_indices))
367
382
        self.assertEqual(2, builder._backing_indices[0].key_count())
410
425
        self.assertEqual(None, builder._backing_indices[2])
411
426
        self.assertEqual(16, builder._backing_indices[3].key_count())
412
427
        # Now finish, and check we got a correctly ordered tree
413
 
        t = self.get_transport('')
414
 
        size = t.put_file('index', builder.finish())
415
 
        index = btree_index.BTreeGraphIndex(t, 'index', size)
 
428
        transport = self.get_transport('')
 
429
        size = transport.put_file('index', builder.finish())
 
430
        index = btree_index.BTreeGraphIndex(transport, 'index', size)
416
431
        nodes = list(index.iter_all_entries())
417
432
        self.assertEqual(sorted(nodes), nodes)
418
433
        self.assertEqual(16, len(nodes))
425
440
        # Test the parts of the index that take up memory are doing so
426
441
        # predictably.
427
442
        self.assertEqual(1, len(builder._nodes))
 
443
        self.assertEqual(1, len(builder._keys))
428
444
        self.assertIs(None, builder._nodes_by_key)
429
445
        builder.add_node(*nodes[1])
430
446
        self.assertEqual(0, len(builder._nodes))
 
447
        self.assertEqual(0, len(builder._keys))
431
448
        self.assertIs(None, builder._nodes_by_key)
432
449
        self.assertEqual(1, len(builder._backing_indices))
433
450
        self.assertEqual(2, builder._backing_indices[0].key_count())
434
451
        # now back to memory
435
452
        builder.add_node(*nodes[2])
436
453
        self.assertEqual(1, len(builder._nodes))
 
454
        self.assertEqual(1, len(builder._keys))
437
455
        self.assertIs(None, builder._nodes_by_key)
438
456
        # And spills to a second backing index but doesn't combine
439
457
        builder.add_node(*nodes[3])
440
458
        self.assertEqual(0, len(builder._nodes))
 
459
        self.assertEqual(0, len(builder._keys))
441
460
        self.assertIs(None, builder._nodes_by_key)
442
461
        self.assertEqual(2, len(builder._backing_indices))
443
462
        for backing_index in builder._backing_indices:
446
465
        builder.add_node(*nodes[4])
447
466
        builder.add_node(*nodes[5])
448
467
        self.assertEqual(0, len(builder._nodes))
 
468
        self.assertEqual(0, len(builder._keys))
449
469
        self.assertIs(None, builder._nodes_by_key)
450
470
        self.assertEqual(3, len(builder._backing_indices))
451
471
        for backing_index in builder._backing_indices:
510
530
        builder.add_node(*nodes[0])
511
531
        # Test the parts of the index that take up memory are doing so
512
532
        # predictably.
 
533
        self.assertEqual(1, len(builder._keys))
513
534
        self.assertEqual(1, len(builder._nodes))
514
535
        self.assertIs(None, builder._nodes_by_key)
515
536
        builder.add_node(*nodes[1])
 
537
        self.assertEqual(0, len(builder._keys))
516
538
        self.assertEqual(0, len(builder._nodes))
517
539
        self.assertIs(None, builder._nodes_by_key)
518
540
        self.assertEqual(1, len(builder._backing_indices))
521
543
        old = dict(builder._get_nodes_by_key()) #Build up the nodes by key dict
522
544
        builder.add_node(*nodes[2])
523
545
        self.assertEqual(1, len(builder._nodes))
 
546
        self.assertEqual(1, len(builder._keys))
524
547
        self.assertIsNot(None, builder._nodes_by_key)
525
548
        self.assertNotEqual({}, builder._nodes_by_key)
526
549
        # We should have a new entry
528
551
        # And spills to a second backing index combing all
529
552
        builder.add_node(*nodes[3])
530
553
        self.assertEqual(0, len(builder._nodes))
 
554
        self.assertEqual(0, len(builder._keys))
531
555
        self.assertIs(None, builder._nodes_by_key)
532
556
        self.assertEqual(2, len(builder._backing_indices))
533
557
        self.assertEqual(None, builder._backing_indices[0])
536
560
        builder.add_node(*nodes[4])
537
561
        builder.add_node(*nodes[5])
538
562
        self.assertEqual(0, len(builder._nodes))
 
563
        self.assertEqual(0, len(builder._keys))
539
564
        self.assertIs(None, builder._nodes_by_key)
540
565
        self.assertEqual(2, len(builder._backing_indices))
541
566
        self.assertEqual(2, builder._backing_indices[0].key_count())
608
633
        for key, value, references in nodes:
609
634
            builder.add_node(key, value, references)
610
635
        stream = builder.finish()
611
 
        trans = transport.get_transport('trace+' + self.get_url())
 
636
        trans = get_transport('trace+' + self.get_url())
612
637
        size = trans.put_file('index', stream)
613
638
        return btree_index.BTreeGraphIndex(trans, 'index', size)
614
639
 
615
 
    def make_index_with_offset(self, ref_lists=1, key_elements=1, nodes=[],
616
 
                               offset=0):
617
 
        builder = btree_index.BTreeBuilder(key_elements=key_elements,
618
 
                                           reference_lists=ref_lists)
619
 
        builder.add_nodes(nodes)
620
 
        transport = self.get_transport('')
621
 
        # NamedTemporaryFile dies on builder.finish().read(). weird.
622
 
        temp_file = builder.finish()
623
 
        content = temp_file.read()
624
 
        del temp_file
625
 
        size = len(content)
626
 
        transport.put_bytes('index', (' '*offset)+content)
627
 
        return btree_index.BTreeGraphIndex(transport, 'index', size=size,
628
 
                                           offset=offset)
629
 
 
630
 
    def test_clear_cache(self):
631
 
        nodes = self.make_nodes(160, 2, 2)
632
 
        index = self.make_index(ref_lists=2, key_elements=2, nodes=nodes)
633
 
        self.assertEqual(1, len(list(index.iter_entries([nodes[30][0]]))))
634
 
        self.assertEqual([1, 4], index._row_lengths)
635
 
        self.assertIsNot(None, index._root_node)
636
 
        internal_node_pre_clear = index._internal_node_cache.keys()
637
 
        self.assertTrue(len(index._leaf_node_cache) > 0)
638
 
        index.clear_cache()
639
 
        # We don't touch _root_node or _internal_node_cache, both should be
640
 
        # small, and can save a round trip or two
641
 
        self.assertIsNot(None, index._root_node)
642
 
        # NOTE: We don't want to affect the _internal_node_cache, as we expect
643
 
        #       it will be small, and if we ever do touch this index again, it
644
 
        #       will save round-trips.  This assertion isn't very strong,
645
 
        #       becuase without a 3-level index, we don't have any internal
646
 
        #       nodes cached.
647
 
        self.assertEqual(internal_node_pre_clear,
648
 
                         index._internal_node_cache.keys())
649
 
        self.assertEqual(0, len(index._leaf_node_cache))
650
 
 
651
640
    def test_trivial_constructor(self):
652
 
        t = transport.get_transport('trace+' + self.get_url(''))
653
 
        index = btree_index.BTreeGraphIndex(t, 'index', None)
 
641
        transport = get_transport('trace+' + self.get_url(''))
 
642
        index = btree_index.BTreeGraphIndex(transport, 'index', None)
654
643
        # Checks the page size at load, but that isn't logged yet.
655
 
        self.assertEqual([], t._activity)
 
644
        self.assertEqual([], transport._activity)
656
645
 
657
646
    def test_with_size_constructor(self):
658
 
        t = transport.get_transport('trace+' + self.get_url(''))
659
 
        index = btree_index.BTreeGraphIndex(t, 'index', 1)
 
647
        transport = get_transport('trace+' + self.get_url(''))
 
648
        index = btree_index.BTreeGraphIndex(transport, 'index', 1)
660
649
        # Checks the page size at load, but that isn't logged yet.
661
 
        self.assertEqual([], t._activity)
 
650
        self.assertEqual([], transport._activity)
662
651
 
663
652
    def test_empty_key_count_no_size(self):
664
653
        builder = btree_index.BTreeBuilder(key_elements=1, reference_lists=0)
665
 
        t = transport.get_transport('trace+' + self.get_url(''))
666
 
        t.put_file('index', builder.finish())
667
 
        index = btree_index.BTreeGraphIndex(t, 'index', None)
668
 
        del t._activity[:]
669
 
        self.assertEqual([], t._activity)
 
654
        transport = get_transport('trace+' + self.get_url(''))
 
655
        transport.put_file('index', builder.finish())
 
656
        index = btree_index.BTreeGraphIndex(transport, 'index', None)
 
657
        del transport._activity[:]
 
658
        self.assertEqual([], transport._activity)
670
659
        self.assertEqual(0, index.key_count())
671
660
        # The entire index should have been requested (as we generally have the
672
661
        # size available, and doing many small readvs is inappropriate).
673
662
        # We can't tell how much was actually read here, but - check the code.
674
 
        self.assertEqual([('get', 'index')], t._activity)
 
663
        self.assertEqual([('get', 'index')], transport._activity)
675
664
 
676
665
    def test_empty_key_count(self):
677
666
        builder = btree_index.BTreeBuilder(key_elements=1, reference_lists=0)
678
 
        t = transport.get_transport('trace+' + self.get_url(''))
679
 
        size = t.put_file('index', builder.finish())
 
667
        transport = get_transport('trace+' + self.get_url(''))
 
668
        size = transport.put_file('index', builder.finish())
680
669
        self.assertEqual(72, size)
681
 
        index = btree_index.BTreeGraphIndex(t, 'index', size)
682
 
        del t._activity[:]
683
 
        self.assertEqual([], t._activity)
 
670
        index = btree_index.BTreeGraphIndex(transport, 'index', size)
 
671
        del transport._activity[:]
 
672
        self.assertEqual([], transport._activity)
684
673
        self.assertEqual(0, index.key_count())
685
674
        # The entire index should have been read, as 4K > size
686
675
        self.assertEqual([('readv', 'index', [(0, 72)], False, None)],
687
 
                         t._activity)
 
676
            transport._activity)
688
677
 
689
678
    def test_non_empty_key_count_2_2(self):
690
679
        builder = btree_index.BTreeBuilder(key_elements=2, reference_lists=2)
691
680
        nodes = self.make_nodes(35, 2, 2)
692
681
        for node in nodes:
693
682
            builder.add_node(*node)
694
 
        t = transport.get_transport('trace+' + self.get_url(''))
695
 
        size = t.put_file('index', builder.finish())
696
 
        index = btree_index.BTreeGraphIndex(t, 'index', size)
697
 
        del t._activity[:]
698
 
        self.assertEqual([], t._activity)
 
683
        transport = get_transport('trace+' + self.get_url(''))
 
684
        size = transport.put_file('index', builder.finish())
 
685
        index = btree_index.BTreeGraphIndex(transport, 'index', size)
 
686
        del transport._activity[:]
 
687
        self.assertEqual([], transport._activity)
699
688
        self.assertEqual(70, index.key_count())
700
689
        # The entire index should have been read, as it is one page long.
701
690
        self.assertEqual([('readv', 'index', [(0, size)], False, None)],
702
 
            t._activity)
703
 
        self.assertEqual(1173, size)
704
 
 
705
 
    def test_with_offset_no_size(self):
706
 
        index = self.make_index_with_offset(key_elements=1, ref_lists=1,
707
 
                                            offset=1234,
708
 
                                            nodes=self.make_nodes(200, 1, 1))
709
 
        index._size = None # throw away the size info
710
 
        self.assertEqual(200, index.key_count())
711
 
 
712
 
    def test_with_small_offset(self):
713
 
        index = self.make_index_with_offset(key_elements=1, ref_lists=1,
714
 
                                            offset=1234,
715
 
                                            nodes=self.make_nodes(200, 1, 1))
716
 
        self.assertEqual(200, index.key_count())
717
 
 
718
 
    def test_with_large_offset(self):
719
 
        index = self.make_index_with_offset(key_elements=1, ref_lists=1,
720
 
                                            offset=123456,
721
 
                                            nodes=self.make_nodes(200, 1, 1))
722
 
        self.assertEqual(200, index.key_count())
 
691
            transport._activity)
 
692
        self.assertEqual(1199, size)
723
693
 
724
694
    def test__read_nodes_no_size_one_page_reads_once(self):
725
695
        self.make_index(nodes=[(('key',), 'value', ())])
726
 
        trans = transport.get_transport('trace+' + self.get_url())
 
696
        trans = get_transport('trace+' + self.get_url())
727
697
        index = btree_index.BTreeGraphIndex(trans, 'index', None)
728
698
        del trans._activity[:]
729
699
        nodes = dict(index._read_nodes([0]))
730
700
        self.assertEqual([0], nodes.keys())
731
701
        node = nodes[0]
732
 
        self.assertEqual([('key',)], node.all_keys())
 
702
        self.assertEqual([('key',)], node.keys.keys())
733
703
        self.assertEqual([('get', 'index')], trans._activity)
734
704
 
735
705
    def test__read_nodes_no_size_multiple_pages(self):
737
707
        index.key_count()
738
708
        num_pages = index._row_offsets[-1]
739
709
        # Reopen with a traced transport and no size
740
 
        trans = transport.get_transport('trace+' + self.get_url())
 
710
        trans = get_transport('trace+' + self.get_url())
741
711
        index = btree_index.BTreeGraphIndex(trans, 'index', None)
742
712
        del trans._activity[:]
743
713
        nodes = dict(index._read_nodes([0]))
748
718
        nodes = self.make_nodes(160, 2, 2)
749
719
        for node in nodes:
750
720
            builder.add_node(*node)
751
 
        t = transport.get_transport('trace+' + self.get_url(''))
752
 
        size = t.put_file('index', builder.finish())
 
721
        transport = get_transport('trace+' + self.get_url(''))
 
722
        size = transport.put_file('index', builder.finish())
753
723
        self.assertEqual(17692, size)
754
 
        index = btree_index.BTreeGraphIndex(t, 'index', size)
755
 
        del t._activity[:]
756
 
        self.assertEqual([], t._activity)
 
724
        index = btree_index.BTreeGraphIndex(transport, 'index', size)
 
725
        del transport._activity[:]
 
726
        self.assertEqual([], transport._activity)
757
727
        self.assertEqual(320, index.key_count())
758
728
        # The entire index should not have been read.
759
729
        self.assertEqual([('readv', 'index', [(0, 4096)], False, None)],
760
 
                         t._activity)
 
730
            transport._activity)
761
731
 
762
732
    def test_validate_one_page(self):
763
733
        builder = btree_index.BTreeBuilder(key_elements=2, reference_lists=2)
764
734
        nodes = self.make_nodes(45, 2, 2)
765
735
        for node in nodes:
766
736
            builder.add_node(*node)
767
 
        t = transport.get_transport('trace+' + self.get_url(''))
768
 
        size = t.put_file('index', builder.finish())
769
 
        index = btree_index.BTreeGraphIndex(t, 'index', size)
770
 
        del t._activity[:]
771
 
        self.assertEqual([], t._activity)
 
737
        transport = get_transport('trace+' + self.get_url(''))
 
738
        size = transport.put_file('index', builder.finish())
 
739
        index = btree_index.BTreeGraphIndex(transport, 'index', size)
 
740
        del transport._activity[:]
 
741
        self.assertEqual([], transport._activity)
772
742
        index.validate()
773
743
        # The entire index should have been read linearly.
774
744
        self.assertEqual([('readv', 'index', [(0, size)], False, None)],
775
 
                         t._activity)
776
 
        self.assertEqual(1488, size)
 
745
            transport._activity)
 
746
        self.assertEqual(1514, size)
777
747
 
778
748
    def test_validate_two_pages(self):
779
749
        builder = btree_index.BTreeBuilder(key_elements=2, reference_lists=2)
780
750
        nodes = self.make_nodes(80, 2, 2)
781
751
        for node in nodes:
782
752
            builder.add_node(*node)
783
 
        t = transport.get_transport('trace+' + self.get_url(''))
784
 
        size = t.put_file('index', builder.finish())
 
753
        transport = get_transport('trace+' + self.get_url(''))
 
754
        size = transport.put_file('index', builder.finish())
785
755
        # Root page, 2 leaf pages
786
756
        self.assertEqual(9339, size)
787
 
        index = btree_index.BTreeGraphIndex(t, 'index', size)
788
 
        del t._activity[:]
789
 
        self.assertEqual([], t._activity)
 
757
        index = btree_index.BTreeGraphIndex(transport, 'index', size)
 
758
        del transport._activity[:]
 
759
        self.assertEqual([], transport._activity)
790
760
        index.validate()
791
761
        # The entire index should have been read linearly.
792
 
        self.assertEqual(
793
 
            [('readv', 'index', [(0, 4096)], False, None),
794
 
             ('readv', 'index', [(4096, 4096), (8192, 1147)], False, None)],
795
 
            t._activity)
 
762
        self.assertEqual([('readv', 'index', [(0, 4096)], False, None),
 
763
            ('readv', 'index', [(4096, 4096), (8192, 1147)], False, None)],
 
764
            transport._activity)
796
765
        # XXX: TODO: write some badly-ordered nodes, and some pointers-to-wrong
797
766
        # node and make validate find them.
798
767
 
799
768
    def test_eq_ne(self):
800
769
        # two indices are equal when constructed with the same parameters:
801
 
        t1 = transport.get_transport('trace+' + self.get_url(''))
802
 
        t2 = self.get_transport()
803
 
        self.assertTrue(
804
 
            btree_index.BTreeGraphIndex(t1, 'index', None) ==
805
 
            btree_index.BTreeGraphIndex(t1, 'index', None))
806
 
        self.assertTrue(
807
 
            btree_index.BTreeGraphIndex(t1, 'index', 20) ==
808
 
            btree_index.BTreeGraphIndex(t1, 'index', 20))
809
 
        self.assertFalse(
810
 
            btree_index.BTreeGraphIndex(t1, 'index', 20) ==
811
 
            btree_index.BTreeGraphIndex(t2, 'index', 20))
812
 
        self.assertFalse(
813
 
            btree_index.BTreeGraphIndex(t1, 'inde1', 20) ==
814
 
            btree_index.BTreeGraphIndex(t1, 'inde2', 20))
815
 
        self.assertFalse(
816
 
            btree_index.BTreeGraphIndex(t1, 'index', 10) ==
817
 
            btree_index.BTreeGraphIndex(t1, 'index', 20))
818
 
        self.assertFalse(
819
 
            btree_index.BTreeGraphIndex(t1, 'index', None) !=
820
 
            btree_index.BTreeGraphIndex(t1, 'index', None))
821
 
        self.assertFalse(
822
 
            btree_index.BTreeGraphIndex(t1, 'index', 20) !=
823
 
            btree_index.BTreeGraphIndex(t1, 'index', 20))
824
 
        self.assertTrue(
825
 
            btree_index.BTreeGraphIndex(t1, 'index', 20) !=
826
 
            btree_index.BTreeGraphIndex(t2, 'index', 20))
827
 
        self.assertTrue(
828
 
            btree_index.BTreeGraphIndex(t1, 'inde1', 20) !=
829
 
            btree_index.BTreeGraphIndex(t1, 'inde2', 20))
830
 
        self.assertTrue(
831
 
            btree_index.BTreeGraphIndex(t1, 'index', 10) !=
832
 
            btree_index.BTreeGraphIndex(t1, 'index', 20))
 
770
        transport1 = get_transport('trace+' + self.get_url(''))
 
771
        transport2 = get_transport(self.get_url(''))
 
772
        self.assertTrue(
 
773
            btree_index.BTreeGraphIndex(transport1, 'index', None) ==
 
774
            btree_index.BTreeGraphIndex(transport1, 'index', None))
 
775
        self.assertTrue(
 
776
            btree_index.BTreeGraphIndex(transport1, 'index', 20) ==
 
777
            btree_index.BTreeGraphIndex(transport1, 'index', 20))
 
778
        self.assertFalse(
 
779
            btree_index.BTreeGraphIndex(transport1, 'index', 20) ==
 
780
            btree_index.BTreeGraphIndex(transport2, 'index', 20))
 
781
        self.assertFalse(
 
782
            btree_index.BTreeGraphIndex(transport1, 'inde1', 20) ==
 
783
            btree_index.BTreeGraphIndex(transport1, 'inde2', 20))
 
784
        self.assertFalse(
 
785
            btree_index.BTreeGraphIndex(transport1, 'index', 10) ==
 
786
            btree_index.BTreeGraphIndex(transport1, 'index', 20))
 
787
        self.assertFalse(
 
788
            btree_index.BTreeGraphIndex(transport1, 'index', None) !=
 
789
            btree_index.BTreeGraphIndex(transport1, 'index', None))
 
790
        self.assertFalse(
 
791
            btree_index.BTreeGraphIndex(transport1, 'index', 20) !=
 
792
            btree_index.BTreeGraphIndex(transport1, 'index', 20))
 
793
        self.assertTrue(
 
794
            btree_index.BTreeGraphIndex(transport1, 'index', 20) !=
 
795
            btree_index.BTreeGraphIndex(transport2, 'index', 20))
 
796
        self.assertTrue(
 
797
            btree_index.BTreeGraphIndex(transport1, 'inde1', 20) !=
 
798
            btree_index.BTreeGraphIndex(transport1, 'inde2', 20))
 
799
        self.assertTrue(
 
800
            btree_index.BTreeGraphIndex(transport1, 'index', 10) !=
 
801
            btree_index.BTreeGraphIndex(transport1, 'index', 20))
833
802
 
834
803
    def test_iter_all_only_root_no_size(self):
835
804
        self.make_index(nodes=[(('key',), 'value', ())])
836
 
        t = transport.get_transport('trace+' + self.get_url(''))
837
 
        index = btree_index.BTreeGraphIndex(t, 'index', None)
838
 
        del t._activity[:]
 
805
        trans = get_transport('trace+' + self.get_url(''))
 
806
        index = btree_index.BTreeGraphIndex(trans, 'index', None)
 
807
        del trans._activity[:]
839
808
        self.assertEqual([(('key',), 'value')],
840
809
                         [x[1:] for x in index.iter_all_entries()])
841
 
        self.assertEqual([('get', 'index')], t._activity)
 
810
        self.assertEqual([('get', 'index')], trans._activity)
842
811
 
843
812
    def test_iter_all_entries_reads(self):
844
813
        # iterating all entries reads the header, then does a linear
850
819
        nodes = self.make_nodes(10000, 2, 2)
851
820
        for node in nodes:
852
821
            builder.add_node(*node)
853
 
        t = transport.get_transport('trace+' + self.get_url(''))
854
 
        size = t.put_file('index', builder.finish())
 
822
        transport = get_transport('trace+' + self.get_url(''))
 
823
        size = transport.put_file('index', builder.finish())
855
824
        self.assertEqual(1303220, size, 'number of expected bytes in the'
856
825
                                        ' output changed')
857
826
        page_size = btree_index._PAGE_SIZE
858
827
        del builder
859
 
        index = btree_index.BTreeGraphIndex(t, 'index', size)
860
 
        del t._activity[:]
861
 
        self.assertEqual([], t._activity)
 
828
        index = btree_index.BTreeGraphIndex(transport, 'index', size)
 
829
        del transport._activity[:]
 
830
        self.assertEqual([], transport._activity)
862
831
        found_nodes = self.time(list, index.iter_all_entries())
863
832
        bare_nodes = []
864
833
        for node in found_nodes:
885
854
        readv_request[-1] = (readv_request[-1][0], 1303220 % page_size)
886
855
        expected = [('readv', 'index', [(0, page_size)], False, None),
887
856
             ('readv',  'index', readv_request, False, None)]
888
 
        if expected != t._activity:
 
857
        if expected != transport._activity:
889
858
            self.assertEqualDiff(pprint.pformat(expected),
890
859
                                 pprint.pformat(transport._activity))
891
860
 
905
874
        nodes = self.make_nodes(160, 2, 2)
906
875
        for node in nodes:
907
876
            builder.add_node(*node)
908
 
        t = transport.get_transport('trace+' + self.get_url(''))
909
 
        size = t.put_file('index', builder.finish())
 
877
        transport = get_transport('trace+' + self.get_url(''))
 
878
        size = transport.put_file('index', builder.finish())
910
879
        del builder
911
 
        index = btree_index.BTreeGraphIndex(t, 'index', size)
912
 
        del t._activity[:]
913
 
        self.assertEqual([], t._activity)
 
880
        index = btree_index.BTreeGraphIndex(transport, 'index', size)
 
881
        del transport._activity[:]
 
882
        self.assertEqual([], transport._activity)
914
883
        # search for one key
915
884
        found_nodes = list(index.iter_entries([nodes[30][0]]))
916
885
        bare_nodes = []
924
893
        # Should have read the root node, then one leaf page:
925
894
        self.assertEqual([('readv', 'index', [(0, 4096)], False, None),
926
895
             ('readv',  'index', [(8192, 4096), ], False, None)],
927
 
            t._activity)
 
896
            transport._activity)
928
897
 
929
898
    def test_iter_key_prefix_1_element_key_None(self):
930
899
        index = self.make_index()
1113
1082
        min_l2_key = l2.min_key
1114
1083
        max_l1_key = l1.max_key
1115
1084
        self.assertTrue(max_l1_key < min_l2_key)
1116
 
        parents_min_l2_key = l2[min_l2_key][1][0]
 
1085
        parents_min_l2_key = l2.keys[min_l2_key][1][0]
1117
1086
        self.assertEqual((l1.max_key,), parents_min_l2_key)
1118
1087
        # Now, whatever key we select that would fall on the second page,
1119
1088
        # should give us all the parents until the page break
1132
1101
        parent_map = {}
1133
1102
        search_keys = index._find_ancestors([max_l1_key], 0, parent_map,
1134
1103
                                            missing_keys)
1135
 
        self.assertEqual(l1.all_keys(), sorted(parent_map))
 
1104
        self.assertEqual(sorted(l1.keys), sorted(parent_map))
1136
1105
        self.assertEqual(set(), missing_keys)
1137
1106
        self.assertEqual(set(), search_keys)
1138
1107
 
1146
1115
        self.assertEqual({}, parent_map)
1147
1116
        self.assertEqual(set([('one',), ('two',)]), missing_keys)
1148
1117
 
1149
 
    def test_supports_unlimited_cache(self):
1150
 
        builder = btree_index.BTreeBuilder(reference_lists=0, key_elements=1)
1151
 
        # We need enough nodes to cause a page split (so we have both an
1152
 
        # internal node and a couple leaf nodes. 500 seems to be enough.)
1153
 
        nodes = self.make_nodes(500, 1, 0)
1154
 
        for node in nodes:
1155
 
            builder.add_node(*node)
1156
 
        stream = builder.finish()
1157
 
        trans = self.get_transport()
1158
 
        size = trans.put_file('index', stream)
1159
 
        index = btree_index.BTreeGraphIndex(trans, 'index', size)
1160
 
        self.assertEqual(500, index.key_count())
1161
 
        # We have an internal node
1162
 
        self.assertEqual(2, len(index._row_lengths))
1163
 
        # We have at least 2 leaf nodes
1164
 
        self.assertTrue(index._row_lengths[-1] >= 2)
1165
 
        self.assertIsInstance(index._leaf_node_cache, lru_cache.LRUCache)
1166
 
        self.assertEqual(btree_index._NODE_CACHE_SIZE,
1167
 
                         index._leaf_node_cache._max_cache)
1168
 
        self.assertIsInstance(index._internal_node_cache, fifo_cache.FIFOCache)
1169
 
        self.assertEqual(100, index._internal_node_cache._max_cache)
1170
 
        # No change if unlimited_cache=False is passed
1171
 
        index = btree_index.BTreeGraphIndex(trans, 'index', size,
1172
 
                                            unlimited_cache=False)
1173
 
        self.assertIsInstance(index._leaf_node_cache, lru_cache.LRUCache)
1174
 
        self.assertEqual(btree_index._NODE_CACHE_SIZE,
1175
 
                         index._leaf_node_cache._max_cache)
1176
 
        self.assertIsInstance(index._internal_node_cache, fifo_cache.FIFOCache)
1177
 
        self.assertEqual(100, index._internal_node_cache._max_cache)
1178
 
        index = btree_index.BTreeGraphIndex(trans, 'index', size,
1179
 
                                            unlimited_cache=True)
1180
 
        self.assertIsInstance(index._leaf_node_cache, dict)
1181
 
        self.assertIs(type(index._internal_node_cache), dict)
1182
 
        # Exercise the lookup code
1183
 
        entries = set(index.iter_entries([n[0] for n in nodes]))
1184
 
        self.assertEqual(500, len(entries))
1185
 
 
1186
1118
 
1187
1119
class TestBTreeNodes(BTreeTestCase):
1188
1120
 
1189
 
    scenarios = btreeparser_scenarios()
 
1121
    def restore_parser(self):
 
1122
        btree_index._btree_serializer = self.saved_parser
1190
1123
 
1191
1124
    def setUp(self):
1192
1125
        BTreeTestCase.setUp(self)
1193
 
        self.overrideAttr(btree_index, '_btree_serializer', self.parse_btree)
 
1126
        self.saved_parser = btree_index._btree_serializer
 
1127
        self.addCleanup(self.restore_parser)
 
1128
        btree_index._btree_serializer = self.parse_btree
1194
1129
 
1195
1130
    def test_LeafNode_1_0(self):
1196
1131
        node_bytes = ("type=leaf\n"
1208
1143
            ("2222222222222222222222222222222222222222",): ("value:2", ()),
1209
1144
            ("3333333333333333333333333333333333333333",): ("value:3", ()),
1210
1145
            ("4444444444444444444444444444444444444444",): ("value:4", ()),
1211
 
            }, dict(node.all_items()))
 
1146
            }, node.keys)
1212
1147
 
1213
1148
    def test_LeafNode_2_2(self):
1214
1149
        node_bytes = ("type=leaf\n"
1228
1163
            ('11', '33'): ('value:3',
1229
1164
                ((('11', 'ref22'),), (('11', 'ref22'), ('11', 'ref22')))),
1230
1165
            ('11', '44'): ('value:4', ((), (('11', 'ref00'),)))
1231
 
            }, dict(node.all_items()))
 
1166
            }, node.keys)
1232
1167
 
1233
1168
    def test_InternalNode_1(self):
1234
1169
        node_bytes = ("type=internal\n"
1269
1204
            ('11', '33'): ('value:3',
1270
1205
                ((('11', 'ref22'),), (('11', 'ref22'), ('11', 'ref22')))),
1271
1206
            ('11', '44'): ('value:4', ((), (('11', 'ref00'),)))
1272
 
            }, dict(node.all_items()))
 
1207
            }, node.keys)
1273
1208
 
1274
1209
    def assertFlattened(self, expected, key, value, refs):
1275
1210
        flat_key, flat_line = self.parse_btree._flatten_node(
1307
1242
    def test_exists(self):
1308
1243
        # This is just to let the user know if they don't have the feature
1309
1244
        # available
1310
 
        self.requireFeature(compiled_btreeparser_feature)
 
1245
        self.requireFeature(CompiledBtreeParserFeature)
1311
1246
 
1312
1247
 
1313
1248
class TestMultiBisectRight(tests.TestCase):
1353
1288
        This doesn't actually create anything on disk, it just primes a
1354
1289
        BTreeGraphIndex with the recommended information.
1355
1290
        """
1356
 
        index = btree_index.BTreeGraphIndex(
1357
 
            transport.get_transport('memory:///'), 'test-index', size=size)
 
1291
        index = btree_index.BTreeGraphIndex(get_transport('memory:///'),
 
1292
                                            'test-index', size=size)
1358
1293
        if recommended_pages is not None:
1359
1294
            index._recommended_pages = recommended_pages
1360
1295
        return index