2 * Copyright (C) 2010 Google Inc. All rights reserved.
3 * Copyright (C) 2010 Pawel Hajdan (phajdan.jr@chromium.org)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
9 * * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * * Redistributions in binary form must reproduce the above
12 * copyright notice, this list of conditions and the following disclaimer
13 * in the documentation and/or other materials provided with the
15 * * Neither the name of Google Inc. nor the names of its
16 * contributors may be used to endorse or promote products derived from
17 * this software without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 LayoutTestController class:
34 Bound to a JavaScript window.layoutTestController object using the
35 CppBoundClass::bindToJavascript(), this allows layout tests that are run in
36 the test_shell (or, in principle, any web page loaded into a client app built
37 with this class) to control various aspects of how the tests are run and what
38 sort of output they produce.
41 #ifndef LayoutTestController_h
42 #define LayoutTestController_h
44 #include "CppBoundClass.h"
46 #include "WebString.h"
48 #include <wtf/Deque.h>
49 #include <wtf/OwnPtr.h>
52 class WebDeviceOrientationClient;
53 class WebDeviceOrientationClientMock;
54 class WebSpeechInputController;
55 class WebSpeechInputControllerMock;
56 class WebSpeechInputListener;
61 class LayoutTestController : public CppBoundClass {
63 // Builds the property and method lists needed to bind this class to a JS
65 LayoutTestController(TestShell*);
67 ~LayoutTestController();
69 // This function sets a flag that tells the test_shell to dump pages as
70 // plain text, rather than as a text representation of the renderer's state.
71 // It takes an optional argument, whether to dump pixels results or not.
72 void dumpAsText(const CppArgumentList&, CppVariant*);
74 // This function should set a flag that tells the test_shell to print a line
75 // of descriptive text for each database command. It should take no
76 // arguments, and ignore any that may be present. However, at the moment, we
77 // don't have any DB function that prints messages, so for now this function
78 // doesn't do anything.
79 void dumpDatabaseCallbacks(const CppArgumentList&, CppVariant*);
81 // This function sets a flag that tells the test_shell to print a line of
82 // descriptive text for each editing command. It takes no arguments, and
83 // ignores any that may be present.
84 void dumpEditingCallbacks(const CppArgumentList&, CppVariant*);
86 // This function sets a flag that tells the test_shell to print a line of
87 // descriptive text for each frame load callback. It takes no arguments, and
88 // ignores any that may be present.
89 void dumpFrameLoadCallbacks(const CppArgumentList&, CppVariant*);
91 // This function sets a flag that tells the test_shell to print a line of
92 // user gesture status text for some frame load callbacks. It takes no
93 // arguments, and ignores any that may be present.
94 void dumpUserGestureInFrameLoadCallbacks(const CppArgumentList&, CppVariant*);
96 // This function sets a flag that tells the test_shell to print out a text
97 // representation of the back/forward list. It ignores all arguments.
98 void dumpBackForwardList(const CppArgumentList&, CppVariant*);
100 // This function sets a flag that tells the test_shell to print out the
101 // scroll offsets of the child frames. It ignores all.
102 void dumpChildFrameScrollPositions(const CppArgumentList&, CppVariant*);
104 // This function sets a flag that tells the test_shell to recursively
105 // dump all frames as plain text if the dumpAsText flag is set.
106 // It takes no arguments, and ignores any that may be present.
107 void dumpChildFramesAsText(const CppArgumentList&, CppVariant*);
109 // This function sets a flag that tells the test_shell to dump a descriptive
110 // line for each resource load callback. It takes no arguments, and ignores
111 // any that may be present.
112 void dumpResourceLoadCallbacks(const CppArgumentList&, CppVariant*);
114 // This function sets a flag that tells the test_shell to dump the MIME type
115 // for each resource that was loaded. It takes no arguments, and ignores any
116 // that may be present.
117 void dumpResourceResponseMIMETypes(const CppArgumentList&, CppVariant*);
119 // This function sets a flag that tells the test_shell to dump all calls
120 // to window.status().
121 // It takes no arguments, and ignores any that may be present.
122 void dumpWindowStatusChanges(const CppArgumentList&, CppVariant*);
124 // When called with a boolean argument, this sets a flag that controls
125 // whether content-editable elements accept editing focus when an editing
126 // attempt is made. It ignores any additional arguments.
127 void setAcceptsEditing(const CppArgumentList&, CppVariant*);
129 // Functions for dealing with windows. By default we block all new windows.
130 void windowCount(const CppArgumentList&, CppVariant*);
131 void setCanOpenWindows(const CppArgumentList&, CppVariant*);
132 void setCloseRemainingWindowsWhenComplete(const CppArgumentList&, CppVariant*);
134 // By default, tests end when page load is complete. These methods are used
135 // to delay the completion of the test until notifyDone is called.
136 void waitUntilDone(const CppArgumentList&, CppVariant*);
137 void notifyDone(const CppArgumentList&, CppVariant*);
139 // Methods for adding actions to the work queue. Used in conjunction with
140 // waitUntilDone/notifyDone above.
141 void queueBackNavigation(const CppArgumentList&, CppVariant*);
142 void queueForwardNavigation(const CppArgumentList&, CppVariant*);
143 void queueReload(const CppArgumentList&, CppVariant*);
144 void queueLoadingScript(const CppArgumentList&, CppVariant*);
145 void queueNonLoadingScript(const CppArgumentList&, CppVariant*);
146 void queueLoad(const CppArgumentList&, CppVariant*);
147 void queueLoadHTMLString(const CppArgumentList&, CppVariant*);
149 // Although this is named "objC" to match the Mac version, it actually tests
150 // the identity of its two arguments in C++.
151 void objCIdentityIsEqual(const CppArgumentList&, CppVariant*);
153 // Changes the cookie policy from the default to allow all cookies.
154 void setAlwaysAcceptCookies(const CppArgumentList&, CppVariant*);
156 // Shows DevTools window.
157 void showWebInspector(const CppArgumentList&, CppVariant*);
158 void closeWebInspector(const CppArgumentList&, CppVariant*);
160 // Gives focus to the window.
161 void setWindowIsKey(const CppArgumentList&, CppVariant*);
163 // Method that controls whether pressing Tab key cycles through page elements
164 // or inserts a '\t' char in text area
165 void setTabKeyCyclesThroughElements(const CppArgumentList&, CppVariant*);
167 // Passes through to WebPreferences which allows the user to have a custom
169 void setUserStyleSheetEnabled(const CppArgumentList&, CppVariant*);
170 void setUserStyleSheetLocation(const CppArgumentList&, CppVariant*);
172 // Passes this preference through to WebSettings.
173 void setAuthorAndUserStylesEnabled(const CppArgumentList&, CppVariant*);
175 // Puts Webkit in "dashboard compatibility mode", which is used in obscure
176 // Mac-only circumstances. It's not really necessary, and will most likely
177 // never be used by Chrome, but some layout tests depend on its presence.
178 void setUseDashboardCompatibilityMode(const CppArgumentList&, CppVariant*);
180 void setScrollbarPolicy(const CppArgumentList&, CppVariant*);
182 // Causes navigation actions just printout the intended navigation instead
183 // of taking you to the page. This is used for cases like mailto, where you
184 // don't actually want to open the mail program.
185 void setCustomPolicyDelegate(const CppArgumentList&, CppVariant*);
187 // Delays completion of the test until the policy delegate runs.
188 void waitForPolicyDelegate(const CppArgumentList&, CppVariant*);
190 // Causes WillSendRequest to clear certain headers.
191 void setWillSendRequestClearHeader(const CppArgumentList&, CppVariant*);
193 // Causes WillSendRequest to block redirects.
194 void setWillSendRequestReturnsNullOnRedirect(const CppArgumentList&, CppVariant*);
196 // Causes WillSendRequest to return an empty request.
197 void setWillSendRequestReturnsNull(const CppArgumentList&, CppVariant*);
199 // Converts a URL starting with file:///tmp/ to the local mapping.
200 void pathToLocalResource(const CppArgumentList&, CppVariant*);
202 // Sets a bool such that when a drag is started, we fill the drag clipboard
203 // with a fake file object.
204 void addFileToPasteboardOnDrag(const CppArgumentList&, CppVariant*);
206 // Executes an internal command (superset of document.execCommand() commands).
207 void execCommand(const CppArgumentList&, CppVariant*);
209 // Checks if an internal command is currently available.
210 void isCommandEnabled(const CppArgumentList&, CppVariant*);
212 // Set the WebPreference that controls webkit's popup blocking.
213 void setPopupBlockingEnabled(const CppArgumentList&, CppVariant*);
215 // If true, causes provisional frame loads to be stopped for the remainder of
217 void setStopProvisionalFrameLoads(const CppArgumentList&, CppVariant*);
219 // Enable or disable smart insert/delete. This is enabled by default.
220 void setSmartInsertDeleteEnabled(const CppArgumentList&, CppVariant*);
222 // Enable or disable trailing whitespace selection on double click.
223 void setSelectTrailingWhitespaceEnabled(const CppArgumentList&, CppVariant*);
225 void pauseAnimationAtTimeOnElementWithId(const CppArgumentList&, CppVariant*);
226 void pauseTransitionAtTimeOnElementWithId(const CppArgumentList&, CppVariant*);
227 void elementDoesAutoCompleteForElementWithId(const CppArgumentList&, CppVariant*);
228 void numberOfActiveAnimations(const CppArgumentList&, CppVariant*);
229 void suspendAnimations(const CppArgumentList&, CppVariant*);
230 void resumeAnimations(const CppArgumentList&, CppVariant*);
231 void sampleSVGAnimationForElementAtTime(const CppArgumentList&, CppVariant*);
232 void disableImageLoading(const CppArgumentList&, CppVariant*);
233 void setIconDatabaseEnabled(const CppArgumentList&, CppVariant*);
234 void dumpSelectionRect(const CppArgumentList&, CppVariant*);
236 // Grants permission for desktop notifications to an origin
237 void grantDesktopNotificationPermission(const CppArgumentList&, CppVariant*);
238 // Simulates a click on a desktop notification.
239 void simulateDesktopNotificationClick(const CppArgumentList&, CppVariant*);
241 void setDomainRelaxationForbiddenForURLScheme(const CppArgumentList&, CppVariant*);
242 void setDeferMainResourceDataLoad(const CppArgumentList&, CppVariant*);
243 void setEditingBehavior(const CppArgumentList&, CppVariant*);
245 // The following are only stubs. TODO(pamg): Implement any of these that
246 // are needed to pass the layout tests.
247 void dumpAsWebArchive(const CppArgumentList&, CppVariant*);
248 void dumpTitleChanges(const CppArgumentList&, CppVariant*);
249 void setMainFrameIsFirstResponder(const CppArgumentList&, CppVariant*);
250 void display(const CppArgumentList&, CppVariant*);
251 void testRepaint(const CppArgumentList&, CppVariant*);
252 void repaintSweepHorizontally(const CppArgumentList&, CppVariant*);
253 void clearBackForwardList(const CppArgumentList&, CppVariant*);
254 void keepWebHistory(const CppArgumentList&, CppVariant*);
255 void storeWebScriptObject(const CppArgumentList&, CppVariant*);
256 void accessStoredWebScriptObject(const CppArgumentList&, CppVariant*);
257 void objCClassNameOf(const CppArgumentList&, CppVariant*);
258 void addDisallowedURL(const CppArgumentList&, CppVariant*);
259 void callShouldCloseOnWebView(const CppArgumentList&, CppVariant*);
260 void setCallCloseOnWebViews(const CppArgumentList&, CppVariant*);
261 void setPrivateBrowsingEnabled(const CppArgumentList&, CppVariant*);
263 void setJavaScriptCanAccessClipboard(const CppArgumentList&, CppVariant*);
264 void setXSSAuditorEnabled(const CppArgumentList&, CppVariant*);
265 void evaluateScriptInIsolatedWorld(const CppArgumentList&, CppVariant*);
266 void overridePreference(const CppArgumentList&, CppVariant*);
267 void setAllowUniversalAccessFromFileURLs(const CppArgumentList&, CppVariant*);
268 void setAllowFileAccessFromFileURLs(const CppArgumentList&, CppVariant*);
271 // The fallback method is called when a nonexistent method is called on
272 // the layout test controller object.
273 // It is usefull to catch typos in the JavaScript code (a few layout tests
274 // do have typos in them) and it allows the script to continue running in
275 // that case (as the Mac does).
276 void fallbackMethod(const CppArgumentList&, CppVariant*);
278 // Allows layout tests to manage origins' whitelisting.
279 void addOriginAccessWhitelistEntry(const CppArgumentList&, CppVariant*);
280 void removeOriginAccessWhitelistEntry(const CppArgumentList&, CppVariant*);
282 // Clears all Application Caches.
283 void clearAllApplicationCaches(const CppArgumentList&, CppVariant*);
284 // Sets the Application Quota for the localhost origin.
285 void setApplicationCacheOriginQuota(const CppArgumentList&, CppVariant*);
287 // Clears all databases.
288 void clearAllDatabases(const CppArgumentList&, CppVariant*);
289 // Sets the default quota for all origins
290 void setDatabaseQuota(const CppArgumentList&, CppVariant*);
292 // Calls setlocale(LC_ALL, ...) for a specified locale.
293 // Resets between tests.
294 void setPOSIXLocale(const CppArgumentList&, CppVariant*);
296 // Gets the value of the counter in the element specified by its ID.
297 void counterValueForElementById(const CppArgumentList&, CppVariant*);
299 // Gets the number of page where the specified element will be put.
300 void pageNumberForElementById(const CppArgumentList&, CppVariant*);
302 // Gets the number of pages to be printed.
303 void numberOfPages(const CppArgumentList&, CppVariant*);
306 // Allows layout tests to start Timeline profiling.
307 void setTimelineProfilingEnabled(const CppArgumentList&, CppVariant*);
309 // Allows layout tests to exec scripts at WebInspector side.
310 void evaluateInWebInspector(const CppArgumentList&, CppVariant*);
312 // Forces the selection colors for testing under Linux.
313 void forceRedSelectionColors(const CppArgumentList&, CppVariant*);
315 // Adds a user script or user style sheet to be injected into new documents.
316 void addUserScript(const CppArgumentList&, CppVariant*);
317 void addUserStyleSheet(const CppArgumentList&, CppVariant*);
319 // DeviceOrientation related functions
320 void setMockDeviceOrientation(const CppArgumentList&, CppVariant*);
322 // Geolocation related functions.
323 void setGeolocationPermission(const CppArgumentList&, CppVariant*);
324 void setMockGeolocationPosition(const CppArgumentList&, CppVariant*);
325 void setMockGeolocationError(const CppArgumentList&, CppVariant*);
327 // Empty stub method to keep parity with object model exposed by global LayoutTestController.
328 void abortModal(const CppArgumentList&, CppVariant*);
330 // Speech input related functions.
331 void setMockSpeechInputResult(const CppArgumentList&, CppVariant*);
333 void layerTreeAsText(const CppArgumentList& args, CppVariant* result);
335 void markerTextForListItem(const CppArgumentList&, CppVariant*);
336 void hasSpellingMarker(const CppArgumentList&, CppVariant*);
339 // The following methods are not exposed to JavaScript.
340 void setWorkQueueFrozen(bool frozen) { m_workQueue.setFrozen(frozen); }
342 WebKit::WebSpeechInputController* speechInputController(WebKit::WebSpeechInputListener*);
343 WebKit::WebDeviceOrientationClient* deviceOrientationClient();
344 bool shouldDumpAsText() { return m_dumpAsText; }
345 bool shouldDumpEditingCallbacks() { return m_dumpEditingCallbacks; }
346 bool shouldDumpFrameLoadCallbacks() { return m_dumpFrameLoadCallbacks; }
347 void setShouldDumpFrameLoadCallbacks(bool value) { m_dumpFrameLoadCallbacks = value; }
348 bool shouldDumpUserGestureInFrameLoadCallbacks() { return m_dumpUserGestureInFrameLoadCallbacks; }
349 void setShouldDumpUserGestureInFrameLoadCallbacks(bool value) { m_dumpUserGestureInFrameLoadCallbacks = value; }
350 bool shouldDumpResourceLoadCallbacks() {return m_dumpResourceLoadCallbacks; }
351 void setShouldDumpResourceResponseMIMETypes(bool value) { m_dumpResourceResponseMIMETypes = value; }
352 bool shouldDumpResourceResponseMIMETypes() {return m_dumpResourceResponseMIMETypes; }
353 bool shouldDumpStatusCallbacks() { return m_dumpWindowStatusChanges; }
354 bool shouldDumpSelectionRect() { return m_dumpSelectionRect; }
355 bool shouldDumpBackForwardList() { return m_dumpBackForwardList; }
356 bool shouldDumpTitleChanges() { return m_dumpTitleChanges; }
357 bool shouldDumpChildFrameScrollPositions() { return m_dumpChildFrameScrollPositions; }
358 bool shouldDumpChildFramesAsText() { return m_dumpChildFramesAsText; }
359 bool shouldGeneratePixelResults() { return m_generatePixelResults; }
360 bool acceptsEditing() { return m_acceptsEditing; }
361 bool canOpenWindows() { return m_canOpenWindows; }
362 bool shouldAddFileToPasteboard() { return m_shouldAddFileToPasteboard; }
363 bool stopProvisionalFrameLoads() { return m_stopProvisionalFrameLoads; }
364 bool deferMainResourceDataLoad() { return m_deferMainResourceDataLoad; }
366 bool testRepaint() const { return m_testRepaint; }
367 bool sweepHorizontally() const { return m_sweepHorizontally; }
369 // Called by the webview delegate when the toplevel frame load is done.
370 void locationChangeDone();
372 // Called by the webview delegate when the policy delegate runs if the
373 // waitForPolicyDelegate was called.
374 void policyDelegateDone();
376 // Reinitializes all static values. The reset() method should be called
377 // before the start of each test (currently from
378 // TestShell::runFileTest).
381 // A single item in the work queue.
384 virtual ~WorkItem() {}
386 // Returns true if this started a load.
387 virtual bool run(TestShell* shell) = 0;
390 TaskList* taskList() { return &m_taskList; }
393 friend class WorkItem;
394 friend class WorkQueue;
396 // Helper class for managing events queued by methods like queueLoad or
400 WorkQueue(LayoutTestController* controller) : m_frozen(false), m_controller(controller) {}
401 virtual ~WorkQueue();
402 void processWorkSoon();
404 // Reset the state of the class between tests.
407 void addWork(WorkItem* work);
409 void setFrozen(bool frozen) { m_frozen = frozen; }
410 bool isEmpty() { return m_queue.isEmpty(); }
411 TaskList* taskList() { return &m_taskList; }
415 class WorkQueueTask: public MethodTask<WorkQueue> {
417 WorkQueueTask(WorkQueue* object): MethodTask<WorkQueue>(object) {}
418 virtual void runIfValid() { m_object->processWork(); }
422 Deque<WorkItem*> m_queue;
424 LayoutTestController* m_controller;
427 // Support for overridePreference.
428 bool cppVariantToBool(const CppVariant&);
429 int32_t cppVariantToInt32(const CppVariant&);
430 WebKit::WebString cppVariantToWebString(const CppVariant&);
432 void logErrorToConsole(const std::string&);
433 void completeNotifyDone(bool isTimeout);
434 class NotifyDoneTimedOutTask: public MethodTask<LayoutTestController> {
436 NotifyDoneTimedOutTask(LayoutTestController* object): MethodTask<LayoutTestController>(object) {}
437 virtual void runIfValid() { m_object->completeNotifyDone(true); }
441 bool pauseAnimationAtTimeOnElementWithId(const WebKit::WebString& animationName, double time, const WebKit::WebString& elementId);
442 bool pauseTransitionAtTimeOnElementWithId(const WebKit::WebString& propertyName, double time, const WebKit::WebString& elementId);
443 bool elementDoesAutoCompleteForElementWithId(const WebKit::WebString&);
444 int numberOfActiveAnimations();
445 void suspendAnimations();
446 void resumeAnimations();
448 // Used for test timeouts.
451 // Non-owning pointer. The LayoutTestController is owned by the host.
454 // If true, the test_shell will produce a plain text dump rather than a
455 // text representation of the renderer.
458 // If true, the test_shell will write a descriptive line for each editing
460 bool m_dumpEditingCallbacks;
462 // If true, the test_shell will draw the bounds of the current selection rect
463 // taking possible transforms of the selection rect into account.
464 bool m_dumpSelectionRect;
466 // If true, the test_shell will output a descriptive line for each frame
468 bool m_dumpFrameLoadCallbacks;
470 // If true, the test_shell will output a line of the user gesture status
471 // text for some frame load callbacks.
472 bool m_dumpUserGestureInFrameLoadCallbacks;
474 // If true, the test_shell will output a descriptive line for each resource
476 bool m_dumpResourceLoadCallbacks;
478 // If true, the test_shell will output the MIME type for each resource that
480 bool m_dumpResourceResponseMIMETypes;
482 // If true, the test_shell will produce a dump of the back forward list as
484 bool m_dumpBackForwardList;
486 // If true, the test_shell will print out the child frame scroll offsets as
488 bool m_dumpChildFrameScrollPositions;
490 // If true and if dump_as_text_ is true, the test_shell will recursively
491 // dump all frames as plain text.
492 bool m_dumpChildFramesAsText;
494 // If true, the test_shell will dump all changes to window.status.
495 bool m_dumpWindowStatusChanges;
497 // If true, output a message when the page title is changed.
498 bool m_dumpTitleChanges;
500 // If true, the test_shell will generate pixel results in dumpAsText mode
501 bool m_generatePixelResults;
503 // If true, the element will be treated as editable. This value is returned
504 // from various editing callbacks that are called just before edit operations
506 bool m_acceptsEditing;
508 // If true, new windows can be opened via javascript or by plugins. By
509 // default, set to false and can be toggled to true using
510 // setCanOpenWindows().
511 bool m_canOpenWindows;
513 // When reset is called, go through and close all but the main test shell
514 // window. By default, set to true but toggled to false using
515 // setCloseRemainingWindowsWhenComplete().
516 bool m_closeRemainingWindows;
518 // If true, pixel dump will be produced as a series of 1px-tall, view-wide
519 // individual paints over the height of the view.
521 // If true and test_repaint_ is true as well, pixel dump will be produced as
522 // a series of 1px-wide, view-tall paints across the width of the view.
523 bool m_sweepHorizontally;
525 // If true and a drag starts, adds a file to the drag&drop clipboard.
526 bool m_shouldAddFileToPasteboard;
528 // If true, stops provisional frame loads during the
529 // DidStartProvisionalLoadForFrame callback.
530 bool m_stopProvisionalFrameLoads;
532 // If true, don't dump output until notifyDone is called.
533 bool m_waitUntilDone;
535 // If false, all new requests will not defer the main resource data load.
536 bool m_deferMainResourceDataLoad;
538 WorkQueue m_workQueue;
540 CppVariant m_globalFlag;
542 // Bound variable counting the number of top URLs visited.
543 CppVariant m_webHistoryItemCount;
545 WebKit::WebURL m_userStyleSheetLocation;
547 OwnPtr<WebKit::WebSpeechInputControllerMock> m_speechInputControllerMock;
549 OwnPtr<WebKit::WebDeviceOrientationClientMock> m_deviceOrientationClientMock;
552 #endif // LayoutTestController_h