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