1 // Copyright 2018 The Abseil Authors.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of 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,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 #include "absl/base/log_severity.h"
16
17 #include <cstdint>
18 #include <ios>
19 #include <limits>
20 #include <ostream>
21 #include <sstream>
22 #include <string>
23 #include <tuple>
24
25 #include "gmock/gmock.h"
26 #include "gtest/gtest.h"
27 #include "absl/flags/internal/flag.h"
28 #include "absl/flags/marshalling.h"
29 #include "absl/strings/str_cat.h"
30
31 namespace {
32 using ::testing::Eq;
33 using ::testing::IsFalse;
34 using ::testing::IsTrue;
35 using ::testing::TestWithParam;
36 using ::testing::Values;
37
38 template <typename T>
StreamHelper(T value)39 std::string StreamHelper(T value) {
40 std::ostringstream stream;
41 stream << value;
42 return stream.str();
43 }
44
TEST(StreamTest,Works)45 TEST(StreamTest, Works) {
46 EXPECT_THAT(StreamHelper(static_cast<absl::LogSeverity>(-100)),
47 Eq("absl::LogSeverity(-100)"));
48 EXPECT_THAT(StreamHelper(absl::LogSeverity::kInfo), Eq("INFO"));
49 EXPECT_THAT(StreamHelper(absl::LogSeverity::kWarning), Eq("WARNING"));
50 EXPECT_THAT(StreamHelper(absl::LogSeverity::kError), Eq("ERROR"));
51 EXPECT_THAT(StreamHelper(absl::LogSeverity::kFatal), Eq("FATAL"));
52 EXPECT_THAT(StreamHelper(static_cast<absl::LogSeverity>(4)),
53 Eq("absl::LogSeverity(4)"));
54 }
55
56 static_assert(absl::flags_internal::FlagUseValueAndInitBitStorage<
57 absl::LogSeverity>::value,
58 "Flags of type absl::LogSeverity ought to be lock-free.");
59
60 using ParseFlagFromOutOfRangeIntegerTest = TestWithParam<int64_t>;
61 INSTANTIATE_TEST_SUITE_P(
62 Instantiation, ParseFlagFromOutOfRangeIntegerTest,
63 Values(static_cast<int64_t>(std::numeric_limits<int>::min()) - 1,
64 static_cast<int64_t>(std::numeric_limits<int>::max()) + 1));
TEST_P(ParseFlagFromOutOfRangeIntegerTest,ReturnsError)65 TEST_P(ParseFlagFromOutOfRangeIntegerTest, ReturnsError) {
66 const std::string to_parse = absl::StrCat(GetParam());
67 absl::LogSeverity value;
68 std::string error;
69 EXPECT_THAT(absl::ParseFlag(to_parse, &value, &error), IsFalse()) << value;
70 }
71
72 using ParseFlagFromAlmostOutOfRangeIntegerTest = TestWithParam<int>;
73 INSTANTIATE_TEST_SUITE_P(Instantiation,
74 ParseFlagFromAlmostOutOfRangeIntegerTest,
75 Values(std::numeric_limits<int>::min(),
76 std::numeric_limits<int>::max()));
TEST_P(ParseFlagFromAlmostOutOfRangeIntegerTest,YieldsExpectedValue)77 TEST_P(ParseFlagFromAlmostOutOfRangeIntegerTest, YieldsExpectedValue) {
78 const auto expected = static_cast<absl::LogSeverity>(GetParam());
79 const std::string to_parse = absl::StrCat(GetParam());
80 absl::LogSeverity value;
81 std::string error;
82 ASSERT_THAT(absl::ParseFlag(to_parse, &value, &error), IsTrue()) << error;
83 EXPECT_THAT(value, Eq(expected));
84 }
85
86 using ParseFlagFromIntegerMatchingEnumeratorTest =
87 TestWithParam<std::tuple<absl::string_view, absl::LogSeverity>>;
88 INSTANTIATE_TEST_SUITE_P(
89 Instantiation, ParseFlagFromIntegerMatchingEnumeratorTest,
90 Values(std::make_tuple("0", absl::LogSeverity::kInfo),
91 std::make_tuple(" 0", absl::LogSeverity::kInfo),
92 std::make_tuple("-0", absl::LogSeverity::kInfo),
93 std::make_tuple("+0", absl::LogSeverity::kInfo),
94 std::make_tuple("00", absl::LogSeverity::kInfo),
95 std::make_tuple("0 ", absl::LogSeverity::kInfo),
96 std::make_tuple("0x0", absl::LogSeverity::kInfo),
97 std::make_tuple("1", absl::LogSeverity::kWarning),
98 std::make_tuple("+1", absl::LogSeverity::kWarning),
99 std::make_tuple("2", absl::LogSeverity::kError),
100 std::make_tuple("3", absl::LogSeverity::kFatal)));
TEST_P(ParseFlagFromIntegerMatchingEnumeratorTest,YieldsExpectedValue)101 TEST_P(ParseFlagFromIntegerMatchingEnumeratorTest, YieldsExpectedValue) {
102 const absl::string_view to_parse = std::get<0>(GetParam());
103 const absl::LogSeverity expected = std::get<1>(GetParam());
104 absl::LogSeverity value;
105 std::string error;
106 ASSERT_THAT(absl::ParseFlag(to_parse, &value, &error), IsTrue()) << error;
107 EXPECT_THAT(value, Eq(expected));
108 }
109
110 using ParseFlagFromOtherIntegerTest =
111 TestWithParam<std::tuple<absl::string_view, int>>;
112 INSTANTIATE_TEST_SUITE_P(Instantiation, ParseFlagFromOtherIntegerTest,
113 Values(std::make_tuple("-1", -1),
114 std::make_tuple("4", 4),
115 std::make_tuple("010", 10),
116 std::make_tuple("0x10", 16)));
TEST_P(ParseFlagFromOtherIntegerTest,YieldsExpectedValue)117 TEST_P(ParseFlagFromOtherIntegerTest, YieldsExpectedValue) {
118 const absl::string_view to_parse = std::get<0>(GetParam());
119 const auto expected = static_cast<absl::LogSeverity>(std::get<1>(GetParam()));
120 absl::LogSeverity value;
121 std::string error;
122 ASSERT_THAT(absl::ParseFlag(to_parse, &value, &error), IsTrue()) << error;
123 EXPECT_THAT(value, Eq(expected));
124 }
125
126 using ParseFlagFromEnumeratorTest =
127 TestWithParam<std::tuple<absl::string_view, absl::LogSeverity>>;
128 INSTANTIATE_TEST_SUITE_P(
129 Instantiation, ParseFlagFromEnumeratorTest,
130 Values(std::make_tuple("INFO", absl::LogSeverity::kInfo),
131 std::make_tuple("info", absl::LogSeverity::kInfo),
132 std::make_tuple("kInfo", absl::LogSeverity::kInfo),
133 std::make_tuple("iNfO", absl::LogSeverity::kInfo),
134 std::make_tuple("kInFo", absl::LogSeverity::kInfo),
135 std::make_tuple("WARNING", absl::LogSeverity::kWarning),
136 std::make_tuple("warning", absl::LogSeverity::kWarning),
137 std::make_tuple("kWarning", absl::LogSeverity::kWarning),
138 std::make_tuple("WaRnInG", absl::LogSeverity::kWarning),
139 std::make_tuple("KwArNiNg", absl::LogSeverity::kWarning),
140 std::make_tuple("ERROR", absl::LogSeverity::kError),
141 std::make_tuple("error", absl::LogSeverity::kError),
142 std::make_tuple("kError", absl::LogSeverity::kError),
143 std::make_tuple("eRrOr", absl::LogSeverity::kError),
144 std::make_tuple("kErRoR", absl::LogSeverity::kError),
145 std::make_tuple("FATAL", absl::LogSeverity::kFatal),
146 std::make_tuple("fatal", absl::LogSeverity::kFatal),
147 std::make_tuple("kFatal", absl::LogSeverity::kFatal),
148 std::make_tuple("FaTaL", absl::LogSeverity::kFatal),
149 std::make_tuple("KfAtAl", absl::LogSeverity::kFatal)));
TEST_P(ParseFlagFromEnumeratorTest,YieldsExpectedValue)150 TEST_P(ParseFlagFromEnumeratorTest, YieldsExpectedValue) {
151 const absl::string_view to_parse = std::get<0>(GetParam());
152 const absl::LogSeverity expected = std::get<1>(GetParam());
153 absl::LogSeverity value;
154 std::string error;
155 ASSERT_THAT(absl::ParseFlag(to_parse, &value, &error), IsTrue()) << error;
156 EXPECT_THAT(value, Eq(expected));
157 }
158
159 using ParseFlagFromGarbageTest = TestWithParam<absl::string_view>;
160 INSTANTIATE_TEST_SUITE_P(Instantiation, ParseFlagFromGarbageTest,
161 Values("", "\0", " ", "garbage", "kkinfo", "I"));
TEST_P(ParseFlagFromGarbageTest,ReturnsError)162 TEST_P(ParseFlagFromGarbageTest, ReturnsError) {
163 const absl::string_view to_parse = GetParam();
164 absl::LogSeverity value;
165 std::string error;
166 EXPECT_THAT(absl::ParseFlag(to_parse, &value, &error), IsFalse()) << value;
167 }
168
169 using UnparseFlagToEnumeratorTest =
170 TestWithParam<std::tuple<absl::LogSeverity, absl::string_view>>;
171 INSTANTIATE_TEST_SUITE_P(
172 Instantiation, UnparseFlagToEnumeratorTest,
173 Values(std::make_tuple(absl::LogSeverity::kInfo, "INFO"),
174 std::make_tuple(absl::LogSeverity::kWarning, "WARNING"),
175 std::make_tuple(absl::LogSeverity::kError, "ERROR"),
176 std::make_tuple(absl::LogSeverity::kFatal, "FATAL")));
TEST_P(UnparseFlagToEnumeratorTest,ReturnsExpectedValueAndRoundTrips)177 TEST_P(UnparseFlagToEnumeratorTest, ReturnsExpectedValueAndRoundTrips) {
178 const absl::LogSeverity to_unparse = std::get<0>(GetParam());
179 const absl::string_view expected = std::get<1>(GetParam());
180 const std::string stringified_value = absl::UnparseFlag(to_unparse);
181 EXPECT_THAT(stringified_value, Eq(expected));
182 absl::LogSeverity reparsed_value;
183 std::string error;
184 EXPECT_THAT(absl::ParseFlag(stringified_value, &reparsed_value, &error),
185 IsTrue());
186 EXPECT_THAT(reparsed_value, Eq(to_unparse));
187 }
188
189 using UnparseFlagToOtherIntegerTest = TestWithParam<int>;
190 INSTANTIATE_TEST_SUITE_P(Instantiation, UnparseFlagToOtherIntegerTest,
191 Values(std::numeric_limits<int>::min(), -1, 4,
192 std::numeric_limits<int>::max()));
TEST_P(UnparseFlagToOtherIntegerTest,ReturnsExpectedValueAndRoundTrips)193 TEST_P(UnparseFlagToOtherIntegerTest, ReturnsExpectedValueAndRoundTrips) {
194 const absl::LogSeverity to_unparse =
195 static_cast<absl::LogSeverity>(GetParam());
196 const std::string expected = absl::StrCat(GetParam());
197 const std::string stringified_value = absl::UnparseFlag(to_unparse);
198 EXPECT_THAT(stringified_value, Eq(expected));
199 absl::LogSeverity reparsed_value;
200 std::string error;
201 EXPECT_THAT(absl::ParseFlag(stringified_value, &reparsed_value, &error),
202 IsTrue());
203 EXPECT_THAT(reparsed_value, Eq(to_unparse));
204 }
205
TEST(LogThresholdTest,LogSeverityAtLeastTest)206 TEST(LogThresholdTest, LogSeverityAtLeastTest) {
207 EXPECT_LT(absl::LogSeverity::kError, absl::LogSeverityAtLeast::kFatal);
208 EXPECT_GT(absl::LogSeverityAtLeast::kError, absl::LogSeverity::kInfo);
209
210 EXPECT_LE(absl::LogSeverityAtLeast::kInfo, absl::LogSeverity::kError);
211 EXPECT_GE(absl::LogSeverity::kError, absl::LogSeverityAtLeast::kInfo);
212 }
213
TEST(LogThresholdTest,LogSeverityAtMostTest)214 TEST(LogThresholdTest, LogSeverityAtMostTest) {
215 EXPECT_GT(absl::LogSeverity::kError, absl::LogSeverityAtMost::kWarning);
216 EXPECT_LT(absl::LogSeverityAtMost::kError, absl::LogSeverity::kFatal);
217
218 EXPECT_GE(absl::LogSeverityAtMost::kFatal, absl::LogSeverity::kError);
219 EXPECT_LE(absl::LogSeverity::kWarning, absl::LogSeverityAtMost::kError);
220 }
221
TEST(LogThresholdTest,Extremes)222 TEST(LogThresholdTest, Extremes) {
223 EXPECT_LT(absl::LogSeverity::kFatal, absl::LogSeverityAtLeast::kInfinity);
224 EXPECT_GT(absl::LogSeverity::kInfo,
225 absl::LogSeverityAtMost::kNegativeInfinity);
226 }
227
TEST(LogThresholdTest,Output)228 TEST(LogThresholdTest, Output) {
229 EXPECT_THAT(StreamHelper(absl::LogSeverityAtLeast::kInfo), Eq(">=INFO"));
230 EXPECT_THAT(StreamHelper(absl::LogSeverityAtLeast::kWarning),
231 Eq(">=WARNING"));
232 EXPECT_THAT(StreamHelper(absl::LogSeverityAtLeast::kError), Eq(">=ERROR"));
233 EXPECT_THAT(StreamHelper(absl::LogSeverityAtLeast::kFatal), Eq(">=FATAL"));
234 EXPECT_THAT(StreamHelper(absl::LogSeverityAtLeast::kInfinity),
235 Eq("INFINITY"));
236
237 EXPECT_THAT(StreamHelper(absl::LogSeverityAtMost::kInfo), Eq("<=INFO"));
238 EXPECT_THAT(StreamHelper(absl::LogSeverityAtMost::kWarning), Eq("<=WARNING"));
239 EXPECT_THAT(StreamHelper(absl::LogSeverityAtMost::kError), Eq("<=ERROR"));
240 EXPECT_THAT(StreamHelper(absl::LogSeverityAtMost::kFatal), Eq("<=FATAL"));
241 EXPECT_THAT(StreamHelper(absl::LogSeverityAtMost::kNegativeInfinity),
242 Eq("NEGATIVE_INFINITY"));
243 }
244
245 } // namespace
246