Merge pull request #5180 from chu11/issue5178_liboptparse_missing_argument

liboptparse: correct message on missing argument

Author: mergify[bot]

src/common/liboptparse/optparse.c

@@ -1197,7 +1197,14 @@ static char * optstring_create ()
     char *optstring = calloc (4, 1);
     if (optstring == NULL)
         return (NULL);
-    optstring[0] = '\0';
+    /* Per getopt(3) manpage
+     *
+     * "If the first character ... of optstring is a colon (':'), then
+     * getopt() returns ':' instead of '?' to indicate a missing
+     * option argument"
+     */
+    optstring[0] = ':';
+    optstring[1] = '\0';
     return (optstring);
 }
 
@@ -1365,7 +1372,13 @@ int optparse_parse_args (optparse_t *p, int argc, char *argv[])
                                &li, &d, p->posixly_correct)) >= 0) {
         struct option_info *opt;
         struct optparse_option *o;
-        if (c == '?') {
+        if (c == ':') {
+            (*p->log_fn) ("%s: '%s' missing argument\n",
+                          fullname, argv[d.optind-1]);
+            d.optind = -1;
+            break;
+        }
+        else if (c == '?') {
             if (d.optopt != '\0')
                 (*p->log_fn) ("%s: unrecognized option '-%c'\n",
                               fullname,  d.optopt);

src/common/liboptparse/test/optparse.c

@@ -934,6 +934,18 @@ test two: unrecognized option '-Z'\n\
 Try `test two --help' for more information.\n",
     "bad argument error message is expected");
 
+    // Test missing argument prints expected error
+    char *av43[] = { "test", "two", "-t", NULL};
+    ac = ARRAY_SIZE (av43) - 1;
+
+    diag ("parsing test two -t");
+    n = optparse_run_subcommand (a, ac, av43);
+    ok (n == -1,
+        "optparse_run_subcommand with missing argument fails");
+
+    usage_output_is ("test two: '-t' missing argument\n",
+                     "missing argument error message is expected");
+
     // Test no subcommand (and subcommand required) prints error
     char *av5[] = { "test", NULL };
     ac = ARRAY_SIZE (av5) - 1;
@@ -1346,15 +1358,15 @@ static void test_optional_args ()
 
 int main (int argc, char *argv[])
 {
-    plan (296);
+    plan (299);
 
     test_convenience_accessors (); /* 36 tests */
     test_usage_output (); /* 46 tests */
     test_option_cb ();  /* 16 tests */
     test_errors (); /* 9 tests */
     test_multiret (); /* 19 tests */
     test_data (); /* 8 tests */
-    test_subcommand (); /* 67 tests */
+    test_subcommand (); /* 70 tests */
     test_long_only (); /* 13 tests */
     test_optional_argument (); /* 9 tests */
     test_corner_case (); /* 3 tests */