WebKitTestRunner needs testRunner.queueLoad
[WebKit-https.git] / Tools / WebKitTestRunner / InjectedBundle / TestRunner.h
1 /*
2  * Copyright (C) 2010, 2011, 2012 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 #ifndef TestRunner_h
27 #define TestRunner_h
28
29 #include "JSWrappable.h"
30 #include <JavaScriptCore/JSRetainPtr.h>
31 #include <WebKit2/WKBundleScriptWorld.h>
32 #include <WebKit2/WKRetainPtr.h>
33 #include <string>
34 #include <wtf/PassRefPtr.h>
35
36 #if PLATFORM(MAC)
37 #include <wtf/RetainPtr.h>
38 #include <CoreFoundation/CFRunLoop.h>
39 typedef RetainPtr<CFRunLoopTimerRef> PlatformTimerRef;
40 #elif PLATFORM(WIN)
41 typedef UINT_PTR PlatformTimerRef;
42 #elif PLATFORM(QT)
43 #include <QTimer>
44 typedef QTimer PlatformTimerRef;
45 #elif PLATFORM(GTK)
46 typedef unsigned int PlatformTimerRef;
47 #elif PLATFORM(EFL)
48 typedef struct _Ecore_Timer Ecore_Timer;
49 typedef Ecore_Timer* PlatformTimerRef;
50 #endif
51
52 namespace WTR {
53
54 class TestRunner : public JSWrappable {
55 public:
56     static PassRefPtr<TestRunner> create();
57     virtual ~TestRunner();
58
59     // JSWrappable
60     virtual JSClassRef wrapperClass();
61
62     void makeWindowObject(JSContextRef, JSObjectRef windowObject, JSValueRef* exception);
63
64     // The basics.
65     void dumpAsText(bool dumpPixels);
66     void waitForPolicyDelegate();
67     void dumpChildFramesAsText() { m_whatToDump = AllFramesText; }
68     void waitUntilDone();
69     void notifyDone();
70     double preciseTime();
71
72     // Other dumping.
73     void dumpBackForwardList() { m_shouldDumpBackForwardListsForAllWindows = true; }
74     void dumpChildFrameScrollPositions() { m_shouldDumpAllFrameScrollPositions = true; }
75     void dumpEditingCallbacks() { m_dumpEditingCallbacks = true; }
76     void dumpSelectionRect() { m_dumpSelectionRect = true; }
77     void dumpStatusCallbacks() { m_dumpStatusCallbacks = true; }
78     void dumpTitleChanges() { m_dumpTitleChanges = true; }
79     void dumpFullScreenCallbacks() { m_dumpFullScreenCallbacks = true; }
80     void dumpFrameLoadCallbacks() { setShouldDumpFrameLoadCallbacks(true); }
81     void dumpProgressFinishedCallback() { setShouldDumpProgressFinishedCallback(true); }
82     void dumpResourceLoadCallbacks() { m_dumpResourceLoadCallbacks = true; }
83     void dumpResourceResponseMIMETypes() { m_dumpResourceResponseMIMETypes = true; }
84     void dumpWillCacheResponse() { m_dumpWillCacheResponse = true; }
85     void dumpApplicationCacheDelegateCallbacks() { m_dumpApplicationCacheDelegateCallbacks = true; }
86     void dumpDatabaseCallbacks() { m_dumpDatabaseCallbacks = true; }
87
88     void setShouldDumpFrameLoadCallbacks(bool value) { m_dumpFrameLoadCallbacks = value; }
89     void setShouldDumpProgressFinishedCallback(bool value) { m_dumpProgressFinishedCallback = value; }
90
91     // Special options.
92     void keepWebHistory();
93     void setAcceptsEditing(bool value) { m_shouldAllowEditing = value; }
94     void setCanOpenWindows(bool);
95     void setCloseRemainingWindowsWhenComplete(bool value) { m_shouldCloseExtraWindows = value; }
96     void setXSSAuditorEnabled(bool);
97     void setAllowUniversalAccessFromFileURLs(bool);
98     void setAllowFileAccessFromFileURLs(bool);
99     void setFrameFlatteningEnabled(bool);
100     void setPluginsEnabled(bool);
101     void setJavaScriptCanAccessClipboard(bool);
102     void setPrivateBrowsingEnabled(bool);
103     void setPopupBlockingEnabled(bool);
104     void setAuthorAndUserStylesEnabled(bool);
105     void setCustomPolicyDelegate(bool enabled, bool permissive = false);
106     void addOriginAccessWhitelistEntry(JSStringRef sourceOrigin, JSStringRef destinationProtocol, JSStringRef destinationHost, bool allowDestinationSubdomains);
107     void removeOriginAccessWhitelistEntry(JSStringRef sourceOrigin, JSStringRef destinationProtocol, JSStringRef destinationHost, bool allowDestinationSubdomains);
108     void setUserStyleSheetEnabled(bool);
109     void setUserStyleSheetLocation(JSStringRef);
110     void setMinimumTimerInterval(double seconds); // Interval specified in seconds.
111     void setSpatialNavigationEnabled(bool);
112     void setTabKeyCyclesThroughElements(bool);
113     void setSerializeHTTPLoads();
114     void dispatchPendingLoadRequests();
115
116     // Special DOM functions.
117     JSValueRef computedStyleIncludingVisitedInfo(JSValueRef element);
118     void clearBackForwardList();
119     void execCommand(JSStringRef name, JSStringRef argument);
120     bool isCommandEnabled(JSStringRef name);
121     JSRetainPtr<JSStringRef> markerTextForListItem(JSValueRef element);
122     unsigned windowCount();
123
124     // Repaint testing.
125     void testRepaint() { m_testRepaint = true; }
126     void repaintSweepHorizontally() { m_testRepaintSweepHorizontally = true; }
127     void display();
128
129     // Animation testing.
130     unsigned numberOfActiveAnimations() const;
131     bool pauseAnimationAtTimeOnElementWithId(JSStringRef animationName, double time, JSStringRef elementId);
132     bool pauseTransitionAtTimeOnElementWithId(JSStringRef propertyName, double time, JSStringRef elementId);
133     void suspendAnimations();
134     
135     // UserContent testing.
136     void addUserScript(JSStringRef source, bool runAtStart, bool allFrames);
137     void addUserStyleSheet(JSStringRef source, bool allFrames);
138
139     // Text search testing.
140     bool findString(JSStringRef, JSValueRef optionsArray);
141
142     // Local storage
143     void clearAllDatabases();
144     void setDatabaseQuota(uint64_t);
145     JSRetainPtr<JSStringRef> pathToLocalResource(JSStringRef);
146
147     // Application Cache
148     void clearAllApplicationCaches();
149     void clearApplicationCacheForOrigin(JSStringRef origin);
150     void setAppCacheMaximumSize(uint64_t);
151     long long applicationCacheDiskUsageForOrigin(JSStringRef origin);
152     void setApplicationCacheOriginQuota(unsigned long long);
153     void disallowIncreaseForApplicationCacheQuota();
154     bool shouldDisallowIncreaseForApplicationCacheQuota() { return m_disallowIncreaseForApplicationCacheQuota; }
155     JSValueRef originsWithApplicationCache();
156
157     // Printing
158     bool isPageBoxVisible(int pageIndex);
159
160     void setValueForUser(JSContextRef, JSValueRef element, JSStringRef value);
161
162     enum WhatToDump { RenderTree, MainFrameText, AllFramesText };
163     WhatToDump whatToDump() const { return m_whatToDump; }
164
165     bool shouldDumpAllFrameScrollPositions() const { return m_shouldDumpAllFrameScrollPositions; }
166     bool shouldDumpBackForwardListsForAllWindows() const { return m_shouldDumpBackForwardListsForAllWindows; }
167     bool shouldDumpEditingCallbacks() const { return m_dumpEditingCallbacks; }
168     bool shouldDumpMainFrameScrollPosition() const { return m_whatToDump == RenderTree; }
169     bool shouldDumpStatusCallbacks() const { return m_dumpStatusCallbacks; }
170     bool shouldDumpTitleChanges() const { return m_dumpTitleChanges; }
171     bool shouldDumpPixels() const { return m_dumpPixels; }
172     bool shouldDumpFullScreenCallbacks() const { return m_dumpFullScreenCallbacks; }
173     bool shouldDumpFrameLoadCallbacks() const { return m_dumpFrameLoadCallbacks; }
174     bool shouldDumpProgressFinishedCallback() const { return m_dumpProgressFinishedCallback; }
175     bool shouldDumpResourceLoadCallbacks() const { return m_dumpResourceLoadCallbacks; }
176     bool shouldDumpResourceResponseMIMETypes() const { return m_dumpResourceResponseMIMETypes; }
177     bool shouldDumpWillCacheResponse() const { return m_dumpWillCacheResponse; }
178     bool shouldDumpApplicationCacheDelegateCallbacks() const { return m_dumpApplicationCacheDelegateCallbacks; }
179     bool shouldDumpDatabaseCallbacks() const { return m_dumpDatabaseCallbacks; }
180     bool shouldDumpSelectionRect() const { return m_dumpSelectionRect; }
181
182     bool isPolicyDelegateEnabled() const { return m_policyDelegateEnabled; }
183     bool isPolicyDelegatePermissive() const { return m_policyDelegatePermissive; }
184
185     bool waitToDump() const { return m_waitToDump; }
186     void waitToDumpWatchdogTimerFired();
187     void invalidateWaitToDumpWatchdogTimer();
188
189     bool shouldAllowEditing() const { return m_shouldAllowEditing; }
190
191     bool shouldCloseExtraWindowsAfterRunningTest() const { return m_shouldCloseExtraWindows; }
192
193     void evaluateScriptInIsolatedWorld(JSContextRef, unsigned worldID, JSStringRef script);
194     static unsigned worldIDForWorld(WKBundleScriptWorldRef);
195
196     void showWebInspector();
197     void closeWebInspector();
198     void evaluateInWebInspector(long callId, JSStringRef script);
199
200     void setPOSIXLocale(JSStringRef);
201
202     bool willSendRequestReturnsNull() const { return m_willSendRequestReturnsNull; }
203     void setWillSendRequestReturnsNull(bool f) { m_willSendRequestReturnsNull = f; }
204     bool willSendRequestReturnsNullOnRedirect() const { return m_willSendRequestReturnsNullOnRedirect; }
205     void setWillSendRequestReturnsNullOnRedirect(bool f) { m_willSendRequestReturnsNullOnRedirect = f; }
206
207     void setTextDirection(JSStringRef);
208
209     void setShouldStayOnPageAfterHandlingBeforeUnload(bool);
210
211     void setDefersLoading(bool);
212
213     void setStopProvisionalFrameLoads() { m_shouldStopProvisionalFrameLoads = true; }
214     bool shouldStopProvisionalFrameLoads() const { return m_shouldStopProvisionalFrameLoads; }
215     
216     bool globalFlag() const { return m_globalFlag; }
217     void setGlobalFlag(bool value) { m_globalFlag = value; }
218
219     unsigned workerThreadCount();
220     
221     void addChromeInputField(JSValueRef);
222     void removeChromeInputField(JSValueRef);
223     void focusWebView(JSValueRef);
224     void setBackingScaleFactor(double, JSValueRef);
225
226     void setWindowIsKey(bool);
227
228     void callAddChromeInputFieldCallback();
229     void callRemoveChromeInputFieldCallback();
230     void callFocusWebViewCallback();
231     void callSetBackingScaleFactorCallback();
232
233     void overridePreference(JSStringRef preference, JSStringRef value);
234
235     // Web intents testing.
236     void sendWebIntentResponse(JSStringRef reply);
237     void deliverWebIntent(JSStringRef action, JSStringRef type, JSStringRef data);
238
239     // Cookies testing
240     void setAlwaysAcceptCookies(bool);
241
242     // Custom full screen behavior.
243     void setHasCustomFullScreenBehavior(bool value) { m_customFullScreenBehavior = value; }
244     bool hasCustomFullScreenBehavior() const { return m_customFullScreenBehavior; }
245
246     // Web notifications.
247     void grantWebNotificationPermission(JSStringRef origin);
248     void denyWebNotificationPermission(JSStringRef origin);
249     void removeAllWebNotificationPermissions();
250     void simulateWebNotificationClick(JSValueRef notification);
251
252     // Geolocation.
253     void setGeolocationPermission(bool);
254     void setMockGeolocationPosition(double latitude, double longitude, double accuracy, JSValueRef altitude, JSValueRef altitudeAccuracy, JSValueRef heading, JSValueRef speed);
255     void setMockGeolocationPositionUnavailableError(JSStringRef message);
256
257     JSRetainPtr<JSStringRef> platformName();
258
259     void setPageVisibility(JSStringRef state);
260     void resetPageVisibility();
261
262     bool callShouldCloseOnWebView();
263
264     void queueBackNavigation(unsigned howFarBackward);
265     void queueLoad(JSStringRef url, JSStringRef target);
266
267 private:
268     static const double waitToDumpWatchdogTimerInterval;
269
270     TestRunner();
271
272     void platformInitialize();
273     void initializeWaitToDumpWatchdogTimerIfNeeded();
274
275     WhatToDump m_whatToDump;
276     bool m_shouldDumpAllFrameScrollPositions;
277     bool m_shouldDumpBackForwardListsForAllWindows;
278
279     bool m_shouldAllowEditing;
280     bool m_shouldCloseExtraWindows;
281
282     bool m_dumpEditingCallbacks;
283     bool m_dumpStatusCallbacks;
284     bool m_dumpTitleChanges;
285     bool m_dumpPixels;
286     bool m_dumpSelectionRect;
287     bool m_dumpFullScreenCallbacks;
288     bool m_dumpFrameLoadCallbacks;
289     bool m_dumpProgressFinishedCallback;
290     bool m_dumpResourceLoadCallbacks;
291     bool m_dumpResourceResponseMIMETypes;
292     bool m_dumpWillCacheResponse;
293     bool m_dumpApplicationCacheDelegateCallbacks;
294     bool m_dumpDatabaseCallbacks;
295     bool m_disallowIncreaseForApplicationCacheQuota;
296     bool m_waitToDump; // True if waitUntilDone() has been called, but notifyDone() has not yet been called.
297     bool m_testRepaint;
298     bool m_testRepaintSweepHorizontally;
299
300     bool m_willSendRequestReturnsNull;
301     bool m_willSendRequestReturnsNullOnRedirect;
302     bool m_shouldStopProvisionalFrameLoads;
303
304     bool m_policyDelegateEnabled;
305     bool m_policyDelegatePermissive;
306     
307     bool m_globalFlag;
308     bool m_customFullScreenBehavior;
309
310     bool m_userStyleSheetEnabled;
311     WKRetainPtr<WKStringRef> m_userStyleSheetLocation;
312
313     PlatformTimerRef m_waitToDumpWatchdogTimer;
314 };
315
316 } // namespace WTR
317
318 #endif // TestRunner_h