blob: 52dae951d1fa9072865a841b4bedf5d78e321422 [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')
Georg Brandl89644d02014-11-05 20:37:40 +010018# Self-signed cert file for self-signed.pythontest.net
19CERT_selfsigned_pythontestdotnet = os.path.join(here, 'selfsigned_pythontestdotnet.pem')
Antoine Pitrou803e6d62010-10-13 10:36:15 +000020
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
Georg Brandlf0746ca2014-09-30 14:08:04 +0200275 def test_too_many_headers(self):
276 headers = '\r\n'.join('Header%d: foo' % i
277 for i in range(client._MAXHEADERS + 1)) + '\r\n'
278 text = ('HTTP/1.1 200 OK\r\n' + headers)
279 s = FakeSocket(text)
280 r = client.HTTPResponse(s)
281 self.assertRaisesRegex(client.HTTPException,
282 r"got more than \d+ headers", r.begin)
283
Thomas Wouters89f507f2006-12-13 04:49:30 +0000284 def test_send_file(self):
Guido van Rossum022c4742007-08-29 02:00:20 +0000285 expected = (b'GET /foo HTTP/1.1\r\nHost: example.com\r\n'
286 b'Accept-Encoding: identity\r\nContent-Length:')
Thomas Wouters89f507f2006-12-13 04:49:30 +0000287
Brett Cannon77b7de62010-10-29 23:31:11 +0000288 with open(__file__, 'rb') as body:
289 conn = client.HTTPConnection('example.com')
290 sock = FakeSocket(body)
291 conn.sock = sock
292 conn.request('GET', '/foo', body)
293 self.assertTrue(sock.data.startswith(expected), '%r != %r' %
294 (sock.data[:len(expected)], expected))
Jeremy Hylton2c178252004-08-07 16:28:14 +0000295
Antoine Pitrouead1d622009-09-29 18:44:53 +0000296 def test_send(self):
297 expected = b'this is a test this is only a test'
298 conn = client.HTTPConnection('example.com')
299 sock = FakeSocket(None)
300 conn.sock = sock
301 conn.send(expected)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000302 self.assertEqual(expected, sock.data)
Antoine Pitrouead1d622009-09-29 18:44:53 +0000303 sock.data = b''
304 conn.send(array.array('b', expected))
Ezio Melottib3aedd42010-11-20 19:04:17 +0000305 self.assertEqual(expected, sock.data)
Antoine Pitrouead1d622009-09-29 18:44:53 +0000306 sock.data = b''
307 conn.send(io.BytesIO(expected))
Ezio Melottib3aedd42010-11-20 19:04:17 +0000308 self.assertEqual(expected, sock.data)
Antoine Pitrouead1d622009-09-29 18:44:53 +0000309
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000310 def test_send_iter(self):
311 expected = b'GET /foo HTTP/1.1\r\nHost: example.com\r\n' \
312 b'Accept-Encoding: identity\r\nContent-Length: 11\r\n' \
313 b'\r\nonetwothree'
314
315 def body():
316 yield b"one"
317 yield b"two"
318 yield b"three"
319
320 conn = client.HTTPConnection('example.com')
321 sock = FakeSocket("")
322 conn.sock = sock
323 conn.request('GET', '/foo', body(), {'Content-Length': '11'})
Victor Stinner04ba9662011-01-04 00:04:46 +0000324 self.assertEqual(sock.data, expected)
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000325
Senthil Kumaraneb71ad42011-08-02 18:33:41 +0800326 def test_send_type_error(self):
327 # See: Issue #12676
328 conn = client.HTTPConnection('example.com')
329 conn.sock = FakeSocket('')
330 with self.assertRaises(TypeError):
331 conn.request('POST', 'test', conn)
332
Christian Heimesa612dc02008-02-24 13:08:18 +0000333 def test_chunked(self):
334 chunked_start = (
335 'HTTP/1.1 200 OK\r\n'
336 'Transfer-Encoding: chunked\r\n\r\n'
337 'a\r\n'
338 'hello worl\r\n'
339 '1\r\n'
340 'd\r\n'
341 )
342 sock = FakeSocket(chunked_start + '0\r\n')
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000343 resp = client.HTTPResponse(sock, method="GET")
Christian Heimesa612dc02008-02-24 13:08:18 +0000344 resp.begin()
Ezio Melottib3aedd42010-11-20 19:04:17 +0000345 self.assertEqual(resp.read(), b'hello world')
Christian Heimesa612dc02008-02-24 13:08:18 +0000346 resp.close()
347
348 for x in ('', 'foo\r\n'):
349 sock = FakeSocket(chunked_start + x)
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000350 resp = client.HTTPResponse(sock, method="GET")
Christian Heimesa612dc02008-02-24 13:08:18 +0000351 resp.begin()
352 try:
353 resp.read()
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000354 except client.IncompleteRead as i:
Ezio Melottib3aedd42010-11-20 19:04:17 +0000355 self.assertEqual(i.partial, b'hello world')
Benjamin Peterson6accb982009-03-02 22:50:25 +0000356 self.assertEqual(repr(i),'IncompleteRead(11 bytes read)')
357 self.assertEqual(str(i),'IncompleteRead(11 bytes read)')
Christian Heimesa612dc02008-02-24 13:08:18 +0000358 else:
359 self.fail('IncompleteRead expected')
360 finally:
361 resp.close()
362
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000363 def test_chunked_head(self):
364 chunked_start = (
365 'HTTP/1.1 200 OK\r\n'
366 'Transfer-Encoding: chunked\r\n\r\n'
367 'a\r\n'
368 'hello world\r\n'
369 '1\r\n'
370 'd\r\n'
371 )
372 sock = FakeSocket(chunked_start + '0\r\n')
373 resp = client.HTTPResponse(sock, method="HEAD")
374 resp.begin()
Ezio Melottib3aedd42010-11-20 19:04:17 +0000375 self.assertEqual(resp.read(), b'')
376 self.assertEqual(resp.status, 200)
377 self.assertEqual(resp.reason, 'OK')
Senthil Kumaran0b998832010-06-04 17:27:11 +0000378 self.assertTrue(resp.isclosed())
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200379 self.assertFalse(resp.closed)
380 resp.close()
381 self.assertTrue(resp.closed)
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000382
Christian Heimesa612dc02008-02-24 13:08:18 +0000383 def test_negative_content_length(self):
Jeremy Hylton82066952008-12-15 03:08:30 +0000384 sock = FakeSocket(
385 'HTTP/1.1 200 OK\r\nContent-Length: -1\r\n\r\nHello\r\n')
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000386 resp = client.HTTPResponse(sock, method="GET")
Christian Heimesa612dc02008-02-24 13:08:18 +0000387 resp.begin()
Ezio Melottib3aedd42010-11-20 19:04:17 +0000388 self.assertEqual(resp.read(), b'Hello\r\n')
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100389 self.assertTrue(resp.isclosed())
Christian Heimesa612dc02008-02-24 13:08:18 +0000390
Benjamin Peterson6accb982009-03-02 22:50:25 +0000391 def test_incomplete_read(self):
392 sock = FakeSocket('HTTP/1.1 200 OK\r\nContent-Length: 10\r\n\r\nHello\r\n')
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000393 resp = client.HTTPResponse(sock, method="GET")
Benjamin Peterson6accb982009-03-02 22:50:25 +0000394 resp.begin()
395 try:
396 resp.read()
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000397 except client.IncompleteRead as i:
Ezio Melottib3aedd42010-11-20 19:04:17 +0000398 self.assertEqual(i.partial, b'Hello\r\n')
Benjamin Peterson6accb982009-03-02 22:50:25 +0000399 self.assertEqual(repr(i),
400 "IncompleteRead(7 bytes read, 3 more expected)")
401 self.assertEqual(str(i),
402 "IncompleteRead(7 bytes read, 3 more expected)")
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100403 self.assertTrue(resp.isclosed())
Benjamin Peterson6accb982009-03-02 22:50:25 +0000404 else:
405 self.fail('IncompleteRead expected')
Benjamin Peterson6accb982009-03-02 22:50:25 +0000406
Jeremy Hylton636950f2009-03-28 04:34:21 +0000407 def test_epipe(self):
408 sock = EPipeSocket(
409 "HTTP/1.0 401 Authorization Required\r\n"
410 "Content-type: text/html\r\n"
411 "WWW-Authenticate: Basic realm=\"example\"\r\n",
412 b"Content-Length")
413 conn = client.HTTPConnection("example.com")
414 conn.sock = sock
415 self.assertRaises(socket.error,
416 lambda: conn.request("PUT", "/url", "body"))
417 resp = conn.getresponse()
418 self.assertEqual(401, resp.status)
419 self.assertEqual("Basic realm=\"example\"",
420 resp.getheader("www-authenticate"))
Christian Heimesa612dc02008-02-24 13:08:18 +0000421
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000422 # Test lines overflowing the max line size (_MAXLINE in http.client)
423
424 def test_overflowing_status_line(self):
425 body = "HTTP/1.1 200 Ok" + "k" * 65536 + "\r\n"
426 resp = client.HTTPResponse(FakeSocket(body))
427 self.assertRaises((client.LineTooLong, client.BadStatusLine), resp.begin)
428
429 def test_overflowing_header_line(self):
430 body = (
431 'HTTP/1.1 200 OK\r\n'
432 'X-Foo: bar' + 'r' * 65536 + '\r\n\r\n'
433 )
434 resp = client.HTTPResponse(FakeSocket(body))
435 self.assertRaises(client.LineTooLong, resp.begin)
436
437 def test_overflowing_chunked_line(self):
438 body = (
439 'HTTP/1.1 200 OK\r\n'
440 'Transfer-Encoding: chunked\r\n\r\n'
441 + '0' * 65536 + 'a\r\n'
442 'hello world\r\n'
443 '0\r\n'
444 )
445 resp = client.HTTPResponse(FakeSocket(body))
446 resp.begin()
447 self.assertRaises(client.LineTooLong, resp.read)
448
Senthil Kumaran9c29f862012-04-29 10:20:46 +0800449 def test_early_eof(self):
450 # Test httpresponse with no \r\n termination,
451 body = "HTTP/1.1 200 Ok"
452 sock = FakeSocket(body)
453 resp = client.HTTPResponse(sock)
454 resp.begin()
455 self.assertEqual(resp.read(), b'')
456 self.assertTrue(resp.isclosed())
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200457 self.assertFalse(resp.closed)
458 resp.close()
459 self.assertTrue(resp.closed)
Senthil Kumaran9c29f862012-04-29 10:20:46 +0800460
Georg Brandl4cbd1e32006-02-17 22:01:08 +0000461class OfflineTest(TestCase):
462 def test_responses(self):
Ezio Melottib3aedd42010-11-20 19:04:17 +0000463 self.assertEqual(client.responses[client.NOT_FOUND], "Not Found")
Georg Brandl4cbd1e32006-02-17 22:01:08 +0000464
Gregory P. Smithb4066372010-01-03 03:28:29 +0000465
466class SourceAddressTest(TestCase):
467 def setUp(self):
468 self.serv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
469 self.port = support.bind_port(self.serv)
470 self.source_port = support.find_unused_port()
471 self.serv.listen(5)
472 self.conn = None
473
474 def tearDown(self):
475 if self.conn:
476 self.conn.close()
477 self.conn = None
478 self.serv.close()
479 self.serv = None
480
481 def testHTTPConnectionSourceAddress(self):
482 self.conn = client.HTTPConnection(HOST, self.port,
483 source_address=('', self.source_port))
484 self.conn.connect()
485 self.assertEqual(self.conn.sock.getsockname()[1], self.source_port)
486
487 @unittest.skipIf(not hasattr(client, 'HTTPSConnection'),
488 'http.client.HTTPSConnection not defined')
489 def testHTTPSConnectionSourceAddress(self):
490 self.conn = client.HTTPSConnection(HOST, self.port,
491 source_address=('', self.source_port))
492 # We don't test anything here other the constructor not barfing as
493 # this code doesn't deal with setting up an active running SSL server
494 # for an ssl_wrapped connect() to actually return from.
495
496
Guido van Rossumd8faa362007-04-27 19:54:29 +0000497class TimeoutTest(TestCase):
Christian Heimes5e696852008-04-09 08:37:03 +0000498 PORT = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000499
500 def setUp(self):
501 self.serv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000502 TimeoutTest.PORT = support.bind_port(self.serv)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000503 self.serv.listen(5)
504
505 def tearDown(self):
506 self.serv.close()
507 self.serv = None
508
509 def testTimeoutAttribute(self):
Jeremy Hylton3a38c912007-08-14 17:08:07 +0000510 # This will prove that the timeout gets through HTTPConnection
511 # and into the socket.
512
Georg Brandlf78e02b2008-06-10 17:40:04 +0000513 # default -- use global socket timeout
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000514 self.assertTrue(socket.getdefaulttimeout() is None)
Georg Brandlf78e02b2008-06-10 17:40:04 +0000515 socket.setdefaulttimeout(30)
516 try:
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000517 httpConn = client.HTTPConnection(HOST, TimeoutTest.PORT)
Georg Brandlf78e02b2008-06-10 17:40:04 +0000518 httpConn.connect()
519 finally:
520 socket.setdefaulttimeout(None)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000521 self.assertEqual(httpConn.sock.gettimeout(), 30)
522 httpConn.close()
523
Georg Brandlf78e02b2008-06-10 17:40:04 +0000524 # no timeout -- do not use global socket default
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000525 self.assertTrue(socket.getdefaulttimeout() is None)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000526 socket.setdefaulttimeout(30)
527 try:
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000528 httpConn = client.HTTPConnection(HOST, TimeoutTest.PORT,
Christian Heimes5e696852008-04-09 08:37:03 +0000529 timeout=None)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000530 httpConn.connect()
531 finally:
Georg Brandlf78e02b2008-06-10 17:40:04 +0000532 socket.setdefaulttimeout(None)
533 self.assertEqual(httpConn.sock.gettimeout(), None)
534 httpConn.close()
535
536 # a value
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000537 httpConn = client.HTTPConnection(HOST, TimeoutTest.PORT, timeout=30)
Georg Brandlf78e02b2008-06-10 17:40:04 +0000538 httpConn.connect()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000539 self.assertEqual(httpConn.sock.gettimeout(), 30)
540 httpConn.close()
541
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000542
543class HTTPSTest(TestCase):
544
545 def setUp(self):
546 if not hasattr(client, 'HTTPSConnection'):
547 self.skipTest('ssl support required')
548
549 def make_server(self, certfile):
550 from test.ssl_servers import make_https_server
551 return make_https_server(self, certfile)
Guido van Rossumd59da4b2007-05-22 18:11:13 +0000552
553 def test_attributes(self):
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000554 # simple test to check it's storing the timeout
555 h = client.HTTPSConnection(HOST, TimeoutTest.PORT, timeout=30)
556 self.assertEqual(h.timeout, 30)
557
558 def _check_svn_python_org(self, resp):
559 # Just a simple check that everything went fine
560 server_string = resp.getheader('server')
561 self.assertIn('Apache', server_string)
562
563 def test_networked(self):
564 # Default settings: no cert verification is done
565 support.requires('network')
566 with support.transient_internet('svn.python.org'):
567 h = client.HTTPSConnection('svn.python.org', 443)
568 h.request('GET', '/')
569 resp = h.getresponse()
570 self._check_svn_python_org(resp)
571
572 def test_networked_good_cert(self):
Georg Brandl89644d02014-11-05 20:37:40 +0100573 # We feed the server's cert as a validating cert
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000574 import ssl
575 support.requires('network')
Georg Brandl89644d02014-11-05 20:37:40 +0100576 with support.transient_internet('self-signed.pythontest.net'):
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000577 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
578 context.verify_mode = ssl.CERT_REQUIRED
Georg Brandl89644d02014-11-05 20:37:40 +0100579 context.load_verify_locations(CERT_selfsigned_pythontestdotnet)
580 h = client.HTTPSConnection('self-signed.pythontest.net', 443, context=context)
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000581 h.request('GET', '/')
582 resp = h.getresponse()
Georg Brandl89644d02014-11-05 20:37:40 +0100583 server_string = resp.getheader('server')
584 self.assertIn('nginx', server_string)
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000585
586 def test_networked_bad_cert(self):
587 # We feed a "CA" cert that is unrelated to the server's cert
588 import ssl
589 support.requires('network')
590 with support.transient_internet('svn.python.org'):
591 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
592 context.verify_mode = ssl.CERT_REQUIRED
593 context.load_verify_locations(CERT_localhost)
594 h = client.HTTPSConnection('svn.python.org', 443, context=context)
595 with self.assertRaises(ssl.SSLError):
596 h.request('GET', '/')
597
598 def test_local_good_hostname(self):
599 # The (valid) cert validates the HTTP hostname
600 import ssl
601 from test.ssl_servers import make_https_server
602 server = make_https_server(self, CERT_localhost)
603 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
604 context.verify_mode = ssl.CERT_REQUIRED
605 context.load_verify_locations(CERT_localhost)
606 h = client.HTTPSConnection('localhost', server.port, context=context)
607 h.request('GET', '/nonexistent')
608 resp = h.getresponse()
609 self.assertEqual(resp.status, 404)
610
611 def test_local_bad_hostname(self):
612 # The (valid) cert doesn't validate the HTTP hostname
613 import ssl
614 from test.ssl_servers import make_https_server
615 server = make_https_server(self, CERT_fakehostname)
616 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
617 context.verify_mode = ssl.CERT_REQUIRED
618 context.load_verify_locations(CERT_fakehostname)
619 h = client.HTTPSConnection('localhost', server.port, context=context)
620 with self.assertRaises(ssl.CertificateError):
621 h.request('GET', '/')
622 # Same with explicit check_hostname=True
623 h = client.HTTPSConnection('localhost', server.port, context=context,
624 check_hostname=True)
625 with self.assertRaises(ssl.CertificateError):
626 h.request('GET', '/')
627 # With check_hostname=False, the mismatching is ignored
628 h = client.HTTPSConnection('localhost', server.port, context=context,
629 check_hostname=False)
630 h.request('GET', '/nonexistent')
631 resp = h.getresponse()
632 self.assertEqual(resp.status, 404)
633
Petri Lehtinene119c402011-10-26 21:29:15 +0300634 @unittest.skipIf(not hasattr(client, 'HTTPSConnection'),
635 'http.client.HTTPSConnection not available')
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200636 def test_host_port(self):
637 # Check invalid host_port
638
639 for hp in ("www.python.org:abc", "user:password@www.python.org"):
640 self.assertRaises(client.InvalidURL, client.HTTPSConnection, hp)
641
642 for hp, h, p in (("[fe80::207:e9ff:fe9b]:8000",
643 "fe80::207:e9ff:fe9b", 8000),
644 ("www.python.org:443", "www.python.org", 443),
645 ("www.python.org:", "www.python.org", 443),
646 ("www.python.org", "www.python.org", 443),
647 ("[fe80::207:e9ff:fe9b]", "fe80::207:e9ff:fe9b", 443),
648 ("[fe80::207:e9ff:fe9b]:", "fe80::207:e9ff:fe9b",
649 443)):
650 c = client.HTTPSConnection(hp)
651 self.assertEqual(h, c.host)
652 self.assertEqual(p, c.port)
653
Guido van Rossumd59da4b2007-05-22 18:11:13 +0000654
Jeremy Hylton236654b2009-03-27 20:24:34 +0000655class RequestBodyTest(TestCase):
656 """Test cases where a request includes a message body."""
657
658 def setUp(self):
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000659 self.conn = client.HTTPConnection('example.com')
Jeremy Hylton636950f2009-03-28 04:34:21 +0000660 self.conn.sock = self.sock = FakeSocket("")
Jeremy Hylton236654b2009-03-27 20:24:34 +0000661 self.conn.sock = self.sock
662
663 def get_headers_and_fp(self):
664 f = io.BytesIO(self.sock.data)
665 f.readline() # read the request line
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000666 message = client.parse_headers(f)
Jeremy Hylton236654b2009-03-27 20:24:34 +0000667 return message, f
668
669 def test_manual_content_length(self):
670 # Set an incorrect content-length so that we can verify that
671 # it will not be over-ridden by the library.
672 self.conn.request("PUT", "/url", "body",
673 {"Content-Length": "42"})
674 message, f = self.get_headers_and_fp()
675 self.assertEqual("42", message.get("content-length"))
676 self.assertEqual(4, len(f.read()))
677
678 def test_ascii_body(self):
679 self.conn.request("PUT", "/url", "body")
680 message, f = self.get_headers_and_fp()
681 self.assertEqual("text/plain", message.get_content_type())
Raymond Hettinger7beae8a2011-01-06 05:34:17 +0000682 self.assertIsNone(message.get_charset())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000683 self.assertEqual("4", message.get("content-length"))
684 self.assertEqual(b'body', f.read())
685
686 def test_latin1_body(self):
687 self.conn.request("PUT", "/url", "body\xc1")
688 message, f = self.get_headers_and_fp()
689 self.assertEqual("text/plain", message.get_content_type())
Raymond Hettinger7beae8a2011-01-06 05:34:17 +0000690 self.assertIsNone(message.get_charset())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000691 self.assertEqual("5", message.get("content-length"))
692 self.assertEqual(b'body\xc1', f.read())
693
694 def test_bytes_body(self):
695 self.conn.request("PUT", "/url", b"body\xc1")
696 message, f = self.get_headers_and_fp()
697 self.assertEqual("text/plain", message.get_content_type())
Raymond Hettinger7beae8a2011-01-06 05:34:17 +0000698 self.assertIsNone(message.get_charset())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000699 self.assertEqual("5", message.get("content-length"))
700 self.assertEqual(b'body\xc1', f.read())
701
702 def test_file_body(self):
Victor Stinner18d15cb2011-09-21 01:09:04 +0200703 self.addCleanup(support.unlink, support.TESTFN)
Brett Cannon77b7de62010-10-29 23:31:11 +0000704 with open(support.TESTFN, "w") as f:
705 f.write("body")
706 with open(support.TESTFN) as f:
707 self.conn.request("PUT", "/url", f)
708 message, f = self.get_headers_and_fp()
709 self.assertEqual("text/plain", message.get_content_type())
Raymond Hettinger7beae8a2011-01-06 05:34:17 +0000710 self.assertIsNone(message.get_charset())
Brett Cannon77b7de62010-10-29 23:31:11 +0000711 self.assertEqual("4", message.get("content-length"))
712 self.assertEqual(b'body', f.read())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000713
714 def test_binary_file_body(self):
Victor Stinner18d15cb2011-09-21 01:09:04 +0200715 self.addCleanup(support.unlink, support.TESTFN)
Brett Cannon77b7de62010-10-29 23:31:11 +0000716 with open(support.TESTFN, "wb") as f:
717 f.write(b"body\xc1")
718 with open(support.TESTFN, "rb") as f:
719 self.conn.request("PUT", "/url", f)
720 message, f = self.get_headers_and_fp()
721 self.assertEqual("text/plain", message.get_content_type())
Raymond Hettinger7beae8a2011-01-06 05:34:17 +0000722 self.assertIsNone(message.get_charset())
Brett Cannon77b7de62010-10-29 23:31:11 +0000723 self.assertEqual("5", message.get("content-length"))
724 self.assertEqual(b'body\xc1', f.read())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000725
Senthil Kumaran9f8dc442010-08-02 11:04:58 +0000726
727class HTTPResponseTest(TestCase):
728
729 def setUp(self):
730 body = "HTTP/1.1 200 Ok\r\nMy-Header: first-value\r\nMy-Header: \
731 second-value\r\n\r\nText"
732 sock = FakeSocket(body)
733 self.resp = client.HTTPResponse(sock)
734 self.resp.begin()
735
736 def test_getting_header(self):
737 header = self.resp.getheader('My-Header')
738 self.assertEqual(header, 'first-value, second-value')
739
740 header = self.resp.getheader('My-Header', 'some default')
741 self.assertEqual(header, 'first-value, second-value')
742
743 def test_getting_nonexistent_header_with_string_default(self):
744 header = self.resp.getheader('No-Such-Header', 'default-value')
745 self.assertEqual(header, 'default-value')
746
747 def test_getting_nonexistent_header_with_iterable_default(self):
748 header = self.resp.getheader('No-Such-Header', ['default', 'values'])
749 self.assertEqual(header, 'default, values')
750
751 header = self.resp.getheader('No-Such-Header', ('default', 'values'))
752 self.assertEqual(header, 'default, values')
753
754 def test_getting_nonexistent_header_without_default(self):
755 header = self.resp.getheader('No-Such-Header')
756 self.assertEqual(header, None)
757
758 def test_getting_header_defaultint(self):
759 header = self.resp.getheader('No-Such-Header',default=42)
760 self.assertEqual(header, 42)
761
Jeremy Hylton2c178252004-08-07 16:28:14 +0000762def test_main(verbose=None):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000763 support.run_unittest(HeaderTests, OfflineTest, BasicTest, TimeoutTest,
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000764 HTTPSTest, RequestBodyTest, SourceAddressTest,
Senthil Kumaran9f8dc442010-08-02 11:04:58 +0000765 HTTPResponseTest)
Jeremy Hylton2c178252004-08-07 16:28:14 +0000766
Thomas Wouters89f507f2006-12-13 04:49:30 +0000767if __name__ == '__main__':
768 test_main()