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