//===- llvm/unittest/Support/CommandLineTest.cpp - CommandLine tests ------===// // // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // See https://llvm.org/LICENSE.txt for license information. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception // //===----------------------------------------------------------------------===// #include "llvm/Support/CommandLine.h" #include "llvm/ADT/STLExtras.h" #include "llvm/ADT/SmallString.h" #include "llvm/ADT/StringRef.h" #include "llvm/ADT/Triple.h" #include "llvm/Config/config.h" #include "llvm/Support/Allocator.h" #include "llvm/Support/FileSystem.h" #include "llvm/Support/Host.h" #include "llvm/Support/InitLLVM.h" #include "llvm/Support/MemoryBuffer.h" #include "llvm/Support/Path.h" #include "llvm/Support/Program.h" #include "llvm/Support/StringSaver.h" #include "llvm/Support/VirtualFileSystem.h" #include "llvm/Support/raw_ostream.h" #include "llvm/Testing/Support/SupportHelpers.h" #include "gmock/gmock.h" #include "gtest/gtest.h" #include #include #include #include using namespace llvm; using llvm::unittest::TempDir; using llvm::unittest::TempFile; namespace { MATCHER(StringEquality, "Checks if two char* are equal as strings") { return std::string(std::get<0>(arg)) == std::string(std::get<1>(arg)); } class TempEnvVar { public: TempEnvVar(const char *name, const char *value) : name(name) { const char *old_value = getenv(name); EXPECT_EQ(nullptr, old_value) << old_value; #if HAVE_SETENV setenv(name, value, true); #endif } ~TempEnvVar() { #if HAVE_SETENV // Assume setenv and unsetenv come together. unsetenv(name); #else (void)name; // Suppress -Wunused-private-field. #endif } private: const char *const name; }; template > class StackOption : public Base { public: template explicit StackOption(Ts &&... Ms) : Base(std::forward(Ms)...) {} ~StackOption() override { this->removeArgument(); } template StackOption &operator=(const DT &V) { Base::operator=(V); return *this; } }; class StackSubCommand : public cl::SubCommand { public: StackSubCommand(StringRef Name, StringRef Description = StringRef()) : SubCommand(Name, Description) {} StackSubCommand() : SubCommand() {} ~StackSubCommand() { unregisterSubCommand(); } }; cl::OptionCategory TestCategory("Test Options", "Description"); TEST(CommandLineTest, ModifyExisitingOption) { StackOption TestOption("test-option", cl::desc("old description")); static const char Description[] = "New description"; static const char ArgString[] = "new-test-option"; static const char ValueString[] = "Integer"; StringMap &Map = cl::getRegisteredOptions(*cl::TopLevelSubCommand); ASSERT_TRUE(Map.count("test-option") == 1) << "Could not find option in map."; cl::Option *Retrieved = Map["test-option"]; ASSERT_EQ(&TestOption, Retrieved) << "Retrieved wrong option."; ASSERT_NE(Retrieved->Categories.end(), find_if(Retrieved->Categories, [&](const llvm::cl::OptionCategory *Cat) { return Cat == &cl::getGeneralCategory(); })) << "Incorrect default option category."; Retrieved->addCategory(TestCategory); ASSERT_NE(Retrieved->Categories.end(), find_if(Retrieved->Categories, [&](const llvm::cl::OptionCategory *Cat) { return Cat == &TestCategory; })) << "Failed to modify option's option category."; Retrieved->setDescription(Description); ASSERT_STREQ(Retrieved->HelpStr.data(), Description) << "Changing option description failed."; Retrieved->setArgStr(ArgString); ASSERT_STREQ(ArgString, Retrieved->ArgStr.data()) << "Failed to modify option's Argument string."; Retrieved->setValueStr(ValueString); ASSERT_STREQ(Retrieved->ValueStr.data(), ValueString) << "Failed to modify option's Value string."; Retrieved->setHiddenFlag(cl::Hidden); ASSERT_EQ(cl::Hidden, TestOption.getOptionHiddenFlag()) << "Failed to modify option's hidden flag."; } TEST(CommandLineTest, UseOptionCategory) { StackOption TestOption2("test-option", cl::cat(TestCategory)); ASSERT_NE(TestOption2.Categories.end(), find_if(TestOption2.Categories, [&](const llvm::cl::OptionCategory *Cat) { return Cat == &TestCategory; })) << "Failed to assign Option Category."; } TEST(CommandLineTest, UseMultipleCategories) { StackOption TestOption2("test-option2", cl::cat(TestCategory), cl::cat(cl::getGeneralCategory()), cl::cat(cl::getGeneralCategory())); // Make sure cl::getGeneralCategory() wasn't added twice. ASSERT_EQ(TestOption2.Categories.size(), 2U); ASSERT_NE(TestOption2.Categories.end(), find_if(TestOption2.Categories, [&](const llvm::cl::OptionCategory *Cat) { return Cat == &TestCategory; })) << "Failed to assign Option Category."; ASSERT_NE(TestOption2.Categories.end(), find_if(TestOption2.Categories, [&](const llvm::cl::OptionCategory *Cat) { return Cat == &cl::getGeneralCategory(); })) << "Failed to assign General Category."; cl::OptionCategory AnotherCategory("Additional test Options", "Description"); StackOption TestOption("test-option", cl::cat(TestCategory), cl::cat(AnotherCategory)); ASSERT_EQ(TestOption.Categories.end(), find_if(TestOption.Categories, [&](const llvm::cl::OptionCategory *Cat) { return Cat == &cl::getGeneralCategory(); })) << "Failed to remove General Category."; ASSERT_NE(TestOption.Categories.end(), find_if(TestOption.Categories, [&](const llvm::cl::OptionCategory *Cat) { return Cat == &TestCategory; })) << "Failed to assign Option Category."; ASSERT_NE(TestOption.Categories.end(), find_if(TestOption.Categories, [&](const llvm::cl::OptionCategory *Cat) { return Cat == &AnotherCategory; })) << "Failed to assign Another Category."; } typedef void ParserFunction(StringRef Source, StringSaver &Saver, SmallVectorImpl &NewArgv, bool MarkEOLs); void testCommandLineTokenizer(ParserFunction *parse, StringRef Input, ArrayRef Output, bool MarkEOLs = false) { SmallVector Actual; BumpPtrAllocator A; StringSaver Saver(A); parse(Input, Saver, Actual, MarkEOLs); EXPECT_EQ(Output.size(), Actual.size()); for (unsigned I = 0, E = Actual.size(); I != E; ++I) { if (I < Output.size()) { EXPECT_STREQ(Output[I], Actual[I]); } } } TEST(CommandLineTest, TokenizeGNUCommandLine) { const char Input[] = "foo\\ bar \"foo bar\" \'foo bar\' 'foo\\\\bar' -DFOO=bar\\(\\) " "foo\"bar\"baz C:\\\\src\\\\foo.cpp \"C:\\src\\foo.cpp\""; const char *const Output[] = { "foo bar", "foo bar", "foo bar", "foo\\bar", "-DFOO=bar()", "foobarbaz", "C:\\src\\foo.cpp", "C:srcfoo.cpp"}; testCommandLineTokenizer(cl::TokenizeGNUCommandLine, Input, Output); } TEST(CommandLineTest, TokenizeWindowsCommandLine1) { const char Input[] = R"(a\b c\\d e\\"f g" h\"i j\\\"k "lmn" o pqr "st \"u" \v)"; const char *const Output[] = { "a\\b", "c\\\\d", "e\\f g", "h\"i", "j\\\"k", "lmn", "o", "pqr", "st \"u", "\\v" }; testCommandLineTokenizer(cl::TokenizeWindowsCommandLine, Input, Output); } TEST(CommandLineTest, TokenizeWindowsCommandLine2) { const char Input[] = "clang -c -DFOO=\"\"\"ABC\"\"\" x.cpp"; const char *const Output[] = { "clang", "-c", "-DFOO=\"ABC\"", "x.cpp"}; testCommandLineTokenizer(cl::TokenizeWindowsCommandLine, Input, Output); } TEST(CommandLineTest, TokenizeWindowsCommandLineQuotedLastArgument) { const char Input1[] = R"(a b c d "")"; const char *const Output1[] = {"a", "b", "c", "d", ""}; testCommandLineTokenizer(cl::TokenizeWindowsCommandLine, Input1, Output1); const char Input2[] = R"(a b c d ")"; const char *const Output2[] = {"a", "b", "c", "d"}; testCommandLineTokenizer(cl::TokenizeWindowsCommandLine, Input2, Output2); } TEST(CommandLineTest, TokenizeAndMarkEOLs) { // Clang uses EOL marking in response files to support options that consume // the rest of the arguments on the current line, but do not consume arguments // from subsequent lines. For example, given these rsp files contents: // /c /Zi /O2 // /Oy- /link /debug /opt:ref // /Zc:ThreadsafeStatics- // // clang-cl needs to treat "/debug /opt:ref" as linker flags, and everything // else as compiler flags. The tokenizer inserts nullptr sentinels into the // output so that clang-cl can find the end of the current line. const char Input[] = "clang -Xclang foo\n\nfoo\"bar\"baz\n x.cpp\n"; const char *const Output[] = {"clang", "-Xclang", "foo", nullptr, nullptr, "foobarbaz", nullptr, "x.cpp", nullptr}; testCommandLineTokenizer(cl::TokenizeWindowsCommandLine, Input, Output, /*MarkEOLs=*/true); testCommandLineTokenizer(cl::TokenizeGNUCommandLine, Input, Output, /*MarkEOLs=*/true); } TEST(CommandLineTest, TokenizeConfigFile1) { const char *Input = "\\"; const char *const Output[] = { "\\" }; testCommandLineTokenizer(cl::tokenizeConfigFile, Input, Output); } TEST(CommandLineTest, TokenizeConfigFile2) { const char *Input = "\\abc"; const char *const Output[] = { "abc" }; testCommandLineTokenizer(cl::tokenizeConfigFile, Input, Output); } TEST(CommandLineTest, TokenizeConfigFile3) { const char *Input = "abc\\"; const char *const Output[] = { "abc\\" }; testCommandLineTokenizer(cl::tokenizeConfigFile, Input, Output); } TEST(CommandLineTest, TokenizeConfigFile4) { const char *Input = "abc\\\n123"; const char *const Output[] = { "abc123" }; testCommandLineTokenizer(cl::tokenizeConfigFile, Input, Output); } TEST(CommandLineTest, TokenizeConfigFile5) { const char *Input = "abc\\\r\n123"; const char *const Output[] = { "abc123" }; testCommandLineTokenizer(cl::tokenizeConfigFile, Input, Output); } TEST(CommandLineTest, TokenizeConfigFile6) { const char *Input = "abc\\\n"; const char *const Output[] = { "abc" }; testCommandLineTokenizer(cl::tokenizeConfigFile, Input, Output); } TEST(CommandLineTest, TokenizeConfigFile7) { const char *Input = "abc\\\r\n"; const char *const Output[] = { "abc" }; testCommandLineTokenizer(cl::tokenizeConfigFile, Input, Output); } TEST(CommandLineTest, TokenizeConfigFile8) { SmallVector Actual; BumpPtrAllocator A; StringSaver Saver(A); cl::tokenizeConfigFile("\\\n", Saver, Actual, /*MarkEOLs=*/false); EXPECT_TRUE(Actual.empty()); } TEST(CommandLineTest, TokenizeConfigFile9) { SmallVector Actual; BumpPtrAllocator A; StringSaver Saver(A); cl::tokenizeConfigFile("\\\r\n", Saver, Actual, /*MarkEOLs=*/false); EXPECT_TRUE(Actual.empty()); } TEST(CommandLineTest, TokenizeConfigFile10) { const char *Input = "\\\nabc"; const char *const Output[] = { "abc" }; testCommandLineTokenizer(cl::tokenizeConfigFile, Input, Output); } TEST(CommandLineTest, TokenizeConfigFile11) { const char *Input = "\\\r\nabc"; const char *const Output[] = { "abc" }; testCommandLineTokenizer(cl::tokenizeConfigFile, Input, Output); } TEST(CommandLineTest, AliasesWithArguments) { static const size_t ARGC = 3; const char *const Inputs[][ARGC] = { { "-tool", "-actual=x", "-extra" }, { "-tool", "-actual", "x" }, { "-tool", "-alias=x", "-extra" }, { "-tool", "-alias", "x" } }; for (size_t i = 0, e = array_lengthof(Inputs); i < e; ++i) { StackOption Actual("actual"); StackOption Extra("extra"); StackOption Input(cl::Positional); cl::alias Alias("alias", llvm::cl::aliasopt(Actual)); cl::ParseCommandLineOptions(ARGC, Inputs[i]); EXPECT_EQ("x", Actual); EXPECT_EQ(0, Input.getNumOccurrences()); Alias.removeArgument(); } } void testAliasRequired(int argc, const char *const *argv) { StackOption Option("option", cl::Required); cl::alias Alias("o", llvm::cl::aliasopt(Option)); cl::ParseCommandLineOptions(argc, argv); EXPECT_EQ("x", Option); EXPECT_EQ(1, Option.getNumOccurrences()); Alias.removeArgument(); } TEST(CommandLineTest, AliasRequired) { const char *opts1[] = { "-tool", "-option=x" }; const char *opts2[] = { "-tool", "-o", "x" }; testAliasRequired(array_lengthof(opts1), opts1); testAliasRequired(array_lengthof(opts2), opts2); } TEST(CommandLineTest, HideUnrelatedOptions) { StackOption TestOption1("hide-option-1"); StackOption TestOption2("hide-option-2", cl::cat(TestCategory)); cl::HideUnrelatedOptions(TestCategory); ASSERT_EQ(cl::ReallyHidden, TestOption1.getOptionHiddenFlag()) << "Failed to hide extra option."; ASSERT_EQ(cl::NotHidden, TestOption2.getOptionHiddenFlag()) << "Hid extra option that should be visable."; StringMap &Map = cl::getRegisteredOptions(*cl::TopLevelSubCommand); ASSERT_EQ(cl::NotHidden, Map["help"]->getOptionHiddenFlag()) << "Hid default option that should be visable."; } cl::OptionCategory TestCategory2("Test Options set 2", "Description"); TEST(CommandLineTest, HideUnrelatedOptionsMulti) { StackOption TestOption1("multi-hide-option-1"); StackOption TestOption2("multi-hide-option-2", cl::cat(TestCategory)); StackOption TestOption3("multi-hide-option-3", cl::cat(TestCategory2)); const cl::OptionCategory *VisibleCategories[] = {&TestCategory, &TestCategory2}; cl::HideUnrelatedOptions(makeArrayRef(VisibleCategories)); ASSERT_EQ(cl::ReallyHidden, TestOption1.getOptionHiddenFlag()) << "Failed to hide extra option."; ASSERT_EQ(cl::NotHidden, TestOption2.getOptionHiddenFlag()) << "Hid extra option that should be visable."; ASSERT_EQ(cl::NotHidden, TestOption3.getOptionHiddenFlag()) << "Hid extra option that should be visable."; StringMap &Map = cl::getRegisteredOptions(*cl::TopLevelSubCommand); ASSERT_EQ(cl::NotHidden, Map["help"]->getOptionHiddenFlag()) << "Hid default option that should be visable."; } TEST(CommandLineTest, SetValueInSubcategories) { cl::ResetCommandLineParser(); StackSubCommand SC1("sc1", "First subcommand"); StackSubCommand SC2("sc2", "Second subcommand"); StackOption TopLevelOpt("top-level", cl::init(false)); StackOption SC1Opt("sc1", cl::sub(SC1), cl::init(false)); StackOption SC2Opt("sc2", cl::sub(SC2), cl::init(false)); EXPECT_FALSE(TopLevelOpt); EXPECT_FALSE(SC1Opt); EXPECT_FALSE(SC2Opt); const char *args[] = {"prog", "-top-level"}; EXPECT_TRUE( cl::ParseCommandLineOptions(2, args, StringRef(), &llvm::nulls())); EXPECT_TRUE(TopLevelOpt); EXPECT_FALSE(SC1Opt); EXPECT_FALSE(SC2Opt); TopLevelOpt = false; cl::ResetAllOptionOccurrences(); EXPECT_FALSE(TopLevelOpt); EXPECT_FALSE(SC1Opt); EXPECT_FALSE(SC2Opt); const char *args2[] = {"prog", "sc1", "-sc1"}; EXPECT_TRUE( cl::ParseCommandLineOptions(3, args2, StringRef(), &llvm::nulls())); EXPECT_FALSE(TopLevelOpt); EXPECT_TRUE(SC1Opt); EXPECT_FALSE(SC2Opt); SC1Opt = false; cl::ResetAllOptionOccurrences(); EXPECT_FALSE(TopLevelOpt); EXPECT_FALSE(SC1Opt); EXPECT_FALSE(SC2Opt); const char *args3[] = {"prog", "sc2", "-sc2"}; EXPECT_TRUE( cl::ParseCommandLineOptions(3, args3, StringRef(), &llvm::nulls())); EXPECT_FALSE(TopLevelOpt); EXPECT_FALSE(SC1Opt); EXPECT_TRUE(SC2Opt); } TEST(CommandLineTest, LookupFailsInWrongSubCommand) { cl::ResetCommandLineParser(); StackSubCommand SC1("sc1", "First subcommand"); StackSubCommand SC2("sc2", "Second subcommand"); StackOption SC1Opt("sc1", cl::sub(SC1), cl::init(false)); StackOption SC2Opt("sc2", cl::sub(SC2), cl::init(false)); std::string Errs; raw_string_ostream OS(Errs); const char *args[] = {"prog", "sc1", "-sc2"}; EXPECT_FALSE(cl::ParseCommandLineOptions(3, args, StringRef(), &OS)); OS.flush(); EXPECT_FALSE(Errs.empty()); } TEST(CommandLineTest, AddToAllSubCommands) { cl::ResetCommandLineParser(); StackSubCommand SC1("sc1", "First subcommand"); StackOption AllOpt("everywhere", cl::sub(*cl::AllSubCommands), cl::init(false)); StackSubCommand SC2("sc2", "Second subcommand"); const char *args[] = {"prog", "-everywhere"}; const char *args2[] = {"prog", "sc1", "-everywhere"}; const char *args3[] = {"prog", "sc2", "-everywhere"}; std::string Errs; raw_string_ostream OS(Errs); EXPECT_FALSE(AllOpt); EXPECT_TRUE(cl::ParseCommandLineOptions(2, args, StringRef(), &OS)); EXPECT_TRUE(AllOpt); AllOpt = false; cl::ResetAllOptionOccurrences(); EXPECT_FALSE(AllOpt); EXPECT_TRUE(cl::ParseCommandLineOptions(3, args2, StringRef(), &OS)); EXPECT_TRUE(AllOpt); AllOpt = false; cl::ResetAllOptionOccurrences(); EXPECT_FALSE(AllOpt); EXPECT_TRUE(cl::ParseCommandLineOptions(3, args3, StringRef(), &OS)); EXPECT_TRUE(AllOpt); // Since all parsing succeeded, the error message should be empty. OS.flush(); EXPECT_TRUE(Errs.empty()); } TEST(CommandLineTest, ReparseCommandLineOptions) { cl::ResetCommandLineParser(); StackOption TopLevelOpt("top-level", cl::sub(*cl::TopLevelSubCommand), cl::init(false)); const char *args[] = {"prog", "-top-level"}; EXPECT_FALSE(TopLevelOpt); EXPECT_TRUE( cl::ParseCommandLineOptions(2, args, StringRef(), &llvm::nulls())); EXPECT_TRUE(TopLevelOpt); TopLevelOpt = false; cl::ResetAllOptionOccurrences(); EXPECT_FALSE(TopLevelOpt); EXPECT_TRUE( cl::ParseCommandLineOptions(2, args, StringRef(), &llvm::nulls())); EXPECT_TRUE(TopLevelOpt); } TEST(CommandLineTest, RemoveFromRegularSubCommand) { cl::ResetCommandLineParser(); StackSubCommand SC("sc", "Subcommand"); StackOption RemoveOption("remove-option", cl::sub(SC), cl::init(false)); StackOption KeepOption("keep-option", cl::sub(SC), cl::init(false)); const char *args[] = {"prog", "sc", "-remove-option"}; std::string Errs; raw_string_ostream OS(Errs); EXPECT_FALSE(RemoveOption); EXPECT_TRUE(cl::ParseCommandLineOptions(3, args, StringRef(), &OS)); EXPECT_TRUE(RemoveOption); OS.flush(); EXPECT_TRUE(Errs.empty()); RemoveOption.removeArgument(); cl::ResetAllOptionOccurrences(); EXPECT_FALSE(cl::ParseCommandLineOptions(3, args, StringRef(), &OS)); OS.flush(); EXPECT_FALSE(Errs.empty()); } TEST(CommandLineTest, RemoveFromTopLevelSubCommand) { cl::ResetCommandLineParser(); StackOption TopLevelRemove( "top-level-remove", cl::sub(*cl::TopLevelSubCommand), cl::init(false)); StackOption TopLevelKeep( "top-level-keep", cl::sub(*cl::TopLevelSubCommand), cl::init(false)); const char *args[] = {"prog", "-top-level-remove"}; EXPECT_FALSE(TopLevelRemove); EXPECT_TRUE( cl::ParseCommandLineOptions(2, args, StringRef(), &llvm::nulls())); EXPECT_TRUE(TopLevelRemove); TopLevelRemove.removeArgument(); cl::ResetAllOptionOccurrences(); EXPECT_FALSE( cl::ParseCommandLineOptions(2, args, StringRef(), &llvm::nulls())); } TEST(CommandLineTest, RemoveFromAllSubCommands) { cl::ResetCommandLineParser(); StackSubCommand SC1("sc1", "First Subcommand"); StackSubCommand SC2("sc2", "Second Subcommand"); StackOption RemoveOption("remove-option", cl::sub(*cl::AllSubCommands), cl::init(false)); StackOption KeepOption("keep-option", cl::sub(*cl::AllSubCommands), cl::init(false)); const char *args0[] = {"prog", "-remove-option"}; const char *args1[] = {"prog", "sc1", "-remove-option"}; const char *args2[] = {"prog", "sc2", "-remove-option"}; // It should work for all subcommands including the top-level. EXPECT_FALSE(RemoveOption); EXPECT_TRUE( cl::ParseCommandLineOptions(2, args0, StringRef(), &llvm::nulls())); EXPECT_TRUE(RemoveOption); RemoveOption = false; cl::ResetAllOptionOccurrences(); EXPECT_FALSE(RemoveOption); EXPECT_TRUE( cl::ParseCommandLineOptions(3, args1, StringRef(), &llvm::nulls())); EXPECT_TRUE(RemoveOption); RemoveOption = false; cl::ResetAllOptionOccurrences(); EXPECT_FALSE(RemoveOption); EXPECT_TRUE( cl::ParseCommandLineOptions(3, args2, StringRef(), &llvm::nulls())); EXPECT_TRUE(RemoveOption); RemoveOption.removeArgument(); // It should not work for any subcommands including the top-level. cl::ResetAllOptionOccurrences(); EXPECT_FALSE( cl::ParseCommandLineOptions(2, args0, StringRef(), &llvm::nulls())); cl::ResetAllOptionOccurrences(); EXPECT_FALSE( cl::ParseCommandLineOptions(3, args1, StringRef(), &llvm::nulls())); cl::ResetAllOptionOccurrences(); EXPECT_FALSE( cl::ParseCommandLineOptions(3, args2, StringRef(), &llvm::nulls())); } TEST(CommandLineTest, GetRegisteredSubcommands) { cl::ResetCommandLineParser(); StackSubCommand SC1("sc1", "First Subcommand"); StackOption Opt1("opt1", cl::sub(SC1), cl::init(false)); StackSubCommand SC2("sc2", "Second subcommand"); StackOption Opt2("opt2", cl::sub(SC2), cl::init(false)); const char *args0[] = {"prog", "sc1"}; const char *args1[] = {"prog", "sc2"}; EXPECT_TRUE( cl::ParseCommandLineOptions(2, args0, StringRef(), &llvm::nulls())); EXPECT_FALSE(Opt1); EXPECT_FALSE(Opt2); for (auto *S : cl::getRegisteredSubcommands()) { if (*S) { EXPECT_EQ("sc1", S->getName()); } } cl::ResetAllOptionOccurrences(); EXPECT_TRUE( cl::ParseCommandLineOptions(2, args1, StringRef(), &llvm::nulls())); EXPECT_FALSE(Opt1); EXPECT_FALSE(Opt2); for (auto *S : cl::getRegisteredSubcommands()) { if (*S) { EXPECT_EQ("sc2", S->getName()); } } } TEST(CommandLineTest, DefaultOptions) { cl::ResetCommandLineParser(); StackOption Bar("bar", cl::sub(*cl::AllSubCommands), cl::DefaultOption); StackOption Bar_Alias( "b", cl::desc("Alias for -bar"), cl::aliasopt(Bar), cl::DefaultOption); StackOption Foo("foo", cl::init(false), cl::sub(*cl::AllSubCommands), cl::DefaultOption); StackOption Foo_Alias("f", cl::desc("Alias for -foo"), cl::aliasopt(Foo), cl::DefaultOption); StackSubCommand SC1("sc1", "First Subcommand"); // Override "-b" and change type in sc1 SubCommand. StackOption SC1_B("b", cl::sub(SC1), cl::init(false)); StackSubCommand SC2("sc2", "Second subcommand"); // Override "-foo" and change type in sc2 SubCommand. Note that this does not // affect "-f" alias, which continues to work correctly. StackOption SC2_Foo("foo", cl::sub(SC2)); const char *args0[] = {"prog", "-b", "args0 bar string", "-f"}; EXPECT_TRUE(cl::ParseCommandLineOptions(sizeof(args0) / sizeof(char *), args0, StringRef(), &llvm::nulls())); EXPECT_TRUE(Bar == "args0 bar string"); EXPECT_TRUE(Foo); EXPECT_FALSE(SC1_B); EXPECT_TRUE(SC2_Foo.empty()); cl::ResetAllOptionOccurrences(); const char *args1[] = {"prog", "sc1", "-b", "-bar", "args1 bar string", "-f"}; EXPECT_TRUE(cl::ParseCommandLineOptions(sizeof(args1) / sizeof(char *), args1, StringRef(), &llvm::nulls())); EXPECT_TRUE(Bar == "args1 bar string"); EXPECT_TRUE(Foo); EXPECT_TRUE(SC1_B); EXPECT_TRUE(SC2_Foo.empty()); for (auto *S : cl::getRegisteredSubcommands()) { if (*S) { EXPECT_EQ("sc1", S->getName()); } } cl::ResetAllOptionOccurrences(); const char *args2[] = {"prog", "sc2", "-b", "args2 bar string", "-f", "-foo", "foo string"}; EXPECT_TRUE(cl::ParseCommandLineOptions(sizeof(args2) / sizeof(char *), args2, StringRef(), &llvm::nulls())); EXPECT_TRUE(Bar == "args2 bar string"); EXPECT_TRUE(Foo); EXPECT_FALSE(SC1_B); EXPECT_TRUE(SC2_Foo == "foo string"); for (auto *S : cl::getRegisteredSubcommands()) { if (*S) { EXPECT_EQ("sc2", S->getName()); } } cl::ResetCommandLineParser(); } TEST(CommandLineTest, ArgumentLimit) { std::string args(32 * 4096, 'a'); EXPECT_FALSE(llvm::sys::commandLineFitsWithinSystemLimits("cl", args.data())); std::string args2(256, 'a'); EXPECT_TRUE(llvm::sys::commandLineFitsWithinSystemLimits("cl", args2.data())); if (Triple(sys::getProcessTriple()).isOSWindows()) { // We use 32000 as a limit for command line length. Program name ('cl'), // separating spaces and termination null character occupy 5 symbols. std::string long_arg(32000 - 5, 'b'); EXPECT_TRUE( llvm::sys::commandLineFitsWithinSystemLimits("cl", long_arg.data())); long_arg += 'b'; EXPECT_FALSE( llvm::sys::commandLineFitsWithinSystemLimits("cl", long_arg.data())); } } TEST(CommandLineTest, ResponseFileWindows) { if (!Triple(sys::getProcessTriple()).isOSWindows()) return; StackOption> InputFilenames( cl::Positional, cl::desc(""), cl::ZeroOrMore); StackOption TopLevelOpt("top-level", cl::init(false)); // Create response file. TempFile ResponseFile("resp-", ".txt", "-top-level\npath\\dir\\file1\npath/dir/file2", /*Unique*/ true); llvm::SmallString<128> RspOpt; RspOpt.append(1, '@'); RspOpt.append(ResponseFile.path()); const char *args[] = {"prog", RspOpt.c_str()}; EXPECT_FALSE(TopLevelOpt); EXPECT_TRUE( cl::ParseCommandLineOptions(2, args, StringRef(), &llvm::nulls())); EXPECT_TRUE(TopLevelOpt); EXPECT_TRUE(InputFilenames[0] == "path\\dir\\file1"); EXPECT_TRUE(InputFilenames[1] == "path/dir/file2"); } TEST(CommandLineTest, ResponseFiles) { vfs::InMemoryFileSystem FS; #ifdef _WIN32 const char *TestRoot = "C:\\"; #else const char *TestRoot = "/"; #endif FS.setCurrentWorkingDirectory(TestRoot); // Create included response file of first level. llvm::StringRef IncludedFileName = "resp1"; FS.addFile(IncludedFileName, 0, llvm::MemoryBuffer::getMemBuffer("-option_1 -option_2\n" "@incdir/resp2\n" "-option_3=abcd\n" "@incdir/resp3\n" "-option_4=efjk\n")); // Directory for included file. llvm::StringRef IncDir = "incdir"; // Create included response file of second level. llvm::SmallString<128> IncludedFileName2; llvm::sys::path::append(IncludedFileName2, IncDir, "resp2"); FS.addFile(IncludedFileName2, 0, MemoryBuffer::getMemBuffer("-option_21 -option_22\n" "-option_23=abcd\n")); // Create second included response file of second level. llvm::SmallString<128> IncludedFileName3; llvm::sys::path::append(IncludedFileName3, IncDir, "resp3"); FS.addFile(IncludedFileName3, 0, MemoryBuffer::getMemBuffer("-option_31 -option_32\n" "-option_33=abcd\n")); // Prepare 'file' with reference to response file. SmallString<128> IncRef; IncRef.append(1, '@'); IncRef.append(IncludedFileName); llvm::SmallVector Argv = {"test/test", "-flag_1", IncRef.c_str(), "-flag_2"}; // Expand response files. llvm::BumpPtrAllocator A; llvm::StringSaver Saver(A); ASSERT_TRUE(llvm::cl::ExpandResponseFiles( Saver, llvm::cl::TokenizeGNUCommandLine, Argv, false, true, /*CurrentDir=*/StringRef(TestRoot), FS)); EXPECT_THAT(Argv, testing::Pointwise( StringEquality(), {"test/test", "-flag_1", "-option_1", "-option_2", "-option_21", "-option_22", "-option_23=abcd", "-option_3=abcd", "-option_31", "-option_32", "-option_33=abcd", "-option_4=efjk", "-flag_2"})); } TEST(CommandLineTest, RecursiveResponseFiles) { vfs::InMemoryFileSystem FS; #ifdef _WIN32 const char *TestRoot = "C:\\"; #else const char *TestRoot = "/"; #endif FS.setCurrentWorkingDirectory(TestRoot); StringRef SelfFilePath = "self.rsp"; std::string SelfFileRef = ("@" + SelfFilePath).str(); StringRef NestedFilePath = "nested.rsp"; std::string NestedFileRef = ("@" + NestedFilePath).str(); StringRef FlagFilePath = "flag.rsp"; std::string FlagFileRef = ("@" + FlagFilePath).str(); std::string SelfFileContents; raw_string_ostream SelfFile(SelfFileContents); SelfFile << "-option_1\n"; SelfFile << FlagFileRef << "\n"; SelfFile << NestedFileRef << "\n"; SelfFile << SelfFileRef << "\n"; FS.addFile(SelfFilePath, 0, MemoryBuffer::getMemBuffer(SelfFile.str())); std::string NestedFileContents; raw_string_ostream NestedFile(NestedFileContents); NestedFile << "-option_2\n"; NestedFile << FlagFileRef << "\n"; NestedFile << SelfFileRef << "\n"; NestedFile << NestedFileRef << "\n"; FS.addFile(NestedFilePath, 0, MemoryBuffer::getMemBuffer(NestedFile.str())); std::string FlagFileContents; raw_string_ostream FlagFile(FlagFileContents); FlagFile << "-option_x\n"; FS.addFile(FlagFilePath, 0, MemoryBuffer::getMemBuffer(FlagFile.str())); // Ensure: // Recursive expansion terminates // Recursive files never expand // Non-recursive repeats are allowed SmallVector Argv = {"test/test", SelfFileRef.c_str(), "-option_3"}; BumpPtrAllocator A; StringSaver Saver(A); #ifdef _WIN32 cl::TokenizerCallback Tokenizer = cl::TokenizeWindowsCommandLine; #else cl::TokenizerCallback Tokenizer = cl::TokenizeGNUCommandLine; #endif ASSERT_FALSE(cl::ExpandResponseFiles(Saver, Tokenizer, Argv, false, false, /*CurrentDir=*/llvm::StringRef(TestRoot), FS)); EXPECT_THAT(Argv, testing::Pointwise(StringEquality(), {"test/test", "-option_1", "-option_x", "-option_2", "-option_x", SelfFileRef.c_str(), NestedFileRef.c_str(), SelfFileRef.c_str(), "-option_3"})); } TEST(CommandLineTest, ResponseFilesAtArguments) { vfs::InMemoryFileSystem FS; #ifdef _WIN32 const char *TestRoot = "C:\\"; #else const char *TestRoot = "/"; #endif FS.setCurrentWorkingDirectory(TestRoot); StringRef ResponseFilePath = "test.rsp"; std::string ResponseFileContents; raw_string_ostream ResponseFile(ResponseFileContents); ResponseFile << "-foo" << "\n"; ResponseFile << "-bar" << "\n"; FS.addFile(ResponseFilePath, 0, MemoryBuffer::getMemBuffer(ResponseFile.str())); // Ensure we expand rsp files after lots of non-rsp arguments starting with @. constexpr size_t NON_RSP_AT_ARGS = 64; SmallVector Argv = {"test/test"}; Argv.append(NON_RSP_AT_ARGS, "@non_rsp_at_arg"); std::string ResponseFileRef = ("@" + ResponseFilePath).str(); Argv.push_back(ResponseFileRef.c_str()); BumpPtrAllocator A; StringSaver Saver(A); ASSERT_FALSE(cl::ExpandResponseFiles(Saver, cl::TokenizeGNUCommandLine, Argv, false, false, /*CurrentDir=*/StringRef(TestRoot), FS)); // ASSERT instead of EXPECT to prevent potential out-of-bounds access. ASSERT_EQ(Argv.size(), 1 + NON_RSP_AT_ARGS + 2); size_t i = 0; EXPECT_STREQ(Argv[i++], "test/test"); for (; i < 1 + NON_RSP_AT_ARGS; ++i) EXPECT_STREQ(Argv[i], "@non_rsp_at_arg"); EXPECT_STREQ(Argv[i++], "-foo"); EXPECT_STREQ(Argv[i++], "-bar"); } TEST(CommandLineTest, ResponseFileRelativePath) { vfs::InMemoryFileSystem FS; #ifdef _WIN32 const char *TestRoot = "C:\\"; #else const char *TestRoot = "//net"; #endif FS.setCurrentWorkingDirectory(TestRoot); StringRef OuterFile = "dir/outer.rsp"; StringRef OuterFileContents = "@inner.rsp"; FS.addFile(OuterFile, 0, MemoryBuffer::getMemBuffer(OuterFileContents)); StringRef InnerFile = "dir/inner.rsp"; StringRef InnerFileContents = "-flag"; FS.addFile(InnerFile, 0, MemoryBuffer::getMemBuffer(InnerFileContents)); SmallVector Argv = {"test/test", "@dir/outer.rsp"}; BumpPtrAllocator A; StringSaver Saver(A); ASSERT_TRUE(cl::ExpandResponseFiles(Saver, cl::TokenizeGNUCommandLine, Argv, false, true, /*CurrentDir=*/StringRef(TestRoot), FS)); EXPECT_THAT(Argv, testing::Pointwise(StringEquality(), {"test/test", "-flag"})); } TEST(CommandLineTest, ResponseFileEOLs) { vfs::InMemoryFileSystem FS; #ifdef _WIN32 const char *TestRoot = "C:\\"; #else const char *TestRoot = "//net"; #endif FS.setCurrentWorkingDirectory(TestRoot); FS.addFile("eols.rsp", 0, MemoryBuffer::getMemBuffer("-Xclang -Wno-whatever\n input.cpp")); SmallVector Argv = {"clang", "@eols.rsp"}; BumpPtrAllocator A; StringSaver Saver(A); ASSERT_TRUE(cl::ExpandResponseFiles(Saver, cl::TokenizeWindowsCommandLine, Argv, true, true, /*CurrentDir=*/StringRef(TestRoot), FS)); const char *Expected[] = {"clang", "-Xclang", "-Wno-whatever", nullptr, "input.cpp"}; ASSERT_EQ(array_lengthof(Expected), Argv.size()); for (size_t I = 0, E = array_lengthof(Expected); I < E; ++I) { if (Expected[I] == nullptr) { ASSERT_EQ(Argv[I], nullptr); } else { ASSERT_STREQ(Expected[I], Argv[I]); } } } TEST(CommandLineTest, SetDefautValue) { cl::ResetCommandLineParser(); StackOption Opt1("opt1", cl::init("true")); StackOption Opt2("opt2", cl::init(true)); cl::alias Alias("alias", llvm::cl::aliasopt(Opt2)); StackOption Opt3("opt3", cl::init(3)); const char *args[] = {"prog", "-opt1=false", "-opt2", "-opt3"}; EXPECT_TRUE( cl::ParseCommandLineOptions(2, args, StringRef(), &llvm::nulls())); EXPECT_TRUE(Opt1 == "false"); EXPECT_TRUE(Opt2); EXPECT_TRUE(Opt3 == 3); Opt2 = false; Opt3 = 1; cl::ResetAllOptionOccurrences(); for (auto &OM : cl::getRegisteredOptions(*cl::TopLevelSubCommand)) { cl::Option *O = OM.second; if (O->ArgStr == "opt2") { continue; } O->setDefault(); } EXPECT_TRUE(Opt1 == "true"); EXPECT_TRUE(Opt2); EXPECT_TRUE(Opt3 == 3); Alias.removeArgument(); } TEST(CommandLineTest, ReadConfigFile) { llvm::SmallVector Argv; TempDir TestDir("unittest", /*Unique*/ true); llvm::SmallString<128> TestCfg; llvm::sys::path::append(TestCfg, TestDir.path(), "foo"); TempFile ConfigFile(TestCfg, "", "# Comment\n" "-option_1\n" "@subconfig\n" "-option_3=abcd\n" "-option_4=\\\n" "cdef\n"); llvm::SmallString<128> TestCfg2; llvm::sys::path::append(TestCfg2, TestDir.path(), "subconfig"); TempFile ConfigFile2(TestCfg2, "", "-option_2\n" "\n" " # comment\n"); // Make sure the current directory is not the directory where config files // resides. In this case the code that expands response files will not find // 'subconfig' unless it resolves nested inclusions relative to the including // file. llvm::SmallString<128> CurrDir; std::error_code EC = llvm::sys::fs::current_path(CurrDir); EXPECT_TRUE(!EC); EXPECT_NE(CurrDir.str(), TestDir.path()); llvm::BumpPtrAllocator A; llvm::StringSaver Saver(A); bool Result = llvm::cl::readConfigFile(ConfigFile.path(), Saver, Argv); EXPECT_TRUE(Result); EXPECT_EQ(Argv.size(), 4U); EXPECT_STREQ(Argv[0], "-option_1"); EXPECT_STREQ(Argv[1], "-option_2"); EXPECT_STREQ(Argv[2], "-option_3=abcd"); EXPECT_STREQ(Argv[3], "-option_4=cdef"); } TEST(CommandLineTest, PositionalEatArgsError) { cl::ResetCommandLineParser(); StackOption> PosEatArgs( "positional-eat-args", cl::Positional, cl::desc("..."), cl::ZeroOrMore, cl::PositionalEatsArgs); StackOption> PosEatArgs2( "positional-eat-args2", cl::Positional, cl::desc("Some strings"), cl::ZeroOrMore, cl::PositionalEatsArgs); const char *args[] = {"prog", "-positional-eat-args=XXXX"}; const char *args2[] = {"prog", "-positional-eat-args=XXXX", "-foo"}; const char *args3[] = {"prog", "-positional-eat-args", "-foo"}; const char *args4[] = {"prog", "-positional-eat-args", "-foo", "-positional-eat-args2", "-bar", "foo"}; std::string Errs; raw_string_ostream OS(Errs); EXPECT_FALSE(cl::ParseCommandLineOptions(2, args, StringRef(), &OS)); OS.flush(); EXPECT_FALSE(Errs.empty()); Errs.clear(); EXPECT_FALSE(cl::ParseCommandLineOptions(3, args2, StringRef(), &OS)); OS.flush(); EXPECT_FALSE(Errs.empty()); Errs.clear(); EXPECT_TRUE(cl::ParseCommandLineOptions(3, args3, StringRef(), &OS)); OS.flush(); EXPECT_TRUE(Errs.empty()); Errs.clear(); cl::ResetAllOptionOccurrences(); EXPECT_TRUE(cl::ParseCommandLineOptions(6, args4, StringRef(), &OS)); OS.flush(); EXPECT_TRUE(PosEatArgs.size() == 1); EXPECT_TRUE(PosEatArgs2.size() == 2); EXPECT_TRUE(Errs.empty()); } #ifdef _WIN32 TEST(CommandLineTest, GetCommandLineArguments) { int argc = __argc; char **argv = __argv; // GetCommandLineArguments is called in InitLLVM. llvm::InitLLVM X(argc, argv); EXPECT_EQ(llvm::sys::path::is_absolute(argv[0]), llvm::sys::path::is_absolute(__argv[0])); EXPECT_TRUE( llvm::sys::path::filename(argv[0]).equals_insensitive("supporttests.exe")) << "Filename of test executable is " << llvm::sys::path::filename(argv[0]); } #endif class OutputRedirector { public: OutputRedirector(int RedirectFD) : RedirectFD(RedirectFD), OldFD(dup(RedirectFD)) { if (OldFD == -1 || sys::fs::createTemporaryFile("unittest-redirect", "", NewFD, FilePath) || dup2(NewFD, RedirectFD) == -1) Valid = false; } ~OutputRedirector() { dup2(OldFD, RedirectFD); close(OldFD); close(NewFD); } SmallVector FilePath; bool Valid = true; private: int RedirectFD; int OldFD; int NewFD; }; struct AutoDeleteFile { SmallVector FilePath; ~AutoDeleteFile() { if (!FilePath.empty()) sys::fs::remove(std::string(FilePath.data(), FilePath.size())); } }; class PrintOptionInfoTest : public ::testing::Test { public: // Return std::string because the output of a failing EXPECT check is // unreadable for StringRef. It also avoids any lifetime issues. template std::string runTest(Ts... OptionAttributes) { outs().flush(); // flush any output from previous tests AutoDeleteFile File; { OutputRedirector Stdout(fileno(stdout)); if (!Stdout.Valid) return ""; File.FilePath = Stdout.FilePath; StackOption TestOption(Opt, cl::desc(HelpText), OptionAttributes...); printOptionInfo(TestOption, 26); outs().flush(); } auto Buffer = MemoryBuffer::getFile(File.FilePath); if (!Buffer) return ""; return Buffer->get()->getBuffer().str(); } enum class OptionValue { Val }; const StringRef Opt = "some-option"; const StringRef HelpText = "some help"; private: // This is a workaround for cl::Option sub-classes having their // printOptionInfo functions private. void printOptionInfo(const cl::Option &O, size_t Width) { O.printOptionInfo(Width); } }; TEST_F(PrintOptionInfoTest, PrintOptionInfoValueOptionalWithoutSentinel) { std::string Output = runTest(cl::ValueOptional, cl::values(clEnumValN(OptionValue::Val, "v1", "desc1"))); // clang-format off EXPECT_EQ(Output, (" --" + Opt + "= - " + HelpText + "\n" " =v1 - desc1\n") .str()); // clang-format on } TEST_F(PrintOptionInfoTest, PrintOptionInfoValueOptionalWithSentinel) { std::string Output = runTest( cl::ValueOptional, cl::values(clEnumValN(OptionValue::Val, "v1", "desc1"), clEnumValN(OptionValue::Val, "", ""))); // clang-format off EXPECT_EQ(Output, (" --" + Opt + " - " + HelpText + "\n" " --" + Opt + "= - " + HelpText + "\n" " =v1 - desc1\n") .str()); // clang-format on } TEST_F(PrintOptionInfoTest, PrintOptionInfoValueOptionalWithSentinelWithHelp) { std::string Output = runTest( cl::ValueOptional, cl::values(clEnumValN(OptionValue::Val, "v1", "desc1"), clEnumValN(OptionValue::Val, "", "desc2"))); // clang-format off EXPECT_EQ(Output, (" --" + Opt + " - " + HelpText + "\n" " --" + Opt + "= - " + HelpText + "\n" " =v1 - desc1\n" " = - desc2\n") .str()); // clang-format on } TEST_F(PrintOptionInfoTest, PrintOptionInfoValueRequiredWithEmptyValueName) { std::string Output = runTest( cl::ValueRequired, cl::values(clEnumValN(OptionValue::Val, "v1", "desc1"), clEnumValN(OptionValue::Val, "", ""))); // clang-format off EXPECT_EQ(Output, (" --" + Opt + "= - " + HelpText + "\n" " =v1 - desc1\n" " =\n") .str()); // clang-format on } TEST_F(PrintOptionInfoTest, PrintOptionInfoEmptyValueDescription) { std::string Output = runTest( cl::ValueRequired, cl::values(clEnumValN(OptionValue::Val, "v1", ""))); // clang-format off EXPECT_EQ(Output, (" --" + Opt + "= - " + HelpText + "\n" " =v1\n").str()); // clang-format on } TEST_F(PrintOptionInfoTest, PrintOptionInfoMultilineValueDescription) { std::string Output = runTest(cl::ValueRequired, cl::values(clEnumValN(OptionValue::Val, "v1", "This is the first enum value\n" "which has a really long description\n" "thus it is multi-line."), clEnumValN(OptionValue::Val, "", "This is an unnamed enum value option\n" "Should be indented as well"))); // clang-format off EXPECT_EQ(Output, (" --" + Opt + "= - " + HelpText + "\n" " =v1 - This is the first enum value\n" " which has a really long description\n" " thus it is multi-line.\n" " = - This is an unnamed enum value option\n" " Should be indented as well\n").str()); // clang-format on } class GetOptionWidthTest : public ::testing::Test { public: enum class OptionValue { Val }; template size_t runTest(StringRef ArgName, Ts... OptionAttributes) { StackOption TestOption(ArgName, cl::desc("some help"), OptionAttributes...); return getOptionWidth(TestOption); } private: // This is a workaround for cl::Option sub-classes having their // printOptionInfo // functions private. size_t getOptionWidth(const cl::Option &O) { return O.getOptionWidth(); } }; TEST_F(GetOptionWidthTest, GetOptionWidthArgNameLonger) { StringRef ArgName("a-long-argument-name"); size_t ExpectedStrSize = (" --" + ArgName + "= - ").str().size(); EXPECT_EQ( runTest(ArgName, cl::values(clEnumValN(OptionValue::Val, "v", "help"))), ExpectedStrSize); } TEST_F(GetOptionWidthTest, GetOptionWidthFirstOptionNameLonger) { StringRef OptName("a-long-option-name"); size_t ExpectedStrSize = (" =" + OptName + " - ").str().size(); EXPECT_EQ( runTest("a", cl::values(clEnumValN(OptionValue::Val, OptName, "help"), clEnumValN(OptionValue::Val, "b", "help"))), ExpectedStrSize); } TEST_F(GetOptionWidthTest, GetOptionWidthSecondOptionNameLonger) { StringRef OptName("a-long-option-name"); size_t ExpectedStrSize = (" =" + OptName + " - ").str().size(); EXPECT_EQ( runTest("a", cl::values(clEnumValN(OptionValue::Val, "b", "help"), clEnumValN(OptionValue::Val, OptName, "help"))), ExpectedStrSize); } TEST_F(GetOptionWidthTest, GetOptionWidthEmptyOptionNameLonger) { size_t ExpectedStrSize = StringRef(" = - ").size(); // The length of a= (including indentation) is actually the same as the // = string, so it is impossible to distinguish via testing the case // where the empty string is picked from where the option name is picked. EXPECT_EQ(runTest("a", cl::values(clEnumValN(OptionValue::Val, "b", "help"), clEnumValN(OptionValue::Val, "", "help"))), ExpectedStrSize); } TEST_F(GetOptionWidthTest, GetOptionWidthValueOptionalEmptyOptionWithNoDescription) { StringRef ArgName("a"); // The length of a= (including indentation) is actually the same as the // = string, so it is impossible to distinguish via testing the case // where the empty string is ignored from where it is not ignored. // The dash will not actually be printed, but the space it would take up is // included to ensure a consistent column width. size_t ExpectedStrSize = (" -" + ArgName + "= - ").str().size(); EXPECT_EQ(runTest(ArgName, cl::ValueOptional, cl::values(clEnumValN(OptionValue::Val, "value", "help"), clEnumValN(OptionValue::Val, "", ""))), ExpectedStrSize); } TEST_F(GetOptionWidthTest, GetOptionWidthValueRequiredEmptyOptionWithNoDescription) { // The length of a= (including indentation) is actually the same as the // = string, so it is impossible to distinguish via testing the case // where the empty string is picked from where the option name is picked size_t ExpectedStrSize = StringRef(" = - ").size(); EXPECT_EQ(runTest("a", cl::ValueRequired, cl::values(clEnumValN(OptionValue::Val, "value", "help"), clEnumValN(OptionValue::Val, "", ""))), ExpectedStrSize); } TEST(CommandLineTest, PrefixOptions) { cl::ResetCommandLineParser(); StackOption> IncludeDirs( "I", cl::Prefix, cl::desc("Declare an include directory")); // Test non-prefixed variant works with cl::Prefix options. EXPECT_TRUE(IncludeDirs.empty()); const char *args[] = {"prog", "-I=/usr/include"}; EXPECT_TRUE( cl::ParseCommandLineOptions(2, args, StringRef(), &llvm::nulls())); EXPECT_TRUE(IncludeDirs.size() == 1); EXPECT_TRUE(IncludeDirs.front().compare("/usr/include") == 0); IncludeDirs.erase(IncludeDirs.begin()); cl::ResetAllOptionOccurrences(); // Test non-prefixed variant works with cl::Prefix options when value is // passed in following argument. EXPECT_TRUE(IncludeDirs.empty()); const char *args2[] = {"prog", "-I", "/usr/include"}; EXPECT_TRUE( cl::ParseCommandLineOptions(3, args2, StringRef(), &llvm::nulls())); EXPECT_TRUE(IncludeDirs.size() == 1); EXPECT_TRUE(IncludeDirs.front().compare("/usr/include") == 0); IncludeDirs.erase(IncludeDirs.begin()); cl::ResetAllOptionOccurrences(); // Test prefixed variant works with cl::Prefix options. EXPECT_TRUE(IncludeDirs.empty()); const char *args3[] = {"prog", "-I/usr/include"}; EXPECT_TRUE( cl::ParseCommandLineOptions(2, args3, StringRef(), &llvm::nulls())); EXPECT_TRUE(IncludeDirs.size() == 1); EXPECT_TRUE(IncludeDirs.front().compare("/usr/include") == 0); StackOption> MacroDefs( "D", cl::AlwaysPrefix, cl::desc("Define a macro"), cl::value_desc("MACRO[=VALUE]")); cl::ResetAllOptionOccurrences(); // Test non-prefixed variant does not work with cl::AlwaysPrefix options: // equal sign is part of the value. EXPECT_TRUE(MacroDefs.empty()); const char *args4[] = {"prog", "-D=HAVE_FOO"}; EXPECT_TRUE( cl::ParseCommandLineOptions(2, args4, StringRef(), &llvm::nulls())); EXPECT_TRUE(MacroDefs.size() == 1); EXPECT_TRUE(MacroDefs.front().compare("=HAVE_FOO") == 0); MacroDefs.erase(MacroDefs.begin()); cl::ResetAllOptionOccurrences(); // Test non-prefixed variant does not allow value to be passed in following // argument with cl::AlwaysPrefix options. EXPECT_TRUE(MacroDefs.empty()); const char *args5[] = {"prog", "-D", "HAVE_FOO"}; EXPECT_FALSE( cl::ParseCommandLineOptions(3, args5, StringRef(), &llvm::nulls())); EXPECT_TRUE(MacroDefs.empty()); cl::ResetAllOptionOccurrences(); // Test prefixed variant works with cl::AlwaysPrefix options. EXPECT_TRUE(MacroDefs.empty()); const char *args6[] = {"prog", "-DHAVE_FOO"}; EXPECT_TRUE( cl::ParseCommandLineOptions(2, args6, StringRef(), &llvm::nulls())); EXPECT_TRUE(MacroDefs.size() == 1); EXPECT_TRUE(MacroDefs.front().compare("HAVE_FOO") == 0); } TEST(CommandLineTest, GroupingWithValue) { cl::ResetCommandLineParser(); StackOption OptF("f", cl::Grouping, cl::desc("Some flag")); StackOption OptB("b", cl::Grouping, cl::desc("Another flag")); StackOption OptD("d", cl::Grouping, cl::ValueDisallowed, cl::desc("ValueDisallowed option")); StackOption OptV("v", cl::Grouping, cl::desc("ValueRequired option")); StackOption OptO("o", cl::Grouping, cl::ValueOptional, cl::desc("ValueOptional option")); // Should be possible to use an option which requires a value // at the end of a group. const char *args1[] = {"prog", "-fv", "val1"}; EXPECT_TRUE( cl::ParseCommandLineOptions(3, args1, StringRef(), &llvm::nulls())); EXPECT_TRUE(OptF); EXPECT_STREQ("val1", OptV.c_str()); OptV.clear(); cl::ResetAllOptionOccurrences(); // Should not crash if it is accidentally used elsewhere in the group. const char *args2[] = {"prog", "-vf", "val2"}; EXPECT_FALSE( cl::ParseCommandLineOptions(3, args2, StringRef(), &llvm::nulls())); OptV.clear(); cl::ResetAllOptionOccurrences(); // Should allow the "opt=value" form at the end of the group const char *args3[] = {"prog", "-fv=val3"}; EXPECT_TRUE( cl::ParseCommandLineOptions(2, args3, StringRef(), &llvm::nulls())); EXPECT_TRUE(OptF); EXPECT_STREQ("val3", OptV.c_str()); OptV.clear(); cl::ResetAllOptionOccurrences(); // Should allow assigning a value for a ValueOptional option // at the end of the group const char *args4[] = {"prog", "-fo=val4"}; EXPECT_TRUE( cl::ParseCommandLineOptions(2, args4, StringRef(), &llvm::nulls())); EXPECT_TRUE(OptF); EXPECT_STREQ("val4", OptO.c_str()); OptO.clear(); cl::ResetAllOptionOccurrences(); // Should assign an empty value if a ValueOptional option is used elsewhere // in the group. const char *args5[] = {"prog", "-fob"}; EXPECT_TRUE( cl::ParseCommandLineOptions(2, args5, StringRef(), &llvm::nulls())); EXPECT_TRUE(OptF); EXPECT_EQ(1, OptO.getNumOccurrences()); EXPECT_EQ(1, OptB.getNumOccurrences()); EXPECT_TRUE(OptO.empty()); cl::ResetAllOptionOccurrences(); // Should not allow an assignment for a ValueDisallowed option. const char *args6[] = {"prog", "-fd=false"}; EXPECT_FALSE( cl::ParseCommandLineOptions(2, args6, StringRef(), &llvm::nulls())); } TEST(CommandLineTest, GroupingAndPrefix) { cl::ResetCommandLineParser(); StackOption OptF("f", cl::Grouping, cl::desc("Some flag")); StackOption OptB("b", cl::Grouping, cl::desc("Another flag")); StackOption OptP("p", cl::Prefix, cl::Grouping, cl::desc("Prefix and Grouping")); StackOption OptA("a", cl::AlwaysPrefix, cl::Grouping, cl::desc("AlwaysPrefix and Grouping")); // Should be possible to use a cl::Prefix option without grouping. const char *args1[] = {"prog", "-pval1"}; EXPECT_TRUE( cl::ParseCommandLineOptions(2, args1, StringRef(), &llvm::nulls())); EXPECT_STREQ("val1", OptP.c_str()); OptP.clear(); cl::ResetAllOptionOccurrences(); // Should be possible to pass a value in a separate argument. const char *args2[] = {"prog", "-p", "val2"}; EXPECT_TRUE( cl::ParseCommandLineOptions(3, args2, StringRef(), &llvm::nulls())); EXPECT_STREQ("val2", OptP.c_str()); OptP.clear(); cl::ResetAllOptionOccurrences(); // The "-opt=value" form should work, too. const char *args3[] = {"prog", "-p=val3"}; EXPECT_TRUE( cl::ParseCommandLineOptions(2, args3, StringRef(), &llvm::nulls())); EXPECT_STREQ("val3", OptP.c_str()); OptP.clear(); cl::ResetAllOptionOccurrences(); // All three previous cases should work the same way if an option with both // cl::Prefix and cl::Grouping modifiers is used at the end of a group. const char *args4[] = {"prog", "-fpval4"}; EXPECT_TRUE( cl::ParseCommandLineOptions(2, args4, StringRef(), &llvm::nulls())); EXPECT_TRUE(OptF); EXPECT_STREQ("val4", OptP.c_str()); OptP.clear(); cl::ResetAllOptionOccurrences(); const char *args5[] = {"prog", "-fp", "val5"}; EXPECT_TRUE( cl::ParseCommandLineOptions(3, args5, StringRef(), &llvm::nulls())); EXPECT_TRUE(OptF); EXPECT_STREQ("val5", OptP.c_str()); OptP.clear(); cl::ResetAllOptionOccurrences(); const char *args6[] = {"prog", "-fp=val6"}; EXPECT_TRUE( cl::ParseCommandLineOptions(2, args6, StringRef(), &llvm::nulls())); EXPECT_TRUE(OptF); EXPECT_STREQ("val6", OptP.c_str()); OptP.clear(); cl::ResetAllOptionOccurrences(); // Should assign a value even if the part after a cl::Prefix option is equal // to the name of another option. const char *args7[] = {"prog", "-fpb"}; EXPECT_TRUE( cl::ParseCommandLineOptions(2, args7, StringRef(), &llvm::nulls())); EXPECT_TRUE(OptF); EXPECT_STREQ("b", OptP.c_str()); EXPECT_FALSE(OptB); OptP.clear(); cl::ResetAllOptionOccurrences(); // Should be possible to use a cl::AlwaysPrefix option without grouping. const char *args8[] = {"prog", "-aval8"}; EXPECT_TRUE( cl::ParseCommandLineOptions(2, args8, StringRef(), &llvm::nulls())); EXPECT_STREQ("val8", OptA.c_str()); OptA.clear(); cl::ResetAllOptionOccurrences(); // Should not be possible to pass a value in a separate argument. const char *args9[] = {"prog", "-a", "val9"}; EXPECT_FALSE( cl::ParseCommandLineOptions(3, args9, StringRef(), &llvm::nulls())); cl::ResetAllOptionOccurrences(); // With the "-opt=value" form, the "=" symbol should be preserved. const char *args10[] = {"prog", "-a=val10"}; EXPECT_TRUE( cl::ParseCommandLineOptions(2, args10, StringRef(), &llvm::nulls())); EXPECT_STREQ("=val10", OptA.c_str()); OptA.clear(); cl::ResetAllOptionOccurrences(); // All three previous cases should work the same way if an option with both // cl::AlwaysPrefix and cl::Grouping modifiers is used at the end of a group. const char *args11[] = {"prog", "-faval11"}; EXPECT_TRUE( cl::ParseCommandLineOptions(2, args11, StringRef(), &llvm::nulls())); EXPECT_TRUE(OptF); EXPECT_STREQ("val11", OptA.c_str()); OptA.clear(); cl::ResetAllOptionOccurrences(); const char *args12[] = {"prog", "-fa", "val12"}; EXPECT_FALSE( cl::ParseCommandLineOptions(3, args12, StringRef(), &llvm::nulls())); cl::ResetAllOptionOccurrences(); const char *args13[] = {"prog", "-fa=val13"}; EXPECT_TRUE( cl::ParseCommandLineOptions(2, args13, StringRef(), &llvm::nulls())); EXPECT_TRUE(OptF); EXPECT_STREQ("=val13", OptA.c_str()); OptA.clear(); cl::ResetAllOptionOccurrences(); // Should assign a value even if the part after a cl::AlwaysPrefix option // is equal to the name of another option. const char *args14[] = {"prog", "-fab"}; EXPECT_TRUE( cl::ParseCommandLineOptions(2, args14, StringRef(), &llvm::nulls())); EXPECT_TRUE(OptF); EXPECT_STREQ("b", OptA.c_str()); EXPECT_FALSE(OptB); OptA.clear(); cl::ResetAllOptionOccurrences(); } TEST(CommandLineTest, LongOptions) { cl::ResetCommandLineParser(); StackOption OptA("a", cl::desc("Some flag")); StackOption OptBLong("long-flag", cl::desc("Some long flag")); StackOption OptB("b", cl::desc("Alias to --long-flag"), cl::aliasopt(OptBLong)); StackOption OptAB("ab", cl::desc("Another long option")); std::string Errs; raw_string_ostream OS(Errs); const char *args1[] = {"prog", "-a", "-ab", "val1"}; const char *args2[] = {"prog", "-a", "--ab", "val1"}; const char *args3[] = {"prog", "-ab", "--ab", "val1"}; // // The following tests treat `-` and `--` the same, and always match the // longest string. // EXPECT_TRUE( cl::ParseCommandLineOptions(4, args1, StringRef(), &OS)); OS.flush(); EXPECT_TRUE(OptA); EXPECT_FALSE(OptBLong); EXPECT_STREQ("val1", OptAB.c_str()); EXPECT_TRUE(Errs.empty()); Errs.clear(); cl::ResetAllOptionOccurrences(); EXPECT_TRUE( cl::ParseCommandLineOptions(4, args2, StringRef(), &OS)); OS.flush(); EXPECT_TRUE(OptA); EXPECT_FALSE(OptBLong); EXPECT_STREQ("val1", OptAB.c_str()); EXPECT_TRUE(Errs.empty()); Errs.clear(); cl::ResetAllOptionOccurrences(); // Fails because `-ab` and `--ab` are treated the same and appear more than // once. Also, `val1` is unexpected. EXPECT_FALSE( cl::ParseCommandLineOptions(4, args3, StringRef(), &OS)); OS.flush(); outs()<< Errs << "\n"; EXPECT_FALSE(Errs.empty()); Errs.clear(); cl::ResetAllOptionOccurrences(); // // The following tests treat `-` and `--` differently, with `-` for short, and // `--` for long options. // // Fails because `-ab` is treated as `-a -b`, so `-a` is seen twice, and // `val1` is unexpected. EXPECT_FALSE(cl::ParseCommandLineOptions(4, args1, StringRef(), &OS, nullptr, true)); OS.flush(); EXPECT_FALSE(Errs.empty()); Errs.clear(); cl::ResetAllOptionOccurrences(); // Works because `-a` is treated differently than `--ab`. EXPECT_TRUE(cl::ParseCommandLineOptions(4, args2, StringRef(), &OS, nullptr, true)); OS.flush(); EXPECT_TRUE(Errs.empty()); Errs.clear(); cl::ResetAllOptionOccurrences(); // Works because `-ab` is treated as `-a -b`, and `--ab` is a long option. EXPECT_TRUE(cl::ParseCommandLineOptions(4, args3, StringRef(), &OS, nullptr, true)); EXPECT_TRUE(OptA); EXPECT_TRUE(OptBLong); EXPECT_STREQ("val1", OptAB.c_str()); OS.flush(); EXPECT_TRUE(Errs.empty()); Errs.clear(); cl::ResetAllOptionOccurrences(); } TEST(CommandLineTest, OptionErrorMessage) { // When there is an error, we expect some error message like: // prog: for the -a option: [...] // // Test whether the "for the -a option"-part is correctly formatted. cl::ResetCommandLineParser(); StackOption OptA("a", cl::desc("Some option")); StackOption OptLong("long", cl::desc("Some long option")); std::string Errs; raw_string_ostream OS(Errs); OptA.error("custom error", OS); OS.flush(); EXPECT_FALSE(Errs.find("for the -a option:") == std::string::npos); Errs.clear(); OptLong.error("custom error", OS); OS.flush(); EXPECT_FALSE(Errs.find("for the --long option:") == std::string::npos); Errs.clear(); cl::ResetAllOptionOccurrences(); } TEST(CommandLineTest, OptionErrorMessageSuggest) { // When there is an error, and the edit-distance is not very large, // we expect some error message like: // prog: did you mean '--option'? // // Test whether this message is well-formatted. cl::ResetCommandLineParser(); StackOption OptLong("aluminium", cl::desc("Some long option")); const char *args[] = {"prog", "--aluminum"}; std::string Errs; raw_string_ostream OS(Errs); EXPECT_FALSE(cl::ParseCommandLineOptions(2, args, StringRef(), &OS)); OS.flush(); EXPECT_FALSE(Errs.find("prog: Did you mean '--aluminium'?\n") == std::string::npos); Errs.clear(); cl::ResetAllOptionOccurrences(); } TEST(CommandLineTest, OptionErrorMessageSuggestNoHidden) { // We expect that 'really hidden' option do not show up in option // suggestions. cl::ResetCommandLineParser(); StackOption OptLong("aluminium", cl::desc("Some long option")); StackOption OptLong2("aluminum", cl::desc("Bad option"), cl::ReallyHidden); const char *args[] = {"prog", "--alumnum"}; std::string Errs; raw_string_ostream OS(Errs); EXPECT_FALSE(cl::ParseCommandLineOptions(2, args, StringRef(), &OS)); OS.flush(); EXPECT_FALSE(Errs.find("prog: Did you mean '--aluminium'?\n") == std::string::npos); Errs.clear(); cl::ResetAllOptionOccurrences(); } TEST(CommandLineTest, Callback) { cl::ResetCommandLineParser(); StackOption OptA("a", cl::desc("option a")); StackOption OptB( "b", cl::desc("option b -- This option turns on option a"), cl::callback([&](const bool &) { OptA = true; })); StackOption OptC( "c", cl::desc("option c -- This option turns on options a and b"), cl::callback([&](const bool &) { OptB = true; })); StackOption> List( "list", cl::desc("option list -- This option turns on options a, b, and c when " "'foo' is included in list"), cl::CommaSeparated, cl::callback([&](const std::string &Str) { if (Str == "foo") OptC = true; })); const char *args1[] = {"prog", "-a"}; EXPECT_TRUE(cl::ParseCommandLineOptions(2, args1)); EXPECT_TRUE(OptA); EXPECT_FALSE(OptB); EXPECT_FALSE(OptC); EXPECT_TRUE(List.size() == 0); cl::ResetAllOptionOccurrences(); const char *args2[] = {"prog", "-b"}; EXPECT_TRUE(cl::ParseCommandLineOptions(2, args2)); EXPECT_TRUE(OptA); EXPECT_TRUE(OptB); EXPECT_FALSE(OptC); EXPECT_TRUE(List.size() == 0); cl::ResetAllOptionOccurrences(); const char *args3[] = {"prog", "-c"}; EXPECT_TRUE(cl::ParseCommandLineOptions(2, args3)); EXPECT_TRUE(OptA); EXPECT_TRUE(OptB); EXPECT_TRUE(OptC); EXPECT_TRUE(List.size() == 0); cl::ResetAllOptionOccurrences(); const char *args4[] = {"prog", "--list=foo,bar"}; EXPECT_TRUE(cl::ParseCommandLineOptions(2, args4)); EXPECT_TRUE(OptA); EXPECT_TRUE(OptB); EXPECT_TRUE(OptC); EXPECT_TRUE(List.size() == 2); cl::ResetAllOptionOccurrences(); const char *args5[] = {"prog", "--list=bar"}; EXPECT_TRUE(cl::ParseCommandLineOptions(2, args5)); EXPECT_FALSE(OptA); EXPECT_FALSE(OptB); EXPECT_FALSE(OptC); EXPECT_TRUE(List.size() == 1); cl::ResetAllOptionOccurrences(); } enum Enum { Val1, Val2 }; static cl::bits ExampleBits( cl::desc("An example cl::bits to ensure it compiles"), cl::values( clEnumValN(Val1, "bits-val1", "The Val1 value"), clEnumValN(Val1, "bits-val2", "The Val2 value"))); TEST(CommandLineTest, ConsumeAfterOnePositional) { cl::ResetCommandLineParser(); // input [args] StackOption> Input(cl::Positional, cl::Required); StackOption> ExtraArgs(cl::ConsumeAfter); const char *Args[] = {"prog", "input", "arg1", "arg2"}; std::string Errs; raw_string_ostream OS(Errs); EXPECT_TRUE(cl::ParseCommandLineOptions(4, Args, StringRef(), &OS)); OS.flush(); EXPECT_EQ("input", Input); EXPECT_TRUE(ExtraArgs.size() == 2); EXPECT_TRUE(ExtraArgs[0] == "arg1"); EXPECT_TRUE(ExtraArgs[1] == "arg2"); EXPECT_TRUE(Errs.empty()); } TEST(CommandLineTest, ConsumeAfterTwoPositionals) { cl::ResetCommandLineParser(); // input1 input2 [args] StackOption> Input1(cl::Positional, cl::Required); StackOption> Input2(cl::Positional, cl::Required); StackOption> ExtraArgs(cl::ConsumeAfter); const char *Args[] = {"prog", "input1", "input2", "arg1", "arg2"}; std::string Errs; raw_string_ostream OS(Errs); EXPECT_TRUE(cl::ParseCommandLineOptions(5, Args, StringRef(), &OS)); OS.flush(); EXPECT_EQ("input1", Input1); EXPECT_EQ("input2", Input2); EXPECT_TRUE(ExtraArgs.size() == 2); EXPECT_TRUE(ExtraArgs[0] == "arg1"); EXPECT_TRUE(ExtraArgs[1] == "arg2"); EXPECT_TRUE(Errs.empty()); } } // anonymous namespace