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