PageRenderTime 84ms CodeModel.GetById 15ms RepoModel.GetById 0ms app.codeStats 0ms

/Lib/test/test_socket.py

https://bitbucket.org/python_mirrors/features-pep-433
Python | 4893 lines | 4521 code | 194 blank | 178 comment | 51 complexity | 0a2ed7ce08cdc0779f884c72deda0a76 MD5 | raw file
Possible License(s): BSD-3-Clause, 0BSD
  1. #!/usr/bin/env python3
  2. import unittest
  3. from test import support
  4. from unittest.case import _ExpectedFailure
  5. import errno
  6. import io
  7. import socket
  8. import select
  9. import tempfile
  10. import _testcapi
  11. import time
  12. import traceback
  13. import queue
  14. import sys
  15. import os
  16. import array
  17. import platform
  18. import contextlib
  19. from weakref import proxy
  20. import signal
  21. import math
  22. import pickle
  23. import struct
  24. try:
  25. import multiprocessing
  26. except ImportError:
  27. multiprocessing = False
  28. HOST = support.HOST
  29. MSG = 'Michael Gilfix was here\u1234\r\n'.encode('utf-8') ## test unicode string and carriage return
  30. try:
  31. import _thread as thread
  32. import threading
  33. except ImportError:
  34. thread = None
  35. threading = None
  36. def _have_socket_can():
  37. """Check whether CAN sockets are supported on this host."""
  38. try:
  39. s = socket.socket(socket.PF_CAN, socket.SOCK_RAW, socket.CAN_RAW)
  40. except (AttributeError, OSError):
  41. return False
  42. else:
  43. s.close()
  44. return True
  45. def _have_socket_rds():
  46. """Check whether RDS sockets are supported on this host."""
  47. try:
  48. s = socket.socket(socket.PF_RDS, socket.SOCK_SEQPACKET, 0)
  49. except (AttributeError, OSError):
  50. return False
  51. else:
  52. s.close()
  53. return True
  54. HAVE_SOCKET_CAN = _have_socket_can()
  55. HAVE_SOCKET_RDS = _have_socket_rds()
  56. # Size in bytes of the int type
  57. SIZEOF_INT = array.array("i").itemsize
  58. class SocketTCPTest(unittest.TestCase):
  59. def setUp(self):
  60. self.serv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  61. self.port = support.bind_port(self.serv)
  62. self.serv.listen(1)
  63. def tearDown(self):
  64. self.serv.close()
  65. self.serv = None
  66. class SocketUDPTest(unittest.TestCase):
  67. def setUp(self):
  68. self.serv = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
  69. self.port = support.bind_port(self.serv)
  70. def tearDown(self):
  71. self.serv.close()
  72. self.serv = None
  73. class ThreadSafeCleanupTestCase(unittest.TestCase):
  74. """Subclass of unittest.TestCase with thread-safe cleanup methods.
  75. This subclass protects the addCleanup() and doCleanups() methods
  76. with a recursive lock.
  77. """
  78. if threading:
  79. def __init__(self, *args, **kwargs):
  80. super().__init__(*args, **kwargs)
  81. self._cleanup_lock = threading.RLock()
  82. def addCleanup(self, *args, **kwargs):
  83. with self._cleanup_lock:
  84. return super().addCleanup(*args, **kwargs)
  85. def doCleanups(self, *args, **kwargs):
  86. with self._cleanup_lock:
  87. return super().doCleanups(*args, **kwargs)
  88. class SocketCANTest(unittest.TestCase):
  89. """To be able to run this test, a `vcan0` CAN interface can be created with
  90. the following commands:
  91. # modprobe vcan
  92. # ip link add dev vcan0 type vcan
  93. # ifconfig vcan0 up
  94. """
  95. interface = 'vcan0'
  96. bufsize = 128
  97. def setUp(self):
  98. self.s = socket.socket(socket.PF_CAN, socket.SOCK_RAW, socket.CAN_RAW)
  99. self.addCleanup(self.s.close)
  100. try:
  101. self.s.bind((self.interface,))
  102. except OSError:
  103. self.skipTest('network interface `%s` does not exist' %
  104. self.interface)
  105. class SocketRDSTest(unittest.TestCase):
  106. """To be able to run this test, the `rds` kernel module must be loaded:
  107. # modprobe rds
  108. """
  109. bufsize = 8192
  110. def setUp(self):
  111. self.serv = socket.socket(socket.PF_RDS, socket.SOCK_SEQPACKET, 0)
  112. self.addCleanup(self.serv.close)
  113. try:
  114. self.port = support.bind_port(self.serv)
  115. except OSError:
  116. self.skipTest('unable to bind RDS socket')
  117. class ThreadableTest:
  118. """Threadable Test class
  119. The ThreadableTest class makes it easy to create a threaded
  120. client/server pair from an existing unit test. To create a
  121. new threaded class from an existing unit test, use multiple
  122. inheritance:
  123. class NewClass (OldClass, ThreadableTest):
  124. pass
  125. This class defines two new fixture functions with obvious
  126. purposes for overriding:
  127. clientSetUp ()
  128. clientTearDown ()
  129. Any new test functions within the class must then define
  130. tests in pairs, where the test name is preceeded with a
  131. '_' to indicate the client portion of the test. Ex:
  132. def testFoo(self):
  133. # Server portion
  134. def _testFoo(self):
  135. # Client portion
  136. Any exceptions raised by the clients during their tests
  137. are caught and transferred to the main thread to alert
  138. the testing framework.
  139. Note, the server setup function cannot call any blocking
  140. functions that rely on the client thread during setup,
  141. unless serverExplicitReady() is called just before
  142. the blocking call (such as in setting up a client/server
  143. connection and performing the accept() in setUp().
  144. """
  145. def __init__(self):
  146. # Swap the true setup function
  147. self.__setUp = self.setUp
  148. self.__tearDown = self.tearDown
  149. self.setUp = self._setUp
  150. self.tearDown = self._tearDown
  151. def serverExplicitReady(self):
  152. """This method allows the server to explicitly indicate that
  153. it wants the client thread to proceed. This is useful if the
  154. server is about to execute a blocking routine that is
  155. dependent upon the client thread during its setup routine."""
  156. self.server_ready.set()
  157. def _setUp(self):
  158. self.server_ready = threading.Event()
  159. self.client_ready = threading.Event()
  160. self.done = threading.Event()
  161. self.queue = queue.Queue(1)
  162. self.server_crashed = False
  163. # Do some munging to start the client test.
  164. methodname = self.id()
  165. i = methodname.rfind('.')
  166. methodname = methodname[i+1:]
  167. test_method = getattr(self, '_' + methodname)
  168. self.client_thread = thread.start_new_thread(
  169. self.clientRun, (test_method,))
  170. try:
  171. self.__setUp()
  172. except:
  173. self.server_crashed = True
  174. raise
  175. finally:
  176. self.server_ready.set()
  177. self.client_ready.wait()
  178. def _tearDown(self):
  179. self.__tearDown()
  180. self.done.wait()
  181. if self.queue.qsize():
  182. exc = self.queue.get()
  183. raise exc
  184. def clientRun(self, test_func):
  185. self.server_ready.wait()
  186. self.clientSetUp()
  187. self.client_ready.set()
  188. if self.server_crashed:
  189. self.clientTearDown()
  190. return
  191. if not hasattr(test_func, '__call__'):
  192. raise TypeError("test_func must be a callable function")
  193. try:
  194. test_func()
  195. except _ExpectedFailure:
  196. # We deliberately ignore expected failures
  197. pass
  198. except BaseException as e:
  199. self.queue.put(e)
  200. finally:
  201. self.clientTearDown()
  202. def clientSetUp(self):
  203. raise NotImplementedError("clientSetUp must be implemented.")
  204. def clientTearDown(self):
  205. self.done.set()
  206. thread.exit()
  207. class ThreadedTCPSocketTest(SocketTCPTest, ThreadableTest):
  208. def __init__(self, methodName='runTest'):
  209. SocketTCPTest.__init__(self, methodName=methodName)
  210. ThreadableTest.__init__(self)
  211. def clientSetUp(self):
  212. self.cli = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  213. def clientTearDown(self):
  214. self.cli.close()
  215. self.cli = None
  216. ThreadableTest.clientTearDown(self)
  217. class ThreadedUDPSocketTest(SocketUDPTest, ThreadableTest):
  218. def __init__(self, methodName='runTest'):
  219. SocketUDPTest.__init__(self, methodName=methodName)
  220. ThreadableTest.__init__(self)
  221. def clientSetUp(self):
  222. self.cli = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
  223. def clientTearDown(self):
  224. self.cli.close()
  225. self.cli = None
  226. ThreadableTest.clientTearDown(self)
  227. class ThreadedCANSocketTest(SocketCANTest, ThreadableTest):
  228. def __init__(self, methodName='runTest'):
  229. SocketCANTest.__init__(self, methodName=methodName)
  230. ThreadableTest.__init__(self)
  231. def clientSetUp(self):
  232. self.cli = socket.socket(socket.PF_CAN, socket.SOCK_RAW, socket.CAN_RAW)
  233. try:
  234. self.cli.bind((self.interface,))
  235. except OSError:
  236. # skipTest should not be called here, and will be called in the
  237. # server instead
  238. pass
  239. def clientTearDown(self):
  240. self.cli.close()
  241. self.cli = None
  242. ThreadableTest.clientTearDown(self)
  243. class ThreadedRDSSocketTest(SocketRDSTest, ThreadableTest):
  244. def __init__(self, methodName='runTest'):
  245. SocketRDSTest.__init__(self, methodName=methodName)
  246. ThreadableTest.__init__(self)
  247. def clientSetUp(self):
  248. self.cli = socket.socket(socket.PF_RDS, socket.SOCK_SEQPACKET, 0)
  249. try:
  250. # RDS sockets must be bound explicitly to send or receive data
  251. self.cli.bind((HOST, 0))
  252. self.cli_addr = self.cli.getsockname()
  253. except OSError:
  254. # skipTest should not be called here, and will be called in the
  255. # server instead
  256. pass
  257. def clientTearDown(self):
  258. self.cli.close()
  259. self.cli = None
  260. ThreadableTest.clientTearDown(self)
  261. class SocketConnectedTest(ThreadedTCPSocketTest):
  262. """Socket tests for client-server connection.
  263. self.cli_conn is a client socket connected to the server. The
  264. setUp() method guarantees that it is connected to the server.
  265. """
  266. def __init__(self, methodName='runTest'):
  267. ThreadedTCPSocketTest.__init__(self, methodName=methodName)
  268. def setUp(self):
  269. ThreadedTCPSocketTest.setUp(self)
  270. # Indicate explicitly we're ready for the client thread to
  271. # proceed and then perform the blocking call to accept
  272. self.serverExplicitReady()
  273. conn, addr = self.serv.accept()
  274. self.cli_conn = conn
  275. def tearDown(self):
  276. self.cli_conn.close()
  277. self.cli_conn = None
  278. ThreadedTCPSocketTest.tearDown(self)
  279. def clientSetUp(self):
  280. ThreadedTCPSocketTest.clientSetUp(self)
  281. self.cli.connect((HOST, self.port))
  282. self.serv_conn = self.cli
  283. def clientTearDown(self):
  284. self.serv_conn.close()
  285. self.serv_conn = None
  286. ThreadedTCPSocketTest.clientTearDown(self)
  287. class SocketPairTest(unittest.TestCase, ThreadableTest):
  288. def __init__(self, methodName='runTest'):
  289. unittest.TestCase.__init__(self, methodName=methodName)
  290. ThreadableTest.__init__(self)
  291. def setUp(self):
  292. self.serv, self.cli = socket.socketpair()
  293. def tearDown(self):
  294. self.serv.close()
  295. self.serv = None
  296. def clientSetUp(self):
  297. pass
  298. def clientTearDown(self):
  299. self.cli.close()
  300. self.cli = None
  301. ThreadableTest.clientTearDown(self)
  302. # The following classes are used by the sendmsg()/recvmsg() tests.
  303. # Combining, for instance, ConnectedStreamTestMixin and TCPTestBase
  304. # gives a drop-in replacement for SocketConnectedTest, but different
  305. # address families can be used, and the attributes serv_addr and
  306. # cli_addr will be set to the addresses of the endpoints.
  307. class SocketTestBase(unittest.TestCase):
  308. """A base class for socket tests.
  309. Subclasses must provide methods newSocket() to return a new socket
  310. and bindSock(sock) to bind it to an unused address.
  311. Creates a socket self.serv and sets self.serv_addr to its address.
  312. """
  313. def setUp(self):
  314. self.serv = self.newSocket()
  315. self.bindServer()
  316. def bindServer(self):
  317. """Bind server socket and set self.serv_addr to its address."""
  318. self.bindSock(self.serv)
  319. self.serv_addr = self.serv.getsockname()
  320. def tearDown(self):
  321. self.serv.close()
  322. self.serv = None
  323. class SocketListeningTestMixin(SocketTestBase):
  324. """Mixin to listen on the server socket."""
  325. def setUp(self):
  326. super().setUp()
  327. self.serv.listen(1)
  328. class ThreadedSocketTestMixin(ThreadSafeCleanupTestCase, SocketTestBase,
  329. ThreadableTest):
  330. """Mixin to add client socket and allow client/server tests.
  331. Client socket is self.cli and its address is self.cli_addr. See
  332. ThreadableTest for usage information.
  333. """
  334. def __init__(self, *args, **kwargs):
  335. super().__init__(*args, **kwargs)
  336. ThreadableTest.__init__(self)
  337. def clientSetUp(self):
  338. self.cli = self.newClientSocket()
  339. self.bindClient()
  340. def newClientSocket(self):
  341. """Return a new socket for use as client."""
  342. return self.newSocket()
  343. def bindClient(self):
  344. """Bind client socket and set self.cli_addr to its address."""
  345. self.bindSock(self.cli)
  346. self.cli_addr = self.cli.getsockname()
  347. def clientTearDown(self):
  348. self.cli.close()
  349. self.cli = None
  350. ThreadableTest.clientTearDown(self)
  351. class ConnectedStreamTestMixin(SocketListeningTestMixin,
  352. ThreadedSocketTestMixin):
  353. """Mixin to allow client/server stream tests with connected client.
  354. Server's socket representing connection to client is self.cli_conn
  355. and client's connection to server is self.serv_conn. (Based on
  356. SocketConnectedTest.)
  357. """
  358. def setUp(self):
  359. super().setUp()
  360. # Indicate explicitly we're ready for the client thread to
  361. # proceed and then perform the blocking call to accept
  362. self.serverExplicitReady()
  363. conn, addr = self.serv.accept()
  364. self.cli_conn = conn
  365. def tearDown(self):
  366. self.cli_conn.close()
  367. self.cli_conn = None
  368. super().tearDown()
  369. def clientSetUp(self):
  370. super().clientSetUp()
  371. self.cli.connect(self.serv_addr)
  372. self.serv_conn = self.cli
  373. def clientTearDown(self):
  374. self.serv_conn.close()
  375. self.serv_conn = None
  376. super().clientTearDown()
  377. class UnixSocketTestBase(SocketTestBase):
  378. """Base class for Unix-domain socket tests."""
  379. # This class is used for file descriptor passing tests, so we
  380. # create the sockets in a private directory so that other users
  381. # can't send anything that might be problematic for a privileged
  382. # user running the tests.
  383. def setUp(self):
  384. self.dir_path = tempfile.mkdtemp()
  385. self.addCleanup(os.rmdir, self.dir_path)
  386. super().setUp()
  387. def bindSock(self, sock):
  388. path = tempfile.mktemp(dir=self.dir_path)
  389. sock.bind(path)
  390. self.addCleanup(support.unlink, path)
  391. class UnixStreamBase(UnixSocketTestBase):
  392. """Base class for Unix-domain SOCK_STREAM tests."""
  393. def newSocket(self):
  394. return socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
  395. class InetTestBase(SocketTestBase):
  396. """Base class for IPv4 socket tests."""
  397. host = HOST
  398. def setUp(self):
  399. super().setUp()
  400. self.port = self.serv_addr[1]
  401. def bindSock(self, sock):
  402. support.bind_port(sock, host=self.host)
  403. class TCPTestBase(InetTestBase):
  404. """Base class for TCP-over-IPv4 tests."""
  405. def newSocket(self):
  406. return socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  407. class UDPTestBase(InetTestBase):
  408. """Base class for UDP-over-IPv4 tests."""
  409. def newSocket(self):
  410. return socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
  411. class SCTPStreamBase(InetTestBase):
  412. """Base class for SCTP tests in one-to-one (SOCK_STREAM) mode."""
  413. def newSocket(self):
  414. return socket.socket(socket.AF_INET, socket.SOCK_STREAM,
  415. socket.IPPROTO_SCTP)
  416. class Inet6TestBase(InetTestBase):
  417. """Base class for IPv6 socket tests."""
  418. # Don't use "localhost" here - it may not have an IPv6 address
  419. # assigned to it by default (e.g. in /etc/hosts), and if someone
  420. # has assigned it an IPv4-mapped address, then it's unlikely to
  421. # work with the full IPv6 API.
  422. host = "::1"
  423. class UDP6TestBase(Inet6TestBase):
  424. """Base class for UDP-over-IPv6 tests."""
  425. def newSocket(self):
  426. return socket.socket(socket.AF_INET6, socket.SOCK_DGRAM)
  427. # Test-skipping decorators for use with ThreadableTest.
  428. def skipWithClientIf(condition, reason):
  429. """Skip decorated test if condition is true, add client_skip decorator.
  430. If the decorated object is not a class, sets its attribute
  431. "client_skip" to a decorator which will return an empty function
  432. if the test is to be skipped, or the original function if it is
  433. not. This can be used to avoid running the client part of a
  434. skipped test when using ThreadableTest.
  435. """
  436. def client_pass(*args, **kwargs):
  437. pass
  438. def skipdec(obj):
  439. retval = unittest.skip(reason)(obj)
  440. if not isinstance(obj, type):
  441. retval.client_skip = lambda f: client_pass
  442. return retval
  443. def noskipdec(obj):
  444. if not (isinstance(obj, type) or hasattr(obj, "client_skip")):
  445. obj.client_skip = lambda f: f
  446. return obj
  447. return skipdec if condition else noskipdec
  448. def requireAttrs(obj, *attributes):
  449. """Skip decorated test if obj is missing any of the given attributes.
  450. Sets client_skip attribute as skipWithClientIf() does.
  451. """
  452. missing = [name for name in attributes if not hasattr(obj, name)]
  453. return skipWithClientIf(
  454. missing, "don't have " + ", ".join(name for name in missing))
  455. def requireSocket(*args):
  456. """Skip decorated test if a socket cannot be created with given arguments.
  457. When an argument is given as a string, will use the value of that
  458. attribute of the socket module, or skip the test if it doesn't
  459. exist. Sets client_skip attribute as skipWithClientIf() does.
  460. """
  461. err = None
  462. missing = [obj for obj in args if
  463. isinstance(obj, str) and not hasattr(socket, obj)]
  464. if missing:
  465. err = "don't have " + ", ".join(name for name in missing)
  466. else:
  467. callargs = [getattr(socket, obj) if isinstance(obj, str) else obj
  468. for obj in args]
  469. try:
  470. s = socket.socket(*callargs)
  471. except OSError as e:
  472. # XXX: check errno?
  473. err = str(e)
  474. else:
  475. s.close()
  476. return skipWithClientIf(
  477. err is not None,
  478. "can't create socket({0}): {1}".format(
  479. ", ".join(str(o) for o in args), err))
  480. #######################################################################
  481. ## Begin Tests
  482. class GeneralModuleTests(unittest.TestCase):
  483. def test_repr(self):
  484. s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  485. self.addCleanup(s.close)
  486. self.assertTrue(repr(s).startswith("<socket.socket object"))
  487. def test_weakref(self):
  488. s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  489. p = proxy(s)
  490. self.assertEqual(p.fileno(), s.fileno())
  491. s.close()
  492. s = None
  493. try:
  494. p.fileno()
  495. except ReferenceError:
  496. pass
  497. else:
  498. self.fail('Socket proxy still exists')
  499. def testSocketError(self):
  500. # Testing socket module exceptions
  501. msg = "Error raising socket exception (%s)."
  502. with self.assertRaises(OSError, msg=msg % 'OSError'):
  503. raise OSError
  504. with self.assertRaises(OSError, msg=msg % 'socket.herror'):
  505. raise socket.herror
  506. with self.assertRaises(OSError, msg=msg % 'socket.gaierror'):
  507. raise socket.gaierror
  508. def testSendtoErrors(self):
  509. # Testing that sendto doens't masks failures. See #10169.
  510. s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
  511. self.addCleanup(s.close)
  512. s.bind(('', 0))
  513. sockname = s.getsockname()
  514. # 2 args
  515. with self.assertRaises(TypeError) as cm:
  516. s.sendto('\u2620', sockname)
  517. self.assertEqual(str(cm.exception),
  518. "'str' does not support the buffer interface")
  519. with self.assertRaises(TypeError) as cm:
  520. s.sendto(5j, sockname)
  521. self.assertEqual(str(cm.exception),
  522. "'complex' does not support the buffer interface")
  523. with self.assertRaises(TypeError) as cm:
  524. s.sendto(b'foo', None)
  525. self.assertIn('not NoneType',str(cm.exception))
  526. # 3 args
  527. with self.assertRaises(TypeError) as cm:
  528. s.sendto('\u2620', 0, sockname)
  529. self.assertEqual(str(cm.exception),
  530. "'str' does not support the buffer interface")
  531. with self.assertRaises(TypeError) as cm:
  532. s.sendto(5j, 0, sockname)
  533. self.assertEqual(str(cm.exception),
  534. "'complex' does not support the buffer interface")
  535. with self.assertRaises(TypeError) as cm:
  536. s.sendto(b'foo', 0, None)
  537. self.assertIn('not NoneType', str(cm.exception))
  538. with self.assertRaises(TypeError) as cm:
  539. s.sendto(b'foo', 'bar', sockname)
  540. self.assertIn('an integer is required', str(cm.exception))
  541. with self.assertRaises(TypeError) as cm:
  542. s.sendto(b'foo', None, None)
  543. self.assertIn('an integer is required', str(cm.exception))
  544. # wrong number of args
  545. with self.assertRaises(TypeError) as cm:
  546. s.sendto(b'foo')
  547. self.assertIn('(1 given)', str(cm.exception))
  548. with self.assertRaises(TypeError) as cm:
  549. s.sendto(b'foo', 0, sockname, 4)
  550. self.assertIn('(4 given)', str(cm.exception))
  551. def testCrucialConstants(self):
  552. # Testing for mission critical constants
  553. socket.AF_INET
  554. socket.SOCK_STREAM
  555. socket.SOCK_DGRAM
  556. socket.SOCK_RAW
  557. socket.SOCK_RDM
  558. socket.SOCK_SEQPACKET
  559. socket.SOL_SOCKET
  560. socket.SO_REUSEADDR
  561. def testHostnameRes(self):
  562. # Testing hostname resolution mechanisms
  563. hostname = socket.gethostname()
  564. try:
  565. ip = socket.gethostbyname(hostname)
  566. except OSError:
  567. # Probably name lookup wasn't set up right; skip this test
  568. return
  569. self.assertTrue(ip.find('.') >= 0, "Error resolving host to ip.")
  570. try:
  571. hname, aliases, ipaddrs = socket.gethostbyaddr(ip)
  572. except OSError:
  573. # Probably a similar problem as above; skip this test
  574. return
  575. all_host_names = [hostname, hname] + aliases
  576. fqhn = socket.getfqdn(ip)
  577. if not fqhn in all_host_names:
  578. self.fail("Error testing host resolution mechanisms. (fqdn: %s, all: %s)" % (fqhn, repr(all_host_names)))
  579. @unittest.skipUnless(hasattr(socket, 'sethostname'), "test needs socket.sethostname()")
  580. @unittest.skipUnless(hasattr(socket, 'gethostname'), "test needs socket.gethostname()")
  581. def test_sethostname(self):
  582. oldhn = socket.gethostname()
  583. try:
  584. socket.sethostname('new')
  585. except OSError as e:
  586. if e.errno == errno.EPERM:
  587. self.skipTest("test should be run as root")
  588. else:
  589. raise
  590. try:
  591. # running test as root!
  592. self.assertEqual(socket.gethostname(), 'new')
  593. # Should work with bytes objects too
  594. socket.sethostname(b'bar')
  595. self.assertEqual(socket.gethostname(), 'bar')
  596. finally:
  597. socket.sethostname(oldhn)
  598. @unittest.skipUnless(hasattr(socket, 'if_nameindex'),
  599. 'socket.if_nameindex() not available.')
  600. def testInterfaceNameIndex(self):
  601. interfaces = socket.if_nameindex()
  602. for index, name in interfaces:
  603. self.assertIsInstance(index, int)
  604. self.assertIsInstance(name, str)
  605. # interface indices are non-zero integers
  606. self.assertGreater(index, 0)
  607. _index = socket.if_nametoindex(name)
  608. self.assertIsInstance(_index, int)
  609. self.assertEqual(index, _index)
  610. _name = socket.if_indextoname(index)
  611. self.assertIsInstance(_name, str)
  612. self.assertEqual(name, _name)
  613. @unittest.skipUnless(hasattr(socket, 'if_nameindex'),
  614. 'socket.if_nameindex() not available.')
  615. def testInvalidInterfaceNameIndex(self):
  616. # test nonexistent interface index/name
  617. self.assertRaises(OSError, socket.if_indextoname, 0)
  618. self.assertRaises(OSError, socket.if_nametoindex, '_DEADBEEF')
  619. # test with invalid values
  620. self.assertRaises(TypeError, socket.if_nametoindex, 0)
  621. self.assertRaises(TypeError, socket.if_indextoname, '_DEADBEEF')
  622. def testRefCountGetNameInfo(self):
  623. # Testing reference count for getnameinfo
  624. if hasattr(sys, "getrefcount"):
  625. try:
  626. # On some versions, this loses a reference
  627. orig = sys.getrefcount(__name__)
  628. socket.getnameinfo(__name__,0)
  629. except TypeError:
  630. if sys.getrefcount(__name__) != orig:
  631. self.fail("socket.getnameinfo loses a reference")
  632. def testInterpreterCrash(self):
  633. # Making sure getnameinfo doesn't crash the interpreter
  634. try:
  635. # On some versions, this crashes the interpreter.
  636. socket.getnameinfo(('x', 0, 0, 0), 0)
  637. except OSError:
  638. pass
  639. def testNtoH(self):
  640. # This just checks that htons etc. are their own inverse,
  641. # when looking at the lower 16 or 32 bits.
  642. sizes = {socket.htonl: 32, socket.ntohl: 32,
  643. socket.htons: 16, socket.ntohs: 16}
  644. for func, size in sizes.items():
  645. mask = (1<<size) - 1
  646. for i in (0, 1, 0xffff, ~0xffff, 2, 0x01234567, 0x76543210):
  647. self.assertEqual(i & mask, func(func(i&mask)) & mask)
  648. swapped = func(mask)
  649. self.assertEqual(swapped & mask, mask)
  650. self.assertRaises(OverflowError, func, 1<<34)
  651. def testNtoHErrors(self):
  652. good_values = [ 1, 2, 3, 1, 2, 3 ]
  653. bad_values = [ -1, -2, -3, -1, -2, -3 ]
  654. for k in good_values:
  655. socket.ntohl(k)
  656. socket.ntohs(k)
  657. socket.htonl(k)
  658. socket.htons(k)
  659. for k in bad_values:
  660. self.assertRaises(OverflowError, socket.ntohl, k)
  661. self.assertRaises(OverflowError, socket.ntohs, k)
  662. self.assertRaises(OverflowError, socket.htonl, k)
  663. self.assertRaises(OverflowError, socket.htons, k)
  664. def testGetServBy(self):
  665. eq = self.assertEqual
  666. # Find one service that exists, then check all the related interfaces.
  667. # I've ordered this by protocols that have both a tcp and udp
  668. # protocol, at least for modern Linuxes.
  669. if (sys.platform.startswith(('freebsd', 'netbsd'))
  670. or sys.platform in ('linux', 'darwin')):
  671. # avoid the 'echo' service on this platform, as there is an
  672. # assumption breaking non-standard port/protocol entry
  673. services = ('daytime', 'qotd', 'domain')
  674. else:
  675. services = ('echo', 'daytime', 'domain')
  676. for service in services:
  677. try:
  678. port = socket.getservbyname(service, 'tcp')
  679. break
  680. except OSError:
  681. pass
  682. else:
  683. raise OSError
  684. # Try same call with optional protocol omitted
  685. port2 = socket.getservbyname(service)
  686. eq(port, port2)
  687. # Try udp, but don't barf it it doesn't exist
  688. try:
  689. udpport = socket.getservbyname(service, 'udp')
  690. except OSError:
  691. udpport = None
  692. else:
  693. eq(udpport, port)
  694. # Now make sure the lookup by port returns the same service name
  695. eq(socket.getservbyport(port2), service)
  696. eq(socket.getservbyport(port, 'tcp'), service)
  697. if udpport is not None:
  698. eq(socket.getservbyport(udpport, 'udp'), service)
  699. # Make sure getservbyport does not accept out of range ports.
  700. self.assertRaises(OverflowError, socket.getservbyport, -1)
  701. self.assertRaises(OverflowError, socket.getservbyport, 65536)
  702. def testDefaultTimeout(self):
  703. # Testing default timeout
  704. # The default timeout should initially be None
  705. self.assertEqual(socket.getdefaulttimeout(), None)
  706. s = socket.socket()
  707. self.assertEqual(s.gettimeout(), None)
  708. s.close()
  709. # Set the default timeout to 10, and see if it propagates
  710. socket.setdefaulttimeout(10)
  711. self.assertEqual(socket.getdefaulttimeout(), 10)
  712. s = socket.socket()
  713. self.assertEqual(s.gettimeout(), 10)
  714. s.close()
  715. # Reset the default timeout to None, and see if it propagates
  716. socket.setdefaulttimeout(None)
  717. self.assertEqual(socket.getdefaulttimeout(), None)
  718. s = socket.socket()
  719. self.assertEqual(s.gettimeout(), None)
  720. s.close()
  721. # Check that setting it to an invalid value raises ValueError
  722. self.assertRaises(ValueError, socket.setdefaulttimeout, -1)
  723. # Check that setting it to an invalid type raises TypeError
  724. self.assertRaises(TypeError, socket.setdefaulttimeout, "spam")
  725. def testIPv4_inet_aton_fourbytes(self):
  726. if not hasattr(socket, 'inet_aton'):
  727. return # No inet_aton, nothing to check
  728. # Test that issue1008086 and issue767150 are fixed.
  729. # It must return 4 bytes.
  730. self.assertEqual(b'\x00'*4, socket.inet_aton('0.0.0.0'))
  731. self.assertEqual(b'\xff'*4, socket.inet_aton('255.255.255.255'))
  732. def testIPv4toString(self):
  733. if not hasattr(socket, 'inet_pton'):
  734. return # No inet_pton() on this platform
  735. from socket import inet_aton as f, inet_pton, AF_INET
  736. g = lambda a: inet_pton(AF_INET, a)
  737. assertInvalid = lambda func,a: self.assertRaises(
  738. (OSError, ValueError), func, a
  739. )
  740. self.assertEqual(b'\x00\x00\x00\x00', f('0.0.0.0'))
  741. self.assertEqual(b'\xff\x00\xff\x00', f('255.0.255.0'))
  742. self.assertEqual(b'\xaa\xaa\xaa\xaa', f('170.170.170.170'))
  743. self.assertEqual(b'\x01\x02\x03\x04', f('1.2.3.4'))
  744. self.assertEqual(b'\xff\xff\xff\xff', f('255.255.255.255'))
  745. assertInvalid(f, '0.0.0.')
  746. assertInvalid(f, '300.0.0.0')
  747. assertInvalid(f, 'a.0.0.0')
  748. assertInvalid(f, '1.2.3.4.5')
  749. assertInvalid(f, '::1')
  750. self.assertEqual(b'\x00\x00\x00\x00', g('0.0.0.0'))
  751. self.assertEqual(b'\xff\x00\xff\x00', g('255.0.255.0'))
  752. self.assertEqual(b'\xaa\xaa\xaa\xaa', g('170.170.170.170'))
  753. self.assertEqual(b'\xff\xff\xff\xff', g('255.255.255.255'))
  754. assertInvalid(g, '0.0.0.')
  755. assertInvalid(g, '300.0.0.0')
  756. assertInvalid(g, 'a.0.0.0')
  757. assertInvalid(g, '1.2.3.4.5')
  758. assertInvalid(g, '::1')
  759. def testIPv6toString(self):
  760. if not hasattr(socket, 'inet_pton'):
  761. return # No inet_pton() on this platform
  762. try:
  763. from socket import inet_pton, AF_INET6, has_ipv6
  764. if not has_ipv6:
  765. return
  766. except ImportError:
  767. return
  768. f = lambda a: inet_pton(AF_INET6, a)
  769. assertInvalid = lambda a: self.assertRaises(
  770. (OSError, ValueError), f, a
  771. )
  772. self.assertEqual(b'\x00' * 16, f('::'))
  773. self.assertEqual(b'\x00' * 16, f('0::0'))
  774. self.assertEqual(b'\x00\x01' + b'\x00' * 14, f('1::'))
  775. self.assertEqual(
  776. b'\x45\xef\x76\xcb\x00\x1a\x56\xef\xaf\xeb\x0b\xac\x19\x24\xae\xae',
  777. f('45ef:76cb:1a:56ef:afeb:bac:1924:aeae')
  778. )
  779. self.assertEqual(
  780. b'\xad\x42\x0a\xbc' + b'\x00' * 4 + b'\x01\x27\x00\x00\x02\x54\x00\x02',
  781. f('ad42:abc::127:0:254:2')
  782. )
  783. self.assertEqual(b'\x00\x12\x00\x0a' + b'\x00' * 12, f('12:a::'))
  784. assertInvalid('0x20::')
  785. assertInvalid(':::')
  786. assertInvalid('::0::')
  787. assertInvalid('1::abc::')
  788. assertInvalid('1::abc::def')
  789. assertInvalid('1:2:3:4:5:6:')
  790. assertInvalid('1:2:3:4:5:6')
  791. assertInvalid('1:2:3:4:5:6:7:8:')
  792. assertInvalid('1:2:3:4:5:6:7:8:0')
  793. self.assertEqual(b'\x00' * 12 + b'\xfe\x2a\x17\x40',
  794. f('::254.42.23.64')
  795. )
  796. self.assertEqual(
  797. b'\x00\x42' + b'\x00' * 8 + b'\xa2\x9b\xfe\x2a\x17\x40',
  798. f('42::a29b:254.42.23.64')
  799. )
  800. self.assertEqual(
  801. b'\x00\x42\xa8\xb9\x00\x00\x00\x02\xff\xff\xa2\x9b\xfe\x2a\x17\x40',
  802. f('42:a8b9:0:2:ffff:a29b:254.42.23.64')
  803. )
  804. assertInvalid('255.254.253.252')
  805. assertInvalid('1::260.2.3.0')
  806. assertInvalid('1::0.be.e.0')
  807. assertInvalid('1:2:3:4:5:6:7:1.2.3.4')
  808. assertInvalid('::1.2.3.4:0')
  809. assertInvalid('0.100.200.0:3:4:5:6:7:8')
  810. def testStringToIPv4(self):
  811. if not hasattr(socket, 'inet_ntop'):
  812. return # No inet_ntop() on this platform
  813. from socket import inet_ntoa as f, inet_ntop, AF_INET
  814. g = lambda a: inet_ntop(AF_INET, a)
  815. assertInvalid = lambda func,a: self.assertRaises(
  816. (OSError, ValueError), func, a
  817. )
  818. self.assertEqual('1.0.1.0', f(b'\x01\x00\x01\x00'))
  819. self.assertEqual('170.85.170.85', f(b'\xaa\x55\xaa\x55'))
  820. self.assertEqual('255.255.255.255', f(b'\xff\xff\xff\xff'))
  821. self.assertEqual('1.2.3.4', f(b'\x01\x02\x03\x04'))
  822. assertInvalid(f, b'\x00' * 3)
  823. assertInvalid(f, b'\x00' * 5)
  824. assertInvalid(f, b'\x00' * 16)
  825. self.assertEqual('1.0.1.0', g(b'\x01\x00\x01\x00'))
  826. self.assertEqual('170.85.170.85', g(b'\xaa\x55\xaa\x55'))
  827. self.assertEqual('255.255.255.255', g(b'\xff\xff\xff\xff'))
  828. assertInvalid(g, b'\x00' * 3)
  829. assertInvalid(g, b'\x00' * 5)
  830. assertInvalid(g, b'\x00' * 16)
  831. def testStringToIPv6(self):
  832. if not hasattr(socket, 'inet_ntop'):
  833. return # No inet_ntop() on this platform
  834. try:
  835. from socket import inet_ntop, AF_INET6, has_ipv6
  836. if not has_ipv6:
  837. return
  838. except ImportError:
  839. return
  840. f = lambda a: inet_ntop(AF_INET6, a)
  841. assertInvalid = lambda a: self.assertRaises(
  842. (OSError, ValueError), f, a
  843. )
  844. self.assertEqual('::', f(b'\x00' * 16))
  845. self.assertEqual('::1', f(b'\x00' * 15 + b'\x01'))
  846. self.assertEqual(
  847. 'aef:b01:506:1001:ffff:9997:55:170',
  848. f(b'\x0a\xef\x0b\x01\x05\x06\x10\x01\xff\xff\x99\x97\x00\x55\x01\x70')
  849. )
  850. assertInvalid(b'\x12' * 15)
  851. assertInvalid(b'\x12' * 17)
  852. assertInvalid(b'\x12' * 4)
  853. # XXX The following don't test module-level functionality...
  854. def testSockName(self):
  855. # Testing getsockname()
  856. port = support.find_unused_port()
  857. sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  858. self.addCleanup(sock.close)
  859. sock.bind(("0.0.0.0", port))
  860. name = sock.getsockname()
  861. # XXX(nnorwitz): http://tinyurl.com/os5jz seems to indicate
  862. # it reasonable to get the host's addr in addition to 0.0.0.0.
  863. # At least for eCos. This is required for the S/390 to pass.
  864. try:
  865. my_ip_addr = socket.gethostbyname(socket.gethostname())
  866. except OSError:
  867. # Probably name lookup wasn't set up right; skip this test
  868. return
  869. self.assertIn(name[0], ("0.0.0.0", my_ip_addr), '%s invalid' % name[0])
  870. self.assertEqual(name[1], port)
  871. def testGetSockOpt(self):
  872. # Testing getsockopt()
  873. # We know a socket should start without reuse==0
  874. sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  875. self.addCleanup(sock.close)
  876. reuse = sock.getsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR)
  877. self.assertFalse(reuse != 0, "initial mode is reuse")
  878. def testSetSockOpt(self):
  879. # Testing setsockopt()
  880. sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  881. self.addCleanup(sock.close)
  882. sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
  883. reuse = sock.getsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR)
  884. self.assertFalse(reuse == 0, "failed to set reuse mode")
  885. def testSendAfterClose(self):
  886. # testing send() after close() with timeout
  887. sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  888. sock.settimeout(1)
  889. sock.close()
  890. self.assertRaises(OSError, sock.send, b"spam")
  891. def testNewAttributes(self):
  892. # testing .family, .type and .protocol
  893. sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM, cloexec=False)
  894. self.assertEqual(sock.family, socket.AF_INET)
  895. self.assertEqual(sock.type, socket.SOCK_STREAM)
  896. self.assertEqual(sock.proto, 0)
  897. sock.close()
  898. def test_getsockaddrarg(self):
  899. host = '0.0.0.0'
  900. port = support.find_unused_port()
  901. big_port = port + 65536
  902. neg_port = port - 65536
  903. sock = socket.socket()
  904. try:
  905. self.assertRaises(OverflowError, sock.bind, (host, big_port))
  906. self.assertRaises(OverflowError, sock.bind, (host, neg_port))
  907. sock.bind((host, port))
  908. finally:
  909. sock.close()
  910. @unittest.skipUnless(os.name == "nt", "Windows specific")
  911. def test_sock_ioctl(self):
  912. self.assertTrue(hasattr(socket.socket, 'ioctl'))
  913. self.assertTrue(hasattr(socket, 'SIO_RCVALL'))
  914. self.assertTrue(hasattr(socket, 'RCVALL_ON'))
  915. self.assertTrue(hasattr(socket, 'RCVALL_OFF'))
  916. self.assertTrue(hasattr(socket, 'SIO_KEEPALIVE_VALS'))
  917. s = socket.socket()
  918. self.addCleanup(s.close)
  919. self.assertRaises(ValueError, s.ioctl, -1, None)
  920. s.ioctl(socket.SIO_KEEPALIVE_VALS, (1, 100, 100))
  921. def testGetaddrinfo(self):
  922. try:
  923. socket.getaddrinfo('localhost', 80)
  924. except socket.gaierror as err:
  925. if err.errno == socket.EAI_SERVICE:
  926. # see http://bugs.python.org/issue1282647
  927. self.skipTest("buggy libc version")
  928. raise
  929. # len of every sequence is supposed to be == 5
  930. for info in socket.getaddrinfo(HOST, None):
  931. self.assertEqual(len(info), 5)
  932. # host can be a domain name, a string representation of an
  933. # IPv4/v6 address or None
  934. socket.getaddrinfo('localhost', 80)
  935. socket.getaddrinfo('127.0.0.1', 80)
  936. socket.getaddrinfo(None, 80)
  937. if support.IPV6_ENABLED:
  938. socket.getaddrinfo('::1', 80)
  939. # port can be a string service name such as "http", a numeric
  940. # port number or None
  941. socket.getaddrinfo(HOST, "http")
  942. socket.getaddrinfo(HOST, 80)
  943. socket.getaddrinfo(HOST, None)
  944. # test family and socktype filters
  945. infos = socket.getaddrinfo(HOST, None, socket.AF_INET)
  946. for family, _, _, _, _ in infos:
  947. self.assertEqual(family, socket.AF_INET)
  948. infos = socket.getaddrinfo(HOST, None, 0, socket.SOCK_STREAM)
  949. for _, socktype, _, _, _ in infos:
  950. self.assertEqual(socktype, socket.SOCK_STREAM)
  951. # test proto and flags arguments
  952. socket.getaddrinfo(HOST, None, 0, 0, socket.SOL_TCP)
  953. socket.getaddrinfo(HOST, None, 0, 0, 0, socket.AI_PASSIVE)
  954. # a server willing to support both IPv4 and IPv6 will
  955. # usually do this
  956. socket.getaddrinfo(None, 0, socket.AF_UNSPEC, socket.SOCK_STREAM, 0,
  957. socket.AI_PASSIVE)
  958. # test keyword arguments
  959. a = socket.getaddrinfo(HOST, None)
  960. b = socket.getaddrinfo(host=HOST, port=None)
  961. self.assertEqual(a, b)
  962. a = socket.getaddrinfo(HOST, None, socket.AF_INET)
  963. b = socket.getaddrinfo(HOST, None, family=socket.AF_INET)
  964. self.assertEqual(a, b)
  965. a = socket.getaddrinfo(HOST, None, 0, socket.SOCK_STREAM)
  966. b = socket.getaddrinfo(HOST, None, type=socket.SOCK_STREAM)
  967. self.assertEqual(a, b)
  968. a = socket.getaddrinfo(HOST, None, 0, 0, socket.SOL_TCP)
  969. b = socket.getaddrinfo(HOST, None, proto=socket.SOL_TCP)
  970. self.assertEqual(a, b)
  971. a = socket.getaddrinfo(HOST, None, 0, 0, 0, socket.AI_PASSIVE)
  972. b = socket.getaddrinfo(HOST, None, flags=socket.AI_PASSIVE)
  973. self.assertEqual(a, b)
  974. a = socket.getaddrinfo(None, 0, socket.AF_UNSPEC, socket.SOCK_STREAM, 0,
  975. socket.AI_PASSIVE)
  976. b = socket.getaddrinfo(host=None, port=0, family=socket.AF_UNSPEC,
  977. type=socket.SOCK_STREAM, proto=0,
  978. flags=socket.AI_PASSIVE)
  979. self.assertEqual(a, b)
  980. # Issue #6697.
  981. self.assertRaises(UnicodeEncodeError, socket.getaddrinfo, 'localhost', '\uD800')
  982. def test_getnameinfo(self):
  983. # only IP addresses are allowed
  984. self.assertRaises(OSError, socket.getnameinfo, ('mail.python.org',0), 0)
  985. @unittest.skipUnless(support.is_resource_enabled('network'),
  986. 'network is not enabled')
  987. def test_idna(self):
  988. # Check for internet access before running test (issue #12804).
  989. try:
  990. socket.gethostbyname('python.org')
  991. except socket.gaierror as e:
  992. if e.errno == socket.EAI_NODATA:
  993. self.skipTest('internet access required for this test')
  994. # these should all be successful
  995. socket.gethostbyname('испытание.python.org')
  996. socket.gethostbyname_ex('испытание.python.org')
  997. socket.getaddrinfo('испытание.python.org',0,socket.AF_UNSPEC,socket.SOCK_STREAM)
  998. # this may not work if the forward lookup choses the IPv6 address, as that doesn't
  999. # have a reverse entry yet
  1000. # socket.gethostbyaddr('испытание.python.org')
  1001. def check_sendall_interrupted(self, with_timeout):
  1002. # socketpair() is not stricly required, but it makes things easier.
  1003. if not hasattr(signal, 'alarm') or not hasattr(socket, 'socketpair'):
  1004. self.skipTest("signal.alarm and socket.socketpair required for this test")
  1005. # Our signal handlers clobber the C errno by calling a math function
  1006. # with an invalid domain value.
  1007. def ok_handler(*args):
  1008. self.assertRaises(ValueError, math.acosh, 0)
  1009. def raising_handler(*args):
  1010. self.assertRaises(ValueError, math.acosh, 0)
  1011. 1 // 0
  1012. c, s = socket.socketpair()
  1013. old_alarm = signal.signal(signal.SIGALRM, raising_handler)
  1014. try:
  1015. if with_timeout:
  1016. # Just above the one second minimum for signal.alarm
  1017. c.settimeout(1.5)
  1018. with self.assertRaises(ZeroDivisionError):
  1019. signal.alarm(1)
  1020. c.sendall(b"x" * (1024**2))
  1021. if with_timeout:
  1022. signal.signal(signal.SIGALRM, ok_handler)
  1023. signal.alarm(1)
  1024. self.assertRaises(socket.timeout, c.sendall, b"x" * (1024**2))
  1025. finally:
  1026. signal.signal(signal.SIGALRM, old_alarm)
  1027. c.close()
  1028. s.close()
  1029. def test_sendall_interrupted(self):
  1030. self.check_sendall_interrupted(False)
  1031. def test_sendall_interrupted_with_timeout(self):
  1032. self.check_sendall_interrupted(True)
  1033. def test_dealloc_warn(self):
  1034. sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  1035. r = repr(sock)
  1036. with self.assertWarns(ResourceWarning) as cm:
  1037. sock = None
  1038. support.gc_collect()
  1039. self.assertIn(r, str(cm.warning.args[0]))
  1040. # An open socket file object gets dereferenced after the socket
  1041. sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  1042. f = sock.makefile('rb')
  1043. r = repr(sock)
  1044. sock = None
  1045. support.gc_collect()
  1046. with self.assertWarns(ResourceWarning):
  1047. f = None
  1048. support.gc_collect()
  1049. def test_name_closed_socketio(self):
  1050. with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
  1051. fp = sock.makefile("rb")
  1052. fp.close()
  1053. self.assertEqual(repr(fp), "<_io.BufferedReader name=-1>")
  1054. def test_unusable_closed_socketio(self):
  1055. with socket.socket() as sock:
  1056. fp = sock.makefile("rb", buffering=0)
  1057. self.assertTrue(fp.readable())
  1058. self.assertFalse(fp.writable())
  1059. self.assertFalse(fp.seekable())
  1060. fp.close()
  1061. self.assertRaises(ValueError, fp.readable)
  1062. self.assertRaises(ValueError, fp.writable)
  1063. self.assertRaises(ValueError, fp.seekable)
  1064. def test_pickle(self):
  1065. sock = socket.socket()
  1066. with sock:
  1067. for protocol in range(pickle.HIGHEST_PROTOCOL + 1):
  1068. self.assertRaises(TypeError, pickle.dumps, sock, protocol)
  1069. def test_listen_backlog(self):
  1070. for backlog in 0, -1:
  1071. srv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  1072. srv.bind((HOST, 0))
  1073. srv.listen(backlog)
  1074. srv.close()
  1075. # Issue 15989
  1076. srv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  1077. srv.bind((HOST, 0))
  1078. self.assertRaises(OverflowError, srv.listen, _testcapi.INT_MAX + 1)
  1079. srv.close()
  1080. @unittest.skipUnless(support.IPV6_ENABLED, 'IPv6 required for this test.')
  1081. def test_flowinfo(self):
  1082. self.assertRaises(OverflowError, socket.getnameinfo,
  1083. ('::1',0, 0xffffffff), 0)
  1084. with socket.socket(socket.AF_INET6, socket.SOCK_STREAM) as s:
  1085. self.assertRaises(OverflowError, s.bind, ('::1', 0, -10))
  1086. @unittest.skipUnless(HAVE_SOCKET_CAN, 'SocketCan required for this test.')
  1087. class BasicCANTest(unittest.TestCase):
  1088. def testCrucialConstants(self):
  1089. socket.AF_CAN
  1090. socket.PF_CAN
  1091. socket.CAN_RAW
  1092. def testCreateSocket(self):
  1093. with socket.socket(socket.PF_CAN, socket.SOCK_RAW, socket.CAN_RAW) as s:
  1094. pass
  1095. def testBindAny(self):
  1096. with socket.socket(socket.PF_CAN, socket.SOCK_RAW, socket.CAN_RAW) as s:
  1097. s.bind(('', ))
  1098. def testTooLongInterfaceName(self):
  1099. # most systems limit IFNAMSIZ to 16, take 1024 to be sure
  1100. with socket.socket(socket.PF_CAN, socket.SOCK_RAW, socket.CAN_RAW) as s:
  1101. self.assertRaisesRegex(OSError, 'interface name too long',
  1102. s.bind, ('x' * 1024,))
  1103. @unittest.skipUnless(hasattr(socket, "CAN_RAW_LOOPBACK"),
  1104. 'socket.CAN_RAW_LOOPBACK required for this test.')
  1105. def testLoopback(self):
  1106. with socket.socket(socket.PF_CAN, socket.SOCK_RAW, socket.CAN_RAW) as s:
  1107. for loopback in (0, 1):
  1108. s.setsockopt(socket.SOL_CAN_RAW, socket.CAN_RAW_LOOPBACK,
  1109. loopback)
  1110. self.assertEqual(loopback,
  1111. s.getsockopt(socket.SOL_CAN_RAW, socket.CAN_RAW_LOOPBACK))
  1112. @unittest.skipUnless(hasattr(socket, "CAN_RAW_FILTER"),
  1113. 'socket.CAN_RAW_FILTER required for this test.')
  1114. def testFilter(self):
  1115. can_id, can_mask = 0x200, 0x700
  1116. can_filter = struct.pack("=II", can_id, can_mask)
  1117. with socket.socket(socket.PF_CAN, socket.SOCK_RAW, socket.CAN_RAW) as s:
  1118. s.setsockopt(socket.SOL_CAN_RAW, socket.CAN_RAW_FILTER, can_filter)
  1119. self.assertEqual(can_filter,
  1120. s.getsockopt(socket.SOL_CAN_RAW, socket.CAN_RAW_FILTER, 8))
  1121. @unittest.skipUnless(HAVE_SOCKET_CAN, 'SocketCan required for this test.')
  1122. @unittest.skipUnless(thread, 'Threading required for this test.')
  1123. class CANTest(ThreadedCANSocketTest):
  1124. """The CAN frame structure is defined in <linux/can.h>:
  1125. struct can_frame {
  1126. canid_t can_id; /* 32 bit CAN_ID + EFF/RTR/ERR flags */
  1127. __u8 can_dlc; /* data length code: 0 .. 8 */
  1128. __u8 data[8] __attribute__((aligned(8)));
  1129. };
  1130. """
  1131. can_frame_fmt = "=IB3x8s"
  1132. def __init__(self, methodName='runTest'):
  1133. ThreadedCANSocketTest.__init__(self, methodName=methodName)
  1134. @classmethod
  1135. def build_can_frame(cls, can_id, data):
  1136. """Build a CAN frame."""
  1137. can_dlc = len(data)
  1138. data = data.ljust(8, b'\x00')
  1139. return struct.pack(cls.can_frame_fmt, can_id, can_dlc, data)
  1140. @classmethod
  1141. def dissect_can_frame(cls, frame):
  1142. """Dissect a CAN frame."""
  1143. can_id, can_dlc, data = struct.unpack(cls.can_frame_fmt, frame)
  1144. return (can_id, can_dlc, data[:can_dlc])
  1145. def testSendFrame(self):
  1146. cf, addr = self.s.recvfrom(self.bufsize)
  1147. self.assertEqual(self.cf, cf)
  1148. self.assertEqual(addr[0], self.interface)
  1149. self.assertEqual(addr[1], socket.AF_CAN)
  1150. def _testSendFrame(self):
  1151. self.cf = self.build_can_frame(0x00, b'\x01\x02\x03\x04\x05')
  1152. self.cli.send(self.cf)
  1153. def testSendMaxFrame(self):
  1154. cf, addr = self.s.recvfrom(self.bufsize)
  1155. self.assertEqual(self.cf, cf)
  1156. def _testSendMaxFrame(self):
  1157. self.cf = self.build_can_frame(0x00, b'\x07' * 8)
  1158. self.cli.send(self.cf)
  1159. def testSendMultiFrames(self):
  1160. cf, addr = self.s.recvfrom(self.bufsize)
  1161. self.assertEqual(self.cf1, cf)
  1162. cf, addr = self.s.recvfrom(self.bufsize)
  1163. self.assertEqual(self.cf2, cf)
  1164. def _testSendMultiFrames(self):
  1165. self.cf1 = self.build_can_frame(0x07, b'\x44\x33\x22\x11')
  1166. self.cli.send(self.cf1)
  1167. self.cf2 = self.build_can_frame(0x12, b'\x99\x22\x33')
  1168. self.cli.send(self.cf2)
  1169. @unittest.skipUnless(HAVE_SOCKET_RDS, 'RDS sockets required for this test.')
  1170. class BasicRDSTest(unittest.TestCase):
  1171. def testCrucialConstants(self):
  1172. socket.AF_RDS
  1173. socket.PF_RDS
  1174. def testCreateSocket(self):
  1175. with socket.socket(socket.PF_RDS, socket.SOCK_SEQPACKET, 0) as s:
  1176. pass
  1177. def testSocketBufferSize(self):
  1178. bufsize = 16384
  1179. with socket.socket(socket.PF_RDS, socket.SOCK_SEQPACKET, 0) as s:
  1180. s.setsockopt(socket.SOL_SOCKET, socket.SO_RCVBUF, bufsize)
  1181. s.setsockopt(socket.SOL_SOCKET, socket.SO_SNDBUF, bufsize)
  1182. @unittest.skipUnless(HAVE_SOCKET_RDS, 'RDS sockets required for this test.')
  1183. @unittest.skipUnless(thread, 'Threading required for this test.')
  1184. class RDSTest(ThreadedRDSSocketTest):
  1185. def __init__(self, methodName='runTest'):
  1186. ThreadedRDSSocketTest.__init__(self, methodName=methodName)
  1187. def setUp(self):
  1188. super().setUp()
  1189. self.evt = threading.Event()
  1190. def testSendAndRecv(self):
  1191. data, addr = self.serv.recvfrom(self.bufsize)
  1192. self.assertEqual(self.data, data)
  1193. self.assertEqual(self.cli_addr, addr)
  1194. def _testSendAndRecv(self):
  1195. self.data = b'spam'
  1196. self.cli.sendto(self.data, 0, (HOST, self.port))
  1197. def testPeek(self):
  1198. data, addr = self.serv.recvfrom(self.bufsize, socket.MSG_PEEK)
  1199. self.assertEqual(self.data, data)
  1200. data, addr = self.serv.recvfrom(self.bufsize)
  1201. self.assertEqual(self.data, data)
  1202. def _testPeek(self):
  1203. self.data = b'spam'
  1204. self.cli.sendto(self.data, 0, (HOST, self.port))
  1205. @requireAttrs(socket.socket, 'recvmsg')
  1206. def testSendAndRecvMsg(self):
  1207. data, ancdata, msg_flags, addr = self.serv.recvmsg(self.bufsize)
  1208. self.assertEqual(self.data, data)
  1209. @requireAttrs(socket.socket, 'sendmsg')
  1210. def _testSendAndRecvMsg(self):
  1211. self.data = b'hello ' * 10
  1212. self.cli.sendmsg([self.data], (), 0, (HOST, self.port))
  1213. def testSendAndRecvMulti(self):
  1214. data, addr = self.serv.recvfrom(self.bufsize)
  1215. self.assertEqual(self.data1, data)
  1216. data, addr = self.serv.recvfrom(self.bufsize)
  1217. self.assertEqual(self.data2, data)
  1218. def _testSendAndRecvMulti(self):
  1219. self.data1 = b'bacon'
  1220. self.cli.sendto(self.data1, 0, (HOST, self.port))
  1221. self.data2 = b'egg'
  1222. self.cli.sendto(self.data2, 0, (HOST, self.port))
  1223. def testSelect(self):
  1224. r, w, x = select.select([self.serv], [], [], 3.0)
  1225. self.assertIn(self.serv, r)
  1226. data, addr = self.serv.recvfrom(self.bufsize)
  1227. self.assertEqual(self.data, data)
  1228. def _testSelect(self):
  1229. self.data = b'select'
  1230. self.cli.sendto(self.data, 0, (HOST, self.port))
  1231. def testCongestion(self):
  1232. # wait until the sender is done
  1233. self.evt.wait()
  1234. def _testCongestion(self):
  1235. # test the behavior in case of congestion
  1236. self.data = b'fill'
  1237. self.cli.setblocking(False)
  1238. try:
  1239. # try to lower the receiver's socket buffer size
  1240. self.cli.setsockopt(socket.SOL_SOCKET, socket.SO_RCVBUF, 16384)
  1241. except OSError:
  1242. pass
  1243. with self.assertRaises(OSError) as cm:
  1244. try:
  1245. # fill the receiver's socket buffer
  1246. while True:
  1247. self.cli.sendto(self.data, 0, (HOST, self.port))
  1248. finally:
  1249. # signal the receiver we're done
  1250. self.evt.set()
  1251. # sendto() should have failed with ENOBUFS
  1252. self.assertEqual(cm.exception.errno, errno.ENOBUFS)
  1253. # and we should have received a congestion notification through poll
  1254. r, w, x = select.select([self.serv], [], [], 3.0)
  1255. self.assertIn(self.serv, r)
  1256. @unittest.skipUnless(thread, 'Threading required for this test.')
  1257. class BasicTCPTest(SocketConnectedTest):
  1258. def __init__(self, methodName='runTest'):
  1259. SocketConnectedTest.__init__(self, methodName=methodName)
  1260. def testRecv(self):
  1261. # Testing large receive over TCP
  1262. msg = self.cli_conn.recv(1024)
  1263. self.assertEqual(msg, MSG)
  1264. def _testRecv(self):
  1265. self.serv_conn.send(MSG)
  1266. def testOverFlowRecv(self):
  1267. # Testing receive in chunks over TCP
  1268. seg1 = self.cli_conn.recv(len(MSG) - 3)
  1269. seg2 = self.cli_conn.recv(1024)
  1270. msg = seg1 + seg2
  1271. self.assertEqual(msg, MSG)
  1272. def _testOverFlowRecv(self):
  1273. self.serv_conn.send(MSG)
  1274. def testRecvFrom(self):
  1275. # Testing large recvfrom() over TCP
  1276. msg, addr = self.cli_conn.recvfrom(1024)
  1277. self.assertEqual(msg, MSG)
  1278. def _testRecvFrom(self):
  1279. self.serv_conn.send(MSG)
  1280. def testOverFlowRecvFrom(self):
  1281. # Testing recvfrom() in chunks over TCP
  1282. seg1, addr = self.cli_conn.recvfrom(len(MSG)-3)
  1283. seg2, addr = self.cli_conn.recvfrom(1024)
  1284. msg = seg1 + seg2
  1285. self.assertEqual(msg, MSG)
  1286. def _testOverFlowRecvFrom(self):
  1287. self.serv_conn.send(MSG)
  1288. def testSendAll(self):
  1289. # Testing sendall() with a 2048 byte string over TCP
  1290. msg = b''
  1291. while 1:
  1292. read = self.cli_conn.recv(1024)
  1293. if not read:
  1294. break
  1295. msg += read
  1296. self.assertEqual(msg, b'f' * 2048)
  1297. def _testSendAll(self):
  1298. big_chunk = b'f' * 2048
  1299. self.serv_conn.sendall(big_chunk)
  1300. def testFromFd(self):
  1301. # Testing fromfd()
  1302. fd = self.cli_conn.fileno()
  1303. sock = socket.fromfd(fd, socket.AF_INET, socket.SOCK_STREAM)
  1304. self.addCleanup(sock.close)
  1305. self.assertIsInstance(sock, socket.socket)
  1306. msg = sock.recv(1024)
  1307. self.assertEqual(msg, MSG)
  1308. def _testFromFd(self):
  1309. self.serv_conn.send(MSG)
  1310. def testDup(self):
  1311. # Testing dup()
  1312. sock = self.cli_conn.dup()
  1313. self.addCleanup(sock.close)
  1314. msg = sock.recv(1024)
  1315. self.assertEqual(msg, MSG)
  1316. def _testDup(self):
  1317. self.serv_conn.send(MSG)
  1318. def testShutdown(self):
  1319. # Testing shutdown()
  1320. msg = self.cli_conn.recv(1024)
  1321. self.assertEqual(msg, MSG)
  1322. # wait for _testShutdown to finish: on OS X, when the server
  1323. # closes the connection the client also becomes disconnected,
  1324. # and the client's shutdown call will fail. (Issue #4397.)
  1325. self.done.wait()
  1326. def _testShutdown(self):
  1327. self.serv_conn.send(MSG)
  1328. # Issue 15989
  1329. self.assertRaises(OverflowError, self.serv_conn.shutdown,
  1330. _testcapi.INT_MAX + 1)
  1331. self.assertRaises(OverflowError, self.serv_conn.shutdown,
  1332. 2 + (_testcapi.UINT_MAX + 1))
  1333. self.serv_conn.shutdown(2)
  1334. def testDetach(self):
  1335. # Testing detach()
  1336. fileno = self.cli_conn.fileno()
  1337. f = self.cli_conn.detach()
  1338. self.assertEqual(f, fileno)
  1339. # cli_conn cannot be used anymore...
  1340. self.assertTrue(self.cli_conn._closed)
  1341. self.assertRaises(OSError, self.cli_conn.recv, 1024)
  1342. self.cli_conn.close()
  1343. # ...but we can create another socket using the (still open)
  1344. # file descriptor
  1345. sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM, fileno=f)
  1346. self.addCleanup(sock.close)
  1347. msg = sock.recv(1024)
  1348. self.assertEqual(msg, MSG)
  1349. def _testDetach(self):
  1350. self.serv_conn.send(MSG)
  1351. @unittest.skipUnless(thread, 'Threading required for this test.')
  1352. class BasicUDPTest(ThreadedUDPSocketTest):
  1353. def __init__(self, methodName='runTest'):
  1354. ThreadedUDPSocketTest.__init__(self, methodName=methodName)
  1355. def testSendtoAndRecv(self):
  1356. # Testing sendto() and Recv() over UDP
  1357. msg = self.serv.recv(len(MSG))
  1358. self.assertEqual(msg, MSG)
  1359. def _testSendtoAndRecv(self):
  1360. self.cli.sendto(MSG, 0, (HOST, self.port))
  1361. def testRecvFrom(self):
  1362. # Testing recvfrom() over UDP
  1363. msg, addr = self.serv.recvfrom(len(MSG))
  1364. self.assertEqual(msg, MSG)
  1365. def _testRecvFrom(self):
  1366. self.cli.sendto(MSG, 0, (HOST, self.port))
  1367. def testRecvFromNegative(self):
  1368. # Negative lengths passed to recvfrom should give ValueError.
  1369. self.assertRaises(ValueError, self.serv.recvfrom, -1)
  1370. def _testRecvFromNegative(self):
  1371. self.cli.sendto(MSG, 0, (HOST, self.port))
  1372. # Tests for the sendmsg()/recvmsg() interface. Where possible, the
  1373. # same test code is used with different families and types of socket
  1374. # (e.g. stream, datagram), and tests using recvmsg() are repeated
  1375. # using recvmsg_into().
  1376. #
  1377. # The generic test classes such as SendmsgTests and
  1378. # RecvmsgGenericTests inherit from SendrecvmsgBase and expect to be
  1379. # supplied with sockets cli_sock and serv_sock representing the
  1380. # client's and the server's end of the connection respectively, and
  1381. # attributes cli_addr and serv_addr holding their (numeric where
  1382. # appropriate) addresses.
  1383. #
  1384. # The final concrete test classes combine these with subclasses of
  1385. # SocketTestBase which set up client and server sockets of a specific
  1386. # type, and with subclasses of SendrecvmsgBase such as
  1387. # SendrecvmsgDgramBase and SendrecvmsgConnectedBase which map these
  1388. # sockets to cli_sock and serv_sock and override the methods and
  1389. # attributes of SendrecvmsgBase to fill in destination addresses if
  1390. # needed when sending, check for specific flags in msg_flags, etc.
  1391. #
  1392. # RecvmsgIntoMixin provides a version of doRecvmsg() implemented using
  1393. # recvmsg_into().
  1394. # XXX: like the other datagram (UDP) tests in this module, the code
  1395. # here assumes that datagram delivery on the local machine will be
  1396. # reliable.
  1397. class SendrecvmsgBase(ThreadSafeCleanupTestCase):
  1398. # Base class for sendmsg()/recvmsg() tests.
  1399. # Time in seconds to wait before considering a test failed, or
  1400. # None for no timeout. Not all tests actually set a timeout.
  1401. fail_timeout = 3.0
  1402. def setUp(self):
  1403. self.misc_event = threading.Event()
  1404. super().setUp()
  1405. def sendToServer(self, msg):
  1406. # Send msg to the server.
  1407. return self.cli_sock.send(msg)
  1408. # Tuple of alternative default arguments for sendmsg() when called
  1409. # via sendmsgToServer() (e.g. to include a destination address).
  1410. sendmsg_to_server_defaults = ()
  1411. def sendmsgToServer(self, *args):
  1412. # Call sendmsg() on self.cli_sock with the given arguments,
  1413. # filling in any arguments which are not supplied with the
  1414. # corresponding items of self.sendmsg_to_server_defaults, if
  1415. # any.
  1416. return self.cli_sock.sendmsg(
  1417. *(args + self.sendmsg_to_server_defaults[len(args):]))
  1418. def doRecvmsg(self, sock, bufsize, *args):
  1419. # Call recvmsg() on sock with given arguments and return its
  1420. # result. Should be used for tests which can use either
  1421. # recvmsg() or recvmsg_into() - RecvmsgIntoMixin overrides
  1422. # this method with one which emulates it using recvmsg_into(),
  1423. # thus allowing the same test to be used for both methods.
  1424. result = sock.recvmsg(bufsize, *args)
  1425. self.registerRecvmsgResult(result)
  1426. return result
  1427. def registerRecvmsgResult(self, result):
  1428. # Called by doRecvmsg() with the return value of recvmsg() or
  1429. # recvmsg_into(). Can be overridden to arrange cleanup based
  1430. # on the returned ancillary data, for instance.
  1431. pass
  1432. def checkRecvmsgAddress(self, addr1, addr2):
  1433. # Called to compare the received address with the address of
  1434. # the peer.
  1435. self.assertEqual(addr1, addr2)
  1436. # Flags that are normally unset in msg_flags
  1437. msg_flags_common_unset = 0
  1438. for name in ("MSG_CTRUNC", "MSG_OOB"):
  1439. msg_flags_common_unset |= getattr(socket, name, 0)
  1440. # Flags that are normally set
  1441. msg_flags_common_set = 0
  1442. # Flags set when a complete record has been received (e.g. MSG_EOR
  1443. # for SCTP)
  1444. msg_flags_eor_indicator = 0
  1445. # Flags set when a complete record has not been received
  1446. # (e.g. MSG_TRUNC for datagram sockets)
  1447. msg_flags_non_eor_indicator = 0
  1448. def checkFlags(self, flags, eor=None, checkset=0, checkunset=0, ignore=0):
  1449. # Method to check the value of msg_flags returned by recvmsg[_into]().
  1450. #
  1451. # Checks that all bits in msg_flags_common_set attribute are
  1452. # set in "flags" and all bits in msg_flags_common_unset are
  1453. # unset.
  1454. #
  1455. # The "eor" argument specifies whether the flags should
  1456. # indicate that a full record (or datagram) has been received.
  1457. # If "eor" is None, no checks are done; otherwise, checks
  1458. # that:
  1459. #
  1460. # * if "eor" is true, all bits in msg_flags_eor_indicator are
  1461. # set and all bits in msg_flags_non_eor_indicator are unset
  1462. #
  1463. # * if "eor" is false, all bits in msg_flags_non_eor_indicator
  1464. # are set and all bits in msg_flags_eor_indicator are unset
  1465. #
  1466. # If "checkset" and/or "checkunset" are supplied, they require
  1467. # the given bits to be set or unset respectively, overriding
  1468. # what the attributes require for those bits.
  1469. #
  1470. # If any bits are set in "ignore", they will not be checked,
  1471. # regardless of the other inputs.
  1472. #
  1473. # Will raise Exception if the inputs require a bit to be both
  1474. # set and unset, and it is not ignored.
  1475. defaultset = self.msg_flags_common_set
  1476. defaultunset = self.msg_flags_common_unset
  1477. if eor:
  1478. defaultset |= self.msg_flags_eor_indicator
  1479. defaultunset |= self.msg_flags_non_eor_indicator
  1480. elif eor is not None:
  1481. defaultset |= self.msg_flags_non_eor_indicator
  1482. defaultunset |= self.msg_flags_eor_indicator
  1483. # Function arguments override defaults
  1484. defaultset &= ~checkunset
  1485. defaultunset &= ~checkset
  1486. # Merge arguments with remaining defaults, and check for conflicts
  1487. checkset |= defaultset
  1488. checkunset |= defaultunset
  1489. inboth = checkset & checkunset & ~ignore
  1490. if inboth:
  1491. raise Exception("contradictory set, unset requirements for flags "
  1492. "{0:#x}".format(inboth))
  1493. # Compare with given msg_flags value
  1494. mask = (checkset | checkunset) & ~ignore
  1495. self.assertEqual(flags & mask, checkset & mask)
  1496. class RecvmsgIntoMixin(SendrecvmsgBase):
  1497. # Mixin to implement doRecvmsg() using recvmsg_into().
  1498. def doRecvmsg(self, sock, bufsize, *args):
  1499. buf = bytearray(bufsize)
  1500. result = sock.recvmsg_into([buf], *args)
  1501. self.registerRecvmsgResult(result)
  1502. self.assertGreaterEqual(result[0], 0)
  1503. self.assertLessEqual(result[0], bufsize)
  1504. return (bytes(buf[:result[0]]),) + result[1:]
  1505. class SendrecvmsgDgramFlagsBase(SendrecvmsgBase):
  1506. # Defines flags to be checked in msg_flags for datagram sockets.
  1507. @property
  1508. def msg_flags_non_eor_indicator(self):
  1509. return super().msg_flags_non_eor_indicator | socket.MSG_TRUNC
  1510. class SendrecvmsgSCTPFlagsBase(SendrecvmsgBase):
  1511. # Defines flags to be checked in msg_flags for SCTP sockets.
  1512. @property
  1513. def msg_flags_eor_indicator(self):
  1514. return super().msg_flags_eor_indicator | socket.MSG_EOR
  1515. class SendrecvmsgConnectionlessBase(SendrecvmsgBase):
  1516. # Base class for tests on connectionless-mode sockets. Users must
  1517. # supply sockets on attributes cli and serv to be mapped to
  1518. # cli_sock and serv_sock respectively.
  1519. @property
  1520. def serv_sock(self):
  1521. return self.serv
  1522. @property
  1523. def cli_sock(self):
  1524. return self.cli
  1525. @property
  1526. def sendmsg_to_server_defaults(self):
  1527. return ([], [], 0, self.serv_addr)
  1528. def sendToServer(self, msg):
  1529. return self.cli_sock.sendto(msg, self.serv_addr)
  1530. class SendrecvmsgConnectedBase(SendrecvmsgBase):
  1531. # Base class for tests on connected sockets. Users must supply
  1532. # sockets on attributes serv_conn and cli_conn (representing the
  1533. # connections *to* the server and the client), to be mapped to
  1534. # cli_sock and serv_sock respectively.
  1535. @property
  1536. def serv_sock(self):
  1537. return self.cli_conn
  1538. @property
  1539. def cli_sock(self):
  1540. return self.serv_conn
  1541. def checkRecvmsgAddress(self, addr1, addr2):
  1542. # Address is currently "unspecified" for a connected socket,
  1543. # so we don't examine it
  1544. pass
  1545. class SendrecvmsgServerTimeoutBase(SendrecvmsgBase):
  1546. # Base class to set a timeout on server's socket.
  1547. def setUp(self):
  1548. super().setUp()
  1549. self.serv_sock.settimeout(self.fail_timeout)
  1550. class SendmsgTests(SendrecvmsgServerTimeoutBase):
  1551. # Tests for sendmsg() which can use any socket type and do not
  1552. # involve recvmsg() or recvmsg_into().
  1553. def testSendmsg(self):
  1554. # Send a simple message with sendmsg().
  1555. self.assertEqual(self.serv_sock.recv(len(MSG)), MSG)
  1556. def _testSendmsg(self):
  1557. self.assertEqual(self.sendmsgToServer([MSG]), len(MSG))
  1558. def testSendmsgDataGenerator(self):
  1559. # Send from buffer obtained from a generator (not a sequence).
  1560. self.assertEqual(self.serv_sock.recv(len(MSG)), MSG)
  1561. def _testSendmsgDataGenerator(self):
  1562. self.assertEqual(self.sendmsgToServer((o for o in [MSG])),
  1563. len(MSG))
  1564. def testSendmsgAncillaryGenerator(self):
  1565. # Gather (empty) ancillary data from a generator.
  1566. self.assertEqual(self.serv_sock.recv(len(MSG)), MSG)
  1567. def _testSendmsgAncillaryGenerator(self):
  1568. self.assertEqual(self.sendmsgToServer([MSG], (o for o in [])),
  1569. len(MSG))
  1570. def testSendmsgArray(self):
  1571. # Send data from an array instead of the usual bytes object.
  1572. self.assertEqual(self.serv_sock.recv(len(MSG)), MSG)
  1573. def _testSendmsgArray(self):
  1574. self.assertEqual(self.sendmsgToServer([array.array("B", MSG)]),
  1575. len(MSG))
  1576. def testSendmsgGather(self):
  1577. # Send message data from more than one buffer (gather write).
  1578. self.assertEqual(self.serv_sock.recv(len(MSG)), MSG)
  1579. def _testSendmsgGather(self):
  1580. self.assertEqual(self.sendmsgToServer([MSG[:3], MSG[3:]]), len(MSG))
  1581. def testSendmsgBadArgs(self):
  1582. # Check that sendmsg() rejects invalid arguments.
  1583. self.assertEqual(self.serv_sock.recv(1000), b"done")
  1584. def _testSendmsgBadArgs(self):
  1585. self.assertRaises(TypeError, self.cli_sock.sendmsg)
  1586. self.assertRaises(TypeError, self.sendmsgToServer,
  1587. b"not in an iterable")
  1588. self.assertRaises(TypeError, self.sendmsgToServer,
  1589. object())
  1590. self.assertRaises(TypeError, self.sendmsgToServer,
  1591. [object()])
  1592. self.assertRaises(TypeError, self.sendmsgToServer,
  1593. [MSG, object()])
  1594. self.assertRaises(TypeError, self.sendmsgToServer,
  1595. [MSG], object())
  1596. self.assertRaises(TypeError, self.sendmsgToServer,
  1597. [MSG], [], object())
  1598. self.assertRaises(TypeError, self.sendmsgToServer,
  1599. [MSG], [], 0, object())
  1600. self.sendToServer(b"done")
  1601. def testSendmsgBadCmsg(self):
  1602. # Check that invalid ancillary data items are rejected.
  1603. self.assertEqual(self.serv_sock.recv(1000), b"done")
  1604. def _testSendmsgBadCmsg(self):
  1605. self.assertRaises(TypeError, self.sendmsgToServer,
  1606. [MSG], [object()])
  1607. self.assertRaises(TypeError, self.sendmsgToServer,
  1608. [MSG], [(object(), 0, b"data")])
  1609. self.assertRaises(TypeError, self.sendmsgToServer,
  1610. [MSG], [(0, object(), b"data")])
  1611. self.assertRaises(TypeError, self.sendmsgToServer,
  1612. [MSG], [(0, 0, object())])
  1613. self.assertRaises(TypeError, self.sendmsgToServer,
  1614. [MSG], [(0, 0)])
  1615. self.assertRaises(TypeError, self.sendmsgToServer,
  1616. [MSG], [(0, 0, b"data", 42)])
  1617. self.sendToServer(b"done")
  1618. @requireAttrs(socket, "CMSG_SPACE")
  1619. def testSendmsgBadMultiCmsg(self):
  1620. # Check that invalid ancillary data items are rejected when
  1621. # more than one item is present.
  1622. self.assertEqual(self.serv_sock.recv(1000), b"done")
  1623. @testSendmsgBadMultiCmsg.client_skip
  1624. def _testSendmsgBadMultiCmsg(self):
  1625. self.assertRaises(TypeError, self.sendmsgToServer,
  1626. [MSG], [0, 0, b""])
  1627. self.assertRaises(TypeError, self.sendmsgToServer,
  1628. [MSG], [(0, 0, b""), object()])
  1629. self.sendToServer(b"done")
  1630. def testSendmsgExcessCmsgReject(self):
  1631. # Check that sendmsg() rejects excess ancillary data items
  1632. # when the number that can be sent is limited.
  1633. self.assertEqual(self.serv_sock.recv(1000), b"done")
  1634. def _testSendmsgExcessCmsgReject(self):
  1635. if not hasattr(socket, "CMSG_SPACE"):
  1636. # Can only send one item
  1637. with self.assertRaises(OSError) as cm:
  1638. self.sendmsgToServer([MSG], [(0, 0, b""), (0, 0, b"")])
  1639. self.assertIsNone(cm.exception.errno)
  1640. self.sendToServer(b"done")
  1641. def testSendmsgAfterClose(self):
  1642. # Check that sendmsg() fails on a closed socket.
  1643. pass
  1644. def _testSendmsgAfterClose(self):
  1645. self.cli_sock.close()
  1646. self.assertRaises(OSError, self.sendmsgToServer, [MSG])
  1647. class SendmsgStreamTests(SendmsgTests):
  1648. # Tests for sendmsg() which require a stream socket and do not
  1649. # involve recvmsg() or recvmsg_into().
  1650. def testSendmsgExplicitNoneAddr(self):
  1651. # Check that peer address can be specified as None.
  1652. self.assertEqual(self.serv_sock.recv(len(MSG)), MSG)
  1653. def _testSendmsgExplicitNoneAddr(self):
  1654. self.assertEqual(self.sendmsgToServer([MSG], [], 0, None), len(MSG))
  1655. def testSendmsgTimeout(self):
  1656. # Check that timeout works with sendmsg().
  1657. self.assertEqual(self.serv_sock.recv(512), b"a"*512)
  1658. self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
  1659. def _testSendmsgTimeout(self):
  1660. try:
  1661. self.cli_sock.settimeout(0.03)
  1662. with self.assertRaises(socket.timeout):
  1663. while True:
  1664. self.sendmsgToServer([b"a"*512])
  1665. finally:
  1666. self.misc_event.set()
  1667. # XXX: would be nice to have more tests for sendmsg flags argument.
  1668. # Linux supports MSG_DONTWAIT when sending, but in general, it
  1669. # only works when receiving. Could add other platforms if they
  1670. # support it too.
  1671. @skipWithClientIf(sys.platform not in {"linux2"},
  1672. "MSG_DONTWAIT not known to work on this platform when "
  1673. "sending")
  1674. def testSendmsgDontWait(self):
  1675. # Check that MSG_DONTWAIT in flags causes non-blocking behaviour.
  1676. self.assertEqual(self.serv_sock.recv(512), b"a"*512)
  1677. self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
  1678. @testSendmsgDontWait.client_skip
  1679. def _testSendmsgDontWait(self):
  1680. try:
  1681. with self.assertRaises(OSError) as cm:
  1682. while True:
  1683. self.sendmsgToServer([b"a"*512], [], socket.MSG_DONTWAIT)
  1684. self.assertIn(cm.exception.errno,
  1685. (errno.EAGAIN, errno.EWOULDBLOCK))
  1686. finally:
  1687. self.misc_event.set()
  1688. class SendmsgConnectionlessTests(SendmsgTests):
  1689. # Tests for sendmsg() which require a connectionless-mode
  1690. # (e.g. datagram) socket, and do not involve recvmsg() or
  1691. # recvmsg_into().
  1692. def testSendmsgNoDestAddr(self):
  1693. # Check that sendmsg() fails when no destination address is
  1694. # given for unconnected socket.
  1695. pass
  1696. def _testSendmsgNoDestAddr(self):
  1697. self.assertRaises(OSError, self.cli_sock.sendmsg,
  1698. [MSG])
  1699. self.assertRaises(OSError, self.cli_sock.sendmsg,
  1700. [MSG], [], 0, None)
  1701. class RecvmsgGenericTests(SendrecvmsgBase):
  1702. # Tests for recvmsg() which can also be emulated using
  1703. # recvmsg_into(), and can use any socket type.
  1704. def testRecvmsg(self):
  1705. # Receive a simple message with recvmsg[_into]().
  1706. msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock, len(MSG))
  1707. self.assertEqual(msg, MSG)
  1708. self.checkRecvmsgAddress(addr, self.cli_addr)
  1709. self.assertEqual(ancdata, [])
  1710. self.checkFlags(flags, eor=True)
  1711. def _testRecvmsg(self):
  1712. self.sendToServer(MSG)
  1713. def testRecvmsgExplicitDefaults(self):
  1714. # Test recvmsg[_into]() with default arguments provided explicitly.
  1715. msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
  1716. len(MSG), 0, 0)
  1717. self.assertEqual(msg, MSG)
  1718. self.checkRecvmsgAddress(addr, self.cli_addr)
  1719. self.assertEqual(ancdata, [])
  1720. self.checkFlags(flags, eor=True)
  1721. def _testRecvmsgExplicitDefaults(self):
  1722. self.sendToServer(MSG)
  1723. def testRecvmsgShorter(self):
  1724. # Receive a message smaller than buffer.
  1725. msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
  1726. len(MSG) + 42)
  1727. self.assertEqual(msg, MSG)
  1728. self.checkRecvmsgAddress(addr, self.cli_addr)
  1729. self.assertEqual(ancdata, [])
  1730. self.checkFlags(flags, eor=True)
  1731. def _testRecvmsgShorter(self):
  1732. self.sendToServer(MSG)
  1733. # FreeBSD < 8 doesn't always set the MSG_TRUNC flag when a truncated
  1734. # datagram is received (issue #13001).
  1735. @support.requires_freebsd_version(8)
  1736. def testRecvmsgTrunc(self):
  1737. # Receive part of message, check for truncation indicators.
  1738. msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
  1739. len(MSG) - 3)
  1740. self.assertEqual(msg, MSG[:-3])
  1741. self.checkRecvmsgAddress(addr, self.cli_addr)
  1742. self.assertEqual(ancdata, [])
  1743. self.checkFlags(flags, eor=False)
  1744. @support.requires_freebsd_version(8)
  1745. def _testRecvmsgTrunc(self):
  1746. self.sendToServer(MSG)
  1747. def testRecvmsgShortAncillaryBuf(self):
  1748. # Test ancillary data buffer too small to hold any ancillary data.
  1749. msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
  1750. len(MSG), 1)
  1751. self.assertEqual(msg, MSG)
  1752. self.checkRecvmsgAddress(addr, self.cli_addr)
  1753. self.assertEqual(ancdata, [])
  1754. self.checkFlags(flags, eor=True)
  1755. def _testRecvmsgShortAncillaryBuf(self):
  1756. self.sendToServer(MSG)
  1757. def testRecvmsgLongAncillaryBuf(self):
  1758. # Test large ancillary data buffer.
  1759. msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
  1760. len(MSG), 10240)
  1761. self.assertEqual(msg, MSG)
  1762. self.checkRecvmsgAddress(addr, self.cli_addr)
  1763. self.assertEqual(ancdata, [])
  1764. self.checkFlags(flags, eor=True)
  1765. def _testRecvmsgLongAncillaryBuf(self):
  1766. self.sendToServer(MSG)
  1767. def testRecvmsgAfterClose(self):
  1768. # Check that recvmsg[_into]() fails on a closed socket.
  1769. self.serv_sock.close()
  1770. self.assertRaises(OSError, self.doRecvmsg, self.serv_sock, 1024)
  1771. def _testRecvmsgAfterClose(self):
  1772. pass
  1773. def testRecvmsgTimeout(self):
  1774. # Check that timeout works.
  1775. try:
  1776. self.serv_sock.settimeout(0.03)
  1777. self.assertRaises(socket.timeout,
  1778. self.doRecvmsg, self.serv_sock, len(MSG))
  1779. finally:
  1780. self.misc_event.set()
  1781. def _testRecvmsgTimeout(self):
  1782. self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
  1783. @requireAttrs(socket, "MSG_PEEK")
  1784. def testRecvmsgPeek(self):
  1785. # Check that MSG_PEEK in flags enables examination of pending
  1786. # data without consuming it.
  1787. # Receive part of data with MSG_PEEK.
  1788. msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
  1789. len(MSG) - 3, 0,
  1790. socket.MSG_PEEK)
  1791. self.assertEqual(msg, MSG[:-3])
  1792. self.checkRecvmsgAddress(addr, self.cli_addr)
  1793. self.assertEqual(ancdata, [])
  1794. # Ignoring MSG_TRUNC here (so this test is the same for stream
  1795. # and datagram sockets). Some wording in POSIX seems to
  1796. # suggest that it needn't be set when peeking, but that may
  1797. # just be a slip.
  1798. self.checkFlags(flags, eor=False,
  1799. ignore=getattr(socket, "MSG_TRUNC", 0))
  1800. # Receive all data with MSG_PEEK.
  1801. msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
  1802. len(MSG), 0,
  1803. socket.MSG_PEEK)
  1804. self.assertEqual(msg, MSG)
  1805. self.checkRecvmsgAddress(addr, self.cli_addr)
  1806. self.assertEqual(ancdata, [])
  1807. self.checkFlags(flags, eor=True)
  1808. # Check that the same data can still be received normally.
  1809. msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock, len(MSG))
  1810. self.assertEqual(msg, MSG)
  1811. self.checkRecvmsgAddress(addr, self.cli_addr)
  1812. self.assertEqual(ancdata, [])
  1813. self.checkFlags(flags, eor=True)
  1814. @testRecvmsgPeek.client_skip
  1815. def _testRecvmsgPeek(self):
  1816. self.sendToServer(MSG)
  1817. @requireAttrs(socket.socket, "sendmsg")
  1818. def testRecvmsgFromSendmsg(self):
  1819. # Test receiving with recvmsg[_into]() when message is sent
  1820. # using sendmsg().
  1821. self.serv_sock.settimeout(self.fail_timeout)
  1822. msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock, len(MSG))
  1823. self.assertEqual(msg, MSG)
  1824. self.checkRecvmsgAddress(addr, self.cli_addr)
  1825. self.assertEqual(ancdata, [])
  1826. self.checkFlags(flags, eor=True)
  1827. @testRecvmsgFromSendmsg.client_skip
  1828. def _testRecvmsgFromSendmsg(self):
  1829. self.assertEqual(self.sendmsgToServer([MSG[:3], MSG[3:]]), len(MSG))
  1830. class RecvmsgGenericStreamTests(RecvmsgGenericTests):
  1831. # Tests which require a stream socket and can use either recvmsg()
  1832. # or recvmsg_into().
  1833. def testRecvmsgEOF(self):
  1834. # Receive end-of-stream indicator (b"", peer socket closed).
  1835. msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock, 1024)
  1836. self.assertEqual(msg, b"")
  1837. self.checkRecvmsgAddress(addr, self.cli_addr)
  1838. self.assertEqual(ancdata, [])
  1839. self.checkFlags(flags, eor=None) # Might not have end-of-record marker
  1840. def _testRecvmsgEOF(self):
  1841. self.cli_sock.close()
  1842. def testRecvmsgOverflow(self):
  1843. # Receive a message in more than one chunk.
  1844. seg1, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
  1845. len(MSG) - 3)
  1846. self.checkRecvmsgAddress(addr, self.cli_addr)
  1847. self.assertEqual(ancdata, [])
  1848. self.checkFlags(flags, eor=False)
  1849. seg2, ancdata, flags, addr = self.doRecvmsg(self.serv_sock, 1024)
  1850. self.checkRecvmsgAddress(addr, self.cli_addr)
  1851. self.assertEqual(ancdata, [])
  1852. self.checkFlags(flags, eor=True)
  1853. msg = seg1 + seg2
  1854. self.assertEqual(msg, MSG)
  1855. def _testRecvmsgOverflow(self):
  1856. self.sendToServer(MSG)
  1857. class RecvmsgTests(RecvmsgGenericTests):
  1858. # Tests for recvmsg() which can use any socket type.
  1859. def testRecvmsgBadArgs(self):
  1860. # Check that recvmsg() rejects invalid arguments.
  1861. self.assertRaises(TypeError, self.serv_sock.recvmsg)
  1862. self.assertRaises(ValueError, self.serv_sock.recvmsg,
  1863. -1, 0, 0)
  1864. self.assertRaises(ValueError, self.serv_sock.recvmsg,
  1865. len(MSG), -1, 0)
  1866. self.assertRaises(TypeError, self.serv_sock.recvmsg,
  1867. [bytearray(10)], 0, 0)
  1868. self.assertRaises(TypeError, self.serv_sock.recvmsg,
  1869. object(), 0, 0)
  1870. self.assertRaises(TypeError, self.serv_sock.recvmsg,
  1871. len(MSG), object(), 0)
  1872. self.assertRaises(TypeError, self.serv_sock.recvmsg,
  1873. len(MSG), 0, object())
  1874. msg, ancdata, flags, addr = self.serv_sock.recvmsg(len(MSG), 0, 0)
  1875. self.assertEqual(msg, MSG)
  1876. self.checkRecvmsgAddress(addr, self.cli_addr)
  1877. self.assertEqual(ancdata, [])
  1878. self.checkFlags(flags, eor=True)
  1879. def _testRecvmsgBadArgs(self):
  1880. self.sendToServer(MSG)
  1881. class RecvmsgIntoTests(RecvmsgIntoMixin, RecvmsgGenericTests):
  1882. # Tests for recvmsg_into() which can use any socket type.
  1883. def testRecvmsgIntoBadArgs(self):
  1884. # Check that recvmsg_into() rejects invalid arguments.
  1885. buf = bytearray(len(MSG))
  1886. self.assertRaises(TypeError, self.serv_sock.recvmsg_into)
  1887. self.assertRaises(TypeError, self.serv_sock.recvmsg_into,
  1888. len(MSG), 0, 0)
  1889. self.assertRaises(TypeError, self.serv_sock.recvmsg_into,
  1890. buf, 0, 0)
  1891. self.assertRaises(TypeError, self.serv_sock.recvmsg_into,
  1892. [object()], 0, 0)
  1893. self.assertRaises(TypeError, self.serv_sock.recvmsg_into,
  1894. [b"I'm not writable"], 0, 0)
  1895. self.assertRaises(TypeError, self.serv_sock.recvmsg_into,
  1896. [buf, object()], 0, 0)
  1897. self.assertRaises(ValueError, self.serv_sock.recvmsg_into,
  1898. [buf], -1, 0)
  1899. self.assertRaises(TypeError, self.serv_sock.recvmsg_into,
  1900. [buf], object(), 0)
  1901. self.assertRaises(TypeError, self.serv_sock.recvmsg_into,
  1902. [buf], 0, object())
  1903. nbytes, ancdata, flags, addr = self.serv_sock.recvmsg_into([buf], 0, 0)
  1904. self.assertEqual(nbytes, len(MSG))
  1905. self.assertEqual(buf, bytearray(MSG))
  1906. self.checkRecvmsgAddress(addr, self.cli_addr)
  1907. self.assertEqual(ancdata, [])
  1908. self.checkFlags(flags, eor=True)
  1909. def _testRecvmsgIntoBadArgs(self):
  1910. self.sendToServer(MSG)
  1911. def testRecvmsgIntoGenerator(self):
  1912. # Receive into buffer obtained from a generator (not a sequence).
  1913. buf = bytearray(len(MSG))
  1914. nbytes, ancdata, flags, addr = self.serv_sock.recvmsg_into(
  1915. (o for o in [buf]))
  1916. self.assertEqual(nbytes, len(MSG))
  1917. self.assertEqual(buf, bytearray(MSG))
  1918. self.checkRecvmsgAddress(addr, self.cli_addr)
  1919. self.assertEqual(ancdata, [])
  1920. self.checkFlags(flags, eor=True)
  1921. def _testRecvmsgIntoGenerator(self):
  1922. self.sendToServer(MSG)
  1923. def testRecvmsgIntoArray(self):
  1924. # Receive into an array rather than the usual bytearray.
  1925. buf = array.array("B", [0] * len(MSG))
  1926. nbytes, ancdata, flags, addr = self.serv_sock.recvmsg_into([buf])
  1927. self.assertEqual(nbytes, len(MSG))
  1928. self.assertEqual(buf.tobytes(), MSG)
  1929. self.checkRecvmsgAddress(addr, self.cli_addr)
  1930. self.assertEqual(ancdata, [])
  1931. self.checkFlags(flags, eor=True)
  1932. def _testRecvmsgIntoArray(self):
  1933. self.sendToServer(MSG)
  1934. def testRecvmsgIntoScatter(self):
  1935. # Receive into multiple buffers (scatter write).
  1936. b1 = bytearray(b"----")
  1937. b2 = bytearray(b"0123456789")
  1938. b3 = bytearray(b"--------------")
  1939. nbytes, ancdata, flags, addr = self.serv_sock.recvmsg_into(
  1940. [b1, memoryview(b2)[2:9], b3])
  1941. self.assertEqual(nbytes, len(b"Mary had a little lamb"))
  1942. self.assertEqual(b1, bytearray(b"Mary"))
  1943. self.assertEqual(b2, bytearray(b"01 had a 9"))
  1944. self.assertEqual(b3, bytearray(b"little lamb---"))
  1945. self.checkRecvmsgAddress(addr, self.cli_addr)
  1946. self.assertEqual(ancdata, [])
  1947. self.checkFlags(flags, eor=True)
  1948. def _testRecvmsgIntoScatter(self):
  1949. self.sendToServer(b"Mary had a little lamb")
  1950. class CmsgMacroTests(unittest.TestCase):
  1951. # Test the functions CMSG_LEN() and CMSG_SPACE(). Tests
  1952. # assumptions used by sendmsg() and recvmsg[_into](), which share
  1953. # code with these functions.
  1954. # Match the definition in socketmodule.c
  1955. socklen_t_limit = min(0x7fffffff, _testcapi.INT_MAX)
  1956. @requireAttrs(socket, "CMSG_LEN")
  1957. def testCMSG_LEN(self):
  1958. # Test CMSG_LEN() with various valid and invalid values,
  1959. # checking the assumptions used by recvmsg() and sendmsg().
  1960. toobig = self.socklen_t_limit - socket.CMSG_LEN(0) + 1
  1961. values = list(range(257)) + list(range(toobig - 257, toobig))
  1962. # struct cmsghdr has at least three members, two of which are ints
  1963. self.assertGreater(socket.CMSG_LEN(0), array.array("i").itemsize * 2)
  1964. for n in values:
  1965. ret = socket.CMSG_LEN(n)
  1966. # This is how recvmsg() calculates the data size
  1967. self.assertEqual(ret - socket.CMSG_LEN(0), n)
  1968. self.assertLessEqual(ret, self.socklen_t_limit)
  1969. self.assertRaises(OverflowError, socket.CMSG_LEN, -1)
  1970. # sendmsg() shares code with these functions, and requires
  1971. # that it reject values over the limit.
  1972. self.assertRaises(OverflowError, socket.CMSG_LEN, toobig)
  1973. self.assertRaises(OverflowError, socket.CMSG_LEN, sys.maxsize)
  1974. @requireAttrs(socket, "CMSG_SPACE")
  1975. def testCMSG_SPACE(self):
  1976. # Test CMSG_SPACE() with various valid and invalid values,
  1977. # checking the assumptions used by sendmsg().
  1978. toobig = self.socklen_t_limit - socket.CMSG_SPACE(1) + 1
  1979. values = list(range(257)) + list(range(toobig - 257, toobig))
  1980. last = socket.CMSG_SPACE(0)
  1981. # struct cmsghdr has at least three members, two of which are ints
  1982. self.assertGreater(last, array.array("i").itemsize * 2)
  1983. for n in values:
  1984. ret = socket.CMSG_SPACE(n)
  1985. self.assertGreaterEqual(ret, last)
  1986. self.assertGreaterEqual(ret, socket.CMSG_LEN(n))
  1987. self.assertGreaterEqual(ret, n + socket.CMSG_LEN(0))
  1988. self.assertLessEqual(ret, self.socklen_t_limit)
  1989. last = ret
  1990. self.assertRaises(OverflowError, socket.CMSG_SPACE, -1)
  1991. # sendmsg() shares code with these functions, and requires
  1992. # that it reject values over the limit.
  1993. self.assertRaises(OverflowError, socket.CMSG_SPACE, toobig)
  1994. self.assertRaises(OverflowError, socket.CMSG_SPACE, sys.maxsize)
  1995. class SCMRightsTest(SendrecvmsgServerTimeoutBase):
  1996. # Tests for file descriptor passing on Unix-domain sockets.
  1997. # Invalid file descriptor value that's unlikely to evaluate to a
  1998. # real FD even if one of its bytes is replaced with a different
  1999. # value (which shouldn't actually happen).
  2000. badfd = -0x5555
  2001. def newFDs(self, n):
  2002. # Return a list of n file descriptors for newly-created files
  2003. # containing their list indices as ASCII numbers.
  2004. fds = []
  2005. for i in range(n):
  2006. fd, path = tempfile.mkstemp()
  2007. self.addCleanup(os.unlink, path)
  2008. self.addCleanup(os.close, fd)
  2009. os.write(fd, str(i).encode())
  2010. fds.append(fd)
  2011. return fds
  2012. def checkFDs(self, fds):
  2013. # Check that the file descriptors in the given list contain
  2014. # their correct list indices as ASCII numbers.
  2015. for n, fd in enumerate(fds):
  2016. os.lseek(fd, 0, os.SEEK_SET)
  2017. self.assertEqual(os.read(fd, 1024), str(n).encode())
  2018. def registerRecvmsgResult(self, result):
  2019. self.addCleanup(self.closeRecvmsgFDs, result)
  2020. def closeRecvmsgFDs(self, recvmsg_result):
  2021. # Close all file descriptors specified in the ancillary data
  2022. # of the given return value from recvmsg() or recvmsg_into().
  2023. for cmsg_level, cmsg_type, cmsg_data in recvmsg_result[1]:
  2024. if (cmsg_level == socket.SOL_SOCKET and
  2025. cmsg_type == socket.SCM_RIGHTS):
  2026. fds = array.array("i")
  2027. fds.frombytes(cmsg_data[:
  2028. len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])
  2029. for fd in fds:
  2030. os.close(fd)
  2031. def createAndSendFDs(self, n):
  2032. # Send n new file descriptors created by newFDs() to the
  2033. # server, with the constant MSG as the non-ancillary data.
  2034. self.assertEqual(
  2035. self.sendmsgToServer([MSG],
  2036. [(socket.SOL_SOCKET,
  2037. socket.SCM_RIGHTS,
  2038. array.array("i", self.newFDs(n)))]),
  2039. len(MSG))
  2040. def checkRecvmsgFDs(self, numfds, result, maxcmsgs=1, ignoreflags=0):
  2041. # Check that constant MSG was received with numfds file
  2042. # descriptors in a maximum of maxcmsgs control messages (which
  2043. # must contain only complete integers). By default, check
  2044. # that MSG_CTRUNC is unset, but ignore any flags in
  2045. # ignoreflags.
  2046. msg, ancdata, flags, addr = result
  2047. self.assertEqual(msg, MSG)
  2048. self.checkRecvmsgAddress(addr, self.cli_addr)
  2049. self.checkFlags(flags, eor=True, checkunset=socket.MSG_CTRUNC,
  2050. ignore=ignoreflags)
  2051. self.assertIsInstance(ancdata, list)
  2052. self.assertLessEqual(len(ancdata), maxcmsgs)
  2053. fds = array.array("i")
  2054. for item in ancdata:
  2055. self.assertIsInstance(item, tuple)
  2056. cmsg_level, cmsg_type, cmsg_data = item
  2057. self.assertEqual(cmsg_level, socket.SOL_SOCKET)
  2058. self.assertEqual(cmsg_type, socket.SCM_RIGHTS)
  2059. self.assertIsInstance(cmsg_data, bytes)
  2060. self.assertEqual(len(cmsg_data) % SIZEOF_INT, 0)
  2061. fds.frombytes(cmsg_data)
  2062. self.assertEqual(len(fds), numfds)
  2063. self.checkFDs(fds)
  2064. def testFDPassSimple(self):
  2065. # Pass a single FD (array read from bytes object).
  2066. self.checkRecvmsgFDs(1, self.doRecvmsg(self.serv_sock,
  2067. len(MSG), 10240))
  2068. def _testFDPassSimple(self):
  2069. self.assertEqual(
  2070. self.sendmsgToServer(
  2071. [MSG],
  2072. [(socket.SOL_SOCKET,
  2073. socket.SCM_RIGHTS,
  2074. array.array("i", self.newFDs(1)).tobytes())]),
  2075. len(MSG))
  2076. def testMultipleFDPass(self):
  2077. # Pass multiple FDs in a single array.
  2078. self.checkRecvmsgFDs(4, self.doRecvmsg(self.serv_sock,
  2079. len(MSG), 10240))
  2080. def _testMultipleFDPass(self):
  2081. self.createAndSendFDs(4)
  2082. @requireAttrs(socket, "CMSG_SPACE")
  2083. def testFDPassCMSG_SPACE(self):
  2084. # Test using CMSG_SPACE() to calculate ancillary buffer size.
  2085. self.checkRecvmsgFDs(
  2086. 4, self.doRecvmsg(self.serv_sock, len(MSG),
  2087. socket.CMSG_SPACE(4 * SIZEOF_INT)))
  2088. @testFDPassCMSG_SPACE.client_skip
  2089. def _testFDPassCMSG_SPACE(self):
  2090. self.createAndSendFDs(4)
  2091. def testFDPassCMSG_LEN(self):
  2092. # Test using CMSG_LEN() to calculate ancillary buffer size.
  2093. self.checkRecvmsgFDs(1,
  2094. self.doRecvmsg(self.serv_sock, len(MSG),
  2095. socket.CMSG_LEN(4 * SIZEOF_INT)),
  2096. # RFC 3542 says implementations may set
  2097. # MSG_CTRUNC if there isn't enough space
  2098. # for trailing padding.
  2099. ignoreflags=socket.MSG_CTRUNC)
  2100. def _testFDPassCMSG_LEN(self):
  2101. self.createAndSendFDs(1)
  2102. # Issue #12958: The following test has problems on Mac OS X
  2103. @support.anticipate_failure(sys.platform == "darwin")
  2104. @requireAttrs(socket, "CMSG_SPACE")
  2105. def testFDPassSeparate(self):
  2106. # Pass two FDs in two separate arrays. Arrays may be combined
  2107. # into a single control message by the OS.
  2108. self.checkRecvmsgFDs(2,
  2109. self.doRecvmsg(self.serv_sock, len(MSG), 10240),
  2110. maxcmsgs=2)
  2111. @testFDPassSeparate.client_skip
  2112. @support.anticipate_failure(sys.platform == "darwin")
  2113. def _testFDPassSeparate(self):
  2114. fd0, fd1 = self.newFDs(2)
  2115. self.assertEqual(
  2116. self.sendmsgToServer([MSG], [(socket.SOL_SOCKET,
  2117. socket.SCM_RIGHTS,
  2118. array.array("i", [fd0])),
  2119. (socket.SOL_SOCKET,
  2120. socket.SCM_RIGHTS,
  2121. array.array("i", [fd1]))]),
  2122. len(MSG))
  2123. # Issue #12958: The following test has problems on Mac OS X
  2124. @support.anticipate_failure(sys.platform == "darwin")
  2125. @requireAttrs(socket, "CMSG_SPACE")
  2126. def testFDPassSeparateMinSpace(self):
  2127. # Pass two FDs in two separate arrays, receiving them into the
  2128. # minimum space for two arrays.
  2129. self.checkRecvmsgFDs(2,
  2130. self.doRecvmsg(self.serv_sock, len(MSG),
  2131. socket.CMSG_SPACE(SIZEOF_INT) +
  2132. socket.CMSG_LEN(SIZEOF_INT)),
  2133. maxcmsgs=2, ignoreflags=socket.MSG_CTRUNC)
  2134. @testFDPassSeparateMinSpace.client_skip
  2135. @support.anticipate_failure(sys.platform == "darwin")
  2136. def _testFDPassSeparateMinSpace(self):
  2137. fd0, fd1 = self.newFDs(2)
  2138. self.assertEqual(
  2139. self.sendmsgToServer([MSG], [(socket.SOL_SOCKET,
  2140. socket.SCM_RIGHTS,
  2141. array.array("i", [fd0])),
  2142. (socket.SOL_SOCKET,
  2143. socket.SCM_RIGHTS,
  2144. array.array("i", [fd1]))]),
  2145. len(MSG))
  2146. def sendAncillaryIfPossible(self, msg, ancdata):
  2147. # Try to send msg and ancdata to server, but if the system
  2148. # call fails, just send msg with no ancillary data.
  2149. try:
  2150. nbytes = self.sendmsgToServer([msg], ancdata)
  2151. except OSError as e:
  2152. # Check that it was the system call that failed
  2153. self.assertIsInstance(e.errno, int)
  2154. nbytes = self.sendmsgToServer([msg])
  2155. self.assertEqual(nbytes, len(msg))
  2156. def testFDPassEmpty(self):
  2157. # Try to pass an empty FD array. Can receive either no array
  2158. # or an empty array.
  2159. self.checkRecvmsgFDs(0, self.doRecvmsg(self.serv_sock,
  2160. len(MSG), 10240),
  2161. ignoreflags=socket.MSG_CTRUNC)
  2162. def _testFDPassEmpty(self):
  2163. self.sendAncillaryIfPossible(MSG, [(socket.SOL_SOCKET,
  2164. socket.SCM_RIGHTS,
  2165. b"")])
  2166. def testFDPassPartialInt(self):
  2167. # Try to pass a truncated FD array.
  2168. msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
  2169. len(MSG), 10240)
  2170. self.assertEqual(msg, MSG)
  2171. self.checkRecvmsgAddress(addr, self.cli_addr)
  2172. self.checkFlags(flags, eor=True, ignore=socket.MSG_CTRUNC)
  2173. self.assertLessEqual(len(ancdata), 1)
  2174. for cmsg_level, cmsg_type, cmsg_data in ancdata:
  2175. self.assertEqual(cmsg_level, socket.SOL_SOCKET)
  2176. self.assertEqual(cmsg_type, socket.SCM_RIGHTS)
  2177. self.assertLess(len(cmsg_data), SIZEOF_INT)
  2178. def _testFDPassPartialInt(self):
  2179. self.sendAncillaryIfPossible(
  2180. MSG,
  2181. [(socket.SOL_SOCKET,
  2182. socket.SCM_RIGHTS,
  2183. array.array("i", [self.badfd]).tobytes()[:-1])])
  2184. @requireAttrs(socket, "CMSG_SPACE")
  2185. def testFDPassPartialIntInMiddle(self):
  2186. # Try to pass two FD arrays, the first of which is truncated.
  2187. msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
  2188. len(MSG), 10240)
  2189. self.assertEqual(msg, MSG)
  2190. self.checkRecvmsgAddress(addr, self.cli_addr)
  2191. self.checkFlags(flags, eor=True, ignore=socket.MSG_CTRUNC)
  2192. self.assertLessEqual(len(ancdata), 2)
  2193. fds = array.array("i")
  2194. # Arrays may have been combined in a single control message
  2195. for cmsg_level, cmsg_type, cmsg_data in ancdata:
  2196. self.assertEqual(cmsg_level, socket.SOL_SOCKET)
  2197. self.assertEqual(cmsg_type, socket.SCM_RIGHTS)
  2198. fds.frombytes(cmsg_data[:
  2199. len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])
  2200. self.assertLessEqual(len(fds), 2)
  2201. self.checkFDs(fds)
  2202. @testFDPassPartialIntInMiddle.client_skip
  2203. def _testFDPassPartialIntInMiddle(self):
  2204. fd0, fd1 = self.newFDs(2)
  2205. self.sendAncillaryIfPossible(
  2206. MSG,
  2207. [(socket.SOL_SOCKET,
  2208. socket.SCM_RIGHTS,
  2209. array.array("i", [fd0, self.badfd]).tobytes()[:-1]),
  2210. (socket.SOL_SOCKET,
  2211. socket.SCM_RIGHTS,
  2212. array.array("i", [fd1]))])
  2213. def checkTruncatedHeader(self, result, ignoreflags=0):
  2214. # Check that no ancillary data items are returned when data is
  2215. # truncated inside the cmsghdr structure.
  2216. msg, ancdata, flags, addr = result
  2217. self.assertEqual(msg, MSG)
  2218. self.checkRecvmsgAddress(addr, self.cli_addr)
  2219. self.assertEqual(ancdata, [])
  2220. self.checkFlags(flags, eor=True, checkset=socket.MSG_CTRUNC,
  2221. ignore=ignoreflags)
  2222. def testCmsgTruncNoBufSize(self):
  2223. # Check that no ancillary data is received when no buffer size
  2224. # is specified.
  2225. self.checkTruncatedHeader(self.doRecvmsg(self.serv_sock, len(MSG)),
  2226. # BSD seems to set MSG_CTRUNC only
  2227. # if an item has been partially
  2228. # received.
  2229. ignoreflags=socket.MSG_CTRUNC)
  2230. def _testCmsgTruncNoBufSize(self):
  2231. self.createAndSendFDs(1)
  2232. def testCmsgTrunc0(self):
  2233. # Check that no ancillary data is received when buffer size is 0.
  2234. self.checkTruncatedHeader(self.doRecvmsg(self.serv_sock, len(MSG), 0),
  2235. ignoreflags=socket.MSG_CTRUNC)
  2236. def _testCmsgTrunc0(self):
  2237. self.createAndSendFDs(1)
  2238. # Check that no ancillary data is returned for various non-zero
  2239. # (but still too small) buffer sizes.
  2240. def testCmsgTrunc1(self):
  2241. self.checkTruncatedHeader(self.doRecvmsg(self.serv_sock, len(MSG), 1))
  2242. def _testCmsgTrunc1(self):
  2243. self.createAndSendFDs(1)
  2244. def testCmsgTrunc2Int(self):
  2245. # The cmsghdr structure has at least three members, two of
  2246. # which are ints, so we still shouldn't see any ancillary
  2247. # data.
  2248. self.checkTruncatedHeader(self.doRecvmsg(self.serv_sock, len(MSG),
  2249. SIZEOF_INT * 2))
  2250. def _testCmsgTrunc2Int(self):
  2251. self.createAndSendFDs(1)
  2252. def testCmsgTruncLen0Minus1(self):
  2253. self.checkTruncatedHeader(self.doRecvmsg(self.serv_sock, len(MSG),
  2254. socket.CMSG_LEN(0) - 1))
  2255. def _testCmsgTruncLen0Minus1(self):
  2256. self.createAndSendFDs(1)
  2257. # The following tests try to truncate the control message in the
  2258. # middle of the FD array.
  2259. def checkTruncatedArray(self, ancbuf, maxdata, mindata=0):
  2260. # Check that file descriptor data is truncated to between
  2261. # mindata and maxdata bytes when received with buffer size
  2262. # ancbuf, and that any complete file descriptor numbers are
  2263. # valid.
  2264. msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
  2265. len(MSG), ancbuf)
  2266. self.assertEqual(msg, MSG)
  2267. self.checkRecvmsgAddress(addr, self.cli_addr)
  2268. self.checkFlags(flags, eor=True, checkset=socket.MSG_CTRUNC)
  2269. if mindata == 0 and ancdata == []:
  2270. return
  2271. self.assertEqual(len(ancdata), 1)
  2272. cmsg_level, cmsg_type, cmsg_data = ancdata[0]
  2273. self.assertEqual(cmsg_level, socket.SOL_SOCKET)
  2274. self.assertEqual(cmsg_type, socket.SCM_RIGHTS)
  2275. self.assertGreaterEqual(len(cmsg_data), mindata)
  2276. self.assertLessEqual(len(cmsg_data), maxdata)
  2277. fds = array.array("i")
  2278. fds.frombytes(cmsg_data[:
  2279. len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])
  2280. self.checkFDs(fds)
  2281. def testCmsgTruncLen0(self):
  2282. self.checkTruncatedArray(ancbuf=socket.CMSG_LEN(0), maxdata=0)
  2283. def _testCmsgTruncLen0(self):
  2284. self.createAndSendFDs(1)
  2285. def testCmsgTruncLen0Plus1(self):
  2286. self.checkTruncatedArray(ancbuf=socket.CMSG_LEN(0) + 1, maxdata=1)
  2287. def _testCmsgTruncLen0Plus1(self):
  2288. self.createAndSendFDs(2)
  2289. def testCmsgTruncLen1(self):
  2290. self.checkTruncatedArray(ancbuf=socket.CMSG_LEN(SIZEOF_INT),
  2291. maxdata=SIZEOF_INT)
  2292. def _testCmsgTruncLen1(self):
  2293. self.createAndSendFDs(2)
  2294. def testCmsgTruncLen2Minus1(self):
  2295. self.checkTruncatedArray(ancbuf=socket.CMSG_LEN(2 * SIZEOF_INT) - 1,
  2296. maxdata=(2 * SIZEOF_INT) - 1)
  2297. def _testCmsgTruncLen2Minus1(self):
  2298. self.createAndSendFDs(2)
  2299. class RFC3542AncillaryTest(SendrecvmsgServerTimeoutBase):
  2300. # Test sendmsg() and recvmsg[_into]() using the ancillary data
  2301. # features of the RFC 3542 Advanced Sockets API for IPv6.
  2302. # Currently we can only handle certain data items (e.g. traffic
  2303. # class, hop limit, MTU discovery and fragmentation settings)
  2304. # without resorting to unportable means such as the struct module,
  2305. # but the tests here are aimed at testing the ancillary data
  2306. # handling in sendmsg() and recvmsg() rather than the IPv6 API
  2307. # itself.
  2308. # Test value to use when setting hop limit of packet
  2309. hop_limit = 2
  2310. # Test value to use when setting traffic class of packet.
  2311. # -1 means "use kernel default".
  2312. traffic_class = -1
  2313. def ancillaryMapping(self, ancdata):
  2314. # Given ancillary data list ancdata, return a mapping from
  2315. # pairs (cmsg_level, cmsg_type) to corresponding cmsg_data.
  2316. # Check that no (level, type) pair appears more than once.
  2317. d = {}
  2318. for cmsg_level, cmsg_type, cmsg_data in ancdata:
  2319. self.assertNotIn((cmsg_level, cmsg_type), d)
  2320. d[(cmsg_level, cmsg_type)] = cmsg_data
  2321. return d
  2322. def checkHopLimit(self, ancbufsize, maxhop=255, ignoreflags=0):
  2323. # Receive hop limit into ancbufsize bytes of ancillary data
  2324. # space. Check that data is MSG, ancillary data is not
  2325. # truncated (but ignore any flags in ignoreflags), and hop
  2326. # limit is between 0 and maxhop inclusive.
  2327. self.serv_sock.setsockopt(socket.IPPROTO_IPV6,
  2328. socket.IPV6_RECVHOPLIMIT, 1)
  2329. self.misc_event.set()
  2330. msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
  2331. len(MSG), ancbufsize)
  2332. self.assertEqual(msg, MSG)
  2333. self.checkRecvmsgAddress(addr, self.cli_addr)
  2334. self.checkFlags(flags, eor=True, checkunset=socket.MSG_CTRUNC,
  2335. ignore=ignoreflags)
  2336. self.assertEqual(len(ancdata), 1)
  2337. self.assertIsInstance(ancdata[0], tuple)
  2338. cmsg_level, cmsg_type, cmsg_data = ancdata[0]
  2339. self.assertEqual(cmsg_level, socket.IPPROTO_IPV6)
  2340. self.assertEqual(cmsg_type, socket.IPV6_HOPLIMIT)
  2341. self.assertIsInstance(cmsg_data, bytes)
  2342. self.assertEqual(len(cmsg_data), SIZEOF_INT)
  2343. a = array.array("i")
  2344. a.frombytes(cmsg_data)
  2345. self.assertGreaterEqual(a[0], 0)
  2346. self.assertLessEqual(a[0], maxhop)
  2347. @requireAttrs(socket, "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT")
  2348. def testRecvHopLimit(self):
  2349. # Test receiving the packet hop limit as ancillary data.
  2350. self.checkHopLimit(ancbufsize=10240)
  2351. @testRecvHopLimit.client_skip
  2352. def _testRecvHopLimit(self):
  2353. # Need to wait until server has asked to receive ancillary
  2354. # data, as implementations are not required to buffer it
  2355. # otherwise.
  2356. self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
  2357. self.sendToServer(MSG)
  2358. @requireAttrs(socket, "CMSG_SPACE", "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT")
  2359. def testRecvHopLimitCMSG_SPACE(self):
  2360. # Test receiving hop limit, using CMSG_SPACE to calculate buffer size.
  2361. self.checkHopLimit(ancbufsize=socket.CMSG_SPACE(SIZEOF_INT))
  2362. @testRecvHopLimitCMSG_SPACE.client_skip
  2363. def _testRecvHopLimitCMSG_SPACE(self):
  2364. self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
  2365. self.sendToServer(MSG)
  2366. # Could test receiving into buffer sized using CMSG_LEN, but RFC
  2367. # 3542 says portable applications must provide space for trailing
  2368. # padding. Implementations may set MSG_CTRUNC if there isn't
  2369. # enough space for the padding.
  2370. @requireAttrs(socket.socket, "sendmsg")
  2371. @requireAttrs(socket, "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT")
  2372. def testSetHopLimit(self):
  2373. # Test setting hop limit on outgoing packet and receiving it
  2374. # at the other end.
  2375. self.checkHopLimit(ancbufsize=10240, maxhop=self.hop_limit)
  2376. @testSetHopLimit.client_skip
  2377. def _testSetHopLimit(self):
  2378. self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
  2379. self.assertEqual(
  2380. self.sendmsgToServer([MSG],
  2381. [(socket.IPPROTO_IPV6, socket.IPV6_HOPLIMIT,
  2382. array.array("i", [self.hop_limit]))]),
  2383. len(MSG))
  2384. def checkTrafficClassAndHopLimit(self, ancbufsize, maxhop=255,
  2385. ignoreflags=0):
  2386. # Receive traffic class and hop limit into ancbufsize bytes of
  2387. # ancillary data space. Check that data is MSG, ancillary
  2388. # data is not truncated (but ignore any flags in ignoreflags),
  2389. # and traffic class and hop limit are in range (hop limit no
  2390. # more than maxhop).
  2391. self.serv_sock.setsockopt(socket.IPPROTO_IPV6,
  2392. socket.IPV6_RECVHOPLIMIT, 1)
  2393. self.serv_sock.setsockopt(socket.IPPROTO_IPV6,
  2394. socket.IPV6_RECVTCLASS, 1)
  2395. self.misc_event.set()
  2396. msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
  2397. len(MSG), ancbufsize)
  2398. self.assertEqual(msg, MSG)
  2399. self.checkRecvmsgAddress(addr, self.cli_addr)
  2400. self.checkFlags(flags, eor=True, checkunset=socket.MSG_CTRUNC,
  2401. ignore=ignoreflags)
  2402. self.assertEqual(len(ancdata), 2)
  2403. ancmap = self.ancillaryMapping(ancdata)
  2404. tcdata = ancmap[(socket.IPPROTO_IPV6, socket.IPV6_TCLASS)]
  2405. self.assertEqual(len(tcdata), SIZEOF_INT)
  2406. a = array.array("i")
  2407. a.frombytes(tcdata)
  2408. self.assertGreaterEqual(a[0], 0)
  2409. self.assertLessEqual(a[0], 255)
  2410. hldata = ancmap[(socket.IPPROTO_IPV6, socket.IPV6_HOPLIMIT)]
  2411. self.assertEqual(len(hldata), SIZEOF_INT)
  2412. a = array.array("i")
  2413. a.frombytes(hldata)
  2414. self.assertGreaterEqual(a[0], 0)
  2415. self.assertLessEqual(a[0], maxhop)
  2416. @requireAttrs(socket, "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT",
  2417. "IPV6_RECVTCLASS", "IPV6_TCLASS")
  2418. def testRecvTrafficClassAndHopLimit(self):
  2419. # Test receiving traffic class and hop limit as ancillary data.
  2420. self.checkTrafficClassAndHopLimit(ancbufsize=10240)
  2421. @testRecvTrafficClassAndHopLimit.client_skip
  2422. def _testRecvTrafficClassAndHopLimit(self):
  2423. self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
  2424. self.sendToServer(MSG)
  2425. @requireAttrs(socket, "CMSG_SPACE", "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT",
  2426. "IPV6_RECVTCLASS", "IPV6_TCLASS")
  2427. def testRecvTrafficClassAndHopLimitCMSG_SPACE(self):
  2428. # Test receiving traffic class and hop limit, using
  2429. # CMSG_SPACE() to calculate buffer size.
  2430. self.checkTrafficClassAndHopLimit(
  2431. ancbufsize=socket.CMSG_SPACE(SIZEOF_INT) * 2)
  2432. @testRecvTrafficClassAndHopLimitCMSG_SPACE.client_skip
  2433. def _testRecvTrafficClassAndHopLimitCMSG_SPACE(self):
  2434. self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
  2435. self.sendToServer(MSG)
  2436. @requireAttrs(socket.socket, "sendmsg")
  2437. @requireAttrs(socket, "CMSG_SPACE", "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT",
  2438. "IPV6_RECVTCLASS", "IPV6_TCLASS")
  2439. def testSetTrafficClassAndHopLimit(self):
  2440. # Test setting traffic class and hop limit on outgoing packet,
  2441. # and receiving them at the other end.
  2442. self.checkTrafficClassAndHopLimit(ancbufsize=10240,
  2443. maxhop=self.hop_limit)
  2444. @testSetTrafficClassAndHopLimit.client_skip
  2445. def _testSetTrafficClassAndHopLimit(self):
  2446. self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
  2447. self.assertEqual(
  2448. self.sendmsgToServer([MSG],
  2449. [(socket.IPPROTO_IPV6, socket.IPV6_TCLASS,
  2450. array.array("i", [self.traffic_class])),
  2451. (socket.IPPROTO_IPV6, socket.IPV6_HOPLIMIT,
  2452. array.array("i", [self.hop_limit]))]),
  2453. len(MSG))
  2454. @requireAttrs(socket.socket, "sendmsg")
  2455. @requireAttrs(socket, "CMSG_SPACE", "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT",
  2456. "IPV6_RECVTCLASS", "IPV6_TCLASS")
  2457. def testOddCmsgSize(self):
  2458. # Try to send ancillary data with first item one byte too
  2459. # long. Fall back to sending with correct size if this fails,
  2460. # and check that second item was handled correctly.
  2461. self.checkTrafficClassAndHopLimit(ancbufsize=10240,
  2462. maxhop=self.hop_limit)
  2463. @testOddCmsgSize.client_skip
  2464. def _testOddCmsgSize(self):
  2465. self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
  2466. try:
  2467. nbytes = self.sendmsgToServer(
  2468. [MSG],
  2469. [(socket.IPPROTO_IPV6, socket.IPV6_TCLASS,
  2470. array.array("i", [self.traffic_class]).tobytes() + b"\x00"),
  2471. (socket.IPPROTO_IPV6, socket.IPV6_HOPLIMIT,
  2472. array.array("i", [self.hop_limit]))])
  2473. except OSError as e:
  2474. self.assertIsInstance(e.errno, int)
  2475. nbytes = self.sendmsgToServer(
  2476. [MSG],
  2477. [(socket.IPPROTO_IPV6, socket.IPV6_TCLASS,
  2478. array.array("i", [self.traffic_class])),
  2479. (socket.IPPROTO_IPV6, socket.IPV6_HOPLIMIT,
  2480. array.array("i", [self.hop_limit]))])
  2481. self.assertEqual(nbytes, len(MSG))
  2482. # Tests for proper handling of truncated ancillary data
  2483. def checkHopLimitTruncatedHeader(self, ancbufsize, ignoreflags=0):
  2484. # Receive hop limit into ancbufsize bytes of ancillary data
  2485. # space, which should be too small to contain the ancillary
  2486. # data header (if ancbufsize is None, pass no second argument
  2487. # to recvmsg()). Check that data is MSG, MSG_CTRUNC is set
  2488. # (unless included in ignoreflags), and no ancillary data is
  2489. # returned.
  2490. self.serv_sock.setsockopt(socket.IPPROTO_IPV6,
  2491. socket.IPV6_RECVHOPLIMIT, 1)
  2492. self.misc_event.set()
  2493. args = () if ancbufsize is None else (ancbufsize,)
  2494. msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
  2495. len(MSG), *args)
  2496. self.assertEqual(msg, MSG)
  2497. self.checkRecvmsgAddress(addr, self.cli_addr)
  2498. self.assertEqual(ancdata, [])
  2499. self.checkFlags(flags, eor=True, checkset=socket.MSG_CTRUNC,
  2500. ignore=ignoreflags)
  2501. @requireAttrs(socket, "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT")
  2502. def testCmsgTruncNoBufSize(self):
  2503. # Check that no ancillary data is received when no ancillary
  2504. # buffer size is provided.
  2505. self.checkHopLimitTruncatedHeader(ancbufsize=None,
  2506. # BSD seems to set
  2507. # MSG_CTRUNC only if an item
  2508. # has been partially
  2509. # received.
  2510. ignoreflags=socket.MSG_CTRUNC)
  2511. @testCmsgTruncNoBufSize.client_skip
  2512. def _testCmsgTruncNoBufSize(self):
  2513. self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
  2514. self.sendToServer(MSG)
  2515. @requireAttrs(socket, "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT")
  2516. def testSingleCmsgTrunc0(self):
  2517. # Check that no ancillary data is received when ancillary
  2518. # buffer size is zero.
  2519. self.checkHopLimitTruncatedHeader(ancbufsize=0,
  2520. ignoreflags=socket.MSG_CTRUNC)
  2521. @testSingleCmsgTrunc0.client_skip
  2522. def _testSingleCmsgTrunc0(self):
  2523. self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
  2524. self.sendToServer(MSG)
  2525. # Check that no ancillary data is returned for various non-zero
  2526. # (but still too small) buffer sizes.
  2527. @requireAttrs(socket, "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT")
  2528. def testSingleCmsgTrunc1(self):
  2529. self.checkHopLimitTruncatedHeader(ancbufsize=1)
  2530. @testSingleCmsgTrunc1.client_skip
  2531. def _testSingleCmsgTrunc1(self):
  2532. self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
  2533. self.sendToServer(MSG)
  2534. @requireAttrs(socket, "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT")
  2535. def testSingleCmsgTrunc2Int(self):
  2536. self.checkHopLimitTruncatedHeader(ancbufsize=2 * SIZEOF_INT)
  2537. @testSingleCmsgTrunc2Int.client_skip
  2538. def _testSingleCmsgTrunc2Int(self):
  2539. self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
  2540. self.sendToServer(MSG)
  2541. @requireAttrs(socket, "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT")
  2542. def testSingleCmsgTruncLen0Minus1(self):
  2543. self.checkHopLimitTruncatedHeader(ancbufsize=socket.CMSG_LEN(0) - 1)
  2544. @testSingleCmsgTruncLen0Minus1.client_skip
  2545. def _testSingleCmsgTruncLen0Minus1(self):
  2546. self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
  2547. self.sendToServer(MSG)
  2548. @requireAttrs(socket, "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT")
  2549. def testSingleCmsgTruncInData(self):
  2550. # Test truncation of a control message inside its associated
  2551. # data. The message may be returned with its data truncated,
  2552. # or not returned at all.
  2553. self.serv_sock.setsockopt(socket.IPPROTO_IPV6,
  2554. socket.IPV6_RECVHOPLIMIT, 1)
  2555. self.misc_event.set()
  2556. msg, ancdata, flags, addr = self.doRecvmsg(
  2557. self.serv_sock, len(MSG), socket.CMSG_LEN(SIZEOF_INT) - 1)
  2558. self.assertEqual(msg, MSG)
  2559. self.checkRecvmsgAddress(addr, self.cli_addr)
  2560. self.checkFlags(flags, eor=True, checkset=socket.MSG_CTRUNC)
  2561. self.assertLessEqual(len(ancdata), 1)
  2562. if ancdata:
  2563. cmsg_level, cmsg_type, cmsg_data = ancdata[0]
  2564. self.assertEqual(cmsg_level, socket.IPPROTO_IPV6)
  2565. self.assertEqual(cmsg_type, socket.IPV6_HOPLIMIT)
  2566. self.assertLess(len(cmsg_data), SIZEOF_INT)
  2567. @testSingleCmsgTruncInData.client_skip
  2568. def _testSingleCmsgTruncInData(self):
  2569. self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
  2570. self.sendToServer(MSG)
  2571. def checkTruncatedSecondHeader(self, ancbufsize, ignoreflags=0):
  2572. # Receive traffic class and hop limit into ancbufsize bytes of
  2573. # ancillary data space, which should be large enough to
  2574. # contain the first item, but too small to contain the header
  2575. # of the second. Check that data is MSG, MSG_CTRUNC is set
  2576. # (unless included in ignoreflags), and only one ancillary
  2577. # data item is returned.
  2578. self.serv_sock.setsockopt(socket.IPPROTO_IPV6,
  2579. socket.IPV6_RECVHOPLIMIT, 1)
  2580. self.serv_sock.setsockopt(socket.IPPROTO_IPV6,
  2581. socket.IPV6_RECVTCLASS, 1)
  2582. self.misc_event.set()
  2583. msg, ancdata, flags, addr = self.doRecvmsg(self.serv_sock,
  2584. len(MSG), ancbufsize)
  2585. self.assertEqual(msg, MSG)
  2586. self.checkRecvmsgAddress(addr, self.cli_addr)
  2587. self.checkFlags(flags, eor=True, checkset=socket.MSG_CTRUNC,
  2588. ignore=ignoreflags)
  2589. self.assertEqual(len(ancdata), 1)
  2590. cmsg_level, cmsg_type, cmsg_data = ancdata[0]
  2591. self.assertEqual(cmsg_level, socket.IPPROTO_IPV6)
  2592. self.assertIn(cmsg_type, {socket.IPV6_TCLASS, socket.IPV6_HOPLIMIT})
  2593. self.assertEqual(len(cmsg_data), SIZEOF_INT)
  2594. a = array.array("i")
  2595. a.frombytes(cmsg_data)
  2596. self.assertGreaterEqual(a[0], 0)
  2597. self.assertLessEqual(a[0], 255)
  2598. # Try the above test with various buffer sizes.
  2599. @requireAttrs(socket, "CMSG_SPACE", "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT",
  2600. "IPV6_RECVTCLASS", "IPV6_TCLASS")
  2601. def testSecondCmsgTrunc0(self):
  2602. self.checkTruncatedSecondHeader(socket.CMSG_SPACE(SIZEOF_INT),
  2603. ignoreflags=socket.MSG_CTRUNC)
  2604. @testSecondCmsgTrunc0.client_skip
  2605. def _testSecondCmsgTrunc0(self):
  2606. self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
  2607. self.sendToServer(MSG)
  2608. @requireAttrs(socket, "CMSG_SPACE", "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT",
  2609. "IPV6_RECVTCLASS", "IPV6_TCLASS")
  2610. def testSecondCmsgTrunc1(self):
  2611. self.checkTruncatedSecondHeader(socket.CMSG_SPACE(SIZEOF_INT) + 1)
  2612. @testSecondCmsgTrunc1.client_skip
  2613. def _testSecondCmsgTrunc1(self):
  2614. self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
  2615. self.sendToServer(MSG)
  2616. @requireAttrs(socket, "CMSG_SPACE", "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT",
  2617. "IPV6_RECVTCLASS", "IPV6_TCLASS")
  2618. def testSecondCmsgTrunc2Int(self):
  2619. self.checkTruncatedSecondHeader(socket.CMSG_SPACE(SIZEOF_INT) +
  2620. 2 * SIZEOF_INT)
  2621. @testSecondCmsgTrunc2Int.client_skip
  2622. def _testSecondCmsgTrunc2Int(self):
  2623. self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
  2624. self.sendToServer(MSG)
  2625. @requireAttrs(socket, "CMSG_SPACE", "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT",
  2626. "IPV6_RECVTCLASS", "IPV6_TCLASS")
  2627. def testSecondCmsgTruncLen0Minus1(self):
  2628. self.checkTruncatedSecondHeader(socket.CMSG_SPACE(SIZEOF_INT) +
  2629. socket.CMSG_LEN(0) - 1)
  2630. @testSecondCmsgTruncLen0Minus1.client_skip
  2631. def _testSecondCmsgTruncLen0Minus1(self):
  2632. self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
  2633. self.sendToServer(MSG)
  2634. @requireAttrs(socket, "CMSG_SPACE", "IPV6_RECVHOPLIMIT", "IPV6_HOPLIMIT",
  2635. "IPV6_RECVTCLASS", "IPV6_TCLASS")
  2636. def testSecomdCmsgTruncInData(self):
  2637. # Test truncation of the second of two control messages inside
  2638. # its associated data.
  2639. self.serv_sock.setsockopt(socket.IPPROTO_IPV6,
  2640. socket.IPV6_RECVHOPLIMIT, 1)
  2641. self.serv_sock.setsockopt(socket.IPPROTO_IPV6,
  2642. socket.IPV6_RECVTCLASS, 1)
  2643. self.misc_event.set()
  2644. msg, ancdata, flags, addr = self.doRecvmsg(
  2645. self.serv_sock, len(MSG),
  2646. socket.CMSG_SPACE(SIZEOF_INT) + socket.CMSG_LEN(SIZEOF_INT) - 1)
  2647. self.assertEqual(msg, MSG)
  2648. self.checkRecvmsgAddress(addr, self.cli_addr)
  2649. self.checkFlags(flags, eor=True, checkset=socket.MSG_CTRUNC)
  2650. cmsg_types = {socket.IPV6_TCLASS, socket.IPV6_HOPLIMIT}
  2651. cmsg_level, cmsg_type, cmsg_data = ancdata.pop(0)
  2652. self.assertEqual(cmsg_level, socket.IPPROTO_IPV6)
  2653. cmsg_types.remove(cmsg_type)
  2654. self.assertEqual(len(cmsg_data), SIZEOF_INT)
  2655. a = array.array("i")
  2656. a.frombytes(cmsg_data)
  2657. self.assertGreaterEqual(a[0], 0)
  2658. self.assertLessEqual(a[0], 255)
  2659. if ancdata:
  2660. cmsg_level, cmsg_type, cmsg_data = ancdata.pop(0)
  2661. self.assertEqual(cmsg_level, socket.IPPROTO_IPV6)
  2662. cmsg_types.remove(cmsg_type)
  2663. self.assertLess(len(cmsg_data), SIZEOF_INT)
  2664. self.assertEqual(ancdata, [])
  2665. @testSecomdCmsgTruncInData.client_skip
  2666. def _testSecomdCmsgTruncInData(self):
  2667. self.assertTrue(self.misc_event.wait(timeout=self.fail_timeout))
  2668. self.sendToServer(MSG)
  2669. # Derive concrete test classes for different socket types.
  2670. class SendrecvmsgUDPTestBase(SendrecvmsgDgramFlagsBase,
  2671. SendrecvmsgConnectionlessBase,
  2672. ThreadedSocketTestMixin, UDPTestBase):
  2673. pass
  2674. @requireAttrs(socket.socket, "sendmsg")
  2675. @unittest.skipUnless(thread, 'Threading required for this test.')
  2676. class SendmsgUDPTest(SendmsgConnectionlessTests, SendrecvmsgUDPTestBase):
  2677. pass
  2678. @requireAttrs(socket.socket, "recvmsg")
  2679. @unittest.skipUnless(thread, 'Threading required for this test.')
  2680. class RecvmsgUDPTest(RecvmsgTests, SendrecvmsgUDPTestBase):
  2681. pass
  2682. @requireAttrs(socket.socket, "recvmsg_into")
  2683. @unittest.skipUnless(thread, 'Threading required for this test.')
  2684. class RecvmsgIntoUDPTest(RecvmsgIntoTests, SendrecvmsgUDPTestBase):
  2685. pass
  2686. class SendrecvmsgUDP6TestBase(SendrecvmsgDgramFlagsBase,
  2687. SendrecvmsgConnectionlessBase,
  2688. ThreadedSocketTestMixin, UDP6TestBase):
  2689. pass
  2690. @requireAttrs(socket.socket, "sendmsg")
  2691. @unittest.skipUnless(support.IPV6_ENABLED, 'IPv6 required for this test.')
  2692. @requireSocket("AF_INET6", "SOCK_DGRAM")
  2693. @unittest.skipUnless(thread, 'Threading required for this test.')
  2694. class SendmsgUDP6Test(SendmsgConnectionlessTests, SendrecvmsgUDP6TestBase):
  2695. pass
  2696. @requireAttrs(socket.socket, "recvmsg")
  2697. @unittest.skipUnless(support.IPV6_ENABLED, 'IPv6 required for this test.')
  2698. @requireSocket("AF_INET6", "SOCK_DGRAM")
  2699. @unittest.skipUnless(thread, 'Threading required for this test.')
  2700. class RecvmsgUDP6Test(RecvmsgTests, SendrecvmsgUDP6TestBase):
  2701. pass
  2702. @requireAttrs(socket.socket, "recvmsg_into")
  2703. @unittest.skipUnless(support.IPV6_ENABLED, 'IPv6 required for this test.')
  2704. @requireSocket("AF_INET6", "SOCK_DGRAM")
  2705. @unittest.skipUnless(thread, 'Threading required for this test.')
  2706. class RecvmsgIntoUDP6Test(RecvmsgIntoTests, SendrecvmsgUDP6TestBase):
  2707. pass
  2708. @requireAttrs(socket.socket, "recvmsg")
  2709. @unittest.skipUnless(support.IPV6_ENABLED, 'IPv6 required for this test.')
  2710. @requireAttrs(socket, "IPPROTO_IPV6")
  2711. @requireSocket("AF_INET6", "SOCK_DGRAM")
  2712. @unittest.skipUnless(thread, 'Threading required for this test.')
  2713. class RecvmsgRFC3542AncillaryUDP6Test(RFC3542AncillaryTest,
  2714. SendrecvmsgUDP6TestBase):
  2715. pass
  2716. @requireAttrs(socket.socket, "recvmsg_into")
  2717. @unittest.skipUnless(support.IPV6_ENABLED, 'IPv6 required for this test.')
  2718. @requireAttrs(socket, "IPPROTO_IPV6")
  2719. @requireSocket("AF_INET6", "SOCK_DGRAM")
  2720. @unittest.skipUnless(thread, 'Threading required for this test.')
  2721. class RecvmsgIntoRFC3542AncillaryUDP6Test(RecvmsgIntoMixin,
  2722. RFC3542AncillaryTest,
  2723. SendrecvmsgUDP6TestBase):
  2724. pass
  2725. class SendrecvmsgTCPTestBase(SendrecvmsgConnectedBase,
  2726. ConnectedStreamTestMixin, TCPTestBase):
  2727. pass
  2728. @requireAttrs(socket.socket, "sendmsg")
  2729. @unittest.skipUnless(thread, 'Threading required for this test.')
  2730. class SendmsgTCPTest(SendmsgStreamTests, SendrecvmsgTCPTestBase):
  2731. pass
  2732. @requireAttrs(socket.socket, "recvmsg")
  2733. @unittest.skipUnless(thread, 'Threading required for this test.')
  2734. class RecvmsgTCPTest(RecvmsgTests, RecvmsgGenericStreamTests,
  2735. SendrecvmsgTCPTestBase):
  2736. pass
  2737. @requireAttrs(socket.socket, "recvmsg_into")
  2738. @unittest.skipUnless(thread, 'Threading required for this test.')
  2739. class RecvmsgIntoTCPTest(RecvmsgIntoTests, RecvmsgGenericStreamTests,
  2740. SendrecvmsgTCPTestBase):
  2741. pass
  2742. class SendrecvmsgSCTPStreamTestBase(SendrecvmsgSCTPFlagsBase,
  2743. SendrecvmsgConnectedBase,
  2744. ConnectedStreamTestMixin, SCTPStreamBase):
  2745. pass
  2746. @requireAttrs(socket.socket, "sendmsg")
  2747. @requireSocket("AF_INET", "SOCK_STREAM", "IPPROTO_SCTP")
  2748. @unittest.skipUnless(thread, 'Threading required for this test.')
  2749. class SendmsgSCTPStreamTest(SendmsgStreamTests, SendrecvmsgSCTPStreamTestBase):
  2750. pass
  2751. @requireAttrs(socket.socket, "recvmsg")
  2752. @requireSocket("AF_INET", "SOCK_STREAM", "IPPROTO_SCTP")
  2753. @unittest.skipUnless(thread, 'Threading required for this test.')
  2754. class RecvmsgSCTPStreamTest(RecvmsgTests, RecvmsgGenericStreamTests,
  2755. SendrecvmsgSCTPStreamTestBase):
  2756. def testRecvmsgEOF(self):
  2757. try:
  2758. super(RecvmsgSCTPStreamTest, self).testRecvmsgEOF()
  2759. except OSError as e:
  2760. if e.errno != errno.ENOTCONN:
  2761. raise
  2762. self.skipTest("sporadic ENOTCONN (kernel issue?) - see issue #13876")
  2763. @requireAttrs(socket.socket, "recvmsg_into")
  2764. @requireSocket("AF_INET", "SOCK_STREAM", "IPPROTO_SCTP")
  2765. @unittest.skipUnless(thread, 'Threading required for this test.')
  2766. class RecvmsgIntoSCTPStreamTest(RecvmsgIntoTests, RecvmsgGenericStreamTests,
  2767. SendrecvmsgSCTPStreamTestBase):
  2768. def testRecvmsgEOF(self):
  2769. try:
  2770. super(RecvmsgIntoSCTPStreamTest, self).testRecvmsgEOF()
  2771. except OSError as e:
  2772. if e.errno != errno.ENOTCONN:
  2773. raise
  2774. self.skipTest("sporadic ENOTCONN (kernel issue?) - see issue #13876")
  2775. class SendrecvmsgUnixStreamTestBase(SendrecvmsgConnectedBase,
  2776. ConnectedStreamTestMixin, UnixStreamBase):
  2777. pass
  2778. @requireAttrs(socket.socket, "sendmsg")
  2779. @requireAttrs(socket, "AF_UNIX")
  2780. @unittest.skipUnless(thread, 'Threading required for this test.')
  2781. class SendmsgUnixStreamTest(SendmsgStreamTests, SendrecvmsgUnixStreamTestBase):
  2782. pass
  2783. @requireAttrs(socket.socket, "recvmsg")
  2784. @requireAttrs(socket, "AF_UNIX")
  2785. @unittest.skipUnless(thread, 'Threading required for this test.')
  2786. class RecvmsgUnixStreamTest(RecvmsgTests, RecvmsgGenericStreamTests,
  2787. SendrecvmsgUnixStreamTestBase):
  2788. pass
  2789. @requireAttrs(socket.socket, "recvmsg_into")
  2790. @requireAttrs(socket, "AF_UNIX")
  2791. @unittest.skipUnless(thread, 'Threading required for this test.')
  2792. class RecvmsgIntoUnixStreamTest(RecvmsgIntoTests, RecvmsgGenericStreamTests,
  2793. SendrecvmsgUnixStreamTestBase):
  2794. pass
  2795. @requireAttrs(socket.socket, "sendmsg", "recvmsg")
  2796. @requireAttrs(socket, "AF_UNIX", "SOL_SOCKET", "SCM_RIGHTS")
  2797. @unittest.skipUnless(thread, 'Threading required for this test.')
  2798. class RecvmsgSCMRightsStreamTest(SCMRightsTest, SendrecvmsgUnixStreamTestBase):
  2799. pass
  2800. @requireAttrs(socket.socket, "sendmsg", "recvmsg_into")
  2801. @requireAttrs(socket, "AF_UNIX", "SOL_SOCKET", "SCM_RIGHTS")
  2802. @unittest.skipUnless(thread, 'Threading required for this test.')
  2803. class RecvmsgIntoSCMRightsStreamTest(RecvmsgIntoMixin, SCMRightsTest,
  2804. SendrecvmsgUnixStreamTestBase):
  2805. pass
  2806. # Test interrupting the interruptible send/receive methods with a
  2807. # signal when a timeout is set. These tests avoid having multiple
  2808. # threads alive during the test so that the OS cannot deliver the
  2809. # signal to the wrong one.
  2810. class InterruptedTimeoutBase(unittest.TestCase):
  2811. # Base class for interrupted send/receive tests. Installs an
  2812. # empty handler for SIGALRM and removes it on teardown, along with
  2813. # any scheduled alarms.
  2814. def setUp(self):
  2815. super().setUp()
  2816. orig_alrm_handler = signal.signal(signal.SIGALRM,
  2817. lambda signum, frame: None)
  2818. self.addCleanup(signal.signal, signal.SIGALRM, orig_alrm_handler)
  2819. self.addCleanup(self.setAlarm, 0)
  2820. # Timeout for socket operations
  2821. timeout = 4.0
  2822. # Provide setAlarm() method to schedule delivery of SIGALRM after
  2823. # given number of seconds, or cancel it if zero, and an
  2824. # appropriate time value to use. Use setitimer() if available.
  2825. if hasattr(signal, "setitimer"):
  2826. alarm_time = 0.05
  2827. def setAlarm(self, seconds):
  2828. signal.setitimer(signal.ITIMER_REAL, seconds)
  2829. else:
  2830. # Old systems may deliver the alarm up to one second early
  2831. alarm_time = 2
  2832. def setAlarm(self, seconds):
  2833. signal.alarm(seconds)
  2834. # Require siginterrupt() in order to ensure that system calls are
  2835. # interrupted by default.
  2836. @requireAttrs(signal, "siginterrupt")
  2837. @unittest.skipUnless(hasattr(signal, "alarm") or hasattr(signal, "setitimer"),
  2838. "Don't have signal.alarm or signal.setitimer")
  2839. class InterruptedRecvTimeoutTest(InterruptedTimeoutBase, UDPTestBase):
  2840. # Test interrupting the recv*() methods with signals when a
  2841. # timeout is set.
  2842. def setUp(self):
  2843. super().setUp()
  2844. self.serv.settimeout(self.timeout)
  2845. def checkInterruptedRecv(self, func, *args, **kwargs):
  2846. # Check that func(*args, **kwargs) raises OSError with an
  2847. # errno of EINTR when interrupted by a signal.
  2848. self.setAlarm(self.alarm_time)
  2849. with self.assertRaises(OSError) as cm:
  2850. func(*args, **kwargs)
  2851. self.assertNotIsInstance(cm.exception, socket.timeout)
  2852. self.assertEqual(cm.exception.errno, errno.EINTR)
  2853. def testInterruptedRecvTimeout(self):
  2854. self.checkInterruptedRecv(self.serv.recv, 1024)
  2855. def testInterruptedRecvIntoTimeout(self):
  2856. self.checkInterruptedRecv(self.serv.recv_into, bytearray(1024))
  2857. def testInterruptedRecvfromTimeout(self):
  2858. self.checkInterruptedRecv(self.serv.recvfrom, 1024)
  2859. def testInterruptedRecvfromIntoTimeout(self):
  2860. self.checkInterruptedRecv(self.serv.recvfrom_into, bytearray(1024))
  2861. @requireAttrs(socket.socket, "recvmsg")
  2862. def testInterruptedRecvmsgTimeout(self):
  2863. self.checkInterruptedRecv(self.serv.recvmsg, 1024)
  2864. @requireAttrs(socket.socket, "recvmsg_into")
  2865. def testInterruptedRecvmsgIntoTimeout(self):
  2866. self.checkInterruptedRecv(self.serv.recvmsg_into, [bytearray(1024)])
  2867. # Require siginterrupt() in order to ensure that system calls are
  2868. # interrupted by default.
  2869. @requireAttrs(signal, "siginterrupt")
  2870. @unittest.skipUnless(hasattr(signal, "alarm") or hasattr(signal, "setitimer"),
  2871. "Don't have signal.alarm or signal.setitimer")
  2872. @unittest.skipUnless(thread, 'Threading required for this test.')
  2873. class InterruptedSendTimeoutTest(InterruptedTimeoutBase,
  2874. ThreadSafeCleanupTestCase,
  2875. SocketListeningTestMixin, TCPTestBase):
  2876. # Test interrupting the interruptible send*() methods with signals
  2877. # when a timeout is set.
  2878. def setUp(self):
  2879. super().setUp()
  2880. self.serv_conn = self.newSocket()
  2881. self.addCleanup(self.serv_conn.close)
  2882. # Use a thread to complete the connection, but wait for it to
  2883. # terminate before running the test, so that there is only one
  2884. # thread to accept the signal.
  2885. cli_thread = threading.Thread(target=self.doConnect)
  2886. cli_thread.start()
  2887. self.cli_conn, addr = self.serv.accept()
  2888. self.addCleanup(self.cli_conn.close)
  2889. cli_thread.join()
  2890. self.serv_conn.settimeout(self.timeout)
  2891. def doConnect(self):
  2892. self.serv_conn.connect(self.serv_addr)
  2893. def checkInterruptedSend(self, func, *args, **kwargs):
  2894. # Check that func(*args, **kwargs), run in a loop, raises
  2895. # OSError with an errno of EINTR when interrupted by a
  2896. # signal.
  2897. with self.assertRaises(OSError) as cm:
  2898. while True:
  2899. self.setAlarm(self.alarm_time)
  2900. func(*args, **kwargs)
  2901. self.assertNotIsInstance(cm.exception, socket.timeout)
  2902. self.assertEqual(cm.exception.errno, errno.EINTR)
  2903. # Issue #12958: The following tests have problems on Mac OS X
  2904. @support.anticipate_failure(sys.platform == "darwin")
  2905. def testInterruptedSendTimeout(self):
  2906. self.checkInterruptedSend(self.serv_conn.send, b"a"*512)
  2907. @support.anticipate_failure(sys.platform == "darwin")
  2908. def testInterruptedSendtoTimeout(self):
  2909. # Passing an actual address here as Python's wrapper for
  2910. # sendto() doesn't allow passing a zero-length one; POSIX
  2911. # requires that the address is ignored since the socket is
  2912. # connection-mode, however.
  2913. self.checkInterruptedSend(self.serv_conn.sendto, b"a"*512,
  2914. self.serv_addr)
  2915. @support.anticipate_failure(sys.platform == "darwin")
  2916. @requireAttrs(socket.socket, "sendmsg")
  2917. def testInterruptedSendmsgTimeout(self):
  2918. self.checkInterruptedSend(self.serv_conn.sendmsg, [b"a"*512])
  2919. @unittest.skipUnless(thread, 'Threading required for this test.')
  2920. class TCPCloserTest(ThreadedTCPSocketTest):
  2921. def testClose(self):
  2922. conn, addr = self.serv.accept()
  2923. conn.close()
  2924. sd = self.cli
  2925. read, write, err = select.select([sd], [], [], 1.0)
  2926. self.assertEqual(read, [sd])
  2927. self.assertEqual(sd.recv(1), b'')
  2928. # Calling close() many times should be safe.
  2929. conn.close()
  2930. conn.close()
  2931. def _testClose(self):
  2932. self.cli.connect((HOST, self.port))
  2933. time.sleep(1.0)
  2934. @unittest.skipUnless(thread, 'Threading required for this test.')
  2935. class BasicSocketPairTest(SocketPairTest):
  2936. def __init__(self, methodName='runTest'):
  2937. SocketPairTest.__init__(self, methodName=methodName)
  2938. def _check_defaults(self, sock):
  2939. self.assertIsInstance(sock, socket.socket)
  2940. if hasattr(socket, 'AF_UNIX'):
  2941. self.assertEqual(sock.family, socket.AF_UNIX)
  2942. else:
  2943. self.assertEqual(sock.family, socket.AF_INET)
  2944. self.assertEqual(sock.type, socket.SOCK_STREAM)
  2945. self.assertEqual(sock.proto, 0)
  2946. def _testDefaults(self):
  2947. self._check_defaults(self.cli)
  2948. def testDefaults(self):
  2949. self._check_defaults(self.serv)
  2950. def testRecv(self):
  2951. msg = self.serv.recv(1024)
  2952. self.assertEqual(msg, MSG)
  2953. def _testRecv(self):
  2954. self.cli.send(MSG)
  2955. def testSend(self):
  2956. self.serv.send(MSG)
  2957. def _testSend(self):
  2958. msg = self.cli.recv(1024)
  2959. self.assertEqual(msg, MSG)
  2960. @unittest.skipUnless(thread, 'Threading required for this test.')
  2961. class NonBlockingTCPTests(ThreadedTCPSocketTest):
  2962. def __init__(self, methodName='runTest'):
  2963. ThreadedTCPSocketTest.__init__(self, methodName=methodName)
  2964. def testSetBlocking(self):
  2965. # Testing whether set blocking works
  2966. self.serv.setblocking(True)
  2967. self.assertIsNone(self.serv.gettimeout())
  2968. self.serv.setblocking(False)
  2969. self.assertEqual(self.serv.gettimeout(), 0.0)
  2970. start = time.time()
  2971. try:
  2972. self.serv.accept()
  2973. except OSError:
  2974. pass
  2975. end = time.time()
  2976. self.assertTrue((end - start) < 1.0, "Error setting non-blocking mode.")
  2977. # Issue 15989
  2978. if _testcapi.UINT_MAX < _testcapi.ULONG_MAX:
  2979. self.serv.setblocking(_testcapi.UINT_MAX + 1)
  2980. self.assertIsNone(self.serv.gettimeout())
  2981. def _testSetBlocking(self):
  2982. pass
  2983. if hasattr(socket, "SOCK_NONBLOCK"):
  2984. @support.requires_linux_version(2, 6, 28)
  2985. def testInitNonBlocking(self):
  2986. # reinit server socket
  2987. self.serv.close()
  2988. self.serv = socket.socket(socket.AF_INET, socket.SOCK_STREAM |
  2989. socket.SOCK_NONBLOCK)
  2990. self.port = support.bind_port(self.serv)
  2991. self.serv.listen(1)
  2992. # actual testing
  2993. start = time.time()
  2994. try:
  2995. self.serv.accept()
  2996. except OSError:
  2997. pass
  2998. end = time.time()
  2999. self.assertTrue((end - start) < 1.0, "Error creating with non-blocking mode.")
  3000. def _testInitNonBlocking(self):
  3001. pass
  3002. def testInheritFlags(self):
  3003. # Issue #7995: when calling accept() on a listening socket with a
  3004. # timeout, the resulting socket should not be non-blocking.
  3005. self.serv.settimeout(10)
  3006. try:
  3007. conn, addr = self.serv.accept()
  3008. message = conn.recv(len(MSG))
  3009. finally:
  3010. conn.close()
  3011. self.serv.settimeout(None)
  3012. def _testInheritFlags(self):
  3013. time.sleep(0.1)
  3014. self.cli.connect((HOST, self.port))
  3015. time.sleep(0.5)
  3016. self.cli.send(MSG)
  3017. def testAccept(self):
  3018. # Testing non-blocking accept
  3019. self.serv.setblocking(0)
  3020. try:
  3021. conn, addr = self.serv.accept()
  3022. except OSError:
  3023. pass
  3024. else:
  3025. self.fail("Error trying to do non-blocking accept.")
  3026. read, write, err = select.select([self.serv], [], [])
  3027. if self.serv in read:
  3028. conn, addr = self.serv.accept()
  3029. conn.close()
  3030. else:
  3031. self.fail("Error trying to do accept after select.")
  3032. def _testAccept(self):
  3033. time.sleep(0.1)
  3034. self.cli.connect((HOST, self.port))
  3035. def testConnect(self):
  3036. # Testing non-blocking connect
  3037. conn, addr = self.serv.accept()
  3038. conn.close()
  3039. def _testConnect(self):
  3040. self.cli.settimeout(10)
  3041. self.cli.connect((HOST, self.port))
  3042. def testRecv(self):
  3043. # Testing non-blocking recv
  3044. conn, addr = self.serv.accept()
  3045. conn.setblocking(0)
  3046. try:
  3047. msg = conn.recv(len(MSG))
  3048. except OSError:
  3049. pass
  3050. else:
  3051. self.fail("Error trying to do non-blocking recv.")
  3052. read, write, err = select.select([conn], [], [])
  3053. if conn in read:
  3054. msg = conn.recv(len(MSG))
  3055. conn.close()
  3056. self.assertEqual(msg, MSG)
  3057. else:
  3058. self.fail("Error during select call to non-blocking socket.")
  3059. def _testRecv(self):
  3060. self.cli.connect((HOST, self.port))
  3061. time.sleep(0.1)
  3062. self.cli.send(MSG)
  3063. @unittest.skipUnless(thread, 'Threading required for this test.')
  3064. class FileObjectClassTestCase(SocketConnectedTest):
  3065. """Unit tests for the object returned by socket.makefile()
  3066. self.read_file is the io object returned by makefile() on
  3067. the client connection. You can read from this file to
  3068. get output from the server.
  3069. self.write_file is the io object returned by makefile() on the
  3070. server connection. You can write to this file to send output
  3071. to the client.
  3072. """
  3073. bufsize = -1 # Use default buffer size
  3074. encoding = 'utf-8'
  3075. errors = 'strict'
  3076. newline = None
  3077. read_mode = 'rb'
  3078. read_msg = MSG
  3079. write_mode = 'wb'
  3080. write_msg = MSG
  3081. def __init__(self, methodName='runTest'):
  3082. SocketConnectedTest.__init__(self, methodName=methodName)
  3083. def setUp(self):
  3084. self.evt1, self.evt2, self.serv_finished, self.cli_finished = [
  3085. threading.Event() for i in range(4)]
  3086. SocketConnectedTest.setUp(self)
  3087. self.read_file = self.cli_conn.makefile(
  3088. self.read_mode, self.bufsize,
  3089. encoding = self.encoding,
  3090. errors = self.errors,
  3091. newline = self.newline)
  3092. def tearDown(self):
  3093. self.serv_finished.set()
  3094. self.read_file.close()
  3095. self.assertTrue(self.read_file.closed)
  3096. self.read_file = None
  3097. SocketConnectedTest.tearDown(self)
  3098. def clientSetUp(self):
  3099. SocketConnectedTest.clientSetUp(self)
  3100. self.write_file = self.serv_conn.makefile(
  3101. self.write_mode, self.bufsize,
  3102. encoding = self.encoding,
  3103. errors = self.errors,
  3104. newline = self.newline)
  3105. def clientTearDown(self):
  3106. self.cli_finished.set()
  3107. self.write_file.close()
  3108. self.assertTrue(self.write_file.closed)
  3109. self.write_file = None
  3110. SocketConnectedTest.clientTearDown(self)
  3111. def testReadAfterTimeout(self):
  3112. # Issue #7322: A file object must disallow further reads
  3113. # after a timeout has occurred.
  3114. self.cli_conn.settimeout(1)
  3115. self.read_file.read(3)
  3116. # First read raises a timeout
  3117. self.assertRaises(socket.timeout, self.read_file.read, 1)
  3118. # Second read is disallowed
  3119. with self.assertRaises(OSError) as ctx:
  3120. self.read_file.read(1)
  3121. self.assertIn("cannot read from timed out object", str(ctx.exception))
  3122. def _testReadAfterTimeout(self):
  3123. self.write_file.write(self.write_msg[0:3])
  3124. self.write_file.flush()
  3125. self.serv_finished.wait()
  3126. def testSmallRead(self):
  3127. # Performing small file read test
  3128. first_seg = self.read_file.read(len(self.read_msg)-3)
  3129. second_seg = self.read_file.read(3)
  3130. msg = first_seg + second_seg
  3131. self.assertEqual(msg, self.read_msg)
  3132. def _testSmallRead(self):
  3133. self.write_file.write(self.write_msg)
  3134. self.write_file.flush()
  3135. def testFullRead(self):
  3136. # read until EOF
  3137. msg = self.read_file.read()
  3138. self.assertEqual(msg, self.read_msg)
  3139. def _testFullRead(self):
  3140. self.write_file.write(self.write_msg)
  3141. self.write_file.close()
  3142. def testUnbufferedRead(self):
  3143. # Performing unbuffered file read test
  3144. buf = type(self.read_msg)()
  3145. while 1:
  3146. char = self.read_file.read(1)
  3147. if not char:
  3148. break
  3149. buf += char
  3150. self.assertEqual(buf, self.read_msg)
  3151. def _testUnbufferedRead(self):
  3152. self.write_file.write(self.write_msg)
  3153. self.write_file.flush()
  3154. def testReadline(self):
  3155. # Performing file readline test
  3156. line = self.read_file.readline()
  3157. self.assertEqual(line, self.read_msg)
  3158. def _testReadline(self):
  3159. self.write_file.write(self.write_msg)
  3160. self.write_file.flush()
  3161. def testCloseAfterMakefile(self):
  3162. # The file returned by makefile should keep the socket open.
  3163. self.cli_conn.close()
  3164. # read until EOF
  3165. msg = self.read_file.read()
  3166. self.assertEqual(msg, self.read_msg)
  3167. def _testCloseAfterMakefile(self):
  3168. self.write_file.write(self.write_msg)
  3169. self.write_file.flush()
  3170. def testMakefileAfterMakefileClose(self):
  3171. self.read_file.close()
  3172. msg = self.cli_conn.recv(len(MSG))
  3173. if isinstance(self.read_msg, str):
  3174. msg = msg.decode()
  3175. self.assertEqual(msg, self.read_msg)
  3176. def _testMakefileAfterMakefileClose(self):
  3177. self.write_file.write(self.write_msg)
  3178. self.write_file.flush()
  3179. def testClosedAttr(self):
  3180. self.assertTrue(not self.read_file.closed)
  3181. def _testClosedAttr(self):
  3182. self.assertTrue(not self.write_file.closed)
  3183. def testAttributes(self):
  3184. self.assertEqual(self.read_file.mode, self.read_mode)
  3185. self.assertEqual(self.read_file.name, self.cli_conn.fileno())
  3186. def _testAttributes(self):
  3187. self.assertEqual(self.write_file.mode, self.write_mode)
  3188. self.assertEqual(self.write_file.name, self.serv_conn.fileno())
  3189. def testRealClose(self):
  3190. self.read_file.close()
  3191. self.assertRaises(ValueError, self.read_file.fileno)
  3192. self.cli_conn.close()
  3193. self.assertRaises(OSError, self.cli_conn.getsockname)
  3194. def _testRealClose(self):
  3195. pass
  3196. class FileObjectInterruptedTestCase(unittest.TestCase):
  3197. """Test that the file object correctly handles EINTR internally."""
  3198. class MockSocket(object):
  3199. def __init__(self, recv_funcs=()):
  3200. # A generator that returns callables that we'll call for each
  3201. # call to recv().
  3202. self._recv_step = iter(recv_funcs)
  3203. def recv_into(self, buffer):
  3204. data = next(self._recv_step)()
  3205. assert len(buffer) >= len(data)
  3206. buffer[:len(data)] = data
  3207. return len(data)
  3208. def _decref_socketios(self):
  3209. pass
  3210. def _textiowrap_for_test(self, buffering=-1):
  3211. raw = socket.SocketIO(self, "r")
  3212. if buffering < 0:
  3213. buffering = io.DEFAULT_BUFFER_SIZE
  3214. if buffering == 0:
  3215. return raw
  3216. buffer = io.BufferedReader(raw, buffering)
  3217. text = io.TextIOWrapper(buffer, None, None)
  3218. text.mode = "rb"
  3219. return text
  3220. @staticmethod
  3221. def _raise_eintr():
  3222. raise OSError(errno.EINTR, "interrupted")
  3223. def _textiowrap_mock_socket(self, mock, buffering=-1):
  3224. raw = socket.SocketIO(mock, "r")
  3225. if buffering < 0:
  3226. buffering = io.DEFAULT_BUFFER_SIZE
  3227. if buffering == 0:
  3228. return raw
  3229. buffer = io.BufferedReader(raw, buffering)
  3230. text = io.TextIOWrapper(buffer, None, None)
  3231. text.mode = "rb"
  3232. return text
  3233. def _test_readline(self, size=-1, buffering=-1):
  3234. mock_sock = self.MockSocket(recv_funcs=[
  3235. lambda : b"This is the first line\nAnd the sec",
  3236. self._raise_eintr,
  3237. lambda : b"ond line is here\n",
  3238. lambda : b"",
  3239. lambda : b"", # XXX(gps): io library does an extra EOF read
  3240. ])
  3241. fo = mock_sock._textiowrap_for_test(buffering=buffering)
  3242. self.assertEqual(fo.readline(size), "This is the first line\n")
  3243. self.assertEqual(fo.readline(size), "And the second line is here\n")
  3244. def _test_read(self, size=-1, buffering=-1):
  3245. mock_sock = self.MockSocket(recv_funcs=[
  3246. lambda : b"This is the first line\nAnd the sec",
  3247. self._raise_eintr,
  3248. lambda : b"ond line is here\n",
  3249. lambda : b"",
  3250. lambda : b"", # XXX(gps): io library does an extra EOF read
  3251. ])
  3252. expecting = (b"This is the first line\n"
  3253. b"And the second line is here\n")
  3254. fo = mock_sock._textiowrap_for_test(buffering=buffering)
  3255. if buffering == 0:
  3256. data = b''
  3257. else:
  3258. data = ''
  3259. expecting = expecting.decode('utf-8')
  3260. while len(data) != len(expecting):
  3261. part = fo.read(size)
  3262. if not part:
  3263. break
  3264. data += part
  3265. self.assertEqual(data, expecting)
  3266. def test_default(self):
  3267. self._test_readline()
  3268. self._test_readline(size=100)
  3269. self._test_read()
  3270. self._test_read(size=100)
  3271. def test_with_1k_buffer(self):
  3272. self._test_readline(buffering=1024)
  3273. self._test_readline(size=100, buffering=1024)
  3274. self._test_read(buffering=1024)
  3275. self._test_read(size=100, buffering=1024)
  3276. def _test_readline_no_buffer(self, size=-1):
  3277. mock_sock = self.MockSocket(recv_funcs=[
  3278. lambda : b"a",
  3279. lambda : b"\n",
  3280. lambda : b"B",
  3281. self._raise_eintr,
  3282. lambda : b"b",
  3283. lambda : b"",
  3284. ])
  3285. fo = mock_sock._textiowrap_for_test(buffering=0)
  3286. self.assertEqual(fo.readline(size), b"a\n")
  3287. self.assertEqual(fo.readline(size), b"Bb")
  3288. def test_no_buffer(self):
  3289. self._test_readline_no_buffer()
  3290. self._test_readline_no_buffer(size=4)
  3291. self._test_read(buffering=0)
  3292. self._test_read(size=100, buffering=0)
  3293. class UnbufferedFileObjectClassTestCase(FileObjectClassTestCase):
  3294. """Repeat the tests from FileObjectClassTestCase with bufsize==0.
  3295. In this case (and in this case only), it should be possible to
  3296. create a file object, read a line from it, create another file
  3297. object, read another line from it, without loss of data in the
  3298. first file object's buffer. Note that http.client relies on this
  3299. when reading multiple requests from the same socket."""
  3300. bufsize = 0 # Use unbuffered mode
  3301. def testUnbufferedReadline(self):
  3302. # Read a line, create a new file object, read another line with it
  3303. line = self.read_file.readline() # first line
  3304. self.assertEqual(line, b"A. " + self.write_msg) # first line
  3305. self.read_file = self.cli_conn.makefile('rb', 0)
  3306. line = self.read_file.readline() # second line
  3307. self.assertEqual(line, b"B. " + self.write_msg) # second line
  3308. def _testUnbufferedReadline(self):
  3309. self.write_file.write(b"A. " + self.write_msg)
  3310. self.write_file.write(b"B. " + self.write_msg)
  3311. self.write_file.flush()
  3312. def testMakefileClose(self):
  3313. # The file returned by makefile should keep the socket open...
  3314. self.cli_conn.close()
  3315. msg = self.cli_conn.recv(1024)
  3316. self.assertEqual(msg, self.read_msg)
  3317. # ...until the file is itself closed
  3318. self.read_file.close()
  3319. self.assertRaises(OSError, self.cli_conn.recv, 1024)
  3320. def _testMakefileClose(self):
  3321. self.write_file.write(self.write_msg)
  3322. self.write_file.flush()
  3323. def testMakefileCloseSocketDestroy(self):
  3324. refcount_before = sys.getrefcount(self.cli_conn)
  3325. self.read_file.close()
  3326. refcount_after = sys.getrefcount(self.cli_conn)
  3327. self.assertEqual(refcount_before - 1, refcount_after)
  3328. def _testMakefileCloseSocketDestroy(self):
  3329. pass
  3330. # Non-blocking ops
  3331. # NOTE: to set `read_file` as non-blocking, we must call
  3332. # `cli_conn.setblocking` and vice-versa (see setUp / clientSetUp).
  3333. def testSmallReadNonBlocking(self):
  3334. self.cli_conn.setblocking(False)
  3335. self.assertEqual(self.read_file.readinto(bytearray(10)), None)
  3336. self.assertEqual(self.read_file.read(len(self.read_msg) - 3), None)
  3337. self.evt1.set()
  3338. self.evt2.wait(1.0)
  3339. first_seg = self.read_file.read(len(self.read_msg) - 3)
  3340. if first_seg is None:
  3341. # Data not arrived (can happen under Windows), wait a bit
  3342. time.sleep(0.5)
  3343. first_seg = self.read_file.read(len(self.read_msg) - 3)
  3344. buf = bytearray(10)
  3345. n = self.read_file.readinto(buf)
  3346. self.assertEqual(n, 3)
  3347. msg = first_seg + buf[:n]
  3348. self.assertEqual(msg, self.read_msg)
  3349. self.assertEqual(self.read_file.readinto(bytearray(16)), None)
  3350. self.assertEqual(self.read_file.read(1), None)
  3351. def _testSmallReadNonBlocking(self):
  3352. self.evt1.wait(1.0)
  3353. self.write_file.write(self.write_msg)
  3354. self.write_file.flush()
  3355. self.evt2.set()
  3356. # Avoid cloding the socket before the server test has finished,
  3357. # otherwise system recv() will return 0 instead of EWOULDBLOCK.
  3358. self.serv_finished.wait(5.0)
  3359. def testWriteNonBlocking(self):
  3360. self.cli_finished.wait(5.0)
  3361. # The client thread can't skip directly - the SkipTest exception
  3362. # would appear as a failure.
  3363. if self.serv_skipped:
  3364. self.skipTest(self.serv_skipped)
  3365. def _testWriteNonBlocking(self):
  3366. self.serv_skipped = None
  3367. self.serv_conn.setblocking(False)
  3368. # Try to saturate the socket buffer pipe with repeated large writes.
  3369. BIG = b"x" * (1024 ** 2)
  3370. LIMIT = 10
  3371. # The first write() succeeds since a chunk of data can be buffered
  3372. n = self.write_file.write(BIG)
  3373. self.assertGreater(n, 0)
  3374. for i in range(LIMIT):
  3375. n = self.write_file.write(BIG)
  3376. if n is None:
  3377. # Succeeded
  3378. break
  3379. self.assertGreater(n, 0)
  3380. else:
  3381. # Let us know that this test didn't manage to establish
  3382. # the expected conditions. This is not a failure in itself but,
  3383. # if it happens repeatedly, the test should be fixed.
  3384. self.serv_skipped = "failed to saturate the socket buffer"
  3385. class LineBufferedFileObjectClassTestCase(FileObjectClassTestCase):
  3386. bufsize = 1 # Default-buffered for reading; line-buffered for writing
  3387. class SmallBufferedFileObjectClassTestCase(FileObjectClassTestCase):
  3388. bufsize = 2 # Exercise the buffering code
  3389. class UnicodeReadFileObjectClassTestCase(FileObjectClassTestCase):
  3390. """Tests for socket.makefile() in text mode (rather than binary)"""
  3391. read_mode = 'r'
  3392. read_msg = MSG.decode('utf-8')
  3393. write_mode = 'wb'
  3394. write_msg = MSG
  3395. newline = ''
  3396. class UnicodeWriteFileObjectClassTestCase(FileObjectClassTestCase):
  3397. """Tests for socket.makefile() in text mode (rather than binary)"""
  3398. read_mode = 'rb'
  3399. read_msg = MSG
  3400. write_mode = 'w'
  3401. write_msg = MSG.decode('utf-8')
  3402. newline = ''
  3403. class UnicodeReadWriteFileObjectClassTestCase(FileObjectClassTestCase):
  3404. """Tests for socket.makefile() in text mode (rather than binary)"""
  3405. read_mode = 'r'
  3406. read_msg = MSG.decode('utf-8')
  3407. write_mode = 'w'
  3408. write_msg = MSG.decode('utf-8')
  3409. newline = ''
  3410. class NetworkConnectionTest(object):
  3411. """Prove network connection."""
  3412. def clientSetUp(self):
  3413. # We're inherited below by BasicTCPTest2, which also inherits
  3414. # BasicTCPTest, which defines self.port referenced below.
  3415. self.cli = socket.create_connection((HOST, self.port))
  3416. self.serv_conn = self.cli
  3417. class BasicTCPTest2(NetworkConnectionTest, BasicTCPTest):
  3418. """Tests that NetworkConnection does not break existing TCP functionality.
  3419. """
  3420. class NetworkConnectionNoServer(unittest.TestCase):
  3421. class MockSocket(socket.socket):
  3422. def connect(self, *args):
  3423. raise socket.timeout('timed out')
  3424. @contextlib.contextmanager
  3425. def mocked_socket_module(self):
  3426. """Return a socket which times out on connect"""
  3427. old_socket = socket.socket
  3428. socket.socket = self.MockSocket
  3429. try:
  3430. yield
  3431. finally:
  3432. socket.socket = old_socket
  3433. def test_connect(self):
  3434. port = support.find_unused_port()
  3435. cli = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  3436. self.addCleanup(cli.close)
  3437. with self.assertRaises(OSError) as cm:
  3438. cli.connect((HOST, port))
  3439. self.assertEqual(cm.exception.errno, errno.ECONNREFUSED)
  3440. def test_create_connection(self):
  3441. # Issue #9792: errors raised by create_connection() should have
  3442. # a proper errno attribute.
  3443. port = support.find_unused_port()
  3444. with self.assertRaises(OSError) as cm:
  3445. socket.create_connection((HOST, port))
  3446. # Issue #16257: create_connection() calls getaddrinfo() against
  3447. # 'localhost'. This may result in an IPV6 addr being returned
  3448. # as well as an IPV4 one:
  3449. # >>> socket.getaddrinfo('localhost', port, 0, SOCK_STREAM)
  3450. # >>> [(2, 2, 0, '', ('127.0.0.1', 41230)),
  3451. # (26, 2, 0, '', ('::1', 41230, 0, 0))]
  3452. #
  3453. # create_connection() enumerates through all the addresses returned
  3454. # and if it doesn't successfully bind to any of them, it propagates
  3455. # the last exception it encountered.
  3456. #
  3457. # On Solaris, ENETUNREACH is returned in this circumstance instead
  3458. # of ECONNREFUSED. So, if that errno exists, add it to our list of
  3459. # expected errnos.
  3460. expected_errnos = [ errno.ECONNREFUSED, ]
  3461. if hasattr(errno, 'ENETUNREACH'):
  3462. expected_errnos.append(errno.ENETUNREACH)
  3463. self.assertIn(cm.exception.errno, expected_errnos)
  3464. def test_create_connection_timeout(self):
  3465. # Issue #9792: create_connection() should not recast timeout errors
  3466. # as generic socket errors.
  3467. with self.mocked_socket_module():
  3468. with self.assertRaises(socket.timeout):
  3469. socket.create_connection((HOST, 1234))
  3470. @unittest.skipUnless(thread, 'Threading required for this test.')
  3471. class NetworkConnectionAttributesTest(SocketTCPTest, ThreadableTest):
  3472. def __init__(self, methodName='runTest'):
  3473. SocketTCPTest.__init__(self, methodName=methodName)
  3474. ThreadableTest.__init__(self)
  3475. def clientSetUp(self):
  3476. self.source_port = support.find_unused_port()
  3477. def clientTearDown(self):
  3478. self.cli.close()
  3479. self.cli = None
  3480. ThreadableTest.clientTearDown(self)
  3481. def _justAccept(self):
  3482. conn, addr = self.serv.accept()
  3483. conn.close()
  3484. testFamily = _justAccept
  3485. def _testFamily(self):
  3486. self.cli = socket.create_connection((HOST, self.port), timeout=30)
  3487. self.addCleanup(self.cli.close)
  3488. self.assertEqual(self.cli.family, 2)
  3489. testSourceAddress = _justAccept
  3490. def _testSourceAddress(self):
  3491. self.cli = socket.create_connection((HOST, self.port), timeout=30,
  3492. source_address=('', self.source_port))
  3493. self.addCleanup(self.cli.close)
  3494. self.assertEqual(self.cli.getsockname()[1], self.source_port)
  3495. # The port number being used is sufficient to show that the bind()
  3496. # call happened.
  3497. testTimeoutDefault = _justAccept
  3498. def _testTimeoutDefault(self):
  3499. # passing no explicit timeout uses socket's global default
  3500. self.assertTrue(socket.getdefaulttimeout() is None)
  3501. socket.setdefaulttimeout(42)
  3502. try:
  3503. self.cli = socket.create_connection((HOST, self.port))
  3504. self.addCleanup(self.cli.close)
  3505. finally:
  3506. socket.setdefaulttimeout(None)
  3507. self.assertEqual(self.cli.gettimeout(), 42)
  3508. testTimeoutNone = _justAccept
  3509. def _testTimeoutNone(self):
  3510. # None timeout means the same as sock.settimeout(None)
  3511. self.assertTrue(socket.getdefaulttimeout() is None)
  3512. socket.setdefaulttimeout(30)
  3513. try:
  3514. self.cli = socket.create_connection((HOST, self.port), timeout=None)
  3515. self.addCleanup(self.cli.close)
  3516. finally:
  3517. socket.setdefaulttimeout(None)
  3518. self.assertEqual(self.cli.gettimeout(), None)
  3519. testTimeoutValueNamed = _justAccept
  3520. def _testTimeoutValueNamed(self):
  3521. self.cli = socket.create_connection((HOST, self.port), timeout=30)
  3522. self.assertEqual(self.cli.gettimeout(), 30)
  3523. testTimeoutValueNonamed = _justAccept
  3524. def _testTimeoutValueNonamed(self):
  3525. self.cli = socket.create_connection((HOST, self.port), 30)
  3526. self.addCleanup(self.cli.close)
  3527. self.assertEqual(self.cli.gettimeout(), 30)
  3528. @unittest.skipUnless(thread, 'Threading required for this test.')
  3529. class NetworkConnectionBehaviourTest(SocketTCPTest, ThreadableTest):
  3530. def __init__(self, methodName='runTest'):
  3531. SocketTCPTest.__init__(self, methodName=methodName)
  3532. ThreadableTest.__init__(self)
  3533. def clientSetUp(self):
  3534. pass
  3535. def clientTearDown(self):
  3536. self.cli.close()
  3537. self.cli = None
  3538. ThreadableTest.clientTearDown(self)
  3539. def testInsideTimeout(self):
  3540. conn, addr = self.serv.accept()
  3541. self.addCleanup(conn.close)
  3542. time.sleep(3)
  3543. conn.send(b"done!")
  3544. testOutsideTimeout = testInsideTimeout
  3545. def _testInsideTimeout(self):
  3546. self.cli = sock = socket.create_connection((HOST, self.port))
  3547. data = sock.recv(5)
  3548. self.assertEqual(data, b"done!")
  3549. def _testOutsideTimeout(self):
  3550. self.cli = sock = socket.create_connection((HOST, self.port), timeout=1)
  3551. self.assertRaises(socket.timeout, lambda: sock.recv(5))
  3552. class TCPTimeoutTest(SocketTCPTest):
  3553. def testTCPTimeout(self):
  3554. def raise_timeout(*args, **kwargs):
  3555. self.serv.settimeout(1.0)
  3556. self.serv.accept()
  3557. self.assertRaises(socket.timeout, raise_timeout,
  3558. "Error generating a timeout exception (TCP)")
  3559. def testTimeoutZero(self):
  3560. ok = False
  3561. try:
  3562. self.serv.settimeout(0.0)
  3563. foo = self.serv.accept()
  3564. except socket.timeout:
  3565. self.fail("caught timeout instead of error (TCP)")
  3566. except OSError:
  3567. ok = True
  3568. except:
  3569. self.fail("caught unexpected exception (TCP)")
  3570. if not ok:
  3571. self.fail("accept() returned success when we did not expect it")
  3572. def testInterruptedTimeout(self):
  3573. # XXX I don't know how to do this test on MSWindows or any other
  3574. # plaform that doesn't support signal.alarm() or os.kill(), though
  3575. # the bug should have existed on all platforms.
  3576. if not hasattr(signal, "alarm"):
  3577. return # can only test on *nix
  3578. self.serv.settimeout(5.0) # must be longer than alarm
  3579. class Alarm(Exception):
  3580. pass
  3581. def alarm_handler(signal, frame):
  3582. raise Alarm
  3583. old_alarm = signal.signal(signal.SIGALRM, alarm_handler)
  3584. try:
  3585. signal.alarm(2) # POSIX allows alarm to be up to 1 second early
  3586. try:
  3587. foo = self.serv.accept()
  3588. except socket.timeout:
  3589. self.fail("caught timeout instead of Alarm")
  3590. except Alarm:
  3591. pass
  3592. except:
  3593. self.fail("caught other exception instead of Alarm:"
  3594. " %s(%s):\n%s" %
  3595. (sys.exc_info()[:2] + (traceback.format_exc(),)))
  3596. else:
  3597. self.fail("nothing caught")
  3598. finally:
  3599. signal.alarm(0) # shut off alarm
  3600. except Alarm:
  3601. self.fail("got Alarm in wrong place")
  3602. finally:
  3603. # no alarm can be pending. Safe to restore old handler.
  3604. signal.signal(signal.SIGALRM, old_alarm)
  3605. class UDPTimeoutTest(SocketUDPTest):
  3606. def testUDPTimeout(self):
  3607. def raise_timeout(*args, **kwargs):
  3608. self.serv.settimeout(1.0)
  3609. self.serv.recv(1024)
  3610. self.assertRaises(socket.timeout, raise_timeout,
  3611. "Error generating a timeout exception (UDP)")
  3612. def testTimeoutZero(self):
  3613. ok = False
  3614. try:
  3615. self.serv.settimeout(0.0)
  3616. foo = self.serv.recv(1024)
  3617. except socket.timeout:
  3618. self.fail("caught timeout instead of error (UDP)")
  3619. except OSError:
  3620. ok = True
  3621. except:
  3622. self.fail("caught unexpected exception (UDP)")
  3623. if not ok:
  3624. self.fail("recv() returned success when we did not expect it")
  3625. class TestExceptions(unittest.TestCase):
  3626. def testExceptionTree(self):
  3627. self.assertTrue(issubclass(OSError, Exception))
  3628. self.assertTrue(issubclass(socket.herror, OSError))
  3629. self.assertTrue(issubclass(socket.gaierror, OSError))
  3630. self.assertTrue(issubclass(socket.timeout, OSError))
  3631. class TestLinuxAbstractNamespace(unittest.TestCase):
  3632. UNIX_PATH_MAX = 108
  3633. def testLinuxAbstractNamespace(self):
  3634. address = b"\x00python-test-hello\x00\xff"
  3635. with socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) as s1:
  3636. s1.bind(address)
  3637. s1.listen(1)
  3638. with socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) as s2:
  3639. s2.connect(s1.getsockname())
  3640. with s1.accept()[0] as s3:
  3641. self.assertEqual(s1.getsockname(), address)
  3642. self.assertEqual(s2.getpeername(), address)
  3643. def testMaxName(self):
  3644. address = b"\x00" + b"h" * (self.UNIX_PATH_MAX - 1)
  3645. with socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) as s:
  3646. s.bind(address)
  3647. self.assertEqual(s.getsockname(), address)
  3648. def testNameOverflow(self):
  3649. address = "\x00" + "h" * self.UNIX_PATH_MAX
  3650. with socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) as s:
  3651. self.assertRaises(OSError, s.bind, address)
  3652. def testStrName(self):
  3653. # Check that an abstract name can be passed as a string.
  3654. s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
  3655. try:
  3656. s.bind("\x00python\x00test\x00")
  3657. self.assertEqual(s.getsockname(), b"\x00python\x00test\x00")
  3658. finally:
  3659. s.close()
  3660. class TestUnixDomain(unittest.TestCase):
  3661. def setUp(self):
  3662. self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
  3663. def tearDown(self):
  3664. self.sock.close()
  3665. def encoded(self, path):
  3666. # Return the given path encoded in the file system encoding,
  3667. # or skip the test if this is not possible.
  3668. try:
  3669. return os.fsencode(path)
  3670. except UnicodeEncodeError:
  3671. self.skipTest(
  3672. "Pathname {0!a} cannot be represented in file "
  3673. "system encoding {1!r}".format(
  3674. path, sys.getfilesystemencoding()))
  3675. def bind(self, sock, path):
  3676. # Bind the socket
  3677. try:
  3678. sock.bind(path)
  3679. except OSError as e:
  3680. if str(e) == "AF_UNIX path too long":
  3681. self.skipTest(
  3682. "Pathname {0!a} is too long to serve as a AF_UNIX path"
  3683. .format(path))
  3684. else:
  3685. raise
  3686. def testStrAddr(self):
  3687. # Test binding to and retrieving a normal string pathname.
  3688. path = os.path.abspath(support.TESTFN)
  3689. self.bind(self.sock, path)
  3690. self.addCleanup(support.unlink, path)
  3691. self.assertEqual(self.sock.getsockname(), path)
  3692. def testBytesAddr(self):
  3693. # Test binding to a bytes pathname.
  3694. path = os.path.abspath(support.TESTFN)
  3695. self.bind(self.sock, self.encoded(path))
  3696. self.addCleanup(support.unlink, path)
  3697. self.assertEqual(self.sock.getsockname(), path)
  3698. def testSurrogateescapeBind(self):
  3699. # Test binding to a valid non-ASCII pathname, with the
  3700. # non-ASCII bytes supplied using surrogateescape encoding.
  3701. path = os.path.abspath(support.TESTFN_UNICODE)
  3702. b = self.encoded(path)
  3703. self.bind(self.sock, b.decode("ascii", "surrogateescape"))
  3704. self.addCleanup(support.unlink, path)
  3705. self.assertEqual(self.sock.getsockname(), path)
  3706. def testUnencodableAddr(self):
  3707. # Test binding to a pathname that cannot be encoded in the
  3708. # file system encoding.
  3709. if support.TESTFN_UNENCODABLE is None:
  3710. self.skipTest("No unencodable filename available")
  3711. path = os.path.abspath(support.TESTFN_UNENCODABLE)
  3712. self.bind(self.sock, path)
  3713. self.addCleanup(support.unlink, path)
  3714. self.assertEqual(self.sock.getsockname(), path)
  3715. @unittest.skipUnless(thread, 'Threading required for this test.')
  3716. class BufferIOTest(SocketConnectedTest):
  3717. """
  3718. Test the buffer versions of socket.recv() and socket.send().
  3719. """
  3720. def __init__(self, methodName='runTest'):
  3721. SocketConnectedTest.__init__(self, methodName=methodName)
  3722. def testRecvIntoArray(self):
  3723. buf = bytearray(1024)
  3724. nbytes = self.cli_conn.recv_into(buf)
  3725. self.assertEqual(nbytes, len(MSG))
  3726. msg = buf[:len(MSG)]
  3727. self.assertEqual(msg, MSG)
  3728. def _testRecvIntoArray(self):
  3729. buf = bytes(MSG)
  3730. self.serv_conn.send(buf)
  3731. def testRecvIntoBytearray(self):
  3732. buf = bytearray(1024)
  3733. nbytes = self.cli_conn.recv_into(buf)
  3734. self.assertEqual(nbytes, len(MSG))
  3735. msg = buf[:len(MSG)]
  3736. self.assertEqual(msg, MSG)
  3737. _testRecvIntoBytearray = _testRecvIntoArray
  3738. def testRecvIntoMemoryview(self):
  3739. buf = bytearray(1024)
  3740. nbytes = self.cli_conn.recv_into(memoryview(buf))
  3741. self.assertEqual(nbytes, len(MSG))
  3742. msg = buf[:len(MSG)]
  3743. self.assertEqual(msg, MSG)
  3744. _testRecvIntoMemoryview = _testRecvIntoArray
  3745. def testRecvFromIntoArray(self):
  3746. buf = bytearray(1024)
  3747. nbytes, addr = self.cli_conn.recvfrom_into(buf)
  3748. self.assertEqual(nbytes, len(MSG))
  3749. msg = buf[:len(MSG)]
  3750. self.assertEqual(msg, MSG)
  3751. def _testRecvFromIntoArray(self):
  3752. buf = bytes(MSG)
  3753. self.serv_conn.send(buf)
  3754. def testRecvFromIntoBytearray(self):
  3755. buf = bytearray(1024)
  3756. nbytes, addr = self.cli_conn.recvfrom_into(buf)
  3757. self.assertEqual(nbytes, len(MSG))
  3758. msg = buf[:len(MSG)]
  3759. self.assertEqual(msg, MSG)
  3760. _testRecvFromIntoBytearray = _testRecvFromIntoArray
  3761. def testRecvFromIntoMemoryview(self):
  3762. buf = bytearray(1024)
  3763. nbytes, addr = self.cli_conn.recvfrom_into(memoryview(buf))
  3764. self.assertEqual(nbytes, len(MSG))
  3765. msg = buf[:len(MSG)]
  3766. self.assertEqual(msg, MSG)
  3767. _testRecvFromIntoMemoryview = _testRecvFromIntoArray
  3768. TIPC_STYPE = 2000
  3769. TIPC_LOWER = 200
  3770. TIPC_UPPER = 210
  3771. def isTipcAvailable():
  3772. """Check if the TIPC module is loaded
  3773. The TIPC module is not loaded automatically on Ubuntu and probably
  3774. other Linux distros.
  3775. """
  3776. if not hasattr(socket, "AF_TIPC"):
  3777. return False
  3778. if not os.path.isfile("/proc/modules"):
  3779. return False
  3780. with open("/proc/modules") as f:
  3781. for line in f:
  3782. if line.startswith("tipc "):
  3783. return True
  3784. if support.verbose:
  3785. print("TIPC module is not loaded, please 'sudo modprobe tipc'")
  3786. return False
  3787. class TIPCTest(unittest.TestCase):
  3788. def testRDM(self):
  3789. srv = socket.socket(socket.AF_TIPC, socket.SOCK_RDM)
  3790. cli = socket.socket(socket.AF_TIPC, socket.SOCK_RDM)
  3791. self.addCleanup(srv.close)
  3792. self.addCleanup(cli.close)
  3793. srv.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
  3794. srvaddr = (socket.TIPC_ADDR_NAMESEQ, TIPC_STYPE,
  3795. TIPC_LOWER, TIPC_UPPER)
  3796. srv.bind(srvaddr)
  3797. sendaddr = (socket.TIPC_ADDR_NAME, TIPC_STYPE,
  3798. TIPC_LOWER + int((TIPC_UPPER - TIPC_LOWER) / 2), 0)
  3799. cli.sendto(MSG, sendaddr)
  3800. msg, recvaddr = srv.recvfrom(1024)
  3801. self.assertEqual(cli.getsockname(), recvaddr)
  3802. self.assertEqual(msg, MSG)
  3803. class TIPCThreadableTest(unittest.TestCase, ThreadableTest):
  3804. def __init__(self, methodName = 'runTest'):
  3805. unittest.TestCase.__init__(self, methodName = methodName)
  3806. ThreadableTest.__init__(self)
  3807. def setUp(self):
  3808. self.srv = socket.socket(socket.AF_TIPC, socket.SOCK_STREAM)
  3809. self.addCleanup(self.srv.close)
  3810. self.srv.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
  3811. srvaddr = (socket.TIPC_ADDR_NAMESEQ, TIPC_STYPE,
  3812. TIPC_LOWER, TIPC_UPPER)
  3813. self.srv.bind(srvaddr)
  3814. self.srv.listen(5)
  3815. self.serverExplicitReady()
  3816. self.conn, self.connaddr = self.srv.accept()
  3817. self.addCleanup(self.conn.close)
  3818. def clientSetUp(self):
  3819. # The is a hittable race between serverExplicitReady() and the
  3820. # accept() call; sleep a little while to avoid it, otherwise
  3821. # we could get an exception
  3822. time.sleep(0.1)
  3823. self.cli = socket.socket(socket.AF_TIPC, socket.SOCK_STREAM)
  3824. self.addCleanup(self.cli.close)
  3825. addr = (socket.TIPC_ADDR_NAME, TIPC_STYPE,
  3826. TIPC_LOWER + int((TIPC_UPPER - TIPC_LOWER) / 2), 0)
  3827. self.cli.connect(addr)
  3828. self.cliaddr = self.cli.getsockname()
  3829. def testStream(self):
  3830. msg = self.conn.recv(1024)
  3831. self.assertEqual(msg, MSG)
  3832. self.assertEqual(self.cliaddr, self.connaddr)
  3833. def _testStream(self):
  3834. self.cli.send(MSG)
  3835. self.cli.close()
  3836. @unittest.skipUnless(thread, 'Threading required for this test.')
  3837. class ContextManagersTest(ThreadedTCPSocketTest):
  3838. def _testSocketClass(self):
  3839. # base test
  3840. with socket.socket() as sock:
  3841. self.assertFalse(sock._closed)
  3842. self.assertTrue(sock._closed)
  3843. # close inside with block
  3844. with socket.socket() as sock:
  3845. sock.close()
  3846. self.assertTrue(sock._closed)
  3847. # exception inside with block
  3848. with socket.socket() as sock:
  3849. self.assertRaises(OSError, sock.sendall, b'foo')
  3850. self.assertTrue(sock._closed)
  3851. def testCreateConnectionBase(self):
  3852. conn, addr = self.serv.accept()
  3853. self.addCleanup(conn.close)
  3854. data = conn.recv(1024)
  3855. conn.sendall(data)
  3856. def _testCreateConnectionBase(self):
  3857. address = self.serv.getsockname()
  3858. with socket.create_connection(address) as sock:
  3859. self.assertFalse(sock._closed)
  3860. sock.sendall(b'foo')
  3861. self.assertEqual(sock.recv(1024), b'foo')
  3862. self.assertTrue(sock._closed)
  3863. def testCreateConnectionClose(self):
  3864. conn, addr = self.serv.accept()
  3865. self.addCleanup(conn.close)
  3866. data = conn.recv(1024)
  3867. conn.sendall(data)
  3868. def _testCreateConnectionClose(self):
  3869. address = self.serv.getsockname()
  3870. with socket.create_connection(address) as sock:
  3871. sock.close()
  3872. self.assertTrue(sock._closed)
  3873. self.assertRaises(OSError, sock.sendall, b'foo')
  3874. @unittest.skipUnless(hasattr(os, 'get_cloexec'), "need os.get_cloexec()")
  3875. class CloexecTest(unittest.TestCase):
  3876. @unittest.skipUnless(hasattr(socket, "SOCK_CLOEXEC"),
  3877. "SOCK_CLOEXEC not defined")
  3878. @support.requires_linux_version(2, 6, 28)
  3879. def test_SOCK_CLOEXEC(self):
  3880. with socket.socket(socket.AF_INET,
  3881. socket.SOCK_STREAM | socket.SOCK_CLOEXEC) as s:
  3882. self.assertTrue(s.type & socket.SOCK_CLOEXEC)
  3883. self.assertTrue(os.get_cloexec(sock.fileno()))
  3884. def test_socket_cloexec(self):
  3885. for cloexec in (False, True):
  3886. sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM,
  3887. cloexec=cloexec)
  3888. with sock:
  3889. self.assertEqual(os.get_cloexec(sock.fileno()), cloexec)
  3890. @unittest.skipUnless(hasattr(socket, "socketpair"),
  3891. "need socket.socketpair()")
  3892. def test_socketpair_cloexec(self):
  3893. for cloexec in (False, True):
  3894. s1, s2 = socket.socketpair(cloexec=cloexec)
  3895. self.assertEqual(os.get_cloexec(s1.fileno()), cloexec)
  3896. self.assertEqual(os.get_cloexec(s2.fileno()), cloexec)
  3897. s1.close()
  3898. s2.close()
  3899. @unittest.skipUnless(hasattr(socket, "SOCK_NONBLOCK"),
  3900. "SOCK_NONBLOCK not defined")
  3901. class NonblockConstantTest(unittest.TestCase):
  3902. def checkNonblock(self, s, nonblock=True, timeout=0.0):
  3903. if nonblock:
  3904. self.assertTrue(s.type & socket.SOCK_NONBLOCK)
  3905. self.assertEqual(s.gettimeout(), timeout)
  3906. else:
  3907. self.assertFalse(s.type & socket.SOCK_NONBLOCK)
  3908. self.assertEqual(s.gettimeout(), None)
  3909. @support.requires_linux_version(2, 6, 28)
  3910. def test_SOCK_NONBLOCK(self):
  3911. # a lot of it seems silly and redundant, but I wanted to test that
  3912. # changing back and forth worked ok
  3913. with socket.socket(socket.AF_INET,
  3914. socket.SOCK_STREAM | socket.SOCK_NONBLOCK) as s:
  3915. self.checkNonblock(s)
  3916. s.setblocking(1)
  3917. self.checkNonblock(s, False)
  3918. s.setblocking(0)
  3919. self.checkNonblock(s)
  3920. s.settimeout(None)
  3921. self.checkNonblock(s, False)
  3922. s.settimeout(2.0)
  3923. self.checkNonblock(s, timeout=2.0)
  3924. s.setblocking(1)
  3925. self.checkNonblock(s, False)
  3926. # defaulttimeout
  3927. t = socket.getdefaulttimeout()
  3928. socket.setdefaulttimeout(0.0)
  3929. with socket.socket() as s:
  3930. self.checkNonblock(s)
  3931. socket.setdefaulttimeout(None)
  3932. with socket.socket() as s:
  3933. self.checkNonblock(s, False)
  3934. socket.setdefaulttimeout(2.0)
  3935. with socket.socket() as s:
  3936. self.checkNonblock(s, timeout=2.0)
  3937. socket.setdefaulttimeout(None)
  3938. with socket.socket() as s:
  3939. self.checkNonblock(s, False)
  3940. socket.setdefaulttimeout(t)
  3941. @unittest.skipUnless(os.name == "nt", "Windows specific")
  3942. @unittest.skipUnless(multiprocessing, "need multiprocessing")
  3943. class TestSocketSharing(SocketTCPTest):
  3944. # This must be classmethod and not staticmethod or multiprocessing
  3945. # won't be able to bootstrap it.
  3946. @classmethod
  3947. def remoteProcessServer(cls, q):
  3948. # Recreate socket from shared data
  3949. sdata = q.get()
  3950. message = q.get()
  3951. s = socket.fromshare(sdata)
  3952. s2, c = s.accept()
  3953. # Send the message
  3954. s2.sendall(message)
  3955. s2.close()
  3956. s.close()
  3957. def testShare(self):
  3958. # Transfer the listening server socket to another process
  3959. # and service it from there.
  3960. # Create process:
  3961. q = multiprocessing.Queue()
  3962. p = multiprocessing.Process(target=self.remoteProcessServer, args=(q,))
  3963. p.start()
  3964. # Get the shared socket data
  3965. data = self.serv.share(p.pid)
  3966. # Pass the shared socket to the other process
  3967. addr = self.serv.getsockname()
  3968. self.serv.close()
  3969. q.put(data)
  3970. # The data that the server will send us
  3971. message = b"slapmahfro"
  3972. q.put(message)
  3973. # Connect
  3974. s = socket.create_connection(addr)
  3975. # listen for the data
  3976. m = []
  3977. while True:
  3978. data = s.recv(100)
  3979. if not data:
  3980. break
  3981. m.append(data)
  3982. s.close()
  3983. received = b"".join(m)
  3984. self.assertEqual(received, message)
  3985. p.join()
  3986. def testShareLength(self):
  3987. data = self.serv.share(os.getpid())
  3988. self.assertRaises(ValueError, socket.fromshare, data[:-1])
  3989. self.assertRaises(ValueError, socket.fromshare, data+b"foo")
  3990. def compareSockets(self, org, other):
  3991. # socket sharing is expected to work only for blocking socket
  3992. # since the internal python timout value isn't transfered.
  3993. self.assertEqual(org.gettimeout(), None)
  3994. self.assertEqual(org.gettimeout(), other.gettimeout())
  3995. self.assertEqual(org.family, other.family)
  3996. self.assertEqual(org.type, other.type)
  3997. # If the user specified "0" for proto, then
  3998. # internally windows will have picked the correct value.
  3999. # Python introspection on the socket however will still return
  4000. # 0. For the shared socket, the python value is recreated
  4001. # from the actual value, so it may not compare correctly.
  4002. if org.proto != 0:
  4003. self.assertEqual(org.proto, other.proto)
  4004. def testShareLocal(self):
  4005. data = self.serv.share(os.getpid())
  4006. s = socket.fromshare(data)
  4007. try:
  4008. self.compareSockets(self.serv, s)
  4009. finally:
  4010. s.close()
  4011. def testTypes(self):
  4012. families = [socket.AF_INET, socket.AF_INET6]
  4013. types = [socket.SOCK_STREAM, socket.SOCK_DGRAM]
  4014. for f in families:
  4015. for t in types:
  4016. try:
  4017. source = socket.socket(f, t)
  4018. except OSError:
  4019. continue # This combination is not supported
  4020. try:
  4021. data = source.share(os.getpid())
  4022. shared = socket.fromshare(data)
  4023. try:
  4024. self.compareSockets(source, shared)
  4025. finally:
  4026. shared.close()
  4027. finally:
  4028. source.close()
  4029. def test_main():
  4030. tests = [GeneralModuleTests, BasicTCPTest, TCPCloserTest, TCPTimeoutTest,
  4031. TestExceptions, BufferIOTest, BasicTCPTest2, BasicUDPTest, UDPTimeoutTest ]
  4032. tests.extend([
  4033. NonBlockingTCPTests,
  4034. FileObjectClassTestCase,
  4035. FileObjectInterruptedTestCase,
  4036. UnbufferedFileObjectClassTestCase,
  4037. LineBufferedFileObjectClassTestCase,
  4038. SmallBufferedFileObjectClassTestCase,
  4039. UnicodeReadFileObjectClassTestCase,
  4040. UnicodeWriteFileObjectClassTestCase,
  4041. UnicodeReadWriteFileObjectClassTestCase,
  4042. NetworkConnectionNoServer,
  4043. NetworkConnectionAttributesTest,
  4044. NetworkConnectionBehaviourTest,
  4045. ContextManagersTest,
  4046. CloexecTest,
  4047. NonblockConstantTest
  4048. ])
  4049. if hasattr(socket, "socketpair"):
  4050. tests.append(BasicSocketPairTest)
  4051. if hasattr(socket, "AF_UNIX"):
  4052. tests.append(TestUnixDomain)
  4053. if sys.platform == 'linux':
  4054. tests.append(TestLinuxAbstractNamespace)
  4055. if isTipcAvailable():
  4056. tests.append(TIPCTest)
  4057. tests.append(TIPCThreadableTest)
  4058. tests.extend([BasicCANTest, CANTest])
  4059. tests.extend([BasicRDSTest, RDSTest])
  4060. tests.extend([
  4061. CmsgMacroTests,
  4062. SendmsgUDPTest,
  4063. RecvmsgUDPTest,
  4064. RecvmsgIntoUDPTest,
  4065. SendmsgUDP6Test,
  4066. RecvmsgUDP6Test,
  4067. RecvmsgRFC3542AncillaryUDP6Test,
  4068. RecvmsgIntoRFC3542AncillaryUDP6Test,
  4069. RecvmsgIntoUDP6Test,
  4070. SendmsgTCPTest,
  4071. RecvmsgTCPTest,
  4072. RecvmsgIntoTCPTest,
  4073. SendmsgSCTPStreamTest,
  4074. RecvmsgSCTPStreamTest,
  4075. RecvmsgIntoSCTPStreamTest,
  4076. SendmsgUnixStreamTest,
  4077. RecvmsgUnixStreamTest,
  4078. RecvmsgIntoUnixStreamTest,
  4079. RecvmsgSCMRightsStreamTest,
  4080. RecvmsgIntoSCMRightsStreamTest,
  4081. # These are slow when setitimer() is not available
  4082. InterruptedRecvTimeoutTest,
  4083. InterruptedSendTimeoutTest,
  4084. TestSocketSharing,
  4085. ])
  4086. thread_info = support.threading_setup()
  4087. support.run_unittest(*tests)
  4088. support.threading_cleanup(*thread_info)
  4089. if __name__ == "__main__":
  4090. test_main()