2010-07-11 Maciej Stachowiak <mjs@apple.com>
[WebKit.git] / WebKitTools / WebKitTestRunner / InjectedBundle / LayoutTestController.cpp
1 /*
2  * Copyright (C) 2010 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "LayoutTestController.h"
27 #include "InjectedBundle.h"
28 #include "InjectedBundlePage.h"
29
30 #include <JavaScriptCore/JSRetainPtr.h>
31
32 namespace WTR {
33
34 PassRefPtr<LayoutTestController> LayoutTestController::create(const std::string& testPathOrURL)
35 {
36     return adoptRef(new LayoutTestController(testPathOrURL));
37 }
38
39 LayoutTestController::LayoutTestController(const std::string& testPathOrURL)
40     : m_dumpAsText(false)
41     , m_waitToDump(false)
42     , m_testPathOrURL(testPathOrURL)
43 {
44 }
45
46 LayoutTestController::~LayoutTestController()
47 {
48 }
49
50 static const CFTimeInterval waitToDumpWatchdogInterval = 30.0;
51
52
53 void LayoutTestController::invalidateWaitToDumpWatchdog()
54 {
55     if (m_waitToDumpWatchdog) {
56         CFRunLoopTimerInvalidate(m_waitToDumpWatchdog.get());
57         m_waitToDumpWatchdog = 0;
58     }
59 }
60
61 static void waitUntilDoneWatchdogFired(CFRunLoopTimerRef timer, void* info)
62 {
63     InjectedBundle::shared().layoutTestController()->waitToDumpWatchdogTimerFired();
64 }
65
66 void LayoutTestController::setWaitToDump()
67 {
68     m_waitToDump = true;
69     if (!m_waitToDumpWatchdog) {
70         m_waitToDumpWatchdog.adoptCF(CFRunLoopTimerCreate(kCFAllocatorDefault, CFAbsoluteTimeGetCurrent() + waitToDumpWatchdogInterval, 
71                                                       0, 0, 0, waitUntilDoneWatchdogFired, NULL));
72         CFRunLoopAddTimer(CFRunLoopGetCurrent(), m_waitToDumpWatchdog.get(), kCFRunLoopCommonModes);
73     }
74 }
75
76 void LayoutTestController::waitToDumpWatchdogTimerFired()
77 {
78     invalidateWaitToDumpWatchdog();
79     const char* message = "FAIL: Timed out waiting for notifyDone to be called\n";
80     InjectedBundle::shared().os() << message << "\n";
81     InjectedBundle::shared().done();
82 }
83
84 void LayoutTestController::notifyDone()
85 {
86     if (m_waitToDump && !InjectedBundle::shared().page()->isLoading())
87         InjectedBundle::shared().page()->dump();
88     m_waitToDump = false;
89 }
90
91 static JSValueRef dumpAsTextCallback(JSContextRef context, JSObjectRef function, JSObjectRef thisObject, size_t argumentCount, const JSValueRef arguments[], JSValueRef* exception)
92 {
93     LayoutTestController* controller = static_cast<LayoutTestController*>(JSObjectGetPrivate(thisObject));
94     controller->setDumpAsText(true);
95     return JSValueMakeUndefined(context);
96 }
97
98 static JSValueRef waitUntilDoneCallback(JSContextRef context, JSObjectRef function, JSObjectRef thisObject, size_t argumentCount, const JSValueRef arguments[], JSValueRef* exception)
99 {
100     LayoutTestController* controller = static_cast<LayoutTestController*>(JSObjectGetPrivate(thisObject));
101     controller->setWaitToDump();
102     return JSValueMakeUndefined(context);
103 }
104
105 static JSValueRef notifyDoneCallback(JSContextRef context, JSObjectRef function, JSObjectRef thisObject, size_t argumentCount, const JSValueRef arguments[], JSValueRef* exception)
106 {
107     LayoutTestController* controller = static_cast<LayoutTestController*>(JSObjectGetPrivate(thisObject));
108     controller->notifyDone();
109     return JSValueMakeUndefined(context);
110 }
111
112 // Object Finalization
113
114 static void layoutTestControllerObjectFinalize(JSObjectRef object)
115 {
116     LayoutTestController* controller = static_cast<LayoutTestController*>(JSObjectGetPrivate(object));
117     controller->deref();
118 }
119
120 // Object Creation
121
122 void LayoutTestController::makeWindowObject(JSContextRef context, JSObjectRef windowObject, JSValueRef* exception)
123 {
124     JSRetainPtr<JSStringRef> layoutTestContollerStr(Adopt, JSStringCreateWithUTF8CString("layoutTestController"));
125     ref();
126
127     JSClassRef classRef = getJSClass();
128     JSValueRef layoutTestContollerObject = JSObjectMake(context, classRef, this);
129     JSClassRelease(classRef);
130
131     JSObjectSetProperty(context, windowObject, layoutTestContollerStr.get(), layoutTestContollerObject, kJSPropertyAttributeReadOnly | kJSPropertyAttributeDontDelete, exception);
132 }
133
134 JSClassRef LayoutTestController::getJSClass()
135 {
136     static JSStaticFunction* staticFunctions = LayoutTestController::staticFunctions();
137     static JSClassDefinition classDefinition = {
138         0, kJSClassAttributeNone, "LayoutTestController", 0, 0, staticFunctions,
139         0, layoutTestControllerObjectFinalize, 0, 0, 0, 0, 0, 0, 0, 0, 0
140     };
141
142     return JSClassCreate(&classDefinition);
143 }
144
145 JSStaticFunction* LayoutTestController::staticFunctions()
146 {
147     static JSStaticFunction staticFunctions[] = {
148         { "dumpAsText", dumpAsTextCallback, kJSPropertyAttributeReadOnly | kJSPropertyAttributeDontDelete },
149         { "notifyDone", notifyDoneCallback, kJSPropertyAttributeReadOnly | kJSPropertyAttributeDontDelete },
150         { "waitUntilDone", waitUntilDoneCallback, kJSPropertyAttributeReadOnly | kJSPropertyAttributeDontDelete },
151         { 0, 0, 0 }
152     };
153
154     return staticFunctions;
155 }
156
157 } // namespace WTR