1b1af71a2653d1ef62d2a5040de06f389b2ee334
[WebKit-https.git] / WebKitTools / Scripts / webkitpy / layout_tests / port / websocket_server.py
1 #!/usr/bin/env python
2 # Copyright (C) 2010 Google Inc. All rights reserved.
3 #
4 # Redistribution and use in source and binary forms, with or without
5 # modification, are permitted provided that the following conditions are
6 # met:
7 #
8 #     * Redistributions of source code must retain the above copyright
9 # notice, this list of conditions and the following disclaimer.
10 #     * Redistributions in binary form must reproduce the above
11 # copyright notice, this list of conditions and the following disclaimer
12 # in the documentation and/or other materials provided with the
13 # distribution.
14 #     * Neither the name of Google Inc. nor the names of its
15 # contributors may be used to endorse or promote products derived from
16 # this software without specific prior written permission.
17 #
18 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30 """A class to help start/stop the PyWebSocket server used by layout tests."""
31
32
33 import logging
34 import optparse
35 import os
36 import subprocess
37 import sys
38 import tempfile
39 import time
40 import urllib
41
42 import factory
43 import http_server
44
45 _log = logging.getLogger("webkitpy.layout_tests.port.websocket_server")
46
47 _WS_LOG_PREFIX = 'pywebsocket.ws.log-'
48 _WSS_LOG_PREFIX = 'pywebsocket.wss.log-'
49
50 _DEFAULT_WS_PORT = 8880
51 _DEFAULT_WSS_PORT = 9323
52
53
54 def url_is_alive(url):
55     """Checks to see if we get an http response from |url|.
56     We poll the url 5 times with a 1 second delay.  If we don't
57     get a reply in that time, we give up and assume the httpd
58     didn't start properly.
59
60     Args:
61       url: The URL to check.
62     Return:
63       True if the url is alive.
64     """
65     wait_time = 5
66     while wait_time > 0:
67         try:
68             response = urllib.urlopen(url)
69             # Server is up and responding.
70             return True
71         except IOError:
72             pass
73         wait_time -= 1
74         # Wait a second and try again.
75         time.sleep(1)
76
77     return False
78
79
80 class PyWebSocketNotStarted(Exception):
81     pass
82
83
84 class PyWebSocketNotFound(Exception):
85     pass
86
87
88 class PyWebSocket(http_server.Lighttpd):
89
90     def __init__(self, port_obj, output_dir, port=_DEFAULT_WS_PORT,
91                  root=None, use_tls=False,
92                  register_cygwin=True,
93                  pidfile=None):
94         """Args:
95           output_dir: the absolute path to the layout test result directory
96         """
97         http_server.Lighttpd.__init__(self, port_obj, output_dir,
98                                       port=_DEFAULT_WS_PORT,
99                                       root=root,
100                                       register_cygwin=register_cygwin)
101         self._output_dir = output_dir
102         self._process = None
103         self._port = port
104         self._root = root
105         self._use_tls = use_tls
106         self._private_key = self._pem_file
107         self._certificate = self._pem_file
108         if self._port:
109             self._port = int(self._port)
110         if self._use_tls:
111             self._server_name = 'PyWebSocket(Secure)'
112         else:
113             self._server_name = 'PyWebSocket'
114         self._pidfile = pidfile
115         self._wsout = None
116
117         # Webkit tests
118         if self._root:
119             self._layout_tests = os.path.abspath(self._root)
120             self._web_socket_tests = os.path.abspath(
121                 os.path.join(self._root, 'websocket', 'tests'))
122         else:
123             try:
124                 self._layout_tests = self._port_obj.layout_tests_dir()
125                 self._web_socket_tests = os.path.join(self._layout_tests,
126                      'websocket', 'tests')
127             except:
128                 self._web_socket_tests = None
129
130     def start(self):
131         if not self._web_socket_tests:
132             _log.info('No need to start %s server.' % self._server_name)
133             return
134         if self.is_running():
135             raise PyWebSocketNotStarted('%s is already running.' %
136                                         self._server_name)
137
138         time_str = time.strftime('%d%b%Y-%H%M%S')
139         if self._use_tls:
140             log_prefix = _WSS_LOG_PREFIX
141         else:
142             log_prefix = _WS_LOG_PREFIX
143         log_file_name = log_prefix + time_str
144
145         # Remove old log files. We only need to keep the last ones.
146         self.remove_log_files(self._output_dir, log_prefix)
147
148         error_log = os.path.join(self._output_dir, log_file_name + "-err.txt")
149
150         output_log = os.path.join(self._output_dir, log_file_name + "-out.txt")
151         self._wsout = open(output_log, "w")
152
153         python_interp = sys.executable
154         pywebsocket_base = os.path.join(
155             os.path.dirname(os.path.dirname(os.path.dirname(
156             os.path.abspath(__file__)))), 'thirdparty', 'pywebsocket')
157         pywebsocket_script = os.path.join(pywebsocket_base, 'mod_pywebsocket',
158             'standalone.py')
159         start_cmd = [
160             python_interp, pywebsocket_script,
161             '--server-host', '127.0.0.1',
162             '--port', str(self._port),
163             '--document-root', self._layout_tests,
164             '--scan-dir', self._web_socket_tests,
165             '--cgi-paths', '/websocket/tests',
166             '--log-file', error_log,
167         ]
168
169         handler_map_file = os.path.join(self._web_socket_tests,
170                                         'handler_map.txt')
171         if os.path.exists(handler_map_file):
172             _log.debug('Using handler_map_file: %s' % handler_map_file)
173             start_cmd.append('--websock-handlers-map-file')
174             start_cmd.append(handler_map_file)
175         else:
176             _log.warning('No handler_map_file found')
177
178         if self._use_tls:
179             start_cmd.extend(['-t', '-k', self._private_key,
180                               '-c', self._certificate])
181
182         # Put the cygwin directory first in the path to find cygwin1.dll
183         env = os.environ
184         if sys.platform in ('cygwin', 'win32'):
185             env['PATH'] = '%s;%s' % (
186                 self._port_obj.path_from_chromium_base('third_party',
187                                                        'cygwin', 'bin'),
188                 env['PATH'])
189             env['CYGWIN_PATH'] = self._port_obj.path_from_chromium_base(
190                 'third_party', 'cygwin', 'bin')
191
192         if sys.platform == 'win32' and self._register_cygwin:
193             setup_mount = self._port_obj.path_from_chromium_base(
194                 'third_party', 'cygwin', 'setup_mount.bat')
195             subprocess.Popen(setup_mount).wait()
196
197         env['PYTHONPATH'] = (pywebsocket_base + os.path.pathsep +
198                              env.get('PYTHONPATH', ''))
199
200         _log.debug('Starting %s server on %d.' % (
201                    self._server_name, self._port))
202         _log.debug('cmdline: %s' % ' '.join(start_cmd))
203         self._process = subprocess.Popen(start_cmd, stdout=self._wsout,
204                                          stderr=subprocess.STDOUT,
205                                          env=env)
206
207         # Wait a bit before checking the liveness of the server.
208         time.sleep(0.5)
209
210         if self._use_tls:
211             url = 'https'
212         else:
213             url = 'http'
214         url = url + '://127.0.0.1:%d/' % self._port
215         if not url_is_alive(url):
216             fp = open(output_log)
217             try:
218                 for line in fp:
219                     _log.error(line)
220             finally:
221                 fp.close()
222             raise PyWebSocketNotStarted(
223                 'Failed to start %s server on port %s.' %
224                     (self._server_name, self._port))
225
226         # Our process terminated already
227         if self._process.returncode != None:
228             raise PyWebSocketNotStarted(
229                 'Failed to start %s server.' % self._server_name)
230         if self._pidfile:
231             f = open(self._pidfile, 'w')
232             f.write("%d" % self._process.pid)
233             f.close()
234
235     def stop(self, force=False):
236         if not force and not self.is_running():
237             return
238
239         if self._process:
240             pid = self._process.pid
241         elif self._pidfile:
242             f = open(self._pidfile)
243             pid = int(f.read().strip())
244             f.close()
245
246         if not pid:
247             raise PyWebSocketNotFound(
248                 'Failed to find %s server pid.' % self._server_name)
249
250         _log.debug('Shutting down %s server %d.' % (self._server_name, pid))
251         self._port_obj._kill_process(pid)
252
253         if self._process:
254             self._process.wait()
255             self._process = None
256
257         if self._wsout:
258             self._wsout.close()
259             self._wsout = None
260
261
262 if '__main__' == __name__:
263     # Provide some command line params for starting the PyWebSocket server
264     # manually.
265     option_parser = optparse.OptionParser()
266     option_parser.add_option('--server', type='choice',
267                              choices=['start', 'stop'], default='start',
268                              help='Server action (start|stop)')
269     option_parser.add_option('-p', '--port', dest='port',
270                              default=None, help='Port to listen on')
271     option_parser.add_option('-r', '--root',
272                              help='Absolute path to DocumentRoot '
273                                   '(overrides layout test roots)')
274     option_parser.add_option('-t', '--tls', dest='use_tls',
275                              action='store_true',
276                              default=False, help='use TLS (wss://)')
277     option_parser.add_option('-k', '--private_key', dest='private_key',
278                              default='', help='TLS private key file.')
279     option_parser.add_option('-c', '--certificate', dest='certificate',
280                              default='', help='TLS certificate file.')
281     option_parser.add_option('--register_cygwin', action="store_true",
282                              dest="register_cygwin",
283                              help='Register Cygwin paths (on Win try bots)')
284     option_parser.add_option('--pidfile', help='path to pid file.')
285     options, args = option_parser.parse_args()
286
287     if not options.port:
288         if options.use_tls:
289             options.port = _DEFAULT_WSS_PORT
290         else:
291             options.port = _DEFAULT_WS_PORT
292
293     kwds = {'port': options.port, 'use_tls': options.use_tls}
294     if options.root:
295         kwds['root'] = options.root
296     if options.private_key:
297         kwds['private_key'] = options.private_key
298     if options.certificate:
299         kwds['certificate'] = options.certificate
300     kwds['register_cygwin'] = options.register_cygwin
301     if options.pidfile:
302         kwds['pidfile'] = options.pidfile
303
304     port_obj = factory.get()
305     pywebsocket = PyWebSocket(port_obj, tempfile.gettempdir(), **kwds)
306
307     if 'start' == options.server:
308         pywebsocket.start()
309     else:
310         pywebsocket.stop(force=True)