posix/wordexp-test.c

   1 /* Copyright (C) 1997, 1998 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3
   4    The GNU C Library is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU Library General Public License as
   6    published by the Free Software Foundation; either version 2 of the
   7    License, or (at your option) any later version.
   8
   9    The GNU C Library is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    Library General Public License for more details.
  13
  14    You should have received a copy of the GNU Library General Public
  15    License along with the GNU C Library; see the file COPYING.LIB.  If not,
  16    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17    Boston, MA 02111-1307, USA.  */
  18
  19 #include <sys/stat.h>
  20 #include <sys/types.h>
  21 #include <fcntl.h>
  22 #include <unistd.h>
  23 #include <pwd.h>
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #include <wordexp.h>
  27
  28 #define IFS " \n\t"
  29
  30 struct test_case_struct
  31 {
  32   int retval;
  33   const char *env;
  34   const char *words;
  35   int flags;
  36   int wordc;
  37   const char *wordv[10];
  38   const char *ifs;
  39 } test_case[] =
  40   {
  41     /* Simple word- and field-splitting */
  42     { 0, NULL, "one", 0, 1, { "one", }, IFS },
  43     { 0, NULL, "one two", 0, 2, { "one", "two", }, IFS },
  44     { 0, NULL, "one two three", 0, 3, { "one", "two", "three", }, IFS },
  45     { 0, NULL, " \tfoo\t\tbar ", 0, 2, { "foo", "bar", }, IFS },
  46     { 0, NULL, "red , white blue", 0, 4, { "red", ",", "white", "blue", }, " ," },
  47     { 0, NULL, "one two three", 0, 3, { "one", "two", "three", }, "" },
  48     { 0, NULL, "one \"two three\"", 0, 2, { "one", "two three", }, IFS },
  49     { 0, NULL, "one \"two three\"", 0, 2, { "one", "two three", }, "" },
  50     { 0, "two three", "one \"$var\"", 0, 2, { "one", "two three", }, IFS },
  51     { 0, "two three", "one $var", 0, 3, { "one", "two", "three", }, IFS },
  52     { 0, "two three", "one \"$var\"", 0, 2, { "one", "two three", }, "" },
  53     { 0, "two three", "one $var", 0, 2, { "one", "two three", }, "" },
  54
  55     /* The non-whitespace IFS char at the end delimits the second field
  56      * but does NOT start a new field. */
  57     { 0, ":abc:", "$var", 0, 2, { "", "abc", }, ":" },
  58
  59     { 0, NULL, "$(echo :abc:)", 0, 2, { "", "abc", }, ":" },
  60     { 0, NULL, "$(echo :abc:\\ )", 0, 2, { "", "abc", }, ": " },
  61     { 0, NULL, "$(echo :abc\\ )", 0, 2, { "", "abc", }, ": " },
  62     { 0, ":abc:", "$(echo $var)", 0, 2, { "", "abc", }, ":" },
  63     { 0, NULL, ":abc:", 0, 1, { ":abc:", }, ":" },
  64     { 0, NULL, "$(echo :abc:)def", 0, 3, { "", "abc", "def", },
  65       ":" },
  66     { 0, NULL, "$(echo abc:de)f", 0, 2, { "abc", "def", }, ":" },
  67     { 0, NULL, "$(echo abc:de)f:ghi", 0, 2, { "abc", "def:ghi", },
  68       ":" },
  69     { 0, NULL, "abc:d$(echo ef:ghi)", 0, 2, { "abc:def", "ghi", },
  70       ":" },
  71     { 0, "abc:", "$var$(echo def:ghi)", 0, 3, { "abc", "def",
  72                                                           "ghi", }, ":" },
  73     { 0, "abc:d", "$var$(echo ef:ghi)", 0, 3, { "abc", "def",
  74                                                           "ghi", }, ":" },
  75     { 0, "def:ghi", "$(echo abc:)$var", 0, 3, { "abc", "def",
  76                                                           "ghi", }, ":" },
  77     { 0, "ef:ghi", "$(echo abc:d)$var", 0, 3, { "abc", "def",
  78                                                           "ghi", }, ":" },
  79
  80     /* Simple parameter expansion */
  81     { 0, "foo", "${var}", 0, 1, { "foo", }, IFS },
  82     { 0, "foo", "$var", 0, 1, { "foo", }, IFS },
  83     { 0, "foo", "\\\"$var\\\"", 0, 1, { "\"foo\"", }, IFS },
  84     { 0, "foo", "%$var%", 0, 1, { "%foo%", }, IFS },
  85     { 0, "foo", "-$var-", 0, 1, { "-foo-", }, IFS },
  86
  87     /* Simple quote removal */
  88     { 0, NULL, "\"quoted\"", 0, 1, { "quoted", }, IFS },
  89     { 0, "foo", "\"$var\"\"$var\"", 0, 1, { "foofoo", }, IFS },
  90     { 0, NULL, "'singly-quoted'", 0, 1, { "singly-quoted", }, IFS },
  91     { 0, NULL, "contin\\\nuation", 0, 1, { "continuation", }, IFS },
  92     { 0, NULL, "explicit ''", 0, 2, { "explicit", "", }, IFS },
  93     { 0, NULL, "explicit \"\"", 0, 2, { "explicit", "", }, IFS },
  94     { 0, NULL, "explicit ``", 0, 1, { "explicit", }, IFS },
  95
  96     /* Simple command substitution */
  97     { 0, NULL, "$(echo hello)", 0, 1, { "hello", }, IFS },
  98     { 0, NULL, "$( (echo hello) )", 0, 1, { "hello", }, IFS },
  99     { 0, NULL, "$((echo hello);(echo there))", 0, 2, { "hello", "there", }, IFS },
 100     { 0, NULL, "`echo one two`", 0, 2, { "one", "two", }, IFS },
 101     { 0, NULL, "$(echo ')')", 0, 1, { ")" }, IFS },
 102     { 0, NULL, "$(echo hello; echo)", 0, 1, { "hello", }, IFS },
 103     { 0, NULL, "a$(echo b)c", 0, 1, { "abc", }, IFS },
 104
 105     /* Simple arithmetic expansion */
 106     { 0, NULL, "$((1 + 1))", 0, 1, { "2", }, IFS },
 107     { 0, NULL, "$((2-3))", 0, 1, { "-1", }, IFS },
 108     { 0, NULL, "$((-1))", 0, 1, { "-1", }, IFS },
 109     { 0, NULL, "$[50+20]", 0, 1, { "70", }, IFS },
 110     { 0, NULL, "$(((2+3)*(4+5)))", 0, 1, { "45", }, IFS },
 111
 112     /* Advanced parameter expansion */
 113     { 0, NULL, "${var:-bar}", 0, 1, { "bar", }, IFS },
 114     { 0, NULL, "${var-bar}", 0, 1, { "bar", }, IFS },
 115     { 0, "", "${var:-bar}", 0, 1, { "bar", }, IFS },
 116     { 0, "foo", "${var:-bar}", 0, 1, { "foo", }, IFS },
 117     { 0, "", "${var-bar}", 0, 0, { NULL, }, IFS },
 118     { 0, NULL, "${var:=bar}", 0, 1, { "bar", }, IFS },
 119     { 0, NULL, "${var=bar}", 0, 1, { "bar", }, IFS },
 120     { 0, "", "${var:=bar}", 0, 1, { "bar", }, IFS },
 121     { 0, "foo", "${var:=bar}", 0, 1, { "foo", }, IFS },
 122     { 0, "", "${var=bar}", 0, 0, { NULL, }, IFS },
 123     { 0, "foo", "${var:?bar}", 0, 1, { "foo", }, IFS },
 124     { 0, NULL, "${var:+bar}", 0, 0, { NULL, }, IFS },
 125     { 0, NULL, "${var+bar}", 0, 0, { NULL, }, IFS },
 126     { 0, "", "${var:+bar}", 0, 0, { NULL, }, IFS },
 127     { 0, "foo", "${var:+bar}", 0, 1, { "bar", }, IFS },
 128     { 0, "", "${var+bar}", 0, 1, { "bar", }, IFS },
 129     { 0, "12345", "${#var}", 0, 1, { "5", }, IFS },
 130     { 0, NULL, "${var:-'}'}", 0, 1, { "}", }, IFS },
 131     { 0, NULL, "${var-}", 0, 0, { NULL }, IFS },
 132
 133     { 0, "pizza", "${var#${var}}", 0, 0, { NULL }, IFS },
 134     { 0, "pepperoni", "${var%$(echo oni)}", 0, 1, { "pepper" }, IFS },
 135     { 0, "6pack", "${var#$((6))}", 0, 1, { "pack" }, IFS },
 136     { 0, "b*witched", "${var##b*}", 0, 0, { NULL }, IFS },
 137     { 0, "b*witched", "${var##\"b*\"}", 0, 1, { "witched" }, IFS },
 138     { 0, "banana", "${var%na*}", 0, 1, { "bana", }, IFS },
 139     { 0, "banana", "${var%%na*}", 0, 1, { "ba", }, IFS },
 140     { 0, "borabora-island", "${var#*bora}", 0, 1, { "bora-island", }, IFS },
 141     { 0, "borabora-island", "${var##*bora}", 0, 1, { "-island", }, IFS },
 142     { 0, "coconut", "${var##\\*co}", 0, 1, { "coconut", }, IFS },
 143     { 0, "100%", "${var%0%}", 0, 1, { "10" }, IFS },
 144
 145     /* Pathname expansion */
 146     { 0, NULL, "???", 0, 2, { "one", "two", }, IFS },
 147     { 0, NULL, "[ot]??", 0, 2, { "one", "two", }, IFS },
 148     { 0, NULL, "t*", 0, 2, { "three", "two", }, IFS },
 149     { 0, NULL, "\"t\"*", 0, 2, { "three", "two", }, IFS },
 150
 151     /* Nested constructs */
 152     { 0, "one two", "$var", 0, 2, { "one", "two", }, IFS },
 153     { 0, "one two three", "$var", 0, 3, { "one", "two", "three", }, IFS },
 154     { 0, " \tfoo\t\tbar ", "$var", 0, 2, { "foo", "bar", }, IFS },
 155     { 0, "  red  , white blue", "$var", 0, 3, { "red", "white", "blue", }, ", \n\t" },
 156     { 0, "  red  , white blue", "\"$var\"", 0, 1, { "  red  , white blue", }, ", \n\t" },
 157     { 0, NULL, "\"$(echo hello there)\"", 0, 1, { "hello there", }, IFS },
 158     { 0, NULL, "\"$(echo \"hello there\")\"", 0, 1, { "hello there", }, IFS },
 159     { 0, NULL, "${var=one two} \"$var\"", 0, 3, { "one", "two", "one two", }, IFS },
 160     { 0, "1", "$(( $(echo 3)+$var ))", 0, 1, { "4", }, IFS },
 161     { 0, NULL, "\"$(echo \"*\")\"", 0, 1, { "*", }, IFS },
 162     { 0, NULL, "\"a\n\n$(echo)b\"", 0, 1, { "a\n\nb", }, IFS },
 163     { 0, "foo", "*$var*", 0, 1, { "*foo*", }, IFS },
 164     { 0, "o thr", "*$var*", 0, 2, { "two", "three" }, IFS },
 165
 166     /* Different IFS values */
 167     { 0, "a b\tc\nd  ", "$var", 0, 4, { "a", "b", "c", "d" }, NULL /* unset */ },
 168     { 0, "a b\tc d  ", "$var", 0, 1, { "a b\tc d  " }, "" /* `null' */ },
 169     { 0, "a,b c\n, d", "$var", 0, 3, { "a", "b c", " d" }, "\t\n," },
 170
 171     /* Other things that should succeed */
 172     { 0, NULL, "\\*\"|&;<>\"\\(\\)\\{\\}", 0, 1, { "*|&;<>(){}", }, IFS },
 173     { 0, "???", "$var", 0, 1, { "???", }, IFS },
 174     { 0, NULL, "$var", 0, 0, { NULL, }, IFS },
 175     { 0, NULL, "\"\\n\"", 0, 1, { "\\n", }, IFS },
 176     { 0, NULL, "", 0, 0, { NULL, }, IFS },
 177
 178     /* Flags not already covered (testit() has special handling for these) */
 179     { 0, NULL, "one two", WRDE_DOOFFS, 2, { "one", "two", }, IFS },
 180     { 0, NULL, "appended", WRDE_APPEND, 3, { "pre1", "pre2", "appended", }, IFS },
 181     { 0, NULL, "appended", WRDE_DOOFFS|WRDE_APPEND, 3, { "pre1", "pre2", "appended", }, IFS },
 182
 183     /* Things that should fail */
 184     { WRDE_BADCHAR, NULL, "new\nline", 0, 0, { NULL, }, "" /* \n not IFS */ },
 185     { WRDE_BADCHAR, NULL, "pipe|symbol", 0, 0, { NULL, }, IFS },
 186     { WRDE_BADCHAR, NULL, "&ampersand", 0, 0, { NULL, }, IFS },
 187     { WRDE_BADCHAR, NULL, "semi;colon", 0, 0, { NULL, }, IFS },
 188     { WRDE_BADCHAR, NULL, "<greater", 0, 0, { NULL, }, IFS },
 189     { WRDE_BADCHAR, NULL, "less>", 0, 0, { NULL, }, IFS },
 190     { WRDE_BADCHAR, NULL, "(open-paren", 0, 0, { NULL, }, IFS },
 191     { WRDE_BADCHAR, NULL, "close-paren)", 0, 0, { NULL, }, IFS },
 192     { WRDE_BADCHAR, NULL, "{open-brace", 0, 0, { NULL, }, IFS },
 193     { WRDE_BADCHAR, NULL, "close-brace}", 0, 0, { NULL, }, IFS },
 194     { WRDE_CMDSUB, NULL, "$(ls)", WRDE_NOCMD, 0, { NULL, }, IFS },
 195     { WRDE_BADVAL, NULL, "$var", WRDE_UNDEF, 0, { NULL, }, IFS },
 196     { WRDE_BADVAL, NULL, "$9", WRDE_UNDEF, 0, { NULL, }, IFS },
 197     { WRDE_SYNTAX, NULL, "$[50+20))", 0, 0, { NULL, }, IFS },
 198     { WRDE_SYNTAX, NULL, "${%%noparam}", 0, 0, { NULL, }, IFS },
 199     { WRDE_SYNTAX, NULL, "${missing-brace", 0, 0, { NULL, }, IFS },
 200     { WRDE_SYNTAX, NULL, "$(for i in)", 0, 0, { NULL, }, IFS },
 201     { WRDE_SYNTAX, NULL, "$((2+))", 0, 0, { NULL, }, IFS },
 202     { WRDE_SYNTAX, NULL, "`", 0, 0, { NULL, }, IFS },
 203
 204     { -1, NULL, NULL, 0, 0, { NULL, }, IFS },
 205   };
 206
 207 static int testit (struct test_case_struct *tc);
 208 static int tests;
 209
 210 void
 211 command_line_test (const char *words)
 212 {
 213   wordexp_t we;
 214   int i;
 215   int retval = wordexp (words, &we, 0);
 216   printf ("wordexp returned %d\n", retval);
 217   for (i = 0; i < we.we_wordc; i++)
 218     printf ("we_wordv[%d] = \"%s\"\n", i, we.we_wordv[i]);
 219 }
 220
 221 int
 222 main (int argc, char *argv[])
 223 {
 224   const char *globfile[] = { "one", "two", "three", NULL };
 225   char tmpdir[32];
 226   struct passwd *pw;
 227   const char *cwd;
 228   int test;
 229   int fail = 0;
 230   int i;
 231   struct test_case_struct ts;
 232
 233   if (argc > 1)
 234     {
 235       command_line_test (argv[1]);
 236       return 0;
 237     }
 238
 239   cwd = getcwd (NULL, 0);
 240
 241   /* Set up arena for pathname expansion */
 242   tmpnam (tmpdir);
 243   if (mkdir (tmpdir, S_IRWXU) || chdir (tmpdir))
 244     return -1;
 245   else
 246     {
 247       int fd;
 248
 249       for (i = 0; globfile[i]; ++i)
 250         if ((fd = creat (globfile[i], S_IRUSR | S_IWUSR)) == -1
 251             || close (fd))
 252           return -1;
 253     }
 254
 255   for (test = 0; test_case[test].retval != -1; test++)
 256     if (testit (&test_case[test]))
 257       ++fail;
 258
 259   /* Tilde-expansion tests. */
 260   pw = getpwnam ("root");
 261   if (pw != NULL)
 262     {
 263       ts.retval = 0;
 264       ts.env = NULL;
 265       ts.words = "~root ";
 266       ts.flags = 0;
 267       ts.wordc = 1;
 268       ts.wordv[0] = pw->pw_dir;
 269       ts.ifs = IFS;
 270
 271       if (testit (&ts))
 272         ++fail;
 273
 274       ts.retval = 0;
 275       ts.env = pw->pw_dir;
 276       ts.words = "${var#~root}x";
 277       ts.flags = 0;
 278       ts.wordc = 1;
 279       ts.wordv[0] = "x";
 280       ts.ifs = IFS;
 281
 282       if (testit (&ts))
 283         ++fail;
 284     }
 285
 286   /* "~" expands to value of $HOME when HOME is set */
 287
 288   setenv ("HOME", "/dummy/home", 1);
 289   ts.retval = 0;
 290   ts.env = NULL;
 291   ts.words = "~ ~/foo";
 292   ts.flags = 0;
 293   ts.wordc = 2;
 294   ts.wordv[0] = "/dummy/home";
 295   ts.wordv[1] = "/dummy/home/foo";
 296   ts.ifs = IFS;
 297
 298   if (testit (&ts))
 299     ++fail;
 300
 301   /* "~" expands to home dir from passwd file if HOME is not set */
 302
 303   pw = getpwuid (getuid ());
 304   if (pw != NULL)
 305     {
 306       unsetenv ("HOME");
 307       ts.retval = 0;
 308       ts.env = NULL;
 309       ts.words = "~";
 310       ts.flags = 0;
 311       ts.wordc = 1;
 312       ts.wordv[0] = pw->pw_dir;
 313       ts.ifs = IFS;
 314
 315       if (testit (&ts))
 316         ++fail;
 317     }
 318
 319   puts ("tests completed, now cleaning up");
 320
 321   /* Clean up */
 322   for (i = 0; globfile[i]; ++i)
 323     remove (globfile[i]);
 324
 325   if (cwd == NULL)
 326     cwd = "..";
 327
 328   chdir (cwd);
 329   rmdir (tmpdir);
 330
 331   printf ("tests failed: %d\n", fail);
 332
 333   return fail != 0;
 334 }
 335
 336
 337 static int
 338 testit (struct test_case_struct *tc)
 339 {
 340   int retval;
 341   wordexp_t we, sav_we;
 342   char *dummy;
 343   int bzzzt = 0;
 344   int start_offs = 0;
 345   int i;
 346
 347   if (tc->env)
 348     setenv ("var", tc->env, 1);
 349   else
 350     unsetenv ("var");
 351
 352   if (tc->ifs)
 353     setenv ("IFS", tc->ifs, 1);
 354   else
 355     unsetenv ("IFS");
 356
 357   sav_we.we_wordc = 99;
 358   sav_we.we_wordv = &dummy;
 359   sav_we.we_offs = 3;
 360   we = sav_we;
 361
 362   printf ("Test %d (%s): ", ++tests, tc->words);
 363
 364   if (tc->flags & WRDE_APPEND)
 365     {
 366       /* initial wordexp() call, to be appended to */
 367       if (wordexp ("pre1 pre2", &we, tc->flags & ~WRDE_APPEND) != 0)
 368         {
 369           printf ("FAILED setup\n");
 370           return 1;
 371         }
 372     }
 373   retval = wordexp (tc->words, &we, tc->flags);
 374
 375   if (tc->flags & WRDE_DOOFFS)
 376       start_offs = sav_we.we_offs;
 377
 378   if (retval != tc->retval || (retval == 0 && we.we_wordc != tc->wordc))
 379     bzzzt = 1;
 380   else if (retval == 0)
 381     {
 382       for (i = 0; i < start_offs; ++i)
 383         if (we.we_wordv[i] != NULL)
 384           {
 385             bzzzt = 1;
 386             break;
 387           }
 388
 389       for (i = 0; i < we.we_wordc; ++i)
 390         if (we.we_wordv[i+start_offs] == NULL ||
 391             strcmp (tc->wordv[i], we.we_wordv[i+start_offs]) != 0)
 392           {
 393             bzzzt = 1;
 394             break;
 395           }
 396     }
 397
 398   if (bzzzt)
 399     {
 400       printf ("FAILED\n");
 401       printf ("Test words: <%s>, need retval %d, wordc %d\n",
 402               tc->words, tc->retval, tc->wordc);
 403       if (start_offs != 0)
 404         printf ("(preceded by %d NULLs)\n", start_offs);
 405       printf ("Got retval %d, wordc %d: ", retval, we.we_wordc);
 406       if (retval == 0 || retval == WRDE_NOSPACE)
 407         {
 408           for (i = 0; i < we.we_wordc + start_offs; ++i)
 409             if (we.we_wordv[i] == NULL)
 410               printf ("NULL ");
 411             else
 412               printf ("<%s> ", we.we_wordv[i]);
 413         }
 414       printf ("\n");
 415     }
 416   else if (retval != 0 && retval != WRDE_NOSPACE &&
 417            (we.we_wordc != sav_we.we_wordc ||
 418             we.we_wordv != sav_we.we_wordv ||
 419             we.we_offs != sav_we.we_offs))
 420     {
 421       bzzzt = 1;
 422       printf ("FAILED to restore wordexp_t members\n");
 423     }
 424   else
 425     printf ("OK\n");
 426
 427   if (retval == 0 || retval == WRDE_NOSPACE)
 428     wordfree (&we);
 429
 430   return bzzzt;
 431 }