Move WebKitTestRunner to std::unique_ptr
[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 <WebKit/WKRetainPtr.h>
30 #include <string>
31 #include <wtf/Noncopyable.h>
32 #include <wtf/text/StringBuilder.h>
33
34 namespace WTR {
35
36 class TestInvocation {
37     WTF_MAKE_NONCOPYABLE(TestInvocation);
38 public:
39     explicit TestInvocation(const std::string& pathOrURL);
40     ~TestInvocation();
41
42     WKURLRef url() const;
43
44     void setIsPixelTest(const std::string& expectedPixelHash);
45
46     void setCustomTimeout(int duration);
47
48     void invoke();
49     void didReceiveMessageFromInjectedBundle(WKStringRef messageName, WKTypeRef messageBody);
50     WKRetainPtr<WKTypeRef> didReceiveSynchronousMessageFromInjectedBundle(WKStringRef messageName, WKTypeRef messageBody);
51
52     void dumpWebProcessUnresponsiveness();
53     static void dumpWebProcessUnresponsiveness(const char* errorMessage);
54     void outputText(const WTF::String&);
55 private:
56     void dumpResults();
57     static void dump(const char* textToStdout, const char* textToStderr = 0, bool seenError = false);
58     void dumpPixelsAndCompareWithExpected(WKImageRef, WKArrayRef repaintRects);
59     void dumpAudio(WKDataRef);
60     bool compareActualHashToExpectedAndDumpResults(const char[33]);
61
62     static void forceRepaintDoneCallback(WKErrorRef, void* context);
63
64     WKRetainPtr<WKURLRef> m_url;
65     std::string m_pathOrURL;
66     
67     bool m_dumpPixels;
68     std::string m_expectedPixelHash;
69
70     int m_timeout;
71
72     // Invocation state
73     bool m_gotInitialResponse;
74     bool m_gotFinalMessage;
75     bool m_gotRepaint;
76     bool m_error;
77
78     StringBuilder m_textOutput;
79     WKRetainPtr<WKDataRef> m_audioResult;
80     WKRetainPtr<WKImageRef> m_pixelResult;
81     WKRetainPtr<WKArrayRef> m_repaintRects;
82     std::string m_errorMessage;
83     bool m_webProcessIsUnresponsive;
84
85 };
86
87 } // namespace WTR
88
89 #endif // TestInvocation_h