summaryrefslogtreecommitdiff
path: root/test/test_cache.py
blob: 41c628e1ec7ee2a309e2d91077c0ad066148d076 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
# unit tests for the cache module
# copyright 2003-2012 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
#
# This file is part of logilab-common.
#
# logilab-common is free software: you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the Free
# Software Foundation, either version 2.1 of the License, or (at your option) any
# later version.
#
# logilab-common is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License along
# with logilab-common.  If not, see <http://www.gnu.org/licenses/>.

from logilab.common.testlib import TestCase, unittest_main
from logilab.common.cache import Cache


class CacheTestCase(TestCase):
    def setUp(self):
        self.cache = Cache(5)
        self.testdict = {}

    def test_setitem1(self):
        """Checks that the setitem method works"""
        self.cache[1] = "foo"
        self.assertEqual(self.cache[1], "foo", "1:foo is not in cache")
        self.assertEqual(len(self.cache._usage), 1)
        self.assertEqual(self.cache._usage[-1], 1, "1 is not the most recently used key")
        self.assertCountEqual(
            self.cache._usage, self.cache.keys(), "usage list and data keys are different"
        )

    def test_setitem2(self):
        """Checks that the setitem method works for multiple items"""
        self.cache[1] = "foo"
        self.cache[2] = "bar"
        self.assertEqual(self.cache[2], "bar", "2 : 'bar' is not in cache.data")
        self.assertEqual(len(self.cache._usage), 2, "lenght of usage list is not 2")
        self.assertEqual(self.cache._usage[-1], 2, "1 is not the most recently used key")
        self.assertCountEqual(
            self.cache._usage, self.cache.keys()
        )  # usage list and data keys are different

    def test_setitem3(self):
        """Checks that the setitem method works when replacing an element in the cache"""
        self.cache[1] = "foo"
        self.cache[1] = "bar"
        self.assertEqual(self.cache[1], "bar", "1 : 'bar' is not in cache.data")
        self.assertEqual(len(self.cache._usage), 1, "lenght of usage list is not 1")
        self.assertEqual(self.cache._usage[-1], 1, "1 is not the most recently used key")
        self.assertCountEqual(
            self.cache._usage, self.cache.keys()
        )  # usage list and data keys are different

    def test_recycling1(self):
        """Checks the removal of old elements"""
        self.cache[1] = "foo"
        self.cache[2] = "bar"
        self.cache[3] = "baz"
        self.cache[4] = "foz"
        self.cache[5] = "fuz"
        self.cache[6] = "spam"
        self.assertTrue(
            1 not in self.cache, "key 1 has not been suppressed from the cache dictionnary"
        )
        self.assertTrue(
            1 not in self.cache._usage, "key 1 has not been suppressed from the cache LRU list"
        )
        self.assertEqual(len(self.cache._usage), 5, "lenght of usage list is not 5")
        self.assertEqual(self.cache._usage[-1], 6, "6 is not the most recently used key")
        self.assertCountEqual(
            self.cache._usage, self.cache.keys()
        )  # usage list and data keys are different

    def test_recycling2(self):
        """Checks that accessed elements get in the front of the list"""
        self.cache[1] = "foo"
        self.cache[2] = "bar"
        self.cache[3] = "baz"
        self.cache[4] = "foz"
        a = self.cache[1]
        self.assertEqual(a, "foo")
        self.assertEqual(self.cache._usage[-1], 1, "1 is not the most recently used key")
        self.assertCountEqual(
            self.cache._usage, self.cache.keys()
        )  # usage list and data keys are different

    def test_delitem(self):
        """Checks that elements are removed from both element dict and element
        list.
        """
        self.cache["foo"] = "bar"
        del self.cache["foo"]
        self.assertTrue(
            "foo" not in self.cache.keys(), "Element 'foo' was not removed cache dictionnary"
        )
        self.assertTrue("foo" not in self.cache._usage, "Element 'foo' was not removed usage list")
        self.assertCountEqual(
            self.cache._usage, self.cache.keys()
        )  # usage list and data keys are different

    def test_nullsize(self):
        """Checks that a 'NULL' size cache doesn't store anything"""
        null_cache = Cache(0)
        null_cache["foo"] = "bar"
        self.assertEqual(null_cache.size, 0, "Cache size should be O, not %d" % null_cache.size)
        self.assertEqual(len(null_cache), 0, "Cache should be empty !")
        # Assert null_cache['foo'] raises a KeyError
        self.assertRaises(KeyError, null_cache.__getitem__, "foo")
        # Deleting element raises a KeyError
        self.assertRaises(KeyError, null_cache.__delitem__, "foo")

    def test_getitem(self):
        """Checks that getitem doest not modify the _usage attribute"""
        try:
            self.cache["toto"]
        except KeyError:
            self.assertTrue("toto" not in self.cache._usage)
        else:
            self.fail("excepted KeyError")


if __name__ == "__main__":
    unittest_main()