← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_lru_cache.py

  • Committer: Vincent Ladeuil
  • Date: 2012-03-13 17:25:29 UTC
  • mfrom: (6499 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6501.
  • Revision ID: v.ladeuil+lp@free.fr-20120313172529-i0suyjnepsor25i7
Merge trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_lru_cache.py
18
18
 
19
19
from bzrlib import (
20
20
    lru_cache,
 
21
    symbol_versioning,
21
22
    tests,
22
23
    )
23
24
 
24
25
 
 
26
def walk_lru(lru):
 
27
    """Test helper to walk the LRU list and assert its consistency"""
 
28
    node = lru._most_recently_used
 
29
    if node is not None:
 
30
        if node.prev is not None:
 
31
            raise AssertionError('the _most_recently_used entry is not'
 
32
                                 ' supposed to have a previous entry'
 
33
                                 ' %s' % (node,))
 
34
    while node is not None:
 
35
        if node.next_key is lru_cache._null_key:
 
36
            if node is not lru._least_recently_used:
 
37
                raise AssertionError('only the last node should have'
 
38
                                     ' no next value: %s' % (node,))
 
39
            node_next = None
 
40
        else:
 
41
            node_next = lru._cache[node.next_key]
 
42
            if node_next.prev is not node:
 
43
                raise AssertionError('inconsistency found, node.next.prev'
 
44
                                     ' != node: %s' % (node,))
 
45
        if node.prev is None:
 
46
            if node is not lru._most_recently_used:
 
47
                raise AssertionError('only the _most_recently_used should'
 
48
                                     ' not have a previous node: %s'
 
49
                                     % (node,))
 
50
        else:
 
51
            if node.prev.next_key != node.key:
 
52
                raise AssertionError('inconsistency found, node.prev.next'
 
53
                                     ' != node: %s' % (node,))
 
54
        yield node
 
55
        node = node_next
 
56
 
 
57
 
25
58
class TestLRUCache(tests.TestCase):
26
59
    """Test that LRU cache properly keeps track of entries."""
27
60
 
38
71
    def test_missing(self):
39
72
        cache = lru_cache.LRUCache(max_cache=10)
40
73
 
41
 
        self.failIf('foo' in cache)
 
74
        self.assertFalse('foo' in cache)
42
75
        self.assertRaises(KeyError, cache.__getitem__, 'foo')
43
76
 
44
77
        cache['foo'] = 'bar'
45
78
        self.assertEqual('bar', cache['foo'])
46
 
        self.failUnless('foo' in cache)
47
 
        self.failIf('bar' in cache)
 
79
        self.assertTrue('foo' in cache)
 
80
        self.assertFalse('bar' in cache)
48
81
 
49
82
    def test_map_None(self):
50
83
        # Make sure that we can properly map None as a key.
51
84
        cache = lru_cache.LRUCache(max_cache=10)
52
 
        self.failIf(None in cache)
 
85
        self.assertFalse(None in cache)
53
86
        cache[None] = 1
54
87
        self.assertEqual(1, cache[None])
55
88
        cache[None] = 2
61
94
        cache[None]
62
95
        cache[1]
63
96
        cache[None]
64
 
        self.assertEqual([None, 1], [n.key for n in cache._walk_lru()])
 
97
        self.assertEqual([None, 1], [n.key for n in walk_lru(cache)])
65
98
 
66
99
    def test_add__null_key(self):
67
100
        cache = lru_cache.LRUCache(max_cache=10)
68
 
        self.assertRaises(ValueError, cache.add, lru_cache._null_key, 1)
 
101
        self.assertRaises(ValueError,
 
102
            cache.__setitem__, lru_cache._null_key, 1)
69
103
 
70
104
    def test_overflow(self):
71
105
        """Adding extra entries will pop out old ones."""
75
109
        # With a max cache of 1, adding 'baz' should pop out 'foo'
76
110
        cache['baz'] = 'biz'
77
111
 
78
 
        self.failIf('foo' in cache)
79
 
        self.failUnless('baz' in cache)
 
112
        self.assertFalse('foo' in cache)
 
113
        self.assertTrue('baz' in cache)
80
114
 
81
115
        self.assertEqual('biz', cache['baz'])
82
116
 
92
126
        # This must kick out 'foo' because it was the last accessed
93
127
        cache['nub'] = 'in'
94
128
 
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
        self.assertFalse('foo' in cache)
 
130
 
 
131
    def test_cleanup_function_deprecated(self):
 
132
        """Test that per-node cleanup functions are no longer allowed"""
 
133
        cache = lru_cache.LRUCache()
 
134
        self.assertRaises(ValueError, self.applyDeprecated,
 
135
            symbol_versioning.deprecated_in((2, 5, 0)),
 
136
            cache.add, "key", 1, cleanup=lambda: None)
171
137
 
172
138
    def test_len(self):
173
139
        cache = lru_cache.LRUCache(max_cache=10, after_cleanup_count=10)
197
163
        # We hit the max
198
164
        self.assertEqual(10, len(cache))
199
165
        self.assertEqual([11, 10, 9, 1, 8, 7, 6, 5, 4, 3],
200
 
                         [n.key for n in cache._walk_lru()])
 
166
                         [n.key for n in walk_lru(cache)])
201
167
 
202
168
    def test_cleanup_shrinks_to_after_clean_count(self):
203
169
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=3)
204
170
 
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)
 
171
        cache[1] = 10
 
172
        cache[2] = 20
 
173
        cache[3] = 25
 
174
        cache[4] = 30
 
175
        cache[5] = 35
210
176
 
211
177
        self.assertEqual(5, len(cache))
212
178
        # This will bump us over the max, which causes us to shrink down to
213
179
        # after_cleanup_cache size
214
 
        cache.add(6, 40)
 
180
        cache[6] = 40
215
181
        self.assertEqual(3, len(cache))
216
182
 
217
183
    def test_after_cleanup_larger_than_max(self):
227
193
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=2)
228
194
 
229
195
        # Add these in order
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)
 
196
        cache[1] = 10
 
197
        cache[2] = 20
 
198
        cache[3] = 25
 
199
        cache[4] = 30
 
200
        cache[5] = 35
235
201
 
236
202
        self.assertEqual(5, len(cache))
237
203
        # Force a compaction
242
208
        cache = lru_cache.LRUCache(max_cache=5)
243
209
 
244
210
        # Add these in order
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)
 
211
        cache[1] = 10
 
212
        cache[2] = 20
 
213
        cache[3] = 25
 
214
        cache[4] = 30
 
215
        cache[5] = 35
250
216
 
251
 
        self.assertEqual([5, 4, 3, 2, 1], [n.key for n in cache._walk_lru()])
 
217
        self.assertEqual([5, 4, 3, 2, 1], [n.key for n in walk_lru(cache)])
252
218
 
253
219
        # Now access some randomly
254
220
        cache[2]
255
221
        cache[5]
256
222
        cache[3]
257
223
        cache[2]
258
 
        self.assertEqual([2, 3, 5, 4, 1], [n.key for n in cache._walk_lru()])
 
224
        self.assertEqual([2, 3, 5, 4, 1], [n.key for n in walk_lru(cache)])
259
225
 
260
226
    def test_get(self):
261
227
        cache = lru_cache.LRUCache(max_cache=5)
262
228
 
263
 
        cache.add(1, 10)
264
 
        cache.add(2, 20)
 
229
        cache[1] = 10
 
230
        cache[2] = 20
265
231
        self.assertEqual(20, cache.get(2))
266
232
        self.assertIs(None, cache.get(3))
267
233
        obj = object()
268
234
        self.assertIs(obj, cache.get(3, obj))
269
 
        self.assertEqual([2, 1], [n.key for n in cache._walk_lru()])
 
235
        self.assertEqual([2, 1], [n.key for n in walk_lru(cache)])
270
236
        self.assertEqual(10, cache.get(1))
271
 
        self.assertEqual([1, 2], [n.key for n in cache._walk_lru()])
 
237
        self.assertEqual([1, 2], [n.key for n in walk_lru(cache)])
272
238
 
273
239
    def test_keys(self):
274
240
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=5)
332
298
 
333
299
    def test_add__null_key(self):
334
300
        cache = lru_cache.LRUSizeCache()
335
 
        self.assertRaises(ValueError, cache.add, lru_cache._null_key, 1)
 
301
        self.assertRaises(ValueError,
 
302
            cache.__setitem__, lru_cache._null_key, 1)
336
303
 
337
304
    def test_add_tracks_size(self):
338
305
        cache = lru_cache.LRUSizeCache()
339
306
        self.assertEqual(0, cache._value_size)
340
 
        cache.add('my key', 'my value text')
 
307
        cache['my key'] = 'my value text'
341
308
        self.assertEqual(13, cache._value_size)
342
309
 
343
310
    def test_remove_tracks_size(self):
344
311
        cache = lru_cache.LRUSizeCache()
345
312
        self.assertEqual(0, cache._value_size)
346
 
        cache.add('my key', 'my value text')
 
313
        cache['my key'] = 'my value text'
347
314
        self.assertEqual(13, cache._value_size)
348
315
        node = cache._cache['my key']
349
316
        cache._remove_node(node)
353
320
        """Adding a large value may not be cached at all."""
354
321
        cache = lru_cache.LRUSizeCache(max_size=10, after_cleanup_size=5)
355
322
        self.assertEqual(0, cache._value_size)
356
 
        self.assertEqual({}, cache.items())
357
 
        cache.add('test', 'key')
358
 
        self.assertEqual(3, cache._value_size)
359
 
        self.assertEqual({'test': 'key'}, cache.items())
360
 
        cache.add('test2', 'key that is too big')
361
 
        self.assertEqual(3, cache._value_size)
362
 
        self.assertEqual({'test':'key'}, cache.items())
 
323
        self.assertEqual({}, cache.as_dict())
 
324
        cache['test'] = 'key'
 
325
        self.assertEqual(3, cache._value_size)
 
326
        self.assertEqual({'test': 'key'}, cache.as_dict())
 
327
        cache['test2'] = 'key that is too big'
 
328
        self.assertEqual(3, cache._value_size)
 
329
        self.assertEqual({'test':'key'}, cache.as_dict())
363
330
        # If we would add a key, only to cleanup and remove all cached entries,
364
331
        # then obviously that value should not be stored
365
 
        cache.add('test3', 'bigkey')
366
 
        self.assertEqual(3, cache._value_size)
367
 
        self.assertEqual({'test':'key'}, cache.items())
368
 
 
369
 
        cache.add('test4', 'bikey')
370
 
        self.assertEqual(3, cache._value_size)
371
 
        self.assertEqual({'test':'key'}, cache.items())
372
 
 
373
 
    def test_no_add_over_size_cleanup(self):
374
 
        """If a large value is not cached, we will call cleanup right away."""
375
 
        cleanup_calls = []
376
 
        def cleanup(key, value):
377
 
            cleanup_calls.append((key, value))
378
 
 
379
 
        cache = lru_cache.LRUSizeCache(max_size=10, after_cleanup_size=5)
380
 
        self.assertEqual(0, cache._value_size)
381
 
        self.assertEqual({}, cache.items())
382
 
        cache.add('test', 'key that is too big', cleanup=cleanup)
383
 
        # key was not added
384
 
        self.assertEqual(0, cache._value_size)
385
 
        self.assertEqual({}, cache.items())
386
 
        # and cleanup was called
387
 
        self.assertEqual([('test', 'key that is too big')], cleanup_calls)
 
332
        cache['test3'] = 'bigkey'
 
333
        self.assertEqual(3, cache._value_size)
 
334
        self.assertEqual({'test':'key'}, cache.as_dict())
 
335
 
 
336
        cache['test4'] = 'bikey'
 
337
        self.assertEqual(3, cache._value_size)
 
338
        self.assertEqual({'test':'key'}, cache.as_dict())
388
339
 
389
340
    def test_adding_clears_cache_based_on_size(self):
390
341
        """The cache is cleared in LRU order until small enough"""
391
342
        cache = lru_cache.LRUSizeCache(max_size=20)
392
 
        cache.add('key1', 'value') # 5 chars
393
 
        cache.add('key2', 'value2') # 6 chars
394
 
        cache.add('key3', 'value23') # 7 chars
 
343
        cache['key1'] = 'value' # 5 chars
 
344
        cache['key2'] = 'value2' # 6 chars
 
345
        cache['key3'] = 'value23' # 7 chars
395
346
        self.assertEqual(5+6+7, cache._value_size)
396
347
        cache['key2'] # reference key2 so it gets a newer reference time
397
 
        cache.add('key4', 'value234') # 8 chars, over limit
 
348
        cache['key4'] = 'value234' # 8 chars, over limit
398
349
        # We have to remove 2 keys to get back under limit
399
350
        self.assertEqual(6+8, cache._value_size)
400
351
        self.assertEqual({'key2':'value2', 'key4':'value234'},
401
 
                         cache.items())
 
352
                         cache.as_dict())
402
353
 
403
354
    def test_adding_clears_to_after_cleanup_size(self):
404
355
        cache = lru_cache.LRUSizeCache(max_size=20, after_cleanup_size=10)
405
 
        cache.add('key1', 'value') # 5 chars
406
 
        cache.add('key2', 'value2') # 6 chars
407
 
        cache.add('key3', 'value23') # 7 chars
 
356
        cache['key1'] = 'value' # 5 chars
 
357
        cache['key2'] = 'value2' # 6 chars
 
358
        cache['key3'] = 'value23' # 7 chars
408
359
        self.assertEqual(5+6+7, cache._value_size)
409
360
        cache['key2'] # reference key2 so it gets a newer reference time
410
 
        cache.add('key4', 'value234') # 8 chars, over limit
 
361
        cache['key4'] = 'value234' # 8 chars, over limit
411
362
        # We have to remove 3 keys to get back under limit
412
363
        self.assertEqual(8, cache._value_size)
413
 
        self.assertEqual({'key4':'value234'}, cache.items())
 
364
        self.assertEqual({'key4':'value234'}, cache.as_dict())
414
365
 
415
366
    def test_custom_sizes(self):
416
367
        def size_of_list(lst):
418
369
        cache = lru_cache.LRUSizeCache(max_size=20, after_cleanup_size=10,
419
370
                                       compute_size=size_of_list)
420
371
 
421
 
        cache.add('key1', ['val', 'ue']) # 5 chars
422
 
        cache.add('key2', ['val', 'ue2']) # 6 chars
423
 
        cache.add('key3', ['val', 'ue23']) # 7 chars
 
372
        cache['key1'] = ['val', 'ue'] # 5 chars
 
373
        cache['key2'] = ['val', 'ue2'] # 6 chars
 
374
        cache['key3'] = ['val', 'ue23'] # 7 chars
424
375
        self.assertEqual(5+6+7, cache._value_size)
425
376
        cache['key2'] # reference key2 so it gets a newer reference time
426
 
        cache.add('key4', ['value', '234']) # 8 chars, over limit
 
377
        cache['key4'] = ['value', '234'] # 8 chars, over limit
427
378
        # We have to remove 3 keys to get back under limit
428
379
        self.assertEqual(8, cache._value_size)
429
 
        self.assertEqual({'key4':['value', '234']}, cache.items())
 
380
        self.assertEqual({'key4':['value', '234']}, cache.as_dict())
430
381
 
431
382
    def test_cleanup(self):
432
383
        cache = lru_cache.LRUSizeCache(max_size=20, after_cleanup_size=10)
433
384
 
434
385
        # Add these in order
435
 
        cache.add('key1', 'value') # 5 chars
436
 
        cache.add('key2', 'value2') # 6 chars
437
 
        cache.add('key3', 'value23') # 7 chars
 
386
        cache['key1'] = 'value' # 5 chars
 
387
        cache['key2'] = 'value2' # 6 chars
 
388
        cache['key3'] = 'value23' # 7 chars
438
389
        self.assertEqual(5+6+7, cache._value_size)
439
390
 
440
391
        cache.cleanup()