summary refs log tree commit diff
path: root/tests/storage/test__base.py
blob: 783abc2b00e2d6bb2b0e7e0457daabf200d590f7 (plain) (blame)
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
# -*- coding: utf-8 -*-
# Copyright 2015 OpenMarket Ltd
#
# 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.


from tests import unittest
from twisted.internet import defer

from synapse.storage._base import Cache, cached


class CacheTestCase(unittest.TestCase):

    def setUp(self):
        self.cache = Cache("test")

    def test_empty(self):
        failed = False
        try:
            self.cache.get("foo")
        except KeyError:
            failed = True

        self.assertTrue(failed)

    def test_hit(self):
        self.cache.prefill("foo", 123)

        self.assertEquals(self.cache.get("foo"), 123)

    def test_invalidate(self):
        self.cache.prefill("foo", 123)
        self.cache.invalidate("foo")

        failed = False
        try:
            self.cache.get("foo")
        except KeyError:
            failed = True

        self.assertTrue(failed)


class CacheDecoratorTestCase(unittest.TestCase):

    @defer.inlineCallbacks
    def test_passthrough(self):
        @cached()
        def func(self, key):
            return key

        self.assertEquals((yield func(self, "foo")), "foo")
        self.assertEquals((yield func(self, "bar")), "bar")

    @defer.inlineCallbacks
    def test_hit(self):
        callcount = [0]

        @cached()
        def func(self, key):
            callcount[0] += 1
            return key

        yield func(self, "foo")

        self.assertEquals(callcount[0], 1)

        self.assertEquals((yield func(self, "foo")), "foo")
        self.assertEquals(callcount[0], 1)

    @defer.inlineCallbacks
    def test_invalidate(self):
        callcount = [0]

        @cached()
        def func(self, key):
            callcount[0] += 1
            return key

        yield func(self, "foo")

        self.assertEquals(callcount[0], 1)

        func.invalidate("foo")

        yield func(self, "foo")

        self.assertEquals(callcount[0], 2)

    def test_invalidate_missing(self):
        @cached()
        def func(self, key):
            return key

        func.invalidate("what")

    @defer.inlineCallbacks
    def test_max_entries(self):
        callcount = [0]

        @cached(max_entries=10)
        def func(self, key):
            callcount[0] += 1
            return key

        for k in range(0,12):
            yield func(self, k)

        self.assertEquals(callcount[0], 12)

        # There must have been at least 2 evictions, meaning if we calculate
        # all 12 values again, we must get called at least 2 more times
        for k in range(0,12):
            yield func(self, k)

        self.assertTrue(callcount[0] >= 14,
            msg="Expected callcount >= 14, got %d" % (callcount[0]))

    @defer.inlineCallbacks
    def test_prefill(self):
        callcount = [0]

        @cached()
        def func(self, key):
            callcount[0] += 1
            return key

        func.prefill("foo", 123)

        self.assertEquals((yield func(self, "foo")), 123)
        self.assertEquals(callcount[0], 0)