1# Copyright (C) 2011 Google Inc. All rights reserved.
2#
3# Redistribution and use in source and binary forms, with or without
4# modification, are permitted provided that the following conditions are
5# met:
6#
7#     * Redistributions of source code must retain the above copyright
8# notice, this list of conditions and the following disclaimer.
9#     * Redistributions in binary form must reproduce the above
10# copyright notice, this list of conditions and the following disclaimer
11# in the documentation and/or other materials provided with the
12# distribution.
13#     * Neither the name of Google Inc. nor the names of its
14# contributors may be used to endorse or promote products derived from
15# this software without specific prior written permission.
16#
17# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29"""A class to help start/stop the PyWebSocket server used by layout tests."""
30
31import logging
32import os
33import sys
34import time
35
36from webkitpy.layout_tests.servers import http_server
37from webkitpy.layout_tests.servers import http_server_base
38
39_log = logging.getLogger(__name__)
40
41
42_WS_LOG_PREFIX = 'pywebsocket.ws.log-'
43_WSS_LOG_PREFIX = 'pywebsocket.wss.log-'
44
45
46_DEFAULT_WS_PORT = 8880
47_DEFAULT_WSS_PORT = 9323
48
49
50class PyWebSocket(http_server.Lighttpd):
51    def __init__(self, port_obj, output_dir, port=_DEFAULT_WS_PORT,
52                 root=None, use_tls=False,
53                 private_key=None, certificate=None, ca_certificate=None,
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        if private_key:
74            self._private_key = private_key
75        else:
76            self._private_key = self._pem_file
77        if certificate:
78            self._certificate = certificate
79        else:
80            self._certificate = self._pem_file
81        self._ca_certificate = ca_certificate
82        if self._port:
83            self._port = int(self._port)
84        self._wsin = None
85        self._wsout = None
86        self._mappings = [{'port': self._port}]
87
88        if not self._pid_file:
89            self._pid_file = self._filesystem.join(self._runtime_path, '%s.pid' % self._name)
90
91        # Webkit tests
92        # FIXME: This is the wrong way to detect if we're in Chrome vs. WebKit!
93        # The port objects are supposed to abstract this.
94        if self._root:
95            self._layout_tests = self._filesystem.abspath(self._root)
96            self._web_socket_tests = self._filesystem.abspath(self._filesystem.join(self._root, 'http', 'tests', 'websocket'))
97        else:
98            try:
99                self._layout_tests = self._port_obj.layout_tests_dir()
100                self._web_socket_tests = self._filesystem.join(self._layout_tests, 'http', 'tests', 'websocket')
101            except:
102                self._web_socket_tests = None
103
104        if self._use_tls:
105            self._log_prefix = _WSS_LOG_PREFIX
106        else:
107            self._log_prefix = _WS_LOG_PREFIX
108
109    def _prepare_config(self):
110        time_str = time.strftime('%d%b%Y-%H%M%S')
111        log_file_name = self._log_prefix + time_str
112        # FIXME: Doesn't Executive have a devnull, so that we don't have to use os.devnull directly?
113        self._wsin = open(os.devnull, 'r')
114
115        error_log = self._filesystem.join(self._output_dir, log_file_name + "-err.txt")
116        output_log = self._filesystem.join(self._output_dir, log_file_name + "-out.txt")
117        self._wsout = self._filesystem.open_text_file_for_writing(output_log)
118
119        from webkitpy.thirdparty import mod_pywebsocket
120        python_interp = sys.executable
121        # FIXME: Use self._filesystem.path_to_module(self.__module__) instead of __file__
122        # I think this is trying to get the chrome directory?  Doesn't the port object know that?
123        pywebsocket_base = self._filesystem.join(self._filesystem.dirname(self._filesystem.dirname(self._filesystem.dirname(self._filesystem.abspath(__file__)))), 'thirdparty')
124        pywebsocket_script = self._filesystem.join(pywebsocket_base, 'mod_pywebsocket', 'standalone.py')
125        start_cmd = [
126            python_interp, '-u', pywebsocket_script,
127            '--server-host', 'localhost',
128            '--port', str(self._port),
129            '--document-root', self._web_socket_tests,
130            '--scan-dir', self._web_socket_tests,
131            '--cgi-paths', '/',
132            '--log-file', error_log,
133        ]
134
135        handler_map_file = self._filesystem.join(self._web_socket_tests, 'handler_map.txt')
136        if self._filesystem.exists(handler_map_file):
137            _log.debug('Using handler_map_file: %s' % handler_map_file)
138            start_cmd.append('--websock-handlers-map-file')
139            start_cmd.append(handler_map_file)
140        else:
141            _log.warning('No handler_map_file found')
142
143        if self._use_tls:
144            start_cmd.extend(['-t', '-k', self._private_key,
145                              '-c', self._certificate])
146            if self._ca_certificate:
147                start_cmd.append('--ca-certificate')
148                start_cmd.append(self._ca_certificate)
149
150        self._start_cmd = start_cmd
151        server_name = self._filesystem.basename(pywebsocket_script)
152        self._env = self._port_obj.setup_environ_for_server(server_name)
153        self._env['PYTHONPATH'] = (pywebsocket_base + os.path.pathsep + self._env.get('PYTHONPATH', ''))
154
155    def _remove_stale_logs(self):
156        try:
157            self._remove_log_files(self._output_dir, self._log_prefix)
158        except OSError, e:
159            _log.warning('Failed to remove stale %s log files: %s' % (self._name, str(e)))
160
161    def _spawn_process(self):
162        _log.debug('Starting %s server, cmd="%s"' % (self._name, self._start_cmd))
163        self._process = self._executive.popen(self._start_cmd, env=self._env, shell=False, stdin=self._wsin, stdout=self._wsout, stderr=self._executive.STDOUT)
164        self._filesystem.write_text_file(self._pid_file, str(self._process.pid))
165        return self._process.pid
166
167    def _stop_running_server(self):
168        super(PyWebSocket, self)._stop_running_server()
169
170        if self._wsin:
171            self._wsin.close()
172            self._wsin = None
173        if self._wsout:
174            self._wsout.close()
175            self._wsout = None
176