blob: 420302c332c7011ba85c3d0606d20fcad6089492 [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())
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200167 self.assertFalse(resp.closed)
168 resp.close()
169 self.assertTrue(resp.closed)
Jeremy Hyltonba603192003-01-23 18:02:20 +0000170
Thomas Wouters89f507f2006-12-13 04:49:30 +0000171 body = "HTTP/1.1 400.100 Not Ok\r\n\r\nText"
172 sock = FakeSocket(body)
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000173 resp = client.HTTPResponse(sock)
174 self.assertRaises(client.BadStatusLine, resp.begin)
Jeremy Hyltonba603192003-01-23 18:02:20 +0000175
Benjamin Peterson11dbfd42010-03-21 22:50:04 +0000176 def test_bad_status_repr(self):
177 exc = client.BadStatusLine('')
Ezio Melottib3aedd42010-11-20 19:04:17 +0000178 self.assertEqual(repr(exc), '''BadStatusLine("\'\'",)''')
Benjamin Peterson11dbfd42010-03-21 22:50:04 +0000179
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000180 def test_partial_reads(self):
Antoine Pitrou084daa22012-12-15 19:11:54 +0100181 # if we have a length, the system knows when to close itself
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000182 # same behaviour than when we read the whole thing with read()
183 body = "HTTP/1.1 200 Ok\r\nContent-Length: 4\r\n\r\nText"
184 sock = FakeSocket(body)
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000185 resp = client.HTTPResponse(sock)
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000186 resp.begin()
187 self.assertEqual(resp.read(2), b'Te')
188 self.assertFalse(resp.isclosed())
189 self.assertEqual(resp.read(2), b'xt')
190 self.assertTrue(resp.isclosed())
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200191 self.assertFalse(resp.closed)
192 resp.close()
193 self.assertTrue(resp.closed)
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000194
Antoine Pitrou084daa22012-12-15 19:11:54 +0100195 def test_partial_reads_no_content_length(self):
196 # when no length is present, the socket should be gracefully closed when
197 # all data was read
198 body = "HTTP/1.1 200 Ok\r\n\r\nText"
199 sock = FakeSocket(body)
200 resp = client.HTTPResponse(sock)
201 resp.begin()
202 self.assertEqual(resp.read(2), b'Te')
203 self.assertFalse(resp.isclosed())
204 self.assertEqual(resp.read(2), b'xt')
205 self.assertEqual(resp.read(1), b'')
206 self.assertTrue(resp.isclosed())
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200207 self.assertFalse(resp.closed)
208 resp.close()
209 self.assertTrue(resp.closed)
Antoine Pitrou084daa22012-12-15 19:11:54 +0100210
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100211 def test_partial_reads_incomplete_body(self):
212 # if the server shuts down the connection before the whole
213 # content-length is delivered, the socket is gracefully closed
214 body = "HTTP/1.1 200 Ok\r\nContent-Length: 10\r\n\r\nText"
215 sock = FakeSocket(body)
216 resp = client.HTTPResponse(sock)
217 resp.begin()
218 self.assertEqual(resp.read(2), b'Te')
219 self.assertFalse(resp.isclosed())
220 self.assertEqual(resp.read(2), b'xt')
221 self.assertEqual(resp.read(1), b'')
222 self.assertTrue(resp.isclosed())
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200223 self.assertFalse(resp.closed)
224 resp.close()
225 self.assertTrue(resp.closed)
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100226
Thomas Wouters89f507f2006-12-13 04:49:30 +0000227 def test_host_port(self):
228 # Check invalid host_port
Jeremy Hyltonba603192003-01-23 18:02:20 +0000229
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200230 for hp in ("www.python.org:abc", "user:password@www.python.org"):
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000231 self.assertRaises(client.InvalidURL, client.HTTPConnection, hp)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000232
Jeremy Hylton3a38c912007-08-14 17:08:07 +0000233 for hp, h, p in (("[fe80::207:e9ff:fe9b]:8000",
234 "fe80::207:e9ff:fe9b", 8000),
Thomas Wouters89f507f2006-12-13 04:49:30 +0000235 ("www.python.org:80", "www.python.org", 80),
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200236 ("www.python.org:", "www.python.org", 80),
Thomas Wouters89f507f2006-12-13 04:49:30 +0000237 ("www.python.org", "www.python.org", 80),
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200238 ("[fe80::207:e9ff:fe9b]", "fe80::207:e9ff:fe9b", 80),
239 ("[fe80::207:e9ff:fe9b]:", "fe80::207:e9ff:fe9b", 80)):
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000240 c = client.HTTPConnection(hp)
Jeremy Hylton3a38c912007-08-14 17:08:07 +0000241 self.assertEqual(h, c.host)
242 self.assertEqual(p, c.port)
Skip Montanaro10e6e0e2004-09-14 16:32:02 +0000243
Thomas Wouters89f507f2006-12-13 04:49:30 +0000244 def test_response_headers(self):
245 # test response with multiple message headers with the same field name.
246 text = ('HTTP/1.1 200 OK\r\n'
Jeremy Hylton3a38c912007-08-14 17:08:07 +0000247 'Set-Cookie: Customer="WILE_E_COYOTE"; '
248 'Version="1"; Path="/acme"\r\n'
Thomas Wouters89f507f2006-12-13 04:49:30 +0000249 'Set-Cookie: Part_Number="Rocket_Launcher_0001"; Version="1";'
250 ' Path="/acme"\r\n'
251 '\r\n'
252 'No body\r\n')
253 hdr = ('Customer="WILE_E_COYOTE"; Version="1"; Path="/acme"'
254 ', '
255 'Part_Number="Rocket_Launcher_0001"; Version="1"; Path="/acme"')
256 s = FakeSocket(text)
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000257 r = client.HTTPResponse(s)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000258 r.begin()
259 cookies = r.getheader("Set-Cookie")
Jeremy Hylton3a38c912007-08-14 17:08:07 +0000260 self.assertEqual(cookies, hdr)
Jeremy Hyltonba603192003-01-23 18:02:20 +0000261
Thomas Wouters89f507f2006-12-13 04:49:30 +0000262 def test_read_head(self):
263 # Test that the library doesn't attempt to read any data
264 # from a HEAD request. (Tickles SF bug #622042.)
265 sock = FakeSocket(
266 'HTTP/1.1 200 OK\r\n'
267 'Content-Length: 14432\r\n'
268 '\r\n',
269 NoEOFStringIO)
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000270 resp = client.HTTPResponse(sock, method="HEAD")
Thomas Wouters89f507f2006-12-13 04:49:30 +0000271 resp.begin()
Guido van Rossuma00f1232007-09-12 19:43:09 +0000272 if resp.read():
Thomas Wouters89f507f2006-12-13 04:49:30 +0000273 self.fail("Did not expect response from HEAD request")
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000274
Thomas Wouters89f507f2006-12-13 04:49:30 +0000275 def test_send_file(self):
Guido van Rossum022c4742007-08-29 02:00:20 +0000276 expected = (b'GET /foo HTTP/1.1\r\nHost: example.com\r\n'
277 b'Accept-Encoding: identity\r\nContent-Length:')
Thomas Wouters89f507f2006-12-13 04:49:30 +0000278
Brett Cannon77b7de62010-10-29 23:31:11 +0000279 with open(__file__, 'rb') as body:
280 conn = client.HTTPConnection('example.com')
281 sock = FakeSocket(body)
282 conn.sock = sock
283 conn.request('GET', '/foo', body)
284 self.assertTrue(sock.data.startswith(expected), '%r != %r' %
285 (sock.data[:len(expected)], expected))
Jeremy Hylton2c178252004-08-07 16:28:14 +0000286
Antoine Pitrouead1d622009-09-29 18:44:53 +0000287 def test_send(self):
288 expected = b'this is a test this is only a test'
289 conn = client.HTTPConnection('example.com')
290 sock = FakeSocket(None)
291 conn.sock = sock
292 conn.send(expected)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000293 self.assertEqual(expected, sock.data)
Antoine Pitrouead1d622009-09-29 18:44:53 +0000294 sock.data = b''
295 conn.send(array.array('b', expected))
Ezio Melottib3aedd42010-11-20 19:04:17 +0000296 self.assertEqual(expected, sock.data)
Antoine Pitrouead1d622009-09-29 18:44:53 +0000297 sock.data = b''
298 conn.send(io.BytesIO(expected))
Ezio Melottib3aedd42010-11-20 19:04:17 +0000299 self.assertEqual(expected, sock.data)
Antoine Pitrouead1d622009-09-29 18:44:53 +0000300
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000301 def test_send_iter(self):
302 expected = b'GET /foo HTTP/1.1\r\nHost: example.com\r\n' \
303 b'Accept-Encoding: identity\r\nContent-Length: 11\r\n' \
304 b'\r\nonetwothree'
305
306 def body():
307 yield b"one"
308 yield b"two"
309 yield b"three"
310
311 conn = client.HTTPConnection('example.com')
312 sock = FakeSocket("")
313 conn.sock = sock
314 conn.request('GET', '/foo', body(), {'Content-Length': '11'})
Victor Stinner04ba9662011-01-04 00:04:46 +0000315 self.assertEqual(sock.data, expected)
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000316
Senthil Kumaraneb71ad42011-08-02 18:33:41 +0800317 def test_send_type_error(self):
318 # See: Issue #12676
319 conn = client.HTTPConnection('example.com')
320 conn.sock = FakeSocket('')
321 with self.assertRaises(TypeError):
322 conn.request('POST', 'test', conn)
323
Christian Heimesa612dc02008-02-24 13:08:18 +0000324 def test_chunked(self):
325 chunked_start = (
326 'HTTP/1.1 200 OK\r\n'
327 'Transfer-Encoding: chunked\r\n\r\n'
328 'a\r\n'
329 'hello worl\r\n'
330 '1\r\n'
331 'd\r\n'
332 )
333 sock = FakeSocket(chunked_start + '0\r\n')
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000334 resp = client.HTTPResponse(sock, method="GET")
Christian Heimesa612dc02008-02-24 13:08:18 +0000335 resp.begin()
Ezio Melottib3aedd42010-11-20 19:04:17 +0000336 self.assertEqual(resp.read(), b'hello world')
Christian Heimesa612dc02008-02-24 13:08:18 +0000337 resp.close()
338
339 for x in ('', 'foo\r\n'):
340 sock = FakeSocket(chunked_start + x)
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000341 resp = client.HTTPResponse(sock, method="GET")
Christian Heimesa612dc02008-02-24 13:08:18 +0000342 resp.begin()
343 try:
344 resp.read()
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000345 except client.IncompleteRead as i:
Ezio Melottib3aedd42010-11-20 19:04:17 +0000346 self.assertEqual(i.partial, b'hello world')
Benjamin Peterson6accb982009-03-02 22:50:25 +0000347 self.assertEqual(repr(i),'IncompleteRead(11 bytes read)')
348 self.assertEqual(str(i),'IncompleteRead(11 bytes read)')
Christian Heimesa612dc02008-02-24 13:08:18 +0000349 else:
350 self.fail('IncompleteRead expected')
351 finally:
352 resp.close()
353
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000354 def test_chunked_head(self):
355 chunked_start = (
356 'HTTP/1.1 200 OK\r\n'
357 'Transfer-Encoding: chunked\r\n\r\n'
358 'a\r\n'
359 'hello world\r\n'
360 '1\r\n'
361 'd\r\n'
362 )
363 sock = FakeSocket(chunked_start + '0\r\n')
364 resp = client.HTTPResponse(sock, method="HEAD")
365 resp.begin()
Ezio Melottib3aedd42010-11-20 19:04:17 +0000366 self.assertEqual(resp.read(), b'')
367 self.assertEqual(resp.status, 200)
368 self.assertEqual(resp.reason, 'OK')
Senthil Kumaran0b998832010-06-04 17:27:11 +0000369 self.assertTrue(resp.isclosed())
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200370 self.assertFalse(resp.closed)
371 resp.close()
372 self.assertTrue(resp.closed)
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000373
Christian Heimesa612dc02008-02-24 13:08:18 +0000374 def test_negative_content_length(self):
Jeremy Hylton82066952008-12-15 03:08:30 +0000375 sock = FakeSocket(
376 'HTTP/1.1 200 OK\r\nContent-Length: -1\r\n\r\nHello\r\n')
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000377 resp = client.HTTPResponse(sock, method="GET")
Christian Heimesa612dc02008-02-24 13:08:18 +0000378 resp.begin()
Ezio Melottib3aedd42010-11-20 19:04:17 +0000379 self.assertEqual(resp.read(), b'Hello\r\n')
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100380 self.assertTrue(resp.isclosed())
Christian Heimesa612dc02008-02-24 13:08:18 +0000381
Benjamin Peterson6accb982009-03-02 22:50:25 +0000382 def test_incomplete_read(self):
383 sock = FakeSocket('HTTP/1.1 200 OK\r\nContent-Length: 10\r\n\r\nHello\r\n')
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000384 resp = client.HTTPResponse(sock, method="GET")
Benjamin Peterson6accb982009-03-02 22:50:25 +0000385 resp.begin()
386 try:
387 resp.read()
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000388 except client.IncompleteRead as i:
Ezio Melottib3aedd42010-11-20 19:04:17 +0000389 self.assertEqual(i.partial, b'Hello\r\n')
Benjamin Peterson6accb982009-03-02 22:50:25 +0000390 self.assertEqual(repr(i),
391 "IncompleteRead(7 bytes read, 3 more expected)")
392 self.assertEqual(str(i),
393 "IncompleteRead(7 bytes read, 3 more expected)")
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100394 self.assertTrue(resp.isclosed())
Benjamin Peterson6accb982009-03-02 22:50:25 +0000395 else:
396 self.fail('IncompleteRead expected')
Benjamin Peterson6accb982009-03-02 22:50:25 +0000397
Jeremy Hylton636950f2009-03-28 04:34:21 +0000398 def test_epipe(self):
399 sock = EPipeSocket(
400 "HTTP/1.0 401 Authorization Required\r\n"
401 "Content-type: text/html\r\n"
402 "WWW-Authenticate: Basic realm=\"example\"\r\n",
403 b"Content-Length")
404 conn = client.HTTPConnection("example.com")
405 conn.sock = sock
406 self.assertRaises(socket.error,
407 lambda: conn.request("PUT", "/url", "body"))
408 resp = conn.getresponse()
409 self.assertEqual(401, resp.status)
410 self.assertEqual("Basic realm=\"example\"",
411 resp.getheader("www-authenticate"))
Christian Heimesa612dc02008-02-24 13:08:18 +0000412
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000413 # Test lines overflowing the max line size (_MAXLINE in http.client)
414
415 def test_overflowing_status_line(self):
416 body = "HTTP/1.1 200 Ok" + "k" * 65536 + "\r\n"
417 resp = client.HTTPResponse(FakeSocket(body))
418 self.assertRaises((client.LineTooLong, client.BadStatusLine), resp.begin)
419
420 def test_overflowing_header_line(self):
421 body = (
422 'HTTP/1.1 200 OK\r\n'
423 'X-Foo: bar' + 'r' * 65536 + '\r\n\r\n'
424 )
425 resp = client.HTTPResponse(FakeSocket(body))
426 self.assertRaises(client.LineTooLong, resp.begin)
427
428 def test_overflowing_chunked_line(self):
429 body = (
430 'HTTP/1.1 200 OK\r\n'
431 'Transfer-Encoding: chunked\r\n\r\n'
432 + '0' * 65536 + 'a\r\n'
433 'hello world\r\n'
434 '0\r\n'
435 )
436 resp = client.HTTPResponse(FakeSocket(body))
437 resp.begin()
438 self.assertRaises(client.LineTooLong, resp.read)
439
Senthil Kumaran9c29f862012-04-29 10:20:46 +0800440 def test_early_eof(self):
441 # Test httpresponse with no \r\n termination,
442 body = "HTTP/1.1 200 Ok"
443 sock = FakeSocket(body)
444 resp = client.HTTPResponse(sock)
445 resp.begin()
446 self.assertEqual(resp.read(), b'')
447 self.assertTrue(resp.isclosed())
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200448 self.assertFalse(resp.closed)
449 resp.close()
450 self.assertTrue(resp.closed)
Senthil Kumaran9c29f862012-04-29 10:20:46 +0800451
Georg Brandl4cbd1e32006-02-17 22:01:08 +0000452class OfflineTest(TestCase):
453 def test_responses(self):
Ezio Melottib3aedd42010-11-20 19:04:17 +0000454 self.assertEqual(client.responses[client.NOT_FOUND], "Not Found")
Georg Brandl4cbd1e32006-02-17 22:01:08 +0000455
Gregory P. Smithb4066372010-01-03 03:28:29 +0000456
457class SourceAddressTest(TestCase):
458 def setUp(self):
459 self.serv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
460 self.port = support.bind_port(self.serv)
461 self.source_port = support.find_unused_port()
462 self.serv.listen(5)
463 self.conn = None
464
465 def tearDown(self):
466 if self.conn:
467 self.conn.close()
468 self.conn = None
469 self.serv.close()
470 self.serv = None
471
472 def testHTTPConnectionSourceAddress(self):
473 self.conn = client.HTTPConnection(HOST, self.port,
474 source_address=('', self.source_port))
475 self.conn.connect()
476 self.assertEqual(self.conn.sock.getsockname()[1], self.source_port)
477
478 @unittest.skipIf(not hasattr(client, 'HTTPSConnection'),
479 'http.client.HTTPSConnection not defined')
480 def testHTTPSConnectionSourceAddress(self):
481 self.conn = client.HTTPSConnection(HOST, self.port,
482 source_address=('', self.source_port))
483 # We don't test anything here other the constructor not barfing as
484 # this code doesn't deal with setting up an active running SSL server
485 # for an ssl_wrapped connect() to actually return from.
486
487
Guido van Rossumd8faa362007-04-27 19:54:29 +0000488class TimeoutTest(TestCase):
Christian Heimes5e696852008-04-09 08:37:03 +0000489 PORT = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000490
491 def setUp(self):
492 self.serv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000493 TimeoutTest.PORT = support.bind_port(self.serv)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000494 self.serv.listen(5)
495
496 def tearDown(self):
497 self.serv.close()
498 self.serv = None
499
500 def testTimeoutAttribute(self):
Jeremy Hylton3a38c912007-08-14 17:08:07 +0000501 # This will prove that the timeout gets through HTTPConnection
502 # and into the socket.
503
Georg Brandlf78e02b2008-06-10 17:40:04 +0000504 # default -- use global socket timeout
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000505 self.assertTrue(socket.getdefaulttimeout() is None)
Georg Brandlf78e02b2008-06-10 17:40:04 +0000506 socket.setdefaulttimeout(30)
507 try:
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000508 httpConn = client.HTTPConnection(HOST, TimeoutTest.PORT)
Georg Brandlf78e02b2008-06-10 17:40:04 +0000509 httpConn.connect()
510 finally:
511 socket.setdefaulttimeout(None)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000512 self.assertEqual(httpConn.sock.gettimeout(), 30)
513 httpConn.close()
514
Georg Brandlf78e02b2008-06-10 17:40:04 +0000515 # no timeout -- do not use global socket default
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000516 self.assertTrue(socket.getdefaulttimeout() is None)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000517 socket.setdefaulttimeout(30)
518 try:
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000519 httpConn = client.HTTPConnection(HOST, TimeoutTest.PORT,
Christian Heimes5e696852008-04-09 08:37:03 +0000520 timeout=None)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000521 httpConn.connect()
522 finally:
Georg Brandlf78e02b2008-06-10 17:40:04 +0000523 socket.setdefaulttimeout(None)
524 self.assertEqual(httpConn.sock.gettimeout(), None)
525 httpConn.close()
526
527 # a value
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000528 httpConn = client.HTTPConnection(HOST, TimeoutTest.PORT, timeout=30)
Georg Brandlf78e02b2008-06-10 17:40:04 +0000529 httpConn.connect()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000530 self.assertEqual(httpConn.sock.gettimeout(), 30)
531 httpConn.close()
532
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000533
534class HTTPSTest(TestCase):
535
536 def setUp(self):
537 if not hasattr(client, 'HTTPSConnection'):
538 self.skipTest('ssl support required')
539
540 def make_server(self, certfile):
541 from test.ssl_servers import make_https_server
542 return make_https_server(self, certfile)
Guido van Rossumd59da4b2007-05-22 18:11:13 +0000543
544 def test_attributes(self):
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000545 # simple test to check it's storing the timeout
546 h = client.HTTPSConnection(HOST, TimeoutTest.PORT, timeout=30)
547 self.assertEqual(h.timeout, 30)
548
549 def _check_svn_python_org(self, resp):
550 # Just a simple check that everything went fine
551 server_string = resp.getheader('server')
552 self.assertIn('Apache', server_string)
553
554 def test_networked(self):
555 # Default settings: no cert verification is done
556 support.requires('network')
557 with support.transient_internet('svn.python.org'):
558 h = client.HTTPSConnection('svn.python.org', 443)
559 h.request('GET', '/')
560 resp = h.getresponse()
561 self._check_svn_python_org(resp)
562
563 def test_networked_good_cert(self):
564 # We feed a CA cert that validates the server's cert
565 import ssl
566 support.requires('network')
567 with support.transient_internet('svn.python.org'):
568 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
569 context.verify_mode = ssl.CERT_REQUIRED
570 context.load_verify_locations(CACERT_svn_python_org)
571 h = client.HTTPSConnection('svn.python.org', 443, context=context)
572 h.request('GET', '/')
573 resp = h.getresponse()
574 self._check_svn_python_org(resp)
575
576 def test_networked_bad_cert(self):
577 # We feed a "CA" cert that is unrelated to the server's cert
578 import ssl
579 support.requires('network')
580 with support.transient_internet('svn.python.org'):
581 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
582 context.verify_mode = ssl.CERT_REQUIRED
583 context.load_verify_locations(CERT_localhost)
584 h = client.HTTPSConnection('svn.python.org', 443, context=context)
585 with self.assertRaises(ssl.SSLError):
586 h.request('GET', '/')
587
588 def test_local_good_hostname(self):
589 # The (valid) cert validates the HTTP hostname
590 import ssl
591 from test.ssl_servers import make_https_server
592 server = make_https_server(self, CERT_localhost)
593 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
594 context.verify_mode = ssl.CERT_REQUIRED
595 context.load_verify_locations(CERT_localhost)
596 h = client.HTTPSConnection('localhost', server.port, context=context)
597 h.request('GET', '/nonexistent')
598 resp = h.getresponse()
599 self.assertEqual(resp.status, 404)
600
601 def test_local_bad_hostname(self):
602 # The (valid) cert doesn't validate the HTTP hostname
603 import ssl
604 from test.ssl_servers import make_https_server
605 server = make_https_server(self, CERT_fakehostname)
606 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
607 context.verify_mode = ssl.CERT_REQUIRED
608 context.load_verify_locations(CERT_fakehostname)
609 h = client.HTTPSConnection('localhost', server.port, context=context)
610 with self.assertRaises(ssl.CertificateError):
611 h.request('GET', '/')
612 # Same with explicit check_hostname=True
613 h = client.HTTPSConnection('localhost', server.port, context=context,
614 check_hostname=True)
615 with self.assertRaises(ssl.CertificateError):
616 h.request('GET', '/')
617 # With check_hostname=False, the mismatching is ignored
618 h = client.HTTPSConnection('localhost', server.port, context=context,
619 check_hostname=False)
620 h.request('GET', '/nonexistent')
621 resp = h.getresponse()
622 self.assertEqual(resp.status, 404)
623
Petri Lehtinene119c402011-10-26 21:29:15 +0300624 @unittest.skipIf(not hasattr(client, 'HTTPSConnection'),
625 'http.client.HTTPSConnection not available')
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200626 def test_host_port(self):
627 # Check invalid host_port
628
629 for hp in ("www.python.org:abc", "user:password@www.python.org"):
630 self.assertRaises(client.InvalidURL, client.HTTPSConnection, hp)
631
632 for hp, h, p in (("[fe80::207:e9ff:fe9b]:8000",
633 "fe80::207:e9ff:fe9b", 8000),
634 ("www.python.org:443", "www.python.org", 443),
635 ("www.python.org:", "www.python.org", 443),
636 ("www.python.org", "www.python.org", 443),
637 ("[fe80::207:e9ff:fe9b]", "fe80::207:e9ff:fe9b", 443),
638 ("[fe80::207:e9ff:fe9b]:", "fe80::207:e9ff:fe9b",
639 443)):
640 c = client.HTTPSConnection(hp)
641 self.assertEqual(h, c.host)
642 self.assertEqual(p, c.port)
643
Guido van Rossumd59da4b2007-05-22 18:11:13 +0000644
Jeremy Hylton236654b2009-03-27 20:24:34 +0000645class RequestBodyTest(TestCase):
646 """Test cases where a request includes a message body."""
647
648 def setUp(self):
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000649 self.conn = client.HTTPConnection('example.com')
Jeremy Hylton636950f2009-03-28 04:34:21 +0000650 self.conn.sock = self.sock = FakeSocket("")
Jeremy Hylton236654b2009-03-27 20:24:34 +0000651 self.conn.sock = self.sock
652
653 def get_headers_and_fp(self):
654 f = io.BytesIO(self.sock.data)
655 f.readline() # read the request line
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000656 message = client.parse_headers(f)
Jeremy Hylton236654b2009-03-27 20:24:34 +0000657 return message, f
658
659 def test_manual_content_length(self):
660 # Set an incorrect content-length so that we can verify that
661 # it will not be over-ridden by the library.
662 self.conn.request("PUT", "/url", "body",
663 {"Content-Length": "42"})
664 message, f = self.get_headers_and_fp()
665 self.assertEqual("42", message.get("content-length"))
666 self.assertEqual(4, len(f.read()))
667
668 def test_ascii_body(self):
669 self.conn.request("PUT", "/url", "body")
670 message, f = self.get_headers_and_fp()
671 self.assertEqual("text/plain", message.get_content_type())
Raymond Hettinger7beae8a2011-01-06 05:34:17 +0000672 self.assertIsNone(message.get_charset())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000673 self.assertEqual("4", message.get("content-length"))
674 self.assertEqual(b'body', f.read())
675
676 def test_latin1_body(self):
677 self.conn.request("PUT", "/url", "body\xc1")
678 message, f = self.get_headers_and_fp()
679 self.assertEqual("text/plain", message.get_content_type())
Raymond Hettinger7beae8a2011-01-06 05:34:17 +0000680 self.assertIsNone(message.get_charset())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000681 self.assertEqual("5", message.get("content-length"))
682 self.assertEqual(b'body\xc1', f.read())
683
684 def test_bytes_body(self):
685 self.conn.request("PUT", "/url", b"body\xc1")
686 message, f = self.get_headers_and_fp()
687 self.assertEqual("text/plain", message.get_content_type())
Raymond Hettinger7beae8a2011-01-06 05:34:17 +0000688 self.assertIsNone(message.get_charset())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000689 self.assertEqual("5", message.get("content-length"))
690 self.assertEqual(b'body\xc1', f.read())
691
692 def test_file_body(self):
Victor Stinner18d15cb2011-09-21 01:09:04 +0200693 self.addCleanup(support.unlink, support.TESTFN)
Brett Cannon77b7de62010-10-29 23:31:11 +0000694 with open(support.TESTFN, "w") as f:
695 f.write("body")
696 with open(support.TESTFN) as f:
697 self.conn.request("PUT", "/url", f)
698 message, f = self.get_headers_and_fp()
699 self.assertEqual("text/plain", message.get_content_type())
Raymond Hettinger7beae8a2011-01-06 05:34:17 +0000700 self.assertIsNone(message.get_charset())
Brett Cannon77b7de62010-10-29 23:31:11 +0000701 self.assertEqual("4", message.get("content-length"))
702 self.assertEqual(b'body', f.read())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000703
704 def test_binary_file_body(self):
Victor Stinner18d15cb2011-09-21 01:09:04 +0200705 self.addCleanup(support.unlink, support.TESTFN)
Brett Cannon77b7de62010-10-29 23:31:11 +0000706 with open(support.TESTFN, "wb") as f:
707 f.write(b"body\xc1")
708 with open(support.TESTFN, "rb") as f:
709 self.conn.request("PUT", "/url", f)
710 message, f = self.get_headers_and_fp()
711 self.assertEqual("text/plain", message.get_content_type())
Raymond Hettinger7beae8a2011-01-06 05:34:17 +0000712 self.assertIsNone(message.get_charset())
Brett Cannon77b7de62010-10-29 23:31:11 +0000713 self.assertEqual("5", message.get("content-length"))
714 self.assertEqual(b'body\xc1', f.read())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000715
Senthil Kumaran9f8dc442010-08-02 11:04:58 +0000716
717class HTTPResponseTest(TestCase):
718
719 def setUp(self):
720 body = "HTTP/1.1 200 Ok\r\nMy-Header: first-value\r\nMy-Header: \
721 second-value\r\n\r\nText"
722 sock = FakeSocket(body)
723 self.resp = client.HTTPResponse(sock)
724 self.resp.begin()
725
726 def test_getting_header(self):
727 header = self.resp.getheader('My-Header')
728 self.assertEqual(header, 'first-value, second-value')
729
730 header = self.resp.getheader('My-Header', 'some default')
731 self.assertEqual(header, 'first-value, second-value')
732
733 def test_getting_nonexistent_header_with_string_default(self):
734 header = self.resp.getheader('No-Such-Header', 'default-value')
735 self.assertEqual(header, 'default-value')
736
737 def test_getting_nonexistent_header_with_iterable_default(self):
738 header = self.resp.getheader('No-Such-Header', ['default', 'values'])
739 self.assertEqual(header, 'default, values')
740
741 header = self.resp.getheader('No-Such-Header', ('default', 'values'))
742 self.assertEqual(header, 'default, values')
743
744 def test_getting_nonexistent_header_without_default(self):
745 header = self.resp.getheader('No-Such-Header')
746 self.assertEqual(header, None)
747
748 def test_getting_header_defaultint(self):
749 header = self.resp.getheader('No-Such-Header',default=42)
750 self.assertEqual(header, 42)
751
Jeremy Hylton2c178252004-08-07 16:28:14 +0000752def test_main(verbose=None):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000753 support.run_unittest(HeaderTests, OfflineTest, BasicTest, TimeoutTest,
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000754 HTTPSTest, RequestBodyTest, SourceAddressTest,
Senthil Kumaran9f8dc442010-08-02 11:04:58 +0000755 HTTPResponseTest)
Jeremy Hylton2c178252004-08-07 16:28:14 +0000756
Thomas Wouters89f507f2006-12-13 04:49:30 +0000757if __name__ == '__main__':
758 test_main()