From abf336e108b01f44afb473eb86c1dece6360195c Mon Sep 17 00:00:00 2001 From: Miguel Grinberg Date: Sun, 24 Nov 2024 19:55:15 +0000 Subject: [PATCH] Removed dependency on unittest.TestCase base class --- tests/async/test_admin.py | 40 ++++++++++++++--------------- tests/async/test_client.py | 3 +-- tests/async/test_manager.py | 5 ++-- tests/async/test_namespace.py | 5 +--- tests/async/test_pubsub_manager.py | 5 ++-- tests/async/test_server.py | 5 ++-- tests/async/test_simple_client.py | 3 +-- tests/common/test_admin.py | 38 +++++++++++++-------------- tests/common/test_client.py | 3 +-- tests/common/test_manager.py | 5 ++-- tests/common/test_middleware.py | 3 +-- tests/common/test_msgpack_packet.py | 4 +-- tests/common/test_namespace.py | 3 +-- tests/common/test_packet.py | 4 +-- tests/common/test_pubsub_manager.py | 5 ++-- tests/common/test_server.py | 5 ++-- tests/common/test_simple_client.py | 3 +-- 17 files changed, 60 insertions(+), 79 deletions(-) diff --git a/tests/async/test_admin.py b/tests/async/test_admin.py index 4988277..4f28353 100644 --- a/tests/async/test_admin.py +++ b/tests/async/test_admin.py @@ -2,7 +2,6 @@ from functools import wraps import threading import time from unittest import mock -import unittest import pytest try: from engineio.async_socket import AsyncSocket as EngineIOSocket @@ -38,13 +37,13 @@ def with_instrumented_server(auth=False, **ikwargs): pass async def shutdown(): - await instrumented_server.shutdown() + await self.isvr.shutdown() await sio.shutdown() if 'server_stats_interval' not in ikwargs: ikwargs['server_stats_interval'] = 0.25 - instrumented_server = sio.instrument(auth=auth, **ikwargs) + self.isvr = sio.instrument(auth=auth, **ikwargs) server = SocketIOWebServer(sio, on_shutdown=shutdown) server.start() @@ -56,10 +55,11 @@ def with_instrumented_server(auth=False, **ikwargs): EngineIOSocket.schedule_ping = mock.MagicMock() try: - ret = f(self, instrumented_server, *args, **kwargs) + ret = f(self, *args, **kwargs) finally: server.stop() - instrumented_server.uninstrument() + self.isvr.uninstrument() + self.isvr = None EngineIOSocket.schedule_ping = original_schedule_ping @@ -80,12 +80,12 @@ async def _async_custom_auth(auth): return auth == {'foo': 'bar'} -class TestAsyncAdmin(unittest.TestCase): - def setUp(self): +class TestAsyncAdmin: + def setup_method(self): print('threads at start:', threading.enumerate()) self.thread_count = threading.active_count() - def tearDown(self): + def teardown_method(self): print('threads at end:', threading.enumerate()) assert self.thread_count == threading.active_count() @@ -107,7 +107,7 @@ class TestAsyncAdmin(unittest.TestCase): sio.instrument() @with_instrumented_server(auth=False) - def test_admin_connect_with_no_auth(self, isvr): + def test_admin_connect_with_no_auth(self): with socketio.SimpleClient() as admin_client: admin_client.connect('http://localhost:8900', namespace='/admin') with socketio.SimpleClient() as admin_client: @@ -115,7 +115,7 @@ class TestAsyncAdmin(unittest.TestCase): auth={'foo': 'bar'}) @with_instrumented_server(auth={'foo': 'bar'}) - def test_admin_connect_with_dict_auth(self, isvr): + def test_admin_connect_with_dict_auth(self): with socketio.SimpleClient() as admin_client: admin_client.connect('http://localhost:8900', namespace='/admin', auth={'foo': 'bar'}) @@ -131,7 +131,7 @@ class TestAsyncAdmin(unittest.TestCase): @with_instrumented_server(auth=[{'foo': 'bar'}, {'u': 'admin', 'p': 'secret'}]) - def test_admin_connect_with_list_auth(self, isvr): + def test_admin_connect_with_list_auth(self): with socketio.SimpleClient() as admin_client: admin_client.connect('http://localhost:8900', namespace='/admin', auth={'foo': 'bar'}) @@ -148,7 +148,7 @@ class TestAsyncAdmin(unittest.TestCase): namespace='/admin') @with_instrumented_server(auth=_custom_auth) - def test_admin_connect_with_function_auth(self, isvr): + def test_admin_connect_with_function_auth(self): with socketio.SimpleClient() as admin_client: admin_client.connect('http://localhost:8900', namespace='/admin', auth={'foo': 'bar'}) @@ -162,7 +162,7 @@ class TestAsyncAdmin(unittest.TestCase): namespace='/admin') @with_instrumented_server(auth=_async_custom_auth) - def test_admin_connect_with_async_function_auth(self, isvr): + def test_admin_connect_with_async_function_auth(self): with socketio.SimpleClient() as admin_client: admin_client.connect('http://localhost:8900', namespace='/admin', auth={'foo': 'bar'}) @@ -176,7 +176,7 @@ class TestAsyncAdmin(unittest.TestCase): namespace='/admin') @with_instrumented_server() - def test_admin_connect_only_admin(self, isvr): + def test_admin_connect_only_admin(self): with socketio.SimpleClient() as admin_client: admin_client.connect('http://localhost:8900', namespace='/admin') sid = admin_client.sid @@ -201,7 +201,7 @@ class TestAsyncAdmin(unittest.TestCase): events['server_stats']['namespaces'] @with_instrumented_server() - def test_admin_connect_with_others(self, isvr): + def test_admin_connect_with_others(self): with socketio.SimpleClient() as client1, \ socketio.SimpleClient() as client2, \ socketio.SimpleClient() as client3, \ @@ -210,12 +210,12 @@ class TestAsyncAdmin(unittest.TestCase): client1.emit('enter_room', 'room') sid1 = client1.sid - saved_check_for_upgrade = isvr._check_for_upgrade - isvr._check_for_upgrade = AsyncMock() + saved_check_for_upgrade = self.isvr._check_for_upgrade + self.isvr._check_for_upgrade = AsyncMock() client2.connect('http://localhost:8900', namespace='/foo', transports=['polling']) sid2 = client2.sid - isvr._check_for_upgrade = saved_check_for_upgrade + self.isvr._check_for_upgrade = saved_check_for_upgrade client3.connect('http://localhost:8900', namespace='/admin') sid3 = client3.sid @@ -251,7 +251,7 @@ class TestAsyncAdmin(unittest.TestCase): assert socket['rooms'] == [sid3] @with_instrumented_server(mode='production', read_only=True) - def test_admin_connect_production(self, isvr): + def test_admin_connect_production(self): with socketio.SimpleClient() as admin_client: admin_client.connect('http://localhost:8900', namespace='/admin') events = self._expect({'config': 1, 'server_stats': 2}, @@ -272,7 +272,7 @@ class TestAsyncAdmin(unittest.TestCase): events['server_stats']['namespaces'] @with_instrumented_server() - def test_admin_features(self, isvr): + def test_admin_features(self): with socketio.SimpleClient() as client1, \ socketio.SimpleClient() as client2, \ socketio.SimpleClient() as admin_client: diff --git a/tests/async/test_client.py b/tests/async/test_client.py index cf99059..38c690d 100644 --- a/tests/async/test_client.py +++ b/tests/async/test_client.py @@ -1,5 +1,4 @@ import asyncio -import unittest from unittest import mock import pytest @@ -12,7 +11,7 @@ from socketio import packet from .helpers import AsyncMock, _run -class TestAsyncClient(unittest.TestCase): +class TestAsyncClient: def test_is_asyncio_based(self): c = async_client.AsyncClient() assert c.is_asyncio_based() diff --git a/tests/async/test_manager.py b/tests/async/test_manager.py index 83f6475..50d1dd9 100644 --- a/tests/async/test_manager.py +++ b/tests/async/test_manager.py @@ -1,4 +1,3 @@ -import unittest from unittest import mock from socketio import async_manager @@ -6,8 +5,8 @@ from socketio import packet from .helpers import AsyncMock, _run -class TestAsyncManager(unittest.TestCase): - def setUp(self): +class TestAsyncManager: + def setup_method(self): id = 0 def generate_id(): diff --git a/tests/async/test_namespace.py b/tests/async/test_namespace.py index 6043003..873f479 100644 --- a/tests/async/test_namespace.py +++ b/tests/async/test_namespace.py @@ -1,13 +1,10 @@ -import sys -import unittest from unittest import mock from socketio import async_namespace from .helpers import AsyncMock, _run -@unittest.skipIf(sys.version_info < (3, 5), 'only for Python 3.5+') -class TestAsyncNamespace(unittest.TestCase): +class TestAsyncNamespace: def test_connect_event(self): result = {} diff --git a/tests/async/test_pubsub_manager.py b/tests/async/test_pubsub_manager.py index c7aeb6e..8a509d2 100644 --- a/tests/async/test_pubsub_manager.py +++ b/tests/async/test_pubsub_manager.py @@ -1,6 +1,5 @@ import asyncio import functools -import unittest from unittest import mock import pytest @@ -11,8 +10,8 @@ from socketio import packet from .helpers import AsyncMock, _run -class TestAsyncPubSubManager(unittest.TestCase): - def setUp(self): +class TestAsyncPubSubManager: + def setup_method(self): id = 0 def generate_id(): diff --git a/tests/async/test_server.py b/tests/async/test_server.py index 471e562..8b2dfe2 100644 --- a/tests/async/test_server.py +++ b/tests/async/test_server.py @@ -1,6 +1,5 @@ import asyncio import logging -import unittest from unittest import mock from engineio import json @@ -18,8 +17,8 @@ from .helpers import AsyncMock, _run @mock.patch('socketio.server.engineio.AsyncServer', **{ 'return_value.generate_id.side_effect': [str(i) for i in range(1, 10)], 'return_value.send_packet': AsyncMock()}) -class TestAsyncServer(unittest.TestCase): - def tearDown(self): +class TestAsyncServer: + def teardown_method(self): # restore JSON encoder, in case a test changed it packet.Packet.json = json diff --git a/tests/async/test_simple_client.py b/tests/async/test_simple_client.py index 08b2ea6..6a2eb7a 100644 --- a/tests/async/test_simple_client.py +++ b/tests/async/test_simple_client.py @@ -1,5 +1,4 @@ import asyncio -import unittest from unittest import mock import pytest @@ -8,7 +7,7 @@ from socketio.exceptions import SocketIOError, TimeoutError, DisconnectedError from .helpers import AsyncMock, _run -class TestAsyncAsyncSimpleClient(unittest.TestCase): +class TestAsyncAsyncSimpleClient: def test_constructor(self): client = AsyncSimpleClient(1, '2', a='3', b=4) assert client.client_args == (1, '2') diff --git a/tests/common/test_admin.py b/tests/common/test_admin.py index 2b2d016..e766731 100644 --- a/tests/common/test_admin.py +++ b/tests/common/test_admin.py @@ -2,7 +2,6 @@ from functools import wraps import threading import time from unittest import mock -import unittest import pytest from engineio.socket import Socket as EngineIOSocket import socketio @@ -36,7 +35,7 @@ def with_instrumented_server(auth=False, **ikwargs): if 'server_stats_interval' not in ikwargs: ikwargs['server_stats_interval'] = 0.25 - instrumented_server = sio.instrument(auth=auth, **ikwargs) + self.isvr = sio.instrument(auth=auth, **ikwargs) server = SocketIOWebServer(sio) server.start() @@ -48,11 +47,12 @@ def with_instrumented_server(auth=False, **ikwargs): EngineIOSocket.schedule_ping = mock.MagicMock() try: - ret = f(self, instrumented_server, *args, **kwargs) + ret = f(self, *args, **kwargs) finally: server.stop() - instrumented_server.shutdown() - instrumented_server.uninstrument() + self.isvr.shutdown() + self.isvr.uninstrument() + self.isvr = None EngineIOSocket.schedule_ping = original_schedule_ping @@ -69,12 +69,12 @@ def _custom_auth(auth): return auth == {'foo': 'bar'} -class TestAdmin(unittest.TestCase): - def setUp(self): +class TestAdmin: + def setup_method(self): print('threads at start:', threading.enumerate()) self.thread_count = threading.active_count() - def tearDown(self): + def teardown_method(self): print('threads at end:', threading.enumerate()) assert self.thread_count == threading.active_count() @@ -96,7 +96,7 @@ class TestAdmin(unittest.TestCase): sio.instrument() @with_instrumented_server(auth=False) - def test_admin_connect_with_no_auth(self, isvr): + def test_admin_connect_with_no_auth(self): with socketio.SimpleClient() as admin_client: admin_client.connect('http://localhost:8900', namespace='/admin') with socketio.SimpleClient() as admin_client: @@ -104,7 +104,7 @@ class TestAdmin(unittest.TestCase): auth={'foo': 'bar'}) @with_instrumented_server(auth={'foo': 'bar'}) - def test_admin_connect_with_dict_auth(self, isvr): + def test_admin_connect_with_dict_auth(self): with socketio.SimpleClient() as admin_client: admin_client.connect('http://localhost:8900', namespace='/admin', auth={'foo': 'bar'}) @@ -120,7 +120,7 @@ class TestAdmin(unittest.TestCase): @with_instrumented_server(auth=[{'foo': 'bar'}, {'u': 'admin', 'p': 'secret'}]) - def test_admin_connect_with_list_auth(self, isvr): + def test_admin_connect_with_list_auth(self): with socketio.SimpleClient() as admin_client: admin_client.connect('http://localhost:8900', namespace='/admin', auth={'foo': 'bar'}) @@ -137,7 +137,7 @@ class TestAdmin(unittest.TestCase): namespace='/admin') @with_instrumented_server(auth=_custom_auth) - def test_admin_connect_with_function_auth(self, isvr): + def test_admin_connect_with_function_auth(self): with socketio.SimpleClient() as admin_client: admin_client.connect('http://localhost:8900', namespace='/admin', auth={'foo': 'bar'}) @@ -151,7 +151,7 @@ class TestAdmin(unittest.TestCase): namespace='/admin') @with_instrumented_server() - def test_admin_connect_only_admin(self, isvr): + def test_admin_connect_only_admin(self): with socketio.SimpleClient() as admin_client: admin_client.connect('http://localhost:8900', namespace='/admin') sid = admin_client.sid @@ -176,7 +176,7 @@ class TestAdmin(unittest.TestCase): events['server_stats']['namespaces'] @with_instrumented_server() - def test_admin_connect_with_others(self, isvr): + def test_admin_connect_with_others(self): with socketio.SimpleClient() as client1, \ socketio.SimpleClient() as client2, \ socketio.SimpleClient() as client3, \ @@ -185,12 +185,12 @@ class TestAdmin(unittest.TestCase): client1.emit('enter_room', 'room') sid1 = client1.sid - saved_check_for_upgrade = isvr._check_for_upgrade - isvr._check_for_upgrade = mock.MagicMock() + saved_check_for_upgrade = self.isvr._check_for_upgrade + self.isvr._check_for_upgrade = mock.MagicMock() client2.connect('http://localhost:8900', namespace='/foo', transports=['polling']) sid2 = client2.sid - isvr._check_for_upgrade = saved_check_for_upgrade + self.isvr._check_for_upgrade = saved_check_for_upgrade client3.connect('http://localhost:8900', namespace='/admin') sid3 = client3.sid @@ -226,7 +226,7 @@ class TestAdmin(unittest.TestCase): assert socket['rooms'] == [sid3] @with_instrumented_server(mode='production', read_only=True) - def test_admin_connect_production(self, isvr): + def test_admin_connect_production(self): with socketio.SimpleClient() as admin_client: admin_client.connect('http://localhost:8900', namespace='/admin') events = self._expect({'config': 1, 'server_stats': 2}, @@ -247,7 +247,7 @@ class TestAdmin(unittest.TestCase): events['server_stats']['namespaces'] @with_instrumented_server() - def test_admin_features(self, isvr): + def test_admin_features(self): with socketio.SimpleClient() as client1, \ socketio.SimpleClient() as client2, \ socketio.SimpleClient() as admin_client: diff --git a/tests/common/test_client.py b/tests/common/test_client.py index 52cfc33..c7de4b9 100644 --- a/tests/common/test_client.py +++ b/tests/common/test_client.py @@ -1,6 +1,5 @@ import logging import time -import unittest from unittest import mock from engineio import exceptions as engineio_exceptions @@ -16,7 +15,7 @@ from socketio import namespace from socketio import packet -class TestClient(unittest.TestCase): +class TestClient: def test_is_asyncio_based(self): c = client.Client() assert not c.is_asyncio_based() diff --git a/tests/common/test_manager.py b/tests/common/test_manager.py index 571d2fd..65ed1cb 100644 --- a/tests/common/test_manager.py +++ b/tests/common/test_manager.py @@ -1,4 +1,3 @@ -import unittest from unittest import mock import pytest @@ -7,8 +6,8 @@ from socketio import manager from socketio import packet -class TestBaseManager(unittest.TestCase): - def setUp(self): +class TestBaseManager: + def setup_method(self): id = 0 def generate_id(): diff --git a/tests/common/test_middleware.py b/tests/common/test_middleware.py index 8611a04..0579503 100644 --- a/tests/common/test_middleware.py +++ b/tests/common/test_middleware.py @@ -1,10 +1,9 @@ -import unittest from unittest import mock from socketio import middleware -class TestMiddleware(unittest.TestCase): +class TestMiddleware: def test_wsgi_routing(self): mock_wsgi_app = mock.MagicMock() mock_sio_app = 'foo' diff --git a/tests/common/test_msgpack_packet.py b/tests/common/test_msgpack_packet.py index 4930cff..e0197a2 100644 --- a/tests/common/test_msgpack_packet.py +++ b/tests/common/test_msgpack_packet.py @@ -1,10 +1,8 @@ -import unittest - from socketio import msgpack_packet from socketio import packet -class TestMsgPackPacket(unittest.TestCase): +class TestMsgPackPacket: def test_encode_decode(self): p = msgpack_packet.MsgPackPacket( packet.CONNECT, data={'auth': {'token': '123'}}, namespace='/foo') diff --git a/tests/common/test_namespace.py b/tests/common/test_namespace.py index 7967cec..8bfa989 100644 --- a/tests/common/test_namespace.py +++ b/tests/common/test_namespace.py @@ -1,10 +1,9 @@ -import unittest from unittest import mock from socketio import namespace -class TestNamespace(unittest.TestCase): +class TestNamespace: def test_connect_event(self): result = {} diff --git a/tests/common/test_packet.py b/tests/common/test_packet.py index 1dcc8f0..5682dab 100644 --- a/tests/common/test_packet.py +++ b/tests/common/test_packet.py @@ -1,11 +1,9 @@ -import unittest - import pytest from socketio import packet -class TestPacket(unittest.TestCase): +class TestPacket: def test_encode_default_packet(self): pkt = packet.Packet() assert pkt.packet_type == packet.EVENT diff --git a/tests/common/test_pubsub_manager.py b/tests/common/test_pubsub_manager.py index 5a4653e..6d8eda7 100644 --- a/tests/common/test_pubsub_manager.py +++ b/tests/common/test_pubsub_manager.py @@ -1,6 +1,5 @@ import functools import logging -import unittest from unittest import mock import pytest @@ -10,8 +9,8 @@ from socketio import pubsub_manager from socketio import packet -class TestPubSubManager(unittest.TestCase): - def setUp(self): +class TestPubSubManager: + def setup_method(self): id = 0 def generate_id(): diff --git a/tests/common/test_server.py b/tests/common/test_server.py index 33790dc..e6b02e5 100644 --- a/tests/common/test_server.py +++ b/tests/common/test_server.py @@ -1,5 +1,4 @@ import logging -import unittest from unittest import mock from engineio import json @@ -15,8 +14,8 @@ from socketio import server @mock.patch('socketio.server.engineio.Server', **{ 'return_value.generate_id.side_effect': [str(i) for i in range(1, 10)]}) -class TestServer(unittest.TestCase): - def tearDown(self): +class TestServer: + def teardown_method(self): # restore JSON encoder, in case a test changed it packet.Packet.json = json diff --git a/tests/common/test_simple_client.py b/tests/common/test_simple_client.py index 3b9f983..4279057 100644 --- a/tests/common/test_simple_client.py +++ b/tests/common/test_simple_client.py @@ -1,11 +1,10 @@ -import unittest from unittest import mock import pytest from socketio import SimpleClient from socketio.exceptions import SocketIOError, TimeoutError, DisconnectedError -class TestSimpleClient(unittest.TestCase): +class TestSimpleClient: def test_constructor(self): client = SimpleClient(1, '2', a='3', b=4) assert client.client_args == (1, '2')