Set getUserMedia permission to true by default on WTR
[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     // Milliseconds
53     void setCustomTimeout(int duration) { m_timeout = duration; }
54     void setDumpJSConsoleLogInStdErr(bool value) { m_dumpJSConsoleLogInStdErr = value; }
55
56     // Seconds
57     double shortTimeout() const;
58
59     void invoke();
60     void didReceiveMessageFromInjectedBundle(WKStringRef messageName, WKTypeRef messageBody);
61     WKRetainPtr<WKTypeRef> didReceiveSynchronousMessageFromInjectedBundle(WKStringRef messageName, WKTypeRef messageBody);
62
63     void dumpWebProcessUnresponsiveness();
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 didRemoveAllSessionCredentials();
75     
76 private:
77     void dumpResults();
78     static void dump(const char* textToStdout, const char* textToStderr = 0, bool seenError = false);
79     enum class SnapshotResultType { WebView, WebContents };
80     void dumpPixelsAndCompareWithExpected(SnapshotResultType, WKArrayRef repaintRects, WKImageRef = nullptr);
81     void dumpAudio(WKDataRef);
82     bool compareActualHashToExpectedAndDumpResults(const char[33]);
83
84     static void forceRepaintDoneCallback(WKErrorRef, void* context);
85     
86     struct UIScriptInvocationData {
87         unsigned callbackID;
88         WebKit::WKRetainPtr<WKStringRef> scriptString;
89         TestInvocation* testInvocation;
90     };
91     static void runUISideScriptAfterUpdateCallback(WKErrorRef, void* context);
92
93     bool shouldLogFrameLoadDelegates() const;
94     bool shouldLogHistoryClientCallbacks() const;
95
96     void runUISideScript(WKStringRef, unsigned callbackID);
97     // UIScriptContextDelegate
98     void uiScriptDidComplete(const String& result, unsigned callbackID) override;
99
100     const TestOptions m_options;
101     
102     WKRetainPtr<WKURLRef> m_url;
103     WTF::String m_urlString;
104
105     std::string m_expectedPixelHash;
106
107     int m_timeout { 0 };
108     bool m_dumpJSConsoleLogInStdErr { false };
109
110     // Invocation state
111     bool m_gotInitialResponse { false };
112     bool m_gotFinalMessage { false };
113     bool m_gotRepaint { false };
114     bool m_error { false };
115
116     bool m_dumpPixels { false };
117     bool m_pixelResultIsPending { false };
118     bool m_webProcessIsUnresponsive { false };
119
120     StringBuilder m_textOutput;
121     WKRetainPtr<WKDataRef> m_audioResult;
122     WKRetainPtr<WKImageRef> m_pixelResult;
123     WKRetainPtr<WKArrayRef> m_repaintRects;
124     std::string m_errorMessage;
125     
126     std::unique_ptr<UIScriptContext> m_UIScriptContext;
127     UIScriptInvocationData* m_pendingUIScriptInvocationData { nullptr };
128 };
129
130 } // namespace WTR
131
132 #endif // TestInvocation_h