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

Commit

Permalink
Ensure each cache config test uses separate state. (#11019)
Browse files Browse the repository at this point in the history
Hopefully this fixes these tests sometimes failing in CI.
  • Loading branch information
clokep authored Oct 7, 2021
1 parent e0bf34d commit 7301019
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
1 change: 1 addition & 0 deletions changelog.d/11019.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Ensure that cache config tests do not share state.
20 changes: 12 additions & 8 deletions tests/config/test_cache.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,16 @@
# See the License for the specific language governing permissions and
# limitations under the License.

from unittest.mock import patch

from synapse.config.cache import CacheConfig, add_resizable_cache
from synapse.util.caches.lrucache import LruCache

from tests.unittest import TestCase


# Patch the global _CACHES so that each test runs against its own state.
@patch("synapse.config.cache._CACHES", new_callable=dict)
class CacheConfigTests(TestCase):
def setUp(self):
# Reset caches before each test
Expand All @@ -26,7 +30,7 @@ def setUp(self):
def tearDown(self):
self.config.reset()

def test_individual_caches_from_environ(self):
def test_individual_caches_from_environ(self, _caches):
"""
Individual cache factors will be loaded from the environment.
"""
Expand All @@ -39,7 +43,7 @@ def test_individual_caches_from_environ(self):

self.assertEqual(dict(self.config.cache_factors), {"something_or_other": 2.0})

def test_config_overrides_environ(self):
def test_config_overrides_environ(self, _caches):
"""
Individual cache factors defined in the environment will take precedence
over those in the config.
Expand All @@ -56,7 +60,7 @@ def test_config_overrides_environ(self):
{"foo": 1.0, "bar": 3.0, "something_or_other": 2.0},
)

def test_individual_instantiated_before_config_load(self):
def test_individual_instantiated_before_config_load(self, _caches):
"""
If a cache is instantiated before the config is read, it will be given
the default cache size in the interim, and then resized once the config
Expand All @@ -72,7 +76,7 @@ def test_individual_instantiated_before_config_load(self):

self.assertEqual(cache.max_size, 300)

def test_individual_instantiated_after_config_load(self):
def test_individual_instantiated_after_config_load(self, _caches):
"""
If a cache is instantiated after the config is read, it will be
immediately resized to the correct size given the per_cache_factor if
Expand All @@ -85,7 +89,7 @@ def test_individual_instantiated_after_config_load(self):
add_resizable_cache("foo", cache_resize_callback=cache.set_cache_factor)
self.assertEqual(cache.max_size, 200)

def test_global_instantiated_before_config_load(self):
def test_global_instantiated_before_config_load(self, _caches):
"""
If a cache is instantiated before the config is read, it will be given
the default cache size in the interim, and then resized to the new
Expand All @@ -100,7 +104,7 @@ def test_global_instantiated_before_config_load(self):

self.assertEqual(cache.max_size, 400)

def test_global_instantiated_after_config_load(self):
def test_global_instantiated_after_config_load(self, _caches):
"""
If a cache is instantiated after the config is read, it will be
immediately resized to the correct size given the global factor if there
Expand All @@ -113,7 +117,7 @@ def test_global_instantiated_after_config_load(self):
add_resizable_cache("foo", cache_resize_callback=cache.set_cache_factor)
self.assertEqual(cache.max_size, 150)

def test_cache_with_asterisk_in_name(self):
def test_cache_with_asterisk_in_name(self, _caches):
"""Some caches have asterisks in their name, test that they are set correctly."""

config = {
Expand All @@ -139,7 +143,7 @@ def test_cache_with_asterisk_in_name(self):
add_resizable_cache("*cache_c*", cache_resize_callback=cache_c.set_cache_factor)
self.assertEqual(cache_c.max_size, 200)

def test_apply_cache_factor_from_config(self):
def test_apply_cache_factor_from_config(self, _caches):
"""Caches can disable applying cache factor updates, mainly used by
event cache size.
"""
Expand Down

0 comments on commit 7301019

Please sign in to comment.