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 disableImageLoading(const CppArgumentList&, CppVariant*);
227 void setIconDatabaseEnabled(const CppArgumentList&, CppVariant*);
228 void dumpSelectionRect(const CppArgumentList&, CppVariant*);
230 // Grants permission for desktop notifications to an origin
231 void grantDesktopNotificationPermission(const CppArgumentList&, CppVariant*);
232 // Simulates a click on a desktop notification.
233 void simulateDesktopNotificationClick(const CppArgumentList&, CppVariant*);
235 void setDomainRelaxationForbiddenForURLScheme(const CppArgumentList&, CppVariant*);
236 void setDeferMainResourceDataLoad(const CppArgumentList&, CppVariant*);
237 void setEditingBehavior(const CppArgumentList&, CppVariant*);
239 // The following are only stubs. TODO(pamg): Implement any of these that
240 // are needed to pass the layout tests.
241 void dumpAsWebArchive(const CppArgumentList&, CppVariant*);
242 void dumpTitleChanges(const CppArgumentList&, CppVariant*);
243 void setMainFrameIsFirstResponder(const CppArgumentList&, CppVariant*);
244 void display(const CppArgumentList&, CppVariant*);
245 void testRepaint(const CppArgumentList&, CppVariant*);
246 void repaintSweepHorizontally(const CppArgumentList&, CppVariant*);
247 void clearBackForwardList(const CppArgumentList&, CppVariant*);
248 void keepWebHistory(const CppArgumentList&, CppVariant*);
249 void storeWebScriptObject(const CppArgumentList&, CppVariant*);
250 void accessStoredWebScriptObject(const CppArgumentList&, CppVariant*);
251 void objCClassNameOf(const CppArgumentList&, CppVariant*);
252 void addDisallowedURL(const CppArgumentList&, CppVariant*);
253 void callShouldCloseOnWebView(const CppArgumentList&, CppVariant*);
254 void setCallCloseOnWebViews(const CppArgumentList&, CppVariant*);
255 void setPrivateBrowsingEnabled(const CppArgumentList&, CppVariant*);
257 void setJavaScriptCanAccessClipboard(const CppArgumentList&, CppVariant*);
258 void setXSSAuditorEnabled(const CppArgumentList&, CppVariant*);
259 void evaluateScriptInIsolatedWorld(const CppArgumentList&, CppVariant*);
260 void overridePreference(const CppArgumentList&, CppVariant*);
261 void setAllowUniversalAccessFromFileURLs(const CppArgumentList&, CppVariant*);
262 void setAllowFileAccessFromFileURLs(const CppArgumentList&, CppVariant*);
265 // The fallback method is called when a nonexistent method is called on
266 // the layout test controller object.
267 // It is usefull to catch typos in the JavaScript code (a few layout tests
268 // do have typos in them) and it allows the script to continue running in
269 // that case (as the Mac does).
270 void fallbackMethod(const CppArgumentList&, CppVariant*);
272 // Allows layout tests to manage origins' whitelisting.
273 void addOriginAccessWhitelistEntry(const CppArgumentList&, CppVariant*);
274 void removeOriginAccessWhitelistEntry(const CppArgumentList&, CppVariant*);
276 // Clears all Application Caches.
277 void clearAllApplicationCaches(const CppArgumentList&, CppVariant*);
278 // Sets the Application Quota for the localhost origin.
279 void setApplicationCacheOriginQuota(const CppArgumentList&, CppVariant*);
281 // Clears all databases.
282 void clearAllDatabases(const CppArgumentList&, CppVariant*);
283 // Sets the default quota for all origins
284 void setDatabaseQuota(const CppArgumentList&, CppVariant*);
286 // Calls setlocale(LC_ALL, ...) for a specified locale.
287 // Resets between tests.
288 void setPOSIXLocale(const CppArgumentList&, CppVariant*);
290 // Gets the value of the counter in the element specified by its ID.
291 void counterValueForElementById(const CppArgumentList&, CppVariant*);
293 // Gets the number of page where the specified element will be put.
294 void pageNumberForElementById(const CppArgumentList&, CppVariant*);
296 // Gets the number of pages to be printed.
297 void numberOfPages(const CppArgumentList&, CppVariant*);
300 // Allows layout tests to start Timeline profiling.
301 void setTimelineProfilingEnabled(const CppArgumentList&, CppVariant*);
303 // Allows layout tests to exec scripts at WebInspector side.
304 void evaluateInWebInspector(const CppArgumentList&, CppVariant*);
306 // Forces the selection colors for testing under Linux.
307 void forceRedSelectionColors(const CppArgumentList&, CppVariant*);
309 // Adds a user script or user style sheet to be injected into new documents.
310 void addUserScript(const CppArgumentList&, CppVariant*);
311 void addUserStyleSheet(const CppArgumentList&, CppVariant*);
313 // DeviceOrientation related functions
314 void setMockDeviceOrientation(const CppArgumentList&, CppVariant*);
316 // Geolocation related functions.
317 void setGeolocationPermission(const CppArgumentList&, CppVariant*);
318 void setMockGeolocationPosition(const CppArgumentList&, CppVariant*);
319 void setMockGeolocationError(const CppArgumentList&, CppVariant*);
321 // Empty stub method to keep parity with object model exposed by global LayoutTestController.
322 void abortModal(const CppArgumentList&, CppVariant*);
324 // Speech input related functions.
325 void setMockSpeechInputResult(const CppArgumentList&, CppVariant*);
327 void markerTextForListItem(const CppArgumentList&, CppVariant*);
330 // The following methods are not exposed to JavaScript.
331 void setWorkQueueFrozen(bool frozen) { m_workQueue.setFrozen(frozen); }
333 WebKit::WebSpeechInputController* speechInputController(WebKit::WebSpeechInputListener*);
334 WebKit::WebDeviceOrientationClient* deviceOrientationClient();
335 bool shouldDumpAsText() { return m_dumpAsText; }
336 bool shouldDumpEditingCallbacks() { return m_dumpEditingCallbacks; }
337 bool shouldDumpFrameLoadCallbacks() { return m_dumpFrameLoadCallbacks; }
338 void setShouldDumpFrameLoadCallbacks(bool value) { m_dumpFrameLoadCallbacks = value; }
339 bool shouldDumpResourceLoadCallbacks() {return m_dumpResourceLoadCallbacks; }
340 void setShouldDumpResourceResponseMIMETypes(bool value) { m_dumpResourceResponseMIMETypes = value; }
341 bool shouldDumpResourceResponseMIMETypes() {return m_dumpResourceResponseMIMETypes; }
342 bool shouldDumpStatusCallbacks() { return m_dumpWindowStatusChanges; }
343 bool shouldDumpSelectionRect() { return m_dumpSelectionRect; }
344 bool shouldDumpBackForwardList() { return m_dumpBackForwardList; }
345 bool shouldDumpTitleChanges() { return m_dumpTitleChanges; }
346 bool shouldDumpChildFrameScrollPositions() { return m_dumpChildFrameScrollPositions; }
347 bool shouldDumpChildFramesAsText() { return m_dumpChildFramesAsText; }
348 bool shouldGeneratePixelResults() { return m_generatePixelResults; }
349 bool acceptsEditing() { return m_acceptsEditing; }
350 bool canOpenWindows() { return m_canOpenWindows; }
351 bool shouldAddFileToPasteboard() { return m_shouldAddFileToPasteboard; }
352 bool stopProvisionalFrameLoads() { return m_stopProvisionalFrameLoads; }
353 bool deferMainResourceDataLoad() { return m_deferMainResourceDataLoad; }
355 bool testRepaint() const { return m_testRepaint; }
356 bool sweepHorizontally() const { return m_sweepHorizontally; }
358 // Called by the webview delegate when the toplevel frame load is done.
359 void locationChangeDone();
361 // Called by the webview delegate when the policy delegate runs if the
362 // waitForPolicyDelegate was called.
363 void policyDelegateDone();
365 // Reinitializes all static values. The reset() method should be called
366 // before the start of each test (currently from
367 // TestShell::runFileTest).
370 // A single item in the work queue.
373 virtual ~WorkItem() {}
375 // Returns true if this started a load.
376 virtual bool run(TestShell* shell) = 0;
379 TaskList* taskList() { return &m_taskList; }
382 friend class WorkItem;
383 friend class WorkQueue;
385 // Helper class for managing events queued by methods like queueLoad or
389 WorkQueue(LayoutTestController* controller) : m_frozen(false), m_controller(controller) {}
390 virtual ~WorkQueue();
391 void processWorkSoon();
393 // Reset the state of the class between tests.
396 void addWork(WorkItem* work);
398 void setFrozen(bool frozen) { m_frozen = frozen; }
399 bool isEmpty() { return m_queue.isEmpty(); }
400 TaskList* taskList() { return &m_taskList; }
404 class WorkQueueTask: public MethodTask<WorkQueue> {
406 WorkQueueTask(WorkQueue* object): MethodTask<WorkQueue>(object) {}
407 virtual void runIfValid() { m_object->processWork(); }
411 Deque<WorkItem*> m_queue;
413 LayoutTestController* m_controller;
416 // Support for overridePreference.
417 bool cppVariantToBool(const CppVariant&);
418 int32_t cppVariantToInt32(const CppVariant&);
419 WebKit::WebString cppVariantToWebString(const CppVariant&);
421 void logErrorToConsole(const std::string&);
422 void completeNotifyDone(bool isTimeout);
423 class NotifyDoneTimedOutTask: public MethodTask<LayoutTestController> {
425 NotifyDoneTimedOutTask(LayoutTestController* object): MethodTask<LayoutTestController>(object) {}
426 virtual void runIfValid() { m_object->completeNotifyDone(true); }
430 bool pauseAnimationAtTimeOnElementWithId(const WebKit::WebString& animationName, double time, const WebKit::WebString& elementId);
431 bool pauseTransitionAtTimeOnElementWithId(const WebKit::WebString& propertyName, double time, const WebKit::WebString& elementId);
432 bool elementDoesAutoCompleteForElementWithId(const WebKit::WebString&);
433 int numberOfActiveAnimations();
434 void suspendAnimations();
435 void resumeAnimations();
437 // Used for test timeouts.
440 // Non-owning pointer. The LayoutTestController is owned by the host.
443 // If true, the test_shell will produce a plain text dump rather than a
444 // text representation of the renderer.
447 // If true, the test_shell will write a descriptive line for each editing
449 bool m_dumpEditingCallbacks;
451 // If true, the test_shell will draw the bounds of the current selection rect
452 // taking possible transforms of the selection rect into account.
453 bool m_dumpSelectionRect;
455 // If true, the test_shell will output a descriptive line for each frame
457 bool m_dumpFrameLoadCallbacks;
459 // If true, the test_shell will output a descriptive line for each resource
461 bool m_dumpResourceLoadCallbacks;
463 // If true, the test_shell will output the MIME type for each resource that
465 bool m_dumpResourceResponseMIMETypes;
467 // If true, the test_shell will produce a dump of the back forward list as
469 bool m_dumpBackForwardList;
471 // If true, the test_shell will print out the child frame scroll offsets as
473 bool m_dumpChildFrameScrollPositions;
475 // If true and if dump_as_text_ is true, the test_shell will recursively
476 // dump all frames as plain text.
477 bool m_dumpChildFramesAsText;
479 // If true, the test_shell will dump all changes to window.status.
480 bool m_dumpWindowStatusChanges;
482 // If true, output a message when the page title is changed.
483 bool m_dumpTitleChanges;
485 // If true, the test_shell will generate pixel results in dumpAsText mode
486 bool m_generatePixelResults;
488 // If true, the element will be treated as editable. This value is returned
489 // from various editing callbacks that are called just before edit operations
491 bool m_acceptsEditing;
493 // If true, new windows can be opened via javascript or by plugins. By
494 // default, set to false and can be toggled to true using
495 // setCanOpenWindows().
496 bool m_canOpenWindows;
498 // When reset is called, go through and close all but the main test shell
499 // window. By default, set to true but toggled to false using
500 // setCloseRemainingWindowsWhenComplete().
501 bool m_closeRemainingWindows;
503 // If true, pixel dump will be produced as a series of 1px-tall, view-wide
504 // individual paints over the height of the view.
506 // If true and test_repaint_ is true as well, pixel dump will be produced as
507 // a series of 1px-wide, view-tall paints across the width of the view.
508 bool m_sweepHorizontally;
510 // If true and a drag starts, adds a file to the drag&drop clipboard.
511 bool m_shouldAddFileToPasteboard;
513 // If true, stops provisional frame loads during the
514 // DidStartProvisionalLoadForFrame callback.
515 bool m_stopProvisionalFrameLoads;
517 // If true, don't dump output until notifyDone is called.
518 bool m_waitUntilDone;
520 // If false, all new requests will not defer the main resource data load.
521 bool m_deferMainResourceDataLoad;
523 WorkQueue m_workQueue;
525 CppVariant m_globalFlag;
527 // Bound variable counting the number of top URLs visited.
528 CppVariant m_webHistoryItemCount;
530 WebKit::WebURL m_userStyleSheetLocation;
532 OwnPtr<WebKit::WebSpeechInputControllerMock> m_speechInputControllerMock;
534 OwnPtr<WebKit::WebDeviceOrientationClientMock> m_deviceOrientationClientMock;
537 #endif // LayoutTestController_h