Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Add missing types to tests.util. #14597

Merged
merged 16 commits into from
Dec 2, 2022
Merged

Add missing types to tests.util. #14597

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
2f81f5b
Add missing types to test_async_helpers.
clokep Dec 1, 2022
b320a12
Add missing types to test_batching_queue.
clokep Dec 1, 2022
6ea52a6
Add missing types to test_dict_cache.
clokep Dec 1, 2022
24a7e30
Add missing types to test_expiring_cache.
clokep Dec 1, 2022
2e82e46
Add missing types to test_file_consumer.
clokep Dec 1, 2022
5b398b4
Add missing types to test_linearizer.
clokep Dec 1, 2022
524f15d
Add missing types to test_logcontext.
clokep Dec 1, 2022
b4dff91
Add missing types to test_lrucache.
clokep Dec 1, 2022
d879e9b
Add missing types to test_rwlock.
clokep Dec 1, 2022
ab5e9b3
Add missing types to test_wheel_timer.
clokep Dec 1, 2022
31c2eb4
Add missing return types to tests.
clokep Dec 1, 2022
a76e89f
Add missing types to test_ratelimitutils.
clokep Dec 1, 2022
6fd04e7
Add missing types to test_check_dependencies.
clokep Dec 2, 2022
219fb8f
Newsfragment
clokep Dec 2, 2022
41ab6ee
Fix old Python.
clokep Dec 2, 2022
c6a812e
Rename BlockingStringWrite to BlockingBytesWrite.
clokep Dec 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion mypy.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ exclude = (?x)
|tests/server_notices/test_resource_limits_server_notices.py
|tests/test_state.py
|tests/test_terms_auth.py
|tests/util/test_lrucache.py
|tests/util/test_rwlock.py
|tests/util/test_wheel_timer.py
)$
Expand Down Expand Up @@ -151,6 +150,9 @@ disallow_untyped_defs = True
[mypy-tests.util.test_logcontext]
disallow_untyped_defs = True

[mypy-tests.util.test_lrucache]
disallow_untyped_defs = True

[mypy-tests.utils]
disallow_untyped_defs = True

Expand Down
80 changes: 42 additions & 38 deletions tests/util/test_lrucache.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,11 @@
# limitations under the License.


from typing import List
from typing import List, Tuple
from unittest.mock import Mock, patch

from synapse.metrics.jemalloc import JemallocStats
from synapse.types import JsonDict
from synapse.util.caches.lrucache import LruCache, setup_expire_lru_cache_entries
from synapse.util.caches.treecache import TreeCache

Expand All @@ -25,14 +26,14 @@


class LruCacheTestCase(unittest.HomeserverTestCase):
def test_get_set(self):
cache = LruCache(1)
def test_get_set(self) -> None:
cache: LruCache[str, str] = LruCache(1)
cache["key"] = "value"
self.assertEqual(cache.get("key"), "value")
self.assertEqual(cache["key"], "value")

def test_eviction(self):
cache = LruCache(2)
def test_eviction(self) -> None:
cache: LruCache[int, int] = LruCache(2)
cache[1] = 1
cache[2] = 2

Expand All @@ -45,23 +46,24 @@ def test_eviction(self):
self.assertEqual(cache.get(2), 2)
self.assertEqual(cache.get(3), 3)

def test_setdefault(self):
cache = LruCache(1)
def test_setdefault(self) -> None:
cache: LruCache[str, int] = LruCache(1)
self.assertEqual(cache.setdefault("key", 1), 1)
self.assertEqual(cache.get("key"), 1)
self.assertEqual(cache.setdefault("key", 2), 1)
self.assertEqual(cache.get("key"), 1)
cache["key"] = 2 # Make sure overriding works.
self.assertEqual(cache.get("key"), 2)

def test_pop(self):
cache = LruCache(1)
def test_pop(self) -> None:
cache: LruCache[str, int] = LruCache(1)
cache["key"] = 1
self.assertEqual(cache.pop("key"), 1)
self.assertEqual(cache.pop("key"), None)

def test_del_multi(self):
cache = LruCache(4, cache_type=TreeCache)
def test_del_multi(self) -> None:
# The type here isn't quite correct as they don't handle TreeCache well.
cache: LruCache[Tuple[str, str], str] = LruCache(4, cache_type=TreeCache)
cache[("animal", "cat")] = "mew"
cache[("animal", "dog")] = "woof"
cache[("vehicles", "car")] = "vroom"
Expand All @@ -71,30 +73,30 @@ def test_del_multi(self):

self.assertEqual(cache.get(("animal", "cat")), "mew")
self.assertEqual(cache.get(("vehicles", "car")), "vroom")
cache.del_multi(("animal",))
cache.del_multi(("animal",)) # type: ignore[arg-type]
DMRobertson marked this conversation as resolved.
Show resolved Hide resolved
self.assertEqual(len(cache), 2)
self.assertEqual(cache.get(("animal", "cat")), None)
self.assertEqual(cache.get(("animal", "dog")), None)
self.assertEqual(cache.get(("vehicles", "car")), "vroom")
self.assertEqual(cache.get(("vehicles", "train")), "chuff")
# Man from del_multi say "Yes".

def test_clear(self):
cache = LruCache(1)
def test_clear(self) -> None:
cache: LruCache[str, int] = LruCache(1)
cache["key"] = 1
cache.clear()
self.assertEqual(len(cache), 0)

@override_config({"caches": {"per_cache_factors": {"mycache": 10}}})
def test_special_size(self):
cache = LruCache(10, "mycache")
def test_special_size(self) -> None:
cache: LruCache = LruCache(10, "mycache")
self.assertEqual(cache.max_size, 100)


class LruCacheCallbacksTestCase(unittest.HomeserverTestCase):
def test_get(self):
def test_get(self) -> None:
m = Mock()
cache = LruCache(1)
cache: LruCache[str, str] = LruCache(1)

cache.set("key", "value")
self.assertFalse(m.called)
Expand All @@ -111,9 +113,9 @@ def test_get(self):
cache.set("key", "value")
self.assertEqual(m.call_count, 1)

def test_multi_get(self):
def test_multi_get(self) -> None:
m = Mock()
cache = LruCache(1)
cache: LruCache[str, str] = LruCache(1)

cache.set("key", "value")
self.assertFalse(m.called)
Expand All @@ -130,9 +132,9 @@ def test_multi_get(self):
cache.set("key", "value")
self.assertEqual(m.call_count, 1)

def test_set(self):
def test_set(self) -> None:
m = Mock()
cache = LruCache(1)
cache: LruCache[str, str] = LruCache(1)

cache.set("key", "value", callbacks=[m])
self.assertFalse(m.called)
Expand All @@ -146,9 +148,9 @@ def test_set(self):
cache.set("key", "value")
self.assertEqual(m.call_count, 1)

def test_pop(self):
def test_pop(self) -> None:
m = Mock()
cache = LruCache(1)
cache: LruCache[str, str] = LruCache(1)

cache.set("key", "value", callbacks=[m])
self.assertFalse(m.called)
Expand All @@ -162,12 +164,13 @@ def test_pop(self):
cache.pop("key")
self.assertEqual(m.call_count, 1)

def test_del_multi(self):
def test_del_multi(self) -> None:
m1 = Mock()
m2 = Mock()
m3 = Mock()
m4 = Mock()
cache = LruCache(4, cache_type=TreeCache)
# The type here isn't quite correct as they don't handle TreeCache well.
cache: LruCache[Tuple[str, str], str] = LruCache(4, cache_type=TreeCache)

cache.set(("a", "1"), "value", callbacks=[m1])
cache.set(("a", "2"), "value", callbacks=[m2])
Expand All @@ -179,17 +182,17 @@ def test_del_multi(self):
self.assertEqual(m3.call_count, 0)
self.assertEqual(m4.call_count, 0)

cache.del_multi(("a",))
cache.del_multi(("a",)) # type: ignore[arg-type]

self.assertEqual(m1.call_count, 1)
self.assertEqual(m2.call_count, 1)
self.assertEqual(m3.call_count, 0)
self.assertEqual(m4.call_count, 0)

def test_clear(self):
def test_clear(self) -> None:
m1 = Mock()
m2 = Mock()
cache = LruCache(5)
cache: LruCache[str, str] = LruCache(5)

cache.set("key1", "value", callbacks=[m1])
cache.set("key2", "value", callbacks=[m2])
Expand All @@ -202,11 +205,11 @@ def test_clear(self):
self.assertEqual(m1.call_count, 1)
self.assertEqual(m2.call_count, 1)

def test_eviction(self):
def test_eviction(self) -> None:
m1 = Mock(name="m1")
m2 = Mock(name="m2")
m3 = Mock(name="m3")
cache = LruCache(2)
cache: LruCache[str, str] = LruCache(2)

cache.set("key1", "value", callbacks=[m1])
cache.set("key2", "value", callbacks=[m2])
Expand Down Expand Up @@ -241,8 +244,8 @@ def test_eviction(self):


class LruCacheSizedTestCase(unittest.HomeserverTestCase):
def test_evict(self):
cache = LruCache(5, size_callback=len)
def test_evict(self) -> None:
cache: LruCache[str, List[int]] = LruCache(5, size_callback=len)
cache["key1"] = [0]
cache["key2"] = [1, 2]
cache["key3"] = [3]
Expand All @@ -269,6 +272,7 @@ def test_zero_size_drop_from_cache(self) -> None:
cache["key1"] = []

self.assertEqual(len(cache), 0)
assert isinstance(cache.cache, dict)
cache.cache["key1"].drop_from_cache()
self.assertIsNone(
cache.pop("key1"), "Cache entry should have been evicted but wasn't"
Expand All @@ -278,17 +282,17 @@ def test_zero_size_drop_from_cache(self) -> None:
class TimeEvictionTestCase(unittest.HomeserverTestCase):
"""Test that time based eviction works correctly."""

def default_config(self):
def default_config(self) -> JsonDict:
config = super().default_config()

config.setdefault("caches", {})["expiry_time"] = "30m"

return config

def test_evict(self):
def test_evict(self) -> None:
setup_expire_lru_cache_entries(self.hs)

cache = LruCache(5, clock=self.hs.get_clock())
cache: LruCache[str, int] = LruCache(5, clock=self.hs.get_clock())

# Check that we evict entries we haven't accessed for 30 minutes.
cache["key1"] = 1
Expand Down Expand Up @@ -332,15 +336,15 @@ class MemoryEvictionTestCase(unittest.HomeserverTestCase):
}
)
@patch("synapse.util.caches.lrucache.get_jemalloc_stats")
def test_evict_memory(self, jemalloc_interface) -> None:
def test_evict_memory(self, jemalloc_interface: Mock) -> None:
mock_jemalloc_class = Mock(spec=JemallocStats)
jemalloc_interface.return_value = mock_jemalloc_class

# set the return value of get_stat() to be greater than max_cache_memory_usage
mock_jemalloc_class.get_stat.return_value = 924288000

setup_expire_lru_cache_entries(self.hs)
cache = LruCache(4, clock=self.hs.get_clock())
cache: LruCache[str, int] = LruCache(4, clock=self.hs.get_clock())

cache["key1"] = 1
cache["key2"] = 2
Expand Down