forked from SeleniumHQ/selenium
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathwebserver.py
203 lines (169 loc) · 6.66 KB
/
webserver.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# Licensed to the Software Freedom Conservancy (SFC) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The SFC licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
"""A simple web server for testing purpose.
It serves the testing html pages that are needed by the webdriver unit tests."""
import contextlib
import logging
import os
import re
import threading
try:
from urllib import request as urllib_request
except ImportError:
import urllib as urllib_request
try:
from http.server import BaseHTTPRequestHandler
from http.server import HTTPServer
from socketserver import ThreadingMixIn
except ImportError:
from BaseHTTPServer import BaseHTTPRequestHandler
from BaseHTTPServer import HTTPServer
from SocketServer import ThreadingMixIn
def updir():
dirname = os.path.dirname
return dirname(dirname(__file__))
LOGGER = logging.getLogger(__name__)
WEBDRIVER = os.environ.get("WEBDRIVER", updir())
HTML_ROOT = os.path.join(WEBDRIVER, "../../../../common/src/web")
if not os.path.isdir(HTML_ROOT):
message = (
"Can't find 'common_web' directory, try setting WEBDRIVER"
" environment variable WEBDRIVER:" + WEBDRIVER + " HTML_ROOT:" + HTML_ROOT
)
LOGGER.error(message)
assert 0, message
DEFAULT_HOST = "localhost"
DEFAULT_HOST_IP = "127.0.0.1"
DEFAULT_PORT = 8000
class HtmlOnlyHandler(BaseHTTPRequestHandler):
"""Handler for HTML responses and JSON files."""
def _serve_page(self, page_number):
"""Serve a dynamically generated HTML page."""
html = f"""<html><head><title>Page{page_number}</title></head>
<body>Page number <span id="pageNumber">{page_number}</span>
<p><a href="../xhtmlTest.html" target="_top">top</a></p>
</body></html>"""
return html.encode("utf-8")
def _serve_file(self, file_path):
"""Serve a file from the HTML root directory."""
with open(file_path, encoding="latin-1") as f:
return f.read().encode("utf-8")
def _send_response(self, content_type="text/html"):
"""Send a response."""
self.send_response(200)
self.send_header("Content-type", content_type)
self.end_headers()
def do_GET(self):
"""GET method handler."""
try:
path = self.path[1:].split("?")[0]
file_path = os.path.join(HTML_ROOT, path)
if path.startswith("page/"):
html = self._serve_page(path[5:])
self._send_response("text/html")
self.wfile.write(html)
elif os.path.isfile(file_path):
content_type = "application/json" if file_path.endswith(".json") else "text/html"
content = self._serve_file(file_path)
self._send_response(content_type)
self.wfile.write(content)
else:
self.send_error(404, f"File Not Found: {path}")
except OSError:
self.send_error(404, f"File Not Found: {path}")
def do_POST(self):
"""POST method handler."""
try:
remaining_bytes = int(self.headers["content-length"])
contents = self.rfile.read(remaining_bytes).decode("utf-8")
fn_match = re.search(r'Content-Disposition.*name="upload"; filename="(.*)"', contents)
if not fn_match:
self.send_error(500, f"File not found in content. {contents}")
return
self._send_response("text/html")
self.wfile.write(
f"""<!doctype html>
{contents}
<script>window.top.window.onUploadDone();</script>
""".encode()
)
except Exception as e:
self.send_error(500, f"Error found: {e}")
def log_message(self, format, *args):
"""Override default to avoid trashing stderr"""
pass
class ThreadedHTTPServer(ThreadingMixIn, HTTPServer):
pass
class SimpleWebServer:
"""A very basic web server."""
def __init__(self, host=DEFAULT_HOST_IP, port=DEFAULT_PORT):
self.stop_serving = False
host = host if host else DEFAULT_HOST_IP
port = port
while True:
try:
self.server = ThreadedHTTPServer((host, port), HtmlOnlyHandler)
self.host = host
self.port = port
break
except OSError:
LOGGER.debug(f"port {port} is in use, trying to next one")
port += 1
self.thread = threading.Thread(target=self._run_web_server)
def _run_web_server(self):
"""Runs the server loop."""
LOGGER.debug("web server started")
while not self.stop_serving:
self.server.handle_request()
self.server.server_close()
def start(self):
"""Starts the server."""
self.thread.start()
def stop(self):
"""Stops the server."""
self.stop_serving = True
with contextlib.suppress(IOError):
_ = urllib_request.urlopen(f"http://{self.host}:{self.port}")
def where_is(self, path, localhost=False) -> str:
# True force serve the page from localhost
# 0.0.0.0 shouldn't be used as a destination address, so fallback to localhost
if localhost or self.host == "0.0.0.0":
return f"http://{DEFAULT_HOST}:{self.port}/{path}"
return f"http://{self.host}:{self.port}/{path}"
def main(argv=None):
from optparse import OptionParser
from time import sleep
if argv is None:
import sys
argv = sys.argv
parser = OptionParser("%prog [options]")
parser.add_option(
"-p", "--port", dest="port", type="int", help=f"port to listen (default: {DEFAULT_PORT})", default=DEFAULT_PORT
)
opts, args = parser.parse_args(argv[1:])
if args:
parser.error("wrong number of arguments") # Will exit
server = SimpleWebServer(port=opts.port)
server.start()
print(f"Server started on port {opts.port}, hit CTRL-C to quit")
try:
while 1:
sleep(0.1)
except KeyboardInterrupt:
pass
if __name__ == "__main__":
main()