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