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/parse.h"
17
18 #include <stdlib.h>
19
20 #include <fstream>
21 #include <string>
22 #include <vector>
23
24 #include "gmock/gmock.h"
25 #include "gtest/gtest.h"
26 #include "absl/base/internal/raw_logging.h"
27 #include "absl/base/internal/scoped_set_env.h"
28 #include "absl/flags/declare.h"
29 #include "absl/flags/flag.h"
30 #include "absl/flags/internal/parse.h"
31 #include "absl/flags/internal/registry.h"
32 #include "absl/strings/str_cat.h"
33 #include "absl/strings/string_view.h"
34 #include "absl/strings/substitute.h"
35 #include "absl/types/span.h"
36
37 #ifdef _WIN32
38 #include <windows.h>
39 #endif
40
41 namespace {
42
43 using absl::base_internal::ScopedSetEnv;
44
45 struct UDT {
46 UDT() = default;
47 UDT(const UDT&) = default;
UDT__anonb2adf1a30111::UDT48 UDT(int v) : value(v) {} // NOLINT
49
50 int value;
51 };
52
AbslParseFlag(absl::string_view in,UDT * udt,std::string * err)53 bool AbslParseFlag(absl::string_view in, UDT* udt, std::string* err) {
54 if (in == "A") {
55 udt->value = 1;
56 return true;
57 }
58 if (in == "AAA") {
59 udt->value = 10;
60 return true;
61 }
62
63 *err = "Use values A, AAA instead";
64 return false;
65 }
AbslUnparseFlag(const UDT & udt)66 std::string AbslUnparseFlag(const UDT& udt) {
67 return udt.value == 1 ? "A" : "AAA";
68 }
69
GetTestTmpDirEnvVar(const char * const env_var_name)70 std::string GetTestTmpDirEnvVar(const char* const env_var_name) {
71 #ifdef _WIN32
72 char buf[MAX_PATH];
73 auto get_res = GetEnvironmentVariableA(env_var_name, buf, sizeof(buf));
74 if (get_res >= sizeof(buf) || get_res == 0) {
75 return "";
76 }
77
78 return std::string(buf, get_res);
79 #else
80 const char* val = ::getenv(env_var_name);
81 if (val == nullptr) {
82 return "";
83 }
84
85 return val;
86 #endif
87 }
88
GetTestTempDir()89 const std::string& GetTestTempDir() {
90 static std::string* temp_dir_name = []() -> std::string* {
91 std::string* res = new std::string(GetTestTmpDirEnvVar("TEST_TMPDIR"));
92
93 if (res->empty()) {
94 *res = GetTestTmpDirEnvVar("TMPDIR");
95 }
96
97 if (res->empty()) {
98 #ifdef _WIN32
99 char temp_path_buffer[MAX_PATH];
100
101 auto len = GetTempPathA(MAX_PATH, temp_path_buffer);
102 if (len < MAX_PATH && len != 0) {
103 std::string temp_dir_name = temp_path_buffer;
104 if (!absl::EndsWith(temp_dir_name, "\\")) {
105 temp_dir_name.push_back('\\');
106 }
107 absl::StrAppend(&temp_dir_name, "parse_test.", GetCurrentProcessId());
108 if (CreateDirectoryA(temp_dir_name.c_str(), nullptr)) {
109 *res = temp_dir_name;
110 }
111 }
112 #else
113 char temp_dir_template[] = "/tmp/parse_test.XXXXXX";
114 if (auto* unique_name = ::mkdtemp(temp_dir_template)) {
115 *res = unique_name;
116 }
117 #endif
118 }
119
120 if (res->empty()) {
121 ABSL_INTERNAL_LOG(FATAL,
122 "Failed to make temporary directory for data files");
123 }
124
125 #ifdef _WIN32
126 *res += "\\";
127 #else
128 *res += "/";
129 #endif
130
131 return res;
132 }();
133
134 return *temp_dir_name;
135 }
136
137 struct FlagfileData {
138 const absl::string_view file_name;
139 const absl::Span<const char* const> file_lines;
140 };
141
142 // clang-format off
143 constexpr const char* const ff1_data[] = {
144 "# comment ",
145 " # comment ",
146 "",
147 " ",
148 "--int_flag=-1",
149 " --string_flag=q2w2 ",
150 " ## ",
151 " --double_flag=0.1",
152 "--bool_flag=Y "
153 };
154
155 constexpr const char* const ff2_data[] = {
156 "# Setting legacy flag",
157 "--legacy_int=1111",
158 "--legacy_bool",
159 "--nobool_flag",
160 "--legacy_str=aqsw",
161 "--int_flag=100",
162 " ## ============="
163 };
164 // clang-format on
165
166 // Builds flagfile flag in the flagfile_flag buffer and returns it. This
167 // function also creates a temporary flagfile based on FlagfileData input.
168 // We create a flagfile in a temporary directory with the name specified in
169 // FlagfileData and populate it with lines specifed in FlagfileData. If $0 is
170 // referenced in any of the lines in FlagfileData they are replaced with
171 // temporary directory location. This way we can test inclusion of one flagfile
172 // from another flagfile.
GetFlagfileFlag(const std::vector<FlagfileData> & ffd,std::string * flagfile_flag)173 const char* GetFlagfileFlag(const std::vector<FlagfileData>& ffd,
174 std::string* flagfile_flag) {
175 *flagfile_flag = "--flagfile=";
176 absl::string_view separator;
177 for (const auto& flagfile_data : ffd) {
178 std::string flagfile_name =
179 absl::StrCat(GetTestTempDir(), flagfile_data.file_name);
180
181 std::ofstream flagfile_out(flagfile_name);
182 for (auto line : flagfile_data.file_lines) {
183 flagfile_out << absl::Substitute(line, GetTestTempDir()) << "\n";
184 }
185
186 absl::StrAppend(flagfile_flag, separator, flagfile_name);
187 separator = ",";
188 }
189
190 return flagfile_flag->c_str();
191 }
192
193 } // namespace
194
195 ABSL_FLAG(int, int_flag, 1, "");
196 ABSL_FLAG(double, double_flag, 1.1, "");
197 ABSL_FLAG(std::string, string_flag, "a", "");
198 ABSL_FLAG(bool, bool_flag, false, "");
199 ABSL_FLAG(UDT, udt_flag, -1, "");
200 ABSL_RETIRED_FLAG(int, legacy_int, 1, "");
201 ABSL_RETIRED_FLAG(bool, legacy_bool, false, "");
202 ABSL_RETIRED_FLAG(std::string, legacy_str, "l", "");
203
204 namespace {
205
206 namespace flags = absl::flags_internal;
207 using testing::ElementsAreArray;
208
209 class ParseTest : public testing::Test {
210 private:
211 flags::FlagSaver flag_saver_;
212 };
213
214 // --------------------------------------------------------------------
215
216 template <int N>
InvokeParse(const char * (& in_argv)[N])217 std::vector<char*> InvokeParse(const char* (&in_argv)[N]) {
218 return absl::ParseCommandLine(N, const_cast<char**>(in_argv));
219 }
220
221 // --------------------------------------------------------------------
222
223 template <int N>
TestParse(const char * (& in_argv)[N],int int_flag_value,double double_flag_val,absl::string_view string_flag_val,bool bool_flag_val,int exp_position_args=0)224 void TestParse(const char* (&in_argv)[N], int int_flag_value,
225 double double_flag_val, absl::string_view string_flag_val,
226 bool bool_flag_val, int exp_position_args = 0) {
227 auto out_args = InvokeParse(in_argv);
228
229 EXPECT_EQ(out_args.size(), 1 + exp_position_args);
230 EXPECT_STREQ(out_args[0], "testbin");
231
232 EXPECT_EQ(absl::GetFlag(FLAGS_int_flag), int_flag_value);
233 EXPECT_NEAR(absl::GetFlag(FLAGS_double_flag), double_flag_val, 0.0001);
234 EXPECT_EQ(absl::GetFlag(FLAGS_string_flag), string_flag_val);
235 EXPECT_EQ(absl::GetFlag(FLAGS_bool_flag), bool_flag_val);
236 }
237
238 // --------------------------------------------------------------------
239
TEST_F(ParseTest,TestEmptyArgv)240 TEST_F(ParseTest, TestEmptyArgv) {
241 const char* in_argv[] = {"testbin"};
242
243 auto out_args = InvokeParse(in_argv);
244
245 EXPECT_EQ(out_args.size(), 1);
246 EXPECT_STREQ(out_args[0], "testbin");
247 }
248
249 // --------------------------------------------------------------------
250
TEST_F(ParseTest,TestValidIntArg)251 TEST_F(ParseTest, TestValidIntArg) {
252 const char* in_args1[] = {
253 "testbin",
254 "--int_flag=10",
255 };
256 TestParse(in_args1, 10, 1.1, "a", false);
257
258 const char* in_args2[] = {
259 "testbin",
260 "-int_flag=020",
261 };
262 TestParse(in_args2, 20, 1.1, "a", false);
263
264 const char* in_args3[] = {
265 "testbin",
266 "--int_flag",
267 "-30",
268 };
269 TestParse(in_args3, -30, 1.1, "a", false);
270
271 const char* in_args4[] = {
272 "testbin",
273 "-int_flag",
274 "0x21",
275 };
276 TestParse(in_args4, 33, 1.1, "a", false);
277 }
278
279 // --------------------------------------------------------------------
280
TEST_F(ParseTest,TestValidDoubleArg)281 TEST_F(ParseTest, TestValidDoubleArg) {
282 const char* in_args1[] = {
283 "testbin",
284 "--double_flag=2.3",
285 };
286 TestParse(in_args1, 1, 2.3, "a", false);
287
288 const char* in_args2[] = {
289 "testbin",
290 "--double_flag=0x1.2",
291 };
292 TestParse(in_args2, 1, 1.125, "a", false);
293
294 const char* in_args3[] = {
295 "testbin",
296 "--double_flag",
297 "99.7",
298 };
299 TestParse(in_args3, 1, 99.7, "a", false);
300
301 const char* in_args4[] = {
302 "testbin",
303 "--double_flag",
304 "0x20.1",
305 };
306 TestParse(in_args4, 1, 32.0625, "a", false);
307 }
308
309 // --------------------------------------------------------------------
310
TEST_F(ParseTest,TestValidStringArg)311 TEST_F(ParseTest, TestValidStringArg) {
312 const char* in_args1[] = {
313 "testbin",
314 "--string_flag=aqswde",
315 };
316 TestParse(in_args1, 1, 1.1, "aqswde", false);
317
318 const char* in_args2[] = {
319 "testbin",
320 "-string_flag=a=b=c",
321 };
322 TestParse(in_args2, 1, 1.1, "a=b=c", false);
323
324 const char* in_args3[] = {
325 "testbin",
326 "--string_flag",
327 "zaxscd",
328 };
329 TestParse(in_args3, 1, 1.1, "zaxscd", false);
330
331 const char* in_args4[] = {
332 "testbin",
333 "-string_flag",
334 "--int_flag",
335 };
336 TestParse(in_args4, 1, 1.1, "--int_flag", false);
337
338 const char* in_args5[] = {
339 "testbin",
340 "--string_flag",
341 "--no_a_flag=11",
342 };
343 TestParse(in_args5, 1, 1.1, "--no_a_flag=11", false);
344 }
345
346 // --------------------------------------------------------------------
347
TEST_F(ParseTest,TestValidBoolArg)348 TEST_F(ParseTest, TestValidBoolArg) {
349 const char* in_args1[] = {
350 "testbin",
351 "--bool_flag",
352 };
353 TestParse(in_args1, 1, 1.1, "a", true);
354
355 const char* in_args2[] = {
356 "testbin",
357 "--nobool_flag",
358 };
359 TestParse(in_args2, 1, 1.1, "a", false);
360
361 const char* in_args3[] = {
362 "testbin",
363 "--bool_flag=true",
364 };
365 TestParse(in_args3, 1, 1.1, "a", true);
366
367 const char* in_args4[] = {
368 "testbin",
369 "-bool_flag=false",
370 };
371 TestParse(in_args4, 1, 1.1, "a", false);
372 }
373
374 // --------------------------------------------------------------------
375
TEST_F(ParseTest,TestValidUDTArg)376 TEST_F(ParseTest, TestValidUDTArg) {
377 const char* in_args1[] = {
378 "testbin",
379 "--udt_flag=A",
380 };
381 InvokeParse(in_args1);
382
383 EXPECT_EQ(absl::GetFlag(FLAGS_udt_flag).value, 1);
384
385 const char* in_args2[] = {"testbin", "--udt_flag", "AAA"};
386 InvokeParse(in_args2);
387
388 EXPECT_EQ(absl::GetFlag(FLAGS_udt_flag).value, 10);
389 }
390
391 // --------------------------------------------------------------------
392
TEST_F(ParseTest,TestValidMultipleArg)393 TEST_F(ParseTest, TestValidMultipleArg) {
394 const char* in_args1[] = {
395 "testbin", "--bool_flag", "--int_flag=2",
396 "--double_flag=0.1", "--string_flag=asd",
397 };
398 TestParse(in_args1, 2, 0.1, "asd", true);
399
400 const char* in_args2[] = {
401 "testbin", "--string_flag=", "--nobool_flag", "--int_flag",
402 "-011", "--double_flag", "-1e-2",
403 };
404 TestParse(in_args2, -11, -0.01, "", false);
405
406 const char* in_args3[] = {
407 "testbin", "--int_flag", "-0", "--string_flag", "\"\"",
408 "--bool_flag=true", "--double_flag=1e18",
409 };
410 TestParse(in_args3, 0, 1e18, "\"\"", true);
411 }
412
413 // --------------------------------------------------------------------
414
TEST_F(ParseTest,TestPositionalArgs)415 TEST_F(ParseTest, TestPositionalArgs) {
416 const char* in_args1[] = {
417 "testbin",
418 "p1",
419 "p2",
420 };
421 TestParse(in_args1, 1, 1.1, "a", false, 2);
422
423 auto out_args1 = InvokeParse(in_args1);
424
425 EXPECT_STREQ(out_args1[1], "p1");
426 EXPECT_STREQ(out_args1[2], "p2");
427
428 const char* in_args2[] = {
429 "testbin",
430 "--int_flag=2",
431 "p1",
432 };
433 TestParse(in_args2, 2, 1.1, "a", false, 1);
434
435 auto out_args2 = InvokeParse(in_args2);
436
437 EXPECT_STREQ(out_args2[1], "p1");
438
439 const char* in_args3[] = {"testbin", "p1", "--int_flag=3",
440 "p2", "--bool_flag", "true"};
441 TestParse(in_args3, 3, 1.1, "a", true, 3);
442
443 auto out_args3 = InvokeParse(in_args3);
444
445 EXPECT_STREQ(out_args3[1], "p1");
446 EXPECT_STREQ(out_args3[2], "p2");
447 EXPECT_STREQ(out_args3[3], "true");
448
449 const char* in_args4[] = {
450 "testbin",
451 "--",
452 "p1",
453 "p2",
454 };
455 TestParse(in_args4, 3, 1.1, "a", true, 2);
456
457 auto out_args4 = InvokeParse(in_args4);
458
459 EXPECT_STREQ(out_args4[1], "p1");
460 EXPECT_STREQ(out_args4[2], "p2");
461
462 const char* in_args5[] = {
463 "testbin", "p1", "--int_flag=4", "--", "--bool_flag", "false", "p2",
464 };
465 TestParse(in_args5, 4, 1.1, "a", true, 4);
466
467 auto out_args5 = InvokeParse(in_args5);
468
469 EXPECT_STREQ(out_args5[1], "p1");
470 EXPECT_STREQ(out_args5[2], "--bool_flag");
471 EXPECT_STREQ(out_args5[3], "false");
472 EXPECT_STREQ(out_args5[4], "p2");
473 }
474
475 // --------------------------------------------------------------------
476
477 using ParseDeathTest = ParseTest;
478
TEST_F(ParseDeathTest,TestUndefinedArg)479 TEST_F(ParseDeathTest, TestUndefinedArg) {
480 const char* in_args1[] = {
481 "testbin",
482 "--undefined_flag",
483 };
484 EXPECT_DEATH(InvokeParse(in_args1),
485 "Unknown command line flag 'undefined_flag'");
486
487 const char* in_args2[] = {
488 "testbin",
489 "--noprefixed_flag",
490 };
491 EXPECT_DEATH(InvokeParse(in_args2),
492 "Unknown command line flag 'noprefixed_flag'");
493
494 const char* in_args3[] = {
495 "testbin",
496 "--Int_flag=1",
497 };
498 EXPECT_DEATH(InvokeParse(in_args3), "Unknown command line flag 'Int_flag'");
499 }
500
501 // --------------------------------------------------------------------
502
TEST_F(ParseDeathTest,TestInvalidBoolFlagFormat)503 TEST_F(ParseDeathTest, TestInvalidBoolFlagFormat) {
504 const char* in_args1[] = {
505 "testbin",
506 "--bool_flag=",
507 };
508 EXPECT_DEATH(
509 InvokeParse(in_args1),
510 "Missing the value after assignment for the boolean flag 'bool_flag'");
511
512 const char* in_args2[] = {
513 "testbin",
514 "--nobool_flag=true",
515 };
516 EXPECT_DEATH(InvokeParse(in_args2),
517 "Negative form with assignment is not valid for the boolean "
518 "flag 'bool_flag'");
519 }
520
521 // --------------------------------------------------------------------
522
TEST_F(ParseDeathTest,TestInvalidNonBoolFlagFormat)523 TEST_F(ParseDeathTest, TestInvalidNonBoolFlagFormat) {
524 const char* in_args1[] = {
525 "testbin",
526 "--nostring_flag",
527 };
528 EXPECT_DEATH(InvokeParse(in_args1),
529 "Negative form is not valid for the flag 'string_flag'");
530
531 const char* in_args2[] = {
532 "testbin",
533 "--int_flag",
534 };
535 EXPECT_DEATH(InvokeParse(in_args2),
536 "Missing the value for the flag 'int_flag'");
537 }
538
539 // --------------------------------------------------------------------
540
TEST_F(ParseDeathTest,TestInvalidUDTFlagFormat)541 TEST_F(ParseDeathTest, TestInvalidUDTFlagFormat) {
542 const char* in_args1[] = {
543 "testbin",
544 "--udt_flag=1",
545 };
546 EXPECT_DEATH(InvokeParse(in_args1),
547 "Illegal value '1' specified for flag 'udt_flag'; Use values A, "
548 "AAA instead");
549
550 const char* in_args2[] = {
551 "testbin",
552 "--udt_flag",
553 "AA",
554 };
555 EXPECT_DEATH(InvokeParse(in_args2),
556 "Illegal value 'AA' specified for flag 'udt_flag'; Use values "
557 "A, AAA instead");
558 }
559
560 // --------------------------------------------------------------------
561
TEST_F(ParseTest,TestLegacyFlags)562 TEST_F(ParseTest, TestLegacyFlags) {
563 const char* in_args1[] = {
564 "testbin",
565 "--legacy_int=11",
566 };
567 TestParse(in_args1, 1, 1.1, "a", false);
568
569 const char* in_args2[] = {
570 "testbin",
571 "--legacy_bool",
572 };
573 TestParse(in_args2, 1, 1.1, "a", false);
574
575 const char* in_args3[] = {
576 "testbin", "--legacy_int", "22", "--int_flag=2",
577 "--legacy_bool", "true", "--legacy_str", "--string_flag=qwe",
578 };
579 TestParse(in_args3, 2, 1.1, "a", false, 1);
580 }
581
582 // --------------------------------------------------------------------
583
TEST_F(ParseTest,TestSimpleValidFlagfile)584 TEST_F(ParseTest, TestSimpleValidFlagfile) {
585 std::string flagfile_flag;
586
587 const char* in_args1[] = {
588 "testbin",
589 GetFlagfileFlag({{"parse_test.ff1", absl::MakeConstSpan(ff1_data)}},
590 &flagfile_flag),
591 };
592 TestParse(in_args1, -1, 0.1, "q2w2 ", true);
593
594 const char* in_args2[] = {
595 "testbin",
596 GetFlagfileFlag({{"parse_test.ff2", absl::MakeConstSpan(ff2_data)}},
597 &flagfile_flag),
598 };
599 TestParse(in_args2, 100, 0.1, "q2w2 ", false);
600 }
601
602 // --------------------------------------------------------------------
603
TEST_F(ParseTest,TestValidMultiFlagfile)604 TEST_F(ParseTest, TestValidMultiFlagfile) {
605 std::string flagfile_flag;
606
607 const char* in_args1[] = {
608 "testbin",
609 GetFlagfileFlag({{"parse_test.ff2", absl::MakeConstSpan(ff2_data)},
610 {"parse_test.ff1", absl::MakeConstSpan(ff1_data)}},
611 &flagfile_flag),
612 };
613 TestParse(in_args1, -1, 0.1, "q2w2 ", true);
614 }
615
616 // --------------------------------------------------------------------
617
TEST_F(ParseTest,TestFlagfileMixedWithRegularFlags)618 TEST_F(ParseTest, TestFlagfileMixedWithRegularFlags) {
619 std::string flagfile_flag;
620
621 const char* in_args1[] = {
622 "testbin", "--int_flag=3",
623 GetFlagfileFlag({{"parse_test.ff1", absl::MakeConstSpan(ff1_data)}},
624 &flagfile_flag),
625 "-double_flag=0.2"};
626 TestParse(in_args1, -1, 0.2, "q2w2 ", true);
627 }
628
629 // --------------------------------------------------------------------
630
TEST_F(ParseTest,TestFlagfileInFlagfile)631 TEST_F(ParseTest, TestFlagfileInFlagfile) {
632 std::string flagfile_flag;
633
634 constexpr const char* const ff3_data[] = {
635 "--flagfile=$0/parse_test.ff1",
636 "--flagfile=$0/parse_test.ff2",
637 };
638
639 const char* in_args1[] = {
640 "testbin",
641 GetFlagfileFlag({{"parse_test.ff3", absl::MakeConstSpan(ff3_data)}},
642 &flagfile_flag),
643 };
644 TestParse(in_args1, 100, 0.1, "q2w2 ", false);
645 }
646
647 // --------------------------------------------------------------------
648
TEST_F(ParseDeathTest,TestInvalidFlagfiles)649 TEST_F(ParseDeathTest, TestInvalidFlagfiles) {
650 std::string flagfile_flag;
651
652 constexpr const char* const ff4_data[] = {
653 "--unknown_flag=10"
654 };
655
656 const char* in_args1[] = {
657 "testbin",
658 GetFlagfileFlag({{"parse_test.ff4",
659 absl::MakeConstSpan(ff4_data)}}, &flagfile_flag),
660 };
661 EXPECT_DEATH(InvokeParse(in_args1),
662 "Unknown command line flag 'unknown_flag'");
663
664 constexpr const char* const ff5_data[] = {
665 "--int_flag 10",
666 };
667
668 const char* in_args2[] = {
669 "testbin",
670 GetFlagfileFlag({{"parse_test.ff5",
671 absl::MakeConstSpan(ff5_data)}}, &flagfile_flag),
672 };
673 EXPECT_DEATH(InvokeParse(in_args2),
674 "Unknown command line flag 'int_flag 10'");
675
676 constexpr const char* const ff6_data[] = {
677 "--int_flag=10", "--", "arg1", "arg2", "arg3",
678 };
679
680 const char* in_args3[] = {
681 "testbin",
682 GetFlagfileFlag({{"parse_test.ff6", absl::MakeConstSpan(ff6_data)}},
683 &flagfile_flag),
684 };
685 EXPECT_DEATH(InvokeParse(in_args3),
686 "Flagfile can't contain position arguments or --");
687
688 const char* in_args4[] = {
689 "testbin",
690 "--flagfile=invalid_flag_file",
691 };
692 EXPECT_DEATH(InvokeParse(in_args4), "Can't open flagfile invalid_flag_file");
693
694 constexpr const char* const ff7_data[] = {
695 "--int_flag=10",
696 "*bin*",
697 "--str_flag=aqsw",
698 };
699
700 const char* in_args5[] = {
701 "testbin",
702 GetFlagfileFlag({{"parse_test.ff7", absl::MakeConstSpan(ff7_data)}},
703 &flagfile_flag),
704 };
705 EXPECT_DEATH(InvokeParse(in_args5),
706 "Unexpected line in the flagfile .*: \\*bin\\*");
707 }
708
709 // --------------------------------------------------------------------
710
TEST_F(ParseTest,TestReadingRequiredFlagsFromEnv)711 TEST_F(ParseTest, TestReadingRequiredFlagsFromEnv) {
712 const char* in_args1[] = {"testbin",
713 "--fromenv=int_flag,bool_flag,string_flag"};
714
715 ScopedSetEnv set_int_flag("FLAGS_int_flag", "33");
716 ScopedSetEnv set_bool_flag("FLAGS_bool_flag", "True");
717 ScopedSetEnv set_string_flag("FLAGS_string_flag", "AQ12");
718
719 TestParse(in_args1, 33, 1.1, "AQ12", true);
720 }
721
722 // --------------------------------------------------------------------
723
TEST_F(ParseDeathTest,TestReadingUnsetRequiredFlagsFromEnv)724 TEST_F(ParseDeathTest, TestReadingUnsetRequiredFlagsFromEnv) {
725 const char* in_args1[] = {"testbin", "--fromenv=int_flag"};
726
727 EXPECT_DEATH(InvokeParse(in_args1),
728 "FLAGS_int_flag not found in environment");
729 }
730
731 // --------------------------------------------------------------------
732
TEST_F(ParseDeathTest,TestRecursiveFlagsFromEnv)733 TEST_F(ParseDeathTest, TestRecursiveFlagsFromEnv) {
734 const char* in_args1[] = {"testbin", "--fromenv=tryfromenv"};
735
736 ScopedSetEnv set_tryfromenv("FLAGS_tryfromenv", "int_flag");
737
738 EXPECT_DEATH(InvokeParse(in_args1), "Infinite recursion on flag tryfromenv");
739 }
740
741 // --------------------------------------------------------------------
742
TEST_F(ParseTest,TestReadingOptionalFlagsFromEnv)743 TEST_F(ParseTest, TestReadingOptionalFlagsFromEnv) {
744 const char* in_args1[] = {
745 "testbin", "--tryfromenv=int_flag,bool_flag,string_flag,other_flag"};
746
747 ScopedSetEnv set_int_flag("FLAGS_int_flag", "17");
748 ScopedSetEnv set_bool_flag("FLAGS_bool_flag", "Y");
749
750 TestParse(in_args1, 17, 1.1, "a", true);
751 }
752
753 // --------------------------------------------------------------------
754
TEST_F(ParseTest,TestReadingFlagsFromEnvMoxedWithRegularFlags)755 TEST_F(ParseTest, TestReadingFlagsFromEnvMoxedWithRegularFlags) {
756 const char* in_args1[] = {
757 "testbin",
758 "--bool_flag=T",
759 "--tryfromenv=int_flag,bool_flag",
760 "--int_flag=-21",
761 };
762
763 ScopedSetEnv set_int_flag("FLAGS_int_flag", "-15");
764 ScopedSetEnv set_bool_flag("FLAGS_bool_flag", "F");
765
766 TestParse(in_args1, -21, 1.1, "a", false);
767 }
768
769 // --------------------------------------------------------------------
770
TEST_F(ParseTest,TestKeepParsedArgs)771 TEST_F(ParseTest, TestKeepParsedArgs) {
772 const char* in_args1[] = {
773 "testbin", "arg1", "--bool_flag",
774 "--int_flag=211", "arg2", "--double_flag=1.1",
775 "--string_flag", "asd", "--",
776 "arg3", "arg4",
777 };
778
779 auto out_args1 = InvokeParse(in_args1);
780
781 EXPECT_THAT(
782 out_args1,
783 ElementsAreArray({absl::string_view("testbin"), absl::string_view("arg1"),
784 absl::string_view("arg2"), absl::string_view("arg3"),
785 absl::string_view("arg4")}));
786
787 auto out_args2 = flags::ParseCommandLineImpl(
788 11, const_cast<char**>(in_args1), flags::ArgvListAction::kKeepParsedArgs,
789 flags::UsageFlagsAction::kHandleUsage,
790 flags::OnUndefinedFlag::kAbortIfUndefined);
791
792 EXPECT_THAT(
793 out_args2,
794 ElementsAreArray({absl::string_view("testbin"),
795 absl::string_view("--bool_flag"),
796 absl::string_view("--int_flag=211"),
797 absl::string_view("--double_flag=1.1"),
798 absl::string_view("--string_flag"),
799 absl::string_view("asd"), absl::string_view("--"),
800 absl::string_view("arg1"), absl::string_view("arg2"),
801 absl::string_view("arg3"), absl::string_view("arg4")}));
802 }
803
804 // --------------------------------------------------------------------
805
TEST_F(ParseTest,TestIgnoreUndefinedFlags)806 TEST_F(ParseTest, TestIgnoreUndefinedFlags) {
807 const char* in_args1[] = {
808 "testbin",
809 "arg1",
810 "--undef_flag=aa",
811 "--int_flag=21",
812 };
813
814 auto out_args1 = flags::ParseCommandLineImpl(
815 4, const_cast<char**>(in_args1), flags::ArgvListAction::kRemoveParsedArgs,
816 flags::UsageFlagsAction::kHandleUsage,
817 flags::OnUndefinedFlag::kIgnoreUndefined);
818
819 EXPECT_THAT(out_args1, ElementsAreArray({absl::string_view("testbin"),
820 absl::string_view("arg1")}));
821
822 EXPECT_EQ(absl::GetFlag(FLAGS_int_flag), 21);
823
824 const char* in_args2[] = {
825 "testbin",
826 "arg1",
827 "--undef_flag=aa",
828 "--string_flag=AA",
829 };
830
831 auto out_args2 = flags::ParseCommandLineImpl(
832 4, const_cast<char**>(in_args2), flags::ArgvListAction::kKeepParsedArgs,
833 flags::UsageFlagsAction::kHandleUsage,
834 flags::OnUndefinedFlag::kIgnoreUndefined);
835
836 EXPECT_THAT(
837 out_args2,
838 ElementsAreArray(
839 {absl::string_view("testbin"), absl::string_view("--undef_flag=aa"),
840 absl::string_view("--string_flag=AA"), absl::string_view("arg1")}));
841
842 EXPECT_EQ(absl::GetFlag(FLAGS_string_flag), "AA");
843 }
844
845 // --------------------------------------------------------------------
846
TEST_F(ParseDeathTest,TestHelpFlagHandling)847 TEST_F(ParseDeathTest, TestHelpFlagHandling) {
848 const char* in_args1[] = {
849 "testbin",
850 "--help",
851 };
852
853 EXPECT_EXIT(InvokeParse(in_args1), testing::ExitedWithCode(1), "");
854
855 const char* in_args2[] = {
856 "testbin",
857 "--help",
858 "--int_flag=3",
859 };
860
861 auto out_args2 = flags::ParseCommandLineImpl(
862 3, const_cast<char**>(in_args2), flags::ArgvListAction::kRemoveParsedArgs,
863 flags::UsageFlagsAction::kIgnoreUsage,
864 flags::OnUndefinedFlag::kAbortIfUndefined);
865
866 EXPECT_EQ(absl::GetFlag(FLAGS_int_flag), 3);
867 }
868
869 } // namespace
870