1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
|
import time
import unittest
from unittest import mock
import pytest # noqa: F401
from wsproto.events import Request, CloseConnection, TextMessage, \
BytesMessage, Ping, Pong
import simple_websocket
class SimpleWebSocketServerTestCase(unittest.TestCase):
def get_server(self, mock_wsconn, environ, events=[],
client_subprotocols=None, server_subprotocols=None,
**kwargs):
mock_wsconn().events.side_effect = \
[iter(ev) for ev in [[
Request(host='example.com', target='/ws',
subprotocols=client_subprotocols or [])]] +
events + [[CloseConnection(1000, 'bye')]]]
mock_wsconn().send = lambda x: str(x).encode('utf-8')
environ.update({
'HTTP_HOST': 'example.com',
'HTTP_CONNECTION': 'Upgrade',
'HTTP_UPGRADE': 'websocket',
'HTTP_SEC_WEBSOCKET_KEY': 'Iv8io/9s+lYFgZWcXczP8Q==',
'HTTP_SEC_WEBSOCKET_VERSION': '13',
})
return simple_websocket.Server.accept(
environ, subprotocols=server_subprotocols, **kwargs)
@mock.patch('simple_websocket.ws.WSConnection')
def test_werkzeug(self, mock_wsconn):
mock_socket = mock.MagicMock()
mock_socket.recv.return_value = b'x'
server = self.get_server(mock_wsconn, {
'werkzeug.socket': mock_socket,
})
assert server.sock == mock_socket
assert server.mode == 'werkzeug'
assert server.receive_bytes == 4096
assert server.input_buffer == []
assert server.event.__class__.__name__ == 'Event'
mock_wsconn().receive_data.assert_any_call(
b'GET / HTTP/1.1\r\n'
b'Host: example.com\r\n'
b'Connection: Upgrade\r\n'
b'Upgrade: websocket\r\n'
b'Sec-Websocket-Key: Iv8io/9s+lYFgZWcXczP8Q==\r\n'
b'Sec-Websocket-Version: 13\r\n\r\n')
assert server.is_server
@mock.patch('simple_websocket.ws.WSConnection')
def test_gunicorn(self, mock_wsconn):
mock_socket = mock.MagicMock()
mock_socket.recv.return_value = b'x'
server = self.get_server(mock_wsconn, {
'gunicorn.socket': mock_socket,
})
assert server.sock == mock_socket
assert server.mode == 'gunicorn'
assert server.receive_bytes == 4096
assert server.input_buffer == []
assert server.event.__class__.__name__ == 'Event'
mock_wsconn().receive_data.assert_any_call(
b'GET / HTTP/1.1\r\n'
b'Host: example.com\r\n'
b'Connection: Upgrade\r\n'
b'Upgrade: websocket\r\n'
b'Sec-Websocket-Key: Iv8io/9s+lYFgZWcXczP8Q==\r\n'
b'Sec-Websocket-Version: 13\r\n\r\n')
assert server.is_server
def test_no_socket(self):
with pytest.raises(RuntimeError):
self.get_server(mock.MagicMock(), {})
@mock.patch('simple_websocket.ws.WSConnection')
def test_send(self, mock_wsconn):
mock_socket = mock.MagicMock()
mock_socket.recv.return_value = b'x'
server = self.get_server(mock_wsconn, {
'werkzeug.socket': mock_socket,
})
while server.connected:
time.sleep(0.01)
with pytest.raises(simple_websocket.ConnectionClosed):
server.send('hello')
server.connected = True
server.send('hello')
mock_socket.send.assert_called_with(
b"TextMessage(data='hello', frame_finished=True, "
b"message_finished=True)")
server.connected = True
server.send(b'hello')
mock_socket.send.assert_called_with(
b"Message(data=b'hello', frame_finished=True, "
b"message_finished=True)")
@mock.patch('simple_websocket.ws.WSConnection')
def test_receive(self, mock_wsconn):
mock_socket = mock.MagicMock()
mock_socket.recv.return_value = b'x'
server = self.get_server(mock_wsconn, {
'werkzeug.socket': mock_socket,
}, events=[
[TextMessage('hello')],
[BytesMessage(b'hello')],
])
while server.connected:
time.sleep(0.01)
server.connected = True
assert server.receive() == 'hello'
assert server.receive() == b'hello'
assert server.receive(timeout=0) is None
@mock.patch('simple_websocket.ws.WSConnection')
def test_receive_after_close(self, mock_wsconn):
mock_socket = mock.MagicMock()
mock_socket.recv.return_value = b'x'
server = self.get_server(mock_wsconn, {
'werkzeug.socket': mock_socket,
}, events=[
[TextMessage('hello')],
])
while server.connected:
time.sleep(0.01)
assert server.receive() == 'hello'
with pytest.raises(simple_websocket.ConnectionClosed):
server.receive()
@mock.patch('simple_websocket.ws.WSConnection')
def test_receive_split_messages(self, mock_wsconn):
mock_socket = mock.MagicMock()
mock_socket.recv.return_value = b'x'
server = self.get_server(mock_wsconn, {
'werkzeug.socket': mock_socket,
}, events=[
[TextMessage('hel', message_finished=False)],
[TextMessage('lo')],
[TextMessage('he', message_finished=False)],
[TextMessage('l', message_finished=False)],
[TextMessage('lo')],
[BytesMessage(b'hel', message_finished=False)],
[BytesMessage(b'lo')],
[BytesMessage(b'he', message_finished=False)],
[BytesMessage(b'l', message_finished=False)],
[BytesMessage(b'lo')],
])
while server.connected:
time.sleep(0.01)
server.connected = True
assert server.receive() == 'hello'
assert server.receive() == 'hello'
assert server.receive() == b'hello'
assert server.receive() == b'hello'
assert server.receive(timeout=0) is None
@mock.patch('simple_websocket.ws.WSConnection')
def test_receive_ping(self, mock_wsconn):
mock_socket = mock.MagicMock()
mock_socket.recv.return_value = b'x'
server = self.get_server(mock_wsconn, {
'werkzeug.socket': mock_socket,
}, events=[
[Ping(b'hello')],
])
while server.connected:
time.sleep(0.01)
mock_socket.send.assert_any_call(b"Pong(payload=b'hello')")
@mock.patch('simple_websocket.ws.WSConnection')
def test_receive_empty(self, mock_wsconn):
mock_socket = mock.MagicMock()
mock_socket.recv.side_effect = [b'x', b'x', b'']
server = self.get_server(mock_wsconn, {
'werkzeug.socket': mock_socket,
}, events=[
[TextMessage('hello')],
])
while server.connected:
time.sleep(0.01)
server.connected = True
assert server.receive() == 'hello'
assert server.receive(timeout=0) is None
@mock.patch('simple_websocket.ws.WSConnection')
def test_receive_large(self, mock_wsconn):
mock_socket = mock.MagicMock()
mock_socket.recv.return_value = b'x'
server = self.get_server(mock_wsconn, {
'werkzeug.socket': mock_socket,
}, events=[
[TextMessage('hello')],
[TextMessage('hello1')],
], max_message_size=5)
while server.connected:
time.sleep(0.01)
server.connected = True
assert server.receive() == 'hello'
assert server.receive(timeout=0) is None
@mock.patch('simple_websocket.ws.WSConnection')
def test_close(self, mock_wsconn):
mock_socket = mock.MagicMock()
mock_socket.recv.return_value = b'x'
server = self.get_server(mock_wsconn, {
'werkzeug.socket': mock_socket,
})
while server.connected:
time.sleep(0.01)
with pytest.raises(simple_websocket.ConnectionClosed) as exc:
server.close()
assert str(exc.value) == 'Connection closed: 1000 bye'
server.connected = True
server.close()
assert not server.connected
mock_socket.send.assert_called_with(
b'CloseConnection(code=<CloseReason.NORMAL_CLOSURE: 1000>, '
b'reason=None)')
@mock.patch('simple_websocket.ws.WSConnection')
@mock.patch('simple_websocket.ws.time')
def test_ping_pong(self, mock_time, mock_wsconn):
mock_sel = mock.MagicMock()
mock_sel().select.side_effect = [True, True, False, False]
mock_time.side_effect = [0, 1, 25.01, 25.02, 28, 52, 76]
mock_socket = mock.MagicMock()
mock_socket.recv.side_effect = [b'x', b'x']
server = self.get_server(
mock_wsconn, {'werkzeug.socket': mock_socket},
events=[
[TextMessage('hello')],
[Pong()],
], ping_interval=25, thread_class=mock.MagicMock(),
selector_class=mock_sel)
server._thread()
assert mock_socket.send.call_count == 4
assert mock_socket.send.call_args_list[1][0][0].startswith(b'Ping')
assert mock_socket.send.call_args_list[2][0][0].startswith(b'Ping')
assert mock_socket.send.call_args_list[3][0][0].startswith(b'Close')
@mock.patch('simple_websocket.ws.WSConnection')
def test_subprotocols(self, mock_wsconn):
mock_socket = mock.MagicMock()
mock_socket.recv.return_value = b'x'
server = self.get_server(mock_wsconn, {
'werkzeug.socket': mock_socket,
}, client_subprotocols=['foo', 'bar'], server_subprotocols='bar')
while server.connected:
time.sleep(0.01)
assert server.subprotocol == 'bar'
server = self.get_server(mock_wsconn, {
'werkzeug.socket': mock_socket,
}, client_subprotocols=['foo', 'bar'], server_subprotocols=['bar'])
while server.connected:
time.sleep(0.01)
assert server.subprotocol == 'bar'
server = self.get_server(mock_wsconn, {
'werkzeug.socket': mock_socket,
}, client_subprotocols=['foo'], server_subprotocols=['foo', 'bar'])
while server.connected:
time.sleep(0.01)
assert server.subprotocol == 'foo'
server = self.get_server(mock_wsconn, {
'werkzeug.socket': mock_socket,
}, client_subprotocols=['foo'], server_subprotocols=['bar', 'baz'])
while server.connected:
time.sleep(0.01)
assert server.subprotocol is None
server = self.get_server(mock_wsconn, {
'werkzeug.socket': mock_socket,
}, client_subprotocols=['foo'], server_subprotocols=None)
while server.connected:
time.sleep(0.01)
assert server.subprotocol is None
|