Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 1 | """Unittests for the various HTTPServer modules. |
| 2 | |
| 3 | Written by Cody A.W. Somerville <cody-somerville@ubuntu.com>, |
| 4 | Josip Dzolonga, and Michael Otteneder for the 2007/08 GHOP contest. |
| 5 | """ |
| 6 | |
Georg Brandl | 2442015 | 2008-05-26 16:32:26 +0000 | [diff] [blame] | 7 | from http.server import BaseHTTPRequestHandler, HTTPServer, \ |
| 8 | SimpleHTTPRequestHandler, CGIHTTPRequestHandler |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 9 | from http import server, HTTPStatus |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 10 | |
| 11 | import os |
| 12 | import sys |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 13 | import re |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 14 | import base64 |
| 15 | import shutil |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 16 | import urllib.parse |
Serhiy Storchaka | cb5bc40 | 2014-08-17 08:22:11 +0300 | [diff] [blame] | 17 | import html |
Georg Brandl | 2442015 | 2008-05-26 16:32:26 +0000 | [diff] [blame] | 18 | import http.client |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 19 | import tempfile |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 20 | from io import BytesIO |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 21 | |
| 22 | import unittest |
| 23 | from test import support |
Victor Stinner | 45df820 | 2010-04-28 22:31:17 +0000 | [diff] [blame] | 24 | threading = support.import_module('threading') |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 25 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 26 | class NoLogRequestHandler: |
| 27 | def log_message(self, *args): |
| 28 | # don't write log messages to stderr |
| 29 | pass |
| 30 | |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 31 | def read(self, n=None): |
| 32 | return '' |
| 33 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 34 | |
| 35 | class 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 Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 40 | |
| 41 | def run(self): |
Antoine Pitrou | cb34218 | 2011-03-21 00:26:51 +0100 | [diff] [blame] | 42 | self.server = HTTPServer(('localhost', 0), self.request_handler) |
| 43 | self.test_object.HOST, self.test_object.PORT = self.server.socket.getsockname() |
Antoine Pitrou | 08911bd | 2010-04-25 22:19:43 +0000 | [diff] [blame] | 44 | self.test_object.server_started.set() |
| 45 | self.test_object = None |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 46 | try: |
Antoine Pitrou | 08911bd | 2010-04-25 22:19:43 +0000 | [diff] [blame] | 47 | self.server.serve_forever(0.05) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 48 | finally: |
| 49 | self.server.server_close() |
| 50 | |
| 51 | def stop(self): |
| 52 | self.server.shutdown() |
| 53 | |
| 54 | |
| 55 | class BaseTestCase(unittest.TestCase): |
| 56 | def setUp(self): |
Antoine Pitrou | 45ebeb8 | 2009-10-27 18:52:30 +0000 | [diff] [blame] | 57 | self._threads = support.threading_setup() |
Nick Coghlan | 6ead552 | 2009-10-18 13:19:33 +0000 | [diff] [blame] | 58 | os.environ = support.EnvironmentVarGuard() |
Antoine Pitrou | 08911bd | 2010-04-25 22:19:43 +0000 | [diff] [blame] | 59 | self.server_started = threading.Event() |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 60 | self.thread = TestServerThread(self, self.request_handler) |
| 61 | self.thread.start() |
Antoine Pitrou | 08911bd | 2010-04-25 22:19:43 +0000 | [diff] [blame] | 62 | self.server_started.wait() |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 63 | |
| 64 | def tearDown(self): |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 65 | self.thread.stop() |
Antoine Pitrou | f727082 | 2012-09-30 01:05:30 +0200 | [diff] [blame] | 66 | self.thread = None |
Nick Coghlan | 6ead552 | 2009-10-18 13:19:33 +0000 | [diff] [blame] | 67 | os.environ.__exit__() |
Antoine Pitrou | 45ebeb8 | 2009-10-27 18:52:30 +0000 | [diff] [blame] | 68 | support.threading_cleanup(*self._threads) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 69 | |
| 70 | def request(self, uri, method='GET', body=None, headers={}): |
Antoine Pitrou | cb34218 | 2011-03-21 00:26:51 +0100 | [diff] [blame] | 71 | self.connection = http.client.HTTPConnection(self.HOST, self.PORT) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 72 | self.connection.request(method, uri, body, headers) |
| 73 | return self.connection.getresponse() |
| 74 | |
| 75 | |
| 76 | class 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 Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 82 | self.send_response(HTTPStatus.NO_CONTENT) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 83 | self.send_header('Content-Type', 'text/html') |
| 84 | self.send_header('Connection', 'close') |
| 85 | self.end_headers() |
| 86 | |
| 87 | def do_KEEP(self): |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 88 | self.send_response(HTTPStatus.NO_CONTENT) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 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 Kumaran | 52d2720 | 2012-10-10 23:16:21 -0700 | [diff] [blame] | 96 | def do_NOTFOUND(self): |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 97 | self.send_error(HTTPStatus.NOT_FOUND) |
Senthil Kumaran | 52d2720 | 2012-10-10 23:16:21 -0700 | [diff] [blame] | 98 | |
Senthil Kumaran | 2688644 | 2013-03-15 07:53:21 -0700 | [diff] [blame] | 99 | def do_EXPLAINERROR(self): |
| 100 | self.send_error(999, "Short Message", |
| 101 | "This is a long \n explaination") |
| 102 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 103 | 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 Ronacher | 8d96d77 | 2011-01-22 13:13:05 +0000 | [diff] [blame] | 109 | def do_LATINONEHEADER(self): |
| 110 | self.send_response(999) |
| 111 | self.send_header('X-Special', 'Dängerous Mind') |
Armin Ronacher | 5953128 | 2011-01-22 13:44:22 +0000 | [diff] [blame] | 112 | self.send_header('Connection', 'close') |
Armin Ronacher | 8d96d77 | 2011-01-22 13:13:05 +0000 | [diff] [blame] | 113 | self.end_headers() |
Armin Ronacher | 5953128 | 2011-01-22 13:44:22 +0000 | [diff] [blame] | 114 | body = self.headers['x-special-incoming'].encode('utf-8') |
| 115 | self.wfile.write(body) |
Armin Ronacher | 8d96d77 | 2011-01-22 13:13:05 +0000 | [diff] [blame] | 116 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 117 | def setUp(self): |
| 118 | BaseTestCase.setUp(self) |
Antoine Pitrou | cb34218 | 2011-03-21 00:26:51 +0100 | [diff] [blame] | 119 | self.con = http.client.HTTPConnection(self.HOST, self.PORT) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 120 | self.con.connect() |
| 121 | |
| 122 | def test_command(self): |
| 123 | self.con.request('GET', '/') |
| 124 | res = self.con.getresponse() |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 125 | self.assertEqual(res.status, HTTPStatus.NOT_IMPLEMENTED) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 126 | |
| 127 | def test_request_line_trimming(self): |
| 128 | self.con._http_vsn_str = 'HTTP/1.1\n' |
R David Murray | 14199f9 | 2014-06-24 16:39:49 -0400 | [diff] [blame] | 129 | self.con.putrequest('XYZBOGUS', '/') |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 130 | self.con.endheaders() |
| 131 | res = self.con.getresponse() |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 132 | self.assertEqual(res.status, HTTPStatus.NOT_IMPLEMENTED) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 133 | |
| 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 Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 139 | self.assertEqual(res.status, HTTPStatus.BAD_REQUEST) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 140 | |
| 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 Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 146 | self.assertEqual(res.status, HTTPStatus.BAD_REQUEST) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 147 | |
| 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 Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 153 | self.assertEqual(res.status, HTTPStatus.NOT_IMPLEMENTED) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 154 | |
| 155 | def test_version_none(self): |
R David Murray | 14199f9 | 2014-06-24 16:39:49 -0400 | [diff] [blame] | 156 | # Test that a valid method is rejected when not HTTP/1.x |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 157 | self.con._http_vsn_str = '' |
R David Murray | 14199f9 | 2014-06-24 16:39:49 -0400 | [diff] [blame] | 158 | self.con.putrequest('CUSTOM', '/') |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 159 | self.con.endheaders() |
| 160 | res = self.con.getresponse() |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 161 | self.assertEqual(res.status, HTTPStatus.BAD_REQUEST) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 162 | |
| 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 Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 169 | self.assertEqual(res.status, HTTPStatus.HTTP_VERSION_NOT_SUPPORTED) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 170 | |
| 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 Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 176 | self.assertEqual(res.status, HTTPStatus.BAD_REQUEST) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 177 | |
| 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 Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 183 | self.assertEqual(res.status, HTTPStatus.NOT_IMPLEMENTED) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 184 | |
| 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 Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 191 | self.assertEqual(res.status, HTTPStatus.NOT_IMPLEMENTED) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 192 | |
| 193 | def test_handler(self): |
| 194 | self.con.request('TEST', '/') |
| 195 | res = self.con.getresponse() |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 196 | self.assertEqual(res.status, HTTPStatus.NO_CONTENT) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 197 | |
| 198 | def test_return_header_keep_alive(self): |
| 199 | self.con.request('KEEP', '/') |
| 200 | res = self.con.getresponse() |
Florent Xicluna | 9b86b9a | 2010-03-19 19:00:44 +0000 | [diff] [blame] | 201 | self.assertEqual(res.getheader('Connection'), 'keep-alive') |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 202 | self.con.request('TEST', '/') |
Brian Curtin | 61d0d60 | 2010-10-31 00:34:23 +0000 | [diff] [blame] | 203 | self.addCleanup(self.con.close) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 204 | |
| 205 | def test_internal_key_error(self): |
| 206 | self.con.request('KEYERROR', '/') |
| 207 | res = self.con.getresponse() |
Florent Xicluna | 9b86b9a | 2010-03-19 19:00:44 +0000 | [diff] [blame] | 208 | self.assertEqual(res.status, 999) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 209 | |
| 210 | def test_return_custom_status(self): |
| 211 | self.con.request('CUSTOM', '/') |
| 212 | res = self.con.getresponse() |
Florent Xicluna | 9b86b9a | 2010-03-19 19:00:44 +0000 | [diff] [blame] | 213 | self.assertEqual(res.status, 999) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 214 | |
Senthil Kumaran | 2688644 | 2013-03-15 07:53:21 -0700 | [diff] [blame] | 215 | 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 Ronacher | 8d96d77 | 2011-01-22 13:13:05 +0000 | [diff] [blame] | 221 | def test_latin1_header(self): |
Armin Ronacher | 5953128 | 2011-01-22 13:44:22 +0000 | [diff] [blame] | 222 | self.con.request('LATINONEHEADER', '/', headers={ |
| 223 | 'X-Special-Incoming': 'Ärger mit Unicode' |
| 224 | }) |
Armin Ronacher | 8d96d77 | 2011-01-22 13:13:05 +0000 | [diff] [blame] | 225 | res = self.con.getresponse() |
| 226 | self.assertEqual(res.getheader('X-Special'), 'Dängerous Mind') |
Armin Ronacher | 5953128 | 2011-01-22 13:44:22 +0000 | [diff] [blame] | 227 | self.assertEqual(res.read(), 'Ärger mit Unicode'.encode('utf-8')) |
Armin Ronacher | 8d96d77 | 2011-01-22 13:13:05 +0000 | [diff] [blame] | 228 | |
Senthil Kumaran | 52d2720 | 2012-10-10 23:16:21 -0700 | [diff] [blame] | 229 | 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 Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 233 | self.assertEqual(res.status, HTTPStatus.NOT_FOUND) |
| 234 | |
Senthil Kumaran | 52d2720 | 2012-10-10 23:16:21 -0700 | [diff] [blame] | 235 | data = res.read() |
Senthil Kumaran | 52d2720 | 2012-10-10 23:16:21 -0700 | [diff] [blame] | 236 | self.assertEqual(int(res.getheader('Content-Length')), len(data)) |
| 237 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 238 | |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 239 | class 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 Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 275 | class 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 Cannon | 105df5d | 2010-10-29 23:43:42 +0000 | [diff] [blame] | 287 | with open(os.path.join(self.tempdir, 'test'), 'wb') as temp: |
| 288 | temp.write(self.data) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 289 | |
| 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 Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 302 | self.assertTrue(response) |
Florent Xicluna | 9b86b9a | 2010-03-19 19:00:44 +0000 | [diff] [blame] | 303 | self.assertEqual(response.status, status) |
| 304 | self.assertIsNotNone(response.reason) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 305 | if data: |
| 306 | self.assertEqual(data, body) |
Serhiy Storchaka | cb5bc40 | 2014-08-17 08:22:11 +0300 | [diff] [blame] | 307 | return body |
| 308 | |
Ned Deily | 1418320 | 2015-01-05 01:02:30 -0800 | [diff] [blame] | 309 | @support.requires_mac_ver(10, 5) |
Serhiy Storchaka | cb5bc40 | 2014-08-17 08:22:11 +0300 | [diff] [blame] | 310 | @unittest.skipUnless(support.TESTFN_UNDECODABLE, |
| 311 | 'need support.TESTFN_UNDECODABLE') |
| 312 | def test_undecodable_filename(self): |
Serhiy Storchaka | a64ce5d | 2014-08-17 12:20:02 +0300 | [diff] [blame] | 313 | enc = sys.getfilesystemencoding() |
Serhiy Storchaka | cb5bc40 | 2014-08-17 08:22:11 +0300 | [diff] [blame] | 314 | 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 Storchaka | d9e9528 | 2014-08-17 16:57:39 +0300 | [diff] [blame] | 318 | 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 Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 325 | body = self.check_status_and_reason(response, HTTPStatus.OK) |
Serhiy Storchaka | cb5bc40 | 2014-08-17 08:22:11 +0300 | [diff] [blame] | 326 | quotedname = urllib.parse.quote(filename, errors='surrogatepass') |
| 327 | self.assertIn(('href="%s"' % quotedname) |
Serhiy Storchaka | a64ce5d | 2014-08-17 12:20:02 +0300 | [diff] [blame] | 328 | .encode(enc, 'surrogateescape'), body) |
Serhiy Storchaka | cb5bc40 | 2014-08-17 08:22:11 +0300 | [diff] [blame] | 329 | self.assertIn(('>%s<' % html.escape(filename)) |
Serhiy Storchaka | a64ce5d | 2014-08-17 12:20:02 +0300 | [diff] [blame] | 330 | .encode(enc, 'surrogateescape'), body) |
Serhiy Storchaka | cb5bc40 | 2014-08-17 08:22:11 +0300 | [diff] [blame] | 331 | response = self.request(self.tempdir_name + '/' + quotedname) |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 332 | self.check_status_and_reason(response, HTTPStatus.OK, |
Serhiy Storchaka | cb5bc40 | 2014-08-17 08:22:11 +0300 | [diff] [blame] | 333 | data=support.TESTFN_UNDECODABLE) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 334 | |
| 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 Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 338 | self.check_status_and_reason(response, HTTPStatus.OK, data=self.data) |
Senthil Kumaran | 72c238e | 2013-09-13 00:21:18 -0700 | [diff] [blame] | 339 | # check for trailing "/" which should return 404. See Issue17324 |
| 340 | response = self.request(self.tempdir_name + '/test/') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 341 | self.check_status_and_reason(response, HTTPStatus.NOT_FOUND) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 342 | response = self.request(self.tempdir_name + '/') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 343 | self.check_status_and_reason(response, HTTPStatus.OK) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 344 | response = self.request(self.tempdir_name) |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 345 | self.check_status_and_reason(response, HTTPStatus.MOVED_PERMANENTLY) |
Benjamin Peterson | 94cb7a2 | 2014-12-26 10:53:43 -0600 | [diff] [blame] | 346 | response = self.request(self.tempdir_name + '/?hi=2') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 347 | self.check_status_and_reason(response, HTTPStatus.OK) |
Benjamin Peterson | 94cb7a2 | 2014-12-26 10:53:43 -0600 | [diff] [blame] | 348 | response = self.request(self.tempdir_name + '?hi=1') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 349 | self.check_status_and_reason(response, HTTPStatus.MOVED_PERMANENTLY) |
Benjamin Peterson | 94cb7a2 | 2014-12-26 10:53:43 -0600 | [diff] [blame] | 350 | self.assertEqual(response.getheader("Location"), |
| 351 | self.tempdir_name + "/?hi=1") |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 352 | response = self.request('/ThisDoesNotExist') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 353 | self.check_status_and_reason(response, HTTPStatus.NOT_FOUND) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 354 | response = self.request('/' + 'ThisDoesNotExist' + '/') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 355 | self.check_status_and_reason(response, HTTPStatus.NOT_FOUND) |
Brett Cannon | 105df5d | 2010-10-29 23:43:42 +0000 | [diff] [blame] | 356 | with open(os.path.join(self.tempdir_name, 'index.html'), 'w') as f: |
| 357 | response = self.request('/' + self.tempdir_name + '/') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 358 | self.check_status_and_reason(response, HTTPStatus.OK) |
Charles-François Natali | f7ed9fc | 2011-11-02 19:35:14 +0100 | [diff] [blame] | 359 | # 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 Cannon | 105df5d | 2010-10-29 23:43:42 +0000 | [diff] [blame] | 362 | os.chmod(self.tempdir, 0) |
| 363 | response = self.request(self.tempdir_name + '/') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 364 | self.check_status_and_reason(response, HTTPStatus.NOT_FOUND) |
Brett Cannon | 105df5d | 2010-10-29 23:43:42 +0000 | [diff] [blame] | 365 | os.chmod(self.tempdir, 0o755) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 366 | |
| 367 | def test_head(self): |
| 368 | response = self.request( |
| 369 | self.tempdir_name + '/test', method='HEAD') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 370 | self.check_status_and_reason(response, HTTPStatus.OK) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 371 | 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 Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 378 | self.check_status_and_reason(response, HTTPStatus.NOT_IMPLEMENTED) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 379 | # requests must be case sensitive,so this should fail too |
Terry Jan Reedy | dd09efd | 2014-10-18 17:10:09 -0400 | [diff] [blame] | 380 | response = self.request('/', method='custom') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 381 | self.check_status_and_reason(response, HTTPStatus.NOT_IMPLEMENTED) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 382 | response = self.request('/', method='GETs') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 383 | self.check_status_and_reason(response, HTTPStatus.NOT_IMPLEMENTED) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 384 | |
| 385 | |
| 386 | cgi_file1 = """\ |
| 387 | #!%s |
| 388 | |
| 389 | print("Content-type: text/html") |
| 390 | print() |
| 391 | print("Hello World") |
| 392 | """ |
| 393 | |
| 394 | cgi_file2 = """\ |
| 395 | #!%s |
| 396 | import cgi |
| 397 | |
| 398 | print("Content-type: text/html") |
| 399 | print() |
| 400 | |
| 401 | form = cgi.FieldStorage() |
Florent Xicluna | 9b86b9a | 2010-03-19 19:00:44 +0000 | [diff] [blame] | 402 | print("%%s, %%s, %%s" %% (form.getfirst("spam"), form.getfirst("eggs"), |
| 403 | form.getfirst("bacon"))) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 404 | """ |
| 405 | |
Charles-François Natali | f7ed9fc | 2011-11-02 19:35:14 +0100 | [diff] [blame] | 406 | |
| 407 | @unittest.skipIf(hasattr(os, 'geteuid') and os.geteuid() == 0, |
| 408 | "This test can't be run reliably as root (issue #13308).") |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 409 | class CGIHTTPServerTestCase(BaseTestCase): |
| 410 | class request_handler(NoLogRequestHandler, CGIHTTPRequestHandler): |
| 411 | pass |
| 412 | |
Antoine Pitrou | e768c39 | 2012-08-05 14:52:45 +0200 | [diff] [blame] | 413 | linesep = os.linesep.encode('ascii') |
| 414 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 415 | def setUp(self): |
| 416 | BaseTestCase.setUp(self) |
Victor Stinner | 0b0ca0c | 2010-10-17 19:46:36 +0000 | [diff] [blame] | 417 | self.cwd = os.getcwd() |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 418 | self.parent_dir = tempfile.mkdtemp() |
| 419 | self.cgi_dir = os.path.join(self.parent_dir, 'cgi-bin') |
Ned Deily | 915a30f | 2014-07-12 22:06:26 -0700 | [diff] [blame] | 420 | self.cgi_child_dir = os.path.join(self.cgi_dir, 'child-dir') |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 421 | os.mkdir(self.cgi_dir) |
Ned Deily | 915a30f | 2014-07-12 22:06:26 -0700 | [diff] [blame] | 422 | os.mkdir(self.cgi_child_dir) |
Benjamin Peterson | 35aca89 | 2013-10-30 12:48:59 -0400 | [diff] [blame] | 423 | self.nocgi_path = None |
Victor Stinner | 0b0ca0c | 2010-10-17 19:46:36 +0000 | [diff] [blame] | 424 | self.file1_path = None |
| 425 | self.file2_path = None |
Ned Deily | 915a30f | 2014-07-12 22:06:26 -0700 | [diff] [blame] | 426 | self.file3_path = None |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 427 | |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 428 | # The shebang line should be pure ASCII: use symlink if possible. |
| 429 | # See issue #7668. |
Brian Curtin | 3b4499c | 2010-12-28 14:31:47 +0000 | [diff] [blame] | 430 | if support.can_symlink(): |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 431 | 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 Stinner | 3218c31 | 2010-10-17 20:13:36 +0000 | [diff] [blame] | 436 | 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 Storchaka | 0b4591e | 2013-02-04 15:45:00 +0200 | [diff] [blame] | 443 | self.skipTest("Python executable path is not encodable to utf-8") |
Victor Stinner | 3218c31 | 2010-10-17 20:13:36 +0000 | [diff] [blame] | 444 | |
Benjamin Peterson | 04e9de4 | 2013-10-30 12:43:09 -0400 | [diff] [blame] | 445 | 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 Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 450 | self.file1_path = os.path.join(self.cgi_dir, 'file1.py') |
Victor Stinner | 6fb4575 | 2010-10-17 20:17:41 +0000 | [diff] [blame] | 451 | with open(self.file1_path, 'w', encoding='utf-8') as file1: |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 452 | file1.write(cgi_file1 % self.pythonexe) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 453 | os.chmod(self.file1_path, 0o777) |
| 454 | |
| 455 | self.file2_path = os.path.join(self.cgi_dir, 'file2.py') |
Victor Stinner | 6fb4575 | 2010-10-17 20:17:41 +0000 | [diff] [blame] | 456 | with open(self.file2_path, 'w', encoding='utf-8') as file2: |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 457 | file2.write(cgi_file2 % self.pythonexe) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 458 | os.chmod(self.file2_path, 0o777) |
| 459 | |
Ned Deily | 915a30f | 2014-07-12 22:06:26 -0700 | [diff] [blame] | 460 | 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 Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 465 | os.chdir(self.parent_dir) |
| 466 | |
| 467 | def tearDown(self): |
| 468 | try: |
| 469 | os.chdir(self.cwd) |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 470 | if self.pythonexe != sys.executable: |
| 471 | os.remove(self.pythonexe) |
Benjamin Peterson | 35aca89 | 2013-10-30 12:48:59 -0400 | [diff] [blame] | 472 | if self.nocgi_path: |
| 473 | os.remove(self.nocgi_path) |
Victor Stinner | 0b0ca0c | 2010-10-17 19:46:36 +0000 | [diff] [blame] | 474 | if self.file1_path: |
| 475 | os.remove(self.file1_path) |
| 476 | if self.file2_path: |
| 477 | os.remove(self.file2_path) |
Ned Deily | 915a30f | 2014-07-12 22:06:26 -0700 | [diff] [blame] | 478 | if self.file3_path: |
| 479 | os.remove(self.file3_path) |
| 480 | os.rmdir(self.cgi_child_dir) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 481 | os.rmdir(self.cgi_dir) |
| 482 | os.rmdir(self.parent_dir) |
| 483 | finally: |
| 484 | BaseTestCase.tearDown(self) |
| 485 | |
Senthil Kumaran | d70846b | 2012-04-12 02:34:32 +0800 | [diff] [blame] | 486 | def test_url_collapse_path(self): |
| 487 | # verify tail is the last portion and head is the rest on proper urls |
Benjamin Peterson | ad71f0f | 2009-04-11 20:12:10 +0000 | [diff] [blame] | 488 | test_vectors = { |
Senthil Kumaran | d70846b | 2012-04-12 02:34:32 +0800 | [diff] [blame] | 489 | '': '//', |
Benjamin Peterson | ad71f0f | 2009-04-11 20:12:10 +0000 | [diff] [blame] | 490 | '..': IndexError, |
| 491 | '/.//..': IndexError, |
Senthil Kumaran | d70846b | 2012-04-12 02:34:32 +0800 | [diff] [blame] | 492 | '/': '//', |
| 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 Peterson | ad71f0f | 2009-04-11 20:12:10 +0000 | [diff] [blame] | 511 | '../a/b/c/../d/e/.././././..//f': IndexError, |
Senthil Kumaran | d70846b | 2012-04-12 02:34:32 +0800 | [diff] [blame] | 512 | '/a/b/c/../d/e/../../../f': '/a/f', |
| 513 | '/a/b/c/../d/e/../../../../f': '//f', |
Benjamin Peterson | ad71f0f | 2009-04-11 20:12:10 +0000 | [diff] [blame] | 514 | '/a/b/c/../d/e/../../../../../f': IndexError, |
Senthil Kumaran | d70846b | 2012-04-12 02:34:32 +0800 | [diff] [blame] | 515 | '/a/b/c/../d/e/../../../../f/..': '//', |
| 516 | '/a/b/c/../d/e/../../../../f/../.': '//', |
Benjamin Peterson | ad71f0f | 2009-04-11 20:12:10 +0000 | [diff] [blame] | 517 | } |
| 518 | for path, expected in test_vectors.items(): |
| 519 | if isinstance(expected, type) and issubclass(expected, Exception): |
| 520 | self.assertRaises(expected, |
Senthil Kumaran | d70846b | 2012-04-12 02:34:32 +0800 | [diff] [blame] | 521 | server._url_collapse_path, path) |
Benjamin Peterson | ad71f0f | 2009-04-11 20:12:10 +0000 | [diff] [blame] | 522 | else: |
Senthil Kumaran | d70846b | 2012-04-12 02:34:32 +0800 | [diff] [blame] | 523 | actual = server._url_collapse_path(path) |
Florent Xicluna | 9b86b9a | 2010-03-19 19:00:44 +0000 | [diff] [blame] | 524 | self.assertEqual(expected, actual, |
| 525 | msg='path = %r\nGot: %r\nWanted: %r' % |
| 526 | (path, actual, expected)) |
Benjamin Peterson | ad71f0f | 2009-04-11 20:12:10 +0000 | [diff] [blame] | 527 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 528 | def test_headers_and_content(self): |
| 529 | res = self.request('/cgi-bin/file1.py') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 530 | self.assertEqual( |
| 531 | (res.read(), res.getheader('Content-type'), res.status), |
| 532 | (b'Hello World' + self.linesep, 'text/html', HTTPStatus.OK)) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 533 | |
Benjamin Peterson | 04e9de4 | 2013-10-30 12:43:09 -0400 | [diff] [blame] | 534 | def test_issue19435(self): |
| 535 | res = self.request('///////////nocgi.py/../cgi-bin/nothere.sh') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 536 | self.assertEqual(res.status, HTTPStatus.NOT_FOUND) |
Benjamin Peterson | 04e9de4 | 2013-10-30 12:43:09 -0400 | [diff] [blame] | 537 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 538 | def test_post(self): |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 539 | params = urllib.parse.urlencode( |
| 540 | {'spam' : 1, 'eggs' : 'python', 'bacon' : 123456}) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 541 | headers = {'Content-type' : 'application/x-www-form-urlencoded'} |
| 542 | res = self.request('/cgi-bin/file2.py', 'POST', params, headers) |
| 543 | |
Antoine Pitrou | e768c39 | 2012-08-05 14:52:45 +0200 | [diff] [blame] | 544 | self.assertEqual(res.read(), b'1, python, 123456' + self.linesep) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 545 | |
| 546 | def test_invaliduri(self): |
| 547 | res = self.request('/cgi-bin/invalid') |
| 548 | res.read() |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 549 | self.assertEqual(res.status, HTTPStatus.NOT_FOUND) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 550 | |
| 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 Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 555 | self.assertEqual( |
| 556 | (b'Hello World' + self.linesep, 'text/html', HTTPStatus.OK), |
| 557 | (res.read(), res.getheader('Content-type'), res.status)) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 558 | |
Benjamin Peterson | ad71f0f | 2009-04-11 20:12:10 +0000 | [diff] [blame] | 559 | def test_no_leading_slash(self): |
| 560 | # http://bugs.python.org/issue2254 |
| 561 | res = self.request('cgi-bin/file1.py') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 562 | self.assertEqual( |
| 563 | (b'Hello World' + self.linesep, 'text/html', HTTPStatus.OK), |
| 564 | (res.read(), res.getheader('Content-type'), res.status)) |
Benjamin Peterson | ad71f0f | 2009-04-11 20:12:10 +0000 | [diff] [blame] | 565 | |
Senthil Kumaran | 4271372 | 2010-10-03 17:55:45 +0000 | [diff] [blame] | 566 | 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 Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 570 | self.assertEqual( |
| 571 | (b'Hello World' + self.linesep, 'text/html', HTTPStatus.OK), |
| 572 | (res.read(), res.getheader('Content-type'), res.status)) |
Senthil Kumaran | 4271372 | 2010-10-03 17:55:45 +0000 | [diff] [blame] | 573 | self.assertEqual(os.environ['SERVER_SOFTWARE'], signature) |
| 574 | |
Benjamin Peterson | 73b8b1c | 2014-06-14 18:36:29 -0700 | [diff] [blame] | 575 | def test_urlquote_decoding_in_cgi_check(self): |
| 576 | res = self.request('/cgi-bin%2ffile1.py') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 577 | self.assertEqual( |
| 578 | (b'Hello World' + self.linesep, 'text/html', HTTPStatus.OK), |
| 579 | (res.read(), res.getheader('Content-type'), res.status)) |
Benjamin Peterson | 73b8b1c | 2014-06-14 18:36:29 -0700 | [diff] [blame] | 580 | |
Ned Deily | 915a30f | 2014-07-12 22:06:26 -0700 | [diff] [blame] | 581 | def test_nested_cgi_path_issue21323(self): |
| 582 | res = self.request('/cgi-bin/child-dir/file3.py') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 583 | self.assertEqual( |
| 584 | (b'Hello World' + self.linesep, 'text/html', HTTPStatus.OK), |
| 585 | (res.read(), res.getheader('Content-type'), res.status)) |
Ned Deily | 915a30f | 2014-07-12 22:06:26 -0700 | [diff] [blame] | 586 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 587 | |
Georg Brandl | 6fcac0d | 2010-08-02 18:56:54 +0000 | [diff] [blame] | 588 | class SocketlessRequestHandler(SimpleHTTPRequestHandler): |
| 589 | def __init__(self): |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 590 | self.get_called = False |
| 591 | self.protocol_version = "HTTP/1.1" |
| 592 | |
| 593 | def do_GET(self): |
| 594 | self.get_called = True |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 595 | self.send_response(HTTPStatus.OK) |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 596 | 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 Brandl | 6fcac0d | 2010-08-02 18:56:54 +0000 | [diff] [blame] | 601 | pass |
| 602 | |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 603 | class RejectingSocketlessRequestHandler(SocketlessRequestHandler): |
| 604 | def handle_expect_100(self): |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 605 | self.send_error(HTTPStatus.EXPECTATION_FAILED) |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 606 | return False |
| 607 | |
Senthil Kumaran | c7ae19b | 2011-05-09 23:25:02 +0800 | [diff] [blame] | 608 | |
| 609 | class 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 Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 625 | class BaseHTTPRequestHandlerTestCase(unittest.TestCase): |
Ezio Melotti | 3b3499b | 2011-03-16 11:35:38 +0200 | [diff] [blame] | 626 | """Test the functionality of the BaseHTTPServer. |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 627 | |
| 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 Storchaka | 25d8aea | 2014-02-08 14:50:08 +0200 | [diff] [blame] | 654 | self.assertIsNotNone(match) |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 655 | |
| 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 Peterson | 70e2847 | 2015-02-17 21:11:10 -0500 | [diff] [blame] | 662 | 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 Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 667 | |
| 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 Peterson | 70e2847 | 2015-02-17 21:11:10 -0500 | [diff] [blame] | 674 | 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 Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 679 | |
| 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 Peterson | 70e2847 | 2015-02-17 21:11:10 -0500 | [diff] [blame] | 692 | 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 Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 698 | |
| 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 Peterson | 0442423 | 2014-01-18 21:50:18 -0500 | [diff] [blame] | 702 | self.assertEqual(result[1], b'\r\n') |
| 703 | self.assertEqual(result[2], b'HTTP/1.1 200 OK\r\n') |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 704 | 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 Peterson | 70e2847 | 2015-02-17 21:11:10 -0500 | [diff] [blame] | 707 | 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 Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 713 | |
Senthil Kumaran | c7ae19b | 2011-05-09 23:25:02 +0800 | [diff] [blame] | 714 | def test_header_buffering_of_send_error(self): |
Senthil Kumaran | e4dad4f | 2010-11-21 14:36:14 +0000 | [diff] [blame] | 715 | |
| 716 | input = BytesIO(b'GET / HTTP/1.1\r\n\r\n') |
Senthil Kumaran | c7ae19b | 2011-05-09 23:25:02 +0800 | [diff] [blame] | 717 | 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 Kumaran | e4dad4f | 2010-11-21 14:36:14 +0000 | [diff] [blame] | 724 | |
Senthil Kumaran | c7ae19b | 2011-05-09 23:25:02 +0800 | [diff] [blame] | 725 | 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 Kumaran | e4dad4f | 2010-11-21 14:36:14 +0000 | [diff] [blame] | 757 | |
| 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 Peterson | 0442423 | 2014-01-18 21:50:18 -0500 | [diff] [blame] | 777 | self.assertEqual(result[1], b'') |
| 778 | self.assertEqual(result[2], b'HTTP/1.1 200 OK') |
Senthil Kumaran | e4dad4f | 2010-11-21 14:36:14 +0000 | [diff] [blame] | 779 | |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 780 | 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 Pitrou | c492437 | 2010-12-16 16:48:36 +0000 | [diff] [blame] | 792 | 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 Peterson | 70e2847 | 2015-02-17 21:11:10 -0500 | [diff] [blame] | 798 | self.assertIsInstance(self.handler.requestline, str) |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 799 | |
Senthil Kumaran | 5466bf1 | 2010-12-18 16:55:23 +0000 | [diff] [blame] | 800 | 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 Peterson | 70e2847 | 2015-02-17 21:11:10 -0500 | [diff] [blame] | 806 | 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 Kumaran | 5466bf1 | 2010-12-18 16:55:23 +0000 | [diff] [blame] | 822 | |
Georg Brandl | 6fcac0d | 2010-08-02 18:56:54 +0000 | [diff] [blame] | 823 | class 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 Peksag | 366c570 | 2015-02-13 20:48:15 +0200 | [diff] [blame] | 845 | class 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 Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 858 | def test_main(verbose=None): |
Georg Brandl | 6fcac0d | 2010-08-02 18:56:54 +0000 | [diff] [blame] | 859 | cwd = os.getcwd() |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 860 | try: |
Georg Brandl | 6fcac0d | 2010-08-02 18:56:54 +0000 | [diff] [blame] | 861 | support.run_unittest( |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 862 | RequestHandlerLoggingTestCase, |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 863 | BaseHTTPRequestHandlerTestCase, |
Georg Brandl | 6fcac0d | 2010-08-02 18:56:54 +0000 | [diff] [blame] | 864 | BaseHTTPServerTestCase, |
| 865 | SimpleHTTPServerTestCase, |
| 866 | CGIHTTPServerTestCase, |
| 867 | SimpleHTTPRequestHandlerTestCase, |
Berker Peksag | 366c570 | 2015-02-13 20:48:15 +0200 | [diff] [blame] | 868 | MiscTestCase, |
Georg Brandl | 6fcac0d | 2010-08-02 18:56:54 +0000 | [diff] [blame] | 869 | ) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 870 | finally: |
| 871 | os.chdir(cwd) |
| 872 | |
| 873 | if __name__ == '__main__': |
| 874 | test_main() |