make sync test cases reusable for cluster

Author: amirreza8002

tests/conftest.py

@@ -1,13 +1,16 @@
+import copy
 from collections.abc import Iterable
+from typing import cast
 
 import pytest
 import pytest_asyncio
+from pytest_django.fixtures import SettingsWrapper
 
 from asgiref.compatibility import iscoroutinefunction
-from django.core.cache import cache as default_cache
+from django.core.cache import cache as default_cache, caches
 
 from django_valkey.base import BaseValkeyCache
-
+from django_valkey.cache import ValkeyCache
 
 # for some reason `isawaitable` doesn't work here
 if iscoroutinefunction(default_cache.clear):
@@ -23,3 +26,20 @@ async def cache():
     def cache() -> Iterable[BaseValkeyCache]:
         yield default_cache
         default_cache.clear()
+
+
+@pytest.fixture
+def key_prefix_cache(
+    cache: ValkeyCache, settings: SettingsWrapper
+) -> Iterable[ValkeyCache]:
+    caches_setting = copy.deepcopy(settings.CACHES)
+    caches_setting["default"]["KEY_PREFIX"] = "*"
+    settings.CACHES = caches_setting
+    yield cache
+
+
+@pytest.fixture
+def with_prefix_cache() -> Iterable[ValkeyCache]:
+    with_prefix = cast(ValkeyCache, caches["with_prefix"])
+    yield with_prefix
+    with_prefix.clear()

tests/test_backend.py

@@ -15,6 +15,7 @@
 
 from django_valkey.cache import ValkeyCache
 from django_valkey.client import ShardClient, herd
+from django_valkey.cluster_cache.client import DefaultClusterClient
 from django_valkey.serializers.json import JSONSerializer
 from django_valkey.serializers.msgpack import MSGPackSerializer
 from django_valkey.serializers.pickle import PickleSerializer
@@ -99,7 +100,7 @@ def test_unicode_keys(self, cache: ValkeyCache):
         res = cache.get("ключ")
         assert res == "value"
 
-    def test_save_and_integer(self, cache: ValkeyCache):
+    def test_save_an_integer(self, cache: ValkeyCache):
         cache.set("test_key", 2)
         res = cache.get("test_key", "Foo")
 
@@ -223,7 +224,9 @@ def test_get_many(self, cache: ValkeyCache):
         assert res == {"a": 1, "b": 2, "c": 3}
 
     def test_mget(self, cache: ValkeyCache):
-        if isinstance(cache.client, ShardClient):
+        if isinstance(cache.client, ShardClient) or isinstance(
+            cache.client, DefaultClusterClient
+        ):
             pytest.skip()
         cache.set("a", 1)
         cache.set("b", 2)
@@ -240,13 +243,28 @@ def test_get_many_unicode(self, cache: ValkeyCache):
         res = cache.get_many(["a", "ب", "c"])
         assert res == {"a": "1", "ب": "2", "c": "الف"}
 
+    def test_mget_unicode(self, cache: ValkeyCache):
+        if isinstance(cache.client, ShardClient) or isinstance(
+            cache.client, DefaultClusterClient
+        ):
+            pytest.skip()
+
+        cache.set("fooa", "1")
+        cache.set("fooب", "2")
+        cache.set("fooc", "الف")
+
+        res = cache.mget(["fooa", "fooب", "fooc"])
+        assert res == {"fooa": "1", "fooب": "2", "fooc": "الف"}
+
     def test_set_many(self, cache: ValkeyCache):
         cache.set_many({"a": 1, "b": 2, "c": 3})
         res = cache.get_many(["a", "b", "c"])
         assert res == {"a": 1, "b": 2, "c": 3}
 
     def test_mset(self, cache: ValkeyCache):
-        if isinstance(cache.client, ShardClient):
+        if isinstance(cache.client, ShardClient) or isinstance(
+            cache.client, DefaultClusterClient
+        ):
             pytest.skip()
         cache.mset({"a": 1, "b": 2, "c": 3})
         res = cache.mget(["a", "b", "c"])
@@ -518,6 +536,9 @@ def test_ttl_incr_version_no_timeout(self, cache: ValkeyCache):
         assert my_value == "hello world!"
 
     def test_delete_pattern(self, cache: ValkeyCache):
+        if isinstance(cache.client, DefaultClusterClient):
+            pytest.skip("cluster client has a specific test")
+
         for key in ["foo-aa", "foo-ab", "foo-bb", "foo-bc"]:
             cache.set(key, "foo")
 
@@ -532,6 +553,9 @@ def test_delete_pattern(self, cache: ValkeyCache):
 
     @patch("django_valkey.cache.ValkeyCache.client")
     def test_delete_pattern_with_custom_count(self, client_mock, cache: ValkeyCache):
+        if isinstance(cache.client, DefaultClusterClient):
+            pytest.skip("cluster client has a specific test")
+
         for key in ["foo-aa", "foo-ab", "foo-bb", "foo-bc"]:
             cache.set(key, "foo")
 
@@ -547,6 +571,9 @@ def test_delete_pattern_with_settings_default_scan_count(
         cache: ValkeyCache,
         settings: SettingsWrapper,
     ):
+        if isinstance(cache.client, DefaultClusterClient):
+            pytest.skip("cluster client has a specific test")
+
         for key in ["foo-aa", "foo-ab", "foo-bb", "foo-bc"]:
             cache.set(key, "foo")
         expected_count = settings.DJANGO_VALKEY_SCAN_ITERSIZE
@@ -715,6 +742,11 @@ def test_lock(self, cache: ValkeyCache):
         lock.release()
         assert not cache.has_key("foobar")
 
+    def test_lock_context_manager(self, cache: ValkeyCache):
+        with cache.lock("foobar"):
+            assert cache.has_key("foobar")
+        assert not cache.has_key("foobar")
+
     def test_lock_released_by_thread(self, cache: ValkeyCache):
         lock = cache.lock("foobar", thread_local=False)
         lock.acquire(blocking=True)
@@ -918,6 +950,9 @@ def test_sdiff(self, cache: ValkeyCache):
         if isinstance(cache.client, ShardClient):
             pytest.skip("ShardClient doesn't support sdiff")
 
+        if isinstance(cache.client, DefaultClusterClient):
+            pytest.skip("cluster client has a specific test")
+
         cache.sadd("foo1", "bar1", "bar2")
         cache.sadd("foo2", "bar2", "bar3")
         assert cache.sdiff("foo1", "foo2") == {"bar1"}
@@ -926,6 +961,9 @@ def test_sdiffstore(self, cache: ValkeyCache):
         if isinstance(cache.client, ShardClient):
             pytest.skip("ShardClient doesn't support sdiffstore")
 
+        if isinstance(cache.client, DefaultClusterClient):
+            pytest.skip("cluster client has a specific test")
+
         cache.sadd("foo1", "bar1", "bar2")
         cache.sadd("foo2", "bar2", "bar3")
         assert cache.sdiffstore("foo3", "foo1", "foo2") == 1
@@ -935,6 +973,9 @@ def test_sdiffstore_with_keys_version(self, cache: ValkeyCache):
         if isinstance(cache.client, ShardClient):
             pytest.skip("ShardClient doesn't support sdiffstore")
 
+        if isinstance(cache.client, DefaultClusterClient):
+            pytest.skip("cluster client has a specific test")
+
         cache.sadd("foo1", "bar1", "bar2", version=2)
         cache.sadd("foo2", "bar2", "bar3", version=2)
         assert cache.sdiffstore("foo3", "foo1", "foo2", version_keys=2) == 1
@@ -946,6 +987,9 @@ def test_sdiffstore_with_different_keys_versions_without_initial_set_in_version(
         if isinstance(cache.client, ShardClient):
             pytest.skip("ShardClient doesn't support sdiffstore")
 
+        if isinstance(cache.client, DefaultClusterClient):
+            pytest.skip("cluster client has a specific test")
+
         cache.sadd("foo1", "bar1", "bar2", version=1)
         cache.sadd("foo2", "bar2", "bar3", version=2)
         assert cache.sdiffstore("foo3", "foo1", "foo2", version_keys=2) == 0
@@ -956,6 +1000,9 @@ def test_sdiffstore_with_different_keys_versions_with_initial_set_in_version(
         if isinstance(cache.client, ShardClient):
             pytest.skip("ShardClient doesn't support sdiffstore")
 
+        if isinstance(cache.client, DefaultClusterClient):
+            pytest.skip("cluster client has a specific test")
+
         cache.sadd("foo1", "bar1", "bar2", version=2)
         cache.sadd("foo2", "bar2", "bar3", version=1)
         assert cache.sdiffstore("foo3", "foo1", "foo2", version_keys=2) == 2
@@ -964,14 +1011,20 @@ def test_sinter(self, cache: ValkeyCache):
         if isinstance(cache.client, ShardClient):
             pytest.skip("ShardClient doesn't support sinter")
 
+        if isinstance(cache.client, DefaultClusterClient):
+            pytest.skip("cluster client has a specific test")
+
         cache.sadd("foo1", "bar1", "bar2")
         cache.sadd("foo2", "bar2", "bar3")
         assert cache.sinter("foo1", "foo2") == {"bar2"}
 
-    def test_interstore(self, cache: ValkeyCache):
+    def test_sinterstore(self, cache: ValkeyCache):
         if isinstance(cache.client, ShardClient):
             pytest.skip("ShardClient doesn't support sinterstore")
 
+        if isinstance(cache.client, DefaultClusterClient):
+            pytest.skip("cluster client has a specific test")
+
         cache.sadd("foo1", "bar1", "bar2")
         cache.sadd("foo2", "bar2", "bar3")
         assert cache.sinterstore("foo3", "foo1", "foo2") == 1
@@ -1066,6 +1119,9 @@ def test_smove(self, cache: ValkeyCache):
         # if isinstance(cache.client, ShardClient):
         #     pytest.skip("ShardClient doesn't support get_client")
 
+        if isinstance(cache.client, DefaultClusterClient):
+            pytest.skip("cluster client has a specific test")
+
         cache.sadd("foo1", "bar1", "bar2")
         cache.sadd("foo2", "bar2", "bar3")
         assert cache.smove("foo1", "foo2", "bar1") is True
@@ -1130,6 +1186,9 @@ def test_sunion(self, cache: ValkeyCache):
         if isinstance(cache.client, ShardClient):
             pytest.skip("ShardClient doesn't support sunion")
 
+        if isinstance(cache.client, DefaultClusterClient):
+            pytest.skip("cluster client has a specific test")
+
         cache.sadd("foo1", "bar1", "bar2")
         cache.sadd("foo2", "bar2", "bar3")
         assert cache.sunion("foo1", "foo2") == {"bar1", "bar2", "bar3"}
@@ -1138,6 +1197,9 @@ def test_sunionstore(self, cache: ValkeyCache):
         if isinstance(cache.client, ShardClient):
             pytest.skip("ShardClient doesn't support sunionstore")
 
+        if isinstance(cache.client, DefaultClusterClient):
+            pytest.skip("cluster client has a specific test")
+
         cache.sadd("foo1", "bar1", "bar2")
         cache.sadd("foo2", "bar2", "bar3")
         assert cache.sunionstore("foo3", "foo1", "foo2") == 3

tests/test_cache_options.py

@@ -1,15 +1,17 @@
 import copy
-from collections.abc import Iterable
 from typing import cast
 
 import pytest
-from django.core.cache import caches
 from pytest import LogCaptureFixture
 from pytest_django.fixtures import SettingsWrapper
+
+from django.core.cache import caches, cache as default_cache
+
 from valkey.exceptions import ConnectionError
 
 from django_valkey.cache import ValkeyCache
 from django_valkey.client import ShardClient
+from django_valkey.cluster_cache.client import DefaultClusterClient
 
 
 def make_key(key: str, prefix: str, version: str) -> str:
@@ -31,13 +33,21 @@ def ignore_exceptions_cache(settings: SettingsWrapper) -> ValkeyCache:
     return cast(ValkeyCache, caches["doesnotexist"])
 
 
+@pytest.mark.skipif(
+    isinstance(default_cache.client, DefaultClusterClient),
+    reason="cluster client doesn't support ignore exception",
+)
 def test_get_django_omit_exceptions_many_returns_default_arg(
     ignore_exceptions_cache: ValkeyCache,
 ):
     assert ignore_exceptions_cache._ignore_exceptions is True
     assert ignore_exceptions_cache.get_many(["key1", "key2", "key3"]) == {}
 
 
+@pytest.mark.skipif(
+    isinstance(default_cache.client, DefaultClusterClient),
+    reason="cluster client doesn't support ignore exception",
+)
 def test_get_django_omit_exceptions(
     caplog: LogCaptureFixture, ignore_exceptions_cache: ValkeyCache
 ):
@@ -55,6 +65,10 @@ def test_get_django_omit_exceptions(
     )
 
 
+@pytest.mark.skipif(
+    isinstance(default_cache.client, DefaultClusterClient),
+    reason="cluster client doesn't support ignore exception",
+)
 def test_get_django_omit_exceptions_priority_1(settings: SettingsWrapper):
     caches_setting = copy.deepcopy(settings.CACHES)
     caches_setting["doesnotexist"]["OPTIONS"]["IGNORE_EXCEPTIONS"] = True
@@ -65,6 +79,10 @@ def test_get_django_omit_exceptions_priority_1(settings: SettingsWrapper):
     assert cache.get("key") is None
 
 
+@pytest.mark.skipif(
+    isinstance(default_cache.client, DefaultClusterClient),
+    reason="cluster client doesn't support ignore exception",
+)
 def test_get_django_omit_exceptions_priority_2(settings: SettingsWrapper):
     caches_setting = copy.deepcopy(settings.CACHES)
     caches_setting["doesnotexist"]["OPTIONS"]["IGNORE_EXCEPTIONS"] = False
@@ -76,23 +94,6 @@ def test_get_django_omit_exceptions_priority_2(settings: SettingsWrapper):
         cache.get("key")
 
 
-@pytest.fixture
-def key_prefix_cache(
-    cache: ValkeyCache, settings: SettingsWrapper
-) -> Iterable[ValkeyCache]:
-    caches_setting = copy.deepcopy(settings.CACHES)
-    caches_setting["default"]["KEY_PREFIX"] = "*"
-    settings.CACHES = caches_setting
-    yield cache
-
-
-@pytest.fixture
-def with_prefix_cache() -> Iterable[ValkeyCache]:
-    with_prefix = cast(ValkeyCache, caches["with_prefix"])
-    yield with_prefix
-    with_prefix.clear()
-
-
 class TestDjangoValkeyCacheEscapePrefix:
     def test_delete_pattern(
         self, key_prefix_cache: ValkeyCache, with_prefix_cache: ValkeyCache
@@ -113,6 +114,10 @@ def test_iter_keys(
         with_prefix_cache.set("b", "2")
         assert list(key_prefix_cache.iter_keys("*")) == ["a"]
 
+    @pytest.mark.skipif(
+        isinstance(default_cache.client, DefaultClusterClient),
+        reason="cluster client doesn't support ignore exception",
+    )
     def test_keys(self, key_prefix_cache: ValkeyCache, with_prefix_cache: ValkeyCache):
         key_prefix_cache.set("a", "1")
         with_prefix_cache.set("b", "2")
@@ -121,6 +126,10 @@ def test_keys(self, key_prefix_cache: ValkeyCache, with_prefix_cache: ValkeyCach
         assert "b" not in keys
 
 
+@pytest.mark.skipif(
+    isinstance(default_cache.client, DefaultClusterClient),
+    reason="cluster client doesn't support ignore exception",
+)
 def test_custom_key_function(cache: ValkeyCache, settings: SettingsWrapper):
     caches_setting = copy.deepcopy(settings.CACHES)
     caches_setting["default"]["KEY_FUNCTION"] = "tests.test_cache_options.make_key"