blob: 1a85c0e7ce415094cf9a32829bc5a62b9df85da4 [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
Giampaolo Rodolà677d95c2010-08-16 05:08:11 +0000611 socket.getaddrinfo(HOST, None, 0, 0, socket.SOL_TCP)
Giampaolo Rodolà419f7042010-08-14 16:45:41 +0000612 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)
Giampaolo Rodolàccfb91c2010-08-17 15:30:23 +0000617 # test keyword arguments
618 a = socket.getaddrinfo(HOST, None)
619 b = socket.getaddrinfo(host=HOST, port=None)
620 self.assertEqual(a, b)
621 a = socket.getaddrinfo(HOST, None, socket.AF_INET)
622 b = socket.getaddrinfo(HOST, None, family=socket.AF_INET)
623 self.assertEqual(a, b)
624 a = socket.getaddrinfo(HOST, None, 0, socket.SOCK_STREAM)
625 b = socket.getaddrinfo(HOST, None, type=socket.SOCK_STREAM)
626 self.assertEqual(a, b)
627 a = socket.getaddrinfo(HOST, None, 0, 0, socket.SOL_TCP)
628 b = socket.getaddrinfo(HOST, None, proto=socket.SOL_TCP)
629 self.assertEqual(a, b)
630 a = socket.getaddrinfo(HOST, None, 0, 0, 0, socket.AI_PASSIVE)
631 b = socket.getaddrinfo(HOST, None, flags=socket.AI_PASSIVE)
632 self.assertEqual(a, b)
633 a = socket.getaddrinfo(None, 0, socket.AF_UNSPEC, socket.SOCK_STREAM, 0,
634 socket.AI_PASSIVE)
635 b = socket.getaddrinfo(host=None, port=0, family=socket.AF_UNSPEC,
636 type=socket.SOCK_STREAM, proto=0,
637 flags=socket.AI_PASSIVE)
638 self.assertEqual(a, b)
Giampaolo Rodolà419f7042010-08-14 16:45:41 +0000639
Martin v. Löwisfc0275a2010-08-22 19:33:47 +0000640 def test_idna(self):
641 # these should all be successful
642 socket.gethostbyname('испытание.python.org')
643 socket.gethostbyname_ex('испытание.python.org')
644 socket.getaddrinfo('испытание.python.org',0)
Martin v. Löwis56773cf2010-08-22 19:38:04 +0000645 socket.gethostbyaddr('испытание.python.org')
Christian Heimesfaf2f632008-01-06 16:59:19 +0000646
Victor Stinner45df8202010-04-28 22:31:17 +0000647@unittest.skipUnless(thread, 'Threading required for this test.')
Guido van Rossum24e4af82002-06-12 19:18:08 +0000648class BasicTCPTest(SocketConnectedTest):
649
650 def __init__(self, methodName='runTest'):
651 SocketConnectedTest.__init__(self, methodName=methodName)
652
653 def testRecv(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000654 # Testing large receive over TCP
Guido van Rossum24e4af82002-06-12 19:18:08 +0000655 msg = self.cli_conn.recv(1024)
Guido van Rossum76489682002-06-12 20:38:30 +0000656 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000657
658 def _testRecv(self):
659 self.serv_conn.send(MSG)
660
661 def testOverFlowRecv(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000662 # Testing receive in chunks over TCP
Guido van Rossum24e4af82002-06-12 19:18:08 +0000663 seg1 = self.cli_conn.recv(len(MSG) - 3)
664 seg2 = self.cli_conn.recv(1024)
Guido van Rossumab659962002-06-12 21:29:43 +0000665 msg = seg1 + seg2
Guido van Rossum76489682002-06-12 20:38:30 +0000666 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000667
668 def _testOverFlowRecv(self):
669 self.serv_conn.send(MSG)
670
671 def testRecvFrom(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000672 # Testing large recvfrom() over TCP
Guido van Rossum24e4af82002-06-12 19:18:08 +0000673 msg, addr = self.cli_conn.recvfrom(1024)
Guido van Rossum76489682002-06-12 20:38:30 +0000674 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000675
676 def _testRecvFrom(self):
677 self.serv_conn.send(MSG)
678
679 def testOverFlowRecvFrom(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000680 # Testing recvfrom() in chunks over TCP
Guido van Rossum24e4af82002-06-12 19:18:08 +0000681 seg1, addr = self.cli_conn.recvfrom(len(MSG)-3)
682 seg2, addr = self.cli_conn.recvfrom(1024)
Guido van Rossumab659962002-06-12 21:29:43 +0000683 msg = seg1 + seg2
Guido van Rossum76489682002-06-12 20:38:30 +0000684 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000685
686 def _testOverFlowRecvFrom(self):
687 self.serv_conn.send(MSG)
688
689 def testSendAll(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000690 # Testing sendall() with a 2048 byte string over TCP
Guido van Rossum7d0a8262007-05-21 23:13:11 +0000691 msg = b''
Guido van Rossum24e4af82002-06-12 19:18:08 +0000692 while 1:
693 read = self.cli_conn.recv(1024)
694 if not read:
695 break
Guido van Rossume531e292002-08-08 20:28:34 +0000696 msg += read
Guido van Rossum7d0a8262007-05-21 23:13:11 +0000697 self.assertEqual(msg, b'f' * 2048)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000698
699 def _testSendAll(self):
Guido van Rossum7d0a8262007-05-21 23:13:11 +0000700 big_chunk = b'f' * 2048
Guido van Rossum24e4af82002-06-12 19:18:08 +0000701 self.serv_conn.sendall(big_chunk)
702
703 def testFromFd(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000704 # Testing fromfd()
Guido van Rossum8e95ca82002-06-12 20:55:17 +0000705 if not hasattr(socket, "fromfd"):
Guido van Rossum6fb3d5e2002-06-12 20:48:59 +0000706 return # On Windows, this doesn't exist
Guido van Rossum24e4af82002-06-12 19:18:08 +0000707 fd = self.cli_conn.fileno()
708 sock = socket.fromfd(fd, socket.AF_INET, socket.SOCK_STREAM)
709 msg = sock.recv(1024)
Guido van Rossum76489682002-06-12 20:38:30 +0000710 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000711
712 def _testFromFd(self):
713 self.serv_conn.send(MSG)
714
Guido van Rossum39eb8fa2007-11-16 01:24:05 +0000715 def testDup(self):
716 # Testing dup()
717 sock = self.cli_conn.dup()
718 msg = sock.recv(1024)
719 self.assertEqual(msg, MSG)
720
721 def _testDup(self):
722 self.serv_conn.send(MSG)
723
Guido van Rossum24e4af82002-06-12 19:18:08 +0000724 def testShutdown(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000725 # Testing shutdown()
Guido van Rossum24e4af82002-06-12 19:18:08 +0000726 msg = self.cli_conn.recv(1024)
Guido van Rossum76489682002-06-12 20:38:30 +0000727 self.assertEqual(msg, MSG)
Mark Dickinson29500f62009-01-15 15:36:10 +0000728 # wait for _testShutdown to finish: on OS X, when the server
729 # closes the connection the client also becomes disconnected,
730 # and the client's shutdown call will fail. (Issue #4397.)
731 self.done.wait()
Guido van Rossum24e4af82002-06-12 19:18:08 +0000732
733 def _testShutdown(self):
734 self.serv_conn.send(MSG)
735 self.serv_conn.shutdown(2)
736
Antoine Pitrou6e451df2010-08-09 20:39:54 +0000737 def testDetach(self):
738 # Testing detach()
739 fileno = self.cli_conn.fileno()
740 f = self.cli_conn.detach()
741 self.assertEqual(f, fileno)
742 # cli_conn cannot be used anymore...
Antoine Pitroue43f9d02010-08-08 23:24:50 +0000743 self.assertRaises(socket.error, self.cli_conn.recv, 1024)
744 self.cli_conn.close()
Antoine Pitrou6e451df2010-08-09 20:39:54 +0000745 # ...but we can create another socket using the (still open)
746 # file descriptor
Antoine Pitroue43f9d02010-08-08 23:24:50 +0000747 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM, fileno=f)
748 msg = sock.recv(1024)
749 self.assertEqual(msg, MSG)
750
Antoine Pitrou6e451df2010-08-09 20:39:54 +0000751 def _testDetach(self):
Antoine Pitroue43f9d02010-08-08 23:24:50 +0000752 self.serv_conn.send(MSG)
753
Victor Stinner45df8202010-04-28 22:31:17 +0000754@unittest.skipUnless(thread, 'Threading required for this test.')
Guido van Rossum24e4af82002-06-12 19:18:08 +0000755class BasicUDPTest(ThreadedUDPSocketTest):
756
757 def __init__(self, methodName='runTest'):
758 ThreadedUDPSocketTest.__init__(self, methodName=methodName)
759
760 def testSendtoAndRecv(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000761 # Testing sendto() and Recv() over UDP
Guido van Rossum24e4af82002-06-12 19:18:08 +0000762 msg = self.serv.recv(len(MSG))
Guido van Rossum76489682002-06-12 20:38:30 +0000763 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000764
765 def _testSendtoAndRecv(self):
Christian Heimes5e696852008-04-09 08:37:03 +0000766 self.cli.sendto(MSG, 0, (HOST, self.port))
Guido van Rossum24e4af82002-06-12 19:18:08 +0000767
Guido van Rossum1c938012002-06-12 21:17:20 +0000768 def testRecvFrom(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000769 # Testing recvfrom() over UDP
Guido van Rossum24e4af82002-06-12 19:18:08 +0000770 msg, addr = self.serv.recvfrom(len(MSG))
Guido van Rossum76489682002-06-12 20:38:30 +0000771 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000772
Guido van Rossum1c938012002-06-12 21:17:20 +0000773 def _testRecvFrom(self):
Christian Heimes5e696852008-04-09 08:37:03 +0000774 self.cli.sendto(MSG, 0, (HOST, self.port))
Guido van Rossum24e4af82002-06-12 19:18:08 +0000775
Guido van Rossumd8faa362007-04-27 19:54:29 +0000776 def testRecvFromNegative(self):
777 # Negative lengths passed to recvfrom should give ValueError.
778 self.assertRaises(ValueError, self.serv.recvfrom, -1)
779
780 def _testRecvFromNegative(self):
Christian Heimes5e696852008-04-09 08:37:03 +0000781 self.cli.sendto(MSG, 0, (HOST, self.port))
Guido van Rossumd8faa362007-04-27 19:54:29 +0000782
Victor Stinner45df8202010-04-28 22:31:17 +0000783@unittest.skipUnless(thread, 'Threading required for this test.')
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000784class TCPCloserTest(ThreadedTCPSocketTest):
785
786 def testClose(self):
787 conn, addr = self.serv.accept()
788 conn.close()
789
790 sd = self.cli
791 read, write, err = select.select([sd], [], [], 1.0)
792 self.assertEqual(read, [sd])
Guido van Rossum7d0a8262007-05-21 23:13:11 +0000793 self.assertEqual(sd.recv(1), b'')
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000794
Jeremy Hylton5accbdb2007-08-03 20:40:09 +0000795 # Calling close() many times should be safe.
796 conn.close()
797 conn.close()
798
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000799 def _testClose(self):
Christian Heimes5e696852008-04-09 08:37:03 +0000800 self.cli.connect((HOST, self.port))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000801 time.sleep(1.0)
802
Victor Stinner45df8202010-04-28 22:31:17 +0000803@unittest.skipUnless(thread, 'Threading required for this test.')
Dave Cole331708b2004-08-09 04:51:41 +0000804class BasicSocketPairTest(SocketPairTest):
805
806 def __init__(self, methodName='runTest'):
807 SocketPairTest.__init__(self, methodName=methodName)
808
809 def testRecv(self):
810 msg = self.serv.recv(1024)
811 self.assertEqual(msg, MSG)
812
813 def _testRecv(self):
814 self.cli.send(MSG)
815
816 def testSend(self):
817 self.serv.send(MSG)
818
819 def _testSend(self):
820 msg = self.cli.recv(1024)
821 self.assertEqual(msg, MSG)
822
Victor Stinner45df8202010-04-28 22:31:17 +0000823@unittest.skipUnless(thread, 'Threading required for this test.')
Guido van Rossum24e4af82002-06-12 19:18:08 +0000824class NonBlockingTCPTests(ThreadedTCPSocketTest):
825
826 def __init__(self, methodName='runTest'):
827 ThreadedTCPSocketTest.__init__(self, methodName=methodName)
828
829 def testSetBlocking(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000830 # Testing whether set blocking works
Guido van Rossum24e4af82002-06-12 19:18:08 +0000831 self.serv.setblocking(0)
832 start = time.time()
833 try:
834 self.serv.accept()
835 except socket.error:
836 pass
837 end = time.time()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000838 self.assertTrue((end - start) < 1.0, "Error setting non-blocking mode.")
Guido van Rossum24e4af82002-06-12 19:18:08 +0000839
840 def _testSetBlocking(self):
Barry Warsaw6870bba2001-03-23 17:40:16 +0000841 pass
Barry Warsawcf3d4b51997-01-03 20:03:32 +0000842
Guido van Rossum24e4af82002-06-12 19:18:08 +0000843 def testAccept(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000844 # Testing non-blocking accept
Guido van Rossum24e4af82002-06-12 19:18:08 +0000845 self.serv.setblocking(0)
Guido van Rossum41360a41998-03-26 19:42:58 +0000846 try:
Guido van Rossum24e4af82002-06-12 19:18:08 +0000847 conn, addr = self.serv.accept()
848 except socket.error:
849 pass
850 else:
851 self.fail("Error trying to do non-blocking accept.")
852 read, write, err = select.select([self.serv], [], [])
853 if self.serv in read:
854 conn, addr = self.serv.accept()
855 else:
856 self.fail("Error trying to do accept after select.")
Guido van Rossum67f7a382002-06-06 21:08:16 +0000857
Guido van Rossum24e4af82002-06-12 19:18:08 +0000858 def _testAccept(self):
Guido van Rossumb6cc7d22002-07-19 12:46:46 +0000859 time.sleep(0.1)
Christian Heimes5e696852008-04-09 08:37:03 +0000860 self.cli.connect((HOST, self.port))
Guido van Rossum24e4af82002-06-12 19:18:08 +0000861
862 def testConnect(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000863 # Testing non-blocking connect
Guido van Rossum24e4af82002-06-12 19:18:08 +0000864 conn, addr = self.serv.accept()
865
866 def _testConnect(self):
Guido van Rossum7b8bac12002-06-13 16:07:04 +0000867 self.cli.settimeout(10)
Christian Heimes5e696852008-04-09 08:37:03 +0000868 self.cli.connect((HOST, self.port))
Guido van Rossum24e4af82002-06-12 19:18:08 +0000869
870 def testRecv(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000871 # Testing non-blocking recv
Guido van Rossum24e4af82002-06-12 19:18:08 +0000872 conn, addr = self.serv.accept()
873 conn.setblocking(0)
874 try:
875 msg = conn.recv(len(MSG))
876 except socket.error:
877 pass
878 else:
879 self.fail("Error trying to do non-blocking recv.")
880 read, write, err = select.select([conn], [], [])
881 if conn in read:
882 msg = conn.recv(len(MSG))
Guido van Rossum76489682002-06-12 20:38:30 +0000883 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000884 else:
885 self.fail("Error during select call to non-blocking socket.")
886
887 def _testRecv(self):
Christian Heimes5e696852008-04-09 08:37:03 +0000888 self.cli.connect((HOST, self.port))
Guido van Rossumb6cc7d22002-07-19 12:46:46 +0000889 time.sleep(0.1)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000890 self.cli.send(MSG)
891
Victor Stinner45df8202010-04-28 22:31:17 +0000892@unittest.skipUnless(thread, 'Threading required for this test.')
Guido van Rossum24e4af82002-06-12 19:18:08 +0000893class FileObjectClassTestCase(SocketConnectedTest):
Jeremy Hylton5accbdb2007-08-03 20:40:09 +0000894 """Unit tests for the object returned by socket.makefile()
895
896 self.serv_file is the io object returned by makefile() on
897 the client connection. You can read from this file to
898 get output from the server.
899
900 self.cli_file is the io object returned by makefile() on the
901 server connection. You can write to this file to send output
902 to the client.
903 """
Guido van Rossum24e4af82002-06-12 19:18:08 +0000904
Guido van Rossume9f66142002-08-07 15:46:19 +0000905 bufsize = -1 # Use default buffer size
906
Guido van Rossum24e4af82002-06-12 19:18:08 +0000907 def __init__(self, methodName='runTest'):
908 SocketConnectedTest.__init__(self, methodName=methodName)
909
910 def setUp(self):
911 SocketConnectedTest.setUp(self)
Guido van Rossume9f66142002-08-07 15:46:19 +0000912 self.serv_file = self.cli_conn.makefile('rb', self.bufsize)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000913
914 def tearDown(self):
915 self.serv_file.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000916 self.assertTrue(self.serv_file.closed)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000917 self.serv_file = None
918 SocketConnectedTest.tearDown(self)
919
920 def clientSetUp(self):
921 SocketConnectedTest.clientSetUp(self)
Guido van Rossume9f66142002-08-07 15:46:19 +0000922 self.cli_file = self.serv_conn.makefile('wb')
Guido van Rossum24e4af82002-06-12 19:18:08 +0000923
924 def clientTearDown(self):
925 self.cli_file.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000926 self.assertTrue(self.cli_file.closed)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000927 self.cli_file = None
928 SocketConnectedTest.clientTearDown(self)
929
930 def testSmallRead(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000931 # Performing small file read test
Guido van Rossum24e4af82002-06-12 19:18:08 +0000932 first_seg = self.serv_file.read(len(MSG)-3)
933 second_seg = self.serv_file.read(3)
Guido van Rossumab659962002-06-12 21:29:43 +0000934 msg = first_seg + second_seg
Guido van Rossum76489682002-06-12 20:38:30 +0000935 self.assertEqual(msg, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000936
937 def _testSmallRead(self):
938 self.cli_file.write(MSG)
939 self.cli_file.flush()
940
Guido van Rossum8c943832002-08-08 01:00:28 +0000941 def testFullRead(self):
942 # read until EOF
943 msg = self.serv_file.read()
944 self.assertEqual(msg, MSG)
945
946 def _testFullRead(self):
947 self.cli_file.write(MSG)
948 self.cli_file.close()
949
Guido van Rossum24e4af82002-06-12 19:18:08 +0000950 def testUnbufferedRead(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000951 # Performing unbuffered file read test
Guido van Rossum7d0a8262007-05-21 23:13:11 +0000952 buf = b''
Guido van Rossum24e4af82002-06-12 19:18:08 +0000953 while 1:
954 char = self.serv_file.read(1)
Guido van Rossum8c943832002-08-08 01:00:28 +0000955 if not char:
Guido van Rossum24e4af82002-06-12 19:18:08 +0000956 break
Guido van Rossum8c943832002-08-08 01:00:28 +0000957 buf += char
958 self.assertEqual(buf, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000959
960 def _testUnbufferedRead(self):
961 self.cli_file.write(MSG)
962 self.cli_file.flush()
963
964 def testReadline(self):
Guido van Rossum8c943832002-08-08 01:00:28 +0000965 # Performing file readline test
Guido van Rossum24e4af82002-06-12 19:18:08 +0000966 line = self.serv_file.readline()
Guido van Rossum76489682002-06-12 20:38:30 +0000967 self.assertEqual(line, MSG)
Guido van Rossum24e4af82002-06-12 19:18:08 +0000968
969 def _testReadline(self):
970 self.cli_file.write(MSG)
971 self.cli_file.flush()
972
Jeremy Hylton5accbdb2007-08-03 20:40:09 +0000973 def testCloseAfterMakefile(self):
974 # The file returned by makefile should keep the socket open.
975 self.cli_conn.close()
976 # read until EOF
977 msg = self.serv_file.read()
978 self.assertEqual(msg, MSG)
979
980 def _testCloseAfterMakefile(self):
981 self.cli_file.write(MSG)
982 self.cli_file.flush()
983
984 def testMakefileAfterMakefileClose(self):
985 self.serv_file.close()
986 msg = self.cli_conn.recv(len(MSG))
987 self.assertEqual(msg, MSG)
988
989 def _testMakefileAfterMakefileClose(self):
990 self.cli_file.write(MSG)
991 self.cli_file.flush()
992
Tim Peters116d83c2004-03-28 02:20:45 +0000993 def testClosedAttr(self):
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000994 self.assertTrue(not self.serv_file.closed)
Tim Peters116d83c2004-03-28 02:20:45 +0000995
996 def _testClosedAttr(self):
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000997 self.assertTrue(not self.cli_file.closed)
Tim Peters116d83c2004-03-28 02:20:45 +0000998
Amaury Forgeot d'Arc9d24ff02008-11-20 23:15:52 +0000999 def testAttributes(self):
Benjamin Peterson44309e62008-11-22 00:41:45 +00001000 self.assertEqual(self.serv_file.mode, 'rb')
Amaury Forgeot d'Arc9d24ff02008-11-20 23:15:52 +00001001 self.assertEqual(self.serv_file.name, self.cli_conn.fileno())
1002
1003 def _testAttributes(self):
Benjamin Peterson44309e62008-11-22 00:41:45 +00001004 self.assertEqual(self.cli_file.mode, 'wb')
Amaury Forgeot d'Arc9d24ff02008-11-20 23:15:52 +00001005 self.assertEqual(self.cli_file.name, self.serv_conn.fileno())
1006
Gregory P. Smithde3369f2009-01-12 04:50:11 +00001007 def testRealClose(self):
1008 self.serv_file.close()
1009 self.assertRaises(ValueError, self.serv_file.fileno)
1010 self.cli_conn.close()
1011 self.assertRaises(socket.error, self.cli_conn.getsockname)
1012
1013 def _testRealClose(self):
1014 pass
1015
1016
Gregory P. Smithaafdca82010-01-04 04:50:36 +00001017class FileObjectInterruptedTestCase(unittest.TestCase):
1018 """Test that the file object correctly handles EINTR internally."""
1019
1020 class MockSocket(object):
1021 def __init__(self, recv_funcs=()):
1022 # A generator that returns callables that we'll call for each
1023 # call to recv().
1024 self._recv_step = iter(recv_funcs)
1025
1026 def recv_into(self, buffer):
1027 data = next(self._recv_step)()
1028 assert len(buffer) >= len(data)
1029 buffer[:len(data)] = data
1030 return len(data)
1031
1032 def _decref_socketios(self):
1033 pass
1034
1035 def _textiowrap_for_test(self, buffering=-1):
1036 raw = socket.SocketIO(self, "r")
1037 if buffering < 0:
1038 buffering = io.DEFAULT_BUFFER_SIZE
1039 if buffering == 0:
1040 return raw
1041 buffer = io.BufferedReader(raw, buffering)
1042 text = io.TextIOWrapper(buffer, None, None)
1043 text.mode = "rb"
1044 return text
1045
1046 @staticmethod
1047 def _raise_eintr():
1048 raise socket.error(errno.EINTR)
1049
1050 def _textiowrap_mock_socket(self, mock, buffering=-1):
1051 raw = socket.SocketIO(mock, "r")
1052 if buffering < 0:
1053 buffering = io.DEFAULT_BUFFER_SIZE
1054 if buffering == 0:
1055 return raw
1056 buffer = io.BufferedReader(raw, buffering)
1057 text = io.TextIOWrapper(buffer, None, None)
1058 text.mode = "rb"
1059 return text
1060
1061 def _test_readline(self, size=-1, buffering=-1):
1062 mock_sock = self.MockSocket(recv_funcs=[
1063 lambda : b"This is the first line\nAnd the sec",
1064 self._raise_eintr,
1065 lambda : b"ond line is here\n",
1066 lambda : b"",
1067 lambda : b"", # XXX(gps): io library does an extra EOF read
1068 ])
1069 fo = mock_sock._textiowrap_for_test(buffering=buffering)
1070 self.assertEquals(fo.readline(size), "This is the first line\n")
1071 self.assertEquals(fo.readline(size), "And the second line is here\n")
1072
1073 def _test_read(self, size=-1, buffering=-1):
1074 mock_sock = self.MockSocket(recv_funcs=[
1075 lambda : b"This is the first line\nAnd the sec",
1076 self._raise_eintr,
1077 lambda : b"ond line is here\n",
1078 lambda : b"",
1079 lambda : b"", # XXX(gps): io library does an extra EOF read
1080 ])
1081 expecting = (b"This is the first line\n"
1082 b"And the second line is here\n")
1083 fo = mock_sock._textiowrap_for_test(buffering=buffering)
1084 if buffering == 0:
1085 data = b''
1086 else:
1087 data = ''
1088 expecting = expecting.decode('utf8')
1089 while len(data) != len(expecting):
1090 part = fo.read(size)
1091 if not part:
1092 break
1093 data += part
1094 self.assertEquals(data, expecting)
1095
1096 def test_default(self):
1097 self._test_readline()
1098 self._test_readline(size=100)
1099 self._test_read()
1100 self._test_read(size=100)
1101
1102 def test_with_1k_buffer(self):
1103 self._test_readline(buffering=1024)
1104 self._test_readline(size=100, buffering=1024)
1105 self._test_read(buffering=1024)
1106 self._test_read(size=100, buffering=1024)
1107
1108 def _test_readline_no_buffer(self, size=-1):
1109 mock_sock = self.MockSocket(recv_funcs=[
1110 lambda : b"a",
1111 lambda : b"\n",
1112 lambda : b"B",
1113 self._raise_eintr,
1114 lambda : b"b",
1115 lambda : b"",
1116 ])
1117 fo = mock_sock._textiowrap_for_test(buffering=0)
1118 self.assertEquals(fo.readline(size), b"a\n")
1119 self.assertEquals(fo.readline(size), b"Bb")
1120
1121 def test_no_buffer(self):
1122 self._test_readline_no_buffer()
1123 self._test_readline_no_buffer(size=4)
1124 self._test_read(buffering=0)
1125 self._test_read(size=100, buffering=0)
1126
1127
Guido van Rossume9f66142002-08-07 15:46:19 +00001128class UnbufferedFileObjectClassTestCase(FileObjectClassTestCase):
1129
1130 """Repeat the tests from FileObjectClassTestCase with bufsize==0.
Tim Peters469cdad2002-08-08 20:19:19 +00001131
Guido van Rossume9f66142002-08-07 15:46:19 +00001132 In this case (and in this case only), it should be possible to
1133 create a file object, read a line from it, create another file
1134 object, read another line from it, without loss of data in the
Georg Brandl24420152008-05-26 16:32:26 +00001135 first file object's buffer. Note that http.client relies on this
Guido van Rossume9f66142002-08-07 15:46:19 +00001136 when reading multiple requests from the same socket."""
1137
1138 bufsize = 0 # Use unbuffered mode
1139
1140 def testUnbufferedReadline(self):
Guido van Rossum8c943832002-08-08 01:00:28 +00001141 # Read a line, create a new file object, read another line with it
Guido van Rossume9f66142002-08-07 15:46:19 +00001142 line = self.serv_file.readline() # first line
Guido van Rossum7d0a8262007-05-21 23:13:11 +00001143 self.assertEqual(line, b"A. " + MSG) # first line
Guido van Rossume9f66142002-08-07 15:46:19 +00001144 self.serv_file = self.cli_conn.makefile('rb', 0)
1145 line = self.serv_file.readline() # second line
Guido van Rossum7d0a8262007-05-21 23:13:11 +00001146 self.assertEqual(line, b"B. " + MSG) # second line
Guido van Rossume9f66142002-08-07 15:46:19 +00001147
1148 def _testUnbufferedReadline(self):
Guido van Rossum7d0a8262007-05-21 23:13:11 +00001149 self.cli_file.write(b"A. " + MSG)
1150 self.cli_file.write(b"B. " + MSG)
Guido van Rossume9f66142002-08-07 15:46:19 +00001151 self.cli_file.flush()
1152
Gregory P. Smithde3369f2009-01-12 04:50:11 +00001153 def testMakefileClose(self):
1154 # The file returned by makefile should keep the socket open...
1155 self.cli_conn.close()
1156 msg = self.cli_conn.recv(1024)
1157 self.assertEqual(msg, MSG)
1158 # ...until the file is itself closed
1159 self.serv_file.close()
1160 self.assertRaises(socket.error, self.cli_conn.recv, 1024)
1161
1162 def _testMakefileClose(self):
1163 self.cli_file.write(MSG)
1164 self.cli_file.flush()
1165
1166 def testMakefileCloseSocketDestroy(self):
1167 refcount_before = sys.getrefcount(self.cli_conn)
1168 self.serv_file.close()
1169 refcount_after = sys.getrefcount(self.cli_conn)
1170 self.assertEqual(refcount_before - 1, refcount_after)
1171
1172 def _testMakefileCloseSocketDestroy(self):
1173 pass
1174
1175
Guido van Rossum8c943832002-08-08 01:00:28 +00001176class LineBufferedFileObjectClassTestCase(FileObjectClassTestCase):
1177
1178 bufsize = 1 # Default-buffered for reading; line-buffered for writing
1179
1180
1181class SmallBufferedFileObjectClassTestCase(FileObjectClassTestCase):
1182
1183 bufsize = 2 # Exercise the buffering code
Guido van Rossume9f66142002-08-07 15:46:19 +00001184
Thomas Woutersb2137042007-02-01 18:02:27 +00001185
Guido van Rossumd8faa362007-04-27 19:54:29 +00001186class NetworkConnectionTest(object):
1187 """Prove network connection."""
Guido van Rossum7d0a8262007-05-21 23:13:11 +00001188
Guido van Rossumd8faa362007-04-27 19:54:29 +00001189 def clientSetUp(self):
Christian Heimes5e696852008-04-09 08:37:03 +00001190 # We're inherited below by BasicTCPTest2, which also inherits
1191 # BasicTCPTest, which defines self.port referenced below.
1192 self.cli = socket.create_connection((HOST, self.port))
Guido van Rossumd8faa362007-04-27 19:54:29 +00001193 self.serv_conn = self.cli
1194
1195class BasicTCPTest2(NetworkConnectionTest, BasicTCPTest):
1196 """Tests that NetworkConnection does not break existing TCP functionality.
1197 """
1198
1199class NetworkConnectionNoServer(unittest.TestCase):
Guido van Rossum7d0a8262007-05-21 23:13:11 +00001200
Guido van Rossumd8faa362007-04-27 19:54:29 +00001201 def testWithoutServer(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001202 port = support.find_unused_port()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001203 self.assertRaises(
Christian Heimes5e696852008-04-09 08:37:03 +00001204 socket.error,
1205 lambda: socket.create_connection((HOST, port))
1206 )
Guido van Rossumd8faa362007-04-27 19:54:29 +00001207
Victor Stinner45df8202010-04-28 22:31:17 +00001208@unittest.skipUnless(thread, 'Threading required for this test.')
Guido van Rossumd8faa362007-04-27 19:54:29 +00001209class NetworkConnectionAttributesTest(SocketTCPTest, ThreadableTest):
1210
1211 def __init__(self, methodName='runTest'):
1212 SocketTCPTest.__init__(self, methodName=methodName)
1213 ThreadableTest.__init__(self)
1214
1215 def clientSetUp(self):
Gregory P. Smithb4066372010-01-03 03:28:29 +00001216 self.source_port = support.find_unused_port()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001217
1218 def clientTearDown(self):
1219 self.cli.close()
1220 self.cli = None
1221 ThreadableTest.clientTearDown(self)
1222
1223 def _justAccept(self):
1224 conn, addr = self.serv.accept()
1225
1226 testFamily = _justAccept
1227 def _testFamily(self):
Christian Heimes5e696852008-04-09 08:37:03 +00001228 self.cli = socket.create_connection((HOST, self.port), timeout=30)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001229 self.assertEqual(self.cli.family, 2)
1230
Gregory P. Smitha81d8812010-01-03 15:09:32 +00001231 testSourceAddress = _justAccept
1232 def _testSourceAddress(self):
Gregory P. Smithb4066372010-01-03 03:28:29 +00001233 self.cli = socket.create_connection((HOST, self.port), timeout=30,
1234 source_address=('', self.source_port))
1235 self.assertEqual(self.cli.getsockname()[1], self.source_port)
Gregory P. Smitha81d8812010-01-03 15:09:32 +00001236 # The port number being used is sufficient to show that the bind()
1237 # call happened.
Gregory P. Smithb4066372010-01-03 03:28:29 +00001238
Guido van Rossumd8faa362007-04-27 19:54:29 +00001239 testTimeoutDefault = _justAccept
1240 def _testTimeoutDefault(self):
Georg Brandlf78e02b2008-06-10 17:40:04 +00001241 # passing no explicit timeout uses socket's global default
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001242 self.assertTrue(socket.getdefaulttimeout() is None)
Georg Brandlf78e02b2008-06-10 17:40:04 +00001243 socket.setdefaulttimeout(42)
1244 try:
1245 self.cli = socket.create_connection((HOST, self.port))
1246 finally:
1247 socket.setdefaulttimeout(None)
1248 self.assertEquals(self.cli.gettimeout(), 42)
1249
1250 testTimeoutNone = _justAccept
1251 def _testTimeoutNone(self):
1252 # None timeout means the same as sock.settimeout(None)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001253 self.assertTrue(socket.getdefaulttimeout() is None)
Georg Brandlf78e02b2008-06-10 17:40:04 +00001254 socket.setdefaulttimeout(30)
1255 try:
1256 self.cli = socket.create_connection((HOST, self.port), timeout=None)
1257 finally:
1258 socket.setdefaulttimeout(None)
1259 self.assertEqual(self.cli.gettimeout(), None)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001260
1261 testTimeoutValueNamed = _justAccept
1262 def _testTimeoutValueNamed(self):
Christian Heimes5e696852008-04-09 08:37:03 +00001263 self.cli = socket.create_connection((HOST, self.port), timeout=30)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001264 self.assertEqual(self.cli.gettimeout(), 30)
1265
1266 testTimeoutValueNonamed = _justAccept
1267 def _testTimeoutValueNonamed(self):
Christian Heimes5e696852008-04-09 08:37:03 +00001268 self.cli = socket.create_connection((HOST, self.port), 30)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001269 self.assertEqual(self.cli.gettimeout(), 30)
1270
Victor Stinner45df8202010-04-28 22:31:17 +00001271@unittest.skipUnless(thread, 'Threading required for this test.')
Guido van Rossumd8faa362007-04-27 19:54:29 +00001272class NetworkConnectionBehaviourTest(SocketTCPTest, ThreadableTest):
1273
1274 def __init__(self, methodName='runTest'):
1275 SocketTCPTest.__init__(self, methodName=methodName)
1276 ThreadableTest.__init__(self)
1277
1278 def clientSetUp(self):
1279 pass
1280
1281 def clientTearDown(self):
1282 self.cli.close()
1283 self.cli = None
1284 ThreadableTest.clientTearDown(self)
1285
1286 def testInsideTimeout(self):
1287 conn, addr = self.serv.accept()
1288 time.sleep(3)
Guido van Rossum7d0a8262007-05-21 23:13:11 +00001289 conn.send(b"done!")
Guido van Rossumd8faa362007-04-27 19:54:29 +00001290 testOutsideTimeout = testInsideTimeout
1291
1292 def _testInsideTimeout(self):
Christian Heimes5e696852008-04-09 08:37:03 +00001293 self.cli = sock = socket.create_connection((HOST, self.port))
Guido van Rossumd8faa362007-04-27 19:54:29 +00001294 data = sock.recv(5)
Guido van Rossum7d0a8262007-05-21 23:13:11 +00001295 self.assertEqual(data, b"done!")
Guido van Rossumd8faa362007-04-27 19:54:29 +00001296
1297 def _testOutsideTimeout(self):
Christian Heimes5e696852008-04-09 08:37:03 +00001298 self.cli = sock = socket.create_connection((HOST, self.port), timeout=1)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001299 self.assertRaises(socket.timeout, lambda: sock.recv(5))
Guido van Rossumd8faa362007-04-27 19:54:29 +00001300
1301
Raymond Hettinger11a35f52003-06-29 04:40:22 +00001302class TCPTimeoutTest(SocketTCPTest):
1303
1304 def testTCPTimeout(self):
1305 def raise_timeout(*args, **kwargs):
1306 self.serv.settimeout(1.0)
1307 self.serv.accept()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001308 self.assertRaises(socket.timeout, raise_timeout,
Raymond Hettinger11a35f52003-06-29 04:40:22 +00001309 "Error generating a timeout exception (TCP)")
1310
1311 def testTimeoutZero(self):
1312 ok = False
1313 try:
1314 self.serv.settimeout(0.0)
1315 foo = self.serv.accept()
1316 except socket.timeout:
1317 self.fail("caught timeout instead of error (TCP)")
1318 except socket.error:
1319 ok = True
1320 except:
1321 self.fail("caught unexpected exception (TCP)")
1322 if not ok:
1323 self.fail("accept() returned success when we did not expect it")
1324
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001325 def testInterruptedTimeout(self):
1326 # XXX I don't know how to do this test on MSWindows or any other
1327 # plaform that doesn't support signal.alarm() or os.kill(), though
1328 # the bug should have existed on all platforms.
1329 if not hasattr(signal, "alarm"):
1330 return # can only test on *nix
1331 self.serv.settimeout(5.0) # must be longer than alarm
1332 class Alarm(Exception):
1333 pass
1334 def alarm_handler(signal, frame):
1335 raise Alarm
1336 old_alarm = signal.signal(signal.SIGALRM, alarm_handler)
1337 try:
1338 signal.alarm(2) # POSIX allows alarm to be up to 1 second early
1339 try:
1340 foo = self.serv.accept()
1341 except socket.timeout:
1342 self.fail("caught timeout instead of Alarm")
1343 except Alarm:
1344 pass
1345 except:
Christian Heimesbbe741d2008-03-28 10:53:29 +00001346 self.fail("caught other exception instead of Alarm:"
1347 " %s(%s):\n%s" %
1348 (sys.exc_info()[:2] + (traceback.format_exc(),)))
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001349 else:
1350 self.fail("nothing caught")
Christian Heimesbbe741d2008-03-28 10:53:29 +00001351 finally:
1352 signal.alarm(0) # shut off alarm
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001353 except Alarm:
1354 self.fail("got Alarm in wrong place")
1355 finally:
1356 # no alarm can be pending. Safe to restore old handler.
1357 signal.signal(signal.SIGALRM, old_alarm)
1358
Raymond Hettinger11a35f52003-06-29 04:40:22 +00001359class UDPTimeoutTest(SocketTCPTest):
1360
1361 def testUDPTimeout(self):
1362 def raise_timeout(*args, **kwargs):
1363 self.serv.settimeout(1.0)
1364 self.serv.recv(1024)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001365 self.assertRaises(socket.timeout, raise_timeout,
Raymond Hettinger11a35f52003-06-29 04:40:22 +00001366 "Error generating a timeout exception (UDP)")
1367
1368 def testTimeoutZero(self):
1369 ok = False
1370 try:
1371 self.serv.settimeout(0.0)
1372 foo = self.serv.recv(1024)
1373 except socket.timeout:
1374 self.fail("caught timeout instead of error (UDP)")
1375 except socket.error:
1376 ok = True
1377 except:
1378 self.fail("caught unexpected exception (UDP)")
1379 if not ok:
1380 self.fail("recv() returned success when we did not expect it")
1381
1382class TestExceptions(unittest.TestCase):
1383
1384 def testExceptionTree(self):
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001385 self.assertTrue(issubclass(socket.error, Exception))
1386 self.assertTrue(issubclass(socket.herror, socket.error))
1387 self.assertTrue(issubclass(socket.gaierror, socket.error))
1388 self.assertTrue(issubclass(socket.timeout, socket.error))
Raymond Hettinger11a35f52003-06-29 04:40:22 +00001389
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001390class TestLinuxAbstractNamespace(unittest.TestCase):
1391
1392 UNIX_PATH_MAX = 108
1393
1394 def testLinuxAbstractNamespace(self):
Guido van Rossum32c4ac02007-08-15 03:56:40 +00001395 address = b"\x00python-test-hello\x00\xff"
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001396 s1 = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
1397 s1.bind(address)
1398 s1.listen(1)
1399 s2 = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
1400 s2.connect(s1.getsockname())
1401 s1.accept()
1402 self.assertEqual(s1.getsockname(), address)
1403 self.assertEqual(s2.getpeername(), address)
1404
1405 def testMaxName(self):
Guido van Rossum32c4ac02007-08-15 03:56:40 +00001406 address = b"\x00" + b"h" * (self.UNIX_PATH_MAX - 1)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001407 s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
1408 s.bind(address)
1409 self.assertEqual(s.getsockname(), address)
1410
1411 def testNameOverflow(self):
1412 address = "\x00" + "h" * self.UNIX_PATH_MAX
1413 s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
1414 self.assertRaises(socket.error, s.bind, address)
1415
Raymond Hettinger11a35f52003-06-29 04:40:22 +00001416
Victor Stinner45df8202010-04-28 22:31:17 +00001417@unittest.skipUnless(thread, 'Threading required for this test.')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001418class BufferIOTest(SocketConnectedTest):
1419 """
1420 Test the buffer versions of socket.recv() and socket.send().
1421 """
1422 def __init__(self, methodName='runTest'):
1423 SocketConnectedTest.__init__(self, methodName=methodName)
1424
Antoine Pitrou25480782010-03-17 22:50:28 +00001425 def testRecvIntoArray(self):
Antoine Pitrou2f89aa62008-08-02 21:02:48 +00001426 buf = bytearray(1024)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001427 nbytes = self.cli_conn.recv_into(buf)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001428 self.assertEqual(nbytes, len(MSG))
Guido van Rossum7d0a8262007-05-21 23:13:11 +00001429 msg = buf[:len(MSG)]
Thomas Wouters477c8d52006-05-27 19:21:47 +00001430 self.assertEqual(msg, MSG)
1431
Antoine Pitrou25480782010-03-17 22:50:28 +00001432 def _testRecvIntoArray(self):
Guido van Rossumb5b22702007-05-18 18:55:53 +00001433 buf = bytes(MSG)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001434 self.serv_conn.send(buf)
1435
Antoine Pitrou25480782010-03-17 22:50:28 +00001436 def testRecvIntoBytearray(self):
1437 buf = bytearray(1024)
1438 nbytes = self.cli_conn.recv_into(buf)
1439 self.assertEqual(nbytes, len(MSG))
1440 msg = buf[:len(MSG)]
1441 self.assertEqual(msg, MSG)
1442
1443 _testRecvIntoBytearray = _testRecvIntoArray
1444
1445 def testRecvIntoMemoryview(self):
1446 buf = bytearray(1024)
1447 nbytes = self.cli_conn.recv_into(memoryview(buf))
1448 self.assertEqual(nbytes, len(MSG))
1449 msg = buf[:len(MSG)]
1450 self.assertEqual(msg, MSG)
1451
1452 _testRecvIntoMemoryview = _testRecvIntoArray
1453
1454 def testRecvFromIntoArray(self):
Antoine Pitrou2f89aa62008-08-02 21:02:48 +00001455 buf = bytearray(1024)
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001456 nbytes, addr = self.cli_conn.recvfrom_into(buf)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001457 self.assertEqual(nbytes, len(MSG))
Guido van Rossum7d0a8262007-05-21 23:13:11 +00001458 msg = buf[:len(MSG)]
Thomas Wouters477c8d52006-05-27 19:21:47 +00001459 self.assertEqual(msg, MSG)
1460
Antoine Pitrou25480782010-03-17 22:50:28 +00001461 def _testRecvFromIntoArray(self):
Guido van Rossumb5b22702007-05-18 18:55:53 +00001462 buf = bytes(MSG)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001463 self.serv_conn.send(buf)
1464
Antoine Pitrou25480782010-03-17 22:50:28 +00001465 def testRecvFromIntoBytearray(self):
1466 buf = bytearray(1024)
1467 nbytes, addr = self.cli_conn.recvfrom_into(buf)
1468 self.assertEqual(nbytes, len(MSG))
1469 msg = buf[:len(MSG)]
1470 self.assertEqual(msg, MSG)
1471
1472 _testRecvFromIntoBytearray = _testRecvFromIntoArray
1473
1474 def testRecvFromIntoMemoryview(self):
1475 buf = bytearray(1024)
1476 nbytes, addr = self.cli_conn.recvfrom_into(memoryview(buf))
1477 self.assertEqual(nbytes, len(MSG))
1478 msg = buf[:len(MSG)]
1479 self.assertEqual(msg, MSG)
1480
1481 _testRecvFromIntoMemoryview = _testRecvFromIntoArray
1482
Christian Heimes043d6f62008-01-07 17:19:16 +00001483
1484TIPC_STYPE = 2000
1485TIPC_LOWER = 200
1486TIPC_UPPER = 210
1487
1488def isTipcAvailable():
1489 """Check if the TIPC module is loaded
1490
1491 The TIPC module is not loaded automatically on Ubuntu and probably
1492 other Linux distros.
1493 """
1494 if not hasattr(socket, "AF_TIPC"):
1495 return False
1496 if not os.path.isfile("/proc/modules"):
1497 return False
1498 with open("/proc/modules") as f:
1499 for line in f:
1500 if line.startswith("tipc "):
1501 return True
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001502 if support.verbose:
Christian Heimes043d6f62008-01-07 17:19:16 +00001503 print("TIPC module is not loaded, please 'sudo modprobe tipc'")
1504 return False
1505
1506class TIPCTest (unittest.TestCase):
1507 def testRDM(self):
1508 srv = socket.socket(socket.AF_TIPC, socket.SOCK_RDM)
1509 cli = socket.socket(socket.AF_TIPC, socket.SOCK_RDM)
1510
1511 srv.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
1512 srvaddr = (socket.TIPC_ADDR_NAMESEQ, TIPC_STYPE,
1513 TIPC_LOWER, TIPC_UPPER)
1514 srv.bind(srvaddr)
1515
1516 sendaddr = (socket.TIPC_ADDR_NAME, TIPC_STYPE,
1517 TIPC_LOWER + int((TIPC_UPPER - TIPC_LOWER) / 2), 0)
1518 cli.sendto(MSG, sendaddr)
1519
1520 msg, recvaddr = srv.recvfrom(1024)
1521
1522 self.assertEqual(cli.getsockname(), recvaddr)
1523 self.assertEqual(msg, MSG)
1524
1525
1526class TIPCThreadableTest (unittest.TestCase, ThreadableTest):
1527 def __init__(self, methodName = 'runTest'):
1528 unittest.TestCase.__init__(self, methodName = methodName)
1529 ThreadableTest.__init__(self)
1530
1531 def setUp(self):
1532 self.srv = socket.socket(socket.AF_TIPC, socket.SOCK_STREAM)
1533 self.srv.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
1534 srvaddr = (socket.TIPC_ADDR_NAMESEQ, TIPC_STYPE,
1535 TIPC_LOWER, TIPC_UPPER)
1536 self.srv.bind(srvaddr)
1537 self.srv.listen(5)
1538 self.serverExplicitReady()
1539 self.conn, self.connaddr = self.srv.accept()
1540
1541 def clientSetUp(self):
1542 # The is a hittable race between serverExplicitReady() and the
1543 # accept() call; sleep a little while to avoid it, otherwise
1544 # we could get an exception
1545 time.sleep(0.1)
1546 self.cli = socket.socket(socket.AF_TIPC, socket.SOCK_STREAM)
1547 addr = (socket.TIPC_ADDR_NAME, TIPC_STYPE,
1548 TIPC_LOWER + int((TIPC_UPPER - TIPC_LOWER) / 2), 0)
1549 self.cli.connect(addr)
1550 self.cliaddr = self.cli.getsockname()
1551
1552 def testStream(self):
1553 msg = self.conn.recv(1024)
1554 self.assertEqual(msg, MSG)
1555 self.assertEqual(self.cliaddr, self.connaddr)
1556
1557 def _testStream(self):
1558 self.cli.send(MSG)
1559 self.cli.close()
1560
1561
Guido van Rossumb995eb72002-07-31 16:08:40 +00001562def test_main():
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001563 tests = [GeneralModuleTests, BasicTCPTest, TCPCloserTest, TCPTimeoutTest,
Ronald Oussoren94f25282010-05-05 19:11:21 +00001564 TestExceptions, BufferIOTest, BasicTCPTest2, BasicUDPTest, UDPTimeoutTest ]
Walter Dörwald21d3a322003-05-01 17:45:56 +00001565
1566 tests.extend([
1567 NonBlockingTCPTests,
1568 FileObjectClassTestCase,
Gregory P. Smithaafdca82010-01-04 04:50:36 +00001569 FileObjectInterruptedTestCase,
Walter Dörwald21d3a322003-05-01 17:45:56 +00001570 UnbufferedFileObjectClassTestCase,
1571 LineBufferedFileObjectClassTestCase,
Thomas Woutersb2137042007-02-01 18:02:27 +00001572 SmallBufferedFileObjectClassTestCase,
Guido van Rossumd8faa362007-04-27 19:54:29 +00001573 NetworkConnectionNoServer,
1574 NetworkConnectionAttributesTest,
1575 NetworkConnectionBehaviourTest,
Walter Dörwald21d3a322003-05-01 17:45:56 +00001576 ])
Dave Cole331708b2004-08-09 04:51:41 +00001577 if hasattr(socket, "socketpair"):
1578 tests.append(BasicSocketPairTest)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001579 if sys.platform == 'linux2':
1580 tests.append(TestLinuxAbstractNamespace)
Christian Heimes043d6f62008-01-07 17:19:16 +00001581 if isTipcAvailable():
1582 tests.append(TIPCTest)
Christian Heimes790c8232008-01-07 21:14:23 +00001583 tests.append(TIPCThreadableTest)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001584
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001585 thread_info = support.threading_setup()
1586 support.run_unittest(*tests)
1587 support.threading_cleanup(*thread_info)
Guido van Rossum24e4af82002-06-12 19:18:08 +00001588
1589if __name__ == "__main__":
Guido van Rossumb995eb72002-07-31 16:08:40 +00001590 test_main()