1 //===- llvm/unittest/Support/CommandLineTest.cpp - CommandLine tests ------===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 #include "llvm/Support/CommandLine.h"
10 #include "llvm/ADT/STLExtras.h"
11 #include "llvm/ADT/SmallString.h"
12 #include "llvm/ADT/Triple.h"
13 #include "llvm/Config/config.h"
14 #include "llvm/Support/FileSystem.h"
15 #include "llvm/Support/InitLLVM.h"
16 #include "llvm/Support/MemoryBuffer.h"
17 #include "llvm/Support/Path.h"
18 #include "llvm/Support/Program.h"
19 #include "llvm/Support/StringSaver.h"
20 #include "gtest/gtest.h"
31 TempEnvVar(const char *name
, const char *value
)
33 const char *old_value
= getenv(name
);
34 EXPECT_EQ(nullptr, old_value
) << old_value
;
36 setenv(name
, value
, true);
38 # define SKIP_ENVIRONMENT_TESTS
44 // Assume setenv and unsetenv come together.
47 (void)name
; // Suppress -Wunused-private-field.
52 const char *const name
;
55 template <typename T
, typename Base
= cl::opt
<T
>>
56 class StackOption
: public Base
{
58 template <class... Ts
>
59 explicit StackOption(Ts
&&... Ms
) : Base(std::forward
<Ts
>(Ms
)...) {}
61 ~StackOption() override
{ this->removeArgument(); }
63 template <class DT
> StackOption
<T
> &operator=(const DT
&V
) {
69 class StackSubCommand
: public cl::SubCommand
{
71 StackSubCommand(StringRef Name
,
72 StringRef Description
= StringRef())
73 : SubCommand(Name
, Description
) {}
75 StackSubCommand() : SubCommand() {}
77 ~StackSubCommand() { unregisterSubCommand(); }
81 cl::OptionCategory
TestCategory("Test Options", "Description");
82 TEST(CommandLineTest
, ModifyExisitingOption
) {
83 StackOption
<int> TestOption("test-option", cl::desc("old description"));
85 static const char Description
[] = "New description";
86 static const char ArgString
[] = "new-test-option";
87 static const char ValueString
[] = "Integer";
89 StringMap
<cl::Option
*> &Map
=
90 cl::getRegisteredOptions(*cl::TopLevelSubCommand
);
92 ASSERT_TRUE(Map
.count("test-option") == 1) <<
93 "Could not find option in map.";
95 cl::Option
*Retrieved
= Map
["test-option"];
96 ASSERT_EQ(&TestOption
, Retrieved
) << "Retrieved wrong option.";
98 ASSERT_EQ(&cl::GeneralCategory
,Retrieved
->Category
) <<
99 "Incorrect default option category.";
101 Retrieved
->setCategory(TestCategory
);
102 ASSERT_EQ(&TestCategory
,Retrieved
->Category
) <<
103 "Failed to modify option's option category.";
105 Retrieved
->setDescription(Description
);
106 ASSERT_STREQ(Retrieved
->HelpStr
.data(), Description
)
107 << "Changing option description failed.";
109 Retrieved
->setArgStr(ArgString
);
110 ASSERT_STREQ(ArgString
, Retrieved
->ArgStr
.data())
111 << "Failed to modify option's Argument string.";
113 Retrieved
->setValueStr(ValueString
);
114 ASSERT_STREQ(Retrieved
->ValueStr
.data(), ValueString
)
115 << "Failed to modify option's Value string.";
117 Retrieved
->setHiddenFlag(cl::Hidden
);
118 ASSERT_EQ(cl::Hidden
, TestOption
.getOptionHiddenFlag()) <<
119 "Failed to modify option's hidden flag.";
121 #ifndef SKIP_ENVIRONMENT_TESTS
123 const char test_env_var
[] = "LLVM_TEST_COMMAND_LINE_FLAGS";
125 cl::opt
<std::string
> EnvironmentTestOption("env-test-opt");
126 TEST(CommandLineTest
, ParseEnvironment
) {
127 TempEnvVar
TEV(test_env_var
, "-env-test-opt=hello");
128 EXPECT_EQ("", EnvironmentTestOption
);
129 cl::ParseEnvironmentOptions("CommandLineTest", test_env_var
);
130 EXPECT_EQ("hello", EnvironmentTestOption
);
133 // This test used to make valgrind complain
134 // ("Conditional jump or move depends on uninitialised value(s)")
136 // Warning: Do not run any tests after this one that try to gain access to
137 // registered command line options because this will likely result in a
138 // SEGFAULT. This can occur because the cl::opt in the test below is declared
139 // on the stack which will be destroyed after the test completes but the
140 // command line system will still hold a pointer to a deallocated cl::Option.
141 TEST(CommandLineTest
, ParseEnvironmentToLocalVar
) {
142 // Put cl::opt on stack to check for proper initialization of fields.
143 StackOption
<std::string
> EnvironmentTestOptionLocal("env-test-opt-local");
144 TempEnvVar
TEV(test_env_var
, "-env-test-opt-local=hello-local");
145 EXPECT_EQ("", EnvironmentTestOptionLocal
);
146 cl::ParseEnvironmentOptions("CommandLineTest", test_env_var
);
147 EXPECT_EQ("hello-local", EnvironmentTestOptionLocal
);
150 #endif // SKIP_ENVIRONMENT_TESTS
152 TEST(CommandLineTest
, UseOptionCategory
) {
153 StackOption
<int> TestOption2("test-option", cl::cat(TestCategory
));
155 ASSERT_EQ(&TestCategory
,TestOption2
.Category
) << "Failed to assign Option "
159 typedef void ParserFunction(StringRef Source
, StringSaver
&Saver
,
160 SmallVectorImpl
<const char *> &NewArgv
,
163 void testCommandLineTokenizer(ParserFunction
*parse
, StringRef Input
,
164 const char *const Output
[], size_t OutputSize
) {
165 SmallVector
<const char *, 0> Actual
;
167 StringSaver
Saver(A
);
168 parse(Input
, Saver
, Actual
, /*MarkEOLs=*/false);
169 EXPECT_EQ(OutputSize
, Actual
.size());
170 for (unsigned I
= 0, E
= Actual
.size(); I
!= E
; ++I
) {
171 if (I
< OutputSize
) {
172 EXPECT_STREQ(Output
[I
], Actual
[I
]);
177 TEST(CommandLineTest
, TokenizeGNUCommandLine
) {
179 "foo\\ bar \"foo bar\" \'foo bar\' 'foo\\\\bar' -DFOO=bar\\(\\) "
180 "foo\"bar\"baz C:\\\\src\\\\foo.cpp \"C:\\src\\foo.cpp\"";
181 const char *const Output
[] = {
182 "foo bar", "foo bar", "foo bar", "foo\\bar",
183 "-DFOO=bar()", "foobarbaz", "C:\\src\\foo.cpp", "C:srcfoo.cpp"};
184 testCommandLineTokenizer(cl::TokenizeGNUCommandLine
, Input
, Output
,
185 array_lengthof(Output
));
188 TEST(CommandLineTest
, TokenizeWindowsCommandLine
) {
189 const char Input
[] = "a\\b c\\\\d e\\\\\"f g\" h\\\"i j\\\\\\\"k \"lmn\" o pqr "
191 const char *const Output
[] = { "a\\b", "c\\\\d", "e\\f g", "h\"i", "j\\\"k",
192 "lmn", "o", "pqr", "st \"u", "\\v" };
193 testCommandLineTokenizer(cl::TokenizeWindowsCommandLine
, Input
, Output
,
194 array_lengthof(Output
));
197 TEST(CommandLineTest
, TokenizeConfigFile1
) {
198 const char *Input
= "\\";
199 const char *const Output
[] = { "\\" };
200 testCommandLineTokenizer(cl::tokenizeConfigFile
, Input
, Output
,
201 array_lengthof(Output
));
204 TEST(CommandLineTest
, TokenizeConfigFile2
) {
205 const char *Input
= "\\abc";
206 const char *const Output
[] = { "abc" };
207 testCommandLineTokenizer(cl::tokenizeConfigFile
, Input
, Output
,
208 array_lengthof(Output
));
211 TEST(CommandLineTest
, TokenizeConfigFile3
) {
212 const char *Input
= "abc\\";
213 const char *const Output
[] = { "abc\\" };
214 testCommandLineTokenizer(cl::tokenizeConfigFile
, Input
, Output
,
215 array_lengthof(Output
));
218 TEST(CommandLineTest
, TokenizeConfigFile4
) {
219 const char *Input
= "abc\\\n123";
220 const char *const Output
[] = { "abc123" };
221 testCommandLineTokenizer(cl::tokenizeConfigFile
, Input
, Output
,
222 array_lengthof(Output
));
225 TEST(CommandLineTest
, TokenizeConfigFile5
) {
226 const char *Input
= "abc\\\r\n123";
227 const char *const Output
[] = { "abc123" };
228 testCommandLineTokenizer(cl::tokenizeConfigFile
, Input
, Output
,
229 array_lengthof(Output
));
232 TEST(CommandLineTest
, TokenizeConfigFile6
) {
233 const char *Input
= "abc\\\n";
234 const char *const Output
[] = { "abc" };
235 testCommandLineTokenizer(cl::tokenizeConfigFile
, Input
, Output
,
236 array_lengthof(Output
));
239 TEST(CommandLineTest
, TokenizeConfigFile7
) {
240 const char *Input
= "abc\\\r\n";
241 const char *const Output
[] = { "abc" };
242 testCommandLineTokenizer(cl::tokenizeConfigFile
, Input
, Output
,
243 array_lengthof(Output
));
246 TEST(CommandLineTest
, TokenizeConfigFile8
) {
247 SmallVector
<const char *, 0> Actual
;
249 StringSaver
Saver(A
);
250 cl::tokenizeConfigFile("\\\n", Saver
, Actual
, /*MarkEOLs=*/false);
251 EXPECT_TRUE(Actual
.empty());
254 TEST(CommandLineTest
, TokenizeConfigFile9
) {
255 SmallVector
<const char *, 0> Actual
;
257 StringSaver
Saver(A
);
258 cl::tokenizeConfigFile("\\\r\n", Saver
, Actual
, /*MarkEOLs=*/false);
259 EXPECT_TRUE(Actual
.empty());
262 TEST(CommandLineTest
, TokenizeConfigFile10
) {
263 const char *Input
= "\\\nabc";
264 const char *const Output
[] = { "abc" };
265 testCommandLineTokenizer(cl::tokenizeConfigFile
, Input
, Output
,
266 array_lengthof(Output
));
269 TEST(CommandLineTest
, TokenizeConfigFile11
) {
270 const char *Input
= "\\\r\nabc";
271 const char *const Output
[] = { "abc" };
272 testCommandLineTokenizer(cl::tokenizeConfigFile
, Input
, Output
,
273 array_lengthof(Output
));
276 TEST(CommandLineTest
, AliasesWithArguments
) {
277 static const size_t ARGC
= 3;
278 const char *const Inputs
[][ARGC
] = {
279 { "-tool", "-actual=x", "-extra" },
280 { "-tool", "-actual", "x" },
281 { "-tool", "-alias=x", "-extra" },
282 { "-tool", "-alias", "x" }
285 for (size_t i
= 0, e
= array_lengthof(Inputs
); i
< e
; ++i
) {
286 StackOption
<std::string
> Actual("actual");
287 StackOption
<bool> Extra("extra");
288 StackOption
<std::string
> Input(cl::Positional
);
290 cl::alias
Alias("alias", llvm::cl::aliasopt(Actual
));
292 cl::ParseCommandLineOptions(ARGC
, Inputs
[i
]);
293 EXPECT_EQ("x", Actual
);
294 EXPECT_EQ(0, Input
.getNumOccurrences());
296 Alias
.removeArgument();
300 void testAliasRequired(int argc
, const char *const *argv
) {
301 StackOption
<std::string
> Option("option", cl::Required
);
302 cl::alias
Alias("o", llvm::cl::aliasopt(Option
));
304 cl::ParseCommandLineOptions(argc
, argv
);
305 EXPECT_EQ("x", Option
);
306 EXPECT_EQ(1, Option
.getNumOccurrences());
308 Alias
.removeArgument();
311 TEST(CommandLineTest
, AliasRequired
) {
312 const char *opts1
[] = { "-tool", "-option=x" };
313 const char *opts2
[] = { "-tool", "-o", "x" };
314 testAliasRequired(array_lengthof(opts1
), opts1
);
315 testAliasRequired(array_lengthof(opts2
), opts2
);
318 TEST(CommandLineTest
, HideUnrelatedOptions
) {
319 StackOption
<int> TestOption1("hide-option-1");
320 StackOption
<int> TestOption2("hide-option-2", cl::cat(TestCategory
));
322 cl::HideUnrelatedOptions(TestCategory
);
324 ASSERT_EQ(cl::ReallyHidden
, TestOption1
.getOptionHiddenFlag())
325 << "Failed to hide extra option.";
326 ASSERT_EQ(cl::NotHidden
, TestOption2
.getOptionHiddenFlag())
327 << "Hid extra option that should be visable.";
329 StringMap
<cl::Option
*> &Map
=
330 cl::getRegisteredOptions(*cl::TopLevelSubCommand
);
331 ASSERT_EQ(cl::NotHidden
, Map
["help"]->getOptionHiddenFlag())
332 << "Hid default option that should be visable.";
335 cl::OptionCategory
TestCategory2("Test Options set 2", "Description");
337 TEST(CommandLineTest
, HideUnrelatedOptionsMulti
) {
338 StackOption
<int> TestOption1("multi-hide-option-1");
339 StackOption
<int> TestOption2("multi-hide-option-2", cl::cat(TestCategory
));
340 StackOption
<int> TestOption3("multi-hide-option-3", cl::cat(TestCategory2
));
342 const cl::OptionCategory
*VisibleCategories
[] = {&TestCategory
,
345 cl::HideUnrelatedOptions(makeArrayRef(VisibleCategories
));
347 ASSERT_EQ(cl::ReallyHidden
, TestOption1
.getOptionHiddenFlag())
348 << "Failed to hide extra option.";
349 ASSERT_EQ(cl::NotHidden
, TestOption2
.getOptionHiddenFlag())
350 << "Hid extra option that should be visable.";
351 ASSERT_EQ(cl::NotHidden
, TestOption3
.getOptionHiddenFlag())
352 << "Hid extra option that should be visable.";
354 StringMap
<cl::Option
*> &Map
=
355 cl::getRegisteredOptions(*cl::TopLevelSubCommand
);
356 ASSERT_EQ(cl::NotHidden
, Map
["help"]->getOptionHiddenFlag())
357 << "Hid default option that should be visable.";
360 TEST(CommandLineTest
, SetValueInSubcategories
) {
361 cl::ResetCommandLineParser();
363 StackSubCommand
SC1("sc1", "First subcommand");
364 StackSubCommand
SC2("sc2", "Second subcommand");
366 StackOption
<bool> TopLevelOpt("top-level", cl::init(false));
367 StackOption
<bool> SC1Opt("sc1", cl::sub(SC1
), cl::init(false));
368 StackOption
<bool> SC2Opt("sc2", cl::sub(SC2
), cl::init(false));
370 EXPECT_FALSE(TopLevelOpt
);
371 EXPECT_FALSE(SC1Opt
);
372 EXPECT_FALSE(SC2Opt
);
373 const char *args
[] = {"prog", "-top-level"};
375 cl::ParseCommandLineOptions(2, args
, StringRef(), &llvm::nulls()));
376 EXPECT_TRUE(TopLevelOpt
);
377 EXPECT_FALSE(SC1Opt
);
378 EXPECT_FALSE(SC2Opt
);
382 cl::ResetAllOptionOccurrences();
383 EXPECT_FALSE(TopLevelOpt
);
384 EXPECT_FALSE(SC1Opt
);
385 EXPECT_FALSE(SC2Opt
);
386 const char *args2
[] = {"prog", "sc1", "-sc1"};
388 cl::ParseCommandLineOptions(3, args2
, StringRef(), &llvm::nulls()));
389 EXPECT_FALSE(TopLevelOpt
);
391 EXPECT_FALSE(SC2Opt
);
395 cl::ResetAllOptionOccurrences();
396 EXPECT_FALSE(TopLevelOpt
);
397 EXPECT_FALSE(SC1Opt
);
398 EXPECT_FALSE(SC2Opt
);
399 const char *args3
[] = {"prog", "sc2", "-sc2"};
401 cl::ParseCommandLineOptions(3, args3
, StringRef(), &llvm::nulls()));
402 EXPECT_FALSE(TopLevelOpt
);
403 EXPECT_FALSE(SC1Opt
);
407 TEST(CommandLineTest
, LookupFailsInWrongSubCommand
) {
408 cl::ResetCommandLineParser();
410 StackSubCommand
SC1("sc1", "First subcommand");
411 StackSubCommand
SC2("sc2", "Second subcommand");
413 StackOption
<bool> SC1Opt("sc1", cl::sub(SC1
), cl::init(false));
414 StackOption
<bool> SC2Opt("sc2", cl::sub(SC2
), cl::init(false));
417 raw_string_ostream
OS(Errs
);
419 const char *args
[] = {"prog", "sc1", "-sc2"};
420 EXPECT_FALSE(cl::ParseCommandLineOptions(3, args
, StringRef(), &OS
));
422 EXPECT_FALSE(Errs
.empty());
425 TEST(CommandLineTest
, AddToAllSubCommands
) {
426 cl::ResetCommandLineParser();
428 StackSubCommand
SC1("sc1", "First subcommand");
429 StackOption
<bool> AllOpt("everywhere", cl::sub(*cl::AllSubCommands
),
431 StackSubCommand
SC2("sc2", "Second subcommand");
433 const char *args
[] = {"prog", "-everywhere"};
434 const char *args2
[] = {"prog", "sc1", "-everywhere"};
435 const char *args3
[] = {"prog", "sc2", "-everywhere"};
438 raw_string_ostream
OS(Errs
);
440 EXPECT_FALSE(AllOpt
);
441 EXPECT_TRUE(cl::ParseCommandLineOptions(2, args
, StringRef(), &OS
));
446 cl::ResetAllOptionOccurrences();
447 EXPECT_FALSE(AllOpt
);
448 EXPECT_TRUE(cl::ParseCommandLineOptions(3, args2
, StringRef(), &OS
));
453 cl::ResetAllOptionOccurrences();
454 EXPECT_FALSE(AllOpt
);
455 EXPECT_TRUE(cl::ParseCommandLineOptions(3, args3
, StringRef(), &OS
));
458 // Since all parsing succeeded, the error message should be empty.
460 EXPECT_TRUE(Errs
.empty());
463 TEST(CommandLineTest
, ReparseCommandLineOptions
) {
464 cl::ResetCommandLineParser();
466 StackOption
<bool> TopLevelOpt("top-level", cl::sub(*cl::TopLevelSubCommand
),
469 const char *args
[] = {"prog", "-top-level"};
471 EXPECT_FALSE(TopLevelOpt
);
473 cl::ParseCommandLineOptions(2, args
, StringRef(), &llvm::nulls()));
474 EXPECT_TRUE(TopLevelOpt
);
478 cl::ResetAllOptionOccurrences();
479 EXPECT_FALSE(TopLevelOpt
);
481 cl::ParseCommandLineOptions(2, args
, StringRef(), &llvm::nulls()));
482 EXPECT_TRUE(TopLevelOpt
);
485 TEST(CommandLineTest
, RemoveFromRegularSubCommand
) {
486 cl::ResetCommandLineParser();
488 StackSubCommand
SC("sc", "Subcommand");
489 StackOption
<bool> RemoveOption("remove-option", cl::sub(SC
), cl::init(false));
490 StackOption
<bool> KeepOption("keep-option", cl::sub(SC
), cl::init(false));
492 const char *args
[] = {"prog", "sc", "-remove-option"};
495 raw_string_ostream
OS(Errs
);
497 EXPECT_FALSE(RemoveOption
);
498 EXPECT_TRUE(cl::ParseCommandLineOptions(3, args
, StringRef(), &OS
));
499 EXPECT_TRUE(RemoveOption
);
501 EXPECT_TRUE(Errs
.empty());
503 RemoveOption
.removeArgument();
505 cl::ResetAllOptionOccurrences();
506 EXPECT_FALSE(cl::ParseCommandLineOptions(3, args
, StringRef(), &OS
));
508 EXPECT_FALSE(Errs
.empty());
511 TEST(CommandLineTest
, RemoveFromTopLevelSubCommand
) {
512 cl::ResetCommandLineParser();
514 StackOption
<bool> TopLevelRemove(
515 "top-level-remove", cl::sub(*cl::TopLevelSubCommand
), cl::init(false));
516 StackOption
<bool> TopLevelKeep(
517 "top-level-keep", cl::sub(*cl::TopLevelSubCommand
), cl::init(false));
519 const char *args
[] = {"prog", "-top-level-remove"};
521 EXPECT_FALSE(TopLevelRemove
);
523 cl::ParseCommandLineOptions(2, args
, StringRef(), &llvm::nulls()));
524 EXPECT_TRUE(TopLevelRemove
);
526 TopLevelRemove
.removeArgument();
528 cl::ResetAllOptionOccurrences();
530 cl::ParseCommandLineOptions(2, args
, StringRef(), &llvm::nulls()));
533 TEST(CommandLineTest
, RemoveFromAllSubCommands
) {
534 cl::ResetCommandLineParser();
536 StackSubCommand
SC1("sc1", "First Subcommand");
537 StackSubCommand
SC2("sc2", "Second Subcommand");
538 StackOption
<bool> RemoveOption("remove-option", cl::sub(*cl::AllSubCommands
),
540 StackOption
<bool> KeepOption("keep-option", cl::sub(*cl::AllSubCommands
),
543 const char *args0
[] = {"prog", "-remove-option"};
544 const char *args1
[] = {"prog", "sc1", "-remove-option"};
545 const char *args2
[] = {"prog", "sc2", "-remove-option"};
547 // It should work for all subcommands including the top-level.
548 EXPECT_FALSE(RemoveOption
);
550 cl::ParseCommandLineOptions(2, args0
, StringRef(), &llvm::nulls()));
551 EXPECT_TRUE(RemoveOption
);
553 RemoveOption
= false;
555 cl::ResetAllOptionOccurrences();
556 EXPECT_FALSE(RemoveOption
);
558 cl::ParseCommandLineOptions(3, args1
, StringRef(), &llvm::nulls()));
559 EXPECT_TRUE(RemoveOption
);
561 RemoveOption
= false;
563 cl::ResetAllOptionOccurrences();
564 EXPECT_FALSE(RemoveOption
);
566 cl::ParseCommandLineOptions(3, args2
, StringRef(), &llvm::nulls()));
567 EXPECT_TRUE(RemoveOption
);
569 RemoveOption
.removeArgument();
571 // It should not work for any subcommands including the top-level.
572 cl::ResetAllOptionOccurrences();
574 cl::ParseCommandLineOptions(2, args0
, StringRef(), &llvm::nulls()));
575 cl::ResetAllOptionOccurrences();
577 cl::ParseCommandLineOptions(3, args1
, StringRef(), &llvm::nulls()));
578 cl::ResetAllOptionOccurrences();
580 cl::ParseCommandLineOptions(3, args2
, StringRef(), &llvm::nulls()));
583 TEST(CommandLineTest
, GetRegisteredSubcommands
) {
584 cl::ResetCommandLineParser();
586 StackSubCommand
SC1("sc1", "First Subcommand");
587 StackOption
<bool> Opt1("opt1", cl::sub(SC1
), cl::init(false));
588 StackSubCommand
SC2("sc2", "Second subcommand");
589 StackOption
<bool> Opt2("opt2", cl::sub(SC2
), cl::init(false));
591 const char *args0
[] = {"prog", "sc1"};
592 const char *args1
[] = {"prog", "sc2"};
595 cl::ParseCommandLineOptions(2, args0
, StringRef(), &llvm::nulls()));
598 for (auto *S
: cl::getRegisteredSubcommands()) {
600 EXPECT_EQ("sc1", S
->getName());
604 cl::ResetAllOptionOccurrences();
606 cl::ParseCommandLineOptions(2, args1
, StringRef(), &llvm::nulls()));
609 for (auto *S
: cl::getRegisteredSubcommands()) {
611 EXPECT_EQ("sc2", S
->getName());
616 TEST(CommandLineTest
, ArgumentLimit
) {
617 std::string
args(32 * 4096, 'a');
618 EXPECT_FALSE(llvm::sys::commandLineFitsWithinSystemLimits("cl", args
.data()));
621 TEST(CommandLineTest
, ResponseFileWindows
) {
622 if (!Triple(sys::getProcessTriple()).isOSWindows())
625 StackOption
<std::string
, cl::list
<std::string
>> InputFilenames(
626 cl::Positional
, cl::desc("<input files>"), cl::ZeroOrMore
);
627 StackOption
<bool> TopLevelOpt("top-level", cl::init(false));
629 // Create response file.
631 SmallString
<64> TempPath
;
633 llvm::sys::fs::createTemporaryFile("resp-", ".txt", FileDescriptor
, TempPath
);
636 std::ofstream
RspFile(TempPath
.c_str());
637 EXPECT_TRUE(RspFile
.is_open());
638 RspFile
<< "-top-level\npath\\dir\\file1\npath/dir/file2";
641 llvm::SmallString
<128> RspOpt
;
642 RspOpt
.append(1, '@');
643 RspOpt
.append(TempPath
.c_str());
644 const char *args
[] = {"prog", RspOpt
.c_str()};
645 EXPECT_FALSE(TopLevelOpt
);
647 cl::ParseCommandLineOptions(2, args
, StringRef(), &llvm::nulls()));
648 EXPECT_TRUE(TopLevelOpt
);
649 EXPECT_TRUE(InputFilenames
[0] == "path\\dir\\file1");
650 EXPECT_TRUE(InputFilenames
[1] == "path/dir/file2");
652 llvm::sys::fs::remove(TempPath
.c_str());
655 TEST(CommandLineTest
, ResponseFiles
) {
656 llvm::SmallString
<128> TestDir
;
658 llvm::sys::fs::createUniqueDirectory("unittest", TestDir
);
661 // Create included response file of first level.
662 llvm::SmallString
<128> IncludedFileName
;
663 llvm::sys::path::append(IncludedFileName
, TestDir
, "resp1");
664 std::ofstream
IncludedFile(IncludedFileName
.c_str());
665 EXPECT_TRUE(IncludedFile
.is_open());
666 IncludedFile
<< "-option_1 -option_2\n"
669 IncludedFile
.close();
671 // Directory for included file.
672 llvm::SmallString
<128> IncDir
;
673 llvm::sys::path::append(IncDir
, TestDir
, "incdir");
674 EC
= llvm::sys::fs::create_directory(IncDir
);
677 // Create included response file of second level.
678 llvm::SmallString
<128> IncludedFileName2
;
679 llvm::sys::path::append(IncludedFileName2
, IncDir
, "resp2");
680 std::ofstream
IncludedFile2(IncludedFileName2
.c_str());
681 EXPECT_TRUE(IncludedFile2
.is_open());
682 IncludedFile2
<< "-option_21 -option_22\n";
683 IncludedFile2
<< "-option_23=abcd\n";
684 IncludedFile2
.close();
686 // Prepare 'file' with reference to response file.
687 SmallString
<128> IncRef
;
688 IncRef
.append(1, '@');
689 IncRef
.append(IncludedFileName
.c_str());
690 llvm::SmallVector
<const char *, 4> Argv
=
691 { "test/test", "-flag_1", IncRef
.c_str(), "-flag_2" };
693 // Expand response files.
694 llvm::BumpPtrAllocator A
;
695 llvm::StringSaver
Saver(A
);
696 bool Res
= llvm::cl::ExpandResponseFiles(
697 Saver
, llvm::cl::TokenizeGNUCommandLine
, Argv
, false, true);
699 EXPECT_EQ(Argv
.size(), 9U);
700 EXPECT_STREQ(Argv
[0], "test/test");
701 EXPECT_STREQ(Argv
[1], "-flag_1");
702 EXPECT_STREQ(Argv
[2], "-option_1");
703 EXPECT_STREQ(Argv
[3], "-option_2");
704 EXPECT_STREQ(Argv
[4], "-option_21");
705 EXPECT_STREQ(Argv
[5], "-option_22");
706 EXPECT_STREQ(Argv
[6], "-option_23=abcd");
707 EXPECT_STREQ(Argv
[7], "-option_3=abcd");
708 EXPECT_STREQ(Argv
[8], "-flag_2");
710 llvm::sys::fs::remove(IncludedFileName2
);
711 llvm::sys::fs::remove(IncDir
);
712 llvm::sys::fs::remove(IncludedFileName
);
713 llvm::sys::fs::remove(TestDir
);
716 TEST(CommandLineTest
, SetDefautValue
) {
717 cl::ResetCommandLineParser();
719 StackOption
<std::string
> Opt1("opt1", cl::init("true"));
720 StackOption
<bool> Opt2("opt2", cl::init(true));
721 cl::alias
Alias("alias", llvm::cl::aliasopt(Opt2
));
722 StackOption
<int> Opt3("opt3", cl::init(3));
724 const char *args
[] = {"prog", "-opt1=false", "-opt2", "-opt3"};
727 cl::ParseCommandLineOptions(2, args
, StringRef(), &llvm::nulls()));
729 EXPECT_TRUE(Opt1
== "false");
731 EXPECT_TRUE(Opt3
== 3);
736 cl::ResetAllOptionOccurrences();
738 for (auto &OM
: cl::getRegisteredOptions(*cl::TopLevelSubCommand
)) {
739 cl::Option
*O
= OM
.second
;
740 if (O
->ArgStr
== "opt2") {
746 EXPECT_TRUE(Opt1
== "true");
748 EXPECT_TRUE(Opt3
== 3);
749 Alias
.removeArgument();
752 TEST(CommandLineTest
, ReadConfigFile
) {
753 llvm::SmallVector
<const char *, 1> Argv
;
755 llvm::SmallString
<128> TestDir
;
757 llvm::sys::fs::createUniqueDirectory("unittest", TestDir
);
760 llvm::SmallString
<128> TestCfg
;
761 llvm::sys::path::append(TestCfg
, TestDir
, "foo");
762 std::ofstream
ConfigFile(TestCfg
.c_str());
763 EXPECT_TRUE(ConfigFile
.is_open());
764 ConfigFile
<< "# Comment\n"
772 llvm::SmallString
<128> TestCfg2
;
773 llvm::sys::path::append(TestCfg2
, TestDir
, "subconfig");
774 std::ofstream
ConfigFile2(TestCfg2
.c_str());
775 EXPECT_TRUE(ConfigFile2
.is_open());
776 ConfigFile2
<< "-option_2\n"
781 // Make sure the current directory is not the directory where config files
782 // resides. In this case the code that expands response files will not find
783 // 'subconfig' unless it resolves nested inclusions relative to the including
785 llvm::SmallString
<128> CurrDir
;
786 EC
= llvm::sys::fs::current_path(CurrDir
);
788 EXPECT_TRUE(StringRef(CurrDir
) != StringRef(TestDir
));
790 llvm::BumpPtrAllocator A
;
791 llvm::StringSaver
Saver(A
);
792 bool Result
= llvm::cl::readConfigFile(TestCfg
, Saver
, Argv
);
795 EXPECT_EQ(Argv
.size(), 4U);
796 EXPECT_STREQ(Argv
[0], "-option_1");
797 EXPECT_STREQ(Argv
[1], "-option_2");
798 EXPECT_STREQ(Argv
[2], "-option_3=abcd");
799 EXPECT_STREQ(Argv
[3], "-option_4=cdef");
801 llvm::sys::fs::remove(TestCfg2
);
802 llvm::sys::fs::remove(TestCfg
);
803 llvm::sys::fs::remove(TestDir
);
806 TEST(CommandLineTest
, PositionalEatArgsError
) {
807 StackOption
<std::string
, cl::list
<std::string
>> PosEatArgs(
808 "positional-eat-args", cl::Positional
, cl::desc("<arguments>..."),
809 cl::ZeroOrMore
, cl::PositionalEatsArgs
);
811 const char *args
[] = {"prog", "-positional-eat-args=XXXX"};
812 const char *args2
[] = {"prog", "-positional-eat-args=XXXX", "-foo"};
813 const char *args3
[] = {"prog", "-positional-eat-args", "-foo"};
816 raw_string_ostream
OS(Errs
);
817 EXPECT_FALSE(cl::ParseCommandLineOptions(2, args
, StringRef(), &OS
)); OS
.flush();
818 EXPECT_FALSE(Errs
.empty()); Errs
.clear();
819 EXPECT_FALSE(cl::ParseCommandLineOptions(3, args2
, StringRef(), &OS
)); OS
.flush();
820 EXPECT_FALSE(Errs
.empty()); Errs
.clear();
821 EXPECT_TRUE(cl::ParseCommandLineOptions(3, args3
, StringRef(), &OS
)); OS
.flush();
822 EXPECT_TRUE(Errs
.empty());
826 TEST(CommandLineTest
, GetCommandLineArguments
) {
828 char **argv
= __argv
;
830 // GetCommandLineArguments is called in InitLLVM.
831 llvm::InitLLVM
X(argc
, argv
);
833 EXPECT_EQ(llvm::sys::path::is_absolute(argv
[0]),
834 llvm::sys::path::is_absolute(__argv
[0]));
836 EXPECT_TRUE(llvm::sys::path::filename(argv
[0])
837 .equals_lower("supporttests.exe"))
838 << "Filename of test executable is "
839 << llvm::sys::path::filename(argv
[0]);
843 class OutputRedirector
{
845 OutputRedirector(int RedirectFD
)
846 : RedirectFD(RedirectFD
), OldFD(dup(RedirectFD
)) {
848 sys::fs::createTemporaryFile("unittest-redirect", "", NewFD
,
850 dup2(NewFD
, RedirectFD
) == -1)
854 ~OutputRedirector() {
855 dup2(OldFD
, RedirectFD
);
860 SmallVector
<char, 128> FilePath
;
869 struct AutoDeleteFile
{
870 SmallVector
<char, 128> FilePath
;
872 if (!FilePath
.empty())
873 sys::fs::remove(std::string(FilePath
.data(), FilePath
.size()));
877 class PrintOptionInfoTest
: public ::testing::Test
{
879 // Return std::string because the output of a failing EXPECT check is
880 // unreadable for StringRef. It also avoids any lifetime issues.
881 template <typename
... Ts
> std::string
runTest(Ts
... OptionAttributes
) {
884 OutputRedirector
Stdout(fileno(stdout
));
887 File
.FilePath
= Stdout
.FilePath
;
889 StackOption
<OptionValue
> TestOption(Opt
, cl::desc(HelpText
),
890 OptionAttributes
...);
891 printOptionInfo(TestOption
, 25);
894 auto Buffer
= MemoryBuffer::getFile(File
.FilePath
);
897 return Buffer
->get()->getBuffer().str();
900 enum class OptionValue
{ Val
};
901 const StringRef Opt
= "some-option";
902 const StringRef HelpText
= "some help";
905 // This is a workaround for cl::Option sub-classes having their
906 // printOptionInfo functions private.
907 void printOptionInfo(const cl::Option
&O
, size_t Width
) {
908 O
.printOptionInfo(Width
);
912 TEST_F(PrintOptionInfoTest
, PrintOptionInfoValueOptionalWithoutSentinel
) {
914 runTest(cl::ValueOptional
,
915 cl::values(clEnumValN(OptionValue::Val
, "v1", "desc1")));
918 EXPECT_EQ(Output
, (" -" + Opt
+ "=<value> - " + HelpText
+ "\n"
924 TEST_F(PrintOptionInfoTest
, PrintOptionInfoValueOptionalWithSentinel
) {
925 std::string Output
= runTest(
926 cl::ValueOptional
, cl::values(clEnumValN(OptionValue::Val
, "v1", "desc1"),
927 clEnumValN(OptionValue::Val
, "", "")));
931 (" -" + Opt
+ " - " + HelpText
+ "\n"
932 " -" + Opt
+ "=<value> - " + HelpText
+ "\n"
938 TEST_F(PrintOptionInfoTest
, PrintOptionInfoValueOptionalWithSentinelWithHelp
) {
939 std::string Output
= runTest(
940 cl::ValueOptional
, cl::values(clEnumValN(OptionValue::Val
, "v1", "desc1"),
941 clEnumValN(OptionValue::Val
, "", "desc2")));
944 EXPECT_EQ(Output
, (" -" + Opt
+ " - " + HelpText
+ "\n"
945 " -" + Opt
+ "=<value> - " + HelpText
+ "\n"
947 " =<empty> - desc2\n")
952 TEST_F(PrintOptionInfoTest
, PrintOptionInfoValueRequiredWithEmptyValueName
) {
953 std::string Output
= runTest(
954 cl::ValueRequired
, cl::values(clEnumValN(OptionValue::Val
, "v1", "desc1"),
955 clEnumValN(OptionValue::Val
, "", "")));
958 EXPECT_EQ(Output
, (" -" + Opt
+ "=<value> - " + HelpText
+ "\n"
965 TEST_F(PrintOptionInfoTest
, PrintOptionInfoEmptyValueDescription
) {
966 std::string Output
= runTest(
967 cl::ValueRequired
, cl::values(clEnumValN(OptionValue::Val
, "v1", "")));
971 (" -" + Opt
+ "=<value> - " + HelpText
+ "\n"
976 class GetOptionWidthTest
: public ::testing::Test
{
978 enum class OptionValue
{ Val
};
980 template <typename
... Ts
>
981 size_t runTest(StringRef ArgName
, Ts
... OptionAttributes
) {
982 StackOption
<OptionValue
> TestOption(ArgName
, cl::desc("some help"),
983 OptionAttributes
...);
984 return getOptionWidth(TestOption
);
988 // This is a workaround for cl::Option sub-classes having their
990 // functions private.
991 size_t getOptionWidth(const cl::Option
&O
) { return O
.getOptionWidth(); }
994 TEST_F(GetOptionWidthTest
, GetOptionWidthArgNameLonger
) {
995 StringRef
ArgName("a-long-argument-name");
996 size_t ExpectedStrSize
= (" -" + ArgName
+ "=<value> - ").str().size();
998 runTest(ArgName
, cl::values(clEnumValN(OptionValue::Val
, "v", "help"))),
1002 TEST_F(GetOptionWidthTest
, GetOptionWidthFirstOptionNameLonger
) {
1003 StringRef
OptName("a-long-option-name");
1004 size_t ExpectedStrSize
= (" =" + OptName
+ " - ").str().size();
1006 runTest("a", cl::values(clEnumValN(OptionValue::Val
, OptName
, "help"),
1007 clEnumValN(OptionValue::Val
, "b", "help"))),
1011 TEST_F(GetOptionWidthTest
, GetOptionWidthSecondOptionNameLonger
) {
1012 StringRef
OptName("a-long-option-name");
1013 size_t ExpectedStrSize
= (" =" + OptName
+ " - ").str().size();
1015 runTest("a", cl::values(clEnumValN(OptionValue::Val
, "b", "help"),
1016 clEnumValN(OptionValue::Val
, OptName
, "help"))),
1020 TEST_F(GetOptionWidthTest
, GetOptionWidthEmptyOptionNameLonger
) {
1021 size_t ExpectedStrSize
= StringRef(" =<empty> - ").size();
1022 // The length of a=<value> (including indentation) is actually the same as the
1023 // =<empty> string, so it is impossible to distinguish via testing the case
1024 // where the empty string is picked from where the option name is picked.
1025 EXPECT_EQ(runTest("a", cl::values(clEnumValN(OptionValue::Val
, "b", "help"),
1026 clEnumValN(OptionValue::Val
, "", "help"))),
1030 TEST_F(GetOptionWidthTest
,
1031 GetOptionWidthValueOptionalEmptyOptionWithNoDescription
) {
1032 StringRef
ArgName("a");
1033 // The length of a=<value> (including indentation) is actually the same as the
1034 // =<empty> string, so it is impossible to distinguish via testing the case
1035 // where the empty string is ignored from where it is not ignored.
1036 // The dash will not actually be printed, but the space it would take up is
1037 // included to ensure a consistent column width.
1038 size_t ExpectedStrSize
= (" -" + ArgName
+ "=<value> - ").str().size();
1039 EXPECT_EQ(runTest(ArgName
, cl::ValueOptional
,
1040 cl::values(clEnumValN(OptionValue::Val
, "value", "help"),
1041 clEnumValN(OptionValue::Val
, "", ""))),
1045 TEST_F(GetOptionWidthTest
,
1046 GetOptionWidthValueRequiredEmptyOptionWithNoDescription
) {
1047 // The length of a=<value> (including indentation) is actually the same as the
1048 // =<empty> string, so it is impossible to distinguish via testing the case
1049 // where the empty string is picked from where the option name is picked
1050 size_t ExpectedStrSize
= StringRef(" =<empty> - ").size();
1051 EXPECT_EQ(runTest("a", cl::ValueRequired
,
1052 cl::values(clEnumValN(OptionValue::Val
, "value", "help"),
1053 clEnumValN(OptionValue::Val
, "", ""))),
1057 TEST(CommandLineTest
, PrefixOptions
) {
1058 cl::ResetCommandLineParser();
1060 StackOption
<std::string
, cl::list
<std::string
>> IncludeDirs(
1061 "I", cl::Prefix
, cl::desc("Declare an include directory"));
1063 // Test non-prefixed variant works with cl::Prefix options.
1064 EXPECT_TRUE(IncludeDirs
.empty());
1065 const char *args
[] = {"prog", "-I=/usr/include"};
1067 cl::ParseCommandLineOptions(2, args
, StringRef(), &llvm::nulls()));
1068 EXPECT_TRUE(IncludeDirs
.size() == 1);
1069 EXPECT_TRUE(IncludeDirs
.front().compare("/usr/include") == 0);
1071 IncludeDirs
.erase(IncludeDirs
.begin());
1072 cl::ResetAllOptionOccurrences();
1074 // Test non-prefixed variant works with cl::Prefix options when value is
1075 // passed in following argument.
1076 EXPECT_TRUE(IncludeDirs
.empty());
1077 const char *args2
[] = {"prog", "-I", "/usr/include"};
1079 cl::ParseCommandLineOptions(3, args2
, StringRef(), &llvm::nulls()));
1080 EXPECT_TRUE(IncludeDirs
.size() == 1);
1081 EXPECT_TRUE(IncludeDirs
.front().compare("/usr/include") == 0);
1083 IncludeDirs
.erase(IncludeDirs
.begin());
1084 cl::ResetAllOptionOccurrences();
1086 // Test prefixed variant works with cl::Prefix options.
1087 EXPECT_TRUE(IncludeDirs
.empty());
1088 const char *args3
[] = {"prog", "-I/usr/include"};
1090 cl::ParseCommandLineOptions(2, args3
, StringRef(), &llvm::nulls()));
1091 EXPECT_TRUE(IncludeDirs
.size() == 1);
1092 EXPECT_TRUE(IncludeDirs
.front().compare("/usr/include") == 0);
1094 StackOption
<std::string
, cl::list
<std::string
>> MacroDefs(
1095 "D", cl::AlwaysPrefix
, cl::desc("Define a macro"),
1096 cl::value_desc("MACRO[=VALUE]"));
1098 cl::ResetAllOptionOccurrences();
1100 // Test non-prefixed variant does not work with cl::AlwaysPrefix options:
1101 // equal sign is part of the value.
1102 EXPECT_TRUE(MacroDefs
.empty());
1103 const char *args4
[] = {"prog", "-D=HAVE_FOO"};
1105 cl::ParseCommandLineOptions(2, args4
, StringRef(), &llvm::nulls()));
1106 EXPECT_TRUE(MacroDefs
.size() == 1);
1107 EXPECT_TRUE(MacroDefs
.front().compare("=HAVE_FOO") == 0);
1109 MacroDefs
.erase(MacroDefs
.begin());
1110 cl::ResetAllOptionOccurrences();
1112 // Test non-prefixed variant does not allow value to be passed in following
1113 // argument with cl::AlwaysPrefix options.
1114 EXPECT_TRUE(MacroDefs
.empty());
1115 const char *args5
[] = {"prog", "-D", "HAVE_FOO"};
1117 cl::ParseCommandLineOptions(3, args5
, StringRef(), &llvm::nulls()));
1118 EXPECT_TRUE(MacroDefs
.empty());
1120 cl::ResetAllOptionOccurrences();
1122 // Test prefixed variant works with cl::AlwaysPrefix options.
1123 EXPECT_TRUE(MacroDefs
.empty());
1124 const char *args6
[] = {"prog", "-DHAVE_FOO"};
1126 cl::ParseCommandLineOptions(2, args6
, StringRef(), &llvm::nulls()));
1127 EXPECT_TRUE(MacroDefs
.size() == 1);
1128 EXPECT_TRUE(MacroDefs
.front().compare("HAVE_FOO") == 0);
1131 } // anonymous namespace