summaryrefslogtreecommitdiffstats
path: root/networking-odl/networking_odl/tests/unit/common/test_cache.py
blob: b702455eda78fa0afba5a806530cc5ab8600f04e (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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
# Copyright (c) 2015 OpenStack Foundation
# All Rights Reserved.
#
#    Licensed under the Apache License, Version 2.0 (the "License"); you may
#    not use this file except in compliance with the License. You may obtain
#    a copy of the License at
#
#         http://www.apache.org/licenses/LICENSE-2.0
#
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
#    License for the specific language governing permissions and limitations
#    under the License.

import mock

from neutron.tests import base

from networking_odl.common import cache


class TestCache(base.DietTestCase):

    def test_init_with_callable(self):

        def given_fetch_method():
            pass

        cache.Cache(given_fetch_method)

    def test_init_without_callable(self):
        self.assertRaises(TypeError, lambda: cache.Cache(object()))

    def test_fecth_once(self):
        value = 'value'

        given_fetch_method = mock.Mock(return_value=iter([('key', value)]))
        given_cache = cache.Cache(given_fetch_method)

        # When value with key is fetched
        result = given_cache.fetch('key', 60.0)

        # Result is returned
        self.assertIs(value, result)

        # Then fetch method is called once
        given_fetch_method.assert_called_once_with(('key',))

    def test_fecth_with_no_result(self):
        given_fetch_method = mock.Mock(return_value=iter([]))
        given_cache = cache.Cache(given_fetch_method)

        # When value with key is fetched
        try:
            given_cache.fetch('key', 60.0)
        except cache.CacheFetchError as error:
            given_fetch_method.assert_called_once_with(('key',))
            self.assertRaises(KeyError, error.reraise_cause)
        else:
            self.fail('Expecting CacheFetchError to be raised.')

    @mock.patch.object(cache, 'LOG')
    def test_fecth_with_failure(self, logger):
        # pylint: disable=unused-argument

        given_error = RuntimeError("It doesn't work like this!")

        def failing_function(keys):
            raise given_error

        given_fetch_method = mock.Mock(side_effect=failing_function)
        given_cache = cache.Cache(given_fetch_method)

        # When value with key is fetched
        try:
            given_cache.fetch('key', 60.0)
        except cache.CacheFetchError as error:
            given_fetch_method.assert_called_once_with(('key',))
            self.assertRaises(RuntimeError, error.reraise_cause)
        else:
            self.fail('Expecting CacheFetchError to be raised.')
        logger.warning.assert_called_once_with(
            'Error fetching values for keys: %r', "'key'",
            exc_info=(type(given_error), given_error, mock.ANY))

    def test_fecth_again_after_clear(self):
        value1 = 'value1'
        value2 = 'value2'
        given_fetch_method = mock.Mock(
            side_effect=[iter([('key', value1)]),
                         iter([('key', value2)])])
        given_cache = cache.Cache(given_fetch_method)

        # When value with key is fetched
        result1 = given_cache.fetch('key', 60.0)

        # When cache is cleared
        given_cache.clear()

        # When value with same key is fetched again
        result2 = given_cache.fetch('key', 0.0)

        # Then first result is returned
        self.assertIs(value1, result1)

        # Then fetch method is called twice
        self.assertEqual(
            [mock.call(('key',)), mock.call(('key',))],
            given_fetch_method.mock_calls)

        # Then second result is returned
        self.assertIs(value2, result2)

    def test_fecth_again_before_timeout(self):
        value1 = 'value1'
        value2 = 'value2'
        given_fetch_method = mock.Mock(
            side_effect=[iter([('key', value1)]),
                         iter([('key', value2)])])
        given_cache = cache.Cache(given_fetch_method)

        # When value with key is fetched
        result1 = given_cache.fetch('key', 1.0)

        # When value with same key is fetched again and cached entry is not
        # expired
        result2 = given_cache.fetch('key', 0.0)

        # First result is returned
        self.assertIs(value1, result1)

        # Then fetch method is called once
        given_fetch_method.assert_called_once_with(('key',))

        # Then first result is returned twice
        self.assertIs(value1, result2)

    def test_fecth_again_after_timeout(self):
        value1 = 'value1'
        value2 = 'value2'
        given_fetch_method = mock.Mock(
            side_effect=[iter([('key', value1)]),
                         iter([('key', value2)])])
        given_cache = cache.Cache(given_fetch_method)

        # When value with key is fetched
        result1 = given_cache.fetch('key', 0.0)

        # When value with same key is fetched again and cached entry is
        # expired
        result2 = given_cache.fetch('key', 0.0)

        # Then first result is returned
        self.assertIs(value1, result1)

        # Then fetch method is called twice
        self.assertEqual(
            [mock.call(('key',)), mock.call(('key',))],
            given_fetch_method.mock_calls)

        # Then second result is returned
        self.assertIs(value2, result2)

    def test_fecth_two_values_yielding_both_before_timeout(self):
        value1 = 'value1'
        value2 = 'value2'
        given_fetch_method = mock.Mock(
            return_value=iter([('key1', value1),
                               ('key2', value2)]))
        given_cache = cache.Cache(given_fetch_method)

        # When value with key is fetched
        result1 = given_cache.fetch('key1', 60.0)

        # When value with another key is fetched and cached entry is not
        # expired
        result2 = given_cache.fetch('key2', 60.0)

        # Then first result is returned
        self.assertIs(value1, result1)

        # Then fetch method is called once
        given_fetch_method.assert_called_once_with(('key1',))

        # Then second result is returned
        self.assertIs(value2, result2)

    def test_fecth_two_values_yielding_both_after_timeout(self):
        value1 = 'value1'
        value2 = 'value2'
        given_fetch_method = mock.Mock(
            return_value=[('key1', value1), ('key2', value2)])
        given_cache = cache.Cache(given_fetch_method)

        # When value with key is fetched
        result1 = given_cache.fetch('key1', 0.0)

        # When value with another key is fetched and cached entry is
        # expired
        result2 = given_cache.fetch('key2', 0.0)

        # Then first result is returned
        self.assertIs(value1, result1)

        # Then fetch method is called twice
        self.assertEqual(
            [mock.call(('key1',)), mock.call(('key2',))],
            given_fetch_method.mock_calls)

        # Then second result is returned
        self.assertIs(value2, result2)

    def test_fecth_all_with_multiple_entries(self):
        given_fetch_method = mock.Mock(
            return_value=iter([('key', 'value1'),
                               ('key', 'value2')]))
        given_cache = cache.Cache(given_fetch_method)

        # When value with key is fetched
        results = list(given_cache.fetch_all(['key'], 0.0))

        # Then fetch method is once
        given_fetch_method.assert_called_once_with(('key',))

        # Then both results are yield in the right order
        self.assertEqual([('key', 'value1'), ('key', 'value2')], results)

    def test_fecth_all_with_repeated_entries(self):
        entry = ('key', 'value')
        given_fetch_method = mock.Mock(
            return_value=iter([entry, entry, entry]))
        given_cache = cache.Cache(given_fetch_method)

        # When value with key is fetched
        results = list(given_cache.fetch_all(['key'], 0.0))

        # Then fetch method is once
        given_fetch_method.assert_called_once_with(('key',))

        # Then results are yield in the right order
        self.assertEqual([entry, entry, entry], results)