← 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: 2009-06-22 12:52:39 UTC
  • mto: (4471.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4472.
  • Revision ID: v.ladeuil+lp@free.fr-20090622125239-kabo9smxt9c3vnir
Use a consistent scheme for naming pyrex source files.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_lru_cache.py
1
 
# Copyright (C) 2006 Canonical Ltd
 
1
# Copyright (C) 2006, 2008 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
12
12
#
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Tests for the lru_cache module."""
18
18
 
25
25
class TestLRUCache(tests.TestCase):
26
26
    """Test that LRU cache properly keeps track of entries."""
27
27
 
 
28
    def test_cache_size(self):
 
29
        cache = lru_cache.LRUCache(max_cache=10)
 
30
        self.assertEqual(10, cache.cache_size())
 
31
 
 
32
        cache = lru_cache.LRUCache(max_cache=256)
 
33
        self.assertEqual(256, cache.cache_size())
 
34
 
 
35
        cache.resize(512)
 
36
        self.assertEqual(512, cache.cache_size())
 
37
 
28
38
    def test_missing(self):
29
39
        cache = lru_cache.LRUCache(max_cache=10)
30
40
 
36
46
        self.failUnless('foo' in cache)
37
47
        self.failIf('bar' in cache)
38
48
 
 
49
    def test_map_None(self):
 
50
        # Make sure that we can properly map None as a key.
 
51
        cache = lru_cache.LRUCache(max_cache=10)
 
52
        self.failIf(None in cache)
 
53
        cache[None] = 1
 
54
        self.assertEqual(1, cache[None])
 
55
        cache[None] = 2
 
56
        self.assertEqual(2, cache[None])
 
57
        # Test the various code paths of __getitem__, to make sure that we can
 
58
        # handle when None is the key for the LRU and the MRU
 
59
        cache[1] = 3
 
60
        cache[None] = 1
 
61
        cache[None]
 
62
        cache[1]
 
63
        cache[None]
 
64
        self.assertEqual([None, 1], [n.key for n in cache._walk_lru()])
 
65
 
 
66
    def test_add__null_key(self):
 
67
        cache = lru_cache.LRUCache(max_cache=10)
 
68
        self.assertRaises(ValueError, cache.add, lru_cache._null_key, 1)
 
69
 
39
70
    def test_overflow(self):
40
71
        """Adding extra entries will pop out old ones."""
41
 
        cache = lru_cache.LRUCache(max_cache=1)
 
72
        cache = lru_cache.LRUCache(max_cache=1, after_cleanup_count=1)
42
73
 
43
74
        cache['foo'] = 'bar'
44
75
        # With a max cache of 1, adding 'baz' should pop out 'foo'
63
94
 
64
95
        self.failIf('foo' in cache)
65
96
 
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)
69
 
 
70
 
        cache['baz'] = 'biz'
71
 
        cache['foo'] = 'bar'
72
 
 
73
 
        for i in xrange(1000):
74
 
            cache['baz']
75
 
 
76
 
        self.failUnless(len(cache._queue) < 40)
77
 
 
78
97
    def test_cleanup(self):
79
98
        """Test that we can use a cleanup function."""
80
99
        cleanup_called = []
92
111
        # 'foo' is now most recent, so final cleanup will call it last
93
112
        cache['foo']
94
113
        cache.clear()
95
 
        self.assertEqual([('baz', '1'), ('biz', '3'), ('foo', '2')], cleanup_called)
 
114
        self.assertEqual([('baz', '1'), ('biz', '3'), ('foo', '2')],
 
115
                         cleanup_called)
96
116
 
97
117
    def test_cleanup_on_replace(self):
98
118
        """Replacing an object should cleanup the old value."""
107
127
 
108
128
        self.assertEqual([(2, 20)], cleanup_called)
109
129
        self.assertEqual(25, cache[2])
110
 
        
 
130
 
111
131
        # Even __setitem__ should make sure cleanup() is called
112
132
        cache[2] = 26
113
133
        self.assertEqual([(2, 20), (2, 25)], cleanup_called)
114
134
 
115
135
    def test_len(self):
116
 
        cache = lru_cache.LRUCache(max_cache=10)
 
136
        cache = lru_cache.LRUCache(max_cache=10, after_cleanup_count=10)
117
137
 
118
138
        cache[1] = 10
119
139
        cache[2] = 20
139
159
 
140
160
        # We hit the max
141
161
        self.assertEqual(10, len(cache))
 
162
        self.assertEqual([11, 10, 9, 1, 8, 7, 6, 5, 4, 3],
 
163
                         [n.key for n in cache._walk_lru()])
142
164
 
143
 
    def test_cleanup_shrinks_to_after_clean_size(self):
144
 
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_size=3)
 
165
    def test_cleanup_shrinks_to_after_clean_count(self):
 
166
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=3)
145
167
 
146
168
        cache.add(1, 10)
147
169
        cache.add(2, 20)
156
178
        self.assertEqual(3, len(cache))
157
179
 
158
180
    def test_after_cleanup_larger_than_max(self):
159
 
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_size=10)
160
 
        self.assertEqual(5, cache._after_cleanup_size)
 
181
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=10)
 
182
        self.assertEqual(5, cache._after_cleanup_count)
161
183
 
162
184
    def test_after_cleanup_none(self):
163
 
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_size=None)
164
 
        self.assertEqual(5, cache._after_cleanup_size)
 
185
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=None)
 
186
        # By default _after_cleanup_size is 80% of the normal size
 
187
        self.assertEqual(4, cache._after_cleanup_count)
165
188
 
166
189
    def test_cleanup(self):
167
 
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_size=2)
 
190
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=2)
168
191
 
169
192
        # Add these in order
170
193
        cache.add(1, 10)
178
201
        cache.cleanup()
179
202
        self.assertEqual(2, len(cache))
180
203
 
181
 
    def test_compact_preserves_last_access_order(self):
 
204
    def test_preserve_last_access_order(self):
182
205
        cache = lru_cache.LRUCache(max_cache=5)
183
206
 
184
207
        # Add these in order
188
211
        cache.add(4, 30)
189
212
        cache.add(5, 35)
190
213
 
191
 
        self.assertEqual([1, 2, 3, 4, 5], list(cache._queue))
 
214
        self.assertEqual([5, 4, 3, 2, 1], [n.key for n in cache._walk_lru()])
192
215
 
193
216
        # Now access some randomly
194
217
        cache[2]
195
218
        cache[5]
196
219
        cache[3]
197
220
        cache[2]
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)
200
 
 
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)
 
221
        self.assertEqual([2, 3, 5, 4, 1], [n.key for n in cache._walk_lru()])
205
222
 
206
223
    def test_get(self):
207
224
        cache = lru_cache.LRUCache(max_cache=5)
212
229
        self.assertIs(None, cache.get(3))
213
230
        obj = object()
214
231
        self.assertIs(obj, cache.get(3, obj))
 
232
        self.assertEqual([2, 1], [n.key for n in cache._walk_lru()])
 
233
        self.assertEqual(10, cache.get(1))
 
234
        self.assertEqual([1, 2], [n.key for n in cache._walk_lru()])
 
235
 
 
236
    def test_keys(self):
 
237
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=5)
 
238
 
 
239
        cache[1] = 2
 
240
        cache[2] = 3
 
241
        cache[3] = 4
 
242
        self.assertEqual([1, 2, 3], sorted(cache.keys()))
 
243
        cache[4] = 5
 
244
        cache[5] = 6
 
245
        cache[6] = 7
 
246
        self.assertEqual([2, 3, 4, 5, 6], sorted(cache.keys()))
 
247
 
 
248
    def test_after_cleanup_size_deprecated(self):
 
249
        obj = self.callDeprecated([
 
250
            'LRUCache.__init__(after_cleanup_size) was deprecated in 1.11.'
 
251
            ' Use after_cleanup_count instead.'],
 
252
            lru_cache.LRUCache, 50, after_cleanup_size=25)
 
253
        self.assertEqual(obj._after_cleanup_count, 25)
 
254
 
 
255
    def test_resize_smaller(self):
 
256
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=4)
 
257
        cache[1] = 2
 
258
        cache[2] = 3
 
259
        cache[3] = 4
 
260
        cache[4] = 5
 
261
        cache[5] = 6
 
262
        self.assertEqual([1, 2, 3, 4, 5], sorted(cache.keys()))
 
263
        cache[6] = 7
 
264
        self.assertEqual([3, 4, 5, 6], sorted(cache.keys()))
 
265
        # Now resize to something smaller, which triggers a cleanup
 
266
        cache.resize(max_cache=3, after_cleanup_count=2)
 
267
        self.assertEqual([5, 6], sorted(cache.keys()))
 
268
        # Adding something will use the new size
 
269
        cache[7] = 8
 
270
        self.assertEqual([5, 6, 7], sorted(cache.keys()))
 
271
        cache[8] = 9
 
272
        self.assertEqual([7, 8], sorted(cache.keys()))
 
273
 
 
274
    def test_resize_larger(self):
 
275
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=4)
 
276
        cache[1] = 2
 
277
        cache[2] = 3
 
278
        cache[3] = 4
 
279
        cache[4] = 5
 
280
        cache[5] = 6
 
281
        self.assertEqual([1, 2, 3, 4, 5], sorted(cache.keys()))
 
282
        cache[6] = 7
 
283
        self.assertEqual([3, 4, 5, 6], sorted(cache.keys()))
 
284
        cache.resize(max_cache=8, after_cleanup_count=6)
 
285
        self.assertEqual([3, 4, 5, 6], sorted(cache.keys()))
 
286
        cache[7] = 8
 
287
        cache[8] = 9
 
288
        cache[9] = 10
 
289
        cache[10] = 11
 
290
        self.assertEqual([3, 4, 5, 6, 7, 8, 9, 10], sorted(cache.keys()))
 
291
        cache[11] = 12 # triggers cleanup back to new after_cleanup_count
 
292
        self.assertEqual([6, 7, 8, 9, 10, 11], sorted(cache.keys()))
215
293
 
216
294
 
217
295
class TestLRUSizeCache(tests.TestCase):
219
297
    def test_basic_init(self):
220
298
        cache = lru_cache.LRUSizeCache()
221
299
        self.assertEqual(2048, cache._max_cache)
222
 
        self.assertEqual(4*2048, cache._compact_queue_length)
223
 
        self.assertEqual(cache._max_size, cache._after_cleanup_size)
 
300
        self.assertEqual(int(cache._max_size*0.8), cache._after_cleanup_size)
224
301
        self.assertEqual(0, cache._value_size)
225
302
 
 
303
    def test_add__null_key(self):
 
304
        cache = lru_cache.LRUSizeCache()
 
305
        self.assertRaises(ValueError, cache.add, lru_cache._null_key, 1)
 
306
 
226
307
    def test_add_tracks_size(self):
227
308
        cache = lru_cache.LRUSizeCache()
228
309
        self.assertEqual(0, cache._value_size)
234
315
        self.assertEqual(0, cache._value_size)
235
316
        cache.add('my key', 'my value text')
236
317
        self.assertEqual(13, cache._value_size)
237
 
        cache._remove('my key')
 
318
        node = cache._cache['my key']
 
319
        cache._remove_node(node)
238
320
        self.assertEqual(0, cache._value_size)
239
321
 
240
322
    def test_no_add_over_size(self):
241
323
        """Adding a large value may not be cached at all."""
242
324
        cache = lru_cache.LRUSizeCache(max_size=10, after_cleanup_size=5)
243
325
        self.assertEqual(0, cache._value_size)
244
 
        self.assertEqual({}, cache._cache)
 
326
        self.assertEqual({}, cache.items())
245
327
        cache.add('test', 'key')
246
328
        self.assertEqual(3, cache._value_size)
247
 
        self.assertEqual({'test':'key'}, cache._cache)
 
329
        self.assertEqual({'test': 'key'}, cache.items())
248
330
        cache.add('test2', 'key that is too big')
249
331
        self.assertEqual(3, cache._value_size)
250
 
        self.assertEqual({'test':'key'}, cache._cache)
 
332
        self.assertEqual({'test':'key'}, cache.items())
251
333
        # If we would add a key, only to cleanup and remove all cached entries,
252
334
        # then obviously that value should not be stored
253
335
        cache.add('test3', 'bigkey')
254
336
        self.assertEqual(3, cache._value_size)
255
 
        self.assertEqual({'test':'key'}, cache._cache)
 
337
        self.assertEqual({'test':'key'}, cache.items())
256
338
 
257
339
        cache.add('test4', 'bikey')
258
340
        self.assertEqual(3, cache._value_size)
259
 
        self.assertEqual({'test':'key'}, cache._cache)
 
341
        self.assertEqual({'test':'key'}, cache.items())
 
342
 
 
343
    def test_no_add_over_size_cleanup(self):
 
344
        """If a large value is not cached, we will call cleanup right away."""
 
345
        cleanup_calls = []
 
346
        def cleanup(key, value):
 
347
            cleanup_calls.append((key, value))
 
348
 
 
349
        cache = lru_cache.LRUSizeCache(max_size=10, after_cleanup_size=5)
 
350
        self.assertEqual(0, cache._value_size)
 
351
        self.assertEqual({}, cache.items())
 
352
        cache.add('test', 'key that is too big', cleanup=cleanup)
 
353
        # key was not added
 
354
        self.assertEqual(0, cache._value_size)
 
355
        self.assertEqual({}, cache.items())
 
356
        # and cleanup was called
 
357
        self.assertEqual([('test', 'key that is too big')], cleanup_calls)
260
358
 
261
359
    def test_adding_clears_cache_based_on_size(self):
262
360
        """The cache is cleared in LRU order until small enough"""
270
368
        # We have to remove 2 keys to get back under limit
271
369
        self.assertEqual(6+8, cache._value_size)
272
370
        self.assertEqual({'key2':'value2', 'key4':'value234'},
273
 
                         cache._cache)
 
371
                         cache.items())
274
372
 
275
373
    def test_adding_clears_to_after_cleanup_size(self):
276
374
        cache = lru_cache.LRUSizeCache(max_size=20, after_cleanup_size=10)
282
380
        cache.add('key4', 'value234') # 8 chars, over limit
283
381
        # We have to remove 3 keys to get back under limit
284
382
        self.assertEqual(8, cache._value_size)
285
 
        self.assertEqual({'key4':'value234'}, cache._cache)
 
383
        self.assertEqual({'key4':'value234'}, cache.items())
286
384
 
287
385
    def test_custom_sizes(self):
288
386
        def size_of_list(lst):
298
396
        cache.add('key4', ['value', '234']) # 8 chars, over limit
299
397
        # We have to remove 3 keys to get back under limit
300
398
        self.assertEqual(8, cache._value_size)
301
 
        self.assertEqual({'key4':['value', '234']}, cache._cache)
 
399
        self.assertEqual({'key4':['value', '234']}, cache.items())
302
400
 
303
401
    def test_cleanup(self):
304
402
        cache = lru_cache.LRUSizeCache(max_size=20, after_cleanup_size=10)
312
410
        cache.cleanup()
313
411
        # Only the most recent fits after cleaning up
314
412
        self.assertEqual(7, cache._value_size)
 
413
 
 
414
    def test_keys(self):
 
415
        cache = lru_cache.LRUSizeCache(max_size=10)
 
416
 
 
417
        cache[1] = 'a'
 
418
        cache[2] = 'b'
 
419
        cache[3] = 'cdef'
 
420
        self.assertEqual([1, 2, 3], sorted(cache.keys()))
 
421
 
 
422
    def test_resize_smaller(self):
 
423
        cache = lru_cache.LRUSizeCache(max_size=10, after_cleanup_size=9)
 
424
        cache[1] = 'abc'
 
425
        cache[2] = 'def'
 
426
        cache[3] = 'ghi'
 
427
        cache[4] = 'jkl'
 
428
        # Triggers a cleanup
 
429
        self.assertEqual([2, 3, 4], sorted(cache.keys()))
 
430
        # Resize should also cleanup again
 
431
        cache.resize(max_size=6, after_cleanup_size=4)
 
432
        self.assertEqual([4], sorted(cache.keys()))
 
433
        # Adding should use the new max size
 
434
        cache[5] = 'mno'
 
435
        self.assertEqual([4, 5], sorted(cache.keys()))
 
436
        cache[6] = 'pqr'
 
437
        self.assertEqual([6], sorted(cache.keys()))
 
438
 
 
439
    def test_resize_larger(self):
 
440
        cache = lru_cache.LRUSizeCache(max_size=10, after_cleanup_size=9)
 
441
        cache[1] = 'abc'
 
442
        cache[2] = 'def'
 
443
        cache[3] = 'ghi'
 
444
        cache[4] = 'jkl'
 
445
        # Triggers a cleanup
 
446
        self.assertEqual([2, 3, 4], sorted(cache.keys()))
 
447
        cache.resize(max_size=15, after_cleanup_size=12)
 
448
        self.assertEqual([2, 3, 4], sorted(cache.keys()))
 
449
        cache[5] = 'mno'
 
450
        cache[6] = 'pqr'
 
451
        self.assertEqual([2, 3, 4, 5, 6], sorted(cache.keys()))
 
452
        cache[7] = 'stu'
 
453
        self.assertEqual([4, 5, 6, 7], sorted(cache.keys()))
 
454