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 |
Lisa Roach | 433433f | 2018-11-26 10:43:38 -0800 | [diff] [blame] | 12 | import socket |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 13 | import sys |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 14 | import re |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 15 | import base64 |
Martin Panter | d274b3f | 2016-04-18 03:45:18 +0000 | [diff] [blame] | 16 | import ntpath |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 17 | import shutil |
Pierre Quentel | 351adda | 2017-04-02 12:26:12 +0200 | [diff] [blame] | 18 | import email.message |
| 19 | import email.utils |
Serhiy Storchaka | cb5bc40 | 2014-08-17 08:22:11 +0300 | [diff] [blame] | 20 | import html |
Georg Brandl | 2442015 | 2008-05-26 16:32:26 +0000 | [diff] [blame] | 21 | import http.client |
Pierre Quentel | 351adda | 2017-04-02 12:26:12 +0200 | [diff] [blame] | 22 | import urllib.parse |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 23 | import tempfile |
Berker Peksag | 04bc5b9 | 2016-03-14 06:06:03 +0200 | [diff] [blame] | 24 | import time |
Pierre Quentel | 351adda | 2017-04-02 12:26:12 +0200 | [diff] [blame] | 25 | import datetime |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 26 | import threading |
Stéphane Wirtel | a17a2f5 | 2017-05-24 09:29:06 +0200 | [diff] [blame] | 27 | from unittest import mock |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 28 | from io import BytesIO |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 29 | |
| 30 | import unittest |
| 31 | from test import support |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 32 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 33 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 34 | class NoLogRequestHandler: |
| 35 | def log_message(self, *args): |
| 36 | # don't write log messages to stderr |
| 37 | pass |
| 38 | |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 39 | def read(self, n=None): |
| 40 | return '' |
| 41 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 42 | |
| 43 | class TestServerThread(threading.Thread): |
| 44 | def __init__(self, test_object, request_handler): |
| 45 | threading.Thread.__init__(self) |
| 46 | self.request_handler = request_handler |
| 47 | self.test_object = test_object |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 48 | |
| 49 | def run(self): |
Antoine Pitrou | cb34218 | 2011-03-21 00:26:51 +0100 | [diff] [blame] | 50 | self.server = HTTPServer(('localhost', 0), self.request_handler) |
| 51 | self.test_object.HOST, self.test_object.PORT = self.server.socket.getsockname() |
Antoine Pitrou | 08911bd | 2010-04-25 22:19:43 +0000 | [diff] [blame] | 52 | self.test_object.server_started.set() |
| 53 | self.test_object = None |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 54 | try: |
Antoine Pitrou | 08911bd | 2010-04-25 22:19:43 +0000 | [diff] [blame] | 55 | self.server.serve_forever(0.05) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 56 | finally: |
| 57 | self.server.server_close() |
| 58 | |
| 59 | def stop(self): |
| 60 | self.server.shutdown() |
Victor Stinner | 830d7d2 | 2017-08-22 18:05:07 +0200 | [diff] [blame] | 61 | self.join() |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 62 | |
| 63 | |
| 64 | class BaseTestCase(unittest.TestCase): |
| 65 | def setUp(self): |
Antoine Pitrou | 45ebeb8 | 2009-10-27 18:52:30 +0000 | [diff] [blame] | 66 | self._threads = support.threading_setup() |
Nick Coghlan | 6ead552 | 2009-10-18 13:19:33 +0000 | [diff] [blame] | 67 | os.environ = support.EnvironmentVarGuard() |
Antoine Pitrou | 08911bd | 2010-04-25 22:19:43 +0000 | [diff] [blame] | 68 | self.server_started = threading.Event() |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 69 | self.thread = TestServerThread(self, self.request_handler) |
| 70 | self.thread.start() |
Antoine Pitrou | 08911bd | 2010-04-25 22:19:43 +0000 | [diff] [blame] | 71 | self.server_started.wait() |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 72 | |
| 73 | def tearDown(self): |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 74 | self.thread.stop() |
Antoine Pitrou | f727082 | 2012-09-30 01:05:30 +0200 | [diff] [blame] | 75 | self.thread = None |
Nick Coghlan | 6ead552 | 2009-10-18 13:19:33 +0000 | [diff] [blame] | 76 | os.environ.__exit__() |
Antoine Pitrou | 45ebeb8 | 2009-10-27 18:52:30 +0000 | [diff] [blame] | 77 | support.threading_cleanup(*self._threads) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 78 | |
| 79 | def request(self, uri, method='GET', body=None, headers={}): |
Antoine Pitrou | cb34218 | 2011-03-21 00:26:51 +0100 | [diff] [blame] | 80 | self.connection = http.client.HTTPConnection(self.HOST, self.PORT) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 81 | self.connection.request(method, uri, body, headers) |
| 82 | return self.connection.getresponse() |
| 83 | |
| 84 | |
| 85 | class BaseHTTPServerTestCase(BaseTestCase): |
| 86 | class request_handler(NoLogRequestHandler, BaseHTTPRequestHandler): |
| 87 | protocol_version = 'HTTP/1.1' |
| 88 | default_request_version = 'HTTP/1.1' |
| 89 | |
| 90 | def do_TEST(self): |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 91 | self.send_response(HTTPStatus.NO_CONTENT) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 92 | self.send_header('Content-Type', 'text/html') |
| 93 | self.send_header('Connection', 'close') |
| 94 | self.end_headers() |
| 95 | |
| 96 | def do_KEEP(self): |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 97 | self.send_response(HTTPStatus.NO_CONTENT) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 98 | self.send_header('Content-Type', 'text/html') |
| 99 | self.send_header('Connection', 'keep-alive') |
| 100 | self.end_headers() |
| 101 | |
| 102 | def do_KEYERROR(self): |
| 103 | self.send_error(999) |
| 104 | |
Senthil Kumaran | 52d2720 | 2012-10-10 23:16:21 -0700 | [diff] [blame] | 105 | def do_NOTFOUND(self): |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 106 | self.send_error(HTTPStatus.NOT_FOUND) |
Senthil Kumaran | 52d2720 | 2012-10-10 23:16:21 -0700 | [diff] [blame] | 107 | |
Senthil Kumaran | 2688644 | 2013-03-15 07:53:21 -0700 | [diff] [blame] | 108 | def do_EXPLAINERROR(self): |
| 109 | self.send_error(999, "Short Message", |
Martin Panter | 46f5072 | 2016-05-26 05:35:26 +0000 | [diff] [blame] | 110 | "This is a long \n explanation") |
Senthil Kumaran | 2688644 | 2013-03-15 07:53:21 -0700 | [diff] [blame] | 111 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 112 | def do_CUSTOM(self): |
| 113 | self.send_response(999) |
| 114 | self.send_header('Content-Type', 'text/html') |
| 115 | self.send_header('Connection', 'close') |
| 116 | self.end_headers() |
| 117 | |
Armin Ronacher | 8d96d77 | 2011-01-22 13:13:05 +0000 | [diff] [blame] | 118 | def do_LATINONEHEADER(self): |
| 119 | self.send_response(999) |
| 120 | self.send_header('X-Special', 'Dängerous Mind') |
Armin Ronacher | 5953128 | 2011-01-22 13:44:22 +0000 | [diff] [blame] | 121 | self.send_header('Connection', 'close') |
Armin Ronacher | 8d96d77 | 2011-01-22 13:13:05 +0000 | [diff] [blame] | 122 | self.end_headers() |
Armin Ronacher | 5953128 | 2011-01-22 13:44:22 +0000 | [diff] [blame] | 123 | body = self.headers['x-special-incoming'].encode('utf-8') |
| 124 | self.wfile.write(body) |
Armin Ronacher | 8d96d77 | 2011-01-22 13:13:05 +0000 | [diff] [blame] | 125 | |
Martin Panter | e42e129 | 2016-06-08 08:29:13 +0000 | [diff] [blame] | 126 | def do_SEND_ERROR(self): |
| 127 | self.send_error(int(self.path[1:])) |
| 128 | |
| 129 | def do_HEAD(self): |
| 130 | self.send_error(int(self.path[1:])) |
| 131 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 132 | def setUp(self): |
| 133 | BaseTestCase.setUp(self) |
Antoine Pitrou | cb34218 | 2011-03-21 00:26:51 +0100 | [diff] [blame] | 134 | self.con = http.client.HTTPConnection(self.HOST, self.PORT) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 135 | self.con.connect() |
| 136 | |
| 137 | def test_command(self): |
| 138 | self.con.request('GET', '/') |
| 139 | res = self.con.getresponse() |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 140 | self.assertEqual(res.status, HTTPStatus.NOT_IMPLEMENTED) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 141 | |
| 142 | def test_request_line_trimming(self): |
| 143 | self.con._http_vsn_str = 'HTTP/1.1\n' |
R David Murray | 14199f9 | 2014-06-24 16:39:49 -0400 | [diff] [blame] | 144 | self.con.putrequest('XYZBOGUS', '/') |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 145 | self.con.endheaders() |
| 146 | res = self.con.getresponse() |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 147 | self.assertEqual(res.status, HTTPStatus.NOT_IMPLEMENTED) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 148 | |
| 149 | def test_version_bogus(self): |
| 150 | self.con._http_vsn_str = 'FUBAR' |
| 151 | self.con.putrequest('GET', '/') |
| 152 | self.con.endheaders() |
| 153 | res = self.con.getresponse() |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 154 | self.assertEqual(res.status, HTTPStatus.BAD_REQUEST) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 155 | |
| 156 | def test_version_digits(self): |
| 157 | self.con._http_vsn_str = 'HTTP/9.9.9' |
| 158 | self.con.putrequest('GET', '/') |
| 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_none_get(self): |
| 164 | self.con._http_vsn_str = '' |
| 165 | self.con.putrequest('GET', '/') |
| 166 | self.con.endheaders() |
| 167 | res = self.con.getresponse() |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 168 | self.assertEqual(res.status, HTTPStatus.NOT_IMPLEMENTED) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 169 | |
| 170 | def test_version_none(self): |
R David Murray | 14199f9 | 2014-06-24 16:39:49 -0400 | [diff] [blame] | 171 | # Test that a valid method is rejected when not HTTP/1.x |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 172 | self.con._http_vsn_str = '' |
R David Murray | 14199f9 | 2014-06-24 16:39:49 -0400 | [diff] [blame] | 173 | self.con.putrequest('CUSTOM', '/') |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 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_version_invalid(self): |
| 179 | self.con._http_vsn = 99 |
| 180 | self.con._http_vsn_str = 'HTTP/9.9' |
| 181 | self.con.putrequest('GET', '/') |
| 182 | self.con.endheaders() |
| 183 | res = self.con.getresponse() |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 184 | self.assertEqual(res.status, HTTPStatus.HTTP_VERSION_NOT_SUPPORTED) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 185 | |
| 186 | def test_send_blank(self): |
| 187 | self.con._http_vsn_str = '' |
| 188 | self.con.putrequest('', '') |
| 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.BAD_REQUEST) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 192 | |
| 193 | def test_header_close(self): |
| 194 | self.con.putrequest('GET', '/') |
| 195 | self.con.putheader('Connection', 'close') |
| 196 | self.con.endheaders() |
| 197 | res = self.con.getresponse() |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 198 | self.assertEqual(res.status, HTTPStatus.NOT_IMPLEMENTED) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 199 | |
Berker Peksag | 2085361 | 2016-08-25 01:13:34 +0300 | [diff] [blame] | 200 | def test_header_keep_alive(self): |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 201 | self.con._http_vsn_str = 'HTTP/1.1' |
| 202 | self.con.putrequest('GET', '/') |
| 203 | self.con.putheader('Connection', 'keep-alive') |
| 204 | self.con.endheaders() |
| 205 | res = self.con.getresponse() |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 206 | self.assertEqual(res.status, HTTPStatus.NOT_IMPLEMENTED) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 207 | |
| 208 | def test_handler(self): |
| 209 | self.con.request('TEST', '/') |
| 210 | res = self.con.getresponse() |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 211 | self.assertEqual(res.status, HTTPStatus.NO_CONTENT) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 212 | |
| 213 | def test_return_header_keep_alive(self): |
| 214 | self.con.request('KEEP', '/') |
| 215 | res = self.con.getresponse() |
Florent Xicluna | 9b86b9a | 2010-03-19 19:00:44 +0000 | [diff] [blame] | 216 | self.assertEqual(res.getheader('Connection'), 'keep-alive') |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 217 | self.con.request('TEST', '/') |
Brian Curtin | 61d0d60 | 2010-10-31 00:34:23 +0000 | [diff] [blame] | 218 | self.addCleanup(self.con.close) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 219 | |
| 220 | def test_internal_key_error(self): |
| 221 | self.con.request('KEYERROR', '/') |
| 222 | res = self.con.getresponse() |
Florent Xicluna | 9b86b9a | 2010-03-19 19:00:44 +0000 | [diff] [blame] | 223 | self.assertEqual(res.status, 999) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 224 | |
| 225 | def test_return_custom_status(self): |
| 226 | self.con.request('CUSTOM', '/') |
| 227 | res = self.con.getresponse() |
Florent Xicluna | 9b86b9a | 2010-03-19 19:00:44 +0000 | [diff] [blame] | 228 | self.assertEqual(res.status, 999) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 229 | |
Senthil Kumaran | 2688644 | 2013-03-15 07:53:21 -0700 | [diff] [blame] | 230 | def test_return_explain_error(self): |
| 231 | self.con.request('EXPLAINERROR', '/') |
| 232 | res = self.con.getresponse() |
| 233 | self.assertEqual(res.status, 999) |
| 234 | self.assertTrue(int(res.getheader('Content-Length'))) |
| 235 | |
Armin Ronacher | 8d96d77 | 2011-01-22 13:13:05 +0000 | [diff] [blame] | 236 | def test_latin1_header(self): |
Armin Ronacher | 5953128 | 2011-01-22 13:44:22 +0000 | [diff] [blame] | 237 | self.con.request('LATINONEHEADER', '/', headers={ |
| 238 | 'X-Special-Incoming': 'Ärger mit Unicode' |
| 239 | }) |
Armin Ronacher | 8d96d77 | 2011-01-22 13:13:05 +0000 | [diff] [blame] | 240 | res = self.con.getresponse() |
| 241 | self.assertEqual(res.getheader('X-Special'), 'Dängerous Mind') |
Armin Ronacher | 5953128 | 2011-01-22 13:44:22 +0000 | [diff] [blame] | 242 | self.assertEqual(res.read(), 'Ärger mit Unicode'.encode('utf-8')) |
Armin Ronacher | 8d96d77 | 2011-01-22 13:13:05 +0000 | [diff] [blame] | 243 | |
Senthil Kumaran | 52d2720 | 2012-10-10 23:16:21 -0700 | [diff] [blame] | 244 | def test_error_content_length(self): |
| 245 | # Issue #16088: standard error responses should have a content-length |
| 246 | self.con.request('NOTFOUND', '/') |
| 247 | res = self.con.getresponse() |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 248 | self.assertEqual(res.status, HTTPStatus.NOT_FOUND) |
| 249 | |
Senthil Kumaran | 52d2720 | 2012-10-10 23:16:21 -0700 | [diff] [blame] | 250 | data = res.read() |
Senthil Kumaran | 52d2720 | 2012-10-10 23:16:21 -0700 | [diff] [blame] | 251 | self.assertEqual(int(res.getheader('Content-Length')), len(data)) |
| 252 | |
Martin Panter | e42e129 | 2016-06-08 08:29:13 +0000 | [diff] [blame] | 253 | def test_send_error(self): |
| 254 | allow_transfer_encoding_codes = (HTTPStatus.NOT_MODIFIED, |
| 255 | HTTPStatus.RESET_CONTENT) |
| 256 | for code in (HTTPStatus.NO_CONTENT, HTTPStatus.NOT_MODIFIED, |
| 257 | HTTPStatus.PROCESSING, HTTPStatus.RESET_CONTENT, |
| 258 | HTTPStatus.SWITCHING_PROTOCOLS): |
| 259 | self.con.request('SEND_ERROR', '/{}'.format(code)) |
| 260 | res = self.con.getresponse() |
| 261 | self.assertEqual(code, res.status) |
| 262 | self.assertEqual(None, res.getheader('Content-Length')) |
| 263 | self.assertEqual(None, res.getheader('Content-Type')) |
| 264 | if code not in allow_transfer_encoding_codes: |
| 265 | self.assertEqual(None, res.getheader('Transfer-Encoding')) |
| 266 | |
| 267 | data = res.read() |
| 268 | self.assertEqual(b'', data) |
| 269 | |
| 270 | def test_head_via_send_error(self): |
| 271 | allow_transfer_encoding_codes = (HTTPStatus.NOT_MODIFIED, |
| 272 | HTTPStatus.RESET_CONTENT) |
| 273 | for code in (HTTPStatus.OK, HTTPStatus.NO_CONTENT, |
| 274 | HTTPStatus.NOT_MODIFIED, HTTPStatus.RESET_CONTENT, |
| 275 | HTTPStatus.SWITCHING_PROTOCOLS): |
| 276 | self.con.request('HEAD', '/{}'.format(code)) |
| 277 | res = self.con.getresponse() |
| 278 | self.assertEqual(code, res.status) |
| 279 | if code == HTTPStatus.OK: |
| 280 | self.assertTrue(int(res.getheader('Content-Length')) > 0) |
| 281 | self.assertIn('text/html', res.getheader('Content-Type')) |
| 282 | else: |
| 283 | self.assertEqual(None, res.getheader('Content-Length')) |
| 284 | self.assertEqual(None, res.getheader('Content-Type')) |
| 285 | if code not in allow_transfer_encoding_codes: |
| 286 | self.assertEqual(None, res.getheader('Transfer-Encoding')) |
| 287 | |
| 288 | data = res.read() |
| 289 | self.assertEqual(b'', data) |
| 290 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 291 | |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 292 | class RequestHandlerLoggingTestCase(BaseTestCase): |
| 293 | class request_handler(BaseHTTPRequestHandler): |
| 294 | protocol_version = 'HTTP/1.1' |
| 295 | default_request_version = 'HTTP/1.1' |
| 296 | |
| 297 | def do_GET(self): |
| 298 | self.send_response(HTTPStatus.OK) |
| 299 | self.end_headers() |
| 300 | |
| 301 | def do_ERROR(self): |
| 302 | self.send_error(HTTPStatus.NOT_FOUND, 'File not found') |
| 303 | |
| 304 | def test_get(self): |
| 305 | self.con = http.client.HTTPConnection(self.HOST, self.PORT) |
| 306 | self.con.connect() |
| 307 | |
| 308 | with support.captured_stderr() as err: |
| 309 | self.con.request('GET', '/') |
| 310 | self.con.getresponse() |
| 311 | |
| 312 | self.assertTrue( |
| 313 | err.getvalue().endswith('"GET / HTTP/1.1" 200 -\n')) |
| 314 | |
| 315 | def test_err(self): |
| 316 | self.con = http.client.HTTPConnection(self.HOST, self.PORT) |
| 317 | self.con.connect() |
| 318 | |
| 319 | with support.captured_stderr() as err: |
| 320 | self.con.request('ERROR', '/') |
| 321 | self.con.getresponse() |
| 322 | |
| 323 | lines = err.getvalue().split('\n') |
| 324 | self.assertTrue(lines[0].endswith('code 404, message File not found')) |
| 325 | self.assertTrue(lines[1].endswith('"ERROR / HTTP/1.1" 404 -')) |
| 326 | |
| 327 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 328 | class SimpleHTTPServerTestCase(BaseTestCase): |
| 329 | class request_handler(NoLogRequestHandler, SimpleHTTPRequestHandler): |
| 330 | pass |
| 331 | |
| 332 | def setUp(self): |
| 333 | BaseTestCase.setUp(self) |
| 334 | self.cwd = os.getcwd() |
| 335 | basetempdir = tempfile.gettempdir() |
| 336 | os.chdir(basetempdir) |
| 337 | self.data = b'We are the knights who say Ni!' |
| 338 | self.tempdir = tempfile.mkdtemp(dir=basetempdir) |
| 339 | self.tempdir_name = os.path.basename(self.tempdir) |
Martin Panter | fc475a9 | 2016-04-09 04:56:10 +0000 | [diff] [blame] | 340 | self.base_url = '/' + self.tempdir_name |
Victor Stinner | 28ce07a | 2017-07-28 18:15:02 +0200 | [diff] [blame] | 341 | tempname = os.path.join(self.tempdir, 'test') |
| 342 | with open(tempname, 'wb') as temp: |
Brett Cannon | 105df5d | 2010-10-29 23:43:42 +0000 | [diff] [blame] | 343 | temp.write(self.data) |
Victor Stinner | 28ce07a | 2017-07-28 18:15:02 +0200 | [diff] [blame] | 344 | temp.flush() |
| 345 | mtime = os.stat(tempname).st_mtime |
Pierre Quentel | 351adda | 2017-04-02 12:26:12 +0200 | [diff] [blame] | 346 | # compute last modification datetime for browser cache tests |
| 347 | last_modif = datetime.datetime.fromtimestamp(mtime, |
| 348 | datetime.timezone.utc) |
| 349 | self.last_modif_datetime = last_modif.replace(microsecond=0) |
| 350 | self.last_modif_header = email.utils.formatdate( |
| 351 | last_modif.timestamp(), usegmt=True) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 352 | |
| 353 | def tearDown(self): |
| 354 | try: |
| 355 | os.chdir(self.cwd) |
| 356 | try: |
| 357 | shutil.rmtree(self.tempdir) |
| 358 | except: |
| 359 | pass |
| 360 | finally: |
| 361 | BaseTestCase.tearDown(self) |
| 362 | |
| 363 | def check_status_and_reason(self, response, status, data=None): |
Berker Peksag | b575432 | 2015-07-22 19:25:37 +0300 | [diff] [blame] | 364 | def close_conn(): |
| 365 | """Don't close reader yet so we can check if there was leftover |
| 366 | buffered input""" |
| 367 | nonlocal reader |
| 368 | reader = response.fp |
| 369 | response.fp = None |
| 370 | reader = None |
| 371 | response._close_conn = close_conn |
| 372 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 373 | body = response.read() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 374 | self.assertTrue(response) |
Florent Xicluna | 9b86b9a | 2010-03-19 19:00:44 +0000 | [diff] [blame] | 375 | self.assertEqual(response.status, status) |
| 376 | self.assertIsNotNone(response.reason) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 377 | if data: |
| 378 | self.assertEqual(data, body) |
Berker Peksag | b575432 | 2015-07-22 19:25:37 +0300 | [diff] [blame] | 379 | # Ensure the server has not set up a persistent connection, and has |
| 380 | # not sent any extra data |
| 381 | self.assertEqual(response.version, 10) |
| 382 | self.assertEqual(response.msg.get("Connection", "close"), "close") |
| 383 | self.assertEqual(reader.read(30), b'', 'Connection should be closed') |
| 384 | |
| 385 | reader.close() |
Serhiy Storchaka | cb5bc40 | 2014-08-17 08:22:11 +0300 | [diff] [blame] | 386 | return body |
| 387 | |
Ned Deily | b3edde8 | 2017-12-04 23:42:02 -0500 | [diff] [blame] | 388 | @unittest.skipIf(sys.platform == 'darwin', |
| 389 | 'undecodable name cannot always be decoded on macOS') |
Steve Dower | e58571b | 2016-09-08 11:11:13 -0700 | [diff] [blame] | 390 | @unittest.skipIf(sys.platform == 'win32', |
| 391 | 'undecodable name cannot be decoded on win32') |
Serhiy Storchaka | cb5bc40 | 2014-08-17 08:22:11 +0300 | [diff] [blame] | 392 | @unittest.skipUnless(support.TESTFN_UNDECODABLE, |
| 393 | 'need support.TESTFN_UNDECODABLE') |
| 394 | def test_undecodable_filename(self): |
Serhiy Storchaka | a64ce5d | 2014-08-17 12:20:02 +0300 | [diff] [blame] | 395 | enc = sys.getfilesystemencoding() |
Serhiy Storchaka | cb5bc40 | 2014-08-17 08:22:11 +0300 | [diff] [blame] | 396 | filename = os.fsdecode(support.TESTFN_UNDECODABLE) + '.txt' |
| 397 | with open(os.path.join(self.tempdir, filename), 'wb') as f: |
| 398 | f.write(support.TESTFN_UNDECODABLE) |
Martin Panter | fc475a9 | 2016-04-09 04:56:10 +0000 | [diff] [blame] | 399 | response = self.request(self.base_url + '/') |
Serhiy Storchaka | d9e9528 | 2014-08-17 16:57:39 +0300 | [diff] [blame] | 400 | if sys.platform == 'darwin': |
| 401 | # On Mac OS the HFS+ filesystem replaces bytes that aren't valid |
| 402 | # UTF-8 into a percent-encoded value. |
| 403 | for name in os.listdir(self.tempdir): |
| 404 | if name != 'test': # Ignore a filename created in setUp(). |
| 405 | filename = name |
| 406 | break |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 407 | body = self.check_status_and_reason(response, HTTPStatus.OK) |
Serhiy Storchaka | cb5bc40 | 2014-08-17 08:22:11 +0300 | [diff] [blame] | 408 | quotedname = urllib.parse.quote(filename, errors='surrogatepass') |
| 409 | self.assertIn(('href="%s"' % quotedname) |
Serhiy Storchaka | a64ce5d | 2014-08-17 12:20:02 +0300 | [diff] [blame] | 410 | .encode(enc, 'surrogateescape'), body) |
Martin Panter | da3bb38 | 2016-04-11 00:40:08 +0000 | [diff] [blame] | 411 | self.assertIn(('>%s<' % html.escape(filename, quote=False)) |
Serhiy Storchaka | a64ce5d | 2014-08-17 12:20:02 +0300 | [diff] [blame] | 412 | .encode(enc, 'surrogateescape'), body) |
Martin Panter | fc475a9 | 2016-04-09 04:56:10 +0000 | [diff] [blame] | 413 | response = self.request(self.base_url + '/' + quotedname) |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 414 | self.check_status_and_reason(response, HTTPStatus.OK, |
Serhiy Storchaka | cb5bc40 | 2014-08-17 08:22:11 +0300 | [diff] [blame] | 415 | data=support.TESTFN_UNDECODABLE) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 416 | |
| 417 | def test_get(self): |
| 418 | #constructs the path relative to the root directory of the HTTPServer |
Martin Panter | fc475a9 | 2016-04-09 04:56:10 +0000 | [diff] [blame] | 419 | response = self.request(self.base_url + '/test') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 420 | self.check_status_and_reason(response, HTTPStatus.OK, data=self.data) |
Senthil Kumaran | 72c238e | 2013-09-13 00:21:18 -0700 | [diff] [blame] | 421 | # check for trailing "/" which should return 404. See Issue17324 |
Martin Panter | fc475a9 | 2016-04-09 04:56:10 +0000 | [diff] [blame] | 422 | response = self.request(self.base_url + '/test/') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 423 | self.check_status_and_reason(response, HTTPStatus.NOT_FOUND) |
Martin Panter | fc475a9 | 2016-04-09 04:56:10 +0000 | [diff] [blame] | 424 | response = self.request(self.base_url + '/') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 425 | self.check_status_and_reason(response, HTTPStatus.OK) |
Martin Panter | fc475a9 | 2016-04-09 04:56:10 +0000 | [diff] [blame] | 426 | response = self.request(self.base_url) |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 427 | self.check_status_and_reason(response, HTTPStatus.MOVED_PERMANENTLY) |
Martin Panter | fc475a9 | 2016-04-09 04:56:10 +0000 | [diff] [blame] | 428 | response = self.request(self.base_url + '/?hi=2') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 429 | self.check_status_and_reason(response, HTTPStatus.OK) |
Martin Panter | fc475a9 | 2016-04-09 04:56:10 +0000 | [diff] [blame] | 430 | response = self.request(self.base_url + '?hi=1') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 431 | self.check_status_and_reason(response, HTTPStatus.MOVED_PERMANENTLY) |
Benjamin Peterson | 94cb7a2 | 2014-12-26 10:53:43 -0600 | [diff] [blame] | 432 | self.assertEqual(response.getheader("Location"), |
Martin Panter | fc475a9 | 2016-04-09 04:56:10 +0000 | [diff] [blame] | 433 | self.base_url + "/?hi=1") |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 434 | response = self.request('/ThisDoesNotExist') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 435 | self.check_status_and_reason(response, HTTPStatus.NOT_FOUND) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 436 | response = self.request('/' + 'ThisDoesNotExist' + '/') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 437 | self.check_status_and_reason(response, HTTPStatus.NOT_FOUND) |
Berker Peksag | b575432 | 2015-07-22 19:25:37 +0300 | [diff] [blame] | 438 | |
| 439 | data = b"Dummy index file\r\n" |
| 440 | with open(os.path.join(self.tempdir_name, 'index.html'), 'wb') as f: |
| 441 | f.write(data) |
Martin Panter | fc475a9 | 2016-04-09 04:56:10 +0000 | [diff] [blame] | 442 | response = self.request(self.base_url + '/') |
Berker Peksag | b575432 | 2015-07-22 19:25:37 +0300 | [diff] [blame] | 443 | self.check_status_and_reason(response, HTTPStatus.OK, data) |
| 444 | |
| 445 | # chmod() doesn't work as expected on Windows, and filesystem |
| 446 | # permissions are ignored by root on Unix. |
| 447 | if os.name == 'posix' and os.geteuid() != 0: |
| 448 | os.chmod(self.tempdir, 0) |
| 449 | try: |
Martin Panter | fc475a9 | 2016-04-09 04:56:10 +0000 | [diff] [blame] | 450 | response = self.request(self.base_url + '/') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 451 | self.check_status_and_reason(response, HTTPStatus.NOT_FOUND) |
Berker Peksag | b575432 | 2015-07-22 19:25:37 +0300 | [diff] [blame] | 452 | finally: |
Brett Cannon | 105df5d | 2010-10-29 23:43:42 +0000 | [diff] [blame] | 453 | os.chmod(self.tempdir, 0o755) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 454 | |
| 455 | def test_head(self): |
| 456 | response = self.request( |
Martin Panter | fc475a9 | 2016-04-09 04:56:10 +0000 | [diff] [blame] | 457 | self.base_url + '/test', method='HEAD') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 458 | self.check_status_and_reason(response, HTTPStatus.OK) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 459 | self.assertEqual(response.getheader('content-length'), |
| 460 | str(len(self.data))) |
| 461 | self.assertEqual(response.getheader('content-type'), |
| 462 | 'application/octet-stream') |
| 463 | |
Pierre Quentel | 351adda | 2017-04-02 12:26:12 +0200 | [diff] [blame] | 464 | def test_browser_cache(self): |
| 465 | """Check that when a request to /test is sent with the request header |
| 466 | If-Modified-Since set to date of last modification, the server returns |
| 467 | status code 304, not 200 |
| 468 | """ |
| 469 | headers = email.message.Message() |
| 470 | headers['If-Modified-Since'] = self.last_modif_header |
| 471 | response = self.request(self.base_url + '/test', headers=headers) |
| 472 | self.check_status_and_reason(response, HTTPStatus.NOT_MODIFIED) |
| 473 | |
| 474 | # one hour after last modification : must return 304 |
| 475 | new_dt = self.last_modif_datetime + datetime.timedelta(hours=1) |
| 476 | headers = email.message.Message() |
| 477 | headers['If-Modified-Since'] = email.utils.format_datetime(new_dt, |
| 478 | usegmt=True) |
| 479 | response = self.request(self.base_url + '/test', headers=headers) |
Victor Stinner | 28ce07a | 2017-07-28 18:15:02 +0200 | [diff] [blame] | 480 | self.check_status_and_reason(response, HTTPStatus.NOT_MODIFIED) |
Pierre Quentel | 351adda | 2017-04-02 12:26:12 +0200 | [diff] [blame] | 481 | |
| 482 | def test_browser_cache_file_changed(self): |
| 483 | # with If-Modified-Since earlier than Last-Modified, must return 200 |
| 484 | dt = self.last_modif_datetime |
| 485 | # build datetime object : 365 days before last modification |
| 486 | old_dt = dt - datetime.timedelta(days=365) |
| 487 | headers = email.message.Message() |
| 488 | headers['If-Modified-Since'] = email.utils.format_datetime(old_dt, |
| 489 | usegmt=True) |
| 490 | response = self.request(self.base_url + '/test', headers=headers) |
| 491 | self.check_status_and_reason(response, HTTPStatus.OK) |
| 492 | |
| 493 | def test_browser_cache_with_If_None_Match_header(self): |
| 494 | # if If-None-Match header is present, ignore If-Modified-Since |
| 495 | |
| 496 | headers = email.message.Message() |
| 497 | headers['If-Modified-Since'] = self.last_modif_header |
| 498 | headers['If-None-Match'] = "*" |
| 499 | response = self.request(self.base_url + '/test', headers=headers) |
Victor Stinner | 28ce07a | 2017-07-28 18:15:02 +0200 | [diff] [blame] | 500 | self.check_status_and_reason(response, HTTPStatus.OK) |
Pierre Quentel | 351adda | 2017-04-02 12:26:12 +0200 | [diff] [blame] | 501 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 502 | def test_invalid_requests(self): |
| 503 | response = self.request('/', method='FOO') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 504 | self.check_status_and_reason(response, HTTPStatus.NOT_IMPLEMENTED) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 505 | # requests must be case sensitive,so this should fail too |
Terry Jan Reedy | dd09efd | 2014-10-18 17:10:09 -0400 | [diff] [blame] | 506 | response = self.request('/', method='custom') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 507 | self.check_status_and_reason(response, HTTPStatus.NOT_IMPLEMENTED) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 508 | response = self.request('/', method='GETs') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 509 | self.check_status_and_reason(response, HTTPStatus.NOT_IMPLEMENTED) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 510 | |
Pierre Quentel | 351adda | 2017-04-02 12:26:12 +0200 | [diff] [blame] | 511 | def test_last_modified(self): |
| 512 | """Checks that the datetime returned in Last-Modified response header |
| 513 | is the actual datetime of last modification, rounded to the second |
| 514 | """ |
| 515 | response = self.request(self.base_url + '/test') |
| 516 | self.check_status_and_reason(response, HTTPStatus.OK, data=self.data) |
| 517 | last_modif_header = response.headers['Last-modified'] |
| 518 | self.assertEqual(last_modif_header, self.last_modif_header) |
| 519 | |
Martin Panter | fc475a9 | 2016-04-09 04:56:10 +0000 | [diff] [blame] | 520 | def test_path_without_leading_slash(self): |
| 521 | response = self.request(self.tempdir_name + '/test') |
| 522 | self.check_status_and_reason(response, HTTPStatus.OK, data=self.data) |
| 523 | response = self.request(self.tempdir_name + '/test/') |
| 524 | self.check_status_and_reason(response, HTTPStatus.NOT_FOUND) |
| 525 | response = self.request(self.tempdir_name + '/') |
| 526 | self.check_status_and_reason(response, HTTPStatus.OK) |
| 527 | response = self.request(self.tempdir_name) |
| 528 | self.check_status_and_reason(response, HTTPStatus.MOVED_PERMANENTLY) |
| 529 | response = self.request(self.tempdir_name + '/?hi=2') |
| 530 | self.check_status_and_reason(response, HTTPStatus.OK) |
| 531 | response = self.request(self.tempdir_name + '?hi=1') |
| 532 | self.check_status_and_reason(response, HTTPStatus.MOVED_PERMANENTLY) |
| 533 | self.assertEqual(response.getheader("Location"), |
| 534 | self.tempdir_name + "/?hi=1") |
| 535 | |
Martin Panter | da3bb38 | 2016-04-11 00:40:08 +0000 | [diff] [blame] | 536 | def test_html_escape_filename(self): |
| 537 | filename = '<test&>.txt' |
| 538 | fullpath = os.path.join(self.tempdir, filename) |
| 539 | |
| 540 | try: |
| 541 | open(fullpath, 'w').close() |
| 542 | except OSError: |
| 543 | raise unittest.SkipTest('Can not create file %s on current file ' |
| 544 | 'system' % filename) |
| 545 | |
| 546 | try: |
| 547 | response = self.request(self.base_url + '/') |
| 548 | body = self.check_status_and_reason(response, HTTPStatus.OK) |
| 549 | enc = response.headers.get_content_charset() |
| 550 | finally: |
| 551 | os.unlink(fullpath) # avoid affecting test_undecodable_filename |
| 552 | |
| 553 | self.assertIsNotNone(enc) |
| 554 | html_text = '>%s<' % html.escape(filename, quote=False) |
| 555 | self.assertIn(html_text.encode(enc), body) |
| 556 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 557 | |
| 558 | cgi_file1 = """\ |
| 559 | #!%s |
| 560 | |
| 561 | print("Content-type: text/html") |
| 562 | print() |
| 563 | print("Hello World") |
| 564 | """ |
| 565 | |
| 566 | cgi_file2 = """\ |
| 567 | #!%s |
| 568 | import cgi |
| 569 | |
| 570 | print("Content-type: text/html") |
| 571 | print() |
| 572 | |
| 573 | form = cgi.FieldStorage() |
Florent Xicluna | 9b86b9a | 2010-03-19 19:00:44 +0000 | [diff] [blame] | 574 | print("%%s, %%s, %%s" %% (form.getfirst("spam"), form.getfirst("eggs"), |
| 575 | form.getfirst("bacon"))) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 576 | """ |
| 577 | |
Martin Panter | a02e18a | 2015-10-03 05:38:07 +0000 | [diff] [blame] | 578 | cgi_file4 = """\ |
| 579 | #!%s |
| 580 | import os |
| 581 | |
| 582 | print("Content-type: text/html") |
| 583 | print() |
| 584 | |
| 585 | print(os.environ["%s"]) |
| 586 | """ |
| 587 | |
Charles-François Natali | f7ed9fc | 2011-11-02 19:35:14 +0100 | [diff] [blame] | 588 | |
| 589 | @unittest.skipIf(hasattr(os, 'geteuid') and os.geteuid() == 0, |
| 590 | "This test can't be run reliably as root (issue #13308).") |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 591 | class CGIHTTPServerTestCase(BaseTestCase): |
| 592 | class request_handler(NoLogRequestHandler, CGIHTTPRequestHandler): |
| 593 | pass |
| 594 | |
Antoine Pitrou | e768c39 | 2012-08-05 14:52:45 +0200 | [diff] [blame] | 595 | linesep = os.linesep.encode('ascii') |
| 596 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 597 | def setUp(self): |
| 598 | BaseTestCase.setUp(self) |
Victor Stinner | 0b0ca0c | 2010-10-17 19:46:36 +0000 | [diff] [blame] | 599 | self.cwd = os.getcwd() |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 600 | self.parent_dir = tempfile.mkdtemp() |
| 601 | self.cgi_dir = os.path.join(self.parent_dir, 'cgi-bin') |
Ned Deily | 915a30f | 2014-07-12 22:06:26 -0700 | [diff] [blame] | 602 | self.cgi_child_dir = os.path.join(self.cgi_dir, 'child-dir') |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 603 | os.mkdir(self.cgi_dir) |
Ned Deily | 915a30f | 2014-07-12 22:06:26 -0700 | [diff] [blame] | 604 | os.mkdir(self.cgi_child_dir) |
Benjamin Peterson | 35aca89 | 2013-10-30 12:48:59 -0400 | [diff] [blame] | 605 | self.nocgi_path = None |
Victor Stinner | 0b0ca0c | 2010-10-17 19:46:36 +0000 | [diff] [blame] | 606 | self.file1_path = None |
| 607 | self.file2_path = None |
Ned Deily | 915a30f | 2014-07-12 22:06:26 -0700 | [diff] [blame] | 608 | self.file3_path = None |
Martin Panter | a02e18a | 2015-10-03 05:38:07 +0000 | [diff] [blame] | 609 | self.file4_path = None |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 610 | |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 611 | # The shebang line should be pure ASCII: use symlink if possible. |
| 612 | # See issue #7668. |
Steve Dower | 323e743 | 2019-06-29 14:28:59 -0700 | [diff] [blame] | 613 | self._pythonexe_symlink = None |
Brian Curtin | 3b4499c | 2010-12-28 14:31:47 +0000 | [diff] [blame] | 614 | if support.can_symlink(): |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 615 | self.pythonexe = os.path.join(self.parent_dir, 'python') |
Steve Dower | 323e743 | 2019-06-29 14:28:59 -0700 | [diff] [blame] | 616 | self._pythonexe_symlink = support.PythonSymlink(self.pythonexe).__enter__() |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 617 | else: |
| 618 | self.pythonexe = sys.executable |
| 619 | |
Victor Stinner | 3218c31 | 2010-10-17 20:13:36 +0000 | [diff] [blame] | 620 | try: |
| 621 | # The python executable path is written as the first line of the |
| 622 | # CGI Python script. The encoding cookie cannot be used, and so the |
| 623 | # path should be encodable to the default script encoding (utf-8) |
| 624 | self.pythonexe.encode('utf-8') |
| 625 | except UnicodeEncodeError: |
| 626 | self.tearDown() |
Serhiy Storchaka | 0b4591e | 2013-02-04 15:45:00 +0200 | [diff] [blame] | 627 | self.skipTest("Python executable path is not encodable to utf-8") |
Victor Stinner | 3218c31 | 2010-10-17 20:13:36 +0000 | [diff] [blame] | 628 | |
Benjamin Peterson | 04e9de4 | 2013-10-30 12:43:09 -0400 | [diff] [blame] | 629 | self.nocgi_path = os.path.join(self.parent_dir, 'nocgi.py') |
| 630 | with open(self.nocgi_path, 'w') as fp: |
| 631 | fp.write(cgi_file1 % self.pythonexe) |
| 632 | os.chmod(self.nocgi_path, 0o777) |
| 633 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 634 | self.file1_path = os.path.join(self.cgi_dir, 'file1.py') |
Victor Stinner | 6fb4575 | 2010-10-17 20:17:41 +0000 | [diff] [blame] | 635 | with open(self.file1_path, 'w', encoding='utf-8') as file1: |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 636 | file1.write(cgi_file1 % self.pythonexe) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 637 | os.chmod(self.file1_path, 0o777) |
| 638 | |
| 639 | self.file2_path = os.path.join(self.cgi_dir, 'file2.py') |
Victor Stinner | 6fb4575 | 2010-10-17 20:17:41 +0000 | [diff] [blame] | 640 | with open(self.file2_path, 'w', encoding='utf-8') as file2: |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 641 | file2.write(cgi_file2 % self.pythonexe) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 642 | os.chmod(self.file2_path, 0o777) |
| 643 | |
Ned Deily | 915a30f | 2014-07-12 22:06:26 -0700 | [diff] [blame] | 644 | self.file3_path = os.path.join(self.cgi_child_dir, 'file3.py') |
| 645 | with open(self.file3_path, 'w', encoding='utf-8') as file3: |
| 646 | file3.write(cgi_file1 % self.pythonexe) |
| 647 | os.chmod(self.file3_path, 0o777) |
| 648 | |
Martin Panter | a02e18a | 2015-10-03 05:38:07 +0000 | [diff] [blame] | 649 | self.file4_path = os.path.join(self.cgi_dir, 'file4.py') |
| 650 | with open(self.file4_path, 'w', encoding='utf-8') as file4: |
| 651 | file4.write(cgi_file4 % (self.pythonexe, 'QUERY_STRING')) |
| 652 | os.chmod(self.file4_path, 0o777) |
| 653 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 654 | os.chdir(self.parent_dir) |
| 655 | |
| 656 | def tearDown(self): |
| 657 | try: |
| 658 | os.chdir(self.cwd) |
Steve Dower | 323e743 | 2019-06-29 14:28:59 -0700 | [diff] [blame] | 659 | if self._pythonexe_symlink: |
| 660 | self._pythonexe_symlink.__exit__(None, None, None) |
Benjamin Peterson | 35aca89 | 2013-10-30 12:48:59 -0400 | [diff] [blame] | 661 | if self.nocgi_path: |
| 662 | os.remove(self.nocgi_path) |
Victor Stinner | 0b0ca0c | 2010-10-17 19:46:36 +0000 | [diff] [blame] | 663 | if self.file1_path: |
| 664 | os.remove(self.file1_path) |
| 665 | if self.file2_path: |
| 666 | os.remove(self.file2_path) |
Ned Deily | 915a30f | 2014-07-12 22:06:26 -0700 | [diff] [blame] | 667 | if self.file3_path: |
| 668 | os.remove(self.file3_path) |
Martin Panter | a02e18a | 2015-10-03 05:38:07 +0000 | [diff] [blame] | 669 | if self.file4_path: |
| 670 | os.remove(self.file4_path) |
Ned Deily | 915a30f | 2014-07-12 22:06:26 -0700 | [diff] [blame] | 671 | os.rmdir(self.cgi_child_dir) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 672 | os.rmdir(self.cgi_dir) |
| 673 | os.rmdir(self.parent_dir) |
| 674 | finally: |
| 675 | BaseTestCase.tearDown(self) |
| 676 | |
Senthil Kumaran | d70846b | 2012-04-12 02:34:32 +0800 | [diff] [blame] | 677 | def test_url_collapse_path(self): |
| 678 | # 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] | 679 | test_vectors = { |
Senthil Kumaran | d70846b | 2012-04-12 02:34:32 +0800 | [diff] [blame] | 680 | '': '//', |
Benjamin Peterson | ad71f0f | 2009-04-11 20:12:10 +0000 | [diff] [blame] | 681 | '..': IndexError, |
| 682 | '/.//..': IndexError, |
Senthil Kumaran | d70846b | 2012-04-12 02:34:32 +0800 | [diff] [blame] | 683 | '/': '//', |
| 684 | '//': '//', |
| 685 | '/\\': '//\\', |
| 686 | '/.//': '//', |
| 687 | 'cgi-bin/file1.py': '/cgi-bin/file1.py', |
| 688 | '/cgi-bin/file1.py': '/cgi-bin/file1.py', |
| 689 | 'a': '//a', |
| 690 | '/a': '//a', |
| 691 | '//a': '//a', |
| 692 | './a': '//a', |
| 693 | './C:/': '/C:/', |
| 694 | '/a/b': '/a/b', |
| 695 | '/a/b/': '/a/b/', |
| 696 | '/a/b/.': '/a/b/', |
| 697 | '/a/b/c/..': '/a/b/', |
| 698 | '/a/b/c/../d': '/a/b/d', |
| 699 | '/a/b/c/../d/e/../f': '/a/b/d/f', |
| 700 | '/a/b/c/../d/e/../../f': '/a/b/f', |
| 701 | '/a/b/c/../d/e/.././././..//f': '/a/b/f', |
Benjamin Peterson | ad71f0f | 2009-04-11 20:12:10 +0000 | [diff] [blame] | 702 | '../a/b/c/../d/e/.././././..//f': IndexError, |
Senthil Kumaran | d70846b | 2012-04-12 02:34:32 +0800 | [diff] [blame] | 703 | '/a/b/c/../d/e/../../../f': '/a/f', |
| 704 | '/a/b/c/../d/e/../../../../f': '//f', |
Benjamin Peterson | ad71f0f | 2009-04-11 20:12:10 +0000 | [diff] [blame] | 705 | '/a/b/c/../d/e/../../../../../f': IndexError, |
Senthil Kumaran | d70846b | 2012-04-12 02:34:32 +0800 | [diff] [blame] | 706 | '/a/b/c/../d/e/../../../../f/..': '//', |
| 707 | '/a/b/c/../d/e/../../../../f/../.': '//', |
Benjamin Peterson | ad71f0f | 2009-04-11 20:12:10 +0000 | [diff] [blame] | 708 | } |
| 709 | for path, expected in test_vectors.items(): |
| 710 | if isinstance(expected, type) and issubclass(expected, Exception): |
| 711 | self.assertRaises(expected, |
Senthil Kumaran | d70846b | 2012-04-12 02:34:32 +0800 | [diff] [blame] | 712 | server._url_collapse_path, path) |
Benjamin Peterson | ad71f0f | 2009-04-11 20:12:10 +0000 | [diff] [blame] | 713 | else: |
Senthil Kumaran | d70846b | 2012-04-12 02:34:32 +0800 | [diff] [blame] | 714 | actual = server._url_collapse_path(path) |
Florent Xicluna | 9b86b9a | 2010-03-19 19:00:44 +0000 | [diff] [blame] | 715 | self.assertEqual(expected, actual, |
| 716 | msg='path = %r\nGot: %r\nWanted: %r' % |
| 717 | (path, actual, expected)) |
Benjamin Peterson | ad71f0f | 2009-04-11 20:12:10 +0000 | [diff] [blame] | 718 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 719 | def test_headers_and_content(self): |
| 720 | res = self.request('/cgi-bin/file1.py') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 721 | self.assertEqual( |
| 722 | (res.read(), res.getheader('Content-type'), res.status), |
| 723 | (b'Hello World' + self.linesep, 'text/html', HTTPStatus.OK)) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 724 | |
Benjamin Peterson | 04e9de4 | 2013-10-30 12:43:09 -0400 | [diff] [blame] | 725 | def test_issue19435(self): |
| 726 | res = self.request('///////////nocgi.py/../cgi-bin/nothere.sh') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 727 | self.assertEqual(res.status, HTTPStatus.NOT_FOUND) |
Benjamin Peterson | 04e9de4 | 2013-10-30 12:43:09 -0400 | [diff] [blame] | 728 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 729 | def test_post(self): |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 730 | params = urllib.parse.urlencode( |
| 731 | {'spam' : 1, 'eggs' : 'python', 'bacon' : 123456}) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 732 | headers = {'Content-type' : 'application/x-www-form-urlencoded'} |
| 733 | res = self.request('/cgi-bin/file2.py', 'POST', params, headers) |
| 734 | |
Antoine Pitrou | e768c39 | 2012-08-05 14:52:45 +0200 | [diff] [blame] | 735 | self.assertEqual(res.read(), b'1, python, 123456' + self.linesep) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 736 | |
| 737 | def test_invaliduri(self): |
| 738 | res = self.request('/cgi-bin/invalid') |
| 739 | res.read() |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 740 | self.assertEqual(res.status, HTTPStatus.NOT_FOUND) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 741 | |
| 742 | def test_authorization(self): |
| 743 | headers = {b'Authorization' : b'Basic ' + |
| 744 | base64.b64encode(b'username:pass')} |
| 745 | res = self.request('/cgi-bin/file1.py', 'GET', headers=headers) |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 746 | self.assertEqual( |
| 747 | (b'Hello World' + self.linesep, 'text/html', HTTPStatus.OK), |
| 748 | (res.read(), res.getheader('Content-type'), res.status)) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 749 | |
Benjamin Peterson | ad71f0f | 2009-04-11 20:12:10 +0000 | [diff] [blame] | 750 | def test_no_leading_slash(self): |
| 751 | # http://bugs.python.org/issue2254 |
| 752 | res = self.request('cgi-bin/file1.py') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 753 | self.assertEqual( |
| 754 | (b'Hello World' + self.linesep, 'text/html', HTTPStatus.OK), |
| 755 | (res.read(), res.getheader('Content-type'), res.status)) |
Benjamin Peterson | ad71f0f | 2009-04-11 20:12:10 +0000 | [diff] [blame] | 756 | |
Senthil Kumaran | 4271372 | 2010-10-03 17:55:45 +0000 | [diff] [blame] | 757 | def test_os_environ_is_not_altered(self): |
| 758 | signature = "Test CGI Server" |
| 759 | os.environ['SERVER_SOFTWARE'] = signature |
| 760 | res = self.request('/cgi-bin/file1.py') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 761 | self.assertEqual( |
| 762 | (b'Hello World' + self.linesep, 'text/html', HTTPStatus.OK), |
| 763 | (res.read(), res.getheader('Content-type'), res.status)) |
Senthil Kumaran | 4271372 | 2010-10-03 17:55:45 +0000 | [diff] [blame] | 764 | self.assertEqual(os.environ['SERVER_SOFTWARE'], signature) |
| 765 | |
Benjamin Peterson | 73b8b1c | 2014-06-14 18:36:29 -0700 | [diff] [blame] | 766 | def test_urlquote_decoding_in_cgi_check(self): |
| 767 | res = self.request('/cgi-bin%2ffile1.py') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 768 | self.assertEqual( |
| 769 | (b'Hello World' + self.linesep, 'text/html', HTTPStatus.OK), |
| 770 | (res.read(), res.getheader('Content-type'), res.status)) |
Benjamin Peterson | 73b8b1c | 2014-06-14 18:36:29 -0700 | [diff] [blame] | 771 | |
Ned Deily | 915a30f | 2014-07-12 22:06:26 -0700 | [diff] [blame] | 772 | def test_nested_cgi_path_issue21323(self): |
| 773 | res = self.request('/cgi-bin/child-dir/file3.py') |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 774 | self.assertEqual( |
| 775 | (b'Hello World' + self.linesep, 'text/html', HTTPStatus.OK), |
| 776 | (res.read(), res.getheader('Content-type'), res.status)) |
Ned Deily | 915a30f | 2014-07-12 22:06:26 -0700 | [diff] [blame] | 777 | |
Martin Panter | a02e18a | 2015-10-03 05:38:07 +0000 | [diff] [blame] | 778 | def test_query_with_multiple_question_mark(self): |
| 779 | res = self.request('/cgi-bin/file4.py?a=b?c=d') |
| 780 | self.assertEqual( |
Martin Panter | eb1fee9 | 2015-10-03 06:07:22 +0000 | [diff] [blame] | 781 | (b'a=b?c=d' + self.linesep, 'text/html', HTTPStatus.OK), |
Martin Panter | a02e18a | 2015-10-03 05:38:07 +0000 | [diff] [blame] | 782 | (res.read(), res.getheader('Content-type'), res.status)) |
| 783 | |
Martin Panter | cb29e8c | 2015-10-03 05:55:46 +0000 | [diff] [blame] | 784 | def test_query_with_continuous_slashes(self): |
| 785 | res = self.request('/cgi-bin/file4.py?k=aa%2F%2Fbb&//q//p//=//a//b//') |
| 786 | self.assertEqual( |
| 787 | (b'k=aa%2F%2Fbb&//q//p//=//a//b//' + self.linesep, |
Martin Panter | eb1fee9 | 2015-10-03 06:07:22 +0000 | [diff] [blame] | 788 | 'text/html', HTTPStatus.OK), |
Martin Panter | cb29e8c | 2015-10-03 05:55:46 +0000 | [diff] [blame] | 789 | (res.read(), res.getheader('Content-type'), res.status)) |
| 790 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 791 | |
Georg Brandl | 6fcac0d | 2010-08-02 18:56:54 +0000 | [diff] [blame] | 792 | class SocketlessRequestHandler(SimpleHTTPRequestHandler): |
Stéphane Wirtel | a17a2f5 | 2017-05-24 09:29:06 +0200 | [diff] [blame] | 793 | def __init__(self, *args, **kwargs): |
| 794 | request = mock.Mock() |
| 795 | request.makefile.return_value = BytesIO() |
| 796 | super().__init__(request, None, None) |
| 797 | |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 798 | self.get_called = False |
| 799 | self.protocol_version = "HTTP/1.1" |
| 800 | |
| 801 | def do_GET(self): |
| 802 | self.get_called = True |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 803 | self.send_response(HTTPStatus.OK) |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 804 | self.send_header('Content-Type', 'text/html') |
| 805 | self.end_headers() |
| 806 | self.wfile.write(b'<html><body>Data</body></html>\r\n') |
| 807 | |
| 808 | def log_message(self, format, *args): |
Georg Brandl | 6fcac0d | 2010-08-02 18:56:54 +0000 | [diff] [blame] | 809 | pass |
| 810 | |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 811 | class RejectingSocketlessRequestHandler(SocketlessRequestHandler): |
| 812 | def handle_expect_100(self): |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 813 | self.send_error(HTTPStatus.EXPECTATION_FAILED) |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 814 | return False |
| 815 | |
Senthil Kumaran | c7ae19b | 2011-05-09 23:25:02 +0800 | [diff] [blame] | 816 | |
| 817 | class AuditableBytesIO: |
| 818 | |
| 819 | def __init__(self): |
| 820 | self.datas = [] |
| 821 | |
| 822 | def write(self, data): |
| 823 | self.datas.append(data) |
| 824 | |
| 825 | def getData(self): |
| 826 | return b''.join(self.datas) |
| 827 | |
| 828 | @property |
| 829 | def numWrites(self): |
| 830 | return len(self.datas) |
| 831 | |
| 832 | |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 833 | class BaseHTTPRequestHandlerTestCase(unittest.TestCase): |
Ezio Melotti | 3b3499b | 2011-03-16 11:35:38 +0200 | [diff] [blame] | 834 | """Test the functionality of the BaseHTTPServer. |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 835 | |
| 836 | Test the support for the Expect 100-continue header. |
| 837 | """ |
| 838 | |
| 839 | HTTPResponseMatch = re.compile(b'HTTP/1.[0-9]+ 200 OK') |
| 840 | |
| 841 | def setUp (self): |
| 842 | self.handler = SocketlessRequestHandler() |
| 843 | |
| 844 | def send_typical_request(self, message): |
| 845 | input = BytesIO(message) |
| 846 | output = BytesIO() |
| 847 | self.handler.rfile = input |
| 848 | self.handler.wfile = output |
| 849 | self.handler.handle_one_request() |
| 850 | output.seek(0) |
| 851 | return output.readlines() |
| 852 | |
| 853 | def verify_get_called(self): |
| 854 | self.assertTrue(self.handler.get_called) |
| 855 | |
| 856 | def verify_expected_headers(self, headers): |
| 857 | for fieldName in b'Server: ', b'Date: ', b'Content-Type: ': |
| 858 | self.assertEqual(sum(h.startswith(fieldName) for h in headers), 1) |
| 859 | |
| 860 | def verify_http_server_response(self, response): |
| 861 | match = self.HTTPResponseMatch.search(response) |
Serhiy Storchaka | 25d8aea | 2014-02-08 14:50:08 +0200 | [diff] [blame] | 862 | self.assertIsNotNone(match) |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 863 | |
| 864 | def test_http_1_1(self): |
| 865 | result = self.send_typical_request(b'GET / HTTP/1.1\r\n\r\n') |
| 866 | self.verify_http_server_response(result[0]) |
| 867 | self.verify_expected_headers(result[1:-1]) |
| 868 | self.verify_get_called() |
| 869 | self.assertEqual(result[-1], b'<html><body>Data</body></html>\r\n') |
Benjamin Peterson | 70e2847 | 2015-02-17 21:11:10 -0500 | [diff] [blame] | 870 | self.assertEqual(self.handler.requestline, 'GET / HTTP/1.1') |
| 871 | self.assertEqual(self.handler.command, 'GET') |
| 872 | self.assertEqual(self.handler.path, '/') |
| 873 | self.assertEqual(self.handler.request_version, 'HTTP/1.1') |
| 874 | self.assertSequenceEqual(self.handler.headers.items(), ()) |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 875 | |
| 876 | def test_http_1_0(self): |
| 877 | result = self.send_typical_request(b'GET / HTTP/1.0\r\n\r\n') |
| 878 | self.verify_http_server_response(result[0]) |
| 879 | self.verify_expected_headers(result[1:-1]) |
| 880 | self.verify_get_called() |
| 881 | self.assertEqual(result[-1], b'<html><body>Data</body></html>\r\n') |
Benjamin Peterson | 70e2847 | 2015-02-17 21:11:10 -0500 | [diff] [blame] | 882 | self.assertEqual(self.handler.requestline, 'GET / HTTP/1.0') |
| 883 | self.assertEqual(self.handler.command, 'GET') |
| 884 | self.assertEqual(self.handler.path, '/') |
| 885 | self.assertEqual(self.handler.request_version, 'HTTP/1.0') |
| 886 | self.assertSequenceEqual(self.handler.headers.items(), ()) |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 887 | |
| 888 | def test_http_0_9(self): |
| 889 | result = self.send_typical_request(b'GET / HTTP/0.9\r\n\r\n') |
| 890 | self.assertEqual(len(result), 1) |
| 891 | self.assertEqual(result[0], b'<html><body>Data</body></html>\r\n') |
| 892 | self.verify_get_called() |
| 893 | |
Martin Panter | e82338d | 2016-11-19 01:06:37 +0000 | [diff] [blame] | 894 | def test_extra_space(self): |
| 895 | result = self.send_typical_request( |
| 896 | b'GET /spaced out HTTP/1.1\r\n' |
| 897 | b'Host: dummy\r\n' |
| 898 | b'\r\n' |
| 899 | ) |
| 900 | self.assertTrue(result[0].startswith(b'HTTP/1.1 400 ')) |
| 901 | self.verify_expected_headers(result[1:result.index(b'\r\n')]) |
| 902 | self.assertFalse(self.handler.get_called) |
| 903 | |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 904 | def test_with_continue_1_0(self): |
| 905 | result = self.send_typical_request(b'GET / HTTP/1.0\r\nExpect: 100-continue\r\n\r\n') |
| 906 | self.verify_http_server_response(result[0]) |
| 907 | self.verify_expected_headers(result[1:-1]) |
| 908 | self.verify_get_called() |
| 909 | self.assertEqual(result[-1], b'<html><body>Data</body></html>\r\n') |
Benjamin Peterson | 70e2847 | 2015-02-17 21:11:10 -0500 | [diff] [blame] | 910 | self.assertEqual(self.handler.requestline, 'GET / HTTP/1.0') |
| 911 | self.assertEqual(self.handler.command, 'GET') |
| 912 | self.assertEqual(self.handler.path, '/') |
| 913 | self.assertEqual(self.handler.request_version, 'HTTP/1.0') |
| 914 | headers = (("Expect", "100-continue"),) |
| 915 | self.assertSequenceEqual(self.handler.headers.items(), headers) |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 916 | |
| 917 | def test_with_continue_1_1(self): |
| 918 | result = self.send_typical_request(b'GET / HTTP/1.1\r\nExpect: 100-continue\r\n\r\n') |
| 919 | self.assertEqual(result[0], b'HTTP/1.1 100 Continue\r\n') |
Benjamin Peterson | 0442423 | 2014-01-18 21:50:18 -0500 | [diff] [blame] | 920 | self.assertEqual(result[1], b'\r\n') |
| 921 | self.assertEqual(result[2], b'HTTP/1.1 200 OK\r\n') |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 922 | self.verify_expected_headers(result[2:-1]) |
| 923 | self.verify_get_called() |
| 924 | self.assertEqual(result[-1], b'<html><body>Data</body></html>\r\n') |
Benjamin Peterson | 70e2847 | 2015-02-17 21:11:10 -0500 | [diff] [blame] | 925 | self.assertEqual(self.handler.requestline, 'GET / HTTP/1.1') |
| 926 | self.assertEqual(self.handler.command, 'GET') |
| 927 | self.assertEqual(self.handler.path, '/') |
| 928 | self.assertEqual(self.handler.request_version, 'HTTP/1.1') |
| 929 | headers = (("Expect", "100-continue"),) |
| 930 | self.assertSequenceEqual(self.handler.headers.items(), headers) |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 931 | |
Senthil Kumaran | c7ae19b | 2011-05-09 23:25:02 +0800 | [diff] [blame] | 932 | def test_header_buffering_of_send_error(self): |
Senthil Kumaran | e4dad4f | 2010-11-21 14:36:14 +0000 | [diff] [blame] | 933 | |
| 934 | input = BytesIO(b'GET / HTTP/1.1\r\n\r\n') |
Senthil Kumaran | c7ae19b | 2011-05-09 23:25:02 +0800 | [diff] [blame] | 935 | output = AuditableBytesIO() |
| 936 | handler = SocketlessRequestHandler() |
| 937 | handler.rfile = input |
| 938 | handler.wfile = output |
| 939 | handler.request_version = 'HTTP/1.1' |
| 940 | handler.requestline = '' |
| 941 | handler.command = None |
Senthil Kumaran | e4dad4f | 2010-11-21 14:36:14 +0000 | [diff] [blame] | 942 | |
Senthil Kumaran | c7ae19b | 2011-05-09 23:25:02 +0800 | [diff] [blame] | 943 | handler.send_error(418) |
| 944 | self.assertEqual(output.numWrites, 2) |
| 945 | |
| 946 | def test_header_buffering_of_send_response_only(self): |
| 947 | |
| 948 | input = BytesIO(b'GET / HTTP/1.1\r\n\r\n') |
| 949 | output = AuditableBytesIO() |
| 950 | handler = SocketlessRequestHandler() |
| 951 | handler.rfile = input |
| 952 | handler.wfile = output |
| 953 | handler.request_version = 'HTTP/1.1' |
| 954 | |
| 955 | handler.send_response_only(418) |
| 956 | self.assertEqual(output.numWrites, 0) |
| 957 | handler.end_headers() |
| 958 | self.assertEqual(output.numWrites, 1) |
| 959 | |
| 960 | def test_header_buffering_of_send_header(self): |
| 961 | |
| 962 | input = BytesIO(b'GET / HTTP/1.1\r\n\r\n') |
| 963 | output = AuditableBytesIO() |
| 964 | handler = SocketlessRequestHandler() |
| 965 | handler.rfile = input |
| 966 | handler.wfile = output |
| 967 | handler.request_version = 'HTTP/1.1' |
| 968 | |
| 969 | handler.send_header('Foo', 'foo') |
| 970 | handler.send_header('bar', 'bar') |
| 971 | self.assertEqual(output.numWrites, 0) |
| 972 | handler.end_headers() |
| 973 | self.assertEqual(output.getData(), b'Foo: foo\r\nbar: bar\r\n\r\n') |
| 974 | self.assertEqual(output.numWrites, 1) |
Senthil Kumaran | e4dad4f | 2010-11-21 14:36:14 +0000 | [diff] [blame] | 975 | |
| 976 | def test_header_unbuffered_when_continue(self): |
| 977 | |
| 978 | def _readAndReseek(f): |
| 979 | pos = f.tell() |
| 980 | f.seek(0) |
| 981 | data = f.read() |
| 982 | f.seek(pos) |
| 983 | return data |
| 984 | |
| 985 | input = BytesIO(b'GET / HTTP/1.1\r\nExpect: 100-continue\r\n\r\n') |
| 986 | output = BytesIO() |
| 987 | self.handler.rfile = input |
| 988 | self.handler.wfile = output |
| 989 | self.handler.request_version = 'HTTP/1.1' |
| 990 | |
| 991 | self.handler.handle_one_request() |
| 992 | self.assertNotEqual(_readAndReseek(output), b'') |
| 993 | result = _readAndReseek(output).split(b'\r\n') |
| 994 | self.assertEqual(result[0], b'HTTP/1.1 100 Continue') |
Benjamin Peterson | 0442423 | 2014-01-18 21:50:18 -0500 | [diff] [blame] | 995 | self.assertEqual(result[1], b'') |
| 996 | self.assertEqual(result[2], b'HTTP/1.1 200 OK') |
Senthil Kumaran | e4dad4f | 2010-11-21 14:36:14 +0000 | [diff] [blame] | 997 | |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 998 | def test_with_continue_rejected(self): |
| 999 | usual_handler = self.handler # Save to avoid breaking any subsequent tests. |
| 1000 | self.handler = RejectingSocketlessRequestHandler() |
| 1001 | result = self.send_typical_request(b'GET / HTTP/1.1\r\nExpect: 100-continue\r\n\r\n') |
| 1002 | self.assertEqual(result[0], b'HTTP/1.1 417 Expectation Failed\r\n') |
| 1003 | self.verify_expected_headers(result[1:-1]) |
| 1004 | # The expect handler should short circuit the usual get method by |
| 1005 | # returning false here, so get_called should be false |
| 1006 | self.assertFalse(self.handler.get_called) |
| 1007 | self.assertEqual(sum(r == b'Connection: close\r\n' for r in result[1:-1]), 1) |
| 1008 | self.handler = usual_handler # Restore to avoid breaking any subsequent tests. |
| 1009 | |
Antoine Pitrou | c492437 | 2010-12-16 16:48:36 +0000 | [diff] [blame] | 1010 | def test_request_length(self): |
| 1011 | # Issue #10714: huge request lines are discarded, to avoid Denial |
| 1012 | # of Service attacks. |
| 1013 | result = self.send_typical_request(b'GET ' + b'x' * 65537) |
| 1014 | self.assertEqual(result[0], b'HTTP/1.1 414 Request-URI Too Long\r\n') |
| 1015 | self.assertFalse(self.handler.get_called) |
Benjamin Peterson | 70e2847 | 2015-02-17 21:11:10 -0500 | [diff] [blame] | 1016 | self.assertIsInstance(self.handler.requestline, str) |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 1017 | |
Senthil Kumaran | 5466bf1 | 2010-12-18 16:55:23 +0000 | [diff] [blame] | 1018 | def test_header_length(self): |
| 1019 | # Issue #6791: same for headers |
| 1020 | result = self.send_typical_request( |
| 1021 | b'GET / HTTP/1.1\r\nX-Foo: bar' + b'r' * 65537 + b'\r\n\r\n') |
Martin Panter | 50badad | 2016-04-03 01:28:53 +0000 | [diff] [blame] | 1022 | self.assertEqual(result[0], b'HTTP/1.1 431 Line too long\r\n') |
Senthil Kumaran | 5466bf1 | 2010-12-18 16:55:23 +0000 | [diff] [blame] | 1023 | self.assertFalse(self.handler.get_called) |
Benjamin Peterson | 70e2847 | 2015-02-17 21:11:10 -0500 | [diff] [blame] | 1024 | self.assertEqual(self.handler.requestline, 'GET / HTTP/1.1') |
| 1025 | |
Martin Panter | acc0319 | 2016-04-03 00:45:46 +0000 | [diff] [blame] | 1026 | def test_too_many_headers(self): |
| 1027 | result = self.send_typical_request( |
| 1028 | b'GET / HTTP/1.1\r\n' + b'X-Foo: bar\r\n' * 101 + b'\r\n') |
| 1029 | self.assertEqual(result[0], b'HTTP/1.1 431 Too many headers\r\n') |
| 1030 | self.assertFalse(self.handler.get_called) |
| 1031 | self.assertEqual(self.handler.requestline, 'GET / HTTP/1.1') |
| 1032 | |
Martin Panter | da3bb38 | 2016-04-11 00:40:08 +0000 | [diff] [blame] | 1033 | def test_html_escape_on_error(self): |
| 1034 | result = self.send_typical_request( |
| 1035 | b'<script>alert("hello")</script> / HTTP/1.1') |
| 1036 | result = b''.join(result) |
| 1037 | text = '<script>alert("hello")</script>' |
| 1038 | self.assertIn(html.escape(text, quote=False).encode('ascii'), result) |
| 1039 | |
Benjamin Peterson | 70e2847 | 2015-02-17 21:11:10 -0500 | [diff] [blame] | 1040 | def test_close_connection(self): |
| 1041 | # handle_one_request() should be repeatedly called until |
| 1042 | # it sets close_connection |
| 1043 | def handle_one_request(): |
| 1044 | self.handler.close_connection = next(close_values) |
| 1045 | self.handler.handle_one_request = handle_one_request |
| 1046 | |
| 1047 | close_values = iter((True,)) |
| 1048 | self.handler.handle() |
| 1049 | self.assertRaises(StopIteration, next, close_values) |
| 1050 | |
| 1051 | close_values = iter((False, False, True)) |
| 1052 | self.handler.handle() |
| 1053 | self.assertRaises(StopIteration, next, close_values) |
Senthil Kumaran | 5466bf1 | 2010-12-18 16:55:23 +0000 | [diff] [blame] | 1054 | |
Berker Peksag | 04bc5b9 | 2016-03-14 06:06:03 +0200 | [diff] [blame] | 1055 | def test_date_time_string(self): |
| 1056 | now = time.time() |
| 1057 | # this is the old code that formats the timestamp |
| 1058 | year, month, day, hh, mm, ss, wd, y, z = time.gmtime(now) |
| 1059 | expected = "%s, %02d %3s %4d %02d:%02d:%02d GMT" % ( |
| 1060 | self.handler.weekdayname[wd], |
| 1061 | day, |
| 1062 | self.handler.monthname[month], |
| 1063 | year, hh, mm, ss |
| 1064 | ) |
| 1065 | self.assertEqual(self.handler.date_time_string(timestamp=now), expected) |
| 1066 | |
| 1067 | |
Georg Brandl | 6fcac0d | 2010-08-02 18:56:54 +0000 | [diff] [blame] | 1068 | class SimpleHTTPRequestHandlerTestCase(unittest.TestCase): |
| 1069 | """ Test url parsing """ |
| 1070 | def setUp(self): |
| 1071 | self.translated = os.getcwd() |
| 1072 | self.translated = os.path.join(self.translated, 'filename') |
| 1073 | self.handler = SocketlessRequestHandler() |
| 1074 | |
| 1075 | def test_query_arguments(self): |
| 1076 | path = self.handler.translate_path('/filename') |
| 1077 | self.assertEqual(path, self.translated) |
| 1078 | path = self.handler.translate_path('/filename?foo=bar') |
| 1079 | self.assertEqual(path, self.translated) |
| 1080 | path = self.handler.translate_path('/filename?a=b&spam=eggs#zot') |
| 1081 | self.assertEqual(path, self.translated) |
| 1082 | |
| 1083 | def test_start_with_double_slash(self): |
| 1084 | path = self.handler.translate_path('//filename') |
| 1085 | self.assertEqual(path, self.translated) |
| 1086 | path = self.handler.translate_path('//filename?foo=bar') |
| 1087 | self.assertEqual(path, self.translated) |
| 1088 | |
Martin Panter | d274b3f | 2016-04-18 03:45:18 +0000 | [diff] [blame] | 1089 | def test_windows_colon(self): |
| 1090 | with support.swap_attr(server.os, 'path', ntpath): |
| 1091 | path = self.handler.translate_path('c:c:c:foo/filename') |
| 1092 | path = path.replace(ntpath.sep, os.sep) |
| 1093 | self.assertEqual(path, self.translated) |
| 1094 | |
| 1095 | path = self.handler.translate_path('\\c:../filename') |
| 1096 | path = path.replace(ntpath.sep, os.sep) |
| 1097 | self.assertEqual(path, self.translated) |
| 1098 | |
| 1099 | path = self.handler.translate_path('c:\\c:..\\foo/filename') |
| 1100 | path = path.replace(ntpath.sep, os.sep) |
| 1101 | self.assertEqual(path, self.translated) |
| 1102 | |
| 1103 | path = self.handler.translate_path('c:c:foo\\c:c:bar/filename') |
| 1104 | path = path.replace(ntpath.sep, os.sep) |
| 1105 | self.assertEqual(path, self.translated) |
| 1106 | |
Georg Brandl | 6fcac0d | 2010-08-02 18:56:54 +0000 | [diff] [blame] | 1107 | |
Berker Peksag | 366c570 | 2015-02-13 20:48:15 +0200 | [diff] [blame] | 1108 | class MiscTestCase(unittest.TestCase): |
| 1109 | def test_all(self): |
| 1110 | expected = [] |
| 1111 | blacklist = {'executable', 'nobody_uid', 'test'} |
| 1112 | for name in dir(server): |
| 1113 | if name.startswith('_') or name in blacklist: |
| 1114 | continue |
| 1115 | module_object = getattr(server, name) |
| 1116 | if getattr(module_object, '__module__', None) == 'http.server': |
| 1117 | expected.append(name) |
| 1118 | self.assertCountEqual(server.__all__, expected) |
| 1119 | |
| 1120 | |
Lisa Roach | 433433f | 2018-11-26 10:43:38 -0800 | [diff] [blame] | 1121 | class ScriptTestCase(unittest.TestCase): |
Jason R. Coombs | f289084 | 2019-02-07 08:22:45 -0500 | [diff] [blame] | 1122 | |
| 1123 | def mock_server_class(self): |
| 1124 | return mock.MagicMock( |
| 1125 | return_value=mock.MagicMock( |
| 1126 | __enter__=mock.MagicMock( |
| 1127 | return_value=mock.MagicMock( |
| 1128 | socket=mock.MagicMock( |
| 1129 | getsockname=lambda: ('', 0), |
| 1130 | ), |
| 1131 | ), |
| 1132 | ), |
| 1133 | ), |
| 1134 | ) |
| 1135 | |
| 1136 | @mock.patch('builtins.print') |
| 1137 | def test_server_test_unspec(self, _): |
| 1138 | mock_server = self.mock_server_class() |
| 1139 | server.test(ServerClass=mock_server, bind=None) |
| 1140 | self.assertIn( |
| 1141 | mock_server.address_family, |
| 1142 | (socket.AF_INET6, socket.AF_INET), |
| 1143 | ) |
| 1144 | |
| 1145 | @mock.patch('builtins.print') |
| 1146 | def test_server_test_localhost(self, _): |
| 1147 | mock_server = self.mock_server_class() |
| 1148 | server.test(ServerClass=mock_server, bind="localhost") |
| 1149 | self.assertIn( |
| 1150 | mock_server.address_family, |
| 1151 | (socket.AF_INET6, socket.AF_INET), |
| 1152 | ) |
| 1153 | |
| 1154 | ipv6_addrs = ( |
| 1155 | "::", |
| 1156 | "2001:0db8:85a3:0000:0000:8a2e:0370:7334", |
| 1157 | "::1", |
| 1158 | ) |
| 1159 | |
| 1160 | ipv4_addrs = ( |
| 1161 | "0.0.0.0", |
| 1162 | "8.8.8.8", |
| 1163 | "127.0.0.1", |
| 1164 | ) |
| 1165 | |
Lisa Roach | 433433f | 2018-11-26 10:43:38 -0800 | [diff] [blame] | 1166 | @mock.patch('builtins.print') |
| 1167 | def test_server_test_ipv6(self, _): |
Jason R. Coombs | f289084 | 2019-02-07 08:22:45 -0500 | [diff] [blame] | 1168 | for bind in self.ipv6_addrs: |
| 1169 | mock_server = self.mock_server_class() |
| 1170 | server.test(ServerClass=mock_server, bind=bind) |
| 1171 | self.assertEqual(mock_server.address_family, socket.AF_INET6) |
Lisa Roach | 433433f | 2018-11-26 10:43:38 -0800 | [diff] [blame] | 1172 | |
Jason R. Coombs | f289084 | 2019-02-07 08:22:45 -0500 | [diff] [blame] | 1173 | @mock.patch('builtins.print') |
| 1174 | def test_server_test_ipv4(self, _): |
| 1175 | for bind in self.ipv4_addrs: |
| 1176 | mock_server = self.mock_server_class() |
| 1177 | server.test(ServerClass=mock_server, bind=bind) |
| 1178 | self.assertEqual(mock_server.address_family, socket.AF_INET) |
Lisa Roach | 433433f | 2018-11-26 10:43:38 -0800 | [diff] [blame] | 1179 | |
| 1180 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 1181 | def test_main(verbose=None): |
Georg Brandl | 6fcac0d | 2010-08-02 18:56:54 +0000 | [diff] [blame] | 1182 | cwd = os.getcwd() |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 1183 | try: |
Georg Brandl | 6fcac0d | 2010-08-02 18:56:54 +0000 | [diff] [blame] | 1184 | support.run_unittest( |
Serhiy Storchaka | c0a23e6 | 2015-03-07 11:51:37 +0200 | [diff] [blame] | 1185 | RequestHandlerLoggingTestCase, |
Senthil Kumaran | 0f476d4 | 2010-09-30 06:09:18 +0000 | [diff] [blame] | 1186 | BaseHTTPRequestHandlerTestCase, |
Georg Brandl | 6fcac0d | 2010-08-02 18:56:54 +0000 | [diff] [blame] | 1187 | BaseHTTPServerTestCase, |
| 1188 | SimpleHTTPServerTestCase, |
| 1189 | CGIHTTPServerTestCase, |
| 1190 | SimpleHTTPRequestHandlerTestCase, |
Berker Peksag | 366c570 | 2015-02-13 20:48:15 +0200 | [diff] [blame] | 1191 | MiscTestCase, |
Lisa Roach | 433433f | 2018-11-26 10:43:38 -0800 | [diff] [blame] | 1192 | ScriptTestCase |
Georg Brandl | 6fcac0d | 2010-08-02 18:56:54 +0000 | [diff] [blame] | 1193 | ) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 1194 | finally: |
| 1195 | os.chdir(cwd) |
| 1196 | |
| 1197 | if __name__ == '__main__': |
| 1198 | test_main() |