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