Add WKTR support for "should open external URLs".
[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 <WebKit/WKBundleScriptWorld.h>
32 #include <WebKit/WKRetainPtr.h>
33 #include <string>
34 #include <wtf/PassRefPtr.h>
35
36 #if PLATFORM(COCOA)
37 #include <wtf/RetainPtr.h>
38 #include <CoreFoundation/CFRunLoop.h>
39 typedef RetainPtr<CFRunLoopTimerRef> PlatformTimerRef;
40 #elif PLATFORM(GTK)
41 #include <wtf/gobject/GMainLoopSource.h>
42 typedef GMainLoopSource PlatformTimerRef;
43 #elif PLATFORM(EFL)
44 typedef Ecore_Timer* PlatformTimerRef;
45 #endif
46
47 namespace WTR {
48
49 class TestRunner : public JSWrappable {
50 public:
51     static PassRefPtr<TestRunner> create();
52     virtual ~TestRunner();
53
54     // JSWrappable
55     virtual JSClassRef wrapperClass();
56
57     void makeWindowObject(JSContextRef, JSObjectRef windowObject, JSValueRef* exception);
58
59     // The basics.
60     WKURLRef testURL() const { return m_testURL.get(); }
61     void setTestURL(WKURLRef url) { m_testURL = url; }
62     void dumpAsText(bool dumpPixels);
63     void waitForPolicyDelegate();
64     void dumpChildFramesAsText() { m_whatToDump = AllFramesText; }
65     void waitUntilDone();
66     void notifyDone();
67     double preciseTime();
68
69     // Other dumping.
70     void dumpBackForwardList() { m_shouldDumpBackForwardListsForAllWindows = true; }
71     void dumpChildFrameScrollPositions() { m_shouldDumpAllFrameScrollPositions = true; }
72     void dumpEditingCallbacks() { m_dumpEditingCallbacks = true; }
73     void dumpSelectionRect() { m_dumpSelectionRect = true; }
74     void dumpStatusCallbacks() { m_dumpStatusCallbacks = true; }
75     void dumpTitleChanges() { m_dumpTitleChanges = true; }
76     void dumpFullScreenCallbacks() { m_dumpFullScreenCallbacks = true; }
77     void dumpFrameLoadCallbacks() { setShouldDumpFrameLoadCallbacks(true); }
78     void dumpProgressFinishedCallback() { setShouldDumpProgressFinishedCallback(true); }
79     void dumpResourceLoadCallbacks() { m_dumpResourceLoadCallbacks = true; }
80     void dumpResourceResponseMIMETypes() { m_dumpResourceResponseMIMETypes = true; }
81     void dumpWillCacheResponse() { m_dumpWillCacheResponse = true; }
82     void dumpApplicationCacheDelegateCallbacks() { m_dumpApplicationCacheDelegateCallbacks = true; }
83     void dumpDatabaseCallbacks() { m_dumpDatabaseCallbacks = true; }
84     void dumpDOMAsWebArchive() { m_whatToDump = DOMAsWebArchive; }
85     void dumpPolicyDelegateCallbacks() { m_dumpPolicyCallbacks = true; }
86
87     void setShouldDumpFrameLoadCallbacks(bool value) { m_dumpFrameLoadCallbacks = value; }
88     void setShouldDumpProgressFinishedCallback(bool value) { m_dumpProgressFinishedCallback = value; }
89
90     // Special options.
91     void keepWebHistory();
92     void setAcceptsEditing(bool value) { m_shouldAllowEditing = value; }
93     void setCanOpenWindows(bool);
94     void setCloseRemainingWindowsWhenComplete(bool value) { m_shouldCloseExtraWindows = value; }
95     void setXSSAuditorEnabled(bool);
96     void setAllowUniversalAccessFromFileURLs(bool);
97     void setAllowFileAccessFromFileURLs(bool);
98     void setPluginsEnabled(bool);
99     void setJavaScriptCanAccessClipboard(bool);
100     void setPrivateBrowsingEnabled(bool);
101     void setPopupBlockingEnabled(bool);
102     void setAuthorAndUserStylesEnabled(bool);
103     void setCustomPolicyDelegate(bool enabled, bool permissive = false);
104     void addOriginAccessWhitelistEntry(JSStringRef sourceOrigin, JSStringRef destinationProtocol, JSStringRef destinationHost, bool allowDestinationSubdomains);
105     void removeOriginAccessWhitelistEntry(JSStringRef sourceOrigin, JSStringRef destinationProtocol, JSStringRef destinationHost, bool allowDestinationSubdomains);
106     void setUserStyleSheetEnabled(bool);
107     void setUserStyleSheetLocation(JSStringRef);
108     void setSpatialNavigationEnabled(bool);
109     void setTabKeyCyclesThroughElements(bool);
110     void setSerializeHTTPLoads();
111     void dispatchPendingLoadRequests();
112     void setCacheModel(int);
113     void setAsynchronousSpellCheckingEnabled(bool);
114
115     // Special DOM functions.
116     void clearBackForwardList();
117     void execCommand(JSStringRef name, JSStringRef argument);
118     bool isCommandEnabled(JSStringRef name);
119     unsigned windowCount();
120
121     // Repaint testing.
122     void testRepaint() { m_testRepaint = true; }
123     void repaintSweepHorizontally() { m_testRepaintSweepHorizontally = true; }
124     void display();
125     
126     // UserContent testing.
127     void addUserScript(JSStringRef source, bool runAtStart, bool allFrames);
128     void addUserStyleSheet(JSStringRef source, bool allFrames);
129
130     // Text search testing.
131     bool findString(JSStringRef, JSValueRef optionsArray);
132
133     // Local storage
134     void clearAllDatabases();
135     void setDatabaseQuota(uint64_t);
136     JSRetainPtr<JSStringRef> pathToLocalResource(JSStringRef);
137
138     // Application Cache
139     void clearAllApplicationCaches();
140     void clearApplicationCacheForOrigin(JSStringRef origin);
141     void setAppCacheMaximumSize(uint64_t);
142     long long applicationCacheDiskUsageForOrigin(JSStringRef origin);
143     void disallowIncreaseForApplicationCacheQuota();
144     bool shouldDisallowIncreaseForApplicationCacheQuota() { return m_disallowIncreaseForApplicationCacheQuota; }
145     JSValueRef originsWithApplicationCache();
146
147     // Printing
148     bool isPageBoxVisible(int pageIndex);
149     bool isPrinting() { return m_isPrinting; }
150     void setPrinting() { m_isPrinting = true; }
151
152     // Authentication
153     void setHandlesAuthenticationChallenges(bool);
154     void setAuthenticationUsername(JSStringRef);
155     void setAuthenticationPassword(JSStringRef);
156
157     void setValueForUser(JSContextRef, JSValueRef element, JSStringRef value);
158
159     // Audio testing.
160     void setAudioResult(JSContextRef, JSValueRef data);
161
162     void setBlockAllPlugins(bool shouldBlock);
163
164     enum WhatToDump { RenderTree, MainFrameText, AllFramesText, Audio, DOMAsWebArchive };
165     WhatToDump whatToDump() const { return m_whatToDump; }
166
167     bool shouldDumpAllFrameScrollPositions() const { return m_shouldDumpAllFrameScrollPositions; }
168     bool shouldDumpBackForwardListsForAllWindows() const { return m_shouldDumpBackForwardListsForAllWindows; }
169     bool shouldDumpEditingCallbacks() const { return m_dumpEditingCallbacks; }
170     bool shouldDumpMainFrameScrollPosition() const { return m_whatToDump == RenderTree; }
171     bool shouldDumpStatusCallbacks() const { return m_dumpStatusCallbacks; }
172     bool shouldDumpTitleChanges() const { return m_dumpTitleChanges; }
173     bool shouldDumpPixels() const { return m_dumpPixels; }
174     bool shouldDumpFullScreenCallbacks() const { return m_dumpFullScreenCallbacks; }
175     bool shouldDumpFrameLoadCallbacks() const { return m_dumpFrameLoadCallbacks; }
176     bool shouldDumpProgressFinishedCallback() const { return m_dumpProgressFinishedCallback; }
177     bool shouldDumpResourceLoadCallbacks() const { return m_dumpResourceLoadCallbacks; }
178     bool shouldDumpResourceResponseMIMETypes() const { return m_dumpResourceResponseMIMETypes; }
179     bool shouldDumpWillCacheResponse() const { return m_dumpWillCacheResponse; }
180     bool shouldDumpApplicationCacheDelegateCallbacks() const { return m_dumpApplicationCacheDelegateCallbacks; }
181     bool shouldDumpDatabaseCallbacks() const { return m_dumpDatabaseCallbacks; }
182     bool shouldDumpSelectionRect() const { return m_dumpSelectionRect; }
183     bool shouldDumpPolicyCallbacks() const { return m_dumpPolicyCallbacks; }
184
185     bool isPolicyDelegateEnabled() const { return m_policyDelegateEnabled; }
186     bool isPolicyDelegatePermissive() const { return m_policyDelegatePermissive; }
187
188     bool waitToDump() const { return m_waitToDump; }
189     void waitToDumpWatchdogTimerFired();
190     void invalidateWaitToDumpWatchdogTimer();
191
192     bool shouldAllowEditing() const { return m_shouldAllowEditing; }
193
194     bool shouldCloseExtraWindowsAfterRunningTest() const { return m_shouldCloseExtraWindows; }
195
196     void evaluateScriptInIsolatedWorld(JSContextRef, unsigned worldID, JSStringRef script);
197     static unsigned worldIDForWorld(WKBundleScriptWorldRef);
198
199     void showWebInspector();
200     void closeWebInspector();
201     void evaluateInWebInspector(JSStringRef script);
202
203     void setPOSIXLocale(JSStringRef);
204
205     bool willSendRequestReturnsNull() const { return m_willSendRequestReturnsNull; }
206     void setWillSendRequestReturnsNull(bool f) { m_willSendRequestReturnsNull = f; }
207     bool willSendRequestReturnsNullOnRedirect() const { return m_willSendRequestReturnsNullOnRedirect; }
208     void setWillSendRequestReturnsNullOnRedirect(bool f) { m_willSendRequestReturnsNullOnRedirect = f; }
209
210     void setTextDirection(JSStringRef);
211
212     void setShouldStayOnPageAfterHandlingBeforeUnload(bool);
213
214     void setDefersLoading(bool);
215
216     void setStopProvisionalFrameLoads() { m_shouldStopProvisionalFrameLoads = true; }
217     bool shouldStopProvisionalFrameLoads() const { return m_shouldStopProvisionalFrameLoads; }
218     
219     bool globalFlag() const { return m_globalFlag; }
220     void setGlobalFlag(bool value) { m_globalFlag = value; }
221
222     double databaseDefaultQuota() const { return m_databaseDefaultQuota; }
223     void setDatabaseDefaultQuota(double quota) { m_databaseDefaultQuota = quota; }
224
225     double databaseMaxQuota() const { return m_databaseMaxQuota; }
226     void setDatabaseMaxQuota(double quota) { m_databaseMaxQuota = quota; }
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     // MediaStream
261     void setUserMediaPermission(bool);
262
263     void setPageVisibility(JSStringRef state);
264     void resetPageVisibility();
265
266     bool callShouldCloseOnWebView();
267
268     void setCustomTimeout(int duration) { m_timeout = duration; }
269
270     // Work queue.
271     void queueBackNavigation(unsigned howFarBackward);
272     void queueForwardNavigation(unsigned howFarForward);
273     void queueLoad(JSStringRef url, JSStringRef target, bool shouldOpenExternalURLs);
274     void queueLoadHTMLString(JSStringRef content, JSStringRef baseURL, JSStringRef unreachableURL);
275     void queueReload();
276     void queueLoadingScript(JSStringRef script);
277     void queueNonLoadingScript(JSStringRef script);
278
279     bool secureEventInputIsEnabled() const;
280     
281     JSValueRef numberOfDFGCompiles(JSValueRef theFunction);
282     JSValueRef neverInlineFunction(JSValueRef theFunction);
283
284 private:
285     TestRunner();
286
287     void platformInitialize();
288     void initializeWaitToDumpWatchdogTimerIfNeeded();
289
290     WKRetainPtr<WKURLRef> m_testURL; // Set by InjectedBundlePage once provisional load starts.
291
292     WhatToDump m_whatToDump;
293     bool m_shouldDumpAllFrameScrollPositions;
294     bool m_shouldDumpBackForwardListsForAllWindows;
295
296     bool m_shouldAllowEditing;
297     bool m_shouldCloseExtraWindows;
298
299     bool m_dumpEditingCallbacks;
300     bool m_dumpStatusCallbacks;
301     bool m_dumpTitleChanges;
302     bool m_dumpPixels;
303     bool m_dumpSelectionRect;
304     bool m_dumpFullScreenCallbacks;
305     bool m_dumpFrameLoadCallbacks;
306     bool m_dumpProgressFinishedCallback;
307     bool m_dumpResourceLoadCallbacks;
308     bool m_dumpResourceResponseMIMETypes;
309     bool m_dumpWillCacheResponse;
310     bool m_dumpApplicationCacheDelegateCallbacks;
311     bool m_dumpDatabaseCallbacks;
312     bool m_dumpPolicyCallbacks { false };
313     bool m_disallowIncreaseForApplicationCacheQuota;
314     bool m_waitToDump; // True if waitUntilDone() has been called, but notifyDone() has not yet been called.
315     bool m_testRepaint;
316     bool m_testRepaintSweepHorizontally;
317     bool m_isPrinting;
318
319     bool m_willSendRequestReturnsNull;
320     bool m_willSendRequestReturnsNullOnRedirect;
321     bool m_shouldStopProvisionalFrameLoads;
322
323     bool m_policyDelegateEnabled;
324     bool m_policyDelegatePermissive;
325     
326     bool m_globalFlag;
327     bool m_customFullScreenBehavior;
328
329     int m_timeout;
330
331     double m_databaseDefaultQuota;
332     double m_databaseMaxQuota;
333
334     bool m_userStyleSheetEnabled;
335     WKRetainPtr<WKStringRef> m_userStyleSheetLocation;
336
337     WKRetainPtr<WKArrayRef> m_allowedHosts;
338
339     PlatformTimerRef m_waitToDumpWatchdogTimer;
340 };
341
342 } // namespace WTR
343
344 #endif // TestRunner_h