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