5ef32ae532347ec42a06f4011e074ef6bfcb755b
[WebKit-https.git] / Tools / WebKitTestRunner / InjectedBundle / TestRunner.h
1 /*
2  * Copyright (C) 2010, 2011, 2012 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 <JavaScriptCore/JSRetainPtr.h>
31 #include <WebKit2/WKBundleScriptWorld.h>
32 #include <WebKit2/WKRetainPtr.h>
33 #include <string>
34 #include <wtf/PassRefPtr.h>
35
36 #if PLATFORM(MAC)
37 #include <wtf/RetainPtr.h>
38 #include <CoreFoundation/CFRunLoop.h>
39 typedef RetainPtr<CFRunLoopTimerRef> PlatformTimerRef;
40 #elif PLATFORM(GTK)
41 typedef unsigned int PlatformTimerRef;
42 #elif PLATFORM(EFL)
43 #if USE(EO)
44 typedef struct _Eo_Opaque Ecore_Timer;
45 #else
46 typedef struct _Ecore_Timer Ecore_Timer;
47 #endif
48 typedef Ecore_Timer* PlatformTimerRef;
49 #endif
50
51 namespace WTR {
52
53 class TestRunner : public JSWrappable {
54 public:
55     static PassRefPtr<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     void dumpAsText(bool dumpPixels);
65     void waitForPolicyDelegate();
66     void dumpChildFramesAsText() { m_whatToDump = AllFramesText; }
67     void waitUntilDone();
68     void notifyDone();
69     double preciseTime();
70
71     // Other dumping.
72     void dumpBackForwardList() { m_shouldDumpBackForwardListsForAllWindows = true; }
73     void dumpChildFrameScrollPositions() { m_shouldDumpAllFrameScrollPositions = true; }
74     void dumpEditingCallbacks() { m_dumpEditingCallbacks = true; }
75     void dumpSelectionRect() { m_dumpSelectionRect = true; }
76     void dumpStatusCallbacks() { m_dumpStatusCallbacks = true; }
77     void dumpTitleChanges() { m_dumpTitleChanges = true; }
78     void dumpFullScreenCallbacks() { m_dumpFullScreenCallbacks = true; }
79     void dumpFrameLoadCallbacks() { setShouldDumpFrameLoadCallbacks(true); }
80     void dumpProgressFinishedCallback() { setShouldDumpProgressFinishedCallback(true); }
81     void dumpResourceLoadCallbacks() { m_dumpResourceLoadCallbacks = true; }
82     void dumpResourceResponseMIMETypes() { m_dumpResourceResponseMIMETypes = true; }
83     void dumpWillCacheResponse() { m_dumpWillCacheResponse = true; }
84     void dumpApplicationCacheDelegateCallbacks() { m_dumpApplicationCacheDelegateCallbacks = true; }
85     void dumpDatabaseCallbacks() { m_dumpDatabaseCallbacks = true; }
86     void dumpDOMAsWebArchive() { m_whatToDump = DOMAsWebArchive; }
87
88     void setShouldDumpFrameLoadCallbacks(bool value) { m_dumpFrameLoadCallbacks = value; }
89     void setShouldDumpProgressFinishedCallback(bool value) { m_dumpProgressFinishedCallback = value; }
90
91     // Special options.
92     void keepWebHistory();
93     void setAcceptsEditing(bool value) { m_shouldAllowEditing = value; }
94     void setCanOpenWindows(bool);
95     void setCloseRemainingWindowsWhenComplete(bool value) { m_shouldCloseExtraWindows = value; }
96     void setXSSAuditorEnabled(bool);
97     void setAllowUniversalAccessFromFileURLs(bool);
98     void setAllowFileAccessFromFileURLs(bool);
99     void setPluginsEnabled(bool);
100     void setJavaScriptCanAccessClipboard(bool);
101     void setPrivateBrowsingEnabled(bool);
102     void setPopupBlockingEnabled(bool);
103     void setAuthorAndUserStylesEnabled(bool);
104     void setCustomPolicyDelegate(bool enabled, bool permissive = false);
105     void addOriginAccessWhitelistEntry(JSStringRef sourceOrigin, JSStringRef destinationProtocol, JSStringRef destinationHost, bool allowDestinationSubdomains);
106     void removeOriginAccessWhitelistEntry(JSStringRef sourceOrigin, JSStringRef destinationProtocol, JSStringRef destinationHost, bool allowDestinationSubdomains);
107     void setUserStyleSheetEnabled(bool);
108     void setUserStyleSheetLocation(JSStringRef);
109     void setSpatialNavigationEnabled(bool);
110     void setTabKeyCyclesThroughElements(bool);
111     void setSerializeHTTPLoads();
112     void dispatchPendingLoadRequests();
113     void setCacheModel(int);
114     void setAsynchronousSpellCheckingEnabled(bool);
115
116     // Special DOM functions.
117     void clearBackForwardList();
118     void execCommand(JSStringRef name, JSStringRef argument);
119     bool isCommandEnabled(JSStringRef name);
120     unsigned windowCount();
121
122     // Repaint testing.
123     void testRepaint() { m_testRepaint = true; }
124     void repaintSweepHorizontally() { m_testRepaintSweepHorizontally = true; }
125     void display();
126     
127     // UserContent testing.
128     void addUserScript(JSStringRef source, bool runAtStart, bool allFrames);
129     void addUserStyleSheet(JSStringRef source, bool allFrames);
130
131     // Text search testing.
132     bool findString(JSStringRef, JSValueRef optionsArray);
133
134     // Local storage
135     void clearAllDatabases();
136     void setDatabaseQuota(uint64_t);
137     JSRetainPtr<JSStringRef> pathToLocalResource(JSStringRef);
138
139     // Application Cache
140     void clearAllApplicationCaches();
141     void clearApplicationCacheForOrigin(JSStringRef origin);
142     void setAppCacheMaximumSize(uint64_t);
143     long long applicationCacheDiskUsageForOrigin(JSStringRef origin);
144     void disallowIncreaseForApplicationCacheQuota();
145     bool shouldDisallowIncreaseForApplicationCacheQuota() { return m_disallowIncreaseForApplicationCacheQuota; }
146     JSValueRef originsWithApplicationCache();
147
148     // Printing
149     bool isPageBoxVisible(int pageIndex);
150     bool isPrinting() { return m_isPrinting; }
151     void setPrinting() { m_isPrinting = true; }
152
153     // Authentication
154     void setHandlesAuthenticationChallenges(bool);
155     void setAuthenticationUsername(JSStringRef);
156     void setAuthenticationPassword(JSStringRef);
157
158     void setValueForUser(JSContextRef, JSValueRef element, JSStringRef value);
159
160     // Audio testing.
161     void setAudioResult(JSContextRef, JSValueRef data);
162
163     void setBlockAllPlugins(bool shouldBlock);
164
165     enum WhatToDump { RenderTree, MainFrameText, AllFramesText, Audio, DOMAsWebArchive };
166     WhatToDump whatToDump() const { return m_whatToDump; }
167
168     bool shouldDumpAllFrameScrollPositions() const { return m_shouldDumpAllFrameScrollPositions; }
169     bool shouldDumpBackForwardListsForAllWindows() const { return m_shouldDumpBackForwardListsForAllWindows; }
170     bool shouldDumpEditingCallbacks() const { return m_dumpEditingCallbacks; }
171     bool shouldDumpMainFrameScrollPosition() const { return m_whatToDump == RenderTree; }
172     bool shouldDumpStatusCallbacks() const { return m_dumpStatusCallbacks; }
173     bool shouldDumpTitleChanges() const { return m_dumpTitleChanges; }
174     bool shouldDumpPixels() const { return m_dumpPixels; }
175     bool shouldDumpFullScreenCallbacks() const { return m_dumpFullScreenCallbacks; }
176     bool shouldDumpFrameLoadCallbacks() const { return m_dumpFrameLoadCallbacks; }
177     bool shouldDumpProgressFinishedCallback() const { return m_dumpProgressFinishedCallback; }
178     bool shouldDumpResourceLoadCallbacks() const { return m_dumpResourceLoadCallbacks; }
179     bool shouldDumpResourceResponseMIMETypes() const { return m_dumpResourceResponseMIMETypes; }
180     bool shouldDumpWillCacheResponse() const { return m_dumpWillCacheResponse; }
181     bool shouldDumpApplicationCacheDelegateCallbacks() const { return m_dumpApplicationCacheDelegateCallbacks; }
182     bool shouldDumpDatabaseCallbacks() const { return m_dumpDatabaseCallbacks; }
183     bool shouldDumpSelectionRect() const { return m_dumpSelectionRect; }
184
185     bool isPolicyDelegateEnabled() const { return m_policyDelegateEnabled; }
186     bool isPolicyDelegatePermissive() const { return m_policyDelegatePermissive; }
187
188     bool waitToDump() const { return m_waitToDump; }
189     void waitToDumpWatchdogTimerFired();
190     void invalidateWaitToDumpWatchdogTimer();
191
192     bool shouldAllowEditing() const { return m_shouldAllowEditing; }
193
194     bool shouldCloseExtraWindowsAfterRunningTest() const { return m_shouldCloseExtraWindows; }
195
196     void evaluateScriptInIsolatedWorld(JSContextRef, unsigned worldID, JSStringRef script);
197     static unsigned worldIDForWorld(WKBundleScriptWorldRef);
198
199     void showWebInspector();
200     void closeWebInspector();
201     void evaluateInWebInspector(long callId, JSStringRef script);
202
203     void setPOSIXLocale(JSStringRef);
204
205     bool willSendRequestReturnsNull() const { return m_willSendRequestReturnsNull; }
206     void setWillSendRequestReturnsNull(bool f) { m_willSendRequestReturnsNull = f; }
207     bool willSendRequestReturnsNullOnRedirect() const { return m_willSendRequestReturnsNullOnRedirect; }
208     void setWillSendRequestReturnsNullOnRedirect(bool f) { m_willSendRequestReturnsNullOnRedirect = f; }
209
210     void setTextDirection(JSStringRef);
211
212     void setShouldStayOnPageAfterHandlingBeforeUnload(bool);
213
214     void setDefersLoading(bool);
215
216     void setStopProvisionalFrameLoads() { m_shouldStopProvisionalFrameLoads = true; }
217     bool shouldStopProvisionalFrameLoads() const { return m_shouldStopProvisionalFrameLoads; }
218     
219     bool globalFlag() const { return m_globalFlag; }
220     void setGlobalFlag(bool value) { m_globalFlag = value; }
221
222     double databaseDefaultQuota() const { return m_databaseDefaultQuota; }
223     void setDatabaseDefaultQuota(double quota) { m_databaseDefaultQuota = quota; }
224
225     double databaseMaxQuota() const { return m_databaseMaxQuota; }
226     void setDatabaseMaxQuota(double quota) { m_databaseMaxQuota = quota; }
227
228     void addChromeInputField(JSValueRef);
229     void removeChromeInputField(JSValueRef);
230     void focusWebView(JSValueRef);
231     void setBackingScaleFactor(double, JSValueRef);
232
233     void setWindowIsKey(bool);
234
235     void callAddChromeInputFieldCallback();
236     void callRemoveChromeInputFieldCallback();
237     void callFocusWebViewCallback();
238     void callSetBackingScaleFactorCallback();
239
240     void overridePreference(JSStringRef preference, JSStringRef value);
241
242     // Cookies testing
243     void setAlwaysAcceptCookies(bool);
244
245     // Custom full screen behavior.
246     void setHasCustomFullScreenBehavior(bool value) { m_customFullScreenBehavior = value; }
247     bool hasCustomFullScreenBehavior() const { return m_customFullScreenBehavior; }
248
249     // Web notifications.
250     void grantWebNotificationPermission(JSStringRef origin);
251     void denyWebNotificationPermission(JSStringRef origin);
252     void removeAllWebNotificationPermissions();
253     void simulateWebNotificationClick(JSValueRef notification);
254
255     // Geolocation.
256     void setGeolocationPermission(bool);
257     void setMockGeolocationPosition(double latitude, double longitude, double accuracy, JSValueRef altitude, JSValueRef altitudeAccuracy, JSValueRef heading, JSValueRef speed);
258     void setMockGeolocationPositionUnavailableError(JSStringRef message);
259
260     JSRetainPtr<JSStringRef> platformName();
261
262     void setPageVisibility(JSStringRef state);
263     void resetPageVisibility();
264
265     bool callShouldCloseOnWebView();
266
267     void setCustomTimeout(int duration);
268
269     // Work queue.
270     void queueBackNavigation(unsigned howFarBackward);
271     void queueForwardNavigation(unsigned howFarForward);
272     void queueLoad(JSStringRef url, JSStringRef target);
273     void queueLoadHTMLString(JSStringRef content, JSStringRef baseURL, JSStringRef unreachableURL);
274     void queueReload();
275     void queueLoadingScript(JSStringRef script);
276     void queueNonLoadingScript(JSStringRef script);
277
278     bool secureEventInputIsEnabled() const;
279     
280     JSValueRef numberOfDFGCompiles(JSValueRef theFunction);
281     JSValueRef neverInlineFunction(JSValueRef theFunction);
282
283 private:
284     static const double waitToDumpWatchdogTimerInterval;
285
286     TestRunner();
287
288     void platformInitialize();
289     void initializeWaitToDumpWatchdogTimerIfNeeded();
290
291     WhatToDump m_whatToDump;
292     bool m_shouldDumpAllFrameScrollPositions;
293     bool m_shouldDumpBackForwardListsForAllWindows;
294
295     bool m_shouldAllowEditing;
296     bool m_shouldCloseExtraWindows;
297
298     bool m_dumpEditingCallbacks;
299     bool m_dumpStatusCallbacks;
300     bool m_dumpTitleChanges;
301     bool m_dumpPixels;
302     bool m_dumpSelectionRect;
303     bool m_dumpFullScreenCallbacks;
304     bool m_dumpFrameLoadCallbacks;
305     bool m_dumpProgressFinishedCallback;
306     bool m_dumpResourceLoadCallbacks;
307     bool m_dumpResourceResponseMIMETypes;
308     bool m_dumpWillCacheResponse;
309     bool m_dumpApplicationCacheDelegateCallbacks;
310     bool m_dumpDatabaseCallbacks;
311     bool m_disallowIncreaseForApplicationCacheQuota;
312     bool m_waitToDump; // True if waitUntilDone() has been called, but notifyDone() has not yet been called.
313     bool m_testRepaint;
314     bool m_testRepaintSweepHorizontally;
315     bool m_isPrinting;
316
317     bool m_willSendRequestReturnsNull;
318     bool m_willSendRequestReturnsNullOnRedirect;
319     bool m_shouldStopProvisionalFrameLoads;
320
321     bool m_policyDelegateEnabled;
322     bool m_policyDelegatePermissive;
323     
324     bool m_globalFlag;
325     bool m_customFullScreenBehavior;
326
327     int m_timeout;
328
329     double m_databaseDefaultQuota;
330     double m_databaseMaxQuota;
331
332     bool m_userStyleSheetEnabled;
333     WKRetainPtr<WKStringRef> m_userStyleSheetLocation;
334
335     PlatformTimerRef m_waitToDumpWatchdogTimer;
336 };
337
338 } // namespace WTR
339
340 #endif // TestRunner_h