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