forked from microsoft/winget-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCommand.cpp
More file actions
664 lines (539 loc) · 25 KB
/
Copy pathCommand.cpp
File metadata and controls
664 lines (539 loc) · 25 KB
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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
#include "pch.h"
#include "TestCommon.h"
#include <Command.h>
#include <AppInstallerStrings.h>
#include <Commands/RootCommand.h>
using namespace std::string_literals;
using namespace std::string_view_literals;
using namespace TestCommon;
using namespace AppInstaller;
using namespace AppInstaller::CLI;
using namespace AppInstaller::CLI::Execution;
std::string GetCommandName(const std::unique_ptr<Command>& command)
{
return std::string{ command->FullName() };
}
std::vector<std::string_view> GetCommandAliases(const std::unique_ptr<Command>& command)
{
return std::vector<std::string_view> { command->Aliases() };
}
std::string GetArgumentName(const Argument& arg)
{
return std::string{ arg.Name() };
}
std::string GetArgumentAlternateName(const Argument& arg)
{
if (arg.AlternateName() == Argument::NoAlternateName)
{
return {};
}
else
{
return std::string{ arg.AlternateName() };
}
}
std::string GetArgumentAlias(const Argument& arg)
{
if (arg.Alias() == ArgumentCommon::NoAlias)
{
return {};
}
else
{
return std::string(1, arg.Alias());
}
}
bool StringIsLowercase(const std::string& s)
{
return Utility::ToLower(s) == s;
}
template <typename Enumerable, typename Op>
void EnsureStringsAreLowercaseAndNoCollisions(const std::string& info, const Enumerable& e, Op& op, std::unordered_set<std::string>& values, bool requireLower = true)
{
INFO(info);
for (const auto& val : e)
{
std::string valString = op(val);
if (valString.empty())
{
continue;
}
INFO(valString);
if (requireLower)
{
REQUIRE(StringIsLowercase(valString));
}
REQUIRE(values.find(valString) == values.end());
values.emplace(std::move(valString));
}
}
template <typename Enumerable, typename Op>
void EnsureStringsAreLowercaseAndNoCollisions(const std::string& info, const Enumerable& e, Op& op, bool requireLower = true)
{
std::unordered_set<std::string> values;
EnsureStringsAreLowercaseAndNoCollisions(info, e, op, values, requireLower);
}
template <typename Enumerable, typename Op>
void EnsureVectorStringViewsAreLowercaseAndNoCollisions(const std::string& info, const Enumerable& e, Op& op, std::unordered_set<std::string>& values, bool requireLower = true)
{
INFO(info);
for (const auto& val : e)
{
std::vector<std::string_view> aliasVector = op(val);
std::vector<std::string> valVector(aliasVector.begin(), aliasVector.end());
if (valVector.empty())
{
continue;
}
// When op returns a vector, we need to ensure every value in the vector does not cause a collision
for (auto& valString : valVector)
{
INFO(valString);
if (requireLower)
{
REQUIRE(StringIsLowercase(valString));
}
REQUIRE(values.find(valString) == values.end());
values.emplace(std::move(valString));
}
}
}
void EnsureCommandConsistency(const Command& command)
{
// Command names and aliases exist in the same space, so both need to be checked as a set
// However, collisions do not occur between levels, so the full name must be used to check for collision
std::unordered_set<std::string> allCommandAliasNames;
EnsureStringsAreLowercaseAndNoCollisions(command.FullName() + " commands", command.GetCommands(), GetCommandName, allCommandAliasNames);
EnsureVectorStringViewsAreLowercaseAndNoCollisions(command.FullName() + " aliases", command.GetCommands(), GetCommandAliases, allCommandAliasNames);
auto args = command.GetArguments();
Argument::GetCommon(args);
// Argument names and alternate names exist in the same space, so both need to be checked as a set
std::unordered_set<std::string> allArgumentNames;
EnsureStringsAreLowercaseAndNoCollisions(command.FullName() + " argument names", args, GetArgumentName, allArgumentNames);
EnsureStringsAreLowercaseAndNoCollisions(command.FullName() + " argument alternate name", args, GetArgumentAlternateName, allArgumentNames);
// Argument aliases use a different space than the names and can be checked separately
EnsureStringsAreLowercaseAndNoCollisions(command.FullName() + " argument alias", args, GetArgumentAlias, false);
// No : allowed in commands
for (const auto& comm : command.GetCommands())
{
INFO(command.FullName());
INFO(comm->Name());
REQUIRE(comm->Name().find_first_of(Command::ParentSplitChar) == std::string_view::npos);
}
// No = allowed in arguments
// All positional args should be listed first
bool foundNonPositional = false;
bool queryArgPresent = false;
bool multiQueryArgPresent = false;
for (const auto& arg : command.GetArguments())
{
INFO(command.FullName());
INFO(arg.Name());
REQUIRE(arg.Name().find_first_of(APPINSTALLER_CLI_ARGUMENT_SPLIT_CHAR) == std::string_view::npos);
if (arg.Type() == ArgumentType::Positional)
{
REQUIRE(!foundNonPositional);
}
else
{
foundNonPositional = true;
}
if (arg.ExecArgType() == Execution::Args::Type::Query)
{
queryArgPresent = true;
}
if (arg.ExecArgType() == Execution::Args::Type::MultiQuery)
{
multiQueryArgPresent = true;
}
}
REQUIRE((!queryArgPresent || !multiQueryArgPresent));
// Recurse for all subcommands
for (const auto& sub : command.GetCommands())
{
EnsureCommandConsistency(*sub.get());
}
}
// This test ensure that the command tree we expose does not have any inconsistencies.
// 1. No command name collisions
// 2. All command names are lower cased
// 3. No argument name collisions
// 4. All arguments are lower cased
// 5. No argument alias collisions
// 6. All argument alias are lower cased
// 7. No argument names contain '='
// 8. All positional arguments are first in the list
// 9. No command includes both Query and MultiQuery arguments
TEST_CASE("EnsureCommandTreeConsistency", "[command]")
{
RootCommand root;
EnsureCommandConsistency(root);
}
struct TestCommand : public Command
{
TestCommand(std::vector<Argument> args) : Command("test", ""), m_args(std::move(args)) {}
std::vector<Argument> GetArguments() const override
{
return m_args;
}
std::vector<Argument> m_args;
};
// Matcher that lets us verify CommandExceptions.
struct CommandExceptionMatcher : public Catch::MatcherBase<CommandException>
{
CommandExceptionMatcher(CLI::Resource::LocString message) : m_expectedMessage(std::move(message)) {}
bool match(const CommandException& ce) const override
{
return ce.Message() == m_expectedMessage;
}
std::string describe() const override
{
std::ostringstream result;
result << "has message == " << m_expectedMessage;
return result.str();
}
private:
CLI::Resource::LocString m_expectedMessage;
};
namespace Catch {
template<>
struct StringMaker<CommandException> {
static std::string convert(CommandException const& ce) {
return Utility::Format("CommandException{ '{0}' }", ce.Message().get());
}
};
}
#define REQUIRE_COMMAND_EXCEPTION(_expr_, _arg_) REQUIRE_THROWS_MATCHES(_expr_, CommandException, CommandExceptionMatcher(_arg_))
void RequireValueParsedToArg(const std::string& value, const Argument& arg, const Args& args)
{
REQUIRE(args.Contains(arg.ExecArgType()));
REQUIRE(value == args.GetArg(arg.ExecArgType()));
}
void RequireValuesParsedToArg(const std::vector<std::string>& values, Args::Type execArgType, const Args& args)
{
REQUIRE(args.Contains(execArgType));
REQUIRE(args.GetCount(execArgType) == values.size());
auto argValues = args.GetArgs(execArgType);
for (size_t i = 0; i < values.size(); ++i)
{
REQUIRE(argValues->at(i) == values[i]);
}
}
void RequireValuesParsedToArg(const std::vector<std::string>& values, const Argument& arg, const Args& args)
{
RequireValuesParsedToArg(values, arg.ExecArgType(), args);
}
// Description used for tests; doesn't need to be anything in particular.
static constexpr CLI::Resource::StringId DefaultDesc{ L""sv };
TEST_CASE("ParseArguments_MultiplePositional", "[command]")
{
Args args;
TestCommand command({
Argument{ "pos1", 'p', Args::Type::Channel, DefaultDesc, ArgumentType::Positional },
Argument{ "std1", 's', Args::Type::Command, DefaultDesc, ArgumentType::Standard },
Argument{ "pos2", 'q', Args::Type::Count, DefaultDesc, ArgumentType::Positional },
});
std::vector<std::string> values{ "val1", "val2" };
Invocation inv{ std::vector<std::string>(values) };
command.ParseArguments(inv, args);
RequireValueParsedToArg(values[0], command.m_args[0], args);
RequireValueParsedToArg(values[1], command.m_args[2], args);
}
TEST_CASE("ParseArguments_ForcePositional", "[command]")
{
Args args;
TestCommand command({
Argument{ "pos1", 'p', Args::Type::Channel, DefaultDesc, ArgumentType::Positional },
Argument{ "std1", 's', Args::Type::Command, DefaultDesc, ArgumentType::Standard },
Argument{ "pos2", 'q', Args::Type::Count, DefaultDesc, ArgumentType::Positional },
});
std::vector<std::string> values{ "val1", "--", "-std1" };
Invocation inv{ std::vector<std::string>(values) };
command.ParseArguments(inv, args);
RequireValueParsedToArg(values[0], command.m_args[0], args);
RequireValueParsedToArg(values[2], command.m_args[2], args);
}
TEST_CASE("ParseArguments_TooManyPositional", "[command]")
{
Args args;
TestCommand command({
Argument{ "pos1", 'p', Args::Type::Channel, DefaultDesc, ArgumentType::Positional },
Argument{ "std1", 's', Args::Type::Command, DefaultDesc, ArgumentType::Standard },
});
std::vector<std::string> values{ "val1", "--", "-std1" };
Invocation inv{ std::vector<std::string>(values) };
REQUIRE_COMMAND_EXCEPTION(command.ParseArguments(inv, args), CLI::Resource::String::ExtraPositionalError(Utility::LocIndView{ values[2] }));
}
TEST_CASE("ParseArguments_InvalidChar", "[command]")
{
Args args;
TestCommand command({
Argument{ "pos1", 'p', Args::Type::Channel, DefaultDesc, ArgumentType::Positional },
Argument{ "std1", 's', Args::Type::Command, DefaultDesc, ArgumentType::Standard },
Argument{ "pos2", 'q', Args::Type::Count, DefaultDesc, ArgumentType::Positional },
});
std::vector<std::string> values{ "val1", "-", "-std1" };
Invocation inv{ std::vector<std::string>(values) };
REQUIRE_COMMAND_EXCEPTION(command.ParseArguments(inv, args), CLI::Resource::String::InvalidArgumentSpecifierError(Utility::LocIndView{ values[1] }));
}
TEST_CASE("ParseArguments_InvalidAlias", "[command]")
{
Args args;
TestCommand command({
Argument{ "pos1", 'p', Args::Type::Channel, DefaultDesc, ArgumentType::Positional },
Argument{ "std1", 's', Args::Type::Command, DefaultDesc, ArgumentType::Standard },
Argument{ "pos2", 'q', Args::Type::Count, DefaultDesc, ArgumentType::Positional },
});
std::vector<std::string> values{ "val1", "-b", "-std1" };
Invocation inv{ std::vector<std::string>(values) };
REQUIRE_COMMAND_EXCEPTION(command.ParseArguments(inv, args), CLI::Resource::String::InvalidAliasError(Utility::LocIndView{ values[1] }));
}
TEST_CASE("ParseArguments_MultiFlag", "[command]")
{
Args args;
TestCommand command({
Argument{ "pos1", 'p', Args::Type::Channel, DefaultDesc, ArgumentType::Positional },
Argument{ "flag1", 's', Args::Type::Command, DefaultDesc, ArgumentType::Flag },
Argument{ "pos2", 'q', Args::Type::Count, DefaultDesc, ArgumentType::Positional },
Argument{ "flag2", 't', Args::Type::Exact, DefaultDesc, ArgumentType::Flag },
});
std::vector<std::string> values{ "val1", "-st", "val2" };
Invocation inv{ std::vector<std::string>(values) };
command.ParseArguments(inv, args);
REQUIRE(args.Contains(command.m_args[1].ExecArgType()));
REQUIRE(args.Contains(command.m_args[3].ExecArgType()));
}
TEST_CASE("ParseArguments_FlagThenUnknown", "[command]")
{
Args args;
TestCommand command({
Argument{ "pos1", 'p', Args::Type::Channel, DefaultDesc, ArgumentType::Positional },
Argument{ "flag1", 's', Args::Type::Command, DefaultDesc, ArgumentType::Flag },
Argument{ "pos2", 'q', Args::Type::Count, DefaultDesc, ArgumentType::Positional },
Argument{ "flag2", 't', Args::Type::Exact, DefaultDesc, ArgumentType::Flag },
});
std::vector<std::string> values{ "val1", "-sr", "val2" };
Invocation inv{ std::vector<std::string>(values) };
REQUIRE_COMMAND_EXCEPTION(command.ParseArguments(inv, args), CLI::Resource::String::AdjoinedNotFoundError(Utility::LocIndView{ values[1] }));
}
TEST_CASE("ParseArguments_FlagThenNonFlag", "[command]")
{
Args args;
TestCommand command({
Argument{ "pos1", 'p', Args::Type::Channel, DefaultDesc, ArgumentType::Positional },
Argument{ "flag1", 's', Args::Type::Command, DefaultDesc, ArgumentType::Flag },
Argument{ "pos2", 'q', Args::Type::Count, DefaultDesc, ArgumentType::Positional },
Argument{ "flag2", 't', Args::Type::Exact, DefaultDesc, ArgumentType::Flag },
});
std::vector<std::string> values{ "val1", "-sp", "val2" };
Invocation inv{ std::vector<std::string>(values) };
REQUIRE_COMMAND_EXCEPTION(command.ParseArguments(inv, args), CLI::Resource::String::AdjoinedNotFlagError(Utility::LocIndView{ values[1] }));
}
TEST_CASE("ParseArguments_NameUsingAliasSpecifier", "[command]")
{
Args args;
TestCommand command({
Argument{ "pos1", 'p', Args::Type::Channel, DefaultDesc, ArgumentType::Positional },
Argument{ "std1", 's', Args::Type::Command, DefaultDesc, ArgumentType::Standard },
Argument{ "pos2", 'q', Args::Type::Count, DefaultDesc, ArgumentType::Positional },
Argument{ "flag1", 'f', Args::Type::Exact, DefaultDesc, ArgumentType::Flag },
});
std::vector<std::string> values{ "another", "-flag1" };
Invocation inv{ std::vector<std::string>(values) };
REQUIRE_COMMAND_EXCEPTION(command.ParseArguments(inv, args), CLI::Resource::String::AdjoinedNotFoundError(Utility::LocIndView{ values[1] }));
}
TEST_CASE("ParseArguments_AliasWithAdjoinedValue", "[command]")
{
Args args;
TestCommand command({
Argument{ "pos1", 'p', Args::Type::Channel, DefaultDesc, ArgumentType::Positional },
Argument{ "std1", 's', Args::Type::Command, DefaultDesc, ArgumentType::Standard },
Argument{ "pos2", 'q', Args::Type::Count, DefaultDesc, ArgumentType::Positional },
});
std::vector<std::string> values{ "-s=Val1" };
Invocation inv{ std::vector<std::string>(values) };
command.ParseArguments(inv, args);
RequireValueParsedToArg(values[0].substr(3), command.m_args[1], args);
}
TEST_CASE("ParseArguments_AliasWithSeparatedValue", "[command]")
{
Args args;
TestCommand command({
Argument{ "pos1", 'p', Args::Type::Channel, DefaultDesc, ArgumentType::Positional },
Argument{ "std1", 's', Args::Type::Command, DefaultDesc, ArgumentType::Standard },
Argument{ "pos2", 'q', Args::Type::Count, DefaultDesc, ArgumentType::Positional },
});
std::vector<std::string> values{ "-s", "Val1" };
Invocation inv{ std::vector<std::string>(values) };
command.ParseArguments(inv, args);
RequireValueParsedToArg(values[1], command.m_args[1], args);
}
TEST_CASE("ParseArguments_AliasWithSeparatedValueMissing", "[command]")
{
Args args;
TestCommand command({
Argument{ "pos1", 'p', Args::Type::Channel, DefaultDesc, ArgumentType::Positional },
Argument{ "std1", 's', Args::Type::Command, DefaultDesc, ArgumentType::Standard },
Argument{ "pos2", 'q', Args::Type::Count, DefaultDesc, ArgumentType::Positional },
});
std::vector<std::string> values{ "-s" };
Invocation inv{ std::vector<std::string>(values) };
REQUIRE_COMMAND_EXCEPTION(command.ParseArguments(inv, args), CLI::Resource::String::MissingArgumentError(Utility::LocIndView{ values[0] }));
}
TEST_CASE("ParseArguments_NameWithAdjoinedValue", "[command]")
{
Args args;
TestCommand command({
Argument{ "pos1", 'p', Args::Type::Channel, DefaultDesc, ArgumentType::Positional },
Argument{ "std1", 's', Args::Type::Command, DefaultDesc, ArgumentType::Standard },
Argument{ "pos2", 'q', Args::Type::Count, DefaultDesc, ArgumentType::Positional },
});
std::vector<std::string> values{ "--pos1=Val1" };
Invocation inv{ std::vector<std::string>(values) };
command.ParseArguments(inv, args);
RequireValueParsedToArg(values[0].substr(7), command.m_args[0], args);
}
TEST_CASE("ParseArguments_AlternateNameWithAdjoinedValue", "[command]")
{
Args args;
TestCommand command({
Argument{ "pos1", 'p', "p1", Args::Type::Channel, DefaultDesc, ArgumentType::Positional},
Argument{ "std1", 's', Args::Type::Command, DefaultDesc, ArgumentType::Standard },
Argument{ "pos2", 'q', Args::Type::Count, DefaultDesc, ArgumentType::Positional },
});
std::vector<std::string> values{ "--p1=Val1" };
Invocation inv{ std::vector<std::string>(values) };
command.ParseArguments(inv, args);
RequireValueParsedToArg(values[0].substr(5), command.m_args[0], args);
}
TEST_CASE("ParseArguments_NameFlag", "[command]")
{
Args args;
TestCommand command({
Argument{ "pos1", 'p', Args::Type::Channel, DefaultDesc, ArgumentType::Positional },
Argument{ "std1", 's', Args::Type::Command, DefaultDesc, ArgumentType::Standard },
Argument{ "pos2", 'q', Args::Type::Count, DefaultDesc, ArgumentType::Positional },
Argument{ "flag1", 'f', Args::Type::Exact, DefaultDesc, ArgumentType::Flag },
});
std::vector<std::string> values{ "--flag1", "arbitrary" };
Invocation inv{ std::vector<std::string>(values) };
command.ParseArguments(inv, args);
RequireValueParsedToArg(values[1], command.m_args[0], args);
REQUIRE(args.Contains(command.m_args[3].ExecArgType()));
}
TEST_CASE("ParseArguments_NameFlagWithAdjoinedValue", "[command]")
{
Args args;
TestCommand command({
Argument{ "pos1", 'p', Args::Type::Channel, DefaultDesc, ArgumentType::Positional },
Argument{ "std1", 's', Args::Type::Command, DefaultDesc, ArgumentType::Standard },
Argument{ "pos2", 'q', Args::Type::Count, DefaultDesc, ArgumentType::Positional },
Argument{ "flag1", 'f', Args::Type::Exact, DefaultDesc, ArgumentType::Flag },
});
std::vector<std::string> values{ "another", "--flag1=arbitrary" };
Invocation inv{ std::vector<std::string>(values) };
REQUIRE_COMMAND_EXCEPTION(command.ParseArguments(inv, args), CLI::Resource::String::FlagContainAdjoinedError(Utility::LocIndView{ values[1] }));
}
TEST_CASE("ParseArguments_NameWithSeparatedValue", "[command]")
{
Args args;
TestCommand command({
Argument{ "pos1", 'p', Args::Type::Channel, DefaultDesc, ArgumentType::Positional },
Argument{ "std1", 's', Args::Type::Command, DefaultDesc, ArgumentType::Standard },
Argument{ "pos2", 'q', Args::Type::Count, DefaultDesc, ArgumentType::Positional },
Argument{ "flag1", 'f', Args::Type::Exact, DefaultDesc, ArgumentType::Flag },
});
std::vector<std::string> values{ "--pos2", "arbitrary" };
Invocation inv{ std::vector<std::string>(values) };
command.ParseArguments(inv, args);
RequireValueParsedToArg(values[1], command.m_args[2], args);
}
TEST_CASE("ParseArguments_NameWithSeparatedValueMissing", "[command]")
{
Args args;
TestCommand command({
Argument{ "pos1", 'p', Args::Type::Channel, DefaultDesc, ArgumentType::Positional },
Argument{ "std1", 's', Args::Type::Command, DefaultDesc, ArgumentType::Standard },
Argument{ "pos2", 'q', Args::Type::Count, DefaultDesc, ArgumentType::Positional },
Argument{ "flag1", 'f', Args::Type::Exact, DefaultDesc, ArgumentType::Flag },
});
std::vector<std::string> values{ "--pos2" };
Invocation inv{ std::vector<std::string>(values) };
REQUIRE_COMMAND_EXCEPTION(command.ParseArguments(inv, args), CLI::Resource::String::MissingArgumentError(Utility::LocIndView{ values[0] }));
}
TEST_CASE("ParseArguments_UnknownName", "[command]")
{
Args args;
TestCommand command({
Argument{ "pos1", 'p', Args::Type::Channel, DefaultDesc, ArgumentType::Positional },
Argument{ "std1", 's', Args::Type::Command, DefaultDesc, ArgumentType::Standard },
Argument{ "pos2", 'q', Args::Type::Count, DefaultDesc, ArgumentType::Positional },
Argument{ "flag1", 'f', Args::Type::Exact, DefaultDesc, ArgumentType::Flag },
});
std::vector<std::string> values{ "another", "--nope" };
Invocation inv{ std::vector<std::string>(values) };
REQUIRE_COMMAND_EXCEPTION(command.ParseArguments(inv, args), CLI::Resource::String::InvalidNameError(Utility::LocIndView{ values[1] }));
}
TEST_CASE("ParseArguments_PositionalWithMultipleValues", "[command]")
{
Args args;
TestCommand command({
Argument{ "multi", 'm', Args::Type::MultiQuery, DefaultDesc, ArgumentType::Positional }.SetCountLimit(5),
});
std::vector<std::string> values{ "value1" "value2", "value3" };
Invocation inv{ std::vector<std::string>(values) };
command.ParseArguments(inv, args);
RequireValuesParsedToArg(values, command.m_args[0], args);
}
TEST_CASE("ParseArguments_PositionalWithMultipleValuesAndOtherArgs", "[command]")
{
Args args;
TestCommand command({
Argument{ "pos1", 'p', Args::Type::Source, DefaultDesc, ArgumentType::Positional },
Argument{ "pos2", 'q', Args::Type::All, DefaultDesc, ArgumentType::Positional },
Argument{ "multi", 'm', Args::Type::MultiQuery, DefaultDesc, ArgumentType::Positional }.SetCountLimit(5),
Argument{ "flag", 'f', Args::Type::BlockingPin, DefaultDesc, ArgumentType::Flag },
});
std::vector<std::string> values{ "positional", "-q", "anotherPos", "multiValue1", "multiValue2", "-f" };
Invocation inv{ std::vector<std::string>(values) };
command.ParseArguments(inv, args);
RequireValueParsedToArg(values[0], command.m_args[0], args);
RequireValueParsedToArg(values[2], command.m_args[1], args);
RequireValuesParsedToArg({ values[3], values[4] }, command.m_args[2], args);
REQUIRE(args.Contains(command.m_args[3].ExecArgType()));
}
TEST_CASE("ParseArguments_PositionalWithMultipleValuesAndName", "[command]")
{
Args args;
TestCommand command({
Argument{ "multi", 'm', Args::Type::MultiQuery, DefaultDesc, ArgumentType::Positional }.SetCountLimit(5),
});
std::vector<std::string> values{ "--multi", "one", "two", "three" };
Invocation inv{ std::vector<std::string>(values) };
command.ParseArguments(inv, args);
RequireValuesParsedToArg({ values[1], values[2], values[3] }, command.m_args[0], args);
}
TEST_CASE("ParseArguments_MultiQueryConvertedToSingleQuery", "[command]")
{
Args args;
TestCommand command({
Argument{ "multi", 'm', Args::Type::MultiQuery, DefaultDesc, ArgumentType::Positional }.SetCountLimit(5),
});
std::vector<std::string> values{ "singleValue" };
Invocation inv{ std::vector<std::string>(values) };
// ParseArguments converts MultiQuery args with a single value into Query args
command.ParseArguments(inv, args);
RequireValuesParsedToArg({ values[0] }, Args::Type::Query, args);
}
TEST_CASE("ParseArguments_PositionalWithTooManyValues", "[command]")
{
Args args;
TestCommand command({
Argument{ "multi", 'm', Args::Type::MultiQuery, DefaultDesc, ArgumentType::Positional }.SetCountLimit(5),
});
std::vector<std::string> values{ "1", "2", "3", "4", "5", "tooMany" };
Invocation inv{ std::vector<std::string>(values) };
REQUIRE_COMMAND_EXCEPTION(command.ParseArguments(inv, args), CLI::Resource::String::ExtraPositionalError(Utility::LocIndView{ values.back() }));
}