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
|
// Copyright 2020 The Pigweed Authors
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
#include "pw_log_rpc/log_queue.h"
#include "gtest/gtest.h"
#include "pw_log/levels.h"
#include "pw_log_proto/log.pwpb.h"
#include "pw_protobuf/decoder.h"
namespace pw::log_rpc {
namespace {
constexpr size_t kEncodeBufferSize = 512;
constexpr const char kTokenizedMessage[] = "msg_token";
constexpr uint32_t kFlags = 0xF;
constexpr uint32_t kLevel = 0b010;
constexpr uint32_t kLine = 0b101011000;
constexpr uint32_t kTokenizedThread = 0xF;
constexpr int64_t kTimestamp = 0;
constexpr size_t kLogBufferSize = kEncodeBufferSize * 3;
void VerifyLogEntry(pw::protobuf::Decoder& log_decoder,
const char* expected_tokenized_message,
const uint32_t expected_flags,
const uint32_t expected_level,
const uint32_t expected_line,
const uint32_t expected_tokenized_thread,
const int64_t expected_timestamp) {
ConstByteSpan log_entry_message;
EXPECT_TRUE(log_decoder.Next().ok()); // preamble
EXPECT_EQ(1U, log_decoder.FieldNumber());
EXPECT_TRUE(log_decoder.ReadBytes(&log_entry_message).ok());
pw::protobuf::Decoder entry_decoder(log_entry_message);
ConstByteSpan tokenized_message;
EXPECT_TRUE(entry_decoder.Next().ok()); // tokenized_message
EXPECT_EQ(1U, entry_decoder.FieldNumber());
EXPECT_TRUE(entry_decoder.ReadBytes(&tokenized_message).ok());
EXPECT_TRUE(std::memcmp(tokenized_message.begin(),
(const void*)expected_tokenized_message,
tokenized_message.size()) == 0);
uint32_t line_level;
EXPECT_TRUE(entry_decoder.Next().ok()); // line_level
EXPECT_EQ(2U, entry_decoder.FieldNumber());
EXPECT_TRUE(entry_decoder.ReadUint32(&line_level).ok());
EXPECT_EQ(expected_level, line_level & PW_LOG_LEVEL_BITMASK);
EXPECT_EQ(expected_line,
(line_level & ~PW_LOG_LEVEL_BITMASK) >> PW_LOG_LEVEL_BITWIDTH);
uint32_t flags;
EXPECT_TRUE(entry_decoder.Next().ok()); // flags
EXPECT_EQ(3U, entry_decoder.FieldNumber());
EXPECT_TRUE(entry_decoder.ReadUint32(&flags).ok());
EXPECT_EQ(expected_flags, flags);
uint32_t tokenized_thread;
EXPECT_TRUE(entry_decoder.Next().ok()); // tokenized_thread
EXPECT_EQ(4U, entry_decoder.FieldNumber());
EXPECT_TRUE(entry_decoder.ReadUint32(&tokenized_thread).ok());
EXPECT_EQ(expected_tokenized_thread, tokenized_thread);
int64_t timestamp;
EXPECT_TRUE(entry_decoder.Next().ok()); // timestamp
EXPECT_EQ(5U, entry_decoder.FieldNumber());
EXPECT_TRUE(entry_decoder.ReadInt64(×tamp).ok());
EXPECT_EQ(expected_timestamp, timestamp);
}
} // namespace
TEST(LogQueue, SinglePushPopTokenizedMessage) {
std::byte log_buffer[kLogBufferSize];
LogQueueWithEncodeBuffer<kEncodeBufferSize> log_queue(log_buffer);
EXPECT_EQ(Status::OK,
log_queue.PushTokenizedMessage(
std::as_bytes(std::span(kTokenizedMessage)),
kFlags,
kLevel,
kLine,
kTokenizedThread,
kTimestamp));
std::byte log_entry[kEncodeBufferSize];
Result<LogEntries> pop_result = log_queue.Pop(std::span(log_entry));
EXPECT_TRUE(pop_result.ok());
pw::protobuf::Decoder log_decoder(pop_result.value().entries);
EXPECT_EQ(pop_result.value().entry_count, 1U);
VerifyLogEntry(log_decoder,
kTokenizedMessage,
kFlags,
kLevel,
kLine,
kTokenizedThread,
kTimestamp);
}
TEST(LogQueue, MultiplePushPopTokenizedMessage) {
constexpr size_t kEntryCount = 3;
std::byte log_buffer[1024];
LogQueueWithEncodeBuffer<kEncodeBufferSize> log_queue(log_buffer);
for (size_t i = 0; i < kEntryCount; i++) {
EXPECT_EQ(Status::OK,
log_queue.PushTokenizedMessage(
std::as_bytes(std::span(kTokenizedMessage)),
kFlags,
kLevel,
kLine + (i << 3),
kTokenizedThread,
kTimestamp + i));
}
std::byte log_entry[kEncodeBufferSize];
for (size_t i = 0; i < kEntryCount; i++) {
Result<LogEntries> pop_result = log_queue.Pop(std::span(log_entry));
EXPECT_TRUE(pop_result.ok());
pw::protobuf::Decoder log_decoder(pop_result.value().entries);
EXPECT_EQ(pop_result.value().entry_count, 1U);
VerifyLogEntry(log_decoder,
kTokenizedMessage,
kFlags,
kLevel,
kLine + (i << 3),
kTokenizedThread,
kTimestamp + i);
}
}
TEST(LogQueue, PopMultiple) {
constexpr size_t kEntryCount = 3;
std::byte log_buffer[kLogBufferSize];
LogQueueWithEncodeBuffer<kEncodeBufferSize> log_queue(log_buffer);
for (size_t i = 0; i < kEntryCount; i++) {
EXPECT_EQ(Status::OK,
log_queue.PushTokenizedMessage(
std::as_bytes(std::span(kTokenizedMessage)),
kFlags,
kLevel,
kLine + (i << 3),
kTokenizedThread,
kTimestamp + i));
}
std::byte log_entries[kLogBufferSize];
Result<LogEntries> pop_result = log_queue.PopMultiple(log_entries);
EXPECT_TRUE(pop_result.ok());
pw::protobuf::Decoder log_decoder(pop_result.value().entries);
EXPECT_EQ(pop_result.value().entry_count, kEntryCount);
for (size_t i = 0; i < kEntryCount; i++) {
VerifyLogEntry(log_decoder,
kTokenizedMessage,
kFlags,
kLevel,
kLine + (i << 3),
kTokenizedThread,
kTimestamp + i);
}
}
TEST(LogQueue, TooSmallEncodeBuffer) {
constexpr size_t kSmallBuffer = 1;
std::byte log_buffer[kLogBufferSize];
LogQueueWithEncodeBuffer<kSmallBuffer> log_queue(log_buffer);
EXPECT_EQ(Status::INTERNAL,
log_queue.PushTokenizedMessage(
std::as_bytes(std::span(kTokenizedMessage)),
kFlags,
kLevel,
kLine,
kTokenizedThread,
kTimestamp));
}
TEST(LogQueue, TooSmallLogBuffer) {
constexpr size_t kSmallerThanPreamble = 1;
constexpr size_t kEntryCount = 100;
// Expect OUT_OF_RANGE when the buffer is smaller than a preamble.
std::byte log_buffer[kLogBufferSize];
LogQueueWithEncodeBuffer<kEncodeBufferSize> log_queue_small(
std::span(log_buffer, kSmallerThanPreamble));
EXPECT_EQ(Status::OUT_OF_RANGE,
log_queue_small.PushTokenizedMessage(
std::as_bytes(std::span(kTokenizedMessage)),
kFlags,
kLevel,
kLine,
kTokenizedThread,
kTimestamp));
// Expect RESOURCE_EXHAUSTED when there's not enough space for the chunk.
LogQueueWithEncodeBuffer<kEncodeBufferSize> log_queue_medium(log_buffer);
for (size_t i = 0; i < kEntryCount; i++) {
log_queue_medium.PushTokenizedMessage(
std::as_bytes(std::span(kTokenizedMessage)),
kFlags,
kLevel,
kLine,
kTokenizedThread,
kTimestamp);
}
EXPECT_EQ(Status::RESOURCE_EXHAUSTED,
log_queue_medium.PushTokenizedMessage(
std::as_bytes(std::span(kTokenizedMessage)),
kFlags,
kLevel,
kLine,
kTokenizedThread,
kTimestamp));
}
} // namespace pw::log_rpc
|
