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 #define PW_LOG_MODULE_NAME "log module name!"
16
17 // Configure the module so that the test runs against known values.
18 #undef PW_LOG_TOKENIZED_LEVEL_BITS
19 #undef PW_LOG_TOKENIZED_MODULE_BITS
20 #undef PW_LOG_TOKENIZED_FLAG_BITS
21 #undef PW_LOG_TOKENIZED_LINE_BITS
22
23 #define PW_LOG_TOKENIZED_LEVEL_BITS 3
24 #define PW_LOG_TOKENIZED_MODULE_BITS 16
25 #define PW_LOG_TOKENIZED_FLAG_BITS 2
26 #define PW_LOG_TOKENIZED_LINE_BITS 11
27
28 #include "pw_log_tokenized/log_tokenized.h"
29
30 #include "pw_log_tokenized/base64.h"
31 #include "pw_log_tokenized_private/test_utils.h"
32 #include "pw_unit_test/framework.h"
33
34 namespace pw::log_tokenized {
35 namespace {
36
TEST(LogTokenized,FormatString)37 TEST(LogTokenized, FormatString) {
38 PW_LOG_TOKENIZED_TO_GLOBAL_HANDLER_WITH_PAYLOAD(
39 63, PW_LOG_MODULE_NAME, 1023, "hello %d", 1);
40 EXPECT_STREQ(last_log.format_string,
41 "■msg♦hello %d■module♦log module name!■file♦" __FILE__);
42 }
43
44 constexpr uintptr_t kModuleToken =
45 PW_TOKENIZER_STRING_TOKEN(PW_LOG_MODULE_NAME) &
46 ((1u << PW_LOG_TOKENIZED_MODULE_BITS) - 1);
47
TEST(LogTokenized,Base64)48 TEST(LogTokenized, Base64) {
49 constexpr uint8_t kBinary[6]{1, 2, 3, 4, 5, 6};
50 constexpr const char* kBase64Expected = "$AQIDBAUG"; // calculated in Python
51
52 InlineBasicString result_1 = PrefixedBase64Encode(as_bytes(span(kBinary)));
53 EXPECT_EQ(result_1, kBase64Expected);
54 EXPECT_EQ(result_1.capacity(), kBase64EncodedBufferSizeBytes);
55
56 InlineBasicString result_2 = PrefixedBase64Encode(kBinary, sizeof(kBinary));
57 EXPECT_EQ(result_2, kBase64Expected);
58
59 InlineBasicString result_3 = PrefixedBase64Encode(
60 reinterpret_cast<const std::byte*>(kBinary), sizeof(kBinary));
61 EXPECT_EQ(result_3, kBase64Expected);
62 }
63
TEST(LogTokenized,LogMetadata_LevelTooLarge_Clamps)64 TEST(LogTokenized, LogMetadata_LevelTooLarge_Clamps) {
65 auto check_metadata = [] {
66 Metadata metadata = Metadata(last_log.metadata);
67 EXPECT_EQ(metadata.level(), 7u);
68 EXPECT_EQ(metadata.flags(), 0u);
69 EXPECT_EQ(metadata.module(), kModuleToken);
70 EXPECT_EQ(metadata.line_number(), 1000u);
71 };
72
73 #line 1000
74 PW_LOG_TOKENIZED_TO_GLOBAL_HANDLER_WITH_PAYLOAD(8, PW_LOG_MODULE_NAME, 0, "");
75 check_metadata();
76
77 pw_log_tokenized_Test_LogMetadata_LevelTooLarge_Clamps();
78 check_metadata();
79 }
80
TEST(LogTokenized,LogMetadata_TooManyFlags_Truncates)81 TEST(LogTokenized, LogMetadata_TooManyFlags_Truncates) {
82 auto check_metadata = [] {
83 Metadata metadata = Metadata(last_log.metadata);
84 EXPECT_EQ(metadata.level(), 1u);
85 EXPECT_EQ(metadata.flags(), 0b11u);
86 EXPECT_EQ(metadata.module(), kModuleToken);
87 EXPECT_EQ(metadata.line_number(), 1100u);
88 };
89
90 // Keep statements on a single line, since GCC and Clang disagree about which
91 // line number to assign to multi-line macros.
92 // clang-format off
93 #line 1100
94 PW_LOG_TOKENIZED_TO_GLOBAL_HANDLER_WITH_PAYLOAD(1, PW_LOG_MODULE_NAME, 0xFFFFFFFF, "hello");
95 // clang-format on
96 check_metadata();
97
98 pw_log_tokenized_Test_LogMetadata_TooManyFlags_Truncates();
99 check_metadata();
100 }
101
TEST(LogTokenized,LogMetadata_VariousValues)102 TEST(LogTokenized, LogMetadata_VariousValues) {
103 auto check_metadata = [] {
104 Metadata metadata = Metadata(last_log.metadata);
105 EXPECT_EQ(metadata.level(), 6u);
106 EXPECT_EQ(metadata.flags(), 3u);
107 EXPECT_EQ(metadata.module(), kModuleToken);
108 EXPECT_EQ(last_log.arg_count, 1u);
109 EXPECT_EQ(metadata.line_number(), 1200u);
110 };
111
112 // clang-format off
113 #line 1200
114 PW_LOG_TOKENIZED_TO_GLOBAL_HANDLER_WITH_PAYLOAD(6, PW_LOG_MODULE_NAME, 3, "hello%s", "?");
115 // clang-format on
116 check_metadata();
117
118 pw_log_tokenized_Test_LogMetadata_LogMetadata_VariousValues();
119 check_metadata();
120 }
121
TEST(LogTokenized,LogMetadata_Zero)122 TEST(LogTokenized, LogMetadata_Zero) {
123 auto check_metadata = [] {
124 Metadata metadata = Metadata(last_log.metadata);
125 EXPECT_EQ(metadata.level(), 0u);
126 EXPECT_EQ(metadata.flags(), 0u);
127 EXPECT_EQ(metadata.module(), kModuleToken);
128 EXPECT_EQ(last_log.arg_count, 0u);
129 EXPECT_EQ(metadata.line_number(), 1300u);
130 };
131
132 #line 1300
133 PW_LOG_TOKENIZED_TO_GLOBAL_HANDLER_WITH_PAYLOAD(0, PW_LOG_MODULE_NAME, 0, "");
134 check_metadata();
135
136 pw_log_tokenized_Test_LogMetadata_LogMetadata_Zero();
137 check_metadata();
138 }
139
TEST(LogTokenized,LogMetadata_MaxValues)140 TEST(LogTokenized, LogMetadata_MaxValues) {
141 #line 2047
142 PW_LOG_TOKENIZED_TO_GLOBAL_HANDLER_WITH_PAYLOAD(7, "name", 3, "hello %d", 1);
143
144 Metadata metadata = Metadata(last_log.metadata);
145 EXPECT_EQ(metadata.line_number(), 2047u);
146 EXPECT_EQ(metadata.level(), 7u);
147 EXPECT_EQ(metadata.flags(), 3u);
148 EXPECT_EQ(metadata.module(),
149 PW_TOKENIZER_STRING_TOKEN("name") &
150 ((1u << PW_LOG_TOKENIZED_MODULE_BITS) - 1));
151 EXPECT_EQ(last_log.arg_count, 1u);
152 }
153
TEST(LogTokenized,LogMetadata_LineNumberTooLarge_IsZero)154 TEST(LogTokenized, LogMetadata_LineNumberTooLarge_IsZero) {
155 #line 2048 // At 11 bits, the largest representable line is 2047
156 PW_LOG_TOKENIZED_TO_GLOBAL_HANDLER_WITH_PAYLOAD(
157 7, PW_LOG_MODULE_NAME, 3, "hello %d", 1);
158 EXPECT_EQ(Metadata(last_log.metadata).line_number(), 0u);
159
160 #line 2049
161 PW_LOG_TOKENIZED_TO_GLOBAL_HANDLER_WITH_PAYLOAD(
162 7, PW_LOG_MODULE_NAME, 3, "hello %d", 1);
163 EXPECT_EQ(Metadata(last_log.metadata).line_number(), 0u);
164
165 #line 99999
166 PW_LOG_TOKENIZED_TO_GLOBAL_HANDLER_WITH_PAYLOAD(
167 7, PW_LOG_MODULE_NAME, 3, "hello %d", 1);
168 EXPECT_EQ(Metadata(last_log.metadata).line_number(), 0u);
169 }
170
171 } // namespace
172 } // namespace pw::log_tokenized
173