2011-01-19 Dirk Pranke <dpranke@chromium.org>
[WebKit.git] / Tools / Scripts / webkitpy / layout_tests / port / test_files.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 """This module is used to find all of the layout test files used by
31 run-webkit-tests. It exposes one public function - find() -
32 which takes an optional list of paths. If a list is passed in, the returned
33 list of test files is constrained to those found under the paths passed in,
34 i.e. calling find(["LayoutTests/fast"]) will only return files
35 under that directory."""
36
37 import time
38
39 from webkitpy.common.system import logutils
40
41
42 _log = logutils.get_logger(__file__)
43
44
45 # When collecting test cases, we include any file with these extensions.
46 _supported_file_extensions = set(['.html', '.shtml', '.xml', '.xhtml', '.xhtmlmp', '.pl',
47                                   '.php', '.svg'])
48 # When collecting test cases, skip these directories
49 _skipped_directories = set(['.svn', '_svn', 'resources', 'script-tests'])
50
51
52 def find(port, paths):
53     """Finds the set of tests under port.layout_tests_dir().
54
55     Args:
56       paths: a list of command line paths relative to the layout_tests_dir()
57           to limit the search to. glob patterns are ok.
58     """
59     fs = port._filesystem
60     gather_start_time = time.time()
61     paths_to_walk = set()
62
63     # if paths is empty, provide a pre-defined list.
64     if paths:
65         _log.debug("Gathering tests from: %s relative to %s" % (paths, port.layout_tests_dir()))
66         for path in paths:
67             # If there's an * in the name, assume it's a glob pattern.
68             path = fs.join(port.layout_tests_dir(), path)
69             if path.find('*') > -1:
70                 filenames = fs.glob(path)
71                 paths_to_walk.update(filenames)
72             else:
73                 paths_to_walk.add(path)
74     else:
75         _log.debug("Gathering tests from: %s" % port.layout_tests_dir())
76         paths_to_walk.add(port.layout_tests_dir())
77
78     # FIXME: I'm not sure there's much point in this being a set. A list would
79     # probably be faster.
80     test_files = set()
81     for path in paths_to_walk:
82         files = fs.files_under(path, _skipped_directories, _is_test_file)
83         test_files.update(set(files))
84
85     gather_time = time.time() - gather_start_time
86     _log.debug("Test gathering took %f seconds" % gather_time)
87
88     return test_files
89
90
91 def _has_supported_extension(fs, filename):
92     """Return true if filename is one of the file extensions we want to run a
93     test on."""
94     extension = fs.splitext(filename)[1]
95     return extension in _supported_file_extensions
96
97
98 def _is_reference_html_file(filename):
99     """Return true if the filename points to a reference HTML file."""
100     if (filename.endswith('-expected.html') or
101         filename.endswith('-expected-mismatch.html')):
102         _log.warn("Reftests are not supported - ignoring %s" % filename)
103         return True
104     return False
105
106
107 def _is_test_file(fs, dirname, filename):
108     """Return true if the filename points to a test file."""
109     return (_has_supported_extension(fs, filename) and
110             not _is_reference_html_file(filename))