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