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