Rename WebKitTools to Tools
[WebKit-https.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 glob
38 import os
39 import time
40
41 from webkitpy.common.system import logutils
42
43
44 _log = logutils.get_logger(__file__)
45
46
47 # When collecting test cases, we include any file with these extensions.
48 _supported_file_extensions = set(['.html', '.shtml', '.xml', '.xhtml', '.xhtmlmp', '.pl',
49                                   '.php', '.svg'])
50 # When collecting test cases, skip these directories
51 _skipped_directories = set(['.svn', '_svn', 'resources', 'script-tests'])
52
53
54 def find(port, paths):
55     """Finds the set of tests under port.layout_tests_dir().
56
57     Args:
58       paths: a list of command line paths relative to the layout_tests_dir()
59           to limit the search to. glob patterns are ok.
60     """
61     gather_start_time = time.time()
62     paths_to_walk = set()
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 = os.path.join(port.layout_tests_dir(), path)
69             if path.find('*') > -1:
70                 filenames = glob.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     # Now walk all the paths passed in on the command line and get filenames
79     test_files = set()
80     for path in paths_to_walk:
81         if os.path.isfile(path) and _is_test_file(path):
82             test_files.add(os.path.normpath(path))
83             continue
84
85         for root, dirs, files in os.walk(path):
86             # Don't walk skipped directories or their sub-directories.
87             if os.path.basename(root) in _skipped_directories:
88                 del dirs[:]
89                 continue
90             # This copy and for-in is slightly inefficient, but
91             # the extra walk avoidance consistently shaves .5 seconds
92             # off of total walk() time on my MacBook Pro.
93             for directory in dirs[:]:
94                 if directory in _skipped_directories:
95                     dirs.remove(directory)
96
97             for filename in files:
98                 if _is_test_file(filename):
99                     filename = os.path.join(root, filename)
100                     filename = os.path.normpath(filename)
101                     test_files.add(filename)
102
103     gather_time = time.time() - gather_start_time
104     _log.debug("Test gathering took %f seconds" % gather_time)
105
106     return test_files
107
108
109 def _has_supported_extension(filename):
110     """Return true if filename is one of the file extensions we want to run a
111     test on."""
112     extension = os.path.splitext(filename)[1]
113     return extension in _supported_file_extensions
114
115
116 def _is_reference_html_file(filename):
117     """Return true if the filename points to a reference HTML file."""
118     if (filename.endswith('-expected.html') or
119         filename.endswith('-expected-mismatch.html')):
120         _log.warn("Reftests are not supported - ignoring %s" % filename)
121         return True
122     return False
123
124
125 def _is_test_file(filename):
126     """Return true if the filename points to a test file."""
127     return (_has_supported_extension(filename) and
128             not _is_reference_html_file(filename))