WKTR should know about the JSC extensions to testRunner
[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 #if USE(EO)
49 typedef struct _Eo Ecore_Timer;
50 #else
51 typedef struct _Ecore_Timer Ecore_Timer;
52 #endif
53 typedef Ecore_Timer* PlatformTimerRef;
54 #endif
55
56 namespace WTR {
57
58 class TestRunner : public JSWrappable {
59 public:
60     static PassRefPtr<TestRunner> create();
61     virtual ~TestRunner();
62
63     // JSWrappable
64     virtual JSClassRef wrapperClass();
65
66     void makeWindowObject(JSContextRef, JSObjectRef windowObject, JSValueRef* exception);
67
68     // The basics.
69     void dumpAsText(bool dumpPixels);
70     void waitForPolicyDelegate();
71     void dumpChildFramesAsText() { m_whatToDump = AllFramesText; }
72     void waitUntilDone();
73     void notifyDone();
74     double preciseTime();
75
76     // Other dumping.
77     void dumpBackForwardList() { m_shouldDumpBackForwardListsForAllWindows = true; }
78     void dumpChildFrameScrollPositions() { m_shouldDumpAllFrameScrollPositions = true; }
79     void dumpEditingCallbacks() { m_dumpEditingCallbacks = true; }
80     void dumpSelectionRect() { m_dumpSelectionRect = true; }
81     void dumpStatusCallbacks() { m_dumpStatusCallbacks = true; }
82     void dumpTitleChanges() { m_dumpTitleChanges = true; }
83     void dumpFullScreenCallbacks() { m_dumpFullScreenCallbacks = true; }
84     void dumpFrameLoadCallbacks() { setShouldDumpFrameLoadCallbacks(true); }
85     void dumpProgressFinishedCallback() { setShouldDumpProgressFinishedCallback(true); }
86     void dumpResourceLoadCallbacks() { m_dumpResourceLoadCallbacks = true; }
87     void dumpResourceResponseMIMETypes() { m_dumpResourceResponseMIMETypes = true; }
88     void dumpWillCacheResponse() { m_dumpWillCacheResponse = true; }
89     void dumpApplicationCacheDelegateCallbacks() { m_dumpApplicationCacheDelegateCallbacks = true; }
90     void dumpDatabaseCallbacks() { m_dumpDatabaseCallbacks = true; }
91     void dumpDOMAsWebArchive() { m_whatToDump = DOMAsWebArchive; }
92
93     void setShouldDumpFrameLoadCallbacks(bool value) { m_dumpFrameLoadCallbacks = value; }
94     void setShouldDumpProgressFinishedCallback(bool value) { m_dumpProgressFinishedCallback = value; }
95
96     // Special options.
97     void keepWebHistory();
98     void setAcceptsEditing(bool value) { m_shouldAllowEditing = value; }
99     void setCanOpenWindows(bool);
100     void setCloseRemainingWindowsWhenComplete(bool value) { m_shouldCloseExtraWindows = value; }
101     void setXSSAuditorEnabled(bool);
102     void setAllowUniversalAccessFromFileURLs(bool);
103     void setAllowFileAccessFromFileURLs(bool);
104     void setPluginsEnabled(bool);
105     void setJavaScriptCanAccessClipboard(bool);
106     void setPrivateBrowsingEnabled(bool);
107     void setPopupBlockingEnabled(bool);
108     void setAuthorAndUserStylesEnabled(bool);
109     void setCustomPolicyDelegate(bool enabled, bool permissive = false);
110     void addOriginAccessWhitelistEntry(JSStringRef sourceOrigin, JSStringRef destinationProtocol, JSStringRef destinationHost, bool allowDestinationSubdomains);
111     void removeOriginAccessWhitelistEntry(JSStringRef sourceOrigin, JSStringRef destinationProtocol, JSStringRef destinationHost, bool allowDestinationSubdomains);
112     void setUserStyleSheetEnabled(bool);
113     void setUserStyleSheetLocation(JSStringRef);
114     void setSpatialNavigationEnabled(bool);
115     void setTabKeyCyclesThroughElements(bool);
116     void setSerializeHTTPLoads();
117     void dispatchPendingLoadRequests();
118     void setCacheModel(int);
119     void setAsynchronousSpellCheckingEnabled(bool);
120
121     // Special DOM functions.
122     void clearBackForwardList();
123     void execCommand(JSStringRef name, JSStringRef argument);
124     bool isCommandEnabled(JSStringRef name);
125     unsigned windowCount();
126
127     // Repaint testing.
128     void testRepaint() { m_testRepaint = true; }
129     void repaintSweepHorizontally() { m_testRepaintSweepHorizontally = true; }
130     void display();
131     
132     // UserContent testing.
133     void addUserScript(JSStringRef source, bool runAtStart, bool allFrames);
134     void addUserStyleSheet(JSStringRef source, bool allFrames);
135
136     // Text search testing.
137     bool findString(JSStringRef, JSValueRef optionsArray);
138
139     // Local storage
140     void clearAllDatabases();
141     void setDatabaseQuota(uint64_t);
142     JSRetainPtr<JSStringRef> pathToLocalResource(JSStringRef);
143
144     // Application Cache
145     void clearAllApplicationCaches();
146     void clearApplicationCacheForOrigin(JSStringRef origin);
147     void setAppCacheMaximumSize(uint64_t);
148     long long applicationCacheDiskUsageForOrigin(JSStringRef origin);
149     void setApplicationCacheOriginQuota(unsigned long long);
150     void disallowIncreaseForApplicationCacheQuota();
151     bool shouldDisallowIncreaseForApplicationCacheQuota() { return m_disallowIncreaseForApplicationCacheQuota; }
152     JSValueRef originsWithApplicationCache();
153
154     // Printing
155     bool isPageBoxVisible(int pageIndex);
156     bool isPrinting() { return m_isPrinting; }
157     void setPrinting() { m_isPrinting = true; }
158
159     // Authentication
160     void setHandlesAuthenticationChallenges(bool);
161     void setAuthenticationUsername(JSStringRef);
162     void setAuthenticationPassword(JSStringRef);
163
164     void setValueForUser(JSContextRef, JSValueRef element, JSStringRef value);
165
166     // Audio testing.
167     void setAudioResult(JSContextRef, JSValueRef data);
168
169     void setBlockAllPlugins(bool shouldBlock);
170
171     enum WhatToDump { RenderTree, MainFrameText, AllFramesText, Audio, DOMAsWebArchive };
172     WhatToDump whatToDump() const { return m_whatToDump; }
173
174     bool shouldDumpAllFrameScrollPositions() const { return m_shouldDumpAllFrameScrollPositions; }
175     bool shouldDumpBackForwardListsForAllWindows() const { return m_shouldDumpBackForwardListsForAllWindows; }
176     bool shouldDumpEditingCallbacks() const { return m_dumpEditingCallbacks; }
177     bool shouldDumpMainFrameScrollPosition() const { return m_whatToDump == RenderTree; }
178     bool shouldDumpStatusCallbacks() const { return m_dumpStatusCallbacks; }
179     bool shouldDumpTitleChanges() const { return m_dumpTitleChanges; }
180     bool shouldDumpPixels() const { return m_dumpPixels; }
181     bool shouldDumpFullScreenCallbacks() const { return m_dumpFullScreenCallbacks; }
182     bool shouldDumpFrameLoadCallbacks() const { return m_dumpFrameLoadCallbacks; }
183     bool shouldDumpProgressFinishedCallback() const { return m_dumpProgressFinishedCallback; }
184     bool shouldDumpResourceLoadCallbacks() const { return m_dumpResourceLoadCallbacks; }
185     bool shouldDumpResourceResponseMIMETypes() const { return m_dumpResourceResponseMIMETypes; }
186     bool shouldDumpWillCacheResponse() const { return m_dumpWillCacheResponse; }
187     bool shouldDumpApplicationCacheDelegateCallbacks() const { return m_dumpApplicationCacheDelegateCallbacks; }
188     bool shouldDumpDatabaseCallbacks() const { return m_dumpDatabaseCallbacks; }
189     bool shouldDumpSelectionRect() const { return m_dumpSelectionRect; }
190
191     bool isPolicyDelegateEnabled() const { return m_policyDelegateEnabled; }
192     bool isPolicyDelegatePermissive() const { return m_policyDelegatePermissive; }
193
194     bool waitToDump() const { return m_waitToDump; }
195     void waitToDumpWatchdogTimerFired();
196     void invalidateWaitToDumpWatchdogTimer();
197
198     bool shouldAllowEditing() const { return m_shouldAllowEditing; }
199
200     bool shouldCloseExtraWindowsAfterRunningTest() const { return m_shouldCloseExtraWindows; }
201
202     void evaluateScriptInIsolatedWorld(JSContextRef, unsigned worldID, JSStringRef script);
203     static unsigned worldIDForWorld(WKBundleScriptWorldRef);
204
205     void showWebInspector();
206     void closeWebInspector();
207     void evaluateInWebInspector(long callId, JSStringRef script);
208
209     void setPOSIXLocale(JSStringRef);
210
211     bool willSendRequestReturnsNull() const { return m_willSendRequestReturnsNull; }
212     void setWillSendRequestReturnsNull(bool f) { m_willSendRequestReturnsNull = f; }
213     bool willSendRequestReturnsNullOnRedirect() const { return m_willSendRequestReturnsNullOnRedirect; }
214     void setWillSendRequestReturnsNullOnRedirect(bool f) { m_willSendRequestReturnsNullOnRedirect = f; }
215
216     void setTextDirection(JSStringRef);
217
218     void setShouldStayOnPageAfterHandlingBeforeUnload(bool);
219
220     void setDefersLoading(bool);
221
222     void setStopProvisionalFrameLoads() { m_shouldStopProvisionalFrameLoads = true; }
223     bool shouldStopProvisionalFrameLoads() const { return m_shouldStopProvisionalFrameLoads; }
224     
225     bool globalFlag() const { return m_globalFlag; }
226     void setGlobalFlag(bool value) { m_globalFlag = value; }
227
228     void addChromeInputField(JSValueRef);
229     void removeChromeInputField(JSValueRef);
230     void focusWebView(JSValueRef);
231     void setBackingScaleFactor(double, JSValueRef);
232
233     void setWindowIsKey(bool);
234
235     void callAddChromeInputFieldCallback();
236     void callRemoveChromeInputFieldCallback();
237     void callFocusWebViewCallback();
238     void callSetBackingScaleFactorCallback();
239
240     void overridePreference(JSStringRef preference, JSStringRef value);
241
242     // Cookies testing
243     void setAlwaysAcceptCookies(bool);
244
245     // Custom full screen behavior.
246     void setHasCustomFullScreenBehavior(bool value) { m_customFullScreenBehavior = value; }
247     bool hasCustomFullScreenBehavior() const { return m_customFullScreenBehavior; }
248
249     // Web notifications.
250     void grantWebNotificationPermission(JSStringRef origin);
251     void denyWebNotificationPermission(JSStringRef origin);
252     void removeAllWebNotificationPermissions();
253     void simulateWebNotificationClick(JSValueRef notification);
254
255     // Geolocation.
256     void setGeolocationPermission(bool);
257     void setMockGeolocationPosition(double latitude, double longitude, double accuracy, JSValueRef altitude, JSValueRef altitudeAccuracy, JSValueRef heading, JSValueRef speed);
258     void setMockGeolocationPositionUnavailableError(JSStringRef message);
259
260     JSRetainPtr<JSStringRef> platformName();
261
262     void setPageVisibility(JSStringRef state);
263     void resetPageVisibility();
264
265     bool callShouldCloseOnWebView();
266
267     void setCustomTimeout(int duration);
268
269     // Work queue.
270     void queueBackNavigation(unsigned howFarBackward);
271     void queueForwardNavigation(unsigned howFarForward);
272     void queueLoad(JSStringRef url, JSStringRef target);
273     void queueLoadHTMLString(JSStringRef content, JSStringRef baseURL, JSStringRef unreachableURL);
274     void queueReload();
275     void queueLoadingScript(JSStringRef script);
276     void queueNonLoadingScript(JSStringRef script);
277
278     bool secureEventInputIsEnabled() const;
279     
280     JSValueRef numberOfDFGCompiles(JSValueRef theFunction);
281     JSValueRef neverInlineFunction(JSValueRef theFunction);
282
283 private:
284     static const double waitToDumpWatchdogTimerInterval;
285
286     TestRunner();
287
288     void platformInitialize();
289     void initializeWaitToDumpWatchdogTimerIfNeeded();
290
291     WhatToDump m_whatToDump;
292     bool m_shouldDumpAllFrameScrollPositions;
293     bool m_shouldDumpBackForwardListsForAllWindows;
294
295     bool m_shouldAllowEditing;
296     bool m_shouldCloseExtraWindows;
297
298     bool m_dumpEditingCallbacks;
299     bool m_dumpStatusCallbacks;
300     bool m_dumpTitleChanges;
301     bool m_dumpPixels;
302     bool m_dumpSelectionRect;
303     bool m_dumpFullScreenCallbacks;
304     bool m_dumpFrameLoadCallbacks;
305     bool m_dumpProgressFinishedCallback;
306     bool m_dumpResourceLoadCallbacks;
307     bool m_dumpResourceResponseMIMETypes;
308     bool m_dumpWillCacheResponse;
309     bool m_dumpApplicationCacheDelegateCallbacks;
310     bool m_dumpDatabaseCallbacks;
311     bool m_disallowIncreaseForApplicationCacheQuota;
312     bool m_waitToDump; // True if waitUntilDone() has been called, but notifyDone() has not yet been called.
313     bool m_testRepaint;
314     bool m_testRepaintSweepHorizontally;
315     bool m_isPrinting;
316
317     bool m_willSendRequestReturnsNull;
318     bool m_willSendRequestReturnsNullOnRedirect;
319     bool m_shouldStopProvisionalFrameLoads;
320
321     bool m_policyDelegateEnabled;
322     bool m_policyDelegatePermissive;
323     
324     bool m_globalFlag;
325     bool m_customFullScreenBehavior;
326
327     int m_timeout;
328
329     bool m_userStyleSheetEnabled;
330     WKRetainPtr<WKStringRef> m_userStyleSheetLocation;
331
332     PlatformTimerRef m_waitToDumpWatchdogTimer;
333 };
334
335 } // namespace WTR
336
337 #endif // TestRunner_h