1 // Copyright 2020 The Pigweed Authors
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not
4 // use this file except in compliance with the License. You may obtain a copy of
5 // the License at
6 //
7 // https://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 // License for the specific language governing permissions and limitations under
13 // the License.
14
15 #include "pw_rpc/channel.h"
16
17 #include "gtest/gtest.h"
18 #include "pw_rpc/internal/packet.h"
19 #include "pw_rpc_private/internal_test_utils.h"
20
21 namespace pw::rpc::internal {
22 namespace {
23
24 using std::byte;
25
TEST(ChannelOutput,Name)26 TEST(ChannelOutput, Name) {
27 class NameTester : public ChannelOutput {
28 public:
29 NameTester(const char* name) : ChannelOutput(name) {}
30 std::span<std::byte> AcquireBuffer() override { return {}; }
31 Status SendAndReleaseBuffer(std::span<const std::byte>) override {
32 return OkStatus();
33 }
34 };
35
36 EXPECT_STREQ("hello_world", NameTester("hello_world").name());
37 EXPECT_EQ(nullptr, NameTester(nullptr).name());
38 }
39
40 constexpr Packet kTestPacket(PacketType::RESPONSE, 1, 42, 100);
41 const size_t kReservedSize = 2 /* type */ + 2 /* channel */ + 5 /* service */ +
42 5 /* method */ + 2 /* payload key */ +
43 2 /* status */;
44
45 enum class ChannelId {
46 kOne = 1,
47 kTwo = 2,
48 };
49
TEST(Channel,Create_FromEnum)50 TEST(Channel, Create_FromEnum) {
51 constexpr rpc::Channel one = Channel::Create<ChannelId::kOne>(nullptr);
52 constexpr rpc::Channel two = Channel::Create<ChannelId::kTwo>(nullptr);
53 static_assert(one.id() == 1);
54 static_assert(two.id() == 2);
55 }
56
TEST(Channel,TestPacket_ReservedSizeMatchesMinEncodedSizeBytes)57 TEST(Channel, TestPacket_ReservedSizeMatchesMinEncodedSizeBytes) {
58 EXPECT_EQ(kReservedSize, kTestPacket.MinEncodedSizeBytes());
59 }
60
TEST(Channel,OutputBuffer_EmptyBuffer)61 TEST(Channel, OutputBuffer_EmptyBuffer) {
62 TestOutput<0> output;
63 internal::Channel channel(100, &output);
64
65 Channel::OutputBuffer buffer = channel.AcquireBuffer();
66 EXPECT_TRUE(buffer.payload(kTestPacket).empty());
67 }
68
TEST(Channel,OutputBuffer_TooSmall)69 TEST(Channel, OutputBuffer_TooSmall) {
70 TestOutput<kReservedSize - 1> output;
71 internal::Channel channel(100, &output);
72
73 Channel::OutputBuffer output_buffer = channel.AcquireBuffer();
74 EXPECT_TRUE(output_buffer.payload(kTestPacket).empty());
75
76 EXPECT_EQ(Status::Internal(), channel.Send(output_buffer, kTestPacket));
77 }
78
TEST(Channel,OutputBuffer_ExactFit)79 TEST(Channel, OutputBuffer_ExactFit) {
80 TestOutput<kReservedSize> output;
81 internal::Channel channel(100, &output);
82
83 Channel::OutputBuffer output_buffer(channel.AcquireBuffer());
84 const std::span payload = output_buffer.payload(kTestPacket);
85
86 EXPECT_EQ(payload.size(), output.buffer().size() - kReservedSize);
87 EXPECT_EQ(output.buffer().data() + kReservedSize, payload.data());
88
89 EXPECT_EQ(OkStatus(), channel.Send(output_buffer, kTestPacket));
90 }
91
TEST(Channel,OutputBuffer_PayloadDoesNotFit_ReportsError)92 TEST(Channel, OutputBuffer_PayloadDoesNotFit_ReportsError) {
93 TestOutput<kReservedSize> output;
94 internal::Channel channel(100, &output);
95
96 Packet packet = kTestPacket;
97 byte data[1] = {};
98 packet.set_payload(data);
99
100 EXPECT_EQ(Status::Internal(), channel.Send(packet));
101 }
102
TEST(Channel,OutputBuffer_ExtraRoom)103 TEST(Channel, OutputBuffer_ExtraRoom) {
104 TestOutput<kReservedSize * 3> output;
105 internal::Channel channel(100, &output);
106
107 Channel::OutputBuffer output_buffer = channel.AcquireBuffer();
108 const std::span payload = output_buffer.payload(kTestPacket);
109
110 EXPECT_EQ(payload.size(), output.buffer().size() - kReservedSize);
111 EXPECT_EQ(output.buffer().data() + kReservedSize, payload.data());
112
113 EXPECT_EQ(OkStatus(), channel.Send(output_buffer, kTestPacket));
114 }
115
TEST(Channel,OutputBuffer_ReturnsStatusFromChannelOutputSend)116 TEST(Channel, OutputBuffer_ReturnsStatusFromChannelOutputSend) {
117 TestOutput<kReservedSize * 3> output;
118 internal::Channel channel(100, &output);
119
120 Channel::OutputBuffer output_buffer = channel.AcquireBuffer();
121 output.set_send_status(Status::Aborted());
122
123 EXPECT_EQ(Status::Aborted(), channel.Send(output_buffer, kTestPacket));
124 }
125
126 } // namespace
127 } // namespace pw::rpc::internal
128