blob: 93923ced4124b3e3bc7df5cc4c83a245a06f4812 [file] [log] [blame]
Benjamin Peterson90f5ba52010-03-11 22:53:45 +00001#!/usr/bin/env python3
Barry Warsawcf3d4b51997-01-03 20:03:32 +00002
Guido van Rossum24e4af82002-06-12 19:18:08 +00003import unittest
Benjamin Petersonee8712c2008-05-20 21:35:26 +00004from test import support
Barry Warsawcf3d4b51997-01-03 20:03:32 +00005
Christian Heimes5e696852008-04-09 08:37:03 +00006import errno
Gregory P. Smithaafdca82010-01-04 04:50:36 +00007import io
Barry Warsawcf3d4b51997-01-03 20:03:32 +00008import socket
Guido van Rossum24e4af82002-06-12 19:18:08 +00009import select
Christian Heimesbbe741d2008-03-28 10:53:29 +000010import time
11import traceback
Alexandre Vassalottif260e442008-05-11 19:59:59 +000012import queue
Jack Jansen522e7692002-09-06 21:57:50 +000013import sys
Christian Heimesfaf2f632008-01-06 16:59:19 +000014import os
15import array
Raymond Hettinger027bb632004-05-31 03:09:25 +000016from weakref import proxy
Thomas Wouters0e3f5912006-08-11 14:57:12 +000017import signal
Barry Warsawcf3d4b51997-01-03 20:03:32 +000018
Giampaolo Rodolà419f7042010-08-14 16:45:41 +000019def try_address(host, port=0, family=socket.AF_INET):
20 """Try to bind a socket on the given host:port and return True
21 if that has been possible."""
22 try:
23 sock = socket.socket(family, socket.SOCK_STREAM)
24 sock.bind((host, port))
25 except (socket.error, socket.gaierror):
26 return False
27 else:
28 sock.close()
29 return True
30
Benjamin Petersonee8712c2008-05-20 21:35:26 +000031HOST = support.HOST
Guido van Rossum7d0a8262007-05-21 23:13:11 +000032MSG = b'Michael Gilfix was here\n'
Giampaolo Rodolà419f7042010-08-14 16:45:41 +000033SUPPORTS_IPV6 = socket.has_ipv6 and try_address('::1', family=socket.AF_INET6)
Barry Warsawcf3d4b51997-01-03 20:03:32 +000034
Victor Stinner45df8202010-04-28 22:31:17 +000035try:
36 import _thread as thread
37 import threading
38except ImportError:
39 thread = None
40 threading = None
41
Guido van Rossum24e4af82002-06-12 19:18:08 +000042class SocketTCPTest(unittest.TestCase):
Barry Warsawcf3d4b51997-01-03 20:03:32 +000043
Guido van Rossum24e4af82002-06-12 19:18:08 +000044 def setUp(self):
45 self.serv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
Benjamin Petersonee8712c2008-05-20 21:35:26 +000046 self.port = support.bind_port(self.serv)
Guido van Rossum24e4af82002-06-12 19:18:08 +000047 self.serv.listen(1)
Barry Warsawcf3d4b51997-01-03 20:03:32 +000048
Guido van Rossum24e4af82002-06-12 19:18:08 +000049 def tearDown(self):
50 self.serv.close()
51 self.serv = None
Barry Warsawcf3d4b51997-01-03 20:03:32 +000052
Guido van Rossum24e4af82002-06-12 19:18:08 +000053class SocketUDPTest(unittest.TestCase):
54
55 def setUp(self):
56 self.serv = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
Benjamin Petersonee8712c2008-05-20 21:35:26 +000057 self.port = support.bind_port(self.serv)
Guido van Rossum24e4af82002-06-12 19:18:08 +000058
59 def tearDown(self):
60 self.serv.close()
61 self.serv = None
62
63class ThreadableTest:
Guido van Rossum83ccb4e2002-06-18 18:35:13 +000064 """Threadable Test class
65
66 The ThreadableTest class makes it easy to create a threaded
67 client/server pair from an existing unit test. To create a
68 new threaded class from an existing unit test, use multiple
69 inheritance:
70
71 class NewClass (OldClass, ThreadableTest):
72 pass
73
74 This class defines two new fixture functions with obvious
75 purposes for overriding:
76
77 clientSetUp ()
78 clientTearDown ()
79
80 Any new test functions within the class must then define
81 tests in pairs, where the test name is preceeded with a
82 '_' to indicate the client portion of the test. Ex:
83
84 def testFoo(self):
85 # Server portion
86
87 def _testFoo(self):
88 # Client portion
89
90 Any exceptions raised by the clients during their tests
91 are caught and transferred to the main thread to alert
92 the testing framework.
93
94 Note, the server setup function cannot call any blocking
95 functions that rely on the client thread during setup,
Guido van Rossumd8faa362007-04-27 19:54:29 +000096 unless serverExplicitReady() is called just before
Guido van Rossum83ccb4e2002-06-18 18:35:13 +000097 the blocking call (such as in setting up a client/server
98 connection and performing the accept() in setUp().
99 """
Guido van Rossum24e4af82002-06-12 19:18:08 +0000100
101 def __init__(self):
102 # Swap the true setup function
103 self.__setUp = self.setUp
104 self.__tearDown = self.tearDown
105 self.setUp = self._setUp
106 self.tearDown = self._tearDown
107
Guido van Rossum83ccb4e2002-06-18 18:35:13 +0000108 def serverExplicitReady(self):
109 """This method allows the server to explicitly indicate that
110 it wants the client thread to proceed. This is useful if the
111 server is about to execute a blocking routine that is
112 dependent upon the client thread during its setup routine."""
113 self.server_ready.set()
114
Guido van Rossum24e4af82002-06-12 19:18:08 +0000115 def _setUp(self):
Guido van Rossum83ccb4e2002-06-18 18:35:13 +0000116 self.server_ready = threading.Event()
117 self.client_ready = threading.Event()
Guido van Rossum24e4af82002-06-12 19:18:08 +0000118 self.done = threading.Event()
Alexandre Vassalottif260e442008-05-11 19:59:59 +0000119 self.queue = queue.Queue(1)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000120
121 # Do some munging to start the client test.
Guido van Rossum11ba0942002-06-13 15:07:44 +0000122 methodname = self.id()
123 i = methodname.rfind('.')
124 methodname = methodname[i+1:]
125 test_method = getattr(self, '_' + methodname)
Guido van Rossumab659962002-06-12 21:29:43 +0000126 self.client_thread = thread.start_new_thread(
127 self.clientRun, (test_method,))
Guido van Rossum24e4af82002-06-12 19:18:08 +0000128
129 self.__setUp()
Benjamin Peterson672b8032008-06-11 19:14:14 +0000130 if not self.server_ready.is_set():
Guido van Rossum83ccb4e2002-06-18 18:35:13 +0000131 self.server_ready.set()
132 self.client_ready.wait()
Guido van Rossum24e4af82002-06-12 19:18:08 +0000133
134 def _tearDown(self):
135 self.__tearDown()
136 self.done.wait()
137
Raymond Hettingerda3caed2008-01-14 21:39:24 +0000138 if self.queue.qsize():
Guido van Rossum24e4af82002-06-12 19:18:08 +0000139 msg = self.queue.get()
140 self.fail(msg)
141
142 def clientRun(self, test_func):
Guido van Rossum83ccb4e2002-06-18 18:35:13 +0000143 self.server_ready.wait()
144 self.client_ready.set()
Guido van Rossum24e4af82002-06-12 19:18:08 +0000145 self.clientSetUp()
Guido van Rossumd59da4b2007-05-22 18:11:13 +0000146 if not hasattr(test_func, '__call__'):
Collin Winter3add4d72007-08-29 23:37:32 +0000147 raise TypeError("test_func must be a callable function")
Guido van Rossum24e4af82002-06-12 19:18:08 +0000148 try:
149 test_func()
Guido van Rossumb940e112007-01-10 16:19:56 +0000150 except Exception as strerror:
Guido van Rossum24e4af82002-06-12 19:18:08 +0000151 self.queue.put(strerror)
152 self.clientTearDown()
153
154 def clientSetUp(self):
Collin Winter3add4d72007-08-29 23:37:32 +0000155 raise NotImplementedError("clientSetUp must be implemented.")
Guido van Rossum24e4af82002-06-12 19:18:08 +0000156
157 def clientTearDown(self):
158 self.done.set()
159 thread.exit()
160
161class ThreadedTCPSocketTest(SocketTCPTest, ThreadableTest):
162
163 def __init__(self, methodName='runTest'):
164 SocketTCPTest.__init__(self, methodName=methodName)
165 ThreadableTest.__init__(self)
166
167 def clientSetUp(self):
168 self.cli = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
169
170 def clientTearDown(self):
171 self.cli.close()
172 self.cli = None
173 ThreadableTest.clientTearDown(self)
174
175class ThreadedUDPSocketTest(SocketUDPTest, ThreadableTest):
176
177 def __init__(self, methodName='runTest'):
178 SocketUDPTest.__init__(self, methodName=methodName)
179 ThreadableTest.__init__(self)
180
181 def clientSetUp(self):
182 self.cli = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
183
184class SocketConnectedTest(ThreadedTCPSocketTest):
Jeremy Hylton5accbdb2007-08-03 20:40:09 +0000185 """Socket tests for client-server connection.
186
187 self.cli_conn is a client socket connected to the server. The
188 setUp() method guarantees that it is connected to the server.
189 """
Guido van Rossum24e4af82002-06-12 19:18:08 +0000190
191 def __init__(self, methodName='runTest'):
192 ThreadedTCPSocketTest.__init__(self, methodName=methodName)
193
194 def setUp(self):
195 ThreadedTCPSocketTest.setUp(self)
Guido van Rossum83ccb4e2002-06-18 18:35:13 +0000196 # Indicate explicitly we're ready for the client thread to
197 # proceed and then perform the blocking call to accept
198 self.serverExplicitReady()
Guido van Rossum24e4af82002-06-12 19:18:08 +0000199 conn, addr = self.serv.accept()
200 self.cli_conn = conn
201
202 def tearDown(self):
203 self.cli_conn.close()
204 self.cli_conn = None
205 ThreadedTCPSocketTest.tearDown(self)
206
207 def clientSetUp(self):
208 ThreadedTCPSocketTest.clientSetUp(self)
Christian Heimes5e696852008-04-09 08:37:03 +0000209 self.cli.connect((HOST, self.port))
Guido van Rossum24e4af82002-06-12 19:18:08 +0000210 self.serv_conn = self.cli
211
212 def clientTearDown(self):
213 self.serv_conn.close()
214 self.serv_conn = None
215 ThreadedTCPSocketTest.clientTearDown(self)
216
Dave Cole331708b2004-08-09 04:51:41 +0000217class SocketPairTest(unittest.TestCase, ThreadableTest):
218
219 def __init__(self, methodName='runTest'):
220 unittest.TestCase.__init__(self, methodName=methodName)
221 ThreadableTest.__init__(self)
222
223 def setUp(self):
224 self.serv, self.cli = socket.socketpair()
225
226 def tearDown(self):
227 self.serv.close()
228 self.serv = None
229
230 def clientSetUp(self):
231 pass
232
233 def clientTearDown(self):
234 self.cli.close()
235 self.cli = None
236 ThreadableTest.clientTearDown(self)
237
Tim Peters494aaee2004-08-09 18:54:11 +0000238
Guido van Rossum24e4af82002-06-12 19:18:08 +0000239#######################################################################
240## Begin Tests
241
242class GeneralModuleTests(unittest.TestCase):
243
Walter Dörwalda7eb93e2007-06-05 13:41:53 +0000244 def test_repr(self):
245 s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000246 self.assertTrue(repr(s).startswith("<socket.socket object"))
Walter Dörwalda7eb93e2007-06-05 13:41:53 +0000247
Raymond Hettinger027bb632004-05-31 03:09:25 +0000248 def test_weakref(self):
249 s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
250 p = proxy(s)
251 self.assertEqual(p.fileno(), s.fileno())
252 s.close()
253 s = None
254 try:
255 p.fileno()
256 except ReferenceError:
257 pass
258 else:
259 self.fail('Socket proxy still exists')
260
Guido van Rossum24e4af82002-06-12 19:18:08 +0000261 def testSocketError(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000262 # Testing socket module exceptions
Guido van Rossum24e4af82002-06-12 19:18:08 +0000263 def raise_error(*args, **kwargs):
264 raise socket.error
265 def raise_herror(*args, **kwargs):
266 raise socket.herror
267 def raise_gaierror(*args, **kwargs):
268 raise socket.gaierror
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000269 self.assertRaises(socket.error, raise_error,
Guido van Rossum24e4af82002-06-12 19:18:08 +0000270 "Error raising socket exception.")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000271 self.assertRaises(socket.error, raise_herror,
Guido van Rossum24e4af82002-06-12 19:18:08 +0000272 "Error raising socket exception.")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000273 self.assertRaises(socket.error, raise_gaierror,
Guido van Rossum24e4af82002-06-12 19:18:08 +0000274 "Error raising socket exception.")
275
276 def testCrucialConstants(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000277 # Testing for mission critical constants
Guido van Rossum24e4af82002-06-12 19:18:08 +0000278 socket.AF_INET
279 socket.SOCK_STREAM
280 socket.SOCK_DGRAM
281 socket.SOCK_RAW
282 socket.SOCK_RDM
283 socket.SOCK_SEQPACKET
284 socket.SOL_SOCKET
285 socket.SO_REUSEADDR
286
Guido van Rossum654c11e2002-06-13 20:24:17 +0000287 def testHostnameRes(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000288 # Testing hostname resolution mechanisms
Guido van Rossum654c11e2002-06-13 20:24:17 +0000289 hostname = socket.gethostname()
Guido van Rossum71e02942002-12-26 16:55:15 +0000290 try:
291 ip = socket.gethostbyname(hostname)
292 except socket.error:
293 # Probably name lookup wasn't set up right; skip this test
294 return
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000295 self.assertTrue(ip.find('.') >= 0, "Error resolving host to ip.")
Guido van Rossum9647b522002-12-26 17:04:45 +0000296 try:
297 hname, aliases, ipaddrs = socket.gethostbyaddr(ip)
298 except socket.error:
299 # Probably a similar problem as above; skip this test
300 return
Brett Cannon01668a12005-03-11 00:04:17 +0000301 all_host_names = [hostname, hname] + aliases
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000302 fqhn = socket.getfqdn(ip)
Guido van Rossum654c11e2002-06-13 20:24:17 +0000303 if not fqhn in all_host_names:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000304 self.fail("Error testing host resolution mechanisms. (fqdn: %s, all: %s)" % (fqhn, repr(all_host_names)))
Barry Warsawcf3d4b51997-01-03 20:03:32 +0000305
Guido van Rossum284a2cf2002-06-12 21:19:40 +0000306 def testRefCountGetNameInfo(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000307 # Testing reference count for getnameinfo
Guido van Rossum284a2cf2002-06-12 21:19:40 +0000308 if hasattr(sys, "getrefcount"):
Guido van Rossum24e4af82002-06-12 19:18:08 +0000309 try:
310 # On some versions, this loses a reference
311 orig = sys.getrefcount(__name__)
312 socket.getnameinfo(__name__,0)
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000313 except TypeError:
Guido van Rossumb053cd82006-08-24 03:53:23 +0000314 if sys.getrefcount(__name__) != orig:
Guido van Rossum24e4af82002-06-12 19:18:08 +0000315 self.fail("socket.getnameinfo loses a reference")
Barry Warsawcf3d4b51997-01-03 20:03:32 +0000316
Guido van Rossum24e4af82002-06-12 19:18:08 +0000317 def testInterpreterCrash(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000318 # Making sure getnameinfo doesn't crash the interpreter
Guido van Rossum24e4af82002-06-12 19:18:08 +0000319 try:
320 # On some versions, this crashes the interpreter.
321 socket.getnameinfo(('x', 0, 0, 0), 0)
322 except socket.error:
323 pass
Barry Warsawcf3d4b51997-01-03 20:03:32 +0000324
Guido van Rossumc0a0e082002-09-16 01:30:03 +0000325 def testNtoH(self):
Guido van Rossuma2627af2002-09-14 00:58:46 +0000326 # This just checks that htons etc. are their own inverse,
327 # when looking at the lower 16 or 32 bits.
328 sizes = {socket.htonl: 32, socket.ntohl: 32,
329 socket.htons: 16, socket.ntohs: 16}
330 for func, size in sizes.items():
Guido van Rossume2a383d2007-01-15 16:59:06 +0000331 mask = (1<<size) - 1
Guido van Rossuma2627af2002-09-14 00:58:46 +0000332 for i in (0, 1, 0xffff, ~0xffff, 2, 0x01234567, 0x76543210):
333 self.assertEqual(i & mask, func(func(i&mask)) & mask)
Jeremy Hyltoncbd5b892002-07-31 15:57:39 +0000334
Guido van Rossuma2627af2002-09-14 00:58:46 +0000335 swapped = func(mask)
336 self.assertEqual(swapped & mask, mask)
Guido van Rossume2a383d2007-01-15 16:59:06 +0000337 self.assertRaises(OverflowError, func, 1<<34)
Jeremy Hyltonc075e192002-07-25 16:01:12 +0000338
Guido van Rossum018919a2007-01-15 00:07:32 +0000339 def testNtoHErrors(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000340 good_values = [ 1, 2, 3, 1, 2, 3 ]
341 bad_values = [ -1, -2, -3, -1, -2, -3 ]
Guido van Rossum018919a2007-01-15 00:07:32 +0000342 for k in good_values:
343 socket.ntohl(k)
344 socket.ntohs(k)
345 socket.htonl(k)
346 socket.htons(k)
347 for k in bad_values:
348 self.assertRaises(OverflowError, socket.ntohl, k)
349 self.assertRaises(OverflowError, socket.ntohs, k)
350 self.assertRaises(OverflowError, socket.htonl, k)
351 self.assertRaises(OverflowError, socket.htons, k)
352
Barry Warsaw11b91a02004-06-28 00:50:43 +0000353 def testGetServBy(self):
354 eq = self.assertEqual
355 # Find one service that exists, then check all the related interfaces.
356 # I've ordered this by protocols that have both a tcp and udp
357 # protocol, at least for modern Linuxes.
Brett Cannon08febeb2004-11-20 21:10:07 +0000358 if sys.platform in ('linux2', 'freebsd4', 'freebsd5', 'freebsd6',
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000359 'freebsd7', 'freebsd8', 'darwin'):
Andrew MacIntyre18bf43c2004-07-12 12:10:30 +0000360 # avoid the 'echo' service on this platform, as there is an
361 # assumption breaking non-standard port/protocol entry
362 services = ('daytime', 'qotd', 'domain')
363 else:
364 services = ('echo', 'daytime', 'domain')
365 for service in services:
Skip Montanarof4433302002-08-02 15:52:30 +0000366 try:
Barry Warsaw11b91a02004-06-28 00:50:43 +0000367 port = socket.getservbyname(service, 'tcp')
Skip Montanarof4433302002-08-02 15:52:30 +0000368 break
369 except socket.error:
370 pass
Skip Montanaro05eb4012004-02-10 15:51:15 +0000371 else:
372 raise socket.error
Barry Warsaw11b91a02004-06-28 00:50:43 +0000373 # Try same call with optional protocol omitted
374 port2 = socket.getservbyname(service)
375 eq(port, port2)
376 # Try udp, but don't barf it it doesn't exist
377 try:
378 udpport = socket.getservbyname(service, 'udp')
379 except socket.error:
380 udpport = None
381 else:
382 eq(udpport, port)
383 # Now make sure the lookup by port returns the same service name
384 eq(socket.getservbyport(port2), service)
385 eq(socket.getservbyport(port, 'tcp'), service)
386 if udpport is not None:
387 eq(socket.getservbyport(udpport, 'udp'), service)
Benjamin Peterson5c6d7872009-02-06 02:40:07 +0000388 # Make sure getservbyport does not accept out of range ports.
389 self.assertRaises(OverflowError, socket.getservbyport, -1)
390 self.assertRaises(OverflowError, socket.getservbyport, 65536)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000391
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +0000392 def testDefaultTimeout(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000393 # Testing default timeout
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +0000394 # The default timeout should initially be None
395 self.assertEqual(socket.getdefaulttimeout(), None)
396 s = socket.socket()
397 self.assertEqual(s.gettimeout(), None)
398 s.close()
399
400 # Set the default timeout to 10, and see if it propagates
401 socket.setdefaulttimeout(10)
402 self.assertEqual(socket.getdefaulttimeout(), 10)
403 s = socket.socket()
404 self.assertEqual(s.gettimeout(), 10)
405 s.close()
406
407 # Reset the default timeout to None, and see if it propagates
408 socket.setdefaulttimeout(None)
409 self.assertEqual(socket.getdefaulttimeout(), None)
410 s = socket.socket()
411 self.assertEqual(s.gettimeout(), None)
412 s.close()
413
414 # Check that setting it to an invalid value raises ValueError
415 self.assertRaises(ValueError, socket.setdefaulttimeout, -1)
416
417 # Check that setting it to an invalid type raises TypeError
418 self.assertRaises(TypeError, socket.setdefaulttimeout, "spam")
419
Benjamin Petersonf91df042009-02-13 02:50:59 +0000420 def testIPv4_inet_aton_fourbytes(self):
421 if not hasattr(socket, 'inet_aton'):
422 return # No inet_aton, nothing to check
423 # Test that issue1008086 and issue767150 are fixed.
424 # It must return 4 bytes.
425 self.assertEquals(b'\x00'*4, socket.inet_aton('0.0.0.0'))
426 self.assertEquals(b'\xff'*4, socket.inet_aton('255.255.255.255'))
427
Guido van Rossum47dfa4a2003-04-25 05:48:32 +0000428 def testIPv4toString(self):
Guido van Rossumf4001ee2003-04-25 15:11:23 +0000429 if not hasattr(socket, 'inet_pton'):
430 return # No inet_pton() on this platform
Guido van Rossum47dfa4a2003-04-25 05:48:32 +0000431 from socket import inet_aton as f, inet_pton, AF_INET
432 g = lambda a: inet_pton(AF_INET, a)
433
Guido van Rossumb5b22702007-05-18 18:55:53 +0000434 self.assertEquals(b'\x00\x00\x00\x00', f('0.0.0.0'))
435 self.assertEquals(b'\xff\x00\xff\x00', f('255.0.255.0'))
436 self.assertEquals(b'\xaa\xaa\xaa\xaa', f('170.170.170.170'))
437 self.assertEquals(b'\x01\x02\x03\x04', f('1.2.3.4'))
438 self.assertEquals(b'\xff\xff\xff\xff', f('255.255.255.255'))
Guido van Rossum47dfa4a2003-04-25 05:48:32 +0000439
Guido van Rossumb5b22702007-05-18 18:55:53 +0000440 self.assertEquals(b'\x00\x00\x00\x00', g('0.0.0.0'))
441 self.assertEquals(b'\xff\x00\xff\x00', g('255.0.255.0'))
442 self.assertEquals(b'\xaa\xaa\xaa\xaa', g('170.170.170.170'))
443 self.assertEquals(b'\xff\xff\xff\xff', g('255.255.255.255'))
Tim Petersc2659cf2003-05-12 20:19:37 +0000444
Guido van Rossum47dfa4a2003-04-25 05:48:32 +0000445 def testIPv6toString(self):
Guido van Rossumf4001ee2003-04-25 15:11:23 +0000446 if not hasattr(socket, 'inet_pton'):
447 return # No inet_pton() on this platform
Guido van Rossum47dfa4a2003-04-25 05:48:32 +0000448 try:
449 from socket import inet_pton, AF_INET6, has_ipv6
450 if not has_ipv6:
451 return
452 except ImportError:
453 return
454 f = lambda a: inet_pton(AF_INET6, a)
455
Guido van Rossum540d9872007-08-17 03:51:09 +0000456 self.assertEquals(b'\x00' * 16, f('::'))
457 self.assertEquals(b'\x00' * 16, f('0::0'))
458 self.assertEquals(b'\x00\x01' + b'\x00' * 14, f('1::'))
Guido van Rossum47dfa4a2003-04-25 05:48:32 +0000459 self.assertEquals(
Guido van Rossum67180622007-07-10 07:29:12 +0000460 b'\x45\xef\x76\xcb\x00\x1a\x56\xef\xaf\xeb\x0b\xac\x19\x24\xae\xae',
Guido van Rossum47dfa4a2003-04-25 05:48:32 +0000461 f('45ef:76cb:1a:56ef:afeb:bac:1924:aeae')
462 )
Tim Petersc2659cf2003-05-12 20:19:37 +0000463
Guido van Rossum47dfa4a2003-04-25 05:48:32 +0000464 def testStringToIPv4(self):
Guido van Rossumf4001ee2003-04-25 15:11:23 +0000465 if not hasattr(socket, 'inet_ntop'):
466 return # No inet_ntop() on this platform
Guido van Rossum47dfa4a2003-04-25 05:48:32 +0000467 from socket import inet_ntoa as f, inet_ntop, AF_INET
468 g = lambda a: inet_ntop(AF_INET, a)
469
Guido van Rossumb5b22702007-05-18 18:55:53 +0000470 self.assertEquals('1.0.1.0', f(b'\x01\x00\x01\x00'))
471 self.assertEquals('170.85.170.85', f(b'\xaa\x55\xaa\x55'))
472 self.assertEquals('255.255.255.255', f(b'\xff\xff\xff\xff'))
473 self.assertEquals('1.2.3.4', f(b'\x01\x02\x03\x04'))
Tim Petersc2659cf2003-05-12 20:19:37 +0000474
Guido van Rossumb5b22702007-05-18 18:55:53 +0000475 self.assertEquals('1.0.1.0', g(b'\x01\x00\x01\x00'))
476 self.assertEquals('170.85.170.85', g(b'\xaa\x55\xaa\x55'))
477 self.assertEquals('255.255.255.255', g(b'\xff\xff\xff\xff'))
Guido van Rossum47dfa4a2003-04-25 05:48:32 +0000478
479 def testStringToIPv6(self):
Guido van Rossumf4001ee2003-04-25 15:11:23 +0000480 if not hasattr(socket, 'inet_ntop'):
481 return # No inet_ntop() on this platform
Guido van Rossum47dfa4a2003-04-25 05:48:32 +0000482 try:
483 from socket import inet_ntop, AF_INET6, has_ipv6
484 if not has_ipv6:
485 return
486 except ImportError:
487 return
488 f = lambda a: inet_ntop(AF_INET6, a)
489
Guido van Rossum540d9872007-08-17 03:51:09 +0000490 self.assertEquals('::', f(b'\x00' * 16))
491 self.assertEquals('::1', f(b'\x00' * 15 + b'\x01'))
Guido van Rossum47dfa4a2003-04-25 05:48:32 +0000492 self.assertEquals(
493 'aef:b01:506:1001:ffff:9997:55:170',
Guido van Rossum67180622007-07-10 07:29:12 +0000494 f(b'\x0a\xef\x0b\x01\x05\x06\x10\x01\xff\xff\x99\x97\x00\x55\x01\x70')
Guido van Rossum47dfa4a2003-04-25 05:48:32 +0000495 )
496
Guido van Rossumb6cc7d22002-07-19 12:46:46 +0000497 # XXX The following don't test module-level functionality...
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +0000498
Benjamin Peterson5c6d7872009-02-06 02:40:07 +0000499 def _get_unused_port(self, bind_address='0.0.0.0'):
500 """Use a temporary socket to elicit an unused ephemeral port.
Christian Heimes5e696852008-04-09 08:37:03 +0000501
Benjamin Peterson5c6d7872009-02-06 02:40:07 +0000502 Args:
503 bind_address: Hostname or IP address to search for a port on.
504
505 Returns: A most likely to be unused port.
506 """
507 tempsock = socket.socket()
508 tempsock.bind((bind_address, 0))
509 host, port = tempsock.getsockname()
510 tempsock.close()
511 return port
512
513 def testSockName(self):
514 # Testing getsockname()
515 port = self._get_unused_port()
Guido van Rossum24e4af82002-06-12 19:18:08 +0000516 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
Christian Heimes5e696852008-04-09 08:37:03 +0000517 sock.bind(("0.0.0.0", port))
Guido van Rossum24e4af82002-06-12 19:18:08 +0000518 name = sock.getsockname()
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000519 # XXX(nnorwitz): http://tinyurl.com/os5jz seems to indicate
520 # it reasonable to get the host's addr in addition to 0.0.0.0.
521 # At least for eCos. This is required for the S/390 to pass.
522 my_ip_addr = socket.gethostbyname(socket.gethostname())
Benjamin Peterson577473f2010-01-19 00:09:57 +0000523 self.assertIn(name[0], ("0.0.0.0", my_ip_addr), '%s invalid' % name[0])
Christian Heimes5e696852008-04-09 08:37:03 +0000524 self.assertEqual(name[1], port)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000525
526 def testGetSockOpt(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000527 # Testing getsockopt()
Guido van Rossum24e4af82002-06-12 19:18:08 +0000528 # We know a socket should start without reuse==0
529 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
530 reuse = sock.getsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000531 self.assertFalse(reuse != 0, "initial mode is reuse")
Guido van Rossum24e4af82002-06-12 19:18:08 +0000532
533 def testSetSockOpt(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000534 # Testing setsockopt()
Guido van Rossum24e4af82002-06-12 19:18:08 +0000535 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
536 sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
537 reuse = sock.getsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000538 self.assertFalse(reuse == 0, "failed to set reuse mode")
Guido van Rossum24e4af82002-06-12 19:18:08 +0000539
Guido van Rossumb6cc7d22002-07-19 12:46:46 +0000540 def testSendAfterClose(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000541 # testing send() after close() with timeout
Guido van Rossumb6cc7d22002-07-19 12:46:46 +0000542 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
543 sock.settimeout(1)
544 sock.close()
Guido van Rossum8a392d72007-11-21 22:09:45 +0000545 self.assertRaises(socket.error, sock.send, b"spam")
Guido van Rossumb6cc7d22002-07-19 12:46:46 +0000546
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000547 def testNewAttributes(self):
548 # testing .family, .type and .protocol
549 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
550 self.assertEqual(sock.family, socket.AF_INET)
551 self.assertEqual(sock.type, socket.SOCK_STREAM)
552 self.assertEqual(sock.proto, 0)
553 sock.close()
554
Benjamin Peterson5c6d7872009-02-06 02:40:07 +0000555 def test_getsockaddrarg(self):
556 host = '0.0.0.0'
557 port = self._get_unused_port(bind_address=host)
558 big_port = port + 65536
559 neg_port = port - 65536
560 sock = socket.socket()
561 try:
562 self.assertRaises(OverflowError, sock.bind, (host, big_port))
563 self.assertRaises(OverflowError, sock.bind, (host, neg_port))
564 sock.bind((host, port))
565 finally:
566 sock.close()
567
Christian Heimesfaf2f632008-01-06 16:59:19 +0000568 def test_sock_ioctl(self):
569 if os.name != "nt":
570 return
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000571 self.assertTrue(hasattr(socket.socket, 'ioctl'))
572 self.assertTrue(hasattr(socket, 'SIO_RCVALL'))
573 self.assertTrue(hasattr(socket, 'RCVALL_ON'))
574 self.assertTrue(hasattr(socket, 'RCVALL_OFF'))
Kristján Valur Jónsson847ec752009-09-27 21:10:38 +0000575 self.assertTrue(hasattr(socket, 'SIO_KEEPALIVE_VALS'))
576 s = socket.socket()
577 self.assertRaises(ValueError, s.ioctl, -1, None)
578 s.ioctl(socket.SIO_KEEPALIVE_VALS, (1, 100, 100))
Christian Heimesfaf2f632008-01-06 16:59:19 +0000579
Giampaolo Rodolà419f7042010-08-14 16:45:41 +0000580 def testGetaddrinfo(self):
581 try:
582 socket.getaddrinfo('localhost', 80)
583 except socket.gaierror as err:
584 if err.errno == socket.EAI_SERVICE:
585 # see http://bugs.python.org/issue1282647
586 self.skipTest("buggy libc version")
587 raise
588 # len of every sequence is supposed to be == 5
589 for info in socket.getaddrinfo(HOST, None):
590 self.assertEqual(len(info), 5)
591 # host can be a domain name, a string representation of an
592 # IPv4/v6 address or None
593 socket.getaddrinfo('localhost', 80)
594 socket.getaddrinfo('127.0.0.1', 80)
595 socket.getaddrinfo(None, 80)
596 if SUPPORTS_IPV6:
597 socket.getaddrinfo('::1', 80)
598 # port can be a string service name such as "http", a numeric
599 # port number or None
600 socket.getaddrinfo(HOST, "http")
601 socket.getaddrinfo(HOST, 80)
602 socket.getaddrinfo(HOST, None)
603 # test family and socktype filters
604 infos = socket.getaddrinfo(HOST, None, socket.AF_INET)
605 for family, _, _, _, _ in infos:
606 self.assertEqual(family, socket.AF_INET)
607 infos = socket.getaddrinfo(HOST, None, 0, socket.SOCK_STREAM)
608 for _, socktype, _, _, _ in infos:
609 self.assertEqual(socktype, socket.SOCK_STREAM)
610 # test proto and flags arguments
611 socket.getaddrinfo(HOST, None, 0, 0, socket.AI_CANONNAME)
612 socket.getaddrinfo(HOST, None, 0, 0, 0, socket.AI_PASSIVE)
613 # a server willing to support both IPv4 and IPv6 will
614 # usually do this
615 socket.getaddrinfo(None, 0, socket.AF_UNSPEC, socket.SOCK_STREAM, 0,
616 socket.AI_PASSIVE)
617
Christian Heimesfaf2f632008-01-06 16:59:19 +0000618
Victor Stinner45df8202010-04-28 22:31:17 +0000619@unittest.skipUnless(thread, 'Threading required for this test.')
Guido van Rossum24e4af82002-06-12 19:18:08 +0000620class BasicTCPTest(SocketConnectedTest):
621
622 def __init__(self, methodName='runTest'):
623 SocketConnectedTest.__init__(self, methodName=methodName)
624
625 def testRecv(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000626 # Testing large receive over TCP
Guido van Rossum24e4af82002-06-12 19:18:08 +0000627 msg = self.cli_conn.recv(1024)
Guido van Rossum76489682002-06-12 20:38:30 +0000628 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000629
630 def _testRecv(self):
631 self.serv_conn.send(MSG)
632
633 def testOverFlowRecv(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000634 # Testing receive in chunks over TCP
Guido van Rossum24e4af82002-06-12 19:18:08 +0000635 seg1 = self.cli_conn.recv(len(MSG) - 3)
636 seg2 = self.cli_conn.recv(1024)
Guido van Rossumab659962002-06-12 21:29:43 +0000637 msg = seg1 + seg2
Guido van Rossum76489682002-06-12 20:38:30 +0000638 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000639
640 def _testOverFlowRecv(self):
641 self.serv_conn.send(MSG)
642
643 def testRecvFrom(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000644 # Testing large recvfrom() over TCP
Guido van Rossum24e4af82002-06-12 19:18:08 +0000645 msg, addr = self.cli_conn.recvfrom(1024)
Guido van Rossum76489682002-06-12 20:38:30 +0000646 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000647
648 def _testRecvFrom(self):
649 self.serv_conn.send(MSG)
650
651 def testOverFlowRecvFrom(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000652 # Testing recvfrom() in chunks over TCP
Guido van Rossum24e4af82002-06-12 19:18:08 +0000653 seg1, addr = self.cli_conn.recvfrom(len(MSG)-3)
654 seg2, addr = self.cli_conn.recvfrom(1024)
Guido van Rossumab659962002-06-12 21:29:43 +0000655 msg = seg1 + seg2
Guido van Rossum76489682002-06-12 20:38:30 +0000656 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000657
658 def _testOverFlowRecvFrom(self):
659 self.serv_conn.send(MSG)
660
661 def testSendAll(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000662 # Testing sendall() with a 2048 byte string over TCP
Guido van Rossum7d0a8262007-05-21 23:13:11 +0000663 msg = b''
Guido van Rossum24e4af82002-06-12 19:18:08 +0000664 while 1:
665 read = self.cli_conn.recv(1024)
666 if not read:
667 break
Guido van Rossume531e292002-08-08 20:28:34 +0000668 msg += read
Guido van Rossum7d0a8262007-05-21 23:13:11 +0000669 self.assertEqual(msg, b'f' * 2048)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000670
671 def _testSendAll(self):
Guido van Rossum7d0a8262007-05-21 23:13:11 +0000672 big_chunk = b'f' * 2048
Guido van Rossum24e4af82002-06-12 19:18:08 +0000673 self.serv_conn.sendall(big_chunk)
674
675 def testFromFd(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000676 # Testing fromfd()
Guido van Rossum8e95ca82002-06-12 20:55:17 +0000677 if not hasattr(socket, "fromfd"):
Guido van Rossum6fb3d5e2002-06-12 20:48:59 +0000678 return # On Windows, this doesn't exist
Guido van Rossum24e4af82002-06-12 19:18:08 +0000679 fd = self.cli_conn.fileno()
680 sock = socket.fromfd(fd, socket.AF_INET, socket.SOCK_STREAM)
681 msg = sock.recv(1024)
Guido van Rossum76489682002-06-12 20:38:30 +0000682 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000683
684 def _testFromFd(self):
685 self.serv_conn.send(MSG)
686
Guido van Rossum39eb8fa2007-11-16 01:24:05 +0000687 def testDup(self):
688 # Testing dup()
689 sock = self.cli_conn.dup()
690 msg = sock.recv(1024)
691 self.assertEqual(msg, MSG)
692
693 def _testDup(self):
694 self.serv_conn.send(MSG)
695
Guido van Rossum24e4af82002-06-12 19:18:08 +0000696 def testShutdown(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000697 # Testing shutdown()
Guido van Rossum24e4af82002-06-12 19:18:08 +0000698 msg = self.cli_conn.recv(1024)
Guido van Rossum76489682002-06-12 20:38:30 +0000699 self.assertEqual(msg, MSG)
Mark Dickinson29500f62009-01-15 15:36:10 +0000700 # wait for _testShutdown to finish: on OS X, when the server
701 # closes the connection the client also becomes disconnected,
702 # and the client's shutdown call will fail. (Issue #4397.)
703 self.done.wait()
Guido van Rossum24e4af82002-06-12 19:18:08 +0000704
705 def _testShutdown(self):
706 self.serv_conn.send(MSG)
707 self.serv_conn.shutdown(2)
708
Antoine Pitrou6e451df2010-08-09 20:39:54 +0000709 def testDetach(self):
710 # Testing detach()
711 fileno = self.cli_conn.fileno()
712 f = self.cli_conn.detach()
713 self.assertEqual(f, fileno)
714 # cli_conn cannot be used anymore...
Antoine Pitroue43f9d02010-08-08 23:24:50 +0000715 self.assertRaises(socket.error, self.cli_conn.recv, 1024)
716 self.cli_conn.close()
Antoine Pitrou6e451df2010-08-09 20:39:54 +0000717 # ...but we can create another socket using the (still open)
718 # file descriptor
Antoine Pitroue43f9d02010-08-08 23:24:50 +0000719 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM, fileno=f)
720 msg = sock.recv(1024)
721 self.assertEqual(msg, MSG)
722
Antoine Pitrou6e451df2010-08-09 20:39:54 +0000723 def _testDetach(self):
Antoine Pitroue43f9d02010-08-08 23:24:50 +0000724 self.serv_conn.send(MSG)
725
Victor Stinner45df8202010-04-28 22:31:17 +0000726@unittest.skipUnless(thread, 'Threading required for this test.')
Guido van Rossum24e4af82002-06-12 19:18:08 +0000727class BasicUDPTest(ThreadedUDPSocketTest):
728
729 def __init__(self, methodName='runTest'):
730 ThreadedUDPSocketTest.__init__(self, methodName=methodName)
731
732 def testSendtoAndRecv(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000733 # Testing sendto() and Recv() over UDP
Guido van Rossum24e4af82002-06-12 19:18:08 +0000734 msg = self.serv.recv(len(MSG))
Guido van Rossum76489682002-06-12 20:38:30 +0000735 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000736
737 def _testSendtoAndRecv(self):
Christian Heimes5e696852008-04-09 08:37:03 +0000738 self.cli.sendto(MSG, 0, (HOST, self.port))
Guido van Rossum24e4af82002-06-12 19:18:08 +0000739
Guido van Rossum1c938012002-06-12 21:17:20 +0000740 def testRecvFrom(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000741 # Testing recvfrom() over UDP
Guido van Rossum24e4af82002-06-12 19:18:08 +0000742 msg, addr = self.serv.recvfrom(len(MSG))
Guido van Rossum76489682002-06-12 20:38:30 +0000743 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000744
Guido van Rossum1c938012002-06-12 21:17:20 +0000745 def _testRecvFrom(self):
Christian Heimes5e696852008-04-09 08:37:03 +0000746 self.cli.sendto(MSG, 0, (HOST, self.port))
Guido van Rossum24e4af82002-06-12 19:18:08 +0000747
Guido van Rossumd8faa362007-04-27 19:54:29 +0000748 def testRecvFromNegative(self):
749 # Negative lengths passed to recvfrom should give ValueError.
750 self.assertRaises(ValueError, self.serv.recvfrom, -1)
751
752 def _testRecvFromNegative(self):
Christian Heimes5e696852008-04-09 08:37:03 +0000753 self.cli.sendto(MSG, 0, (HOST, self.port))
Guido van Rossumd8faa362007-04-27 19:54:29 +0000754
Victor Stinner45df8202010-04-28 22:31:17 +0000755@unittest.skipUnless(thread, 'Threading required for this test.')
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000756class TCPCloserTest(ThreadedTCPSocketTest):
757
758 def testClose(self):
759 conn, addr = self.serv.accept()
760 conn.close()
761
762 sd = self.cli
763 read, write, err = select.select([sd], [], [], 1.0)
764 self.assertEqual(read, [sd])
Guido van Rossum7d0a8262007-05-21 23:13:11 +0000765 self.assertEqual(sd.recv(1), b'')
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000766
Jeremy Hylton5accbdb2007-08-03 20:40:09 +0000767 # Calling close() many times should be safe.
768 conn.close()
769 conn.close()
770
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000771 def _testClose(self):
Christian Heimes5e696852008-04-09 08:37:03 +0000772 self.cli.connect((HOST, self.port))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000773 time.sleep(1.0)
774
Victor Stinner45df8202010-04-28 22:31:17 +0000775@unittest.skipUnless(thread, 'Threading required for this test.')
Dave Cole331708b2004-08-09 04:51:41 +0000776class BasicSocketPairTest(SocketPairTest):
777
778 def __init__(self, methodName='runTest'):
779 SocketPairTest.__init__(self, methodName=methodName)
780
781 def testRecv(self):
782 msg = self.serv.recv(1024)
783 self.assertEqual(msg, MSG)
784
785 def _testRecv(self):
786 self.cli.send(MSG)
787
788 def testSend(self):
789 self.serv.send(MSG)
790
791 def _testSend(self):
792 msg = self.cli.recv(1024)
793 self.assertEqual(msg, MSG)
794
Victor Stinner45df8202010-04-28 22:31:17 +0000795@unittest.skipUnless(thread, 'Threading required for this test.')
Guido van Rossum24e4af82002-06-12 19:18:08 +0000796class NonBlockingTCPTests(ThreadedTCPSocketTest):
797
798 def __init__(self, methodName='runTest'):
799 ThreadedTCPSocketTest.__init__(self, methodName=methodName)
800
801 def testSetBlocking(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000802 # Testing whether set blocking works
Guido van Rossum24e4af82002-06-12 19:18:08 +0000803 self.serv.setblocking(0)
804 start = time.time()
805 try:
806 self.serv.accept()
807 except socket.error:
808 pass
809 end = time.time()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000810 self.assertTrue((end - start) < 1.0, "Error setting non-blocking mode.")
Guido van Rossum24e4af82002-06-12 19:18:08 +0000811
812 def _testSetBlocking(self):
Barry Warsaw6870bba2001-03-23 17:40:16 +0000813 pass
Barry Warsawcf3d4b51997-01-03 20:03:32 +0000814
Guido van Rossum24e4af82002-06-12 19:18:08 +0000815 def testAccept(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000816 # Testing non-blocking accept
Guido van Rossum24e4af82002-06-12 19:18:08 +0000817 self.serv.setblocking(0)
Guido van Rossum41360a41998-03-26 19:42:58 +0000818 try:
Guido van Rossum24e4af82002-06-12 19:18:08 +0000819 conn, addr = self.serv.accept()
820 except socket.error:
821 pass
822 else:
823 self.fail("Error trying to do non-blocking accept.")
824 read, write, err = select.select([self.serv], [], [])
825 if self.serv in read:
826 conn, addr = self.serv.accept()
827 else:
828 self.fail("Error trying to do accept after select.")
Guido van Rossum67f7a382002-06-06 21:08:16 +0000829
Guido van Rossum24e4af82002-06-12 19:18:08 +0000830 def _testAccept(self):
Guido van Rossumb6cc7d22002-07-19 12:46:46 +0000831 time.sleep(0.1)
Christian Heimes5e696852008-04-09 08:37:03 +0000832 self.cli.connect((HOST, self.port))
Guido van Rossum24e4af82002-06-12 19:18:08 +0000833
834 def testConnect(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000835 # Testing non-blocking connect
Guido van Rossum24e4af82002-06-12 19:18:08 +0000836 conn, addr = self.serv.accept()
837
838 def _testConnect(self):
Guido van Rossum7b8bac12002-06-13 16:07:04 +0000839 self.cli.settimeout(10)
Christian Heimes5e696852008-04-09 08:37:03 +0000840 self.cli.connect((HOST, self.port))
Guido van Rossum24e4af82002-06-12 19:18:08 +0000841
842 def testRecv(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000843 # Testing non-blocking recv
Guido van Rossum24e4af82002-06-12 19:18:08 +0000844 conn, addr = self.serv.accept()
845 conn.setblocking(0)
846 try:
847 msg = conn.recv(len(MSG))
848 except socket.error:
849 pass
850 else:
851 self.fail("Error trying to do non-blocking recv.")
852 read, write, err = select.select([conn], [], [])
853 if conn in read:
854 msg = conn.recv(len(MSG))
Guido van Rossum76489682002-06-12 20:38:30 +0000855 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000856 else:
857 self.fail("Error during select call to non-blocking socket.")
858
859 def _testRecv(self):
Christian Heimes5e696852008-04-09 08:37:03 +0000860 self.cli.connect((HOST, self.port))
Guido van Rossumb6cc7d22002-07-19 12:46:46 +0000861 time.sleep(0.1)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000862 self.cli.send(MSG)
863
Victor Stinner45df8202010-04-28 22:31:17 +0000864@unittest.skipUnless(thread, 'Threading required for this test.')
Guido van Rossum24e4af82002-06-12 19:18:08 +0000865class FileObjectClassTestCase(SocketConnectedTest):
Jeremy Hylton5accbdb2007-08-03 20:40:09 +0000866 """Unit tests for the object returned by socket.makefile()
867
868 self.serv_file is the io object returned by makefile() on
869 the client connection. You can read from this file to
870 get output from the server.
871
872 self.cli_file is the io object returned by makefile() on the
873 server connection. You can write to this file to send output
874 to the client.
875 """
Guido van Rossum24e4af82002-06-12 19:18:08 +0000876
Guido van Rossume9f66142002-08-07 15:46:19 +0000877 bufsize = -1 # Use default buffer size
878
Guido van Rossum24e4af82002-06-12 19:18:08 +0000879 def __init__(self, methodName='runTest'):
880 SocketConnectedTest.__init__(self, methodName=methodName)
881
882 def setUp(self):
883 SocketConnectedTest.setUp(self)
Guido van Rossume9f66142002-08-07 15:46:19 +0000884 self.serv_file = self.cli_conn.makefile('rb', self.bufsize)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000885
886 def tearDown(self):
887 self.serv_file.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000888 self.assertTrue(self.serv_file.closed)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000889 self.serv_file = None
890 SocketConnectedTest.tearDown(self)
891
892 def clientSetUp(self):
893 SocketConnectedTest.clientSetUp(self)
Guido van Rossume9f66142002-08-07 15:46:19 +0000894 self.cli_file = self.serv_conn.makefile('wb')
Guido van Rossum24e4af82002-06-12 19:18:08 +0000895
896 def clientTearDown(self):
897 self.cli_file.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000898 self.assertTrue(self.cli_file.closed)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000899 self.cli_file = None
900 SocketConnectedTest.clientTearDown(self)
901
902 def testSmallRead(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000903 # Performing small file read test
Guido van Rossum24e4af82002-06-12 19:18:08 +0000904 first_seg = self.serv_file.read(len(MSG)-3)
905 second_seg = self.serv_file.read(3)
Guido van Rossumab659962002-06-12 21:29:43 +0000906 msg = first_seg + second_seg
Guido van Rossum76489682002-06-12 20:38:30 +0000907 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000908
909 def _testSmallRead(self):
910 self.cli_file.write(MSG)
911 self.cli_file.flush()
912
Guido van Rossum8c943832002-08-08 01:00:28 +0000913 def testFullRead(self):
914 # read until EOF
915 msg = self.serv_file.read()
916 self.assertEqual(msg, MSG)
917
918 def _testFullRead(self):
919 self.cli_file.write(MSG)
920 self.cli_file.close()
921
Guido van Rossum24e4af82002-06-12 19:18:08 +0000922 def testUnbufferedRead(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000923 # Performing unbuffered file read test
Guido van Rossum7d0a8262007-05-21 23:13:11 +0000924 buf = b''
Guido van Rossum24e4af82002-06-12 19:18:08 +0000925 while 1:
926 char = self.serv_file.read(1)
Guido van Rossum8c943832002-08-08 01:00:28 +0000927 if not char:
Guido van Rossum24e4af82002-06-12 19:18:08 +0000928 break
Guido van Rossum8c943832002-08-08 01:00:28 +0000929 buf += char
930 self.assertEqual(buf, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000931
932 def _testUnbufferedRead(self):
933 self.cli_file.write(MSG)
934 self.cli_file.flush()
935
936 def testReadline(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000937 # Performing file readline test
Guido van Rossum24e4af82002-06-12 19:18:08 +0000938 line = self.serv_file.readline()
Guido van Rossum76489682002-06-12 20:38:30 +0000939 self.assertEqual(line, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000940
941 def _testReadline(self):
942 self.cli_file.write(MSG)
943 self.cli_file.flush()
944
Jeremy Hylton5accbdb2007-08-03 20:40:09 +0000945 def testCloseAfterMakefile(self):
946 # The file returned by makefile should keep the socket open.
947 self.cli_conn.close()
948 # read until EOF
949 msg = self.serv_file.read()
950 self.assertEqual(msg, MSG)
951
952 def _testCloseAfterMakefile(self):
953 self.cli_file.write(MSG)
954 self.cli_file.flush()
955
956 def testMakefileAfterMakefileClose(self):
957 self.serv_file.close()
958 msg = self.cli_conn.recv(len(MSG))
959 self.assertEqual(msg, MSG)
960
961 def _testMakefileAfterMakefileClose(self):
962 self.cli_file.write(MSG)
963 self.cli_file.flush()
964
Tim Peters116d83c2004-03-28 02:20:45 +0000965 def testClosedAttr(self):
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000966 self.assertTrue(not self.serv_file.closed)
Tim Peters116d83c2004-03-28 02:20:45 +0000967
968 def _testClosedAttr(self):
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000969 self.assertTrue(not self.cli_file.closed)
Tim Peters116d83c2004-03-28 02:20:45 +0000970
Amaury Forgeot d'Arc9d24ff02008-11-20 23:15:52 +0000971 def testAttributes(self):
Benjamin Peterson44309e62008-11-22 00:41:45 +0000972 self.assertEqual(self.serv_file.mode, 'rb')
Amaury Forgeot d'Arc9d24ff02008-11-20 23:15:52 +0000973 self.assertEqual(self.serv_file.name, self.cli_conn.fileno())
974
975 def _testAttributes(self):
Benjamin Peterson44309e62008-11-22 00:41:45 +0000976 self.assertEqual(self.cli_file.mode, 'wb')
Amaury Forgeot d'Arc9d24ff02008-11-20 23:15:52 +0000977 self.assertEqual(self.cli_file.name, self.serv_conn.fileno())
978
Gregory P. Smithde3369f2009-01-12 04:50:11 +0000979 def testRealClose(self):
980 self.serv_file.close()
981 self.assertRaises(ValueError, self.serv_file.fileno)
982 self.cli_conn.close()
983 self.assertRaises(socket.error, self.cli_conn.getsockname)
984
985 def _testRealClose(self):
986 pass
987
988
Gregory P. Smithaafdca82010-01-04 04:50:36 +0000989class FileObjectInterruptedTestCase(unittest.TestCase):
990 """Test that the file object correctly handles EINTR internally."""
991
992 class MockSocket(object):
993 def __init__(self, recv_funcs=()):
994 # A generator that returns callables that we'll call for each
995 # call to recv().
996 self._recv_step = iter(recv_funcs)
997
998 def recv_into(self, buffer):
999 data = next(self._recv_step)()
1000 assert len(buffer) >= len(data)
1001 buffer[:len(data)] = data
1002 return len(data)
1003
1004 def _decref_socketios(self):
1005 pass
1006
1007 def _textiowrap_for_test(self, buffering=-1):
1008 raw = socket.SocketIO(self, "r")
1009 if buffering < 0:
1010 buffering = io.DEFAULT_BUFFER_SIZE
1011 if buffering == 0:
1012 return raw
1013 buffer = io.BufferedReader(raw, buffering)
1014 text = io.TextIOWrapper(buffer, None, None)
1015 text.mode = "rb"
1016 return text
1017
1018 @staticmethod
1019 def _raise_eintr():
1020 raise socket.error(errno.EINTR)
1021
1022 def _textiowrap_mock_socket(self, mock, buffering=-1):
1023 raw = socket.SocketIO(mock, "r")
1024 if buffering < 0:
1025 buffering = io.DEFAULT_BUFFER_SIZE
1026 if buffering == 0:
1027 return raw
1028 buffer = io.BufferedReader(raw, buffering)
1029 text = io.TextIOWrapper(buffer, None, None)
1030 text.mode = "rb"
1031 return text
1032
1033 def _test_readline(self, size=-1, buffering=-1):
1034 mock_sock = self.MockSocket(recv_funcs=[
1035 lambda : b"This is the first line\nAnd the sec",
1036 self._raise_eintr,
1037 lambda : b"ond line is here\n",
1038 lambda : b"",
1039 lambda : b"", # XXX(gps): io library does an extra EOF read
1040 ])
1041 fo = mock_sock._textiowrap_for_test(buffering=buffering)
1042 self.assertEquals(fo.readline(size), "This is the first line\n")
1043 self.assertEquals(fo.readline(size), "And the second line is here\n")
1044
1045 def _test_read(self, size=-1, buffering=-1):
1046 mock_sock = self.MockSocket(recv_funcs=[
1047 lambda : b"This is the first line\nAnd the sec",
1048 self._raise_eintr,
1049 lambda : b"ond line is here\n",
1050 lambda : b"",
1051 lambda : b"", # XXX(gps): io library does an extra EOF read
1052 ])
1053 expecting = (b"This is the first line\n"
1054 b"And the second line is here\n")
1055 fo = mock_sock._textiowrap_for_test(buffering=buffering)
1056 if buffering == 0:
1057 data = b''
1058 else:
1059 data = ''
1060 expecting = expecting.decode('utf8')
1061 while len(data) != len(expecting):
1062 part = fo.read(size)
1063 if not part:
1064 break
1065 data += part
1066 self.assertEquals(data, expecting)
1067
1068 def test_default(self):
1069 self._test_readline()
1070 self._test_readline(size=100)
1071 self._test_read()
1072 self._test_read(size=100)
1073
1074 def test_with_1k_buffer(self):
1075 self._test_readline(buffering=1024)
1076 self._test_readline(size=100, buffering=1024)
1077 self._test_read(buffering=1024)
1078 self._test_read(size=100, buffering=1024)
1079
1080 def _test_readline_no_buffer(self, size=-1):
1081 mock_sock = self.MockSocket(recv_funcs=[
1082 lambda : b"a",
1083 lambda : b"\n",
1084 lambda : b"B",
1085 self._raise_eintr,
1086 lambda : b"b",
1087 lambda : b"",
1088 ])
1089 fo = mock_sock._textiowrap_for_test(buffering=0)
1090 self.assertEquals(fo.readline(size), b"a\n")
1091 self.assertEquals(fo.readline(size), b"Bb")
1092
1093 def test_no_buffer(self):
1094 self._test_readline_no_buffer()
1095 self._test_readline_no_buffer(size=4)
1096 self._test_read(buffering=0)
1097 self._test_read(size=100, buffering=0)
1098
1099
Guido van Rossume9f66142002-08-07 15:46:19 +00001100class UnbufferedFileObjectClassTestCase(FileObjectClassTestCase):
1101
1102 """Repeat the tests from FileObjectClassTestCase with bufsize==0.
Tim Peters469cdad2002-08-08 20:19:19 +00001103
Guido van Rossume9f66142002-08-07 15:46:19 +00001104 In this case (and in this case only), it should be possible to
1105 create a file object, read a line from it, create another file
1106 object, read another line from it, without loss of data in the
Georg Brandl24420152008-05-26 16:32:26 +00001107 first file object's buffer. Note that http.client relies on this
Guido van Rossume9f66142002-08-07 15:46:19 +00001108 when reading multiple requests from the same socket."""
1109
1110 bufsize = 0 # Use unbuffered mode
1111
1112 def testUnbufferedReadline(self):
Guido van Rossum8c943832002-08-08 01:00:28 +00001113 # Read a line, create a new file object, read another line with it
Guido van Rossume9f66142002-08-07 15:46:19 +00001114 line = self.serv_file.readline() # first line
Guido van Rossum7d0a8262007-05-21 23:13:11 +00001115 self.assertEqual(line, b"A. " + MSG) # first line
Guido van Rossume9f66142002-08-07 15:46:19 +00001116 self.serv_file = self.cli_conn.makefile('rb', 0)
1117 line = self.serv_file.readline() # second line
Guido van Rossum7d0a8262007-05-21 23:13:11 +00001118 self.assertEqual(line, b"B. " + MSG) # second line
Guido van Rossume9f66142002-08-07 15:46:19 +00001119
1120 def _testUnbufferedReadline(self):
Guido van Rossum7d0a8262007-05-21 23:13:11 +00001121 self.cli_file.write(b"A. " + MSG)
1122 self.cli_file.write(b"B. " + MSG)
Guido van Rossume9f66142002-08-07 15:46:19 +00001123 self.cli_file.flush()
1124
Gregory P. Smithde3369f2009-01-12 04:50:11 +00001125 def testMakefileClose(self):
1126 # The file returned by makefile should keep the socket open...
1127 self.cli_conn.close()
1128 msg = self.cli_conn.recv(1024)
1129 self.assertEqual(msg, MSG)
1130 # ...until the file is itself closed
1131 self.serv_file.close()
1132 self.assertRaises(socket.error, self.cli_conn.recv, 1024)
1133
1134 def _testMakefileClose(self):
1135 self.cli_file.write(MSG)
1136 self.cli_file.flush()
1137
1138 def testMakefileCloseSocketDestroy(self):
1139 refcount_before = sys.getrefcount(self.cli_conn)
1140 self.serv_file.close()
1141 refcount_after = sys.getrefcount(self.cli_conn)
1142 self.assertEqual(refcount_before - 1, refcount_after)
1143
1144 def _testMakefileCloseSocketDestroy(self):
1145 pass
1146
1147
Guido van Rossum8c943832002-08-08 01:00:28 +00001148class LineBufferedFileObjectClassTestCase(FileObjectClassTestCase):
1149
1150 bufsize = 1 # Default-buffered for reading; line-buffered for writing
1151
1152
1153class SmallBufferedFileObjectClassTestCase(FileObjectClassTestCase):
1154
1155 bufsize = 2 # Exercise the buffering code
Guido van Rossume9f66142002-08-07 15:46:19 +00001156
Thomas Woutersb2137042007-02-01 18:02:27 +00001157
Guido van Rossumd8faa362007-04-27 19:54:29 +00001158class NetworkConnectionTest(object):
1159 """Prove network connection."""
Guido van Rossum7d0a8262007-05-21 23:13:11 +00001160
Guido van Rossumd8faa362007-04-27 19:54:29 +00001161 def clientSetUp(self):
Christian Heimes5e696852008-04-09 08:37:03 +00001162 # We're inherited below by BasicTCPTest2, which also inherits
1163 # BasicTCPTest, which defines self.port referenced below.
1164 self.cli = socket.create_connection((HOST, self.port))
Guido van Rossumd8faa362007-04-27 19:54:29 +00001165 self.serv_conn = self.cli
1166
1167class BasicTCPTest2(NetworkConnectionTest, BasicTCPTest):
1168 """Tests that NetworkConnection does not break existing TCP functionality.
1169 """
1170
1171class NetworkConnectionNoServer(unittest.TestCase):
Guido van Rossum7d0a8262007-05-21 23:13:11 +00001172
Guido van Rossumd8faa362007-04-27 19:54:29 +00001173 def testWithoutServer(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001174 port = support.find_unused_port()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001175 self.assertRaises(
Christian Heimes5e696852008-04-09 08:37:03 +00001176 socket.error,
1177 lambda: socket.create_connection((HOST, port))
1178 )
Guido van Rossumd8faa362007-04-27 19:54:29 +00001179
Victor Stinner45df8202010-04-28 22:31:17 +00001180@unittest.skipUnless(thread, 'Threading required for this test.')
Guido van Rossumd8faa362007-04-27 19:54:29 +00001181class NetworkConnectionAttributesTest(SocketTCPTest, ThreadableTest):
1182
1183 def __init__(self, methodName='runTest'):
1184 SocketTCPTest.__init__(self, methodName=methodName)
1185 ThreadableTest.__init__(self)
1186
1187 def clientSetUp(self):
Gregory P. Smithb4066372010-01-03 03:28:29 +00001188 self.source_port = support.find_unused_port()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001189
1190 def clientTearDown(self):
1191 self.cli.close()
1192 self.cli = None
1193 ThreadableTest.clientTearDown(self)
1194
1195 def _justAccept(self):
1196 conn, addr = self.serv.accept()
1197
1198 testFamily = _justAccept
1199 def _testFamily(self):
Christian Heimes5e696852008-04-09 08:37:03 +00001200 self.cli = socket.create_connection((HOST, self.port), timeout=30)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001201 self.assertEqual(self.cli.family, 2)
1202
Gregory P. Smitha81d8812010-01-03 15:09:32 +00001203 testSourceAddress = _justAccept
1204 def _testSourceAddress(self):
Gregory P. Smithb4066372010-01-03 03:28:29 +00001205 self.cli = socket.create_connection((HOST, self.port), timeout=30,
1206 source_address=('', self.source_port))
1207 self.assertEqual(self.cli.getsockname()[1], self.source_port)
Gregory P. Smitha81d8812010-01-03 15:09:32 +00001208 # The port number being used is sufficient to show that the bind()
1209 # call happened.
Gregory P. Smithb4066372010-01-03 03:28:29 +00001210
Guido van Rossumd8faa362007-04-27 19:54:29 +00001211 testTimeoutDefault = _justAccept
1212 def _testTimeoutDefault(self):
Georg Brandlf78e02b2008-06-10 17:40:04 +00001213 # passing no explicit timeout uses socket's global default
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001214 self.assertTrue(socket.getdefaulttimeout() is None)
Georg Brandlf78e02b2008-06-10 17:40:04 +00001215 socket.setdefaulttimeout(42)
1216 try:
1217 self.cli = socket.create_connection((HOST, self.port))
1218 finally:
1219 socket.setdefaulttimeout(None)
1220 self.assertEquals(self.cli.gettimeout(), 42)
1221
1222 testTimeoutNone = _justAccept
1223 def _testTimeoutNone(self):
1224 # None timeout means the same as sock.settimeout(None)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001225 self.assertTrue(socket.getdefaulttimeout() is None)
Georg Brandlf78e02b2008-06-10 17:40:04 +00001226 socket.setdefaulttimeout(30)
1227 try:
1228 self.cli = socket.create_connection((HOST, self.port), timeout=None)
1229 finally:
1230 socket.setdefaulttimeout(None)
1231 self.assertEqual(self.cli.gettimeout(), None)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001232
1233 testTimeoutValueNamed = _justAccept
1234 def _testTimeoutValueNamed(self):
Christian Heimes5e696852008-04-09 08:37:03 +00001235 self.cli = socket.create_connection((HOST, self.port), timeout=30)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001236 self.assertEqual(self.cli.gettimeout(), 30)
1237
1238 testTimeoutValueNonamed = _justAccept
1239 def _testTimeoutValueNonamed(self):
Christian Heimes5e696852008-04-09 08:37:03 +00001240 self.cli = socket.create_connection((HOST, self.port), 30)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001241 self.assertEqual(self.cli.gettimeout(), 30)
1242
Victor Stinner45df8202010-04-28 22:31:17 +00001243@unittest.skipUnless(thread, 'Threading required for this test.')
Guido van Rossumd8faa362007-04-27 19:54:29 +00001244class NetworkConnectionBehaviourTest(SocketTCPTest, ThreadableTest):
1245
1246 def __init__(self, methodName='runTest'):
1247 SocketTCPTest.__init__(self, methodName=methodName)
1248 ThreadableTest.__init__(self)
1249
1250 def clientSetUp(self):
1251 pass
1252
1253 def clientTearDown(self):
1254 self.cli.close()
1255 self.cli = None
1256 ThreadableTest.clientTearDown(self)
1257
1258 def testInsideTimeout(self):
1259 conn, addr = self.serv.accept()
1260 time.sleep(3)
Guido van Rossum7d0a8262007-05-21 23:13:11 +00001261 conn.send(b"done!")
Guido van Rossumd8faa362007-04-27 19:54:29 +00001262 testOutsideTimeout = testInsideTimeout
1263
1264 def _testInsideTimeout(self):
Christian Heimes5e696852008-04-09 08:37:03 +00001265 self.cli = sock = socket.create_connection((HOST, self.port))
Guido van Rossumd8faa362007-04-27 19:54:29 +00001266 data = sock.recv(5)
Guido van Rossum7d0a8262007-05-21 23:13:11 +00001267 self.assertEqual(data, b"done!")
Guido van Rossumd8faa362007-04-27 19:54:29 +00001268
1269 def _testOutsideTimeout(self):
Christian Heimes5e696852008-04-09 08:37:03 +00001270 self.cli = sock = socket.create_connection((HOST, self.port), timeout=1)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001271 self.assertRaises(socket.timeout, lambda: sock.recv(5))
Guido van Rossumd8faa362007-04-27 19:54:29 +00001272
1273
Raymond Hettinger11a35f52003-06-29 04:40:22 +00001274class TCPTimeoutTest(SocketTCPTest):
1275
1276 def testTCPTimeout(self):
1277 def raise_timeout(*args, **kwargs):
1278 self.serv.settimeout(1.0)
1279 self.serv.accept()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001280 self.assertRaises(socket.timeout, raise_timeout,
Raymond Hettinger11a35f52003-06-29 04:40:22 +00001281 "Error generating a timeout exception (TCP)")
1282
1283 def testTimeoutZero(self):
1284 ok = False
1285 try:
1286 self.serv.settimeout(0.0)
1287 foo = self.serv.accept()
1288 except socket.timeout:
1289 self.fail("caught timeout instead of error (TCP)")
1290 except socket.error:
1291 ok = True
1292 except:
1293 self.fail("caught unexpected exception (TCP)")
1294 if not ok:
1295 self.fail("accept() returned success when we did not expect it")
1296
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001297 def testInterruptedTimeout(self):
1298 # XXX I don't know how to do this test on MSWindows or any other
1299 # plaform that doesn't support signal.alarm() or os.kill(), though
1300 # the bug should have existed on all platforms.
1301 if not hasattr(signal, "alarm"):
1302 return # can only test on *nix
1303 self.serv.settimeout(5.0) # must be longer than alarm
1304 class Alarm(Exception):
1305 pass
1306 def alarm_handler(signal, frame):
1307 raise Alarm
1308 old_alarm = signal.signal(signal.SIGALRM, alarm_handler)
1309 try:
1310 signal.alarm(2) # POSIX allows alarm to be up to 1 second early
1311 try:
1312 foo = self.serv.accept()
1313 except socket.timeout:
1314 self.fail("caught timeout instead of Alarm")
1315 except Alarm:
1316 pass
1317 except:
Christian Heimesbbe741d2008-03-28 10:53:29 +00001318 self.fail("caught other exception instead of Alarm:"
1319 " %s(%s):\n%s" %
1320 (sys.exc_info()[:2] + (traceback.format_exc(),)))
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001321 else:
1322 self.fail("nothing caught")
Christian Heimesbbe741d2008-03-28 10:53:29 +00001323 finally:
1324 signal.alarm(0) # shut off alarm
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001325 except Alarm:
1326 self.fail("got Alarm in wrong place")
1327 finally:
1328 # no alarm can be pending. Safe to restore old handler.
1329 signal.signal(signal.SIGALRM, old_alarm)
1330
Raymond Hettinger11a35f52003-06-29 04:40:22 +00001331class UDPTimeoutTest(SocketTCPTest):
1332
1333 def testUDPTimeout(self):
1334 def raise_timeout(*args, **kwargs):
1335 self.serv.settimeout(1.0)
1336 self.serv.recv(1024)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001337 self.assertRaises(socket.timeout, raise_timeout,
Raymond Hettinger11a35f52003-06-29 04:40:22 +00001338 "Error generating a timeout exception (UDP)")
1339
1340 def testTimeoutZero(self):
1341 ok = False
1342 try:
1343 self.serv.settimeout(0.0)
1344 foo = self.serv.recv(1024)
1345 except socket.timeout:
1346 self.fail("caught timeout instead of error (UDP)")
1347 except socket.error:
1348 ok = True
1349 except:
1350 self.fail("caught unexpected exception (UDP)")
1351 if not ok:
1352 self.fail("recv() returned success when we did not expect it")
1353
1354class TestExceptions(unittest.TestCase):
1355
1356 def testExceptionTree(self):
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001357 self.assertTrue(issubclass(socket.error, Exception))
1358 self.assertTrue(issubclass(socket.herror, socket.error))
1359 self.assertTrue(issubclass(socket.gaierror, socket.error))
1360 self.assertTrue(issubclass(socket.timeout, socket.error))
Raymond Hettinger11a35f52003-06-29 04:40:22 +00001361
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001362class TestLinuxAbstractNamespace(unittest.TestCase):
1363
1364 UNIX_PATH_MAX = 108
1365
1366 def testLinuxAbstractNamespace(self):
Guido van Rossum32c4ac02007-08-15 03:56:40 +00001367 address = b"\x00python-test-hello\x00\xff"
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001368 s1 = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
1369 s1.bind(address)
1370 s1.listen(1)
1371 s2 = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
1372 s2.connect(s1.getsockname())
1373 s1.accept()
1374 self.assertEqual(s1.getsockname(), address)
1375 self.assertEqual(s2.getpeername(), address)
1376
1377 def testMaxName(self):
Guido van Rossum32c4ac02007-08-15 03:56:40 +00001378 address = b"\x00" + b"h" * (self.UNIX_PATH_MAX - 1)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001379 s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
1380 s.bind(address)
1381 self.assertEqual(s.getsockname(), address)
1382
1383 def testNameOverflow(self):
1384 address = "\x00" + "h" * self.UNIX_PATH_MAX
1385 s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
1386 self.assertRaises(socket.error, s.bind, address)
1387
Raymond Hettinger11a35f52003-06-29 04:40:22 +00001388
Victor Stinner45df8202010-04-28 22:31:17 +00001389@unittest.skipUnless(thread, 'Threading required for this test.')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001390class BufferIOTest(SocketConnectedTest):
1391 """
1392 Test the buffer versions of socket.recv() and socket.send().
1393 """
1394 def __init__(self, methodName='runTest'):
1395 SocketConnectedTest.__init__(self, methodName=methodName)
1396
Antoine Pitrou25480782010-03-17 22:50:28 +00001397 def testRecvIntoArray(self):
Antoine Pitrou2f89aa62008-08-02 21:02:48 +00001398 buf = bytearray(1024)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001399 nbytes = self.cli_conn.recv_into(buf)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001400 self.assertEqual(nbytes, len(MSG))
Guido van Rossum7d0a8262007-05-21 23:13:11 +00001401 msg = buf[:len(MSG)]
Thomas Wouters477c8d52006-05-27 19:21:47 +00001402 self.assertEqual(msg, MSG)
1403
Antoine Pitrou25480782010-03-17 22:50:28 +00001404 def _testRecvIntoArray(self):
Guido van Rossumb5b22702007-05-18 18:55:53 +00001405 buf = bytes(MSG)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001406 self.serv_conn.send(buf)
1407
Antoine Pitrou25480782010-03-17 22:50:28 +00001408 def testRecvIntoBytearray(self):
1409 buf = bytearray(1024)
1410 nbytes = self.cli_conn.recv_into(buf)
1411 self.assertEqual(nbytes, len(MSG))
1412 msg = buf[:len(MSG)]
1413 self.assertEqual(msg, MSG)
1414
1415 _testRecvIntoBytearray = _testRecvIntoArray
1416
1417 def testRecvIntoMemoryview(self):
1418 buf = bytearray(1024)
1419 nbytes = self.cli_conn.recv_into(memoryview(buf))
1420 self.assertEqual(nbytes, len(MSG))
1421 msg = buf[:len(MSG)]
1422 self.assertEqual(msg, MSG)
1423
1424 _testRecvIntoMemoryview = _testRecvIntoArray
1425
1426 def testRecvFromIntoArray(self):
Antoine Pitrou2f89aa62008-08-02 21:02:48 +00001427 buf = bytearray(1024)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001428 nbytes, addr = self.cli_conn.recvfrom_into(buf)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001429 self.assertEqual(nbytes, len(MSG))
Guido van Rossum7d0a8262007-05-21 23:13:11 +00001430 msg = buf[:len(MSG)]
Thomas Wouters477c8d52006-05-27 19:21:47 +00001431 self.assertEqual(msg, MSG)
1432
Antoine Pitrou25480782010-03-17 22:50:28 +00001433 def _testRecvFromIntoArray(self):
Guido van Rossumb5b22702007-05-18 18:55:53 +00001434 buf = bytes(MSG)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001435 self.serv_conn.send(buf)
1436
Antoine Pitrou25480782010-03-17 22:50:28 +00001437 def testRecvFromIntoBytearray(self):
1438 buf = bytearray(1024)
1439 nbytes, addr = self.cli_conn.recvfrom_into(buf)
1440 self.assertEqual(nbytes, len(MSG))
1441 msg = buf[:len(MSG)]
1442 self.assertEqual(msg, MSG)
1443
1444 _testRecvFromIntoBytearray = _testRecvFromIntoArray
1445
1446 def testRecvFromIntoMemoryview(self):
1447 buf = bytearray(1024)
1448 nbytes, addr = self.cli_conn.recvfrom_into(memoryview(buf))
1449 self.assertEqual(nbytes, len(MSG))
1450 msg = buf[:len(MSG)]
1451 self.assertEqual(msg, MSG)
1452
1453 _testRecvFromIntoMemoryview = _testRecvFromIntoArray
1454
Christian Heimes043d6f62008-01-07 17:19:16 +00001455
1456TIPC_STYPE = 2000
1457TIPC_LOWER = 200
1458TIPC_UPPER = 210
1459
1460def isTipcAvailable():
1461 """Check if the TIPC module is loaded
1462
1463 The TIPC module is not loaded automatically on Ubuntu and probably
1464 other Linux distros.
1465 """
1466 if not hasattr(socket, "AF_TIPC"):
1467 return False
1468 if not os.path.isfile("/proc/modules"):
1469 return False
1470 with open("/proc/modules") as f:
1471 for line in f:
1472 if line.startswith("tipc "):
1473 return True
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001474 if support.verbose:
Christian Heimes043d6f62008-01-07 17:19:16 +00001475 print("TIPC module is not loaded, please 'sudo modprobe tipc'")
1476 return False
1477
1478class TIPCTest (unittest.TestCase):
1479 def testRDM(self):
1480 srv = socket.socket(socket.AF_TIPC, socket.SOCK_RDM)
1481 cli = socket.socket(socket.AF_TIPC, socket.SOCK_RDM)
1482
1483 srv.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
1484 srvaddr = (socket.TIPC_ADDR_NAMESEQ, TIPC_STYPE,
1485 TIPC_LOWER, TIPC_UPPER)
1486 srv.bind(srvaddr)
1487
1488 sendaddr = (socket.TIPC_ADDR_NAME, TIPC_STYPE,
1489 TIPC_LOWER + int((TIPC_UPPER - TIPC_LOWER) / 2), 0)
1490 cli.sendto(MSG, sendaddr)
1491
1492 msg, recvaddr = srv.recvfrom(1024)
1493
1494 self.assertEqual(cli.getsockname(), recvaddr)
1495 self.assertEqual(msg, MSG)
1496
1497
1498class TIPCThreadableTest (unittest.TestCase, ThreadableTest):
1499 def __init__(self, methodName = 'runTest'):
1500 unittest.TestCase.__init__(self, methodName = methodName)
1501 ThreadableTest.__init__(self)
1502
1503 def setUp(self):
1504 self.srv = socket.socket(socket.AF_TIPC, socket.SOCK_STREAM)
1505 self.srv.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
1506 srvaddr = (socket.TIPC_ADDR_NAMESEQ, TIPC_STYPE,
1507 TIPC_LOWER, TIPC_UPPER)
1508 self.srv.bind(srvaddr)
1509 self.srv.listen(5)
1510 self.serverExplicitReady()
1511 self.conn, self.connaddr = self.srv.accept()
1512
1513 def clientSetUp(self):
1514 # The is a hittable race between serverExplicitReady() and the
1515 # accept() call; sleep a little while to avoid it, otherwise
1516 # we could get an exception
1517 time.sleep(0.1)
1518 self.cli = socket.socket(socket.AF_TIPC, socket.SOCK_STREAM)
1519 addr = (socket.TIPC_ADDR_NAME, TIPC_STYPE,
1520 TIPC_LOWER + int((TIPC_UPPER - TIPC_LOWER) / 2), 0)
1521 self.cli.connect(addr)
1522 self.cliaddr = self.cli.getsockname()
1523
1524 def testStream(self):
1525 msg = self.conn.recv(1024)
1526 self.assertEqual(msg, MSG)
1527 self.assertEqual(self.cliaddr, self.connaddr)
1528
1529 def _testStream(self):
1530 self.cli.send(MSG)
1531 self.cli.close()
1532
1533
Guido van Rossumb995eb72002-07-31 16:08:40 +00001534def test_main():
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001535 tests = [GeneralModuleTests, BasicTCPTest, TCPCloserTest, TCPTimeoutTest,
Ronald Oussoren94f25282010-05-05 19:11:21 +00001536 TestExceptions, BufferIOTest, BasicTCPTest2, BasicUDPTest, UDPTimeoutTest ]
Walter Dörwald21d3a322003-05-01 17:45:56 +00001537
1538 tests.extend([
1539 NonBlockingTCPTests,
1540 FileObjectClassTestCase,
Gregory P. Smithaafdca82010-01-04 04:50:36 +00001541 FileObjectInterruptedTestCase,
Walter Dörwald21d3a322003-05-01 17:45:56 +00001542 UnbufferedFileObjectClassTestCase,
1543 LineBufferedFileObjectClassTestCase,
Thomas Woutersb2137042007-02-01 18:02:27 +00001544 SmallBufferedFileObjectClassTestCase,
Guido van Rossumd8faa362007-04-27 19:54:29 +00001545 NetworkConnectionNoServer,
1546 NetworkConnectionAttributesTest,
1547 NetworkConnectionBehaviourTest,
Walter Dörwald21d3a322003-05-01 17:45:56 +00001548 ])
Dave Cole331708b2004-08-09 04:51:41 +00001549 if hasattr(socket, "socketpair"):
1550 tests.append(BasicSocketPairTest)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001551 if sys.platform == 'linux2':
1552 tests.append(TestLinuxAbstractNamespace)
Christian Heimes043d6f62008-01-07 17:19:16 +00001553 if isTipcAvailable():
1554 tests.append(TIPCTest)
Christian Heimes790c8232008-01-07 21:14:23 +00001555 tests.append(TIPCThreadableTest)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001556
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001557 thread_info = support.threading_setup()
1558 support.run_unittest(*tests)
1559 support.threading_cleanup(*thread_info)
Guido van Rossum24e4af82002-06-12 19:18:08 +00001560
1561if __name__ == "__main__":
Guido van Rossumb995eb72002-07-31 16:08:40 +00001562 test_main()