2011-01-17 John Knottenbelt <jknotten@chromium.org>
[WebKit-https.git] / Tools / DumpRenderTree / chromium / TestShell.h
1 /*
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
31 #ifndef TestShell_h
32 #define TestShell_h
33
34 #include "AccessibilityController.h"
35 #include "EventSender.h"
36 #include "LayoutTestController.h"
37 #include "NotificationPresenter.h"
38 #include "PlainTextController.h"
39 #include "TestEventPrinter.h"
40 #include "TextInputController.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 WebView;
55 class WebURL;
56 }
57 namespace skia {
58 class PlatformCanvas;
59 }
60
61 class DRTDevToolsAgent;
62 class DRTDevToolsCallArgs;
63 class DRTDevToolsClient;
64
65 struct TestParams {
66     bool dumpTree;
67     bool dumpPixels;
68     bool printSeparators;
69     WebKit::WebURL testUrl;
70     // Resultant image file name. Required only if the test_shell mode.
71     std::string pixelFileName;
72     std::string pixelHash;
73
74     TestParams()
75         : dumpTree(true)
76         , dumpPixels(false)
77         , printSeparators(false) {}
78 };
79
80 class TestShell {
81 public:
82     TestShell(bool testShellMode);
83     ~TestShell();
84
85     // The main WebView.
86     WebKit::WebView* webView() const { return m_webView; }
87     // Returns the host for the main WebView.
88     WebViewHost* webViewHost() const { return m_webViewHost; }
89     LayoutTestController* layoutTestController() const { return m_layoutTestController.get(); }
90     EventSender* eventSender() const { return m_eventSender.get(); }
91     AccessibilityController* accessibilityController() const { return m_accessibilityController.get(); }
92     NotificationPresenter* notificationPresenter() const { return m_notificationPresenter.get(); }
93     TestEventPrinter* printer() const { return m_printer.get(); }
94
95     WebPreferences* preferences() { return &m_prefs; }
96     void applyPreferences() { m_prefs.applyTo(m_webView); }
97
98     void bindJSObjectsToWindow(WebKit::WebFrame*);
99     void runFileTest(const TestParams&);
100     void callJSGC();
101     void resetTestController();
102     void waitTestFinished();
103
104     // Operations to the main window.
105     void loadURL(const WebKit::WebURL& url);
106     void reload();
107     void goToOffset(int offset);
108     int navigationEntryCount() const;
109
110     void setFocus(WebKit::WebWidget*, bool enable);
111     bool shouldDumpFrameLoadCallbacks() const { return (m_testIsPreparing || m_testIsPending) && layoutTestController()->shouldDumpFrameLoadCallbacks(); }
112     bool shouldDumpUserGestureInFrameLoadCallbacks() const { return (m_testIsPreparing || m_testIsPending) && layoutTestController()->shouldDumpUserGestureInFrameLoadCallbacks(); }
113     bool shouldDumpResourceLoadCallbacks() const  { return (m_testIsPreparing || m_testIsPending) && layoutTestController()->shouldDumpResourceLoadCallbacks(); }
114     bool shouldDumpResourceResponseMIMETypes() const  { return (m_testIsPreparing || m_testIsPending) && layoutTestController()->shouldDumpResourceResponseMIMETypes(); }
115     void setIsLoading(bool flag) { m_isLoading = flag; }
116
117     // Called by the LayoutTestController to signal test completion.
118     void testFinished();
119     // Called by LayoutTestController when a test hits the timeout, but does not
120     // cause a hang. We can avoid killing TestShell in this case and still dump
121     // the test results.
122     void testTimedOut();
123
124     bool allowExternalPages() const { return m_allowExternalPages; }
125     void setAllowExternalPages(bool allowExternalPages) { m_allowExternalPages = allowExternalPages; }
126
127     void setAcceleratedCompositingEnabled(bool enabled) { m_acceleratedCompositingEnabled = enabled; }
128     void setAccelerated2dCanvasEnabled(bool enabled) { m_accelerated2dCanvasEnabled = enabled; }
129
130 #if defined(OS_WIN)
131     // Access to the finished event.  Used by the static WatchDog thread.
132     HANDLE finishedEvent() { return m_finishedEvent; }
133 #endif
134
135     // Get the timeout for running a test in milliseconds.
136     int layoutTestTimeout() { return m_timeout; }
137     int layoutTestTimeoutForWatchDog() { return layoutTestTimeout() + 1000; }
138     void setLayoutTestTimeout(int timeout) { m_timeout = timeout; }
139
140     // V8 JavaScript stress test options.
141     int stressOpt() { return m_stressOpt; }
142     void setStressOpt(bool stressOpt) { m_stressOpt = stressOpt; }
143     int stressDeopt() { return m_stressDeopt; }
144     void setStressDeopt(int stressDeopt) { m_stressDeopt = stressDeopt; }
145
146     // The JavaScript flags specified as a strings.
147     std::string javaScriptFlags() { return m_javaScriptFlags; }
148     void setJavaScriptFlags(std::string javaScriptFlags) { m_javaScriptFlags = javaScriptFlags; }
149
150     // Set whether to dump when the loaded page has finished processing. This is used with multiple load
151     // testing where we only want to have the output from the last load.
152     void setDumpWhenFinished(bool dumpWhenFinished) { m_dumpWhenFinished = dumpWhenFinished; }
153
154     WebViewHost* createNewWindow(const WebKit::WebURL&);
155     void closeWindow(WebViewHost*);
156     void closeRemainingWindows();
157     int windowCount();
158     static void resizeWindowForTest(WebViewHost*, const WebKit::WebURL&);
159
160     void showDevTools();
161     void closeDevTools();
162
163     DRTDevToolsAgent* drtDevToolsAgent() { return m_drtDevToolsAgent.get(); }
164     DRTDevToolsClient* drtDevToolsClient() { return m_drtDevToolsClient.get(); }
165     WebViewHost* devToolsWebView() { return m_devTools; }
166
167     static const int virtualWindowBorder = 3;
168
169     typedef Vector<WebViewHost*> WindowList;
170     WindowList windowList() const { return m_windowList; }
171
172 private:
173     WebViewHost* createNewWindow(const WebKit::WebURL&, DRTDevToolsAgent*);
174     void createMainWindow();
175     void createDRTDevToolsClient(DRTDevToolsAgent*);
176
177     void resetWebSettings(WebKit::WebView&);
178     void dump();
179     std::string dumpAllBackForwardLists();
180     void dumpImage(skia::PlatformCanvas*) const;
181
182     bool m_testIsPending;
183     bool m_testIsPreparing;
184     bool m_isLoading;
185     WebKit::WebView* m_webView;
186     WebKit::WebWidget* m_focusedWidget;
187     bool m_testShellMode;
188     WebViewHost* m_webViewHost;
189     WebViewHost* m_devTools;
190     OwnPtr<DRTDevToolsAgent> m_drtDevToolsAgent;
191     OwnPtr<DRTDevToolsClient> m_drtDevToolsClient;
192     OwnPtr<AccessibilityController> m_accessibilityController;
193     OwnPtr<EventSender> m_eventSender;
194     OwnPtr<LayoutTestController> m_layoutTestController;
195     OwnPtr<PlainTextController> m_plainTextController;
196     OwnPtr<TextInputController> m_textInputController;
197     OwnPtr<NotificationPresenter> m_notificationPresenter;
198     OwnPtr<TestEventPrinter> m_printer;
199     TestParams m_params;
200     int m_timeout; // timeout value in millisecond
201     bool m_allowExternalPages;
202     bool m_acceleratedCompositingEnabled;
203     bool m_accelerated2dCanvasEnabled;
204     WebPreferences m_prefs;
205     bool m_stressOpt;
206     bool m_stressDeopt;
207     std::string m_javaScriptFlags;
208     bool m_dumpWhenFinished;
209
210
211     // List of all windows in this process.
212     // The main window should be put into windowList[0].
213     WindowList m_windowList;
214
215 #if defined(OS_WIN)
216     // Used by the watchdog to know when it's finished.
217     HANDLE m_finishedEvent;
218 #endif
219 };
220
221 void platformInit(int*, char***);
222 void openStartupDialog();
223 bool checkLayoutTestSystemDependencies();
224
225 #endif // TestShell_h