forked from WebKit/WebKit
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathWebDriverService.h
190 lines (168 loc) · 10.4 KB
/
WebDriverService.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
/*
* Copyright (C) 2017 Igalia S.L.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "HTTPServer.h"
#include "Session.h"
#include <wtf/Forward.h>
#include <wtf/HashMap.h>
#include <wtf/JSONValues.h>
#include <wtf/text/StringHash.h>
#if ENABLE(WEBDRIVER_BIDI)
#include "WebSocketServer.h"
#endif
namespace WebDriver {
struct Capabilities;
class CommandResult;
class Session;
class WebDriverService final : public HTTPRequestHandler
#if ENABLE(WEBDRIVER_BIDI)
, public WebSocketMessageHandler
#endif
{
public:
WebDriverService();
~WebDriverService();
int run(int argc, char** argv);
static void platformInit();
static bool platformCompareBrowserVersions(const String&, const String&);
RefPtr<Session> session() const { return m_session; }
private:
enum class HTTPMethod { Get, Post, Delete };
typedef void (WebDriverService::*CommandHandler)(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
struct Command {
HTTPMethod method;
const char* uriTemplate;
CommandHandler handler;
};
static const Command s_commands[];
static std::optional<HTTPMethod> toCommandHTTPMethod(const String& method);
static bool findCommand(HTTPMethod, const String& path, CommandHandler*, HashMap<String, String>& parameters);
void newSession(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void deleteSession(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void status(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void getTimeouts(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void setTimeouts(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void go(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void getCurrentURL(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void back(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void forward(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void refresh(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void getTitle(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void getWindowHandle(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void closeWindow(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void switchToWindow(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void getWindowHandles(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void newWindow(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void switchToFrame(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void switchToParentFrame(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void getWindowRect(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void setWindowRect(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void maximizeWindow(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void minimizeWindow(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void fullscreenWindow(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void findElement(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void findElements(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void findElementFromElement(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void findElementsFromElement(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void findElementFromShadowRoot(RefPtr<JSON::Object>&&, Function<void(CommandResult&&)>&&);
void findElementsFromShadowRoot(RefPtr<JSON::Object>&&, Function<void(CommandResult&&)>&&);
void getActiveElement(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void getElementShadowRoot(RefPtr<JSON::Object>&&, Function<void(CommandResult&&)>&&);
void isElementSelected(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void getElementAttribute(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void getElementProperty(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void getElementCSSValue(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void getElementText(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void getElementTagName(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void getElementRect(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void isElementEnabled(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void getComputedRole(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void getComputedLabel(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void isElementDisplayed(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void elementClick(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void elementClear(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void elementSendKeys(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void getPageSource(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void executeScript(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void executeAsyncScript(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void getAllCookies(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void getNamedCookie(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void addCookie(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void deleteCookie(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void deleteAllCookies(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void performActions(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void releaseActions(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void dismissAlert(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void acceptAlert(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void getAlertText(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void sendAlertText(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void takeScreenshot(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
void takeElementScreenshot(RefPtr<JSON::Object>&&, Function<void (CommandResult&&)>&&);
#if ENABLE(WEBDRIVER_BIDI)
// BiDi message handlers
void bidiSessionStatus(unsigned id, RefPtr<JSON::Object>&&, Function<void (WebSocketMessageHandler::Message&&)>&&);
void bidiSessionSubscribe(unsigned id, RefPtr<JSON::Object>&&, Function<void (WebSocketMessageHandler::Message&&)>&&);
void bidiSessionUnsubscribe(unsigned id, RefPtr<JSON::Object>&&, Function<void (WebSocketMessageHandler::Message&&)>&&);
#endif
static Capabilities platformCapabilities();
Vector<Capabilities> processCapabilities(const JSON::Object&, Function<void (CommandResult&&)>&) const;
RefPtr<JSON::Object> validatedCapabilities(const JSON::Object&) const;
RefPtr<JSON::Object> mergeCapabilities(const JSON::Object&, const JSON::Object&) const;
RefPtr<JSON::Object> matchCapabilities(const JSON::Object&) const;
bool platformValidateCapability(const String&, const Ref<JSON::Value>&) const;
bool platformMatchCapability(const String&, const Ref<JSON::Value>&) const;
bool platformSupportProxyType(const String&) const;
bool platformSupportBidi() const;
void parseCapabilities(const JSON::Object& desiredCapabilities, Capabilities&) const;
void platformParseCapabilities(const JSON::Object& desiredCapabilities, Capabilities&) const;
void connectToBrowser(Vector<Capabilities>&&, Function<void (CommandResult&&)>&&);
void createSession(Vector<Capabilities>&&, Ref<SessionHost>&&, Function<void (CommandResult&&)>&&);
bool findSessionOrCompleteWithError(JSON::Object&, Function<void (CommandResult&&)>&);
void handleRequest(HTTPRequestHandler::Request&&, Function<void (HTTPRequestHandler::Response&&)>&& replyHandler) override;
void sendResponse(Function<void (HTTPRequestHandler::Response&&)>&& replyHandler, CommandResult&&) const;
#if ENABLE(WEBDRIVER_BIDI)
bool acceptHandshake(HTTPRequestHandler::Request&&) override;
void handleMessage(WebSocketMessageHandler::Message&&, Function<void (WebSocketMessageHandler::Message&&)>&& replyHandler) override;
void clientDisconnected(const WebSocketMessageHandler::Connection&) override;
void onBrowserTerminated(const String& sessionId);
typedef void (WebDriverService::*BidiCommandHandler)(unsigned id, RefPtr<JSON::Object>&&, Function<void (WebSocketMessageHandler::Message&&)>&&);
struct BidiCommand {
String method;
BidiCommandHandler handler;
};
static const BidiCommand s_bidiCommands[];
static bool findBidiCommand(RefPtr<JSON::Value>&, BidiCommandHandler*, unsigned& id, RefPtr<JSON::Object>& parsedParams);
#endif // ENABLE(WEBDRIVER_BIDI)
HTTPServer m_server;
#if ENABLE(WEBDRIVER_BIDI)
WebSocketServer m_bidiServer;
SessionHost::BrowserTerminatedObserver m_browserTerminatedObserver;
#endif
RefPtr<Session> m_session;
String m_targetAddress;
uint16_t m_targetPort { 0 };
bool m_replaceOnNewSession { false };
};
} // namespace WebDriver