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
|
// 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 "components/sharing_message/sharing_fcm_handler.h"
#include <memory>
#include "base/test/task_environment.h"
#include "components/gcm_driver/fake_gcm_driver.h"
#include "components/sharing_message/fake_device_info.h"
#include "components/sharing_message/fake_sharing_handler_registry.h"
#include "components/sharing_message/features.h"
#include "components/sharing_message/mock_sharing_message_handler.h"
#include "components/sharing_message/proto/sharing_message.pb.h"
#include "components/sharing_message/sharing_constants.h"
#include "components/sharing_message/sharing_fcm_handler.h"
#include "components/sharing_message/sharing_fcm_sender.h"
#include "components/sharing_message/sharing_handler_registry.h"
#include "components/sync/protocol/device_info_specifics.pb.h"
#include "components/sync_device_info/device_info.h"
#include "components/sync_device_info/fake_device_info_sync_service.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
using ::testing::_;
using ::testing::Eq;
using SharingMessage = components_sharing_message::SharingMessage;
namespace {
const char kTestAppId[] = "test_app_id";
const char kTestMessageId[] = "0:1563805165426489%0bb84dcff9fd7ecd";
const char kTestMessageIdSecondaryUser[] =
"0:1563805165426489%20#0bb84dcff9fd7ecd";
const char kOriginalMessageId[] = "test_original_message_id";
const char kSenderGuid[] = "test_sender_guid";
const char kSenderName[] = "test_sender_name";
const char kSenderIdFCMToken[] = "test_sender_id_fcm_token";
const char kSenderIdP256dh[] = "test_sender_id_p256_dh";
const char kSenderIdAuthSecret[] = "test_sender_id_auth_secret";
const char kServerConfiguration[] = "test_server_configuration";
const char kServerP256dh[] = "test_server_p256_dh";
const char kServerAuthSecret[] = "test_server_auth_secret";
void SetupFcmChannel(
components_sharing_message::FCMChannelConfiguration* fcm_configuration) {
fcm_configuration->set_sender_id_fcm_token(kSenderIdFCMToken);
fcm_configuration->set_sender_id_p256dh(kSenderIdP256dh);
fcm_configuration->set_sender_id_auth_secret(kSenderIdAuthSecret);
}
class MockSharingFCMSender : public SharingFCMSender {
public:
MockSharingFCMSender()
: SharingFCMSender(
/*sharing_message_bridge=*/nullptr,
/*sync_preference=*/nullptr,
/*gcm_driver=*/nullptr,
/*device_info_tracker=*/nullptr,
/*local_device_info_provider=*/nullptr,
/*sync_service=*/nullptr,
/*start_sync_flare=*/base::DoNothing()) {}
~MockSharingFCMSender() override = default;
MOCK_METHOD4(SendMessageToFcmTarget,
void(const components_sharing_message::FCMChannelConfiguration&
fcm_configuration,
base::TimeDelta time_to_live,
SharingMessage message,
SendMessageCallback callback));
MOCK_METHOD3(
SendMessageToServerTarget,
void(const components_sharing_message::ServerChannelConfiguration&
server_channel,
SharingMessage message,
SendMessageCallback callback));
};
class SharingFCMHandlerTest : public testing::Test {
protected:
SharingFCMHandlerTest() {
sharing_fcm_handler_ = std::make_unique<SharingFCMHandler>(
&fake_gcm_driver_,
fake_device_info_sync_service_.GetDeviceInfoTracker(),
&mock_sharing_fcm_sender_, &handler_registry_);
fake_device_info_ = CreateFakeDeviceInfo(
kSenderGuid, kSenderName,
syncer::DeviceInfo::SharingInfo(
{kSenderIdFCMToken, kSenderIdP256dh, kSenderIdAuthSecret},
/*chime_representative_target_id=*/std::string(),
std::set<sync_pb::SharingSpecificFields::EnabledFeatures>()));
}
// Creates a gcm::IncomingMessage with SharingMessage and defaults.
gcm::IncomingMessage CreateGCMIncomingMessage(
const std::string& message_id,
const SharingMessage& sharing_message) {
gcm::IncomingMessage incoming_message;
incoming_message.message_id = message_id;
sharing_message.SerializeToString(&incoming_message.raw_data);
return incoming_message;
}
base::test::TaskEnvironment task_environment_;
FakeSharingHandlerRegistry handler_registry_;
testing::NiceMock<MockSharingMessageHandler> mock_sharing_message_handler_;
testing::NiceMock<MockSharingFCMSender> mock_sharing_fcm_sender_;
gcm::FakeGCMDriver fake_gcm_driver_;
std::unique_ptr<SharingFCMHandler> sharing_fcm_handler_;
syncer::FakeDeviceInfoSyncService fake_device_info_sync_service_;
std::unique_ptr<syncer::DeviceInfo> fake_device_info_;
};
} // namespace
MATCHER_P(ProtoEquals, message, "") {
std::string expected_serialized, actual_serialized;
message.SerializeToString(&expected_serialized);
arg.SerializeToString(&actual_serialized);
return expected_serialized == actual_serialized;
}
MATCHER(FCMChannelMatcher, "") {
return arg.sender_id_fcm_token() == kSenderIdFCMToken &&
arg.sender_id_p256dh() == kSenderIdP256dh &&
arg.sender_id_auth_secret() == kSenderIdAuthSecret;
}
MATCHER(ServerChannelMatcher, "") {
return arg.configuration() == kServerConfiguration &&
arg.p256dh() == kServerP256dh &&
arg.auth_secret() == kServerAuthSecret;
}
// Tests handling of SharingMessage with AckMessage payload. This is different
// from other payloads since we need to ensure AckMessage is not sent for
// SharingMessage with AckMessage payload.
TEST_F(SharingFCMHandlerTest, AckMessageHandler) {
SharingMessage sharing_message;
sharing_message.mutable_ack_message()->set_original_message_id(
kOriginalMessageId);
gcm::IncomingMessage incoming_message =
CreateGCMIncomingMessage(kTestMessageId, sharing_message);
EXPECT_CALL(mock_sharing_message_handler_,
OnMessage(ProtoEquals(sharing_message), _));
EXPECT_CALL(mock_sharing_fcm_sender_, SendMessageToFcmTarget(_, _, _, _))
.Times(0);
handler_registry_.SetSharingHandler(SharingMessage::kAckMessage,
&mock_sharing_message_handler_);
sharing_fcm_handler_->OnMessage(kTestAppId, incoming_message);
}
// Generic test for handling of SharingMessage payload other than AckMessage.
TEST_F(SharingFCMHandlerTest, PingMessageHandler) {
SharingMessage sharing_message;
sharing_message.set_sender_guid(kSenderGuid);
sharing_message.mutable_ping_message();
SetupFcmChannel(sharing_message.mutable_fcm_channel_configuration());
gcm::IncomingMessage incoming_message =
CreateGCMIncomingMessage(kTestMessageId, sharing_message);
SharingMessage sharing_ack_message;
sharing_ack_message.mutable_ack_message()->set_original_message_id(
kTestMessageId);
// Tests OnMessage flow in SharingFCMHandler when no handler is registered.
EXPECT_CALL(mock_sharing_message_handler_, OnMessage(_, _)).Times(0);
EXPECT_CALL(mock_sharing_fcm_sender_, SendMessageToFcmTarget(_, _, _, _))
.Times(0);
sharing_fcm_handler_->OnMessage(kTestAppId, incoming_message);
// Tests OnMessage flow in SharingFCMHandler after handler is added.
ON_CALL(mock_sharing_message_handler_,
OnMessage(ProtoEquals(sharing_message), _))
.WillByDefault(testing::Invoke(
[](const SharingMessage& message,
SharingMessageHandler::DoneCallback done_callback) {
std::move(done_callback).Run(/*response=*/nullptr);
}));
EXPECT_CALL(mock_sharing_message_handler_, OnMessage(_, _));
EXPECT_CALL(
mock_sharing_fcm_sender_,
SendMessageToFcmTarget(FCMChannelMatcher(), Eq(kSharingAckMessageTTL),
ProtoEquals(sharing_ack_message), _));
handler_registry_.SetSharingHandler(SharingMessage::kPingMessage,
&mock_sharing_message_handler_);
sharing_fcm_handler_->OnMessage(kTestAppId, incoming_message);
// Tests OnMessage flow in SharingFCMHandler after registered handler is
// removed.
EXPECT_CALL(mock_sharing_message_handler_, OnMessage(_, _)).Times(0);
EXPECT_CALL(mock_sharing_fcm_sender_, SendMessageToFcmTarget(_, _, _, _))
.Times(0);
handler_registry_.SetSharingHandler(SharingMessage::kPingMessage, nullptr);
sharing_fcm_handler_->OnMessage(kTestAppId, incoming_message);
}
TEST_F(SharingFCMHandlerTest, PingMessageHandlerWithMessageIdInPayload) {
SharingMessage sharing_message;
sharing_message.set_sender_guid(kSenderGuid);
sharing_message.mutable_ping_message();
sharing_message.set_message_id(kTestMessageId);
SetupFcmChannel(sharing_message.mutable_fcm_channel_configuration());
gcm::IncomingMessage incoming_message =
CreateGCMIncomingMessage(std::string(), sharing_message);
SharingMessage sharing_ack_message;
sharing_ack_message.mutable_ack_message()->set_original_message_id(
kTestMessageId);
ON_CALL(mock_sharing_message_handler_,
OnMessage(ProtoEquals(sharing_message), _))
.WillByDefault(testing::Invoke(
[](const SharingMessage& message,
SharingMessageHandler::DoneCallback done_callback) {
std::move(done_callback).Run(/*response=*/nullptr);
}));
EXPECT_CALL(mock_sharing_message_handler_, OnMessage(_, _));
EXPECT_CALL(
mock_sharing_fcm_sender_,
SendMessageToFcmTarget(FCMChannelMatcher(), Eq(kSharingAckMessageTTL),
ProtoEquals(sharing_ack_message), _));
handler_registry_.SetSharingHandler(SharingMessage::kPingMessage,
&mock_sharing_message_handler_);
sharing_fcm_handler_->OnMessage(kTestAppId, incoming_message);
}
TEST_F(SharingFCMHandlerTest, PingMessageHandlerWithResponse) {
SharingMessage sharing_message;
sharing_message.set_sender_guid(kSenderGuid);
sharing_message.mutable_ping_message();
SetupFcmChannel(sharing_message.mutable_fcm_channel_configuration());
gcm::IncomingMessage incoming_message =
CreateGCMIncomingMessage(kTestMessageId, sharing_message);
SharingMessage sharing_ack_message;
sharing_ack_message.mutable_ack_message()->set_original_message_id(
kTestMessageId);
sharing_ack_message.mutable_ack_message()->mutable_response_message();
// Tests OnMessage flow in SharingFCMHandler after handler is added.
ON_CALL(mock_sharing_message_handler_,
OnMessage(ProtoEquals(sharing_message), _))
.WillByDefault(testing::Invoke(
[](const SharingMessage& message,
SharingMessageHandler::DoneCallback done_callback) {
std::move(done_callback)
.Run(std::make_unique<
components_sharing_message::ResponseMessage>());
}));
EXPECT_CALL(mock_sharing_message_handler_, OnMessage(_, _));
EXPECT_CALL(
mock_sharing_fcm_sender_,
SendMessageToFcmTarget(FCMChannelMatcher(), Eq(kSharingAckMessageTTL),
ProtoEquals(sharing_ack_message), _));
handler_registry_.SetSharingHandler(SharingMessage::kPingMessage,
&mock_sharing_message_handler_);
sharing_fcm_handler_->OnMessage(kTestAppId, incoming_message);
}
// Test for handling of SharingMessage payload other than AckMessage for
// secondary users in Android.
TEST_F(SharingFCMHandlerTest, PingMessageHandlerSecondaryUser) {
SharingMessage sharing_message;
sharing_message.set_sender_guid(kSenderGuid);
sharing_message.mutable_ping_message();
SetupFcmChannel(sharing_message.mutable_fcm_channel_configuration());
gcm::IncomingMessage incoming_message =
CreateGCMIncomingMessage(kTestMessageIdSecondaryUser, sharing_message);
SharingMessage sharing_ack_message;
sharing_ack_message.mutable_ack_message()->set_original_message_id(
kTestMessageId);
// Tests OnMessage flow in SharingFCMHandler after handler is added.
ON_CALL(mock_sharing_message_handler_,
OnMessage(ProtoEquals(sharing_message), _))
.WillByDefault(testing::Invoke(
[](const SharingMessage& message,
SharingMessageHandler::DoneCallback done_callback) {
std::move(done_callback).Run(/*response=*/nullptr);
}));
EXPECT_CALL(
mock_sharing_fcm_sender_,
SendMessageToFcmTarget(FCMChannelMatcher(), Eq(kSharingAckMessageTTL),
ProtoEquals(sharing_ack_message), _));
handler_registry_.SetSharingHandler(SharingMessage::kPingMessage,
&mock_sharing_message_handler_);
sharing_fcm_handler_->OnMessage(kTestAppId, incoming_message);
}
TEST_F(SharingFCMHandlerTest,
PingMessageHandlerWithServerChannelConfiguration) {
SharingMessage sharing_message;
sharing_message.mutable_ping_message();
components_sharing_message::ServerChannelConfiguration* server_configuration =
sharing_message.mutable_server_channel_configuration();
server_configuration->set_configuration(kServerConfiguration);
server_configuration->set_p256dh(kServerP256dh);
server_configuration->set_auth_secret(kServerAuthSecret);
gcm::IncomingMessage incoming_message =
CreateGCMIncomingMessage(kTestMessageId, sharing_message);
SharingMessage sharing_ack_message;
sharing_ack_message.mutable_ack_message()->set_original_message_id(
kTestMessageId);
ON_CALL(mock_sharing_message_handler_,
OnMessage(ProtoEquals(sharing_message), _))
.WillByDefault(testing::Invoke(
[](const SharingMessage& message,
SharingMessageHandler::DoneCallback done_callback) {
std::move(done_callback).Run(/*response=*/nullptr);
}));
EXPECT_CALL(mock_sharing_fcm_sender_,
SendMessageToServerTarget(ServerChannelMatcher(),
ProtoEquals(sharing_ack_message), _));
handler_registry_.SetSharingHandler(SharingMessage::kPingMessage,
&mock_sharing_message_handler_);
sharing_fcm_handler_->OnMessage(kTestAppId, incoming_message);
}
|