blob: b0777d42867c4f88dd644f17f61c43f0a5dc9150 [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):
Antoine Pitrou084daa22012-12-15 19:11:54 +0100178 # if we have a length, the system knows when to close itself
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000179 # 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 Pitrou084daa22012-12-15 19:11:54 +0100189 def test_partial_reads_no_content_length(self):
190 # when no length is present, the socket should be gracefully closed when
191 # all data was read
192 body = "HTTP/1.1 200 Ok\r\n\r\nText"
193 sock = FakeSocket(body)
194 resp = client.HTTPResponse(sock)
195 resp.begin()
196 self.assertEqual(resp.read(2), b'Te')
197 self.assertFalse(resp.isclosed())
198 self.assertEqual(resp.read(2), b'xt')
199 self.assertEqual(resp.read(1), b'')
200 self.assertTrue(resp.isclosed())
201
Thomas Wouters89f507f2006-12-13 04:49:30 +0000202 def test_host_port(self):
203 # Check invalid host_port
Jeremy Hyltonba603192003-01-23 18:02:20 +0000204
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200205 for hp in ("www.python.org:abc", "user:password@www.python.org"):
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000206 self.assertRaises(client.InvalidURL, client.HTTPConnection, hp)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000207
Jeremy Hylton3a38c912007-08-14 17:08:07 +0000208 for hp, h, p in (("[fe80::207:e9ff:fe9b]:8000",
209 "fe80::207:e9ff:fe9b", 8000),
Thomas Wouters89f507f2006-12-13 04:49:30 +0000210 ("www.python.org:80", "www.python.org", 80),
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200211 ("www.python.org:", "www.python.org", 80),
Thomas Wouters89f507f2006-12-13 04:49:30 +0000212 ("www.python.org", "www.python.org", 80),
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200213 ("[fe80::207:e9ff:fe9b]", "fe80::207:e9ff:fe9b", 80),
214 ("[fe80::207:e9ff:fe9b]:", "fe80::207:e9ff:fe9b", 80)):
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000215 c = client.HTTPConnection(hp)
Jeremy Hylton3a38c912007-08-14 17:08:07 +0000216 self.assertEqual(h, c.host)
217 self.assertEqual(p, c.port)
Skip Montanaro10e6e0e2004-09-14 16:32:02 +0000218
Thomas Wouters89f507f2006-12-13 04:49:30 +0000219 def test_response_headers(self):
220 # test response with multiple message headers with the same field name.
221 text = ('HTTP/1.1 200 OK\r\n'
Jeremy Hylton3a38c912007-08-14 17:08:07 +0000222 'Set-Cookie: Customer="WILE_E_COYOTE"; '
223 'Version="1"; Path="/acme"\r\n'
Thomas Wouters89f507f2006-12-13 04:49:30 +0000224 'Set-Cookie: Part_Number="Rocket_Launcher_0001"; Version="1";'
225 ' Path="/acme"\r\n'
226 '\r\n'
227 'No body\r\n')
228 hdr = ('Customer="WILE_E_COYOTE"; Version="1"; Path="/acme"'
229 ', '
230 'Part_Number="Rocket_Launcher_0001"; Version="1"; Path="/acme"')
231 s = FakeSocket(text)
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000232 r = client.HTTPResponse(s)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000233 r.begin()
234 cookies = r.getheader("Set-Cookie")
Jeremy Hylton3a38c912007-08-14 17:08:07 +0000235 self.assertEqual(cookies, hdr)
Jeremy Hyltonba603192003-01-23 18:02:20 +0000236
Thomas Wouters89f507f2006-12-13 04:49:30 +0000237 def test_read_head(self):
238 # Test that the library doesn't attempt to read any data
239 # from a HEAD request. (Tickles SF bug #622042.)
240 sock = FakeSocket(
241 'HTTP/1.1 200 OK\r\n'
242 'Content-Length: 14432\r\n'
243 '\r\n',
244 NoEOFStringIO)
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000245 resp = client.HTTPResponse(sock, method="HEAD")
Thomas Wouters89f507f2006-12-13 04:49:30 +0000246 resp.begin()
Guido van Rossuma00f1232007-09-12 19:43:09 +0000247 if resp.read():
Thomas Wouters89f507f2006-12-13 04:49:30 +0000248 self.fail("Did not expect response from HEAD request")
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000249
Thomas Wouters89f507f2006-12-13 04:49:30 +0000250 def test_send_file(self):
Guido van Rossum022c4742007-08-29 02:00:20 +0000251 expected = (b'GET /foo HTTP/1.1\r\nHost: example.com\r\n'
252 b'Accept-Encoding: identity\r\nContent-Length:')
Thomas Wouters89f507f2006-12-13 04:49:30 +0000253
Brett Cannon77b7de62010-10-29 23:31:11 +0000254 with open(__file__, 'rb') as body:
255 conn = client.HTTPConnection('example.com')
256 sock = FakeSocket(body)
257 conn.sock = sock
258 conn.request('GET', '/foo', body)
259 self.assertTrue(sock.data.startswith(expected), '%r != %r' %
260 (sock.data[:len(expected)], expected))
Jeremy Hylton2c178252004-08-07 16:28:14 +0000261
Antoine Pitrouead1d622009-09-29 18:44:53 +0000262 def test_send(self):
263 expected = b'this is a test this is only a test'
264 conn = client.HTTPConnection('example.com')
265 sock = FakeSocket(None)
266 conn.sock = sock
267 conn.send(expected)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000268 self.assertEqual(expected, sock.data)
Antoine Pitrouead1d622009-09-29 18:44:53 +0000269 sock.data = b''
270 conn.send(array.array('b', expected))
Ezio Melottib3aedd42010-11-20 19:04:17 +0000271 self.assertEqual(expected, sock.data)
Antoine Pitrouead1d622009-09-29 18:44:53 +0000272 sock.data = b''
273 conn.send(io.BytesIO(expected))
Ezio Melottib3aedd42010-11-20 19:04:17 +0000274 self.assertEqual(expected, sock.data)
Antoine Pitrouead1d622009-09-29 18:44:53 +0000275
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000276 def test_send_iter(self):
277 expected = b'GET /foo HTTP/1.1\r\nHost: example.com\r\n' \
278 b'Accept-Encoding: identity\r\nContent-Length: 11\r\n' \
279 b'\r\nonetwothree'
280
281 def body():
282 yield b"one"
283 yield b"two"
284 yield b"three"
285
286 conn = client.HTTPConnection('example.com')
287 sock = FakeSocket("")
288 conn.sock = sock
289 conn.request('GET', '/foo', body(), {'Content-Length': '11'})
Victor Stinner04ba9662011-01-04 00:04:46 +0000290 self.assertEqual(sock.data, expected)
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000291
Senthil Kumaraneb71ad42011-08-02 18:33:41 +0800292 def test_send_type_error(self):
293 # See: Issue #12676
294 conn = client.HTTPConnection('example.com')
295 conn.sock = FakeSocket('')
296 with self.assertRaises(TypeError):
297 conn.request('POST', 'test', conn)
298
Christian Heimesa612dc02008-02-24 13:08:18 +0000299 def test_chunked(self):
300 chunked_start = (
301 'HTTP/1.1 200 OK\r\n'
302 'Transfer-Encoding: chunked\r\n\r\n'
303 'a\r\n'
304 'hello worl\r\n'
305 '1\r\n'
306 'd\r\n'
307 )
308 sock = FakeSocket(chunked_start + '0\r\n')
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000309 resp = client.HTTPResponse(sock, method="GET")
Christian Heimesa612dc02008-02-24 13:08:18 +0000310 resp.begin()
Ezio Melottib3aedd42010-11-20 19:04:17 +0000311 self.assertEqual(resp.read(), b'hello world')
Christian Heimesa612dc02008-02-24 13:08:18 +0000312 resp.close()
313
314 for x in ('', 'foo\r\n'):
315 sock = FakeSocket(chunked_start + x)
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000316 resp = client.HTTPResponse(sock, method="GET")
Christian Heimesa612dc02008-02-24 13:08:18 +0000317 resp.begin()
318 try:
319 resp.read()
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000320 except client.IncompleteRead as i:
Ezio Melottib3aedd42010-11-20 19:04:17 +0000321 self.assertEqual(i.partial, b'hello world')
Benjamin Peterson6accb982009-03-02 22:50:25 +0000322 self.assertEqual(repr(i),'IncompleteRead(11 bytes read)')
323 self.assertEqual(str(i),'IncompleteRead(11 bytes read)')
Christian Heimesa612dc02008-02-24 13:08:18 +0000324 else:
325 self.fail('IncompleteRead expected')
326 finally:
327 resp.close()
328
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000329 def test_chunked_head(self):
330 chunked_start = (
331 'HTTP/1.1 200 OK\r\n'
332 'Transfer-Encoding: chunked\r\n\r\n'
333 'a\r\n'
334 'hello world\r\n'
335 '1\r\n'
336 'd\r\n'
337 )
338 sock = FakeSocket(chunked_start + '0\r\n')
339 resp = client.HTTPResponse(sock, method="HEAD")
340 resp.begin()
Ezio Melottib3aedd42010-11-20 19:04:17 +0000341 self.assertEqual(resp.read(), b'')
342 self.assertEqual(resp.status, 200)
343 self.assertEqual(resp.reason, 'OK')
Senthil Kumaran0b998832010-06-04 17:27:11 +0000344 self.assertTrue(resp.isclosed())
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000345
Christian Heimesa612dc02008-02-24 13:08:18 +0000346 def test_negative_content_length(self):
Jeremy Hylton82066952008-12-15 03:08:30 +0000347 sock = FakeSocket(
348 'HTTP/1.1 200 OK\r\nContent-Length: -1\r\n\r\nHello\r\n')
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000349 resp = client.HTTPResponse(sock, method="GET")
Christian Heimesa612dc02008-02-24 13:08:18 +0000350 resp.begin()
Ezio Melottib3aedd42010-11-20 19:04:17 +0000351 self.assertEqual(resp.read(), b'Hello\r\n')
Christian Heimesa612dc02008-02-24 13:08:18 +0000352 resp.close()
353
Benjamin Peterson6accb982009-03-02 22:50:25 +0000354 def test_incomplete_read(self):
355 sock = FakeSocket('HTTP/1.1 200 OK\r\nContent-Length: 10\r\n\r\nHello\r\n')
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000356 resp = client.HTTPResponse(sock, method="GET")
Benjamin Peterson6accb982009-03-02 22:50:25 +0000357 resp.begin()
358 try:
359 resp.read()
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000360 except client.IncompleteRead as i:
Ezio Melottib3aedd42010-11-20 19:04:17 +0000361 self.assertEqual(i.partial, b'Hello\r\n')
Benjamin Peterson6accb982009-03-02 22:50:25 +0000362 self.assertEqual(repr(i),
363 "IncompleteRead(7 bytes read, 3 more expected)")
364 self.assertEqual(str(i),
365 "IncompleteRead(7 bytes read, 3 more expected)")
366 else:
367 self.fail('IncompleteRead expected')
368 finally:
369 resp.close()
370
Jeremy Hylton636950f2009-03-28 04:34:21 +0000371 def test_epipe(self):
372 sock = EPipeSocket(
373 "HTTP/1.0 401 Authorization Required\r\n"
374 "Content-type: text/html\r\n"
375 "WWW-Authenticate: Basic realm=\"example\"\r\n",
376 b"Content-Length")
377 conn = client.HTTPConnection("example.com")
378 conn.sock = sock
379 self.assertRaises(socket.error,
380 lambda: conn.request("PUT", "/url", "body"))
381 resp = conn.getresponse()
382 self.assertEqual(401, resp.status)
383 self.assertEqual("Basic realm=\"example\"",
384 resp.getheader("www-authenticate"))
Christian Heimesa612dc02008-02-24 13:08:18 +0000385
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000386 # Test lines overflowing the max line size (_MAXLINE in http.client)
387
388 def test_overflowing_status_line(self):
389 body = "HTTP/1.1 200 Ok" + "k" * 65536 + "\r\n"
390 resp = client.HTTPResponse(FakeSocket(body))
391 self.assertRaises((client.LineTooLong, client.BadStatusLine), resp.begin)
392
393 def test_overflowing_header_line(self):
394 body = (
395 'HTTP/1.1 200 OK\r\n'
396 'X-Foo: bar' + 'r' * 65536 + '\r\n\r\n'
397 )
398 resp = client.HTTPResponse(FakeSocket(body))
399 self.assertRaises(client.LineTooLong, resp.begin)
400
401 def test_overflowing_chunked_line(self):
402 body = (
403 'HTTP/1.1 200 OK\r\n'
404 'Transfer-Encoding: chunked\r\n\r\n'
405 + '0' * 65536 + 'a\r\n'
406 'hello world\r\n'
407 '0\r\n'
408 )
409 resp = client.HTTPResponse(FakeSocket(body))
410 resp.begin()
411 self.assertRaises(client.LineTooLong, resp.read)
412
Senthil Kumaran9c29f862012-04-29 10:20:46 +0800413 def test_early_eof(self):
414 # Test httpresponse with no \r\n termination,
415 body = "HTTP/1.1 200 Ok"
416 sock = FakeSocket(body)
417 resp = client.HTTPResponse(sock)
418 resp.begin()
419 self.assertEqual(resp.read(), b'')
420 self.assertTrue(resp.isclosed())
421
Georg Brandl4cbd1e32006-02-17 22:01:08 +0000422class OfflineTest(TestCase):
423 def test_responses(self):
Ezio Melottib3aedd42010-11-20 19:04:17 +0000424 self.assertEqual(client.responses[client.NOT_FOUND], "Not Found")
Georg Brandl4cbd1e32006-02-17 22:01:08 +0000425
Gregory P. Smithb4066372010-01-03 03:28:29 +0000426
427class SourceAddressTest(TestCase):
428 def setUp(self):
429 self.serv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
430 self.port = support.bind_port(self.serv)
431 self.source_port = support.find_unused_port()
432 self.serv.listen(5)
433 self.conn = None
434
435 def tearDown(self):
436 if self.conn:
437 self.conn.close()
438 self.conn = None
439 self.serv.close()
440 self.serv = None
441
442 def testHTTPConnectionSourceAddress(self):
443 self.conn = client.HTTPConnection(HOST, self.port,
444 source_address=('', self.source_port))
445 self.conn.connect()
446 self.assertEqual(self.conn.sock.getsockname()[1], self.source_port)
447
448 @unittest.skipIf(not hasattr(client, 'HTTPSConnection'),
449 'http.client.HTTPSConnection not defined')
450 def testHTTPSConnectionSourceAddress(self):
451 self.conn = client.HTTPSConnection(HOST, self.port,
452 source_address=('', self.source_port))
453 # We don't test anything here other the constructor not barfing as
454 # this code doesn't deal with setting up an active running SSL server
455 # for an ssl_wrapped connect() to actually return from.
456
457
Guido van Rossumd8faa362007-04-27 19:54:29 +0000458class TimeoutTest(TestCase):
Christian Heimes5e696852008-04-09 08:37:03 +0000459 PORT = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000460
461 def setUp(self):
462 self.serv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000463 TimeoutTest.PORT = support.bind_port(self.serv)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000464 self.serv.listen(5)
465
466 def tearDown(self):
467 self.serv.close()
468 self.serv = None
469
470 def testTimeoutAttribute(self):
Jeremy Hylton3a38c912007-08-14 17:08:07 +0000471 # This will prove that the timeout gets through HTTPConnection
472 # and into the socket.
473
Georg Brandlf78e02b2008-06-10 17:40:04 +0000474 # default -- use global socket timeout
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000475 self.assertTrue(socket.getdefaulttimeout() is None)
Georg Brandlf78e02b2008-06-10 17:40:04 +0000476 socket.setdefaulttimeout(30)
477 try:
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000478 httpConn = client.HTTPConnection(HOST, TimeoutTest.PORT)
Georg Brandlf78e02b2008-06-10 17:40:04 +0000479 httpConn.connect()
480 finally:
481 socket.setdefaulttimeout(None)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000482 self.assertEqual(httpConn.sock.gettimeout(), 30)
483 httpConn.close()
484
Georg Brandlf78e02b2008-06-10 17:40:04 +0000485 # no timeout -- do not use global socket default
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000486 self.assertTrue(socket.getdefaulttimeout() is None)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000487 socket.setdefaulttimeout(30)
488 try:
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000489 httpConn = client.HTTPConnection(HOST, TimeoutTest.PORT,
Christian Heimes5e696852008-04-09 08:37:03 +0000490 timeout=None)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000491 httpConn.connect()
492 finally:
Georg Brandlf78e02b2008-06-10 17:40:04 +0000493 socket.setdefaulttimeout(None)
494 self.assertEqual(httpConn.sock.gettimeout(), None)
495 httpConn.close()
496
497 # a value
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000498 httpConn = client.HTTPConnection(HOST, TimeoutTest.PORT, timeout=30)
Georg Brandlf78e02b2008-06-10 17:40:04 +0000499 httpConn.connect()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000500 self.assertEqual(httpConn.sock.gettimeout(), 30)
501 httpConn.close()
502
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000503
504class HTTPSTest(TestCase):
505
506 def setUp(self):
507 if not hasattr(client, 'HTTPSConnection'):
508 self.skipTest('ssl support required')
509
510 def make_server(self, certfile):
511 from test.ssl_servers import make_https_server
512 return make_https_server(self, certfile)
Guido van Rossumd59da4b2007-05-22 18:11:13 +0000513
514 def test_attributes(self):
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000515 # simple test to check it's storing the timeout
516 h = client.HTTPSConnection(HOST, TimeoutTest.PORT, timeout=30)
517 self.assertEqual(h.timeout, 30)
518
519 def _check_svn_python_org(self, resp):
520 # Just a simple check that everything went fine
521 server_string = resp.getheader('server')
522 self.assertIn('Apache', server_string)
523
524 def test_networked(self):
525 # Default settings: no cert verification is done
526 support.requires('network')
527 with support.transient_internet('svn.python.org'):
528 h = client.HTTPSConnection('svn.python.org', 443)
529 h.request('GET', '/')
530 resp = h.getresponse()
531 self._check_svn_python_org(resp)
532
533 def test_networked_good_cert(self):
534 # We feed a CA cert that validates the server's cert
535 import ssl
536 support.requires('network')
537 with support.transient_internet('svn.python.org'):
538 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
539 context.verify_mode = ssl.CERT_REQUIRED
540 context.load_verify_locations(CACERT_svn_python_org)
541 h = client.HTTPSConnection('svn.python.org', 443, context=context)
542 h.request('GET', '/')
543 resp = h.getresponse()
544 self._check_svn_python_org(resp)
545
546 def test_networked_bad_cert(self):
547 # We feed a "CA" cert that is unrelated to the server's cert
548 import ssl
549 support.requires('network')
550 with support.transient_internet('svn.python.org'):
551 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
552 context.verify_mode = ssl.CERT_REQUIRED
553 context.load_verify_locations(CERT_localhost)
554 h = client.HTTPSConnection('svn.python.org', 443, context=context)
555 with self.assertRaises(ssl.SSLError):
556 h.request('GET', '/')
557
558 def test_local_good_hostname(self):
559 # The (valid) cert validates the HTTP hostname
560 import ssl
561 from test.ssl_servers import make_https_server
562 server = make_https_server(self, CERT_localhost)
563 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
564 context.verify_mode = ssl.CERT_REQUIRED
565 context.load_verify_locations(CERT_localhost)
566 h = client.HTTPSConnection('localhost', server.port, context=context)
567 h.request('GET', '/nonexistent')
568 resp = h.getresponse()
569 self.assertEqual(resp.status, 404)
570
571 def test_local_bad_hostname(self):
572 # The (valid) cert doesn't validate the HTTP hostname
573 import ssl
574 from test.ssl_servers import make_https_server
575 server = make_https_server(self, CERT_fakehostname)
576 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
577 context.verify_mode = ssl.CERT_REQUIRED
578 context.load_verify_locations(CERT_fakehostname)
579 h = client.HTTPSConnection('localhost', server.port, context=context)
580 with self.assertRaises(ssl.CertificateError):
581 h.request('GET', '/')
582 # Same with explicit check_hostname=True
583 h = client.HTTPSConnection('localhost', server.port, context=context,
584 check_hostname=True)
585 with self.assertRaises(ssl.CertificateError):
586 h.request('GET', '/')
587 # With check_hostname=False, the mismatching is ignored
588 h = client.HTTPSConnection('localhost', server.port, context=context,
589 check_hostname=False)
590 h.request('GET', '/nonexistent')
591 resp = h.getresponse()
592 self.assertEqual(resp.status, 404)
593
Petri Lehtinene119c402011-10-26 21:29:15 +0300594 @unittest.skipIf(not hasattr(client, 'HTTPSConnection'),
595 'http.client.HTTPSConnection not available')
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200596 def test_host_port(self):
597 # Check invalid host_port
598
599 for hp in ("www.python.org:abc", "user:password@www.python.org"):
600 self.assertRaises(client.InvalidURL, client.HTTPSConnection, hp)
601
602 for hp, h, p in (("[fe80::207:e9ff:fe9b]:8000",
603 "fe80::207:e9ff:fe9b", 8000),
604 ("www.python.org:443", "www.python.org", 443),
605 ("www.python.org:", "www.python.org", 443),
606 ("www.python.org", "www.python.org", 443),
607 ("[fe80::207:e9ff:fe9b]", "fe80::207:e9ff:fe9b", 443),
608 ("[fe80::207:e9ff:fe9b]:", "fe80::207:e9ff:fe9b",
609 443)):
610 c = client.HTTPSConnection(hp)
611 self.assertEqual(h, c.host)
612 self.assertEqual(p, c.port)
613
Guido van Rossumd59da4b2007-05-22 18:11:13 +0000614
Jeremy Hylton236654b2009-03-27 20:24:34 +0000615class RequestBodyTest(TestCase):
616 """Test cases where a request includes a message body."""
617
618 def setUp(self):
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000619 self.conn = client.HTTPConnection('example.com')
Jeremy Hylton636950f2009-03-28 04:34:21 +0000620 self.conn.sock = self.sock = FakeSocket("")
Jeremy Hylton236654b2009-03-27 20:24:34 +0000621 self.conn.sock = self.sock
622
623 def get_headers_and_fp(self):
624 f = io.BytesIO(self.sock.data)
625 f.readline() # read the request line
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000626 message = client.parse_headers(f)
Jeremy Hylton236654b2009-03-27 20:24:34 +0000627 return message, f
628
629 def test_manual_content_length(self):
630 # Set an incorrect content-length so that we can verify that
631 # it will not be over-ridden by the library.
632 self.conn.request("PUT", "/url", "body",
633 {"Content-Length": "42"})
634 message, f = self.get_headers_and_fp()
635 self.assertEqual("42", message.get("content-length"))
636 self.assertEqual(4, len(f.read()))
637
638 def test_ascii_body(self):
639 self.conn.request("PUT", "/url", "body")
640 message, f = self.get_headers_and_fp()
641 self.assertEqual("text/plain", message.get_content_type())
Raymond Hettinger7beae8a2011-01-06 05:34:17 +0000642 self.assertIsNone(message.get_charset())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000643 self.assertEqual("4", message.get("content-length"))
644 self.assertEqual(b'body', f.read())
645
646 def test_latin1_body(self):
647 self.conn.request("PUT", "/url", "body\xc1")
648 message, f = self.get_headers_and_fp()
649 self.assertEqual("text/plain", message.get_content_type())
Raymond Hettinger7beae8a2011-01-06 05:34:17 +0000650 self.assertIsNone(message.get_charset())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000651 self.assertEqual("5", message.get("content-length"))
652 self.assertEqual(b'body\xc1', f.read())
653
654 def test_bytes_body(self):
655 self.conn.request("PUT", "/url", b"body\xc1")
656 message, f = self.get_headers_and_fp()
657 self.assertEqual("text/plain", message.get_content_type())
Raymond Hettinger7beae8a2011-01-06 05:34:17 +0000658 self.assertIsNone(message.get_charset())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000659 self.assertEqual("5", message.get("content-length"))
660 self.assertEqual(b'body\xc1', f.read())
661
662 def test_file_body(self):
Victor Stinner18d15cb2011-09-21 01:09:04 +0200663 self.addCleanup(support.unlink, support.TESTFN)
Brett Cannon77b7de62010-10-29 23:31:11 +0000664 with open(support.TESTFN, "w") as f:
665 f.write("body")
666 with open(support.TESTFN) as f:
667 self.conn.request("PUT", "/url", f)
668 message, f = self.get_headers_and_fp()
669 self.assertEqual("text/plain", message.get_content_type())
Raymond Hettinger7beae8a2011-01-06 05:34:17 +0000670 self.assertIsNone(message.get_charset())
Brett Cannon77b7de62010-10-29 23:31:11 +0000671 self.assertEqual("4", message.get("content-length"))
672 self.assertEqual(b'body', f.read())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000673
674 def test_binary_file_body(self):
Victor Stinner18d15cb2011-09-21 01:09:04 +0200675 self.addCleanup(support.unlink, support.TESTFN)
Brett Cannon77b7de62010-10-29 23:31:11 +0000676 with open(support.TESTFN, "wb") as f:
677 f.write(b"body\xc1")
678 with open(support.TESTFN, "rb") as f:
679 self.conn.request("PUT", "/url", f)
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())
Brett Cannon77b7de62010-10-29 23:31:11 +0000683 self.assertEqual("5", message.get("content-length"))
684 self.assertEqual(b'body\xc1', f.read())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000685
Senthil Kumaran9f8dc442010-08-02 11:04:58 +0000686
687class HTTPResponseTest(TestCase):
688
689 def setUp(self):
690 body = "HTTP/1.1 200 Ok\r\nMy-Header: first-value\r\nMy-Header: \
691 second-value\r\n\r\nText"
692 sock = FakeSocket(body)
693 self.resp = client.HTTPResponse(sock)
694 self.resp.begin()
695
696 def test_getting_header(self):
697 header = self.resp.getheader('My-Header')
698 self.assertEqual(header, 'first-value, second-value')
699
700 header = self.resp.getheader('My-Header', 'some default')
701 self.assertEqual(header, 'first-value, second-value')
702
703 def test_getting_nonexistent_header_with_string_default(self):
704 header = self.resp.getheader('No-Such-Header', 'default-value')
705 self.assertEqual(header, 'default-value')
706
707 def test_getting_nonexistent_header_with_iterable_default(self):
708 header = self.resp.getheader('No-Such-Header', ['default', 'values'])
709 self.assertEqual(header, 'default, values')
710
711 header = self.resp.getheader('No-Such-Header', ('default', 'values'))
712 self.assertEqual(header, 'default, values')
713
714 def test_getting_nonexistent_header_without_default(self):
715 header = self.resp.getheader('No-Such-Header')
716 self.assertEqual(header, None)
717
718 def test_getting_header_defaultint(self):
719 header = self.resp.getheader('No-Such-Header',default=42)
720 self.assertEqual(header, 42)
721
Jeremy Hylton2c178252004-08-07 16:28:14 +0000722def test_main(verbose=None):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000723 support.run_unittest(HeaderTests, OfflineTest, BasicTest, TimeoutTest,
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000724 HTTPSTest, RequestBodyTest, SourceAddressTest,
Senthil Kumaran9f8dc442010-08-02 11:04:58 +0000725 HTTPResponseTest)
Jeremy Hylton2c178252004-08-07 16:28:14 +0000726
Thomas Wouters89f507f2006-12-13 04:49:30 +0000727if __name__ == '__main__':
728 test_main()