blob: 5df4b512041cf3723ca37e36c00e3192d2eade3e [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
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100202 def test_partial_reads_incomplete_body(self):
203 # if the server shuts down the connection before the whole
204 # content-length is delivered, the socket is gracefully closed
205 body = "HTTP/1.1 200 Ok\r\nContent-Length: 10\r\n\r\nText"
206 sock = FakeSocket(body)
207 resp = client.HTTPResponse(sock)
208 resp.begin()
209 self.assertEqual(resp.read(2), b'Te')
210 self.assertFalse(resp.isclosed())
211 self.assertEqual(resp.read(2), b'xt')
212 self.assertEqual(resp.read(1), b'')
213 self.assertTrue(resp.isclosed())
214
Thomas Wouters89f507f2006-12-13 04:49:30 +0000215 def test_host_port(self):
216 # Check invalid host_port
Jeremy Hyltonba603192003-01-23 18:02:20 +0000217
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200218 for hp in ("www.python.org:abc", "user:password@www.python.org"):
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000219 self.assertRaises(client.InvalidURL, client.HTTPConnection, hp)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000220
Jeremy Hylton3a38c912007-08-14 17:08:07 +0000221 for hp, h, p in (("[fe80::207:e9ff:fe9b]:8000",
222 "fe80::207:e9ff:fe9b", 8000),
Thomas Wouters89f507f2006-12-13 04:49:30 +0000223 ("www.python.org:80", "www.python.org", 80),
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200224 ("www.python.org:", "www.python.org", 80),
Thomas Wouters89f507f2006-12-13 04:49:30 +0000225 ("www.python.org", "www.python.org", 80),
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200226 ("[fe80::207:e9ff:fe9b]", "fe80::207:e9ff:fe9b", 80),
227 ("[fe80::207:e9ff:fe9b]:", "fe80::207:e9ff:fe9b", 80)):
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000228 c = client.HTTPConnection(hp)
Jeremy Hylton3a38c912007-08-14 17:08:07 +0000229 self.assertEqual(h, c.host)
230 self.assertEqual(p, c.port)
Skip Montanaro10e6e0e2004-09-14 16:32:02 +0000231
Thomas Wouters89f507f2006-12-13 04:49:30 +0000232 def test_response_headers(self):
233 # test response with multiple message headers with the same field name.
234 text = ('HTTP/1.1 200 OK\r\n'
Jeremy Hylton3a38c912007-08-14 17:08:07 +0000235 'Set-Cookie: Customer="WILE_E_COYOTE"; '
236 'Version="1"; Path="/acme"\r\n'
Thomas Wouters89f507f2006-12-13 04:49:30 +0000237 'Set-Cookie: Part_Number="Rocket_Launcher_0001"; Version="1";'
238 ' Path="/acme"\r\n'
239 '\r\n'
240 'No body\r\n')
241 hdr = ('Customer="WILE_E_COYOTE"; Version="1"; Path="/acme"'
242 ', '
243 'Part_Number="Rocket_Launcher_0001"; Version="1"; Path="/acme"')
244 s = FakeSocket(text)
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000245 r = client.HTTPResponse(s)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000246 r.begin()
247 cookies = r.getheader("Set-Cookie")
Jeremy Hylton3a38c912007-08-14 17:08:07 +0000248 self.assertEqual(cookies, hdr)
Jeremy Hyltonba603192003-01-23 18:02:20 +0000249
Thomas Wouters89f507f2006-12-13 04:49:30 +0000250 def test_read_head(self):
251 # Test that the library doesn't attempt to read any data
252 # from a HEAD request. (Tickles SF bug #622042.)
253 sock = FakeSocket(
254 'HTTP/1.1 200 OK\r\n'
255 'Content-Length: 14432\r\n'
256 '\r\n',
257 NoEOFStringIO)
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000258 resp = client.HTTPResponse(sock, method="HEAD")
Thomas Wouters89f507f2006-12-13 04:49:30 +0000259 resp.begin()
Guido van Rossuma00f1232007-09-12 19:43:09 +0000260 if resp.read():
Thomas Wouters89f507f2006-12-13 04:49:30 +0000261 self.fail("Did not expect response from HEAD request")
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000262
Thomas Wouters89f507f2006-12-13 04:49:30 +0000263 def test_send_file(self):
Guido van Rossum022c4742007-08-29 02:00:20 +0000264 expected = (b'GET /foo HTTP/1.1\r\nHost: example.com\r\n'
265 b'Accept-Encoding: identity\r\nContent-Length:')
Thomas Wouters89f507f2006-12-13 04:49:30 +0000266
Brett Cannon77b7de62010-10-29 23:31:11 +0000267 with open(__file__, 'rb') as body:
268 conn = client.HTTPConnection('example.com')
269 sock = FakeSocket(body)
270 conn.sock = sock
271 conn.request('GET', '/foo', body)
272 self.assertTrue(sock.data.startswith(expected), '%r != %r' %
273 (sock.data[:len(expected)], expected))
Jeremy Hylton2c178252004-08-07 16:28:14 +0000274
Antoine Pitrouead1d622009-09-29 18:44:53 +0000275 def test_send(self):
276 expected = b'this is a test this is only a test'
277 conn = client.HTTPConnection('example.com')
278 sock = FakeSocket(None)
279 conn.sock = sock
280 conn.send(expected)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000281 self.assertEqual(expected, sock.data)
Antoine Pitrouead1d622009-09-29 18:44:53 +0000282 sock.data = b''
283 conn.send(array.array('b', expected))
Ezio Melottib3aedd42010-11-20 19:04:17 +0000284 self.assertEqual(expected, sock.data)
Antoine Pitrouead1d622009-09-29 18:44:53 +0000285 sock.data = b''
286 conn.send(io.BytesIO(expected))
Ezio Melottib3aedd42010-11-20 19:04:17 +0000287 self.assertEqual(expected, sock.data)
Antoine Pitrouead1d622009-09-29 18:44:53 +0000288
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000289 def test_send_iter(self):
290 expected = b'GET /foo HTTP/1.1\r\nHost: example.com\r\n' \
291 b'Accept-Encoding: identity\r\nContent-Length: 11\r\n' \
292 b'\r\nonetwothree'
293
294 def body():
295 yield b"one"
296 yield b"two"
297 yield b"three"
298
299 conn = client.HTTPConnection('example.com')
300 sock = FakeSocket("")
301 conn.sock = sock
302 conn.request('GET', '/foo', body(), {'Content-Length': '11'})
Victor Stinner04ba9662011-01-04 00:04:46 +0000303 self.assertEqual(sock.data, expected)
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000304
Senthil Kumaraneb71ad42011-08-02 18:33:41 +0800305 def test_send_type_error(self):
306 # See: Issue #12676
307 conn = client.HTTPConnection('example.com')
308 conn.sock = FakeSocket('')
309 with self.assertRaises(TypeError):
310 conn.request('POST', 'test', conn)
311
Christian Heimesa612dc02008-02-24 13:08:18 +0000312 def test_chunked(self):
313 chunked_start = (
314 'HTTP/1.1 200 OK\r\n'
315 'Transfer-Encoding: chunked\r\n\r\n'
316 'a\r\n'
317 'hello worl\r\n'
318 '1\r\n'
319 'd\r\n'
320 )
321 sock = FakeSocket(chunked_start + '0\r\n')
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000322 resp = client.HTTPResponse(sock, method="GET")
Christian Heimesa612dc02008-02-24 13:08:18 +0000323 resp.begin()
Ezio Melottib3aedd42010-11-20 19:04:17 +0000324 self.assertEqual(resp.read(), b'hello world')
Christian Heimesa612dc02008-02-24 13:08:18 +0000325 resp.close()
326
327 for x in ('', 'foo\r\n'):
328 sock = FakeSocket(chunked_start + x)
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000329 resp = client.HTTPResponse(sock, method="GET")
Christian Heimesa612dc02008-02-24 13:08:18 +0000330 resp.begin()
331 try:
332 resp.read()
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000333 except client.IncompleteRead as i:
Ezio Melottib3aedd42010-11-20 19:04:17 +0000334 self.assertEqual(i.partial, b'hello world')
Benjamin Peterson6accb982009-03-02 22:50:25 +0000335 self.assertEqual(repr(i),'IncompleteRead(11 bytes read)')
336 self.assertEqual(str(i),'IncompleteRead(11 bytes read)')
Christian Heimesa612dc02008-02-24 13:08:18 +0000337 else:
338 self.fail('IncompleteRead expected')
339 finally:
340 resp.close()
341
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000342 def test_chunked_head(self):
343 chunked_start = (
344 'HTTP/1.1 200 OK\r\n'
345 'Transfer-Encoding: chunked\r\n\r\n'
346 'a\r\n'
347 'hello world\r\n'
348 '1\r\n'
349 'd\r\n'
350 )
351 sock = FakeSocket(chunked_start + '0\r\n')
352 resp = client.HTTPResponse(sock, method="HEAD")
353 resp.begin()
Ezio Melottib3aedd42010-11-20 19:04:17 +0000354 self.assertEqual(resp.read(), b'')
355 self.assertEqual(resp.status, 200)
356 self.assertEqual(resp.reason, 'OK')
Senthil Kumaran0b998832010-06-04 17:27:11 +0000357 self.assertTrue(resp.isclosed())
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000358
Christian Heimesa612dc02008-02-24 13:08:18 +0000359 def test_negative_content_length(self):
Jeremy Hylton82066952008-12-15 03:08:30 +0000360 sock = FakeSocket(
361 'HTTP/1.1 200 OK\r\nContent-Length: -1\r\n\r\nHello\r\n')
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000362 resp = client.HTTPResponse(sock, method="GET")
Christian Heimesa612dc02008-02-24 13:08:18 +0000363 resp.begin()
Ezio Melottib3aedd42010-11-20 19:04:17 +0000364 self.assertEqual(resp.read(), b'Hello\r\n')
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100365 self.assertTrue(resp.isclosed())
Christian Heimesa612dc02008-02-24 13:08:18 +0000366
Benjamin Peterson6accb982009-03-02 22:50:25 +0000367 def test_incomplete_read(self):
368 sock = FakeSocket('HTTP/1.1 200 OK\r\nContent-Length: 10\r\n\r\nHello\r\n')
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000369 resp = client.HTTPResponse(sock, method="GET")
Benjamin Peterson6accb982009-03-02 22:50:25 +0000370 resp.begin()
371 try:
372 resp.read()
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000373 except client.IncompleteRead as i:
Ezio Melottib3aedd42010-11-20 19:04:17 +0000374 self.assertEqual(i.partial, b'Hello\r\n')
Benjamin Peterson6accb982009-03-02 22:50:25 +0000375 self.assertEqual(repr(i),
376 "IncompleteRead(7 bytes read, 3 more expected)")
377 self.assertEqual(str(i),
378 "IncompleteRead(7 bytes read, 3 more expected)")
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100379 self.assertTrue(resp.isclosed())
Benjamin Peterson6accb982009-03-02 22:50:25 +0000380 else:
381 self.fail('IncompleteRead expected')
Benjamin Peterson6accb982009-03-02 22:50:25 +0000382
Jeremy Hylton636950f2009-03-28 04:34:21 +0000383 def test_epipe(self):
384 sock = EPipeSocket(
385 "HTTP/1.0 401 Authorization Required\r\n"
386 "Content-type: text/html\r\n"
387 "WWW-Authenticate: Basic realm=\"example\"\r\n",
388 b"Content-Length")
389 conn = client.HTTPConnection("example.com")
390 conn.sock = sock
391 self.assertRaises(socket.error,
392 lambda: conn.request("PUT", "/url", "body"))
393 resp = conn.getresponse()
394 self.assertEqual(401, resp.status)
395 self.assertEqual("Basic realm=\"example\"",
396 resp.getheader("www-authenticate"))
Christian Heimesa612dc02008-02-24 13:08:18 +0000397
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000398 # Test lines overflowing the max line size (_MAXLINE in http.client)
399
400 def test_overflowing_status_line(self):
401 body = "HTTP/1.1 200 Ok" + "k" * 65536 + "\r\n"
402 resp = client.HTTPResponse(FakeSocket(body))
403 self.assertRaises((client.LineTooLong, client.BadStatusLine), resp.begin)
404
405 def test_overflowing_header_line(self):
406 body = (
407 'HTTP/1.1 200 OK\r\n'
408 'X-Foo: bar' + 'r' * 65536 + '\r\n\r\n'
409 )
410 resp = client.HTTPResponse(FakeSocket(body))
411 self.assertRaises(client.LineTooLong, resp.begin)
412
413 def test_overflowing_chunked_line(self):
414 body = (
415 'HTTP/1.1 200 OK\r\n'
416 'Transfer-Encoding: chunked\r\n\r\n'
417 + '0' * 65536 + 'a\r\n'
418 'hello world\r\n'
419 '0\r\n'
420 )
421 resp = client.HTTPResponse(FakeSocket(body))
422 resp.begin()
423 self.assertRaises(client.LineTooLong, resp.read)
424
Senthil Kumaran9c29f862012-04-29 10:20:46 +0800425 def test_early_eof(self):
426 # Test httpresponse with no \r\n termination,
427 body = "HTTP/1.1 200 Ok"
428 sock = FakeSocket(body)
429 resp = client.HTTPResponse(sock)
430 resp.begin()
431 self.assertEqual(resp.read(), b'')
432 self.assertTrue(resp.isclosed())
433
Georg Brandl4cbd1e32006-02-17 22:01:08 +0000434class OfflineTest(TestCase):
435 def test_responses(self):
Ezio Melottib3aedd42010-11-20 19:04:17 +0000436 self.assertEqual(client.responses[client.NOT_FOUND], "Not Found")
Georg Brandl4cbd1e32006-02-17 22:01:08 +0000437
Gregory P. Smithb4066372010-01-03 03:28:29 +0000438
439class SourceAddressTest(TestCase):
440 def setUp(self):
441 self.serv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
442 self.port = support.bind_port(self.serv)
443 self.source_port = support.find_unused_port()
444 self.serv.listen(5)
445 self.conn = None
446
447 def tearDown(self):
448 if self.conn:
449 self.conn.close()
450 self.conn = None
451 self.serv.close()
452 self.serv = None
453
454 def testHTTPConnectionSourceAddress(self):
455 self.conn = client.HTTPConnection(HOST, self.port,
456 source_address=('', self.source_port))
457 self.conn.connect()
458 self.assertEqual(self.conn.sock.getsockname()[1], self.source_port)
459
460 @unittest.skipIf(not hasattr(client, 'HTTPSConnection'),
461 'http.client.HTTPSConnection not defined')
462 def testHTTPSConnectionSourceAddress(self):
463 self.conn = client.HTTPSConnection(HOST, self.port,
464 source_address=('', self.source_port))
465 # We don't test anything here other the constructor not barfing as
466 # this code doesn't deal with setting up an active running SSL server
467 # for an ssl_wrapped connect() to actually return from.
468
469
Guido van Rossumd8faa362007-04-27 19:54:29 +0000470class TimeoutTest(TestCase):
Christian Heimes5e696852008-04-09 08:37:03 +0000471 PORT = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000472
473 def setUp(self):
474 self.serv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000475 TimeoutTest.PORT = support.bind_port(self.serv)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000476 self.serv.listen(5)
477
478 def tearDown(self):
479 self.serv.close()
480 self.serv = None
481
482 def testTimeoutAttribute(self):
Jeremy Hylton3a38c912007-08-14 17:08:07 +0000483 # This will prove that the timeout gets through HTTPConnection
484 # and into the socket.
485
Georg Brandlf78e02b2008-06-10 17:40:04 +0000486 # default -- use global socket timeout
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000487 self.assertTrue(socket.getdefaulttimeout() is None)
Georg Brandlf78e02b2008-06-10 17:40:04 +0000488 socket.setdefaulttimeout(30)
489 try:
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000490 httpConn = client.HTTPConnection(HOST, TimeoutTest.PORT)
Georg Brandlf78e02b2008-06-10 17:40:04 +0000491 httpConn.connect()
492 finally:
493 socket.setdefaulttimeout(None)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000494 self.assertEqual(httpConn.sock.gettimeout(), 30)
495 httpConn.close()
496
Georg Brandlf78e02b2008-06-10 17:40:04 +0000497 # no timeout -- do not use global socket default
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000498 self.assertTrue(socket.getdefaulttimeout() is None)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000499 socket.setdefaulttimeout(30)
500 try:
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000501 httpConn = client.HTTPConnection(HOST, TimeoutTest.PORT,
Christian Heimes5e696852008-04-09 08:37:03 +0000502 timeout=None)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000503 httpConn.connect()
504 finally:
Georg Brandlf78e02b2008-06-10 17:40:04 +0000505 socket.setdefaulttimeout(None)
506 self.assertEqual(httpConn.sock.gettimeout(), None)
507 httpConn.close()
508
509 # a value
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000510 httpConn = client.HTTPConnection(HOST, TimeoutTest.PORT, timeout=30)
Georg Brandlf78e02b2008-06-10 17:40:04 +0000511 httpConn.connect()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000512 self.assertEqual(httpConn.sock.gettimeout(), 30)
513 httpConn.close()
514
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000515
516class HTTPSTest(TestCase):
517
518 def setUp(self):
519 if not hasattr(client, 'HTTPSConnection'):
520 self.skipTest('ssl support required')
521
522 def make_server(self, certfile):
523 from test.ssl_servers import make_https_server
524 return make_https_server(self, certfile)
Guido van Rossumd59da4b2007-05-22 18:11:13 +0000525
526 def test_attributes(self):
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000527 # simple test to check it's storing the timeout
528 h = client.HTTPSConnection(HOST, TimeoutTest.PORT, timeout=30)
529 self.assertEqual(h.timeout, 30)
530
531 def _check_svn_python_org(self, resp):
532 # Just a simple check that everything went fine
533 server_string = resp.getheader('server')
534 self.assertIn('Apache', server_string)
535
536 def test_networked(self):
537 # Default settings: no cert verification is done
538 support.requires('network')
539 with support.transient_internet('svn.python.org'):
540 h = client.HTTPSConnection('svn.python.org', 443)
541 h.request('GET', '/')
542 resp = h.getresponse()
543 self._check_svn_python_org(resp)
544
545 def test_networked_good_cert(self):
546 # We feed a CA cert that validates the server's cert
547 import ssl
548 support.requires('network')
549 with support.transient_internet('svn.python.org'):
550 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
551 context.verify_mode = ssl.CERT_REQUIRED
552 context.load_verify_locations(CACERT_svn_python_org)
553 h = client.HTTPSConnection('svn.python.org', 443, context=context)
554 h.request('GET', '/')
555 resp = h.getresponse()
556 self._check_svn_python_org(resp)
557
558 def test_networked_bad_cert(self):
559 # We feed a "CA" cert that is unrelated to the server's cert
560 import ssl
561 support.requires('network')
562 with support.transient_internet('svn.python.org'):
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('svn.python.org', 443, context=context)
567 with self.assertRaises(ssl.SSLError):
568 h.request('GET', '/')
569
570 def test_local_good_hostname(self):
571 # The (valid) cert validates the HTTP hostname
572 import ssl
573 from test.ssl_servers import make_https_server
574 server = make_https_server(self, CERT_localhost)
575 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
576 context.verify_mode = ssl.CERT_REQUIRED
577 context.load_verify_locations(CERT_localhost)
578 h = client.HTTPSConnection('localhost', server.port, context=context)
579 h.request('GET', '/nonexistent')
580 resp = h.getresponse()
581 self.assertEqual(resp.status, 404)
582
583 def test_local_bad_hostname(self):
584 # The (valid) cert doesn't validate the HTTP hostname
585 import ssl
586 from test.ssl_servers import make_https_server
587 server = make_https_server(self, CERT_fakehostname)
588 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
589 context.verify_mode = ssl.CERT_REQUIRED
590 context.load_verify_locations(CERT_fakehostname)
591 h = client.HTTPSConnection('localhost', server.port, context=context)
592 with self.assertRaises(ssl.CertificateError):
593 h.request('GET', '/')
594 # Same with explicit check_hostname=True
595 h = client.HTTPSConnection('localhost', server.port, context=context,
596 check_hostname=True)
597 with self.assertRaises(ssl.CertificateError):
598 h.request('GET', '/')
599 # With check_hostname=False, the mismatching is ignored
600 h = client.HTTPSConnection('localhost', server.port, context=context,
601 check_hostname=False)
602 h.request('GET', '/nonexistent')
603 resp = h.getresponse()
604 self.assertEqual(resp.status, 404)
605
Petri Lehtinene119c402011-10-26 21:29:15 +0300606 @unittest.skipIf(not hasattr(client, 'HTTPSConnection'),
607 'http.client.HTTPSConnection not available')
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200608 def test_host_port(self):
609 # Check invalid host_port
610
611 for hp in ("www.python.org:abc", "user:password@www.python.org"):
612 self.assertRaises(client.InvalidURL, client.HTTPSConnection, hp)
613
614 for hp, h, p in (("[fe80::207:e9ff:fe9b]:8000",
615 "fe80::207:e9ff:fe9b", 8000),
616 ("www.python.org:443", "www.python.org", 443),
617 ("www.python.org:", "www.python.org", 443),
618 ("www.python.org", "www.python.org", 443),
619 ("[fe80::207:e9ff:fe9b]", "fe80::207:e9ff:fe9b", 443),
620 ("[fe80::207:e9ff:fe9b]:", "fe80::207:e9ff:fe9b",
621 443)):
622 c = client.HTTPSConnection(hp)
623 self.assertEqual(h, c.host)
624 self.assertEqual(p, c.port)
625
Guido van Rossumd59da4b2007-05-22 18:11:13 +0000626
Jeremy Hylton236654b2009-03-27 20:24:34 +0000627class RequestBodyTest(TestCase):
628 """Test cases where a request includes a message body."""
629
630 def setUp(self):
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000631 self.conn = client.HTTPConnection('example.com')
Jeremy Hylton636950f2009-03-28 04:34:21 +0000632 self.conn.sock = self.sock = FakeSocket("")
Jeremy Hylton236654b2009-03-27 20:24:34 +0000633 self.conn.sock = self.sock
634
635 def get_headers_and_fp(self):
636 f = io.BytesIO(self.sock.data)
637 f.readline() # read the request line
Jeremy Hylton7c1692d2009-03-27 21:31:03 +0000638 message = client.parse_headers(f)
Jeremy Hylton236654b2009-03-27 20:24:34 +0000639 return message, f
640
641 def test_manual_content_length(self):
642 # Set an incorrect content-length so that we can verify that
643 # it will not be over-ridden by the library.
644 self.conn.request("PUT", "/url", "body",
645 {"Content-Length": "42"})
646 message, f = self.get_headers_and_fp()
647 self.assertEqual("42", message.get("content-length"))
648 self.assertEqual(4, len(f.read()))
649
650 def test_ascii_body(self):
651 self.conn.request("PUT", "/url", "body")
652 message, f = self.get_headers_and_fp()
653 self.assertEqual("text/plain", message.get_content_type())
Raymond Hettinger7beae8a2011-01-06 05:34:17 +0000654 self.assertIsNone(message.get_charset())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000655 self.assertEqual("4", message.get("content-length"))
656 self.assertEqual(b'body', f.read())
657
658 def test_latin1_body(self):
659 self.conn.request("PUT", "/url", "body\xc1")
660 message, f = self.get_headers_and_fp()
661 self.assertEqual("text/plain", message.get_content_type())
Raymond Hettinger7beae8a2011-01-06 05:34:17 +0000662 self.assertIsNone(message.get_charset())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000663 self.assertEqual("5", message.get("content-length"))
664 self.assertEqual(b'body\xc1', f.read())
665
666 def test_bytes_body(self):
667 self.conn.request("PUT", "/url", b"body\xc1")
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())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000671 self.assertEqual("5", message.get("content-length"))
672 self.assertEqual(b'body\xc1', f.read())
673
674 def test_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, "w") as f:
677 f.write("body")
678 with open(support.TESTFN) 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("4", message.get("content-length"))
684 self.assertEqual(b'body', f.read())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000685
686 def test_binary_file_body(self):
Victor Stinner18d15cb2011-09-21 01:09:04 +0200687 self.addCleanup(support.unlink, support.TESTFN)
Brett Cannon77b7de62010-10-29 23:31:11 +0000688 with open(support.TESTFN, "wb") as f:
689 f.write(b"body\xc1")
690 with open(support.TESTFN, "rb") as f:
691 self.conn.request("PUT", "/url", f)
692 message, f = self.get_headers_and_fp()
693 self.assertEqual("text/plain", message.get_content_type())
Raymond Hettinger7beae8a2011-01-06 05:34:17 +0000694 self.assertIsNone(message.get_charset())
Brett Cannon77b7de62010-10-29 23:31:11 +0000695 self.assertEqual("5", message.get("content-length"))
696 self.assertEqual(b'body\xc1', f.read())
Jeremy Hylton236654b2009-03-27 20:24:34 +0000697
Senthil Kumaran9f8dc442010-08-02 11:04:58 +0000698
699class HTTPResponseTest(TestCase):
700
701 def setUp(self):
702 body = "HTTP/1.1 200 Ok\r\nMy-Header: first-value\r\nMy-Header: \
703 second-value\r\n\r\nText"
704 sock = FakeSocket(body)
705 self.resp = client.HTTPResponse(sock)
706 self.resp.begin()
707
708 def test_getting_header(self):
709 header = self.resp.getheader('My-Header')
710 self.assertEqual(header, 'first-value, second-value')
711
712 header = self.resp.getheader('My-Header', 'some default')
713 self.assertEqual(header, 'first-value, second-value')
714
715 def test_getting_nonexistent_header_with_string_default(self):
716 header = self.resp.getheader('No-Such-Header', 'default-value')
717 self.assertEqual(header, 'default-value')
718
719 def test_getting_nonexistent_header_with_iterable_default(self):
720 header = self.resp.getheader('No-Such-Header', ['default', 'values'])
721 self.assertEqual(header, 'default, values')
722
723 header = self.resp.getheader('No-Such-Header', ('default', 'values'))
724 self.assertEqual(header, 'default, values')
725
726 def test_getting_nonexistent_header_without_default(self):
727 header = self.resp.getheader('No-Such-Header')
728 self.assertEqual(header, None)
729
730 def test_getting_header_defaultint(self):
731 header = self.resp.getheader('No-Such-Header',default=42)
732 self.assertEqual(header, 42)
733
Jeremy Hylton2c178252004-08-07 16:28:14 +0000734def test_main(verbose=None):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000735 support.run_unittest(HeaderTests, OfflineTest, BasicTest, TimeoutTest,
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000736 HTTPSTest, RequestBodyTest, SourceAddressTest,
Senthil Kumaran9f8dc442010-08-02 11:04:58 +0000737 HTTPResponseTest)
Jeremy Hylton2c178252004-08-07 16:28:14 +0000738
Thomas Wouters89f507f2006-12-13 04:49:30 +0000739if __name__ == '__main__':
740 test_main()