Miguel Grinberg
2 years ago
14 changed files with 848 additions and 78 deletions
@ -0,0 +1,299 @@ |
|||
from functools import wraps |
|||
import threading |
|||
import time |
|||
from unittest import mock |
|||
import unittest |
|||
import pytest |
|||
from engineio.asyncio_socket import AsyncSocket as EngineIOSocket |
|||
import socketio |
|||
from socketio.exceptions import ConnectionError |
|||
from tests.asyncio_web_server import SocketIOWebServer |
|||
from .helpers import AsyncMock |
|||
|
|||
|
|||
def with_instrumented_server(auth=False, **ikwargs): |
|||
"""This decorator can be applied to test functions or methods so that they |
|||
run with a Socket.IO server that has been instrumented for the official |
|||
Admin UI project. The arguments passed to the decorator are passed directly |
|||
to the ``instrument()`` method of the server. |
|||
""" |
|||
def decorator(f): |
|||
@wraps(f) |
|||
def wrapped(self, *args, **kwargs): |
|||
sio = socketio.AsyncServer(async_mode='asgi') |
|||
instrumented_server = sio.instrument(auth=auth, **ikwargs) |
|||
|
|||
@sio.event |
|||
def enter_room(sid, data): |
|||
sio.enter_room(sid, data) |
|||
|
|||
@sio.event |
|||
async def emit(sid, event): |
|||
await sio.emit(event, skip_sid=sid) |
|||
|
|||
@sio.event(namespace='/foo') |
|||
def connect(sid, environ, auth): |
|||
pass |
|||
|
|||
async def shutdown(): |
|||
await instrumented_server.shutdown() |
|||
await sio.shutdown() |
|||
|
|||
server = SocketIOWebServer(sio, on_shutdown=shutdown) |
|||
server.start() |
|||
|
|||
# import logging |
|||
# logging.getLogger('engineio.client').setLevel(logging.DEBUG) |
|||
# logging.getLogger('socketio.client').setLevel(logging.DEBUG) |
|||
|
|||
original_schedule_ping = EngineIOSocket.schedule_ping |
|||
EngineIOSocket.schedule_ping = mock.MagicMock() |
|||
|
|||
try: |
|||
ret = f(self, instrumented_server, *args, **kwargs) |
|||
finally: |
|||
server.stop() |
|||
instrumented_server.uninstrument() |
|||
|
|||
EngineIOSocket.schedule_ping = original_schedule_ping |
|||
|
|||
# import logging |
|||
# logging.getLogger('engineio.client').setLevel(logging.NOTSET) |
|||
# logging.getLogger('socketio.client').setLevel(logging.NOTSET) |
|||
|
|||
return ret |
|||
return wrapped |
|||
return decorator |
|||
|
|||
|
|||
def _custom_auth(auth): |
|||
return auth == {'foo': 'bar'} |
|||
|
|||
|
|||
async def _async_custom_auth(auth): |
|||
return auth == {'foo': 'bar'} |
|||
|
|||
|
|||
class TestAsyncAdmin(unittest.TestCase): |
|||
def setUp(self): |
|||
print('threads at start:', threading.enumerate()) |
|||
self.thread_count = threading.active_count() |
|||
|
|||
def tearDown(self): |
|||
print('threads at end:', threading.enumerate()) |
|||
assert self.thread_count == threading.active_count() |
|||
|
|||
def test_missing_auth(self): |
|||
sio = socketio.AsyncServer(async_mode='asgi') |
|||
with pytest.raises(ValueError): |
|||
sio.instrument() |
|||
|
|||
@with_instrumented_server(auth=False) |
|||
def test_admin_connect_with_no_auth(self, isvr): |
|||
with socketio.SimpleClient() as admin_client: |
|||
admin_client.connect('http://localhost:8900', namespace='/admin') |
|||
with socketio.SimpleClient() as admin_client: |
|||
admin_client.connect('http://localhost:8900', namespace='/admin', |
|||
auth={'foo': 'bar'}) |
|||
|
|||
@with_instrumented_server(auth={'foo': 'bar'}) |
|||
def test_admin_connect_with_dict_auth(self, isvr): |
|||
with socketio.SimpleClient() as admin_client: |
|||
admin_client.connect('http://localhost:8900', namespace='/admin', |
|||
auth={'foo': 'bar'}) |
|||
with socketio.SimpleClient() as admin_client: |
|||
with pytest.raises(ConnectionError): |
|||
admin_client.connect( |
|||
'http://localhost:8900', namespace='/admin', |
|||
auth={'foo': 'baz'}) |
|||
with socketio.SimpleClient() as admin_client: |
|||
with pytest.raises(ConnectionError): |
|||
admin_client.connect( |
|||
'http://localhost:8900', namespace='/admin') |
|||
|
|||
@with_instrumented_server(auth=[{'foo': 'bar'}, |
|||
{'u': 'admin', 'p': 'secret'}]) |
|||
def test_admin_connect_with_list_auth(self, isvr): |
|||
with socketio.SimpleClient() as admin_client: |
|||
admin_client.connect('http://localhost:8900', namespace='/admin', |
|||
auth={'foo': 'bar'}) |
|||
with socketio.SimpleClient() as admin_client: |
|||
admin_client.connect('http://localhost:8900', namespace='/admin', |
|||
auth={'u': 'admin', 'p': 'secret'}) |
|||
with socketio.SimpleClient() as admin_client: |
|||
with pytest.raises(ConnectionError): |
|||
admin_client.connect('http://localhost:8900', |
|||
namespace='/admin', auth={'foo': 'baz'}) |
|||
with socketio.SimpleClient() as admin_client: |
|||
with pytest.raises(ConnectionError): |
|||
admin_client.connect('http://localhost:8900', |
|||
namespace='/admin') |
|||
|
|||
@with_instrumented_server(auth=_custom_auth) |
|||
def test_admin_connect_with_function_auth(self, isvr): |
|||
with socketio.SimpleClient() as admin_client: |
|||
admin_client.connect('http://localhost:8900', namespace='/admin', |
|||
auth={'foo': 'bar'}) |
|||
with socketio.SimpleClient() as admin_client: |
|||
with pytest.raises(ConnectionError): |
|||
admin_client.connect('http://localhost:8900', |
|||
namespace='/admin', auth={'foo': 'baz'}) |
|||
with socketio.SimpleClient() as admin_client: |
|||
with pytest.raises(ConnectionError): |
|||
admin_client.connect('http://localhost:8900', |
|||
namespace='/admin') |
|||
|
|||
@with_instrumented_server(auth=_async_custom_auth) |
|||
def test_admin_connect_with_async_function_auth(self, isvr): |
|||
with socketio.SimpleClient() as admin_client: |
|||
admin_client.connect('http://localhost:8900', namespace='/admin', |
|||
auth={'foo': 'bar'}) |
|||
with socketio.SimpleClient() as admin_client: |
|||
with pytest.raises(ConnectionError): |
|||
admin_client.connect('http://localhost:8900', |
|||
namespace='/admin', auth={'foo': 'baz'}) |
|||
with socketio.SimpleClient() as admin_client: |
|||
with pytest.raises(ConnectionError): |
|||
admin_client.connect('http://localhost:8900', |
|||
namespace='/admin') |
|||
|
|||
@with_instrumented_server() |
|||
def test_admin_connect_only_admin(self, isvr): |
|||
with socketio.SimpleClient() as admin_client: |
|||
admin_client.connect('http://localhost:8900', namespace='/admin') |
|||
sid = admin_client.sid |
|||
expected = ['config', 'all_sockets', 'server_stats'] |
|||
events = {} |
|||
while expected: |
|||
data = admin_client.receive(timeout=5) |
|||
if data[0] in expected: |
|||
events[data[0]] = data[1] |
|||
expected.remove(data[0]) |
|||
|
|||
assert 'supportedFeatures' in events['config'] |
|||
assert 'ALL_EVENTS' in events['config']['supportedFeatures'] |
|||
assert len(events['all_sockets']) == 1 |
|||
assert events['all_sockets'][0]['id'] == sid |
|||
assert events['all_sockets'][0]['rooms'] == [sid] |
|||
assert events['server_stats']['clientsCount'] == 1 |
|||
assert events['server_stats']['pollingClientsCount'] == 0 |
|||
assert len(events['server_stats']['namespaces']) == 3 |
|||
assert {'name': '/', 'socketsCount': 0} in \ |
|||
events['server_stats']['namespaces'] |
|||
assert {'name': '/foo', 'socketsCount': 0} in \ |
|||
events['server_stats']['namespaces'] |
|||
assert {'name': '/admin', 'socketsCount': 1} in \ |
|||
events['server_stats']['namespaces'] |
|||
|
|||
@with_instrumented_server() |
|||
def test_admin_connect_with_others(self, isvr): |
|||
with socketio.SimpleClient() as client1, \ |
|||
socketio.SimpleClient() as client2, \ |
|||
socketio.SimpleClient() as client3, \ |
|||
socketio.SimpleClient() as admin_client: |
|||
client1.connect('http://localhost:8900') |
|||
client1.emit('enter_room', 'room') |
|||
sid1 = client1.sid |
|||
|
|||
saved_check_for_upgrade = isvr._check_for_upgrade |
|||
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 |
|||
|
|||
client3.connect('http://localhost:8900', namespace='/admin') |
|||
sid3 = client3.sid |
|||
|
|||
admin_client.connect('http://localhost:8900', namespace='/admin') |
|||
sid = admin_client.sid |
|||
expected = ['config', 'all_sockets', 'server_stats'] |
|||
events = {} |
|||
while expected: |
|||
data = admin_client.receive(timeout=5) |
|||
if data[0] in expected: |
|||
events[data[0]] = data[1] |
|||
expected.remove(data[0]) |
|||
|
|||
assert 'supportedFeatures' in events['config'] |
|||
assert 'ALL_EVENTS' in events['config']['supportedFeatures'] |
|||
assert len(events['all_sockets']) == 4 |
|||
assert events['server_stats']['clientsCount'] == 4 |
|||
assert events['server_stats']['pollingClientsCount'] == 1 |
|||
assert len(events['server_stats']['namespaces']) == 3 |
|||
assert {'name': '/', 'socketsCount': 1} in \ |
|||
events['server_stats']['namespaces'] |
|||
assert {'name': '/foo', 'socketsCount': 1} in \ |
|||
events['server_stats']['namespaces'] |
|||
assert {'name': '/admin', 'socketsCount': 2} in \ |
|||
events['server_stats']['namespaces'] |
|||
|
|||
for socket in events['all_sockets']: |
|||
if socket['id'] == sid: |
|||
assert socket['rooms'] == [sid] |
|||
elif socket['id'] == sid1: |
|||
assert socket['rooms'] == [sid1, 'room'] |
|||
elif socket['id'] == sid2: |
|||
assert socket['rooms'] == [sid2] |
|||
elif socket['id'] == sid3: |
|||
assert socket['rooms'] == [sid3] |
|||
|
|||
@with_instrumented_server(mode='production') |
|||
def test_admin_connect_production(self, isvr): |
|||
with socketio.SimpleClient() as admin_client: |
|||
admin_client.connect('http://localhost:8900', namespace='/admin') |
|||
expected = ['config', 'server_stats'] |
|||
events = {} |
|||
while expected: |
|||
data = admin_client.receive(timeout=5) |
|||
if data[0] in expected: |
|||
events[data[0]] = data[1] |
|||
expected.remove(data[0]) |
|||
|
|||
assert 'supportedFeatures' in events['config'] |
|||
assert 'ALL_EVENTS' not in events['config']['supportedFeatures'] |
|||
assert events['server_stats']['clientsCount'] == 1 |
|||
assert events['server_stats']['pollingClientsCount'] == 0 |
|||
assert len(events['server_stats']['namespaces']) == 3 |
|||
assert {'name': '/', 'socketsCount': 0} in \ |
|||
events['server_stats']['namespaces'] |
|||
assert {'name': '/foo', 'socketsCount': 0} in \ |
|||
events['server_stats']['namespaces'] |
|||
assert {'name': '/admin', 'socketsCount': 1} in \ |
|||
events['server_stats']['namespaces'] |
|||
|
|||
@with_instrumented_server() |
|||
def test_admin_features(self, isvr): |
|||
with socketio.SimpleClient() as client1, \ |
|||
socketio.SimpleClient() as client2, \ |
|||
socketio.SimpleClient() as admin_client: |
|||
client1.connect('http://localhost:8900') |
|||
client2.connect('http://localhost:8900') |
|||
admin_client.connect('http://localhost:8900', namespace='/admin') |
|||
|
|||
# emit from admin |
|||
admin_client.emit( |
|||
'emit', ('/', client1.sid, 'foo', {'bar': 'baz'}, 'extra')) |
|||
data = client1.receive(timeout=5) |
|||
assert data == ['foo', {'bar': 'baz'}, 'extra'] |
|||
|
|||
# emit from regular client |
|||
client1.emit('emit', 'foo') |
|||
data = client2.receive(timeout=5) |
|||
assert data == ['foo'] |
|||
|
|||
# join and leave |
|||
admin_client.emit('join', ('/', 'room', client1.sid)) |
|||
admin_client.emit( |
|||
'emit', ('/', 'room', 'foo', {'bar': 'baz'})) |
|||
data = client1.receive(timeout=5) |
|||
assert data == ['foo', {'bar': 'baz'}] |
|||
admin_client.emit('leave', ('/', 'room')) |
|||
|
|||
# disconnect |
|||
admin_client.emit('_disconnect', ('/', False, client1.sid)) |
|||
for _ in range(10): |
|||
if not client1.connected: |
|||
break |
|||
time.sleep(0.2) |
|||
assert not client1.connected |
|||
@ -0,0 +1,57 @@ |
|||
import requests |
|||
import threading |
|||
import time |
|||
import uvicorn |
|||
import socketio |
|||
|
|||
|
|||
class SocketIOWebServer: |
|||
"""A simple web server used for running Socket.IO servers in tests. |
|||
|
|||
:param sio: a Socket.IO server instance. |
|||
|
|||
Note 1: This class is not production-ready and is intended for testing. |
|||
Note 2: This class only supports the "asgi" async_mode. |
|||
""" |
|||
def __init__(self, sio, on_shutdown=None): |
|||
if sio.async_mode != 'asgi': |
|||
raise ValueError('The async_mode must be "asgi"') |
|||
|
|||
async def http_app(scope, receive, send): |
|||
await send({'type': 'http.response.start', |
|||
'status': 200, |
|||
'headers': [('Content-Type', 'text/plain')]}) |
|||
await send({'type': 'http.response.body', |
|||
'body': b'OK'}) |
|||
|
|||
self.sio = sio |
|||
self.app = socketio.ASGIApp(sio, http_app, on_shutdown=on_shutdown) |
|||
self.httpd = None |
|||
self.thread = None |
|||
|
|||
def start(self, port=8900): |
|||
"""Start the web server. |
|||
|
|||
:param port: the port to listen on. Defaults to 8900. |
|||
|
|||
The server is started in a background thread. |
|||
""" |
|||
self.httpd = uvicorn.Server(config=uvicorn.Config(self.app, port=port)) |
|||
self.thread = threading.Thread(target=self.httpd.run) |
|||
self.thread.start() |
|||
|
|||
# wait for the server to start |
|||
while True: |
|||
try: |
|||
r = requests.get(f'http://localhost:{port}/') |
|||
r.raise_for_status() |
|||
if r.text == 'OK': |
|||
break |
|||
except: |
|||
time.sleep(0.1) |
|||
|
|||
def stop(self): |
|||
"""Stop the web server.""" |
|||
self.httpd.should_exit = True |
|||
self.thread.join() |
|||
self.thread = None |
|||
@ -0,0 +1,277 @@ |
|||
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 |
|||
from socketio.exceptions import ConnectionError |
|||
from tests.web_server import SocketIOWebServer |
|||
|
|||
|
|||
def with_instrumented_server(auth=False, **ikwargs): |
|||
"""This decorator can be applied to test functions or methods so that they |
|||
run with a Socket.IO server that has been instrumented for the official |
|||
Admin UI project. The arguments passed to the decorator are passed directly |
|||
to the ``instrument()`` method of the server. |
|||
""" |
|||
def decorator(f): |
|||
@wraps(f) |
|||
def wrapped(self, *args, **kwargs): |
|||
sio = socketio.Server(async_mode='threading') |
|||
instrumented_server = sio.instrument(auth=auth, **ikwargs) |
|||
|
|||
@sio.event |
|||
def enter_room(sid, data): |
|||
sio.enter_room(sid, data) |
|||
|
|||
@sio.event |
|||
def emit(sid, event): |
|||
sio.emit(event, skip_sid=sid) |
|||
|
|||
@sio.event(namespace='/foo') |
|||
def connect(sid, environ, auth): |
|||
pass |
|||
|
|||
server = SocketIOWebServer(sio) |
|||
server.start() |
|||
|
|||
# import logging |
|||
# logging.getLogger('engineio.client').setLevel(logging.DEBUG) |
|||
# logging.getLogger('socketio.client').setLevel(logging.DEBUG) |
|||
|
|||
original_schedule_ping = EngineIOSocket.schedule_ping |
|||
EngineIOSocket.schedule_ping = mock.MagicMock() |
|||
|
|||
try: |
|||
ret = f(self, instrumented_server, *args, **kwargs) |
|||
finally: |
|||
server.stop() |
|||
instrumented_server.shutdown() |
|||
instrumented_server.uninstrument() |
|||
|
|||
EngineIOSocket.schedule_ping = original_schedule_ping |
|||
|
|||
# import logging |
|||
# logging.getLogger('engineio.client').setLevel(logging.NOTSET) |
|||
# logging.getLogger('socketio.client').setLevel(logging.NOTSET) |
|||
|
|||
return ret |
|||
return wrapped |
|||
return decorator |
|||
|
|||
|
|||
def _custom_auth(auth): |
|||
return auth == {'foo': 'bar'} |
|||
|
|||
|
|||
class TestAdmin(unittest.TestCase): |
|||
def setUp(self): |
|||
print('threads at start:', threading.enumerate()) |
|||
self.thread_count = threading.active_count() |
|||
|
|||
def tearDown(self): |
|||
print('threads at end:', threading.enumerate()) |
|||
assert self.thread_count == threading.active_count() |
|||
|
|||
def test_missing_auth(self): |
|||
sio = socketio.Server(async_mode='threading') |
|||
with pytest.raises(ValueError): |
|||
sio.instrument() |
|||
|
|||
@with_instrumented_server(auth=False) |
|||
def test_admin_connect_with_no_auth(self, isvr): |
|||
with socketio.SimpleClient() as admin_client: |
|||
admin_client.connect('http://localhost:8900', namespace='/admin') |
|||
with socketio.SimpleClient() as admin_client: |
|||
admin_client.connect('http://localhost:8900', namespace='/admin', |
|||
auth={'foo': 'bar'}) |
|||
|
|||
@with_instrumented_server(auth={'foo': 'bar'}) |
|||
def test_admin_connect_with_dict_auth(self, isvr): |
|||
with socketio.SimpleClient() as admin_client: |
|||
admin_client.connect('http://localhost:8900', namespace='/admin', |
|||
auth={'foo': 'bar'}) |
|||
with socketio.SimpleClient() as admin_client: |
|||
with pytest.raises(ConnectionError): |
|||
admin_client.connect( |
|||
'http://localhost:8900', namespace='/admin', |
|||
auth={'foo': 'baz'}) |
|||
with socketio.SimpleClient() as admin_client: |
|||
with pytest.raises(ConnectionError): |
|||
admin_client.connect( |
|||
'http://localhost:8900', namespace='/admin') |
|||
|
|||
@with_instrumented_server(auth=[{'foo': 'bar'}, |
|||
{'u': 'admin', 'p': 'secret'}]) |
|||
def test_admin_connect_with_list_auth(self, isvr): |
|||
with socketio.SimpleClient() as admin_client: |
|||
admin_client.connect('http://localhost:8900', namespace='/admin', |
|||
auth={'foo': 'bar'}) |
|||
with socketio.SimpleClient() as admin_client: |
|||
admin_client.connect('http://localhost:8900', namespace='/admin', |
|||
auth={'u': 'admin', 'p': 'secret'}) |
|||
with socketio.SimpleClient() as admin_client: |
|||
with pytest.raises(ConnectionError): |
|||
admin_client.connect('http://localhost:8900', |
|||
namespace='/admin', auth={'foo': 'baz'}) |
|||
with socketio.SimpleClient() as admin_client: |
|||
with pytest.raises(ConnectionError): |
|||
admin_client.connect('http://localhost:8900', |
|||
namespace='/admin') |
|||
|
|||
@with_instrumented_server(auth=_custom_auth) |
|||
def test_admin_connect_with_function_auth(self, isvr): |
|||
with socketio.SimpleClient() as admin_client: |
|||
admin_client.connect('http://localhost:8900', namespace='/admin', |
|||
auth={'foo': 'bar'}) |
|||
with socketio.SimpleClient() as admin_client: |
|||
with pytest.raises(ConnectionError): |
|||
admin_client.connect('http://localhost:8900', |
|||
namespace='/admin', auth={'foo': 'baz'}) |
|||
with socketio.SimpleClient() as admin_client: |
|||
with pytest.raises(ConnectionError): |
|||
admin_client.connect('http://localhost:8900', |
|||
namespace='/admin') |
|||
|
|||
@with_instrumented_server() |
|||
def test_admin_connect_only_admin(self, isvr): |
|||
with socketio.SimpleClient() as admin_client: |
|||
admin_client.connect('http://localhost:8900', namespace='/admin') |
|||
sid = admin_client.sid |
|||
expected = ['config', 'all_sockets', 'server_stats'] |
|||
events = {} |
|||
while expected: |
|||
data = admin_client.receive(timeout=5) |
|||
if data[0] in expected: |
|||
events[data[0]] = data[1] |
|||
expected.remove(data[0]) |
|||
|
|||
assert 'supportedFeatures' in events['config'] |
|||
assert 'ALL_EVENTS' in events['config']['supportedFeatures'] |
|||
assert len(events['all_sockets']) == 1 |
|||
assert events['all_sockets'][0]['id'] == sid |
|||
assert events['all_sockets'][0]['rooms'] == [sid] |
|||
assert events['server_stats']['clientsCount'] == 1 |
|||
assert events['server_stats']['pollingClientsCount'] == 0 |
|||
assert len(events['server_stats']['namespaces']) == 3 |
|||
assert {'name': '/', 'socketsCount': 0} in \ |
|||
events['server_stats']['namespaces'] |
|||
assert {'name': '/foo', 'socketsCount': 0} in \ |
|||
events['server_stats']['namespaces'] |
|||
assert {'name': '/admin', 'socketsCount': 1} in \ |
|||
events['server_stats']['namespaces'] |
|||
|
|||
@with_instrumented_server() |
|||
def test_admin_connect_with_others(self, isvr): |
|||
with socketio.SimpleClient() as client1, \ |
|||
socketio.SimpleClient() as client2, \ |
|||
socketio.SimpleClient() as client3, \ |
|||
socketio.SimpleClient() as admin_client: |
|||
client1.connect('http://localhost:8900') |
|||
client1.emit('enter_room', 'room') |
|||
sid1 = client1.sid |
|||
|
|||
saved_check_for_upgrade = isvr._check_for_upgrade |
|||
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 |
|||
|
|||
client3.connect('http://localhost:8900', namespace='/admin') |
|||
sid3 = client3.sid |
|||
|
|||
admin_client.connect('http://localhost:8900', namespace='/admin') |
|||
sid = admin_client.sid |
|||
expected = ['config', 'all_sockets', 'server_stats'] |
|||
events = {} |
|||
while expected: |
|||
data = admin_client.receive(timeout=5) |
|||
if data[0] in expected: |
|||
events[data[0]] = data[1] |
|||
expected.remove(data[0]) |
|||
|
|||
assert 'supportedFeatures' in events['config'] |
|||
assert 'ALL_EVENTS' in events['config']['supportedFeatures'] |
|||
assert len(events['all_sockets']) == 4 |
|||
assert events['server_stats']['clientsCount'] == 4 |
|||
assert events['server_stats']['pollingClientsCount'] == 1 |
|||
assert len(events['server_stats']['namespaces']) == 3 |
|||
assert {'name': '/', 'socketsCount': 1} in \ |
|||
events['server_stats']['namespaces'] |
|||
assert {'name': '/foo', 'socketsCount': 1} in \ |
|||
events['server_stats']['namespaces'] |
|||
assert {'name': '/admin', 'socketsCount': 2} in \ |
|||
events['server_stats']['namespaces'] |
|||
|
|||
for socket in events['all_sockets']: |
|||
if socket['id'] == sid: |
|||
assert socket['rooms'] == [sid] |
|||
elif socket['id'] == sid1: |
|||
assert socket['rooms'] == [sid1, 'room'] |
|||
elif socket['id'] == sid2: |
|||
assert socket['rooms'] == [sid2] |
|||
elif socket['id'] == sid3: |
|||
assert socket['rooms'] == [sid3] |
|||
|
|||
@with_instrumented_server(mode='production') |
|||
def test_admin_connect_production(self, isvr): |
|||
with socketio.SimpleClient() as admin_client: |
|||
admin_client.connect('http://localhost:8900', namespace='/admin') |
|||
expected = ['config', 'server_stats'] |
|||
events = {} |
|||
while expected: |
|||
data = admin_client.receive(timeout=5) |
|||
if data[0] in expected: |
|||
events[data[0]] = data[1] |
|||
expected.remove(data[0]) |
|||
|
|||
assert 'supportedFeatures' in events['config'] |
|||
assert 'ALL_EVENTS' not in events['config']['supportedFeatures'] |
|||
assert events['server_stats']['clientsCount'] == 1 |
|||
assert events['server_stats']['pollingClientsCount'] == 0 |
|||
assert len(events['server_stats']['namespaces']) == 3 |
|||
assert {'name': '/', 'socketsCount': 0} in \ |
|||
events['server_stats']['namespaces'] |
|||
assert {'name': '/foo', 'socketsCount': 0} in \ |
|||
events['server_stats']['namespaces'] |
|||
assert {'name': '/admin', 'socketsCount': 1} in \ |
|||
events['server_stats']['namespaces'] |
|||
|
|||
@with_instrumented_server() |
|||
def test_admin_features(self, isvr): |
|||
with socketio.SimpleClient() as client1, \ |
|||
socketio.SimpleClient() as client2, \ |
|||
socketio.SimpleClient() as admin_client: |
|||
client1.connect('http://localhost:8900') |
|||
client2.connect('http://localhost:8900') |
|||
admin_client.connect('http://localhost:8900', namespace='/admin') |
|||
|
|||
# emit from admin |
|||
admin_client.emit( |
|||
'emit', ('/', client1.sid, 'foo', {'bar': 'baz'}, 'extra')) |
|||
data = client1.receive(timeout=5) |
|||
assert data == ['foo', {'bar': 'baz'}, 'extra'] |
|||
|
|||
# emit from regular client |
|||
client1.emit('emit', 'foo') |
|||
data = client2.receive(timeout=5) |
|||
assert data == ['foo'] |
|||
|
|||
# join and leave |
|||
admin_client.emit('join', ('/', 'room', client1.sid)) |
|||
admin_client.emit( |
|||
'emit', ('/', 'room', 'foo', {'bar': 'baz'})) |
|||
data = client1.receive(timeout=5) |
|||
assert data == ['foo', {'bar': 'baz'}] |
|||
admin_client.emit('leave', ('/', 'room')) |
|||
|
|||
# disconnect |
|||
admin_client.emit('_disconnect', ('/', False, client1.sid)) |
|||
for _ in range(10): |
|||
if not client1.connected: |
|||
break |
|||
time.sleep(0.2) |
|||
assert not client1.connected |
|||
@ -0,0 +1,81 @@ |
|||
import threading |
|||
import time |
|||
from socketserver import ThreadingMixIn |
|||
from wsgiref.simple_server import make_server, WSGIServer, WSGIRequestHandler |
|||
import requests |
|||
import socketio |
|||
|
|||
|
|||
class SocketIOWebServer: |
|||
"""A simple web server used for running Socket.IO servers in tests. |
|||
|
|||
:param sio: a Socket.IO server instance. |
|||
|
|||
Note 1: This class is not production-ready and is intended for testing. |
|||
Note 2: This class only supports the "threading" async_mode, with WebSocket |
|||
support provided by the simple-websocket package. |
|||
""" |
|||
def __init__(self, sio): |
|||
if sio.async_mode != 'threading': |
|||
raise ValueError('The async_mode must be "threading"') |
|||
|
|||
def http_app(environ, start_response): |
|||
start_response('200 OK', [('Content-Type', 'text/plain')]) |
|||
return [b'OK'] |
|||
|
|||
self.sio = sio |
|||
self.app = socketio.WSGIApp(sio, http_app) |
|||
self.httpd = None |
|||
self.thread = None |
|||
|
|||
def start(self, port=8900): |
|||
"""Start the web server. |
|||
|
|||
:param port: the port to listen on. Defaults to 8900. |
|||
|
|||
The server is started in a background thread. |
|||
""" |
|||
class ThreadingWSGIServer(ThreadingMixIn, WSGIServer): |
|||
pass |
|||
|
|||
class WebSocketRequestHandler(WSGIRequestHandler): |
|||
def get_environ(self): |
|||
env = super().get_environ() |
|||
|
|||
# pass the raw socket to the WSGI app so that it can be used |
|||
# by WebSocket connections (hack copied from gunicorn) |
|||
env['gunicorn.socket'] = self.connection |
|||
return env |
|||
|
|||
self.httpd = make_server('', port, self._app_wrapper, |
|||
ThreadingWSGIServer, WebSocketRequestHandler) |
|||
self.thread = threading.Thread(target=self.httpd.serve_forever) |
|||
self.thread.start() |
|||
|
|||
# wait for the server to start |
|||
while True: |
|||
try: |
|||
r = requests.get(f'http://localhost:{port}/') |
|||
r.raise_for_status() |
|||
if r.text == 'OK': |
|||
break |
|||
except: |
|||
time.sleep(0.1) |
|||
|
|||
def stop(self): |
|||
"""Stop the web server.""" |
|||
self.sio.shutdown() |
|||
self.httpd.shutdown() |
|||
self.httpd.server_close() |
|||
self.thread.join() |
|||
self.httpd = None |
|||
self.thread = None |
|||
|
|||
def _app_wrapper(self, environ, start_response): |
|||
try: |
|||
return self.app(environ, start_response) |
|||
except StopIteration: |
|||
# end the WebSocket request without sending a response |
|||
# (this is a hack that was copied from gunicorn's threaded worker) |
|||
start_response('200 OK', []) |
|||
return [] |
|||
Loading…
Reference in new issue