Rename WebKitTools to Tools
[WebKit-https.git] / Tools / Scripts / webkitpy / common / net / layouttestresults.py
1 # Copyright (c) 2010, Google Inc. All rights reserved.
2 #
3 # Redistribution and use in source and binary forms, with or without
4 # modification, are permitted provided that the following conditions are
5 # met:
6 #
7 #     * Redistributions of source code must retain the above copyright
8 # notice, this list of conditions and the following disclaimer.
9 #     * Redistributions in binary form must reproduce the above
10 # copyright notice, this list of conditions and the following disclaimer
11 # in the documentation and/or other materials provided with the
12 # distribution.
13 #     * Neither the name of Google Inc. nor the names of its
14 # contributors may be used to endorse or promote products derived from
15 # this software without specific prior written permission.
16 #
17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #
29 # A module for parsing results.html files generated by old-run-webkit-tests
30
31 from webkitpy.thirdparty.BeautifulSoup import BeautifulSoup, SoupStrainer
32
33
34 # FIXME: This should be unified with all the layout test results code in the layout_tests package
35 # This doesn't belong in common.net, but we don't have a better place for it yet.
36 def path_for_layout_test(test_name):
37     return "LayoutTests/%s" % test_name
38
39
40 # FIXME: This should be unified with all the layout test results code in the layout_tests package
41 # This doesn't belong in common.net, but we don't have a better place for it yet.
42 class LayoutTestResults(object):
43     """This class knows how to parse old-run-webkit-tests results.html files."""
44
45     stderr_key = u'Tests that had stderr output:'
46     fail_key = u'Tests where results did not match expected results:'
47     timeout_key = u'Tests that timed out:'
48     crash_key = u'Tests that caused the DumpRenderTree tool to crash:'
49     missing_key = u'Tests that had no expected results (probably new):'
50
51     expected_keys = [
52         stderr_key,
53         fail_key,
54         crash_key,
55         timeout_key,
56         missing_key,
57     ]
58
59     @classmethod
60     def _parse_results_html(cls, page):
61         if not page:
62             return None
63         parsed_results = {}
64         tables = BeautifulSoup(page).findAll("table")
65         for table in tables:
66             table_title = unicode(table.findPreviousSibling("p").string)
67             if table_title not in cls.expected_keys:
68                 # This Exception should only ever be hit if run-webkit-tests changes its results.html format.
69                 raise Exception("Unhandled title: %s" % table_title)
70             # We might want to translate table titles into identifiers before storing.
71             parsed_results[table_title] = [unicode(row.find("a").string) for row in table.findAll("tr")]
72
73         return parsed_results
74
75     @classmethod
76     def results_from_string(cls, string):
77         parsed_results = cls._parse_results_html(string)
78         if not parsed_results:
79             return None
80         return cls(parsed_results)
81
82     def __init__(self, parsed_results):
83         self._parsed_results = parsed_results
84
85     def parsed_results(self):
86         return self._parsed_results
87
88     def results_matching_keys(self, result_keys):
89         return sorted(sum([tests for key, tests in self._parsed_results.items() if key in result_keys], []))
90
91     def failing_tests(self):
92         return self.results_matching_keys([self.fail_key, self.crash_key, self.timeout_key])