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 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
|
import sys
import time
import errno
import socket
import threading
from boltons.socketutils import (BufferedSocket,
NetstringSocket,
ConnectionClosed,
NetstringMessageTooLong,
MessageTooLong,
Timeout)
import pytest
# skip if there's no socketpair
pytestmark = pytest.mark.skipif(getattr(socket, 'socketpair', None) is None,
reason='no socketpair (likely Py2 on Windows)')
def test_short_lines():
for ms in (2, 4, 6, 1024, None):
x, y = socket.socketpair()
bs = BufferedSocket(x)
y.sendall(b'1\n2\n3\n')
assert bs.recv_until(b'\n', maxsize=ms) == b'1'
assert bs.recv_until(b'\n', maxsize=ms) == b'2'
y.close()
assert bs.recv_close(maxsize=ms) == b'3\n'
try:
bs.recv_size(1)
except ConnectionClosed:
pass
else:
assert False, 'expected ConnectionClosed'
bs.close()
return
def test_multibyte_delim():
"""Primarily tests recv_until with various maxsizes and True/False
for with_delimiter.
"""
delim = b'\r\n'
for with_delim in (True, False):
if with_delim:
cond_delim = b'\r\n'
else:
cond_delim = b''
empty = b''
small_one = b'1'
big_two = b'2' * 2048
for ms in (3, 5, 1024, None):
x, y = socket.socketpair()
bs = BufferedSocket(x)
y.sendall(empty + delim)
y.sendall(small_one + delim)
y.sendall(big_two + delim)
kwargs = {'maxsize': ms, 'with_delimiter': with_delim}
assert bs.recv_until(delim, **kwargs) == empty + cond_delim
assert bs.recv_until(delim, **kwargs) == small_one + cond_delim
try:
assert bs.recv_until(delim, **kwargs) == big_two + cond_delim
except MessageTooLong:
if ms is None:
assert False, 'unexpected MessageTooLong'
else:
if ms is not None:
assert False, 'expected MessageTooLong'
return
def test_props():
x, y = socket.socketpair()
bs = BufferedSocket(x)
assert bs.type == x.type
assert bs.proto == x.proto
assert bs.family == x.family
return
def test_buffers():
x, y = socket.socketpair()
bx, by = BufferedSocket(x), BufferedSocket(y)
assert by.getrecvbuffer() == b''
assert by.getsendbuffer() == b''
assert bx.getrecvbuffer() == b''
by.buffer(b'12')
by.sendall(b'3')
assert bx.recv_size(1) == b'1'
assert bx.getrecvbuffer() == b'23'
return
def test_client_disconnecting():
def get_bs_pair():
x, y = socket.socketpair()
bx, by = BufferedSocket(x), BufferedSocket(y)
# sanity check
by.sendall(b'123')
bx.recv_size(3) == b'123'
return bx, by
bx, by = get_bs_pair()
assert bx.fileno() > 0
bx.close()
assert bx.getrecvbuffer() == b''
try:
bx.recv(1)
except OSError:
pass
else:
assert False, 'expected socket.error on closed recv'
assert bx.fileno() == -1
by.buffer(b'123')
assert by.getsendbuffer()
try:
by.flush()
except OSError:
assert by.getsendbuffer() == b'123'
else:
if sys.platform != 'win32': # Windows socketpairs are kind of bad
assert False, 'expected socket.error broken pipe'
try:
by.shutdown(socket.SHUT_RDWR)
except OSError:
# Mac sockets are already shut down at this point. See #71.
if sys.platform != 'darwin':
raise
by.close()
assert not by.getsendbuffer()
try:
by.send(b'123')
except OSError:
pass
else:
assert False, 'expected socket.error on closed send'
return
def test_split_delim():
delim = b'\r\n'
first = b'1234\r'
second = b'\n5'
x, y = socket.socketpair()
bs = BufferedSocket(x)
y.sendall(first)
try:
bs.recv_until(delim, timeout=0.0001)
except Timeout:
pass
y.sendall(second)
assert bs.recv_until(delim, with_delimiter=True) == b'1234\r\n'
assert bs.recv_size(1) == b'5'
return
def test_basic_nonblocking():
delim = b'\n'
# test with per-call timeout
x, y = socket.socketpair()
bs = BufferedSocket(x)
try:
bs.recv_until(delim, timeout=0)
except OSError as se:
assert se.errno == errno.EWOULDBLOCK
y.sendall(delim) # sending an empty message, effectively
assert bs.recv_until(delim) == b''
# test with instance-level default timeout
x, y = socket.socketpair()
bs = BufferedSocket(x, timeout=0)
try:
bs.recv_until(delim)
except OSError as se:
assert se.errno == errno.EWOULDBLOCK
y.sendall(delim)
assert bs.recv_until(delim) == b''
# test with setblocking(0) on the underlying socket
x, y = socket.socketpair()
x.setblocking(0)
bs = BufferedSocket(x)
try:
bs.recv_until(delim)
except OSError as se:
assert se.errno == errno.EWOULDBLOCK
y.sendall(delim)
assert bs.recv_until(delim) == b''
return
def test_simple_buffered_socket_passthroughs():
x, y = socket.socketpair()
bs = BufferedSocket(x)
assert bs.getsockname() == x.getsockname()
assert bs.getpeername() == x.getpeername()
def test_timeout_setters_getters():
x, y = socket.socketpair()
bs = BufferedSocket(x)
assert bs.settimeout(1.0) is None
assert bs.gettimeout() == 1.0
assert bs.setblocking(False) is None
assert bs.gettimeout() == 0.0
assert bs.setblocking(True) is None
assert bs.gettimeout() is None
def netstring_server(server_socket):
"A basic netstring server loop, supporting a few operations"
try:
while True:
clientsock, addr = server_socket.accept()
client = NetstringSocket(clientsock)
while 1:
request = client.read_ns()
if request == b'close':
clientsock.close()
break
elif request == b'shutdown':
return
elif request == b'reply4k':
client.write_ns(b'a' * 4096)
elif request == b'ping':
client.write_ns(b'pong')
elif request == b'reply128k':
client.setmaxsize(128 * 1024)
client.write_ns(b'huge' * 32 * 1024) # 128kb
client.setmaxsize(32768) # back to default
except Exception as e:
print('netstring_server exiting with error: %r' % e)
raise
def test_socketutils_netstring():
"""A holistic feature test of BufferedSocket via the NetstringSocket
wrapper. Runs
"""
print("running self tests")
# Set up server
server_socket = socket.socket()
server_socket.bind(('127.0.0.1', 0)) # localhost with ephemeral port
server_socket.listen(100)
ip, port = server_socket.getsockname()
start_server = lambda: netstring_server(server_socket)
threading.Thread(target=start_server).start()
# set up client
def client_connect():
clientsock = socket.create_connection((ip, port))
client = NetstringSocket(clientsock)
return client
# connect, ping-pong
client = client_connect()
client.write_ns(b'ping')
assert client.read_ns() == b'pong'
s = time.time()
for i in range(1000):
client.write_ns(b'ping')
assert client.read_ns() == b'pong'
dur = time.time() - s
print("netstring ping-pong latency", dur, "ms")
s = time.time()
for i in range(1000):
client.write_ns(b'ping')
resps = []
for i in range(1000):
resps.append(client.read_ns())
e = time.time()
assert all([r == b'pong' for r in resps])
assert client.bsock.getrecvbuffer() == b''
dur = e - s
print("netstring pipelined ping-pong latency", dur, "ms")
# tell the server to close the socket and then try a failure case
client.write_ns(b'close')
try:
client.read_ns()
raise Exception('read from closed socket')
except ConnectionClosed:
print("raised ConnectionClosed correctly")
# test big messages
client = client_connect()
client.setmaxsize(128 * 1024)
client.write_ns(b'reply128k')
res = client.read_ns()
assert len(res) == (128 * 1024)
client.write_ns(b'close')
# test that read timeouts work
client = client_connect()
client.settimeout(0.1)
try:
client.read_ns()
raise Exception('did not timeout')
except Timeout:
print("read_ns raised timeout correctly")
client.write_ns(b'close')
# test that netstring max sizes work
client = client_connect()
client.setmaxsize(2048)
client.write_ns(b'reply4k')
try:
client.read_ns()
raise Exception('read more than maxsize')
except NetstringMessageTooLong:
print("raised MessageTooLong correctly")
try:
client.bsock.recv_until(b'b', maxsize=4096)
raise Exception('recv_until did not raise MessageTooLong')
except MessageTooLong:
print("raised MessageTooLong correctly")
assert client.bsock.recv_size(4097) == b'a' * 4096 + b','
print('correctly maintained buffer after exception raised')
# test BufferedSocket read timeouts with recv_until and recv_size
client.bsock.settimeout(0.01)
try:
client.bsock.recv_until(b'a')
raise Exception('recv_until did not raise Timeout')
except Timeout:
print('recv_until correctly raised Timeout')
try:
client.bsock.recv_size(1)
raise Exception('recv_size did not raise Timeout')
except Timeout:
print('recv_size correctly raised Timeout')
client.write_ns(b'shutdown')
print("all passed")
def netstring_server_timeout_override(server_socket):
"""Netstring socket has an unreasonably low timeout,
however it should be overridden by the `read_ns` argument."""
try:
while True:
clientsock, addr = server_socket.accept()
client = NetstringSocket(clientsock, timeout=0.01)
while 1:
request = client.read_ns(1)
if request == b'close':
clientsock.close()
break
elif request == b'shutdown':
return
elif request == b'ping':
client.write_ns(b'pong')
except Exception as e:
print('netstring_server exiting with error: %r' % e)
raise
def test_socketutils_netstring_timeout():
"""Tests that server socket timeout is overridden by the argument to read call.
Server has timeout of 10 ms, and we will sleep for 20 ms. If timeout is not overridden correctly,
a timeout exception will be raised."""
print("running timeout test")
# Set up server
server_socket = socket.socket()
server_socket.bind(('127.0.0.1', 0)) # localhost with ephemeral port
server_socket.listen(100)
ip, port = server_socket.getsockname()
start_server = lambda: netstring_server_timeout_override(server_socket)
threading.Thread(target=start_server).start()
# set up client
def client_connect():
clientsock = socket.create_connection((ip, port))
client = NetstringSocket(clientsock)
return client
# connect, ping-pong
client = client_connect()
time.sleep(0.02)
client.write_ns(b'ping')
assert client.read_ns() == b'pong'
client.write_ns(b'shutdown')
print("no timeout occurred - all good.")
|