X-Git-Url: http://git.efficios.com/?p=argpar.git;a=blobdiff_plain;f=tests%2Ftest_argpar.c;h=87646a9a0a9d99fcc28a6ededbc035eee4eddeae;hp=458c69e5bd2d9c00cee5ff5d2ae981ff7003b7db;hb=10aefab2119c89f4afa4f46a619eae20d6be7512;hpb=1c9a6bde7e12e1978e8e47764913a91b7407e9b5 diff --git a/tests/test_argpar.c b/tests/test_argpar.c index 458c69e..87646a9 100644 --- a/tests/test_argpar.c +++ b/tests/test_argpar.c @@ -1,5 +1,6 @@ /* - * Copyright (c) 2019 Philippe Proulx + * Copyright (c) 2019-2021 Philippe Proulx + * Copyright (c) 2020-2021 Simon Marchi * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -17,120 +18,157 @@ #include #include +#include #include +#include #include #include "tap/tap.h" #include "argpar/argpar.h" /* - * Tests that the command line `cmdline`, with non-quoted - * space-delimited arguments, once parsed given the option descriptors - * `descrs` and the option `fail_on_unknown_opt`, succeeds and gives the - * expected command line `expected_cmd_line` and number of ingested - * original arguments `expected_ingested_orig_args`. + * Formats `item` and appends the resulting string to `res_str` to + * incrementally build an expected command line string. * - * The resulting command-line is built from the resulting arguments, - * space-delimiting each argument, preferring the `--long-opt=arg` style - * over the `-s arg` style, and using the `arg` form for non-option - * arguments where `A` is the original argument index and `B` is the - * non-option argument index. + * This function: + * + * * Prefers the `--long-opt=arg` style over the `-s arg` style. + * + * * Uses the `arg` form for non-option arguments, where `A` is the + * original argument index and `B` is the non-option argument index. */ static -void test_succeed(const char *cmdline, - const char *expected_cmd_line, - const struct argpar_opt_descr *descrs, - unsigned int expected_ingested_orig_args) +void append_to_res_str(GString * const res_str, + const struct argpar_item * const item) { - struct argpar_parse_ret parse_ret; - GString *res_str = g_string_new(NULL); - gchar **argv = g_strsplit(cmdline, " ", 0); - unsigned int i; - - assert(argv); - assert(res_str); - parse_ret = argpar_parse(g_strv_length(argv), - (const char * const *) argv, descrs, false); - ok(parse_ret.items, - "argpar_parse() succeeds for command line `%s`", cmdline); - ok(!parse_ret.error, - "argpar_parse() does not write an error for command line `%s`", cmdline); - ok(parse_ret.ingested_orig_args == expected_ingested_orig_args, - "argpar_parse() returns the correct number of ingested " - "original arguments for command line `%s`", cmdline); - if (parse_ret.ingested_orig_args != expected_ingested_orig_args) { - diag("Expected: %u Got: %u", expected_ingested_orig_args, - parse_ret.ingested_orig_args); - } - - if (!parse_ret.items) { - fail("argpar_parse() returns the expected parsed arguments " - "for command line `%s`", cmdline); - goto end; + if (res_str->len > 0) { + g_string_append_c(res_str, ' '); } - for (i = 0; i < parse_ret.items->n_items; i++) { - const struct argpar_item *arg = parse_ret.items->items[i]; + switch (argpar_item_type(item)) { + case ARGPAR_ITEM_TYPE_OPT: + { + const struct argpar_opt_descr * const descr = + argpar_item_opt_descr(item); + const char * const arg = argpar_item_opt_arg(item); - switch (arg->type) { - case ARGPAR_ITEM_TYPE_OPT: - { - const struct argpar_item_opt *arg_opt = - (const void *) arg; + if (descr->long_name) { + g_string_append_printf(res_str, "--%s", + descr->long_name); - if (arg_opt->descr->long_name) { - g_string_append_printf(res_str, "--%s", - arg_opt->descr->long_name); + if (arg) { + g_string_append_printf(res_str, "=%s", arg); + } + } else if (descr->short_name) { + g_string_append_printf(res_str, "-%c", + descr->short_name); - if (arg_opt->arg) { - g_string_append_printf(res_str, "=%s", - arg_opt->arg); - } + if (arg) { + g_string_append_printf(res_str, " %s", arg); + } + } - g_string_append_c(res_str, ' '); - } else if (arg_opt->descr->short_name) { - g_string_append_printf(res_str, "-%c", - arg_opt->descr->short_name); + break; + } + case ARGPAR_ITEM_TYPE_NON_OPT: + { + const char * const arg = argpar_item_non_opt_arg(item); + const unsigned int orig_index = + argpar_item_non_opt_orig_index(item); + const unsigned int non_opt_index = + argpar_item_non_opt_non_opt_index(item); - if (arg_opt->arg) { - g_string_append_printf(res_str, " %s", - arg_opt->arg); - } + g_string_append_printf(res_str, "%s<%u,%u>", arg, orig_index, + non_opt_index); + break; + } + default: + abort(); + } +} - g_string_append_c(res_str, ' '); - } +/* + * Parses `cmdline` with the argpar API using the option descriptors + * `descrs`, and ensures that the resulting effective command line is + * `expected_cmd_line` and that the number of ingested original + * arguments is `expected_ingested_orig_args`. + * + * This function splits `cmdline` on spaces to create an original + * argument array. + * + * This function builds the resulting command line from parsing items + * by space-separating each formatted item (see append_to_res_str()). + */ +static +void test_succeed(const char * const cmdline, + const char * const expected_cmd_line, + const struct argpar_opt_descr * const descrs, + const unsigned int expected_ingested_orig_args) +{ + struct argpar_iter *iter = NULL; + const struct argpar_item *item = NULL; + const struct argpar_error *error = NULL; + GString * const res_str = g_string_new(NULL); + gchar ** const argv = g_strsplit(cmdline, " ", 0); + unsigned int i, actual_ingested_orig_args; + assert(argv); + assert(res_str); + iter = argpar_iter_create(g_strv_length(argv), + (const char * const *) argv, descrs); + assert(iter); + + for (i = 0; ; i++) { + enum argpar_iter_next_status status; + + ARGPAR_ITEM_DESTROY_AND_RESET(item); + status = argpar_iter_next(iter, &item, &error); + + ok(status == ARGPAR_ITER_NEXT_STATUS_OK || + status == ARGPAR_ITER_NEXT_STATUS_END, + "argpar_iter_next() returns the expected status " + "(%d) for command line `%s` (call %u)", + status, cmdline, i + 1); + ok(!error, + "argpar_iter_next() doesn't set an error for " + "command line `%s` (call %u)", + cmdline, i + 1); + + if (status == ARGPAR_ITER_NEXT_STATUS_END) { + ok(!item, + "argpar_iter_next() doesn't set an item " + "for status `ARGPAR_ITER_NEXT_STATUS_END` " + "and command line `%s` (call %u)", + cmdline, i + 1); break; } - case ARGPAR_ITEM_TYPE_NON_OPT: - { - const struct argpar_item_non_opt *arg_non_opt = - (const void *) arg; - - g_string_append_printf(res_str, "%s<%u,%u> ", - arg_non_opt->arg, arg_non_opt->orig_index, - arg_non_opt->non_opt_index); - break; - } - default: - abort(); - } + + append_to_res_str(res_str, item); } - if (res_str->len > 0) { - g_string_truncate(res_str, res_str->len - 1); + actual_ingested_orig_args = argpar_iter_ingested_orig_args(iter); + ok(actual_ingested_orig_args == expected_ingested_orig_args, + "argpar_iter_ingested_orig_args() returns the expected " + "number of ingested original arguments for command line `%s`", + cmdline); + + if (actual_ingested_orig_args != expected_ingested_orig_args) { + diag("Expected: %u Got: %u", expected_ingested_orig_args, + actual_ingested_orig_args); } ok(strcmp(expected_cmd_line, res_str->str) == 0, - "argpar_parse() returns the expected parsed arguments " + "argpar_iter_next() returns the expected parsing items " "for command line `%s`", cmdline); + if (strcmp(expected_cmd_line, res_str->str) != 0) { diag("Expected: `%s`", expected_cmd_line); diag("Got: `%s`", res_str->str); } -end: - argpar_parse_ret_fini(&parse_ret); + argpar_item_destroy(item); + argpar_iter_destroy(iter); + assert(!error); g_string_free(res_str, TRUE); g_strfreev(argv); } @@ -322,84 +360,6 @@ void succeed_tests(void) descrs, 7); } - /* Unknown short option (space form) */ - { - const struct argpar_opt_descr descrs[] = { - { 0, 'd', NULL, true }, - ARGPAR_OPT_DESCR_SENTINEL - }; - - test_succeed( - "-d salut -e -d meow", - "-d salut", - descrs, 2); - } - - /* Unknown short option (glued form) */ - { - const struct argpar_opt_descr descrs[] = { - { 0, 'd', NULL, true }, - ARGPAR_OPT_DESCR_SENTINEL - }; - - test_succeed( - "-dsalut -e -d meow", - "-d salut", - descrs, 1); - } - - /* Unknown long option (space form) */ - { - const struct argpar_opt_descr descrs[] = { - { 0, '\0', "sink", true }, - ARGPAR_OPT_DESCR_SENTINEL - }; - - test_succeed( - "--sink party --food --sink impulse", - "--sink=party", - descrs, 2); - } - - /* Unknown long option (equal form) */ - { - const struct argpar_opt_descr descrs[] = { - { 0, '\0', "sink", true }, - ARGPAR_OPT_DESCR_SENTINEL - }; - - test_succeed( - "--sink=party --food --sink=impulse", - "--sink=party", - descrs, 1); - } - - /* Unknown option before non-option argument */ - { - const struct argpar_opt_descr descrs[] = { - { 0, '\0', "thumb", true }, - ARGPAR_OPT_DESCR_SENTINEL - }; - - test_succeed( - "--thumb=party --food bateau --thumb waves", - "--thumb=party", - descrs, 1); - } - - /* Unknown option after non-option argument */ - { - const struct argpar_opt_descr descrs[] = { - { 0, '\0', "thumb", true }, - ARGPAR_OPT_DESCR_SENTINEL - }; - - test_succeed( - "--thumb=party wound --food --thumb waves", - "--thumb=party wound<1,0>", - descrs, 2); - } - /* Valid `---opt` */ { const struct argpar_opt_descr descrs[] = { @@ -491,62 +451,247 @@ void succeed_tests(void) "-f --yeah= -f", descrs, 3); } + + /* `-` non-option argument */ + { + const struct argpar_opt_descr descrs[] = { + { 0, 'f', NULL, false }, + ARGPAR_OPT_DESCR_SENTINEL + }; + + test_succeed( + "-f - -f", + "-f -<1,0> -f", + descrs, 3); + } + + /* `--` non-option argument */ + { + const struct argpar_opt_descr descrs[] = { + { 0, 'f', NULL, false }, + ARGPAR_OPT_DESCR_SENTINEL + }; + + test_succeed( + "-f -- -f", + "-f --<1,0> -f", + descrs, 3); + } + + /* Very long name of long option */ + { + const char opt_name[] = + "kale-chips-waistcoat-yr-bicycle-rights-gochujang-" + "woke-tumeric-flexitarian-biodiesel-chillwave-cliche-" + "ethical-cardigan-listicle-pok-pok-sustainable-live-" + "edge-jianbing-gochujang-butcher-disrupt-tattooed-" + "tumeric-prism-photo-booth-vape-kogi-jean-shorts-" + "blog-williamsburg-fingerstache-palo-santo-artisan-" + "affogato-occupy-skateboard-adaptogen-neutra-celiac-" + "put-a-bird-on-it-kombucha-everyday-carry-hot-chicken-" + "craft-beer-subway-tile-tote-bag-disrupt-selvage-" + "raclette-art-party-readymade-paleo-heirloom-trust-" + "fund-small-batch-kinfolk-woke-cardigan-prism-" + "chambray-la-croix-hashtag-unicorn-edison-bulb-tbh-" + "cornhole-cliche-tattooed-green-juice-adaptogen-" + "kitsch-lo-fi-vexillologist-migas-gentrify-" + "viral-raw-denim"; + const struct argpar_opt_descr descrs[] = { + { 0, '\0', opt_name, true }, + ARGPAR_OPT_DESCR_SENTINEL + }; + char cmdline[1024]; + + sprintf(cmdline, "--%s=23", opt_name); + test_succeed(cmdline, cmdline, descrs, 1); + } } /* - * Tests that the command line `cmdline`, with non-quoted - * space-delimited arguments, once parsed given the option descriptors - * `descrs`, fails and gives the expected error `expected_error`. + * Parses `cmdline` with the argpar API using the option descriptors + * `descrs`, and ensures that argpar_iter_next() fails with status + * `expected_status` and that it sets an error having: + * + * * The original argument index `expected_orig_index`. + * + * * If applicable: + * + * * The unknown option name `expected_unknown_opt_name`. + * + * * The option descriptor at index `expected_opt_descr_index` of + * `descrs`. + * + * * The option type `expected_is_short`. + * + * This function splits `cmdline` on spaces to create an original + * argument array. */ static -void test_fail(const char *cmdline, const char *expected_error, - const struct argpar_opt_descr *descrs) +void test_fail(const char * const cmdline, + const enum argpar_error_type expected_error_type, + const unsigned int expected_orig_index, + const char * const expected_unknown_opt_name, + const unsigned int expected_opt_descr_index, + const bool expected_is_short, + const struct argpar_opt_descr * const descrs) { - struct argpar_parse_ret parse_ret; - gchar **argv = g_strsplit(cmdline, " ", 0); - - parse_ret = argpar_parse(g_strv_length(argv), - (const char * const *) argv, descrs, true); - ok(!parse_ret.items, - "argpar_parse() fails for command line `%s`", cmdline); - ok(parse_ret.error, - "argpar_parse() writes an error string for command line `%s`", - cmdline); - if (parse_ret.items) { - fail("argpar_parse() writes the expected error string"); - goto end; - } + struct argpar_iter *iter = NULL; + const struct argpar_item *item = NULL; + gchar ** const argv = g_strsplit(cmdline, " ", 0); + unsigned int i; + const struct argpar_error *error = NULL; + + iter = argpar_iter_create(g_strv_length(argv), + (const char * const *) argv, descrs); + assert(iter); + + for (i = 0; ; i++) { + enum argpar_iter_next_status status; + + ARGPAR_ITEM_DESTROY_AND_RESET(item); + status = argpar_iter_next(iter, &item, &error); + ok(status == ARGPAR_ITER_NEXT_STATUS_OK || + (status == ARGPAR_ITER_NEXT_STATUS_ERROR && + argpar_error_type(error) == expected_error_type), + "argpar_iter_next() returns the expected status " + "and error type (%d) for command line `%s` (call %u)", + expected_error_type, cmdline, i + 1); + + if (status != ARGPAR_ITER_NEXT_STATUS_OK) { + ok(!item, + "argpar_iter_next() doesn't set an item " + "for other status than " + "`ARGPAR_ITER_NEXT_STATUS_OK` " + "and command line `%s` (call %u)", + cmdline, i + 1); + ok(error, + "argpar_iter_next() sets an error for " + "other status than " + " `ARGPAR_ITER_NEXT_STATUS_OK` " + "and command line `%s` (call %u)", + cmdline, i + 1); + ok(argpar_error_orig_index(error) == + expected_orig_index, + "argpar_iter_next() sets an error with " + "the expected original argument index " + "for command line `%s` (call %u)", + cmdline, i + 1); + + if (argpar_error_type(error) == ARGPAR_ERROR_TYPE_UNKNOWN_OPT) { + ok(strcmp(argpar_error_unknown_opt_name(error), + expected_unknown_opt_name) == 0, + "argpar_iter_next() sets an error with " + "the expected unknown option name " + "for command line `%s` (call %u)", + cmdline, i + 1); + } else { + bool is_short; + + ok(argpar_error_opt_descr(error, &is_short) == + &descrs[expected_opt_descr_index], + "argpar_iter_next() sets an error with " + "the expected option descriptor " + "for command line `%s` (call %u)", + cmdline, i + 1); + ok(is_short == expected_is_short, + "argpar_iter_next() sets an error with " + "the expected option type " + "for command line `%s` (call %u)", + cmdline, i + 1); + } + break; + } - ok(strcmp(expected_error, parse_ret.error) == 0, - "argpar_parse() writes the expected error string " + ok(item, + "argpar_iter_next() sets an item for status " + "`ARGPAR_ITER_NEXT_STATUS_OK` " + "and command line `%s` (call %u)", + cmdline, i + 1); + ok(!error, + "argpar_iter_next() doesn't set an error for status " + "`ARGPAR_ITER_NEXT_STATUS_OK` " + "and command line `%s` (call %u)", + cmdline, i + 1); + } + + /* + ok(strcmp(expected_error, error) == 0, + "argpar_iter_next() sets the expected error string " "for command line `%s`", cmdline); - if (strcmp(expected_error, parse_ret.error) != 0) { + + if (strcmp(expected_error, error) != 0) { diag("Expected: `%s`", expected_error); - diag("Got: `%s`", parse_ret.error); + diag("Got: `%s`", error); } + */ -end: - argpar_parse_ret_fini(&parse_ret); + argpar_item_destroy(item); + argpar_iter_destroy(iter); + argpar_error_destroy(error); g_strfreev(argv); } static void fail_tests(void) { - /* Unknown long option */ + + /* Unknown short option (space form) */ { const struct argpar_opt_descr descrs[] = { - { 0, '\0', "thumb", true }, + { 0, 'd', NULL, true }, + ARGPAR_OPT_DESCR_SENTINEL + }; + + test_fail( + "-d salut -e -d meow", + ARGPAR_ERROR_TYPE_UNKNOWN_OPT, + 2, "-e", 0, false, + descrs); + } + + /* Unknown short option (glued form) */ + { + const struct argpar_opt_descr descrs[] = { + { 0, 'd', 0, true }, + ARGPAR_OPT_DESCR_SENTINEL + }; + + test_fail( + "-dsalut -e -d meow", + ARGPAR_ERROR_TYPE_UNKNOWN_OPT, + 1, "-e", 0, false, + descrs); + } + + /* Unknown long option (space form) */ + { + const struct argpar_opt_descr descrs[] = { + { 0, '\0', "sink", true }, + ARGPAR_OPT_DESCR_SENTINEL + }; + + test_fail( + "--sink party --food --sink impulse", + ARGPAR_ERROR_TYPE_UNKNOWN_OPT, + 2, "--food", 0, false, + descrs); + } + + /* Unknown long option (equal form) */ + { + const struct argpar_opt_descr descrs[] = { + { 0, '\0', "sink", true }, ARGPAR_OPT_DESCR_SENTINEL }; test_fail( - "--thumb=party --meow", - "While parsing argument #2 (`--meow`): Unknown option `--meow`", + "--sink=party --food --sink=impulse", + ARGPAR_ERROR_TYPE_UNKNOWN_OPT, + 1, "--food", 0, false, descrs); } - /* Unknown short option */ + /* Unknown option before non-option argument */ { const struct argpar_opt_descr descrs[] = { { 0, '\0', "thumb", true }, @@ -554,12 +699,13 @@ void fail_tests(void) }; test_fail( - "--thumb=party -x", - "While parsing argument #2 (`-x`): Unknown option `-x`", + "--thumb=party --food=18 bateau --thumb waves", + ARGPAR_ERROR_TYPE_UNKNOWN_OPT, + 1, "--food", 0, false, descrs); } - /* Missing long option argument */ + /* Unknown option after non-option argument */ { const struct argpar_opt_descr descrs[] = { { 0, '\0', "thumb", true }, @@ -567,40 +713,41 @@ void fail_tests(void) }; test_fail( - "--thumb", - "While parsing argument #1 (`--thumb`): Missing required argument for option `--thumb`", + "--thumb=party wound --food --thumb waves", + ARGPAR_ERROR_TYPE_UNKNOWN_OPT, + 2, "--food", 0, false, descrs); } - /* Missing short option argument */ + /* Missing long option argument */ { const struct argpar_opt_descr descrs[] = { - { 0, 'k', NULL, true }, + { 0, '\0', "thumb", true }, ARGPAR_OPT_DESCR_SENTINEL }; test_fail( - "-k", - "While parsing argument #1 (`-k`): Missing required argument for option `-k`", + "allo --thumb", + ARGPAR_ERROR_TYPE_MISSING_OPT_ARG, + 1, NULL, 0, false, descrs); } - /* Missing short option argument (multiple glued) */ + /* Missing short option argument */ { const struct argpar_opt_descr descrs[] = { - { 0, 'a', NULL, false }, - { 0, 'b', NULL, false }, - { 0, 'c', NULL, true }, + { 0, 'k', NULL, true }, ARGPAR_OPT_DESCR_SENTINEL }; test_fail( - "-abc", - "While parsing argument #1 (`-abc`): Missing required argument for option `-c`", + "zoom heille -k", + ARGPAR_ERROR_TYPE_MISSING_OPT_ARG, + 2, NULL, 0, true, descrs); } - /* Invalid `-` */ + /* Missing short option argument (multiple glued) */ { const struct argpar_opt_descr descrs[] = { { 0, 'a', NULL, false }, @@ -610,30 +757,30 @@ void fail_tests(void) }; test_fail( - "-ab - -c", - "While parsing argument #2 (`-`): Invalid argument", + "-abc", + ARGPAR_ERROR_TYPE_MISSING_OPT_ARG, + 0, NULL, 2, true, descrs); } - /* Invalid `--` */ + /* Unexpected long option argument */ { const struct argpar_opt_descr descrs[] = { - { 0, 'a', NULL, false }, - { 0, 'b', NULL, false }, - { 0, 'c', NULL, true }, + { 0, 'c', "chevre", false }, ARGPAR_OPT_DESCR_SENTINEL }; test_fail( - "-ab -- -c", - "While parsing argument #2 (`--`): Invalid argument", + "ambulance --chevre=fromage tar -cjv", + ARGPAR_ERROR_TYPE_UNEXPECTED_OPT_ARG, + 1, NULL, 0, false, descrs); } } int main(void) { - plan_tests(129); + plan_tests(309); succeed_tests(); fail_tests(); return exit_status();