PYTHON-1297 Convert to pytest for running unit and integration tests (datastax#1215)

Author: absurdfarce

.gitignore

@@ -12,7 +12,6 @@ build
 MANIFEST
 dist
 .coverage
-nosetests.xml
 cover/
 docs/_build/
 tests/integration/ccm

README-dev.rst

@@ -48,6 +48,16 @@ environment variable::
 
     SCYLLA_VERSION="release:5.1" python -m pytest tests/integration/standard tests/integration/cqlengine/
 
+Or you can specify a scylla/cassandra directory (to test unreleased versions)::
+
+    SCYLLA_VERSION=/path/to/scylla pytest tests/integration/standard/
+
+Specifying the usage of an already running Scylla cluster
+------------------------------------------------------------
+The test will start the appropriate Scylla clusters when necessary  but if you don't want this to happen because a Scylla cluster is already running the flag ``USE_CASS_EXTERNAL`` can be used, for example::
+
+    USE_CASS_EXTERNAL=1 SCYLLA_VERSION='release:5.1' pytest tests/integration/standard
+
 Specify a Protocol Version for Tests
 ------------------------------------
 The protocol version defaults to:

cassandra/io/asyncorereactor.py

@@ -24,7 +24,6 @@
 import sys
 import ssl
 
-
 try:
     from weakref import WeakSet
 except ImportError:

cassandra/io/libevreactor.py

@@ -22,8 +22,6 @@
 import time
 
 from cassandra import DependencyException
-from cassandra.connection import (Connection, ConnectionShutdown,
-                                  NONBLOCKING, Timer, TimerManager)
 try:
     import cassandra.io.libevwrapper as libev
 except ImportError:
@@ -35,6 +33,9 @@
         "for instructions on installing build dependencies and building "
         "the C extension.")
 
+from cassandra.connection import (Connection, ConnectionShutdown,
+                                  NONBLOCKING, Timer, TimerManager)
+
 
 log = logging.getLogger(__name__)
 

cassandra/io/twistedreactor.py

@@ -102,6 +102,9 @@ def maybe_start(self):
                 self._thread.start()
                 atexit.register(partial(_cleanup, weakref.ref(self)))
 
+    def _reactor_stopped(self):
+        return reactor._stopped
+
     def _cleanup(self):
         if self._thread:
             reactor.callFromThread(reactor.stop)

setup.py

@@ -18,17 +18,6 @@
 import json
 import warnings
 from pathlib import Path
-
-if __name__ == '__main__' and len(sys.argv) > 1:
-    if sys.argv[1] == "gevent_nosetests":
-        print("Running gevent tests")
-        from gevent.monkey import patch_all
-        patch_all()
-    elif sys.argv[1] == "eventlet_nosetests":
-        print("Running eventlet tests")
-        from eventlet import monkey_patch
-        monkey_patch()
-
 from setuptools.command.build_ext import build_ext
 from setuptools import Extension, Command, setup
 from setuptools.errors import (CCompilerError, PlatformError,
@@ -40,17 +29,6 @@
 except ImportError:
     has_subprocess = False
 
-try:
-    from nose.commands import nosetests
-except ImportError:
-    gevent_nosetests = None
-    eventlet_nosetests = None
-else:
-    class gevent_nosetests(nosetests):
-        description = "run nosetests with gevent monkey patching"
-
-    class eventlet_nosetests(nosetests):
-        description = "run nosetests with eventlet monkey patching"
 
 has_cqlengine = False
 if __name__ == '__main__' and len(sys.argv) > 1 and sys.argv[1] == "install":
@@ -424,12 +402,6 @@ def pre_build_check():
 def run_setup(extensions):
 
     kw = {'cmdclass': {'doc': DocCommand}}
-    if gevent_nosetests is not None:
-        kw['cmdclass']['gevent_nosetests'] = gevent_nosetests
-
-    if eventlet_nosetests is not None:
-        kw['cmdclass']['eventlet_nosetests'] = eventlet_nosetests
-
     kw['cmdclass']['build_ext'] = build_extensions
     kw['ext_modules'] = [Extension('DUMMY', [])]  # dummy extension makes sure build_ext is called for install
 

tests/integration/cloud/conftest.py

@@ -0,0 +1,9 @@
+import pytest
+
+from tests.integration.cloud import setup_package, teardown_package
+
+@pytest.fixture(scope='session', autouse=True)
+def setup_and_teardown_packages():
+    setup_package()
+    yield
+    teardown_package()

tests/integration/conftest.py

@@ -4,6 +4,8 @@
 import pytest
 from ccmlib.cluster_factory import ClusterFactory as CCMClusterFactory
 
+from tests.integration import teardown_package
+
 from . import CLUSTER_NAME, SINGLE_NODE_CLUSTER_NAME, MULTIDC_CLUSTER_NAME
 from . import path as ccm_path
 
@@ -22,3 +24,9 @@ def cleanup_clusters():
                 cluster.clear()
             except FileNotFoundError:
                 pass
+
+@pytest.fixture(scope='session', autouse=True)
+def setup_and_teardown_packages():
+    print('setup')
+    yield
+    teardown_package()

tests/integration/cqlengine/conftest.py

@@ -33,7 +33,8 @@
 
 from cassandra.cqlengine import connection
 from cassandra.cqlengine.management import create_keyspace_simple, drop_keyspace, CQLENG_ALLOW_SCHEMA_MANAGEMENT
-from tests.integration import use_single_node
+from tests.integration import use_single_node, teardown_package as parent_teardown_package
+from tests.integration.cqlengine import setup_package, teardown_package
 
 from . import setup_connection, DEFAULT_KEYSPACE
 
@@ -52,3 +53,11 @@ def cqlengine_fixture():
 
     drop_keyspace(DEFAULT_KEYSPACE)
     connection.unregister_connection("default")
+
+
+@pytest.fixture(scope='session', autouse=True)
+def setup_and_teardown_packages():
+    setup_package()
+    yield
+    teardown_package()
+    parent_teardown_package()

tests/integration/cqlengine/test_batch_query.py

@@ -13,6 +13,8 @@
 # limitations under the License.
 import warnings
 
+import pytest
+
 from cassandra.cqlengine import columns
 from cassandra.cqlengine.management import drop_table, sync_table
 from cassandra.cqlengine.models import Model
@@ -217,8 +219,7 @@ def test_callbacks_work_multiple_times(self):
         def my_callback(*args, **kwargs):
             call_history.append(args)
 
-        with warnings.catch_warnings(record=True) as w:
-            warnings.simplefilter("always")
+        with pytest.warns() as w:
             with BatchQuery() as batch:
                 batch.add_callback(my_callback)
                 batch.execute()

tests/integration/simulacron/conftest.py

@@ -0,0 +1,9 @@
+import pytest
+
+from tests.integration.simulacron import teardown_package
+
+@pytest.fixture(scope='session', autouse=True)
+def setup_and_teardown_packages():
+    print('setup')
+    yield
+    teardown_package()

tests/integration/standard/conftest.py

@@ -0,0 +1,13 @@
+import pytest
+import logging
+
+# from https://github.com/streamlit/streamlit/pull/5047/files
+def pytest_sessionfinish():
+    # We're not waiting for scriptrunner threads to cleanly close before ending the PyTest,
+    # which results in raised exception ValueError: I/O operation on closed file.
+    # This is well known issue in PyTest, check out these discussions for more:
+    # * https://github.com/pytest-dev/pytest/issues/5502
+    # * https://github.com/pytest-dev/pytest/issues/5282
+    # To prevent the exception from being raised on pytest_sessionfinish
+    # we disable exception raising in logging module
+    logging.raiseExceptions = False

tests/unit/io/test_asyncorereactor.py

@@ -11,6 +11,7 @@
 # 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.
+import platform
 import unittest
 
 from unittest.mock import patch
@@ -64,7 +65,8 @@ def tearDownClass(cls):
             except:
                 pass
 
-
+has_asyncore = Version(platform.python_version()) < Version("3.12.0")
+@unittest.skipUnless(has_asyncore, "asyncore has been removed in Python 3.12")
 class AsyncoreConnectionTest(ReactorTestMixin, AsyncorePatcher):
 
     connection_class = AsyncoreConnection
@@ -75,6 +77,7 @@ def setUp(self):
             raise unittest.SkipTest("Can't test asyncore with monkey patching")
 
 
+@unittest.skipUnless(has_asyncore, "asyncore has been removed in Python 3.12")
 class TestAsyncoreTimer(TimerTestMixin, AsyncorePatcher):
     connection_class = AsyncoreConnection
 

tests/unit/io/test_libevreactor.py

@@ -14,11 +14,8 @@
 import unittest
 
 from unittest.mock import patch, Mock
-import weakref
 import socket
 
-from tests import is_monkey_patched
-from tests.unit.io.utils import ReactorTestMixin, TimerTestMixin, noop_if_monkey_patched
 from cassandra import DependencyException
 
 try:
@@ -27,6 +24,9 @@
 except (ImportError, DependencyException):
     LibevConnection = None  # noqa
 
+from tests import is_monkey_patched
+from tests.unit.io.utils import ReactorTestMixin, TimerTestMixin, noop_if_monkey_patched
+
 
 class LibevConnectionTest(ReactorTestMixin, unittest.TestCase):
 

tests/unit/io/test_twistedreactor.py

@@ -66,7 +66,9 @@ def setUp(self):
         self.tr.protocol = self.obj_ut
 
     def tearDown(self):
-        pass
+        loop = twistedreactor.TwistedConnection._loop
+        if not loop._reactor_stopped():
+            loop._cleanup()
 
     def test_makeConnection(self):
         """

tests/unit/io/utils.py

@@ -178,7 +178,7 @@ def test_timer_cancellation(self):
         timer = self.create_timer(timeout, callback.invoke)
         timer.cancel()
         # Release context allow for timer thread to run.
-        time.sleep(.2)
+        time.sleep(timeout * 2)
         timer_manager = self._timers
         # Assert that the cancellation was honored
         self.assertFalse(timer_manager._queue)