[Qt][WK2] Refactor on Qt5 Layout tests' structure
[WebKit-https.git] / Tools / Scripts / webkitpy / layout_tests / port / qt.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 Google name 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 """QtWebKit implementation of the Port interface."""
30
31 import logging
32 import re
33 import sys
34 import os
35
36 import webkit
37
38 from webkitpy.common.memoized import memoized
39 from webkitpy.layout_tests.models.test_configuration import TestConfiguration
40 from webkitpy.layout_tests.port.webkit import WebKitPort
41
42
43 _log = logging.getLogger(__name__)
44
45
46 class QtPort(WebKitPort):
47     ALL_VERSIONS = ['linux', 'win', 'mac']
48     port_name = "qt"
49
50     def _wk2_port_name(self):
51         return "qt-5.0-wk2"
52
53     def _port_flag_for_scripts(self):
54         return "--qt"
55
56     @classmethod
57     def determine_full_port_name(cls, host, options, port_name):
58         if port_name and port_name != cls.port_name:
59             return port_name
60         return port_name + '-' + host.platform.os_name
61
62     # sys_platform exists only for unit testing.
63     def __init__(self, host, port_name, **kwargs):
64         WebKitPort.__init__(self, host, port_name, **kwargs)
65
66         # FIXME: This will allow WebKitPort.baseline_search_path and WebKitPort._skipped_file_search_paths
67         # to do the right thing, but doesn't include support for qt-4.8 or qt-arm (seen in LayoutTests/platform) yet.
68         self._operating_system = port_name.replace('qt-', '')
69
70         # FIXME: Why is this being set at all?
71         self._version = self.operating_system()
72
73     def _generate_all_test_configurations(self):
74         configurations = []
75         for version in self.ALL_VERSIONS:
76             for build_type in self.ALL_BUILD_TYPES:
77                 configurations.append(TestConfiguration(version=version, architecture='x86', build_type=build_type, graphics_type='cpu'))
78         return configurations
79
80     def _build_driver(self):
81         # The Qt port builds DRT as part of the main build step
82         return True
83
84     def _path_to_driver(self):
85         return self._build_path('bin/%s' % self.driver_name())
86
87     def _path_to_image_diff(self):
88         return self._build_path('bin/ImageDiff')
89
90     def _path_to_webcore_library(self):
91         if self.operating_system() == 'mac':
92             return self._build_path('lib/QtWebKit.framework/QtWebKit')
93         else:
94             return self._build_path('lib/libQtWebKit.so')
95
96     @memoized
97     def qt_version(self):
98         version = ''
99         try:
100             for line in self._executive.run_command(['qmake', '-v']).split('\n'):
101                 match = re.search('Qt\sversion\s(?P<version>\d\.\d)', line)
102                 if match:
103                     version = match.group('version')
104                     break
105         except OSError:
106             version = '4.8'
107         return version
108
109     def baseline_search_path(self):
110         search_paths = []
111         if self.get_option('webkit_test_runner'):
112             search_paths.append(self._wk2_port_name())
113         search_paths.append(self.name())
114         version = self.qt_version()
115         if '4.8' in version:
116             search_paths.append('qt-4.8')
117         elif version:
118             search_paths.append('qt-5.0')
119         search_paths.append(self.port_name)
120         return map(self._webkit_baseline_path, search_paths)
121
122     def _skipped_file_search_paths(self):
123         search_paths = set([self.port_name, self.name()])
124         version = self.qt_version()
125         if '4.8' in version:
126             search_paths.add('qt-4.8')
127         elif version:
128             search_paths.add('qt-5.0')
129             if self.get_option('webkit_test_runner'):
130                 search_paths.update(['qt-5.0-wk2', 'wk2'])
131             else:
132                 search_paths.add('qt-5.0-wk1')
133         return search_paths
134
135     def _runtime_feature_list(self):
136         return None
137
138     def setup_environ_for_server(self, server_name=None):
139         clean_env = WebKitPort.setup_environ_for_server(self, server_name)
140         clean_env['QTWEBKIT_PLUGIN_PATH'] = self._build_path('lib/plugins')
141         self._copy_value_from_environ_if_set(clean_env, 'QT_DRT_WEBVIEW_MODE')
142         return clean_env
143
144     # FIXME: We should find a way to share this implmentation with Gtk,
145     # or teach run-launcher how to call run-safari and move this down to WebKitPort.
146     def show_results_html_file(self, results_filename):
147         run_launcher_args = []
148         if self.get_option('webkit_test_runner'):
149             run_launcher_args.append('-2')
150         run_launcher_args.append("file://%s" % results_filename)
151         self._run_script("run-launcher", run_launcher_args)
152
153     def operating_system(self):
154         return self._operating_system
155
156     def check_sys_deps(self, needs_http):
157         result = super(QtPort, self).check_sys_deps(needs_http)
158         if not 'WEBKIT_TESTFONTS' in os.environ:
159             _log.error('\nThe WEBKIT_TESTFONTS environment variable is not defined or not set properly.')
160             _log.error('You must set it before running the tests.')
161             _log.error('Use git to grab the actual fonts from http://gitorious.org/qtwebkit/testfonts')
162             return False
163         return result