[chromium] extract normalization of LayoutTests URLs to a method of TestShell
[WebKit.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
58 class DRTDevToolsAgent;
59 class DRTDevToolsCallArgs;
60 class DRTDevToolsClient;
61 class WebPermissions;
62
63 struct TestParams {
64     bool dumpTree;
65     bool dumpPixels;
66     bool debugRenderTree;
67     bool debugLayerTree;
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         , debugRenderTree(false)
78         , debugLayerTree(false)
79         , printSeparators(false) { }
80 };
81
82 class TestShell {
83 public:
84     TestShell(bool testShellMode);
85     ~TestShell();
86
87     // The main WebView.
88     WebKit::WebView* webView() const { return m_webView; }
89     // Returns the host for the main WebView.
90     WebViewHost* webViewHost() const { return m_webViewHost.get(); }
91     LayoutTestController* layoutTestController() const { return m_layoutTestController.get(); }
92     EventSender* eventSender() const { return m_eventSender.get(); }
93     AccessibilityController* accessibilityController() const { return m_accessibilityController.get(); }
94     NotificationPresenter* notificationPresenter() const { return m_notificationPresenter.get(); }
95     TestEventPrinter* printer() const { return m_printer.get(); }
96
97     WebPreferences* preferences() { return &m_prefs; }
98     void applyPreferences() { m_prefs.applyTo(m_webView); }
99
100     WebPermissions* webPermissions() { return m_webPermissions.get(); }
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&);
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 setCompositeToTexture(bool enabled) { m_compositeToTexture = enabled; }
133     void setForceCompositingMode(bool enabled) { m_forceCompositingMode = enabled; }
134     void setAccelerated2dCanvasEnabled(bool enabled) { m_accelerated2dCanvasEnabled = enabled; }
135     void setLegacyAccelerated2dCanvasEnabled(bool enabled) { m_legacyAccelerated2dCanvasEnabled = enabled; }
136     void setAcceleratedDrawingEnabled(bool enabled) { m_acceleratedDrawingEnabled = enabled; }
137 #if defined(OS_WIN)
138     // Access to the finished event. Used by the static WatchDog thread.
139     HANDLE finishedEvent() { return m_finishedEvent; }
140 #endif
141
142     // Get the timeout for running a test in milliseconds.
143     int layoutTestTimeout() { return m_timeout; }
144     int layoutTestTimeoutForWatchDog() { return layoutTestTimeout() + 1000; }
145     void setLayoutTestTimeout(int timeout) { m_timeout = timeout; }
146
147     // V8 JavaScript stress test options.
148     int stressOpt() { return m_stressOpt; }
149     void setStressOpt(bool stressOpt) { m_stressOpt = stressOpt; }
150     int stressDeopt() { return m_stressDeopt; }
151     void setStressDeopt(int stressDeopt) { m_stressDeopt = stressDeopt; }
152
153     // The JavaScript flags specified as a strings.
154     std::string javaScriptFlags() { return m_javaScriptFlags; }
155     void setJavaScriptFlags(std::string javaScriptFlags) { m_javaScriptFlags = javaScriptFlags; }
156
157     // Set whether to dump when the loaded page has finished processing. This is used with multiple load
158     // testing where we only want to have the output from the last load.
159     void setDumpWhenFinished(bool dumpWhenFinished) { m_dumpWhenFinished = dumpWhenFinished; }
160
161     WebViewHost* createNewWindow(const WebKit::WebURL&);
162     void closeWindow(WebViewHost*);
163     void closeRemainingWindows();
164     int windowCount();
165     static void resizeWindowForTest(WebViewHost*, const WebKit::WebURL&);
166
167     void showDevTools();
168     void closeDevTools();
169
170     DRTDevToolsAgent* drtDevToolsAgent() { return m_drtDevToolsAgent.get(); }
171     DRTDevToolsClient* drtDevToolsClient() { return m_drtDevToolsClient.get(); }
172     WebViewHost* devToolsWebView() { return m_devTools; }
173
174     static const int virtualWindowBorder = 3;
175
176     typedef Vector<WebViewHost*> WindowList;
177     WindowList windowList() const { return m_windowList; }
178
179     // Returns a string representation of an URL's spec that does not depend on
180     // the location of the layout test in the file system.
181     std::string normalizeLayoutTestURL(const std::string&);
182
183 private:
184     WebViewHost* createNewWindow(const WebKit::WebURL&, DRTDevToolsAgent*);
185     void createMainWindow();
186     void createDRTDevToolsClient(DRTDevToolsAgent*);
187
188     void resetWebSettings(WebKit::WebView&);
189     void dump();
190     std::string dumpAllBackForwardLists();
191     void dumpImage(SkCanvas*) const;
192
193     bool m_testIsPending;
194     bool m_testIsPreparing;
195     bool m_isLoading;
196     WebKit::WebView* m_webView;
197     WebKit::WebWidget* m_focusedWidget;
198     bool m_testShellMode;
199     WebViewHost* m_devTools;
200
201     // Be careful of the destruction order of the following objects.
202     OwnPtr<TestEventPrinter> m_printer;
203     OwnPtr<WebPermissions> m_webPermissions;
204     OwnPtr<DRTDevToolsAgent> m_drtDevToolsAgent;
205     OwnPtr<DRTDevToolsClient> m_drtDevToolsClient;
206     OwnPtr<AccessibilityController> m_accessibilityController;
207     OwnPtr<EventSender> m_eventSender;
208     OwnPtr<LayoutTestController> m_layoutTestController;
209     OwnPtr<PlainTextController> m_plainTextController;
210     OwnPtr<TextInputController> m_textInputController;
211     OwnPtr<NotificationPresenter> m_notificationPresenter;
212     OwnPtr<WebViewHost> m_webViewHost;
213
214     TestParams m_params;
215     int m_timeout; // timeout value in millisecond
216     bool m_allowExternalPages;
217     bool m_acceleratedCompositingEnabled;
218     bool m_compositeToTexture;
219     bool m_forceCompositingMode;
220     bool m_accelerated2dCanvasEnabled;
221     bool m_legacyAccelerated2dCanvasEnabled;
222     bool m_acceleratedDrawingEnabled;
223     WebPreferences m_prefs;
224     bool m_stressOpt;
225     bool m_stressDeopt;
226     std::string m_javaScriptFlags;
227     bool m_dumpWhenFinished;
228
229
230     // List of all windows in this process.
231     // The main window should be put into windowList[0].
232     WindowList m_windowList;
233
234 #if defined(OS_WIN)
235     // Used by the watchdog to know when it's finished.
236     HANDLE m_finishedEvent;
237 #endif
238
239     // Temporary directory for IndexedDB (LevelDB doesn't support in-memory databases.)
240     OwnPtr<webkit_support::ScopedTempDirectory> m_tempIndexedDBDirectory;
241 };
242
243 void platformInit(int*, char***);
244 void openStartupDialog();
245 bool checkLayoutTestSystemDependencies();
246
247 #endif // TestShell_h