/Lib/test/test_socket.py

http://unladen-swallow.googlecode.com/ · Python · 1245 lines · 950 code · 178 blank · 117 comment · 89 complexity · d251cb5f4a40c370d1f7223e6a1f21e9 MD5 · raw file

  1. #!/usr/bin/env python
  2. import unittest
  3. from test import test_support
  4. import errno
  5. import socket
  6. import select
  7. import thread, threading
  8. import time
  9. import traceback
  10. import Queue
  11. import sys
  12. import os
  13. import array
  14. from weakref import proxy
  15. import signal
  16. HOST = test_support.HOST
  17. MSG = 'Michael Gilfix was here\n'
  18. class SocketTCPTest(unittest.TestCase):
  19. def setUp(self):
  20. self.serv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  21. self.port = test_support.bind_port(self.serv)
  22. self.serv.listen(1)
  23. def tearDown(self):
  24. self.serv.close()
  25. self.serv = None
  26. class SocketUDPTest(unittest.TestCase):
  27. def setUp(self):
  28. self.serv = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
  29. self.port = test_support.bind_port(self.serv)
  30. def tearDown(self):
  31. self.serv.close()
  32. self.serv = None
  33. class ThreadableTest:
  34. """Threadable Test class
  35. The ThreadableTest class makes it easy to create a threaded
  36. client/server pair from an existing unit test. To create a
  37. new threaded class from an existing unit test, use multiple
  38. inheritance:
  39. class NewClass (OldClass, ThreadableTest):
  40. pass
  41. This class defines two new fixture functions with obvious
  42. purposes for overriding:
  43. clientSetUp ()
  44. clientTearDown ()
  45. Any new test functions within the class must then define
  46. tests in pairs, where the test name is preceeded with a
  47. '_' to indicate the client portion of the test. Ex:
  48. def testFoo(self):
  49. # Server portion
  50. def _testFoo(self):
  51. # Client portion
  52. Any exceptions raised by the clients during their tests
  53. are caught and transferred to the main thread to alert
  54. the testing framework.
  55. Note, the server setup function cannot call any blocking
  56. functions that rely on the client thread during setup,
  57. unless serverExplicitReady() is called just before
  58. the blocking call (such as in setting up a client/server
  59. connection and performing the accept() in setUp().
  60. """
  61. def __init__(self):
  62. # Swap the true setup function
  63. self.__setUp = self.setUp
  64. self.__tearDown = self.tearDown
  65. self.setUp = self._setUp
  66. self.tearDown = self._tearDown
  67. def serverExplicitReady(self):
  68. """This method allows the server to explicitly indicate that
  69. it wants the client thread to proceed. This is useful if the
  70. server is about to execute a blocking routine that is
  71. dependent upon the client thread during its setup routine."""
  72. self.server_ready.set()
  73. def _setUp(self):
  74. self.server_ready = threading.Event()
  75. self.client_ready = threading.Event()
  76. self.done = threading.Event()
  77. self.queue = Queue.Queue(1)
  78. # Do some munging to start the client test.
  79. methodname = self.id()
  80. i = methodname.rfind('.')
  81. methodname = methodname[i+1:]
  82. test_method = getattr(self, '_' + methodname)
  83. self.client_thread = thread.start_new_thread(
  84. self.clientRun, (test_method,))
  85. self.__setUp()
  86. if not self.server_ready.is_set():
  87. self.server_ready.set()
  88. self.client_ready.wait()
  89. def _tearDown(self):
  90. self.__tearDown()
  91. self.done.wait()
  92. if not self.queue.empty():
  93. msg = self.queue.get()
  94. self.fail(msg)
  95. def clientRun(self, test_func):
  96. self.server_ready.wait()
  97. self.client_ready.set()
  98. self.clientSetUp()
  99. if not callable(test_func):
  100. raise TypeError, "test_func must be a callable function"
  101. try:
  102. test_func()
  103. except Exception, strerror:
  104. self.queue.put(strerror)
  105. self.clientTearDown()
  106. def clientSetUp(self):
  107. raise NotImplementedError, "clientSetUp must be implemented."
  108. def clientTearDown(self):
  109. self.done.set()
  110. thread.exit()
  111. class ThreadedTCPSocketTest(SocketTCPTest, ThreadableTest):
  112. def __init__(self, methodName='runTest'):
  113. SocketTCPTest.__init__(self, methodName=methodName)
  114. ThreadableTest.__init__(self)
  115. def clientSetUp(self):
  116. self.cli = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  117. def clientTearDown(self):
  118. self.cli.close()
  119. self.cli = None
  120. ThreadableTest.clientTearDown(self)
  121. class ThreadedUDPSocketTest(SocketUDPTest, ThreadableTest):
  122. def __init__(self, methodName='runTest'):
  123. SocketUDPTest.__init__(self, methodName=methodName)
  124. ThreadableTest.__init__(self)
  125. def clientSetUp(self):
  126. self.cli = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
  127. class SocketConnectedTest(ThreadedTCPSocketTest):
  128. def __init__(self, methodName='runTest'):
  129. ThreadedTCPSocketTest.__init__(self, methodName=methodName)
  130. def setUp(self):
  131. ThreadedTCPSocketTest.setUp(self)
  132. # Indicate explicitly we're ready for the client thread to
  133. # proceed and then perform the blocking call to accept
  134. self.serverExplicitReady()
  135. conn, addr = self.serv.accept()
  136. self.cli_conn = conn
  137. def tearDown(self):
  138. self.cli_conn.close()
  139. self.cli_conn = None
  140. ThreadedTCPSocketTest.tearDown(self)
  141. def clientSetUp(self):
  142. ThreadedTCPSocketTest.clientSetUp(self)
  143. self.cli.connect((HOST, self.port))
  144. self.serv_conn = self.cli
  145. def clientTearDown(self):
  146. self.serv_conn.close()
  147. self.serv_conn = None
  148. ThreadedTCPSocketTest.clientTearDown(self)
  149. class SocketPairTest(unittest.TestCase, ThreadableTest):
  150. def __init__(self, methodName='runTest'):
  151. unittest.TestCase.__init__(self, methodName=methodName)
  152. ThreadableTest.__init__(self)
  153. def setUp(self):
  154. self.serv, self.cli = socket.socketpair()
  155. def tearDown(self):
  156. self.serv.close()
  157. self.serv = None
  158. def clientSetUp(self):
  159. pass
  160. def clientTearDown(self):
  161. self.cli.close()
  162. self.cli = None
  163. ThreadableTest.clientTearDown(self)
  164. #######################################################################
  165. ## Begin Tests
  166. class GeneralModuleTests(unittest.TestCase):
  167. def test_weakref(self):
  168. s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  169. p = proxy(s)
  170. self.assertEqual(p.fileno(), s.fileno())
  171. s.close()
  172. s = None
  173. try:
  174. p.fileno()
  175. except ReferenceError:
  176. pass
  177. else:
  178. self.fail('Socket proxy still exists')
  179. def testSocketError(self):
  180. # Testing socket module exceptions
  181. def raise_error(*args, **kwargs):
  182. raise socket.error
  183. def raise_herror(*args, **kwargs):
  184. raise socket.herror
  185. def raise_gaierror(*args, **kwargs):
  186. raise socket.gaierror
  187. self.failUnlessRaises(socket.error, raise_error,
  188. "Error raising socket exception.")
  189. self.failUnlessRaises(socket.error, raise_herror,
  190. "Error raising socket exception.")
  191. self.failUnlessRaises(socket.error, raise_gaierror,
  192. "Error raising socket exception.")
  193. def testCrucialConstants(self):
  194. # Testing for mission critical constants
  195. socket.AF_INET
  196. socket.SOCK_STREAM
  197. socket.SOCK_DGRAM
  198. socket.SOCK_RAW
  199. socket.SOCK_RDM
  200. socket.SOCK_SEQPACKET
  201. socket.SOL_SOCKET
  202. socket.SO_REUSEADDR
  203. def testHostnameRes(self):
  204. # Testing hostname resolution mechanisms
  205. hostname = socket.gethostname()
  206. try:
  207. ip = socket.gethostbyname(hostname)
  208. except socket.error:
  209. # Probably name lookup wasn't set up right; skip this test
  210. return
  211. self.assert_(ip.find('.') >= 0, "Error resolving host to ip.")
  212. try:
  213. hname, aliases, ipaddrs = socket.gethostbyaddr(ip)
  214. except socket.error:
  215. # Probably a similar problem as above; skip this test
  216. return
  217. all_host_names = [hostname, hname] + aliases
  218. fqhn = socket.getfqdn(ip)
  219. if not fqhn in all_host_names:
  220. self.fail("Error testing host resolution mechanisms. (fqdn: %s, all: %s)" % (fqhn, repr(all_host_names)))
  221. def testRefCountGetNameInfo(self):
  222. # Testing reference count for getnameinfo
  223. if hasattr(sys, "getrefcount"):
  224. try:
  225. # On some versions, this loses a reference
  226. orig = sys.getrefcount(__name__)
  227. socket.getnameinfo(__name__,0)
  228. except TypeError:
  229. if sys.getrefcount(__name__) <> orig:
  230. self.fail("socket.getnameinfo loses a reference")
  231. def testInterpreterCrash(self):
  232. # Making sure getnameinfo doesn't crash the interpreter
  233. try:
  234. # On some versions, this crashes the interpreter.
  235. socket.getnameinfo(('x', 0, 0, 0), 0)
  236. except socket.error:
  237. pass
  238. def testNtoH(self):
  239. # This just checks that htons etc. are their own inverse,
  240. # when looking at the lower 16 or 32 bits.
  241. sizes = {socket.htonl: 32, socket.ntohl: 32,
  242. socket.htons: 16, socket.ntohs: 16}
  243. for func, size in sizes.items():
  244. mask = (1L<<size) - 1
  245. for i in (0, 1, 0xffff, ~0xffff, 2, 0x01234567, 0x76543210):
  246. self.assertEqual(i & mask, func(func(i&mask)) & mask)
  247. swapped = func(mask)
  248. self.assertEqual(swapped & mask, mask)
  249. self.assertRaises(OverflowError, func, 1L<<34)
  250. def testNtoHErrors(self):
  251. good_values = [ 1, 2, 3, 1L, 2L, 3L ]
  252. bad_values = [ -1, -2, -3, -1L, -2L, -3L ]
  253. for k in good_values:
  254. socket.ntohl(k)
  255. socket.ntohs(k)
  256. socket.htonl(k)
  257. socket.htons(k)
  258. for k in bad_values:
  259. self.assertRaises(OverflowError, socket.ntohl, k)
  260. self.assertRaises(OverflowError, socket.ntohs, k)
  261. self.assertRaises(OverflowError, socket.htonl, k)
  262. self.assertRaises(OverflowError, socket.htons, k)
  263. def testGetServBy(self):
  264. eq = self.assertEqual
  265. # Find one service that exists, then check all the related interfaces.
  266. # I've ordered this by protocols that have both a tcp and udp
  267. # protocol, at least for modern Linuxes.
  268. if sys.platform in ('linux2', 'freebsd4', 'freebsd5', 'freebsd6',
  269. 'freebsd7', 'freebsd8', 'darwin'):
  270. # avoid the 'echo' service on this platform, as there is an
  271. # assumption breaking non-standard port/protocol entry
  272. services = ('daytime', 'qotd', 'domain')
  273. else:
  274. services = ('echo', 'daytime', 'domain')
  275. for service in services:
  276. try:
  277. port = socket.getservbyname(service, 'tcp')
  278. break
  279. except socket.error:
  280. pass
  281. else:
  282. raise socket.error
  283. # Try same call with optional protocol omitted
  284. port2 = socket.getservbyname(service)
  285. eq(port, port2)
  286. # Try udp, but don't barf it it doesn't exist
  287. try:
  288. udpport = socket.getservbyname(service, 'udp')
  289. except socket.error:
  290. udpport = None
  291. else:
  292. eq(udpport, port)
  293. # Now make sure the lookup by port returns the same service name
  294. eq(socket.getservbyport(port2), service)
  295. eq(socket.getservbyport(port, 'tcp'), service)
  296. if udpport is not None:
  297. eq(socket.getservbyport(udpport, 'udp'), service)
  298. def testDefaultTimeout(self):
  299. # Testing default timeout
  300. # The default timeout should initially be None
  301. self.assertEqual(socket.getdefaulttimeout(), None)
  302. s = socket.socket()
  303. self.assertEqual(s.gettimeout(), None)
  304. s.close()
  305. # Set the default timeout to 10, and see if it propagates
  306. socket.setdefaulttimeout(10)
  307. self.assertEqual(socket.getdefaulttimeout(), 10)
  308. s = socket.socket()
  309. self.assertEqual(s.gettimeout(), 10)
  310. s.close()
  311. # Reset the default timeout to None, and see if it propagates
  312. socket.setdefaulttimeout(None)
  313. self.assertEqual(socket.getdefaulttimeout(), None)
  314. s = socket.socket()
  315. self.assertEqual(s.gettimeout(), None)
  316. s.close()
  317. # Check that setting it to an invalid value raises ValueError
  318. self.assertRaises(ValueError, socket.setdefaulttimeout, -1)
  319. # Check that setting it to an invalid type raises TypeError
  320. self.assertRaises(TypeError, socket.setdefaulttimeout, "spam")
  321. def testIPv4toString(self):
  322. if not hasattr(socket, 'inet_pton'):
  323. return # No inet_pton() on this platform
  324. from socket import inet_aton as f, inet_pton, AF_INET
  325. g = lambda a: inet_pton(AF_INET, a)
  326. self.assertEquals('\x00\x00\x00\x00', f('0.0.0.0'))
  327. self.assertEquals('\xff\x00\xff\x00', f('255.0.255.0'))
  328. self.assertEquals('\xaa\xaa\xaa\xaa', f('170.170.170.170'))
  329. self.assertEquals('\x01\x02\x03\x04', f('1.2.3.4'))
  330. self.assertEquals('\xff\xff\xff\xff', f('255.255.255.255'))
  331. self.assertEquals('\x00\x00\x00\x00', g('0.0.0.0'))
  332. self.assertEquals('\xff\x00\xff\x00', g('255.0.255.0'))
  333. self.assertEquals('\xaa\xaa\xaa\xaa', g('170.170.170.170'))
  334. self.assertEquals('\xff\xff\xff\xff', g('255.255.255.255'))
  335. def testIPv6toString(self):
  336. if not hasattr(socket, 'inet_pton'):
  337. return # No inet_pton() on this platform
  338. try:
  339. from socket import inet_pton, AF_INET6, has_ipv6
  340. if not has_ipv6:
  341. return
  342. except ImportError:
  343. return
  344. f = lambda a: inet_pton(AF_INET6, a)
  345. self.assertEquals('\x00' * 16, f('::'))
  346. self.assertEquals('\x00' * 16, f('0::0'))
  347. self.assertEquals('\x00\x01' + '\x00' * 14, f('1::'))
  348. self.assertEquals(
  349. '\x45\xef\x76\xcb\x00\x1a\x56\xef\xaf\xeb\x0b\xac\x19\x24\xae\xae',
  350. f('45ef:76cb:1a:56ef:afeb:bac:1924:aeae')
  351. )
  352. def testStringToIPv4(self):
  353. if not hasattr(socket, 'inet_ntop'):
  354. return # No inet_ntop() on this platform
  355. from socket import inet_ntoa as f, inet_ntop, AF_INET
  356. g = lambda a: inet_ntop(AF_INET, a)
  357. self.assertEquals('1.0.1.0', f('\x01\x00\x01\x00'))
  358. self.assertEquals('170.85.170.85', f('\xaa\x55\xaa\x55'))
  359. self.assertEquals('255.255.255.255', f('\xff\xff\xff\xff'))
  360. self.assertEquals('1.2.3.4', f('\x01\x02\x03\x04'))
  361. self.assertEquals('1.0.1.0', g('\x01\x00\x01\x00'))
  362. self.assertEquals('170.85.170.85', g('\xaa\x55\xaa\x55'))
  363. self.assertEquals('255.255.255.255', g('\xff\xff\xff\xff'))
  364. def testStringToIPv6(self):
  365. if not hasattr(socket, 'inet_ntop'):
  366. return # No inet_ntop() on this platform
  367. try:
  368. from socket import inet_ntop, AF_INET6, has_ipv6
  369. if not has_ipv6:
  370. return
  371. except ImportError:
  372. return
  373. f = lambda a: inet_ntop(AF_INET6, a)
  374. self.assertEquals('::', f('\x00' * 16))
  375. self.assertEquals('::1', f('\x00' * 15 + '\x01'))
  376. self.assertEquals(
  377. 'aef:b01:506:1001:ffff:9997:55:170',
  378. f('\x0a\xef\x0b\x01\x05\x06\x10\x01\xff\xff\x99\x97\x00\x55\x01\x70')
  379. )
  380. # XXX The following don't test module-level functionality...
  381. def testSockName(self):
  382. # Testing getsockname(). Use a temporary socket to elicit an unused
  383. # ephemeral port that we can use later in the test.
  384. tempsock = socket.socket()
  385. tempsock.bind(("0.0.0.0", 0))
  386. (host, port) = tempsock.getsockname()
  387. tempsock.close()
  388. del tempsock
  389. sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  390. sock.bind(("0.0.0.0", port))
  391. name = sock.getsockname()
  392. # XXX(nnorwitz): http://tinyurl.com/os5jz seems to indicate
  393. # it reasonable to get the host's addr in addition to 0.0.0.0.
  394. # At least for eCos. This is required for the S/390 to pass.
  395. my_ip_addr = socket.gethostbyname(socket.gethostname())
  396. self.assert_(name[0] in ("0.0.0.0", my_ip_addr), '%s invalid' % name[0])
  397. self.assertEqual(name[1], port)
  398. def testGetSockOpt(self):
  399. # Testing getsockopt()
  400. # We know a socket should start without reuse==0
  401. sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  402. reuse = sock.getsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR)
  403. self.failIf(reuse != 0, "initial mode is reuse")
  404. def testSetSockOpt(self):
  405. # Testing setsockopt()
  406. sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  407. sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
  408. reuse = sock.getsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR)
  409. self.failIf(reuse == 0, "failed to set reuse mode")
  410. def testSendAfterClose(self):
  411. # testing send() after close() with timeout
  412. sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  413. sock.settimeout(1)
  414. sock.close()
  415. self.assertRaises(socket.error, sock.send, "spam")
  416. def testNewAttributes(self):
  417. # testing .family, .type and .protocol
  418. sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  419. self.assertEqual(sock.family, socket.AF_INET)
  420. self.assertEqual(sock.type, socket.SOCK_STREAM)
  421. self.assertEqual(sock.proto, 0)
  422. sock.close()
  423. def test_sock_ioctl(self):
  424. if os.name != "nt":
  425. return
  426. self.assert_(hasattr(socket.socket, 'ioctl'))
  427. self.assert_(hasattr(socket, 'SIO_RCVALL'))
  428. self.assert_(hasattr(socket, 'RCVALL_ON'))
  429. self.assert_(hasattr(socket, 'RCVALL_OFF'))
  430. class BasicTCPTest(SocketConnectedTest):
  431. def __init__(self, methodName='runTest'):
  432. SocketConnectedTest.__init__(self, methodName=methodName)
  433. def testRecv(self):
  434. # Testing large receive over TCP
  435. msg = self.cli_conn.recv(1024)
  436. self.assertEqual(msg, MSG)
  437. def _testRecv(self):
  438. self.serv_conn.send(MSG)
  439. def testOverFlowRecv(self):
  440. # Testing receive in chunks over TCP
  441. seg1 = self.cli_conn.recv(len(MSG) - 3)
  442. seg2 = self.cli_conn.recv(1024)
  443. msg = seg1 + seg2
  444. self.assertEqual(msg, MSG)
  445. def _testOverFlowRecv(self):
  446. self.serv_conn.send(MSG)
  447. def testRecvFrom(self):
  448. # Testing large recvfrom() over TCP
  449. msg, addr = self.cli_conn.recvfrom(1024)
  450. self.assertEqual(msg, MSG)
  451. def _testRecvFrom(self):
  452. self.serv_conn.send(MSG)
  453. def testOverFlowRecvFrom(self):
  454. # Testing recvfrom() in chunks over TCP
  455. seg1, addr = self.cli_conn.recvfrom(len(MSG)-3)
  456. seg2, addr = self.cli_conn.recvfrom(1024)
  457. msg = seg1 + seg2
  458. self.assertEqual(msg, MSG)
  459. def _testOverFlowRecvFrom(self):
  460. self.serv_conn.send(MSG)
  461. def testSendAll(self):
  462. # Testing sendall() with a 2048 byte string over TCP
  463. msg = ''
  464. while 1:
  465. read = self.cli_conn.recv(1024)
  466. if not read:
  467. break
  468. msg += read
  469. self.assertEqual(msg, 'f' * 2048)
  470. def _testSendAll(self):
  471. big_chunk = 'f' * 2048
  472. self.serv_conn.sendall(big_chunk)
  473. def testFromFd(self):
  474. # Testing fromfd()
  475. if not hasattr(socket, "fromfd"):
  476. return # On Windows, this doesn't exist
  477. fd = self.cli_conn.fileno()
  478. sock = socket.fromfd(fd, socket.AF_INET, socket.SOCK_STREAM)
  479. msg = sock.recv(1024)
  480. self.assertEqual(msg, MSG)
  481. def _testFromFd(self):
  482. self.serv_conn.send(MSG)
  483. def testShutdown(self):
  484. # Testing shutdown()
  485. msg = self.cli_conn.recv(1024)
  486. self.assertEqual(msg, MSG)
  487. # wait for _testShutdown to finish: on OS X, when the server
  488. # closes the connection the client also becomes disconnected,
  489. # and the client's shutdown call will fail. (Issue #4397.)
  490. self.done.wait()
  491. def _testShutdown(self):
  492. self.serv_conn.send(MSG)
  493. self.serv_conn.shutdown(2)
  494. class BasicUDPTest(ThreadedUDPSocketTest):
  495. def __init__(self, methodName='runTest'):
  496. ThreadedUDPSocketTest.__init__(self, methodName=methodName)
  497. def testSendtoAndRecv(self):
  498. # Testing sendto() and Recv() over UDP
  499. msg = self.serv.recv(len(MSG))
  500. self.assertEqual(msg, MSG)
  501. def _testSendtoAndRecv(self):
  502. self.cli.sendto(MSG, 0, (HOST, self.port))
  503. def testRecvFrom(self):
  504. # Testing recvfrom() over UDP
  505. msg, addr = self.serv.recvfrom(len(MSG))
  506. self.assertEqual(msg, MSG)
  507. def _testRecvFrom(self):
  508. self.cli.sendto(MSG, 0, (HOST, self.port))
  509. def testRecvFromNegative(self):
  510. # Negative lengths passed to recvfrom should give ValueError.
  511. self.assertRaises(ValueError, self.serv.recvfrom, -1)
  512. def _testRecvFromNegative(self):
  513. self.cli.sendto(MSG, 0, (HOST, self.port))
  514. class TCPCloserTest(ThreadedTCPSocketTest):
  515. def testClose(self):
  516. conn, addr = self.serv.accept()
  517. conn.close()
  518. sd = self.cli
  519. read, write, err = select.select([sd], [], [], 1.0)
  520. self.assertEqual(read, [sd])
  521. self.assertEqual(sd.recv(1), '')
  522. def _testClose(self):
  523. self.cli.connect((HOST, self.port))
  524. time.sleep(1.0)
  525. class BasicSocketPairTest(SocketPairTest):
  526. def __init__(self, methodName='runTest'):
  527. SocketPairTest.__init__(self, methodName=methodName)
  528. def testRecv(self):
  529. msg = self.serv.recv(1024)
  530. self.assertEqual(msg, MSG)
  531. def _testRecv(self):
  532. self.cli.send(MSG)
  533. def testSend(self):
  534. self.serv.send(MSG)
  535. def _testSend(self):
  536. msg = self.cli.recv(1024)
  537. self.assertEqual(msg, MSG)
  538. class NonBlockingTCPTests(ThreadedTCPSocketTest):
  539. def __init__(self, methodName='runTest'):
  540. ThreadedTCPSocketTest.__init__(self, methodName=methodName)
  541. def testSetBlocking(self):
  542. # Testing whether set blocking works
  543. self.serv.setblocking(0)
  544. start = time.time()
  545. try:
  546. self.serv.accept()
  547. except socket.error:
  548. pass
  549. end = time.time()
  550. self.assert_((end - start) < 1.0, "Error setting non-blocking mode.")
  551. def _testSetBlocking(self):
  552. pass
  553. def testAccept(self):
  554. # Testing non-blocking accept
  555. self.serv.setblocking(0)
  556. try:
  557. conn, addr = self.serv.accept()
  558. except socket.error:
  559. pass
  560. else:
  561. self.fail("Error trying to do non-blocking accept.")
  562. read, write, err = select.select([self.serv], [], [])
  563. if self.serv in read:
  564. conn, addr = self.serv.accept()
  565. else:
  566. self.fail("Error trying to do accept after select.")
  567. def _testAccept(self):
  568. time.sleep(0.1)
  569. self.cli.connect((HOST, self.port))
  570. def testConnect(self):
  571. # Testing non-blocking connect
  572. conn, addr = self.serv.accept()
  573. def _testConnect(self):
  574. self.cli.settimeout(10)
  575. self.cli.connect((HOST, self.port))
  576. def testRecv(self):
  577. # Testing non-blocking recv
  578. conn, addr = self.serv.accept()
  579. conn.setblocking(0)
  580. try:
  581. msg = conn.recv(len(MSG))
  582. except socket.error:
  583. pass
  584. else:
  585. self.fail("Error trying to do non-blocking recv.")
  586. read, write, err = select.select([conn], [], [])
  587. if conn in read:
  588. msg = conn.recv(len(MSG))
  589. self.assertEqual(msg, MSG)
  590. else:
  591. self.fail("Error during select call to non-blocking socket.")
  592. def _testRecv(self):
  593. self.cli.connect((HOST, self.port))
  594. time.sleep(0.1)
  595. self.cli.send(MSG)
  596. class FileObjectClassTestCase(SocketConnectedTest):
  597. bufsize = -1 # Use default buffer size
  598. def __init__(self, methodName='runTest'):
  599. SocketConnectedTest.__init__(self, methodName=methodName)
  600. def setUp(self):
  601. SocketConnectedTest.setUp(self)
  602. self.serv_file = self.cli_conn.makefile('rb', self.bufsize)
  603. def tearDown(self):
  604. self.serv_file.close()
  605. self.assert_(self.serv_file.closed)
  606. self.serv_file = None
  607. SocketConnectedTest.tearDown(self)
  608. def clientSetUp(self):
  609. SocketConnectedTest.clientSetUp(self)
  610. self.cli_file = self.serv_conn.makefile('wb')
  611. def clientTearDown(self):
  612. self.cli_file.close()
  613. self.assert_(self.cli_file.closed)
  614. self.cli_file = None
  615. SocketConnectedTest.clientTearDown(self)
  616. def testSmallRead(self):
  617. # Performing small file read test
  618. first_seg = self.serv_file.read(len(MSG)-3)
  619. second_seg = self.serv_file.read(3)
  620. msg = first_seg + second_seg
  621. self.assertEqual(msg, MSG)
  622. def _testSmallRead(self):
  623. self.cli_file.write(MSG)
  624. self.cli_file.flush()
  625. def testFullRead(self):
  626. # read until EOF
  627. msg = self.serv_file.read()
  628. self.assertEqual(msg, MSG)
  629. def _testFullRead(self):
  630. self.cli_file.write(MSG)
  631. self.cli_file.close()
  632. def testUnbufferedRead(self):
  633. # Performing unbuffered file read test
  634. buf = ''
  635. while 1:
  636. char = self.serv_file.read(1)
  637. if not char:
  638. break
  639. buf += char
  640. self.assertEqual(buf, MSG)
  641. def _testUnbufferedRead(self):
  642. self.cli_file.write(MSG)
  643. self.cli_file.flush()
  644. def testReadline(self):
  645. # Performing file readline test
  646. line = self.serv_file.readline()
  647. self.assertEqual(line, MSG)
  648. def _testReadline(self):
  649. self.cli_file.write(MSG)
  650. self.cli_file.flush()
  651. def testReadlineAfterRead(self):
  652. a_baloo_is = self.serv_file.read(len("A baloo is"))
  653. self.assertEqual("A baloo is", a_baloo_is)
  654. _a_bear = self.serv_file.read(len(" a bear"))
  655. self.assertEqual(" a bear", _a_bear)
  656. line = self.serv_file.readline()
  657. self.assertEqual("\n", line)
  658. line = self.serv_file.readline()
  659. self.assertEqual("A BALOO IS A BEAR.\n", line)
  660. line = self.serv_file.readline()
  661. self.assertEqual(MSG, line)
  662. def _testReadlineAfterRead(self):
  663. self.cli_file.write("A baloo is a bear\n")
  664. self.cli_file.write("A BALOO IS A BEAR.\n")
  665. self.cli_file.write(MSG)
  666. self.cli_file.flush()
  667. def testReadlineAfterReadNoNewline(self):
  668. end_of_ = self.serv_file.read(len("End Of "))
  669. self.assertEqual("End Of ", end_of_)
  670. line = self.serv_file.readline()
  671. self.assertEqual("Line", line)
  672. def _testReadlineAfterReadNoNewline(self):
  673. self.cli_file.write("End Of Line")
  674. def testClosedAttr(self):
  675. self.assert_(not self.serv_file.closed)
  676. def _testClosedAttr(self):
  677. self.assert_(not self.cli_file.closed)
  678. class UnbufferedFileObjectClassTestCase(FileObjectClassTestCase):
  679. """Repeat the tests from FileObjectClassTestCase with bufsize==0.
  680. In this case (and in this case only), it should be possible to
  681. create a file object, read a line from it, create another file
  682. object, read another line from it, without loss of data in the
  683. first file object's buffer. Note that httplib relies on this
  684. when reading multiple requests from the same socket."""
  685. bufsize = 0 # Use unbuffered mode
  686. def testUnbufferedReadline(self):
  687. # Read a line, create a new file object, read another line with it
  688. line = self.serv_file.readline() # first line
  689. self.assertEqual(line, "A. " + MSG) # first line
  690. self.serv_file = self.cli_conn.makefile('rb', 0)
  691. line = self.serv_file.readline() # second line
  692. self.assertEqual(line, "B. " + MSG) # second line
  693. def _testUnbufferedReadline(self):
  694. self.cli_file.write("A. " + MSG)
  695. self.cli_file.write("B. " + MSG)
  696. self.cli_file.flush()
  697. class LineBufferedFileObjectClassTestCase(FileObjectClassTestCase):
  698. bufsize = 1 # Default-buffered for reading; line-buffered for writing
  699. class SmallBufferedFileObjectClassTestCase(FileObjectClassTestCase):
  700. bufsize = 2 # Exercise the buffering code
  701. class NetworkConnectionTest(object):
  702. """Prove network connection."""
  703. def clientSetUp(self):
  704. # We're inherited below by BasicTCPTest2, which also inherits
  705. # BasicTCPTest, which defines self.port referenced below.
  706. self.cli = socket.create_connection((HOST, self.port))
  707. self.serv_conn = self.cli
  708. class BasicTCPTest2(NetworkConnectionTest, BasicTCPTest):
  709. """Tests that NetworkConnection does not break existing TCP functionality.
  710. """
  711. class NetworkConnectionNoServer(unittest.TestCase):
  712. def testWithoutServer(self):
  713. port = test_support.find_unused_port()
  714. self.failUnlessRaises(
  715. socket.error,
  716. lambda: socket.create_connection((HOST, port))
  717. )
  718. class NetworkConnectionAttributesTest(SocketTCPTest, ThreadableTest):
  719. def __init__(self, methodName='runTest'):
  720. SocketTCPTest.__init__(self, methodName=methodName)
  721. ThreadableTest.__init__(self)
  722. def clientSetUp(self):
  723. pass
  724. def clientTearDown(self):
  725. self.cli.close()
  726. self.cli = None
  727. ThreadableTest.clientTearDown(self)
  728. def _justAccept(self):
  729. conn, addr = self.serv.accept()
  730. testFamily = _justAccept
  731. def _testFamily(self):
  732. self.cli = socket.create_connection((HOST, self.port), timeout=30)
  733. self.assertEqual(self.cli.family, 2)
  734. testTimeoutDefault = _justAccept
  735. def _testTimeoutDefault(self):
  736. # passing no explicit timeout uses socket's global default
  737. self.assert_(socket.getdefaulttimeout() is None)
  738. socket.setdefaulttimeout(42)
  739. try:
  740. self.cli = socket.create_connection((HOST, self.port))
  741. finally:
  742. socket.setdefaulttimeout(None)
  743. self.assertEquals(self.cli.gettimeout(), 42)
  744. testTimeoutNone = _justAccept
  745. def _testTimeoutNone(self):
  746. # None timeout means the same as sock.settimeout(None)
  747. self.assert_(socket.getdefaulttimeout() is None)
  748. socket.setdefaulttimeout(30)
  749. try:
  750. self.cli = socket.create_connection((HOST, self.port), timeout=None)
  751. finally:
  752. socket.setdefaulttimeout(None)
  753. self.assertEqual(self.cli.gettimeout(), None)
  754. testTimeoutValueNamed = _justAccept
  755. def _testTimeoutValueNamed(self):
  756. self.cli = socket.create_connection((HOST, self.port), timeout=30)
  757. self.assertEqual(self.cli.gettimeout(), 30)
  758. testTimeoutValueNonamed = _justAccept
  759. def _testTimeoutValueNonamed(self):
  760. self.cli = socket.create_connection((HOST, self.port), 30)
  761. self.assertEqual(self.cli.gettimeout(), 30)
  762. class NetworkConnectionBehaviourTest(SocketTCPTest, ThreadableTest):
  763. def __init__(self, methodName='runTest'):
  764. SocketTCPTest.__init__(self, methodName=methodName)
  765. ThreadableTest.__init__(self)
  766. def clientSetUp(self):
  767. pass
  768. def clientTearDown(self):
  769. self.cli.close()
  770. self.cli = None
  771. ThreadableTest.clientTearDown(self)
  772. def testInsideTimeout(self):
  773. conn, addr = self.serv.accept()
  774. time.sleep(3)
  775. conn.send("done!")
  776. testOutsideTimeout = testInsideTimeout
  777. def _testInsideTimeout(self):
  778. self.cli = sock = socket.create_connection((HOST, self.port))
  779. data = sock.recv(5)
  780. self.assertEqual(data, "done!")
  781. def _testOutsideTimeout(self):
  782. self.cli = sock = socket.create_connection((HOST, self.port), timeout=1)
  783. self.failUnlessRaises(socket.timeout, lambda: sock.recv(5))
  784. class Urllib2FileobjectTest(unittest.TestCase):
  785. # urllib2.HTTPHandler has "borrowed" socket._fileobject, and requires that
  786. # it close the socket if the close c'tor argument is true
  787. def testClose(self):
  788. class MockSocket:
  789. closed = False
  790. def flush(self): pass
  791. def close(self): self.closed = True
  792. # must not close unless we request it: the original use of _fileobject
  793. # by module socket requires that the underlying socket not be closed until
  794. # the _socketobject that created the _fileobject is closed
  795. s = MockSocket()
  796. f = socket._fileobject(s)
  797. f.close()
  798. self.assert_(not s.closed)
  799. s = MockSocket()
  800. f = socket._fileobject(s, close=True)
  801. f.close()
  802. self.assert_(s.closed)
  803. class TCPTimeoutTest(SocketTCPTest):
  804. def testTCPTimeout(self):
  805. def raise_timeout(*args, **kwargs):
  806. self.serv.settimeout(1.0)
  807. self.serv.accept()
  808. self.failUnlessRaises(socket.timeout, raise_timeout,
  809. "Error generating a timeout exception (TCP)")
  810. def testTimeoutZero(self):
  811. ok = False
  812. try:
  813. self.serv.settimeout(0.0)
  814. foo = self.serv.accept()
  815. except socket.timeout:
  816. self.fail("caught timeout instead of error (TCP)")
  817. except socket.error:
  818. ok = True
  819. except:
  820. self.fail("caught unexpected exception (TCP)")
  821. if not ok:
  822. self.fail("accept() returned success when we did not expect it")
  823. def testInterruptedTimeout(self):
  824. # XXX I don't know how to do this test on MSWindows or any other
  825. # plaform that doesn't support signal.alarm() or os.kill(), though
  826. # the bug should have existed on all platforms.
  827. if not hasattr(signal, "alarm"):
  828. return # can only test on *nix
  829. self.serv.settimeout(5.0) # must be longer than alarm
  830. class Alarm(Exception):
  831. pass
  832. def alarm_handler(signal, frame):
  833. raise Alarm
  834. old_alarm = signal.signal(signal.SIGALRM, alarm_handler)
  835. try:
  836. signal.alarm(2) # POSIX allows alarm to be up to 1 second early
  837. try:
  838. foo = self.serv.accept()
  839. except socket.timeout:
  840. self.fail("caught timeout instead of Alarm")
  841. except Alarm:
  842. pass
  843. except:
  844. self.fail("caught other exception instead of Alarm:"
  845. " %s(%s):\n%s" %
  846. (sys.exc_info()[:2] + (traceback.format_exc(),)))
  847. else:
  848. self.fail("nothing caught")
  849. finally:
  850. signal.alarm(0) # shut off alarm
  851. except Alarm:
  852. self.fail("got Alarm in wrong place")
  853. finally:
  854. # no alarm can be pending. Safe to restore old handler.
  855. signal.signal(signal.SIGALRM, old_alarm)
  856. class UDPTimeoutTest(SocketTCPTest):
  857. def testUDPTimeout(self):
  858. def raise_timeout(*args, **kwargs):
  859. self.serv.settimeout(1.0)
  860. self.serv.recv(1024)
  861. self.failUnlessRaises(socket.timeout, raise_timeout,
  862. "Error generating a timeout exception (UDP)")
  863. def testTimeoutZero(self):
  864. ok = False
  865. try:
  866. self.serv.settimeout(0.0)
  867. foo = self.serv.recv(1024)
  868. except socket.timeout:
  869. self.fail("caught timeout instead of error (UDP)")
  870. except socket.error:
  871. ok = True
  872. except:
  873. self.fail("caught unexpected exception (UDP)")
  874. if not ok:
  875. self.fail("recv() returned success when we did not expect it")
  876. class TestExceptions(unittest.TestCase):
  877. def testExceptionTree(self):
  878. self.assert_(issubclass(socket.error, Exception))
  879. self.assert_(issubclass(socket.herror, socket.error))
  880. self.assert_(issubclass(socket.gaierror, socket.error))
  881. self.assert_(issubclass(socket.timeout, socket.error))
  882. class TestLinuxAbstractNamespace(unittest.TestCase):
  883. UNIX_PATH_MAX = 108
  884. def testLinuxAbstractNamespace(self):
  885. address = "\x00python-test-hello\x00\xff"
  886. s1 = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
  887. s1.bind(address)
  888. s1.listen(1)
  889. s2 = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
  890. s2.connect(s1.getsockname())
  891. s1.accept()
  892. self.assertEqual(s1.getsockname(), address)
  893. self.assertEqual(s2.getpeername(), address)
  894. def testMaxName(self):
  895. address = "\x00" + "h" * (self.UNIX_PATH_MAX - 1)
  896. s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
  897. s.bind(address)
  898. self.assertEqual(s.getsockname(), address)
  899. def testNameOverflow(self):
  900. address = "\x00" + "h" * self.UNIX_PATH_MAX
  901. s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
  902. self.assertRaises(socket.error, s.bind, address)
  903. class BufferIOTest(SocketConnectedTest):
  904. """
  905. Test the buffer versions of socket.recv() and socket.send().
  906. """
  907. def __init__(self, methodName='runTest'):
  908. SocketConnectedTest.__init__(self, methodName=methodName)
  909. def testRecvInto(self):
  910. buf = array.array('c', ' '*1024)
  911. nbytes = self.cli_conn.recv_into(buf)
  912. self.assertEqual(nbytes, len(MSG))
  913. msg = buf.tostring()[:len(MSG)]
  914. self.assertEqual(msg, MSG)
  915. def _testRecvInto(self):
  916. buf = buffer(MSG)
  917. self.serv_conn.send(buf)
  918. def testRecvFromInto(self):
  919. buf = array.array('c', ' '*1024)
  920. nbytes, addr = self.cli_conn.recvfrom_into(buf)
  921. self.assertEqual(nbytes, len(MSG))
  922. msg = buf.tostring()[:len(MSG)]
  923. self.assertEqual(msg, MSG)
  924. def _testRecvFromInto(self):
  925. buf = buffer(MSG)
  926. self.serv_conn.send(buf)
  927. TIPC_STYPE = 2000
  928. TIPC_LOWER = 200
  929. TIPC_UPPER = 210
  930. def isTipcAvailable():
  931. """Check if the TIPC module is loaded
  932. The TIPC module is not loaded automatically on Ubuntu and probably
  933. other Linux distros.
  934. """
  935. if not hasattr(socket, "AF_TIPC"):
  936. return False
  937. if not os.path.isfile("/proc/modules"):
  938. return False
  939. with open("/proc/modules") as f:
  940. for line in f:
  941. if line.startswith("tipc "):
  942. return True
  943. if test_support.verbose:
  944. print "TIPC module is not loaded, please 'sudo modprobe tipc'"
  945. return False
  946. class TIPCTest (unittest.TestCase):
  947. def testRDM(self):
  948. srv = socket.socket(socket.AF_TIPC, socket.SOCK_RDM)
  949. cli = socket.socket(socket.AF_TIPC, socket.SOCK_RDM)
  950. srv.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
  951. srvaddr = (socket.TIPC_ADDR_NAMESEQ, TIPC_STYPE,
  952. TIPC_LOWER, TIPC_UPPER)
  953. srv.bind(srvaddr)
  954. sendaddr = (socket.TIPC_ADDR_NAME, TIPC_STYPE,
  955. TIPC_LOWER + (TIPC_UPPER - TIPC_LOWER) / 2, 0)
  956. cli.sendto(MSG, sendaddr)
  957. msg, recvaddr = srv.recvfrom(1024)
  958. self.assertEqual(cli.getsockname(), recvaddr)
  959. self.assertEqual(msg, MSG)
  960. class TIPCThreadableTest (unittest.TestCase, ThreadableTest):
  961. def __init__(self, methodName = 'runTest'):
  962. unittest.TestCase.__init__(self, methodName = methodName)
  963. ThreadableTest.__init__(self)
  964. def setUp(self):
  965. self.srv = socket.socket(socket.AF_TIPC, socket.SOCK_STREAM)
  966. self.srv.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
  967. srvaddr = (socket.TIPC_ADDR_NAMESEQ, TIPC_STYPE,
  968. TIPC_LOWER, TIPC_UPPER)
  969. self.srv.bind(srvaddr)
  970. self.srv.listen(5)
  971. self.serverExplicitReady()
  972. self.conn, self.connaddr = self.srv.accept()
  973. def clientSetUp(self):
  974. # The is a hittable race between serverExplicitReady() and the
  975. # accept() call; sleep a little while to avoid it, otherwise
  976. # we could get an exception
  977. time.sleep(0.1)
  978. self.cli = socket.socket(socket.AF_TIPC, socket.SOCK_STREAM)
  979. addr = (socket.TIPC_ADDR_NAME, TIPC_STYPE,
  980. TIPC_LOWER + (TIPC_UPPER - TIPC_LOWER) / 2, 0)
  981. self.cli.connect(addr)
  982. self.cliaddr = self.cli.getsockname()
  983. def testStream(self):
  984. msg = self.conn.recv(1024)
  985. self.assertEqual(msg, MSG)
  986. self.assertEqual(self.cliaddr, self.connaddr)
  987. def _testStream(self):
  988. self.cli.send(MSG)
  989. self.cli.close()
  990. def test_main():
  991. tests = [GeneralModuleTests, BasicTCPTest, TCPCloserTest, TCPTimeoutTest,
  992. TestExceptions, BufferIOTest, BasicTCPTest2]
  993. if sys.platform != 'mac':
  994. tests.extend([ BasicUDPTest, UDPTimeoutTest ])
  995. tests.extend([
  996. NonBlockingTCPTests,
  997. FileObjectClassTestCase,
  998. UnbufferedFileObjectClassTestCase,
  999. LineBufferedFileObjectClassTestCase,
  1000. SmallBufferedFileObjectClassTestCase,
  1001. Urllib2FileobjectTest,
  1002. NetworkConnectionNoServer,
  1003. NetworkConnectionAttributesTest,
  1004. NetworkConnectionBehaviourTest,
  1005. ])
  1006. if hasattr(socket, "socketpair"):
  1007. tests.append(BasicSocketPairTest)
  1008. if sys.platform == 'linux2':
  1009. tests.append(TestLinuxAbstractNamespace)
  1010. if isTipcAvailable():
  1011. tests.append(TIPCTest)
  1012. tests.append(TIPCThreadableTest)
  1013. thread_info = test_support.threading_setup()
  1014. test_support.run_unittest(*tests)
  1015. test_support.threading_cleanup(*thread_info)
  1016. if __name__ == "__main__":
  1017. test_main()