blob: 569341d83b40d511f984c25c6cd3e58647d76b02 [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
Benjamin Petersonad71f0f2009-04-11 20:12:10 +00009from http import server
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):
82 self.send_response(204)
83 self.send_header('Content-Type', 'text/html')
84 self.send_header('Connection', 'close')
85 self.end_headers()
86
87 def do_KEEP(self):
88 self.send_response(204)
89 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):
97 self.send_error(404)
98
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()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000125 self.assertEqual(res.status, 501)
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()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000132 self.assertEqual(res.status, 501)
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()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000139 self.assertEqual(res.status, 400)
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()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000146 self.assertEqual(res.status, 400)
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()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000153 self.assertEqual(res.status, 501)
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()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000161 self.assertEqual(res.status, 400)
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()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000169 self.assertEqual(res.status, 505)
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()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000176 self.assertEqual(res.status, 400)
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()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000183 self.assertEqual(res.status, 501)
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()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000191 self.assertEqual(res.status, 501)
Georg Brandlb533e262008-05-25 18:19:30 +0000192
193 def test_handler(self):
194 self.con.request('TEST', '/')
195 res = self.con.getresponse()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000196 self.assertEqual(res.status, 204)
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()
233 self.assertEqual(res.status, 404)
234 data = res.read()
Senthil Kumaran52d27202012-10-10 23:16:21 -0700235 self.assertEqual(int(res.getheader('Content-Length')), len(data))
236
Georg Brandlb533e262008-05-25 18:19:30 +0000237
238class SimpleHTTPServerTestCase(BaseTestCase):
239 class request_handler(NoLogRequestHandler, SimpleHTTPRequestHandler):
240 pass
241
242 def setUp(self):
243 BaseTestCase.setUp(self)
244 self.cwd = os.getcwd()
245 basetempdir = tempfile.gettempdir()
246 os.chdir(basetempdir)
247 self.data = b'We are the knights who say Ni!'
248 self.tempdir = tempfile.mkdtemp(dir=basetempdir)
249 self.tempdir_name = os.path.basename(self.tempdir)
Brett Cannon105df5d2010-10-29 23:43:42 +0000250 with open(os.path.join(self.tempdir, 'test'), 'wb') as temp:
251 temp.write(self.data)
Georg Brandlb533e262008-05-25 18:19:30 +0000252
253 def tearDown(self):
254 try:
255 os.chdir(self.cwd)
256 try:
257 shutil.rmtree(self.tempdir)
258 except:
259 pass
260 finally:
261 BaseTestCase.tearDown(self)
262
263 def check_status_and_reason(self, response, status, data=None):
264 body = response.read()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000265 self.assertTrue(response)
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000266 self.assertEqual(response.status, status)
267 self.assertIsNotNone(response.reason)
Georg Brandlb533e262008-05-25 18:19:30 +0000268 if data:
269 self.assertEqual(data, body)
Serhiy Storchakacb5bc402014-08-17 08:22:11 +0300270 return body
271
Ned Deily14183202015-01-05 01:02:30 -0800272 @support.requires_mac_ver(10, 5)
Serhiy Storchakacb5bc402014-08-17 08:22:11 +0300273 @unittest.skipUnless(support.TESTFN_UNDECODABLE,
274 'need support.TESTFN_UNDECODABLE')
275 def test_undecodable_filename(self):
Serhiy Storchakaa64ce5d2014-08-17 12:20:02 +0300276 enc = sys.getfilesystemencoding()
Serhiy Storchakacb5bc402014-08-17 08:22:11 +0300277 filename = os.fsdecode(support.TESTFN_UNDECODABLE) + '.txt'
278 with open(os.path.join(self.tempdir, filename), 'wb') as f:
279 f.write(support.TESTFN_UNDECODABLE)
280 response = self.request(self.tempdir_name + '/')
Serhiy Storchakad9e95282014-08-17 16:57:39 +0300281 if sys.platform == 'darwin':
282 # On Mac OS the HFS+ filesystem replaces bytes that aren't valid
283 # UTF-8 into a percent-encoded value.
284 for name in os.listdir(self.tempdir):
285 if name != 'test': # Ignore a filename created in setUp().
286 filename = name
287 break
Serhiy Storchakacb5bc402014-08-17 08:22:11 +0300288 body = self.check_status_and_reason(response, 200)
289 quotedname = urllib.parse.quote(filename, errors='surrogatepass')
290 self.assertIn(('href="%s"' % quotedname)
Serhiy Storchakaa64ce5d2014-08-17 12:20:02 +0300291 .encode(enc, 'surrogateescape'), body)
Serhiy Storchakacb5bc402014-08-17 08:22:11 +0300292 self.assertIn(('>%s<' % html.escape(filename))
Serhiy Storchakaa64ce5d2014-08-17 12:20:02 +0300293 .encode(enc, 'surrogateescape'), body)
Serhiy Storchakacb5bc402014-08-17 08:22:11 +0300294 response = self.request(self.tempdir_name + '/' + quotedname)
295 self.check_status_and_reason(response, 200,
296 data=support.TESTFN_UNDECODABLE)
Georg Brandlb533e262008-05-25 18:19:30 +0000297
298 def test_get(self):
299 #constructs the path relative to the root directory of the HTTPServer
300 response = self.request(self.tempdir_name + '/test')
301 self.check_status_and_reason(response, 200, data=self.data)
Senthil Kumaran72c238e2013-09-13 00:21:18 -0700302 # check for trailing "/" which should return 404. See Issue17324
303 response = self.request(self.tempdir_name + '/test/')
304 self.check_status_and_reason(response, 404)
Georg Brandlb533e262008-05-25 18:19:30 +0000305 response = self.request(self.tempdir_name + '/')
306 self.check_status_and_reason(response, 200)
307 response = self.request(self.tempdir_name)
308 self.check_status_and_reason(response, 301)
Benjamin Peterson94cb7a22014-12-26 10:53:43 -0600309 response = self.request(self.tempdir_name + '/?hi=2')
310 self.check_status_and_reason(response, 200)
311 response = self.request(self.tempdir_name + '?hi=1')
312 self.check_status_and_reason(response, 301)
313 self.assertEqual(response.getheader("Location"),
314 self.tempdir_name + "/?hi=1")
Georg Brandlb533e262008-05-25 18:19:30 +0000315 response = self.request('/ThisDoesNotExist')
316 self.check_status_and_reason(response, 404)
317 response = self.request('/' + 'ThisDoesNotExist' + '/')
318 self.check_status_and_reason(response, 404)
Brett Cannon105df5d2010-10-29 23:43:42 +0000319 with open(os.path.join(self.tempdir_name, 'index.html'), 'w') as f:
320 response = self.request('/' + self.tempdir_name + '/')
321 self.check_status_and_reason(response, 200)
Charles-François Natalif7ed9fc2011-11-02 19:35:14 +0100322 # chmod() doesn't work as expected on Windows, and filesystem
323 # permissions are ignored by root on Unix.
324 if os.name == 'posix' and os.geteuid() != 0:
Brett Cannon105df5d2010-10-29 23:43:42 +0000325 os.chmod(self.tempdir, 0)
326 response = self.request(self.tempdir_name + '/')
327 self.check_status_and_reason(response, 404)
328 os.chmod(self.tempdir, 0o755)
Georg Brandlb533e262008-05-25 18:19:30 +0000329
330 def test_head(self):
331 response = self.request(
332 self.tempdir_name + '/test', method='HEAD')
333 self.check_status_and_reason(response, 200)
334 self.assertEqual(response.getheader('content-length'),
335 str(len(self.data)))
336 self.assertEqual(response.getheader('content-type'),
337 'application/octet-stream')
338
339 def test_invalid_requests(self):
340 response = self.request('/', method='FOO')
341 self.check_status_and_reason(response, 501)
342 # requests must be case sensitive,so this should fail too
Terry Jan Reedydd09efd2014-10-18 17:10:09 -0400343 response = self.request('/', method='custom')
Georg Brandlb533e262008-05-25 18:19:30 +0000344 self.check_status_and_reason(response, 501)
345 response = self.request('/', method='GETs')
346 self.check_status_and_reason(response, 501)
347
348
349cgi_file1 = """\
350#!%s
351
352print("Content-type: text/html")
353print()
354print("Hello World")
355"""
356
357cgi_file2 = """\
358#!%s
359import cgi
360
361print("Content-type: text/html")
362print()
363
364form = cgi.FieldStorage()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000365print("%%s, %%s, %%s" %% (form.getfirst("spam"), form.getfirst("eggs"),
366 form.getfirst("bacon")))
Georg Brandlb533e262008-05-25 18:19:30 +0000367"""
368
Charles-François Natalif7ed9fc2011-11-02 19:35:14 +0100369
370@unittest.skipIf(hasattr(os, 'geteuid') and os.geteuid() == 0,
371 "This test can't be run reliably as root (issue #13308).")
Georg Brandlb533e262008-05-25 18:19:30 +0000372class CGIHTTPServerTestCase(BaseTestCase):
373 class request_handler(NoLogRequestHandler, CGIHTTPRequestHandler):
374 pass
375
Antoine Pitroue768c392012-08-05 14:52:45 +0200376 linesep = os.linesep.encode('ascii')
377
Georg Brandlb533e262008-05-25 18:19:30 +0000378 def setUp(self):
379 BaseTestCase.setUp(self)
Victor Stinner0b0ca0c2010-10-17 19:46:36 +0000380 self.cwd = os.getcwd()
Georg Brandlb533e262008-05-25 18:19:30 +0000381 self.parent_dir = tempfile.mkdtemp()
382 self.cgi_dir = os.path.join(self.parent_dir, 'cgi-bin')
Ned Deily915a30f2014-07-12 22:06:26 -0700383 self.cgi_child_dir = os.path.join(self.cgi_dir, 'child-dir')
Georg Brandlb533e262008-05-25 18:19:30 +0000384 os.mkdir(self.cgi_dir)
Ned Deily915a30f2014-07-12 22:06:26 -0700385 os.mkdir(self.cgi_child_dir)
Benjamin Peterson35aca892013-10-30 12:48:59 -0400386 self.nocgi_path = None
Victor Stinner0b0ca0c2010-10-17 19:46:36 +0000387 self.file1_path = None
388 self.file2_path = None
Ned Deily915a30f2014-07-12 22:06:26 -0700389 self.file3_path = None
Georg Brandlb533e262008-05-25 18:19:30 +0000390
Florent Xiclunafd1b0932010-03-28 00:25:02 +0000391 # The shebang line should be pure ASCII: use symlink if possible.
392 # See issue #7668.
Brian Curtin3b4499c2010-12-28 14:31:47 +0000393 if support.can_symlink():
Florent Xiclunafd1b0932010-03-28 00:25:02 +0000394 self.pythonexe = os.path.join(self.parent_dir, 'python')
395 os.symlink(sys.executable, self.pythonexe)
396 else:
397 self.pythonexe = sys.executable
398
Victor Stinner3218c312010-10-17 20:13:36 +0000399 try:
400 # The python executable path is written as the first line of the
401 # CGI Python script. The encoding cookie cannot be used, and so the
402 # path should be encodable to the default script encoding (utf-8)
403 self.pythonexe.encode('utf-8')
404 except UnicodeEncodeError:
405 self.tearDown()
Serhiy Storchaka0b4591e2013-02-04 15:45:00 +0200406 self.skipTest("Python executable path is not encodable to utf-8")
Victor Stinner3218c312010-10-17 20:13:36 +0000407
Benjamin Peterson04e9de42013-10-30 12:43:09 -0400408 self.nocgi_path = os.path.join(self.parent_dir, 'nocgi.py')
409 with open(self.nocgi_path, 'w') as fp:
410 fp.write(cgi_file1 % self.pythonexe)
411 os.chmod(self.nocgi_path, 0o777)
412
Georg Brandlb533e262008-05-25 18:19:30 +0000413 self.file1_path = os.path.join(self.cgi_dir, 'file1.py')
Victor Stinner6fb45752010-10-17 20:17:41 +0000414 with open(self.file1_path, 'w', encoding='utf-8') as file1:
Florent Xiclunafd1b0932010-03-28 00:25:02 +0000415 file1.write(cgi_file1 % self.pythonexe)
Georg Brandlb533e262008-05-25 18:19:30 +0000416 os.chmod(self.file1_path, 0o777)
417
418 self.file2_path = os.path.join(self.cgi_dir, 'file2.py')
Victor Stinner6fb45752010-10-17 20:17:41 +0000419 with open(self.file2_path, 'w', encoding='utf-8') as file2:
Florent Xiclunafd1b0932010-03-28 00:25:02 +0000420 file2.write(cgi_file2 % self.pythonexe)
Georg Brandlb533e262008-05-25 18:19:30 +0000421 os.chmod(self.file2_path, 0o777)
422
Ned Deily915a30f2014-07-12 22:06:26 -0700423 self.file3_path = os.path.join(self.cgi_child_dir, 'file3.py')
424 with open(self.file3_path, 'w', encoding='utf-8') as file3:
425 file3.write(cgi_file1 % self.pythonexe)
426 os.chmod(self.file3_path, 0o777)
427
Georg Brandlb533e262008-05-25 18:19:30 +0000428 os.chdir(self.parent_dir)
429
430 def tearDown(self):
431 try:
432 os.chdir(self.cwd)
Florent Xiclunafd1b0932010-03-28 00:25:02 +0000433 if self.pythonexe != sys.executable:
434 os.remove(self.pythonexe)
Benjamin Peterson35aca892013-10-30 12:48:59 -0400435 if self.nocgi_path:
436 os.remove(self.nocgi_path)
Victor Stinner0b0ca0c2010-10-17 19:46:36 +0000437 if self.file1_path:
438 os.remove(self.file1_path)
439 if self.file2_path:
440 os.remove(self.file2_path)
Ned Deily915a30f2014-07-12 22:06:26 -0700441 if self.file3_path:
442 os.remove(self.file3_path)
443 os.rmdir(self.cgi_child_dir)
Georg Brandlb533e262008-05-25 18:19:30 +0000444 os.rmdir(self.cgi_dir)
445 os.rmdir(self.parent_dir)
446 finally:
447 BaseTestCase.tearDown(self)
448
Senthil Kumarand70846b2012-04-12 02:34:32 +0800449 def test_url_collapse_path(self):
450 # verify tail is the last portion and head is the rest on proper urls
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000451 test_vectors = {
Senthil Kumarand70846b2012-04-12 02:34:32 +0800452 '': '//',
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000453 '..': IndexError,
454 '/.//..': IndexError,
Senthil Kumarand70846b2012-04-12 02:34:32 +0800455 '/': '//',
456 '//': '//',
457 '/\\': '//\\',
458 '/.//': '//',
459 'cgi-bin/file1.py': '/cgi-bin/file1.py',
460 '/cgi-bin/file1.py': '/cgi-bin/file1.py',
461 'a': '//a',
462 '/a': '//a',
463 '//a': '//a',
464 './a': '//a',
465 './C:/': '/C:/',
466 '/a/b': '/a/b',
467 '/a/b/': '/a/b/',
468 '/a/b/.': '/a/b/',
469 '/a/b/c/..': '/a/b/',
470 '/a/b/c/../d': '/a/b/d',
471 '/a/b/c/../d/e/../f': '/a/b/d/f',
472 '/a/b/c/../d/e/../../f': '/a/b/f',
473 '/a/b/c/../d/e/.././././..//f': '/a/b/f',
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000474 '../a/b/c/../d/e/.././././..//f': IndexError,
Senthil Kumarand70846b2012-04-12 02:34:32 +0800475 '/a/b/c/../d/e/../../../f': '/a/f',
476 '/a/b/c/../d/e/../../../../f': '//f',
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000477 '/a/b/c/../d/e/../../../../../f': IndexError,
Senthil Kumarand70846b2012-04-12 02:34:32 +0800478 '/a/b/c/../d/e/../../../../f/..': '//',
479 '/a/b/c/../d/e/../../../../f/../.': '//',
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000480 }
481 for path, expected in test_vectors.items():
482 if isinstance(expected, type) and issubclass(expected, Exception):
483 self.assertRaises(expected,
Senthil Kumarand70846b2012-04-12 02:34:32 +0800484 server._url_collapse_path, path)
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000485 else:
Senthil Kumarand70846b2012-04-12 02:34:32 +0800486 actual = server._url_collapse_path(path)
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000487 self.assertEqual(expected, actual,
488 msg='path = %r\nGot: %r\nWanted: %r' %
489 (path, actual, expected))
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000490
Georg Brandlb533e262008-05-25 18:19:30 +0000491 def test_headers_and_content(self):
492 res = self.request('/cgi-bin/file1.py')
Antoine Pitroue768c392012-08-05 14:52:45 +0200493 self.assertEqual((b'Hello World' + self.linesep, 'text/html', 200),
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000494 (res.read(), res.getheader('Content-type'), res.status))
Georg Brandlb533e262008-05-25 18:19:30 +0000495
Benjamin Peterson04e9de42013-10-30 12:43:09 -0400496 def test_issue19435(self):
497 res = self.request('///////////nocgi.py/../cgi-bin/nothere.sh')
498 self.assertEqual(res.status, 404)
499
Georg Brandlb533e262008-05-25 18:19:30 +0000500 def test_post(self):
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000501 params = urllib.parse.urlencode(
502 {'spam' : 1, 'eggs' : 'python', 'bacon' : 123456})
Georg Brandlb533e262008-05-25 18:19:30 +0000503 headers = {'Content-type' : 'application/x-www-form-urlencoded'}
504 res = self.request('/cgi-bin/file2.py', 'POST', params, headers)
505
Antoine Pitroue768c392012-08-05 14:52:45 +0200506 self.assertEqual(res.read(), b'1, python, 123456' + self.linesep)
Georg Brandlb533e262008-05-25 18:19:30 +0000507
508 def test_invaliduri(self):
509 res = self.request('/cgi-bin/invalid')
510 res.read()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000511 self.assertEqual(res.status, 404)
Georg Brandlb533e262008-05-25 18:19:30 +0000512
513 def test_authorization(self):
514 headers = {b'Authorization' : b'Basic ' +
515 base64.b64encode(b'username:pass')}
516 res = self.request('/cgi-bin/file1.py', 'GET', headers=headers)
Antoine Pitroue768c392012-08-05 14:52:45 +0200517 self.assertEqual((b'Hello World' + self.linesep, 'text/html', 200),
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000518 (res.read(), res.getheader('Content-type'), res.status))
Georg Brandlb533e262008-05-25 18:19:30 +0000519
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000520 def test_no_leading_slash(self):
521 # http://bugs.python.org/issue2254
522 res = self.request('cgi-bin/file1.py')
Antoine Pitroue768c392012-08-05 14:52:45 +0200523 self.assertEqual((b'Hello World' + self.linesep, 'text/html', 200),
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000524 (res.read(), res.getheader('Content-type'), res.status))
525
Senthil Kumaran42713722010-10-03 17:55:45 +0000526 def test_os_environ_is_not_altered(self):
527 signature = "Test CGI Server"
528 os.environ['SERVER_SOFTWARE'] = signature
529 res = self.request('/cgi-bin/file1.py')
Antoine Pitroue768c392012-08-05 14:52:45 +0200530 self.assertEqual((b'Hello World' + self.linesep, 'text/html', 200),
Senthil Kumaran42713722010-10-03 17:55:45 +0000531 (res.read(), res.getheader('Content-type'), res.status))
532 self.assertEqual(os.environ['SERVER_SOFTWARE'], signature)
533
Benjamin Peterson73b8b1c2014-06-14 18:36:29 -0700534 def test_urlquote_decoding_in_cgi_check(self):
535 res = self.request('/cgi-bin%2ffile1.py')
Benjamin Peterson314dc122014-06-16 23:15:50 -0700536 self.assertEqual((b'Hello World' + self.linesep, 'text/html', 200),
Benjamin Peterson73b8b1c2014-06-14 18:36:29 -0700537 (res.read(), res.getheader('Content-type'), res.status))
538
Ned Deily915a30f2014-07-12 22:06:26 -0700539 def test_nested_cgi_path_issue21323(self):
540 res = self.request('/cgi-bin/child-dir/file3.py')
541 self.assertEqual((b'Hello World' + self.linesep, 'text/html', 200),
542 (res.read(), res.getheader('Content-type'), res.status))
543
Georg Brandlb533e262008-05-25 18:19:30 +0000544
Georg Brandl6fcac0d2010-08-02 18:56:54 +0000545class SocketlessRequestHandler(SimpleHTTPRequestHandler):
546 def __init__(self):
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000547 self.get_called = False
548 self.protocol_version = "HTTP/1.1"
549
550 def do_GET(self):
551 self.get_called = True
552 self.send_response(200)
553 self.send_header('Content-Type', 'text/html')
554 self.end_headers()
555 self.wfile.write(b'<html><body>Data</body></html>\r\n')
556
557 def log_message(self, format, *args):
Georg Brandl6fcac0d2010-08-02 18:56:54 +0000558 pass
559
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000560class RejectingSocketlessRequestHandler(SocketlessRequestHandler):
561 def handle_expect_100(self):
562 self.send_error(417)
563 return False
564
Senthil Kumaranc7ae19b2011-05-09 23:25:02 +0800565
566class AuditableBytesIO:
567
568 def __init__(self):
569 self.datas = []
570
571 def write(self, data):
572 self.datas.append(data)
573
574 def getData(self):
575 return b''.join(self.datas)
576
577 @property
578 def numWrites(self):
579 return len(self.datas)
580
581
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000582class BaseHTTPRequestHandlerTestCase(unittest.TestCase):
Ezio Melotti3b3499b2011-03-16 11:35:38 +0200583 """Test the functionality of the BaseHTTPServer.
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000584
585 Test the support for the Expect 100-continue header.
586 """
587
588 HTTPResponseMatch = re.compile(b'HTTP/1.[0-9]+ 200 OK')
589
590 def setUp (self):
591 self.handler = SocketlessRequestHandler()
592
593 def send_typical_request(self, message):
594 input = BytesIO(message)
595 output = BytesIO()
596 self.handler.rfile = input
597 self.handler.wfile = output
598 self.handler.handle_one_request()
599 output.seek(0)
600 return output.readlines()
601
602 def verify_get_called(self):
603 self.assertTrue(self.handler.get_called)
604
605 def verify_expected_headers(self, headers):
606 for fieldName in b'Server: ', b'Date: ', b'Content-Type: ':
607 self.assertEqual(sum(h.startswith(fieldName) for h in headers), 1)
608
609 def verify_http_server_response(self, response):
610 match = self.HTTPResponseMatch.search(response)
Serhiy Storchaka25d8aea2014-02-08 14:50:08 +0200611 self.assertIsNotNone(match)
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000612
613 def test_http_1_1(self):
614 result = self.send_typical_request(b'GET / HTTP/1.1\r\n\r\n')
615 self.verify_http_server_response(result[0])
616 self.verify_expected_headers(result[1:-1])
617 self.verify_get_called()
618 self.assertEqual(result[-1], b'<html><body>Data</body></html>\r\n')
619
620 def test_http_1_0(self):
621 result = self.send_typical_request(b'GET / HTTP/1.0\r\n\r\n')
622 self.verify_http_server_response(result[0])
623 self.verify_expected_headers(result[1:-1])
624 self.verify_get_called()
625 self.assertEqual(result[-1], b'<html><body>Data</body></html>\r\n')
626
627 def test_http_0_9(self):
628 result = self.send_typical_request(b'GET / HTTP/0.9\r\n\r\n')
629 self.assertEqual(len(result), 1)
630 self.assertEqual(result[0], b'<html><body>Data</body></html>\r\n')
631 self.verify_get_called()
632
633 def test_with_continue_1_0(self):
634 result = self.send_typical_request(b'GET / HTTP/1.0\r\nExpect: 100-continue\r\n\r\n')
635 self.verify_http_server_response(result[0])
636 self.verify_expected_headers(result[1:-1])
637 self.verify_get_called()
638 self.assertEqual(result[-1], b'<html><body>Data</body></html>\r\n')
639
640 def test_with_continue_1_1(self):
641 result = self.send_typical_request(b'GET / HTTP/1.1\r\nExpect: 100-continue\r\n\r\n')
642 self.assertEqual(result[0], b'HTTP/1.1 100 Continue\r\n')
Benjamin Peterson04424232014-01-18 21:50:18 -0500643 self.assertEqual(result[1], b'\r\n')
644 self.assertEqual(result[2], b'HTTP/1.1 200 OK\r\n')
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000645 self.verify_expected_headers(result[2:-1])
646 self.verify_get_called()
647 self.assertEqual(result[-1], b'<html><body>Data</body></html>\r\n')
648
Senthil Kumaranc7ae19b2011-05-09 23:25:02 +0800649 def test_header_buffering_of_send_error(self):
Senthil Kumarane4dad4f2010-11-21 14:36:14 +0000650
651 input = BytesIO(b'GET / HTTP/1.1\r\n\r\n')
Senthil Kumaranc7ae19b2011-05-09 23:25:02 +0800652 output = AuditableBytesIO()
653 handler = SocketlessRequestHandler()
654 handler.rfile = input
655 handler.wfile = output
656 handler.request_version = 'HTTP/1.1'
657 handler.requestline = ''
658 handler.command = None
Senthil Kumarane4dad4f2010-11-21 14:36:14 +0000659
Senthil Kumaranc7ae19b2011-05-09 23:25:02 +0800660 handler.send_error(418)
661 self.assertEqual(output.numWrites, 2)
662
663 def test_header_buffering_of_send_response_only(self):
664
665 input = BytesIO(b'GET / HTTP/1.1\r\n\r\n')
666 output = AuditableBytesIO()
667 handler = SocketlessRequestHandler()
668 handler.rfile = input
669 handler.wfile = output
670 handler.request_version = 'HTTP/1.1'
671
672 handler.send_response_only(418)
673 self.assertEqual(output.numWrites, 0)
674 handler.end_headers()
675 self.assertEqual(output.numWrites, 1)
676
677 def test_header_buffering_of_send_header(self):
678
679 input = BytesIO(b'GET / HTTP/1.1\r\n\r\n')
680 output = AuditableBytesIO()
681 handler = SocketlessRequestHandler()
682 handler.rfile = input
683 handler.wfile = output
684 handler.request_version = 'HTTP/1.1'
685
686 handler.send_header('Foo', 'foo')
687 handler.send_header('bar', 'bar')
688 self.assertEqual(output.numWrites, 0)
689 handler.end_headers()
690 self.assertEqual(output.getData(), b'Foo: foo\r\nbar: bar\r\n\r\n')
691 self.assertEqual(output.numWrites, 1)
Senthil Kumarane4dad4f2010-11-21 14:36:14 +0000692
693 def test_header_unbuffered_when_continue(self):
694
695 def _readAndReseek(f):
696 pos = f.tell()
697 f.seek(0)
698 data = f.read()
699 f.seek(pos)
700 return data
701
702 input = BytesIO(b'GET / HTTP/1.1\r\nExpect: 100-continue\r\n\r\n')
703 output = BytesIO()
704 self.handler.rfile = input
705 self.handler.wfile = output
706 self.handler.request_version = 'HTTP/1.1'
707
708 self.handler.handle_one_request()
709 self.assertNotEqual(_readAndReseek(output), b'')
710 result = _readAndReseek(output).split(b'\r\n')
711 self.assertEqual(result[0], b'HTTP/1.1 100 Continue')
Benjamin Peterson04424232014-01-18 21:50:18 -0500712 self.assertEqual(result[1], b'')
713 self.assertEqual(result[2], b'HTTP/1.1 200 OK')
Senthil Kumarane4dad4f2010-11-21 14:36:14 +0000714
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000715 def test_with_continue_rejected(self):
716 usual_handler = self.handler # Save to avoid breaking any subsequent tests.
717 self.handler = RejectingSocketlessRequestHandler()
718 result = self.send_typical_request(b'GET / HTTP/1.1\r\nExpect: 100-continue\r\n\r\n')
719 self.assertEqual(result[0], b'HTTP/1.1 417 Expectation Failed\r\n')
720 self.verify_expected_headers(result[1:-1])
721 # The expect handler should short circuit the usual get method by
722 # returning false here, so get_called should be false
723 self.assertFalse(self.handler.get_called)
724 self.assertEqual(sum(r == b'Connection: close\r\n' for r in result[1:-1]), 1)
725 self.handler = usual_handler # Restore to avoid breaking any subsequent tests.
726
Antoine Pitrouc4924372010-12-16 16:48:36 +0000727 def test_request_length(self):
728 # Issue #10714: huge request lines are discarded, to avoid Denial
729 # of Service attacks.
730 result = self.send_typical_request(b'GET ' + b'x' * 65537)
731 self.assertEqual(result[0], b'HTTP/1.1 414 Request-URI Too Long\r\n')
732 self.assertFalse(self.handler.get_called)
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000733
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000734 def test_header_length(self):
735 # Issue #6791: same for headers
736 result = self.send_typical_request(
737 b'GET / HTTP/1.1\r\nX-Foo: bar' + b'r' * 65537 + b'\r\n\r\n')
738 self.assertEqual(result[0], b'HTTP/1.1 400 Line too long\r\n')
739 self.assertFalse(self.handler.get_called)
740
Georg Brandl6fcac0d2010-08-02 18:56:54 +0000741class SimpleHTTPRequestHandlerTestCase(unittest.TestCase):
742 """ Test url parsing """
743 def setUp(self):
744 self.translated = os.getcwd()
745 self.translated = os.path.join(self.translated, 'filename')
746 self.handler = SocketlessRequestHandler()
747
748 def test_query_arguments(self):
749 path = self.handler.translate_path('/filename')
750 self.assertEqual(path, self.translated)
751 path = self.handler.translate_path('/filename?foo=bar')
752 self.assertEqual(path, self.translated)
753 path = self.handler.translate_path('/filename?a=b&spam=eggs#zot')
754 self.assertEqual(path, self.translated)
755
756 def test_start_with_double_slash(self):
757 path = self.handler.translate_path('//filename')
758 self.assertEqual(path, self.translated)
759 path = self.handler.translate_path('//filename?foo=bar')
760 self.assertEqual(path, self.translated)
761
762
Georg Brandlb533e262008-05-25 18:19:30 +0000763def test_main(verbose=None):
Georg Brandl6fcac0d2010-08-02 18:56:54 +0000764 cwd = os.getcwd()
Georg Brandlb533e262008-05-25 18:19:30 +0000765 try:
Georg Brandl6fcac0d2010-08-02 18:56:54 +0000766 support.run_unittest(
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000767 BaseHTTPRequestHandlerTestCase,
Georg Brandl6fcac0d2010-08-02 18:56:54 +0000768 BaseHTTPServerTestCase,
769 SimpleHTTPServerTestCase,
770 CGIHTTPServerTestCase,
771 SimpleHTTPRequestHandlerTestCase,
772 )
Georg Brandlb533e262008-05-25 18:19:30 +0000773 finally:
774 os.chdir(cwd)
775
776if __name__ == '__main__':
777 test_main()