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
|
// Copyright 2021 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.
#define PW_LOG_MODULE_NAME "log module name!"
// Configure the module so that the test runs against known values.
#undef PW_LOG_TOKENIZED_LEVEL_BITS
#undef PW_LOG_TOKENIZED_MODULE_BITS
#undef PW_LOG_TOKENIZED_FLAG_BITS
#undef PW_LOG_TOKENIZED_LINE_BITS
#define PW_LOG_TOKENIZED_LEVEL_BITS 3
#define PW_LOG_TOKENIZED_MODULE_BITS 16
#define PW_LOG_TOKENIZED_FLAG_BITS 2
#define PW_LOG_TOKENIZED_LINE_BITS 11
#include "pw_log_tokenized/log_tokenized.h"
#include "gtest/gtest.h"
#include "pw_log_tokenized/base64.h"
#include "pw_log_tokenized_private/test_utils.h"
namespace pw::log_tokenized {
namespace {
TEST(LogTokenized, FormatString) {
PW_LOG_TOKENIZED_TO_GLOBAL_HANDLER_WITH_PAYLOAD(
63, PW_LOG_MODULE_NAME, 1023, "hello %d", 1);
EXPECT_STREQ(last_log.format_string,
"■msg♦hello %d■module♦log module name!■file♦" __FILE__);
}
constexpr uintptr_t kModuleToken =
PW_TOKENIZER_STRING_TOKEN(PW_LOG_MODULE_NAME) &
((1u << PW_LOG_TOKENIZED_MODULE_BITS) - 1);
TEST(LogTokenized, Base64) {
constexpr uint8_t kBinary[6]{1, 2, 3, 4, 5, 6};
constexpr const char* kBase64Expected = "$AQIDBAUG"; // calculated in Python
InlineBasicString result_1 = PrefixedBase64Encode(as_bytes(span(kBinary)));
EXPECT_EQ(result_1, kBase64Expected);
EXPECT_EQ(result_1.capacity(), kBase64EncodedBufferSizeBytes);
InlineBasicString result_2 = PrefixedBase64Encode(kBinary, sizeof(kBinary));
EXPECT_EQ(result_2, kBase64Expected);
InlineBasicString result_3 = PrefixedBase64Encode(
reinterpret_cast<const std::byte*>(kBinary), sizeof(kBinary));
EXPECT_EQ(result_3, kBase64Expected);
}
TEST(LogTokenized, LogMetadata_LevelTooLarge_Clamps) {
auto check_metadata = [] {
Metadata metadata = Metadata(last_log.metadata);
EXPECT_EQ(metadata.level(), 7u);
EXPECT_EQ(metadata.flags(), 0u);
EXPECT_EQ(metadata.module(), kModuleToken);
EXPECT_EQ(metadata.line_number(), 1000u);
};
#line 1000
PW_LOG_TOKENIZED_TO_GLOBAL_HANDLER_WITH_PAYLOAD(8, PW_LOG_MODULE_NAME, 0, "");
check_metadata();
pw_log_tokenized_Test_LogMetadata_LevelTooLarge_Clamps();
check_metadata();
}
TEST(LogTokenized, LogMetadata_TooManyFlags_Truncates) {
auto check_metadata = [] {
Metadata metadata = Metadata(last_log.metadata);
EXPECT_EQ(metadata.level(), 1u);
EXPECT_EQ(metadata.flags(), 0b11u);
EXPECT_EQ(metadata.module(), kModuleToken);
EXPECT_EQ(metadata.line_number(), 1100u);
};
// Keep statements on a single line, since GCC and Clang disagree about which
// line number to assign to multi-line macros.
// clang-format off
#line 1100
PW_LOG_TOKENIZED_TO_GLOBAL_HANDLER_WITH_PAYLOAD(1, PW_LOG_MODULE_NAME, 0xFFFFFFFF, "hello");
// clang-format on
check_metadata();
pw_log_tokenized_Test_LogMetadata_TooManyFlags_Truncates();
check_metadata();
}
TEST(LogTokenized, LogMetadata_VariousValues) {
auto check_metadata = [] {
Metadata metadata = Metadata(last_log.metadata);
EXPECT_EQ(metadata.level(), 6u);
EXPECT_EQ(metadata.flags(), 3u);
EXPECT_EQ(metadata.module(), kModuleToken);
EXPECT_EQ(last_log.arg_count, 1u);
EXPECT_EQ(metadata.line_number(), 1200u);
};
// clang-format off
#line 1200
PW_LOG_TOKENIZED_TO_GLOBAL_HANDLER_WITH_PAYLOAD(6, PW_LOG_MODULE_NAME, 3, "hello%s", "?");
// clang-format on
check_metadata();
pw_log_tokenized_Test_LogMetadata_LogMetadata_VariousValues();
check_metadata();
}
TEST(LogTokenized, LogMetadata_Zero) {
auto check_metadata = [] {
Metadata metadata = Metadata(last_log.metadata);
EXPECT_EQ(metadata.level(), 0u);
EXPECT_EQ(metadata.flags(), 0u);
EXPECT_EQ(metadata.module(), kModuleToken);
EXPECT_EQ(last_log.arg_count, 0u);
EXPECT_EQ(metadata.line_number(), 1300u);
};
#line 1300
PW_LOG_TOKENIZED_TO_GLOBAL_HANDLER_WITH_PAYLOAD(0, PW_LOG_MODULE_NAME, 0, "");
check_metadata();
pw_log_tokenized_Test_LogMetadata_LogMetadata_Zero();
check_metadata();
}
TEST(LogTokenized, LogMetadata_MaxValues) {
#line 2047
PW_LOG_TOKENIZED_TO_GLOBAL_HANDLER_WITH_PAYLOAD(7, "name", 3, "hello %d", 1);
Metadata metadata = Metadata(last_log.metadata);
EXPECT_EQ(metadata.line_number(), 2047u);
EXPECT_EQ(metadata.level(), 7u);
EXPECT_EQ(metadata.flags(), 3u);
EXPECT_EQ(metadata.module(),
PW_TOKENIZER_STRING_TOKEN("name") &
((1u << PW_LOG_TOKENIZED_MODULE_BITS) - 1));
EXPECT_EQ(last_log.arg_count, 1u);
}
TEST(LogTokenized, LogMetadata_LineNumberTooLarge_IsZero) {
#line 2048 // At 11 bits, the largest representable line is 2047
PW_LOG_TOKENIZED_TO_GLOBAL_HANDLER_WITH_PAYLOAD(
7, PW_LOG_MODULE_NAME, 3, "hello %d", 1);
EXPECT_EQ(Metadata(last_log.metadata).line_number(), 0u);
#line 2049
PW_LOG_TOKENIZED_TO_GLOBAL_HANDLER_WITH_PAYLOAD(
7, PW_LOG_MODULE_NAME, 3, "hello %d", 1);
EXPECT_EQ(Metadata(last_log.metadata).line_number(), 0u);
#line 99999
PW_LOG_TOKENIZED_TO_GLOBAL_HANDLER_WITH_PAYLOAD(
7, PW_LOG_MODULE_NAME, 3, "hello %d", 1);
EXPECT_EQ(Metadata(last_log.metadata).line_number(), 0u);
}
} // namespace
} // namespace pw::log_tokenized
|
