blob: cf61552da1ac406788c16dc3e5770cac6b8db170 [file] [log] [blame]
Jeremy Hylton636950f2009-03-28 04:34:21 +00001import errno
Jeremy Hylton7c1692d2009-03-27 21:31:03 +00002from http import client
Jeremy Hylton8fff7922007-08-03 20:56:14 +00003import io
Antoine Pitrou803e6d62010-10-13 10:36:15 +00004import os
Antoine Pitrouead1d622009-09-29 18:44:53 +00005import array
Guido van Rossumd8faa362007-04-27 19:54:29 +00006import socket
Jeremy Hylton121d34a2003-07-08 12:36:58 +00007
Gregory P. Smithb4066372010-01-03 03:28:29 +00008import unittest
9TestCase = unittest.TestCase
Jeremy Hylton2c178252004-08-07 16:28:14 +000010
Benjamin Petersonee8712c2008-05-20 21:35:26 +000011from test import support
Jeremy Hylton79fa2b62001-04-13 14:57:44 +000012
Antoine Pitrou803e6d62010-10-13 10:36:15 +000013here = os.path.dirname(__file__)
14# Self-signed cert file for 'localhost'
15CERT_localhost = os.path.join(here, 'keycert.pem')
16# Self-signed cert file for 'fakehostname'
17CERT_fakehostname = os.path.join(here, 'keycert2.pem')
18# Root cert file (CA) for svn.python.org's cert
19CACERT_svn_python_org = os.path.join(here, 'https_svn_python_org_root.pem')
20
Benjamin Petersonee8712c2008-05-20 21:35:26 +000021HOST = support.HOST
Christian Heimes5e696852008-04-09 08:37:03 +000022
Jeremy Hylton79fa2b62001-04-13 14:57:44 +000023class FakeSocket:
Jeremy Hylton8fff7922007-08-03 20:56:14 +000024 def __init__(self, text, fileclass=io.BytesIO):
25 if isinstance(text, str):
Guido van Rossum39478e82007-08-27 17:23:59 +000026 text = text.encode("ascii")
Jeremy Hylton79fa2b62001-04-13 14:57:44 +000027 self.text = text
Jeremy Hylton121d34a2003-07-08 12:36:58 +000028 self.fileclass = fileclass
Martin v. Löwisdd5a8602007-06-30 09:22:09 +000029 self.data = b''
Jeremy Hylton79fa2b62001-04-13 14:57:44 +000030
Jeremy Hylton2c178252004-08-07 16:28:14 +000031 def sendall(self, data):
Thomas Wouters89f507f2006-12-13 04:49:30 +000032 self.data += data
Jeremy Hylton2c178252004-08-07 16:28:14 +000033
Jeremy Hylton79fa2b62001-04-13 14:57:44 +000034 def makefile(self, mode, bufsize=None):
35 if mode != 'r' and mode != 'rb':
Jeremy Hylton7c1692d2009-03-27 21:31:03 +000036 raise client.UnimplementedFileMode()
Jeremy Hylton121d34a2003-07-08 12:36:58 +000037 return self.fileclass(self.text)
38
Jeremy Hylton636950f2009-03-28 04:34:21 +000039class EPipeSocket(FakeSocket):
40
41 def __init__(self, text, pipe_trigger):
42 # When sendall() is called with pipe_trigger, raise EPIPE.
43 FakeSocket.__init__(self, text)
44 self.pipe_trigger = pipe_trigger
45
46 def sendall(self, data):
47 if self.pipe_trigger in data:
48 raise socket.error(errno.EPIPE, "gotcha")
49 self.data += data
50
51 def close(self):
52 pass
53
Jeremy Hylton8fff7922007-08-03 20:56:14 +000054class NoEOFStringIO(io.BytesIO):
Jeremy Hylton121d34a2003-07-08 12:36:58 +000055 """Like StringIO, but raises AssertionError on EOF.
56
Jeremy Hylton7c1692d2009-03-27 21:31:03 +000057 This is used below to test that http.client doesn't try to read
Jeremy Hylton121d34a2003-07-08 12:36:58 +000058 more from the underlying file than it should.
59 """
60 def read(self, n=-1):
Jeremy Hylton8fff7922007-08-03 20:56:14 +000061 data = io.BytesIO.read(self, n)
Jeremy Hyltonda3f2282007-08-29 17:26:34 +000062 if data == b'':
Jeremy Hylton121d34a2003-07-08 12:36:58 +000063 raise AssertionError('caller tried to read past EOF')
64 return data
65
66 def readline(self, length=None):
Jeremy Hylton8fff7922007-08-03 20:56:14 +000067 data = io.BytesIO.readline(self, length)
Jeremy Hyltonda3f2282007-08-29 17:26:34 +000068 if data == b'':
Jeremy Hylton121d34a2003-07-08 12:36:58 +000069 raise AssertionError('caller tried to read past EOF')
70 return data
Jeremy Hylton79fa2b62001-04-13 14:57:44 +000071
Jeremy Hylton2c178252004-08-07 16:28:14 +000072class HeaderTests(TestCase):
73 def test_auto_headers(self):
74 # Some headers are added automatically, but should not be added by
75 # .request() if they are explicitly set.
76
Jeremy Hylton2c178252004-08-07 16:28:14 +000077 class HeaderCountingBuffer(list):
78 def __init__(self):
79 self.count = {}
80 def append(self, item):
Guido van Rossum022c4742007-08-29 02:00:20 +000081 kv = item.split(b':')
Jeremy Hylton2c178252004-08-07 16:28:14 +000082 if len(kv) > 1:
83 # item is a 'Key: Value' header string
Martin v. Löwisdd5a8602007-06-30 09:22:09 +000084 lcKey = kv[0].decode('ascii').lower()
Jeremy Hylton2c178252004-08-07 16:28:14 +000085 self.count.setdefault(lcKey, 0)
86 self.count[lcKey] += 1
87 list.append(self, item)
88
89 for explicit_header in True, False:
90 for header in 'Content-length', 'Host', 'Accept-encoding':
Jeremy Hylton7c1692d2009-03-27 21:31:03 +000091 conn = client.HTTPConnection('example.com')
Jeremy Hylton2c178252004-08-07 16:28:14 +000092 conn.sock = FakeSocket('blahblahblah')
93 conn._buffer = HeaderCountingBuffer()
94
95 body = 'spamspamspam'
96 headers = {}
97 if explicit_header:
98 headers[header] = str(len(body))
99 conn.request('POST', '/', body, headers)
100 self.assertEqual(conn._buffer.count[header.lower()], 1)
101
Senthil Kumaran5fa4a892012-05-19 16:58:09 +0800102 def test_content_length_0(self):
103
104 class ContentLengthChecker(list):
105 def __init__(self):
106 list.__init__(self)
107 self.content_length = None
108 def append(self, item):
109 kv = item.split(b':', 1)
110 if len(kv) > 1 and kv[0].lower() == b'content-length':
111 self.content_length = kv[1].strip()
112 list.append(self, item)
113
114 # POST with empty body
115 conn = client.HTTPConnection('example.com')
116 conn.sock = FakeSocket(None)
117 conn._buffer = ContentLengthChecker()
118 conn.request('POST', '/', '')
119 self.assertEqual(conn._buffer.content_length, b'0',
120 'Header Content-Length not set')
121
122 # PUT request with empty body
123 conn = client.HTTPConnection('example.com')
124 conn.sock = FakeSocket(None)
125 conn._buffer = ContentLengthChecker()
126 conn.request('PUT', '/', '')
127 self.assertEqual(conn._buffer.content_length, b'0',
128 'Header Content-Length not set')
129
Senthil Kumaran58d5dbf2010-10-03 18:22:42 +0000130 def test_putheader(self):
131 conn = client.HTTPConnection('example.com')
132 conn.sock = FakeSocket(None)
133 conn.putrequest('GET','/')
134 conn.putheader('Content-length', 42)
Senthil Kumaran58d5dbf2010-10-03 18:22:42 +0000135 self.assertTrue(b'Content-length: 42' in conn._buffer)
136
Senthil Kumaran74ebd9e2010-11-13 12:27:49 +0000137 def test_ipv6host_header(self):
138 # Default host header on IPv6 transaction should wrapped by [] if
139 # its actual IPv6 address
140 expected = b'GET /foo HTTP/1.1\r\nHost: [2001::]:81\r\n' \
141 b'Accept-Encoding: identity\r\n\r\n'
142 conn = client.HTTPConnection('[2001::]:81')
143 sock = FakeSocket('')
144 conn.sock = sock
145 conn.request('GET', '/foo')
146 self.assertTrue(sock.data.startswith(expected))
147
148 expected = b'GET /foo HTTP/1.1\r\nHost: [2001:102A::]\r\n' \
149 b'Accept-Encoding: identity\r\n\r\n'
150 conn = client.HTTPConnection('[2001:102A::]')
151 sock = FakeSocket('')
152 conn.sock = sock
153 conn.request('GET', '/foo')
154 self.assertTrue(sock.data.startswith(expected))
155
Senthil Kumaran58d5dbf2010-10-03 18:22:42 +0000156
Thomas Wouters89f507f2006-12-13 04:49:30 +0000157class BasicTest(TestCase):
158 def test_status_lines(self):
159 # Test HTTP status lines
Jeremy Hylton79fa2b62001-04-13 14:57:44 +0000160
Thomas Wouters89f507f2006-12-13 04:49:30 +0000161 body = "HTTP/1.1 200 Ok\r\n\r\nText"
162 sock = FakeSocket(body)
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000163 resp = client.HTTPResponse(sock)
Jeremy Hyltonba603192003-01-23 18:02:20 +0000164 resp.begin()
Jeremy Hylton8fff7922007-08-03 20:56:14 +0000165 self.assertEqual(resp.read(), b"Text")
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000166 self.assertTrue(resp.isclosed())
Jeremy Hyltonba603192003-01-23 18:02:20 +0000167
Thomas Wouters89f507f2006-12-13 04:49:30 +0000168 body = "HTTP/1.1 400.100 Not Ok\r\n\r\nText"
169 sock = FakeSocket(body)
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000170 resp = client.HTTPResponse(sock)
171 self.assertRaises(client.BadStatusLine, resp.begin)
Jeremy Hyltonba603192003-01-23 18:02:20 +0000172
Benjamin Peterson11dbfd42010-03-21 22:50:04 +0000173 def test_bad_status_repr(self):
174 exc = client.BadStatusLine('')
Ezio Melottib3aedd42010-11-20 19:04:17 +0000175 self.assertEqual(repr(exc), '''BadStatusLine("\'\'",)''')
Benjamin Peterson11dbfd42010-03-21 22:50:04 +0000176
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000177 def test_partial_reads(self):
178 # if we have a lenght, the system knows when to close itself
179 # same behaviour than when we read the whole thing with read()
180 body = "HTTP/1.1 200 Ok\r\nContent-Length: 4\r\n\r\nText"
181 sock = FakeSocket(body)
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000182 resp = client.HTTPResponse(sock)
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000183 resp.begin()
184 self.assertEqual(resp.read(2), b'Te')
185 self.assertFalse(resp.isclosed())
186 self.assertEqual(resp.read(2), b'xt')
187 self.assertTrue(resp.isclosed())
188
Antoine Pitrou38d96432011-12-06 22:33:57 +0100189 def test_partial_readintos(self):
190 # if we have a lenght, the system knows when to close itself
191 # same behaviour than when we read the whole thing with read()
192 body = "HTTP/1.1 200 Ok\r\nContent-Length: 4\r\n\r\nText"
193 sock = FakeSocket(body)
194 resp = client.HTTPResponse(sock)
195 resp.begin()
196 b = bytearray(2)
197 n = resp.readinto(b)
198 self.assertEqual(n, 2)
199 self.assertEqual(bytes(b), b'Te')
200 self.assertFalse(resp.isclosed())
201 n = resp.readinto(b)
202 self.assertEqual(n, 2)
203 self.assertEqual(bytes(b), b'xt')
204 self.assertTrue(resp.isclosed())
205
Thomas Wouters89f507f2006-12-13 04:49:30 +0000206 def test_host_port(self):
207 # Check invalid host_port
Jeremy Hyltonba603192003-01-23 18:02:20 +0000208
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200209 for hp in ("www.python.org:abc", "user:password@www.python.org"):
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000210 self.assertRaises(client.InvalidURL, client.HTTPConnection, hp)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000211
Jeremy Hylton3a38c912007-08-14 17:08:07 +0000212 for hp, h, p in (("[fe80::207:e9ff:fe9b]:8000",
213 "fe80::207:e9ff:fe9b", 8000),
Thomas Wouters89f507f2006-12-13 04:49:30 +0000214 ("www.python.org:80", "www.python.org", 80),
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200215 ("www.python.org:", "www.python.org", 80),
Thomas Wouters89f507f2006-12-13 04:49:30 +0000216 ("www.python.org", "www.python.org", 80),
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200217 ("[fe80::207:e9ff:fe9b]", "fe80::207:e9ff:fe9b", 80),
218 ("[fe80::207:e9ff:fe9b]:", "fe80::207:e9ff:fe9b", 80)):
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000219 c = client.HTTPConnection(hp)
Jeremy Hylton3a38c912007-08-14 17:08:07 +0000220 self.assertEqual(h, c.host)
221 self.assertEqual(p, c.port)
Skip Montanaro10e6e0e2004-09-14 16:32:02 +0000222
Thomas Wouters89f507f2006-12-13 04:49:30 +0000223 def test_response_headers(self):
224 # test response with multiple message headers with the same field name.
225 text = ('HTTP/1.1 200 OK\r\n'
Jeremy Hylton3a38c912007-08-14 17:08:07 +0000226 'Set-Cookie: Customer="WILE_E_COYOTE"; '
227 'Version="1"; Path="/acme"\r\n'
Thomas Wouters89f507f2006-12-13 04:49:30 +0000228 'Set-Cookie: Part_Number="Rocket_Launcher_0001"; Version="1";'
229 ' Path="/acme"\r\n'
230 '\r\n'
231 'No body\r\n')
232 hdr = ('Customer="WILE_E_COYOTE"; Version="1"; Path="/acme"'
233 ', '
234 'Part_Number="Rocket_Launcher_0001"; Version="1"; Path="/acme"')
235 s = FakeSocket(text)
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000236 r = client.HTTPResponse(s)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000237 r.begin()
238 cookies = r.getheader("Set-Cookie")
Jeremy Hylton3a38c912007-08-14 17:08:07 +0000239 self.assertEqual(cookies, hdr)
Jeremy Hyltonba603192003-01-23 18:02:20 +0000240
Thomas Wouters89f507f2006-12-13 04:49:30 +0000241 def test_read_head(self):
242 # Test that the library doesn't attempt to read any data
243 # from a HEAD request. (Tickles SF bug #622042.)
244 sock = FakeSocket(
245 'HTTP/1.1 200 OK\r\n'
246 'Content-Length: 14432\r\n'
247 '\r\n',
248 NoEOFStringIO)
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000249 resp = client.HTTPResponse(sock, method="HEAD")
Thomas Wouters89f507f2006-12-13 04:49:30 +0000250 resp.begin()
Guido van Rossuma00f1232007-09-12 19:43:09 +0000251 if resp.read():
Thomas Wouters89f507f2006-12-13 04:49:30 +0000252 self.fail("Did not expect response from HEAD request")
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000253
Antoine Pitrou38d96432011-12-06 22:33:57 +0100254 def test_readinto_head(self):
255 # Test that the library doesn't attempt to read any data
256 # from a HEAD request. (Tickles SF bug #622042.)
257 sock = FakeSocket(
258 'HTTP/1.1 200 OK\r\n'
259 'Content-Length: 14432\r\n'
260 '\r\n',
261 NoEOFStringIO)
262 resp = client.HTTPResponse(sock, method="HEAD")
263 resp.begin()
264 b = bytearray(5)
265 if resp.readinto(b) != 0:
266 self.fail("Did not expect response from HEAD request")
267 self.assertEqual(bytes(b), b'\x00'*5)
268
Thomas Wouters89f507f2006-12-13 04:49:30 +0000269 def test_send_file(self):
Guido van Rossum022c4742007-08-29 02:00:20 +0000270 expected = (b'GET /foo HTTP/1.1\r\nHost: example.com\r\n'
271 b'Accept-Encoding: identity\r\nContent-Length:')
Thomas Wouters89f507f2006-12-13 04:49:30 +0000272
Brett Cannon77b7de62010-10-29 23:31:11 +0000273 with open(__file__, 'rb') as body:
274 conn = client.HTTPConnection('example.com')
275 sock = FakeSocket(body)
276 conn.sock = sock
277 conn.request('GET', '/foo', body)
278 self.assertTrue(sock.data.startswith(expected), '%r != %r' %
279 (sock.data[:len(expected)], expected))
Jeremy Hylton2c178252004-08-07 16:28:14 +0000280
Antoine Pitrouead1d622009-09-29 18:44:53 +0000281 def test_send(self):
282 expected = b'this is a test this is only a test'
283 conn = client.HTTPConnection('example.com')
284 sock = FakeSocket(None)
285 conn.sock = sock
286 conn.send(expected)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000287 self.assertEqual(expected, sock.data)
Antoine Pitrouead1d622009-09-29 18:44:53 +0000288 sock.data = b''
289 conn.send(array.array('b', expected))
Ezio Melottib3aedd42010-11-20 19:04:17 +0000290 self.assertEqual(expected, sock.data)
Antoine Pitrouead1d622009-09-29 18:44:53 +0000291 sock.data = b''
292 conn.send(io.BytesIO(expected))
Ezio Melottib3aedd42010-11-20 19:04:17 +0000293 self.assertEqual(expected, sock.data)
Antoine Pitrouead1d622009-09-29 18:44:53 +0000294
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000295 def test_send_iter(self):
296 expected = b'GET /foo HTTP/1.1\r\nHost: example.com\r\n' \
297 b'Accept-Encoding: identity\r\nContent-Length: 11\r\n' \
298 b'\r\nonetwothree'
299
300 def body():
301 yield b"one"
302 yield b"two"
303 yield b"three"
304
305 conn = client.HTTPConnection('example.com')
306 sock = FakeSocket("")
307 conn.sock = sock
308 conn.request('GET', '/foo', body(), {'Content-Length': '11'})
Victor Stinner04ba9662011-01-04 00:04:46 +0000309 self.assertEqual(sock.data, expected)
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000310
Senthil Kumaraneb71ad42011-08-02 18:33:41 +0800311 def test_send_type_error(self):
312 # See: Issue #12676
313 conn = client.HTTPConnection('example.com')
314 conn.sock = FakeSocket('')
315 with self.assertRaises(TypeError):
316 conn.request('POST', 'test', conn)
317
Christian Heimesa612dc02008-02-24 13:08:18 +0000318 def test_chunked(self):
319 chunked_start = (
320 'HTTP/1.1 200 OK\r\n'
321 'Transfer-Encoding: chunked\r\n\r\n'
322 'a\r\n'
323 'hello worl\r\n'
Antoine Pitrouf7e78182012-01-04 18:57:22 +0100324 '3\r\n'
325 'd! \r\n'
326 '8\r\n'
327 'and now \r\n'
328 '22\r\n'
329 'for something completely different\r\n'
Christian Heimesa612dc02008-02-24 13:08:18 +0000330 )
Antoine Pitrouf7e78182012-01-04 18:57:22 +0100331 expected = b'hello world! and now for something completely different'
Christian Heimesa612dc02008-02-24 13:08:18 +0000332 sock = FakeSocket(chunked_start + '0\r\n')
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000333 resp = client.HTTPResponse(sock, method="GET")
Christian Heimesa612dc02008-02-24 13:08:18 +0000334 resp.begin()
Antoine Pitrouf7e78182012-01-04 18:57:22 +0100335 self.assertEqual(resp.read(), expected)
Christian Heimesa612dc02008-02-24 13:08:18 +0000336 resp.close()
337
Antoine Pitrouf7e78182012-01-04 18:57:22 +0100338 # Various read sizes
339 for n in range(1, 12):
340 sock = FakeSocket(chunked_start + '0\r\n')
341 resp = client.HTTPResponse(sock, method="GET")
342 resp.begin()
343 self.assertEqual(resp.read(n) + resp.read(n) + resp.read(), expected)
344 resp.close()
345
Christian Heimesa612dc02008-02-24 13:08:18 +0000346 for x in ('', 'foo\r\n'):
347 sock = FakeSocket(chunked_start + x)
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000348 resp = client.HTTPResponse(sock, method="GET")
Christian Heimesa612dc02008-02-24 13:08:18 +0000349 resp.begin()
350 try:
351 resp.read()
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000352 except client.IncompleteRead as i:
Antoine Pitrouf7e78182012-01-04 18:57:22 +0100353 self.assertEqual(i.partial, expected)
354 expected_message = 'IncompleteRead(%d bytes read)' % len(expected)
355 self.assertEqual(repr(i), expected_message)
356 self.assertEqual(str(i), expected_message)
Christian Heimesa612dc02008-02-24 13:08:18 +0000357 else:
358 self.fail('IncompleteRead expected')
359 finally:
360 resp.close()
361
Antoine Pitrou38d96432011-12-06 22:33:57 +0100362 def test_readinto_chunked(self):
363 chunked_start = (
364 'HTTP/1.1 200 OK\r\n'
365 'Transfer-Encoding: chunked\r\n\r\n'
366 'a\r\n'
367 'hello worl\r\n'
Antoine Pitrouf7e78182012-01-04 18:57:22 +0100368 '3\r\n'
369 'd! \r\n'
370 '8\r\n'
371 'and now \r\n'
372 '22\r\n'
373 'for something completely different\r\n'
Antoine Pitrou38d96432011-12-06 22:33:57 +0100374 )
Antoine Pitrouf7e78182012-01-04 18:57:22 +0100375 expected = b'hello world! and now for something completely different'
376 nexpected = len(expected)
377 b = bytearray(128)
378
Antoine Pitrou38d96432011-12-06 22:33:57 +0100379 sock = FakeSocket(chunked_start + '0\r\n')
380 resp = client.HTTPResponse(sock, method="GET")
381 resp.begin()
Antoine Pitrou38d96432011-12-06 22:33:57 +0100382 n = resp.readinto(b)
Antoine Pitrouf7e78182012-01-04 18:57:22 +0100383 self.assertEqual(b[:nexpected], expected)
384 self.assertEqual(n, nexpected)
Antoine Pitrou38d96432011-12-06 22:33:57 +0100385 resp.close()
386
Antoine Pitrouf7e78182012-01-04 18:57:22 +0100387 # Various read sizes
388 for n in range(1, 12):
389 sock = FakeSocket(chunked_start + '0\r\n')
390 resp = client.HTTPResponse(sock, method="GET")
391 resp.begin()
392 m = memoryview(b)
393 i = resp.readinto(m[0:n])
394 i += resp.readinto(m[i:n + i])
395 i += resp.readinto(m[i:])
396 self.assertEqual(b[:nexpected], expected)
397 self.assertEqual(i, nexpected)
398 resp.close()
399
Antoine Pitrou38d96432011-12-06 22:33:57 +0100400 for x in ('', 'foo\r\n'):
401 sock = FakeSocket(chunked_start + x)
402 resp = client.HTTPResponse(sock, method="GET")
403 resp.begin()
404 try:
Antoine Pitrou38d96432011-12-06 22:33:57 +0100405 n = resp.readinto(b)
406 except client.IncompleteRead as i:
Antoine Pitrouf7e78182012-01-04 18:57:22 +0100407 self.assertEqual(i.partial, expected)
408 expected_message = 'IncompleteRead(%d bytes read)' % len(expected)
409 self.assertEqual(repr(i), expected_message)
410 self.assertEqual(str(i), expected_message)
Antoine Pitrou38d96432011-12-06 22:33:57 +0100411 else:
412 self.fail('IncompleteRead expected')
413 finally:
414 resp.close()
415
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000416 def test_chunked_head(self):
417 chunked_start = (
418 'HTTP/1.1 200 OK\r\n'
419 'Transfer-Encoding: chunked\r\n\r\n'
420 'a\r\n'
421 'hello world\r\n'
422 '1\r\n'
423 'd\r\n'
424 )
425 sock = FakeSocket(chunked_start + '0\r\n')
426 resp = client.HTTPResponse(sock, method="HEAD")
427 resp.begin()
Ezio Melottib3aedd42010-11-20 19:04:17 +0000428 self.assertEqual(resp.read(), b'')
429 self.assertEqual(resp.status, 200)
430 self.assertEqual(resp.reason, 'OK')
Senthil Kumaran0b998832010-06-04 17:27:11 +0000431 self.assertTrue(resp.isclosed())
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000432
Antoine Pitrou38d96432011-12-06 22:33:57 +0100433 def test_readinto_chunked_head(self):
434 chunked_start = (
435 'HTTP/1.1 200 OK\r\n'
436 'Transfer-Encoding: chunked\r\n\r\n'
437 'a\r\n'
438 'hello world\r\n'
439 '1\r\n'
440 'd\r\n'
441 )
442 sock = FakeSocket(chunked_start + '0\r\n')
443 resp = client.HTTPResponse(sock, method="HEAD")
444 resp.begin()
445 b = bytearray(5)
446 n = resp.readinto(b)
447 self.assertEqual(n, 0)
448 self.assertEqual(bytes(b), b'\x00'*5)
449 self.assertEqual(resp.status, 200)
450 self.assertEqual(resp.reason, 'OK')
451 self.assertTrue(resp.isclosed())
452
Christian Heimesa612dc02008-02-24 13:08:18 +0000453 def test_negative_content_length(self):
Jeremy Hylton82066952008-12-15 03:08:30 +0000454 sock = FakeSocket(
455 'HTTP/1.1 200 OK\r\nContent-Length: -1\r\n\r\nHello\r\n')
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000456 resp = client.HTTPResponse(sock, method="GET")
Christian Heimesa612dc02008-02-24 13:08:18 +0000457 resp.begin()
Ezio Melottib3aedd42010-11-20 19:04:17 +0000458 self.assertEqual(resp.read(), b'Hello\r\n')
Christian Heimesa612dc02008-02-24 13:08:18 +0000459 resp.close()
460
Benjamin Peterson6accb982009-03-02 22:50:25 +0000461 def test_incomplete_read(self):
462 sock = FakeSocket('HTTP/1.1 200 OK\r\nContent-Length: 10\r\n\r\nHello\r\n')
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000463 resp = client.HTTPResponse(sock, method="GET")
Benjamin Peterson6accb982009-03-02 22:50:25 +0000464 resp.begin()
465 try:
466 resp.read()
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000467 except client.IncompleteRead as i:
Ezio Melottib3aedd42010-11-20 19:04:17 +0000468 self.assertEqual(i.partial, b'Hello\r\n')
Benjamin Peterson6accb982009-03-02 22:50:25 +0000469 self.assertEqual(repr(i),
470 "IncompleteRead(7 bytes read, 3 more expected)")
471 self.assertEqual(str(i),
472 "IncompleteRead(7 bytes read, 3 more expected)")
473 else:
474 self.fail('IncompleteRead expected')
475 finally:
476 resp.close()
477
Jeremy Hylton636950f2009-03-28 04:34:21 +0000478 def test_epipe(self):
479 sock = EPipeSocket(
480 "HTTP/1.0 401 Authorization Required\r\n"
481 "Content-type: text/html\r\n"
482 "WWW-Authenticate: Basic realm=\"example\"\r\n",
483 b"Content-Length")
484 conn = client.HTTPConnection("example.com")
485 conn.sock = sock
486 self.assertRaises(socket.error,
487 lambda: conn.request("PUT", "/url", "body"))
488 resp = conn.getresponse()
489 self.assertEqual(401, resp.status)
490 self.assertEqual("Basic realm=\"example\"",
491 resp.getheader("www-authenticate"))
Christian Heimesa612dc02008-02-24 13:08:18 +0000492
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000493 # Test lines overflowing the max line size (_MAXLINE in http.client)
494
495 def test_overflowing_status_line(self):
496 body = "HTTP/1.1 200 Ok" + "k" * 65536 + "\r\n"
497 resp = client.HTTPResponse(FakeSocket(body))
498 self.assertRaises((client.LineTooLong, client.BadStatusLine), resp.begin)
499
500 def test_overflowing_header_line(self):
501 body = (
502 'HTTP/1.1 200 OK\r\n'
503 'X-Foo: bar' + 'r' * 65536 + '\r\n\r\n'
504 )
505 resp = client.HTTPResponse(FakeSocket(body))
506 self.assertRaises(client.LineTooLong, resp.begin)
507
508 def test_overflowing_chunked_line(self):
509 body = (
510 'HTTP/1.1 200 OK\r\n'
511 'Transfer-Encoding: chunked\r\n\r\n'
512 + '0' * 65536 + 'a\r\n'
513 'hello world\r\n'
514 '0\r\n'
515 )
516 resp = client.HTTPResponse(FakeSocket(body))
517 resp.begin()
518 self.assertRaises(client.LineTooLong, resp.read)
519
Senthil Kumaran9c29f862012-04-29 10:20:46 +0800520 def test_early_eof(self):
521 # Test httpresponse with no \r\n termination,
522 body = "HTTP/1.1 200 Ok"
523 sock = FakeSocket(body)
524 resp = client.HTTPResponse(sock)
525 resp.begin()
526 self.assertEqual(resp.read(), b'')
527 self.assertTrue(resp.isclosed())
528
Georg Brandl4cbd1e32006-02-17 22:01:08 +0000529class OfflineTest(TestCase):
530 def test_responses(self):
Ezio Melottib3aedd42010-11-20 19:04:17 +0000531 self.assertEqual(client.responses[client.NOT_FOUND], "Not Found")
Georg Brandl4cbd1e32006-02-17 22:01:08 +0000532
Gregory P. Smithb4066372010-01-03 03:28:29 +0000533
534class SourceAddressTest(TestCase):
535 def setUp(self):
536 self.serv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
537 self.port = support.bind_port(self.serv)
538 self.source_port = support.find_unused_port()
539 self.serv.listen(5)
540 self.conn = None
541
542 def tearDown(self):
543 if self.conn:
544 self.conn.close()
545 self.conn = None
546 self.serv.close()
547 self.serv = None
548
549 def testHTTPConnectionSourceAddress(self):
550 self.conn = client.HTTPConnection(HOST, self.port,
551 source_address=('', self.source_port))
552 self.conn.connect()
553 self.assertEqual(self.conn.sock.getsockname()[1], self.source_port)
554
555 @unittest.skipIf(not hasattr(client, 'HTTPSConnection'),
556 'http.client.HTTPSConnection not defined')
557 def testHTTPSConnectionSourceAddress(self):
558 self.conn = client.HTTPSConnection(HOST, self.port,
559 source_address=('', self.source_port))
560 # We don't test anything here other the constructor not barfing as
561 # this code doesn't deal with setting up an active running SSL server
562 # for an ssl_wrapped connect() to actually return from.
563
564
Guido van Rossumd8faa362007-04-27 19:54:29 +0000565class TimeoutTest(TestCase):
Christian Heimes5e696852008-04-09 08:37:03 +0000566 PORT = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000567
568 def setUp(self):
569 self.serv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000570 TimeoutTest.PORT = support.bind_port(self.serv)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000571 self.serv.listen(5)
572
573 def tearDown(self):
574 self.serv.close()
575 self.serv = None
576
577 def testTimeoutAttribute(self):
Jeremy Hylton3a38c912007-08-14 17:08:07 +0000578 # This will prove that the timeout gets through HTTPConnection
579 # and into the socket.
580
Georg Brandlf78e02b2008-06-10 17:40:04 +0000581 # default -- use global socket timeout
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000582 self.assertTrue(socket.getdefaulttimeout() is None)
Georg Brandlf78e02b2008-06-10 17:40:04 +0000583 socket.setdefaulttimeout(30)
584 try:
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000585 httpConn = client.HTTPConnection(HOST, TimeoutTest.PORT)
Georg Brandlf78e02b2008-06-10 17:40:04 +0000586 httpConn.connect()
587 finally:
588 socket.setdefaulttimeout(None)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000589 self.assertEqual(httpConn.sock.gettimeout(), 30)
590 httpConn.close()
591
Georg Brandlf78e02b2008-06-10 17:40:04 +0000592 # no timeout -- do not use global socket default
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000593 self.assertTrue(socket.getdefaulttimeout() is None)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000594 socket.setdefaulttimeout(30)
595 try:
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000596 httpConn = client.HTTPConnection(HOST, TimeoutTest.PORT,
Christian Heimes5e696852008-04-09 08:37:03 +0000597 timeout=None)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000598 httpConn.connect()
599 finally:
Georg Brandlf78e02b2008-06-10 17:40:04 +0000600 socket.setdefaulttimeout(None)
601 self.assertEqual(httpConn.sock.gettimeout(), None)
602 httpConn.close()
603
604 # a value
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000605 httpConn = client.HTTPConnection(HOST, TimeoutTest.PORT, timeout=30)
Georg Brandlf78e02b2008-06-10 17:40:04 +0000606 httpConn.connect()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000607 self.assertEqual(httpConn.sock.gettimeout(), 30)
608 httpConn.close()
609
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000610
611class HTTPSTest(TestCase):
612
613 def setUp(self):
614 if not hasattr(client, 'HTTPSConnection'):
615 self.skipTest('ssl support required')
616
617 def make_server(self, certfile):
618 from test.ssl_servers import make_https_server
619 return make_https_server(self, certfile)
Guido van Rossumd59da4b2007-05-22 18:11:13 +0000620
621 def test_attributes(self):
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000622 # simple test to check it's storing the timeout
623 h = client.HTTPSConnection(HOST, TimeoutTest.PORT, timeout=30)
624 self.assertEqual(h.timeout, 30)
625
626 def _check_svn_python_org(self, resp):
627 # Just a simple check that everything went fine
628 server_string = resp.getheader('server')
629 self.assertIn('Apache', server_string)
630
631 def test_networked(self):
632 # Default settings: no cert verification is done
633 support.requires('network')
634 with support.transient_internet('svn.python.org'):
635 h = client.HTTPSConnection('svn.python.org', 443)
636 h.request('GET', '/')
637 resp = h.getresponse()
638 self._check_svn_python_org(resp)
639
640 def test_networked_good_cert(self):
641 # We feed a CA cert that validates the server's cert
642 import ssl
643 support.requires('network')
644 with support.transient_internet('svn.python.org'):
645 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
646 context.verify_mode = ssl.CERT_REQUIRED
647 context.load_verify_locations(CACERT_svn_python_org)
648 h = client.HTTPSConnection('svn.python.org', 443, context=context)
649 h.request('GET', '/')
650 resp = h.getresponse()
651 self._check_svn_python_org(resp)
652
653 def test_networked_bad_cert(self):
654 # We feed a "CA" cert that is unrelated to the server's cert
655 import ssl
656 support.requires('network')
657 with support.transient_internet('svn.python.org'):
658 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
659 context.verify_mode = ssl.CERT_REQUIRED
660 context.load_verify_locations(CERT_localhost)
661 h = client.HTTPSConnection('svn.python.org', 443, context=context)
662 with self.assertRaises(ssl.SSLError):
663 h.request('GET', '/')
664
665 def test_local_good_hostname(self):
666 # The (valid) cert validates the HTTP hostname
667 import ssl
Brett Cannon252365b2011-08-04 22:43:11 -0700668 server = self.make_server(CERT_localhost)
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000669 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
670 context.verify_mode = ssl.CERT_REQUIRED
671 context.load_verify_locations(CERT_localhost)
672 h = client.HTTPSConnection('localhost', server.port, context=context)
673 h.request('GET', '/nonexistent')
674 resp = h.getresponse()
675 self.assertEqual(resp.status, 404)
Brett Cannon252365b2011-08-04 22:43:11 -0700676 del server
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000677
678 def test_local_bad_hostname(self):
679 # The (valid) cert doesn't validate the HTTP hostname
680 import ssl
Brett Cannon252365b2011-08-04 22:43:11 -0700681 server = self.make_server(CERT_fakehostname)
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000682 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
683 context.verify_mode = ssl.CERT_REQUIRED
684 context.load_verify_locations(CERT_fakehostname)
685 h = client.HTTPSConnection('localhost', server.port, context=context)
686 with self.assertRaises(ssl.CertificateError):
687 h.request('GET', '/')
688 # Same with explicit check_hostname=True
689 h = client.HTTPSConnection('localhost', server.port, context=context,
690 check_hostname=True)
691 with self.assertRaises(ssl.CertificateError):
692 h.request('GET', '/')
693 # With check_hostname=False, the mismatching is ignored
694 h = client.HTTPSConnection('localhost', server.port, context=context,
695 check_hostname=False)
696 h.request('GET', '/nonexistent')
697 resp = h.getresponse()
698 self.assertEqual(resp.status, 404)
Brett Cannon252365b2011-08-04 22:43:11 -0700699 del server
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000700
Petri Lehtinene119c402011-10-26 21:29:15 +0300701 @unittest.skipIf(not hasattr(client, 'HTTPSConnection'),
702 'http.client.HTTPSConnection not available')
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200703 def test_host_port(self):
704 # Check invalid host_port
705
706 for hp in ("www.python.org:abc", "user:password@www.python.org"):
707 self.assertRaises(client.InvalidURL, client.HTTPSConnection, hp)
708
709 for hp, h, p in (("[fe80::207:e9ff:fe9b]:8000",
710 "fe80::207:e9ff:fe9b", 8000),
711 ("www.python.org:443", "www.python.org", 443),
712 ("www.python.org:", "www.python.org", 443),
713 ("www.python.org", "www.python.org", 443),
714 ("[fe80::207:e9ff:fe9b]", "fe80::207:e9ff:fe9b", 443),
715 ("[fe80::207:e9ff:fe9b]:", "fe80::207:e9ff:fe9b",
716 443)):
717 c = client.HTTPSConnection(hp)
718 self.assertEqual(h, c.host)
719 self.assertEqual(p, c.port)
720
Guido van Rossumd59da4b2007-05-22 18:11:13 +0000721
Jeremy Hylton236654b2009-03-27 20:24:34 +0000722class RequestBodyTest(TestCase):
723 """Test cases where a request includes a message body."""
724
725 def setUp(self):
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000726 self.conn = client.HTTPConnection('example.com')
Jeremy Hylton636950f2009-03-28 04:34:21 +0000727 self.conn.sock = self.sock = FakeSocket("")
Jeremy Hylton236654b2009-03-27 20:24:34 +0000728 self.conn.sock = self.sock
729
730 def get_headers_and_fp(self):
731 f = io.BytesIO(self.sock.data)
732 f.readline() # read the request line
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000733 message = client.parse_headers(f)
Jeremy Hylton236654b2009-03-27 20:24:34 +0000734 return message, f
735
736 def test_manual_content_length(self):
737 # Set an incorrect content-length so that we can verify that
738 # it will not be over-ridden by the library.
739 self.conn.request("PUT", "/url", "body",
740 {"Content-Length": "42"})
741 message, f = self.get_headers_and_fp()
742 self.assertEqual("42", message.get("content-length"))
743 self.assertEqual(4, len(f.read()))
744
745 def test_ascii_body(self):
746 self.conn.request("PUT", "/url", "body")
747 message, f = self.get_headers_and_fp()
748 self.assertEqual("text/plain", message.get_content_type())
Raymond Hettinger7beae8a2011-01-06 05:34:17 +0000749 self.assertIsNone(message.get_charset())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000750 self.assertEqual("4", message.get("content-length"))
751 self.assertEqual(b'body', f.read())
752
753 def test_latin1_body(self):
754 self.conn.request("PUT", "/url", "body\xc1")
755 message, f = self.get_headers_and_fp()
756 self.assertEqual("text/plain", message.get_content_type())
Raymond Hettinger7beae8a2011-01-06 05:34:17 +0000757 self.assertIsNone(message.get_charset())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000758 self.assertEqual("5", message.get("content-length"))
759 self.assertEqual(b'body\xc1', f.read())
760
761 def test_bytes_body(self):
762 self.conn.request("PUT", "/url", b"body\xc1")
763 message, f = self.get_headers_and_fp()
764 self.assertEqual("text/plain", message.get_content_type())
Raymond Hettinger7beae8a2011-01-06 05:34:17 +0000765 self.assertIsNone(message.get_charset())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000766 self.assertEqual("5", message.get("content-length"))
767 self.assertEqual(b'body\xc1', f.read())
768
769 def test_file_body(self):
Victor Stinner18d15cb2011-09-21 01:09:04 +0200770 self.addCleanup(support.unlink, support.TESTFN)
Brett Cannon77b7de62010-10-29 23:31:11 +0000771 with open(support.TESTFN, "w") as f:
772 f.write("body")
773 with open(support.TESTFN) as f:
774 self.conn.request("PUT", "/url", f)
775 message, f = self.get_headers_and_fp()
776 self.assertEqual("text/plain", message.get_content_type())
Raymond Hettinger7beae8a2011-01-06 05:34:17 +0000777 self.assertIsNone(message.get_charset())
Brett Cannon77b7de62010-10-29 23:31:11 +0000778 self.assertEqual("4", message.get("content-length"))
779 self.assertEqual(b'body', f.read())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000780
781 def test_binary_file_body(self):
Victor Stinner18d15cb2011-09-21 01:09:04 +0200782 self.addCleanup(support.unlink, support.TESTFN)
Brett Cannon77b7de62010-10-29 23:31:11 +0000783 with open(support.TESTFN, "wb") as f:
784 f.write(b"body\xc1")
785 with open(support.TESTFN, "rb") as f:
786 self.conn.request("PUT", "/url", f)
787 message, f = self.get_headers_and_fp()
788 self.assertEqual("text/plain", message.get_content_type())
Raymond Hettinger7beae8a2011-01-06 05:34:17 +0000789 self.assertIsNone(message.get_charset())
Brett Cannon77b7de62010-10-29 23:31:11 +0000790 self.assertEqual("5", message.get("content-length"))
791 self.assertEqual(b'body\xc1', f.read())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000792
Senthil Kumaran9f8dc442010-08-02 11:04:58 +0000793
794class HTTPResponseTest(TestCase):
795
796 def setUp(self):
797 body = "HTTP/1.1 200 Ok\r\nMy-Header: first-value\r\nMy-Header: \
798 second-value\r\n\r\nText"
799 sock = FakeSocket(body)
800 self.resp = client.HTTPResponse(sock)
801 self.resp.begin()
802
803 def test_getting_header(self):
804 header = self.resp.getheader('My-Header')
805 self.assertEqual(header, 'first-value, second-value')
806
807 header = self.resp.getheader('My-Header', 'some default')
808 self.assertEqual(header, 'first-value, second-value')
809
810 def test_getting_nonexistent_header_with_string_default(self):
811 header = self.resp.getheader('No-Such-Header', 'default-value')
812 self.assertEqual(header, 'default-value')
813
814 def test_getting_nonexistent_header_with_iterable_default(self):
815 header = self.resp.getheader('No-Such-Header', ['default', 'values'])
816 self.assertEqual(header, 'default, values')
817
818 header = self.resp.getheader('No-Such-Header', ('default', 'values'))
819 self.assertEqual(header, 'default, values')
820
821 def test_getting_nonexistent_header_without_default(self):
822 header = self.resp.getheader('No-Such-Header')
823 self.assertEqual(header, None)
824
825 def test_getting_header_defaultint(self):
826 header = self.resp.getheader('No-Such-Header',default=42)
827 self.assertEqual(header, 42)
828
Jeremy Hylton2c178252004-08-07 16:28:14 +0000829def test_main(verbose=None):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000830 support.run_unittest(HeaderTests, OfflineTest, BasicTest, TimeoutTest,
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000831 HTTPSTest, RequestBodyTest, SourceAddressTest,
Senthil Kumaran9f8dc442010-08-02 11:04:58 +0000832 HTTPResponseTest)
Jeremy Hylton2c178252004-08-07 16:28:14 +0000833
Thomas Wouters89f507f2006-12-13 04:49:30 +0000834if __name__ == '__main__':
835 test_main()