2 * Copyright (C) 2005, 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
3 * (C) 2007 Graham Dennis (graham.dennis@gmail.com)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15 * its contributors may be used to endorse or promote products derived
16 * from this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 #import "DumpRenderTree.h"
33 #import "AccessibilityController.h"
34 #import "CheckedMalloc.h"
35 #import "DumpRenderTreeDraggingInfo.h"
36 #import "DumpRenderTreePasteboard.h"
37 #import "DumpRenderTreeWindow.h"
38 #import "EditingDelegate.h"
39 #import "EventSendingController.h"
40 #import "FrameLoadDelegate.h"
41 #import "HistoryDelegate.h"
42 #import "JavaScriptThreading.h"
43 #import "LayoutTestController.h"
44 #import "MockGeolocationProvider.h"
45 #import "NavigationController.h"
46 #import "ObjCPlugin.h"
47 #import "ObjCPluginFunction.h"
48 #import "PixelDumpSupport.h"
49 #import "PolicyDelegate.h"
50 #import "ResourceLoadDelegate.h"
51 #import "UIDelegate.h"
52 #import "WebArchiveDumpSupport.h"
54 #import "WorkQueueItem.h"
55 #import <Carbon/Carbon.h>
56 #import <CoreFoundation/CoreFoundation.h>
57 #import <WebCore/FoundationExtras.h>
58 #import <WebKit/DOMElement.h>
59 #import <WebKit/DOMExtensions.h>
60 #import <WebKit/DOMRange.h>
61 #import <WebKit/WebArchive.h>
62 #import <WebKit/WebBackForwardList.h>
63 #import <WebKit/WebCache.h>
64 #import <WebKit/WebCoreStatistics.h>
65 #import <WebKit/WebDataSourcePrivate.h>
66 #import <WebKit/WebDatabaseManagerPrivate.h>
67 #import <WebKit/WebDocumentPrivate.h>
68 #import <WebKit/WebDeviceOrientationProviderMock.h>
69 #import <WebKit/WebEditingDelegate.h>
70 #import <WebKit/WebFrameView.h>
71 #import <WebKit/WebHistory.h>
72 #import <WebKit/WebHistoryItemPrivate.h>
73 #import <WebKit/WebInspector.h>
74 #import <WebKit/WebKitNSStringExtras.h>
75 #import <WebKit/WebPluginDatabase.h>
76 #import <WebKit/WebPreferences.h>
77 #import <WebKit/WebPreferencesPrivate.h>
78 #import <WebKit/WebPreferenceKeysPrivate.h>
79 #import <WebKit/WebResourceLoadDelegate.h>
80 #import <WebKit/WebTypesInternal.h>
81 #import <WebKit/WebViewPrivate.h>
83 #import <objc/objc-runtime.h>
84 #import <wtf/Assertions.h>
85 #import <wtf/RetainPtr.h>
86 #import <wtf/Threading.h>
87 #import <wtf/OwnPtr.h>
90 #import <mach-o/getsect.h>
95 @interface DumpRenderTreeApplication : NSApplication
98 @interface DumpRenderTreeEvent : NSEvent
101 @interface NSURLRequest (PrivateThingsWeShouldntReallyUse)
102 +(void)setAllowsAnyHTTPSCertificate:(BOOL)allow forHost:(NSString *)host;
105 static void runTest(const string& testPathOrURL);
107 // Deciding when it's OK to dump out the state is a bit tricky. All these must be true:
108 // - There is no load in progress
109 // - There is no work queued up (see workQueue var, below)
110 // - waitToDump==NO. This means either waitUntilDone was never called, or it was called
111 // and notifyDone was called subsequently.
112 // Note that the call to notifyDone and the end of the load can happen in either order.
116 NavigationController* gNavigationController = 0;
117 RefPtr<LayoutTestController> gLayoutTestController;
119 WebFrame *mainFrame = 0;
120 // This is the topmost frame that is loading, during a given load, or nil when no load is
121 // in progress. Usually this is the same as the main frame, but not always. In the case
122 // where a frameset is loaded, and then new content is loaded into one of the child frames,
123 // that child frame is the "topmost frame that is loading".
124 WebFrame *topLoadingFrame = nil; // !nil iff a load is in progress
127 CFMutableSetRef disallowedURLs = 0;
128 CFRunLoopTimerRef waitToDumpWatchdog = 0;
131 static FrameLoadDelegate *frameLoadDelegate;
132 static UIDelegate *uiDelegate;
133 static EditingDelegate *editingDelegate;
134 static ResourceLoadDelegate *resourceLoadDelegate;
135 static HistoryDelegate *historyDelegate;
136 PolicyDelegate *policyDelegate;
138 static int dumpPixels;
140 static int dumpTree = YES;
141 static int forceComplexText;
142 static BOOL printSeparators;
143 static RetainPtr<CFStringRef> persistentUserStyleSheetLocation;
145 static WebHistoryItem *prevTestBFItem = nil; // current b/f item at the end of the previous test
148 static void swizzleAllMethods(Class imposter, Class original)
150 unsigned int imposterMethodCount;
151 Method* imposterMethods = class_copyMethodList(imposter, &imposterMethodCount);
153 unsigned int originalMethodCount;
154 Method* originalMethods = class_copyMethodList(original, &originalMethodCount);
156 for (unsigned int i = 0; i < imposterMethodCount; i++) {
157 SEL imposterMethodName = method_getName(imposterMethods[i]);
159 // Attempt to add the method to the original class. If it fails, the method already exists and we should
160 // instead exchange the implementations.
161 if (class_addMethod(original, imposterMethodName, method_getImplementation(imposterMethods[i]), method_getTypeEncoding(imposterMethods[i])))
165 for (; j < originalMethodCount; j++) {
166 SEL originalMethodName = method_getName(originalMethods[j]);
167 if (sel_isEqual(imposterMethodName, originalMethodName))
171 // If class_addMethod failed above then the method must exist on the original class.
172 ASSERT(j < originalMethodCount);
173 method_exchangeImplementations(imposterMethods[i], originalMethods[j]);
176 free(imposterMethods);
177 free(originalMethods);
181 static void poseAsClass(const char* imposter, const char* original)
183 Class imposterClass = objc_getClass(imposter);
184 Class originalClass = objc_getClass(original);
187 class_poseAs(imposterClass, originalClass);
190 // Swizzle instance methods
191 swizzleAllMethods(imposterClass, originalClass);
192 // and then class methods
193 swizzleAllMethods(object_getClass(imposterClass), object_getClass(originalClass));
197 void setPersistentUserStyleSheetLocation(CFStringRef url)
199 persistentUserStyleSheetLocation = url;
202 static bool shouldIgnoreWebCoreNodeLeaks(const string& URLString)
204 static char* const ignoreSet[] = {
205 // Keeping this infrastructure around in case we ever need it again.
207 static const int ignoreSetCount = sizeof(ignoreSet) / sizeof(char*);
209 for (int i = 0; i < ignoreSetCount; i++) {
210 // FIXME: ignore case
211 string curIgnore(ignoreSet[i]);
212 // Match at the end of the URLString
213 if (!URLString.compare(URLString.length() - curIgnore.length(), curIgnore.length(), curIgnore))
219 static void activateFonts()
221 #if defined(BUILDING_ON_LEOPARD) || defined(BUILDING_ON_TIGER)
222 static const char* fontSectionNames[] = {
236 for (unsigned i = 0; fontSectionNames[i]; ++i) {
237 unsigned long fontDataLength;
238 char* fontData = getsectdata("__DATA", fontSectionNames[i], &fontDataLength);
240 fprintf(stderr, "Failed to locate the %s font.\n", fontSectionNames[i]);
244 ATSFontContainerRef fontContainer;
245 OSStatus status = ATSFontActivateFromMemory(fontData, fontDataLength, kATSFontContextLocal, kATSFontFormatUnspecified, NULL, kATSOptionFlagsDefault, &fontContainer);
247 if (status != noErr) {
248 fprintf(stderr, "Failed to activate the %s font.\n", fontSectionNames[i]);
254 // Work around <rdar://problem/6698023> by activating fonts from disk
255 // FIXME: This code can be removed once <rdar://problem/6698023> is addressed.
257 static const char* fontFileNames[] = {
260 "WebKitWeightWatcher100.ttf",
261 "WebKitWeightWatcher200.ttf",
262 "WebKitWeightWatcher300.ttf",
263 "WebKitWeightWatcher400.ttf",
264 "WebKitWeightWatcher500.ttf",
265 "WebKitWeightWatcher600.ttf",
266 "WebKitWeightWatcher700.ttf",
267 "WebKitWeightWatcher800.ttf",
268 "WebKitWeightWatcher900.ttf",
272 NSMutableArray *fontURLs = [NSMutableArray array];
273 NSURL *resourcesDirectory = [NSURL URLWithString:@"DumpRenderTree.resources" relativeToURL:[[NSBundle mainBundle] executableURL]];
274 for (unsigned i = 0; fontFileNames[i]; ++i) {
275 NSURL *fontURL = [resourcesDirectory URLByAppendingPathComponent:[NSString stringWithUTF8String:fontFileNames[i]]];
276 [fontURLs addObject:[fontURL absoluteURL]];
279 CFArrayRef errors = 0;
280 if (!CTFontManagerRegisterFontsForURLs((CFArrayRef)fontURLs, kCTFontManagerScopeProcess, &errors)) {
281 NSLog(@"Failed to activate fonts: %@", errors);
288 WebView *createWebViewAndOffscreenWindow()
290 NSRect rect = NSMakeRect(0, 0, LayoutTestController::maxViewWidth, LayoutTestController::maxViewHeight);
291 WebView *webView = [[WebView alloc] initWithFrame:rect frameName:nil groupName:@"org.webkit.DumpRenderTree"];
293 [webView setUIDelegate:uiDelegate];
294 [webView setFrameLoadDelegate:frameLoadDelegate];
295 [webView setEditingDelegate:editingDelegate];
296 [webView setResourceLoadDelegate:resourceLoadDelegate];
297 [webView _setGeolocationProvider:[MockGeolocationProvider shared]];
298 [webView _setDeviceOrientationProvider:[WebDeviceOrientationProviderMock shared]];
300 // Register the same schemes that Safari does
301 [WebView registerURLSchemeAsLocal:@"feed"];
302 [WebView registerURLSchemeAsLocal:@"feeds"];
303 [WebView registerURLSchemeAsLocal:@"feedsearch"];
305 [webView setContinuousSpellCheckingEnabled:YES];
307 // To make things like certain NSViews, dragging, and plug-ins work, put the WebView a window, but put it off-screen so you don't see it.
308 // Put it at -10000, -10000 in "flipped coordinates", since WebCore and the DOM use flipped coordinates.
309 NSRect windowRect = NSOffsetRect(rect, -10000, [[[NSScreen screens] objectAtIndex:0] frame].size.height - rect.size.height + 10000);
310 DumpRenderTreeWindow *window = [[DumpRenderTreeWindow alloc] initWithContentRect:windowRect styleMask:NSBorderlessWindowMask backing:NSBackingStoreBuffered defer:YES];
312 #if !defined(BUILDING_ON_TIGER) && !defined(BUILDING_ON_LEOPARD)
313 [window setColorSpace:[[NSScreen mainScreen] colorSpace]];
316 [[window contentView] addSubview:webView];
317 [window orderBack:nil];
318 [window setAutodisplay:NO];
320 [window startListeningForAcceleratedCompositingChanges];
322 // For reasons that are not entirely clear, the following pair of calls makes WebView handle its
323 // dynamic scrollbars properly. Without it, every frame will always have scrollbars.
324 NSBitmapImageRep *imageRep = [webView bitmapImageRepForCachingDisplayInRect:[webView bounds]];
325 [webView cacheDisplayInRect:[webView bounds] toBitmapImageRep:imageRep];
330 void testStringByEvaluatingJavaScriptFromString()
332 // maps expected result <= JavaScript expression
333 NSDictionary *expressions = [NSDictionary dictionaryWithObjectsAndKeys:
338 @"", @"new String()",
339 @"", @"new String('0')",
345 @"", @"(function() { throw 'error'; })()",
353 NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
354 WebView *webView = [[WebView alloc] initWithFrame:NSZeroRect frameName:@"" groupName:@""];
356 NSEnumerator *enumerator = [expressions keyEnumerator];
358 while ((expression = [enumerator nextObject])) {
359 NSString *expectedResult = [expressions objectForKey:expression];
360 NSString *result = [webView stringByEvaluatingJavaScriptFromString:expression];
361 assert([result isEqualToString:expectedResult]);
369 static NSString *libraryPathForDumpRenderTree()
371 //FIXME: This may not be sufficient to prevent interactions/crashes
372 //when running more than one copy of DumpRenderTree.
373 //See https://bugs.webkit.org/show_bug.cgi?id=10906
374 char* dumpRenderTreeTemp = getenv("DUMPRENDERTREE_TEMP");
375 if (dumpRenderTreeTemp)
376 return [[NSFileManager defaultManager] stringWithFileSystemRepresentation:dumpRenderTreeTemp length:strlen(dumpRenderTreeTemp)];
378 return [@"~/Library/Application Support/DumpRenderTree" stringByExpandingTildeInPath];
381 // Called before each test.
382 static void resetDefaultsToConsistentValues()
384 // Give some clear to undocumented defaults values
385 static const int NoFontSmoothing = 0;
386 static const int BlueTintedAppearance = 1;
388 NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
389 [defaults setInteger:4 forKey:@"AppleAntiAliasingThreshold"]; // smallest font size to CG should perform antialiasing on
390 [defaults setInteger:NoFontSmoothing forKey:@"AppleFontSmoothing"];
391 [defaults setInteger:BlueTintedAppearance forKey:@"AppleAquaColorVariant"];
392 [defaults setObject:@"0.709800 0.835300 1.000000" forKey:@"AppleHighlightColor"];
393 [defaults setObject:@"0.500000 0.500000 0.500000" forKey:@"AppleOtherHighlightColor"];
394 [defaults setObject:[NSArray arrayWithObject:@"en"] forKey:@"AppleLanguages"];
395 [defaults setBool:YES forKey:WebKitEnableFullDocumentTeardownPreferenceKey];
396 [defaults setBool:YES forKey:WebKitFullScreenEnabledPreferenceKey];
398 // Scrollbars are drawn either using AppKit (which uses NSUserDefaults) or using HIToolbox (which uses CFPreferences / kCFPreferencesAnyApplication / kCFPreferencesCurrentUser / kCFPreferencesAnyHost)
399 [defaults setObject:@"DoubleMax" forKey:@"AppleScrollBarVariant"];
400 RetainPtr<CFTypeRef> initialValue = CFPreferencesCopyValue(CFSTR("AppleScrollBarVariant"), kCFPreferencesAnyApplication, kCFPreferencesCurrentUser, kCFPreferencesAnyHost);
401 CFPreferencesSetValue(CFSTR("AppleScrollBarVariant"), CFSTR("DoubleMax"), kCFPreferencesAnyApplication, kCFPreferencesCurrentUser, kCFPreferencesAnyHost);
403 // See <rdar://problem/6347388>.
404 ThemeScrollBarArrowStyle style;
405 GetThemeScrollBarArrowStyle(&style); // Force HIToolbox to read from CFPreferences
408 [defaults setBool:NO forKey:@"AppleScrollAnimationEnabled"];
409 [defaults setBool:NO forKey:@"NSOverlayScrollersEnabled"];
412 CFPreferencesSetValue(CFSTR("AppleScrollBarVariant"), initialValue.get(), kCFPreferencesAnyApplication, kCFPreferencesCurrentUser, kCFPreferencesAnyHost);
414 NSString *path = libraryPathForDumpRenderTree();
415 [defaults setObject:[path stringByAppendingPathComponent:@"Databases"] forKey:WebDatabaseDirectoryDefaultsKey];
416 [defaults setObject:[path stringByAppendingPathComponent:@"LocalCache"] forKey:WebKitLocalCacheDefaultsKey];
418 WebPreferences *preferences = [WebPreferences standardPreferences];
420 [preferences setAllowUniversalAccessFromFileURLs:YES];
421 [preferences setAllowFileAccessFromFileURLs:YES];
422 [preferences setStandardFontFamily:@"Times"];
423 [preferences setFixedFontFamily:@"Courier"];
424 [preferences setSerifFontFamily:@"Times"];
425 [preferences setSansSerifFontFamily:@"Helvetica"];
426 [preferences setCursiveFontFamily:@"Apple Chancery"];
427 [preferences setFantasyFontFamily:@"Papyrus"];
428 [preferences setDefaultFontSize:16];
429 [preferences setDefaultFixedFontSize:13];
430 [preferences setMinimumFontSize:0];
431 [preferences setJavaEnabled:NO];
432 [preferences setJavaScriptEnabled:YES];
433 [preferences setEditableLinkBehavior:WebKitEditableLinkOnlyLiveWithShiftKey];
434 [preferences setTabsToLinks:NO];
435 [preferences setDOMPasteAllowed:YES];
436 [preferences setShouldPrintBackgrounds:YES];
437 [preferences setCacheModel:WebCacheModelDocumentBrowser];
438 [preferences setXSSAuditorEnabled:NO];
439 [preferences setExperimentalNotificationsEnabled:NO];
440 [preferences setPluginAllowedRunTime:1];
441 [preferences setPlugInsEnabled:YES];
443 [preferences setPrivateBrowsingEnabled:NO];
444 [preferences setAuthorAndUserStylesEnabled:YES];
445 [preferences setJavaScriptCanOpenWindowsAutomatically:YES];
446 [preferences setJavaScriptCanAccessClipboard:YES];
447 [preferences setOfflineWebApplicationCacheEnabled:YES];
448 [preferences setDeveloperExtrasEnabled:NO];
449 [preferences setLoadsImagesAutomatically:YES];
450 [preferences setFrameFlatteningEnabled:NO];
451 [preferences setEditingBehavior:WebKitEditingMacBehavior];
452 if (persistentUserStyleSheetLocation) {
453 [preferences setUserStyleSheetLocation:[NSURL URLWithString:(NSString *)(persistentUserStyleSheetLocation.get())]];
454 [preferences setUserStyleSheetEnabled:YES];
456 [preferences setUserStyleSheetEnabled:NO];
458 // The back/forward cache is causing problems due to layouts during transition from one page to another.
459 // So, turn it off for now, but we might want to turn it back on some day.
460 [preferences setUsesPageCache:NO];
461 [preferences setAcceleratedCompositingEnabled:YES];
462 [preferences setWebGLEnabled:NO];
463 [preferences setUsePreHTML5ParserQuirks:NO];
464 [preferences setAsynchronousSpellCheckingEnabled:NO];
466 [[NSHTTPCookieStorage sharedHTTPCookieStorage] setCookieAcceptPolicy:NSHTTPCookieAcceptPolicyOnlyFromMainDocumentDomain];
468 LayoutTestController::setSerializeHTTPLoads(false);
470 setlocale(LC_ALL, "");
473 // Called once on DumpRenderTree startup.
474 static void setDefaultsToConsistentValuesForTesting()
476 resetDefaultsToConsistentValues();
478 NSString *path = libraryPathForDumpRenderTree();
479 NSURLCache *sharedCache =
480 [[NSURLCache alloc] initWithMemoryCapacity:1024 * 1024
482 diskPath:[path stringByAppendingPathComponent:@"URLCache"]];
483 [NSURLCache setSharedURLCache:sharedCache];
484 [sharedCache release];
488 static void* runThread(void* arg)
490 static ThreadIdentifier previousId = 0;
491 ThreadIdentifier currentId = currentThread();
492 // Verify 2 successive threads do not get the same Id.
493 ASSERT(previousId != currentId);
494 previousId = currentId;
498 static void testThreadIdentifierMap()
500 // Imitate 'foreign' threads that are not created by WTF.
502 pthread_create(&pthread, 0, &runThread, 0);
503 pthread_join(pthread, 0);
505 pthread_create(&pthread, 0, &runThread, 0);
506 pthread_join(pthread, 0);
508 // Now create another thread using WTF. On OSX, it will have the same pthread handle
509 // but should get a different ThreadIdentifier.
510 createThread(runThread, 0, "DumpRenderTree: test");
513 static void crashHandler(int sig)
515 char *signalName = strsignal(sig);
516 write(STDERR_FILENO, signalName, strlen(signalName));
517 write(STDERR_FILENO, "\n", 1);
518 restoreMainDisplayColorProfile(0);
522 static void installSignalHandlers()
524 signal(SIGILL, crashHandler); /* 4: illegal instruction (not reset when caught) */
525 signal(SIGTRAP, crashHandler); /* 5: trace trap (not reset when caught) */
526 signal(SIGEMT, crashHandler); /* 7: EMT instruction */
527 signal(SIGFPE, crashHandler); /* 8: floating point exception */
528 signal(SIGBUS, crashHandler); /* 10: bus error */
529 signal(SIGSEGV, crashHandler); /* 11: segmentation violation */
530 signal(SIGSYS, crashHandler); /* 12: bad argument to system call */
531 signal(SIGPIPE, crashHandler); /* 13: write on a pipe with no reader */
532 signal(SIGXCPU, crashHandler); /* 24: exceeded CPU time limit */
533 signal(SIGXFSZ, crashHandler); /* 25: exceeded file size limit */
536 static void allocateGlobalControllers()
538 // FIXME: We should remove these and move to the ObjC standard [Foo sharedInstance] model
539 gNavigationController = [[NavigationController alloc] init];
540 frameLoadDelegate = [[FrameLoadDelegate alloc] init];
541 uiDelegate = [[UIDelegate alloc] init];
542 editingDelegate = [[EditingDelegate alloc] init];
543 resourceLoadDelegate = [[ResourceLoadDelegate alloc] init];
544 policyDelegate = [[PolicyDelegate alloc] init];
545 historyDelegate = [[HistoryDelegate alloc] init];
548 // ObjC++ doens't seem to let me pass NSObject*& sadly.
549 static inline void releaseAndZero(NSObject** object)
555 static void releaseGlobalControllers()
557 releaseAndZero(&gNavigationController);
558 releaseAndZero(&frameLoadDelegate);
559 releaseAndZero(&editingDelegate);
560 releaseAndZero(&resourceLoadDelegate);
561 releaseAndZero(&uiDelegate);
562 releaseAndZero(&policyDelegate);
565 static void initializeGlobalsFromCommandLineOptions(int argc, const char *argv[])
567 struct option options[] = {
568 {"notree", no_argument, &dumpTree, NO},
569 {"pixel-tests", no_argument, &dumpPixels, YES},
570 {"tree", no_argument, &dumpTree, YES},
571 {"threaded", no_argument, &threaded, YES},
572 {"complex-text", no_argument, &forceComplexText, YES},
577 while ((option = getopt_long(argc, (char * const *)argv, "", options, NULL)) != -1) {
579 case '?': // unknown or ambiguous option
580 case ':': // missing argument
587 static void addTestPluginsToPluginSearchPath(const char* executablePath)
589 NSString *pwd = [[NSString stringWithUTF8String:executablePath] stringByDeletingLastPathComponent];
590 [WebPluginDatabase setAdditionalWebPlugInPaths:[NSArray arrayWithObject:pwd]];
591 [[WebPluginDatabase sharedDatabase] refresh];
594 static bool useLongRunningServerMode(int argc, const char *argv[])
596 // This assumes you've already called getopt_long
597 return (argc == optind+1 && strcmp(argv[optind], "-") == 0);
600 static void runTestingServerLoop()
602 // When DumpRenderTree run in server mode, we just wait around for file names
603 // to be passed to us and read each in turn, passing the results back to the client
604 char filenameBuffer[2048];
605 while (fgets(filenameBuffer, sizeof(filenameBuffer), stdin)) {
606 char *newLineCharacter = strchr(filenameBuffer, '\n');
607 if (newLineCharacter)
608 *newLineCharacter = '\0';
610 if (strlen(filenameBuffer) == 0)
613 runTest(filenameBuffer);
617 static void prepareConsistentTestingEnvironment()
619 poseAsClass("DumpRenderTreePasteboard", "NSPasteboard");
620 poseAsClass("DumpRenderTreeEvent", "NSEvent");
622 setDefaultsToConsistentValuesForTesting();
626 setupMainDisplayColorProfile();
627 allocateGlobalControllers();
629 makeLargeMallocFailSilently();
632 void dumpRenderTree(int argc, const char *argv[])
634 initializeGlobalsFromCommandLineOptions(argc, argv);
635 prepareConsistentTestingEnvironment();
636 addTestPluginsToPluginSearchPath(argv[0]);
638 installSignalHandlers();
640 if (forceComplexText)
641 [WebView _setAlwaysUsesComplexTextCodePath:YES];
643 WebView *webView = createWebViewAndOffscreenWindow();
644 mainFrame = [webView mainFrame];
646 [[NSURLCache sharedURLCache] removeAllCachedResponses];
649 // <http://webkit.org/b/31200> In order to prevent extra frame load delegate logging being generated if the first test to use SSL
650 // is set to log frame load delegate calls we ignore SSL certificate errors on localhost and 127.0.0.1.
651 #if BUILDING_ON_TIGER
652 // Initialize internal NSURLRequest data for setAllowsAnyHTTPSCertificate:forHost: to work properly.
653 [[[[NSURLRequest alloc] init] autorelease] HTTPMethod];
655 [NSURLRequest setAllowsAnyHTTPSCertificate:YES forHost:@"localhost"];
656 [NSURLRequest setAllowsAnyHTTPSCertificate:YES forHost:@"127.0.0.1"];
658 // <rdar://problem/5222911>
659 testStringByEvaluatingJavaScriptFromString();
661 // http://webkit.org/b/32689
662 testThreadIdentifierMap();
665 startJavaScriptThreads();
667 if (useLongRunningServerMode(argc, argv)) {
668 printSeparators = YES;
669 runTestingServerLoop();
671 printSeparators = (optind < argc-1 || (dumpPixels && dumpTree));
672 for (int i = optind; i != argc; ++i)
677 stopJavaScriptThreads();
679 NSWindow *window = [webView window];
683 // Work around problem where registering drag types leaves an outstanding
684 // "perform selector" on the window, which retains the window. It's a bit
685 // inelegant and perhaps dangerous to just blow them all away, but in practice
686 // it probably won't cause any trouble (and this is just a test tool, after all).
687 [NSObject cancelPreviousPerformRequestsWithTarget:window];
689 [window close]; // releases when closed
692 releaseGlobalControllers();
694 [DumpRenderTreePasteboard releaseLocalPasteboards];
696 // FIXME: This should be moved onto LayoutTestController and made into a HashSet
697 if (disallowedURLs) {
698 CFRelease(disallowedURLs);
703 restoreMainDisplayColorProfile(0);
706 int main(int argc, const char *argv[])
708 NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
709 [DumpRenderTreeApplication sharedApplication]; // Force AppKit to init itself
710 dumpRenderTree(argc, argv);
711 [WebCoreStatistics garbageCollectJavaScriptObjects];
712 [WebCoreStatistics emptyCache]; // Otherwise SVGImages trigger false positives for Frame/Node counts
717 static NSInteger compareHistoryItems(id item1, id item2, void *context)
719 return [[item1 target] caseInsensitiveCompare:[item2 target]];
722 static void dumpHistoryItem(WebHistoryItem *item, int indent, BOOL current)
729 for (int i = start; i < indent; i++)
732 NSString *urlString = [item URLString];
733 if ([[NSURL URLWithString:urlString] isFileURL]) {
734 NSRange range = [urlString rangeOfString:@"/LayoutTests/"];
735 urlString = [@"(file test):" stringByAppendingString:[urlString substringFromIndex:(range.length + range.location)]];
738 printf("%s", [urlString UTF8String]);
739 NSString *target = [item target];
740 if (target && [target length] > 0)
741 printf(" (in frame \"%s\")", [target UTF8String]);
742 if ([item isTargetItem])
743 printf(" **nav target**");
745 NSArray *kids = [item children];
747 // must sort to eliminate arbitrary result ordering which defeats reproducible testing
748 kids = [kids sortedArrayUsingFunction:&compareHistoryItems context:nil];
749 for (unsigned i = 0; i < [kids count]; i++)
750 dumpHistoryItem([kids objectAtIndex:i], indent+4, NO);
754 static void dumpFrameScrollPosition(WebFrame *f)
756 NSPoint scrollPosition = [[[[f frameView] documentView] superview] bounds].origin;
757 if (ABS(scrollPosition.x) > 0.00000001 || ABS(scrollPosition.y) > 0.00000001) {
758 if ([f parentFrame] != nil)
759 printf("frame '%s' ", [[f name] UTF8String]);
760 printf("scrolled to %.f,%.f\n", scrollPosition.x, scrollPosition.y);
763 if (gLayoutTestController->dumpChildFrameScrollPositions()) {
764 NSArray *kids = [f childFrames];
766 for (unsigned i = 0; i < [kids count]; i++)
767 dumpFrameScrollPosition([kids objectAtIndex:i]);
771 static NSString *dumpFramesAsText(WebFrame *frame)
773 DOMDocument *document = [frame DOMDocument];
774 DOMElement *documentElement = [document documentElement];
776 if (!documentElement)
779 NSMutableString *result = [[[NSMutableString alloc] init] autorelease];
781 // Add header for all but the main frame.
782 if ([frame parentFrame])
783 result = [NSMutableString stringWithFormat:@"\n--------\nFrame: '%@'\n--------\n", [frame name]];
785 [result appendFormat:@"%@\n", [documentElement innerText]];
787 if (gLayoutTestController->dumpChildFramesAsText()) {
788 NSArray *kids = [frame childFrames];
790 for (unsigned i = 0; i < [kids count]; i++)
791 [result appendString:dumpFramesAsText([kids objectAtIndex:i])];
798 static NSData *dumpFrameAsPDF(WebFrame *frame)
803 // Sadly we have to dump to a file and then read from that file again
804 // +[NSPrintOperation PDFOperationWithView:insideRect:] requires a rect and prints to a single page
805 // likewise +[NSView dataWithPDFInsideRect:] also prints to a single continuous page
806 // The goal of this function is to test "real" printing across multiple pages.
807 // FIXME: It's possible there might be printing SPI to let us print a multi-page PDF to an NSData object
808 NSString *path = [libraryPathForDumpRenderTree() stringByAppendingPathComponent:@"test.pdf"];
810 NSMutableDictionary *printInfoDict = [NSMutableDictionary dictionaryWithDictionary:[[NSPrintInfo sharedPrintInfo] dictionary]];
811 [printInfoDict setObject:NSPrintSaveJob forKey:NSPrintJobDisposition];
812 [printInfoDict setObject:path forKey:NSPrintSavePath];
814 NSPrintInfo *printInfo = [[NSPrintInfo alloc] initWithDictionary:printInfoDict];
815 [printInfo setHorizontalPagination:NSAutoPagination];
816 [printInfo setVerticalPagination:NSAutoPagination];
817 [printInfo setVerticallyCentered:NO];
819 NSPrintOperation *printOperation = [NSPrintOperation printOperationWithView:[frame frameView] printInfo:printInfo];
820 [printOperation setShowPanels:NO];
821 [printOperation runOperation];
825 NSData *pdfData = [NSData dataWithContentsOfFile:path];
826 [[NSFileManager defaultManager] removeFileAtPath:path handler:nil];
831 static void dumpBackForwardListForWebView(WebView *view)
833 printf("\n============== Back Forward List ==============\n");
834 WebBackForwardList *bfList = [view backForwardList];
836 // Print out all items in the list after prevTestBFItem, which was from the previous test
837 // Gather items from the end of the list, the print them out from oldest to newest
838 NSMutableArray *itemsToPrint = [[NSMutableArray alloc] init];
839 for (int i = [bfList forwardListCount]; i > 0; i--) {
840 WebHistoryItem *item = [bfList itemAtIndex:i];
841 // something is wrong if the item from the last test is in the forward part of the b/f list
842 assert(item != prevTestBFItem);
843 [itemsToPrint addObject:item];
846 assert([bfList currentItem] != prevTestBFItem);
847 [itemsToPrint addObject:[bfList currentItem]];
848 int currentItemIndex = [itemsToPrint count] - 1;
850 for (int i = -1; i >= -[bfList backListCount]; i--) {
851 WebHistoryItem *item = [bfList itemAtIndex:i];
852 if (item == prevTestBFItem)
854 [itemsToPrint addObject:item];
857 for (int i = [itemsToPrint count]-1; i >= 0; i--)
858 dumpHistoryItem([itemsToPrint objectAtIndex:i], 8, i == currentItemIndex);
860 [itemsToPrint release];
861 printf("===============================================\n");
864 static void sizeWebViewForCurrentTest()
866 // W3C SVG tests expect to be 480x360
867 bool isSVGW3CTest = (gLayoutTestController->testPathOrURL().find("svg/W3C-SVG-1.1") != string::npos);
869 [[mainFrame webView] setFrameSize:NSMakeSize(480, 360)];
871 [[mainFrame webView] setFrameSize:NSMakeSize(LayoutTestController::maxViewWidth, LayoutTestController::maxViewHeight)];
874 static const char *methodNameStringForFailedTest()
876 const char *errorMessage;
877 if (gLayoutTestController->dumpAsText())
878 errorMessage = "[documentElement innerText]";
879 else if (gLayoutTestController->dumpDOMAsWebArchive())
880 errorMessage = "[[mainFrame DOMDocument] webArchive]";
881 else if (gLayoutTestController->dumpSourceAsWebArchive())
882 errorMessage = "[[mainFrame dataSource] webArchive]";
884 errorMessage = "[mainFrame renderTreeAsExternalRepresentation]";
889 static void dumpBackForwardListForAllWindows()
891 CFArrayRef openWindows = (CFArrayRef)[DumpRenderTreeWindow openWindows];
892 unsigned count = CFArrayGetCount(openWindows);
893 for (unsigned i = 0; i < count; i++) {
894 NSWindow *window = (NSWindow *)CFArrayGetValueAtIndex(openWindows, i);
895 WebView *webView = [[[window contentView] subviews] objectAtIndex:0];
896 dumpBackForwardListForWebView(webView);
900 static void invalidateAnyPreviousWaitToDumpWatchdog()
902 if (waitToDumpWatchdog) {
903 CFRunLoopTimerInvalidate(waitToDumpWatchdog);
904 CFRelease(waitToDumpWatchdog);
905 waitToDumpWatchdog = 0;
911 invalidateAnyPreviousWaitToDumpWatchdog();
914 NSString *resultString = nil;
915 NSData *resultData = nil;
916 NSString *resultMimeType = @"text/plain";
918 if ([[[mainFrame dataSource] _responseMIMEType] isEqualToString:@"text/plain"]) {
919 gLayoutTestController->setDumpAsText(true);
920 gLayoutTestController->setGeneratePixelResults(false);
922 if (gLayoutTestController->dumpAsText()) {
923 resultString = dumpFramesAsText(mainFrame);
924 } else if (gLayoutTestController->dumpAsPDF()) {
925 resultData = dumpFrameAsPDF(mainFrame);
926 resultMimeType = @"application/pdf";
927 } else if (gLayoutTestController->dumpDOMAsWebArchive()) {
928 WebArchive *webArchive = [[mainFrame DOMDocument] webArchive];
929 resultString = HardAutorelease(createXMLStringFromWebArchiveData((CFDataRef)[webArchive data]));
930 resultMimeType = @"application/x-webarchive";
931 } else if (gLayoutTestController->dumpSourceAsWebArchive()) {
932 WebArchive *webArchive = [[mainFrame dataSource] webArchive];
933 resultString = HardAutorelease(createXMLStringFromWebArchiveData((CFDataRef)[webArchive data]));
934 resultMimeType = @"application/x-webarchive";
936 sizeWebViewForCurrentTest();
937 resultString = [mainFrame renderTreeAsExternalRepresentationForPrinting:gLayoutTestController->isPrinting()];
940 if (resultString && !resultData)
941 resultData = [resultString dataUsingEncoding:NSUTF8StringEncoding];
943 printf("Content-Type: %s\n", [resultMimeType UTF8String]);
946 fwrite([resultData bytes], 1, [resultData length], stdout);
948 if (!gLayoutTestController->dumpAsText() && !gLayoutTestController->dumpDOMAsWebArchive() && !gLayoutTestController->dumpSourceAsWebArchive())
949 dumpFrameScrollPosition(mainFrame);
951 if (gLayoutTestController->dumpBackForwardList())
952 dumpBackForwardListForAllWindows();
954 printf("ERROR: nil result from %s", methodNameStringForFailedTest());
956 // Stop the watchdog thread before we leave this test to make sure it doesn't
957 // fire in between tests causing the next test to fail.
958 // This is a speculative fix for: https://bugs.webkit.org/show_bug.cgi?id=32339
959 invalidateAnyPreviousWaitToDumpWatchdog();
961 if (printSeparators) {
962 puts("#EOF"); // terminate the content block
963 fputs("#EOF\n", stderr);
967 if (dumpPixels && gLayoutTestController->generatePixelResults())
968 // FIXME: when isPrinting is set, dump the image with page separators.
969 dumpWebViewAsPixelsAndCompareWithExpected(gLayoutTestController->expectedPixelHash());
971 puts("#EOF"); // terminate the (possibly empty) pixels block
979 static bool shouldLogFrameLoadDelegates(const char* pathOrURL)
981 return strstr(pathOrURL, "loading/");
984 static bool shouldLogHistoryDelegates(const char* pathOrURL)
986 return strstr(pathOrURL, "globalhistory/");
989 static bool shouldOpenWebInspector(const char* pathOrURL)
991 return strstr(pathOrURL, "inspector/");
994 static bool shouldEnableDeveloperExtras(const char* pathOrURL)
999 static void resetWebViewToConsistentStateBeforeTesting()
1001 WebView *webView = [mainFrame webView];
1002 [webView setEditable:NO];
1003 [(EditingDelegate *)[webView editingDelegate] setAcceptsEditing:YES];
1004 [webView makeTextStandardSize:nil];
1005 [webView resetPageZoom:nil];
1006 [webView setTabKeyCyclesThroughElements:YES];
1007 [webView setPolicyDelegate:nil];
1008 [policyDelegate setPermissive:NO];
1009 [policyDelegate setControllerToNotifyDone:0];
1010 [frameLoadDelegate resetToConsistentState];
1011 [webView _setDashboardBehavior:WebDashboardBehaviorUseBackwardCompatibilityMode to:NO];
1012 [webView _clearMainFrameName];
1013 [[webView undoManager] removeAllActions];
1014 [WebView _removeAllUserContentFromGroup:[webView groupName]];
1015 [[webView window] setAutodisplay:NO];
1017 resetDefaultsToConsistentValues();
1019 [[mainFrame webView] setSmartInsertDeleteEnabled:YES];
1020 [[[mainFrame webView] inspector] setJavaScriptProfilingEnabled:NO];
1022 [WebView _setUsesTestModeFocusRingColor:YES];
1023 [WebView _resetOriginAccessWhitelists];
1025 [[MockGeolocationProvider shared] stopTimer];
1027 // Clear the contents of the general pasteboard
1028 [[NSPasteboard generalPasteboard] declareTypes:[NSArray arrayWithObject:NSStringPboardType] owner:nil];
1031 static void runTest(const string& testPathOrURL)
1033 ASSERT(!testPathOrURL.empty());
1035 // Look for "'" as a separator between the path or URL, and the pixel dump hash that follows.
1036 string pathOrURL(testPathOrURL);
1037 string expectedPixelHash;
1039 size_t separatorPos = pathOrURL.find("'");
1040 if (separatorPos != string::npos) {
1041 pathOrURL = string(testPathOrURL, 0, separatorPos);
1042 expectedPixelHash = string(testPathOrURL, separatorPos + 1);
1045 NSString *pathOrURLString = [NSString stringWithUTF8String:pathOrURL.c_str()];
1046 if (!pathOrURLString) {
1047 fprintf(stderr, "Failed to parse \"%s\" as UTF-8\n", pathOrURL.c_str());
1052 if ([pathOrURLString hasPrefix:@"http://"] || [pathOrURLString hasPrefix:@"https://"])
1053 url = [NSURL URLWithString:pathOrURLString];
1055 url = [NSURL fileURLWithPath:pathOrURLString];
1057 fprintf(stderr, "Failed to parse \"%s\" as a URL\n", pathOrURL.c_str());
1061 const string testURL([[url absoluteString] UTF8String]);
1063 resetWebViewToConsistentStateBeforeTesting();
1065 gLayoutTestController = LayoutTestController::create(testURL, expectedPixelHash);
1066 topLoadingFrame = nil;
1067 ASSERT(!draggingInfo); // the previous test should have called eventSender.mouseUp to drop!
1068 releaseAndZero(&draggingInfo);
1071 gLayoutTestController->setIconDatabaseEnabled(false);
1074 CFSetRemoveAllValues(disallowedURLs);
1075 if (shouldLogFrameLoadDelegates(pathOrURL.c_str()))
1076 gLayoutTestController->setDumpFrameLoadCallbacks(true);
1078 if (shouldLogHistoryDelegates(pathOrURL.c_str()))
1079 [[mainFrame webView] setHistoryDelegate:historyDelegate];
1081 [[mainFrame webView] setHistoryDelegate:nil];
1083 if (shouldEnableDeveloperExtras(pathOrURL.c_str())) {
1084 gLayoutTestController->setDeveloperExtrasEnabled(true);
1085 if (shouldOpenWebInspector(pathOrURL.c_str()))
1086 gLayoutTestController->showWebInspector();
1089 if ([WebHistory optionalSharedHistory])
1090 [WebHistory setOptionalSharedHistory:nil];
1091 lastMousePosition = NSZeroPoint;
1092 lastClickPosition = NSZeroPoint;
1094 [prevTestBFItem release];
1095 prevTestBFItem = [[[[mainFrame webView] backForwardList] currentItem] retain];
1097 WorkQueue::shared()->clear();
1098 WorkQueue::shared()->setFrozen(false);
1100 bool ignoreWebCoreNodeLeaks = shouldIgnoreWebCoreNodeLeaks(testURL);
1101 if (ignoreWebCoreNodeLeaks)
1102 [WebCoreStatistics startIgnoringWebCoreNodeLeaks];
1104 NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
1105 [mainFrame loadRequest:[NSURLRequest requestWithURL:url]];
1109 pool = [[NSAutoreleasePool alloc] init];
1110 [[NSRunLoop currentRunLoop] runMode:NSDefaultRunLoopMode beforeDate:[NSDate distantPast]];
1114 pool = [[NSAutoreleasePool alloc] init];
1115 [EventSendingController clearSavedEvents];
1116 [[mainFrame webView] setSelectedDOMRange:nil affinity:NSSelectionAffinityDownstream];
1118 WorkQueue::shared()->clear();
1120 if (gLayoutTestController->closeRemainingWindowsWhenComplete()) {
1121 NSArray* array = [DumpRenderTreeWindow openWindows];
1123 unsigned count = [array count];
1124 for (unsigned i = 0; i < count; i++) {
1125 NSWindow *window = [array objectAtIndex:i];
1127 // Don't try to close the main window
1128 if (window == [[mainFrame webView] window])
1131 WebView *webView = [[[window contentView] subviews] objectAtIndex:0];
1138 // If developer extras enabled Web Inspector may have been open by the test.
1139 if (shouldEnableDeveloperExtras(pathOrURL.c_str())) {
1140 gLayoutTestController->closeWebInspector();
1141 gLayoutTestController->setDeveloperExtrasEnabled(false);
1144 resetWebViewToConsistentStateBeforeTesting();
1146 [mainFrame loadHTMLString:@"<html></html>" baseURL:[NSURL URLWithString:@"about:blank"]];
1147 [mainFrame stopLoading];
1151 // We should only have our main window left open when we're done
1152 ASSERT(CFArrayGetCount(openWindowsRef) == 1);
1153 ASSERT(CFArrayGetValueAtIndex(openWindowsRef, 0) == [[mainFrame webView] window]);
1155 gLayoutTestController.clear();
1157 if (ignoreWebCoreNodeLeaks)
1158 [WebCoreStatistics stopIgnoringWebCoreNodeLeaks];
1161 void displayWebView()
1163 NSView *webView = [mainFrame webView];
1165 [webView lockFocus];
1166 [[[NSColor blackColor] colorWithAlphaComponent:0.66] set];
1167 NSRectFillUsingOperation([webView frame], NSCompositeSourceOver);
1168 [webView unlockFocus];
1171 @implementation DumpRenderTreeEvent
1173 + (NSPoint)mouseLocation
1175 return [[[mainFrame webView] window] convertBaseToScreen:lastMousePosition];
1180 @implementation DumpRenderTreeApplication
1184 // <rdar://problem/7686123> Java plug-in freezes unless NSApplication is running