1 //
2 // Copyright 2019 The Abseil Authors.
3 //
4 // Licensed under the Apache License, Version 2.0 (the "License");
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
7 //
8 // https://www.apache.org/licenses/LICENSE-2.0
9 //
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
15
16 #include "absl/flags/reflection.h"
17
18 #include <memory>
19 #include <string>
20
21 #include "gmock/gmock.h"
22 #include "gtest/gtest.h"
23 #include "absl/flags/declare.h"
24 #include "absl/flags/flag.h"
25 #include "absl/flags/internal/commandlineflag.h"
26 #include "absl/flags/marshalling.h"
27 #include "absl/memory/memory.h"
28 #include "absl/strings/str_cat.h"
29 #include "absl/strings/str_split.h"
30
31 ABSL_FLAG(int, int_flag, 1, "int_flag help");
32 ABSL_FLAG(std::string, string_flag, "dflt", "string_flag help");
33 ABSL_RETIRED_FLAG(bool, bool_retired_flag, false, "bool_retired_flag help");
34
35 ABSL_DECLARE_FLAG(bool, help);
36
37 namespace {
38
39 namespace flags = absl::flags_internal;
40
41 class ReflectionTest : public testing::Test {
42 protected:
SetUp()43 void SetUp() override { flag_saver_ = absl::make_unique<absl::FlagSaver>(); }
TearDown()44 void TearDown() override { flag_saver_.reset(); }
45
46 private:
47 std::unique_ptr<absl::FlagSaver> flag_saver_;
48 };
49
50 // --------------------------------------------------------------------
51
TEST_F(ReflectionTest,TestFindCommandLineFlag)52 TEST_F(ReflectionTest, TestFindCommandLineFlag) {
53 auto* handle = absl::FindCommandLineFlag("some_flag");
54 EXPECT_EQ(handle, nullptr);
55
56 handle = absl::FindCommandLineFlag("int_flag");
57 EXPECT_NE(handle, nullptr);
58
59 handle = absl::FindCommandLineFlag("string_flag");
60 EXPECT_NE(handle, nullptr);
61
62 handle = absl::FindCommandLineFlag("bool_retired_flag");
63 EXPECT_NE(handle, nullptr);
64 }
65
66 // --------------------------------------------------------------------
67
TEST_F(ReflectionTest,TestGetAllFlags)68 TEST_F(ReflectionTest, TestGetAllFlags) {
69 (void)absl::GetFlag(FLAGS_help); // Force linking of usage flags.
70
71 auto all_flags = absl::GetAllFlags();
72 EXPECT_NE(all_flags.find("int_flag"), all_flags.end());
73 EXPECT_NE(all_flags.find("bool_retired_flag"), all_flags.end());
74 EXPECT_NE(all_flags.find("help"), all_flags.end());
75 EXPECT_EQ(all_flags.find("some_undefined_flag"), all_flags.end());
76
77 std::vector<absl::string_view> flag_names_first_attempt;
78 auto all_flags_1 = absl::GetAllFlags();
79 for (auto f : all_flags_1) {
80 flag_names_first_attempt.push_back(f.first);
81 }
82
83 std::vector<absl::string_view> flag_names_second_attempt;
84 auto all_flags_2 = absl::GetAllFlags();
85 for (auto f : all_flags_2) {
86 flag_names_second_attempt.push_back(f.first);
87 }
88
89 EXPECT_THAT(flag_names_first_attempt,
90 ::testing::UnorderedElementsAreArray(flag_names_second_attempt));
91 }
92
93 // --------------------------------------------------------------------
94
95 struct CustomUDT {
CustomUDT__anon94e9a2dc0111::CustomUDT96 CustomUDT() : a(1), b(1) {}
CustomUDT__anon94e9a2dc0111::CustomUDT97 CustomUDT(int a_, int b_) : a(a_), b(b_) {}
98
operator ==(const CustomUDT & f1,const CustomUDT & f2)99 friend bool operator==(const CustomUDT& f1, const CustomUDT& f2) {
100 return f1.a == f2.a && f1.b == f2.b;
101 }
102
103 int a;
104 int b;
105 };
AbslParseFlag(absl::string_view in,CustomUDT * f,std::string *)106 bool AbslParseFlag(absl::string_view in, CustomUDT* f, std::string*) {
107 std::vector<absl::string_view> parts =
108 absl::StrSplit(in, ':', absl::SkipWhitespace());
109
110 if (parts.size() != 2) return false;
111
112 if (!absl::SimpleAtoi(parts[0], &f->a)) return false;
113
114 if (!absl::SimpleAtoi(parts[1], &f->b)) return false;
115
116 return true;
117 }
AbslUnparseFlag(const CustomUDT & f)118 std::string AbslUnparseFlag(const CustomUDT& f) {
119 return absl::StrCat(f.a, ":", f.b);
120 }
121
122 } // namespace
123
124 // --------------------------------------------------------------------
125
126 ABSL_FLAG(bool, test_flag_01, true, "");
127 ABSL_FLAG(int, test_flag_02, 1234, "");
128 ABSL_FLAG(int16_t, test_flag_03, -34, "");
129 ABSL_FLAG(uint16_t, test_flag_04, 189, "");
130 ABSL_FLAG(int32_t, test_flag_05, 10765, "");
131 ABSL_FLAG(uint32_t, test_flag_06, 40000, "");
132 ABSL_FLAG(int64_t, test_flag_07, -1234567, "");
133 ABSL_FLAG(uint64_t, test_flag_08, 9876543, "");
134 ABSL_FLAG(double, test_flag_09, -9.876e-50, "");
135 ABSL_FLAG(float, test_flag_10, 1.234e12f, "");
136 ABSL_FLAG(std::string, test_flag_11, "", "");
137 ABSL_FLAG(absl::Duration, test_flag_12, absl::Minutes(10), "");
138 static int counter = 0;
__anon94e9a2dc0202() 139 ABSL_FLAG(int, test_flag_13, 200, "").OnUpdate([]() { counter++; });
140 ABSL_FLAG(CustomUDT, test_flag_14, {}, "");
141
142 namespace {
143
TEST_F(ReflectionTest,TestFlagSaverInScope)144 TEST_F(ReflectionTest, TestFlagSaverInScope) {
145 {
146 absl::FlagSaver s;
147 counter = 0;
148 absl::SetFlag(&FLAGS_test_flag_01, false);
149 absl::SetFlag(&FLAGS_test_flag_02, -1021);
150 absl::SetFlag(&FLAGS_test_flag_03, 6009);
151 absl::SetFlag(&FLAGS_test_flag_04, 44);
152 absl::SetFlag(&FLAGS_test_flag_05, +800);
153 absl::SetFlag(&FLAGS_test_flag_06, -40978756);
154 absl::SetFlag(&FLAGS_test_flag_07, 23405);
155 absl::SetFlag(&FLAGS_test_flag_08, 975310);
156 absl::SetFlag(&FLAGS_test_flag_09, 1.00001);
157 absl::SetFlag(&FLAGS_test_flag_10, -3.54f);
158 absl::SetFlag(&FLAGS_test_flag_11, "asdf");
159 absl::SetFlag(&FLAGS_test_flag_12, absl::Hours(20));
160 absl::SetFlag(&FLAGS_test_flag_13, 4);
161 absl::SetFlag(&FLAGS_test_flag_14, CustomUDT{-1, -2});
162 }
163
164 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_01), true);
165 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_02), 1234);
166 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_03), -34);
167 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_04), 189);
168 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_05), 10765);
169 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_06), 40000);
170 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_07), -1234567);
171 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_08), 9876543);
172 EXPECT_NEAR(absl::GetFlag(FLAGS_test_flag_09), -9.876e-50, 1e-55);
173 EXPECT_NEAR(absl::GetFlag(FLAGS_test_flag_10), 1.234e12f, 1e5f);
174 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_11), "");
175 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_12), absl::Minutes(10));
176 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_13), 200);
177 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_14), CustomUDT{});
178 EXPECT_EQ(counter, 2);
179 }
180
181 // --------------------------------------------------------------------
182
TEST_F(ReflectionTest,TestFlagSaverVsUpdateViaReflection)183 TEST_F(ReflectionTest, TestFlagSaverVsUpdateViaReflection) {
184 {
185 absl::FlagSaver s;
186 counter = 0;
187 std::string error;
188 EXPECT_TRUE(
189 absl::FindCommandLineFlag("test_flag_01")->ParseFrom("false", &error))
190 << error;
191 EXPECT_TRUE(
192 absl::FindCommandLineFlag("test_flag_02")->ParseFrom("-4536", &error))
193 << error;
194 EXPECT_TRUE(
195 absl::FindCommandLineFlag("test_flag_03")->ParseFrom("111", &error))
196 << error;
197 EXPECT_TRUE(
198 absl::FindCommandLineFlag("test_flag_04")->ParseFrom("909", &error))
199 << error;
200 EXPECT_TRUE(
201 absl::FindCommandLineFlag("test_flag_05")->ParseFrom("-2004", &error))
202 << error;
203 EXPECT_TRUE(
204 absl::FindCommandLineFlag("test_flag_06")->ParseFrom("1000023", &error))
205 << error;
206 EXPECT_TRUE(
207 absl::FindCommandLineFlag("test_flag_07")->ParseFrom("69305", &error))
208 << error;
209 EXPECT_TRUE(absl::FindCommandLineFlag("test_flag_08")
210 ->ParseFrom("1000000001", &error))
211 << error;
212 EXPECT_TRUE(
213 absl::FindCommandLineFlag("test_flag_09")->ParseFrom("2.09021", &error))
214 << error;
215 EXPECT_TRUE(
216 absl::FindCommandLineFlag("test_flag_10")->ParseFrom("-33.1", &error))
217 << error;
218 EXPECT_TRUE(
219 absl::FindCommandLineFlag("test_flag_11")->ParseFrom("ADD_FOO", &error))
220 << error;
221 EXPECT_TRUE(absl::FindCommandLineFlag("test_flag_12")
222 ->ParseFrom("3h11m16s", &error))
223 << error;
224 EXPECT_TRUE(
225 absl::FindCommandLineFlag("test_flag_13")->ParseFrom("0", &error))
226 << error;
227 EXPECT_TRUE(
228 absl::FindCommandLineFlag("test_flag_14")->ParseFrom("10:1", &error))
229 << error;
230 }
231
232 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_01), true);
233 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_02), 1234);
234 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_03), -34);
235 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_04), 189);
236 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_05), 10765);
237 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_06), 40000);
238 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_07), -1234567);
239 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_08), 9876543);
240 EXPECT_NEAR(absl::GetFlag(FLAGS_test_flag_09), -9.876e-50, 1e-55);
241 EXPECT_NEAR(absl::GetFlag(FLAGS_test_flag_10), 1.234e12f, 1e5f);
242 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_11), "");
243 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_12), absl::Minutes(10));
244 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_13), 200);
245 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_14), CustomUDT{});
246 EXPECT_EQ(counter, 2);
247 }
248
249 // --------------------------------------------------------------------
250
TEST_F(ReflectionTest,TestMultipleFlagSaversInEnclosedScopes)251 TEST_F(ReflectionTest, TestMultipleFlagSaversInEnclosedScopes) {
252 {
253 absl::FlagSaver s;
254 absl::SetFlag(&FLAGS_test_flag_08, 10);
255 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_08), 10);
256 {
257 absl::FlagSaver s;
258 absl::SetFlag(&FLAGS_test_flag_08, 20);
259 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_08), 20);
260 {
261 absl::FlagSaver s;
262 absl::SetFlag(&FLAGS_test_flag_08, -200);
263 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_08), -200);
264 }
265 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_08), 20);
266 }
267 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_08), 10);
268 }
269 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_08), 9876543);
270 }
271
272 } // namespace
273