2011-02-03 Hayato Ito <hayato@chromium.org>
[WebKit-https.git] / Tools / Scripts / webkitpy / layout_tests / port / base.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 Google name 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 """Abstract base class of Port-specific entrypoints for the layout tests
31 test infrastructure (the Port and Driver classes)."""
32
33 import cgi
34 import difflib
35 import errno
36 import os
37 import shlex
38 import sys
39 import time
40
41 import apache_http_server
42 import config as port_config
43 import http_lock
44 import http_server
45 import test_files
46 import websocket_server
47
48 from webkitpy.common import system
49 from webkitpy.common.system import filesystem
50 from webkitpy.common.system import logutils
51 from webkitpy.common.system import path
52 from webkitpy.common.system.executive import Executive, ScriptError
53 from webkitpy.common.system.user import User
54
55
56 _log = logutils.get_logger(__file__)
57
58
59 class DummyOptions(object):
60     """Fake implementation of optparse.Values. Cloned from
61     webkitpy.tool.mocktool.MockOptions.
62
63     """
64
65     def __init__(self, **kwargs):
66         # The caller can set option values using keyword arguments. We don't
67         # set any values by default because we don't know how this
68         # object will be used. Generally speaking unit tests should
69         # subclass this or provider wrapper functions that set a common
70         # set of options.
71         for key, value in kwargs.items():
72             self.__dict__[key] = value
73
74
75 # FIXME: This class should merge with webkitpy.webkit_port at some point.
76 class Port(object):
77     """Abstract class for Port-specific hooks for the layout_test package."""
78
79     def __init__(self, port_name=None, options=None,
80                  executive=None,
81                  user=None,
82                  filesystem=None,
83                  config=None,
84                  **kwargs):
85         self._name = port_name
86         self._options = options
87         if self._options is None:
88             # FIXME: Ideally we'd have a package-wide way to get a
89             # well-formed options object that had all of the necessary
90             # options defined on it.
91             self._options = DummyOptions()
92         self._executive = executive or Executive()
93         self._user = user or User()
94         self._filesystem = filesystem or system.filesystem.FileSystem()
95         self._config = config or port_config.Config(self._executive,
96                                                     self._filesystem)
97         self._helper = None
98         self._http_server = None
99         self._webkit_base_dir = None
100         self._websocket_server = None
101         self._http_lock = None
102
103         # Python's Popen has a bug that causes any pipes opened to a
104         # process that can't be executed to be leaked.  Since this
105         # code is specifically designed to tolerate exec failures
106         # to gracefully handle cases where wdiff is not installed,
107         # the bug results in a massive file descriptor leak. As a
108         # workaround, if an exec failure is ever experienced for
109         # wdiff, assume it's not available.  This will leak one
110         # file descriptor but that's better than leaking each time
111         # wdiff would be run.
112         #
113         # http://mail.python.org/pipermail/python-list/
114         #    2008-August/505753.html
115         # http://bugs.python.org/issue3210
116         self._wdiff_available = True
117
118         self._pretty_patch_path = self.path_from_webkit_base("Websites",
119             "bugs.webkit.org", "PrettyPatch", "prettify.rb")
120         # If we're running on a mocked-out filesystem, this file almost
121         # certainly won't be available, so it's a good test to keep us
122         # from erroring out later.
123         self._pretty_patch_available = self._filesystem.exists(self._pretty_patch_path)
124         if not hasattr(self._options, 'configuration') or self._options.configuration is None:
125             self._options.configuration = self.default_configuration()
126         self._test_configuration = None
127
128     def default_child_processes(self):
129         """Return the number of DumpRenderTree instances to use for this
130         port."""
131         return self._executive.cpu_count()
132
133     def default_worker_model(self):
134         return 'old-threads'
135
136     def baseline_path(self):
137         """Return the absolute path to the directory to store new baselines
138         in for this port."""
139         raise NotImplementedError('Port.baseline_path')
140
141     def baseline_search_path(self):
142         """Return a list of absolute paths to directories to search under for
143         baselines. The directories are searched in order."""
144         raise NotImplementedError('Port.baseline_search_path')
145
146     def check_build(self, needs_http):
147         """This routine is used to ensure that the build is up to date
148         and all the needed binaries are present."""
149         raise NotImplementedError('Port.check_build')
150
151     def check_sys_deps(self, needs_http):
152         """If the port needs to do some runtime checks to ensure that the
153         tests can be run successfully, it should override this routine.
154         This step can be skipped with --nocheck-sys-deps.
155
156         Returns whether the system is properly configured."""
157         return True
158
159     def check_image_diff(self, override_step=None, logging=True):
160         """This routine is used to check whether image_diff binary exists."""
161         raise NotImplementedError('Port.check_image_diff')
162
163     def check_pretty_patch(self):
164         """Checks whether we can use the PrettyPatch ruby script."""
165
166         # check if Ruby is installed
167         try:
168             result = self._executive.run_command(['ruby', '--version'])
169         except OSError, e:
170             if e.errno in [errno.ENOENT, errno.EACCES, errno.ECHILD]:
171                 _log.error("Ruby is not installed; "
172                            "can't generate pretty patches.")
173                 _log.error('')
174                 return False
175
176         if not self.path_exists(self._pretty_patch_path):
177             _log.error('Unable to find %s .' % self._pretty_patch_path)
178             _log.error("Can't generate pretty patches.")
179             _log.error('')
180             return False
181
182         return True
183
184     def compare_text(self, expected_text, actual_text):
185         """Return whether or not the two strings are *not* equal. This
186         routine is used to diff text output.
187
188         While this is a generic routine, we include it in the Port
189         interface so that it can be overriden for testing purposes."""
190         return expected_text != actual_text
191
192     def diff_image(self, expected_contents, actual_contents,
193                    diff_filename=None, tolerance=0):
194         """Compare two images and produce a delta image file.
195
196         Return True if the two images are different, False if they are the same.
197         Also produce a delta image of the two images and write that into
198         |diff_filename| if it is not None.
199
200         |tolerance| should be a percentage value (0.0 - 100.0).
201         If it is omitted, the port default tolerance value is used.
202
203         """
204         raise NotImplementedError('Port.diff_image')
205
206
207     def diff_text(self, expected_text, actual_text,
208                   expected_filename, actual_filename):
209         """Returns a string containing the diff of the two text strings
210         in 'unified diff' format.
211
212         While this is a generic routine, we include it in the Port
213         interface so that it can be overriden for testing purposes."""
214
215         # The filenames show up in the diff output, make sure they're
216         # raw bytes and not unicode, so that they don't trigger join()
217         # trying to decode the input.
218         def to_raw_bytes(str):
219             if isinstance(str, unicode):
220                 return str.encode('utf-8')
221             return str
222         expected_filename = to_raw_bytes(expected_filename)
223         actual_filename = to_raw_bytes(actual_filename)
224         diff = difflib.unified_diff(expected_text.splitlines(True),
225                                     actual_text.splitlines(True),
226                                     expected_filename,
227                                     actual_filename)
228         return ''.join(diff)
229
230     def driver_name(self):
231         """Returns the name of the actual binary that is performing the test,
232         so that it can be referred to in log messages. In most cases this
233         will be DumpRenderTree, but if a port uses a binary with a different
234         name, it can be overridden here."""
235         return "DumpRenderTree"
236
237     def expected_baselines(self, filename, suffix, all_baselines=False):
238         """Given a test name, finds where the baseline results are located.
239
240         Args:
241         filename: absolute filename to test file
242         suffix: file suffix of the expected results, including dot; e.g.
243             '.txt' or '.png'.  This should not be None, but may be an empty
244             string.
245         all_baselines: If True, return an ordered list of all baseline paths
246             for the given platform. If False, return only the first one.
247         Returns
248         a list of ( platform_dir, results_filename ), where
249             platform_dir - abs path to the top of the results tree (or test
250                 tree)
251             results_filename - relative path from top of tree to the results
252                 file
253             (port.join() of the two gives you the full path to the file,
254                 unless None was returned.)
255         Return values will be in the format appropriate for the current
256         platform (e.g., "\\" for path separators on Windows). If the results
257         file is not found, then None will be returned for the directory,
258         but the expected relative pathname will still be returned.
259
260         This routine is generic but lives here since it is used in
261         conjunction with the other baseline and filename routines that are
262         platform specific.
263         """
264         testname = self._filesystem.splitext(self.relative_test_filename(filename))[0]
265
266         baseline_filename = testname + '-expected' + suffix
267
268         baseline_search_path = self.baseline_search_path()
269
270         baselines = []
271         for platform_dir in baseline_search_path:
272             if self.path_exists(self._filesystem.join(platform_dir,
273                                                       baseline_filename)):
274                 baselines.append((platform_dir, baseline_filename))
275
276             if not all_baselines and baselines:
277                 return baselines
278
279         # If it wasn't found in a platform directory, return the expected
280         # result in the test directory, even if no such file actually exists.
281         platform_dir = self.layout_tests_dir()
282         if self.path_exists(self._filesystem.join(platform_dir,
283                                                   baseline_filename)):
284             baselines.append((platform_dir, baseline_filename))
285
286         if baselines:
287             return baselines
288
289         return [(None, baseline_filename)]
290
291     def expected_filename(self, filename, suffix):
292         """Given a test name, returns an absolute path to its expected results.
293
294         If no expected results are found in any of the searched directories,
295         the directory in which the test itself is located will be returned.
296         The return value is in the format appropriate for the platform
297         (e.g., "\\" for path separators on windows).
298
299         Args:
300         filename: absolute filename to test file
301         suffix: file suffix of the expected results, including dot; e.g. '.txt'
302             or '.png'.  This should not be None, but may be an empty string.
303         platform: the most-specific directory name to use to build the
304             search list of directories, e.g., 'chromium-win', or
305             'chromium-mac-leopard' (we follow the WebKit format)
306
307         This routine is generic but is implemented here to live alongside
308         the other baseline and filename manipulation routines.
309         """
310         platform_dir, baseline_filename = self.expected_baselines(
311             filename, suffix)[0]
312         if platform_dir:
313             return self._filesystem.join(platform_dir, baseline_filename)
314         return self._filesystem.join(self.layout_tests_dir(), baseline_filename)
315
316     def expected_checksum(self, test):
317         """Returns the checksum of the image we expect the test to produce, or None if it is a text-only test."""
318         path = self.expected_filename(test, '.checksum')
319         if not self.path_exists(path):
320             return None
321         return self._filesystem.read_text_file(path)
322
323     def expected_image(self, test):
324         """Returns the image we expect the test to produce."""
325         path = self.expected_filename(test, '.png')
326         if not self.path_exists(path):
327             return None
328         return self._filesystem.read_binary_file(path)
329
330     def expected_text(self, test):
331         """Returns the text output we expect the test to produce.
332         End-of-line characters are normalized to '\n'."""
333         # FIXME: DRT output is actually utf-8, but since we don't decode the
334         # output from DRT (instead treating it as a binary string), we read the
335         # baselines as a binary string, too.
336         path = self.expected_filename(test, '.txt')
337         if not self.path_exists(path):
338             return ''
339         text = self._filesystem.read_binary_file(path)
340         return text.replace("\r\n", "\n")
341
342     def filename_to_uri(self, filename):
343         """Convert a test file (which is an absolute path) to a URI."""
344         LAYOUTTEST_HTTP_DIR = "http/tests/"
345         LAYOUTTEST_WEBSOCKET_DIR = "http/tests/websocket/tests/"
346
347         relative_path = self.relative_test_filename(filename)
348         port = None
349         use_ssl = False
350
351         if (relative_path.startswith(LAYOUTTEST_WEBSOCKET_DIR)
352             or relative_path.startswith(LAYOUTTEST_HTTP_DIR)):
353             relative_path = relative_path[len(LAYOUTTEST_HTTP_DIR):]
354             port = 8000
355
356         # Make http/tests/local run as local files. This is to mimic the
357         # logic in run-webkit-tests.
358         #
359         # TODO(dpranke): remove the media reference and the SSL reference?
360         if (port and not relative_path.startswith("local/") and
361             not relative_path.startswith("media/")):
362             if relative_path.startswith("ssl/"):
363                 port += 443
364                 protocol = "https"
365             else:
366                 protocol = "http"
367             return "%s://127.0.0.1:%u/%s" % (protocol, port, relative_path)
368
369         return path.abspath_to_uri(self._filesystem.abspath(filename))
370
371     def tests(self, paths):
372         """Return the list of tests found (relative to layout_tests_dir()."""
373         return test_files.find(self, paths)
374
375     def test_dirs(self):
376         """Returns the list of top-level test directories.
377
378         Used by --clobber-old-results."""
379         layout_tests_dir = self.layout_tests_dir()
380         return filter(lambda x: self._filesystem.isdir(self._filesystem.join(layout_tests_dir, x)),
381                       self._filesystem.listdir(layout_tests_dir))
382
383     def path_isdir(self, path):
384         """Return True if the path refers to a directory of tests."""
385         # Used by test_expectations.py to apply rules to whole directories.
386         return self._filesystem.isdir(path)
387
388     def path_exists(self, path):
389         """Return True if the path refers to an existing test or baseline."""
390         # Used by test_expectations.py to determine if an entry refers to a
391         # valid test and by printing.py to determine if baselines exist.
392         return self._filesystem.exists(path)
393
394     def driver_cmd_line(self):
395         """Prints the DRT command line that will be used."""
396         driver = self.create_driver(0)
397         return driver.cmd_line()
398
399     def update_baseline(self, path, data, encoding):
400         """Updates the baseline for a test.
401
402         Args:
403             path: the actual path to use for baseline, not the path to
404               the test. This function is used to update either generic or
405               platform-specific baselines, but we can't infer which here.
406             data: contents of the baseline.
407             encoding: file encoding to use for the baseline.
408         """
409         # FIXME: remove the encoding parameter in favor of text/binary
410         # functions.
411         if encoding is None:
412             self._filesystem.write_binary_file(path, data)
413         else:
414             self._filesystem.write_text_file(path, data)
415
416     def uri_to_test_name(self, uri):
417         """Return the base layout test name for a given URI.
418
419         This returns the test name for a given URI, e.g., if you passed in
420         "file:///src/LayoutTests/fast/html/keygen.html" it would return
421         "fast/html/keygen.html".
422
423         """
424         test = uri
425         if uri.startswith("file:///"):
426             prefix = path.abspath_to_uri(self.layout_tests_dir()) + "/"
427             return test[len(prefix):]
428
429         if uri.startswith("http://127.0.0.1:8880/"):
430             # websocket tests
431             return test.replace('http://127.0.0.1:8880/', '')
432
433         if uri.startswith("http://"):
434             # regular HTTP test
435             return test.replace('http://127.0.0.1:8000/', 'http/tests/')
436
437         if uri.startswith("https://"):
438             return test.replace('https://127.0.0.1:8443/', 'http/tests/')
439
440         raise NotImplementedError('unknown url type: %s' % uri)
441
442     def layout_tests_dir(self):
443         """Return the absolute path to the top of the LayoutTests directory."""
444         return self.path_from_webkit_base('LayoutTests')
445
446     def skips_layout_test(self, test_name):
447         """Figures out if the givent test is being skipped or not.
448
449         Test categories are handled as well."""
450         for test_or_category in self.skipped_layout_tests():
451             if test_or_category == test_name:
452                 return True
453             category = self._filesystem.join(self.layout_tests_dir(),
454                                              test_or_category)
455             if (self._filesystem.isdir(category) and
456                 test_name.startswith(test_or_category)):
457                 return True
458         return False
459
460     def maybe_make_directory(self, *path):
461         """Creates the specified directory if it doesn't already exist."""
462         self._filesystem.maybe_make_directory(*path)
463
464     def name(self):
465         """Return the name of the port (e.g., 'mac', 'chromium-win-xp').
466
467         Note that this is different from the test_platform_name(), which
468         may be different (e.g., 'win-xp' instead of 'chromium-win-xp'."""
469         return self._name
470
471     def get_option(self, name, default_value=None):
472         # FIXME: Eventually we should not have to do a test for
473         # hasattr(), and we should be able to just do
474         # self.options.value. See additional FIXME in the constructor.
475         if hasattr(self._options, name):
476             return getattr(self._options, name)
477         return default_value
478
479     def set_option_default(self, name, default_value):
480         if not hasattr(self._options, name):
481             return setattr(self._options, name, default_value)
482
483     def path_from_webkit_base(self, *comps):
484         """Returns the full path to path made by joining the top of the
485         WebKit source tree and the list of path components in |*comps|."""
486         return self._config.path_from_webkit_base(*comps)
487
488     def script_path(self, script_name):
489         return self._config.script_path(script_name)
490
491     def path_to_test_expectations_file(self):
492         """Update the test expectations to the passed-in string.
493
494         This is used by the rebaselining tool. Raises NotImplementedError
495         if the port does not use expectations files."""
496         raise NotImplementedError('Port.path_to_test_expectations_file')
497
498     def relative_test_filename(self, filename):
499         """Relative unix-style path for a filename under the LayoutTests
500         directory. Filenames outside the LayoutTests directory should raise
501         an error."""
502         # FIXME: On Windows, does this return test_names with forward slashes,
503         # or windows-style relative paths?
504         assert filename.startswith(self.layout_tests_dir()), "%s did not start with %s" % (filename, self.layout_tests_dir())
505         return filename[len(self.layout_tests_dir()) + 1:]
506
507     def abspath_for_test(self, test_name):
508         """Returns the full path to the file for a given test name. This is the
509         inverse of relative_test_filename()."""
510         return self._filesystem.normpath(self._filesystem.join(self.layout_tests_dir(), test_name))
511
512     def results_directory(self):
513         """Absolute path to the place to store the test results."""
514         raise NotImplementedError('Port.results_directory')
515
516     def setup_test_run(self):
517         """Perform port-specific work at the beginning of a test run."""
518         pass
519
520     def setup_environ_for_server(self):
521         """Perform port-specific work at the beginning of a server launch.
522
523         Returns:
524            Operating-system's environment.
525         """
526         return os.environ.copy()
527
528     def show_results_html_file(self, results_filename):
529         """This routine should display the HTML file pointed at by
530         results_filename in a users' browser."""
531         return self._user.open_url(results_filename)
532
533     def create_driver(self, worker_number):
534         """Return a newly created base.Driver subclass for starting/stopping
535         the test driver."""
536         raise NotImplementedError('Port.create_driver')
537
538     def start_helper(self):
539         """If a port needs to reconfigure graphics settings or do other
540         things to ensure a known test configuration, it should override this
541         method."""
542         pass
543
544     def start_http_server(self):
545         """Start a web server if it is available. Do nothing if
546         it isn't. This routine is allowed to (and may) fail if a server
547         is already running."""
548         if self.get_option('use_apache'):
549             self._http_server = apache_http_server.LayoutTestApacheHttpd(self,
550                 self.get_option('results_directory'))
551         else:
552             self._http_server = http_server.Lighttpd(self,
553                 self.get_option('results_directory'))
554         self._http_server.start()
555
556     def start_websocket_server(self):
557         """Start a websocket server if it is available. Do nothing if
558         it isn't. This routine is allowed to (and may) fail if a server
559         is already running."""
560         self._websocket_server = websocket_server.PyWebSocket(self,
561             self.get_option('results_directory'))
562         self._websocket_server.start()
563
564     def acquire_http_lock(self):
565         self._http_lock = http_lock.HttpLock(None)
566         self._http_lock.wait_for_httpd_lock()
567
568     def stop_helper(self):
569         """Shut down the test helper if it is running. Do nothing if
570         it isn't, or it isn't available. If a port overrides start_helper()
571         it must override this routine as well."""
572         pass
573
574     def stop_http_server(self):
575         """Shut down the http server if it is running. Do nothing if
576         it isn't, or it isn't available."""
577         if self._http_server:
578             self._http_server.stop()
579
580     def stop_websocket_server(self):
581         """Shut down the websocket server if it is running. Do nothing if
582         it isn't, or it isn't available."""
583         if self._websocket_server:
584             self._websocket_server.stop()
585
586     def release_http_lock(self):
587         if self._http_lock:
588             self._http_lock.cleanup_http_lock()
589
590     #
591     # TEST EXPECTATION-RELATED METHODS
592     #
593
594     def test_configuration(self):
595         """Returns the current TestConfiguration for the port."""
596         if not self._test_configuration:
597             self._test_configuration = TestConfiguration(self)
598         return self._test_configuration
599
600     def all_test_configurations(self):
601         return self.test_configuration().all_test_configurations()
602
603     def test_expectations(self):
604         """Returns the test expectations for this port.
605
606         Basically this string should contain the equivalent of a
607         test_expectations file. See test_expectations.py for more details."""
608         return self._filesystem.read_text_file(self.path_to_test_expectations_file())
609
610     def test_expectations_overrides(self):
611         """Returns an optional set of overrides for the test_expectations.
612
613         This is used by ports that have code in two repositories, and where
614         it is possible that you might need "downstream" expectations that
615         temporarily override the "upstream" expectations until the port can
616         sync up the two repos."""
617         return None
618
619     def test_platform_name(self):
620         """Returns the string that corresponds to the given platform name
621         in the test expectations. This may be the same as name(), or it
622         may be different. For example, chromium returns 'mac' for
623         'chromium-mac'."""
624         raise NotImplementedError('Port.test_platform_name')
625
626     def test_platforms(self):
627         """Returns the list of test platform identifiers as used in the
628         test_expectations and on dashboards, the rebaselining tool, etc.
629
630         Note that this is not necessarily the same as the list of ports,
631         which must be globally unique (e.g., both 'chromium-mac' and 'mac'
632         might return 'mac' as a test_platform name'."""
633         raise NotImplementedError('Port.platforms')
634
635     def test_platform_name_to_name(self, test_platform_name):
636         """Returns the Port platform name that corresponds to the name as
637         referenced in the expectations file. E.g., "mac" returns
638         "chromium-mac" on the Chromium ports."""
639         raise NotImplementedError('Port.test_platform_name_to_name')
640
641     def version(self):
642         """Returns a string indicating the version of a given platform, e.g.
643         '-leopard' or '-xp'.
644
645         This is used to help identify the exact port when parsing test
646         expectations, determining search paths, and logging information."""
647         raise NotImplementedError('Port.version')
648
649     def test_repository_paths(self):
650         """Returns a list of (repository_name, repository_path) tuples
651         of its depending code base.  By default it returns a list that only
652         contains a ('webkit', <webkitRepossitoryPath>) tuple.
653         """
654         return [('webkit', self.layout_tests_dir())]
655
656
657     _WDIFF_DEL = '##WDIFF_DEL##'
658     _WDIFF_ADD = '##WDIFF_ADD##'
659     _WDIFF_END = '##WDIFF_END##'
660
661     def _format_wdiff_output_as_html(self, wdiff):
662         wdiff = cgi.escape(wdiff)
663         wdiff = wdiff.replace(self._WDIFF_DEL, "<span class=del>")
664         wdiff = wdiff.replace(self._WDIFF_ADD, "<span class=add>")
665         wdiff = wdiff.replace(self._WDIFF_END, "</span>")
666         html = "<head><style>.del { background: #faa; } "
667         html += ".add { background: #afa; }</style></head>"
668         html += "<pre>%s</pre>" % wdiff
669         return html
670
671     def _wdiff_command(self, actual_filename, expected_filename):
672         executable = self._path_to_wdiff()
673         return [executable,
674                 "--start-delete=%s" % self._WDIFF_DEL,
675                 "--end-delete=%s" % self._WDIFF_END,
676                 "--start-insert=%s" % self._WDIFF_ADD,
677                 "--end-insert=%s" % self._WDIFF_END,
678                 actual_filename,
679                 expected_filename]
680
681     @staticmethod
682     def _handle_wdiff_error(script_error):
683         # Exit 1 means the files differed, any other exit code is an error.
684         if script_error.exit_code != 1:
685             raise script_error
686
687     def _run_wdiff(self, actual_filename, expected_filename):
688         """Runs wdiff and may throw exceptions.
689         This is mostly a hook for unit testing."""
690         # Diffs are treated as binary as they may include multiple files
691         # with conflicting encodings.  Thus we do not decode the output.
692         command = self._wdiff_command(actual_filename, expected_filename)
693         wdiff = self._executive.run_command(command, decode_output=False,
694             error_handler=self._handle_wdiff_error)
695         return self._format_wdiff_output_as_html(wdiff)
696
697     def wdiff_text(self, actual_filename, expected_filename):
698         """Returns a string of HTML indicating the word-level diff of the
699         contents of the two filenames. Returns an empty string if word-level
700         diffing isn't available."""
701         if not self._wdiff_available:
702             return ""
703         try:
704             # It's possible to raise a ScriptError we pass wdiff invalid paths.
705             return self._run_wdiff(actual_filename, expected_filename)
706         except OSError, e:
707             if e.errno in [errno.ENOENT, errno.EACCES, errno.ECHILD]:
708                 # Silently ignore cases where wdiff is missing.
709                 self._wdiff_available = False
710                 return ""
711             raise
712
713     # This is a class variable so we can test error output easily.
714     _pretty_patch_error_html = "Failed to run PrettyPatch, see error log."
715
716     def pretty_patch_text(self, diff_path):
717         if not self._pretty_patch_available:
718             return self._pretty_patch_error_html
719         command = ("ruby", "-I", self._filesystem.dirname(self._pretty_patch_path),
720                    self._pretty_patch_path, diff_path)
721         try:
722             # Diffs are treated as binary (we pass decode_output=False) as they
723             # may contain multiple files of conflicting encodings.
724             return self._executive.run_command(command, decode_output=False)
725         except OSError, e:
726             # If the system is missing ruby log the error and stop trying.
727             self._pretty_patch_available = False
728             _log.error("Failed to run PrettyPatch (%s): %s" % (command, e))
729             return self._pretty_patch_error_html
730         except ScriptError, e:
731             # If ruby failed to run for some reason, log the command
732             # output and stop trying.
733             self._pretty_patch_available = False
734             _log.error("Failed to run PrettyPatch (%s):\n%s" % (command,
735                        e.message_with_output()))
736             return self._pretty_patch_error_html
737
738     def default_configuration(self):
739         return self._config.default_configuration()
740
741     #
742     # PROTECTED ROUTINES
743     #
744     # The routines below should only be called by routines in this class
745     # or any of its subclasses.
746     #
747     def _webkit_build_directory(self, args):
748         return self._config.build_directory(args[0])
749
750     def _path_to_apache(self):
751         """Returns the full path to the apache binary.
752
753         This is needed only by ports that use the apache_http_server module."""
754         raise NotImplementedError('Port.path_to_apache')
755
756     def _path_to_apache_config_file(self):
757         """Returns the full path to the apache binary.
758
759         This is needed only by ports that use the apache_http_server module."""
760         raise NotImplementedError('Port.path_to_apache_config_file')
761
762     def _path_to_driver(self, configuration=None):
763         """Returns the full path to the test driver (DumpRenderTree)."""
764         raise NotImplementedError('Port._path_to_driver')
765
766     def _path_to_webcore_library(self):
767         """Returns the full path to a built copy of WebCore."""
768         raise NotImplementedError('Port.path_to_webcore_library')
769
770     def _path_to_helper(self):
771         """Returns the full path to the layout_test_helper binary, which
772         is used to help configure the system for the test run, or None
773         if no helper is needed.
774
775         This is likely only used by start/stop_helper()."""
776         raise NotImplementedError('Port._path_to_helper')
777
778     def _path_to_image_diff(self):
779         """Returns the full path to the image_diff binary, or None if it
780         is not available.
781
782         This is likely used only by diff_image()"""
783         raise NotImplementedError('Port.path_to_image_diff')
784
785     def _path_to_lighttpd(self):
786         """Returns the path to the LigHTTPd binary.
787
788         This is needed only by ports that use the http_server.py module."""
789         raise NotImplementedError('Port._path_to_lighttpd')
790
791     def _path_to_lighttpd_modules(self):
792         """Returns the path to the LigHTTPd modules directory.
793
794         This is needed only by ports that use the http_server.py module."""
795         raise NotImplementedError('Port._path_to_lighttpd_modules')
796
797     def _path_to_lighttpd_php(self):
798         """Returns the path to the LigHTTPd PHP executable.
799
800         This is needed only by ports that use the http_server.py module."""
801         raise NotImplementedError('Port._path_to_lighttpd_php')
802
803     def _path_to_wdiff(self):
804         """Returns the full path to the wdiff binary, or None if it is
805         not available.
806
807         This is likely used only by wdiff_text()"""
808         raise NotImplementedError('Port._path_to_wdiff')
809
810     def _shut_down_http_server(self, pid):
811         """Forcefully and synchronously kills the web server.
812
813         This routine should only be called from http_server.py or its
814         subclasses."""
815         raise NotImplementedError('Port._shut_down_http_server')
816
817     def _webkit_baseline_path(self, platform):
818         """Return the  full path to the top of the baseline tree for a
819         given platform."""
820         return self._filesystem.join(self.layout_tests_dir(), 'platform',
821                                      platform)
822
823
824 class DriverInput(object):
825     """Holds the input parameters for a driver."""
826
827     def __init__(self, filename, timeout, image_hash):
828         """Initializes a DriverInput object.
829
830         Args:
831           filename: Full path to the test.
832           timeout: Timeout in msecs the driver should use while running the test
833           image_hash: A image checksum which is used to avoid doing an image dump if
834                      the checksums match.
835         """
836         self.filename = filename
837         self.timeout = timeout
838         self.image_hash = image_hash
839
840
841 class DriverOutput(object):
842     """Groups information about a output from driver for easy passing of data."""
843
844     def __init__(self, text, image, image_hash,
845                  crash=False, test_time=None, timeout=False, error=''):
846         """Initializes a TestOutput object.
847
848         Args:
849           text: a text output
850           image: an image output
851           image_hash: a string containing the checksum of the image
852           crash: a boolean indicating whether the driver crashed on the test
853           test_time: a time which the test has taken
854           timeout: a boolean indicating whehter the test timed out
855           error: any unexpected or additional (or error) text output
856         """
857         self.text = text
858         self.image = image
859         self.image_hash = image_hash
860         self.crash = crash
861         self.test_time = test_time
862         self.timeout = timeout
863         self.error = error
864
865
866 class Driver:
867     """Abstract interface for the DumpRenderTree interface."""
868
869     def __init__(self, port, worker_number):
870         """Initialize a Driver to subsequently run tests.
871
872         Typically this routine will spawn DumpRenderTree in a config
873         ready for subsequent input.
874
875         port - reference back to the port object.
876         worker_number - identifier for a particular worker/driver instance
877         """
878         raise NotImplementedError('Driver.__init__')
879
880     def run_test(self, driver_input):
881         """Run a single test and return the results.
882
883         Note that it is okay if a test times out or crashes and leaves
884         the driver in an indeterminate state. The upper layers of the program
885         are responsible for cleaning up and ensuring things are okay.
886
887         Args:
888           driver_input: a DriverInput object
889
890         Returns a DriverOutput object.
891         """
892         raise NotImplementedError('Driver.run_test')
893
894     # FIXME: This is static so we can test it w/o creating a Base instance.
895     @classmethod
896     def _command_wrapper(cls, wrapper_option):
897         # Hook for injecting valgrind or other runtime instrumentation,
898         # used by e.g. tools/valgrind/valgrind_tests.py.
899         wrapper = []
900         browser_wrapper = os.environ.get("BROWSER_WRAPPER", None)
901         if browser_wrapper:
902             # FIXME: There seems to be no reason to use BROWSER_WRAPPER over --wrapper.
903             # Remove this code any time after the date listed below.
904             _log.error("BROWSER_WRAPPER is deprecated, please use --wrapper instead.")
905             _log.error("BROWSER_WRAPPER will be removed any time after June 1st 2010 and your scripts will break.")
906             wrapper += [browser_wrapper]
907
908         if wrapper_option:
909             wrapper += shlex.split(wrapper_option)
910         return wrapper
911
912     def poll(self):
913         """Returns None if the Driver is still running. Returns the returncode
914         if it has exited."""
915         raise NotImplementedError('Driver.poll')
916
917     def stop(self):
918         raise NotImplementedError('Driver.stop')
919
920
921 class TestConfiguration(object):
922     def __init__(self, port=None, os=None, version=None, architecture=None,
923                  build_type=None, graphics_type=None):
924
925         # FIXME: We can get the O/S and version from test_platform_name()
926         # and version() for now, but those should go away and be cleaned up
927         # with more generic methods like operation_system() and os_version()
928         # or something. Note that we need to strip the leading '-' off the
929         # version string if it is present.
930         if port:
931             port_version = port.version()
932         self.os = os or port.test_platform_name().replace(port_version, '')
933         self.version = version or port_version[1:]
934         self.architecture = architecture or 'x86'
935         self.build_type = build_type or port._options.configuration.lower()
936         self.graphics_type = graphics_type or 'cpu'
937
938     def items(self):
939         return self.__dict__.items()
940
941     def keys(self):
942         return self.__dict__.keys()
943
944     def __str__(self):
945         return ("<%(version)s, %(build_type)s, %(graphics_type)s>" %
946                 self.__dict__)
947
948     def __repr__(self):
949         return "TestConfig(os='%(os)s', version='%(version)s', architecture='%(architecture)s', build_type='%(build_type)s', graphics_type='%(graphics_type)s')" % self.__dict__
950
951     def values(self):
952         """Returns the configuration values of this instance as a tuple."""
953         return self.__dict__.values()
954
955     def all_test_configurations(self):
956         """Returns a sequence of the TestConfigurations the port supports."""
957         # By default, we assume we want to test every graphics type in
958         # every configuration on every system.
959         test_configurations = []
960         for system in self.all_systems():
961             for build_type in self.all_build_types():
962                 for graphics_type in self.all_graphics_types():
963                     test_configurations.append(TestConfiguration(
964                         os=system[0],
965                         version=system[1],
966                         architecture=system[2],
967                         build_type=build_type,
968                         graphics_type=graphics_type))
969         return test_configurations
970
971     def all_systems(self):
972         return (('mac', 'leopard', 'x86'),
973                 ('mac', 'snowleopard', 'x86'),
974                 ('win', 'xp', 'x86'),
975                 ('win', 'vista', 'x86'),
976                 ('win', 'win7', 'x86'),
977                 ('linux', 'hardy', 'x86'))
978
979     def all_build_types(self):
980         return ('debug', 'release')
981
982     def all_graphics_types(self):
983         return ('cpu', 'gpu')