blob: cc8da17609f7fb97799e90ef5ed871082d098ad4 [file] [log] [blame]
Guido van Rossum24e4af82002-06-12 19:18:08 +00001import unittest
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002from test import support
Barry Warsawcf3d4b51997-01-03 20:03:32 +00003
Christian Heimes5e696852008-04-09 08:37:03 +00004import errno
Gregory P. Smithaafdca82010-01-04 04:50:36 +00005import io
Charles-François Natali65708cf2014-07-25 18:44:30 +01006import itertools
Barry Warsawcf3d4b51997-01-03 20:03:32 +00007import socket
Guido van Rossum24e4af82002-06-12 19:18:08 +00008import select
Nick Coghlan96fe56a2011-08-22 11:55:57 +10009import tempfile
Christian Heimesbbe741d2008-03-28 10:53:29 +000010import time
11import traceback
Alexandre Vassalottif260e442008-05-11 19:59:59 +000012import queue
Jack Jansen522e7692002-09-06 21:57:50 +000013import sys
Christian Heimesfaf2f632008-01-06 16:59:19 +000014import os
15import array
Antoine Pitrouacd0fda2010-10-23 17:01:44 +000016import platform
Antoine Pitrou4b92b5f2010-09-07 21:05:49 +000017import contextlib
Raymond Hettinger027bb632004-05-31 03:09:25 +000018from weakref import proxy
Thomas Wouters0e3f5912006-08-11 14:57:12 +000019import signal
Antoine Pitrou6d7df632010-09-27 17:52:25 +000020import math
Antoine Pitrou6d58d642011-03-20 23:56:36 +010021import pickle
Charles-François Natali47413c12011-10-06 19:47:44 +020022import struct
Antoine Pitroub1c54962010-10-14 15:05:38 +000023try:
Kristján Valur Jónsson10f383a2012-04-07 11:23:31 +000024 import multiprocessing
25except ImportError:
26 multiprocessing = False
Victor Stinnera3c18d02013-09-08 11:53:09 +020027try:
28 import fcntl
29except ImportError:
30 fcntl = None
Barry Warsawcf3d4b51997-01-03 20:03:32 +000031
Benjamin Petersonee8712c2008-05-20 21:35:26 +000032HOST = support.HOST
Marc-André Lemburg8f36af72011-02-25 15:42:01 +000033MSG = 'Michael Gilfix was here\u1234\r\n'.encode('utf-8') ## test unicode string and carriage return
Barry Warsawcf3d4b51997-01-03 20:03:32 +000034
Victor Stinner45df8202010-04-28 22:31:17 +000035try:
36 import _thread as thread
37 import threading
38except ImportError:
39 thread = None
40 threading = None
Victor Stinnere254e532014-07-26 14:36:55 +020041try:
42 import _socket
43except ImportError:
44 _socket = None
45
Victor Stinner45df8202010-04-28 22:31:17 +000046
Charles-François Natali47413c12011-10-06 19:47:44 +020047def _have_socket_can():
48 """Check whether CAN sockets are supported on this host."""
49 try:
50 s = socket.socket(socket.PF_CAN, socket.SOCK_RAW, socket.CAN_RAW)
Andrew Svetlov0832af62012-12-18 23:10:48 +020051 except (AttributeError, OSError):
Charles-François Natali47413c12011-10-06 19:47:44 +020052 return False
53 else:
54 s.close()
55 return True
56
Charles-François Natali10b8cf42011-11-10 19:21:37 +010057def _have_socket_rds():
58 """Check whether RDS sockets are supported on this host."""
59 try:
60 s = socket.socket(socket.PF_RDS, socket.SOCK_SEQPACKET, 0)
61 except (AttributeError, OSError):
62 return False
63 else:
64 s.close()
65 return True
66
Charles-François Natali47413c12011-10-06 19:47:44 +020067HAVE_SOCKET_CAN = _have_socket_can()
68
Charles-François Natali10b8cf42011-11-10 19:21:37 +010069HAVE_SOCKET_RDS = _have_socket_rds()
70
Nick Coghlan96fe56a2011-08-22 11:55:57 +100071# Size in bytes of the int type
72SIZEOF_INT = array.array("i").itemsize
73
Guido van Rossum24e4af82002-06-12 19:18:08 +000074class SocketTCPTest(unittest.TestCase):
Barry Warsawcf3d4b51997-01-03 20:03:32 +000075
Guido van Rossum24e4af82002-06-12 19:18:08 +000076 def setUp(self):
77 self.serv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
Benjamin Petersonee8712c2008-05-20 21:35:26 +000078 self.port = support.bind_port(self.serv)
Guido van Rossum24e4af82002-06-12 19:18:08 +000079 self.serv.listen(1)
Barry Warsawcf3d4b51997-01-03 20:03:32 +000080
Guido van Rossum24e4af82002-06-12 19:18:08 +000081 def tearDown(self):
82 self.serv.close()
83 self.serv = None
Barry Warsawcf3d4b51997-01-03 20:03:32 +000084
Guido van Rossum24e4af82002-06-12 19:18:08 +000085class SocketUDPTest(unittest.TestCase):
86
87 def setUp(self):
88 self.serv = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
Benjamin Petersonee8712c2008-05-20 21:35:26 +000089 self.port = support.bind_port(self.serv)
Guido van Rossum24e4af82002-06-12 19:18:08 +000090
91 def tearDown(self):
92 self.serv.close()
93 self.serv = None
94
Nick Coghlan96fe56a2011-08-22 11:55:57 +100095class ThreadSafeCleanupTestCase(unittest.TestCase):
96 """Subclass of unittest.TestCase with thread-safe cleanup methods.
97
98 This subclass protects the addCleanup() and doCleanups() methods
99 with a recursive lock.
100 """
101
102 if threading:
103 def __init__(self, *args, **kwargs):
104 super().__init__(*args, **kwargs)
105 self._cleanup_lock = threading.RLock()
106
107 def addCleanup(self, *args, **kwargs):
108 with self._cleanup_lock:
109 return super().addCleanup(*args, **kwargs)
110
111 def doCleanups(self, *args, **kwargs):
112 with self._cleanup_lock:
113 return super().doCleanups(*args, **kwargs)
114
Charles-François Natali47413c12011-10-06 19:47:44 +0200115class SocketCANTest(unittest.TestCase):
116
117 """To be able to run this test, a `vcan0` CAN interface can be created with
118 the following commands:
119 # modprobe vcan
120 # ip link add dev vcan0 type vcan
121 # ifconfig vcan0 up
122 """
123 interface = 'vcan0'
124 bufsize = 128
125
Charles-François Natali773e42d2013-02-05 19:42:01 +0100126 """The CAN frame structure is defined in <linux/can.h>:
127
128 struct can_frame {
129 canid_t can_id; /* 32 bit CAN_ID + EFF/RTR/ERR flags */
130 __u8 can_dlc; /* data length code: 0 .. 8 */
131 __u8 data[8] __attribute__((aligned(8)));
132 };
133 """
134 can_frame_fmt = "=IB3x8s"
135 can_frame_size = struct.calcsize(can_frame_fmt)
136
137 """The Broadcast Management Command frame structure is defined
138 in <linux/can/bcm.h>:
139
140 struct bcm_msg_head {
141 __u32 opcode;
142 __u32 flags;
143 __u32 count;
144 struct timeval ival1, ival2;
145 canid_t can_id;
146 __u32 nframes;
147 struct can_frame frames[0];
148 }
149
150 `bcm_msg_head` must be 8 bytes aligned because of the `frames` member (see
151 `struct can_frame` definition). Must use native not standard types for packing.
152 """
153 bcm_cmd_msg_fmt = "@3I4l2I"
154 bcm_cmd_msg_fmt += "x" * (struct.calcsize(bcm_cmd_msg_fmt) % 8)
155
Charles-François Natali47413c12011-10-06 19:47:44 +0200156 def setUp(self):
157 self.s = socket.socket(socket.PF_CAN, socket.SOCK_RAW, socket.CAN_RAW)
Antoine Pitrou86fe8602011-10-10 20:15:59 +0200158 self.addCleanup(self.s.close)
Charles-François Natali47413c12011-10-06 19:47:44 +0200159 try:
160 self.s.bind((self.interface,))
Andrew Svetlov0832af62012-12-18 23:10:48 +0200161 except OSError:
Charles-François Natali47413c12011-10-06 19:47:44 +0200162 self.skipTest('network interface `%s` does not exist' %
163 self.interface)
Charles-François Natali47413c12011-10-06 19:47:44 +0200164
Charles-François Natali10b8cf42011-11-10 19:21:37 +0100165
166class SocketRDSTest(unittest.TestCase):
167
168 """To be able to run this test, the `rds` kernel module must be loaded:
169 # modprobe rds
170 """
171 bufsize = 8192
172
173 def setUp(self):
174 self.serv = socket.socket(socket.PF_RDS, socket.SOCK_SEQPACKET, 0)
175 self.addCleanup(self.serv.close)
176 try:
177 self.port = support.bind_port(self.serv)
178 except OSError:
179 self.skipTest('unable to bind RDS socket')
180
181
Guido van Rossum24e4af82002-06-12 19:18:08 +0000182class ThreadableTest:
Guido van Rossum83ccb4e2002-06-18 18:35:13 +0000183 """Threadable Test class
184
185 The ThreadableTest class makes it easy to create a threaded
186 client/server pair from an existing unit test. To create a
187 new threaded class from an existing unit test, use multiple
188 inheritance:
189
190 class NewClass (OldClass, ThreadableTest):
191 pass
192
193 This class defines two new fixture functions with obvious
194 purposes for overriding:
195
196 clientSetUp ()
197 clientTearDown ()
198
199 Any new test functions within the class must then define
200 tests in pairs, where the test name is preceeded with a
201 '_' to indicate the client portion of the test. Ex:
202
203 def testFoo(self):
204 # Server portion
205
206 def _testFoo(self):
207 # Client portion
208
209 Any exceptions raised by the clients during their tests
210 are caught and transferred to the main thread to alert
211 the testing framework.
212
213 Note, the server setup function cannot call any blocking
214 functions that rely on the client thread during setup,
Guido van Rossumd8faa362007-04-27 19:54:29 +0000215 unless serverExplicitReady() is called just before
Guido van Rossum83ccb4e2002-06-18 18:35:13 +0000216 the blocking call (such as in setting up a client/server
217 connection and performing the accept() in setUp().
218 """
Guido van Rossum24e4af82002-06-12 19:18:08 +0000219
220 def __init__(self):
221 # Swap the true setup function
222 self.__setUp = self.setUp
223 self.__tearDown = self.tearDown
224 self.setUp = self._setUp
225 self.tearDown = self._tearDown
226
Guido van Rossum83ccb4e2002-06-18 18:35:13 +0000227 def serverExplicitReady(self):
228 """This method allows the server to explicitly indicate that
229 it wants the client thread to proceed. This is useful if the
230 server is about to execute a blocking routine that is
231 dependent upon the client thread during its setup routine."""
232 self.server_ready.set()
233
Guido van Rossum24e4af82002-06-12 19:18:08 +0000234 def _setUp(self):
Guido van Rossum83ccb4e2002-06-18 18:35:13 +0000235 self.server_ready = threading.Event()
236 self.client_ready = threading.Event()
Guido van Rossum24e4af82002-06-12 19:18:08 +0000237 self.done = threading.Event()
Alexandre Vassalottif260e442008-05-11 19:59:59 +0000238 self.queue = queue.Queue(1)
Antoine Pitrou86fe8602011-10-10 20:15:59 +0200239 self.server_crashed = False
Guido van Rossum24e4af82002-06-12 19:18:08 +0000240
241 # Do some munging to start the client test.
Guido van Rossum11ba0942002-06-13 15:07:44 +0000242 methodname = self.id()
243 i = methodname.rfind('.')
244 methodname = methodname[i+1:]
245 test_method = getattr(self, '_' + methodname)
Guido van Rossumab659962002-06-12 21:29:43 +0000246 self.client_thread = thread.start_new_thread(
247 self.clientRun, (test_method,))
Guido van Rossum24e4af82002-06-12 19:18:08 +0000248
Antoine Pitrou86fe8602011-10-10 20:15:59 +0200249 try:
250 self.__setUp()
251 except:
252 self.server_crashed = True
253 raise
254 finally:
Guido van Rossum83ccb4e2002-06-18 18:35:13 +0000255 self.server_ready.set()
256 self.client_ready.wait()
Guido van Rossum24e4af82002-06-12 19:18:08 +0000257
258 def _tearDown(self):
259 self.__tearDown()
260 self.done.wait()
261
Raymond Hettingerda3caed2008-01-14 21:39:24 +0000262 if self.queue.qsize():
Antoine Pitrou98b46702010-09-18 22:59:00 +0000263 exc = self.queue.get()
264 raise exc
Guido van Rossum24e4af82002-06-12 19:18:08 +0000265
266 def clientRun(self, test_func):
Guido van Rossum83ccb4e2002-06-18 18:35:13 +0000267 self.server_ready.wait()
Guido van Rossum24e4af82002-06-12 19:18:08 +0000268 self.clientSetUp()
Charles-François Natalia49ed762011-09-21 22:03:58 +0200269 self.client_ready.set()
Antoine Pitrou86fe8602011-10-10 20:15:59 +0200270 if self.server_crashed:
271 self.clientTearDown()
272 return
Guido van Rossumd59da4b2007-05-22 18:11:13 +0000273 if not hasattr(test_func, '__call__'):
Collin Winter3add4d72007-08-29 23:37:32 +0000274 raise TypeError("test_func must be a callable function")
Guido van Rossum24e4af82002-06-12 19:18:08 +0000275 try:
276 test_func()
Antoine Pitrou98b46702010-09-18 22:59:00 +0000277 except BaseException as e:
278 self.queue.put(e)
279 finally:
280 self.clientTearDown()
Guido van Rossum24e4af82002-06-12 19:18:08 +0000281
282 def clientSetUp(self):
Collin Winter3add4d72007-08-29 23:37:32 +0000283 raise NotImplementedError("clientSetUp must be implemented.")
Guido van Rossum24e4af82002-06-12 19:18:08 +0000284
285 def clientTearDown(self):
286 self.done.set()
287 thread.exit()
288
289class ThreadedTCPSocketTest(SocketTCPTest, ThreadableTest):
290
291 def __init__(self, methodName='runTest'):
292 SocketTCPTest.__init__(self, methodName=methodName)
293 ThreadableTest.__init__(self)
294
295 def clientSetUp(self):
296 self.cli = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
297
298 def clientTearDown(self):
299 self.cli.close()
300 self.cli = None
301 ThreadableTest.clientTearDown(self)
302
303class ThreadedUDPSocketTest(SocketUDPTest, ThreadableTest):
304
305 def __init__(self, methodName='runTest'):
306 SocketUDPTest.__init__(self, methodName=methodName)
307 ThreadableTest.__init__(self)
308
309 def clientSetUp(self):
310 self.cli = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
311
Brian Curtin3beb38f2010-11-04 03:41:43 +0000312 def clientTearDown(self):
313 self.cli.close()
314 self.cli = None
315 ThreadableTest.clientTearDown(self)
316
Charles-François Natali47413c12011-10-06 19:47:44 +0200317class ThreadedCANSocketTest(SocketCANTest, ThreadableTest):
318
319 def __init__(self, methodName='runTest'):
320 SocketCANTest.__init__(self, methodName=methodName)
321 ThreadableTest.__init__(self)
322
323 def clientSetUp(self):
324 self.cli = socket.socket(socket.PF_CAN, socket.SOCK_RAW, socket.CAN_RAW)
325 try:
326 self.cli.bind((self.interface,))
Andrew Svetlov0832af62012-12-18 23:10:48 +0200327 except OSError:
Antoine Pitrou86fe8602011-10-10 20:15:59 +0200328 # skipTest should not be called here, and will be called in the
329 # server instead
330 pass
Charles-François Natali47413c12011-10-06 19:47:44 +0200331
332 def clientTearDown(self):
333 self.cli.close()
334 self.cli = None
335 ThreadableTest.clientTearDown(self)
336
Charles-François Natali10b8cf42011-11-10 19:21:37 +0100337class ThreadedRDSSocketTest(SocketRDSTest, ThreadableTest):
338
339 def __init__(self, methodName='runTest'):
340 SocketRDSTest.__init__(self, methodName=methodName)
341 ThreadableTest.__init__(self)
Charles-François Natali10b8cf42011-11-10 19:21:37 +0100342
343 def clientSetUp(self):
344 self.cli = socket.socket(socket.PF_RDS, socket.SOCK_SEQPACKET, 0)
345 try:
346 # RDS sockets must be bound explicitly to send or receive data
347 self.cli.bind((HOST, 0))
348 self.cli_addr = self.cli.getsockname()
349 except OSError:
350 # skipTest should not be called here, and will be called in the
351 # server instead
352 pass
353
354 def clientTearDown(self):
355 self.cli.close()
356 self.cli = None
357 ThreadableTest.clientTearDown(self)
358
Guido van Rossum24e4af82002-06-12 19:18:08 +0000359class SocketConnectedTest(ThreadedTCPSocketTest):
Jeremy Hylton5accbdb2007-08-03 20:40:09 +0000360 """Socket tests for client-server connection.
361
362 self.cli_conn is a client socket connected to the server. The
363 setUp() method guarantees that it is connected to the server.
364 """
Guido van Rossum24e4af82002-06-12 19:18:08 +0000365
366 def __init__(self, methodName='runTest'):
367 ThreadedTCPSocketTest.__init__(self, methodName=methodName)
368
369 def setUp(self):
370 ThreadedTCPSocketTest.setUp(self)
Guido van Rossum83ccb4e2002-06-18 18:35:13 +0000371 # Indicate explicitly we're ready for the client thread to
372 # proceed and then perform the blocking call to accept
373 self.serverExplicitReady()
Guido van Rossum24e4af82002-06-12 19:18:08 +0000374 conn, addr = self.serv.accept()
375 self.cli_conn = conn
376
377 def tearDown(self):
378 self.cli_conn.close()
379 self.cli_conn = None
380 ThreadedTCPSocketTest.tearDown(self)
381
382 def clientSetUp(self):
383 ThreadedTCPSocketTest.clientSetUp(self)
Christian Heimes5e696852008-04-09 08:37:03 +0000384 self.cli.connect((HOST, self.port))
Guido van Rossum24e4af82002-06-12 19:18:08 +0000385 self.serv_conn = self.cli
386
387 def clientTearDown(self):
388 self.serv_conn.close()
389 self.serv_conn = None
390 ThreadedTCPSocketTest.clientTearDown(self)
391
Dave Cole331708b2004-08-09 04:51:41 +0000392class SocketPairTest(unittest.TestCase, ThreadableTest):
393
394 def __init__(self, methodName='runTest'):
395 unittest.TestCase.__init__(self, methodName=methodName)
396 ThreadableTest.__init__(self)
397
398 def setUp(self):
399 self.serv, self.cli = socket.socketpair()
400
401 def tearDown(self):
402 self.serv.close()
403 self.serv = None
404
405 def clientSetUp(self):
406 pass
407
408 def clientTearDown(self):
409 self.cli.close()
410 self.cli = None
411 ThreadableTest.clientTearDown(self)
412
Tim Peters494aaee2004-08-09 18:54:11 +0000413
Nick Coghlan96fe56a2011-08-22 11:55:57 +1000414# The following classes are used by the sendmsg()/recvmsg() tests.
415# Combining, for instance, ConnectedStreamTestMixin and TCPTestBase
416# gives a drop-in replacement for SocketConnectedTest, but different
417# address families can be used, and the attributes serv_addr and
418# cli_addr will be set to the addresses of the endpoints.
419
420class SocketTestBase(unittest.TestCase):
421 """A base class for socket tests.
422
423 Subclasses must provide methods newSocket() to return a new socket
424 and bindSock(sock) to bind it to an unused address.
425
426 Creates a socket self.serv and sets self.serv_addr to its address.
427 """
428
429 def setUp(self):
430 self.serv = self.newSocket()
431 self.bindServer()
432
433 def bindServer(self):
434 """Bind server socket and set self.serv_addr to its address."""
435 self.bindSock(self.serv)
436 self.serv_addr = self.serv.getsockname()
437
438 def tearDown(self):
439 self.serv.close()
440 self.serv = None
441
442
443class SocketListeningTestMixin(SocketTestBase):
444 """Mixin to listen on the server socket."""
445
446 def setUp(self):
447 super().setUp()
448 self.serv.listen(1)
449
450
451class ThreadedSocketTestMixin(ThreadSafeCleanupTestCase, SocketTestBase,
452 ThreadableTest):
453 """Mixin to add client socket and allow client/server tests.
454
455 Client socket is self.cli and its address is self.cli_addr. See
456 ThreadableTest for usage information.
457 """
458
459 def __init__(self, *args, **kwargs):
460 super().__init__(*args, **kwargs)
461 ThreadableTest.__init__(self)
462
463 def clientSetUp(self):
464 self.cli = self.newClientSocket()
465 self.bindClient()
466
467 def newClientSocket(self):
468 """Return a new socket for use as client."""
469 return self.newSocket()
470
471 def bindClient(self):
472 """Bind client socket and set self.cli_addr to its address."""
473 self.bindSock(self.cli)
474 self.cli_addr = self.cli.getsockname()
475
476 def clientTearDown(self):
477 self.cli.close()
478 self.cli = None
479 ThreadableTest.clientTearDown(self)
480
481
482class ConnectedStreamTestMixin(SocketListeningTestMixin,
483 ThreadedSocketTestMixin):
484 """Mixin to allow client/server stream tests with connected client.
485
486 Server's socket representing connection to client is self.cli_conn
487 and client's connection to server is self.serv_conn. (Based on
488 SocketConnectedTest.)
489 """
490
491 def setUp(self):
492 super().setUp()
493 # Indicate explicitly we're ready for the client thread to
494 # proceed and then perform the blocking call to accept
495 self.serverExplicitReady()
496 conn, addr = self.serv.accept()
497 self.cli_conn = conn
498
499 def tearDown(self):
500 self.cli_conn.close()
501 self.cli_conn = None
502 super().tearDown()
503
504 def clientSetUp(self):
505 super().clientSetUp()
506 self.cli.connect(self.serv_addr)
507 self.serv_conn = self.cli
508
509 def clientTearDown(self):
510 self.serv_conn.close()
511 self.serv_conn = None
512 super().clientTearDown()
513
514
515class UnixSocketTestBase(SocketTestBase):
516 """Base class for Unix-domain socket tests."""
517
518 # This class is used for file descriptor passing tests, so we
519 # create the sockets in a private directory so that other users
520 # can't send anything that might be problematic for a privileged
521 # user running the tests.
522
523 def setUp(self):
524 self.dir_path = tempfile.mkdtemp()
525 self.addCleanup(os.rmdir, self.dir_path)
526 super().setUp()
527
528 def bindSock(self, sock):
529 path = tempfile.mktemp(dir=self.dir_path)
530 sock.bind(path)
531 self.addCleanup(support.unlink, path)
532
533class UnixStreamBase(UnixSocketTestBase):
534 """Base class for Unix-domain SOCK_STREAM tests."""
535
536 def newSocket(self):
537 return socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
538
539
540class InetTestBase(SocketTestBase):
541 """Base class for IPv4 socket tests."""
542
543 host = HOST
544
545 def setUp(self):
546 super().setUp()
547 self.port = self.serv_addr[1]
548
549 def bindSock(self, sock):
550 support.bind_port(sock, host=self.host)
551
552class TCPTestBase(InetTestBase):
553 """Base class for TCP-over-IPv4 tests."""
554
555 def newSocket(self):
556 return socket.socket(socket.AF_INET, socket.SOCK_STREAM)
557
558class UDPTestBase(InetTestBase):
559 """Base class for UDP-over-IPv4 tests."""
560
561 def newSocket(self):
562 return socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
563
564class SCTPStreamBase(InetTestBase):
565 """Base class for SCTP tests in one-to-one (SOCK_STREAM) mode."""
566
567 def newSocket(self):
568 return socket.socket(socket.AF_INET, socket.SOCK_STREAM,
569 socket.IPPROTO_SCTP)
570
571
572class Inet6TestBase(InetTestBase):
573 """Base class for IPv6 socket tests."""
574
Charles-François Natalifcfb3242013-08-31 14:40:49 +0200575 host = support.HOSTv6
Nick Coghlan96fe56a2011-08-22 11:55:57 +1000576
577class UDP6TestBase(Inet6TestBase):
578 """Base class for UDP-over-IPv6 tests."""
579
580 def newSocket(self):
581 return socket.socket(socket.AF_INET6, socket.SOCK_DGRAM)
582
583
584# Test-skipping decorators for use with ThreadableTest.
585
586def skipWithClientIf(condition, reason):
587 """Skip decorated test if condition is true, add client_skip decorator.
588
589 If the decorated object is not a class, sets its attribute
590 "client_skip" to a decorator which will return an empty function
591 if the test is to be skipped, or the original function if it is
592 not. This can be used to avoid running the client part of a
593 skipped test when using ThreadableTest.
594 """
595 def client_pass(*args, **kwargs):
596 pass
597 def skipdec(obj):
598 retval = unittest.skip(reason)(obj)
599 if not isinstance(obj, type):
600 retval.client_skip = lambda f: client_pass
601 return retval
602 def noskipdec(obj):
603 if not (isinstance(obj, type) or hasattr(obj, "client_skip")):
604 obj.client_skip = lambda f: f
605 return obj
606 return skipdec if condition else noskipdec
607
608
609def requireAttrs(obj, *attributes):
610 """Skip decorated test if obj is missing any of the given attributes.
611
612 Sets client_skip attribute as skipWithClientIf() does.
613 """
614 missing = [name for name in attributes if not hasattr(obj, name)]
615 return skipWithClientIf(
616 missing, "don't have " + ", ".join(name for name in missing))
617
618
619def requireSocket(*args):
620 """Skip decorated test if a socket cannot be created with given arguments.
621
622 When an argument is given as a string, will use the value of that
623 attribute of the socket module, or skip the test if it doesn't
624 exist. Sets client_skip attribute as skipWithClientIf() does.
625 """
626 err = None
627 missing = [obj for obj in args if
628 isinstance(obj, str) and not hasattr(socket, obj)]
629 if missing:
630 err = "don't have " + ", ".join(name for name in missing)
631 else:
632 callargs = [getattr(socket, obj) if isinstance(obj, str) else obj
633 for obj in args]
634 try:
635 s = socket.socket(*callargs)
Andrew Svetlov0832af62012-12-18 23:10:48 +0200636 except OSError as e:
Nick Coghlan96fe56a2011-08-22 11:55:57 +1000637 # XXX: check errno?
638 err = str(e)
639 else:
640 s.close()
641 return skipWithClientIf(
642 err is not None,
643 "can't create socket({0}): {1}".format(
644 ", ".join(str(o) for o in args), err))
645
646
Guido van Rossum24e4af82002-06-12 19:18:08 +0000647#######################################################################
648## Begin Tests
649
650class GeneralModuleTests(unittest.TestCase):
651
Ethan Furman7184bac2014-10-14 18:56:53 -0700652 def test_SocketType_is_socketobject(self):
653 import _socket
654 self.assertTrue(socket.SocketType is _socket.socket)
655 s = socket.socket()
656 self.assertIsInstance(s, socket.SocketType)
657 s.close()
658
Walter Dörwalda7eb93e2007-06-05 13:41:53 +0000659 def test_repr(self):
660 s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
Giampaolo Rodola'50331cb2013-04-10 15:49:47 +0200661 with s:
662 self.assertIn('fd=%i' % s.fileno(), repr(s))
Nick Coghlanca351e62013-11-13 22:10:16 +1000663 self.assertIn('family=%s' % socket.AF_INET, repr(s))
664 self.assertIn('type=%s' % socket.SOCK_STREAM, repr(s))
Giampaolo Rodola'50331cb2013-04-10 15:49:47 +0200665 self.assertIn('proto=0', repr(s))
Giampaolo Rodola'50331cb2013-04-10 15:49:47 +0200666 self.assertNotIn('raddr', repr(s))
667 s.bind(('127.0.0.1', 0))
Giampaolo Rodola'7ca49362013-04-12 18:28:15 +0200668 self.assertIn('laddr', repr(s))
Giampaolo Rodola'50331cb2013-04-10 15:49:47 +0200669 self.assertIn(str(s.getsockname()), repr(s))
670 self.assertIn('[closed]', repr(s))
671 self.assertNotIn('laddr', repr(s))
Walter Dörwalda7eb93e2007-06-05 13:41:53 +0000672
Victor Stinnere254e532014-07-26 14:36:55 +0200673 @unittest.skipUnless(_socket is not None, 'need _socket module')
674 def test_csocket_repr(self):
675 s = _socket.socket(_socket.AF_INET, _socket.SOCK_STREAM)
676 try:
677 expected = ('<socket object, fd=%s, family=%s, type=%s, proto=%s>'
678 % (s.fileno(), s.family, s.type, s.proto))
679 self.assertEqual(repr(s), expected)
680 finally:
681 s.close()
682 expected = ('<socket object, fd=-1, family=%s, type=%s, proto=%s>'
683 % (s.family, s.type, s.proto))
684 self.assertEqual(repr(s), expected)
685
Raymond Hettinger027bb632004-05-31 03:09:25 +0000686 def test_weakref(self):
687 s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
688 p = proxy(s)
689 self.assertEqual(p.fileno(), s.fileno())
690 s.close()
691 s = None
692 try:
693 p.fileno()
694 except ReferenceError:
695 pass
696 else:
697 self.fail('Socket proxy still exists')
698
Guido van Rossum24e4af82002-06-12 19:18:08 +0000699 def testSocketError(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000700 # Testing socket module exceptions
Ezio Melotti845f1522011-05-08 20:23:57 +0300701 msg = "Error raising socket exception (%s)."
Andrew Svetlov0832af62012-12-18 23:10:48 +0200702 with self.assertRaises(OSError, msg=msg % 'OSError'):
703 raise OSError
704 with self.assertRaises(OSError, msg=msg % 'socket.herror'):
Guido van Rossum24e4af82002-06-12 19:18:08 +0000705 raise socket.herror
Andrew Svetlov0832af62012-12-18 23:10:48 +0200706 with self.assertRaises(OSError, msg=msg % 'socket.gaierror'):
Guido van Rossum24e4af82002-06-12 19:18:08 +0000707 raise socket.gaierror
Guido van Rossum24e4af82002-06-12 19:18:08 +0000708
Ezio Melotti63e42302011-05-07 19:47:48 +0300709 def testSendtoErrors(self):
Berker Peksag4882cac2015-04-14 09:30:01 +0300710 # Testing that sendto doesn't masks failures. See #10169.
Ezio Melotti63e42302011-05-07 19:47:48 +0300711 s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
712 self.addCleanup(s.close)
713 s.bind(('', 0))
714 sockname = s.getsockname()
715 # 2 args
Ezio Melotti4c1aebd2011-05-07 19:50:28 +0300716 with self.assertRaises(TypeError) as cm:
Ezio Melotti63e42302011-05-07 19:47:48 +0300717 s.sendto('\u2620', sockname)
Ezio Melotti4c1aebd2011-05-07 19:50:28 +0300718 self.assertEqual(str(cm.exception),
719 "'str' does not support the buffer interface")
720 with self.assertRaises(TypeError) as cm:
Ezio Melotti63e42302011-05-07 19:47:48 +0300721 s.sendto(5j, sockname)
Ezio Melotti4c1aebd2011-05-07 19:50:28 +0300722 self.assertEqual(str(cm.exception),
723 "'complex' does not support the buffer interface")
724 with self.assertRaises(TypeError) as cm:
Ezio Melotti63e42302011-05-07 19:47:48 +0300725 s.sendto(b'foo', None)
Ezio Melotti4c1aebd2011-05-07 19:50:28 +0300726 self.assertIn('not NoneType',str(cm.exception))
Ezio Melotti63e42302011-05-07 19:47:48 +0300727 # 3 args
Ezio Melotti4c1aebd2011-05-07 19:50:28 +0300728 with self.assertRaises(TypeError) as cm:
Ezio Melotti63e42302011-05-07 19:47:48 +0300729 s.sendto('\u2620', 0, sockname)
Ezio Melotti4c1aebd2011-05-07 19:50:28 +0300730 self.assertEqual(str(cm.exception),
731 "'str' does not support the buffer interface")
732 with self.assertRaises(TypeError) as cm:
Ezio Melotti63e42302011-05-07 19:47:48 +0300733 s.sendto(5j, 0, sockname)
Ezio Melotti4c1aebd2011-05-07 19:50:28 +0300734 self.assertEqual(str(cm.exception),
735 "'complex' does not support the buffer interface")
736 with self.assertRaises(TypeError) as cm:
Ezio Melotti63e42302011-05-07 19:47:48 +0300737 s.sendto(b'foo', 0, None)
Ezio Melotti4c1aebd2011-05-07 19:50:28 +0300738 self.assertIn('not NoneType', str(cm.exception))
739 with self.assertRaises(TypeError) as cm:
Ezio Melotti63e42302011-05-07 19:47:48 +0300740 s.sendto(b'foo', 'bar', sockname)
Ezio Melotti4c1aebd2011-05-07 19:50:28 +0300741 self.assertIn('an integer is required', str(cm.exception))
742 with self.assertRaises(TypeError) as cm:
Ezio Melotti63e42302011-05-07 19:47:48 +0300743 s.sendto(b'foo', None, None)
Ezio Melotti4c1aebd2011-05-07 19:50:28 +0300744 self.assertIn('an integer is required', str(cm.exception))
Ezio Melotti63e42302011-05-07 19:47:48 +0300745 # wrong number of args
Ezio Melotti4c1aebd2011-05-07 19:50:28 +0300746 with self.assertRaises(TypeError) as cm:
Ezio Melotti63e42302011-05-07 19:47:48 +0300747 s.sendto(b'foo')
Ezio Melotti4c1aebd2011-05-07 19:50:28 +0300748 self.assertIn('(1 given)', str(cm.exception))
749 with self.assertRaises(TypeError) as cm:
Ezio Melotti63e42302011-05-07 19:47:48 +0300750 s.sendto(b'foo', 0, sockname, 4)
Ezio Melotti4c1aebd2011-05-07 19:50:28 +0300751 self.assertIn('(4 given)', str(cm.exception))
Ezio Melotti63e42302011-05-07 19:47:48 +0300752
Guido van Rossum24e4af82002-06-12 19:18:08 +0000753 def testCrucialConstants(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000754 # Testing for mission critical constants
Guido van Rossum24e4af82002-06-12 19:18:08 +0000755 socket.AF_INET
756 socket.SOCK_STREAM
757 socket.SOCK_DGRAM
758 socket.SOCK_RAW
759 socket.SOCK_RDM
760 socket.SOCK_SEQPACKET
761 socket.SOL_SOCKET
762 socket.SO_REUSEADDR
763
Guido van Rossum654c11e2002-06-13 20:24:17 +0000764 def testHostnameRes(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000765 # Testing hostname resolution mechanisms
Guido van Rossum654c11e2002-06-13 20:24:17 +0000766 hostname = socket.gethostname()
Guido van Rossum71e02942002-12-26 16:55:15 +0000767 try:
768 ip = socket.gethostbyname(hostname)
Andrew Svetlov0832af62012-12-18 23:10:48 +0200769 except OSError:
Guido van Rossum71e02942002-12-26 16:55:15 +0000770 # Probably name lookup wasn't set up right; skip this test
Zachary Ware9fe6d862013-12-08 00:20:35 -0600771 self.skipTest('name lookup failure')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000772 self.assertTrue(ip.find('.') >= 0, "Error resolving host to ip.")
Guido van Rossum9647b522002-12-26 17:04:45 +0000773 try:
774 hname, aliases, ipaddrs = socket.gethostbyaddr(ip)
Andrew Svetlov0832af62012-12-18 23:10:48 +0200775 except OSError:
Guido van Rossum9647b522002-12-26 17:04:45 +0000776 # Probably a similar problem as above; skip this test
Zachary Ware9fe6d862013-12-08 00:20:35 -0600777 self.skipTest('name lookup failure')
Brett Cannon01668a12005-03-11 00:04:17 +0000778 all_host_names = [hostname, hname] + aliases
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000779 fqhn = socket.getfqdn(ip)
Guido van Rossum654c11e2002-06-13 20:24:17 +0000780 if not fqhn in all_host_names:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000781 self.fail("Error testing host resolution mechanisms. (fqdn: %s, all: %s)" % (fqhn, repr(all_host_names)))
Barry Warsawcf3d4b51997-01-03 20:03:32 +0000782
Charles-François Natali0cc86852013-09-13 19:53:08 +0200783 def test_host_resolution(self):
784 for addr in ['0.1.1.~1', '1+.1.1.1', '::1q', '::1::2',
785 '1:1:1:1:1:1:1:1:1']:
786 self.assertRaises(OSError, socket.gethostbyname, addr)
787 self.assertRaises(OSError, socket.gethostbyaddr, addr)
788
789 for addr in [support.HOST, '10.0.0.1', '255.255.255.255']:
790 self.assertEqual(socket.gethostbyname(addr), addr)
791
792 # we don't test support.HOSTv6 because there's a chance it doesn't have
793 # a matching name entry (e.g. 'ip6-localhost')
794 for host in [support.HOST]:
795 self.assertIn(host, socket.gethostbyaddr(host)[2])
796
Antoine Pitrou061cfb52011-02-28 22:25:22 +0000797 @unittest.skipUnless(hasattr(socket, 'sethostname'), "test needs socket.sethostname()")
798 @unittest.skipUnless(hasattr(socket, 'gethostname'), "test needs socket.gethostname()")
799 def test_sethostname(self):
800 oldhn = socket.gethostname()
801 try:
802 socket.sethostname('new')
Andrew Svetlov0832af62012-12-18 23:10:48 +0200803 except OSError as e:
Antoine Pitrou061cfb52011-02-28 22:25:22 +0000804 if e.errno == errno.EPERM:
805 self.skipTest("test should be run as root")
806 else:
807 raise
808 try:
809 # running test as root!
810 self.assertEqual(socket.gethostname(), 'new')
811 # Should work with bytes objects too
812 socket.sethostname(b'bar')
813 self.assertEqual(socket.gethostname(), 'bar')
814 finally:
815 socket.sethostname(oldhn)
816
Gregory P. Smith5ed2e772011-05-15 00:26:45 -0700817 @unittest.skipUnless(hasattr(socket, 'if_nameindex'),
818 'socket.if_nameindex() not available.')
819 def testInterfaceNameIndex(self):
820 interfaces = socket.if_nameindex()
821 for index, name in interfaces:
Charles-François Natali60713592011-05-20 16:55:06 +0200822 self.assertIsInstance(index, int)
823 self.assertIsInstance(name, str)
Gregory P. Smith5ed2e772011-05-15 00:26:45 -0700824 # interface indices are non-zero integers
825 self.assertGreater(index, 0)
Charles-François Natali60713592011-05-20 16:55:06 +0200826 _index = socket.if_nametoindex(name)
827 self.assertIsInstance(_index, int)
828 self.assertEqual(index, _index)
829 _name = socket.if_indextoname(index)
830 self.assertIsInstance(_name, str)
831 self.assertEqual(name, _name)
832
833 @unittest.skipUnless(hasattr(socket, 'if_nameindex'),
834 'socket.if_nameindex() not available.')
835 def testInvalidInterfaceNameIndex(self):
836 # test nonexistent interface index/name
Andrew Svetlov0832af62012-12-18 23:10:48 +0200837 self.assertRaises(OSError, socket.if_indextoname, 0)
838 self.assertRaises(OSError, socket.if_nametoindex, '_DEADBEEF')
Charles-François Natali60713592011-05-20 16:55:06 +0200839 # test with invalid values
840 self.assertRaises(TypeError, socket.if_nametoindex, 0)
841 self.assertRaises(TypeError, socket.if_indextoname, '_DEADBEEF')
Gregory P. Smith5ed2e772011-05-15 00:26:45 -0700842
Serhiy Storchaka43767632013-11-03 21:31:38 +0200843 @unittest.skipUnless(hasattr(sys, 'getrefcount'),
844 'test needs sys.getrefcount()')
Guido van Rossum284a2cf2002-06-12 21:19:40 +0000845 def testRefCountGetNameInfo(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000846 # Testing reference count for getnameinfo
Serhiy Storchaka43767632013-11-03 21:31:38 +0200847 try:
848 # On some versions, this loses a reference
849 orig = sys.getrefcount(__name__)
850 socket.getnameinfo(__name__,0)
851 except TypeError:
852 if sys.getrefcount(__name__) != orig:
853 self.fail("socket.getnameinfo loses a reference")
Barry Warsawcf3d4b51997-01-03 20:03:32 +0000854
Guido van Rossum24e4af82002-06-12 19:18:08 +0000855 def testInterpreterCrash(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000856 # Making sure getnameinfo doesn't crash the interpreter
Guido van Rossum24e4af82002-06-12 19:18:08 +0000857 try:
858 # On some versions, this crashes the interpreter.
859 socket.getnameinfo(('x', 0, 0, 0), 0)
Andrew Svetlov0832af62012-12-18 23:10:48 +0200860 except OSError:
Guido van Rossum24e4af82002-06-12 19:18:08 +0000861 pass
Barry Warsawcf3d4b51997-01-03 20:03:32 +0000862
Guido van Rossumc0a0e082002-09-16 01:30:03 +0000863 def testNtoH(self):
Guido van Rossuma2627af2002-09-14 00:58:46 +0000864 # This just checks that htons etc. are their own inverse,
865 # when looking at the lower 16 or 32 bits.
866 sizes = {socket.htonl: 32, socket.ntohl: 32,
867 socket.htons: 16, socket.ntohs: 16}
868 for func, size in sizes.items():
Guido van Rossume2a383d2007-01-15 16:59:06 +0000869 mask = (1<<size) - 1
Guido van Rossuma2627af2002-09-14 00:58:46 +0000870 for i in (0, 1, 0xffff, ~0xffff, 2, 0x01234567, 0x76543210):
871 self.assertEqual(i & mask, func(func(i&mask)) & mask)
Jeremy Hyltoncbd5b892002-07-31 15:57:39 +0000872
Guido van Rossuma2627af2002-09-14 00:58:46 +0000873 swapped = func(mask)
874 self.assertEqual(swapped & mask, mask)
Guido van Rossume2a383d2007-01-15 16:59:06 +0000875 self.assertRaises(OverflowError, func, 1<<34)
Jeremy Hyltonc075e192002-07-25 16:01:12 +0000876
Guido van Rossum018919a2007-01-15 00:07:32 +0000877 def testNtoHErrors(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000878 good_values = [ 1, 2, 3, 1, 2, 3 ]
879 bad_values = [ -1, -2, -3, -1, -2, -3 ]
Guido van Rossum018919a2007-01-15 00:07:32 +0000880 for k in good_values:
881 socket.ntohl(k)
882 socket.ntohs(k)
883 socket.htonl(k)
884 socket.htons(k)
885 for k in bad_values:
886 self.assertRaises(OverflowError, socket.ntohl, k)
887 self.assertRaises(OverflowError, socket.ntohs, k)
888 self.assertRaises(OverflowError, socket.htonl, k)
889 self.assertRaises(OverflowError, socket.htons, k)
890
Barry Warsaw11b91a02004-06-28 00:50:43 +0000891 def testGetServBy(self):
892 eq = self.assertEqual
893 # Find one service that exists, then check all the related interfaces.
894 # I've ordered this by protocols that have both a tcp and udp
895 # protocol, at least for modern Linuxes.
doko@ubuntu.com4a173bc2014-04-17 19:47:16 +0200896 if (sys.platform.startswith(('freebsd', 'netbsd', 'gnukfreebsd'))
Victor Stinnere6747472011-08-21 00:39:18 +0200897 or sys.platform in ('linux', 'darwin')):
Andrew MacIntyre18bf43c2004-07-12 12:10:30 +0000898 # avoid the 'echo' service on this platform, as there is an
899 # assumption breaking non-standard port/protocol entry
900 services = ('daytime', 'qotd', 'domain')
901 else:
902 services = ('echo', 'daytime', 'domain')
903 for service in services:
Skip Montanarof4433302002-08-02 15:52:30 +0000904 try:
Barry Warsaw11b91a02004-06-28 00:50:43 +0000905 port = socket.getservbyname(service, 'tcp')
Skip Montanarof4433302002-08-02 15:52:30 +0000906 break
Andrew Svetlov0832af62012-12-18 23:10:48 +0200907 except OSError:
Skip Montanarof4433302002-08-02 15:52:30 +0000908 pass
Skip Montanaro05eb4012004-02-10 15:51:15 +0000909 else:
Andrew Svetlov0832af62012-12-18 23:10:48 +0200910 raise OSError
Barry Warsaw11b91a02004-06-28 00:50:43 +0000911 # Try same call with optional protocol omitted
912 port2 = socket.getservbyname(service)
913 eq(port, port2)
Terry Jan Reedyc30b7b12013-03-11 17:57:08 -0400914 # Try udp, but don't barf if it doesn't exist
Barry Warsaw11b91a02004-06-28 00:50:43 +0000915 try:
916 udpport = socket.getservbyname(service, 'udp')
Andrew Svetlov0832af62012-12-18 23:10:48 +0200917 except OSError:
Barry Warsaw11b91a02004-06-28 00:50:43 +0000918 udpport = None
919 else:
920 eq(udpport, port)
921 # Now make sure the lookup by port returns the same service name
922 eq(socket.getservbyport(port2), service)
923 eq(socket.getservbyport(port, 'tcp'), service)
924 if udpport is not None:
925 eq(socket.getservbyport(udpport, 'udp'), service)
Benjamin Peterson5c6d7872009-02-06 02:40:07 +0000926 # Make sure getservbyport does not accept out of range ports.
927 self.assertRaises(OverflowError, socket.getservbyport, -1)
928 self.assertRaises(OverflowError, socket.getservbyport, 65536)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000929
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +0000930 def testDefaultTimeout(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000931 # Testing default timeout
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +0000932 # The default timeout should initially be None
933 self.assertEqual(socket.getdefaulttimeout(), None)
934 s = socket.socket()
935 self.assertEqual(s.gettimeout(), None)
936 s.close()
937
938 # Set the default timeout to 10, and see if it propagates
939 socket.setdefaulttimeout(10)
940 self.assertEqual(socket.getdefaulttimeout(), 10)
941 s = socket.socket()
942 self.assertEqual(s.gettimeout(), 10)
943 s.close()
944
945 # Reset the default timeout to None, and see if it propagates
946 socket.setdefaulttimeout(None)
947 self.assertEqual(socket.getdefaulttimeout(), None)
948 s = socket.socket()
949 self.assertEqual(s.gettimeout(), None)
950 s.close()
951
952 # Check that setting it to an invalid value raises ValueError
953 self.assertRaises(ValueError, socket.setdefaulttimeout, -1)
954
955 # Check that setting it to an invalid type raises TypeError
956 self.assertRaises(TypeError, socket.setdefaulttimeout, "spam")
957
Serhiy Storchaka43767632013-11-03 21:31:38 +0200958 @unittest.skipUnless(hasattr(socket, 'inet_aton'),
959 'test needs socket.inet_aton()')
Benjamin Petersonf91df042009-02-13 02:50:59 +0000960 def testIPv4_inet_aton_fourbytes(self):
Benjamin Petersonf91df042009-02-13 02:50:59 +0000961 # Test that issue1008086 and issue767150 are fixed.
962 # It must return 4 bytes.
Ezio Melottib3aedd42010-11-20 19:04:17 +0000963 self.assertEqual(b'\x00'*4, socket.inet_aton('0.0.0.0'))
964 self.assertEqual(b'\xff'*4, socket.inet_aton('255.255.255.255'))
Benjamin Petersonf91df042009-02-13 02:50:59 +0000965
Serhiy Storchaka43767632013-11-03 21:31:38 +0200966 @unittest.skipUnless(hasattr(socket, 'inet_pton'),
967 'test needs socket.inet_pton()')
Guido van Rossum47dfa4a2003-04-25 05:48:32 +0000968 def testIPv4toString(self):
969 from socket import inet_aton as f, inet_pton, AF_INET
970 g = lambda a: inet_pton(AF_INET, a)
971
Antoine Pitrou7ded21e2011-12-19 16:21:21 +0100972 assertInvalid = lambda func,a: self.assertRaises(
Andrew Svetlov0832af62012-12-18 23:10:48 +0200973 (OSError, ValueError), func, a
Antoine Pitrou7ded21e2011-12-19 16:21:21 +0100974 )
975
Ezio Melottib3aedd42010-11-20 19:04:17 +0000976 self.assertEqual(b'\x00\x00\x00\x00', f('0.0.0.0'))
977 self.assertEqual(b'\xff\x00\xff\x00', f('255.0.255.0'))
978 self.assertEqual(b'\xaa\xaa\xaa\xaa', f('170.170.170.170'))
979 self.assertEqual(b'\x01\x02\x03\x04', f('1.2.3.4'))
980 self.assertEqual(b'\xff\xff\xff\xff', f('255.255.255.255'))
Antoine Pitrou7ded21e2011-12-19 16:21:21 +0100981 assertInvalid(f, '0.0.0.')
982 assertInvalid(f, '300.0.0.0')
983 assertInvalid(f, 'a.0.0.0')
984 assertInvalid(f, '1.2.3.4.5')
985 assertInvalid(f, '::1')
Guido van Rossum47dfa4a2003-04-25 05:48:32 +0000986
Ezio Melottib3aedd42010-11-20 19:04:17 +0000987 self.assertEqual(b'\x00\x00\x00\x00', g('0.0.0.0'))
988 self.assertEqual(b'\xff\x00\xff\x00', g('255.0.255.0'))
989 self.assertEqual(b'\xaa\xaa\xaa\xaa', g('170.170.170.170'))
990 self.assertEqual(b'\xff\xff\xff\xff', g('255.255.255.255'))
Antoine Pitrou7ded21e2011-12-19 16:21:21 +0100991 assertInvalid(g, '0.0.0.')
992 assertInvalid(g, '300.0.0.0')
993 assertInvalid(g, 'a.0.0.0')
994 assertInvalid(g, '1.2.3.4.5')
995 assertInvalid(g, '::1')
Tim Petersc2659cf2003-05-12 20:19:37 +0000996
Serhiy Storchaka43767632013-11-03 21:31:38 +0200997 @unittest.skipUnless(hasattr(socket, 'inet_pton'),
998 'test needs socket.inet_pton()')
Guido van Rossum47dfa4a2003-04-25 05:48:32 +0000999 def testIPv6toString(self):
1000 try:
1001 from socket import inet_pton, AF_INET6, has_ipv6
1002 if not has_ipv6:
Zachary Ware9fe6d862013-12-08 00:20:35 -06001003 self.skipTest('IPv6 not available')
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00001004 except ImportError:
Zachary Ware9fe6d862013-12-08 00:20:35 -06001005 self.skipTest('could not import needed symbols from socket')
Jason R. Coombs6bdc4982013-11-10 14:02:04 -05001006
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09001007 if sys.platform == "win32":
1008 try:
1009 inet_pton(AF_INET6, '::')
1010 except OSError as e:
1011 if e.winerror == 10022:
Zachary Ware101d9e72013-12-08 00:44:27 -06001012 self.skipTest('IPv6 might not be supported')
Jason R. Coombs6bdc4982013-11-10 14:02:04 -05001013
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00001014 f = lambda a: inet_pton(AF_INET6, a)
Antoine Pitrou7ded21e2011-12-19 16:21:21 +01001015 assertInvalid = lambda a: self.assertRaises(
Andrew Svetlov0832af62012-12-18 23:10:48 +02001016 (OSError, ValueError), f, a
Antoine Pitrou7ded21e2011-12-19 16:21:21 +01001017 )
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00001018
Ezio Melottib3aedd42010-11-20 19:04:17 +00001019 self.assertEqual(b'\x00' * 16, f('::'))
1020 self.assertEqual(b'\x00' * 16, f('0::0'))
1021 self.assertEqual(b'\x00\x01' + b'\x00' * 14, f('1::'))
1022 self.assertEqual(
Guido van Rossum67180622007-07-10 07:29:12 +00001023 b'\x45\xef\x76\xcb\x00\x1a\x56\xef\xaf\xeb\x0b\xac\x19\x24\xae\xae',
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00001024 f('45ef:76cb:1a:56ef:afeb:bac:1924:aeae')
1025 )
Antoine Pitrou7ded21e2011-12-19 16:21:21 +01001026 self.assertEqual(
1027 b'\xad\x42\x0a\xbc' + b'\x00' * 4 + b'\x01\x27\x00\x00\x02\x54\x00\x02',
1028 f('ad42:abc::127:0:254:2')
1029 )
1030 self.assertEqual(b'\x00\x12\x00\x0a' + b'\x00' * 12, f('12:a::'))
1031 assertInvalid('0x20::')
1032 assertInvalid(':::')
1033 assertInvalid('::0::')
1034 assertInvalid('1::abc::')
1035 assertInvalid('1::abc::def')
1036 assertInvalid('1:2:3:4:5:6:')
1037 assertInvalid('1:2:3:4:5:6')
1038 assertInvalid('1:2:3:4:5:6:7:8:')
1039 assertInvalid('1:2:3:4:5:6:7:8:0')
1040
1041 self.assertEqual(b'\x00' * 12 + b'\xfe\x2a\x17\x40',
1042 f('::254.42.23.64')
1043 )
1044 self.assertEqual(
1045 b'\x00\x42' + b'\x00' * 8 + b'\xa2\x9b\xfe\x2a\x17\x40',
1046 f('42::a29b:254.42.23.64')
1047 )
1048 self.assertEqual(
1049 b'\x00\x42\xa8\xb9\x00\x00\x00\x02\xff\xff\xa2\x9b\xfe\x2a\x17\x40',
1050 f('42:a8b9:0:2:ffff:a29b:254.42.23.64')
1051 )
1052 assertInvalid('255.254.253.252')
1053 assertInvalid('1::260.2.3.0')
1054 assertInvalid('1::0.be.e.0')
1055 assertInvalid('1:2:3:4:5:6:7:1.2.3.4')
1056 assertInvalid('::1.2.3.4:0')
1057 assertInvalid('0.100.200.0:3:4:5:6:7:8')
Tim Petersc2659cf2003-05-12 20:19:37 +00001058
Serhiy Storchaka43767632013-11-03 21:31:38 +02001059 @unittest.skipUnless(hasattr(socket, 'inet_ntop'),
1060 'test needs socket.inet_ntop()')
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00001061 def testStringToIPv4(self):
1062 from socket import inet_ntoa as f, inet_ntop, AF_INET
1063 g = lambda a: inet_ntop(AF_INET, a)
Antoine Pitrou7ded21e2011-12-19 16:21:21 +01001064 assertInvalid = lambda func,a: self.assertRaises(
Andrew Svetlov0832af62012-12-18 23:10:48 +02001065 (OSError, ValueError), func, a
Antoine Pitrou7ded21e2011-12-19 16:21:21 +01001066 )
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00001067
Ezio Melottib3aedd42010-11-20 19:04:17 +00001068 self.assertEqual('1.0.1.0', f(b'\x01\x00\x01\x00'))
1069 self.assertEqual('170.85.170.85', f(b'\xaa\x55\xaa\x55'))
1070 self.assertEqual('255.255.255.255', f(b'\xff\xff\xff\xff'))
1071 self.assertEqual('1.2.3.4', f(b'\x01\x02\x03\x04'))
Antoine Pitrou7ded21e2011-12-19 16:21:21 +01001072 assertInvalid(f, b'\x00' * 3)
1073 assertInvalid(f, b'\x00' * 5)
1074 assertInvalid(f, b'\x00' * 16)
Tim Petersc2659cf2003-05-12 20:19:37 +00001075
Ezio Melottib3aedd42010-11-20 19:04:17 +00001076 self.assertEqual('1.0.1.0', g(b'\x01\x00\x01\x00'))
1077 self.assertEqual('170.85.170.85', g(b'\xaa\x55\xaa\x55'))
1078 self.assertEqual('255.255.255.255', g(b'\xff\xff\xff\xff'))
Antoine Pitrou7ded21e2011-12-19 16:21:21 +01001079 assertInvalid(g, b'\x00' * 3)
1080 assertInvalid(g, b'\x00' * 5)
1081 assertInvalid(g, b'\x00' * 16)
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00001082
Serhiy Storchaka43767632013-11-03 21:31:38 +02001083 @unittest.skipUnless(hasattr(socket, 'inet_ntop'),
1084 'test needs socket.inet_ntop()')
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00001085 def testStringToIPv6(self):
1086 try:
1087 from socket import inet_ntop, AF_INET6, has_ipv6
1088 if not has_ipv6:
Zachary Ware9fe6d862013-12-08 00:20:35 -06001089 self.skipTest('IPv6 not available')
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00001090 except ImportError:
Zachary Ware9fe6d862013-12-08 00:20:35 -06001091 self.skipTest('could not import needed symbols from socket')
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09001092
1093 if sys.platform == "win32":
1094 try:
1095 inet_ntop(AF_INET6, b'\x00' * 16)
1096 except OSError as e:
1097 if e.winerror == 10022:
Zachary Ware101d9e72013-12-08 00:44:27 -06001098 self.skipTest('IPv6 might not be supported')
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09001099
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00001100 f = lambda a: inet_ntop(AF_INET6, a)
Antoine Pitrou7ded21e2011-12-19 16:21:21 +01001101 assertInvalid = lambda a: self.assertRaises(
Andrew Svetlov0832af62012-12-18 23:10:48 +02001102 (OSError, ValueError), f, a
Antoine Pitrou7ded21e2011-12-19 16:21:21 +01001103 )
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00001104
Ezio Melottib3aedd42010-11-20 19:04:17 +00001105 self.assertEqual('::', f(b'\x00' * 16))
1106 self.assertEqual('::1', f(b'\x00' * 15 + b'\x01'))
1107 self.assertEqual(
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00001108 'aef:b01:506:1001:ffff:9997:55:170',
Guido van Rossum67180622007-07-10 07:29:12 +00001109 f(b'\x0a\xef\x0b\x01\x05\x06\x10\x01\xff\xff\x99\x97\x00\x55\x01\x70')
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00001110 )
1111
Antoine Pitrou7ded21e2011-12-19 16:21:21 +01001112 assertInvalid(b'\x12' * 15)
1113 assertInvalid(b'\x12' * 17)
1114 assertInvalid(b'\x12' * 4)
1115
Guido van Rossumb6cc7d22002-07-19 12:46:46 +00001116 # XXX The following don't test module-level functionality...
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00001117
Benjamin Peterson5c6d7872009-02-06 02:40:07 +00001118 def testSockName(self):
1119 # Testing getsockname()
Antoine Pitrouccc87b52011-05-10 23:37:11 +02001120 port = support.find_unused_port()
Guido van Rossum24e4af82002-06-12 19:18:08 +00001121 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
Brian Curtin21ebbb72010-11-02 02:07:09 +00001122 self.addCleanup(sock.close)
Christian Heimes5e696852008-04-09 08:37:03 +00001123 sock.bind(("0.0.0.0", port))
Guido van Rossum24e4af82002-06-12 19:18:08 +00001124 name = sock.getsockname()
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001125 # XXX(nnorwitz): http://tinyurl.com/os5jz seems to indicate
1126 # it reasonable to get the host's addr in addition to 0.0.0.0.
1127 # At least for eCos. This is required for the S/390 to pass.
Georg Brandl89197fe2010-11-20 14:16:17 +00001128 try:
1129 my_ip_addr = socket.gethostbyname(socket.gethostname())
Andrew Svetlov0832af62012-12-18 23:10:48 +02001130 except OSError:
Georg Brandl89197fe2010-11-20 14:16:17 +00001131 # Probably name lookup wasn't set up right; skip this test
Zachary Ware9fe6d862013-12-08 00:20:35 -06001132 self.skipTest('name lookup failure')
Benjamin Peterson577473f2010-01-19 00:09:57 +00001133 self.assertIn(name[0], ("0.0.0.0", my_ip_addr), '%s invalid' % name[0])
Christian Heimes5e696852008-04-09 08:37:03 +00001134 self.assertEqual(name[1], port)
Guido van Rossum24e4af82002-06-12 19:18:08 +00001135
1136 def testGetSockOpt(self):
Guido van Rossum8c943832002-08-08 01:00:28 +00001137 # Testing getsockopt()
Guido van Rossum24e4af82002-06-12 19:18:08 +00001138 # We know a socket should start without reuse==0
1139 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
Brian Curtin21ebbb72010-11-02 02:07:09 +00001140 self.addCleanup(sock.close)
Guido van Rossum24e4af82002-06-12 19:18:08 +00001141 reuse = sock.getsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001142 self.assertFalse(reuse != 0, "initial mode is reuse")
Guido van Rossum24e4af82002-06-12 19:18:08 +00001143
1144 def testSetSockOpt(self):
Guido van Rossum8c943832002-08-08 01:00:28 +00001145 # Testing setsockopt()
Guido van Rossum24e4af82002-06-12 19:18:08 +00001146 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
Brian Curtin21ebbb72010-11-02 02:07:09 +00001147 self.addCleanup(sock.close)
Guido van Rossum24e4af82002-06-12 19:18:08 +00001148 sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
1149 reuse = sock.getsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001150 self.assertFalse(reuse == 0, "failed to set reuse mode")
Guido van Rossum24e4af82002-06-12 19:18:08 +00001151
Guido van Rossumb6cc7d22002-07-19 12:46:46 +00001152 def testSendAfterClose(self):
Guido van Rossum8c943832002-08-08 01:00:28 +00001153 # testing send() after close() with timeout
Guido van Rossumb6cc7d22002-07-19 12:46:46 +00001154 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
1155 sock.settimeout(1)
1156 sock.close()
Andrew Svetlov0832af62012-12-18 23:10:48 +02001157 self.assertRaises(OSError, sock.send, b"spam")
Guido van Rossumb6cc7d22002-07-19 12:46:46 +00001158
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001159 def testNewAttributes(self):
1160 # testing .family, .type and .protocol
Victor Stinnerdaf45552013-08-28 00:53:59 +02001161
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001162 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
1163 self.assertEqual(sock.family, socket.AF_INET)
Victor Stinnerdaf45552013-08-28 00:53:59 +02001164 if hasattr(socket, 'SOCK_CLOEXEC'):
1165 self.assertIn(sock.type,
1166 (socket.SOCK_STREAM | socket.SOCK_CLOEXEC,
1167 socket.SOCK_STREAM))
1168 else:
1169 self.assertEqual(sock.type, socket.SOCK_STREAM)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001170 self.assertEqual(sock.proto, 0)
1171 sock.close()
1172
Benjamin Peterson5c6d7872009-02-06 02:40:07 +00001173 def test_getsockaddrarg(self):
Charles-François Natali65708cf2014-07-25 18:44:30 +01001174 sock = socket.socket()
1175 self.addCleanup(sock.close)
Antoine Pitrouccc87b52011-05-10 23:37:11 +02001176 port = support.find_unused_port()
Benjamin Peterson5c6d7872009-02-06 02:40:07 +00001177 big_port = port + 65536
1178 neg_port = port - 65536
Charles-François Natali65708cf2014-07-25 18:44:30 +01001179 self.assertRaises(OverflowError, sock.bind, (HOST, big_port))
1180 self.assertRaises(OverflowError, sock.bind, (HOST, neg_port))
1181 # Since find_unused_port() is inherently subject to race conditions, we
1182 # call it a couple times if necessary.
1183 for i in itertools.count():
1184 port = support.find_unused_port()
1185 try:
1186 sock.bind((HOST, port))
1187 except OSError as e:
1188 if e.errno != errno.EADDRINUSE or i == 5:
1189 raise
1190 else:
1191 break
Benjamin Peterson5c6d7872009-02-06 02:40:07 +00001192
Brian Curtin5ad0bd62010-11-05 15:47:45 +00001193 @unittest.skipUnless(os.name == "nt", "Windows specific")
Christian Heimesfaf2f632008-01-06 16:59:19 +00001194 def test_sock_ioctl(self):
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001195 self.assertTrue(hasattr(socket.socket, 'ioctl'))
1196 self.assertTrue(hasattr(socket, 'SIO_RCVALL'))
1197 self.assertTrue(hasattr(socket, 'RCVALL_ON'))
1198 self.assertTrue(hasattr(socket, 'RCVALL_OFF'))
Kristján Valur Jónsson847ec752009-09-27 21:10:38 +00001199 self.assertTrue(hasattr(socket, 'SIO_KEEPALIVE_VALS'))
1200 s = socket.socket()
Brian Curtin5ad0bd62010-11-05 15:47:45 +00001201 self.addCleanup(s.close)
Kristján Valur Jónsson847ec752009-09-27 21:10:38 +00001202 self.assertRaises(ValueError, s.ioctl, -1, None)
1203 s.ioctl(socket.SIO_KEEPALIVE_VALS, (1, 100, 100))
Christian Heimesfaf2f632008-01-06 16:59:19 +00001204
Giampaolo Rodolà419f7042010-08-14 16:45:41 +00001205 def testGetaddrinfo(self):
1206 try:
1207 socket.getaddrinfo('localhost', 80)
1208 except socket.gaierror as err:
1209 if err.errno == socket.EAI_SERVICE:
1210 # see http://bugs.python.org/issue1282647
1211 self.skipTest("buggy libc version")
1212 raise
1213 # len of every sequence is supposed to be == 5
1214 for info in socket.getaddrinfo(HOST, None):
1215 self.assertEqual(len(info), 5)
1216 # host can be a domain name, a string representation of an
1217 # IPv4/v6 address or None
1218 socket.getaddrinfo('localhost', 80)
1219 socket.getaddrinfo('127.0.0.1', 80)
1220 socket.getaddrinfo(None, 80)
Antoine Pitrou9c39f3c2011-04-28 19:18:10 +02001221 if support.IPV6_ENABLED:
Giampaolo Rodolà419f7042010-08-14 16:45:41 +00001222 socket.getaddrinfo('::1', 80)
1223 # port can be a string service name such as "http", a numeric
1224 # port number or None
1225 socket.getaddrinfo(HOST, "http")
1226 socket.getaddrinfo(HOST, 80)
1227 socket.getaddrinfo(HOST, None)
1228 # test family and socktype filters
Eli Benderskyb2ff3cf2013-08-31 15:13:30 -07001229 infos = socket.getaddrinfo(HOST, 80, socket.AF_INET, socket.SOCK_STREAM)
1230 for family, type, _, _, _ in infos:
Giampaolo Rodolà419f7042010-08-14 16:45:41 +00001231 self.assertEqual(family, socket.AF_INET)
Eli Benderskyb2ff3cf2013-08-31 15:13:30 -07001232 self.assertEqual(str(family), 'AddressFamily.AF_INET')
1233 self.assertEqual(type, socket.SOCK_STREAM)
Ethan Furman7184bac2014-10-14 18:56:53 -07001234 self.assertEqual(str(type), 'SocketKind.SOCK_STREAM')
Giampaolo Rodolà419f7042010-08-14 16:45:41 +00001235 infos = socket.getaddrinfo(HOST, None, 0, socket.SOCK_STREAM)
1236 for _, socktype, _, _, _ in infos:
1237 self.assertEqual(socktype, socket.SOCK_STREAM)
1238 # test proto and flags arguments
Giampaolo Rodolà677d95c2010-08-16 05:08:11 +00001239 socket.getaddrinfo(HOST, None, 0, 0, socket.SOL_TCP)
Giampaolo Rodolà419f7042010-08-14 16:45:41 +00001240 socket.getaddrinfo(HOST, None, 0, 0, 0, socket.AI_PASSIVE)
1241 # a server willing to support both IPv4 and IPv6 will
1242 # usually do this
1243 socket.getaddrinfo(None, 0, socket.AF_UNSPEC, socket.SOCK_STREAM, 0,
1244 socket.AI_PASSIVE)
Giampaolo Rodolàccfb91c2010-08-17 15:30:23 +00001245 # test keyword arguments
1246 a = socket.getaddrinfo(HOST, None)
1247 b = socket.getaddrinfo(host=HOST, port=None)
1248 self.assertEqual(a, b)
1249 a = socket.getaddrinfo(HOST, None, socket.AF_INET)
1250 b = socket.getaddrinfo(HOST, None, family=socket.AF_INET)
1251 self.assertEqual(a, b)
1252 a = socket.getaddrinfo(HOST, None, 0, socket.SOCK_STREAM)
1253 b = socket.getaddrinfo(HOST, None, type=socket.SOCK_STREAM)
1254 self.assertEqual(a, b)
1255 a = socket.getaddrinfo(HOST, None, 0, 0, socket.SOL_TCP)
1256 b = socket.getaddrinfo(HOST, None, proto=socket.SOL_TCP)
1257 self.assertEqual(a, b)
1258 a = socket.getaddrinfo(HOST, None, 0, 0, 0, socket.AI_PASSIVE)
1259 b = socket.getaddrinfo(HOST, None, flags=socket.AI_PASSIVE)
1260 self.assertEqual(a, b)
1261 a = socket.getaddrinfo(None, 0, socket.AF_UNSPEC, socket.SOCK_STREAM, 0,
1262 socket.AI_PASSIVE)
1263 b = socket.getaddrinfo(host=None, port=0, family=socket.AF_UNSPEC,
1264 type=socket.SOCK_STREAM, proto=0,
1265 flags=socket.AI_PASSIVE)
1266 self.assertEqual(a, b)
Alexander Belopolskye239d232010-12-08 23:31:48 +00001267 # Issue #6697.
1268 self.assertRaises(UnicodeEncodeError, socket.getaddrinfo, 'localhost', '\uD800')
Giampaolo Rodolà419f7042010-08-14 16:45:41 +00001269
Ned Deilyb24f4812014-02-13 22:50:42 -08001270 # Issue 17269: test workaround for OS X platform bug segfault
Ronald Oussorena822d3662013-06-10 10:36:28 +02001271 if hasattr(socket, 'AI_NUMERICSERV'):
Ned Deilyb24f4812014-02-13 22:50:42 -08001272 try:
1273 # The arguments here are undefined and the call may succeed
1274 # or fail. All we care here is that it doesn't segfault.
1275 socket.getaddrinfo("localhost", None, 0, 0, 0,
1276 socket.AI_NUMERICSERV)
1277 except socket.gaierror:
1278 pass
Ronald Oussoren27a4ac52013-05-24 13:47:37 +02001279
Martin v. Löwis112c0f32010-08-25 07:38:15 +00001280 def test_getnameinfo(self):
1281 # only IP addresses are allowed
Andrew Svetlov0832af62012-12-18 23:10:48 +02001282 self.assertRaises(OSError, socket.getnameinfo, ('mail.python.org',0), 0)
Martin v. Löwis112c0f32010-08-25 07:38:15 +00001283
Daniel Stutzbach460ff3d2010-09-09 21:17:58 +00001284 @unittest.skipUnless(support.is_resource_enabled('network'),
1285 'network is not enabled')
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00001286 def test_idna(self):
Nadeem Vawda61baebd2012-01-25 08:02:05 +02001287 # Check for internet access before running test (issue #12804).
1288 try:
1289 socket.gethostbyname('python.org')
1290 except socket.gaierror as e:
1291 if e.errno == socket.EAI_NODATA:
1292 self.skipTest('internet access required for this test')
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00001293 # these should all be successful
Benjamin Peterson863c9622014-11-03 15:10:47 -05001294 domain = 'испытание.pythontest.net'
1295 socket.gethostbyname(domain)
1296 socket.gethostbyname_ex(domain)
1297 socket.getaddrinfo(domain,0,socket.AF_UNSPEC,socket.SOCK_STREAM)
Martin v. Löwis67e91ad2010-08-23 15:27:26 +00001298 # this may not work if the forward lookup choses the IPv6 address, as that doesn't
1299 # have a reverse entry yet
1300 # socket.gethostbyaddr('испытание.python.org')
Christian Heimesfaf2f632008-01-06 16:59:19 +00001301
Antoine Pitrou6d7df632010-09-27 17:52:25 +00001302 def check_sendall_interrupted(self, with_timeout):
1303 # socketpair() is not stricly required, but it makes things easier.
1304 if not hasattr(signal, 'alarm') or not hasattr(socket, 'socketpair'):
1305 self.skipTest("signal.alarm and socket.socketpair required for this test")
1306 # Our signal handlers clobber the C errno by calling a math function
1307 # with an invalid domain value.
1308 def ok_handler(*args):
1309 self.assertRaises(ValueError, math.acosh, 0)
1310 def raising_handler(*args):
1311 self.assertRaises(ValueError, math.acosh, 0)
1312 1 // 0
1313 c, s = socket.socketpair()
1314 old_alarm = signal.signal(signal.SIGALRM, raising_handler)
1315 try:
1316 if with_timeout:
1317 # Just above the one second minimum for signal.alarm
1318 c.settimeout(1.5)
1319 with self.assertRaises(ZeroDivisionError):
1320 signal.alarm(1)
Charles-François Natali5fd26422013-08-29 19:01:40 +02001321 c.sendall(b"x" * support.SOCK_MAX_SIZE)
Antoine Pitrou6d7df632010-09-27 17:52:25 +00001322 if with_timeout:
1323 signal.signal(signal.SIGALRM, ok_handler)
1324 signal.alarm(1)
Charles-François Natali5fd26422013-08-29 19:01:40 +02001325 self.assertRaises(socket.timeout, c.sendall,
1326 b"x" * support.SOCK_MAX_SIZE)
Antoine Pitrou6d7df632010-09-27 17:52:25 +00001327 finally:
Victor Stinner71fe8c02013-08-24 15:52:47 +02001328 signal.alarm(0)
Antoine Pitrou6d7df632010-09-27 17:52:25 +00001329 signal.signal(signal.SIGALRM, old_alarm)
1330 c.close()
1331 s.close()
1332
1333 def test_sendall_interrupted(self):
1334 self.check_sendall_interrupted(False)
1335
1336 def test_sendall_interrupted_with_timeout(self):
1337 self.check_sendall_interrupted(True)
1338
Antoine Pitroue033e062010-10-29 10:38:18 +00001339 def test_dealloc_warn(self):
1340 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
1341 r = repr(sock)
1342 with self.assertWarns(ResourceWarning) as cm:
1343 sock = None
1344 support.gc_collect()
1345 self.assertIn(r, str(cm.warning.args[0]))
1346 # An open socket file object gets dereferenced after the socket
1347 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
1348 f = sock.makefile('rb')
1349 r = repr(sock)
1350 sock = None
1351 support.gc_collect()
1352 with self.assertWarns(ResourceWarning):
1353 f = None
1354 support.gc_collect()
1355
Victor Stinnerc3a51ec2011-01-04 11:00:45 +00001356 def test_name_closed_socketio(self):
1357 with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
1358 fp = sock.makefile("rb")
1359 fp.close()
1360 self.assertEqual(repr(fp), "<_io.BufferedReader name=-1>")
1361
Antoine Pitrou1e7ee9d2012-09-14 17:28:10 +02001362 def test_unusable_closed_socketio(self):
1363 with socket.socket() as sock:
1364 fp = sock.makefile("rb", buffering=0)
1365 self.assertTrue(fp.readable())
1366 self.assertFalse(fp.writable())
1367 self.assertFalse(fp.seekable())
1368 fp.close()
1369 self.assertRaises(ValueError, fp.readable)
1370 self.assertRaises(ValueError, fp.writable)
1371 self.assertRaises(ValueError, fp.seekable)
1372
Antoine Pitrou6d58d642011-03-20 23:56:36 +01001373 def test_pickle(self):
1374 sock = socket.socket()
1375 with sock:
1376 for protocol in range(pickle.HIGHEST_PROTOCOL + 1):
1377 self.assertRaises(TypeError, pickle.dumps, sock, protocol)
Ethan Furman482fe042015-03-18 18:19:30 -07001378 for protocol in range(pickle.HIGHEST_PROTOCOL + 1):
1379 family = pickle.loads(pickle.dumps(socket.AF_INET, protocol))
1380 self.assertEqual(family, socket.AF_INET)
1381 type = pickle.loads(pickle.dumps(socket.SOCK_STREAM, protocol))
1382 self.assertEqual(type, socket.SOCK_STREAM)
Antoine Pitrou6d58d642011-03-20 23:56:36 +01001383
Serhiy Storchaka78980432013-01-15 01:12:17 +02001384 def test_listen_backlog(self):
1385 for backlog in 0, -1:
1386 srv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
1387 srv.bind((HOST, 0))
1388 srv.listen(backlog)
1389 srv.close()
1390
Serhiy Storchaka5cfc79d2014-02-07 10:06:39 +02001391 @support.cpython_only
1392 def test_listen_backlog_overflow(self):
Serhiy Storchaka78980432013-01-15 01:12:17 +02001393 # Issue 15989
Serhiy Storchaka5cfc79d2014-02-07 10:06:39 +02001394 import _testcapi
Antoine Pitrou1be815a2011-05-10 19:16:29 +02001395 srv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
1396 srv.bind((HOST, 0))
Serhiy Storchaka78980432013-01-15 01:12:17 +02001397 self.assertRaises(OverflowError, srv.listen, _testcapi.INT_MAX + 1)
Antoine Pitrou1be815a2011-05-10 19:16:29 +02001398 srv.close()
1399
Charles-François Natali42663332012-01-02 15:57:30 +01001400 @unittest.skipUnless(support.IPV6_ENABLED, 'IPv6 required for this test.')
Charles-François Natali366999a2012-01-02 15:47:29 +01001401 def test_flowinfo(self):
1402 self.assertRaises(OverflowError, socket.getnameinfo,
Charles-François Natalifcfb3242013-08-31 14:40:49 +02001403 (support.HOSTv6, 0, 0xffffffff), 0)
Charles-François Natali366999a2012-01-02 15:47:29 +01001404 with socket.socket(socket.AF_INET6, socket.SOCK_STREAM) as s:
Charles-François Natalifcfb3242013-08-31 14:40:49 +02001405 self.assertRaises(OverflowError, s.bind, (support.HOSTv6, 0, -10))
Charles-François Natali366999a2012-01-02 15:47:29 +01001406
Eli Benderskyb2ff3cf2013-08-31 15:13:30 -07001407 def test_str_for_enums(self):
1408 # Make sure that the AF_* and SOCK_* constants have enum-like string
1409 # reprs.
1410 with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
1411 self.assertEqual(str(s.family), 'AddressFamily.AF_INET')
Ethan Furman7184bac2014-10-14 18:56:53 -07001412 self.assertEqual(str(s.type), 'SocketKind.SOCK_STREAM')
Eli Benderskyb2ff3cf2013-08-31 15:13:30 -07001413
1414 @unittest.skipIf(os.name == 'nt', 'Will not work on Windows')
1415 def test_uknown_socket_family_repr(self):
1416 # Test that when created with a family that's not one of the known
1417 # AF_*/SOCK_* constants, socket.family just returns the number.
1418 #
1419 # To do this we fool socket.socket into believing it already has an
1420 # open fd because on this path it doesn't actually verify the family and
1421 # type and populates the socket object.
1422 #
1423 # On Windows this trick won't work, so the test is skipped.
1424 fd, _ = tempfile.mkstemp()
1425 with socket.socket(family=42424, type=13331, fileno=fd) as s:
1426 self.assertEqual(s.family, 42424)
1427 self.assertEqual(s.type, 13331)
Antoine Pitrou6d7df632010-09-27 17:52:25 +00001428
Charles-François Natali47413c12011-10-06 19:47:44 +02001429@unittest.skipUnless(HAVE_SOCKET_CAN, 'SocketCan required for this test.')
1430class BasicCANTest(unittest.TestCase):
1431
1432 def testCrucialConstants(self):
1433 socket.AF_CAN
1434 socket.PF_CAN
1435 socket.CAN_RAW
1436
Charles-François Natali773e42d2013-02-05 19:42:01 +01001437 @unittest.skipUnless(hasattr(socket, "CAN_BCM"),
1438 'socket.CAN_BCM required for this test.')
1439 def testBCMConstants(self):
1440 socket.CAN_BCM
1441
1442 # opcodes
1443 socket.CAN_BCM_TX_SETUP # create (cyclic) transmission task
1444 socket.CAN_BCM_TX_DELETE # remove (cyclic) transmission task
1445 socket.CAN_BCM_TX_READ # read properties of (cyclic) transmission task
1446 socket.CAN_BCM_TX_SEND # send one CAN frame
1447 socket.CAN_BCM_RX_SETUP # create RX content filter subscription
1448 socket.CAN_BCM_RX_DELETE # remove RX content filter subscription
1449 socket.CAN_BCM_RX_READ # read properties of RX content filter subscription
1450 socket.CAN_BCM_TX_STATUS # reply to TX_READ request
1451 socket.CAN_BCM_TX_EXPIRED # notification on performed transmissions (count=0)
1452 socket.CAN_BCM_RX_STATUS # reply to RX_READ request
1453 socket.CAN_BCM_RX_TIMEOUT # cyclic message is absent
1454 socket.CAN_BCM_RX_CHANGED # updated CAN frame (detected content change)
1455
Charles-François Natali47413c12011-10-06 19:47:44 +02001456 def testCreateSocket(self):
1457 with socket.socket(socket.PF_CAN, socket.SOCK_RAW, socket.CAN_RAW) as s:
1458 pass
1459
Charles-François Natali773e42d2013-02-05 19:42:01 +01001460 @unittest.skipUnless(hasattr(socket, "CAN_BCM"),
1461 'socket.CAN_BCM required for this test.')
1462 def testCreateBCMSocket(self):
1463 with socket.socket(socket.PF_CAN, socket.SOCK_DGRAM, socket.CAN_BCM) as s:
1464 pass
1465
Charles-François Natali47413c12011-10-06 19:47:44 +02001466 def testBindAny(self):
1467 with socket.socket(socket.PF_CAN, socket.SOCK_RAW, socket.CAN_RAW) as s:
1468 s.bind(('', ))
1469
1470 def testTooLongInterfaceName(self):
1471 # most systems limit IFNAMSIZ to 16, take 1024 to be sure
1472 with socket.socket(socket.PF_CAN, socket.SOCK_RAW, socket.CAN_RAW) as s:
Andrew Svetlov0832af62012-12-18 23:10:48 +02001473 self.assertRaisesRegex(OSError, 'interface name too long',
Antoine Pitrouffa547e2011-10-11 22:43:37 +02001474 s.bind, ('x' * 1024,))
Charles-François Natali47413c12011-10-06 19:47:44 +02001475
1476 @unittest.skipUnless(hasattr(socket, "CAN_RAW_LOOPBACK"),
1477 'socket.CAN_RAW_LOOPBACK required for this test.')
1478 def testLoopback(self):
1479 with socket.socket(socket.PF_CAN, socket.SOCK_RAW, socket.CAN_RAW) as s:
1480 for loopback in (0, 1):
1481 s.setsockopt(socket.SOL_CAN_RAW, socket.CAN_RAW_LOOPBACK,
1482 loopback)
1483 self.assertEqual(loopback,
1484 s.getsockopt(socket.SOL_CAN_RAW, socket.CAN_RAW_LOOPBACK))
1485
1486 @unittest.skipUnless(hasattr(socket, "CAN_RAW_FILTER"),
1487 'socket.CAN_RAW_FILTER required for this test.')
1488 def testFilter(self):
1489 can_id, can_mask = 0x200, 0x700
1490 can_filter = struct.pack("=II", can_id, can_mask)
1491 with socket.socket(socket.PF_CAN, socket.SOCK_RAW, socket.CAN_RAW) as s:
1492 s.setsockopt(socket.SOL_CAN_RAW, socket.CAN_RAW_FILTER, can_filter)
1493 self.assertEqual(can_filter,
1494 s.getsockopt(socket.SOL_CAN_RAW, socket.CAN_RAW_FILTER, 8))
1495
1496
1497@unittest.skipUnless(HAVE_SOCKET_CAN, 'SocketCan required for this test.')
Terry Jan Reedya40e6b02014-06-13 15:20:45 -04001498@unittest.skipUnless(thread, 'Threading required for this test.')
Charles-François Natali47413c12011-10-06 19:47:44 +02001499class CANTest(ThreadedCANSocketTest):
1500
Charles-François Natali47413c12011-10-06 19:47:44 +02001501 def __init__(self, methodName='runTest'):
1502 ThreadedCANSocketTest.__init__(self, methodName=methodName)
1503
1504 @classmethod
1505 def build_can_frame(cls, can_id, data):
1506 """Build a CAN frame."""
1507 can_dlc = len(data)
1508 data = data.ljust(8, b'\x00')
1509 return struct.pack(cls.can_frame_fmt, can_id, can_dlc, data)
1510
1511 @classmethod
1512 def dissect_can_frame(cls, frame):
1513 """Dissect a CAN frame."""
1514 can_id, can_dlc, data = struct.unpack(cls.can_frame_fmt, frame)
1515 return (can_id, can_dlc, data[:can_dlc])
1516
1517 def testSendFrame(self):
1518 cf, addr = self.s.recvfrom(self.bufsize)
1519 self.assertEqual(self.cf, cf)
1520 self.assertEqual(addr[0], self.interface)
1521 self.assertEqual(addr[1], socket.AF_CAN)
1522
1523 def _testSendFrame(self):
1524 self.cf = self.build_can_frame(0x00, b'\x01\x02\x03\x04\x05')
1525 self.cli.send(self.cf)
1526
1527 def testSendMaxFrame(self):
1528 cf, addr = self.s.recvfrom(self.bufsize)
1529 self.assertEqual(self.cf, cf)
1530
1531 def _testSendMaxFrame(self):
1532 self.cf = self.build_can_frame(0x00, b'\x07' * 8)
1533 self.cli.send(self.cf)
1534
1535 def testSendMultiFrames(self):
1536 cf, addr = self.s.recvfrom(self.bufsize)
1537 self.assertEqual(self.cf1, cf)
1538
1539 cf, addr = self.s.recvfrom(self.bufsize)
1540 self.assertEqual(self.cf2, cf)
1541
1542 def _testSendMultiFrames(self):
1543 self.cf1 = self.build_can_frame(0x07, b'\x44\x33\x22\x11')
1544 self.cli.send(self.cf1)
1545
1546 self.cf2 = self.build_can_frame(0x12, b'\x99\x22\x33')
1547 self.cli.send(self.cf2)
1548
Charles-François Natali773e42d2013-02-05 19:42:01 +01001549 @unittest.skipUnless(hasattr(socket, "CAN_BCM"),
1550 'socket.CAN_BCM required for this test.')
1551 def _testBCM(self):
1552 cf, addr = self.cli.recvfrom(self.bufsize)
1553 self.assertEqual(self.cf, cf)
1554 can_id, can_dlc, data = self.dissect_can_frame(cf)
1555 self.assertEqual(self.can_id, can_id)
1556 self.assertEqual(self.data, data)
1557
1558 @unittest.skipUnless(hasattr(socket, "CAN_BCM"),
1559 'socket.CAN_BCM required for this test.')
1560 def testBCM(self):
1561 bcm = socket.socket(socket.PF_CAN, socket.SOCK_DGRAM, socket.CAN_BCM)
1562 self.addCleanup(bcm.close)
1563 bcm.connect((self.interface,))
1564 self.can_id = 0x123
1565 self.data = bytes([0xc0, 0xff, 0xee])
1566 self.cf = self.build_can_frame(self.can_id, self.data)
1567 opcode = socket.CAN_BCM_TX_SEND
1568 flags = 0
1569 count = 0
1570 ival1_seconds = ival1_usec = ival2_seconds = ival2_usec = 0
1571 bcm_can_id = 0x0222
1572 nframes = 1
1573 assert len(self.cf) == 16
1574 header = struct.pack(self.bcm_cmd_msg_fmt,
1575 opcode,
1576 flags,
1577 count,
1578 ival1_seconds,
1579 ival1_usec,
1580 ival2_seconds,
1581 ival2_usec,
1582 bcm_can_id,
1583 nframes,
1584 )
1585 header_plus_frame = header + self.cf
1586 bytes_sent = bcm.send(header_plus_frame)
1587 self.assertEqual(bytes_sent, len(header_plus_frame))
1588
Charles-François Natali47413c12011-10-06 19:47:44 +02001589
Charles-François Natali10b8cf42011-11-10 19:21:37 +01001590@unittest.skipUnless(HAVE_SOCKET_RDS, 'RDS sockets required for this test.')
1591class BasicRDSTest(unittest.TestCase):
1592
1593 def testCrucialConstants(self):
1594 socket.AF_RDS
1595 socket.PF_RDS
1596
1597 def testCreateSocket(self):
1598 with socket.socket(socket.PF_RDS, socket.SOCK_SEQPACKET, 0) as s:
1599 pass
1600
1601 def testSocketBufferSize(self):
1602 bufsize = 16384
1603 with socket.socket(socket.PF_RDS, socket.SOCK_SEQPACKET, 0) as s:
1604 s.setsockopt(socket.SOL_SOCKET, socket.SO_RCVBUF, bufsize)
1605 s.setsockopt(socket.SOL_SOCKET, socket.SO_SNDBUF, bufsize)
1606
1607
1608@unittest.skipUnless(HAVE_SOCKET_RDS, 'RDS sockets required for this test.')
1609@unittest.skipUnless(thread, 'Threading required for this test.')
1610class RDSTest(ThreadedRDSSocketTest):
1611
1612 def __init__(self, methodName='runTest'):
1613 ThreadedRDSSocketTest.__init__(self, methodName=methodName)
1614
Charles-François Natali240c55f2011-11-10 20:33:36 +01001615 def setUp(self):
1616 super().setUp()
1617 self.evt = threading.Event()
1618
Charles-François Natali10b8cf42011-11-10 19:21:37 +01001619 def testSendAndRecv(self):
1620 data, addr = self.serv.recvfrom(self.bufsize)
1621 self.assertEqual(self.data, data)
1622 self.assertEqual(self.cli_addr, addr)
1623
1624 def _testSendAndRecv(self):
1625 self.data = b'spam'
1626 self.cli.sendto(self.data, 0, (HOST, self.port))
1627
1628 def testPeek(self):
1629 data, addr = self.serv.recvfrom(self.bufsize, socket.MSG_PEEK)
1630 self.assertEqual(self.data, data)
1631 data, addr = self.serv.recvfrom(self.bufsize)
1632 self.assertEqual(self.data, data)
1633
1634 def _testPeek(self):
1635 self.data = b'spam'
1636 self.cli.sendto(self.data, 0, (HOST, self.port))
1637
1638 @requireAttrs(socket.socket, 'recvmsg')
1639 def testSendAndRecvMsg(self):
1640 data, ancdata, msg_flags, addr = self.serv.recvmsg(self.bufsize)
1641 self.assertEqual(self.data, data)
1642
1643 @requireAttrs(socket.socket, 'sendmsg')
1644 def _testSendAndRecvMsg(self):
1645 self.data = b'hello ' * 10
1646 self.cli.sendmsg([self.data], (), 0, (HOST, self.port))
1647
1648 def testSendAndRecvMulti(self):
1649 data, addr = self.serv.recvfrom(self.bufsize)
1650 self.assertEqual(self.data1, data)
1651
1652 data, addr = self.serv.recvfrom(self.bufsize)
1653 self.assertEqual(self.data2, data)
1654
1655 def _testSendAndRecvMulti(self):
1656 self.data1 = b'bacon'
1657 self.cli.sendto(self.data1, 0, (HOST, self.port))
1658
1659 self.data2 = b'egg'
1660 self.cli.sendto(self.data2, 0, (HOST, self.port))
1661
1662 def testSelect(self):
1663 r, w, x = select.select([self.serv], [], [], 3.0)
1664 self.assertIn(self.serv, r)
1665 data, addr = self.serv.recvfrom(self.bufsize)
1666 self.assertEqual(self.data, data)
1667
1668 def _testSelect(self):
1669 self.data = b'select'
1670 self.cli.sendto(self.data, 0, (HOST, self.port))
1671
1672 def testCongestion(self):
1673 # wait until the sender is done
1674 self.evt.wait()
1675
1676 def _testCongestion(self):
1677 # test the behavior in case of congestion
1678 self.data = b'fill'
1679 self.cli.setblocking(False)
1680 try:
1681 # try to lower the receiver's socket buffer size
1682 self.cli.setsockopt(socket.SOL_SOCKET, socket.SO_RCVBUF, 16384)
1683 except OSError:
1684 pass
1685 with self.assertRaises(OSError) as cm:
1686 try:
1687 # fill the receiver's socket buffer
1688 while True:
1689 self.cli.sendto(self.data, 0, (HOST, self.port))
1690 finally:
1691 # signal the receiver we're done
1692 self.evt.set()
1693 # sendto() should have failed with ENOBUFS
1694 self.assertEqual(cm.exception.errno, errno.ENOBUFS)
1695 # and we should have received a congestion notification through poll
1696 r, w, x = select.select([self.serv], [], [], 3.0)
1697 self.assertIn(self.serv, r)
1698
1699
Victor Stinner45df8202010-04-28 22:31:17 +00001700@unittest.skipUnless(thread, 'Threading required for this test.')
Guido van Rossum24e4af82002-06-12 19:18:08 +00001701class BasicTCPTest(SocketConnectedTest):
1702
1703 def __init__(self, methodName='runTest'):
1704 SocketConnectedTest.__init__(self, methodName=methodName)
1705
1706 def testRecv(self):
Guido van Rossum8c943832002-08-08 01:00:28 +00001707 # Testing large receive over TCP
Guido van Rossum24e4af82002-06-12 19:18:08 +00001708 msg = self.cli_conn.recv(1024)
Guido van Rossum76489682002-06-12 20:38:30 +00001709 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +00001710
1711 def _testRecv(self):
1712 self.serv_conn.send(MSG)
1713
1714 def testOverFlowRecv(self):
Guido van Rossum8c943832002-08-08 01:00:28 +00001715 # Testing receive in chunks over TCP
Guido van Rossum24e4af82002-06-12 19:18:08 +00001716 seg1 = self.cli_conn.recv(len(MSG) - 3)
1717 seg2 = self.cli_conn.recv(1024)
Guido van Rossumab659962002-06-12 21:29:43 +00001718 msg = seg1 + seg2
Guido van Rossum76489682002-06-12 20:38:30 +00001719 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +00001720
1721 def _testOverFlowRecv(self):
1722 self.serv_conn.send(MSG)
1723
1724 def testRecvFrom(self):
Guido van Rossum8c943832002-08-08 01:00:28 +00001725 # Testing large recvfrom() over TCP
Guido van Rossum24e4af82002-06-12 19:18:08 +00001726 msg, addr = self.cli_conn.recvfrom(1024)
Guido van Rossum76489682002-06-12 20:38:30 +00001727 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +00001728
1729 def _testRecvFrom(self):
1730 self.serv_conn.send(MSG)
1731
1732 def testOverFlowRecvFrom(self):
Guido van Rossum8c943832002-08-08 01:00:28 +00001733 # Testing recvfrom() in chunks over TCP
Guido van Rossum24e4af82002-06-12 19:18:08 +00001734 seg1, addr = self.cli_conn.recvfrom(len(MSG)-3)
1735 seg2, addr = self.cli_conn.recvfrom(1024)
Guido van Rossumab659962002-06-12 21:29:43 +00001736 msg = seg1 + seg2
Guido van Rossum76489682002-06-12 20:38:30 +00001737 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +00001738
1739 def _testOverFlowRecvFrom(self):
1740 self.serv_conn.send(MSG)
1741
1742 def testSendAll(self):
Guido van Rossum8c943832002-08-08 01:00:28 +00001743 # Testing sendall() with a 2048 byte string over TCP
Guido van Rossum7d0a8262007-05-21 23:13:11 +00001744 msg = b''
Guido van Rossum24e4af82002-06-12 19:18:08 +00001745 while 1:
1746 read = self.cli_conn.recv(1024)
1747 if not read:
1748 break
Guido van Rossume531e292002-08-08 20:28:34 +00001749 msg += read
Guido van Rossum7d0a8262007-05-21 23:13:11 +00001750 self.assertEqual(msg, b'f' * 2048)
Guido van Rossum24e4af82002-06-12 19:18:08 +00001751
1752 def _testSendAll(self):
Guido van Rossum7d0a8262007-05-21 23:13:11 +00001753 big_chunk = b'f' * 2048
Guido van Rossum24e4af82002-06-12 19:18:08 +00001754 self.serv_conn.sendall(big_chunk)
1755
1756 def testFromFd(self):
Guido van Rossum8c943832002-08-08 01:00:28 +00001757 # Testing fromfd()
Guido van Rossum24e4af82002-06-12 19:18:08 +00001758 fd = self.cli_conn.fileno()
1759 sock = socket.fromfd(fd, socket.AF_INET, socket.SOCK_STREAM)
Brian Curtin21ebbb72010-11-02 02:07:09 +00001760 self.addCleanup(sock.close)
Antoine Pitrou9e0b8642010-09-14 18:00:02 +00001761 self.assertIsInstance(sock, socket.socket)
Guido van Rossum24e4af82002-06-12 19:18:08 +00001762 msg = sock.recv(1024)
Guido van Rossum76489682002-06-12 20:38:30 +00001763 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +00001764
1765 def _testFromFd(self):
1766 self.serv_conn.send(MSG)
1767
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00001768 def testDup(self):
1769 # Testing dup()
1770 sock = self.cli_conn.dup()
Brian Curtin21ebbb72010-11-02 02:07:09 +00001771 self.addCleanup(sock.close)
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00001772 msg = sock.recv(1024)
1773 self.assertEqual(msg, MSG)
1774
1775 def _testDup(self):
1776 self.serv_conn.send(MSG)
1777
Guido van Rossum24e4af82002-06-12 19:18:08 +00001778 def testShutdown(self):
Guido van Rossum8c943832002-08-08 01:00:28 +00001779 # Testing shutdown()
Guido van Rossum24e4af82002-06-12 19:18:08 +00001780 msg = self.cli_conn.recv(1024)
Guido van Rossum76489682002-06-12 20:38:30 +00001781 self.assertEqual(msg, MSG)
Mark Dickinson29500f62009-01-15 15:36:10 +00001782 # wait for _testShutdown to finish: on OS X, when the server
1783 # closes the connection the client also becomes disconnected,
1784 # and the client's shutdown call will fail. (Issue #4397.)
1785 self.done.wait()
Guido van Rossum24e4af82002-06-12 19:18:08 +00001786
1787 def _testShutdown(self):
1788 self.serv_conn.send(MSG)
Serhiy Storchaka5cfc79d2014-02-07 10:06:39 +02001789 self.serv_conn.shutdown(2)
1790
1791 testShutdown_overflow = support.cpython_only(testShutdown)
1792
1793 @support.cpython_only
1794 def _testShutdown_overflow(self):
1795 import _testcapi
1796 self.serv_conn.send(MSG)
Serhiy Storchaka78980432013-01-15 01:12:17 +02001797 # Issue 15989
1798 self.assertRaises(OverflowError, self.serv_conn.shutdown,
1799 _testcapi.INT_MAX + 1)
1800 self.assertRaises(OverflowError, self.serv_conn.shutdown,
1801 2 + (_testcapi.UINT_MAX + 1))
Guido van Rossum24e4af82002-06-12 19:18:08 +00001802 self.serv_conn.shutdown(2)
1803
Antoine Pitrou6e451df2010-08-09 20:39:54 +00001804 def testDetach(self):
1805 # Testing detach()
1806 fileno = self.cli_conn.fileno()
1807 f = self.cli_conn.detach()
1808 self.assertEqual(f, fileno)
1809 # cli_conn cannot be used anymore...
Antoine Pitrou70deb3d2012-04-01 01:00:17 +02001810 self.assertTrue(self.cli_conn._closed)
Andrew Svetlov0832af62012-12-18 23:10:48 +02001811 self.assertRaises(OSError, self.cli_conn.recv, 1024)
Antoine Pitroue43f9d02010-08-08 23:24:50 +00001812 self.cli_conn.close()
Antoine Pitrou6e451df2010-08-09 20:39:54 +00001813 # ...but we can create another socket using the (still open)
1814 # file descriptor
Antoine Pitroue43f9d02010-08-08 23:24:50 +00001815 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM, fileno=f)
Brian Curtin21ebbb72010-11-02 02:07:09 +00001816 self.addCleanup(sock.close)
Antoine Pitroue43f9d02010-08-08 23:24:50 +00001817 msg = sock.recv(1024)
1818 self.assertEqual(msg, MSG)
1819
Antoine Pitrou6e451df2010-08-09 20:39:54 +00001820 def _testDetach(self):
Antoine Pitroue43f9d02010-08-08 23:24:50 +00001821 self.serv_conn.send(MSG)
1822
Victor Stinner45df8202010-04-28 22:31:17 +00001823@unittest.skipUnless(thread, 'Threading required for this test.')
Guido van Rossum24e4af82002-06-12 19:18:08 +00001824class BasicUDPTest(ThreadedUDPSocketTest):
1825
1826 def __init__(self, methodName='runTest'):
1827 ThreadedUDPSocketTest.__init__(self, methodName=methodName)
1828
1829 def testSendtoAndRecv(self):
Guido van Rossum8c943832002-08-08 01:00:28 +00001830 # Testing sendto() and Recv() over UDP
Guido van Rossum24e4af82002-06-12 19:18:08 +00001831 msg = self.serv.recv(len(MSG))
Guido van Rossum76489682002-06-12 20:38:30 +00001832 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +00001833
1834 def _testSendtoAndRecv(self):
Christian Heimes5e696852008-04-09 08:37:03 +00001835 self.cli.sendto(MSG, 0, (HOST, self.port))
Guido van Rossum24e4af82002-06-12 19:18:08 +00001836
Guido van Rossum1c938012002-06-12 21:17:20 +00001837 def testRecvFrom(self):
Guido van Rossum8c943832002-08-08 01:00:28 +00001838 # Testing recvfrom() over UDP
Guido van Rossum24e4af82002-06-12 19:18:08 +00001839 msg, addr = self.serv.recvfrom(len(MSG))
Guido van Rossum76489682002-06-12 20:38:30 +00001840 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +00001841
Guido van Rossum1c938012002-06-12 21:17:20 +00001842 def _testRecvFrom(self):
Christian Heimes5e696852008-04-09 08:37:03 +00001843 self.cli.sendto(MSG, 0, (HOST, self.port))
Guido van Rossum24e4af82002-06-12 19:18:08 +00001844
Guido van Rossumd8faa362007-04-27 19:54:29 +00001845 def testRecvFromNegative(self):
1846 # Negative lengths passed to recvfrom should give ValueError.
1847 self.assertRaises(ValueError, self.serv.recvfrom, -1)
1848
1849 def _testRecvFromNegative(self):
Christian Heimes5e696852008-04-09 08:37:03 +00001850 self.cli.sendto(MSG, 0, (HOST, self.port))
Guido van Rossumd8faa362007-04-27 19:54:29 +00001851
Nick Coghlan96fe56a2011-08-22 11:55:57 +10001852# Tests for the sendmsg()/recvmsg() interface. Where possible, the
1853# same test code is used with different families and types of socket
1854# (e.g. stream, datagram), and tests using recvmsg() are repeated
1855# using recvmsg_into().
1856#
1857# The generic test classes such as SendmsgTests and
1858# RecvmsgGenericTests inherit from SendrecvmsgBase and expect to be
1859# supplied with sockets cli_sock and serv_sock representing the
1860# client's and the server's end of the connection respectively, and
1861# attributes cli_addr and serv_addr holding their (numeric where
1862# appropriate) addresses.
1863#
1864# The final concrete test classes combine these with subclasses of
1865# SocketTestBase which set up client and server sockets of a specific
1866# type, and with subclasses of SendrecvmsgBase such as
1867# SendrecvmsgDgramBase and SendrecvmsgConnectedBase which map these
1868# sockets to cli_sock and serv_sock and override the methods and
1869# attributes of SendrecvmsgBase to fill in destination addresses if
1870# needed when sending, check for specific flags in msg_flags, etc.
1871#
1872# RecvmsgIntoMixin provides a version of doRecvmsg() implemented using
1873# recvmsg_into().
1874
1875# XXX: like the other datagram (UDP) tests in this module, the code
1876# here assumes that datagram delivery on the local machine will be
1877# reliable.
1878
1879class SendrecvmsgBase(ThreadSafeCleanupTestCase):
1880 # Base class for sendmsg()/recvmsg() tests.
1881
1882 # Time in seconds to wait before considering a test failed, or
1883 # None for no timeout. Not all tests actually set a timeout.
1884 fail_timeout = 3.0
1885
1886 def setUp(self):
1887 self.misc_event = threading.Event()
1888 super().setUp()
1889
1890 def sendToServer(self, msg):
1891 # Send msg to the server.
1892 return self.cli_sock.send(msg)
1893
1894 # Tuple of alternative default arguments for sendmsg() when called
1895 # via sendmsgToServer() (e.g. to include a destination address).
1896 sendmsg_to_server_defaults = ()
1897
1898 def sendmsgToServer(self, *args):
1899 # Call sendmsg() on self.cli_sock with the given arguments,
1900 # filling in any arguments which are not supplied with the
1901 # corresponding items of self.sendmsg_to_server_defaults, if
1902 # any.
1903 return self.cli_sock.sendmsg(
1904 *(args + self.sendmsg_to_server_defaults[len(args):]))
1905
1906 def doRecvmsg(self, sock, bufsize, *args):
1907 # Call recvmsg() on sock with given arguments and return its
1908 # result. Should be used for tests which can use either
1909 # recvmsg() or recvmsg_into() - RecvmsgIntoMixin overrides
1910 # this method with one which emulates it using recvmsg_into(),
1911 # thus allowing the same test to be used for both methods.
1912 result = sock.recvmsg(bufsize, *args)
1913 self.registerRecvmsgResult(result)
1914 return result
1915
1916 def registerRecvmsgResult(self, result):
1917 # Called by doRecvmsg() with the return value of recvmsg() or
1918 # recvmsg_into(). Can be overridden to arrange cleanup based
1919 # on the returned ancillary data, for instance.
1920 pass
1921
1922 def checkRecvmsgAddress(self, addr1, addr2):
1923 # Called to compare the received address with the address of
1924 # the peer.
1925 self.assertEqual(addr1, addr2)
1926
1927 # Flags that are normally unset in msg_flags
1928 msg_flags_common_unset = 0
1929 for name in ("MSG_CTRUNC", "MSG_OOB"):
1930 msg_flags_common_unset |= getattr(socket, name, 0)
1931
1932 # Flags that are normally set
1933 msg_flags_common_set = 0
1934
1935 # Flags set when a complete record has been received (e.g. MSG_EOR
1936 # for SCTP)
1937 msg_flags_eor_indicator = 0
1938
1939 # Flags set when a complete record has not been received
1940 # (e.g. MSG_TRUNC for datagram sockets)
1941 msg_flags_non_eor_indicator = 0
1942
1943 def checkFlags(self, flags, eor=None, checkset=0, checkunset=0, ignore=0):
1944 # Method to check the value of msg_flags returned by recvmsg[_into]().
1945 #
1946 # Checks that all bits in msg_flags_common_set attribute are
1947 # set in "flags" and all bits in msg_flags_common_unset are
1948 # unset.
1949 #
1950 # The "eor" argument specifies whether the flags should
1951 # indicate that a full record (or datagram) has been received.
1952 # If "eor" is None, no checks are done; otherwise, checks
1953 # that:
1954 #
1955 # * if "eor" is true, all bits in msg_flags_eor_indicator are
1956 # set and all bits in msg_flags_non_eor_indicator are unset
1957 #
1958 # * if "eor" is false, all bits in msg_flags_non_eor_indicator
1959 # are set and all bits in msg_flags_eor_indicator are unset
1960 #
1961 # If "checkset" and/or "checkunset" are supplied, they require
1962 # the given bits to be set or unset respectively, overriding
1963 # what the attributes require for those bits.
1964 #
1965 # If any bits are set in "ignore", they will not be checked,
1966 # regardless of the other inputs.
1967 #
1968 # Will raise Exception if the inputs require a bit to be both
1969 # set and unset, and it is not ignored.
1970
1971 defaultset = self.msg_flags_common_set
1972 defaultunset = self.msg_flags_common_unset
1973
1974 if eor:
1975 defaultset |= self.msg_flags_eor_indicator
1976 defaultunset |= self.msg_flags_non_eor_indicator
1977 elif eor is not None:
1978 defaultset |= self.msg_flags_non_eor_indicator
1979 defaultunset |= self.msg_flags_eor_indicator
1980
1981 # Function arguments override defaults
1982 defaultset &= ~checkunset
1983 defaultunset &= ~checkset
1984
1985 # Merge arguments with remaining defaults, and check for conflicts
1986 checkset |= defaultset
1987 checkunset |= defaultunset
1988 inboth = checkset & checkunset & ~ignore
1989 if inboth:
1990 raise Exception("contradictory set, unset requirements for flags "
1991 "{0:#x}".format(inboth))
1992
1993 # Compare with given msg_flags value
1994 mask = (checkset | checkunset) & ~ignore
1995 self.assertEqual(flags & mask, checkset & mask)
1996
1997
1998class RecvmsgIntoMixin(SendrecvmsgBase):
1999 # Mixin to implement doRecvmsg() using recvmsg_into().
2000
2001 def doRecvmsg(self, sock, bufsize, *args):
2002 buf = bytearray(bufsize)
2003 result = sock.recvmsg_into([buf], *args)
2004 self.registerRecvmsgResult(result)
2005 self.assertGreaterEqual(result[0], 0)
2006 self.assertLessEqual(result[0], bufsize)
2007 return (bytes(buf[:result[0]]),) + result[1:]
2008
2009
2010class SendrecvmsgDgramFlagsBase(SendrecvmsgBase):
2011 # Defines flags to be checked in msg_flags for datagram sockets.
2012
2013 @property
2014 def msg_flags_non_eor_indicator(self):
2015 return super().msg_flags_non_eor_indicator | socket.MSG_TRUNC
2016
2017
2018class SendrecvmsgSCTPFlagsBase(SendrecvmsgBase):
2019 # Defines flags to be checked in msg_flags for SCTP sockets.
2020
2021 @property
2022 def msg_flags_eor_indicator(self):
2023 return super().msg_flags_eor_indicator | socket.MSG_EOR
2024
2025
2026class SendrecvmsgConnectionlessBase(SendrecvmsgBase):
2027 # Base class for tests on connectionless-mode sockets. Users must
2028 # supply sockets on attributes cli and serv to be mapped to
2029 # cli_sock and serv_sock respectively.
2030
2031 @property
2032 def serv_sock(self):
2033 return self.serv
2034
2035 @property
2036 def cli_sock(self):
2037 return self.cli
2038
2039 @property
2040 def sendmsg_to_server_defaults(self):
2041 return ([], [], 0, self.serv_addr)
2042
2043 def sendToServer(self, msg):
2044 return self.cli_sock.sendto(msg, self.serv_addr)
2045
2046
2047class SendrecvmsgConnectedBase(SendrecvmsgBase):
2048 # Base class for tests on connected sockets. Users must supply
2049 # sockets on attributes serv_conn and cli_conn (representing the
2050 # connections *to* the server and the client), to be mapped to
2051 # cli_sock and serv_sock respectively.
2052
2053 @property
2054 def serv_sock(self):
2055 return self.cli_conn
2056
2057 @property
2058 def cli_sock(self):
2059 return self.serv_conn
2060
2061 def checkRecvmsgAddress(self, addr1, addr2):
2062 # Address is currently "unspecified" for a connected socket,
2063 # so we don't examine it
2064 pass
2065
2066
2067class SendrecvmsgServerTimeoutBase(SendrecvmsgBase):
2068 # Base class to set a timeout on server's socket.
2069
2070 def setUp(self):
2071 super().setUp()
2072 self.serv_sock.settimeout(self.fail_timeout)
2073
2074
2075class SendmsgTests(SendrecvmsgServerTimeoutBase):
2076 # Tests for sendmsg() which can use any socket type and do not
2077 # involve recvmsg() or recvmsg_into().
2078
2079 def testSendmsg(self):
2080 # Send a simple message with sendmsg().
2081 self.assertEqual(self.serv_sock.recv(len(MSG)), MSG)
2082
2083 def _testSendmsg(self):
2084 self.assertEqual(self.sendmsgToServer([MSG]), len(MSG))
2085
2086 def testSendmsgDataGenerator(self):
2087 # Send from buffer obtained from a generator (not a sequence).
2088 self.assertEqual(self.serv_sock.recv(len(MSG)), MSG)
2089
2090 def _testSendmsgDataGenerator(self):
2091 self.assertEqual(self.sendmsgToServer((o for o in [MSG])),
2092 len(MSG))
2093
2094 def testSendmsgAncillaryGenerator(self):
2095 # Gather (empty) ancillary data from a generator.
2096 self.assertEqual(self.serv_sock.recv(len(MSG)), MSG)
2097
2098 def _testSendmsgAncillaryGenerator(self):
2099 self.assertEqual(self.sendmsgToServer([MSG], (o for o in [])),
2100 len(MSG))
2101
2102 def testSendmsgArray(self):
2103 # Send data from an array instead of the usual bytes object.
2104 self.assertEqual(self.serv_sock.recv(len(MSG)), MSG)
2105
2106 def _testSendmsgArray(self):
2107 self.assertEqual(self.sendmsgToServer([array.array("B", MSG)]),
2108 len(MSG))
2109
2110 def testSendmsgGather(self):
2111 # Send message data from more than one buffer (gather write).
2112 self.assertEqual(self.serv_sock.recv(len(MSG)), MSG)
2113
2114 def _testSendmsgGather(self):
2115 self.assertEqual(self.sendmsgToServer([MSG[:3], MSG[3:]]), len(MSG))
2116
2117 def testSendmsgBadArgs(self):
2118 # Check that sendmsg() rejects invalid arguments.
2119 self.assertEqual(self.serv_sock.recv(1000), b"done")
2120
2121 def _testSendmsgBadArgs(self):
2122 self.assertRaises(TypeError, self.cli_sock.sendmsg)
2123 self.assertRaises(TypeError, self.sendmsgToServer,
2124 b"not in an iterable")
2125 self.assertRaises(TypeError, self.sendmsgToServer,
2126 object())
2127 self.assertRaises(TypeError, self.sendmsgToServer,
2128 [object()])
2129 self.assertRaises(TypeError, self.sendmsgToServer,
2130 [MSG, object()])
2131 self.assertRaises(TypeError, self.sendmsgToServer,
2132 [MSG], object())
2133 self.assertRaises(TypeError, self.sendmsgToServer,
2134 [MSG], [], object())
2135 self.assertRaises(TypeError, self.sendmsgToServer,
2136 [MSG], [], 0, object())
2137 self.sendToServer(b"done")
2138
2139 def testSendmsgBadCmsg(self):
2140 # Check that invalid ancillary data items are rejected.
2141 self.assertEqual(self.serv_sock.recv(1000), b"done")
2142
2143 def _testSendmsgBadCmsg(self):
2144 self.assertRaises(TypeError, self.sendmsgToServer,
2145 [MSG], [object()])
2146 self.assertRaises(TypeError, self.sendmsgToServer,
2147 [MSG], [(object(), 0, b"data")])
2148 self.assertRaises(TypeError, self.sendmsgToServer,
2149 [MSG], [(0, object(), b"data")])
2150 self.assertRaises(TypeError, self.sendmsgToServer,
2151 [MSG], [(0, 0, object())])
2152 self.assertRaises(TypeError, self.sendmsgToServer,
2153 [MSG], [(0, 0)])
2154 self.assertRaises(TypeError, self.sendmsgToServer,
2155 [MSG], [(0, 0, b"data", 42)])
2156 self.sendToServer(b"done")
2157
2158 @requireAttrs(socket, "CMSG_SPACE")
2159 def testSendmsgBadMultiCmsg(self):
2160 # Check that invalid ancillary data items are rejected when
2161 # more than one item is present.
2162 self.assertEqual(self.serv_sock.recv(1000), b"done")
2163
2164 @testSendmsgBadMultiCmsg.client_skip
2165 def _testSendmsgBadMultiCmsg(self):
2166 self.assertRaises(TypeError, self.sendmsgToServer,
2167 [MSG], [0, 0, b""])
2168 self.assertRaises(TypeError, self.sendmsgToServer,
2169 [MSG], [(0, 0, b""), object()])
2170 self.sendToServer(b"done")
2171
2172 def testSendmsgExcessCmsgReject(self):
2173 # Check that sendmsg() rejects excess ancillary data items
2174 # when the number that can be sent is limited.
2175 self.assertEqual(self.serv_sock.recv(1000), b"done")
2176
2177 def _testSendmsgExcessCmsgReject(self):
2178 if not hasattr(socket, "CMSG_SPACE"):
2179 # Can only send one item
Andrew Svetlov0832af62012-12-18 23:10:48 +02002180 with self.assertRaises(OSError) as cm:
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002181 self.sendmsgToServer([MSG], [(0, 0, b""), (0, 0, b"")])
2182 self.assertIsNone(cm.exception.errno)
2183 self.sendToServer(b"done")
2184
2185 def testSendmsgAfterClose(self):
2186 # Check that sendmsg() fails on a closed socket.
2187 pass
2188
2189 def _testSendmsgAfterClose(self):
2190 self.cli_sock.close()
Andrew Svetlov0832af62012-12-18 23:10:48 +02002191 self.assertRaises(OSError, self.sendmsgToServer, [MSG])
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002192
2193
2194class SendmsgStreamTests(SendmsgTests):
2195 # Tests for sendmsg() which require a stream socket and do not
2196 # involve recvmsg() or recvmsg_into().
2197
2198 def testSendmsgExplicitNoneAddr(self):
2199 # Check that peer address can be specified as None.
2200 self.assertEqual(self.serv_sock.recv(len(MSG)), MSG)
2201
2202 def _testSendmsgExplicitNoneAddr(self):
2203 self.assertEqual(self.sendmsgToServer([MSG], [], 0, None), len(MSG))
2204
2205 def testSendmsgTimeout(self):
2206 # Check that timeout works with sendmsg().
2207 self.assertEqual(self.serv_sock.recv(512), b"a"*512)
2208 self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
2209
2210 def _testSendmsgTimeout(self):
2211 try:
2212 self.cli_sock.settimeout(0.03)
2213 with self.assertRaises(socket.timeout):
2214 while True:
2215 self.sendmsgToServer([b"a"*512])
2216 finally:
2217 self.misc_event.set()
2218
2219 # XXX: would be nice to have more tests for sendmsg flags argument.
2220
2221 # Linux supports MSG_DONTWAIT when sending, but in general, it
2222 # only works when receiving. Could add other platforms if they
2223 # support it too.
Serhiy Storchakaabde2c12014-11-19 13:21:13 +02002224 @skipWithClientIf(sys.platform not in {"linux"},
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002225 "MSG_DONTWAIT not known to work on this platform when "
2226 "sending")
2227 def testSendmsgDontWait(self):
2228 # Check that MSG_DONTWAIT in flags causes non-blocking behaviour.
2229 self.assertEqual(self.serv_sock.recv(512), b"a"*512)
2230 self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
2231
2232 @testSendmsgDontWait.client_skip
2233 def _testSendmsgDontWait(self):
2234 try:
Andrew Svetlov0832af62012-12-18 23:10:48 +02002235 with self.assertRaises(OSError) as cm:
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002236 while True:
2237 self.sendmsgToServer([b"a"*512], [], socket.MSG_DONTWAIT)
2238 self.assertIn(cm.exception.errno,
2239 (errno.EAGAIN, errno.EWOULDBLOCK))
2240 finally:
2241 self.misc_event.set()
2242
2243
2244class SendmsgConnectionlessTests(SendmsgTests):
2245 # Tests for sendmsg() which require a connectionless-mode
2246 # (e.g. datagram) socket, and do not involve recvmsg() or
2247 # recvmsg_into().
2248
2249 def testSendmsgNoDestAddr(self):
2250 # Check that sendmsg() fails when no destination address is
2251 # given for unconnected socket.
2252 pass
2253
2254 def _testSendmsgNoDestAddr(self):
Andrew Svetlov0832af62012-12-18 23:10:48 +02002255 self.assertRaises(OSError, self.cli_sock.sendmsg,
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002256 [MSG])
Andrew Svetlov0832af62012-12-18 23:10:48 +02002257 self.assertRaises(OSError, self.cli_sock.sendmsg,
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002258 [MSG], [], 0, None)
2259
2260
2261class RecvmsgGenericTests(SendrecvmsgBase):
2262 # Tests for recvmsg() which can also be emulated using
2263 # recvmsg_into(), and can use any socket type.
2264
2265 def testRecvmsg(self):
2266 # Receive a simple message with recvmsg[_into]().
2267 msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock, len(MSG))
2268 self.assertEqual(msg, MSG)
2269 self.checkRecvmsgAddress(addr, self.cli_addr)
2270 self.assertEqual(ancdata, [])
2271 self.checkFlags(flags, eor=True)
2272
2273 def _testRecvmsg(self):
2274 self.sendToServer(MSG)
2275
2276 def testRecvmsgExplicitDefaults(self):
2277 # Test recvmsg[_into]() with default arguments provided explicitly.
2278 msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
2279 len(MSG), 0, 0)
2280 self.assertEqual(msg, MSG)
2281 self.checkRecvmsgAddress(addr, self.cli_addr)
2282 self.assertEqual(ancdata, [])
2283 self.checkFlags(flags, eor=True)
2284
2285 def _testRecvmsgExplicitDefaults(self):
2286 self.sendToServer(MSG)
2287
2288 def testRecvmsgShorter(self):
2289 # Receive a message smaller than buffer.
2290 msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
2291 len(MSG) + 42)
2292 self.assertEqual(msg, MSG)
2293 self.checkRecvmsgAddress(addr, self.cli_addr)
2294 self.assertEqual(ancdata, [])
2295 self.checkFlags(flags, eor=True)
2296
2297 def _testRecvmsgShorter(self):
2298 self.sendToServer(MSG)
2299
Charles-François Natali8619cd72011-10-03 19:43:15 +02002300 # FreeBSD < 8 doesn't always set the MSG_TRUNC flag when a truncated
2301 # datagram is received (issue #13001).
2302 @support.requires_freebsd_version(8)
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002303 def testRecvmsgTrunc(self):
2304 # Receive part of message, check for truncation indicators.
2305 msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
2306 len(MSG) - 3)
2307 self.assertEqual(msg, MSG[:-3])
2308 self.checkRecvmsgAddress(addr, self.cli_addr)
2309 self.assertEqual(ancdata, [])
2310 self.checkFlags(flags, eor=False)
2311
Charles-François Natali8619cd72011-10-03 19:43:15 +02002312 @support.requires_freebsd_version(8)
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002313 def _testRecvmsgTrunc(self):
2314 self.sendToServer(MSG)
2315
2316 def testRecvmsgShortAncillaryBuf(self):
2317 # Test ancillary data buffer too small to hold any ancillary data.
2318 msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
2319 len(MSG), 1)
2320 self.assertEqual(msg, MSG)
2321 self.checkRecvmsgAddress(addr, self.cli_addr)
2322 self.assertEqual(ancdata, [])
2323 self.checkFlags(flags, eor=True)
2324
2325 def _testRecvmsgShortAncillaryBuf(self):
2326 self.sendToServer(MSG)
2327
2328 def testRecvmsgLongAncillaryBuf(self):
2329 # Test large ancillary data buffer.
2330 msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
2331 len(MSG), 10240)
2332 self.assertEqual(msg, MSG)
2333 self.checkRecvmsgAddress(addr, self.cli_addr)
2334 self.assertEqual(ancdata, [])
2335 self.checkFlags(flags, eor=True)
2336
2337 def _testRecvmsgLongAncillaryBuf(self):
2338 self.sendToServer(MSG)
2339
2340 def testRecvmsgAfterClose(self):
2341 # Check that recvmsg[_into]() fails on a closed socket.
2342 self.serv_sock.close()
Andrew Svetlov0832af62012-12-18 23:10:48 +02002343 self.assertRaises(OSError, self.doRecvmsg, self.serv_sock, 1024)
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002344
2345 def _testRecvmsgAfterClose(self):
2346 pass
2347
2348 def testRecvmsgTimeout(self):
2349 # Check that timeout works.
2350 try:
2351 self.serv_sock.settimeout(0.03)
2352 self.assertRaises(socket.timeout,
2353 self.doRecvmsg, self.serv_sock, len(MSG))
2354 finally:
2355 self.misc_event.set()
2356
2357 def _testRecvmsgTimeout(self):
2358 self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
2359
2360 @requireAttrs(socket, "MSG_PEEK")
2361 def testRecvmsgPeek(self):
2362 # Check that MSG_PEEK in flags enables examination of pending
2363 # data without consuming it.
2364
2365 # Receive part of data with MSG_PEEK.
2366 msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
2367 len(MSG) - 3, 0,
2368 socket.MSG_PEEK)
2369 self.assertEqual(msg, MSG[:-3])
2370 self.checkRecvmsgAddress(addr, self.cli_addr)
2371 self.assertEqual(ancdata, [])
2372 # Ignoring MSG_TRUNC here (so this test is the same for stream
2373 # and datagram sockets). Some wording in POSIX seems to
2374 # suggest that it needn't be set when peeking, but that may
2375 # just be a slip.
2376 self.checkFlags(flags, eor=False,
2377 ignore=getattr(socket, "MSG_TRUNC", 0))
2378
2379 # Receive all data with MSG_PEEK.
2380 msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
2381 len(MSG), 0,
2382 socket.MSG_PEEK)
2383 self.assertEqual(msg, MSG)
2384 self.checkRecvmsgAddress(addr, self.cli_addr)
2385 self.assertEqual(ancdata, [])
2386 self.checkFlags(flags, eor=True)
2387
2388 # Check that the same data can still be received normally.
2389 msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock, len(MSG))
2390 self.assertEqual(msg, MSG)
2391 self.checkRecvmsgAddress(addr, self.cli_addr)
2392 self.assertEqual(ancdata, [])
2393 self.checkFlags(flags, eor=True)
2394
2395 @testRecvmsgPeek.client_skip
2396 def _testRecvmsgPeek(self):
2397 self.sendToServer(MSG)
2398
2399 @requireAttrs(socket.socket, "sendmsg")
2400 def testRecvmsgFromSendmsg(self):
2401 # Test receiving with recvmsg[_into]() when message is sent
2402 # using sendmsg().
2403 self.serv_sock.settimeout(self.fail_timeout)
2404 msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock, len(MSG))
2405 self.assertEqual(msg, MSG)
2406 self.checkRecvmsgAddress(addr, self.cli_addr)
2407 self.assertEqual(ancdata, [])
2408 self.checkFlags(flags, eor=True)
2409
2410 @testRecvmsgFromSendmsg.client_skip
2411 def _testRecvmsgFromSendmsg(self):
2412 self.assertEqual(self.sendmsgToServer([MSG[:3], MSG[3:]]), len(MSG))
2413
2414
2415class RecvmsgGenericStreamTests(RecvmsgGenericTests):
2416 # Tests which require a stream socket and can use either recvmsg()
2417 # or recvmsg_into().
2418
2419 def testRecvmsgEOF(self):
2420 # Receive end-of-stream indicator (b"", peer socket closed).
2421 msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock, 1024)
2422 self.assertEqual(msg, b"")
2423 self.checkRecvmsgAddress(addr, self.cli_addr)
2424 self.assertEqual(ancdata, [])
2425 self.checkFlags(flags, eor=None) # Might not have end-of-record marker
2426
2427 def _testRecvmsgEOF(self):
2428 self.cli_sock.close()
2429
2430 def testRecvmsgOverflow(self):
2431 # Receive a message in more than one chunk.
2432 seg1, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
2433 len(MSG) - 3)
2434 self.checkRecvmsgAddress(addr, self.cli_addr)
2435 self.assertEqual(ancdata, [])
2436 self.checkFlags(flags, eor=False)
2437
2438 seg2, ancdata, flags, addr = self.doRecvmsg(self.serv_sock, 1024)
2439 self.checkRecvmsgAddress(addr, self.cli_addr)
2440 self.assertEqual(ancdata, [])
2441 self.checkFlags(flags, eor=True)
2442
2443 msg = seg1 + seg2
2444 self.assertEqual(msg, MSG)
2445
2446 def _testRecvmsgOverflow(self):
2447 self.sendToServer(MSG)
2448
2449
2450class RecvmsgTests(RecvmsgGenericTests):
2451 # Tests for recvmsg() which can use any socket type.
2452
2453 def testRecvmsgBadArgs(self):
2454 # Check that recvmsg() rejects invalid arguments.
2455 self.assertRaises(TypeError, self.serv_sock.recvmsg)
2456 self.assertRaises(ValueError, self.serv_sock.recvmsg,
2457 -1, 0, 0)
2458 self.assertRaises(ValueError, self.serv_sock.recvmsg,
2459 len(MSG), -1, 0)
2460 self.assertRaises(TypeError, self.serv_sock.recvmsg,
2461 [bytearray(10)], 0, 0)
2462 self.assertRaises(TypeError, self.serv_sock.recvmsg,
2463 object(), 0, 0)
2464 self.assertRaises(TypeError, self.serv_sock.recvmsg,
2465 len(MSG), object(), 0)
2466 self.assertRaises(TypeError, self.serv_sock.recvmsg,
2467 len(MSG), 0, object())
2468
2469 msg, ancdata, flags, addr = self.serv_sock.recvmsg(len(MSG), 0, 0)
2470 self.assertEqual(msg, MSG)
2471 self.checkRecvmsgAddress(addr, self.cli_addr)
2472 self.assertEqual(ancdata, [])
2473 self.checkFlags(flags, eor=True)
2474
2475 def _testRecvmsgBadArgs(self):
2476 self.sendToServer(MSG)
2477
2478
2479class RecvmsgIntoTests(RecvmsgIntoMixin, RecvmsgGenericTests):
2480 # Tests for recvmsg_into() which can use any socket type.
2481
2482 def testRecvmsgIntoBadArgs(self):
2483 # Check that recvmsg_into() rejects invalid arguments.
2484 buf = bytearray(len(MSG))
2485 self.assertRaises(TypeError, self.serv_sock.recvmsg_into)
2486 self.assertRaises(TypeError, self.serv_sock.recvmsg_into,
2487 len(MSG), 0, 0)
2488 self.assertRaises(TypeError, self.serv_sock.recvmsg_into,
2489 buf, 0, 0)
2490 self.assertRaises(TypeError, self.serv_sock.recvmsg_into,
2491 [object()], 0, 0)
2492 self.assertRaises(TypeError, self.serv_sock.recvmsg_into,
2493 [b"I'm not writable"], 0, 0)
2494 self.assertRaises(TypeError, self.serv_sock.recvmsg_into,
2495 [buf, object()], 0, 0)
2496 self.assertRaises(ValueError, self.serv_sock.recvmsg_into,
2497 [buf], -1, 0)
2498 self.assertRaises(TypeError, self.serv_sock.recvmsg_into,
2499 [buf], object(), 0)
2500 self.assertRaises(TypeError, self.serv_sock.recvmsg_into,
2501 [buf], 0, object())
2502
2503 nbytes, ancdata, flags, addr = self.serv_sock.recvmsg_into([buf], 0, 0)
2504 self.assertEqual(nbytes, len(MSG))
2505 self.assertEqual(buf, bytearray(MSG))
2506 self.checkRecvmsgAddress(addr, self.cli_addr)
2507 self.assertEqual(ancdata, [])
2508 self.checkFlags(flags, eor=True)
2509
2510 def _testRecvmsgIntoBadArgs(self):
2511 self.sendToServer(MSG)
2512
2513 def testRecvmsgIntoGenerator(self):
2514 # Receive into buffer obtained from a generator (not a sequence).
2515 buf = bytearray(len(MSG))
2516 nbytes, ancdata, flags, addr = self.serv_sock.recvmsg_into(
2517 (o for o in [buf]))
2518 self.assertEqual(nbytes, len(MSG))
2519 self.assertEqual(buf, bytearray(MSG))
2520 self.checkRecvmsgAddress(addr, self.cli_addr)
2521 self.assertEqual(ancdata, [])
2522 self.checkFlags(flags, eor=True)
2523
2524 def _testRecvmsgIntoGenerator(self):
2525 self.sendToServer(MSG)
2526
2527 def testRecvmsgIntoArray(self):
2528 # Receive into an array rather than the usual bytearray.
2529 buf = array.array("B", [0] * len(MSG))
2530 nbytes, ancdata, flags, addr = self.serv_sock.recvmsg_into([buf])
2531 self.assertEqual(nbytes, len(MSG))
Nadeem Vawda3d1706f2011-08-22 09:46:56 +02002532 self.assertEqual(buf.tobytes(), MSG)
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002533 self.checkRecvmsgAddress(addr, self.cli_addr)
2534 self.assertEqual(ancdata, [])
2535 self.checkFlags(flags, eor=True)
2536
2537 def _testRecvmsgIntoArray(self):
2538 self.sendToServer(MSG)
2539
2540 def testRecvmsgIntoScatter(self):
2541 # Receive into multiple buffers (scatter write).
2542 b1 = bytearray(b"----")
2543 b2 = bytearray(b"0123456789")
2544 b3 = bytearray(b"--------------")
2545 nbytes, ancdata, flags, addr = self.serv_sock.recvmsg_into(
2546 [b1, memoryview(b2)[2:9], b3])
2547 self.assertEqual(nbytes, len(b"Mary had a little lamb"))
2548 self.assertEqual(b1, bytearray(b"Mary"))
2549 self.assertEqual(b2, bytearray(b"01 had a 9"))
2550 self.assertEqual(b3, bytearray(b"little lamb---"))
2551 self.checkRecvmsgAddress(addr, self.cli_addr)
2552 self.assertEqual(ancdata, [])
2553 self.checkFlags(flags, eor=True)
2554
2555 def _testRecvmsgIntoScatter(self):
2556 self.sendToServer(b"Mary had a little lamb")
2557
2558
2559class CmsgMacroTests(unittest.TestCase):
2560 # Test the functions CMSG_LEN() and CMSG_SPACE(). Tests
2561 # assumptions used by sendmsg() and recvmsg[_into](), which share
2562 # code with these functions.
2563
2564 # Match the definition in socketmodule.c
Serhiy Storchaka5cfc79d2014-02-07 10:06:39 +02002565 try:
2566 import _testcapi
2567 except ImportError:
2568 socklen_t_limit = 0x7fffffff
2569 else:
2570 socklen_t_limit = min(0x7fffffff, _testcapi.INT_MAX)
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002571
2572 @requireAttrs(socket, "CMSG_LEN")
2573 def testCMSG_LEN(self):
2574 # Test CMSG_LEN() with various valid and invalid values,
2575 # checking the assumptions used by recvmsg() and sendmsg().
2576 toobig = self.socklen_t_limit - socket.CMSG_LEN(0) + 1
2577 values = list(range(257)) + list(range(toobig - 257, toobig))
2578
2579 # struct cmsghdr has at least three members, two of which are ints
2580 self.assertGreater(socket.CMSG_LEN(0), array.array("i").itemsize * 2)
2581 for n in values:
2582 ret = socket.CMSG_LEN(n)
2583 # This is how recvmsg() calculates the data size
2584 self.assertEqual(ret - socket.CMSG_LEN(0), n)
2585 self.assertLessEqual(ret, self.socklen_t_limit)
2586
2587 self.assertRaises(OverflowError, socket.CMSG_LEN, -1)
2588 # sendmsg() shares code with these functions, and requires
2589 # that it reject values over the limit.
2590 self.assertRaises(OverflowError, socket.CMSG_LEN, toobig)
2591 self.assertRaises(OverflowError, socket.CMSG_LEN, sys.maxsize)
2592
2593 @requireAttrs(socket, "CMSG_SPACE")
2594 def testCMSG_SPACE(self):
2595 # Test CMSG_SPACE() with various valid and invalid values,
2596 # checking the assumptions used by sendmsg().
2597 toobig = self.socklen_t_limit - socket.CMSG_SPACE(1) + 1
2598 values = list(range(257)) + list(range(toobig - 257, toobig))
2599
2600 last = socket.CMSG_SPACE(0)
2601 # struct cmsghdr has at least three members, two of which are ints
2602 self.assertGreater(last, array.array("i").itemsize * 2)
2603 for n in values:
2604 ret = socket.CMSG_SPACE(n)
2605 self.assertGreaterEqual(ret, last)
2606 self.assertGreaterEqual(ret, socket.CMSG_LEN(n))
2607 self.assertGreaterEqual(ret, n + socket.CMSG_LEN(0))
2608 self.assertLessEqual(ret, self.socklen_t_limit)
2609 last = ret
2610
2611 self.assertRaises(OverflowError, socket.CMSG_SPACE, -1)
2612 # sendmsg() shares code with these functions, and requires
2613 # that it reject values over the limit.
2614 self.assertRaises(OverflowError, socket.CMSG_SPACE, toobig)
2615 self.assertRaises(OverflowError, socket.CMSG_SPACE, sys.maxsize)
2616
2617
2618class SCMRightsTest(SendrecvmsgServerTimeoutBase):
2619 # Tests for file descriptor passing on Unix-domain sockets.
2620
2621 # Invalid file descriptor value that's unlikely to evaluate to a
2622 # real FD even if one of its bytes is replaced with a different
2623 # value (which shouldn't actually happen).
2624 badfd = -0x5555
2625
2626 def newFDs(self, n):
2627 # Return a list of n file descriptors for newly-created files
2628 # containing their list indices as ASCII numbers.
2629 fds = []
2630 for i in range(n):
2631 fd, path = tempfile.mkstemp()
2632 self.addCleanup(os.unlink, path)
2633 self.addCleanup(os.close, fd)
2634 os.write(fd, str(i).encode())
2635 fds.append(fd)
2636 return fds
2637
2638 def checkFDs(self, fds):
2639 # Check that the file descriptors in the given list contain
2640 # their correct list indices as ASCII numbers.
2641 for n, fd in enumerate(fds):
2642 os.lseek(fd, 0, os.SEEK_SET)
2643 self.assertEqual(os.read(fd, 1024), str(n).encode())
2644
2645 def registerRecvmsgResult(self, result):
2646 self.addCleanup(self.closeRecvmsgFDs, result)
2647
2648 def closeRecvmsgFDs(self, recvmsg_result):
2649 # Close all file descriptors specified in the ancillary data
2650 # of the given return value from recvmsg() or recvmsg_into().
2651 for cmsg_level, cmsg_type, cmsg_data in recvmsg_result[1]:
2652 if (cmsg_level == socket.SOL_SOCKET and
2653 cmsg_type == socket.SCM_RIGHTS):
2654 fds = array.array("i")
Nadeem Vawda3d1706f2011-08-22 09:46:56 +02002655 fds.frombytes(cmsg_data[:
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002656 len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])
2657 for fd in fds:
2658 os.close(fd)
2659
2660 def createAndSendFDs(self, n):
2661 # Send n new file descriptors created by newFDs() to the
2662 # server, with the constant MSG as the non-ancillary data.
2663 self.assertEqual(
2664 self.sendmsgToServer([MSG],
2665 [(socket.SOL_SOCKET,
2666 socket.SCM_RIGHTS,
2667 array.array("i", self.newFDs(n)))]),
2668 len(MSG))
2669
2670 def checkRecvmsgFDs(self, numfds, result, maxcmsgs=1, ignoreflags=0):
2671 # Check that constant MSG was received with numfds file
2672 # descriptors in a maximum of maxcmsgs control messages (which
2673 # must contain only complete integers). By default, check
2674 # that MSG_CTRUNC is unset, but ignore any flags in
2675 # ignoreflags.
2676 msg, ancdata, flags, addr = result
2677 self.assertEqual(msg, MSG)
2678 self.checkRecvmsgAddress(addr, self.cli_addr)
2679 self.checkFlags(flags, eor=True, checkunset=socket.MSG_CTRUNC,
2680 ignore=ignoreflags)
2681
2682 self.assertIsInstance(ancdata, list)
2683 self.assertLessEqual(len(ancdata), maxcmsgs)
2684 fds = array.array("i")
2685 for item in ancdata:
2686 self.assertIsInstance(item, tuple)
2687 cmsg_level, cmsg_type, cmsg_data = item
2688 self.assertEqual(cmsg_level, socket.SOL_SOCKET)
2689 self.assertEqual(cmsg_type, socket.SCM_RIGHTS)
2690 self.assertIsInstance(cmsg_data, bytes)
2691 self.assertEqual(len(cmsg_data) % SIZEOF_INT, 0)
Nadeem Vawda3d1706f2011-08-22 09:46:56 +02002692 fds.frombytes(cmsg_data)
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002693
2694 self.assertEqual(len(fds), numfds)
2695 self.checkFDs(fds)
2696
2697 def testFDPassSimple(self):
2698 # Pass a single FD (array read from bytes object).
2699 self.checkRecvmsgFDs(1, self.doRecvmsg(self.serv_sock,
2700 len(MSG), 10240))
2701
2702 def _testFDPassSimple(self):
2703 self.assertEqual(
2704 self.sendmsgToServer(
2705 [MSG],
2706 [(socket.SOL_SOCKET,
2707 socket.SCM_RIGHTS,
Nadeem Vawda3d1706f2011-08-22 09:46:56 +02002708 array.array("i", self.newFDs(1)).tobytes())]),
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002709 len(MSG))
2710
2711 def testMultipleFDPass(self):
2712 # Pass multiple FDs in a single array.
2713 self.checkRecvmsgFDs(4, self.doRecvmsg(self.serv_sock,
2714 len(MSG), 10240))
2715
2716 def _testMultipleFDPass(self):
2717 self.createAndSendFDs(4)
2718
2719 @requireAttrs(socket, "CMSG_SPACE")
2720 def testFDPassCMSG_SPACE(self):
2721 # Test using CMSG_SPACE() to calculate ancillary buffer size.
2722 self.checkRecvmsgFDs(
2723 4, self.doRecvmsg(self.serv_sock, len(MSG),
2724 socket.CMSG_SPACE(4 * SIZEOF_INT)))
2725
2726 @testFDPassCMSG_SPACE.client_skip
2727 def _testFDPassCMSG_SPACE(self):
2728 self.createAndSendFDs(4)
2729
2730 def testFDPassCMSG_LEN(self):
2731 # Test using CMSG_LEN() to calculate ancillary buffer size.
2732 self.checkRecvmsgFDs(1,
2733 self.doRecvmsg(self.serv_sock, len(MSG),
2734 socket.CMSG_LEN(4 * SIZEOF_INT)),
2735 # RFC 3542 says implementations may set
2736 # MSG_CTRUNC if there isn't enough space
2737 # for trailing padding.
2738 ignoreflags=socket.MSG_CTRUNC)
2739
2740 def _testFDPassCMSG_LEN(self):
2741 self.createAndSendFDs(1)
2742
Charles-Francois Natalid66b10e2013-05-20 19:08:19 +02002743 @unittest.skipIf(sys.platform == "darwin", "skipping, see issue #12958")
Robert Collins43cbbe22015-08-03 10:36:04 +12002744 @unittest.skipIf(sys.platform.startswith("aix"), "skipping, see issue #22397")
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002745 @requireAttrs(socket, "CMSG_SPACE")
2746 def testFDPassSeparate(self):
2747 # Pass two FDs in two separate arrays. Arrays may be combined
2748 # into a single control message by the OS.
2749 self.checkRecvmsgFDs(2,
2750 self.doRecvmsg(self.serv_sock, len(MSG), 10240),
2751 maxcmsgs=2)
2752
2753 @testFDPassSeparate.client_skip
Charles-Francois Natalid66b10e2013-05-20 19:08:19 +02002754 @unittest.skipIf(sys.platform == "darwin", "skipping, see issue #12958")
Robert Collins43cbbe22015-08-03 10:36:04 +12002755 @unittest.skipIf(sys.platform.startswith("aix"), "skipping, see issue #22397")
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002756 def _testFDPassSeparate(self):
2757 fd0, fd1 = self.newFDs(2)
2758 self.assertEqual(
2759 self.sendmsgToServer([MSG], [(socket.SOL_SOCKET,
2760 socket.SCM_RIGHTS,
2761 array.array("i", [fd0])),
2762 (socket.SOL_SOCKET,
2763 socket.SCM_RIGHTS,
2764 array.array("i", [fd1]))]),
2765 len(MSG))
2766
Charles-Francois Natalid66b10e2013-05-20 19:08:19 +02002767 @unittest.skipIf(sys.platform == "darwin", "skipping, see issue #12958")
Robert Collins43cbbe22015-08-03 10:36:04 +12002768 @unittest.skipIf(sys.platform.startswith("aix"), "skipping, see issue #22397")
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002769 @requireAttrs(socket, "CMSG_SPACE")
2770 def testFDPassSeparateMinSpace(self):
2771 # Pass two FDs in two separate arrays, receiving them into the
2772 # minimum space for two arrays.
2773 self.checkRecvmsgFDs(2,
2774 self.doRecvmsg(self.serv_sock, len(MSG),
2775 socket.CMSG_SPACE(SIZEOF_INT) +
2776 socket.CMSG_LEN(SIZEOF_INT)),
2777 maxcmsgs=2, ignoreflags=socket.MSG_CTRUNC)
2778
2779 @testFDPassSeparateMinSpace.client_skip
Charles-Francois Natalid66b10e2013-05-20 19:08:19 +02002780 @unittest.skipIf(sys.platform == "darwin", "skipping, see issue #12958")
Robert Collins43cbbe22015-08-03 10:36:04 +12002781 @unittest.skipIf(sys.platform.startswith("aix"), "skipping, see issue #22397")
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002782 def _testFDPassSeparateMinSpace(self):
2783 fd0, fd1 = self.newFDs(2)
2784 self.assertEqual(
2785 self.sendmsgToServer([MSG], [(socket.SOL_SOCKET,
2786 socket.SCM_RIGHTS,
2787 array.array("i", [fd0])),
2788 (socket.SOL_SOCKET,
2789 socket.SCM_RIGHTS,
2790 array.array("i", [fd1]))]),
2791 len(MSG))
2792
2793 def sendAncillaryIfPossible(self, msg, ancdata):
2794 # Try to send msg and ancdata to server, but if the system
2795 # call fails, just send msg with no ancillary data.
2796 try:
2797 nbytes = self.sendmsgToServer([msg], ancdata)
Andrew Svetlov0832af62012-12-18 23:10:48 +02002798 except OSError as e:
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002799 # Check that it was the system call that failed
2800 self.assertIsInstance(e.errno, int)
2801 nbytes = self.sendmsgToServer([msg])
2802 self.assertEqual(nbytes, len(msg))
2803
2804 def testFDPassEmpty(self):
2805 # Try to pass an empty FD array. Can receive either no array
2806 # or an empty array.
2807 self.checkRecvmsgFDs(0, self.doRecvmsg(self.serv_sock,
2808 len(MSG), 10240),
2809 ignoreflags=socket.MSG_CTRUNC)
2810
2811 def _testFDPassEmpty(self):
2812 self.sendAncillaryIfPossible(MSG, [(socket.SOL_SOCKET,
2813 socket.SCM_RIGHTS,
2814 b"")])
2815
2816 def testFDPassPartialInt(self):
2817 # Try to pass a truncated FD array.
2818 msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
2819 len(MSG), 10240)
2820 self.assertEqual(msg, MSG)
2821 self.checkRecvmsgAddress(addr, self.cli_addr)
2822 self.checkFlags(flags, eor=True, ignore=socket.MSG_CTRUNC)
2823 self.assertLessEqual(len(ancdata), 1)
2824 for cmsg_level, cmsg_type, cmsg_data in ancdata:
2825 self.assertEqual(cmsg_level, socket.SOL_SOCKET)
2826 self.assertEqual(cmsg_type, socket.SCM_RIGHTS)
2827 self.assertLess(len(cmsg_data), SIZEOF_INT)
2828
2829 def _testFDPassPartialInt(self):
2830 self.sendAncillaryIfPossible(
2831 MSG,
2832 [(socket.SOL_SOCKET,
2833 socket.SCM_RIGHTS,
Nadeem Vawda3d1706f2011-08-22 09:46:56 +02002834 array.array("i", [self.badfd]).tobytes()[:-1])])
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002835
2836 @requireAttrs(socket, "CMSG_SPACE")
2837 def testFDPassPartialIntInMiddle(self):
2838 # Try to pass two FD arrays, the first of which is truncated.
2839 msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
2840 len(MSG), 10240)
2841 self.assertEqual(msg, MSG)
2842 self.checkRecvmsgAddress(addr, self.cli_addr)
2843 self.checkFlags(flags, eor=True, ignore=socket.MSG_CTRUNC)
2844 self.assertLessEqual(len(ancdata), 2)
2845 fds = array.array("i")
2846 # Arrays may have been combined in a single control message
2847 for cmsg_level, cmsg_type, cmsg_data in ancdata:
2848 self.assertEqual(cmsg_level, socket.SOL_SOCKET)
2849 self.assertEqual(cmsg_type, socket.SCM_RIGHTS)
Nadeem Vawda3d1706f2011-08-22 09:46:56 +02002850 fds.frombytes(cmsg_data[:
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002851 len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])
2852 self.assertLessEqual(len(fds), 2)
2853 self.checkFDs(fds)
2854
2855 @testFDPassPartialIntInMiddle.client_skip
2856 def _testFDPassPartialIntInMiddle(self):
2857 fd0, fd1 = self.newFDs(2)
2858 self.sendAncillaryIfPossible(
2859 MSG,
2860 [(socket.SOL_SOCKET,
2861 socket.SCM_RIGHTS,
Nadeem Vawda3d1706f2011-08-22 09:46:56 +02002862 array.array("i", [fd0, self.badfd]).tobytes()[:-1]),
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002863 (socket.SOL_SOCKET,
2864 socket.SCM_RIGHTS,
2865 array.array("i", [fd1]))])
2866
2867 def checkTruncatedHeader(self, result, ignoreflags=0):
2868 # Check that no ancillary data items are returned when data is
2869 # truncated inside the cmsghdr structure.
2870 msg, ancdata, flags, addr = result
2871 self.assertEqual(msg, MSG)
2872 self.checkRecvmsgAddress(addr, self.cli_addr)
2873 self.assertEqual(ancdata, [])
2874 self.checkFlags(flags, eor=True, checkset=socket.MSG_CTRUNC,
2875 ignore=ignoreflags)
2876
2877 def testCmsgTruncNoBufSize(self):
2878 # Check that no ancillary data is received when no buffer size
2879 # is specified.
2880 self.checkTruncatedHeader(self.doRecvmsg(self.serv_sock, len(MSG)),
2881 # BSD seems to set MSG_CTRUNC only
2882 # if an item has been partially
2883 # received.
2884 ignoreflags=socket.MSG_CTRUNC)
2885
2886 def _testCmsgTruncNoBufSize(self):
2887 self.createAndSendFDs(1)
2888
2889 def testCmsgTrunc0(self):
2890 # Check that no ancillary data is received when buffer size is 0.
2891 self.checkTruncatedHeader(self.doRecvmsg(self.serv_sock, len(MSG), 0),
2892 ignoreflags=socket.MSG_CTRUNC)
2893
2894 def _testCmsgTrunc0(self):
2895 self.createAndSendFDs(1)
2896
2897 # Check that no ancillary data is returned for various non-zero
2898 # (but still too small) buffer sizes.
2899
2900 def testCmsgTrunc1(self):
2901 self.checkTruncatedHeader(self.doRecvmsg(self.serv_sock, len(MSG), 1))
2902
2903 def _testCmsgTrunc1(self):
2904 self.createAndSendFDs(1)
2905
2906 def testCmsgTrunc2Int(self):
2907 # The cmsghdr structure has at least three members, two of
2908 # which are ints, so we still shouldn't see any ancillary
2909 # data.
2910 self.checkTruncatedHeader(self.doRecvmsg(self.serv_sock, len(MSG),
2911 SIZEOF_INT * 2))
2912
2913 def _testCmsgTrunc2Int(self):
2914 self.createAndSendFDs(1)
2915
2916 def testCmsgTruncLen0Minus1(self):
2917 self.checkTruncatedHeader(self.doRecvmsg(self.serv_sock, len(MSG),
2918 socket.CMSG_LEN(0) - 1))
2919
2920 def _testCmsgTruncLen0Minus1(self):
2921 self.createAndSendFDs(1)
2922
2923 # The following tests try to truncate the control message in the
2924 # middle of the FD array.
2925
2926 def checkTruncatedArray(self, ancbuf, maxdata, mindata=0):
2927 # Check that file descriptor data is truncated to between
2928 # mindata and maxdata bytes when received with buffer size
2929 # ancbuf, and that any complete file descriptor numbers are
2930 # valid.
2931 msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
2932 len(MSG), ancbuf)
2933 self.assertEqual(msg, MSG)
2934 self.checkRecvmsgAddress(addr, self.cli_addr)
2935 self.checkFlags(flags, eor=True, checkset=socket.MSG_CTRUNC)
2936
2937 if mindata == 0 and ancdata == []:
2938 return
2939 self.assertEqual(len(ancdata), 1)
2940 cmsg_level, cmsg_type, cmsg_data = ancdata[0]
2941 self.assertEqual(cmsg_level, socket.SOL_SOCKET)
2942 self.assertEqual(cmsg_type, socket.SCM_RIGHTS)
2943 self.assertGreaterEqual(len(cmsg_data), mindata)
2944 self.assertLessEqual(len(cmsg_data), maxdata)
2945 fds = array.array("i")
Nadeem Vawda3d1706f2011-08-22 09:46:56 +02002946 fds.frombytes(cmsg_data[:
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002947 len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])
2948 self.checkFDs(fds)
2949
2950 def testCmsgTruncLen0(self):
2951 self.checkTruncatedArray(ancbuf=socket.CMSG_LEN(0), maxdata=0)
2952
2953 def _testCmsgTruncLen0(self):
2954 self.createAndSendFDs(1)
2955
2956 def testCmsgTruncLen0Plus1(self):
2957 self.checkTruncatedArray(ancbuf=socket.CMSG_LEN(0) + 1, maxdata=1)
2958
2959 def _testCmsgTruncLen0Plus1(self):
2960 self.createAndSendFDs(2)
2961
2962 def testCmsgTruncLen1(self):
2963 self.checkTruncatedArray(ancbuf=socket.CMSG_LEN(SIZEOF_INT),
2964 maxdata=SIZEOF_INT)
2965
2966 def _testCmsgTruncLen1(self):
2967 self.createAndSendFDs(2)
2968
2969 def testCmsgTruncLen2Minus1(self):
2970 self.checkTruncatedArray(ancbuf=socket.CMSG_LEN(2 * SIZEOF_INT) - 1,
2971 maxdata=(2 * SIZEOF_INT) - 1)
2972
2973 def _testCmsgTruncLen2Minus1(self):
2974 self.createAndSendFDs(2)
2975
2976
2977class RFC3542AncillaryTest(SendrecvmsgServerTimeoutBase):
2978 # Test sendmsg() and recvmsg[_into]() using the ancillary data
2979 # features of the RFC 3542 Advanced Sockets API for IPv6.
2980 # Currently we can only handle certain data items (e.g. traffic
2981 # class, hop limit, MTU discovery and fragmentation settings)
2982 # without resorting to unportable means such as the struct module,
2983 # but the tests here are aimed at testing the ancillary data
2984 # handling in sendmsg() and recvmsg() rather than the IPv6 API
2985 # itself.
2986
2987 # Test value to use when setting hop limit of packet
2988 hop_limit = 2
2989
2990 # Test value to use when setting traffic class of packet.
2991 # -1 means "use kernel default".
2992 traffic_class = -1
2993
2994 def ancillaryMapping(self, ancdata):
2995 # Given ancillary data list ancdata, return a mapping from
2996 # pairs (cmsg_level, cmsg_type) to corresponding cmsg_data.
2997 # Check that no (level, type) pair appears more than once.
2998 d = {}
2999 for cmsg_level, cmsg_type, cmsg_data in ancdata:
3000 self.assertNotIn((cmsg_level, cmsg_type), d)
3001 d[(cmsg_level, cmsg_type)] = cmsg_data
3002 return d
3003
3004 def checkHopLimit(self, ancbufsize, maxhop=255, ignoreflags=0):
3005 # Receive hop limit into ancbufsize bytes of ancillary data
3006 # space. Check that data is MSG, ancillary data is not
3007 # truncated (but ignore any flags in ignoreflags), and hop
3008 # limit is between 0 and maxhop inclusive.
3009 self.serv_sock.setsockopt(socket.IPPROTO_IPV6,
3010 socket.IPV6_RECVHOPLIMIT, 1)
3011 self.misc_event.set()
3012 msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
3013 len(MSG), ancbufsize)
3014
3015 self.assertEqual(msg, MSG)
3016 self.checkRecvmsgAddress(addr, self.cli_addr)
3017 self.checkFlags(flags, eor=True, checkunset=socket.MSG_CTRUNC,
3018 ignore=ignoreflags)
3019
3020 self.assertEqual(len(ancdata), 1)
3021 self.assertIsInstance(ancdata[0], tuple)
3022 cmsg_level, cmsg_type, cmsg_data = ancdata[0]
3023 self.assertEqual(cmsg_level, socket.IPPROTO_IPV6)
3024 self.assertEqual(cmsg_type, socket.IPV6_HOPLIMIT)
3025 self.assertIsInstance(cmsg_data, bytes)
3026 self.assertEqual(len(cmsg_data), SIZEOF_INT)
3027 a = array.array("i")
Nadeem Vawda3d1706f2011-08-22 09:46:56 +02003028 a.frombytes(cmsg_data)
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003029 self.assertGreaterEqual(a[0], 0)
3030 self.assertLessEqual(a[0], maxhop)
3031
3032 @requireAttrs(socket, "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT")
3033 def testRecvHopLimit(self):
3034 # Test receiving the packet hop limit as ancillary data.
3035 self.checkHopLimit(ancbufsize=10240)
3036
3037 @testRecvHopLimit.client_skip
3038 def _testRecvHopLimit(self):
3039 # Need to wait until server has asked to receive ancillary
3040 # data, as implementations are not required to buffer it
3041 # otherwise.
3042 self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
3043 self.sendToServer(MSG)
3044
3045 @requireAttrs(socket, "CMSG_SPACE", "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT")
3046 def testRecvHopLimitCMSG_SPACE(self):
3047 # Test receiving hop limit, using CMSG_SPACE to calculate buffer size.
3048 self.checkHopLimit(ancbufsize=socket.CMSG_SPACE(SIZEOF_INT))
3049
3050 @testRecvHopLimitCMSG_SPACE.client_skip
3051 def _testRecvHopLimitCMSG_SPACE(self):
3052 self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
3053 self.sendToServer(MSG)
3054
3055 # Could test receiving into buffer sized using CMSG_LEN, but RFC
3056 # 3542 says portable applications must provide space for trailing
3057 # padding. Implementations may set MSG_CTRUNC if there isn't
3058 # enough space for the padding.
3059
3060 @requireAttrs(socket.socket, "sendmsg")
3061 @requireAttrs(socket, "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT")
3062 def testSetHopLimit(self):
3063 # Test setting hop limit on outgoing packet and receiving it
3064 # at the other end.
3065 self.checkHopLimit(ancbufsize=10240, maxhop=self.hop_limit)
3066
3067 @testSetHopLimit.client_skip
3068 def _testSetHopLimit(self):
3069 self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
3070 self.assertEqual(
3071 self.sendmsgToServer([MSG],
3072 [(socket.IPPROTO_IPV6, socket.IPV6_HOPLIMIT,
3073 array.array("i", [self.hop_limit]))]),
3074 len(MSG))
3075
3076 def checkTrafficClassAndHopLimit(self, ancbufsize, maxhop=255,
3077 ignoreflags=0):
3078 # Receive traffic class and hop limit into ancbufsize bytes of
3079 # ancillary data space. Check that data is MSG, ancillary
3080 # data is not truncated (but ignore any flags in ignoreflags),
3081 # and traffic class and hop limit are in range (hop limit no
3082 # more than maxhop).
3083 self.serv_sock.setsockopt(socket.IPPROTO_IPV6,
3084 socket.IPV6_RECVHOPLIMIT, 1)
3085 self.serv_sock.setsockopt(socket.IPPROTO_IPV6,
3086 socket.IPV6_RECVTCLASS, 1)
3087 self.misc_event.set()
3088 msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
3089 len(MSG), ancbufsize)
3090
3091 self.assertEqual(msg, MSG)
3092 self.checkRecvmsgAddress(addr, self.cli_addr)
3093 self.checkFlags(flags, eor=True, checkunset=socket.MSG_CTRUNC,
3094 ignore=ignoreflags)
3095 self.assertEqual(len(ancdata), 2)
3096 ancmap = self.ancillaryMapping(ancdata)
3097
3098 tcdata = ancmap[(socket.IPPROTO_IPV6, socket.IPV6_TCLASS)]
3099 self.assertEqual(len(tcdata), SIZEOF_INT)
3100 a = array.array("i")
Nadeem Vawda3d1706f2011-08-22 09:46:56 +02003101 a.frombytes(tcdata)
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003102 self.assertGreaterEqual(a[0], 0)
3103 self.assertLessEqual(a[0], 255)
3104
3105 hldata = ancmap[(socket.IPPROTO_IPV6, socket.IPV6_HOPLIMIT)]
3106 self.assertEqual(len(hldata), SIZEOF_INT)
3107 a = array.array("i")
Nadeem Vawda3d1706f2011-08-22 09:46:56 +02003108 a.frombytes(hldata)
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003109 self.assertGreaterEqual(a[0], 0)
3110 self.assertLessEqual(a[0], maxhop)
3111
3112 @requireAttrs(socket, "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT",
3113 "IPV6_RECVTCLASS", "IPV6_TCLASS")
3114 def testRecvTrafficClassAndHopLimit(self):
3115 # Test receiving traffic class and hop limit as ancillary data.
3116 self.checkTrafficClassAndHopLimit(ancbufsize=10240)
3117
3118 @testRecvTrafficClassAndHopLimit.client_skip
3119 def _testRecvTrafficClassAndHopLimit(self):
3120 self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
3121 self.sendToServer(MSG)
3122
3123 @requireAttrs(socket, "CMSG_SPACE", "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT",
3124 "IPV6_RECVTCLASS", "IPV6_TCLASS")
3125 def testRecvTrafficClassAndHopLimitCMSG_SPACE(self):
3126 # Test receiving traffic class and hop limit, using
3127 # CMSG_SPACE() to calculate buffer size.
3128 self.checkTrafficClassAndHopLimit(
3129 ancbufsize=socket.CMSG_SPACE(SIZEOF_INT) * 2)
3130
3131 @testRecvTrafficClassAndHopLimitCMSG_SPACE.client_skip
3132 def _testRecvTrafficClassAndHopLimitCMSG_SPACE(self):
3133 self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
3134 self.sendToServer(MSG)
3135
3136 @requireAttrs(socket.socket, "sendmsg")
3137 @requireAttrs(socket, "CMSG_SPACE", "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT",
3138 "IPV6_RECVTCLASS", "IPV6_TCLASS")
3139 def testSetTrafficClassAndHopLimit(self):
3140 # Test setting traffic class and hop limit on outgoing packet,
3141 # and receiving them at the other end.
3142 self.checkTrafficClassAndHopLimit(ancbufsize=10240,
3143 maxhop=self.hop_limit)
3144
3145 @testSetTrafficClassAndHopLimit.client_skip
3146 def _testSetTrafficClassAndHopLimit(self):
3147 self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
3148 self.assertEqual(
3149 self.sendmsgToServer([MSG],
3150 [(socket.IPPROTO_IPV6, socket.IPV6_TCLASS,
3151 array.array("i", [self.traffic_class])),
3152 (socket.IPPROTO_IPV6, socket.IPV6_HOPLIMIT,
3153 array.array("i", [self.hop_limit]))]),
3154 len(MSG))
3155
3156 @requireAttrs(socket.socket, "sendmsg")
3157 @requireAttrs(socket, "CMSG_SPACE", "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT",
3158 "IPV6_RECVTCLASS", "IPV6_TCLASS")
3159 def testOddCmsgSize(self):
3160 # Try to send ancillary data with first item one byte too
3161 # long. Fall back to sending with correct size if this fails,
3162 # and check that second item was handled correctly.
3163 self.checkTrafficClassAndHopLimit(ancbufsize=10240,
3164 maxhop=self.hop_limit)
3165
3166 @testOddCmsgSize.client_skip
3167 def _testOddCmsgSize(self):
3168 self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
3169 try:
3170 nbytes = self.sendmsgToServer(
3171 [MSG],
3172 [(socket.IPPROTO_IPV6, socket.IPV6_TCLASS,
Nadeem Vawda3d1706f2011-08-22 09:46:56 +02003173 array.array("i", [self.traffic_class]).tobytes() + b"\x00"),
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003174 (socket.IPPROTO_IPV6, socket.IPV6_HOPLIMIT,
3175 array.array("i", [self.hop_limit]))])
Andrew Svetlov0832af62012-12-18 23:10:48 +02003176 except OSError as e:
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003177 self.assertIsInstance(e.errno, int)
3178 nbytes = self.sendmsgToServer(
3179 [MSG],
3180 [(socket.IPPROTO_IPV6, socket.IPV6_TCLASS,
3181 array.array("i", [self.traffic_class])),
3182 (socket.IPPROTO_IPV6, socket.IPV6_HOPLIMIT,
3183 array.array("i", [self.hop_limit]))])
3184 self.assertEqual(nbytes, len(MSG))
3185
3186 # Tests for proper handling of truncated ancillary data
3187
3188 def checkHopLimitTruncatedHeader(self, ancbufsize, ignoreflags=0):
3189 # Receive hop limit into ancbufsize bytes of ancillary data
3190 # space, which should be too small to contain the ancillary
3191 # data header (if ancbufsize is None, pass no second argument
3192 # to recvmsg()). Check that data is MSG, MSG_CTRUNC is set
3193 # (unless included in ignoreflags), and no ancillary data is
3194 # returned.
3195 self.serv_sock.setsockopt(socket.IPPROTO_IPV6,
3196 socket.IPV6_RECVHOPLIMIT, 1)
3197 self.misc_event.set()
3198 args = () if ancbufsize is None else (ancbufsize,)
3199 msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
3200 len(MSG), *args)
3201
3202 self.assertEqual(msg, MSG)
3203 self.checkRecvmsgAddress(addr, self.cli_addr)
3204 self.assertEqual(ancdata, [])
3205 self.checkFlags(flags, eor=True, checkset=socket.MSG_CTRUNC,
3206 ignore=ignoreflags)
3207
3208 @requireAttrs(socket, "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT")
3209 def testCmsgTruncNoBufSize(self):
3210 # Check that no ancillary data is received when no ancillary
3211 # buffer size is provided.
3212 self.checkHopLimitTruncatedHeader(ancbufsize=None,
3213 # BSD seems to set
3214 # MSG_CTRUNC only if an item
3215 # has been partially
3216 # received.
3217 ignoreflags=socket.MSG_CTRUNC)
3218
3219 @testCmsgTruncNoBufSize.client_skip
3220 def _testCmsgTruncNoBufSize(self):
3221 self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
3222 self.sendToServer(MSG)
3223
3224 @requireAttrs(socket, "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT")
3225 def testSingleCmsgTrunc0(self):
3226 # Check that no ancillary data is received when ancillary
3227 # buffer size is zero.
3228 self.checkHopLimitTruncatedHeader(ancbufsize=0,
3229 ignoreflags=socket.MSG_CTRUNC)
3230
3231 @testSingleCmsgTrunc0.client_skip
3232 def _testSingleCmsgTrunc0(self):
3233 self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
3234 self.sendToServer(MSG)
3235
3236 # Check that no ancillary data is returned for various non-zero
3237 # (but still too small) buffer sizes.
3238
3239 @requireAttrs(socket, "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT")
3240 def testSingleCmsgTrunc1(self):
3241 self.checkHopLimitTruncatedHeader(ancbufsize=1)
3242
3243 @testSingleCmsgTrunc1.client_skip
3244 def _testSingleCmsgTrunc1(self):
3245 self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
3246 self.sendToServer(MSG)
3247
3248 @requireAttrs(socket, "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT")
3249 def testSingleCmsgTrunc2Int(self):
3250 self.checkHopLimitTruncatedHeader(ancbufsize=2 * SIZEOF_INT)
3251
3252 @testSingleCmsgTrunc2Int.client_skip
3253 def _testSingleCmsgTrunc2Int(self):
3254 self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
3255 self.sendToServer(MSG)
3256
3257 @requireAttrs(socket, "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT")
3258 def testSingleCmsgTruncLen0Minus1(self):
3259 self.checkHopLimitTruncatedHeader(ancbufsize=socket.CMSG_LEN(0) - 1)
3260
3261 @testSingleCmsgTruncLen0Minus1.client_skip
3262 def _testSingleCmsgTruncLen0Minus1(self):
3263 self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
3264 self.sendToServer(MSG)
3265
3266 @requireAttrs(socket, "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT")
3267 def testSingleCmsgTruncInData(self):
3268 # Test truncation of a control message inside its associated
3269 # data. The message may be returned with its data truncated,
3270 # or not returned at all.
3271 self.serv_sock.setsockopt(socket.IPPROTO_IPV6,
3272 socket.IPV6_RECVHOPLIMIT, 1)
3273 self.misc_event.set()
3274 msg, ancdata, flags, addr = self.doRecvmsg(
3275 self.serv_sock, len(MSG), socket.CMSG_LEN(SIZEOF_INT) - 1)
3276
3277 self.assertEqual(msg, MSG)
3278 self.checkRecvmsgAddress(addr, self.cli_addr)
3279 self.checkFlags(flags, eor=True, checkset=socket.MSG_CTRUNC)
3280
3281 self.assertLessEqual(len(ancdata), 1)
3282 if ancdata:
3283 cmsg_level, cmsg_type, cmsg_data = ancdata[0]
3284 self.assertEqual(cmsg_level, socket.IPPROTO_IPV6)
3285 self.assertEqual(cmsg_type, socket.IPV6_HOPLIMIT)
3286 self.assertLess(len(cmsg_data), SIZEOF_INT)
3287
3288 @testSingleCmsgTruncInData.client_skip
3289 def _testSingleCmsgTruncInData(self):
3290 self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
3291 self.sendToServer(MSG)
3292
3293 def checkTruncatedSecondHeader(self, ancbufsize, ignoreflags=0):
3294 # Receive traffic class and hop limit into ancbufsize bytes of
3295 # ancillary data space, which should be large enough to
3296 # contain the first item, but too small to contain the header
3297 # of the second. Check that data is MSG, MSG_CTRUNC is set
3298 # (unless included in ignoreflags), and only one ancillary
3299 # data item is returned.
3300 self.serv_sock.setsockopt(socket.IPPROTO_IPV6,
3301 socket.IPV6_RECVHOPLIMIT, 1)
3302 self.serv_sock.setsockopt(socket.IPPROTO_IPV6,
3303 socket.IPV6_RECVTCLASS, 1)
3304 self.misc_event.set()
3305 msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
3306 len(MSG), ancbufsize)
3307
3308 self.assertEqual(msg, MSG)
3309 self.checkRecvmsgAddress(addr, self.cli_addr)
3310 self.checkFlags(flags, eor=True, checkset=socket.MSG_CTRUNC,
3311 ignore=ignoreflags)
3312
3313 self.assertEqual(len(ancdata), 1)
3314 cmsg_level, cmsg_type, cmsg_data = ancdata[0]
3315 self.assertEqual(cmsg_level, socket.IPPROTO_IPV6)
3316 self.assertIn(cmsg_type, {socket.IPV6_TCLASS, socket.IPV6_HOPLIMIT})
3317 self.assertEqual(len(cmsg_data), SIZEOF_INT)
3318 a = array.array("i")
Nadeem Vawda3d1706f2011-08-22 09:46:56 +02003319 a.frombytes(cmsg_data)
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003320 self.assertGreaterEqual(a[0], 0)
3321 self.assertLessEqual(a[0], 255)
3322
3323 # Try the above test with various buffer sizes.
3324
3325 @requireAttrs(socket, "CMSG_SPACE", "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT",
3326 "IPV6_RECVTCLASS", "IPV6_TCLASS")
3327 def testSecondCmsgTrunc0(self):
3328 self.checkTruncatedSecondHeader(socket.CMSG_SPACE(SIZEOF_INT),
3329 ignoreflags=socket.MSG_CTRUNC)
3330
3331 @testSecondCmsgTrunc0.client_skip
3332 def _testSecondCmsgTrunc0(self):
3333 self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
3334 self.sendToServer(MSG)
3335
3336 @requireAttrs(socket, "CMSG_SPACE", "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT",
3337 "IPV6_RECVTCLASS", "IPV6_TCLASS")
3338 def testSecondCmsgTrunc1(self):
3339 self.checkTruncatedSecondHeader(socket.CMSG_SPACE(SIZEOF_INT) + 1)
3340
3341 @testSecondCmsgTrunc1.client_skip
3342 def _testSecondCmsgTrunc1(self):
3343 self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
3344 self.sendToServer(MSG)
3345
3346 @requireAttrs(socket, "CMSG_SPACE", "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT",
3347 "IPV6_RECVTCLASS", "IPV6_TCLASS")
3348 def testSecondCmsgTrunc2Int(self):
3349 self.checkTruncatedSecondHeader(socket.CMSG_SPACE(SIZEOF_INT) +
3350 2 * SIZEOF_INT)
3351
3352 @testSecondCmsgTrunc2Int.client_skip
3353 def _testSecondCmsgTrunc2Int(self):
3354 self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
3355 self.sendToServer(MSG)
3356
3357 @requireAttrs(socket, "CMSG_SPACE", "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT",
3358 "IPV6_RECVTCLASS", "IPV6_TCLASS")
3359 def testSecondCmsgTruncLen0Minus1(self):
3360 self.checkTruncatedSecondHeader(socket.CMSG_SPACE(SIZEOF_INT) +
3361 socket.CMSG_LEN(0) - 1)
3362
3363 @testSecondCmsgTruncLen0Minus1.client_skip
3364 def _testSecondCmsgTruncLen0Minus1(self):
3365 self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
3366 self.sendToServer(MSG)
3367
3368 @requireAttrs(socket, "CMSG_SPACE", "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT",
3369 "IPV6_RECVTCLASS", "IPV6_TCLASS")
3370 def testSecomdCmsgTruncInData(self):
3371 # Test truncation of the second of two control messages inside
3372 # its associated data.
3373 self.serv_sock.setsockopt(socket.IPPROTO_IPV6,
3374 socket.IPV6_RECVHOPLIMIT, 1)
3375 self.serv_sock.setsockopt(socket.IPPROTO_IPV6,
3376 socket.IPV6_RECVTCLASS, 1)
3377 self.misc_event.set()
3378 msg, ancdata, flags, addr = self.doRecvmsg(
3379 self.serv_sock, len(MSG),
3380 socket.CMSG_SPACE(SIZEOF_INT) + socket.CMSG_LEN(SIZEOF_INT) - 1)
3381
3382 self.assertEqual(msg, MSG)
3383 self.checkRecvmsgAddress(addr, self.cli_addr)
3384 self.checkFlags(flags, eor=True, checkset=socket.MSG_CTRUNC)
3385
3386 cmsg_types = {socket.IPV6_TCLASS, socket.IPV6_HOPLIMIT}
3387
3388 cmsg_level, cmsg_type, cmsg_data = ancdata.pop(0)
3389 self.assertEqual(cmsg_level, socket.IPPROTO_IPV6)
3390 cmsg_types.remove(cmsg_type)
3391 self.assertEqual(len(cmsg_data), SIZEOF_INT)
3392 a = array.array("i")
Nadeem Vawda3d1706f2011-08-22 09:46:56 +02003393 a.frombytes(cmsg_data)
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003394 self.assertGreaterEqual(a[0], 0)
3395 self.assertLessEqual(a[0], 255)
3396
3397 if ancdata:
3398 cmsg_level, cmsg_type, cmsg_data = ancdata.pop(0)
3399 self.assertEqual(cmsg_level, socket.IPPROTO_IPV6)
3400 cmsg_types.remove(cmsg_type)
3401 self.assertLess(len(cmsg_data), SIZEOF_INT)
3402
3403 self.assertEqual(ancdata, [])
3404
3405 @testSecomdCmsgTruncInData.client_skip
3406 def _testSecomdCmsgTruncInData(self):
3407 self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
3408 self.sendToServer(MSG)
3409
3410
3411# Derive concrete test classes for different socket types.
3412
3413class SendrecvmsgUDPTestBase(SendrecvmsgDgramFlagsBase,
3414 SendrecvmsgConnectionlessBase,
3415 ThreadedSocketTestMixin, UDPTestBase):
3416 pass
3417
3418@requireAttrs(socket.socket, "sendmsg")
3419@unittest.skipUnless(thread, 'Threading required for this test.')
3420class SendmsgUDPTest(SendmsgConnectionlessTests, SendrecvmsgUDPTestBase):
3421 pass
3422
3423@requireAttrs(socket.socket, "recvmsg")
3424@unittest.skipUnless(thread, 'Threading required for this test.')
3425class RecvmsgUDPTest(RecvmsgTests, SendrecvmsgUDPTestBase):
3426 pass
3427
3428@requireAttrs(socket.socket, "recvmsg_into")
3429@unittest.skipUnless(thread, 'Threading required for this test.')
3430class RecvmsgIntoUDPTest(RecvmsgIntoTests, SendrecvmsgUDPTestBase):
3431 pass
3432
3433
3434class SendrecvmsgUDP6TestBase(SendrecvmsgDgramFlagsBase,
3435 SendrecvmsgConnectionlessBase,
3436 ThreadedSocketTestMixin, UDP6TestBase):
Charles-François Natali37114bb2013-07-09 19:15:43 +02003437
3438 def checkRecvmsgAddress(self, addr1, addr2):
3439 # Called to compare the received address with the address of
3440 # the peer, ignoring scope ID
3441 self.assertEqual(addr1[:-1], addr2[:-1])
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003442
3443@requireAttrs(socket.socket, "sendmsg")
Ross Lagerwall8d459f02012-07-08 09:53:57 +02003444@unittest.skipUnless(support.IPV6_ENABLED, 'IPv6 required for this test.')
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003445@requireSocket("AF_INET6", "SOCK_DGRAM")
3446@unittest.skipUnless(thread, 'Threading required for this test.')
3447class SendmsgUDP6Test(SendmsgConnectionlessTests, SendrecvmsgUDP6TestBase):
3448 pass
3449
3450@requireAttrs(socket.socket, "recvmsg")
Ross Lagerwall8d459f02012-07-08 09:53:57 +02003451@unittest.skipUnless(support.IPV6_ENABLED, 'IPv6 required for this test.')
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003452@requireSocket("AF_INET6", "SOCK_DGRAM")
3453@unittest.skipUnless(thread, 'Threading required for this test.')
3454class RecvmsgUDP6Test(RecvmsgTests, SendrecvmsgUDP6TestBase):
3455 pass
3456
3457@requireAttrs(socket.socket, "recvmsg_into")
Ross Lagerwall8d459f02012-07-08 09:53:57 +02003458@unittest.skipUnless(support.IPV6_ENABLED, 'IPv6 required for this test.')
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003459@requireSocket("AF_INET6", "SOCK_DGRAM")
3460@unittest.skipUnless(thread, 'Threading required for this test.')
3461class RecvmsgIntoUDP6Test(RecvmsgIntoTests, SendrecvmsgUDP6TestBase):
3462 pass
3463
3464@requireAttrs(socket.socket, "recvmsg")
Ross Lagerwall8d459f02012-07-08 09:53:57 +02003465@unittest.skipUnless(support.IPV6_ENABLED, 'IPv6 required for this test.')
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003466@requireAttrs(socket, "IPPROTO_IPV6")
3467@requireSocket("AF_INET6", "SOCK_DGRAM")
3468@unittest.skipUnless(thread, 'Threading required for this test.')
3469class RecvmsgRFC3542AncillaryUDP6Test(RFC3542AncillaryTest,
3470 SendrecvmsgUDP6TestBase):
3471 pass
3472
3473@requireAttrs(socket.socket, "recvmsg_into")
Ross Lagerwall8d459f02012-07-08 09:53:57 +02003474@unittest.skipUnless(support.IPV6_ENABLED, 'IPv6 required for this test.')
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003475@requireAttrs(socket, "IPPROTO_IPV6")
3476@requireSocket("AF_INET6", "SOCK_DGRAM")
3477@unittest.skipUnless(thread, 'Threading required for this test.')
3478class RecvmsgIntoRFC3542AncillaryUDP6Test(RecvmsgIntoMixin,
3479 RFC3542AncillaryTest,
3480 SendrecvmsgUDP6TestBase):
3481 pass
3482
3483
3484class SendrecvmsgTCPTestBase(SendrecvmsgConnectedBase,
3485 ConnectedStreamTestMixin, TCPTestBase):
3486 pass
3487
3488@requireAttrs(socket.socket, "sendmsg")
3489@unittest.skipUnless(thread, 'Threading required for this test.')
3490class SendmsgTCPTest(SendmsgStreamTests, SendrecvmsgTCPTestBase):
3491 pass
3492
3493@requireAttrs(socket.socket, "recvmsg")
3494@unittest.skipUnless(thread, 'Threading required for this test.')
3495class RecvmsgTCPTest(RecvmsgTests, RecvmsgGenericStreamTests,
3496 SendrecvmsgTCPTestBase):
3497 pass
3498
3499@requireAttrs(socket.socket, "recvmsg_into")
3500@unittest.skipUnless(thread, 'Threading required for this test.')
3501class RecvmsgIntoTCPTest(RecvmsgIntoTests, RecvmsgGenericStreamTests,
3502 SendrecvmsgTCPTestBase):
3503 pass
3504
3505
3506class SendrecvmsgSCTPStreamTestBase(SendrecvmsgSCTPFlagsBase,
3507 SendrecvmsgConnectedBase,
3508 ConnectedStreamTestMixin, SCTPStreamBase):
3509 pass
3510
3511@requireAttrs(socket.socket, "sendmsg")
3512@requireSocket("AF_INET", "SOCK_STREAM", "IPPROTO_SCTP")
3513@unittest.skipUnless(thread, 'Threading required for this test.')
3514class SendmsgSCTPStreamTest(SendmsgStreamTests, SendrecvmsgSCTPStreamTestBase):
3515 pass
3516
3517@requireAttrs(socket.socket, "recvmsg")
3518@requireSocket("AF_INET", "SOCK_STREAM", "IPPROTO_SCTP")
3519@unittest.skipUnless(thread, 'Threading required for this test.')
3520class RecvmsgSCTPStreamTest(RecvmsgTests, RecvmsgGenericStreamTests,
3521 SendrecvmsgSCTPStreamTestBase):
Antoine Pitrou92f8b002012-12-16 16:40:04 +01003522
3523 def testRecvmsgEOF(self):
3524 try:
3525 super(RecvmsgSCTPStreamTest, self).testRecvmsgEOF()
3526 except OSError as e:
3527 if e.errno != errno.ENOTCONN:
3528 raise
3529 self.skipTest("sporadic ENOTCONN (kernel issue?) - see issue #13876")
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003530
3531@requireAttrs(socket.socket, "recvmsg_into")
3532@requireSocket("AF_INET", "SOCK_STREAM", "IPPROTO_SCTP")
3533@unittest.skipUnless(thread, 'Threading required for this test.')
3534class RecvmsgIntoSCTPStreamTest(RecvmsgIntoTests, RecvmsgGenericStreamTests,
3535 SendrecvmsgSCTPStreamTestBase):
Antoine Pitroud5a070f2012-12-18 23:44:36 +01003536
3537 def testRecvmsgEOF(self):
3538 try:
3539 super(RecvmsgIntoSCTPStreamTest, self).testRecvmsgEOF()
3540 except OSError as e:
3541 if e.errno != errno.ENOTCONN:
3542 raise
3543 self.skipTest("sporadic ENOTCONN (kernel issue?) - see issue #13876")
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003544
3545
3546class SendrecvmsgUnixStreamTestBase(SendrecvmsgConnectedBase,
3547 ConnectedStreamTestMixin, UnixStreamBase):
3548 pass
3549
3550@requireAttrs(socket.socket, "sendmsg")
3551@requireAttrs(socket, "AF_UNIX")
3552@unittest.skipUnless(thread, 'Threading required for this test.')
3553class SendmsgUnixStreamTest(SendmsgStreamTests, SendrecvmsgUnixStreamTestBase):
3554 pass
3555
3556@requireAttrs(socket.socket, "recvmsg")
3557@requireAttrs(socket, "AF_UNIX")
3558@unittest.skipUnless(thread, 'Threading required for this test.')
3559class RecvmsgUnixStreamTest(RecvmsgTests, RecvmsgGenericStreamTests,
3560 SendrecvmsgUnixStreamTestBase):
3561 pass
3562
3563@requireAttrs(socket.socket, "recvmsg_into")
3564@requireAttrs(socket, "AF_UNIX")
3565@unittest.skipUnless(thread, 'Threading required for this test.')
3566class RecvmsgIntoUnixStreamTest(RecvmsgIntoTests, RecvmsgGenericStreamTests,
3567 SendrecvmsgUnixStreamTestBase):
3568 pass
3569
3570@requireAttrs(socket.socket, "sendmsg", "recvmsg")
3571@requireAttrs(socket, "AF_UNIX", "SOL_SOCKET", "SCM_RIGHTS")
3572@unittest.skipUnless(thread, 'Threading required for this test.')
3573class RecvmsgSCMRightsStreamTest(SCMRightsTest, SendrecvmsgUnixStreamTestBase):
3574 pass
3575
3576@requireAttrs(socket.socket, "sendmsg", "recvmsg_into")
3577@requireAttrs(socket, "AF_UNIX", "SOL_SOCKET", "SCM_RIGHTS")
3578@unittest.skipUnless(thread, 'Threading required for this test.')
3579class RecvmsgIntoSCMRightsStreamTest(RecvmsgIntoMixin, SCMRightsTest,
3580 SendrecvmsgUnixStreamTestBase):
3581 pass
3582
3583
3584# Test interrupting the interruptible send/receive methods with a
3585# signal when a timeout is set. These tests avoid having multiple
3586# threads alive during the test so that the OS cannot deliver the
3587# signal to the wrong one.
3588
3589class InterruptedTimeoutBase(unittest.TestCase):
3590 # Base class for interrupted send/receive tests. Installs an
3591 # empty handler for SIGALRM and removes it on teardown, along with
3592 # any scheduled alarms.
3593
3594 def setUp(self):
3595 super().setUp()
3596 orig_alrm_handler = signal.signal(signal.SIGALRM,
3597 lambda signum, frame: None)
3598 self.addCleanup(signal.signal, signal.SIGALRM, orig_alrm_handler)
3599 self.addCleanup(self.setAlarm, 0)
3600
3601 # Timeout for socket operations
3602 timeout = 4.0
3603
3604 # Provide setAlarm() method to schedule delivery of SIGALRM after
3605 # given number of seconds, or cancel it if zero, and an
3606 # appropriate time value to use. Use setitimer() if available.
3607 if hasattr(signal, "setitimer"):
3608 alarm_time = 0.05
3609
3610 def setAlarm(self, seconds):
3611 signal.setitimer(signal.ITIMER_REAL, seconds)
3612 else:
3613 # Old systems may deliver the alarm up to one second early
3614 alarm_time = 2
3615
3616 def setAlarm(self, seconds):
3617 signal.alarm(seconds)
3618
3619
3620# Require siginterrupt() in order to ensure that system calls are
3621# interrupted by default.
3622@requireAttrs(signal, "siginterrupt")
3623@unittest.skipUnless(hasattr(signal, "alarm") or hasattr(signal, "setitimer"),
3624 "Don't have signal.alarm or signal.setitimer")
3625class InterruptedRecvTimeoutTest(InterruptedTimeoutBase, UDPTestBase):
3626 # Test interrupting the recv*() methods with signals when a
3627 # timeout is set.
3628
3629 def setUp(self):
3630 super().setUp()
3631 self.serv.settimeout(self.timeout)
3632
3633 def checkInterruptedRecv(self, func, *args, **kwargs):
Andrew Svetlov0832af62012-12-18 23:10:48 +02003634 # Check that func(*args, **kwargs) raises OSError with an
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003635 # errno of EINTR when interrupted by a signal.
3636 self.setAlarm(self.alarm_time)
Andrew Svetlov0832af62012-12-18 23:10:48 +02003637 with self.assertRaises(OSError) as cm:
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003638 func(*args, **kwargs)
3639 self.assertNotIsInstance(cm.exception, socket.timeout)
3640 self.assertEqual(cm.exception.errno, errno.EINTR)
3641
3642 def testInterruptedRecvTimeout(self):
3643 self.checkInterruptedRecv(self.serv.recv, 1024)
3644
3645 def testInterruptedRecvIntoTimeout(self):
3646 self.checkInterruptedRecv(self.serv.recv_into, bytearray(1024))
3647
3648 def testInterruptedRecvfromTimeout(self):
3649 self.checkInterruptedRecv(self.serv.recvfrom, 1024)
3650
3651 def testInterruptedRecvfromIntoTimeout(self):
3652 self.checkInterruptedRecv(self.serv.recvfrom_into, bytearray(1024))
3653
3654 @requireAttrs(socket.socket, "recvmsg")
3655 def testInterruptedRecvmsgTimeout(self):
3656 self.checkInterruptedRecv(self.serv.recvmsg, 1024)
3657
3658 @requireAttrs(socket.socket, "recvmsg_into")
3659 def testInterruptedRecvmsgIntoTimeout(self):
3660 self.checkInterruptedRecv(self.serv.recvmsg_into, [bytearray(1024)])
3661
3662
3663# Require siginterrupt() in order to ensure that system calls are
3664# interrupted by default.
3665@requireAttrs(signal, "siginterrupt")
3666@unittest.skipUnless(hasattr(signal, "alarm") or hasattr(signal, "setitimer"),
3667 "Don't have signal.alarm or signal.setitimer")
3668@unittest.skipUnless(thread, 'Threading required for this test.')
3669class InterruptedSendTimeoutTest(InterruptedTimeoutBase,
3670 ThreadSafeCleanupTestCase,
3671 SocketListeningTestMixin, TCPTestBase):
3672 # Test interrupting the interruptible send*() methods with signals
3673 # when a timeout is set.
3674
3675 def setUp(self):
3676 super().setUp()
3677 self.serv_conn = self.newSocket()
3678 self.addCleanup(self.serv_conn.close)
3679 # Use a thread to complete the connection, but wait for it to
3680 # terminate before running the test, so that there is only one
3681 # thread to accept the signal.
3682 cli_thread = threading.Thread(target=self.doConnect)
3683 cli_thread.start()
3684 self.cli_conn, addr = self.serv.accept()
3685 self.addCleanup(self.cli_conn.close)
3686 cli_thread.join()
3687 self.serv_conn.settimeout(self.timeout)
3688
3689 def doConnect(self):
3690 self.serv_conn.connect(self.serv_addr)
3691
3692 def checkInterruptedSend(self, func, *args, **kwargs):
3693 # Check that func(*args, **kwargs), run in a loop, raises
Andrew Svetlov0832af62012-12-18 23:10:48 +02003694 # OSError with an errno of EINTR when interrupted by a
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003695 # signal.
Andrew Svetlov0832af62012-12-18 23:10:48 +02003696 with self.assertRaises(OSError) as cm:
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003697 while True:
3698 self.setAlarm(self.alarm_time)
3699 func(*args, **kwargs)
3700 self.assertNotIsInstance(cm.exception, socket.timeout)
3701 self.assertEqual(cm.exception.errno, errno.EINTR)
3702
Ned Deilyc5640382014-02-03 13:58:31 -08003703 # Issue #12958: The following tests have problems on OS X prior to 10.7
3704 @support.requires_mac_ver(10, 7)
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003705 def testInterruptedSendTimeout(self):
3706 self.checkInterruptedSend(self.serv_conn.send, b"a"*512)
3707
Ned Deilyc5640382014-02-03 13:58:31 -08003708 @support.requires_mac_ver(10, 7)
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003709 def testInterruptedSendtoTimeout(self):
3710 # Passing an actual address here as Python's wrapper for
3711 # sendto() doesn't allow passing a zero-length one; POSIX
3712 # requires that the address is ignored since the socket is
3713 # connection-mode, however.
3714 self.checkInterruptedSend(self.serv_conn.sendto, b"a"*512,
3715 self.serv_addr)
3716
Ned Deilyc5640382014-02-03 13:58:31 -08003717 @support.requires_mac_ver(10, 7)
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003718 @requireAttrs(socket.socket, "sendmsg")
3719 def testInterruptedSendmsgTimeout(self):
3720 self.checkInterruptedSend(self.serv_conn.sendmsg, [b"a"*512])
3721
3722
Victor Stinner45df8202010-04-28 22:31:17 +00003723@unittest.skipUnless(thread, 'Threading required for this test.')
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003724class TCPCloserTest(ThreadedTCPSocketTest):
3725
3726 def testClose(self):
3727 conn, addr = self.serv.accept()
3728 conn.close()
3729
3730 sd = self.cli
3731 read, write, err = select.select([sd], [], [], 1.0)
3732 self.assertEqual(read, [sd])
Guido van Rossum7d0a8262007-05-21 23:13:11 +00003733 self.assertEqual(sd.recv(1), b'')
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003734
Jeremy Hylton5accbdb2007-08-03 20:40:09 +00003735 # Calling close() many times should be safe.
3736 conn.close()
3737 conn.close()
3738
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003739 def _testClose(self):
Christian Heimes5e696852008-04-09 08:37:03 +00003740 self.cli.connect((HOST, self.port))
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003741 time.sleep(1.0)
3742
Serhiy Storchaka43767632013-11-03 21:31:38 +02003743@unittest.skipUnless(hasattr(socket, 'socketpair'),
3744 'test needs socket.socketpair()')
Victor Stinner45df8202010-04-28 22:31:17 +00003745@unittest.skipUnless(thread, 'Threading required for this test.')
Dave Cole331708b2004-08-09 04:51:41 +00003746class BasicSocketPairTest(SocketPairTest):
3747
3748 def __init__(self, methodName='runTest'):
3749 SocketPairTest.__init__(self, methodName=methodName)
3750
Antoine Pitrou2e55fec2010-09-14 21:24:25 +00003751 def _check_defaults(self, sock):
3752 self.assertIsInstance(sock, socket.socket)
3753 if hasattr(socket, 'AF_UNIX'):
3754 self.assertEqual(sock.family, socket.AF_UNIX)
3755 else:
3756 self.assertEqual(sock.family, socket.AF_INET)
3757 self.assertEqual(sock.type, socket.SOCK_STREAM)
3758 self.assertEqual(sock.proto, 0)
3759
Antoine Pitrou9e0b8642010-09-14 18:00:02 +00003760 def _testDefaults(self):
Antoine Pitrou2e55fec2010-09-14 21:24:25 +00003761 self._check_defaults(self.cli)
Antoine Pitrou9e0b8642010-09-14 18:00:02 +00003762
3763 def testDefaults(self):
Antoine Pitrou2e55fec2010-09-14 21:24:25 +00003764 self._check_defaults(self.serv)
Antoine Pitrou9e0b8642010-09-14 18:00:02 +00003765
Dave Cole331708b2004-08-09 04:51:41 +00003766 def testRecv(self):
3767 msg = self.serv.recv(1024)
3768 self.assertEqual(msg, MSG)
3769
3770 def _testRecv(self):
3771 self.cli.send(MSG)
3772
3773 def testSend(self):
3774 self.serv.send(MSG)
3775
3776 def _testSend(self):
3777 msg = self.cli.recv(1024)
3778 self.assertEqual(msg, MSG)
3779
Victor Stinner45df8202010-04-28 22:31:17 +00003780@unittest.skipUnless(thread, 'Threading required for this test.')
Guido van Rossum24e4af82002-06-12 19:18:08 +00003781class NonBlockingTCPTests(ThreadedTCPSocketTest):
3782
3783 def __init__(self, methodName='runTest'):
3784 ThreadedTCPSocketTest.__init__(self, methodName=methodName)
3785
3786 def testSetBlocking(self):
Guido van Rossum8c943832002-08-08 01:00:28 +00003787 # Testing whether set blocking works
Serhiy Storchaka45cb7f62013-01-15 11:08:30 +02003788 self.serv.setblocking(True)
3789 self.assertIsNone(self.serv.gettimeout())
3790 self.serv.setblocking(False)
3791 self.assertEqual(self.serv.gettimeout(), 0.0)
Guido van Rossum24e4af82002-06-12 19:18:08 +00003792 start = time.time()
3793 try:
3794 self.serv.accept()
Andrew Svetlov0832af62012-12-18 23:10:48 +02003795 except OSError:
Guido van Rossum24e4af82002-06-12 19:18:08 +00003796 pass
3797 end = time.time()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00003798 self.assertTrue((end - start) < 1.0, "Error setting non-blocking mode.")
Guido van Rossum24e4af82002-06-12 19:18:08 +00003799
3800 def _testSetBlocking(self):
Barry Warsaw6870bba2001-03-23 17:40:16 +00003801 pass
Barry Warsawcf3d4b51997-01-03 20:03:32 +00003802
Serhiy Storchaka5cfc79d2014-02-07 10:06:39 +02003803 @support.cpython_only
3804 def testSetBlocking_overflow(self):
3805 # Issue 15989
3806 import _testcapi
3807 if _testcapi.UINT_MAX >= _testcapi.ULONG_MAX:
3808 self.skipTest('needs UINT_MAX < ULONG_MAX')
3809 self.serv.setblocking(False)
3810 self.assertEqual(self.serv.gettimeout(), 0.0)
3811 self.serv.setblocking(_testcapi.UINT_MAX + 1)
3812 self.assertIsNone(self.serv.gettimeout())
3813
3814 _testSetBlocking_overflow = support.cpython_only(_testSetBlocking)
3815
Serhiy Storchaka43767632013-11-03 21:31:38 +02003816 @unittest.skipUnless(hasattr(socket, 'SOCK_NONBLOCK'),
3817 'test needs socket.SOCK_NONBLOCK')
3818 @support.requires_linux_version(2, 6, 28)
3819 def testInitNonBlocking(self):
3820 # reinit server socket
3821 self.serv.close()
3822 self.serv = socket.socket(socket.AF_INET, socket.SOCK_STREAM |
3823 socket.SOCK_NONBLOCK)
3824 self.port = support.bind_port(self.serv)
3825 self.serv.listen(1)
3826 # actual testing
3827 start = time.time()
3828 try:
3829 self.serv.accept()
3830 except OSError:
Antoine Pitroub1c54962010-10-14 15:05:38 +00003831 pass
Serhiy Storchaka43767632013-11-03 21:31:38 +02003832 end = time.time()
3833 self.assertTrue((end - start) < 1.0, "Error creating with non-blocking mode.")
3834
3835 def _testInitNonBlocking(self):
3836 pass
Antoine Pitroub1c54962010-10-14 15:05:38 +00003837
Antoine Pitrou600232b2011-01-05 21:03:42 +00003838 def testInheritFlags(self):
3839 # Issue #7995: when calling accept() on a listening socket with a
3840 # timeout, the resulting socket should not be non-blocking.
3841 self.serv.settimeout(10)
3842 try:
3843 conn, addr = self.serv.accept()
3844 message = conn.recv(len(MSG))
3845 finally:
3846 conn.close()
3847 self.serv.settimeout(None)
3848
3849 def _testInheritFlags(self):
3850 time.sleep(0.1)
3851 self.cli.connect((HOST, self.port))
3852 time.sleep(0.5)
3853 self.cli.send(MSG)
3854
Guido van Rossum24e4af82002-06-12 19:18:08 +00003855 def testAccept(self):
Guido van Rossum8c943832002-08-08 01:00:28 +00003856 # Testing non-blocking accept
Guido van Rossum24e4af82002-06-12 19:18:08 +00003857 self.serv.setblocking(0)
Guido van Rossum41360a41998-03-26 19:42:58 +00003858 try:
Guido van Rossum24e4af82002-06-12 19:18:08 +00003859 conn, addr = self.serv.accept()
Andrew Svetlov0832af62012-12-18 23:10:48 +02003860 except OSError:
Guido van Rossum24e4af82002-06-12 19:18:08 +00003861 pass
3862 else:
3863 self.fail("Error trying to do non-blocking accept.")
3864 read, write, err = select.select([self.serv], [], [])
3865 if self.serv in read:
3866 conn, addr = self.serv.accept()
Brian Curtin21ebbb72010-11-02 02:07:09 +00003867 conn.close()
Guido van Rossum24e4af82002-06-12 19:18:08 +00003868 else:
3869 self.fail("Error trying to do accept after select.")
Guido van Rossum67f7a382002-06-06 21:08:16 +00003870
Guido van Rossum24e4af82002-06-12 19:18:08 +00003871 def _testAccept(self):
Guido van Rossumb6cc7d22002-07-19 12:46:46 +00003872 time.sleep(0.1)
Christian Heimes5e696852008-04-09 08:37:03 +00003873 self.cli.connect((HOST, self.port))
Guido van Rossum24e4af82002-06-12 19:18:08 +00003874
3875 def testConnect(self):
Guido van Rossum8c943832002-08-08 01:00:28 +00003876 # Testing non-blocking connect
Guido van Rossum24e4af82002-06-12 19:18:08 +00003877 conn, addr = self.serv.accept()
Brian Curtin21ebbb72010-11-02 02:07:09 +00003878 conn.close()
Guido van Rossum24e4af82002-06-12 19:18:08 +00003879
3880 def _testConnect(self):
Guido van Rossum7b8bac12002-06-13 16:07:04 +00003881 self.cli.settimeout(10)
Christian Heimes5e696852008-04-09 08:37:03 +00003882 self.cli.connect((HOST, self.port))
Guido van Rossum24e4af82002-06-12 19:18:08 +00003883
3884 def testRecv(self):
Guido van Rossum8c943832002-08-08 01:00:28 +00003885 # Testing non-blocking recv
Guido van Rossum24e4af82002-06-12 19:18:08 +00003886 conn, addr = self.serv.accept()
3887 conn.setblocking(0)
3888 try:
3889 msg = conn.recv(len(MSG))
Andrew Svetlov0832af62012-12-18 23:10:48 +02003890 except OSError:
Guido van Rossum24e4af82002-06-12 19:18:08 +00003891 pass
3892 else:
3893 self.fail("Error trying to do non-blocking recv.")
3894 read, write, err = select.select([conn], [], [])
3895 if conn in read:
3896 msg = conn.recv(len(MSG))
Brian Curtin21ebbb72010-11-02 02:07:09 +00003897 conn.close()
Guido van Rossum76489682002-06-12 20:38:30 +00003898 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +00003899 else:
3900 self.fail("Error during select call to non-blocking socket.")
3901
3902 def _testRecv(self):
Christian Heimes5e696852008-04-09 08:37:03 +00003903 self.cli.connect((HOST, self.port))
Guido van Rossumb6cc7d22002-07-19 12:46:46 +00003904 time.sleep(0.1)
Guido van Rossum24e4af82002-06-12 19:18:08 +00003905 self.cli.send(MSG)
3906
Victor Stinner45df8202010-04-28 22:31:17 +00003907@unittest.skipUnless(thread, 'Threading required for this test.')
Guido van Rossum24e4af82002-06-12 19:18:08 +00003908class FileObjectClassTestCase(SocketConnectedTest):
Jeremy Hylton5accbdb2007-08-03 20:40:09 +00003909 """Unit tests for the object returned by socket.makefile()
3910
Antoine Pitrou834bd812010-10-13 16:17:14 +00003911 self.read_file is the io object returned by makefile() on
Jeremy Hylton5accbdb2007-08-03 20:40:09 +00003912 the client connection. You can read from this file to
3913 get output from the server.
3914
Antoine Pitrou834bd812010-10-13 16:17:14 +00003915 self.write_file is the io object returned by makefile() on the
Jeremy Hylton5accbdb2007-08-03 20:40:09 +00003916 server connection. You can write to this file to send output
3917 to the client.
3918 """
Guido van Rossum24e4af82002-06-12 19:18:08 +00003919
Guido van Rossume9f66142002-08-07 15:46:19 +00003920 bufsize = -1 # Use default buffer size
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00003921 encoding = 'utf-8'
Antoine Pitrou834bd812010-10-13 16:17:14 +00003922 errors = 'strict'
3923 newline = None
3924
3925 read_mode = 'rb'
3926 read_msg = MSG
3927 write_mode = 'wb'
3928 write_msg = MSG
Guido van Rossume9f66142002-08-07 15:46:19 +00003929
Guido van Rossum24e4af82002-06-12 19:18:08 +00003930 def __init__(self, methodName='runTest'):
3931 SocketConnectedTest.__init__(self, methodName=methodName)
3932
3933 def setUp(self):
Antoine Pitrou98b46702010-09-18 22:59:00 +00003934 self.evt1, self.evt2, self.serv_finished, self.cli_finished = [
3935 threading.Event() for i in range(4)]
Guido van Rossum24e4af82002-06-12 19:18:08 +00003936 SocketConnectedTest.setUp(self)
Antoine Pitrou834bd812010-10-13 16:17:14 +00003937 self.read_file = self.cli_conn.makefile(
3938 self.read_mode, self.bufsize,
3939 encoding = self.encoding,
3940 errors = self.errors,
3941 newline = self.newline)
Guido van Rossum24e4af82002-06-12 19:18:08 +00003942
3943 def tearDown(self):
Antoine Pitrou98b46702010-09-18 22:59:00 +00003944 self.serv_finished.set()
Antoine Pitrou834bd812010-10-13 16:17:14 +00003945 self.read_file.close()
3946 self.assertTrue(self.read_file.closed)
3947 self.read_file = None
Guido van Rossum24e4af82002-06-12 19:18:08 +00003948 SocketConnectedTest.tearDown(self)
3949
3950 def clientSetUp(self):
3951 SocketConnectedTest.clientSetUp(self)
Antoine Pitrou834bd812010-10-13 16:17:14 +00003952 self.write_file = self.serv_conn.makefile(
3953 self.write_mode, self.bufsize,
3954 encoding = self.encoding,
3955 errors = self.errors,
3956 newline = self.newline)
Guido van Rossum24e4af82002-06-12 19:18:08 +00003957
3958 def clientTearDown(self):
Antoine Pitrou98b46702010-09-18 22:59:00 +00003959 self.cli_finished.set()
Antoine Pitrou834bd812010-10-13 16:17:14 +00003960 self.write_file.close()
3961 self.assertTrue(self.write_file.closed)
3962 self.write_file = None
Guido van Rossum24e4af82002-06-12 19:18:08 +00003963 SocketConnectedTest.clientTearDown(self)
3964
Antoine Pitrou68e5c042011-02-25 23:07:44 +00003965 def testReadAfterTimeout(self):
3966 # Issue #7322: A file object must disallow further reads
3967 # after a timeout has occurred.
3968 self.cli_conn.settimeout(1)
3969 self.read_file.read(3)
3970 # First read raises a timeout
3971 self.assertRaises(socket.timeout, self.read_file.read, 1)
3972 # Second read is disallowed
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02003973 with self.assertRaises(OSError) as ctx:
Antoine Pitrou68e5c042011-02-25 23:07:44 +00003974 self.read_file.read(1)
3975 self.assertIn("cannot read from timed out object", str(ctx.exception))
3976
3977 def _testReadAfterTimeout(self):
3978 self.write_file.write(self.write_msg[0:3])
3979 self.write_file.flush()
3980 self.serv_finished.wait()
3981
Guido van Rossum24e4af82002-06-12 19:18:08 +00003982 def testSmallRead(self):
Guido van Rossum8c943832002-08-08 01:00:28 +00003983 # Performing small file read test
Antoine Pitrou834bd812010-10-13 16:17:14 +00003984 first_seg = self.read_file.read(len(self.read_msg)-3)
3985 second_seg = self.read_file.read(3)
Guido van Rossumab659962002-06-12 21:29:43 +00003986 msg = first_seg + second_seg
Antoine Pitrou834bd812010-10-13 16:17:14 +00003987 self.assertEqual(msg, self.read_msg)
Guido van Rossum24e4af82002-06-12 19:18:08 +00003988
3989 def _testSmallRead(self):
Antoine Pitrou834bd812010-10-13 16:17:14 +00003990 self.write_file.write(self.write_msg)
3991 self.write_file.flush()
Guido van Rossum24e4af82002-06-12 19:18:08 +00003992
Guido van Rossum8c943832002-08-08 01:00:28 +00003993 def testFullRead(self):
3994 # read until EOF
Antoine Pitrou834bd812010-10-13 16:17:14 +00003995 msg = self.read_file.read()
3996 self.assertEqual(msg, self.read_msg)
Guido van Rossum8c943832002-08-08 01:00:28 +00003997
3998 def _testFullRead(self):
Antoine Pitrou834bd812010-10-13 16:17:14 +00003999 self.write_file.write(self.write_msg)
4000 self.write_file.close()
Guido van Rossum8c943832002-08-08 01:00:28 +00004001
Guido van Rossum24e4af82002-06-12 19:18:08 +00004002 def testUnbufferedRead(self):
Guido van Rossum8c943832002-08-08 01:00:28 +00004003 # Performing unbuffered file read test
Antoine Pitrou834bd812010-10-13 16:17:14 +00004004 buf = type(self.read_msg)()
Guido van Rossum24e4af82002-06-12 19:18:08 +00004005 while 1:
Antoine Pitrou834bd812010-10-13 16:17:14 +00004006 char = self.read_file.read(1)
Guido van Rossum8c943832002-08-08 01:00:28 +00004007 if not char:
Guido van Rossum24e4af82002-06-12 19:18:08 +00004008 break
Guido van Rossum8c943832002-08-08 01:00:28 +00004009 buf += char
Antoine Pitrou834bd812010-10-13 16:17:14 +00004010 self.assertEqual(buf, self.read_msg)
Guido van Rossum24e4af82002-06-12 19:18:08 +00004011
4012 def _testUnbufferedRead(self):
Antoine Pitrou834bd812010-10-13 16:17:14 +00004013 self.write_file.write(self.write_msg)
4014 self.write_file.flush()
Guido van Rossum24e4af82002-06-12 19:18:08 +00004015
4016 def testReadline(self):
Guido van Rossum8c943832002-08-08 01:00:28 +00004017 # Performing file readline test
Antoine Pitrou834bd812010-10-13 16:17:14 +00004018 line = self.read_file.readline()
4019 self.assertEqual(line, self.read_msg)
Guido van Rossum24e4af82002-06-12 19:18:08 +00004020
4021 def _testReadline(self):
Antoine Pitrou834bd812010-10-13 16:17:14 +00004022 self.write_file.write(self.write_msg)
4023 self.write_file.flush()
Guido van Rossum24e4af82002-06-12 19:18:08 +00004024
Jeremy Hylton5accbdb2007-08-03 20:40:09 +00004025 def testCloseAfterMakefile(self):
4026 # The file returned by makefile should keep the socket open.
4027 self.cli_conn.close()
4028 # read until EOF
Antoine Pitrou834bd812010-10-13 16:17:14 +00004029 msg = self.read_file.read()
4030 self.assertEqual(msg, self.read_msg)
Jeremy Hylton5accbdb2007-08-03 20:40:09 +00004031
4032 def _testCloseAfterMakefile(self):
Antoine Pitrou834bd812010-10-13 16:17:14 +00004033 self.write_file.write(self.write_msg)
4034 self.write_file.flush()
Jeremy Hylton5accbdb2007-08-03 20:40:09 +00004035
4036 def testMakefileAfterMakefileClose(self):
Antoine Pitrou834bd812010-10-13 16:17:14 +00004037 self.read_file.close()
Jeremy Hylton5accbdb2007-08-03 20:40:09 +00004038 msg = self.cli_conn.recv(len(MSG))
Antoine Pitrou834bd812010-10-13 16:17:14 +00004039 if isinstance(self.read_msg, str):
4040 msg = msg.decode()
4041 self.assertEqual(msg, self.read_msg)
Jeremy Hylton5accbdb2007-08-03 20:40:09 +00004042
4043 def _testMakefileAfterMakefileClose(self):
Antoine Pitrou834bd812010-10-13 16:17:14 +00004044 self.write_file.write(self.write_msg)
4045 self.write_file.flush()
Jeremy Hylton5accbdb2007-08-03 20:40:09 +00004046
Tim Peters116d83c2004-03-28 02:20:45 +00004047 def testClosedAttr(self):
Antoine Pitrou834bd812010-10-13 16:17:14 +00004048 self.assertTrue(not self.read_file.closed)
Tim Peters116d83c2004-03-28 02:20:45 +00004049
4050 def _testClosedAttr(self):
Antoine Pitrou834bd812010-10-13 16:17:14 +00004051 self.assertTrue(not self.write_file.closed)
Tim Peters116d83c2004-03-28 02:20:45 +00004052
Amaury Forgeot d'Arc9d24ff02008-11-20 23:15:52 +00004053 def testAttributes(self):
Antoine Pitrou834bd812010-10-13 16:17:14 +00004054 self.assertEqual(self.read_file.mode, self.read_mode)
4055 self.assertEqual(self.read_file.name, self.cli_conn.fileno())
Amaury Forgeot d'Arc9d24ff02008-11-20 23:15:52 +00004056
4057 def _testAttributes(self):
Antoine Pitrou834bd812010-10-13 16:17:14 +00004058 self.assertEqual(self.write_file.mode, self.write_mode)
4059 self.assertEqual(self.write_file.name, self.serv_conn.fileno())
Amaury Forgeot d'Arc9d24ff02008-11-20 23:15:52 +00004060
Gregory P. Smithde3369f2009-01-12 04:50:11 +00004061 def testRealClose(self):
Antoine Pitrou834bd812010-10-13 16:17:14 +00004062 self.read_file.close()
4063 self.assertRaises(ValueError, self.read_file.fileno)
Gregory P. Smithde3369f2009-01-12 04:50:11 +00004064 self.cli_conn.close()
Andrew Svetlov0832af62012-12-18 23:10:48 +02004065 self.assertRaises(OSError, self.cli_conn.getsockname)
Gregory P. Smithde3369f2009-01-12 04:50:11 +00004066
4067 def _testRealClose(self):
4068 pass
4069
4070
Gregory P. Smithaafdca82010-01-04 04:50:36 +00004071class FileObjectInterruptedTestCase(unittest.TestCase):
4072 """Test that the file object correctly handles EINTR internally."""
4073
4074 class MockSocket(object):
4075 def __init__(self, recv_funcs=()):
4076 # A generator that returns callables that we'll call for each
4077 # call to recv().
4078 self._recv_step = iter(recv_funcs)
4079
4080 def recv_into(self, buffer):
4081 data = next(self._recv_step)()
4082 assert len(buffer) >= len(data)
4083 buffer[:len(data)] = data
4084 return len(data)
4085
4086 def _decref_socketios(self):
4087 pass
4088
4089 def _textiowrap_for_test(self, buffering=-1):
4090 raw = socket.SocketIO(self, "r")
4091 if buffering < 0:
4092 buffering = io.DEFAULT_BUFFER_SIZE
4093 if buffering == 0:
4094 return raw
4095 buffer = io.BufferedReader(raw, buffering)
4096 text = io.TextIOWrapper(buffer, None, None)
4097 text.mode = "rb"
4098 return text
4099
4100 @staticmethod
4101 def _raise_eintr():
Andrew Svetlov0832af62012-12-18 23:10:48 +02004102 raise OSError(errno.EINTR, "interrupted")
Gregory P. Smithaafdca82010-01-04 04:50:36 +00004103
4104 def _textiowrap_mock_socket(self, mock, buffering=-1):
4105 raw = socket.SocketIO(mock, "r")
4106 if buffering < 0:
4107 buffering = io.DEFAULT_BUFFER_SIZE
4108 if buffering == 0:
4109 return raw
4110 buffer = io.BufferedReader(raw, buffering)
4111 text = io.TextIOWrapper(buffer, None, None)
4112 text.mode = "rb"
4113 return text
4114
4115 def _test_readline(self, size=-1, buffering=-1):
4116 mock_sock = self.MockSocket(recv_funcs=[
4117 lambda : b"This is the first line\nAnd the sec",
4118 self._raise_eintr,
4119 lambda : b"ond line is here\n",
4120 lambda : b"",
4121 lambda : b"", # XXX(gps): io library does an extra EOF read
4122 ])
4123 fo = mock_sock._textiowrap_for_test(buffering=buffering)
Ezio Melottib3aedd42010-11-20 19:04:17 +00004124 self.assertEqual(fo.readline(size), "This is the first line\n")
4125 self.assertEqual(fo.readline(size), "And the second line is here\n")
Gregory P. Smithaafdca82010-01-04 04:50:36 +00004126
4127 def _test_read(self, size=-1, buffering=-1):
4128 mock_sock = self.MockSocket(recv_funcs=[
4129 lambda : b"This is the first line\nAnd the sec",
4130 self._raise_eintr,
4131 lambda : b"ond line is here\n",
4132 lambda : b"",
4133 lambda : b"", # XXX(gps): io library does an extra EOF read
4134 ])
4135 expecting = (b"This is the first line\n"
4136 b"And the second line is here\n")
4137 fo = mock_sock._textiowrap_for_test(buffering=buffering)
4138 if buffering == 0:
4139 data = b''
4140 else:
4141 data = ''
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00004142 expecting = expecting.decode('utf-8')
Gregory P. Smithaafdca82010-01-04 04:50:36 +00004143 while len(data) != len(expecting):
4144 part = fo.read(size)
4145 if not part:
4146 break
4147 data += part
Ezio Melottib3aedd42010-11-20 19:04:17 +00004148 self.assertEqual(data, expecting)
Gregory P. Smithaafdca82010-01-04 04:50:36 +00004149
4150 def test_default(self):
4151 self._test_readline()
4152 self._test_readline(size=100)
4153 self._test_read()
4154 self._test_read(size=100)
4155
4156 def test_with_1k_buffer(self):
4157 self._test_readline(buffering=1024)
4158 self._test_readline(size=100, buffering=1024)
4159 self._test_read(buffering=1024)
4160 self._test_read(size=100, buffering=1024)
4161
4162 def _test_readline_no_buffer(self, size=-1):
4163 mock_sock = self.MockSocket(recv_funcs=[
4164 lambda : b"a",
4165 lambda : b"\n",
4166 lambda : b"B",
4167 self._raise_eintr,
4168 lambda : b"b",
4169 lambda : b"",
4170 ])
4171 fo = mock_sock._textiowrap_for_test(buffering=0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00004172 self.assertEqual(fo.readline(size), b"a\n")
4173 self.assertEqual(fo.readline(size), b"Bb")
Gregory P. Smithaafdca82010-01-04 04:50:36 +00004174
4175 def test_no_buffer(self):
4176 self._test_readline_no_buffer()
4177 self._test_readline_no_buffer(size=4)
4178 self._test_read(buffering=0)
4179 self._test_read(size=100, buffering=0)
4180
4181
Guido van Rossume9f66142002-08-07 15:46:19 +00004182class UnbufferedFileObjectClassTestCase(FileObjectClassTestCase):
4183
4184 """Repeat the tests from FileObjectClassTestCase with bufsize==0.
Tim Peters469cdad2002-08-08 20:19:19 +00004185
Guido van Rossume9f66142002-08-07 15:46:19 +00004186 In this case (and in this case only), it should be possible to
4187 create a file object, read a line from it, create another file
4188 object, read another line from it, without loss of data in the
Georg Brandl24420152008-05-26 16:32:26 +00004189 first file object's buffer. Note that http.client relies on this
Guido van Rossume9f66142002-08-07 15:46:19 +00004190 when reading multiple requests from the same socket."""
4191
4192 bufsize = 0 # Use unbuffered mode
4193
4194 def testUnbufferedReadline(self):
Guido van Rossum8c943832002-08-08 01:00:28 +00004195 # Read a line, create a new file object, read another line with it
Antoine Pitrou834bd812010-10-13 16:17:14 +00004196 line = self.read_file.readline() # first line
4197 self.assertEqual(line, b"A. " + self.write_msg) # first line
4198 self.read_file = self.cli_conn.makefile('rb', 0)
4199 line = self.read_file.readline() # second line
4200 self.assertEqual(line, b"B. " + self.write_msg) # second line
Guido van Rossume9f66142002-08-07 15:46:19 +00004201
4202 def _testUnbufferedReadline(self):
Antoine Pitrou834bd812010-10-13 16:17:14 +00004203 self.write_file.write(b"A. " + self.write_msg)
4204 self.write_file.write(b"B. " + self.write_msg)
4205 self.write_file.flush()
Guido van Rossume9f66142002-08-07 15:46:19 +00004206
Gregory P. Smithde3369f2009-01-12 04:50:11 +00004207 def testMakefileClose(self):
4208 # The file returned by makefile should keep the socket open...
4209 self.cli_conn.close()
4210 msg = self.cli_conn.recv(1024)
Antoine Pitrou834bd812010-10-13 16:17:14 +00004211 self.assertEqual(msg, self.read_msg)
Gregory P. Smithde3369f2009-01-12 04:50:11 +00004212 # ...until the file is itself closed
Antoine Pitrou834bd812010-10-13 16:17:14 +00004213 self.read_file.close()
Andrew Svetlov0832af62012-12-18 23:10:48 +02004214 self.assertRaises(OSError, self.cli_conn.recv, 1024)
Gregory P. Smithde3369f2009-01-12 04:50:11 +00004215
4216 def _testMakefileClose(self):
Antoine Pitrou834bd812010-10-13 16:17:14 +00004217 self.write_file.write(self.write_msg)
4218 self.write_file.flush()
Gregory P. Smithde3369f2009-01-12 04:50:11 +00004219
4220 def testMakefileCloseSocketDestroy(self):
4221 refcount_before = sys.getrefcount(self.cli_conn)
Antoine Pitrou834bd812010-10-13 16:17:14 +00004222 self.read_file.close()
Gregory P. Smithde3369f2009-01-12 04:50:11 +00004223 refcount_after = sys.getrefcount(self.cli_conn)
4224 self.assertEqual(refcount_before - 1, refcount_after)
4225
4226 def _testMakefileCloseSocketDestroy(self):
4227 pass
4228
Antoine Pitrou98b46702010-09-18 22:59:00 +00004229 # Non-blocking ops
Antoine Pitrou834bd812010-10-13 16:17:14 +00004230 # NOTE: to set `read_file` as non-blocking, we must call
Antoine Pitrou98b46702010-09-18 22:59:00 +00004231 # `cli_conn.setblocking` and vice-versa (see setUp / clientSetUp).
4232
4233 def testSmallReadNonBlocking(self):
4234 self.cli_conn.setblocking(False)
Antoine Pitrou834bd812010-10-13 16:17:14 +00004235 self.assertEqual(self.read_file.readinto(bytearray(10)), None)
4236 self.assertEqual(self.read_file.read(len(self.read_msg) - 3), None)
Antoine Pitrou98b46702010-09-18 22:59:00 +00004237 self.evt1.set()
4238 self.evt2.wait(1.0)
Antoine Pitrou834bd812010-10-13 16:17:14 +00004239 first_seg = self.read_file.read(len(self.read_msg) - 3)
Antoine Pitrou43bf0452011-04-04 01:21:37 +02004240 if first_seg is None:
4241 # Data not arrived (can happen under Windows), wait a bit
4242 time.sleep(0.5)
4243 first_seg = self.read_file.read(len(self.read_msg) - 3)
Antoine Pitrou98b46702010-09-18 22:59:00 +00004244 buf = bytearray(10)
Antoine Pitrou834bd812010-10-13 16:17:14 +00004245 n = self.read_file.readinto(buf)
Antoine Pitrou98b46702010-09-18 22:59:00 +00004246 self.assertEqual(n, 3)
4247 msg = first_seg + buf[:n]
Antoine Pitrou834bd812010-10-13 16:17:14 +00004248 self.assertEqual(msg, self.read_msg)
4249 self.assertEqual(self.read_file.readinto(bytearray(16)), None)
4250 self.assertEqual(self.read_file.read(1), None)
Antoine Pitrou98b46702010-09-18 22:59:00 +00004251
4252 def _testSmallReadNonBlocking(self):
4253 self.evt1.wait(1.0)
Antoine Pitrou834bd812010-10-13 16:17:14 +00004254 self.write_file.write(self.write_msg)
4255 self.write_file.flush()
Antoine Pitrou98b46702010-09-18 22:59:00 +00004256 self.evt2.set()
4257 # Avoid cloding the socket before the server test has finished,
4258 # otherwise system recv() will return 0 instead of EWOULDBLOCK.
4259 self.serv_finished.wait(5.0)
4260
4261 def testWriteNonBlocking(self):
4262 self.cli_finished.wait(5.0)
4263 # The client thread can't skip directly - the SkipTest exception
4264 # would appear as a failure.
4265 if self.serv_skipped:
4266 self.skipTest(self.serv_skipped)
4267
4268 def _testWriteNonBlocking(self):
4269 self.serv_skipped = None
4270 self.serv_conn.setblocking(False)
4271 # Try to saturate the socket buffer pipe with repeated large writes.
Charles-François Natali5fd26422013-08-29 19:01:40 +02004272 BIG = b"x" * support.SOCK_MAX_SIZE
Antoine Pitrou98b46702010-09-18 22:59:00 +00004273 LIMIT = 10
4274 # The first write() succeeds since a chunk of data can be buffered
Antoine Pitrou834bd812010-10-13 16:17:14 +00004275 n = self.write_file.write(BIG)
Antoine Pitrou98b46702010-09-18 22:59:00 +00004276 self.assertGreater(n, 0)
4277 for i in range(LIMIT):
Antoine Pitrou834bd812010-10-13 16:17:14 +00004278 n = self.write_file.write(BIG)
Antoine Pitrou98b46702010-09-18 22:59:00 +00004279 if n is None:
4280 # Succeeded
4281 break
4282 self.assertGreater(n, 0)
4283 else:
4284 # Let us know that this test didn't manage to establish
4285 # the expected conditions. This is not a failure in itself but,
4286 # if it happens repeatedly, the test should be fixed.
4287 self.serv_skipped = "failed to saturate the socket buffer"
4288
Gregory P. Smithde3369f2009-01-12 04:50:11 +00004289
Guido van Rossum8c943832002-08-08 01:00:28 +00004290class LineBufferedFileObjectClassTestCase(FileObjectClassTestCase):
4291
4292 bufsize = 1 # Default-buffered for reading; line-buffered for writing
4293
4294
4295class SmallBufferedFileObjectClassTestCase(FileObjectClassTestCase):
4296
4297 bufsize = 2 # Exercise the buffering code
Guido van Rossume9f66142002-08-07 15:46:19 +00004298
Thomas Woutersb2137042007-02-01 18:02:27 +00004299
Antoine Pitrou834bd812010-10-13 16:17:14 +00004300class UnicodeReadFileObjectClassTestCase(FileObjectClassTestCase):
4301 """Tests for socket.makefile() in text mode (rather than binary)"""
4302
4303 read_mode = 'r'
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00004304 read_msg = MSG.decode('utf-8')
Antoine Pitrou834bd812010-10-13 16:17:14 +00004305 write_mode = 'wb'
4306 write_msg = MSG
4307 newline = ''
4308
4309
4310class UnicodeWriteFileObjectClassTestCase(FileObjectClassTestCase):
4311 """Tests for socket.makefile() in text mode (rather than binary)"""
4312
4313 read_mode = 'rb'
4314 read_msg = MSG
4315 write_mode = 'w'
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00004316 write_msg = MSG.decode('utf-8')
Antoine Pitrou834bd812010-10-13 16:17:14 +00004317 newline = ''
4318
4319
4320class UnicodeReadWriteFileObjectClassTestCase(FileObjectClassTestCase):
4321 """Tests for socket.makefile() in text mode (rather than binary)"""
4322
4323 read_mode = 'r'
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00004324 read_msg = MSG.decode('utf-8')
Antoine Pitrou834bd812010-10-13 16:17:14 +00004325 write_mode = 'w'
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00004326 write_msg = MSG.decode('utf-8')
Antoine Pitrou834bd812010-10-13 16:17:14 +00004327 newline = ''
4328
4329
Guido van Rossumd8faa362007-04-27 19:54:29 +00004330class NetworkConnectionTest(object):
4331 """Prove network connection."""
Guido van Rossum7d0a8262007-05-21 23:13:11 +00004332
Guido van Rossumd8faa362007-04-27 19:54:29 +00004333 def clientSetUp(self):
Christian Heimes5e696852008-04-09 08:37:03 +00004334 # We're inherited below by BasicTCPTest2, which also inherits
4335 # BasicTCPTest, which defines self.port referenced below.
4336 self.cli = socket.create_connection((HOST, self.port))
Guido van Rossumd8faa362007-04-27 19:54:29 +00004337 self.serv_conn = self.cli
4338
4339class BasicTCPTest2(NetworkConnectionTest, BasicTCPTest):
4340 """Tests that NetworkConnection does not break existing TCP functionality.
4341 """
4342
4343class NetworkConnectionNoServer(unittest.TestCase):
Guido van Rossum7d0a8262007-05-21 23:13:11 +00004344
Antoine Pitrou4b92b5f2010-09-07 21:05:49 +00004345 class MockSocket(socket.socket):
4346 def connect(self, *args):
4347 raise socket.timeout('timed out')
4348
4349 @contextlib.contextmanager
4350 def mocked_socket_module(self):
4351 """Return a socket which times out on connect"""
4352 old_socket = socket.socket
4353 socket.socket = self.MockSocket
4354 try:
4355 yield
4356 finally:
4357 socket.socket = old_socket
4358
4359 def test_connect(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00004360 port = support.find_unused_port()
Antoine Pitrou4b92b5f2010-09-07 21:05:49 +00004361 cli = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
Brian Curtin21ebbb72010-11-02 02:07:09 +00004362 self.addCleanup(cli.close)
Andrew Svetlov0832af62012-12-18 23:10:48 +02004363 with self.assertRaises(OSError) as cm:
Antoine Pitrou4b92b5f2010-09-07 21:05:49 +00004364 cli.connect((HOST, port))
4365 self.assertEqual(cm.exception.errno, errno.ECONNREFUSED)
4366
4367 def test_create_connection(self):
4368 # Issue #9792: errors raised by create_connection() should have
4369 # a proper errno attribute.
4370 port = support.find_unused_port()
Andrew Svetlov0832af62012-12-18 23:10:48 +02004371 with self.assertRaises(OSError) as cm:
Antoine Pitrou4b92b5f2010-09-07 21:05:49 +00004372 socket.create_connection((HOST, port))
Trent Nelson45bb6132012-10-17 06:15:15 -04004373
4374 # Issue #16257: create_connection() calls getaddrinfo() against
4375 # 'localhost'. This may result in an IPV6 addr being returned
4376 # as well as an IPV4 one:
4377 # >>> socket.getaddrinfo('localhost', port, 0, SOCK_STREAM)
4378 # >>> [(2, 2, 0, '', ('127.0.0.1', 41230)),
4379 # (26, 2, 0, '', ('::1', 41230, 0, 0))]
4380 #
4381 # create_connection() enumerates through all the addresses returned
4382 # and if it doesn't successfully bind to any of them, it propagates
4383 # the last exception it encountered.
4384 #
4385 # On Solaris, ENETUNREACH is returned in this circumstance instead
4386 # of ECONNREFUSED. So, if that errno exists, add it to our list of
4387 # expected errnos.
4388 expected_errnos = [ errno.ECONNREFUSED, ]
4389 if hasattr(errno, 'ENETUNREACH'):
4390 expected_errnos.append(errno.ENETUNREACH)
4391
4392 self.assertIn(cm.exception.errno, expected_errnos)
Antoine Pitrou4b92b5f2010-09-07 21:05:49 +00004393
4394 def test_create_connection_timeout(self):
4395 # Issue #9792: create_connection() should not recast timeout errors
4396 # as generic socket errors.
4397 with self.mocked_socket_module():
4398 with self.assertRaises(socket.timeout):
4399 socket.create_connection((HOST, 1234))
4400
Guido van Rossumd8faa362007-04-27 19:54:29 +00004401
Victor Stinner45df8202010-04-28 22:31:17 +00004402@unittest.skipUnless(thread, 'Threading required for this test.')
Guido van Rossumd8faa362007-04-27 19:54:29 +00004403class NetworkConnectionAttributesTest(SocketTCPTest, ThreadableTest):
4404
4405 def __init__(self, methodName='runTest'):
4406 SocketTCPTest.__init__(self, methodName=methodName)
4407 ThreadableTest.__init__(self)
4408
4409 def clientSetUp(self):
Gregory P. Smithb4066372010-01-03 03:28:29 +00004410 self.source_port = support.find_unused_port()
Guido van Rossumd8faa362007-04-27 19:54:29 +00004411
4412 def clientTearDown(self):
4413 self.cli.close()
4414 self.cli = None
4415 ThreadableTest.clientTearDown(self)
4416
4417 def _justAccept(self):
4418 conn, addr = self.serv.accept()
Brian Curtin21ebbb72010-11-02 02:07:09 +00004419 conn.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00004420
4421 testFamily = _justAccept
4422 def _testFamily(self):
Christian Heimes5e696852008-04-09 08:37:03 +00004423 self.cli = socket.create_connection((HOST, self.port), timeout=30)
Brian Curtin21ebbb72010-11-02 02:07:09 +00004424 self.addCleanup(self.cli.close)
Guido van Rossumd8faa362007-04-27 19:54:29 +00004425 self.assertEqual(self.cli.family, 2)
4426
Gregory P. Smitha81d8812010-01-03 15:09:32 +00004427 testSourceAddress = _justAccept
4428 def _testSourceAddress(self):
Gregory P. Smithb4066372010-01-03 03:28:29 +00004429 self.cli = socket.create_connection((HOST, self.port), timeout=30,
4430 source_address=('', self.source_port))
Brian Curtin21ebbb72010-11-02 02:07:09 +00004431 self.addCleanup(self.cli.close)
Gregory P. Smithb4066372010-01-03 03:28:29 +00004432 self.assertEqual(self.cli.getsockname()[1], self.source_port)
Gregory P. Smitha81d8812010-01-03 15:09:32 +00004433 # The port number being used is sufficient to show that the bind()
4434 # call happened.
Gregory P. Smithb4066372010-01-03 03:28:29 +00004435
Guido van Rossumd8faa362007-04-27 19:54:29 +00004436 testTimeoutDefault = _justAccept
4437 def _testTimeoutDefault(self):
Georg Brandlf78e02b2008-06-10 17:40:04 +00004438 # passing no explicit timeout uses socket's global default
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00004439 self.assertTrue(socket.getdefaulttimeout() is None)
Georg Brandlf78e02b2008-06-10 17:40:04 +00004440 socket.setdefaulttimeout(42)
4441 try:
4442 self.cli = socket.create_connection((HOST, self.port))
Brian Curtin21ebbb72010-11-02 02:07:09 +00004443 self.addCleanup(self.cli.close)
Georg Brandlf78e02b2008-06-10 17:40:04 +00004444 finally:
4445 socket.setdefaulttimeout(None)
Ezio Melottib3aedd42010-11-20 19:04:17 +00004446 self.assertEqual(self.cli.gettimeout(), 42)
Georg Brandlf78e02b2008-06-10 17:40:04 +00004447
4448 testTimeoutNone = _justAccept
4449 def _testTimeoutNone(self):
4450 # None timeout means the same as sock.settimeout(None)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00004451 self.assertTrue(socket.getdefaulttimeout() is None)
Georg Brandlf78e02b2008-06-10 17:40:04 +00004452 socket.setdefaulttimeout(30)
4453 try:
4454 self.cli = socket.create_connection((HOST, self.port), timeout=None)
Brian Curtin21ebbb72010-11-02 02:07:09 +00004455 self.addCleanup(self.cli.close)
Georg Brandlf78e02b2008-06-10 17:40:04 +00004456 finally:
4457 socket.setdefaulttimeout(None)
4458 self.assertEqual(self.cli.gettimeout(), None)
Guido van Rossumd8faa362007-04-27 19:54:29 +00004459
4460 testTimeoutValueNamed = _justAccept
4461 def _testTimeoutValueNamed(self):
Christian Heimes5e696852008-04-09 08:37:03 +00004462 self.cli = socket.create_connection((HOST, self.port), timeout=30)
Guido van Rossumd8faa362007-04-27 19:54:29 +00004463 self.assertEqual(self.cli.gettimeout(), 30)
4464
4465 testTimeoutValueNonamed = _justAccept
4466 def _testTimeoutValueNonamed(self):
Christian Heimes5e696852008-04-09 08:37:03 +00004467 self.cli = socket.create_connection((HOST, self.port), 30)
Brian Curtin21ebbb72010-11-02 02:07:09 +00004468 self.addCleanup(self.cli.close)
Guido van Rossumd8faa362007-04-27 19:54:29 +00004469 self.assertEqual(self.cli.gettimeout(), 30)
4470
Victor Stinner45df8202010-04-28 22:31:17 +00004471@unittest.skipUnless(thread, 'Threading required for this test.')
Guido van Rossumd8faa362007-04-27 19:54:29 +00004472class NetworkConnectionBehaviourTest(SocketTCPTest, ThreadableTest):
4473
4474 def __init__(self, methodName='runTest'):
4475 SocketTCPTest.__init__(self, methodName=methodName)
4476 ThreadableTest.__init__(self)
4477
4478 def clientSetUp(self):
4479 pass
4480
4481 def clientTearDown(self):
4482 self.cli.close()
4483 self.cli = None
4484 ThreadableTest.clientTearDown(self)
4485
4486 def testInsideTimeout(self):
4487 conn, addr = self.serv.accept()
Brian Curtin21ebbb72010-11-02 02:07:09 +00004488 self.addCleanup(conn.close)
Guido van Rossumd8faa362007-04-27 19:54:29 +00004489 time.sleep(3)
Guido van Rossum7d0a8262007-05-21 23:13:11 +00004490 conn.send(b"done!")
Guido van Rossumd8faa362007-04-27 19:54:29 +00004491 testOutsideTimeout = testInsideTimeout
4492
4493 def _testInsideTimeout(self):
Christian Heimes5e696852008-04-09 08:37:03 +00004494 self.cli = sock = socket.create_connection((HOST, self.port))
Guido van Rossumd8faa362007-04-27 19:54:29 +00004495 data = sock.recv(5)
Guido van Rossum7d0a8262007-05-21 23:13:11 +00004496 self.assertEqual(data, b"done!")
Guido van Rossumd8faa362007-04-27 19:54:29 +00004497
4498 def _testOutsideTimeout(self):
Christian Heimes5e696852008-04-09 08:37:03 +00004499 self.cli = sock = socket.create_connection((HOST, self.port), timeout=1)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00004500 self.assertRaises(socket.timeout, lambda: sock.recv(5))
Guido van Rossumd8faa362007-04-27 19:54:29 +00004501
4502
Raymond Hettinger11a35f52003-06-29 04:40:22 +00004503class TCPTimeoutTest(SocketTCPTest):
4504
4505 def testTCPTimeout(self):
4506 def raise_timeout(*args, **kwargs):
4507 self.serv.settimeout(1.0)
4508 self.serv.accept()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00004509 self.assertRaises(socket.timeout, raise_timeout,
Raymond Hettinger11a35f52003-06-29 04:40:22 +00004510 "Error generating a timeout exception (TCP)")
4511
4512 def testTimeoutZero(self):
4513 ok = False
4514 try:
4515 self.serv.settimeout(0.0)
4516 foo = self.serv.accept()
4517 except socket.timeout:
4518 self.fail("caught timeout instead of error (TCP)")
Andrew Svetlov0832af62012-12-18 23:10:48 +02004519 except OSError:
Raymond Hettinger11a35f52003-06-29 04:40:22 +00004520 ok = True
4521 except:
4522 self.fail("caught unexpected exception (TCP)")
4523 if not ok:
4524 self.fail("accept() returned success when we did not expect it")
4525
Serhiy Storchaka43767632013-11-03 21:31:38 +02004526 @unittest.skipUnless(hasattr(signal, 'alarm'),
4527 'test needs signal.alarm()')
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004528 def testInterruptedTimeout(self):
4529 # XXX I don't know how to do this test on MSWindows or any other
4530 # plaform that doesn't support signal.alarm() or os.kill(), though
4531 # the bug should have existed on all platforms.
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004532 self.serv.settimeout(5.0) # must be longer than alarm
4533 class Alarm(Exception):
4534 pass
4535 def alarm_handler(signal, frame):
4536 raise Alarm
4537 old_alarm = signal.signal(signal.SIGALRM, alarm_handler)
4538 try:
4539 signal.alarm(2) # POSIX allows alarm to be up to 1 second early
4540 try:
4541 foo = self.serv.accept()
4542 except socket.timeout:
4543 self.fail("caught timeout instead of Alarm")
4544 except Alarm:
4545 pass
4546 except:
Christian Heimesbbe741d2008-03-28 10:53:29 +00004547 self.fail("caught other exception instead of Alarm:"
4548 " %s(%s):\n%s" %
4549 (sys.exc_info()[:2] + (traceback.format_exc(),)))
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004550 else:
4551 self.fail("nothing caught")
Christian Heimesbbe741d2008-03-28 10:53:29 +00004552 finally:
4553 signal.alarm(0) # shut off alarm
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004554 except Alarm:
4555 self.fail("got Alarm in wrong place")
4556 finally:
4557 # no alarm can be pending. Safe to restore old handler.
4558 signal.signal(signal.SIGALRM, old_alarm)
4559
Ezio Melotti7f78ddc2011-11-18 18:33:14 +02004560class UDPTimeoutTest(SocketUDPTest):
Raymond Hettinger11a35f52003-06-29 04:40:22 +00004561
4562 def testUDPTimeout(self):
4563 def raise_timeout(*args, **kwargs):
4564 self.serv.settimeout(1.0)
4565 self.serv.recv(1024)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00004566 self.assertRaises(socket.timeout, raise_timeout,
Raymond Hettinger11a35f52003-06-29 04:40:22 +00004567 "Error generating a timeout exception (UDP)")
4568
4569 def testTimeoutZero(self):
4570 ok = False
4571 try:
4572 self.serv.settimeout(0.0)
4573 foo = self.serv.recv(1024)
4574 except socket.timeout:
4575 self.fail("caught timeout instead of error (UDP)")
Andrew Svetlov0832af62012-12-18 23:10:48 +02004576 except OSError:
Raymond Hettinger11a35f52003-06-29 04:40:22 +00004577 ok = True
4578 except:
4579 self.fail("caught unexpected exception (UDP)")
4580 if not ok:
4581 self.fail("recv() returned success when we did not expect it")
4582
4583class TestExceptions(unittest.TestCase):
4584
4585 def testExceptionTree(self):
Andrew Svetlov0832af62012-12-18 23:10:48 +02004586 self.assertTrue(issubclass(OSError, Exception))
4587 self.assertTrue(issubclass(socket.herror, OSError))
4588 self.assertTrue(issubclass(socket.gaierror, OSError))
4589 self.assertTrue(issubclass(socket.timeout, OSError))
Raymond Hettinger11a35f52003-06-29 04:40:22 +00004590
Serhiy Storchaka43767632013-11-03 21:31:38 +02004591@unittest.skipUnless(sys.platform == 'linux', 'Linux specific test')
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004592class TestLinuxAbstractNamespace(unittest.TestCase):
4593
4594 UNIX_PATH_MAX = 108
4595
4596 def testLinuxAbstractNamespace(self):
Charles-François Natalib10c71d2013-05-21 10:45:46 +02004597 address = b"\x00python-test-hello\x00\xff"
Victor Stinner1d5eb342011-01-03 14:30:46 +00004598 with socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) as s1:
4599 s1.bind(address)
4600 s1.listen(1)
4601 with socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) as s2:
4602 s2.connect(s1.getsockname())
4603 with s1.accept()[0] as s3:
4604 self.assertEqual(s1.getsockname(), address)
4605 self.assertEqual(s2.getpeername(), address)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004606
4607 def testMaxName(self):
Charles-François Natalib10c71d2013-05-21 10:45:46 +02004608 address = b"\x00" + b"h" * (self.UNIX_PATH_MAX - 1)
Victor Stinner1d5eb342011-01-03 14:30:46 +00004609 with socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) as s:
4610 s.bind(address)
4611 self.assertEqual(s.getsockname(), address)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004612
4613 def testNameOverflow(self):
4614 address = "\x00" + "h" * self.UNIX_PATH_MAX
Victor Stinner1d5eb342011-01-03 14:30:46 +00004615 with socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) as s:
Andrew Svetlov0832af62012-12-18 23:10:48 +02004616 self.assertRaises(OSError, s.bind, address)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004617
Charles-François Natalib10c71d2013-05-21 10:45:46 +02004618 def testStrName(self):
4619 # Check that an abstract name can be passed as a string.
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01004620 s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
4621 try:
Charles-François Natalib10c71d2013-05-21 10:45:46 +02004622 s.bind("\x00python\x00test\x00")
4623 self.assertEqual(s.getsockname(), b"\x00python\x00test\x00")
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01004624 finally:
4625 s.close()
4626
Serhiy Storchaka43767632013-11-03 21:31:38 +02004627@unittest.skipUnless(hasattr(socket, 'AF_UNIX'), 'test needs socket.AF_UNIX')
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01004628class TestUnixDomain(unittest.TestCase):
4629
4630 def setUp(self):
4631 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
4632
4633 def tearDown(self):
4634 self.sock.close()
4635
4636 def encoded(self, path):
4637 # Return the given path encoded in the file system encoding,
4638 # or skip the test if this is not possible.
4639 try:
4640 return os.fsencode(path)
4641 except UnicodeEncodeError:
4642 self.skipTest(
4643 "Pathname {0!a} cannot be represented in file "
4644 "system encoding {1!r}".format(
4645 path, sys.getfilesystemencoding()))
4646
Antoine Pitrou16374872011-12-16 15:04:12 +01004647 def bind(self, sock, path):
4648 # Bind the socket
4649 try:
4650 sock.bind(path)
4651 except OSError as e:
4652 if str(e) == "AF_UNIX path too long":
4653 self.skipTest(
4654 "Pathname {0!a} is too long to serve as a AF_UNIX path"
4655 .format(path))
4656 else:
4657 raise
4658
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01004659 def testStrAddr(self):
4660 # Test binding to and retrieving a normal string pathname.
4661 path = os.path.abspath(support.TESTFN)
Antoine Pitrou16374872011-12-16 15:04:12 +01004662 self.bind(self.sock, path)
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01004663 self.addCleanup(support.unlink, path)
4664 self.assertEqual(self.sock.getsockname(), path)
4665
4666 def testBytesAddr(self):
4667 # Test binding to a bytes pathname.
4668 path = os.path.abspath(support.TESTFN)
Antoine Pitrou16374872011-12-16 15:04:12 +01004669 self.bind(self.sock, self.encoded(path))
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01004670 self.addCleanup(support.unlink, path)
4671 self.assertEqual(self.sock.getsockname(), path)
4672
4673 def testSurrogateescapeBind(self):
4674 # Test binding to a valid non-ASCII pathname, with the
4675 # non-ASCII bytes supplied using surrogateescape encoding.
4676 path = os.path.abspath(support.TESTFN_UNICODE)
4677 b = self.encoded(path)
Antoine Pitrou16374872011-12-16 15:04:12 +01004678 self.bind(self.sock, b.decode("ascii", "surrogateescape"))
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01004679 self.addCleanup(support.unlink, path)
4680 self.assertEqual(self.sock.getsockname(), path)
4681
4682 def testUnencodableAddr(self):
4683 # Test binding to a pathname that cannot be encoded in the
4684 # file system encoding.
4685 if support.TESTFN_UNENCODABLE is None:
4686 self.skipTest("No unencodable filename available")
4687 path = os.path.abspath(support.TESTFN_UNENCODABLE)
Antoine Pitrou16374872011-12-16 15:04:12 +01004688 self.bind(self.sock, path)
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01004689 self.addCleanup(support.unlink, path)
4690 self.assertEqual(self.sock.getsockname(), path)
Raymond Hettinger11a35f52003-06-29 04:40:22 +00004691
Victor Stinner45df8202010-04-28 22:31:17 +00004692@unittest.skipUnless(thread, 'Threading required for this test.')
Thomas Wouters477c8d52006-05-27 19:21:47 +00004693class BufferIOTest(SocketConnectedTest):
4694 """
4695 Test the buffer versions of socket.recv() and socket.send().
4696 """
4697 def __init__(self, methodName='runTest'):
4698 SocketConnectedTest.__init__(self, methodName=methodName)
4699
Antoine Pitrou25480782010-03-17 22:50:28 +00004700 def testRecvIntoArray(self):
Antoine Pitrou2f89aa62008-08-02 21:02:48 +00004701 buf = bytearray(1024)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00004702 nbytes = self.cli_conn.recv_into(buf)
Thomas Wouters477c8d52006-05-27 19:21:47 +00004703 self.assertEqual(nbytes, len(MSG))
Guido van Rossum7d0a8262007-05-21 23:13:11 +00004704 msg = buf[:len(MSG)]
Thomas Wouters477c8d52006-05-27 19:21:47 +00004705 self.assertEqual(msg, MSG)
4706
Antoine Pitrou25480782010-03-17 22:50:28 +00004707 def _testRecvIntoArray(self):
Guido van Rossumb5b22702007-05-18 18:55:53 +00004708 buf = bytes(MSG)
Thomas Wouters477c8d52006-05-27 19:21:47 +00004709 self.serv_conn.send(buf)
4710
Antoine Pitrou25480782010-03-17 22:50:28 +00004711 def testRecvIntoBytearray(self):
4712 buf = bytearray(1024)
4713 nbytes = self.cli_conn.recv_into(buf)
4714 self.assertEqual(nbytes, len(MSG))
4715 msg = buf[:len(MSG)]
4716 self.assertEqual(msg, MSG)
4717
4718 _testRecvIntoBytearray = _testRecvIntoArray
4719
4720 def testRecvIntoMemoryview(self):
4721 buf = bytearray(1024)
4722 nbytes = self.cli_conn.recv_into(memoryview(buf))
4723 self.assertEqual(nbytes, len(MSG))
4724 msg = buf[:len(MSG)]
4725 self.assertEqual(msg, MSG)
4726
4727 _testRecvIntoMemoryview = _testRecvIntoArray
4728
4729 def testRecvFromIntoArray(self):
Antoine Pitrou2f89aa62008-08-02 21:02:48 +00004730 buf = bytearray(1024)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00004731 nbytes, addr = self.cli_conn.recvfrom_into(buf)
Thomas Wouters477c8d52006-05-27 19:21:47 +00004732 self.assertEqual(nbytes, len(MSG))
Guido van Rossum7d0a8262007-05-21 23:13:11 +00004733 msg = buf[:len(MSG)]
Thomas Wouters477c8d52006-05-27 19:21:47 +00004734 self.assertEqual(msg, MSG)
4735
Antoine Pitrou25480782010-03-17 22:50:28 +00004736 def _testRecvFromIntoArray(self):
Guido van Rossumb5b22702007-05-18 18:55:53 +00004737 buf = bytes(MSG)
Thomas Wouters477c8d52006-05-27 19:21:47 +00004738 self.serv_conn.send(buf)
4739
Antoine Pitrou25480782010-03-17 22:50:28 +00004740 def testRecvFromIntoBytearray(self):
4741 buf = bytearray(1024)
4742 nbytes, addr = self.cli_conn.recvfrom_into(buf)
4743 self.assertEqual(nbytes, len(MSG))
4744 msg = buf[:len(MSG)]
4745 self.assertEqual(msg, MSG)
4746
4747 _testRecvFromIntoBytearray = _testRecvFromIntoArray
4748
4749 def testRecvFromIntoMemoryview(self):
4750 buf = bytearray(1024)
4751 nbytes, addr = self.cli_conn.recvfrom_into(memoryview(buf))
4752 self.assertEqual(nbytes, len(MSG))
4753 msg = buf[:len(MSG)]
4754 self.assertEqual(msg, MSG)
4755
4756 _testRecvFromIntoMemoryview = _testRecvFromIntoArray
4757
Benjamin Petersonc6b37e22014-01-13 23:14:42 -05004758 def testRecvFromIntoSmallBuffer(self):
4759 # See issue #20246.
4760 buf = bytearray(8)
4761 self.assertRaises(ValueError, self.cli_conn.recvfrom_into, buf, 1024)
4762
4763 def _testRecvFromIntoSmallBuffer(self):
Stefan Krah6b2e5592014-01-21 22:58:40 +01004764 self.serv_conn.send(MSG)
Benjamin Petersonc6b37e22014-01-13 23:14:42 -05004765
Benjamin Petersonbd1d12e2014-01-14 00:27:42 -05004766 def testRecvFromIntoEmptyBuffer(self):
4767 buf = bytearray()
4768 self.cli_conn.recvfrom_into(buf)
4769 self.cli_conn.recvfrom_into(buf, 0)
4770
4771 _testRecvFromIntoEmptyBuffer = _testRecvFromIntoArray
4772
Christian Heimes043d6f62008-01-07 17:19:16 +00004773
4774TIPC_STYPE = 2000
4775TIPC_LOWER = 200
4776TIPC_UPPER = 210
4777
4778def isTipcAvailable():
4779 """Check if the TIPC module is loaded
4780
4781 The TIPC module is not loaded automatically on Ubuntu and probably
4782 other Linux distros.
4783 """
4784 if not hasattr(socket, "AF_TIPC"):
4785 return False
4786 if not os.path.isfile("/proc/modules"):
4787 return False
4788 with open("/proc/modules") as f:
4789 for line in f:
4790 if line.startswith("tipc "):
4791 return True
Christian Heimes043d6f62008-01-07 17:19:16 +00004792 return False
4793
Serhiy Storchaka43767632013-11-03 21:31:38 +02004794@unittest.skipUnless(isTipcAvailable(),
4795 "TIPC module is not loaded, please 'sudo modprobe tipc'")
Antoine Pitrou86aed0b2011-10-02 23:33:19 +02004796class TIPCTest(unittest.TestCase):
Christian Heimes043d6f62008-01-07 17:19:16 +00004797 def testRDM(self):
4798 srv = socket.socket(socket.AF_TIPC, socket.SOCK_RDM)
4799 cli = socket.socket(socket.AF_TIPC, socket.SOCK_RDM)
Antoine Pitrou86aed0b2011-10-02 23:33:19 +02004800 self.addCleanup(srv.close)
4801 self.addCleanup(cli.close)
Christian Heimes043d6f62008-01-07 17:19:16 +00004802
4803 srv.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
4804 srvaddr = (socket.TIPC_ADDR_NAMESEQ, TIPC_STYPE,
4805 TIPC_LOWER, TIPC_UPPER)
4806 srv.bind(srvaddr)
4807
4808 sendaddr = (socket.TIPC_ADDR_NAME, TIPC_STYPE,
4809 TIPC_LOWER + int((TIPC_UPPER - TIPC_LOWER) / 2), 0)
4810 cli.sendto(MSG, sendaddr)
4811
4812 msg, recvaddr = srv.recvfrom(1024)
4813
4814 self.assertEqual(cli.getsockname(), recvaddr)
4815 self.assertEqual(msg, MSG)
4816
4817
Serhiy Storchaka43767632013-11-03 21:31:38 +02004818@unittest.skipUnless(isTipcAvailable(),
4819 "TIPC module is not loaded, please 'sudo modprobe tipc'")
Antoine Pitrou86aed0b2011-10-02 23:33:19 +02004820class TIPCThreadableTest(unittest.TestCase, ThreadableTest):
Christian Heimes043d6f62008-01-07 17:19:16 +00004821 def __init__(self, methodName = 'runTest'):
4822 unittest.TestCase.__init__(self, methodName = methodName)
4823 ThreadableTest.__init__(self)
4824
4825 def setUp(self):
4826 self.srv = socket.socket(socket.AF_TIPC, socket.SOCK_STREAM)
Antoine Pitrou86aed0b2011-10-02 23:33:19 +02004827 self.addCleanup(self.srv.close)
Christian Heimes043d6f62008-01-07 17:19:16 +00004828 self.srv.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
4829 srvaddr = (socket.TIPC_ADDR_NAMESEQ, TIPC_STYPE,
4830 TIPC_LOWER, TIPC_UPPER)
4831 self.srv.bind(srvaddr)
4832 self.srv.listen(5)
4833 self.serverExplicitReady()
4834 self.conn, self.connaddr = self.srv.accept()
Antoine Pitrou86aed0b2011-10-02 23:33:19 +02004835 self.addCleanup(self.conn.close)
Christian Heimes043d6f62008-01-07 17:19:16 +00004836
4837 def clientSetUp(self):
4838 # The is a hittable race between serverExplicitReady() and the
4839 # accept() call; sleep a little while to avoid it, otherwise
4840 # we could get an exception
4841 time.sleep(0.1)
4842 self.cli = socket.socket(socket.AF_TIPC, socket.SOCK_STREAM)
Antoine Pitrou86aed0b2011-10-02 23:33:19 +02004843 self.addCleanup(self.cli.close)
Christian Heimes043d6f62008-01-07 17:19:16 +00004844 addr = (socket.TIPC_ADDR_NAME, TIPC_STYPE,
4845 TIPC_LOWER + int((TIPC_UPPER - TIPC_LOWER) / 2), 0)
4846 self.cli.connect(addr)
4847 self.cliaddr = self.cli.getsockname()
4848
4849 def testStream(self):
4850 msg = self.conn.recv(1024)
4851 self.assertEqual(msg, MSG)
4852 self.assertEqual(self.cliaddr, self.connaddr)
4853
4854 def _testStream(self):
4855 self.cli.send(MSG)
4856 self.cli.close()
4857
4858
Giampaolo Rodolàb383dbb2010-09-08 22:44:12 +00004859@unittest.skipUnless(thread, 'Threading required for this test.')
4860class ContextManagersTest(ThreadedTCPSocketTest):
4861
4862 def _testSocketClass(self):
4863 # base test
4864 with socket.socket() as sock:
4865 self.assertFalse(sock._closed)
4866 self.assertTrue(sock._closed)
4867 # close inside with block
4868 with socket.socket() as sock:
4869 sock.close()
4870 self.assertTrue(sock._closed)
4871 # exception inside with block
4872 with socket.socket() as sock:
Andrew Svetlov0832af62012-12-18 23:10:48 +02004873 self.assertRaises(OSError, sock.sendall, b'foo')
Giampaolo Rodolàb383dbb2010-09-08 22:44:12 +00004874 self.assertTrue(sock._closed)
4875
4876 def testCreateConnectionBase(self):
4877 conn, addr = self.serv.accept()
Brian Curtin21ebbb72010-11-02 02:07:09 +00004878 self.addCleanup(conn.close)
Giampaolo Rodolàb383dbb2010-09-08 22:44:12 +00004879 data = conn.recv(1024)
4880 conn.sendall(data)
4881
4882 def _testCreateConnectionBase(self):
4883 address = self.serv.getsockname()
4884 with socket.create_connection(address) as sock:
4885 self.assertFalse(sock._closed)
4886 sock.sendall(b'foo')
4887 self.assertEqual(sock.recv(1024), b'foo')
4888 self.assertTrue(sock._closed)
4889
4890 def testCreateConnectionClose(self):
4891 conn, addr = self.serv.accept()
Brian Curtin21ebbb72010-11-02 02:07:09 +00004892 self.addCleanup(conn.close)
Giampaolo Rodolàb383dbb2010-09-08 22:44:12 +00004893 data = conn.recv(1024)
4894 conn.sendall(data)
4895
4896 def _testCreateConnectionClose(self):
4897 address = self.serv.getsockname()
4898 with socket.create_connection(address) as sock:
4899 sock.close()
4900 self.assertTrue(sock._closed)
Andrew Svetlov0832af62012-12-18 23:10:48 +02004901 self.assertRaises(OSError, sock.sendall, b'foo')
Giampaolo Rodolàb383dbb2010-09-08 22:44:12 +00004902
Antoine Pitrouacd0fda2010-10-23 17:01:44 +00004903
Victor Stinnerdaf45552013-08-28 00:53:59 +02004904class InheritanceTest(unittest.TestCase):
4905 @unittest.skipUnless(hasattr(socket, "SOCK_CLOEXEC"),
4906 "SOCK_CLOEXEC not defined")
Charles-François Natali239bb962011-06-03 12:55:15 +02004907 @support.requires_linux_version(2, 6, 28)
Antoine Pitroub1c54962010-10-14 15:05:38 +00004908 def test_SOCK_CLOEXEC(self):
Victor Stinner1d5eb342011-01-03 14:30:46 +00004909 with socket.socket(socket.AF_INET,
4910 socket.SOCK_STREAM | socket.SOCK_CLOEXEC) as s:
4911 self.assertTrue(s.type & socket.SOCK_CLOEXEC)
Victor Stinnerd39dca92013-08-28 12:28:18 +02004912 self.assertFalse(s.get_inheritable())
Victor Stinnerdaf45552013-08-28 00:53:59 +02004913
4914 def test_default_inheritable(self):
4915 sock = socket.socket()
4916 with sock:
4917 self.assertEqual(sock.get_inheritable(), False)
4918
4919 def test_dup(self):
4920 sock = socket.socket()
4921 with sock:
4922 newsock = sock.dup()
4923 sock.close()
4924 with newsock:
4925 self.assertEqual(newsock.get_inheritable(), False)
4926
4927 def test_set_inheritable(self):
4928 sock = socket.socket()
4929 with sock:
4930 sock.set_inheritable(True)
4931 self.assertEqual(sock.get_inheritable(), True)
4932
4933 sock.set_inheritable(False)
4934 self.assertEqual(sock.get_inheritable(), False)
4935
Victor Stinner4f7a36f2013-09-08 14:14:38 +02004936 @unittest.skipIf(fcntl is None, "need fcntl")
4937 def test_get_inheritable_cloexec(self):
4938 sock = socket.socket()
4939 with sock:
4940 fd = sock.fileno()
4941 self.assertEqual(sock.get_inheritable(), False)
Victor Stinnera3c18d02013-09-08 11:53:09 +02004942
Victor Stinner4f7a36f2013-09-08 14:14:38 +02004943 # clear FD_CLOEXEC flag
4944 flags = fcntl.fcntl(fd, fcntl.F_GETFD)
4945 flags &= ~fcntl.FD_CLOEXEC
4946 fcntl.fcntl(fd, fcntl.F_SETFD, flags)
Victor Stinnera3c18d02013-09-08 11:53:09 +02004947
Victor Stinner4f7a36f2013-09-08 14:14:38 +02004948 self.assertEqual(sock.get_inheritable(), True)
Victor Stinnera3c18d02013-09-08 11:53:09 +02004949
Victor Stinner4f7a36f2013-09-08 14:14:38 +02004950 @unittest.skipIf(fcntl is None, "need fcntl")
4951 def test_set_inheritable_cloexec(self):
4952 sock = socket.socket()
4953 with sock:
4954 fd = sock.fileno()
4955 self.assertEqual(fcntl.fcntl(fd, fcntl.F_GETFD) & fcntl.FD_CLOEXEC,
4956 fcntl.FD_CLOEXEC)
Victor Stinnera3c18d02013-09-08 11:53:09 +02004957
Victor Stinner4f7a36f2013-09-08 14:14:38 +02004958 sock.set_inheritable(True)
4959 self.assertEqual(fcntl.fcntl(fd, fcntl.F_GETFD) & fcntl.FD_CLOEXEC,
4960 0)
Victor Stinnera3c18d02013-09-08 11:53:09 +02004961
4962
Victor Stinnerdaf45552013-08-28 00:53:59 +02004963 @unittest.skipUnless(hasattr(socket, "socketpair"),
4964 "need socket.socketpair()")
4965 def test_socketpair(self):
4966 s1, s2 = socket.socketpair()
4967 self.addCleanup(s1.close)
4968 self.addCleanup(s2.close)
4969 self.assertEqual(s1.get_inheritable(), False)
4970 self.assertEqual(s2.get_inheritable(), False)
Antoine Pitroub1c54962010-10-14 15:05:38 +00004971
4972
4973@unittest.skipUnless(hasattr(socket, "SOCK_NONBLOCK"),
4974 "SOCK_NONBLOCK not defined")
4975class NonblockConstantTest(unittest.TestCase):
4976 def checkNonblock(self, s, nonblock=True, timeout=0.0):
4977 if nonblock:
4978 self.assertTrue(s.type & socket.SOCK_NONBLOCK)
4979 self.assertEqual(s.gettimeout(), timeout)
4980 else:
4981 self.assertFalse(s.type & socket.SOCK_NONBLOCK)
4982 self.assertEqual(s.gettimeout(), None)
4983
Charles-François Natali239bb962011-06-03 12:55:15 +02004984 @support.requires_linux_version(2, 6, 28)
Antoine Pitroub1c54962010-10-14 15:05:38 +00004985 def test_SOCK_NONBLOCK(self):
4986 # a lot of it seems silly and redundant, but I wanted to test that
4987 # changing back and forth worked ok
Victor Stinner1d5eb342011-01-03 14:30:46 +00004988 with socket.socket(socket.AF_INET,
4989 socket.SOCK_STREAM | socket.SOCK_NONBLOCK) as s:
4990 self.checkNonblock(s)
4991 s.setblocking(1)
4992 self.checkNonblock(s, False)
4993 s.setblocking(0)
4994 self.checkNonblock(s)
4995 s.settimeout(None)
4996 self.checkNonblock(s, False)
4997 s.settimeout(2.0)
4998 self.checkNonblock(s, timeout=2.0)
4999 s.setblocking(1)
5000 self.checkNonblock(s, False)
Antoine Pitroub1c54962010-10-14 15:05:38 +00005001 # defaulttimeout
5002 t = socket.getdefaulttimeout()
5003 socket.setdefaulttimeout(0.0)
Victor Stinner1d5eb342011-01-03 14:30:46 +00005004 with socket.socket() as s:
5005 self.checkNonblock(s)
Antoine Pitroub1c54962010-10-14 15:05:38 +00005006 socket.setdefaulttimeout(None)
Victor Stinner1d5eb342011-01-03 14:30:46 +00005007 with socket.socket() as s:
5008 self.checkNonblock(s, False)
Antoine Pitroub1c54962010-10-14 15:05:38 +00005009 socket.setdefaulttimeout(2.0)
Victor Stinner1d5eb342011-01-03 14:30:46 +00005010 with socket.socket() as s:
5011 self.checkNonblock(s, timeout=2.0)
Antoine Pitroub1c54962010-10-14 15:05:38 +00005012 socket.setdefaulttimeout(None)
Victor Stinner1d5eb342011-01-03 14:30:46 +00005013 with socket.socket() as s:
5014 self.checkNonblock(s, False)
Antoine Pitroub1c54962010-10-14 15:05:38 +00005015 socket.setdefaulttimeout(t)
5016
Giampaolo Rodolàb383dbb2010-09-08 22:44:12 +00005017
Kristján Valur Jónsson10f383a2012-04-07 11:23:31 +00005018@unittest.skipUnless(os.name == "nt", "Windows specific")
5019@unittest.skipUnless(multiprocessing, "need multiprocessing")
5020class TestSocketSharing(SocketTCPTest):
5021 # This must be classmethod and not staticmethod or multiprocessing
5022 # won't be able to bootstrap it.
5023 @classmethod
5024 def remoteProcessServer(cls, q):
5025 # Recreate socket from shared data
5026 sdata = q.get()
5027 message = q.get()
5028
5029 s = socket.fromshare(sdata)
5030 s2, c = s.accept()
5031
5032 # Send the message
5033 s2.sendall(message)
5034 s2.close()
5035 s.close()
5036
5037 def testShare(self):
5038 # Transfer the listening server socket to another process
5039 # and service it from there.
5040
5041 # Create process:
5042 q = multiprocessing.Queue()
5043 p = multiprocessing.Process(target=self.remoteProcessServer, args=(q,))
5044 p.start()
5045
5046 # Get the shared socket data
5047 data = self.serv.share(p.pid)
5048
5049 # Pass the shared socket to the other process
5050 addr = self.serv.getsockname()
5051 self.serv.close()
5052 q.put(data)
5053
5054 # The data that the server will send us
5055 message = b"slapmahfro"
5056 q.put(message)
5057
5058 # Connect
5059 s = socket.create_connection(addr)
5060 # listen for the data
5061 m = []
5062 while True:
5063 data = s.recv(100)
5064 if not data:
5065 break
5066 m.append(data)
5067 s.close()
5068 received = b"".join(m)
5069 self.assertEqual(received, message)
5070 p.join()
5071
5072 def testShareLength(self):
5073 data = self.serv.share(os.getpid())
5074 self.assertRaises(ValueError, socket.fromshare, data[:-1])
5075 self.assertRaises(ValueError, socket.fromshare, data+b"foo")
5076
5077 def compareSockets(self, org, other):
5078 # socket sharing is expected to work only for blocking socket
5079 # since the internal python timout value isn't transfered.
5080 self.assertEqual(org.gettimeout(), None)
5081 self.assertEqual(org.gettimeout(), other.gettimeout())
5082
5083 self.assertEqual(org.family, other.family)
5084 self.assertEqual(org.type, other.type)
5085 # If the user specified "0" for proto, then
5086 # internally windows will have picked the correct value.
5087 # Python introspection on the socket however will still return
5088 # 0. For the shared socket, the python value is recreated
5089 # from the actual value, so it may not compare correctly.
5090 if org.proto != 0:
5091 self.assertEqual(org.proto, other.proto)
5092
5093 def testShareLocal(self):
5094 data = self.serv.share(os.getpid())
5095 s = socket.fromshare(data)
5096 try:
5097 self.compareSockets(self.serv, s)
5098 finally:
5099 s.close()
5100
5101 def testTypes(self):
5102 families = [socket.AF_INET, socket.AF_INET6]
5103 types = [socket.SOCK_STREAM, socket.SOCK_DGRAM]
5104 for f in families:
5105 for t in types:
Kristján Valur Jónsson52a11f12012-04-07 20:38:44 +00005106 try:
5107 source = socket.socket(f, t)
5108 except OSError:
5109 continue # This combination is not supported
Kristján Valur Jónsson10f383a2012-04-07 11:23:31 +00005110 try:
5111 data = source.share(os.getpid())
5112 shared = socket.fromshare(data)
5113 try:
5114 self.compareSockets(source, shared)
5115 finally:
5116 shared.close()
5117 finally:
5118 source.close()
5119
5120
Guido van Rossumb995eb72002-07-31 16:08:40 +00005121def test_main():
Thomas Wouters0e3f5912006-08-11 14:57:12 +00005122 tests = [GeneralModuleTests, BasicTCPTest, TCPCloserTest, TCPTimeoutTest,
Ronald Oussoren94f25282010-05-05 19:11:21 +00005123 TestExceptions, BufferIOTest, BasicTCPTest2, BasicUDPTest, UDPTimeoutTest ]
Walter Dörwald21d3a322003-05-01 17:45:56 +00005124
5125 tests.extend([
5126 NonBlockingTCPTests,
5127 FileObjectClassTestCase,
Gregory P. Smithaafdca82010-01-04 04:50:36 +00005128 FileObjectInterruptedTestCase,
Walter Dörwald21d3a322003-05-01 17:45:56 +00005129 UnbufferedFileObjectClassTestCase,
5130 LineBufferedFileObjectClassTestCase,
Thomas Woutersb2137042007-02-01 18:02:27 +00005131 SmallBufferedFileObjectClassTestCase,
Antoine Pitrou834bd812010-10-13 16:17:14 +00005132 UnicodeReadFileObjectClassTestCase,
5133 UnicodeWriteFileObjectClassTestCase,
5134 UnicodeReadWriteFileObjectClassTestCase,
Guido van Rossumd8faa362007-04-27 19:54:29 +00005135 NetworkConnectionNoServer,
5136 NetworkConnectionAttributesTest,
5137 NetworkConnectionBehaviourTest,
Giampaolo Rodolàb383dbb2010-09-08 22:44:12 +00005138 ContextManagersTest,
Victor Stinnerdaf45552013-08-28 00:53:59 +02005139 InheritanceTest,
Antoine Pitroub1c54962010-10-14 15:05:38 +00005140 NonblockConstantTest
Walter Dörwald21d3a322003-05-01 17:45:56 +00005141 ])
Serhiy Storchaka43767632013-11-03 21:31:38 +02005142 tests.append(BasicSocketPairTest)
5143 tests.append(TestUnixDomain)
5144 tests.append(TestLinuxAbstractNamespace)
5145 tests.extend([TIPCTest, TIPCThreadableTest])
Charles-François Natali47413c12011-10-06 19:47:44 +02005146 tests.extend([BasicCANTest, CANTest])
Charles-François Natali10b8cf42011-11-10 19:21:37 +01005147 tests.extend([BasicRDSTest, RDSTest])
Nick Coghlan96fe56a2011-08-22 11:55:57 +10005148 tests.extend([
5149 CmsgMacroTests,
5150 SendmsgUDPTest,
5151 RecvmsgUDPTest,
5152 RecvmsgIntoUDPTest,
5153 SendmsgUDP6Test,
5154 RecvmsgUDP6Test,
5155 RecvmsgRFC3542AncillaryUDP6Test,
5156 RecvmsgIntoRFC3542AncillaryUDP6Test,
5157 RecvmsgIntoUDP6Test,
5158 SendmsgTCPTest,
5159 RecvmsgTCPTest,
5160 RecvmsgIntoTCPTest,
5161 SendmsgSCTPStreamTest,
5162 RecvmsgSCTPStreamTest,
5163 RecvmsgIntoSCTPStreamTest,
5164 SendmsgUnixStreamTest,
5165 RecvmsgUnixStreamTest,
5166 RecvmsgIntoUnixStreamTest,
5167 RecvmsgSCMRightsStreamTest,
5168 RecvmsgIntoSCMRightsStreamTest,
5169 # These are slow when setitimer() is not available
5170 InterruptedRecvTimeoutTest,
5171 InterruptedSendTimeoutTest,
Kristján Valur Jónsson10f383a2012-04-07 11:23:31 +00005172 TestSocketSharing,
Nick Coghlan96fe56a2011-08-22 11:55:57 +10005173 ])
Thomas Wouters0e3f5912006-08-11 14:57:12 +00005174
Benjamin Petersonee8712c2008-05-20 21:35:26 +00005175 thread_info = support.threading_setup()
5176 support.run_unittest(*tests)
5177 support.threading_cleanup(*thread_info)
Guido van Rossum24e4af82002-06-12 19:18:08 +00005178
5179if __name__ == "__main__":
Guido van Rossumb995eb72002-07-31 16:08:40 +00005180 test_main()