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
content / public / test / test_devtools_protocol_client.h [blame]
// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CONTENT_PUBLIC_TEST_TEST_DEVTOOLS_PROTOCOL_CLIENT_H_
#define CONTENT_PUBLIC_TEST_TEST_DEVTOOLS_PROTOCOL_CLIENT_H_
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <utility>
#include <vector>
#include "base/functional/callback.h"
#include "base/functional/function_ref.h"
#include "base/values.h"
#include "content/public/browser/devtools_agent_host.h"
namespace content {
class TestDevToolsProtocolClient : public DevToolsAgentHostClient {
public:
typedef base::RepeatingCallback<bool(const base::Value::Dict&)>
NotificationMatcher;
TestDevToolsProtocolClient();
~TestDevToolsProtocolClient() override;
void AttachToWebContents(WebContents* web_contents);
void AttachToTabTarget(WebContents* web_contents);
void AttachToBrowserTarget();
const base::Value::Dict* SendCommand(std::string method,
base::Value::Dict params,
bool wait = true) {
return SendSessionCommand(method, std::move(params), std::string(), wait);
}
const base::Value::Dict* SendCommandSync(std::string method) {
return SendCommand(std::move(method), base::Value::Dict(), true);
}
const base::Value::Dict* SendCommandSync(std::string method,
base::Value::Dict params) {
return SendCommand(std::move(method), std::move(params), true);
}
const base::Value::Dict* SendCommandAsync(std::string method) {
return SendCommand(std::move(method), base::Value::Dict(), false);
}
const base::Value::Dict* SendCommandAsync(std::string method,
base::Value::Dict params) {
return SendCommand(std::move(method), std::move(params), false);
}
const base::Value::Dict* SendSessionCommand(const std::string method,
base::Value::Dict params,
const std::string session_id,
bool wait);
void DetachProtocolClient() {
if (agent_host_) {
agent_host_->DetachClient(this);
agent_host_ = nullptr;
}
}
protected:
bool HasExistingNotification() const { return !notifications_.empty(); }
bool HasExistingNotification(const std::string& notification) const;
bool HasExistingNotificationMatching(
base::FunctionRef<bool(const base::Value::Dict&)> pred) const;
base::Value::Dict WaitForNotification(const std::string& notification,
bool allow_existing);
base::Value::Dict WaitForNotification(const std::string& notification) {
return WaitForNotification(notification, false);
}
// Waits for a notification whose params, when passed to |matcher|, returns
// true. Existing notifications are allowed.
base::Value::Dict WaitForMatchingNotification(
const std::string& notification,
const NotificationMatcher& matcher);
void ClearNotifications() { notifications_.clear(); }
void set_agent_host_can_close() { agent_host_can_close_ = true; }
void SetAllowUnsafeOperations(bool allow) {
allow_unsafe_operations_ = allow;
}
void SetIsTrusted(bool is_trusted) { is_trusted_ = is_trusted; }
void SetNavigationInitiatorOrigin(
const url::Origin& navigation_initiator_origin) {
navigation_initiator_origin_ = navigation_initiator_origin;
}
void SetMayReadLocalFiles(bool may_read_local_files) {
may_read_local_files_ = may_read_local_files;
}
void SetMayWriteLocalFiles(bool may_write_local_files) {
may_write_local_files_ = may_write_local_files;
}
void SetNotAttachableHosts(
const std::set<std::string>& not_attachable_hosts) {
not_attachable_hosts_ = not_attachable_hosts;
}
const base::Value::Dict* result() const;
const base::Value::Dict* error() const;
int received_responses_count() const { return received_responses_count_; }
scoped_refptr<DevToolsAgentHost> agent_host_;
void SetProtocolCommandId(int id) { last_sent_id_ = id - 1; }
private:
void WaitForResponse();
void RunLoopUpdatingQuitClosure();
void DispatchProtocolMessage(DevToolsAgentHost* agent_host,
base::span<const uint8_t> message) override;
void AgentHostClosed(DevToolsAgentHost* agent_host) override;
std::optional<url::Origin> GetNavigationInitiatorOrigin() override;
bool AllowUnsafeOperations() override;
bool IsTrusted() override;
bool MayReadLocalFiles() override;
bool MayWriteLocalFiles() override;
bool MayAttachToURL(const GURL& url, bool is_webui) override;
int last_sent_id_ = 0;
int waiting_for_command_result_id_ = 0;
std::string waiting_for_notification_;
NotificationMatcher waiting_for_notification_matcher_;
int received_responses_count_ = 0;
base::Value::Dict response_;
base::Value::Dict received_notification_params_;
std::vector<base::Value::Dict> notifications_;
bool in_dispatch_ = false;
bool agent_host_can_close_ = false;
base::OnceClosure run_loop_quit_closure_;
bool allow_unsafe_operations_ = true;
bool is_trusted_ = true;
std::optional<url::Origin> navigation_initiator_origin_;
bool may_read_local_files_ = true;
bool may_write_local_files_ = true;
std::set<std::string> not_attachable_hosts_;
};
} // namespace content
#endif // CONTENT_PUBLIC_TEST_TEST_DEVTOOLS_PROTOCOL_CLIENT_H_