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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
|
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "remoting/signaling/ftl_messaging_client.h"
#include <algorithm>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "base/check.h"
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/memory/raw_ptr.h"
#include "base/notreached.h"
#include "base/run_loop.h"
#include "base/task/thread_pool.h"
#include "base/test/bind.h"
#include "base/test/mock_callback.h"
#include "base/test/task_environment.h"
#include "remoting/base/fake_oauth_token_getter.h"
#include "remoting/base/http_status.h"
#include "remoting/base/protobuf_http_client.h"
#include "remoting/base/protobuf_http_test_responder.h"
#include "remoting/base/scoped_protobuf_http_request.h"
#include "remoting/proto/ftl/v1/ftl_messages.pb.h"
#include "remoting/signaling/ftl_services_context.h"
#include "remoting/signaling/message_reception_channel.h"
#include "remoting/signaling/registration_manager.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace remoting {
namespace {
using ::testing::_;
using ::testing::Invoke;
using ::testing::Property;
using ::testing::Return;
using ::testing::Truly;
constexpr char kFakeServerEndpoint[] = "test.com";
constexpr char kFakeSenderId[] = "fake_sender@gmail.com";
constexpr char kFakeSenderRegId[] = "fake_sender_reg_id";
constexpr char kFakeReceiverId[] = "fake_receiver@gmail.com";
constexpr char kMessage1Id[] = "msg_1";
constexpr char kMessage2Id[] = "msg_2";
constexpr char kMessage1Text[] = "Message 1";
constexpr char kMessage2Text[] = "Message 2";
MATCHER(IsFakeSenderId, "") {
return arg.id() == kFakeSenderId;
}
ftl::ChromotingMessage CreateXmppMessage(const std::string& message_text) {
ftl::ChromotingMessage crd_message;
crd_message.mutable_xmpp()->set_stanza(message_text);
return crd_message;
}
ftl::InboxMessage CreateInboxMessage(const std::string& message_id,
const std::string& message_text) {
ftl::InboxMessage message;
message.mutable_sender_id()->set_id(kFakeSenderId);
message.mutable_receiver_id()->set_id(kFakeReceiverId);
message.set_sender_registration_id(kFakeSenderRegId);
message.set_message_type(ftl::InboxMessage_MessageType_CHROMOTING_MESSAGE);
message.set_message_id(message_id);
ftl::ChromotingMessage crd_message = CreateXmppMessage(message_text);
std::string serialized_message;
bool succeeded = crd_message.SerializeToString(&serialized_message);
EXPECT_TRUE(succeeded);
message.set_message(serialized_message);
return message;
}
base::OnceCallback<void(const HttpStatus&)> CheckStatusThenQuitRunLoopCallback(
const base::Location& from_here,
HttpStatus::Code expected_status_code,
base::RunLoop* run_loop) {
return base::BindLambdaForTesting([=](const HttpStatus& status) {
ASSERT_EQ(expected_status_code, status.error_code())
<< "Incorrect status code. Location: " << from_here.ToString();
run_loop->QuitWhenIdle();
});
}
std::string GetChromotingMessageText(const ftl::InboxMessage& message) {
EXPECT_EQ(ftl::InboxMessage_MessageType_CHROMOTING_MESSAGE,
message.message_type());
ftl::ChromotingMessage chromoting_message;
chromoting_message.ParseFromString(message.message());
return chromoting_message.xmpp().stanza();
}
class MockMessageReceptionChannel : public MessageReceptionChannel {
public:
MockMessageReceptionChannel() = default;
MockMessageReceptionChannel(const MockMessageReceptionChannel&) = delete;
MockMessageReceptionChannel& operator=(const MockMessageReceptionChannel&) =
delete;
~MockMessageReceptionChannel() override = default;
// MessageReceptionChannel implementations.
void Initialize(const StreamOpener& stream_opener,
const MessageCallback& on_incoming_msg) override {
stream_opener_ = stream_opener;
on_incoming_msg_ = on_incoming_msg;
}
MOCK_METHOD2(StartReceivingMessages, void(base::OnceClosure, DoneCallback));
MOCK_METHOD0(StopReceivingMessages, void());
MOCK_CONST_METHOD0(IsReceivingMessages, bool());
StreamOpener* stream_opener() { return &stream_opener_; }
MessageCallback* on_incoming_msg() { return &on_incoming_msg_; }
private:
StreamOpener stream_opener_;
MessageCallback on_incoming_msg_;
};
class MockRegistrationManager : public RegistrationManager {
public:
MockRegistrationManager() = default;
~MockRegistrationManager() override = default;
MOCK_METHOD1(SignInGaia, void(DoneCallback));
MOCK_METHOD0(SignOut, void());
MOCK_CONST_METHOD0(IsSignedIn, bool());
MOCK_CONST_METHOD0(GetRegistrationId, std::string());
MOCK_CONST_METHOD0(GetFtlAuthToken, std::string());
};
decltype(auto) StanzaTextMatches(const std::string& expected_stanza) {
return Truly([=](const ftl::ChromotingMessage& message) {
return expected_stanza == message.xmpp().stanza();
});
}
} // namespace
class FtlMessagingClientTest : public testing::Test {
public:
void SetUp() override;
void TearDown() override;
protected:
ProtobufHttpTestResponder test_responder_;
FakeOAuthTokenGetter token_getter_{OAuthTokenGetter::Status::SUCCESS,
OAuthTokenInfo()};
std::unique_ptr<FtlMessagingClient> messaging_client_;
raw_ptr<MockMessageReceptionChannel> mock_message_reception_channel_;
private:
base::test::TaskEnvironment task_environment_;
MockRegistrationManager mock_registration_manager_;
};
void FtlMessagingClientTest::SetUp() {
EXPECT_CALL(mock_registration_manager_, GetFtlAuthToken())
.WillRepeatedly(Return("fake_auth_token"));
auto channel = std::make_unique<MockMessageReceptionChannel>();
mock_message_reception_channel_ = channel.get();
messaging_client_ = std::unique_ptr<FtlMessagingClient>(
new FtlMessagingClient(std::make_unique<ProtobufHttpClient>(
kFakeServerEndpoint, &token_getter_,
test_responder_.GetUrlLoaderFactory()),
&mock_registration_manager_, std::move(channel)));
}
void FtlMessagingClientTest::TearDown() {
mock_message_reception_channel_ = nullptr;
messaging_client_.reset();
}
TEST_F(FtlMessagingClientTest, TestSendMessage_Unauthenticated) {
base::RunLoop run_loop;
messaging_client_->SendMessage(
kFakeReceiverId, kFakeSenderRegId, CreateXmppMessage(kMessage1Text),
CheckStatusThenQuitRunLoopCallback(
FROM_HERE, HttpStatus::Code::UNAUTHENTICATED, &run_loop));
test_responder_.AddErrorToMostRecentRequestUrl(
HttpStatus(HttpStatus::Code::UNAUTHENTICATED, "Unauthenticated"));
run_loop.Run();
}
TEST_F(FtlMessagingClientTest, TestSendMessage_SendOneMessageWithoutRegId) {
base::RunLoop run_loop;
messaging_client_->SendMessage(
kFakeReceiverId, "", CreateXmppMessage(kMessage1Text),
CheckStatusThenQuitRunLoopCallback(FROM_HERE, HttpStatus::Code::OK,
&run_loop));
ftl::InboxSendRequest request;
ASSERT_TRUE(test_responder_.GetMostRecentRequestMessage(&request));
EXPECT_EQ(0, request.dest_registration_ids_size());
EXPECT_LT(0, request.time_to_live());
EXPECT_EQ(kFakeReceiverId, request.dest_id().id());
EXPECT_FALSE(request.message().message_id().empty());
EXPECT_EQ(kMessage1Text, GetChromotingMessageText(request.message()));
test_responder_.AddResponseToMostRecentRequestUrl(ftl::InboxSendResponse());
run_loop.Run();
}
TEST_F(FtlMessagingClientTest, TestSendMessage_SendOneMessageWithRegId) {
base::RunLoop run_loop;
messaging_client_->SendMessage(
kFakeReceiverId, kFakeSenderRegId, CreateXmppMessage(kMessage1Text),
CheckStatusThenQuitRunLoopCallback(FROM_HERE, HttpStatus::Code::OK,
&run_loop));
ftl::InboxSendRequest request;
ASSERT_TRUE(test_responder_.GetMostRecentRequestMessage(&request));
EXPECT_EQ(1, request.dest_registration_ids_size());
EXPECT_EQ(kFakeSenderRegId, request.dest_registration_ids(0));
EXPECT_LT(0, request.time_to_live());
EXPECT_EQ(kFakeReceiverId, request.dest_id().id());
EXPECT_FALSE(request.message().message_id().empty());
EXPECT_EQ(kMessage1Text, GetChromotingMessageText(request.message()));
test_responder_.AddResponseToMostRecentRequestUrl(ftl::InboxSendResponse());
run_loop.Run();
}
TEST_F(FtlMessagingClientTest, TestStartReceivingMessages_CallbacksForwarded) {
base::RunLoop run_loop;
EXPECT_CALL(*mock_message_reception_channel_, StartReceivingMessages(_, _))
.WillOnce(Invoke([&](base::OnceClosure on_ready,
FtlMessagingClient::DoneCallback on_closed) {
std::move(on_ready).Run();
std::move(on_closed).Run(
HttpStatus(HttpStatus::Code::UNAUTHENTICATED, ""));
}));
base::MockCallback<base::OnceClosure> mock_on_ready_closure;
EXPECT_CALL(mock_on_ready_closure, Run()).WillOnce(Return());
messaging_client_->StartReceivingMessages(
mock_on_ready_closure.Get(),
base::BindLambdaForTesting([&](const HttpStatus& status) {
ASSERT_EQ(HttpStatus::Code::UNAUTHENTICATED, status.error_code());
run_loop.Quit();
}));
run_loop.Run();
}
TEST_F(FtlMessagingClientTest, TestStopReceivingMessages_CallForwarded) {
EXPECT_CALL(*mock_message_reception_channel_, StopReceivingMessages())
.WillOnce(Return());
messaging_client_->StopReceivingMessages();
}
TEST_F(FtlMessagingClientTest,
TestStreamOpener_StreamsTwoMessagesThenCloseByServer) {
base::RunLoop run_loop;
std::unique_ptr<ScopedProtobufHttpRequest> scoped_stream;
ftl::ReceiveMessagesResponse response_1;
response_1.mutable_inbox_message()->set_message_id(kMessage1Id);
ftl::ReceiveMessagesResponse response_2;
response_2.mutable_pong();
base::MockCallback<base::RepeatingCallback<void(
std::unique_ptr<ftl::ReceiveMessagesResponse>)>>
mock_on_incoming_msg;
EXPECT_CALL(mock_on_incoming_msg, Run(_))
.WillOnce([&](std::unique_ptr<ftl::ReceiveMessagesResponse> response) {
ASSERT_EQ(kMessage1Id, response->inbox_message().message_id());
})
.WillOnce([&](std::unique_ptr<ftl::ReceiveMessagesResponse> response) {
ASSERT_TRUE(response->has_pong());
});
base::MockCallback<base::OnceClosure> on_channel_ready;
EXPECT_CALL(on_channel_ready, Run()).Times(1);
scoped_stream = mock_message_reception_channel_->stream_opener()->Run(
on_channel_ready.Get(), mock_on_incoming_msg.Get(),
CheckStatusThenQuitRunLoopCallback(FROM_HERE, HttpStatus::Code::OK,
&run_loop));
test_responder_.AddStreamResponseToMostRecentRequestUrl(
{&response_1, &response_2}, HttpStatus::OK());
run_loop.Run();
}
TEST_F(FtlMessagingClientTest,
TestOnMessageReceived_MessagePassedToSubscriberAndAcked) {
base::RunLoop run_loop;
base::MockCallback<FtlMessagingClient::MessageCallback> mock_on_incoming_msg;
EXPECT_CALL(mock_on_incoming_msg, Run(IsFakeSenderId(), kFakeSenderRegId,
StanzaTextMatches(kMessage1Text)))
.WillOnce([&](const ftl::Id&, const std::string&,
const ftl::ChromotingMessage&) { run_loop.Quit(); });
auto subscription =
messaging_client_->RegisterMessageCallback(mock_on_incoming_msg.Get());
ftl::InboxMessage message = CreateInboxMessage(kMessage1Id, kMessage1Text);
mock_message_reception_channel_->on_incoming_msg()->Run(message);
ftl::BatchAckMessagesRequest request;
ASSERT_TRUE(test_responder_.GetMostRecentRequestMessage(&request));
EXPECT_EQ(1, request.message_ids_size());
EXPECT_EQ(kMessage1Id, request.message_ids(0));
test_responder_.AddResponseToMostRecentRequestUrl(
ftl::BatchAckMessagesResponse());
run_loop.Run();
}
TEST_F(FtlMessagingClientTest, ReceivedDuplicatedMessage_AckAndDrop) {
base::RunLoop run_loop;
base::MockCallback<FtlMessagingClient::MessageCallback> mock_on_incoming_msg;
EXPECT_CALL(mock_on_incoming_msg, Run(IsFakeSenderId(), kFakeSenderRegId, _))
.WillOnce([](const ftl::Id&, const std::string&,
const ftl::ChromotingMessage& message) {
EXPECT_EQ(kMessage1Text, message.xmpp().stanza());
})
.WillOnce([](const ftl::Id&, const std::string&,
const ftl::ChromotingMessage& message) {
EXPECT_EQ(kMessage2Text, message.xmpp().stanza());
});
EXPECT_CALL(test_responder_.GetMockInterceptor(), Run(_))
.WillOnce([](const network::ResourceRequest& request) {
ftl::BatchAckMessagesRequest message;
ProtobufHttpTestResponder::ParseRequestMessage(request, &message);
EXPECT_EQ(1, message.message_ids_size());
EXPECT_EQ(kMessage1Id, message.message_ids(0));
})
.WillOnce([](const network::ResourceRequest& request) {
ftl::BatchAckMessagesRequest message;
ProtobufHttpTestResponder::ParseRequestMessage(request, &message);
EXPECT_EQ(1, message.message_ids_size());
EXPECT_EQ(kMessage1Id, message.message_ids(0));
})
.WillOnce([&](const network::ResourceRequest& request) {
ftl::BatchAckMessagesRequest message;
ProtobufHttpTestResponder::ParseRequestMessage(request, &message);
EXPECT_EQ(1, message.message_ids_size());
EXPECT_EQ(kMessage2Id, message.message_ids(0));
run_loop.Quit();
});
auto subscription =
messaging_client_->RegisterMessageCallback(mock_on_incoming_msg.Get());
ftl::InboxMessage message_1 = CreateInboxMessage(kMessage1Id, kMessage1Text);
mock_message_reception_channel_->on_incoming_msg()->Run(message_1);
ftl::InboxMessage message_2 = CreateInboxMessage(kMessage1Id, kMessage1Text);
mock_message_reception_channel_->on_incoming_msg()->Run(message_2);
ftl::InboxMessage message_3 = CreateInboxMessage(kMessage2Id, kMessage2Text);
mock_message_reception_channel_->on_incoming_msg()->Run(message_3);
run_loop.Run();
}
} // namespace remoting
|
