898374573d29ecbb43094c4b4054c0ee86e4939f
[WebKit-https.git] / Source / WebDriver / WebDriverService.h
1 /*
2  * Copyright (C) 2017 Igalia S.L.
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 #pragma once
27
28 #include "HTTPServer.h"
29 #include "Session.h"
30 #include <wtf/Forward.h>
31 #include <wtf/HashMap.h>
32 #include <wtf/text/StringHash.h>
33
34 namespace Inspector {
35 class InspectorArray;
36 class InspectorObject;
37 }
38
39 namespace WebDriver {
40
41 class Capabilities;
42 class CommandResult;
43 class Session;
44
45 class WebDriverService final : public HTTPRequestHandler {
46 public:
47     WebDriverService();
48     ~WebDriverService() = default;
49
50     int run(int argc, char** argv);
51     void quit();
52
53     static bool platformCompareBrowserVersions(const String&, const String&);
54
55 private:
56     enum class HTTPMethod { Get, Post, Delete };
57     typedef void (WebDriverService::*CommandHandler)(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
58     struct Command {
59         HTTPMethod method;
60         const char* uriTemplate;
61         CommandHandler handler;
62     };
63     static const Command s_commands[];
64
65     static std::optional<HTTPMethod> toCommandHTTPMethod(const String& method);
66     static bool findCommand(const String& method, const String& path, CommandHandler*, HashMap<String, String>& parameters);
67
68     void newSession(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
69     void deleteSession(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
70     void setTimeouts(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
71     void go(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
72     void getCurrentURL(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
73     void back(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
74     void forward(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
75     void refresh(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
76     void getTitle(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
77     void getWindowHandle(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
78     void closeWindow(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
79     void switchToWindow(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
80     void getWindowHandles(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
81     void switchToFrame(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
82     void switchToParentFrame(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
83     void getWindowPosition(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
84     void setWindowPosition(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
85     void getWindowSize(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
86     void setWindowSize(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
87     void findElement(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
88     void findElements(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
89     void findElementFromElement(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
90     void findElementsFromElement(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
91     void isElementSelected(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
92     void getElementText(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
93     void getElementTagName(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
94     void getElementRect(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
95     void isElementEnabled(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
96     void isElementDisplayed(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
97     void getElementAttribute(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
98     void elementClick(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
99     void elementClear(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
100     void elementSendKeys(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
101     void elementSubmit(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
102     void executeScript(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
103     void executeAsyncScript(RefPtr<Inspector::InspectorObject>&&, Function<void (CommandResult&&)>&&);
104
105     static Capabilities platformCapabilities();
106     RefPtr<Inspector::InspectorObject> processCapabilities(const Inspector::InspectorObject&, Function<void (CommandResult&&)>&) const;
107     RefPtr<Inspector::InspectorObject> validatedCapabilities(const Inspector::InspectorObject&) const;
108     RefPtr<Inspector::InspectorObject> mergeCapabilities(const Inspector::InspectorObject&, const Inspector::InspectorObject&) const;
109     std::optional<String> matchCapabilities(const Inspector::InspectorObject&) const;
110     bool platformValidateCapability(const String&, const RefPtr<Inspector::InspectorValue>&) const;
111     std::optional<String> platformMatchCapability(const String&, const RefPtr<Inspector::InspectorValue>&) const;
112     void parseCapabilities(const Inspector::InspectorObject& desiredCapabilities, Capabilities&) const;
113     void platformParseCapabilities(const Inspector::InspectorObject& desiredCapabilities, Capabilities&) const;
114     RefPtr<Session> findSessionOrCompleteWithError(Inspector::InspectorObject&, Function<void (CommandResult&&)>&);
115
116     void handleRequest(HTTPRequestHandler::Request&&, Function<void (HTTPRequestHandler::Response&&)>&& replyHandler) override;
117     void sendResponse(Function<void (HTTPRequestHandler::Response&&)>&& replyHandler, CommandResult&&) const;
118
119     HTTPServer m_server;
120     HashMap<String, RefPtr<Session>> m_sessions;
121     Session* m_activeSession { nullptr };
122 };
123
124 } // namespace WebDriver