2010-02-23 Dirk Pranke <dpranke@chromium.org>
[WebKit-https.git] / WebKitTools / Scripts / webkitpy / layout_tests / port / http_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 lighttpd server used by layout tests."""
31
32
33 import logging
34 import optparse
35 import os
36 import shutil
37 import subprocess
38 import sys
39 import tempfile
40 import time
41 import urllib
42
43 import factory
44 import http_server_base
45
46
47 class HttpdNotStarted(Exception):
48     pass
49
50
51 class Lighttpd(http_server_base.HttpServerBase):
52
53     def __init__(self, port_obj, output_dir, background=False, port=None,
54                  root=None, register_cygwin=None, run_background=None):
55         """Args:
56           output_dir: the absolute path to the layout test result directory
57         """
58         # Webkit tests
59         http_server_base.HttpServerBase.__init__(self, port_obj)
60         self._output_dir = output_dir
61         self._process = None
62         self._port = port
63         self._root = root
64         self._register_cygwin = register_cygwin
65         self._run_background = run_background
66         if self._port:
67             self._port = int(self._port)
68
69         try:
70             self._webkit_tests = os.path.join(
71                 self._port_obj.layout_tests_dir(), 'http', 'tests')
72             self._js_test_resource = os.path.join(
73                 self._port_obj.layout_tests_dir(), 'fast', 'js', 'resources')
74         except:
75             self._webkit_tests = None
76             self._js_test_resource = None
77
78         # Self generated certificate for SSL server (for client cert get
79         # <base-path>\chrome\test\data\ssl\certs\root_ca_cert.crt)
80         self._pem_file = os.path.join(
81             os.path.dirname(os.path.abspath(__file__)), 'httpd2.pem')
82
83         # One mapping where we can get to everything
84         self.VIRTUALCONFIG = []
85
86         if self._webkit_tests:
87             self.VIRTUALCONFIG.extend(
88                # Three mappings (one with SSL) for LayoutTests http tests
89                [{'port': 8000, 'docroot': self._webkit_tests},
90                 {'port': 8080, 'docroot': self._webkit_tests},
91                 {'port': 8443, 'docroot': self._webkit_tests,
92                  'sslcert': self._pem_file}])
93
94     def is_running(self):
95         return self._process != None
96
97     def start(self):
98         if self.is_running():
99             raise 'Lighttpd already running'
100
101         base_conf_file = self._port_obj.path_from_webkit_base('WebKitTools',
102             'Scripts', 'webkitpy', 'layout_tests', 'port', 'lighttpd.conf')
103         out_conf_file = os.path.join(self._output_dir, 'lighttpd.conf')
104         time_str = time.strftime("%d%b%Y-%H%M%S")
105         access_file_name = "access.log-" + time_str + ".txt"
106         access_log = os.path.join(self._output_dir, access_file_name)
107         log_file_name = "error.log-" + time_str + ".txt"
108         error_log = os.path.join(self._output_dir, log_file_name)
109
110         # Remove old log files. We only need to keep the last ones.
111         self.remove_log_files(self._output_dir, "access.log-")
112         self.remove_log_files(self._output_dir, "error.log-")
113
114         # Write out the config
115         f = file(base_conf_file, 'rb')
116         base_conf = f.read()
117         f.close()
118
119         f = file(out_conf_file, 'wb')
120         f.write(base_conf)
121
122         # Write out our cgi handlers.  Run perl through env so that it
123         # processes the #! line and runs perl with the proper command
124         # line arguments. Emulate apache's mod_asis with a cat cgi handler.
125         f.write(('cgi.assign = ( ".cgi"  => "/usr/bin/env",\n'
126                  '               ".pl"   => "/usr/bin/env",\n'
127                  '               ".asis" => "/bin/cat",\n'
128                  '               ".php"  => "%s" )\n\n') %
129                                      self._port_obj._path_to_lighttpd_php())
130
131         # Setup log files
132         f.write(('server.errorlog = "%s"\n'
133                  'accesslog.filename = "%s"\n\n') % (error_log, access_log))
134
135         # Setup upload folders. Upload folder is to hold temporary upload files
136         # and also POST data. This is used to support XHR layout tests that
137         # does POST.
138         f.write(('server.upload-dirs = ( "%s" )\n\n') % (self._output_dir))
139
140         # Setup a link to where the js test templates are stored
141         f.write(('alias.url = ( "/js-test-resources" => "%s" )\n\n') %
142                     (self._js_test_resource))
143
144         # dump out of virtual host config at the bottom.
145         if self._root:
146             if self._port:
147                 # Have both port and root dir.
148                 mappings = [{'port': self._port, 'docroot': self._root}]
149             else:
150                 # Have only a root dir - set the ports as for LayoutTests.
151                 # This is used in ui_tests to run http tests against a browser.
152
153                 # default set of ports as for LayoutTests but with a
154                 # specified root.
155                 mappings = [{'port': 8000, 'docroot': self._root},
156                             {'port': 8080, 'docroot': self._root},
157                             {'port': 8443, 'docroot': self._root,
158                              'sslcert': self._pem_file}]
159         else:
160             mappings = self.VIRTUALCONFIG
161         for mapping in mappings:
162             ssl_setup = ''
163             if 'sslcert' in mapping:
164                 ssl_setup = ('  ssl.engine = "enable"\n'
165                              '  ssl.pemfile = "%s"\n' % mapping['sslcert'])
166
167             f.write(('$SERVER["socket"] == "127.0.0.1:%d" {\n'
168                      '  server.document-root = "%s"\n' +
169                      ssl_setup +
170                      '}\n\n') % (mapping['port'], mapping['docroot']))
171         f.close()
172
173         executable = self._port_obj._path_to_lighttpd()
174         module_path = self._port_obj._path_to_lighttpd_modules()
175         start_cmd = [executable,
176                      # Newly written config file
177                      '-f', os.path.join(self._output_dir, 'lighttpd.conf'),
178                      # Where it can find its module dynamic libraries
179                      '-m', module_path]
180
181         if not self._run_background:
182             start_cmd.append(# Don't background
183                              '-D')
184
185         # Copy liblightcomp.dylib to /tmp/lighttpd/lib to work around the
186         # bug that mod_alias.so loads it from the hard coded path.
187         if sys.platform == 'darwin':
188             tmp_module_path = '/tmp/lighttpd/lib'
189             if not os.path.exists(tmp_module_path):
190                 os.makedirs(tmp_module_path)
191             lib_file = 'liblightcomp.dylib'
192             shutil.copyfile(os.path.join(module_path, lib_file),
193                             os.path.join(tmp_module_path, lib_file))
194
195         # Put the cygwin directory first in the path to find cygwin1.dll
196         env = os.environ
197         if sys.platform in ('cygwin', 'win32'):
198             env['PATH'] = '%s;%s' % (
199                 self._port_obj.path_from_chromium_base('third_party',
200                                                        'cygwin', 'bin'),
201                 env['PATH'])
202
203         if sys.platform == 'win32' and self._register_cygwin:
204             setup_mount = port.path_from_chromium_base('third_party',
205                 'cygwin', 'setup_mount.bat')
206             subprocess.Popen(setup_mount).wait()
207
208         logging.debug('Starting http server')
209         self._process = subprocess.Popen(start_cmd, env=env)
210
211         # Wait for server to start.
212         self.mappings = mappings
213         server_started = self.wait_for_action(
214             self.is_server_running_on_all_ports)
215
216         # Our process terminated already
217         if not server_started or self._process.returncode != None:
218             raise google.httpd_utils.HttpdNotStarted('Failed to start httpd.')
219
220         logging.debug("Server successfully started")
221
222     # TODO(deanm): Find a nicer way to shutdown cleanly.  Our log files are
223     # probably not being flushed, etc... why doesn't our python have os.kill ?
224
225     def stop(self, force=False):
226         if not force and not self.is_running():
227             return
228
229         httpd_pid = None
230         if self._process:
231             httpd_pid = self._process.pid
232         self._port_obj._shut_down_http_server(httpd_pid)
233
234         if self._process:
235             self._process.wait()
236             self._process = None
237
238 if '__main__' == __name__:
239     # Provide some command line params for starting/stopping the http server
240     # manually. Also used in ui_tests to run http layout tests in a browser.
241     option_parser = optparse.OptionParser()
242     option_parser.add_option('-k', '--server',
243         help='Server action (start|stop)')
244     option_parser.add_option('-p', '--port',
245         help='Port to listen on (overrides layout test ports)')
246     option_parser.add_option('-r', '--root',
247         help='Absolute path to DocumentRoot (overrides layout test roots)')
248     option_parser.add_option('--register_cygwin', action="store_true",
249         dest="register_cygwin", help='Register Cygwin paths (on Win try bots)')
250     option_parser.add_option('--run_background', action="store_true",
251         dest="run_background",
252         help='Run on background (for running as UI test)')
253     options, args = option_parser.parse_args()
254
255     if not options.server:
256         print ('Usage: %s --server {start|stop} [--root=root_dir]'
257                ' [--port=port_number]' % sys.argv[0])
258     else:
259         if (options.root is None) and (options.port is not None):
260             # specifying root but not port means we want httpd on default
261             # set of ports that LayoutTest use, but pointing to a different
262             # source of tests. Specifying port but no root does not seem
263             # meaningful.
264             raise 'Specifying port requires also a root.'
265         port_obj = factory.get()
266         httpd = Lighttpd(port_obj,
267                          tempfile.gettempdir(),
268                          port=options.port,
269                          root=options.root,
270                          register_cygwin=options.register_cygwin,
271                          run_background=options.run_background)
272         if 'start' == options.server:
273             httpd.start()
274         else:
275             httpd.stop(force=True)