[Qt] Unreviewed gardening, remove unnecessary expected files.
[WebKit-https.git] / Tools / DumpRenderTree / chromium / TestShell.h
1 /*
2  * Copyright (C) 2012 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
31 #ifndef TestShell_h
32 #define TestShell_h
33
34 #include "AccessibilityController.h"
35 #include "EventSender.h"
36 #include "GamepadController.h"
37 #include "LayoutTestController.h"
38 #include "NotificationPresenter.h"
39 #include "TestEventPrinter.h"
40 #include "TestInterfaces.h"
41 #include "WebPreferences.h"
42 #include "WebViewHost.h"
43 #include <string>
44 #include <wtf/OwnPtr.h>
45 #include <wtf/Vector.h>
46
47 // TestShell is a container of global variables and has bridge functions between
48 // various objects. Only one instance is created in one DRT process.
49
50 namespace WebKit {
51 class WebDevToolsAgentClient;
52 class WebFrame;
53 class WebNotificationPresenter;
54 class WebThread;
55 class WebView;
56 class WebURL;
57 }
58
59 class DRTDevToolsAgent;
60 class DRTDevToolsCallArgs;
61 class DRTDevToolsClient;
62 class MockWebPrerenderingSupport;
63 class WebPermissions;
64
65 struct TestParams {
66     bool dumpTree;
67     bool dumpPixels;
68     bool debugRenderTree;
69     bool debugLayerTree;
70     bool printSeparators;
71     WebKit::WebURL testUrl;
72     std::string pixelHash;
73
74     TestParams()
75         : dumpTree(true)
76         , dumpPixels(false)
77         , debugRenderTree(false)
78         , debugLayerTree(false)
79         , printSeparators(false) { }
80 };
81
82 class TestShell {
83 public:
84     TestShell();
85     ~TestShell();
86
87     void initialize();
88
89     // The main WebView.
90     WebKit::WebView* webView() const { return m_webView; }
91     // Returns the host for the main WebView.
92     WebViewHost* webViewHost() const { return m_webViewHost.get(); }
93     LayoutTestController* layoutTestController() const { return m_layoutTestController.get(); }
94     EventSender* eventSender() const { return m_eventSender.get(); }
95     AccessibilityController* accessibilityController() const { return m_testInterfaces->accessibilityController(); }
96 #if ENABLE(NOTIFICATIONS)
97     NotificationPresenter* notificationPresenter() const { return m_notificationPresenter.get(); }
98 #endif
99     const TestEventPrinter* printer() const { return &m_printer; }
100
101     WebPreferences* preferences() { return &m_prefs; }
102     void applyPreferences() { m_prefs.applyTo(m_webView); }
103
104     WebPermissions* webPermissions() { return m_webPermissions.get(); }
105
106     void bindJSObjectsToWindow(WebKit::WebFrame*);
107     void runFileTest(const TestParams&);
108     void callJSGC();
109     void resetTestController();
110     void waitTestFinished();
111
112     // Operations to the main window.
113     void loadURL(const WebKit::WebURL&);
114     void reload();
115     void goToOffset(int offset);
116     int navigationEntryCount() const;
117
118     void setFocus(WebKit::WebWidget*, bool enable);
119     bool shouldDumpFrameLoadCallbacks() const { return (m_testIsPreparing || m_testIsPending) && layoutTestController()->shouldDumpFrameLoadCallbacks(); }
120     bool shouldDumpUserGestureInFrameLoadCallbacks() const { return (m_testIsPreparing || m_testIsPending) && layoutTestController()->shouldDumpUserGestureInFrameLoadCallbacks(); }
121     bool shouldDumpResourceLoadCallbacks() const  { return (m_testIsPreparing || m_testIsPending) && layoutTestController()->shouldDumpResourceLoadCallbacks(); }
122     bool shouldDumpResourceResponseMIMETypes() const  { return (m_testIsPreparing || m_testIsPending) && layoutTestController()->shouldDumpResourceResponseMIMETypes(); }
123     void setIsLoading(bool flag) { m_isLoading = flag; }
124
125     // Called by the LayoutTestController to signal test completion.
126     void testFinished();
127     // Called by LayoutTestController when a test hits the timeout, but does not
128     // cause a hang. We can avoid killing TestShell in this case and still dump
129     // the test results.
130     void testTimedOut();
131
132     bool allowExternalPages() const { return m_allowExternalPages; }
133     void setAllowExternalPages(bool allowExternalPages) { m_allowExternalPages = allowExternalPages; }
134
135     void setAcceleratedCompositingForVideoEnabled(bool enabled) { m_acceleratedCompositingForVideoEnabled = enabled; }
136     void setThreadedCompositingEnabled(bool enabled) { m_threadedCompositingEnabled = enabled; }
137     void setForceCompositingMode(bool enabled) { m_forceCompositingMode = enabled; }
138     void setAccelerated2dCanvasEnabled(bool enabled) { m_accelerated2dCanvasEnabled = enabled; }
139     void setDeferred2dCanvasEnabled(bool enabled) { m_deferred2dCanvasEnabled = enabled; }
140     void setAcceleratedPaintingEnabled(bool enabled) { m_acceleratedPaintingEnabled = enabled; }
141     void setPerTilePaintingEnabled(bool);
142 #if defined(OS_WIN)
143     // Access to the finished event. Used by the static WatchDog thread.
144     HANDLE finishedEvent() { return m_finishedEvent; }
145 #endif
146
147     // Get the timeout for running a test in milliseconds.
148     int layoutTestTimeout() { return m_timeout; }
149     int layoutTestTimeoutForWatchDog() { return layoutTestTimeout() + 1000; }
150     void setLayoutTestTimeout(int timeout) { m_timeout = timeout; }
151
152     // V8 JavaScript stress test options.
153     int stressOpt() { return m_stressOpt; }
154     void setStressOpt(bool stressOpt) { m_stressOpt = stressOpt; }
155     int stressDeopt() { return m_stressDeopt; }
156     void setStressDeopt(int stressDeopt) { m_stressDeopt = stressDeopt; }
157
158     // The JavaScript flags specified as a strings.
159     std::string javaScriptFlags() { return m_javaScriptFlags; }
160     void setJavaScriptFlags(std::string javaScriptFlags) { m_javaScriptFlags = javaScriptFlags; }
161
162     // Set whether to dump when the loaded page has finished processing. This is used with multiple load
163     // testing where we only want to have the output from the last load.
164     void setDumpWhenFinished(bool dumpWhenFinished) { m_dumpWhenFinished = dumpWhenFinished; }
165
166     void setIsDisplayingModalDialog(bool isDisplayingModalDialog) { m_isDisplayingModalDialog = isDisplayingModalDialog; }
167     bool isDisplayingModalDialog() const { return m_isDisplayingModalDialog; }
168
169     // Set whether the binary data output should be encoded in base64 text.
170     void setEncodeBinary(bool encodeBinary) { m_printer.setEncodeBinary(encodeBinary); }
171
172     WebViewHost* createNewWindow(const WebKit::WebURL&);
173     void closeWindow(WebViewHost*);
174     void closeRemainingWindows();
175     int windowCount();
176     static void resizeWindowForTest(WebViewHost*, const WebKit::WebURL&);
177
178     void showDevTools();
179     void closeDevTools();
180
181     DRTDevToolsAgent* drtDevToolsAgent() { return m_drtDevToolsAgent.get(); }
182     DRTDevToolsClient* drtDevToolsClient() { return m_drtDevToolsClient.get(); }
183     WebViewHost* devToolsWebView() { return m_devTools; }
184
185     static const int virtualWindowBorder = 3;
186
187     typedef Vector<WebViewHost*> WindowList;
188     WindowList windowList() const { return m_windowList; }
189
190     // Returns a string representation of an URL's spec that does not depend on
191     // the location of the layout test in the file system.
192     std::string normalizeLayoutTestURL(const std::string&);
193
194 private:
195     WebViewHost* createNewWindow(const WebKit::WebURL&, DRTDevToolsAgent*);
196     void createMainWindow();
197     void createDRTDevToolsClient(DRTDevToolsAgent*);
198
199     void resetWebSettings(WebKit::WebView&);
200     void dump();
201     std::string dumpAllBackForwardLists();
202     void dumpImage(SkCanvas*) const;
203
204     bool m_testIsPending;
205     bool m_testIsPreparing;
206     bool m_isLoading;
207     WebKit::WebView* m_webView;
208     WebKit::WebWidget* m_focusedWidget;
209     WebViewHost* m_devTools;
210
211     // Be careful of the destruction order of the following objects.
212     TestEventPrinter m_printer;
213     OwnPtr<WebPermissions> m_webPermissions;
214     OwnPtr<DRTDevToolsAgent> m_drtDevToolsAgent;
215     OwnPtr<DRTDevToolsClient> m_drtDevToolsClient;
216     OwnPtr<TestInterfaces> m_testInterfaces;
217     OwnPtr<EventSender> m_eventSender;
218     OwnPtr<LayoutTestController> m_layoutTestController;
219 #if ENABLE(NOTIFICATIONS) || ENABLE(LEGACY_NOTIFICATIONS)
220     OwnPtr<NotificationPresenter> m_notificationPresenter;
221 #endif
222     OwnPtr<WebViewHost> m_webViewHost;
223     OwnPtr<WebKit::WebThread> m_webCompositorThread;
224 #if ENABLE(LINK_PRERENDER)
225     OwnPtr<MockWebPrerenderingSupport> m_prerenderingSupport;
226 #endif
227
228     TestParams m_params;
229     int m_timeout; // timeout value in millisecond
230     bool m_allowExternalPages;
231     bool m_acceleratedCompositingForVideoEnabled;
232     bool m_threadedCompositingEnabled;
233     bool m_forceCompositingMode;
234     bool m_accelerated2dCanvasEnabled;
235     bool m_deferred2dCanvasEnabled;
236     bool m_acceleratedPaintingEnabled;
237     bool m_perTilePaintingEnabled;
238     WebPreferences m_prefs;
239     bool m_stressOpt;
240     bool m_stressDeopt;
241     std::string m_javaScriptFlags;
242     bool m_dumpWhenFinished;
243     bool m_isDisplayingModalDialog;
244
245
246     // List of all windows in this process.
247     // The main window should be put into windowList[0].
248     WindowList m_windowList;
249
250 #if defined(OS_WIN)
251     // Used by the watchdog to know when it's finished.
252     HANDLE m_finishedEvent;
253 #endif
254 };
255
256 void platformInit(int*, char***);
257 void openStartupDialog();
258 bool checkLayoutTestSystemDependencies();
259
260 #endif // TestShell_h