don't use autoinstall to import pywebsocket but check it in WebKit directly.
[WebKit-https.git] / Tools / Scripts / webkitpy / layout_tests / servers / websocket_server.py
1 #!/usr/bin/env python
2 # Copyright (C) 2011 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 import logging
33 import os
34 import sys
35 import time
36
37 from webkitpy.layout_tests.servers import http_server
38 from webkitpy.layout_tests.servers import http_server_base
39
40 _log = logging.getLogger(__name__)
41
42
43 _WS_LOG_PREFIX = 'pywebsocket.ws.log-'
44 _WSS_LOG_PREFIX = 'pywebsocket.wss.log-'
45
46
47 _DEFAULT_WS_PORT = 8880
48 _DEFAULT_WSS_PORT = 9323
49
50
51 class PyWebSocket(http_server.Lighttpd):
52     def __init__(self, port_obj, output_dir, port=_DEFAULT_WS_PORT,
53                  root=None, use_tls=False,
54                  pidfile=None):
55         """Args:
56           output_dir: the absolute path to the layout test result directory
57         """
58         http_server.Lighttpd.__init__(self, port_obj, output_dir,
59                                       port=_DEFAULT_WS_PORT,
60                                       root=root)
61         self._output_dir = output_dir
62         self._pid_file = pidfile
63         self._process = None
64
65         self._port = port
66         self._root = root
67         self._use_tls = use_tls
68
69         self._name = 'pywebsocket'
70         if self._use_tls:
71             self._name = 'pywebsocket_secure'
72
73         self._private_key = self._pem_file
74         self._certificate = self._pem_file
75         if self._port:
76             self._port = int(self._port)
77         self._wsin = None
78         self._wsout = None
79         self._mappings = [{'port': self._port}]
80
81         if not self._pid_file:
82             self._pid_file = self._filesystem.join(self._runtime_path, '%s.pid' % self._name)
83
84         # Webkit tests
85         # FIXME: This is the wrong way to detect if we're in Chrome vs. WebKit!
86         # The port objects are supposed to abstract this.
87         if self._root:
88             self._layout_tests = self._filesystem.abspath(self._root)
89             self._web_socket_tests = self._filesystem.abspath(self._filesystem.join(self._root, 'http', 'tests', 'websocket', 'tests'))
90         else:
91             try:
92                 self._layout_tests = self._port_obj.layout_tests_dir()
93                 self._web_socket_tests = self._filesystem.join(self._layout_tests, 'http', 'tests', 'websocket', 'tests')
94             except:
95                 self._web_socket_tests = None
96
97         if self._use_tls:
98             self._log_prefix = _WSS_LOG_PREFIX
99         else:
100             self._log_prefix = _WS_LOG_PREFIX
101
102     def _prepare_config(self):
103         time_str = time.strftime('%d%b%Y-%H%M%S')
104         log_file_name = self._log_prefix + time_str
105         # FIXME: Doesn't Executive have a devnull, so that we don't have to use os.devnull directly?
106         self._wsin = open(os.devnull, 'r')
107
108         error_log = self._filesystem.join(self._output_dir, log_file_name + "-err.txt")
109         output_log = self._filesystem.join(self._output_dir, log_file_name + "-out.txt")
110         self._wsout = self._filesystem.open_text_file_for_writing(output_log)
111
112         from webkitpy.thirdparty import mod_pywebsocket
113         python_interp = sys.executable
114         # FIXME: Use self._filesystem.path_to_module(self.__module__) instead of __file__
115         # I think this is trying to get the chrome directory?  Doesn't the port object know that?
116         pywebsocket_base = self._filesystem.join(self._filesystem.dirname(self._filesystem.dirname(self._filesystem.dirname(self._filesystem.abspath(__file__)))), 'thirdparty')
117         pywebsocket_script = self._filesystem.join(pywebsocket_base, 'mod_pywebsocket', 'standalone.py')
118         start_cmd = [
119             python_interp, '-u', pywebsocket_script,
120             '--server-host', 'localhost',
121             '--port', str(self._port),
122             # FIXME: Don't we have a self._port_obj.layout_test_path?
123             '--document-root', self._filesystem.join(self._layout_tests, 'http', 'tests'),
124             '--scan-dir', self._web_socket_tests,
125             '--cgi-paths', '/websocket/tests',
126             '--log-file', error_log,
127         ]
128
129         handler_map_file = self._filesystem.join(self._web_socket_tests, 'handler_map.txt')
130         if self._filesystem.exists(handler_map_file):
131             _log.debug('Using handler_map_file: %s' % handler_map_file)
132             start_cmd.append('--websock-handlers-map-file')
133             start_cmd.append(handler_map_file)
134         else:
135             _log.warning('No handler_map_file found')
136
137         if self._use_tls:
138             start_cmd.extend(['-t', '-k', self._private_key,
139                               '-c', self._certificate])
140
141         self._start_cmd = start_cmd
142         server_name = self._filesystem.basename(pywebsocket_script)
143         self._env = self._port_obj.setup_environ_for_server(server_name)
144         self._env['PYTHONPATH'] = (pywebsocket_base + os.path.pathsep + self._env.get('PYTHONPATH', ''))
145
146     def _remove_stale_logs(self):
147         try:
148             self._remove_log_files(self._output_dir, self._log_prefix)
149         except OSError, e:
150             _log.warning('Failed to remove stale %s log files: %s' % (self._name, str(e)))
151
152     def _spawn_process(self):
153         _log.debug('Starting %s server, cmd="%s"' % (self._name, self._start_cmd))
154         self._process = self._executive.popen(self._start_cmd, env=self._env, shell=False, stdin=self._wsin, stdout=self._wsout, stderr=self._executive.STDOUT)
155         self._filesystem.write_text_file(self._pid_file, str(self._process.pid))
156         return self._process.pid
157
158     def _stop_running_server(self):
159         super(PyWebSocket, self)._stop_running_server()
160
161         if self._wsin:
162             self._wsin.close()
163             self._wsin = None
164         if self._wsout:
165             self._wsout.close()
166             self._wsout = None