blob: 15694afd1d571b87465c4c0e4ae9a2a349e74a90 [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
Georg Brandl24420152008-05-26 16:32:26 +000017import http.client
Georg Brandlb533e262008-05-25 18:19:30 +000018import tempfile
Senthil Kumaran0f476d42010-09-30 06:09:18 +000019from io import BytesIO
Georg Brandlb533e262008-05-25 18:19:30 +000020
21import unittest
22from test import support
Victor Stinner45df8202010-04-28 22:31:17 +000023threading = support.import_module('threading')
Georg Brandlb533e262008-05-25 18:19:30 +000024
Georg Brandlb533e262008-05-25 18:19:30 +000025class NoLogRequestHandler:
26 def log_message(self, *args):
27 # don't write log messages to stderr
28 pass
29
Barry Warsaw820c1202008-06-12 04:06:45 +000030 def read(self, n=None):
31 return ''
32
Georg Brandlb533e262008-05-25 18:19:30 +000033
34class TestServerThread(threading.Thread):
35 def __init__(self, test_object, request_handler):
36 threading.Thread.__init__(self)
37 self.request_handler = request_handler
38 self.test_object = test_object
Georg Brandlb533e262008-05-25 18:19:30 +000039
40 def run(self):
Antoine Pitroucb342182011-03-21 00:26:51 +010041 self.server = HTTPServer(('localhost', 0), self.request_handler)
42 self.test_object.HOST, self.test_object.PORT = self.server.socket.getsockname()
Antoine Pitrou08911bd2010-04-25 22:19:43 +000043 self.test_object.server_started.set()
44 self.test_object = None
Georg Brandlb533e262008-05-25 18:19:30 +000045 try:
Antoine Pitrou08911bd2010-04-25 22:19:43 +000046 self.server.serve_forever(0.05)
Georg Brandlb533e262008-05-25 18:19:30 +000047 finally:
48 self.server.server_close()
49
50 def stop(self):
51 self.server.shutdown()
52
53
54class BaseTestCase(unittest.TestCase):
55 def setUp(self):
Antoine Pitrou45ebeb82009-10-27 18:52:30 +000056 self._threads = support.threading_setup()
Nick Coghlan6ead5522009-10-18 13:19:33 +000057 os.environ = support.EnvironmentVarGuard()
Antoine Pitrou08911bd2010-04-25 22:19:43 +000058 self.server_started = threading.Event()
Georg Brandlb533e262008-05-25 18:19:30 +000059 self.thread = TestServerThread(self, self.request_handler)
60 self.thread.start()
Antoine Pitrou08911bd2010-04-25 22:19:43 +000061 self.server_started.wait()
Georg Brandlb533e262008-05-25 18:19:30 +000062
63 def tearDown(self):
Georg Brandlb533e262008-05-25 18:19:30 +000064 self.thread.stop()
Antoine Pitrouf7270822012-09-30 01:05:30 +020065 self.thread = None
Nick Coghlan6ead5522009-10-18 13:19:33 +000066 os.environ.__exit__()
Antoine Pitrou45ebeb82009-10-27 18:52:30 +000067 support.threading_cleanup(*self._threads)
Georg Brandlb533e262008-05-25 18:19:30 +000068
69 def request(self, uri, method='GET', body=None, headers={}):
Antoine Pitroucb342182011-03-21 00:26:51 +010070 self.connection = http.client.HTTPConnection(self.HOST, self.PORT)
Georg Brandlb533e262008-05-25 18:19:30 +000071 self.connection.request(method, uri, body, headers)
72 return self.connection.getresponse()
73
74
75class BaseHTTPServerTestCase(BaseTestCase):
76 class request_handler(NoLogRequestHandler, BaseHTTPRequestHandler):
77 protocol_version = 'HTTP/1.1'
78 default_request_version = 'HTTP/1.1'
79
80 def do_TEST(self):
81 self.send_response(204)
82 self.send_header('Content-Type', 'text/html')
83 self.send_header('Connection', 'close')
84 self.end_headers()
85
86 def do_KEEP(self):
87 self.send_response(204)
88 self.send_header('Content-Type', 'text/html')
89 self.send_header('Connection', 'keep-alive')
90 self.end_headers()
91
92 def do_KEYERROR(self):
93 self.send_error(999)
94
Senthil Kumaran52d27202012-10-10 23:16:21 -070095 def do_NOTFOUND(self):
96 self.send_error(404)
97
Senthil Kumaran26886442013-03-15 07:53:21 -070098 def do_EXPLAINERROR(self):
99 self.send_error(999, "Short Message",
100 "This is a long \n explaination")
101
Georg Brandlb533e262008-05-25 18:19:30 +0000102 def do_CUSTOM(self):
103 self.send_response(999)
104 self.send_header('Content-Type', 'text/html')
105 self.send_header('Connection', 'close')
106 self.end_headers()
107
Armin Ronacher8d96d772011-01-22 13:13:05 +0000108 def do_LATINONEHEADER(self):
109 self.send_response(999)
110 self.send_header('X-Special', 'Dängerous Mind')
Armin Ronacher59531282011-01-22 13:44:22 +0000111 self.send_header('Connection', 'close')
Armin Ronacher8d96d772011-01-22 13:13:05 +0000112 self.end_headers()
Armin Ronacher59531282011-01-22 13:44:22 +0000113 body = self.headers['x-special-incoming'].encode('utf-8')
114 self.wfile.write(body)
Armin Ronacher8d96d772011-01-22 13:13:05 +0000115
Georg Brandlb533e262008-05-25 18:19:30 +0000116 def setUp(self):
117 BaseTestCase.setUp(self)
Antoine Pitroucb342182011-03-21 00:26:51 +0100118 self.con = http.client.HTTPConnection(self.HOST, self.PORT)
Georg Brandlb533e262008-05-25 18:19:30 +0000119 self.con.connect()
120
121 def test_command(self):
122 self.con.request('GET', '/')
123 res = self.con.getresponse()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000124 self.assertEqual(res.status, 501)
Georg Brandlb533e262008-05-25 18:19:30 +0000125
126 def test_request_line_trimming(self):
127 self.con._http_vsn_str = 'HTTP/1.1\n'
128 self.con.putrequest('GET', '/')
129 self.con.endheaders()
130 res = self.con.getresponse()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000131 self.assertEqual(res.status, 501)
Georg Brandlb533e262008-05-25 18:19:30 +0000132
133 def test_version_bogus(self):
134 self.con._http_vsn_str = 'FUBAR'
135 self.con.putrequest('GET', '/')
136 self.con.endheaders()
137 res = self.con.getresponse()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000138 self.assertEqual(res.status, 400)
Georg Brandlb533e262008-05-25 18:19:30 +0000139
140 def test_version_digits(self):
141 self.con._http_vsn_str = 'HTTP/9.9.9'
142 self.con.putrequest('GET', '/')
143 self.con.endheaders()
144 res = self.con.getresponse()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000145 self.assertEqual(res.status, 400)
Georg Brandlb533e262008-05-25 18:19:30 +0000146
147 def test_version_none_get(self):
148 self.con._http_vsn_str = ''
149 self.con.putrequest('GET', '/')
150 self.con.endheaders()
151 res = self.con.getresponse()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000152 self.assertEqual(res.status, 501)
Georg Brandlb533e262008-05-25 18:19:30 +0000153
154 def test_version_none(self):
155 self.con._http_vsn_str = ''
156 self.con.putrequest('PUT', '/')
157 self.con.endheaders()
158 res = self.con.getresponse()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000159 self.assertEqual(res.status, 400)
Georg Brandlb533e262008-05-25 18:19:30 +0000160
161 def test_version_invalid(self):
162 self.con._http_vsn = 99
163 self.con._http_vsn_str = 'HTTP/9.9'
164 self.con.putrequest('GET', '/')
165 self.con.endheaders()
166 res = self.con.getresponse()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000167 self.assertEqual(res.status, 505)
Georg Brandlb533e262008-05-25 18:19:30 +0000168
169 def test_send_blank(self):
170 self.con._http_vsn_str = ''
171 self.con.putrequest('', '')
172 self.con.endheaders()
173 res = self.con.getresponse()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000174 self.assertEqual(res.status, 400)
Georg Brandlb533e262008-05-25 18:19:30 +0000175
176 def test_header_close(self):
177 self.con.putrequest('GET', '/')
178 self.con.putheader('Connection', 'close')
179 self.con.endheaders()
180 res = self.con.getresponse()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000181 self.assertEqual(res.status, 501)
Georg Brandlb533e262008-05-25 18:19:30 +0000182
183 def test_head_keep_alive(self):
184 self.con._http_vsn_str = 'HTTP/1.1'
185 self.con.putrequest('GET', '/')
186 self.con.putheader('Connection', 'keep-alive')
187 self.con.endheaders()
188 res = self.con.getresponse()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000189 self.assertEqual(res.status, 501)
Georg Brandlb533e262008-05-25 18:19:30 +0000190
191 def test_handler(self):
192 self.con.request('TEST', '/')
193 res = self.con.getresponse()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000194 self.assertEqual(res.status, 204)
Georg Brandlb533e262008-05-25 18:19:30 +0000195
196 def test_return_header_keep_alive(self):
197 self.con.request('KEEP', '/')
198 res = self.con.getresponse()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000199 self.assertEqual(res.getheader('Connection'), 'keep-alive')
Georg Brandlb533e262008-05-25 18:19:30 +0000200 self.con.request('TEST', '/')
Brian Curtin61d0d602010-10-31 00:34:23 +0000201 self.addCleanup(self.con.close)
Georg Brandlb533e262008-05-25 18:19:30 +0000202
203 def test_internal_key_error(self):
204 self.con.request('KEYERROR', '/')
205 res = self.con.getresponse()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000206 self.assertEqual(res.status, 999)
Georg Brandlb533e262008-05-25 18:19:30 +0000207
208 def test_return_custom_status(self):
209 self.con.request('CUSTOM', '/')
210 res = self.con.getresponse()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000211 self.assertEqual(res.status, 999)
Georg Brandlb533e262008-05-25 18:19:30 +0000212
Senthil Kumaran26886442013-03-15 07:53:21 -0700213 def test_return_explain_error(self):
214 self.con.request('EXPLAINERROR', '/')
215 res = self.con.getresponse()
216 self.assertEqual(res.status, 999)
217 self.assertTrue(int(res.getheader('Content-Length')))
218
Armin Ronacher8d96d772011-01-22 13:13:05 +0000219 def test_latin1_header(self):
Armin Ronacher59531282011-01-22 13:44:22 +0000220 self.con.request('LATINONEHEADER', '/', headers={
221 'X-Special-Incoming': 'Ärger mit Unicode'
222 })
Armin Ronacher8d96d772011-01-22 13:13:05 +0000223 res = self.con.getresponse()
224 self.assertEqual(res.getheader('X-Special'), 'Dängerous Mind')
Armin Ronacher59531282011-01-22 13:44:22 +0000225 self.assertEqual(res.read(), 'Ärger mit Unicode'.encode('utf-8'))
Armin Ronacher8d96d772011-01-22 13:13:05 +0000226
Senthil Kumaran52d27202012-10-10 23:16:21 -0700227 def test_error_content_length(self):
228 # Issue #16088: standard error responses should have a content-length
229 self.con.request('NOTFOUND', '/')
230 res = self.con.getresponse()
231 self.assertEqual(res.status, 404)
232 data = res.read()
Senthil Kumaran52d27202012-10-10 23:16:21 -0700233 self.assertEqual(int(res.getheader('Content-Length')), len(data))
234
Georg Brandlb533e262008-05-25 18:19:30 +0000235
236class SimpleHTTPServerTestCase(BaseTestCase):
237 class request_handler(NoLogRequestHandler, SimpleHTTPRequestHandler):
238 pass
239
240 def setUp(self):
241 BaseTestCase.setUp(self)
242 self.cwd = os.getcwd()
243 basetempdir = tempfile.gettempdir()
244 os.chdir(basetempdir)
245 self.data = b'We are the knights who say Ni!'
246 self.tempdir = tempfile.mkdtemp(dir=basetempdir)
247 self.tempdir_name = os.path.basename(self.tempdir)
Brett Cannon105df5d2010-10-29 23:43:42 +0000248 with open(os.path.join(self.tempdir, 'test'), 'wb') as temp:
249 temp.write(self.data)
Georg Brandlb533e262008-05-25 18:19:30 +0000250
251 def tearDown(self):
252 try:
253 os.chdir(self.cwd)
254 try:
255 shutil.rmtree(self.tempdir)
256 except:
257 pass
258 finally:
259 BaseTestCase.tearDown(self)
260
261 def check_status_and_reason(self, response, status, data=None):
262 body = response.read()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000263 self.assertTrue(response)
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000264 self.assertEqual(response.status, status)
265 self.assertIsNotNone(response.reason)
Georg Brandlb533e262008-05-25 18:19:30 +0000266 if data:
267 self.assertEqual(data, body)
268
269 def test_get(self):
270 #constructs the path relative to the root directory of the HTTPServer
271 response = self.request(self.tempdir_name + '/test')
272 self.check_status_and_reason(response, 200, data=self.data)
Senthil Kumaran72c238e2013-09-13 00:21:18 -0700273 # check for trailing "/" which should return 404. See Issue17324
274 response = self.request(self.tempdir_name + '/test/')
275 self.check_status_and_reason(response, 404)
Georg Brandlb533e262008-05-25 18:19:30 +0000276 response = self.request(self.tempdir_name + '/')
277 self.check_status_and_reason(response, 200)
278 response = self.request(self.tempdir_name)
279 self.check_status_and_reason(response, 301)
280 response = self.request('/ThisDoesNotExist')
281 self.check_status_and_reason(response, 404)
282 response = self.request('/' + 'ThisDoesNotExist' + '/')
283 self.check_status_and_reason(response, 404)
Brett Cannon105df5d2010-10-29 23:43:42 +0000284 with open(os.path.join(self.tempdir_name, 'index.html'), 'w') as f:
285 response = self.request('/' + self.tempdir_name + '/')
286 self.check_status_and_reason(response, 200)
Charles-François Natalif7ed9fc2011-11-02 19:35:14 +0100287 # chmod() doesn't work as expected on Windows, and filesystem
288 # permissions are ignored by root on Unix.
289 if os.name == 'posix' and os.geteuid() != 0:
Brett Cannon105df5d2010-10-29 23:43:42 +0000290 os.chmod(self.tempdir, 0)
291 response = self.request(self.tempdir_name + '/')
292 self.check_status_and_reason(response, 404)
293 os.chmod(self.tempdir, 0o755)
Georg Brandlb533e262008-05-25 18:19:30 +0000294
295 def test_head(self):
296 response = self.request(
297 self.tempdir_name + '/test', method='HEAD')
298 self.check_status_and_reason(response, 200)
299 self.assertEqual(response.getheader('content-length'),
300 str(len(self.data)))
301 self.assertEqual(response.getheader('content-type'),
302 'application/octet-stream')
303
304 def test_invalid_requests(self):
305 response = self.request('/', method='FOO')
306 self.check_status_and_reason(response, 501)
307 # requests must be case sensitive,so this should fail too
308 response = self.request('/', method='get')
309 self.check_status_and_reason(response, 501)
310 response = self.request('/', method='GETs')
311 self.check_status_and_reason(response, 501)
312
313
314cgi_file1 = """\
315#!%s
316
317print("Content-type: text/html")
318print()
319print("Hello World")
320"""
321
322cgi_file2 = """\
323#!%s
324import cgi
325
326print("Content-type: text/html")
327print()
328
329form = cgi.FieldStorage()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000330print("%%s, %%s, %%s" %% (form.getfirst("spam"), form.getfirst("eggs"),
331 form.getfirst("bacon")))
Georg Brandlb533e262008-05-25 18:19:30 +0000332"""
333
Charles-François Natalif7ed9fc2011-11-02 19:35:14 +0100334
335@unittest.skipIf(hasattr(os, 'geteuid') and os.geteuid() == 0,
336 "This test can't be run reliably as root (issue #13308).")
Georg Brandlb533e262008-05-25 18:19:30 +0000337class CGIHTTPServerTestCase(BaseTestCase):
338 class request_handler(NoLogRequestHandler, CGIHTTPRequestHandler):
339 pass
340
Antoine Pitroue768c392012-08-05 14:52:45 +0200341 linesep = os.linesep.encode('ascii')
342
Georg Brandlb533e262008-05-25 18:19:30 +0000343 def setUp(self):
344 BaseTestCase.setUp(self)
Victor Stinner0b0ca0c2010-10-17 19:46:36 +0000345 self.cwd = os.getcwd()
Georg Brandlb533e262008-05-25 18:19:30 +0000346 self.parent_dir = tempfile.mkdtemp()
347 self.cgi_dir = os.path.join(self.parent_dir, 'cgi-bin')
348 os.mkdir(self.cgi_dir)
Benjamin Peterson35aca892013-10-30 12:48:59 -0400349 self.nocgi_path = None
Victor Stinner0b0ca0c2010-10-17 19:46:36 +0000350 self.file1_path = None
351 self.file2_path = None
Georg Brandlb533e262008-05-25 18:19:30 +0000352
Florent Xiclunafd1b0932010-03-28 00:25:02 +0000353 # The shebang line should be pure ASCII: use symlink if possible.
354 # See issue #7668.
Brian Curtin3b4499c2010-12-28 14:31:47 +0000355 if support.can_symlink():
Florent Xiclunafd1b0932010-03-28 00:25:02 +0000356 self.pythonexe = os.path.join(self.parent_dir, 'python')
357 os.symlink(sys.executable, self.pythonexe)
358 else:
359 self.pythonexe = sys.executable
360
Victor Stinner3218c312010-10-17 20:13:36 +0000361 try:
362 # The python executable path is written as the first line of the
363 # CGI Python script. The encoding cookie cannot be used, and so the
364 # path should be encodable to the default script encoding (utf-8)
365 self.pythonexe.encode('utf-8')
366 except UnicodeEncodeError:
367 self.tearDown()
Serhiy Storchaka0b4591e2013-02-04 15:45:00 +0200368 self.skipTest("Python executable path is not encodable to utf-8")
Victor Stinner3218c312010-10-17 20:13:36 +0000369
Benjamin Peterson04e9de42013-10-30 12:43:09 -0400370 self.nocgi_path = os.path.join(self.parent_dir, 'nocgi.py')
371 with open(self.nocgi_path, 'w') as fp:
372 fp.write(cgi_file1 % self.pythonexe)
373 os.chmod(self.nocgi_path, 0o777)
374
Georg Brandlb533e262008-05-25 18:19:30 +0000375 self.file1_path = os.path.join(self.cgi_dir, 'file1.py')
Victor Stinner6fb45752010-10-17 20:17:41 +0000376 with open(self.file1_path, 'w', encoding='utf-8') as file1:
Florent Xiclunafd1b0932010-03-28 00:25:02 +0000377 file1.write(cgi_file1 % self.pythonexe)
Georg Brandlb533e262008-05-25 18:19:30 +0000378 os.chmod(self.file1_path, 0o777)
379
380 self.file2_path = os.path.join(self.cgi_dir, 'file2.py')
Victor Stinner6fb45752010-10-17 20:17:41 +0000381 with open(self.file2_path, 'w', encoding='utf-8') as file2:
Florent Xiclunafd1b0932010-03-28 00:25:02 +0000382 file2.write(cgi_file2 % self.pythonexe)
Georg Brandlb533e262008-05-25 18:19:30 +0000383 os.chmod(self.file2_path, 0o777)
384
Georg Brandlb533e262008-05-25 18:19:30 +0000385 os.chdir(self.parent_dir)
386
387 def tearDown(self):
388 try:
389 os.chdir(self.cwd)
Florent Xiclunafd1b0932010-03-28 00:25:02 +0000390 if self.pythonexe != sys.executable:
391 os.remove(self.pythonexe)
Benjamin Peterson35aca892013-10-30 12:48:59 -0400392 if self.nocgi_path:
393 os.remove(self.nocgi_path)
Victor Stinner0b0ca0c2010-10-17 19:46:36 +0000394 if self.file1_path:
395 os.remove(self.file1_path)
396 if self.file2_path:
397 os.remove(self.file2_path)
Georg Brandlb533e262008-05-25 18:19:30 +0000398 os.rmdir(self.cgi_dir)
399 os.rmdir(self.parent_dir)
400 finally:
401 BaseTestCase.tearDown(self)
402
Senthil Kumarand70846b2012-04-12 02:34:32 +0800403 def test_url_collapse_path(self):
404 # verify tail is the last portion and head is the rest on proper urls
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000405 test_vectors = {
Senthil Kumarand70846b2012-04-12 02:34:32 +0800406 '': '//',
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000407 '..': IndexError,
408 '/.//..': IndexError,
Senthil Kumarand70846b2012-04-12 02:34:32 +0800409 '/': '//',
410 '//': '//',
411 '/\\': '//\\',
412 '/.//': '//',
413 'cgi-bin/file1.py': '/cgi-bin/file1.py',
414 '/cgi-bin/file1.py': '/cgi-bin/file1.py',
415 'a': '//a',
416 '/a': '//a',
417 '//a': '//a',
418 './a': '//a',
419 './C:/': '/C:/',
420 '/a/b': '/a/b',
421 '/a/b/': '/a/b/',
422 '/a/b/.': '/a/b/',
423 '/a/b/c/..': '/a/b/',
424 '/a/b/c/../d': '/a/b/d',
425 '/a/b/c/../d/e/../f': '/a/b/d/f',
426 '/a/b/c/../d/e/../../f': '/a/b/f',
427 '/a/b/c/../d/e/.././././..//f': '/a/b/f',
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000428 '../a/b/c/../d/e/.././././..//f': IndexError,
Senthil Kumarand70846b2012-04-12 02:34:32 +0800429 '/a/b/c/../d/e/../../../f': '/a/f',
430 '/a/b/c/../d/e/../../../../f': '//f',
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000431 '/a/b/c/../d/e/../../../../../f': IndexError,
Senthil Kumarand70846b2012-04-12 02:34:32 +0800432 '/a/b/c/../d/e/../../../../f/..': '//',
433 '/a/b/c/../d/e/../../../../f/../.': '//',
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000434 }
435 for path, expected in test_vectors.items():
436 if isinstance(expected, type) and issubclass(expected, Exception):
437 self.assertRaises(expected,
Senthil Kumarand70846b2012-04-12 02:34:32 +0800438 server._url_collapse_path, path)
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000439 else:
Senthil Kumarand70846b2012-04-12 02:34:32 +0800440 actual = server._url_collapse_path(path)
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000441 self.assertEqual(expected, actual,
442 msg='path = %r\nGot: %r\nWanted: %r' %
443 (path, actual, expected))
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000444
Georg Brandlb533e262008-05-25 18:19:30 +0000445 def test_headers_and_content(self):
446 res = self.request('/cgi-bin/file1.py')
Antoine Pitroue768c392012-08-05 14:52:45 +0200447 self.assertEqual((b'Hello World' + self.linesep, 'text/html', 200),
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000448 (res.read(), res.getheader('Content-type'), res.status))
Georg Brandlb533e262008-05-25 18:19:30 +0000449
Benjamin Peterson04e9de42013-10-30 12:43:09 -0400450 def test_issue19435(self):
451 res = self.request('///////////nocgi.py/../cgi-bin/nothere.sh')
452 self.assertEqual(res.status, 404)
453
Georg Brandlb533e262008-05-25 18:19:30 +0000454 def test_post(self):
Jeremy Hylton1afc1692008-06-18 20:49:58 +0000455 params = urllib.parse.urlencode(
456 {'spam' : 1, 'eggs' : 'python', 'bacon' : 123456})
Georg Brandlb533e262008-05-25 18:19:30 +0000457 headers = {'Content-type' : 'application/x-www-form-urlencoded'}
458 res = self.request('/cgi-bin/file2.py', 'POST', params, headers)
459
Antoine Pitroue768c392012-08-05 14:52:45 +0200460 self.assertEqual(res.read(), b'1, python, 123456' + self.linesep)
Georg Brandlb533e262008-05-25 18:19:30 +0000461
462 def test_invaliduri(self):
463 res = self.request('/cgi-bin/invalid')
464 res.read()
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000465 self.assertEqual(res.status, 404)
Georg Brandlb533e262008-05-25 18:19:30 +0000466
467 def test_authorization(self):
468 headers = {b'Authorization' : b'Basic ' +
469 base64.b64encode(b'username:pass')}
470 res = self.request('/cgi-bin/file1.py', 'GET', headers=headers)
Antoine Pitroue768c392012-08-05 14:52:45 +0200471 self.assertEqual((b'Hello World' + self.linesep, 'text/html', 200),
Florent Xicluna9b86b9a2010-03-19 19:00:44 +0000472 (res.read(), res.getheader('Content-type'), res.status))
Georg Brandlb533e262008-05-25 18:19:30 +0000473
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000474 def test_no_leading_slash(self):
475 # http://bugs.python.org/issue2254
476 res = self.request('cgi-bin/file1.py')
Antoine Pitroue768c392012-08-05 14:52:45 +0200477 self.assertEqual((b'Hello World' + self.linesep, 'text/html', 200),
Benjamin Petersonad71f0f2009-04-11 20:12:10 +0000478 (res.read(), res.getheader('Content-type'), res.status))
479
Senthil Kumaran42713722010-10-03 17:55:45 +0000480 def test_os_environ_is_not_altered(self):
481 signature = "Test CGI Server"
482 os.environ['SERVER_SOFTWARE'] = signature
483 res = self.request('/cgi-bin/file1.py')
Antoine Pitroue768c392012-08-05 14:52:45 +0200484 self.assertEqual((b'Hello World' + self.linesep, 'text/html', 200),
Senthil Kumaran42713722010-10-03 17:55:45 +0000485 (res.read(), res.getheader('Content-type'), res.status))
486 self.assertEqual(os.environ['SERVER_SOFTWARE'], signature)
487
Georg Brandlb533e262008-05-25 18:19:30 +0000488
Georg Brandl6fcac0d2010-08-02 18:56:54 +0000489class SocketlessRequestHandler(SimpleHTTPRequestHandler):
490 def __init__(self):
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000491 self.get_called = False
492 self.protocol_version = "HTTP/1.1"
493
494 def do_GET(self):
495 self.get_called = True
496 self.send_response(200)
497 self.send_header('Content-Type', 'text/html')
498 self.end_headers()
499 self.wfile.write(b'<html><body>Data</body></html>\r\n')
500
501 def log_message(self, format, *args):
Georg Brandl6fcac0d2010-08-02 18:56:54 +0000502 pass
503
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000504class RejectingSocketlessRequestHandler(SocketlessRequestHandler):
505 def handle_expect_100(self):
506 self.send_error(417)
507 return False
508
Senthil Kumaranc7ae19b2011-05-09 23:25:02 +0800509
510class AuditableBytesIO:
511
512 def __init__(self):
513 self.datas = []
514
515 def write(self, data):
516 self.datas.append(data)
517
518 def getData(self):
519 return b''.join(self.datas)
520
521 @property
522 def numWrites(self):
523 return len(self.datas)
524
525
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000526class BaseHTTPRequestHandlerTestCase(unittest.TestCase):
Ezio Melotti3b3499b2011-03-16 11:35:38 +0200527 """Test the functionality of the BaseHTTPServer.
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000528
529 Test the support for the Expect 100-continue header.
530 """
531
532 HTTPResponseMatch = re.compile(b'HTTP/1.[0-9]+ 200 OK')
533
534 def setUp (self):
535 self.handler = SocketlessRequestHandler()
536
537 def send_typical_request(self, message):
538 input = BytesIO(message)
539 output = BytesIO()
540 self.handler.rfile = input
541 self.handler.wfile = output
542 self.handler.handle_one_request()
543 output.seek(0)
544 return output.readlines()
545
546 def verify_get_called(self):
547 self.assertTrue(self.handler.get_called)
548
549 def verify_expected_headers(self, headers):
550 for fieldName in b'Server: ', b'Date: ', b'Content-Type: ':
551 self.assertEqual(sum(h.startswith(fieldName) for h in headers), 1)
552
553 def verify_http_server_response(self, response):
554 match = self.HTTPResponseMatch.search(response)
Serhiy Storchaka25d8aea2014-02-08 14:50:08 +0200555 self.assertIsNotNone(match)
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000556
557 def test_http_1_1(self):
558 result = self.send_typical_request(b'GET / HTTP/1.1\r\n\r\n')
559 self.verify_http_server_response(result[0])
560 self.verify_expected_headers(result[1:-1])
561 self.verify_get_called()
562 self.assertEqual(result[-1], b'<html><body>Data</body></html>\r\n')
563
564 def test_http_1_0(self):
565 result = self.send_typical_request(b'GET / HTTP/1.0\r\n\r\n')
566 self.verify_http_server_response(result[0])
567 self.verify_expected_headers(result[1:-1])
568 self.verify_get_called()
569 self.assertEqual(result[-1], b'<html><body>Data</body></html>\r\n')
570
571 def test_http_0_9(self):
572 result = self.send_typical_request(b'GET / HTTP/0.9\r\n\r\n')
573 self.assertEqual(len(result), 1)
574 self.assertEqual(result[0], b'<html><body>Data</body></html>\r\n')
575 self.verify_get_called()
576
577 def test_with_continue_1_0(self):
578 result = self.send_typical_request(b'GET / HTTP/1.0\r\nExpect: 100-continue\r\n\r\n')
579 self.verify_http_server_response(result[0])
580 self.verify_expected_headers(result[1:-1])
581 self.verify_get_called()
582 self.assertEqual(result[-1], b'<html><body>Data</body></html>\r\n')
583
584 def test_with_continue_1_1(self):
585 result = self.send_typical_request(b'GET / HTTP/1.1\r\nExpect: 100-continue\r\n\r\n')
586 self.assertEqual(result[0], b'HTTP/1.1 100 Continue\r\n')
Benjamin Peterson04424232014-01-18 21:50:18 -0500587 self.assertEqual(result[1], b'\r\n')
588 self.assertEqual(result[2], b'HTTP/1.1 200 OK\r\n')
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000589 self.verify_expected_headers(result[2:-1])
590 self.verify_get_called()
591 self.assertEqual(result[-1], b'<html><body>Data</body></html>\r\n')
592
Senthil Kumaranc7ae19b2011-05-09 23:25:02 +0800593 def test_header_buffering_of_send_error(self):
Senthil Kumarane4dad4f2010-11-21 14:36:14 +0000594
595 input = BytesIO(b'GET / HTTP/1.1\r\n\r\n')
Senthil Kumaranc7ae19b2011-05-09 23:25:02 +0800596 output = AuditableBytesIO()
597 handler = SocketlessRequestHandler()
598 handler.rfile = input
599 handler.wfile = output
600 handler.request_version = 'HTTP/1.1'
601 handler.requestline = ''
602 handler.command = None
Senthil Kumarane4dad4f2010-11-21 14:36:14 +0000603
Senthil Kumaranc7ae19b2011-05-09 23:25:02 +0800604 handler.send_error(418)
605 self.assertEqual(output.numWrites, 2)
606
607 def test_header_buffering_of_send_response_only(self):
608
609 input = BytesIO(b'GET / HTTP/1.1\r\n\r\n')
610 output = AuditableBytesIO()
611 handler = SocketlessRequestHandler()
612 handler.rfile = input
613 handler.wfile = output
614 handler.request_version = 'HTTP/1.1'
615
616 handler.send_response_only(418)
617 self.assertEqual(output.numWrites, 0)
618 handler.end_headers()
619 self.assertEqual(output.numWrites, 1)
620
621 def test_header_buffering_of_send_header(self):
622
623 input = BytesIO(b'GET / HTTP/1.1\r\n\r\n')
624 output = AuditableBytesIO()
625 handler = SocketlessRequestHandler()
626 handler.rfile = input
627 handler.wfile = output
628 handler.request_version = 'HTTP/1.1'
629
630 handler.send_header('Foo', 'foo')
631 handler.send_header('bar', 'bar')
632 self.assertEqual(output.numWrites, 0)
633 handler.end_headers()
634 self.assertEqual(output.getData(), b'Foo: foo\r\nbar: bar\r\n\r\n')
635 self.assertEqual(output.numWrites, 1)
Senthil Kumarane4dad4f2010-11-21 14:36:14 +0000636
637 def test_header_unbuffered_when_continue(self):
638
639 def _readAndReseek(f):
640 pos = f.tell()
641 f.seek(0)
642 data = f.read()
643 f.seek(pos)
644 return data
645
646 input = BytesIO(b'GET / HTTP/1.1\r\nExpect: 100-continue\r\n\r\n')
647 output = BytesIO()
648 self.handler.rfile = input
649 self.handler.wfile = output
650 self.handler.request_version = 'HTTP/1.1'
651
652 self.handler.handle_one_request()
653 self.assertNotEqual(_readAndReseek(output), b'')
654 result = _readAndReseek(output).split(b'\r\n')
655 self.assertEqual(result[0], b'HTTP/1.1 100 Continue')
Benjamin Peterson04424232014-01-18 21:50:18 -0500656 self.assertEqual(result[1], b'')
657 self.assertEqual(result[2], b'HTTP/1.1 200 OK')
Senthil Kumarane4dad4f2010-11-21 14:36:14 +0000658
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000659 def test_with_continue_rejected(self):
660 usual_handler = self.handler # Save to avoid breaking any subsequent tests.
661 self.handler = RejectingSocketlessRequestHandler()
662 result = self.send_typical_request(b'GET / HTTP/1.1\r\nExpect: 100-continue\r\n\r\n')
663 self.assertEqual(result[0], b'HTTP/1.1 417 Expectation Failed\r\n')
664 self.verify_expected_headers(result[1:-1])
665 # The expect handler should short circuit the usual get method by
666 # returning false here, so get_called should be false
667 self.assertFalse(self.handler.get_called)
668 self.assertEqual(sum(r == b'Connection: close\r\n' for r in result[1:-1]), 1)
669 self.handler = usual_handler # Restore to avoid breaking any subsequent tests.
670
Antoine Pitrouc4924372010-12-16 16:48:36 +0000671 def test_request_length(self):
672 # Issue #10714: huge request lines are discarded, to avoid Denial
673 # of Service attacks.
674 result = self.send_typical_request(b'GET ' + b'x' * 65537)
675 self.assertEqual(result[0], b'HTTP/1.1 414 Request-URI Too Long\r\n')
676 self.assertFalse(self.handler.get_called)
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000677
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000678 def test_header_length(self):
679 # Issue #6791: same for headers
680 result = self.send_typical_request(
681 b'GET / HTTP/1.1\r\nX-Foo: bar' + b'r' * 65537 + b'\r\n\r\n')
682 self.assertEqual(result[0], b'HTTP/1.1 400 Line too long\r\n')
683 self.assertFalse(self.handler.get_called)
684
Georg Brandl6fcac0d2010-08-02 18:56:54 +0000685class SimpleHTTPRequestHandlerTestCase(unittest.TestCase):
686 """ Test url parsing """
687 def setUp(self):
688 self.translated = os.getcwd()
689 self.translated = os.path.join(self.translated, 'filename')
690 self.handler = SocketlessRequestHandler()
691
692 def test_query_arguments(self):
693 path = self.handler.translate_path('/filename')
694 self.assertEqual(path, self.translated)
695 path = self.handler.translate_path('/filename?foo=bar')
696 self.assertEqual(path, self.translated)
697 path = self.handler.translate_path('/filename?a=b&spam=eggs#zot')
698 self.assertEqual(path, self.translated)
699
700 def test_start_with_double_slash(self):
701 path = self.handler.translate_path('//filename')
702 self.assertEqual(path, self.translated)
703 path = self.handler.translate_path('//filename?foo=bar')
704 self.assertEqual(path, self.translated)
705
706
Georg Brandlb533e262008-05-25 18:19:30 +0000707def test_main(verbose=None):
Georg Brandl6fcac0d2010-08-02 18:56:54 +0000708 cwd = os.getcwd()
Georg Brandlb533e262008-05-25 18:19:30 +0000709 try:
Georg Brandl6fcac0d2010-08-02 18:56:54 +0000710 support.run_unittest(
Senthil Kumaran0f476d42010-09-30 06:09:18 +0000711 BaseHTTPRequestHandlerTestCase,
Georg Brandl6fcac0d2010-08-02 18:56:54 +0000712 BaseHTTPServerTestCase,
713 SimpleHTTPServerTestCase,
714 CGIHTTPServerTestCase,
715 SimpleHTTPRequestHandlerTestCase,
716 )
Georg Brandlb533e262008-05-25 18:19:30 +0000717 finally:
718 os.chdir(cwd)
719
720if __name__ == '__main__':
721 test_main()