1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
|
//===- unittest/Support/OptionParsingTest.cpp - OptTable 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/ADT/STLExtras.h"
#include "llvm/Option/Arg.h"
#include "llvm/Option/ArgList.h"
#include "llvm/Option/OptTable.h"
#include "llvm/Option/Option.h"
#include "llvm/Support/raw_ostream.h"
#include "gtest/gtest.h"
using namespace llvm;
using namespace llvm::opt;
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
#endif
namespace {
enum ID {
OPT_INVALID = 0,
#define OPTION(PREFIXES, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, \
VISIBILITY, PARAM, HELPTEXT, HELPTEXTSFORVARIANTS, METAVAR, \
VALUES, SUBCOMMANDIDS_OFFSET) \
OPT_##ID,
#include "SubCommandOpts.inc"
#undef OPTION
};
#define OPTTABLE_STR_TABLE_CODE
#include "SubCommandOpts.inc"
#undef OPTTABLE_STR_TABLE_CODE
#define OPTTABLE_PREFIXES_TABLE_CODE
#include "SubCommandOpts.inc"
#undef OPTTABLE_PREFIXES_TABLE_CODE
#define OPTTABLE_SUBCOMMAND_IDS_TABLE_CODE
#include "SubCommandOpts.inc"
#undef OPTTABLE_SUBCOMMAND_IDS_TABLE_CODE
#define OPTTABLE_SUBCOMMANDS_CODE
#include "SubCommandOpts.inc"
#undef OPTTABLE_SUBCOMMANDS_CODE
static constexpr OptTable::Info InfoTable[] = {
#define OPTION(...) LLVM_CONSTRUCT_OPT_INFO(__VA_ARGS__),
#include "SubCommandOpts.inc"
#undef OPTION
};
class TestOptSubCommandTable : public GenericOptTable {
public:
TestOptSubCommandTable(bool IgnoreCase = false)
: GenericOptTable(OptionStrTable, OptionPrefixesTable, InfoTable,
/*IgnoreCase=*/false, OptionSubCommands,
OptionSubCommandIDsTable) {}
};
// Test fixture
template <typename T> class OptSubCommandTableTest : public ::testing::Test {};
// Test both precomputed and computed OptTables with the same suite of tests.
using OptSubCommandTableTestTypes = ::testing::Types<TestOptSubCommandTable>;
TYPED_TEST_SUITE(OptSubCommandTableTest, OptSubCommandTableTestTypes, );
TYPED_TEST(OptSubCommandTableTest, SubCommandParsing) {
TypeParam T;
unsigned MAI, MAC;
std::string ErrMsg;
raw_string_ostream RSO1(ErrMsg);
auto HandleMultipleSubcommands = [&](ArrayRef<StringRef> SubCommands) {
ErrMsg.clear();
RSO1 << "Multiple subcommands passed\n";
for (auto SC : SubCommands)
RSO1 << "\n" << SC;
};
auto HandleOtherPositionals = [&](ArrayRef<StringRef> Positionals) {
ErrMsg.clear();
RSO1 << "Unregistered positionals passed\n";
for (auto SC : Positionals)
RSO1 << "\n" << SC;
};
{
// Test case 1: Toplevel option, no subcommand
const char *Args[] = {"-version"};
InputArgList AL = T.ParseArgs(Args, MAI, MAC);
EXPECT_TRUE(AL.hasArg(OPT_version));
StringRef SC = AL.getSubCommand(
T.getSubCommands(), HandleMultipleSubcommands, HandleOtherPositionals);
EXPECT_TRUE(SC.empty());
EXPECT_FALSE(AL.hasArg(OPT_uppercase));
EXPECT_FALSE(AL.hasArg(OPT_lowercase));
}
{
// Test case 2: Subcommand 'foo' with its valid options
const char *Args[] = {"foo", "-uppercase"};
InputArgList AL = T.ParseArgs(Args, MAI, MAC);
StringRef SC = AL.getSubCommand(
T.getSubCommands(), HandleMultipleSubcommands, HandleOtherPositionals);
EXPECT_EQ(SC, "foo");
EXPECT_TRUE(AL.hasArg(OPT_uppercase));
EXPECT_FALSE(AL.hasArg(OPT_lowercase));
EXPECT_FALSE(AL.hasArg(OPT_version));
EXPECT_EQ(std::string::npos, ErrMsg.find("Multiple subcommands passed"))
<< "Did not expect error message as this is a valid use case.";
EXPECT_EQ(std::string::npos, ErrMsg.find("Unregistered positionals passed"))
<< "Did not expect error message as this is a valid use case.";
}
{
// Test case 3: Check valid use of subcommand which follows a valid
// subcommand option.
const char *Args[] = {"-uppercase", "foo"};
InputArgList AL = T.ParseArgs(Args, MAI, MAC);
StringRef SC = AL.getSubCommand(
T.getSubCommands(), HandleMultipleSubcommands, HandleOtherPositionals);
EXPECT_EQ(SC, "foo");
EXPECT_TRUE(AL.hasArg(OPT_uppercase));
EXPECT_FALSE(AL.hasArg(OPT_lowercase));
EXPECT_FALSE(AL.hasArg(OPT_version));
EXPECT_EQ(std::string::npos, ErrMsg.find("Multiple subcommands passed"))
<< "Did not expect error message as this is a valid use case.";
EXPECT_EQ(std::string::npos, ErrMsg.find("Unregistered positionals passed"))
<< "Did not expect error message as this is a valid use case.";
}
{
// Test case 4: Check invalid use of passing multiple subcommands.
const char *Args[] = {"-uppercase", "foo", "bar"};
InputArgList AL = T.ParseArgs(Args, MAI, MAC);
StringRef SC = AL.getSubCommand(
T.getSubCommands(), HandleMultipleSubcommands, HandleOtherPositionals);
// No valid subcommand should be returned as this is an invalid invocation.
EXPECT_TRUE(SC.empty());
// Expect the multiple subcommands error message.
EXPECT_NE(std::string::npos, ErrMsg.find("Multiple subcommands passed"));
EXPECT_NE(std::string::npos, ErrMsg.find("foo"));
EXPECT_NE(std::string::npos, ErrMsg.find("bar"));
EXPECT_EQ(std::string::npos, ErrMsg.find("Unregistered positionals passed"))
<< "Did not expect error message as this is a valid use case.";
}
{
// Test case 5: Check invalid use of passing unregistered subcommands.
const char *Args[] = {"foobar"};
InputArgList AL = T.ParseArgs(Args, MAI, MAC);
StringRef SC = AL.getSubCommand(
T.getSubCommands(), HandleMultipleSubcommands, HandleOtherPositionals);
// No valid subcommand should be returned as this is an invalid invocation.
EXPECT_TRUE(SC.empty());
// Expect the unregistered subcommands error message.
EXPECT_NE(std::string::npos,
ErrMsg.find("Unregistered positionals passed"));
EXPECT_NE(std::string::npos, ErrMsg.find("foobar"));
}
{
// Test case 6: Check invalid use of a valid subcommand which follows a
// valid subcommand option but the option is not registered with the given
// subcommand.
const char *Args[] = {"-lowercase", "bar"};
InputArgList AL = T.ParseArgs(Args, MAI, MAC);
StringRef SC = AL.getSubCommand(
T.getSubCommands(), HandleMultipleSubcommands, HandleOtherPositionals);
auto HandleSubCommandArg = [&](ID OptionType) {
if (!AL.hasArg(OptionType))
return false;
auto O = T.getOption(OptionType);
if (!O.isRegisteredSC(SC)) {
ErrMsg.clear();
RSO1 << "Option [" << O.getName() << "] is not valid for SubCommand ["
<< SC << "]\n";
return false;
}
return true;
};
EXPECT_EQ(SC, "bar"); // valid subcommand
EXPECT_TRUE(AL.hasArg(OPT_lowercase)); // valid option
EXPECT_FALSE(HandleSubCommandArg(OPT_lowercase));
EXPECT_NE(
std::string::npos,
ErrMsg.find("Option [lowercase] is not valid for SubCommand [bar]"));
}
}
TYPED_TEST(OptSubCommandTableTest, SubCommandHelp) {
TypeParam T;
std::string Help;
raw_string_ostream RSO(Help);
// Toplevel help
T.printHelp(RSO, "Test Usage String", "OverviewString");
EXPECT_NE(std::string::npos, Help.find("OVERVIEW:"));
EXPECT_NE(std::string::npos, Help.find("OverviewString"));
EXPECT_NE(std::string::npos, Help.find("USAGE:"));
EXPECT_NE(std::string::npos, Help.find("Test Usage String"));
EXPECT_NE(std::string::npos, Help.find("SUBCOMMANDS:"));
EXPECT_NE(std::string::npos, Help.find("foo"));
EXPECT_NE(std::string::npos, Help.find("bar"));
EXPECT_NE(std::string::npos, Help.find("HelpText for SubCommand foo."));
EXPECT_NE(std::string::npos, Help.find("HelpText for SubCommand bar."));
EXPECT_NE(std::string::npos, Help.find("OPTIONS:"));
EXPECT_NE(std::string::npos, Help.find("--help"));
EXPECT_NE(std::string::npos, Help.find("-version"));
// uppercase is not a global option and should not be shown.
EXPECT_EQ(std::string::npos, Help.find("-uppercase"));
// Help for subcommand foo
Help.clear();
StringRef SC1 = "foo";
T.printHelp(RSO, "Test Usage String", "OverviewString", false, false,
Visibility(), SC1);
EXPECT_NE(std::string::npos, Help.find("OVERVIEW:"));
EXPECT_NE(std::string::npos, Help.find("OverviewString"));
// SubCommand "foo" definition for tablegen has NO dedicated usage string so
// not expected to see USAGE.
EXPECT_EQ(std::string::npos, Help.find("USAGE:"));
EXPECT_NE(std::string::npos, Help.find("HelpText for SubCommand foo."));
EXPECT_NE(std::string::npos, Help.find("-uppercase"));
EXPECT_NE(std::string::npos, Help.find("-lowercase"));
EXPECT_EQ(std::string::npos, Help.find("-version"));
EXPECT_EQ(std::string::npos, Help.find("SUBCOMMANDS:"));
// Help for subcommand bar
Help.clear();
StringRef SC2 = "bar";
T.printHelp(RSO, "Test Usage String", "OverviewString", false, false,
Visibility(), SC2);
EXPECT_NE(std::string::npos, Help.find("OVERVIEW:"));
EXPECT_NE(std::string::npos, Help.find("OverviewString"));
// SubCommand "bar" definition for tablegen has a dedicated usage string.
EXPECT_NE(std::string::npos, Help.find("USAGE:"));
EXPECT_NE(std::string::npos, Help.find("Subcommand bar <options>"));
EXPECT_NE(std::string::npos, Help.find("HelpText for SubCommand bar."));
EXPECT_NE(std::string::npos, Help.find("-uppercase"));
// lowercase is not an option for bar and should not be shown.
EXPECT_EQ(std::string::npos, Help.find("-lowercase"));
// version is a global option and should not be shown.
EXPECT_EQ(std::string::npos, Help.find("-version"));
}
} // end anonymous namespace
|
