Implement WebKit2 callback equivalent to - [WebUIDelegate webView:setStatusText:]
[WebKit.git] / WebKitTools / WebKitTestRunner / TestController.cpp
1 /*
2  * Copyright (C) 2010 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "TestController.h"
27
28 #include "PlatformWebView.h"
29 #include "StringFunctions.h"
30 #include "TestInvocation.h"
31 #include <WebKit2/WKContextPrivate.h>
32 #include <WebKit2/WKPreferencesPrivate.h>
33 #include <wtf/PassOwnPtr.h>
34
35 namespace WTR {
36
37 static TestController* controller;
38
39 TestController& TestController::shared()
40 {
41     ASSERT(controller);
42     return *controller;
43 }
44
45 TestController::TestController(int argc, const char* argv[])
46     : m_dumpPixels(false)
47     , m_verbose(false)
48     , m_printSeparators(false)
49     , m_usingServerMode(false)
50     , m_state(Initial)
51     , m_doneResetting(false)
52 {
53     initialize(argc, argv);
54     controller = this;
55     run();
56     controller = 0;
57 }
58
59 TestController::~TestController()
60 {
61 }
62
63 static void closeOtherPage(WKPageRef page, const void* clientInfo)
64 {
65     WKPageClose(page);
66     const PlatformWebView* view = static_cast<const PlatformWebView*>(clientInfo);
67     delete view;
68 }
69
70 static WKPageRef createOtherPage(WKPageRef oldPage, const void*)
71 {
72     PlatformWebView* view = new PlatformWebView(WKPageGetPageNamespace(oldPage));
73     WKPageRef newPage = view->page();
74
75     view->resizeTo(800, 600);
76
77     WKPageUIClient otherPageUIClient = {
78         0,
79         view,
80         createOtherPage,
81         0,
82         closeOtherPage,
83         0,
84         0,
85         0,
86         0,
87         0
88     };
89     WKPageSetPageUIClient(newPage, &otherPageUIClient);
90
91     WKRetain(newPage);
92     return newPage;
93 }
94
95 void TestController::initialize(int argc, const char* argv[])
96 {
97     platformInitialize();
98
99     bool printSupportedFeatures = false;
100
101     for (int i = 1; i < argc; ++i) {
102         std::string argument(argv[i]);
103
104         if (argument == "--pixel-tests") {
105             m_dumpPixels = true;
106             continue;
107         }
108         if (argument == "--verbose") {
109             m_verbose = true;
110             continue;
111         }
112         if (argument == "--print-supported-features") {
113             printSupportedFeatures = true;
114             break;
115         }
116
117         // Skip any other arguments that begin with '--'.
118         if (argument.length() >= 2 && argument[0] == '-' && argument[1] == '-')
119             continue;
120
121         m_paths.push_back(argument);
122     }
123
124     if (printSupportedFeatures) {
125         // FIXME: On Windows, DumpRenderTree uses this to expose whether it supports 3d
126         // transforms and accelerated compositing. When we support those features, we
127         // should match DRT's behavior.
128         exit(0);
129     }
130
131     m_usingServerMode = (m_paths.size() == 1 && m_paths[0] == "-");
132     if (m_usingServerMode)
133         m_printSeparators = true;
134     else
135         m_printSeparators = m_paths.size() > 1;
136
137     initializeInjectedBundlePath();
138     initializeTestPluginDirectory();
139
140     m_context.adopt(WKContextCreateWithInjectedBundlePath(injectedBundlePath()));
141     platformInitializeContext();
142
143     WKContextInjectedBundleClient injectedBundleClient = {
144         0,
145         this,
146         didReceiveMessageFromInjectedBundle
147     };
148     WKContextSetInjectedBundleClient(m_context.get(), &injectedBundleClient);
149
150     _WKContextSetAdditionalPluginsDirectory(m_context.get(), testPluginDirectory());
151
152     m_pageNamespace.adopt(WKPageNamespaceCreate(m_context.get()));
153     m_mainWebView = adoptPtr(new PlatformWebView(m_pageNamespace.get()));
154
155     WKPageUIClient pageUIClient = {
156         0,
157         this,
158         createOtherPage,
159         0,
160         0,
161         0,
162         0,
163         0,
164         0,
165         0
166     };
167     WKPageSetPageUIClient(m_mainWebView->page(), &pageUIClient);
168
169     WKPageLoaderClient pageLoaderClient = {
170         0,
171         this,
172         0,
173         0,
174         0,
175         0,
176         0,
177         didFinishLoadForFrame,
178         0,
179         0,
180         0,
181         0,
182         0,
183         0,
184         0,
185         0,
186         0,
187         0,
188         0
189     };
190     WKPageSetPageLoaderClient(m_mainWebView->page(), &pageLoaderClient);
191 }
192
193 void TestController::resetStateToConsistentValues()
194 {
195     m_state = Resetting;
196
197     // FIXME: This function should also ensure that there is only one page open.
198
199     // Reset preferences
200     WKPreferencesRef preferences = WKContextGetPreferences(m_context.get());
201     WKPreferencesSetOfflineWebApplicationCacheEnabled(preferences, true);
202     WKPreferencesSetFontSmoothingLevel(preferences, kWKFontSmoothingLevelNoSubpixelAntiAliasing);
203     WKPreferencesSetXSSAuditorEnabled(preferences, false);
204
205     m_mainWebView->focus();
206
207     // Reset main page back to about:blank
208     m_doneResetting = false;
209
210     WKRetainPtr<WKURLRef> url(AdoptWK, createWKURL("about:blank"));
211     WKPageLoadURL(m_mainWebView->page(), url.get());
212     TestController::runUntil(m_doneResetting);
213 }
214
215 void TestController::runTest(const char* test)
216 {
217     resetStateToConsistentValues();
218
219     m_state = RunningTest;
220     m_currentInvocation.set(new TestInvocation(test));
221     m_currentInvocation->invoke();
222     m_currentInvocation.clear();
223 }
224
225 void TestController::runTestingServerLoop()
226 {
227     char filenameBuffer[2048];
228     while (fgets(filenameBuffer, sizeof(filenameBuffer), stdin)) {
229         char *newLineCharacter = strchr(filenameBuffer, '\n');
230         if (newLineCharacter)
231             *newLineCharacter = '\0';
232
233         if (strlen(filenameBuffer) == 0)
234             continue;
235
236         runTest(filenameBuffer);
237     }
238 }
239
240 void TestController::run()
241 {
242     if (m_usingServerMode)
243         runTestingServerLoop();
244     else {
245         for (size_t i = 0; i < m_paths.size(); ++i)
246             runTest(m_paths[i].c_str());
247     }
248 }
249
250 // WKContextInjectedBundleClient
251
252 void TestController::didReceiveMessageFromInjectedBundle(WKContextRef context, WKStringRef messageName, WKTypeRef messageBody, const void *clientInfo)
253 {
254     static_cast<TestController*>(const_cast<void*>(clientInfo))->didReceiveMessageFromInjectedBundle(messageName, messageBody);
255 }
256
257 void TestController::didReceiveMessageFromInjectedBundle(WKStringRef messageName, WKTypeRef messageBody)
258 {
259     m_currentInvocation->didReceiveMessageFromInjectedBundle(messageName, messageBody);
260 }
261
262 // WKPageLoaderClient
263
264 void TestController::didFinishLoadForFrame(WKPageRef page, WKFrameRef frame, const void* clientInfo)
265 {
266     static_cast<TestController*>(const_cast<void*>(clientInfo))->didFinishLoadForFrame(page, frame);
267 }
268
269 void TestController::didFinishLoadForFrame(WKPageRef page, WKFrameRef frame)
270 {
271     if (m_state != Resetting)
272         return;
273
274     if (!WKFrameIsMainFrame(frame))
275         return;
276
277     WKRetainPtr<WKURLRef> wkURL(AdoptWK, WKFrameCopyURL(frame));
278     RetainPtr<CFURLRef> cfURL= toCF(wkURL);
279     CFStringRef cfURLString = CFURLGetString(cfURL.get());
280     if (!CFEqual(cfURLString, CFSTR("about:blank")))
281         return;
282
283     m_doneResetting = true;
284 }
285
286 } // namespace WTR