Make <a download> a runtime enabled option
[WebKit-https.git] / Tools / WebKitTestRunner / InjectedBundle / TestRunner.h
1 /*
2  * Copyright (C) 2010-2016 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 "StringFunctions.h"
31 #include <JavaScriptCore/JSRetainPtr.h>
32 #include <WebKit/WKBundleScriptWorld.h>
33 #include <WebKit/WKRetainPtr.h>
34 #include <string>
35 #include <wtf/PassRefPtr.h>
36 #include <wtf/text/WTFString.h>
37
38 #if PLATFORM(COCOA)
39 #include <wtf/RetainPtr.h>
40 #include <CoreFoundation/CFRunLoop.h>
41 typedef RetainPtr<CFRunLoopTimerRef> PlatformTimerRef;
42 #elif PLATFORM(GTK)
43 #include <wtf/RunLoop.h>
44 namespace WTR {
45 class TestRunner;
46 typedef RunLoop::Timer<TestRunner> PlatformTimerRef;
47 }
48 #elif PLATFORM(EFL)
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     WKURLRef testURL() const { return m_testURL.get(); }
66     void setTestURL(WKURLRef url) { m_testURL = url; }
67     void dumpAsText(bool dumpPixels);
68     void waitForPolicyDelegate();
69     void dumpChildFramesAsText() { m_whatToDump = AllFramesText; }
70     void waitUntilDownloadFinished();
71     void waitUntilDone();
72     void notifyDone();
73     double preciseTime();
74     double timeout() { return m_timeout; }
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     void dumpPolicyDelegateCallbacks() { m_dumpPolicyCallbacks = true; }
93
94     void setShouldDumpFrameLoadCallbacks(bool value) { m_dumpFrameLoadCallbacks = value; }
95     void setShouldDumpProgressFinishedCallback(bool value) { m_dumpProgressFinishedCallback = value; }
96
97     // Special options.
98     void keepWebHistory();
99     void setAcceptsEditing(bool value) { m_shouldAllowEditing = value; }
100     void setCanOpenWindows(bool);
101     void setCloseRemainingWindowsWhenComplete(bool value) { m_shouldCloseExtraWindows = value; }
102     void setXSSAuditorEnabled(bool);
103     void setShadowDOMEnabled(bool);
104     void setCustomElementsEnabled(bool);
105     void setWebGL2Enabled(bool);
106     void setFetchAPIEnabled(bool);
107     void setAllowUniversalAccessFromFileURLs(bool);
108     void setAllowFileAccessFromFileURLs(bool);
109     void setPluginsEnabled(bool);
110     void setJavaScriptCanAccessClipboard(bool);
111     void setPrivateBrowsingEnabled(bool);
112     void setPopupBlockingEnabled(bool);
113     void setAuthorAndUserStylesEnabled(bool);
114     void setCustomPolicyDelegate(bool enabled, bool permissive = false);
115     void addOriginAccessWhitelistEntry(JSStringRef sourceOrigin, JSStringRef destinationProtocol, JSStringRef destinationHost, bool allowDestinationSubdomains);
116     void removeOriginAccessWhitelistEntry(JSStringRef sourceOrigin, JSStringRef destinationProtocol, JSStringRef destinationHost, bool allowDestinationSubdomains);
117     void setUserStyleSheetEnabled(bool);
118     void setUserStyleSheetLocation(JSStringRef);
119     void setSpatialNavigationEnabled(bool);
120     void setTabKeyCyclesThroughElements(bool);
121     void setSerializeHTTPLoads();
122     void dispatchPendingLoadRequests();
123     void setCacheModel(int);
124     void setAsynchronousSpellCheckingEnabled(bool);
125     void setDownloadAttributeEnabled(bool);
126
127     // Special DOM functions.
128     void clearBackForwardList();
129     void execCommand(JSStringRef name, JSStringRef argument);
130     bool isCommandEnabled(JSStringRef name);
131     unsigned windowCount();
132
133     // Repaint testing.
134     void testRepaint() { m_testRepaint = true; }
135     void repaintSweepHorizontally() { m_testRepaintSweepHorizontally = true; }
136     void display();
137     
138     // UserContent testing.
139     void addUserScript(JSStringRef source, bool runAtStart, bool allFrames);
140     void addUserStyleSheet(JSStringRef source, bool allFrames);
141
142     // Text search testing.
143     bool findString(JSStringRef, JSValueRef optionsArray);
144
145     // Local storage
146     void clearAllDatabases();
147     void setDatabaseQuota(uint64_t);
148     JSRetainPtr<JSStringRef> pathToLocalResource(JSStringRef);
149
150     // Application Cache
151     void clearAllApplicationCaches();
152     void clearApplicationCacheForOrigin(JSStringRef origin);
153     void setAppCacheMaximumSize(uint64_t);
154     long long applicationCacheDiskUsageForOrigin(JSStringRef origin);
155     void disallowIncreaseForApplicationCacheQuota();
156     bool shouldDisallowIncreaseForApplicationCacheQuota() { return m_disallowIncreaseForApplicationCacheQuota; }
157     JSValueRef originsWithApplicationCache();
158
159     // Printing
160     bool isPageBoxVisible(int pageIndex);
161     bool isPrinting() { return m_isPrinting; }
162     void setPrinting() { m_isPrinting = true; }
163
164     // Authentication
165     void setHandlesAuthenticationChallenges(bool);
166     void setAuthenticationUsername(JSStringRef);
167     void setAuthenticationPassword(JSStringRef);
168
169     void setValueForUser(JSContextRef, JSValueRef element, JSStringRef value);
170
171     // Audio testing.
172     void setAudioResult(JSContextRef, JSValueRef data);
173
174     void setBlockAllPlugins(bool shouldBlock);
175
176     enum WhatToDump { RenderTree, MainFrameText, AllFramesText, Audio, DOMAsWebArchive };
177     WhatToDump whatToDump() const { return m_whatToDump; }
178
179     bool shouldDumpAllFrameScrollPositions() const { return m_shouldDumpAllFrameScrollPositions; }
180     bool shouldDumpBackForwardListsForAllWindows() const { return m_shouldDumpBackForwardListsForAllWindows; }
181     bool shouldDumpEditingCallbacks() const { return m_dumpEditingCallbacks; }
182     bool shouldDumpMainFrameScrollPosition() const { return m_whatToDump == RenderTree; }
183     bool shouldDumpStatusCallbacks() const { return m_dumpStatusCallbacks; }
184     bool shouldDumpTitleChanges() const { return m_dumpTitleChanges; }
185     bool shouldDumpPixels() const { return m_dumpPixels; }
186     bool shouldDumpFullScreenCallbacks() const { return m_dumpFullScreenCallbacks; }
187     bool shouldDumpFrameLoadCallbacks() const { return m_dumpFrameLoadCallbacks; }
188     bool shouldDumpProgressFinishedCallback() const { return m_dumpProgressFinishedCallback; }
189     bool shouldDumpResourceLoadCallbacks() const { return m_dumpResourceLoadCallbacks; }
190     bool shouldDumpResourceResponseMIMETypes() const { return m_dumpResourceResponseMIMETypes; }
191     bool shouldDumpWillCacheResponse() const { return m_dumpWillCacheResponse; }
192     bool shouldDumpApplicationCacheDelegateCallbacks() const { return m_dumpApplicationCacheDelegateCallbacks; }
193     bool shouldDumpDatabaseCallbacks() const { return m_dumpDatabaseCallbacks; }
194     bool shouldDumpSelectionRect() const { return m_dumpSelectionRect; }
195     bool shouldDumpPolicyCallbacks() const { return m_dumpPolicyCallbacks; }
196
197     bool isPolicyDelegateEnabled() const { return m_policyDelegateEnabled; }
198     bool isPolicyDelegatePermissive() const { return m_policyDelegatePermissive; }
199
200     bool waitToDump() const { return m_waitToDump; }
201     void waitToDumpWatchdogTimerFired();
202     void invalidateWaitToDumpWatchdogTimer();
203     bool shouldFinishAfterDownload() const { return m_shouldFinishAfterDownload; }
204
205     bool shouldAllowEditing() const { return m_shouldAllowEditing; }
206
207     bool shouldCloseExtraWindowsAfterRunningTest() const { return m_shouldCloseExtraWindows; }
208
209     void evaluateScriptInIsolatedWorld(JSContextRef, unsigned worldID, JSStringRef script);
210     static unsigned worldIDForWorld(WKBundleScriptWorldRef);
211
212     void showWebInspector();
213     void closeWebInspector();
214     void evaluateInWebInspector(JSStringRef script);
215     JSRetainPtr<JSStringRef> inspectorTestStubURL();
216
217     void setPOSIXLocale(JSStringRef);
218
219     bool willSendRequestReturnsNull() const { return m_willSendRequestReturnsNull; }
220     void setWillSendRequestReturnsNull(bool f) { m_willSendRequestReturnsNull = f; }
221     bool willSendRequestReturnsNullOnRedirect() const { return m_willSendRequestReturnsNullOnRedirect; }
222     void setWillSendRequestReturnsNullOnRedirect(bool f) { m_willSendRequestReturnsNullOnRedirect = f; }
223     void setWillSendRequestAddsHTTPBody(JSStringRef body) { m_willSendRequestHTTPBody = toWTFString(toWK(body)); }
224     String willSendRequestHTTPBody() const { return m_willSendRequestHTTPBody; }
225
226     void setTextDirection(JSStringRef);
227
228     void setShouldStayOnPageAfterHandlingBeforeUnload(bool);
229
230     void setDefersLoading(bool);
231
232     void setStopProvisionalFrameLoads() { m_shouldStopProvisionalFrameLoads = true; }
233     bool shouldStopProvisionalFrameLoads() const { return m_shouldStopProvisionalFrameLoads; }
234     
235     bool globalFlag() const { return m_globalFlag; }
236     void setGlobalFlag(bool value) { m_globalFlag = value; }
237
238     double databaseDefaultQuota() const { return m_databaseDefaultQuota; }
239     void setDatabaseDefaultQuota(double quota) { m_databaseDefaultQuota = quota; }
240
241     double databaseMaxQuota() const { return m_databaseMaxQuota; }
242     void setDatabaseMaxQuota(double quota) { m_databaseMaxQuota = quota; }
243
244     void addChromeInputField(JSValueRef);
245     void removeChromeInputField(JSValueRef);
246     void focusWebView(JSValueRef);
247     void setBackingScaleFactor(double, JSValueRef);
248
249     void setWindowIsKey(bool);
250
251     void setViewSize(double width, double height);
252
253     void callAddChromeInputFieldCallback();
254     void callRemoveChromeInputFieldCallback();
255     void callFocusWebViewCallback();
256     void callSetBackingScaleFactorCallback();
257
258     void overridePreference(JSStringRef preference, JSStringRef value);
259
260     // Cookies testing
261     void setAlwaysAcceptCookies(bool);
262
263     // Custom full screen behavior.
264     void setHasCustomFullScreenBehavior(bool value) { m_customFullScreenBehavior = value; }
265     bool hasCustomFullScreenBehavior() const { return m_customFullScreenBehavior; }
266
267     // Web notifications.
268     void grantWebNotificationPermission(JSStringRef origin);
269     void denyWebNotificationPermission(JSStringRef origin);
270     void removeAllWebNotificationPermissions();
271     void simulateWebNotificationClick(JSValueRef notification);
272
273     // Geolocation.
274     void setGeolocationPermission(bool);
275     void setMockGeolocationPosition(double latitude, double longitude, double accuracy, JSValueRef altitude, JSValueRef altitudeAccuracy, JSValueRef heading, JSValueRef speed);
276     void setMockGeolocationPositionUnavailableError(JSStringRef message);
277     bool isGeolocationProviderActive();
278
279     // MediaStream
280     void setUserMediaPermission(bool);
281     void setUserMediaPermissionForOrigin(bool permission, JSStringRef origin, JSStringRef parentOrigin);
282
283     void setPageVisibility(JSStringRef state);
284     void resetPageVisibility();
285
286     bool callShouldCloseOnWebView();
287
288     void setCustomTimeout(int duration) { m_timeout = duration; }
289
290     // Work queue.
291     void queueBackNavigation(unsigned howFarBackward);
292     void queueForwardNavigation(unsigned howFarForward);
293     void queueLoad(JSStringRef url, JSStringRef target, bool shouldOpenExternalURLs);
294     void queueLoadHTMLString(JSStringRef content, JSStringRef baseURL, JSStringRef unreachableURL);
295     void queueReload();
296     void queueLoadingScript(JSStringRef script);
297     void queueNonLoadingScript(JSStringRef script);
298
299     bool secureEventInputIsEnabled() const;
300
301     JSValueRef failNextNewCodeBlock();
302     JSValueRef numberOfDFGCompiles(JSValueRef theFunction);
303     JSValueRef neverInlineFunction(JSValueRef theFunction);
304
305     bool shouldDecideNavigationPolicyAfterDelay() const { return m_shouldDecideNavigationPolicyAfterDelay; }
306     void setShouldDecideNavigationPolicyAfterDelay(bool);
307     void setNavigationGesturesEnabled(bool);
308
309     void runUIScript(JSStringRef script, JSValueRef callback);
310     void runUIScriptCallback(unsigned callbackID, JSStringRef result);
311
312     void installDidBeginSwipeCallback(JSValueRef);
313     void installWillEndSwipeCallback(JSValueRef);
314     void installDidEndSwipeCallback(JSValueRef);
315     void installDidRemoveSwipeSnapshotCallback(JSValueRef);
316     void callDidBeginSwipeCallback();
317     void callWillEndSwipeCallback();
318     void callDidEndSwipeCallback();
319     void callDidRemoveSwipeSnapshotCallback();
320
321     void clearTestRunnerCallbacks();
322
323 private:
324     TestRunner();
325
326     void platformInitialize();
327     void initializeWaitToDumpWatchdogTimerIfNeeded();
328
329     WKRetainPtr<WKURLRef> m_testURL; // Set by InjectedBundlePage once provisional load starts.
330
331     WhatToDump m_whatToDump;
332     bool m_shouldDumpAllFrameScrollPositions;
333     bool m_shouldDumpBackForwardListsForAllWindows;
334
335     bool m_shouldAllowEditing;
336     bool m_shouldCloseExtraWindows;
337
338     bool m_dumpEditingCallbacks;
339     bool m_dumpStatusCallbacks;
340     bool m_dumpTitleChanges;
341     bool m_dumpPixels;
342     bool m_dumpSelectionRect;
343     bool m_dumpFullScreenCallbacks;
344     bool m_dumpFrameLoadCallbacks;
345     bool m_dumpProgressFinishedCallback;
346     bool m_dumpResourceLoadCallbacks;
347     bool m_dumpResourceResponseMIMETypes;
348     bool m_dumpWillCacheResponse;
349     bool m_dumpApplicationCacheDelegateCallbacks;
350     bool m_dumpDatabaseCallbacks;
351     bool m_dumpPolicyCallbacks { false };
352     bool m_disallowIncreaseForApplicationCacheQuota;
353     bool m_waitToDump; // True if waitUntilDone() has been called, but notifyDone() has not yet been called.
354     bool m_testRepaint;
355     bool m_testRepaintSweepHorizontally;
356     bool m_isPrinting;
357
358     bool m_willSendRequestReturnsNull;
359     bool m_willSendRequestReturnsNullOnRedirect;
360     bool m_shouldStopProvisionalFrameLoads;
361     String m_willSendRequestHTTPBody;
362
363     bool m_policyDelegateEnabled;
364     bool m_policyDelegatePermissive;
365     
366     bool m_globalFlag;
367     bool m_customFullScreenBehavior;
368
369     int m_timeout;
370
371     double m_databaseDefaultQuota;
372     double m_databaseMaxQuota;
373
374     bool m_shouldDecideNavigationPolicyAfterDelay { false };
375     bool m_shouldFinishAfterDownload { false };
376
377     bool m_userStyleSheetEnabled;
378     WKRetainPtr<WKStringRef> m_userStyleSheetLocation;
379
380     WKRetainPtr<WKArrayRef> m_allowedHosts;
381
382     PlatformTimerRef m_waitToDumpWatchdogTimer;
383 };
384
385 } // namespace WTR
386
387 #endif // TestRunner_h