decouple tests from unittest.TestCase base class

use a regular pytest naming convention and create a standard
fixtures package

Change-Id: I9616ec468f433649ee0de0b2475b9133d5a7873d

Author: zzzeek

dogpile/testing/__init__.py

@@ -0,0 +1,5 @@
+from .assertions import assert_raises_message as assert_raises_message
+from .assertions import eq_ as eq_
+from .assertions import is_ as is_
+from .assertions import ne_ as ne_
+from .assertions import winsleep as winsleep

dogpile/testing/assertions.py

@@ -0,0 +1,34 @@
+import re
+import sys
+import time
+
+
+def eq_(a, b, msg=None):
+    """Assert a == b, with repr messaging on failure."""
+    assert a == b, msg or "%r != %r" % (a, b)
+
+
+def is_(a, b, msg=None):
+    """Assert a is b, with repr messaging on failure."""
+    assert a is b, msg or "%r is not %r" % (a, b)
+
+
+def ne_(a, b, msg=None):
+    """Assert a != b, with repr messaging on failure."""
+    assert a != b, msg or "%r == %r" % (a, b)
+
+
+def assert_raises_message(except_cls, msg, callable_, *args, **kwargs):
+    try:
+        callable_(*args, **kwargs)
+        assert False, "Callable did not raise an exception"
+    except except_cls as e:
+        assert re.search(msg, str(e)), "%r !~ %s" % (msg, e)
+
+
+def winsleep():
+    # sleep a for an amount of time
+    # sufficient for windows time.time()
+    # to change
+    if sys.platform.startswith("win"):
+        time.sleep(0.001)

tests/cache/_fixtures.py dogpile/testing/fixtures.pytests/cache/_fixtures.py renamed to dogpile/testing/fixtures.py

@@ -1,11 +1,12 @@
+# mypy: ignore-errors
+
 import collections
 import itertools
 import json
 import random
 from threading import Lock
 from threading import Thread
 import time
-from unittest import TestCase
 import uuid
 
 import pytest
@@ -17,15 +18,15 @@
 from dogpile.cache.api import CantDeserializeException
 from dogpile.cache.api import NO_VALUE
 from dogpile.cache.region import _backend_loader
-from . import assert_raises_message
-from . import eq_
+from .assertions import assert_raises_message
+from .assertions import eq_
 
 
 def gen_some_key():
     return f"some_key_{random.randint(1, 100000)}"
 
 
-class _GenericBackendFixture(object):
+class _GenericBackendFixture:
     @classmethod
     def setup_class(cls):
         backend_cls = _backend_loader.load(cls.backend)
@@ -36,7 +37,7 @@ def setup_class(cls):
             pytest.skip("Backend %s not installed" % cls.backend)
         cls._check_backend_available(backend)
 
-    def tearDown(self):
+    def teardown_method(self, method):
         some_key = gen_some_key()
         if self._region_inst:
             for key in self._keys:
@@ -96,7 +97,7 @@ def _backend(self):
         return self._backend_inst
 
 
-class _GenericBackendTest(_GenericBackendFixture, TestCase):
+class _GenericBackendTestSuite(_GenericBackendFixture):
     def test_backend_get_nothing(self):
         backend = self._backend()
         some_key = gen_some_key()
@@ -402,7 +403,7 @@ def raise_cant_deserialize_exception(v):
     raise CantDeserializeException()
 
 
-class _GenericSerializerTest(TestCase):
+class _GenericSerializerTestSuite:
     # Inheriting from this class will make test cases
     # use these serialization arguments
     region_args = {
@@ -452,7 +453,7 @@ def test_uses_deserializer(self):
     # TODO: test set_multi, get_multi
 
 
-class _GenericMutexTest(_GenericBackendFixture, TestCase):
+class _GenericMutexTestSuite(_GenericBackendFixture):
     def test_mutex(self):
         backend = self._backend()
         mutex = backend.get_mutex("foo")

pyproject.toml

@@ -69,6 +69,8 @@ target-version = ['py38']
 [tool.pytest.ini_options]
 addopts = "--tb native -v -r fxX  -p no:logging -p no:warnings -m 'not time_intensive'"
 python_files = "tests/*test_*.py"
+python_classes = "*Test"
+
 filterwarnings = [
     "error"
 ]

setup.cfg

@@ -15,6 +15,7 @@ exclude = .venv,.git,.tox,dist,docs/*,*egg,build
 import-order-style = google
 application-import-names = dogpile,tests
 per-file-ignores =
+    **/__init__.py:F401
     tests/*:FA100
 
 

tests/cache/__init__.py

@@ -1,34 +0,0 @@
-import re
-import sys
-import time
-
-
-def eq_(a, b, msg=None):
-    """Assert a == b, with repr messaging on failure."""
-    assert a == b, msg or "%r != %r" % (a, b)
-
-
-def is_(a, b, msg=None):
-    """Assert a is b, with repr messaging on failure."""
-    assert a is b, msg or "%r is not %r" % (a, b)
-
-
-def ne_(a, b, msg=None):
-    """Assert a != b, with repr messaging on failure."""
-    assert a != b, msg or "%r == %r" % (a, b)
-
-
-def assert_raises_message(except_cls, msg, callable_, *args, **kwargs):
-    try:
-        callable_(*args, **kwargs)
-        assert False, "Callable did not raise an exception"
-    except except_cls as e:
-        assert re.search(msg, str(e)), "%r !~ %s" % (msg, e)
-
-
-def winsleep():
-    # sleep a for an amount of time
-    # sufficient for windows time.time()
-    # to change
-    if sys.platform.startswith("win"):
-        time.sleep(0.001)

tests/cache/plugins/test_mako_cache.py

@@ -1,11 +1,10 @@
 from unittest import mock
-from unittest import TestCase
 
 from mako.cache import register_plugin
 from mako.template import Template
 import pytest
 
-from .. import eq_
+from dogpile.testing import eq_
 
 
 try:
@@ -18,7 +17,7 @@
 )
 
 
-class TestMakoPlugin(TestCase):
+class MakoPluginTest:
     def _mock_fixture(self):
         reg = mock.MagicMock()
         reg.get_or_create.return_value = "hello world"

tests/cache/test_dbm_backend.py

@@ -3,11 +3,11 @@
 
 from dogpile.cache.backends.file import AbstractFileLock
 from dogpile.cache.proxy import ProxyBackend
+from dogpile.testing import assert_raises_message
+from dogpile.testing.fixtures import _GenericBackendTestSuite
+from dogpile.testing.fixtures import _GenericMutexTestSuite
+from dogpile.testing.fixtures import _GenericSerializerTestSuite
 from dogpile.util.readwrite_lock import ReadWriteMutex
-from . import assert_raises_message
-from ._fixtures import _GenericBackendTest
-from ._fixtures import _GenericMutexTest
-from ._fixtures import _GenericSerializerTest
 
 try:
     import fcntl  # noqa
@@ -40,21 +40,21 @@ def release_write_lock(self):
 
 if has_fcntl:
 
-    class DBMBackendTest(_GenericBackendTest):
+    class DBMBackendTest(_GenericBackendTestSuite):
         backend = "dogpile.cache.dbm"
 
         config_args = {"arguments": {"filename": test_fname}}
 
 
-class DBMBackendConditionTest(_GenericBackendTest):
+class DBMBackendConditionTest(_GenericBackendTestSuite):
     backend = "dogpile.cache.dbm"
 
     config_args = {
         "arguments": {"filename": test_fname, "lock_factory": MutexLock}
     }
 
 
-class DBMBackendProxyTest(_GenericBackendTest):
+class DBMBackendProxyTest(_GenericBackendTestSuite):
     backend = "dogpile.cache.dbm"
 
     config_args = {
@@ -64,12 +64,12 @@ class DBMBackendProxyTest(_GenericBackendTest):
 
 
 class DBMBackendSerializerTest(
-    _GenericSerializerTest, DBMBackendConditionTest
+    _GenericSerializerTestSuite, DBMBackendConditionTest
 ):
     pass
 
 
-class DBMBackendNoLockTest(_GenericBackendTest):
+class DBMBackendNoLockTest(_GenericBackendTestSuite):
     backend = "dogpile.cache.dbm"
 
     config_args = {
@@ -81,7 +81,7 @@ class DBMBackendNoLockTest(_GenericBackendTest):
     }
 
 
-class _DBMMutexTest(_GenericMutexTest):
+class _DBMMutexTestSuite(_GenericMutexTestSuite):
     backend = "dogpile.cache.dbm"
 
     def test_release_assertion_thread(self):
@@ -107,11 +107,11 @@ def test_release_assertion_key(self):
 
 if has_fcntl:
 
-    class DBMMutexFileTest(_DBMMutexTest):
+    class DBMMutexFileTest(_DBMMutexTestSuite):
         config_args = {"arguments": {"filename": test_fname}}
 
 
-class DBMMutexConditionTest(_DBMMutexTest):
+class DBMMutexConditionTest(_DBMMutexTestSuite):
     config_args = {
         "arguments": {"filename": test_fname, "lock_factory": MutexLock}
     }

tests/cache/test_decorator.py

@@ -2,17 +2,17 @@
 
 import itertools
 import time
-from unittest import TestCase
 
 from dogpile.cache import util
 from dogpile.cache.api import NO_VALUE
+from dogpile.testing import assert_raises_message
+from dogpile.testing import eq_
+from dogpile.testing import winsleep
+from dogpile.testing.fixtures import _GenericBackendFixture
 from dogpile.util import compat
-from . import eq_
-from . import winsleep
-from ._fixtures import _GenericBackendFixture
 
 
-class DecoratorTest(_GenericBackendFixture, TestCase):
+class DecoratorTest(_GenericBackendFixture):
     backend = "dogpile.cache.memory"
 
     def _fixture(
@@ -189,7 +189,7 @@ def generate_key_with_reversed_order(*args):
         eq_(go.get(3, 1), ["1 2", "2 1"])
 
 
-class KeyGenerationTest(TestCase):
+class KeyGenerationTest:
     def _keygen_decorator(self, namespace=None, **kw):
         canary = []
 
@@ -229,7 +229,14 @@ def one(a, b):
             pass
 
         gen = canary[0]
-        self.assertRaises(ValueError, gen, 1, b=2)
+        assert_raises_message(
+            ValueError,
+            "dogpile.cache's default key creation function "
+            "does not accept keyword arguments",
+            gen,
+            1,
+            b=2,
+        )
 
     def test_kwarg_kegen_keygen_fn(self):
         decorate, canary = self._kwarg_keygen_decorator()
@@ -471,7 +478,7 @@ def test_sha1_key_mangler_bytes_py3k(self):
         )
 
 
-class CacheDecoratorTest(_GenericBackendFixture, TestCase):
+class CacheDecoratorTest(_GenericBackendFixture):
     backend = "mock"
 
     def test_cache_arg(self):
@@ -656,7 +663,7 @@ def func(a, b, c=True, *args, **kwargs):
         cached_func = reg.cache_on_arguments()(func)
         cached_signature = compat.inspect_getargspec(cached_func)
 
-        self.assertEqual(signature, cached_signature)
+        eq_(signature, cached_signature)
 
     def test_cache_multi_preserve_sig(self):
         reg = self._region()
@@ -668,4 +675,4 @@ def func(a, b, c=True, *args, **kwargs):
         cached_func = reg.cache_multi_on_arguments()(func)
         cached_signature = compat.inspect_getargspec(cached_func)
 
-        self.assertEqual(signature, cached_signature)
+        eq_(signature, cached_signature)

tests/cache/test_mako.py

@@ -1,7 +1,4 @@
-from unittest import TestCase
-
-
-class MakoTest(TestCase):
+class MakoTest:
 
     """Test entry point for Mako"""