1 // Copyright 2020 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #include "cast/streaming/rpc_messenger.h"
6
7 #include <memory>
8 #include <string>
9 #include <utility>
10 #include <vector>
11
12 #include "cast/streaming/remoting.pb.h"
13 #include "gmock/gmock.h"
14 #include "gtest/gtest.h"
15
16 using testing::_;
17 using testing::Invoke;
18 using testing::Return;
19
20 namespace openscreen {
21 namespace cast {
22 namespace {
23
24 class FakeMessenger {
25 public:
OnReceivedRpc(std::unique_ptr<RpcMessage> message)26 void OnReceivedRpc(std::unique_ptr<RpcMessage> message) {
27 received_rpc_ = std::move(message);
28 received_count_++;
29 }
30
OnSentRpc(const std::vector<uint8_t> & message)31 void OnSentRpc(const std::vector<uint8_t>& message) {
32 EXPECT_TRUE(sent_rpc_.ParseFromArray(message.data(), message.size()));
33 sent_count_++;
34 }
35
received_count() const36 int received_count() const { return received_count_; }
received_rpc() const37 const RpcMessage& received_rpc() const { return *received_rpc_; }
38
sent_count() const39 int sent_count() const { return sent_count_; }
sent_rpc() const40 const RpcMessage& sent_rpc() const { return sent_rpc_; }
41
set_handle(RpcMessenger::Handle handle)42 void set_handle(RpcMessenger::Handle handle) { handle_ = handle; }
handle()43 RpcMessenger::Handle handle() { return handle_; }
44
45 private:
46 std::unique_ptr<RpcMessage> received_rpc_;
47 int received_count_ = 0;
48
49 RpcMessage sent_rpc_;
50 int sent_count_ = 0;
51
52 RpcMessenger::Handle handle_ = -1;
53 };
54
55 } // namespace
56
57 class RpcMessengerTest : public testing::Test {
58 protected:
SetUp()59 void SetUp() override {
60 fake_messenger_ = std::make_unique<FakeMessenger>();
61 ASSERT_FALSE(fake_messenger_->received_count());
62
63 rpc_messenger_ = std::make_unique<RpcMessenger>(
64 [p = fake_messenger_.get()](std::vector<uint8_t> message) {
65 p->OnSentRpc(message);
66 });
67
68 const auto handle = rpc_messenger_->GetUniqueHandle();
69 fake_messenger_->set_handle(handle);
70 rpc_messenger_->RegisterMessageReceiverCallback(
71 handle,
72 [p = fake_messenger_.get()](std::unique_ptr<RpcMessage> message) {
73 p->OnReceivedRpc(std::move(message));
74 });
75 }
76
ProcessMessage(const RpcMessage & rpc)77 void ProcessMessage(const RpcMessage& rpc) {
78 std::vector<uint8_t> message(rpc.ByteSizeLong());
79 rpc.SerializeToArray(message.data(), message.size());
80 rpc_messenger_->ProcessMessageFromRemote(message.data(), message.size());
81 }
82
83 std::unique_ptr<FakeMessenger> fake_messenger_;
84 std::unique_ptr<RpcMessenger> rpc_messenger_;
85 };
86
TEST_F(RpcMessengerTest,TestProcessMessageFromRemoteRegistered)87 TEST_F(RpcMessengerTest, TestProcessMessageFromRemoteRegistered) {
88 RpcMessage rpc;
89 rpc.set_handle(fake_messenger_->handle());
90 ProcessMessage(rpc);
91 ASSERT_EQ(1, fake_messenger_->received_count());
92 }
93
TEST_F(RpcMessengerTest,TestProcessMessageFromRemoteUnregistered)94 TEST_F(RpcMessengerTest, TestProcessMessageFromRemoteUnregistered) {
95 RpcMessage rpc;
96 rpc_messenger_->UnregisterMessageReceiverCallback(fake_messenger_->handle());
97 ProcessMessage(rpc);
98 ASSERT_EQ(0, fake_messenger_->received_count());
99 }
100
TEST_F(RpcMessengerTest,CanSendMultipleMessages)101 TEST_F(RpcMessengerTest, CanSendMultipleMessages) {
102 for (int i = 0; i < 10; ++i) {
103 rpc_messenger_->SendMessageToRemote(RpcMessage{});
104 }
105 EXPECT_EQ(10, fake_messenger_->sent_count());
106 }
107
TEST_F(RpcMessengerTest,SendMessageCallback)108 TEST_F(RpcMessengerTest, SendMessageCallback) {
109 // Send message for RPC messenger to process.
110 RpcMessage sent_rpc;
111 sent_rpc.set_handle(fake_messenger_->handle());
112 sent_rpc.set_proc(RpcMessage::RPC_R_SETVOLUME);
113 sent_rpc.set_double_value(2.3);
114 rpc_messenger_->SendMessageToRemote(sent_rpc);
115
116 // Check if received message is identical to the one sent earlier.
117 ASSERT_EQ(1, fake_messenger_->sent_count());
118 const RpcMessage& message = fake_messenger_->sent_rpc();
119 ASSERT_EQ(fake_messenger_->handle(), message.handle());
120 ASSERT_EQ(RpcMessage::RPC_R_SETVOLUME, message.proc());
121 ASSERT_EQ(2.3, message.double_value());
122 }
123
TEST_F(RpcMessengerTest,ProcessMessageWithRegisteredHandle)124 TEST_F(RpcMessengerTest, ProcessMessageWithRegisteredHandle) {
125 // Send message for RPC messenger to process.
126 RpcMessage sent_rpc;
127 sent_rpc.set_handle(fake_messenger_->handle());
128 sent_rpc.set_proc(RpcMessage::RPC_DS_INITIALIZE);
129 sent_rpc.set_integer_value(4004);
130 ProcessMessage(sent_rpc);
131
132 // Checks if received message is identical to the one sent earlier.
133 ASSERT_EQ(1, fake_messenger_->received_count());
134 const RpcMessage& received_rpc = fake_messenger_->received_rpc();
135 ASSERT_EQ(fake_messenger_->handle(), received_rpc.handle());
136 ASSERT_EQ(RpcMessage::RPC_DS_INITIALIZE, received_rpc.proc());
137 ASSERT_EQ(4004, received_rpc.integer_value());
138 }
139
TEST_F(RpcMessengerTest,ProcessMessageWithUnregisteredHandle)140 TEST_F(RpcMessengerTest, ProcessMessageWithUnregisteredHandle) {
141 // Send message for RPC messenger to process.
142 RpcMessage sent_rpc;
143 RpcMessenger::Handle different_handle = fake_messenger_->handle() + 1;
144 sent_rpc.set_handle(different_handle);
145 sent_rpc.set_proc(RpcMessage::RPC_R_SETVOLUME);
146 sent_rpc.set_double_value(4.5);
147 ProcessMessage(sent_rpc);
148
149 // We shouldn't have gotten the message since the handle is different.
150 ASSERT_EQ(0, fake_messenger_->received_count());
151 }
152
TEST_F(RpcMessengerTest,Registration)153 TEST_F(RpcMessengerTest, Registration) {
154 const auto handle = fake_messenger_->handle();
155 ASSERT_TRUE(rpc_messenger_->IsRegisteredForTesting(handle));
156
157 rpc_messenger_->UnregisterMessageReceiverCallback(handle);
158 ASSERT_FALSE(rpc_messenger_->IsRegisteredForTesting(handle));
159 }
160
161 } // namespace cast
162 } // namespace openscreen
163