Confirm <a download> satisfies specification criteria
[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 "JSWrappable.h"
30 #include "TestOptions.h"
31 #include "UIScriptContext.h"
32 #include <WebKit/WKRetainPtr.h>
33 #include <string>
34 #include <wtf/Noncopyable.h>
35 #include <wtf/text/StringBuilder.h>
36
37 namespace WTR {
38
39 class TestInvocation : public UIScriptContextDelegate {
40     WTF_MAKE_NONCOPYABLE(TestInvocation);
41 public:
42     explicit TestInvocation(WKURLRef, const TestOptions&);
43     ~TestInvocation();
44
45     WKURLRef url() const;
46     bool urlContains(const char*) const;
47     
48     const TestOptions& options() const { return m_options; }
49
50     void setIsPixelTest(const std::string& expectedPixelHash);
51
52     void setCustomTimeout(int duration) { m_timeout = duration; }
53     int customTimeout() const { return m_timeout; }
54
55     void invoke();
56     void didReceiveMessageFromInjectedBundle(WKStringRef messageName, WKTypeRef messageBody);
57     WKRetainPtr<WKTypeRef> didReceiveSynchronousMessageFromInjectedBundle(WKStringRef messageName, WKTypeRef messageBody);
58
59     void dumpWebProcessUnresponsiveness();
60     static void dumpWebProcessUnresponsiveness(const char* errorMessage);
61     void outputText(const WTF::String&);
62
63     void didBeginSwipe();
64     void willEndSwipe();
65     void didEndSwipe();
66     void didRemoveSwipeSnapshot();
67
68     void notifyDownloadDone();
69
70 private:
71     void dumpResults();
72     static void dump(const char* textToStdout, const char* textToStderr = 0, bool seenError = false);
73     enum class SnapshotResultType { WebView, WebContents };
74     void dumpPixelsAndCompareWithExpected(WKImageRef, WKArrayRef repaintRects, SnapshotResultType);
75     void dumpAudio(WKDataRef);
76     bool compareActualHashToExpectedAndDumpResults(const char[33]);
77
78     static void forceRepaintDoneCallback(WKErrorRef, void* context);
79     
80     struct UIScriptInvocationData {
81         unsigned callbackID;
82         WebKit::WKRetainPtr<WKStringRef> scriptString;
83         TestInvocation* testInvocation;
84     };
85     static void runUISideScriptAfterUpdateCallback(WKErrorRef, void* context);
86
87     bool shouldLogFrameLoadDelegates() const;
88     bool shouldLogHistoryClientCallbacks() const;
89
90     void runUISideScript(WKStringRef, unsigned callbackID);
91     // UIScriptContextDelegate
92     void uiScriptDidComplete(WKStringRef result, unsigned callbackID) override;
93
94     const TestOptions m_options;
95     
96     WKRetainPtr<WKURLRef> m_url;
97     WTF::String m_urlString;
98
99     std::string m_expectedPixelHash;
100
101     int m_timeout { 0 };
102
103     // Invocation state
104     bool m_gotInitialResponse { false };
105     bool m_gotFinalMessage { false };
106     bool m_gotRepaint { false };
107     bool m_error { false };
108
109     bool m_dumpPixels { false };
110     bool m_pixelResultIsPending { false };
111     bool m_webProcessIsUnresponsive { false };
112
113     StringBuilder m_textOutput;
114     WKRetainPtr<WKDataRef> m_audioResult;
115     WKRetainPtr<WKImageRef> m_pixelResult;
116     WKRetainPtr<WKArrayRef> m_repaintRects;
117     std::string m_errorMessage;
118     
119     std::unique_ptr<UIScriptContext> m_UIScriptContext;
120     UIScriptInvocationData* m_pendingUIScriptInvocationData { nullptr };
121 };
122
123 } // namespace WTR
124
125 #endif // TestInvocation_h