PSON: Make WebKitTestRunner work with process swap on navigation turned on
[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 "WhatToDump.h"
33 #include <WebKit/WKRetainPtr.h>
34 #include <string>
35 #include <wtf/Noncopyable.h>
36 #include <wtf/text/StringBuilder.h>
37
38 namespace WTR {
39
40 class TestInvocation final : public UIScriptContextDelegate {
41     WTF_MAKE_NONCOPYABLE(TestInvocation);
42 public:
43     explicit TestInvocation(WKURLRef, const TestOptions&);
44     ~TestInvocation();
45
46     WKURLRef url() const;
47     bool urlContains(const char*) const;
48     
49     const TestOptions& options() const { return m_options; }
50
51     void setIsPixelTest(const std::string& expectedPixelHash);
52
53     // Milliseconds
54     void setCustomTimeout(int duration) { m_timeout = duration; }
55     void setDumpJSConsoleLogInStdErr(bool value) { m_dumpJSConsoleLogInStdErr = value; }
56
57     // Seconds
58     double shortTimeout() const;
59
60     void invoke();
61     void didReceiveMessageFromInjectedBundle(WKStringRef messageName, WKTypeRef messageBody);
62     WKRetainPtr<WKTypeRef> didReceiveSynchronousMessageFromInjectedBundle(WKStringRef messageName, WKTypeRef messageBody);
63
64     static void dumpWebProcessUnresponsiveness(const char* errorMessage);
65     void outputText(const WTF::String&);
66
67     void didBeginSwipe();
68     void willEndSwipe();
69     void didEndSwipe();
70     void didRemoveSwipeSnapshot();
71
72     void notifyDownloadDone();
73
74     void didClearStatisticsThroughWebsiteDataRemoval();
75     void didSetPartitionOrBlockCookiesForHost();
76     void didReceiveAllStorageAccessEntries(Vector<String>& domains);
77
78     void didRemoveAllSessionCredentials();
79     
80 private:
81     WKRetainPtr<WKMutableDictionaryRef> createTestSettingsDictionary();
82
83     void dumpResults();
84     static void dump(const char* textToStdout, const char* textToStderr = 0, bool seenError = false);
85     enum class SnapshotResultType { WebView, WebContents };
86     void dumpPixelsAndCompareWithExpected(SnapshotResultType, WKArrayRef repaintRects, WKImageRef = nullptr);
87     void dumpAudio(WKDataRef);
88     bool compareActualHashToExpectedAndDumpResults(const char[33]);
89
90     static void forceRepaintDoneCallback(WKErrorRef, void* context);
91     
92     struct UIScriptInvocationData {
93         unsigned callbackID;
94         WebKit::WKRetainPtr<WKStringRef> scriptString;
95         TestInvocation* testInvocation;
96     };
97     static void runUISideScriptAfterUpdateCallback(WKErrorRef, void* context);
98
99     bool shouldLogHistoryClientCallbacks() const;
100
101     void runUISideScript(WKStringRef, unsigned callbackID);
102     // UIScriptContextDelegate
103     void uiScriptDidComplete(const String& result, unsigned callbackID) override;
104
105     const TestOptions m_options;
106     
107     WKRetainPtr<WKURLRef> m_url;
108     WTF::String m_urlString;
109
110     std::string m_expectedPixelHash;
111
112     int m_timeout { 0 };
113     bool m_dumpJSConsoleLogInStdErr { false };
114
115     // Invocation state
116     bool m_startedTesting { false };
117     bool m_gotInitialResponse { false };
118     bool m_gotFinalMessage { false };
119     bool m_gotRepaint { false };
120     bool m_error { false };
121
122     bool m_waitUntilDone { false };
123     bool m_dumpFrameLoadCallbacks { false };
124     bool m_dumpPixels { false };
125     bool m_pixelResultIsPending { false };
126     WhatToDump m_whatToDump { WhatToDump::RenderTree };
127
128     StringBuilder m_textOutput;
129     WKRetainPtr<WKDataRef> m_audioResult;
130     WKRetainPtr<WKImageRef> m_pixelResult;
131     WKRetainPtr<WKArrayRef> m_repaintRects;
132     
133     std::unique_ptr<UIScriptContext> m_UIScriptContext;
134     UIScriptInvocationData* m_pendingUIScriptInvocationData { nullptr };
135 };
136
137 } // namespace WTR
138
139 #endif // TestInvocation_h