Merge Dave's fixes for the compatibility tests and web.
[jelmer/dulwich-libgit2.git] / dulwich / tests / test_lru_cache.py
1 # Copyright (C) 2006, 2008 Canonical Ltd
2 #
3 # This program is free software; you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation; either version 2 of the License, or
6 # (at your option) any later version.
7 #
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 # GNU General Public License for more details.
12 #
13 # You should have received a copy of the GNU General Public License
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
16
17 """Tests for the lru_cache module."""
18
19 from dulwich import (
20     lru_cache,
21     )
22 import unittest
23
24
25 class TestLRUCache(unittest.TestCase):
26     """Test that LRU cache properly keeps track of entries."""
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     def test_missing(self):
39         cache = lru_cache.LRUCache(max_cache=10)
40
41         self.failIf('foo' in cache)
42         self.assertRaises(KeyError, cache.__getitem__, 'foo')
43
44         cache['foo'] = 'bar'
45         self.assertEqual('bar', cache['foo'])
46         self.failUnless('foo' in cache)
47         self.failIf('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.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
70     def test_overflow(self):
71         """Adding extra entries will pop out old ones."""
72         cache = lru_cache.LRUCache(max_cache=1, after_cleanup_count=1)
73
74         cache['foo'] = 'bar'
75         # With a max cache of 1, adding 'baz' should pop out 'foo'
76         cache['baz'] = 'biz'
77
78         self.failIf('foo' in cache)
79         self.failUnless('baz' in cache)
80
81         self.assertEqual('biz', cache['baz'])
82
83     def test_by_usage(self):
84         """Accessing entries bumps them up in priority."""
85         cache = lru_cache.LRUCache(max_cache=2)
86
87         cache['baz'] = 'biz'
88         cache['foo'] = 'bar'
89
90         self.assertEqual('biz', cache['baz'])
91
92         # This must kick out 'foo' because it was the last accessed
93         cache['nub'] = 'in'
94
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_len(self):
136         cache = lru_cache.LRUCache(max_cache=10, after_cleanup_count=10)
137
138         cache[1] = 10
139         cache[2] = 20
140         cache[3] = 30
141         cache[4] = 40
142
143         self.assertEqual(4, len(cache))
144
145         cache[5] = 50
146         cache[6] = 60
147         cache[7] = 70
148         cache[8] = 80
149
150         self.assertEqual(8, len(cache))
151
152         cache[1] = 15 # replacement
153
154         self.assertEqual(8, len(cache))
155
156         cache[9] = 90
157         cache[10] = 100
158         cache[11] = 110
159
160         # We hit the max
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()])
164
165     def test_cleanup_shrinks_to_after_clean_count(self):
166         cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=3)
167
168         cache.add(1, 10)
169         cache.add(2, 20)
170         cache.add(3, 25)
171         cache.add(4, 30)
172         cache.add(5, 35)
173
174         self.assertEqual(5, len(cache))
175         # This will bump us over the max, which causes us to shrink down to
176         # after_cleanup_cache size
177         cache.add(6, 40)
178         self.assertEqual(3, len(cache))
179
180     def test_after_cleanup_larger_than_max(self):
181         cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=10)
182         self.assertEqual(5, cache._after_cleanup_count)
183
184     def test_after_cleanup_none(self):
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)
188
189     def test_cleanup(self):
190         cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=2)
191
192         # Add these in order
193         cache.add(1, 10)
194         cache.add(2, 20)
195         cache.add(3, 25)
196         cache.add(4, 30)
197         cache.add(5, 35)
198
199         self.assertEqual(5, len(cache))
200         # Force a compaction
201         cache.cleanup()
202         self.assertEqual(2, len(cache))
203
204     def test_preserve_last_access_order(self):
205         cache = lru_cache.LRUCache(max_cache=5)
206
207         # Add these in order
208         cache.add(1, 10)
209         cache.add(2, 20)
210         cache.add(3, 25)
211         cache.add(4, 30)
212         cache.add(5, 35)
213
214         self.assertEqual([5, 4, 3, 2, 1], [n.key for n in cache._walk_lru()])
215
216         # Now access some randomly
217         cache[2]
218         cache[5]
219         cache[3]
220         cache[2]
221         self.assertEqual([2, 3, 5, 4, 1], [n.key for n in cache._walk_lru()])
222
223     def test_get(self):
224         cache = lru_cache.LRUCache(max_cache=5)
225
226         cache.add(1, 10)
227         cache.add(2, 20)
228         self.assertEqual(20, cache.get(2))
229         self.assertEquals(None, cache.get(3))
230         obj = object()
231         self.assertTrue(obj is 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_resize_smaller(self):
249         cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=4)
250         cache[1] = 2
251         cache[2] = 3
252         cache[3] = 4
253         cache[4] = 5
254         cache[5] = 6
255         self.assertEqual([1, 2, 3, 4, 5], sorted(cache.keys()))
256         cache[6] = 7
257         self.assertEqual([3, 4, 5, 6], sorted(cache.keys()))
258         # Now resize to something smaller, which triggers a cleanup
259         cache.resize(max_cache=3, after_cleanup_count=2)
260         self.assertEqual([5, 6], sorted(cache.keys()))
261         # Adding something will use the new size
262         cache[7] = 8
263         self.assertEqual([5, 6, 7], sorted(cache.keys()))
264         cache[8] = 9
265         self.assertEqual([7, 8], sorted(cache.keys()))
266
267     def test_resize_larger(self):
268         cache = lru_cache.LRUCache(max_cache=5, after_cleanup_count=4)
269         cache[1] = 2
270         cache[2] = 3
271         cache[3] = 4
272         cache[4] = 5
273         cache[5] = 6
274         self.assertEqual([1, 2, 3, 4, 5], sorted(cache.keys()))
275         cache[6] = 7
276         self.assertEqual([3, 4, 5, 6], sorted(cache.keys()))
277         cache.resize(max_cache=8, after_cleanup_count=6)
278         self.assertEqual([3, 4, 5, 6], sorted(cache.keys()))
279         cache[7] = 8
280         cache[8] = 9
281         cache[9] = 10
282         cache[10] = 11
283         self.assertEqual([3, 4, 5, 6, 7, 8, 9, 10], sorted(cache.keys()))
284         cache[11] = 12 # triggers cleanup back to new after_cleanup_count
285         self.assertEqual([6, 7, 8, 9, 10, 11], sorted(cache.keys()))
286
287
288 class TestLRUSizeCache(unittest.TestCase):
289
290     def test_basic_init(self):
291         cache = lru_cache.LRUSizeCache()
292         self.assertEqual(2048, cache._max_cache)
293         self.assertEqual(int(cache._max_size*0.8), cache._after_cleanup_size)
294         self.assertEqual(0, cache._value_size)
295
296     def test_add__null_key(self):
297         cache = lru_cache.LRUSizeCache()
298         self.assertRaises(ValueError, cache.add, lru_cache._null_key, 1)
299
300     def test_add_tracks_size(self):
301         cache = lru_cache.LRUSizeCache()
302         self.assertEqual(0, cache._value_size)
303         cache.add('my key', 'my value text')
304         self.assertEqual(13, cache._value_size)
305
306     def test_remove_tracks_size(self):
307         cache = lru_cache.LRUSizeCache()
308         self.assertEqual(0, cache._value_size)
309         cache.add('my key', 'my value text')
310         self.assertEqual(13, cache._value_size)
311         node = cache._cache['my key']
312         cache._remove_node(node)
313         self.assertEqual(0, cache._value_size)
314
315     def test_no_add_over_size(self):
316         """Adding a large value may not be cached at all."""
317         cache = lru_cache.LRUSizeCache(max_size=10, after_cleanup_size=5)
318         self.assertEqual(0, cache._value_size)
319         self.assertEqual({}, cache.items())
320         cache.add('test', 'key')
321         self.assertEqual(3, cache._value_size)
322         self.assertEqual({'test': 'key'}, cache.items())
323         cache.add('test2', 'key that is too big')
324         self.assertEqual(3, cache._value_size)
325         self.assertEqual({'test':'key'}, cache.items())
326         # If we would add a key, only to cleanup and remove all cached entries,
327         # then obviously that value should not be stored
328         cache.add('test3', 'bigkey')
329         self.assertEqual(3, cache._value_size)
330         self.assertEqual({'test':'key'}, cache.items())
331
332         cache.add('test4', 'bikey')
333         self.assertEqual(3, cache._value_size)
334         self.assertEqual({'test':'key'}, cache.items())
335
336     def test_no_add_over_size_cleanup(self):
337         """If a large value is not cached, we will call cleanup right away."""
338         cleanup_calls = []
339         def cleanup(key, value):
340             cleanup_calls.append((key, value))
341
342         cache = lru_cache.LRUSizeCache(max_size=10, after_cleanup_size=5)
343         self.assertEqual(0, cache._value_size)
344         self.assertEqual({}, cache.items())
345         cache.add('test', 'key that is too big', cleanup=cleanup)
346         # key was not added
347         self.assertEqual(0, cache._value_size)
348         self.assertEqual({}, cache.items())
349         # and cleanup was called
350         self.assertEqual([('test', 'key that is too big')], cleanup_calls)
351
352     def test_adding_clears_cache_based_on_size(self):
353         """The cache is cleared in LRU order until small enough"""
354         cache = lru_cache.LRUSizeCache(max_size=20)
355         cache.add('key1', 'value') # 5 chars
356         cache.add('key2', 'value2') # 6 chars
357         cache.add('key3', 'value23') # 7 chars
358         self.assertEqual(5+6+7, cache._value_size)
359         cache['key2'] # reference key2 so it gets a newer reference time
360         cache.add('key4', 'value234') # 8 chars, over limit
361         # We have to remove 2 keys to get back under limit
362         self.assertEqual(6+8, cache._value_size)
363         self.assertEqual({'key2':'value2', 'key4':'value234'},
364                          cache.items())
365
366     def test_adding_clears_to_after_cleanup_size(self):
367         cache = lru_cache.LRUSizeCache(max_size=20, after_cleanup_size=10)
368         cache.add('key1', 'value') # 5 chars
369         cache.add('key2', 'value2') # 6 chars
370         cache.add('key3', 'value23') # 7 chars
371         self.assertEqual(5+6+7, cache._value_size)
372         cache['key2'] # reference key2 so it gets a newer reference time
373         cache.add('key4', 'value234') # 8 chars, over limit
374         # We have to remove 3 keys to get back under limit
375         self.assertEqual(8, cache._value_size)
376         self.assertEqual({'key4':'value234'}, cache.items())
377
378     def test_custom_sizes(self):
379         def size_of_list(lst):
380             return sum(len(x) for x in lst)
381         cache = lru_cache.LRUSizeCache(max_size=20, after_cleanup_size=10,
382                                        compute_size=size_of_list)
383
384         cache.add('key1', ['val', 'ue']) # 5 chars
385         cache.add('key2', ['val', 'ue2']) # 6 chars
386         cache.add('key3', ['val', 'ue23']) # 7 chars
387         self.assertEqual(5+6+7, cache._value_size)
388         cache['key2'] # reference key2 so it gets a newer reference time
389         cache.add('key4', ['value', '234']) # 8 chars, over limit
390         # We have to remove 3 keys to get back under limit
391         self.assertEqual(8, cache._value_size)
392         self.assertEqual({'key4':['value', '234']}, cache.items())
393
394     def test_cleanup(self):
395         cache = lru_cache.LRUSizeCache(max_size=20, after_cleanup_size=10)
396
397         # Add these in order
398         cache.add('key1', 'value') # 5 chars
399         cache.add('key2', 'value2') # 6 chars
400         cache.add('key3', 'value23') # 7 chars
401         self.assertEqual(5+6+7, cache._value_size)
402
403         cache.cleanup()
404         # Only the most recent fits after cleaning up
405         self.assertEqual(7, cache._value_size)
406
407     def test_keys(self):
408         cache = lru_cache.LRUSizeCache(max_size=10)
409
410         cache[1] = 'a'
411         cache[2] = 'b'
412         cache[3] = 'cdef'
413         self.assertEqual([1, 2, 3], sorted(cache.keys()))
414
415     def test_resize_smaller(self):
416         cache = lru_cache.LRUSizeCache(max_size=10, after_cleanup_size=9)
417         cache[1] = 'abc'
418         cache[2] = 'def'
419         cache[3] = 'ghi'
420         cache[4] = 'jkl'
421         # Triggers a cleanup
422         self.assertEqual([2, 3, 4], sorted(cache.keys()))
423         # Resize should also cleanup again
424         cache.resize(max_size=6, after_cleanup_size=4)
425         self.assertEqual([4], sorted(cache.keys()))
426         # Adding should use the new max size
427         cache[5] = 'mno'
428         self.assertEqual([4, 5], sorted(cache.keys()))
429         cache[6] = 'pqr'
430         self.assertEqual([6], sorted(cache.keys()))
431
432     def test_resize_larger(self):
433         cache = lru_cache.LRUSizeCache(max_size=10, after_cleanup_size=9)
434         cache[1] = 'abc'
435         cache[2] = 'def'
436         cache[3] = 'ghi'
437         cache[4] = 'jkl'
438         # Triggers a cleanup
439         self.assertEqual([2, 3, 4], sorted(cache.keys()))
440         cache.resize(max_size=15, after_cleanup_size=12)
441         self.assertEqual([2, 3, 4], sorted(cache.keys()))
442         cache[5] = 'mno'
443         cache[6] = 'pqr'
444         self.assertEqual([2, 3, 4, 5, 6], sorted(cache.keys()))
445         cache[7] = 'stu'
446         self.assertEqual([4, 5, 6, 7], sorted(cache.keys()))
447