blob: fcdfe51d83740e74999da0e27fd57adabb35e0db [file] [log] [blame]
Georg Brandlb533e262008-05-25 18:19:30 +00001"""Unittests for the various HTTPServer modules.
2
3Written by Cody A.W. Somerville <cody-somerville@ubuntu.com>,
4Josip Dzolonga, and Michael Otteneder for the 2007/08 GHOP contest.
5"""
6
Georg Brandl24420152008-05-26 16:32:26 +00007from http.server import BaseHTTPRequestHandler, HTTPServer, \
8 SimpleHTTPRequestHandler, CGIHTTPRequestHandler
Serhiy Storchakac0a23e62015-03-07 11:51:37 +02009from http import server, HTTPStatus
Georg Brandlb533e262008-05-25 18:19:30 +000010
11import os
12import sys
Senthil Kumaran0f476d42010-09-30 06:09:18 +000013import re
Georg Brandlb533e262008-05-25 18:19:30 +000014import base64
15import shutil
Jeremy Hylton1afc1692008-06-18 20:49:58 +000016import urllib.parse
Serhiy Storchakacb5bc402014-08-17 08:22:11 +030017import html
Georg Brandl24420152008-05-26 16:32:26 +000018import http.client
Georg Brandlb533e262008-05-25 18:19:30 +000019import tempfile
Senthil Kumaran0f476d42010-09-30 06:09:18 +000020from io import BytesIO
Georg Brandlb533e262008-05-25 18:19:30 +000021
22import unittest
23from test import support
Victor Stinner45df8202010-04-28 22:31:17 +000024threading = support.import_module('threading')
Georg Brandlb533e262008-05-25 18:19:30 +000025
Georg Brandlb533e262008-05-25 18:19:30 +000026class NoLogRequestHandler:
27 def log_message(self, *args):
28 # don't write log messages to stderr
29 pass
30
Barry Warsaw820c1202008-06-12 04:06:45 +000031 def read(self, n=None):
32 return ''
33
Georg Brandlb533e262008-05-25 18:19:30 +000034
35class TestServerThread(threading.Thread):
36 def __init__(self, test_object, request_handler):
37 threading.Thread.__init__(self)
38 self.request_handler = request_handler
39 self.test_object = test_object
Georg Brandlb533e262008-05-25 18:19:30 +000040
41 def run(self):
Antoine Pitroucb342182011-03-21 00:26:51 +010042 self.server = HTTPServer(('localhost', 0), self.request_handler)
43 self.test_object.HOST, self.test_object.PORT = self.server.socket.getsockname()
Antoine Pitrou08911bd2010-04-25 22:19:43 +000044 self.test_object.server_started.set()
45 self.test_object = None
Georg Brandlb533e262008-05-25 18:19:30 +000046 try:
Antoine Pitrou08911bd2010-04-25 22:19:43 +000047 self.server.serve_forever(0.05)
Georg Brandlb533e262008-05-25 18:19:30 +000048 finally:
49 self.server.server_close()
50
51 def stop(self):
52 self.server.shutdown()
53
54
55class BaseTestCase(unittest.TestCase):
56 def setUp(self):
Antoine Pitrou45ebeb82009-10-27 18:52:30 +000057 self._threads = support.threading_setup()
Nick Coghlan6ead5522009-10-18 13:19:33 +000058 os.environ = support.EnvironmentVarGuard()
Antoine Pitrou08911bd2010-04-25 22:19:43 +000059 self.server_started = threading.Event()
Georg Brandlb533e262008-05-25 18:19:30 +000060 self.thread = TestServerThread(self, self.request_handler)
61 self.thread.start()
Antoine Pitrou08911bd2010-04-25 22:19:43 +000062 self.server_started.wait()
Georg Brandlb533e262008-05-25 18:19:30 +000063
64 def tearDown(self):
Georg Brandlb533e262008-05-25 18:19:30 +000065 self.thread.stop()
Antoine Pitrouf7270822012-09-30 01:05:30 +020066 self.thread = None
Nick Coghlan6ead5522009-10-18 13:19:33 +000067 os.environ.__exit__()
Antoine Pitrou45ebeb82009-10-27 18:52:30 +000068 support.threading_cleanup(*self._threads)
Georg Brandlb533e262008-05-25 18:19:30 +000069
70 def request(self, uri, method='GET', body=None, headers={}):
Antoine Pitroucb342182011-03-21 00:26:51 +010071 self.connection = http.client.HTTPConnection(self.HOST, self.PORT)
Georg Brandlb533e262008-05-25 18:19:30 +000072 self.connection.request(method, uri, body, headers)
73 return self.connection.getresponse()
74
75
76class BaseHTTPServerTestCase(BaseTestCase):
77 class request_handler(NoLogRequestHandler, BaseHTTPRequestHandler):
78 protocol_version = 'HTTP/1.1'
79 default_request_version = 'HTTP/1.1'
80
81 def do_TEST(self):
Serhiy Storchakac0a23e62015-03-07 11:51:37 +020082 self.send_response(HTTPStatus.NO_CONTENT)
Georg Brandlb533e262008-05-25 18:19:30 +000083 self.send_header('Content-Type', 'text/html')
84 self.send_header('Connection', 'close')
85 self.end_headers()
86
87 def do_KEEP(self):
Serhiy Storchakac0a23e62015-03-07 11:51:37 +020088 self.send_response(HTTPStatus.NO_CONTENT)
Georg Brandlb533e262008-05-25 18:19:30 +000089 self.send_header('Content-Type', 'text/html')
90 self.send_header('Connection', 'keep-alive')
91 self.end_headers()
92
93 def do_KEYERROR(self):
94 self.send_error(999)
95
Senthil Kumaran52d27202012-10-10 23:16:21 -070096 def do_NOTFOUND(self):
Serhiy Storchakac0a23e62015-03-07 11:51:37 +020097 self.send_error(HTTPStatus.NOT_FOUND)
Senthil Kumaran52d27202012-10-10 23:16:21 -070098
Senthil Kumaran26886442013-03-15 07:53:21 -070099 def do_EXPLAINERROR(self):
100 self.send_error(999, "Short Message",
101 "This is a long \n explaination")
102
Georg Brandlb533e262008-05-25 18:19:30 +0000103 def do_CUSTOM(self):
104 self.send_response(999)
105 self.send_header('Content-Type', 'text/html')
106 self.send_header('Connection', 'close')
107 self.end_headers()
108
Armin Ronacher8d96d772011-01-22 13:13:05 +0000109 def do_LATINONEHEADER(self):
110 self.send_response(999)
111 self.send_header('X-Special', 'Dängerous Mind')
Armin Ronacher59531282011-01-22 13:44:22 +0000112 self.send_header('Connection', 'close')
Armin Ronacher8d96d772011-01-22 13:13:05 +0000113 self.end_headers()
Armin Ronacher59531282011-01-22 13:44:22 +0000114 body = self.headers['x-special-incoming'].encode('utf-8')
115 self.wfile.write(body)
Armin Ronacher8d96d772011-01-22 13:13:05 +0000116
Georg Brandlb533e262008-05-25 18:19:30 +0000117 def setUp(self):
118 BaseTestCase.setUp(self)
Antoine Pitroucb342182011-03-21 00:26:51 +0100119 self.con = http.client.HTTPConnection(self.HOST, self.PORT)
Georg Brandlb533e262008-05-25 18:19:30 +0000120 self.con.connect()
121
122 def test_command(self):
123 self.con.request('GET', '/')
124 res = self.con.getresponse()
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200125 self.assertEqual(res.status, HTTPStatus.NOT_IMPLEMENTED)
Georg Brandlb533e262008-05-25 18:19:30 +0000126
127 def test_request_line_trimming(self):
128 self.con._http_vsn_str = 'HTTP/1.1\n'
R David Murray14199f92014-06-24 16:39:49 -0400129 self.con.putrequest('XYZBOGUS', '/')
Georg Brandlb533e262008-05-25 18:19:30 +0000130 self.con.endheaders()
131 res = self.con.getresponse()
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200132 self.assertEqual(res.status, HTTPStatus.NOT_IMPLEMENTED)
Georg Brandlb533e262008-05-25 18:19:30 +0000133
134 def test_version_bogus(self):
135 self.con._http_vsn_str = 'FUBAR'
136 self.con.putrequest('GET', '/')
137 self.con.endheaders()
138 res = self.con.getresponse()
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200139 self.assertEqual(res.status, HTTPStatus.BAD_REQUEST)
Georg Brandlb533e262008-05-25 18:19:30 +0000140
141 def test_version_digits(self):
142 self.con._http_vsn_str = 'HTTP/9.9.9'
143 self.con.putrequest('GET', '/')
144 self.con.endheaders()
145 res = self.con.getresponse()
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200146 self.assertEqual(res.status, HTTPStatus.BAD_REQUEST)
Georg Brandlb533e262008-05-25 18:19:30 +0000147
148 def test_version_none_get(self):
149 self.con._http_vsn_str = ''
150 self.con.putrequest('GET', '/')
151 self.con.endheaders()
152 res = self.con.getresponse()
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200153 self.assertEqual(res.status, HTTPStatus.NOT_IMPLEMENTED)
Georg Brandlb533e262008-05-25 18:19:30 +0000154
155 def test_version_none(self):
R David Murray14199f92014-06-24 16:39:49 -0400156 # Test that a valid method is rejected when not HTTP/1.x
Georg Brandlb533e262008-05-25 18:19:30 +0000157 self.con._http_vsn_str = ''
R David Murray14199f92014-06-24 16:39:49 -0400158 self.con.putrequest('CUSTOM', '/')
Georg Brandlb533e262008-05-25 18:19:30 +0000159 self.con.endheaders()
160 res = self.con.getresponse()
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200161 self.assertEqual(res.status, HTTPStatus.BAD_REQUEST)
Georg Brandlb533e262008-05-25 18:19:30 +0000162
163 def test_version_invalid(self):
164 self.con._http_vsn = 99
165 self.con._http_vsn_str = 'HTTP/9.9'
166 self.con.putrequest('GET', '/')
167 self.con.endheaders()
168 res = self.con.getresponse()
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200169 self.assertEqual(res.status, HTTPStatus.HTTP_VERSION_NOT_SUPPORTED)
Georg Brandlb533e262008-05-25 18:19:30 +0000170
171 def test_send_blank(self):
172 self.con._http_vsn_str = ''
173 self.con.putrequest('', '')
174 self.con.endheaders()
175 res = self.con.getresponse()
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200176 self.assertEqual(res.status, HTTPStatus.BAD_REQUEST)
Georg Brandlb533e262008-05-25 18:19:30 +0000177
178 def test_header_close(self):
179 self.con.putrequest('GET', '/')
180 self.con.putheader('Connection', 'close')
181 self.con.endheaders()
182 res = self.con.getresponse()
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200183 self.assertEqual(res.status, HTTPStatus.NOT_IMPLEMENTED)
Georg Brandlb533e262008-05-25 18:19:30 +0000184
185 def test_head_keep_alive(self):
186 self.con._http_vsn_str = 'HTTP/1.1'
187 self.con.putrequest('GET', '/')
188 self.con.putheader('Connection', 'keep-alive')
189 self.con.endheaders()
190 res = self.con.getresponse()
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200191 self.assertEqual(res.status, HTTPStatus.NOT_IMPLEMENTED)
Georg Brandlb533e262008-05-25 18:19:30 +0000192
193 def test_handler(self):
194 self.con.request('TEST', '/')
195 res = self.con.getresponse()
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200196 self.assertEqual(res.status, HTTPStatus.NO_CONTENT)
Georg Brandlb533e262008-05-25 18:19:30 +0000197
198 def test_return_header_keep_alive(self):
199 self.con.request('KEEP', '/')
200 res = self.con.getresponse()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000201 self.assertEqual(res.getheader('Connection'), 'keep-alive')
Georg Brandlb533e262008-05-25 18:19:30 +0000202 self.con.request('TEST', '/')
Brian Curtin61d0d602010-10-31 00:34:23 +0000203 self.addCleanup(self.con.close)
Georg Brandlb533e262008-05-25 18:19:30 +0000204
205 def test_internal_key_error(self):
206 self.con.request('KEYERROR', '/')
207 res = self.con.getresponse()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000208 self.assertEqual(res.status, 999)
Georg Brandlb533e262008-05-25 18:19:30 +0000209
210 def test_return_custom_status(self):
211 self.con.request('CUSTOM', '/')
212 res = self.con.getresponse()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000213 self.assertEqual(res.status, 999)
Georg Brandlb533e262008-05-25 18:19:30 +0000214
Senthil Kumaran26886442013-03-15 07:53:21 -0700215 def test_return_explain_error(self):
216 self.con.request('EXPLAINERROR', '/')
217 res = self.con.getresponse()
218 self.assertEqual(res.status, 999)
219 self.assertTrue(int(res.getheader('Content-Length')))
220
Armin Ronacher8d96d772011-01-22 13:13:05 +0000221 def test_latin1_header(self):
Armin Ronacher59531282011-01-22 13:44:22 +0000222 self.con.request('LATINONEHEADER', '/', headers={
223 'X-Special-Incoming': 'Ärger mit Unicode'
224 })
Armin Ronacher8d96d772011-01-22 13:13:05 +0000225 res = self.con.getresponse()
226 self.assertEqual(res.getheader('X-Special'), 'Dängerous Mind')
Armin Ronacher59531282011-01-22 13:44:22 +0000227 self.assertEqual(res.read(), 'Ärger mit Unicode'.encode('utf-8'))
Armin Ronacher8d96d772011-01-22 13:13:05 +0000228
Senthil Kumaran52d27202012-10-10 23:16:21 -0700229 def test_error_content_length(self):
230 # Issue #16088: standard error responses should have a content-length
231 self.con.request('NOTFOUND', '/')
232 res = self.con.getresponse()
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200233 self.assertEqual(res.status, HTTPStatus.NOT_FOUND)
234
Senthil Kumaran52d27202012-10-10 23:16:21 -0700235 data = res.read()
Senthil Kumaran52d27202012-10-10 23:16:21 -0700236 self.assertEqual(int(res.getheader('Content-Length')), len(data))
237
Georg Brandlb533e262008-05-25 18:19:30 +0000238
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200239class RequestHandlerLoggingTestCase(BaseTestCase):
240 class request_handler(BaseHTTPRequestHandler):
241 protocol_version = 'HTTP/1.1'
242 default_request_version = 'HTTP/1.1'
243
244 def do_GET(self):
245 self.send_response(HTTPStatus.OK)
246 self.end_headers()
247
248 def do_ERROR(self):
249 self.send_error(HTTPStatus.NOT_FOUND, 'File not found')
250
251 def test_get(self):
252 self.con = http.client.HTTPConnection(self.HOST, self.PORT)
253 self.con.connect()
254
255 with support.captured_stderr() as err:
256 self.con.request('GET', '/')
257 self.con.getresponse()
258
259 self.assertTrue(
260 err.getvalue().endswith('"GET / HTTP/1.1" 200 -\n'))
261
262 def test_err(self):
263 self.con = http.client.HTTPConnection(self.HOST, self.PORT)
264 self.con.connect()
265
266 with support.captured_stderr() as err:
267 self.con.request('ERROR', '/')
268 self.con.getresponse()
269
270 lines = err.getvalue().split('\n')
271 self.assertTrue(lines[0].endswith('code 404, message File not found'))
272 self.assertTrue(lines[1].endswith('"ERROR / HTTP/1.1" 404 -'))
273
274
Georg Brandlb533e262008-05-25 18:19:30 +0000275class SimpleHTTPServerTestCase(BaseTestCase):
276 class request_handler(NoLogRequestHandler, SimpleHTTPRequestHandler):
277 pass
278
279 def setUp(self):
280 BaseTestCase.setUp(self)
281 self.cwd = os.getcwd()
282 basetempdir = tempfile.gettempdir()
283 os.chdir(basetempdir)
284 self.data = b'We are the knights who say Ni!'
285 self.tempdir = tempfile.mkdtemp(dir=basetempdir)
286 self.tempdir_name = os.path.basename(self.tempdir)
Brett Cannon105df5d2010-10-29 23:43:42 +0000287 with open(os.path.join(self.tempdir, 'test'), 'wb') as temp:
288 temp.write(self.data)
Georg Brandlb533e262008-05-25 18:19:30 +0000289
290 def tearDown(self):
291 try:
292 os.chdir(self.cwd)
293 try:
294 shutil.rmtree(self.tempdir)
295 except:
296 pass
297 finally:
298 BaseTestCase.tearDown(self)
299
300 def check_status_and_reason(self, response, status, data=None):
301 body = response.read()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000302 self.assertTrue(response)
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000303 self.assertEqual(response.status, status)
304 self.assertIsNotNone(response.reason)
Georg Brandlb533e262008-05-25 18:19:30 +0000305 if data:
306 self.assertEqual(data, body)
Serhiy Storchakacb5bc402014-08-17 08:22:11 +0300307 return body
308
Ned Deily14183202015-01-05 01:02:30 -0800309 @support.requires_mac_ver(10, 5)
Serhiy Storchakacb5bc402014-08-17 08:22:11 +0300310 @unittest.skipUnless(support.TESTFN_UNDECODABLE,
311 'need support.TESTFN_UNDECODABLE')
312 def test_undecodable_filename(self):
Serhiy Storchakaa64ce5d2014-08-17 12:20:02 +0300313 enc = sys.getfilesystemencoding()
Serhiy Storchakacb5bc402014-08-17 08:22:11 +0300314 filename = os.fsdecode(support.TESTFN_UNDECODABLE) + '.txt'
315 with open(os.path.join(self.tempdir, filename), 'wb') as f:
316 f.write(support.TESTFN_UNDECODABLE)
317 response = self.request(self.tempdir_name + '/')
Serhiy Storchakad9e95282014-08-17 16:57:39 +0300318 if sys.platform == 'darwin':
319 # On Mac OS the HFS+ filesystem replaces bytes that aren't valid
320 # UTF-8 into a percent-encoded value.
321 for name in os.listdir(self.tempdir):
322 if name != 'test': # Ignore a filename created in setUp().
323 filename = name
324 break
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200325 body = self.check_status_and_reason(response, HTTPStatus.OK)
Serhiy Storchakacb5bc402014-08-17 08:22:11 +0300326 quotedname = urllib.parse.quote(filename, errors='surrogatepass')
327 self.assertIn(('href="%s"' % quotedname)
Serhiy Storchakaa64ce5d2014-08-17 12:20:02 +0300328 .encode(enc, 'surrogateescape'), body)
Serhiy Storchakacb5bc402014-08-17 08:22:11 +0300329 self.assertIn(('>%s<' % html.escape(filename))
Serhiy Storchakaa64ce5d2014-08-17 12:20:02 +0300330 .encode(enc, 'surrogateescape'), body)
Serhiy Storchakacb5bc402014-08-17 08:22:11 +0300331 response = self.request(self.tempdir_name + '/' + quotedname)
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200332 self.check_status_and_reason(response, HTTPStatus.OK,
Serhiy Storchakacb5bc402014-08-17 08:22:11 +0300333 data=support.TESTFN_UNDECODABLE)
Georg Brandlb533e262008-05-25 18:19:30 +0000334
335 def test_get(self):
336 #constructs the path relative to the root directory of the HTTPServer
337 response = self.request(self.tempdir_name + '/test')
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200338 self.check_status_and_reason(response, HTTPStatus.OK, data=self.data)
Senthil Kumaran72c238e2013-09-13 00:21:18 -0700339 # check for trailing "/" which should return 404. See Issue17324
340 response = self.request(self.tempdir_name + '/test/')
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200341 self.check_status_and_reason(response, HTTPStatus.NOT_FOUND)
Georg Brandlb533e262008-05-25 18:19:30 +0000342 response = self.request(self.tempdir_name + '/')
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200343 self.check_status_and_reason(response, HTTPStatus.OK)
Georg Brandlb533e262008-05-25 18:19:30 +0000344 response = self.request(self.tempdir_name)
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200345 self.check_status_and_reason(response, HTTPStatus.MOVED_PERMANENTLY)
Benjamin Peterson94cb7a22014-12-26 10:53:43 -0600346 response = self.request(self.tempdir_name + '/?hi=2')
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200347 self.check_status_and_reason(response, HTTPStatus.OK)
Benjamin Peterson94cb7a22014-12-26 10:53:43 -0600348 response = self.request(self.tempdir_name + '?hi=1')
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200349 self.check_status_and_reason(response, HTTPStatus.MOVED_PERMANENTLY)
Benjamin Peterson94cb7a22014-12-26 10:53:43 -0600350 self.assertEqual(response.getheader("Location"),
351 self.tempdir_name + "/?hi=1")
Georg Brandlb533e262008-05-25 18:19:30 +0000352 response = self.request('/ThisDoesNotExist')
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200353 self.check_status_and_reason(response, HTTPStatus.NOT_FOUND)
Georg Brandlb533e262008-05-25 18:19:30 +0000354 response = self.request('/' + 'ThisDoesNotExist' + '/')
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200355 self.check_status_and_reason(response, HTTPStatus.NOT_FOUND)
Brett Cannon105df5d2010-10-29 23:43:42 +0000356 with open(os.path.join(self.tempdir_name, 'index.html'), 'w') as f:
357 response = self.request('/' + self.tempdir_name + '/')
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200358 self.check_status_and_reason(response, HTTPStatus.OK)
Charles-François Natalif7ed9fc2011-11-02 19:35:14 +0100359 # chmod() doesn't work as expected on Windows, and filesystem
360 # permissions are ignored by root on Unix.
361 if os.name == 'posix' and os.geteuid() != 0:
Brett Cannon105df5d2010-10-29 23:43:42 +0000362 os.chmod(self.tempdir, 0)
363 response = self.request(self.tempdir_name + '/')
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200364 self.check_status_and_reason(response, HTTPStatus.NOT_FOUND)
Brett Cannon105df5d2010-10-29 23:43:42 +0000365 os.chmod(self.tempdir, 0o755)
Georg Brandlb533e262008-05-25 18:19:30 +0000366
367 def test_head(self):
368 response = self.request(
369 self.tempdir_name + '/test', method='HEAD')
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200370 self.check_status_and_reason(response, HTTPStatus.OK)
Georg Brandlb533e262008-05-25 18:19:30 +0000371 self.assertEqual(response.getheader('content-length'),
372 str(len(self.data)))
373 self.assertEqual(response.getheader('content-type'),
374 'application/octet-stream')
375
376 def test_invalid_requests(self):
377 response = self.request('/', method='FOO')
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200378 self.check_status_and_reason(response, HTTPStatus.NOT_IMPLEMENTED)
Georg Brandlb533e262008-05-25 18:19:30 +0000379 # requests must be case sensitive,so this should fail too
Terry Jan Reedydd09efd2014-10-18 17:10:09 -0400380 response = self.request('/', method='custom')
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200381 self.check_status_and_reason(response, HTTPStatus.NOT_IMPLEMENTED)
Georg Brandlb533e262008-05-25 18:19:30 +0000382 response = self.request('/', method='GETs')
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200383 self.check_status_and_reason(response, HTTPStatus.NOT_IMPLEMENTED)
Georg Brandlb533e262008-05-25 18:19:30 +0000384
385
386cgi_file1 = """\
387#!%s
388
389print("Content-type: text/html")
390print()
391print("Hello World")
392"""
393
394cgi_file2 = """\
395#!%s
396import cgi
397
398print("Content-type: text/html")
399print()
400
401form = cgi.FieldStorage()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000402print("%%s, %%s, %%s" %% (form.getfirst("spam"), form.getfirst("eggs"),
403 form.getfirst("bacon")))
Georg Brandlb533e262008-05-25 18:19:30 +0000404"""
405
Charles-François Natalif7ed9fc2011-11-02 19:35:14 +0100406
407@unittest.skipIf(hasattr(os, 'geteuid') and os.geteuid() == 0,
408 "This test can't be run reliably as root (issue #13308).")
Georg Brandlb533e262008-05-25 18:19:30 +0000409class CGIHTTPServerTestCase(BaseTestCase):
410 class request_handler(NoLogRequestHandler, CGIHTTPRequestHandler):
411 pass
412
Antoine Pitroue768c392012-08-05 14:52:45 +0200413 linesep = os.linesep.encode('ascii')
414
Georg Brandlb533e262008-05-25 18:19:30 +0000415 def setUp(self):
416 BaseTestCase.setUp(self)
Victor Stinner0b0ca0c2010-10-17 19:46:36 +0000417 self.cwd = os.getcwd()
Georg Brandlb533e262008-05-25 18:19:30 +0000418 self.parent_dir = tempfile.mkdtemp()
419 self.cgi_dir = os.path.join(self.parent_dir, 'cgi-bin')
Ned Deily915a30f2014-07-12 22:06:26 -0700420 self.cgi_child_dir = os.path.join(self.cgi_dir, 'child-dir')
Georg Brandlb533e262008-05-25 18:19:30 +0000421 os.mkdir(self.cgi_dir)
Ned Deily915a30f2014-07-12 22:06:26 -0700422 os.mkdir(self.cgi_child_dir)
Benjamin Peterson35aca892013-10-30 12:48:59 -0400423 self.nocgi_path = None
Victor Stinner0b0ca0c2010-10-17 19:46:36 +0000424 self.file1_path = None
425 self.file2_path = None
Ned Deily915a30f2014-07-12 22:06:26 -0700426 self.file3_path = None
Georg Brandlb533e262008-05-25 18:19:30 +0000427
Florent Xiclunafd1b0932010-03-28 00:25:02 +0000428 # The shebang line should be pure ASCII: use symlink if possible.
429 # See issue #7668.
Brian Curtin3b4499c2010-12-28 14:31:47 +0000430 if support.can_symlink():
Florent Xiclunafd1b0932010-03-28 00:25:02 +0000431 self.pythonexe = os.path.join(self.parent_dir, 'python')
432 os.symlink(sys.executable, self.pythonexe)
433 else:
434 self.pythonexe = sys.executable
435
Victor Stinner3218c312010-10-17 20:13:36 +0000436 try:
437 # The python executable path is written as the first line of the
438 # CGI Python script. The encoding cookie cannot be used, and so the
439 # path should be encodable to the default script encoding (utf-8)
440 self.pythonexe.encode('utf-8')
441 except UnicodeEncodeError:
442 self.tearDown()
Serhiy Storchaka0b4591e2013-02-04 15:45:00 +0200443 self.skipTest("Python executable path is not encodable to utf-8")
Victor Stinner3218c312010-10-17 20:13:36 +0000444
Benjamin Peterson04e9de42013-10-30 12:43:09 -0400445 self.nocgi_path = os.path.join(self.parent_dir, 'nocgi.py')
446 with open(self.nocgi_path, 'w') as fp:
447 fp.write(cgi_file1 % self.pythonexe)
448 os.chmod(self.nocgi_path, 0o777)
449
Georg Brandlb533e262008-05-25 18:19:30 +0000450 self.file1_path = os.path.join(self.cgi_dir, 'file1.py')
Victor Stinner6fb45752010-10-17 20:17:41 +0000451 with open(self.file1_path, 'w', encoding='utf-8') as file1:
Florent Xiclunafd1b0932010-03-28 00:25:02 +0000452 file1.write(cgi_file1 % self.pythonexe)
Georg Brandlb533e262008-05-25 18:19:30 +0000453 os.chmod(self.file1_path, 0o777)
454
455 self.file2_path = os.path.join(self.cgi_dir, 'file2.py')
Victor Stinner6fb45752010-10-17 20:17:41 +0000456 with open(self.file2_path, 'w', encoding='utf-8') as file2:
Florent Xiclunafd1b0932010-03-28 00:25:02 +0000457 file2.write(cgi_file2 % self.pythonexe)
Georg Brandlb533e262008-05-25 18:19:30 +0000458 os.chmod(self.file2_path, 0o777)
459
Ned Deily915a30f2014-07-12 22:06:26 -0700460 self.file3_path = os.path.join(self.cgi_child_dir, 'file3.py')
461 with open(self.file3_path, 'w', encoding='utf-8') as file3:
462 file3.write(cgi_file1 % self.pythonexe)
463 os.chmod(self.file3_path, 0o777)
464
Georg Brandlb533e262008-05-25 18:19:30 +0000465 os.chdir(self.parent_dir)
466
467 def tearDown(self):
468 try:
469 os.chdir(self.cwd)
Florent Xiclunafd1b0932010-03-28 00:25:02 +0000470 if self.pythonexe != sys.executable:
471 os.remove(self.pythonexe)
Benjamin Peterson35aca892013-10-30 12:48:59 -0400472 if self.nocgi_path:
473 os.remove(self.nocgi_path)
Victor Stinner0b0ca0c2010-10-17 19:46:36 +0000474 if self.file1_path:
475 os.remove(self.file1_path)
476 if self.file2_path:
477 os.remove(self.file2_path)
Ned Deily915a30f2014-07-12 22:06:26 -0700478 if self.file3_path:
479 os.remove(self.file3_path)
480 os.rmdir(self.cgi_child_dir)
Georg Brandlb533e262008-05-25 18:19:30 +0000481 os.rmdir(self.cgi_dir)
482 os.rmdir(self.parent_dir)
483 finally:
484 BaseTestCase.tearDown(self)
485
Senthil Kumarand70846b2012-04-12 02:34:32 +0800486 def test_url_collapse_path(self):
487 # verify tail is the last portion and head is the rest on proper urls
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000488 test_vectors = {
Senthil Kumarand70846b2012-04-12 02:34:32 +0800489 '': '//',
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000490 '..': IndexError,
491 '/.//..': IndexError,
Senthil Kumarand70846b2012-04-12 02:34:32 +0800492 '/': '//',
493 '//': '//',
494 '/\\': '//\\',
495 '/.//': '//',
496 'cgi-bin/file1.py': '/cgi-bin/file1.py',
497 '/cgi-bin/file1.py': '/cgi-bin/file1.py',
498 'a': '//a',
499 '/a': '//a',
500 '//a': '//a',
501 './a': '//a',
502 './C:/': '/C:/',
503 '/a/b': '/a/b',
504 '/a/b/': '/a/b/',
505 '/a/b/.': '/a/b/',
506 '/a/b/c/..': '/a/b/',
507 '/a/b/c/../d': '/a/b/d',
508 '/a/b/c/../d/e/../f': '/a/b/d/f',
509 '/a/b/c/../d/e/../../f': '/a/b/f',
510 '/a/b/c/../d/e/.././././..//f': '/a/b/f',
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000511 '../a/b/c/../d/e/.././././..//f': IndexError,
Senthil Kumarand70846b2012-04-12 02:34:32 +0800512 '/a/b/c/../d/e/../../../f': '/a/f',
513 '/a/b/c/../d/e/../../../../f': '//f',
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000514 '/a/b/c/../d/e/../../../../../f': IndexError,
Senthil Kumarand70846b2012-04-12 02:34:32 +0800515 '/a/b/c/../d/e/../../../../f/..': '//',
516 '/a/b/c/../d/e/../../../../f/../.': '//',
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000517 }
518 for path, expected in test_vectors.items():
519 if isinstance(expected, type) and issubclass(expected, Exception):
520 self.assertRaises(expected,
Senthil Kumarand70846b2012-04-12 02:34:32 +0800521 server._url_collapse_path, path)
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000522 else:
Senthil Kumarand70846b2012-04-12 02:34:32 +0800523 actual = server._url_collapse_path(path)
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000524 self.assertEqual(expected, actual,
525 msg='path = %r\nGot: %r\nWanted: %r' %
526 (path, actual, expected))
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000527
Georg Brandlb533e262008-05-25 18:19:30 +0000528 def test_headers_and_content(self):
529 res = self.request('/cgi-bin/file1.py')
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200530 self.assertEqual(
531 (res.read(), res.getheader('Content-type'), res.status),
532 (b'Hello World' + self.linesep, 'text/html', HTTPStatus.OK))
Georg Brandlb533e262008-05-25 18:19:30 +0000533
Benjamin Peterson04e9de42013-10-30 12:43:09 -0400534 def test_issue19435(self):
535 res = self.request('///////////nocgi.py/../cgi-bin/nothere.sh')
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200536 self.assertEqual(res.status, HTTPStatus.NOT_FOUND)
Benjamin Peterson04e9de42013-10-30 12:43:09 -0400537
Georg Brandlb533e262008-05-25 18:19:30 +0000538 def test_post(self):
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000539 params = urllib.parse.urlencode(
540 {'spam' : 1, 'eggs' : 'python', 'bacon' : 123456})
Georg Brandlb533e262008-05-25 18:19:30 +0000541 headers = {'Content-type' : 'application/x-www-form-urlencoded'}
542 res = self.request('/cgi-bin/file2.py', 'POST', params, headers)
543
Antoine Pitroue768c392012-08-05 14:52:45 +0200544 self.assertEqual(res.read(), b'1, python, 123456' + self.linesep)
Georg Brandlb533e262008-05-25 18:19:30 +0000545
546 def test_invaliduri(self):
547 res = self.request('/cgi-bin/invalid')
548 res.read()
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200549 self.assertEqual(res.status, HTTPStatus.NOT_FOUND)
Georg Brandlb533e262008-05-25 18:19:30 +0000550
551 def test_authorization(self):
552 headers = {b'Authorization' : b'Basic ' +
553 base64.b64encode(b'username:pass')}
554 res = self.request('/cgi-bin/file1.py', 'GET', headers=headers)
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200555 self.assertEqual(
556 (b'Hello World' + self.linesep, 'text/html', HTTPStatus.OK),
557 (res.read(), res.getheader('Content-type'), res.status))
Georg Brandlb533e262008-05-25 18:19:30 +0000558
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000559 def test_no_leading_slash(self):
560 # http://bugs.python.org/issue2254
561 res = self.request('cgi-bin/file1.py')
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200562 self.assertEqual(
563 (b'Hello World' + self.linesep, 'text/html', HTTPStatus.OK),
564 (res.read(), res.getheader('Content-type'), res.status))
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000565
Senthil Kumaran42713722010-10-03 17:55:45 +0000566 def test_os_environ_is_not_altered(self):
567 signature = "Test CGI Server"
568 os.environ['SERVER_SOFTWARE'] = signature
569 res = self.request('/cgi-bin/file1.py')
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200570 self.assertEqual(
571 (b'Hello World' + self.linesep, 'text/html', HTTPStatus.OK),
572 (res.read(), res.getheader('Content-type'), res.status))
Senthil Kumaran42713722010-10-03 17:55:45 +0000573 self.assertEqual(os.environ['SERVER_SOFTWARE'], signature)
574
Benjamin Peterson73b8b1c2014-06-14 18:36:29 -0700575 def test_urlquote_decoding_in_cgi_check(self):
576 res = self.request('/cgi-bin%2ffile1.py')
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200577 self.assertEqual(
578 (b'Hello World' + self.linesep, 'text/html', HTTPStatus.OK),
579 (res.read(), res.getheader('Content-type'), res.status))
Benjamin Peterson73b8b1c2014-06-14 18:36:29 -0700580
Ned Deily915a30f2014-07-12 22:06:26 -0700581 def test_nested_cgi_path_issue21323(self):
582 res = self.request('/cgi-bin/child-dir/file3.py')
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200583 self.assertEqual(
584 (b'Hello World' + self.linesep, 'text/html', HTTPStatus.OK),
585 (res.read(), res.getheader('Content-type'), res.status))
Ned Deily915a30f2014-07-12 22:06:26 -0700586
Georg Brandlb533e262008-05-25 18:19:30 +0000587
Georg Brandl6fcac0d2010-08-02 18:56:54 +0000588class SocketlessRequestHandler(SimpleHTTPRequestHandler):
589 def __init__(self):
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000590 self.get_called = False
591 self.protocol_version = "HTTP/1.1"
592
593 def do_GET(self):
594 self.get_called = True
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200595 self.send_response(HTTPStatus.OK)
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000596 self.send_header('Content-Type', 'text/html')
597 self.end_headers()
598 self.wfile.write(b'<html><body>Data</body></html>\r\n')
599
600 def log_message(self, format, *args):
Georg Brandl6fcac0d2010-08-02 18:56:54 +0000601 pass
602
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000603class RejectingSocketlessRequestHandler(SocketlessRequestHandler):
604 def handle_expect_100(self):
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200605 self.send_error(HTTPStatus.EXPECTATION_FAILED)
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000606 return False
607
Senthil Kumaranc7ae19b2011-05-09 23:25:02 +0800608
609class AuditableBytesIO:
610
611 def __init__(self):
612 self.datas = []
613
614 def write(self, data):
615 self.datas.append(data)
616
617 def getData(self):
618 return b''.join(self.datas)
619
620 @property
621 def numWrites(self):
622 return len(self.datas)
623
624
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000625class BaseHTTPRequestHandlerTestCase(unittest.TestCase):
Ezio Melotti3b3499b2011-03-16 11:35:38 +0200626 """Test the functionality of the BaseHTTPServer.
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000627
628 Test the support for the Expect 100-continue header.
629 """
630
631 HTTPResponseMatch = re.compile(b'HTTP/1.[0-9]+ 200 OK')
632
633 def setUp (self):
634 self.handler = SocketlessRequestHandler()
635
636 def send_typical_request(self, message):
637 input = BytesIO(message)
638 output = BytesIO()
639 self.handler.rfile = input
640 self.handler.wfile = output
641 self.handler.handle_one_request()
642 output.seek(0)
643 return output.readlines()
644
645 def verify_get_called(self):
646 self.assertTrue(self.handler.get_called)
647
648 def verify_expected_headers(self, headers):
649 for fieldName in b'Server: ', b'Date: ', b'Content-Type: ':
650 self.assertEqual(sum(h.startswith(fieldName) for h in headers), 1)
651
652 def verify_http_server_response(self, response):
653 match = self.HTTPResponseMatch.search(response)
Serhiy Storchaka25d8aea2014-02-08 14:50:08 +0200654 self.assertIsNotNone(match)
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000655
656 def test_http_1_1(self):
657 result = self.send_typical_request(b'GET / HTTP/1.1\r\n\r\n')
658 self.verify_http_server_response(result[0])
659 self.verify_expected_headers(result[1:-1])
660 self.verify_get_called()
661 self.assertEqual(result[-1], b'<html><body>Data</body></html>\r\n')
Benjamin Peterson70e28472015-02-17 21:11:10 -0500662 self.assertEqual(self.handler.requestline, 'GET / HTTP/1.1')
663 self.assertEqual(self.handler.command, 'GET')
664 self.assertEqual(self.handler.path, '/')
665 self.assertEqual(self.handler.request_version, 'HTTP/1.1')
666 self.assertSequenceEqual(self.handler.headers.items(), ())
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000667
668 def test_http_1_0(self):
669 result = self.send_typical_request(b'GET / HTTP/1.0\r\n\r\n')
670 self.verify_http_server_response(result[0])
671 self.verify_expected_headers(result[1:-1])
672 self.verify_get_called()
673 self.assertEqual(result[-1], b'<html><body>Data</body></html>\r\n')
Benjamin Peterson70e28472015-02-17 21:11:10 -0500674 self.assertEqual(self.handler.requestline, 'GET / HTTP/1.0')
675 self.assertEqual(self.handler.command, 'GET')
676 self.assertEqual(self.handler.path, '/')
677 self.assertEqual(self.handler.request_version, 'HTTP/1.0')
678 self.assertSequenceEqual(self.handler.headers.items(), ())
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000679
680 def test_http_0_9(self):
681 result = self.send_typical_request(b'GET / HTTP/0.9\r\n\r\n')
682 self.assertEqual(len(result), 1)
683 self.assertEqual(result[0], b'<html><body>Data</body></html>\r\n')
684 self.verify_get_called()
685
686 def test_with_continue_1_0(self):
687 result = self.send_typical_request(b'GET / HTTP/1.0\r\nExpect: 100-continue\r\n\r\n')
688 self.verify_http_server_response(result[0])
689 self.verify_expected_headers(result[1:-1])
690 self.verify_get_called()
691 self.assertEqual(result[-1], b'<html><body>Data</body></html>\r\n')
Benjamin Peterson70e28472015-02-17 21:11:10 -0500692 self.assertEqual(self.handler.requestline, 'GET / HTTP/1.0')
693 self.assertEqual(self.handler.command, 'GET')
694 self.assertEqual(self.handler.path, '/')
695 self.assertEqual(self.handler.request_version, 'HTTP/1.0')
696 headers = (("Expect", "100-continue"),)
697 self.assertSequenceEqual(self.handler.headers.items(), headers)
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000698
699 def test_with_continue_1_1(self):
700 result = self.send_typical_request(b'GET / HTTP/1.1\r\nExpect: 100-continue\r\n\r\n')
701 self.assertEqual(result[0], b'HTTP/1.1 100 Continue\r\n')
Benjamin Peterson04424232014-01-18 21:50:18 -0500702 self.assertEqual(result[1], b'\r\n')
703 self.assertEqual(result[2], b'HTTP/1.1 200 OK\r\n')
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000704 self.verify_expected_headers(result[2:-1])
705 self.verify_get_called()
706 self.assertEqual(result[-1], b'<html><body>Data</body></html>\r\n')
Benjamin Peterson70e28472015-02-17 21:11:10 -0500707 self.assertEqual(self.handler.requestline, 'GET / HTTP/1.1')
708 self.assertEqual(self.handler.command, 'GET')
709 self.assertEqual(self.handler.path, '/')
710 self.assertEqual(self.handler.request_version, 'HTTP/1.1')
711 headers = (("Expect", "100-continue"),)
712 self.assertSequenceEqual(self.handler.headers.items(), headers)
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000713
Senthil Kumaranc7ae19b2011-05-09 23:25:02 +0800714 def test_header_buffering_of_send_error(self):
Senthil Kumarane4dad4f2010-11-21 14:36:14 +0000715
716 input = BytesIO(b'GET / HTTP/1.1\r\n\r\n')
Senthil Kumaranc7ae19b2011-05-09 23:25:02 +0800717 output = AuditableBytesIO()
718 handler = SocketlessRequestHandler()
719 handler.rfile = input
720 handler.wfile = output
721 handler.request_version = 'HTTP/1.1'
722 handler.requestline = ''
723 handler.command = None
Senthil Kumarane4dad4f2010-11-21 14:36:14 +0000724
Senthil Kumaranc7ae19b2011-05-09 23:25:02 +0800725 handler.send_error(418)
726 self.assertEqual(output.numWrites, 2)
727
728 def test_header_buffering_of_send_response_only(self):
729
730 input = BytesIO(b'GET / HTTP/1.1\r\n\r\n')
731 output = AuditableBytesIO()
732 handler = SocketlessRequestHandler()
733 handler.rfile = input
734 handler.wfile = output
735 handler.request_version = 'HTTP/1.1'
736
737 handler.send_response_only(418)
738 self.assertEqual(output.numWrites, 0)
739 handler.end_headers()
740 self.assertEqual(output.numWrites, 1)
741
742 def test_header_buffering_of_send_header(self):
743
744 input = BytesIO(b'GET / HTTP/1.1\r\n\r\n')
745 output = AuditableBytesIO()
746 handler = SocketlessRequestHandler()
747 handler.rfile = input
748 handler.wfile = output
749 handler.request_version = 'HTTP/1.1'
750
751 handler.send_header('Foo', 'foo')
752 handler.send_header('bar', 'bar')
753 self.assertEqual(output.numWrites, 0)
754 handler.end_headers()
755 self.assertEqual(output.getData(), b'Foo: foo\r\nbar: bar\r\n\r\n')
756 self.assertEqual(output.numWrites, 1)
Senthil Kumarane4dad4f2010-11-21 14:36:14 +0000757
758 def test_header_unbuffered_when_continue(self):
759
760 def _readAndReseek(f):
761 pos = f.tell()
762 f.seek(0)
763 data = f.read()
764 f.seek(pos)
765 return data
766
767 input = BytesIO(b'GET / HTTP/1.1\r\nExpect: 100-continue\r\n\r\n')
768 output = BytesIO()
769 self.handler.rfile = input
770 self.handler.wfile = output
771 self.handler.request_version = 'HTTP/1.1'
772
773 self.handler.handle_one_request()
774 self.assertNotEqual(_readAndReseek(output), b'')
775 result = _readAndReseek(output).split(b'\r\n')
776 self.assertEqual(result[0], b'HTTP/1.1 100 Continue')
Benjamin Peterson04424232014-01-18 21:50:18 -0500777 self.assertEqual(result[1], b'')
778 self.assertEqual(result[2], b'HTTP/1.1 200 OK')
Senthil Kumarane4dad4f2010-11-21 14:36:14 +0000779
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000780 def test_with_continue_rejected(self):
781 usual_handler = self.handler # Save to avoid breaking any subsequent tests.
782 self.handler = RejectingSocketlessRequestHandler()
783 result = self.send_typical_request(b'GET / HTTP/1.1\r\nExpect: 100-continue\r\n\r\n')
784 self.assertEqual(result[0], b'HTTP/1.1 417 Expectation Failed\r\n')
785 self.verify_expected_headers(result[1:-1])
786 # The expect handler should short circuit the usual get method by
787 # returning false here, so get_called should be false
788 self.assertFalse(self.handler.get_called)
789 self.assertEqual(sum(r == b'Connection: close\r\n' for r in result[1:-1]), 1)
790 self.handler = usual_handler # Restore to avoid breaking any subsequent tests.
791
Antoine Pitrouc4924372010-12-16 16:48:36 +0000792 def test_request_length(self):
793 # Issue #10714: huge request lines are discarded, to avoid Denial
794 # of Service attacks.
795 result = self.send_typical_request(b'GET ' + b'x' * 65537)
796 self.assertEqual(result[0], b'HTTP/1.1 414 Request-URI Too Long\r\n')
797 self.assertFalse(self.handler.get_called)
Benjamin Peterson70e28472015-02-17 21:11:10 -0500798 self.assertIsInstance(self.handler.requestline, str)
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000799
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000800 def test_header_length(self):
801 # Issue #6791: same for headers
802 result = self.send_typical_request(
803 b'GET / HTTP/1.1\r\nX-Foo: bar' + b'r' * 65537 + b'\r\n\r\n')
804 self.assertEqual(result[0], b'HTTP/1.1 400 Line too long\r\n')
805 self.assertFalse(self.handler.get_called)
Benjamin Peterson70e28472015-02-17 21:11:10 -0500806 self.assertEqual(self.handler.requestline, 'GET / HTTP/1.1')
807
808 def test_close_connection(self):
809 # handle_one_request() should be repeatedly called until
810 # it sets close_connection
811 def handle_one_request():
812 self.handler.close_connection = next(close_values)
813 self.handler.handle_one_request = handle_one_request
814
815 close_values = iter((True,))
816 self.handler.handle()
817 self.assertRaises(StopIteration, next, close_values)
818
819 close_values = iter((False, False, True))
820 self.handler.handle()
821 self.assertRaises(StopIteration, next, close_values)
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000822
Georg Brandl6fcac0d2010-08-02 18:56:54 +0000823class SimpleHTTPRequestHandlerTestCase(unittest.TestCase):
824 """ Test url parsing """
825 def setUp(self):
826 self.translated = os.getcwd()
827 self.translated = os.path.join(self.translated, 'filename')
828 self.handler = SocketlessRequestHandler()
829
830 def test_query_arguments(self):
831 path = self.handler.translate_path('/filename')
832 self.assertEqual(path, self.translated)
833 path = self.handler.translate_path('/filename?foo=bar')
834 self.assertEqual(path, self.translated)
835 path = self.handler.translate_path('/filename?a=b&spam=eggs#zot')
836 self.assertEqual(path, self.translated)
837
838 def test_start_with_double_slash(self):
839 path = self.handler.translate_path('//filename')
840 self.assertEqual(path, self.translated)
841 path = self.handler.translate_path('//filename?foo=bar')
842 self.assertEqual(path, self.translated)
843
844
Berker Peksag366c5702015-02-13 20:48:15 +0200845class MiscTestCase(unittest.TestCase):
846 def test_all(self):
847 expected = []
848 blacklist = {'executable', 'nobody_uid', 'test'}
849 for name in dir(server):
850 if name.startswith('_') or name in blacklist:
851 continue
852 module_object = getattr(server, name)
853 if getattr(module_object, '__module__', None) == 'http.server':
854 expected.append(name)
855 self.assertCountEqual(server.__all__, expected)
856
857
Georg Brandlb533e262008-05-25 18:19:30 +0000858def test_main(verbose=None):
Georg Brandl6fcac0d2010-08-02 18:56:54 +0000859 cwd = os.getcwd()
Georg Brandlb533e262008-05-25 18:19:30 +0000860 try:
Georg Brandl6fcac0d2010-08-02 18:56:54 +0000861 support.run_unittest(
Serhiy Storchakac0a23e62015-03-07 11:51:37 +0200862 RequestHandlerLoggingTestCase,
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000863 BaseHTTPRequestHandlerTestCase,
Georg Brandl6fcac0d2010-08-02 18:56:54 +0000864 BaseHTTPServerTestCase,
865 SimpleHTTPServerTestCase,
866 CGIHTTPServerTestCase,
867 SimpleHTTPRequestHandlerTestCase,
Berker Peksag366c5702015-02-13 20:48:15 +0200868 MiscTestCase,
Georg Brandl6fcac0d2010-08-02 18:56:54 +0000869 )
Georg Brandlb533e262008-05-25 18:19:30 +0000870 finally:
871 os.chdir(cwd)
872
873if __name__ == '__main__':
874 test_main()