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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "extensions/browser/api_test_utils.h"
#include <memory>
#include <optional>
#include <utility>
#include <variant>
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/json/json_reader.h"
#include "base/test/values_test_util.h"
#include "base/types/expected.h"
#include "base/values.h"
#include "components/crx_file/id_util.h"
#include "content/public/browser/browser_context.h"
#include "content/public/test/test_utils.h"
#include "extensions/browser/extension_function.h"
#include "extensions/browser/extension_function_dispatcher.h"
#include "testing/gtest/include/gtest/gtest.h"
using extensions::ExtensionFunctionDispatcher;
namespace extensions {
namespace api_test_utils {
SendResponseHelper::SendResponseHelper(ExtensionFunction* function) {
function->set_has_callback(true);
function->set_response_callback(
base::BindOnce(&SendResponseHelper::OnResponse, base::Unretained(this)));
}
SendResponseHelper::~SendResponseHelper() = default;
bool SendResponseHelper::GetResponse() {
EXPECT_TRUE(has_response());
return *response_;
}
void SendResponseHelper::OnResponse(ExtensionFunction::ResponseType response,
base::Value::List results,
const std::string& error,
mojom::ExtraResponseDataPtr) {
ASSERT_NE(ExtensionFunction::ResponseType::kBadMessage, response);
response_ = std::make_unique<bool>(
response == ExtensionFunction::ResponseType::kSucceeded);
run_loop_.Quit();
}
void SendResponseHelper::WaitForResponse() {
run_loop_.Run();
}
bool GetBoolean(const base::Value::Dict& dict, const std::string& key) {
std::optional<bool> value = dict.FindBool(key);
if (!value.has_value()) {
ADD_FAILURE() << key << " does not exist or is not a boolean.";
return false;
}
return *value;
}
int GetInteger(const base::Value::Dict& dict, const std::string& key) {
std::optional<int> value = dict.FindInt(key);
if (!value.has_value()) {
ADD_FAILURE() << key << " does not exist or is not an integer.";
return 0;
}
return *value;
}
std::string GetString(const base::Value::Dict& dict, const std::string& key) {
const std::string* value = dict.FindString(key);
if (!value) {
ADD_FAILURE() << key << " does not exist or is not a string.";
return "";
}
return *value;
}
base::Value::List GetList(const base::Value::Dict& dict,
const std::string& key) {
const base::Value::List* value = dict.FindList(key);
if (!value) {
ADD_FAILURE() << key << " does not exist or is not a list.";
return base::Value::List();
}
return value->Clone();
}
base::Value::Dict GetDict(const base::Value::Dict& dict,
const std::string& key) {
const base::Value::Dict* value = dict.FindDict(key);
if (!value) {
ADD_FAILURE() << key << " does not exist or is not a dict.";
return base::Value::Dict();
}
return value->Clone();
}
base::Value::Dict ToDict(std::optional<base::ValueView> val) {
if (!val) {
ADD_FAILURE() << "val is nullopt";
return base::Value::Dict();
}
base::Value result = val->ToValue();
if (!result.is_dict()) {
ADD_FAILURE() << "val is not a dictionary";
return base::Value::Dict();
}
return std::move(result).TakeDict();
}
base::Value::List ToList(std::optional<base::ValueView> val) {
if (!val) {
ADD_FAILURE() << "val is nullopt";
return base::Value::List();
}
base::Value result = val->ToValue();
if (!result.is_list()) {
ADD_FAILURE() << "val is not a list";
return base::Value::List();
}
return std::move(result).TakeList();
}
std::optional<base::Value> RunFunctionWithDelegateAndReturnSingleResult(
scoped_refptr<ExtensionFunction> function,
ArgsType args,
std::unique_ptr<ExtensionFunctionDispatcher> dispatcher,
FunctionMode mode) {
RunFunction(function, std::move(args), std::move(dispatcher), mode);
EXPECT_TRUE(function->GetError().empty())
<< "Function " << function->name()
<< " had unexpected error: " << function->GetError();
const base::Value::List* results = function->GetResultListForTest();
if (!results || results->empty()) {
return std::nullopt;
}
return (*results)[0].Clone();
}
std::optional<base::Value> RunFunctionAndReturnSingleResult(
scoped_refptr<ExtensionFunction> function,
ArgsType args,
content::BrowserContext* context,
FunctionMode mode) {
auto dispatcher = std::make_unique<ExtensionFunctionDispatcher>(context);
return RunFunctionWithDelegateAndReturnSingleResult(
std::move(function), std::move(args), std::move(dispatcher), mode);
}
std::string RunFunctionAndReturnError(scoped_refptr<ExtensionFunction> function,
ArgsType args,
content::BrowserContext* context,
FunctionMode mode) {
// Without a callback the function will not generate a result.
RunFunction(function, std::move(args), context, mode);
// When sending a response, the function will set an empty list value if there
// is no specified result.
const base::Value::List* results = function->GetResultListForTest();
CHECK(results);
EXPECT_TRUE(results->empty()) << "Did not expect a result";
CHECK(function->response_type());
EXPECT_EQ(ExtensionFunction::ResponseType::kFailed,
*function->response_type());
return function->GetError();
}
base::expected<base::Value::List, std::string> RunFunctionAndReturnExpected(
scoped_refptr<ExtensionFunction> function,
ArgsType args,
content::BrowserContext* context,
FunctionMode mode) {
RunFunction(function, std::move(args), context, mode);
CHECK(function->response_type());
switch (*function->response_type()) {
case ExtensionFunction::ResponseType::kBadMessage:
// This case ASSERTs in `SendResponseHelper::OnResponse`.
NOTREACHED();
case ExtensionFunction::ResponseType::kFailed:
return base::unexpected(function->GetError());
case ExtensionFunction::ResponseType::kSucceeded:
const base::Value::List* results = function->GetResultListForTest();
CHECK(results);
return results->Clone();
}
}
bool RunFunction(scoped_refptr<ExtensionFunction> function,
ArgsType args,
content::BrowserContext* context,
FunctionMode mode) {
auto dispatcher = std::make_unique<ExtensionFunctionDispatcher>(context);
return RunFunction(function, std::move(args), std::move(dispatcher), mode);
}
bool RunFunction(scoped_refptr<ExtensionFunction> function,
ArgsType args,
std::unique_ptr<ExtensionFunctionDispatcher> dispatcher,
FunctionMode mode) {
static_assert(std::variant_size<ArgsType>::value == 2, "Unhandled variant!");
base::Value::List parsed_args =
args.index() == 0 ? base::test::ParseJsonList(std::get<0>(args))
: std::move(std::get<1>(args));
SendResponseHelper response_helper(function.get());
function->SetArgs(std::move(parsed_args));
CHECK(dispatcher);
function->SetDispatcher(dispatcher->AsWeakPtr());
function->set_include_incognito_information(mode == FunctionMode::kIncognito);
function->preserve_results_for_testing();
function->RunWithValidation().Execute();
response_helper.WaitForResponse();
EXPECT_TRUE(response_helper.has_response());
return response_helper.GetResponse();
}
} // namespace api_test_utils
} // namespace extensions
|
