Add support for Device Orientation / Motion permission API
[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     // Device Orientation Motion.
108     void setShouldAllowDeviceOrientationAndMotionAccess(boolean value);
109
110     // Special DOM variables.
111     attribute boolean globalFlag;
112
113     // Repaint testing.
114     void testRepaint();
115     void repaintSweepHorizontally();
116     void display();
117     void displayAndTrackRepaints();
118
119     // Failed load condition testing
120     void forceImmediateCompletion();
121
122     // Printing
123     boolean isPageBoxVisible(long pageIndex);
124
125     void dumpAllHTTPRedirectedResponseHeaders();
126
127     [PassContext] void setValueForUser(object element, DOMString value);
128
129     // UserContent testing.
130     void addUserScript(DOMString source, boolean runAtStart, boolean allFrames);
131     void addUserStyleSheet(DOMString source, boolean allFrames);
132
133     // Local storage API
134     void clearAllDatabases();
135     void setDatabaseQuota(unsigned long long quota);
136     DOMString pathToLocalResource(DOMString url);
137
138     attribute double databaseDefaultQuota;
139     attribute double databaseMaxQuota;
140
141     // IndexedDB API
142     void setIDBPerOriginQuota(unsigned long long quota);
143
144     // Application Cache API
145     void clearAllApplicationCaches();
146     void setAppCacheMaximumSize(unsigned long long size);
147     long long applicationCacheDiskUsageForOrigin(DOMString origin);
148     void clearApplicationCacheForOrigin(DOMString name);
149     void disallowIncreaseForApplicationCacheQuota();
150     object originsWithApplicationCache();
151
152     // Text search testing.
153     boolean findString(DOMString target, object optionsArray);
154     void findStringMatchesInPage(DOMString target, object optionsArray);
155     void replaceFindMatchesAtIndices(object matchIndicesArray, DOMString replacementText, boolean selectionOnly);
156
157     // Evaluating script in a special context.
158     [PassContext] void evaluateScriptInIsolatedWorld(unsigned long worldID, DOMString script);
159
160     // For Web Inspector tests
161     void showWebInspector();
162     void closeWebInspector();
163     void evaluateInWebInspector(DOMString script);
164     readonly attribute DOMString inspectorTestStubURL;
165
166     void setPOSIXLocale(DOMString locale);
167
168     void setTextDirection(DOMString direction);
169
170     void setWillSendRequestReturnsNull(boolean flag);
171     void setWillSendRequestReturnsNullOnRedirect(boolean flag);
172     void setWillSendRequestAddsHTTPBody(DOMString body);
173     
174     void setShouldStayOnPageAfterHandlingBeforeUnload(boolean flag);
175
176     void setStopProvisionalFrameLoads();
177
178     readonly attribute boolean didReceiveServerRedirectForProvisionalNavigation;
179     void clearDidReceiveServerRedirectForProvisionalNavigation();
180
181     // Focus testing.
182     void addChromeInputField(object callback);
183     void removeChromeInputField(object callback);
184     void focusWebView(object callback);
185
186     // Window/view state
187     void setBackingScaleFactor(double backingScaleFactor, object callback);
188
189     void setWindowIsKey(boolean isKey);
190     void setViewSize(double width, double height);
191
192     // Cookies testing
193     void setAlwaysAcceptCookies(boolean accept);
194     void setOnlyAcceptFirstPartyCookies(boolean accept);
195
196     void overridePreference(DOMString preference, DOMString value);
197
198     // Page Visibility API
199     void setPageVisibility(DOMString state);
200     void resetPageVisibility();
201
202     // Control full screen behavior.
203     void setHasCustomFullScreenBehavior(boolean value);
204
205     // Web notifications support
206     void grantWebNotificationPermission(DOMString origin);
207     void denyWebNotificationPermission(DOMString origin);
208     void removeAllWebNotificationPermissions();
209     void simulateWebNotificationClick(object notification);
210
211     // Geolocation
212     void setGeolocationPermission(boolean value);
213     void setMockGeolocationPosition(double latitude, double longitude, double accuracy, optional object altitude, optional object altitudeAccuracy, optional object heading, optional object speed, optional object floorLevel);
214     void setMockGeolocationPositionUnavailableError(DOMString errorMessage);
215     boolean isGeolocationProviderActive();
216
217     // MediaStream
218     void setUserMediaPermission(boolean value);
219     void resetUserMediaPermission();
220     void setUserMediaPersistentPermissionForOrigin(boolean permission, DOMString origin, DOMString parentOrigin);
221     unsigned long userMediaPermissionRequestCountForOrigin(DOMString origin, DOMString parentOrigin);
222     void resetUserMediaPermissionRequestCountForOrigin(DOMString origin, DOMString parentOrigin);
223     readonly attribute boolean isDoingMediaCapture;
224
225     // Audio testing.
226     [PassContext] void setAudioResult(object data);
227
228     boolean callShouldCloseOnWebView();
229
230     // Work queue.
231     void queueBackNavigation(unsigned long howFarBackward);
232     void queueForwardNavigation(unsigned long howFarForward);
233     void queueLoad(DOMString url, DOMString target, optional boolean shouldOpenExternalURLs);
234     void queueLoadHTMLString(DOMString content, optional DOMString baseURL, optional DOMString unreachableURL);
235     void queueReload();
236     void queueLoadingScript(DOMString script);
237     void queueNonLoadingScript(DOMString script);
238
239     // Authentication
240     void setRejectsProtectionSpaceAndContinueForAuthenticationChallenges(boolean value);
241     void setHandlesAuthenticationChallenges(boolean value);
242     void setShouldLogCanAuthenticateAgainstProtectionSpace(boolean value);
243     void setAuthenticationUsername(DOMString username);
244     void setAuthenticationPassword(DOMString password);
245
246     void setAllowsAnySSLCertificate(boolean value);
247
248     // Secure text input mode (Mac only)
249     readonly attribute boolean secureEventInputIsEnabled;
250     
251     // Override plugin load policy.
252     void setBlockAllPlugins(boolean shouldBlock);
253     void setPluginSupportedMode(DOMString mode);
254
255     // Hooks to the JSC compiler.
256     object failNextNewCodeBlock();
257     object numberOfDFGCompiles(object function);
258     object neverInlineFunction(object function);
259
260     // Swipe gestures
261     void installDidBeginSwipeCallback(object callback);
262     void installWillEndSwipeCallback(object callback);
263     void installDidEndSwipeCallback(object callback);
264     void installDidRemoveSwipeSnapshotCallback(object callback);
265
266     unsigned long imageCountInGeneralPasteboard();
267
268     // UI Process Testing
269     void runUIScript(DOMString script, object callback);
270
271     void clearTestRunnerCallbacks();
272
273     void accummulateLogsForChannel(DOMString channel);
274
275     // Gamepad
276     void setMockGamepadDetails(unsigned long index, DOMString id, unsigned long axisCount, unsigned long buttonCount);
277     void setMockGamepadAxisValue(unsigned long index, unsigned long axisIndex, double value);
278     void setMockGamepadButtonValue(unsigned long index, unsigned long buttonIndex, double value);
279     void connectMockGamepad(unsigned long index);
280     void disconnectMockGamepad(unsigned long index);
281
282     // Resource Load Statistics
283     void installStatisticsDidModifyDataRecordsCallback(object callback);
284     void installStatisticsDidScanDataRecordsCallback(object callback);
285     void installStatisticsDidRunTelemetryCallback(object callback);
286     void setStatisticsDebugMode(boolean value, object completionHandler);
287     void setStatisticsPrevalentResourceForDebugMode(DOMString hostName, object completionHandler);
288     void setStatisticsLastSeen(DOMString hostName, double seconds, object completionHandler);
289     void setStatisticsPrevalentResource(DOMString hostName, boolean value, object completionHandler);
290     void setStatisticsVeryPrevalentResource(DOMString hostName, boolean value, object completionHandler);
291     boolean isStatisticsPrevalentResource(DOMString hostName);
292     boolean isStatisticsVeryPrevalentResource(DOMString hostName);
293     boolean isStatisticsRegisteredAsSubresourceUnder(DOMString subresourceHost, DOMString topFrameHost);
294     boolean isStatisticsRegisteredAsSubFrameUnder(DOMString subFrameHost, DOMString topFrameHost);
295     boolean isStatisticsRegisteredAsRedirectingTo(DOMString hostRedirectedFrom, DOMString hostRedirectedTo);
296     void setStatisticsHasHadUserInteraction(DOMString hostName, boolean value, object completionHandler);
297     boolean isStatisticsHasHadUserInteraction(DOMString hostName);
298     void setStatisticsGrandfathered(DOMString hostName, boolean value);
299     boolean isStatisticsGrandfathered(DOMString hostName);
300     void setStatisticsSubframeUnderTopFrameOrigin(DOMString hostName, DOMString topFrameHostName);
301     void setStatisticsSubresourceUnderTopFrameOrigin(DOMString hostName, DOMString topFrameHostName);
302     void setStatisticsSubresourceUniqueRedirectTo(DOMString hostName, DOMString hostNameRedirectedTo);
303     void setStatisticsSubresourceUniqueRedirectFrom(DOMString hostName, DOMString hostNameRedirectedTo);
304     void setStatisticsTopFrameUniqueRedirectTo(DOMString hostName, DOMString hostNameRedirectedTo);
305     void setStatisticsTopFrameUniqueRedirectFrom(DOMString hostName, DOMString hostNameRedirectedTo);
306     void setStatisticsTimeToLiveUserInteraction(double seconds);
307     void statisticsNotifyObserver();
308     void statisticsProcessStatisticsAndDataRecords();
309     void statisticsUpdateCookieBlocking(object completionHandler);
310     void statisticsSubmitTelemetry();
311     void setStatisticsNotifyPagesWhenDataRecordsWereScanned(boolean value);
312     void setStatisticsShouldClassifyResourcesBeforeDataRecordsRemoval(boolean value);
313     void setStatisticsNotifyPagesWhenTelemetryWasCaptured(boolean value);
314     void setStatisticsMinimumTimeBetweenDataRecordsRemoval(double seconds);
315     void setStatisticsGrandfatheringTime(double seconds);
316     void setStatisticsMaxStatisticsEntries(unsigned long entries);
317     void setStatisticsPruneEntriesDownTo(unsigned long entries);
318     void statisticsClearInMemoryAndPersistentStore(object callback);
319     void statisticsClearInMemoryAndPersistentStoreModifiedSinceHours(unsigned long hours, object callback);
320     void statisticsClearThroughWebsiteDataRemoval(object callback);
321     void statisticsDeleteCookiesForHost(DOMString hostName, boolean includeHttpOnlyCookies);
322     void setStatisticsCacheMaxAgeCap(double seconds);
323     void statisticsResetToConsistentState(object completionHandler);
324
325     // Injected bundle form client.
326     void installTextDidChangeInTextFieldCallback(object callback);
327     void installTextFieldDidBeginEditingCallback(object callback);
328     void installTextFieldDidEndEditingCallback(object callback);
329
330     // Storage Access API
331     void setStorageAccessAPIEnabled(boolean enabled);
332     void getAllStorageAccessEntries(object callback);
333
334     // Open panel
335     void setOpenPanelFiles(object filesArray);
336
337     // Modal alerts
338     void setShouldDismissJavaScriptAlertsAsynchronously(boolean value);
339
340     void setWebRTCMDNSICECandidatesEnabled(boolean value);
341     void setWebRTCUnifiedPlanEnabled(boolean value);
342     void setCustomUserAgent(DOMString userAgent);
343
344     void setWebAPIStatisticsEnabled(boolean value);
345
346     void terminateNetworkProcess();
347     void terminateServiceWorkerProcess();
348
349     void setCanHandleHTTPSServerTrustEvaluation(boolean canHandle);
350     readonly attribute boolean canDoServerTrustEvaluationInNetworkProcess;
351     readonly attribute unsigned long serverTrustEvaluationCallbackCallsCount;
352
353     readonly attribute boolean didCancelClientRedirect;
354
355     void removeAllSessionCredentials(object callback);
356
357     void getApplicationManifestThen(object callback);
358
359     void installFakeHelvetica(DOMString configuration);
360
361     void addMockCameraDevice(DOMString persistentId, DOMString label);
362     void addMockMicrophoneDevice(DOMString persistentId, DOMString label);
363     void addMockScreenDevice(DOMString persistentId, DOMString label);
364     void clearMockMediaDevices();
365     void removeMockMediaDevice(DOMString persistentId);
366     void resetMockMediaDevices();
367
368     void injectUserScript(DOMString string);
369     readonly attribute unsigned long userScriptInjectedCount;
370
371     void sendDisplayConfigurationChangedMessageForTesting();
372
373     // WebAuthN
374     void setWebAuthenticationMockConfiguration(object configuration);
375     void addTestKeyToKeychain(DOMString privateKeyBase64, DOMString attrLabel, DOMString applicationTagBase64);
376     void cleanUpKeychain(DOMString attrLabel);
377     boolean keyExistsInKeychain(DOMString attrLabel, DOMString applicationTagBase64);
378
379     // Ad Click Attribution
380     void clearAdClickAttribution();
381 };