src/third_party/WebKit/Tools/Scripts/webkitpy/layout_tests/servers/pywebsocket.py

   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 as used by the layout tests."""
  30
  31 import logging
  32 import os
  33 import sys
  34 import time
  35
  36 from webkitpy.layout_tests.servers import server_base
  37 from webkitpy.thirdparty import mod_pywebsocket
  38
  39 _log = logging.getLogger(__name__)
  40
  41
  42 _WS_LOG_PREFIX = 'pywebsocket.ws.log-'
  43
  44 _DEFAULT_WS_PORT = 8880
  45
  46
  47 class PyWebSocket(server_base.ServerBase):
  48
  49     def __init__(self, port_obj, output_dir, additional_dirs=None):
  50         super(PyWebSocket, self).__init__(port_obj, output_dir)
  51         self._name = 'pywebsocket'
  52         self._log_prefixes = (_WS_LOG_PREFIX,)
  53         self._mappings = [{'port': _DEFAULT_WS_PORT}]
  54         self._pid_file = self._filesystem.join(self._runtime_path, '%s.pid' % self._name)
  55
  56         self._port = _DEFAULT_WS_PORT
  57         self._layout_tests = self._port_obj.layout_tests_dir()
  58         self._web_socket_tests = self._filesystem.join(self._layout_tests, 'http', 'tests', 'websocket')
  59         time_str = time.strftime('%d%b%Y-%H%M%S')
  60         log_file_name = _WS_LOG_PREFIX + time_str
  61         error_log = self._filesystem.join(self._output_dir, log_file_name + "-err.txt")
  62         pywebsocket_base = self._port_obj.path_from_webkit_base('Tools', 'Scripts', 'webkitpy', 'thirdparty')
  63         pywebsocket_script = self._filesystem.join(pywebsocket_base, 'mod_pywebsocket', 'standalone.py')
  64
  65         self._start_cmd = [
  66             sys.executable, '-u', pywebsocket_script,
  67             '--server-host', 'localhost',
  68             '--port', str(self._port),
  69             '--document-root', self._web_socket_tests,
  70             '--scan-dir', self._web_socket_tests,
  71             '--cgi-paths', '/',
  72             '--log-file', error_log,
  73             '--websock-handlers-map-file', self._filesystem.join(self._web_socket_tests, 'handler_map.txt'),
  74             ]
  75         self._env = self._port_obj.setup_environ_for_server()
  76         self._env['PYTHONPATH'] = (pywebsocket_base + os.pathsep + self._env.get('PYTHONPATH', ''))