9cf4493e60e786338b13eaf0ab6507c435c31378
[WebKit-https.git] / Tools / WebKitTestRunner / InjectedBundle / Bindings / TestRunner.idl
1 /*
2  * Copyright (C) 2010-2017 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 interface TestRunner {
27     readonly attribute boolean isWebKit2;
28
29     // The basics.
30     void dumpAsText(boolean dumpPixels);
31     void dumpChildFramesAsText();
32     void waitForPolicyDelegate();
33     void waitUntilDone();
34     void notifyDone();
35     double preciseTime(); // seconds since the epoch
36     readonly attribute double timeout; // milliseconds
37
38     // Downloads.
39     void waitUntilDownloadFinished();
40     void setShouldLogDownloadCallbacks(boolean value);
41
42     // Other dumping.
43     void dumpBackForwardList();
44     void dumpChildFrameScrollPositions();
45     void dumpEditingCallbacks();
46     void dumpSelectionRect();
47     void dumpStatusCallbacks();
48     void dumpTitleChanges();
49     void dumpFullScreenCallbacks();
50     void dumpFrameLoadCallbacks();
51     void dumpProgressFinishedCallback();
52     void dumpResourceLoadCallbacks();
53     void dumpResourceResponseMIMETypes();
54     void dumpWillCacheResponse();
55     void dumpApplicationCacheDelegateCallbacks();
56     void dumpDatabaseCallbacks();
57     void dumpDOMAsWebArchive();
58     void dumpPolicyDelegateCallbacks();
59     void dumpResourceLoadStatistics();
60     void dumpAdClickAttribution();
61
62     void clearDOMCaches();
63     void clearDOMCache(DOMString origin);
64     boolean hasDOMCache(DOMString origin);
65     unsigned long domCacheSize(DOMString origin);
66     void allowCacheStorageQuotaIncrease();
67
68     // Special options.
69     void keepWebHistory();
70     void setAcceptsEditing(boolean value);
71     void setCanOpenWindows();
72     void setCloseRemainingWindowsWhenComplete(boolean value);
73     void setXSSAuditorEnabled(boolean value);
74     void setAllowUniversalAccessFromFileURLs(boolean value);
75     void setAllowFileAccessFromFileURLs(boolean value);
76     void setNeedsStorageAccessFromFileURLsQuirk(boolean value);
77     void setPluginsEnabled(boolean value);
78     void setJavaScriptCanAccessClipboard(boolean value);
79     void setPrivateBrowsingEnabled(boolean value);
80     void setUseDashboardCompatibilityMode(boolean value);
81     void setPopupBlockingEnabled(boolean value);
82     void setAuthorAndUserStylesEnabled(boolean value);
83     void setCustomPolicyDelegate(boolean enabled, boolean permissive);
84     void addOriginAccessWhitelistEntry(DOMString sourceOrigin, DOMString destinationProtocol, DOMString destinationHost, boolean allowDestinationSubdomains);
85     void removeOriginAccessWhitelistEntry(DOMString sourceOrigin, DOMString destinationProtocol, DOMString destinationHost, boolean allowDestinationSubdomains);
86     void setUserStyleSheetEnabled(boolean value);
87     void setUserStyleSheetLocation(DOMString location);
88     void setSpatialNavigationEnabled(boolean value);
89     void setTabKeyCyclesThroughElements(boolean enabled);
90     void setSerializeHTTPLoads();
91     void dispatchPendingLoadRequests();
92     void setCacheModel(long model);
93     void setAsynchronousSpellCheckingEnabled(boolean value);
94     void setPrinting();
95     void setShouldDecideNavigationPolicyAfterDelay(boolean value);
96     void setShouldDecideResponsePolicyAfterDelay(boolean value);
97     void setNavigationGesturesEnabled(boolean value);
98     void setIgnoresViewportScaleLimits(boolean value);
99     void setShouldDownloadUndisplayableMIMETypes(boolean value);
100
101     // Special DOM functions.
102     void clearBackForwardList();
103     void execCommand(DOMString name, DOMString showUI, DOMString value);
104     boolean isCommandEnabled(DOMString name);
105     unsigned long windowCount();
106
107     // Special DOM variables.
108     attribute boolean globalFlag;
109
110     // Repaint testing.
111     void testRepaint();
112     void repaintSweepHorizontally();
113     void display();
114     void displayAndTrackRepaints();
115
116     // Failed load condition testing
117     void forceImmediateCompletion();
118
119     // Printing
120     boolean isPageBoxVisible(long pageIndex);
121
122     void dumpAllHTTPRedirectedResponseHeaders();
123
124     [PassContext] void setValueForUser(object element, DOMString value);
125
126     // UserContent testing.
127     void addUserScript(DOMString source, boolean runAtStart, boolean allFrames);
128     void addUserStyleSheet(DOMString source, boolean allFrames);
129
130     // Local storage API
131     void clearAllDatabases();
132     void setDatabaseQuota(unsigned long long quota);
133     DOMString pathToLocalResource(DOMString url);
134
135     attribute double databaseDefaultQuota;
136     attribute double databaseMaxQuota;
137
138     // IndexedDB API
139     void setIDBPerOriginQuota(unsigned long long quota);
140
141     // Application Cache API
142     void clearAllApplicationCaches();
143     void setAppCacheMaximumSize(unsigned long long size);
144     long long applicationCacheDiskUsageForOrigin(DOMString origin);
145     void clearApplicationCacheForOrigin(DOMString name);
146     void disallowIncreaseForApplicationCacheQuota();
147     object originsWithApplicationCache();
148
149     // Text search testing.
150     boolean findString(DOMString target, object optionsArray);
151     void findStringMatchesInPage(DOMString target, object optionsArray);
152     void replaceFindMatchesAtIndices(object matchIndicesArray, DOMString replacementText, boolean selectionOnly);
153
154     // Evaluating script in a special context.
155     [PassContext] void evaluateScriptInIsolatedWorld(unsigned long worldID, DOMString script);
156
157     // For Web Inspector tests
158     void showWebInspector();
159     void closeWebInspector();
160     void evaluateInWebInspector(DOMString script);
161     readonly attribute DOMString inspectorTestStubURL;
162
163     void setPOSIXLocale(DOMString locale);
164
165     void setTextDirection(DOMString direction);
166
167     void setWillSendRequestReturnsNull(boolean flag);
168     void setWillSendRequestReturnsNullOnRedirect(boolean flag);
169     void setWillSendRequestAddsHTTPBody(DOMString body);
170     
171     void setShouldStayOnPageAfterHandlingBeforeUnload(boolean flag);
172
173     void setStopProvisionalFrameLoads();
174
175     readonly attribute boolean didReceiveServerRedirectForProvisionalNavigation;
176     void clearDidReceiveServerRedirectForProvisionalNavigation();
177
178     // Focus testing.
179     void addChromeInputField(object callback);
180     void removeChromeInputField(object callback);
181     void focusWebView(object callback);
182
183     // Window/view state
184     void setBackingScaleFactor(double backingScaleFactor, object callback);
185
186     void setWindowIsKey(boolean isKey);
187     void setViewSize(double width, double height);
188
189     // Cookies testing
190     void setAlwaysAcceptCookies(boolean accept);
191     void setOnlyAcceptFirstPartyCookies(boolean accept);
192
193     void overridePreference(DOMString preference, DOMString value);
194
195     // Page Visibility API
196     void setPageVisibility(DOMString state);
197     void resetPageVisibility();
198
199     // Control full screen behavior.
200     void setHasCustomFullScreenBehavior(boolean value);
201
202     // Web notifications support
203     void grantWebNotificationPermission(DOMString origin);
204     void denyWebNotificationPermission(DOMString origin);
205     void removeAllWebNotificationPermissions();
206     void simulateWebNotificationClick(object notification);
207
208     // Geolocation
209     void setGeolocationPermission(boolean value);
210     void setMockGeolocationPosition(double latitude, double longitude, double accuracy, optional object altitude, optional object altitudeAccuracy, optional object heading, optional object speed, optional object floorLevel);
211     void setMockGeolocationPositionUnavailableError(DOMString errorMessage);
212     boolean isGeolocationProviderActive();
213
214     // MediaStream
215     void setUserMediaPermission(boolean value);
216     void resetUserMediaPermission();
217     void setUserMediaPersistentPermissionForOrigin(boolean permission, DOMString origin, DOMString parentOrigin);
218     unsigned long userMediaPermissionRequestCountForOrigin(DOMString origin, DOMString parentOrigin);
219     void resetUserMediaPermissionRequestCountForOrigin(DOMString origin, DOMString parentOrigin);
220     readonly attribute boolean isDoingMediaCapture;
221
222     // Audio testing.
223     [PassContext] void setAudioResult(object data);
224
225     boolean callShouldCloseOnWebView();
226
227     // Work queue.
228     void queueBackNavigation(unsigned long howFarBackward);
229     void queueForwardNavigation(unsigned long howFarForward);
230     void queueLoad(DOMString url, DOMString target, optional boolean shouldOpenExternalURLs);
231     void queueLoadHTMLString(DOMString content, optional DOMString baseURL, optional DOMString unreachableURL);
232     void queueReload();
233     void queueLoadingScript(DOMString script);
234     void queueNonLoadingScript(DOMString script);
235
236     // Authentication
237     void setRejectsProtectionSpaceAndContinueForAuthenticationChallenges(boolean value);
238     void setHandlesAuthenticationChallenges(boolean value);
239     void setShouldLogCanAuthenticateAgainstProtectionSpace(boolean value);
240     void setAuthenticationUsername(DOMString username);
241     void setAuthenticationPassword(DOMString password);
242
243     void setAllowsAnySSLCertificate(boolean value);
244
245     // Secure text input mode (Mac only)
246     readonly attribute boolean secureEventInputIsEnabled;
247     
248     // Override plugin load policy.
249     void setBlockAllPlugins(boolean shouldBlock);
250     void setPluginSupportedMode(DOMString mode);
251
252     // Hooks to the JSC compiler.
253     object failNextNewCodeBlock();
254     object numberOfDFGCompiles(object function);
255     object neverInlineFunction(object function);
256
257     // Swipe gestures
258     void installDidBeginSwipeCallback(object callback);
259     void installWillEndSwipeCallback(object callback);
260     void installDidEndSwipeCallback(object callback);
261     void installDidRemoveSwipeSnapshotCallback(object callback);
262
263     unsigned long imageCountInGeneralPasteboard();
264
265     // UI Process Testing
266     void runUIScript(DOMString script, object callback);
267
268     void clearTestRunnerCallbacks();
269
270     void accummulateLogsForChannel(DOMString channel);
271
272     // Gamepad
273     void setMockGamepadDetails(unsigned long index, DOMString id, unsigned long axisCount, unsigned long buttonCount);
274     void setMockGamepadAxisValue(unsigned long index, unsigned long axisIndex, double value);
275     void setMockGamepadButtonValue(unsigned long index, unsigned long buttonIndex, double value);
276     void connectMockGamepad(unsigned long index);
277     void disconnectMockGamepad(unsigned long index);
278
279     // Resource Load Statistics
280     void installStatisticsDidModifyDataRecordsCallback(object callback);
281     void installStatisticsDidScanDataRecordsCallback(object callback);
282     void installStatisticsDidRunTelemetryCallback(object callback);
283     void setStatisticsDebugMode(boolean value, object completionHandler);
284     void setStatisticsPrevalentResourceForDebugMode(DOMString hostName, object completionHandler);
285     void setStatisticsLastSeen(DOMString hostName, double seconds, object completionHandler);
286     void setStatisticsPrevalentResource(DOMString hostName, boolean value, object completionHandler);
287     void setStatisticsVeryPrevalentResource(DOMString hostName, boolean value, object completionHandler);
288     boolean isStatisticsPrevalentResource(DOMString hostName);
289     boolean isStatisticsVeryPrevalentResource(DOMString hostName);
290     boolean isStatisticsRegisteredAsSubresourceUnder(DOMString subresourceHost, DOMString topFrameHost);
291     boolean isStatisticsRegisteredAsSubFrameUnder(DOMString subFrameHost, DOMString topFrameHost);
292     boolean isStatisticsRegisteredAsRedirectingTo(DOMString hostRedirectedFrom, DOMString hostRedirectedTo);
293     void setStatisticsHasHadUserInteraction(DOMString hostName, boolean value, object completionHandler);
294     boolean isStatisticsHasHadUserInteraction(DOMString hostName);
295     void setStatisticsGrandfathered(DOMString hostName, boolean value);
296     boolean isStatisticsGrandfathered(DOMString hostName);
297     void setStatisticsSubframeUnderTopFrameOrigin(DOMString hostName, DOMString topFrameHostName);
298     void setStatisticsSubresourceUnderTopFrameOrigin(DOMString hostName, DOMString topFrameHostName);
299     void setStatisticsSubresourceUniqueRedirectTo(DOMString hostName, DOMString hostNameRedirectedTo);
300     void setStatisticsSubresourceUniqueRedirectFrom(DOMString hostName, DOMString hostNameRedirectedTo);
301     void setStatisticsTopFrameUniqueRedirectTo(DOMString hostName, DOMString hostNameRedirectedTo);
302     void setStatisticsTopFrameUniqueRedirectFrom(DOMString hostName, DOMString hostNameRedirectedTo);
303     void setStatisticsTimeToLiveUserInteraction(double seconds);
304     void statisticsNotifyObserver();
305     void statisticsProcessStatisticsAndDataRecords();
306     void statisticsUpdateCookieBlocking(object completionHandler);
307     void statisticsSubmitTelemetry();
308     void setStatisticsNotifyPagesWhenDataRecordsWereScanned(boolean value);
309     void setStatisticsShouldClassifyResourcesBeforeDataRecordsRemoval(boolean value);
310     void setStatisticsNotifyPagesWhenTelemetryWasCaptured(boolean value);
311     void setStatisticsMinimumTimeBetweenDataRecordsRemoval(double seconds);
312     void setStatisticsGrandfatheringTime(double seconds);
313     void setStatisticsMaxStatisticsEntries(unsigned long entries);
314     void setStatisticsPruneEntriesDownTo(unsigned long entries);
315     void statisticsClearInMemoryAndPersistentStore(object callback);
316     void statisticsClearInMemoryAndPersistentStoreModifiedSinceHours(unsigned long hours, object callback);
317     void statisticsClearThroughWebsiteDataRemoval(object callback);
318     void statisticsDeleteCookiesForHost(DOMString hostName, boolean includeHttpOnlyCookies);
319     void setStatisticsCacheMaxAgeCap(double seconds);
320     void statisticsResetToConsistentState(object completionHandler);
321
322     // Injected bundle form client.
323     void installTextDidChangeInTextFieldCallback(object callback);
324     void installTextFieldDidBeginEditingCallback(object callback);
325     void installTextFieldDidEndEditingCallback(object callback);
326
327     // Storage Access API
328     void setStorageAccessAPIEnabled(boolean enabled);
329     void getAllStorageAccessEntries(object callback);
330
331     // Open panel
332     void setOpenPanelFiles(object filesArray);
333
334     // Modal alerts
335     void setShouldDismissJavaScriptAlertsAsynchronously(boolean value);
336
337     void setWebRTCMDNSICECandidatesEnabled(boolean value);
338     void setWebRTCUnifiedPlanEnabled(boolean value);
339     void setCustomUserAgent(DOMString userAgent);
340
341     void setWebAPIStatisticsEnabled(boolean value);
342
343     void terminateNetworkProcess();
344     void terminateServiceWorkerProcess();
345
346     void setCanHandleHTTPSServerTrustEvaluation(boolean canHandle);
347     readonly attribute boolean canDoServerTrustEvaluationInNetworkProcess;
348     readonly attribute unsigned long serverTrustEvaluationCallbackCallsCount;
349
350     readonly attribute boolean didCancelClientRedirect;
351
352     void removeAllSessionCredentials(object callback);
353
354     void getApplicationManifestThen(object callback);
355
356     void installFakeHelvetica(DOMString configuration);
357
358     void addMockCameraDevice(DOMString persistentId, DOMString label);
359     void addMockMicrophoneDevice(DOMString persistentId, DOMString label);
360     void addMockScreenDevice(DOMString persistentId, DOMString label);
361     void clearMockMediaDevices();
362     void removeMockMediaDevice(DOMString persistentId);
363     void resetMockMediaDevices();
364
365     void injectUserScript(DOMString string);
366     readonly attribute unsigned long userScriptInjectedCount;
367
368     void sendDisplayConfigurationChangedMessageForTesting();
369
370     // WebAuthN
371     void setWebAuthenticationMockConfiguration(object configuration);
372     void addTestKeyToKeychain(DOMString privateKeyBase64, DOMString attrLabel, DOMString applicationTagBase64);
373     void cleanUpKeychain(DOMString attrLabel);
374     boolean keyExistsInKeychain(DOMString attrLabel, DOMString applicationTagBase64);
375
376     // Ad Click Attribution
377     void clearAdClickAttribution();
378 };