/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_lru_cache.py

  • Committer: Marius Kruger
  • Date: 2010-07-10 21:28:56 UTC
  • mto: (5384.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5385.
  • Revision ID: marius.kruger@enerweb.co.za-20100710212856-uq4ji3go0u5se7hx
* Update documentation
* add NEWS

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_lru_cache.py
16
16
 
17
17
"""Tests for the lru_cache module."""
18
18
 
19
 
from .. import (
 
19
from bzrlib import (
20
20
    lru_cache,
21
21
    tests,
22
22
    )
23
23
 
24
24
 
25
 
def walk_lru(lru):
26
 
    """Test helper to walk the LRU list and assert its consistency"""
27
 
    node = lru._most_recently_used
28
 
    if node is not None:
29
 
        if node.prev is not None:
30
 
            raise AssertionError('the _most_recently_used entry is not'
31
 
                                 ' supposed to have a previous entry'
32
 
                                 ' %s' % (node,))
33
 
    while node is not None:
34
 
        if node.next_key is lru_cache._null_key:
35
 
            if node is not lru._least_recently_used:
36
 
                raise AssertionError('only the last node should have'
37
 
                                     ' no next value: %s' % (node,))
38
 
            node_next = None
39
 
        else:
40
 
            node_next = lru._cache[node.next_key]
41
 
            if node_next.prev is not node:
42
 
                raise AssertionError('inconsistency found, node.next.prev'
43
 
                                     ' != node: %s' % (node,))
44
 
        if node.prev is None:
45
 
            if node is not lru._most_recently_used:
46
 
                raise AssertionError('only the _most_recently_used should'
47
 
                                     ' not have a previous node: %s'
48
 
                                     % (node,))
49
 
        else:
50
 
            if node.prev.next_key != node.key:
51
 
                raise AssertionError('inconsistency found, node.prev.next'
52
 
                                     ' != node: %s' % (node,))
53
 
        yield node
54
 
        node = node_next
55
 
 
56
 
 
57
25
class TestLRUCache(tests.TestCase):
58
26
    """Test that LRU cache properly keeps track of entries."""
59
27
 
70
38
    def test_missing(self):
71
39
        cache = lru_cache.LRUCache(max_cache=10)
72
40
 
73
 
        self.assertFalse('foo' in cache)
 
41
        self.failIf('foo' in cache)
74
42
        self.assertRaises(KeyError, cache.__getitem__, 'foo')
75
43
 
76
44
        cache['foo'] = 'bar'
77
45
        self.assertEqual('bar', cache['foo'])
78
 
        self.assertTrue('foo' in cache)
79
 
        self.assertFalse('bar' in cache)
 
46
        self.failUnless('foo' in cache)
 
47
        self.failIf('bar' in cache)
80
48
 
81
49
    def test_map_None(self):
82
50
        # Make sure that we can properly map None as a key.
83
51
        cache = lru_cache.LRUCache(max_cache=10)
84
 
        self.assertFalse(None in cache)
 
52
        self.failIf(None in cache)
85
53
        cache[None] = 1
86
54
        self.assertEqual(1, cache[None])
87
55
        cache[None] = 2
93
61
        cache[None]
94
62
        cache[1]
95
63
        cache[None]
96
 
        self.assertEqual([None, 1], [n.key for n in walk_lru(cache)])
 
64
        self.assertEqual([None, 1], [n.key for n in cache._walk_lru()])
97
65
 
98
66
    def test_add__null_key(self):
99
67
        cache = lru_cache.LRUCache(max_cache=10)
100
 
        self.assertRaises(ValueError,
101
 
                          cache.__setitem__, lru_cache._null_key, 1)
 
68
        self.assertRaises(ValueError, cache.add, lru_cache._null_key, 1)
102
69
 
103
70
    def test_overflow(self):
104
71
        """Adding extra entries will pop out old ones."""
108
75
        # With a max cache of 1, adding 'baz' should pop out 'foo'
109
76
        cache['baz'] = 'biz'
110
77
 
111
 
        self.assertFalse('foo' in cache)
112
 
        self.assertTrue('baz' in cache)
 
78
        self.failIf('foo' in cache)
 
79
        self.failUnless('baz' in cache)
113
80
 
114
81
        self.assertEqual('biz', cache['baz'])
115
82
 
125
92
        # This must kick out 'foo' because it was the last accessed
126
93
        cache['nub'] = 'in'
127
94
 
128
 
        self.assertFalse('foo' in cache)
 
95
        self.failIf('foo' in cache)
 
96
 
 
97
    def test_cleanup(self):
 
98
        """Test that we can use a cleanup function."""
 
99
        cleanup_called = []
 
100
        def cleanup_func(key, val):
 
101
            cleanup_called.append((key, val))
 
102
 
 
103
        cache = lru_cache.LRUCache(max_cache=2)
 
104
 
 
105
        cache.add('baz', '1', cleanup=cleanup_func)
 
106
        cache.add('foo', '2', cleanup=cleanup_func)
 
107
        cache.add('biz', '3', cleanup=cleanup_func)
 
108
 
 
109
        self.assertEqual([('baz', '1')], cleanup_called)
 
110
 
 
111
        # 'foo' is now most recent, so final cleanup will call it last
 
112
        cache['foo']
 
113
        cache.clear()
 
114
        self.assertEqual([('baz', '1'), ('biz', '3'), ('foo', '2')],
 
115
                         cleanup_called)
 
116
 
 
117
    def test_cleanup_on_replace(self):
 
118
        """Replacing an object should cleanup the old value."""
 
119
        cleanup_called = []
 
120
        def cleanup_func(key, val):
 
121
            cleanup_called.append((key, val))
 
122
 
 
123
        cache = lru_cache.LRUCache(max_cache=2)
 
124
        cache.add(1, 10, cleanup=cleanup_func)
 
125
        cache.add(2, 20, cleanup=cleanup_func)
 
126
        cache.add(2, 25, cleanup=cleanup_func)
 
127
 
 
128
        self.assertEqual([(2, 20)], cleanup_called)
 
129
        self.assertEqual(25, cache[2])
 
130
 
 
131
        # Even __setitem__ should make sure cleanup() is called
 
132
        cache[2] = 26
 
133
        self.assertEqual([(2, 20), (2, 25)], cleanup_called)
 
134
 
 
135
    def test_cleanup_error_maintains_linked_list(self):
 
136
        cleanup_called = []
 
137
        def cleanup_func(key, val):
 
138
            cleanup_called.append((key, val))
 
139
            raise ValueError('failure during cleanup')
 
140
 
 
141
        cache = lru_cache.LRUCache(max_cache=10)
 
142
        for i in xrange(10):
 
143
            cache.add(i, i, cleanup=cleanup_func)
 
144
        for i in xrange(10, 20):
 
145
            self.assertRaises(ValueError,
 
146
                cache.add, i, i, cleanup=cleanup_func)
 
147
 
 
148
        self.assertEqual([(i, i) for i in xrange(10)], cleanup_called)
 
149
 
 
150
        self.assertEqual(range(19, 9, -1), [n.key for n in cache._walk_lru()])
 
151
 
 
152
    def test_cleanup_during_replace_still_replaces(self):
 
153
        cleanup_called = []
 
154
        def cleanup_func(key, val):
 
155
            cleanup_called.append((key, val))
 
156
            raise ValueError('failure during cleanup')
 
157
 
 
158
        cache = lru_cache.LRUCache(max_cache=10)
 
159
        for i in xrange(10):
 
160
            cache.add(i, i, cleanup=cleanup_func)
 
161
        self.assertRaises(ValueError,
 
162
            cache.add, 1, 20, cleanup=cleanup_func)
 
163
        # We also still update the recent access to this node
 
164
        self.assertEqual([1, 9, 8, 7, 6, 5, 4, 3, 2, 0],
 
165
                         [n.key for n in cache._walk_lru()])
 
166
        self.assertEqual(20, cache[1])
 
167
 
 
168
        self.assertEqual([(1, 1)], cleanup_called)
 
169
        self.assertEqual([1, 9, 8, 7, 6, 5, 4, 3, 2, 0],
 
170
                         [n.key for n in cache._walk_lru()])
129
171
 
130
172
    def test_len(self):
131
173
        cache = lru_cache.LRUCache(max_cache=10, after_cleanup_count=10)
144
186
 
145
187
        self.assertEqual(8, len(cache))
146
188
 
147
 
        cache[1] = 15  # replacement
 
189
        cache[1] = 15 # replacement
148
190
 
149
191
        self.assertEqual(8, len(cache))
150
192
 
155
197
        # We hit the max
156
198
        self.assertEqual(10, len(cache))
157
199
        self.assertEqual([11, 10, 9, 1, 8, 7, 6, 5, 4, 3],
158
 
                         [n.key for n in walk_lru(cache)])
 
200
                         [n.key for n in cache._walk_lru()])
159
201
 
160
202
    def test_cleanup_shrinks_to_after_clean_count(self):
161
203
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=3)
162
204
 
163
 
        cache[1] = 10
164
 
        cache[2] = 20
165
 
        cache[3] = 25
166
 
        cache[4] = 30
167
 
        cache[5] = 35
 
205
        cache.add(1, 10)
 
206
        cache.add(2, 20)
 
207
        cache.add(3, 25)
 
208
        cache.add(4, 30)
 
209
        cache.add(5, 35)
168
210
 
169
211
        self.assertEqual(5, len(cache))
170
212
        # This will bump us over the max, which causes us to shrink down to
171
213
        # after_cleanup_cache size
172
 
        cache[6] = 40
 
214
        cache.add(6, 40)
173
215
        self.assertEqual(3, len(cache))
174
216
 
175
217
    def test_after_cleanup_larger_than_max(self):
185
227
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=2)
186
228
 
187
229
        # Add these in order
188
 
        cache[1] = 10
189
 
        cache[2] = 20
190
 
        cache[3] = 25
191
 
        cache[4] = 30
192
 
        cache[5] = 35
 
230
        cache.add(1, 10)
 
231
        cache.add(2, 20)
 
232
        cache.add(3, 25)
 
233
        cache.add(4, 30)
 
234
        cache.add(5, 35)
193
235
 
194
236
        self.assertEqual(5, len(cache))
195
237
        # Force a compaction
200
242
        cache = lru_cache.LRUCache(max_cache=5)
201
243
 
202
244
        # Add these in order
203
 
        cache[1] = 10
204
 
        cache[2] = 20
205
 
        cache[3] = 25
206
 
        cache[4] = 30
207
 
        cache[5] = 35
 
245
        cache.add(1, 10)
 
246
        cache.add(2, 20)
 
247
        cache.add(3, 25)
 
248
        cache.add(4, 30)
 
249
        cache.add(5, 35)
208
250
 
209
 
        self.assertEqual([5, 4, 3, 2, 1], [n.key for n in walk_lru(cache)])
 
251
        self.assertEqual([5, 4, 3, 2, 1], [n.key for n in cache._walk_lru()])
210
252
 
211
253
        # Now access some randomly
212
254
        cache[2]
213
255
        cache[5]
214
256
        cache[3]
215
257
        cache[2]
216
 
        self.assertEqual([2, 3, 5, 4, 1], [n.key for n in walk_lru(cache)])
 
258
        self.assertEqual([2, 3, 5, 4, 1], [n.key for n in cache._walk_lru()])
217
259
 
218
260
    def test_get(self):
219
261
        cache = lru_cache.LRUCache(max_cache=5)
220
262
 
221
 
        cache[1] = 10
222
 
        cache[2] = 20
 
263
        cache.add(1, 10)
 
264
        cache.add(2, 20)
223
265
        self.assertEqual(20, cache.get(2))
224
266
        self.assertIs(None, cache.get(3))
225
267
        obj = object()
226
268
        self.assertIs(obj, cache.get(3, obj))
227
 
        self.assertEqual([2, 1], [n.key for n in walk_lru(cache)])
 
269
        self.assertEqual([2, 1], [n.key for n in cache._walk_lru()])
228
270
        self.assertEqual(10, cache.get(1))
229
 
        self.assertEqual([1, 2], [n.key for n in walk_lru(cache)])
 
271
        self.assertEqual([1, 2], [n.key for n in cache._walk_lru()])
230
272
 
231
273
    def test_keys(self):
232
274
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=5)
240
282
        cache[6] = 7
241
283
        self.assertEqual([2, 3, 4, 5, 6], sorted(cache.keys()))
242
284
 
 
285
    def test_after_cleanup_size_deprecated(self):
 
286
        obj = self.callDeprecated([
 
287
            'LRUCache.__init__(after_cleanup_size) was deprecated in 1.11.'
 
288
            ' Use after_cleanup_count instead.'],
 
289
            lru_cache.LRUCache, 50, after_cleanup_size=25)
 
290
        self.assertEqual(obj._after_cleanup_count, 25)
 
291
 
243
292
    def test_resize_smaller(self):
244
293
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=4)
245
294
        cache[1] = 2
276
325
        cache[9] = 10
277
326
        cache[10] = 11
278
327
        self.assertEqual([3, 4, 5, 6, 7, 8, 9, 10], sorted(cache.keys()))
279
 
        cache[11] = 12  # triggers cleanup back to new after_cleanup_count
 
328
        cache[11] = 12 # triggers cleanup back to new after_cleanup_count
280
329
        self.assertEqual([6, 7, 8, 9, 10, 11], sorted(cache.keys()))
281
330
 
282
331
 
285
334
    def test_basic_init(self):
286
335
        cache = lru_cache.LRUSizeCache()
287
336
        self.assertEqual(2048, cache._max_cache)
288
 
        self.assertEqual(int(cache._max_size * 0.8), cache._after_cleanup_size)
 
337
        self.assertEqual(int(cache._max_size*0.8), cache._after_cleanup_size)
289
338
        self.assertEqual(0, cache._value_size)
290
339
 
291
340
    def test_add__null_key(self):
292
341
        cache = lru_cache.LRUSizeCache()
293
 
        self.assertRaises(ValueError,
294
 
                          cache.__setitem__, lru_cache._null_key, 1)
 
342
        self.assertRaises(ValueError, cache.add, lru_cache._null_key, 1)
295
343
 
296
344
    def test_add_tracks_size(self):
297
345
        cache = lru_cache.LRUSizeCache()
298
346
        self.assertEqual(0, cache._value_size)
299
 
        cache['my key'] = 'my value text'
 
347
        cache.add('my key', 'my value text')
300
348
        self.assertEqual(13, cache._value_size)
301
349
 
302
350
    def test_remove_tracks_size(self):
303
351
        cache = lru_cache.LRUSizeCache()
304
352
        self.assertEqual(0, cache._value_size)
305
 
        cache['my key'] = 'my value text'
 
353
        cache.add('my key', 'my value text')
306
354
        self.assertEqual(13, cache._value_size)
307
355
        node = cache._cache['my key']
308
356
        cache._remove_node(node)
312
360
        """Adding a large value may not be cached at all."""
313
361
        cache = lru_cache.LRUSizeCache(max_size=10, after_cleanup_size=5)
314
362
        self.assertEqual(0, cache._value_size)
315
 
        self.assertEqual({}, cache.as_dict())
316
 
        cache['test'] = 'key'
317
 
        self.assertEqual(3, cache._value_size)
318
 
        self.assertEqual({'test': 'key'}, cache.as_dict())
319
 
        cache['test2'] = 'key that is too big'
320
 
        self.assertEqual(3, cache._value_size)
321
 
        self.assertEqual({'test': 'key'}, cache.as_dict())
 
363
        self.assertEqual({}, cache.items())
 
364
        cache.add('test', 'key')
 
365
        self.assertEqual(3, cache._value_size)
 
366
        self.assertEqual({'test': 'key'}, cache.items())
 
367
        cache.add('test2', 'key that is too big')
 
368
        self.assertEqual(3, cache._value_size)
 
369
        self.assertEqual({'test':'key'}, cache.items())
322
370
        # If we would add a key, only to cleanup and remove all cached entries,
323
371
        # then obviously that value should not be stored
324
 
        cache['test3'] = 'bigkey'
325
 
        self.assertEqual(3, cache._value_size)
326
 
        self.assertEqual({'test': 'key'}, cache.as_dict())
327
 
 
328
 
        cache['test4'] = 'bikey'
329
 
        self.assertEqual(3, cache._value_size)
330
 
        self.assertEqual({'test': 'key'}, cache.as_dict())
 
372
        cache.add('test3', 'bigkey')
 
373
        self.assertEqual(3, cache._value_size)
 
374
        self.assertEqual({'test':'key'}, cache.items())
 
375
 
 
376
        cache.add('test4', 'bikey')
 
377
        self.assertEqual(3, cache._value_size)
 
378
        self.assertEqual({'test':'key'}, cache.items())
 
379
 
 
380
    def test_no_add_over_size_cleanup(self):
 
381
        """If a large value is not cached, we will call cleanup right away."""
 
382
        cleanup_calls = []
 
383
        def cleanup(key, value):
 
384
            cleanup_calls.append((key, value))
 
385
 
 
386
        cache = lru_cache.LRUSizeCache(max_size=10, after_cleanup_size=5)
 
387
        self.assertEqual(0, cache._value_size)
 
388
        self.assertEqual({}, cache.items())
 
389
        cache.add('test', 'key that is too big', cleanup=cleanup)
 
390
        # key was not added
 
391
        self.assertEqual(0, cache._value_size)
 
392
        self.assertEqual({}, cache.items())
 
393
        # and cleanup was called
 
394
        self.assertEqual([('test', 'key that is too big')], cleanup_calls)
331
395
 
332
396
    def test_adding_clears_cache_based_on_size(self):
333
397
        """The cache is cleared in LRU order until small enough"""
334
398
        cache = lru_cache.LRUSizeCache(max_size=20)
335
 
        cache['key1'] = 'value'  # 5 chars
336
 
        cache['key2'] = 'value2'  # 6 chars
337
 
        cache['key3'] = 'value23'  # 7 chars
338
 
        self.assertEqual(5 + 6 + 7, cache._value_size)
339
 
        cache['key2']  # reference key2 so it gets a newer reference time
340
 
        cache['key4'] = 'value234'  # 8 chars, over limit
 
399
        cache.add('key1', 'value') # 5 chars
 
400
        cache.add('key2', 'value2') # 6 chars
 
401
        cache.add('key3', 'value23') # 7 chars
 
402
        self.assertEqual(5+6+7, cache._value_size)
 
403
        cache['key2'] # reference key2 so it gets a newer reference time
 
404
        cache.add('key4', 'value234') # 8 chars, over limit
341
405
        # We have to remove 2 keys to get back under limit
342
 
        self.assertEqual(6 + 8, cache._value_size)
343
 
        self.assertEqual({'key2': 'value2', 'key4': 'value234'},
344
 
                         cache.as_dict())
 
406
        self.assertEqual(6+8, cache._value_size)
 
407
        self.assertEqual({'key2':'value2', 'key4':'value234'},
 
408
                         cache.items())
345
409
 
346
410
    def test_adding_clears_to_after_cleanup_size(self):
347
411
        cache = lru_cache.LRUSizeCache(max_size=20, after_cleanup_size=10)
348
 
        cache['key1'] = 'value'  # 5 chars
349
 
        cache['key2'] = 'value2'  # 6 chars
350
 
        cache['key3'] = 'value23'  # 7 chars
351
 
        self.assertEqual(5 + 6 + 7, cache._value_size)
352
 
        cache['key2']  # reference key2 so it gets a newer reference time
353
 
        cache['key4'] = 'value234'  # 8 chars, over limit
 
412
        cache.add('key1', 'value') # 5 chars
 
413
        cache.add('key2', 'value2') # 6 chars
 
414
        cache.add('key3', 'value23') # 7 chars
 
415
        self.assertEqual(5+6+7, cache._value_size)
 
416
        cache['key2'] # reference key2 so it gets a newer reference time
 
417
        cache.add('key4', 'value234') # 8 chars, over limit
354
418
        # We have to remove 3 keys to get back under limit
355
419
        self.assertEqual(8, cache._value_size)
356
 
        self.assertEqual({'key4': 'value234'}, cache.as_dict())
 
420
        self.assertEqual({'key4':'value234'}, cache.items())
357
421
 
358
422
    def test_custom_sizes(self):
359
423
        def size_of_list(lst):
361
425
        cache = lru_cache.LRUSizeCache(max_size=20, after_cleanup_size=10,
362
426
                                       compute_size=size_of_list)
363
427
 
364
 
        cache['key1'] = ['val', 'ue']  # 5 chars
365
 
        cache['key2'] = ['val', 'ue2']  # 6 chars
366
 
        cache['key3'] = ['val', 'ue23']  # 7 chars
367
 
        self.assertEqual(5 + 6 + 7, cache._value_size)
368
 
        cache['key2']  # reference key2 so it gets a newer reference time
369
 
        cache['key4'] = ['value', '234']  # 8 chars, over limit
 
428
        cache.add('key1', ['val', 'ue']) # 5 chars
 
429
        cache.add('key2', ['val', 'ue2']) # 6 chars
 
430
        cache.add('key3', ['val', 'ue23']) # 7 chars
 
431
        self.assertEqual(5+6+7, cache._value_size)
 
432
        cache['key2'] # reference key2 so it gets a newer reference time
 
433
        cache.add('key4', ['value', '234']) # 8 chars, over limit
370
434
        # We have to remove 3 keys to get back under limit
371
435
        self.assertEqual(8, cache._value_size)
372
 
        self.assertEqual({'key4': ['value', '234']}, cache.as_dict())
 
436
        self.assertEqual({'key4':['value', '234']}, cache.items())
373
437
 
374
438
    def test_cleanup(self):
375
439
        cache = lru_cache.LRUSizeCache(max_size=20, after_cleanup_size=10)
376
440
 
377
441
        # Add these in order
378
 
        cache['key1'] = 'value'  # 5 chars
379
 
        cache['key2'] = 'value2'  # 6 chars
380
 
        cache['key3'] = 'value23'  # 7 chars
381
 
        self.assertEqual(5 + 6 + 7, cache._value_size)
 
442
        cache.add('key1', 'value') # 5 chars
 
443
        cache.add('key2', 'value2') # 6 chars
 
444
        cache.add('key3', 'value23') # 7 chars
 
445
        self.assertEqual(5+6+7, cache._value_size)
382
446
 
383
447
        cache.cleanup()
384
448
        # Only the most recent fits after cleaning up
424
488
        self.assertEqual([2, 3, 4, 5, 6], sorted(cache.keys()))
425
489
        cache[7] = 'stu'
426
490
        self.assertEqual([4, 5, 6, 7], sorted(cache.keys()))
 
491