← 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: 2010-09-28 08:57:31 UTC
  • mto: (5490.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 5492.
  • Revision ID: v.ladeuil+lp@free.fr-20100928085731-8h0duqj5wf4acsgy
Add -m to search for a regexp in news entries instead of the bug number.

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