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