13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""Tests for the lru_cache module."""
19
19
from bzrlib import (
27
"""Test helper to walk the LRU list and assert its consistency"""
28
node = lru._most_recently_used
30
if node.prev is not None:
31
raise AssertionError('the _most_recently_used entry is not'
32
' supposed to have a previous entry'
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,))
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,))
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'
51
if node.prev.next_key != node.key:
52
raise AssertionError('inconsistency found, node.prev.next'
53
' != node: %s' % (node,))
58
25
class TestLRUCache(tests.TestCase):
59
26
"""Test that LRU cache properly keeps track of entries."""
61
def test_cache_size(self):
62
cache = lru_cache.LRUCache(max_cache=10)
63
self.assertEqual(10, cache.cache_size())
65
cache = lru_cache.LRUCache(max_cache=256)
66
self.assertEqual(256, cache.cache_size())
69
self.assertEqual(512, cache.cache_size())
71
28
def test_missing(self):
72
29
cache = lru_cache.LRUCache(max_cache=10)
74
self.assertFalse('foo' in cache)
31
self.failIf('foo' in cache)
75
32
self.assertRaises(KeyError, cache.__getitem__, 'foo')
77
34
cache['foo'] = 'bar'
78
35
self.assertEqual('bar', cache['foo'])
79
self.assertTrue('foo' in cache)
80
self.assertFalse('bar' in cache)
82
def test_map_None(self):
83
# Make sure that we can properly map None as a key.
84
cache = lru_cache.LRUCache(max_cache=10)
85
self.assertFalse(None in cache)
87
self.assertEqual(1, cache[None])
89
self.assertEqual(2, cache[None])
90
# Test the various code paths of __getitem__, to make sure that we can
91
# handle when None is the key for the LRU and the MRU
97
self.assertEqual([None, 1], [n.key for n in walk_lru(cache)])
99
def test_add__null_key(self):
100
cache = lru_cache.LRUCache(max_cache=10)
101
self.assertRaises(ValueError,
102
cache.__setitem__, lru_cache._null_key, 1)
36
self.failUnless('foo' in cache)
37
self.failIf('bar' in cache)
104
39
def test_overflow(self):
105
40
"""Adding extra entries will pop out old ones."""
106
cache = lru_cache.LRUCache(max_cache=1, after_cleanup_count=1)
41
cache = lru_cache.LRUCache(max_cache=1)
108
43
cache['foo'] = 'bar'
109
44
# With a max cache of 1, adding 'baz' should pop out 'foo'
110
45
cache['baz'] = 'biz'
112
self.assertFalse('foo' in cache)
113
self.assertTrue('baz' in cache)
47
self.failIf('foo' in cache)
48
self.failUnless('baz' in cache)
115
50
self.assertEqual('biz', cache['baz'])
126
61
# This must kick out 'foo' because it was the last accessed
127
62
cache['nub'] = 'in'
129
self.assertFalse('foo' in cache)
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)
64
self.failIf('foo' in cache)
66
def test_queue_stays_bounded(self):
67
"""Lots of accesses does not cause the queue to grow without bound."""
68
cache = lru_cache.LRUCache(max_cache=10)
73
for i in xrange(1000):
76
self.failUnless(len(cache._queue) < 40)
78
def test_cleanup(self):
79
"""Test that we can use a cleanup function."""
81
def cleanup_func(key, val):
82
cleanup_called.append((key, val))
84
cache = lru_cache.LRUCache(max_cache=2)
86
cache.add('baz', '1', cleanup=cleanup_func)
87
cache.add('foo', '2', cleanup=cleanup_func)
88
cache.add('biz', '3', cleanup=cleanup_func)
90
self.assertEqual([('baz', '1')], cleanup_called)
92
# 'foo' is now most recent, so final cleanup will call it last
95
self.assertEqual([('baz', '1'), ('biz', '3'), ('foo', '2')], cleanup_called)
97
def test_cleanup_on_replace(self):
98
"""Replacing an object should cleanup the old value."""
100
def cleanup_func(key, val):
101
cleanup_called.append((key, val))
103
cache = lru_cache.LRUCache(max_cache=2)
104
cache.add(1, 10, cleanup=cleanup_func)
105
cache.add(2, 20, cleanup=cleanup_func)
106
cache.add(2, 25, cleanup=cleanup_func)
108
self.assertEqual([(2, 20)], cleanup_called)
109
self.assertEqual(25, cache[2])
111
# Even __setitem__ should make sure cleanup() is called
113
self.assertEqual([(2, 20), (2, 25)], cleanup_called)
138
115
def test_len(self):
139
cache = lru_cache.LRUCache(max_cache=10, after_cleanup_count=10)
116
cache = lru_cache.LRUCache(max_cache=10)
164
141
self.assertEqual(10, len(cache))
165
self.assertEqual([11, 10, 9, 1, 8, 7, 6, 5, 4, 3],
166
[n.key for n in walk_lru(cache)])
168
def test_cleanup_shrinks_to_after_clean_count(self):
169
cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=3)
143
def test_cleanup_shrinks_to_after_clean_size(self):
144
cache = lru_cache.LRUCache(max_cache=5, after_cleanup_size=3)
177
152
self.assertEqual(5, len(cache))
178
153
# This will bump us over the max, which causes us to shrink down to
179
154
# after_cleanup_cache size
181
156
self.assertEqual(3, len(cache))
183
158
def test_after_cleanup_larger_than_max(self):
184
cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=10)
185
self.assertEqual(5, cache._after_cleanup_count)
159
cache = lru_cache.LRUCache(max_cache=5, after_cleanup_size=10)
160
self.assertEqual(5, cache._after_cleanup_size)
187
162
def test_after_cleanup_none(self):
188
cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=None)
189
# By default _after_cleanup_size is 80% of the normal size
190
self.assertEqual(4, cache._after_cleanup_count)
163
cache = lru_cache.LRUCache(max_cache=5, after_cleanup_size=None)
164
self.assertEqual(5, cache._after_cleanup_size)
192
166
def test_cleanup(self):
193
cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=2)
167
cache = lru_cache.LRUCache(max_cache=5, after_cleanup_size=2)
195
169
# Add these in order
202
176
self.assertEqual(5, len(cache))
203
177
# Force a compaction
205
179
self.assertEqual(2, len(cache))
207
def test_preserve_last_access_order(self):
181
def test_compact_preserves_last_access_order(self):
208
182
cache = lru_cache.LRUCache(max_cache=5)
210
184
# Add these in order
217
self.assertEqual([5, 4, 3, 2, 1], [n.key for n in walk_lru(cache)])
191
self.assertEqual([1, 2, 3, 4, 5], list(cache._queue))
219
193
# Now access some randomly
224
self.assertEqual([2, 3, 5, 4, 1], [n.key for n in walk_lru(cache)])
198
self.assertEqual([1, 2, 3, 4, 5, 2, 5, 3, 2], list(cache._queue))
199
self.assertEqual({1:1, 2:3, 3:2, 4:1, 5:2}, cache._refcount)
201
# Compacting should save the last position
202
cache._compact_queue()
203
self.assertEqual([1, 4, 5, 3, 2], list(cache._queue))
204
self.assertEqual({1:1, 2:1, 3:1, 4:1, 5:1}, cache._refcount)
226
206
def test_get(self):
227
207
cache = lru_cache.LRUCache(max_cache=5)
231
211
self.assertEqual(20, cache.get(2))
232
212
self.assertIs(None, cache.get(3))
234
214
self.assertIs(obj, cache.get(3, obj))
235
self.assertEqual([2, 1], [n.key for n in walk_lru(cache)])
236
self.assertEqual(10, cache.get(1))
237
self.assertEqual([1, 2], [n.key for n in walk_lru(cache)])
240
cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=5)
245
self.assertEqual([1, 2, 3], sorted(cache.keys()))
249
self.assertEqual([2, 3, 4, 5, 6], sorted(cache.keys()))
251
def test_resize_smaller(self):
252
cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=4)
258
self.assertEqual([1, 2, 3, 4, 5], sorted(cache.keys()))
260
self.assertEqual([3, 4, 5, 6], sorted(cache.keys()))
261
# Now resize to something smaller, which triggers a cleanup
262
cache.resize(max_cache=3, after_cleanup_count=2)
263
self.assertEqual([5, 6], sorted(cache.keys()))
264
# Adding something will use the new size
266
self.assertEqual([5, 6, 7], sorted(cache.keys()))
268
self.assertEqual([7, 8], sorted(cache.keys()))
270
def test_resize_larger(self):
271
cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=4)
277
self.assertEqual([1, 2, 3, 4, 5], sorted(cache.keys()))
279
self.assertEqual([3, 4, 5, 6], sorted(cache.keys()))
280
cache.resize(max_cache=8, after_cleanup_count=6)
281
self.assertEqual([3, 4, 5, 6], sorted(cache.keys()))
286
self.assertEqual([3, 4, 5, 6, 7, 8, 9, 10], sorted(cache.keys()))
287
cache[11] = 12 # triggers cleanup back to new after_cleanup_count
288
self.assertEqual([6, 7, 8, 9, 10, 11], sorted(cache.keys()))
291
217
class TestLRUSizeCache(tests.TestCase):
293
219
def test_basic_init(self):
294
220
cache = lru_cache.LRUSizeCache()
295
221
self.assertEqual(2048, cache._max_cache)
296
self.assertEqual(int(cache._max_size*0.8), cache._after_cleanup_size)
222
self.assertEqual(4*2048, cache._compact_queue_length)
223
self.assertEqual(cache._max_size, cache._after_cleanup_size)
297
224
self.assertEqual(0, cache._value_size)
299
def test_add__null_key(self):
300
cache = lru_cache.LRUSizeCache()
301
self.assertRaises(ValueError,
302
cache.__setitem__, lru_cache._null_key, 1)
304
226
def test_add_tracks_size(self):
305
227
cache = lru_cache.LRUSizeCache()
306
228
self.assertEqual(0, cache._value_size)
307
cache['my key'] = 'my value text'
229
cache.add('my key', 'my value text')
308
230
self.assertEqual(13, cache._value_size)
310
232
def test_remove_tracks_size(self):
311
233
cache = lru_cache.LRUSizeCache()
312
234
self.assertEqual(0, cache._value_size)
313
cache['my key'] = 'my value text'
235
cache.add('my key', 'my value text')
314
236
self.assertEqual(13, cache._value_size)
315
node = cache._cache['my key']
316
cache._remove_node(node)
237
cache._remove('my key')
317
238
self.assertEqual(0, cache._value_size)
319
240
def test_no_add_over_size(self):
320
241
"""Adding a large value may not be cached at all."""
321
242
cache = lru_cache.LRUSizeCache(max_size=10, after_cleanup_size=5)
322
243
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())
244
self.assertEqual({}, cache._cache)
245
cache.add('test', 'key')
246
self.assertEqual(3, cache._value_size)
247
self.assertEqual({'test':'key'}, cache._cache)
248
cache.add('test2', 'key that is too big')
249
self.assertEqual(3, cache._value_size)
250
self.assertEqual({'test':'key'}, cache._cache)
330
251
# If we would add a key, only to cleanup and remove all cached entries,
331
252
# then obviously that value should not be stored
332
cache['test3'] = 'bigkey'
253
cache.add('test3', 'bigkey')
333
254
self.assertEqual(3, cache._value_size)
334
self.assertEqual({'test':'key'}, cache.as_dict())
255
self.assertEqual({'test':'key'}, cache._cache)
336
cache['test4'] = 'bikey'
257
cache.add('test4', 'bikey')
337
258
self.assertEqual(3, cache._value_size)
338
self.assertEqual({'test':'key'}, cache.as_dict())
259
self.assertEqual({'test':'key'}, cache._cache)
340
261
def test_adding_clears_cache_based_on_size(self):
341
262
"""The cache is cleared in LRU order until small enough"""
342
263
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
264
cache.add('key1', 'value') # 5 chars
265
cache.add('key2', 'value2') # 6 chars
266
cache.add('key3', 'value23') # 7 chars
346
267
self.assertEqual(5+6+7, cache._value_size)
347
268
cache['key2'] # reference key2 so it gets a newer reference time
348
cache['key4'] = 'value234' # 8 chars, over limit
269
cache.add('key4', 'value234') # 8 chars, over limit
349
270
# We have to remove 2 keys to get back under limit
350
271
self.assertEqual(6+8, cache._value_size)
351
272
self.assertEqual({'key2':'value2', 'key4':'value234'},
354
275
def test_adding_clears_to_after_cleanup_size(self):
355
276
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
277
cache.add('key1', 'value') # 5 chars
278
cache.add('key2', 'value2') # 6 chars
279
cache.add('key3', 'value23') # 7 chars
359
280
self.assertEqual(5+6+7, cache._value_size)
360
281
cache['key2'] # reference key2 so it gets a newer reference time
361
cache['key4'] = 'value234' # 8 chars, over limit
282
cache.add('key4', 'value234') # 8 chars, over limit
362
283
# We have to remove 3 keys to get back under limit
363
284
self.assertEqual(8, cache._value_size)
364
self.assertEqual({'key4':'value234'}, cache.as_dict())
285
self.assertEqual({'key4':'value234'}, cache._cache)
366
287
def test_custom_sizes(self):
367
288
def size_of_list(lst):
369
290
cache = lru_cache.LRUSizeCache(max_size=20, after_cleanup_size=10,
370
291
compute_size=size_of_list)
372
cache['key1'] = ['val', 'ue'] # 5 chars
373
cache['key2'] = ['val', 'ue2'] # 6 chars
374
cache['key3'] = ['val', 'ue23'] # 7 chars
293
cache.add('key1', ['val', 'ue']) # 5 chars
294
cache.add('key2', ['val', 'ue2']) # 6 chars
295
cache.add('key3', ['val', 'ue23']) # 7 chars
375
296
self.assertEqual(5+6+7, cache._value_size)
376
297
cache['key2'] # reference key2 so it gets a newer reference time
377
cache['key4'] = ['value', '234'] # 8 chars, over limit
298
cache.add('key4', ['value', '234']) # 8 chars, over limit
378
299
# We have to remove 3 keys to get back under limit
379
300
self.assertEqual(8, cache._value_size)
380
self.assertEqual({'key4':['value', '234']}, cache.as_dict())
301
self.assertEqual({'key4':['value', '234']}, cache._cache)
382
303
def test_cleanup(self):
383
304
cache = lru_cache.LRUSizeCache(max_size=20, after_cleanup_size=10)
385
306
# Add these in order
386
cache['key1'] = 'value' # 5 chars
387
cache['key2'] = 'value2' # 6 chars
388
cache['key3'] = 'value23' # 7 chars
307
cache.add('key1', 'value') # 5 chars
308
cache.add('key2', 'value2') # 6 chars
309
cache.add('key3', 'value23') # 7 chars
389
310
self.assertEqual(5+6+7, cache._value_size)
392
313
# Only the most recent fits after cleaning up
393
314
self.assertEqual(7, cache._value_size)
396
cache = lru_cache.LRUSizeCache(max_size=10)
401
self.assertEqual([1, 2, 3], sorted(cache.keys()))
403
def test_resize_smaller(self):
404
cache = lru_cache.LRUSizeCache(max_size=10, after_cleanup_size=9)
410
self.assertEqual([2, 3, 4], sorted(cache.keys()))
411
# Resize should also cleanup again
412
cache.resize(max_size=6, after_cleanup_size=4)
413
self.assertEqual([4], sorted(cache.keys()))
414
# Adding should use the new max size
416
self.assertEqual([4, 5], sorted(cache.keys()))
418
self.assertEqual([6], sorted(cache.keys()))
420
def test_resize_larger(self):
421
cache = lru_cache.LRUSizeCache(max_size=10, after_cleanup_size=9)
427
self.assertEqual([2, 3, 4], sorted(cache.keys()))
428
cache.resize(max_size=15, after_cleanup_size=12)
429
self.assertEqual([2, 3, 4], sorted(cache.keys()))
432
self.assertEqual([2, 3, 4, 5, 6], sorted(cache.keys()))
434
self.assertEqual([4, 5, 6, 7], sorted(cache.keys()))
added
removed
bzrlib/tests/test_lru_cache.py
