tests/test-argp.c

   1 /* Test suite for argp.
   2    Copyright (C) 2006 Free Software Foundation, Inc.
   3    This file is part of the GNUlib Library.
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 2, or (at your option)
   8    any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License along
  16    with this program; if not, write to the Free Software Foundation,
  17    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
  18
  19 #ifdef HAVE_CONFIG_H
  20 # include <config.h>
  21 #endif
  22
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25 #if HAVE_STRING_H
  26 # include <string.h>
  27 #endif
  28 #if HAVE_STRINGS_H
  29 # include <strings.h>
  30 #endif
  31
  32 #include "argp.h"
  33
  34 struct test_args
  35 {
  36   int test;
  37   int verbose;
  38   char *file;
  39   char *hidden;
  40   int opt;
  41   char *optional;
  42   int optional_set;
  43 };
  44
  45 static struct argp_option group1_option[] =
  46 {
  47   { NULL, 0, NULL, 0, "Option Group 1", 0},
  48   { "verbose", 'v', NULL, 0, "Simple option without arguments", 1 },
  49   { "file", 'f', "FILE", 0, "Option with a mandatory argument", 1 },
  50   { "input", 0, NULL, OPTION_ALIAS, NULL, 1 },
  51   { "hidden", 'H', "FILE", OPTION_HIDDEN, "Hidden option", 1 },
  52   { NULL, 0, NULL, 0, NULL, 0 }
  53 };
  54
  55 static error_t
  56 group1_parser (int key, char *arg, struct argp_state *state)
  57 {
  58   struct test_args *args = state->input;
  59
  60   switch (key)
  61     {
  62     case 'v':
  63       args->verbose++;
  64       break;
  65
  66     case 'f':
  67       args->file = arg;
  68       break;
  69
  70     case 'H':
  71       args->hidden = arg;
  72       break;
  73
  74     default:
  75       return ARGP_ERR_UNKNOWN;
  76     }
  77   return 0;
  78 }
  79
  80 struct argp group1_argp = {
  81   group1_option,
  82   group1_parser
  83 };
  84
  85 struct argp_child group1_child = {
  86   &group1_argp,
  87   0,
  88   "",
  89   1
  90 };
  91
  92 \f
  93 static struct argp_option group2_option[] =
  94 {
  95   { NULL, 0, NULL, 0, "Option Group 2", 0},
  96   { "option", 'O', NULL, 0, "An option", 1 },
  97   { "optional", 'o', "ARG", OPTION_ARG_OPTIONAL,
  98     "Option with an optional argument. ARG is one of the following:", 1 },
  99   { "one", 0, NULL, OPTION_DOC|OPTION_NO_TRANS, "one unit", 2 },
 100   { "two", 0, NULL, OPTION_DOC|OPTION_NO_TRANS, "two units", 2 },
 101   { "many", 0, NULL, OPTION_DOC|OPTION_NO_TRANS, "many units", 2 },
 102   { NULL, 0, NULL, 0, NULL, 0 }
 103 };
 104
 105 static error_t
 106 group2_parser (int key, char *arg, struct argp_state *state)
 107 {
 108   struct test_args *args = state->input;
 109
 110   switch (key)
 111     {
 112     case 'O':
 113       args->opt = 1;
 114       break;
 115
 116     case 'o':
 117       args->optional_set = 1;
 118       args->optional = arg;
 119       break;
 120
 121     default:
 122       return ARGP_ERR_UNKNOWN;
 123     }
 124   return 0;
 125 }
 126
 127 struct argp group2_argp = {
 128   group2_option,
 129   group2_parser
 130 };
 131
 132 struct argp_child group2_child = {
 133   &group2_argp,
 134   0,
 135   "",
 136   2
 137 };
 138
 139 static struct argp_option main_options[] =
 140   {
 141     { NULL, 0, NULL, 0, "Main options", 0},
 142     { "test", 't', NULL, 0, NULL, 1 },
 143     { NULL, 0, NULL, 0, NULL, 0 }
 144   };
 145
 146 static error_t
 147 parse_opt (int key, char *arg, struct argp_state *state)
 148 {
 149   struct test_args *args = state->input;
 150   int i;
 151
 152   switch (key)
 153     {
 154     case ARGP_KEY_INIT:
 155       for (i = 0; state->root_argp->children[i].argp; i++)
 156         state->child_inputs[i] = args;
 157       break;
 158
 159     case 't':
 160       args->test = 1;
 161       break;
 162
 163     default:
 164       return ARGP_ERR_UNKNOWN;
 165     }
 166   return 0;
 167 }
 168
 169 const char *argp_program_version = "test_argp (" PACKAGE_NAME ") " VERSION;
 170 const char *argp_program_bug_address = "<" PACKAGE_BUGREPORT ">";
 171 static char doc[] = "documentation string";
 172
 173 struct argp test_argp = {
 174   main_options,
 175   parse_opt,
 176   "ARGS...",
 177   doc,
 178   NULL,
 179   NULL,
 180   NULL
 181 };
 182
 183 #define NARGS(a) (sizeof(a) / sizeof((a)[0]) - 1)
 184 #define ARGV0 "test-argp"
 185 #define init_args(a) memset (&(a), 0, sizeof (a));
 186
 187 #define INIT_TEST_COMMON(n)     \
 188  int argc = NARGS (argv);       \
 189  struct test_args test_args;    \
 190  init_args(test_args);          \
 191  test_number = n;
 192
 193 #define INIT_TEST1(n, arg1)            \
 194  char *argv[] = { ARGV0, arg1, NULL }; \
 195  INIT_TEST_COMMON(n)
 196
 197 #define INIT_TEST2(n, arg1, arg2)            \
 198  char *argv[] = { ARGV0, arg1, arg2, NULL }; \
 199  INIT_TEST_COMMON(n)
 200
 201 #define INIT_TEST3(n, arg1, arg2, arg3)            \
 202  char *argv[] = { ARGV0, arg1, arg2, arg3, NULL }; \
 203  INIT_TEST_COMMON(n)
 204
 205 int test_number;
 206 unsigned failure_count = 0;
 207
 208 void
 209 fail(const char *msg)
 210 {
 211   fprintf(stderr, "Test %d: %s\n", test_number, msg);
 212   failure_count++;
 213 }
 214
 215 void
 216 test1(struct argp *argp)
 217 {
 218   INIT_TEST1 (1, "--test");
 219   if (argp_parse (argp, argc, argv, 0, NULL, &test_args))
 220     fail("argp_parse failed");
 221   else if (test_args.test != 1)
 222     fail("option not processed");
 223 }
 224
 225 void
 226 test2(struct argp *argp)
 227 {
 228   INIT_TEST1 (2, "-t");
 229   if (argp_parse (argp, argc, argv, 0, NULL, &test_args))
 230     fail("argp_parse failed");
 231   else if (test_args.test != 1)
 232     fail("option not processed");
 233 }
 234
 235 void
 236 test_file(struct argp *argp, int argc, char **argv, struct test_args *args)
 237 {
 238   if (argp_parse (argp, argc, argv, 0, NULL, args))
 239     fail("argp_parse failed");
 240   else if (!args->file)
 241     fail("option not processed");
 242   else if (strcmp (args->file, "FILE"))
 243     fail("option processed incorrectly");
 244 }
 245
 246 void
 247 test3(struct argp *argp)
 248 {
 249   INIT_TEST1 (3, "--file=FILE");
 250   test_file (argp, argc, argv, &test_args);
 251 }
 252
 253 void
 254 test4(struct argp *argp)
 255 {
 256   INIT_TEST2 (4, "--file", "FILE");
 257   test_file (argp, argc, argv, &test_args);
 258 }
 259
 260 void
 261 test5(struct argp *argp)
 262 {
 263   INIT_TEST1 (5, "--input=FILE");
 264   test_file (argp, argc, argv, &test_args);
 265 }
 266
 267 void
 268 test6(struct argp *argp)
 269 {
 270   INIT_TEST2 (6, "--input", "FILE");
 271   test_file (argp, argc, argv, &test_args);
 272 }
 273
 274 void
 275 test_optional(struct argp *argp, int argc, char **argv,
 276               struct test_args *args, char *val, char *a)
 277 {
 278   int index;
 279   if (argp_parse (argp, argc, argv, 0, &index, args))
 280     fail("argp_parse failed");
 281   else if (!args->optional_set)
 282     fail("option not processed");
 283
 284   if (!val)
 285     {
 286       if (args->optional)
 287         fail("option processed incorrectly");
 288     }
 289   else if (strcmp (args->optional, val))
 290     fail("option processed incorrectly");
 291
 292   if (a)
 293     {
 294       if (index == argc)
 295         fail("expected command line argument not found");
 296       else if (strcmp(argv[index], a))
 297         fail("expected command line argument does not match");
 298     }
 299 }
 300
 301 void
 302 test7(struct argp *argp)
 303 {
 304   INIT_TEST1 (7, "-oARG");
 305   test_optional(argp, argc, argv, &test_args, "ARG", NULL);
 306 }
 307
 308 void
 309 test8(struct argp *argp)
 310 {
 311   INIT_TEST2 (8, "-o", "ARG");
 312   test_optional(argp, argc, argv, &test_args, NULL, "ARG");
 313 }
 314
 315 void
 316 test9(struct argp *argp)
 317 {
 318   INIT_TEST1 (9, "--optional=ARG");
 319   test_optional(argp, argc, argv, &test_args, "ARG", NULL);
 320 }
 321
 322 void
 323 test10(struct argp *argp)
 324 {
 325   INIT_TEST2 (10, "--optional", "ARG");
 326   test_optional(argp, argc, argv, &test_args, NULL, "ARG");
 327 }
 328
 329 void
 330 test11(struct argp *argp)
 331 {
 332   INIT_TEST1 (11, "--optiona=ARG");
 333   test_optional(argp, argc, argv, &test_args, "ARG", NULL);
 334 }
 335
 336 void
 337 test12(struct argp *argp)
 338 {
 339   INIT_TEST3 (12, "--option", "--optional=OPT", "FILE");
 340   test_optional(argp, argc, argv, &test_args, "OPT", "FILE");
 341 }
 342
 343
 344 typedef void (*test_fp) (struct argp *argp);
 345
 346 test_fp test_fun[] = {
 347   test1,  test2,  test3,  test4,
 348   test5,  test6,  test7,  test8,
 349   test9,  test10, test11, test12,
 350   NULL
 351 };
 352
 353 int
 354 main (int argc, char **argv)
 355 {
 356   struct argp_child argp_children[3];
 357   test_fp *fun;
 358
 359   argp_children[0] = group1_child;
 360   argp_children[1] = group2_child;
 361   argp_children[2].argp = NULL;
 362   test_argp.children = argp_children;
 363
 364   if (argc > 0)
 365     {
 366       struct test_args test_args;
 367       init_args(test_args);
 368       return argp_parse (&test_argp, argc, argv, 0, NULL, &test_args);
 369     }
 370
 371   for (fun = test_fun; *fun; fun++)
 372     (*fun) (&test_argp);
 373
 374   if (failure_count)
 375     return 1;
 376
 377   return 0;
 378 }