← 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

(jelmer) Support upgrading between the 2a and development-colo formats.
 (Jelmer Vernooij)

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, 2009 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
 
31
 
        self.failIf('foo' in cache)
 
41
        self.assertFalse('foo' in cache)
32
42
        self.assertRaises(KeyError, cache.__getitem__, 'foo')
33
43
 
34
44
        cache['foo'] = 'bar'
35
45
        self.assertEqual('bar', cache['foo'])
36
 
        self.failUnless('foo' in cache)
37
 
        self.failIf('bar' in cache)
 
46
        self.assertTrue('foo' in cache)
 
47
        self.assertFalse('bar' in cache)
 
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.assertFalse(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)
38
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'
45
76
        cache['baz'] = 'biz'
46
77
 
47
 
        self.failIf('foo' in cache)
48
 
        self.failUnless('baz' in cache)
 
78
        self.assertFalse('foo' in cache)
 
79
        self.assertTrue('baz' in cache)
49
80
 
50
81
        self.assertEqual('biz', cache['baz'])
51
82
 
61
92
        # This must kick out 'foo' because it was the last accessed
62
93
        cache['nub'] = 'in'
63
94
 
64
 
        self.failIf('foo' in cache)
65
 
 
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)
 
95
        self.assertFalse('foo' in cache)
77
96
 
78
97
    def test_cleanup(self):
79
98
        """Test that we can use a cleanup function."""
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
 
 
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()])
 
171
 
115
172
    def test_len(self):
116
 
        cache = lru_cache.LRUCache(max_cache=10)
 
173
        cache = lru_cache.LRUCache(max_cache=10, after_cleanup_count=10)
117
174
 
118
175
        cache[1] = 10
119
176
        cache[2] = 20
139
196
 
140
197
        # We hit the max
141
198
        self.assertEqual(10, len(cache))
 
199
        self.assertEqual([11, 10, 9, 1, 8, 7, 6, 5, 4, 3],
 
200
                         [n.key for n in cache._walk_lru()])
142
201
 
143
 
    def test_cleanup_shrinks_to_after_clean_size(self):
144
 
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_size=3)
 
202
    def test_cleanup_shrinks_to_after_clean_count(self):
 
203
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=3)
145
204
 
146
205
        cache.add(1, 10)
147
206
        cache.add(2, 20)
156
215
        self.assertEqual(3, len(cache))
157
216
 
158
217
    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)
 
218
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=10)
 
219
        self.assertEqual(5, cache._after_cleanup_count)
161
220
 
162
221
    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)
 
222
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=None)
 
223
        # By default _after_cleanup_size is 80% of the normal size
 
224
        self.assertEqual(4, cache._after_cleanup_count)
165
225
 
166
226
    def test_cleanup(self):
167
 
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_size=2)
 
227
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=2)
168
228
 
169
229
        # Add these in order
170
230
        cache.add(1, 10)
178
238
        cache.cleanup()
179
239
        self.assertEqual(2, len(cache))
180
240
 
181
 
    def test_compact_preserves_last_access_order(self):
 
241
    def test_preserve_last_access_order(self):
182
242
        cache = lru_cache.LRUCache(max_cache=5)
183
243
 
184
244
        # Add these in order
188
248
        cache.add(4, 30)
189
249
        cache.add(5, 35)
190
250
 
191
 
        self.assertEqual([1, 2, 3, 4, 5], list(cache._queue))
 
251
        self.assertEqual([5, 4, 3, 2, 1], [n.key for n in cache._walk_lru()])
192
252
 
193
253
        # Now access some randomly
194
254
        cache[2]
195
255
        cache[5]
196
256
        cache[3]
197
257
        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)
 
258
        self.assertEqual([2, 3, 5, 4, 1], [n.key for n in cache._walk_lru()])
205
259
 
206
260
    def test_get(self):
207
261
        cache = lru_cache.LRUCache(max_cache=5)
212
266
        self.assertIs(None, cache.get(3))
213
267
        obj = object()
214
268
        self.assertIs(obj, cache.get(3, obj))
 
269
        self.assertEqual([2, 1], [n.key for n in cache._walk_lru()])
 
270
        self.assertEqual(10, cache.get(1))
 
271
        self.assertEqual([1, 2], [n.key for n in cache._walk_lru()])
 
272
 
 
273
    def test_keys(self):
 
274
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=5)
 
275
 
 
276
        cache[1] = 2
 
277
        cache[2] = 3
 
278
        cache[3] = 4
 
279
        self.assertEqual([1, 2, 3], sorted(cache.keys()))
 
280
        cache[4] = 5
 
281
        cache[5] = 6
 
282
        cache[6] = 7
 
283
        self.assertEqual([2, 3, 4, 5, 6], sorted(cache.keys()))
 
284
 
 
285
    def test_resize_smaller(self):
 
286
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=4)
 
287
        cache[1] = 2
 
288
        cache[2] = 3
 
289
        cache[3] = 4
 
290
        cache[4] = 5
 
291
        cache[5] = 6
 
292
        self.assertEqual([1, 2, 3, 4, 5], sorted(cache.keys()))
 
293
        cache[6] = 7
 
294
        self.assertEqual([3, 4, 5, 6], sorted(cache.keys()))
 
295
        # Now resize to something smaller, which triggers a cleanup
 
296
        cache.resize(max_cache=3, after_cleanup_count=2)
 
297
        self.assertEqual([5, 6], sorted(cache.keys()))
 
298
        # Adding something will use the new size
 
299
        cache[7] = 8
 
300
        self.assertEqual([5, 6, 7], sorted(cache.keys()))
 
301
        cache[8] = 9
 
302
        self.assertEqual([7, 8], sorted(cache.keys()))
 
303
 
 
304
    def test_resize_larger(self):
 
305
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=4)
 
306
        cache[1] = 2
 
307
        cache[2] = 3
 
308
        cache[3] = 4
 
309
        cache[4] = 5
 
310
        cache[5] = 6
 
311
        self.assertEqual([1, 2, 3, 4, 5], sorted(cache.keys()))
 
312
        cache[6] = 7
 
313
        self.assertEqual([3, 4, 5, 6], sorted(cache.keys()))
 
314
        cache.resize(max_cache=8, after_cleanup_count=6)
 
315
        self.assertEqual([3, 4, 5, 6], sorted(cache.keys()))
 
316
        cache[7] = 8
 
317
        cache[8] = 9
 
318
        cache[9] = 10
 
319
        cache[10] = 11
 
320
        self.assertEqual([3, 4, 5, 6, 7, 8, 9, 10], sorted(cache.keys()))
 
321
        cache[11] = 12 # triggers cleanup back to new after_cleanup_count
 
322
        self.assertEqual([6, 7, 8, 9, 10, 11], sorted(cache.keys()))
215
323
 
216
324
 
217
325
class TestLRUSizeCache(tests.TestCase):
219
327
    def test_basic_init(self):
220
328
        cache = lru_cache.LRUSizeCache()
221
329
        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)
 
330
        self.assertEqual(int(cache._max_size*0.8), cache._after_cleanup_size)
224
331
        self.assertEqual(0, cache._value_size)
225
332
 
 
333
    def test_add__null_key(self):
 
334
        cache = lru_cache.LRUSizeCache()
 
335
        self.assertRaises(ValueError, cache.add, lru_cache._null_key, 1)
 
336
 
226
337
    def test_add_tracks_size(self):
227
338
        cache = lru_cache.LRUSizeCache()
228
339
        self.assertEqual(0, cache._value_size)
234
345
        self.assertEqual(0, cache._value_size)
235
346
        cache.add('my key', 'my value text')
236
347
        self.assertEqual(13, cache._value_size)
237
 
        cache._remove('my key')
 
348
        node = cache._cache['my key']
 
349
        cache._remove_node(node)
238
350
        self.assertEqual(0, cache._value_size)
239
351
 
240
352
    def test_no_add_over_size(self):
241
353
        """Adding a large value may not be cached at all."""
242
354
        cache = lru_cache.LRUSizeCache(max_size=10, after_cleanup_size=5)
243
355
        self.assertEqual(0, cache._value_size)
244
 
        self.assertEqual({}, cache._cache)
 
356
        self.assertEqual({}, cache.items())
245
357
        cache.add('test', 'key')
246
358
        self.assertEqual(3, cache._value_size)
247
 
        self.assertEqual({'test':'key'}, cache._cache)
 
359
        self.assertEqual({'test': 'key'}, cache.items())
248
360
        cache.add('test2', 'key that is too big')
249
361
        self.assertEqual(3, cache._value_size)
250
 
        self.assertEqual({'test':'key'}, cache._cache)
 
362
        self.assertEqual({'test':'key'}, cache.items())
251
363
        # If we would add a key, only to cleanup and remove all cached entries,
252
364
        # then obviously that value should not be stored
253
365
        cache.add('test3', 'bigkey')
254
366
        self.assertEqual(3, cache._value_size)
255
 
        self.assertEqual({'test':'key'}, cache._cache)
 
367
        self.assertEqual({'test':'key'}, cache.items())
256
368
 
257
369
        cache.add('test4', 'bikey')
258
370
        self.assertEqual(3, cache._value_size)
259
 
        self.assertEqual({'test':'key'}, cache._cache)
 
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)
260
388
 
261
389
    def test_adding_clears_cache_based_on_size(self):
262
390
        """The cache is cleared in LRU order until small enough"""
270
398
        # We have to remove 2 keys to get back under limit
271
399
        self.assertEqual(6+8, cache._value_size)
272
400
        self.assertEqual({'key2':'value2', 'key4':'value234'},
273
 
                         cache._cache)
 
401
                         cache.items())
274
402
 
275
403
    def test_adding_clears_to_after_cleanup_size(self):
276
404
        cache = lru_cache.LRUSizeCache(max_size=20, after_cleanup_size=10)
282
410
        cache.add('key4', 'value234') # 8 chars, over limit
283
411
        # We have to remove 3 keys to get back under limit
284
412
        self.assertEqual(8, cache._value_size)
285
 
        self.assertEqual({'key4':'value234'}, cache._cache)
 
413
        self.assertEqual({'key4':'value234'}, cache.items())
286
414
 
287
415
    def test_custom_sizes(self):
288
416
        def size_of_list(lst):
298
426
        cache.add('key4', ['value', '234']) # 8 chars, over limit
299
427
        # We have to remove 3 keys to get back under limit
300
428
        self.assertEqual(8, cache._value_size)
301
 
        self.assertEqual({'key4':['value', '234']}, cache._cache)
 
429
        self.assertEqual({'key4':['value', '234']}, cache.items())
302
430
 
303
431
    def test_cleanup(self):
304
432
        cache = lru_cache.LRUSizeCache(max_size=20, after_cleanup_size=10)
312
440
        cache.cleanup()
313
441
        # Only the most recent fits after cleaning up
314
442
        self.assertEqual(7, cache._value_size)
 
443
 
 
444
    def test_keys(self):
 
445
        cache = lru_cache.LRUSizeCache(max_size=10)
 
446
 
 
447
        cache[1] = 'a'
 
448
        cache[2] = 'b'
 
449
        cache[3] = 'cdef'
 
450
        self.assertEqual([1, 2, 3], sorted(cache.keys()))
 
451
 
 
452
    def test_resize_smaller(self):
 
453
        cache = lru_cache.LRUSizeCache(max_size=10, after_cleanup_size=9)
 
454
        cache[1] = 'abc'
 
455
        cache[2] = 'def'
 
456
        cache[3] = 'ghi'
 
457
        cache[4] = 'jkl'
 
458
        # Triggers a cleanup
 
459
        self.assertEqual([2, 3, 4], sorted(cache.keys()))
 
460
        # Resize should also cleanup again
 
461
        cache.resize(max_size=6, after_cleanup_size=4)
 
462
        self.assertEqual([4], sorted(cache.keys()))
 
463
        # Adding should use the new max size
 
464
        cache[5] = 'mno'
 
465
        self.assertEqual([4, 5], sorted(cache.keys()))
 
466
        cache[6] = 'pqr'
 
467
        self.assertEqual([6], sorted(cache.keys()))
 
468
 
 
469
    def test_resize_larger(self):
 
470
        cache = lru_cache.LRUSizeCache(max_size=10, after_cleanup_size=9)
 
471
        cache[1] = 'abc'
 
472
        cache[2] = 'def'
 
473
        cache[3] = 'ghi'
 
474
        cache[4] = 'jkl'
 
475
        # Triggers a cleanup
 
476
        self.assertEqual([2, 3, 4], sorted(cache.keys()))
 
477
        cache.resize(max_size=15, after_cleanup_size=12)
 
478
        self.assertEqual([2, 3, 4], sorted(cache.keys()))
 
479
        cache[5] = 'mno'
 
480
        cache[6] = 'pqr'
 
481
        self.assertEqual([2, 3, 4, 5, 6], sorted(cache.keys()))
 
482
        cache[7] = 'stu'
 
483
        self.assertEqual([4, 5, 6, 7], sorted(cache.keys()))
 
484