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