1 // Copyright 2021 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_bytes/array.h"
16 #include "pw_protobuf/encoder.h"
17 #include "pw_protobuf_test_protos/full_test.pwpb.h"
18 #include "pw_status/status.h"
19 #include "pw_unit_test/framework.h"
20
21 namespace pw::protobuf {
22 namespace {
23
TEST(Encoder,SizeTypeIsConfigured)24 TEST(Encoder, SizeTypeIsConfigured) {
25 static_assert(config::kMaxVarintSize == sizeof(uint8_t));
26 }
27
TEST(Encoder,NestedWriteSmallerThanVarintSize)28 TEST(Encoder, NestedWriteSmallerThanVarintSize) {
29 std::array<std::byte, 256> buffer;
30
31 MemoryEncoder encoder(buffer);
32
33 {
34 // Overhead of 1 byte key + 1 byte size for the nested message itself.
35 StreamEncoder nested = encoder.GetNestedEncoder(1);
36 EXPECT_EQ(nested.ConservativeWriteLimit(), 125u);
37 // 1 byte key + 1 byte size + 123 byte value = 125 byte nested length.
38 EXPECT_EQ(nested.WriteBytes(2, bytes::Initialized<123>(0xaa)), OkStatus());
39 }
40
41 EXPECT_EQ(encoder.status(), OkStatus());
42 }
43
TEST(Encoder,NestedWriteLargerThanVarintSizeReturnsResourceExhausted)44 TEST(Encoder, NestedWriteLargerThanVarintSizeReturnsResourceExhausted) {
45 std::array<std::byte, 256> buffer;
46
47 MemoryEncoder encoder(buffer);
48
49 {
50 // Try to write a larger nested message than the max nested varint value.
51 // Overhead of 1 byte key + 1 byte size for the nested message itself.
52 StreamEncoder nested = encoder.GetNestedEncoder(1);
53 EXPECT_EQ(nested.ConservativeWriteLimit(), 125u);
54 // 1 byte key + 1 byte size + 124 byte value = 126 byte nested length.
55 EXPECT_EQ(nested.WriteBytes(2, bytes::Initialized<124>(0xaa)),
56 Status::ResourceExhausted());
57 EXPECT_EQ(nested.WriteUint32(3, 42), Status::ResourceExhausted());
58 }
59
60 EXPECT_EQ(encoder.status(), Status::ResourceExhausted());
61 }
62
TEST(Encoder,NestedMessageLargerThanVarintSizeReturnsResourceExhausted)63 TEST(Encoder, NestedMessageLargerThanVarintSizeReturnsResourceExhausted) {
64 std::array<std::byte, 256> buffer;
65
66 MemoryEncoder encoder(buffer);
67
68 {
69 // Try to write a larger nested message than the max nested varint value as
70 // multiple smaller writes.
71 StreamEncoder nested = encoder.GetNestedEncoder(1);
72 EXPECT_EQ(nested.WriteBytes(2, bytes::Initialized<60>(0xaa)), OkStatus());
73 EXPECT_EQ(nested.WriteBytes(3, bytes::Initialized<60>(0xaa)), OkStatus());
74 EXPECT_EQ(nested.WriteBytes(4, bytes::Initialized<60>(0xaa)),
75 Status::ResourceExhausted());
76 }
77
78 EXPECT_EQ(encoder.status(), Status::ResourceExhausted());
79 }
80
TEST(Encoder,MessageWrite_NestedMessageLargerThanVarintSize)81 TEST(Encoder, MessageWrite_NestedMessageLargerThanVarintSize) {
82 std::array<std::byte, 256> buffer;
83 test::pwpb::LargeNestedTest::MemoryEncoder encoder(buffer);
84
85 test::pwpb::LargeNestedTest::Message message = {};
86
87 message.large_nested.data.SetEncoder(
88 [](test::pwpb::LargeNestedTest::LargeNested::StreamEncoder&
89 large_nested_encoder) {
90 // 1 byte key + 1 byte size + 126 byte value = 128 byte nested length.
91 Status status =
92 large_nested_encoder.WriteData(bytes::Initialized<126>(0xaa));
93 EXPECT_EQ(status, Status::ResourceExhausted());
94 return status;
95 });
96
97 EXPECT_EQ(encoder.Write(message), Status::ResourceExhausted());
98 }
99
100 } // namespace
101 } // namespace pw::protobuf
102