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 "public/WebString.h"
47 #include "public/WebURL.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 out a text
92 // representation of the back/forward list. It ignores all arguments.
93 void dumpBackForwardList(const CppArgumentList&, CppVariant*);
95 // This function sets a flag that tells the test_shell to print out the
96 // scroll offsets of the child frames. It ignores all.
97 void dumpChildFrameScrollPositions(const CppArgumentList&, CppVariant*);
99 // This function sets a flag that tells the test_shell to recursively
100 // dump all frames as plain text if the dumpAsText flag is set.
101 // It takes no arguments, and ignores any that may be present.
102 void dumpChildFramesAsText(const CppArgumentList&, CppVariant*);
104 // This function sets a flag that tells the test_shell to dump a descriptive
105 // line for each resource load callback. It takes no arguments, and ignores
106 // any that may be present.
107 void dumpResourceLoadCallbacks(const CppArgumentList&, CppVariant*);
109 // This function sets a flag that tells the test_shell to dump the MIME type
110 // for each resource that was loaded. It takes no arguments, and ignores any
111 // that may be present.
112 void dumpResourceResponseMIMETypes(const CppArgumentList&, CppVariant*);
114 // This function sets a flag that tells the test_shell to dump all calls
115 // to window.status().
116 // It takes no arguments, and ignores any that may be present.
117 void dumpWindowStatusChanges(const CppArgumentList&, CppVariant*);
119 // When called with a boolean argument, this sets a flag that controls
120 // whether content-editable elements accept editing focus when an editing
121 // attempt is made. It ignores any additional arguments.
122 void setAcceptsEditing(const CppArgumentList&, CppVariant*);
124 // Functions for dealing with windows. By default we block all new windows.
125 void windowCount(const CppArgumentList&, CppVariant*);
126 void setCanOpenWindows(const CppArgumentList&, CppVariant*);
127 void setCloseRemainingWindowsWhenComplete(const CppArgumentList&, CppVariant*);
129 // By default, tests end when page load is complete. These methods are used
130 // to delay the completion of the test until notifyDone is called.
131 void waitUntilDone(const CppArgumentList&, CppVariant*);
132 void notifyDone(const CppArgumentList&, CppVariant*);
134 // Methods for adding actions to the work queue. Used in conjunction with
135 // waitUntilDone/notifyDone above.
136 void queueBackNavigation(const CppArgumentList&, CppVariant*);
137 void queueForwardNavigation(const CppArgumentList&, CppVariant*);
138 void queueReload(const CppArgumentList&, CppVariant*);
139 void queueLoadingScript(const CppArgumentList&, CppVariant*);
140 void queueNonLoadingScript(const CppArgumentList&, CppVariant*);
141 void queueLoad(const CppArgumentList&, CppVariant*);
142 void queueLoadHTMLString(const CppArgumentList&, CppVariant*);
144 // Although this is named "objC" to match the Mac version, it actually tests
145 // the identity of its two arguments in C++.
146 void objCIdentityIsEqual(const CppArgumentList&, CppVariant*);
148 // Changes the cookie policy from the default to allow all cookies.
149 void setAlwaysAcceptCookies(const CppArgumentList&, CppVariant*);
151 // Shows DevTools window.
152 void showWebInspector(const CppArgumentList&, CppVariant*);
153 void closeWebInspector(const CppArgumentList&, CppVariant*);
155 // Gives focus to the window.
156 void setWindowIsKey(const CppArgumentList&, CppVariant*);
158 // Method that controls whether pressing Tab key cycles through page elements
159 // or inserts a '\t' char in text area
160 void setTabKeyCyclesThroughElements(const CppArgumentList&, CppVariant*);
162 // Passes through to WebPreferences which allows the user to have a custom
164 void setUserStyleSheetEnabled(const CppArgumentList&, CppVariant*);
165 void setUserStyleSheetLocation(const CppArgumentList&, CppVariant*);
167 // Passes this preference through to WebSettings.
168 void setAuthorAndUserStylesEnabled(const CppArgumentList&, CppVariant*);
170 // Puts Webkit in "dashboard compatibility mode", which is used in obscure
171 // Mac-only circumstances. It's not really necessary, and will most likely
172 // never be used by Chrome, but some layout tests depend on its presence.
173 void setUseDashboardCompatibilityMode(const CppArgumentList&, CppVariant*);
175 void setScrollbarPolicy(const CppArgumentList&, CppVariant*);
177 // Causes navigation actions just printout the intended navigation instead
178 // of taking you to the page. This is used for cases like mailto, where you
179 // don't actually want to open the mail program.
180 void setCustomPolicyDelegate(const CppArgumentList&, CppVariant*);
182 // Delays completion of the test until the policy delegate runs.
183 void waitForPolicyDelegate(const CppArgumentList&, CppVariant*);
185 // Causes WillSendRequest to clear certain headers.
186 void setWillSendRequestClearHeader(const CppArgumentList&, CppVariant*);
188 // Causes WillSendRequest to block redirects.
189 void setWillSendRequestReturnsNullOnRedirect(const CppArgumentList&, CppVariant*);
191 // Causes WillSendRequest to return an empty request.
192 void setWillSendRequestReturnsNull(const CppArgumentList&, CppVariant*);
194 // Converts a URL starting with file:///tmp/ to the local mapping.
195 void pathToLocalResource(const CppArgumentList&, CppVariant*);
197 // Sets a bool such that when a drag is started, we fill the drag clipboard
198 // with a fake file object.
199 void addFileToPasteboardOnDrag(const CppArgumentList&, CppVariant*);
201 // Executes an internal command (superset of document.execCommand() commands).
202 void execCommand(const CppArgumentList&, CppVariant*);
204 // Checks if an internal command is currently available.
205 void isCommandEnabled(const CppArgumentList&, CppVariant*);
207 // Set the WebPreference that controls webkit's popup blocking.
208 void setPopupBlockingEnabled(const CppArgumentList&, CppVariant*);
210 // If true, causes provisional frame loads to be stopped for the remainder of
212 void setStopProvisionalFrameLoads(const CppArgumentList&, CppVariant*);
214 // Enable or disable smart insert/delete. This is enabled by default.
215 void setSmartInsertDeleteEnabled(const CppArgumentList&, CppVariant*);
217 // Enable or disable trailing whitespace selection on double click.
218 void setSelectTrailingWhitespaceEnabled(const CppArgumentList&, CppVariant*);
220 void pauseAnimationAtTimeOnElementWithId(const CppArgumentList&, CppVariant*);
221 void pauseTransitionAtTimeOnElementWithId(const CppArgumentList&, CppVariant*);
222 void elementDoesAutoCompleteForElementWithId(const CppArgumentList&, CppVariant*);
223 void numberOfActiveAnimations(const CppArgumentList&, CppVariant*);
224 void suspendAnimations(const CppArgumentList&, CppVariant*);
225 void resumeAnimations(const CppArgumentList&, CppVariant*);
226 void sampleSVGAnimationForElementAtTime(const CppArgumentList&, CppVariant*);
227 void disableImageLoading(const CppArgumentList&, CppVariant*);
228 void setIconDatabaseEnabled(const CppArgumentList&, CppVariant*);
229 void dumpSelectionRect(const CppArgumentList&, CppVariant*);
231 // Grants permission for desktop notifications to an origin
232 void grantDesktopNotificationPermission(const CppArgumentList&, CppVariant*);
233 // Simulates a click on a desktop notification.
234 void simulateDesktopNotificationClick(const CppArgumentList&, CppVariant*);
236 void setDomainRelaxationForbiddenForURLScheme(const CppArgumentList&, CppVariant*);
237 void setDeferMainResourceDataLoad(const CppArgumentList&, CppVariant*);
238 void setEditingBehavior(const CppArgumentList&, CppVariant*);
240 // The following are only stubs. TODO(pamg): Implement any of these that
241 // are needed to pass the layout tests.
242 void dumpAsWebArchive(const CppArgumentList&, CppVariant*);
243 void dumpTitleChanges(const CppArgumentList&, CppVariant*);
244 void setMainFrameIsFirstResponder(const CppArgumentList&, CppVariant*);
245 void display(const CppArgumentList&, CppVariant*);
246 void testRepaint(const CppArgumentList&, CppVariant*);
247 void repaintSweepHorizontally(const CppArgumentList&, CppVariant*);
248 void clearBackForwardList(const CppArgumentList&, CppVariant*);
249 void keepWebHistory(const CppArgumentList&, CppVariant*);
250 void storeWebScriptObject(const CppArgumentList&, CppVariant*);
251 void accessStoredWebScriptObject(const CppArgumentList&, CppVariant*);
252 void objCClassNameOf(const CppArgumentList&, CppVariant*);
253 void addDisallowedURL(const CppArgumentList&, CppVariant*);
254 void callShouldCloseOnWebView(const CppArgumentList&, CppVariant*);
255 void setCallCloseOnWebViews(const CppArgumentList&, CppVariant*);
256 void setPrivateBrowsingEnabled(const CppArgumentList&, CppVariant*);
258 void setJavaScriptCanAccessClipboard(const CppArgumentList&, CppVariant*);
259 void setXSSAuditorEnabled(const CppArgumentList&, CppVariant*);
260 void evaluateScriptInIsolatedWorld(const CppArgumentList&, CppVariant*);
261 void overridePreference(const CppArgumentList&, CppVariant*);
262 void setAllowUniversalAccessFromFileURLs(const CppArgumentList&, CppVariant*);
263 void setAllowFileAccessFromFileURLs(const CppArgumentList&, CppVariant*);
266 // The fallback method is called when a nonexistent method is called on
267 // the layout test controller object.
268 // It is usefull to catch typos in the JavaScript code (a few layout tests
269 // do have typos in them) and it allows the script to continue running in
270 // that case (as the Mac does).
271 void fallbackMethod(const CppArgumentList&, CppVariant*);
273 // Allows layout tests to manage origins' whitelisting.
274 void addOriginAccessWhitelistEntry(const CppArgumentList&, CppVariant*);
275 void removeOriginAccessWhitelistEntry(const CppArgumentList&, CppVariant*);
277 // Clears all Application Caches.
278 void clearAllApplicationCaches(const CppArgumentList&, CppVariant*);
279 // Sets the Application Quota for the localhost origin.
280 void setApplicationCacheOriginQuota(const CppArgumentList&, CppVariant*);
282 // Clears all databases.
283 void clearAllDatabases(const CppArgumentList&, CppVariant*);
284 // Sets the default quota for all origins
285 void setDatabaseQuota(const CppArgumentList&, CppVariant*);
287 // Calls setlocale(LC_ALL, ...) for a specified locale.
288 // Resets between tests.
289 void setPOSIXLocale(const CppArgumentList&, CppVariant*);
291 // Gets the value of the counter in the element specified by its ID.
292 void counterValueForElementById(const CppArgumentList&, CppVariant*);
294 // Gets the number of page where the specified element will be put.
295 void pageNumberForElementById(const CppArgumentList&, CppVariant*);
297 // Gets the number of pages to be printed.
298 void numberOfPages(const CppArgumentList&, CppVariant*);
301 // Allows layout tests to start Timeline profiling.
302 void setTimelineProfilingEnabled(const CppArgumentList&, CppVariant*);
304 // Allows layout tests to exec scripts at WebInspector side.
305 void evaluateInWebInspector(const CppArgumentList&, CppVariant*);
307 // Forces the selection colors for testing under Linux.
308 void forceRedSelectionColors(const CppArgumentList&, CppVariant*);
310 // Adds a user script or user style sheet to be injected into new documents.
311 void addUserScript(const CppArgumentList&, CppVariant*);
312 void addUserStyleSheet(const CppArgumentList&, CppVariant*);
314 // DeviceOrientation related functions
315 void setMockDeviceOrientation(const CppArgumentList&, CppVariant*);
317 // Geolocation related functions.
318 void setGeolocationPermission(const CppArgumentList&, CppVariant*);
319 void setMockGeolocationPosition(const CppArgumentList&, CppVariant*);
320 void setMockGeolocationError(const CppArgumentList&, CppVariant*);
322 // Empty stub method to keep parity with object model exposed by global LayoutTestController.
323 void abortModal(const CppArgumentList&, CppVariant*);
325 // Speech input related functions.
326 void setMockSpeechInputResult(const CppArgumentList&, CppVariant*);
328 void markerTextForListItem(const CppArgumentList&, CppVariant*);
331 // The following methods are not exposed to JavaScript.
332 void setWorkQueueFrozen(bool frozen) { m_workQueue.setFrozen(frozen); }
334 WebKit::WebSpeechInputController* speechInputController(WebKit::WebSpeechInputListener*);
335 WebKit::WebDeviceOrientationClient* deviceOrientationClient();
336 bool shouldDumpAsText() { return m_dumpAsText; }
337 bool shouldDumpEditingCallbacks() { return m_dumpEditingCallbacks; }
338 bool shouldDumpFrameLoadCallbacks() { return m_dumpFrameLoadCallbacks; }
339 void setShouldDumpFrameLoadCallbacks(bool value) { m_dumpFrameLoadCallbacks = value; }
340 bool shouldDumpResourceLoadCallbacks() {return m_dumpResourceLoadCallbacks; }
341 void setShouldDumpResourceResponseMIMETypes(bool value) { m_dumpResourceResponseMIMETypes = value; }
342 bool shouldDumpResourceResponseMIMETypes() {return m_dumpResourceResponseMIMETypes; }
343 bool shouldDumpStatusCallbacks() { return m_dumpWindowStatusChanges; }
344 bool shouldDumpSelectionRect() { return m_dumpSelectionRect; }
345 bool shouldDumpBackForwardList() { return m_dumpBackForwardList; }
346 bool shouldDumpTitleChanges() { return m_dumpTitleChanges; }
347 bool shouldDumpChildFrameScrollPositions() { return m_dumpChildFrameScrollPositions; }
348 bool shouldDumpChildFramesAsText() { return m_dumpChildFramesAsText; }
349 bool shouldGeneratePixelResults() { return m_generatePixelResults; }
350 bool acceptsEditing() { return m_acceptsEditing; }
351 bool canOpenWindows() { return m_canOpenWindows; }
352 bool shouldAddFileToPasteboard() { return m_shouldAddFileToPasteboard; }
353 bool stopProvisionalFrameLoads() { return m_stopProvisionalFrameLoads; }
354 bool deferMainResourceDataLoad() { return m_deferMainResourceDataLoad; }
356 bool testRepaint() const { return m_testRepaint; }
357 bool sweepHorizontally() const { return m_sweepHorizontally; }
359 // Called by the webview delegate when the toplevel frame load is done.
360 void locationChangeDone();
362 // Called by the webview delegate when the policy delegate runs if the
363 // waitForPolicyDelegate was called.
364 void policyDelegateDone();
366 // Reinitializes all static values. The reset() method should be called
367 // before the start of each test (currently from
368 // TestShell::runFileTest).
371 // A single item in the work queue.
374 virtual ~WorkItem() {}
376 // Returns true if this started a load.
377 virtual bool run(TestShell* shell) = 0;
380 TaskList* taskList() { return &m_taskList; }
383 friend class WorkItem;
384 friend class WorkQueue;
386 // Helper class for managing events queued by methods like queueLoad or
390 WorkQueue(LayoutTestController* controller) : m_frozen(false), m_controller(controller) {}
391 virtual ~WorkQueue();
392 void processWorkSoon();
394 // Reset the state of the class between tests.
397 void addWork(WorkItem* work);
399 void setFrozen(bool frozen) { m_frozen = frozen; }
400 bool isEmpty() { return m_queue.isEmpty(); }
401 TaskList* taskList() { return &m_taskList; }
405 class WorkQueueTask: public MethodTask<WorkQueue> {
407 WorkQueueTask(WorkQueue* object): MethodTask<WorkQueue>(object) {}
408 virtual void runIfValid() { m_object->processWork(); }
412 Deque<WorkItem*> m_queue;
414 LayoutTestController* m_controller;
417 // Support for overridePreference.
418 bool cppVariantToBool(const CppVariant&);
419 int32_t cppVariantToInt32(const CppVariant&);
420 WebKit::WebString cppVariantToWebString(const CppVariant&);
422 void logErrorToConsole(const std::string&);
423 void completeNotifyDone(bool isTimeout);
424 class NotifyDoneTimedOutTask: public MethodTask<LayoutTestController> {
426 NotifyDoneTimedOutTask(LayoutTestController* object): MethodTask<LayoutTestController>(object) {}
427 virtual void runIfValid() { m_object->completeNotifyDone(true); }
431 bool pauseAnimationAtTimeOnElementWithId(const WebKit::WebString& animationName, double time, const WebKit::WebString& elementId);
432 bool pauseTransitionAtTimeOnElementWithId(const WebKit::WebString& propertyName, double time, const WebKit::WebString& elementId);
433 bool elementDoesAutoCompleteForElementWithId(const WebKit::WebString&);
434 int numberOfActiveAnimations();
435 void suspendAnimations();
436 void resumeAnimations();
438 // Used for test timeouts.
441 // Non-owning pointer. The LayoutTestController is owned by the host.
444 // If true, the test_shell will produce a plain text dump rather than a
445 // text representation of the renderer.
448 // If true, the test_shell will write a descriptive line for each editing
450 bool m_dumpEditingCallbacks;
452 // If true, the test_shell will draw the bounds of the current selection rect
453 // taking possible transforms of the selection rect into account.
454 bool m_dumpSelectionRect;
456 // If true, the test_shell will output a descriptive line for each frame
458 bool m_dumpFrameLoadCallbacks;
460 // If true, the test_shell will output a descriptive line for each resource
462 bool m_dumpResourceLoadCallbacks;
464 // If true, the test_shell will output the MIME type for each resource that
466 bool m_dumpResourceResponseMIMETypes;
468 // If true, the test_shell will produce a dump of the back forward list as
470 bool m_dumpBackForwardList;
472 // If true, the test_shell will print out the child frame scroll offsets as
474 bool m_dumpChildFrameScrollPositions;
476 // If true and if dump_as_text_ is true, the test_shell will recursively
477 // dump all frames as plain text.
478 bool m_dumpChildFramesAsText;
480 // If true, the test_shell will dump all changes to window.status.
481 bool m_dumpWindowStatusChanges;
483 // If true, output a message when the page title is changed.
484 bool m_dumpTitleChanges;
486 // If true, the test_shell will generate pixel results in dumpAsText mode
487 bool m_generatePixelResults;
489 // If true, the element will be treated as editable. This value is returned
490 // from various editing callbacks that are called just before edit operations
492 bool m_acceptsEditing;
494 // If true, new windows can be opened via javascript or by plugins. By
495 // default, set to false and can be toggled to true using
496 // setCanOpenWindows().
497 bool m_canOpenWindows;
499 // When reset is called, go through and close all but the main test shell
500 // window. By default, set to true but toggled to false using
501 // setCloseRemainingWindowsWhenComplete().
502 bool m_closeRemainingWindows;
504 // If true, pixel dump will be produced as a series of 1px-tall, view-wide
505 // individual paints over the height of the view.
507 // If true and test_repaint_ is true as well, pixel dump will be produced as
508 // a series of 1px-wide, view-tall paints across the width of the view.
509 bool m_sweepHorizontally;
511 // If true and a drag starts, adds a file to the drag&drop clipboard.
512 bool m_shouldAddFileToPasteboard;
514 // If true, stops provisional frame loads during the
515 // DidStartProvisionalLoadForFrame callback.
516 bool m_stopProvisionalFrameLoads;
518 // If true, don't dump output until notifyDone is called.
519 bool m_waitUntilDone;
521 // If false, all new requests will not defer the main resource data load.
522 bool m_deferMainResourceDataLoad;
524 WorkQueue m_workQueue;
526 CppVariant m_globalFlag;
528 // Bound variable counting the number of top URLs visited.
529 CppVariant m_webHistoryItemCount;
531 WebKit::WebURL m_userStyleSheetLocation;
533 OwnPtr<WebKit::WebSpeechInputControllerMock> m_speechInputControllerMock;
535 OwnPtr<WebKit::WebDeviceOrientationClientMock> m_deviceOrientationClientMock;
538 #endif // LayoutTestController_h