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