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 namespace {
36
37 namespace flags = absl::flags_internal;
38
39 class ReflectionTest : public testing::Test {
40 protected:
SetUp()41 void SetUp() override { flag_saver_ = absl::make_unique<absl::FlagSaver>(); }
TearDown()42 void TearDown() override { flag_saver_.reset(); }
43
44 private:
45 std::unique_ptr<absl::FlagSaver> flag_saver_;
46 };
47
48 // --------------------------------------------------------------------
49
TEST_F(ReflectionTest,TestFindCommandLineFlag)50 TEST_F(ReflectionTest, TestFindCommandLineFlag) {
51 auto* handle = absl::FindCommandLineFlag("some_flag");
52 EXPECT_EQ(handle, nullptr);
53
54 handle = absl::FindCommandLineFlag("int_flag");
55 EXPECT_NE(handle, nullptr);
56
57 handle = absl::FindCommandLineFlag("string_flag");
58 EXPECT_NE(handle, nullptr);
59
60 handle = absl::FindCommandLineFlag("bool_retired_flag");
61 EXPECT_NE(handle, nullptr);
62 }
63
64 // --------------------------------------------------------------------
65
TEST_F(ReflectionTest,TestGetAllFlags)66 TEST_F(ReflectionTest, TestGetAllFlags) {
67 auto all_flags = absl::GetAllFlags();
68 EXPECT_NE(all_flags.find("int_flag"), all_flags.end());
69 EXPECT_EQ(all_flags.find("bool_retired_flag"), all_flags.end());
70 EXPECT_EQ(all_flags.find("some_undefined_flag"), all_flags.end());
71
72 std::vector<absl::string_view> flag_names_first_attempt;
73 auto all_flags_1 = absl::GetAllFlags();
74 for (auto f : all_flags_1) {
75 flag_names_first_attempt.push_back(f.first);
76 }
77
78 std::vector<absl::string_view> flag_names_second_attempt;
79 auto all_flags_2 = absl::GetAllFlags();
80 for (auto f : all_flags_2) {
81 flag_names_second_attempt.push_back(f.first);
82 }
83
84 EXPECT_THAT(flag_names_first_attempt,
85 ::testing::UnorderedElementsAreArray(flag_names_second_attempt));
86 }
87
88 // --------------------------------------------------------------------
89
90 struct CustomUDT {
CustomUDT__anon2e6dca200111::CustomUDT91 CustomUDT() : a(1), b(1) {}
CustomUDT__anon2e6dca200111::CustomUDT92 CustomUDT(int a_, int b_) : a(a_), b(b_) {}
93
operator ==(const CustomUDT & f1,const CustomUDT & f2)94 friend bool operator==(const CustomUDT& f1, const CustomUDT& f2) {
95 return f1.a == f2.a && f1.b == f2.b;
96 }
97
98 int a;
99 int b;
100 };
AbslParseFlag(absl::string_view in,CustomUDT * f,std::string *)101 bool AbslParseFlag(absl::string_view in, CustomUDT* f, std::string*) {
102 std::vector<absl::string_view> parts =
103 absl::StrSplit(in, ':', absl::SkipWhitespace());
104
105 if (parts.size() != 2) return false;
106
107 if (!absl::SimpleAtoi(parts[0], &f->a)) return false;
108
109 if (!absl::SimpleAtoi(parts[1], &f->b)) return false;
110
111 return true;
112 }
AbslUnparseFlag(const CustomUDT & f)113 std::string AbslUnparseFlag(const CustomUDT& f) {
114 return absl::StrCat(f.a, ":", f.b);
115 }
116
117 } // namespace
118
119 // --------------------------------------------------------------------
120
121 ABSL_FLAG(bool, test_flag_01, true, "");
122 ABSL_FLAG(int, test_flag_02, 1234, "");
123 ABSL_FLAG(int16_t, test_flag_03, -34, "");
124 ABSL_FLAG(uint16_t, test_flag_04, 189, "");
125 ABSL_FLAG(int32_t, test_flag_05, 10765, "");
126 ABSL_FLAG(uint32_t, test_flag_06, 40000, "");
127 ABSL_FLAG(int64_t, test_flag_07, -1234567, "");
128 ABSL_FLAG(uint64_t, test_flag_08, 9876543, "");
129 ABSL_FLAG(double, test_flag_09, -9.876e-50, "");
130 ABSL_FLAG(float, test_flag_10, 1.234e12f, "");
131 ABSL_FLAG(std::string, test_flag_11, "", "");
132 ABSL_FLAG(absl::Duration, test_flag_12, absl::Minutes(10), "");
133 static int counter = 0;
__anon2e6dca200202() 134 ABSL_FLAG(int, test_flag_13, 200, "").OnUpdate([]() { counter++; });
135 ABSL_FLAG(CustomUDT, test_flag_14, {}, "");
136
137 namespace {
138
TEST_F(ReflectionTest,TestFlagSaverInScope)139 TEST_F(ReflectionTest, TestFlagSaverInScope) {
140 {
141 absl::FlagSaver s;
142 counter = 0;
143 absl::SetFlag(&FLAGS_test_flag_01, false);
144 absl::SetFlag(&FLAGS_test_flag_02, -1021);
145 absl::SetFlag(&FLAGS_test_flag_03, 6009);
146 absl::SetFlag(&FLAGS_test_flag_04, 44);
147 absl::SetFlag(&FLAGS_test_flag_05, +800);
148 absl::SetFlag(&FLAGS_test_flag_06, -40978756);
149 absl::SetFlag(&FLAGS_test_flag_07, 23405);
150 absl::SetFlag(&FLAGS_test_flag_08, 975310);
151 absl::SetFlag(&FLAGS_test_flag_09, 1.00001);
152 absl::SetFlag(&FLAGS_test_flag_10, -3.54f);
153 absl::SetFlag(&FLAGS_test_flag_11, "asdf");
154 absl::SetFlag(&FLAGS_test_flag_12, absl::Hours(20));
155 absl::SetFlag(&FLAGS_test_flag_13, 4);
156 absl::SetFlag(&FLAGS_test_flag_14, CustomUDT{-1, -2});
157 }
158
159 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_01), true);
160 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_02), 1234);
161 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_03), -34);
162 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_04), 189);
163 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_05), 10765);
164 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_06), 40000);
165 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_07), -1234567);
166 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_08), 9876543);
167 EXPECT_NEAR(absl::GetFlag(FLAGS_test_flag_09), -9.876e-50, 1e-55);
168 EXPECT_NEAR(absl::GetFlag(FLAGS_test_flag_10), 1.234e12f, 1e5f);
169 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_11), "");
170 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_12), absl::Minutes(10));
171 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_13), 200);
172 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_14), CustomUDT{});
173 EXPECT_EQ(counter, 2);
174 }
175
176 // --------------------------------------------------------------------
177
TEST_F(ReflectionTest,TestFlagSaverVsUpdateViaReflection)178 TEST_F(ReflectionTest, TestFlagSaverVsUpdateViaReflection) {
179 {
180 absl::FlagSaver s;
181 counter = 0;
182 std::string error;
183 EXPECT_TRUE(
184 absl::FindCommandLineFlag("test_flag_01")->ParseFrom("false", &error))
185 << error;
186 EXPECT_TRUE(
187 absl::FindCommandLineFlag("test_flag_02")->ParseFrom("-4536", &error))
188 << error;
189 EXPECT_TRUE(
190 absl::FindCommandLineFlag("test_flag_03")->ParseFrom("111", &error))
191 << error;
192 EXPECT_TRUE(
193 absl::FindCommandLineFlag("test_flag_04")->ParseFrom("909", &error))
194 << error;
195 EXPECT_TRUE(
196 absl::FindCommandLineFlag("test_flag_05")->ParseFrom("-2004", &error))
197 << error;
198 EXPECT_TRUE(
199 absl::FindCommandLineFlag("test_flag_06")->ParseFrom("1000023", &error))
200 << error;
201 EXPECT_TRUE(
202 absl::FindCommandLineFlag("test_flag_07")->ParseFrom("69305", &error))
203 << error;
204 EXPECT_TRUE(absl::FindCommandLineFlag("test_flag_08")
205 ->ParseFrom("1000000001", &error))
206 << error;
207 EXPECT_TRUE(
208 absl::FindCommandLineFlag("test_flag_09")->ParseFrom("2.09021", &error))
209 << error;
210 EXPECT_TRUE(
211 absl::FindCommandLineFlag("test_flag_10")->ParseFrom("-33.1", &error))
212 << error;
213 EXPECT_TRUE(
214 absl::FindCommandLineFlag("test_flag_11")->ParseFrom("ADD_FOO", &error))
215 << error;
216 EXPECT_TRUE(absl::FindCommandLineFlag("test_flag_12")
217 ->ParseFrom("3h11m16s", &error))
218 << error;
219 EXPECT_TRUE(
220 absl::FindCommandLineFlag("test_flag_13")->ParseFrom("0", &error))
221 << error;
222 EXPECT_TRUE(
223 absl::FindCommandLineFlag("test_flag_14")->ParseFrom("10:1", &error))
224 << error;
225 }
226
227 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_01), true);
228 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_02), 1234);
229 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_03), -34);
230 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_04), 189);
231 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_05), 10765);
232 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_06), 40000);
233 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_07), -1234567);
234 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_08), 9876543);
235 EXPECT_NEAR(absl::GetFlag(FLAGS_test_flag_09), -9.876e-50, 1e-55);
236 EXPECT_NEAR(absl::GetFlag(FLAGS_test_flag_10), 1.234e12f, 1e5f);
237 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_11), "");
238 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_12), absl::Minutes(10));
239 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_13), 200);
240 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_14), CustomUDT{});
241 EXPECT_EQ(counter, 2);
242 }
243
244 // --------------------------------------------------------------------
245
TEST_F(ReflectionTest,TestMultipleFlagSaversInEnclosedScopes)246 TEST_F(ReflectionTest, TestMultipleFlagSaversInEnclosedScopes) {
247 {
248 absl::FlagSaver s;
249 absl::SetFlag(&FLAGS_test_flag_08, 10);
250 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_08), 10);
251 {
252 absl::FlagSaver s;
253 absl::SetFlag(&FLAGS_test_flag_08, 20);
254 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_08), 20);
255 {
256 absl::FlagSaver s;
257 absl::SetFlag(&FLAGS_test_flag_08, -200);
258 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_08), -200);
259 }
260 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_08), 20);
261 }
262 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_08), 10);
263 }
264 EXPECT_EQ(absl::GetFlag(FLAGS_test_flag_08), 9876543);
265 }
266
267 } // namespace
268