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
|
// Copyright Contributors to the DNF5 project.
// Copyright Contributors to the libdnf project.
// SPDX-License-Identifier: GPL-2.0-or-later
//
// This file is part of libdnf: https://github.com/rpm-software-management/libdnf/
//
// Libdnf is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 2 of the License, or
// (at your option) any later version.
//
// Libdnf is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with libdnf. If not, see <https://www.gnu.org/licenses/>.
#include "test_argument_parser.hpp"
#include "../shared/utils.hpp"
#include <libdnf5-cli/argument_parser.hpp>
#include <libdnf5/conf/option_bool.hpp>
#include <libdnf5/conf/option_string.hpp>
CPPUNIT_TEST_SUITE_REGISTRATION(ArgumentParserTest);
using ArgParser = libdnf5::cli::ArgumentParser;
void ArgumentParserTest::test_argument_parser() {
ArgParser arg_parser;
ArgParser::Command * selected_cmd{nullptr};
ArgParser::Command * test = arg_parser.add_new_command("test");
test->set_description("Unit test for testing ArgumentParser");
test->set_long_description("Tets is a unit test for testing ArgumentParser.");
test->set_commands_help_header("List of commands:");
test->set_named_args_help_header("Global arguments:");
arg_parser.set_root_command(test);
auto * help = arg_parser.add_new_named_arg("help");
help->set_long_name("help");
help->set_short_name('h');
help->set_description("Print help");
help->set_parse_hook_func([test](
[[maybe_unused]] ArgParser::NamedArg * arg,
[[maybe_unused]] const char * option,
[[maybe_unused]] const char * value) {
test->help();
return true;
});
test->register_named_arg(help);
auto * global_arg = arg_parser.add_new_named_arg("global_arg");
global_arg->set_long_name("global_arg");
global_arg->set_description("Global argument for test");
test->register_named_arg(global_arg);
auto * available_option =
dynamic_cast<libdnf5::OptionBool *>(arg_parser.add_init_value(std::make_unique<libdnf5::OptionBool>(true)));
CPPUNIT_ASSERT(available_option);
auto * installed_option =
dynamic_cast<libdnf5::OptionBool *>(arg_parser.add_init_value(std::make_unique<libdnf5::OptionBool>(false)));
CPPUNIT_ASSERT(installed_option);
auto * info_option =
dynamic_cast<libdnf5::OptionBool *>(arg_parser.add_init_value(std::make_unique<libdnf5::OptionBool>(false)));
CPPUNIT_ASSERT(info_option);
auto * nevra_option =
dynamic_cast<libdnf5::OptionBool *>(arg_parser.add_init_value(std::make_unique<libdnf5::OptionBool>(true)));
CPPUNIT_ASSERT(nevra_option);
auto * available = arg_parser.add_new_named_arg("available");
available->set_long_name("available");
available->set_description("display available packages (default)");
available->set_const_value("true");
available->link_value(available_option);
auto * installed = arg_parser.add_new_named_arg("installed");
installed->set_long_name("installed");
installed->set_description("display installed packages");
installed->set_const_value("true");
installed->link_value(installed_option);
auto * info = arg_parser.add_new_named_arg("info");
info->set_long_name("info");
info->set_description("show detailed information about the packages");
info->set_const_value("true");
info->link_value(info_option);
auto * nevra = arg_parser.add_new_named_arg("nevra");
nevra->set_long_name("nevra");
nevra->set_description("use name-epoch:version-release.architecture format for displaying packages (default)");
nevra->set_const_value("true");
nevra->link_value(nevra_option);
auto * keys_options = arg_parser.add_new_values();
auto * keys = arg_parser.add_new_positional_arg(
"keys",
ArgParser::PositionalArg::UNLIMITED,
arg_parser.add_init_value(std::make_unique<libdnf5::OptionString>(nullptr)),
keys_options);
keys->set_description("List of keys to match");
info->add_conflict_argument(*nevra);
ArgParser::Command * repoquery = arg_parser.add_new_command("repoquery");
repoquery->set_description("search for packages matching keyword");
repoquery->set_long_description("");
repoquery->set_named_args_help_header("Optional arguments:");
repoquery->set_positional_args_help_header("Positional arguments:");
repoquery->set_parse_hook_func([&selected_cmd](
ArgParser::Argument * arg,
[[maybe_unused]] const char * option,
[[maybe_unused]] int argc,
[[maybe_unused]] const char * const argv[]) {
selected_cmd = dynamic_cast<ArgParser::Command *>(arg);
return true;
});
repoquery->register_named_arg(available);
repoquery->register_named_arg(installed);
repoquery->register_named_arg(info);
repoquery->register_named_arg(nevra);
repoquery->register_positional_arg(keys);
test->register_command(repoquery);
CPPUNIT_ASSERT_THROW(arg_parser.add_new_command("bad.id"), libdnf5::cli::ArgumentParserArgumentInvalidIdError);
CPPUNIT_ASSERT_THROW(arg_parser.add_new_named_arg("bad.id"), libdnf5::cli::ArgumentParserArgumentInvalidIdError);
CPPUNIT_ASSERT_THROW(
arg_parser.add_new_positional_arg("bad.id", ArgParser::PositionalArg::UNLIMITED, nullptr, nullptr),
libdnf5::cli::ArgumentParserArgumentInvalidIdError);
CPPUNIT_ASSERT_EQUAL(test, arg_parser.get_root_command());
CPPUNIT_ASSERT_EQUAL(repoquery, &arg_parser.get_command("repoquery"));
CPPUNIT_ASSERT_THROW(arg_parser.get_command("unknowncmd"), libdnf5::cli::ArgumentParserNotFoundError);
CPPUNIT_ASSERT_THROW(arg_parser.get_command("global_arg"), libdnf5::cli::ArgumentParserNotFoundError);
CPPUNIT_ASSERT_EQUAL(global_arg, &arg_parser.get_named_arg("global_arg", false));
CPPUNIT_ASSERT_EQUAL(global_arg, &arg_parser.get_named_arg("global_arg", true));
CPPUNIT_ASSERT_EQUAL(installed, &arg_parser.get_named_arg("repoquery.installed", false));
CPPUNIT_ASSERT_EQUAL(installed, &arg_parser.get_named_arg("repoquery.installed", true));
CPPUNIT_ASSERT_THROW(
arg_parser.get_named_arg("repoquery.global_arg", false), libdnf5::cli::ArgumentParserNotFoundError);
CPPUNIT_ASSERT_EQUAL(global_arg, &arg_parser.get_named_arg("repoquery.global_arg", true));
CPPUNIT_ASSERT_THROW(
arg_parser.get_named_arg("unknowncmd.installed", false), libdnf5::cli::ArgumentParserNotFoundError);
CPPUNIT_ASSERT_THROW(
arg_parser.get_named_arg("unknowncmd.installed", true), libdnf5::cli::ArgumentParserNotFoundError);
CPPUNIT_ASSERT_THROW(
arg_parser.get_named_arg("repoquery.unknown", false), libdnf5::cli::ArgumentParserNotFoundError);
CPPUNIT_ASSERT_THROW(
arg_parser.get_named_arg("repoquery.unknown", true), libdnf5::cli::ArgumentParserNotFoundError);
CPPUNIT_ASSERT_THROW(arg_parser.get_named_arg("repoquery.keys", false), libdnf5::cli::ArgumentParserNotFoundError);
CPPUNIT_ASSERT_THROW(arg_parser.get_named_arg("repoquery.keys", true), libdnf5::cli::ArgumentParserNotFoundError);
CPPUNIT_ASSERT_EQUAL(keys, &arg_parser.get_positional_arg("repoquery.keys", false));
CPPUNIT_ASSERT_EQUAL(keys, &arg_parser.get_positional_arg("repoquery.keys", true));
CPPUNIT_ASSERT_THROW(
arg_parser.get_positional_arg("unknowncmd.keys", false), libdnf5::cli::ArgumentParserNotFoundError);
CPPUNIT_ASSERT_THROW(
arg_parser.get_positional_arg("unknowncmd.keys", true), libdnf5::cli::ArgumentParserNotFoundError);
CPPUNIT_ASSERT_THROW(
arg_parser.get_positional_arg("repoquery.unknown", false), libdnf5::cli::ArgumentParserNotFoundError);
CPPUNIT_ASSERT_THROW(
arg_parser.get_positional_arg("repoquery.unknown", true), libdnf5::cli::ArgumentParserNotFoundError);
CPPUNIT_ASSERT_THROW(
arg_parser.get_positional_arg("repoquery.installed", false), libdnf5::cli::ArgumentParserNotFoundError);
CPPUNIT_ASSERT_THROW(
arg_parser.get_positional_arg("repoquery.installed", true), libdnf5::cli::ArgumentParserNotFoundError);
CPPUNIT_ASSERT_EQUAL((std::vector<ArgParser::Command *>{repoquery}), test->get_commands());
CPPUNIT_ASSERT_EQUAL((std::vector<ArgParser::NamedArg *>{help, global_arg}), test->get_named_args());
CPPUNIT_ASSERT_EQUAL((std::vector<ArgParser::PositionalArg *>{}), test->get_positional_args());
CPPUNIT_ASSERT_EQUAL(repoquery, &test->get_command("repoquery"));
CPPUNIT_ASSERT_THROW(test->get_command("unknowncmd"), libdnf5::cli::ArgumentParserNotFoundError);
CPPUNIT_ASSERT_EQUAL(global_arg, &test->get_named_arg("global_arg"));
CPPUNIT_ASSERT_THROW(test->get_named_arg("unknown"), libdnf5::cli::ArgumentParserNotFoundError);
CPPUNIT_ASSERT_THROW(test->get_positional_arg("keys"), libdnf5::cli::ArgumentParserNotFoundError);
CPPUNIT_ASSERT_EQUAL((std::vector<ArgParser::Command *>{}), repoquery->get_commands());
CPPUNIT_ASSERT_EQUAL(
(std::vector<ArgParser::NamedArg *>{available, installed, info, nevra}), repoquery->get_named_args());
CPPUNIT_ASSERT_EQUAL((std::vector<ArgParser::PositionalArg *>{keys}), repoquery->get_positional_args());
CPPUNIT_ASSERT_THROW(repoquery->get_command("repoquery"), libdnf5::cli::ArgumentParserNotFoundError);
CPPUNIT_ASSERT_EQUAL(info, &repoquery->get_named_arg("info"));
CPPUNIT_ASSERT_THROW(repoquery->get_named_arg("unknown"), libdnf5::cli::ArgumentParserNotFoundError);
CPPUNIT_ASSERT_EQUAL(keys, &repoquery->get_positional_arg("keys"));
CPPUNIT_ASSERT_THROW(repoquery->get_positional_arg("unknown"), libdnf5::cli::ArgumentParserNotFoundError);
CPPUNIT_ASSERT_EQUAL(std::string("info"), info->get_id());
CPPUNIT_ASSERT_EQUAL(info_option, dynamic_cast<libdnf5::OptionBool *>(info->get_linked_value()));
CPPUNIT_ASSERT_EQUAL(0, info->get_parse_count());
CPPUNIT_ASSERT_EQUAL(std::string("keys"), keys->get_id());
CPPUNIT_ASSERT_EQUAL(keys_options, keys->get_linked_values());
CPPUNIT_ASSERT_EQUAL(0, info->get_parse_count());
{
constexpr const char * argv[]{"test", "repoquery", "--installed", "--info"};
arg_parser.parse(std::size(argv), argv);
CPPUNIT_ASSERT_EQUAL(repoquery, selected_cmd);
auto * installed_linked_option = dynamic_cast<libdnf5::OptionBool *>(installed->get_linked_value());
CPPUNIT_ASSERT(installed_linked_option);
CPPUNIT_ASSERT_EQUAL(true, installed_linked_option->get_value());
}
{
// "--info" and "--nevra" cannot be used together
constexpr const char * argv[]{"test", "repoquery", "--nevra", "--info"};
CPPUNIT_ASSERT_THROW(
arg_parser.parse(std::size(argv), argv), libdnf5::cli::ArgumentParserConflictingArgumentsError);
}
{
// The number of values required by the "keys" positional argument is set to UNLIMITED, "abc" and "def" will be parsed.
constexpr const char * argv[]{"test", "repoquery", "--info", "abc", "def"};
arg_parser.parse(std::size(argv), argv);
const auto & options = *keys->get_linked_values();
CPPUNIT_ASSERT_EQUAL(static_cast<size_t>(2), options.size());
CPPUNIT_ASSERT_EQUAL(
std::string("abc"), dynamic_cast<const libdnf5::OptionString *>(options[0].get())->get_value());
CPPUNIT_ASSERT_EQUAL(
std::string("def"), dynamic_cast<const libdnf5::OptionString *>(options[1].get())->get_value());
}
{
// By default, the positional argument cannot be repeated. Throws an exception on "def".
constexpr const char * argv[]{"test", "repoquery", "abc", "--info", "def", "gh"};
CPPUNIT_ASSERT_THROW(arg_parser.parse(std::size(argv), argv), libdnf5::cli::ArgumentParserUnknownArgumentError);
}
{
// Allow repeating the "keys" positional argument on the command line
keys->set_nrepeats(ArgParser::PositionalArg::UNLIMITED);
// Stores all values of the repeated positional argument "keys" into a local vector using a hook function.
std::vector<std::string> key_vals;
keys->set_parse_hook_func(
[&key_vals]([[maybe_unused]] ArgParser::PositionalArg * arg, int argc, const char * const argv[]) {
for (int i = 0; i < argc; ++i) {
key_vals.emplace_back(argv[i]);
}
return true;
});
constexpr const char * argv[]{"test", "repoquery", "abc", "--info", "def", "gh"};
arg_parser.parse(std::size(argv), argv);
CPPUNIT_ASSERT_EQUAL(static_cast<size_t>(3), key_vals.size());
CPPUNIT_ASSERT_EQUAL(std::string("abc"), key_vals[0]);
CPPUNIT_ASSERT_EQUAL(std::string("def"), key_vals[1]);
CPPUNIT_ASSERT_EQUAL(std::string("gh"), key_vals[2]);
keys->set_complete_hook_func(nullptr);
}
}
|
