xref: /aosp_15_r20/external/pigweed/pw_log_rpc/pw_log_rpc_private/test_utils.h (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1 // Copyright 2022 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 #pragma once
15 
16 #include <cstdint>
17 
18 #include "pw_bytes/span.h"
19 #include "pw_containers/vector.h"
20 #include "pw_log_tokenized/metadata.h"
21 #include "pw_protobuf/decoder.h"
22 
23 namespace pw::log_rpc {
24 
25 struct TestLogEntry {
26   log_tokenized::Metadata metadata;
27   int64_t timestamp = 0;
28   uint32_t dropped = 0;
29   ConstByteSpan tokenized_data = {};
30   ConstByteSpan file = {};
31   ConstByteSpan thread = {};
32 };
33 
34 // Unpacks a `LogEntry` proto buffer to compare it with the expected data and
35 // updates the total drop count found.
36 void VerifyLogEntry(protobuf::Decoder& entry_decoder,
37                     const TestLogEntry& expected_entry,
38                     uint32_t& drop_count_out);
39 
40 // Verifies a stream of log entries and updates the total entry and drop counts.
41 void VerifyLogEntries(protobuf::Decoder& entries_decoder,
42                       const Vector<TestLogEntry>& expected_entries,
43                       uint32_t expected_first_entry_sequence_id,
44                       size_t& entries_count_out,
45                       uint32_t& drop_count_out);
46 
47 size_t CountLogEntries(protobuf::Decoder& entries_decoder);
48 
49 }  // namespace pw::log_rpc
50