2010-04-22 Fumitoshi Ukai <ukai@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 from __future__ import with_statement
33
34 import codecs
35 import logging
36 import optparse
37 import os
38 import shutil
39 import subprocess
40 import sys
41 import tempfile
42 import time
43 import urllib
44
45 import factory
46 import http_server_base
47
48 _log = logging.getLogger("webkitpy.layout_tests.port.http_server")
49
50
51 class HttpdNotStarted(Exception):
52     pass
53
54
55 class Lighttpd(http_server_base.HttpServerBase):
56
57     def __init__(self, port_obj, output_dir, background=False, port=None,
58                  root=None, run_background=None):
59         """Args:
60           output_dir: the absolute path to the layout test result directory
61         """
62         # Webkit tests
63         http_server_base.HttpServerBase.__init__(self, port_obj)
64         self._output_dir = output_dir
65         self._process = None
66         self._port = port
67         self._root = root
68         self._run_background = run_background
69         if self._port:
70             self._port = int(self._port)
71
72         try:
73             self._webkit_tests = os.path.join(
74                 self._port_obj.layout_tests_dir(), 'http', 'tests')
75             self._js_test_resource = os.path.join(
76                 self._port_obj.layout_tests_dir(), 'fast', 'js', 'resources')
77         except:
78             self._webkit_tests = None
79             self._js_test_resource = None
80
81         # Self generated certificate for SSL server (for client cert get
82         # <base-path>\chrome\test\data\ssl\certs\root_ca_cert.crt)
83         self._pem_file = os.path.join(
84             os.path.dirname(os.path.abspath(__file__)), 'httpd2.pem')
85
86         # One mapping where we can get to everything
87         self.VIRTUALCONFIG = []
88
89         if self._webkit_tests:
90             self.VIRTUALCONFIG.extend(
91                # Three mappings (one with SSL) for LayoutTests http tests
92                [{'port': 8000, 'docroot': self._webkit_tests},
93                 {'port': 8080, 'docroot': self._webkit_tests},
94                 {'port': 8443, 'docroot': self._webkit_tests,
95                  'sslcert': self._pem_file}])
96
97     def is_running(self):
98         return self._process != None
99
100     def start(self):
101         if self.is_running():
102             raise 'Lighttpd already running'
103
104         base_conf_file = self._port_obj.path_from_webkit_base('WebKitTools',
105             'Scripts', 'webkitpy', 'layout_tests', 'port', 'lighttpd.conf')
106         out_conf_file = os.path.join(self._output_dir, 'lighttpd.conf')
107         time_str = time.strftime("%d%b%Y-%H%M%S")
108         access_file_name = "access.log-" + time_str + ".txt"
109         access_log = os.path.join(self._output_dir, access_file_name)
110         log_file_name = "error.log-" + time_str + ".txt"
111         error_log = os.path.join(self._output_dir, log_file_name)
112
113         # Remove old log files. We only need to keep the last ones.
114         self.remove_log_files(self._output_dir, "access.log-")
115         self.remove_log_files(self._output_dir, "error.log-")
116
117         # Write out the config
118         with codecs.open(base_conf_file, "r", "utf-8") as file:
119             base_conf = file.read()
120
121         # FIXME: This should be re-worked so that this block can
122         # use with open() instead of a manual file.close() call.
123         # lighttpd.conf files seem to be UTF-8 without BOM:
124         # http://redmine.lighttpd.net/issues/992
125         f = codecs.open(out_conf_file, "w", "utf-8")
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                                      self._port_obj._path_to_lighttpd_php())
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': self._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 = self._port_obj._path_to_lighttpd()
180         module_path = self._port_obj._path_to_lighttpd_modules()
181         start_cmd = [executable,
182                      # Newly written config file
183                      '-f', os.path.join(self._output_dir, 'lighttpd.conf'),
184                      # Where it can find its module dynamic libraries
185                      '-m', module_path]
186
187         if not self._run_background:
188             start_cmd.append(# Don't background
189                              '-D')
190
191         # Copy liblightcomp.dylib to /tmp/lighttpd/lib to work around the
192         # bug that mod_alias.so loads it from the hard coded path.
193         if sys.platform == 'darwin':
194             tmp_module_path = '/tmp/lighttpd/lib'
195             if not os.path.exists(tmp_module_path):
196                 os.makedirs(tmp_module_path)
197             lib_file = 'liblightcomp.dylib'
198             shutil.copyfile(os.path.join(module_path, lib_file),
199                             os.path.join(tmp_module_path, lib_file))
200
201         _log.debug('Starting http server')
202         self._process = subprocess.Popen(start_cmd, env=env)
203
204         # Wait for server to start.
205         self.mappings = mappings
206         server_started = self.wait_for_action(
207             self.is_server_running_on_all_ports)
208
209         # Our process terminated already
210         if not server_started or self._process.returncode != None:
211             raise google.httpd_utils.HttpdNotStarted('Failed to start httpd.')
212
213         _log.debug("Server successfully started")
214
215     # TODO(deanm): Find a nicer way to shutdown cleanly.  Our log files are
216     # probably not being flushed, etc... why doesn't our python have os.kill ?
217
218     def stop(self, force=False):
219         if not force and not self.is_running():
220             return
221
222         httpd_pid = None
223         if self._process:
224             httpd_pid = self._process.pid
225         self._port_obj._shut_down_http_server(httpd_pid)
226
227         if self._process:
228             self._process.wait()
229             self._process = None