2c2566cceeeeb46d97228d8f407bd6a4756d8fa9
[WebKit.git] / Tools / WebKitTestRunner / InjectedBundle / LayoutTestController.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 "LayoutTestController.h"
27
28 #include "InjectedBundle.h"
29 #include "InjectedBundlePage.h"
30 #include "JSLayoutTestController.h"
31 #include "StringFunctions.h"
32 #include <WebKit2/WKBundleBackForwardList.h>
33 #include <WebKit2/WKBundleFrame.h>
34 #include <WebKit2/WKBundleFramePrivate.h>
35 #include <WebKit2/WKBundleInspector.h>
36 #include <WebKit2/WKBundlePagePrivate.h>
37 #include <WebKit2/WKBundleScriptWorld.h>
38 #include <WebKit2/WKBundlePrivate.h>
39 #include <WebKit2/WKRetainPtr.h>
40 #include <WebKit2/WebKit2.h>
41 #include <wtf/HashMap.h>
42
43 namespace WTR {
44
45 // This is lower than DumpRenderTree's timeout, to make it easier to work through the failures
46 // Eventually it should be changed to match.
47 const double LayoutTestController::waitToDumpWatchdogTimerInterval = 6;
48
49 static JSValueRef propertyValue(JSContextRef context, JSObjectRef object, const char* propertyName)
50 {
51     if (!object)
52         return 0;
53     JSRetainPtr<JSStringRef> propertyNameString(Adopt, JSStringCreateWithUTF8CString(propertyName));
54     JSValueRef exception;
55     return JSObjectGetProperty(context, object, propertyNameString.get(), &exception);
56 }
57
58 static JSObjectRef propertyObject(JSContextRef context, JSObjectRef object, const char* propertyName)
59 {
60     JSValueRef value = propertyValue(context, object, propertyName);
61     if (!value || !JSValueIsObject(context, value))
62         return 0;
63     return const_cast<JSObjectRef>(value);
64 }
65
66 static JSObjectRef getElementById(WKBundleFrameRef frame, JSStringRef elementId)
67 {
68     JSContextRef context = WKBundleFrameGetJavaScriptContext(frame);
69     JSObjectRef document = propertyObject(context, JSContextGetGlobalObject(context), "document");
70     if (!document)
71         return 0;
72     JSValueRef getElementById = propertyObject(context, document, "getElementById");
73     if (!getElementById || !JSValueIsObject(context, getElementById))
74         return 0;
75     JSValueRef elementIdValue = JSValueMakeString(context, elementId);
76     JSValueRef exception;
77     JSValueRef element = JSObjectCallAsFunction(context, const_cast<JSObjectRef>(getElementById), document, 1, &elementIdValue, &exception);
78     if (!element || !JSValueIsObject(context, element))
79         return 0;
80     return const_cast<JSObjectRef>(element);
81 }
82
83 PassRefPtr<LayoutTestController> LayoutTestController::create()
84 {
85     return adoptRef(new LayoutTestController);
86 }
87
88 LayoutTestController::LayoutTestController()
89     : m_whatToDump(RenderTree)
90     , m_shouldDumpAllFrameScrollPositions(false)
91     , m_shouldDumpBackForwardListsForAllWindows(false)
92     , m_shouldAllowEditing(true)
93     , m_shouldCloseExtraWindows(false)
94     , m_dumpEditingCallbacks(false)
95     , m_dumpStatusCallbacks(false)
96     , m_dumpTitleChanges(false)
97     , m_waitToDump(false)
98     , m_testRepaint(false)
99     , m_testRepaintSweepHorizontally(false)
100 {
101     platformInitialize();
102 }
103
104 LayoutTestController::~LayoutTestController()
105 {
106 }
107
108 JSClassRef LayoutTestController::wrapperClass()
109 {
110     return JSLayoutTestController::layoutTestControllerClass();
111 }
112
113 void LayoutTestController::display()
114 {
115     // FIXME: actually implement, once we want pixel tests
116 }
117
118 void LayoutTestController::waitUntilDone()
119 {
120     m_waitToDump = true;
121     initializeWaitToDumpWatchdogTimerIfNeeded();
122 }
123
124 void LayoutTestController::waitToDumpWatchdogTimerFired()
125 {
126     invalidateWaitToDumpWatchdogTimer();
127     const char* message = "FAIL: Timed out waiting for notifyDone to be called\n";
128     InjectedBundle::shared().os() << message << "\n";
129     InjectedBundle::shared().done();
130 }
131
132 void LayoutTestController::notifyDone()
133 {
134     if (!InjectedBundle::shared().isTestRunning())
135         return;
136
137     if (m_waitToDump && !InjectedBundle::shared().topLoadingFrame())
138         InjectedBundle::shared().page()->dump();
139
140     m_waitToDump = false;
141 }
142
143 unsigned LayoutTestController::numberOfActiveAnimations() const
144 {
145     // FIXME: Is it OK this works only for the main frame?
146     // FIXME: If this is needed only for the main frame, then why is the function on WKBundleFrame instead of WKBundlePage?
147     WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(InjectedBundle::shared().page()->page());
148     return WKBundleFrameGetNumberOfActiveAnimations(mainFrame);
149 }
150
151 bool LayoutTestController::pauseAnimationAtTimeOnElementWithId(JSStringRef animationName, double time, JSStringRef elementId)
152 {
153     // FIXME: Is it OK this works only for the main frame?
154     // FIXME: If this is needed only for the main frame, then why is the function on WKBundleFrame instead of WKBundlePage?
155     WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(InjectedBundle::shared().page()->page());
156     return WKBundleFramePauseAnimationOnElementWithId(mainFrame, toWK(animationName).get(), toWK(elementId).get(), time);
157 }
158
159 void LayoutTestController::suspendAnimations()
160 {
161     WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(InjectedBundle::shared().page()->page());
162     WKBundleFrameSuspendAnimations(mainFrame);
163 }
164
165 void LayoutTestController::resumeAnimations()
166 {
167     WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(InjectedBundle::shared().page()->page());
168     WKBundleFrameResumeAnimations(mainFrame);
169 }
170
171 JSRetainPtr<JSStringRef> LayoutTestController::layerTreeAsText() const
172 {
173     WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(InjectedBundle::shared().page()->page());
174     WKRetainPtr<WKStringRef> text(AdoptWK, WKBundleFrameCopyLayerTreeAsText(mainFrame));
175     return toJS(text);
176 }
177
178 void LayoutTestController::addUserScript(JSStringRef source, bool runAtStart, bool allFrames)
179 {
180     WKRetainPtr<WKStringRef> sourceWK = toWK(source);
181     WKRetainPtr<WKBundleScriptWorldRef> scriptWorld(AdoptWK, WKBundleScriptWorldCreateWorld());
182
183     WKBundleAddUserScript(InjectedBundle::shared().bundle(), InjectedBundle::shared().pageGroup(), scriptWorld.get(), sourceWK.get(), 0, 0, 0,
184         (runAtStart ? kWKInjectAtDocumentStart : kWKInjectAtDocumentEnd),
185         (allFrames ? kWKInjectInAllFrames : kWKInjectInTopFrameOnly));
186 }
187
188 void LayoutTestController::addUserStyleSheet(JSStringRef source, bool allFrames)
189 {
190     WKRetainPtr<WKStringRef> sourceWK = toWK(source);
191     WKRetainPtr<WKBundleScriptWorldRef> scriptWorld(AdoptWK, WKBundleScriptWorldCreateWorld());
192
193     WKBundleAddUserStyleSheet(InjectedBundle::shared().bundle(), InjectedBundle::shared().pageGroup(), scriptWorld.get(), sourceWK.get(), 0, 0, 0,
194         (allFrames ? kWKInjectInAllFrames : kWKInjectInTopFrameOnly));
195 }
196
197 void LayoutTestController::keepWebHistory()
198 {
199     WKBundleSetShouldTrackVisitedLinks(InjectedBundle::shared().bundle(), true);
200 }
201
202 JSValueRef LayoutTestController::computedStyleIncludingVisitedInfo(JSValueRef element)
203 {
204     // FIXME: Is it OK this works only for the main frame?
205     WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(InjectedBundle::shared().page()->page());
206     JSContextRef context = WKBundleFrameGetJavaScriptContext(mainFrame);
207     if (!JSValueIsObject(context, element))
208         return JSValueMakeUndefined(context);
209     JSValueRef value = WKBundleFrameGetComputedStyleIncludingVisitedInfo(mainFrame, const_cast<JSObjectRef>(element));
210     if (!value)
211         return JSValueMakeUndefined(context);
212     return value;
213 }
214
215 JSRetainPtr<JSStringRef> LayoutTestController::counterValueForElementById(JSStringRef elementId)
216 {
217     WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(InjectedBundle::shared().page()->page());
218     JSObjectRef element = getElementById(mainFrame, elementId);
219     if (!element)
220         return 0;
221     WKRetainPtr<WKStringRef> value(AdoptWK, WKBundleFrameCopyCounterValue(mainFrame, const_cast<JSObjectRef>(element)));
222     return toJS(value);
223 }
224
225 JSRetainPtr<JSStringRef> LayoutTestController::markerTextForListItem(JSValueRef element)
226 {
227     WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(InjectedBundle::shared().page()->page());
228     JSContextRef context = WKBundleFrameGetJavaScriptContext(mainFrame);
229     if (!element || !JSValueIsObject(context, element))
230         return 0;
231     WKRetainPtr<WKStringRef> text(AdoptWK, WKBundleFrameCopyMarkerText(mainFrame, const_cast<JSObjectRef>(element)));
232     if (WKStringIsEmpty(text.get()))
233         return 0;
234     return toJS(text);
235 }
236
237 void LayoutTestController::execCommand(JSStringRef name, JSStringRef argument)
238 {
239     WKBundlePageExecuteEditingCommand(InjectedBundle::shared().page()->page(), toWK(name).get(), toWK(argument).get());
240 }
241
242 bool LayoutTestController::findString(JSStringRef target, JSValueRef optionsArrayAsValue)
243 {
244     WKFindOptions options = 0;
245
246     WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(InjectedBundle::shared().page()->page());
247     JSContextRef context = WKBundleFrameGetJavaScriptContext(mainFrame);
248     JSRetainPtr<JSStringRef> lengthPropertyName(Adopt, JSStringCreateWithUTF8CString("length"));
249     JSObjectRef optionsArray = JSValueToObject(context, optionsArrayAsValue, 0);
250     JSValueRef lengthValue = JSObjectGetProperty(context, optionsArray, lengthPropertyName.get(), 0);
251     if (!JSValueIsNumber(context, lengthValue))
252         return false;
253
254     size_t length = static_cast<size_t>(JSValueToNumber(context, lengthValue, 0));
255     for (size_t i = 0; i < length; ++i) {
256         JSValueRef value = JSObjectGetPropertyAtIndex(context, optionsArray, i, 0);
257         if (!JSValueIsString(context, value))
258             continue;
259
260         JSRetainPtr<JSStringRef> optionName(Adopt, JSValueToStringCopy(context, value, 0));
261
262         if (JSStringIsEqualToUTF8CString(optionName.get(), "CaseInsensitive"))
263             options |= kWKFindOptionsCaseInsensitive;
264         else if (JSStringIsEqualToUTF8CString(optionName.get(), "AtWordStarts"))
265             options |= kWKFindOptionsAtWordStarts;
266         else if (JSStringIsEqualToUTF8CString(optionName.get(), "TreatMedialCapitalAsWordStart"))
267             options |= kWKFindOptionsTreatMedialCapitalAsWordStart;
268         else if (JSStringIsEqualToUTF8CString(optionName.get(), "Backwards"))
269             options |= kWKFindOptionsBackwards;
270         else if (JSStringIsEqualToUTF8CString(optionName.get(), "WrapAround"))
271             options |= kWKFindOptionsWrapAround;
272         else if (JSStringIsEqualToUTF8CString(optionName.get(), "StartInSelection")) {
273             // FIXME: No kWKFindOptionsStartInSelection.
274         }
275     }
276
277     return WKBundlePageFindString(InjectedBundle::shared().page()->page(), toWK(target).get(), options);
278 }
279
280 bool LayoutTestController::isCommandEnabled(JSStringRef name)
281 {
282     return WKBundlePageIsEditingCommandEnabled(InjectedBundle::shared().page()->page(), toWK(name).get());
283 }
284
285 void LayoutTestController::setCanOpenWindows(bool)
286 {
287     // It's not clear if or why any tests require opening windows be forbidden.
288     // For now, just ignore this setting, and if we find later it's needed we can add it.
289 }
290
291 void LayoutTestController::setXSSAuditorEnabled(bool enabled)
292 {
293     WKBundleOverrideXSSAuditorEnabledForTestRunner(InjectedBundle::shared().bundle(), InjectedBundle::shared().pageGroup(), true);
294 }
295
296 unsigned LayoutTestController::windowCount()
297 {
298     return InjectedBundle::shared().pageCount();
299 }
300
301 void LayoutTestController::clearBackForwardList()
302 {
303     WKBundleBackForwardListClear(WKBundlePageGetBackForwardList(InjectedBundle::shared().page()->page()));
304 }
305
306 // Object Creation
307
308 void LayoutTestController::makeWindowObject(JSContextRef context, JSObjectRef windowObject, JSValueRef* exception)
309 {
310     setProperty(context, windowObject, "layoutTestController", this, kJSPropertyAttributeReadOnly | kJSPropertyAttributeDontDelete, exception);
311 }
312
313 void LayoutTestController::showWebInspector()
314 {
315     WKBundleInspectorShow(WKBundlePageGetInspector(InjectedBundle::shared().page()->page()));
316 }
317
318 void LayoutTestController::closeWebInspector()
319 {
320     WKBundleInspectorClose(WKBundlePageGetInspector(InjectedBundle::shared().page()->page()));
321 }
322
323 void LayoutTestController::evaluateInWebInspector(long callID, JSStringRef script)
324 {
325     WKRetainPtr<WKStringRef> scriptWK = toWK(script);
326     WKBundleInspectorEvaluateScriptForTest(WKBundlePageGetInspector(InjectedBundle::shared().page()->page()), callID, scriptWK.get());
327 }
328
329 void LayoutTestController::setTimelineProfilingEnabled(bool enabled)
330 {
331     WKBundleInspectorSetPageProfilingEnabled(WKBundlePageGetInspector(InjectedBundle::shared().page()->page()), enabled);
332 }
333
334 typedef WTF::HashMap<unsigned, WKRetainPtr<WKBundleScriptWorldRef> > WorldMap;
335 static WorldMap& worldMap()
336 {
337     static WorldMap& map = *new WorldMap;
338     return map;
339 }
340
341 unsigned LayoutTestController::worldIDForWorld(WKBundleScriptWorldRef world)
342 {
343     WorldMap::const_iterator end = worldMap().end();
344     for (WorldMap::const_iterator it = worldMap().begin(); it != end; ++it) {
345         if (it->second == world)
346             return it->first;
347     }
348
349     return 0;
350 }
351
352 void LayoutTestController::evaluateScriptInIsolatedWorld(JSContextRef context, unsigned worldID, JSStringRef script)
353 {
354     // A worldID of 0 always corresponds to a new world. Any other worldID corresponds to a world
355     // that is created once and cached forever.
356     WKRetainPtr<WKBundleScriptWorldRef> world;
357     if (!worldID)
358         world.adopt(WKBundleScriptWorldCreateWorld());
359     else {
360         WKRetainPtr<WKBundleScriptWorldRef>& worldSlot = worldMap().add(worldID, 0).first->second;
361         if (!worldSlot)
362             worldSlot.adopt(WKBundleScriptWorldCreateWorld());
363         world = worldSlot;
364     }
365
366     WKBundleFrameRef frame = WKBundleFrameForJavaScriptContext(context);
367     if (!frame)
368         frame = WKBundlePageGetMainFrame(InjectedBundle::shared().page()->page());
369
370     JSGlobalContextRef jsContext = WKBundleFrameGetJavaScriptContextForWorld(frame, world.get());
371     JSEvaluateScript(jsContext, script, 0, 0, 0, 0); 
372 }
373
374 void LayoutTestController::setPOSIXLocale(JSStringRef locale)
375 {
376     char localeBuf[32];
377     JSStringGetUTF8CString(locale, localeBuf, sizeof(localeBuf));
378     setlocale(LC_ALL, localeBuf);
379 }
380
381 } // namespace WTR