posix/wordexp-test.c

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