[Mac, iOS] Crash log application information contains latest main frame URL instead...
[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     WKURLRef testURL() const { return m_testURL.get(); }
60     void setTestURL(WKURLRef url) { m_testURL = url; }
61     void dumpAsText(bool dumpPixels);
62     void waitForPolicyDelegate();
63     void dumpChildFramesAsText() { m_whatToDump = AllFramesText; }
64     void waitUntilDone();
65     void notifyDone();
66     double preciseTime();
67
68     // Other dumping.
69     void dumpBackForwardList() { m_shouldDumpBackForwardListsForAllWindows = true; }
70     void dumpChildFrameScrollPositions() { m_shouldDumpAllFrameScrollPositions = true; }
71     void dumpEditingCallbacks() { m_dumpEditingCallbacks = true; }
72     void dumpSelectionRect() { m_dumpSelectionRect = true; }
73     void dumpStatusCallbacks() { m_dumpStatusCallbacks = true; }
74     void dumpTitleChanges() { m_dumpTitleChanges = true; }
75     void dumpFullScreenCallbacks() { m_dumpFullScreenCallbacks = true; }
76     void dumpFrameLoadCallbacks() { setShouldDumpFrameLoadCallbacks(true); }
77     void dumpProgressFinishedCallback() { setShouldDumpProgressFinishedCallback(true); }
78     void dumpResourceLoadCallbacks() { m_dumpResourceLoadCallbacks = true; }
79     void dumpResourceResponseMIMETypes() { m_dumpResourceResponseMIMETypes = true; }
80     void dumpWillCacheResponse() { m_dumpWillCacheResponse = true; }
81     void dumpApplicationCacheDelegateCallbacks() { m_dumpApplicationCacheDelegateCallbacks = true; }
82     void dumpDatabaseCallbacks() { m_dumpDatabaseCallbacks = true; }
83     void dumpDOMAsWebArchive() { m_whatToDump = DOMAsWebArchive; }
84
85     void setShouldDumpFrameLoadCallbacks(bool value) { m_dumpFrameLoadCallbacks = value; }
86     void setShouldDumpProgressFinishedCallback(bool value) { m_dumpProgressFinishedCallback = value; }
87
88     // Special options.
89     void keepWebHistory();
90     void setAcceptsEditing(bool value) { m_shouldAllowEditing = value; }
91     void setCanOpenWindows(bool);
92     void setCloseRemainingWindowsWhenComplete(bool value) { m_shouldCloseExtraWindows = value; }
93     void setXSSAuditorEnabled(bool);
94     void setAllowUniversalAccessFromFileURLs(bool);
95     void setAllowFileAccessFromFileURLs(bool);
96     void setPluginsEnabled(bool);
97     void setJavaScriptCanAccessClipboard(bool);
98     void setPrivateBrowsingEnabled(bool);
99     void setPopupBlockingEnabled(bool);
100     void setAuthorAndUserStylesEnabled(bool);
101     void setCustomPolicyDelegate(bool enabled, bool permissive = false);
102     void addOriginAccessWhitelistEntry(JSStringRef sourceOrigin, JSStringRef destinationProtocol, JSStringRef destinationHost, bool allowDestinationSubdomains);
103     void removeOriginAccessWhitelistEntry(JSStringRef sourceOrigin, JSStringRef destinationProtocol, JSStringRef destinationHost, bool allowDestinationSubdomains);
104     void setUserStyleSheetEnabled(bool);
105     void setUserStyleSheetLocation(JSStringRef);
106     void setSpatialNavigationEnabled(bool);
107     void setTabKeyCyclesThroughElements(bool);
108     void setSerializeHTTPLoads();
109     void dispatchPendingLoadRequests();
110     void setCacheModel(int);
111     void setAsynchronousSpellCheckingEnabled(bool);
112
113     // Special DOM functions.
114     void clearBackForwardList();
115     void execCommand(JSStringRef name, JSStringRef argument);
116     bool isCommandEnabled(JSStringRef name);
117     unsigned windowCount();
118
119     // Repaint testing.
120     void testRepaint() { m_testRepaint = true; }
121     void repaintSweepHorizontally() { m_testRepaintSweepHorizontally = true; }
122     void display();
123     
124     // UserContent testing.
125     void addUserScript(JSStringRef source, bool runAtStart, bool allFrames);
126     void addUserStyleSheet(JSStringRef source, bool allFrames);
127
128     // Text search testing.
129     bool findString(JSStringRef, JSValueRef optionsArray);
130
131     // Local storage
132     void clearAllDatabases();
133     void setDatabaseQuota(uint64_t);
134     JSRetainPtr<JSStringRef> pathToLocalResource(JSStringRef);
135
136     // Application Cache
137     void clearAllApplicationCaches();
138     void clearApplicationCacheForOrigin(JSStringRef origin);
139     void setAppCacheMaximumSize(uint64_t);
140     long long applicationCacheDiskUsageForOrigin(JSStringRef origin);
141     void disallowIncreaseForApplicationCacheQuota();
142     bool shouldDisallowIncreaseForApplicationCacheQuota() { return m_disallowIncreaseForApplicationCacheQuota; }
143     JSValueRef originsWithApplicationCache();
144
145     // Printing
146     bool isPageBoxVisible(int pageIndex);
147     bool isPrinting() { return m_isPrinting; }
148     void setPrinting() { m_isPrinting = true; }
149
150     // Authentication
151     void setHandlesAuthenticationChallenges(bool);
152     void setAuthenticationUsername(JSStringRef);
153     void setAuthenticationPassword(JSStringRef);
154
155     void setValueForUser(JSContextRef, JSValueRef element, JSStringRef value);
156
157     // Audio testing.
158     void setAudioResult(JSContextRef, JSValueRef data);
159
160     void setBlockAllPlugins(bool shouldBlock);
161
162     enum WhatToDump { RenderTree, MainFrameText, AllFramesText, Audio, DOMAsWebArchive };
163     WhatToDump whatToDump() const { return m_whatToDump; }
164
165     bool shouldDumpAllFrameScrollPositions() const { return m_shouldDumpAllFrameScrollPositions; }
166     bool shouldDumpBackForwardListsForAllWindows() const { return m_shouldDumpBackForwardListsForAllWindows; }
167     bool shouldDumpEditingCallbacks() const { return m_dumpEditingCallbacks; }
168     bool shouldDumpMainFrameScrollPosition() const { return m_whatToDump == RenderTree; }
169     bool shouldDumpStatusCallbacks() const { return m_dumpStatusCallbacks; }
170     bool shouldDumpTitleChanges() const { return m_dumpTitleChanges; }
171     bool shouldDumpPixels() const { return m_dumpPixels; }
172     bool shouldDumpFullScreenCallbacks() const { return m_dumpFullScreenCallbacks; }
173     bool shouldDumpFrameLoadCallbacks() const { return m_dumpFrameLoadCallbacks; }
174     bool shouldDumpProgressFinishedCallback() const { return m_dumpProgressFinishedCallback; }
175     bool shouldDumpResourceLoadCallbacks() const { return m_dumpResourceLoadCallbacks; }
176     bool shouldDumpResourceResponseMIMETypes() const { return m_dumpResourceResponseMIMETypes; }
177     bool shouldDumpWillCacheResponse() const { return m_dumpWillCacheResponse; }
178     bool shouldDumpApplicationCacheDelegateCallbacks() const { return m_dumpApplicationCacheDelegateCallbacks; }
179     bool shouldDumpDatabaseCallbacks() const { return m_dumpDatabaseCallbacks; }
180     bool shouldDumpSelectionRect() const { return m_dumpSelectionRect; }
181
182     bool isPolicyDelegateEnabled() const { return m_policyDelegateEnabled; }
183     bool isPolicyDelegatePermissive() const { return m_policyDelegatePermissive; }
184
185     bool waitToDump() const { return m_waitToDump; }
186     void waitToDumpWatchdogTimerFired();
187     void invalidateWaitToDumpWatchdogTimer();
188
189     bool shouldAllowEditing() const { return m_shouldAllowEditing; }
190
191     bool shouldCloseExtraWindowsAfterRunningTest() const { return m_shouldCloseExtraWindows; }
192
193     void evaluateScriptInIsolatedWorld(JSContextRef, unsigned worldID, JSStringRef script);
194     static unsigned worldIDForWorld(WKBundleScriptWorldRef);
195
196     void showWebInspector();
197     void closeWebInspector();
198     void evaluateInWebInspector(JSStringRef script);
199
200     void setPOSIXLocale(JSStringRef);
201
202     bool willSendRequestReturnsNull() const { return m_willSendRequestReturnsNull; }
203     void setWillSendRequestReturnsNull(bool f) { m_willSendRequestReturnsNull = f; }
204     bool willSendRequestReturnsNullOnRedirect() const { return m_willSendRequestReturnsNullOnRedirect; }
205     void setWillSendRequestReturnsNullOnRedirect(bool f) { m_willSendRequestReturnsNullOnRedirect = f; }
206
207     void setTextDirection(JSStringRef);
208
209     void setShouldStayOnPageAfterHandlingBeforeUnload(bool);
210
211     void setDefersLoading(bool);
212
213     void setStopProvisionalFrameLoads() { m_shouldStopProvisionalFrameLoads = true; }
214     bool shouldStopProvisionalFrameLoads() const { return m_shouldStopProvisionalFrameLoads; }
215     
216     bool globalFlag() const { return m_globalFlag; }
217     void setGlobalFlag(bool value) { m_globalFlag = value; }
218
219     double databaseDefaultQuota() const { return m_databaseDefaultQuota; }
220     void setDatabaseDefaultQuota(double quota) { m_databaseDefaultQuota = quota; }
221
222     double databaseMaxQuota() const { return m_databaseMaxQuota; }
223     void setDatabaseMaxQuota(double quota) { m_databaseMaxQuota = quota; }
224
225     void addChromeInputField(JSValueRef);
226     void removeChromeInputField(JSValueRef);
227     void focusWebView(JSValueRef);
228     void setBackingScaleFactor(double, JSValueRef);
229
230     void setWindowIsKey(bool);
231
232     void callAddChromeInputFieldCallback();
233     void callRemoveChromeInputFieldCallback();
234     void callFocusWebViewCallback();
235     void callSetBackingScaleFactorCallback();
236
237     void overridePreference(JSStringRef preference, JSStringRef value);
238
239     // Cookies testing
240     void setAlwaysAcceptCookies(bool);
241
242     // Custom full screen behavior.
243     void setHasCustomFullScreenBehavior(bool value) { m_customFullScreenBehavior = value; }
244     bool hasCustomFullScreenBehavior() const { return m_customFullScreenBehavior; }
245
246     // Web notifications.
247     void grantWebNotificationPermission(JSStringRef origin);
248     void denyWebNotificationPermission(JSStringRef origin);
249     void removeAllWebNotificationPermissions();
250     void simulateWebNotificationClick(JSValueRef notification);
251
252     // Geolocation.
253     void setGeolocationPermission(bool);
254     void setMockGeolocationPosition(double latitude, double longitude, double accuracy, JSValueRef altitude, JSValueRef altitudeAccuracy, JSValueRef heading, JSValueRef speed);
255     void setMockGeolocationPositionUnavailableError(JSStringRef message);
256
257     // MediaStream
258     void setUserMediaPermission(bool);
259
260     void setPageVisibility(JSStringRef state);
261     void resetPageVisibility();
262
263     bool callShouldCloseOnWebView();
264
265     void setCustomTimeout(int duration);
266
267     // Work queue.
268     void queueBackNavigation(unsigned howFarBackward);
269     void queueForwardNavigation(unsigned howFarForward);
270     void queueLoad(JSStringRef url, JSStringRef target);
271     void queueLoadHTMLString(JSStringRef content, JSStringRef baseURL, JSStringRef unreachableURL);
272     void queueReload();
273     void queueLoadingScript(JSStringRef script);
274     void queueNonLoadingScript(JSStringRef script);
275
276     bool secureEventInputIsEnabled() const;
277     
278     JSValueRef numberOfDFGCompiles(JSValueRef theFunction);
279     JSValueRef neverInlineFunction(JSValueRef theFunction);
280
281 private:
282     static const double waitToDumpWatchdogTimerInterval;
283
284     TestRunner();
285
286     void platformInitialize();
287     void initializeWaitToDumpWatchdogTimerIfNeeded();
288
289     WKRetainPtr<WKURLRef> m_testURL; // Set by InjectedBundlePage once provisional load starts.
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