Line data Source code
1 : /*
2 : * License:
3 : * Copyright (c) 2006-2021 Made to Order Software Corp. All Rights Reserved
4 : *
5 : * https://snapwebsites.org/
6 : * contact@m2osw.com
7 : *
8 : * This program is free software; you can redistribute it and/or modify
9 : * it under the terms of the GNU General Public License as published by
10 : * the Free Software Foundation; either version 2 of the License, or
11 : * (at your option) any later version.
12 : *
13 : * This program is distributed in the hope that it will be useful,
14 : * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 : * GNU General Public License for more details.
17 : *
18 : * You should have received a copy of the GNU General Public License along
19 : * with this program; if not, write to the Free Software Foundation, Inc.,
20 : * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 : *
22 : * Authors:
23 : * Alexis Wilke alexis@m2osw.com
24 : */
25 :
26 : // self
27 : //
28 : #include "main.h"
29 :
30 : // advgetopt lib
31 : //
32 : #include <advgetopt/exception.h>
33 :
34 : // snapdev lib
35 : //
36 : #include <snapdev/ostream_to_buf.h>
37 : #include <snapdev/safe_setenv.h>
38 :
39 : // C++ lib
40 : //
41 : #include <fstream>
42 : #include <sstream>
43 :
44 :
45 :
46 :
47 :
48 :
49 :
50 :
51 :
52 :
53 :
54 :
55 10 : CATCH_TEST_CASE("flag_argument", "[arguments][valid][getopt]")
56 : {
57 16 : CATCH_START_SECTION("Verify a simple --verbose argument")
58 2 : advgetopt::option const options[] =
59 : {
60 : advgetopt::define_option(
61 : advgetopt::Name("verbose")
62 : , advgetopt::ShortName('v')
63 : , advgetopt::Flags(advgetopt::standalone_command_flags())
64 : , advgetopt::Help("print info as we work.")
65 : ),
66 : advgetopt::end_options()
67 : };
68 :
69 2 : advgetopt::options_environment environment_options;
70 2 : environment_options.f_project_name = "unittest";
71 2 : environment_options.f_options = options;
72 2 : environment_options.f_environment_flags = 0;
73 2 : environment_options.f_help_header = "Usage: test simple --verbose option";
74 2 : environment_options.f_environment_variable_name = "ADVGETOPT_UNDEFINED_VARIABLE_TO_TEST_THE_NULL";
75 :
76 4 : CATCH_WHEN("using long form")
77 : {
78 1 : char const * cargv[] =
79 : {
80 : "/usr/bin/arguments",
81 : "--verbose",
82 : nullptr
83 : };
84 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
85 1 : char ** argv = const_cast<char **>(cargv);
86 :
87 2 : advgetopt::getopt opt(environment_options, argc, argv);
88 :
89 : // check that the result is valid
90 :
91 : // an invalid parameter, MUST NOT EXIST
92 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
93 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
94 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
95 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
96 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
97 :
98 : // no default
99 1 : CATCH_REQUIRE(opt.get_option("--") == nullptr);
100 1 : CATCH_REQUIRE_FALSE(opt.is_defined("--"));
101 1 : CATCH_REQUIRE(opt.get_default("--").empty());
102 1 : CATCH_REQUIRE(opt.size("--") == 0);
103 :
104 : // the valid parameter
105 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
106 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
107 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
108 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
109 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
110 :
111 : // other parameters
112 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
113 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
114 : }
115 :
116 4 : CATCH_WHEN("using short form")
117 : {
118 1 : char const * cargv[] =
119 : {
120 : "/usr/bin/arguments",
121 : "-v",
122 : nullptr
123 : };
124 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
125 1 : char ** argv = const_cast<char **>(cargv);
126 :
127 2 : advgetopt::getopt opt(environment_options, argc, argv);
128 :
129 : // check that the result is valid
130 :
131 : // an invalid parameter, MUST NOT EXIST
132 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
133 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
134 1 : CATCH_REQUIRE(opt.get_option('Z', true) == nullptr);
135 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
136 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
137 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
138 :
139 : // no default
140 1 : CATCH_REQUIRE(opt.get_option("--") == nullptr);
141 1 : CATCH_REQUIRE_FALSE(opt.is_defined("--"));
142 1 : CATCH_REQUIRE(opt.get_default("--").empty());
143 1 : CATCH_REQUIRE(opt.size("--") == 0);
144 :
145 : // the valid parameter
146 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
147 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
148 1 : CATCH_REQUIRE(opt.get_option('v', true) == opt.get_option('v'));
149 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
150 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
151 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
152 :
153 : // other parameters
154 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
155 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
156 : }
157 : CATCH_END_SECTION()
158 :
159 16 : CATCH_START_SECTION("Verify a simple --verbose argument in a variable")
160 2 : advgetopt::option const options[] =
161 : {
162 : advgetopt::define_option(
163 : advgetopt::Name("verbose")
164 : , advgetopt::ShortName('v')
165 : , advgetopt::Flags(advgetopt::var_flags<advgetopt::GETOPT_FLAG_FLAG>())
166 : , advgetopt::Help("print info as we work.")
167 : ),
168 : advgetopt::end_options()
169 : };
170 :
171 2 : advgetopt::options_environment environment_options;
172 2 : environment_options.f_project_name = "unittest";
173 2 : environment_options.f_options = options;
174 2 : environment_options.f_environment_flags = 0;
175 2 : environment_options.f_help_header = "Usage: test simple --verbose option";
176 2 : environment_options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
177 :
178 4 : CATCH_WHEN("using long form")
179 : {
180 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "--verbose");
181 :
182 1 : char const * cargv[] =
183 : {
184 : "/usr/bin/arguments",
185 : nullptr
186 : };
187 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
188 1 : char ** argv = const_cast<char **>(cargv);
189 :
190 2 : advgetopt::getopt opt(environment_options, argc, argv);
191 :
192 : // check that the result is valid
193 :
194 : // an invalid parameter, MUST NOT EXIST
195 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
196 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
197 1 : CATCH_REQUIRE(opt.get_option('Z', true) == nullptr);
198 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
199 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
200 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
201 :
202 : // no default
203 1 : CATCH_REQUIRE(opt.get_option("--") == nullptr);
204 1 : CATCH_REQUIRE_FALSE(opt.is_defined("--"));
205 1 : CATCH_REQUIRE(opt.get_default("--").empty());
206 1 : CATCH_REQUIRE(opt.size("--") == 0);
207 :
208 : // the valid parameter
209 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
210 1 : CATCH_REQUIRE(opt.get_option('v') == opt.get_option("verbose"));
211 1 : CATCH_REQUIRE(opt.get_option('v', true) == opt.get_option('v'));
212 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
213 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
214 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
215 :
216 : // other parameters
217 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
218 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
219 : }
220 :
221 4 : CATCH_WHEN("using short form")
222 : {
223 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "-v");
224 :
225 1 : char const * cargv[] =
226 : {
227 : "/usr/bin/arguments",
228 : nullptr
229 : };
230 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
231 1 : char ** argv = const_cast<char **>(cargv);
232 :
233 2 : advgetopt::getopt opt(environment_options, argc, argv);
234 :
235 : // check that the result is valid
236 :
237 : // an invalid parameter, MUST NOT EXIST
238 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
239 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
240 1 : CATCH_REQUIRE(opt.get_option('Z', true) == nullptr);
241 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
242 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
243 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
244 :
245 : // no default
246 1 : CATCH_REQUIRE(opt.get_option("--") == nullptr);
247 1 : CATCH_REQUIRE_FALSE(opt.is_defined("--"));
248 1 : CATCH_REQUIRE(opt.get_default("--").empty());
249 1 : CATCH_REQUIRE(opt.size("--") == 0);
250 :
251 : // the valid parameter
252 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
253 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
254 1 : CATCH_REQUIRE(opt.get_option('v', true) == opt.get_option("verbose"));
255 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
256 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
257 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
258 :
259 : // other parameters
260 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
261 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
262 : }
263 : CATCH_END_SECTION()
264 :
265 16 : CATCH_START_SECTION("Verify a simple alias argument")
266 2 : advgetopt::option const options[] =
267 : {
268 : advgetopt::define_option(
269 : advgetopt::Name("verbosity")
270 : , advgetopt::ShortName('n')
271 : , advgetopt::Flags(advgetopt::standalone_command_flags<advgetopt::GETOPT_FLAG_FLAG>())
272 : , advgetopt::Alias("verbose")
273 : ),
274 : advgetopt::define_option(
275 : advgetopt::Name("verbose")
276 : , advgetopt::ShortName('v')
277 : , advgetopt::Flags(advgetopt::standalone_command_flags())
278 : , advgetopt::Help("print info as we work.")
279 : ),
280 : advgetopt::end_options()
281 : };
282 :
283 2 : advgetopt::options_environment environment_options;
284 2 : environment_options.f_project_name = "unittest";
285 2 : environment_options.f_options = options;
286 2 : environment_options.f_environment_flags = 0;
287 2 : environment_options.f_help_header = "Usage: test simple --verbosity option";
288 :
289 4 : CATCH_WHEN("using long form")
290 : {
291 1 : char const * cargv[] =
292 : {
293 : "/usr/bin/arguments",
294 : "--verbosity",
295 : nullptr
296 : };
297 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
298 1 : char ** argv = const_cast<char **>(cargv);
299 :
300 2 : advgetopt::getopt opt(environment_options, argc, argv);
301 :
302 : // check that the result is valid
303 :
304 : // an invalid parameter, MUST NOT EXIST
305 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
306 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
307 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
308 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
309 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
310 :
311 : // no default
312 1 : CATCH_REQUIRE(opt.get_option("--") == nullptr);
313 1 : CATCH_REQUIRE_FALSE(opt.is_defined("--"));
314 1 : CATCH_REQUIRE(opt.get_default("--").empty());
315 1 : CATCH_REQUIRE(opt.size("--") == 0);
316 :
317 : // the valid parameter
318 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
319 1 : CATCH_REQUIRE(opt.get_option('v') == opt.get_option("verbose"));
320 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
321 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
322 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
323 :
324 : // the alias parameter
325 1 : CATCH_REQUIRE(opt.get_option("verbosity") != nullptr);
326 1 : CATCH_REQUIRE(opt.get_option("verbosity") == opt.get_option("verbose"));
327 1 : CATCH_REQUIRE(opt.is_defined("verbosity"));
328 1 : CATCH_REQUIRE(opt.get_default("verbosity").empty());
329 1 : CATCH_REQUIRE(opt.size("verbosity") == 1);
330 :
331 : // other parameters
332 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
333 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
334 : }
335 :
336 4 : CATCH_WHEN("using short form")
337 : {
338 1 : char const * cargv[] =
339 : {
340 : "/usr/bin/arguments",
341 : "-n",
342 : nullptr
343 : };
344 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
345 1 : char ** argv = const_cast<char **>(cargv);
346 :
347 2 : advgetopt::getopt opt(environment_options, argc, argv);
348 :
349 : // check that the result is valid
350 :
351 : // an invalid parameter, MUST NOT EXIST
352 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
353 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
354 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
355 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
356 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
357 :
358 : // no default
359 1 : CATCH_REQUIRE(opt.get_option("--") == nullptr);
360 1 : CATCH_REQUIRE_FALSE(opt.is_defined("--"));
361 1 : CATCH_REQUIRE(opt.get_default("--").empty());
362 1 : CATCH_REQUIRE(opt.size("--") == 0);
363 :
364 : // the valid parameter
365 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
366 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
367 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
368 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
369 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
370 :
371 : // the alias parameter
372 1 : CATCH_REQUIRE(opt.get_option("verbosity") != nullptr);
373 1 : CATCH_REQUIRE(opt.get_option("verbosity") == opt.get_option("verbose"));
374 1 : CATCH_REQUIRE(opt.is_defined("verbosity"));
375 1 : CATCH_REQUIRE(opt.get_option('n') == opt.get_option("verbose"));
376 1 : CATCH_REQUIRE(opt.get_option('n', true) == opt.get_option("verbosity", true));
377 1 : CATCH_REQUIRE(opt.get_option('n', true) != opt.get_option("verbose"));
378 1 : CATCH_REQUIRE(opt.get_default("verbosity").empty());
379 1 : CATCH_REQUIRE(opt.size("verbosity") == 1);
380 :
381 : // other parameters
382 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
383 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
384 : }
385 : CATCH_END_SECTION()
386 :
387 16 : CATCH_START_SECTION("Verify a simple alias argument in a variable")
388 2 : advgetopt::option const options[] =
389 : {
390 : advgetopt::define_option(
391 : advgetopt::Name("verbose")
392 : , advgetopt::ShortName('v')
393 : , advgetopt::Flags(advgetopt::var_flags<advgetopt::GETOPT_FLAG_FLAG>())
394 : , advgetopt::Help("print info as we work.")
395 : ),
396 : advgetopt::define_option(
397 : advgetopt::Name("verbosity")
398 : , advgetopt::ShortName('n')
399 : , advgetopt::Flags(advgetopt::var_flags<advgetopt::GETOPT_FLAG_FLAG>())
400 : , advgetopt::Alias("verbose")
401 : ),
402 : advgetopt::end_options()
403 : };
404 :
405 2 : advgetopt::options_environment environment_options;
406 2 : environment_options.f_project_name = "unittest";
407 2 : environment_options.f_options = options;
408 2 : environment_options.f_environment_flags = 0;
409 2 : environment_options.f_help_header = "Usage: test simple --verbosity option";
410 2 : environment_options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
411 :
412 4 : CATCH_WHEN("using long form")
413 : {
414 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "--verbosity");
415 :
416 1 : char const * cargv[] =
417 : {
418 : "/usr/bin/arguments",
419 : nullptr
420 : };
421 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
422 1 : char ** argv = const_cast<char **>(cargv);
423 :
424 2 : advgetopt::getopt opt(environment_options, argc, argv);
425 :
426 : // check that the result is valid
427 :
428 : // an invalid parameter, MUST NOT EXIST
429 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
430 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
431 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
432 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
433 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
434 :
435 : // no default
436 1 : CATCH_REQUIRE(opt.get_option("--") == nullptr);
437 1 : CATCH_REQUIRE_FALSE(opt.is_defined("--"));
438 1 : CATCH_REQUIRE(opt.get_default("--").empty());
439 1 : CATCH_REQUIRE(opt.size("--") == 0);
440 :
441 : // the valid parameter
442 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
443 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
444 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
445 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
446 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
447 :
448 : // the alias parameter
449 1 : CATCH_REQUIRE(opt.get_option("verbosity") != nullptr);
450 1 : CATCH_REQUIRE(opt.get_option("verbosity") == opt.get_option("verbose"));
451 1 : CATCH_REQUIRE(opt.is_defined("verbosity"));
452 1 : CATCH_REQUIRE(opt.get_default("verbosity").empty());
453 1 : CATCH_REQUIRE(opt.size("verbosity") == 1);
454 :
455 : // other parameters
456 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
457 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
458 : }
459 :
460 4 : CATCH_WHEN("using short form")
461 : {
462 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "-n");
463 :
464 1 : char const * cargv[] =
465 : {
466 : "/usr/bin/arguments",
467 : nullptr
468 : };
469 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
470 1 : char ** argv = const_cast<char **>(cargv);
471 :
472 2 : advgetopt::getopt opt(environment_options, argc, argv);
473 :
474 : // check that the result is valid
475 :
476 : // an invalid parameter, MUST NOT EXIST
477 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
478 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
479 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
480 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
481 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
482 :
483 : // no default
484 1 : CATCH_REQUIRE(opt.get_option("--") == nullptr);
485 1 : CATCH_REQUIRE_FALSE(opt.is_defined("--"));
486 1 : CATCH_REQUIRE(opt.get_default("--").empty());
487 1 : CATCH_REQUIRE(opt.size("--") == 0);
488 :
489 : // the valid parameter
490 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
491 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
492 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
493 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
494 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
495 :
496 : // the alias parameter
497 1 : CATCH_REQUIRE(opt.get_option("verbosity") != nullptr);
498 1 : CATCH_REQUIRE(opt.get_option("verbosity") == opt.get_option("verbose"));
499 1 : CATCH_REQUIRE(opt.is_defined("verbosity"));
500 1 : CATCH_REQUIRE(opt.get_default("verbosity").empty());
501 1 : CATCH_REQUIRE(opt.size("verbosity") == 1);
502 :
503 : // other parameters
504 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
505 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
506 : }
507 : CATCH_END_SECTION()
508 8 : }
509 :
510 :
511 13 : CATCH_TEST_CASE("require_argument", "[arguments][valid][required][getopt]")
512 : {
513 22 : CATCH_START_SECTION("Verify a simple --out <filename> argument")
514 3 : advgetopt::option const options[] =
515 : {
516 : advgetopt::define_option(
517 : advgetopt::Name("out")
518 : , advgetopt::ShortName('o')
519 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
520 : , advgetopt::Help("output filename.")
521 : ),
522 : advgetopt::end_options()
523 : };
524 :
525 3 : advgetopt::options_environment environment_options;
526 3 : environment_options.f_project_name = "unittest";
527 3 : environment_options.f_options = options;
528 3 : environment_options.f_environment_flags = advgetopt::GETOPT_ENVIRONMENT_FLAG_SYSTEM_PARAMETERS;
529 3 : environment_options.f_help_header = "Usage: test simple --out <filename> option";
530 :
531 6 : CATCH_WHEN("using long form")
532 : {
533 1 : char const * cargv[] =
534 : {
535 : "/usr/bin/arguments",
536 : "--out",
537 : "my-filename.out",
538 : "--license",
539 : nullptr
540 : };
541 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
542 1 : char ** argv = const_cast<char **>(cargv);
543 :
544 2 : advgetopt::getopt opt(environment_options, argc, argv);
545 :
546 : // check that the result is valid
547 :
548 : // an invalid parameter, MUST NOT EXIST
549 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
550 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
551 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
552 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
553 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
554 :
555 : // the valid parameter
556 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
557 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
558 1 : CATCH_REQUIRE(opt.is_defined("out"));
559 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
560 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
561 1 : CATCH_REQUIRE(opt.get_default("out").empty());
562 1 : CATCH_REQUIRE(opt.size("out") == 1);
563 :
564 : // the license system parameter
565 1 : CATCH_REQUIRE(opt.get_option("license") != nullptr);
566 1 : CATCH_REQUIRE(opt.get_option('L') != nullptr);
567 1 : CATCH_REQUIRE(opt.is_defined("license"));
568 1 : CATCH_REQUIRE(opt.get_default("license").empty());
569 1 : CATCH_REQUIRE(opt.size("license") == 1);
570 :
571 : // the copyright system parameter
572 1 : CATCH_REQUIRE(opt.get_option("copyright") != nullptr);
573 1 : CATCH_REQUIRE(opt.get_option('C') != nullptr);
574 1 : CATCH_REQUIRE_FALSE(opt.is_defined("copyright"));
575 1 : CATCH_REQUIRE(opt.get_default("copyright").empty());
576 1 : CATCH_REQUIRE(opt.size("copyright") == 0);
577 :
578 : // other parameters
579 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
580 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
581 : }
582 :
583 6 : CATCH_WHEN("using long form with an equal sign")
584 : {
585 1 : char const * cargv[] =
586 : {
587 : "/usr/bin/arguments",
588 : "--out=my-filename.out",
589 : nullptr
590 : };
591 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
592 1 : char ** argv = const_cast<char **>(cargv);
593 :
594 2 : advgetopt::getopt opt(environment_options, argc, argv);
595 :
596 : // check that the result is valid
597 :
598 : // an invalid parameter, MUST NOT EXIST
599 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
600 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
601 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
602 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
603 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
604 :
605 : // the valid parameter
606 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
607 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
608 1 : CATCH_REQUIRE(opt.is_defined("out"));
609 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
610 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
611 1 : CATCH_REQUIRE(opt.get_default("out").empty());
612 1 : CATCH_REQUIRE(opt.size("out") == 1);
613 :
614 : // other parameters
615 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
616 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
617 : }
618 :
619 6 : CATCH_WHEN("using short form")
620 : {
621 1 : char const * cargv[] =
622 : {
623 : "/usr/bin/arguments",
624 : "-o",
625 : "my-filename.out",
626 : nullptr
627 : };
628 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
629 1 : char ** argv = const_cast<char **>(cargv);
630 :
631 2 : advgetopt::getopt opt(environment_options, argc, argv);
632 :
633 : // check that the result is valid
634 :
635 : // an invalid parameter, MUST NOT EXIST
636 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
637 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
638 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
639 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
640 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
641 :
642 : // the valid parameter
643 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
644 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
645 1 : CATCH_REQUIRE(opt.is_defined("out"));
646 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
647 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
648 1 : CATCH_REQUIRE(opt.get_default("out").empty());
649 1 : CATCH_REQUIRE(opt.size("out") == 1);
650 :
651 : // other parameters
652 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
653 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
654 : }
655 : CATCH_END_SECTION()
656 :
657 22 : CATCH_START_SECTION("Verify a simple alias of --out <filename> argument")
658 3 : advgetopt::option const options[] =
659 : {
660 : advgetopt::define_option(
661 : advgetopt::Name("out")
662 : , advgetopt::ShortName('o')
663 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
664 : , advgetopt::Help("output filename.")
665 : ),
666 : advgetopt::define_option(
667 : advgetopt::Name("results")
668 : , advgetopt::ShortName('r')
669 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
670 : , advgetopt::Alias("out")
671 : ),
672 : advgetopt::end_options()
673 : };
674 :
675 3 : advgetopt::options_environment environment_options;
676 3 : environment_options.f_project_name = "unittest";
677 3 : environment_options.f_options = options;
678 3 : environment_options.f_environment_flags = 0;
679 3 : environment_options.f_help_header = "Usage: test simple --results <filename> option";
680 :
681 6 : CATCH_WHEN("using long form")
682 : {
683 1 : char const * cargv[] =
684 : {
685 : "/usr/bin/arguments",
686 : "--results",
687 : "my-filename.out",
688 : nullptr
689 : };
690 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
691 1 : char ** argv = const_cast<char **>(cargv);
692 :
693 2 : advgetopt::getopt opt(environment_options, argc, argv);
694 :
695 : // check that the result is valid
696 :
697 : // an invalid parameter, MUST NOT EXIST
698 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
699 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
700 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
701 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
702 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
703 :
704 : // the valid parameter
705 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
706 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
707 1 : CATCH_REQUIRE(opt.is_defined("out"));
708 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
709 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
710 1 : CATCH_REQUIRE(opt.get_default("out").empty());
711 1 : CATCH_REQUIRE(opt.size("out") == 1);
712 :
713 : // the alias parameter
714 1 : CATCH_REQUIRE(opt.get_option("results") != nullptr);
715 1 : CATCH_REQUIRE(opt.get_option("results") == opt.get_option("out"));
716 1 : CATCH_REQUIRE(opt.is_defined("results"));
717 1 : CATCH_REQUIRE(opt.is_defined("results"));
718 1 : CATCH_REQUIRE(opt.get_string("results") == "my-filename.out");
719 1 : CATCH_REQUIRE(opt.get_string("results", 0) == "my-filename.out");
720 1 : CATCH_REQUIRE(opt.get_default("results").empty());
721 1 : CATCH_REQUIRE(opt.size("results") == 1);
722 :
723 : // other parameters
724 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
725 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
726 : }
727 :
728 6 : CATCH_WHEN("using long form with an equal sign")
729 : {
730 1 : char const * cargv[] =
731 : {
732 : "/usr/bin/arguments",
733 : "--results=my-filename.out",
734 : nullptr
735 : };
736 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
737 1 : char ** argv = const_cast<char **>(cargv);
738 :
739 2 : advgetopt::getopt opt(environment_options, argc, argv);
740 :
741 : // check that the result is valid
742 :
743 : // an invalid parameter, MUST NOT EXIST
744 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
745 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
746 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
747 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
748 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
749 :
750 : // the valid parameter
751 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
752 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
753 1 : CATCH_REQUIRE(opt.is_defined("out"));
754 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
755 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
756 1 : CATCH_REQUIRE(opt.get_default("out").empty());
757 1 : CATCH_REQUIRE(opt.size("out") == 1);
758 :
759 : // the alias parameter
760 1 : CATCH_REQUIRE(opt.get_option("results") != nullptr);
761 1 : CATCH_REQUIRE(opt.get_option("results") == opt.get_option("out"));
762 1 : CATCH_REQUIRE(opt.is_defined("results"));
763 1 : CATCH_REQUIRE(opt.is_defined("results"));
764 1 : CATCH_REQUIRE(opt.get_string("results") == "my-filename.out");
765 1 : CATCH_REQUIRE(opt.get_string("results", 0) == "my-filename.out");
766 1 : CATCH_REQUIRE(opt.get_default("results").empty());
767 1 : CATCH_REQUIRE(opt.size("results") == 1);
768 :
769 : // other parameters
770 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
771 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
772 : }
773 :
774 6 : CATCH_WHEN("using short form")
775 : {
776 1 : char const * cargv[] =
777 : {
778 : "/usr/bin/arguments",
779 : "-r",
780 : "my-filename.out",
781 : nullptr
782 : };
783 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
784 1 : char ** argv = const_cast<char **>(cargv);
785 :
786 2 : advgetopt::getopt opt(environment_options, argc, argv);
787 :
788 : // check that the result is valid
789 :
790 : // an invalid parameter, MUST NOT EXIST
791 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
792 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
793 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
794 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
795 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
796 :
797 : // the valid parameter
798 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
799 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
800 1 : CATCH_REQUIRE(opt.is_defined("out"));
801 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
802 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
803 1 : CATCH_REQUIRE(opt.get_default("out").empty());
804 1 : CATCH_REQUIRE(opt.size("out") == 1);
805 :
806 : // the alias parameter
807 1 : CATCH_REQUIRE(opt.get_option("results") != nullptr);
808 1 : CATCH_REQUIRE(opt.get_option("results") == opt.get_option("out"));
809 1 : CATCH_REQUIRE(opt.is_defined("results"));
810 1 : CATCH_REQUIRE(opt.get_string("results") == "my-filename.out");
811 1 : CATCH_REQUIRE(opt.get_string("results", 0) == "my-filename.out");
812 1 : CATCH_REQUIRE(opt.get_default("results").empty());
813 1 : CATCH_REQUIRE(opt.size("results") == 1);
814 :
815 : // other parameters
816 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
817 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
818 : }
819 : CATCH_END_SECTION()
820 :
821 22 : CATCH_START_SECTION("Verify a simple --out <filename> argument in a variable")
822 3 : advgetopt::option const options[] =
823 : {
824 : advgetopt::define_option(
825 : advgetopt::Name("out_dir")
826 : , advgetopt::ShortName('o')
827 : , advgetopt::Flags(advgetopt::var_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
828 : , advgetopt::Help("output filename.")
829 : ),
830 : advgetopt::end_options()
831 : };
832 :
833 3 : advgetopt::options_environment environment_options;
834 3 : environment_options.f_project_name = "unittest";
835 3 : environment_options.f_options = options;
836 3 : environment_options.f_environment_flags = 0;
837 3 : environment_options.f_help_header = "Usage: test simple --out_dir <filename> option";
838 3 : environment_options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
839 :
840 6 : CATCH_WHEN("using long form")
841 : {
842 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "--out_dir my-filename.out");
843 :
844 1 : char const * cargv[] =
845 : {
846 : "/usr/bin/arguments",
847 : nullptr
848 : };
849 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
850 1 : char ** argv = const_cast<char **>(cargv);
851 :
852 2 : advgetopt::getopt opt(environment_options, argc, argv);
853 :
854 : // check that the result is valid
855 :
856 : // an invalid parameter, MUST NOT EXIST
857 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
858 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
859 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
860 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
861 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
862 :
863 : // the valid parameter
864 1 : CATCH_REQUIRE(opt.get_option("out-dir") != nullptr);
865 1 : CATCH_REQUIRE(opt.get_option("out_dir") != nullptr);
866 1 : CATCH_REQUIRE(opt.get_option("out_dir") == opt.get_option("out-dir"));
867 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
868 1 : CATCH_REQUIRE(opt.is_defined("out-dir"));
869 1 : CATCH_REQUIRE(opt.get_string("out-dir") == "my-filename.out");
870 1 : CATCH_REQUIRE(opt.get_string("out-dir", 0) == "my-filename.out");
871 1 : CATCH_REQUIRE(opt.get_default("out-dir").empty());
872 1 : CATCH_REQUIRE(opt.size("out-dir") == 1);
873 :
874 : // other parameters
875 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
876 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
877 : }
878 :
879 6 : CATCH_WHEN("using long form with an equal sign")
880 : {
881 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "--out_dir=my-filename.out");
882 :
883 1 : char const * cargv[] =
884 : {
885 : "/usr/bin/arguments",
886 : nullptr
887 : };
888 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
889 1 : char ** argv = const_cast<char **>(cargv);
890 :
891 2 : advgetopt::getopt opt(environment_options, argc, argv);
892 :
893 : // check that the result is valid
894 :
895 : // an invalid parameter, MUST NOT EXIST
896 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
897 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
898 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
899 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
900 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
901 :
902 : // the valid parameter
903 1 : CATCH_REQUIRE(opt.get_option("out_dir") != nullptr);
904 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
905 1 : CATCH_REQUIRE(opt.is_defined("out_dir"));
906 1 : CATCH_REQUIRE(opt.get_string("out_dir") == "my-filename.out");
907 1 : CATCH_REQUIRE(opt.get_string("out_dir", 0) == "my-filename.out");
908 1 : CATCH_REQUIRE(opt.get_default("out_dir").empty());
909 1 : CATCH_REQUIRE(opt.size("out_dir") == 1);
910 :
911 : // other parameters
912 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
913 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
914 : }
915 :
916 6 : CATCH_WHEN("using short form")
917 : {
918 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "-o my-filename.out");
919 :
920 1 : char const * cargv[] =
921 : {
922 : "/usr/bin/arguments",
923 : nullptr
924 : };
925 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
926 1 : char ** argv = const_cast<char **>(cargv);
927 :
928 2 : advgetopt::getopt opt(environment_options, argc, argv);
929 :
930 : // check that the result is valid
931 :
932 : // an invalid parameter, MUST NOT EXIST
933 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
934 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
935 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
936 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
937 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
938 :
939 : // the valid parameter
940 1 : CATCH_REQUIRE(opt.get_option("out_dir") != nullptr);
941 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
942 1 : CATCH_REQUIRE(opt.is_defined("out-dir"));
943 1 : CATCH_REQUIRE(opt.get_string("out_dir") == "my-filename.out");
944 1 : CATCH_REQUIRE(opt.get_string("out-dir", 0) == "my-filename.out");
945 1 : CATCH_REQUIRE(opt.get_default("out_dir").empty());
946 1 : CATCH_REQUIRE(opt.size("out-dir") == 1);
947 :
948 : // other parameters
949 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
950 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
951 : }
952 : CATCH_END_SECTION()
953 :
954 22 : CATCH_START_SECTION("Verify a simple alias of --out <filename> argument in a variable")
955 2 : advgetopt::option const options[] =
956 : {
957 : advgetopt::define_option(
958 : advgetopt::Name("out")
959 : , advgetopt::ShortName('o')
960 : , advgetopt::Flags(advgetopt::var_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
961 : , advgetopt::Help("output filename.")
962 : ),
963 : advgetopt::define_option(
964 : advgetopt::Name("results")
965 : , advgetopt::ShortName('r')
966 : , advgetopt::Flags(advgetopt::var_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
967 : , advgetopt::Alias("o")
968 : ),
969 : advgetopt::end_options()
970 : };
971 :
972 2 : advgetopt::options_environment environment_options;
973 2 : environment_options.f_project_name = "unittest";
974 2 : environment_options.f_options = options;
975 2 : environment_options.f_environment_flags = 0;
976 2 : environment_options.f_help_header = "Usage: test simple alias of --out <filename> option";
977 2 : environment_options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
978 :
979 4 : CATCH_WHEN("using long form")
980 : {
981 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "--results my-filename.out");
982 :
983 1 : char const * cargv[] =
984 : {
985 : "/usr/bin/arguments",
986 : nullptr
987 : };
988 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
989 1 : char ** argv = const_cast<char **>(cargv);
990 :
991 2 : advgetopt::getopt opt(environment_options, argc, argv);
992 :
993 : // check that the result is valid
994 :
995 : // an invalid parameter, MUST NOT EXIST
996 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
997 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
998 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
999 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1000 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
1001 :
1002 : // the valid parameter
1003 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
1004 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
1005 1 : CATCH_REQUIRE(opt.is_defined("out"));
1006 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
1007 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
1008 1 : CATCH_REQUIRE(opt.get_default("out").empty());
1009 1 : CATCH_REQUIRE(opt.size("out") == 1);
1010 :
1011 : // the alias parameter
1012 1 : CATCH_REQUIRE(opt.get_option("results") != nullptr);
1013 1 : CATCH_REQUIRE(opt.get_option("results") == opt.get_option("out"));
1014 1 : CATCH_REQUIRE(opt.is_defined("results"));
1015 1 : CATCH_REQUIRE(opt.get_string("results") == "my-filename.out");
1016 1 : CATCH_REQUIRE(opt.get_string("results", 0) == "my-filename.out");
1017 1 : CATCH_REQUIRE(opt.get_default("results").empty());
1018 1 : CATCH_REQUIRE(opt.size("results") == 1);
1019 :
1020 : // other parameters
1021 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
1022 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
1023 : }
1024 :
1025 4 : CATCH_WHEN("using short form")
1026 : {
1027 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "-r my-filename.out");
1028 :
1029 1 : char const * cargv[] =
1030 : {
1031 : "/usr/bin/arguments",
1032 : nullptr
1033 : };
1034 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
1035 1 : char ** argv = const_cast<char **>(cargv);
1036 :
1037 2 : advgetopt::getopt opt(environment_options, argc, argv);
1038 :
1039 : // check that the result is valid
1040 :
1041 : // an invalid parameter, MUST NOT EXIST
1042 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
1043 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
1044 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
1045 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1046 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
1047 :
1048 : // the valid parameter
1049 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
1050 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
1051 1 : CATCH_REQUIRE(opt.is_defined("out"));
1052 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
1053 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
1054 1 : CATCH_REQUIRE(opt.get_default("out").empty());
1055 1 : CATCH_REQUIRE(opt.size("out") == 1);
1056 :
1057 : // the alias parameter
1058 1 : CATCH_REQUIRE(opt.get_option("results") != nullptr);
1059 1 : CATCH_REQUIRE(opt.get_option("results") == opt.get_option("out"));
1060 1 : CATCH_REQUIRE(opt.is_defined("results"));
1061 1 : CATCH_REQUIRE(opt.get_string("results") == "my-filename.out");
1062 1 : CATCH_REQUIRE(opt.get_string("results", 0) == "my-filename.out");
1063 1 : CATCH_REQUIRE(opt.get_default("results").empty());
1064 1 : CATCH_REQUIRE(opt.size("results") == 1);
1065 :
1066 : // other parameters
1067 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
1068 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
1069 : }
1070 : CATCH_END_SECTION()
1071 11 : }
1072 :
1073 :
1074 8 : CATCH_TEST_CASE("require_arguments", "[arguments][valid][required][multiple][getopt]")
1075 : {
1076 12 : CATCH_START_SECTION("Verify a simple --out <filename> ... argument")
1077 2 : advgetopt::option const options[] =
1078 : {
1079 : advgetopt::define_option(
1080 : advgetopt::Name("out")
1081 : , advgetopt::ShortName('o')
1082 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED, advgetopt::GETOPT_FLAG_MULTIPLE>())
1083 : , advgetopt::Help("output filename.")
1084 : ),
1085 : advgetopt::end_options()
1086 : };
1087 :
1088 2 : advgetopt::options_environment environment_options;
1089 2 : environment_options.f_project_name = "unittest";
1090 2 : environment_options.f_options = options;
1091 2 : environment_options.f_environment_flags = 0;
1092 2 : environment_options.f_help_header = "Usage: test simple --out <filename> ... option";
1093 :
1094 4 : CATCH_WHEN("using long form")
1095 : {
1096 1 : char const * cargv[] =
1097 : {
1098 : "/usr/bin/arguments",
1099 : "--out",
1100 : "my-filename.out",
1101 : "another.out",
1102 : "last.out",
1103 : nullptr
1104 : };
1105 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
1106 1 : char ** argv = const_cast<char **>(cargv);
1107 :
1108 2 : advgetopt::getopt opt(environment_options, argc, argv);
1109 :
1110 : // check that the result is valid
1111 :
1112 : // an invalid parameter, MUST NOT EXIST
1113 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
1114 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
1115 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
1116 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1117 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
1118 :
1119 : // the valid parameter
1120 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
1121 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
1122 1 : CATCH_REQUIRE(opt.is_defined("out"));
1123 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
1124 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
1125 1 : CATCH_REQUIRE(opt.get_string("out", 1) == "another.out");
1126 1 : CATCH_REQUIRE(opt.get_string("out", 2) == "last.out");
1127 1 : CATCH_REQUIRE(opt.get_default("out").empty());
1128 1 : CATCH_REQUIRE(opt.size("out") == 3);
1129 :
1130 : // other parameters
1131 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
1132 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
1133 : }
1134 :
1135 4 : CATCH_WHEN("using short form")
1136 : {
1137 1 : char const * cargv[] =
1138 : {
1139 : "/usr/bin/arguments",
1140 : "-o",
1141 : "my-filename.out",
1142 : "another.out",
1143 : "last.out",
1144 : nullptr
1145 : };
1146 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
1147 1 : char ** argv = const_cast<char **>(cargv);
1148 :
1149 2 : advgetopt::getopt opt(environment_options, argc, argv);
1150 :
1151 : // check that the result is valid
1152 :
1153 : // an invalid parameter, MUST NOT EXIST
1154 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
1155 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
1156 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
1157 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1158 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
1159 :
1160 : // the valid parameter
1161 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
1162 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
1163 1 : CATCH_REQUIRE(opt.is_defined("out"));
1164 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
1165 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
1166 1 : CATCH_REQUIRE(opt.get_string("out", 1) == "another.out");
1167 1 : CATCH_REQUIRE(opt.get_string("out", 2) == "last.out");
1168 1 : CATCH_REQUIRE(opt.get_default("out").empty());
1169 1 : CATCH_REQUIRE(opt.size("out") == 3);
1170 :
1171 : // other parameters
1172 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
1173 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
1174 : }
1175 : CATCH_END_SECTION()
1176 :
1177 12 : CATCH_START_SECTION("Verify a simple alias of --out <filename> ... argument")
1178 2 : advgetopt::option const options[] =
1179 : {
1180 : advgetopt::define_option(
1181 : advgetopt::Name("out")
1182 : , advgetopt::ShortName('o')
1183 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED, advgetopt::GETOPT_FLAG_MULTIPLE>())
1184 : , advgetopt::Help("output filename.")
1185 : ),
1186 : advgetopt::define_option(
1187 : advgetopt::Name("results")
1188 : , advgetopt::ShortName('r')
1189 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED, advgetopt::GETOPT_FLAG_MULTIPLE>())
1190 : , advgetopt::Alias("out")
1191 : ),
1192 : advgetopt::end_options()
1193 : };
1194 :
1195 2 : advgetopt::options_environment environment_options;
1196 2 : environment_options.f_project_name = "unittest";
1197 2 : environment_options.f_options = options;
1198 2 : environment_options.f_environment_flags = 0;
1199 2 : environment_options.f_help_header = "Usage: test simple alias of --out <filename> ... option";
1200 :
1201 4 : CATCH_WHEN("using long form")
1202 : {
1203 1 : char const * cargv[] =
1204 : {
1205 : "/usr/bin/arguments",
1206 : "--results",
1207 : "my-filename.out",
1208 : "another.out",
1209 : "last.out",
1210 : nullptr
1211 : };
1212 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
1213 1 : char ** argv = const_cast<char **>(cargv);
1214 :
1215 2 : advgetopt::getopt opt(environment_options, argc, argv);
1216 :
1217 : // check that the result is valid
1218 :
1219 : // an invalid parameter, MUST NOT EXIST
1220 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
1221 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
1222 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
1223 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1224 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
1225 :
1226 : // the valid parameter
1227 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
1228 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
1229 1 : CATCH_REQUIRE(opt.is_defined("out"));
1230 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
1231 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
1232 1 : CATCH_REQUIRE(opt.get_string("out", 1) == "another.out");
1233 1 : CATCH_REQUIRE(opt.get_string("out", 2) == "last.out");
1234 1 : CATCH_REQUIRE(opt.get_default("out").empty());
1235 1 : CATCH_REQUIRE(opt.size("out") == 3);
1236 :
1237 : // the alias parameter
1238 1 : CATCH_REQUIRE(opt.get_option("results") != nullptr);
1239 1 : CATCH_REQUIRE(opt.get_option("results") == opt.get_option("out"));
1240 1 : CATCH_REQUIRE(opt.is_defined("results"));
1241 1 : CATCH_REQUIRE(opt.get_string("results") == "my-filename.out");
1242 1 : CATCH_REQUIRE(opt.get_string("results", 0) == "my-filename.out");
1243 1 : CATCH_REQUIRE(opt.get_string("results", 1) == "another.out");
1244 1 : CATCH_REQUIRE(opt.get_string("results", 2) == "last.out");
1245 1 : CATCH_REQUIRE(opt.get_default("results").empty());
1246 1 : CATCH_REQUIRE(opt.size("results") == 3);
1247 :
1248 : // other parameters
1249 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
1250 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
1251 : }
1252 :
1253 4 : CATCH_WHEN("using short form")
1254 : {
1255 1 : char const * cargv[] =
1256 : {
1257 : "/usr/bin/arguments",
1258 : "-r",
1259 : "my-filename.out",
1260 : "another.out",
1261 : "last.out",
1262 : nullptr
1263 : };
1264 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
1265 1 : char ** argv = const_cast<char **>(cargv);
1266 :
1267 2 : advgetopt::getopt opt(environment_options, argc, argv);
1268 :
1269 : // check that the result is valid
1270 :
1271 : // an invalid parameter, MUST NOT EXIST
1272 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
1273 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
1274 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
1275 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1276 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
1277 :
1278 : // the valid parameter
1279 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
1280 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
1281 1 : CATCH_REQUIRE(opt.is_defined("out"));
1282 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
1283 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
1284 1 : CATCH_REQUIRE(opt.get_string("out", 1) == "another.out");
1285 1 : CATCH_REQUIRE(opt.get_string("out", 2) == "last.out");
1286 1 : CATCH_REQUIRE(opt.get_default("out").empty());
1287 1 : CATCH_REQUIRE(opt.size("out") == 3);
1288 :
1289 : // the alias parameter
1290 1 : CATCH_REQUIRE(opt.get_option("results") != nullptr);
1291 1 : CATCH_REQUIRE(opt.get_option("results") == opt.get_option("out"));
1292 1 : CATCH_REQUIRE(opt.is_defined("results"));
1293 1 : CATCH_REQUIRE(opt.get_string("results") == "my-filename.out");
1294 1 : CATCH_REQUIRE(opt.get_string("results", 0) == "my-filename.out");
1295 1 : CATCH_REQUIRE(opt.get_string("results", 1) == "another.out");
1296 1 : CATCH_REQUIRE(opt.get_string("results", 2) == "last.out");
1297 1 : CATCH_REQUIRE(opt.get_default("results").empty());
1298 1 : CATCH_REQUIRE(opt.size("results") == 3);
1299 :
1300 : // other parameters
1301 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
1302 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
1303 : }
1304 : CATCH_END_SECTION()
1305 :
1306 12 : CATCH_START_SECTION("Verify a simple --out <filename> ... argument in a variable")
1307 2 : advgetopt::option const options[] =
1308 : {
1309 : advgetopt::define_option(
1310 : advgetopt::Name("out")
1311 : , advgetopt::ShortName('o')
1312 : , advgetopt::Flags(advgetopt::var_flags<advgetopt::GETOPT_FLAG_REQUIRED, advgetopt::GETOPT_FLAG_MULTIPLE>())
1313 : , advgetopt::Help("output filename.")
1314 : ),
1315 : advgetopt::end_options()
1316 : };
1317 :
1318 2 : advgetopt::options_environment environment_options;
1319 2 : environment_options.f_project_name = "unittest";
1320 2 : environment_options.f_options = options;
1321 2 : environment_options.f_environment_flags = 0;
1322 2 : environment_options.f_help_header = "Usage: test simple --out <filename> ... option";
1323 2 : environment_options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
1324 :
1325 4 : CATCH_WHEN("using long form")
1326 : {
1327 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "--out \"my filename.out\" another.out last.out");
1328 :
1329 1 : char const * cargv[] =
1330 : {
1331 : "/usr/bin/arguments",
1332 : nullptr
1333 : };
1334 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
1335 1 : char ** argv = const_cast<char **>(cargv);
1336 :
1337 2 : advgetopt::getopt opt(environment_options, argc, argv);
1338 :
1339 : // check that the result is valid
1340 :
1341 : // an invalid parameter, MUST NOT EXIST
1342 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
1343 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
1344 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
1345 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1346 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
1347 :
1348 : // the valid parameter
1349 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
1350 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
1351 1 : CATCH_REQUIRE(opt.is_defined("out"));
1352 1 : CATCH_REQUIRE(opt.get_string("out") == "my filename.out");
1353 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my filename.out");
1354 1 : CATCH_REQUIRE(opt.get_string("out", 1) == "another.out");
1355 1 : CATCH_REQUIRE(opt.get_string("out", 2) == "last.out");
1356 1 : CATCH_REQUIRE(opt.get_default("out").empty());
1357 1 : CATCH_REQUIRE(opt.size("out") == 3);
1358 :
1359 : // other parameters
1360 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
1361 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
1362 : }
1363 :
1364 4 : CATCH_WHEN("using short form")
1365 : {
1366 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "-o 'my filename.out' another.out last.out");
1367 :
1368 1 : char const * cargv[] =
1369 : {
1370 : "/usr/bin/arguments",
1371 : nullptr
1372 : };
1373 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
1374 1 : char ** argv = const_cast<char **>(cargv);
1375 :
1376 2 : advgetopt::getopt opt(environment_options, argc, argv);
1377 :
1378 : // check that the result is valid
1379 :
1380 : // an invalid parameter, MUST NOT EXIST
1381 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
1382 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
1383 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
1384 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1385 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
1386 :
1387 : // the valid parameter
1388 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
1389 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
1390 1 : CATCH_REQUIRE(opt.is_defined("out"));
1391 1 : CATCH_REQUIRE(opt.get_string("out") == "my filename.out");
1392 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my filename.out");
1393 1 : CATCH_REQUIRE(opt.get_string("out", 1) == "another.out");
1394 1 : CATCH_REQUIRE(opt.get_string("out", 2) == "last.out");
1395 1 : CATCH_REQUIRE(opt.get_default("out").empty());
1396 1 : CATCH_REQUIRE(opt.size("out") == 3);
1397 :
1398 : // other parameters
1399 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
1400 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
1401 : }
1402 : CATCH_END_SECTION()
1403 6 : }
1404 :
1405 :
1406 17 : CATCH_TEST_CASE("optional_arguments", "[arguments][valid][multiple][getopt]")
1407 : {
1408 30 : CATCH_START_SECTION("Verify a simple --out [<filename> ...] argument")
1409 9 : char const * const separators[] =
1410 : {
1411 : ",",
1412 : nullptr
1413 : };
1414 :
1415 9 : advgetopt::option const options[] =
1416 : {
1417 : advgetopt::define_option(
1418 : advgetopt::Name("out")
1419 : , advgetopt::ShortName('o')
1420 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_MULTIPLE>())
1421 : , advgetopt::Help("output filename.")
1422 : , advgetopt::Separators(separators)
1423 54 : ),
1424 : advgetopt::end_options()
1425 63 : };
1426 :
1427 9 : advgetopt::options_environment environment_options;
1428 9 : environment_options.f_project_name = "unittest";
1429 9 : environment_options.f_options = options;
1430 9 : environment_options.f_environment_flags = 0;
1431 9 : environment_options.f_help_header = "Usage: test simple --out <filename> ... option";
1432 :
1433 18 : CATCH_WHEN("using long form and no arguments")
1434 : {
1435 1 : char const * cargv[] =
1436 : {
1437 : "/usr/bin/arguments",
1438 : "--out",
1439 : nullptr
1440 : };
1441 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
1442 1 : char ** argv = const_cast<char **>(cargv);
1443 :
1444 2 : advgetopt::getopt opt(environment_options, argc, argv);
1445 :
1446 : // check that the result is valid
1447 :
1448 : // an invalid parameter, MUST NOT EXIST
1449 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
1450 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
1451 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
1452 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1453 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
1454 :
1455 : // the valid parameter
1456 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
1457 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
1458 1 : CATCH_REQUIRE(opt.is_defined("out"));
1459 1 : CATCH_REQUIRE(opt.get_string("out").empty());
1460 1 : CATCH_REQUIRE(opt.get_string("out", 0).empty());
1461 1 : CATCH_REQUIRE(opt.get_default("out").empty());
1462 1 : CATCH_REQUIRE(opt.size("out") == 1);
1463 :
1464 : // other parameters
1465 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
1466 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
1467 : }
1468 :
1469 18 : CATCH_WHEN("using long form and one empty argument and an equal sign")
1470 : {
1471 1 : char const * cargv[] =
1472 : {
1473 : "/usr/bin/arguments",
1474 : "--out=",
1475 : nullptr
1476 : };
1477 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
1478 1 : char ** argv = const_cast<char **>(cargv);
1479 :
1480 2 : advgetopt::getopt opt(environment_options, argc, argv);
1481 :
1482 : // check that the result is valid
1483 :
1484 : // an invalid parameter, MUST NOT EXIST
1485 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
1486 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
1487 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
1488 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1489 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
1490 :
1491 : // the valid parameter
1492 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
1493 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
1494 1 : CATCH_REQUIRE(opt.is_defined("out"));
1495 1 : CATCH_REQUIRE(opt.get_string("out").empty());
1496 1 : CATCH_REQUIRE(opt.get_string("out", 0).empty());
1497 1 : CATCH_REQUIRE(opt.get_default("out").empty());
1498 1 : CATCH_REQUIRE(opt.size("out") == 1);
1499 :
1500 : // other parameters
1501 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
1502 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
1503 : }
1504 :
1505 18 : CATCH_WHEN("using long form and one argument")
1506 : {
1507 1 : char const * cargv[] =
1508 : {
1509 : "/usr/bin/arguments",
1510 : "--out",
1511 : "my-filename.out",
1512 : nullptr
1513 : };
1514 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
1515 1 : char ** argv = const_cast<char **>(cargv);
1516 :
1517 2 : advgetopt::getopt opt(environment_options, argc, argv);
1518 :
1519 : // check that the result is valid
1520 :
1521 : // an invalid parameter, MUST NOT EXIST
1522 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
1523 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
1524 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
1525 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1526 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
1527 :
1528 : // the valid parameter
1529 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
1530 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
1531 1 : CATCH_REQUIRE(opt.is_defined("out"));
1532 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
1533 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
1534 1 : CATCH_REQUIRE(opt.get_default("out").empty());
1535 1 : CATCH_REQUIRE(opt.size("out") == 1);
1536 :
1537 : // other parameters
1538 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
1539 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
1540 : }
1541 :
1542 18 : CATCH_WHEN("using long form and one argument and an equal sign")
1543 : {
1544 1 : char const * cargv[] =
1545 : {
1546 : "/usr/bin/arguments",
1547 : "--out=my-filename.out",
1548 : nullptr
1549 : };
1550 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
1551 1 : char ** argv = const_cast<char **>(cargv);
1552 :
1553 2 : advgetopt::getopt opt(environment_options, argc, argv);
1554 :
1555 : // check that the result is valid
1556 :
1557 : // an invalid parameter, MUST NOT EXIST
1558 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
1559 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
1560 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
1561 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1562 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
1563 :
1564 : // the valid parameter
1565 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
1566 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
1567 1 : CATCH_REQUIRE(opt.is_defined("out"));
1568 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
1569 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
1570 1 : CATCH_REQUIRE(opt.get_default("out").empty());
1571 1 : CATCH_REQUIRE(opt.size("out") == 1);
1572 :
1573 : // other parameters
1574 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
1575 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
1576 : }
1577 :
1578 18 : CATCH_WHEN("using long form and three arguments")
1579 : {
1580 1 : char const * cargv[] =
1581 : {
1582 : "/usr/bin/arguments",
1583 : "--out",
1584 : "my-filename.out",
1585 : "another.out",
1586 : "last.out",
1587 : nullptr
1588 : };
1589 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
1590 1 : char ** argv = const_cast<char **>(cargv);
1591 :
1592 2 : advgetopt::getopt opt(environment_options, argc, argv);
1593 :
1594 : // check that the result is valid
1595 :
1596 : // an invalid parameter, MUST NOT EXIST
1597 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
1598 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
1599 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
1600 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1601 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
1602 :
1603 : // the valid parameter
1604 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
1605 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
1606 1 : CATCH_REQUIRE(opt.is_defined("out"));
1607 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
1608 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
1609 1 : CATCH_REQUIRE(opt.get_string("out", 1) == "another.out");
1610 1 : CATCH_REQUIRE(opt.get_string("out", 2) == "last.out");
1611 1 : CATCH_REQUIRE(opt.get_default("out").empty());
1612 1 : CATCH_REQUIRE(opt.size("out") == 3);
1613 :
1614 : // other parameters
1615 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
1616 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
1617 : }
1618 :
1619 18 : CATCH_WHEN("using long form and three arguments and an equal sign")
1620 : {
1621 1 : char const * cargv[] =
1622 : {
1623 : "/usr/bin/arguments",
1624 : "--out=my-filename.out,another.out,last.out",
1625 : nullptr
1626 : };
1627 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
1628 1 : char ** argv = const_cast<char **>(cargv);
1629 :
1630 2 : advgetopt::getopt opt(environment_options, argc, argv);
1631 :
1632 : // check that the result is valid
1633 :
1634 : // an invalid parameter, MUST NOT EXIST
1635 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
1636 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
1637 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
1638 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1639 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
1640 :
1641 : // the valid parameter
1642 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
1643 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
1644 1 : CATCH_REQUIRE(opt.is_defined("out"));
1645 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
1646 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
1647 1 : CATCH_REQUIRE(opt.get_string("out", 1) == "another.out");
1648 1 : CATCH_REQUIRE(opt.get_string("out", 2) == "last.out");
1649 1 : CATCH_REQUIRE(opt.get_default("out").empty());
1650 1 : CATCH_REQUIRE(opt.size("out") == 3);
1651 :
1652 : // other parameters
1653 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
1654 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
1655 : }
1656 :
1657 18 : CATCH_WHEN("using short form and no arguments")
1658 : {
1659 1 : char const * cargv[] =
1660 : {
1661 : "/usr/bin/arguments",
1662 : "-o",
1663 : nullptr
1664 : };
1665 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
1666 1 : char ** argv = const_cast<char **>(cargv);
1667 :
1668 2 : advgetopt::getopt opt(environment_options, argc, argv);
1669 :
1670 : // check that the result is valid
1671 :
1672 : // an invalid parameter, MUST NOT EXIST
1673 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
1674 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
1675 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
1676 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1677 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
1678 :
1679 : // the valid parameter
1680 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
1681 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
1682 1 : CATCH_REQUIRE(opt.is_defined("out"));
1683 1 : CATCH_REQUIRE(opt.get_string("out").empty());
1684 1 : CATCH_REQUIRE(opt.get_string("out", 0).empty());
1685 1 : CATCH_REQUIRE(opt.get_default("out").empty());
1686 1 : CATCH_REQUIRE(opt.size("out") == 1);
1687 :
1688 : // other parameters
1689 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
1690 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
1691 : }
1692 :
1693 18 : CATCH_WHEN("using short form and one argument")
1694 : {
1695 1 : char const * cargv[] =
1696 : {
1697 : "/usr/bin/arguments",
1698 : "-o",
1699 : "my-filename.out",
1700 : nullptr
1701 : };
1702 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
1703 1 : char ** argv = const_cast<char **>(cargv);
1704 :
1705 2 : advgetopt::getopt opt(environment_options, argc, argv);
1706 :
1707 : // check that the result is valid
1708 :
1709 : // an invalid parameter, MUST NOT EXIST
1710 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
1711 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
1712 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
1713 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1714 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
1715 :
1716 : // the valid parameter
1717 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
1718 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
1719 1 : CATCH_REQUIRE(opt.is_defined("out"));
1720 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
1721 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
1722 1 : CATCH_REQUIRE(opt.get_default("out").empty());
1723 1 : CATCH_REQUIRE(opt.size("out") == 1);
1724 :
1725 : // other parameters
1726 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
1727 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
1728 : }
1729 :
1730 18 : CATCH_WHEN("using short form and three arguments")
1731 : {
1732 1 : char const * cargv[] =
1733 : {
1734 : "/usr/bin/arguments",
1735 : "-o",
1736 : "my-filename.out",
1737 : "another.out",
1738 : "last.out",
1739 : nullptr
1740 : };
1741 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
1742 1 : char ** argv = const_cast<char **>(cargv);
1743 :
1744 2 : advgetopt::getopt opt(environment_options, argc, argv);
1745 :
1746 : // check that the result is valid
1747 :
1748 : // an invalid parameter, MUST NOT EXIST
1749 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
1750 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
1751 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
1752 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1753 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
1754 :
1755 : // the valid parameter
1756 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
1757 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
1758 1 : CATCH_REQUIRE(opt.is_defined("out"));
1759 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
1760 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
1761 1 : CATCH_REQUIRE(opt.get_string("out", 1) == "another.out");
1762 1 : CATCH_REQUIRE(opt.get_string("out", 2) == "last.out");
1763 1 : CATCH_REQUIRE(opt.get_default("out").empty());
1764 1 : CATCH_REQUIRE(opt.size("out") == 3);
1765 :
1766 : // other parameters
1767 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
1768 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
1769 : }
1770 : CATCH_END_SECTION()
1771 :
1772 30 : CATCH_START_SECTION("Verify a simple --out [<filename> ...] argument in a variable")
1773 6 : advgetopt::option const options[] =
1774 : {
1775 : advgetopt::define_option(
1776 : advgetopt::Name("out")
1777 : , advgetopt::ShortName('o')
1778 : , advgetopt::Flags(advgetopt::var_flags<advgetopt::GETOPT_FLAG_MULTIPLE>())
1779 : , advgetopt::Help("output filename.")
1780 : ),
1781 : advgetopt::end_options()
1782 : };
1783 :
1784 6 : advgetopt::options_environment environment_options;
1785 6 : environment_options.f_project_name = "unittest";
1786 6 : environment_options.f_options = options;
1787 6 : environment_options.f_environment_flags = 0;
1788 6 : environment_options.f_help_header = "Usage: test simple --out <filename> ... option";
1789 6 : environment_options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
1790 :
1791 12 : CATCH_WHEN("using long form and no arguments")
1792 : {
1793 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "--out");
1794 :
1795 1 : char const * cargv[] =
1796 : {
1797 : "/usr/bin/arguments",
1798 : nullptr
1799 : };
1800 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
1801 1 : char ** argv = const_cast<char **>(cargv);
1802 :
1803 2 : advgetopt::getopt opt(environment_options, argc, argv);
1804 :
1805 : // check that the result is valid
1806 :
1807 : // an invalid parameter, MUST NOT EXIST
1808 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
1809 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
1810 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
1811 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1812 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
1813 :
1814 : // the valid parameter
1815 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
1816 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
1817 1 : CATCH_REQUIRE(opt.is_defined("out"));
1818 1 : CATCH_REQUIRE(opt.get_string("out").empty());
1819 1 : CATCH_REQUIRE(opt.get_string("out", 0).empty());
1820 1 : CATCH_REQUIRE(opt.get_default("out").empty());
1821 1 : CATCH_REQUIRE(opt.size("out") == 1);
1822 :
1823 : // other parameters
1824 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
1825 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
1826 : }
1827 :
1828 12 : CATCH_WHEN("using long form and one argument")
1829 : {
1830 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "--out my-filename.out");
1831 :
1832 1 : char const * cargv[] =
1833 : {
1834 : "/usr/bin/arguments",
1835 : nullptr
1836 : };
1837 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
1838 1 : char ** argv = const_cast<char **>(cargv);
1839 :
1840 2 : advgetopt::getopt opt(environment_options, argc, argv);
1841 :
1842 : // check that the result is valid
1843 :
1844 : // an invalid parameter, MUST NOT EXIST
1845 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
1846 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
1847 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
1848 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1849 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
1850 :
1851 : // the valid parameter
1852 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
1853 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
1854 1 : CATCH_REQUIRE(opt.is_defined("out"));
1855 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
1856 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
1857 1 : CATCH_REQUIRE(opt.get_default("out").empty());
1858 1 : CATCH_REQUIRE(opt.size("out") == 1);
1859 :
1860 : // other parameters
1861 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
1862 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
1863 : }
1864 :
1865 12 : CATCH_WHEN("using long form and three arguments")
1866 : {
1867 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "--out my-filename.out another.out last.out");
1868 :
1869 1 : char const * cargv[] =
1870 : {
1871 : "/usr/bin/arguments",
1872 : nullptr
1873 : };
1874 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
1875 1 : char ** argv = const_cast<char **>(cargv);
1876 :
1877 2 : advgetopt::getopt opt(environment_options, argc, argv);
1878 :
1879 : // check that the result is valid
1880 :
1881 : // an invalid parameter, MUST NOT EXIST
1882 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
1883 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
1884 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
1885 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1886 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
1887 :
1888 : // the valid parameter
1889 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
1890 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
1891 1 : CATCH_REQUIRE(opt.is_defined("out"));
1892 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
1893 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
1894 1 : CATCH_REQUIRE(opt.get_string("out", 1) == "another.out");
1895 1 : CATCH_REQUIRE(opt.get_string("out", 2) == "last.out");
1896 1 : CATCH_REQUIRE(opt.get_default("out").empty());
1897 1 : CATCH_REQUIRE(opt.size("out") == 3);
1898 :
1899 : // other parameters
1900 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
1901 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
1902 : }
1903 :
1904 12 : CATCH_WHEN("using short form and no arguments")
1905 : {
1906 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "-o");
1907 :
1908 1 : char const * cargv[] =
1909 : {
1910 : "/usr/bin/arguments",
1911 : nullptr
1912 : };
1913 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
1914 1 : char ** argv = const_cast<char **>(cargv);
1915 :
1916 2 : advgetopt::getopt opt(environment_options, argc, argv);
1917 :
1918 : // check that the result is valid
1919 :
1920 : // an invalid parameter, MUST NOT EXIST
1921 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
1922 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
1923 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
1924 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1925 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
1926 :
1927 : // the valid parameter
1928 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
1929 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
1930 1 : CATCH_REQUIRE(opt.is_defined("out"));
1931 1 : CATCH_REQUIRE(opt.get_string("out").empty());
1932 1 : CATCH_REQUIRE(opt.get_string("out", 0).empty());
1933 1 : CATCH_REQUIRE(opt.get_default("out").empty());
1934 1 : CATCH_REQUIRE(opt.size("out") == 1);
1935 :
1936 : // other parameters
1937 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
1938 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
1939 : }
1940 :
1941 12 : CATCH_WHEN("using short form and one argument")
1942 : {
1943 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "-o my-filename.out");
1944 :
1945 1 : char const * cargv[] =
1946 : {
1947 : "/usr/bin/arguments",
1948 : nullptr
1949 : };
1950 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
1951 1 : char ** argv = const_cast<char **>(cargv);
1952 :
1953 2 : advgetopt::getopt opt(environment_options, argc, argv);
1954 :
1955 : // check that the result is valid
1956 :
1957 : // an invalid parameter, MUST NOT EXIST
1958 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
1959 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
1960 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
1961 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1962 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
1963 :
1964 : // the valid parameter
1965 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
1966 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
1967 1 : CATCH_REQUIRE(opt.is_defined("out"));
1968 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
1969 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
1970 1 : CATCH_REQUIRE(opt.get_default("out").empty());
1971 1 : CATCH_REQUIRE(opt.size("out") == 1);
1972 :
1973 : // other parameters
1974 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
1975 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
1976 : }
1977 :
1978 12 : CATCH_WHEN("using short form and three arguments")
1979 : {
1980 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "-o my-filename.out another.out last.out");
1981 :
1982 1 : char const * cargv[] =
1983 : {
1984 : "/usr/bin/arguments",
1985 : nullptr
1986 : };
1987 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
1988 1 : char ** argv = const_cast<char **>(cargv);
1989 :
1990 2 : advgetopt::getopt opt(environment_options, argc, argv);
1991 :
1992 : // check that the result is valid
1993 :
1994 : // an invalid parameter, MUST NOT EXIST
1995 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
1996 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
1997 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
1998 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
1999 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
2000 :
2001 : // the valid parameter
2002 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
2003 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
2004 1 : CATCH_REQUIRE(opt.is_defined("out"));
2005 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
2006 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
2007 1 : CATCH_REQUIRE(opt.get_string("out", 1) == "another.out");
2008 1 : CATCH_REQUIRE(opt.get_string("out", 2) == "last.out");
2009 1 : CATCH_REQUIRE(opt.get_default("out").empty());
2010 1 : CATCH_REQUIRE(opt.size("out") == 3);
2011 :
2012 : // other parameters
2013 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
2014 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
2015 : }
2016 : CATCH_END_SECTION()
2017 15 : }
2018 :
2019 :
2020 8 : CATCH_TEST_CASE("config_dir_argument", "[arguments][valid][getopt][config]")
2021 : {
2022 12 : CATCH_START_SECTION("Verify that we do get the --config-dir option when we have a standalone configuration filename")
2023 : {
2024 1 : advgetopt::option const options[] =
2025 : {
2026 : advgetopt::define_option(
2027 : advgetopt::Name("out")
2028 : , advgetopt::ShortName('o')
2029 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
2030 : , advgetopt::Help("output filename.")
2031 : ),
2032 : advgetopt::end_options()
2033 : };
2034 :
2035 1 : advgetopt::options_environment environment_options;
2036 1 : environment_options.f_project_name = "unittest";
2037 1 : environment_options.f_options = options;
2038 1 : environment_options.f_environment_flags = advgetopt::GETOPT_ENVIRONMENT_FLAG_SYSTEM_PARAMETERS;
2039 1 : environment_options.f_configuration_filename = "snapwatchdog.conf";
2040 1 : environment_options.f_help_header = "Usage: test --config-dir";
2041 :
2042 1 : char const * cargv[] =
2043 : {
2044 : "/usr/bin/arguments",
2045 : "--out",
2046 : "my-filename.out",
2047 : "--license",
2048 : "--config-dir",
2049 : "/opt/m2osw/config",
2050 : nullptr
2051 : };
2052 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
2053 1 : char ** argv = const_cast<char **>(cargv);
2054 :
2055 2 : advgetopt::getopt opt(environment_options, argc, argv);
2056 :
2057 : // check that the result is valid
2058 :
2059 : // an invalid parameter, MUST NOT EXIST
2060 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
2061 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
2062 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
2063 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
2064 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
2065 :
2066 : // the valid parameter
2067 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
2068 1 : CATCH_REQUIRE(opt.get_option('o') == opt.get_option("out"));
2069 1 : CATCH_REQUIRE(opt.is_defined("out"));
2070 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
2071 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
2072 1 : CATCH_REQUIRE(opt.get_default("out").empty());
2073 1 : CATCH_REQUIRE(opt.size("out") == 1);
2074 :
2075 : // the license system parameter
2076 1 : CATCH_REQUIRE(opt.get_option("license") != nullptr);
2077 1 : CATCH_REQUIRE(opt.get_option('L') != nullptr);
2078 1 : CATCH_REQUIRE(opt.is_defined("license"));
2079 1 : CATCH_REQUIRE(opt.get_default("license").empty());
2080 1 : CATCH_REQUIRE(opt.size("license") == 1);
2081 :
2082 : // the copyright system parameter
2083 1 : CATCH_REQUIRE(opt.get_option("copyright") != nullptr);
2084 1 : CATCH_REQUIRE(opt.get_option('C') == opt.get_option("copyright"));
2085 1 : CATCH_REQUIRE_FALSE(opt.is_defined("copyright"));
2086 1 : CATCH_REQUIRE(opt.get_default("copyright").empty());
2087 1 : CATCH_REQUIRE(opt.size("copyright") == 0);
2088 :
2089 : // the config-dir system parameter
2090 1 : CATCH_REQUIRE(opt.get_option("config-dir") != nullptr);
2091 1 : CATCH_REQUIRE(opt.is_defined("config-dir"));
2092 1 : CATCH_REQUIRE(opt.get_default("config-dir").empty());
2093 1 : CATCH_REQUIRE(opt.size("config-dir") == 1);
2094 1 : CATCH_REQUIRE(opt.get_string("config-dir") == "/opt/m2osw/config");
2095 :
2096 : // other parameters
2097 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
2098 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
2099 : }
2100 : CATCH_END_SECTION()
2101 :
2102 12 : CATCH_START_SECTION("Verify that we do not get the --config-dir option when the standalone configuration filename is nullptr")
2103 : {
2104 1 : advgetopt::option const options[] =
2105 : {
2106 : advgetopt::define_option(
2107 : advgetopt::Name("out")
2108 : , advgetopt::ShortName('o')
2109 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
2110 : , advgetopt::Help("output filename.")
2111 : ),
2112 : advgetopt::end_options()
2113 : };
2114 :
2115 1 : advgetopt::options_environment environment_options;
2116 1 : environment_options.f_project_name = "unittest";
2117 1 : environment_options.f_options = options;
2118 1 : environment_options.f_environment_flags = advgetopt::GETOPT_ENVIRONMENT_FLAG_SYSTEM_PARAMETERS;
2119 1 : environment_options.f_configuration_filename = nullptr;
2120 1 : environment_options.f_help_header = "Usage: test --config-dir";
2121 :
2122 1 : char const * cargv[] =
2123 : {
2124 : "/usr/bin/arguments",
2125 : "--out",
2126 : "my-filename.out",
2127 : "--license",
2128 : nullptr
2129 : };
2130 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
2131 1 : char ** argv = const_cast<char **>(cargv);
2132 :
2133 2 : advgetopt::getopt opt(environment_options, argc, argv);
2134 :
2135 : // check that the result is valid
2136 :
2137 : // an invalid parameter, MUST NOT EXIST
2138 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
2139 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
2140 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
2141 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
2142 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
2143 :
2144 : // the valid parameter
2145 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
2146 1 : CATCH_REQUIRE(opt.get_option('o') == opt.get_option("out"));
2147 1 : CATCH_REQUIRE(opt.is_defined("out"));
2148 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
2149 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
2150 1 : CATCH_REQUIRE(opt.get_default("out").empty());
2151 1 : CATCH_REQUIRE(opt.size("out") == 1);
2152 :
2153 : // the license system parameter
2154 1 : CATCH_REQUIRE(opt.get_option("license") != nullptr);
2155 1 : CATCH_REQUIRE(opt.get_option('L') != nullptr);
2156 1 : CATCH_REQUIRE(opt.is_defined("license"));
2157 1 : CATCH_REQUIRE(opt.get_default("license").empty());
2158 1 : CATCH_REQUIRE(opt.size("license") == 1);
2159 :
2160 : // the copyright system parameter
2161 1 : CATCH_REQUIRE(opt.get_option("copyright") != nullptr);
2162 1 : CATCH_REQUIRE(opt.get_option('C') == opt.get_option("copyright"));
2163 1 : CATCH_REQUIRE_FALSE(opt.is_defined("copyright"));
2164 1 : CATCH_REQUIRE(opt.get_default("copyright").empty());
2165 1 : CATCH_REQUIRE(opt.size("copyright") == 0);
2166 :
2167 : // no config-dir system parameter when the configuration filename is missing
2168 1 : CATCH_REQUIRE(opt.get_option("config-dir") == nullptr);
2169 1 : CATCH_REQUIRE_FALSE(opt.is_defined("config-dir"));
2170 1 : CATCH_REQUIRE(opt.get_default("config-dir").empty());
2171 1 : CATCH_REQUIRE(opt.size("config-dir") == 0);
2172 :
2173 : // other parameters
2174 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
2175 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
2176 : }
2177 : CATCH_END_SECTION()
2178 :
2179 12 : CATCH_START_SECTION("Verify that we do not get the --config-dir option when the standalone configuration filename is \"\"")
2180 : {
2181 1 : advgetopt::option const options[] =
2182 : {
2183 : advgetopt::define_option(
2184 : advgetopt::Name("out")
2185 : , advgetopt::ShortName('o')
2186 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
2187 : , advgetopt::Help("output filename.")
2188 : ),
2189 : advgetopt::end_options()
2190 : };
2191 :
2192 1 : advgetopt::options_environment environment_options;
2193 1 : environment_options.f_project_name = "unittest";
2194 1 : environment_options.f_options = options;
2195 1 : environment_options.f_environment_flags = advgetopt::GETOPT_ENVIRONMENT_FLAG_SYSTEM_PARAMETERS;
2196 1 : environment_options.f_configuration_filename = "";
2197 1 : environment_options.f_help_header = "Usage: test --config-dir";
2198 :
2199 1 : char const * cargv[] =
2200 : {
2201 : "/usr/bin/arguments",
2202 : "--out",
2203 : "my-filename.out",
2204 : "--license",
2205 : nullptr
2206 : };
2207 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
2208 1 : char ** argv = const_cast<char **>(cargv);
2209 :
2210 2 : advgetopt::getopt opt(environment_options, argc, argv);
2211 :
2212 : // check that the result is valid
2213 :
2214 : // an invalid parameter, MUST NOT EXIST
2215 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
2216 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
2217 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
2218 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
2219 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
2220 :
2221 : // the valid parameter
2222 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
2223 1 : CATCH_REQUIRE(opt.get_option('o') == opt.get_option("out"));
2224 1 : CATCH_REQUIRE(opt.is_defined("out"));
2225 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
2226 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
2227 1 : CATCH_REQUIRE(opt.get_default("out").empty());
2228 1 : CATCH_REQUIRE(opt.size("out") == 1);
2229 :
2230 : // the license system parameter
2231 1 : CATCH_REQUIRE(opt.get_option("license") != nullptr);
2232 1 : CATCH_REQUIRE(opt.get_option('L') != nullptr);
2233 1 : CATCH_REQUIRE(opt.is_defined("license"));
2234 1 : CATCH_REQUIRE(opt.get_default("license").empty());
2235 1 : CATCH_REQUIRE(opt.size("license") == 1);
2236 :
2237 : // the copyright system parameter
2238 1 : CATCH_REQUIRE(opt.get_option("copyright") != nullptr);
2239 1 : CATCH_REQUIRE(opt.get_option('C') == opt.get_option("copyright"));
2240 1 : CATCH_REQUIRE_FALSE(opt.is_defined("copyright"));
2241 1 : CATCH_REQUIRE(opt.get_default("copyright").empty());
2242 1 : CATCH_REQUIRE(opt.size("copyright") == 0);
2243 :
2244 : // no config-dir system parameter when the configuration filename is missing
2245 1 : CATCH_REQUIRE(opt.get_option("config-dir") == nullptr);
2246 1 : CATCH_REQUIRE_FALSE(opt.is_defined("config-dir"));
2247 1 : CATCH_REQUIRE(opt.get_default("config-dir").empty());
2248 1 : CATCH_REQUIRE(opt.size("config-dir") == 0);
2249 :
2250 : // other parameters
2251 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
2252 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
2253 : }
2254 : CATCH_END_SECTION()
2255 :
2256 12 : CATCH_START_SECTION("Test adding '-c' to '--config-dir'")
2257 : {
2258 1 : advgetopt::option const options[] =
2259 : {
2260 : advgetopt::define_option(
2261 : advgetopt::Name("out")
2262 : , advgetopt::ShortName('o')
2263 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
2264 : , advgetopt::Help("output filename.")
2265 : ),
2266 : advgetopt::end_options()
2267 : };
2268 :
2269 1 : advgetopt::options_environment environment_options;
2270 1 : environment_options.f_project_name = "unittest";
2271 1 : environment_options.f_options = options;
2272 1 : environment_options.f_environment_flags = advgetopt::GETOPT_ENVIRONMENT_FLAG_SYSTEM_PARAMETERS;
2273 1 : environment_options.f_configuration_filename = "snapwatchdog.conf";
2274 1 : environment_options.f_help_header = "Usage: test --config-dir";
2275 :
2276 1 : char const * cargv[] =
2277 : {
2278 : "/usr/bin/arguments",
2279 : "--out",
2280 : "my-filename.out",
2281 : "--license",
2282 : "-c",
2283 : "/opt/m2osw/config",
2284 : nullptr
2285 : };
2286 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
2287 1 : char ** argv = const_cast<char **>(cargv);
2288 :
2289 2 : advgetopt::getopt opt(environment_options);
2290 1 : opt.parse_program_name(argv);
2291 1 : opt.link_aliases();
2292 :
2293 2 : advgetopt::option_info::pointer_t config_dir(opt.get_option("config-dir"));
2294 1 : CATCH_REQUIRE(config_dir != nullptr);
2295 1 : opt.set_short_name("config-dir", U'c');
2296 :
2297 1 : opt.parse_arguments(argc, argv, advgetopt::option_source_t::SOURCE_COMMAND_LINE);
2298 :
2299 : // check that the result is valid
2300 :
2301 : // an invalid parameter, MUST NOT EXIST
2302 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
2303 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
2304 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
2305 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
2306 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
2307 :
2308 : // the valid parameter
2309 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
2310 1 : CATCH_REQUIRE(opt.get_option('o') == opt.get_option("out"));
2311 1 : CATCH_REQUIRE(opt.is_defined("out"));
2312 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
2313 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
2314 1 : CATCH_REQUIRE(opt.get_default("out").empty());
2315 1 : CATCH_REQUIRE(opt.size("out") == 1);
2316 :
2317 : // the license system parameter
2318 1 : CATCH_REQUIRE(opt.get_option("license") != nullptr);
2319 1 : CATCH_REQUIRE(opt.get_option('L') != nullptr);
2320 1 : CATCH_REQUIRE(opt.is_defined("license"));
2321 1 : CATCH_REQUIRE(opt.get_default("license").empty());
2322 1 : CATCH_REQUIRE(opt.size("license") == 1);
2323 :
2324 : // the copyright system parameter
2325 1 : CATCH_REQUIRE(opt.get_option("copyright") != nullptr);
2326 1 : CATCH_REQUIRE(opt.get_option('C') == opt.get_option("copyright"));
2327 1 : CATCH_REQUIRE_FALSE(opt.is_defined("copyright"));
2328 1 : CATCH_REQUIRE(opt.get_default("copyright").empty());
2329 1 : CATCH_REQUIRE(opt.size("copyright") == 0);
2330 :
2331 : // the config-dir system parameter
2332 1 : CATCH_REQUIRE(opt.get_option("config-dir") != nullptr);
2333 1 : CATCH_REQUIRE(opt.is_defined("config-dir"));
2334 1 : CATCH_REQUIRE(opt.get_default("config-dir").empty());
2335 1 : CATCH_REQUIRE(opt.size("config-dir") == 1);
2336 1 : CATCH_REQUIRE(opt.get_string("config-dir") == "/opt/m2osw/config");
2337 :
2338 : // other parameters
2339 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
2340 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
2341 : }
2342 : CATCH_END_SECTION()
2343 :
2344 12 : CATCH_START_SECTION("Test our own parsing with '--config-dir' and f_configuration_filename set to nullptr")
2345 : {
2346 1 : advgetopt::option const options[] =
2347 : {
2348 : advgetopt::define_option(
2349 : advgetopt::Name("out")
2350 : , advgetopt::ShortName('o')
2351 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
2352 : , advgetopt::Help("output filename.")
2353 : ),
2354 : advgetopt::end_options()
2355 : };
2356 :
2357 1 : advgetopt::options_environment environment_options;
2358 1 : environment_options.f_project_name = "unittest";
2359 1 : environment_options.f_options = options;
2360 1 : environment_options.f_environment_flags = advgetopt::GETOPT_ENVIRONMENT_FLAG_SYSTEM_PARAMETERS;
2361 1 : environment_options.f_configuration_filename = nullptr;
2362 1 : environment_options.f_help_header = "Usage: test --config-dir";
2363 :
2364 1 : char const * cargv[] =
2365 : {
2366 : "/usr/bin/arguments",
2367 : "--out",
2368 : "my-filename.out",
2369 : "--license",
2370 : nullptr
2371 : };
2372 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
2373 1 : char ** argv = const_cast<char **>(cargv);
2374 :
2375 2 : advgetopt::getopt opt(environment_options);
2376 1 : opt.parse_program_name(argv);
2377 1 : opt.link_aliases();
2378 :
2379 1 : CATCH_REQUIRE(opt.get_option("config-dir") == nullptr);
2380 :
2381 1 : opt.parse_arguments(argc, argv, advgetopt::option_source_t::SOURCE_COMMAND_LINE);
2382 :
2383 : // check that the result is valid
2384 :
2385 : // an invalid parameter, MUST NOT EXIST
2386 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
2387 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
2388 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
2389 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
2390 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
2391 :
2392 : // the valid parameter
2393 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
2394 1 : CATCH_REQUIRE(opt.get_option('o') == opt.get_option("out"));
2395 1 : CATCH_REQUIRE(opt.is_defined("out"));
2396 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
2397 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
2398 1 : CATCH_REQUIRE(opt.get_default("out").empty());
2399 1 : CATCH_REQUIRE(opt.size("out") == 1);
2400 :
2401 : // the license system parameter
2402 1 : CATCH_REQUIRE(opt.get_option("license") != nullptr);
2403 1 : CATCH_REQUIRE(opt.get_option('L') != nullptr);
2404 1 : CATCH_REQUIRE(opt.is_defined("license"));
2405 1 : CATCH_REQUIRE(opt.get_default("license").empty());
2406 1 : CATCH_REQUIRE(opt.size("license") == 1);
2407 :
2408 : // the copyright system parameter
2409 1 : CATCH_REQUIRE(opt.get_option("copyright") != nullptr);
2410 1 : CATCH_REQUIRE(opt.get_option('C') == opt.get_option("copyright"));
2411 1 : CATCH_REQUIRE_FALSE(opt.is_defined("copyright"));
2412 1 : CATCH_REQUIRE(opt.get_default("copyright").empty());
2413 1 : CATCH_REQUIRE(opt.size("copyright") == 0);
2414 :
2415 : // the config-dir system parameter
2416 1 : CATCH_REQUIRE(opt.get_option("config-dir") == nullptr);
2417 1 : CATCH_REQUIRE_FALSE(opt.is_defined("config-dir"));
2418 1 : CATCH_REQUIRE(opt.get_default("config-dir").empty());
2419 1 : CATCH_REQUIRE(opt.size("config-dir") == 0);
2420 :
2421 : // other parameters
2422 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
2423 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
2424 : }
2425 : CATCH_END_SECTION()
2426 :
2427 12 : CATCH_START_SECTION("Test our own parsing with '--config-dir' and f_configuration_filename set to \"\"")
2428 : {
2429 1 : advgetopt::option const options[] =
2430 : {
2431 : advgetopt::define_option(
2432 : advgetopt::Name("out")
2433 : , advgetopt::ShortName('o')
2434 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
2435 : , advgetopt::Help("output filename.")
2436 : ),
2437 : advgetopt::end_options()
2438 : };
2439 :
2440 1 : advgetopt::options_environment environment_options;
2441 1 : environment_options.f_project_name = "unittest";
2442 1 : environment_options.f_options = options;
2443 1 : environment_options.f_environment_flags = advgetopt::GETOPT_ENVIRONMENT_FLAG_SYSTEM_PARAMETERS;
2444 1 : environment_options.f_configuration_filename = "";
2445 1 : environment_options.f_help_header = "Usage: test --config-dir";
2446 :
2447 1 : char const * cargv[] =
2448 : {
2449 : "/usr/bin/arguments",
2450 : "--out",
2451 : "my-filename.out",
2452 : "--license",
2453 : nullptr
2454 : };
2455 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
2456 1 : char ** argv = const_cast<char **>(cargv);
2457 :
2458 2 : advgetopt::getopt opt(environment_options);
2459 1 : opt.parse_program_name(argv);
2460 1 : opt.link_aliases();
2461 :
2462 1 : CATCH_REQUIRE(opt.get_option("config-dir") == nullptr);
2463 :
2464 1 : opt.parse_arguments(argc, argv, advgetopt::option_source_t::SOURCE_COMMAND_LINE);
2465 :
2466 : // check that the result is valid
2467 :
2468 : // an invalid parameter, MUST NOT EXIST
2469 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
2470 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
2471 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
2472 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
2473 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
2474 :
2475 : // the valid parameter
2476 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
2477 1 : CATCH_REQUIRE(opt.get_option('o') == opt.get_option("out"));
2478 1 : CATCH_REQUIRE(opt.is_defined("out"));
2479 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
2480 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
2481 1 : CATCH_REQUIRE(opt.get_default("out").empty());
2482 1 : CATCH_REQUIRE(opt.size("out") == 1);
2483 :
2484 : // the license system parameter
2485 1 : CATCH_REQUIRE(opt.get_option("license") != nullptr);
2486 1 : CATCH_REQUIRE(opt.get_option('L') != nullptr);
2487 1 : CATCH_REQUIRE(opt.is_defined("license"));
2488 1 : CATCH_REQUIRE(opt.get_default("license").empty());
2489 1 : CATCH_REQUIRE(opt.size("license") == 1);
2490 :
2491 : // the copyright system parameter
2492 1 : CATCH_REQUIRE(opt.get_option("copyright") != nullptr);
2493 1 : CATCH_REQUIRE(opt.get_option('C') == opt.get_option("copyright"));
2494 1 : CATCH_REQUIRE_FALSE(opt.is_defined("copyright"));
2495 1 : CATCH_REQUIRE(opt.get_default("copyright").empty());
2496 1 : CATCH_REQUIRE(opt.size("copyright") == 0);
2497 :
2498 : // the config-dir system parameter
2499 1 : CATCH_REQUIRE(opt.get_option("config-dir") == nullptr);
2500 1 : CATCH_REQUIRE_FALSE(opt.is_defined("config-dir"));
2501 1 : CATCH_REQUIRE(opt.get_default("config-dir").empty());
2502 1 : CATCH_REQUIRE(opt.size("config-dir") == 0);
2503 :
2504 : // other parameters
2505 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
2506 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
2507 : }
2508 : CATCH_END_SECTION()
2509 6 : }
2510 :
2511 :
2512 18 : CATCH_TEST_CASE("default_argument", "[arguments][valid][getopt]")
2513 : {
2514 32 : CATCH_START_SECTION("Verify a simple [<filename>] argument")
2515 6 : advgetopt::option const options[] =
2516 : {
2517 : advgetopt::define_option(
2518 : advgetopt::Name("out")
2519 : , advgetopt::ShortName('o')
2520 : , advgetopt::Flags(advgetopt::any_flags<advgetopt::GETOPT_FLAG_COMMAND_LINE
2521 : , advgetopt::GETOPT_FLAG_DEFAULT_OPTION>())
2522 : , advgetopt::Help("output filename.")
2523 : ),
2524 : advgetopt::end_options()
2525 : };
2526 :
2527 6 : advgetopt::options_environment environment_options;
2528 6 : environment_options.f_project_name = "unittest";
2529 6 : environment_options.f_options = options;
2530 6 : environment_options.f_environment_flags = 0;
2531 6 : environment_options.f_help_header = "Usage: test simple [<filename>] option";
2532 :
2533 12 : CATCH_WHEN("no arguments")
2534 : {
2535 1 : char const * cargv[] =
2536 : {
2537 : "/usr/bin/arguments",
2538 : nullptr
2539 : };
2540 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
2541 1 : char ** argv = const_cast<char **>(cargv);
2542 :
2543 2 : advgetopt::getopt opt(environment_options, argc, argv);
2544 :
2545 : // check that the result is valid
2546 :
2547 : // an invalid parameter, MUST NOT EXIST
2548 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
2549 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
2550 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
2551 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
2552 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
2553 :
2554 : // the valid parameter
2555 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
2556 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
2557 1 : CATCH_REQUIRE_FALSE(opt.is_defined("out"));
2558 1 : CATCH_REQUIRE(opt.get_default("out").empty());
2559 1 : CATCH_REQUIRE(opt.size("out") == 0);
2560 :
2561 : // the valid parameter is the default
2562 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
2563 1 : CATCH_REQUIRE(opt.get_option("--") == opt.get_option("out"));
2564 1 : CATCH_REQUIRE_FALSE(opt.is_defined("--"));
2565 1 : CATCH_REQUIRE(opt.get_default("--").empty());
2566 1 : CATCH_REQUIRE(opt.size("--") == 0);
2567 :
2568 : // other parameters
2569 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
2570 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
2571 : }
2572 :
2573 12 : CATCH_WHEN("one argument")
2574 : {
2575 1 : char const * cargv[] =
2576 : {
2577 : "/usr/bin/arguments",
2578 : "my-filename.out",
2579 : nullptr
2580 : };
2581 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
2582 1 : char ** argv = const_cast<char **>(cargv);
2583 :
2584 2 : advgetopt::getopt opt(environment_options, argc, argv);
2585 :
2586 : // check that the result is valid
2587 :
2588 : // an invalid parameter, MUST NOT EXIST
2589 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
2590 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
2591 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
2592 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
2593 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
2594 :
2595 : // the valid parameter
2596 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
2597 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
2598 1 : CATCH_REQUIRE(opt.is_defined("out"));
2599 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
2600 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
2601 1 : CATCH_REQUIRE(opt.get_default("out").empty());
2602 1 : CATCH_REQUIRE(opt.size("out") == 1);
2603 :
2604 : // the valid parameter is the default
2605 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
2606 1 : CATCH_REQUIRE(opt.get_option("--") == opt.get_option("out"));
2607 1 : CATCH_REQUIRE(opt.is_defined("--"));
2608 1 : CATCH_REQUIRE(opt.get_string("--") == "my-filename.out");
2609 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "my-filename.out");
2610 1 : CATCH_REQUIRE(opt.get_default("--").empty());
2611 1 : CATCH_REQUIRE(opt.size("--") == 1);
2612 :
2613 : // other parameters
2614 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
2615 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
2616 : }
2617 :
2618 12 : CATCH_WHEN("three arguments")
2619 : {
2620 1 : char const * cargv[] =
2621 : {
2622 : "/usr/bin/arguments",
2623 : "my-filename.out",
2624 : "another.out",
2625 : "last.out",
2626 : nullptr
2627 : };
2628 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
2629 1 : char ** argv = const_cast<char **>(cargv);
2630 :
2631 2 : advgetopt::getopt opt(environment_options, argc, argv);
2632 :
2633 : // check that the result is valid
2634 :
2635 : // an invalid parameter, MUST NOT EXIST
2636 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
2637 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
2638 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
2639 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
2640 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
2641 :
2642 : // the valid parameter
2643 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
2644 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
2645 1 : CATCH_REQUIRE(opt.is_defined("out"));
2646 1 : CATCH_REQUIRE(opt.get_string("out") == "last.out");
2647 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "last.out");
2648 1 : CATCH_REQUIRE(opt.get_default("out").empty());
2649 1 : CATCH_REQUIRE(opt.size("out") == 1);
2650 :
2651 : // the valid parameter is the default
2652 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
2653 1 : CATCH_REQUIRE(opt.get_option("--") == opt.get_option("out"));
2654 1 : CATCH_REQUIRE(opt.is_defined("--"));
2655 1 : CATCH_REQUIRE(opt.get_string("--") == "last.out");
2656 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "last.out");
2657 1 : CATCH_REQUIRE(opt.get_default("--").empty());
2658 1 : CATCH_REQUIRE(opt.size("--") == 1);
2659 :
2660 : // other parameters
2661 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
2662 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
2663 : }
2664 :
2665 12 : CATCH_WHEN("using the '--' separator and no arguments")
2666 : {
2667 1 : char const * cargv[] =
2668 : {
2669 : "/usr/bin/arguments",
2670 : "--",
2671 : nullptr
2672 : };
2673 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
2674 1 : char ** argv = const_cast<char **>(cargv);
2675 :
2676 2 : advgetopt::getopt opt(environment_options, argc, argv);
2677 :
2678 : // check that the result is valid
2679 :
2680 : // an invalid parameter, MUST NOT EXIST
2681 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
2682 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
2683 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
2684 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
2685 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
2686 :
2687 : // the valid parameter
2688 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
2689 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
2690 1 : CATCH_REQUIRE_FALSE(opt.is_defined("out"));
2691 1 : CATCH_REQUIRE(opt.get_default("out").empty());
2692 1 : CATCH_REQUIRE(opt.size("out") == 0);
2693 :
2694 : // the valid parameter is the default
2695 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
2696 1 : CATCH_REQUIRE(opt.get_option("--") == opt.get_option("out"));
2697 1 : CATCH_REQUIRE_FALSE(opt.is_defined("--"));
2698 1 : CATCH_REQUIRE(opt.get_default("--").empty());
2699 1 : CATCH_REQUIRE(opt.size("--") == 0);
2700 :
2701 : // other parameters
2702 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
2703 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
2704 : }
2705 :
2706 12 : CATCH_WHEN("using the '--' separator and one argument")
2707 : {
2708 1 : char const * cargv[] =
2709 : {
2710 : "/usr/bin/arguments",
2711 : "--",
2712 : "--my-filename.out",
2713 : nullptr
2714 : };
2715 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
2716 1 : char ** argv = const_cast<char **>(cargv);
2717 :
2718 2 : advgetopt::getopt opt(environment_options, argc, argv);
2719 :
2720 : // check that the result is valid
2721 :
2722 : // an invalid parameter, MUST NOT EXIST
2723 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
2724 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
2725 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
2726 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
2727 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
2728 :
2729 : // the valid parameter
2730 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
2731 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
2732 1 : CATCH_REQUIRE(opt.is_defined("out"));
2733 1 : CATCH_REQUIRE(opt.get_string("out") == "--my-filename.out");
2734 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "--my-filename.out");
2735 1 : CATCH_REQUIRE(opt.get_default("out").empty());
2736 1 : CATCH_REQUIRE(opt.size("out") == 1);
2737 :
2738 : // the valid parameter is the default
2739 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
2740 1 : CATCH_REQUIRE(opt.get_option("--") == opt.get_option("out"));
2741 1 : CATCH_REQUIRE(opt.is_defined("--"));
2742 1 : CATCH_REQUIRE(opt.get_string("--") == "--my-filename.out");
2743 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "--my-filename.out");
2744 1 : CATCH_REQUIRE(opt.get_default("--").empty());
2745 1 : CATCH_REQUIRE(opt.size("--") == 1);
2746 :
2747 : // other parameters
2748 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
2749 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
2750 : }
2751 :
2752 12 : CATCH_WHEN("using the '--' separator and three arguments")
2753 : {
2754 1 : char const * cargv[] =
2755 : {
2756 : "/usr/bin/arguments",
2757 : "--",
2758 : "my-filename.out",
2759 : "-another.out",
2760 : "--last.out",
2761 : nullptr
2762 : };
2763 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
2764 1 : char ** argv = const_cast<char **>(cargv);
2765 :
2766 2 : advgetopt::getopt opt(environment_options, argc, argv);
2767 :
2768 : // check that the result is valid
2769 :
2770 : // an invalid parameter, MUST NOT EXIST
2771 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
2772 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
2773 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
2774 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
2775 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
2776 :
2777 : // the valid parameter
2778 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
2779 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
2780 1 : CATCH_REQUIRE(opt.is_defined("out"));
2781 1 : CATCH_REQUIRE(opt.get_string("out") == "--last.out");
2782 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "--last.out");
2783 1 : CATCH_REQUIRE(opt.get_default("out").empty());
2784 1 : CATCH_REQUIRE(opt.size("out") == 1);
2785 :
2786 : // the valid parameter is the default
2787 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
2788 1 : CATCH_REQUIRE(opt.get_option("--") == opt.get_option("out"));
2789 1 : CATCH_REQUIRE(opt.is_defined("--"));
2790 1 : CATCH_REQUIRE(opt.get_string("--") == "--last.out");
2791 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "--last.out");
2792 1 : CATCH_REQUIRE(opt.get_default("--").empty());
2793 1 : CATCH_REQUIRE(opt.size("--") == 1);
2794 :
2795 : // other parameters
2796 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
2797 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
2798 : }
2799 : CATCH_END_SECTION()
2800 :
2801 32 : CATCH_START_SECTION("Verify a simple [<filename>] argument in a variable")
2802 8 : advgetopt::option const options[] =
2803 : {
2804 : advgetopt::define_option(
2805 : advgetopt::Name("out")
2806 : , advgetopt::ShortName('o')
2807 : , advgetopt::Flags(advgetopt::any_flags<advgetopt::GETOPT_FLAG_ENVIRONMENT_VARIABLE
2808 : , advgetopt::GETOPT_FLAG_DEFAULT_OPTION>())
2809 : , advgetopt::Help("output filename.")
2810 : ),
2811 : advgetopt::end_options()
2812 : };
2813 :
2814 8 : advgetopt::options_environment environment_options;
2815 8 : environment_options.f_project_name = "unittest";
2816 8 : environment_options.f_options = options;
2817 8 : environment_options.f_environment_flags = 0;
2818 8 : environment_options.f_help_header = "Usage: test simple --out <filename> ... option";
2819 8 : environment_options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
2820 :
2821 16 : CATCH_WHEN("no arguments")
2822 : {
2823 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "");
2824 :
2825 1 : char const * cargv[] =
2826 : {
2827 : "/usr/bin/arguments",
2828 : nullptr
2829 : };
2830 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
2831 1 : char ** argv = const_cast<char **>(cargv);
2832 :
2833 2 : advgetopt::getopt opt(environment_options, argc, argv);
2834 :
2835 : // check that the result is valid
2836 :
2837 : // an invalid parameter, MUST NOT EXIST
2838 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
2839 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
2840 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
2841 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
2842 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
2843 :
2844 : // the valid parameter
2845 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
2846 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
2847 1 : CATCH_REQUIRE_FALSE(opt.is_defined("out"));
2848 1 : CATCH_REQUIRE(opt.get_default("out").empty());
2849 1 : CATCH_REQUIRE(opt.size("out") == 0);
2850 :
2851 : // the valid parameter is the default
2852 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
2853 1 : CATCH_REQUIRE(opt.get_option("--") == opt.get_option("out"));
2854 1 : CATCH_REQUIRE_FALSE(opt.is_defined("--"));
2855 1 : CATCH_REQUIRE(opt.get_default("--").empty());
2856 1 : CATCH_REQUIRE(opt.size("--") == 0);
2857 :
2858 : // other parameters
2859 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
2860 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
2861 : }
2862 :
2863 16 : CATCH_WHEN("one argument")
2864 : {
2865 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "my-filename.out");
2866 :
2867 1 : char const * cargv[] =
2868 : {
2869 : "/usr/bin/arguments",
2870 : nullptr
2871 : };
2872 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
2873 1 : char ** argv = const_cast<char **>(cargv);
2874 :
2875 2 : advgetopt::getopt opt(environment_options, argc, argv);
2876 :
2877 : // check that the result is valid
2878 :
2879 : // an invalid parameter, MUST NOT EXIST
2880 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
2881 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
2882 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
2883 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
2884 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
2885 :
2886 : // the valid parameter
2887 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
2888 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
2889 1 : CATCH_REQUIRE(opt.is_defined("out"));
2890 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
2891 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
2892 1 : CATCH_REQUIRE(opt.get_default("out").empty());
2893 1 : CATCH_REQUIRE(opt.size("out") == 1);
2894 :
2895 : // the valid parameter is the default
2896 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
2897 1 : CATCH_REQUIRE(opt.get_option("--") == opt.get_option("out"));
2898 1 : CATCH_REQUIRE(opt.is_defined("--"));
2899 1 : CATCH_REQUIRE(opt.get_string("--") == "my-filename.out");
2900 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "my-filename.out");
2901 1 : CATCH_REQUIRE(opt.get_default("--").empty());
2902 1 : CATCH_REQUIRE(opt.size("--") == 1);
2903 :
2904 : // other parameters
2905 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
2906 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
2907 : }
2908 :
2909 16 : CATCH_WHEN("three arguments")
2910 : {
2911 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "my-filename.out another.out last.out");
2912 :
2913 1 : char const * cargv[] =
2914 : {
2915 : "/usr/bin/arguments",
2916 : nullptr
2917 : };
2918 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
2919 1 : char ** argv = const_cast<char **>(cargv);
2920 :
2921 2 : advgetopt::getopt opt(environment_options, argc, argv);
2922 :
2923 : // check that the result is valid
2924 :
2925 : // an invalid parameter, MUST NOT EXIST
2926 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
2927 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
2928 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
2929 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
2930 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
2931 :
2932 : // the valid parameter
2933 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
2934 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
2935 1 : CATCH_REQUIRE(opt.is_defined("out"));
2936 1 : CATCH_REQUIRE(opt.get_string("out") == "last.out");
2937 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "last.out");
2938 1 : CATCH_REQUIRE(opt.get_default("out").empty());
2939 1 : CATCH_REQUIRE(opt.size("out") == 1);
2940 :
2941 : // the valid parameter is the default
2942 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
2943 1 : CATCH_REQUIRE(opt.get_option("--") == opt.get_option("out"));
2944 1 : CATCH_REQUIRE(opt.is_defined("--"));
2945 1 : CATCH_REQUIRE(opt.get_string("--") == "last.out");
2946 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "last.out");
2947 1 : CATCH_REQUIRE(opt.get_default("--").empty());
2948 1 : CATCH_REQUIRE(opt.size("--") == 1);
2949 :
2950 : // other parameters
2951 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
2952 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
2953 : }
2954 :
2955 16 : CATCH_WHEN("four arguments with a '-'")
2956 : {
2957 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "my-filename.out another.out - last.out");
2958 :
2959 1 : char const * cargv[] =
2960 : {
2961 : "/usr/bin/arguments",
2962 : nullptr
2963 : };
2964 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
2965 1 : char ** argv = const_cast<char **>(cargv);
2966 :
2967 2 : advgetopt::getopt opt(environment_options, argc, argv);
2968 :
2969 : // check that the result is valid
2970 :
2971 : // an invalid parameter, MUST NOT EXIST
2972 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
2973 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
2974 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
2975 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
2976 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
2977 :
2978 : // the valid parameter
2979 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
2980 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
2981 1 : CATCH_REQUIRE(opt.is_defined("out"));
2982 1 : CATCH_REQUIRE(opt.get_string("out") == "last.out");
2983 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "last.out");
2984 1 : CATCH_REQUIRE(opt.get_default("out").empty());
2985 1 : CATCH_REQUIRE(opt.size("out") == 1);
2986 :
2987 : // the valid parameter is the default
2988 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
2989 1 : CATCH_REQUIRE(opt.get_option("--") == opt.get_option("out"));
2990 1 : CATCH_REQUIRE(opt.is_defined("--"));
2991 1 : CATCH_REQUIRE(opt.get_string("--") == "last.out");
2992 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "last.out");
2993 1 : CATCH_REQUIRE(opt.get_default("--").empty());
2994 1 : CATCH_REQUIRE(opt.size("--") == 1);
2995 :
2996 : // other parameters
2997 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
2998 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
2999 : }
3000 :
3001 16 : CATCH_WHEN("using the '--' separator and no arguments")
3002 : {
3003 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "--");
3004 :
3005 1 : char const * cargv[] =
3006 : {
3007 : "/usr/bin/arguments",
3008 : nullptr
3009 : };
3010 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
3011 1 : char ** argv = const_cast<char **>(cargv);
3012 :
3013 2 : advgetopt::getopt opt(environment_options, argc, argv);
3014 :
3015 : // check that the result is valid
3016 :
3017 : // an invalid parameter, MUST NOT EXIST
3018 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
3019 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
3020 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
3021 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
3022 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
3023 :
3024 : // the valid parameter
3025 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
3026 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
3027 1 : CATCH_REQUIRE_FALSE(opt.is_defined("out"));
3028 1 : CATCH_REQUIRE(opt.get_default("out").empty());
3029 1 : CATCH_REQUIRE(opt.size("out") == 0);
3030 :
3031 : // the valid parameter is the default
3032 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
3033 1 : CATCH_REQUIRE(opt.get_option("--") == opt.get_option("out"));
3034 1 : CATCH_REQUIRE_FALSE(opt.is_defined("--"));
3035 1 : CATCH_REQUIRE(opt.get_default("--").empty());
3036 1 : CATCH_REQUIRE(opt.size("--") == 0);
3037 :
3038 : // other parameters
3039 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
3040 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
3041 : }
3042 :
3043 16 : CATCH_WHEN("using the '--' separator and one argument")
3044 : {
3045 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "-- my-filename.out");
3046 :
3047 1 : char const * cargv[] =
3048 : {
3049 : "/usr/bin/arguments",
3050 : nullptr
3051 : };
3052 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
3053 1 : char ** argv = const_cast<char **>(cargv);
3054 :
3055 2 : advgetopt::getopt opt(environment_options, argc, argv);
3056 :
3057 : // check that the result is valid
3058 :
3059 : // an invalid parameter, MUST NOT EXIST
3060 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
3061 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
3062 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
3063 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
3064 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
3065 :
3066 : // the valid parameter
3067 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
3068 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
3069 1 : CATCH_REQUIRE(opt.is_defined("out"));
3070 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
3071 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
3072 1 : CATCH_REQUIRE(opt.get_default("out").empty());
3073 1 : CATCH_REQUIRE(opt.size("out") == 1);
3074 :
3075 : // the valid parameter is the default
3076 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
3077 1 : CATCH_REQUIRE(opt.get_option("--") == opt.get_option("out"));
3078 1 : CATCH_REQUIRE(opt.is_defined("--"));
3079 1 : CATCH_REQUIRE(opt.get_string("--") == "my-filename.out");
3080 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "my-filename.out");
3081 1 : CATCH_REQUIRE(opt.get_default("--").empty());
3082 1 : CATCH_REQUIRE(opt.size("--") == 1);
3083 :
3084 : // other parameters
3085 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
3086 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
3087 : }
3088 :
3089 16 : CATCH_WHEN("using the '--' separator and three arguments")
3090 : {
3091 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "-- my-filename.out -another.out --last.out");
3092 :
3093 1 : char const * cargv[] =
3094 : {
3095 : "/usr/bin/arguments",
3096 : nullptr
3097 : };
3098 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
3099 1 : char ** argv = const_cast<char **>(cargv);
3100 :
3101 2 : advgetopt::getopt opt(environment_options, argc, argv);
3102 :
3103 : // check that the result is valid
3104 :
3105 : // an invalid parameter, MUST NOT EXIST
3106 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
3107 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
3108 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
3109 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
3110 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
3111 :
3112 : // the valid parameter
3113 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
3114 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
3115 1 : CATCH_REQUIRE(opt.is_defined("out"));
3116 1 : CATCH_REQUIRE(opt.get_string("out") == "--last.out");
3117 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "--last.out");
3118 1 : CATCH_REQUIRE(opt.get_default("out").empty());
3119 1 : CATCH_REQUIRE(opt.size("out") == 1);
3120 :
3121 : // the valid parameter is the default
3122 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
3123 1 : CATCH_REQUIRE(opt.get_option("--") == opt.get_option("out"));
3124 1 : CATCH_REQUIRE(opt.is_defined("--"));
3125 1 : CATCH_REQUIRE(opt.get_string("--") == "--last.out");
3126 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "--last.out");
3127 1 : CATCH_REQUIRE(opt.get_default("--").empty());
3128 1 : CATCH_REQUIRE(opt.size("--") == 1);
3129 :
3130 : // other parameters
3131 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
3132 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
3133 : }
3134 :
3135 16 : CATCH_WHEN("using the '--' separator and four arguments with a '-'")
3136 : {
3137 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "-- my-filename.out -another.out - --last.out");
3138 :
3139 1 : char const * cargv[] =
3140 : {
3141 : "/usr/bin/arguments",
3142 : nullptr
3143 : };
3144 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
3145 1 : char ** argv = const_cast<char **>(cargv);
3146 :
3147 2 : advgetopt::getopt opt(environment_options, argc, argv);
3148 :
3149 : // check that the result is valid
3150 :
3151 : // an invalid parameter, MUST NOT EXIST
3152 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
3153 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
3154 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
3155 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
3156 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
3157 :
3158 : // the valid parameter
3159 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
3160 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
3161 1 : CATCH_REQUIRE(opt.is_defined("out"));
3162 1 : CATCH_REQUIRE(opt.get_string("out") == "--last.out");
3163 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "--last.out");
3164 1 : CATCH_REQUIRE(opt.get_default("out").empty());
3165 1 : CATCH_REQUIRE(opt.size("out") == 1);
3166 :
3167 : // the valid parameter is the default
3168 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
3169 1 : CATCH_REQUIRE(opt.get_option("--") == opt.get_option("out"));
3170 1 : CATCH_REQUIRE(opt.is_defined("--"));
3171 1 : CATCH_REQUIRE(opt.get_string("--") == "--last.out");
3172 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "--last.out");
3173 1 : CATCH_REQUIRE(opt.get_default("--").empty());
3174 1 : CATCH_REQUIRE(opt.size("--") == 1);
3175 :
3176 : // other parameters
3177 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
3178 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
3179 : }
3180 : CATCH_END_SECTION()
3181 :
3182 32 : CATCH_START_SECTION("Verify that we can have a non-require argument with an invalid default")
3183 2 : advgetopt::option const options[] =
3184 : {
3185 : advgetopt::define_option(
3186 : advgetopt::Name("before")
3187 : , advgetopt::ShortName('b')
3188 : , advgetopt::Flags(advgetopt::command_flags<>())
3189 : , advgetopt::Help("appears before.")
3190 : , advgetopt::DefaultValue("early")
3191 : ),
3192 : advgetopt::define_option(
3193 : advgetopt::Name("out")
3194 : , advgetopt::ShortName('o')
3195 : , advgetopt::Flags(advgetopt::command_flags<>())
3196 : , advgetopt::Help("output filename.")
3197 : , advgetopt::DefaultValue("default-name")
3198 : , advgetopt::Validator("/[a-z]+/")
3199 : ),
3200 : advgetopt::define_option(
3201 : advgetopt::Name("after")
3202 : , advgetopt::ShortName('a')
3203 : , advgetopt::Flags(advgetopt::command_flags<>())
3204 : , advgetopt::Help("appears after.")
3205 : , advgetopt::DefaultValue("late")
3206 : ),
3207 : advgetopt::end_options()
3208 : };
3209 :
3210 2 : advgetopt::options_environment environment_options;
3211 2 : environment_options.f_project_name = "unittest";
3212 2 : environment_options.f_options = options;
3213 2 : environment_options.f_environment_flags = 0;
3214 2 : environment_options.f_help_header = "Usage: test simple --out <filename> ... option";
3215 2 : environment_options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
3216 :
3217 4 : CATCH_WHEN("no parameters to arguments")
3218 : {
3219 1 : char const * cargv[] =
3220 : {
3221 : "/usr/bin/arguments",
3222 : "--before",
3223 : "--out",
3224 : "--after",
3225 : nullptr
3226 : };
3227 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
3228 1 : char ** argv = const_cast<char **>(cargv);
3229 :
3230 2 : advgetopt::getopt opt(environment_options, argc, argv);
3231 :
3232 : // check that the result is valid
3233 :
3234 : // an invalid parameter, MUST NOT EXIST
3235 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
3236 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
3237 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
3238 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
3239 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
3240 :
3241 : // the valid parameter
3242 1 : CATCH_REQUIRE(opt.get_option("before") != nullptr);
3243 1 : CATCH_REQUIRE(opt.get_option('b') != nullptr);
3244 1 : CATCH_REQUIRE(opt.is_defined("before"));
3245 1 : CATCH_REQUIRE(opt.get_string("before").empty());
3246 1 : CATCH_REQUIRE(opt.get_string("before", 0).empty());
3247 1 : CATCH_REQUIRE(opt.get_default("before") == "early");
3248 1 : CATCH_REQUIRE(opt.size("before") == 1);
3249 :
3250 : // the valid parameter
3251 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
3252 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
3253 1 : CATCH_REQUIRE(opt.is_defined("out"));
3254 1 : CATCH_REQUIRE(opt.get_string("out").empty());
3255 1 : CATCH_REQUIRE(opt.get_string("out", 0).empty());
3256 1 : CATCH_REQUIRE(opt.get_default("out") == "default-name");
3257 1 : CATCH_REQUIRE(opt.size("out") == 1);
3258 :
3259 : // the valid parameter
3260 1 : CATCH_REQUIRE(opt.get_option("after") != nullptr);
3261 1 : CATCH_REQUIRE(opt.get_option('a') != nullptr);
3262 1 : CATCH_REQUIRE(opt.is_defined("after"));
3263 1 : CATCH_REQUIRE(opt.get_string("after").empty());
3264 1 : CATCH_REQUIRE(opt.get_string("after", 0).empty());
3265 1 : CATCH_REQUIRE(opt.get_default("after") == "late");
3266 1 : CATCH_REQUIRE(opt.size("after") == 1);
3267 :
3268 : // other parameters
3269 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
3270 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
3271 : }
3272 :
3273 4 : CATCH_WHEN("parameters to some arguments")
3274 : {
3275 1 : char const * cargv[] =
3276 : {
3277 : "/usr/bin/arguments",
3278 : "--before",
3279 : "avant",
3280 : "--out",
3281 : "--after",
3282 : "apres",
3283 : nullptr
3284 : };
3285 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
3286 1 : char ** argv = const_cast<char **>(cargv);
3287 :
3288 2 : advgetopt::getopt opt(environment_options, argc, argv);
3289 :
3290 : // check that the result is valid
3291 :
3292 : // an invalid parameter, MUST NOT EXIST
3293 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
3294 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
3295 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
3296 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
3297 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
3298 :
3299 : // the valid parameter
3300 1 : CATCH_REQUIRE(opt.get_option("before") != nullptr);
3301 1 : CATCH_REQUIRE(opt.get_option('b') != nullptr);
3302 1 : CATCH_REQUIRE(opt.is_defined("before"));
3303 1 : CATCH_REQUIRE(opt.get_string("before") == "avant");
3304 1 : CATCH_REQUIRE(opt.get_string("before", 0) == "avant");
3305 1 : CATCH_REQUIRE(opt.get_default("before") == "early");
3306 1 : CATCH_REQUIRE(opt.size("before") == 1);
3307 :
3308 : // the valid parameter
3309 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
3310 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
3311 1 : CATCH_REQUIRE(opt.is_defined("out"));
3312 1 : CATCH_REQUIRE(opt.get_string("out").empty());
3313 1 : CATCH_REQUIRE(opt.get_string("out", 0).empty());
3314 1 : CATCH_REQUIRE(opt.get_default("out") == "default-name");
3315 1 : CATCH_REQUIRE(opt.size("out") == 1);
3316 :
3317 : // the valid parameter
3318 1 : CATCH_REQUIRE(opt.get_option("after") != nullptr);
3319 1 : CATCH_REQUIRE(opt.get_option('a') != nullptr);
3320 1 : CATCH_REQUIRE(opt.is_defined("after"));
3321 1 : CATCH_REQUIRE(opt.get_string("after") == "apres");
3322 1 : CATCH_REQUIRE(opt.get_string("after", 0) == "apres");
3323 1 : CATCH_REQUIRE(opt.get_default("after") == "late");
3324 1 : CATCH_REQUIRE(opt.size("after") == 1);
3325 :
3326 : // other parameters
3327 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
3328 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
3329 : }
3330 : CATCH_END_SECTION()
3331 16 : }
3332 :
3333 :
3334 14 : CATCH_TEST_CASE("default_arguments", "[arguments][valid][multiple][getopt]")
3335 : {
3336 24 : CATCH_START_SECTION("Verify a simple [<filename> ...] argument")
3337 4 : advgetopt::option const options[] =
3338 : {
3339 : advgetopt::define_option(
3340 : advgetopt::Name("out")
3341 : , advgetopt::ShortName('o')
3342 : , advgetopt::Flags(advgetopt::any_flags<advgetopt::GETOPT_FLAG_COMMAND_LINE
3343 : , advgetopt::GETOPT_FLAG_DEFAULT_OPTION
3344 : , advgetopt::GETOPT_FLAG_MULTIPLE>())
3345 : , advgetopt::Help("output filename.")
3346 : ),
3347 : advgetopt::end_options()
3348 : };
3349 :
3350 4 : advgetopt::options_environment environment_options;
3351 4 : environment_options.f_project_name = "unittest";
3352 4 : environment_options.f_options = options;
3353 4 : environment_options.f_environment_flags = 0;
3354 4 : environment_options.f_help_header = "Usage: test simple [<filename>] option";
3355 :
3356 8 : CATCH_WHEN("no arguments")
3357 : {
3358 1 : char const * cargv[] =
3359 : {
3360 : "/usr/bin/arguments",
3361 : nullptr
3362 : };
3363 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
3364 1 : char ** argv = const_cast<char **>(cargv);
3365 :
3366 2 : advgetopt::getopt opt(environment_options, argc, argv);
3367 :
3368 : // check that the result is valid
3369 :
3370 : // an invalid parameter, MUST NOT EXIST
3371 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
3372 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
3373 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
3374 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
3375 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
3376 :
3377 : // the valid parameter
3378 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
3379 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
3380 1 : CATCH_REQUIRE_FALSE(opt.is_defined("out"));
3381 1 : CATCH_REQUIRE(opt.get_default("out").empty());
3382 1 : CATCH_REQUIRE(opt.size("out") == 0);
3383 :
3384 : // other parameters
3385 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
3386 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
3387 : }
3388 :
3389 8 : CATCH_WHEN("one argument")
3390 : {
3391 1 : char const * cargv[] =
3392 : {
3393 : "/usr/bin/arguments",
3394 : "my-filename.out",
3395 : nullptr
3396 : };
3397 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
3398 1 : char ** argv = const_cast<char **>(cargv);
3399 :
3400 2 : advgetopt::getopt opt(environment_options, argc, argv);
3401 :
3402 : // check that the result is valid
3403 :
3404 : // an invalid parameter, MUST NOT EXIST
3405 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
3406 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
3407 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
3408 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
3409 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
3410 :
3411 : // the valid parameter
3412 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
3413 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
3414 1 : CATCH_REQUIRE(opt.is_defined("out"));
3415 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
3416 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
3417 1 : CATCH_REQUIRE(opt.get_default("out").empty());
3418 1 : CATCH_REQUIRE(opt.size("out") == 1);
3419 :
3420 : // other parameters
3421 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
3422 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
3423 : }
3424 :
3425 8 : CATCH_WHEN("three arguments")
3426 : {
3427 1 : char const * cargv[] =
3428 : {
3429 : "/usr/bin/arguments",
3430 : "my-filename.out",
3431 : "another.out",
3432 : "last.out",
3433 : nullptr
3434 : };
3435 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
3436 1 : char ** argv = const_cast<char **>(cargv);
3437 :
3438 2 : advgetopt::getopt opt(environment_options, argc, argv);
3439 :
3440 : // check that the result is valid
3441 :
3442 : // an invalid parameter, MUST NOT EXIST
3443 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
3444 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
3445 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
3446 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
3447 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
3448 :
3449 : // the valid parameter
3450 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
3451 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
3452 1 : CATCH_REQUIRE(opt.is_defined("out"));
3453 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
3454 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
3455 1 : CATCH_REQUIRE(opt.get_string("out", 1) == "another.out");
3456 1 : CATCH_REQUIRE(opt.get_string("out", 2) == "last.out");
3457 1 : CATCH_REQUIRE(opt.get_default("out").empty());
3458 1 : CATCH_REQUIRE(opt.size("out") == 3);
3459 :
3460 : // other parameters
3461 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
3462 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
3463 : }
3464 :
3465 8 : CATCH_WHEN("four arguments with a '-'")
3466 : {
3467 1 : char const * cargv[] =
3468 : {
3469 : "/usr/bin/arguments",
3470 : "my-filename.out",
3471 : "another.out",
3472 : "-",
3473 : "last.out",
3474 : nullptr
3475 : };
3476 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
3477 1 : char ** argv = const_cast<char **>(cargv);
3478 :
3479 2 : advgetopt::getopt opt(environment_options, argc, argv);
3480 :
3481 : // check that the result is valid
3482 :
3483 : // an invalid parameter, MUST NOT EXIST
3484 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
3485 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
3486 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
3487 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
3488 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
3489 :
3490 : // the valid parameter
3491 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
3492 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
3493 1 : CATCH_REQUIRE(opt.is_defined("out"));
3494 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
3495 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
3496 1 : CATCH_REQUIRE(opt.get_string("out", 1) == "another.out");
3497 1 : CATCH_REQUIRE(opt.get_string("out", 2) == "-");
3498 1 : CATCH_REQUIRE(opt.get_string("out", 3) == "last.out");
3499 1 : CATCH_REQUIRE(opt.get_default("out").empty());
3500 1 : CATCH_REQUIRE(opt.size("out") == 4);
3501 :
3502 : // other parameters
3503 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
3504 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
3505 : }
3506 : CATCH_END_SECTION()
3507 :
3508 24 : CATCH_START_SECTION("Verify a simple [<filename> ...] argument with the default name (a.k.a. \"--\")")
3509 4 : advgetopt::option const options[] =
3510 : {
3511 : advgetopt::define_option(
3512 : advgetopt::Name("--")
3513 : , advgetopt::Flags(advgetopt::any_flags<advgetopt::GETOPT_FLAG_COMMAND_LINE
3514 : , advgetopt::GETOPT_FLAG_DEFAULT_OPTION
3515 : , advgetopt::GETOPT_FLAG_MULTIPLE>())
3516 : , advgetopt::Help("output filename.")
3517 : ),
3518 : advgetopt::end_options()
3519 : };
3520 :
3521 4 : advgetopt::options_environment environment_options;
3522 4 : environment_options.f_project_name = "unittest";
3523 4 : environment_options.f_options = options;
3524 4 : environment_options.f_environment_flags = 0;
3525 4 : environment_options.f_help_header = "Usage: test simple [<filename>] option";
3526 :
3527 8 : CATCH_WHEN("no arguments")
3528 : {
3529 1 : char const * cargv[] =
3530 : {
3531 : "/usr/bin/arguments",
3532 : nullptr
3533 : };
3534 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
3535 1 : char ** argv = const_cast<char **>(cargv);
3536 :
3537 2 : advgetopt::getopt opt(environment_options, argc, argv);
3538 :
3539 : // check that the result is valid
3540 :
3541 : // an invalid parameter, MUST NOT EXIST
3542 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
3543 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
3544 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
3545 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
3546 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
3547 :
3548 : // the valid parameter
3549 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
3550 1 : CATCH_REQUIRE_FALSE(opt.is_defined("--"));
3551 1 : CATCH_REQUIRE(opt.get_default("--").empty());
3552 1 : CATCH_REQUIRE(opt.size("--") == 0);
3553 :
3554 : // other parameters
3555 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
3556 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
3557 : }
3558 :
3559 8 : CATCH_WHEN("one argument")
3560 : {
3561 1 : char const * cargv[] =
3562 : {
3563 : "/usr/bin/arguments",
3564 : "my-filename.out",
3565 : nullptr
3566 : };
3567 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
3568 1 : char ** argv = const_cast<char **>(cargv);
3569 :
3570 2 : advgetopt::getopt opt(environment_options, argc, argv);
3571 :
3572 : // check that the result is valid
3573 :
3574 : // an invalid parameter, MUST NOT EXIST
3575 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
3576 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
3577 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
3578 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
3579 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
3580 :
3581 : // the valid parameter
3582 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
3583 1 : CATCH_REQUIRE(opt.is_defined("--"));
3584 1 : CATCH_REQUIRE(opt.get_string("--") == "my-filename.out");
3585 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "my-filename.out");
3586 1 : CATCH_REQUIRE(opt.get_default("--").empty());
3587 1 : CATCH_REQUIRE(opt.size("--") == 1);
3588 :
3589 : // other parameters
3590 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
3591 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
3592 : }
3593 :
3594 8 : CATCH_WHEN("three arguments")
3595 : {
3596 1 : char const * cargv[] =
3597 : {
3598 : "/usr/bin/arguments",
3599 : "my-filename.out",
3600 : "another.out",
3601 : "last.out",
3602 : nullptr
3603 : };
3604 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
3605 1 : char ** argv = const_cast<char **>(cargv);
3606 :
3607 2 : advgetopt::getopt opt(environment_options, argc, argv);
3608 :
3609 : // check that the result is valid
3610 :
3611 : // an invalid parameter, MUST NOT EXIST
3612 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
3613 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
3614 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
3615 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
3616 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
3617 :
3618 : // the valid parameter
3619 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
3620 1 : CATCH_REQUIRE(opt.is_defined("--"));
3621 1 : CATCH_REQUIRE(opt.get_string("--") == "my-filename.out");
3622 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "my-filename.out");
3623 1 : CATCH_REQUIRE(opt.get_string("--", 1) == "another.out");
3624 1 : CATCH_REQUIRE(opt.get_string("--", 2) == "last.out");
3625 1 : CATCH_REQUIRE(opt.get_default("--").empty());
3626 1 : CATCH_REQUIRE(opt.size("--") == 3);
3627 :
3628 : // other parameters
3629 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
3630 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
3631 : }
3632 :
3633 8 : CATCH_WHEN("four arguments with a '-'")
3634 : {
3635 1 : char const * cargv[] =
3636 : {
3637 : "/usr/bin/arguments",
3638 : "my-filename.out",
3639 : "another.out",
3640 : "-",
3641 : "last.out",
3642 : nullptr
3643 : };
3644 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
3645 1 : char ** argv = const_cast<char **>(cargv);
3646 :
3647 2 : advgetopt::getopt opt(environment_options, argc, argv);
3648 :
3649 : // check that the result is valid
3650 :
3651 : // an invalid parameter, MUST NOT EXIST
3652 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
3653 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
3654 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
3655 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
3656 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
3657 :
3658 : // the valid parameter
3659 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
3660 1 : CATCH_REQUIRE(opt.is_defined("--"));
3661 1 : CATCH_REQUIRE(opt.get_string("--") == "my-filename.out");
3662 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "my-filename.out");
3663 1 : CATCH_REQUIRE(opt.get_string("--", 1) == "another.out");
3664 1 : CATCH_REQUIRE(opt.get_string("--", 2) == "-");
3665 1 : CATCH_REQUIRE(opt.get_string("--", 3) == "last.out");
3666 1 : CATCH_REQUIRE(opt.get_default("--").empty());
3667 1 : CATCH_REQUIRE(opt.size("--") == 4);
3668 :
3669 : // other parameters
3670 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
3671 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
3672 : }
3673 : CATCH_END_SECTION()
3674 :
3675 24 : CATCH_START_SECTION("Verify a simple [<filename> ...] argument in a variable")
3676 4 : advgetopt::option const options[] =
3677 : {
3678 : advgetopt::define_option(
3679 : advgetopt::Name("out")
3680 : , advgetopt::ShortName('o')
3681 : , advgetopt::Flags(advgetopt::any_flags<advgetopt::GETOPT_FLAG_ENVIRONMENT_VARIABLE
3682 : , advgetopt::GETOPT_FLAG_DEFAULT_OPTION
3683 : , advgetopt::GETOPT_FLAG_MULTIPLE>())
3684 : , advgetopt::Help("output filename.")
3685 : ),
3686 : advgetopt::end_options()
3687 : };
3688 :
3689 4 : advgetopt::options_environment environment_options;
3690 4 : environment_options.f_project_name = "unittest";
3691 4 : environment_options.f_options = options;
3692 4 : environment_options.f_environment_flags = 0;
3693 4 : environment_options.f_help_header = "Usage: test simple --out <filename> ... option";
3694 4 : environment_options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
3695 :
3696 8 : CATCH_WHEN("no arguments")
3697 : {
3698 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "");
3699 :
3700 1 : char const * cargv[] =
3701 : {
3702 : "/usr/bin/arguments",
3703 : nullptr
3704 : };
3705 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
3706 1 : char ** argv = const_cast<char **>(cargv);
3707 :
3708 2 : advgetopt::getopt opt(environment_options, argc, argv);
3709 :
3710 : // check that the result is valid
3711 :
3712 : // an invalid parameter, MUST NOT EXIST
3713 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
3714 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
3715 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
3716 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
3717 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
3718 :
3719 : // the valid parameter
3720 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
3721 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
3722 1 : CATCH_REQUIRE_FALSE(opt.is_defined("out"));
3723 1 : CATCH_REQUIRE(opt.get_default("out").empty());
3724 1 : CATCH_REQUIRE(opt.size("out") == 0);
3725 :
3726 : // other parameters
3727 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
3728 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
3729 : }
3730 :
3731 8 : CATCH_WHEN("one argument")
3732 : {
3733 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "my-filename.out");
3734 :
3735 1 : char const * cargv[] =
3736 : {
3737 : "/usr/bin/arguments",
3738 : nullptr
3739 : };
3740 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
3741 1 : char ** argv = const_cast<char **>(cargv);
3742 :
3743 2 : advgetopt::getopt opt(environment_options, argc, argv);
3744 :
3745 : // check that the result is valid
3746 :
3747 : // an invalid parameter, MUST NOT EXIST
3748 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
3749 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
3750 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
3751 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
3752 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
3753 :
3754 : // the valid parameter
3755 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
3756 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
3757 1 : CATCH_REQUIRE(opt.is_defined("out"));
3758 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
3759 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
3760 1 : CATCH_REQUIRE(opt.get_default("out").empty());
3761 1 : CATCH_REQUIRE(opt.size("out") == 1);
3762 :
3763 : // other parameters
3764 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
3765 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
3766 : }
3767 :
3768 8 : CATCH_WHEN("three arguments")
3769 : {
3770 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "my-filename.out another.out last.out");
3771 :
3772 1 : char const * cargv[] =
3773 : {
3774 : "/usr/bin/arguments",
3775 : nullptr
3776 : };
3777 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
3778 1 : char ** argv = const_cast<char **>(cargv);
3779 :
3780 2 : advgetopt::getopt opt(environment_options, argc, argv);
3781 :
3782 : // check that the result is valid
3783 :
3784 : // an invalid parameter, MUST NOT EXIST
3785 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
3786 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
3787 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
3788 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
3789 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
3790 :
3791 : // the valid parameter
3792 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
3793 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
3794 1 : CATCH_REQUIRE(opt.is_defined("out"));
3795 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
3796 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
3797 1 : CATCH_REQUIRE(opt.get_string("out", 1) == "another.out");
3798 1 : CATCH_REQUIRE(opt.get_string("out", 2) == "last.out");
3799 1 : CATCH_REQUIRE(opt.get_default("out").empty());
3800 1 : CATCH_REQUIRE(opt.size("out") == 3);
3801 :
3802 : // other parameters
3803 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
3804 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
3805 : }
3806 :
3807 8 : CATCH_WHEN("four arguments with a '-'")
3808 : {
3809 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "my-filename.out another.out - last.out");
3810 :
3811 1 : char const * cargv[] =
3812 : {
3813 : "/usr/bin/arguments",
3814 : nullptr
3815 : };
3816 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
3817 1 : char ** argv = const_cast<char **>(cargv);
3818 :
3819 2 : advgetopt::getopt opt(environment_options, argc, argv);
3820 :
3821 : // check that the result is valid
3822 :
3823 : // an invalid parameter, MUST NOT EXIST
3824 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
3825 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
3826 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
3827 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
3828 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
3829 :
3830 : // the valid parameter
3831 1 : CATCH_REQUIRE(opt.get_option("out") != nullptr);
3832 1 : CATCH_REQUIRE(opt.get_option('o') != nullptr);
3833 1 : CATCH_REQUIRE(opt.is_defined("out"));
3834 1 : CATCH_REQUIRE(opt.get_string("out") == "my-filename.out");
3835 1 : CATCH_REQUIRE(opt.get_string("out", 0) == "my-filename.out");
3836 1 : CATCH_REQUIRE(opt.get_string("out", 1) == "another.out");
3837 1 : CATCH_REQUIRE(opt.get_string("out", 2) == "-");
3838 1 : CATCH_REQUIRE(opt.get_string("out", 3) == "last.out");
3839 1 : CATCH_REQUIRE(opt.get_default("out").empty());
3840 1 : CATCH_REQUIRE(opt.size("out") == 4);
3841 :
3842 : // other parameters
3843 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
3844 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
3845 : }
3846 : CATCH_END_SECTION()
3847 12 : }
3848 :
3849 :
3850 5 : CATCH_TEST_CASE("manual_arguments", "[arguments][valid][getopt]")
3851 : {
3852 6 : CATCH_START_SECTION("Verify a few arguments added manually")
3853 :
3854 : // create a getopt object
3855 : //
3856 1 : advgetopt::options_environment environment_options;
3857 1 : environment_options.f_project_name = "unittest";
3858 1 : environment_options.f_help_header = "Usage: test simple --verbose option";
3859 1 : environment_options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
3860 :
3861 2 : advgetopt::getopt opt(environment_options);
3862 :
3863 : // an invalid parameter, MUST NEVER EXIST
3864 : //
3865 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
3866 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
3867 1 : CATCH_REQUIRE_THROWS_MATCHES(
3868 : opt.is_defined("invalid-parameter")
3869 : , advgetopt::getopt_initialization
3870 : , Catch::Matchers::ExceptionMessage(
3871 : "getopt_exception: function called too soon, parser is not done yet (i.e. is_defined(), get_string(), get_integer() cannot be called until the parser is done)"));
3872 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
3873 1 : CATCH_REQUIRE_THROWS_MATCHES(
3874 : opt.size("invalid-parameter")
3875 : , advgetopt::getopt_initialization
3876 : , Catch::Matchers::ExceptionMessage(
3877 : "getopt_exception: function called too soon, parser is not done yet (i.e. is_defined(), get_string(), get_integer() cannot be called until the parser is done)"));
3878 :
3879 : // verbose
3880 : //
3881 1 : CATCH_REQUIRE(opt.get_option("verbose") == nullptr);
3882 1 : CATCH_REQUIRE(opt.get_option('v') == nullptr);
3883 1 : CATCH_REQUIRE_THROWS_MATCHES(
3884 : opt.is_defined("verbose")
3885 : , advgetopt::getopt_initialization
3886 : , Catch::Matchers::ExceptionMessage(
3887 : "getopt_exception: function called too soon, parser is not done yet (i.e. is_defined(), get_string(), get_integer() cannot be called until the parser is done)"));
3888 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
3889 1 : CATCH_REQUIRE_THROWS_MATCHES(
3890 : opt.size("verbose")
3891 : , advgetopt::getopt_initialization
3892 : , Catch::Matchers::ExceptionMessage(
3893 : "getopt_exception: function called too soon, parser is not done yet (i.e. is_defined(), get_string(), get_integer() cannot be called until the parser is done)"));
3894 :
3895 : // help
3896 : //
3897 1 : CATCH_REQUIRE(opt.get_option("help") == nullptr);
3898 1 : CATCH_REQUIRE(opt.get_option('h') == nullptr);
3899 1 : CATCH_REQUIRE(opt.get_default("help").empty());
3900 :
3901 : // default
3902 : //
3903 1 : CATCH_REQUIRE(opt.get_option("--") == nullptr);
3904 1 : CATCH_REQUIRE(opt.get_default("--").empty());
3905 :
3906 : // other parameters
3907 : //
3908 1 : CATCH_REQUIRE(opt.get_program_name().empty());
3909 1 : CATCH_REQUIRE(opt.get_program_fullname().empty());
3910 :
3911 : // setup the program name early
3912 : //
3913 1 : char const * cargv[] =
3914 : {
3915 : "/usr/bin/arguments",
3916 : "--verbose",
3917 : "--help",
3918 : nullptr
3919 : };
3920 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
3921 1 : char ** argv = const_cast<char **>(cargv);
3922 :
3923 1 : opt.parse_program_name(argv);
3924 :
3925 : // an invalid parameter, MUST NEVER EXIST
3926 : //
3927 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
3928 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
3929 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
3930 :
3931 : // verbose
3932 : //
3933 1 : CATCH_REQUIRE(opt.get_option("verbose") == nullptr);
3934 1 : CATCH_REQUIRE(opt.get_option('v') == nullptr);
3935 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
3936 :
3937 : // help
3938 : //
3939 1 : CATCH_REQUIRE(opt.get_option("help") == nullptr);
3940 1 : CATCH_REQUIRE(opt.get_option('h') == nullptr);
3941 1 : CATCH_REQUIRE(opt.get_default("help").empty());
3942 :
3943 : // default
3944 : //
3945 1 : CATCH_REQUIRE(opt.get_option("--") == nullptr);
3946 1 : CATCH_REQUIRE(opt.get_default("--").empty());
3947 :
3948 : // other parameters
3949 : //
3950 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
3951 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
3952 :
3953 : // verify nullptr has no effect
3954 : //
3955 1 : opt.parse_options_info(nullptr);
3956 :
3957 : // an invalid parameter, MUST NEVER EXIST
3958 : //
3959 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
3960 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
3961 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
3962 :
3963 : // verbose
3964 : //
3965 1 : CATCH_REQUIRE(opt.get_option("verbose") == nullptr);
3966 1 : CATCH_REQUIRE(opt.get_option('v') == nullptr);
3967 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
3968 :
3969 : // help
3970 : //
3971 1 : CATCH_REQUIRE(opt.get_option("help") == nullptr);
3972 1 : CATCH_REQUIRE(opt.get_option('h') == nullptr);
3973 1 : CATCH_REQUIRE(opt.get_default("help").empty());
3974 :
3975 : // default
3976 : //
3977 1 : CATCH_REQUIRE(opt.get_option("--") == nullptr);
3978 1 : CATCH_REQUIRE(opt.get_default("--").empty());
3979 :
3980 : // other parameters
3981 : //
3982 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
3983 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
3984 :
3985 : // add --verbose
3986 : //
3987 1 : advgetopt::option const verbose_option[] =
3988 : {
3989 : advgetopt::define_option(
3990 : advgetopt::Name("verbose")
3991 : , advgetopt::ShortName('v')
3992 : , advgetopt::Flags(advgetopt::standalone_command_flags())
3993 : , advgetopt::Help("print info as we work.")
3994 : ),
3995 : advgetopt::end_options()
3996 : };
3997 1 : opt.parse_options_info(verbose_option);
3998 :
3999 : // an invalid parameter, MUST NEVER EXIST
4000 : //
4001 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
4002 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
4003 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
4004 :
4005 : // verbose
4006 : //
4007 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
4008 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
4009 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
4010 :
4011 : // help
4012 : //
4013 1 : CATCH_REQUIRE(opt.get_option("help") == nullptr);
4014 1 : CATCH_REQUIRE(opt.get_option('h') == nullptr);
4015 1 : CATCH_REQUIRE(opt.get_default("help").empty());
4016 :
4017 : // default
4018 : //
4019 1 : CATCH_REQUIRE(opt.get_option("--") == nullptr);
4020 1 : CATCH_REQUIRE(opt.get_default("--").empty());
4021 :
4022 : // other parameters
4023 : //
4024 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
4025 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
4026 :
4027 : // add --help
4028 : //
4029 1 : advgetopt::option const help_option[] =
4030 : {
4031 : advgetopt::define_option(
4032 : advgetopt::Name("help")
4033 : , advgetopt::ShortName('h')
4034 : , advgetopt::Flags(advgetopt::standalone_command_flags())
4035 : , advgetopt::Help("print this help screen.")
4036 : ),
4037 : advgetopt::end_options()
4038 : };
4039 1 : opt.parse_options_info(help_option);
4040 :
4041 : // an invalid parameter, MUST NEVER EXIST
4042 : //
4043 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
4044 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
4045 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
4046 :
4047 : // verbose
4048 : //
4049 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
4050 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
4051 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
4052 :
4053 : // help
4054 : //
4055 1 : CATCH_REQUIRE(opt.get_option("help") != nullptr);
4056 1 : CATCH_REQUIRE(opt.get_option('h') != nullptr);
4057 1 : CATCH_REQUIRE(opt.get_default("help").empty());
4058 :
4059 : // default
4060 : //
4061 1 : CATCH_REQUIRE(opt.get_option("--") == nullptr);
4062 1 : CATCH_REQUIRE(opt.get_default("--").empty());
4063 :
4064 : // other parameters
4065 : //
4066 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
4067 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
4068 :
4069 : // add -- (default option)
4070 : //
4071 1 : advgetopt::option const default_option[] =
4072 : {
4073 : advgetopt::define_option(
4074 : advgetopt::Name("--")
4075 : , advgetopt::Flags(advgetopt::all_flags<advgetopt::GETOPT_FLAG_MULTIPLE>())
4076 : , advgetopt::Help("filenames to handle by this command.")
4077 : ),
4078 : advgetopt::end_options()
4079 : };
4080 1 : opt.parse_options_info(default_option);
4081 :
4082 : // an invalid parameter, MUST NEVER EXIST
4083 : //
4084 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
4085 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
4086 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
4087 :
4088 : // verbose
4089 : //
4090 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
4091 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
4092 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
4093 :
4094 : // help
4095 : //
4096 1 : CATCH_REQUIRE(opt.get_option("help") != nullptr);
4097 1 : CATCH_REQUIRE(opt.get_option('h') != nullptr);
4098 1 : CATCH_REQUIRE(opt.get_default("help").empty());
4099 :
4100 : // default
4101 : //
4102 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
4103 1 : CATCH_REQUIRE(opt.get_default("--").empty());
4104 :
4105 : // other parameters
4106 : //
4107 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
4108 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
4109 :
4110 : // first parse the environment variable
4111 : //
4112 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "file.exe file.so file.dll file.lib file.a");
4113 1 : opt.parse_environment_variable();
4114 :
4115 : // an invalid parameter, MUST NEVER EXIST
4116 : //
4117 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
4118 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
4119 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
4120 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
4121 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
4122 :
4123 : // verbose
4124 : //
4125 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
4126 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
4127 1 : CATCH_REQUIRE_FALSE(opt.is_defined("verbose"));
4128 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
4129 1 : CATCH_REQUIRE(opt.size("verbose") == 0);
4130 :
4131 : // help
4132 : //
4133 1 : CATCH_REQUIRE(opt.get_option("help") != nullptr);
4134 1 : CATCH_REQUIRE(opt.get_option('h') != nullptr);
4135 1 : CATCH_REQUIRE_FALSE(opt.is_defined("help"));
4136 1 : CATCH_REQUIRE(opt.get_default("help").empty());
4137 1 : CATCH_REQUIRE(opt.size("help") == 0);
4138 :
4139 : // default
4140 : //
4141 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
4142 1 : CATCH_REQUIRE(opt.is_defined("--"));
4143 1 : CATCH_REQUIRE(opt.get_string("--") == "file.exe");
4144 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "file.exe");
4145 1 : CATCH_REQUIRE(opt.get_string("--", 1) == "file.so");
4146 1 : CATCH_REQUIRE(opt.get_string("--", 2) == "file.dll");
4147 1 : CATCH_REQUIRE(opt.get_string("--", 3) == "file.lib");
4148 1 : CATCH_REQUIRE(opt.get_string("--", 4) == "file.a");
4149 1 : CATCH_REQUIRE(opt.get_default("--").empty());
4150 1 : CATCH_REQUIRE(opt.size("--") == 5);
4151 :
4152 : // other parameters
4153 : //
4154 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
4155 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
4156 :
4157 : // now parse our command line arguments
4158 : //
4159 1 : opt.parse_arguments(argc, argv, advgetopt::option_source_t::SOURCE_COMMAND_LINE);
4160 :
4161 : // an invalid parameter, MUST NEVER EXIST
4162 : //
4163 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
4164 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
4165 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
4166 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
4167 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
4168 :
4169 : // verbose
4170 : //
4171 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
4172 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
4173 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
4174 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
4175 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
4176 :
4177 : // help
4178 : //
4179 1 : CATCH_REQUIRE(opt.get_option("help") != nullptr);
4180 1 : CATCH_REQUIRE(opt.get_option('h') != nullptr);
4181 1 : CATCH_REQUIRE(opt.is_defined("help"));
4182 1 : CATCH_REQUIRE(opt.get_default("help").empty());
4183 1 : CATCH_REQUIRE(opt.size("help") == 1);
4184 :
4185 : // default
4186 : //
4187 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
4188 1 : CATCH_REQUIRE(opt.is_defined("--"));
4189 1 : CATCH_REQUIRE(opt.get_string("--") == "file.exe");
4190 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "file.exe");
4191 1 : CATCH_REQUIRE(opt.get_string("--", 1) == "file.so");
4192 1 : CATCH_REQUIRE(opt.get_string("--", 2) == "file.dll");
4193 1 : CATCH_REQUIRE(opt.get_string("--", 3) == "file.lib");
4194 1 : CATCH_REQUIRE(opt.get_string("--", 4) == "file.a");
4195 1 : CATCH_REQUIRE(opt.get_default("--").empty());
4196 1 : CATCH_REQUIRE(opt.size("--") == 5);
4197 :
4198 : // other parameters
4199 : //
4200 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
4201 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
4202 :
4203 : CATCH_END_SECTION()
4204 :
4205 6 : CATCH_START_SECTION("Verify a few arguments added manually and system options")
4206 : // create a getopt object with options
4207 : //
4208 1 : advgetopt::option const options[] =
4209 : {
4210 : advgetopt::define_option(
4211 : advgetopt::Name("verbose")
4212 : , advgetopt::ShortName('v')
4213 : , advgetopt::Flags(advgetopt::standalone_command_flags())
4214 : , advgetopt::Help("print info as we work.")
4215 : ),
4216 : advgetopt::define_option(
4217 : advgetopt::Name("size")
4218 : , advgetopt::ShortName('s')
4219 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
4220 : , advgetopt::DefaultValue("123")
4221 : , advgetopt::Help("define a size.")
4222 : ),
4223 : advgetopt::define_option(
4224 : advgetopt::Name("--")
4225 : , advgetopt::Flags(advgetopt::all_flags<advgetopt::GETOPT_FLAG_MULTIPLE>())
4226 : , advgetopt::Help("filenames to handle by this command.")
4227 : ),
4228 : advgetopt::end_options()
4229 : };
4230 :
4231 1 : advgetopt::options_environment environment_options;
4232 1 : environment_options.f_project_name = "unittest";
4233 1 : environment_options.f_options = options;
4234 1 : environment_options.f_environment_flags = advgetopt::GETOPT_ENVIRONMENT_FLAG_SYSTEM_PARAMETERS;
4235 1 : environment_options.f_help_header = "Usage: test simple --verbose option";
4236 1 : environment_options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
4237 :
4238 2 : advgetopt::getopt opt(environment_options);
4239 :
4240 : // an invalid parameter, MUST NEVER EXIST
4241 : //
4242 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
4243 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
4244 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
4245 :
4246 : // verbose
4247 : //
4248 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
4249 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
4250 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
4251 :
4252 : // help
4253 : //
4254 1 : CATCH_REQUIRE(opt.get_option("help") != nullptr);
4255 1 : CATCH_REQUIRE(opt.get_option('h') != nullptr);
4256 1 : CATCH_REQUIRE(opt.get_default("help").empty());
4257 :
4258 : // default
4259 : //
4260 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
4261 1 : CATCH_REQUIRE(opt.get_default("--").empty());
4262 :
4263 : // size
4264 : //
4265 1 : CATCH_REQUIRE(opt.get_option("size") != nullptr);
4266 1 : CATCH_REQUIRE(opt.get_option('s') != nullptr);
4267 1 : CATCH_REQUIRE(opt.get_default("size") == "123");
4268 :
4269 : // pos
4270 : //
4271 1 : CATCH_REQUIRE(opt.get_option("pos") == nullptr);
4272 1 : CATCH_REQUIRE(opt.get_option('p') == nullptr);
4273 1 : CATCH_REQUIRE(opt.get_default("pos").empty());
4274 :
4275 : // other parameters
4276 : //
4277 1 : CATCH_REQUIRE(opt.get_program_name().empty());
4278 1 : CATCH_REQUIRE(opt.get_program_fullname().empty());
4279 :
4280 : // setup the program name early
4281 : //
4282 1 : char const * cargv[] =
4283 : {
4284 : "/usr/bin/arguments",
4285 : "--size",
4286 : "40132",
4287 : "--pos",
4288 : "43,91",
4289 : nullptr
4290 : };
4291 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
4292 1 : char ** argv = const_cast<char **>(cargv);
4293 :
4294 1 : opt.parse_program_name(argv);
4295 :
4296 : // an invalid parameter, MUST NEVER EXIST
4297 : //
4298 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
4299 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
4300 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
4301 :
4302 : // verbose
4303 : //
4304 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
4305 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
4306 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
4307 :
4308 : // help
4309 : //
4310 1 : CATCH_REQUIRE(opt.get_option("help") != nullptr);
4311 1 : CATCH_REQUIRE(opt.get_option('h') != nullptr);
4312 1 : CATCH_REQUIRE(opt.get_default("help").empty());
4313 :
4314 : // size
4315 : //
4316 1 : CATCH_REQUIRE(opt.get_option("size") != nullptr);
4317 1 : CATCH_REQUIRE(opt.get_option('s') != nullptr);
4318 1 : CATCH_REQUIRE(opt.get_default("size") == "123");
4319 :
4320 : // pos
4321 : //
4322 1 : CATCH_REQUIRE(opt.get_option("pos") == nullptr);
4323 1 : CATCH_REQUIRE(opt.get_option('p') == nullptr);
4324 1 : CATCH_REQUIRE(opt.get_default("pos").empty());
4325 :
4326 : // default
4327 : //
4328 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
4329 1 : CATCH_REQUIRE(opt.get_default("--").empty());
4330 :
4331 : // other parameters
4332 : //
4333 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
4334 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
4335 :
4336 : // add --pos
4337 : //
4338 1 : advgetopt::option const help_option[] =
4339 : {
4340 : advgetopt::define_option(
4341 : advgetopt::Name("pos")
4342 : , advgetopt::ShortName('p')
4343 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
4344 : , advgetopt::Help("specify position.")
4345 : , advgetopt::DefaultValue("0,0")
4346 : ),
4347 : advgetopt::end_options()
4348 : };
4349 1 : opt.parse_options_info(help_option);
4350 :
4351 : // an invalid parameter, MUST NEVER EXIST
4352 : //
4353 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
4354 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
4355 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
4356 :
4357 : // verbose
4358 : //
4359 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
4360 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
4361 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
4362 :
4363 : // help
4364 : //
4365 1 : CATCH_REQUIRE(opt.get_option("help") != nullptr);
4366 1 : CATCH_REQUIRE(opt.get_option('h') != nullptr);
4367 1 : CATCH_REQUIRE(opt.get_default("help").empty());
4368 :
4369 : // size
4370 : //
4371 1 : CATCH_REQUIRE(opt.get_option("size") != nullptr);
4372 1 : CATCH_REQUIRE(opt.get_option('s') != nullptr);
4373 1 : CATCH_REQUIRE(opt.get_default("size") == "123");
4374 :
4375 : // pos
4376 : //
4377 1 : CATCH_REQUIRE(opt.get_option("pos") != nullptr);
4378 1 : CATCH_REQUIRE(opt.get_option('p') != nullptr);
4379 1 : CATCH_REQUIRE(opt.get_default("pos") == "0,0");
4380 :
4381 : // default
4382 : //
4383 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
4384 1 : CATCH_REQUIRE(opt.get_default("--").empty());
4385 :
4386 : // other parameters
4387 : //
4388 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
4389 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
4390 :
4391 : // first parse the environment variable
4392 : //
4393 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "file.exe file.so file.dll file.lib file.a");
4394 1 : opt.parse_environment_variable();
4395 :
4396 : // an invalid parameter, MUST NEVER EXIST
4397 : //
4398 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
4399 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
4400 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
4401 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
4402 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
4403 :
4404 : // verbose
4405 : //
4406 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
4407 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
4408 1 : CATCH_REQUIRE_FALSE(opt.is_defined("verbose"));
4409 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
4410 1 : CATCH_REQUIRE(opt.size("verbose") == 0);
4411 :
4412 : // help
4413 : //
4414 1 : CATCH_REQUIRE(opt.get_option("help") != nullptr);
4415 1 : CATCH_REQUIRE(opt.get_option('h') != nullptr);
4416 1 : CATCH_REQUIRE_FALSE(opt.is_defined("help"));
4417 1 : CATCH_REQUIRE(opt.get_default("help").empty());
4418 1 : CATCH_REQUIRE(opt.size("help") == 0);
4419 :
4420 : // size
4421 : //
4422 1 : CATCH_REQUIRE(opt.get_option("size") != nullptr);
4423 1 : CATCH_REQUIRE(opt.get_option('s') != nullptr);
4424 1 : CATCH_REQUIRE_FALSE(opt.is_defined("size"));
4425 1 : CATCH_REQUIRE(opt.get_default("size") == "123");
4426 1 : CATCH_REQUIRE(opt.size("size") == 0);
4427 :
4428 : // pos
4429 : //
4430 1 : CATCH_REQUIRE(opt.get_option("pos") != nullptr);
4431 1 : CATCH_REQUIRE(opt.get_option('p') != nullptr);
4432 1 : CATCH_REQUIRE_FALSE(opt.is_defined("pos"));
4433 1 : CATCH_REQUIRE(opt.get_default("pos") == "0,0");
4434 1 : CATCH_REQUIRE(opt.size("pos") == 0);
4435 :
4436 : // default
4437 : //
4438 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
4439 1 : CATCH_REQUIRE(opt.is_defined("--"));
4440 1 : CATCH_REQUIRE(opt.get_string("--") == "file.exe");
4441 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "file.exe");
4442 1 : CATCH_REQUIRE(opt.get_string("--", 1) == "file.so");
4443 1 : CATCH_REQUIRE(opt.get_string("--", 2) == "file.dll");
4444 1 : CATCH_REQUIRE(opt.get_string("--", 3) == "file.lib");
4445 1 : CATCH_REQUIRE(opt.get_string("--", 4) == "file.a");
4446 1 : CATCH_REQUIRE(opt.get_default("--").empty());
4447 1 : CATCH_REQUIRE(opt.size("--") == 5);
4448 :
4449 : // other parameters
4450 : //
4451 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
4452 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
4453 :
4454 : // now parse our command line arguments
4455 : //
4456 1 : opt.parse_arguments(argc, argv, advgetopt::option_source_t::SOURCE_COMMAND_LINE);
4457 :
4458 : // an invalid parameter, MUST NEVER EXIST
4459 : //
4460 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
4461 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
4462 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
4463 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
4464 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
4465 :
4466 : // verbose
4467 : //
4468 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
4469 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
4470 1 : CATCH_REQUIRE_FALSE(opt.is_defined("verbose"));
4471 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
4472 1 : CATCH_REQUIRE(opt.size("verbose") == 0);
4473 :
4474 : // help
4475 : //
4476 1 : CATCH_REQUIRE(opt.get_option("help") != nullptr);
4477 1 : CATCH_REQUIRE(opt.get_option('h') != nullptr);
4478 1 : CATCH_REQUIRE_FALSE(opt.is_defined("help"));
4479 1 : CATCH_REQUIRE(opt.get_default("help").empty());
4480 1 : CATCH_REQUIRE(opt.size("help") == 0);
4481 :
4482 : // size
4483 : //
4484 1 : CATCH_REQUIRE(opt.get_option("size") != nullptr);
4485 1 : CATCH_REQUIRE(opt.get_option('s') != nullptr);
4486 1 : CATCH_REQUIRE(opt.is_defined("size"));
4487 1 : CATCH_REQUIRE(opt.get_string("size") == "40132");
4488 1 : CATCH_REQUIRE(opt.get_string("size", 0) == "40132");
4489 1 : CATCH_REQUIRE(opt.get_long("size") == 40132);
4490 1 : CATCH_REQUIRE(opt.get_long("size", 0) == 40132);
4491 1 : CATCH_REQUIRE(opt.get_default("size") == "123");
4492 1 : CATCH_REQUIRE(opt.size("size") == 1);
4493 :
4494 : // pos
4495 : //
4496 1 : CATCH_REQUIRE(opt.get_option("pos") != nullptr);
4497 1 : CATCH_REQUIRE(opt.get_option('p') != nullptr);
4498 1 : CATCH_REQUIRE(opt.is_defined("pos"));
4499 1 : CATCH_REQUIRE(opt.get_string("pos") == "43,91");
4500 1 : CATCH_REQUIRE(opt.get_string("pos", 0) == "43,91");
4501 1 : CATCH_REQUIRE(opt.get_default("pos") == "0,0");
4502 1 : CATCH_REQUIRE(opt.size("pos") == 1);
4503 :
4504 : // default
4505 : //
4506 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
4507 1 : CATCH_REQUIRE(opt.is_defined("--"));
4508 1 : CATCH_REQUIRE(opt.get_string("--") == "file.exe");
4509 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "file.exe");
4510 1 : CATCH_REQUIRE(opt.get_string("--", 1) == "file.so");
4511 1 : CATCH_REQUIRE(opt.get_string("--", 2) == "file.dll");
4512 1 : CATCH_REQUIRE(opt.get_string("--", 3) == "file.lib");
4513 1 : CATCH_REQUIRE(opt.get_string("--", 4) == "file.a");
4514 1 : CATCH_REQUIRE(opt.get_default("--").empty());
4515 1 : CATCH_REQUIRE(opt.size("--") == 5);
4516 :
4517 : // other parameters
4518 : //
4519 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
4520 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
4521 :
4522 : // second set of arguments
4523 : //
4524 1 : char const * cargv2[] =
4525 : {
4526 : "/usr/bin/arguments",
4527 : "--help",
4528 : "--verbose",
4529 : nullptr
4530 : };
4531 1 : int const argc2(sizeof(cargv2) / sizeof(cargv2[0]) - 1);
4532 1 : char ** argv2 = const_cast<char **>(cargv2);
4533 :
4534 1 : opt.parse_arguments(argc2, argv2, advgetopt::option_source_t::SOURCE_COMMAND_LINE);
4535 :
4536 : // an invalid parameter, MUST NEVER EXIST
4537 : //
4538 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
4539 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
4540 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
4541 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
4542 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
4543 :
4544 : // verbose
4545 : //
4546 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
4547 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
4548 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
4549 1 : CATCH_REQUIRE(opt.get_string("verbose").empty());
4550 1 : CATCH_REQUIRE(opt.get_string("verbose", 0).empty());
4551 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
4552 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
4553 :
4554 : // help
4555 : //
4556 1 : CATCH_REQUIRE(opt.get_option("help") != nullptr);
4557 1 : CATCH_REQUIRE(opt.get_option('h') != nullptr);
4558 1 : CATCH_REQUIRE(opt.is_defined("help"));
4559 1 : CATCH_REQUIRE(opt.get_string("help").empty());
4560 1 : CATCH_REQUIRE(opt.get_string("help", 0).empty());
4561 1 : CATCH_REQUIRE(opt.get_default("help").empty());
4562 1 : CATCH_REQUIRE(opt.size("help") == 1);
4563 :
4564 : // size
4565 : //
4566 1 : CATCH_REQUIRE(opt.get_option("size") != nullptr);
4567 1 : CATCH_REQUIRE(opt.get_option('s') != nullptr);
4568 1 : CATCH_REQUIRE(opt.is_defined("size"));
4569 1 : CATCH_REQUIRE(opt.get_string("size") == "40132");
4570 1 : CATCH_REQUIRE(opt.get_string("size", 0) == "40132");
4571 1 : CATCH_REQUIRE(opt.get_long("size") == 40132);
4572 1 : CATCH_REQUIRE(opt.get_long("size", 0) == 40132);
4573 1 : CATCH_REQUIRE(opt.get_default("size") == "123");
4574 1 : CATCH_REQUIRE(opt.size("size") == 1);
4575 :
4576 : // pos
4577 : //
4578 1 : CATCH_REQUIRE(opt.get_option("pos") != nullptr);
4579 1 : CATCH_REQUIRE(opt.get_option('p') != nullptr);
4580 1 : CATCH_REQUIRE(opt.is_defined("pos"));
4581 1 : CATCH_REQUIRE(opt.get_string("pos") == "43,91");
4582 1 : CATCH_REQUIRE(opt.get_string("pos", 0) == "43,91");
4583 1 : CATCH_REQUIRE(opt.get_default("pos") == "0,0");
4584 1 : CATCH_REQUIRE(opt.size("pos") == 1);
4585 :
4586 : // default
4587 : //
4588 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
4589 1 : CATCH_REQUIRE(opt.is_defined("--"));
4590 1 : CATCH_REQUIRE(opt.get_string("--") == "file.exe");
4591 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "file.exe");
4592 1 : CATCH_REQUIRE(opt.get_string("--", 1) == "file.so");
4593 1 : CATCH_REQUIRE(opt.get_string("--", 2) == "file.dll");
4594 1 : CATCH_REQUIRE(opt.get_string("--", 3) == "file.lib");
4595 1 : CATCH_REQUIRE(opt.get_string("--", 4) == "file.a");
4596 1 : CATCH_REQUIRE(opt.get_default("--").empty());
4597 1 : CATCH_REQUIRE(opt.size("--") == 5);
4598 :
4599 : // other parameters
4600 : //
4601 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
4602 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
4603 :
4604 : CATCH_END_SECTION()
4605 :
4606 6 : CATCH_START_SECTION("Verify that not calling link_aliases() causes problems")
4607 : // create a getopt object, we will part the options "manually" later
4608 : //
4609 1 : advgetopt::options_environment environment_options;
4610 1 : environment_options.f_project_name = "unittest";
4611 1 : environment_options.f_help_header = "Usage: test --licence as equivalent to --license";
4612 1 : environment_options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
4613 1 : environment_options.f_environment_flags = advgetopt::GETOPT_ENVIRONMENT_FLAG_SYSTEM_PARAMETERS;
4614 :
4615 2 : advgetopt::getopt opt(environment_options);
4616 :
4617 1 : const advgetopt::option options[] =
4618 : {
4619 : advgetopt::define_option(
4620 : advgetopt::Name("verbose")
4621 : , advgetopt::ShortName('v')
4622 : , advgetopt::Flags(advgetopt::standalone_command_flags())
4623 : , advgetopt::Help("print info as we work.")
4624 : ),
4625 : advgetopt::define_option(
4626 : advgetopt::Name("licence") // French spelling
4627 : , advgetopt::Flags(advgetopt::standalone_command_flags())
4628 : , advgetopt::Alias("license") // forgot system flags?
4629 : ),
4630 : advgetopt::end_options()
4631 : };
4632 :
4633 1 : opt.parse_options_info(options);
4634 :
4635 : // "forgot" to call the opt.link_aliases() here
4636 :
4637 1 : char const * cargv[] =
4638 : {
4639 : "/usr/bin/arguments",
4640 : "--verbose",
4641 : "--licence",
4642 : nullptr
4643 : };
4644 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
4645 1 : char ** argv = const_cast<char **>(cargv);
4646 :
4647 1 : CATCH_REQUIRE_THROWS_MATCHES(
4648 : opt.parse_arguments(argc, argv, advgetopt::option_source_t::SOURCE_COMMAND_LINE)
4649 : , advgetopt::getopt_undefined
4650 : , Catch::Matchers::ExceptionMessage(
4651 : "getopt_exception: getopt::get_alias_destination(): alias is missing. Did you call link_aliases()?"));
4652 : CATCH_END_SECTION()
4653 3 : }
4654 :
4655 :
4656 6 : CATCH_TEST_CASE("auto_process_system_arguments", "[arguments][valid][getopt]")
4657 : {
4658 8 : CATCH_START_SECTION("Test auto-processing of system arguments (with many CATCH_WHEN)")
4659 : {
4660 4 : advgetopt::options_environment options;
4661 4 : options.f_project_name = "unittest";
4662 4 : options.f_environment_flags = advgetopt::GETOPT_ENVIRONMENT_FLAG_PROCESS_SYSTEM_PARAMETERS;
4663 4 : options.f_help_header = "Usage: testing system arguments.";
4664 4 : options.f_version = "2.0.1";
4665 4 : options.f_license = "MIT";
4666 4 : options.f_copyright = "Copyright (c) 2019 Made to Order Software Corp. -- All Rights Reserved";
4667 4 : options.f_build_date = "Jun 4 2019";
4668 4 : options.f_build_time = "23:02:36";
4669 :
4670 8 : CATCH_WHEN("Testing --version")
4671 : {
4672 1 : char const * cargv[] =
4673 : {
4674 : "tests/system-arguments",
4675 : "--version",
4676 : nullptr
4677 : };
4678 1 : int const argc = sizeof(cargv) / sizeof(cargv[0]) - 1;
4679 1 : char ** argv = const_cast<char **>(cargv);
4680 :
4681 : // do our own try/catch because we want to test the message
4682 : // and exit code of the exception and it's easier to do it
4683 : // this way
4684 : //
4685 2 : snap::ostream_to_buf<char> out(std::cout);
4686 : try
4687 : {
4688 1 : advgetopt::getopt::pointer_t opt(std::make_shared<advgetopt::getopt>(options, argc, argv));
4689 :
4690 : // if it returns opt cannot be nullptr
4691 : //
4692 0 : CATCH_REQUIRE(opt == nullptr);
4693 : }
4694 2 : catch(advgetopt::getopt_exit const & e)
4695 : {
4696 : // this is the expected route
4697 : //
4698 1 : CATCH_REQUIRE(e.what() == std::string("getopt_exception: system command processed."));
4699 1 : CATCH_REQUIRE(e.code() == 0);
4700 1 : CATCH_REQUIRE(out.str() == "2.0.1\n");
4701 : }
4702 0 : catch(std::exception const & e)
4703 : {
4704 : // no other exception is considered valid here
4705 : //
4706 0 : CATCH_REQUIRE(e.what() == std::string("no other exception was expected..."));
4707 : }
4708 : }
4709 :
4710 8 : CATCH_WHEN("Testing --copyright")
4711 : {
4712 1 : char const * cargv[] =
4713 : {
4714 : "tests/system-arguments",
4715 : "--copyright",
4716 : nullptr
4717 : };
4718 1 : int const argc = sizeof(cargv) / sizeof(cargv[0]) - 1;
4719 1 : char ** argv = const_cast<char **>(cargv);
4720 :
4721 : // do our own try/catch because we want to test the message
4722 : // and exit code of the exception and it's easier to do it
4723 : // this way
4724 : //
4725 2 : snap::ostream_to_buf<char> out(std::cout);
4726 : try
4727 : {
4728 1 : advgetopt::getopt::pointer_t opt(std::make_shared<advgetopt::getopt>(options, argc, argv));
4729 :
4730 : // if it returns opt cannot be nullptr
4731 : //
4732 0 : CATCH_REQUIRE(opt == nullptr);
4733 : }
4734 2 : catch(advgetopt::getopt_exit const & e)
4735 : {
4736 : // this is the expected route
4737 : //
4738 1 : CATCH_REQUIRE(e.what() == std::string("getopt_exception: system command processed."));
4739 1 : CATCH_REQUIRE(e.code() == 0);
4740 1 : CATCH_REQUIRE(out.str() == "Copyright (c) 2019 Made to Order Software Corp. -- All Rights Reserved\n");
4741 : }
4742 0 : catch(std::exception const & e)
4743 : {
4744 : // no other exception is considered valid here
4745 : //
4746 0 : CATCH_REQUIRE(e.what() == std::string("no other exception was expected..."));
4747 : }
4748 : }
4749 :
4750 8 : CATCH_WHEN("Testing --build-date")
4751 : {
4752 1 : char const * cargv[] =
4753 : {
4754 : "tests/system-arguments",
4755 : "--build-date",
4756 : nullptr
4757 : };
4758 1 : int const argc = sizeof(cargv) / sizeof(cargv[0]) - 1;
4759 1 : char ** argv = const_cast<char **>(cargv);
4760 :
4761 : // do our own try/catch because we want to test the message
4762 : // and exit code of the exception and it's easier to do it
4763 : // this way
4764 : //
4765 2 : snap::ostream_to_buf<char> out(std::cout);
4766 : try
4767 : {
4768 1 : advgetopt::getopt::pointer_t opt(std::make_shared<advgetopt::getopt>(options, argc, argv));
4769 :
4770 : // if it returns opt cannot be nullptr
4771 : //
4772 0 : CATCH_REQUIRE(opt == nullptr);
4773 : }
4774 2 : catch(advgetopt::getopt_exit const & e)
4775 : {
4776 : // this is the expected route
4777 : //
4778 1 : CATCH_REQUIRE(e.what() == std::string("getopt_exception: system command processed."));
4779 1 : CATCH_REQUIRE(e.code() == 0);
4780 1 : CATCH_REQUIRE(out.str() == "Built on Jun 4 2019 at 23:02:36\n");
4781 : }
4782 0 : catch(std::exception const & e)
4783 : {
4784 : // no other exception is considered valid here
4785 : //
4786 0 : CATCH_REQUIRE(e.what() == std::string("no other exception was expected..."));
4787 : }
4788 : }
4789 :
4790 8 : CATCH_WHEN("Testing -L (For --license)")
4791 : {
4792 1 : char const * cargv[] =
4793 : {
4794 : "tests/system-arguments",
4795 : "-L",
4796 : nullptr
4797 : };
4798 1 : int const argc = sizeof(cargv) / sizeof(cargv[0]) - 1;
4799 1 : char ** argv = const_cast<char **>(cargv);
4800 :
4801 : // do our own try/catch because we want to test the message
4802 : // and exit code of the exception and it's easier to do it
4803 : // this way
4804 : //
4805 2 : snap::ostream_to_buf<char> out(std::cout);
4806 : try
4807 : {
4808 1 : advgetopt::getopt::pointer_t opt(std::make_shared<advgetopt::getopt>(options, argc, argv));
4809 :
4810 : // if it returns opt cannot be nullptr
4811 : //
4812 0 : CATCH_REQUIRE(opt == nullptr);
4813 : }
4814 2 : catch(advgetopt::getopt_exit const & e)
4815 : {
4816 : // this is the expected route
4817 : //
4818 1 : CATCH_REQUIRE(e.what() == std::string("getopt_exception: system command processed."));
4819 1 : CATCH_REQUIRE(e.code() == 0);
4820 1 : CATCH_REQUIRE(out.str() == "MIT\n");
4821 : }
4822 0 : catch(std::exception const & e)
4823 : {
4824 : // no other exception is considered valid here
4825 : //
4826 0 : CATCH_REQUIRE(e.what() == std::string("no other exception was expected..."));
4827 : }
4828 : }
4829 : }
4830 : CATCH_END_SECTION()
4831 4 : }
4832 :
4833 :
4834 3 : CATCH_TEST_CASE("invalid_getopt_pointers", "[invalid][getopt][arguments]")
4835 : {
4836 2 : CATCH_START_SECTION("Create getopt with argv set to nullptr.")
4837 1 : advgetopt::options_environment const environment_opt;
4838 :
4839 1 : CATCH_REQUIRE_THROWS_MATCHES(
4840 : std::make_shared<advgetopt::getopt>(environment_opt, 3, nullptr)
4841 : , advgetopt::getopt_logic_error
4842 : , Catch::Matchers::ExceptionMessage(
4843 : "getopt_logic_error: argv pointer cannot be nullptr"));
4844 : CATCH_END_SECTION()
4845 1 : }
4846 :
4847 :
4848 4 : CATCH_TEST_CASE("invalid_getopt_missing_options", "[invalid][getopt][arguments]")
4849 : {
4850 4 : CATCH_START_SECTION("Create getopt with no options.")
4851 1 : advgetopt::options_environment options_empty;
4852 1 : options_empty.f_project_name = "unittest";
4853 1 : options_empty.f_options = nullptr;
4854 1 : options_empty.f_help_header = "Usage: try this one and we get a throw (empty list)";
4855 :
4856 1 : char const * cargv[] =
4857 : {
4858 : "/usr/bin/arguments",
4859 : "--no-options",
4860 : nullptr
4861 : };
4862 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
4863 1 : char ** argv = const_cast<char **>(cargv);
4864 :
4865 1 : CATCH_REQUIRE_THROWS_MATCHES(
4866 : std::make_shared<advgetopt::getopt>(options_empty, argc, argv)
4867 : , advgetopt::getopt_logic_error
4868 : , Catch::Matchers::ExceptionMessage(
4869 : "getopt_logic_error: an empty list of options is not legal, you must"
4870 : " defined at least one (i.e. --version, --help...)"));
4871 : CATCH_END_SECTION()
4872 :
4873 4 : CATCH_START_SECTION("Create getopt with an empty list of options.")
4874 1 : const advgetopt::option options_empty_list[] =
4875 : {
4876 : {
4877 : '\0',
4878 : advgetopt::GETOPT_FLAG_END,
4879 : nullptr,
4880 : nullptr,
4881 : nullptr,
4882 : nullptr
4883 : }
4884 : };
4885 :
4886 1 : advgetopt::options_environment options_empty;
4887 1 : options_empty.f_project_name = "unittest";
4888 1 : options_empty.f_options = options_empty_list;
4889 1 : options_empty.f_help_header = "Usage: try this one and we get a throw (empty list)";
4890 :
4891 1 : char const * cargv[] =
4892 : {
4893 : "/usr/bin/arguments",
4894 : "--no-options",
4895 : nullptr
4896 : };
4897 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
4898 1 : char ** argv = const_cast<char **>(cargv);
4899 :
4900 1 : CATCH_REQUIRE_THROWS_MATCHES(
4901 : std::make_shared<advgetopt::getopt>(options_empty, argc, argv)
4902 : , advgetopt::getopt_logic_error
4903 : , Catch::Matchers::ExceptionMessage(
4904 : "getopt_logic_error: an empty list of options is not legal, you must"
4905 : " defined at least one (i.e. --version, --help...)"));
4906 : CATCH_END_SECTION()
4907 2 : }
4908 :
4909 :
4910 6 : CATCH_TEST_CASE("invalid_getopt_missing_required_option", "[invalid][getopt][arguments][alias]")
4911 : {
4912 8 : CATCH_START_SECTION("Specify the option without a corresponding parameter.")
4913 1 : const advgetopt::option options[] =
4914 : {
4915 : advgetopt::define_option(
4916 : advgetopt::Name("verbose")
4917 : , advgetopt::ShortName('v')
4918 : , advgetopt::Flags(advgetopt::standalone_command_flags())
4919 : , advgetopt::Help("print info as we work.")
4920 : ),
4921 : advgetopt::define_option(
4922 : advgetopt::Name("size")
4923 : , advgetopt::Help("The size of the line.")
4924 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
4925 : , advgetopt::DefaultValue("100")
4926 : ),
4927 : advgetopt::end_options()
4928 : };
4929 :
4930 1 : advgetopt::options_environment environment_options;
4931 1 : environment_options.f_project_name = "unittest";
4932 1 : environment_options.f_options = options;
4933 1 : environment_options.f_help_header = "Usage: use --size without a value.";
4934 :
4935 1 : char const * cargv[] =
4936 : {
4937 : "/usr/bin/arguments",
4938 : "--verbose",
4939 : "--size",
4940 : nullptr
4941 : };
4942 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
4943 1 : char ** argv = const_cast<char **>(cargv);
4944 :
4945 1 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option --size expects an argument.");
4946 2 : advgetopt::getopt opt(environment_options, argc, argv);
4947 1 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
4948 :
4949 : // check that the result is valid
4950 :
4951 : // an invalid parameter, MUST NOT EXIST
4952 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
4953 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
4954 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
4955 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
4956 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
4957 :
4958 : // no default
4959 1 : CATCH_REQUIRE(opt.get_option("--") == nullptr);
4960 1 : CATCH_REQUIRE_FALSE(opt.is_defined("--"));
4961 1 : CATCH_REQUIRE(opt.get_default("--").empty());
4962 1 : CATCH_REQUIRE(opt.size("--") == 0);
4963 :
4964 : // the valid parameter
4965 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
4966 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
4967 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
4968 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
4969 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
4970 :
4971 : // the invalid parameter
4972 1 : CATCH_REQUIRE(opt.get_option("size") != nullptr);
4973 1 : CATCH_REQUIRE_FALSE(opt.is_defined("size"));
4974 1 : CATCH_REQUIRE(opt.get_default("size") == "100");
4975 1 : CATCH_REQUIRE(opt.size("size") == 0);
4976 :
4977 : // other parameters
4978 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
4979 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
4980 : CATCH_END_SECTION()
4981 :
4982 8 : CATCH_START_SECTION("Specify the option with an equal sign but without a corresponding parameter.")
4983 1 : const advgetopt::option options[] =
4984 : {
4985 : advgetopt::define_option(
4986 : advgetopt::Name("verbose")
4987 : , advgetopt::ShortName('v')
4988 : , advgetopt::Flags(advgetopt::standalone_command_flags())
4989 : , advgetopt::Help("print info as we work.")
4990 : ),
4991 : advgetopt::define_option(
4992 : advgetopt::Name("size")
4993 : , advgetopt::Help("The size of the line.")
4994 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
4995 : , advgetopt::DefaultValue("100")
4996 : ),
4997 : advgetopt::end_options()
4998 : };
4999 :
5000 1 : advgetopt::options_environment environment_options;
5001 1 : environment_options.f_project_name = "unittest";
5002 1 : environment_options.f_options = options;
5003 1 : environment_options.f_help_header = "Usage: use --size without a value.";
5004 :
5005 1 : char const * cargv[] =
5006 : {
5007 : "/usr/bin/arguments",
5008 : "--verbose",
5009 : "--size=",
5010 : nullptr
5011 : };
5012 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
5013 1 : char ** argv = const_cast<char **>(cargv);
5014 :
5015 1 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option --size must be given a value.");
5016 2 : advgetopt::getopt opt(environment_options, argc, argv);
5017 1 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
5018 :
5019 : // check that the result is valid
5020 :
5021 : // an invalid parameter, MUST NOT EXIST
5022 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
5023 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
5024 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
5025 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
5026 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
5027 :
5028 : // no default
5029 1 : CATCH_REQUIRE(opt.get_option("--") == nullptr);
5030 1 : CATCH_REQUIRE_FALSE(opt.is_defined("--"));
5031 1 : CATCH_REQUIRE(opt.get_default("--").empty());
5032 1 : CATCH_REQUIRE(opt.size("--") == 0);
5033 :
5034 : // the valid parameter
5035 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
5036 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
5037 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
5038 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
5039 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
5040 :
5041 : // the invalid parameter
5042 1 : CATCH_REQUIRE(opt.get_option("size") != nullptr);
5043 1 : CATCH_REQUIRE_FALSE(opt.is_defined("size"));
5044 1 : CATCH_REQUIRE(opt.get_default("size") == "100");
5045 1 : CATCH_REQUIRE(opt.size("size") == 0);
5046 :
5047 : // other parameters
5048 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
5049 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
5050 : CATCH_END_SECTION()
5051 :
5052 8 : CATCH_START_SECTION("Specify the option without a corresponding parameter followed by a long argument.")
5053 1 : const advgetopt::option options[] =
5054 : {
5055 : advgetopt::define_option(
5056 : advgetopt::Name("verbose")
5057 : , advgetopt::ShortName('v')
5058 : , advgetopt::Flags(advgetopt::standalone_command_flags())
5059 : , advgetopt::Help("print info as we work.")
5060 : ),
5061 : advgetopt::define_option(
5062 : advgetopt::Name("size")
5063 : , advgetopt::Help("The size of the line.")
5064 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
5065 : , advgetopt::DefaultValue("100")
5066 : ),
5067 : advgetopt::end_options()
5068 : };
5069 :
5070 1 : advgetopt::options_environment environment_options;
5071 1 : environment_options.f_project_name = "unittest";
5072 1 : environment_options.f_options = options;
5073 1 : environment_options.f_help_header = "Usage: use --size without a value.";
5074 :
5075 1 : char const * cargv[] =
5076 : {
5077 : "/usr/bin/arguments",
5078 : "--size",
5079 : "--verbose",
5080 : nullptr
5081 : };
5082 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
5083 1 : char ** argv = const_cast<char **>(cargv);
5084 :
5085 1 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option --size expects an argument.");
5086 2 : advgetopt::getopt opt(environment_options, argc, argv);
5087 1 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
5088 :
5089 : // check that the result is valid
5090 :
5091 : // an invalid parameter, MUST NOT EXIST
5092 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
5093 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
5094 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
5095 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
5096 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
5097 :
5098 : // no default
5099 1 : CATCH_REQUIRE(opt.get_option("--") == nullptr);
5100 1 : CATCH_REQUIRE_FALSE(opt.is_defined("--"));
5101 1 : CATCH_REQUIRE(opt.get_default("--").empty());
5102 1 : CATCH_REQUIRE(opt.size("--") == 0);
5103 :
5104 : // the valid parameter
5105 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
5106 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
5107 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
5108 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
5109 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
5110 :
5111 : // the invalid parameter
5112 1 : CATCH_REQUIRE(opt.get_option("size") != nullptr);
5113 1 : CATCH_REQUIRE_FALSE(opt.is_defined("size"));
5114 1 : CATCH_REQUIRE(opt.get_default("size") == "100");
5115 1 : CATCH_REQUIRE(opt.size("size") == 0);
5116 :
5117 : // other parameters
5118 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
5119 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
5120 : CATCH_END_SECTION()
5121 :
5122 8 : CATCH_START_SECTION("Specify the option without a corresponding parameter followed by a short argument.")
5123 1 : const advgetopt::option options[] =
5124 : {
5125 : advgetopt::define_option(
5126 : advgetopt::Name("verbose")
5127 : , advgetopt::ShortName('v')
5128 : , advgetopt::Flags(advgetopt::standalone_command_flags())
5129 : , advgetopt::Help("print info as we work.")
5130 : ),
5131 : advgetopt::define_option(
5132 : advgetopt::Name("size")
5133 : , advgetopt::Help("The size of the line.")
5134 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
5135 : , advgetopt::DefaultValue("100")
5136 : ),
5137 : advgetopt::end_options()
5138 : };
5139 :
5140 1 : advgetopt::options_environment environment_options;
5141 1 : environment_options.f_project_name = "unittest";
5142 1 : environment_options.f_options = options;
5143 1 : environment_options.f_help_header = "Usage: use --size without a value.";
5144 :
5145 1 : char const * cargv[] =
5146 : {
5147 : "/usr/bin/arguments",
5148 : "--size",
5149 : "-v",
5150 : nullptr
5151 : };
5152 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
5153 1 : char ** argv = const_cast<char **>(cargv);
5154 :
5155 1 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option --size expects an argument.");
5156 2 : advgetopt::getopt opt(environment_options, argc, argv);
5157 1 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
5158 :
5159 : // check that the result is valid
5160 :
5161 : // an invalid parameter, MUST NOT EXIST
5162 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
5163 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
5164 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
5165 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
5166 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
5167 :
5168 : // no default
5169 1 : CATCH_REQUIRE(opt.get_option("--") == nullptr);
5170 1 : CATCH_REQUIRE_FALSE(opt.is_defined("--"));
5171 1 : CATCH_REQUIRE(opt.get_default("--").empty());
5172 1 : CATCH_REQUIRE(opt.size("--") == 0);
5173 :
5174 : // the valid parameter
5175 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
5176 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
5177 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
5178 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
5179 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
5180 :
5181 : // the invalid parameter
5182 1 : CATCH_REQUIRE(opt.get_option("size") != nullptr);
5183 1 : CATCH_REQUIRE_FALSE(opt.is_defined("size"));
5184 1 : CATCH_REQUIRE(opt.get_default("size") == "100");
5185 1 : CATCH_REQUIRE(opt.size("size") == 0);
5186 :
5187 : // other parameters
5188 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
5189 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
5190 : CATCH_END_SECTION()
5191 4 : }
5192 :
5193 :
5194 11 : CATCH_TEST_CASE("invalid_default_options", "[invalid][getopt][arguments]")
5195 : {
5196 18 : CATCH_START_SECTION("Using a standalone 'file.txt' when no default option is allowed.")
5197 1 : const advgetopt::option options[] =
5198 : {
5199 : advgetopt::define_option(
5200 : advgetopt::Name("verbose")
5201 : , advgetopt::ShortName('v')
5202 : , advgetopt::Flags(advgetopt::standalone_command_flags())
5203 : , advgetopt::Help("print info as we work.")
5204 : ),
5205 : advgetopt::end_options()
5206 : };
5207 :
5208 1 : advgetopt::options_environment environment_options;
5209 1 : environment_options.f_project_name = "unittest";
5210 1 : environment_options.f_options = options;
5211 1 : environment_options.f_help_header = "Usage: use '--' when no default option was defined.";
5212 :
5213 1 : char const * cargv[] =
5214 : {
5215 : "/usr/bin/arguments",
5216 : "--verbose",
5217 : "file.txt",
5218 : nullptr
5219 : };
5220 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
5221 1 : char ** argv = const_cast<char **>(cargv);
5222 :
5223 1 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: no default options defined; we do not know what to do of \"file.txt\"; standalone parameters are not accepted by this program.");
5224 2 : advgetopt::getopt opt(environment_options, argc, argv);
5225 1 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
5226 :
5227 : // check that the result is valid
5228 :
5229 : // an invalid parameter, MUST NOT EXIST
5230 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
5231 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
5232 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
5233 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
5234 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
5235 :
5236 : // no default
5237 1 : CATCH_REQUIRE(opt.get_option("--") == nullptr);
5238 1 : CATCH_REQUIRE_FALSE(opt.is_defined("--"));
5239 1 : CATCH_REQUIRE(opt.get_default("--").empty());
5240 1 : CATCH_REQUIRE(opt.size("--") == 0);
5241 :
5242 : // the valid parameter
5243 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
5244 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
5245 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
5246 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
5247 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
5248 :
5249 : // other parameters
5250 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
5251 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
5252 : CATCH_END_SECTION()
5253 :
5254 18 : CATCH_START_SECTION("Using a standalone 'file.txt' on the command line when only allowed in a variable.")
5255 1 : const advgetopt::option options[] =
5256 : {
5257 : advgetopt::define_option(
5258 : advgetopt::Name("verbose")
5259 : , advgetopt::ShortName('v')
5260 : , advgetopt::Flags(advgetopt::standalone_command_flags())
5261 : , advgetopt::Help("print info as we work.")
5262 : ),
5263 : advgetopt::define_option(
5264 : advgetopt::Name("--")
5265 : , advgetopt::Flags(advgetopt::var_flags<advgetopt::GETOPT_FLAG_DEFAULT_OPTION>())
5266 : , advgetopt::Help("default option.")
5267 : ),
5268 : advgetopt::end_options()
5269 : };
5270 :
5271 1 : advgetopt::options_environment environment_options;
5272 1 : environment_options.f_project_name = "unittest";
5273 1 : environment_options.f_options = options;
5274 1 : environment_options.f_help_header = "Usage: use '--' on the command line when only allowed in the variable.";
5275 1 : environment_options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
5276 :
5277 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "allowed.jpg");
5278 :
5279 1 : char const * cargv[] =
5280 : {
5281 : "/usr/bin/arguments",
5282 : "--verbose",
5283 : "file.txt",
5284 : nullptr
5285 : };
5286 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
5287 1 : char ** argv = const_cast<char **>(cargv);
5288 :
5289 1 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: default options are not supported on the command line.");
5290 2 : advgetopt::getopt opt(environment_options, argc, argv);
5291 1 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
5292 :
5293 : // check that the result is valid
5294 :
5295 : // an invalid parameter, MUST NOT EXIST
5296 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
5297 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
5298 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
5299 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
5300 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
5301 :
5302 : // default on command line passed through
5303 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
5304 1 : CATCH_REQUIRE(opt.is_defined("--"));
5305 1 : CATCH_REQUIRE(opt.get_string("--") == "allowed.jpg");
5306 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "allowed.jpg");
5307 1 : CATCH_REQUIRE(opt.get_default("--").empty());
5308 1 : CATCH_REQUIRE(opt.size("--") == 1);
5309 :
5310 : // the valid parameter
5311 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
5312 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
5313 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
5314 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
5315 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
5316 :
5317 : // other parameters
5318 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
5319 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
5320 : CATCH_END_SECTION()
5321 :
5322 18 : CATCH_START_SECTION("Using a standalone 'file.txt' in a variable when only allowed on the command line.")
5323 1 : const advgetopt::option options[] =
5324 : {
5325 : advgetopt::define_option(
5326 : advgetopt::Name("verbose")
5327 : , advgetopt::ShortName('v')
5328 : , advgetopt::Flags(advgetopt::standalone_command_flags())
5329 : , advgetopt::Help("print info as we work.")
5330 : ),
5331 : advgetopt::define_option(
5332 : advgetopt::Name("--")
5333 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_DEFAULT_OPTION>())
5334 : , advgetopt::Help("default option.")
5335 : ),
5336 : advgetopt::end_options()
5337 : };
5338 :
5339 1 : advgetopt::options_environment environment_options;
5340 1 : environment_options.f_project_name = "unittest";
5341 1 : environment_options.f_options = options;
5342 1 : environment_options.f_help_header = "Usage: use '--' on the command line when only allowed in the variable.";
5343 1 : environment_options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
5344 :
5345 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "file.txt");
5346 :
5347 1 : char const * cargv[] =
5348 : {
5349 : "/usr/bin/arguments",
5350 : "--verbose",
5351 : "allowed.jpg",
5352 : nullptr
5353 : };
5354 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
5355 1 : char ** argv = const_cast<char **>(cargv);
5356 :
5357 1 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: default options are not supported in the environment variable.");
5358 2 : advgetopt::getopt opt(environment_options, argc, argv);
5359 1 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
5360 :
5361 : // check that the result is valid
5362 :
5363 : // an invalid parameter, MUST NOT EXIST
5364 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
5365 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
5366 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
5367 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
5368 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
5369 :
5370 : // default on command line passed through
5371 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
5372 1 : CATCH_REQUIRE(opt.is_defined("--"));
5373 1 : CATCH_REQUIRE(opt.get_string("--") == "allowed.jpg");
5374 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "allowed.jpg");
5375 1 : CATCH_REQUIRE(opt.get_default("--").empty());
5376 1 : CATCH_REQUIRE(opt.size("--") == 1);
5377 :
5378 : // the valid parameter
5379 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
5380 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
5381 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
5382 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
5383 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
5384 :
5385 : // other parameters
5386 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
5387 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
5388 : CATCH_END_SECTION()
5389 :
5390 18 : CATCH_START_SECTION("Using a '--' when no default option is allowed.")
5391 1 : const advgetopt::option options[] =
5392 : {
5393 : advgetopt::define_option(
5394 : advgetopt::Name("verbose")
5395 : , advgetopt::ShortName('v')
5396 : , advgetopt::Flags(advgetopt::standalone_command_flags())
5397 : , advgetopt::Help("print info as we work.")
5398 : ),
5399 : advgetopt::end_options()
5400 : };
5401 :
5402 1 : advgetopt::options_environment environment_options;
5403 1 : environment_options.f_project_name = "unittest";
5404 1 : environment_options.f_options = options;
5405 1 : environment_options.f_help_header = "Usage: use '--' when no default option was defined.";
5406 :
5407 1 : char const * cargv[] =
5408 : {
5409 : "/usr/bin/arguments",
5410 : "--verbose",
5411 : "--",
5412 : "file.txt",
5413 : nullptr
5414 : };
5415 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
5416 1 : char ** argv = const_cast<char **>(cargv);
5417 :
5418 1 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: no default options defined; thus \"--\" is not accepted by this program.");
5419 2 : advgetopt::getopt opt(environment_options, argc, argv);
5420 1 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
5421 :
5422 : // check that the result is valid
5423 :
5424 : // an invalid parameter, MUST NOT EXIST
5425 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
5426 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
5427 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
5428 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
5429 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
5430 :
5431 : // no default
5432 1 : CATCH_REQUIRE(opt.get_option("--") == nullptr);
5433 1 : CATCH_REQUIRE_FALSE(opt.is_defined("--"));
5434 1 : CATCH_REQUIRE(opt.get_default("--").empty());
5435 1 : CATCH_REQUIRE(opt.size("--") == 0);
5436 :
5437 : // the valid parameter
5438 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
5439 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
5440 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
5441 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
5442 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
5443 :
5444 : // other parameters
5445 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
5446 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
5447 : CATCH_END_SECTION()
5448 :
5449 18 : CATCH_START_SECTION("Using a '--' when on the command line when only accepted in variables.")
5450 1 : const advgetopt::option options[] =
5451 : {
5452 : advgetopt::define_option(
5453 : advgetopt::Name("verbose")
5454 : , advgetopt::ShortName('v')
5455 : , advgetopt::Flags(advgetopt::standalone_command_flags())
5456 : , advgetopt::Help("print info as we work.")
5457 : ),
5458 : advgetopt::define_option(
5459 : advgetopt::Name("--")
5460 : , advgetopt::Flags(advgetopt::var_flags<advgetopt::GETOPT_FLAG_DEFAULT_OPTION>())
5461 : , advgetopt::Help("default option.")
5462 : ),
5463 : advgetopt::end_options()
5464 : };
5465 :
5466 1 : advgetopt::options_environment environment_options;
5467 1 : environment_options.f_project_name = "unittest";
5468 1 : environment_options.f_options = options;
5469 1 : environment_options.f_help_header = "Usage: use '--' when no default option was defined.";
5470 1 : environment_options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
5471 :
5472 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "-- allowed.txt");
5473 :
5474 1 : char const * cargv[] =
5475 : {
5476 : "/usr/bin/arguments",
5477 : "--verbose",
5478 : "--",
5479 : "file.txt",
5480 : nullptr
5481 : };
5482 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
5483 1 : char ** argv = const_cast<char **>(cargv);
5484 :
5485 1 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option \"--\" is not supported on the command line.");
5486 2 : advgetopt::getopt opt(environment_options, argc, argv);
5487 1 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
5488 :
5489 : // check that the result is valid
5490 :
5491 : // an invalid parameter, MUST NOT EXIST
5492 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
5493 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
5494 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
5495 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
5496 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
5497 :
5498 : // no default
5499 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
5500 1 : CATCH_REQUIRE(opt.is_defined("--"));
5501 1 : CATCH_REQUIRE(opt.get_string("--") == "allowed.txt");
5502 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "allowed.txt");
5503 1 : CATCH_REQUIRE(opt.get_default("--").empty());
5504 1 : CATCH_REQUIRE(opt.size("--") == 1);
5505 :
5506 : // the valid parameter
5507 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
5508 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
5509 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
5510 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
5511 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
5512 :
5513 : // other parameters
5514 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
5515 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
5516 : CATCH_END_SECTION()
5517 :
5518 18 : CATCH_START_SECTION("Using a '--' in the environment variable when only accepted on the command line.")
5519 1 : const advgetopt::option options[] =
5520 : {
5521 : advgetopt::define_option(
5522 : advgetopt::Name("verbose")
5523 : , advgetopt::ShortName('v')
5524 : , advgetopt::Flags(advgetopt::standalone_command_flags())
5525 : , advgetopt::Help("print info as we work.")
5526 : ),
5527 : advgetopt::define_option(
5528 : advgetopt::Name("--")
5529 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_DEFAULT_OPTION>())
5530 : , advgetopt::Help("default option.")
5531 : ),
5532 : advgetopt::end_options()
5533 : };
5534 :
5535 1 : advgetopt::options_environment environment_options;
5536 1 : environment_options.f_project_name = "unittest";
5537 1 : environment_options.f_options = options;
5538 1 : environment_options.f_help_header = "Usage: use '--' when no default option was defined.";
5539 1 : environment_options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
5540 :
5541 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", " -- file.txt ");
5542 :
5543 1 : char const * cargv[] =
5544 : {
5545 : "/usr/bin/arguments",
5546 : "--verbose",
5547 : "--",
5548 : "allowed.txt",
5549 : nullptr
5550 : };
5551 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
5552 1 : char ** argv = const_cast<char **>(cargv);
5553 :
5554 1 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option \"--\" is not supported in the environment variable.");
5555 2 : advgetopt::getopt opt(environment_options, argc, argv);
5556 1 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
5557 :
5558 : // check that the result is valid
5559 :
5560 : // an invalid parameter, MUST NOT EXIST
5561 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
5562 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
5563 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
5564 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
5565 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
5566 :
5567 : // no default
5568 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
5569 1 : CATCH_REQUIRE(opt.is_defined("--"));
5570 1 : CATCH_REQUIRE(opt.get_string("--") == "allowed.txt");
5571 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "allowed.txt");
5572 1 : CATCH_REQUIRE(opt.get_default("--").empty());
5573 1 : CATCH_REQUIRE(opt.size("--") == 1);
5574 :
5575 : // the valid parameter
5576 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
5577 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
5578 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
5579 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
5580 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
5581 :
5582 : // other parameters
5583 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
5584 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
5585 : CATCH_END_SECTION()
5586 :
5587 18 : CATCH_START_SECTION("Using a '-' when no default option is allowed.")
5588 1 : const advgetopt::option options[] =
5589 : {
5590 : advgetopt::define_option(
5591 : advgetopt::Name("verbose")
5592 : , advgetopt::ShortName('v')
5593 : , advgetopt::Flags(advgetopt::standalone_command_flags())
5594 : , advgetopt::Help("print info as we work.")
5595 : ),
5596 : advgetopt::end_options()
5597 : };
5598 :
5599 1 : advgetopt::options_environment environment_options;
5600 1 : environment_options.f_project_name = "unittest";
5601 1 : environment_options.f_options = options;
5602 1 : environment_options.f_help_header = "Usage: use '-' when no default option was defined.";
5603 :
5604 1 : char const * cargv[] =
5605 : {
5606 : "/usr/bin/arguments",
5607 : "--verbose",
5608 : "-",
5609 : "file.txt",
5610 : nullptr
5611 : };
5612 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
5613 1 : char ** argv = const_cast<char **>(cargv);
5614 :
5615 1 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: no default options defined; thus \"-\" is not accepted by this program.");
5616 2 : advgetopt::getopt opt(environment_options, argc, argv);
5617 1 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
5618 :
5619 : // check that the result is valid
5620 :
5621 : // an invalid parameter, MUST NOT EXIST
5622 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
5623 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
5624 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
5625 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
5626 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
5627 :
5628 : // no default
5629 1 : CATCH_REQUIRE(opt.get_option("--") == nullptr);
5630 1 : CATCH_REQUIRE_FALSE(opt.is_defined("--"));
5631 1 : CATCH_REQUIRE(opt.get_default("--").empty());
5632 1 : CATCH_REQUIRE(opt.size("--") == 0);
5633 :
5634 : // the valid parameter
5635 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
5636 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
5637 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
5638 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
5639 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
5640 :
5641 : // other parameters
5642 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
5643 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
5644 : CATCH_END_SECTION()
5645 :
5646 18 : CATCH_START_SECTION("Using a '-' when on the command line when only accepted in variables.")
5647 1 : const advgetopt::option options[] =
5648 : {
5649 : advgetopt::define_option(
5650 : advgetopt::Name("verbose")
5651 : , advgetopt::ShortName('v')
5652 : , advgetopt::Flags(advgetopt::standalone_command_flags())
5653 : , advgetopt::Help("print info as we work.")
5654 : ),
5655 : advgetopt::define_option(
5656 : advgetopt::Name("--")
5657 : , advgetopt::Flags(advgetopt::var_flags<advgetopt::GETOPT_FLAG_DEFAULT_OPTION>())
5658 : , advgetopt::Help("default option.")
5659 : ),
5660 : advgetopt::end_options()
5661 : };
5662 :
5663 1 : advgetopt::options_environment environment_options;
5664 1 : environment_options.f_project_name = "unittest";
5665 1 : environment_options.f_options = options;
5666 1 : environment_options.f_help_header = "Usage: use '-' when no default option was defined.";
5667 1 : environment_options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
5668 :
5669 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "- allowed.txt");
5670 :
5671 1 : char const * cargv[] =
5672 : {
5673 : "/usr/bin/arguments",
5674 : "--verbose",
5675 : "-",
5676 : "file.txt",
5677 : nullptr
5678 : };
5679 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
5680 1 : char ** argv = const_cast<char **>(cargv);
5681 :
5682 1 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option \"-\" is not supported on the command line.");
5683 2 : advgetopt::getopt opt(environment_options, argc, argv);
5684 1 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
5685 :
5686 : // check that the result is valid
5687 :
5688 : // an invalid parameter, MUST NOT EXIST
5689 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
5690 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
5691 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
5692 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
5693 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
5694 :
5695 : // no default
5696 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
5697 1 : CATCH_REQUIRE(opt.is_defined("--"));
5698 1 : CATCH_REQUIRE(opt.get_string("--") == "allowed.txt");
5699 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "allowed.txt");
5700 1 : CATCH_REQUIRE(opt.get_default("--").empty());
5701 1 : CATCH_REQUIRE(opt.size("--") == 1);
5702 :
5703 : // the valid parameter
5704 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
5705 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
5706 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
5707 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
5708 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
5709 :
5710 : // other parameters
5711 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
5712 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
5713 : CATCH_END_SECTION()
5714 :
5715 18 : CATCH_START_SECTION("Using a '-' in the environment variable when only accepted on the command line.")
5716 1 : const advgetopt::option options[] =
5717 : {
5718 : advgetopt::define_option(
5719 : advgetopt::Name("verbose")
5720 : , advgetopt::ShortName('v')
5721 : , advgetopt::Flags(advgetopt::standalone_command_flags())
5722 : , advgetopt::Help("print info as we work.")
5723 : ),
5724 : advgetopt::define_option(
5725 : advgetopt::Name("--")
5726 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_DEFAULT_OPTION>())
5727 : , advgetopt::Help("default option.")
5728 : ),
5729 : advgetopt::end_options()
5730 : };
5731 :
5732 1 : advgetopt::options_environment environment_options;
5733 1 : environment_options.f_project_name = "unittest";
5734 1 : environment_options.f_options = options;
5735 1 : environment_options.f_help_header = "Usage: use '-' when no default option was defined.";
5736 1 : environment_options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
5737 :
5738 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", " - file.txt ");
5739 :
5740 1 : char const * cargv[] =
5741 : {
5742 : "/usr/bin/arguments",
5743 : "--verbose",
5744 : "-",
5745 : "allowed.txt",
5746 : nullptr
5747 : };
5748 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
5749 1 : char ** argv = const_cast<char **>(cargv);
5750 :
5751 1 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option \"-\" is not supported in the environment variable.");
5752 2 : advgetopt::getopt opt(environment_options, argc, argv);
5753 1 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
5754 :
5755 : // check that the result is valid
5756 :
5757 : // an invalid parameter, MUST NOT EXIST
5758 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
5759 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
5760 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
5761 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
5762 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
5763 :
5764 : // no default
5765 1 : CATCH_REQUIRE(opt.get_option("--") != nullptr);
5766 1 : CATCH_REQUIRE(opt.is_defined("--"));
5767 1 : CATCH_REQUIRE(opt.get_string("--") == "allowed.txt");
5768 1 : CATCH_REQUIRE(opt.get_string("--", 0) == "allowed.txt");
5769 1 : CATCH_REQUIRE(opt.get_default("--").empty());
5770 1 : CATCH_REQUIRE(opt.size("--") == 1);
5771 :
5772 : // the valid parameter
5773 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
5774 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
5775 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
5776 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
5777 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
5778 :
5779 : // other parameters
5780 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
5781 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
5782 : CATCH_END_SECTION()
5783 9 : }
5784 :
5785 :
5786 9 : CATCH_TEST_CASE("invalid_options", "[invalid][getopt][arguments]")
5787 : {
5788 14 : CATCH_START_SECTION("Long option with an equal sign but not name.")
5789 1 : const advgetopt::option options[] =
5790 : {
5791 : advgetopt::define_option(
5792 : advgetopt::Name("size")
5793 : , advgetopt::ShortName('s')
5794 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
5795 : , advgetopt::Help("define the size.")
5796 : ),
5797 : advgetopt::end_options()
5798 : };
5799 :
5800 1 : advgetopt::options_environment environment_options;
5801 1 : environment_options.f_project_name = "unittest";
5802 1 : environment_options.f_options = options;
5803 1 : environment_options.f_help_header = "Usage: use a long name option without the long name.";
5804 :
5805 1 : char const * cargv[] =
5806 : {
5807 : "/usr/bin/arguments",
5808 : "--=591",
5809 : nullptr
5810 : };
5811 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
5812 1 : char ** argv = const_cast<char **>(cargv);
5813 :
5814 1 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: name missing in \"--=591\".");
5815 2 : advgetopt::getopt opt(environment_options, argc, argv);
5816 1 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
5817 :
5818 : // check that the result is valid
5819 :
5820 : // an invalid parameter, MUST NOT EXIST
5821 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
5822 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
5823 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
5824 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
5825 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
5826 :
5827 : // the valid parameter
5828 1 : CATCH_REQUIRE(opt.get_option("size") != nullptr);
5829 1 : CATCH_REQUIRE(opt.get_option('s') != nullptr);
5830 1 : CATCH_REQUIRE_FALSE(opt.is_defined("size"));
5831 1 : CATCH_REQUIRE(opt.get_default("size").empty());
5832 1 : CATCH_REQUIRE(opt.size("size") == 0);
5833 :
5834 : // other parameters
5835 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
5836 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
5837 : CATCH_END_SECTION()
5838 :
5839 14 : CATCH_START_SECTION("Unknown long option.")
5840 1 : const advgetopt::option options[] =
5841 : {
5842 : advgetopt::define_option(
5843 : advgetopt::Name("size")
5844 : , advgetopt::ShortName('s')
5845 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
5846 : , advgetopt::Help("define the size.")
5847 : ),
5848 : advgetopt::end_options()
5849 : };
5850 :
5851 1 : advgetopt::options_environment environment_options;
5852 1 : environment_options.f_project_name = "unittest";
5853 1 : environment_options.f_options = options;
5854 1 : environment_options.f_help_header = "Usage: use an unknown long option.";
5855 :
5856 1 : char const * cargv[] =
5857 : {
5858 : "/usr/bin/arguments",
5859 : "--unknown=568",
5860 : nullptr
5861 : };
5862 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
5863 1 : char ** argv = const_cast<char **>(cargv);
5864 :
5865 1 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option \"--unknown\" is not supported.");
5866 2 : advgetopt::getopt opt(environment_options, argc, argv);
5867 1 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
5868 :
5869 : // check that the result is valid
5870 :
5871 : // an invalid parameter, MUST NOT EXIST
5872 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
5873 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
5874 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
5875 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
5876 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
5877 :
5878 : // the valid parameter
5879 1 : CATCH_REQUIRE(opt.get_option("size") != nullptr);
5880 1 : CATCH_REQUIRE(opt.get_option('s') != nullptr);
5881 1 : CATCH_REQUIRE_FALSE(opt.is_defined("size"));
5882 1 : CATCH_REQUIRE(opt.get_default("size").empty());
5883 1 : CATCH_REQUIRE(opt.size("size") == 0);
5884 :
5885 : // other parameters
5886 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
5887 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
5888 : CATCH_END_SECTION()
5889 :
5890 14 : CATCH_START_SECTION("Long option not available in environment variable.")
5891 1 : const advgetopt::option options[] =
5892 : {
5893 : advgetopt::define_option(
5894 : advgetopt::Name("size")
5895 : , advgetopt::ShortName('s')
5896 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
5897 : , advgetopt::Help("define the size.")
5898 : ),
5899 : advgetopt::end_options()
5900 : };
5901 :
5902 1 : advgetopt::options_environment environment_options;
5903 1 : environment_options.f_project_name = "unittest";
5904 1 : environment_options.f_options = options;
5905 1 : environment_options.f_help_header = "Usage: use an unknown long option.";
5906 1 : environment_options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
5907 :
5908 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "--size 4551");
5909 :
5910 1 : char const * cargv[] =
5911 : {
5912 : "/usr/bin/arguments",
5913 : "--size=568",
5914 : nullptr
5915 : };
5916 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
5917 1 : char ** argv = const_cast<char **>(cargv);
5918 :
5919 1 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option \"--size\" is not supported in the environment variable.");
5920 2 : advgetopt::getopt opt(environment_options, argc, argv);
5921 1 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
5922 :
5923 : // check that the result is valid
5924 :
5925 : // an invalid parameter, MUST NOT EXIST
5926 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
5927 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
5928 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
5929 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
5930 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
5931 :
5932 : // the valid parameter
5933 1 : CATCH_REQUIRE(opt.get_option("size") != nullptr);
5934 1 : CATCH_REQUIRE(opt.get_option('s') != nullptr);
5935 1 : CATCH_REQUIRE(opt.is_defined("size"));
5936 1 : CATCH_REQUIRE(opt.get_string("size") == "568");
5937 1 : CATCH_REQUIRE(opt.get_string("size", 0) == "568");
5938 1 : CATCH_REQUIRE(opt.get_long("size") == 568);
5939 1 : CATCH_REQUIRE(opt.get_long("size", 0) == 568);
5940 1 : CATCH_REQUIRE(opt.get_default("size").empty());
5941 1 : CATCH_REQUIRE(opt.size("size") == 1);
5942 :
5943 : // other parameters
5944 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
5945 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
5946 : CATCH_END_SECTION()
5947 :
5948 14 : CATCH_START_SECTION("Long option not available on command line.")
5949 1 : const advgetopt::option options[] =
5950 : {
5951 : advgetopt::define_option(
5952 : advgetopt::Name("size")
5953 : , advgetopt::ShortName('s')
5954 : , advgetopt::Flags(advgetopt::var_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
5955 : , advgetopt::Help("define the size.")
5956 : , advgetopt::DefaultValue("331")
5957 : ),
5958 : advgetopt::end_options()
5959 : };
5960 :
5961 1 : advgetopt::options_environment environment_options;
5962 1 : environment_options.f_project_name = "unittest";
5963 1 : environment_options.f_options = options;
5964 1 : environment_options.f_help_header = "Usage: use an unknown long option.";
5965 1 : environment_options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
5966 :
5967 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "--size 4551");
5968 :
5969 1 : char const * cargv[] =
5970 : {
5971 : "/usr/bin/arguments",
5972 : "--size=568",
5973 : nullptr
5974 : };
5975 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
5976 1 : char ** argv = const_cast<char **>(cargv);
5977 :
5978 1 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option \"--size\" is not supported on the command line.");
5979 2 : advgetopt::getopt opt(environment_options, argc, argv);
5980 1 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
5981 :
5982 : // check that the result is valid
5983 :
5984 : // an invalid parameter, MUST NOT EXIST
5985 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
5986 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
5987 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
5988 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
5989 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
5990 :
5991 : // the valid parameter
5992 1 : CATCH_REQUIRE(opt.get_option("size") != nullptr);
5993 1 : CATCH_REQUIRE(opt.get_option('s') != nullptr);
5994 1 : CATCH_REQUIRE(opt.is_defined("size"));
5995 1 : CATCH_REQUIRE(opt.get_string("size") == "4551");
5996 1 : CATCH_REQUIRE(opt.get_string("size", 0) == "4551");
5997 1 : CATCH_REQUIRE(opt.get_long("size") == 4551);
5998 1 : CATCH_REQUIRE(opt.get_long("size", 0) == 4551);
5999 1 : CATCH_REQUIRE(opt.get_default("size") == "331");
6000 1 : CATCH_REQUIRE(opt.size("size") == 1);
6001 :
6002 : // other parameters
6003 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
6004 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
6005 : CATCH_END_SECTION()
6006 :
6007 14 : CATCH_START_SECTION("Unknown short option.")
6008 1 : const advgetopt::option options[] =
6009 : {
6010 : advgetopt::define_option(
6011 : advgetopt::Name("verbose")
6012 : , advgetopt::ShortName('v')
6013 : , advgetopt::Flags(advgetopt::standalone_command_flags<>())
6014 : , advgetopt::Help("tell you about our work here.")
6015 : ),
6016 : advgetopt::define_option(
6017 : advgetopt::Name("size")
6018 : , advgetopt::ShortName('s')
6019 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
6020 : , advgetopt::Help("define the size.")
6021 : ),
6022 : advgetopt::end_options()
6023 : };
6024 :
6025 1 : advgetopt::options_environment environment_options;
6026 1 : environment_options.f_project_name = "unittest";
6027 1 : environment_options.f_options = options;
6028 1 : environment_options.f_help_header = "Usage: use an unknown long option.";
6029 :
6030 1 : char const * cargv[] =
6031 : {
6032 : "/usr/bin/arguments",
6033 : "-vq 568",
6034 : nullptr
6035 : };
6036 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
6037 1 : char ** argv = const_cast<char **>(cargv);
6038 :
6039 1 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option \"-q\" is not supported.");
6040 2 : advgetopt::getopt opt(environment_options, argc, argv);
6041 1 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
6042 :
6043 : // check that the result is valid
6044 :
6045 : // an invalid parameter, MUST NOT EXIST
6046 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
6047 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
6048 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
6049 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
6050 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
6051 :
6052 : // verbose
6053 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
6054 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
6055 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
6056 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
6057 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
6058 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
6059 :
6060 : // the valid parameter
6061 1 : CATCH_REQUIRE(opt.get_option("size") != nullptr);
6062 1 : CATCH_REQUIRE(opt.get_option('s') != nullptr);
6063 1 : CATCH_REQUIRE_FALSE(opt.is_defined("size"));
6064 1 : CATCH_REQUIRE(opt.get_default("size").empty());
6065 1 : CATCH_REQUIRE(opt.size("size") == 0);
6066 :
6067 : // other parameters
6068 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
6069 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
6070 : CATCH_END_SECTION()
6071 :
6072 14 : CATCH_START_SECTION("Short option not available in environment variable.")
6073 1 : const advgetopt::option options[] =
6074 : {
6075 : advgetopt::define_option(
6076 : advgetopt::Name("size")
6077 : , advgetopt::ShortName('s')
6078 : , advgetopt::Flags(advgetopt::command_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
6079 : , advgetopt::Help("define the size.")
6080 : ),
6081 : advgetopt::define_option(
6082 : advgetopt::Name("verbose")
6083 : , advgetopt::ShortName('v')
6084 : , advgetopt::Flags(advgetopt::standalone_command_flags<>())
6085 : , advgetopt::Help("tell you about our work here.")
6086 : ),
6087 : advgetopt::end_options()
6088 : };
6089 :
6090 1 : advgetopt::options_environment environment_options;
6091 1 : environment_options.f_project_name = "unittest";
6092 1 : environment_options.f_options = options;
6093 1 : environment_options.f_help_header = "Usage: use an unknown long option.";
6094 1 : environment_options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
6095 :
6096 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "-s 4551");
6097 :
6098 1 : char const * cargv[] =
6099 : {
6100 : "/usr/bin/arguments",
6101 : "-sv",
6102 : "568",
6103 : nullptr
6104 : };
6105 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
6106 1 : char ** argv = const_cast<char **>(cargv);
6107 :
6108 1 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option \"-s\" is not supported in the environment variable.");
6109 1 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: no default options defined; we do not know what to do of \"4551\"; standalone parameters are not accepted by this program.");
6110 2 : advgetopt::getopt opt(environment_options, argc, argv);
6111 1 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
6112 :
6113 : // check that the result is valid
6114 :
6115 : // an invalid parameter, MUST NOT EXIST
6116 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
6117 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
6118 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
6119 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
6120 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
6121 :
6122 : // the valid parameter
6123 1 : CATCH_REQUIRE(opt.get_option("size") != nullptr);
6124 1 : CATCH_REQUIRE(opt.get_option('s') != nullptr);
6125 1 : CATCH_REQUIRE(opt.is_defined("size"));
6126 1 : CATCH_REQUIRE(opt.get_string("size") == "568");
6127 1 : CATCH_REQUIRE(opt.get_string("size", 0) == "568");
6128 1 : CATCH_REQUIRE(opt.get_long("size") == 568);
6129 1 : CATCH_REQUIRE(opt.get_long("size", 0) == 568);
6130 1 : CATCH_REQUIRE(opt.get_default("size").empty());
6131 1 : CATCH_REQUIRE(opt.size("size") == 1);
6132 :
6133 : // verbose
6134 1 : CATCH_REQUIRE(opt.get_option("verbose") != nullptr);
6135 1 : CATCH_REQUIRE(opt.get_option('v') != nullptr);
6136 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
6137 1 : CATCH_REQUIRE(opt.is_defined("verbose"));
6138 1 : CATCH_REQUIRE(opt.get_default("verbose").empty());
6139 1 : CATCH_REQUIRE(opt.size("verbose") == 1);
6140 :
6141 : // other parameters
6142 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
6143 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
6144 : CATCH_END_SECTION()
6145 :
6146 14 : CATCH_START_SECTION("Long option not available on command line.")
6147 1 : const advgetopt::option options[] =
6148 : {
6149 : advgetopt::define_option(
6150 : advgetopt::Name("size")
6151 : , advgetopt::ShortName('s')
6152 : , advgetopt::Flags(advgetopt::var_flags<advgetopt::GETOPT_FLAG_REQUIRED>())
6153 : , advgetopt::Help("define the size.")
6154 : , advgetopt::DefaultValue("331")
6155 : ),
6156 : advgetopt::define_option(
6157 : advgetopt::Name("verbose")
6158 : , advgetopt::ShortName('v')
6159 : , advgetopt::Flags(advgetopt::standalone_command_flags<>())
6160 : , advgetopt::Help("tell you about our work here.")
6161 : ),
6162 : advgetopt::end_options()
6163 : };
6164 :
6165 1 : advgetopt::options_environment environment_options;
6166 1 : environment_options.f_project_name = "unittest";
6167 1 : environment_options.f_options = options;
6168 1 : environment_options.f_help_header = "Usage: use an unknown long option.";
6169 1 : environment_options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
6170 :
6171 2 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "-s 4551");
6172 :
6173 1 : char const * cargv[] =
6174 : {
6175 : "/usr/bin/arguments",
6176 : "-sv 568",
6177 : nullptr
6178 : };
6179 1 : int const argc(sizeof(cargv) / sizeof(cargv[0]) - 1);
6180 1 : char ** argv = const_cast<char **>(cargv);
6181 :
6182 1 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option \"-s\" is not supported on the command line.");
6183 : //SNAP_CATCH2_NAMESPACE::push_expected_log("error: no default options defined; we do not know what to do of \"4551\"; standalone parameters are not accepted by this program.");
6184 2 : advgetopt::getopt opt(environment_options, argc, argv);
6185 1 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
6186 :
6187 : // check that the result is valid
6188 :
6189 : // an invalid parameter, MUST NOT EXIST
6190 1 : CATCH_REQUIRE(opt.get_option("invalid-parameter") == nullptr);
6191 1 : CATCH_REQUIRE(opt.get_option('Z') == nullptr);
6192 1 : CATCH_REQUIRE_FALSE(opt.is_defined("invalid-parameter"));
6193 1 : CATCH_REQUIRE(opt.get_default("invalid-parameter").empty());
6194 1 : CATCH_REQUIRE(opt.size("invalid-parameter") == 0);
6195 :
6196 : // the valid parameter
6197 1 : CATCH_REQUIRE(opt.get_option("size") != nullptr);
6198 1 : CATCH_REQUIRE(opt.get_option('s') != nullptr);
6199 1 : CATCH_REQUIRE(opt.is_defined("size"));
6200 1 : CATCH_REQUIRE(opt.get_string("size") == "4551");
6201 1 : CATCH_REQUIRE(opt.get_string("size", 0) == "4551");
6202 1 : CATCH_REQUIRE(opt.get_long("size") == 4551);
6203 1 : CATCH_REQUIRE(opt.get_long("size", 0) == 4551);
6204 1 : CATCH_REQUIRE(opt.get_default("size") == "331");
6205 1 : CATCH_REQUIRE(opt.size("size") == 1);
6206 :
6207 : // other parameters
6208 1 : CATCH_REQUIRE(opt.get_program_name() == "arguments");
6209 1 : CATCH_REQUIRE(opt.get_program_fullname() == "/usr/bin/arguments");
6210 : CATCH_END_SECTION()
6211 13 : }
6212 :
6213 :
6214 : #if 0
6215 : // TODO: break this out in sections and even multiple tests
6216 : // the old version would check a command set of options which is
6217 : // not required (doable/useful) with version 2.x
6218 : //
6219 : // also this test used to work but now that I heavily changed
6220 : // the configuration file loading process (specifically, added
6221 : // the cache), it fails since this test assumed that you can
6222 : // load a new copy of the same file over and over again
6223 :
6224 : CATCH_TEST_CASE("invalid_parameters", "[invalid][getopt][arguments]")
6225 : {
6226 :
6227 : CATCH_START_SECTION("Check all possible invalid argument")
6228 :
6229 : // default arguments
6230 : //
6231 : char const * cargv[] =
6232 : {
6233 : "tests/unittests/invalid_parameters",
6234 : "--ignore-parameters",
6235 : nullptr
6236 : };
6237 : const int argc = sizeof(cargv) / sizeof(cargv[0]) - 1;
6238 : char **argv = const_cast<char **>(cargv);
6239 :
6240 : // no options available
6241 : //
6242 : const advgetopt::option options_empty_list[] =
6243 : {
6244 : {
6245 : '\0',
6246 : advgetopt::GETOPT_FLAG_END,
6247 : nullptr,
6248 : nullptr,
6249 : nullptr,
6250 : nullptr
6251 : }
6252 : };
6253 :
6254 : advgetopt::options_environment options_empty;
6255 : options_empty.f_project_name = "unittest";
6256 : options_empty.f_options = options_empty_list;
6257 : options_empty.f_help_header = "Usage: try this one and we get a throw (empty list)";
6258 :
6259 : {
6260 : CATCH_REQUIRE_THROWS_AS(std::make_shared<advgetopt::getopt>(options_empty, argc, argv), advgetopt::getopt_logic_error);
6261 : }
6262 :
6263 : // option without a name and "wrong" type
6264 : //
6265 : const advgetopt::option options_no_name_list[] =
6266 : {
6267 : {
6268 : '\0',
6269 : advgetopt::GETOPT_FLAG_REQUIRED,
6270 : nullptr,
6271 : "we can have a default though",
6272 : nullptr,
6273 : nullptr
6274 : },
6275 : {
6276 : '\0',
6277 : advgetopt::GETOPT_FLAG_END,
6278 : nullptr,
6279 : nullptr,
6280 : nullptr,
6281 : nullptr
6282 : }
6283 : };
6284 :
6285 : advgetopt::options_environment options_no_name;
6286 : options_no_name.f_project_name = "unittest";
6287 : options_no_name.f_options = options_no_name_list;
6288 : options_no_name.f_help_header = "Usage: try this one and we get a throw (no name)";
6289 :
6290 : {
6291 : CATCH_REQUIRE_THROWS_AS(std::make_shared<advgetopt::getopt>(options_no_name, argc, argv), advgetopt::getopt_logic_error);
6292 : }
6293 :
6294 : // long options must be 2+ characters
6295 : //
6296 : const advgetopt::option options_2chars_minimum_list[] =
6297 : {
6298 : {
6299 : '\0',
6300 : advgetopt::GETOPT_FLAG_MULTIPLE,
6301 : "", // cannot be empty string (use nullptr instead)
6302 : nullptr,
6303 : "long option must be 2 characters long at least",
6304 : nullptr
6305 : },
6306 : {
6307 : '\0',
6308 : advgetopt::GETOPT_FLAG_END,
6309 : nullptr,
6310 : nullptr,
6311 : nullptr,
6312 : nullptr
6313 : }
6314 : };
6315 :
6316 : advgetopt::options_environment options_2chars_minimum;
6317 : options_2chars_minimum.f_project_name = "unittest";
6318 : options_2chars_minimum.f_options = options_2chars_minimum_list;
6319 : options_2chars_minimum.f_help_header = "Usage: try this one and we get a throw (2 chars minimum)";
6320 :
6321 : {
6322 : CATCH_REQUIRE_THROWS_AS(std::make_shared<advgetopt::getopt>(options_2chars_minimum, argc, argv), advgetopt::getopt_logic_error);
6323 : }
6324 :
6325 : // long options must be 2+ characters
6326 : //
6327 : const advgetopt::option options_2chars_minimum2_list[] =
6328 : {
6329 : {
6330 : '\0',
6331 : advgetopt::GETOPT_FLAG_MULTIPLE,
6332 : "f", // cannot be 1 character
6333 : nullptr,
6334 : "long option must be 2 characters long at least",
6335 : nullptr
6336 : },
6337 : {
6338 : '\0',
6339 : advgetopt::GETOPT_FLAG_END,
6340 : nullptr,
6341 : nullptr,
6342 : nullptr,
6343 : nullptr
6344 : }
6345 : };
6346 :
6347 : advgetopt::options_environment options_2chars_minimum2;
6348 : options_2chars_minimum2.f_project_name = "unittest";
6349 : options_2chars_minimum2.f_options = options_2chars_minimum2_list;
6350 : options_2chars_minimum2.f_help_header = "Usage: try this one and we get a throw (2 chars minimum 2nd)";
6351 :
6352 : {
6353 : CATCH_REQUIRE_THROWS_AS(std::make_shared<advgetopt::getopt>(options_2chars_minimum2, argc, argv), advgetopt::getopt_logic_error);
6354 : }
6355 :
6356 : // same long option defined twice
6357 : //
6358 : const advgetopt::option options_defined_twice_list[] =
6359 : {
6360 : {
6361 : '\0',
6362 : advgetopt::GETOPT_FLAG_REQUIRED,
6363 : "filename",
6364 : nullptr,
6365 : "options must be unique",
6366 : nullptr
6367 : },
6368 : {
6369 : '\0',
6370 : advgetopt::GETOPT_FLAG_REQUIRED,
6371 : "filename", // copy/paste problem maybe?
6372 : nullptr,
6373 : "options must be unique",
6374 : nullptr
6375 : },
6376 : {
6377 : '\0',
6378 : advgetopt::GETOPT_FLAG_END,
6379 : nullptr,
6380 : nullptr,
6381 : nullptr,
6382 : nullptr
6383 : }
6384 : };
6385 :
6386 : advgetopt::options_environment options_defined_twice;
6387 : options_defined_twice.f_project_name = "unittest";
6388 : options_defined_twice.f_options = options_defined_twice_list;
6389 : options_defined_twice.f_help_header = "Usage: try this one and we get a throw (long defined twice)";
6390 :
6391 : {
6392 : CATCH_REQUIRE_THROWS_AS(std::make_shared<advgetopt::getopt>(options_defined_twice, argc, argv), advgetopt::getopt_logic_error);
6393 : }
6394 :
6395 : // same short option defined twice
6396 : //
6397 : const advgetopt::option options_short_defined_twice_list[] =
6398 : {
6399 : {
6400 : 'f',
6401 : advgetopt::GETOPT_FLAG_REQUIRED,
6402 : "from",
6403 : nullptr,
6404 : "options must be unique",
6405 : nullptr
6406 : },
6407 : {
6408 : 'f',
6409 : advgetopt::GETOPT_FLAG_REQUIRED,
6410 : "to",
6411 : nullptr,
6412 : "options must be unique",
6413 : nullptr
6414 : },
6415 : {
6416 : '\0',
6417 : advgetopt::GETOPT_FLAG_END,
6418 : nullptr,
6419 : nullptr,
6420 : nullptr,
6421 : nullptr
6422 : }
6423 : };
6424 :
6425 : advgetopt::options_environment options_short_defined_twice;
6426 : options_short_defined_twice.f_project_name = "unittest";
6427 : options_short_defined_twice.f_options = options_short_defined_twice_list;
6428 : options_short_defined_twice.f_help_header = "Usage: try this one and we get a throw (short defined twice)";
6429 : options_short_defined_twice.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
6430 :
6431 : {
6432 : CATCH_REQUIRE_THROWS_AS(std::make_shared<advgetopt::getopt>(options_short_defined_twice, argc, argv), advgetopt::getopt_logic_error);
6433 : }
6434 :
6435 : // 2 default_multiple_argument's in the same list is invalid
6436 : //
6437 : const advgetopt::option options_two_default_multiple_arguments_list[] =
6438 : {
6439 : {
6440 : '\0',
6441 : advgetopt::GETOPT_FLAG_MULTIPLE | advgetopt::GETOPT_FLAG_DEFAULT_OPTION,
6442 : "filenames",
6443 : nullptr,
6444 : "other parameters are viewed as filenames",
6445 : nullptr
6446 : },
6447 : {
6448 : '\0',
6449 : advgetopt::GETOPT_FLAG_MULTIPLE | advgetopt::GETOPT_FLAG_DEFAULT_OPTION,
6450 : "more",
6451 : nullptr,
6452 : "yet other parameters are viewed as \"more\" data--here it breaks, one default max.",
6453 : nullptr
6454 : },
6455 : {
6456 : '\0',
6457 : advgetopt::GETOPT_FLAG_END,
6458 : nullptr,
6459 : nullptr,
6460 : nullptr,
6461 : nullptr
6462 : }
6463 : };
6464 :
6465 : advgetopt::options_environment options_two_default_multiple_arguments;
6466 : options_two_default_multiple_arguments.f_project_name = "unittest";
6467 : options_two_default_multiple_arguments.f_options = options_two_default_multiple_arguments_list;
6468 : options_two_default_multiple_arguments.f_help_header = "Usage: try this one and we get a throw (two defaults by flag, multiple args)";
6469 :
6470 : {
6471 : CATCH_REQUIRE_THROWS_AS(std::make_shared<advgetopt::getopt>(options_two_default_multiple_arguments, argc, argv), advgetopt::getopt_logic_error);
6472 : }
6473 :
6474 : // 2 default_argument's in the same list is invalid
6475 : //
6476 : const advgetopt::option options_two_default_arguments_list[] =
6477 : {
6478 : {
6479 : '\0',
6480 : 0,
6481 : "--",
6482 : nullptr,
6483 : "one other parameter is viewed as a filename",
6484 : nullptr
6485 : },
6486 : {
6487 : '\0',
6488 : 0,
6489 : "--",
6490 : nullptr,
6491 : "yet other parameter viewed as \"more\" data--here it breaks, one default max.",
6492 : nullptr
6493 : },
6494 : {
6495 : '\0',
6496 : advgetopt::GETOPT_FLAG_END,
6497 : nullptr,
6498 : nullptr,
6499 : nullptr,
6500 : nullptr
6501 : }
6502 : };
6503 :
6504 : advgetopt::options_environment options_two_default_arguments;
6505 : options_two_default_arguments.f_project_name = "unittest";
6506 : options_two_default_arguments.f_options = options_two_default_arguments_list;
6507 : options_two_default_arguments.f_help_header = "Usage: try this one and we get a throw (two default args by name)";
6508 :
6509 : {
6510 : CATCH_REQUIRE_THROWS_AS(std::make_shared<advgetopt::getopt>(options_two_default_arguments, argc, argv), advgetopt::getopt_logic_error);
6511 : }
6512 :
6513 : // mix of default arguments in the same list is invalid
6514 : //
6515 : const advgetopt::option options_mix_of_default_list[] =
6516 : {
6517 : {
6518 : '\0',
6519 : advgetopt::GETOPT_FLAG_MULTIPLE,
6520 : "--",
6521 : nullptr,
6522 : "other parameters are viewed as filenames",
6523 : nullptr
6524 : },
6525 : {
6526 : '\0',
6527 : 0,
6528 : "--",
6529 : nullptr,
6530 : "yet other parameter viewed as \"more\" data--here it breaks, one default max.",
6531 : nullptr
6532 : },
6533 : {
6534 : '\0',
6535 : advgetopt::GETOPT_FLAG_END,
6536 : nullptr,
6537 : nullptr,
6538 : nullptr,
6539 : nullptr
6540 : }
6541 : };
6542 :
6543 : advgetopt::options_environment options_mix_of_default;
6544 : options_mix_of_default.f_project_name = "unittest";
6545 : options_mix_of_default.f_options = options_mix_of_default_list;
6546 : options_mix_of_default.f_help_header = "Usage: try this one and we get a throw (mix flags of defaults by name)";
6547 : options_mix_of_default.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
6548 :
6549 : {
6550 : CATCH_REQUIRE_THROWS_AS(std::make_shared<advgetopt::getopt>(options_mix_of_default, argc, argv), advgetopt::getopt_logic_error);
6551 : }
6552 :
6553 : // try the - and -- without a default in the arguments
6554 : //
6555 : const advgetopt::option options_no_defaults_list[] =
6556 : {
6557 : {
6558 : '\0',
6559 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_FLAG,
6560 : "verbose",
6561 : nullptr,
6562 : "just a flag to test.",
6563 : 0
6564 : },
6565 : {
6566 : '\0',
6567 : advgetopt::GETOPT_FLAG_END,
6568 : nullptr,
6569 : nullptr,
6570 : nullptr,
6571 : nullptr
6572 : }
6573 : };
6574 :
6575 : advgetopt::options_environment options_no_defaults;
6576 : options_no_defaults.f_project_name = "unittest";
6577 : options_no_defaults.f_options = options_no_defaults_list;
6578 : options_no_defaults.f_help_header = "Usage: try this one and we get a throw (no defaults)";
6579 :
6580 : {
6581 : // a filename by itself is a problem when there is no default
6582 : //
6583 : char const * sub_cargv[] =
6584 : {
6585 : "tests/unittests/AdvGetOptUnitTests::invalid_parameters",
6586 : "--verbose",
6587 : "this",
6588 : "filename",
6589 : nullptr
6590 : };
6591 : const int sub_argc(sizeof(sub_cargv) / sizeof(sub_cargv[0]) - 1);
6592 : char ** sub_argv(const_cast<char **>(sub_cargv));
6593 :
6594 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: no default options defined; we do not know what to do of \"this\"; standalone parameters are not accepted by this program.");
6595 : advgetopt::getopt opt(options_no_defaults, sub_argc, sub_argv);
6596 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
6597 : }
6598 : {
6599 : // a '-' by itself is a problem when there is no default because it
6600 : // is expected to represent a filename (stdin)
6601 : //
6602 : char const * sub_cargv[] =
6603 : {
6604 : "tests/unittests/AdvGetOptUnitTests::invalid_parameters",
6605 : "--verbose",
6606 : "-",
6607 : nullptr
6608 : };
6609 : const int sub_argc(sizeof(sub_cargv) / sizeof(sub_cargv[0]) - 1);
6610 : char **sub_argv(const_cast<char **>(sub_cargv));
6611 :
6612 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: no default options defined; thus - is not accepted by this program.");
6613 : advgetopt::getopt opt(options_no_defaults, sub_argc, sub_argv);
6614 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
6615 : }
6616 : {
6617 : // the -- by itself would be fine, but since it represents a
6618 : // transition from arguments to only filenames (or whatever the
6619 : // program expects as default options) it generates an error if
6620 : // no default options are accepted
6621 : //
6622 : const char *sub_cargv[] =
6623 : {
6624 : "tests/unittests/AdvGetOptUnitTests::invalid_parameters",
6625 : "--verbose",
6626 : "--", // already just by itself it causes problems
6627 : nullptr
6628 : };
6629 : const int sub_argc = sizeof(sub_cargv) / sizeof(sub_cargv[0]) - 1;
6630 : char **sub_argv = const_cast<char **>(sub_cargv);
6631 :
6632 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: no default options defined; thus -- is not accepted by this program.");
6633 : advgetopt::getopt opt(options_no_defaults, sub_argc, sub_argv);
6634 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
6635 : }
6636 : {
6637 : const char *sub_cargv[] =
6638 : {
6639 : "tests/unittests/AdvGetOptUnitTests::invalid_parameters",
6640 : "--verbose",
6641 : "--",
6642 : "66",
6643 : "--filenames",
6644 : "extra",
6645 : "--file",
6646 : "names",
6647 : nullptr
6648 : };
6649 : const int sub_argc = sizeof(sub_cargv) / sizeof(sub_cargv[0]) - 1;
6650 : char **sub_argv = const_cast<char **>(sub_cargv);
6651 :
6652 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: no default options defined; thus -- is not accepted by this program.");
6653 : advgetopt::getopt opt(options_no_defaults, sub_argc, sub_argv);
6654 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
6655 : }
6656 : {
6657 : // check that -v, that does not exist, generates a usage error
6658 : const char *sub_cargv[] =
6659 : {
6660 : "tests/unittests/AdvGetOptUnitTests::invalid_parameters",
6661 : "-v",
6662 : nullptr
6663 : };
6664 : const int sub_argc = sizeof(sub_cargv) / sizeof(sub_cargv[0]) - 1;
6665 : char **sub_argv = const_cast<char **>(sub_cargv);
6666 :
6667 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option -v is not supported.");
6668 : advgetopt::getopt opt(options_no_defaults, sub_argc, sub_argv);
6669 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
6670 : }
6671 :
6672 : // check -- when default does not allowed environment variables
6673 : //
6674 : const advgetopt::option options_no_defaults_in_envvar_list[] =
6675 : {
6676 : {
6677 : '\0',
6678 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_ENVIRONMENT_VARIABLE | advgetopt::GETOPT_FLAG_FLAG,
6679 : "verbose",
6680 : nullptr,
6681 : "just a flag to test.",
6682 : nullptr
6683 : },
6684 : {
6685 : '\0',
6686 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_MULTIPLE,
6687 : "--",
6688 : nullptr,
6689 : "default multiple filenames",
6690 : nullptr
6691 : },
6692 : {
6693 : '\0',
6694 : advgetopt::GETOPT_FLAG_END,
6695 : nullptr,
6696 : nullptr,
6697 : nullptr,
6698 : nullptr
6699 : }
6700 : };
6701 :
6702 : advgetopt::options_environment options_no_defaults_in_envvar;
6703 : options_no_defaults_in_envvar.f_project_name = "unittest";
6704 : options_no_defaults_in_envvar.f_options = options_no_defaults_in_envvar_list;
6705 : options_no_defaults_in_envvar.f_help_header = "Usage: try this one and we get a throw (no defaults in envvar)";
6706 : options_no_defaults_in_envvar.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
6707 :
6708 : {
6709 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "--verbose - no default here");
6710 : char const * sub_cargv[] =
6711 : {
6712 : "tests/unittests/AdvGetOptUnitTests::invalid_parameters",
6713 : "--verbose",
6714 : "-",
6715 : "here",
6716 : "it",
6717 : "works",
6718 : nullptr
6719 : };
6720 : int const sub_argc = sizeof(sub_cargv) / sizeof(sub_cargv[0]) - 1;
6721 : char **sub_argv = const_cast<char **>(sub_cargv);
6722 :
6723 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option - is not supported in the environment variable.");
6724 : advgetopt::getopt opt(options_no_defaults_in_envvar, sub_argc, sub_argv);
6725 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
6726 : }
6727 : {
6728 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "--verbose no default here");
6729 : const char *sub_cargv[] =
6730 : {
6731 : "tests/unittests/AdvGetOptUnitTests::invalid_parameters",
6732 : "--verbose",
6733 : "-",
6734 : "here",
6735 : "it",
6736 : "works",
6737 : nullptr
6738 : };
6739 : const int sub_argc = sizeof(sub_cargv) / sizeof(sub_cargv[0]) - 1;
6740 : char **sub_argv = const_cast<char **>(sub_cargv);
6741 :
6742 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: default options are not supported in the environment variable.");
6743 : advgetopt::getopt opt(options_no_defaults_in_envvar, sub_argc, sub_argv);
6744 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
6745 : }
6746 : {
6747 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "--verbose -- foo bar blah");
6748 : const char *sub_cargv[] =
6749 : {
6750 : "tests/unittests/AdvGetOptUnitTests::invalid_parameters",
6751 : "--verbose",
6752 : "here",
6753 : "it",
6754 : "works",
6755 : "--",
6756 : "66",
6757 : "--filenames",
6758 : "extra",
6759 : "--file",
6760 : "names",
6761 : nullptr
6762 : };
6763 : const int sub_argc = sizeof(sub_cargv) / sizeof(sub_cargv[0]) - 1;
6764 : char **sub_argv = const_cast<char **>(sub_cargv);
6765 :
6766 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option -- is not supported in the environment variable.");
6767 : advgetopt::getopt opt(options_no_defaults_in_envvar, sub_argc, sub_argv);
6768 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
6769 : }
6770 :
6771 : // unnknown long options
6772 : //
6773 : const advgetopt::option valid_options_unknown_command_line_option_list[] =
6774 : {
6775 : {
6776 : '\0',
6777 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_MULTIPLE,
6778 : "command",
6779 : nullptr,
6780 : "there is a --command, but the user tries --verbose!",
6781 : nullptr
6782 : },
6783 : {
6784 : '\0',
6785 : advgetopt::GETOPT_FLAG_END,
6786 : nullptr,
6787 : nullptr,
6788 : nullptr,
6789 : nullptr
6790 : }
6791 : };
6792 :
6793 : advgetopt::options_environment valid_options_unknown_command_line_option;
6794 : valid_options_unknown_command_line_option.f_project_name = "unittest";
6795 : valid_options_unknown_command_line_option.f_options = valid_options_unknown_command_line_option_list;
6796 : valid_options_unknown_command_line_option.f_help_header = "Usage: try this one and we get a throw (unknown command line option)";
6797 :
6798 : {
6799 : const char *sub_cargv[] =
6800 : {
6801 : "tests/unittests/AdvGetOptUnitTests::invalid_parameters",
6802 : "--verbose",
6803 : nullptr
6804 : };
6805 : const int sub_argc = sizeof(sub_cargv) / sizeof(sub_cargv[0]) - 1;
6806 : char **sub_argv = const_cast<char **>(sub_cargv);
6807 :
6808 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option --verbose is not supported.");
6809 : advgetopt::getopt opt(valid_options_unknown_command_line_option, sub_argc, sub_argv);
6810 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
6811 : }
6812 :
6813 : // illegal short or long option in variable
6814 : //
6815 : const advgetopt::option options_illegal_in_variable_list[] =
6816 : {
6817 : {
6818 : 'v',
6819 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_FLAG,
6820 : "verbose",
6821 : nullptr,
6822 : "just a flag to test.",
6823 : nullptr
6824 : },
6825 : {
6826 : '\0',
6827 : advgetopt::GETOPT_FLAG_END,
6828 : nullptr,
6829 : nullptr,
6830 : nullptr,
6831 : nullptr
6832 : }
6833 : };
6834 :
6835 : advgetopt::options_environment options_illegal_in_variable;
6836 : options_illegal_in_variable.f_project_name = "unittest";
6837 : options_illegal_in_variable.f_options = options_illegal_in_variable_list;
6838 : options_illegal_in_variable.f_help_header = "Usage: try this one and we get a throw (illegal in variable)";
6839 : options_illegal_in_variable.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
6840 :
6841 : {
6842 : // long
6843 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "--verbose");
6844 :
6845 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option --verbose is not supported in the environment variable.");
6846 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option --ignore-parameters is not supported.");
6847 : advgetopt::getopt opt(options_illegal_in_variable, argc, argv);
6848 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
6849 : }
6850 : {
6851 : // short
6852 : snap::safe_setenv env("ADVGETOPT_TEST_OPTIONS", "-v");
6853 :
6854 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option -v is not supported in the environment variable.");
6855 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option --ignore-parameters is not supported.");
6856 : advgetopt::getopt opt(options_illegal_in_variable, argc, argv);
6857 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
6858 : }
6859 :
6860 : // configuration file options must have a long name
6861 : //
6862 : const advgetopt::option configuration_long_name_missing_list[] =
6863 : {
6864 : {
6865 : 'c',
6866 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_CONFIGURATION_FILE,
6867 : nullptr,
6868 : nullptr,
6869 : "a valid option",
6870 : nullptr
6871 : },
6872 : {
6873 : '\0',
6874 : advgetopt::GETOPT_FLAG_END,
6875 : nullptr,
6876 : nullptr,
6877 : nullptr,
6878 : nullptr
6879 : }
6880 : };
6881 :
6882 : advgetopt::options_environment configuration_long_name_missing;
6883 : configuration_long_name_missing.f_project_name = "unittest";
6884 : configuration_long_name_missing.f_options = configuration_long_name_missing_list;
6885 : configuration_long_name_missing.f_help_header = "Usage: try this one and we get a throw (long name missing)";
6886 : configuration_long_name_missing.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
6887 :
6888 : {
6889 : CATCH_REQUIRE_THROWS_AS(std::make_shared<advgetopt::getopt>(configuration_long_name_missing, argc, argv), advgetopt::getopt_logic_error);
6890 : }
6891 :
6892 : // create invalid configuration files
6893 : //
6894 : const advgetopt::option valid_options_list[] =
6895 : {
6896 : {
6897 : '\0',
6898 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_CONFIGURATION_FILE,
6899 : "valid",
6900 : nullptr,
6901 : "a valid option",
6902 : nullptr
6903 : },
6904 : {
6905 : '\0',
6906 : advgetopt::GETOPT_FLAG_COMMAND_LINE,
6907 : "command",
6908 : nullptr,
6909 : "a valid command, but not a valid configuration option",
6910 : nullptr
6911 : },
6912 : {
6913 : '\0',
6914 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_MULTIPLE | advgetopt::GETOPT_FLAG_DEFAULT_OPTION,
6915 : "filename",
6916 : nullptr,
6917 : "other parameters are viewed as filenames",
6918 : nullptr
6919 : },
6920 : {
6921 : '\0',
6922 : advgetopt::GETOPT_FLAG_END,
6923 : nullptr,
6924 : nullptr,
6925 : nullptr,
6926 : nullptr
6927 : }
6928 : };
6929 :
6930 : std::string tmpdir(SNAP_CATCH2_NAMESPACE::g_tmp_dir);
6931 : tmpdir += "/.config";
6932 : std::stringstream ss;
6933 : ss << "mkdir -p " << tmpdir;
6934 : if(system(ss.str().c_str()) != 0)
6935 : {
6936 : std::cerr << "fatal error: creating sub-temporary directory \"" << tmpdir << "\" failed.\n";
6937 : exit(1);
6938 : }
6939 :
6940 : std::string const config_filename(tmpdir + "/advgetopt.config");
6941 : char const * invalid_confs[] =
6942 : {
6943 : config_filename.c_str(),
6944 : nullptr
6945 : };
6946 :
6947 : advgetopt::options_environment valid_options;
6948 : valid_options.f_project_name = "unittest";
6949 : valid_options.f_options = valid_options_list;
6950 : valid_options.f_help_header = "Usage: try this one and we get a throw (valid options!)";
6951 : valid_options.f_configuration_files = invalid_confs;
6952 :
6953 : {
6954 : // '=' operator missing
6955 : {
6956 : std::ofstream config_file;
6957 : config_file.open(config_filename, std::ios_base::out | std::ios_base::binary | std::ios_base::trunc);
6958 : CATCH_REQUIRE(config_file.good());
6959 : config_file <<
6960 : "# Auto-generated\n"
6961 : "valid param\n"
6962 : "# no spaces acceptable in param names\n"
6963 : ;
6964 : }
6965 : {
6966 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option name from \"valid param\" on line 2 in configuration file \""
6967 : + config_filename
6968 : + "\" cannot include a space, missing assignment operator?");
6969 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option --ignore-parameters is not supported.");
6970 : advgetopt::getopt opt(valid_options, argc, argv);
6971 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
6972 : }
6973 : }
6974 : {
6975 : // same effect with a few extra spaces
6976 : {
6977 : std::ofstream config_file;
6978 : config_file.open(config_filename, std::ios_base::out | std::ios_base::binary | std::ios_base::trunc);
6979 : CATCH_REQUIRE(config_file.good());
6980 : config_file <<
6981 : "# Auto-generated\n"
6982 : " valid param \n"
6983 : "# no spaces acceptable in param names\n"
6984 : ;
6985 : }
6986 : {
6987 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option name from \" valid param \" on line 2 in configuration file \""
6988 : + config_filename
6989 : + "\" cannot include a space, missing assignment operator?");
6990 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option --ignore-parameters is not supported.");
6991 : advgetopt::getopt opt(valid_options, argc, argv);
6992 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
6993 : }
6994 : }
6995 : {
6996 : // param name missing
6997 : {
6998 : std::ofstream config_file;
6999 : config_file.open(config_filename, std::ios_base::out | std::ios_base::binary | std::ios_base::trunc);
7000 : CATCH_REQUIRE(config_file.good());
7001 : config_file <<
7002 : "# Auto-generated\n"
7003 : " = valid param\n"
7004 : "# no spaces acceptable in param names\n"
7005 : ;
7006 : }
7007 : {
7008 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: no option name in \" = valid param\" on line 2 from configuration file \""
7009 : + config_filename
7010 : + "\", missing name before = sign?");
7011 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option --ignore-parameters is not supported.");
7012 : advgetopt::getopt opt(valid_options, argc, argv);
7013 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
7014 : }
7015 : }
7016 : {
7017 : // param name starts with a dash or more
7018 : {
7019 : std::ofstream config_file;
7020 : config_file.open(config_filename, std::ios_base::out | std::ios_base::binary | std::ios_base::trunc);
7021 : CATCH_REQUIRE(config_file.good());
7022 : config_file <<
7023 : "# Auto-generated\n"
7024 : "--valid=param\n"
7025 : "# no spaces acceptable in param names\n"
7026 : ;
7027 : }
7028 : {
7029 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option names in configuration files cannot start with a dash or an underscore in \"--valid=param\" on line 2 from configuration file \""
7030 : + config_filename
7031 : + "\".");
7032 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option --ignore-parameters is not supported.");
7033 : advgetopt::getopt opt(valid_options, argc, argv);
7034 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
7035 : }
7036 : }
7037 : {
7038 : // unknown param name
7039 : {
7040 : std::ofstream config_file;
7041 : config_file.open(config_filename, std::ios_base::out | std::ios_base::binary | std::ios_base::trunc);
7042 : CATCH_REQUIRE(config_file.good());
7043 : config_file <<
7044 : "# Auto-generated\n"
7045 : "invalid=param\n"
7046 : "# no spaces acceptable in param names\n"
7047 : ;
7048 : }
7049 : {
7050 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: unknown option \"invalid\" found in configuration file \""
7051 : + config_filename
7052 : + "\".");
7053 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option --ignore-parameters is not supported.");
7054 : advgetopt::getopt opt(valid_options, argc, argv);
7055 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
7056 : }
7057 : }
7058 : {
7059 : // known command, not valid in configuration file
7060 : {
7061 : std::ofstream config_file;
7062 : config_file.open(config_filename, std::ios_base::out | std::ios_base::binary | std::ios_base::trunc);
7063 : CATCH_REQUIRE(config_file.good());
7064 : config_file <<
7065 : "# Auto-generated\n"
7066 : "command=value\n"
7067 : "# no spaces acceptable in param names\n"
7068 : ;
7069 : }
7070 : {
7071 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option \"command\" is not supported in configuration files (found in \""
7072 : + config_filename
7073 : + "\").");
7074 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option --ignore-parameters is not supported.");
7075 : advgetopt::getopt opt(valid_options, argc, argv);
7076 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
7077 : }
7078 : }
7079 :
7080 : #if 0
7081 : // in version 2.x we do not have this case anymore
7082 :
7083 : // one of the options has an invalid mode; explicit option
7084 : {
7085 : const advgetopt::option options_list[] =
7086 : {
7087 : {
7088 : '\0',
7089 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_SHOW_USAGE_ON_ERROR,
7090 : "mode",
7091 : nullptr,
7092 : "an argument with an invalid mode to see that we get an exception",
7093 : static_cast<advgetopt::getopt::argument_mode_t>(static_cast<int>(advgetopt::getopt::argument_mode_t::end_of_options) + 1)
7094 : },
7095 : {
7096 : '\0',
7097 : advgetopt::GETOPT_FLAG_END,
7098 : nullptr,
7099 : nullptr,
7100 : nullptr,
7101 : nullptr
7102 : }
7103 : };
7104 :
7105 : advgetopt::options_environment options;
7106 : options.f_project_name = "unittest";
7107 : options.f_options = options_list;
7108 : options.f_help_header = "Usage: one of the options has an invalid mode";
7109 :
7110 : {
7111 : const char *cargv2[] =
7112 : {
7113 : "tests/unittests/unittest_advgetopt",
7114 : "--mode",
7115 : "test",
7116 : nullptr
7117 : };
7118 : const int argc2 = sizeof(cargv2) / sizeof(cargv2[0]) - 1;
7119 : char **argv2 = const_cast<char **>(cargv2);
7120 :
7121 : // here we hit the one in add_options() (plural)
7122 : // the one in add_option() is not reachable because it is called only
7123 : // when a default option is defined and that means the mode is
7124 : // correct
7125 : CATCH_REQUIRE_THROWS_AS( { advgetopt::getopt opt(argc2, argv2, options, confs, nullptr); }, advgetopt::getopt_invalid );
7126 : }
7127 : {
7128 : const char *cargv2[] =
7129 : {
7130 : "tests/unittests/unittest_advgetopt",
7131 : nullptr
7132 : };
7133 : const int argc2 = sizeof(cargv2) / sizeof(cargv2[0]) - 1;
7134 : char **argv2 = const_cast<char **>(cargv2);
7135 :
7136 : // this one checks that the --mode flag does indeed generate a
7137 : // throw when not used on the command line but then gets shown
7138 : // in the usage() function
7139 : advgetopt::getopt opt(argc2, argv2, options, confs, nullptr);
7140 : for(int i(static_cast<int>(advgetopt::getopt::status_t::no_error)); i <= static_cast<int>(advgetopt::getopt::status_t::fatal); ++i)
7141 : {
7142 : CATCH_REQUIRE_THROWS_AS( opt.usage(static_cast<advgetopt::getopt::status_t>(i), "test no error, warnings, errors..."), advgetopt::getopt_invalid);
7143 : }
7144 : }
7145 : }
7146 : #endif
7147 :
7148 : // a valid initialization, but not so valid calls afterward
7149 : {
7150 : advgetopt::option const options_list[] =
7151 : {
7152 : {
7153 : '\0',
7154 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_FLAG,
7155 : "validate",
7156 : nullptr,
7157 : "this is used to validate different things.",
7158 : nullptr
7159 : },
7160 : {
7161 : '\0',
7162 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_REQUIRED,
7163 : "long",
7164 : nullptr,
7165 : "used to validate that invalid numbers generate an error.",
7166 : nullptr
7167 : },
7168 : {
7169 : 'o',
7170 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_REQUIRED,
7171 : "out-of-bounds",
7172 : nullptr,
7173 : "valid values from 1 to 9.",
7174 : nullptr
7175 : },
7176 : {
7177 : '\0',
7178 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_REQUIRED,
7179 : "not-specified-and-no-default",
7180 : nullptr,
7181 : "test long without having used the option and no default.",
7182 : nullptr
7183 : },
7184 : {
7185 : '\0',
7186 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_REQUIRED,
7187 : "not-specified-with-invalid-default",
7188 : "123abc",
7189 : "test long with an invalid default value.",
7190 : nullptr
7191 : },
7192 : {
7193 : '\0',
7194 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_REQUIRED,
7195 : "not-specified-string-without-default",
7196 : nullptr,
7197 : "test long with an invalid default value.",
7198 : nullptr
7199 : },
7200 : {
7201 : '\0',
7202 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_REQUIRED,
7203 : "string",
7204 : nullptr,
7205 : "test long with an invalid default value.",
7206 : nullptr
7207 : },
7208 : {
7209 : '\0',
7210 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_MULTIPLE | advgetopt::GETOPT_FLAG_DEFAULT_OPTION,
7211 : "filename",
7212 : nullptr,
7213 : "other parameters are viewed as filenames",
7214 : nullptr
7215 : },
7216 : {
7217 : '\0',
7218 : advgetopt::GETOPT_FLAG_END,
7219 : nullptr,
7220 : nullptr,
7221 : nullptr,
7222 : nullptr
7223 : }
7224 : };
7225 : char const * cargv2[] =
7226 : {
7227 : "tests/unittests/unittest_advgetopt",
7228 : "--validate",
7229 : "--long",
7230 : "123abc",
7231 : "--out-of-bounds",
7232 : "123",
7233 : "--string",
7234 : "string value",
7235 : nullptr
7236 : };
7237 : int const argc2 = sizeof(cargv2) / sizeof(cargv2[0]) - 1;
7238 : char ** argv2 = const_cast<char **>(cargv2);
7239 :
7240 : advgetopt::options_environment options;
7241 : options.f_project_name = "unittest";
7242 : options.f_options = options_list;
7243 : options.f_help_header = "Usage: one of the options has an invalid mode";
7244 : options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
7245 :
7246 : advgetopt::getopt opt(options, argc2, argv2);
7247 :
7248 : // cannot get the default without a valid name!
7249 : CATCH_REQUIRE_THROWS_AS( opt.get_default(""), advgetopt::getopt_logic_error);
7250 :
7251 : // cannot get a long named "blah"
7252 : CATCH_REQUIRE_THROWS_AS( opt.get_long("blah"), advgetopt::getopt_logic_error);
7253 : // existing "long", but only 1 entry
7254 : CATCH_REQUIRE_THROWS_AS( opt.get_long("long", 100), advgetopt::getopt_undefined);
7255 : long l(-1);
7256 : CATCH_REQUIRE_THROWS_AS( l = opt.get_long("not-specified-and-no-default", 0), advgetopt::getopt_logic_error);
7257 : CATCH_REQUIRE(l == -1);
7258 : CATCH_REQUIRE_THROWS_AS( l = opt.get_long("not-specified-with-invalid-default", 0), advgetopt::getopt_logic_error);
7259 : CATCH_REQUIRE(l == -1);
7260 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: invalid number (123abc) in parameter --long.");
7261 : l = opt.get_long("long");
7262 : CATCH_REQUIRE(l == -1);
7263 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: 123 is out of bounds (1..9 inclusive) in parameter --out-of-bounds.");
7264 : l = opt.get_long("out-of-bounds", 0, 1, 9);
7265 : CATCH_REQUIRE(l == -1);
7266 : std::string s;
7267 : CATCH_REQUIRE_THROWS_AS( s = opt.get_string("not-specified-string-without-default", 0), advgetopt::getopt_logic_error);
7268 : CATCH_REQUIRE(s.empty());
7269 : CATCH_REQUIRE_THROWS_AS( s = opt.get_string("string", 100), advgetopt::getopt_undefined);
7270 : CATCH_REQUIRE(s.empty());
7271 :
7272 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
7273 :
7274 : // reuse all those invalid options with the reset() function
7275 : // and expect the same result
7276 : // (the constructor is expected to call reset() the exact same way)
7277 : // -- this changed in version 2.x; we can't reset the option definitions
7278 : //
7279 : //CATCH_REQUIRE_THROWS_AS( opt.reset(argc, argv, options_empty_list, confs, nullptr), advgetopt::getopt_invalid);
7280 : //CATCH_REQUIRE_THROWS_AS( opt.reset(argc, argv, options_no_name_list, confs, nullptr), advgetopt::getopt_invalid);
7281 : //CATCH_REQUIRE_THROWS_AS( opt.reset(argc, argv, options_2chars_minimum, confs, nullptr), advgetopt::getopt_invalid);
7282 : //CATCH_REQUIRE_THROWS_AS( opt.reset(argc, argv, options_2chars_minimum2, confs, nullptr), advgetopt::getopt_invalid);
7283 : //CATCH_REQUIRE_THROWS_AS( opt.reset(argc, argv, options_defined_twice, confs, "ADVGETOPT_TEST_OPTIONS"), advgetopt::getopt_invalid);
7284 : //CATCH_REQUIRE_THROWS_AS( opt.reset(argc, argv, options_short_defined_twice, confs, nullptr), advgetopt::getopt_invalid);
7285 : //CATCH_REQUIRE_THROWS_AS( opt.reset(argc, argv, options_two_default_multiple_arguments, confs, nullptr), advgetopt::getopt_invalid_default);
7286 : //CATCH_REQUIRE_THROWS_AS( opt.reset(argc, argv, options_two_default_arguments, confs, "ADVGETOPT_TEST_OPTIONS"), advgetopt::getopt_invalid_default);
7287 : //CATCH_REQUIRE_THROWS_AS( opt.reset(argc, argv, options_mix_of_default, confs, nullptr), advgetopt::getopt_invalid_default);
7288 : }
7289 :
7290 : // valid initialization + usage calls
7291 : {
7292 : const advgetopt::option options_list[] =
7293 : {
7294 : {
7295 : '\0',
7296 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_FLAG,
7297 : "validate",
7298 : nullptr,
7299 : "this is used to validate different things.",
7300 : nullptr
7301 : },
7302 : {
7303 : '\0',
7304 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_REQUIRED,
7305 : "long",
7306 : nullptr,
7307 : "used to validate that invalid numbers generate an error.",
7308 : nullptr
7309 : },
7310 : {
7311 : 'o',
7312 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_REQUIRED,
7313 : "out-of-bounds",
7314 : nullptr,
7315 : "valid values from 1 to 9.",
7316 : nullptr
7317 : },
7318 : {
7319 : '\0',
7320 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_REQUIRED,
7321 : "not-specified-and-no-default",
7322 : nullptr,
7323 : "test long without having used the option and no default.",
7324 : nullptr
7325 : },
7326 : {
7327 : '\0',
7328 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_REQUIRED | advgetopt::GETOPT_FLAG_MULTIPLE,
7329 : "not-specified-with-invalid-default",
7330 : "123abc",
7331 : "test long with an invalid default value.",
7332 : nullptr
7333 : },
7334 : {
7335 : '\0',
7336 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_REQUIRED,
7337 : "not-specified-string-without-default",
7338 : nullptr,
7339 : "test long with an invalid default value.",
7340 : nullptr
7341 : },
7342 : {
7343 : '\0',
7344 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_REQUIRED,
7345 : "string",
7346 : nullptr,
7347 : "test long with an invalid default value.",
7348 : nullptr
7349 : },
7350 : {
7351 : 'u',
7352 : advgetopt::GETOPT_FLAG_COMMAND_LINE,
7353 : "unique",
7354 : nullptr,
7355 : "test long with an invalid default value.",
7356 : nullptr
7357 : },
7358 : {
7359 : 'q',
7360 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_MULTIPLE,
7361 : "quiet",
7362 : nullptr,
7363 : "test long with an invalid default value.",
7364 : nullptr
7365 : },
7366 : {
7367 : '\0',
7368 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_MULTIPLE | advgetopt::GETOPT_FLAG_DEFAULT_OPTION,
7369 : "filename",
7370 : nullptr,
7371 : "other parameters are viewed as filenames.",
7372 : nullptr
7373 : },
7374 : {
7375 : '\0',
7376 : advgetopt::GETOPT_FLAG_END,
7377 : nullptr,
7378 : nullptr,
7379 : nullptr,
7380 : nullptr
7381 : }
7382 : };
7383 : char const * cargv2[] =
7384 : {
7385 : "tests/unittests/unittest_advgetopt",
7386 : "--validate",
7387 : "--long",
7388 : "123abc",
7389 : "--out-of-bounds",
7390 : "123",
7391 : "--string",
7392 : "string value",
7393 : nullptr
7394 : };
7395 : int const argc2 = sizeof(cargv2) / sizeof(cargv2[0]) - 1;
7396 : char ** argv2 = const_cast<char **>(cargv2);
7397 :
7398 : advgetopt::options_environment options;
7399 : options.f_project_name = "unittest";
7400 : options.f_options = options_list;
7401 : options.f_help_header = "Usage: try this one and we get a throw (valid options + usage calls)";
7402 : options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
7403 :
7404 : // this initialization works as expected
7405 : advgetopt::getopt opt(options, argc2, argv2);
7406 :
7407 : // all of the following have the exiting exception
7408 : CATCH_REQUIRE(opt.usage(advgetopt::GETOPT_FLAG_SHOW_ALL) ==
7409 : "Usage: try this one and we get a throw (valid options + usage calls)\n"
7410 : " --long <arg> used to validate that invalid numbers generate an\n"
7411 : " error.\n"
7412 : " --not-specified-and-no-default <arg>\n"
7413 : " test long without having used the option and no\n"
7414 : " default.\n"
7415 : " --not-specified-string-without-default <arg>\n"
7416 : " test long with an invalid default value.\n"
7417 : " --not-specified-with-invalid-default <arg> {<arg>} (default is \"123abc\")\n"
7418 : " test long with an invalid default value.\n"
7419 : " --out-of-bounds or -o <arg>\n"
7420 : " valid values from 1 to 9.\n"
7421 : " --quiet or -q {<arg>} test long with an invalid default value.\n"
7422 : " --string <arg> test long with an invalid default value.\n"
7423 : " --unique or -u [<arg>] test long with an invalid default value.\n"
7424 : " --validate this is used to validate different things.\n"
7425 : " [default arguments] other parameters are viewed as filenames.\n"
7426 : );
7427 : }
7428 :
7429 : // valid initialization + usage calls with a few different options
7430 : {
7431 : const advgetopt::option options_list[] =
7432 : {
7433 : {
7434 : '\0',
7435 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_FLAG,
7436 : "validate",
7437 : nullptr,
7438 : "this is used to validate different things.",
7439 : nullptr
7440 : },
7441 : {
7442 : '\0',
7443 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_REQUIRED,
7444 : "long",
7445 : nullptr,
7446 : "used to validate that invalid numbers generate an error.",
7447 : nullptr
7448 : },
7449 : {
7450 : 'o',
7451 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_REQUIRED,
7452 : "out-of-bounds",
7453 : nullptr,
7454 : "valid values from 1 to 9.",
7455 : nullptr
7456 : },
7457 : {
7458 : '\0',
7459 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_REQUIRED,
7460 : "not-specified-and-no-default",
7461 : nullptr,
7462 : "test long without having used the option and no default.",
7463 : nullptr
7464 : },
7465 : {
7466 : '\0',
7467 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_REQUIRED | advgetopt::GETOPT_FLAG_MULTIPLE,
7468 : "not-specified-with-invalid-default",
7469 : "123abc",
7470 : "test long with an invalid default value.",
7471 : nullptr
7472 : },
7473 : {
7474 : '\0',
7475 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_REQUIRED,
7476 : "not-specified-string-without-default",
7477 : nullptr,
7478 : "test long with an invalid default value.",
7479 : nullptr
7480 : },
7481 : {
7482 : '\0',
7483 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_REQUIRED,
7484 : "string",
7485 : nullptr,
7486 : "test long with an invalid default value.",
7487 : nullptr
7488 : },
7489 : {
7490 : 'u',
7491 : advgetopt::GETOPT_FLAG_COMMAND_LINE,
7492 : "unique",
7493 : nullptr,
7494 : "test long with an invalid default value.",
7495 : nullptr
7496 : },
7497 : {
7498 : 'q',
7499 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_MULTIPLE,
7500 : "quiet",
7501 : nullptr,
7502 : "test long with an invalid default value.",
7503 : nullptr
7504 : },
7505 : {
7506 : 'l',
7507 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_REQUIRED,
7508 : "not-in-v2-though",
7509 : nullptr,
7510 : "long with just a letter.",
7511 : nullptr
7512 : },
7513 : {
7514 : '\0',
7515 : advgetopt::GETOPT_FLAG_COMMAND_LINE,
7516 : "--",
7517 : nullptr,
7518 : "other parameters are viewed as filenames; and we need at least one option with a very long help to check that it wraps perfectly (we'd really need to get the output of the command and check that against what is expected because at this time the test is rather blind in that respect! FIXED IN v2!)",
7519 : nullptr
7520 : },
7521 : {
7522 : '\0',
7523 : advgetopt::GETOPT_FLAG_END,
7524 : nullptr,
7525 : nullptr,
7526 : nullptr,
7527 : nullptr
7528 : }
7529 : };
7530 :
7531 : advgetopt::options_environment options;
7532 : options.f_project_name = "unittest";
7533 : options.f_options = options_list;
7534 : options.f_help_header = "Usage: try this one and we get a throw (valid options + usage calls bis)";
7535 : options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
7536 :
7537 : {
7538 : // make sure that --long (REQUIRED) fails if the
7539 : // long value is not specified
7540 : //
7541 : char const * cargv2[] =
7542 : {
7543 : "tests/unittests/unittest_advgetopt",
7544 : "--validate",
7545 : "--long",
7546 : "--out-of-bounds",
7547 : "123",
7548 : "--string",
7549 : "string value",
7550 : nullptr
7551 : };
7552 : int const argc2 = sizeof(cargv2) / sizeof(cargv2[0]) - 1;
7553 : char ** argv2 = const_cast<char **>(cargv2);
7554 :
7555 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option --long expects an argument.");
7556 : advgetopt::getopt opt(options, argc2, argv2);
7557 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
7558 : }
7559 : {
7560 : // again with the lone -l (no long name)
7561 : //
7562 : char const * cargv2[] =
7563 : {
7564 : "tests/unittests/unittest_advgetopt",
7565 : "--validate",
7566 : "-l",
7567 : "--out-of-bounds",
7568 : "123",
7569 : "--string",
7570 : "string value",
7571 : nullptr
7572 : };
7573 : int const argc2 = sizeof(cargv2) / sizeof(cargv2[0]) - 1;
7574 : char ** argv2 = const_cast<char **>(cargv2);
7575 :
7576 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option --not-in-v2-though expects an argument.");
7577 : advgetopt::getopt opt(options, argc2, argv2);
7578 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
7579 : }
7580 : {
7581 : char const * cargv2[] =
7582 : {
7583 : "tests/unittests/unittest_advgetopt",
7584 : "--validate",
7585 : "--long",
7586 : "123abc",
7587 : "--out-of-bounds",
7588 : "123",
7589 : "--string",
7590 : "string value",
7591 : nullptr
7592 : };
7593 : int const argc2 = sizeof(cargv2) / sizeof(cargv2[0]) - 1;
7594 : char ** argv2 = const_cast<char **>(cargv2);
7595 :
7596 : // this initialization works as expected
7597 : advgetopt::getopt opt(options, argc2, argv2);
7598 :
7599 : // all of the following have the exiting exception
7600 : // for(int i(static_cast<int>(advgetopt::getopt::status_t::no_error)); i <= static_cast<int>(advgetopt::getopt::status_t::fatal); ++i)
7601 : // {
7602 : // CATCH_REQUIRE_THROWS_AS( opt.usage(static_cast<advgetopt::getopt::status_t>(i), "test no error, warnings, errors..."), advgetopt::getopt_exit);
7603 : // }
7604 : CATCH_REQUIRE(opt.usage(advgetopt::GETOPT_FLAG_SHOW_ALL) ==
7605 : "Usage: try this one and we get a throw (valid options + usage calls bis)\n"
7606 : " --long <arg> used to validate that invalid numbers generate an\n"
7607 : " error.\n"
7608 : " --not-in-v2-though or -l <arg>\n"
7609 : " long with just a letter.\n"
7610 : " --not-specified-and-no-default <arg>\n"
7611 : " test long without having used the option and no\n"
7612 : " default.\n"
7613 : " --not-specified-string-without-default <arg>\n"
7614 : " test long with an invalid default value.\n"
7615 : " --not-specified-with-invalid-default <arg> {<arg>} (default is \"123abc\")\n"
7616 : " test long with an invalid default value.\n"
7617 : " --out-of-bounds or -o <arg>\n"
7618 : " valid values from 1 to 9.\n"
7619 : " --quiet or -q {<arg>} test long with an invalid default value.\n"
7620 : " --string <arg> test long with an invalid default value.\n"
7621 : " --unique or -u [<arg>] test long with an invalid default value.\n"
7622 : " --validate this is used to validate different things.\n"
7623 : " [default argument] other parameters are viewed as filenames; and we\n"
7624 : " need at least one option with a very long help to\n"
7625 : " check that it wraps perfectly (we'd really need to\n"
7626 : " get the output of the command and check that\n"
7627 : " against what is expected because at this time the\n"
7628 : " test is rather blind in that respect! FIXED IN\n"
7629 : " v2!)\n"
7630 : );
7631 : }
7632 : }
7633 :
7634 : // strange entry without a name
7635 : {
7636 : advgetopt::option const options_list[] =
7637 : {
7638 : {
7639 : '\0',
7640 : advgetopt::GETOPT_FLAG_SHOW_USAGE_ON_ERROR | advgetopt::GETOPT_FLAG_FLAG,
7641 : nullptr,
7642 : nullptr,
7643 : "this entry has help, but no valid name...",
7644 : nullptr
7645 : },
7646 : {
7647 : 'v',
7648 : advgetopt::GETOPT_FLAG_FLAG,
7649 : "verbose",
7650 : nullptr,
7651 : "show more stuff when found on the command line.",
7652 : nullptr
7653 : },
7654 : {
7655 : '\0',
7656 : advgetopt::GETOPT_FLAG_END,
7657 : nullptr,
7658 : nullptr,
7659 : nullptr,
7660 : nullptr
7661 : }
7662 : };
7663 :
7664 : advgetopt::options_environment options;
7665 : options.f_project_name = "unittest";
7666 : options.f_options = options_list;
7667 : options.f_help_header = "Usage: try this one and we get a throw (strange empty entry!)";
7668 : options.f_environment_variable_name = "ADVGETOPT_TEST_OPTIONS";
7669 :
7670 : {
7671 : char const * cargv2[] =
7672 : {
7673 : "tests/unittests/unittest_advgetopt/AdvGetOptUnitTests::invalid_parameters/test-with-an-empty-entry",
7674 : nullptr
7675 : };
7676 : int const argc2 = sizeof(cargv2) / sizeof(cargv2[0]) - 1;
7677 : char ** argv2 = const_cast<char **>(cargv2);
7678 :
7679 : // this initialization works as expected
7680 : //
7681 : CATCH_REQUIRE_THROWS_AS(std::make_shared<advgetopt::getopt>(options, argc2, argv2), advgetopt::getopt_logic_error );
7682 :
7683 : // // all of the following have the exiting exception
7684 : // for(int i(static_cast<int>(advgetopt::getopt::status_t::no_error)); i <= static_cast<int>(advgetopt::getopt::status_t::fatal); ++i)
7685 : // {
7686 : // CATCH_REQUIRE_THROWS_AS( opt.usage(static_cast<advgetopt::getopt::status_t>(i), "test no error, warnings, errors..."), advgetopt::getopt_invalid);
7687 : // }
7688 : //std::cout << "test usage output here? " << opt.usage(advgetopt::GETOPT_FLAG_SHOW_ALL) << "\n";
7689 : }
7690 : }
7691 :
7692 : // required multiple without arguments
7693 : {
7694 : advgetopt::option const options_list[] =
7695 : {
7696 : {
7697 : 'f',
7698 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_REQUIRED | advgetopt::GETOPT_FLAG_MULTIPLE | advgetopt::GETOPT_FLAG_DEFAULT_OPTION,
7699 : "filenames",
7700 : nullptr,
7701 : "test a required multiple without any arguments and fail.",
7702 : nullptr
7703 : },
7704 : {
7705 : '\0',
7706 : advgetopt::GETOPT_FLAG_END,
7707 : nullptr,
7708 : nullptr,
7709 : nullptr,
7710 : nullptr
7711 : }
7712 : };
7713 :
7714 : advgetopt::options_environment options;
7715 : options.f_project_name = "unittest";
7716 : options.f_options = options_list;
7717 : options.f_help_header = "Usage: try this one and we get a throw (required multiple without args)";
7718 :
7719 : {
7720 : // first with -f
7721 : char const * cargv2[] =
7722 : {
7723 : "tests/unittests/unittest_advgetopt/AdvGetOptUnitTests::invalid_parameters/test-with-an-empty-entry",
7724 : "-f",
7725 : nullptr
7726 : };
7727 : int const argc2 = sizeof(cargv2) / sizeof(cargv2[0]) - 1;
7728 : char ** argv2 = const_cast<char **>(cargv2);
7729 :
7730 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option --filenames expects an argument.");
7731 : advgetopt::getopt opt(options, argc2, argv2);
7732 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
7733 : }
7734 : {
7735 : // second with --filenames
7736 : const char *cargv2[] =
7737 : {
7738 : "tests/unittests/unittest_advgetopt/AdvGetOptUnitTests::invalid_parameters/test-with-an-empty-entry",
7739 : "--filenames",
7740 : nullptr
7741 : };
7742 : int const argc2 = sizeof(cargv2) / sizeof(cargv2[0]) - 1;
7743 : char ** argv2 = const_cast<char **>(cargv2);
7744 :
7745 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option --filenames expects an argument.");
7746 : advgetopt::getopt opt(options, argc2, argv2);
7747 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
7748 : }
7749 : }
7750 :
7751 : // required multiple without arguments, short name only
7752 : {
7753 : advgetopt::option const options_list[] =
7754 : {
7755 : {
7756 : 'f',
7757 : advgetopt::GETOPT_FLAG_COMMAND_LINE | advgetopt::GETOPT_FLAG_REQUIRED | advgetopt::GETOPT_FLAG_MULTIPLE,
7758 : "filenames",
7759 : nullptr,
7760 : "test a required multiple without any arguments and fail.",
7761 : nullptr
7762 : },
7763 : {
7764 : '\0',
7765 : advgetopt::GETOPT_FLAG_END,
7766 : nullptr,
7767 : nullptr,
7768 : nullptr,
7769 : nullptr
7770 : }
7771 : };
7772 :
7773 : advgetopt::options_environment options;
7774 : options.f_project_name = "unittest";
7775 : options.f_options = options_list;
7776 : options.f_help_header = "Usage: try this one and we get a throw (required multiple without args + short name)";
7777 :
7778 : {
7779 : // -f only in this case
7780 : char const * cargv2[] =
7781 : {
7782 : "tests/unittests/unittest_advgetopt/AdvGetOptUnitTests::invalid_parameters/test-with-an-empty-entry",
7783 : "-f",
7784 : nullptr
7785 : };
7786 : int const argc2 = sizeof(cargv2) / sizeof(cargv2[0]) - 1;
7787 : char ** argv2 = const_cast<char **>(cargv2);
7788 :
7789 : SNAP_CATCH2_NAMESPACE::push_expected_log("error: option --filenames expects an argument.");
7790 : advgetopt::getopt opt(options, argc2, argv2);
7791 : SNAP_CATCH2_NAMESPACE::expected_logs_stack_is_empty();
7792 : }
7793 : }
7794 : CATCH_END_SECTION()
7795 : }
7796 : #endif
7797 :
7798 :
7799 : // vim: ts=4 sw=4 et
|
