← 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: Canonical.com Patch Queue Manager
  • Date: 2009-01-13 05:14:24 UTC
  • mfrom: (3936.1.3 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20090113051424-nrk3zkfe09h46i9y
(mbp) merge 1.11 and advance to 1.12

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_lru_cache.py
1
 
# Copyright (C) 2006, 2008, 2009 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
 
 
38
28
    def test_missing(self):
39
29
        cache = lru_cache.LRUCache(max_cache=10)
40
30
 
41
 
        self.assertFalse('foo' in cache)
 
31
        self.failIf('foo' in cache)
42
32
        self.assertRaises(KeyError, cache.__getitem__, 'foo')
43
33
 
44
34
        cache['foo'] = 'bar'
45
35
        self.assertEqual('bar', cache['foo'])
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)
 
36
        self.failUnless('foo' in cache)
 
37
        self.failIf('bar' in cache)
69
38
 
70
39
    def test_overflow(self):
71
40
        """Adding extra entries will pop out old ones."""
75
44
        # With a max cache of 1, adding 'baz' should pop out 'foo'
76
45
        cache['baz'] = 'biz'
77
46
 
78
 
        self.assertFalse('foo' in cache)
79
 
        self.assertTrue('baz' in cache)
 
47
        self.failIf('foo' in cache)
 
48
        self.failUnless('baz' in cache)
80
49
 
81
50
        self.assertEqual('biz', cache['baz'])
82
51
 
92
61
        # This must kick out 'foo' because it was the last accessed
93
62
        cache['nub'] = 'in'
94
63
 
95
 
        self.assertFalse('foo' in cache)
 
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)
96
77
 
97
78
    def test_cleanup(self):
98
79
        """Test that we can use a cleanup function."""
111
92
        # 'foo' is now most recent, so final cleanup will call it last
112
93
        cache['foo']
113
94
        cache.clear()
114
 
        self.assertEqual([('baz', '1'), ('biz', '3'), ('foo', '2')],
115
 
                         cleanup_called)
 
95
        self.assertEqual([('baz', '1'), ('biz', '3'), ('foo', '2')], cleanup_called)
116
96
 
117
97
    def test_cleanup_on_replace(self):
118
98
        """Replacing an object should cleanup the old value."""
127
107
 
128
108
        self.assertEqual([(2, 20)], cleanup_called)
129
109
        self.assertEqual(25, cache[2])
130
 
 
 
110
        
131
111
        # Even __setitem__ should make sure cleanup() is called
132
112
        cache[2] = 26
133
113
        self.assertEqual([(2, 20), (2, 25)], cleanup_called)
134
114
 
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
 
 
172
115
    def test_len(self):
173
116
        cache = lru_cache.LRUCache(max_cache=10, after_cleanup_count=10)
174
117
 
196
139
 
197
140
        # We hit the max
198
141
        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()])
201
142
 
202
143
    def test_cleanup_shrinks_to_after_clean_count(self):
203
144
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=3)
238
179
        cache.cleanup()
239
180
        self.assertEqual(2, len(cache))
240
181
 
241
 
    def test_preserve_last_access_order(self):
 
182
    def test_compact_preserves_last_access_order(self):
242
183
        cache = lru_cache.LRUCache(max_cache=5)
243
184
 
244
185
        # Add these in order
248
189
        cache.add(4, 30)
249
190
        cache.add(5, 35)
250
191
 
251
 
        self.assertEqual([5, 4, 3, 2, 1], [n.key for n in cache._walk_lru()])
 
192
        self.assertEqual([1, 2, 3, 4, 5], list(cache._queue))
252
193
 
253
194
        # Now access some randomly
254
195
        cache[2]
255
196
        cache[5]
256
197
        cache[3]
257
198
        cache[2]
258
 
        self.assertEqual([2, 3, 5, 4, 1], [n.key for n in cache._walk_lru()])
 
199
        self.assertEqual([1, 2, 3, 4, 5, 2, 5, 3, 2], list(cache._queue))
 
200
        self.assertEqual({1:1, 2:3, 3:2, 4:1, 5:2}, cache._refcount)
 
201
 
 
202
        # Compacting should save the last position
 
203
        cache._compact_queue()
 
204
        self.assertEqual([1, 4, 5, 3, 2], list(cache._queue))
 
205
        self.assertEqual({1:1, 2:1, 3:1, 4:1, 5:1}, cache._refcount)
259
206
 
260
207
    def test_get(self):
261
208
        cache = lru_cache.LRUCache(max_cache=5)
266
213
        self.assertIs(None, cache.get(3))
267
214
        obj = object()
268
215
        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
216
 
273
217
    def test_keys(self):
274
218
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=5)
282
226
        cache[6] = 7
283
227
        self.assertEqual([2, 3, 4, 5, 6], sorted(cache.keys()))
284
228
 
 
229
    def test_after_cleanup_size_deprecated(self):
 
230
        obj = self.callDeprecated([
 
231
            'LRUCache.__init__(after_cleanup_size) was deprecated in 1.11.'
 
232
            ' Use after_cleanup_count instead.'],
 
233
            lru_cache.LRUCache, 50, after_cleanup_size=25)
 
234
        self.assertEqual(obj._after_cleanup_count, 25)
 
235
 
285
236
    def test_resize_smaller(self):
286
237
        cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=4)
287
238
        cache[1] = 2
327
278
    def test_basic_init(self):
328
279
        cache = lru_cache.LRUSizeCache()
329
280
        self.assertEqual(2048, cache._max_cache)
 
281
        self.assertEqual(4*2048, cache._compact_queue_length)
330
282
        self.assertEqual(int(cache._max_size*0.8), cache._after_cleanup_size)
331
283
        self.assertEqual(0, cache._value_size)
332
284
 
333
 
    def test_add__null_key(self):
334
 
        cache = lru_cache.LRUSizeCache()
335
 
        self.assertRaises(ValueError, cache.add, lru_cache._null_key, 1)
336
 
 
337
285
    def test_add_tracks_size(self):
338
286
        cache = lru_cache.LRUSizeCache()
339
287
        self.assertEqual(0, cache._value_size)
345
293
        self.assertEqual(0, cache._value_size)
346
294
        cache.add('my key', 'my value text')
347
295
        self.assertEqual(13, cache._value_size)
348
 
        node = cache._cache['my key']
349
 
        cache._remove_node(node)
 
296
        cache._remove('my key')
350
297
        self.assertEqual(0, cache._value_size)
351
298
 
352
299
    def test_no_add_over_size(self):
353
300
        """Adding a large value may not be cached at all."""
354
301
        cache = lru_cache.LRUSizeCache(max_size=10, after_cleanup_size=5)
355
302
        self.assertEqual(0, cache._value_size)
356
 
        self.assertEqual({}, cache.items())
 
303
        self.assertEqual({}, cache._cache)
357
304
        cache.add('test', 'key')
358
305
        self.assertEqual(3, cache._value_size)
359
 
        self.assertEqual({'test': 'key'}, cache.items())
 
306
        self.assertEqual({'test':'key'}, cache._cache)
360
307
        cache.add('test2', 'key that is too big')
361
308
        self.assertEqual(3, cache._value_size)
362
 
        self.assertEqual({'test':'key'}, cache.items())
 
309
        self.assertEqual({'test':'key'}, cache._cache)
363
310
        # If we would add a key, only to cleanup and remove all cached entries,
364
311
        # then obviously that value should not be stored
365
312
        cache.add('test3', 'bigkey')
366
313
        self.assertEqual(3, cache._value_size)
367
 
        self.assertEqual({'test':'key'}, cache.items())
 
314
        self.assertEqual({'test':'key'}, cache._cache)
368
315
 
369
316
        cache.add('test4', 'bikey')
370
317
        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)
 
318
        self.assertEqual({'test':'key'}, cache._cache)
388
319
 
389
320
    def test_adding_clears_cache_based_on_size(self):
390
321
        """The cache is cleared in LRU order until small enough"""
398
329
        # We have to remove 2 keys to get back under limit
399
330
        self.assertEqual(6+8, cache._value_size)
400
331
        self.assertEqual({'key2':'value2', 'key4':'value234'},
401
 
                         cache.items())
 
332
                         cache._cache)
402
333
 
403
334
    def test_adding_clears_to_after_cleanup_size(self):
404
335
        cache = lru_cache.LRUSizeCache(max_size=20, after_cleanup_size=10)
410
341
        cache.add('key4', 'value234') # 8 chars, over limit
411
342
        # We have to remove 3 keys to get back under limit
412
343
        self.assertEqual(8, cache._value_size)
413
 
        self.assertEqual({'key4':'value234'}, cache.items())
 
344
        self.assertEqual({'key4':'value234'}, cache._cache)
414
345
 
415
346
    def test_custom_sizes(self):
416
347
        def size_of_list(lst):
426
357
        cache.add('key4', ['value', '234']) # 8 chars, over limit
427
358
        # We have to remove 3 keys to get back under limit
428
359
        self.assertEqual(8, cache._value_size)
429
 
        self.assertEqual({'key4':['value', '234']}, cache.items())
 
360
        self.assertEqual({'key4':['value', '234']}, cache._cache)
430
361
 
431
362
    def test_cleanup(self):
432
363
        cache = lru_cache.LRUSizeCache(max_size=20, after_cleanup_size=10)