Add basic pixel testing support to WebKitTestRunner
[WebKit-https.git] / Tools / WebKitTestRunner / TestInvocation.h
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 #ifndef TestInvocation_h
27 #define TestInvocation_h
28
29 #include <string>
30 #include <WebKit2/WKRetainPtr.h>
31 #include <wtf/Noncopyable.h>
32
33 namespace WTR {
34
35 class TestInvocation {
36     WTF_MAKE_NONCOPYABLE(TestInvocation);
37 public:
38     TestInvocation(const std::string& pathOrURL);
39     ~TestInvocation();
40
41     void setIsPixelTest(const std::string& expectedPixelHash);
42     
43     void invoke();
44     void didReceiveMessageFromInjectedBundle(WKStringRef messageName, WKTypeRef messageBody);
45     WKRetainPtr<WKTypeRef> didReceiveSynchronousMessageFromInjectedBundle(WKStringRef messageName, WKTypeRef messageBody);
46
47 private:
48     void dump(const char*);
49     void dumpPixelsAndCompareWithExpected();
50     
51     WKRetainPtr<WKURLRef> m_url;
52     std::string m_pathOrURL;
53     
54     bool m_dumpPixels;
55     std::string m_expectedPixelHash;
56
57     // Invocation state
58     bool m_gotInitialResponse;
59     bool m_gotFinalMessage;
60     bool m_gotRepaint;
61     bool m_error;
62 };
63
64 } // namespace WTR
65
66 #endif // TestInvocation_h