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